lib.php 47 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
4
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
 * Copyright (C) 2006-2007 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
 *
 * @package    mahara
Nigel McNie's avatar
Nigel McNie committed
20
 * @subpackage auth
21
22
23
24
25
26
27
28
 * @author     Nigel McNie <nigel@catalyst.net.nz>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
 * @copyright  (C) 2006,2007 Catalyst IT Ltd http://catalyst.net.nz
 *
 */

defined('INTERNAL') || die();

29
require('session.php');
30
require(get_config('docroot') . 'auth/user.php');
31

Nigel McNie's avatar
Nigel McNie committed
32
33
34
/**
 * Unknown user exception
 */
35
class AuthUnknownUserException extends UserException {}
36

37
38
39
40
41
42
/**
 * We tried to call a method on an auth plugin that hasn't been init'ed 
 * successfully
 */
class UninitialisedAuthException extends SystemException {}

43
44
45
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
46
47
48
49
50
51
 *
 * @todo for authentication:
 *   - inactivity: each institution has inactivity timeout times, this needs
 *     to be supported
 *     - this means the lastlogin field needs to be updated on the usr table
 *     - warnings are handled by cron
52
53
54
 */
abstract class Auth {

55
56
57
58
59
60
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
61
    protected $has_instance_config;
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
    protected $type;
    protected $ready;

    /**
     * Given an id, create the auth object and retrieve the config settings
     * If an instance ID is provided, get all the *instance* config settings
     *
     * @param  int  $id   The unique ID of the auth instance
     * @return bool       Whether the create was successful
     */
    public function __construct($id = null) {
        $this->ready = false;
    }

    /**
     * Instantiate the plugin by pulling the config data for an instance from
     * the database
     *
     * @param  int  $id   The unique ID of the auth instance
     * @return bool       Whether the create was successful
     */
    public function init($id) {
        if (!is_numeric($id) || intval($id) != $id) {
            throw new UserNotFoundException();
        }

        $instance = get_record('auth_instance', 'id', $id);
        if (empty($instance)) {
            throw new UserNotFoundException();
        }

        $this->instanceid   = $id;
        $this->institution  = $instance->institution;
        $this->instancename = $instance->instancename;
        $this->priority     = $instance->priority;
        $this->authname     = $instance->authname;

        // Return now if the plugin type doesn't require any config 
        // (e.g. internal)
101
        if ($this->has_instance_config == false) {
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
            return true;
        }

        $records = get_records_array('auth_instance_config', 'instance', $this->instanceid);

        if ($records == false) {
            return false;
        }

        foreach($records as $record) {
            $this->config[$record->field] = $record->value;
        }

        return true;
    }

    /**
     * The __get overloader is invoked when the requested member is private or
     * protected, or just doesn't exist.
     * 
     * @param  string  $name   The name of the value to fetch
     * @return mixed           The value
     */
    public function __get($name) {
126
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname', 'type');
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }

        if (isset($this->config['name'])) {
            return $this->config['name'];
        }
        return null;
    }

    /**
     * The __set overloader is invoked when the specified member is private or
     * protected, or just doesn't exist.
     * 
     * @param  string  $name   The name of the value to set
     * @param  mixed   $value  The value to assign
     * @return void
     */
    public function __set($name, $value) {
        /*
        if (property_exists($this, $name)) {
            $this->{$name} = $value;
            return;
        }
        */
        throw new SystemException('It\'s forbidden to set values on Auth objects');
    }

    /**
     * Check that the plugin has been initialised before we try to use it.
     * 
     * @throws UninitialisedAuthException
     * @return bool 
     */
    protected function must_be_ready() {
        if ($this->ready == false) {
            throw new UninitialisedAuthException('This Auth plugin has not been initialised');
        }
        return true;
    }

    /**
     * Fetch the URL that users can visit to change their passwords. This might
     * be a Moodle installation, for example.
     * 
     * @return  mixed   URL to change password or false if there is none
     */
    public function changepasswordurl() {
        $this->must_be_ready();
        if (empty($this->config['changepasswordurl'])) {
            return false;
        }
        return $this->config['changepasswordurl'];
    }

183
    /**
184
     * Given a username and password, attempts to log the user in.
185
     *
186
     * @param object $user      An object with username member (at least)
187
188
189
190
191
     * @param string $password  The password to use for the attempt
     * @return bool             Whether the authentication was successful
     * @throws AuthUnknownUserException  If the user is unknown to the
     *                                   authentication method
     */
192
193
194
195
    public function authenticate_user_account($user, $password) {
        $this->must_be_ready();
        return false;
    }
196

197
198
199
200
201
202
    /**
     * Given a username, returns whether the user exists in the usr table
     *
     * @param string $username The username to attempt to identify
     * @return bool            Whether the username exists
     */
203
204
    public function user_exists($username) {
        $this->must_be_ready();
205
        if (record_exists('usr', 'LOWER(username)', strtolower($username))) {
206
207
208
209
            return true;
        }
        throw new AuthUnknownUserException("\"$username\" is not known to Auth");
    }
