lib.php 53.3 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

Nigel McNie's avatar
Nigel McNie committed
246
247
248
249
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
250
251
252
253
254
     * 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
255
256
257
258
     *
     * 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!
     *
259
260
261
     * 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
262
263
264
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
265
    public function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
266
267
268
        return true;
    }

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
    /**
     * 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() {
    }

292
293
294
}


295
296
297
298
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

299
/**
300
301
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
302
303
304
305
306
307
308
309
 *
 * 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
310
311
312
313
314
315
316
 *
 * 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.
 *
317
318
 */
function auth_setup () {
319
    global $SESSION, $USER;
320
321
322
323

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

328
329
    // Lock the site until core upgrades are done
    require_once(get_config('libroot') . 'version.php');
330
331
332
333
334
335
336
    $siteclosed    = $config->version > get_config('version');
    $cfgsiteclosed = get_config('siteclosed');
    if (
        ($siteclosed && !$cfgsiteclosed)
        || (!$siteclosed && $cfgsiteclosed)) {
        set_config('siteclosed', $siteclosed);
    }
337

338
339
    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
340
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
341
    if ($sessionlogouttime && isset($_GET['logout'])) {
342
343
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
344
345
346
347
348
349
350
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
351

352
353
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
354
        redirect();
Nigel McNie's avatar
Nigel McNie committed
355
356
    }
    if ($sessionlogouttime > time()) {
357
        // The session is still active, so continue it.
358
359
360
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
361
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->id);
362
            if (!$USER->get('admin') && $userreallyadmin) {
363
                // The user has been made into an admin
364
                $USER->admin = 1;
365
            }
366
            else if ($USER->get('admin') && !$userreallyadmin) {
367
                // The user's admin rights have been taken away
368
                $USER->admin = 0;
369
370
            }
            if (!$USER->get('admin')) {
371
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
372
                redirect();
373
            }
374
        } else if (defined('INSTITUTIONALADMIN') && !$USER->get('admin')) {
375
376
377
378
379
380
381
382
            $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()) {
383
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
384
                redirect();
385
            }
386
        }
387
        $USER->renew();
Nigel McNie's avatar
Nigel McNie committed
388
        auth_check_password_change();
389
        auth_check_required_fields();
390
391
392
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
393
394

        $authinstance = $SESSION->get('authinstance');
395
396
397
398
399
400
401
402
403
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);

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

405
406
            $authobj->logout();
            $USER->logout();
407

408
409
410
411
412
413
414
            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");
415
416
        }

417
        if (defined('JSON')) {
418
            json_reply('global', get_string('sessiontimedoutreload'), 1);
419
        }
420
421
422
423
424
425
        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;
        }
426

427
428
429
430
431
432
        // 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
433
434
435
436
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
437
438
439
            return;
        }

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

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
462
        
463
        auth_draw_login_page(null, $form);
464
        exit;
465
466
467
    }
}

468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
/**
 * 
 * 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,
486
487
            i.instancename,
            i.authname
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
        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;
}


507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
/**
 * 
 * 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());
}
535
536


537
/**
538
539
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
540
 *
541
542
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
543
 */
544
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
545
    static $cache = array();
546

547
    if (null == $institution) {
548
549
550
        return array();
    }

551
    if (!isset($cache[$institution])) {
552
553
554
555
556
557
558
559
560
561
562
        // 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,
563
564
                a.requires_config,
                a.requires_parent
565
            FROM 
566
567
                {auth_instance} i,
                {auth_installed} a
568
569
570
571
572
573
574
575
576
            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());

577
        if (empty($cache[$institution])) {
578
579
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
580
    }
581
582

    return $cache[$institution];
583
584
}

585
586
587
588
589
590
/**
 * 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
 */
591
function auth_get_auth_instances_for_wwwroot($wwwroot) {
592
593
594

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

651
        if (empty($cache[$institution])) {
652
653
654
655
656
657
658
            return false;
        }
    }

    return $cache[$institution];
}

659
660
661
662
663
664
665
/**
 * 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
 */
666
function auth_get_available_auth_types($institution=null) {
667

668
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
669
670
671
672
673
674
675
676
677
        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 
678
            {auth_installed} a
679
        LEFT JOIN 
680
            {auth_instance} i
681
682
683
684
685
686
687
688
689
690
        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';          

691
692
693
694
695
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
696
697
698
699
700

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

701
702
703
704
705
706
707
708
709
710
711
712
    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);'));

