lib.php 32 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
55
56
57
58
59
60
61
62
63
64
65
66
 */
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);

67
68
69
70
71
72
73
74
    /**
     * 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
     */
    public static abstract function user_exists($username);

75
76
77
78
79
80
81
82
    /**
     * 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
     */
83
    public static abstract function get_user_info($username);
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
    /**
     * Given a username, return information about the user from the database.
     *
     * This method is called when the user has been successfully authenticated,
     * all createuser events have been fired and now we wish to populate the
     * users session.
     *
     * 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
     */
    public static abstract function get_user_info_cached($username);

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

132
133
134
135
}


/**
Nigel McNie's avatar
Nigel McNie committed
136
 * Handles authentication by setting up a session for a user if they are logged in.
137
138
139
140
141
142
143
144
 *
 * 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
145
146
147
148
149
150
151
 *
 * 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.
 *
152
153
 */
function auth_setup () {
154
    global $SESSION, $USER;
155
156
157
158

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
159
        $USER->logout();
160
161
162
163
164
        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.
165
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
166
    if ($sessionlogouttime && isset($_GET['logout'])) {
167
168
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
169
        redirect();
Nigel McNie's avatar
Nigel McNie committed
170
171
    }
    if ($sessionlogouttime > time()) {
172
        // The session is still active, so continue it.
173
174
175
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
176
177
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->get('id'));
            if (!$USER->get('admin') && $userreallyadmin) {
178
                // The user has been made into an admin
179
                $USER->set('admin', 1);
180
            }
181
            else if ($USER->get('admin') && !$userreallyadmin) {
182
                // The user's admin rights have been taken away
183
                $USER->set('admin', 0);
184
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
185
                redirect();
186
            }
187
            elseif (!$USER->get('admin')) {
188
                // The user never was an admin
189
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
190
                redirect();
191
            }
192
        }
193
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
194
        auth_check_password_change();
195
196
197
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
198
        $USER->logout();
199
200
201
202
203
204
205
206
207
208
209

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

210
        auth_draw_login_page(get_string('sessiontimedout'));
211
212
213
    }
    else {
        // There is no session, so we check to see if one needs to be started.
214
        // Build login form. If the form is submitted it will be handled here,
215
216
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
217
218
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
219
220
        if ($USER->is_logged_in()) {
            return;
221
222
223
        }
        
        // Check if the page is public or the site is configured to be public.
224
        if (defined('PUBLIC') && !isset($_GET['login'])) {
225
            return;
226
        }
227
        
228
        auth_draw_login_page(null, $form);
229
        exit;
230
231
232
233
234
235
236
237
238
    }
}

/**
 * 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
239
240
241
242
243
    static $cache = array();
    if (isset($cache[$institution])) {
        return $cache[$institution];
    }
    return $cache[$institution] = get_field('institution', 'authplugin', 'name', $institution);
244
245
}

246
247
248
249
250
251
252
253
/**
 * 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
254
255
function auth_check_password_change() {
    global $USER;
256
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
257
258
259
        return;
    }

260
    $authtype  = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
261
262
    $authclass = 'Auth' . ucfirst($authtype);
    $url       = '';
263
    safe_require('auth', $authtype);
Nigel McNie's avatar
Nigel McNie committed
264
265
266
267
268
269
270
271
272
273
    
    // @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'))) {
        if ($url) {
            redirect($url);
            exit;
        }

274
        require_once('pieforms/pieform.php');
275
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
276
277
278
279
280
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
281
282
283
284
285
286
287
288
289
290
291
292
293
                '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(
294
295
296
297
298
299
300
301
302
303
304
                        '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,
                    ),
305
306
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
307
                    'type'  => 'submit',
308
309
                    'value' => get_string('changepassword'),
                ),
310
311
312
313
            )
        );

        $smarty = smarty();
314
        $smarty->assign('change_password_form', pieform($form));
315
316
317
318
319
320
321
322
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
323
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
324
 *
325
326
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
327
 */
328
function change_password_validate(Pieform $form, $values) {
329
    global $USER;
330
331
332

    // Get the authentication type for the user (based on the institution), and
    // use the information to validate the password
333
    $authtype  = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
334
335
    $authclass = 'Auth' . ucfirst($authtype);
    $authlang  = 'auth.' . $authtype;
336
    safe_require('auth', $authtype);
337

Nigel McNie's avatar
Nigel McNie committed
338
    // @todo this could be done by a custom form rule... 'password' => $user
339
    password_validate($form, $values, $USER->get('username'), $USER->get('institution'));
340

Nigel McNie's avatar
Nigel McNie committed
341
    // The password cannot be the same as the old one
342
    if (!$form->get_error('password1')
343
        && call_static_method($authclass, 'authenticate_user_account', $USER->get('username'), $values['password1'], $USER->get('institution'))) {
Nigel McNie's avatar
Nigel McNie committed
344
        $form->set_error('password1', get_string('passwordnotchanged'));
345
346
347
348
349
350
351
352
    }
}