210

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
    /**
     * Returns whether the authentication instance can automatically create a 
     * user record.
     *
     * Auto creating users means that the authentication plugin can say that 
     * users who don't exist yet in Mahara's usr table are allowed, and Mahara
     * should create a user account for them. Example: the first time a user logs
     * in, when authenticating against an ldap store or similar).
     *
     * However, if a plugin says a user can be authenticated, then it must 
     * implement the get_user_info() method which will be called to find out 
     * information about the user so a record in the usr table _can_ be created 
     * for the new user.
     *
     * Authentication methods must implement this method. Some may choose to 
     * implement it by returning an instance config value that the admin user 
     * can set.
     *
     * @return bool
     */
    public abstract function can_auto_create_users();

233
    /**
234
     * Given a username, returns a hash of information about a user from the
235
     * external data source.
236
237
238
239
240
241
     *
     * @param string $username The username to look up information for
     * @return array           The information for the user
     * @throws AuthUnknownUserException If the user is unknown to the
     *                                  authentication method
     */
242
243
244
    public function get_user_info($username) {
        return false;
    }
245

246
247
    /**
     * Given a username, return information about the user from the database.
248
249
     * This object must_be_ready, which means it will have an authinstanceid. 
     * This is used to disambiguate between users with the same username.
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
     *
     * The information retrieved must be all rows in the user table, with the
     * timestamps formatted as unix timestamps. An example (taken from the
     * internal authentication mechanism, which allows usernames to be case
     * insensitive):
     *
     * <code>
     * get_record('usr', 'LOWER(username)', strtolower($username), null, null, null, null,
     *    '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin'));
     * </code>
     *
     * @param string $username The username to get information for
     * @return array           Data that can be used to populate the session
     * @throws AuthUnknownUserException If the user is unknown to the
     *                                  authentication method
     */
266
267
    public function get_user_info_cached($username) {
        $this->must_be_ready();
268
        if (!$result = get_record('usr', 'LOWER(username)', strtolower($username), null, null, null, null,
269
270
271
272
273
274
                    '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin'))) {
            throw new AuthUnknownUserException("\"$username\" is not known to AuthInternal");
        }
        $cache[$result->username] = $result;
        return $result;
    }
275

Nigel McNie's avatar
Nigel McNie committed
276
277
278
279
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
280
281
282
283
284
     * This only needs to be defined by subclasses if:
     *  - They implement the change_password method, which means that the
     *    system can use the <kbd>passwordchange</kbd> flag on the <kbd>usr</kbd>
     *    table to control whether the user's password needs changing.
     *  - The password that a user can set must be in a certain format.
Nigel McNie's avatar
Nigel McNie committed
285
286
287
288
     *
     * The default behaviour is to assume that the password is in a valid form,
     * so make sure to implement this method if this is not the case!
     *
289
290
291
     * This method is defined to be empty, so that authentication methods do 
     * not have to specify a format if they do not need to.
     *
Nigel McNie's avatar
Nigel McNie committed
292
293
294
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
295
    public function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
296
297
298
        return true;
    }

299
300
301
}


302
303
304
305
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

306
/**
307
308
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
309
310
311
312
313
314
315
316
 *
 * This function combined with the Session class is smart - if the user is not
 * logged in then they do not get a session, which prevents simple curl hits
 * or search engine crawls to a page from getting sessions they won't use.
 *
 * Once the user has a session, they keep it even if the log out, so it can
 * be reused. The session does expire, but the expiry time is typically a week
 * or more.
Nigel McNie's avatar
Nigel McNie committed
317
318
319
320
321
322
323
 *
 * If the user is not authenticated for this page, then this function will
 * exit, printing the login page. Therefore, after including init.php, you can
 * be sure that the user is logged in, or has a valid guest key. However, no
 * testing is done to make sure the user has the required permissions to see
 * the page.
 *
324
325
 */
function auth_setup () {
326
    global $SESSION, $USER;
327
328
329
330

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
331
        $USER->logout();
332
333
334
335
336
        return;
    }

    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
337
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
338
    if ($sessionlogouttime && isset($_GET['logout'])) {
339
340
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
341
        redirect();
Nigel McNie's avatar
Nigel McNie committed
342
343
    }
    if ($sessionlogouttime > time()) {
344
        // The session is still active, so continue it.
345
346
347
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
348
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->id);
349
            if (!$USER->get('admin') && $userreallyadmin) {
350
                // The user has been made into an admin
351
                $USER->admin = 1;
352
            }
353
            else if ($USER->get('admin') && !$userreallyadmin) {
354
                // The user's admin rights have been taken away
355
                $USER->admin = 0;
356
357
            }
            if (!$USER->get('admin')) {
358
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
359
                redirect();
360
            }
