lib.php 83.1 KB
Newer Older
1 2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4 5
 * Copyright (C) 2006-2009 Catalyst IT Ltd and others; see:
 *                         http://wiki.mahara.org/Contributors
6
 *
Francois Marier's avatar
Francois Marier committed
7 8 9 10
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
11
 *
Francois Marier's avatar
Francois Marier committed
12 13 14 15
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
16
 *
Francois Marier's avatar
Francois Marier committed
17 18
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
19 20
 *
 * @package    mahara
Nigel McNie's avatar
Nigel McNie committed
21
 * @subpackage auth
22
 * @author     Catalyst IT Ltd
23
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
24
 * @copyright  (C) 2006-2009 Catalyst IT Ltd http://catalyst.net.nz
25 26 27 28 29
 *
 */

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

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

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

39 40 41 42 43 44 45 46
/**
 * An instance of an auth plugin failed during execution 
 * 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
 */
47 48 49 50 51 52 53
class AuthInstanceException extends UserException {

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

55 56 57 58 59 60
/**
 * We tried to call a method on an auth plugin that hasn't been init'ed 
 * successfully
 */
class UninitialisedAuthException extends SystemException {}

61 62 63 64 65 66 67 68 69 70 71 72 73 74
/**
 * 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:"));
    }
}

75 76 77
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
78 79 80 81 82 83
 *
 * @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
84 85 86
 */
abstract class Auth {

87 88 89 90 91 92
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
93
    protected $has_instance_config;
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132
    protected $type;
    protected $ready;

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

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

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

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

        // Return now if the plugin type doesn't require any config 
        // (e.g. internal)
133
        if ($this->has_instance_config == false) {
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
            return true;
        }

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

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

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

        return true;
    }

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

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }
163 164
        if (isset($this->config[$name])) {
            return $this->config[$name];
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213
        }
        return null;
    }

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

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

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

214
    /**
215
     * Given a username and password, attempts to log the user in.
216
     *
217
     * @param object $user      An object with username member (at least)
218 219 220 221 222
     * @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
     */
223 224 225 226
    public function authenticate_user_account($user, $password) {
        $this->must_be_ready();
        return false;
    }
227

228 229 230 231 232 233
    /**
     * 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
     */
234 235
    public function user_exists($username) {
        $this->must_be_ready();
236
        if (record_exists_select('usr', 'LOWER(username) = ?', array(strtolower($username)))) {
237 238 239 240
            return true;
        }
        throw new AuthUnknownUserException("\"$username\" is not known to Auth");
    }
241

242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
    /**
     * Returns whether the authentication instance can automatically create a 
     * user record.
     *
     * Auto creating users means that the authentication plugin can say that 
     * users who don't exist yet in Mahara's usr table are allowed, and Mahara
     * should create a user account for them. Example: the first time a user logs
     * in, when authenticating against an ldap store or similar).
     *
     * However, if a plugin says a user can be authenticated, then it must 
     * implement the get_user_info() method which will be called to find out 
     * information about the user so a record in the usr table _can_ be created 
     * for the new user.
     *
     * Authentication methods must implement this method. Some may choose to 
     * implement it by returning an instance config value that the admin user 
     * can set.
     *
     * @return bool
     */
    public abstract function can_auto_create_users();

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

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

300 301 302 303 304 305 306 307 308 309 310 311
    /**
     * 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() {
    }

312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    /**
     * Called when a user is being logged out, either by clicking a logout 
     * link, their session timing out or some other method where their session 
     * is explicitly being ended with no more processing to take place on this 
     * page load.
     *
     * You can use $USER->logout() to log a user out but continue page 
     * processing if necessary. register.php is an example of such a place 
     * where this happens.
     *
     * If you define this hook, you can call $USER->logout() in it if you need 
     * to before redirecting. Otherwise, it will be called for you once your 
     * hook has run.
     *
     * If you do not explicitly redirect yourself, once this hook is finished 
     * the user will be redirected to the homepage with a message saying they 
     * have been logged out successfully.
     *
     * This method has no parameters and needs no return value
     */
    public function logout() {
    }

335 336 337
}


338 339 340 341
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

342
/**
343 344
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
345 346 347 348 349 350 351 352
 *
 * 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
353 354 355 356 357 358 359
 *
 * 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.
 *
360 361
 */
function auth_setup () {
362
    global $SESSION, $USER;
363 364 365 366

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

371
    // Lock the site until core upgrades are done
David Mudrak's avatar
David Mudrak committed
372
    require(get_config('libroot') . 'version.php');
373
    $siteclosed    = $config->version > get_config('version');
374 375 376 377 378 379 380
    $disablelogin  = $config->disablelogin;

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

381
    $cfgsiteclosed = get_config('siteclosed');
382 383 384 385 386
    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);
