lib.php 26.1 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
30
require('session.php');

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

/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
39
40
41
42
43
44
 *
 * @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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 */
abstract class Auth {

    /**
     * Given a username, password and institution, attempts to log the use in.
     *
     * @param string $username  The username to attempt to authenticate
     * @param string $password  The password to use for the attempt
     * @param string $institute The institution the user belongs to
     * @return bool             Whether the authentication was successful
     * @throws AuthUnknownUserException  If the user is unknown to the
     *                                   authentication method
     */
    public static abstract function authenticate_user_account($username, $password, $institute);

    /**
     * Given a username, returns a hash of information about a user.
     *
     * @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
     */
68
    public static abstract function get_user_info($username);
69
70

    /**
Nigel McNie's avatar
Nigel McNie committed
71
72
73
74
75
     * Returns a hash of information that will be rendered into a form when
     * configuring authentication.
     *
     * This is defined to be empty, so that authentication methods do not have
     * to specify a form if they do not need to.
76
     *
Nigel McNie's avatar
Nigel McNie committed
77
78
79
80
81
82
83
84
85
86
87
88
89
     * If an authentication method is to return any elements, the return result
     * <b>must</b> be wrapped in a call to {@link build_form}.
     *
     * For example:
     *
     * <pre>
     * $elements = array(
     *     // ... describe elements here ...
     * );
     * return Auth::build_form($elements);
     * </pre>
     *
     * @return array The form for configuring the authentication method
90
     */
91
92
93
    public static function get_configuration_form() {
    }

Nigel McNie's avatar
Nigel McNie committed
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
    /**
     * Given a submission from the configuration form, validates it
     *
     * This is defined to be empty, so that authentication methods do not have
     * to specify any validation rules if they do not need to.
     *
     * @param array $values The submitted values for the form
     * @param Form $form    The form being validated
     */
    public static function validate_configuration_form(Form $form, $values) {
    }

    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
110
111
112
113
114
     * 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
115
116
117
118
     *
     * 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!
     *
119
120
121
     * 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
122
123
124
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
125
    public static function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
        return true;
    }

    /**
     * If a validation form is to be used, the result of 
     * {@link get_configuration_form} should be passed through this method
     * before being returned. This method builds the rest of the form.
     *
     * @param string $method  The name of the authentication method (for
     *                        example 'internal'). Lowercase please.
     * @param array $elements The elements in the form.
     * @return array          The form definition. <kbd>false</kbd> if there
     *                        is no form for the authentication method.
     */
    protected static final function build_form($method, $elements) {
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
        if (count($elements)) {
            $elements['submit'] = array(
                'type' => 'submit',
                'value' => 'Update'
            );
            $elements['method'] = array(
                'type' => 'hidden',
                'value' => $method 
            );
            return array(
                'name' => 'auth',
                'elements' => $elements
            );
        }
        return false;
156
157
158
159
160
161
    }

}


/**
Nigel McNie's avatar
Nigel McNie committed
162
 * Handles authentication by setting up a session for a user if they are logged in.
163
164
165
166
167
168
169
170
 *
 * 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
171
172
173
174
175
176
177
178
179
 *
 * 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.
 *
 * @return object The $USER object, if the user is logged in and continuing
 *                their session.
180
181
 */
