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

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

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

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

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

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

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

268
269
270
271
272
273
274
275
276
277
278
279
    /**
     * 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() {
    }

280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
    /**
     * 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() {
    }

303
304
305
}


306
307
308
309
/******************************************************************************/
    // End of Auth base-class
/******************************************************************************/

310
/**
311
312
 * Handles authentication by setting up a session for a user if they are logged 
 * in.
313
314
315
316
317
318
319
320
 *
 * 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
321
322
323
324
325
326
327
 *
 * 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.
 *
328
329
 */
function auth_setup () {
330
    global $SESSION, $USER;
331
332
333
334

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

339
    // Lock the site until core upgrades are done
David Mudrak's avatar
David Mudrak committed
340
    require(get_config('libroot') . 'version.php');
341
    $siteclosed    = $config->version > get_config('version');
342
343
344
345
346
347
348
    $disablelogin  = $config->disablelogin;

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

349
350
351
352
353
    $cfgsiteclosed = get_config('siteclosed');
    if (
        ($siteclosed && !$cfgsiteclosed)
        || (!$siteclosed && $cfgsiteclosed)) {
        set_config('siteclosed', $siteclosed);
354
        if ($disablelogin && $siteclosed) {
355
356
            set_config('disablelogin', 1);
        }
357
    }
358

359
360
    // Check the time that the session is set to log out. If the user does
    // not have a session, this time will be 0.
361
    $sessionlogouttime = $USER->get('logout_time');
Nigel McNie's avatar
Nigel McNie committed
362
    if ($sessionlogouttime && isset($_GET['logout'])) {
363
364
        // Call the authinstance' logout hook
        $authinstance = $SESSION->get('authinstance');
365
366
367
368
369
370
371
        if ($authinstance) {
            $authobj = AuthFactory::create($authinstance);
            $authobj->logout();
        }
        else {
            log_debug("Strange: user " . $USER->get('username') . " had no authinstance set in their session");
        }
372

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

        $authinstance = $SESSION->get('authinstance');
415
416
417
418
419
420
421
422
423
        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');
            }
424

425
426
            $authobj->logout();
            $USER->logout();
427

428
429
430
431
432
433
434
            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");
435
436
        }

437
        if (defined('JSON')) {
438
            json_reply('global', get_string('sessiontimedoutreload'), 1);
439
        }
440
441
442
443
444
445
        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;
        }
446

447
448
449
450
451
452
        // 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
453
454
455
456
            $loginurl = $_SERVER['REQUEST_URI'];
            $loginurl .= (false === strpos($loginurl, '?')) ? '?' : '&';
            $loginurl .= 'login';
            $SESSION->add_info_msg(get_string('sessiontimedoutpublic', 'mahara', hsc($loginurl)), false);
457
458
459
            return;
        }

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

        // No session and a json request
        if (defined('JSON')) {
            json_reply('global', get_string('nosessionreload'), 1);
        }
482
        
483
        auth_draw_login_page(null, $form);
484
        exit;
485
486
487
    }
}

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


527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
/**
 * 
 * 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,
542
543
            i.instancename,
            i.authname
544
545
546
547
548
549
550
551
552
553
554
555
        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());
}
556
557


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

568
    if (null == $institution) {
569
570
571
        return array();
    }

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

598
        if (empty($cache[$institution])) {
599
600
            return false;
        }
Nigel McNie's avatar
Nigel McNie committed
601
    }
602
603

    return $cache[$institution];
604
605
}

606
607
608
609
610
611
/**
 * 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
 */
612
function auth_get_auth_instances_for_wwwroot($wwwroot) {
613
614
615

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

633
634
635
636
637
638
639
/**
 * 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
 */
640
function auth_get_available_auth_types($institution=null) {
641

642
    if (!is_null($institution) && (!is_string($institution) || strlen($institution) > 255)) {
643
644
645
646
647
648
649
650
651
        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 
652
            {auth_installed} a
653
        LEFT JOIN 
654
            {auth_instance} i
655
656
657
658
659
660
661
662
663
664
        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';          

665
666
667
668
669
    if (is_null($institution)) {
        $result = get_records_array('auth_installed', '','','name','name, requires_config');
    } else {
        $result = get_records_sql_array($sql, array());
    }
670
671
672
673
674

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

675
676
677
678
679
680
681
682
683
684
685
686
    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);'));

687
688
    return $result;
}
689
690
/**
 * Checks that all the required fields are set, and handles setting them if required.
691
692
693
 *
 * Checks whether the current user needs to change their password, and handles
 * the password changing if it's required.
694
695
 */
function auth_check_required_fields() {
696
697
698
699
700
701
702
703
704
705
706
707
    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;
    }
708

709
710
711
712
713
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
    // 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')) {
764
765
766
767
        // Don't need to check this for json requests
        return;
    }

768
769
770
    safe_require('artefact', 'internal');
    require_once('pieforms/pieform.php');

771
    $alwaysmandatoryfields = array_keys(ArtefactTypeProfile::get_always_mandatory_fields());
