lib.php 100 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
393
394
        return;
    }

    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
395
    $sessionlogouttime = $USER->get('logout_time');
396
397
398
399
400
401
402

    // 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))) {
403
404
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
405
406
407
408
409
410
411
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
412

Richard Mansfield's avatar
Richard Mansfield committed
413
414
415
416
        if (function_exists('local_logout')) {
            local_logout();
        }

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

        $authinstance = $SESSION->get('authinstance');
453
454
455
456
457
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);

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

463
464
            $authobj->logout();
            $USER->logout();
465

466
467
468
469
470
471
472
            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");
473
474
        }

475
        if (defined('JSON')) {
476
            json_reply('global', get_string('sessiontimedoutreload'), 1);
477
        }
478
479
        if (defined('IFRAME')) {
            header('Content-type: text/html');
480
            print_auth_frame();
481
482
            exit;
        }
483

484
485
486
487
488
489
        // 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
490
491
492
493
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
494
495
496
            return;
        }

497
        auth_draw_login_page(get_string('sessiontimedout'));
498
499
500
    }
    else {
        // There is no session, so we check to see if one needs to be started.
501
        // Build login form. If the form is submitted it will be handled here,
502
503
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
504
505
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
506
        $SESSION->loginform = $form;
507
508
        if ($USER->is_logged_in()) {
            return;
509
        }
Aaron Wells's avatar
Aaron Wells committed
510

511
        // Check if the page is public or the site is configured to be public.
512
        if (defined('PUBLIC') && !isset($_GET['login'])) {
513
514
515
            if ($lang = param_alphanumext('lang', null)) {
                $SESSION->set('lang', $lang);
            }
516
            return;
517
        }
518
519
520
521
522

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

524
        auth_draw_login_page(null, $form);
525
        exit;
526
527
528
    }
}

529
/**
Aaron Wells's avatar
Aaron Wells committed
530
 *
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 * 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,
547
548
            i.instancename,
            i.authname
Aaron Wells's avatar
Aaron Wells committed
549
        FROM
550
551
            {institution} inst,
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
552
        WHERE
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
            i.institution = inst.name
        ORDER BY
            inst.displayname,
            i.instancename';

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

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

    return $cache;
}


568
/**
Aaron Wells's avatar
Aaron Wells committed
569
 *
570
571
572
573
574
575
576
577
578
579
580
581
582
 * 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,
583
584
            i.instancename,
            i.authname
Aaron Wells's avatar
Aaron Wells committed
585
        FROM
586
587
            {institution} inst,
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
588
        WHERE
589
590
591
592
593
594
595
596
            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());
}
597
598


599
/**
Aaron Wells's avatar
Aaron Wells committed
600
 * Given an institution, returns the authentication methods used by it, sorted
601
 * by priority.
602
 *
603
604
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
605
 */
606
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
607
    static $cache = array();
608

609
    if (null == $institution) {
610
611
612
        return array();
    }

613
    if (!isset($cache[$institution])) {
614
615
616
617
618
619
620
621
622
623
624
        // 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,
625
626
                a.requires_config,
                a.requires_parent
Aaron Wells's avatar
Aaron Wells committed
627
            FROM
628
629
                {auth_instance} i,
                {auth_installed} a
Aaron Wells's avatar
Aaron Wells committed
630
            WHERE
631
632
633
634
635
636
637
638
                a.name = i.authname AND
                i.institution = '. db_quote($institution).'
            ORDER BY
                i.priority,
                i.instancename';

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

639
        if (empty($cache[$institution])) {
640
641
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
642
    }
643
644

    return $cache[$institution];
645
646
}

647
648
/**
 * Given a wwwroot, find any auth instances that can come from that host
Aaron Wells's avatar
Aaron Wells committed
649
 *
650
651
652
 * @param   string  wwwroot of the host that is connecting to us
 * @return  array   array of record objects
 */
