lib.php 37.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 40 41 42
/**
 * We tried to call a method on an auth plugin that hasn't been init'ed 
 * successfully
 */
class UninitialisedAuthException extends SystemException {}

43 44 45
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
46 47 48 49 50 51
 *
 * @todo for authentication:
 *   - inactivity: each institution has inactivity timeout times, this needs
 *     to be supported
 *     - this means the lastlogin field needs to be updated on the usr table
 *     - warnings are handled by cron
52 53 54
 */
abstract class Auth {

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 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 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
    protected $has_config;
    protected $type;
    protected $ready;

    /**
     * Given an id, create the auth object and retrieve the config settings
     * If an instance ID is provided, get all the *instance* config settings
     *
     * @param  int  $id   The unique ID of the auth instance
     * @return bool       Whether the create was successful
     */
    public function __construct($id = null) {
        $this->ready = false;
    }

    /**
     * Instantiate the plugin by pulling the config data for an instance from
     * the database
     *
     * @param  int  $id   The unique ID of the auth instance
     * @return bool       Whether the create was successful
     */
    public function init($id) {
        if (!is_numeric($id) || intval($id) != $id) {
            throw new UserNotFoundException();
        }

        $instance = get_record('auth_instance', 'id', $id);
        if (empty($instance)) {
            throw new UserNotFoundException();
        }

        $this->instanceid   = $id;
        $this->institution  = $instance->institution;
        $this->instancename = $instance->instancename;
        $this->priority     = $instance->priority;
        $this->authname     = $instance->authname;

        // Return now if the plugin type doesn't require any config 
        // (e.g. internal)
        if ($this->has_config == false) {
            return true;
        }

        $records = get_records_array('auth_instance_config', 'instance', $this->instanceid);

        if ($records == false) {
            return false;
        }

        foreach($records as $record) {
            $this->config[$record->field] = $record->value;
        }

        return true;
    }

    /**
     * The __get overloader is invoked when the requested member is private or
     * protected, or just doesn't exist.
     * 
     * @param  string  $name   The name of the value to fetch
     * @return mixed           The value
     */
    public function __get($name) {
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname');

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }

        if (isset($this->config['name'])) {
            return $this->config['name'];
        }
        return null;
    }

    /**
     * The __set overloader is invoked when the specified member is private or
     * protected, or just doesn't exist.
     * 
     * @param  string  $name   The name of the value to set
     * @param  mixed   $value  The value to assign
     * @return void
     */
    public function __set($name, $value) {
        /*
        if (property_exists($this, $name)) {
            $this->{$name} = $value;
            return;
        }
        */
        throw new SystemException('It\'s forbidden to set values on Auth objects');
    }

    /**
     * Check that the plugin has been initialised before we try to use it.
     * 
     * @throws UninitialisedAuthException
     * @return bool 
     */
    protected function must_be_ready() {
        if ($this->ready == false) {
            throw new UninitialisedAuthException('This Auth plugin has not been initialised');
        }
        return true;
    }

    /**
     * Fetch the URL that users can visit to change their passwords. This might
     * be a Moodle installation, for example.
     * 
     * @return  mixed   URL to change password or false if there is none
     */
    public function changepasswordurl() {
        $this->must_be_ready();
        if (empty($this->config['changepasswordurl'])) {
            return false;
        }
        return $this->config['changepasswordurl'];
    }

183
    /**
184
     * Given a username and password, attempts to log the user in.
185
     *
186
     * @param object $user      An object with username member (at least)
187 188 189 190 191
     * @param string $password  The password to use for the attempt
     * @return bool             Whether the authentication was successful
     * @throws AuthUnknownUserException  If the user is unknown to the
     *                                   authentication method
     */
192 193 194 195
    public function authenticate_user_account($user, $password) {
        $this->must_be_ready();
        return false;
    }
196

197 198 199 200 201 202
    /**
     * 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
     */
203 204 205 206 207 208 209
    public function user_exists($username) {
        $this->must_be_ready();
        if (record_exists('usr', 'LOWER(username)', strtolower($username), 'authinstance', $this->instanceid)) {
            return true;
        }
        throw new AuthUnknownUserException("\"$username\" is not known to Auth");
    }
210

211
    /**
212 213
     * Given a username, returns a hash of information about a user from the
     * external data source, e.g. Moodle or Drupal.
214 215 216 217 218 219
     *
     * @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
     */
220 221 222
    public function get_user_info($username) {
        return false;
    }