function auth_setup () {
182
    global $SESSION, $USER;
183
184
185
186

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
187
        $SESSION->logout();
188
189
190
191
192
193
        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.
    $sessionlogouttime = $SESSION->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
194
    if ($sessionlogouttime && isset($_GET['logout'])) {
195
        if (isset($_GET['logout'])) {
Nigel McNie's avatar
Nigel McNie committed
196
            log_debug('logging user ' . $SESSION->get('username') . ' out');
197
            $SESSION->logout();
Nigel McNie's avatar
Nigel McNie committed
198
            $SESSION->add_ok_msg(get_string('loggedoutok'));
199
            redirect(get_config('wwwroot'));
200
        }
Nigel McNie's avatar
Nigel McNie committed
201
202
    }
    if ($sessionlogouttime > time()) {
203
        // The session is still active, so continue it.
Nigel McNie's avatar
Nigel McNie committed
204
        log_debug('session still active from previous time');
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219

        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
            $userreallyadmin = get_field('usr', 'admin', 'id', $SESSION->get('id'));
            if (!$SESSION->get('admin') && $userreallyadmin) {
                // The user has been made into an admin
                $SESSION->set('admin', 1);
            }
            else if ($SESSION->get('admin') && !$userreallyadmin) {
                // The user's admin rights have been taken away
                $SESSION->set('admin', 0);
                $SESSION->add_err_msg(get_string('accessforbiddentoadminsection'));
                redirect(get_config('wwwroot'));
            }
220
221
222
223
224
            else {
                // The user never was an admin
                $SESSION->add_err_msg(get_string('accessforbiddentoadminsection'));
                redirect(get_config('wwwroot'));
            }
225
        }
226
        $USER = $SESSION->renew();
Nigel McNie's avatar
Nigel McNie committed
227
        auth_check_password_change();
228
        return $USER;
229
230
231
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
Nigel McNie's avatar
Nigel McNie committed
232
        log_debug('session timed out');
233
        $SESSION->logout();
234
235
236
237
238
239
240
241
242
243
244

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

245
246
247
248
249
        auth_draw_login_page(get_string('sessiontimedout'));
        // The auth_draw_login_page function may authenticate a user if a login
        // request was sent at the same time that the "timed out" message is to
        // be displayed.
        return $USER;
250
251
252
    }
    else {
        // There is no session, so we check to see if one needs to be started.
253
        
254
        // Build login form. If the form is submitted it will be handled here,
255
256
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
257
258
259
        require_once('form.php');
        $form = new Form(auth_get_login_form());
        if ($USER) {
Nigel McNie's avatar
Nigel McNie committed
260
            log_debug('user logged in just fine');
261
262
263
264
            return $USER;
        }
        
        // Check if the page is public or the site is configured to be public.
265
        if (defined('PUBLIC') && !isset($_GET['login'])) {
266
            log_debug('user viewing public page');
267
            return;
268
        }
269
        
270
        log_debug('no session or old session and page is private, or explicit login request');
271
        auth_draw_login_page(null, $form);
272
        exit;
273
274
275
276
277
278
279
280
281
    }
}

/**
 * Given an institution, returns the authentication method used by it.
 *
 * @return string
 */
function auth_get_authtype_for_institution($institution) {
Nigel McNie's avatar
Nigel McNie committed
282
283
284
285
286
    static $cache = array();
    if (isset($cache[$institution])) {
        return $cache[$institution];
    }
    return $cache[$institution] = get_field('institution', 'authplugin', 'name', $institution);
287
288
}

289
290
291
292
293
294
295
296
/**
 * 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
297
298
299
300
301
302
303
304
305
function auth_check_password_change() {
    global $USER;
    if (!$USER->passwordchange) {
        return;
    }

    $authtype  = auth_get_authtype_for_institution($USER->institution);
    $authclass = 'Auth' . ucfirst($authtype);
    $url       = '';
306
    safe_require('auth', $authtype);
Nigel McNie's avatar
Nigel McNie committed
307
308
309
310
311
    
    // @todo auth preference for a password change screen for all auth methods other than internal
    if (
        ($url = get_config_plugin('auth', $authtype, 'changepasswordurl'))
        || (method_exists($authclass, 'change_password'))) {
Nigel McNie's avatar
Nigel McNie committed
312
        log_debug('user needs to change their password');
Nigel McNie's avatar
Nigel McNie committed
313
314
315
316
317
        if ($url) {
            redirect($url);
            exit;
        }

318
319
        require_once('form.php');
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
            'name'      => 'change_password',
            'method'    => 'post',
            'elements'  => array(
                'passwords' => array(
                    'type' => 'fieldset',
                    'legend' => get_string('newpassword'),
                    'elements' => array(
                        '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(
                                'required' => true
                            )
                        )
343
344
345
                    )
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
346
347
                    'type'  => 'submit',
                    'value' => get_string('changepassword')
348
349
350
351
352
353
354
355
356
357
358
359
360
361
                )
            )
        );

        $smarty = smarty();
        $smarty->assign('change_password_form', form($form));
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
362
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
363
 *
364
365
366
367
 * @param Form  $form   The form to check
 * @param array $values The values to check
 */