387
        }
388 389
        set_config('siteclosed', $siteclosed);
        set_config('disablelogin', $disablelogin);
390
    }
391

392 393
    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
394
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
395
    if ($sessionlogouttime && isset($_GET['logout'])) {
396 397
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
398 399 400 401 402 403 404
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
405

Richard Mansfield's avatar
Richard Mansfield committed
406 407 408 409
        if (function_exists('local_logout')) {
            local_logout();
        }

410 411
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
412
        redirect();
Nigel McNie's avatar
Nigel McNie committed
413 414
    }
    if ($sessionlogouttime > time()) {
415
        // The session is still active, so continue it.
416 417
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
418 419 420 421
        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) {
422
                // The user has been made into an admin
423
                $USER->admin = 1;
424
            }
425
            else if ($USER->get('admin') && !$realuser->admin) {
426
                // The user's admin rights have been taken away
427
                $USER->admin = 0;
428
            }
429 430
            if (!$USER->get('staff') && $realuser->staff) {
                $USER->staff = 1;
431
            }
432 433
            else if ($USER->get('staff') && !$realuser->staff) {
                $USER->staff = 0;
434
            }
435 436 437
            // Reload institutional admin/staff permissions
            $USER->reset_institutions();
            auth_check_admin_section();
438
        }
439
        $USER->renew();
440
        auth_check_required_fields();
441 442 443
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
444 445

        $authinstance = $SESSION->get('authinstance');
446 447 448 449 450 451 452 453 454
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);

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

456 457
            $authobj->logout();
            $USER->logout();
458

459 460 461 462 463 464 465
            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");
466 467
        }

468
        if (defined('JSON')) {
469
            json_reply('global', get_string('sessiontimedoutreload'), 1);
470
        }
471 472
        if (defined('IFRAME')) {
            header('Content-type: text/html');
473
            print_auth_frame();
474 475
            exit;
        }
476

477 478 479 480 481 482
        // 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
483 484 485 486
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
487 488 489
            return;
        }

490
        auth_draw_login_page(get_string('sessiontimedout'));
491 492 493
    }
    else {
        // There is no session, so we check to see if one needs to be started.
494
        // Build login form. If the form is submitted it will be handled here,
495 496
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
497 498
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
499 500
        if ($USER->is_logged_in()) {
            return;
501 502 503
        }
        
        // Check if the page is public or the site is configured to be public.
504
        if (defined('PUBLIC') && !isset($_GET['login'])) {
505 506 507
            if ($lang = param_alphanumext('lang', null)) {
                $SESSION->set('lang', $lang);
            }
508
            return;
509
        }
510 511 512 513 514

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
515
        
516
        auth_draw_login_page(null, $form);
517
        exit;
518 519 520
    }
}

521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538
/**
 * 
 * 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,
539 540
            i.instancename,
            i.authname
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559
        FROM 
            {institution} inst,
            {auth_instance} i
        WHERE 
            i.institution = inst.name
        ORDER BY
            inst.displayname,
            i.instancename';

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

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

    return $cache;
}


560 561 562 563 564 565 566 567 568 569 570 571 572 573 574
/**
 * 
 * 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,
575 576
            i.instancename,
            i.authname
577 578 579 580 581 582 583 584 585 586 587 588
        FROM 
            {institution} inst,
            {auth_instance} i
        WHERE 
            i.institution = inst.name AND
            inst.name IN (' . join(',', array_map('db_quote',$institutions)) . ')
        ORDER BY
            inst.displayname,
            i.instancename';

    return get_records_sql_array($sql, array());
}
589 590


591
/**
592 593
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
594
 *
595 596
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
597
 */
598
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
599
    static $cache = array();
600

601
    if (null == $institution) {
602 603 604
        return array();
    }

605
    if (!isset($cache[$institution])) {
606 607 608 609 610 611 612 613 614 615 616
        // 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,
617 618
                a.requires_config,
                a.requires_parent
619
            FROM 
620 621
                {auth_instance} i,
                {auth_installed} a
622 623 624 625 626 627 628 629 630
            WHERE 
                a.name = i.authname AND
                i.institution = '. db_quote($institution).'
            ORDER BY
                i.priority,
                i.instancename';

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

631
        if (empty($cache[$institution])) {
632 633
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
634
    }
635 636

    return $cache[$institution];
637 638
}

