lib.php 31.8 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
 */
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);

61
62
63
64
65
66
67
68
    /**
     * 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);

69
70
71
72
73
74
75
76
    /**
     * 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
     */
77
    public static abstract function get_user_info($username);
78

79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    /**
     * 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
103
104
105
106
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
107
108
109
110
111
     * 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
112
113
114
115
     *
     * 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!
     *
116
117
118
     * 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
119
120
121
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
122
    public static function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
123
124
125
        return true;
    }

126
127
128
129
}


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

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

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

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

/**
 * 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
233
234
235
236
237
    static $cache = array();
    if (isset($cache[$institution])) {
        return $cache[$institution];
    }
    return $cache[$institution] = get_field('institution', 'authplugin', 'name', $institution);
238
239
}

240
241
242
243
244
245
246
247
/**
 * 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
248
249
function auth_check_password_change() {
    global $USER;
250
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
251
252
253
        return;
    }

254
    $authtype  = auth_get_authtype_for_institution($USER->get('institution'));
Nigel McNie's avatar
Nigel McNie committed
255
256
    $authclass = 'Auth' . ucfirst($authtype);
    $url       = '';
257
    safe_require('auth', $authtype);
Nigel McNie's avatar
Nigel McNie committed
258
259
260
261
262
263
264
265
266
267
    
    // @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;
        }

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

        $smarty = smarty();
308
        $smarty->assign('change_password_form', pieform($form));
309
310
311
312
313
314
315
316
        $smarty->display('change_password.tpl');
        exit;
    }
}

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

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

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

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

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

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

370
371
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
372
373
}

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

    }

    if ($message) {
        $SESSION->add_info_msg($message);
410
    }
411
    $smarty = smarty();
412
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
413
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
414
415
416
    $smarty->display('login.tpl');
    exit;
}
417

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

431
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
432
433
434
435
436
437
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
438
439
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
        '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
        ),
459
460
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
461
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
462
        ),
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
    );

    // 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(
498
499
500
501
502
503
504
505
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
506
507
    );

508
    return $form;
509
510
}

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

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

    $username    = $values['login_username'];
    $password    = $values['login_password'];
Nigel McNie's avatar
Nigel McNie committed
551
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
552
553
            
    $authtype = auth_get_authtype_for_institution($institution);
554
    safe_require('auth', $authtype);
555
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
556

557
558
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
559
            // User logged in! Set a cookie to remember their institution
560
            set_cookie('institution', $institution, 0, get_mahara_install_subdirectory());
561
            $oldlastlogin = null;
Nigel McNie's avatar
Nigel McNie committed
562

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

597
            // Only admins in the admin section!
598
            if (defined('ADMIN') && !$userdata->admin) {
599
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
600
                redirect();
601
602
            }

603
604
605
606
607
            // Check if the user's account has been deleted
            if ($userdata->deleted) {
                die_info(get_string('accountdeleted'));
            }

Nigel McNie's avatar
Nigel McNie committed
608
            // Check if the user's account has expired
609
            if ($userdata->expiry > 0 && time() > $userdata->expiry) {
Nigel McNie's avatar
Nigel McNie committed
610
611
612
                die_info(get_string('accountexpired'));
            }

613
            // Check if the user's account has become inactive
Nigel McNie's avatar
Nigel McNie committed
614
615
616
            $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $userdata->institution);
            if ($inactivetime && $oldlastlogin > 0
                && $oldlastlogin + $inactivetime < time()) {
617
618
619
                die_info(get_string('accountinactive'));
            }

Nigel McNie's avatar
Nigel McNie committed
620
            // Check if the user's account has been suspended
621
622
            if ($userdata->suspendedcusr) {
                die_info(get_string('accountsuspended', 'mahara', $userdata->suspendedctime, $userdata->suspendedreason));
Nigel McNie's avatar
Nigel McNie committed
623
624
625
            }

            // User is allowed to log in
626
            $USER->login($userdata);
Nigel McNie's avatar
Nigel McNie committed
627
            auth_check_password_change();
628
629
630
        }
        else {
            // Login attempt failed
631
            $SESSION->add_error_msg(get_string('loginfailed'));
632
633
634
        }
    }
    catch (AuthUnknownUserException $e) {
635
        $SESSION->add_error_msg(get_string('loginfailed'));
636
    }
637
638
}

639
640
641
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
/**
 * 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');

667
    // Expiry warning messages
668
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
        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);
        }
    }

686
    // Actual expired users
687
    if ($users = get_records_sql_array('SELECT id
688
        FROM ' . $prefix . 'usr
689
        WHERE ' . db_format_tsfield('expiry', false) . ' < ?', array(time()))) {
690
691
692
693
694
695
        // Users have expired!
        foreach ($users as $user) {
            expire_user($user->id);
        }
    }

696
    // Inactivity (lastlogin is too old)
697
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
        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);
        }
    }
713
714
715
    
    // Actual inactive users
    if ($users = get_records_sql_array('SELECT u.id
Nigel McNie's avatar
Nigel McNie committed
716
        FROM ' . $prefix . 'usr u
717
        LEFT JOIN ' . $prefix . 'institution i ON (u.institution = i.name)
718
        WHERE ' . db_format_tsfield('lastlogin', false) . ' < ? - i.defaultaccountinactiveexpire', array(time()))) {
719
720
721
722
723
        // Users have become inactive!
        foreach ($users as $user) {
            deactivate_user($user->id);
        }
    }
724
725
}

Martyn Smith's avatar
Martyn Smith committed
726
function auth_generate_login_form() {
Nigel McNie's avatar
Nigel McNie committed
727
728
729
    if (!get_config('installed')) {
        return;
    }
Martyn Smith's avatar
Martyn Smith committed
730
731
732
733
734
735
736
737
738
739
740
741
742
    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(
743
744
745
746
747
748
            'login_username' => array(
                'type'        => 'text',
                'title'       => get_string('username') . ':',
                'description' => get_string('usernamedescription'),
                'rules' => array(
                    'required'    => true
Martyn Smith's avatar
Martyn Smith committed
749
750
                )
            ),
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
            '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
771
772
773
774
775
776
777
778
779
780
781
782
783
784
            '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;
}

785
786
787
788

class PluginAuth extends Plugin {

    public static function get_event_subscriptions() {
789
790
        $subscriptions = array();

791
792
        $activecheck = new StdClass;
        $activecheck->plugin = 'internal';
793
        $activecheck->event  = 'suspenduser';
794
        $activecheck->callfunction = 'update_active_flag';
795
        $subscriptions[] = clone $activecheck;
796
        $activecheck->event = 'unsuspenduser';
797
        $subscriptions[] = clone $activecheck;
798
        $activecheck->event = 'deleteuser';
799
        $subscriptions[] = clone $activecheck;
800
        $activecheck->event = 'undeleteuser';
801
        $subscriptions[] = clone $activecheck;
802
        $activecheck->event = 'expireuser';
803
        $subscriptions[] = clone $activecheck;
804
        $activecheck->event = 'unexpireuser';
805
        $subscriptions[] = clone $activecheck;
806
        $activecheck->event = 'deactivateuser';
807
        $subscriptions[] = clone $activecheck;
808
        $activecheck->event = 'activateuser';
809
        $subscriptions[] = clone $activecheck;
810
811

        return $subscriptions;
812
813
    }

814
    public static function update_active_flag($event, $user) {
815
816
        $active = true;

817
818
        // ensure we have everything we need
        $user = get_user($user['id']);
819
820
821
822
823

        $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $user->institution);
        if ($user->suspendedcusr) {
            $active = false;
        }
824
        else if ($user->expiry && $user->expiry < time()) {
825
826
827
828
829
830
831
832
833
834
            $active = false;
        }
        else if ($inactivetime && $user->lastlogin + $inactivetime < time()) {
            $active = false;
        }
        else if ($user->deleted) {
            $active = false;
        }

        if ($active != $user->active) {
835
            set_field('usr', 'active', (int)$active, 'id', $user->id);
836
        }
837
838
839
840
    }

}

841
?>