lib.php 54.7 KB
Newer Older
1
2
<?php
/**
Francois Marier's avatar
Francois Marier committed
3
 * Mahara: Electronic portfolio, weblog, resume builder and social networking
4
 * Copyright (C) 2006-2008 Catalyst IT Ltd (http://www.catalyst.net.nz)
5
 *
Francois Marier's avatar
Francois Marier committed
6
7
8
9
 * 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.
10
 *
Francois Marier's avatar
Francois Marier committed
11
12
13
14
 * 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.
15
 *
Francois Marier's avatar
Francois Marier committed
16
17
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
18
19
 *
 * @package    mahara
Nigel McNie's avatar
Nigel McNie committed
20
 * @subpackage auth
21
 * @author     Catalyst IT Ltd
22
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL
23
 * @copyright  (C) 2006-2008 Catalyst IT Ltd http://catalyst.net.nz
24
25
26
27
28
 *
 */

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

29
require('session.php');
30
require(get_config('docroot') . 'auth/user.php');
31

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

37
38
39
40
41
42
/**
 * We tried to call a method on an auth plugin that hasn't been init'ed 
 * successfully
 */
class UninitialisedAuthException extends SystemException {}

43
44
45
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
46
47
48
49
50
51
 *
 * @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
52
53
54
 */
abstract class Auth {

55
56
57
58
59
60
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
61
    protected $has_instance_config;
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
    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)
101
        if ($this->has_instance_config == false) {
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
            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) {
126
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname', 'type');
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }

        if (isset($this->config['name'])) {
            return $this->config['name'];
        }
        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'];
    }

183
    /**
184
     * Given a username and password, attempts to log the user in.
185
     *
186
     * @param object $user      An object with username member (at least)
187
188
189
190
191
     * @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
     */
192
193
194
195
    public function authenticate_user_account($user, $password) {
        $this->must_be_ready();
        return false;
    }
196

197
198
199
200
201
202
    /**
     * 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
     */
203
204
    public function user_exists($username) {
        $this->must_be_ready();
205
        if (record_exists('usr', 'LOWER(username)', strtolower($username))) {
206
207
208
209
            return true;
        }
        throw new AuthUnknownUserException("\"$username\" is not known to Auth");
    }
210

211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
    /**
     * 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();

233
    /**
234
     * Given a username, returns a hash of information about a user from the
235
     * external data source.
236
237
238
239
240
241
     *
     * @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
     */
242
243
244
    public function get_user_info($username) {
        return false;
    }
245

246
247
    /**
     * Given a username, return information about the user from the database.
248
249
     * This object must_be_ready, which means it will have an authinstanceid. 
     * This is used to disambiguate between users with the same username.
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
     *
     * The information retrieved must be all rows in the user table, with the
     * timestamps formatted as unix timestamps. An example (taken from the
     * internal authentication mechanism, which allows usernames to be case
     * insensitive):
     *
     * <code>
     * get_record('usr', 'LOWER(username)', strtolower($username), null, null, null, null,
     *    '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin'));
     * </code>
     *
     * @param string $username The username to get information for
     * @return array           Data that can be used to populate the session
     * @throws AuthUnknownUserException If the user is unknown to the
     *                                  authentication method
     */
266
267
    public function get_user_info_cached($username) {
        $this->must_be_ready();
268
        if (!$result = get_record('usr', 'LOWER(username)', strtolower($username), null, null, null, null,
269
270
271
272
273
274
                    '*, ' . db_format_tsfield('expiry') . ', ' . db_format_tsfield('lastlogin'))) {
            throw new AuthUnknownUserException("\"$username\" is not known to AuthInternal");
        }
        $cache[$result->username] = $result;
        return $result;
    }
275

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

299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
    /**
     * 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() {
    }

322
323
324
}


325
326
327
328
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

329
/**
330
331
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
332
333
334
335
336
337
338
339
 *
 * 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
340
341
342
343
344
345
346
 *
 * 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.
 *
347
348
 */