361
        } else if (defined('INSTITUTIONALADMIN') && !$USER->get('admin')) {
362
363
364
365
366
367
368
369
            $userreallyadminfor = get_column('usr_institution', 'institution', 'usr', $USER->id, 'admin', 1);
            if (!$USER->is_institutional_admin() && !empty($userreallyadminfor)) {
                $USER->set_admin_institutions($userreallyadminfor);
            }
            else if ($USER->is_institutional_admin() && empty($userreallyadminfor)) {
                $USER->set_admin_institutions(array());
            }
            if (!$USER->is_institutional_admin()) {
370
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
371
                redirect();
372
            }
373
        }
374
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
375
        auth_check_password_change();
376
377
378
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
379
        $USER->logout();
380

381
        if (defined('JSON')) {
382
            json_reply('global', get_string('sessiontimedoutreload'), 1);
383
384
        }

385
386
387
388
389
390
391
392
393
394
        // If the page the user is viewing is public, inform them that they can
        // log in again
        if (defined('PUBLIC')) {
            // @todo this links to ?login - later it should do magic to make
            // sure that whatever GET string is made it includes the old data
            // correctly
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic'), false);
            return;
        }

395
        auth_draw_login_page(get_string('sessiontimedout'));
396
397
398
    }
    else {
        // There is no session, so we check to see if one needs to be started.
399
        // Build login form. If the form is submitted it will be handled here,
400
401
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
402
403
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
404
405
        if ($USER->is_logged_in()) {
            return;
406
407
408
        }
        
        // Check if the page is public or the site is configured to be public.
409
        if (defined('PUBLIC') && !isset($_GET['login'])) {
410
            return;
411
        }
412
413
414
415
416

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
417
        
418
        auth_draw_login_page(null, $form);
419
        exit;
420
421
422
    }
}

423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
/**
 * 
 * Returns all auth instances
 *
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instances() {
    static $cache = array();

    if (count($cache) > 0) {
        return $cache;
    }

    $sql ='
        SELECT DISTINCT
            i.id,
            inst.name,
            inst.displayname,
441
442
            i.instancename,
            i.authname
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
        FROM 
            {institution} inst,
            {auth_instance} i
        WHERE 
            i.institution = inst.name
        ORDER BY
            inst.displayname,
            i.instancename';

    $cache = get_records_sql_array($sql, array());

    if (empty($cache)) {
        return array();
    }

    return $cache;
}


462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
/**
 * 
 * Given a list of institutions, returns all auth instances associated with them
 *
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instances_for_institutions($institutions) {
    if (empty($institutions)) {
        return array();
    }
    $sql ='
        SELECT DISTINCT
            i.id,
            inst.name,
            inst.displayname,
            i.instancename
        FROM 
            {institution} inst,
            {auth_instance} i
        WHERE 
            i.institution = inst.name AND
            inst.name IN (' . join(',', array_map('db_quote',$institutions)) . ')
        ORDER BY
            inst.displayname,
            i.instancename';

    return get_records_sql_array($sql, array());
}
490
491


492
/**
493
494
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
495
 *
496
497
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
498
 */
499
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
500
    static $cache = array();
501

502
    if (null == $institution) {
503
504
505
        return array();
    }

506
    if (!isset($cache[$institution])) {
507
508
509
510
511
512
513
514
515
516
517
        // Get auth instances in order of priority
        // DO NOT CHANGE THE SORT ORDER OF THIS RESULT SET
        // YEAH EINSTEIN - THAT MEANS YOU!!!

        // TODO: work out why this won't accept a placeholder - had to use db_quote
        $sql ='
            SELECT DISTINCT
                i.id,
                i.instancename,
                i.priority,
                i.authname,
518
519
                a.requires_config,
                a.requires_parent
520
            FROM 
521
522
                {auth_instance} i,
                {auth_installed} a
523
524
525
526
527
528
529
530
531
            WHERE 
                a.name = i.authname AND
                i.institution = '. db_quote($institution).'
            ORDER BY
                i.priority,
                i.instancename';

        $cache[$institution] = get_records_sql_array($sql, array());

532
        if (empty($cache[$institution])) {
533
534
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
535
    }
536
537

    return $cache[$institution];
538
539
}

540
541
542
543
544
545
/**
 * Given a wwwroot, find any auth instances that can come from that host
 * 
 * @param   string  wwwroot of the host that is connecting to us
 * @return  array   array of record objects
 */
546
function auth_get_auth_instances_for_wwwroot($wwwroot) {
547
548
549

    // TODO: we just need ai.id and ai.authname... rewrite query, or
    // just drop this function
550
551
552
553
554
    $query = "  SELECT
                    ai.*,
                    aic.*,
                    i.*
                FROM
555
556
557
                    {auth_instance} ai, 
                    {auth_instance_config} aic,
                    {institution} i
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
                WHERE
                    aic.field = 'wwwroot' AND
                    aic.value = ? AND
                    aic.instance = ai.id AND
                    i.name = ai.institution";

    return get_records_sql_array($query, array('value' => $wwwroot));
}

