lib.php 104 KB
Newer Older
1 2 3 4
<?php
/**
 *
 * @package    mahara
Nigel McNie's avatar
Nigel McNie committed
5
 * @subpackage auth
6
 * @author     Catalyst IT Ltd
7 8
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL version 3 or later
 * @copyright  For copyright information on Mahara, please see the README file distributed with this software.
9 10 11 12 13
 *
 */

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

14
require(get_config('docroot') . 'auth/user.php');
15
require_once(get_config('docroot') . '/lib/htmloutput.php');
16

17 18 19
/**
 * Unknown user exception
 */
20
class AuthUnknownUserException extends UserException {}
21

22
/**
23
 * An instance of an auth plugin failed during execution
24 25 26 27 28 29
 * e.g. LDAP auth failed to connect to a directory
 * Developers can use this to fail an individual auth
 * instance, but not kill all from being tried.
 * If appropriate - the 'message' of the exception will be used
 * as the display message, so don't forget to language translate it
 */
30 31 32 33 34 35
class AuthInstanceException extends UserException {

    public function strings() {
        return array_merge(parent::strings(),
                           array('title' => $this->get_sitename() . ': Authentication problem'));
    }
36 37 38 39

    public function render_exception() {
        return $this->get_string('message') . "\n\n" . preg_replace('/<br\s?\/?>/ius', "\n", $this->getMessage());
    }
40
}
41

42
/**
43
 * We tried to call a method on an auth plugin that hasn't been init'ed
44 45 46 47
 * successfully
 */
class UninitialisedAuthException extends SystemException {}

48 49 50 51 52 53 54 55 56 57 58 59 60 61
/**
 * We tried creating automatically creating an account for a user but
 * it failed for a reason that the user might want to know about
 * (e.g. they used an email address that's already used on the site)
 */
class AccountAutoCreationException extends AuthInstanceException {

    public function strings() {
        return array_merge(parent::strings(),
                           array('message' => 'The automatic creation of your user account failed.'
                                 . "\nDetails if any, follow:"));
    }
}

62 63 64
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
65 66 67 68 69 70
 *
 * @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
71 72 73
 */
abstract class Auth {

74 75 76 77 78 79
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
80
    protected $has_instance_config;
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
    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;

118
        // Return now if the plugin type doesn't require any config
119
        // (e.g. internal)
120
        if ($this->has_instance_config == false) {
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
            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.
140
     *
141 142 143 144
     * @param  string  $name   The name of the value to fetch
     * @return mixed           The value
     */
    public function __get($name) {
145
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname', 'type');
146 147 148 149

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }
150 151
        if (isset($this->config[$name])) {
            return $this->config[$name];
152 153 154 155 156 157 158
        }
        return null;
    }

    /**
     * The __set overloader is invoked when the specified member is private or
     * protected, or just doesn't exist.
159
     *
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
     * @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.
176
     *
177
     * @throws UninitialisedAuthException
178
     * @return bool
179 180 181 182 183 184 185 186 187 188 189
     */
    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.
190
     *
191 192 193 194 195 196 197 198 199 200
     * @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'];
    }

201
    /**
202
     * Given a username and password, attempts to log the user in.
203
     *
204
     * @param object $user      An object with username member (at least)
205 206 207 208 209
     * @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
     */
210 211 212 213
    public function authenticate_user_account($user, $password) {
        $this->must_be_ready();
        return false;
    }
214

215 216 217 218 219 220
    /**
     * 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
     */
221 222
    public function user_exists($username) {
        $this->must_be_ready();
223
        if (record_exists_select('usr', 'LOWER(username) = ?', array(strtolower($username)))) {
224 225 226 227
            return true;
        }
        throw new AuthUnknownUserException("\"$username\" is not known to Auth");
    }
228

229
    /**
230
     * Returns whether the authentication instance can automatically create a
231 232
     * user record.
     *
233
     * Auto creating users means that the authentication plugin can say that
234 235 236 237
     * 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).
     *
238 239 240
     * 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
241 242
     * for the new user.
     *
243 244
     * Authentication methods must implement this method. Some may choose to
     * implement it by returning an instance config value that the admin user
245 246 247 248 249 250
     * can set.
     *
     * @return bool
     */
    public abstract function can_auto_create_users();

251 252 253 254 255 256 257 258 259
    /**
     * If this plugin allows new user's to self-register, this function will be
     * called to check whether it is okay to display a captcha method on the new
     * user self-registration form.
     */
    public static function can_use_registration_captcha() {
        return true;
    }

