lib.php 46.4 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?php
/**
 * This program is part of Mahara
 *
 *  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 2 of the License, or
 *  (at your option) any later version.
 *
 *  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.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 *
 * @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
61
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
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
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
    protected $has_config;
    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)
        if ($this->has_config == false) {
            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) {
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname');

        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
205
206
207
208
209
    public function user_exists($username) {
        $this->must_be_ready();
        if (record_exists('usr', 'LOWER(username)', strtolower($username), 'authinstance', $this->instanceid)) {
            return true;
        }
        throw new AuthUnknownUserException("\"$username\" is not known to Auth");
    }
210

211
    /**
212
213
     * Given a username, returns a hash of information about a user from the
     * external data source, e.g. Moodle or Drupal.
214
215
216
217
218
219
     *
     * @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
     */
220
221
222
    public function get_user_info($username) {
        return false;
    }
223

224
225
    /**
     * Given a username, return information about the user from the database.
226
227
     * This object must_be_ready, which means it will have an authinstanceid. 
     * This is used to disambiguate between users with the same username.
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
     *
     * 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
     */
244
245
246
247
248
249
250
251
252
    public function get_user_info_cached($username) {
        $this->must_be_ready();
        if (!$result = get_record('usr', 'LOWER(username)', strtolower($username), 'authinstance', $this->instanceid,
                    '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin'))) {
            throw new AuthUnknownUserException("\"$username\" is not known to AuthInternal");
        }
        $cache[$result->username] = $result;
        return $result;
    }
253

Nigel McNie's avatar
Nigel McNie committed
254
255
256
257
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
258
259
260
261
262
     * 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
263
264
265
266
     *
     * 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!
     *
267
268
269
     * 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
270
271
272
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
273
    public function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
274
275
276
        return true;
    }

277
278
279
}


280
281
282
283
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

284
/**
285
286
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
287
288
289
290
291
292
293
294
 *
 * 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
295
296
297
298
299
300
301
 *
 * 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.
 *
302
303
 */
function auth_setup () {
304
    global $SESSION, $USER;
305
306
307
308

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
309
        $USER->logout();
310
311
312
313
314
        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.
315
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
316
    if ($sessionlogouttime && isset($_GET['logout'])) {
317
318
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
319
        redirect();
Nigel McNie's avatar
Nigel McNie committed
320
321
    }
    if ($sessionlogouttime > time()) {
322
        // The session is still active, so continue it.
323
324
325
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
326
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->id);
327
            if (!$USER->get('admin') && $userreallyadmin) {
328
                // The user has been made into an admin
329
                $USER->admin = 1;
330
            }
331
            else if ($USER->get('admin') && !$userreallyadmin) {
332
                // The user's admin rights have been taken away
333
                $USER->admin = 0;
334
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
335
                redirect();
336
            }
337
            elseif (!$USER->get('admin')) {
338
                // The user never was an admin
339
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
340
                redirect();
341
            }
342
        }
343
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
344
        auth_check_password_change();
345
346
347
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
348
        $USER->logout();
349
350
351
352
353
354
355
356
357
358
359

        // 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;
        }

360
        auth_draw_login_page(get_string('sessiontimedout'));
361
362
363
    }
    else {
        // There is no session, so we check to see if one needs to be started.
364
        // Build login form. If the form is submitted it will be handled here,
365
366
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
367
368
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
369
370
        if ($USER->is_logged_in()) {
            return;
371
372
373
        }
        
        // Check if the page is public or the site is configured to be public.
374
        if (defined('PUBLIC') && !isset($_GET['login'])) {
375
            return;
376
        }
377
        
378
        auth_draw_login_page(null, $form);
379
        exit;
380
381
382
383
    }
}

/**
384
385
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
386
 *
387
388
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
389
 */
390
function auth_get_auth_instances_for_institution($institution) {
391
    global $CFG;
Nigel McNie's avatar
Nigel McNie committed
392
    static $cache = array();
393
394

    if (!isset($cache[$institution])) {
395
396
397
398
399
400
401
402
403
404
405
        // 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,
406
407
                a.requires_config,
                a.requires_parent
408
409
410
411
412
413
414
415
416
417
418
419
            FROM 
                '.$CFG->dbprefix.'auth_instance i,
                '.$CFG->dbprefix.'auth_installed a
            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());

420
421
422
        if(empty($cache[$institution])) {
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
423
    }
424
425

    return $cache[$institution];
426
427
}

428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
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
490
491
492
493
494
function auth_get_auth_instances_for_wwwroot($wwwroot) {
    global $CFG;
    $query = "  SELECT
                    ai.*,
                    aic.*,
                    i.*
                FROM
                    {$CFG->dbprefix}auth_instance ai, 
                    {$CFG->dbprefix}auth_instance_config aic,
                    {$CFG->dbprefix}institution i
                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) {
    global $CFG;
    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 
                '.$CFG->dbprefix.'auth_instance i,
                '.$CFG->dbprefix.'auth_installed a,
                '.$CFG->dbprefix.'usr u
            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)));

        if(empty($cache[$institution])) {
            return false;
        }
    }

    return $cache[$institution];
}