/**
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instances_for_username($institution, $username) {
    static $cache = array();

    if (!isset($cache[$institution][$username])) {
        // Get auth instances in order of priority
        // DO NOT CHANGE THE SORT ORDER OF THIS RESULT SET
        // YEAH EINSTEIN - THAT MEANS YOU!!!

        // TODO: work out why this won't accept a placeholder - had to use db_quote
        $sql ='
            SELECT DISTINCT
                i.id,
                i.instancename,
                i.priority,
                i.authname,
                a.requires_config,
                a.requires_parent
            FROM 
592
593
594
                {auth_instance} i,
                {auth_installed} a,
                {usr} u
595
596
597
598
599
600
601
602
603
604
605
            WHERE 
                a.name = i.authname AND
                i.institution = ? AND
                u.username = ? AND
                u.institution = i.institution
            ORDER BY
                i.priority,
                i.instancename';

        $cache[$institution][$username] = get_records_sql_array($sql, array(array('institution' => $institution), array('username' => $username)));

606
        if (empty($cache[$institution])) {
607
608
609
610
611
612
613
            return false;
        }
    }

    return $cache[$institution];
}

614
615
616
617
618
619
620
/**
 * Given an institution, get all the auth types EXCEPT those that are already 
 * enabled AND do not require configuration.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
621
function auth_get_available_auth_types($institution=null) {
622

623
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
624
625
626
627
628
629
630
631
632
        return array();
    }

    // TODO: work out why this won't accept a placeholder - had to use db_quote
    $sql ='
        SELECT DISTINCT
            a.name,
            a.requires_config
        FROM 
633
            {auth_installed} a
634
        LEFT JOIN 
635
            {auth_instance} i
636
637
638
639
640
641
642
643
644
645
        ON 
            a.name = i.authname AND
            i.institution = '. db_quote($institution).'
        WHERE
           (a.requires_config = 1 OR
            i.id IS NULL) AND
            a.active = 1
        ORDER BY
            a.name';          

646
647
648
649
650
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
651
652
653
654
655
656
657
658

    if (empty($result)) {
        return array();
    }

    return $result;
}

659
660
661
662
663
664
665
666
/**
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
 *
 * This only applies for the internal authentication plugin. Other plugins
 * will, in theory, have different data stores, making changing the password
 * via the internal form difficult.
 */
Nigel McNie's avatar
Nigel McNie committed
667
668
function auth_check_password_change() {
    global $USER;
669
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
670
671
672
        return;
    }

673
674
675
676
677
678
679
    $authobj = AuthFactory::create($USER->authinstance);

    if ($authobj->changepasswordurl) {
        redirect($authobj->changepasswordurl);
        exit;
    }

Nigel McNie's avatar
Nigel McNie committed
680
    // @todo auth preference for a password change screen for all auth methods other than internal
681
    if (method_exists($authobj, 'change_password')) {
Nigel McNie's avatar
Nigel McNie committed
682

683
        require_once('pieforms/pieform.php');
684
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
685
686
687
688
689
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
690
691
692
693
694
695
696
697
698
699
700
701
702
                'password1' => array(
                    'type'        => 'password',
                    'title'       => get_string('newpassword') . ':',
                    'description' => get_string('yournewpassword'),
                    'rules'       => array(
                        'required' => true
                    )
                ),
                'password2' => array(
                    'type'        => 'password',
                    'title'       => get_string('confirmpassword') . ':',
                    'description' => get_string('yournewpasswordagain'),
                    'rules'       => array(
703
704
705
706
707
708
709
710
711
712
713
                        'required' => true,
                    ),
                ),
                'email' => array(
                    'type'   => 'text',
                    'title'  => get_string('principalemailaddress', 'artefact.internal'),
                    'ignore' => (trim($USER->get('email')) != '' && !preg_match('/@example\.org$/', $USER->get('email'))),
                    'rules'  => array(
                        'required' => true,
                        'email'    => true,
                    ),
714
715
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
716
                    'type'  => 'submit',
717
718
                    'value' => get_string('changepassword'),
                ),
719
720
721
722
            )
        );

        $smarty = smarty();
723
        $smarty->assign('change_password_form', pieform($form));
724
725
726
727
728
729
730
731
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
732
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
733
 *
734
735
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
736
 */