260
    /**
261
     * Given a username, returns a hash of information about a user from the
262
     * external data source.
263 264 265 266 267 268
     *
     * @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
     */
269 270 271
    public function get_user_info($username) {
        return false;
    }
272

273 274 275 276
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
277 278 279 280 281
     * 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.
282 283 284 285
     *
     * 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!
     *
286
     * This method is defined to be empty, so that authentication methods do
287 288
     * not have to specify a format if they do not need to.
     *
289 290 291
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
292
    public function is_password_valid($password) {
293 294 295
        return true;
    }

296 297 298 299 300 301 302 303 304 305 306 307
    /**
     * 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() {
    }

308
    /**
309 310 311
     * 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
312 313
     * page load.
     *
314 315
     * 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
316 317
     * where this happens.
     *
318 319
     * 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
320 321
     * hook has run.
     *
322 323
     * 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
324 325 326 327 328 329 330
     * have been logged out successfully.
     *
     * This method has no parameters and needs no return value
     */
    public function logout() {
    }

331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359
    /**
     * Indicates whether this auth instance is parent to another auth instance
     * @return boolean (For backwards-compatibility reasons, it actually returns $this or null)
     */
    public function is_parent_authority() {
        if (count_records('auth_instance_config', 'field', 'parent', 'value', $this->instanceid)) {
            return $this;
        }
        else {
            return null;
        }
    }

    /**
     * Returns the ID of this instance's parent authority; or FALSE if it has no parent authority
     * @return int|false
     */
    public function get_parent_authority() {
        return get_field('auth_instance_config', 'value', 'instance', $this->id, 'field', 'parent');
    }


    /**
     * Indicates whether or not this auth instance uses the remote username. Most auth instances
     * will only use it if they are the parent to another auth instance.
     */
    public function needs_remote_username() {
        return (boolean) $this->is_parent_authority();
    }
360 361 362
}


363 364 365
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
/*
* Checks all the available auth types and executes 'install_auth_default' method
* if they have one
*/
function install_auth_default() {
    $plugins = auth_get_available_auth_types();

    foreach ($plugins as $key => $value) {
        $classname = 'PluginAuth' . ucfirst(strtolower($value->name));
        $methodname = 'install_auth_default';
        if (method_exists($classname, $methodname)) {
            call_static_method($classname, $methodname);
        }
    }
}
381

382
/**
383
 * Handles authentication by setting up a session for a user if they are logged
384
 * in.
385 386 387 388 389 390 391 392
 *
 * 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.
393 394 395 396 397 398 399
 *
 * 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.
 *
400 401
 */
function auth_setup () {
402
    global $SESSION, $USER;
403 404 405 406

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
407
        $USER->logout();
408 409 410 411 412
        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.
413
    $sessionlogouttime = $USER->get('logout_time');
414 415 416 417 418 419

    // Need to doublecheck that the User's sessionid still has a match the usr_session table
    // It can disappear if the current user has hacked the real user's account and the real user has
    // reset the password clearing the session from usr_session.
    $sessionexists = get_record('usr_session', 'usr', $USER->id, 'session', $USER->get('sessionid'));
    $parentuser = $USER->get('parentuser');
420 421 422
    if (($sessionlogouttime && isset($_GET['logout']))
       || ($sessionexists === false && $USER->get('sessionid') != '' && empty($parentuser))
       || ($sessionexists && isset($sessionexists->useragent) && $sessionexists->useragent != $_SERVER['HTTP_USER_AGENT'])) {
423 424
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
425 426 427 428 429 430 431
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
432

433 434 435 436
        if (function_exists('local_logout')) {
            local_logout();
        }

437 438
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
439
        redirect();
440 441
    }
    if ($sessionlogouttime > time()) {
442
        // The session is still active, so continue it.
443 444
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
445 446 447 448
        if (in_admin_section()) {
            // Reload site admin/staff permissions
            $realuser = get_record('usr', 'id', $USER->id, null, null, null, null, 'admin,staff');
            if (!$USER->get('admin') && $realuser->admin) {
449
                // The user has been made into an admin
450
                $USER->admin = 1;
451
            }
452
            else if ($USER->get('admin') && !$realuser->admin) {
453
                // The user's admin rights have been taken away
454
                $USER->admin = 0;
455
            }
456 457
            if (!$USER->get('staff') && $realuser->staff) {
                $USER->staff = 1;
458
            }
459 460
            else if ($USER->get('staff') && !$realuser->staff) {
                $USER->staff = 0;
461
            }
462 463 464
            // Reload institutional admin/staff permissions
            $USER->reset_institutions();
            auth_check_admin_section();
465
        }
466
        $USER->renew();
467
        auth_check_required_fields();
468 469 470
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
471 472

        $authinstance = $SESSION->get('authinstance');
473 474 475 476 477
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);

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

483 484
            $authobj->logout();
            $USER->logout();
485

486 487 488 489 490 491 492
            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");
493 494
        }