function auth_setup () {
349
    global $SESSION, $USER;
350
351
352
353

    // If the system is not installed, let the user through in the hope that
    // they can fix this little problem :)
    if (!get_config('installed')) {
354
        $USER->logout();
355
356
357
358
359
        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.
360
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
361
    if ($sessionlogouttime && isset($_GET['logout'])) {
362
363
364
365
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
        $authobj = AuthFactory::create($authinstance);
        $authobj->logout();
366

367
368
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
369
        redirect();
Nigel McNie's avatar
Nigel McNie committed
370
371
    }
    if ($sessionlogouttime > time()) {
372
        // The session is still active, so continue it.
373
374
375
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
376
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->id);
377
            if (!$USER->get('admin') && $userreallyadmin) {
378
                // The user has been made into an admin
379
                $USER->admin = 1;
380
            }
381
            else if ($USER->get('admin') && !$userreallyadmin) {
382
                // The user's admin rights have been taken away
383
                $USER->admin = 0;
384
385
            }
            if (!$USER->get('admin')) {
386
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
387
                redirect();
388
            }
389
        } else if (defined('INSTITUTIONALADMIN') && !$USER->get('admin')) {
390
391
392
393
394
395
396
397
            $userreallyadminfor = get_column('usr_institution', 'institution', 'usr', $USER->id, 'admin', 1);
            if (!$USER->is_institutional_admin() && !empty($userreallyadminfor)) {
                $USER->set_admin_institutions($userreallyadminfor);
            }
            else if ($USER->is_institutional_admin() && empty($userreallyadminfor)) {
                $USER->set_admin_institutions(array());
            }
            if (!$USER->is_institutional_admin()) {
398
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
399
                redirect();
400
            }
401
        }
402
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
403
        auth_check_password_change();
404
        auth_check_required_fields();
405
406
407
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
408
409
410
411
412
413
414
415
416
417
418
419

        $authinstance = $SESSION->get('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');
        }

        $authobj->logout();
420
        $USER->logout();
421
422
423
424
425
426

        if ($mnetuser != 0) {
            $SESSION->set('mnetuser', $mnetuser);
            $SESSION->set('authinstance', $authinstance);
        }

427
        if (defined('JSON')) {
428
            json_reply('global', get_string('sessiontimedoutreload'), 1);
429
        }
430
431
432
433
434
435
        if (defined('IFRAME')) {
            $frame = '<html><head></head><body onload="parent.show_login_form(\'ajaxlogin_iframe\')"></body></html>';
            header('Content-type: text/html');
            echo $frame;
            exit;
        }
436

437
438
439
440
441
442
        // 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
443
444
445
446
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
447
448
449
            return;
        }

450
        auth_draw_login_page(get_string('sessiontimedout'));
451
452
453
    }
    else {
        // There is no session, so we check to see if one needs to be started.
454
        // Build login form. If the form is submitted it will be handled here,
455
456
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
457
458
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
459
460
        if ($USER->is_logged_in()) {
            return;
461
462
463
        }
        
        // Check if the page is public or the site is configured to be public.
464
        if (defined('PUBLIC') && !isset($_GET['login'])) {
465
            return;
466
        }
467
468
469
470
471

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
472
        
473
        auth_draw_login_page(null, $form);
474
        exit;
475
476
477
    }
}

478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
/**
 * 
 * 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,
496
497
            i.instancename,
            i.authname
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
        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;
}


517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
/**
 * 
 * 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,
            i.instancename
        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());
}
545
546


547
/**
548
549
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
550
 *
551
552
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
553
 */
554
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
555
    static $cache = array();
556

557
    if (null == $institution) {
558
559
560
        return array();
    }

561
    if (!isset($cache[$institution])) {
562
563
564
565
566
567
568
569
570
571
572
        // 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,
573
574
                a.requires_config,
                a.requires_parent
575
            FROM 
576
577
                {auth_instance} i,
                {auth_installed} a
578
579
580
581
582
583
584
585
586
            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());

587
        if (empty($cache[$institution])) {
588
589
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
590
    }
591
592

    return $cache[$institution];
593
594
}

595
596
597
598
599
600
/**
 * 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
 */
601
function auth_get_auth_instances_for_wwwroot($wwwroot) {
602
603
604

    // TODO: we just need ai.id and ai.authname... rewrite query, or
    // just drop this function
605
606
607
608
609
    $query = "  SELECT
                    ai.*,
                    aic.*,
                    i.*
                FROM
610
611
612
                    {auth_instance} ai, 
                    {auth_instance_config} aic,
                    {institution} i
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
                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));
}

/**
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
 *
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
 */