223

224 225
    /**
     * Given a username, return information about the user from the database.
226 227
     * This object must_be_ready, which means it will have an authinstanceid. 
     * This is used to disambiguate between users with the same username.
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
     *
     * 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
     */
244 245 246 247 248 249 250 251 252
    public function get_user_info_cached($username) {
        $this->must_be_ready();
        if (!$result = get_record('usr', 'LOWER(username)', strtolower($username), 'authinstance', $this->instanceid,
                    '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin'))) {
            throw new AuthUnknownUserException("\"$username\" is not known to AuthInternal");
        }
        $cache[$result->username] = $result;
        return $result;
    }
253

Nigel McNie's avatar
Nigel McNie committed
254 255 256 257
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
258 259 260 261 262
     * 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
263 264 265 266
     *
     * 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!
     *
267 268 269
     * 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
270 271 272
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
273
    public function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
274 275 276
        return true;
    }

277 278 279
}


280 281 282 283
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

284
/**
285 286
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
287 288 289 290 291 292 293 294
 *
 * 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
295 296 297 298 299 300 301
 *
 * 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.
 *
302 303
 */
function auth_setup () {
304
    global $SESSION, $USER;
305 306 307 308

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
309
        $USER->logout();
310 311 312 313 314
        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.
315
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
316
    if ($sessionlogouttime && isset($_GET['logout'])) {
317 318
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
319
        redirect();
Nigel McNie's avatar
Nigel McNie committed
320 321
    }
    if ($sessionlogouttime > time()) {
322
        // The session is still active, so continue it.
323 324 325
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
326
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->id);
327
            if (!$USER->get('admin') && $userreallyadmin) {
328
                // The user has been made into an admin
329
                $USER->admin = 1;
330
            }
331
            else if ($USER->get('admin') && !$userreallyadmin) {
332
                // The user's admin rights have been taken away
333
                $USER->admin = 0;
334
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
335
                redirect();
336
            }
337
            elseif (!$USER->get('admin')) {
338
                // The user never was an admin
339
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
340
                redirect();
341
            }
342
        }
343
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
344
        auth_check_password_change();
345 346 347
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
348
        $USER->logout();
349 350 351 352 353 354 355 356 357 358 359

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

360
        auth_draw_login_page(get_string('sessiontimedout'));
361 362 363
    }
    else {
        // There is no session, so we check to see if one needs to be started.
364
        // Build login form. If the form is submitted it will be handled here,
365 366
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
367 368
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
369 370
        if ($USER->is_logged_in()) {
            return;
371 372 373
        }
        
        // Check if the page is public or the site is configured to be public.
374
        if (defined('PUBLIC') && !isset($_GET['login'])) {
375
            return;
376
        }
377
        
378
        auth_draw_login_page(null, $form);
379
        exit;
380 381 382 383
    }
}

/**
384
 * Given an institution, returns the authentication methods used by it.
385
 *
386 387
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
388
 */
