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

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

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

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

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

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

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

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

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

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

62
63
64
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
65
66
67
68
69
70
 *
 * @todo for authentication:
 *   - inactivity: each institution has inactivity timeout times, this needs
 *     to be supported
 *     - this means the lastlogin field needs to be updated on the usr table
 *     - warnings are handled by cron
71
72
73
 */
abstract class Auth {

74
75
76
77
78
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
79
    protected $active;
80
    protected $config;
81
    protected $has_instance_config;
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
    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;
117
        $this->active       = (isset($instance->active) ? $instance->active : 1); // We need to check if column exists yet via upgrade and set a default if not
118
119
        $this->authname     = $instance->authname;

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

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }
152
153
        if (isset($this->config[$name])) {
            return $this->config[$name];
154
155
156
157
158
159
160
        }
        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
161
     *
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
     * @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
178
     *
179
     * @throws UninitialisedAuthException
Aaron Wells's avatar
Aaron Wells committed
180
     * @return bool
181
182
183
184
185
186
187
188
189
190
191
     */
    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
192
     *
193
194
195
196
197
198
199
200
201
202
     * @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'];
    }

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

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

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

253
254
255
256
257
258
259
260
261
    /**
     * 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;
    }

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

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

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

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

333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
    /**
     * 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();
    }
362
363
364
}


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

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

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

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

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

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

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

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

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

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

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

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

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

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

526
527
528
529
530
        // Allow auth plugins to try logging in the user.
        if (auth_plugins_call_pre_loginpage_hook()) {
            return;
        }

531
        // Check if the page is public or the site is configured to be public.
532
        if (defined('PUBLIC') && !param_exists('login')) {
533
            return;
534
        }
535
536
537
538
539

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

541
        auth_draw_login_page(null, $form);
542
        exit;
543
544
545
    }
}

546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
/**
 * Allow auth plugins a chance to authenticate or redirect as needed.
 *
 * It will call the 'pre_loginpage_hook' for each auth plugin available,
 * if any of them completes the login it returns immediately.
 *
 * Similar to: https://tracker.moodle.org/browse/MDL-48887
 *
 * @return bool If any plugin authenticated the user.
 */
function auth_plugins_call_pre_loginpage_hook() {
    global $USER;

    $methodname = 'pre_loginpage_hook';
    $instances = auth_get_auth_instances();

    foreach ($instances as $instance) {
        $auth = AuthFactory::create($instance->id);
        if ($auth === false) {
            continue;
        }
        if (!method_exists($auth, $methodname)) {
            continue;
        }
        $auth->$methodname();
        if ($USER->is_logged_in()) {
            return true;
        }
    }

    return false;
}

579
/**
Aaron Wells's avatar
Aaron Wells committed
580
 *
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 * 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,
597
            i.instancename,
598
599
            i.authname,
            i.active
Aaron Wells's avatar
Aaron Wells committed
600
        FROM
601
602
            {institution} inst,
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
603
        WHERE
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
            i.institution = inst.name
        ORDER BY
            inst.displayname,
            i.instancename';

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

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

    return $cache;
}


619
/**
Aaron Wells's avatar
Aaron Wells committed
620
 *
621
622
623
624
625
626
627
628
629
630
631
632
633
 * 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,
634
            i.instancename,
635
636
            i.authname,
            i.active
Aaron Wells's avatar
Aaron Wells committed
637
        FROM
638
639
            {institution} inst,
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
640
        WHERE
641
642
643
644
645
646
647
648
            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());
}
649
650


651
/**
Aaron Wells's avatar
Aaron Wells committed
652
 * Given an institution, returns the authentication methods used by it, sorted
653
 * by priority.
654
 *
655
656
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
657
 */
658
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
659
    static $cache = array();
660

661
    if (null == $institution) {
662
663
664
        return array();
    }

665
    if (!isset($cache[$institution])) {
666
667
668
669
670
671
672
673
674
675
676
        // 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,
677
                i.active,
678
679
                a.requires_config,
                a.requires_parent
Aaron Wells's avatar
Aaron Wells committed
680
            FROM
681
682
                {auth_instance} i,
                {auth_installed} a
Aaron Wells's avatar
Aaron Wells committed
683
            WHERE
684
685
686
687
688
689
690
691
                a.name = i.authname AND
                i.institution = '. db_quote($institution).'
            ORDER BY
                i.priority,
                i.instancename';

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

692
        if (empty($cache[$institution])) {
693
694
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
695
    }
696
697

    return $cache[$institution];
698
699
}

