lib.php 28.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

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

Nigel McNie's avatar
Nigel McNie committed
71
72
73
74
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
75
76
77
78
79
     * 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
80
81
82
83
     *
     * 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!
     *
84
85
86
     * 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
87
88
89
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
90
    public static function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
91
92
93
        return true;
    }

94
95
96
97
}


/**
Nigel McNie's avatar
Nigel McNie committed
98
 * Handles authentication by setting up a session for a user if they are logged in.
99
100
101
102
103
104
105
106
 *
 * 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
107
108
109
110
111
112
113
 *
 * 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.
 *
114
115
 */
function auth_setup () {
116
    global $SESSION, $USER;
117
118
119
120

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
121
        $USER->logout();
122
123
124
125
126
        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.
127
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
128
    if ($sessionlogouttime && isset($_GET['logout'])) {
129
130
131
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
        redirect(get_config('wwwroot'));
Nigel McNie's avatar
Nigel McNie committed
132
133
    }
    if ($sessionlogouttime > time()) {
134
        // The session is still active, so continue it.
135
136
137
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
138
139
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->get('id'));
            if (!$USER->get('admin') && $userreallyadmin) {
140
                // The user has been made into an admin
141
                $USER->set('admin', 1);
142
            }
143
            else if ($USER->get('admin') && !$userreallyadmin) {
144
                // The user's admin rights have been taken away
145
                $USER->set('admin', 0);
146
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
147
148
                redirect(get_config('wwwroot'));
            }
149
            elseif (!$USER->get('admin')) {
150
                // The user never was an admin
151
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
152
153
                redirect(get_config('wwwroot'));
            }
154
        }
155
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
156
        auth_check_password_change();
157
158
159
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
160
        $USER->logout();
161
162
163
164
165
166
167
168
169
170
171

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

172
173
174
175
        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.
176
        //return $USER;
177
178
179
    }
    else {
        // There is no session, so we check to see if one needs to be started.
180
        // Build login form. If the form is submitted it will be handled here,
181
182
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
183
184
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
185
186
        if ($USER->is_logged_in()) {
            return;
187
188
189
        }
        
        // Check if the page is public or the site is configured to be public.
190
        if (defined('PUBLIC') && !isset($_GET['login'])) {
191
            return;
192
        }
193
        
194
        auth_draw_login_page(null, $form);
195
        exit;
196
197
198
199
200
201
202
203
204
    }
}

/**
 * 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
205
206
207
208
209
    static $cache = array();
    if (isset($cache[$institution])) {
        return $cache[$institution];
    }
    return $cache[$institution] = get_field('institution', 'authplugin', 'name', $institution);
210
211
}

212
213
214
215
216
217
218
219
/**
 * 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
220
221
function auth_check_password_change() {
    global $USER;
222
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
223
224
225
        return;
    }

226
    $authtype  = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
227
228
    $authclass = 'Auth' . ucfirst($authtype);
    $url       = '';
229
    safe_require('auth', $authtype);
Nigel McNie's avatar
Nigel McNie committed
230
231
232
233
234
235
236
237
238
239
    
    // @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;
        }

240
        require_once('pieforms/pieform.php');
241
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
242
243
244
245
246
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
Nigel McNie's avatar
Nigel McNie committed
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
                '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
                            )
                        )
267
268
269
                    )
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
270
271
                    'type'  => 'submit',
                    'value' => get_string('changepassword')
272
273
274
275
276
                )
            )
        );

        $smarty = smarty();
277
        $smarty->assign('change_password_form', pieform($form));
278
279
280
281
282
283
284
285
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
286
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
287
 *
288
289
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
290
 */
291
function change_password_validate(Pieform $form, $values) {
292
    global $USER;
293
294
295

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

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

Nigel McNie's avatar
Nigel McNie committed
304
    // The password cannot be the same as the old one
305
    if (!$form->get_error('password1')
306
        && call_static_method($authclass, 'authenticate_user_account', $USER->get('username'), $values['password1'], $USER->get('institution'))) {
Nigel McNie's avatar
Nigel McNie committed
307
        $form->set_error('password1', get_string('passwordnotchanged'));
308
309
310
311
312
313
314
315
316
    }
}

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

    // This method should exists, because if it did not then the change
    // password form would not have been shown.
323
    if ($password = call_static_method($authclass, 'change_password', $USER->get('username'), $values['password1'])) {
324
        $user = new StdClass;
Nigel McNie's avatar
Nigel McNie committed
325
        $user->password = $password;
326
327
        $user->passwordchange = 0;
        $where = new StdClass;
328
        $where->username = $USER->get('username');
329
        update_record('usr', $user, $where);
330
331
        $USER->set('password', $password);
        $USER->set('passwordchange', 0);
Nigel McNie's avatar
Nigel McNie committed
332
        $SESSION->add_ok_msg(get_string('passwordsaved'));
333
334
335
        redirect(get_config('wwwroot'));
        exit;
    }