737
function change_password_validate(Pieform $form, $values) {
738
    global $USER;
739

740
    // Get the authentication type for the user, and
741
    // use the information to validate the password
742
    $authobj = AuthFactory::create($USER->authinstance);
743

Nigel McNie's avatar
Nigel McNie committed
744
    // @todo this could be done by a custom form rule... 'password' => $user
745
    password_validate($form, $values, $USER);
746

Nigel McNie's avatar
Nigel McNie committed
747
    // The password cannot be the same as the old one
748
    if (!$form->get_error('password1')
749
        && $authobj->authenticate_user_account($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
750
        $form->set_error('password1', get_string('passwordnotchanged'));
751
752
753
754
755
756
757
758
    }
}

/**
 * Changes the password for a user, given that it is valid.
 *
 * @param array $values The submitted form values
 */
759
function change_password_submit(Pieform $form, $values) {
760
    global $USER, $SESSION;
761
762

    $authobj = AuthFactory::create($USER->authinstance);
Nigel McNie's avatar
Nigel McNie committed
763

764
    // This method should exist, because if it did not then the change
Nigel McNie's avatar
Nigel McNie committed
765
    // password form would not have been shown.
766
    if ($password = $authobj->change_password($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
767
        $SESSION->add_ok_msg(get_string('passwordsaved'));
768
        if (!empty($values['email'])) {
769
770
            $USER->email = $values['email'];
            $USER->commit();
771
            set_profile_field($USER->id, 'email', $values['email']);
772
        }
773
        redirect();
774
    }
Nigel McNie's avatar
Nigel McNie committed
775

776
    // TODO: Exception is the wrong type here!
777
778
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
779
780
}

781
/**
Nigel McNie's avatar
Nigel McNie committed
782
 * Creates and displays the transient login page.
783
 *
Nigel McNie's avatar
Nigel McNie committed
784
785
786
787
 * This login page remembers all GET/POST data and passes it on. This way,
 * users can have their sessions time out, and then can log in again without
 * losing any of their data.
 *
788
789
790
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
791
792
793
 * @param Pieform $form If specified, just build this form to get the HTML
 *                      required. Otherwise, this function will build and
 *                      validate the form itself.
Nigel McNie's avatar
Nigel McNie committed
794
 * @access private
795
 */
796
function auth_draw_login_page($message=null, Pieform $form=null) {
797
    global $USER, $SESSION;
798
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
799
        $loginform = get_login_form_js($form->build());
800
801
    }
    else {
802
        require_once('pieforms/pieform.php');
803
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
804
805
806
807
808
        /*
         * If $USER is set, the form was submitted even before being built.
         * This happens when a user's session times out and they resend post
         * data. The request should just continue if so.
         */
809
        if ($USER->is_logged_in()) {
810
811
812
813
814
815
816
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
817
    }
818
    $smarty = smarty();
819
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
820
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
821
822
823
    $smarty->display('login.tpl');
    exit;
}
824

825
/**
Nigel McNie's avatar
Nigel McNie committed
826
 * Returns the definition of the login form.
827
 *
Nigel McNie's avatar
Nigel McNie committed
828
829
 * @return array   The login form definition array.
 * @access private
830
831
 */
function auth_get_login_form() {
832
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
833

834
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
835
836
837
838
839
840
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
841
842
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
843
844
845
846
847
848
849
850
851
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
            'value'       => '',
            'rules' => array(
                'required'    => true
            )
        ),
852
853
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
854
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
855
        ),
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
    );

    // The login page is completely transient, and it is smart because it
    // remembers the GET and POST data sent to it and resends that on
    // afterwards. 
    $action = '';
    if ($_GET) {
        if (isset($_GET['logout'])) {
            // You can log the user out on any particular page by appending
            // ?logout to the URL. In this case, we don't want the "action"
            // of the url to include that, or be blank, else the next time
            // the user logs in they will be logged out again.
            $action = hsc(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?')));
        } else {
            $action = '?';
            foreach ($_GET as $key => $value) {
                if ($key != 'logout') {
                    $action .= hsc($key) . '=' . hsc($value) . '&amp;';
                }
            }
            $action = substr($action, 0, -5);
        }
    }
    if ($_POST) {
        foreach ($_POST as $key => $value) {
            if (!isset($elements[$key]) && !isset($elements['login']['elements'][$key])) {
                $elements[$key] = array(
                    'type'  => 'hidden',
                    'value' => $value
                );
            }
        }
    }

    $form = array(
891
892
893
894
895
896
897
898
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
899
900
    );

901
    return $form;
902
903
}

Nigel McNie's avatar
Nigel McNie committed
904
905
906
907
908
/**
 * Returns javascript to assist with the rendering of the login forms. The
 * javascript is used to detect whether cookies are enabled, and not show the
 * login form if they are not.
 *
909
910
 * @param string  $form A rendered login form
 * @return string The form with extra javascript added for cookie detection
Nigel McNie's avatar
Nigel McNie committed
911
912
913
914
 * @private
 */
function get_login_form_js($form) {
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
915
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
916
917
918
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
919
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
920
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
921
922
if (document.cookie) {
    loginbox.innerHTML = '$form';
923
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
924
925
}
else {
926
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
Nigel McNie's avatar
Nigel McNie committed
927
928
929
930
}
</script>
EOF;
}
931

932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965

/**
 * Class to build and cache instances of auth objects
 */
class AuthFactory {

    static $authcache = array();

