lib.php 94.7 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('session.php');
15
require(get_config('docroot') . 'auth/user.php');
16
require_once(get_config('docroot') . '/lib/htmloutput.php');
17

Nigel McNie's avatar
Nigel McNie committed
18 19 20
/**
 * Unknown user exception
 */
21
class AuthUnknownUserException extends UserException {}
22

23
/**
Aaron Wells's avatar
Aaron Wells committed
24
 * An instance of an auth plugin failed during execution
25 26 27 28 29 30
 * 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
 */
31 32 33 34 35 36 37
class AuthInstanceException extends UserException {

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

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

45 46 47 48 49 50 51 52 53 54 55 56 57 58
/**
 * 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:"));
    }
}

59 60 61
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
62 63 64 65 66 67
 *
 * @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
68 69 70
 */
abstract class Auth {

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

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

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

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

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

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

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

248 249 250 251 252 253 254 255 256
    /**
     * 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;
    }

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

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

293 294 295 296 297 298 299 300 301 302 303 304
    /**
     * 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() {
    }

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

328 329 330 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
    /**
     * 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();
    }
357 358 359
}


360 361 362 363
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

364
/**
Aaron Wells's avatar
Aaron Wells committed
365
 * Handles authentication by setting up a session for a user if they are logged
366
 * in.
367 368 369 370 371 372 373 374
 *
 * 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
375 376 377 378 379 380 381
 *
 * 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.
 *
382 383
 */
function auth_setup () {
384
    global $SESSION, $USER;
385 386 387 388

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

393
    // Lock the site until core upgrades are done
David Mudrak's avatar
David Mudrak committed
394
    require(get_config('libroot') . 'version.php');
395
    $siteclosed    = $config->version > get_config('version');
396 397 398 399 400 401 402
    $disablelogin  = $config->disablelogin;

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

403
    $cfgsiteclosed = get_config('siteclosed');
404 405 406 407 408
    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);
409
        }
410 411
        set_config('siteclosed', $siteclosed);
        set_config('disablelogin', $disablelogin);
412
    }
413

414 415
    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
416
    $sessionlogouttime = $USER->get('logout_time');
417 418 419 420 421 422 423

    // 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');
    if (($sessionlogouttime && isset($_GET['logout'])) || ($sessionexists === false && $USER->get('sessionid') != '' && empty($parentuser))) {
424 425
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
426 427 428 429 430 431 432
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
433

Richard Mansfield's avatar
Richard Mansfield committed
434 435 436 437
        if (function_exists('local_logout')) {
            local_logout();
        }

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

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

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

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

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

496
        if (defined('JSON')) {
497
            json_reply('global', get_string('sessiontimedoutreload'), 1);
498
        }
499 500
        if (defined('IFRAME')) {
            header('Content-type: text/html');
501
            print_auth_frame();
502 503
            exit;
        }
504

505 506 507 508 509 510
        // 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
511 512 513 514
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
515 516 517
            return;
        }

518
        auth_draw_login_page(get_string('sessiontimedout'));
519 520 521
    }
    else {
        // There is no session, so we check to see if one needs to be started.
522
        // Build login form. If the form is submitted it will be handled here,
523 524
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
525 526
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
527
        $SESSION->loginform = $form;
528 529
        if ($USER->is_logged_in()) {
            return;
530
        }
Aaron Wells's avatar
Aaron Wells committed
531

532
        // Check if the page is public or the site is configured to be public.
533
        if (defined('PUBLIC') && !isset($_GET['login'])) {
534 535 536
            if ($lang = param_alphanumext('lang', null)) {
                $SESSION->set('lang', $lang);
            }
537
            return;
538
        }
539 540 541 542 543

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
Aaron Wells's avatar
Aaron Wells committed
544

545
        auth_draw_login_page(null, $form);
546
        exit;
547 548 549
    }
}

550
/**
Aaron Wells's avatar
Aaron Wells committed
551
 *
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
 * 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,
568 569
            i.instancename,
            i.authname
Aaron Wells's avatar
Aaron Wells committed
570
        FROM
571 572
            {institution} inst,
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
573
        WHERE
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
            i.institution = inst.name
        ORDER BY
            inst.displayname,
            i.instancename';

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

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

    return $cache;
}


589
/**
Aaron Wells's avatar
Aaron Wells committed
590
 *
591 592 593 594 595 596 597 598 599 600 601 602 603
 * 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,
604 605
            i.instancename,
            i.authname
Aaron Wells's avatar
Aaron Wells committed
606
        FROM
607 608
            {institution} inst,
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
609
        WHERE
610 611 612 613 614 615 616 617
            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());
}
618 619


620
/**
Aaron Wells's avatar
Aaron Wells committed
621
 * Given an institution, returns the authentication methods used by it, sorted
622
 * by priority.
623
 *
624 625
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
626
 */