Nigel McNie's avatar
Nigel McNie committed
336

337
338
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
339
340
}

341
/**
Nigel McNie's avatar
Nigel McNie committed
342
 * Creates and displays the transient login page.
343
 *
Nigel McNie's avatar
Nigel McNie committed
344
345
346
347
 * 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.
 *
348
349
350
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
351
352
353
 * @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
354
 * @access private
355
 */
356
function auth_draw_login_page($message=null, Pieform $form=null) {
357
    global $USER, $SESSION;
358
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
359
        $loginform = get_login_form_js($form->build());
360
361
    }
    else {
362
        require_once('pieforms/pieform.php');
363
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
364
365
366
367
368
        /*
         * 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.
         */
369
        if ($USER->is_logged_in()) {
370
371
372
373
374
375
376
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
377
    }
378
    $smarty = smarty();
379
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
380
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
381
382
383
    $smarty->display('login.tpl');
    exit;
}
384

385
/**
Nigel McNie's avatar
Nigel McNie committed
386
 * Returns the definition of the login form.
387
 *
Nigel McNie's avatar
Nigel McNie committed
388
389
 * @return array   The login form definition array.
 * @access private
390
391
 */
function auth_get_login_form() {
392
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
393
394
395
    $elements = array(
        'login' => array(
            'type'   => 'fieldset',
Nigel McNie's avatar
Nigel McNie committed
396
            'legend' => get_string('login'),
397
398
399
            'elements' => array(
                'login_username' => array(
                    'type'        => 'text',
Nigel McNie's avatar
Nigel McNie committed
400
                    'title'       => get_string('username'),
401
                    'description' => get_string('usernamedescription'),
402
403
404
                    'rules' => array(
                        'required'    => true
                    )
405
406
407
                ),
                'login_password' => array(
                    'type'        => 'password',
Nigel McNie's avatar
Nigel McNie committed
408
                    'title'       => get_string('password'),
409
                    'description' => get_string('passworddescription'),
410
411
412
413
                    'value'       => '',
                    'rules' => array(
                        'required'    => true
                    )
414
415
416
417
418
419
420
421
422
423
                ),
                'login_institution' => array(
                    'type' => 'select',
                    'title' => get_string('institution'),
                    'defaultvalue' => get_cookie('institution'),
                    'options' => $institutions,
                    'rules' => array(
                        'required' => true
                    ),
                    'ignore' => count($institutions) == 1
424
425
426
427
428
429
                )
            )
        ),

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

    // 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(
Nigel McNie's avatar
Nigel McNie committed
467
468
469
470
471
472
        'name'          => 'login',
        'method'        => 'post',
        'action'        => $action,
        'plugintype'    => 'auth',
        'pluginname'    => 'internal',
        'elements'      => $elements,
473
        'iscancellable' => false
474
475
    );

476
    return $form;
477
478
}

Nigel McNie's avatar
Nigel McNie committed
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
/**
 * 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');
Nigel McNie's avatar
Nigel McNie committed
495
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
496
497
if (document.cookie) {
    loginbox.innerHTML = '$form';
498
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
499
500
}
else {
501
    replaceChildNodes(loginbox, P(null, '$strcookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
502
503
504
505
}
</script>
EOF;
}
506

507
/**
508
509
 * Called when the login form is submittd. Validates the user and password, and
 * if they are valid, starts a new session for the user.
510
 *
511
 * @param array $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
512
 * @access private
513
 */
514
function login_submit($values) {
515
516
517
518
    global $SESSION, $USER;

    $username    = $values['login_username'];
    $password    = $values['login_password'];
Nigel McNie's avatar
Nigel McNie committed
519
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
520
521
            
    $authtype = auth_get_authtype_for_institution($institution);
522
    safe_require('auth', $authtype);
523
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
524

525
526
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
527
528
            // User logged in! Set a cookie to remember their institution
            set_cookie('institution', $institution);
529
            $oldlastlogin = null;
Nigel McNie's avatar
Nigel McNie committed
530
531
532
533
534
535

            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.
                // @todo document what needs to be returned by get_user_info
536
                $userdata = call_static_method($authclass, 'get_user_info', $username);
537
                $userdata->lastlogin = db_format_timestamp(time());
538
                insert_record('usr', $userdata);
Nigel McNie's avatar
Nigel McNie committed
539
540
541
            }
            // @todo config form option for this for each external plugin. NOT for internal
            else if (get_config_plugin('auth', $authtype, 'updateuserinfoonlogin')) {
542
                $userdata = call_static_method($authclass, 'get_user_info', $username);
543
544
545
                $oldlastlogin = $userdata->lastlogin;
                $userdata->lastlogin = db_format_timestamp(time());
                $userdata->inactivemailsent = 0;
Nigel McNie's avatar
Nigel McNie committed
546
547
548
549
550
551
552
                $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
553
                update_record('usr', $userdata, $where);
Nigel McNie's avatar
Nigel McNie committed
554
555
            }
            else {
556
557
558
559
560
561
562
                $userdata = get_record('usr', 'username', $username, null, null, null, null,
                    '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin'));
                $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