495
        if (defined('JSON')) {
496
            json_reply('global', get_string('sessiontimedoutreload'), 1);
497 498
        }

499 500 501 502 503 504
        // 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
505 506 507 508
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
509 510 511
            return;
        }

512
        auth_draw_login_page(get_string('sessiontimedout'));
513 514 515
    }
    else {
        // There is no session, so we check to see if one needs to be started.
516
        // Build login form. If the form is submitted it will be handled here,
517 518
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
519
        $form = pieform_instance(auth_get_login_form());
520 521
        if ($USER->is_logged_in()) {
            return;
522
        }
523

524
        // Check if the page is public or the site is configured to be public.
525
        if (defined('PUBLIC') && !isset($_GET['login'])) {
526
            return;
527
        }
528 529 530 531 532

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
533

534
        auth_draw_login_page(null, $form);
535
        exit;
536 537 538
    }
}

539
/**
540
 *
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556
 * 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,
557 558
            i.instancename,
            i.authname
559
        FROM
560 561
            {institution} inst,
            {auth_instance} i
562
        WHERE
563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
            i.institution = inst.name
        ORDER BY
            inst.displayname,
            i.instancename';

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

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

    return $cache;
}


578
/**
579
 *
580 581 582 583 584 585 586 587 588 589 590 591 592
 * 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,
593 594
            i.instancename,
            i.authname
595
        FROM
596 597
            {institution} inst,
            {auth_instance} i
598
        WHERE
599 600 601 602 603 604 605 606
            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());
}
607 608


609
/**
610
 * Given an institution, returns the authentication methods used by it, sorted
611
 * by priority.
612
 *
613 614
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
615
 */
616
function auth_get_auth_instances_for_institution($institution=null) {
617
    static $cache = array();
618

619
    if (null == $institution) {
620 621 622
        return array();
    }

623
    if (!isset($cache[$institution])) {
624 625 626 627 628 629 630 631 632 633 634
        // 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,
635 636
                a.requires_config,
                a.requires_parent
637
            FROM
638 639
                {auth_instance} i,
                {auth_installed} a
640
            WHERE
641 642 643 644 645 646 647 648
                a.name = i.authname AND
                i.institution = '. db_quote($institution).'
            ORDER BY
                i.priority,
                i.instancename';

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

649
        if (empty($cache[$institution])) {
650 651
            return false;
        }
652
    }
653 654

    return $cache[$institution];
655 656
}

657 658
/**
 * Given a wwwroot, find any auth instances that can come from that host
659
 *
660 661 662
 * @param   string  wwwroot of the host that is connecting to us
 * @return  array   array of record objects
 */
663 664
function auth_get_auth_instances_for_wwwroot($wwwroot) {
    $query = "  SELECT
665 666 667 668 669
                    ai.id,
                    ai.authname,
                    i.id as institutionid,
                    i.displayname,
                    i.suspended
670
                FROM
671 672 673 674 675 676
                    {auth_instance} ai
                    INNER JOIN {institution} i
                        ON ai.institution = i.name
                    INNER JOIN {auth_instance_config} aic
                        ON aic.field = 'wwwroot'
                        AND aic.instance = ai.id
677
                WHERE
678
                    aic.value = ?";
679 680 681 682

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

683
/**
684
 * Given an institution, get all the auth types EXCEPT those that are already
685 686 687 688 689
 * enabled AND do not require configuration.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
690
function auth_get_available_auth_types($institution=null) {
691

692
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
693 694 695 696 697 698 699 700
        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
701
        FROM
702
            {auth_installed} a
703
        LEFT JOIN
704
            {auth_instance} i
705
        ON
706 707 708 709 710 711 712
            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
713
            a.name';
714

715 716 717 718 719
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
720 721 722 723 724

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

725 726 727 728 729 730 731 732 733 734
    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);
        }
    }
735
    usort($result, create_function('$a, $b', 'if ($a->is_usable != $b->is_usable) return $b->is_usable; return strnatcasecmp($a->title, $b->title);'));
736

737 738
    return $result;
}
739 740
/**
 * Checks that all the required fields are set, and handles setting them if required.
741 742 743
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
744 745
 */
function auth_check_required_fields() {
746 747
    global $USER, $SESSION;

748
    if (defined('NOCHECKREQUIREDFIELDS') || $SESSION->get('nocheckrequiredfields') === true) {
749 750
        return;
    }
751 752 753 754 755 756 757 758 759 760
    $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;
    }
761

762 763 764 765 766 767
    // Check if the user wants to log in anyway
    if ($USER->get('passwordchange') && $USER->get('parentuser') && isset($_GET['loginanyway'])) {
        $USER->loginanyway = true;
        $changepassword = false;
    }

768 769 770 771 772
    // Do not force password change on JSON request.
    if (defined('JSON') && JSON == true) {
        $changepassword = false;
    }

773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
    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')) {
822 823 824 825
        // Don't need to check this for json requests
        return;
    }