    /**
     * Take an instanceid and create an auth object for that instance. 
     * 
     * @param  int      $id     The id of the auth instance
     * @return mixed            An intialised auth object or false, if the
     *                          instance doesn't exist (Should never happen)
     */
    public static function create($id) {

        if (isset(self::$authcache[$id]) && is_object(self::$authcache[$id])) {
            return self::$authcache[$id];
        }

        $authinstance = get_record('auth_instance', 'id', $id, null, null, null, null, 'authname');

        if (!empty($authinstance)) {
            $authclassname = 'Auth' . ucfirst($authinstance->authname);
            safe_require('auth', $authinstance->authname);
            self::$authcache[$id] = new $authclassname($id);
            return self::$authcache[$id];
        }

        return false;
    }
}

966
/**
967
 * Called when the login form is submitted. Validates the user and password, and
968
 * if they are valid, starts a new session for the user.
969
 *
970
971
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
972
 * @access private
973
 */
974
function login_submit(Pieform $form, $values) {
975
976
    global $SESSION, $USER;

977
978
979
980
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
981

982
    try {
983
        $authenticated = $USER->login($username, $password);
984

985
986
987
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
        }
988

989
990
    }
    catch (AuthUnknownUserException $e) {
991
992
        // If the user doesn't exist, check for institutions that
        // want to create users automatically.
993
        try {
994
995
996
997
            // Reset the LiveUser object, since we are attempting to create a 
            // new user
            $USER = new LiveUser();

998
999
1000
1001
1002
1003
1004
            $authinstances = get_records_sql_array('
                SELECT a.id, a.instancename, a.priority, a.authname, a.institution
                FROM {institution} i JOIN {auth_instance} a ON a.institution = i.name
                ORDER BY a.institution, a.priority, a.instancename', null);

            if ($authinstances == false) {
                throw new AuthUnknownUserException("\"$username\" is not known");
Nigel McNie's avatar
Nigel McNie committed
1005
1006
            }

1007
            $USER->username = $username;
1008

1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
            reset($authinstances);
            while ((list(, $authinstance) = each($authinstances)) && false == $authenticated) {
                $auth = AuthFactory::create($authinstance->id);
                if (!$auth->can_auto_create_users()) {
                    continue;
                }
                if ($auth->authenticate_user_account($USER, $password)) {
                    $authenticated = true;
                } else {
                    continue;
                }
1020

1021
1022
1023
1024
1025
1026
                // Check now to see if the institution has its maximum quota of users
                require_once('institution.php');
                $institution = new Institution($authinstance->institution);
                if ($institution->isFull()) {
                    throw new AuthUnknownUserException('Institution has too many users');
                }
1027

1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
                $USER->authinstance = $authinstance->id;
                $userdata = $auth->get_user_info($username);
                if (
                     empty($userdata) ||
                     empty($userdata->firstname) ||
                     empty($userdata->lastname) ||
                     empty($userdata->email) 
                    ) {
                    throw new AuthUnknownUserException("\"$username\" is not known");
                } else {
                    // We have the data - create the user
                    $USER->lastlogin = db_format_timestamp(time());
                    $USER->firstname = $userdata->firstname;
                    $USER->lastname  = $userdata->lastname;
                    $USER->email     = $userdata->email;

                    try {
                        db_begin();
                        $USER->commit();
                        set_profile_field($USER->id, 'firstname', $USER->firstname);
                        set_profile_field($USER->id, 'lastname', $USER->lastname);
                        set_profile_field($USER->id, 'email', $USER->email);

                        if ($authinstance->institution !== 'mahara') {
                            $USER->join_institution($authinstance->institution);
1053
                        }
1054
1055
1056
1057
1058
1059
1060
1061

                        handle_event('createuser', $USER->to_stdclass());
                        db_commit();
                        $USER->reanimate($USER->id, $authinstance->id);
                    }
                    catch (Exception $e) {
                        db_rollback();
                        throw $e;
1062
1063
                    }
                }
Nigel McNie's avatar
Nigel McNie committed
1064
1065
            }

1066
1067
1068
1069
1070
            if (!$authenticated) {
                $SESSION->add_error_msg(get_string('loginfailed'));
                return;
            }

1071
1072
        }
        catch (AuthUnknownUserException $e) {
1073
            $SESSION->add_error_msg(get_string('loginfailed'));
1074
            return;
1075
1076
        }
    }
1077
1078

    // Only admins in the admin section!
1079
1080
    if (!$USER->get('admin') && 
        (defined('ADMIN') || defined('INSTITUTIONALADMIN') && !$USER->is_institutional_admin())) {
1081
1082
1083
1084
1085
1086
        $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
        redirect();
    }

    // Check if the user's account has been deleted
    if ($USER->deleted) {
Richard Mansfield's avatar
Richard Mansfield committed
1087
        $USER->logout();
1088
1089
1090
1091
1092
        die_info(get_string('accountdeleted'));
    }

    // Check if the user's account has expired
    if ($USER->expiry > 0 && time() > $USER->expiry) {
Richard Mansfield's avatar
Richard Mansfield committed
1093
        $USER->logout();
1094
1095
1096
1097
        die_info(get_string('accountexpired'));
    }

    // Check if the user's account has become inactive
1098
    $inactivetime = get_config('defaultaccountinactiveexpire');
1099
1100
    if ($inactivetime && $oldlastlogin > 0
        && $oldlastlogin + $inactivetime < time()) {
Richard Mansfield's avatar
Richard Mansfield committed
1101
        $USER->logout();
1102
1103
1104
1105
1106
        die_info(get_string('accountinactive'));
    }

    // Check if the user's account has been suspended
    if ($USER->suspendedcusr) {
Richard Mansfield's avatar
Richard Mansfield committed
1107
1108
1109
1110
        $suspendedctime  = $USER->suspendedctime;
        $suspendedreason = $USER->suspendedreason;
        $USER->logout();
        die_info(get_string('accountsuspended', 'mahara', $suspendedctime, $suspendedreason));
1111
1112
1113
1114
1115
    }

    // User is allowed to log in
    //$USER->login($userdata);
    auth_check_password_change();
1116
1117
}

