lib.php 43.5 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
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
61
    protected $has_instance_config;
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
    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)
101
        if ($this->has_instance_config == false) {
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
            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) {
126
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname', 'type');
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

        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
    public function user_exists($username) {
        $this->must_be_ready();
205
        if (record_exists('usr', 'LOWER(username)', strtolower($username))) {
206 207 208 209
            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
    public function get_user_info_cached($username) {
        $this->must_be_ready();
246
        if (!$result = get_record('usr', 'LOWER(username)', strtolower($username), null, null, null, null,
247 248 249 250 251 252
                    '*, ' . 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 335
            }
            if (!$USER->get('admin')) {
336
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
337
                redirect();
338
            }
339 340 341 342 343 344 345 346 347
        } else if (defined('INSTITUTIONALADMIN')) {
            $userreallyadminfor = get_column('usr_institution', 'institution', 'usr', $USER->id, 'admin', 1);
            if (!$USER->is_institutional_admin() && !empty($userreallyadminfor)) {
                $USER->set_admin_institutions($userreallyadminfor);
            }
            else if ($USER->is_institutional_admin() && empty($userreallyadminfor)) {
                $USER->set_admin_institutions(array());
            }
            if (!$USER->is_institutional_admin()) {
348
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
349
                redirect();
350
            }
351
        }
352
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
353
        auth_check_password_change();
354 355 356
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
357
        $USER->logout();
358

359
        if (defined('JSON')) {
360
            json_reply('global', get_string('sessiontimedoutreload'), 1);
361 362
        }

363 364 365 366 367 368 369 370 371 372
        // 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;
        }

373
        auth_draw_login_page(get_string('sessiontimedout'));
374 375 376
    }
    else {
        // There is no session, so we check to see if one needs to be started.
377
        // Build login form. If the form is submitted it will be handled here,
378 379
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
380 381
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
382 383
        if ($USER->is_logged_in()) {
            return;
384 385 386
        }
        
        // Check if the page is public or the site is configured to be public.
387
        if (defined('PUBLIC') && !isset($_GET['login'])) {
388
            return;
389
        }
390 391 392 393 394

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
395
        
396
        auth_draw_login_page(null, $form);
397
        exit;
398 399 400
    }
}

401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
/**
 * 
 * Returns all auth instances
 *
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instances() {
    static $cache = array();

    if (count($cache) > 0) {
        return $cache;
    }

    $sql ='
        SELECT DISTINCT
            i.id,
            inst.name,
            inst.displayname,
            i.instancename
        FROM 
            {institution} inst,
            {auth_instance} i
        WHERE 
            i.institution = inst.name
        ORDER BY
            inst.displayname,
            i.instancename';

    $cache = get_records_sql_array($sql, array());

    if (empty($cache)) {
        return array();
    }

    return $cache;
}




441
/**
442 443
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
444
 *
445 446
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
447
 */
448
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
449
    static $cache = array();
450

451
    if (null == $institution) {
452 453 454
        return array();
    }

455
    if (!isset($cache[$institution])) {
456 457 458 459 460 461 462 463 464 465 466
        // Get auth instances in order of priority
        // DO NOT CHANGE THE SORT ORDER OF THIS RESULT SET
        // YEAH EINSTEIN - THAT MEANS YOU!!!

        // TODO: work out why this won't accept a placeholder - had to use db_quote
        $sql ='
            SELECT DISTINCT
                i.id,
                i.instancename,
                i.priority,
                i.authname,
467 468
                a.requires_config,
                a.requires_parent
469
            FROM 
470 471
                {auth_instance} i,
                {auth_installed} a
472 473 474 475 476 477 478 479 480
            WHERE 
                a.name = i.authname AND
                i.institution = '. db_quote($institution).'
            ORDER BY
                i.priority,
                i.instancename';

        $cache[$institution] = get_records_sql_array($sql, array());

481
        if (empty($cache[$institution])) {
482 483
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
484
    }
485 486

    return $cache[$institution];
487 488
}

489 490 491 492 493 494
/**
 * Given a wwwroot, find any auth instances that can come from that host
 * 
 * @param   string  wwwroot of the host that is connecting to us
 * @return  array   array of record objects
 */
495
function auth_get_auth_instances_for_wwwroot($wwwroot) {
496 497 498

    // TODO: we just need ai.id and ai.authname... rewrite query, or
    // just drop this function
499 500 501 502 503
    $query = "  SELECT
                    ai.*,
                    aic.*,
                    i.*
                FROM
504 505 506
                    {auth_instance} ai, 
                    {auth_instance_config} aic,
                    {institution} i
507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
                WHERE
                    aic.field = 'wwwroot' AND
                    aic.value = ? AND
                    aic.instance = ai.id AND
                    i.name = ai.institution";

    return get_records_sql_array($query, array('value' => $wwwroot));
}

/**
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instances_for_username($institution, $username) {
    static $cache = array();

    if (!isset($cache[$institution][$username])) {
        // Get auth instances in order of priority
        // DO NOT CHANGE THE SORT ORDER OF THIS RESULT SET
        // YEAH EINSTEIN - THAT MEANS YOU!!!

        // TODO: work out why this won't accept a placeholder - had to use db_quote
        $sql ='
            SELECT DISTINCT
                i.id,
                i.instancename,
                i.priority,
                i.authname,
                a.requires_config,
                a.requires_parent
            FROM 
541 542 543
                {auth_instance} i,
                {auth_installed} a,
                {usr} u
544 545 546 547 548 549 550 551 552 553 554
            WHERE 
                a.name = i.authname AND
                i.institution = ? AND
                u.username = ? AND
                u.institution = i.institution
            ORDER BY
                i.priority,
                i.instancename';

        $cache[$institution][$username] = get_records_sql_array($sql, array(array('institution' => $institution), array('username' => $username)));

555
        if (empty($cache[$institution])) {
556 557 558 559 560 561 562
            return false;
        }
    }

    return $cache[$institution];
}

563 564 565 566 567 568 569
/**
 * Given an institution, get all the auth types EXCEPT those that are already 
 * enabled AND do not require configuration.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
570
function auth_get_available_auth_types($institution=null) {
571

572
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
573 574 575 576 577 578 579 580 581
        return array();
    }

    // TODO: work out why this won't accept a placeholder - had to use db_quote
    $sql ='
        SELECT DISTINCT
            a.name,
            a.requires_config
        FROM 
582
            {auth_installed} a
583
        LEFT JOIN 
584
            {auth_instance} i
585 586 587 588 589 590 591 592 593 594
        ON 
            a.name = i.authname AND
            i.institution = '. db_quote($institution).'
        WHERE
           (a.requires_config = 1 OR
            i.id IS NULL) AND
            a.active = 1
        ORDER BY
            a.name';          

595 596 597 598 599
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
600 601 602 603 604 605 606 607

    if (empty($result)) {
        return array();
    }

    return $result;
}

608 609 610 611 612 613 614 615
/**
 * 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
616 617
function auth_check_password_change() {
    global $USER;
618
    if (!$USER->get('passwordchange')) {
Nigel McNie's avatar
Nigel McNie committed
619 620 621
        return;
    }

622 623 624 625 626 627 628
    $authobj = AuthFactory::create($USER->authinstance);

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

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

632
        require_once('pieforms/pieform.php');
633
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
634 635 636 637 638
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
639 640 641 642 643 644 645 646 647 648 649 650 651
                '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(
652 653 654 655 656 657 658 659 660 661 662
                        '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,
                    ),
663 664
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
665
                    'type'  => 'submit',
666 667
                    'value' => get_string('changepassword'),
                ),
668 669 670 671
            )
        );

        $smarty = smarty();
672
        $smarty->assign('change_password_form', pieform($form));
673 674 675 676 677 678 679 680
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
681
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
682
 *
683 684
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
685
 */
686
function change_password_validate(Pieform $form, $values) {
687
    global $USER;
688

689
    // Get the authentication type for the user, and
690
    // use the information to validate the password
691
    $authobj = AuthFactory::create($USER->authinstance);
692

Nigel McNie's avatar
Nigel McNie committed
693
    // @todo this could be done by a custom form rule... 'password' => $user
694
    password_validate($form, $values, $USER);
695

Nigel McNie's avatar
Nigel McNie committed
696
    // The password cannot be the same as the old one
697
    if (!$form->get_error('password1')
698
        && $authobj->authenticate_user_account($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
699
        $form->set_error('password1', get_string('passwordnotchanged'));
700 701 702 703 704 705 706 707
    }
}

/**
 * Changes the password for a user, given that it is valid.
 *
 * @param array $values The submitted form values
 */
708
function change_password_submit(Pieform $form, $values) {
709
    global $USER, $SESSION;
710 711

    $authobj = AuthFactory::create($USER->authinstance);
Nigel McNie's avatar
Nigel McNie committed
712

713
    // This method should exist, because if it did not then the change
Nigel McNie's avatar
Nigel McNie committed
714
    // password form would not have been shown.
715
    if ($password = $authobj->change_password($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
716
        $SESSION->add_ok_msg(get_string('passwordsaved'));
717
        if (!empty($values['email'])) {
718
            set_profile_field($USER->id, 'email', $values['email']);
719
        }
720
        redirect();
721
    }
Nigel McNie's avatar
Nigel McNie committed
722

723
    // TODO: Exception is the wrong type here!
724 725
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
726 727
}

728
/**
Nigel McNie's avatar
Nigel McNie committed
729
 * Creates and displays the transient login page.
730
 *
Nigel McNie's avatar
Nigel McNie committed
731 732 733 734
 * 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.
 *
735 736 737
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
738 739 740
 * @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
741
 * @access private
742
 */
743
function auth_draw_login_page($message=null, Pieform $form=null) {
744
    global $USER, $SESSION;
745
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
746
        $loginform = get_login_form_js($form->build());
747 748
    }
    else {
749
        require_once('pieforms/pieform.php');
750
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
751 752 753 754 755
        /*
         * 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.
         */
756
        if ($USER->is_logged_in()) {
757 758 759 760 761 762 763
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
764
    }
765
    $smarty = smarty();
766
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
767
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
768 769 770
    $smarty->display('login.tpl');
    exit;
}
771

772
/**
Nigel McNie's avatar
Nigel McNie committed
773
 * Returns the definition of the login form.
774
 *
Nigel McNie's avatar
Nigel McNie committed
775 776
 * @return array   The login form definition array.
 * @access private
777 778
 */
function auth_get_login_form() {
779
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
780 781 782 783 784
    $defaultinstitution = get_cookie('institution');
    if (!$defaultinstitution) {
        $defaultinstitution = 'mahara';
    }

785
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
786 787 788 789 790 791
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
792 793
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
794 795 796 797 798 799 800 801 802
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
            'value'       => '',
            'rules' => array(
                'required'    => true
            )
        ),
803 804
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
805
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
806
        ),
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841
    );

    // 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(
842 843 844 845 846 847 848 849
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
850 851
    );

