MDL-26796 remove unused param
[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. use only for text in HTML format. This cleaning may fix xhtml strictness too.
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 except the discarding of the invalid utf-8 characters
182  */
183 define('PARAM_RAW', 'raw');
185 /**
186  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
187  */
188 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
190 /**
191  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
192  */
193 define('PARAM_SAFEDIR',  'safedir');
195 /**
196  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
197  */
198 define('PARAM_SAFEPATH',  'safepath');
200 /**
201  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
202  */
203 define('PARAM_SEQUENCE',  'sequence');
205 /**
206  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
207  */
208 define('PARAM_TAG',   'tag');
210 /**
211  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
212  */
213 define('PARAM_TAGLIST',   'taglist');
215 /**
216  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
217  */
218 define('PARAM_TEXT',  'text');
220 /**
221  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
222  */
223 define('PARAM_THEME',  'theme');
225 /**
226  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
227  */
228 define('PARAM_URL',      'url');
230 /**
231  * 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!!
232  */
233 define('PARAM_USERNAME',    'username');
235 /**
236  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
237  */
238 define('PARAM_STRINGID',    'stringid');
240 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
241 /**
242  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
243  * It was one of the first types, that is why it is abused so much ;-)
244  * @deprecated since 2.0
245  */
246 define('PARAM_CLEAN',    'clean');
248 /**
249  * PARAM_INTEGER - deprecated alias for PARAM_INT
250  */
251 define('PARAM_INTEGER',  'int');
253 /**
254  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
255  */
256 define('PARAM_NUMBER',  'float');
258 /**
259  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
260  * NOTE: originally alias for PARAM_APLHA
261  */
262 define('PARAM_ACTION',   'alphanumext');
264 /**
265  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
266  * NOTE: originally alias for PARAM_APLHA
267  */
268 define('PARAM_FORMAT',   'alphanumext');
270 /**
271  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
272  */
273 define('PARAM_MULTILANG',  'text');
275 /**
276  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
277  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
278  * America/Port-au-Prince)
279  */
280 define('PARAM_TIMEZONE', 'timezone');
282 /**
283  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
284  */
285 define('PARAM_CLEANFILE', 'file');
287 /// Web Services ///
289 /**
290  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
291  */
292 define('VALUE_REQUIRED', 1);
294 /**
295  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
296  */
297 define('VALUE_OPTIONAL', 2);
299 /**
300  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
301  */
302 define('VALUE_DEFAULT', 0);
304 /**
305  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
306  */
307 define('NULL_NOT_ALLOWED', false);
309 /**
310  * NULL_ALLOWED - the parameter can be set to null in the database
311  */
312 define('NULL_ALLOWED', true);
314 /// Page types ///
315 /**
316  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
317  */
318 define('PAGE_COURSE_VIEW', 'course-view');
320 /** Get remote addr constant */
321 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
322 /** Get remote addr constant */
323 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
325 /// Blog access level constant declaration ///
326 define ('BLOG_USER_LEVEL', 1);
327 define ('BLOG_GROUP_LEVEL', 2);
328 define ('BLOG_COURSE_LEVEL', 3);
329 define ('BLOG_SITE_LEVEL', 4);
330 define ('BLOG_GLOBAL_LEVEL', 5);
333 ///Tag constants///
334 /**
335  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
336  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
337  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
338  *
339  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
340  */
341 define('TAG_MAX_LENGTH', 50);
343 /// Password policy constants ///
344 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
345 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
346 define ('PASSWORD_DIGITS', '0123456789');
347 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
349 /// Feature constants ///
350 // Used for plugin_supports() to report features that are, or are not, supported by a module.
352 /** True if module can provide a grade */
353 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
354 /** True if module supports outcomes */
355 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
357 /** True if module has code to track whether somebody viewed it */
358 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
359 /** True if module has custom completion rules */
360 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
362 /** True if module has no 'view' page (like label) */
363 define('FEATURE_NO_VIEW_LINK', 'viewlink');
364 /** True if module supports outcomes */
365 define('FEATURE_IDNUMBER', 'idnumber');
366 /** True if module supports groups */
367 define('FEATURE_GROUPS', 'groups');
368 /** True if module supports groupings */
369 define('FEATURE_GROUPINGS', 'groupings');
370 /** True if module supports groupmembersonly */
371 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
373 /** Type of module */
374 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
375 /** True if module supports intro editor */
376 define('FEATURE_MOD_INTRO', 'mod_intro');
377 /** True if module has default completion */
378 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
380 define('FEATURE_COMMENT', 'comment');
382 define('FEATURE_RATE', 'rate');
383 /** True if module supports backup/restore of moodle2 format */
384 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
386 /** Unspecified module archetype */
387 define('MOD_ARCHETYPE_OTHER', 0);
388 /** Resource-like type module */
389 define('MOD_ARCHETYPE_RESOURCE', 1);
390 /** Assignment module archetype */
391 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
393 /**
394  * Security token used for allowing access
395  * from external application such as web services.
396  * Scripts do not use any session, performance is relatively
397  * low because we need to load access info in each request.
398  * Scripts are executed in parallel.
399  */
400 define('EXTERNAL_TOKEN_PERMANENT', 0);
402 /**
403  * Security token used for allowing access
404  * of embedded applications, the code is executed in the
405  * active user session. Token is invalidated after user logs out.
406  * Scripts are executed serially - normal session locking is used.
407  */
408 define('EXTERNAL_TOKEN_EMBEDDED', 1);
410 /**
411  * The home page should be the site home
412  */
413 define('HOMEPAGE_SITE', 0);
414 /**
415  * The home page should be the users my page
416  */
417 define('HOMEPAGE_MY', 1);
418 /**
419  * The home page can be chosen by the user
420  */
421 define('HOMEPAGE_USER', 2);
423 /**
424  * Hub directory url (should be moodle.org)
425  */
426 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
429 /**
430  * Moodle.org url (should be moodle.org)
431  */
432 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
434 /**
435  * Moodle mobile app service name
436  */
437 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
439 /// PARAMETER HANDLING ////////////////////////////////////////////////////
441 /**
442  * Returns a particular value for the named variable, taken from
443  * POST or GET.  If the parameter doesn't exist then an error is
444  * thrown because we require this variable.
445  *
446  * This function should be used to initialise all required values
447  * in a script that are based on parameters.  Usually it will be
448  * used like this:
449  *    $id = required_param('id', PARAM_INT);
450  *
451  * Please note the $type parameter is now required and the value can not be array.
452  *
453  * @param string $parname the name of the page parameter we want
454  * @param string $type expected type of parameter
455  * @return mixed
456  */
457 function required_param($parname, $type) {
458     if (func_num_args() != 2 or empty($parname) or empty($type)) {
459         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
460     }
461     if (isset($_POST[$parname])) {       // POST has precedence
462         $param = $_POST[$parname];
463     } else if (isset($_GET[$parname])) {
464         $param = $_GET[$parname];
465     } else {
466         print_error('missingparam', '', '', $parname);
467     }
469     if (is_array($param)) {
470         debugging('Invalid array parameter detected in required_param(): '.$parname);
471         // TODO: switch to fatal error in Moodle 2.3
472         //print_error('missingparam', '', '', $parname);
473         return required_param_array($parname, $type);
474     }
476     return clean_param($param, $type);
479 /**
480  * Returns a particular array value for the named variable, taken from
481  * POST or GET.  If the parameter doesn't exist then an error is
482  * thrown because we require this variable.
483  *
484  * This function should be used to initialise all required values
485  * in a script that are based on parameters.  Usually it will be
486  * used like this:
487  *    $ids = required_param_array('ids', PARAM_INT);
488  *
489  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
490  *
491  * @param string $parname the name of the page parameter we want
492  * @param string $type expected type of parameter
493  * @return array
494  */
495 function required_param_array($parname, $type) {
496     if (func_num_args() != 2 or empty($parname) or empty($type)) {
497         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
498     }
499     if (isset($_POST[$parname])) {       // POST has precedence
500         $param = $_POST[$parname];
501     } else if (isset($_GET[$parname])) {
502         $param = $_GET[$parname];
503     } else {
504         print_error('missingparam', '', '', $parname);
505     }
506     if (!is_array($param)) {
507         print_error('missingparam', '', '', $parname);
508     }
510     $result = array();
511     foreach($param as $key=>$value) {
512         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
513             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
514             continue;
515         }
516         $result[$key] = clean_param($value, $type);
517     }
519     return $result;
522 /**
523  * Returns a particular value for the named variable, taken from
524  * POST or GET, otherwise returning a given default.
525  *
526  * This function should be used to initialise all optional values
527  * in a script that are based on parameters.  Usually it will be
528  * used like this:
529  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
530  *
531  * Please note the $type parameter is now required and the value can not be array.
532  *
533  * @param string $parname the name of the page parameter we want
534  * @param mixed  $default the default value to return if nothing is found
535  * @param string $type expected type of parameter
536  * @return mixed
537  */
538 function optional_param($parname, $default, $type) {
539     if (func_num_args() != 3 or empty($parname) or empty($type)) {
540         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
541     }
542     if (!isset($default)) {
543         $default = null;
544     }
546     if (isset($_POST[$parname])) {       // POST has precedence
547         $param = $_POST[$parname];
548     } else if (isset($_GET[$parname])) {
549         $param = $_GET[$parname];
550     } else {
551         return $default;
552     }
554     if (is_array($param)) {
555         debugging('Invalid array parameter detected in required_param(): '.$parname);
556         // TODO: switch to $default in Moodle 2.3
557         //return $default;
558         return optional_param_array($parname, $default, $type);
559     }
561     return clean_param($param, $type);
564 /**
565  * Returns a particular array value for the named variable, taken from
566  * POST or GET, otherwise returning a given default.
567  *
568  * This function should be used to initialise all optional values
569  * in a script that are based on parameters.  Usually it will be
570  * used like this:
571  *    $ids = optional_param('id', array(), PARAM_INT);
572  *
573  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
574  *
575  * @param string $parname the name of the page parameter we want
576  * @param mixed  $default the default value to return if nothing is found
577  * @param string $type expected type of parameter
578  * @return array
579  */
580 function optional_param_array($parname, $default, $type) {
581     if (func_num_args() != 3 or empty($parname) or empty($type)) {
582         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
583     }
585     if (isset($_POST[$parname])) {       // POST has precedence
586         $param = $_POST[$parname];
587     } else if (isset($_GET[$parname])) {
588         $param = $_GET[$parname];
589     } else {
590         return $default;
591     }
592     if (!is_array($param)) {
593         debugging('optional_param_array() expects array parameters only: '.$parname);
594         return $default;
595     }
597     $result = array();
598     foreach($param as $key=>$value) {
599         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
600             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
601             continue;
602         }
603         $result[$key] = clean_param($value, $type);
604     }
606     return $result;
609 /**
610  * Strict validation of parameter values, the values are only converted
611  * to requested PHP type. Internally it is using clean_param, the values
612  * before and after cleaning must be equal - otherwise
613  * an invalid_parameter_exception is thrown.
614  * Objects and classes are not accepted.
615  *
616  * @param mixed $param
617  * @param string $type PARAM_ constant
618  * @param bool $allownull are nulls valid value?
619  * @param string $debuginfo optional debug information
620  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
621  */
622 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
623     if (is_null($param)) {
624         if ($allownull == NULL_ALLOWED) {
625             return null;
626         } else {
627             throw new invalid_parameter_exception($debuginfo);
628         }
629     }
630     if (is_array($param) or is_object($param)) {
631         throw new invalid_parameter_exception($debuginfo);
632     }
634     $cleaned = clean_param($param, $type);
635     if ((string)$param !== (string)$cleaned) {
636         // conversion to string is usually lossless
637         throw new invalid_parameter_exception($debuginfo);
638     }
640     return $cleaned;
643 /**
644  * Makes sure array contains only the allowed types,
645  * this function does not validate array key names!
646  * <code>
647  * $options = clean_param($options, PARAM_INT);
648  * </code>
649  *
650  * @param array $param the variable array we are cleaning
651  * @param string $type expected format of param after cleaning.
652  * @param bool $recursive clean recursive arrays
653  * @return array
654  */
655 function clean_param_array(array $param = null, $type, $recursive = false) {
656     $param = (array)$param; // convert null to empty array
657     foreach ($param as $key => $value) {
658         if (is_array($value)) {
659             if ($recursive) {
660                 $param[$key] = clean_param_array($value, $type, true);
661             } else {
662                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
663             }
664         } else {
665             $param[$key] = clean_param($value, $type);
666         }
667     }
668     return $param;
671 /**
672  * Used by {@link optional_param()} and {@link required_param()} to
673  * clean the variables and/or cast to specific types, based on
674  * an options field.
675  * <code>
676  * $course->format = clean_param($course->format, PARAM_ALPHA);
677  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
678  * </code>
679  *
680  * @param mixed $param the variable we are cleaning
681  * @param string $type expected format of param after cleaning.
682  * @return mixed
683  */
684 function clean_param($param, $type) {
686     global $CFG;
688     if (is_object($param) or is_array($param)) {
689         throw new coding_exception('clean_param() can not process objects or arrays, please use clean_param_array() instead.');
690     }
692     switch ($type) {
693         case PARAM_RAW:          // no cleaning at all
694             $param = fix_utf8($param);
695             return $param;
697         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
698             $param = fix_utf8($param);
699             return trim($param);
701         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
702             // this is deprecated!, please use more specific type instead
703             if (is_numeric($param)) {
704                 return $param;
705             }
706             $param = fix_utf8($param);
707             return clean_text($param);     // Sweep for scripts, etc
709         case PARAM_CLEANHTML:    // clean html fragment
710             $param = fix_utf8($param);
711             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
712             return trim($param);
714         case PARAM_INT:
715             return (int)$param;  // Convert to integer
717         case PARAM_FLOAT:
718         case PARAM_NUMBER:
719             return (float)$param;  // Convert to float
721         case PARAM_ALPHA:        // Remove everything not a-z
722             return preg_replace('/[^a-zA-Z]/i', '', $param);
724         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
725             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
727         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
728             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
730         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
731             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
733         case PARAM_SEQUENCE:     // Remove everything not 0-9,
734             return preg_replace('/[^0-9,]/i', '', $param);
736         case PARAM_BOOL:         // Convert to 1 or 0
737             $tempstr = strtolower($param);
738             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
739                 $param = 1;
740             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
741                 $param = 0;
742             } else {
743                 $param = empty($param) ? 0 : 1;
744             }
745             return $param;
747         case PARAM_NOTAGS:       // Strip all tags
748             $param = fix_utf8($param);
749             return strip_tags($param);
751         case PARAM_TEXT:    // leave only tags needed for multilang
752             $param = fix_utf8($param);
753             // if the multilang syntax is not correct we strip all tags
754             // because it would break xhtml strict which is required for accessibility standards
755             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
756             do {
757                 if (strpos($param, '</lang>') !== false) {
758                     // old and future mutilang syntax
759                     $param = strip_tags($param, '<lang>');
760                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
761                         break;
762                     }
763                     $open = false;
764                     foreach ($matches[0] as $match) {
765                         if ($match === '</lang>') {
766                             if ($open) {
767                                 $open = false;
768                                 continue;
769                             } else {
770                                 break 2;
771                             }
772                         }
773                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
774                             break 2;
775                         } else {
776                             $open = true;
777                         }
778                     }
779                     if ($open) {
780                         break;
781                     }
782                     return $param;
784                 } else if (strpos($param, '</span>') !== false) {
785                     // current problematic multilang syntax
786                     $param = strip_tags($param, '<span>');
787                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
788                         break;
789                     }
790                     $open = false;
791                     foreach ($matches[0] as $match) {
792                         if ($match === '</span>') {
793                             if ($open) {
794                                 $open = false;
795                                 continue;
796                             } else {
797                                 break 2;
798                             }
799                         }
800                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
801                             break 2;
802                         } else {
803                             $open = true;
804                         }
805                     }
806                     if ($open) {
807                         break;
808                     }
809                     return $param;
810                 }
811             } while (false);
812             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
813             return strip_tags($param);
815         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
816             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
818         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
819             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
821         case PARAM_FILE:         // Strip all suspicious characters from filename
822             $param = fix_utf8($param);
823             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
824             $param = preg_replace('~\.\.+~', '', $param);
825             if ($param === '.') {
826                 $param = '';
827             }
828             return $param;
830         case PARAM_PATH:         // Strip all suspicious characters from file path
831             $param = fix_utf8($param);
832             $param = str_replace('\\', '/', $param);
833             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
834             $param = preg_replace('~\.\.+~', '', $param);
835             $param = preg_replace('~//+~', '/', $param);
836             return preg_replace('~/(\./)+~', '/', $param);
838         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
839             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
840             // match ipv4 dotted quad
841             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
842                 // confirm values are ok
843                 if ( $match[0] > 255
844                      || $match[1] > 255
845                      || $match[3] > 255
846                      || $match[4] > 255 ) {
847                     // hmmm, what kind of dotted quad is this?
848                     $param = '';
849                 }
850             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
851                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
852                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
853                        ) {
854                 // all is ok - $param is respected
855             } else {
856                 // all is not ok...
857                 $param='';
858             }
859             return $param;
861         case PARAM_URL:          // allow safe ftp, http, mailto urls
862             $param = fix_utf8($param);
863             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
864             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
865                 // all is ok, param is respected
866             } else {
867                 $param =''; // not really ok
868             }
869             return $param;
871         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
872             $param = clean_param($param, PARAM_URL);
873             if (!empty($param)) {
874                 if (preg_match(':^/:', $param)) {
875                     // root-relative, ok!
876                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
877                     // absolute, and matches our wwwroot
878                 } else {
879                     // relative - let's make sure there are no tricks
880                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
881                         // looks ok.
882                     } else {
883                         $param = '';
884                     }
885                 }
886             }
887             return $param;
889         case PARAM_PEM:
890             $param = trim($param);
891             // PEM formatted strings may contain letters/numbers and the symbols
892             // forward slash: /
893             // plus sign:     +
894             // equal sign:    =
895             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
896             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
897                 list($wholething, $body) = $matches;
898                 unset($wholething, $matches);
899                 $b64 = clean_param($body, PARAM_BASE64);
900                 if (!empty($b64)) {
901                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
902                 } else {
903                     return '';
904                 }
905             }
906             return '';
908         case PARAM_BASE64:
909             if (!empty($param)) {
910                 // PEM formatted strings may contain letters/numbers and the symbols
911                 // forward slash: /
912                 // plus sign:     +
913                 // equal sign:    =
914                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
915                     return '';
916                 }
917                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
918                 // Each line of base64 encoded data must be 64 characters in
919                 // length, except for the last line which may be less than (or
920                 // equal to) 64 characters long.
921                 for ($i=0, $j=count($lines); $i < $j; $i++) {
922                     if ($i + 1 == $j) {
923                         if (64 < strlen($lines[$i])) {
924                             return '';
925                         }
926                         continue;
927                     }
929                     if (64 != strlen($lines[$i])) {
930                         return '';
931                     }
932                 }
933                 return implode("\n",$lines);
934             } else {
935                 return '';
936             }
938         case PARAM_TAG:
939             $param = fix_utf8($param);
940             // Please note it is not safe to use the tag name directly anywhere,
941             // it must be processed with s(), urlencode() before embedding anywhere.
942             // remove some nasties
943             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
944             //convert many whitespace chars into one
945             $param = preg_replace('/\s+/', ' ', $param);
946             $textlib = textlib_get_instance();
947             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
948             return $param;
950         case PARAM_TAGLIST:
951             $param = fix_utf8($param);
952             $tags = explode(',', $param);
953             $result = array();
954             foreach ($tags as $tag) {
955                 $res = clean_param($tag, PARAM_TAG);
956                 if ($res !== '') {
957                     $result[] = $res;
958                 }
959             }
960             if ($result) {
961                 return implode(',', $result);
962             } else {
963                 return '';
964             }
966         case PARAM_CAPABILITY:
967             if (get_capability_info($param)) {
968                 return $param;
969             } else {
970                 return '';
971             }
973         case PARAM_PERMISSION:
974             $param = (int)$param;
975             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
976                 return $param;
977             } else {
978                 return CAP_INHERIT;
979             }
981         case PARAM_AUTH:
982             $param = clean_param($param, PARAM_SAFEDIR);
983             if (exists_auth_plugin($param)) {
984                 return $param;
985             } else {
986                 return '';
987             }
989         case PARAM_LANG:
990             $param = clean_param($param, PARAM_SAFEDIR);
991             if (get_string_manager()->translation_exists($param)) {
992                 return $param;
993             } else {
994                 return ''; // Specified language is not installed or param malformed
995             }
997         case PARAM_THEME:
998             $param = clean_param($param, PARAM_SAFEDIR);
999             if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1000                 return $param;
1001             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1002                 return $param;
1003             } else {
1004                 return '';  // Specified theme is not installed
1005             }
1007         case PARAM_USERNAME:
1008             $param = fix_utf8($param);
1009             $param = str_replace(" " , "", $param);
1010             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
1011             if (empty($CFG->extendedusernamechars)) {
1012                 // regular expression, eliminate all chars EXCEPT:
1013                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1014                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1015             }
1016             return $param;
1018         case PARAM_EMAIL:
1019             $param = fix_utf8($param);
1020             if (validate_email($param)) {
1021                 return $param;
1022             } else {
1023                 return '';
1024             }
1026         case PARAM_STRINGID:
1027             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1028                 return $param;
1029             } else {
1030                 return '';
1031             }
1033         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1034             $param = fix_utf8($param);
1035             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3]|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1036             if (preg_match($timezonepattern, $param)) {
1037                 return $param;
1038             } else {
1039                 return '';
1040             }
1042         default:                 // throw error, switched parameters in optional_param or another serious problem
1043             print_error("unknownparamtype", '', '', $type);
1044     }
1047 /**
1048  * Makes sure the data is using valid utf8, invalid characters are discarded.
1049  *
1050  * Note: this function is not intended for full objects with methods and private properties.
1051  *
1052  * @param mixed $value
1053  * @return mixed with proper utf-8 encoding
1054  */
1055 function fix_utf8($value) {
1056     if (is_null($value) or $value === '') {
1057         return $value;
1059     } else if (is_string($value)) {
1060         if ((string)(int)$value === $value) {
1061             // shortcut
1062             return $value;
1063         }
1064         return iconv('UTF-8', 'UTF-8//IGNORE', $value);
1066     } else if (is_array($value)) {
1067         foreach ($value as $k=>$v) {
1068             $value[$k] = fix_utf8($v);
1069         }
1070         return $value;
1072     } else if (is_object($value)) {
1073         $value = clone($value); // do not modify original
1074         foreach ($value as $k=>$v) {
1075             $value->$k = fix_utf8($v);
1076         }
1077         return $value;
1079     } else {
1080         // this is some other type, no utf-8 here
1081         return $value;
1082     }
1085 /**
1086  * Return true if given value is integer or string with integer value
1087  *
1088  * @param mixed $value String or Int
1089  * @return bool true if number, false if not
1090  */
1091 function is_number($value) {
1092     if (is_int($value)) {
1093         return true;
1094     } else if (is_string($value)) {
1095         return ((string)(int)$value) === $value;
1096     } else {
1097         return false;
1098     }
1101 /**
1102  * Returns host part from url
1103  * @param string $url full url
1104  * @return string host, null if not found
1105  */
1106 function get_host_from_url($url) {
1107     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1108     if ($matches) {
1109         return $matches[1];
1110     }
1111     return null;
1114 /**
1115  * Tests whether anything was returned by text editor
1116  *
1117  * This function is useful for testing whether something you got back from
1118  * the HTML editor actually contains anything. Sometimes the HTML editor
1119  * appear to be empty, but actually you get back a <br> tag or something.
1120  *
1121  * @param string $string a string containing HTML.
1122  * @return boolean does the string contain any actual content - that is text,
1123  * images, objects, etc.
1124  */
1125 function html_is_blank($string) {
1126     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1129 /**
1130  * Set a key in global configuration
1131  *
1132  * Set a key/value pair in both this session's {@link $CFG} global variable
1133  * and in the 'config' database table for future sessions.
1134  *
1135  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1136  * In that case it doesn't affect $CFG.
1137  *
1138  * A NULL value will delete the entry.
1139  *
1140  * @global object
1141  * @global object
1142  * @param string $name the key to set
1143  * @param string $value the value to set (without magic quotes)
1144  * @param string $plugin (optional) the plugin scope, default NULL
1145  * @return bool true or exception
1146  */
1147 function set_config($name, $value, $plugin=NULL) {
1148     global $CFG, $DB;
1150     if (empty($plugin)) {
1151         if (!array_key_exists($name, $CFG->config_php_settings)) {
1152             // So it's defined for this invocation at least
1153             if (is_null($value)) {
1154                 unset($CFG->$name);
1155             } else {
1156                 $CFG->$name = (string)$value; // settings from db are always strings
1157             }
1158         }
1160         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1161             if ($value === null) {
1162                 $DB->delete_records('config', array('name'=>$name));
1163             } else {
1164                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1165             }
1166         } else {
1167             if ($value !== null) {
1168                 $config = new stdClass();
1169                 $config->name  = $name;
1170                 $config->value = $value;
1171                 $DB->insert_record('config', $config, false);
1172             }
1173         }
1175     } else { // plugin scope
1176         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1177             if ($value===null) {
1178                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1179             } else {
1180                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1181             }
1182         } else {
1183             if ($value !== null) {
1184                 $config = new stdClass();
1185                 $config->plugin = $plugin;
1186                 $config->name   = $name;
1187                 $config->value  = $value;
1188                 $DB->insert_record('config_plugins', $config, false);
1189             }
1190         }
1191     }
1193     return true;
1196 /**
1197  * Get configuration values from the global config table
1198  * or the config_plugins table.
1199  *
1200  * If called with one parameter, it will load all the config
1201  * variables for one plugin, and return them as an object.
1202  *
1203  * If called with 2 parameters it will return a string single
1204  * value or false if the value is not found.
1205  *
1206  * @param string $plugin full component name
1207  * @param string $name default NULL
1208  * @return mixed hash-like object or single value, return false no config found
1209  */
1210 function get_config($plugin, $name = NULL) {
1211     global $CFG, $DB;
1213     // normalise component name
1214     if ($plugin === 'moodle' or $plugin === 'core') {
1215         $plugin = NULL;
1216     }
1218     if (!empty($name)) { // the user is asking for a specific value
1219         if (!empty($plugin)) {
1220             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1221                 // setting forced in config file
1222                 return $CFG->forced_plugin_settings[$plugin][$name];
1223             } else {
1224                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1225             }
1226         } else {
1227             if (array_key_exists($name, $CFG->config_php_settings)) {
1228                 // setting force in config file
1229                 return $CFG->config_php_settings[$name];
1230             } else {
1231                 return $DB->get_field('config', 'value', array('name'=>$name));
1232             }
1233         }
1234     }
1236     // the user is after a recordset
1237     if ($plugin) {
1238         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1239         if (isset($CFG->forced_plugin_settings[$plugin])) {
1240             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1241                 if (is_null($v) or is_array($v) or is_object($v)) {
1242                     // we do not want any extra mess here, just real settings that could be saved in db
1243                     unset($localcfg[$n]);
1244                 } else {
1245                     //convert to string as if it went through the DB
1246                     $localcfg[$n] = (string)$v;
1247                 }
1248             }
1249         }
1250         if ($localcfg) {
1251             return (object)$localcfg;
1252         } else {
1253             return null;
1254         }
1256     } else {
1257         // this part is not really used any more, but anyway...
1258         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1259         foreach($CFG->config_php_settings as $n=>$v) {
1260             if (is_null($v) or is_array($v) or is_object($v)) {
1261                 // we do not want any extra mess here, just real settings that could be saved in db
1262                 unset($localcfg[$n]);
1263             } else {
1264                 //convert to string as if it went through the DB
1265                 $localcfg[$n] = (string)$v;
1266             }
1267         }
1268         return (object)$localcfg;
1269     }
1272 /**
1273  * Removes a key from global configuration
1274  *
1275  * @param string $name the key to set
1276  * @param string $plugin (optional) the plugin scope
1277  * @global object
1278  * @return boolean whether the operation succeeded.
1279  */
1280 function unset_config($name, $plugin=NULL) {
1281     global $CFG, $DB;
1283     if (empty($plugin)) {
1284         unset($CFG->$name);
1285         $DB->delete_records('config', array('name'=>$name));
1286     } else {
1287         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1288     }
1290     return true;
1293 /**
1294  * Remove all the config variables for a given plugin.
1295  *
1296  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1297  * @return boolean whether the operation succeeded.
1298  */
1299 function unset_all_config_for_plugin($plugin) {
1300     global $DB;
1301     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1302     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
1303     return true;
1306 /**
1307  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1308  *
1309  * All users are verified if they still have the necessary capability.
1310  *
1311  * @param string $value the value of the config setting.
1312  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1313  * @param bool $include admins, include administrators
1314  * @return array of user objects.
1315  */
1316 function get_users_from_config($value, $capability, $includeadmins = true) {
1317     global $CFG, $DB;
1319     if (empty($value) or $value === '$@NONE@$') {
1320         return array();
1321     }
1323     // we have to make sure that users still have the necessary capability,
1324     // it should be faster to fetch them all first and then test if they are present
1325     // instead of validating them one-by-one
1326     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1327     if ($includeadmins) {
1328         $admins = get_admins();
1329         foreach ($admins as $admin) {
1330             $users[$admin->id] = $admin;
1331         }
1332     }
1334     if ($value === '$@ALL@$') {
1335         return $users;
1336     }
1338     $result = array(); // result in correct order
1339     $allowed = explode(',', $value);
1340     foreach ($allowed as $uid) {
1341         if (isset($users[$uid])) {
1342             $user = $users[$uid];
1343             $result[$user->id] = $user;
1344         }
1345     }
1347     return $result;
1351 /**
1352  * Invalidates browser caches and cached data in temp
1353  * @return void
1354  */
1355 function purge_all_caches() {
1356     global $CFG;
1358     reset_text_filters_cache();
1359     js_reset_all_caches();
1360     theme_reset_all_caches();
1361     get_string_manager()->reset_caches();
1363     // purge all other caches: rss, simplepie, etc.
1364     remove_dir($CFG->dataroot.'/cache', true);
1366     // make sure cache dir is writable, throws exception if not
1367     make_upload_directory('cache');
1369     // hack: this script may get called after the purifier was initialised,
1370     // but we do not want to verify repeatedly this exists in each call
1371     make_upload_directory('cache/htmlpurifier');
1373     clearstatcache();
1376 /**
1377  * Get volatile flags
1378  *
1379  * @param string $type
1380  * @param int    $changedsince default null
1381  * @return records array
1382  */
1383 function get_cache_flags($type, $changedsince=NULL) {
1384     global $DB;
1386     $params = array('type'=>$type, 'expiry'=>time());
1387     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1388     if ($changedsince !== NULL) {
1389         $params['changedsince'] = $changedsince;
1390         $sqlwhere .= " AND timemodified > :changedsince";
1391     }
1392     $cf = array();
1394     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1395         foreach ($flags as $flag) {
1396             $cf[$flag->name] = $flag->value;
1397         }
1398     }
1399     return $cf;
1402 /**
1403  * Get volatile flags
1404  *
1405  * @param string $type
1406  * @param string $name
1407  * @param int    $changedsince default null
1408  * @return records array
1409  */
1410 function get_cache_flag($type, $name, $changedsince=NULL) {
1411     global $DB;
1413     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1415     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1416     if ($changedsince !== NULL) {
1417         $params['changedsince'] = $changedsince;
1418         $sqlwhere .= " AND timemodified > :changedsince";
1419     }
1421     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1424 /**
1425  * Set a volatile flag
1426  *
1427  * @param string $type the "type" namespace for the key
1428  * @param string $name the key to set
1429  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1430  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1431  * @return bool Always returns true
1432  */
1433 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1434     global $DB;
1436     $timemodified = time();
1437     if ($expiry===NULL || $expiry < $timemodified) {
1438         $expiry = $timemodified + 24 * 60 * 60;
1439     } else {
1440         $expiry = (int)$expiry;
1441     }
1443     if ($value === NULL) {
1444         unset_cache_flag($type,$name);
1445         return true;
1446     }
1448     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1449         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1450             return true; //no need to update; helps rcache too
1451         }
1452         $f->value        = $value;
1453         $f->expiry       = $expiry;
1454         $f->timemodified = $timemodified;
1455         $DB->update_record('cache_flags', $f);
1456     } else {
1457         $f = new stdClass();
1458         $f->flagtype     = $type;
1459         $f->name         = $name;
1460         $f->value        = $value;
1461         $f->expiry       = $expiry;
1462         $f->timemodified = $timemodified;
1463         $DB->insert_record('cache_flags', $f);
1464     }
1465     return true;
1468 /**
1469  * Removes a single volatile flag
1470  *
1471  * @global object
1472  * @param string $type the "type" namespace for the key
1473  * @param string $name the key to set
1474  * @return bool
1475  */
1476 function unset_cache_flag($type, $name) {
1477     global $DB;
1478     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1479     return true;
1482 /**
1483  * Garbage-collect volatile flags
1484  *
1485  * @return bool Always returns true
1486  */
1487 function gc_cache_flags() {
1488     global $DB;
1489     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1490     return true;
1493 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1495 /**
1496  * Refresh user preference cache. This is used most often for $USER
1497  * object that is stored in session, but it also helps with performance in cron script.
1498  *
1499  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1500  *
1501  * @param stdClass $user user object, preferences are preloaded into ->preference property
1502  * @param int $cachelifetime cache life time on the current page (ins seconds)
1503  * @return void
1504  */
1505 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1506     global $DB;
1507     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1509     if (!isset($user->id)) {
1510         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1511     }
1513     if (empty($user->id) or isguestuser($user->id)) {
1514         // No permanent storage for not-logged-in users and guest
1515         if (!isset($user->preference)) {
1516             $user->preference = array();
1517         }
1518         return;
1519     }
1521     $timenow = time();
1523     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1524         // Already loaded at least once on this page. Are we up to date?
1525         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1526             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1527             return;
1529         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1530             // no change since the lastcheck on this page
1531             $user->preference['_lastloaded'] = $timenow;
1532             return;
1533         }
1534     }
1536     // OK, so we have to reload all preferences
1537     $loadedusers[$user->id] = true;
1538     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1539     $user->preference['_lastloaded'] = $timenow;
1542 /**
1543  * Called from set/delete_user_preferences, so that the prefs can
1544  * be correctly reloaded in different sessions.
1545  *
1546  * NOTE: internal function, do not call from other code.
1547  *
1548  * @param integer $userid the user whose prefs were changed.
1549  * @return void
1550  */
1551 function mark_user_preferences_changed($userid) {
1552     global $CFG;
1554     if (empty($userid) or isguestuser($userid)) {
1555         // no cache flags for guest and not-logged-in users
1556         return;
1557     }
1559     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1562 /**
1563  * Sets a preference for the specified user.
1564  *
1565  * If user object submitted, 'preference' property contains the preferences cache.
1566  *
1567  * @param string $name The key to set as preference for the specified user
1568  * @param string $value The value to set for the $name key in the specified user's record,
1569  *                      null means delete current value
1570  * @param stdClass|int $user A moodle user object or id, null means current user
1571  * @return bool always true or exception
1572  */
1573 function set_user_preference($name, $value, $user = null) {
1574     global $USER, $DB;
1576     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1577         throw new coding_exception('Invalid preference name in set_user_preference() call');
1578     }
1580     if (is_null($value)) {
1581         // null means delete current
1582         return unset_user_preference($name, $user);
1583     } else if (is_object($value)) {
1584         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1585     } else if (is_array($value)) {
1586         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1587     }
1588     $value = (string)$value;
1590     if (is_null($user)) {
1591         $user = $USER;
1592     } else if (isset($user->id)) {
1593         // $user is valid object
1594     } else if (is_numeric($user)) {
1595         $user = (object)array('id'=>(int)$user);
1596     } else {
1597         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1598     }
1600     check_user_preferences_loaded($user);
1602     if (empty($user->id) or isguestuser($user->id)) {
1603         // no permanent storage for not-logged-in users and guest
1604         $user->preference[$name] = $value;
1605         return true;
1606     }
1608     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1609         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1610             // preference already set to this value
1611             return true;
1612         }
1613         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1615     } else {
1616         $preference = new stdClass();
1617         $preference->userid = $user->id;
1618         $preference->name   = $name;
1619         $preference->value  = $value;
1620         $DB->insert_record('user_preferences', $preference);
1621     }
1623     // update value in cache
1624     $user->preference[$name] = $value;
1626     // set reload flag for other sessions
1627     mark_user_preferences_changed($user->id);
1629     return true;
1632 /**
1633  * Sets a whole array of preferences for the current user
1634  *
1635  * If user object submitted, 'preference' property contains the preferences cache.
1636  *
1637  * @param array $prefarray An array of key/value pairs to be set
1638  * @param stdClass|int $user A moodle user object or id, null means current user
1639  * @return bool always true or exception
1640  */
1641 function set_user_preferences(array $prefarray, $user = null) {
1642     foreach ($prefarray as $name => $value) {
1643         set_user_preference($name, $value, $user);
1644     }
1645     return true;
1648 /**
1649  * Unsets a preference completely by deleting it from the database
1650  *
1651  * If user object submitted, 'preference' property contains the preferences cache.
1652  *
1653  * @param string  $name The key to unset as preference for the specified user
1654  * @param stdClass|int $user A moodle user object or id, null means current user
1655  * @return bool always true or exception
1656  */
1657 function unset_user_preference($name, $user = null) {
1658     global $USER, $DB;
1660     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1661         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1662     }
1664     if (is_null($user)) {
1665         $user = $USER;
1666     } else if (isset($user->id)) {
1667         // $user is valid object
1668     } else if (is_numeric($user)) {
1669         $user = (object)array('id'=>(int)$user);
1670     } else {
1671         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1672     }
1674     check_user_preferences_loaded($user);
1676     if (empty($user->id) or isguestuser($user->id)) {
1677         // no permanent storage for not-logged-in user and guest
1678         unset($user->preference[$name]);
1679         return true;
1680     }
1682     // delete from DB
1683     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1685     // delete the preference from cache
1686     unset($user->preference[$name]);
1688     // set reload flag for other sessions
1689     mark_user_preferences_changed($user->id);
1691     return true;
1694 /**
1695  * Used to fetch user preference(s)
1696  *
1697  * If no arguments are supplied this function will return
1698  * all of the current user preferences as an array.
1699  *
1700  * If a name is specified then this function
1701  * attempts to return that particular preference value.  If
1702  * none is found, then the optional value $default is returned,
1703  * otherwise NULL.
1704  *
1705  * If user object submitted, 'preference' property contains the preferences cache.
1706  *
1707  * @param string $name Name of the key to use in finding a preference value
1708  * @param mixed $default Value to be returned if the $name key is not set in the user preferences
1709  * @param stdClass|int $user A moodle user object or id, null means current user
1710  * @return mixed string value or default
1711  */
1712 function get_user_preferences($name = null, $default = null, $user = null) {
1713     global $USER;
1715     if (is_null($name)) {
1716         // all prefs
1717     } else if (is_numeric($name) or $name === '_lastloaded') {
1718         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1719     }
1721     if (is_null($user)) {
1722         $user = $USER;
1723     } else if (isset($user->id)) {
1724         // $user is valid object
1725     } else if (is_numeric($user)) {
1726         $user = (object)array('id'=>(int)$user);
1727     } else {
1728         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1729     }
1731     check_user_preferences_loaded($user);
1733     if (empty($name)) {
1734         return $user->preference; // All values
1735     } else if (isset($user->preference[$name])) {
1736         return $user->preference[$name]; // The single string value
1737     } else {
1738         return $default; // Default value (null if not specified)
1739     }
1742 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1744 /**
1745  * Given date parts in user time produce a GMT timestamp.
1746  *
1747  * @todo Finish documenting this function
1748  * @param int $year The year part to create timestamp of
1749  * @param int $month The month part to create timestamp of
1750  * @param int $day The day part to create timestamp of
1751  * @param int $hour The hour part to create timestamp of
1752  * @param int $minute The minute part to create timestamp of
1753  * @param int $second The second part to create timestamp of
1754  * @param mixed $timezone Timezone modifier, if 99 then use default user's timezone
1755  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1756  *             applied only if timezone is 99 or string.
1757  * @return int timestamp
1758  */
1759 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1761     //save input timezone, required for dst offset check.
1762     $passedtimezone = $timezone;
1764     $timezone = get_user_timezone_offset($timezone);
1766     if (abs($timezone) > 13) {  //server time
1767         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1768     } else {
1769         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1770         $time = usertime($time, $timezone);
1772         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1773         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1774             $time -= dst_offset_on($time, $passedtimezone);
1775         }
1776     }
1778     return $time;
1782 /**
1783  * Format a date/time (seconds) as weeks, days, hours etc as needed
1784  *
1785  * Given an amount of time in seconds, returns string
1786  * formatted nicely as weeks, days, hours etc as needed
1787  *
1788  * @uses MINSECS
1789  * @uses HOURSECS
1790  * @uses DAYSECS
1791  * @uses YEARSECS
1792  * @param int $totalsecs Time in seconds
1793  * @param object $str Should be a time object
1794  * @return string A nicely formatted date/time string
1795  */
1796  function format_time($totalsecs, $str=NULL) {
1798     $totalsecs = abs($totalsecs);
1800     if (!$str) {  // Create the str structure the slow way
1801         $str->day   = get_string('day');
1802         $str->days  = get_string('days');
1803         $str->hour  = get_string('hour');
1804         $str->hours = get_string('hours');
1805         $str->min   = get_string('min');
1806         $str->mins  = get_string('mins');
1807         $str->sec   = get_string('sec');
1808         $str->secs  = get_string('secs');
1809         $str->year  = get_string('year');
1810         $str->years = get_string('years');
1811     }
1814     $years     = floor($totalsecs/YEARSECS);
1815     $remainder = $totalsecs - ($years*YEARSECS);
1816     $days      = floor($remainder/DAYSECS);
1817     $remainder = $totalsecs - ($days*DAYSECS);
1818     $hours     = floor($remainder/HOURSECS);
1819     $remainder = $remainder - ($hours*HOURSECS);
1820     $mins      = floor($remainder/MINSECS);
1821     $secs      = $remainder - ($mins*MINSECS);
1823     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1824     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1825     $sh = ($hours == 1) ? $str->hour : $str->hours;
1826     $sd = ($days == 1)  ? $str->day  : $str->days;
1827     $sy = ($years == 1)  ? $str->year  : $str->years;
1829     $oyears = '';
1830     $odays = '';
1831     $ohours = '';
1832     $omins = '';
1833     $osecs = '';
1835     if ($years)  $oyears  = $years .' '. $sy;
1836     if ($days)  $odays  = $days .' '. $sd;
1837     if ($hours) $ohours = $hours .' '. $sh;
1838     if ($mins)  $omins  = $mins .' '. $sm;
1839     if ($secs)  $osecs  = $secs .' '. $ss;
1841     if ($years) return trim($oyears .' '. $odays);
1842     if ($days)  return trim($odays .' '. $ohours);
1843     if ($hours) return trim($ohours .' '. $omins);
1844     if ($mins)  return trim($omins .' '. $osecs);
1845     if ($secs)  return $osecs;
1846     return get_string('now');
1849 /**
1850  * Returns a formatted string that represents a date in user time
1851  *
1852  * Returns a formatted string that represents a date in user time
1853  * <b>WARNING: note that the format is for strftime(), not date().</b>
1854  * Because of a bug in most Windows time libraries, we can't use
1855  * the nicer %e, so we have to use %d which has leading zeroes.
1856  * A lot of the fuss in the function is just getting rid of these leading
1857  * zeroes as efficiently as possible.
1858  *
1859  * If parameter fixday = true (default), then take off leading
1860  * zero from %d, else maintain it.
1861  *
1862  * @param int $date the timestamp in UTC, as obtained from the database.
1863  * @param string $format strftime format. You should probably get this using
1864  *      get_string('strftime...', 'langconfig');
1865  * @param mixed $timezone by default, uses the user's time zone. if numeric and
1866  *      not 99 then daylight saving will not be added.
1867  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1868  *      If false then the leading zero is maintained.
1869  * @return string the formatted date/time.
1870  */
1871 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1873     global $CFG;
1875     if (empty($format)) {
1876         $format = get_string('strftimedaydatetime', 'langconfig');
1877     }
1879     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1880         $fixday = false;
1881     } else if ($fixday) {
1882         $formatnoday = str_replace('%d', 'DD', $format);
1883         $fixday = ($formatnoday != $format);
1884     }
1886     //add daylight saving offset for string timezones only, as we can't get dst for
1887     //float values. if timezone is 99 (user default timezone), then try update dst.
1888     if ((99 == $timezone) || !is_numeric($timezone)) {
1889         $date += dst_offset_on($date, $timezone);
1890     }
1892     $timezone = get_user_timezone_offset($timezone);
1894     if (abs($timezone) > 13) {   /// Server time
1895         if ($fixday) {
1896             $datestring = strftime($formatnoday, $date);
1897             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1898             $datestring = str_replace('DD', $daystring, $datestring);
1899         } else {
1900             $datestring = strftime($format, $date);
1901         }
1902     } else {
1903         $date += (int)($timezone * 3600);
1904         if ($fixday) {
1905             $datestring = gmstrftime($formatnoday, $date);
1906             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1907             $datestring = str_replace('DD', $daystring, $datestring);
1908         } else {
1909             $datestring = gmstrftime($format, $date);
1910         }
1911     }
1913 /// If we are running under Windows convert from windows encoding to UTF-8
1914 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1916    if ($CFG->ostype == 'WINDOWS') {
1917        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1918            $textlib = textlib_get_instance();
1919            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1920        }
1921    }
1923     return $datestring;
1926 /**
1927  * Given a $time timestamp in GMT (seconds since epoch),
1928  * returns an array that represents the date in user time
1929  *
1930  * @todo Finish documenting this function
1931  * @uses HOURSECS
1932  * @param int $time Timestamp in GMT
1933  * @param mixed $timezone offset time with timezone, if float and not 99, then no
1934  *        dst offset is applyed
1935  * @return array An array that represents the date in user time
1936  */
1937 function usergetdate($time, $timezone=99) {
1939     //save input timezone, required for dst offset check.
1940     $passedtimezone = $timezone;
1942     $timezone = get_user_timezone_offset($timezone);
1944     if (abs($timezone) > 13) {    // Server time
1945         return getdate($time);
1946     }
1948     //add daylight saving offset for string timezones only, as we can't get dst for
1949     //float values. if timezone is 99 (user default timezone), then try update dst.
1950     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
1951         $time += dst_offset_on($time, $passedtimezone);
1952     }
1954     $time += intval((float)$timezone * HOURSECS);
1956     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1958     //be careful to ensure the returned array matches that produced by getdate() above
1959     list(
1960         $getdate['month'],
1961         $getdate['weekday'],
1962         $getdate['yday'],
1963         $getdate['year'],
1964         $getdate['mon'],
1965         $getdate['wday'],
1966         $getdate['mday'],
1967         $getdate['hours'],
1968         $getdate['minutes'],
1969         $getdate['seconds']
1970     ) = explode('_', $datestring);
1972     return $getdate;
1975 /**
1976  * Given a GMT timestamp (seconds since epoch), offsets it by
1977  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1978  *
1979  * @uses HOURSECS
1980  * @param  int $date Timestamp in GMT
1981  * @param float $timezone
1982  * @return int
1983  */
1984 function usertime($date, $timezone=99) {
1986     $timezone = get_user_timezone_offset($timezone);
1988     if (abs($timezone) > 13) {
1989         return $date;
1990     }
1991     return $date - (int)($timezone * HOURSECS);
1994 /**
1995  * Given a time, return the GMT timestamp of the most recent midnight
1996  * for the current user.
1997  *
1998  * @param int $date Timestamp in GMT
1999  * @param float $timezone Defaults to user's timezone
2000  * @return int Returns a GMT timestamp
2001  */
2002 function usergetmidnight($date, $timezone=99) {
2004     $userdate = usergetdate($date, $timezone);
2006     // Time of midnight of this user's day, in GMT
2007     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2011 /**
2012  * Returns a string that prints the user's timezone
2013  *
2014  * @param float $timezone The user's timezone
2015  * @return string
2016  */
2017 function usertimezone($timezone=99) {
2019     $tz = get_user_timezone($timezone);
2021     if (!is_float($tz)) {
2022         return $tz;
2023     }
2025     if(abs($tz) > 13) { // Server time
2026         return get_string('serverlocaltime');
2027     }
2029     if($tz == intval($tz)) {
2030         // Don't show .0 for whole hours
2031         $tz = intval($tz);
2032     }
2034     if($tz == 0) {
2035         return 'UTC';
2036     }
2037     else if($tz > 0) {
2038         return 'UTC+'.$tz;
2039     }
2040     else {
2041         return 'UTC'.$tz;
2042     }
2046 /**
2047  * Returns a float which represents the user's timezone difference from GMT in hours
2048  * Checks various settings and picks the most dominant of those which have a value
2049  *
2050  * @global object
2051  * @global object
2052  * @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
2053  * @return float
2054  */
2055 function get_user_timezone_offset($tz = 99) {
2057     global $USER, $CFG;
2059     $tz = get_user_timezone($tz);
2061     if (is_float($tz)) {
2062         return $tz;
2063     } else {
2064         $tzrecord = get_timezone_record($tz);
2065         if (empty($tzrecord)) {
2066             return 99.0;
2067         }
2068         return (float)$tzrecord->gmtoff / HOURMINS;
2069     }
2072 /**
2073  * Returns an int which represents the systems's timezone difference from GMT in seconds
2074  *
2075  * @global object
2076  * @param mixed $tz timezone
2077  * @return int if found, false is timezone 99 or error
2078  */
2079 function get_timezone_offset($tz) {
2080     global $CFG;
2082     if ($tz == 99) {
2083         return false;
2084     }
2086     if (is_numeric($tz)) {
2087         return intval($tz * 60*60);
2088     }
2090     if (!$tzrecord = get_timezone_record($tz)) {
2091         return false;
2092     }
2093     return intval($tzrecord->gmtoff * 60);
2096 /**
2097  * Returns a float or a string which denotes the user's timezone
2098  * 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)
2099  * means that for this timezone there are also DST rules to be taken into account
2100  * Checks various settings and picks the most dominant of those which have a value
2101  *
2102  * @global object
2103  * @global object
2104  * @param mixed $tz If this value is provided and not equal to 99, it will be returned as is and no other settings will be checked
2105  * @return mixed
2106  */
2107 function get_user_timezone($tz = 99) {
2108     global $USER, $CFG;
2110     $timezones = array(
2111         $tz,
2112         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2113         isset($USER->timezone) ? $USER->timezone : 99,
2114         isset($CFG->timezone) ? $CFG->timezone : 99,
2115         );
2117     $tz = 99;
2119     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
2120         $tz = $next['value'];
2121     }
2123     return is_numeric($tz) ? (float) $tz : $tz;
2126 /**
2127  * Returns cached timezone record for given $timezonename
2128  *
2129  * @global object
2130  * @global object
2131  * @param string $timezonename
2132  * @return mixed timezonerecord object or false
2133  */
2134 function get_timezone_record($timezonename) {
2135     global $CFG, $DB;
2136     static $cache = NULL;
2138     if ($cache === NULL) {
2139         $cache = array();
2140     }
2142     if (isset($cache[$timezonename])) {
2143         return $cache[$timezonename];
2144     }
2146     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2147                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
2150 /**
2151  * Build and store the users Daylight Saving Time (DST) table
2152  *
2153  * @global object
2154  * @global object
2155  * @global object
2156  * @param mixed $from_year Start year for the table, defaults to 1971
2157  * @param mixed $to_year End year for the table, defaults to 2035
2158  * @param mixed $strtimezone, if null or 99 then user's default timezone is used
2159  * @return bool
2160  */
2161 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2162     global $CFG, $SESSION, $DB;
2164     $usertz = get_user_timezone($strtimezone);
2166     if (is_float($usertz)) {
2167         // Trivial timezone, no DST
2168         return false;
2169     }
2171     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2172         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2173         unset($SESSION->dst_offsets);
2174         unset($SESSION->dst_range);
2175     }
2177     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2178         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2179         // This will be the return path most of the time, pretty light computationally
2180         return true;
2181     }
2183     // Reaching here means we either need to extend our table or create it from scratch
2185     // Remember which TZ we calculated these changes for
2186     $SESSION->dst_offsettz = $usertz;
2188     if(empty($SESSION->dst_offsets)) {
2189         // If we 're creating from scratch, put the two guard elements in there
2190         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2191     }
2192     if(empty($SESSION->dst_range)) {
2193         // If creating from scratch
2194         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2195         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2197         // Fill in the array with the extra years we need to process
2198         $yearstoprocess = array();
2199         for($i = $from; $i <= $to; ++$i) {
2200             $yearstoprocess[] = $i;
2201         }
2203         // Take note of which years we have processed for future calls
2204         $SESSION->dst_range = array($from, $to);
2205     }
2206     else {
2207         // If needing to extend the table, do the same
2208         $yearstoprocess = array();
2210         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2211         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2213         if($from < $SESSION->dst_range[0]) {
2214             // Take note of which years we need to process and then note that we have processed them for future calls
2215             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2216                 $yearstoprocess[] = $i;
2217             }
2218             $SESSION->dst_range[0] = $from;
2219         }
2220         if($to > $SESSION->dst_range[1]) {
2221             // Take note of which years we need to process and then note that we have processed them for future calls
2222             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2223                 $yearstoprocess[] = $i;
2224             }
2225             $SESSION->dst_range[1] = $to;
2226         }
2227     }
2229     if(empty($yearstoprocess)) {
2230         // This means that there was a call requesting a SMALLER range than we have already calculated
2231         return true;
2232     }
2234     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2235     // Also, the array is sorted in descending timestamp order!
2237     // Get DB data
2239     static $presets_cache = array();
2240     if (!isset($presets_cache[$usertz])) {
2241         $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');
2242     }
2243     if(empty($presets_cache[$usertz])) {
2244         return false;
2245     }
2247     // Remove ending guard (first element of the array)
2248     reset($SESSION->dst_offsets);
2249     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2251     // Add all required change timestamps
2252     foreach($yearstoprocess as $y) {
2253         // Find the record which is in effect for the year $y
2254         foreach($presets_cache[$usertz] as $year => $preset) {
2255             if($year <= $y) {
2256                 break;
2257             }
2258         }
2260         $changes = dst_changes_for_year($y, $preset);
2262         if($changes === NULL) {
2263             continue;
2264         }
2265         if($changes['dst'] != 0) {
2266             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2267         }
2268         if($changes['std'] != 0) {
2269             $SESSION->dst_offsets[$changes['std']] = 0;
2270         }
2271     }
2273     // Put in a guard element at the top
2274     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2275     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2277     // Sort again
2278     krsort($SESSION->dst_offsets);
2280     return true;
2283 /**
2284  * Calculates the required DST change and returns a Timestamp Array
2285  *
2286  * @uses HOURSECS
2287  * @uses MINSECS
2288  * @param mixed $year Int or String Year to focus on
2289  * @param object $timezone Instatiated Timezone object
2290  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
2291  */
2292 function dst_changes_for_year($year, $timezone) {
2294     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2295         return NULL;
2296     }
2298     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2299     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2301     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2302     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2304     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2305     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2307     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2308     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2309     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2311     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2312     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2314     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2317 /**
2318  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2319  * - Note: Daylight saving only works for string timezones and not for float.
2320  *
2321  * @global object
2322  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2323  * @param mixed $strtimezone timezone for which offset is expected, if 99 or null
2324  *        then user's default timezone is used.
2325  * @return int
2326  */
2327 function dst_offset_on($time, $strtimezone = NULL) {
2328     global $SESSION;
2330     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2331         return 0;
2332     }
2334     reset($SESSION->dst_offsets);
2335     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2336         if($from <= $time) {
2337             break;
2338         }
2339     }
2341     // This is the normal return path
2342     if($offset !== NULL) {
2343         return $offset;
2344     }
2346     // Reaching this point means we haven't calculated far enough, do it now:
2347     // Calculate extra DST changes if needed and recurse. The recursion always
2348     // moves toward the stopping condition, so will always end.
2350     if($from == 0) {
2351         // We need a year smaller than $SESSION->dst_range[0]
2352         if($SESSION->dst_range[0] == 1971) {
2353             return 0;
2354         }
2355         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2356         return dst_offset_on($time, $strtimezone);
2357     }
2358     else {
2359         // We need a year larger than $SESSION->dst_range[1]
2360         if($SESSION->dst_range[1] == 2035) {
2361             return 0;
2362         }
2363         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2364         return dst_offset_on($time, $strtimezone);
2365     }
2368 /**
2369  * ?
2370  *
2371  * @todo Document what this function does
2372  * @param int $startday
2373  * @param int $weekday
2374  * @param int $month
2375  * @param int $year
2376  * @return int
2377  */
2378 function find_day_in_month($startday, $weekday, $month, $year) {
2380     $daysinmonth = days_in_month($month, $year);
2382     if($weekday == -1) {
2383         // Don't care about weekday, so return:
2384         //    abs($startday) if $startday != -1
2385         //    $daysinmonth otherwise
2386         return ($startday == -1) ? $daysinmonth : abs($startday);
2387     }
2389     // From now on we 're looking for a specific weekday
2391     // Give "end of month" its actual value, since we know it
2392     if($startday == -1) {
2393         $startday = -1 * $daysinmonth;
2394     }
2396     // Starting from day $startday, the sign is the direction
2398     if($startday < 1) {
2400         $startday = abs($startday);
2401         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2403         // This is the last such weekday of the month
2404         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2405         if($lastinmonth > $daysinmonth) {
2406             $lastinmonth -= 7;
2407         }
2409         // Find the first such weekday <= $startday
2410         while($lastinmonth > $startday) {
2411             $lastinmonth -= 7;
2412         }
2414         return $lastinmonth;
2416     }
2417     else {
2419         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2421         $diff = $weekday - $indexweekday;
2422         if($diff < 0) {
2423             $diff += 7;
2424         }
2426         // This is the first such weekday of the month equal to or after $startday
2427         $firstfromindex = $startday + $diff;
2429         return $firstfromindex;
2431     }
2434 /**
2435  * Calculate the number of days in a given month
2436  *
2437  * @param int $month The month whose day count is sought
2438  * @param int $year The year of the month whose day count is sought
2439  * @return int
2440  */
2441 function days_in_month($month, $year) {
2442    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2445 /**
2446  * Calculate the position in the week of a specific calendar day
2447  *
2448  * @param int $day The day of the date whose position in the week is sought
2449  * @param int $month The month of the date whose position in the week is sought
2450  * @param int $year The year of the date whose position in the week is sought
2451  * @return int
2452  */
2453 function dayofweek($day, $month, $year) {
2454     // I wonder if this is any different from
2455     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2456     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2459 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2461 /**
2462  * Returns full login url.
2463  *
2464  * @return string login url
2465  */
2466 function get_login_url() {
2467     global $CFG;
2469     $url = "$CFG->wwwroot/login/index.php";
2471     if (!empty($CFG->loginhttps)) {
2472         $url = str_replace('http:', 'https:', $url);
2473     }
2475     return $url;
2478 /**
2479  * This function checks that the current user is logged in and has the
2480  * required privileges
2481  *
2482  * This function checks that the current user is logged in, and optionally
2483  * whether they are allowed to be in a particular course and view a particular
2484  * course module.
2485  * If they are not logged in, then it redirects them to the site login unless
2486  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2487  * case they are automatically logged in as guests.
2488  * If $courseid is given and the user is not enrolled in that course then the
2489  * user is redirected to the course enrolment page.
2490  * If $cm is given and the course module is hidden and the user is not a teacher
2491  * in the course then the user is redirected to the course home page.
2492  *
2493  * When $cm parameter specified, this function sets page layout to 'module'.
2494  * You need to change it manually later if some other layout needed.
2495  *
2496  * @param mixed $courseorid id of the course or course object
2497  * @param bool $autologinguest default true
2498  * @param object $cm course module object
2499  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2500  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2501  *             in order to keep redirects working properly. MDL-14495
2502  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2503  * @return mixed Void, exit, and die depending on path
2504  */
2505 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2506     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2508     // setup global $COURSE, themes, language and locale
2509     if (!empty($courseorid)) {
2510         if (is_object($courseorid)) {
2511             $course = $courseorid;
2512         } else if ($courseorid == SITEID) {
2513             $course = clone($SITE);
2514         } else {
2515             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2516         }
2517         if ($cm) {
2518             if ($cm->course != $course->id) {
2519                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2520             }
2521             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2522             if (!($cm instanceof cm_info)) {
2523                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2524                 // db queries so this is not really a performance concern, however it is obviously
2525                 // better if you use get_fast_modinfo to get the cm before calling this.
2526                 $modinfo = get_fast_modinfo($course);
2527                 $cm = $modinfo->get_cm($cm->id);
2528             }
2529             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2530             $PAGE->set_pagelayout('incourse');
2531         } else {
2532             $PAGE->set_course($course); // set's up global $COURSE
2533         }
2534     } else {
2535         // do not touch global $COURSE via $PAGE->set_course(),
2536         // the reasons is we need to be able to call require_login() at any time!!
2537         $course = $SITE;
2538         if ($cm) {
2539             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2540         }
2541     }
2543     // If the user is not even logged in yet then make sure they are
2544     if (!isloggedin()) {
2545         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2546             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2547                 // misconfigured site guest, just redirect to login page
2548                 redirect(get_login_url());
2549                 exit; // never reached
2550             }
2551             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2552             complete_user_login($guest);
2553             $USER->autologinguest = true;
2554             $SESSION->lang = $lang;
2555         } else {
2556             //NOTE: $USER->site check was obsoleted by session test cookie,
2557             //      $USER->confirmed test is in login/index.php
2558             if ($preventredirect) {
2559                 throw new require_login_exception('You are not logged in');
2560             }
2562             if ($setwantsurltome) {
2563                 // TODO: switch to PAGE->url
2564                 $SESSION->wantsurl = $FULLME;
2565             }
2566             if (!empty($_SERVER['HTTP_REFERER'])) {
2567                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2568             }
2569             redirect(get_login_url());
2570             exit; // never reached
2571         }
2572     }
2574     // loginas as redirection if needed
2575     if ($course->id != SITEID and session_is_loggedinas()) {
2576         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2577             if ($USER->loginascontext->instanceid != $course->id) {
2578                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2579             }
2580         }
2581     }
2583     // check whether the user should be changing password (but only if it is REALLY them)
2584     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2585         $userauth = get_auth_plugin($USER->auth);
2586         if ($userauth->can_change_password() and !$preventredirect) {
2587             $SESSION->wantsurl = $FULLME;
2588             if ($changeurl = $userauth->change_password_url()) {
2589                 //use plugin custom url
2590                 redirect($changeurl);
2591             } else {
2592                 //use moodle internal method
2593                 if (empty($CFG->loginhttps)) {
2594                     redirect($CFG->wwwroot .'/login/change_password.php');
2595                 } else {
2596                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2597                     redirect($wwwroot .'/login/change_password.php');
2598                 }
2599             }
2600         } else {
2601             print_error('nopasswordchangeforced', 'auth');
2602         }
2603     }
2605     // Check that the user account is properly set up
2606     if (user_not_fully_set_up($USER)) {
2607         if ($preventredirect) {
2608             throw new require_login_exception('User not fully set-up');
2609         }
2610         $SESSION->wantsurl = $FULLME;
2611         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2612     }
2614     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2615     sesskey();
2617     // Do not bother admins with any formalities
2618     if (is_siteadmin()) {
2619         //set accesstime or the user will appear offline which messes up messaging
2620         user_accesstime_log($course->id);
2621         return;
2622     }
2624     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2625     if (!$USER->policyagreed and !is_siteadmin()) {
2626         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2627             if ($preventredirect) {
2628                 throw new require_login_exception('Policy not agreed');
2629             }
2630             $SESSION->wantsurl = $FULLME;
2631             redirect($CFG->wwwroot .'/user/policy.php');
2632         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2633             if ($preventredirect) {
2634                 throw new require_login_exception('Policy not agreed');
2635             }
2636             $SESSION->wantsurl = $FULLME;
2637             redirect($CFG->wwwroot .'/user/policy.php');
2638         }
2639     }
2641     // Fetch the system context, the course context, and prefetch its child contexts
2642     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2643     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2644     if ($cm) {
2645         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2646     } else {
2647         $cmcontext = null;
2648     }
2650     // If the site is currently under maintenance, then print a message
2651     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2652         if ($preventredirect) {
2653             throw new require_login_exception('Maintenance in progress');
2654         }
2656         print_maintenance_message();
2657     }
2659     // make sure the course itself is not hidden
2660     if ($course->id == SITEID) {
2661         // frontpage can not be hidden
2662     } else {
2663         if (is_role_switched($course->id)) {
2664             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2665         } else {
2666             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2667                 // originally there was also test of parent category visibility,
2668                 // BUT is was very slow in complex queries involving "my courses"
2669                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2670                 if ($preventredirect) {
2671                     throw new require_login_exception('Course is hidden');
2672                 }
2673                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2674             }
2675         }
2676     }
2678     // is the user enrolled?
2679     if ($course->id == SITEID) {
2680         // everybody is enrolled on the frontpage
2682     } else {
2683         if (session_is_loggedinas()) {
2684             // Make sure the REAL person can access this course first
2685             $realuser = session_get_realuser();
2686             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2687                 if ($preventredirect) {
2688                     throw new require_login_exception('Invalid course login-as access');
2689                 }
2690                 echo $OUTPUT->header();
2691                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2692             }
2693         }
2695         // very simple enrolment caching - changes in course setting are not reflected immediately
2696         if (!isset($USER->enrol)) {
2697             $USER->enrol = array();
2698             $USER->enrol['enrolled'] = array();
2699             $USER->enrol['tempguest'] = array();
2700         }
2702         $access = false;
2704         if (is_viewing($coursecontext, $USER)) {
2705             // ok, no need to mess with enrol
2706             $access = true;
2708         } else {
2709             if (isset($USER->enrol['enrolled'][$course->id])) {
2710                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2711                     $access = true;
2712                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2713                     $access = true;
2714                 } else {
2715                     //expired
2716                     unset($USER->enrol['enrolled'][$course->id]);
2717                 }
2718             }
2719             if (isset($USER->enrol['tempguest'][$course->id])) {
2720                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2721                     $access = true;
2722                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2723                     $access = true;
2724                 } else {
2725                     //expired
2726                     unset($USER->enrol['tempguest'][$course->id]);
2727                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2728                 }
2729             }
2731             if ($access) {
2732                 // cache ok
2733             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2734                 // active participants may always access
2735                 // TODO: refactor this into some new function
2736                 $now = time();
2737                 $sql = "SELECT MAX(ue.timeend)
2738                           FROM {user_enrolments} ue
2739                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2740                           JOIN {user} u ON u.id = ue.userid
2741                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2742                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2743                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2744                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2745                 $until = $DB->get_field_sql($sql, $params);
2746                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2747                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2748                 }
2750                 $USER->enrol['enrolled'][$course->id] = $until;
2751                 $access = true;
2753                 // remove traces of previous temp guest access
2754                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2756             } else {
2757                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2758                 $enrols = enrol_get_plugins(true);
2759                 // first ask all enabled enrol instances in course if they want to auto enrol user
2760                 foreach($instances as $instance) {
2761                     if (!isset($enrols[$instance->enrol])) {
2762                         continue;
2763                     }
2764                     // Get a duration for the guestaccess, a timestamp in the future or false.
2765                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2766                     if ($until !== false) {
2767                         $USER->enrol['enrolled'][$course->id] = $until;
2768                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2769                         $access = true;
2770                         break;
2771                     }
2772                 }
2773                 // if not enrolled yet try to gain temporary guest access
2774                 if (!$access) {
2775                     foreach($instances as $instance) {
2776                         if (!isset($enrols[$instance->enrol])) {
2777                             continue;
2778                         }
2779                         // Get a duration for the guestaccess, a timestamp in the future or false.
2780                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2781                         if ($until !== false) {
2782                             $USER->enrol['tempguest'][$course->id] = $until;
2783                             $access = true;
2784                             break;
2785                         }
2786                     }
2787                 }
2788             }
2789         }
2791         if (!$access) {
2792             if ($preventredirect) {
2793                 throw new require_login_exception('Not enrolled');
2794             }
2795             $SESSION->wantsurl = $FULLME;
2796             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2797         }
2798     }
2800     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
2801     // conditional availability, etc
2802     if ($cm && !$cm->uservisible) {
2803         if ($preventredirect) {
2804             throw new require_login_exception('Activity is hidden');
2805         }
2806         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2807     }
2809     // Finally access granted, update lastaccess times
2810     user_accesstime_log($course->id);
2814 /**
2815  * This function just makes sure a user is logged out.
2816  *
2817  * @global object
2818  */
2819 function require_logout() {
2820     global $USER;
2822     $params = $USER;
2824     if (isloggedin()) {
2825         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2827         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2828         foreach($authsequence as $authname) {
2829             $authplugin = get_auth_plugin($authname);
2830             $authplugin->prelogout_hook();
2831         }
2832     }
2834     events_trigger('user_logout', $params);
2835     session_get_instance()->terminate_current();
2836     unset($params);
2839 /**
2840  * Weaker version of require_login()
2841  *
2842  * This is a weaker version of {@link require_login()} which only requires login
2843  * when called from within a course rather than the site page, unless
2844  * the forcelogin option is turned on.
2845  * @see require_login()
2846  *
2847  * @global object
2848  * @param mixed $courseorid The course object or id in question
2849  * @param bool $autologinguest Allow autologin guests if that is wanted
2850  * @param object $cm Course activity module if known
2851  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2852  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2853  *             in order to keep redirects working properly. MDL-14495
2854  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2855  * @return void
2856  */
2857 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2858     global $CFG, $PAGE, $SITE;
2859     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
2860           or (!is_object($courseorid) and $courseorid == SITEID);
2861     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
2862         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2863         // db queries so this is not really a performance concern, however it is obviously
2864         // better if you use get_fast_modinfo to get the cm before calling this.
2865         if (is_object($courseorid)) {
2866             $course = $courseorid;
2867         } else {
2868             $course = clone($SITE);
2869         }
2870         $modinfo = get_fast_modinfo($course);
2871         $cm = $modinfo->get_cm($cm->id);
2872     }
2873     if (!empty($CFG->forcelogin)) {
2874         // login required for both SITE and courses
2875         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2877     } else if ($issite && !empty($cm) and !$cm->uservisible) {
2878         // always login for hidden activities
2879         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2881     } else if ($issite) {
2882               //login for SITE not required
2883         if ($cm and empty($cm->visible)) {
2884             // hidden activities are not accessible without login
2885             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2886         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2887             // not-logged-in users do not have any group membership
2888             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2889         } else {
2890             // We still need to instatiate PAGE vars properly so that things
2891             // that rely on it like navigation function correctly.
2892             if (!empty($courseorid)) {
2893                 if (is_object($courseorid)) {
2894                     $course = $courseorid;
2895                 } else {
2896                     $course = clone($SITE);
2897                 }
2898                 if ($cm) {
2899                     if ($cm->course != $course->id) {
2900                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2901                     }
2902                     $PAGE->set_cm($cm, $course);
2903                     $PAGE->set_pagelayout('incourse');
2904                 } else {
2905                     $PAGE->set_course($course);
2906                 }
2907             } else {
2908                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2909                 // up properly, set them up now.
2910                 $PAGE->set_course($PAGE->course);
2911             }
2912             //TODO: verify conditional activities here
2913             user_accesstime_log(SITEID);
2914             return;
2915         }
2917     } else {
2918         // course login always required
2919         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2920     }
2923 /**
2924  * Require key login. Function terminates with error if key not found or incorrect.
2925  *
2926  * @global object
2927  * @global object
2928  * @global object
2929  * @global object
2930  * @uses NO_MOODLE_COOKIES
2931  * @uses PARAM_ALPHANUM
2932  * @param string $script unique script identifier
2933  * @param int $instance optional instance id
2934  * @return int Instance ID
2935  */
2936 function require_user_key_login($script, $instance=null) {
2937     global $USER, $SESSION, $CFG, $DB;
2939     if (!NO_MOODLE_COOKIES) {
2940         print_error('sessioncookiesdisable');
2941     }
2943 /// extra safety
2944     @session_write_close();
2946     $keyvalue = required_param('key', PARAM_ALPHANUM);
2948     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2949         print_error('invalidkey');
2950     }
2952     if (!empty($key->validuntil) and $key->validuntil < time()) {
2953         print_error('expiredkey');
2954     }
2956     if ($key->iprestriction) {
2957         $remoteaddr = getremoteaddr(null);
2958         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2959             print_error('ipmismatch');
2960         }
2961     }
2963     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2964         print_error('invaliduserid');
2965     }
2967 /// emulate normal session
2968     session_set_user($user);
2970 /// note we are not using normal login
2971     if (!defined('USER_KEY_LOGIN')) {
2972         define('USER_KEY_LOGIN', true);
2973     }
2975 /// return instance id - it might be empty
2976     return $key->instance;
2979 /**
2980  * Creates a new private user access key.
2981  *
2982  * @global object
2983  * @param string $script unique target identifier
2984  * @param int $userid
2985  * @param int $instance optional instance id
2986  * @param string $iprestriction optional ip restricted access
2987  * @param timestamp $validuntil key valid only until given data
2988  * @return string access key value
2989  */
2990 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2991     global $DB;
2993     $key = new stdClass();
2994     $key->script        = $script;
2995     $key->userid        = $userid;
2996     $key->instance      = $instance;
2997     $key->iprestriction = $iprestriction;
2998     $key->validuntil    = $validuntil;
2999     $key->timecreated   = time();
3001     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3002     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3003         // must be unique
3004         $key->value     = md5($userid.'_'.time().random_string(40));
3005     }
3006     $DB->insert_record('user_private_key', $key);
3007     return $key->value;
3010 /**
3011  * Delete the user's new private user access keys for a particular script.
3012  *
3013  * @global object
3014  * @param string $script unique target identifier
3015  * @param int $userid
3016  * @return void
3017  */
3018 function delete_user_key($script,$userid) {
3019     global $DB;
3020     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3023 /**
3024  * Gets a private user access key (and creates one if one doesn't exist).
3025  *
3026  * @global object
3027  * @param string $script unique target identifier
3028  * @param int $userid
3029  * @param int $instance optional instance id
3030  * @param string $iprestriction optional ip restricted access
3031  * @param timestamp $validuntil key valid only until given data
3032  * @return string access key value
3033  */
3034 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3035     global $DB;
3037     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3038                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3039                                                          'validuntil'=>$validuntil))) {
3040         return $key->value;
3041     } else {
3042         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3043     }
3047 /**
3048  * Modify the user table by setting the currently logged in user's
3049  * last login to now.
3050  *
3051  * @global object
3052  * @global object
3053  * @return bool Always returns true
3054  */
3055 function update_user_login_times() {
3056     global $USER, $DB;
3058     $user = new stdClass();
3059     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3060     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
3062     $user->id = $USER->id;
3064     $DB->update_record('user', $user);
3065     return true;
3068 /**
3069  * Determines if a user has completed setting up their account.
3070  *
3071  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3072  * @return bool
3073  */
3074 function user_not_fully_set_up($user) {
3075     if (isguestuser($user)) {
3076         return false;
3077     }
3078     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3081 /**
3082  * Check whether the user has exceeded the bounce threshold
3083  *
3084  * @global object
3085  * @global object
3086  * @param user $user A {@link $USER} object
3087  * @return bool true=>User has exceeded bounce threshold
3088  */
3089 function over_bounce_threshold($user) {
3090     global $CFG, $DB;
3092     if (empty($CFG->handlebounces)) {
3093         return false;
3094     }
3096     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3097         return false;
3098     }
3100     // set sensible defaults
3101     if (empty($CFG->minbounces)) {
3102         $CFG->minbounces = 10;
3103     }
3104     if (empty($CFG->bounceratio)) {
3105         $CFG->bounceratio = .20;
3106     }
3107     $bouncecount = 0;
3108     $sendcount = 0;
3109     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3110         $bouncecount = $bounce->value;
3111     }
3112     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3113         $sendcount = $send->value;
3114     }
3115     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3118 /**
3119  * Used to increment or reset email sent count
3120  *
3121  * @global object
3122  * @param user $user object containing an id
3123  * @param bool $reset will reset the count to 0
3124  * @return void
3125  */
3126 function set_send_count($user,$reset=false) {
3127     global $DB;
3129     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3130         return;
3131     }
3133     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3134         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3135         $DB->update_record('user_preferences', $pref);
3136     }
3137     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3138         // make a new one
3139         $pref = new stdClass();
3140         $pref->name   = 'email_send_count';
3141         $pref->value  = 1;
3142         $pref->userid = $user->id;
3143         $DB->insert_record('user_preferences', $pref, false);
3144     }
3147 /**
3148  * Increment or reset user's email bounce count
3149  *
3150  * @global object
3151  * @param user $user object containing an id
3152  * @param bool $reset will reset the count to 0
3153  */
3154 function set_bounce_count($user,$reset=false) {
3155     global $DB;
3157     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3158         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3159         $DB->update_record('user_preferences', $pref);
3160     }
3161     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3162         // make a new one
3163         $pref = new stdClass();
3164         $pref->name   = 'email_bounce_count';
3165         $pref->value  = 1;
3166         $pref->userid = $user->id;
3167         $DB->insert_record('user_preferences', $pref, false);
3168     }
3171 /**
3172  * Keeps track of login attempts
3173  *
3174  * @global object
3175  */
3176 function update_login_count() {
3177     global $SESSION;
3179     $max_logins = 10;
3181     if (empty($SESSION->logincount)) {
3182         $SESSION->logincount = 1;
3183     } else {
3184         $SESSION->logincount++;
3185     }
3187     if ($SESSION->logincount > $max_logins) {
3188         unset($SESSION->wantsurl);
3189         print_error('errortoomanylogins');
3190     }
3193 /**
3194  * Resets login attempts
3195  *
3196  * @global object
3197  */
3198 function reset_login_count() {
3199     global $SESSION;
3201     $SESSION->logincount = 0;
3204 /**
3205  * Determines if the currently logged in user is in editing mode.
3206  * Note: originally this function had $userid parameter - it was not usable anyway
3207  *
3208  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3209  * @todo Deprecated function remove when ready
3210  *
3211  * @global object
3212  * @uses DEBUG_DEVELOPER
3213  * @return bool
3214  */
3215 function isediting() {
3216     global $PAGE;
3217     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3218     return $PAGE->user_is_editing();
3221 /**
3222  * Determines if the logged in user is currently moving an activity
3223  *
3224  * @global object
3225  * @param int $courseid The id of the course being tested
3226  * @return bool
3227  */
3228 function ismoving($courseid) {
3229     global $USER;
3231     if (!empty($USER->activitycopy)) {
3232         return ($USER->activitycopycourse == $courseid);
3233     }
3234     return false;
3237 /**
3238  * Returns a persons full name
3239  *
3240  * Given an object containing firstname and lastname
3241  * values, this function returns a string with the
3242  * full name of the person.
3243  * The result may depend on system settings
3244  * or language.  'override' will force both names
3245  * to be used even if system settings specify one.
3246  *
3247  * @global object
3248  * @global object
3249  * @param object $user A {@link $USER} object to get full name of
3250  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3251  * @return string
3252  */
3253 function fullname($user, $override=false) {
3254     global $CFG, $SESSION;
3256     if (!isset($user->firstname) and !isset($user->lastname)) {
3257         return '';
3258     }
3260     if (!$override) {
3261         if (!empty($CFG->forcefirstname)) {
3262             $user->firstname = $CFG->forcefirstname;
3263         }
3264         if (!empty($CFG->forcelastname)) {
3265             $user->lastname = $CFG->forcelastname;
3266         }
3267     }
3269     if (!empty($SESSION->fullnamedisplay)) {
3270         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3271     }
3273     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3274         return $user->firstname .' '. $user->lastname;
3276     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3277         return $user->lastname .' '. $user->firstname;
3279     } else if ($CFG->fullnamedisplay == 'firstname') {
3280         if ($override) {
3281             return get_string('fullnamedisplay', '', $user);
3282         } else {
3283             return $user->firstname;
3284         }
3285     }
3287     return get_string('fullnamedisplay', '', $user);
3290 /**
3291  * Returns whether a given authentication plugin exists.
3292  *
3293  * @global object
3294  * @param string $auth Form of authentication to check for. Defaults to the
3295  *        global setting in {@link $CFG}.
3296  * @return boolean Whether the plugin is available.
3297  */
3298 function exists_auth_plugin($auth) {
3299     global $CFG;
3301     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3302         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3303     }
3304     return false;
3307 /**
3308  * Checks if a given plugin is in the list of enabled authentication plugins.
3309  *
3310  * @param string $auth Authentication plugin.
3311  * @return boolean Whether the plugin is enabled.
3312  */
3313 function is_enabled_auth($auth) {
3314     if (empty($auth)) {
3315         return false;
3316     }
3318     $enabled = get_enabled_auth_plugins();
3320     return in_array($auth, $enabled);
3323 /**
3324  * Returns an authentication plugin instance.
3325  *
3326  * @global object
3327  * @param string $auth name of authentication plugin
3328  * @return auth_plugin_base An instance of the required authentication plugin.
3329  */
3330 function get_auth_plugin($auth) {
3331     global $CFG;
3333     // check the plugin exists first
3334     if (! exists_auth_plugin($auth)) {
3335         print_error('authpluginnotfound', 'debug', '', $auth);
3336     }
3338     // return auth plugin instance
3339     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3340     $class = "auth_plugin_$auth";
3341     return new $class;
3344 /**
3345  * Returns array of active auth plugins.
3346  *
3347  * @param bool $fix fix $CFG->auth if needed
3348  * @return array
3349  */
3350 function get_enabled_auth_plugins($fix=false) {
3351     global $CFG;
3353     $default = array('manual', 'nologin');
3355     if (empty($CFG->auth)) {
3356         $auths = array();
3357     } else {
3358         $auths = explode(',', $CFG->auth);
3359     }
3361     if ($fix) {
3362         $auths = array_unique($auths);
3363         foreach($auths as $k=>$authname) {
3364             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3365                 unset($auths[$k]);
3366             }
3367         }
3368         $newconfig = implode(',', $auths);
3369         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3370             set_config('auth', $newconfig);
3371         }
3372     }
3374     return (array_merge($default, $auths));
3377 /**
3378  * Returns true if an internal authentication method is being used.
3379  * if method not specified then, global default is assumed
3380  *
3381  * @param string $auth Form of authentication required
3382  * @return bool
3383  */
3384 function is_internal_auth($auth) {
3385     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3386     return $authplugin->is_internal();
3389 /**
3390  * Returns true if the user is a 'restored' one
3391  *
3392  * Used in the login process to inform the user
3393  * and allow him/her to reset the password
3394  *
3395  * @uses $CFG
3396  * @uses $DB
3397  * @param string $username username to be checked
3398  * @return bool
3399  */
3400 function is_restored_user($username) {
3401     global $CFG, $DB;
3403     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3406 /**
3407  * Returns an array of user fields
3408  *
3409  * @return array User field/column names
3410  */
3411 function get_user_fieldnames() {
3412     global $DB;
3414     $fieldarray = $DB->get_columns('user');
3415     unset($fieldarray['id']);
3416     $fieldarray = array_keys($fieldarray);
3418     return $fieldarray;
3421 /**
3422  * Creates a bare-bones user record
3423  *
3424  * @todo Outline auth types and provide code example
3425  *
3426  * @param string $username New user's username to add to record
3427  * @param string $password New user's password to add to record
3428  * @param string $auth Form of authentication required
3429  * @return stdClass A complete user object
3430  */
3431 function create_user_record($username, $password, $auth = 'manual') {
3432     global $CFG, $DB;
3434     //just in case check text case
3435     $username = trim(moodle_strtolower($username));
3437     $authplugin = get_auth_plugin($auth);
3439     $newuser = new stdClass();
3441     if ($newinfo = $authplugin->get_userinfo($username)) {
3442         $newinfo = truncate_userinfo($newinfo);
3443         foreach ($newinfo as $key => $value){
3444             $newuser->$key = $value;
3445         }
3446     }
3448     if (!empty($newuser->email)) {
3449         if (email_is_not_allowed($newuser->email)) {
3450             unset($newuser->email);
3451         }
3452     }
3454     if (!isset($newuser->city)) {
3455         $newuser->city = '';
3456     }
3458     $newuser->auth = $auth;
3459     $newuser->username = $username;
3461     // fix for MDL-8480
3462     // user CFG lang for user if $newuser->lang is empty
3463     // or $user->lang is not an installed language
3464     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3465         $newuser->lang = $CFG->lang;
3466     }
3467     $newuser->confirmed = 1;
3468     $newuser->lastip = getremoteaddr();
3469     $newuser->timemodified = time();
3470     $newuser->mnethostid = $CFG->mnet_localhost_id;
3472     $newuser->id = $DB->insert_record('user', $newuser);
3473     $user = get_complete_user_data('id', $newuser->id);
3474     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3475         set_user_preference('auth_forcepasswordchange', 1, $user);
3476     }
3477     update_internal_user_password($user, $password);
3479     // fetch full user record for the event, the complete user data contains too much info
3480     // and we want to be consistent with other places that trigger this event
3481     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3483     return $user;
3486 /**
3487  * Will update a local user record from an external source.
3488  * (MNET users can not be updated using this method!)
3489  *
3490  * @param string $username user's username to update the record
3491  * @return stdClass A complete user object
3492  */
3493 function update_user_record($username) {
3494     global $DB, $CFG;
3496     $username = trim(moodle_strtolower($username)); /// just in case check text case
3498     $oldinfo = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
3499     $newuser = array();
3500     $userauth = get_auth_plugin($oldinfo->auth);
3502     if ($newinfo = $userauth->get_userinfo($username)) {
3503         $newinfo = truncate_userinfo($newinfo);
3504         foreach ($newinfo as $key => $value){
3505             $key = strtolower($key);
3506             if (!property_exists($oldinfo, $key) or $key === 'username' or $key === 'id'
3507                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3508                 // unknown or must not be changed
3509                 continue;
3510             }
3511             $confval = $userauth->config->{'field_updatelocal_' . $key};
3512             $lockval = $userauth->config->{'field_lock_' . $key};
3513             if (empty($confval) || empty($lockval)) {
3514                 continue;
3515             }
3516             if ($confval === 'onlogin') {
3517                 // MDL-4207 Don't overwrite modified user profile values with
3518                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3519                 // of the setting 'unlocked if empty' is to allow the user to fill
3520                 // in a value for the selected field _if LDAP is giving
3521                 // nothing_ for this field. Thus it makes sense to let this value
3522                 // stand in until LDAP is giving a value for this field.
3523                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3524                     if ((string)$oldinfo->$key !== (string)$value) {
3525                         $newuser[$key] = (string)$value;
3526                     }
3527                 }
3528             }
3529         }
3530         if ($newuser) {
3531             $newuser['id'] = $oldinfo->id;
3532             $DB->update_record('user', $newuser);
3533             // fetch full user record for the event, the complete user data contains too much info
3534             // and we want to be consistent with other places that trigger this event
3535             events_trigger('user_updated', $DB->get_record('user', array('id'=>$oldinfo->id)));
3536         }
3537     }
3539     return get_complete_user_data('id', $oldinfo->id);
3542 /**
3543  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3544  * which may have large fields
3545  *
3546  * @todo Add vartype handling to ensure $info is an array
3547  *
3548  * @param array $info Array of user properties to truncate if needed
3549  * @return array The now truncated information that was passed in
3550  */
3551 function truncate_userinfo($info) {
3552     // define the limits
3553     $limit = array(
3554                     'username'    => 100,
3555                     'idnumber'    => 255,
3556                     'firstname'   => 100,
3557                     'lastname'    => 100,
3558                     'email'       => 100,
3559                     'icq'         =>  15,
3560                     'phone1'      =>  20,
3561                     'phone2'      =>  20,
3562                     'institution' =>  40,
3563                     'department'  =>  30,
3564                     'address'     =>  70,
3565                     'city'        => 120,
3566                     'country'     =>   2,
3567                     'url'         => 255,
3568                     );
3570     $textlib = textlib_get_instance();
3571     // apply where needed
3572     foreach (array_keys($info) as $key) {
3573         if (!empty($limit[$key])) {
3574             $info[$key] = trim($textlib->substr($info[$key],0, $limit[$key]));
3575         }
3576     }
3578     return $info;
3581 /**
3582  * Marks user deleted in internal user database and notifies the auth plugin.
3583  * Also unenrols user from all roles and does other cleanup.
3584  *
3585  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3586  *
3587  * @param stdClass $user full user object before delete
3588  * @return boolean always true
3589  */
3590 function delete_user($user) {
3591     global $CFG, $DB;
3592     require_once($CFG->libdir.'/grouplib.php');
3593     require_once($CFG->libdir.'/gradelib.php');
3594     require_once($CFG->dirroot.'/message/lib.php');
3595     require_once($CFG->dirroot.'/tag/lib.php');
3597     // delete all grades - backup is kept in grade_grades_history table
3598     grade_user_delete($user->id);
3600     //move unread messages from this user to read
3601     message_move_userfrom_unread2read($user->id);
3603     // TODO: remove from cohorts using standard API here
3605     // remove user tags
3606     tag_set('user', $user->id, array());
3608     // unconditionally unenrol from all courses
3609     enrol_user_delete($user);
3611     // unenrol from all roles in all contexts
3612     role_unassign_all(array('userid'=>$user->id)); // this might be slow but it is really needed - modules might do some extra cleanup!
3614     //now do a brute force cleanup
3616     // remove from all cohorts
3617     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3619     // remove from all groups
3620     $DB->delete_records('groups_members', array('userid'=>$user->id));
3622     // brute force unenrol from all courses
3623     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3625     // purge user preferences
3626     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3628     // purge user extra profile info
3629     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3631     // last course access not necessary either
3632     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3634     // force logout - may fail if file based sessions used, sorry
3635     session_kill_user($user->id);
3637     // now do a final accesslib cleanup - removes all role assignments in user context and context itself
3638     delete_context(CONTEXT_USER, $user->id);
3640     // workaround for bulk deletes of users with the same email address
3641     $delname = "$user->email.".time();
3642     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3643         $delname++;
3644     }
3646     // mark internal user record as "deleted"
3647     $updateuser = new stdClass();
3648     $updateuser->id           = $user->id;
3649     $updateuser->deleted      = 1;
3650     $updateuser->username     = $delname;            // Remember it just in case
3651     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3652     $updateuser->idnumber     = '';                  // Clear this field to free it up
3653     $updateuser->timemodified = time();
3655     $DB->update_record('user', $updateuser);
3657     // notify auth plugin - do not block the delete even when plugin fails
3658     $authplugin = get_auth_plugin($user->auth);
3659     $authplugin->user_delete($user);
3661     // any plugin that needs to cleanup should register this event
3662     events_trigger('user_deleted', $user);
3664     return true;
3667 /**
3668  * Retrieve the guest user object
3669  *
3670  * @global object
3671  * @global object
3672  * @return user A {@link $USER} object
3673  */
3674 function guest_user() {
3675     global $CFG, $DB;
3677     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
3678         $newuser->confirmed = 1;
3679         $newuser->lang = $CFG->lang;
3680         $newuser->lastip = getremoteaddr();
3681     }
3683     return $newuser;
3686 /**
3687  * Authenticates a user against the chosen authentication mechanism
3688  *
3689  * Given a username and password, this function looks them
3690  * up using the currently selected authentication mechanism,
3691  * and if the authentication is successful, it returns a