function change_password_validate(Form $form, $values) {
368
    global $USER;
369
370
371

    // Get the authentication type for the user (based on the institution), and
    // use the information to validate the password
372
    $authtype  = auth_get_authtype_for_institution($USER->institution);
Nigel McNie's avatar
Nigel McNie committed
373
374
    $authclass = 'Auth' . ucfirst($authtype);
    $authlang  = 'auth.' . $authtype;
375
    safe_require('auth', $authtype);
376

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

Nigel McNie's avatar
Nigel McNie committed
380
    // The password cannot be the same as the old one
381
382
    if (!$form->get_error('password1')
        && call_static_method($authclass, 'authenticate_user_account', $USER->username, $values['password1'], $USER->institution)) {
Nigel McNie's avatar
Nigel McNie committed
383
        $form->set_error('password1', get_string('passwordnotchanged'));
384
385
386
387
388
389
390
391
392
    }
}

/**
 * Changes the password for a user, given that it is valid.
 *
 * @param array $values The submitted form values
 */
function change_password_submit($values) {
393
    global $SESSION;
394
395
    log_debug('changing password to ' . $values['password1']);
    $authtype = auth_get_authtype_for_institution($SESSION->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
396
397
398
399
    $authclass = 'Auth' . ucfirst($authtype);

    // This method should exists, because if it did not then the change
    // password form would not have been shown.
400
    if ($password = call_static_method($authclass, 'change_password', $SESSION->get('username'), $values['password1'])) {
401
        $user = new StdClass;
Nigel McNie's avatar
Nigel McNie committed
402
        $user->password = $password;
403
404
405
406
        $user->passwordchange = 0;
        $where = new StdClass;
        $where->username = $SESSION->get('username');
        update_record('usr', $user, $where);
Nigel McNie's avatar
Nigel McNie committed
407
        $SESSION->set('password', $password);
408
        $SESSION->set('passwordchange', 0);
Nigel McNie's avatar
Nigel McNie committed
409
        $SESSION->add_ok_msg(get_string('passwordsaved'));
410
411
412
        redirect(get_config('wwwroot'));
        exit;
    }
Nigel McNie's avatar
Nigel McNie committed
413

Nigel McNie's avatar
Nigel McNie committed
414
415
    throw new Exception('Attempt by "' . $SESSION->get('username') . '@'
        . $SESSION->get('institution') . 'to change their password failed');
416
417
}

418
/**
Nigel McNie's avatar
Nigel McNie committed
419
 * Creates and displays the transient login page.
420
 *
Nigel McNie's avatar
Nigel McNie committed
421
422
423
424
 * 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.
 *
425
426
427
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
Nigel McNie's avatar
Nigel McNie committed
428
429
430
431
 * @param Form $form If specified, just build this form to get the HTML
 *                   required. Otherwise, this function will build and
 *                   validate the form itself.
 * @access private
432
 */
433
434
function auth_draw_login_page($message=null, Form $form=null) {
    global $USER, $SESSION;
435
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
436
        $loginform = get_login_form_js($form->build());
437
438
439
    }
    else {
        require_once('form.php');
Nigel McNie's avatar
Nigel McNie committed
440
        $loginform = get_login_form_js(form(auth_get_login_form()));
441
442
443
444
445
        /*
         * 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.
         */
446
        if ($USER) {
447
448
449
450
451
452
453
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
454
    }
455
    $smarty = smarty();
456
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
457
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
458
459
460
    $smarty->display('login.tpl');
    exit;
}
461

462
/**
Nigel McNie's avatar
Nigel McNie committed
463
 * Returns the definition of the login form.
464
 *
Nigel McNie's avatar
Nigel McNie committed
465
466
 * @return array   The login form definition array.
 * @access private
467
468
 */
function auth_get_login_form() {
469
470
471
    $elements = array(
        'login' => array(
            'type'   => 'fieldset',
Nigel McNie's avatar
Nigel McNie committed
472
            'legend' => get_string('login'),
473
474
475
            'elements' => array(
                'login_username' => array(
                    'type'        => 'text',
Nigel McNie's avatar
Nigel McNie committed
476
477
478
                    'title'       => get_string('username'),
                    'description' => get_string('usernamedesc'),
                    'help'        => get_string('usernamehelp'),
479
480
481
                    'rules' => array(
                        'required'    => true
                    )
482
483
484
                ),
                'login_password' => array(
                    'type'        => 'password',
Nigel McNie's avatar
Nigel McNie committed
485
486
487
                    'title'       => get_string('password'),
                    'description' => get_string('passworddesc'),
                    'help'        => get_string('passwordhelp'),
488
489
490
491
                    'value'       => '',
                    'rules' => array(
                        'required'    => true
                    )
492
493
494
495
496
497
                )
            )
        ),

        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
498
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
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
    );

    // 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(
535
536
537
        'name'     => 'login',
        'method'   => 'post',
        'action'   => $action,
538
539
        'elements' => $elements,
        'iscancellable' => false
540
541
    );

542
    return $form;
543
544
}