653
654
function auth_get_auth_instances_for_wwwroot($wwwroot) {
    $query = "  SELECT
655
656
657
658
659
                    ai.id,
                    ai.authname,
                    i.id as institutionid,
                    i.displayname,
                    i.suspended
660
                FROM
661
662
663
664
665
666
                    {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
667
                WHERE
668
                    aic.value = ?";
669
670
671
672

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

673
/**
Aaron Wells's avatar
Aaron Wells committed
674
 * Given an institution, get all the auth types EXCEPT those that are already
675
676
677
678
679
 * enabled AND do not require configuration.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
680
function auth_get_available_auth_types($institution=null) {
681

682
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
683
684
685
686
687
688
689
690
        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
691
        FROM
692
            {auth_installed} a
Aaron Wells's avatar
Aaron Wells committed
693
        LEFT JOIN
694
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
695
        ON
696
697
698
699
700
701
702
            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
703
            a.name';
704

705
706
707
708
709
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
710
711
712
713
714

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

715
716
717
718
719
720
721
722
723
724
    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);
        }
    }
725
    usort($result, create_function('$a, $b', 'if ($a->is_usable != $b->is_usable) return $b->is_usable; return strnatcasecmp($a->title, $b->title);'));
726

727
728
    return $result;
}
729
730
/**
 * Checks that all the required fields are set, and handles setting them if required.
731
732
733
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
734
735
 */
function auth_check_required_fields() {
736
737
    global $USER, $SESSION;

738
739
740
741
    if (defined('NOCHECKREQUIREDFIELDS')) {
        return;
    }

742
743
744
745
746
747
748
749
750
751
    $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;
    }
752

753
754
755
756
757
758
    // Check if the user wants to log in anyway
    if ($USER->get('passwordchange') && $USER->get('parentuser') && isset($_GET['loginanyway'])) {
        $USER->loginanyway = true;
        $changepassword = false;
    }

759
760
761
762
763
    // Do not force password change on JSON request.
    if (defined('JSON') && JSON == true) {
        $changepassword = false;
    }

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
801
802
803
804
805
806
807
808
809
810
811
812
    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')) {
813
814
815
816
        // Don't need to check this for json requests
        return;
    }

817
818
819
    safe_require('artefact', 'internal');
    require_once('pieforms/pieform.php');

820
    $alwaysmandatoryfields = array_keys(ArtefactTypeProfile::get_always_mandatory_fields());
821
    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
Aaron Wells's avatar
Aaron Wells committed
822
823
        // 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
824
825
826
827
828
        // the session.
        if (in_array($field, $alwaysmandatoryfields) && $USER->get($field) != null) {
            continue;
        }
        // Not cached? Get value the standard way.
829
        if (get_profile_field($USER->get('id'), $field) != null) {
830
831
832
            continue;
        }

833
        if ($field == 'email') {
834
835
836
837
            if (isset($elements['email'])) {
                continue;
            }
            // Use a text field for their first e-mail address, not the
838
839
840
841
            // emaillist element
            $type = 'text';
        }

842
843
844
845
846
847
        $elements[$field] = array(
            'type'  => $type,
            'title' => get_string($field, 'artefact.internal'),
            'rules' => array('required' => true)
        );

848
849
850
851
852
853
854
855
856
        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,
            );
        }

857
858
859
860
861
862
863
864
865
866
867
        // @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();
868
            $elements[$field]['defaultvalue'] = get_config('country');
869
        }
870
871

        if ($field == 'email') {
872
873
874
875
876
877
878
879
880
881
882
            // 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');
            }
883
        }
884
885
886
887
888
889
    }

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

890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
    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')
        );
908

909
910
911
912
        $form = pieform(array(
            'name'     => 'requiredfields',
            'method'   => 'post',
            'action'   => '',
913
914
915
            'elements' => $elements,
            'dieaftersubmit' => FALSE,
            'backoutaftersubmit' => TRUE,
916
917
        ));
    }
918

919
920
921
922
923
    // Has the form been successfully submitted? Back out and let the requested URL continue.
    if ($form === FALSE) {
        return;
    }

924
    $smarty = smarty();
925
926
927
    if ($USER->get('parentuser')) {
        $smarty->assign('loginasoverridepasswordchange',
            get_string('loginasoverridepasswordchange', 'admin',
928
                       '<a class="btn" href="' . get_config('wwwroot') . '?loginanyway">', '</a>'));
929
930
    }
    $smarty->assign('changepassword', $changepassword);
931
    $smarty->assign('changeusername', $SESSION->get('resetusername'));
932
933
934
935
936
    $smarty->assign('form', $form);
    $smarty->display('requiredfields.tpl');
    exit;
}

937
function requiredfields_validate(Pieform $form, $values) {
Nigel McNie's avatar
Nigel McNie committed
938
    global $USER;
939
    if (isset($values['password1'])) {
940

941
942
943
        // Get the authentication type for the user, and
        // use the information to validate the password
        $authobj = AuthFactory::create($USER->authinstance);
944

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

948
949
950
951
952
953
        // 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'));
            }
954
        }
955
956
957
        // propagate error up as the collective error AuthUnknownUserException
         catch  (AuthInstanceException $e) {
            $form->set_error('password1', $e->getMessage());
958
        }
959
960
961
962
963

        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'));
            }