852
    return $form;
853 854
}

Nigel McNie's avatar
Nigel McNie committed
855 856 857 858 859
/**
 * 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.
 *
860 861
 * @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
862 863 864 865
 * @private
 */
function get_login_form_js($form) {
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
866
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
867 868 869
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
870
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
871
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
872 873
if (document.cookie) {
    loginbox.innerHTML = '$form';
874
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
875 876
}
else {
877
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
Nigel McNie's avatar
Nigel McNie committed
878 879 880 881
}
</script>
EOF;
}
882

883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916

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

917
/**
918
 * Called when the login form is submitted. Validates the user and password, and
919
 * if they are valid, starts a new session for the user.
920
 *
921 922
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
923
 * @access private
924
 */
925
function login_submit(Pieform $form, $values) {
926 927
    global $SESSION, $USER;

928 929 930 931
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
932

933
    try {
934
        //var_dump(array($username, $password, $institution, $_SESSION));
935
        $authenticated = $USER->login($username, $password);
936

937 938 939
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
        }
940

941 942
    }
    catch (AuthUnknownUserException $e) {
943
        try {
944 945 946 947 948 949 950 951 952 953
            // If the user doesn't exist, check for institutions that
            // want to create users automatically.
            $authinstances = get_records_sql_array('
                SELECT a.id, a.instancename, a.priority, a.authname, a.institution
                FROM {institution} i JOIN {auth_instance} a ON a.institution = i.name
                WHERE i.updateuserinfoonlogin = 1
                ORDER BY a.institution, a.priority, a.instancename', null);

            if ($authinstances == false) {
                throw new AuthUnknownUserException("\"$username\" is not known");
Nigel McNie's avatar
Nigel McNie committed
954 955
            }

956
            $USER->username = $username;
957

958
            foreach ($authinstances as $authinstance) {
959

960 961 962 963 964 965 966 967 968 969 970
                while (list(, $authinstance) = each($authinstances) && false == $authenticated) {
                    // TODO: Test this code with an auth plugin that provides a 
                    // get_user_info method
                    $auth = AuthFactory::create($authinstance->id);
                    if ($auth->authenticate_user_account($USER, $password)) {
                        $authenticated = true;
                    } else {
                        continue;
                    }

                    $USER->authinstance = $authinstance->id;
971 972 973 974 975 976 977
                    $userdata = $auth->get_user_info();
                    if (
                         empty($userdata) ||
                         empty($userdata->firstname) ||
                         empty($userdata->lastname) ||
                         empty($userdata->email) 
                        ) {
978
                        throw new AuthUnknownUserException("\"$username\" is not known");
979 980 981 982 983 984 985 986 987 988 989
                    } else {
                        // We have the data - create the user
                        $USER->expiry    = db_format_timestamp(time() + 86400);
                        $USER->lastlogin = db_format_timestamp(time());
                        $USER->firstname = $userdata->firstname;
                        $USER->lastname  = $userdata->lastname;
                        $USER->email     = $userdata->email;

                        try {
                            db_begin();
                            $USER->commit();
990 991 992 993

                            if ($authinstance->institution !== 'mahara') {
                                $USER->join_institution($authinstance->institution);
                            }
994 995 996
    
                            handle_event('createuser', $USER);
                            db_commit();
997 998
                        }
                        catch (Exception $e) {
999 1000 1001 1002 1003
                            db_rollback();
                            throw $e;
                        }
                    }
                }
Nigel McNie's avatar
Nigel McNie committed
1004 1005
            }

1006 1007
        }
        catch (AuthUnknownUserException $e) {
1008
            $SESSION->add_error_msg(get_string('loginfailed'));
1009 1010
        }
    }
1011 1012

    // Only admins in the admin section!
1013 1014
    if (defined('ADMIN') && !$USER->get('admin')
        || defined('INSTITUTIONALADMIN') && !$USER->is_institutional_admin()) {
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029
        $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
        redirect();
    }

    // Check if the user's account has been deleted
    if ($USER->deleted) {
        die_info(get_string('accountdeleted'));
    }

    // Check if the user's account has expired
    if ($USER->expiry > 0 && time() > $USER->expiry) {
        die_info(get_string('accountexpired'));
    }

    // Check if the user's account has become inactive
1030
    $inactivetime = get_config('defaultaccountinactiveexpire');
1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043
    if ($inactivetime && $oldlastlogin > 0
        && $oldlastlogin + $inactivetime < time()) {
        die_info(get_string('accountinactive'));
    }

    // Check if the user's account has been suspended
    if ($USER->suspendedcusr) {
        die_info(get_string('accountsuspended', 'mahara', $USER->suspendedctime, $USER->suspendedreason));
    }

    // User is allowed to log in
    //$USER->login($userdata);
    auth_check_password_change();
1044 1045
}