700
701
/**
 * Given a wwwroot, find any auth instances that can come from that host
Aaron Wells's avatar
Aaron Wells committed
702
 *
703
704
705
 * @param   string  wwwroot of the host that is connecting to us
 * @return  array   array of record objects
 */
706
707
function auth_get_auth_instances_for_wwwroot($wwwroot) {
    $query = "  SELECT
708
709
                    ai.id,
                    ai.authname,
710
                    ai.active,
711
712
713
                    i.id as institutionid,
                    i.displayname,
                    i.suspended
714
                FROM
715
716
717
718
719
720
                    {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
721
                WHERE
722
                    aic.value = ?";
723
724
725
726

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

727
/**
Aaron Wells's avatar
Aaron Wells committed
728
 * Given an institution, get all the auth types EXCEPT those that are already
729
730
731
732
733
 * enabled AND do not require configuration.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
734
function auth_get_available_auth_types($institution=null) {
735

736
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
737
738
739
740
741
742
743
744
        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
745
        FROM
746
            {auth_installed} a
Aaron Wells's avatar
Aaron Wells committed
747
        LEFT JOIN
748
            {auth_instance} i
Aaron Wells's avatar
Aaron Wells committed
749
        ON
750
751
752
753
754
755
756
            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
757
            a.name';
758

759
760
761
762
763
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
764
765
766
767
768

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

769
770
771
772
773
774
775
776
777
778
    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);
        }
    }
779
780
781
782
783
784
785
786
    usort($result, function($a, $b) {
        if ($a->is_usable != $b->is_usable) {
            return $b->is_usable;
        }
        else {
            return strnatcasecmp($a->title, $b->title);
        }
    });
787

788
789
    return $result;
}
790
791
792
/**
 * Build the agree with or withdraw consent to privacy statement
 *
793
794
795
796
797
 * @param ignoreagreevalue true  - when a new privacy statement needs to be accepted,
 *                         false - when the form will be displayed to allow the consent withdraw.
 * @param ignoreformswitch If true we do not show the form's switch fields. Useful if strict privacy is off.
 *
 * @return pieform form
798
 */
799
function privacy_form($ignoreagreevalue = false, $ignoreformswitch = false) {
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
    global $USER;

    // Get all institutions of a user.
    $userinstitutions = array_keys($USER->get('institutions'));
    // Include the 'mahara' institution so that we may show the site privacy statement as well.
    array_push($userinstitutions, 'mahara');

    // Check if there are new privacies that need to be accepted.
    $latestversions = get_latest_privacy_versions($userinstitutions, $ignoreagreevalue);
    if (empty($latestversions)) {
        // We may be masquerading as user
        return '<div>' . get_string('noprivacystatementsaccepted', 'account') . '</div>';
    }

    foreach ($latestversions as $privacy) {
815
816
817
        if ($privacy->type == 'privacy') {
            $title = get_string('institutionprivacystatement', 'admin');
            if ($privacy->institution == 'mahara') {
818
                $title = get_string('siteprivacy', 'admin');
819
820
821
            }
        }
        else {
822
            $title = get_string('institutiontermsandconditions', 'admin');
823
            if ($privacy->institution == 'mahara') {
824
                $title = get_string('sitetermsandconditions', 'admin');
825
826
            }
        }
827
828
        $smarty = smarty_core();
        $smarty->assign('privacy', $privacy);
829
        $smarty->assign('privacytitle', $title);
830
831
        $smarty->assign('privacytime', format_date(strtotime($privacy->ctime)));
        $smarty->assign('ignoreagreevalue', $ignoreagreevalue);
832
        $smarty->assign('ignoreformswitch', $ignoreformswitch);
833
834
835
        $htmlbegin = $smarty->fetch('privacy_panel_begin.tpl');

        //Build form elements.
836
        $elements[$privacy->institution . $privacy->type . 'text'] = array(
837
838
839
            'type' => 'markup',
            'value' => $htmlbegin,
        );
840
        $elements[$privacy->institution . $privacy->type . 'id'] = array(
841
842
843
            'type' => 'hidden',
            'value' => $privacy->id,
        );
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
        if (!$ignoreformswitch) {
            $elements[$privacy->institution . $privacy->type] = array(
                'type'         => 'switchbox',
                'title'        => get_string('privacyagreement', 'admin', get_string($privacy->type . 'lowcase', 'admin')),
                'description'  => $privacy->agreed ? get_string('privacyagreedto', 'admin',
                    get_string($privacy->type . 'lowcase', 'admin'), format_date(strtotime($privacy->agreedtime))) : '',
                'defaultvalue' => $privacy->agreed ? true : false,
                'disabled'     => ($privacy->agreed && $ignoreagreevalue) ? true : false,
                'required' => true,
            );
            $elements[$privacy->institution . $privacy->type . 'switch'] = array(
                'type' => 'hidden',
                'value' => ($privacy->agreed && $ignoreagreevalue) ? 'disabled' : 'enabled',
            );
        }
859
860
861
        $smarty = smarty_core();
        $smarty->assign('ignoreagreevalue', $ignoreagreevalue);
        $htmlend = $smarty->fetch('privacy_panel_end.tpl');
862
        $elements[$privacy->institution . $privacy->type . 'text2'] = array(
863
864
865
866
867
868
            'type' => 'markup',
            'value' => $htmlend,
        );

    }
    $classhidden = $ignoreagreevalue ? '' : 'js-hidden';
869
870
871
872
873
874
875
876
    if (!$ignoreformswitch) {
        $elements['submit'] = array(
            'class' => 'btn-primary ' . $classhidden,
            'type'  => 'submit',
            'value' => get_string('savechanges', 'admin')
        );
    }

877
878
879
880
    $form = pieform(array(
        'name'       => 'agreetoprivacy',
        'elements' => $elements,
    ));
881

882
883
    return $form;
}
884
885
/**
 * Checks that all the required fields are set, and handles setting them if required.
886
887
888
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
889
890
 */
function auth_check_required_fields() {
891
    global $USER, $SESSION;
892

893
894
895
896
897
    if ($USER->get('id') == 0) {
        // We shouldn't be checking either logged out user or User = 0
        throw new ConfigSanityException(get_string('invaliduser', 'error'));
    }

898
899
900
901
902
903
904
905
906
907
908
    // for the case we are mascarading as the user and we want to return to be admin user
    $restoreadmin = param_integer('restore', 0);
    $loginanyway = false;
    if ($USER->get('parentuser') && param_exists('loginanyway')) {
        $USER->loginanyway = true;
    }
    if ($USER->get('loginanyway')) {
        $loginanyway = true;
    }
    // Privacy statement.
    if (get_config('institutionstrictprivacy') && !$USER->has_latest_agreement() && !$restoreadmin && !$loginanyway) {
909
910
911
        // Build the agree with privacy statement form.
        $form = privacy_form(true);

912
        define('TITLE', get_string('legal', 'admin'));
913
914
        $smarty = smarty();
        setpageicon($smarty, 'icon-umbrella');
915
916
        if ($USER->get('parentuser')) {
            $smarty->assign('loginanyway',
917
            get_string('loginasoverridelegalaccept', 'admin',
918
919
                       '<strong><a class="" href="' . get_config('wwwroot') . '?loginanyway">', '</a></strong>'));
        }
920
        $smarty->assign('form', $form);
921
922
        $smarty->assign('description', get_string('newprivacy', 'admin'));
        $smarty->display('account/userprivacy.tpl');
923
924
925
        exit;
    }

926
    if (defined('NOCHECKREQUIREDFIELDS') || $SESSION->get('nocheckrequiredfields') === true) {
927
928
        return;
    }
929
930
931
932
933
934
935
936
937
938
    $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;
    }
939

940
    // Check if the user wants to log in anyway
941
    if ($USER->get('passwordchange') && $loginanyway) {
942
943
944
        $changepassword = false;
    }

945
946
947
948
949
    // Do not force password change on JSON request.
    if (defined('JSON') && JSON == true) {
        $changepassword = false;
    }

950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
    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') . ':',
Gregor Anzelj's avatar
Gregor Anzelj committed
972
973
                'description' => get_password_policy_description('user'),
                'showstrength' => true,
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
                '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')) {
1000
        // Don't need to check this for json requests
For faster browsing, not all history is shown. View entire blame