MDL-23740 fixed PARAM_TAG compatibility with utf-8 chars
[moodle.git] / lib / moodlelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * moodlelib.php - Moodle main library
20  *
21  * Main library file of miscellaneous general-purpose Moodle functions.
22  * Other main libraries:
23  *  - weblib.php      - functions that produce web output
24  *  - datalib.php     - functions that access the database
25  *
26  * @package    core
27  * @subpackage lib
28  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
36 /// Date and time constants ///
37 /**
38  * Time constant - the number of seconds in a year
39  */
40 define('YEARSECS', 31536000);
42 /**
43  * Time constant - the number of seconds in a week
44  */
45 define('WEEKSECS', 604800);
47 /**
48  * Time constant - the number of seconds in a day
49  */
50 define('DAYSECS', 86400);
52 /**
53  * Time constant - the number of seconds in an hour
54  */
55 define('HOURSECS', 3600);
57 /**
58  * Time constant - the number of seconds in a minute
59  */
60 define('MINSECS', 60);
62 /**
63  * Time constant - the number of minutes in a day
64  */
65 define('DAYMINS', 1440);
67 /**
68  * Time constant - the number of minutes in an hour
69  */
70 define('HOURMINS', 60);
72 /// Parameter constants - every call to optional_param(), required_param()  ///
73 /// or clean_param() should have a specified type of parameter.  //////////////
77 /**
78  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
79  */
80 define('PARAM_ALPHA',    'alpha');
82 /**
83  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
84  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
85  */
86 define('PARAM_ALPHAEXT', 'alphaext');
88 /**
89  * PARAM_ALPHANUM - expected numbers and letters only.
90  */
91 define('PARAM_ALPHANUM', 'alphanum');
93 /**
94  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
95  */
96 define('PARAM_ALPHANUMEXT', 'alphanumext');
98 /**
99  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
100  */
101 define('PARAM_AUTH',  'auth');
103 /**
104  * PARAM_BASE64 - Base 64 encoded format
105  */
106 define('PARAM_BASE64',   'base64');
108 /**
109  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
110  */
111 define('PARAM_BOOL',     'bool');
113 /**
114  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
115  * checked against the list of capabilities in the database.
116  */
117 define('PARAM_CAPABILITY',   'capability');
119 /**
120  * PARAM_CLEANHTML - cleans submitted HTML code and removes slashes. It stays as HTML.
121  */
122 define('PARAM_CLEANHTML', 'cleanhtml');
124 /**
125  * PARAM_EMAIL - an email address following the RFC
126  */
127 define('PARAM_EMAIL',   'email');
129 /**
130  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
131  */
132 define('PARAM_FILE',   'file');
134 /**
135  * PARAM_FLOAT - a real/floating point number.
136  */
137 define('PARAM_FLOAT',  'float');
139 /**
140  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
141  */
142 define('PARAM_HOST',     'host');
144 /**
145  * PARAM_INT - integers only, use when expecting only numbers.
146  */
147 define('PARAM_INT',      'int');
149 /**
150  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
151  */
152 define('PARAM_LANG',  'lang');
154 /**
155  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the others! Implies PARAM_URL!)
156  */
157 define('PARAM_LOCALURL', 'localurl');
159 /**
160  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
161  */
162 define('PARAM_NOTAGS',   'notags');
164 /**
165  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
166  * note: the leading slash is not removed, window drive letter is not allowed
167  */
168 define('PARAM_PATH',     'path');
170 /**
171  * PARAM_PEM - Privacy Enhanced Mail format
172  */
173 define('PARAM_PEM',      'pem');
175 /**
176  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
177  */
178 define('PARAM_PERMISSION',   'permission');
180 /**
181  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way
182  */
183 define('PARAM_RAW', 'raw');
185 /**
186  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
187  */
188 define('PARAM_SAFEDIR',  'safedir');
190 /**
191  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
192  */
193 define('PARAM_SAFEPATH',  'safepath');
195 /**
196  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
197  */
198 define('PARAM_SEQUENCE',  'sequence');
200 /**
201  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
202  */
203 define('PARAM_TAG',   'tag');
205 /**
206  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
207  */
208 define('PARAM_TAGLIST',   'taglist');
210 /**
211  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
212  */
213 define('PARAM_TEXT',  'text');
215 /**
216  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
217  */
218 define('PARAM_THEME',  'theme');
220 /**
221  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
222  */
223 define('PARAM_URL',      'url');
225 /**
226  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
227  */
228 define('PARAM_USERNAME',    'username');
230 /**
231  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
232  */
233 define('PARAM_STRINGID',    'stringid');
235 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
236 /**
237  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
238  * It was one of the first types, that is why it is abused so much ;-)
239  */
240 define('PARAM_CLEAN',    'clean');
242 /**
243  * PARAM_INTEGER - deprecated alias for PARAM_INT
244  */
245 define('PARAM_INTEGER',  'int');
247 /**
248  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
249  */
250 define('PARAM_NUMBER',  'float');
252 /**
253  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
254  * NOTE: originally alias for PARAM_APLHA
255  */
256 define('PARAM_ACTION',   'alphanumext');
258 /**
259  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
260  * NOTE: originally alias for PARAM_APLHA
261  */
262 define('PARAM_FORMAT',   'alphanumext');
264 /**
265  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
266  */
267 define('PARAM_MULTILANG',  'text');
269 /**
270  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
271  */
272 define('PARAM_CLEANFILE', 'file');
274 /// Web Services ///
276 /**
277  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
278  */
279 define('VALUE_REQUIRED', 1);
281 /**
282  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
283  */
284 define('VALUE_OPTIONAL', 2);
286 /**
287  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
288  */
289 define('VALUE_DEFAULT', 0);
291 /**
292  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
293  */
294 define('NULL_NOT_ALLOWED', false);
296 /**
297  * NULL_ALLOWED - the parameter can be set to null in the database
298  */
299 define('NULL_ALLOWED', true);
301 /// Page types ///
302 /**
303  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
304  */
305 define('PAGE_COURSE_VIEW', 'course-view');
307 /** Get remote addr constant */
308 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
309 /** Get remote addr constant */
310 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
312 /// Blog access level constant declaration ///
313 define ('BLOG_USER_LEVEL', 1);
314 define ('BLOG_GROUP_LEVEL', 2);
315 define ('BLOG_COURSE_LEVEL', 3);
316 define ('BLOG_SITE_LEVEL', 4);
317 define ('BLOG_GLOBAL_LEVEL', 5);
320 ///Tag constants///
321 /**
322  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
323  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
324  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
325  *
326  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
327  */
328 define('TAG_MAX_LENGTH', 50);
330 /// Password policy constants ///
331 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
332 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
333 define ('PASSWORD_DIGITS', '0123456789');
334 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
336 /// Feature constants ///
337 // Used for plugin_supports() to report features that are, or are not, supported by a module.
339 /** True if module can provide a grade */
340 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
341 /** True if module supports outcomes */
342 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
344 /** True if module has code to track whether somebody viewed it */
345 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
346 /** True if module has custom completion rules */
347 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
349 /** True if module supports outcomes */
350 define('FEATURE_IDNUMBER', 'idnumber');
351 /** True if module supports groups */
352 define('FEATURE_GROUPS', 'groups');
353 /** True if module supports groupings */
354 define('FEATURE_GROUPINGS', 'groupings');
355 /** True if module supports groupmembersonly */
356 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
358 /** Type of module */
359 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
360 /** True if module supports intro editor */
361 define('FEATURE_MOD_INTRO', 'mod_intro');
362 /** True if module has default completion */
363 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
365 define('FEATURE_COMMENT', 'comment');
367 define('FEATURE_RATE', 'rate');
368 /** True if module supports backup/restore of moodle2 format */
369 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
371 /** Unspecified module archetype */
372 define('MOD_ARCHETYPE_OTHER', 0);
373 /** Resource-like type module */
374 define('MOD_ARCHETYPE_RESOURCE', 1);
375 /** Assignment module archetype */
376 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
378 /**
379  * Security token used for allowing access
380  * from external application such as web services.
381  * Scripts do not use any session, performance is relatively
382  * low because we need to load access info in each request.
383  * Scripts are executed in parallel.
384  */
385 define('EXTERNAL_TOKEN_PERMANENT', 0);
387 /**
388  * Security token used for allowing access
389  * of embedded applications, the code is executed in the
390  * active user session. Token is invalidated after user logs out.
391  * Scripts are executed serially - normal session locking is used.
392  */
393 define('EXTERNAL_TOKEN_EMBEDDED', 1);
395 /**
396  * The home page should be the site home
397  */
398 define('HOMEPAGE_SITE', 0);
399 /**
400  * The home page should be the users my page
401  */
402 define('HOMEPAGE_MY', 1);
403 /**
404  * The home page can be chosen by the user
405  */
406 define('HOMEPAGE_USER', 2);
408 /**
409  * Hub directory url (should be moodle.org)
410  */
411 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
414 /**
415  * Moodle.org url (should be moodle.org)
416  */
417 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
420 /// PARAMETER HANDLING ////////////////////////////////////////////////////
422 /**
423  * Returns a particular value for the named variable, taken from
424  * POST or GET.  If the parameter doesn't exist then an error is
425  * thrown because we require this variable.
426  *
427  * This function should be used to initialise all required values
428  * in a script that are based on parameters.  Usually it will be
429  * used like this:
430  *    $id = required_param('id', PARAM_INT);
431  *
432  * @param string $parname the name of the page parameter we want,
433  *                        default PARAM_CLEAN
434  * @param int $type expected type of parameter
435  * @return mixed
436  */
437 function required_param($parname, $type=PARAM_CLEAN) {
438     if (isset($_POST[$parname])) {       // POST has precedence
439         $param = $_POST[$parname];
440     } else if (isset($_GET[$parname])) {
441         $param = $_GET[$parname];
442     } else {
443         print_error('missingparam', '', '', $parname);
444     }
446     return clean_param($param, $type);
449 /**
450  * Returns a particular value for the named variable, taken from
451  * POST or GET, otherwise returning a given default.
452  *
453  * This function should be used to initialise all optional values
454  * in a script that are based on parameters.  Usually it will be
455  * used like this:
456  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
457  *
458  * @param string $parname the name of the page parameter we want
459  * @param mixed  $default the default value to return if nothing is found
460  * @param int $type expected type of parameter, default PARAM_CLEAN
461  * @return mixed
462  */
463 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
464     if (isset($_POST[$parname])) {       // POST has precedence
465         $param = $_POST[$parname];
466     } else if (isset($_GET[$parname])) {
467         $param = $_GET[$parname];
468     } else {
469         return $default;
470     }
472     return clean_param($param, $type);
475 /**
476  * Strict validation of parameter values, the values are only converted
477  * to requested PHP type. Internally it is using clean_param, the values
478  * before and after cleaning must be equal - otherwise
479  * an invalid_parameter_exception is thrown.
480  * Objects and classes are not accepted.
481  *
482  * @param mixed $param
483  * @param int $type PARAM_ constant
484  * @param bool $allownull are nulls valid value?
485  * @param string $debuginfo optional debug information
486  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
487  */
488 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
489     if (is_null($param)) {
490         if ($allownull == NULL_ALLOWED) {
491             return null;
492         } else {
493             throw new invalid_parameter_exception($debuginfo);
494         }
495     }
496     if (is_array($param) or is_object($param)) {
497         throw new invalid_parameter_exception($debuginfo);
498     }
500     $cleaned = clean_param($param, $type);
501     if ((string)$param !== (string)$cleaned) {
502         // conversion to string is usually lossless
503         throw new invalid_parameter_exception($debuginfo);
504     }
506     return $cleaned;
509 /**
510  * Used by {@link optional_param()} and {@link required_param()} to
511  * clean the variables and/or cast to specific types, based on
512  * an options field.
513  * <code>
514  * $course->format = clean_param($course->format, PARAM_ALPHA);
515  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
516  * </code>
517  *
518  * @param mixed $param the variable we are cleaning
519  * @param int $type expected format of param after cleaning.
520  * @return mixed
521  */
522 function clean_param($param, $type) {
524     global $CFG;
526     if (is_array($param)) {              // Let's loop
527         $newparam = array();
528         foreach ($param as $key => $value) {
529             $newparam[$key] = clean_param($value, $type);
530         }
531         return $newparam;
532     }
534     switch ($type) {
535         case PARAM_RAW:          // no cleaning at all
536             return $param;
538         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
539             if (is_numeric($param)) {
540                 return $param;
541             }
542             return clean_text($param);     // Sweep for scripts, etc
544         case PARAM_CLEANHTML:    // prepare html fragment for display, do not store it into db!!
545             $param = clean_text($param);     // Sweep for scripts, etc
546             return trim($param);
548         case PARAM_INT:
549             return (int)$param;  // Convert to integer
551         case PARAM_FLOAT:
552         case PARAM_NUMBER:
553             return (float)$param;  // Convert to float
555         case PARAM_ALPHA:        // Remove everything not a-z
556             return preg_replace('/[^a-zA-Z]/i', '', $param);
558         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
559             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
561         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
562             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
564         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
565             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
567         case PARAM_SEQUENCE:     // Remove everything not 0-9,
568             return preg_replace('/[^0-9,]/i', '', $param);
570         case PARAM_BOOL:         // Convert to 1 or 0
571             $tempstr = strtolower($param);
572             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
573                 $param = 1;
574             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
575                 $param = 0;
576             } else {
577                 $param = empty($param) ? 0 : 1;
578             }
579             return $param;
581         case PARAM_NOTAGS:       // Strip all tags
582             return strip_tags($param);
584         case PARAM_TEXT:    // leave only tags needed for multilang
585             return clean_param(strip_tags($param, '<lang><span>'), PARAM_CLEAN);
587         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
588             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
590         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
591             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
593         case PARAM_FILE:         // Strip all suspicious characters from filename
594             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
595             $param = preg_replace('~\.\.+~', '', $param);
596             if ($param === '.') {
597                 $param = '';
598             }
599             return $param;
601         case PARAM_PATH:         // Strip all suspicious characters from file path
602             $param = str_replace('\\', '/', $param);
603             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
604             $param = preg_replace('~\.\.+~', '', $param);
605             $param = preg_replace('~//+~', '/', $param);
606             return preg_replace('~/(\./)+~', '/', $param);
608         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
609             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
610             // match ipv4 dotted quad
611             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
612                 // confirm values are ok
613                 if ( $match[0] > 255
614                      || $match[1] > 255
615                      || $match[3] > 255
616                      || $match[4] > 255 ) {
617                     // hmmm, what kind of dotted quad is this?
618                     $param = '';
619                 }
620             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
621                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
622                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
623                        ) {
624                 // all is ok - $param is respected
625             } else {
626                 // all is not ok...
627                 $param='';
628             }
629             return $param;
631         case PARAM_URL:          // allow safe ftp, http, mailto urls
632             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
633             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
634                 // all is ok, param is respected
635             } else {
636                 $param =''; // not really ok
637             }
638             return $param;
640         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
641             $param = clean_param($param, PARAM_URL);
642             if (!empty($param)) {
643                 if (preg_match(':^/:', $param)) {
644                     // root-relative, ok!
645                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
646                     // absolute, and matches our wwwroot
647                 } else {
648                     // relative - let's make sure there are no tricks
649                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
650                         // looks ok.
651                     } else {
652                         $param = '';
653                     }
654                 }
655             }
656             return $param;
658         case PARAM_PEM:
659             $param = trim($param);
660             // PEM formatted strings may contain letters/numbers and the symbols
661             // forward slash: /
662             // plus sign:     +
663             // equal sign:    =
664             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
665             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
666                 list($wholething, $body) = $matches;
667                 unset($wholething, $matches);
668                 $b64 = clean_param($body, PARAM_BASE64);
669                 if (!empty($b64)) {
670                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
671                 } else {
672                     return '';
673                 }
674             }
675             return '';
677         case PARAM_BASE64:
678             if (!empty($param)) {
679                 // PEM formatted strings may contain letters/numbers and the symbols
680                 // forward slash: /
681                 // plus sign:     +
682                 // equal sign:    =
683                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
684                     return '';
685                 }
686                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
687                 // Each line of base64 encoded data must be 64 characters in
688                 // length, except for the last line which may be less than (or
689                 // equal to) 64 characters long.
690                 for ($i=0, $j=count($lines); $i < $j; $i++) {
691                     if ($i + 1 == $j) {
692                         if (64 < strlen($lines[$i])) {
693                             return '';
694                         }
695                         continue;
696                     }
698                     if (64 != strlen($lines[$i])) {
699                         return '';
700                     }
701                 }
702                 return implode("\n",$lines);
703             } else {
704                 return '';
705             }
707         case PARAM_TAG:
708             //as long as magic_quotes_gpc is used, a backslash will be a
709             //problem, so remove *all* backslash.
710             //$param = str_replace('\\', '', $param);
711             //remove some nasties
712             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
713             //convert many whitespace chars into one
714             $param = preg_replace('/\s+/', ' ', $param);
715             $textlib = textlib_get_instance();
716             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
717             return $param;
720         case PARAM_TAGLIST:
721             $tags = explode(',', $param);
722             $result = array();
723             foreach ($tags as $tag) {
724                 $res = clean_param($tag, PARAM_TAG);
725                 if ($res !== '') {
726                     $result[] = $res;
727                 }
728             }
729             if ($result) {
730                 return implode(',', $result);
731             } else {
732                 return '';
733             }
735         case PARAM_CAPABILITY:
736             if (get_capability_info($param)) {
737                 return $param;
738             } else {
739                 return '';
740             }
742         case PARAM_PERMISSION:
743             $param = (int)$param;
744             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
745                 return $param;
746             } else {
747                 return CAP_INHERIT;
748             }
750         case PARAM_AUTH:
751             $param = clean_param($param, PARAM_SAFEDIR);
752             if (exists_auth_plugin($param)) {
753                 return $param;
754             } else {
755                 return '';
756             }
758         case PARAM_LANG:
759             $param = clean_param($param, PARAM_SAFEDIR);
760             if (get_string_manager()->translation_exists($param)) {
761                 return $param;
762             } else {
763                 return ''; // Specified language is not installed or param malformed
764             }
766         case PARAM_THEME:
767             $param = clean_param($param, PARAM_SAFEDIR);
768             if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
769                 return $param;
770             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
771                 return $param;
772             } else {
773                 return '';  // Specified theme is not installed
774             }
776         case PARAM_USERNAME:
777             $param = str_replace(" " , "", $param);
778             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
779             if (empty($CFG->extendedusernamechars)) {
780                 // regular expression, eliminate all chars EXCEPT:
781                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
782                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
783             }
784             return $param;
786         case PARAM_EMAIL:
787             if (validate_email($param)) {
788                 return $param;
789             } else {
790                 return '';
791             }
793         case PARAM_STRINGID:
794             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
795                 return $param;
796             } else {
797                 return '';
798             }
800         default:                 // throw error, switched parameters in optional_param or another serious problem
801             print_error("unknownparamtype", '', '', $type);
802     }
805 /**
806  * Return true if given value is integer or string with integer value
807  *
808  * @param mixed $value String or Int
809  * @return bool true if number, false if not
810  */
811 function is_number($value) {
812     if (is_int($value)) {
813         return true;
814     } else if (is_string($value)) {
815         return ((string)(int)$value) === $value;
816     } else {
817         return false;
818     }
821 /**
822  * Returns host part from url
823  * @param string $url full url
824  * @return string host, null if not found
825  */
826 function get_host_from_url($url) {
827     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
828     if ($matches) {
829         return $matches[1];
830     }
831     return null;
834 /**
835  * Tests whether anything was returned by text editor
836  *
837  * This function is useful for testing whether something you got back from
838  * the HTML editor actually contains anything. Sometimes the HTML editor
839  * appear to be empty, but actually you get back a <br> tag or something.
840  *
841  * @param string $string a string containing HTML.
842  * @return boolean does the string contain any actual content - that is text,
843  * images, objects, etc.
844  */
845 function html_is_blank($string) {
846     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
849 /**
850  * Set a key in global configuration
851  *
852  * Set a key/value pair in both this session's {@link $CFG} global variable
853  * and in the 'config' database table for future sessions.
854  *
855  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
856  * In that case it doesn't affect $CFG.
857  *
858  * A NULL value will delete the entry.
859  *
860  * @global object
861  * @global object
862  * @param string $name the key to set
863  * @param string $value the value to set (without magic quotes)
864  * @param string $plugin (optional) the plugin scope, default NULL
865  * @return bool true or exception
866  */
867 function set_config($name, $value, $plugin=NULL) {
868     global $CFG, $DB;
870     if (empty($plugin)) {
871         if (!array_key_exists($name, $CFG->config_php_settings)) {
872             // So it's defined for this invocation at least
873             if (is_null($value)) {
874                 unset($CFG->$name);
875             } else {
876                 $CFG->$name = (string)$value; // settings from db are always strings
877             }
878         }
880         if ($DB->get_field('config', 'name', array('name'=>$name))) {
881             if ($value === null) {
882                 $DB->delete_records('config', array('name'=>$name));
883             } else {
884                 $DB->set_field('config', 'value', $value, array('name'=>$name));
885             }
886         } else {
887             if ($value !== null) {
888                 $config = new object();
889                 $config->name  = $name;
890                 $config->value = $value;
891                 $DB->insert_record('config', $config, false);
892             }
893         }
895     } else { // plugin scope
896         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
897             if ($value===null) {
898                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
899             } else {
900                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
901             }
902         } else {
903             if ($value !== null) {
904                 $config = new object();
905                 $config->plugin = $plugin;
906                 $config->name   = $name;
907                 $config->value  = $value;
908                 $DB->insert_record('config_plugins', $config, false);
909             }
910         }
911     }
913     return true;
916 /**
917  * Get configuration values from the global config table
918  * or the config_plugins table.
919  *
920  * If called with one parameter, it will load all the config
921  * variables for one plugin, and return them as an object.
922  *
923  * If called with 2 parameters it will return a string single
924  * value or false if the value is not found.
925  *
926  * @param string $plugin full component name
927  * @param string $name default NULL
928  * @return mixed hash-like object or single value, return false no config found
929  */
930 function get_config($plugin, $name = NULL) {
931     global $CFG, $DB;
933     // normalise component name
934     if ($plugin === 'moodle' or $plugin === 'core') {
935         $plugin = NULL;
936     }
938     if (!empty($name)) { // the user is asking for a specific value
939         if (!empty($plugin)) {
940             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
941                 // setting forced in config file
942                 return $CFG->forced_plugin_settings[$plugin][$name];
943             } else {
944                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
945             }
946         } else {
947             if (array_key_exists($name, $CFG->config_php_settings)) {
948                 // setting force in config file
949                 return $CFG->config_php_settings[$name];
950             } else {
951                 return $DB->get_field('config', 'value', array('name'=>$name));
952             }
953         }
954     }
956     // the user is after a recordset
957     if ($plugin) {
958         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
959         if (isset($CFG->forced_plugin_settings[$plugin])) {
960             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
961                 if (is_null($v) or is_array($v) or is_object($v)) {
962                     // we do not want any extra mess here, just real settings that could be saved in db
963                     unset($localcfg[$n]);
964                 } else {
965                     //convert to string as if it went through the DB
966                     $localcfg[$n] = (string)$v;
967                 }
968             }
969         }
970         return (object)$localcfg;
972     } else {
973         // this part is not really used any more, but anyway...
974         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
975         foreach($CFG->config_php_settings as $n=>$v) {
976             if (is_null($v) or is_array($v) or is_object($v)) {
977                 // we do not want any extra mess here, just real settings that could be saved in db
978                 unset($localcfg[$n]);
979             } else {
980                 //convert to string as if it went through the DB
981                 $localcfg[$n] = (string)$v;
982             }
983         }
984         return (object)$localcfg;
985     }
988 /**
989  * Removes a key from global configuration
990  *
991  * @param string $name the key to set
992  * @param string $plugin (optional) the plugin scope
993  * @global object
994  * @return boolean whether the operation succeeded.
995  */
996 function unset_config($name, $plugin=NULL) {
997     global $CFG, $DB;
999     if (empty($plugin)) {
1000         unset($CFG->$name);
1001         $DB->delete_records('config', array('name'=>$name));
1002     } else {
1003         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1004     }
1006     return true;
1009 /**
1010  * Remove all the config variables for a given plugin.
1011  *
1012  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1013  * @return boolean whether the operation succeeded.
1014  */
1015 function unset_all_config_for_plugin($plugin) {
1016     global $DB;
1017     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1018     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
1019     return true;
1022 /**
1023  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1024  *
1025  * All users are verified if they still have the necessary capability.
1026  *
1027  * @param string $value the value of the config setting.
1028  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1029  * @param bool $include admins, include administrators
1030  * @return array of user objects.
1031  */
1032 function get_users_from_config($value, $capability, $includeadmins = true) {
1033     global $CFG, $DB;
1035     if (empty($value) or $value === '$@NONE@$') {
1036         return array();
1037     }
1039     // we have to make sure that users still have the necessary capability,
1040     // it should be faster to fetch them all first and then test if they are present
1041     // instead of validating them one-by-one
1042     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1043     if ($includeadmins) {
1044         $admins = get_admins();
1045         foreach ($admins as $admin) {
1046             $users[$admin->id] = $admin;
1047         }
1048     }
1050     if ($value === '$@ALL@$') {
1051         return $users;
1052     }
1054     $result = array(); // result in correct order
1055     $allowed = explode(',', $value);
1056     foreach ($allowed as $uid) {
1057         if (isset($users[$uid])) {
1058             $user = $users[$uid];
1059             $result[$user->id] = $user;
1060         }
1061     }
1063     return $result;
1067 /**
1068  * Invalidates browser caches and cached data in temp
1069  * @return void
1070  */
1071 function purge_all_caches() {
1072     global $CFG;
1074     reset_text_filters_cache();
1075     js_reset_all_caches();
1076     theme_reset_all_caches();
1077     get_string_manager()->reset_caches();
1079     // purge all other caches: rss, simplepie, etc.
1080     remove_dir($CFG->dataroot.'/cache', true);
1082     // some more diagnostics in case site is misconfigured
1083     if (!check_dir_exists($CFG->dataroot.'/cache', true, true)) {
1084         debugging('Can not create cache directory, please check permissions in dataroot.');
1085     } else if (!is_writeable($CFG->dataroot.'/cache')) {
1086         debugging('Cache directory is not writeable, please verify permissions in dataroot.');
1087     }
1089     clearstatcache();
1092 /**
1093  * Get volatile flags
1094  *
1095  * @param string $type
1096  * @param int    $changedsince default null
1097  * @return records array
1098  */
1099 function get_cache_flags($type, $changedsince=NULL) {
1100     global $DB;
1102     $params = array('type'=>$type, 'expiry'=>time());
1103     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1104     if ($changedsince !== NULL) {
1105         $params['changedsince'] = $changedsince;
1106         $sqlwhere .= " AND timemodified > :changedsince";
1107     }
1108     $cf = array();
1110     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1111         foreach ($flags as $flag) {
1112             $cf[$flag->name] = $flag->value;
1113         }
1114     }
1115     return $cf;
1118 /**
1119  * Get volatile flags
1120  *
1121  * @param string $type
1122  * @param string $name
1123  * @param int    $changedsince default null
1124  * @return records array
1125  */
1126 function get_cache_flag($type, $name, $changedsince=NULL) {
1127     global $DB;
1129     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1131     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1132     if ($changedsince !== NULL) {
1133         $params['changedsince'] = $changedsince;
1134         $sqlwhere .= " AND timemodified > :changedsince";
1135     }
1137     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1140 /**
1141  * Set a volatile flag
1142  *
1143  * @param string $type the "type" namespace for the key
1144  * @param string $name the key to set
1145  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1146  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1147  * @return bool Always returns true
1148  */
1149 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1150     global $DB;
1152     $timemodified = time();
1153     if ($expiry===NULL || $expiry < $timemodified) {
1154         $expiry = $timemodified + 24 * 60 * 60;
1155     } else {
1156         $expiry = (int)$expiry;
1157     }
1159     if ($value === NULL) {
1160         unset_cache_flag($type,$name);
1161         return true;
1162     }
1164     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potentail problem in DEBUG_DEVELOPER
1165         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1166             return true; //no need to update; helps rcache too
1167         }
1168         $f->value        = $value;
1169         $f->expiry       = $expiry;
1170         $f->timemodified = $timemodified;
1171         $DB->update_record('cache_flags', $f);
1172     } else {
1173         $f = new object();
1174         $f->flagtype     = $type;
1175         $f->name         = $name;
1176         $f->value        = $value;
1177         $f->expiry       = $expiry;
1178         $f->timemodified = $timemodified;
1179         $DB->insert_record('cache_flags', $f);
1180     }
1181     return true;
1184 /**
1185  * Removes a single volatile flag
1186  *
1187  * @global object
1188  * @param string $type the "type" namespace for the key
1189  * @param string $name the key to set
1190  * @return bool
1191  */
1192 function unset_cache_flag($type, $name) {
1193     global $DB;
1194     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1195     return true;
1198 /**
1199  * Garbage-collect volatile flags
1200  *
1201  * @return bool Always returns true
1202  */
1203 function gc_cache_flags() {
1204     global $DB;
1205     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1206     return true;
1209 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1211 /**
1212  * Refresh current $USER session global variable with all their current preferences.
1213  *
1214  * @global object
1215  * @param mixed $time default null
1216  * @return void
1217  */
1218 function check_user_preferences_loaded($time = null) {
1219     global $USER, $DB;
1220     static $timenow = null; // Static cache, so we only check up-to-dateness once per request.
1222     if (!empty($USER->preference) && isset($USER->preference['_lastloaded'])) {
1223         // Already loaded. Are we up to date?
1225         if (is_null($timenow) || (!is_null($time) && $time != $timenow)) {
1226             $timenow = time();
1227             if (!get_cache_flag('userpreferenceschanged', $USER->id, $USER->preference['_lastloaded'])) {
1228                 // We are up-to-date.
1229                 return;
1230             }
1231         } else {
1232             // Already checked for up-to-date-ness.
1233             return;
1234         }
1235     }
1237     // OK, so we have to reload. Reset preference
1238     $USER->preference = array();
1240     if (!isloggedin() or isguestuser()) {
1241         // No permanent storage for not-logged-in user and guest
1243     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
1244         foreach ($preferences as $preference) {
1245             $USER->preference[$preference->name] = $preference->value;
1246         }
1247     }
1249     $USER->preference['_lastloaded'] = $timenow;
1252 /**
1253  * Called from set/delete_user_preferences, so that the prefs can be correctly reloaded.
1254  *
1255  * @global object
1256  * @global object
1257  * @param integer $userid the user whose prefs were changed.
1258  */
1259 function mark_user_preferences_changed($userid) {
1260     global $CFG, $USER;
1261     if ($userid == $USER->id) {
1262         check_user_preferences_loaded(time());
1263     }
1264     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1267 /**
1268  * Sets a preference for the current user
1269  *
1270  * Optionally, can set a preference for a different user object
1271  *
1272  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
1273  *
1274  * @global object
1275  * @global object
1276  * @param string $name The key to set as preference for the specified user
1277  * @param string $value The value to set for the $name key in the specified user's record
1278  * @param int $otheruserid A moodle user ID, default null
1279  * @return bool
1280  */
1281 function set_user_preference($name, $value, $otheruserid=NULL) {
1282     global $USER, $DB;
1284     if (empty($name)) {
1285         return false;
1286     }
1288     $nostore = false;
1289     if (empty($otheruserid)){
1290         if (!isloggedin() or isguestuser()) {
1291             $nostore = true;
1292         }
1293         $userid = $USER->id;
1294     } else {
1295         if (isguestuser($otheruserid)) {
1296             $nostore = true;
1297         }
1298         $userid = $otheruserid;
1299     }
1301     if ($nostore) {
1302         // no permanent storage for not-logged-in user and guest
1304     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
1305         if ($preference->value === $value) {
1306             return true;
1307         }
1308         $DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id));
1310     } else {
1311         $preference = new object();
1312         $preference->userid = $userid;
1313         $preference->name   = $name;
1314         $preference->value  = (string)$value;
1315         $DB->insert_record('user_preferences', $preference);
1316     }
1318     mark_user_preferences_changed($userid);
1319     // update value in USER session if needed
1320     if ($userid == $USER->id) {
1321         $USER->preference[$name] = (string)$value;
1322         $USER->preference['_lastloaded'] = time();
1323     }
1325     return true;
1328 /**
1329  * Sets a whole array of preferences for the current user
1330  *
1331  * @param array $prefarray An array of key/value pairs to be set
1332  * @param int $otheruserid A moodle user ID
1333  * @return bool
1334  */
1335 function set_user_preferences($prefarray, $otheruserid=NULL) {
1337     if (!is_array($prefarray) or empty($prefarray)) {
1338         return false;
1339     }
1341     foreach ($prefarray as $name => $value) {
1342         set_user_preference($name, $value, $otheruserid);
1343     }
1344     return true;
1347 /**
1348  * Unsets a preference completely by deleting it from the database
1349  *
1350  * Optionally, can set a preference for a different user id
1351  *
1352  * @global object
1353  * @param string  $name The key to unset as preference for the specified user
1354  * @param int $otheruserid A moodle user ID
1355  */
1356 function unset_user_preference($name, $otheruserid=NULL) {
1357     global $USER, $DB;
1359     if (empty($otheruserid)){
1360         $userid = $USER->id;
1361         check_user_preferences_loaded();
1362     } else {
1363         $userid = $otheruserid;
1364     }
1366     //Then from DB
1367     $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
1369     mark_user_preferences_changed($userid);
1370     //Delete the preference from $USER if needed
1371     if ($userid == $USER->id) {
1372         unset($USER->preference[$name]);
1373         $USER->preference['_lastloaded'] = time();
1374     }
1376     return true;
1379 /**
1380  * Used to fetch user preference(s)
1381  *
1382  * If no arguments are supplied this function will return
1383  * all of the current user preferences as an array.
1384  *
1385  * If a name is specified then this function
1386  * attempts to return that particular preference value.  If
1387  * none is found, then the optional value $default is returned,
1388  * otherwise NULL.
1389  *
1390  * @global object
1391  * @global object
1392  * @param string $name Name of the key to use in finding a preference value
1393  * @param string $default Value to be returned if the $name key is not set in the user preferences
1394  * @param int $otheruserid A moodle user ID
1395  * @return string
1396  */
1397 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1398     global $USER, $DB;
1400     if (empty($otheruserid) || (isloggedin() && ($USER->id == $otheruserid))){
1401         check_user_preferences_loaded();
1403         if (empty($name)) {
1404             return $USER->preference; // All values
1405         } else if (array_key_exists($name, $USER->preference)) {
1406             return $USER->preference[$name]; // The single value
1407         } else {
1408             return $default; // Default value (or NULL)
1409         }
1411     } else {
1412         if (empty($name)) {
1413             return $DB->get_records_menu('user_preferences', array('userid'=>$otheruserid), '', 'name,value'); // All values
1414         } else if ($value = $DB->get_field('user_preferences', 'value', array('userid'=>$otheruserid, 'name'=>$name))) {
1415             return $value; // The single value
1416         } else {
1417             return $default; // Default value (or NULL)
1418         }
1419     }
1422 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1424 /**
1425  * Given date parts in user time produce a GMT timestamp.
1426  *
1427  * @todo Finish documenting this function
1428  * @param int $year The year part to create timestamp of
1429  * @param int $month The month part to create timestamp of
1430  * @param int $day The day part to create timestamp of
1431  * @param int $hour The hour part to create timestamp of
1432  * @param int $minute The minute part to create timestamp of
1433  * @param int $second The second part to create timestamp of
1434  * @param float $timezone Timezone modifier
1435  * @param bool $applydst Toggle Daylight Saving Time, default true
1436  * @return int timestamp
1437  */
1438 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1440     $strtimezone = NULL;
1441     if (!is_numeric($timezone)) {
1442         $strtimezone = $timezone;
1443     }
1445     $timezone = get_user_timezone_offset($timezone);
1447     if (abs($timezone) > 13) {
1448         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1449     } else {
1450         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1451         $time = usertime($time, $timezone);
1452         if($applydst) {
1453             $time -= dst_offset_on($time, $strtimezone);
1454         }
1455     }
1457     return $time;
1461 /**
1462  * Format a date/time (seconds) as weeks, days, hours etc as needed
1463  *
1464  * Given an amount of time in seconds, returns string
1465  * formatted nicely as weeks, days, hours etc as needed
1466  *
1467  * @uses MINSECS
1468  * @uses HOURSECS
1469  * @uses DAYSECS
1470  * @uses YEARSECS
1471  * @param int $totalsecs Time in seconds
1472  * @param object $str Should be a time object
1473  * @return string A nicely formatted date/time string
1474  */
1475  function format_time($totalsecs, $str=NULL) {
1477     $totalsecs = abs($totalsecs);
1479     if (!$str) {  // Create the str structure the slow way
1480         $str->day   = get_string('day');
1481         $str->days  = get_string('days');
1482         $str->hour  = get_string('hour');
1483         $str->hours = get_string('hours');
1484         $str->min   = get_string('min');
1485         $str->mins  = get_string('mins');
1486         $str->sec   = get_string('sec');
1487         $str->secs  = get_string('secs');
1488         $str->year  = get_string('year');
1489         $str->years = get_string('years');
1490     }
1493     $years     = floor($totalsecs/YEARSECS);
1494     $remainder = $totalsecs - ($years*YEARSECS);
1495     $days      = floor($remainder/DAYSECS);
1496     $remainder = $totalsecs - ($days*DAYSECS);
1497     $hours     = floor($remainder/HOURSECS);
1498     $remainder = $remainder - ($hours*HOURSECS);
1499     $mins      = floor($remainder/MINSECS);
1500     $secs      = $remainder - ($mins*MINSECS);
1502     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1503     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1504     $sh = ($hours == 1) ? $str->hour : $str->hours;
1505     $sd = ($days == 1)  ? $str->day  : $str->days;
1506     $sy = ($years == 1)  ? $str->year  : $str->years;
1508     $oyears = '';
1509     $odays = '';
1510     $ohours = '';
1511     $omins = '';
1512     $osecs = '';
1514     if ($years)  $oyears  = $years .' '. $sy;
1515     if ($days)  $odays  = $days .' '. $sd;
1516     if ($hours) $ohours = $hours .' '. $sh;
1517     if ($mins)  $omins  = $mins .' '. $sm;
1518     if ($secs)  $osecs  = $secs .' '. $ss;
1520     if ($years) return trim($oyears .' '. $odays);
1521     if ($days)  return trim($odays .' '. $ohours);
1522     if ($hours) return trim($ohours .' '. $omins);
1523     if ($mins)  return trim($omins .' '. $osecs);
1524     if ($secs)  return $osecs;
1525     return get_string('now');
1528 /**
1529  * Returns a formatted string that represents a date in user time
1530  *
1531  * Returns a formatted string that represents a date in user time
1532  * <b>WARNING: note that the format is for strftime(), not date().</b>
1533  * Because of a bug in most Windows time libraries, we can't use
1534  * the nicer %e, so we have to use %d which has leading zeroes.
1535  * A lot of the fuss in the function is just getting rid of these leading
1536  * zeroes as efficiently as possible.
1537  *
1538  * If parameter fixday = true (default), then take off leading
1539  * zero from %d, else maintain it.
1540  *
1541  * @param int $date the timestamp in UTC, as obtained from the database.
1542  * @param string $format strftime format. You should probably get this using
1543  *      get_string('strftime...', 'langconfig');
1544  * @param float $timezone by default, uses the user's time zone.
1545  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1546  *      If false then the leading zero is maintained.
1547  * @return string the formatted date/time.
1548  */
1549 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1551     global $CFG;
1553     $strtimezone = NULL;
1554     if (!is_numeric($timezone)) {
1555         $strtimezone = $timezone;
1556     }
1558     if (empty($format)) {
1559         $format = get_string('strftimedaydatetime', 'langconfig');
1560     }
1562     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1563         $fixday = false;
1564     } else if ($fixday) {
1565         $formatnoday = str_replace('%d', 'DD', $format);
1566         $fixday = ($formatnoday != $format);
1567     }
1569     $date += dst_offset_on($date, $strtimezone);
1571     $timezone = get_user_timezone_offset($timezone);
1573     if (abs($timezone) > 13) {   /// Server time
1574         if ($fixday) {
1575             $datestring = strftime($formatnoday, $date);
1576             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1577             $datestring = str_replace('DD', $daystring, $datestring);
1578         } else {
1579             $datestring = strftime($format, $date);
1580         }
1581     } else {
1582         $date += (int)($timezone * 3600);
1583         if ($fixday) {
1584             $datestring = gmstrftime($formatnoday, $date);
1585             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1586             $datestring = str_replace('DD', $daystring, $datestring);
1587         } else {
1588             $datestring = gmstrftime($format, $date);
1589         }
1590     }
1592 /// If we are running under Windows convert from windows encoding to UTF-8
1593 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1595    if ($CFG->ostype == 'WINDOWS') {
1596        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1597            $textlib = textlib_get_instance();
1598            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1599        }
1600    }
1602     return $datestring;
1605 /**
1606  * Given a $time timestamp in GMT (seconds since epoch),
1607  * returns an array that represents the date in user time
1608  *
1609  * @todo Finish documenting this function
1610  * @uses HOURSECS
1611  * @param int $time Timestamp in GMT
1612  * @param float $timezone ?
1613  * @return array An array that represents the date in user time
1614  */
1615 function usergetdate($time, $timezone=99) {
1617     $strtimezone = NULL;
1618     if (!is_numeric($timezone)) {
1619         $strtimezone = $timezone;
1620     }
1622     $timezone = get_user_timezone_offset($timezone);
1624     if (abs($timezone) > 13) {    // Server time
1625         return getdate($time);
1626     }
1628     // There is no gmgetdate so we use gmdate instead
1629     $time += dst_offset_on($time, $strtimezone);
1630     $time += intval((float)$timezone * HOURSECS);
1632     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1634     //be careful to ensure the returned array matches that produced by getdate() above
1635     list(
1636         $getdate['month'],
1637         $getdate['weekday'],
1638         $getdate['yday'],
1639         $getdate['year'],
1640         $getdate['mon'],
1641         $getdate['wday'],
1642         $getdate['mday'],
1643         $getdate['hours'],
1644         $getdate['minutes'],
1645         $getdate['seconds']
1646     ) = explode('_', $datestring);
1648     return $getdate;
1651 /**
1652  * Given a GMT timestamp (seconds since epoch), offsets it by
1653  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1654  *
1655  * @uses HOURSECS
1656  * @param  int $date Timestamp in GMT
1657  * @param float $timezone
1658  * @return int
1659  */
1660 function usertime($date, $timezone=99) {
1662     $timezone = get_user_timezone_offset($timezone);
1664     if (abs($timezone) > 13) {
1665         return $date;
1666     }
1667     return $date - (int)($timezone * HOURSECS);
1670 /**
1671  * Given a time, return the GMT timestamp of the most recent midnight
1672  * for the current user.
1673  *
1674  * @param int $date Timestamp in GMT
1675  * @param float $timezone Defaults to user's timezone
1676  * @return int Returns a GMT timestamp
1677  */
1678 function usergetmidnight($date, $timezone=99) {
1680     $userdate = usergetdate($date, $timezone);
1682     // Time of midnight of this user's day, in GMT
1683     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1687 /**
1688  * Returns a string that prints the user's timezone
1689  *
1690  * @param float $timezone The user's timezone
1691  * @return string
1692  */
1693 function usertimezone($timezone=99) {
1695     $tz = get_user_timezone($timezone);
1697     if (!is_float($tz)) {
1698         return $tz;
1699     }
1701     if(abs($tz) > 13) { // Server time
1702         return get_string('serverlocaltime');
1703     }
1705     if($tz == intval($tz)) {
1706         // Don't show .0 for whole hours
1707         $tz = intval($tz);
1708     }
1710     if($tz == 0) {
1711         return 'UTC';
1712     }
1713     else if($tz > 0) {
1714         return 'UTC+'.$tz;
1715     }
1716     else {
1717         return 'UTC'.$tz;
1718     }
1722 /**
1723  * Returns a float which represents the user's timezone difference from GMT in hours
1724  * Checks various settings and picks the most dominant of those which have a value
1725  *
1726  * @global object
1727  * @global object
1728  * @param float $tz If this value is provided and not equal to 99, it will be returned as is and no other settings will be checked
1729  * @return float
1730  */
1731 function get_user_timezone_offset($tz = 99) {
1733     global $USER, $CFG;
1735     $tz = get_user_timezone($tz);
1737     if (is_float($tz)) {
1738         return $tz;
1739     } else {
1740         $tzrecord = get_timezone_record($tz);
1741         if (empty($tzrecord)) {
1742             return 99.0;
1743         }
1744         return (float)$tzrecord->gmtoff / HOURMINS;
1745     }
1748 /**
1749  * Returns an int which represents the systems's timezone difference from GMT in seconds
1750  *
1751  * @global object
1752  * @param mixed $tz timezone
1753  * @return int if found, false is timezone 99 or error
1754  */
1755 function get_timezone_offset($tz) {
1756     global $CFG;
1758     if ($tz == 99) {
1759         return false;
1760     }
1762     if (is_numeric($tz)) {
1763         return intval($tz * 60*60);
1764     }
1766     if (!$tzrecord = get_timezone_record($tz)) {
1767         return false;
1768     }
1769     return intval($tzrecord->gmtoff * 60);
1772 /**
1773  * Returns a float or a string which denotes the user's timezone
1774  * A float value means that a simple offset from GMT is used, while a string (it will be the name of a timezone in the database)
1775  * means that for this timezone there are also DST rules to be taken into account
1776  * Checks various settings and picks the most dominant of those which have a value
1777  *
1778  * @global object
1779  * @global object
1780  * @param float $tz If this value is provided and not equal to 99, it will be returned as is and no other settings will be checked
1781  * @return mixed
1782  */
1783 function get_user_timezone($tz = 99) {
1784     global $USER, $CFG;
1786     $timezones = array(
1787         $tz,
1788         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1789         isset($USER->timezone) ? $USER->timezone : 99,
1790         isset($CFG->timezone) ? $CFG->timezone : 99,
1791         );
1793     $tz = 99;
1795     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1796         $tz = $next['value'];
1797     }
1799     return is_numeric($tz) ? (float) $tz : $tz;
1802 /**
1803  * Returns cached timezone record for given $timezonename
1804  *
1805  * @global object
1806  * @global object
1807  * @param string $timezonename
1808  * @return mixed timezonerecord object or false
1809  */
1810 function get_timezone_record($timezonename) {
1811     global $CFG, $DB;
1812     static $cache = NULL;
1814     if ($cache === NULL) {
1815         $cache = array();
1816     }
1818     if (isset($cache[$timezonename])) {
1819         return $cache[$timezonename];
1820     }
1822     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1823                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1826 /**
1827  * Build and store the users Daylight Saving Time (DST) table
1828  *
1829  * @global object
1830  * @global object
1831  * @global object
1832  * @param mixed $from_year Start year for the table, defaults to 1971
1833  * @param mixed $to_year End year for the table, defaults to 2035
1834  * @param mixed $strtimezone
1835  * @return bool
1836  */
1837 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1838     global $CFG, $SESSION, $DB;
1840     $usertz = get_user_timezone($strtimezone);
1842     if (is_float($usertz)) {
1843         // Trivial timezone, no DST
1844         return false;
1845     }
1847     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1848         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1849         unset($SESSION->dst_offsets);
1850         unset($SESSION->dst_range);
1851     }
1853     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1854         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1855         // This will be the return path most of the time, pretty light computationally
1856         return true;
1857     }
1859     // Reaching here means we either need to extend our table or create it from scratch
1861     // Remember which TZ we calculated these changes for
1862     $SESSION->dst_offsettz = $usertz;
1864     if(empty($SESSION->dst_offsets)) {
1865         // If we 're creating from scratch, put the two guard elements in there
1866         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1867     }
1868     if(empty($SESSION->dst_range)) {
1869         // If creating from scratch
1870         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1871         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1873         // Fill in the array with the extra years we need to process
1874         $yearstoprocess = array();
1875         for($i = $from; $i <= $to; ++$i) {
1876             $yearstoprocess[] = $i;
1877         }
1879         // Take note of which years we have processed for future calls
1880         $SESSION->dst_range = array($from, $to);
1881     }
1882     else {
1883         // If needing to extend the table, do the same
1884         $yearstoprocess = array();
1886         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1887         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1889         if($from < $SESSION->dst_range[0]) {
1890             // Take note of which years we need to process and then note that we have processed them for future calls
1891             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1892                 $yearstoprocess[] = $i;
1893             }
1894             $SESSION->dst_range[0] = $from;
1895         }
1896         if($to > $SESSION->dst_range[1]) {
1897             // Take note of which years we need to process and then note that we have processed them for future calls
1898             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1899                 $yearstoprocess[] = $i;
1900             }
1901             $SESSION->dst_range[1] = $to;
1902         }
1903     }
1905     if(empty($yearstoprocess)) {
1906         // This means that there was a call requesting a SMALLER range than we have already calculated
1907         return true;
1908     }
1910     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1911     // Also, the array is sorted in descending timestamp order!
1913     // Get DB data
1915     static $presets_cache = array();
1916     if (!isset($presets_cache[$usertz])) {
1917         $presets_cache[$usertz] = $DB->get_records('timezone', array('name'=>$usertz), 'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, std_startday, std_weekday, std_skipweeks, std_time');
1918     }
1919     if(empty($presets_cache[$usertz])) {
1920         return false;
1921     }
1923     // Remove ending guard (first element of the array)
1924     reset($SESSION->dst_offsets);
1925     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1927     // Add all required change timestamps
1928     foreach($yearstoprocess as $y) {
1929         // Find the record which is in effect for the year $y
1930         foreach($presets_cache[$usertz] as $year => $preset) {
1931             if($year <= $y) {
1932                 break;
1933             }
1934         }
1936         $changes = dst_changes_for_year($y, $preset);
1938         if($changes === NULL) {
1939             continue;
1940         }
1941         if($changes['dst'] != 0) {
1942             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1943         }
1944         if($changes['std'] != 0) {
1945             $SESSION->dst_offsets[$changes['std']] = 0;
1946         }
1947     }
1949     // Put in a guard element at the top
1950     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1951     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1953     // Sort again
1954     krsort($SESSION->dst_offsets);
1956     return true;
1959 /**
1960  * Calculates the required DST change and returns a Timestamp Array
1961  *
1962  * @uses HOURSECS
1963  * @uses MINSECS
1964  * @param mixed $year Int or String Year to focus on
1965  * @param object $timezone Instatiated Timezone object
1966  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
1967  */
1968 function dst_changes_for_year($year, $timezone) {
1970     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1971         return NULL;
1972     }
1974     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1975     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1977     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1978     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1980     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1981     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1983     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1984     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1985     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1987     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1988     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1990     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1993 /**
1994  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
1995  *
1996  * @global object
1997  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
1998  * @return int
1999  */
2000 function dst_offset_on($time, $strtimezone = NULL) {
2001     global $SESSION;
2003     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2004         return 0;
2005     }
2007     reset($SESSION->dst_offsets);
2008     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2009         if($from <= $time) {
2010             break;
2011         }
2012     }
2014     // This is the normal return path
2015     if($offset !== NULL) {
2016         return $offset;
2017     }
2019     // Reaching this point means we haven't calculated far enough, do it now:
2020     // Calculate extra DST changes if needed and recurse. The recursion always
2021     // moves toward the stopping condition, so will always end.
2023     if($from == 0) {
2024         // We need a year smaller than $SESSION->dst_range[0]
2025         if($SESSION->dst_range[0] == 1971) {
2026             return 0;
2027         }
2028         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2029         return dst_offset_on($time, $strtimezone);
2030     }
2031     else {
2032         // We need a year larger than $SESSION->dst_range[1]
2033         if($SESSION->dst_range[1] == 2035) {
2034             return 0;
2035         }
2036         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2037         return dst_offset_on($time, $strtimezone);
2038     }
2041 /**
2042  * ?
2043  *
2044  * @todo Document what this function does
2045  * @param int $startday
2046  * @param int $weekday
2047  * @param int $month
2048  * @param int $year
2049  * @return int
2050  */
2051 function find_day_in_month($startday, $weekday, $month, $year) {
2053     $daysinmonth = days_in_month($month, $year);
2055     if($weekday == -1) {
2056         // Don't care about weekday, so return:
2057         //    abs($startday) if $startday != -1
2058         //    $daysinmonth otherwise
2059         return ($startday == -1) ? $daysinmonth : abs($startday);
2060     }
2062     // From now on we 're looking for a specific weekday
2064     // Give "end of month" its actual value, since we know it
2065     if($startday == -1) {
2066         $startday = -1 * $daysinmonth;
2067     }
2069     // Starting from day $startday, the sign is the direction
2071     if($startday < 1) {
2073         $startday = abs($startday);
2074         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2076         // This is the last such weekday of the month
2077         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2078         if($lastinmonth > $daysinmonth) {
2079             $lastinmonth -= 7;
2080         }
2082         // Find the first such weekday <= $startday
2083         while($lastinmonth > $startday) {
2084             $lastinmonth -= 7;
2085         }
2087         return $lastinmonth;
2089     }
2090     else {
2092         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
2094         $diff = $weekday - $indexweekday;
2095         if($diff < 0) {
2096             $diff += 7;
2097         }
2099         // This is the first such weekday of the month equal to or after $startday
2100         $firstfromindex = $startday + $diff;
2102         return $firstfromindex;
2104     }
2107 /**
2108  * Calculate the number of days in a given month
2109  *
2110  * @param int $month The month whose day count is sought
2111  * @param int $year The year of the month whose day count is sought
2112  * @return int
2113  */
2114 function days_in_month($month, $year) {
2115    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
2118 /**
2119  * Calculate the position in the week of a specific calendar day
2120  *
2121  * @param int $day The day of the date whose position in the week is sought
2122  * @param int $month The month of the date whose position in the week is sought
2123  * @param int $year The year of the date whose position in the week is sought
2124  * @return int
2125  */
2126 function dayofweek($day, $month, $year) {
2127     // I wonder if this is any different from
2128     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2129     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
2132 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2134 /**
2135  * Returns full login url.
2136  *
2137  * @global object
2138  * @param bool $loginguest add login guest param, return false
2139  * @return string login url
2140  */
2141 function get_login_url($loginguest=false) {
2142     global $CFG;
2144     if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
2145         $loginguest = $loginguest ? '?loginguest=true' : '';
2146         $url = "$CFG->wwwroot/login/index.php$loginguest";
2148     } else {
2149         $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2150         $url = "$wwwroot/login/index.php";
2151     }
2153     return $url;
2156 /**
2157  * This function checks that the current user is logged in and has the
2158  * required privileges
2159  *
2160  * This function checks that the current user is logged in, and optionally
2161  * whether they are allowed to be in a particular course and view a particular
2162  * course module.
2163  * If they are not logged in, then it redirects them to the site login unless
2164  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2165  * case they are automatically logged in as guests.
2166  * If $courseid is given and the user is not enrolled in that course then the
2167  * user is redirected to the course enrolment page.
2168  * If $cm is given and the course module is hidden and the user is not a teacher
2169  * in the course then the user is redirected to the course home page.
2170  *
2171  * When $cm parameter specified, this function sets page layout to 'module'.
2172  * You need to change it manually later if some other layout needed.
2173  *
2174  * @param mixed $courseorid id of the course or course object
2175  * @param bool $autologinguest default true
2176  * @param object $cm course module object
2177  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2178  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2179  *             in order to keep redirects working properly. MDL-14495
2180  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2181  * @return mixed Void, exit, and die depending on path
2182  */
2183 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2184     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2186     // setup global $COURSE, themes, language and locale
2187     if (!empty($courseorid)) {
2188         if (is_object($courseorid)) {
2189             $course = $courseorid;
2190         } else if ($courseorid == SITEID) {
2191             $course = clone($SITE);
2192         } else {
2193             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2194         }
2195         if ($cm) {
2196             if ($cm->course != $course->id) {
2197                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2198             }
2199             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2200             $PAGE->set_pagelayout('incourse');
2201         } else {
2202             $PAGE->set_course($course); // set's up global $COURSE
2203         }
2204     } else {
2205         // do not touch global $COURSE via $PAGE->set_course(),
2206         // the reasons is we need to be able to call require_login() at any time!!
2207         $course = $SITE;
2208         if ($cm) {
2209             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2210         }
2211     }
2213     // If the user is not even logged in yet then make sure they are
2214     if (!isloggedin()) {
2215         //NOTE: $USER->site check was obsoleted by session test cookie,
2216         //      $USER->confirmed test is in login/index.php
2217         if ($preventredirect) {
2218             throw new require_login_exception('You are not logged in');
2219         }
2221         if ($setwantsurltome) {
2222             $SESSION->wantsurl = $FULLME;
2223         }
2224         if (!empty($_SERVER['HTTP_REFERER'])) {
2225             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2226         }
2227         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2228             if ($course->id == SITEID) {
2229                 $loginguest = true;
2230             } else {
2231                 $loginguest = false;
2232             }
2233         } else {
2234             $loginguest = false;
2235         }
2236         redirect(get_login_url($loginguest));
2237         exit; // never reached
2238     }
2240     // loginas as redirection if needed
2241     if ($course->id != SITEID and session_is_loggedinas()) {
2242         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2243             if ($USER->loginascontext->instanceid != $course->id) {
2244                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2245             }
2246         }
2247     }
2249     // check whether the user should be changing password (but only if it is REALLY them)
2250     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2251         $userauth = get_auth_plugin($USER->auth);
2252         if ($userauth->can_change_password() and !$preventredirect) {
2253             $SESSION->wantsurl = $FULLME;
2254             if ($changeurl = $userauth->change_password_url()) {
2255                 //use plugin custom url
2256                 redirect($changeurl);
2257             } else {
2258                 //use moodle internal method
2259                 if (empty($CFG->loginhttps)) {
2260                     redirect($CFG->wwwroot .'/login/change_password.php');
2261                 } else {
2262                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2263                     redirect($wwwroot .'/login/change_password.php');
2264                 }
2265             }
2266         } else {
2267             print_error('nopasswordchangeforced', 'auth');
2268         }
2269     }
2271     // Check that the user account is properly set up
2272     if (user_not_fully_set_up($USER)) {
2273         if ($preventredirect) {
2274             throw new require_login_exception('User not fully set-up');
2275         }
2276         $SESSION->wantsurl = $FULLME;
2277         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2278     }
2280     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2281     sesskey();
2283     // Do not bother admins with any formalities
2284     if (is_siteadmin()) {
2285         //set accesstime or the user will appear offline which messes up messaging
2286         user_accesstime_log($course->id);
2287         return;
2288     }
2290     // Check that the user has agreed to a site policy if there is one
2291     if (!empty($CFG->sitepolicy)) {
2292         if ($preventredirect) {
2293             throw new require_login_exception('Policy not agreed');
2294         }
2295         if (!$USER->policyagreed) {
2296             $SESSION->wantsurl = $FULLME;
2297             redirect($CFG->wwwroot .'/user/policy.php');
2298         }
2299     }
2301     // Fetch the system context, the course context, and prefetch its child contexts
2302     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2303     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2304     if ($cm) {
2305         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2306     } else {
2307         $cmcontext = null;
2308     }
2310     // If the site is currently under maintenance, then print a message
2311     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2312         if ($preventredirect) {
2313             throw new require_login_exception('Maintenance in progress');
2314         }
2316         print_maintenance_message();
2317     }
2319     // make sure the course itself is not hidden
2320     if ($course->id == SITEID) {
2321         // frontpage can not be hidden
2322     } else {
2323         if (!empty($USER->access['rsw'][$coursecontext->path])) {
2324             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2325         } else {
2326             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2327                 // originally there was also test of parent category visibility,
2328                 // BUT is was very slow in complex queries involving "my courses"
2329                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2330                 if ($preventredirect) {
2331                     throw new require_login_exception('Course is hidden');
2332                 }
2333                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2334             }
2335         }
2336     }
2338     // is the user enrolled?
2339     if ($course->id == SITEID) {
2340         // everybody is enrolled on the frontpage
2342     } else {
2343         if (session_is_loggedinas()) {
2344             // Make sure the REAL person can access this course first
2345             $realuser = session_get_realuser();
2346             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2347                 if ($preventredirect) {
2348                     throw new require_login_exception('Invalid course login-as access');
2349                 }
2350                 echo $OUTPUT->header();
2351                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2352             }
2353         }
2355         // very simple enrolment caching - changes in course setting are not reflected immediately
2356         if (!isset($USER->enrol)) {
2357             $USER->enrol = array();
2358             $USER->enrol['enrolled'] = array();
2359             $USER->enrol['tempguest'] = array();
2360         }
2362         $access = false;
2364         if (is_viewing($coursecontext, $USER)) {
2365             // ok, no need to mess with enrol
2366             $access = true;
2368         } else {
2369             if (isset($USER->enrol['enrolled'][$course->id])) {
2370                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2371                     $access = true;
2372                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2373                     $access = true;
2374                 } else {
2375                     //expired
2376                     unset($USER->enrol['enrolled'][$course->id]);
2377                 }
2378             }
2379             if (isset($USER->enrol['tempguest'][$course->id])) {
2380                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2381                     $access = true;
2382                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2383                     $access = true;
2384                 } else {
2385                     //expired
2386                     unset($USER->enrol['tempguest'][$course->id]);
2387                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2388                 }
2389             }
2391             if ($access) {
2392                 // cache ok
2393             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2394                 // active participants may always access
2395                 // TODO: refactor this into some new function
2396                 $now = time();
2397                 $sql = "SELECT MAX(ue.timeend)
2398                           FROM {user_enrolments} ue
2399                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2400                           JOIN {user} u ON u.id = ue.userid
2401                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2402                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2403                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2404                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2405                 $until = $DB->get_field_sql($sql, $params);
2406                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2407                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2408                 }
2410                 $USER->enrol['enrolled'][$course->id] = $until;
2411                 $access = true;
2413                 // remove traces of previous temp guest access
2414                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2416             } else {
2417                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2418                 $enrols = enrol_get_plugins(true);
2419                 // first ask all enabled enrol instances in course if they want to auto enrol user
2420                 foreach($instances as $instance) {
2421                     if (!isset($enrols[$instance->enrol])) {
2422                         continue;
2423                     }
2424                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2425                     if ($until !== false) {
2426                         $USER->enrol['enrolled'][$course->id] = $until;
2427                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2428                         $access = true;
2429                         break;
2430                     }
2431                 }
2432                 // if not enrolled yet try to gain temporary guest access
2433                 if (!$access) {
2434                     foreach($instances as $instance) {
2435                         if (!isset($enrols[$instance->enrol])) {
2436                             continue;
2437                         }
2438                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2439                         if ($until !== false) {
2440                             $USER->enrol['tempguest'][$course->id] = $until;
2441                             $access = true;
2442                             break;
2443                         }
2444                     }
2445                 }
2446             }
2447         }
2449         if (!$access) {
2450             if ($preventredirect) {
2451                 throw new require_login_exception('Not enrolled');
2452             }
2453             $SESSION->wantsurl = $FULLME;
2454             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2455         }
2456     }
2458     // test visibility
2459     if ($cm && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2460         if ($preventredirect) {
2461             throw new require_login_exception('Activity is hidden');
2462         }
2463         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2464     }
2466     // groupmembersonly access control
2467     if (!empty($CFG->enablegroupmembersonly) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2468         if (isguestuser() or !groups_has_membership($cm)) {
2469             if ($preventredirect) {
2470                 throw new require_login_exception('Not member of a group');
2471             }
2472             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2473         }
2474     }
2476     // Conditional activity access control
2477     if (!empty($CFG->enableavailability) and $cm) {
2478         // TODO: this is going to work with login-as-user, sorry!
2479         // We cache conditional access in session
2480         if (!isset($SESSION->conditionaccessok)) {
2481             $SESSION->conditionaccessok = array();
2482         }
2483         // If you have been allowed into the module once then you are allowed
2484         // in for rest of session, no need to do conditional checks
2485         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2486             // Get condition info (does a query for the availability table)
2487             require_once($CFG->libdir.'/conditionlib.php');
2488             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2489             // Check condition for user (this will do a query if the availability
2490             // information depends on grade or completion information)
2491             if ($ci->is_available($junk) || has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2492                 $SESSION->conditionaccessok[$cm->id] = true;
2493             } else {
2494                 print_error('activityiscurrentlyhidden');
2495             }
2496         }
2497     }
2499     // Finally access granted, update lastaccess times
2500     user_accesstime_log($course->id);
2504 /**
2505  * This function just makes sure a user is logged out.
2506  *
2507  * @global object
2508  */
2509 function require_logout() {
2510     global $USER;
2512     if (isloggedin()) {
2513         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2515         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2516         foreach($authsequence as $authname) {
2517             $authplugin = get_auth_plugin($authname);
2518             $authplugin->prelogout_hook();
2519         }
2520     }
2522     session_get_instance()->terminate_current();
2525 /**
2526  * Weaker version of require_login()
2527  *
2528  * This is a weaker version of {@link require_login()} which only requires login
2529  * when called from within a course rather than the site page, unless
2530  * the forcelogin option is turned on.
2531  * @see require_login()
2532  *
2533  * @global object
2534  * @param mixed $courseorid The course object or id in question
2535  * @param bool $autologinguest Allow autologin guests if that is wanted
2536  * @param object $cm Course activity module if known
2537  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2538  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2539  *             in order to keep redirects working properly. MDL-14495
2540  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2541  * @return void
2542  */
2543 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2544     global $CFG, $PAGE, $SITE;
2545     if (!empty($CFG->forcelogin)) {
2546         // login required for both SITE and courses
2547         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2549     } else if (!empty($cm) and !$cm->visible) {
2550         // always login for hidden activities
2551         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2553     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2554           or (!is_object($courseorid) and $courseorid == SITEID)) {
2555               //login for SITE not required
2556         if ($cm and empty($cm->visible)) {
2557             // hidden activities are not accessible without login
2558             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2559         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2560             // not-logged-in users do not have any group membership
2561             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2562         } else {
2563             // We still need to instatiate PAGE vars properly so that things
2564             // that rely on it like navigation function correctly.
2565             if (!empty($courseorid)) {
2566                 if (is_object($courseorid)) {
2567                     $course = $courseorid;
2568                 } else {
2569                     $course = clone($SITE);
2570                 }
2571                 if ($cm) {
2572                     if ($cm->course != $course->id) {
2573                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2574                     }
2575                     $PAGE->set_cm($cm, $course);
2576                     $PAGE->set_pagelayout('incourse');
2577                 } else {
2578                     $PAGE->set_course($course);
2579                 }
2580             } else {
2581                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2582                 // up properly, set them up now.
2583                 $PAGE->set_course($PAGE->course);
2584             }
2585             //TODO: verify conditional activities here
2586             user_accesstime_log(SITEID);
2587             return;
2588         }
2590     } else {
2591         // course login always required
2592         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2593     }
2596 /**
2597  * Require key login. Function terminates with error if key not found or incorrect.
2598  *
2599  * @global object
2600  * @global object
2601  * @global object
2602  * @global object
2603  * @uses NO_MOODLE_COOKIES
2604  * @uses PARAM_ALPHANUM
2605  * @param string $script unique script identifier
2606  * @param int $instance optional instance id
2607  * @return int Instance ID
2608  */
2609 function require_user_key_login($script, $instance=null) {
2610     global $USER, $SESSION, $CFG, $DB;
2612     if (!NO_MOODLE_COOKIES) {
2613         print_error('sessioncookiesdisable');
2614     }
2616 /// extra safety
2617     @session_write_close();
2619     $keyvalue = required_param('key', PARAM_ALPHANUM);
2621     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2622         print_error('invalidkey');
2623     }
2625     if (!empty($key->validuntil) and $key->validuntil < time()) {
2626         print_error('expiredkey');
2627     }
2629     if ($key->iprestriction) {
2630         $remoteaddr = getremoteaddr(null);
2631         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2632             print_error('ipmismatch');
2633         }
2634     }
2636     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2637         print_error('invaliduserid');
2638     }
2640 /// emulate normal session
2641     session_set_user($user);
2643 /// note we are not using normal login
2644     if (!defined('USER_KEY_LOGIN')) {
2645         define('USER_KEY_LOGIN', true);
2646     }
2648 /// return instance id - it might be empty
2649     return $key->instance;
2652 /**
2653  * Creates a new private user access key.
2654  *
2655  * @global object
2656  * @param string $script unique target identifier
2657  * @param int $userid
2658  * @param int $instance optional instance id
2659  * @param string $iprestriction optional ip restricted access
2660  * @param timestamp $validuntil key valid only until given data
2661  * @return string access key value
2662  */
2663 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2664     global $DB;
2666     $key = new object();
2667     $key->script        = $script;
2668     $key->userid        = $userid;
2669     $key->instance      = $instance;
2670     $key->iprestriction = $iprestriction;
2671     $key->validuntil    = $validuntil;
2672     $key->timecreated   = time();
2674     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2675     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2676         // must be unique
2677         $key->value     = md5($userid.'_'.time().random_string(40));
2678     }
2679     $DB->insert_record('user_private_key', $key);
2680     return $key->value;
2683 /**
2684  * Delete the user's new private user access keys for a particular script.
2685  *
2686  * @global object
2687  * @param string $script unique target identifier
2688  * @param int $userid
2689  * @return void
2690  */
2691 function delete_user_key($script,$userid) {
2692     global $DB;
2693     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
2696 /**
2697  * Gets a private user access key (and creates one if one doesn't exist).
2698  *
2699  * @global object
2700  * @param string $script unique target identifier
2701  * @param int $userid
2702  * @param int $instance optional instance id
2703  * @param string $iprestriction optional ip restricted access
2704  * @param timestamp $validuntil key valid only until given data
2705  * @return string access key value
2706  */
2707 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2708     global $DB;
2710     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
2711                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
2712                                                          'validuntil'=>$validuntil))) {
2713         return $key->value;
2714     } else {
2715         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
2716     }
2720 /**
2721  * Modify the user table by setting the currently logged in user's
2722  * last login to now.
2723  *
2724  * @global object
2725  * @global object
2726  * @return bool Always returns true
2727  */
2728 function update_user_login_times() {
2729     global $USER, $DB;
2731     $user = new object();
2732     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2733     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2735     $user->id = $USER->id;
2737     $DB->update_record('user', $user);
2738     return true;
2741 /**
2742  * Determines if a user has completed setting up their account.
2743  *
2744  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
2745  * @return bool
2746  */
2747 function user_not_fully_set_up($user) {
2748     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2751 /**
2752  * Check whether the user has exceeded the bounce threshold
2753  *
2754  * @global object
2755  * @global object
2756  * @param user $user A {@link $USER} object
2757  * @return bool true=>User has exceeded bounce threshold
2758  */
2759 function over_bounce_threshold($user) {
2760     global $CFG, $DB;
2762     if (empty($CFG->handlebounces)) {
2763         return false;
2764     }
2766     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2767         return false;
2768     }
2770     // set sensible defaults
2771     if (empty($CFG->minbounces)) {
2772         $CFG->minbounces = 10;
2773     }
2774     if (empty($CFG->bounceratio)) {
2775         $CFG->bounceratio = .20;
2776     }
2777     $bouncecount = 0;
2778     $sendcount = 0;
2779     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2780         $bouncecount = $bounce->value;
2781     }
2782     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2783         $sendcount = $send->value;
2784     }
2785     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2788 /**
2789  * Used to increment or reset email sent count
2790  *
2791  * @global object
2792  * @param user $user object containing an id
2793  * @param bool $reset will reset the count to 0
2794  * @return void
2795  */
2796 function set_send_count($user,$reset=false) {
2797     global $DB;
2799     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2800         return;
2801     }
2803     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2804         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2805         $DB->update_record('user_preferences', $pref);
2806     }
2807     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2808         // make a new one
2809         $pref = new object();
2810         $pref->name   = 'email_send_count';
2811         $pref->value  = 1;
2812         $pref->userid = $user->id;
2813         $DB->insert_record('user_preferences', $pref, false);
2814     }
2817 /**
2818  * Increment or reset user's email bounce count
2819  *
2820  * @global object
2821  * @param user $user object containing an id
2822  * @param bool $reset will reset the count to 0
2823  */
2824 function set_bounce_count($user,$reset=false) {
2825     global $DB;
2827     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2828         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2829         $DB->update_record('user_preferences', $pref);
2830     }
2831     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2832         // make a new one
2833         $pref = new object();
2834         $pref->name   = 'email_bounce_count';
2835         $pref->value  = 1;
2836         $pref->userid = $user->id;
2837         $DB->insert_record('user_preferences', $pref, false);
2838     }
2841 /**
2842  * Keeps track of login attempts
2843  *
2844  * @global object
2845  */
2846 function update_login_count() {
2847     global $SESSION;
2849     $max_logins = 10;
2851     if (empty($SESSION->logincount)) {
2852         $SESSION->logincount = 1;
2853     } else {
2854         $SESSION->logincount++;
2855     }
2857     if ($SESSION->logincount > $max_logins) {
2858         unset($SESSION->wantsurl);
2859         print_error('errortoomanylogins');
2860     }
2863 /**
2864  * Resets login attempts
2865  *
2866  * @global object
2867  */
2868 function reset_login_count() {
2869     global $SESSION;
2871     $SESSION->logincount = 0;
2874 /**
2875  * Returns reference to full info about modules in course (including visibility).
2876  * Cached and as fast as possible (0 or 1 db query).
2877  *
2878  * @global object
2879  * @global object
2880  * @global object
2881  * @uses CONTEXT_MODULE
2882  * @uses MAX_MODINFO_CACHE_SIZE
2883  * @param mixed $course object or 'reset' string to reset caches, modinfo may be updated in db
2884  * @param int $userid Defaults to current user id
2885  * @return mixed courseinfo object or nothing if resetting
2886  */
2887 function &get_fast_modinfo(&$course, $userid=0) {
2888     global $CFG, $USER, $DB;
2889     require_once($CFG->dirroot.'/course/lib.php');
2891     if (!empty($CFG->enableavailability)) {
2892         require_once($CFG->libdir.'/conditionlib.php');
2893     }
2895     static $cache = array();
2897     if ($course === 'reset') {
2898         $cache = array();
2899         $nothing = null;
2900         return $nothing; // we must return some reference
2901     }
2903     if (empty($userid)) {
2904         $userid = $USER->id;
2905     }
2907     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
2908         return $cache[$course->id];
2909     }
2911     if (empty($course->modinfo)) {
2912         // no modinfo yet - load it
2913         rebuild_course_cache($course->id);
2914         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2915     }
2917     $modinfo = new object();
2918     $modinfo->courseid  = $course->id;
2919     $modinfo->userid    = $userid;
2920     $modinfo->sections  = array();
2921     $modinfo->cms       = array();
2922     $modinfo->instances = array();
2923     $modinfo->groups    = null; // loaded only when really needed - the only one db query
2925     $info = unserialize($course->modinfo);
2926     if (!is_array($info)) {
2927         // hmm, something is wrong - lets try to fix it
2928         rebuild_course_cache($course->id);
2929         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2930         $info = unserialize($course->modinfo);
2931         if (!is_array($info)) {
2932             return $modinfo;
2933         }
2934     }
2936     if ($info) {
2937         // detect if upgrade required
2938         $first = reset($info);
2939         if (!isset($first->id)) {
2940             rebuild_course_cache($course->id);
2941             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2942             $info = unserialize($course->modinfo);
2943             if (!is_array($info)) {
2944                 return $modinfo;
2945             }
2946         }
2947     }
2949     $modlurals = array();
2951     // If we haven't already preloaded contexts for the course, do it now
2952     preload_course_contexts($course->id);
2954     foreach ($info as $mod) {
2955         if (empty($mod->name)) {
2956             // something is wrong here
2957             continue;
2958         }
2959         // reconstruct minimalistic $cm
2960         $cm = new object();
2961         $cm->id               = $mod->cm;
2962         $cm->instance         = $mod->id;
2963         $cm->course           = $course->id;
2964         $cm->modname          = $mod->mod;
2965         $cm->idnumber         = $mod->idnumber;
2966         $cm->name             = $mod->name;
2967         $cm->visible          = $mod->visible;
2968         $cm->sectionnum       = $mod->section;
2969         $cm->groupmode        = $mod->groupmode;
2970         $cm->groupingid       = $mod->groupingid;
2971         $cm->groupmembersonly = $mod->groupmembersonly;
2972         $cm->indent           = $mod->indent;
2973         $cm->completion       = $mod->completion;
2974         $cm->extra            = isset($mod->extra) ? $mod->extra : '';
2975         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
2976         $cm->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
2977         $cm->uservisible      = true;
2978         if(!empty($CFG->enableavailability)) {
2979             // We must have completion information from modinfo. If it's not
2980             // there, cache needs rebuilding
2981             if(!isset($mod->availablefrom)) {
2982                 debugging('enableavailability option was changed; rebuilding '.
2983                     'cache for course '.$course->id);
2984                 rebuild_course_cache($course->id,true);
2985                 // Re-enter this routine to do it all properly
2986                 return get_fast_modinfo($course,$userid);
2987             }
2988             $cm->availablefrom    = $mod->availablefrom;
2989             $cm->availableuntil   = $mod->availableuntil;
2990             $cm->showavailability = $mod->showavailability;
2991             $cm->conditionscompletion = $mod->conditionscompletion;
2992             $cm->conditionsgrade  = $mod->conditionsgrade;
2993         }
2995         // preload long names plurals and also check module is installed properly
2996         if (!isset($modlurals[$cm->modname])) {
2997             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
2998                 continue;
2999             }
3000             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
3001         }
3002         $cm->modplural = $modlurals[$cm->modname];
3003         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
3005         if(!empty($CFG->enableavailability)) {
3006             // Unfortunately the next call really wants to call
3007             // get_fast_modinfo, but that would be recursive, so we fake up a
3008             // modinfo for it already
3009             if(empty($minimalmodinfo)) {
3010                 $minimalmodinfo=new stdClass();
3011                 $minimalmodinfo->cms=array();
3012                 foreach($info as $mod) {
3013                     if (empty($mod->name)) {
3014                         // something is wrong here
3015                         continue;
3016                     }
3017                     $minimalcm = new stdClass();
3018                     $minimalcm->id = $mod->cm;
3019                     $minimalcm->name = $mod->name;
3020                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
3021                 }
3022             }
3024             // Get availability information
3025             $ci = new condition_info($cm);
3026             $cm->available=$ci->is_available($cm->availableinfo, true, $userid, $minimalmodinfo);
3027         } else {
3028             $cm->available=true;
3029         }
3030         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
3031             $cm->uservisible = false;
3033         } else if (!empty($CFG->enablegroupmembersonly) and !empty($cm->groupmembersonly)
3034                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
3035             if (is_null($modinfo->groups)) {
3036                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
3037             }
3038             if (empty($modinfo->groups[$cm->groupingid])) {
3039                 $cm->uservisible = false;
3040             }
3041         }
3043         if (!isset($modinfo->instances[$cm->modname])) {
3044             $modinfo->instances[$cm->modname] = array();
3045         }
3046         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
3047         $modinfo->cms[$cm->id] =& $cm;
3049         // reconstruct sections
3050         if (!isset($modinfo->sections[$cm->sectionnum])) {
3051             $modinfo->sections[$cm->sectionnum] = array();
3052         }
3053         $modinfo->sections[$cm->sectionnum][] = $cm->id;
3055         unset($cm);
3056     }
3058     unset($cache[$course->id]); // prevent potential reference problems when switching users
3059     $cache[$course->id] = $modinfo;
3061     // Ensure cache does not use too much RAM
3062     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
3063         reset($cache);
3064         $key = key($cache);
3065         unset($cache[$key]);
3066     }
3068     return $cache[$course->id];
3071 /**
3072  * Determines if the currently logged in user is in editing mode.
3073  * Note: originally this function had $userid parameter - it was not usable anyway
3074  *
3075  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3076  * @todo Deprecated function remove when ready
3077  *
3078  * @global object
3079  * @uses DEBUG_DEVELOPER
3080  * @return bool
3081  */
3082 function isediting() {
3083     global $PAGE;
3084     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3085     return $PAGE->user_is_editing();
3088 /**
3089  * Determines if the logged in user is currently moving an activity
3090  *
3091  * @global object
3092  * @param int $courseid The id of the course being tested
3093  * @return bool
3094  */
3095 function ismoving($courseid) {
3096     global $USER;
3098     if (!empty($USER->activitycopy)) {
3099         return ($USER->activitycopycourse == $courseid);
3100     }
3101     return false;
3104 /**
3105  * Returns a persons full name
3106  *
3107  * Given an object containing firstname and lastname
3108  * values, this function returns a string with the
3109  * full name of the person.
3110  * The result may depend on system settings
3111  * or language.  'override' will force both names
3112  * to be used even if system settings specify one.
3113  *
3114  * @global object
3115  * @global object
3116  * @param object $user A {@link $USER} object to get full name of
3117  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3118  * @return string
3119  */
3120 function fullname($user, $override=false) {
3121     global $CFG, $SESSION;
3123     if (!isset($user->firstname) and !isset($user->lastname)) {
3124         return '';
3125     }
3127     if (!$override) {
3128         if (!empty($CFG->forcefirstname)) {
3129             $user->firstname = $CFG->forcefirstname;
3130         }
3131         if (!empty($CFG->forcelastname)) {
3132             $user->lastname = $CFG->forcelastname;
3133         }
3134     }
3136     if (!empty($SESSION->fullnamedisplay)) {
3137         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3138     }
3140     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3141         return $user->firstname .' '. $user->lastname;
3143     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3144         return $user->lastname .' '. $user->firstname;
3146     } else if ($CFG->fullnamedisplay == 'firstname') {
3147         if ($override) {
3148             return get_string('fullnamedisplay', '', $user);
3149         } else {
3150             return $user->firstname;
3151         }
3152     }
3154     return get_string('fullnamedisplay', '', $user);
3157 /**
3158  * Returns whether a given authentication plugin exists.
3159  *
3160  * @global object
3161  * @param string $auth Form of authentication to check for. Defaults to the
3162  *        global setting in {@link $CFG}.
3163  * @return boolean Whether the plugin is available.
3164  */
3165 function exists_auth_plugin($auth) {
3166     global $CFG;
3168     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3169         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3170     }
3171     return false;
3174 /**
3175  * Checks if a given plugin is in the list of enabled authentication plugins.
3176  *
3177  * @param string $auth Authentication plugin.
3178  * @return boolean Whether the plugin is enabled.
3179  */
3180 function is_enabled_auth($auth) {
3181     if (empty($auth)) {
3182         return false;
3183     }
3185     $enabled = get_enabled_auth_plugins();
3187     return in_array($auth, $enabled);
3190 /**
3191  * Returns an authentication plugin instance.
3192  *
3193  * @global object
3194  * @param string $auth name of authentication plugin
3195  * @return auth_plugin_base An instance of the required authentication plugin.
3196  */
3197 function get_auth_plugin($auth) {
3198     global $CFG;
3200     // check the plugin exists first
3201     if (! exists_auth_plugin($auth)) {
3202         print_error('authpluginnotfound', 'debug', '', $auth);
3203     }
3205     // return auth plugin instance
3206     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3207     $class = "auth_plugin_$auth";
3208     return new $class;
3211 /**
3212  * Returns array of active auth plugins.
3213  *
3214  * @param bool $fix fix $CFG->auth if needed
3215  * @return array
3216  */
3217 function get_enabled_auth_plugins($fix=false) {
3218     global $CFG;
3220     $default = array('manual', 'nologin');
3222     if (empty($CFG->auth)) {
3223         $auths = array();
3224     } else {
3225         $auths = explode(',', $CFG->auth);
3226     }
3228     if ($fix) {
3229         $auths = array_unique($auths);
3230         foreach($auths as $k=>$authname) {
3231             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3232                 unset($auths[$k]);
3233             }
3234         }
3235         $newconfig = implode(',', $auths);
3236         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3237             set_config('auth', $newconfig);
3238         }
3239     }
3241     return (array_merge($default, $auths));
3244 /**
3245  * Returns true if an internal authentication method is being used.
3246  * if method not specified then, global default is assumed
3247  *
3248  * @param string $auth Form of authentication required
3249  * @return bool
3250  */
3251 function is_internal_auth($auth) {
3252     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3253     return $authplugin->is_internal();
3256 /**
3257  * Returns true if the user is a 'restored' one
3258  *
3259  * Used in the login process to inform the user
3260  * and allow him/her to reset the password
3261  *
3262  * @uses $CFG
3263  * @uses $DB
3264  * @param string $username username to be checked
3265  * @return bool
3266  */
3267 function is_restored_user($username) {
3268     global $CFG, $DB;
3270     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3273 /**
3274  * Returns an array of user fields
3275  *
3276  * @return array User field/column names
3277  */
3278 function get_user_fieldnames() {
3279     global $DB;
3281     $fieldarray = $DB->get_columns('user');
3282     unset($fieldarray['id']);
3283     $fieldarray = array_keys($fieldarray);
3285     return $fieldarray;
3288 /**
3289  * Creates a bare-bones user record
3290  *
3291  * @todo Outline auth types and provide code example
3292  *
3293  * @global object
3294  * @global object
3295  * @param string $username New user's username to add to record
3296  * @param string $password New user's password to add to record
3297  * @param string $auth Form of authentication required
3298  * @return object A {@link $USER} object
3299  */
3300 function create_user_record($username, $password, $auth='manual') {
3301     global $CFG, $DB;
3303     //just in case check text case
3304     $username = trim(moodle_strtolower($username));
3306     $authplugin = get_auth_plugin($auth);
3308     $newuser = new object();
3310     if ($newinfo = $authplugin->get_userinfo($username)) {
3311         $newinfo = truncate_userinfo($newinfo);
3312         foreach ($newinfo as $key => $value){
3313             $newuser->$key = $value;
3314         }
3315     }
3317     if (!empty($newuser->email)) {
3318         if (email_is_not_allowed($newuser->email)) {
3319             unset($newuser->email);
3320         }
3321     }
3323     if (!isset($newuser->city)) {
3324         $newuser->city = '';
3325     }
3327     $newuser->auth = $auth;
3328     $newuser->username = $username;
3330     // fix for MDL-8480
3331     // user CFG lang for user if $newuser->lang is empty
3332     // or $user->lang is not an installed language
3333     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3334         $newuser->lang = $CFG->lang;
3335     }
3336     $newuser->confirmed = 1;
3337     $newuser->lastip = getremoteaddr();
3338     $newuser->timemodified = time();
3339     $newuser->mnethostid = $CFG->mnet_localhost_id;
3341     $DB->insert_record('user', $newuser);
3342     $user = get_complete_user_data('username', $newuser->username);
3343     if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3344         set_user_preference('auth_forcepasswordchange', 1, $user->id);
3345     }
3346     update_internal_user_password($user, $password);
3347     return $user;
3350 /**
3351  * Will update a local user record from an external source
3352  *
3353  * @global object
3354  * @param string $username New user's username to add to record
3355  * @param string $authplugin Unused
3356  * @return user A {@link $USER} object
3357  */
3358 function update_user_record($username, $authplugin) {
3359     global $DB;
3361     $username = trim(moodle_strtolower($username)); /// just in case check text case
3363     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
3364     $userauth = get_auth_plugin($oldinfo->auth);
3366     if ($newinfo = $userauth->get_userinfo($username)) {
3367         $newinfo = truncate_userinfo($newinfo);
3368         foreach ($newinfo as $key => $value){
3369             if ($key === 'username') {
3370                 // 'username' is not a mapped updateable/lockable field, so skip it.
3371                 continue;
3372             }
3373             $confval = $userauth->config->{'field_updatelocal_' . $key};
3374             $lockval = $userauth->config->{'field_lock_' . $key};
3375             if (empty($confval) || empty($lockval)) {
3376                 continue;
3377             }
3378             if ($confval === 'onlogin') {
3379                 // MDL-4207 Don't overwrite modified user profile values with
3380                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3381                 // of the setting 'unlocked if empty' is to allow the user to fill
3382                 // in a value for the selected field _if LDAP is giving
3383                 // nothing_ for this field. Thus it makes sense to let this value
3384                 // stand in until LDAP is giving a value for this field.
3385                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3386                     $DB->set_field('user', $key, $value, array('username'=>$username));
3387                 }
3388             }
3389         }
3390     }
3392     return get_complete_user_data('username', $username);
3395 /**
3396  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3397  * which may have large fields
3398  *
3399  * @todo Add vartype handling to ensure $info is an array
3400  *
3401  * @param array $info Array of user properties to truncate if needed
3402  * @return array The now truncated information that was passed in
3403  */
3404 function truncate_userinfo($info) {
3405     // define the limits
3406     $limit = array(
3407                     'username'    => 100,
3408                     'idnumber'    => 255,
3409                     'firstname'   => 100,
3410                     'lastname'    => 100,
3411                     'email'       => 100,
3412                     'icq'         =>  15,
3413                     'phone1'      =>  20,
3414                     'phone2'      =>  20,
3415                     'institution' =>  40,
3416                     'department'  =>  30,
3417                     'address'     =>  70,
3418                     'city'        => 120,
3419                     'country'     =>   2,
3420                     'url'         => 255,
3421                     );
3423     // apply where needed
3424     foreach (array_keys($info) as $key) {
3425         if (!empty($limit[$key])) {
3426             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
3427         }
3428     }
3430     return $info;
3433 /**
3434  * Marks user deleted in internal user database and notifies the auth plugin.
3435  * Also unenrols user from all roles and does other cleanup.
3436  *
3437  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3438  *
3439  * @param object $user User object before delete
3440  * @return boolean always true
3441  */
3442 function delete_user($user) {
3443     global $CFG, $DB;
3444     require_once($CFG->libdir.'/grouplib.php');
3445     require_once($CFG->libdir.'/gradelib.php');
3446     require_once($CFG->dirroot.'/message/lib.php');
3448     // delete all grades - backup is kept in grade_grades_history table
3449     grade_user_delete($user->id);
3451     //move unread messages from this user to read
3452     message_move_userfrom_unread2read($user->id);
3454     // remove from all cohorts
3455     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3457     // remove from all groups
3458     $DB->delete_records('groups_members', array('userid'=>$user->id));
3460     // brute force unenrol from all courses
3461     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3463     // purge user preferences
3464     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3466     // purge user extra profile info
3467     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3469     // last course access not necessary either
3470     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3472     // final accesslib cleanup - removes all role assignments in user context and context itself, files, etc.
3473     delete_context(CONTEXT_USER, $user->id);
3475     require_once($CFG->dirroot.'/tag/lib.php');
3476     tag_set('user', $user->id, array());
3478     // workaround for bulk deletes of users with the same email address
3479     $delname = "$user->email.".time();
3480     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3481         $delname++;
3482     }
3484     // mark internal user record as "deleted"
3485     $updateuser = new object();
3486     $updateuser->id           = $user->id;
3487     $updateuser->deleted      = 1;
3488     $updateuser->username     = $delname;            // Remember it just in case
3489     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3490     $updateuser->idnumber     = '';                  // Clear this field to free it up
3491     $updateuser->timemodified = time();
3493     $DB->update_record('user', $updateuser);
3495     // notify auth plugin - do not block the delete even when plugin fails
3496     $authplugin = get_auth_plugin($user->auth);
3497     $authplugin->user_delete($user);
3499     // any plugin that needs to cleanup should register this event
3500     events_trigger('user_deleted', $user);
3502     return true;
3505 /**
3506  * Retrieve the guest user object
3507  *
3508  * @global object
3509  * @global object
3510  * @return user A {@link $USER} object
3511  */
3512 function guest_user() {
3513     global $CFG, $DB;
3515     if ($newuser = $DB->get_record('user', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
3516         $newuser->confirmed = 1;
3517         $newuser->lang = $CFG->lang;
3518         $newuser->lastip = getremoteaddr();
3519     }
3521     return $newuser;
3524 /**
3525  * Authenticates a user against the chosen authentication mechanism
3526  *
3527  * Given a username and password, this function looks them
3528  * up using the currently selected authentication mechanism,
3529  * and if the authentication is successful, it returns a
3530  * valid $user object from the 'user' table.
3531  *
3532  * Uses auth_ functions from the currently active auth module
3533  *
3534  * After authenticate_user_login() returns success, you will need to
3535  * log that the user has logged in, and call complete_user_login() to set
3536  * the session up.
3537  *
3538  * @global object
3539  * @global object
3540  * @param string $username  User's username
3541  * @param string $password  User's password
3542  * @return user|flase A {@link $USER} object or false if error
3543  */
3544 function authenticate_user_login($username, $password) {
3545     global $CFG, $DB, $OUTPUT;
3547     $authsenabled = get_enabled_auth_plugins();
3549     if ($user = get_complete_user_data('username', $username)) {
3550         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3551         if (!empty($user->suspended)) {
3552             add_to_log(0, 'login', 'error', 'index.php', $username);
3553             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3554             return false;
3555         }
3556         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3557             add_to_log(0, 'login', 'error', 'index.php', $username);
3558             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3559             return false;
3560         }
3561         $auths = array($auth);
3563     } else {
3564         // check if there's a deleted record (cheaply)
3565         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
3566             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3567             return false;
3568         }
3570         $auths = $authsenabled;
3571         $user = new object();
3572         $user->id = 0;     // User does not exist
3573     }
3575     foreach ($auths as $auth) {
3576         $authplugin = get_auth_plugin($auth);
3578         // on auth fail fall through to the next plugin
3579         if (!$authplugin->user_login($username, $password)) {
3580             continue;
3581         }
3583         // successful authentication
3584         if ($user->id) {                          // User already exists in database
3585             if (empty($user->auth)) {             // For some reason auth isn't set yet
3586                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3587                 $user->auth = $auth;
3588             }
3589             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3590                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3591                 $user->firstaccess = $user->timemodified;
3592             }
3594             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3596             if (!$authplugin->is_internal()) {            // update user record from external DB
3597                 $user = update_user_record($username, get_auth_plugin($user->auth));
3598             }
3599         } else {
3600             // if user not found, create him
3601             $user = create_user_record($username, $password, $auth);
3602         }
3604         $authplugin->sync_roles($user);
3606         foreach ($authsenabled as $hau) {
3607             $hauth = get_auth_plugin($hau);
3608             $hauth->user_authenticated_hook($user, $username, $password);
3609         }
3611         if (empty($user->id)) {
3612             return false;
3613         }
3615         if (!empty($user->suspended)) {
3616             // just in case some auth plugin suspended account
3617             add_to_log(0, 'login', 'error', 'index.php', $username);
3618             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3619             return false;
3620         }
3622         return $user;
3623     }
3625     // failed if all the plugins have failed
3626     add_to_log(0, 'login', 'error', 'index.php', $username);
3627     if (debugging('', DEBUG_ALL)) {
3628         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3629     }
3630     return false;
3633 /**
3634  * Call to complete the user login process after authenticate_user_login()
3635  * has succeeded. It will setup the $USER variable and other required bits
3636  * and pieces.
3637  *
3638  * NOTE:
3639  * - It will NOT log anything -- up to the caller to decide what to log.
3640  *
3641  * @global object
3642  * @global object
3643  * @global object
3644  * @param object $user
3645  * @param bool $setcookie
3646  * @return object A {@link $USER} object - BC only, do not use
3647  */
3648 function complete_user_login($user, $setcookie=true) {
3649     global $CFG, $USER, $SESSION;
3651     // regenerate session id and delete old session,
3652     // this helps prevent session fixation attacks from the same domain
3653     session_regenerate_id(true);
3655     // check enrolments, load caps and setup $USER object
3656     session_set_user($user);
3658     update_user_login_times();
3659     set_login_session_preferences();
3661     if ($setcookie) {
3662         if (empty($CFG->nolastloggedin)) {
3663             set_moodle_cookie($USER->username);
3664         } else {
3665             // do not store last logged in user in cookie
3666             // auth plugins can temporarily override this from loginpage_hook()
3667             // do not save $CFG->nolastloggedin in database!
3668             set_moodle_cookie('nobody');
3669         }
3670     }
3672     /// Select password change url
3673     $userauth = get_auth_plugin($USER->auth);
3675     /// check whether the user should be changing password
3676     if (get_user_preferences('auth_forcepasswordchange', false)){
3677         if ($userauth->can_change_password()) {
3678             if ($changeurl = $userauth->change_password_url()) {
3679                 redirect($changeurl);
3680             } else {
3681                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3682             }
3683         } else {
3684             print_error('nopasswordchangeforced', 'auth');
3685         }
3686     }
3687     return $USER;
3690 /**
3691  * Compare password against hash stored in internal user table.
3692  * If necessary it also updates the stored hash to new format.
3693  *
3694  * @global object
3695  * @param object $user
3696  * @param string $password plain text password
3697  * @return bool is password valid?
3698  */
3699 function validate_internal_user_password(&$user, $password) {
3700     global $CFG;
3702     if (!isset($CFG->passwordsaltmain)) {
3703         $CFG->passwordsaltmain = '';
3704     }
3706     $validated = false;
3708     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)) {
3709         $validated = true;
3710     } else {
3711         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3712             $alt = 'passwordsaltalt'.$i;
3713