389
function auth_get_auth_instances_for_institution($institution) {
Nigel McNie's avatar
Nigel McNie committed
390
    static $cache = array();
391 392 393 394 395 396

    if (!isset($cache[$institution])) {
        $cache[$institution] = get_records_array('auth_instance', 'institution', $institution, 'priority, instancename', 'id, instancename, priority, authname');
        if(empty($cache[$institution])) {
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
397
    }
398 399

    return $cache[$institution];
400 401
}

402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417
/**
 * Given a user, returns the authentication instance used.
 *
 * @param  object   $user            User object with an authinstance member
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instance($user) {
    static $cache = array();

    if (!isset($cache[$user->id])) {
        $cache[$user->id] = get_record('auth_instance', 'id', $user->authinstance, null, null, null, null, 'id, instancename, priority, authname');
    }

    return $cache[$user->id];
}

418 419 420 421 422 423 424 425
/**
 * 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
426 427
function auth_check_password_change() {
    global $USER;
428
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
429 430 431
        return;
    }

432 433 434 435 436 437 438
    $authobj = AuthFactory::create($USER->authinstance);

    if ($authobj->changepasswordurl) {
        redirect($authobj->changepasswordurl);
        exit;
    }

Nigel McNie's avatar
Nigel McNie committed
439
    // @todo auth preference for a password change screen for all auth methods other than internal
440
    if (method_exists($authobj, 'change_password')) {
Nigel McNie's avatar
Nigel McNie committed
441

442
        require_once('pieforms/pieform.php');
443
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
444 445 446 447 448
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
449 450 451 452 453 454 455 456 457 458 459 460 461
                '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(
462 463 464 465 466 467 468 469 470 471 472
                        '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,
                    ),
473 474
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
475
                    'type'  => 'submit',
476 477
                    'value' => get_string('changepassword'),
                ),
478 479 480 481
            )
        );

        $smarty = smarty();
482
        $smarty->assign('change_password_form', pieform($form));
483 484 485 486 487 488 489 490
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
491
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
492
 *
493 494
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
495
 */
496
function change_password_validate(Pieform $form, $values) {
497
    global $USER;
498

499
    // Get the authentication type for the user, and
500
    // use the information to validate the password
501
    $authobj = AuthFactory::create($USER->authinstance);
502

Nigel McNie's avatar
Nigel McNie committed
503
    // @todo this could be done by a custom form rule... 'password' => $user
504
    password_validate_user($form, $values, $USER);
505

Nigel McNie's avatar
Nigel McNie committed
506
    // The password cannot be the same as the old one
507
    if (!$form->get_error('password1')
508
        && $authobj->authenticate_user_account($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
509
        $form->set_error('password1', get_string('passwordnotchanged'));
510 511 512 513 514 515 516 517
    }
}

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

523
    // This method should exist, because if it did not then the change
Nigel McNie's avatar
Nigel McNie committed
524
    // password form would not have been shown.
525
    if ($password = call_static_method($authclass, 'change_password', $USER->get('username'), $values['password1'])) {
526
        $user = new StdClass;
Nigel McNie's avatar
Nigel McNie committed
527
        $user->password = $password;
528 529
        $user->passwordchange = 0;
        $where = new StdClass;
530
        $where->username = $USER->get('username');
531
        update_record('usr', $user, $where);
532 533
        $USER->set('password', $password);
        $USER->set('passwordchange', 0);
Nigel McNie's avatar
Nigel McNie committed
534
        $SESSION->add_ok_msg(get_string('passwordsaved'));
535 536 537
        if (!empty($values['email'])) {
            set_profile_field($USER->get('id'), 'email', $values['email']);
        }
538
        redirect();
539
    }
Nigel McNie's avatar
Nigel McNie committed
540

541 542
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
543 544
}

545
/**
Nigel McNie's avatar
Nigel McNie committed
546
 * Creates and displays the transient login page.
547
 *
Nigel McNie's avatar
Nigel McNie committed
548 549 550 551
 * 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.
 *
552 553 554
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
555 556 557
 * @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
558
 * @access private
559
 */
560
function auth_draw_login_page($message=null, Pieform $form=null) {
561
    global $USER, $SESSION;
562
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
563
        $loginform = get_login_form_js($form->build());
564 565
    }
    else {
566
        require_once('pieforms/pieform.php');
567
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
568 569 570 571 572
        /*
         * 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.
         */
573
        if ($USER->is_logged_in()) {
574 575 576 577 578 579 580
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
581
    }
582
    $smarty = smarty();
583
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
584
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
585 586 587
    $smarty->display('login.tpl');
    exit;
}
588

589
/**
Nigel McNie's avatar
Nigel McNie committed
590
 * Returns the definition of the login form.
591
 *
Nigel McNie's avatar
Nigel McNie committed
592 593
 * @return array   The login form definition array.
 * @access private
594 595
 */
function auth_get_login_form() {
596
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
597 598 599 600 601
    $defaultinstitution = get_cookie('institution');
    if (!$defaultinstitution) {
        $defaultinstitution = 'mahara';
    }

602
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
603 604 605 606 607 608
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
609 610
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629
        '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
        ),
630 631
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
632
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
633
        ),
634 635 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 667 668
    );

    // 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(
669 670 671 672 673 674 675 676
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
677 678
    );

679
    return $form;
680 681
}

Nigel McNie's avatar
Nigel McNie committed
682 683 684 685 686
/**
 * 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.
 *
687 688
 * @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
689 690 691 692 693 694 695 696
 * @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">
697
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
698
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
699 700
if (document.cookie) {
    loginbox.innerHTML = '$form';
701
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
702 703
}
else {
704
    replaceChildNodes(loginbox, P(null, '$strcookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
705 706 707 708
}
</script>
EOF;
}
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743

/**
 * Class to build and cache instances of auth objects
 */
class AuthFactory {

    static $authcache = array();

