Merge branch 'MDL-37997-muc-stats-display' of git://github.com/mudrd8mz/moodle
[moodle.git] / lib / moodlelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * moodlelib.php - Moodle main library
19  *
20  * Main library file of miscellaneous general-purpose Moodle functions.
21  * Other main libraries:
22  *  - weblib.php      - functions that produce web output
23  *  - datalib.php     - functions that access the database
24  *
25  * @package    core
26  * @subpackage lib
27  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 defined('MOODLE_INTERNAL') || die();
33 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
35 /// Date and time constants ///
36 /**
37  * Time constant - the number of seconds in a year
38  */
39 define('YEARSECS', 31536000);
41 /**
42  * Time constant - the number of seconds in a week
43  */
44 define('WEEKSECS', 604800);
46 /**
47  * Time constant - the number of seconds in a day
48  */
49 define('DAYSECS', 86400);
51 /**
52  * Time constant - the number of seconds in an hour
53  */
54 define('HOURSECS', 3600);
56 /**
57  * Time constant - the number of seconds in a minute
58  */
59 define('MINSECS', 60);
61 /**
62  * Time constant - the number of minutes in a day
63  */
64 define('DAYMINS', 1440);
66 /**
67  * Time constant - the number of minutes in an hour
68  */
69 define('HOURMINS', 60);
71 /// Parameter constants - every call to optional_param(), required_param()  ///
72 /// or clean_param() should have a specified type of parameter.  //////////////
76 /**
77  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
78  */
79 define('PARAM_ALPHA',    'alpha');
81 /**
82  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
83  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
84  */
85 define('PARAM_ALPHAEXT', 'alphaext');
87 /**
88  * PARAM_ALPHANUM - expected numbers and letters only.
89  */
90 define('PARAM_ALPHANUM', 'alphanum');
92 /**
93  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
94  */
95 define('PARAM_ALPHANUMEXT', 'alphanumext');
97 /**
98  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
99  */
100 define('PARAM_AUTH',  'auth');
102 /**
103  * PARAM_BASE64 - Base 64 encoded format
104  */
105 define('PARAM_BASE64',   'base64');
107 /**
108  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
109  */
110 define('PARAM_BOOL',     'bool');
112 /**
113  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
114  * checked against the list of capabilities in the database.
115  */
116 define('PARAM_CAPABILITY',   'capability');
118 /**
119  * PARAM_CLEANHTML - cleans submitted HTML code. Note that you almost never want
120  * to use this. The normal mode of operation is to use PARAM_RAW when recieving
121  * the input (required/optional_param or formslib) and then sanitse the HTML
122  * using format_text on output. This is for the rare cases when you want to
123  * sanitise the HTML on input. This cleaning may also fix xhtml strictness.
124  */
125 define('PARAM_CLEANHTML', 'cleanhtml');
127 /**
128  * PARAM_EMAIL - an email address following the RFC
129  */
130 define('PARAM_EMAIL',   'email');
132 /**
133  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
134  */
135 define('PARAM_FILE',   'file');
137 /**
138  * PARAM_FLOAT - a real/floating point number.
139  *
140  * Note that you should not use PARAM_FLOAT for numbers typed in by the user.
141  * It does not work for languages that use , as a decimal separator.
142  * Instead, do something like
143  *     $rawvalue = required_param('name', PARAM_RAW);
144  *     // ... other code including require_login, which sets current lang ...
145  *     $realvalue = unformat_float($rawvalue);
146  *     // ... then use $realvalue
147  */
148 define('PARAM_FLOAT',  'float');
150 /**
151  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
152  */
153 define('PARAM_HOST',     'host');
155 /**
156  * PARAM_INT - integers only, use when expecting only numbers.
157  */
158 define('PARAM_INT',      'int');
160 /**
161  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
162  */
163 define('PARAM_LANG',  'lang');
165 /**
166  * 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!)
167  */
168 define('PARAM_LOCALURL', 'localurl');
170 /**
171  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
172  */
173 define('PARAM_NOTAGS',   'notags');
175 /**
176  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
177  * note: the leading slash is not removed, window drive letter is not allowed
178  */
179 define('PARAM_PATH',     'path');
181 /**
182  * PARAM_PEM - Privacy Enhanced Mail format
183  */
184 define('PARAM_PEM',      'pem');
186 /**
187  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
188  */
189 define('PARAM_PERMISSION',   'permission');
191 /**
192  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
193  */
194 define('PARAM_RAW', 'raw');
196 /**
197  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
198  */
199 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
201 /**
202  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
203  */
204 define('PARAM_SAFEDIR',  'safedir');
206 /**
207  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
208  */
209 define('PARAM_SAFEPATH',  'safepath');
211 /**
212  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
213  */
214 define('PARAM_SEQUENCE',  'sequence');
216 /**
217  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
218  */
219 define('PARAM_TAG',   'tag');
221 /**
222  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
223  */
224 define('PARAM_TAGLIST',   'taglist');
226 /**
227  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
228  */
229 define('PARAM_TEXT',  'text');
231 /**
232  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
233  */
234 define('PARAM_THEME',  'theme');
236 /**
237  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
238  */
239 define('PARAM_URL',      'url');
241 /**
242  * 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!!
243  */
244 define('PARAM_USERNAME',    'username');
246 /**
247  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
248  */
249 define('PARAM_STRINGID',    'stringid');
251 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
252 /**
253  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
254  * It was one of the first types, that is why it is abused so much ;-)
255  * @deprecated since 2.0
256  */
257 define('PARAM_CLEAN',    'clean');
259 /**
260  * PARAM_INTEGER - deprecated alias for PARAM_INT
261  * @deprecated since 2.0
262  */
263 define('PARAM_INTEGER',  'int');
265 /**
266  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
267  * @deprecated since 2.0
268  */
269 define('PARAM_NUMBER',  'float');
271 /**
272  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
273  * NOTE: originally alias for PARAM_APLHA
274  * @deprecated since 2.0
275  */
276 define('PARAM_ACTION',   'alphanumext');
278 /**
279  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
280  * NOTE: originally alias for PARAM_APLHA
281  * @deprecated since 2.0
282  */
283 define('PARAM_FORMAT',   'alphanumext');
285 /**
286  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
287  * @deprecated since 2.0
288  */
289 define('PARAM_MULTILANG',  'text');
291 /**
292  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
293  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
294  * America/Port-au-Prince)
295  */
296 define('PARAM_TIMEZONE', 'timezone');
298 /**
299  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
300  */
301 define('PARAM_CLEANFILE', 'file');
303 /**
304  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
305  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
306  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
307  * NOTE: numbers and underscores are strongly discouraged in plugin names!
308  */
309 define('PARAM_COMPONENT', 'component');
311 /**
312  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
313  * It is usually used together with context id and component.
314  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
315  */
316 define('PARAM_AREA', 'area');
318 /**
319  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
320  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
321  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
322  */
323 define('PARAM_PLUGIN', 'plugin');
326 /// Web Services ///
328 /**
329  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
330  */
331 define('VALUE_REQUIRED', 1);
333 /**
334  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
335  */
336 define('VALUE_OPTIONAL', 2);
338 /**
339  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
340  */
341 define('VALUE_DEFAULT', 0);
343 /**
344  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
345  */
346 define('NULL_NOT_ALLOWED', false);
348 /**
349  * NULL_ALLOWED - the parameter can be set to null in the database
350  */
351 define('NULL_ALLOWED', true);
353 /// Page types ///
354 /**
355  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
356  */
357 define('PAGE_COURSE_VIEW', 'course-view');
359 /** Get remote addr constant */
360 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
361 /** Get remote addr constant */
362 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
364 /// Blog access level constant declaration ///
365 define ('BLOG_USER_LEVEL', 1);
366 define ('BLOG_GROUP_LEVEL', 2);
367 define ('BLOG_COURSE_LEVEL', 3);
368 define ('BLOG_SITE_LEVEL', 4);
369 define ('BLOG_GLOBAL_LEVEL', 5);
372 ///Tag constants///
373 /**
374  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
375  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
376  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
377  *
378  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
379  */
380 define('TAG_MAX_LENGTH', 50);
382 /// Password policy constants ///
383 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
384 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
385 define ('PASSWORD_DIGITS', '0123456789');
386 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
388 /// Feature constants ///
389 // Used for plugin_supports() to report features that are, or are not, supported by a module.
391 /** True if module can provide a grade */
392 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
393 /** True if module supports outcomes */
394 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
395 /** True if module supports advanced grading methods */
396 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
397 /** True if module controls the grade visibility over the gradebook */
398 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
399 /** True if module supports plagiarism plugins */
400 define('FEATURE_PLAGIARISM', 'plagiarism');
402 /** True if module has code to track whether somebody viewed it */
403 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
404 /** True if module has custom completion rules */
405 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
407 /** True if module has no 'view' page (like label) */
408 define('FEATURE_NO_VIEW_LINK', 'viewlink');
409 /** True if module supports outcomes */
410 define('FEATURE_IDNUMBER', 'idnumber');
411 /** True if module supports groups */
412 define('FEATURE_GROUPS', 'groups');
413 /** True if module supports groupings */
414 define('FEATURE_GROUPINGS', 'groupings');
415 /** True if module supports groupmembersonly */
416 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
418 /** Type of module */
419 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
420 /** True if module supports intro editor */
421 define('FEATURE_MOD_INTRO', 'mod_intro');
422 /** True if module has default completion */
423 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
425 define('FEATURE_COMMENT', 'comment');
427 define('FEATURE_RATE', 'rate');
428 /** True if module supports backup/restore of moodle2 format */
429 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
431 /** True if module can show description on course main page */
432 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
434 /** Unspecified module archetype */
435 define('MOD_ARCHETYPE_OTHER', 0);
436 /** Resource-like type module */
437 define('MOD_ARCHETYPE_RESOURCE', 1);
438 /** Assignment module archetype */
439 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
440 /** System (not user-addable) module archetype */
441 define('MOD_ARCHETYPE_SYSTEM', 3);
443 /**
444  * Security token used for allowing access
445  * from external application such as web services.
446  * Scripts do not use any session, performance is relatively
447  * low because we need to load access info in each request.
448  * Scripts are executed in parallel.
449  */
450 define('EXTERNAL_TOKEN_PERMANENT', 0);
452 /**
453  * Security token used for allowing access
454  * of embedded applications, the code is executed in the
455  * active user session. Token is invalidated after user logs out.
456  * Scripts are executed serially - normal session locking is used.
457  */
458 define('EXTERNAL_TOKEN_EMBEDDED', 1);
460 /**
461  * The home page should be the site home
462  */
463 define('HOMEPAGE_SITE', 0);
464 /**
465  * The home page should be the users my page
466  */
467 define('HOMEPAGE_MY', 1);
468 /**
469  * The home page can be chosen by the user
470  */
471 define('HOMEPAGE_USER', 2);
473 /**
474  * Hub directory url (should be moodle.org)
475  */
476 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
479 /**
480  * Moodle.org url (should be moodle.org)
481  */
482 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
484 /**
485  * Moodle mobile app service name
486  */
487 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
489 /**
490  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
491  */
492 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
494 /**
495  * Course display settings
496  */
497 define('COURSE_DISPLAY_SINGLEPAGE', 0); // display all sections on one page
498 define('COURSE_DISPLAY_MULTIPAGE', 1); // split pages into a page per section
500 /**
501  * Authentication constants.
502  */
503 define('AUTH_PASSWORD_NOT_CACHED', 'not cached'); // String used in password field when password is not stored.
505 /// PARAMETER HANDLING ////////////////////////////////////////////////////
507 /**
508  * Returns a particular value for the named variable, taken from
509  * POST or GET.  If the parameter doesn't exist then an error is
510  * thrown because we require this variable.
511  *
512  * This function should be used to initialise all required values
513  * in a script that are based on parameters.  Usually it will be
514  * used like this:
515  *    $id = required_param('id', PARAM_INT);
516  *
517  * Please note the $type parameter is now required and the value can not be array.
518  *
519  * @param string $parname the name of the page parameter we want
520  * @param string $type expected type of parameter
521  * @return mixed
522  */
523 function required_param($parname, $type) {
524     if (func_num_args() != 2 or empty($parname) or empty($type)) {
525         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
526     }
527     if (isset($_POST[$parname])) {       // POST has precedence
528         $param = $_POST[$parname];
529     } else if (isset($_GET[$parname])) {
530         $param = $_GET[$parname];
531     } else {
532         print_error('missingparam', '', '', $parname);
533     }
535     if (is_array($param)) {
536         debugging('Invalid array parameter detected in required_param(): '.$parname);
537         // TODO: switch to fatal error in Moodle 2.3
538         //print_error('missingparam', '', '', $parname);
539         return required_param_array($parname, $type);
540     }
542     return clean_param($param, $type);
545 /**
546  * Returns a particular array value for the named variable, taken from
547  * POST or GET.  If the parameter doesn't exist then an error is
548  * thrown because we require this variable.
549  *
550  * This function should be used to initialise all required values
551  * in a script that are based on parameters.  Usually it will be
552  * used like this:
553  *    $ids = required_param_array('ids', PARAM_INT);
554  *
555  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
556  *
557  * @param string $parname the name of the page parameter we want
558  * @param string $type expected type of parameter
559  * @return array
560  */
561 function required_param_array($parname, $type) {
562     if (func_num_args() != 2 or empty($parname) or empty($type)) {
563         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
564     }
565     if (isset($_POST[$parname])) {       // POST has precedence
566         $param = $_POST[$parname];
567     } else if (isset($_GET[$parname])) {
568         $param = $_GET[$parname];
569     } else {
570         print_error('missingparam', '', '', $parname);
571     }
572     if (!is_array($param)) {
573         print_error('missingparam', '', '', $parname);
574     }
576     $result = array();
577     foreach($param as $key=>$value) {
578         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
579             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
580             continue;
581         }
582         $result[$key] = clean_param($value, $type);
583     }
585     return $result;
588 /**
589  * Returns a particular value for the named variable, taken from
590  * POST or GET, otherwise returning a given default.
591  *
592  * This function should be used to initialise all optional values
593  * in a script that are based on parameters.  Usually it will be
594  * used like this:
595  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
596  *
597  * Please note the $type parameter is now required and the value can not be array.
598  *
599  * @param string $parname the name of the page parameter we want
600  * @param mixed  $default the default value to return if nothing is found
601  * @param string $type expected type of parameter
602  * @return mixed
603  */
604 function optional_param($parname, $default, $type) {
605     if (func_num_args() != 3 or empty($parname) or empty($type)) {
606         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
607     }
608     if (!isset($default)) {
609         $default = null;
610     }
612     if (isset($_POST[$parname])) {       // POST has precedence
613         $param = $_POST[$parname];
614     } else if (isset($_GET[$parname])) {
615         $param = $_GET[$parname];
616     } else {
617         return $default;
618     }
620     if (is_array($param)) {
621         debugging('Invalid array parameter detected in required_param(): '.$parname);
622         // TODO: switch to $default in Moodle 2.3
623         //return $default;
624         return optional_param_array($parname, $default, $type);
625     }
627     return clean_param($param, $type);
630 /**
631  * Returns a particular array value for the named variable, taken from
632  * POST or GET, otherwise returning a given default.
633  *
634  * This function should be used to initialise all optional values
635  * in a script that are based on parameters.  Usually it will be
636  * used like this:
637  *    $ids = optional_param('id', array(), PARAM_INT);
638  *
639  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
640  *
641  * @param string $parname the name of the page parameter we want
642  * @param mixed  $default the default value to return if nothing is found
643  * @param string $type expected type of parameter
644  * @return array
645  */
646 function optional_param_array($parname, $default, $type) {
647     if (func_num_args() != 3 or empty($parname) or empty($type)) {
648         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
649     }
651     if (isset($_POST[$parname])) {       // POST has precedence
652         $param = $_POST[$parname];
653     } else if (isset($_GET[$parname])) {
654         $param = $_GET[$parname];
655     } else {
656         return $default;
657     }
658     if (!is_array($param)) {
659         debugging('optional_param_array() expects array parameters only: '.$parname);
660         return $default;
661     }
663     $result = array();
664     foreach($param as $key=>$value) {
665         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
666             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
667             continue;
668         }
669         $result[$key] = clean_param($value, $type);
670     }
672     return $result;
675 /**
676  * Strict validation of parameter values, the values are only converted
677  * to requested PHP type. Internally it is using clean_param, the values
678  * before and after cleaning must be equal - otherwise
679  * an invalid_parameter_exception is thrown.
680  * Objects and classes are not accepted.
681  *
682  * @param mixed $param
683  * @param string $type PARAM_ constant
684  * @param bool $allownull are nulls valid value?
685  * @param string $debuginfo optional debug information
686  * @return mixed the $param value converted to PHP type
687  * @throws invalid_parameter_exception if $param is not of given type
688  */
689 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
690     if (is_null($param)) {
691         if ($allownull == NULL_ALLOWED) {
692             return null;
693         } else {
694             throw new invalid_parameter_exception($debuginfo);
695         }
696     }
697     if (is_array($param) or is_object($param)) {
698         throw new invalid_parameter_exception($debuginfo);
699     }
701     $cleaned = clean_param($param, $type);
703     if ($type == PARAM_FLOAT) {
704         // Do not detect precision loss here.
705         if (is_float($param) or is_int($param)) {
706             // These always fit.
707         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
708             throw new invalid_parameter_exception($debuginfo);
709         }
710     } else if ((string)$param !== (string)$cleaned) {
711         // conversion to string is usually lossless
712         throw new invalid_parameter_exception($debuginfo);
713     }
715     return $cleaned;
718 /**
719  * Makes sure array contains only the allowed types,
720  * this function does not validate array key names!
721  * <code>
722  * $options = clean_param($options, PARAM_INT);
723  * </code>
724  *
725  * @param array $param the variable array we are cleaning
726  * @param string $type expected format of param after cleaning.
727  * @param bool $recursive clean recursive arrays
728  * @return array
729  */
730 function clean_param_array(array $param = null, $type, $recursive = false) {
731     $param = (array)$param; // convert null to empty array
732     foreach ($param as $key => $value) {
733         if (is_array($value)) {
734             if ($recursive) {
735                 $param[$key] = clean_param_array($value, $type, true);
736             } else {
737                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
738             }
739         } else {
740             $param[$key] = clean_param($value, $type);
741         }
742     }
743     return $param;
746 /**
747  * Used by {@link optional_param()} and {@link required_param()} to
748  * clean the variables and/or cast to specific types, based on
749  * an options field.
750  * <code>
751  * $course->format = clean_param($course->format, PARAM_ALPHA);
752  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
753  * </code>
754  *
755  * @param mixed $param the variable we are cleaning
756  * @param string $type expected format of param after cleaning.
757  * @return mixed
758  */
759 function clean_param($param, $type) {
761     global $CFG;
763     if (is_array($param)) {
764         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
765     } else if (is_object($param)) {
766         if (method_exists($param, '__toString')) {
767             $param = $param->__toString();
768         } else {
769             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
770         }
771     }
773     switch ($type) {
774         case PARAM_RAW:          // no cleaning at all
775             $param = fix_utf8($param);
776             return $param;
778         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
779             $param = fix_utf8($param);
780             return trim($param);
782         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
783             // this is deprecated!, please use more specific type instead
784             if (is_numeric($param)) {
785                 return $param;
786             }
787             $param = fix_utf8($param);
788             return clean_text($param);     // Sweep for scripts, etc
790         case PARAM_CLEANHTML:    // clean html fragment
791             $param = fix_utf8($param);
792             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
793             return trim($param);
795         case PARAM_INT:
796             return (int)$param;  // Convert to integer
798         case PARAM_FLOAT:
799             return (float)$param;  // Convert to float
801         case PARAM_ALPHA:        // Remove everything not a-z
802             return preg_replace('/[^a-zA-Z]/i', '', $param);
804         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
805             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
807         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
808             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
810         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
811             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
813         case PARAM_SEQUENCE:     // Remove everything not 0-9,
814             return preg_replace('/[^0-9,]/i', '', $param);
816         case PARAM_BOOL:         // Convert to 1 or 0
817             $tempstr = strtolower($param);
818             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
819                 $param = 1;
820             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
821                 $param = 0;
822             } else {
823                 $param = empty($param) ? 0 : 1;
824             }
825             return $param;
827         case PARAM_NOTAGS:       // Strip all tags
828             $param = fix_utf8($param);
829             return strip_tags($param);
831         case PARAM_TEXT:    // leave only tags needed for multilang
832             $param = fix_utf8($param);
833             // if the multilang syntax is not correct we strip all tags
834             // because it would break xhtml strict which is required for accessibility standards
835             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
836             do {
837                 if (strpos($param, '</lang>') !== false) {
838                     // old and future mutilang syntax
839                     $param = strip_tags($param, '<lang>');
840                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
841                         break;
842                     }
843                     $open = false;
844                     foreach ($matches[0] as $match) {
845                         if ($match === '</lang>') {
846                             if ($open) {
847                                 $open = false;
848                                 continue;
849                             } else {
850                                 break 2;
851                             }
852                         }
853                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
854                             break 2;
855                         } else {
856                             $open = true;
857                         }
858                     }
859                     if ($open) {
860                         break;
861                     }
862                     return $param;
864                 } else if (strpos($param, '</span>') !== false) {
865                     // current problematic multilang syntax
866                     $param = strip_tags($param, '<span>');
867                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
868                         break;
869                     }
870                     $open = false;
871                     foreach ($matches[0] as $match) {
872                         if ($match === '</span>') {
873                             if ($open) {
874                                 $open = false;
875                                 continue;
876                             } else {
877                                 break 2;
878                             }
879                         }
880                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
881                             break 2;
882                         } else {
883                             $open = true;
884                         }
885                     }
886                     if ($open) {
887                         break;
888                     }
889                     return $param;
890                 }
891             } while (false);
892             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
893             return strip_tags($param);
895         case PARAM_COMPONENT:
896             // we do not want any guessing here, either the name is correct or not
897             // please note only normalised component names are accepted
898             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
899                 return '';
900             }
901             if (strpos($param, '__') !== false) {
902                 return '';
903             }
904             if (strpos($param, 'mod_') === 0) {
905                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
906                 if (substr_count($param, '_') != 1) {
907                     return '';
908                 }
909             }
910             return $param;
912         case PARAM_PLUGIN:
913         case PARAM_AREA:
914             // we do not want any guessing here, either the name is correct or not
915             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
916                 return '';
917             }
918             if (strpos($param, '__') !== false) {
919                 return '';
920             }
921             return $param;
923         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
924             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
926         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
927             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
929         case PARAM_FILE:         // Strip all suspicious characters from filename
930             $param = fix_utf8($param);
931             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
932             if ($param === '.' || $param === '..') {
933                 $param = '';
934             }
935             return $param;
937         case PARAM_PATH:         // Strip all suspicious characters from file path
938             $param = fix_utf8($param);
939             $param = str_replace('\\', '/', $param);
941             // Explode the path and clean each element using the PARAM_FILE rules.
942             $breadcrumb = explode('/', $param);
943             foreach ($breadcrumb as $key => $crumb) {
944                 if ($crumb === '.' && $key === 0) {
945                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
946                 } else {
947                     $crumb = clean_param($crumb, PARAM_FILE);
948                 }
949                 $breadcrumb[$key] = $crumb;
950             }
951             $param = implode('/', $breadcrumb);
953             // Remove multiple current path (./././) and multiple slashes (///).
954             $param = preg_replace('~//+~', '/', $param);
955             $param = preg_replace('~/(\./)+~', '/', $param);
956             return $param;
958         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
959             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
960             // match ipv4 dotted quad
961             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
962                 // confirm values are ok
963                 if ( $match[0] > 255
964                      || $match[1] > 255
965                      || $match[3] > 255
966                      || $match[4] > 255 ) {
967                     // hmmm, what kind of dotted quad is this?
968                     $param = '';
969                 }
970             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
971                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
972                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
973                        ) {
974                 // all is ok - $param is respected
975             } else {
976                 // all is not ok...
977                 $param='';
978             }
979             return $param;
981         case PARAM_URL:          // allow safe ftp, http, mailto urls
982             $param = fix_utf8($param);
983             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
984             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
985                 // all is ok, param is respected
986             } else {
987                 $param =''; // not really ok
988             }
989             return $param;
991         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
992             $param = clean_param($param, PARAM_URL);
993             if (!empty($param)) {
994                 if (preg_match(':^/:', $param)) {
995                     // root-relative, ok!
996                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
997                     // absolute, and matches our wwwroot
998                 } else {
999                     // relative - let's make sure there are no tricks
1000                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1001                         // looks ok.
1002                     } else {
1003                         $param = '';
1004                     }
1005                 }
1006             }
1007             return $param;
1009         case PARAM_PEM:
1010             $param = trim($param);
1011             // PEM formatted strings may contain letters/numbers and the symbols
1012             // forward slash: /
1013             // plus sign:     +
1014             // equal sign:    =
1015             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
1016             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1017                 list($wholething, $body) = $matches;
1018                 unset($wholething, $matches);
1019                 $b64 = clean_param($body, PARAM_BASE64);
1020                 if (!empty($b64)) {
1021                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1022                 } else {
1023                     return '';
1024                 }
1025             }
1026             return '';
1028         case PARAM_BASE64:
1029             if (!empty($param)) {
1030                 // PEM formatted strings may contain letters/numbers and the symbols
1031                 // forward slash: /
1032                 // plus sign:     +
1033                 // equal sign:    =
1034                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1035                     return '';
1036                 }
1037                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1038                 // Each line of base64 encoded data must be 64 characters in
1039                 // length, except for the last line which may be less than (or
1040                 // equal to) 64 characters long.
1041                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1042                     if ($i + 1 == $j) {
1043                         if (64 < strlen($lines[$i])) {
1044                             return '';
1045                         }
1046                         continue;
1047                     }
1049                     if (64 != strlen($lines[$i])) {
1050                         return '';
1051                     }
1052                 }
1053                 return implode("\n",$lines);
1054             } else {
1055                 return '';
1056             }
1058         case PARAM_TAG:
1059             $param = fix_utf8($param);
1060             // Please note it is not safe to use the tag name directly anywhere,
1061             // it must be processed with s(), urlencode() before embedding anywhere.
1062             // remove some nasties
1063             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1064             //convert many whitespace chars into one
1065             $param = preg_replace('/\s+/', ' ', $param);
1066             $param = textlib::substr(trim($param), 0, TAG_MAX_LENGTH);
1067             return $param;
1069         case PARAM_TAGLIST:
1070             $param = fix_utf8($param);
1071             $tags = explode(',', $param);
1072             $result = array();
1073             foreach ($tags as $tag) {
1074                 $res = clean_param($tag, PARAM_TAG);
1075                 if ($res !== '') {
1076                     $result[] = $res;
1077                 }
1078             }
1079             if ($result) {
1080                 return implode(',', $result);
1081             } else {
1082                 return '';
1083             }
1085         case PARAM_CAPABILITY:
1086             if (get_capability_info($param)) {
1087                 return $param;
1088             } else {
1089                 return '';
1090             }
1092         case PARAM_PERMISSION:
1093             $param = (int)$param;
1094             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1095                 return $param;
1096             } else {
1097                 return CAP_INHERIT;
1098             }
1100         case PARAM_AUTH:
1101             $param = clean_param($param, PARAM_PLUGIN);
1102             if (empty($param)) {
1103                 return '';
1104             } else if (exists_auth_plugin($param)) {
1105                 return $param;
1106             } else {
1107                 return '';
1108             }
1110         case PARAM_LANG:
1111             $param = clean_param($param, PARAM_SAFEDIR);
1112             if (get_string_manager()->translation_exists($param)) {
1113                 return $param;
1114             } else {
1115                 return ''; // Specified language is not installed or param malformed
1116             }
1118         case PARAM_THEME:
1119             $param = clean_param($param, PARAM_PLUGIN);
1120             if (empty($param)) {
1121                 return '';
1122             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1123                 return $param;
1124             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1125                 return $param;
1126             } else {
1127                 return '';  // Specified theme is not installed
1128             }
1130         case PARAM_USERNAME:
1131             $param = fix_utf8($param);
1132             $param = str_replace(" " , "", $param);
1133             $param = textlib::strtolower($param);  // Convert uppercase to lowercase MDL-16919
1134             if (empty($CFG->extendedusernamechars)) {
1135                 // regular expression, eliminate all chars EXCEPT:
1136                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1137                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1138             }
1139             return $param;
1141         case PARAM_EMAIL:
1142             $param = fix_utf8($param);
1143             if (validate_email($param)) {
1144                 return $param;
1145             } else {
1146                 return '';
1147             }
1149         case PARAM_STRINGID:
1150             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1151                 return $param;
1152             } else {
1153                 return '';
1154             }
1156         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1157             $param = fix_utf8($param);
1158             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1159             if (preg_match($timezonepattern, $param)) {
1160                 return $param;
1161             } else {
1162                 return '';
1163             }
1165         default:                 // throw error, switched parameters in optional_param or another serious problem
1166             print_error("unknownparamtype", '', '', $type);
1167     }
1170 /**
1171  * Makes sure the data is using valid utf8, invalid characters are discarded.
1172  *
1173  * Note: this function is not intended for full objects with methods and private properties.
1174  *
1175  * @param mixed $value
1176  * @return mixed with proper utf-8 encoding
1177  */
1178 function fix_utf8($value) {
1179     if (is_null($value) or $value === '') {
1180         return $value;
1182     } else if (is_string($value)) {
1183         if ((string)(int)$value === $value) {
1184             // shortcut
1185             return $value;
1186         }
1188         // Lower error reporting because glibc throws bogus notices.
1189         $olderror = error_reporting();
1190         if ($olderror & E_NOTICE) {
1191             error_reporting($olderror ^ E_NOTICE);
1192         }
1194         // Note: this duplicates min_fix_utf8() intentionally.
1195         static $buggyiconv = null;
1196         if ($buggyiconv === null) {
1197             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1198         }
1200         if ($buggyiconv) {
1201             if (function_exists('mb_convert_encoding')) {
1202                 $subst = mb_substitute_character();
1203                 mb_substitute_character('');
1204                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1205                 mb_substitute_character($subst);
1207             } else {
1208                 // Warn admins on admin/index.php page.
1209                 $result = $value;
1210             }
1212         } else {
1213             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1214         }
1216         if ($olderror & E_NOTICE) {
1217             error_reporting($olderror);
1218         }
1220         return $result;
1222     } else if (is_array($value)) {
1223         foreach ($value as $k=>$v) {
1224             $value[$k] = fix_utf8($v);
1225         }
1226         return $value;
1228     } else if (is_object($value)) {
1229         $value = clone($value); // do not modify original
1230         foreach ($value as $k=>$v) {
1231             $value->$k = fix_utf8($v);
1232         }
1233         return $value;
1235     } else {
1236         // this is some other type, no utf-8 here
1237         return $value;
1238     }
1241 /**
1242  * Return true if given value is integer or string with integer value
1243  *
1244  * @param mixed $value String or Int
1245  * @return bool true if number, false if not
1246  */
1247 function is_number($value) {
1248     if (is_int($value)) {
1249         return true;
1250     } else if (is_string($value)) {
1251         return ((string)(int)$value) === $value;
1252     } else {
1253         return false;
1254     }
1257 /**
1258  * Returns host part from url
1259  * @param string $url full url
1260  * @return string host, null if not found
1261  */
1262 function get_host_from_url($url) {
1263     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1264     if ($matches) {
1265         return $matches[1];
1266     }
1267     return null;
1270 /**
1271  * Tests whether anything was returned by text editor
1272  *
1273  * This function is useful for testing whether something you got back from
1274  * the HTML editor actually contains anything. Sometimes the HTML editor
1275  * appear to be empty, but actually you get back a <br> tag or something.
1276  *
1277  * @param string $string a string containing HTML.
1278  * @return boolean does the string contain any actual content - that is text,
1279  * images, objects, etc.
1280  */
1281 function html_is_blank($string) {
1282     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1285 /**
1286  * Set a key in global configuration
1287  *
1288  * Set a key/value pair in both this session's {@link $CFG} global variable
1289  * and in the 'config' database table for future sessions.
1290  *
1291  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1292  * In that case it doesn't affect $CFG.
1293  *
1294  * A NULL value will delete the entry.
1295  *
1296  * @global object
1297  * @global object
1298  * @param string $name the key to set
1299  * @param string $value the value to set (without magic quotes)
1300  * @param string $plugin (optional) the plugin scope, default NULL
1301  * @return bool true or exception
1302  */
1303 function set_config($name, $value, $plugin=NULL) {
1304     global $CFG, $DB;
1306     if (empty($plugin)) {
1307         if (!array_key_exists($name, $CFG->config_php_settings)) {
1308             // So it's defined for this invocation at least
1309             if (is_null($value)) {
1310                 unset($CFG->$name);
1311             } else {
1312                 $CFG->$name = (string)$value; // settings from db are always strings
1313             }
1314         }
1316         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1317             if ($value === null) {
1318                 $DB->delete_records('config', array('name'=>$name));
1319             } else {
1320                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1321             }
1322         } else {
1323             if ($value !== null) {
1324                 $config = new stdClass();
1325                 $config->name  = $name;
1326                 $config->value = $value;
1327                 $DB->insert_record('config', $config, false);
1328             }
1329         }
1330         if ($name === 'siteidentifier') {
1331             cache_helper::update_site_identifier($value);
1332         }
1333         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1334     } else { // plugin scope
1335         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1336             if ($value===null) {
1337                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1338             } else {
1339                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1340             }
1341         } else {
1342             if ($value !== null) {
1343                 $config = new stdClass();
1344                 $config->plugin = $plugin;
1345                 $config->name   = $name;
1346                 $config->value  = $value;
1347                 $DB->insert_record('config_plugins', $config, false);
1348             }
1349         }
1350         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1351     }
1353     return true;
1356 /**
1357  * Get configuration values from the global config table
1358  * or the config_plugins table.
1359  *
1360  * If called with one parameter, it will load all the config
1361  * variables for one plugin, and return them as an object.
1362  *
1363  * If called with 2 parameters it will return a string single
1364  * value or false if the value is not found.
1365  *
1366  * @static $siteidentifier The site identifier is not cached. We use this static cache so
1367  *     that we need only fetch it once per request.
1368  * @param string $plugin full component name
1369  * @param string $name default NULL
1370  * @return mixed hash-like object or single value, return false no config found
1371  */
1372 function get_config($plugin, $name = NULL) {
1373     global $CFG, $DB;
1375     static $siteidentifier = null;
1377     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1378         $forced =& $CFG->config_php_settings;
1379         $iscore = true;
1380         $plugin = 'core';
1381     } else {
1382         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1383             $forced =& $CFG->forced_plugin_settings[$plugin];
1384         } else {
1385             $forced = array();
1386         }
1387         $iscore = false;
1388     }
1390     if ($siteidentifier === null) {
1391         try {
1392             // This may fail during installation.
1393             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1394             // install the database.
1395             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1396         } catch (dml_exception $ex) {
1397             // It's failed. We'll use this opportunity to disable cache stores so that we don't inadvertingly start using
1398             // old caches. People should delete their moodledata dirs when reinstalling the database... but they don't.
1399             cache_factory::disable_stores();
1400             // Set siteidentifier to false. We don't want to trip this continually.
1401             $siteidentifier = false;
1402             throw $ex;
1403         }
1404     }
1406     if (!empty($name)) {
1407         if (array_key_exists($name, $forced)) {
1408             return (string)$forced[$name];
1409         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1410             return $siteidentifier;
1411         }
1412     }
1414     $cache = cache::make('core', 'config');
1415     $result = $cache->get($plugin);
1416     if (!$result) {
1417         // the user is after a recordset
1418         $result = new stdClass;
1419         if (!$iscore) {
1420             $result = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1421         } else {
1422             // this part is not really used any more, but anyway...
1423             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1424         }
1425         $cache->set($plugin, $result);
1426     }
1428     if (!empty($name)) {
1429         if (array_key_exists($name, $result)) {
1430             return $result[$name];
1431         }
1432         return false;
1433     }
1435     if ($plugin === 'core') {
1436         $result['siteidentifier'] = $siteidentifier;
1437     }
1439     foreach ($forced as $key => $value) {
1440         if (is_null($value) or is_array($value) or is_object($value)) {
1441             // we do not want any extra mess here, just real settings that could be saved in db
1442             unset($result[$key]);
1443         } else {
1444             //convert to string as if it went through the DB
1445             $result[$key] = (string)$value;
1446         }
1447     }
1449     return (object)$result;
1452 /**
1453  * Removes a key from global configuration
1454  *
1455  * @param string $name the key to set
1456  * @param string $plugin (optional) the plugin scope
1457  * @global object
1458  * @return boolean whether the operation succeeded.
1459  */
1460 function unset_config($name, $plugin=NULL) {
1461     global $CFG, $DB;
1463     if (empty($plugin)) {
1464         unset($CFG->$name);
1465         $DB->delete_records('config', array('name'=>$name));
1466         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1467     } else {
1468         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1469         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1470     }
1472     return true;
1475 /**
1476  * Remove all the config variables for a given plugin.
1477  *
1478  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1479  * @return boolean whether the operation succeeded.
1480  */
1481 function unset_all_config_for_plugin($plugin) {
1482     global $DB;
1483     // Delete from the obvious config_plugins first
1484     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1485     // Next delete any suspect settings from config
1486     $like = $DB->sql_like('name', '?', true, true, false, '|');
1487     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1488     $DB->delete_records_select('config', $like, $params);
1489     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1490     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1492     return true;
1495 /**
1496  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1497  *
1498  * All users are verified if they still have the necessary capability.
1499  *
1500  * @param string $value the value of the config setting.
1501  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1502  * @param bool $include admins, include administrators
1503  * @return array of user objects.
1504  */
1505 function get_users_from_config($value, $capability, $includeadmins = true) {
1506     global $CFG, $DB;
1508     if (empty($value) or $value === '$@NONE@$') {
1509         return array();
1510     }
1512     // we have to make sure that users still have the necessary capability,
1513     // it should be faster to fetch them all first and then test if they are present
1514     // instead of validating them one-by-one
1515     $users = get_users_by_capability(context_system::instance(), $capability);
1516     if ($includeadmins) {
1517         $admins = get_admins();
1518         foreach ($admins as $admin) {
1519             $users[$admin->id] = $admin;
1520         }
1521     }
1523     if ($value === '$@ALL@$') {
1524         return $users;
1525     }
1527     $result = array(); // result in correct order
1528     $allowed = explode(',', $value);
1529     foreach ($allowed as $uid) {
1530         if (isset($users[$uid])) {
1531             $user = $users[$uid];
1532             $result[$user->id] = $user;
1533         }
1534     }
1536     return $result;
1540 /**
1541  * Invalidates browser caches and cached data in temp
1542  *
1543  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1544  * {@see phpunit_util::reset_dataroot()}
1545  *
1546  * @return void
1547  */
1548 function purge_all_caches() {
1549     global $CFG;
1551     reset_text_filters_cache();
1552     js_reset_all_caches();
1553     theme_reset_all_caches();
1554     get_string_manager()->reset_caches();
1555     textlib::reset_caches();
1557     cache_helper::purge_all();
1559     // purge all other caches: rss, simplepie, etc.
1560     remove_dir($CFG->cachedir.'', true);
1562     // make sure cache dir is writable, throws exception if not
1563     make_cache_directory('');
1565     // hack: this script may get called after the purifier was initialised,
1566     // but we do not want to verify repeatedly this exists in each call
1567     make_cache_directory('htmlpurifier');
1570 /**
1571  * Get volatile flags
1572  *
1573  * @param string $type
1574  * @param int    $changedsince default null
1575  * @return records array
1576  */
1577 function get_cache_flags($type, $changedsince=NULL) {
1578     global $DB;
1580     $params = array('type'=>$type, 'expiry'=>time());
1581     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1582     if ($changedsince !== NULL) {
1583         $params['changedsince'] = $changedsince;
1584         $sqlwhere .= " AND timemodified > :changedsince";
1585     }
1586     $cf = array();
1588     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1589         foreach ($flags as $flag) {
1590             $cf[$flag->name] = $flag->value;
1591         }
1592     }
1593     return $cf;
1596 /**
1597  * Get volatile flags
1598  *
1599  * @param string $type
1600  * @param string $name
1601  * @param int    $changedsince default null
1602  * @return records array
1603  */
1604 function get_cache_flag($type, $name, $changedsince=NULL) {
1605     global $DB;
1607     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1609     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1610     if ($changedsince !== NULL) {
1611         $params['changedsince'] = $changedsince;
1612         $sqlwhere .= " AND timemodified > :changedsince";
1613     }
1615     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1618 /**
1619  * Set a volatile flag
1620  *
1621  * @param string $type the "type" namespace for the key
1622  * @param string $name the key to set
1623  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1624  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1625  * @return bool Always returns true
1626  */
1627 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1628     global $DB;
1630     $timemodified = time();
1631     if ($expiry===NULL || $expiry < $timemodified) {
1632         $expiry = $timemodified + 24 * 60 * 60;
1633     } else {
1634         $expiry = (int)$expiry;
1635     }
1637     if ($value === NULL) {
1638         unset_cache_flag($type,$name);
1639         return true;
1640     }
1642     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1643         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1644             return true; //no need to update
1645         }
1646         $f->value        = $value;
1647         $f->expiry       = $expiry;
1648         $f->timemodified = $timemodified;
1649         $DB->update_record('cache_flags', $f);
1650     } else {
1651         $f = new stdClass();
1652         $f->flagtype     = $type;
1653         $f->name         = $name;
1654         $f->value        = $value;
1655         $f->expiry       = $expiry;
1656         $f->timemodified = $timemodified;
1657         $DB->insert_record('cache_flags', $f);
1658     }
1659     return true;
1662 /**
1663  * Removes a single volatile flag
1664  *
1665  * @global object
1666  * @param string $type the "type" namespace for the key
1667  * @param string $name the key to set
1668  * @return bool
1669  */
1670 function unset_cache_flag($type, $name) {
1671     global $DB;
1672     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1673     return true;
1676 /**
1677  * Garbage-collect volatile flags
1678  *
1679  * @return bool Always returns true
1680  */
1681 function gc_cache_flags() {
1682     global $DB;
1683     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1684     return true;
1687 // USER PREFERENCE API
1689 /**
1690  * Refresh user preference cache. This is used most often for $USER
1691  * object that is stored in session, but it also helps with performance in cron script.
1692  *
1693  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1694  *
1695  * @package  core
1696  * @category preference
1697  * @access   public
1698  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1699  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1700  * @throws   coding_exception
1701  * @return   null
1702  */
1703 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1704     global $DB;
1705     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1707     if (!isset($user->id)) {
1708         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1709     }
1711     if (empty($user->id) or isguestuser($user->id)) {
1712         // No permanent storage for not-logged-in users and guest
1713         if (!isset($user->preference)) {
1714             $user->preference = array();
1715         }
1716         return;
1717     }
1719     $timenow = time();
1721     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1722         // Already loaded at least once on this page. Are we up to date?
1723         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1724             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1725             return;
1727         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1728             // no change since the lastcheck on this page
1729             $user->preference['_lastloaded'] = $timenow;
1730             return;
1731         }
1732     }
1734     // OK, so we have to reload all preferences
1735     $loadedusers[$user->id] = true;
1736     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1737     $user->preference['_lastloaded'] = $timenow;
1740 /**
1741  * Called from set/unset_user_preferences, so that the prefs can
1742  * be correctly reloaded in different sessions.
1743  *
1744  * NOTE: internal function, do not call from other code.
1745  *
1746  * @package core
1747  * @access  private
1748  * @param   integer         $userid the user whose prefs were changed.
1749  */
1750 function mark_user_preferences_changed($userid) {
1751     global $CFG;
1753     if (empty($userid) or isguestuser($userid)) {
1754         // no cache flags for guest and not-logged-in users
1755         return;
1756     }
1758     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1761 /**
1762  * Sets a preference for the specified user.
1763  *
1764  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1765  *
1766  * @package  core
1767  * @category preference
1768  * @access   public
1769  * @param    string            $name  The key to set as preference for the specified user
1770  * @param    string            $value The value to set for the $name key in the specified user's
1771  *                                    record, null means delete current value.
1772  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1773  * @throws   coding_exception
1774  * @return   bool                     Always true or exception
1775  */
1776 function set_user_preference($name, $value, $user = null) {
1777     global $USER, $DB;
1779     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1780         throw new coding_exception('Invalid preference name in set_user_preference() call');
1781     }
1783     if (is_null($value)) {
1784         // null means delete current
1785         return unset_user_preference($name, $user);
1786     } else if (is_object($value)) {
1787         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1788     } else if (is_array($value)) {
1789         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1790     }
1791     $value = (string)$value;
1792     if (textlib::strlen($value) > 1333) { //value column maximum length is 1333 characters
1793         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1794     }
1796     if (is_null($user)) {
1797         $user = $USER;
1798     } else if (isset($user->id)) {
1799         // $user is valid object
1800     } else if (is_numeric($user)) {
1801         $user = (object)array('id'=>(int)$user);
1802     } else {
1803         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1804     }
1806     check_user_preferences_loaded($user);
1808     if (empty($user->id) or isguestuser($user->id)) {
1809         // no permanent storage for not-logged-in users and guest
1810         $user->preference[$name] = $value;
1811         return true;
1812     }
1814     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1815         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1816             // preference already set to this value
1817             return true;
1818         }
1819         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1821     } else {
1822         $preference = new stdClass();
1823         $preference->userid = $user->id;
1824         $preference->name   = $name;
1825         $preference->value  = $value;
1826         $DB->insert_record('user_preferences', $preference);
1827     }
1829     // update value in cache
1830     $user->preference[$name] = $value;
1832     // set reload flag for other sessions
1833     mark_user_preferences_changed($user->id);
1835     return true;
1838 /**
1839  * Sets a whole array of preferences for the current user
1840  *
1841  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1842  *
1843  * @package  core
1844  * @category preference
1845  * @access   public
1846  * @param    array             $prefarray An array of key/value pairs to be set
1847  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1848  * @return   bool                         Always true or exception
1849  */
1850 function set_user_preferences(array $prefarray, $user = null) {
1851     foreach ($prefarray as $name => $value) {
1852         set_user_preference($name, $value, $user);
1853     }
1854     return true;
1857 /**
1858  * Unsets a preference completely by deleting it from the database
1859  *
1860  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1861  *
1862  * @package  core
1863  * @category preference
1864  * @access   public
1865  * @param    string            $name The key to unset as preference for the specified user
1866  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1867  * @throws   coding_exception
1868  * @return   bool                    Always true or exception
1869  */
1870 function unset_user_preference($name, $user = null) {
1871     global $USER, $DB;
1873     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1874         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1875     }
1877     if (is_null($user)) {
1878         $user = $USER;
1879     } else if (isset($user->id)) {
1880         // $user is valid object
1881     } else if (is_numeric($user)) {
1882         $user = (object)array('id'=>(int)$user);
1883     } else {
1884         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1885     }
1887     check_user_preferences_loaded($user);
1889     if (empty($user->id) or isguestuser($user->id)) {
1890         // no permanent storage for not-logged-in user and guest
1891         unset($user->preference[$name]);
1892         return true;
1893     }
1895     // delete from DB
1896     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1898     // delete the preference from cache
1899     unset($user->preference[$name]);
1901     // set reload flag for other sessions
1902     mark_user_preferences_changed($user->id);
1904     return true;
1907 /**
1908  * Used to fetch user preference(s)
1909  *
1910  * If no arguments are supplied this function will return
1911  * all of the current user preferences as an array.
1912  *
1913  * If a name is specified then this function
1914  * attempts to return that particular preference value.  If
1915  * none is found, then the optional value $default is returned,
1916  * otherwise NULL.
1917  *
1918  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1919  *
1920  * @package  core
1921  * @category preference
1922  * @access   public
1923  * @param    string            $name    Name of the key to use in finding a preference value
1924  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1925  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1926  * @throws   coding_exception
1927  * @return   string|mixed|null          A string containing the value of a single preference. An
1928  *                                      array with all of the preferences or null
1929  */
1930 function get_user_preferences($name = null, $default = null, $user = null) {
1931     global $USER;
1933     if (is_null($name)) {
1934         // all prefs
1935     } else if (is_numeric($name) or $name === '_lastloaded') {
1936         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1937     }
1939     if (is_null($user)) {
1940         $user = $USER;
1941     } else if (isset($user->id)) {
1942         // $user is valid object
1943     } else if (is_numeric($user)) {
1944         $user = (object)array('id'=>(int)$user);
1945     } else {
1946         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1947     }
1949     check_user_preferences_loaded($user);
1951     if (empty($name)) {
1952         return $user->preference; // All values
1953     } else if (isset($user->preference[$name])) {
1954         return $user->preference[$name]; // The single string value
1955     } else {
1956         return $default; // Default value (null if not specified)
1957     }
1960 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1962 /**
1963  * Given date parts in user time produce a GMT timestamp.
1964  *
1965  * @package core
1966  * @category time
1967  * @param int $year The year part to create timestamp of
1968  * @param int $month The month part to create timestamp of
1969  * @param int $day The day part to create timestamp of
1970  * @param int $hour The hour part to create timestamp of
1971  * @param int $minute The minute part to create timestamp of
1972  * @param int $second The second part to create timestamp of
1973  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
1974  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
1975  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1976  *             applied only if timezone is 99 or string.
1977  * @return int GMT timestamp
1978  */
1979 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1981     //save input timezone, required for dst offset check.
1982     $passedtimezone = $timezone;
1984     $timezone = get_user_timezone_offset($timezone);
1986     if (abs($timezone) > 13) {  //server time
1987         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1988     } else {
1989         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1990         $time = usertime($time, $timezone);
1992         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1993         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1994             $time -= dst_offset_on($time, $passedtimezone);
1995         }
1996     }
1998     return $time;
2002 /**
2003  * Format a date/time (seconds) as weeks, days, hours etc as needed
2004  *
2005  * Given an amount of time in seconds, returns string
2006  * formatted nicely as weeks, days, hours etc as needed
2007  *
2008  * @package core
2009  * @category time
2010  * @uses MINSECS
2011  * @uses HOURSECS
2012  * @uses DAYSECS
2013  * @uses YEARSECS
2014  * @param int $totalsecs Time in seconds
2015  * @param object $str Should be a time object
2016  * @return string A nicely formatted date/time string
2017  */
2018  function format_time($totalsecs, $str=NULL) {
2020     $totalsecs = abs($totalsecs);
2022     if (!$str) {  // Create the str structure the slow way
2023         $str = new stdClass();
2024         $str->day   = get_string('day');
2025         $str->days  = get_string('days');
2026         $str->hour  = get_string('hour');
2027         $str->hours = get_string('hours');
2028         $str->min   = get_string('min');
2029         $str->mins  = get_string('mins');
2030         $str->sec   = get_string('sec');
2031         $str->secs  = get_string('secs');
2032         $str->year  = get_string('year');
2033         $str->years = get_string('years');
2034     }
2037     $years     = floor($totalsecs/YEARSECS);
2038     $remainder = $totalsecs - ($years*YEARSECS);
2039     $days      = floor($remainder/DAYSECS);
2040     $remainder = $totalsecs - ($days*DAYSECS);
2041     $hours     = floor($remainder/HOURSECS);
2042     $remainder = $remainder - ($hours*HOURSECS);
2043     $mins      = floor($remainder/MINSECS);
2044     $secs      = $remainder - ($mins*MINSECS);
2046     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2047     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2048     $sh = ($hours == 1) ? $str->hour : $str->hours;
2049     $sd = ($days == 1)  ? $str->day  : $str->days;
2050     $sy = ($years == 1)  ? $str->year  : $str->years;
2052     $oyears = '';
2053     $odays = '';
2054     $ohours = '';
2055     $omins = '';
2056     $osecs = '';
2058     if ($years)  $oyears  = $years .' '. $sy;
2059     if ($days)  $odays  = $days .' '. $sd;
2060     if ($hours) $ohours = $hours .' '. $sh;
2061     if ($mins)  $omins  = $mins .' '. $sm;
2062     if ($secs)  $osecs  = $secs .' '. $ss;
2064     if ($years) return trim($oyears .' '. $odays);
2065     if ($days)  return trim($odays .' '. $ohours);
2066     if ($hours) return trim($ohours .' '. $omins);
2067     if ($mins)  return trim($omins .' '. $osecs);
2068     if ($secs)  return $osecs;
2069     return get_string('now');
2072 /**
2073  * Returns a formatted string that represents a date in user time
2074  *
2075  * Returns a formatted string that represents a date in user time
2076  * <b>WARNING: note that the format is for strftime(), not date().</b>
2077  * Because of a bug in most Windows time libraries, we can't use
2078  * the nicer %e, so we have to use %d which has leading zeroes.
2079  * A lot of the fuss in the function is just getting rid of these leading
2080  * zeroes as efficiently as possible.
2081  *
2082  * If parameter fixday = true (default), then take off leading
2083  * zero from %d, else maintain it.
2084  *
2085  * @package core
2086  * @category time
2087  * @param int $date the timestamp in UTC, as obtained from the database.
2088  * @param string $format strftime format. You should probably get this using
2089  *        get_string('strftime...', 'langconfig');
2090  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
2091  *        not 99 then daylight saving will not be added.
2092  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2093  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2094  *        If false then the leading zero is maintained.
2095  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2096  * @return string the formatted date/time.
2097  */
2098 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2100     global $CFG;
2102     if (empty($format)) {
2103         $format = get_string('strftimedaydatetime', 'langconfig');
2104     }
2106     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
2107         $fixday = false;
2108     } else if ($fixday) {
2109         $formatnoday = str_replace('%d', 'DD', $format);
2110         $fixday = ($formatnoday != $format);
2111         $format = $formatnoday;
2112     }
2114     // Note: This logic about fixing 12-hour time to remove unnecessary leading
2115     // zero is required because on Windows, PHP strftime function does not
2116     // support the correct 'hour without leading zero' parameter (%l).
2117     if (!empty($CFG->nofixhour)) {
2118         // Config.php can force %I not to be fixed.
2119         $fixhour = false;
2120     } else if ($fixhour) {
2121         $formatnohour = str_replace('%I', 'HH', $format);
2122         $fixhour = ($formatnohour != $format);
2123         $format = $formatnohour;
2124     }
2126     //add daylight saving offset for string timezones only, as we can't get dst for
2127     //float values. if timezone is 99 (user default timezone), then try update dst.
2128     if ((99 == $timezone) || !is_numeric($timezone)) {
2129         $date += dst_offset_on($date, $timezone);
2130     }
2132     $timezone = get_user_timezone_offset($timezone);
2134     // If we are running under Windows convert to windows encoding and then back to UTF-8
2135     // (because it's impossible to specify UTF-8 to fetch locale info in Win32)
2137     if (abs($timezone) > 13) {   /// Server time
2138         $datestring = date_format_string($date, $format, $timezone);
2139         if ($fixday) {
2140             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
2141             $datestring = str_replace('DD', $daystring, $datestring);
2142         }
2143         if ($fixhour) {
2144             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
2145             $datestring = str_replace('HH', $hourstring, $datestring);
2146         }
2148     } else {
2149         $date += (int)($timezone * 3600);
2150         $datestring = date_format_string($date, $format, $timezone);
2151         if ($fixday) {
2152             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2153             $datestring = str_replace('DD', $daystring, $datestring);
2154         }
2155         if ($fixhour) {
2156             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2157             $datestring = str_replace('HH', $hourstring, $datestring);
2158         }
2159     }
2161     return $datestring;
2164 /**
2165  * Returns a formatted date ensuring it is UTF-8.
2166  *
2167  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2168  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2169  *
2170  * This function does not do any calculation regarding the user preferences and should
2171  * therefore receive the final date timestamp, format and timezone. Timezone being only used
2172  * to differenciate the use of server time or not (strftime() against gmstrftime()).
2173  *
2174  * @param int $date the timestamp.
2175  * @param string $format strftime format.
2176  * @param int|float $timezone the numerical timezone, typically returned by {@link get_user_timezone_offset()}.
2177  * @return string the formatted date/time.
2178  * @since 2.3.3
2179  */
2180 function date_format_string($date, $format, $tz = 99) {
2181     global $CFG;
2182     if (abs($tz) > 13) {
2183         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2184             $format = textlib::convert($format, 'utf-8', $localewincharset);
2185             $datestring = strftime($format, $date);
2186             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2187         } else {
2188             $datestring = strftime($format, $date);
2189         }
2190     } else {
2191         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2192             $format = textlib::convert($format, 'utf-8', $localewincharset);
2193             $datestring = gmstrftime($format, $date);
2194             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2195         } else {
2196             $datestring = gmstrftime($format, $date);
2197         }
2198     }
2199     return $datestring;
2202 /**
2203  * Given a $time timestamp in GMT (seconds since epoch),
2204  * returns an array that represents the date in user time
2205  *
2206  * @package core
2207  * @category time
2208  * @uses HOURSECS
2209  * @param int $time Timestamp in GMT
2210  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2211  *        dst offset is applyed {@link http://docs.moodle.org/dev/Time_API#Timezone}
2212  * @return array An array that represents the date in user time
2213  */
2214 function usergetdate($time, $timezone=99) {
2216     //save input timezone, required for dst offset check.
2217     $passedtimezone = $timezone;
2219     $timezone = get_user_timezone_offset($timezone);
2221     if (abs($timezone) > 13) {    // Server time
2222         return getdate($time);
2223     }
2225     //add daylight saving offset for string timezones only, as we can't get dst for
2226     //float values. if timezone is 99 (user default timezone), then try update dst.
2227     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2228         $time += dst_offset_on($time, $passedtimezone);
2229     }
2231     $time += intval((float)$timezone * HOURSECS);
2233     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2235     //be careful to ensure the returned array matches that produced by getdate() above
2236     list(
2237         $getdate['month'],
2238         $getdate['weekday'],
2239         $getdate['yday'],
2240         $getdate['year'],
2241         $getdate['mon'],
2242         $getdate['wday'],
2243         $getdate['mday'],
2244         $getdate['hours'],
2245         $getdate['minutes'],
2246         $getdate['seconds']
2247     ) = explode('_', $datestring);
2249     // set correct datatype to match with getdate()
2250     $getdate['seconds'] = (int)$getdate['seconds'];
2251     $getdate['yday'] = (int)$getdate['yday'] - 1; // gettime returns 0 through 365
2252     $getdate['year'] = (int)$getdate['year'];
2253     $getdate['mon'] = (int)$getdate['mon'];
2254     $getdate['wday'] = (int)$getdate['wday'];
2255     $getdate['mday'] = (int)$getdate['mday'];
2256     $getdate['hours'] = (int)$getdate['hours'];
2257     $getdate['minutes']  = (int)$getdate['minutes'];
2258     return $getdate;
2261 /**
2262  * Given a GMT timestamp (seconds since epoch), offsets it by
2263  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2264  *
2265  * @package core
2266  * @category time
2267  * @uses HOURSECS
2268  * @param int $date Timestamp in GMT
2269  * @param float|int|string $timezone timezone to calculate GMT time offset before
2270  *        calculating user time, 99 is default user timezone
2271  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2272  * @return int
2273  */
2274 function usertime($date, $timezone=99) {
2276     $timezone = get_user_timezone_offset($timezone);
2278     if (abs($timezone) > 13) {
2279         return $date;
2280     }
2281     return $date - (int)($timezone * HOURSECS);
2284 /**
2285  * Given a time, return the GMT timestamp of the most recent midnight
2286  * for the current user.
2287  *
2288  * @package core
2289  * @category time
2290  * @param int $date Timestamp in GMT
2291  * @param float|int|string $timezone timezone to calculate GMT time offset before
2292  *        calculating user midnight time, 99 is default user timezone
2293  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2294  * @return int Returns a GMT timestamp
2295  */
2296 function usergetmidnight($date, $timezone=99) {
2298     $userdate = usergetdate($date, $timezone);
2300     // Time of midnight of this user's day, in GMT
2301     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2305 /**
2306  * Returns a string that prints the user's timezone
2307  *
2308  * @package core
2309  * @category time
2310  * @param float|int|string $timezone timezone to calculate GMT time offset before
2311  *        calculating user timezone, 99 is default user timezone
2312  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2313  * @return string
2314  */
2315 function usertimezone($timezone=99) {
2317     $tz = get_user_timezone($timezone);
2319     if (!is_float($tz)) {
2320         return $tz;
2321     }
2323     if(abs($tz) > 13) { // Server time
2324         return get_string('serverlocaltime');
2325     }
2327     if($tz == intval($tz)) {
2328         // Don't show .0 for whole hours
2329         $tz = intval($tz);
2330     }
2332     if($tz == 0) {
2333         return 'UTC';
2334     }
2335     else if($tz > 0) {
2336         return 'UTC+'.$tz;
2337     }
2338     else {
2339         return 'UTC'.$tz;
2340     }
2344 /**
2345  * Returns a float which represents the user's timezone difference from GMT in hours
2346  * Checks various settings and picks the most dominant of those which have a value
2347  *
2348  * @package core
2349  * @category time
2350  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2351  *        99 is default user timezone
2352  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2353  * @return float
2354  */
2355 function get_user_timezone_offset($tz = 99) {
2357     global $USER, $CFG;
2359     $tz = get_user_timezone($tz);
2361     if (is_float($tz)) {
2362         return $tz;
2363     } else {
2364         $tzrecord = get_timezone_record($tz);
2365         if (empty($tzrecord)) {
2366             return 99.0;
2367         }
2368         return (float)$tzrecord->gmtoff / HOURMINS;
2369     }
2372 /**
2373  * Returns an int which represents the systems's timezone difference from GMT in seconds
2374  *
2375  * @package core
2376  * @category time
2377  * @param float|int|string $tz timezone for which offset is required.
2378  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2379  * @return int|bool if found, false is timezone 99 or error
2380  */
2381 function get_timezone_offset($tz) {
2382     global $CFG;
2384     if ($tz == 99) {
2385         return false;
2386     }
2388     if (is_numeric($tz)) {
2389         return intval($tz * 60*60);
2390     }
2392     if (!$tzrecord = get_timezone_record($tz)) {
2393         return false;
2394     }
2395     return intval($tzrecord->gmtoff * 60);
2398 /**
2399  * Returns a float or a string which denotes the user's timezone
2400  * 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)
2401  * means that for this timezone there are also DST rules to be taken into account
2402  * Checks various settings and picks the most dominant of those which have a value
2403  *
2404  * @package core
2405  * @category time
2406  * @param float|int|string $tz timezone to calculate GMT time offset before
2407  *        calculating user timezone, 99 is default user timezone
2408  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2409  * @return float|string
2410  */
2411 function get_user_timezone($tz = 99) {
2412     global $USER, $CFG;
2414     $timezones = array(
2415         $tz,
2416         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2417         isset($USER->timezone) ? $USER->timezone : 99,
2418         isset($CFG->timezone) ? $CFG->timezone : 99,
2419         );
2421     $tz = 99;
2423     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array
2424     while(((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2425         $tz = $next['value'];
2426     }
2427     return is_numeric($tz) ? (float) $tz : $tz;
2430 /**
2431  * Returns cached timezone record for given $timezonename
2432  *
2433  * @package core
2434  * @param string $timezonename name of the timezone
2435  * @return stdClass|bool timezonerecord or false
2436  */
2437 function get_timezone_record($timezonename) {
2438     global $CFG, $DB;
2439     static $cache = NULL;
2441     if ($cache === NULL) {
2442         $cache = array();
2443     }
2445     if (isset($cache[$timezonename])) {
2446         return $cache[$timezonename];
2447     }
2449     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2450                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2453 /**
2454  * Build and store the users Daylight Saving Time (DST) table
2455  *
2456  * @package core
2457  * @param int $from_year Start year for the table, defaults to 1971
2458  * @param int $to_year End year for the table, defaults to 2035
2459  * @param int|float|string $strtimezone, timezone to check if dst should be applyed.
2460  * @return bool
2461  */
2462 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2463     global $CFG, $SESSION, $DB;
2465     $usertz = get_user_timezone($strtimezone);
2467     if (is_float($usertz)) {
2468         // Trivial timezone, no DST
2469         return false;
2470     }
2472     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2473         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2474         unset($SESSION->dst_offsets);
2475         unset($SESSION->dst_range);
2476     }
2478     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2479         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2480         // This will be the return path most of the time, pretty light computationally
2481         return true;
2482     }
2484     // Reaching here means we either need to extend our table or create it from scratch
2486     // Remember which TZ we calculated these changes for
2487     $SESSION->dst_offsettz = $usertz;
2489     if(empty($SESSION->dst_offsets)) {
2490         // If we 're creating from scratch, put the two guard elements in there
2491         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2492     }
2493     if(empty($SESSION->dst_range)) {
2494         // If creating from scratch
2495         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2496         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2498         // Fill in the array with the extra years we need to process
2499         $yearstoprocess = array();
2500         for($i = $from; $i <= $to; ++$i) {
2501             $yearstoprocess[] = $i;
2502         }
2504         // Take note of which years we have processed for future calls
2505         $SESSION->dst_range = array($from, $to);
2506     }
2507     else {
2508         // If needing to extend the table, do the same
2509         $yearstoprocess = array();
2511         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2512         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2514         if($from < $SESSION->dst_range[0]) {
2515             // Take note of which years we need to process and then note that we have processed them for future calls
2516             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2517                 $yearstoprocess[] = $i;
2518             }
2519             $SESSION->dst_range[0] = $from;
2520         }
2521         if($to > $SESSION->dst_range[1]) {
2522             // Take note of which years we need to process and then note that we have processed them for future calls
2523             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2524                 $yearstoprocess[] = $i;
2525             }
2526             $SESSION->dst_range[1] = $to;
2527         }
2528     }
2530     if(empty($yearstoprocess)) {
2531         // This means that there was a call requesting a SMALLER range than we have already calculated
2532         return true;
2533     }
2535     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2536     // Also, the array is sorted in descending timestamp order!
2538     // Get DB data
2540     static $presets_cache = array();
2541     if (!isset($presets_cache[$usertz])) {
2542         $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');
2543     }
2544     if(empty($presets_cache[$usertz])) {
2545         return false;
2546     }
2548     // Remove ending guard (first element of the array)
2549     reset($SESSION->dst_offsets);
2550     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2552     // Add all required change timestamps
2553     foreach($yearstoprocess as $y) {
2554         // Find the record which is in effect for the year $y
2555         foreach($presets_cache[$usertz] as $year => $preset) {
2556             if($year <= $y) {
2557                 break;
2558             }
2559         }
2561         $changes = dst_changes_for_year($y, $preset);
2563         if($changes === NULL) {
2564             continue;
2565         }
2566         if($changes['dst'] != 0) {
2567             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2568         }
2569         if($changes['std'] != 0) {
2570             $SESSION->dst_offsets[$changes['std']] = 0;
2571         }
2572     }
2574     // Put in a guard element at the top
2575     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2576     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2578     // Sort again
2579     krsort($SESSION->dst_offsets);
2581     return true;
2584 /**
2585  * Calculates the required DST change and returns a Timestamp Array
2586  *
2587  * @package core
2588  * @category time
2589  * @uses HOURSECS
2590  * @uses MINSECS
2591  * @param int|string $year Int or String Year to focus on
2592  * @param object $timezone Instatiated Timezone object
2593  * @return array|null Array dst=>xx, 0=>xx, std=>yy, 1=>yy or NULL
2594  */
2595 function dst_changes_for_year($year, $timezone) {
2597     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2598         return NULL;
2599     }
2601     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2602     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2604     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2605     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2607     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2608     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2610     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2611     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2612     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2614     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2615     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2617     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2620 /**
2621  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2622  * - Note: Daylight saving only works for string timezones and not for float.
2623  *
2624  * @package core
2625  * @category time
2626  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2627  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2628  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2629  * @return int
2630  */
2631 function dst_offset_on($time, $strtimezone = NULL) {
2632     global $SESSION;
2634     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2635         return 0;
2636     }
2638     reset($SESSION->dst_offsets);
2639     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2640         if($from <= $time) {
2641             break;
2642         }
2643     }
2645     // This is the normal return path
2646     if($offset !== NULL) {
2647         return $offset;
2648     }
2650     // Reaching this point means we haven't calculated far enough, do it now:
2651     // Calculate extra DST changes if needed and recurse. The recursion always
2652     // moves toward the stopping condition, so will always end.
2654     if($from == 0) {
2655         // We need a year smaller than $SESSION->dst_range[0]
2656         if($SESSION->dst_range[0] == 1971) {
2657             return 0;
2658         }
2659         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2660         return dst_offset_on($time, $strtimezone);
2661     }
2662     else {
2663         // We need a year larger than $SESSION->dst_range[1]
2664         if($SESSION->dst_range[1] == 2035) {
2665             return 0;
2666         }
2667         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2668         return dst_offset_on($time, $strtimezone);
2669     }
2672 /**
2673  * Calculates when the day appears in specific month
2674  *
2675  * @package core
2676  * @category time
2677  * @param int $startday starting day of the month
2678  * @param int $weekday The day when week starts (normally taken from user preferences)
2679  * @param int $month The month whose day is sought
2680  * @param int $year The year of the month whose day is sought
2681  * @return int
2682  */
2683 function find_day_in_month($startday, $weekday, $month, $year) {
2685     $daysinmonth = days_in_month($month, $year);
2687     if($weekday == -1) {
2688         // Don't care about weekday, so return:
2689         //    abs($startday) if $startday != -1
2690         //    $daysinmonth otherwise
2691         return ($startday == -1) ? $daysinmonth : abs($startday);
2692     }
2694     // From now on we 're looking for a specific weekday
2696     // Give "end of month" its actual value, since we know it
2697     if($startday == -1) {
2698         $startday = -1 * $daysinmonth;
2699     }
2701     // Starting from day $startday, the sign is the direction
2703     if($startday < 1) {
2705         $startday = abs($startday);
2706         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2708         // This is the last such weekday of the month
2709         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2710         if($lastinmonth > $daysinmonth) {
2711             $lastinmonth -= 7;
2712         }
2714         // Find the first such weekday <= $startday
2715         while($lastinmonth > $startday) {
2716             $lastinmonth -= 7;
2717         }
2719         return $lastinmonth;
2721     }
2722     else {
2724         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2726         $diff = $weekday - $indexweekday;
2727         if($diff < 0) {
2728             $diff += 7;
2729         }
2731         // This is the first such weekday of the month equal to or after $startday
2732         $firstfromindex = $startday + $diff;
2734         return $firstfromindex;
2736     }
2739 /**
2740  * Calculate the number of days in a given month
2741  *
2742  * @package core
2743  * @category time
2744  * @param int $month The month whose day count is sought
2745  * @param int $year The year of the month whose day count is sought
2746  * @return int
2747  */
2748 function days_in_month($month, $year) {
2749    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2752 /**
2753  * Calculate the position in the week of a specific calendar day
2754  *
2755  * @package core
2756  * @category time
2757  * @param int $day The day of the date whose position in the week is sought
2758  * @param int $month The month of the date whose position in the week is sought
2759  * @param int $year The year of the date whose position in the week is sought
2760  * @return int
2761  */
2762 function dayofweek($day, $month, $year) {
2763     // I wonder if this is any different from
2764     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2765     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2768 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2770 /**
2771  * Returns full login url.
2772  *
2773  * @return string login url
2774  */
2775 function get_login_url() {
2776     global $CFG;
2778     $url = "$CFG->wwwroot/login/index.php";
2780     if (!empty($CFG->loginhttps)) {
2781         $url = str_replace('http:', 'https:', $url);
2782     }
2784     return $url;
2787 /**
2788  * This function checks that the current user is logged in and has the
2789  * required privileges
2790  *
2791  * This function checks that the current user is logged in, and optionally
2792  * whether they are allowed to be in a particular course and view a particular
2793  * course module.
2794  * If they are not logged in, then it redirects them to the site login unless
2795  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2796  * case they are automatically logged in as guests.
2797  * If $courseid is given and the user is not enrolled in that course then the
2798  * user is redirected to the course enrolment page.
2799  * If $cm is given and the course module is hidden and the user is not a teacher
2800  * in the course then the user is redirected to the course home page.
2801  *
2802  * When $cm parameter specified, this function sets page layout to 'module'.
2803  * You need to change it manually later if some other layout needed.
2804  *
2805  * @package    core_access
2806  * @category   access
2807  *
2808  * @param mixed $courseorid id of the course or course object
2809  * @param bool $autologinguest default true
2810  * @param object $cm course module object
2811  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2812  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2813  *             in order to keep redirects working properly. MDL-14495
2814  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2815  * @return mixed Void, exit, and die depending on path
2816  */
2817 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2818     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2820     // setup global $COURSE, themes, language and locale
2821     if (!empty($courseorid)) {
2822         if (is_object($courseorid)) {
2823             $course = $courseorid;
2824         } else if ($courseorid == SITEID) {
2825             $course = clone($SITE);
2826         } else {
2827             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2828         }
2829         if ($cm) {
2830             if ($cm->course != $course->id) {
2831                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2832             }
2833             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2834             if (!($cm instanceof cm_info)) {
2835                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2836                 // db queries so this is not really a performance concern, however it is obviously
2837                 // better if you use get_fast_modinfo to get the cm before calling this.
2838                 $modinfo = get_fast_modinfo($course);
2839                 $cm = $modinfo->get_cm($cm->id);
2840             }
2841             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2842             $PAGE->set_pagelayout('incourse');
2843         } else {
2844             $PAGE->set_course($course); // set's up global $COURSE
2845         }
2846     } else {
2847         // do not touch global $COURSE via $PAGE->set_course(),
2848         // the reasons is we need to be able to call require_login() at any time!!
2849         $course = $SITE;
2850         if ($cm) {
2851             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2852         }
2853     }
2855     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2856     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2857     // risk leading the user back to the AJAX request URL.
2858     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2859         $setwantsurltome = false;
2860     }
2862     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2863     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2864         if ($setwantsurltome) {
2865             $SESSION->wantsurl = qualified_me();
2866         }
2867         redirect(get_login_url());
2868     }
2870     // If the user is not even logged in yet then make sure they are
2871     if (!isloggedin()) {
2872         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2873             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2874                 // misconfigured site guest, just redirect to login page
2875                 redirect(get_login_url());
2876                 exit; // never reached
2877             }
2878             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2879             complete_user_login($guest);
2880             $USER->autologinguest = true;
2881             $SESSION->lang = $lang;
2882         } else {
2883             //NOTE: $USER->site check was obsoleted by session test cookie,
2884             //      $USER->confirmed test is in login/index.php
2885             if ($preventredirect) {
2886                 throw new require_login_exception('You are not logged in');
2887             }
2889             if ($setwantsurltome) {
2890                 $SESSION->wantsurl = qualified_me();
2891             }
2892             if (!empty($_SERVER['HTTP_REFERER'])) {
2893                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2894             }
2895             redirect(get_login_url());
2896             exit; // never reached
2897         }
2898     }
2900     // loginas as redirection if needed
2901     if ($course->id != SITEID and session_is_loggedinas()) {
2902         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2903             if ($USER->loginascontext->instanceid != $course->id) {
2904                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2905             }
2906         }
2907     }
2909     // check whether the user should be changing password (but only if it is REALLY them)
2910     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2911         $userauth = get_auth_plugin($USER->auth);
2912         if ($userauth->can_change_password() and !$preventredirect) {
2913             if ($setwantsurltome) {
2914                 $SESSION->wantsurl = qualified_me();
2915             }
2916             if ($changeurl = $userauth->change_password_url()) {
2917                 //use plugin custom url
2918                 redirect($changeurl);
2919             } else {
2920                 //use moodle internal method
2921                 if (empty($CFG->loginhttps)) {
2922                     redirect($CFG->wwwroot .'/login/change_password.php');
2923                 } else {
2924                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2925                     redirect($wwwroot .'/login/change_password.php');
2926                 }
2927             }
2928         } else {
2929             print_error('nopasswordchangeforced', 'auth');
2930         }
2931     }
2933     // Check that the user account is properly set up
2934     if (user_not_fully_set_up($USER)) {
2935         if ($preventredirect) {
2936             throw new require_login_exception('User not fully set-up');
2937         }
2938         if ($setwantsurltome) {
2939             $SESSION->wantsurl = qualified_me();
2940         }
2941         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2942     }
2944     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2945     sesskey();
2947     // Do not bother admins with any formalities
2948     if (is_siteadmin()) {
2949         //set accesstime or the user will appear offline which messes up messaging
2950         user_accesstime_log($course->id);
2951         return;
2952     }
2954     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2955     if (!$USER->policyagreed and !is_siteadmin()) {
2956         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2957             if ($preventredirect) {
2958                 throw new require_login_exception('Policy not agreed');
2959             }
2960             if ($setwantsurltome) {
2961                 $SESSION->wantsurl = qualified_me();
2962             }
2963             redirect($CFG->wwwroot .'/user/policy.php');
2964         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2965             if ($preventredirect) {
2966                 throw new require_login_exception('Policy not agreed');
2967             }
2968             if ($setwantsurltome) {
2969                 $SESSION->wantsurl = qualified_me();
2970             }
2971             redirect($CFG->wwwroot .'/user/policy.php');
2972         }
2973     }
2975     // Fetch the system context, the course context, and prefetch its child contexts
2976     $sysctx = context_system::instance();
2977     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2978     if ($cm) {
2979         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2980     } else {
2981         $cmcontext = null;
2982     }
2984     // If the site is currently under maintenance, then print a message
2985     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2986         if ($preventredirect) {
2987             throw new require_login_exception('Maintenance in progress');
2988         }
2990         print_maintenance_message();
2991     }
2993     // make sure the course itself is not hidden
2994     if ($course->id == SITEID) {
2995         // frontpage can not be hidden
2996     } else {
2997         if (is_role_switched($course->id)) {
2998             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2999         } else {
3000             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
3001                 // originally there was also test of parent category visibility,
3002                 // BUT is was very slow in complex queries involving "my courses"
3003                 // now it is also possible to simply hide all courses user is not enrolled in :-)
3004                 if ($preventredirect) {
3005                     throw new require_login_exception('Course is hidden');
3006                 }
3007                 // We need to override the navigation URL as the course won't have
3008                 // been added to the navigation and thus the navigation will mess up
3009                 // when trying to find it.
3010                 navigation_node::override_active_url(new moodle_url('/'));
3011                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
3012             }
3013         }
3014     }
3016     // is the user enrolled?
3017     if ($course->id == SITEID) {
3018         // everybody is enrolled on the frontpage
3020     } else {
3021         if (session_is_loggedinas()) {
3022             // Make sure the REAL person can access this course first
3023             $realuser = session_get_realuser();
3024             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
3025                 if ($preventredirect) {
3026                     throw new require_login_exception('Invalid course login-as access');
3027                 }
3028                 echo $OUTPUT->header();
3029                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
3030             }
3031         }
3033         $access = false;
3035         if (is_role_switched($course->id)) {
3036             // ok, user had to be inside this course before the switch
3037             $access = true;
3039         } else if (is_viewing($coursecontext, $USER)) {
3040             // ok, no need to mess with enrol
3041             $access = true;
3043         } else {
3044             if (isset($USER->enrol['enrolled'][$course->id])) {
3045                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3046                     $access = true;
3047                     if (isset($USER->enrol['tempguest'][$course->id])) {
3048                         unset($USER->enrol['tempguest'][$course->id]);
3049                         remove_temp_course_roles($coursecontext);
3050                     }
3051                 } else {
3052                     //expired
3053                     unset($USER->enrol['enrolled'][$course->id]);
3054                 }
3055             }
3056             if (isset($USER->enrol['tempguest'][$course->id])) {
3057                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3058                     $access = true;
3059                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3060                     $access = true;
3061                 } else {
3062                     //expired
3063                     unset($USER->enrol['tempguest'][$course->id]);
3064                     remove_temp_course_roles($coursecontext);
3065                 }
3066             }
3068             if ($access) {
3069                 // cache ok
3070             } else {
3071                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3072                 if ($until !== false) {
3073                     // active participants may always access, a timestamp in the future, 0 (always) or false.
3074                     if ($until == 0) {
3075                         $until = ENROL_MAX_TIMESTAMP;
3076                     }
3077                     $USER->enrol['enrolled'][$course->id] = $until;
3078                     $access = true;
3080                 } else {
3081                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
3082                     $enrols = enrol_get_plugins(true);
3083                     // first ask all enabled enrol instances in course if they want to auto enrol user
3084                     foreach($instances as $instance) {
3085                         if (!isset($enrols[$instance->enrol])) {
3086                             continue;
3087                         }
3088                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3089                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3090                         if ($until !== false) {
3091                             if ($until == 0) {
3092                                 $until = ENROL_MAX_TIMESTAMP;
3093                             }
3094                             $USER->enrol['enrolled'][$course->id] = $until;
3095                             $access = true;
3096                             break;
3097                         }
3098                     }
3099                     // if not enrolled yet try to gain temporary guest access
3100                     if (!$access) {
3101                         foreach($instances as $instance) {
3102                             if (!isset($enrols[$instance->enrol])) {
3103                                 continue;
3104                             }
3105                             // Get a duration for the guest access, a timestamp in the future or false.
3106                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3107                             if ($until !== false and $until > time()) {
3108                                 $USER->enrol['tempguest'][$course->id] = $until;
3109                                 $access = true;
3110                                 break;
3111                             }
3112                         }
3113                     }
3114                 }
3115             }
3116         }
3118         if (!$access) {
3119             if ($preventredirect) {
3120                 throw new require_login_exception('Not enrolled');
3121             }
3122             if ($setwantsurltome) {
3123                 $SESSION->wantsurl = qualified_me();
3124             }
3125             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3126         }
3127     }
3129     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
3130     // conditional availability, etc
3131     if ($cm && !$cm->uservisible) {
3132         if ($preventredirect) {
3133             throw new require_login_exception('Activity is hidden');
3134         }
3135         if ($course->id != SITEID) {
3136             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
3137         } else {
3138             $url = new moodle_url('/');
3139         }
3140         redirect($url, get_string('activityiscurrentlyhidden'));
3141     }
3143     // Finally access granted, update lastaccess times
3144     user_accesstime_log($course->id);
3148 /**
3149  * This function just makes sure a user is logged out.
3150  *
3151  * @package    core_access
3152  */
3153 function require_logout() {
3154     global $USER;
3156     $params = $USER;
3158     if (isloggedin()) {
3159         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
3161         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
3162         foreach($authsequence as $authname) {
3163             $authplugin = get_auth_plugin($authname);
3164             $authplugin->prelogout_hook();
3165         }
3166     }
3168     events_trigger('user_logout', $params);
3169     session_get_instance()->terminate_current();
3170     unset($params);
3173 /**
3174  * Weaker version of require_login()
3175  *
3176  * This is a weaker version of {@link require_login()} which only requires login
3177  * when called from within a course rather than the site page, unless
3178  * the forcelogin option is turned on.
3179  * @see require_login()
3180  *
3181  * @package    core_access
3182  * @category   access
3183  *
3184  * @param mixed $courseorid The course object or id in question
3185  * @param bool $autologinguest Allow autologin guests if that is wanted
3186  * @param object $cm Course activity module if known
3187  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3188  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3189  *             in order to keep redirects working properly. MDL-14495
3190  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3191  * @return void
3192  */
3193 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
3194     global $CFG, $PAGE, $SITE;
3195     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3196           or (!is_object($courseorid) and $courseorid == SITEID);
3197     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3198         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
3199         // db queries so this is not really a performance concern, however it is obviously
3200         // better if you use get_fast_modinfo to get the cm before calling this.
3201         if (is_object($courseorid)) {
3202             $course = $courseorid;
3203         } else {
3204             $course = clone($SITE);
3205         }
3206         $modinfo = get_fast_modinfo($course);
3207         $cm = $modinfo->get_cm($cm->id);
3208     }
3209     if (!empty($CFG->forcelogin)) {
3210         // login required for both SITE and courses
3211         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3213     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3214         // always login for hidden activities
3215         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3217     } else if ($issite) {
3218               //login for SITE not required
3219         if ($cm and empty($cm->visible)) {
3220             // hidden activities are not accessible without login
3221             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3222         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3223             // not-logged-in users do not have any group membership
3224             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3225         } else {
3226             // We still need to instatiate PAGE vars properly so that things
3227             // that rely on it like navigation function correctly.
3228             if (!empty($courseorid)) {
3229                 if (is_object($courseorid)) {
3230                     $course = $courseorid;
3231                 } else {
3232                     $course = clone($SITE);
3233                 }
3234                 if ($cm) {
3235                     if ($cm->course != $course->id) {
3236                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3237                     }
3238                     $PAGE->set_cm($cm, $course);
3239                     $PAGE->set_pagelayout('incourse');
3240                 } else {
3241                     $PAGE->set_course($course);
3242                 }
3243             } else {
3244                 // If $PAGE->course, and hence $PAGE->context, have not already been set
3245                 // up properly, set them up now.
3246                 $PAGE->set_course($PAGE->course);
3247             }
3248             //TODO: verify conditional activities here
3249             user_accesstime_log(SITEID);
3250             return;
3251         }
3253     } else {
3254         // course login always required
3255         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3256     }
3259 /**
3260  * Require key login. Function terminates with error if key not found or incorrect.
3261  *
3262  * @global object
3263  * @global object
3264  * @global object
3265  * @global object
3266  * @uses NO_MOODLE_COOKIES
3267  * @uses PARAM_ALPHANUM
3268  * @param string $script unique script identifier
3269  * @param int $instance optional instance id
3270  * @return int Instance ID
3271  */
3272 function require_user_key_login($script, $instance=null) {
3273     global $USER, $SESSION, $CFG, $DB;
3275     if (!NO_MOODLE_COOKIES) {
3276         print_error('sessioncookiesdisable');
3277     }
3279 /// extra safety
3280     @session_write_close();
3282     $keyvalue = required_param('key', PARAM_ALPHANUM);
3284     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3285         print_error('invalidkey');
3286     }
3288     if (!empty($key->validuntil) and $key->validuntil < time()) {
3289         print_error('expiredkey');
3290     }
3292     if ($key->iprestriction) {
3293         $remoteaddr = getremoteaddr(null);
3294         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3295             print_error('ipmismatch');
3296         }
3297     }
3299     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3300         print_error('invaliduserid');
3301     }
3303 /// emulate normal session
3304     enrol_check_plugins($user);
3305     session_set_user($user);
3307 /// note we are not using normal login
3308     if (!defined('USER_KEY_LOGIN')) {
3309         define('USER_KEY_LOGIN', true);
3310     }
3312 /// return instance id - it might be empty
3313     return $key->instance;
3316 /**
3317  * Creates a new private user access key.
3318  *
3319  * @global object
3320  * @param string $script unique target identifier
3321  * @param int $userid
3322  * @param int $instance optional instance id
3323  * @param string $iprestriction optional ip restricted access
3324  * @param timestamp $validuntil key valid only until given data
3325  * @return string access key value
3326  */
3327 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3328     global $DB;
3330     $key = new stdClass();
3331     $key->script        = $script;
3332     $key->userid        = $userid;
3333     $key->instance      = $instance;
3334     $key->iprestriction = $iprestriction;
3335     $key->validuntil    = $validuntil;
3336     $key->timecreated   = time();
3338     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3339     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3340         // must be unique
3341         $key->value     = md5($userid.'_'.time().random_string(40));
3342     }
3343     $DB->insert_record('user_private_key', $key);
3344     return $key->value;
3347 /**
3348  * Delete the user's new private user access keys for a particular script.
3349  *
3350  * @global object
3351  * @param string $script unique target identifier
3352  * @param int $userid
3353  * @return void
3354  */
3355 function delete_user_key($script,$userid) {
3356     global $DB;
3357     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3360 /**
3361  * Gets a private user access key (and creates one if one doesn't exist).
3362  *
3363  * @global object
3364  * @param string $script unique target identifier
3365  * @param int $userid
3366  * @param int $instance optional instance id
3367  * @param string $iprestriction optional ip restricted access
3368  * @param timestamp $validuntil key valid only until given data
3369  * @return string access key value
3370  */
3371 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3372     global $DB;
3374     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3375                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3376                                                          'validuntil'=>$validuntil))) {
3377         return $key->value;
3378     } else {
3379         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3380     }
3384 /**
3385  * Modify the user table by setting the currently logged in user's
3386  * last login to now.
3387  *
3388  * @global object
3389  * @global object
3390  * @return bool Always returns true
3391  */
3392 function update_user_login_times() {
3393     global $USER, $DB;
3395     if (isguestuser()) {
3396         // Do not update guest access times/ips for performance.
3397         return true;
3398     }
3400     $now = time();
3402     $user = new stdClass();
3403     $user->id = $USER->id;
3405     // Make sure all users that logged in have some firstaccess.
3406     if ($USER->firstaccess == 0) {
3407         $USER->firstaccess = $user->firstaccess = $now;
3408     }
3410     // Store the previous current as lastlogin.
3411     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3413     $USER->currentlogin = $user->currentlogin = $now;
3415     // Function user_accesstime_log() may not update immediately, better do it here.
3416     $USER->lastaccess = $user->lastaccess = $now;
3417     $USER->lastip = $user->lastip = getremoteaddr();
3419     $DB->update_record('user', $user);
3420     return true;
3423 /**
3424  * Determines if a user has completed setting up their account.
3425  *
3426  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3427  * @return bool
3428  */
3429 function user_not_fully_set_up($user) {
3430     if (isguestuser($user)) {
3431         return false;
3432     }
3433     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3436 /**
3437  * Check whether the user has exceeded the bounce threshold
3438  *
3439  * @global object
3440  * @global object
3441  * @param user $user A {@link $USER} object
3442  * @return bool true=>User has exceeded bounce threshold
3443  */
3444 function over_bounce_threshold($user) {
3445     global $CFG, $DB;
3447     if (empty($CFG->handlebounces)) {
3448         return false;
3449     }
3451     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3452         return false;
3453     }
3455     // set sensible defaults
3456     if (empty($CFG->minbounces)) {
3457         $CFG->minbounces = 10;
3458     }
3459     if (empty($CFG->bounceratio)) {
3460         $CFG->bounceratio = .20;
3461     }
3462     $bouncecount = 0;
3463     $sendcount = 0;
3464     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3465         $bouncecount = $bounce->value;
3466     }
3467     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3468         $sendcount = $send->value;
3469     }
3470     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3473 /**
3474  * Used to increment or reset email sent count
3475  *
3476  * @global object
3477  * @param user $user object containing an id
3478  * @param bool $reset will reset the count to 0
3479  * @return void
3480  */
3481 function set_send_count($user,$reset=false) {
3482     global $DB;
3484     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3485         return;
3486     }
3488     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3489         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3490         $DB->update_record('user_preferences', $pref);
3491     }
3492     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3493         // make a new one
3494         $pref = new stdClass();
3495         $pref->name   = 'email_send_count';
3496         $pref->value  = 1;
3497         $pref->userid = $user->id;
3498         $DB->insert_record('user_preferences', $pref, false);
3499     }
3502 /**
3503  * Increment or reset user's email bounce count
3504  *
3505  * @global object
3506  * @param user $user object containing an id
3507  * @param bool $reset will reset the count to 0
3508  */
3509 function set_bounce_count($user,$reset=false) {
3510     global $DB;
3512     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3513         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3514         $DB->update_record('user_preferences', $pref);
3515     }
3516     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3517         // make a new one
3518         $pref = new stdClass();
3519         $pref->name   = 'email_bounce_count';
3520         $pref->value  = 1;
3521         $pref->userid = $user->id;
3522         $DB->insert_record('user_preferences', $pref, false);
3523     }
3526 /**
3527  * Determines if the currently logged in user is in editing mode.
3528  * Note: originally this function had $userid parameter - it was not usable anyway
3529  *
3530  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3531  * @todo Deprecated function remove when ready
3532  *
3533  * @global object
3534  * @uses DEBUG_DEVELOPER
3535  * @return bool
3536  */
3537 function isediting() {
3538     global $PAGE;
3539     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3540     return $PAGE->user_is_editing();
3543 /**
3544  * Determines if the logged in user is currently moving an activity
3545  *
3546  * @global object
3547  * @param int $courseid The id of the course being tested
3548  * @return bool
3549  */
3550 function ismoving($courseid) {
3551     global $USER;
3553     if (!empty($USER->activitycopy)) {
3554         return ($USER->activitycopycourse == $courseid);
3555     }
3556     return false;
3559 /**
3560  * Returns a persons full name
3561  *
3562  * Given an object containing firstname and lastname
3563  * values, this function returns a string with the
3564  * full name of the person.
3565  * The result may depend on system settings
3566  * or language.  'override' will force both names
3567  * to be used even if system settings specify one.
3568  *
3569  * @global object
3570  * @global object
3571  * @param object $user A {@link $USER} object to get full name of
3572  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3573  * @return string
3574  */
3575 function fullname($user, $override=false) {
3576     global $CFG, $SESSION;
3578     if (!isset($user->firstname) and !isset($user->lastname)) {
3579         return '';
3580     }
3582     if (!$override) {
3583         if (!empty($CFG->forcefirstname)) {
3584             $user->firstname = $CFG->forcefirstname;
3585         }
3586         if (!empty($CFG->forcelastname)) {
3587             $user->lastname = $CFG->forcelastname;
3588         }
3589     }
3591     if (!empty($SESSION->fullnamedisplay)) {
3592         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3593     }
3595     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3596         return $user->firstname .' '. $user->lastname;
3598     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3599         return $user->lastname .' '. $user->firstname;
3601     } else if ($CFG->fullnamedisplay == 'firstname') {
3602         if ($override) {
3603             return get_string('fullnamedisplay', '', $user);
3604         } else {
3605             return $user->firstname;
3606         }
3607     }
3609     return get_string('fullnamedisplay', '', $user);
3612 /**
3613  * Checks if current user is shown any extra fields when listing users.
3614  * @param object $context Context
3615  * @param array $already Array of fields that we're going to show anyway
3616  *   so don't bother listing them
3617  * @return array Array of field names from user table, not including anything
3618  *   listed in $already
3619  */
3620 function get_extra_user_fields($context, $already = array()) {
3621     global $CFG;
3623     // Only users with permission get the extra fields
3624     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3625         return array();
3626     }
3628     // Split showuseridentity on comma
3629     if (empty($CFG->showuseridentity)) {
3630         // Explode gives wrong result with empty string
3631         $extra = array();
3632     } else {
3633         $extra =  explode(',', $CFG->showuseridentity);
3634     }
3635     $renumber = false;
3636     foreach ($extra as $key => $field) {
3637         if (in_array($field, $already)) {
3638             unset($extra[$key]);
3639             $renumber = true;
3640         }
3641     }
3642     if ($renumber) {
3643         // For consistency, if entries are removed from array, renumber it
3644         // so they are numbered as you would expect
3645         $extra = array_merge($extra);
3646     }
3647     return $extra;
3650 /**
3651  * If the current user is to be shown extra user fields when listing or
3652  * selecting users, returns a string suitable for including in an SQL select
3653  * clause to retrieve those fields.
3654  * @param object $context Context
3655  * @param string $alias Alias of user table, e.g. 'u' (default none)
3656  * @param