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

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

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

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

39
40
41
42
43
44
45
46
47
48
/**
 * An instance of an auth plugin failed during execution 
 * e.g. LDAP auth failed to connect to a directory
 * Developers can use this to fail an individual auth
 * instance, but not kill all from being tried.
 * If appropriate - the 'message' of the exception will be used
 * as the display message, so don't forget to language translate it
 */
class AuthInstanceException extends UserException {}

49
50
51
52
53
54
/**
 * We tried to call a method on an auth plugin that hasn't been init'ed 
 * successfully
 */
class UninitialisedAuthException extends SystemException {}

55
56
57
/**
 * Base authentication class. Provides a common interface with which
 * authentication can be carried out for system users.
Nigel McNie's avatar
Nigel McNie committed
58
59
60
61
62
63
 *
 * @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
64
65
66
 */
abstract class Auth {

67
68
69
70
71
72
    protected $instanceid;
    protected $institution;
    protected $instancename;
    protected $priority;
    protected $authname;
    protected $config;
73
    protected $has_instance_config;
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
101
102
103
104
105
106
107
108
109
110
111
112
    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)
113
        if ($this->has_instance_config == false) {
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
            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) {
138
        $approved_members = array('instanceid', 'institution', 'instancename', 'priority', 'authname', 'type');
139
140
141
142

        if (in_array($name, $approved_members)) {
            return $this->{$name};
        }
143
144
        if (isset($this->config[$name])) {
            return $this->config[$name];
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
183
184
185
186
187
188
189
190
191
192
193
        }
        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'];
    }

194
    /**
195
     * Given a username and password, attempts to log the user in.
196
     *
197
     * @param object $user      An object with username member (at least)
198
199
200
201
202
     * @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
     */
203
204
205
206
    public function authenticate_user_account($user, $password) {
        $this->must_be_ready();
        return false;
    }
207

208
209
210
211
212
213
    /**
     * 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
     */
214
215
    public function user_exists($username) {
        $this->must_be_ready();
216
        if (record_exists('usr', 'LOWER(username)', strtolower($username))) {
217
218
219
220
            return true;
        }
        throw new AuthUnknownUserException("\"$username\" is not known to Auth");
    }
221

222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
    /**
     * 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();

244
    /**
245
     * Given a username, returns a hash of information about a user from the
246
     * external data source.
247
248
249
250
251
252
     *
     * @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
     */
253
254
255
    public function get_user_info($username) {
        return false;
    }
256

Nigel McNie's avatar
Nigel McNie committed
257
258
259
260
    /**
     * Given a password, returns whether it is in a valid format for this
     * authentication method.
     *
261
262
263
264
265
     * 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
266
267
268
269
     *
     * 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!
     *
270
271
272
     * 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
273
274
275
     * @param string $password The password to check
     * @return bool            Whether the username is in valid form.
     */
276
    public function is_password_valid($password) {
Nigel McNie's avatar
Nigel McNie committed
277
278
279
        return true;
    }

280
281
282
283
284
285
286
287
288
289
290
291
    /**
     * Called when a user is being logged in, after the main authentication routines.
     *
     * You can use $USER->login() to perform any additional tasks, for example
     * to set a cookie that another application can read, or pull some data
     * from somewhere.
     *
     * This method has no parameters and needs no return value
     */
    public function login() {
    }

292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
    /**
     * 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() {
    }

315
316
317
}


318
319
320
321
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

322
/**
323
324
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
325
326
327
328
329
330
331
332
 *
 * 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
333
334
335
336
337
338
339
 *
 * 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.
 *
340
341
 */
