lib.php 57.7 KB
Newer Older
1 2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4 5
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
6
 *
Francois Marier's avatar
Francois Marier committed
7 8 9 10
 * 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 3 of the License, or
 * (at your option) any later version.
11
 *
Francois Marier's avatar
Francois Marier committed
12 13 14 15
 * 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.
16
 *
Francois Marier's avatar
Francois Marier committed
17 18
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 20
 *
 * @package    mahara
Nigel McNie's avatar
Nigel McNie committed
21
 * @subpackage auth
22
 * @author     Catalyst IT Ltd
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
25 26 27 28 29
 *
 */

defined('INTERNAL') || die();

30
require('session.php');
31
require(get_config('docroot') . 'auth/user.php');
32

Nigel McNie's avatar
Nigel McNie committed
33 34 35
/**
 * Unknown user exception
 */
36
class AuthUnknownUserException extends UserException {}
37

38 39 40 41 42 43
/**
 * We tried to call a method on an auth plugin that hasn't been init'ed 
 * successfully
 */
class UninitialisedAuthException extends SystemException {}

44 45 46
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
47 48 49 50 51 52
 *
 * @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
53 54 55
 */
abstract class Auth {

56 57 58 59 60 61
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
62
    protected $has_instance_config;
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
    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)
102
        if ($this->has_instance_config == false) {
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126
            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) {
127
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname', 'type');
128 129 130 131

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }
132 133
        if (isset($this->config[$name])) {
            return $this->config[$name];
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
        }
        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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
    /**
     * Returns whether the authentication instance can automatically create a 
     * user record.
     *
     * Auto creating users means that the authentication plugin can say that 
     * users who don't exist yet in Mahara's usr table are allowed, and Mahara
     * should create a user account for them. Example: the first time a user logs
     * in, when authenticating against an ldap store or similar).
     *
     * However, if a plugin says a user can be authenticated, then it must 
     * implement the get_user_info() method which will be called to find out 
     * information about the user so a record in the usr table _can_ be created 
     * for the new user.
     *
     * Authentication methods must implement this method. Some may choose to 
     * implement it by returning an instance config value that the admin user 
     * can set.
     *
     * @return bool
     */
    public abstract function can_auto_create_users();

233
    /**
234
     * Given a username, returns a hash of information about a user from the
235
     * external data source.
236 237 238 239 240 241
     *
     * @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
     */
242 243 244
    public function get_user_info($username) {
        return false;
    }
245

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

269 270 271 272 273 274 275 276 277 278 279 280
    /**
     * Called when a user is being logged in, after the main authentication routines.
     *
     * You can use $USER->login() to perform any additional tasks, for example
     * to set a cookie that another application can read, or pull some data
     * from somewhere.
     *
     * This method has no parameters and needs no return value
     */
    public function login() {
    }

281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
    /**
     * Called when a user is being logged out, either by clicking a logout 
     * link, their session timing out or some other method where their session 
     * is explicitly being ended with no more processing to take place on this 
     * page load.
     *
     * You can use $USER->logout() to log a user out but continue page 
     * processing if necessary. register.php is an example of such a place 
     * where this happens.
     *
     * If you define this hook, you can call $USER->logout() in it if you need 
     * to before redirecting. Otherwise, it will be called for you once your 
     * hook has run.
     *
     * If you do not explicitly redirect yourself, once this hook is finished 
     * the user will be redirected to the homepage with a message saying they 
     * have been logged out successfully.
     *
     * This method has no parameters and needs no return value
     */
    public function logout() {
    }

304 305 306
}


307 308 309 310
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

311
/**
312 313
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
314 315 316 317 318 319 320 321
 *
 * 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
322 323 324 325 326 327 328
 *
 * 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.
 *
329 330
 */
function auth_setup () {
331
    global $SESSION, $USER;
332 333 334 335

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
336
        $USER->logout();
337 338 339
        return;
    }