639 640 641 642 643 644
/**
 * Given a wwwroot, find any auth instances that can come from that host
 * 
 * @param   string  wwwroot of the host that is connecting to us
 * @return  array   array of record objects
 */
645
function auth_get_auth_instances_for_wwwroot($wwwroot) {
646 647 648

    // TODO: we just need ai.id and ai.authname... rewrite query, or
    // just drop this function
649 650 651 652 653
    $query = "  SELECT
                    ai.*,
                    aic.*,
                    i.*
                FROM
654 655 656
                    {auth_instance} ai, 
                    {auth_instance_config} aic,
                    {institution} i
657 658 659 660 661 662 663 664 665
                WHERE
                    aic.field = 'wwwroot' AND
                    aic.value = ? AND
                    aic.instance = ai.id AND
                    i.name = ai.institution";

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

666 667 668 669 670 671 672
/**
 * Given an institution, get all the auth types EXCEPT those that are already 
 * enabled AND do not require configuration.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
673
function auth_get_available_auth_types($institution=null) {
674

675
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
676 677 678 679 680 681 682 683 684
        return array();
    }

    // TODO: work out why this won't accept a placeholder - had to use db_quote
    $sql ='
        SELECT DISTINCT
            a.name,
            a.requires_config
        FROM 
685
            {auth_installed} a
686
        LEFT JOIN 
687
            {auth_instance} i
688 689 690 691 692 693 694 695 696 697
        ON 
            a.name = i.authname AND
            i.institution = '. db_quote($institution).'
        WHERE
           (a.requires_config = 1 OR
            i.id IS NULL) AND
            a.active = 1
        ORDER BY
            a.name';          

698 699 700 701 702
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
703 704 705 706 707

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

708 709 710 711 712 713 714 715 716 717
    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);
        }
    }
718
    usort($result, create_function('$a, $b', 'if ($a->is_usable != $b->is_usable) return $b->is_usable; return strnatcasecmp($a->title, $b->title);'));
719

720 721
    return $result;
}
722 723
/**
 * Checks that all the required fields are set, and handles setting them if required.
724 725 726
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
727 728
 */
function auth_check_required_fields() {
729 730
    global $USER, $SESSION;

731 732 733 734
    if (defined('NOCHECKREQUIREDFIELDS')) {
        return;
    }

735 736 737 738 739 740 741 742 743 744
    $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;
    }
745

746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 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
    // Check if the user wants to log in anyway
    if ($USER->get('passwordchange') && $USER->get('parentuser') && isset($_GET['loginanyway'])) {
        $USER->loginanyway = true;
        $changepassword = false;
    }

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

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

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

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

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

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

            $elements['email'] = array(
                'type'   => 'text',
                'title'  => get_string('principalemailaddress', 'artefact.internal'),
                'ignore' => (trim($USER->get('email')) != '' && !preg_match('/@example\.org$/', $USER->get('email'))),
                'rules'  => array(
                    'required' => true,
                    'email'    => true,
                ),
            );
        }
    }
    else if (defined('JSON')) {
801 802 803 804
        // Don't need to check this for json requests
        return;
    }

805 806 807
    safe_require('artefact', 'internal');
    require_once('pieforms/pieform.php');

808
    $alwaysmandatoryfields = array_keys(ArtefactTypeProfile::get_always_mandatory_fields());
809
    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
810 811 812 813 814 815 816
        // Always mandatory fields are stored in the usr table, so are part of 
        // the user session object. We can save a query by grabbing them from 
        // the session.
        if (in_array($field, $alwaysmandatoryfields) && $USER->get($field) != null) {
            continue;
        }
        // Not cached? Get value the standard way.
817
        if (get_profile_field($USER->get('id'), $field) != null) {
818 819 820
            continue;
        }

821
        if ($field == 'email') {
822 823 824 825
            if (isset($elements['email'])) {
                continue;
            }
            // Use a text field for their first e-mail address, not the
826 827 828 829
            // emaillist element
            $type = 'text';
        }

830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846
        $elements[$field] = array(
            'type'  => $type,
            'title' => get_string($field, 'artefact.internal'),
            'rules' => array('required' => true)
        );

        // @todo ruthlessly stolen from artefact/internal/index.php, could be merged
        if ($type == 'wysiwyg') {
            $elements[$field]['rows'] = 10;
            $elements[$field]['cols'] = 60;
        }
        if ($type == 'textarea') {
            $elements[$field]['rows'] = 4;
            $elements[$field]['cols'] = 60;
        }
        if ($field == 'country') {
            $elements[$field]['options'] = getoptions_country();
847
            $elements[$field]['defaultvalue'] = get_config('country');
848
        }