function auth_get_auth_instances_for_username($institution, $username) {
    static $cache = array();

    if (!isset($cache[$institution][$username])) {
        // 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,
                a.requires_config,
                a.requires_parent
            FROM 
647
648
649
                {auth_instance} i,
                {auth_installed} a,
                {usr} u
650
651
652
653
654
655
656
657
658
659
660
            WHERE 
                a.name = i.authname AND
                i.institution = ? AND
                u.username = ? AND
                u.institution = i.institution
            ORDER BY
                i.priority,
                i.instancename';

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

661
        if (empty($cache[$institution])) {
662
663
664
665
666
667
668
            return false;
        }
    }

    return $cache[$institution];
}

669
670
671
672
673
674
675
/**
 * 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
 */
676
function auth_get_available_auth_types($institution=null) {
677

678
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
679
680
681
682
683
684
685
686
687
        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 
688
            {auth_installed} a
689
        LEFT JOIN 
690
            {auth_instance} i
691
692
693
694
695
696
697
698
699
700
        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';          

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

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

711
712
713
714
715
716
717
718
719
720
721
722
    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);
        }
    }
    usort($result, create_function('$a, $b', 'return strnatcasecmp($a->title, $b->title);'));

723
724
    return $result;
}
725
726
727
728
729
730
731
732
733
734
/**
 * Checks that all the required fields are set, and handles setting them if required.
 */
function auth_check_required_fields() {
    global $USER;
    safe_require('artefact', 'internal');
    require_once('pieforms/pieform.php');
    $elements = array();

    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
735
        if (get_profile_field($USER->get('id'), $field) != null) {
736
737
738
            continue;
        }

739
740
741
742
743
744
        if ($field == 'email') {
            // Use a text field for their first e-mail address, not the 
            // emaillist element
            $type = 'text';
        }

745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
        $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();
            $elements[$field]['defaultvalue'] = 'nz';
        }
764
765
766
767

        if ($field == 'email') {
            $elements[$field]['rules']['email'] = true;
        }
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
    }

    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();
    $smarty->assign('form', $form);
    $smarty->display('requiredfields.tpl');
    exit;
}

function requiredfields_submit(Pieform $form, $values) {
    global $USER, $SESSION;
    foreach ($values as $field => $value) {
        if (in_array($field, array('submit', 'sesskey'))) {
            continue;
        }
        set_profile_field($USER->get('id'), $field, $value);
    }
    $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    redirect();
}
803

804
805
806
807
808
809
810
811
/**
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
 *
 * This only applies for the internal authentication plugin. Other plugins
 * will, in theory, have different data stores, making changing the password
 * via the internal form difficult.
 */
Nigel McNie's avatar
Nigel McNie committed
812
813
function auth_check_password_change() {
    global $USER;
814
815
816
817
818
819
820
821
822
823
824
    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
        ) {
        return;
    }

    // Check if the user wants to log in anyway
    if ($USER->get('passwordchange') && $USER->get('parentuser') && isset($_GET['loginanyway'])) {
        $USER->loginanyway = true;
Nigel McNie's avatar
Nigel McNie committed
825
826
827
        return;
    }

828
829
830
831
832
833
834
    $authobj = AuthFactory::create($USER->authinstance);

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

Nigel McNie's avatar
Nigel McNie committed
835
    // @todo auth preference for a password change screen for all auth methods other than internal
836
    if (method_exists($authobj, 'change_password')) {
Nigel McNie's avatar
Nigel McNie committed
837

838
        require_once('pieforms/pieform.php');
839
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
840
841
842
843
844
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
845
846
847
848
849
850
851
852
853
854
855
856
857
                'password1' => array(
                    'type'        => 'password',
                    'title'       => get_string('newpassword') . ':',
                    'description' => get_string('yournewpassword'),
                    'rules'       => array(
                        'required' => true
                    )
                ),
                'password2' => array(
                    'type'        => 'password',
                    'title'       => get_string('confirmpassword') . ':',
                    'description' => get_string('yournewpasswordagain'),
                    'rules'       => array(
858
859
860
861
862
863
864
865
866
867
868
                        'required' => true,
                    ),
                ),
                '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,
                    ),
869
870
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
871
                    'type'  => 'submit',
872
873
                    'value' => get_string('changepassword'),
                ),