340
    // Lock the site until core upgrades are done
David Mudrak's avatar
David Mudrak committed
341
    require(get_config('libroot') . 'version.php');
342
    $siteclosed    = $config->version > get_config('version');
343 344 345 346 347 348 349
    $disablelogin  = $config->disablelogin;

    if (!$siteclosed && get_config('forcelocalupgrades')) {
        require(get_config('docroot') . 'local/version.php');
        $siteclosed = $config->version > get_config('localversion');
    }

350
    $cfgsiteclosed = get_config('siteclosed');
351 352 353 354 355
    if ($siteclosed && !$cfgsiteclosed || !$siteclosed && $cfgsiteclosed) {
        // If the admin closed the site manually, open it automatically
        // when an upgrade is successful.
        if ($cfgsiteclosed && get_config('siteclosedbyadmin')) {
            set_config('siteclosedbyadmin', false);
356
        }
357 358
        set_config('siteclosed', $siteclosed);
        set_config('disablelogin', $disablelogin);
359
    }
360

361 362
    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
363
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
364
    if ($sessionlogouttime && isset($_GET['logout'])) {
365 366
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
367 368 369 370 371 372 373
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
374

375 376
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
377
        redirect();
Nigel McNie's avatar
Nigel McNie committed
378 379
    }
    if ($sessionlogouttime > time()) {
380
        // The session is still active, so continue it.
381 382 383
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
384
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->id);
385
            if (!$USER->get('admin') && $userreallyadmin) {
386
                // The user has been made into an admin
387
                $USER->admin = 1;
388
            }
389
            else if ($USER->get('admin') && !$userreallyadmin) {
390
                // The user's admin rights have been taken away
391
                $USER->admin = 0;
392 393
            }
            if (!$USER->get('admin')) {
394
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
395
                redirect();
396
            }
397
        } else if (defined('INSTITUTIONALADMIN') && !$USER->get('admin')) {
398 399 400 401 402 403 404 405
            $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()) {
406
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
407
                redirect();
408
            }
409
        }
410
        $USER->renew();
411
        auth_check_required_fields();
412 413 414
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
415 416

        $authinstance = $SESSION->get('authinstance');
417 418 419 420 421 422 423 424 425
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);

            $mnetuser = 0;
            if ($SESSION->get('mnetuser') && $authobj->parent) {
                // We wish to remember that the user is an MNET user - even though 
                // they're using the local login form
                $mnetuser = $USER->get('id');
            }
426

427 428
            $authobj->logout();
            $USER->logout();
429

430 431 432 433 434 435 436
            if ($mnetuser != 0) {
                $SESSION->set('mnetuser', $mnetuser);
                $SESSION->set('authinstance', $authinstance);
            }
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
437 438
        }

439
        if (defined('JSON')) {
440
            json_reply('global', get_string('sessiontimedoutreload'), 1);
441
        }
442 443 444 445 446 447
        if (defined('IFRAME')) {
            $frame = '<html><head></head><body onload="parent.show_login_form(\'ajaxlogin_iframe\')"></body></html>';
            header('Content-type: text/html');
            echo $frame;
            exit;
        }
448

449 450 451 452 453 454
        // 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
455 456 457 458
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
459 460 461
            return;
        }

462
        auth_draw_login_page(get_string('sessiontimedout'));
463 464 465
    }
    else {
        // There is no session, so we check to see if one needs to be started.
466
        // Build login form. If the form is submitted it will be handled here,
467 468
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
469 470
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
471 472
        if ($USER->is_logged_in()) {
            return;
473 474 475
        }
        
        // Check if the page is public or the site is configured to be public.
476
        if (defined('PUBLIC') && !isset($_GET['login'])) {
477
            return;
478
        }
479 480 481 482 483

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
484
        
485
        auth_draw_login_page(null, $form);
486
        exit;
487 488 489
    }
}