627
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
628
    static $cache = array();
629

630
    if (null == $institution) {
631 632 633
        return array();
    }

634
    if (!isset($cache[$institution])) {
635 636 637 638 639 640 641 642 643 644 645
        // 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,
646 647
                a.requires_config,
                a.requires_parent
Aaron Wells's avatar
Aaron Wells committed
648
            FROM
649 650
                {auth_instance} i,
                {auth_installed} a
Aaron Wells's avatar
Aaron Wells committed
651
            WHERE
652 653 654 655 656 657 658 659
                a.name = i.authname AND
                i.institution = '. db_quote($institution).'
            ORDER BY
                i.priority,
                i.instancename';

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

660
        if (empty($cache[$institution])) {
661 662
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
663
    }
664 665

    return $cache[$institution];
666 667
}

668 669
/**
 * Given a wwwroot, find any auth instances that can come from that host
Aaron Wells's avatar
Aaron Wells committed
670
 *
671 672 673
 * @param   string  wwwroot of the host that is connecting to us
 * @return  array   array of record objects
 */
674 675
function auth_get_auth_instances_for_wwwroot($wwwroot) {
    $query = "  SELECT
676 677 678 679 680
                    ai.id,
                    ai.authname,
                    i.id as institutionid,
                    i.displayname,
                    i.suspended
681
                FROM
682 683 684 685 686 687
                    {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
688
                WHERE
689
                    aic.value = ?";
690 691 692 693

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

694
/**
Aaron Wells's avatar
Aaron Wells committed
695
 * Given an institution, get all the auth types EXCEPT those that are already
696 697 698 699 700
 * enabled AND do not require configuration.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
701
function auth_get_available_auth_types($institution=null) {
702

703
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
704 705 706 707 708 709 710 711
        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
Aaron Wells's avatar
Aaron Wells committed
712
        FROM
713
            {auth_installed} a
Aaron Wells's avatar
Aaron Wells committed
714
        LEFT JOIN
715
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
716
        ON
717 718 719 720 721 722 723
            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
Aaron Wells's avatar
Aaron Wells committed
724
            a.name';
725

726 727 728 729 730
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
731 732 733 734 735

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

736 737 738 739 740 741 742 743 744 745
    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);
        }
    }
746
    usort($result, create_function('$a, $b', 'if ($a->is_usable != $b->is_usable) return $b->is_usable; return strnatcasecmp($a->title, $b->title);'));
747

748 749
    return $result;
}
750 751
/**
 * Checks that all the required fields are set, and handles setting them if required.
752 753 754
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
755 756
 */
function auth_check_required_fields() {
757 758
    global $USER, $SESSION;

759 760 761 762
    if (defined('NOCHECKREQUIREDFIELDS')) {
        return;
    }

763 764 765 766 767 768 769 770 771 772
    $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;
    }
773

774 775 776 777 778 779
    // Check if the user wants to log in anyway
    if ($USER->get('passwordchange') && $USER->get('parentuser') && isset($_GET['loginanyway'])) {
        $USER->loginanyway = true;
        $changepassword = false;
    }

780 781 782 783 784
    // Do not force password change on JSON request.
    if (defined('JSON') && JSON == true) {
        $changepassword = false;
    }

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 822 823 824 825 826 827 828 829 830 831 832 833
    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')) {
834 835 836 837
        // Don't need to check this for json requests
        return;
    }

838 839 840
    safe_require('artefact', 'internal');
    require_once('pieforms/pieform.php');

841
    $alwaysmandatoryfields = array_keys(ArtefactTypeProfile::get_always_mandatory_fields());
842
    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
Aaron Wells's avatar
Aaron Wells committed
843 844
        // 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
845 846 847 848 849
        // the session.
        if (in_array($field, $alwaysmandatoryfields) && $USER->get($field) != null) {
            continue;
        }
        // Not cached? Get value the standard way.
850
        if (get_profile_field($USER->get('id'), $field) != null) {
851 852 853
            continue;
        }

854
        if ($field == 'email') {
855 856 857 858
            if (isset($elements['email'])) {
                continue;
            }
            // Use a text field for their first e-mail address, not the
859 860 861 862
            // emaillist element
            $type = 'text';
        }

863 864 865 866 867 868
        $elements[$field] = array(
            'type'  => $type,
            'title' => get_string($field, 'artefact.internal'),
            'rules' => array('required' => true)
        );

869 870 871 872 873 874 875 876 877
        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,
            );
        }