Nigel McNie's avatar
Nigel McNie committed
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
/**
 * 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.
 *
 * @param string $form A rendered login form
 * @return string      The form with extra javascript added for cookie detection
 * @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">
var loginbox = $('loginbox');
document.cookie = '$cookiename=1;expires=0';
if (document.cookie) {
    loginbox.innerHTML = '$form';
564
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
565
566
}
else {
567
    replaceChildNodes(loginbox, P(null, '$strcookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
568
569
570
571
}
</script>
EOF;
}
572

573
/**
574
575
 * Called when the login form is submittd. Validates the user and password, and
 * if they are valid, starts a new session for the user.
576
 *
577
 * @param array $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
578
 * @access private
579
 */
580
function login_submit($values) {
581
582
    global $SESSION, $USER;

Nigel McNie's avatar
Nigel McNie committed
583
    log_debug('auth details supplied, attempting to log user in');
Nigel McNie's avatar
Nigel McNie committed
584

585
586
    $username    = $values['login_username'];
    $password    = $values['login_password'];
Nigel McNie's avatar
Nigel McNie committed
587
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
588
589
            
    $authtype = auth_get_authtype_for_institution($institution);
590
    safe_require('auth', $authtype);
591
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
592

593
594
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
Nigel McNie's avatar
Nigel McNie committed
595
            log_debug('user ' . $username . ' logged in OK');
Nigel McNie's avatar
Nigel McNie committed
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623

            if (!record_exists('usr', 'username', $username)) {
                // We don't know about this user. But if the authentication
                // method says they're fine, then we must insert data for them
                // into the usr table.
                log_debug('this user authenticated but not in the usr table, adding them');
                // @todo document what needs to be returned by get_user_info
                $USER = call_static_method($authclass, 'get_user_info', $username);
                insert_record('usr', $USER);
            }
            // @todo config form option for this for each external plugin. NOT for internal
            else if (get_config_plugin('auth', $authtype, 'updateuserinfoonlogin')) {
                log_debug('updating user info from auth method');
                $USER = call_static_method($authclass, 'get_user_info', $username);
                $where = new StdClass;
                $where->username = $username;
                $where->institution = $institution;
                // @todo as per the above todo about what needs to be returned by get_user_info,
                // that needs to be validated somewhere. Because here we do an insert into the
                // usr table, that needs to work. and provide enough information for future
                // authentication attempts
                update_record('usr', $USER, $where);
            }
            else {
                log_debug('getting user info from database');
                $USER = get_record('usr', 'username', $username, null, null, null, null, '*, ' . db_format_tsfield('expiry'));
            }

624
625
626
627
628
629
            // Only admins in the admin section!
            if (defined('ADMIN') && !$USER->admin) {
                $SESSION->add_err_msg(get_string('accessforbiddentoadminsection'));
                redirect(get_config('wwwroot'));
            }

Nigel McNie's avatar
Nigel McNie committed
630
631
            // Check if the user's account has expired
            if ($USER->expiry > 0 && time() > $USER->expiry) {
Nigel McNie's avatar
Nigel McNie committed
632
                log_debug('the user account has expired');
Nigel McNie's avatar
Nigel McNie committed
633
634
635
636
637
638
639
                // Trash the $USER object, used for checking if the user is logged in.
                // Smarty uses it and puts login-only stuff in the output otherwise...
                $USER = null;
                die_info(get_string('accountexpired'));
            }

            // Check if the user's account has been suspended
640
641
642
643
            // Note: only the internal authentication method can say if a user is suspended for now.
            // There are problems with how searching excluding suspended users will work that would
            // need to be resolved before this could be implemented for all methods
            if ($suspend = get_record('usr_suspension', 'usr', $USER->id)) {
Nigel McNie's avatar
Nigel McNie committed
644
                log_debug('the user account has been suspended');
Nigel McNie's avatar
Nigel McNie committed
645
646
647
648
649
                $USER = null;
                die_info(get_string('accountsuspended', 'mahara', $suspend->ctime, $suspend->reason));
            }

            // User is allowed to log in
650
651
            $SESSION->login($USER);
            $USER->logout_time = $SESSION->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
652
            auth_check_password_change();
653
654
655
        }
        else {
            // Login attempt failed
Nigel McNie's avatar
Nigel McNie committed
656
657
            log_debug('login attempt FAILED');
            $SESSION->add_err_msg(get_string('loginfailed'));
658
659
660
        }
    }
    catch (AuthUnknownUserException $e) {
Nigel McNie's avatar
Nigel McNie committed
661
662
        log_debug('unknown user ' . $username);
        $SESSION->add_err_msg(get_string('loginfailed'));
663
    }