490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
/**
 * 
 * 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,
508 509
            i.instancename,
            i.authname
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
        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;
}


529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
/**
 * 
 * Given a list of institutions, returns all auth instances associated with them
 *
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instances_for_institutions($institutions) {
    if (empty($institutions)) {
        return array();
    }
    $sql ='
        SELECT DISTINCT
            i.id,
            inst.name,
            inst.displayname,
544 545
            i.instancename,
            i.authname
546 547 548 549 550 551 552 553 554 555 556 557
        FROM 
            {institution} inst,
            {auth_instance} i
        WHERE 
            i.institution = inst.name AND
            inst.name IN (' . join(',', array_map('db_quote',$institutions)) . ')
        ORDER BY
            inst.displayname,
            i.instancename';

    return get_records_sql_array($sql, array());
}
558 559


560
/**
561 562
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
563
 *
564 565
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
566
 */
567
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
568
    static $cache = array();
569

570
    if (null == $institution) {
571 572 573
        return array();
    }

574
    if (!isset($cache[$institution])) {
575 576 577 578 579 580 581 582 583 584 585
        // 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,
586 587
                a.requires_config,
                a.requires_parent
588
            FROM 
589 590
                {auth_instance} i,
                {auth_installed} a
591 592 593 594 595 596 597 598 599
            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());

600
        if (empty($cache[$institution])) {
601 602
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
603
    }
604 605

    return $cache[$institution];
606 607
}

608 609 610 611 612 613
/**
 * 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
 */
614
function auth_get_auth_instances_for_wwwroot($wwwroot) {
615 616 617

    // TODO: we just need ai.id and ai.authname... rewrite query, or
    // just drop this function
618 619 620 621 622
    $query = "  SELECT
                    ai.*,
                    aic.*,
                    i.*
                FROM
623 624 625
                    {auth_instance} ai, 
                    {auth_instance_config} aic,
                    {institution} i
626 627 628 629 630 631 632 633 634
                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));
}

635 636 637 638 639 640 641
/**
 * 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
 */
642
function auth_get_available_auth_types($institution=null) {
643

644
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
645 646 647 648 649 650 651 652 653
        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 
654
            {auth_installed} a
655
        LEFT JOIN 
656
            {auth_instance} i
657 658 659 660 661 662 663 664 665 666
        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';          

667 668 669 670 671
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
672 673 674 675 676

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

677 678 679 680 681 682 683 684 685 686 687 688
    foreach ($result as &$row) {
        $row->title       = get_string('title', 'auth.' . $row->name);
        safe_require('auth', $row->name);
        if ($row->is_usable = call_static_method('PluginAuth' . $row->name, 'is_usable')) {
            $row->description = get_string('description', 'auth.' . $row->name);
        }
        else {
            $row->description = get_string('notusable', 'auth.' . $row->name);
        }
    }
    usort($result, create_function('$a, $b', 'return strnatcasecmp($a->title, $b->title);'));

689 690
    return $result;
}
691 692
/**
 * Checks that all the required fields are set, and handles setting them if required.
693 694 695
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
696 697
 */