826 827
    safe_require('artefact', 'internal');

828
    $alwaysmandatoryfields = array_keys(ArtefactTypeProfile::get_always_mandatory_fields());
829
    $element_data = ArtefactTypeProfile::get_field_element_data();
830
    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
831 832
        // 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
833 834 835 836 837
        // the session.
        if (in_array($field, $alwaysmandatoryfields) && $USER->get($field) != null) {
            continue;
        }
        // Not cached? Get value the standard way.
838
        if (get_profile_field($USER->get('id'), $field) != null) {
839 840 841
            continue;
        }

842
        if ($field == 'email') {
843 844 845 846
            if (isset($elements['email'])) {
                continue;
            }
            // Use a text field for their first e-mail address, not the
847 848 849 850
            // emaillist element
            $type = 'text';
        }

851 852 853 854 855
        $elements[$field] = array(
            'type'  => $type,
            'title' => get_string($field, 'artefact.internal'),
            'rules' => array('required' => true)
        );
856 857 858 859 860
        // We need to merge the rules for the element if they have special rules defined
        // in get_field_element_data() so that we save correct data.
        if (isset($element_data[$field])) {
            $elements[$field] = array_merge_recursive($elements[$field], $element_data[$field]);
        }
861

862 863 864 865 866 867 868 869 870
        if ($field == 'socialprofile') {
            $elements[$field] = ArtefactTypeSocialprofile::get_new_profile_elements();
            // add an element to flag that socialprofile is in the list of fields.
            $elements['socialprofile_hidden'] = array(
                'type'  => 'hidden',
                'value' => 1,
            );
        }

871 872 873 874 875 876 877 878 879 880 881
        // @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();
882
            $elements[$field]['defaultvalue'] = get_config('country');
883
        }
884 885

        if ($field == 'email') {
886 887 888 889 890 891 892 893 894 895 896
            // Check if a validation email has been sent
            if (record_exists('artefact_internal_profile_email', 'owner', $USER->get('id'))) {
                $elements['email']['type'] = 'html';
                $elements['email']['value'] = get_string('validationprimaryemailsent', 'auth');
                $elements['email']['disabled'] = true;
                $elements['email']['rules'] = array('required' => false);
            }
            else {
                $elements[$field]['rules']['email'] = true;
                $elements[$field]['description'] = get_string('primaryemaildescription', 'auth');
            }
897
        }
898 899 900
    }

    if (empty($elements)) { // No mandatory fields that aren't set
901
        $SESSION->set('nocheckrequiredfields', true);
902 903 904
        return;
    }

905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920
    if ((count($elements) == 1) && isset($elements['email']) && ($elements['email']['type'] == 'html')) {
        // Display a message if there is only 1 required field and this field is email whose validation has been sent
        $elements['submit'] = array(
                'type' => 'submit',
                'value' => get_string('continue', 'admin')
        );
        $form = pieform(array(
                'name'     => 'requiredfields',
                'method'   => 'post',
                'action'   => get_config('wwwroot') . '?logout',
                'elements' => $elements
        ));
    }
    else {
        $elements['submit'] = array(
            'type' => 'submit',
921
            'class' => 'btn-primary',
922 923
            'value' => get_string('submit')
        );
924

925 926 927 928
        $form = pieform(array(
            'name'     => 'requiredfields',
            'method'   => 'post',
            'action'   => '',
929 930 931
            'elements' => $elements,
            'dieaftersubmit' => FALSE,
            'backoutaftersubmit' => TRUE,
932 933
        ));
    }
934

935 936 937 938 939
    // Has the form been successfully submitted? Back out and let the requested URL continue.
    if ($form === FALSE) {
        return;
    }

