Merge branch 'MDL-27823_bulk_messaging_2' of git://github.com/andyjdavis/moodle
[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_array($param)) {
689         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
690     } else if (is_object($param)) {
691         if (method_exists($param, '__toString')) {
692             $param = $param->__toString();
693         } else {
694             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
695         }
696     }
698     switch ($type) {
699         case PARAM_RAW:          // no cleaning at all
700             $param = fix_utf8($param);
701             return $param;
703         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
704             $param = fix_utf8($param);
705             return trim($param);
707         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
708             // this is deprecated!, please use more specific type instead
709             if (is_numeric($param)) {
710                 return $param;
711             }
712             $param = fix_utf8($param);
713             return clean_text($param);     // Sweep for scripts, etc
715         case PARAM_CLEANHTML:    // clean html fragment
716             $param = fix_utf8($param);
717             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
718             return trim($param);
720         case PARAM_INT:
721             return (int)$param;  // Convert to integer
723         case PARAM_FLOAT:
724         case PARAM_NUMBER:
725             return (float)$param;  // Convert to float
727         case PARAM_ALPHA:        // Remove everything not a-z
728             return preg_replace('/[^a-zA-Z]/i', '', $param);
730         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
731             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
733         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
734             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
736         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
737             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
739         case PARAM_SEQUENCE:     // Remove everything not 0-9,
740             return preg_replace('/[^0-9,]/i', '', $param);
742         case PARAM_BOOL:         // Convert to 1 or 0
743             $tempstr = strtolower($param);
744             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
745                 $param = 1;
746             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
747                 $param = 0;
748             } else {
749                 $param = empty($param) ? 0 : 1;
750             }
751             return $param;
753         case PARAM_NOTAGS:       // Strip all tags
754             $param = fix_utf8($param);
755             return strip_tags($param);
757         case PARAM_TEXT:    // leave only tags needed for multilang
758             $param = fix_utf8($param);
759             // if the multilang syntax is not correct we strip all tags
760             // because it would break xhtml strict which is required for accessibility standards
761             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
762             do {
763                 if (strpos($param, '</lang>') !== false) {
764                     // old and future mutilang syntax
765                     $param = strip_tags($param, '<lang>');
766                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
767                         break;
768                     }
769                     $open = false;
770                     foreach ($matches[0] as $match) {
771                         if ($match === '</lang>') {
772                             if ($open) {
773                                 $open = false;
774                                 continue;
775                             } else {
776                                 break 2;
777                             }
778                         }
779                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
780                             break 2;
781                         } else {
782                             $open = true;
783                         }
784                     }
785                     if ($open) {
786                         break;
787                     }
788                     return $param;
790                 } else if (strpos($param, '</span>') !== false) {
791                     // current problematic multilang syntax
792                     $param = strip_tags($param, '<span>');
793                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
794                         break;
795                     }
796                     $open = false;
797                     foreach ($matches[0] as $match) {
798                         if ($match === '</span>') {
799                             if ($open) {
800                                 $open = false;
801                                 continue;
802                             } else {
803                                 break 2;
804                             }
805                         }
806                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
807                             break 2;
808                         } else {
809                             $open = true;
810                         }
811                     }
812                     if ($open) {
813                         break;
814                     }
815                     return $param;
816                 }
817             } while (false);
818             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
819             return strip_tags($param);
821         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
822             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
824         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
825             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
827         case PARAM_FILE:         // Strip all suspicious characters from filename
828             $param = fix_utf8($param);
829             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
830             $param = preg_replace('~\.\.+~', '', $param);
831             if ($param === '.') {
832                 $param = '';
833             }
834             return $param;
836         case PARAM_PATH:         // Strip all suspicious characters from file path
837             $param = fix_utf8($param);
838             $param = str_replace('\\', '/', $param);
839             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
840             $param = preg_replace('~\.\.+~', '', $param);
841             $param = preg_replace('~//+~', '/', $param);
842             return preg_replace('~/(\./)+~', '/', $param);
844         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
845             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
846             // match ipv4 dotted quad
847             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
848                 // confirm values are ok
849                 if ( $match[0] > 255
850                      || $match[1] > 255
851                      || $match[3] > 255
852                      || $match[4] > 255 ) {
853                     // hmmm, what kind of dotted quad is this?
854                     $param = '';
855                 }
856             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
857                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
858                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
859                        ) {
860                 // all is ok - $param is respected
861             } else {
862                 // all is not ok...
863                 $param='';
864             }
865             return $param;
867         case PARAM_URL:          // allow safe ftp, http, mailto urls
868             $param = fix_utf8($param);
869             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
870             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
871                 // all is ok, param is respected
872             } else {
873                 $param =''; // not really ok
874             }
875             return $param;
877         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
878             $param = clean_param($param, PARAM_URL);
879             if (!empty($param)) {
880                 if (preg_match(':^/:', $param)) {
881                     // root-relative, ok!
882                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
883                     // absolute, and matches our wwwroot
884                 } else {
885                     // relative - let's make sure there are no tricks
886                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
887                         // looks ok.
888                     } else {
889                         $param = '';
890                     }
891                 }
892             }
893             return $param;
895         case PARAM_PEM:
896             $param = trim($param);
897             // PEM formatted strings may contain letters/numbers and the symbols
898             // forward slash: /
899             // plus sign:     +
900             // equal sign:    =
901             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
902             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
903                 list($wholething, $body) = $matches;
904                 unset($wholething, $matches);
905                 $b64 = clean_param($body, PARAM_BASE64);
906                 if (!empty($b64)) {
907                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
908                 } else {
909                     return '';
910                 }
911             }
912             return '';
914         case PARAM_BASE64:
915             if (!empty($param)) {
916                 // PEM formatted strings may contain letters/numbers and the symbols
917                 // forward slash: /
918                 // plus sign:     +
919                 // equal sign:    =
920                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
921                     return '';
922                 }
923                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
924                 // Each line of base64 encoded data must be 64 characters in
925                 // length, except for the last line which may be less than (or
926                 // equal to) 64 characters long.
927                 for ($i=0, $j=count($lines); $i < $j; $i++) {
928                     if ($i + 1 == $j) {
929                         if (64 < strlen($lines[$i])) {
930                             return '';
931                         }
932                         continue;
933                     }
935                     if (64 != strlen($lines[$i])) {
936                         return '';
937                     }
938                 }
939                 return implode("\n",$lines);
940             } else {
941                 return '';
942             }
944         case PARAM_TAG:
945             $param = fix_utf8($param);
946             // Please note it is not safe to use the tag name directly anywhere,
947             // it must be processed with s(), urlencode() before embedding anywhere.
948             // remove some nasties
949             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
950             //convert many whitespace chars into one
951             $param = preg_replace('/\s+/', ' ', $param);
952             $textlib = textlib_get_instance();
953             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
954             return $param;
956         case PARAM_TAGLIST:
957             $param = fix_utf8($param);
958             $tags = explode(',', $param);
959             $result = array();
960             foreach ($tags as $tag) {
961                 $res = clean_param($tag, PARAM_TAG);
962                 if ($res !== '') {
963                     $result[] = $res;
964                 }
965             }
966             if ($result) {
967                 return implode(',', $result);
968             } else {
969                 return '';
970             }
972         case PARAM_CAPABILITY:
973             if (get_capability_info($param)) {
974                 return $param;
975             } else {
976                 return '';
977             }
979         case PARAM_PERMISSION:
980             $param = (int)$param;
981             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
982                 return $param;
983             } else {
984                 return CAP_INHERIT;
985             }
987         case PARAM_AUTH:
988             $param = clean_param($param, PARAM_SAFEDIR);
989             if (exists_auth_plugin($param)) {
990                 return $param;
991             } else {
992                 return '';
993             }
995         case PARAM_LANG:
996             $param = clean_param($param, PARAM_SAFEDIR);
997             if (get_string_manager()->translation_exists($param)) {
998                 return $param;
999             } else {
1000                 return ''; // Specified language is not installed or param malformed
1001             }
1003         case PARAM_THEME:
1004             $param = clean_param($param, PARAM_SAFEDIR);
1005             if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1006                 return $param;
1007             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1008                 return $param;
1009             } else {
1010                 return '';  // Specified theme is not installed
1011             }
1013         case PARAM_USERNAME:
1014             $param = fix_utf8($param);
1015             $param = str_replace(" " , "", $param);
1016             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
1017             if (empty($CFG->extendedusernamechars)) {
1018                 // regular expression, eliminate all chars EXCEPT:
1019                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1020                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1021             }
1022             return $param;
1024         case PARAM_EMAIL:
1025             $param = fix_utf8($param);
1026             if (validate_email($param)) {
1027                 return $param;
1028             } else {
1029                 return '';
1030             }
1032         case PARAM_STRINGID:
1033             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1034                 return $param;
1035             } else {
1036                 return '';
1037             }
1039         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1040             $param = fix_utf8($param);
1041             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3]|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1042             if (preg_match($timezonepattern, $param)) {
1043                 return $param;
1044             } else {
1045                 return '';
1046             }
1048         default:                 // throw error, switched parameters in optional_param or another serious problem
1049             print_error("unknownparamtype", '', '', $type);
1050     }
1053 /**
1054  * Makes sure the data is using valid utf8, invalid characters are discarded.
1055  *
1056  * Note: this function is not intended for full objects with methods and private properties.
1057  *
1058  * @param mixed $value
1059  * @return mixed with proper utf-8 encoding
1060  */
1061 function fix_utf8($value) {
1062     if (is_null($value) or $value === '') {
1063         return $value;
1065     } else if (is_string($value)) {
1066         if ((string)(int)$value === $value) {
1067             // shortcut
1068             return $value;
1069         }
1070         return iconv('UTF-8', 'UTF-8//IGNORE', $value);
1072     } else if (is_array($value)) {
1073         foreach ($value as $k=>$v) {
1074             $value[$k] = fix_utf8($v);
1075         }
1076         return $value;
1078     } else if (is_object($value)) {
1079         $value = clone($value); // do not modify original
1080         foreach ($value as $k=>$v) {
1081             $value->$k = fix_utf8($v);
1082         }
1083         return $value;
1085     } else {
1086         // this is some other type, no utf-8 here
1087         return $value;
1088     }
1091 /**
1092  * Return true if given value is integer or string with integer value
1093  *
1094  * @param mixed $value String or Int
1095  * @return bool true if number, false if not
1096  */
1097 function is_number($value) {
1098     if (is_int($value)) {
1099         return true;
1100     } else if (is_string($value)) {
1101         return ((string)(int)$value) === $value;
1102     } else {
1103         return false;
1104     }
1107 /**
1108  * Returns host part from url
1109  * @param string $url full url
1110  * @return string host, null if not found
1111  */
1112 function get_host_from_url($url) {
1113     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1114     if ($matches) {
1115         return $matches[1];
1116     }
1117     return null;
1120 /**
1121  * Tests whether anything was returned by text editor
1122  *
1123  * This function is useful for testing whether something you got back from
1124  * the HTML editor actually contains anything. Sometimes the HTML editor
1125  * appear to be empty, but actually you get back a <br> tag or something.
1126  *
1127  * @param string $string a string containing HTML.
1128  * @return boolean does the string contain any actual content - that is text,
1129  * images, objects, etc.
1130  */
1131 function html_is_blank($string) {
1132     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1135 /**
1136  * Set a key in global configuration
1137  *
1138  * Set a key/value pair in both this session's {@link $CFG} global variable
1139  * and in the 'config' database table for future sessions.
1140  *
1141  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1142  * In that case it doesn't affect $CFG.
1143  *
1144  * A NULL value will delete the entry.
1145  *
1146  * @global object
1147  * @global object
1148  * @param string $name the key to set
1149  * @param string $value the value to set (without magic quotes)
1150  * @param string $plugin (optional) the plugin scope, default NULL
1151  * @return bool true or exception
1152  */
1153 function set_config($name, $value, $plugin=NULL) {
1154     global $CFG, $DB;
1156     if (empty($plugin)) {
1157         if (!array_key_exists($name, $CFG->config_php_settings)) {
1158             // So it's defined for this invocation at least
1159             if (is_null($value)) {
1160                 unset($CFG->$name);
1161             } else {
1162                 $CFG->$name = (string)$value; // settings from db are always strings
1163             }
1164         }
1166         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1167             if ($value === null) {
1168                 $DB->delete_records('config', array('name'=>$name));
1169             } else {
1170                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1171             }
1172         } else {
1173             if ($value !== null) {
1174                 $config = new stdClass();
1175                 $config->name  = $name;
1176                 $config->value = $value;
1177                 $DB->insert_record('config', $config, false);
1178             }
1179         }
1181     } else { // plugin scope
1182         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1183             if ($value===null) {
1184                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1185             } else {
1186                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1187             }
1188         } else {
1189             if ($value !== null) {
1190                 $config = new stdClass();
1191                 $config->plugin = $plugin;
1192                 $config->name   = $name;
1193                 $config->value  = $value;
1194                 $DB->insert_record('config_plugins', $config, false);
1195             }
1196         }
1197     }
1199     return true;
1202 /**
1203  * Get configuration values from the global config table
1204  * or the config_plugins table.
1205  *
1206  * If called with one parameter, it will load all the config
1207  * variables for one plugin, and return them as an object.
1208  *
1209  * If called with 2 parameters it will return a string single
1210  * value or false if the value is not found.
1211  *
1212  * @param string $plugin full component name
1213  * @param string $name default NULL
1214  * @return mixed hash-like object or single value, return false no config found
1215  */
1216 function get_config($plugin, $name = NULL) {
1217     global $CFG, $DB;
1219     // normalise component name
1220     if ($plugin === 'moodle' or $plugin === 'core') {
1221         $plugin = NULL;
1222     }
1224     if (!empty($name)) { // the user is asking for a specific value
1225         if (!empty($plugin)) {
1226             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1227                 // setting forced in config file
1228                 return $CFG->forced_plugin_settings[$plugin][$name];
1229             } else {
1230                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1231             }
1232         } else {
1233             if (array_key_exists($name, $CFG->config_php_settings)) {
1234                 // setting force in config file
1235                 return $CFG->config_php_settings[$name];
1236             } else {
1237                 return $DB->get_field('config', 'value', array('name'=>$name));
1238             }
1239         }
1240     }
1242     // the user is after a recordset
1243     if ($plugin) {
1244         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1245         if (isset($CFG->forced_plugin_settings[$plugin])) {
1246             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1247                 if (is_null($v) or is_array($v) or is_object($v)) {
1248                     // we do not want any extra mess here, just real settings that could be saved in db
1249                     unset($localcfg[$n]);
1250                 } else {
1251                     //convert to string as if it went through the DB
1252                     $localcfg[$n] = (string)$v;
1253                 }
1254             }
1255         }
1256         if ($localcfg) {
1257             return (object)$localcfg;
1258         } else {
1259             return null;
1260         }
1262     } else {
1263         // this part is not really used any more, but anyway...
1264         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1265         foreach($CFG->config_php_settings as $n=>$v) {
1266             if (is_null($v) or is_array($v) or is_object($v)) {
1267                 // we do not want any extra mess here, just real settings that could be saved in db
1268                 unset($localcfg[$n]);
1269             } else {
1270                 //convert to string as if it went through the DB
1271                 $localcfg[$n] = (string)$v;
1272             }
1273         }
1274         return (object)$localcfg;
1275     }
1278 /**
1279  * Removes a key from global configuration
1280  *
1281  * @param string $name the key to set
1282  * @param string $plugin (optional) the plugin scope
1283  * @global object
1284  * @return boolean whether the operation succeeded.
1285  */
1286 function unset_config($name, $plugin=NULL) {
1287     global $CFG, $DB;
1289     if (empty($plugin)) {
1290         unset($CFG->$name);
1291         $DB->delete_records('config', array('name'=>$name));
1292     } else {
1293         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1294     }
1296     return true;
1299 /**
1300  * Remove all the config variables for a given plugin.
1301  *
1302  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1303  * @return boolean whether the operation succeeded.
1304  */
1305 function unset_all_config_for_plugin($plugin) {
1306     global $DB;
1307     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1308     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
1309     return true;
1312 /**
1313  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1314  *
1315  * All users are verified if they still have the necessary capability.
1316  *
1317  * @param string $value the value of the config setting.
1318  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1319  * @param bool $include admins, include administrators
1320  * @return array of user objects.
1321  */
1322 function get_users_from_config($value, $capability, $includeadmins = true) {
1323     global $CFG, $DB;
1325     if (empty($value) or $value === '$@NONE@$') {
1326         return array();
1327     }
1329     // we have to make sure that users still have the necessary capability,
1330     // it should be faster to fetch them all first and then test if they are present
1331     // instead of validating them one-by-one
1332     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1333     if ($includeadmins) {
1334         $admins = get_admins();
1335         foreach ($admins as $admin) {
1336             $users[$admin->id] = $admin;
1337         }
1338     }
1340     if ($value === '$@ALL@$') {
1341         return $users;
1342     }
1344     $result = array(); // result in correct order
1345     $allowed = explode(',', $value);
1346     foreach ($allowed as $uid) {
1347         if (isset($users[$uid])) {
1348             $user = $users[$uid];
1349             $result[$user->id] = $user;
1350         }
1351     }
1353     return $result;
1357 /**
1358  * Invalidates browser caches and cached data in temp
1359  * @return void
1360  */
1361 function purge_all_caches() {
1362     global $CFG;
1364     reset_text_filters_cache();
1365     js_reset_all_caches();
1366     theme_reset_all_caches();
1367     get_string_manager()->reset_caches();
1369     // purge all other caches: rss, simplepie, etc.
1370     remove_dir($CFG->dataroot.'/cache', true);
1372     // make sure cache dir is writable, throws exception if not
1373     make_upload_directory('cache');
1375     // hack: this script may get called after the purifier was initialised,
1376     // but we do not want to verify repeatedly this exists in each call
1377     make_upload_directory('cache/htmlpurifier');
1379     clearstatcache();
1382 /**
1383  * Get volatile flags
1384  *
1385  * @param string $type
1386  * @param int    $changedsince default null
1387  * @return records array
1388  */
1389 function get_cache_flags($type, $changedsince=NULL) {
1390     global $DB;
1392     $params = array('type'=>$type, 'expiry'=>time());
1393     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1394     if ($changedsince !== NULL) {
1395         $params['changedsince'] = $changedsince;
1396         $sqlwhere .= " AND timemodified > :changedsince";
1397     }
1398     $cf = array();
1400     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1401         foreach ($flags as $flag) {
1402             $cf[$flag->name] = $flag->value;
1403         }
1404     }
1405     return $cf;
1408 /**
1409  * Get volatile flags
1410  *
1411  * @param string $type
1412  * @param string $name
1413  * @param int    $changedsince default null
1414  * @return records array
1415  */
1416 function get_cache_flag($type, $name, $changedsince=NULL) {
1417     global $DB;
1419     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1421     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1422     if ($changedsince !== NULL) {
1423         $params['changedsince'] = $changedsince;
1424         $sqlwhere .= " AND timemodified > :changedsince";
1425     }
1427     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1430 /**
1431  * Set a volatile flag
1432  *
1433  * @param string $type the "type" namespace for the key
1434  * @param string $name the key to set
1435  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1436  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1437  * @return bool Always returns true
1438  */
1439 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1440     global $DB;
1442     $timemodified = time();
1443     if ($expiry===NULL || $expiry < $timemodified) {
1444         $expiry = $timemodified + 24 * 60 * 60;
1445     } else {
1446         $expiry = (int)$expiry;
1447     }
1449     if ($value === NULL) {
1450         unset_cache_flag($type,$name);
1451         return true;
1452     }
1454     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1455         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1456             return true; //no need to update; helps rcache too
1457         }
1458         $f->value        = $value;
1459         $f->expiry       = $expiry;
1460         $f->timemodified = $timemodified;
1461         $DB->update_record('cache_flags', $f);
1462     } else {
1463         $f = new stdClass();
1464         $f->flagtype     = $type;
1465         $f->name         = $name;
1466         $f->value        = $value;
1467         $f->expiry       = $expiry;
1468         $f->timemodified = $timemodified;
1469         $DB->insert_record('cache_flags', $f);
1470     }
1471     return true;
1474 /**
1475  * Removes a single volatile flag
1476  *
1477  * @global object
1478  * @param string $type the "type" namespace for the key
1479  * @param string $name the key to set
1480  * @return bool
1481  */
1482 function unset_cache_flag($type, $name) {
1483     global $DB;
1484     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1485     return true;
1488 /**
1489  * Garbage-collect volatile flags
1490  *
1491  * @return bool Always returns true
1492  */
1493 function gc_cache_flags() {
1494     global $DB;
1495     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1496     return true;
1499 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1501 /**
1502  * Refresh user preference cache. This is used most often for $USER
1503  * object that is stored in session, but it also helps with performance in cron script.
1504  *
1505  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1506  *
1507  * @param stdClass $user user object, preferences are preloaded into ->preference property
1508  * @param int $cachelifetime cache life time on the current page (ins seconds)
1509  * @return void
1510  */
1511 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1512     global $DB;
1513     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1515     if (!isset($user->id)) {
1516         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1517     }
1519     if (empty($user->id) or isguestuser($user->id)) {
1520         // No permanent storage for not-logged-in users and guest
1521         if (!isset($user->preference)) {
1522             $user->preference = array();
1523         }
1524         return;
1525     }
1527     $timenow = time();
1529     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1530         // Already loaded at least once on this page. Are we up to date?
1531         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1532             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1533             return;
1535         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1536             // no change since the lastcheck on this page
1537             $user->preference['_lastloaded'] = $timenow;
1538             return;
1539         }
1540     }
1542     // OK, so we have to reload all preferences
1543     $loadedusers[$user->id] = true;
1544     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1545     $user->preference['_lastloaded'] = $timenow;
1548 /**
1549  * Called from set/delete_user_preferences, so that the prefs can
1550  * be correctly reloaded in different sessions.
1551  *
1552  * NOTE: internal function, do not call from other code.
1553  *
1554  * @param integer $userid the user whose prefs were changed.
1555  * @return void
1556  */
1557 function mark_user_preferences_changed($userid) {
1558     global $CFG;
1560     if (empty($userid) or isguestuser($userid)) {
1561         // no cache flags for guest and not-logged-in users
1562         return;
1563     }
1565     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1568 /**
1569  * Sets a preference for the specified user.
1570  *
1571  * If user object submitted, 'preference' property contains the preferences cache.
1572  *
1573  * @param string $name The key to set as preference for the specified user
1574  * @param string $value The value to set for the $name key in the specified user's record,
1575  *                      null means delete current value
1576  * @param stdClass|int $user A moodle user object or id, null means current user
1577  * @return bool always true or exception
1578  */
1579 function set_user_preference($name, $value, $user = null) {
1580     global $USER, $DB;
1582     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1583         throw new coding_exception('Invalid preference name in set_user_preference() call');
1584     }
1586     if (is_null($value)) {
1587         // null means delete current
1588         return unset_user_preference($name, $user);
1589     } else if (is_object($value)) {
1590         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1591     } else if (is_array($value)) {
1592         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1593     }
1594     $value = (string)$value;
1596     if (is_null($user)) {
1597         $user = $USER;
1598     } else if (isset($user->id)) {
1599         // $user is valid object
1600     } else if (is_numeric($user)) {
1601         $user = (object)array('id'=>(int)$user);
1602     } else {
1603         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1604     }
1606     check_user_preferences_loaded($user);
1608     if (empty($user->id) or isguestuser($user->id)) {
1609         // no permanent storage for not-logged-in users and guest
1610         $user->preference[$name] = $value;
1611         return true;
1612     }
1614     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1615         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1616             // preference already set to this value
1617             return true;
1618         }
1619         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1621     } else {
1622         $preference = new stdClass();
1623         $preference->userid = $user->id;
1624         $preference->name   = $name;
1625         $preference->value  = $value;
1626         $DB->insert_record('user_preferences', $preference);
1627     }
1629     // update value in cache
1630     $user->preference[$name] = $value;
1632     // set reload flag for other sessions
1633     mark_user_preferences_changed($user->id);
1635     return true;
1638 /**
1639  * Sets a whole array of preferences for the current user
1640  *
1641  * If user object submitted, 'preference' property contains the preferences cache.
1642  *
1643  * @param array $prefarray An array of key/value pairs to be set
1644  * @param stdClass|int $user A moodle user object or id, null means current user
1645  * @return bool always true or exception
1646  */
1647 function set_user_preferences(array $prefarray, $user = null) {
1648     foreach ($prefarray as $name => $value) {
1649         set_user_preference($name, $value, $user);
1650     }
1651     return true;
1654 /**
1655  * Unsets a preference completely by deleting it from the database
1656  *
1657  * If user object submitted, 'preference' property contains the preferences cache.
1658  *
1659  * @param string  $name The key to unset as preference for the specified user
1660  * @param stdClass|int $user A moodle user object or id, null means current user
1661  * @return bool always true or exception
1662  */
1663 function unset_user_preference($name, $user = null) {
1664     global $USER, $DB;
1666     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1667         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1668     }
1670     if (is_null($user)) {
1671         $user = $USER;
1672     } else if (isset($user->id)) {
1673         // $user is valid object
1674     } else if (is_numeric($user)) {
1675         $user = (object)array('id'=>(int)$user);
1676     } else {
1677         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1678     }
1680     check_user_preferences_loaded($user);
1682     if (empty($user->id) or isguestuser($user->id)) {
1683         // no permanent storage for not-logged-in user and guest
1684         unset($user->preference[$name]);
1685         return true;
1686     }
1688     // delete from DB
1689     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1691     // delete the preference from cache
1692     unset($user->preference[$name]);
1694     // set reload flag for other sessions
1695     mark_user_preferences_changed($user->id);
1697     return true;
1700 /**
1701  * Used to fetch user preference(s)
1702  *
1703  * If no arguments are supplied this function will return
1704  * all of the current user preferences as an array.
1705  *
1706  * If a name is specified then this function
1707  * attempts to return that particular preference value.  If
1708  * none is found, then the optional value $default is returned,
1709  * otherwise NULL.
1710  *
1711  * If user object submitted, 'preference' property contains the preferences cache.
1712  *
1713  * @param string $name Name of the key to use in finding a preference value
1714  * @param mixed $default Value to be returned if the $name key is not set in the user preferences
1715  * @param stdClass|int $user A moodle user object or id, null means current user
1716  * @return mixed string value or default
1717  */
1718 function get_user_preferences($name = null, $default = null, $user = null) {
1719     global $USER;
1721     if (is_null($name)) {
1722         // all prefs
1723     } else if (is_numeric($name) or $name === '_lastloaded') {
1724         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1725     }
1727     if (is_null($user)) {
1728         $user = $USER;
1729     } else if (isset($user->id)) {
1730         // $user is valid object
1731     } else if (is_numeric($user)) {
1732         $user = (object)array('id'=>(int)$user);
1733     } else {
1734         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1735     }
1737     check_user_preferences_loaded($user);
1739     if (empty($name)) {
1740         return $user->preference; // All values
1741     } else if (isset($user->preference[$name])) {
1742         return $user->preference[$name]; // The single string value
1743     } else {
1744         return $default; // Default value (null if not specified)
1745     }
1748 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1750 /**
1751  * Given date parts in user time produce a GMT timestamp.
1752  *
1753  * @todo Finish documenting this function
1754  * @param int $year The year part to create timestamp of
1755  * @param int $month The month part to create timestamp of
1756  * @param int $day The day part to create timestamp of
1757  * @param int $hour The hour part to create timestamp of
1758  * @param int $minute The minute part to create timestamp of
1759  * @param int $second The second part to create timestamp of
1760  * @param mixed $timezone Timezone modifier, if 99 then use default user's timezone
1761  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1762  *             applied only if timezone is 99 or string.
1763  * @return int timestamp
1764  */
1765 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1767     //save input timezone, required for dst offset check.
1768     $passedtimezone = $timezone;
1770     $timezone = get_user_timezone_offset($timezone);
1772     if (abs($timezone) > 13) {  //server time
1773         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1774     } else {
1775         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1776         $time = usertime($time, $timezone);
1778         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1779         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1780             $time -= dst_offset_on($time, $passedtimezone);
1781         }
1782     }
1784     return $time;
1788 /**
1789  * Format a date/time (seconds) as weeks, days, hours etc as needed
1790  *
1791  * Given an amount of time in seconds, returns string
1792  * formatted nicely as weeks, days, hours etc as needed
1793  *
1794  * @uses MINSECS
1795  * @uses HOURSECS
1796  * @uses DAYSECS
1797  * @uses YEARSECS
1798  * @param int $totalsecs Time in seconds
1799  * @param object $str Should be a time object
1800  * @return string A nicely formatted date/time string
1801  */
1802  function format_time($totalsecs, $str=NULL) {
1804     $totalsecs = abs($totalsecs);
1806     if (!$str) {  // Create the str structure the slow way
1807         $str->day   = get_string('day');
1808         $str->days  = get_string('days');
1809         $str->hour  = get_string('hour');
1810         $str->hours = get_string('hours');
1811         $str->min   = get_string('min');
1812         $str->mins  = get_string('mins');
1813         $str->sec   = get_string('sec');
1814         $str->secs  = get_string('secs');
1815         $str->year  = get_string('year');
1816         $str->years = get_string('years');
1817     }
1820     $years     = floor($totalsecs/YEARSECS);
1821     $remainder = $totalsecs - ($years*YEARSECS);
1822     $days      = floor($remainder/DAYSECS);
1823     $remainder = $totalsecs - ($days*DAYSECS);
1824     $hours     = floor($remainder/HOURSECS);
1825     $remainder = $remainder - ($hours*HOURSECS);
1826     $mins      = floor($remainder/MINSECS);
1827     $secs      = $remainder - ($mins*MINSECS);
1829     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1830     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1831     $sh = ($hours == 1) ? $str->hour : $str->hours;
1832     $sd = ($days == 1)  ? $str->day  : $str->days;
1833     $sy = ($years == 1)  ? $str->year  : $str->years;
1835     $oyears = '';
1836     $odays = '';
1837     $ohours = '';
1838     $omins = '';
1839     $osecs = '';
1841     if ($years)  $oyears  = $years .' '. $sy;
1842     if ($days)  $odays  = $days .' '. $sd;
1843     if ($hours) $ohours = $hours .' '. $sh;
1844     if ($mins)  $omins  = $mins .' '. $sm;
1845     if ($secs)  $osecs  = $secs .' '. $ss;
1847     if ($years) return trim($oyears .' '. $odays);
1848     if ($days)  return trim($odays .' '. $ohours);
1849     if ($hours) return trim($ohours .' '. $omins);
1850     if ($mins)  return trim($omins .' '. $osecs);
1851     if ($secs)  return $osecs;
1852     return get_string('now');
1855 /**
1856  * Returns a formatted string that represents a date in user time
1857  *
1858  * Returns a formatted string that represents a date in user time
1859  * <b>WARNING: note that the format is for strftime(), not date().</b>
1860  * Because of a bug in most Windows time libraries, we can't use
1861  * the nicer %e, so we have to use %d which has leading zeroes.
1862  * A lot of the fuss in the function is just getting rid of these leading
1863  * zeroes as efficiently as possible.
1864  *
1865  * If parameter fixday = true (default), then take off leading
1866  * zero from %d, else maintain it.
1867  *
1868  * @param int $date the timestamp in UTC, as obtained from the database.
1869  * @param string $format strftime format. You should probably get this using
1870  *      get_string('strftime...', 'langconfig');
1871  * @param mixed $timezone by default, uses the user's time zone. if numeric and
1872  *      not 99 then daylight saving will not be added.
1873  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1874  *      If false then the leading zero is maintained.
1875  * @return string the formatted date/time.
1876  */
1877 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1879     global $CFG;
1881     if (empty($format)) {
1882         $format = get_string('strftimedaydatetime', 'langconfig');
1883     }
1885     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1886         $fixday = false;
1887     } else if ($fixday) {
1888         $formatnoday = str_replace('%d', 'DD', $format);
1889         $fixday = ($formatnoday != $format);
1890     }
1892     //add daylight saving offset for string timezones only, as we can't get dst for
1893     //float values. if timezone is 99 (user default timezone), then try update dst.
1894     if ((99 == $timezone) || !is_numeric($timezone)) {
1895         $date += dst_offset_on($date, $timezone);
1896     }
1898     $timezone = get_user_timezone_offset($timezone);
1900     if (abs($timezone) > 13) {   /// Server time
1901         if ($fixday) {
1902             $datestring = strftime($formatnoday, $date);
1903             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1904             $datestring = str_replace('DD', $daystring, $datestring);
1905         } else {
1906             $datestring = strftime($format, $date);
1907         }
1908     } else {
1909         $date += (int)($timezone * 3600);
1910         if ($fixday) {
1911             $datestring = gmstrftime($formatnoday, $date);
1912             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1913             $datestring = str_replace('DD', $daystring, $datestring);
1914         } else {
1915             $datestring = gmstrftime($format, $date);
1916         }
1917     }
1919 /// If we are running under Windows convert from windows encoding to UTF-8
1920 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1922    if ($CFG->ostype == 'WINDOWS') {
1923        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1924            $textlib = textlib_get_instance();
1925            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1926        }
1927    }
1929     return $datestring;
1932 /**
1933  * Given a $time timestamp in GMT (seconds since epoch),
1934  * returns an array that represents the date in user time
1935  *
1936  * @todo Finish documenting this function
1937  * @uses HOURSECS
1938  * @param int $time Timestamp in GMT
1939  * @param mixed $timezone offset time with timezone, if float and not 99, then no
1940  *        dst offset is applyed
1941  * @return array An array that represents the date in user time
1942  */
1943 function usergetdate($time, $timezone=99) {
1945     //save input timezone, required for dst offset check.
1946     $passedtimezone = $timezone;
1948     $timezone = get_user_timezone_offset($timezone);
1950     if (abs($timezone) > 13) {    // Server time
1951         return getdate($time);
1952     }
1954     //add daylight saving offset for string timezones only, as we can't get dst for
1955     //float values. if timezone is 99 (user default timezone), then try update dst.
1956     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
1957         $time += dst_offset_on($time, $passedtimezone);
1958     }
1960     $time += intval((float)$timezone * HOURSECS);
1962     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1964     //be careful to ensure the returned array matches that produced by getdate() above
1965     list(
1966         $getdate['month'],
1967         $getdate['weekday'],
1968         $getdate['yday'],
1969         $getdate['year'],
1970         $getdate['mon'],
1971         $getdate['wday'],
1972         $getdate['mday'],
1973         $getdate['hours'],
1974         $getdate['minutes'],
1975         $getdate['seconds']
1976     ) = explode('_', $datestring);
1978     return $getdate;
1981 /**
1982  * Given a GMT timestamp (seconds since epoch), offsets it by
1983  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1984  *
1985  * @uses HOURSECS
1986  * @param  int $date Timestamp in GMT
1987  * @param float $timezone
1988  * @return int
1989  */
1990 function usertime($date, $timezone=99) {
1992     $timezone = get_user_timezone_offset($timezone);
1994     if (abs($timezone) > 13) {
1995         return $date;
1996     }
1997     return $date - (int)($timezone * HOURSECS);
2000 /**
2001  * Given a time, return the GMT timestamp of the most recent midnight
2002  * for the current user.
2003  *
2004  * @param int $date Timestamp in GMT
2005  * @param float $timezone Defaults to user's timezone
2006  * @return int Returns a GMT timestamp
2007  */
2008 function usergetmidnight($date, $timezone=99) {
2010     $userdate = usergetdate($date, $timezone);
2012     // Time of midnight of this user's day, in GMT
2013     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2017 /**
2018  * Returns a string that prints the user's timezone
2019  *
2020  * @param float $timezone The user's timezone
2021  * @return string
2022  */
2023 function usertimezone($timezone=99) {
2025     $tz = get_user_timezone($timezone);
2027     if (!is_float($tz)) {
2028         return $tz;
2029     }
2031     if(abs($tz) > 13) { // Server time
2032         return get_string('serverlocaltime');
2033     }
2035     if($tz == intval($tz)) {
2036         // Don't show .0 for whole hours
2037         $tz = intval($tz);
2038     }
2040     if($tz == 0) {
2041         return 'UTC';
2042     }
2043     else if($tz > 0) {
2044         return 'UTC+'.$tz;
2045     }
2046     else {
2047         return 'UTC'.$tz;
2048     }
2052 /**
2053  * Returns a float which represents the user's timezone difference from GMT in hours
2054  * Checks various settings and picks the most dominant of those which have a value
2055  *
2056  * @global object
2057  * @global object
2058  * @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
2059  * @return float
2060  */
2061 function get_user_timezone_offset($tz = 99) {
2063     global $USER, $CFG;
2065     $tz = get_user_timezone($tz);
2067     if (is_float($tz)) {
2068         return $tz;
2069     } else {
2070         $tzrecord = get_timezone_record($tz);
2071         if (empty($tzrecord)) {
2072             return 99.0;
2073         }
2074         return (float)$tzrecord->gmtoff / HOURMINS;
2075     }
2078 /**
2079  * Returns an int which represents the systems's timezone difference from GMT in seconds
2080  *
2081  * @global object
2082  * @param mixed $tz timezone
2083  * @return int if found, false is timezone 99 or error
2084  */
2085 function get_timezone_offset($tz) {
2086     global $CFG;
2088     if ($tz == 99) {
2089         return false;
2090     }
2092     if (is_numeric($tz)) {
2093         return intval($tz * 60*60);
2094     }
2096     if (!$tzrecord = get_timezone_record($tz)) {
2097         return false;
2098     }
2099     return intval($tzrecord->gmtoff * 60);
2102 /**
2103  * Returns a float or a string which denotes the user's timezone
2104  * 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)
2105  * means that for this timezone there are also DST rules to be taken into account
2106  * Checks various settings and picks the most dominant of those which have a value
2107  *
2108  * @global object
2109  * @global object
2110  * @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
2111  * @return mixed
2112  */
2113 function get_user_timezone($tz = 99) {
2114     global $USER, $CFG;
2116     $timezones = array(
2117         $tz,
2118         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2119         isset($USER->timezone) ? $USER->timezone : 99,
2120         isset($CFG->timezone) ? $CFG->timezone : 99,
2121         );
2123     $tz = 99;
2125     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
2126         $tz = $next['value'];
2127     }
2129     return is_numeric($tz) ? (float) $tz : $tz;
2132 /**
2133  * Returns cached timezone record for given $timezonename
2134  *
2135  * @global object
2136  * @global object
2137  * @param string $timezonename
2138  * @return mixed timezonerecord object or false
2139  */
2140 function get_timezone_record($timezonename) {
2141     global $CFG, $DB;
2142     static $cache = NULL;
2144     if ($cache === NULL) {
2145         $cache = array();
2146     }
2148     if (isset($cache[$timezonename])) {
2149         return $cache[$timezonename];
2150     }
2152     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2153                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
2156 /**
2157  * Build and store the users Daylight Saving Time (DST) table
2158  *
2159  * @global object
2160  * @global object
2161  * @global object
2162  * @param mixed $from_year Start year for the table, defaults to 1971
2163  * @param mixed $to_year End year for the table, defaults to 2035
2164  * @param mixed $strtimezone, if null or 99 then user's default timezone is used
2165  * @return bool
2166  */
2167 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2168     global $CFG, $SESSION, $DB;
2170     $usertz = get_user_timezone($strtimezone);
2172     if (is_float($usertz)) {
2173         // Trivial timezone, no DST
2174         return false;
2175     }
2177     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2178         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2179         unset($SESSION->dst_offsets);
2180         unset($SESSION->dst_range);
2181     }
2183     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2184         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2185         // This will be the return path most of the time, pretty light computationally
2186         return true;
2187     }
2189     // Reaching here means we either need to extend our table or create it from scratch
2191     // Remember which TZ we calculated these changes for
2192     $SESSION->dst_offsettz = $usertz;
2194     if(empty($SESSION->dst_offsets)) {
2195         // If we 're creating from scratch, put the two guard elements in there
2196         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2197     }
2198     if(empty($SESSION->dst_range)) {
2199         // If creating from scratch
2200         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2201         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2203         // Fill in the array with the extra years we need to process
2204         $yearstoprocess = array();
2205         for($i = $from; $i <= $to; ++$i) {
2206             $yearstoprocess[] = $i;
2207         }
2209         // Take note of which years we have processed for future calls
2210         $SESSION->dst_range = array($from, $to);
2211     }
2212     else {
2213         // If needing to extend the table, do the same
2214         $yearstoprocess = array();
2216         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2217         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2219         if($from < $SESSION->dst_range[0]) {
2220             // Take note of which years we need to process and then note that we have processed them for future calls
2221             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2222                 $yearstoprocess[] = $i;
2223             }
2224             $SESSION->dst_range[0] = $from;
2225         }
2226         if($to > $SESSION->dst_range[1]) {
2227             // Take note of which years we need to process and then note that we have processed them for future calls
2228             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2229                 $yearstoprocess[] = $i;
2230             }
2231             $SESSION->dst_range[1] = $to;
2232         }
2233     }
2235     if(empty($yearstoprocess)) {
2236         // This means that there was a call requesting a SMALLER range than we have already calculated
2237         return true;
2238     }
2240     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2241     // Also, the array is sorted in descending timestamp order!
2243     // Get DB data
2245     static $presets_cache = array();
2246     if (!isset($presets_cache[$usertz])) {
2247         $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');
2248     }
2249     if(empty($presets_cache[$usertz])) {
2250         return false;
2251     }
2253     // Remove ending guard (first element of the array)
2254     reset($SESSION->dst_offsets);
2255     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2257     // Add all required change timestamps
2258     foreach($yearstoprocess as $y) {
2259         // Find the record which is in effect for the year $y
2260         foreach($presets_cache[$usertz] as $year => $preset) {
2261             if($year <= $y) {
2262                 break;
2263             }
2264         }
2266         $changes = dst_changes_for_year($y, $preset);
2268         if($changes === NULL) {
2269             continue;
2270         }
2271         if($changes['dst'] != 0) {
2272             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2273         }
2274         if($changes['std'] != 0) {
2275             $SESSION->dst_offsets[$changes['std']] = 0;
2276         }
2277     }
2279     // Put in a guard element at the top
2280     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2281     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2283     // Sort again
2284     krsort($SESSION->dst_offsets);
2286     return true;
2289 /**
2290  * Calculates the required DST change and returns a Timestamp Array
2291  *
2292  * @uses HOURSECS
2293  * @uses MINSECS
2294  * @param mixed $year Int or String Year to focus on
2295  * @param object $timezone Instatiated Timezone object
2296  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
2297  */
2298 function dst_changes_for_year($year, $timezone) {
2300     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2301         return NULL;
2302     }
2304     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2305     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2307     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2308     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2310     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2311     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2313     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2314     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2315     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2317     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2318     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2320     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2323 /**
2324  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2325  * - Note: Daylight saving only works for string timezones and not for float.
2326  *
2327  * @global object
2328  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2329  * @param mixed $strtimezone timezone for which offset is expected, if 99 or null
2330  *        then user's default timezone is used.
2331  * @return int
2332  */
2333 function dst_offset_on($time, $strtimezone = NULL) {
2334     global $SESSION;
2336     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2337         return 0;
2338     }
2340     reset($SESSION->dst_offsets);
2341     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2342         if($from <= $time) {
2343             break;
2344         }
2345     }
2347     // This is the normal return path
2348     if($offset !== NULL) {
2349         return $offset;
2350     }
2352     // Reaching this point means we haven't calculated far enough, do it now:
2353     // Calculate extra DST changes if needed and recurse. The recursion always
2354     // moves toward the stopping condition, so will always end.
2356     if($from == 0) {
2357         // We need a year smaller than $SESSION->dst_range[0]
2358         if($SESSION->dst_range[0] == 1971) {
2359             return 0;
2360         }
2361         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2362         return dst_offset_on($time, $strtimezone);
2363     }
2364     else {
2365         // We need a year larger than $SESSION->dst_range[1]
2366         if($SESSION->dst_range[1] == 2035) {
2367             return 0;
2368         }
2369         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2370         return dst_offset_on($time, $strtimezone);
2371     }
2374 /**
2375  * ?
2376  *
2377  * @todo Document what this function does
2378  * @param int $startday
2379  * @param int $weekday
2380  * @param int $month
2381  * @param int $year
2382  * @return int
2383  */
2384 function find_day_in_month($startday, $weekday, $month, $year) {
2386     $daysinmonth = days_in_month($month, $year);
2388     if($weekday == -1) {
2389         // Don't care about weekday, so return:
2390         //    abs($startday) if $startday != -1
2391         //    $daysinmonth otherwise
2392         return ($startday == -1) ? $daysinmonth : abs($startday);
2393     }
2395     // From now on we 're looking for a specific weekday
2397     // Give "end of month" its actual value, since we know it
2398     if($startday == -1) {
2399         $startday = -1 * $daysinmonth;
2400     }
2402     // Starting from day $startday, the sign is the direction
2404     if($startday < 1) {
2406         $startday = abs($startday);
2407         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2409         // This is the last such weekday of the month
2410         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2411         if($lastinmonth > $daysinmonth) {
2412             $lastinmonth -= 7;
2413         }
2415         // Find the first such weekday <= $startday
2416         while($lastinmonth > $startday) {
2417             $lastinmonth -= 7;
2418         }
2420         return $lastinmonth;
2422     }
2423     else {
2425         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2427         $diff = $weekday - $indexweekday;
2428         if($diff < 0) {
2429             $diff += 7;
2430         }
2432         // This is the first such weekday of the month equal to or after $startday
2433         $firstfromindex = $startday + $diff;
2435         return $firstfromindex;
2437     }
2440 /**
2441  * Calculate the number of days in a given month
2442  *
2443  * @param int $month The month whose day count is sought
2444  * @param int $year The year of the month whose day count is sought
2445  * @return int
2446  */
2447 function days_in_month($month, $year) {
2448    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2451 /**
2452  * Calculate the position in the week of a specific calendar day
2453  *
2454  * @param int $day The day of the date whose position in the week is sought
2455  * @param int $month The month of the date whose position in the week is sought
2456  * @param int $year The year of the date whose position in the week is sought
2457  * @return int
2458  */
2459 function dayofweek($day, $month, $year) {
2460     // I wonder if this is any different from
2461     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2462     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2465 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2467 /**
2468  * Returns full login url.
2469  *
2470  * @return string login url
2471  */
2472 function get_login_url() {
2473     global $CFG;
2475     $url = "$CFG->wwwroot/login/index.php";
2477     if (!empty($CFG->loginhttps)) {
2478         $url = str_replace('http:', 'https:', $url);
2479     }
2481     return $url;
2484 /**
2485  * This function checks that the current user is logged in and has the
2486  * required privileges
2487  *
2488  * This function checks that the current user is logged in, and optionally
2489  * whether they are allowed to be in a particular course and view a particular
2490  * course module.
2491  * If they are not logged in, then it redirects them to the site login unless
2492  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2493  * case they are automatically logged in as guests.
2494  * If $courseid is given and the user is not enrolled in that course then the
2495  * user is redirected to the course enrolment page.
2496  * If $cm is given and the course module is hidden and the user is not a teacher
2497  * in the course then the user is redirected to the course home page.
2498  *
2499  * When $cm parameter specified, this function sets page layout to 'module'.
2500  * You need to change it manually later if some other layout needed.
2501  *
2502  * @param mixed $courseorid id of the course or course object
2503  * @param bool $autologinguest default true
2504  * @param object $cm course module object
2505  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2506  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2507  *             in order to keep redirects working properly. MDL-14495
2508  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2509  * @return mixed Void, exit, and die depending on path
2510  */
2511 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2512     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2514     // setup global $COURSE, themes, language and locale
2515     if (!empty($courseorid)) {
2516         if (is_object($courseorid)) {
2517             $course = $courseorid;
2518         } else if ($courseorid == SITEID) {
2519             $course = clone($SITE);
2520         } else {
2521             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2522         }
2523         if ($cm) {
2524             if ($cm->course != $course->id) {
2525                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2526             }
2527             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2528             if (!($cm instanceof cm_info)) {
2529                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2530                 // db queries so this is not really a performance concern, however it is obviously
2531                 // better if you use get_fast_modinfo to get the cm before calling this.
2532                 $modinfo = get_fast_modinfo($course);
2533                 $cm = $modinfo->get_cm($cm->id);
2534             }
2535             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2536             $PAGE->set_pagelayout('incourse');
2537         } else {
2538             $PAGE->set_course($course); // set's up global $COURSE
2539         }
2540     } else {
2541         // do not touch global $COURSE via $PAGE->set_course(),
2542         // the reasons is we need to be able to call require_login() at any time!!
2543         $course = $SITE;
2544         if ($cm) {
2545             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2546         }
2547     }
2549     // If the user is not even logged in yet then make sure they are
2550     if (!isloggedin()) {
2551         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2552             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2553                 // misconfigured site guest, just redirect to login page
2554                 redirect(get_login_url());
2555                 exit; // never reached
2556             }
2557             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2558             complete_user_login($guest);
2559             $USER->autologinguest = true;
2560             $SESSION->lang = $lang;
2561         } else {
2562             //NOTE: $USER->site check was obsoleted by session test cookie,
2563             //      $USER->confirmed test is in login/index.php
2564             if ($preventredirect) {
2565                 throw new require_login_exception('You are not logged in');
2566             }
2568             if ($setwantsurltome) {
2569                 // TODO: switch to PAGE->url
2570                 $SESSION->wantsurl = $FULLME;
2571             }
2572             if (!empty($_SERVER['HTTP_REFERER'])) {
2573                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2574             }
2575             redirect(get_login_url());
2576             exit; // never reached
2577         }
2578     }
2580     // loginas as redirection if needed
2581     if ($course->id != SITEID and session_is_loggedinas()) {
2582         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2583             if ($USER->loginascontext->instanceid != $course->id) {
2584                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2585             }
2586         }
2587     }
2589     // check whether the user should be changing password (but only if it is REALLY them)
2590     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2591         $userauth = get_auth_plugin($USER->auth);
2592         if ($userauth->can_change_password() and !$preventredirect) {
2593             $SESSION->wantsurl = $FULLME;
2594             if ($changeurl = $userauth->change_password_url()) {
2595                 //use plugin custom url
2596                 redirect($changeurl);
2597             } else {
2598                 //use moodle internal method
2599                 if (empty($CFG->loginhttps)) {
2600                     redirect($CFG->wwwroot .'/login/change_password.php');
2601                 } else {
2602                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2603                     redirect($wwwroot .'/login/change_password.php');
2604                 }
2605             }
2606         } else {
2607             print_error('nopasswordchangeforced', 'auth');
2608         }
2609     }
2611     // Check that the user account is properly set up
2612     if (user_not_fully_set_up($USER)) {
2613         if ($preventredirect) {
2614             throw new require_login_exception('User not fully set-up');
2615         }
2616         $SESSION->wantsurl = $FULLME;
2617         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2618     }
2620     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2621     sesskey();
2623     // Do not bother admins with any formalities
2624     if (is_siteadmin()) {
2625         //set accesstime or the user will appear offline which messes up messaging
2626         user_accesstime_log($course->id);
2627         return;
2628     }
2630     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2631     if (!$USER->policyagreed and !is_siteadmin()) {
2632         if (!empty($CFG->sitepolicy) 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         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2639             if ($preventredirect) {
2640                 throw new require_login_exception('Policy not agreed');
2641             }
2642             $SESSION->wantsurl = $FULLME;
2643             redirect($CFG->wwwroot .'/user/policy.php');
2644         }
2645     }
2647     // Fetch the system context, the course context, and prefetch its child contexts
2648     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2649     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2650     if ($cm) {
2651         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2652     } else {
2653         $cmcontext = null;
2654     }
2656     // If the site is currently under maintenance, then print a message
2657     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2658         if ($preventredirect) {
2659             throw new require_login_exception('Maintenance in progress');
2660         }
2662         print_maintenance_message();
2663     }
2665     // make sure the course itself is not hidden
2666     if ($course->id == SITEID) {
2667         // frontpage can not be hidden
2668     } else {
2669         if (is_role_switched($course->id)) {
2670             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2671         } else {
2672             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2673                 // originally there was also test of parent category visibility,
2674                 // BUT is was very slow in complex queries involving "my courses"
2675                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2676                 if ($preventredirect) {
2677                     throw new require_login_exception('Course is hidden');
2678                 }
2679                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2680             }
2681         }
2682     }
2684     // is the user enrolled?
2685     if ($course->id == SITEID) {
2686         // everybody is enrolled on the frontpage
2688     } else {
2689         if (session_is_loggedinas()) {
2690             // Make sure the REAL person can access this course first
2691             $realuser = session_get_realuser();
2692             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2693                 if ($preventredirect) {
2694                     throw new require_login_exception('Invalid course login-as access');
2695                 }
2696                 echo $OUTPUT->header();
2697                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2698             }
2699         }
2701         // very simple enrolment caching - changes in course setting are not reflected immediately
2702         if (!isset($USER->enrol)) {
2703             $USER->enrol = array();
2704             $USER->enrol['enrolled'] = array();
2705             $USER->enrol['tempguest'] = array();
2706         }
2708         $access = false;
2710         if (is_viewing($coursecontext, $USER)) {
2711             // ok, no need to mess with enrol
2712             $access = true;
2714         } else {
2715             if (isset($USER->enrol['enrolled'][$course->id])) {
2716                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2717                     $access = true;
2718                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2719                     $access = true;
2720                 } else {
2721                     //expired
2722                     unset($USER->enrol['enrolled'][$course->id]);
2723                 }
2724             }
2725             if (isset($USER->enrol['tempguest'][$course->id])) {
2726                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2727                     $access = true;
2728                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2729                     $access = true;
2730                 } else {
2731                     //expired
2732                     unset($USER->enrol['tempguest'][$course->id]);
2733                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2734                 }
2735             }
2737             if ($access) {
2738                 // cache ok
2739             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2740                 // active participants may always access
2741                 // TODO: refactor this into some new function
2742                 $now = time();
2743                 $sql = "SELECT MAX(ue.timeend)
2744                           FROM {user_enrolments} ue
2745                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2746                           JOIN {user} u ON u.id = ue.userid
2747                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2748                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2749                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2750                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2751                 $until = $DB->get_field_sql($sql, $params);
2752                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2753                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2754                 }
2756                 $USER->enrol['enrolled'][$course->id] = $until;
2757                 $access = true;
2759                 // remove traces of previous temp guest access
2760                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2762             } else {
2763                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2764                 $enrols = enrol_get_plugins(true);
2765                 // first ask all enabled enrol instances in course if they want to auto enrol user
2766                 foreach($instances as $instance) {
2767                     if (!isset($enrols[$instance->enrol])) {
2768                         continue;
2769                     }
2770                     // Get a duration for the guestaccess, a timestamp in the future or false.
2771                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2772                     if ($until !== false) {
2773                         $USER->enrol['enrolled'][$course->id] = $until;
2774                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2775                         $access = true;
2776                         break;
2777                     }
2778                 }
2779                 // if not enrolled yet try to gain temporary guest access
2780                 if (!$access) {
2781                     foreach($instances as $instance) {
2782                         if (!isset($enrols[$instance->enrol])) {
2783                             continue;
2784                         }
2785                         // Get a duration for the guestaccess, a timestamp in the future or false.
2786                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2787                         if ($until !== false) {
2788                             $USER->enrol['tempguest'][$course->id] = $until;
2789                             $access = true;
2790                             break;
2791                         }
2792                     }
2793                 }
2794             }
2795         }
2797         if (!$access) {
2798             if ($preventredirect) {
2799                 throw new require_login_exception('Not enrolled');
2800             }
2801             $SESSION->wantsurl = $FULLME;
2802             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2803         }
2804     }
2806     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
2807     // conditional availability, etc
2808     if ($cm && !$cm->uservisible) {
2809         if ($preventredirect) {
2810             throw new require_login_exception('Activity is hidden');
2811         }
2812         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2813     }
2815     // Finally access granted, update lastaccess times
2816     user_accesstime_log($course->id);
2820 /**
2821  * This function just makes sure a user is logged out.
2822  *
2823  * @global object
2824  */
2825 function require_logout() {
2826     global $USER;
2828     $params = $USER;
2830     if (isloggedin()) {
2831         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2833         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2834         foreach($authsequence as $authname) {
2835             $authplugin = get_auth_plugin($authname);
2836             $authplugin->prelogout_hook();
2837         }
2838     }
2840     events_trigger('user_logout', $params);
2841     session_get_instance()->terminate_current();
2842     unset($params);
2845 /**
2846  * Weaker version of require_login()
2847  *
2848  * This is a weaker version of {@link require_login()} which only requires login
2849  * when called from within a course rather than the site page, unless
2850  * the forcelogin option is turned on.
2851  * @see require_login()
2852  *
2853  * @global object
2854  * @param mixed $courseorid The course object or id in question
2855  * @param bool $autologinguest Allow autologin guests if that is wanted
2856  * @param object $cm Course activity module if known
2857  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2858  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2859  *             in order to keep redirects working properly. MDL-14495
2860  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2861  * @return void
2862  */
2863 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2864     global $CFG, $PAGE, $SITE;
2865     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
2866           or (!is_object($courseorid) and $courseorid == SITEID);
2867     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
2868         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2869         // db queries so this is not really a performance concern, however it is obviously
2870         // better if you use get_fast_modinfo to get the cm before calling this.
2871         if (is_object($courseorid)) {
2872             $course = $courseorid;
2873         } else {
2874             $course = clone($SITE);
2875         }
2876         $modinfo = get_fast_modinfo($course);
2877         $cm = $modinfo->get_cm($cm->id);
2878     }
2879     if (!empty($CFG->forcelogin)) {
2880         // login required for both SITE and courses
2881         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2883     } else if ($issite && !empty($cm) and !$cm->uservisible) {
2884         // always login for hidden activities
2885         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2887     } else if ($issite) {
2888               //login for SITE not required
2889         if ($cm and empty($cm->visible)) {
2890             // hidden activities are not accessible without login
2891             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2892         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2893             // not-logged-in users do not have any group membership
2894             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2895         } else {
2896             // We still need to instatiate PAGE vars properly so that things
2897             // that rely on it like navigation function correctly.
2898             if (!empty($courseorid)) {
2899                 if (is_object($courseorid)) {
2900                     $course = $courseorid;
2901                 } else {
2902                     $course = clone($SITE);
2903                 }
2904                 if ($cm) {
2905                     if ($cm->course != $course->id) {
2906                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2907                     }
2908                     $PAGE->set_cm($cm, $course);
2909                     $PAGE->set_pagelayout('incourse');
2910                 } else {
2911                     $PAGE->set_course($course);
2912                 }
2913             } else {
2914                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2915                 // up properly, set them up now.
2916                 $PAGE->set_course($PAGE->course);
2917             }
2918             //TODO: verify conditional activities here
2919             user_accesstime_log(SITEID);
2920             return;
2921         }
2923     } else {
2924         // course login always required
2925         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2926     }
2929 /**
2930  * Require key login. Function terminates with error if key not found or incorrect.
2931  *
2932  * @global object
2933  * @global object
2934  * @global object
2935  * @global object
2936  * @uses NO_MOODLE_COOKIES
2937  * @uses PARAM_ALPHANUM
2938  * @param string $script unique script identifier
2939  * @param int $instance optional instance id
2940  * @return int Instance ID
2941  */
2942 function require_user_key_login($script, $instance=null) {
2943     global $USER, $SESSION, $CFG, $DB;
2945     if (!NO_MOODLE_COOKIES) {
2946         print_error('sessioncookiesdisable');
2947     }
2949 /// extra safety
2950     @session_write_close();
2952     $keyvalue = required_param('key', PARAM_ALPHANUM);
2954     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2955         print_error('invalidkey');
2956     }
2958     if (!empty($key->validuntil) and $key->validuntil < time()) {
2959         print_error('expiredkey');
2960     }
2962     if ($key->iprestriction) {
2963         $remoteaddr = getremoteaddr(null);
2964         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2965             print_error('ipmismatch');
2966         }
2967     }
2969     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2970         print_error('invaliduserid');
2971     }
2973 /// emulate normal session
2974     session_set_user($user);
2976 /// note we are not using normal login
2977     if (!defined('USER_KEY_LOGIN')) {
2978         define('USER_KEY_LOGIN', true);
2979     }
2981 /// return instance id - it might be empty
2982     return $key->instance;
2985 /**
2986  * Creates a new private user access key.
2987  *
2988  * @global object
2989  * @param string $script unique target identifier
2990  * @param int $userid
2991  * @param int $instance optional instance id
2992  * @param string $iprestriction optional ip restricted access
2993  * @param timestamp $validuntil key valid only until given data
2994  * @return string access key value
2995  */
2996 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2997     global $DB;
2999     $key = new stdClass();
3000     $key->script        = $script;
3001     $key->userid        = $userid;
3002     $key->instance      = $instance;
3003     $key->iprestriction = $iprestriction;
3004     $key->validuntil    = $validuntil;
3005     $key->timecreated   = time();
3007     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3008     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3009         // must be unique
3010         $key->value     = md5($userid.'_'.time().random_string(40));
3011     }
3012     $DB->insert_record('user_private_key', $key);
3013     return $key->value;
3016 /**
3017  * Delete the user's new private user access keys for a particular script.
3018  *
3019  * @global object
3020  * @param string $script unique target identifier
3021  * @param int $userid
3022  * @return void
3023  */
3024 function delete_user_key($script,$userid) {
3025     global $DB;
3026     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3029 /**
3030  * Gets a private user access key (and creates one if one doesn't exist).
3031  *
3032  * @global object
3033  * @param string $script unique target identifier
3034  * @param int $userid
3035  * @param int $instance optional instance id
3036  * @param string $iprestriction optional ip restricted access
3037  * @param timestamp $validuntil key valid only until given data
3038  * @return string access key value
3039  */
3040 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3041     global $DB;
3043     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3044                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3045                                                          'validuntil'=>$validuntil))) {
3046         return $key->value;
3047     } else {
3048         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3049     }
3053 /**
3054  * Modify the user table by setting the currently logged in user's
3055  * last login to now.
3056  *
3057  * @global object
3058  * @global object
3059  * @return bool Always returns true
3060  */
3061 function update_user_login_times() {
3062     global $USER, $DB;
3064     $user = new stdClass();
3065     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3066     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
3068     $user->id = $USER->id;
3070     $DB->update_record('user', $user);
3071     return true;
3074 /**
3075  * Determines if a user has completed setting up their account.
3076  *
3077  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3078  * @return bool
3079  */
3080 function user_not_fully_set_up($user) {
3081     if (isguestuser($user)) {
3082         return false;
3083     }
3084     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3087 /**
3088  * Check whether the user has exceeded the bounce threshold
3089  *
3090  * @global object
3091  * @global object
3092  * @param user $user A {@link $USER} object
3093  * @return bool true=>User has exceeded bounce threshold
3094  */
3095 function over_bounce_threshold($user) {
3096     global $CFG, $DB;
3098     if (empty($CFG->handlebounces)) {
3099         return false;
3100     }
3102     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3103         return false;
3104     }
3106     // set sensible defaults
3107     if (empty($CFG->minbounces)) {
3108         $CFG->minbounces = 10;
3109     }
3110     if (empty($CFG->bounceratio)) {
3111         $CFG->bounceratio = .20;
3112     }
3113     $bouncecount = 0;
3114     $sendcount = 0;
3115     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3116         $bouncecount = $bounce->value;
3117     }
3118     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3119         $sendcount = $send->value;
3120     }
3121     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3124 /**
3125  * Used to increment or reset email sent count
3126  *
3127  * @global object
3128  * @param user $user object containing an id
3129  * @param bool $reset will reset the count to 0
3130  * @return void
3131  */
3132 function set_send_count($user,$reset=false) {
3133     global $DB;
3135     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3136         return;
3137     }
3139     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3140         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3141         $DB->update_record('user_preferences', $pref);
3142     }
3143     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3144         // make a new one
3145         $pref = new stdClass();
3146         $pref->name   = 'email_send_count';
3147         $pref->value  = 1;
3148         $pref->userid = $user->id;
3149         $DB->insert_record('user_preferences', $pref, false);
3150     }
3153 /**
3154  * Increment or reset user's email bounce count
3155  *
3156  * @global object
3157  * @param user $user object containing an id
3158  * @param bool $reset will reset the count to 0
3159  */
3160 function set_bounce_count($user,$reset=false) {
3161     global $DB;
3163     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3164         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3165         $DB->update_record('user_preferences', $pref);
3166     }
3167     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3168         // make a new one
3169         $pref = new stdClass();
3170         $pref->name   = 'email_bounce_count';
3171         $pref->value  = 1;
3172         $pref->userid = $user->id;
3173         $DB->insert_record('user_preferences', $pref, false);
3174     }
3177 /**
3178  * Keeps track of login attempts
3179  *
3180  * @global object
3181  */
3182 function update_login_count() {
3183     global $SESSION;
3185     $max_logins = 10;
3187     if (empty($SESSION->logincount)) {
3188         $SESSION->logincount = 1;
3189     } else {
3190         $SESSION->logincount++;
3191     }
3193     if ($SESSION->logincount > $max_logins) {
3194         unset($SESSION->wantsurl);
3195         print_error('errortoomanylogins');
3196     }
3199 /**
3200  * Resets login attempts
3201  *
3202  * @global object
3203  */
3204 function reset_login_count() {
3205     global $SESSION;
3207     $SESSION->logincount = 0;
3210 /**
3211  * Determines if the currently logged in user is in editing mode.
3212  * Note: originally this function had $userid parameter - it was not usable anyway
3213  *
3214  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3215  * @todo Deprecated function remove when ready
3216  *
3217  * @global object
3218  * @uses DEBUG_DEVELOPER
3219  * @return bool
3220  */
3221 function isediting() {
3222     global $PAGE;
3223     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3224     return $PAGE->user_is_editing();
3227 /**
3228  * Determines if the logged in user is currently moving an activity
3229  *
3230  * @global object
3231  * @param int $courseid The id of the course being tested
3232  * @return bool
3233  */
3234 function ismoving($courseid) {
3235     global $USER;
3237     if (!empty($USER->activitycopy)) {
3238         return ($USER->activitycopycourse == $courseid);
3239     }
3240     return false;
3243 /**
3244  * Returns a persons full name
3245  *
3246  * Given an object containing firstname and lastname
3247  * values, this function returns a string with the
3248  * full name of the person.
3249  * The result may depend on system settings
3250  * or language.  'override' will force both names
3251  * to be used even if system settings specify one.
3252  *
3253  * @global object
3254  * @global object
3255  * @param object $user A {@link $USER} object to get full name of
3256  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3257  * @return string
3258  */
3259 function fullname($user, $override=false) {
3260     global $CFG, $SESSION;
3262     if (!isset($user->firstname) and !isset($user->lastname)) {
3263         return '';
3264     }
3266     if (!$override) {
3267         if (!empty($CFG->forcefirstname)) {
3268             $user->firstname = $CFG->forcefirstname;
3269         }
3270         if (!empty($CFG->forcelastname)) {
3271             $user->lastname = $CFG->forcelastname;
3272         }
3273     }
3275     if (!empty($SESSION->fullnamedisplay)) {
3276         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3277     }
3279     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3280         return $user->firstname .' '. $user->lastname;
3282     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3283         return $user->lastname .' '. $user->firstname;
3285     } else if ($CFG->fullnamedisplay == 'firstname') {
3286         if ($override) {
3287             return get_string('fullnamedisplay', '', $user);
3288         } else {
3289             return $user->firstname;
3290         }
3291     }
3293     return get_string('fullnamedisplay', '', $user);
3296 /**
3297  * Returns whether a given authentication plugin exists.
3298  *
3299  * @global object
3300  * @param string $auth Form of authentication to check for. Defaults to the
3301  *        global setting in {@link $CFG}.
3302  * @return boolean Whether the plugin is available.
3303  */
3304 function exists_auth_plugin($auth) {
3305     global $CFG;
3307     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3308         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3309     }
3310     return false;
3313 /**
3314  * Checks if a given plugin is in the list of enabled authentication plugins.
3315  *
3316  * @param string $auth Authentication plugin.
3317  * @return boolean Whether the plugin is enabled.
3318  */
3319 function is_enabled_auth($auth) {
3320     if (empty($auth)) {
3321         return false;
3322     }
3324     $enabled = get_enabled_auth_plugins();
3326     return in_array($auth, $enabled);
3329 /**
3330  * Returns an authentication plugin instance.
3331  *
3332  * @global object
3333  * @param string $auth name of authentication plugin
3334  * @return auth_plugin_base An instance of the required authentication plugin.
3335  */
3336 function get_auth_plugin($auth) {
3337     global $CFG;
3339     // check the plugin exists first
3340     if (! exists_auth_plugin($auth)) {
3341         print_error('authpluginnotfound', 'debug', '', $auth);
3342     }
3344     // return auth plugin instance
3345     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3346     $class = "auth_plugin_$auth";
3347     return new $class;
3350 /**
3351  * Returns array of active auth plugins.
3352  *
3353  * @param bool $fix fix $CFG->auth if needed
3354  * @return array
3355  */
3356 function get_enabled_auth_plugins($fix=false) {
3357     global $CFG;
3359     $default = array('manual', 'nologin');
3361     if (empty($CFG->auth)) {
3362         $auths = array();
3363     } else {
3364         $auths = explode(',', $CFG->auth);
3365     }
3367     if ($fix) {
3368         $auths = array_unique($auths);
3369         foreach($auths as $k=>$authname) {
3370             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3371                 unset($auths[$k]);
3372             }
3373         }
3374         $newconfig = implode(',', $auths);
3375         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3376             set_config('auth', $newconfig);
3377         }
3378     }
3380     return (array_merge($default, $auths));
3383 /**
3384  * Returns true if an internal authentication method is being used.
3385  * if method not specified then, global default is assumed
3386  *
3387  * @param string $auth Form of authentication required
3388  * @return bool
3389  */
3390 function is_internal_auth($auth) {
3391     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3392     return $authplugin->is_internal();
3395 /**
3396  * Returns true if the user is a 'restored' one
3397  *
3398  * Used in the login process to inform the user
3399  * and allow him/her to reset the password
3400  *
3401  * @uses $CFG
3402  * @uses $DB
3403  * @param string $username username to be checked
3404  * @return bool
3405  */
3406 function is_restored_user($username) {
3407     global $CFG, $DB;
3409     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3412 /**
3413  * Returns an array of user fields
3414  *
3415  * @return array User field/column names
3416  */
3417 function get_user_fieldnames() {
3418     global $DB;
3420     $fieldarray = $DB->get_columns('user');
3421     unset($fieldarray['id']);
3422     $fieldarray = array_keys($fieldarray);
3424     return $fieldarray;
3427 /**
3428  * Creates a bare-bones user record
3429  *
3430  * @todo Outline auth types and provide code example
3431  *
3432  * @param string $username New user's username to add to record
3433  * @param string $password New user's password to add to record
3434  * @param string $auth Form of authentication required
3435  * @return stdClass A complete user object
3436  */
3437 function create_user_record($username, $password, $auth = 'manual') {
3438     global $CFG, $DB;
3440     //just in case check text case
3441     $username = trim(moodle_strtolower($username));
3443     $authplugin = get_auth_plugin($auth);
3445     $newuser = new stdClass();
3447     if ($newinfo = $authplugin->get_userinfo($username)) {
3448         $newinfo = truncate_userinfo($newinfo);
3449         foreach ($newinfo as $key => $value){
3450             $newuser->$key = $value;
3451         }
3452     }
3454     if (!empty($newuser->email)) {
3455         if (email_is_not_allowed($newuser->email)) {
3456             unset($newuser->email);
3457         }
3458     }
3460     if (!isset($newuser->city)) {
3461         $newuser->city = '';
3462     }
3464     $newuser->auth = $auth;
3465     $newuser->username = $username;
3467     // fix for MDL-8480
3468     // user CFG lang for user if $newuser->lang is empty
3469     // or $user->lang is not an installed language
3470     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3471         $newuser->lang = $CFG->lang;
3472     }
3473     $newuser->confirmed = 1;
3474     $newuser->lastip = getremoteaddr();
3475     $newuser->timemodified = time();
3476     $newuser->mnethostid = $CFG->mnet_localhost_id;
3478     $newuser->id = $DB->insert_record('user', $newuser);
3479     $user = get_complete_user_data('id', $newuser->id);
3480     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3481         set_user_preference('auth_forcepasswordchange', 1, $user);
3482     }
3483     update_internal_user_password($user, $password);
3485     // fetch full user record for the event, the complete user data contains too much info
3486     // and we want to be consistent with other places that trigger this event
3487     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3489     return $user;
3492 /**
3493  * Will update a local user record from an external source.
3494  * (MNET users can not be updated using this method!)
3495  *
3496  * @param string $username user's username to update the record
3497  * @return stdClass A complete user object
3498  */
3499 function update_user_record($username) {
3500     global $DB, $CFG;
3502     $username = trim(moodle_strtolower($username)); /// just in case check text case
3504     $oldinfo = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
3505     $newuser = array();
3506     $userauth = get_auth_plugin($oldinfo->auth);
3508     if ($newinfo = $userauth->get_userinfo($username)) {
3509         $newinfo = truncate_userinfo($newinfo);
3510         foreach ($newinfo as $key => $value){
3511             $key = strtolower($key);
3512             if (!property_exists($oldinfo, $key) or $key === 'username' or $key === 'id'
3513                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3514                 // unknown or must not be changed
3515                 continue;
3516             }
3517             $confval = $userauth->config->{'field_updatelocal_' . $key};
3518             $lockval = $userauth->config->{'field_lock_' . $key};
3519             if (empty($confval) || empty($lockval)) {
3520                 continue;
3521             }
3522             if ($confval === 'onlogin') {
3523                 // MDL-4207 Don't overwrite modified user profile values with
3524                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3525                 // of the setting 'unlocked if empty' is to allow the user to fill
3526                 // in a value for the selected field _if LDAP is giving
3527                 // nothing_ for this field. Thus it makes sense to let this value
3528                 // stand in until LDAP is giving a value for this field.
3529                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3530                     if ((string)$oldinfo->$key !== (string)$value) {
3531                         $newuser[$key] = (string)$value;
3532                     }
3533                 }
3534             }
3535         }
3536         if ($newuser) {
3537             $newuser['id'] = $oldinfo->id;
3538             $DB->update_record('user', $newuser);
3539             // fetch full user record for the event, the complete user data contains too much info
3540             // and we want to be consistent with other places that trigger this event
3541             events_trigger('user_updated', $DB->get_record('user', array('id'=>$oldinfo->id)));
3542         }
3543     }
3545     return get_complete_user_data('id', $oldinfo->id);
3548 /**
3549  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3550  * which may have large fields
3551  *
3552  * @todo Add vartype handling to ensure $info is an array
3553  *
3554  * @param array $info Array of user properties to truncate if needed
3555  * @return array The now truncated information that was passed in
3556  */
3557 function truncate_userinfo($info) {
3558     // define the limits
3559     $limit = array(
3560                     'username'    => 100,
3561                     'idnumber'    => 255,
3562                     'firstname'   => 100,
3563                     'lastname'    => 100,
3564                     'email'       => 100,
3565                     'icq'         =>  15,
3566                     'phone1'      =>  20,
3567                     'phone2'      =>  20,
3568                     'institution' =>  40,
3569                     'department'  =>  30,
3570                     'address'     =>  70,
3571                     'city'        => 120,
3572                     'country'     =>   2,
3573                     'url'         => 255,
3574                     );
3576     $textlib = textlib_get_instance();
3577     // apply where needed
3578     foreach (array_keys($info) as $key) {
3579         if (!empty($limit[$key])) {
3580             $info[$key] = trim($textlib->substr($info[$key],0, $limit[$key]));
3581         }
3582     }
3584     return $info;
3587 /**
3588  * Marks user deleted in internal user database and notifies the auth plugin.
3589  * Also unenrols user from all roles and does other cleanup.
3590  *
3591  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3592  *
3593  * @param stdClass $user full user object before delete
3594  * @return boolean always true
3595  */
3596 function delete_user($user) {
3597     global $CFG, $DB;
3598     require_once($CFG->libdir.'/grouplib.php');
3599     require_once($CFG->libdir.'/gradelib.php');
3600     require_once($CFG->dirroot.'/message/lib.php');
3601     require_once($CFG->dirroot.'/tag/lib.php');
3603     // delete all grades - backup is kept in grade_grades_history table
3604     grade_user_delete($user->id);
3606     //move unread messages from this user to read
3607     message_move_userfrom_unread2read($user->id);
3609     // TODO: remove from cohorts using standard API here
3611     // remove user tags
3612     tag_set('user', $user->id, array());
3614     // unconditionally unenrol from all courses
3615     enrol_user_delete($user);
3617     // unenrol from all roles in all contexts
3618     role_unassign_all(array('userid'=>$user->id)); // this might be slow but it is really needed - modules might do some extra cleanup!
3620     //now do a brute force cleanup
3622     // remove from all cohorts
3623     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3625     // remove from all groups
3626     $DB->delete_records('groups_members', array('userid'=>$user->id));
3628     // brute force unenrol from all courses
3629     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3631     // purge user preferences
3632     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3634     // purge user extra profile info
3635     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3637     // last course access not necessary either
3638     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3640     // force logout - may fail if file based sessions used, sorry
3641     session_kill_user($user->id);
3643     // now do a final accesslib cleanup - removes all role assignments in user context and context itself
3644     delete_context(CONTEXT_USER, $user->id);
3646     // workaround for bulk deletes of users with the same email address
3647     $delname = "$user->email.".time();
3648     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3649         $delname++;
3650     }
3652     // mark internal user record as "deleted"
3653     $updateuser = new stdClass();
3654     $updateuser->id           = $user->id;
3655     $updateuser->deleted      = 1;
3656     $updateuser->username     = $delname;            // Remember it just in case
3657     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3658     $updateuser->idnumber     = '';                  // Clear this field to free it up
3659     $updateuser->timemodified = time();
3661     $DB->update_record('user', $updateuser);
3663     // notify auth plugin - do not block the delete even when plugin fails
3664     $authplugin = get_auth_plugin($user->auth);
3665     $authplugin->user_delete($user);
3667     // any plugin that needs to cleanup should register this event
3668     events_trigger('user_deleted', $user);
3670     return true;
3673 /**
3674  * Retrieve the guest user object
3675  *
3676  * @global object
3677  * @global object
3678  * @return user A {@link $USER} object
3679  */
3680 function guest_user() {
3681     global $CFG, $DB;
3683     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
3684         $newuser->confirmed = 1;
3685         $newuser->lang = $CFG->lang;
3686         $newuser->lastip = getremoteaddr();
3687     }
3689     return $newuser;