849 850 851 852

        if ($field == 'email') {
            $elements[$field]['rules']['email'] = true;
        }
853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
    }

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

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

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

    $smarty = smarty();
872 873 874 875 876 877
    if ($USER->get('parentuser')) {
        $smarty->assign('loginasoverridepasswordchange',
            get_string('loginasoverridepasswordchange', 'admin',
                       '<a href="' . get_config('wwwroot') . '?loginanyway">', '</a>'));
    }
    $smarty->assign('changepassword', $changepassword);
878
    $smarty->assign('changeusername', $SESSION->get('resetusername'));
879 880 881 882 883
    $smarty->assign('form', $form);
    $smarty->display('requiredfields.tpl');
    exit;
}

884
function requiredfields_validate(Pieform $form, $values) {
Nigel McNie's avatar
Nigel McNie committed
885
    global $USER;
886 887
    if (!isset($values['password1'])) {
        return true;
888 889
    }

890
    // Get the authentication type for the user, and
891
    // use the information to validate the password
892
    $authobj = AuthFactory::create($USER->authinstance);
893

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

Nigel McNie's avatar
Nigel McNie committed
897
    // The password cannot be the same as the old one
898 899 900 901 902 903 904 905 906
    try {
        if (!$form->get_error('password1')
            && $authobj->authenticate_user_account($USER, $values['password1'])) {
            $form->set_error('password1', get_string('passwordnotchanged'));
        }
    }
    // propagate error up as the collective error AuthUnknownUserException
     catch  (AuthInstanceException $e) {
        $form->set_error('password1', $e->getMessage());
907
    }
908

909

910 911 912 913 914 915 916 917
    if ($authobj->authname == 'internal' && isset($values['username']) && $values['username'] != $USER->get('username')) {
        if (!AuthInternal::is_username_valid($values['username'])) {
            $form->set_error('username', get_string('usernameinvalidform', 'auth.internal'));
        }
        if (!$form->get_error('username') && record_exists_select('usr', 'LOWER(username) = ?', strtolower($values['username']))) {
            $form->set_error('username', get_string('usernamealreadytaken', 'auth.internal'));
        }
    }
918 919
}

920
function requiredfields_submit(Pieform $form, $values) {
921
    global $USER, $SESSION;
922

923 924 925 926 927 928 929 930 931
    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 {
932
            throw new SystemException('Attempt by "' . $USER->get('username') . '@'
933 934 935
                . $USER->get('institution') . 'to change their password failed');
        }
    }
Nigel McNie's avatar
Nigel McNie committed
936

937 938 939 940 941 942 943 944 945 946 947 948 949 950
    if (isset($values['username'])) {
        $SESSION->set('resetusername', false);
        if ($values['username'] != $USER->get('username')) {
            $USER->username = $values['username'];
            $USER->commit();
            $otherfield = true;
        }
    }

    foreach ($values as $field => $value) {
        if (in_array($field, array('submit', 'sesskey', 'password1', 'password2', 'username'))) {
            continue;
        }
        if ($field == 'email') {
951 952
            $USER->email = $values['email'];
            $USER->commit();
953
        }
954 955
        set_profile_field($USER->get('id'), $field, $value);
        $otherfield = true;
956
    }
Nigel McNie's avatar
Nigel McNie committed
957

958 959 960 961 962
    if (isset($otherfield)) {
        $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    }

    redirect();
963 964
}

965
/**
Nigel McNie's avatar
Nigel McNie committed
966
 * Creates and displays the transient login page.
967
 *
Nigel McNie's avatar
Nigel McNie committed
968 969 970 971
 * 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.
 *
972 973 974
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
975 976 977
 * @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
978
 * @access private
979
 */
980
function auth_draw_login_page($message=null, Pieform $form=null) {
981
    global $USER, $SESSION;
982
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
983
        $loginform = get_login_form_js($form->build());
984 985
    }
    else {
986
        require_once('pieforms/pieform.php');
987
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
988 989 990 991 992
        /*
         * 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.
         */
993
        if ($USER->is_logged_in()) {
994 995 996 997 998
            return;
        }

    }

999 1000 1001 1002 1003 1004 1005
    $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);
    }

1006 1007
    if ($message) {
        $SESSION->add_info_msg($message);
1008
    }
1009
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false, 'sidebars' => false));
1010
    $smarty->assign('login_form', $loginform);
1011
    $smarty->assign('PAGEHEADING', get_string('loginto', 'mahara', get_config('sitename')));
1012
    $smarty->assign('LOGINPAGE', true);
1013 1014 1015
    $smarty->display('login.tpl');
    exit;
}
1016