772
    foreach(ArtefactTypeProfile::get_mandatory_fields() as $field => $type) {
773
774
775
776
777
778
779
        // 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.
780
        if (get_profile_field($USER->get('id'), $field) != null) {
781
782
783
            continue;
        }

784
        if ($field == 'email') {
785
786
787
788
            if (isset($elements['email'])) {
                continue;
            }
            // Use a text field for their first e-mail address, not the
789
790
791
792
            // emaillist element
            $type = 'text';
        }

793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
        $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';
        }
812
813
814
815

        if ($field == 'email') {
            $elements[$field]['rules']['email'] = true;
        }
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
    }

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

847
function requiredfields_validate(Pieform $form, $values) {
Nigel McNie's avatar
Nigel McNie committed
848
    global $USER;
849
850
    if (!isset($values['password1'])) {
        return true;
851
852
    }

853
    // Get the authentication type for the user, and
854
    // use the information to validate the password
855
    $authobj = AuthFactory::create($USER->authinstance);
856

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

Nigel McNie's avatar
Nigel McNie committed
860
    // The password cannot be the same as the old one
861
    if (!$form->get_error('password1')
862
        && $authobj->authenticate_user_account($USER, $values['password1'])) {
Nigel McNie's avatar
Nigel McNie committed
863
        $form->set_error('password1', get_string('passwordnotchanged'));
864
    }
865
866
867
868
869
870
871
872
873

    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'));
        }
    }
874
875
}

876
function requiredfields_submit(Pieform $form, $values) {
877
    global $USER, $SESSION;
878

879
880
881
882
883
884
885
886
887
888
889
890
891
892
    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 {
            // TODO: Exception is the wrong type here!
            throw new Exception('Attempt by "' . $USER->get('username') . '@'
                . $USER->get('institution') . 'to change their password failed');
        }
    }
Nigel McNie's avatar
Nigel McNie committed
893

894
895
896
897
898
899
900
901
902
903
904
905
906
907
    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') {
908
909
            $USER->email = $values['email'];
            $USER->commit();
910
        }
911
912
        set_profile_field($USER->get('id'), $field, $value);
        $otherfield = true;
913
    }
Nigel McNie's avatar
Nigel McNie committed
914

915
916
917
918
919
    if (isset($otherfield)) {
        $SESSION->add_ok_msg(get_string('requiredfieldsset', 'auth'));
    }

    redirect();
920
921
}

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

    }

    if ($message) {
        $SESSION->add_info_msg($message);
958
    }
959
    $smarty = smarty(array(), array(), array(), array('pagehelp' => false, 'sidebars' => false));
960
    $smarty->assign('login_form', $loginform);
961
    $smarty->assign('PAGEHEADING', hsc(get_string('loginto', 'mahara', get_config('sitename'))));
962
963
964
    $smarty->display('login.tpl');
    exit;
}
965

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

    // 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) {
1012
                if ($key != 'logout' && $key != 'login') {
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
                    $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(
1031
1032
1033
1034
1035
1036
1037
1038
        'name'           => 'login',
        'method'         => 'post',
        'action'         => $action,
        'plugintype'     => 'auth',
        'pluginname'     => 'internal',
        'elements'       => $elements,
        'dieaftersubmit' => false,
        'iscancellable'  => false
1039
1040
    );

1041
    return $form;
1042
1043
}

Nigel McNie's avatar
Nigel McNie committed
1044
1045
1046
1047
1048
/**
 * 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.
 *
1049
1050
 * @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
1051
1052
1053
1054
 * @private
 */
function get_login_form_js($form) {
    $form = str_replace('/', '\/', str_replace("'", "\'", (str_replace(array("\n", "\t"), '', $form))));
1055
    $strcookiesnotenabled    = json_encode(get_string('cookiesnotenabled'));
Nigel McNie's avatar
Nigel McNie committed
1056
1057
1058
    $cookiename = get_config('cookieprefix') . 'ctest';
    return <<<EOF
<script type="text/javascript">
1059
var loginbox = $('loginform_container');
Nigel McNie's avatar
Nigel McNie committed
1060
document.cookie = "$cookiename=1";
Nigel McNie's avatar
Nigel McNie committed
1061
1062
if (document.cookie) {
    loginbox.innerHTML = '$form';
1063
    document.cookie = '$cookiename=1;expires=1/1/1990 00:00:00';
Nigel McNie's avatar
Nigel McNie committed
1064
1065
}
else {
1066
    replaceChildNodes(loginbox, P(null, $strcookiesnotenabled));
Nigel McNie's avatar
Nigel McNie committed
1067
1068
1069
1070
}
</script>
EOF;
}
1071

1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105

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

1106
/**
1107
 * Called when the login form is submitted. Validates the user and password, and
1108
 * if they are valid, starts a new session for the user.
1109
 *
1110
1111
 * @param object $form   The Pieform form object
 * @param array  $values The submitted values
Nigel McNie's avatar
Nigel McNie committed
1112
 * @access private
1113
 */