964
            if (!$form->get_error('username') && record_exists_select('usr', 'LOWER(username) = ?', array(strtolower($values['username'])))) {
965
966
                $form->set_error('username', get_string('usernamealreadytaken', 'auth.internal'));
            }
967
968
        }
    }
969
970
971
972
    // 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'));
    }
973
974
975
976
    // 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'));
    }
977
978
}

979
function requiredfields_submit(Pieform $form, $values) {
980
    global $USER, $SESSION;
981

982
983
984
985
986
987
988
989
990
    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 {
991
            throw new SystemException('Attempt by "' . $USER->get('username') . '@'
992
993
994
                . $USER->get('institution') . 'to change their password failed');
        }
    }
Nigel McNie's avatar
Nigel McNie committed
995

996
997
998
999
1000
1001
1002
1003
1004
    if (isset($values['username'])) {
        $SESSION->set('resetusername', false);
        if ($values['username'] != $USER->get('username')) {
            $USER->username = $values['username'];
            $USER->commit();
            $otherfield = true;
        }
    }

1005
1006
1007
1008
1009
1010
    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;
    }

1011
    foreach ($values as $field => $value) {
1012
1013
1014
        if (in_array($field, array('submit', 'sesskey', 'password1', 'password2', 'username',
                                   'socialprofile_service', 'socialprofile_profiletype',
                                   'socialprofile_profileurl', 'socialprofile_hidden'))) {
1015
1016
1017
            continue;
        }
        if ($field == 'email') {
1018
            $email = $values['email'];
1019
            // Need to update the admin email on installation
1020
            if ($USER->get('admin')) {
1021
1022
1023
1024
1025
                $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')));
1026
                    update_record('artefact', array('title' => $email), array('owner' => $USER->get('id'), 'artefacttype' => 'email'));
1027
1028
                }
            }
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
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
            // 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;
1074
        }
1075
    }
Nigel McNie's avatar
Nigel McNie committed
1076

1077
1078
1079
1080
    if (isset($otherfield)) {
        $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    }

1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
    // 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();
        }
    }

1093
1094
1095
1096
    if ($form->get_property('backoutaftersubmit')) {
        return;
    }

1097
    redirect();
1098
1099
}

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

    }

1134
1135
1136
1137
1138
1139
1140
    $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);
    }

1141
1142
    if ($message) {
        $SESSION->add_info_msg($message);
1143
    }
1144
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false, 'sidebars' => false));
1145
    $smarty->assign('login_form', $loginform);
1146
    $smarty->assign('PAGEHEADING', get_string('loginto', 'mahara', get_config('sitename')));
1147
    $smarty->assign('LOGINPAGE', true);
1148
1149
1150
    $smarty->display('login.tpl');
    exit;
}
1151

1152
/**
1153
 * Returns the definition of the login form, for display on the transient login page.
1154
 *
Nigel McNie's avatar
Nigel McNie committed
1155
1156
 * @return array   The login form definition array.
 * @access private
1157
1158
 */
function auth_get_login_form() {
1159
    $elements = auth_get_login_form_elements();
1160

1161
1162
1163
1164
    $elements['login']['elements']['login_submitted'] = array(
        'type'  => 'hidden',
        'value' => 1
    );
1165

1166
    // Change login redirection for clean urls
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
    $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)) {
1177
            $getarr = explode('&', $getpart);
1178
1179
            if ($getarr) {
                foreach ($getarr as $data) {
1180
                    $arr = explode('=', $data);
1181
1182
1183
1184
1185
1186
1187
1188
                    $get[$arr[0]] = isset($arr[1]) ? $arr[1] : null;
                }
            }
        }
    }
    else {
        $get = $_GET;
    }
1189
1190
    // 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
1191
    // afterwards.
1192
    $action = '';
1193
1194
    if ($get) {
        if (isset($get['logout'])) {
1195
1196
1197
1198
            // 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.
1199
            $action = hsc(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?')));
1200
1201
        }
        else {
1202
            $action .= '?';
1203
            foreach ($get as $key => $value) {
Ruslan Kabalin's avatar
Ruslan Kabalin committed
1204
                if ($key != 'login') {
1205
                    $action .= hsc($key) . '=' . hsc($value) . '&';
1206
1207
                }
            }
1208
            $action = substr($action, 0, -1);
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
        }
    }
    if ($_POST) {
        foreach ($_POST as $key => $value) {
            if (!isset($elements[$key]) && !isset($elements['login']['elements'][$key])) {
                $elements[$key] = array(
                    'type'  => 'hidden',
                    'value' => $value
                );
            }
        }
    }