1046 1047 1048 1049
/**
 * Removes registration requests that were not completed in the allowed amount of time
 */
function auth_clean_partial_registrations() {
1050
    delete_records_sql('DELETE FROM {usr_registration}
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
        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
    $sitename = get_config('sitename');
    $wwwroot  = get_config('wwwroot');
1071 1072
    $expire   = get_config('defaultaccountinactiveexpire');
    $warn     = get_config('defaultaccountinactivewarn');
1073

1074
    // Expiry warning messages
1075 1076 1077
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email
        FROM {usr} u
        AND ? - ' . db_format_tsfield('u.expiry', false) . ' < ' . $warn . '
1078 1079 1080
        AND expirymailsent = 0', array(time()))) {
        foreach ($users as $user) {
            $displayname  = display_name($user);
1081
            $daystoexpire = ceil($warn / 86400) . ' ';
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
            $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);
        }
    }

1092
    // Actual expired users
1093
    if ($users = get_records_sql_array('SELECT id
1094
        FROM {usr}
1095
        WHERE ' . db_format_tsfield('expiry', false) . ' < ?', array(time()))) {
1096 1097 1098 1099 1100 1101
        // Users have expired!
        foreach ($users as $user) {
            expire_user($user->id);
        }
    }

1102
    
1103
    // Inactivity (lastlogin is too old)
1104 1105 1106
    if ($users = get_records_sql_array('SELECT u.id, u.username, u.firstname, u.lastname, u.preferredname, u.email
        FROM {usr} u
        AND (? - ' . db_format_tsfield('u.lastlogin', false) . ') > ' . ($expire - $warn) . '
1107 1108 1109
        AND inactivemailsent = 0', array(time()))) {
        foreach ($users as $user) {
            $displayname = display_name($user);
1110
            $daystoinactive = ceil($warn / 86400) . ' ';
1111 1112 1113 1114 1115 1116 1117 1118
            $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);
        }
    }
1119 1120 1121
    
    // Actual inactive users
    if ($users = get_records_sql_array('SELECT u.id
1122
        FROM {usr} u
1123
        WHERE ' . db_format_tsfield('lastlogin', false) . ' < ? - ' . $expire, array(time()))) {
1124 1125 1126 1127 1128
        // Users have become inactive!
        foreach ($users as $user) {
            deactivate_user($user->id);
        }
    }
1129 1130
}

Martyn Smith's avatar
Martyn Smith committed
1131
function auth_generate_login_form() {
Nigel McNie's avatar
Nigel McNie committed
1132 1133 1134
    if (!get_config('installed')) {
        return;
    }
Martyn Smith's avatar
Martyn Smith committed
1135 1136 1137 1138 1139 1140 1141 1142
    require_once('pieforms/pieform.php');
    $loginform = get_login_form_js(pieform(array(
        'name'       => 'login',
        'renderer'   => 'div',
        'submit'     => false,
        'plugintype' => 'auth',
        'pluginname' => 'internal',
        'elements'   => array(
1143 1144 1145 1146 1147 1148
            'login_username' => array(
                'type'        => 'text',
                'title'       => get_string('username') . ':',
                'description' => get_string('usernamedescription'),
                'rules' => array(
                    'required'    => true
Martyn Smith's avatar
Martyn Smith committed
1149 1150
                )
            ),
1151 1152 1153 1154 1155 1156 1157 1158 1159
            'login_password' => array(
                'type'        => 'password',
                'title'       => get_string('password') . ':',
                'description' => get_string('passworddescription'),
                'value'       => '',
                'rules' => array(
                    'required'    => true
                )
            ),
Martyn Smith's avatar
Martyn Smith committed
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173
            '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;
}

1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197
/**
 * Given a form, an array of values with 'password1' and 'password2'
 * indices and a user, validate that the user can change their password to
 * the one in $values.
 *
 * This provides one place where validation of passwords can be done. This is
 * used by:
 *  - registration
 *  - user forgot password
 *  - user changing password on their account page
 *  - user forced to change their password by the <kbd>passwordchange</kbd>
 *    flag on the <kbd>usr</kbd> table.
 *
 * The password is checked for:
 *  - Being in valid form according to the rules of the authentication method
 *    for the user
 *  - Not being an easy password (a blacklist of strings, NOT a length check or
 *     similar), including being the user's username
 *  - Both values being equal
 *
 * @param Pieform $form         The form to validate
 * @param array $values         The values passed through
 * @param string $authplugin    The authentication plugin that the user uses
 */
1198
function password_validate(Pieform $form, $values, User $user) {
1199 1200 1201 1202 1203 1204 1205 1206

    $authobj = AuthFactory::create($user->authinstance);

    if (!$form->get_error('password1') && !$authobj->is_password_valid($values['password1'])) {
        $form->set_error('password1', get_string('passwordinvalidform', "auth.$authobj->type"));
    }

    $suckypasswords = array(
1207
        'mahara', 'password', $user->username, 'abc123'
1208 1209 1210 1211 1212 1213 1214 1215 1216 1217
    );

    if (!$form->get_error('password1') && in_array($values['password1'], $suckypasswords)) {
        $form->set_error('password1', get_string('passwordtooeasy'));
    }

    if (!$form->get_error('password1') && $values['password1'] != $values['password2']) {
        $form->set_error('password2', get_string('passwordsdonotmatch'));
    }