function auth_check_required_fields() {
698 699 700 701 702 703 704 705 706 707 708 709
    global $USER, $SESSION;

    $changepassword = true;
    $elements = array();

    if (
        !$USER->get('passwordchange')                                // User doesn't need to change their password
        || ($USER->get('parentuser') && $USER->get('loginanyway'))   // User is masquerading and wants to log in anyway
        || defined('NOCHECKPASSWORDCHANGE')                          // The page wants to skip this hassle
        ) {
        $changepassword = false;
    }
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 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
    // Check if the user wants to log in anyway
    if ($USER->get('passwordchange') && $USER->get('parentuser') && isset($_GET['loginanyway'])) {
        $USER->loginanyway = true;
        $changepassword = false;
    }

    if ($changepassword) {
        $authobj = AuthFactory::create($USER->authinstance);

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

        if (method_exists($authobj, 'change_password')) {

            if ($SESSION->get('resetusername')) {
                $elements['username'] = array(
                    'type' => 'text',
                    'defaultvalue' => $USER->get('username'),
                    'title' => get_string('changeusername', 'account'),
                    'description' => get_string('changeusernamedesc', 'account', hsc(get_config('sitename'))),
                );
            }

            $elements['password1'] = array(
                'type'        => 'password',
                'title'       => get_string('newpassword') . ':',
                'description' => get_string('yournewpassword'),
                'rules'       => array(
                    'required' => true
                )
            );

            $elements['password2'] = array(
                'type'        => 'password',
                'title'       => get_string('confirmpassword') . ':',
                'description' => get_string('yournewpasswordagain'),
                'rules'       => array(
                    'required' => true,
                ),
            );

            $elements['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,
                ),
            );
        }
    }
    else if (defined('JSON')) {
766 767 768 769
        // Don't need to check this for json requests
        return;
    }

770 771 772
    safe_require('artefact', 'internal');
    require_once('pieforms/pieform.php');

773
    $alwaysmandatoryfields = array_keys(ArtefactTypeProfile::get_always_mandatory_fields());
774
    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
775 776 777 778 779 780 781
        // Always mandatory fields are stored in the usr table, so are part of 
        // the user session object. We can save a query by grabbing them from 
        // the session.
        if (in_array($field, $alwaysmandatoryfields) && $USER->get($field) != null) {
            continue;
        }
        // Not cached? Get value the standard way.
782
        if (get_profile_field($USER->get('id'), $field) != null) {
783 784 785
            continue;
        }

786
        if ($field == 'email') {
787 788 789 790
            if (isset($elements['email'])) {
                continue;
            }
            // Use a text field for their first e-mail address, not the
791 792 793 794
            // emaillist element
            $type = 'text';
        }

795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
        $elements[$field] = array(
            'type'  => $type,
            'title' => get_string($field, 'artefact.internal'),
            'rules' => array('required' => true)
        );

        // @todo ruthlessly stolen from artefact/internal/index.php, could be merged
        if ($type == 'wysiwyg') {
            $elements[$field]['rows'] = 10;
            $elements[$field]['cols'] = 60;
        }
        if ($type == 'textarea') {
            $elements[$field]['rows'] = 4;
            $elements[$field]['cols'] = 60;
        }
        if ($field == 'country') {
            $elements[$field]['options'] = getoptions_country();
            $elements[$field]['defaultvalue'] = 'nz';
        }
814 815 816 817

        if ($field == 'email') {
            $elements[$field]['rules']['email'] = true;
        }
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
    }

    if (empty($elements)) { // No mandatory fields that aren't set
        return;
    }

    $elements['submit'] = array(
        'type' => 'submit',
        'value' => get_string('submit')
    );

    $form = pieform(array(
        'name'     => 'requiredfields',
        'method'   => 'post',
        'action'   => '',
        'elements' => $elements
    ));

    $smarty = smarty();
837 838 839 840 841 842
    if ($USER->get('parentuser')) {
        $smarty->assign('loginasoverridepasswordchange',
            get_string('loginasoverridepasswordchange', 'admin',
                       '<a href="' . get_config('wwwroot') . '?loginanyway">', '</a>'));
    }
    $smarty->assign('changepassword', $changepassword);
843
    $smarty->assign('changeusername', $SESSION->get('resetusername'));
844 845 846 847 848
    $smarty->assign('form', $form);
    $smarty->display('requiredfields.tpl');
    exit;
}