878 879 880 881 882 883 884 885 886 887 888
        // @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();
889
            $elements[$field]['defaultvalue'] = get_config('country');
890
        }
891 892

        if ($field == 'email') {
893 894 895 896 897 898 899 900 901 902 903
            // 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');
            }
904
        }
905 906 907 908 909 910
    }

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

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
    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',
            'value' => get_string('submit')
        );
929

930 931 932 933 934 935 936
        $form = pieform(array(
            'name'     => 'requiredfields',
            'method'   => 'post',
            'action'   => '',
            'elements' => $elements
        ));
    }
937 938

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

951
function requiredfields_validate(Pieform $form, $values) {
Nigel McNie's avatar
Nigel McNie committed
952
    global $USER;
953
    if (isset($values['password1'])) {
954

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

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

962 963 964 965 966 967
        // 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'));
            }
968
        }
969 970 971
        // propagate error up as the collective error AuthUnknownUserException
         catch  (AuthInstanceException $e) {
            $form->set_error('password1', $e->getMessage());
972
        }
973 974 975 976 977

        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'));
            }
978
            if (!$form->get_error('username') && record_exists_select('usr', 'LOWER(username) = ?', array(strtolower($values['username'])))) {
979 980
                $form->set_error('username', get_string('usernamealreadytaken', 'auth.internal'));
            }
981 982
        }
    }
983 984 985 986
    // Check if email has been taken
    if (isset($values['email']) && record_exists('artefact_internal_profile_email', 'email', $values['email'])) {
            $form->set_error('email', get_string('unvalidatedemailalreadytaken', 'artefact.internal'));
    }
987 988 989 990
    // 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'));
    }
991 992
}

993
function requiredfields_submit(Pieform $form, $values) {
994
    global $USER, $SESSION;
995

996 997 998 999 1000 1001 1002 1003 1004
    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 {
1005
            throw new SystemException('Attempt by "' . $USER->get('username') . '@'
1006 1007 1008
                . $USER->get('institution') . 'to change their password failed');
        }
    }
Nigel McNie's avatar
Nigel McNie committed
1009

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

1019 1020 1021 1022 1023 1024
    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;
    }

1025
    foreach ($values as $field => $value) {
1026 1027 1028
        if (in_array($field, array('submit', 'sesskey', 'password1', 'password2', 'username',
                                   'socialprofile_service', 'socialprofile_profiletype',
                                   'socialprofile_profileurl', 'socialprofile_hidden'))) {
1029 1030 1031
            continue;
        }
        if ($field == 'email') {
1032
            $email = $values['email'];
1033
            // Need to update the admin email on installation
1034
            if ($USER->get('admin')) {
1035 1036 1037 1038 1039 1040 1041
                $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')));
                }
            }
1042 1043 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
            // 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;
1087
        }
1088
    }
Nigel McNie's avatar
Nigel McNie committed
1089

1090 1091 1092 1093
    if (isset($otherfield)) {
        $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    }

1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105
    // 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();
        }
    }

1106
    redirect();
1107 1108
}

1109
/**
Nigel McNie's avatar
Nigel McNie committed
1110
 * Creates and displays the transient login page.
1111
 *
Nigel McNie's avatar
Nigel McNie committed
1112 1113 1114 1115
 * 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.
 *
1116 1117 1118
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
1119 1120 1121
 * @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
1122
 * @access private
1123
 */
1124
function auth_draw_login_page($message=null, Pieform $form=null) {
1125
    global $USER, $SESSION;
1126
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
1127
        $loginform = get_login_form_js($form->build());
1128 1129
    }
    else {
1130
        require_once('pieforms/pieform.php');
1131
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
1132 1133 1134 1135 1136
        /*
         * 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.
         */
1137
        if ($USER->is_logged_in()) {
1138 1139 1140 1141 1142
            return;
        }

    }

1143 1144 1145 1146 1147 1148 1149
    $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);
    }

1150 1151
    if ($message) {
        $SESSION->add_info_msg($message);
1152
    }
1153
    $smarty = smarty(array(), array(), ar