Merge branch 'wip-MDL-42098-master' of git://github.com/abgreeve/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.
74 /**
75  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
76  */
77 define('PARAM_ALPHA',    'alpha');
79 /**
80  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
81  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
82  */
83 define('PARAM_ALPHAEXT', 'alphaext');
85 /**
86  * PARAM_ALPHANUM - expected numbers and letters only.
87  */
88 define('PARAM_ALPHANUM', 'alphanum');
90 /**
91  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
92  */
93 define('PARAM_ALPHANUMEXT', 'alphanumext');
95 /**
96  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
97  */
98 define('PARAM_AUTH',  'auth');
100 /**
101  * PARAM_BASE64 - Base 64 encoded format
102  */
103 define('PARAM_BASE64',   'base64');
105 /**
106  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
107  */
108 define('PARAM_BOOL',     'bool');
110 /**
111  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
112  * checked against the list of capabilities in the database.
113  */
114 define('PARAM_CAPABILITY',   'capability');
116 /**
117  * PARAM_CLEANHTML - cleans submitted HTML code. Note that you almost never want
118  * to use this. The normal mode of operation is to use PARAM_RAW when recieving
119  * the input (required/optional_param or formslib) and then sanitse the HTML
120  * using format_text on output. This is for the rare cases when you want to
121  * sanitise the HTML on input. This cleaning may also fix xhtml strictness.
122  */
123 define('PARAM_CLEANHTML', 'cleanhtml');
125 /**
126  * PARAM_EMAIL - an email address following the RFC
127  */
128 define('PARAM_EMAIL',   'email');
130 /**
131  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
132  */
133 define('PARAM_FILE',   'file');
135 /**
136  * PARAM_FLOAT - a real/floating point number.
137  *
138  * Note that you should not use PARAM_FLOAT for numbers typed in by the user.
139  * It does not work for languages that use , as a decimal separator.
140  * Instead, do something like
141  *     $rawvalue = required_param('name', PARAM_RAW);
142  *     // ... other code including require_login, which sets current lang ...
143  *     $realvalue = unformat_float($rawvalue);
144  *     // ... then use $realvalue
145  */
146 define('PARAM_FLOAT',  'float');
148 /**
149  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
150  */
151 define('PARAM_HOST',     'host');
153 /**
154  * PARAM_INT - integers only, use when expecting only numbers.
155  */
156 define('PARAM_INT',      'int');
158 /**
159  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
160  */
161 define('PARAM_LANG',  'lang');
163 /**
164  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the
165  * others! Implies PARAM_URL!)
166  */
167 define('PARAM_LOCALURL', 'localurl');
169 /**
170  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
171  */
172 define('PARAM_NOTAGS',   'notags');
174 /**
175  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory
176  * traversals note: the leading slash is not removed, window drive letter is not allowed
177  */
178 define('PARAM_PATH',     'path');
180 /**
181  * PARAM_PEM - Privacy Enhanced Mail format
182  */
183 define('PARAM_PEM',      'pem');
185 /**
186  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
187  */
188 define('PARAM_PERMISSION',   'permission');
190 /**
191  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
192  */
193 define('PARAM_RAW', 'raw');
195 /**
196  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
197  */
198 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
200 /**
201  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
202  */
203 define('PARAM_SAFEDIR',  'safedir');
205 /**
206  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
207  */
208 define('PARAM_SAFEPATH',  'safepath');
210 /**
211  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
212  */
213 define('PARAM_SEQUENCE',  'sequence');
215 /**
216  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
217  */
218 define('PARAM_TAG',   'tag');
220 /**
221  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
222  */
223 define('PARAM_TAGLIST',   'taglist');
225 /**
226  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
227  */
228 define('PARAM_TEXT',  'text');
230 /**
231  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
232  */
233 define('PARAM_THEME',  'theme');
235 /**
236  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but
237  * 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
243  * accounts, do NOT use when syncing with external systems!!
244  */
245 define('PARAM_USERNAME',    'username');
247 /**
248  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
249  */
250 define('PARAM_STRINGID',    'stringid');
252 // DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE.
253 /**
254  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
255  * It was one of the first types, that is why it is abused so much ;-)
256  * @deprecated since 2.0
257  */
258 define('PARAM_CLEAN',    'clean');
260 /**
261  * PARAM_INTEGER - deprecated alias for PARAM_INT
262  * @deprecated since 2.0
263  */
264 define('PARAM_INTEGER',  'int');
266 /**
267  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
268  * @deprecated since 2.0
269  */
270 define('PARAM_NUMBER',  'float');
272 /**
273  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
274  * NOTE: originally alias for PARAM_APLHA
275  * @deprecated since 2.0
276  */
277 define('PARAM_ACTION',   'alphanumext');
279 /**
280  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
281  * NOTE: originally alias for PARAM_APLHA
282  * @deprecated since 2.0
283  */
284 define('PARAM_FORMAT',   'alphanumext');
286 /**
287  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
288  * @deprecated since 2.0
289  */
290 define('PARAM_MULTILANG',  'text');
292 /**
293  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
294  * string separated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
295  * America/Port-au-Prince)
296  */
297 define('PARAM_TIMEZONE', 'timezone');
299 /**
300  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
301  */
302 define('PARAM_CLEANFILE', 'file');
304 /**
305  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
306  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
307  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
308  * NOTE: numbers and underscores are strongly discouraged in plugin names!
309  */
310 define('PARAM_COMPONENT', 'component');
312 /**
313  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
314  * It is usually used together with context id and component.
315  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
316  */
317 define('PARAM_AREA', 'area');
319 /**
320  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
321  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
322  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
323  */
324 define('PARAM_PLUGIN', 'plugin');
327 // Web Services.
329 /**
330  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
331  */
332 define('VALUE_REQUIRED', 1);
334 /**
335  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
336  */
337 define('VALUE_OPTIONAL', 2);
339 /**
340  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
341  */
342 define('VALUE_DEFAULT', 0);
344 /**
345  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
346  */
347 define('NULL_NOT_ALLOWED', false);
349 /**
350  * NULL_ALLOWED - the parameter can be set to null in the database
351  */
352 define('NULL_ALLOWED', true);
354 // Page types.
356 /**
357  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
358  */
359 define('PAGE_COURSE_VIEW', 'course-view');
361 /** Get remote addr constant */
362 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
363 /** Get remote addr constant */
364 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
366 // Blog access level constant declaration.
367 define ('BLOG_USER_LEVEL', 1);
368 define ('BLOG_GROUP_LEVEL', 2);
369 define ('BLOG_COURSE_LEVEL', 3);
370 define ('BLOG_SITE_LEVEL', 4);
371 define ('BLOG_GLOBAL_LEVEL', 5);
374 // Tag constants.
375 /**
376  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
377  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
378  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
379  *
380  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
381  */
382 define('TAG_MAX_LENGTH', 50);
384 // Password policy constants.
385 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
386 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
387 define ('PASSWORD_DIGITS', '0123456789');
388 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
390 // Feature constants.
391 // Used for plugin_supports() to report features that are, or are not, supported by a module.
393 /** True if module can provide a grade */
394 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
395 /** True if module supports outcomes */
396 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
397 /** True if module supports advanced grading methods */
398 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
399 /** True if module controls the grade visibility over the gradebook */
400 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
401 /** True if module supports plagiarism plugins */
402 define('FEATURE_PLAGIARISM', 'plagiarism');
404 /** True if module has code to track whether somebody viewed it */
405 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
406 /** True if module has custom completion rules */
407 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
409 /** True if module has no 'view' page (like label) */
410 define('FEATURE_NO_VIEW_LINK', 'viewlink');
411 /** True if module supports outcomes */
412 define('FEATURE_IDNUMBER', 'idnumber');
413 /** True if module supports groups */
414 define('FEATURE_GROUPS', 'groups');
415 /** True if module supports groupings */
416 define('FEATURE_GROUPINGS', 'groupings');
417 /** True if module supports groupmembersonly */
418 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
420 /** Type of module */
421 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
422 /** True if module supports intro editor */
423 define('FEATURE_MOD_INTRO', 'mod_intro');
424 /** True if module has default completion */
425 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
427 define('FEATURE_COMMENT', 'comment');
429 define('FEATURE_RATE', 'rate');
430 /** True if module supports backup/restore of moodle2 format */
431 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
433 /** True if module can show description on course main page */
434 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
436 /** True if module uses the question bank */
437 define('FEATURE_USES_QUESTIONS', 'usesquestions');
439 /** Unspecified module archetype */
440 define('MOD_ARCHETYPE_OTHER', 0);
441 /** Resource-like type module */
442 define('MOD_ARCHETYPE_RESOURCE', 1);
443 /** Assignment module archetype */
444 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
445 /** System (not user-addable) module archetype */
446 define('MOD_ARCHETYPE_SYSTEM', 3);
448 /** Return this from modname_get_types callback to use default display in activity chooser */
449 define('MOD_SUBTYPE_NO_CHILDREN', 'modsubtypenochildren');
451 /**
452  * Security token used for allowing access
453  * from external application such as web services.
454  * Scripts do not use any session, performance is relatively
455  * low because we need to load access info in each request.
456  * Scripts are executed in parallel.
457  */
458 define('EXTERNAL_TOKEN_PERMANENT', 0);
460 /**
461  * Security token used for allowing access
462  * of embedded applications, the code is executed in the
463  * active user session. Token is invalidated after user logs out.
464  * Scripts are executed serially - normal session locking is used.
465  */
466 define('EXTERNAL_TOKEN_EMBEDDED', 1);
468 /**
469  * The home page should be the site home
470  */
471 define('HOMEPAGE_SITE', 0);
472 /**
473  * The home page should be the users my page
474  */
475 define('HOMEPAGE_MY', 1);
476 /**
477  * The home page can be chosen by the user
478  */
479 define('HOMEPAGE_USER', 2);
481 /**
482  * Hub directory url (should be moodle.org)
483  */
484 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
487 /**
488  * Moodle.org url (should be moodle.org)
489  */
490 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
492 /**
493  * Moodle mobile app service name
494  */
495 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
497 /**
498  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
499  */
500 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
502 /**
503  * Course display settings: display all sections on one page.
504  */
505 define('COURSE_DISPLAY_SINGLEPAGE', 0);
506 /**
507  * Course display settings: split pages into a page per section.
508  */
509 define('COURSE_DISPLAY_MULTIPAGE', 1);
511 /**
512  * Authentication constant: String used in password field when password is not stored.
513  */
514 define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
516 // PARAMETER HANDLING.
518 /**
519  * Returns a particular value for the named variable, taken from
520  * POST or GET.  If the parameter doesn't exist then an error is
521  * thrown because we require this variable.
522  *
523  * This function should be used to initialise all required values
524  * in a script that are based on parameters.  Usually it will be
525  * used like this:
526  *    $id = required_param('id', PARAM_INT);
527  *
528  * Please note the $type parameter is now required and the value can not be array.
529  *
530  * @param string $parname the name of the page parameter we want
531  * @param string $type expected type of parameter
532  * @return mixed
533  * @throws coding_exception
534  */
535 function required_param($parname, $type) {
536     if (func_num_args() != 2 or empty($parname) or empty($type)) {
537         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
538     }
539     // POST has precedence.
540     if (isset($_POST[$parname])) {
541         $param = $_POST[$parname];
542     } else if (isset($_GET[$parname])) {
543         $param = $_GET[$parname];
544     } else {
545         print_error('missingparam', '', '', $parname);
546     }
548     if (is_array($param)) {
549         debugging('Invalid array parameter detected in required_param(): '.$parname);
550         // TODO: switch to fatal error in Moodle 2.3.
551         return required_param_array($parname, $type);
552     }
554     return clean_param($param, $type);
557 /**
558  * Returns a particular array value for the named variable, taken from
559  * POST or GET.  If the parameter doesn't exist then an error is
560  * thrown because we require this variable.
561  *
562  * This function should be used to initialise all required values
563  * in a script that are based on parameters.  Usually it will be
564  * used like this:
565  *    $ids = required_param_array('ids', PARAM_INT);
566  *
567  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
568  *
569  * @param string $parname the name of the page parameter we want
570  * @param string $type expected type of parameter
571  * @return array
572  * @throws coding_exception
573  */
574 function required_param_array($parname, $type) {
575     if (func_num_args() != 2 or empty($parname) or empty($type)) {
576         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
577     }
578     // POST has precedence.
579     if (isset($_POST[$parname])) {
580         $param = $_POST[$parname];
581     } else if (isset($_GET[$parname])) {
582         $param = $_GET[$parname];
583     } else {
584         print_error('missingparam', '', '', $parname);
585     }
586     if (!is_array($param)) {
587         print_error('missingparam', '', '', $parname);
588     }
590     $result = array();
591     foreach ($param as $key => $value) {
592         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
593             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
594             continue;
595         }
596         $result[$key] = clean_param($value, $type);
597     }
599     return $result;
602 /**
603  * Returns a particular value for the named variable, taken from
604  * POST or GET, otherwise returning a given default.
605  *
606  * This function should be used to initialise all optional values
607  * in a script that are based on parameters.  Usually it will be
608  * used like this:
609  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
610  *
611  * Please note the $type parameter is now required and the value can not be array.
612  *
613  * @param string $parname the name of the page parameter we want
614  * @param mixed  $default the default value to return if nothing is found
615  * @param string $type expected type of parameter
616  * @return mixed
617  * @throws coding_exception
618  */
619 function optional_param($parname, $default, $type) {
620     if (func_num_args() != 3 or empty($parname) or empty($type)) {
621         throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
622     }
623     if (!isset($default)) {
624         $default = null;
625     }
627     // POST has precedence.
628     if (isset($_POST[$parname])) {
629         $param = $_POST[$parname];
630     } else if (isset($_GET[$parname])) {
631         $param = $_GET[$parname];
632     } else {
633         return $default;
634     }
636     if (is_array($param)) {
637         debugging('Invalid array parameter detected in required_param(): '.$parname);
638         // TODO: switch to $default in Moodle 2.3.
639         return optional_param_array($parname, $default, $type);
640     }
642     return clean_param($param, $type);
645 /**
646  * Returns a particular array value for the named variable, taken from
647  * POST or GET, otherwise returning a given default.
648  *
649  * This function should be used to initialise all optional values
650  * in a script that are based on parameters.  Usually it will be
651  * used like this:
652  *    $ids = optional_param('id', array(), PARAM_INT);
653  *
654  * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
655  *
656  * @param string $parname the name of the page parameter we want
657  * @param mixed $default the default value to return if nothing is found
658  * @param string $type expected type of parameter
659  * @return array
660  * @throws coding_exception
661  */
662 function optional_param_array($parname, $default, $type) {
663     if (func_num_args() != 3 or empty($parname) or empty($type)) {
664         throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
665     }
667     // POST has precedence.
668     if (isset($_POST[$parname])) {
669         $param = $_POST[$parname];
670     } else if (isset($_GET[$parname])) {
671         $param = $_GET[$parname];
672     } else {
673         return $default;
674     }
675     if (!is_array($param)) {
676         debugging('optional_param_array() expects array parameters only: '.$parname);
677         return $default;
678     }
680     $result = array();
681     foreach ($param as $key => $value) {
682         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
683             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
684             continue;
685         }
686         $result[$key] = clean_param($value, $type);
687     }
689     return $result;
692 /**
693  * Strict validation of parameter values, the values are only converted
694  * to requested PHP type. Internally it is using clean_param, the values
695  * before and after cleaning must be equal - otherwise
696  * an invalid_parameter_exception is thrown.
697  * Objects and classes are not accepted.
698  *
699  * @param mixed $param
700  * @param string $type PARAM_ constant
701  * @param bool $allownull are nulls valid value?
702  * @param string $debuginfo optional debug information
703  * @return mixed the $param value converted to PHP type
704  * @throws invalid_parameter_exception if $param is not of given type
705  */
706 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
707     if (is_null($param)) {
708         if ($allownull == NULL_ALLOWED) {
709             return null;
710         } else {
711             throw new invalid_parameter_exception($debuginfo);
712         }
713     }
714     if (is_array($param) or is_object($param)) {
715         throw new invalid_parameter_exception($debuginfo);
716     }
718     $cleaned = clean_param($param, $type);
720     if ($type == PARAM_FLOAT) {
721         // Do not detect precision loss here.
722         if (is_float($param) or is_int($param)) {
723             // These always fit.
724         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
725             throw new invalid_parameter_exception($debuginfo);
726         }
727     } else if ((string)$param !== (string)$cleaned) {
728         // Conversion to string is usually lossless.
729         throw new invalid_parameter_exception($debuginfo);
730     }
732     return $cleaned;
735 /**
736  * Makes sure array contains only the allowed types, this function does not validate array key names!
737  *
738  * <code>
739  * $options = clean_param($options, PARAM_INT);
740  * </code>
741  *
742  * @param array $param the variable array we are cleaning
743  * @param string $type expected format of param after cleaning.
744  * @param bool $recursive clean recursive arrays
745  * @return array
746  * @throws coding_exception
747  */
748 function clean_param_array(array $param = null, $type, $recursive = false) {
749     // Convert null to empty array.
750     $param = (array)$param;
751     foreach ($param as $key => $value) {
752         if (is_array($value)) {
753             if ($recursive) {
754                 $param[$key] = clean_param_array($value, $type, true);
755             } else {
756                 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
757             }
758         } else {
759             $param[$key] = clean_param($value, $type);
760         }
761     }
762     return $param;
765 /**
766  * Used by {@link optional_param()} and {@link required_param()} to
767  * clean the variables and/or cast to specific types, based on
768  * an options field.
769  * <code>
770  * $course->format = clean_param($course->format, PARAM_ALPHA);
771  * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
772  * </code>
773  *
774  * @param mixed $param the variable we are cleaning
775  * @param string $type expected format of param after cleaning.
776  * @return mixed
777  * @throws coding_exception
778  */
779 function clean_param($param, $type) {
780     global $CFG;
782     if (is_array($param)) {
783         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
784     } else if (is_object($param)) {
785         if (method_exists($param, '__toString')) {
786             $param = $param->__toString();
787         } else {
788             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
789         }
790     }
792     switch ($type) {
793         case PARAM_RAW:
794             // No cleaning at all.
795             $param = fix_utf8($param);
796             return $param;
798         case PARAM_RAW_TRIMMED:
799             // No cleaning, but strip leading and trailing whitespace.
800             $param = fix_utf8($param);
801             return trim($param);
803         case PARAM_CLEAN:
804             // General HTML cleaning, try to use more specific type if possible this is deprecated!
805             // Please use more specific type instead.
806             if (is_numeric($param)) {
807                 return $param;
808             }
809             $param = fix_utf8($param);
810             // Sweep for scripts, etc.
811             return clean_text($param);
813         case PARAM_CLEANHTML:
814             // Clean html fragment.
815             $param = fix_utf8($param);
816             // Sweep for scripts, etc.
817             $param = clean_text($param, FORMAT_HTML);
818             return trim($param);
820         case PARAM_INT:
821             // Convert to integer.
822             return (int)$param;
824         case PARAM_FLOAT:
825             // Convert to float.
826             return (float)$param;
828         case PARAM_ALPHA:
829             // Remove everything not `a-z`.
830             return preg_replace('/[^a-zA-Z]/i', '', $param);
832         case PARAM_ALPHAEXT:
833             // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
834             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
836         case PARAM_ALPHANUM:
837             // Remove everything not `a-zA-Z0-9`.
838             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
840         case PARAM_ALPHANUMEXT:
841             // Remove everything not `a-zA-Z0-9_-`.
842             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
844         case PARAM_SEQUENCE:
845             // Remove everything not `0-9,`.
846             return preg_replace('/[^0-9,]/i', '', $param);
848         case PARAM_BOOL:
849             // Convert to 1 or 0.
850             $tempstr = strtolower($param);
851             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
852                 $param = 1;
853             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
854                 $param = 0;
855             } else {
856                 $param = empty($param) ? 0 : 1;
857             }
858             return $param;
860         case PARAM_NOTAGS:
861             // Strip all tags.
862             $param = fix_utf8($param);
863             return strip_tags($param);
865         case PARAM_TEXT:
866             // Leave only tags needed for multilang.
867             $param = fix_utf8($param);
868             // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
869             // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
870             do {
871                 if (strpos($param, '</lang>') !== false) {
872                     // Old and future mutilang syntax.
873                     $param = strip_tags($param, '<lang>');
874                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
875                         break;
876                     }
877                     $open = false;
878                     foreach ($matches[0] as $match) {
879                         if ($match === '</lang>') {
880                             if ($open) {
881                                 $open = false;
882                                 continue;
883                             } else {
884                                 break 2;
885                             }
886                         }
887                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
888                             break 2;
889                         } else {
890                             $open = true;
891                         }
892                     }
893                     if ($open) {
894                         break;
895                     }
896                     return $param;
898                 } else if (strpos($param, '</span>') !== false) {
899                     // Current problematic multilang syntax.
900                     $param = strip_tags($param, '<span>');
901                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
902                         break;
903                     }
904                     $open = false;
905                     foreach ($matches[0] as $match) {
906                         if ($match === '</span>') {
907                             if ($open) {
908                                 $open = false;
909                                 continue;
910                             } else {
911                                 break 2;
912                             }
913                         }
914                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
915                             break 2;
916                         } else {
917                             $open = true;
918                         }
919                     }
920                     if ($open) {
921                         break;
922                     }
923                     return $param;
924                 }
925             } while (false);
926             // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
927             return strip_tags($param);
929         case PARAM_COMPONENT:
930             // We do not want any guessing here, either the name is correct or not
931             // please note only normalised component names are accepted.
932             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
933                 return '';
934             }
935             if (strpos($param, '__') !== false) {
936                 return '';
937             }
938             if (strpos($param, 'mod_') === 0) {
939                 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
940                 if (substr_count($param, '_') != 1) {
941                     return '';
942                 }
943             }
944             return $param;
946         case PARAM_PLUGIN:
947         case PARAM_AREA:
948             // We do not want any guessing here, either the name is correct or not.
949             if (!is_valid_plugin_name($param)) {
950                 return '';
951             }
952             return $param;
954         case PARAM_SAFEDIR:
955             // Remove everything not a-zA-Z0-9_- .
956             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
958         case PARAM_SAFEPATH:
959             // Remove everything not a-zA-Z0-9/_- .
960             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
962         case PARAM_FILE:
963             // Strip all suspicious characters from filename.
964             $param = fix_utf8($param);
965             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
966             if ($param === '.' || $param === '..') {
967                 $param = '';
968             }
969             return $param;
971         case PARAM_PATH:
972             // Strip all suspicious characters from file path.
973             $param = fix_utf8($param);
974             $param = str_replace('\\', '/', $param);
976             // Explode the path and clean each element using the PARAM_FILE rules.
977             $breadcrumb = explode('/', $param);
978             foreach ($breadcrumb as $key => $crumb) {
979                 if ($crumb === '.' && $key === 0) {
980                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
981                 } else {
982                     $crumb = clean_param($crumb, PARAM_FILE);
983                 }
984                 $breadcrumb[$key] = $crumb;
985             }
986             $param = implode('/', $breadcrumb);
988             // Remove multiple current path (./././) and multiple slashes (///).
989             $param = preg_replace('~//+~', '/', $param);
990             $param = preg_replace('~/(\./)+~', '/', $param);
991             return $param;
993         case PARAM_HOST:
994             // Allow FQDN or IPv4 dotted quad.
995             $param = preg_replace('/[^\.\d\w-]/', '', $param );
996             // Match ipv4 dotted quad.
997             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
998                 // Confirm values are ok.
999                 if ( $match[0] > 255
1000                      || $match[1] > 255
1001                      || $match[3] > 255
1002                      || $match[4] > 255 ) {
1003                     // Hmmm, what kind of dotted quad is this?
1004                     $param = '';
1005                 }
1006             } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1007                        && !preg_match('/^[\.-]/',  $param) // No leading dots/hyphens.
1008                        && !preg_match('/[\.-]$/',  $param) // No trailing dots/hyphens.
1009                        ) {
1010                 // All is ok - $param is respected.
1011             } else {
1012                 // All is not ok...
1013                 $param='';
1014             }
1015             return $param;
1017         case PARAM_URL:          // Allow safe ftp, http, mailto urls.
1018             $param = fix_utf8($param);
1019             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
1020             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
1021                 // All is ok, param is respected.
1022             } else {
1023                 // Not really ok.
1024                 $param ='';
1025             }
1026             return $param;
1028         case PARAM_LOCALURL:
1029             // Allow http absolute, root relative and relative URLs within wwwroot.
1030             $param = clean_param($param, PARAM_URL);
1031             if (!empty($param)) {
1032                 if (preg_match(':^/:', $param)) {
1033                     // Root-relative, ok!
1034                 } else if (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i', $param)) {
1035                     // Absolute, and matches our wwwroot.
1036                 } else {
1037                     // Relative - let's make sure there are no tricks.
1038                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1039                         // Looks ok.
1040                     } else {
1041                         $param = '';
1042                     }
1043                 }
1044             }
1045             return $param;
1047         case PARAM_PEM:
1048             $param = trim($param);
1049             // PEM formatted strings may contain letters/numbers and the symbols:
1050             //   forward slash: /
1051             //   plus sign:     +
1052             //   equal sign:    =
1053             //   , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
1054             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1055                 list($wholething, $body) = $matches;
1056                 unset($wholething, $matches);
1057                 $b64 = clean_param($body, PARAM_BASE64);
1058                 if (!empty($b64)) {
1059                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1060                 } else {
1061                     return '';
1062                 }
1063             }
1064             return '';
1066         case PARAM_BASE64:
1067             if (!empty($param)) {
1068                 // PEM formatted strings may contain letters/numbers and the symbols
1069                 //   forward slash: /
1070                 //   plus sign:     +
1071                 //   equal sign:    =.
1072                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1073                     return '';
1074                 }
1075                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1076                 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1077                 // than (or equal to) 64 characters long.
1078                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1079                     if ($i + 1 == $j) {
1080                         if (64 < strlen($lines[$i])) {
1081                             return '';
1082                         }
1083                         continue;
1084                     }
1086                     if (64 != strlen($lines[$i])) {
1087                         return '';
1088                     }
1089                 }
1090                 return implode("\n", $lines);
1091             } else {
1092                 return '';
1093             }
1095         case PARAM_TAG:
1096             $param = fix_utf8($param);
1097             // Please note it is not safe to use the tag name directly anywhere,
1098             // it must be processed with s(), urlencode() before embedding anywhere.
1099             // Remove some nasties.
1100             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1101             // Convert many whitespace chars into one.
1102             $param = preg_replace('/\s+/', ' ', $param);
1103             $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
1104             return $param;
1106         case PARAM_TAGLIST:
1107             $param = fix_utf8($param);
1108             $tags = explode(',', $param);
1109             $result = array();
1110             foreach ($tags as $tag) {
1111                 $res = clean_param($tag, PARAM_TAG);
1112                 if ($res !== '') {
1113                     $result[] = $res;
1114                 }
1115             }
1116             if ($result) {
1117                 return implode(',', $result);
1118             } else {
1119                 return '';
1120             }
1122         case PARAM_CAPABILITY:
1123             if (get_capability_info($param)) {
1124                 return $param;
1125             } else {
1126                 return '';
1127             }
1129         case PARAM_PERMISSION:
1130             $param = (int)$param;
1131             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1132                 return $param;
1133             } else {
1134                 return CAP_INHERIT;
1135             }
1137         case PARAM_AUTH:
1138             $param = clean_param($param, PARAM_PLUGIN);
1139             if (empty($param)) {
1140                 return '';
1141             } else if (exists_auth_plugin($param)) {
1142                 return $param;
1143             } else {
1144                 return '';
1145             }
1147         case PARAM_LANG:
1148             $param = clean_param($param, PARAM_SAFEDIR);
1149             if (get_string_manager()->translation_exists($param)) {
1150                 return $param;
1151             } else {
1152                 // Specified language is not installed or param malformed.
1153                 return '';
1154             }
1156         case PARAM_THEME:
1157             $param = clean_param($param, PARAM_PLUGIN);
1158             if (empty($param)) {
1159                 return '';
1160             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1161                 return $param;
1162             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1163                 return $param;
1164             } else {
1165                 // Specified theme is not installed.
1166                 return '';
1167             }
1169         case PARAM_USERNAME:
1170             $param = fix_utf8($param);
1171             $param = str_replace(" " , "", $param);
1172             // Convert uppercase to lowercase MDL-16919.
1173             $param = core_text::strtolower($param);
1174             if (empty($CFG->extendedusernamechars)) {
1175                 // Regular expression, eliminate all chars EXCEPT:
1176                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1177                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1178             }
1179             return $param;
1181         case PARAM_EMAIL:
1182             $param = fix_utf8($param);
1183             if (validate_email($param)) {
1184                 return $param;
1185             } else {
1186                 return '';
1187             }
1189         case PARAM_STRINGID:
1190             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1191                 return $param;
1192             } else {
1193                 return '';
1194             }
1196         case PARAM_TIMEZONE:
1197             // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
1198             $param = fix_utf8($param);
1199             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1200             if (preg_match($timezonepattern, $param)) {
1201                 return $param;
1202             } else {
1203                 return '';
1204             }
1206         default:
1207             // Doh! throw error, switched parameters in optional_param or another serious problem.
1208             print_error("unknownparamtype", '', '', $type);
1209     }
1212 /**
1213  * Makes sure the data is using valid utf8, invalid characters are discarded.
1214  *
1215  * Note: this function is not intended for full objects with methods and private properties.
1216  *
1217  * @param mixed $value
1218  * @return mixed with proper utf-8 encoding
1219  */
1220 function fix_utf8($value) {
1221     if (is_null($value) or $value === '') {
1222         return $value;
1224     } else if (is_string($value)) {
1225         if ((string)(int)$value === $value) {
1226             // Shortcut.
1227             return $value;
1228         }
1229         // No null bytes expected in our data, so let's remove it.
1230         $value = str_replace("\0", '', $value);
1232         // Lower error reporting because glibc throws bogus notices.
1233         $olderror = error_reporting();
1234         if ($olderror & E_NOTICE) {
1235             error_reporting($olderror ^ E_NOTICE);
1236         }
1238         // Note: this duplicates min_fix_utf8() intentionally.
1239         static $buggyiconv = null;
1240         if ($buggyiconv === null) {
1241             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1242         }
1244         if ($buggyiconv) {
1245             if (function_exists('mb_convert_encoding')) {
1246                 $subst = mb_substitute_character();
1247                 mb_substitute_character('');
1248                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1249                 mb_substitute_character($subst);
1251             } else {
1252                 // Warn admins on admin/index.php page.
1253                 $result = $value;
1254             }
1256         } else {
1257             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1258         }
1260         if ($olderror & E_NOTICE) {
1261             error_reporting($olderror);
1262         }
1264         return $result;
1266     } else if (is_array($value)) {
1267         foreach ($value as $k => $v) {
1268             $value[$k] = fix_utf8($v);
1269         }
1270         return $value;
1272     } else if (is_object($value)) {
1273         // Do not modify original.
1274         $value = clone($value);
1275         foreach ($value as $k => $v) {
1276             $value->$k = fix_utf8($v);
1277         }
1278         return $value;
1280     } else {
1281         // This is some other type, no utf-8 here.
1282         return $value;
1283     }
1286 /**
1287  * Return true if given value is integer or string with integer value
1288  *
1289  * @param mixed $value String or Int
1290  * @return bool true if number, false if not
1291  */
1292 function is_number($value) {
1293     if (is_int($value)) {
1294         return true;
1295     } else if (is_string($value)) {
1296         return ((string)(int)$value) === $value;
1297     } else {
1298         return false;
1299     }
1302 /**
1303  * Returns host part from url.
1304  *
1305  * @param string $url full url
1306  * @return string host, null if not found
1307  */
1308 function get_host_from_url($url) {
1309     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1310     if ($matches) {
1311         return $matches[1];
1312     }
1313     return null;
1316 /**
1317  * Tests whether anything was returned by text editor
1318  *
1319  * This function is useful for testing whether something you got back from
1320  * the HTML editor actually contains anything. Sometimes the HTML editor
1321  * appear to be empty, but actually you get back a <br> tag or something.
1322  *
1323  * @param string $string a string containing HTML.
1324  * @return boolean does the string contain any actual content - that is text,
1325  * images, objects, etc.
1326  */
1327 function html_is_blank($string) {
1328     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1331 /**
1332  * Set a key in global configuration
1333  *
1334  * Set a key/value pair in both this session's {@link $CFG} global variable
1335  * and in the 'config' database table for future sessions.
1336  *
1337  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1338  * In that case it doesn't affect $CFG.
1339  *
1340  * A NULL value will delete the entry.
1341  *
1342  * @param string $name the key to set
1343  * @param string $value the value to set (without magic quotes)
1344  * @param string $plugin (optional) the plugin scope, default null
1345  * @return bool true or exception
1346  */
1347 function set_config($name, $value, $plugin=null) {
1348     global $CFG, $DB;
1350     if (empty($plugin)) {
1351         if (!array_key_exists($name, $CFG->config_php_settings)) {
1352             // So it's defined for this invocation at least.
1353             if (is_null($value)) {
1354                 unset($CFG->$name);
1355             } else {
1356                 // Settings from db are always strings.
1357                 $CFG->$name = (string)$value;
1358             }
1359         }
1361         if ($DB->get_field('config', 'name', array('name' => $name))) {
1362             if ($value === null) {
1363                 $DB->delete_records('config', array('name' => $name));
1364             } else {
1365                 $DB->set_field('config', 'value', $value, array('name' => $name));
1366             }
1367         } else {
1368             if ($value !== null) {
1369                 $config = new stdClass();
1370                 $config->name  = $name;
1371                 $config->value = $value;
1372                 $DB->insert_record('config', $config, false);
1373             }
1374         }
1375         if ($name === 'siteidentifier') {
1376             cache_helper::update_site_identifier($value);
1377         }
1378         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1379     } else {
1380         // Plugin scope.
1381         if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
1382             if ($value===null) {
1383                 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1384             } else {
1385                 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
1386             }
1387         } else {
1388             if ($value !== null) {
1389                 $config = new stdClass();
1390                 $config->plugin = $plugin;
1391                 $config->name   = $name;
1392                 $config->value  = $value;
1393                 $DB->insert_record('config_plugins', $config, false);
1394             }
1395         }
1396         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1397     }
1399     return true;
1402 /**
1403  * Get configuration values from the global config table
1404  * or the config_plugins table.
1405  *
1406  * If called with one parameter, it will load all the config
1407  * variables for one plugin, and return them as an object.
1408  *
1409  * If called with 2 parameters it will return a string single
1410  * value or false if the value is not found.
1411  *
1412  * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
1413  *     that we need only fetch it once per request.
1414  * @param string $plugin full component name
1415  * @param string $name default null
1416  * @return mixed hash-like object or single value, return false no config found
1417  * @throws dml_exception
1418  */
1419 function get_config($plugin, $name = null) {
1420     global $CFG, $DB;
1422     static $siteidentifier = null;
1424     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1425         $forced =& $CFG->config_php_settings;
1426         $iscore = true;
1427         $plugin = 'core';
1428     } else {
1429         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1430             $forced =& $CFG->forced_plugin_settings[$plugin];
1431         } else {
1432             $forced = array();
1433         }
1434         $iscore = false;
1435     }
1437     if ($siteidentifier === null) {
1438         try {
1439             // This may fail during installation.
1440             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1441             // install the database.
1442             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1443         } catch (dml_exception $ex) {
1444             // Set siteidentifier to false. We don't want to trip this continually.
1445             $siteidentifier = false;
1446             throw $ex;
1447         }
1448     }
1450     if (!empty($name)) {
1451         if (array_key_exists($name, $forced)) {
1452             return (string)$forced[$name];
1453         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1454             return $siteidentifier;
1455         }
1456     }
1458     $cache = cache::make('core', 'config');
1459     $result = $cache->get($plugin);
1460     if ($result === false) {
1461         // The user is after a recordset.
1462         if (!$iscore) {
1463             $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
1464         } else {
1465             // This part is not really used any more, but anyway...
1466             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1467         }
1468         $cache->set($plugin, $result);
1469     }
1471     if (!empty($name)) {
1472         if (array_key_exists($name, $result)) {
1473             return $result[$name];
1474         }
1475         return false;
1476     }
1478     if ($plugin === 'core') {
1479         $result['siteidentifier'] = $siteidentifier;
1480     }
1482     foreach ($forced as $key => $value) {
1483         if (is_null($value) or is_array($value) or is_object($value)) {
1484             // We do not want any extra mess here, just real settings that could be saved in db.
1485             unset($result[$key]);
1486         } else {
1487             // Convert to string as if it went through the DB.
1488             $result[$key] = (string)$value;
1489         }
1490     }
1492     return (object)$result;
1495 /**
1496  * Removes a key from global configuration.
1497  *
1498  * @param string $name the key to set
1499  * @param string $plugin (optional) the plugin scope
1500  * @return boolean whether the operation succeeded.
1501  */
1502 function unset_config($name, $plugin=null) {
1503     global $CFG, $DB;
1505     if (empty($plugin)) {
1506         unset($CFG->$name);
1507         $DB->delete_records('config', array('name' => $name));
1508         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1509     } else {
1510         $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1511         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1512     }
1514     return true;
1517 /**
1518  * Remove all the config variables for a given plugin.
1519  *
1520  * NOTE: this function is called from lib/db/upgrade.php
1521  *
1522  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1523  * @return boolean whether the operation succeeded.
1524  */
1525 function unset_all_config_for_plugin($plugin) {
1526     global $DB;
1527     // Delete from the obvious config_plugins first.
1528     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1529     // Next delete any suspect settings from config.
1530     $like = $DB->sql_like('name', '?', true, true, false, '|');
1531     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1532     $DB->delete_records_select('config', $like, $params);
1533     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1534     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1536     return true;
1539 /**
1540  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1541  *
1542  * All users are verified if they still have the necessary capability.
1543  *
1544  * @param string $value the value of the config setting.
1545  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1546  * @param bool $includeadmins include administrators.
1547  * @return array of user objects.
1548  */
1549 function get_users_from_config($value, $capability, $includeadmins = true) {
1550     if (empty($value) or $value === '$@NONE@$') {
1551         return array();
1552     }
1554     // We have to make sure that users still have the necessary capability,
1555     // it should be faster to fetch them all first and then test if they are present
1556     // instead of validating them one-by-one.
1557     $users = get_users_by_capability(context_system::instance(), $capability);
1558     if ($includeadmins) {
1559         $admins = get_admins();
1560         foreach ($admins as $admin) {
1561             $users[$admin->id] = $admin;
1562         }
1563     }
1565     if ($value === '$@ALL@$') {
1566         return $users;
1567     }
1569     $result = array(); // Result in correct order.
1570     $allowed = explode(',', $value);
1571     foreach ($allowed as $uid) {
1572         if (isset($users[$uid])) {
1573             $user = $users[$uid];
1574             $result[$user->id] = $user;
1575         }
1576     }
1578     return $result;
1582 /**
1583  * Invalidates browser caches and cached data in temp.
1584  *
1585  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1586  * {@link phpunit_util::reset_dataroot()}
1587  *
1588  * @return void
1589  */
1590 function purge_all_caches() {
1591     global $CFG, $DB;
1593     reset_text_filters_cache();
1594     js_reset_all_caches();
1595     theme_reset_all_caches();
1596     get_string_manager()->reset_caches();
1597     core_text::reset_caches();
1598     if (class_exists('core_plugin_manager')) {
1599         core_plugin_manager::reset_caches();
1600     }
1602     // Bump up cacherev field for all courses.
1603     try {
1604         increment_revision_number('course', 'cacherev', '');
1605     } catch (moodle_exception $e) {
1606         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1607     }
1609     $DB->reset_caches();
1610     cache_helper::purge_all();
1612     // Purge all other caches: rss, simplepie, etc.
1613     remove_dir($CFG->cachedir.'', true);
1615     // Make sure cache dir is writable, throws exception if not.
1616     make_cache_directory('');
1618     // This is the only place where we purge local caches, we are only adding files there.
1619     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1620     remove_dir($CFG->localcachedir, true);
1621     set_config('localcachedirpurged', time());
1622     make_localcache_directory('', true);
1625 /**
1626  * Get volatile flags
1627  *
1628  * @param string $type
1629  * @param int $changedsince default null
1630  * @return array records array
1631  */
1632 function get_cache_flags($type, $changedsince = null) {
1633     global $DB;
1635     $params = array('type' => $type, 'expiry' => time());
1636     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1637     if ($changedsince !== null) {
1638         $params['changedsince'] = $changedsince;
1639         $sqlwhere .= " AND timemodified > :changedsince";
1640     }
1641     $cf = array();
1642     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1643         foreach ($flags as $flag) {
1644             $cf[$flag->name] = $flag->value;
1645         }
1646     }
1647     return $cf;
1650 /**
1651  * Get volatile flags
1652  *
1653  * @param string $type
1654  * @param string $name
1655  * @param int $changedsince default null
1656  * @return string|false The cache flag value or false
1657  */
1658 function get_cache_flag($type, $name, $changedsince=null) {
1659     global $DB;
1661     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1663     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1664     if ($changedsince !== null) {
1665         $params['changedsince'] = $changedsince;
1666         $sqlwhere .= " AND timemodified > :changedsince";
1667     }
1669     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1672 /**
1673  * Set a volatile flag
1674  *
1675  * @param string $type the "type" namespace for the key
1676  * @param string $name the key to set
1677  * @param string $value the value to set (without magic quotes) - null will remove the flag
1678  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1679  * @return bool Always returns true
1680  */
1681 function set_cache_flag($type, $name, $value, $expiry = null) {
1682     global $DB;
1684     $timemodified = time();
1685     if ($expiry === null || $expiry < $timemodified) {
1686         $expiry = $timemodified + 24 * 60 * 60;
1687     } else {
1688         $expiry = (int)$expiry;
1689     }
1691     if ($value === null) {
1692         unset_cache_flag($type, $name);
1693         return true;
1694     }
1696     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1697         // This is a potential problem in DEBUG_DEVELOPER.
1698         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1699             return true; // No need to update.
1700         }
1701         $f->value        = $value;
1702         $f->expiry       = $expiry;
1703         $f->timemodified = $timemodified;
1704         $DB->update_record('cache_flags', $f);
1705     } else {
1706         $f = new stdClass();
1707         $f->flagtype     = $type;
1708         $f->name         = $name;
1709         $f->value        = $value;
1710         $f->expiry       = $expiry;
1711         $f->timemodified = $timemodified;
1712         $DB->insert_record('cache_flags', $f);
1713     }
1714     return true;
1717 /**
1718  * Removes a single volatile flag
1719  *
1720  * @param string $type the "type" namespace for the key
1721  * @param string $name the key to set
1722  * @return bool
1723  */
1724 function unset_cache_flag($type, $name) {
1725     global $DB;
1726     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1727     return true;
1730 /**
1731  * Garbage-collect volatile flags
1732  *
1733  * @return bool Always returns true
1734  */
1735 function gc_cache_flags() {
1736     global $DB;
1737     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1738     return true;
1741 // USER PREFERENCE API.
1743 /**
1744  * Refresh user preference cache. This is used most often for $USER
1745  * object that is stored in session, but it also helps with performance in cron script.
1746  *
1747  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1748  *
1749  * @package  core
1750  * @category preference
1751  * @access   public
1752  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1753  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1754  * @throws   coding_exception
1755  * @return   null
1756  */
1757 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1758     global $DB;
1759     // Static cache, we need to check on each page load, not only every 2 minutes.
1760     static $loadedusers = array();
1762     if (!isset($user->id)) {
1763         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1764     }
1766     if (empty($user->id) or isguestuser($user->id)) {
1767         // No permanent storage for not-logged-in users and guest.
1768         if (!isset($user->preference)) {
1769             $user->preference = array();
1770         }
1771         return;
1772     }
1774     $timenow = time();
1776     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1777         // Already loaded at least once on this page. Are we up to date?
1778         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1779             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1780             return;
1782         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1783             // No change since the lastcheck on this page.
1784             $user->preference['_lastloaded'] = $timenow;
1785             return;
1786         }
1787     }
1789     // OK, so we have to reload all preferences.
1790     $loadedusers[$user->id] = true;
1791     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1792     $user->preference['_lastloaded'] = $timenow;
1795 /**
1796  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1797  *
1798  * NOTE: internal function, do not call from other code.
1799  *
1800  * @package core
1801  * @access private
1802  * @param integer $userid the user whose prefs were changed.
1803  */
1804 function mark_user_preferences_changed($userid) {
1805     global $CFG;
1807     if (empty($userid) or isguestuser($userid)) {
1808         // No cache flags for guest and not-logged-in users.
1809         return;
1810     }
1812     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1815 /**
1816  * Sets a preference for the specified user.
1817  *
1818  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1819  *
1820  * @package  core
1821  * @category preference
1822  * @access   public
1823  * @param    string            $name  The key to set as preference for the specified user
1824  * @param    string            $value The value to set for the $name key in the specified user's
1825  *                                    record, null means delete current value.
1826  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1827  * @throws   coding_exception
1828  * @return   bool                     Always true or exception
1829  */
1830 function set_user_preference($name, $value, $user = null) {
1831     global $USER, $DB;
1833     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1834         throw new coding_exception('Invalid preference name in set_user_preference() call');
1835     }
1837     if (is_null($value)) {
1838         // Null means delete current.
1839         return unset_user_preference($name, $user);
1840     } else if (is_object($value)) {
1841         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1842     } else if (is_array($value)) {
1843         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1844     }
1845     // Value column maximum length is 1333 characters.
1846     $value = (string)$value;
1847     if (core_text::strlen($value) > 1333) {
1848         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1849     }
1851     if (is_null($user)) {
1852         $user = $USER;
1853     } else if (isset($user->id)) {
1854         // It is a valid object.
1855     } else if (is_numeric($user)) {
1856         $user = (object)array('id' => (int)$user);
1857     } else {
1858         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1859     }
1861     check_user_preferences_loaded($user);
1863     if (empty($user->id) or isguestuser($user->id)) {
1864         // No permanent storage for not-logged-in users and guest.
1865         $user->preference[$name] = $value;
1866         return true;
1867     }
1869     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1870         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1871             // Preference already set to this value.
1872             return true;
1873         }
1874         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1876     } else {
1877         $preference = new stdClass();
1878         $preference->userid = $user->id;
1879         $preference->name   = $name;
1880         $preference->value  = $value;
1881         $DB->insert_record('user_preferences', $preference);
1882     }
1884     // Update value in cache.
1885     $user->preference[$name] = $value;
1887     // Set reload flag for other sessions.
1888     mark_user_preferences_changed($user->id);
1890     return true;
1893 /**
1894  * Sets a whole array of preferences for the current user
1895  *
1896  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1897  *
1898  * @package  core
1899  * @category preference
1900  * @access   public
1901  * @param    array             $prefarray An array of key/value pairs to be set
1902  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1903  * @return   bool                         Always true or exception
1904  */
1905 function set_user_preferences(array $prefarray, $user = null) {
1906     foreach ($prefarray as $name => $value) {
1907         set_user_preference($name, $value, $user);
1908     }
1909     return true;
1912 /**
1913  * Unsets a preference completely by deleting it from the database
1914  *
1915  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1916  *
1917  * @package  core
1918  * @category preference
1919  * @access   public
1920  * @param    string            $name The key to unset as preference for the specified user
1921  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1922  * @throws   coding_exception
1923  * @return   bool                    Always true or exception
1924  */
1925 function unset_user_preference($name, $user = null) {
1926     global $USER, $DB;
1928     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1929         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1930     }
1932     if (is_null($user)) {
1933         $user = $USER;
1934     } else if (isset($user->id)) {
1935         // It is a valid object.
1936     } else if (is_numeric($user)) {
1937         $user = (object)array('id' => (int)$user);
1938     } else {
1939         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1940     }
1942     check_user_preferences_loaded($user);
1944     if (empty($user->id) or isguestuser($user->id)) {
1945         // No permanent storage for not-logged-in user and guest.
1946         unset($user->preference[$name]);
1947         return true;
1948     }
1950     // Delete from DB.
1951     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
1953     // Delete the preference from cache.
1954     unset($user->preference[$name]);
1956     // Set reload flag for other sessions.
1957     mark_user_preferences_changed($user->id);
1959     return true;
1962 /**
1963  * Used to fetch user preference(s)
1964  *
1965  * If no arguments are supplied this function will return
1966  * all of the current user preferences as an array.
1967  *
1968  * If a name is specified then this function
1969  * attempts to return that particular preference value.  If
1970  * none is found, then the optional value $default is returned,
1971  * otherwise null.
1972  *
1973  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1974  *
1975  * @package  core
1976  * @category preference
1977  * @access   public
1978  * @param    string            $name    Name of the key to use in finding a preference value
1979  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1980  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1981  * @throws   coding_exception
1982  * @return   string|mixed|null          A string containing the value of a single preference. An
1983  *                                      array with all of the preferences or null
1984  */
1985 function get_user_preferences($name = null, $default = null, $user = null) {
1986     global $USER;
1988     if (is_null($name)) {
1989         // All prefs.
1990     } else if (is_numeric($name) or $name === '_lastloaded') {
1991         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1992     }
1994     if (is_null($user)) {
1995         $user = $USER;
1996     } else if (isset($user->id)) {
1997         // Is a valid object.
1998     } else if (is_numeric($user)) {
1999         $user = (object)array('id' => (int)$user);
2000     } else {
2001         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2002     }
2004     check_user_preferences_loaded($user);
2006     if (empty($name)) {
2007         // All values.
2008         return $user->preference;
2009     } else if (isset($user->preference[$name])) {
2010         // The single string value.
2011         return $user->preference[$name];
2012     } else {
2013         // Default value (null if not specified).
2014         return $default;
2015     }
2018 // FUNCTIONS FOR HANDLING TIME.
2020 /**
2021  * Given date parts in user time produce a GMT timestamp.
2022  *
2023  * @package core
2024  * @category time
2025  * @param int $year The year part to create timestamp of
2026  * @param int $month The month part to create timestamp of
2027  * @param int $day The day part to create timestamp of
2028  * @param int $hour The hour part to create timestamp of
2029  * @param int $minute The minute part to create timestamp of
2030  * @param int $second The second part to create timestamp of
2031  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2032  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2033  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2034  *             applied only if timezone is 99 or string.
2035  * @return int GMT timestamp
2036  */
2037 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2039     // Save input timezone, required for dst offset check.
2040     $passedtimezone = $timezone;
2042     $timezone = get_user_timezone_offset($timezone);
2044     if (abs($timezone) > 13) {
2045         // Server time.
2046         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2047     } else {
2048         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2049         $time = usertime($time, $timezone);
2051         // Apply dst for string timezones or if 99 then try dst offset with user's default timezone.
2052         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
2053             $time -= dst_offset_on($time, $passedtimezone);
2054         }
2055     }
2057     return $time;
2061 /**
2062  * Format a date/time (seconds) as weeks, days, hours etc as needed
2063  *
2064  * Given an amount of time in seconds, returns string
2065  * formatted nicely as weeks, days, hours etc as needed
2066  *
2067  * @package core
2068  * @category time
2069  * @uses MINSECS
2070  * @uses HOURSECS
2071  * @uses DAYSECS
2072  * @uses YEARSECS
2073  * @param int $totalsecs Time in seconds
2074  * @param stdClass $str Should be a time object
2075  * @return string A nicely formatted date/time string
2076  */
2077 function format_time($totalsecs, $str = null) {
2079     $totalsecs = abs($totalsecs);
2081     if (!$str) {
2082         // Create the str structure the slow way.
2083         $str = new stdClass();
2084         $str->day   = get_string('day');
2085         $str->days  = get_string('days');
2086         $str->hour  = get_string('hour');
2087         $str->hours = get_string('hours');
2088         $str->min   = get_string('min');
2089         $str->mins  = get_string('mins');
2090         $str->sec   = get_string('sec');
2091         $str->secs  = get_string('secs');
2092         $str->year  = get_string('year');
2093         $str->years = get_string('years');
2094     }
2096     $years     = floor($totalsecs/YEARSECS);
2097     $remainder = $totalsecs - ($years*YEARSECS);
2098     $days      = floor($remainder/DAYSECS);
2099     $remainder = $totalsecs - ($days*DAYSECS);
2100     $hours     = floor($remainder/HOURSECS);
2101     $remainder = $remainder - ($hours*HOURSECS);
2102     $mins      = floor($remainder/MINSECS);
2103     $secs      = $remainder - ($mins*MINSECS);
2105     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2106     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2107     $sh = ($hours == 1) ? $str->hour : $str->hours;
2108     $sd = ($days == 1)  ? $str->day  : $str->days;
2109     $sy = ($years == 1)  ? $str->year  : $str->years;
2111     $oyears = '';
2112     $odays = '';
2113     $ohours = '';
2114     $omins = '';
2115     $osecs = '';
2117     if ($years) {
2118         $oyears  = $years .' '. $sy;
2119     }
2120     if ($days) {
2121         $odays  = $days .' '. $sd;
2122     }
2123     if ($hours) {
2124         $ohours = $hours .' '. $sh;
2125     }
2126     if ($mins) {
2127         $omins  = $mins .' '. $sm;
2128     }
2129     if ($secs) {
2130         $osecs  = $secs .' '. $ss;
2131     }
2133     if ($years) {
2134         return trim($oyears .' '. $odays);
2135     }
2136     if ($days) {
2137         return trim($odays .' '. $ohours);
2138     }
2139     if ($hours) {
2140         return trim($ohours .' '. $omins);
2141     }
2142     if ($mins) {
2143         return trim($omins .' '. $osecs);
2144     }
2145     if ($secs) {
2146         return $osecs;
2147     }
2148     return get_string('now');
2151 /**
2152  * Returns a formatted string that represents a date in user time.
2153  *
2154  * @package core
2155  * @category time
2156  * @param int $date the timestamp in UTC, as obtained from the database.
2157  * @param string $format strftime format. You should probably get this using
2158  *        get_string('strftime...', 'langconfig');
2159  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2160  *        not 99 then daylight saving will not be added.
2161  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2162  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2163  *        If false then the leading zero is maintained.
2164  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2165  * @return string the formatted date/time.
2166  */
2167 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2168     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2169     return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
2172 /**
2173  * Returns a formatted date ensuring it is UTF-8.
2174  *
2175  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2176  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2177  *
2178  * This function does not do any calculation regarding the user preferences and should
2179  * therefore receive the final date timestamp, format and timezone. Timezone being only used
2180  * to differentiate the use of server time or not (strftime() against gmstrftime()).
2181  *
2182  * @param int $date the timestamp.
2183  * @param string $format strftime format.
2184  * @param int|float $tz the numerical timezone, typically returned by {@link get_user_timezone_offset()}.
2185  * @return string the formatted date/time.
2186  * @since 2.3.3
2187  */
2188 function date_format_string($date, $format, $tz = 99) {
2189     global $CFG;
2190     if (abs($tz) > 13) {
2191         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2192             $format = core_text::convert($format, 'utf-8', $localewincharset);
2193             $datestring = strftime($format, $date);
2194             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2195         } else {
2196             $datestring = strftime($format, $date);
2197         }
2198     } else {
2199         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2200             $format = core_text::convert($format, 'utf-8', $localewincharset);
2201             $datestring = gmstrftime($format, $date);
2202             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2203         } else {
2204             $datestring = gmstrftime($format, $date);
2205         }
2206     }
2207     return $datestring;
2210 /**
2211  * Given a $time timestamp in GMT (seconds since epoch),
2212  * returns an array that represents the date in user time
2213  *
2214  * @package core
2215  * @category time
2216  * @uses HOURSECS
2217  * @param int $time Timestamp in GMT
2218  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2219  *        dst offset is applied {@link http://docs.moodle.org/dev/Time_API#Timezone}
2220  * @return array An array that represents the date in user time
2221  */
2222 function usergetdate($time, $timezone=99) {
2224     // Save input timezone, required for dst offset check.
2225     $passedtimezone = $timezone;
2227     $timezone = get_user_timezone_offset($timezone);
2229     if (abs($timezone) > 13) {
2230         // Server time.
2231         return getdate($time);
2232     }
2234     // Add daylight saving offset for string timezones only, as we can't get dst for
2235     // float values. if timezone is 99 (user default timezone), then try update dst.
2236     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2237         $time += dst_offset_on($time, $passedtimezone);
2238     }
2240     $time += intval((float)$timezone * HOURSECS);
2242     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2244     // Be careful to ensure the returned array matches that produced by getdate() above.
2245     list(
2246         $getdate['month'],
2247         $getdate['weekday'],
2248         $getdate['yday'],
2249         $getdate['year'],
2250         $getdate['mon'],
2251         $getdate['wday'],
2252         $getdate['mday'],
2253         $getdate['hours'],
2254         $getdate['minutes'],
2255         $getdate['seconds']
2256     ) = explode('_', $datestring);
2258     // Set correct datatype to match with getdate().
2259     $getdate['seconds'] = (int)$getdate['seconds'];
2260     $getdate['yday'] = (int)$getdate['yday'] - 1; // The function gmstrftime returns 0 through 365.
2261     $getdate['year'] = (int)$getdate['year'];
2262     $getdate['mon'] = (int)$getdate['mon'];
2263     $getdate['wday'] = (int)$getdate['wday'];
2264     $getdate['mday'] = (int)$getdate['mday'];
2265     $getdate['hours'] = (int)$getdate['hours'];
2266     $getdate['minutes'] = (int)$getdate['minutes'];
2267     return $getdate;
2270 /**
2271  * Given a GMT timestamp (seconds since epoch), offsets it by
2272  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2273  *
2274  * @package core
2275  * @category time
2276  * @uses HOURSECS
2277  * @param int $date Timestamp in GMT
2278  * @param float|int|string $timezone timezone to calculate GMT time offset before
2279  *        calculating user time, 99 is default user timezone
2280  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2281  * @return int
2282  */
2283 function usertime($date, $timezone=99) {
2285     $timezone = get_user_timezone_offset($timezone);
2287     if (abs($timezone) > 13) {
2288         return $date;
2289     }
2290     return $date - (int)($timezone * HOURSECS);
2293 /**
2294  * Given a time, return the GMT timestamp of the most recent midnight
2295  * for the current user.
2296  *
2297  * @package core
2298  * @category time
2299  * @param int $date Timestamp in GMT
2300  * @param float|int|string $timezone timezone to calculate GMT time offset before
2301  *        calculating user midnight time, 99 is default user timezone
2302  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2303  * @return int Returns a GMT timestamp
2304  */
2305 function usergetmidnight($date, $timezone=99) {
2307     $userdate = usergetdate($date, $timezone);
2309     // Time of midnight of this user's day, in GMT.
2310     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2314 /**
2315  * Returns a string that prints the user's timezone
2316  *
2317  * @package core
2318  * @category time
2319  * @param float|int|string $timezone timezone to calculate GMT time offset before
2320  *        calculating user timezone, 99 is default user timezone
2321  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2322  * @return string
2323  */
2324 function usertimezone($timezone=99) {
2326     $tz = get_user_timezone($timezone);
2328     if (!is_float($tz)) {
2329         return $tz;
2330     }
2332     if (abs($tz) > 13) {
2333         // Server time.
2334         return get_string('serverlocaltime');
2335     }
2337     if ($tz == intval($tz)) {
2338         // Don't show .0 for whole hours.
2339         $tz = intval($tz);
2340     }
2342     if ($tz == 0) {
2343         return 'UTC';
2344     } else if ($tz > 0) {
2345         return 'UTC+'.$tz;
2346     } else {
2347         return 'UTC'.$tz;
2348     }
2352 /**
2353  * Returns a float which represents the user's timezone difference from GMT in hours
2354  * Checks various settings and picks the most dominant of those which have a value
2355  *
2356  * @package core
2357  * @category time
2358  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2359  *        99 is default user timezone
2360  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2361  * @return float
2362  */
2363 function get_user_timezone_offset($tz = 99) {
2364     $tz = get_user_timezone($tz);
2366     if (is_float($tz)) {
2367         return $tz;
2368     } else {
2369         $tzrecord = get_timezone_record($tz);
2370         if (empty($tzrecord)) {
2371             return 99.0;
2372         }
2373         return (float)$tzrecord->gmtoff / HOURMINS;
2374     }
2377 /**
2378  * Returns an int which represents the systems's timezone difference from GMT in seconds
2379  *
2380  * @package core
2381  * @category time
2382  * @param float|int|string $tz timezone for which offset is required.
2383  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2384  * @return int|bool if found, false is timezone 99 or error
2385  */
2386 function get_timezone_offset($tz) {
2387     if ($tz == 99) {
2388         return false;
2389     }
2391     if (is_numeric($tz)) {
2392         return intval($tz * 60*60);
2393     }
2395     if (!$tzrecord = get_timezone_record($tz)) {
2396         return false;
2397     }
2398     return intval($tzrecord->gmtoff * 60);
2401 /**
2402  * Returns a float or a string which denotes the user's timezone
2403  * 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)
2404  * means that for this timezone there are also DST rules to be taken into account
2405  * Checks various settings and picks the most dominant of those which have a value
2406  *
2407  * @package core
2408  * @category time
2409  * @param float|int|string $tz timezone to calculate GMT time offset before
2410  *        calculating user timezone, 99 is default user timezone
2411  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2412  * @return float|string
2413  */
2414 function get_user_timezone($tz = 99) {
2415     global $USER, $CFG;
2417     $timezones = array(
2418         $tz,
2419         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2420         isset($USER->timezone) ? $USER->timezone : 99,
2421         isset($CFG->timezone) ? $CFG->timezone : 99,
2422         );
2424     $tz = 99;
2426     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2427     while (((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2428         $tz = $next['value'];
2429     }
2430     return is_numeric($tz) ? (float) $tz : $tz;
2433 /**
2434  * Returns cached timezone record for given $timezonename
2435  *
2436  * @package core
2437  * @param string $timezonename name of the timezone
2438  * @return stdClass|bool timezonerecord or false
2439  */
2440 function get_timezone_record($timezonename) {
2441     global $DB;
2442     static $cache = null;
2444     if ($cache === null) {
2445         $cache = array();
2446     }
2448     if (isset($cache[$timezonename])) {
2449         return $cache[$timezonename];
2450     }
2452     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2453                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2456 /**
2457  * Build and store the users Daylight Saving Time (DST) table
2458  *
2459  * @package core
2460  * @param int $fromyear Start year for the table, defaults to 1971
2461  * @param int $toyear End year for the table, defaults to 2035
2462  * @param int|float|string $strtimezone timezone to check if dst should be applied.
2463  * @return bool
2464  */
2465 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2466     global $SESSION, $DB;
2468     $usertz = get_user_timezone($strtimezone);
2470     if (is_float($usertz)) {
2471         // Trivial timezone, no DST.
2472         return false;
2473     }
2475     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2476         // We have pre-calculated values, but the user's effective TZ has changed in the meantime, so reset.
2477         unset($SESSION->dst_offsets);
2478         unset($SESSION->dst_range);
2479     }
2481     if (!empty($SESSION->dst_offsets) && empty($fromyear) && empty($toyear)) {
2482         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table.
2483         // This will be the return path most of the time, pretty light computationally.
2484         return true;
2485     }
2487     // Reaching here means we either need to extend our table or create it from scratch.
2489     // Remember which TZ we calculated these changes for.
2490     $SESSION->dst_offsettz = $usertz;
2492     if (empty($SESSION->dst_offsets)) {
2493         // If we 're creating from scratch, put the two guard elements in there.
2494         $SESSION->dst_offsets = array(1 => null, 0 => null);
2495     }
2496     if (empty($SESSION->dst_range)) {
2497         // If creating from scratch.
2498         $from = max((empty($fromyear) ? intval(date('Y')) - 3 : $fromyear), 1971);
2499         $to   = min((empty($toyear)   ? intval(date('Y')) + 3 : $toyear),   2035);
2501         // Fill in the array with the extra years we need to process.
2502         $yearstoprocess = array();
2503         for ($i = $from; $i <= $to; ++$i) {
2504             $yearstoprocess[] = $i;
2505         }
2507         // Take note of which years we have processed for future calls.
2508         $SESSION->dst_range = array($from, $to);
2509     } else {
2510         // If needing to extend the table, do the same.
2511         $yearstoprocess = array();
2513         $from = max((empty($fromyear) ? $SESSION->dst_range[0] : $fromyear), 1971);
2514         $to   = min((empty($toyear)   ? $SESSION->dst_range[1] : $toyear),   2035);
2516         if ($from < $SESSION->dst_range[0]) {
2517             // Take note of which years we need to process and then note that we have processed them for future calls.
2518             for ($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2519                 $yearstoprocess[] = $i;
2520             }
2521             $SESSION->dst_range[0] = $from;
2522         }
2523         if ($to > $SESSION->dst_range[1]) {
2524             // Take note of which years we need to process and then note that we have processed them for future calls.
2525             for ($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2526                 $yearstoprocess[] = $i;
2527             }
2528             $SESSION->dst_range[1] = $to;
2529         }
2530     }
2532     if (empty($yearstoprocess)) {
2533         // This means that there was a call requesting a SMALLER range than we have already calculated.
2534         return true;
2535     }
2537     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2538     // Also, the array is sorted in descending timestamp order!
2540     // Get DB data.
2542     static $presetscache = array();
2543     if (!isset($presetscache[$usertz])) {
2544         $presetscache[$usertz] = $DB->get_records('timezone', array('name' => $usertz),
2545             'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, '.
2546             'std_startday, std_weekday, std_skipweeks, std_time');
2547     }
2548     if (empty($presetscache[$usertz])) {
2549         return false;
2550     }
2552     // Remove ending guard (first element of the array).
2553     reset($SESSION->dst_offsets);
2554     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2556     // Add all required change timestamps.
2557     foreach ($yearstoprocess as $y) {
2558         // Find the record which is in effect for the year $y.
2559         foreach ($presetscache[$usertz] as $year => $preset) {
2560             if ($year <= $y) {
2561                 break;
2562             }
2563         }
2565         $changes = dst_changes_for_year($y, $preset);
2567         if ($changes === null) {
2568             continue;
2569         }
2570         if ($changes['dst'] != 0) {
2571             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2572         }
2573         if ($changes['std'] != 0) {
2574             $SESSION->dst_offsets[$changes['std']] = 0;
2575         }
2576     }
2578     // Put in a guard element at the top.
2579     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2580     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = null; // DAYSECS is arbitrary, any "small" number will do.
2582     // Sort again.
2583     krsort($SESSION->dst_offsets);
2585     return true;
2588 /**
2589  * Calculates the required DST change and returns a Timestamp Array
2590  *
2591  * @package core
2592  * @category time
2593  * @uses HOURSECS
2594  * @uses MINSECS
2595  * @param int|string $year Int or String Year to focus on
2596  * @param object $timezone Instatiated Timezone object
2597  * @return array|null Array dst => xx, 0 => xx, std => yy, 1 => yy or null
2598  */
2599 function dst_changes_for_year($year, $timezone) {
2601     if ($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 &&
2602         $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2603         return null;
2604     }
2606     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2607     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2609     list($dsthour, $dstmin) = explode(':', $timezone->dst_time);
2610     list($stdhour, $stdmin) = explode(':', $timezone->std_time);
2612     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2613     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2615     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2616     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2617     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2619     $timedst += $dsthour * HOURSECS + $dstmin * MINSECS;
2620     $timestd += $stdhour * HOURSECS + $stdmin * MINSECS;
2622     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2625 /**
2626  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2627  * - Note: Daylight saving only works for string timezones and not for float.
2628  *
2629  * @package core
2630  * @category time
2631  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2632  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2633  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2634  * @return int
2635  */
2636 function dst_offset_on($time, $strtimezone = null) {
2637     global $SESSION;
2639     if (!calculate_user_dst_table(null, null, $strtimezone) || empty($SESSION->dst_offsets)) {
2640         return 0;
2641     }
2643     reset($SESSION->dst_offsets);
2644     while (list($from, $offset) = each($SESSION->dst_offsets)) {
2645         if ($from <= $time) {
2646             break;
2647         }
2648     }
2650     // This is the normal return path.
2651     if ($offset !== null) {
2652         return $offset;
2653     }
2655     // Reaching this point means we haven't calculated far enough, do it now:
2656     // Calculate extra DST changes if needed and recurse. The recursion always
2657     // moves toward the stopping condition, so will always end.
2659     if ($from == 0) {
2660         // We need a year smaller than $SESSION->dst_range[0].
2661         if ($SESSION->dst_range[0] == 1971) {
2662             return 0;
2663         }
2664         calculate_user_dst_table($SESSION->dst_range[0] - 5, null, $strtimezone);
2665         return dst_offset_on($time, $strtimezone);
2666     } else {
2667         // We need a year larger than $SESSION->dst_range[1].
2668         if ($SESSION->dst_range[1] == 2035) {
2669             return 0;
2670         }
2671         calculate_user_dst_table(null, $SESSION->dst_range[1] + 5, $strtimezone);
2672         return dst_offset_on($time, $strtimezone);
2673     }
2676 /**
2677  * Calculates when the day appears in specific month
2678  *
2679  * @package core
2680  * @category time
2681  * @param int $startday starting day of the month
2682  * @param int $weekday The day when week starts (normally taken from user preferences)
2683  * @param int $month The month whose day is sought
2684  * @param int $year The year of the month whose day is sought
2685  * @return int
2686  */
2687 function find_day_in_month($startday, $weekday, $month, $year) {
2688     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2690     $daysinmonth = days_in_month($month, $year);
2691     $daysinweek = count($calendartype->get_weekdays());
2693     if ($weekday == -1) {
2694         // Don't care about weekday, so return:
2695         //    abs($startday) if $startday != -1
2696         //    $daysinmonth otherwise.
2697         return ($startday == -1) ? $daysinmonth : abs($startday);
2698     }
2700     // From now on we 're looking for a specific weekday.
2701     // Give "end of month" its actual value, since we know it.
2702     if ($startday == -1) {
2703         $startday = -1 * $daysinmonth;
2704     }
2706     // Starting from day $startday, the sign is the direction.
2707     if ($startday < 1) {
2708         $startday = abs($startday);
2709         $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
2711         // This is the last such weekday of the month.
2712         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2713         if ($lastinmonth > $daysinmonth) {
2714             $lastinmonth -= $daysinweek;
2715         }
2717         // Find the first such weekday <= $startday.
2718         while ($lastinmonth > $startday) {
2719             $lastinmonth -= $daysinweek;
2720         }
2722         return $lastinmonth;
2723     } else {
2724         $indexweekday = dayofweek($startday, $month, $year);
2726         $diff = $weekday - $indexweekday;
2727         if ($diff < 0) {
2728             $diff += $daysinweek;
2729         }
2731         // This is the first such weekday of the month equal to or after $startday.
2732         $firstfromindex = $startday + $diff;
2734         return $firstfromindex;
2735     }
2738 /**
2739  * Calculate the number of days in a given month
2740  *
2741  * @package core
2742  * @category time
2743  * @param int $month The month whose day count is sought
2744  * @param int $year The year of the month whose day count is sought
2745  * @return int
2746  */
2747 function days_in_month($month, $year) {
2748     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2749     return $calendartype->get_num_days_in_month($year, $month);
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     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2764     return $calendartype->get_weekday($year, $month, $day);
2767 // USER AUTHENTICATION AND LOGIN.
2769 /**
2770  * Returns full login url.
2771  *
2772  * @return string login url
2773  */
2774 function get_login_url() {
2775     global $CFG;
2777     $url = "$CFG->wwwroot/login/index.php";
2779     if (!empty($CFG->loginhttps)) {
2780         $url = str_replace('http:', 'https:', $url);
2781     }
2783     return $url;
2786 /**
2787  * This function checks that the current user is logged in and has the
2788  * required privileges
2789  *
2790  * This function checks that the current user is logged in, and optionally
2791  * whether they are allowed to be in a particular course and view a particular
2792  * course module.
2793  * If they are not logged in, then it redirects them to the site login unless
2794  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2795  * case they are automatically logged in as guests.
2796  * If $courseid is given and the user is not enrolled in that course then the
2797  * user is redirected to the course enrolment page.
2798  * If $cm is given and the course module is hidden and the user is not a teacher
2799  * in the course then the user is redirected to the course home page.
2800  *
2801  * When $cm parameter specified, this function sets page layout to 'module'.
2802  * You need to change it manually later if some other layout needed.
2803  *
2804  * @package    core_access
2805  * @category   access
2806  *
2807  * @param mixed $courseorid id of the course or course object
2808  * @param bool $autologinguest default true
2809  * @param object $cm course module object
2810  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2811  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2812  *             in order to keep redirects working properly. MDL-14495
2813  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2814  * @return mixed Void, exit, and die depending on path
2815  * @throws coding_exception
2816  * @throws require_login_exception
2817  */
2818 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2819     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2821     // Must not redirect when byteserving already started.
2822     if (!empty($_SERVER['HTTP_RANGE'])) {
2823         $preventredirect = true;
2824     }
2826     // Setup global $COURSE, themes, language and locale.
2827     if (!empty($courseorid)) {
2828         if (is_object($courseorid)) {
2829             $course = $courseorid;
2830         } else if ($courseorid == SITEID) {
2831             $course = clone($SITE);
2832         } else {
2833             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2834         }
2835         if ($cm) {
2836             if ($cm->course != $course->id) {
2837                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2838             }
2839             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2840             if (!($cm instanceof cm_info)) {
2841                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2842                 // db queries so this is not really a performance concern, however it is obviously
2843                 // better if you use get_fast_modinfo to get the cm before calling this.
2844                 $modinfo = get_fast_modinfo($course);
2845                 $cm = $modinfo->get_cm($cm->id);
2846             }
2847             $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
2848             $PAGE->set_pagelayout('incourse');
2849         } else {
2850             $PAGE->set_course($course); // Set's up global $COURSE.
2851         }
2852     } else {
2853         // Do not touch global $COURSE via $PAGE->set_course(),
2854         // the reasons is we need to be able to call require_login() at any time!!
2855         $course = $SITE;
2856         if ($cm) {
2857             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2858         }
2859     }
2861     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2862     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2863     // risk leading the user back to the AJAX request URL.
2864     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2865         $setwantsurltome = false;
2866     }
2868     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2869     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2870         if ($setwantsurltome) {
2871             $SESSION->wantsurl = qualified_me();
2872         }
2873         redirect(get_login_url());
2874     }
2876     // If the user is not even logged in yet then make sure they are.
2877     if (!isloggedin()) {
2878         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2879             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2880                 // Misconfigured site guest, just redirect to login page.
2881                 redirect(get_login_url());
2882                 exit; // Never reached.
2883             }
2884             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2885             complete_user_login($guest);
2886             $USER->autologinguest = true;
2887             $SESSION->lang = $lang;
2888         } else {
2889             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2890             if ($preventredirect) {
2891                 throw new require_login_exception('You are not logged in');
2892             }
2894             if ($setwantsurltome) {
2895                 $SESSION->wantsurl = qualified_me();
2896             }
2897             if (!empty($_SERVER['HTTP_REFERER'])) {
2898                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2899             }
2900             redirect(get_login_url());
2901             exit; // Never reached.
2902         }
2903     }
2905     // Loginas as redirection if needed.
2906     if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
2907         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2908             if ($USER->loginascontext->instanceid != $course->id) {
2909                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2910             }
2911         }
2912     }
2914     // Check whether the user should be changing password (but only if it is REALLY them).
2915     if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
2916         $userauth = get_auth_plugin($USER->auth);
2917         if ($userauth->can_change_password() and !$preventredirect) {
2918             if ($setwantsurltome) {
2919                 $SESSION->wantsurl = qualified_me();
2920             }
2921             if ($changeurl = $userauth->change_password_url()) {
2922                 // Use plugin custom url.
2923                 redirect($changeurl);
2924             } else {
2925                 // Use moodle internal method.
2926                 if (empty($CFG->loginhttps)) {
2927                     redirect($CFG->wwwroot .'/login/change_password.php');
2928                 } else {
2929                     $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
2930                     redirect($wwwroot .'/login/change_password.php');
2931                 }
2932             }
2933         } else {
2934             print_error('nopasswordchangeforced', 'auth');
2935         }
2936     }
2938     // Check that the user account is properly set up.
2939     if (user_not_fully_set_up($USER)) {
2940         if ($preventredirect) {
2941             throw new require_login_exception('User not fully set-up');
2942         }
2943         if ($setwantsurltome) {
2944             $SESSION->wantsurl = qualified_me();
2945         }
2946         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2947     }
2949     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2950     sesskey();
2952     // Do not bother admins with any formalities.
2953     if (is_siteadmin()) {
2954         // Set accesstime or the user will appear offline which messes up messaging.
2955         user_accesstime_log($course->id);
2956         return;
2957     }
2959     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2960     if (!$USER->policyagreed and !is_siteadmin()) {
2961         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2962             if ($preventredirect) {
2963                 throw new require_login_exception('Policy not agreed');
2964             }
2965             if ($setwantsurltome) {
2966                 $SESSION->wantsurl = qualified_me();
2967             }
2968             redirect($CFG->wwwroot .'/user/policy.php');
2969         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2970             if ($preventredirect) {
2971                 throw new require_login_exception('Policy not agreed');
2972             }
2973             if ($setwantsurltome) {
2974                 $SESSION->wantsurl = qualified_me();
2975             }
2976             redirect($CFG->wwwroot .'/user/policy.php');
2977         }
2978     }
2980     // Fetch the system context, the course context, and prefetch its child contexts.
2981     $sysctx = context_system::instance();
2982     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2983     if ($cm) {
2984         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2985     } else {
2986         $cmcontext = null;
2987     }
2989     // If the site is currently under maintenance, then print a message.
2990     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2991         if ($preventredirect) {
2992             throw new require_login_exception('Maintenance in progress');
2993         }
2995         print_maintenance_message();
2996     }
2998     // Make sure the course itself is not hidden.
2999     if ($course->id == SITEID) {
3000         // Frontpage can not be hidden.
3001     } else {
3002         if (is_role_switched($course->id)) {
3003             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
3004         } else {
3005             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
3006                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
3007                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
3008                 if ($preventredirect) {
3009                     throw new require_login_exception('Course is hidden');
3010                 }
3011                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
3012                 // the navigation will mess up when trying to find it.
3013                 navigation_node::override_active_url(new moodle_url('/'));
3014                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
3015             }
3016         }
3017     }
3019     // Is the user enrolled?
3020     if ($course->id == SITEID) {
3021         // Everybody is enrolled on the frontpage.
3022     } else {
3023         if (\core\session\manager::is_loggedinas()) {
3024             // Make sure the REAL person can access this course first.
3025             $realuser = \core\session\manager::get_realuser();
3026             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
3027                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
3028                 if ($preventredirect) {
3029                     throw new require_login_exception('Invalid course login-as access');
3030                 }
3031                 echo $OUTPUT->header();
3032                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
3033             }
3034         }
3036         $access = false;
3038         if (is_role_switched($course->id)) {
3039             // Ok, user had to be inside this course before the switch.
3040             $access = true;
3042         } else if (is_viewing($coursecontext, $USER)) {
3043             // Ok, no need to mess with enrol.
3044             $access = true;
3046         } else {
3047             if (isset($USER->enrol['enrolled'][$course->id])) {
3048                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3049                     $access = true;
3050                     if (isset($USER->enrol['tempguest'][$course->id])) {
3051                         unset($USER->enrol['tempguest'][$course->id]);
3052                         remove_temp_course_roles($coursecontext);
3053                     }
3054                 } else {
3055                     // Expired.
3056                     unset($USER->enrol['enrolled'][$course->id]);
3057                 }
3058             }
3059             if (isset($USER->enrol['tempguest'][$course->id])) {
3060                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3061                     $access = true;
3062                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3063                     $access = true;
3064                 } else {
3065                     // Expired.
3066                     unset($USER->enrol['tempguest'][$course->id]);
3067                     remove_temp_course_roles($coursecontext);
3068                 }
3069             }
3071             if (!$access) {
3072                 // Cache not ok.
3073                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3074                 if ($until !== false) {
3075                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
3076                     if ($until == 0) {
3077                         $until = ENROL_MAX_TIMESTAMP;
3078                     }
3079                     $USER->enrol['enrolled'][$course->id] = $until;
3080                     $access = true;
3082                 } else {
3083                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
3084                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
3085                     $enrols = enrol_get_plugins(true);
3086                     // First ask all enabled enrol instances in course if they want to auto enrol user.
3087                     foreach ($instances as $instance) {
3088                         if (!isset($enrols[$instance->enrol])) {
3089                             continue;
3090                         }
3091                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3092                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3093                         if ($until !== false) {
3094                             if ($until == 0) {
3095                                 $until = ENROL_MAX_TIMESTAMP;
3096                             }
3097                             $USER->enrol['enrolled'][$course->id] = $until;
3098                             $access = true;
3099                             break;
3100                         }
3101                     }
3102                     // If not enrolled yet try to gain temporary guest access.
3103                     if (!$access) {
3104                         foreach ($instances as $instance) {
3105                             if (!isset($enrols[$instance->enrol])) {
3106                                 continue;
3107                             }
3108                             // Get a duration for the guest access, a timestamp in the future or false.
3109                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3110                             if ($until !== false and $until > time()) {
3111                                 $USER->enrol['tempguest'][$course->id] = $until;
3112                                 $access = true;
3113                                 break;
3114                             }
3115                         }
3116                     }
3117                 }
3118             }
3119         }
3121         if (!$access) {
3122             if ($preventredirect) {
3123                 throw new require_login_exception('Not enrolled');
3124             }
3125             if ($setwantsurltome) {
3126                 $SESSION->wantsurl = qualified_me();
3127             }
3128             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3129         }
3130     }
3132     // Check visibility of activity to current user; includes visible flag, groupmembersonly, conditional availability, etc.
3133     if ($cm && !$cm->uservisible) {
3134         if ($preventredirect) {
3135             throw new require_login_exception('Activity is hidden');
3136         }
3137         if ($course->id != SITEID) {
3138             $url = new moodle_url('/course/view.php', array('id' => $course->id));
3139         } else {
3140             $url = new moodle_url('/');
3141         }
3142         redirect($url, get_string('activityiscurrentlyhidden'));
3143     }
3145     // Finally access granted, update lastaccess times.
3146     user_accesstime_log($course->id);
3150 /**
3151  * This function just makes sure a user is logged out.
3152  *
3153  * @package    core_access
3154  * @category   access
3155  */
3156 function require_logout() {
3157     global $USER, $DB;
3159     if (!isloggedin()) {
3160         // This should not happen often, no need for hooks or events here.
3161         \core\session\manager::terminate_current();
3162         return;
3163     }
3165     // Execute hooks before action.
3166     $authsequence = get_enabled_auth_plugins();
3167     foreach ($authsequence as $authname) {
3168         $authplugin = get_auth_plugin($authname);
3169         $authplugin->prelogout_hook();
3170     }
3172     // Store info that gets removed during logout.
3173     $sid = session_id();
3174     $event = \core\event\user_loggedout::create(
3175         array(
3176             'userid' => $USER->id,
3177             'objectid' => $USER->id,
3178             'other' => array('sessionid' => $sid),
3179         )
3180     );
3181     if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
3182         $event->add_record_snapshot('sessions', $session);
3183     }
3185     // Delete session record and drop $_SESSION content.
3186     \core\session\manager::terminate_current();
3188     // Trigger event AFTER action.
3189     $event->trigger();
3192 /**
3193  * Weaker version of require_login()
3194  *
3195  * This is a weaker version of {@link require_login()} which only requires login
3196  * when called from within a course rather than the site page, unless
3197  * the forcelogin option is turned on.
3198  * @see require_login()
3199  *
3200  * @package    core_access
3201  * @category   access
3202  *
3203  * @param mixed $courseorid The course object or id in question
3204  * @param bool $autologinguest Allow autologin guests if that is wanted
3205  * @param object $cm Course activity module if known
3206  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3207  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3208  *             in order to keep redirects working properly. MDL-14495
3209  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3210  * @return void
3211  * @throws coding_exception
3212  */
3213 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3214     global $CFG, $PAGE, $SITE;
3215     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3216           or (!is_object($courseorid) and $courseorid == SITEID);
3217     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3218         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3219         // db queries so this is not really a performance concern, however it is obviously
3220         // better if you use get_fast_modinfo to get the cm before calling this.
3221         if (is_object($courseorid)) {
3222             $course = $courseorid;
3223         } else {
3224             $course = clone($SITE);
3225         }
3226         $modinfo = get_fast_modinfo($course);
3227         $cm = $modinfo->get_cm($cm->id);
3228     }
3229     if (!empty($CFG->forcelogin)) {
3230         // Login required for both SITE and courses.
3231         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3233     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3234         // Always login for hidden activities.
3235         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3237     } else if ($issite) {
3238         // Login for SITE not required.
3239         if ($cm and empty($cm->visible)) {
3240             // Hidden activities are not accessible without login.
3241             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3242         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3243             // Not-logged-in users do not have any group membership.
3244             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3245         } else {
3246             // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3247             if (!empty($courseorid)) {
3248                 if (is_object($courseorid)) {
3249                     $course = $courseorid;
3250                 } else {
3251                     $course = clone($SITE);
3252                 }
3253                 if ($cm) {
3254                     if ($cm->course != $course->id) {
3255                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3256                     }
3257                     $PAGE->set_cm($cm, $course);
3258                     $PAGE->set_pagelayout('incourse');
3259                 } else {
3260                     $PAGE->set_course($course);
3261                 }
3262             } else {
3263                 // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3264                 $PAGE->set_course($PAGE->course);
3265             }
3266             // TODO: verify conditional activities here.
3267             user_accesstime_log(SITEID);
3268             return;
3269         }
3271     } else {
3272         // Course login always required.
3273         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3274     }
3277 /**
3278  * Require key login. Function terminates with error if key not found or incorrect.
3279  *
3280  * @uses NO_MOODLE_COOKIES
3281  * @uses PARAM_ALPHANUM
3282  * @param string $script unique script identifier
3283  * @param int $instance optional instance id
3284  * @return int Instance ID
3285  */
3286 function require_user_key_login($script, $instance=null) {
3287     global $DB;
3289     if (!NO_MOODLE_COOKIES) {
3290         print_error('sessioncookiesdisable');
3291     }
3293     // Extra safety.
3294     \core\session\manager::write_close();
3296     $keyvalue = required_param('key', PARAM_ALPHANUM);
3298     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3299         print_error('invalidkey');
3300     }
3302     if (!empty($key->validuntil) and $key->validuntil < time()) {
3303         print_error('expiredkey');
3304     }
3306     if ($key->iprestriction) {
3307         $remoteaddr = getremoteaddr(null);
3308         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3309             print_error('ipmismatch');
3310         }
3311     }
3313     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3314         print_error('invaliduserid');
3315     }
3317     // Emulate normal session.
3318     enrol_check_plugins($user);
3319     \core\session\manager::set_user($user);
3321     // Note we are not using normal login.
3322     if (!defined('USER_KEY_LOGIN')) {
3323         define('USER_KEY_LOGIN', true);
3324     }
3326     // Return instance id - it might be empty.
3327     return $key->instance;
3330 /**
3331  * Creates a new private user access key.
3332  *
3333  * @param string $script unique target identifier
3334  * @param int $userid
3335  * @param int $instance optional instance id
3336  * @param string $iprestriction optional ip restricted access
3337  * @param timestamp $validuntil key valid only until given data
3338  * @return string access key value
3339  */
3340 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3341     global $DB;
3343     $key = new stdClass();
3344     $key->script        = $script;
3345     $key->userid        = $userid;
3346     $key->instance      = $instance;
3347     $key->iprestriction = $iprestriction;
3348     $key->validuntil    = $validuntil;
3349     $key->timecreated   = time();
3351     // Something long and unique.
3352     $key->value         = md5($userid.'_'.time().random_string(40));
3353     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3354         // Must be unique.
3355         $key->value     = md5($userid.'_'.time().random_string(40));
3356     }
3357     $DB->insert_record('user_private_key', $key);
3358     return $key->value;
3361 /**
3362  * Delete the user's new private user access keys for a particular script.
3363  *
3364  * @param string $script unique target identifier
3365  * @param int $userid
3366  * @return void
3367  */
3368 function delete_user_key($script, $userid) {
3369     global $DB;
3370     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3373 /**
3374  * Gets a private user access key (and creates one if one doesn't exist).
3375  *
3376  * @param string $script unique target identifier
3377  * @param int $userid
3378  * @param int $instance optional instance id
3379  * @param string $iprestriction optional ip restricted access
3380  * @param timestamp $validuntil key valid only until given data
3381  * @return string access key value
3382  */
3383 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3384     global $DB;
3386     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3387                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3388                                                          'validuntil' => $validuntil))) {
3389         return $key->value;
3390     } else {
3391         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3392     }
3396 /**
3397  * Modify the user table by setting the currently logged in user's last login to now.
3398  *
3399  * @return bool Always returns true
3400  */
3401 function update_user_login_times() {
3402     global $USER, $DB, $CFG;
3404     require_once($CFG->dirroot.'/user/lib.php');
3406     if (isguestuser()) {
3407         // Do not update guest access times/ips for performance.
3408         return true;
3409     }
3411     $now = time();
3413     $user = new stdClass();
3414     $user->id = $USER->id;
3416     // Make sure all users that logged in have some firstaccess.
3417     if ($USER->firstaccess == 0) {
3418         $USER->firstaccess = $user->firstaccess = $now;
3419     }
3421     // Store the previous current as lastlogin.
3422     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3424     $USER->currentlogin = $user->currentlogin = $now;
3426     // Function user_accesstime_log() may not update immediately, better do it here.
3427     $USER->lastaccess = $user->lastaccess = $now;
3428     $USER->lastip = $user->lastip = getremoteaddr();
3430     user_update_user($user, false);
3431     return true;
3434 /**
3435  * Determines if a user has completed setting up their account.
3436  *
3437  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3438  * @return bool
3439  */
3440 function user_not_fully_set_up($user) {
3441     if (isguestuser($user)) {
3442         return false;
3443     }
3444     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3447 /**
3448  * Check whether the user has exceeded the bounce threshold
3449  *
3450  * @param stdClass $user A {@link $USER} object
3451  * @return bool true => User has exceeded bounce threshold
3452  */
3453 function over_bounce_threshold($user) {
3454     global $CFG, $DB;
3456     if (empty($CFG->handlebounces)) {
3457         return false;
3458     }
3460     if (empty($user->id)) {
3461         // No real (DB) user, nothing to do here.
3462         return false;
3463     }
3465     // Set sensible defaults.
3466     if (empty($CFG->minbounces)) {
3467         $CFG->minbounces = 10;
3468     }
3469     if (empty($CFG->bounceratio)) {
3470         $CFG->bounceratio = .20;
3471     }
3472     $bouncecount = 0;
3473     $sendcount = 0;
3474     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3475         $bouncecount = $bounce->value;
3476     }
3477     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3478         $sendcount = $send->value;
3479     }
3480     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3483 /**
3484  * Used to increment or reset email sent count
3485  *
3486  * @param stdClass $user object containing an id
3487  * @param bool $reset will reset the count to 0
3488  * @return void
3489  */
3490 function set_send_count($user, $reset=false) {
3491     global $DB;
3493     if (empty($user->id)) {
3494         // No real (DB) user, nothing to do here.
3495         return;
3496     }
3498     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3499         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3500         $DB->update_record('user_preferences', $pref);
3501     } else if (!empty($reset)) {
3502         // If it's not there and we're resetting, don't bother. Make a new one.
3503         $pref = new stdClass();
3504         $pref->name   = 'email_send_count';
3505         $pref->value  = 1;
3506         $pref->userid = $user->id;
3507         $DB->insert_record('user_preferences', $pref, false);
3508     }
3511 /**
3512  * Increment or reset user's email bounce count
3513  *
3514  * @param stdClass $user object containing an id
3515  * @param bool $reset will reset the count to 0
3516  */
3517 function set_bounce_count($user, $reset=false) {
3518     global $DB;
3520     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3521         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3522         $DB->update_record('user_preferences', $pref);
3523     } else if (!empty($reset)) {
3524         // If it's not there and we're resetting, don't bother. Make a new one.
3525         $pref = new stdClass();
3526         $pref->name   = 'email_bounce_count';
3527         $pref->value  = 1;
3528         $pref->userid = $user->id;
3529         $DB->insert_record('user_preferences', $pref, false);
3530     }
3533 /**
3534  * Determines if the logged in user is currently moving an activity
3535  *
3536  * @param int $courseid The id of the course being tested
3537  * @return bool
3538  */
3539 function ismoving($courseid) {
3540     global $USER;
3542     if (!empty($USER->activitycopy)) {
3543         return ($USER->activitycopycourse == $courseid);
3544     }
3545     return false;
3548 /**
3549  * Returns a persons full name
3550  *
3551  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3552  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3553  * specify one.
3554  *
3555  * @param stdClass $user A {@link $USER} object to get full name of.
3556  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3557  * @return string
3558  */
3559 function fullname($user, $override=false) {
3560     global $CFG, $SESSION;
3562     // Get all of the name fields.
3563     $allnames = get_all_user_name_fields();
3564     if ($CFG->debugdeveloper) {
3565         foreach ($allnames as $allname) {
3566             if (!array_key_exists($allname, $user)) {
3567                 // If all the user name fields are not set in the user object, then notify the programmer that it needs to be fixed.
3568                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3569                 // Message has been sent, no point in sending the message multiple times.
3570                 break;
3571             }
3572         }
3573     }
3575     if (!isset($user->firstname) and !isset($user->lastname)) {
3576         return '';
3577     }
3579     if (!$override) {
3580         if (!empty($CFG->forcefirstname)) {
3581             $user->firstname = $CFG->forcefirstname;
3582         }
3583         if (!empty($CFG->forcelastname)) {
3584             $user->lastname = $CFG->forcelastname;
3585         }
3586     }
3588     if (!empty($SESSION->fullnamedisplay)) {
3589         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3590     }
3592     $template = null;
3593     // If the fullnamedisplay setting is available, set the template to that.
3594     if (isset($CFG->fullnamedisplay)) {
3595         $template = $CFG->fullnamedisplay;
3596     }
3597     // If the template is empty, or set to language, or $override is set, return the language string.
3598     if (empty($template) || $template == 'language' || $override) {
3599         return get_string('fullnamedisplay', null, $user);
3600     }
3602     $requirednames = array();
3603     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3604     foreach ($allnames as $allname) {
3605         if (strpos($template, $allname) !== false) {
3606             $requirednames[] = $allname;
3607         }
3608     }
3610     $displayname = $template;
3611     // Switch in the actual data into the template.
3612     foreach ($requirednames as $altname) {
3613         if (isset($user->$altname)) {
3614             // Using empty() on the below if statement causes breakages.
3615             if ((string)$user->$altname == '') {
3616                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3617             } else {
3618                 $displayname = str_replace($altname, $user->$altname, $displayname);
3619             }
3620         } else {
3621             $displayname = str_replace($altname, 'EMPTY', $displayname);
3622         }
3623     }
3624     // Tidy up any misc. characters (Not perfect, but gets most characters).
3625     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3626     // katakana and parenthesis.
3627     $patterns = array();
3628     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3629     // filled in by a user.
3630     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3631     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3632     // This regular expression is to remove any double spaces in the display name.
3633     $patterns[] = '/\s{2,}/';
3634     foreach ($patterns as $pattern) {
3635         $displayname = preg_replace($pattern, ' ', $displayname);
3636     }
3638     // Trimming $displayname will help the next check to ensure that we don't have a display name with spaces.
3639     $displayname = trim($displayname);
3640     if (empty($displayname)) {
3641         // Going with just the first name if no alternate fields are filled out. May be changed later depending on what
3642         // people in general feel is a good setting to fall back on.
3643         $displayname = $user->firstname;
3644     }
3645     return $displayname;
3648 /**
3649  * A centralised location for the all name fields. Returns an array / sql string snippet.
3650  *
3651  * @param bool $returnsql True for an sql select field snippet.
3652  * @param string $alias table&