849
function requiredfields_validate(Pieform $form, $values) {
Nigel McNie's avatar
Nigel McNie committed
850
    global $USER;
851 852
    if (!isset($values['password1'])) {
        return true;
853 854
    }

855
    // Get the authentication type for the user, and
856
    // use the information to validate the password
857
    $authobj = AuthFactory::create($USER->authinstance);
858

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

Nigel McNie's avatar
Nigel McNie committed
862
    // The password cannot be the same as the old one
863
    if (!$form->get_error('password1')
864
        && $authobj->authenticate_user_account($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
865
        $form->set_error('password1', get_string('passwordnotchanged'));
866
    }
867 868 869 870 871 872 873 874 875

    if ($authobj->authname == 'internal' && isset($values['username']) && $values['username'] != $USER->get('username')) {
        if (!AuthInternal::is_username_valid($values['username'])) {
            $form->set_error('username', get_string('usernameinvalidform', 'auth.internal'));
        }
        if (!$form->get_error('username') && record_exists_select('usr', 'LOWER(username) = ?', strtolower($values['username']))) {
            $form->set_error('username', get_string('usernamealreadytaken', 'auth.internal'));
        }
    }
876 877
}

878
function requiredfields_submit(Pieform $form, $values) {
879
    global $USER, $SESSION;
880

881 882 883 884 885 886 887 888 889 890 891 892 893 894
    if (isset($values['password1'])) {
        $authobj = AuthFactory::create($USER->authinstance);

        // This method should exist, because if it did not then the change
        // password form would not have been shown.
        if ($password = $authobj->change_password($USER, $values['password1'])) {
            $SESSION->add_ok_msg(get_string('passwordsaved'));
        }
        else {
            // TODO: Exception is the wrong type here!
            throw new Exception('Attempt by "' . $USER->get('username') . '@'
                . $USER->get('institution') . 'to change their password failed');
        }
    }
Nigel McNie's avatar
Nigel McNie committed
895

896 897 898 899 900 901 902 903 904 905 906 907 908 909
    if (isset($values['username'])) {
        $SESSION->set('resetusername', false);
        if ($values['username'] != $USER->get('username')) {
            $USER->username = $values['username'];
            $USER->commit();
            $otherfield = true;
        }
    }

    foreach ($values as $field => $value) {
        if (in_array($field, array('submit', 'sesskey', 'password1', 'password2', 'username'))) {
            continue;
        }
        if ($field == 'email') {
910 911
            $USER->email = $values['email'];
            $USER->commit();
912
        }
913 914
        set_profile_field($USER->get('id'), $field, $value);
        $otherfield = true;
915
    }
Nigel McNie's avatar
Nigel McNie committed
916

917 918 919 920 921
    if (isset($otherfield)) {
        $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    }

    redirect();
922 923
}

924
/**
Nigel McNie's avatar
Nigel McNie committed
925
 * Creates and displays the transient login page.
926
 *
Nigel McNie's avatar
Nigel McNie committed
927 928 929 930
 * 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.
 *
931 932 933
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
934 935 936
 * @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
937
 * @access private
938
 */
939
function auth_draw_login_page($message=null, Pieform $form=null) {
940
    global $USER, $SESSION;
941
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
942
        $loginform = get_login_form_js($form->build());
943 944
    }
    else {
945
        require_once('pieforms/pieform.php');
946
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
947 948 949 950 951
        /*
         * 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.
         */
952
        if ($USER->is_logged_in()) {
953 954 955 956 957 958 959
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
960
    }
961
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false, 'sidebars' => false));
962
    $smarty->assign('login_form', $loginform);
963
    $smarty->assign('PAGEHEADING', hsc(get_string('loginto', 'mahara', get_config('sitename'))));
964 965 966
    $smarty->display('login.tpl');
    exit;
}
967

968
/**
Nigel McNie's avatar
Nigel McNie committed
969
 * Returns the definition of the login form.
970
 *
Nigel McNie's avatar
Nigel McNie committed
971 972
 * @return array   The login form definition array.
 * @access private
973 974
 */