713
714
    return $result;
}
715
716
717
718
719
720
721
722
723
724
/**
 * 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) {
725
        if (get_profile_field($USER->get('id'), $field) != null) {
726
727
728
            continue;
        }

729
730
731
732
733
734
        if ($field == 'email') {
            // Use a text field for their first e-mail address, not the 
            // emaillist element
            $type = 'text';
        }

735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
        $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';
        }
754
755
756
757

        if ($field == 'email') {
            $elements[$field]['rules']['email'] = true;
        }
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
    }

    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();
}
793

794
795
796
797
798
799
800
801
/**
 * 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
802
803
function auth_check_password_change() {
    global $USER;
804
805
806
807
808
809
810
811
812
813
814
    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
815
816
817
        return;
    }

818
819
820
821
822
823
824
    $authobj = AuthFactory::create($USER->authinstance);

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

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

828
        require_once('pieforms/pieform.php');
829
        $form = array(
Nigel McNie's avatar
Nigel McNie committed
830
831
832
833
834
            'name'       => 'change_password',
            'method'     => 'post',
            'plugintype' => 'auth',
            'pluginname' => 'internal',
            'elements'   => array(
835
836
837
838
839
840
841
842
843
844
845
846
847
                '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(
848
849
850
851
852
853
854
855
856
857
858
                        '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,
                    ),
859
860
                ),
                'submit' => array(
Nigel McNie's avatar
Nigel McNie committed
861
                    'type'  => 'submit',
862
863
                    'value' => get_string('changepassword'),
                ),
864
865
866
867
            )
        );

        $smarty = smarty();
868
        $smarty->assign('change_password_form', pieform($form));
869
870
871
872
873
        if ($USER->get('parentuser')) {
            $smarty->assign('loginasoverridepasswordchange',
                get_string('loginasoverridepasswordchange', 'admin',
                    '<a href="' . get_config('wwwroot') . '?loginanyway">', '</a>'));
        }
874
875
876
877
878
879
880
881
        $smarty->display('change_password.tpl');
        exit;
    }
}

/**
 * Validates the form for changing the password for a user.
 *
Nigel McNie's avatar
Nigel McNie committed
882
 * Change password will only be if a URL for it exists, or a function exists.
Nigel McNie's avatar
Nigel McNie committed
883
 *
884
885
 * @param Pieform  $form   The form to check
 * @param array    $values The values to check
886
 */
887
function change_password_validate(Pieform $form, $values) {
888
    global $USER;
889

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

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

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

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

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

914
    // This method should exist, because if it did not then the change
Nigel McNie's avatar
Nigel McNie committed
915
    // password form would not have been shown.
916
    if ($password = $authobj->change_password($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
917
        $SESSION->add_ok_msg(get_string('passwordsaved'));
918
        if (!empty($values['email'])) {
919
920
            $USER->email = $values['email'];
            $USER->commit();
921
            set_profile_field($USER->id, 'email', $values['email']);
922
        }
923
        redirect();
924
    }
Nigel McNie's avatar
Nigel McNie committed
925

926
    // TODO: Exception is the wrong type here!
927
928
    throw new Exception('Attempt by "' . $USER->get('username') . '@'
        . $USER->get('institution') . 'to change their password failed');
929
930
}

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

    }

    if ($message) {
        $SESSION->add_info_msg($message);
967
    }
968
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false));
969
    $smarty->assign('login_form', $loginform);
Richard Mansfield's avatar
Richard Mansfield committed
970
    $smarty->assign('loginmessage', get_string('loginto', 'mahara', get_config('sitename')));
971
972
973
    $smarty->display('login.tpl');
    exit;
}
974

975
/**
Nigel McNie's avatar
Nigel McNie committed
976
 * Returns the definition of the login form.
977
 *
Nigel McNie's avatar
Nigel McNie committed
978
979
 * @return array   The login form definition array.
 * @access private
980
981
 */
function auth_get_login_form() {
982
    $institutions = get_records_menu('institution', '', '', 'name, displayname');
983

984
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
985
986
987
988
989
990
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
991
992
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
993
994
995
996
997
998
999
1000
1001
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
            'value'       => '',
            'rules' => array(
                'required'    => true
            )
        ),
1002
1003
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
1004
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
1005
        ),
1006
1007
1008
1009
        'login_submitted' => array(
            'type'  => 'hidden',
            'value' => 1
        ),
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
    );

    // 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) {
1026
                if ($key != 'logout' && $key != 'login') {
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
                    $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(
1045
1046
1047
1048
1049
1050
1051
1052
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
1053
1054
    );

1055
    return $form;
1056
1057
}

Nigel McNie's avatar
Nigel McNie committed
1058
1059
1060
1061
1062
/**
 * 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.
 *
1063
1064
 * @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
1065
1066
1067
 * @private
 */
function get_login_form_js($form) {
1068
1069
1070
1071
1072
1073
1074
1075
1076
    // 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
1077
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
1078
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
1079
1080
1081
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
1082
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
1083
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
1084
1085
if (document.cookie) {
    loginbox.innerHTML = '$form';
1086
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
1087
1088
}
else {
1089
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
Nigel McNie's avatar
Nigel McNie committed
1090
1091
1092
1093
}
</script>
EOF;
}
1094

1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128

/**
 * 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;
    }
}

1129
/**
1130
 * Called when the login form is submitted. Validates the user and password, and
1131
 * if they are valid, starts a new session for the user.
1132
 *
1133
1134
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
1135
 * @access private
1136
 */