1114
function login_submit(Pieform $form, $values) {
1115
1116
    global $SESSION, $USER;

1117
1118
1119
1120
    $username      = $values['login_username'];
    $password      = $values['login_password'];
    $authenticated = false;
    $oldlastlogin  = 0;
Nigel McNie's avatar
Nigel McNie committed
1121

1122
    try {
1123
        $authenticated = $USER->login($username, $password);
1124

1125
1126
        if (empty($authenticated)) {
            $SESSION->add_error_msg(get_string('loginfailed'));
1127
            return;
1128
        }
1129

1130
1131
    }
    catch (AuthUnknownUserException $e) {
1132
1133
        // If the user doesn't exist, check for institutions that
        // want to create users automatically.
1134
        try {
1135
1136
            // Reset the LiveUser object, since we are attempting to create a 
            // new user
1137
            $SESSION->destroy_session();
1138
1139
            $USER = new LiveUser();

1140
            $authinstances = get_records_sql_array('
1141
                SELECT a.id, a.instancename, a.priority, a.authname, a.institution, i.suspended, i.displayname
1142
1143
1144
1145
1146
                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
1147
1148
            }

1149
            $USER->username = $username;
1150

1151
1152
1153
1154
1155
1156
1157
1158
            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;
1159
1160
                }
                else {
1161
1162
                    continue;
                }
1163

1164
1165
1166
1167
1168
1169
                // 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');
                }
1170

1171
1172
                $USER->authinstance = $authinstance->id;
                $userdata = $auth->get_user_info($username);
1173

1174
                if (empty($userdata)) {
1175
                    throw new AuthUnknownUserException("\"$username\" is not known");
1176
                }
1177
1178
1179
1180
1181
1182
1183

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

1184
1185
1186
                // We have the data - create the user
                $USER->lastlogin = db_format_timestamp(time());
                if (isset($userdata->firstname)) {
1187
                    $USER->firstname = $userdata->firstname;
1188
1189
1190
1191
                }
                if (isset($userdata->lastname)) {
                    $USER->lastname = $userdata->lastname;
                }
1192
1193
1194
1195
1196
1197
1198
                if (isset($userdata->email)) {
                    $USER->email = $userdata->email;
                }
                else {
                    // The user will be asked to populate this when they log in.
                    $USER->email = null;
                }
1199
                try {
1200
1201
1202
1203
                    // 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);
1204
1205
1206
1207
1208
                    $USER->reanimate($USER->id, $authinstance->id);
                }
                catch (Exception $e) {
                    db_rollback();
                    throw $e;
1209
                }
Nigel McNie's avatar
Nigel McNie committed
1210
1211
            }

1212
1213
1214
1215
1216
            if (!$authenticated) {
                $SESSION->add_error_msg(get_string('loginfailed'));
                return;
            }

1217
1218
        }
        catch (AuthUnknownUserException $e) {
1219
1220
1221
1222
            // 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());
1223
            $SESSION->add_error_msg(get_string('loginfailed'));
1224
            return;
1225
1226
        }
    }
1227
1228

    // Only admins in the admin section!
1229
1230
    if (!$USER->get('admin') && 
        (defined('ADMIN') || defined('INSTITUTIONALADMIN') && !$USER->is_institutional_admin())) {
1231
1232
1233
1234
1235
1236
        $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
1237
        $USER->logout();
1238
1239
1240
1241
1242
        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
1243
        $USER->logout();
1244
1245
1246
1247
        die_info(get_string('accountexpired'));
    }

    // Check if the user's account has become inactive
1248
    $inactivetime = get_config('defaultaccountinactiveexpire');
1249
1250
    if ($inactivetime && $oldlastlogin > 0
        && $oldlastlogin + $inactivetime < time()) {
Richard Mansfield's avatar
Richard Mansfield committed
1251
        $USER->logout();
1252
1253
1254
1255
1256
        die_info(get_string('accountinactive'));
    }

    // Check if the user's account has been suspended
    if ($USER->suspendedcusr) {
Richard Mansfield's avatar
Richard Mansfield committed
1257
1258
1259
1260
        $suspendedctime  = $USER->suspendedctime;
        $suspendedreason = $USER->suspendedreason;
        $USER->logout();
        die_info(get_string('accountsuspended', 'mahara', $suspendedctime, $suspendedreason));
1261
1262
1263
1264
    }

    // User is allowed to log in
    //$USER->login($userdata);
1265
    auth_check_required_fields();
1266
1267
}

1268
1269
1270
1271
/**
 * Removes registration requests that were not completed in the allowed amount of time
 */
function auth_clean_partial_registrations() {
1272
    delete_records_sql('DELETE FROM {usr_registration}
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
        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');
1293
1294
    $expire   = get_config('defaultaccountinactiveexpire');
    $warn     = get_config('defaultaccountinactivewarn');
1295

1296
1297
1298
    $daystoexpire = ceil($warn / 86400) . ' ';
    $daystoexpire .= ($daystoexpire == 1) ? get_string('day') : get_string('days');

1299
    // Expiry warning messages