    /**
     * Take an instanceid and create an auth object for that instance. 
     * 
     * @param  int      $id     The id of the auth instance
     * @return mixed            An intialised auth object or false, if the
     *                          instance doesn't exist (Should never happen)
     */
    public static function create($id) {

        if (isset(self::$authcache[$id]) && is_object(self::$authcache[$id])) {
            return self::$authcache[$id];
        }

        $authinstance = get_record('auth_instance', 'id', $id, null, null, null, null, 'authname');

        if (!empty($authinstance)) {
            $authclassname = 'Auth' . ucfirst($authinstance->authname);
            safe_require('auth', $authinstance->authname);
            self::$authcache[$id] = new $authclassname($id);
            return self::$authcache[$id];
        }

        return false;
    }
}

744
/**
745 746
 * Called when the login form is submittd. Validates the user and password, and
 * if they are valid, starts a new session for the user.
747
 *
748
 * @param array $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
749
 * @access private
750
 */
751
function login_submit(Pieform $form, $values) {
752 753 754 755
    global $SESSION, $USER;

    $username    = $values['login_username'];
    $password    = $values['login_password'];
Nigel McNie's avatar
Nigel McNie committed
756
    $institution = (isset($values['login_institution'])) ? $values['login_institution'] : 'mahara';
757 758
            
    $authtype = auth_get_authtype_for_institution($institution);
759
    safe_require('auth', $authtype);
760
    $authclass = 'Auth' . ucfirst($authtype);
Nigel McNie's avatar
Nigel McNie committed
761

762 763
    try {
        if (call_static_method($authclass, 'authenticate_user_account', $username, $password, $institution)) {
764
            // User logged in! Set a cookie to remember their institution
765
            set_cookie('institution', $institution, 0, get_mahara_install_subdirectory());
766
            $oldlastlogin = null;
Nigel McNie's avatar
Nigel McNie committed
767

768
            if (!call_static_method($authclass, 'user_exists', $username)) {
Nigel McNie's avatar
Nigel McNie committed
769 770 771 772
                // 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
773
                $userdata = call_static_method($authclass, 'get_user_info', $username);
774
                $userdata->lastlogin = db_format_timestamp(time());
775
                insert_record('usr', $userdata);
Nigel McNie's avatar
Nigel McNie committed
776
                handle_event('createuser', $userdata);
Nigel McNie's avatar
Nigel McNie committed
777 778 779
            }
            // @todo config form option for this for each external plugin. NOT for internal
            else if (get_config_plugin('auth', $authtype, 'updateuserinfoonlogin')) {
780
                $userdata = call_static_method($authclass, 'get_user_info', $username);
781 782 783
                $oldlastlogin = $userdata->lastlogin;
                $userdata->lastlogin = db_format_timestamp(time());
                $userdata->inactivemailsent = 0;
Nigel McNie's avatar
Nigel McNie committed
784 785 786 787 788 789 790
                $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
791
                update_record('usr', $userdata, $where);
Nigel McNie's avatar
Nigel McNie committed
792 793
            }
            else {
794
                $userdata = call_static_method($authclass, 'get_user_info_cached', $username);
795 796 797 798 799
                $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
800 801
            }

802
            // Only admins in the admin section!
803
            if (defined('ADMIN') && !$userdata->admin) {
804
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
805
                redirect();
806 807
            }

808 809 810 811 812
            // Check if the user's account has been deleted
            if ($userdata->deleted) {
                die_info(get_string('accountdeleted'));
            }

Nigel McNie's avatar
Nigel McNie committed
813
            // Check if the user's account has expired
814
            if ($userdata->expiry > 0 && time() > $userdata->expiry) {
Nigel McNie's avatar
Nigel McNie committed
815 816 817
                die_info(get_string('accountexpired'));
            }

818
            // Check if the user's account has become inactive
Nigel McNie's avatar
Nigel McNie committed
819 820 821
            $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $userdata->institution);
            if ($inactivetime && $oldlastlogin > 0
                && $oldlastlogin + $inactivetime < time()) {
822 823 824
                die_info(get_string('accountinactive'));
            }

Nigel McNie's avatar
Nigel McNie committed
825
            // Check if the user's account has been suspended
826 827
            if ($userdata->suspendedcusr) {
                die_info(get_string('accountsuspended', 'mahara', $userdata->suspendedctime, $userdata->suspendedreason));
Nigel McNie's avatar
Nigel McNie committed
828 829 830
            }

            // User is allowed to log in
831
            $USER->login($userdata);
Nigel McNie's avatar
Nigel McNie committed
832
            auth_check_password_change();
833 834 835
        }
        else {
            // Login attempt failed
836
            $SESSION->add_error_msg(get_string('loginfailed'));
837 838 839
        }
    }
    catch (AuthUnknownUserException $e) {
840
        $SESSION->add_error_msg(get_string('loginfailed'));
841
    }