495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
/**
 * 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
 */
function auth_get_available_auth_types($institution) {
    global $CFG;
    if (!is_string($institution) || strlen($institution) > 255) {
        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 
            '.$CFG->dbprefix.'auth_installed a
        LEFT JOIN 
            '.$CFG->dbprefix.'auth_instance i
        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';          

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

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

    return $result;
}

536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
/**
 * Given a user, returns the authentication instance used.
 *
 * @param  object   $user            User object with an authinstance member
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instance($user) {
    static $cache = array();

    if (!isset($cache[$user->id])) {
        $cache[$user->id] = get_record('auth_instance', 'id', $user->authinstance, null, null, null, null, 'id, instancename, priority, authname');
    }

    return $cache[$user->id];
}

552
553
554
555
556
557
558
559
/**
 * 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
560
561
function auth_check_password_change() {
    global $USER;
562
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
563
564
565
        return;
    }

566
567
568
569
570
571
572
    $authobj = AuthFactory::create($USER->authinstance);

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

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

576
        require_once('pieforms/pieform.php');
577
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
578
579
580
581
582
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
583
584
585
586
587
588
589
590
591
592
593
594
595
                '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(
596
597
598
599
600
601
602
603
604
605
606
                        '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,
                    ),
607
608
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
609
                    'type'  => 'submit',
610
611
                    'value' => get_string('changepassword'),
                ),
612
613
614
615
            )
        );

        $smarty = smarty();
616
        $smarty->assign('change_password_form', pieform($form));
617
618
619
620
621
622
623
624
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
625
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
626
 *
627
628
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
629
 */
630
function change_password_validate(Pieform $form, $values) {
631
    global $USER;
632

633
    // Get the authentication type for the user, and
634
    // use the information to validate the password
635
    $authobj = AuthFactory::create($USER->authinstance);
636

Nigel McNie's avatar
Nigel McNie committed
637
    // @todo this could be done by a custom form rule... 'password' => $user
638
    password_validate_user($form, $values, $USER);
639

Nigel McNie's avatar
Nigel McNie committed
640
    // The password cannot be the same as the old one
641
    if (!$form->get_error('password1')
642
        && $authobj->authenticate_user_account($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
643
        $form->set_error('password1', get_string('passwordnotchanged'));
644
645
646
647
648
649
650
651
    }
}

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

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

657
    // This method should exist, because if it did not then the change
Nigel McNie's avatar
Nigel McNie committed
658
    // password form would not have been shown.
659
    if ($password = $authobj->change_password($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
660
        $SESSION->add_ok_msg(get_string('passwordsaved'));
661
        if (!empty($values['email'])) {
662
            set_profile_field($USER->id, 'email', $values['email']);
663
        }
664
        redirect();
665
    }
Nigel McNie's avatar
Nigel McNie committed
666

667
668
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
669
670
}

671
/**
Nigel McNie's avatar
Nigel McNie committed
672
 * Creates and displays the transient login page.
673
 *
Nigel McNie's avatar
Nigel McNie committed
674
675
676
677
 * 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.
 *
678
679
680
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
681
682
683
 * @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
684
 * @access private
685
 */
686
function auth_draw_login_page($message=null, Pieform $form=null) {
687
    global $USER, $SESSION;
688
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
689
        $loginform = get_login_form_js($form->build());
690
691
    }
    else {
692
        require_once('pieforms/pieform.php');
693
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
694
695
696
697
698
        /*
         * 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.
         */
699
        if ($USER->is_logged_in()) {
700
701
702
703
704
705
706
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
707
    }
708
    $smarty = smarty();
709
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
710
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
711
712
713
    $smarty->display('login.tpl');
    exit;
}
714

715
/**
Nigel McNie's avatar
Nigel McNie committed
716
 * Returns the definition of the login form.
717
 *
Nigel McNie's avatar
Nigel McNie committed
718
719
 * @return array   The login form definition array.
 * @access private
720
721
 */
function auth_get_login_form() {
722
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
723
724
725
726
727
    $defaultinstitution = get_cookie('institution');
    if (!$defaultinstitution) {
        $defaultinstitution = 'mahara';
    }

728
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
729
730
731
732
733
734
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
735
736
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
            'value'       => '',
            'rules' => array(
                'required'    => true
            )
        ),
        'login_institution' => array(
            'type'         => 'select',
            'title'        => get_string('institution'). ':',
            'defaultvalue' => $defaultinstitution,
            'options'      => $institutions,
            'rules' => array(
                'required' => true
            ),
            'ignore' => count($institutions) == 1
        ),
756
757
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
758
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
759
        ),
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
    );

    // 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(