/**
 * Changes the password for a user, given that it is valid.
 *
 * @param array $values The submitted form values
 */
353
function change_password_submit(Pieform $form, $values) {
354
355
    global $USER, $SESSION;
    $authtype = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
356
357
    $authclass = 'Auth' . ucfirst($authtype);

358
    // This method should exist, because if it did not then the change
Nigel McNie's avatar
Nigel McNie committed
359
    // password form would not have been shown.
360
    if ($password = call_static_method($authclass, 'change_password', $USER->get('username'), $values['password1'])) {
361
        $user = new StdClass;
Nigel McNie's avatar
Nigel McNie committed
362
        $user->password = $password;
363
364
        $user->passwordchange = 0;
        $where = new StdClass;
365
        $where->username = $USER->get('username');
366
        update_record('usr', $user, $where);
367
368
        $USER->set('password', $password);
        $USER->set('passwordchange', 0);
Nigel McNie's avatar
Nigel McNie committed
369
        $SESSION->add_ok_msg(get_string('passwordsaved'));
370
371
372
        if (!empty($values['email'])) {
            set_profile_field($USER->get('id'), 'email', $values['email']);
        }
373
        redirect();
374
    }
Nigel McNie's avatar
Nigel McNie committed
375

376
377
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
378
379
}

380
/**
Nigel McNie's avatar
Nigel McNie committed
381
 * Creates and displays the transient login page.
382
 *
Nigel McNie's avatar
Nigel McNie committed
383
384
385
386
 * 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.
 *
387
388
389
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
390
391
392
 * @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
393
 * @access private
394
 */
395
function auth_draw_login_page($message=null, Pieform $form=null) {
396
    global $USER, $SESSION;
397
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
398
        $loginform = get_login_form_js($form->build());
399
400
    }
    else {
401
        require_once('pieforms/pieform.php');
402
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
403
404
405
406
407
        /*
         * 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.
         */
408
        if ($USER->is_logged_in()) {
409
410
411
412
413
414
415
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
416
    }
417
    $smarty = smarty();
418
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
419
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
420
421
422
    $smarty->display('login.tpl');
    exit;
}
423

424
/**
Nigel McNie's avatar
Nigel McNie committed
425
 * Returns the definition of the login form.
426
 *
Nigel McNie's avatar
Nigel McNie committed
427
428
 * @return array   The login form definition array.
 * @access private
429
430
 */
function auth_get_login_form() {
431
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
432
433
434
435
436
    $defaultinstitution = get_cookie('institution');
    if (!$defaultinstitution) {
        $defaultinstitution = 'mahara';
    }

437
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
438
439
440
441
442
443
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
444
445
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
        '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
        ),
465
466
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
467
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
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
495
496
497
498
499
500
501
502
503
    );

    // 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(
504
505
506
507
508
509
510
511
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
512
513
    );

514
    return $form;
515
516
}

Nigel McNie's avatar
Nigel McNie committed
517
518
519
520
521
/**
 * 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.
 *
522
523
 * @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
524
525
526
527
528
529
530
531
 * @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">
532
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
533
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
534
535
if (document.cookie) {
    loginbox.innerHTML = '$form';
536
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
537
538
}
else {
539
    replaceChildNodes(loginbox, P(null, '$strcookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
540
541
542
543
}
</script>
EOF;
}
544

545
/**
546
547
 * Called when the login form is submittd. Validates the user and password, and
 * if they are valid, starts a new session for the user.
548
 *
549
 * @param array $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
550
 * @access private
551
 */