874
875
876
877
            )
        );

        $smarty = smarty();
878
        $smarty->assign('change_password_form', pieform($form));
879
880
881
882
883
        if ($USER->get('parentuser')) {
            $smarty->assign('loginasoverridepasswordchange',
                get_string('loginasoverridepasswordchange', 'admin',
                    '<a href="' . get_config('wwwroot') . '?loginanyway">', '</a>'));
        }
884
885
886
887
888
889
890
891
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
892
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
893
 *
894
895
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
896
 */
897
function change_password_validate(Pieform $form, $values) {
898
    global $USER;
899

900
    // Get the authentication type for the user, and
901
    // use the information to validate the password
902
    $authobj = AuthFactory::create($USER->authinstance);
903

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

Nigel McNie's avatar
Nigel McNie committed
907
    // The password cannot be the same as the old one
908
    if (!$form->get_error('password1')
909
        && $authobj->authenticate_user_account($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
910
        $form->set_error('password1', get_string('passwordnotchanged'));
911
912
913
914
915
916
917
918
    }
}

/**
 * Changes the password for a user, given that it is valid.
 *
 * @param array $values The submitted form values
 */
919
function change_password_submit(Pieform $form, $values) {
920
    global $USER, $SESSION;
921
922

    $authobj = AuthFactory::create($USER->authinstance);
Nigel McNie's avatar
Nigel McNie committed
923

924
    // This method should exist, because if it did not then the change
Nigel McNie's avatar
Nigel McNie committed
925
    // password form would not have been shown.
926
    if ($password = $authobj->change_password($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
927
        $SESSION->add_ok_msg(get_string('passwordsaved'));
928
        if (!empty($values['email'])) {
929
930
            $USER->email = $values['email'];
            $USER->commit();
931
            set_profile_field($USER->id, 'email', $values['email']);
932
        }
933
        redirect();
934
    }
Nigel McNie's avatar
Nigel McNie committed
935

936
    // TODO: Exception is the wrong type here!
937
938
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
939
940
}

941
/**
Nigel McNie's avatar
Nigel McNie committed
942
 * Creates and displays the transient login page.
943
 *
Nigel McNie's avatar
Nigel McNie committed
944
945
946
947
 * 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.
 *
948
949
950
 * As this function builds and validates a login form, it is possible that
 * calling this may validate a user to be logged in.
 *
951
952
953
 * @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
954
 * @access private
955
 */
956
function auth_draw_login_page($message=null, Pieform $form=null) {
957
    global $USER, $SESSION;
958
    if ($form != null) {
Nigel McNie's avatar
Nigel McNie committed
959
        $loginform = get_login_form_js($form->build());
960
961
    }
    else {
962
        require_once('pieforms/pieform.php');
963
        $loginform = get_login_form_js(pieform(auth_get_login_form()));
964
965
966
967
968
        /*
         * 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.
         */
969
        if ($USER->is_logged_in()) {
970
971
972
973
974
975
976
            return;
        }

    }

    if ($message) {
        $SESSION->add_info_msg($message);
977
    }
978
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false));
979
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
980
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
981
982
983
    $smarty->display('login.tpl');
    exit;
}
984

985
/**
Nigel McNie's avatar
Nigel McNie committed
986
 * Returns the definition of the login form.
987
 *
Nigel McNie's avatar
Nigel McNie committed
988
989
 * @return array   The login form definition array.
 * @access private
990
991
 */
function auth_get_login_form() {
992
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
993

994
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
995
996
997
998
999
1000
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
1001
1002
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
1003
1004
1005
1006
1007
1008
1009
1010
1011
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
            'value'       => '',
            'rules' => array(
                'required'    => true
            )
        ),
1012
1013
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
1014
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
1015
        ),
1016
1017
1018
1019
        'login_submitted' => array(
            'type'  => 'hidden',
            'value' => 1
        ),
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
    );

    // 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
    // afterwards. 
    $action = '';
    if ($_GET) {
        if (isset($_GET['logout'])) {
            // 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.
            $action = hsc(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?')));
        } else {
            $action = '?';
            foreach ($_GET as $key => $value) {
1036
                if ($key != 'logout' && $key != 'login') {
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
                    $action .= hsc($key) . '=' . hsc($value) . '&amp;';
                }
            }
            $action = substr($action, 0, -5);
        }
    }
    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(
1055
1056
1057
1058
1059
1060
1061
1062
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
1063
1064
    );

1065
    return $form;
1066
1067
}