563
564
            }

565
            // Only admins in the admin section!
566
            if (defined('ADMIN') && !$userdata->admin) {
567
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
568
569
570
                redirect(get_config('wwwroot'));
            }

571
572
573
574
575
            // Check if the user's account has been deleted
            if ($userdata->deleted) {
                die_info(get_string('accountdeleted'));
            }

Nigel McNie's avatar
Nigel McNie committed
576
            // Check if the user's account has expired
577
            if ($userdata->expiry > 0 && time() > $userdata->expiry) {
Nigel McNie's avatar
Nigel McNie committed
578
579
580
                die_info(get_string('accountexpired'));
            }

581
            // Check if the user's account has become inactive
Nigel McNie's avatar
Nigel McNie committed
582
583
584
            $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $userdata->institution);
            if ($inactivetime && $oldlastlogin > 0
                && $oldlastlogin + $inactivetime < time()) {
585
586
587
                die_info(get_string('accountinactive'));
            }

Nigel McNie's avatar
Nigel McNie committed
588
            // Check if the user's account has been suspended
589
590
            if ($userdata->suspendedcusr) {
                die_info(get_string('accountsuspended', 'mahara', $userdata->suspendedctime, $userdata->suspendedreason));
Nigel McNie's avatar
Nigel McNie committed
591
592
593
            }

            // User is allowed to log in
594
            $USER->login($userdata);
Nigel McNie's avatar
Nigel McNie committed
595
            auth_check_password_change();
596
597
598
        }
        else {
            // Login attempt failed
599
            $SESSION->add_error_msg(get_string('loginfailed'));
600
601
602
        }
    }
    catch (AuthUnknownUserException $e) {
603
        $SESSION->add_error_msg(get_string('loginfailed'));
604
    }
605
606
}

607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
/**
 * 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');

635
    // Expiry warning messages
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
    if ($users = get_records_sql_array('SELECT u.id, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
        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);
        }
    }

654
655
656
657
658
659
660
661
662
663
    // Actual expired users
    if ($users = get_records_sql_array('SELECT u.id
        FROM ' . $prefix . 'usr
        WHERE ' . db_format_tsfield('expiry') . ' < ' . time())) {
        // Users have expired!
        foreach ($users as $user) {
            expire_user($user->id);
        }
    }

664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
    // Inactivity (lastlogin is too old)
    if ($users = get_records_sql_array('SELECT u.id, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
        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);
        }
    }
681
682
683
684
685
686
687
688
689
690
691
    
    // Actual inactive users
    if ($users = get_records_sql_array('SELECT u.id
        FROM ' . $prefix . 'usr
        LEFT JOIN ' . $prefix . 'institution i ON (u.institution = i.name)
        WHERE ' . db_format_tsfield('lastlogin') . ' < ? - i.defaultaccountinactiveexpire', array(time()))) {
        // Users have become inactive!
        foreach ($users as $user) {
            deactivate_user($user->id);
        }
    }
692
693
}

694
695
696
697

class PluginAuth extends Plugin {

    public static function get_event_subscriptions() {
698
699
        $subscriptions = array();

700
701
        $activecheck = new StdClass;
        $activecheck->plugin = 'internal';
702
        $activecheck->event  = 'suspenduser';
703
        $activecheck->callfunction = 'update_active_flag';
704
        $subscriptions[] = clone $activecheck;
705
        $activecheck->event = 'unsuspenduser';
706
        $subscriptions[] = clone $activecheck;
707
        $activecheck->event = 'deleteuser';
708
        $subscriptions[] = clone $activecheck;
709
        $activecheck->event = 'undeleteuser';
710
        $subscriptions[] = clone $activecheck;
711
        $activecheck->event = 'expireuser';
712
        $subscriptions[] = clone $activecheck;
713
        $activecheck->event = 'unexpireuser';
714
        $subscriptions[] = clone $activecheck;
715
        $activecheck->event = 'deactivateuser';
716
        $subscriptions[] = clone $activecheck;
717
        $activecheck->event = 'activateuser';
718
        $subscriptions[] = clone $activecheck;
719
720

        return $subscriptions;
721
722
723
    }

    public static function update_active_flag($event, $userid) {
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
        $active = true;

        $user = get_user($userid);

        $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $user->institution);
        if ($user->suspendedcusr) {
            $active = false;
        }
        else if ($user->expiry < time()) {
            $active = false;
        }
        else if ($inactivetime && $user->lastlogin + $inactivetime < time()) {
            $active = false;
        }
        else if ($user->deleted) {
            $active = false;
        }

        if ($active != $user->active) {
            set_field('usr', 'active', (int)$active, 'id', $userid);
        }
745
746
747
748
    }

}

749
?>