function auth_get_login_form() {
975
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
976 977 978 979 980 981
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
982 983
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
984 985 986 987
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
988
            'defaultvalue'       => '',
Nigel McNie's avatar
Nigel McNie committed
989
        ),
990 991
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
992
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
993
        ),
994 995 996 997
        'login_submitted' => array(
            'type'  => 'hidden',
            'value' => 1
        ),
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
    );

    // 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) {
1014
                if ($key != 'logout' && $key != 'login') {
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
                    $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(
1033 1034 1035 1036 1037 1038 1039 1040
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
1041 1042
    );

1043
    return $form;
1044 1045
}

Nigel McNie's avatar
Nigel McNie committed
1046 1047 1048 1049 1050
/**
 * 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.
 *
1051 1052
 * @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
1053 1054 1055 1056
 * @private
 */
function get_login_form_js($form) {
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
1057
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
1058 1059 1060
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
1061
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
1062
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
1063 1064
if (document.cookie) {
    loginbox.innerHTML = '$form';
1065
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
1066 1067
}
else {
1068
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
Nigel McNie's avatar
Nigel McNie committed
1069 1070 1071 1072
}
</script>
EOF;
}
1073

1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107

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

1108
/**
1109
 * Called when the login form is submitted. Validates the user and password, and
1110
 * if they are valid, starts a new session for the user.
1111
 *
1112 1113
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
1114
 * @access private
1115
 */
1116
function login_submit(Pieform $form, $values) {
1117 1118
    global $SESSION, $USER;

1119 1120 1121 1122
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
1123

1124
    try {
1125
        $authenticated = $USER->login($username, $password);
1126

1127 1128
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
1129
            return;
1130
        }
1131

1132 1133
    }
    catch (AuthUnknownUserException $e) {
1134 1135
        // If the user doesn't exist, check for institutions that
        // want to create users automatically.
1136
        try {
1137 1138
            // Reset the LiveUser object, since we are attempting to create a 
            // new user
1139
            $SESSION->destroy_session();
1140 1141
            $USER = new LiveUser();

1142
            $authinstances = get_records_sql_array('
1143
                SELECT a.id, a.instancename, a.priority, a.authname, a.institution, i.suspended, i.displayname
1144 1145 1146 1147 1148
                FROM {institution} i JOIN {auth_instance} a ON a.institution = i.name
                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
1149 1150
            }

1151
            $USER->username = $username;
1152

1153 1154 1155 1156 1157 1158 1159 1160
            reset($authinstances);
            while ((list(, $authinstance) = each($authinstances)) && false == $authenticated) {
                $auth = AuthFactory::create($authinstance->id);
                if (!$auth->can_auto_create_users()) {
                    continue;
                }
                if ($auth->authenticate_user_account($USER, $password)) {
                    $authenticated = true;
1161 1162
                }
                else {
1163 1164
                    continue;
                }
1165

1166 1167 1168 1169 1170 1171
                // Check now to see if the institution has its maximum quota of users
                require_once('institution.php');
                $institution = new Institution($authinstance->institution);
                if ($institution->isFull()) {
                    throw new AuthUnknownUserException('Institution has too many users');
                }
1172

1173 1174
                $USER->authinstance = $authinstance->id;
                $userdata = $auth->get_user_info($username);
1175

1176
                if (empty($userdata)) {
1177
                    throw new AuthUnknownUserException("\"$username\" is not known");
1178
                }
1179 1180 1181 1182 1183 1184 1185

                // Check for a suspended institution
                if ($authinstance->suspended) {
                    $sitename = get_config('sitename');
                    throw new AccessTotallyDeniedException(get_string('accesstotallydenied_institutionsuspended', 'mahara', $authinstance->displayname, $sitename));
                }

1186 1187 1188
                // We have the data - create the user
                $USER->lastlogin = db_format_timestamp(time());
                if (isset($userdata->firstname)) {
1189
                    $USER->firstname = $userdata->firstname;