Nigel McNie's avatar
Nigel McNie committed
1068
1069
1070
1071
1072
/**
 * 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.
 *
1073
1074
 * @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
1075
1076
1077
 * @private
 */
function get_login_form_js($form) {
1078
1079
1080
1081
1082
1083
1084
1085
1086
    // Add the autofocus class to the username input. This is because Mahara 
    // doesn't always render the login form when it is built. Sometimes, the 
    // form is built to process a login attempt, and then built again when that 
    // attempt fails. This makes sure that every time the login form is 
    // actually displayed it has the autofocus class.
    $form = str_replace(
        'class="required text" id="login_login_username"',
        'class="required text autofocus" id="login_login_username"',
        $form);
Nigel McNie's avatar
Nigel McNie committed
1087
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
1088
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
1089
1090
1091
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
1092
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
1093
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
1094
1095
if (document.cookie) {
    loginbox.innerHTML = '$form';
1096
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
1097
1098
}
else {
1099
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
Nigel McNie's avatar
Nigel McNie committed
1100
1101
1102
1103
}
</script>
EOF;
}
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

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

    static $authcache = array();

    /**
     * Take an instanceid and create an auth object for that instance. 
     * 
     * @param  int      $id     The id of the auth instance
     * @return mixed            An intialised auth object or false, if the
     *                          instance doesn't exist (Should never happen)
     */
    public static function create($id) {

        if (isset(self::$authcache[$id]) && is_object(self::$authcache[$id])) {
            return self::$authcache[$id];
        }

        $authinstance = get_record('auth_instance', 'id', $id, null, null, null, null, 'authname');

        if (!empty($authinstance)) {
            $authclassname = 'Auth' . ucfirst($authinstance->authname);
            safe_require('auth', $authinstance->authname);
            self::$authcache[$id] = new $authclassname($id);
            return self::$authcache[$id];
        }

        return false;
    }
}

1139
/**
1140
 * Called when the login form is submitted. Validates the user and password, and
1141
 * if they are valid, starts a new session for the user.
1142
 *
1143
1144
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
1145
 * @access private
1146
 */
