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

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

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

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

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

        $smarty = smarty();
267
        $smarty->assign('change_password_form', pieform($form));
268 269 270 271 272 273 274 275
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
276
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
277
 *
278 279
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
280
 */
281
function change_password_validate(Pieform $form, $values) {
282
    global $USER;
283 284 285

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

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

Nigel McNie's avatar
Nigel McNie committed
294
    // The password cannot be the same as the old one
295
    if (!$form->get_error('password1')
296
        && call_static_method($authclass, 'authenticate_user_account', $USER->get('username'), $values['password1'], $USER->get('institution'))) {
Nigel McNie's avatar
Nigel McNie committed
297
        $form->set_error('password1', get_string('passwordnotchanged'));
298 299 300 301 302 303 304 305
    }
}

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

    // This method should exists, because if it did not then the change
    // password form would not have been shown.
313
    if ($password = call_static_method($authclass, 'change_password', $USER->get('username'), $values['password1'])) {
314
        $user = new StdClass;
Nigel McNie's avatar
Nigel McNie committed
315
        $user->password = $password;
316 317
        $user->passwordchange = 0;
        $where = new StdClass;
318
        $where->username = $USER->get('username');
319
        update_record('usr', $user, $where);
320 321
        $USER->set('password', $password);
        $USER->set('passwordchange', 0);
Nigel McNie's avatar
Nigel McNie committed
322
        $SESSION->add_ok_msg(get_string('passwordsaved'));
323
        redirect();
324
    }
Nigel McNie's avatar
Nigel McNie committed
325

326 327
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
328 329
}

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

    }

    if ($message) {
        $SESSION->add_info_msg($message);
366
    }
367
    $smarty = smarty();
368
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
369
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
370 371 372
    $smarty->display('login.tpl');
    exit;
}
373

374
/**
Nigel McNie's avatar
Nigel McNie committed
375
 * Returns the definition of the login form.
376
 *
Nigel McNie's avatar
Nigel McNie committed
377 378
 * @return array   The login form definition array.
 * @access private
379 380
 */
function auth_get_login_form() {
381
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
382 383 384 385 386
    $defaultinstitution = get_cookie('institution');
    if (!$defaultinstitution) {
        $defaultinstitution = 'mahara';
    }

387 388 389
    $elements = array(
        'login' => array(
            'type'   => 'fieldset',
Nigel McNie's avatar
Nigel McNie committed
390
            'legend' => get_string('login'),
391 392 393
            'elements' => array(
                'login_username' => array(
                    'type'        => 'text',
Nigel McNie's avatar
Nigel McNie committed
394 395
                    'title'       => get_string('username') . ':',
                    'description' => get_string('usernamedescription'),
396 397 398
                    'rules' => array(
                        'required'    => true
                    )
399 400 401
                ),
                'login_password' => array(
                    'type'        => 'password',
Nigel McNie's avatar
Nigel McNie committed
402 403
                    'title'       => get_string('password') . ':',
                    'description' => get_string('passworddescription'),
404 405 406 407
                    'value'       => '',
                    'rules' => array(
                        'required'    => true
                    )
408 409
                ),
                'login_institution' => array(
410 411 412 413
                    'type'         => 'select',
                    'title'        => get_string('institution'). ':',
                    'defaultvalue' => $defaultinstitution,
                    'options'      => $institutions,
414 415 416 417
                    'rules' => array(
                        'required' => true
                    ),
                    'ignore' => count($institutions) == 1
418 419 420 421 422 423
                )
            )
        ),

        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
424
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
425
        ),
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460
    );

    // 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(
461 462 463 464 465 466 467 468
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
469 470
    );

471
    return $form;
472 473
}

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

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

    $username    = $values['login_username'];
    $password    = $values['login_password'];
Nigel McNie's avatar
Nigel McNie committed
514
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
515 516
            
    $authtype = auth_get_authtype_for_institution($institution);
517
    safe_require('auth', $authtype);
518
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
519

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

            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
531
                $userdata = call_static_method($authclass, 'get_user_info', $username);
532
                $userdata->lastlogin = db_format_timestamp(time());
533
                insert_record('usr', $userdata);
Nigel McNie's avatar
Nigel McNie committed
534
                handle_event('createuser', $userdata);
Nigel McNie's avatar
Nigel McNie committed
535 536 537
            }
            // @todo config form option for this for each external plugin. NOT for internal
            else if (get_config_plugin('auth', $authtype, 'updateuserinfoonlogin')) {
538
                $userdata = call_static_method($authclass, 'get_user_info', $username);
539 540 541
                $oldlastlogin = $userdata->lastlogin;
                $userdata->lastlogin = db_format_timestamp(time());
                $userdata->inactivemailsent = 0;
Nigel McNie's avatar
Nigel McNie committed
542 543 544 545 546 547 548
                $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
549
                update_record('usr', $userdata, $where);
Nigel McNie's avatar
Nigel McNie committed
550 551
            }
            else {
552 553 554 555 556 557 558
                $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
559 560
            }

561
            // Only admins in the admin section!
562
            if (defined('ADMIN') && !$userdata->admin) {
563
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
564 565 566
                redirect(get_config('wwwroot'));
            }

567 568 569 570 571
            // Check if the user's account has been deleted
            if ($userdata->deleted) {
                die_info(get_string('accountdeleted'));
            }

Nigel McNie's avatar
Nigel McNie committed
572
            // Check if the user's account has expired
573
            if ($userdata->expiry > 0 && time() > $userdata->expiry) {
Nigel McNie's avatar
Nigel McNie committed
574 575 576
                die_info(get_string('accountexpired'));
            }

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

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

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

603 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
/**
 * 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');

631
    // Expiry warning messages
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
    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);
        }
    }

650
    // Actual expired users
651
    if ($users = get_records_sql_array('SELECT id
652
        FROM ' . $prefix . 'usr
653
        WHERE ' . db_format_tsfield('expiry', false) . ' < ?', array(time()))) {
654 655 656 657 658 659
        // Users have expired!
        foreach ($users as $user) {
            expire_user($user->id);
        }
    }

660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
    // 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);
        }
    }
677 678 679
    
    // Actual inactive users
    if ($users = get_records_sql_array('SELECT u.id
Nigel McNie's avatar
Nigel McNie committed
680
        FROM ' . $prefix . 'usr u
681
        LEFT JOIN ' . $prefix . 'institution i ON (u.institution = i.name)
682
        WHERE ' . db_format_tsfield('lastlogin', false) . ' < ? - i.defaultaccountinactiveexpire', array(time()))) {
683 684 685 686 687
        // Users have become inactive!
        foreach ($users as $user) {
            deactivate_user($user->id);
        }
    }
688 689
}

690 691 692 693

class PluginAuth extends Plugin {

    public static function get_event_subscriptions() {
694 695
        $subscriptions = array();

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

        return $subscriptions;
717 718 719
    }

    public static function update_active_flag($event, $userid) {
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
        $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);
        }
741 742 743 744
    }

}

745
?>