940
    $smarty = smarty();
941 942 943
    if ($USER->get('parentuser')) {
        $smarty->assign('loginasoverridepasswordchange',
            get_string('loginasoverridepasswordchange', 'admin',
944
                       '<strong><a class="" href="' . get_config('wwwroot') . '?loginanyway">', '</a></strong>'));
945 946
    }
    $smarty->assign('changepassword', $changepassword);
947
    $smarty->assign('changeusername', $SESSION->get('resetusername'));
948 949 950 951 952
    $smarty->assign('form', $form);
    $smarty->display('requiredfields.tpl');
    exit;
}

953
function requiredfields_validate(Pieform $form, $values) {
954
    global $USER;
955
    if (isset($values['password1'])) {
956

957 958 959
        // Get the authentication type for the user, and
        // use the information to validate the password
        $authobj = AuthFactory::create($USER->authinstance);
960

961 962
        // @todo this could be done by a custom form rule... 'password' => $user
        password_validate($form, $values, $USER);
963

964 965 966 967 968 969
        // The password cannot be the same as the old one
        try {
            if (!$form->get_error('password1')
                && $authobj->authenticate_user_account($USER, $values['password1'])) {
                $form->set_error('password1', get_string('passwordnotchanged'));
            }
970
        }
971 972 973
        // propagate error up as the collective error AuthUnknownUserException
         catch  (AuthInstanceException $e) {
            $form->set_error('password1', $e->getMessage());
974
        }
975 976 977 978 979

        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'));
            }
980
            if (!$form->get_error('username') && record_exists_select('usr', 'LOWER(username) = ?', array(strtolower($values['username'])))) {
981 982
                $form->set_error('username', get_string('usernamealreadytaken', 'auth.internal'));
            }
983 984
        }
    }
985

986 987
    // Check if email has been taken
    if (isset($values['email']) && record_exists('artefact_internal_profile_email', 'email', $values['email'])) {
988
        $form->set_error('email', get_string('unvalidatedemailalreadytaken', 'artefact.internal'));
989
    }
990 991 992 993
    // Check if the socialprofile url is valid.
    if (isset($values['socialprofile_hidden']) && $values['socialprofile_hidden'] && $values['socialprofile_profiletype'] == 'webpage' && !filter_var($values['socialprofile_profileurl'], FILTER_VALIDATE_URL)) {
        $form->set_error('socialprofile_profileurl', get_string('notvalidprofileurl', 'artefact.internal'));
    }
994 995
}

996
function requiredfields_submit(Pieform $form, $values) {
997
    global $USER, $SESSION;
998

999 1000 1001 1002 1003 1004 1005 1006 1007
    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 {
1008
            throw new SystemException('Attempt by "' . $USER->get('username') . '@'
1009 1010 1011
                . $USER->get('institution') . 'to change their password failed');
        }
    }
1012

1013 1014 1015 1016 1017 1018 1019 1020 1021
    if (isset($values['username'])) {
        $SESSION->set('resetusername', false);
        if ($values['username'] != $USER->get('username')) {
            $USER->username = $values['username'];
            $USER->commit();
            $otherfield = true;
        }
    }

1022 1023 1024 1025 1026 1027
    if (isset($values['socialprofile_hidden']) && $values['socialprofile_hidden']) {
        // Socialprofile fields. Save them on their own as they are a fieldset.
        set_profile_field($USER->get('id'), 'socialprofile', $values);
        $otherfield = true;
    }