552
function login_submit(Pieform $form, $values) {
553
554
555
556
    global $SESSION, $USER;

    $username    = $values['login_username'];
    $password    = $values['login_password'];
Nigel McNie's avatar
Nigel McNie committed
557
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
558
559
            
    $authtype = auth_get_authtype_for_institution($institution);
560
    safe_require('auth', $authtype);
561
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
562

563
564
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
565
            // User logged in! Set a cookie to remember their institution
566
            set_cookie('institution', $institution, 0, get_mahara_install_subdirectory());
567
            $oldlastlogin = null;
Nigel McNie's avatar
Nigel McNie committed
568

569
            if (!call_static_method($authclass, 'user_exists', $username)) {
Nigel McNie's avatar
Nigel McNie committed
570
571
572
573
                // 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.
                // @todo document what needs to be returned by get_user_info
574
                $userdata = call_static_method($authclass, 'get_user_info', $username);
575
                $userdata->lastlogin = db_format_timestamp(time());
576
                insert_record('usr', $userdata);
Nigel McNie's avatar
Nigel McNie committed
577
                handle_event('createuser', $userdata);
Nigel McNie's avatar
Nigel McNie committed
578
579
580
            }
            // @todo config form option for this for each external plugin. NOT for internal
            else if (get_config_plugin('auth', $authtype, 'updateuserinfoonlogin')) {
581
                $userdata = call_static_method($authclass, 'get_user_info', $username);
582
583
584
                $oldlastlogin = $userdata->lastlogin;
                $userdata->lastlogin = db_format_timestamp(time());
                $userdata->inactivemailsent = 0;
Nigel McNie's avatar
Nigel McNie committed
585
586
587
588
589
590
591
                $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
592
                update_record('usr', $userdata, $where);
Nigel McNie's avatar
Nigel McNie committed
593
594
            }
            else {
595
                $userdata = call_static_method($authclass, 'get_user_info_cached', $username);
596
597
598
599
600
                $oldlastlogin = $userdata->lastlogin;
                $userdata->lastlogin = time();
                $userdata->inactivemailsent = 0;
                set_field('usr', 'lastlogin', db_format_timestamp($userdata->lastlogin), 'username', $username);
                set_field('usr', 'inactivemailsent', 0, 'username', $username);
Nigel McNie's avatar
Nigel McNie committed
601
602
            }

603
            // Only admins in the admin section!
604
            if (defined('ADMIN') && !$userdata->admin) {
605
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
606
                redirect();
607
608
            }

609
610
611
612
613
            // Check if the user's account has been deleted
            if ($userdata->deleted) {
                die_info(get_string('accountdeleted'));
            }

Nigel McNie's avatar
Nigel McNie committed
614
            // Check if the user's account has expired
615
            if ($userdata->expiry > 0 && time() > $userdata->expiry) {
Nigel McNie's avatar
Nigel McNie committed
616
617
618
                die_info(get_string('accountexpired'));
            }

619
            // Check if the user's account has become inactive
Nigel McNie's avatar
Nigel McNie committed
620
621
622
            $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $userdata->institution);
            if ($inactivetime && $oldlastlogin > 0
                && $oldlastlogin + $inactivetime < time()) {
623
624
625
                die_info(get_string('accountinactive'));
            }

Nigel McNie's avatar
Nigel McNie committed
626
            // Check if the user's account has been suspended
627
628
            if ($userdata->suspendedcusr) {
                die_info(get_string('accountsuspended', 'mahara', $userdata->suspendedctime, $userdata->suspendedreason));
Nigel McNie's avatar
Nigel McNie committed
629
630
631
            }

            // User is allowed to log in
632
            $USER->login($userdata);
Nigel McNie's avatar
Nigel McNie committed
633
            auth_check_password_change();
634
635
636
        }
        else {
            // Login attempt failed
637
            $SESSION->add_error_msg(get_string('loginfailed'));
638
639
640
        }
    }
    catch (AuthUnknownUserException $e) {
641
        $SESSION->add_error_msg(get_string('loginfailed'));
642
    }
643
644
}

645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
/**
 * Removes registration requests that were not completed in the allowed amount of time
 */
function auth_clean_partial_registrations() {
    $prefix = get_config('dbprefix');
    delete_records_sql('DELETE FROM ' . $prefix . 'usr_registration
        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
    $prefix   = get_config('dbprefix');
    $sitename = get_config('sitename');
    $wwwroot  = get_config('wwwroot');

673
    // Expiry warning messages
674
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
        FROM ' . $prefix . 'usr u, ' . $prefix . 'institution i
        WHERE u.institution = i.name
        AND ? - ' . db_format_tsfield('u.expiry', false) . ' < i.defaultaccountinactivewarn
        AND expirymailsent = 0', array(time()))) {
        foreach ($users as $user) {
            $displayname  = display_name($user);
            $daystoexpire = ceil($user->timeout / 86400) . ' ';
            $daystoexpire .= ($daystoexpire == 1) ? get_string('day') : get_string('days');
            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);
        }
    }

692
    // Actual expired users