1147
function login_submit(Pieform $form, $values) {
1148
1149
    global $SESSION, $USER;

1150
1151
1152
1153
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
1154

1155
    try {
1156
        $authenticated = $USER->login($username, $password);
1157

1158
1159
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
1160
            return;
1161
        }
1162

1163
1164
    }
    catch (AuthUnknownUserException $e) {
1165
1166
        // If the user doesn't exist, check for institutions that
        // want to create users automatically.
1167
        try {
1168
1169
1170
1171
            // Reset the LiveUser object, since we are attempting to create a 
            // new user
            $USER = new LiveUser();

1172
1173
1174
1175
1176
1177
1178
            $authinstances = get_records_sql_array('
                SELECT a.id, a.instancename, a.priority, a.authname, a.institution
                FROM {institution} i JOIN {auth_instance} a ON a.institution = i.name
                ORDER BY a.institution, a.priority, a.instancename', null);

            if ($authinstances == false) {
                throw new AuthUnknownUserException("\"$username\" is not known");
Nigel McNie's avatar
Nigel McNie committed
1179
1180
            }

1181
            $USER->username = $username;
1182

1183
1184
1185
1186
1187
1188
1189
1190
            reset($authinstances);
            while ((list(, $authinstance) = each($authinstances)) && false == $authenticated) {
                $auth = AuthFactory::create($authinstance->id);
                if (!$auth->can_auto_create_users()) {
                    continue;
                }
                if ($auth->authenticate_user_account($USER, $password)) {
                    $authenticated = true;
1191
1192
                }
                else {
1193
1194
                    continue;
                }
1195

1196
1197
1198
1199
1200
1201
                // Check now to see if the institution has its maximum quota of users
                require_once('institution.php');
                $institution = new Institution($authinstance->institution);
                if ($institution->isFull()) {
                    throw new AuthUnknownUserException('Institution has too many users');
                }
1202

1203
1204
                $USER->authinstance = $authinstance->id;
                $userdata = $auth->get_user_info($username);
1205

1206
                if (empty($userdata)) {
1207
                    throw new AuthUnknownUserException("\"$username\" is not known");
1208
                }
1209
1210
1211
                // We have the data - create the user
                $USER->lastlogin = db_format_timestamp(time());
                if (isset($userdata->firstname)) {
1212
                    $USER->firstname = $userdata->firstname;
1213
1214
1215
1216
                }
                if (isset($userdata->lastname)) {
                    $USER->lastname = $userdata->lastname;
                }
1217
1218
1219
1220
1221
1222
1223
                if (isset($userdata->email)) {
                    $USER->email = $userdata->email;
                }
                else {
                    // The user will be asked to populate this when they log in.
                    $USER->email = null;
                }
1224
1225
1226
1227
                try {
                    db_begin();
                    $USER->commit();
                    if (isset($userdata->firstname)) {
1228
                        set_profile_field($USER->id, 'firstname', $USER->firstname);
1229
1230
                    }
                    if (isset($userdata->lastname)) {
1231
1232
                        set_profile_field($USER->id, 'lastname', $USER->lastname);
                    }
1233
1234
1235
                    if (isset($userdata->email)) {
                        set_profile_field($USER->id, 'email', $USER->email);
                    }
1236
1237
                    if ($authinstance->institution !== 'mahara') {
                        $USER->join_institution($authinstance->institution);
1238
                    }
1239
1240
1241
1242
1243
1244
1245
1246

                    handle_event('createuser', $USER->to_stdclass());
                    db_commit();
                    $USER->reanimate($USER->id, $authinstance->id);
                }
                catch (Exception $e) {
                    db_rollback();
                    throw $e;
1247
                }
Nigel McNie's avatar
Nigel McNie committed
1248
1249
            }

1250
1251
1252
1253
1254
            if (!$authenticated) {
                $SESSION->add_error_msg(get_string('loginfailed'));
                return;
            }

1255
1256
        }
        catch (AuthUnknownUserException $e) {
1257
1258
1259
1260
            // We weren't able to authenticate the user for some reason that 
            // probably isn't their fault (e.g. ldap extension not available 
            // when using ldap authentication)
            log_info($e->getMessage());
1261
            $SESSION->add_error_msg(get_string('loginfailed'));
1262
            return;
1263
1264
        }
    }
1265
1266

    // Only admins in the admin section!
1267
1268
    if (!$USER->get('admin') && 
        (defined('ADMIN') || defined('INSTITUTIONALADMIN') && !$USER->is_institutional_admin())) {
1269
1270
1271
1272
1273
1274
        $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
        redirect();
    }

    // Check if the user's account has been deleted
    if ($USER->deleted) {
Richard Mansfield's avatar
Richard Mansfield committed
1275
        $USER->logout();
1276
1277
1278
1279
1280
        die_info(get_string('accountdeleted'));
    }

    // Check if the user's account has expired
    if ($USER->expiry > 0 && time() > $USER->expiry) {
Richard Mansfield's avatar
Richard Mansfield committed
1281
        $USER->logout();
1282
1283
1284
1285
        die_info(get_string('accountexpired'));
    }

    // Check if the user's account has become inactive
1286
    $inactivetime = get_config('defaultaccountinactiveexpire');
1287
1288
    if ($inactivetime && $oldlastlogin > 0
        && $oldlastlogin + $inactivetime < time()) {
Richard Mansfield's avatar
Richard Mansfield committed
1289
        $USER->logout();
1290
1291
1292
1293
1294
        die_info(get_string('accountinactive'));
    }

    // Check if the user's account has been suspended
    if ($USER->suspendedcusr) {
Richard Mansfield's avatar
Richard Mansfield committed
1295
1296
1297
1298
        $suspendedctime  = $USER->suspendedctime;
        $suspendedreason = $USER->suspendedreason;
        $USER->logout();
        die_info(get_string('accountsuspended', 'mahara', $suspendedctime, $suspendedreason));
1299
1300
1301
1302
1303
    }

    // User is allowed to log in
    //$USER->login($userdata);
    auth_check_password_change();
1304
    auth_check_required_fields();
1305
1306
}

1307
1308
1309
1310
/**
 * Removes registration requests that were not completed in the allowed amount of time
 */
function auth_clean_partial_registrations() {
1311
    delete_records_sql('DELETE FROM {usr_registration}
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326