function auth_setup () {
342
    global $SESSION, $USER;
343
344
345
346

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

351
    // Lock the site until core upgrades are done
David Mudrak's avatar
David Mudrak committed
352
    require(get_config('libroot') . 'version.php');
353
    $siteclosed    = $config->version > get_config('version');
354
355
356
357
358
359
360
    $disablelogin  = $config->disablelogin;

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

361
    $cfgsiteclosed = get_config('siteclosed');
362
363
364
365
366
    if ($siteclosed && !$cfgsiteclosed || !$siteclosed && $cfgsiteclosed) {
        // If the admin closed the site manually, open it automatically
        // when an upgrade is successful.
        if ($cfgsiteclosed && get_config('siteclosedbyadmin')) {
            set_config('siteclosedbyadmin', false);
367
        }
368
369
        set_config('siteclosed', $siteclosed);
        set_config('disablelogin', $disablelogin);
370
    }
371

372
373
    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
374
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
375
    if ($sessionlogouttime && isset($_GET['logout'])) {
376
377
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
378
379
380
381
382
383
384
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
385

386
387
        $USER->logout();
        $SESSION->add_ok_msg(get_string('loggedoutok'));
388
        redirect();
Nigel McNie's avatar
Nigel McNie committed
389
390
    }
    if ($sessionlogouttime > time()) {
391
        // The session is still active, so continue it.
392
393
394
        // Make sure that if a user's admin status has changed, they're kicked
        // out of the admin section
        if (defined('ADMIN')) {
395
            $userreallyadmin = get_field('usr', 'admin', 'id', $USER->id);
396
            if (!$USER->get('admin') && $userreallyadmin) {
397
                // The user has been made into an admin
398
                $USER->admin = 1;
399
            }
400
            else if ($USER->get('admin') && !$userreallyadmin) {
401
                // The user's admin rights have been taken away
402
                $USER->admin = 0;
403
404
            }
            if (!$USER->get('admin')) {
405
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
406
                redirect();
407
            }
408
        } else if (defined('INSTITUTIONALADMIN') && !$USER->get('admin')) {
409
            $USER->reset_institutions();
410
            if (!$USER->is_institutional_admin()) {
411
                $SESSION->add_error_msg(get_string('accessforbiddentoadminsection'));
412
                redirect();
413
            }
414
        }
415
        $USER->renew();
416
        auth_check_required_fields();
417
418
419
    }
    else if ($sessionlogouttime > 0) {
        // The session timed out
420
421

        $authinstance = $SESSION->get('authinstance');
422
423
424
425
426
427
428
429
430
        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');
            }
431

432
433
            $authobj->logout();
            $USER->logout();
434

435
436
437
438
439
440
441
            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");
442
443
        }

444
        if (defined('JSON')) {
445
            json_reply('global', get_string('sessiontimedoutreload'), 1);
446
        }
447
448
        if (defined('IFRAME')) {
            header('Content-type: text/html');
449
            print_auth_frame();
450
451
            exit;
        }
452

453
454
455
456
457
458
        // 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
459
460
461
462
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
463
464
465
            return;
        }

466
        auth_draw_login_page(get_string('sessiontimedout'));
467
468
469
    }
    else {
        // There is no session, so we check to see if one needs to be started.
470
        // Build login form. If the form is submitted it will be handled here,
471
472
        // and set $USER for us (this will happen when users hit a page and
        // specify login data immediately
473
474
        require_once('pieforms/pieform.php');
        $form = new Pieform(auth_get_login_form());
475
476
        if ($USER->is_logged_in()) {
            return;
477
478
479
        }
        
        // Check if the page is public or the site is configured to be public.
480
        if (defined('PUBLIC') && !isset($_GET['login'])) {
481
            return;
482
        }
483
484
485
486
487

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
488
        
489
        auth_draw_login_page(null, $form);
490
        exit;
491
492
493
    }
}

494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
/**
 * 
 * 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,
512
513
            i.instancename,
            i.authname
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
        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;
}


533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
/**
 * 
 * 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,
548
549
            i.instancename,
            i.authname
550
551
552
553
554
555
556
557
558
559
560
561
        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());
}
562
563


564
/**
565
566
 * Given an institution, returns the authentication methods used by it, sorted 
 * by priority.
567
 *
568
569
 * @param  string   $institution     Name of the institution
 * @return array                     Array of auth instance records
570
 */
571
function auth_get_auth_instances_for_institution($institution=null) {
Nigel McNie's avatar
Nigel McNie committed
572
    static $cache = array();
573

574
    if (null == $institution) {
575
576
577
        return array();
    }

578
    if (!isset($cache[$institution])) {
579
580
581
582
583
584
585
586
587
588
589
        // 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,
590
591
                a.requires_config,
                a.requires_parent
592
            FROM 
593
594
                {auth_instance} i,
                {auth_installed} a
595
596
597
598
599
600
601
602
603
            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());

604
        if (empty($cache[$institution])) {
605
606
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
607
    }
608
609

    return $cache[$institution];
610
611
}

612
613
614
615
616
617
/**
 * 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
 */