1118
1119
1120
1121
/**
 * Removes registration requests that were not completed in the allowed amount of time
 */
function auth_clean_partial_registrations() {
1122
    delete_records_sql('DELETE FROM {usr_registration}
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
        WHERE expiry < ?', array(db_format_timestamp(time())));
}

/**
 * Sends notification e-mails to users in two situations:
 *
 *  - Their account is about to expire. This is controlled by the 'expiry'
 *    field of the usr table. Once that time has passed, the user may not
 *    log in.
 *  - They have not logged in for close to a certain amount of time. If that
 *    amount of time has passed, the user may not log in.
 *
 * The actual prevention of users logging in is handled by the authentication
 * code. This cron job sends e-mails to notify users that these events will
 * happen soon.
 */
function auth_handle_account_expiries() {
    // The 'expiry' flag on the usr table
    $sitename = get_config('sitename');
    $wwwroot  = get_config('wwwroot');
1143
1144
    $expire   = get_config('defaultaccountinactiveexpire');
    $warn     = get_config('defaultaccountinactivewarn');
1145

1146
1147
1148
    $daystoexpire = ceil($warn / 86400) . ' ';
    $daystoexpire .= ($daystoexpire == 1) ? get_string('day') : get_string('days');

1149
    // Expiry warning messages
1150
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.admin, u.staff
1151
        FROM {usr} u
1152
1153
        WHERE ' . db_format_tsfield('u.expiry', false) . ' < ?
        AND expirymailsent = 0', array(time() + $warn))) {
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
        foreach ($users as $user) {
            $displayname  = display_name($user);
            email_user($user, null,
                get_string('accountexpirywarning'),
                get_string('accountexpirywarningtext', 'mahara', $displayname, $sitename, $daystoexpire, $wwwroot . 'contact.php', $sitename),
                get_string('accountexpirywarninghtml', 'mahara', $displayname, $sitename, $daystoexpire, $wwwroot . 'contact.php', $sitename)
            );
            set_field('usr', 'expirymailsent', 1, 'id', $user->id);
        }
    }

1165
    // Actual expired users
1166
    if ($users = get_records_sql_array('SELECT id
1167
        FROM {usr}
1168
        WHERE ' . db_format_tsfield('expiry', false) . ' < ?', array(time()))) {
1169
1170
1171
1172
1173
1174
        // Users have expired!
        foreach ($users as $user) {
            expire_user($user->id);
        }
    }

1175
    
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
    if ($expire) {
        // Inactivity (lastlogin is too old)
        if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.admin, u.staff
            FROM {usr} u
            WHERE (? - ' . db_format_tsfield('u.lastlogin', false) . ') > ' . ($expire - $warn) . '
            AND inactivemailsent = 0', array(time()))) {
            foreach ($users as $user) {
                $displayname = display_name($user);
                email_user($user, null, get_string('accountinactivewarning'),
                    get_string('accountinactivewarningtext', 'mahara', $displayname, $sitename, $daystoexpire, $sitename),
                    get_string('accountinactivewarninghtml', 'mahara', $displayname, $sitename, $daystoexpire, $sitename)
                );
                set_field('usr', 'inactivemailsent', 1, 'id', $user->id);
            }
1190
        }
1191
1192
1193
1194
1195
1196
1197
1198
1199
        
        // Actual inactive users
        if ($users = get_records_sql_array('SELECT u.id
            FROM {usr} u
            WHERE (? - ' . db_format_tsfield('lastlogin', false) . ') > ?', array(time(), $expire))) {
            // Users have become inactive!
            foreach ($users as $user) {
                deactivate_user($user->id);
            }
1200
1201
        }
    }
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230

    // Institution membership expiry
    delete_records_sql('DELETE FROM {usr_institution} 
        WHERE ' . db_format_tsfield('expiry', false) . ' < ? AND expirymailsent = 1', array(time()));

    // Institution membership expiry warnings
    if ($users = get_records_sql_array('
        SELECT
            u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, u.admin, u.staff,
            ui.institution, ui.expiry, i.displayname as institutionname
        FROM {usr} u
        INNER JOIN {usr_institution} ui ON u.id = ui.usr
        INNER JOIN {institution} i ON ui.institution = i.name
        WHERE ' . db_format_tsfield('ui.expiry', false) . ' < ?
        AND ui.expirymailsent = 0', array(time() + $warn))) {
        foreach ($users as $user) {
            $displayname  = display_name($user);
            email_user($user, null,
                get_string('institutionexpirywarning'),
                get_string('institutionexpirywarningtext', 'mahara', $displayname, $user->institutionname,
                           $sitename, $daystoexpire, $wwwroot . 'contact.php', $sitename),
                get_string('institutionexpirywarninghtml', 'mahara', $displayname, $user->institutionname,
                           $sitename, $daystoexpire, $wwwroot . 'contact.php', $sitename)
            );
            set_field('usr_institution', 'expirymailsent', 1, 'usr', $user->id,
                      'institution', $user->institution);
        }
    }

1231
1232
}

Martyn Smith's avatar
Martyn Smith committed
1233
function auth_generate_login_form() {
Nigel McNie's avatar
Nigel McNie committed
1234
1235
1236
    if (!get_config('installed')) {
        return;
    }
Martyn Smith's avatar
Martyn Smith committed
1237
1238
1239
1240
1241
1242
1243
1244
    require_once('pieforms/pieform.php');
    $loginform = get_login_form_js(pieform(array(
        'name'       => 'login',
        'renderer'   => 'div',
        'submit'     => false,
        'plugintype' => 'auth',
        'pluginname' => 'internal',
        'elements'   => array(
1245
1246
1247
1248
1249
1250
            'login_username' => array(
                'type'        => 'text',
                'title'       => get_string('username') . ':',
                'description' => get_string('usernamedescription'),
                'rules' => array(
                    'required'    => true
Martyn Smith's avatar
Martyn Smith committed
1251
1252
                )
            ),
1253
1254
1255
1256
1257
1258
1259
1260
1261
            'login_password' => array(
                'type'        => 'password',
                'title'       => get_string('password') . ':',
                'description' => get_string('passworddescription'),
                'value'       => '',
                'rules' => array(
                    'required'    => true
                )
            ),
Martyn Smith's avatar
Martyn Smith committed
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
            'submit' => array(
                'type'  => 'submit',
                'value' => get_string('login')
            ),
            'register' => array(
                'value' => '<div><a href="' . get_config('wwwroot') . 'register.php" tabindex="2">' . get_string('register') . '</a>'
                    . '<br><a href="' . get_config('wwwroot') . 'forgotpass.php" tabindex="2">' . get_string('passwordreminder') . '</a></div>'
            )
        )
    )));

    return $loginform;
}

1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
/**
 * Given a form, an array of values with 'password1' and 'password2'
 * indices and a user, validate that the user can change their password to
 * the one in $values.
 *
 * This provides one place where validation of passwords can be done. This is
 * used by:
 *  - registration
 *  - user forgot password
 *  - user changing password on their account page
 *  - user forced to change their password by the <kbd>passwordchange</kbd>
 *    flag on the <kbd>usr</kbd> table.
 *
 * The password is checked for:
 *  - Being in valid form according to the rules of the authentication method
 *    for the user
 *  - Not being an easy password (a blacklist of strings, NOT a length check or
 *     similar), including being the user's username
 *  - Both values being equal
 *
 * @param Pieform $form         The form to validate
 * @param array $values         The values passed through
 * @param string $authplugin    The authentication plugin that the user uses
 */
1300
function password_validate(Pieform $form, $values, $user) {
1301
1302
1303
1304
1305
1306
1307
1308

    $authobj = AuthFactory::create($user->authinstance);

    if (!$form->get_error('password1') && !$authobj->is_password_valid($values['password1'])) {
        $form->set_error('password1', get_string('passwordinvalidform', "auth.$authobj->type"));
    }

    $suckypasswords = array(
1309
        'mahara', 'password', $user->username, 'abc123'
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
    );

    if (!$form->get_error('password1') && in_array($values['password1'], $suckypasswords)) {
        $form->set_error('password1', get_string('passwordtooeasy'));
    }

    if (!$form->get_error('password1') && $values['password1'] != $values['password2']) {
        $form->set_error('password2', get_string('passwordsdonotmatch'));
    }

1320
}
1321
1322
1323
1324

class PluginAuth extends Plugin {

    public static function get_event_subscriptions() {
1325
1326
        $subscriptions = array();

1327
1328
        $activecheck = new StdClass;
        $activecheck->plugin = 'internal';
1329
        $activecheck->event  = 'suspenduser';
1330
        $activecheck->callfunction = 'update_active_flag';
1331
        $subscriptions[] = clone $activecheck;
1332
        $activecheck->event = 'unsuspenduser';
1333
        $subscriptions[] = clone $activecheck;
1334
        $activecheck->event = 'deleteuser';
1335
        $subscriptions[] = clone $activecheck;
1336
        $activecheck->event = 'undeleteuser';