664
665
}

Nigel McNie's avatar
Nigel McNie committed
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
/**
 * Passes the form data through to the validation method of the appropriate
 * authentication plugin, for it to validate if necessary.
 *
 * This is for validation of the configuration form that each authentication
 * method exports
 *
 * @param Form  $form   The form to validate
 * @param array $values The values submitted to check
 * @access private
 */
function auth_validate(Form $form, $values) {
    $class = 'Auth' . $values['method'];
    safe_require('auth', $values['method'], 'lib.php', 'require_once');
    call_static_method($class, 'validate_configuration_form', $form, $values);
}

/**
 * Handles submission of the configuration form for an authentication method.
 * Sets each configuration value in the database.
 *
 * @param array $values The submitted values, successfully validated
 * @access private
 */
690
691
function auth_submit($values) {
    global $SESSION, $db;
Nigel McNie's avatar
Nigel McNie committed
692
    // @todo use db_begin/db_commit
693
694
695
696
697
698
699
700
701
702
703
704
705
    $db->StartTrans();

    foreach ($values as $key => $value) {
        if (!in_array($key, array('submit', 'method'))) {
            set_config_plugin('auth', $values['method'], $key, $value);
        }
    }
    if ($db->HasFailedTrans()) {
        $db->CompleteTrans();
        throw new Exception('Could not update the configuration options for the auth method');
    }
    $db->CompleteTrans();
    $SESSION->add_ok_msg(get_string('authconfigurationoptionssaved') . ' ' . get_config_plugin('auth', $values['method'], $key));
706
707
708
}

?>