618
function auth_get_auth_instances_for_wwwroot($wwwroot) {
619
620
621

    // TODO: we just need ai.id and ai.authname... rewrite query, or
    // just drop this function
622
623
624
625
626
    $query = "  SELECT
                    ai.*,
                    aic.*,
                    i.*
                FROM
627
628
629
                    {auth_instance} ai, 
                    {auth_instance_config} aic,
                    {institution} i
630
631
632
633
634
635
636
637
638
                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));
}

639
640
641
642
643
644
645
/**
 * 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
 */
646
function auth_get_available_auth_types($institution=null) {
647

648
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
649
650
651
652
653
654
655
656
657
        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 
658
            {auth_installed} a
659
        LEFT JOIN 
660
            {auth_instance} i
661
662
663
664
665
666
667
668
669
670
        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';          

671
672
673
674
675
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
676
677
678
679
680

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

681
682
683
684
685
686
687
688
689
690
691
692
    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);'));

693
694
    return $result;
}
695
696
/**
 * Checks that all the required fields are set, and handles setting them if required.
697
698
699
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
700
701
 */
function auth_check_required_fields() {
702
703
704
705
706
707
708
709
710
711
712
713
    global $USER, $SESSION;

    $changepassword = true;
    $elements = array();

    if (
        !$USER->get('passwordchange')                                // User doesn't need to change their password
        || ($USER->get('parentuser') && $USER->get('loginanyway'))   // User is masquerading and wants to log in anyway
        || defined('NOCHECKPASSWORDCHANGE')                          // The page wants to skip this hassle
        ) {
        $changepassword = false;
    }
714

715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
    // Check if the user wants to log in anyway
    if ($USER->get('passwordchange') && $USER->get('parentuser') && isset($_GET['loginanyway'])) {
        $USER->loginanyway = true;
        $changepassword = false;
    }

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

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

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

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

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

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

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

774
775
776
    safe_require('artefact', 'internal');
    require_once('pieforms/pieform.php');

777
    $alwaysmandatoryfields = array_keys(ArtefactTypeProfile::get_always_mandatory_fields());
778
    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
779
780
781
782
783
784
785
        // Always mandatory fields are stored in the usr table, so are part of 
        // the user session object. We can save a query by grabbing them from 
        // the session.
        if (in_array($field, $alwaysmandatoryfields) && $USER->get($field) != null) {
            continue;
        }
        // Not cached? Get value the standard way.
786
        if (get_profile_field($USER->get('id'), $field) != null) {
787
788
789
            continue;
        }

790
        if ($field == 'email') {
791
792
793
794
            if (isset($elements['email'])) {
                continue;
            }
            // Use a text field for their first e-mail address, not the
795
796
797
798
            // emaillist element
            $type = 'text';
        }

799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
        $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();
816
            $elements[$field]['defaultvalue'] = get_config('country');
817
        }
818
819
820
821

        if ($field == 'email') {
            $elements[$field]['rules']['email'] = true;
        }
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
    }

    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();
841
842
843
844
845
846
    if ($USER->get('parentuser')) {
        $smarty->assign('loginasoverridepasswordchange',
            get_string('loginasoverridepasswordchange', 'admin',
                       '<a href="' . get_config('wwwroot') . '?loginanyway">', '</a>'));
    }
    $smarty->assign('changepassword', $changepassword);
847
    $smarty->assign('changeusername', $SESSION->get('resetusername'));
848
849
850
851
852
    $smarty->assign('form', $form);
    $smarty->display('requiredfields.tpl');
    exit;
}

853
function requiredfields_validate(Pieform $form, $values) {
Nigel McNie's avatar
Nigel McNie committed
854
    global $USER;
855
856
    if (!isset($values['password1'])) {
        return true;
857
858
    }

859
    // Get the authentication type for the user, and
860
    // use the information to validate the password
861
    $authobj = AuthFactory::create($USER->authinstance);
862

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

Nigel McNie's avatar
Nigel McNie committed
866
    // The password cannot be the same as the old one
867
868
869
870
871
872
873
874
875
    try {
        if (!$form->get_error('password1')
            && $authobj->authenticate_user_account($USER, $values['password1'])) {
            $form->set_error('password1', get_string('passwordnotchanged'));
        }
    }
    // propagate error up as the collective error AuthUnknownUserException
     catch  (AuthInstanceException $e) {
        $form->set_error('password1', $e->getMessage());
876
    }
877

878

879
880
881
882
883
884
885
886
    if ($authobj->authname == 'internal' && isset($values['username']) && $values['username'] != $USER->get('username')) {
        if (!AuthInternal::is_username_valid($values['username'])) {
            $form->set_error('username', get_string('usernameinvalidform', 'auth.internal'));
        }
        if (!$form->get_error('username') && record_exists_select('usr', 'LOWER(username) = ?', strtolower($values['username']))) {
            $form->set_error('username', get_string('usernamealreadytaken', 'auth.internal'));
        }
    }
887
888
}