1028
    foreach ($values as $field => $value) {
1029 1030 1031
        if (in_array($field, array('submit', 'sesskey', 'password1', 'password2', 'username',
                                   'socialprofile_service', 'socialprofile_profiletype',
                                   'socialprofile_profileurl', 'socialprofile_hidden'))) {
1032 1033 1034
            continue;
        }
        if ($field == 'email') {
1035
            $email = $values['email'];
1036
            // Need to update the admin email on installation
1037
            if ($USER->get('admin')) {
1038 1039 1040 1041 1042
                $oldemail = get_field('usr', 'email', 'id', $USER->get('id'));
                if ($oldemail == 'admin@example.org') {
                    // we are dealing with the dummy email that is set on install
                    update_record('usr', array('email' => $email), array('id' => $USER->get('id')));
                    update_record('artefact_internal_profile_email', array('email' => $email), array('owner' => $USER->get('id')));
1043
                    update_record('artefact', array('title' => $email), array('owner' => $USER->get('id'), 'artefacttype' => 'email'));
1044 1045
                }
            }
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090
            // Check if a validation email has been sent, if not send one
            if (!record_exists('artefact_internal_profile_email', 'owner', $USER->get('id'))) {
                $key = get_random_key();
                $key_url = get_config('wwwroot') . 'artefact/internal/validate.php?email=' . rawurlencode($email) . '&key=' . $key;
                $key_url_decline = $key_url . '&decline=1';

                try {
                    $sitename = get_config('sitename');
                    email_user(
                        (object)array(
                            'id'            => $USER->get('id'),
                            'username'      => $USER->get('username'),
                            'firstname'     => $USER->get('firstname'),
                            'lastname'      => $USER->get('lastname'),
                            'preferredname' => $USER->get('preferredname'),
                            'admin'         => $USER->get('admin'),
                            'staff'         => $USER->get('staff'),
                            'email'         => $email,
                        ),
                        null,
                        get_string('emailvalidation_subject', 'artefact.internal'),
                        get_string('emailvalidation_body1', 'artefact.internal', $USER->get('firstname'), $email, $sitename, $key_url, $sitename, $key_url_decline)
                    );
                }
                catch (EmailException $e) {
                    $SESSION->add_error_msg($email);
                }

                insert_record(
                    'artefact_internal_profile_email',
                    (object) array(
                        'owner'    => $USER->get('id'),
                        'email'    => $email,
                        'verified' => 0,
                        'principal' => 1,
                        'key'      => $key,
                        'expiry'   => db_format_timestamp(time() + 86400),
                    )
                );
                $SESSION->add_ok_msg(get_string('validationemailsent', 'artefact.internal'));
            }
        }
        else {
            set_profile_field($USER->get('id'), $field, $value);
            $otherfield = true;
1091
        }
1092
    }
1093

1094 1095 1096 1097
    if (isset($otherfield)) {
        $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    }

1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
    // Update the title of user's first blog if first and/or last name have been changed
    $updatedfields = array_keys($values);
    if (in_array('firstname', $updatedfields) || in_array('lastname', $updatedfields)) {
        safe_require('artefact', 'blog');
        $userblogs = get_records_select_array('artefact', 'artefacttype = \'blog\' AND owner = ?', array($USER->get('id')));
        if ($userblogs && count($userblogs) == 1) {
            $defaultblog = new ArtefactTypeBlog($userblogs[0]->id);
            $defaultblog->set('title', get_string('defaultblogtitle', 'artefact.blog', display_name($USER, null, true)));
            $defaultblog->commit();
        }
    }

1110
    $SESSION->set('nocheckrequiredfields', true);
1111 1112 1113 1114
    if ($form->get_property('backoutaftersubmit')) {
        return;
    }

1115
    redirect();
1116 1117
}

1118
/**
1119
 * Creates and displays the transient login page.
1120
 *
1121 1122 1123 1124
 * 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.
 *
1125 1126 1127
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
1128 1129 1130
 * @param Pieform $form If specified, just build this form to get the HTML
 *                      required. Otherwise, this function will build and
 *                      validate the form itself.
1131
 * @access private
1132
 */
1133
function auth_draw_login_page($message=null, Pieform $form=null) {
1134
    global $USER, $SESSION;
1135
    if ($form != null) {
1136
        $loginform = get_login_form_js($form->build());
1137 1138
    }
    else {
1139
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
1140 1141 1142 1143 1144
        /*
         * 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.
         */
1145
        if ($USER->is_logged_in()) {
1146 1147 1148 1149 1150
            return;
        }

    }

1151 1152 1153 1154 1155 1156 1157
    $externallogin = get_config('externallogin');
    if ($externallogin) {
        $externallogin = preg_replace('/{shorturlencoded}/', urlencode(get_relative_script_path()), $externallogin);
        $externallogin = preg_replace('/{wwwroot}/', get_config('wwwroot'), $externallogin);
        redirect($externallogin);
    }

1158 1159
    if ($message) {
        $SESSION->add_info_msg($message);
1160
    }
1161
    define('TITLE', get_string('loginto', 'mahara', get_config('sitename')));
1162
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false, 'sidebars' => false));
1163
    $smarty->assign('login_form', $loginform);
1164
    $smarty->assign('LOGINPAGE', true);
1165 1166 1167
    $smarty->display('login.tpl');
    exit;
}
1168

1169
/**
1170
 * Returns the definition of the login form, for display on the transient login page.
1171
 *
1172 1173
 * @return array   The login form definition array.
 * @access private
1174 1175
 */