693
    if ($users = get_records_sql_array('SELECT id
694
        FROM ' . $prefix . 'usr
695
        WHERE ' . db_format_tsfield('expiry', false) . ' < ?', array(time()))) {
696
697
698
699
700
701
        // Users have expired!
        foreach ($users as $user) {
            expire_user($user->id);
        }
    }

702
    // Inactivity (lastlogin is too old)
703
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
        FROM ' . $prefix . 'usr u, ' . $prefix . 'institution i
        WHERE u.institution = i.name
        AND (? - ' . db_format_tsfield('u.lastlogin', false) . ') > (i.defaultaccountinactiveexpire - i.defaultaccountinactivewarn)
        AND inactivemailsent = 0', array(time()))) {
        foreach ($users as $user) {
            $displayname = display_name($user);
            $daystoinactive = ceil($user->timeout / 86400) . ' ';
            $daystoinactive .= ($daystoexpire == 1) ? get_string('day') : get_string('days');
            email_user($user, null, get_string('accountinactivewarning'),
                get_string('accountinactivewarningtext', 'mahara', $displayname, $sitename, $daystoinactive, $sitename),
                get_string('accountinactivewarninghtml', 'mahara', $displayname, $sitename, $daystoinactive, $sitename)
            );
            set_field('usr', 'inactivemailsent', 1, 'id', $user->id);
        }
    }
719
720
721
    
    // Actual inactive users
    if ($users = get_records_sql_array('SELECT u.id
Nigel McNie's avatar
Nigel McNie committed
722
        FROM ' . $prefix . 'usr u
723
        LEFT JOIN ' . $prefix . 'institution i ON (u.institution = i.name)
724
        WHERE ' . db_format_tsfield('lastlogin', false) . ' < ? - i.defaultaccountinactiveexpire', array(time()))) {
725
726
727
728
729
        // Users have become inactive!
        foreach ($users as $user) {
            deactivate_user($user->id);
        }
    }
730
731
}

Martyn Smith's avatar
Martyn Smith committed
732
function auth_generate_login_form() {
Nigel McNie's avatar
Nigel McNie committed
733
734
735
    if (!get_config('installed')) {
        return;
    }
Martyn Smith's avatar
Martyn Smith committed
736
737
738
739
740
741
742
743
744
745
746
747
748
    require_once('pieforms/pieform.php');
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
    $defaultinstitution = get_cookie('institution');
    if (!$defaultinstitution) {
        $defaultinstitution = 'mahara';
    }
    $loginform = get_login_form_js(pieform(array(
        'name'       => 'login',
        'renderer'   => 'div',
        'submit'     => false,
        'plugintype' => 'auth',
        'pluginname' => 'internal',
        'elements'   => array(
749
750
751
752
753
754
            'login_username' => array(
                'type'        => 'text',
                'title'       => get_string('username') . ':',
                'description' => get_string('usernamedescription'),
                'rules' => array(
                    'required'    => true
Martyn Smith's avatar
Martyn Smith committed
755
756
                )
            ),
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
            '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,
                'help' => true,
            ),
Martyn Smith's avatar
Martyn Smith committed
777
778
779
780
781
782
783
784
785
786
787
788
789
790
            '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;
}

791
792
793
794

class PluginAuth extends Plugin {

    public static function get_event_subscriptions() {
795
796
        $subscriptions = array();

797
798
        $activecheck = new StdClass;
        $activecheck->plugin = 'internal';
799
        $activecheck->event  = 'suspenduser';
800
        $activecheck->callfunction = 'update_active_flag';
801
        $subscriptions[] = clone $activecheck;
802
        $activecheck->event = 'unsuspenduser';
803
        $subscriptions[] = clone $activecheck;
804
        $activecheck->event = 'deleteuser';
805
        $subscriptions[] = clone $activecheck;
806
        $activecheck->event = 'undeleteuser';
807
        $subscriptions[] = clone $activecheck;
808
        $activecheck->event = 'expireuser';
809
        $subscriptions[] = clone $activecheck;
810
        $activecheck->event = 'unexpireuser';
811
        $subscriptions[] = clone $activecheck;
812
        $activecheck->event = 'deactivateuser';
813
        $subscriptions[] = clone $activecheck;
814
        $activecheck->event = 'activateuser';
815
        $subscriptions[] = clone $activecheck;
816
817

        return $subscriptions;
818
819
    }

820
    public static function update_active_flag($event, $user) {
821
822
        $active = true;

823
824
        // ensure we have everything we need
        $user = get_user($user['id']);
825
826
827
828
829

        $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $user->institution);
        if ($user->suspendedcusr) {
            $active = false;
        }
830
        else if ($user->expiry && $user->expiry < time()) {
831
832
833
834
835
836
837
838
839
840
            $active = false;
        }
        else if ($inactivetime && $user->lastlogin + $inactivetime < time()) {
            $active = false;
        }
        else if ($user->deleted) {
            $active = false;
        }

        if ($active != $user->active) {
841
            set_field('usr', 'active', (int)$active, 'id', $user->id);
842
        }
843
844
845
846
    }

}

847
?>