889
function requiredfields_submit(Pieform $form, $values) {
890
    global $USER, $SESSION;
891

892
893
894
895
896
897
898
899
900
    if (isset($values['password1'])) {
        $authobj = AuthFactory::create($USER->authinstance);

        // This method should exist, because if it did not then the change
        // password form would not have been shown.
        if ($password = $authobj->change_password($USER, $values['password1'])) {
            $SESSION->add_ok_msg(get_string('passwordsaved'));
        }
        else {
901
            throw new SystemException('Attempt by "' . $USER->get('username') . '@'
902
903
904
                . $USER->get('institution') . 'to change their password failed');
        }
    }
Nigel McNie's avatar
Nigel McNie committed
905

906
907
908
909
910
911
912
913
914
915
916
917
918
919
    if (isset($values['username'])) {
        $SESSION->set('resetusername', false);
        if ($values['username'] != $USER->get('username')) {
            $USER->username = $values['username'];
            $USER->commit();
            $otherfield = true;
        }
    }

    foreach ($values as $field => $value) {
        if (in_array($field, array('submit', 'sesskey', 'password1', 'password2', 'username'))) {
            continue;
        }
        if ($field == 'email') {
920
921
            $USER->email = $values['email'];
            $USER->commit();
922
        }
923
924
        set_profile_field($USER->get('id'), $field, $value);
        $otherfield = true;
925
    }
Nigel McNie's avatar
Nigel McNie committed
926

927
928
929
930
931
    if (isset($otherfield)) {
        $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    }

    redirect();
932
933
}

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

    }

    if ($message) {
        $SESSION->add_info_msg($message);
970
    }
971
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false, 'sidebars' => false));
972
    $smarty->assign('login_form', $loginform);
973
    $smarty->assign('PAGEHEADING', get_string('loginto', 'mahara', get_config('sitename')));
974
975
976
    $smarty->display('login.tpl');
    exit;
}
977

978
/**
Nigel McNie's avatar
Nigel McNie committed
979
 * Returns the definition of the login form.
980
 *
Nigel McNie's avatar
Nigel McNie committed
981
982
 * @return array   The login form definition array.
 * @access private
983
984
 */