1137
function login_submit(Pieform $form, $values) {
1138
1139
    global $SESSION, $USER;

1140
1141
1142
1143
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
1144

1145
    try {
1146
        $authenticated = $USER->login($username, $password);
1147

1148
1149
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
1150
            return;
1151
        }
1152

1153
1154
    }
    catch (AuthUnknownUserException $e) {
1155
1156
        // If the user doesn't exist, check for institutions that
        // want to create users automatically.
1157
        try {
1158
1159
1160
1161
            // Reset the LiveUser object, since we are attempting to create a 
            // new user
            $USER = new LiveUser();

1162
1163
1164
1165
1166
1167
1168
            $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
1169
1170
            }

1171
            $USER->username = $username;
1172

1173
1174
1175
1176
1177
1178
1179
1180
            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;
1181
1182
                }
                else {
1183
1184
                    continue;
                }
1185

1186
1187
1188
1189
1190
1191
                // 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');
                }
1192

1193
1194
                $USER->authinstance = $authinstance->id;
                $userdata = $auth->get_user_info($username);
1195

1196
                if (empty($userdata)) {
1197
                    throw new AuthUnknownUserException("\"$username\" is not known");
1198
                }
1199
1200
1201
                // We have the data - create the user
                $USER->lastlogin = db_format_timestamp(time());
                if (isset($userdata->firstname)) {
1202
                    $USER->firstname = $userdata->firstname;
1203
1204
1205
1206
                }
                if (isset($userdata->lastname)) {
                    $USER->lastname = $userdata->lastname;
                }
1207
1208
1209
1210
1211
1212
1213
                if (isset($userdata->email)) {
                    $USER->email = $userdata->email;
                }
                else {
                    // The user will be asked to populate this when they log in.
                    $USER->email = null;
                }
1214
                try {
1215
                    create_user($USER, array(), $institution);
1216
1217
1218
1219
1220
                    $USER->reanimate($USER->id, $authinstance->id);
                }
                catch (Exception $e) {
                    db_rollback();
                    throw $e;
1221
                }
Nigel McNie's avatar
Nigel McNie committed
1222
1223
            }

1224
1225
1226
1227
1228
            if (!$authenticated) {
                $SESSION->add_error_msg(get_string('loginfailed'));
                return;
            }

1229
1230
        }
        catch (AuthUnknownUserException $e) {
1231
1232
1233
1234
            // 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());
1235
            $SESSION->add_error_msg(get_string('loginfailed'));
1236
            return;
1237
1238
        }
    }
1239
1240

    // Only admins in the admin section!
1241
1242
    if (!$USER->get('admin') && 
        (defined('ADMIN') || defined('INSTITUTIONALADMIN') && !$USER->is_institutional_admin())) {
1243
1244
1245
1246
1247
1248
        $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
1249
        $USER->logout();
1250
1251
1252
1253
1254
        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
1255
        $USER->logout();
1256
1257
1258
1259
        die_info(get_string('accountexpired'));
    }

    // Check if the user's account has become inactive
1260
    $inactivetime = get_config('defaultaccountinactiveexpire');
1261
1262
    if ($inactivetime && $oldlastlogin > 0
        && $oldlastlogin + $inactivetime < time()) {
Richard Mansfield's avatar
Richard Mansfield committed
1263
        $USER->logout();
1264
1265
1266
1267
1268
        die_info(get_string('accountinactive'));
    }

    // Check if the user's account has been suspended
    if ($USER->suspendedcusr) {
Richard Mansfield's avatar
Richard Mansfield committed
1269
1270
1271
1272
        $suspendedctime  = $USER->suspendedctime;
        $suspendedreason = $USER->suspendedreason;
        $USER->logout();
        die_info(get_string('accountsuspended', 'mahara', $suspendedctime, $suspendedreason));
1273
1274
1275
1276
1277
    }

    // User is allowed to log in
    //$USER->login($userdata);
    auth_check_password_change();
1278
    auth_check_required_fields();
1279
1280
}

1281
1282
1283
1284
/**
 * Removes registration requests that were not completed in the allowed amount of time
 */
function auth_clean_partial_registrations() {
1285
    delete_records_sql('DELETE FROM {usr_registration}
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
        WHERE expiry < ?', array(db_format_timestamp(time())));
}

/**
 * Sends notification e-mails to users in two situations:
 *
 *  - Their account is about to expire. This is controlled by the 'expiry'
 *    field of the usr table. Once that time has passed, the user may not
 *    log in.
 *  - They have not logged in for close to a certain amount of time. If that
 *    amount of time has passed, the user may not log in.
 *
 * The actual prevention of users logging in is handled by the authentication
 * code. This cron job sends e-mails to notify users that these events will
 * happen soon.
 */
function auth_handle_account_expiries() {
    // The 'expiry' flag on the usr table
    $sitename = get_config('sitename');
    $wwwroot  = get_config('wwwroot');
1306
1307
    $expire   = get_config('defaultaccountinactiveexpire');
    $warn     = get_config('defaultaccountinactivewarn');
1308

1309
1310
1311
    $daystoexpire = ceil($warn / 86400) . ' ';
    $daystoexpire .= ($daystoexpire == 1) ? get_string('day') : get_string('days');

1312
    // Expiry warning messages