function auth_get_login_form() {
1176
    $elements = auth_get_login_form_elements();
1177

1178 1179 1180 1181
    $elements['login']['elements']['login_submitted'] = array(
        'type'  => 'hidden',
        'value' => 1
    );
1182

1183
    // Change login redirection for clean urls
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
    $url = get_relative_script_path();
    $getstart = strrpos($url, '?');
    if ($getstart !== false) {
        $getpart = substr($url, $getstart + 1);
        $url = substr($url, 0, $getstart);
    }
    if (!file_exists(get_config('docroot') . $url)) {
        // clean url, treat get string differently
        $get = array();
        if (isset($getpart)) {
1194
            $getarr = explode('&', $getpart);
1195 1196
            if ($getarr) {
                foreach ($getarr as $data) {
1197
                    $arr = explode('=', $data);
1198 1199 1200 1201 1202 1203 1204 1205
                    $get[$arr[0]] = isset($arr[1]) ? $arr[1] : null;
                }
            }
        }
    }
    else {
        $get = $_GET;
    }
1206 1207
    // 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
1208
    // afterwards.
1209
    $action = '';
1210 1211
    if ($get) {
        if (isset($get['logout'])) {
1212 1213 1214 1215
            // 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.
1216
            $action = hsc(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?')));
1217 1218
        }
        else {
1219 1220 1221
            unset($get['login']);
            if (count($get)) {
                $action = '?' . http_build_query($get);
1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236
            }
        }
    }
    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(
1237
        'name'           => 'login',
1238
        'renderer'       => 'div',
1239 1240 1241 1242 1243 1244 1245
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
1246 1247
    );

1248
    return $form;
1249 1250
}

1251 1252 1253 1254 1255 1256 1257 1258 1259
/**
 * Returns the definition of the login form elements.
 *
 * @return array   The login form elements array.
 * @access private
 */
function auth_get_login_form_elements() {
    // See if user can register
    if (count_records('institution', 'registerallowed', 1, 'suspended', 0)) {
Pat Kira's avatar
Pat Kira committed
1260
        $registerlink = '<a class="register-link text-small" href="' . get_config('wwwroot') . 'register.php">' . get_string('register') . '</a> |';
1261 1262 1263 1264 1265 1266 1267 1268
    }
    else {
        $registerlink = '';
    }

    $elements = array(
        'login_username' => array(
            'type'        => 'text',
1269
            'class'       => 'fullwidth',
1270 1271 1272 1273 1274 1275 1276 1277
            'title'       => get_string('username') . ':',
            'defaultvalue' => (isset($_POST['login_username'])) ? $_POST['login_username'] : '',
            'rules' => array(
                'required'    => true
            )
        ),
        'login_password' => array(
            'type'        => 'password',
1278
            'class'       => 'fullwidth',
1279 1280 1281 1282 1283 1284 1285 1286
            'title'       => get_string('password') . ':',
            'defaultvalue'       => '',
            'rules' => array(
                'required'    => true
            )
        ),
        'submit' => array(
            'type'  => 'submit',
1287
            'class' => 'btn-primary btn-block',
1288 1289 1290 1291
            'value' => get_string('login')
        ),
        'register' => array(
            'type' => 'markup',
Pat Kira's avatar
Pat Kira committed
1292 1293
            'value' => '<div id="login-helplinks" class="login-related-links">' . $registerlink
                . '<a class="forgotpass-link text-small" href="' . get_config('wwwroot') . 'forgotpass.php">' . get_string('lostusernamepassword') . '</a></div>'
1294 1295 1296 1297 1298
        ),
    );
    $elements = array(
        'login' => array(
            'type' => 'container',
1299 1300
            'class' => 'login form-condensed',
            'isformgroup' => false,
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
            'elements' => $elements
        )
    );


    // Get any extra elements from the enabled auth plugins
    $extraelements = array();
    $showbasicform = false;
    $authplugins = auth_get_enabled_auth_plugins();
    foreach ($authplugins as $plugin) {
        $classname = 'PluginAuth' . ucfirst(strtolower($plugin));
        $pluginelements = call_static_method($classname, 'login_form_elements');
        if (!empty($pluginelements)) {
            $extraelements = array_merge($extraelements, $pluginelements);
        }
        if (call_static_method($classname, 'need_basic_login_form')) {
            $showbasicform = true;
        }
    }
    if (!empty($extraelements) && $showbasicform) {
        $loginlabel = array(
            'type' => 'markup',
1323
            'value' => '<p><a name="sso" />' . get_string('orloginvia') . '</p>'
1324 1325
        );
        $extraelements = array_merge(array('label' => $loginlabel), $extraelements);
1326 1327 1328 1329
        $keys = array_keys($extraelements);
        if (!empty($keys)) {
            $key = $keys[count($keys) - 1];
        }
1330 1331 1332 1333 1334
    }
    if (count($extraelements)) {
        $extraelements = array(
            'login_extra' => array(
                'type' => 'container',
1335 1336
                'class' => 'login_extra panel-footer text-small',
                'isformgroup' => false,
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349
                'elements' => $extraelements
            )
        );
    }
    // Replace or supplement the standard login form elements
    if ($showbasicform) {
        $elements = array_merge($elements, $extraelements);
    }
    else {
        $elements = $extraelements;
    }
    return $elements;
}
1350 1351 1352 1353 1354
/**
 * 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.
 *
1355 1356
 * @param string  $form A rendered login form
 * @return string The form with extra javascript added for cookie detection
1357 1358 1359
 * @private
 */
function get_login_form_js($form) {
1360
    $form = json_encode($form);
1361
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
1362
    $cookiename = get_config('cookieprefix') . 'ctest';
1363
    $js = <<< EOF
1364
<script type="application/javascript">
1365
var loginbox = $('loginform_container');
1366
document.cookie = "$cookiename=1";
1367
if (document.cookie) {
1368
    loginbox.innerHTML = $form;
1369
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
1370 1371
}
else {
1372
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
1373 1374 1375
}
</script>
EOF;
1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393

    $authplugins = auth_get_enabled_auth_plugins();
    foreach ($authplugins as $plugin) {
        $classname = 'PluginAuth' . ucfirst(strtolower($plugin));
        $pluginjs = call_static_method($classname, 'login_form_js');
        if (!empty($pluginjs)) {
            $js .= $pluginjs;
        }
    }

    return $js;
}

/**
 * Return a list of all enabled and usable auth plugins.
 */
function auth_get_enabled_auth_plugins() {

1394 1395 1396 1397 1398
    static $cached_plugins = null;
    if ($cached_plugins !== null) {
        return $cached_plugins;
    }

1399 1400 1401 1402 1403 1404 1405 1406 1407 1408
    $sql = 'SELECT
                DISTINCT(authname)
            FROM
                {auth_instance} ai
            JOIN
                {institution} i ON ai.institution = i.name
            JOIN
                {auth_installed} inst ON inst.name = ai.authname
            WHERE
                i.suspended = 0 AND
1409 1410
                inst.active = 1
            ORDER BY authname';
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421
    $authplugins = get_column_sql($sql);

    $usableplugins = array();
    foreach ($authplugins as $plugin) {
        safe_require('auth', strtolower($plugin));
        $classname = 'PluginAuth' . ucfirst(strtolower($plugin));
        if (call_static_method($classname, 'is_usable')) {
            $usableplugins[] = $plugin;
        }
    }

1422 1423
    $cached_plugins = $usableplugins;
    return $cached_plugins;
1424
}
1425

1426 1427 1428 1429 1430 1431 1432 1433 1434

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

    static $authcache = array();

    /**
1435 1436
     * Take an instanceid and create an auth object for that instance.
     *
1437
     * @param  int      $id     The id of the auth instance
1438
     * @return Auth            An intialised auth object or false, if the
1439 1440 1441
     *                          instance doesn't exist (Should never happen)
     */
    public static function create($id) {
1442 1443 1444
        if (is_object($id) && isset($id->id)) {
            $id = $id->id;
        }
1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462

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

1463 1464 1465 1466 1467 1468 1469 1470
/**
 * Called when the login form is being validated during submission.
 * Checks the user and password fields are filled in.
 *
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
 */
function login_validate(Pieform $form, $values) {
1471
    if (!empty($values['login_submitted'])) {
1472 1473 1474 1475 1476 1477
        if (empty($values['login_username']) || empty($values['login_password'])) {
            $form->set_error(null, get_string('loginfailed'));
        }
    }
}

1478
/**
1479
 * Called when the login form is submitted. Validates the user and password, and
1480
 * if they are valid, starts a new session for the user.
1481
 *
1482 1483
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
1484
 * @access private
1485
 */
1486
function login_submit(Pieform $form, $values) {
1487 1488
    global $SESSION, $USER;

1489
    $username      = trim($values['login_username']);
1490 1491
    $password      = $values['login_password'];
    $authenticated = false;
1492