function auth_get_login_form() {
985
    $elements = array(
Nigel McNie's avatar
Nigel McNie committed
986
987
988
989
990
991
        'login_username' => array(
            'type'        => 'text',
            'title'       => get_string('username') . ':',
            'description' => get_string('usernamedescription'),
            'rules' => array(
                'required'    => true
992
993
            )
        ),
Nigel McNie's avatar
Nigel McNie committed
994
995
996
997
        'login_password' => array(
            'type'        => 'password',
            'title'       => get_string('password') . ':',
            'description' => get_string('passworddescription'),
998
            'defaultvalue'       => '',
Nigel McNie's avatar
Nigel McNie committed
999
        ),
1000
1001
        'submit' => array(
            'type'  => 'submit',
Nigel McNie's avatar
Nigel McNie committed
1002
            'value' => get_string('login')
Nigel McNie's avatar
Nigel McNie committed
1003
        ),
1004
1005
1006
1007
        'login_submitted' => array(
            'type'  => 'hidden',
            'value' => 1
        ),
1008
1009
1010
1011
1012
1013
    );

    // 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 = '';
1014
1015
1016
    if (get_config('httpswwwroot')) {
        $action = rtrim(get_config('httpswwwroot'), '/') . hsc(strip_querystring(get_relative_script_path()));
    }
1017
1018
1019
1020
1021
1022
    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.
1023
1024
1025
            if ($action == '') {
                $action = hsc(substr($_SERVER['REQUEST_URI'], 0, strpos($_SERVER['REQUEST_URI'], '?')));
            }
1026
        } else {
1027
            $action .= '?';
1028
            foreach ($_GET as $key => $value) {
1029
                if ($key != 'logout' && $key != 'login') {
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
                    $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(
1048
1049
1050
1051
1052
1053
1054
1055
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
1056
1057
    );

1058
    return $form;
1059
1060
}

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

1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104

/**
 * 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) {
1105
1106
1107
        if (is_object($id) && isset($id->id)) {
            $id = $id->id;
        }
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125

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

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

1137
1138
1139
1140
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
1141

1142
    try {
1143
        $authenticated = $USER->login($username, $password);
1144

1145
1146
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
1147
            return;
1148
        }
1149

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

1160
            $authinstances = get_records_sql_array('
1161
                SELECT a.id, a.instancename, a.priority, a.authname, a.institution, i.suspended, i.displayname
1162
1163
1164
1165
1166
                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
1167
1168
            }

1169
            $USER->username = $username;
1170

1171
1172
1173
1174
1175
1176
            reset($authinstances);
            while ((list(, $authinstance) = each($authinstances)) && false == $authenticated) {
                $auth = AuthFactory::create($authinstance->id);
                if (!$auth->can_auto_create_users()) {
                    continue;
                }
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
                // catch semi-fatal auth errors, but allow next auth instance to be
                // tried
                try {
                    if ($auth->authenticate_user_account($USER, $password)) {
                        $authenticated = true;
                    }
                    else {
                        continue;
                    }
                } catch  (AuthInstanceException $e) {
1187
1188
                    continue;
                }
1189

1190
1191
1192
1193
1194
1195
                // 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');
                }
1196

1197
1198
                $USER->authinstance = $authinstance->id;
                $userdata = $auth->get_user_info($username);
1199

1200
                if (empty($userdata)) {
1201
                    throw new AuthUnknownUserException("\"$username\" is not known");
1202
                }
1203
1204
1205
1206
1207
1208
1209

                // Check for a suspended institution
                if ($authinstance->suspended) {
                    $sitename = get_config('sitename');
                    throw new AccessTotallyDeniedException(get_string('accesstotallydenied_institutionsuspended', 'mahara', $authinstance->displayname, $sitename));
                }

1210
1211
1212
                // We have the data - create the user
                $USER->lastlogin = db_format_timestamp(time());
                if (isset($userdata->firstname)) {
1213
                    $USER->firstname = $userdata->firstname;
1214
1215
1216
1217
                }
                if (isset($userdata->lastname)) {
                    $USER->lastname = $userdata->lastname;
                }
1218
1219
1220
1221
1222
1223
1224
                if (isset($userdata->email)) {
                    $USER->email = $userdata->email;
                }
                else {
                    // The user will be asked to populate this when they log in.
                    $USER->email = null;
                }
1225
                try {
1226
1227
1228
1229
                    // If this authinstance is a parent auth for some xmlrpc authinstance, pass it along to create_user
                    // so that this username also gets recorded as the username for sso from the remote sites.
                    $remoteauth = count_records('auth_instance_config', 'field', 'parent', 'value', $authinstance->id) ? $authinstance : null;
                    create_user($USER, array(), $institution, $remoteauth);
1230
1231
1232
1233
1234
                    $USER->reanimate($USER->id, $authinstance->id);
                }
                catch (Exception $e) {
                    db_rollback();
                    throw $e;
1235
                }
Nigel McNie's avatar
Nigel McNie committed
1236
1237
            }

1238
1239
1240
1241
1242
            if (!$authenticated) {
                $SESSION->add_error_msg(get_string('loginfailed'));
                return;
            }

1243
1244
        }
        catch (AuthUnknownUserException $e) {
1245
1246
1247
1248
            // 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());
1249
            $SESSION->add_error_msg(get_string('loginfailed'));
1250
            return;
1251
1252
        }
    }
1253
1254

    // Only admins in the admin section!
1255
1256
    if (!$USER->get('admin') && 
        (defined('ADMIN') || defined('INSTITUTIONALADMIN') && !$USER->is_institutional_admin())) {
1257
1258
1259
1260
1261
1262
        $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
1263
        $USER->logout();
1264
1265
1266
1267
1268
        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
1269
        $USER->logout();
1270
1271
1272
1273
        die_info(get_string('accountexpired'));
    }

    // Check if the user's account has become inactive
1274
    $inactivetime = get_config('defaultaccountinactiveexpire');
1275
1276
    if ($inactivetime && $oldlastlogin > 0
        && $oldlastlogin + $inactivetime < time()) {
Richard Mansfield's avatar
Richard Mansfield committed
1277
        $USER->