795
796
797
798
799
800
801
802
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
803
804
    );

805
    return $form;
806
807
}

Nigel McNie's avatar
Nigel McNie committed
808
809
810
811
812
/**
 * 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.
 *
813
814
 * @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
815
816
817
818
819
820
821
822
 * @private
 */
function get_login_form_js($form) {
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
    $strcookiesnotenabled    = get_string('cookiesnotenabled');
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
823
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
824
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
825
826
if (document.cookie) {
    loginbox.innerHTML = '$form';
827
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
828
829
}
else {
830
    replaceChildNodes(loginbox, P(null, '$strcookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
831
832
833
834
}
</script>
EOF;
}
835

836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869

/**
 * 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;
    }
}

870
/**
871
 * Called when the login form is submitted. Validates the user and password, and
872
 * if they are valid, starts a new session for the user.
873
 *
874
875
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
876
 * @access private
877
 */
878
function login_submit(Pieform $form, $values) {
879
880
    global $SESSION, $USER;

881
882
883
884
885
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $institution   = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
886

887
    try {
888
889
        //var_dump(array($username, $password, $institution, $_SESSION));
        $authenticated = $USER->login($username, $password, $institution);
890

891
892
893
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
        }
894

895
896
897
898
899
900
901
902
903
904
    } catch (AuthUnknownUserException $e) {
        try {
            // The user doesn't exist, but maybe the institution wants us to 
            // create users that don't exist
            $institution  = get_record('institution', 'name', $institution);
            if ($institution != false) {
                if ($institution->updateuserinfoonlogin == 0) {
                    // Institution does not want us to create unknown users
                    throw new AuthUnknownUserException("\"$username\" at \"$institution\" is not known");
                }
Nigel McNie's avatar
Nigel McNie committed
905
906
            }

907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
            // Institution says we should create unknown users
            // Get all the auth options for the institution
            $authinstances = get_records_array('auth_instance', 'institution', $institution, 'priority, instancename', 'id, instancename, priority, authname');

            $USER->username    = $username;
            $USER->institution = $institution->name;

            while (list(, $authinstance) = each($authinstances) && false == $authenticated) {
                // TODO: Test this code with an auth plugin that provides a 
                // get_user_info method
                $auth = AuthFactory::create($authinstance->id);
                if ($auth->authenticate_user_account($USER, $password)) {
                    $authenticated = true;
                } else {
                    continue;
                }
923

924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
                $USER->authinstance = $authinstance->id;

                if($auth->authenticate_user_account($username, $password, $institution)) {
                    $userdata = $auth->get_user_info();
                    if (
                         empty($userdata) ||
                         empty($userdata->firstname) ||
                         empty($userdata->lastname) ||
                         empty($userdata->email) 
                        ) {
                        throw new AuthUnknownUserException("\"$username\" at \"$institution\" is not known");
                    } else {
                        // We have the data - create the user
                        $USER->expiry    = db_format_timestamp(time() + 86400);
                        $USER->lastlogin = db_format_timestamp(time());
                        $USER->firstname = $userdata->firstname;
                        $USER->lastname  = $userdata->lastname;
                        $USER->email     = $userdata->email;

                        try {
                            db_begin();
                            $USER->commit();
    
                            handle_event('createuser', $USER);
                            db_commit();
                        } catch (Exception $e) {
                            db_rollback();
                            throw $e;
                        }
                    }
                }
Nigel McNie's avatar
Nigel McNie committed
955
956
            }

957
        } catch (AuthUnknownUserException $e) {
958
            $SESSION->add_error_msg(get_string('loginfailed'));
959
        }
960
961
    } catch (Exception $e) {
        // Unknown Exception!!!
962
        $SESSION->add_error_msg(get_string('loginfailed'));
963
    }
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995

    // Only admins in the admin section!
    if (defined('ADMIN') && !$USER->admin) {
        $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
        redirect();
    }

    // Check if the user's account has been deleted
    if ($USER->deleted) {
        die_info(get_string('accountdeleted'));
    }

    // Check if the user's account has expired
    if ($USER->expiry > 0 && time() > $USER->expiry) {
        die_info(get_string('accountexpired'));
    }

    // Check if the user's account has become inactive
    $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $USER->institution);
    if ($inactivetime && $oldlastlogin > 0
        && $oldlastlogin + $inactivetime < time()) {
        die_info(get_string('accountinactive'));
    }

    // Check if the user's account has been suspended
    if ($USER->suspendedcusr) {
        die_info(get_string('accountsuspended', 'mahara', $USER->suspendedctime, $USER->suspendedreason));
    }

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

998
999
1000
/**
 * Removes registration requests that were not completed in the allowed amount of time
 */
For faster browsing, not all history is shown. View entire blame