842 843
}

844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
/**
 * 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');

872
    // Expiry warning messages
873
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890
        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);
        }
    }

891
    // Actual expired users
892
    if ($users = get_records_sql_array('SELECT id
893
        FROM ' . $prefix . 'usr
894
        WHERE ' . db_format_tsfield('expiry', false) . ' < ?', array(time()))) {
895 896 897 898 899 900
        // Users have expired!
        foreach ($users as $user) {
            expire_user($user->id);
        }
    }

901
    // Inactivity (lastlogin is too old)
902
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email, i.defaultaccountinactivewarn AS timeout
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917
        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);
        }
    }
918 919 920
    
    // Actual inactive users
    if ($users = get_records_sql_array('SELECT u.id
Nigel McNie's avatar
Nigel McNie committed
921
        FROM ' . $prefix . 'usr u
922
        LEFT JOIN ' . $prefix . 'institution i ON (u.institution = i.name)
923
        WHERE ' . db_format_tsfield('lastlogin', false) . ' < ? - i.defaultaccountinactiveexpire', array(time()))) {
924 925 926 927 928
        // Users have become inactive!
        foreach ($users as $user) {
            deactivate_user($user->id);
        }
    }
929 930
}

Martyn Smith's avatar
Martyn Smith committed
931
function auth_generate_login_form() {
Nigel McNie's avatar
Nigel McNie committed
932 933 934
    if (!get_config('installed')) {
        return;
    }
Martyn Smith's avatar
Martyn Smith committed
935 936 937 938 939 940 941 942 943 944 945 946 947
    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(
948 949 950 951 952 953
            'login_username' => array(
                'type'        => 'text',
                'title'       => get_string('username') . ':',
                'description' => get_string('usernamedescription'),
                'rules' => array(
                    'required'    => true
Martyn Smith's avatar
Martyn Smith committed
954 955
                )
            ),
956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975
            '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
976 977 978 979 980 981 982 983 984 985 986 987 988 989
            '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;
}

990 991 992 993

class PluginAuth extends Plugin {

    public static function get_event_subscriptions() {
994 995
        $subscriptions = array();

996 997
        $activecheck = new StdClass;
        $activecheck->plugin = 'internal';
998
        $activecheck->event  = 'suspenduser';
999
        $activecheck->callfunction = 'update_active_flag';
1000
        $subscriptions[] = clone $activecheck;
1001
        $activecheck->event = 'unsuspenduser';
1002
        $subscriptions[] = clone $activecheck;
1003
        $activecheck->event = 'deleteuser';
1004
        $subscriptions[] = clone $activecheck;
1005
        $activecheck->event = 'undeleteuser';
1006
        $subscriptions[] = clone $activecheck;
1007
        $activecheck->event = 'expireuser';
1008
        $subscriptions[] = clone $activecheck;
1009
        $activecheck->event = 'unexpireuser';
1010
        $subscriptions[] = clone $activecheck;
1011
        $activecheck->event = 'deactivateuser';
1012
        $subscriptions[] = clone $activecheck;
1013
        $activecheck->event = 'activateuser';
1014
        $subscriptions[] = clone $activecheck;
1015 1016

        return $subscriptions;
1017 1018
    }

1019
    public static function update_active_flag($event, $user) {
1020 1021
        $active = true;

1022 1023
        // ensure we have everything we need
        $user = get_user($user['id']);
1024 1025 1026 1027 1028

        $inactivetime = get_field('institution', 'defaultaccountinactiveexpire', 'name', $user->institution);
        if ($user->suspendedcusr) {
            $active = false;
        }
1029
        else if ($user->expiry && $user->expiry < time()) {
1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
            $active = false;
        }
        else if ($inactivetime && $user->lastlogin + $inactivetime < time()) {
            $active = false;
        }
        else if ($user->deleted) {
            $active = false;
        }

        if ($active != $user->active) {
1040
            set_field('usr', 'active', (int)$active, 'id', $user->id);
1041
        }
1042 1043 1044 1045
    }

}

1046
?>