1017
/**
Nigel McNie's avatar
Nigel McNie committed
1018
 * Returns the definition of the login form.
1019
 *
Nigel McNie's avatar
Nigel McNie committed
1020 1021
 * @return array   The login form definition array.
 * @access private
1022 1023
 */
function auth_get_login_form() {
1024
    $elements = auth_get_login_form_elements();
1025

1026 1027 1028 1029
    $elements['login']['elements']['login_submitted'] = array(
        'type'  => 'hidden',
        'value' => 1
    );
1030

1031
    // Change login redirection for clean urls
1032 1033 1034 1035 1036 1037 1038 1039 1040 1041
    $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)) {
1042
            $getarr = explode('&', $getpart);
1043 1044
            if ($getarr) {
                foreach ($getarr as $data) {
1045
                    $arr = explode('=', $data);
1046 1047 1048 1049 1050 1051 1052 1053
                    $get[$arr[0]] = isset($arr[1]) ? $arr[1] : null;
                }
            }
        }
    }
    else {
        $get = $_GET;
    }
1054 1055
    // 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
1056
    // afterwards.
1057
    $action = '';
1058 1059
    if ($get) {
        if (isset($get['logout'])) {
1060 1061 1062 1063
            // 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.
1064
            $action = hsc(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?')));
1065 1066
        }
        else {
1067
            $action .= '?';
1068
            foreach ($get as $key => $value) {
Ruslan Kabalin's avatar
Ruslan Kabalin committed
1069
                if ($key != 'login') {
1070
                    $action .= hsc($key) . '=' . hsc($value) . '&';
1071 1072
                }
            }
1073
            $action = substr($action, 0, -1);
1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087
        }
    }
    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(
1088
        'name'           => 'login',
1089
        'renderer'       => 'div',
1090 1091 1092 1093 1094 1095 1096
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
1097 1098
    );

1099
    return $form;
1100 1101
}

1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
/**
 * 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)) {
        $registerlink = '<a href="' . get_config('wwwroot') . 'register.php" tabindex="2">' . get_string('register') . '</a><br>';
    }
    else {
        $registerlink = '';
    }

    $elements = array(
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'defaultvalue' => (isset($_POST['login_username'])) ? $_POST['login_username'] : '',
            'rules' => array(
                'required'    => true
            )
        ),
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
            'defaultvalue'       => '',
            'rules' => array(
                'required'    => true
            )
        ),
        'submit' => array(
            'type'  => 'submit',
            'value' => get_string('login')
        ),
        'register' => array(
            'type' => 'markup',
            'value' => '<div id="login-helplinks">' . $registerlink
                . '<a href="' . get_config('wwwroot') . 'forgotpass.php" tabindex="2">' . get_string('lostusernamepassword') . '</a></div>'
        ),
    );
    $elements = array(
        'login' => array(
            'type' => 'container',
            'class' => 'login',
            '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',
            'value' => '<label>'.get_string('orloginvia') . '</label>'
        );
        $extraelements = array_merge(array('label' => $loginlabel), $extraelements);
1175 1176 1177 1178 1179
        $keys = array_keys($extraelements);
        if (!empty($keys)) {
            $key = $keys[count($keys) - 1];
            $extraelements[$key]['value'] .= '<div class="cb"></div>';
        }
1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
    }
    if (count($extraelements)) {
        $extraelements = array(
            'login_extra' => array(
                'type' => 'container',
                'class' => 'login_extra',
                'elements' => $extraelements
            )
        );
    }
    // Replace or supplement the standard login form elements
    if ($showbasicform) {
        $elements = array_merge($elements, $extraelements);
    }
    else {
        $elements = $extraelements;
    }
    return $elements;
}
Nigel McNie's avatar
Nigel McNie committed
1199 1200 1201 1202 1203
/**
 * 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.
 *
1204 1205
 * @param string  $form A rendered login form
 * @return string The form with extra javascript added for cookie detection
Nigel McNie's avatar
Nigel McNie committed
1206 1207 1208
 * @private
 */
function get_login_form_js($form) {
1209
    $form = json_encode($form);
1210
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
1211
    $cookiename = get_config('cookieprefix') . 'ctest';
1212
    $js = <<< EOF
Nigel McNie's avatar
Nigel McNie committed
1213
<script type="text/javascript">
1214
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
1215
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
1216
if (document.cookie) {
1217
    loginbox.innerHTML = $form;
1218
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
1219 1220
}
else {
1221
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
Nigel McNie's avatar
Nigel McNie committed
1222 1223 1224
}
</script>
EOF;
1225 1226 1227 1228 1229 1230 1231 1232 1233 1234