MDL-64394 core: Fixed bug when using access log with pre_loginpage_hook
[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 receiving
119  * the input (required/optional_param or formslib) and then sanitise 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', '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 (which is default) if the module wants support for setting the ID number for grade calculation purposes. */
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 /**
418  * True if module supports groupmembersonly (which no longer exists)
419  * @deprecated Since Moodle 2.8
420  */
421 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
423 /** Type of module */
424 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
425 /** True if module supports intro editor */
426 define('FEATURE_MOD_INTRO', 'mod_intro');
427 /** True if module has default completion */
428 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
430 define('FEATURE_COMMENT', 'comment');
432 define('FEATURE_RATE', 'rate');
433 /** True if module supports backup/restore of moodle2 format */
434 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
436 /** True if module can show description on course main page */
437 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
439 /** True if module uses the question bank */
440 define('FEATURE_USES_QUESTIONS', 'usesquestions');
442 /**
443  * Maximum filename char size
444  */
445 define('MAX_FILENAME_SIZE', 100);
447 /** Unspecified module archetype */
448 define('MOD_ARCHETYPE_OTHER', 0);
449 /** Resource-like type module */
450 define('MOD_ARCHETYPE_RESOURCE', 1);
451 /** Assignment module archetype */
452 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
453 /** System (not user-addable) module archetype */
454 define('MOD_ARCHETYPE_SYSTEM', 3);
456 /**
457  * Security token used for allowing access
458  * from external application such as web services.
459  * Scripts do not use any session, performance is relatively
460  * low because we need to load access info in each request.
461  * Scripts are executed in parallel.
462  */
463 define('EXTERNAL_TOKEN_PERMANENT', 0);
465 /**
466  * Security token used for allowing access
467  * of embedded applications, the code is executed in the
468  * active user session. Token is invalidated after user logs out.
469  * Scripts are executed serially - normal session locking is used.
470  */
471 define('EXTERNAL_TOKEN_EMBEDDED', 1);
473 /**
474  * The home page should be the site home
475  */
476 define('HOMEPAGE_SITE', 0);
477 /**
478  * The home page should be the users my page
479  */
480 define('HOMEPAGE_MY', 1);
481 /**
482  * The home page can be chosen by the user
483  */
484 define('HOMEPAGE_USER', 2);
486 /**
487  * Hub directory url (should be moodle.org)
488  */
489 define('HUB_HUBDIRECTORYURL', "https://hubdirectory.moodle.org");
492 /**
493  * Moodle.net url (should be moodle.net)
494  */
495 define('HUB_MOODLEORGHUBURL', "https://moodle.net");
496 define('HUB_OLDMOODLEORGHUBURL', "http://hub.moodle.org");
498 /**
499  * Moodle mobile app service name
500  */
501 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
503 /**
504  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
505  */
506 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
508 /**
509  * Course display settings: display all sections on one page.
510  */
511 define('COURSE_DISPLAY_SINGLEPAGE', 0);
512 /**
513  * Course display settings: split pages into a page per section.
514  */
515 define('COURSE_DISPLAY_MULTIPAGE', 1);
517 /**
518  * Authentication constant: String used in password field when password is not stored.
519  */
520 define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
522 /**
523  * Email from header to never include via information.
524  */
525 define('EMAIL_VIA_NEVER', 0);
527 /**
528  * Email from header to always include via information.
529  */
530 define('EMAIL_VIA_ALWAYS', 1);
532 /**
533  * Email from header to only include via information if the address is no-reply.
534  */
535 define('EMAIL_VIA_NO_REPLY_ONLY', 2);
537 // PARAMETER HANDLING.
539 /**
540  * Returns a particular value for the named variable, taken from
541  * POST or GET.  If the parameter doesn't exist then an error is
542  * thrown because we require this variable.
543  *
544  * This function should be used to initialise all required values
545  * in a script that are based on parameters.  Usually it will be
546  * used like this:
547  *    $id = required_param('id', PARAM_INT);
548  *
549  * Please note the $type parameter is now required and the value can not be array.
550  *
551  * @param string $parname the name of the page parameter we want
552  * @param string $type expected type of parameter
553  * @return mixed
554  * @throws coding_exception
555  */
556 function required_param($parname, $type) {
557     if (func_num_args() != 2 or empty($parname) or empty($type)) {
558         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
559     }
560     // POST has precedence.
561     if (isset($_POST[$parname])) {
562         $param = $_POST[$parname];
563     } else if (isset($_GET[$parname])) {
564         $param = $_GET[$parname];
565     } else {
566         print_error('missingparam', '', '', $parname);
567     }
569     if (is_array($param)) {
570         debugging('Invalid array parameter detected in required_param(): '.$parname);
571         // TODO: switch to fatal error in Moodle 2.3.
572         return required_param_array($parname, $type);
573     }
575     return clean_param($param, $type);
578 /**
579  * Returns a particular array value for the named variable, taken from
580  * POST or GET.  If the parameter doesn't exist then an error is
581  * thrown because we require this variable.
582  *
583  * This function should be used to initialise all required values
584  * in a script that are based on parameters.  Usually it will be
585  * used like this:
586  *    $ids = required_param_array('ids', PARAM_INT);
587  *
588  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
589  *
590  * @param string $parname the name of the page parameter we want
591  * @param string $type expected type of parameter
592  * @return array
593  * @throws coding_exception
594  */
595 function required_param_array($parname, $type) {
596     if (func_num_args() != 2 or empty($parname) or empty($type)) {
597         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
598     }
599     // POST has precedence.
600     if (isset($_POST[$parname])) {
601         $param = $_POST[$parname];
602     } else if (isset($_GET[$parname])) {
603         $param = $_GET[$parname];
604     } else {
605         print_error('missingparam', '', '', $parname);
606     }
607     if (!is_array($param)) {
608         print_error('missingparam', '', '', $parname);
609     }
611     $result = array();
612     foreach ($param as $key => $value) {
613         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
614             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
615             continue;
616         }
617         $result[$key] = clean_param($value, $type);
618     }
620     return $result;
623 /**
624  * Returns a particular value for the named variable, taken from
625  * POST or GET, otherwise returning a given default.
626  *
627  * This function should be used to initialise all optional values
628  * in a script that are based on parameters.  Usually it will be
629  * used like this:
630  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
631  *
632  * Please note the $type parameter is now required and the value can not be array.
633  *
634  * @param string $parname the name of the page parameter we want
635  * @param mixed  $default the default value to return if nothing is found
636  * @param string $type expected type of parameter
637  * @return mixed
638  * @throws coding_exception
639  */
640 function optional_param($parname, $default, $type) {
641     if (func_num_args() != 3 or empty($parname) or empty($type)) {
642         throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
643     }
645     // POST has precedence.
646     if (isset($_POST[$parname])) {
647         $param = $_POST[$parname];
648     } else if (isset($_GET[$parname])) {
649         $param = $_GET[$parname];
650     } else {
651         return $default;
652     }
654     if (is_array($param)) {
655         debugging('Invalid array parameter detected in required_param(): '.$parname);
656         // TODO: switch to $default in Moodle 2.3.
657         return optional_param_array($parname, $default, $type);
658     }
660     return clean_param($param, $type);
663 /**
664  * Returns a particular array value for the named variable, taken from
665  * POST or GET, otherwise returning a given default.
666  *
667  * This function should be used to initialise all optional values
668  * in a script that are based on parameters.  Usually it will be
669  * used like this:
670  *    $ids = optional_param('id', array(), PARAM_INT);
671  *
672  * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
673  *
674  * @param string $parname the name of the page parameter we want
675  * @param mixed $default the default value to return if nothing is found
676  * @param string $type expected type of parameter
677  * @return array
678  * @throws coding_exception
679  */
680 function optional_param_array($parname, $default, $type) {
681     if (func_num_args() != 3 or empty($parname) or empty($type)) {
682         throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
683     }
685     // POST has precedence.
686     if (isset($_POST[$parname])) {
687         $param = $_POST[$parname];
688     } else if (isset($_GET[$parname])) {
689         $param = $_GET[$parname];
690     } else {
691         return $default;
692     }
693     if (!is_array($param)) {
694         debugging('optional_param_array() expects array parameters only: '.$parname);
695         return $default;
696     }
698     $result = array();
699     foreach ($param as $key => $value) {
700         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
701             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
702             continue;
703         }
704         $result[$key] = clean_param($value, $type);
705     }
707     return $result;
710 /**
711  * Strict validation of parameter values, the values are only converted
712  * to requested PHP type. Internally it is using clean_param, the values
713  * before and after cleaning must be equal - otherwise
714  * an invalid_parameter_exception is thrown.
715  * Objects and classes are not accepted.
716  *
717  * @param mixed $param
718  * @param string $type PARAM_ constant
719  * @param bool $allownull are nulls valid value?
720  * @param string $debuginfo optional debug information
721  * @return mixed the $param value converted to PHP type
722  * @throws invalid_parameter_exception if $param is not of given type
723  */
724 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
725     if (is_null($param)) {
726         if ($allownull == NULL_ALLOWED) {
727             return null;
728         } else {
729             throw new invalid_parameter_exception($debuginfo);
730         }
731     }
732     if (is_array($param) or is_object($param)) {
733         throw new invalid_parameter_exception($debuginfo);
734     }
736     $cleaned = clean_param($param, $type);
738     if ($type == PARAM_FLOAT) {
739         // Do not detect precision loss here.
740         if (is_float($param) or is_int($param)) {
741             // These always fit.
742         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
743             throw new invalid_parameter_exception($debuginfo);
744         }
745     } else if ((string)$param !== (string)$cleaned) {
746         // Conversion to string is usually lossless.
747         throw new invalid_parameter_exception($debuginfo);
748     }
750     return $cleaned;
753 /**
754  * Makes sure array contains only the allowed types, this function does not validate array key names!
755  *
756  * <code>
757  * $options = clean_param($options, PARAM_INT);
758  * </code>
759  *
760  * @param array $param the variable array we are cleaning
761  * @param string $type expected format of param after cleaning.
762  * @param bool $recursive clean recursive arrays
763  * @return array
764  * @throws coding_exception
765  */
766 function clean_param_array(array $param = null, $type, $recursive = false) {
767     // Convert null to empty array.
768     $param = (array)$param;
769     foreach ($param as $key => $value) {
770         if (is_array($value)) {
771             if ($recursive) {
772                 $param[$key] = clean_param_array($value, $type, true);
773             } else {
774                 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
775             }
776         } else {
777             $param[$key] = clean_param($value, $type);
778         }
779     }
780     return $param;
783 /**
784  * Used by {@link optional_param()} and {@link required_param()} to
785  * clean the variables and/or cast to specific types, based on
786  * an options field.
787  * <code>
788  * $course->format = clean_param($course->format, PARAM_ALPHA);
789  * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
790  * </code>
791  *
792  * @param mixed $param the variable we are cleaning
793  * @param string $type expected format of param after cleaning.
794  * @return mixed
795  * @throws coding_exception
796  */
797 function clean_param($param, $type) {
798     global $CFG;
800     if (is_array($param)) {
801         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
802     } else if (is_object($param)) {
803         if (method_exists($param, '__toString')) {
804             $param = $param->__toString();
805         } else {
806             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
807         }
808     }
810     switch ($type) {
811         case PARAM_RAW:
812             // No cleaning at all.
813             $param = fix_utf8($param);
814             return $param;
816         case PARAM_RAW_TRIMMED:
817             // No cleaning, but strip leading and trailing whitespace.
818             $param = fix_utf8($param);
819             return trim($param);
821         case PARAM_CLEAN:
822             // General HTML cleaning, try to use more specific type if possible this is deprecated!
823             // Please use more specific type instead.
824             if (is_numeric($param)) {
825                 return $param;
826             }
827             $param = fix_utf8($param);
828             // Sweep for scripts, etc.
829             return clean_text($param);
831         case PARAM_CLEANHTML:
832             // Clean html fragment.
833             $param = fix_utf8($param);
834             // Sweep for scripts, etc.
835             $param = clean_text($param, FORMAT_HTML);
836             return trim($param);
838         case PARAM_INT:
839             // Convert to integer.
840             return (int)$param;
842         case PARAM_FLOAT:
843             // Convert to float.
844             return (float)$param;
846         case PARAM_ALPHA:
847             // Remove everything not `a-z`.
848             return preg_replace('/[^a-zA-Z]/i', '', $param);
850         case PARAM_ALPHAEXT:
851             // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
852             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
854         case PARAM_ALPHANUM:
855             // Remove everything not `a-zA-Z0-9`.
856             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
858         case PARAM_ALPHANUMEXT:
859             // Remove everything not `a-zA-Z0-9_-`.
860             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
862         case PARAM_SEQUENCE:
863             // Remove everything not `0-9,`.
864             return preg_replace('/[^0-9,]/i', '', $param);
866         case PARAM_BOOL:
867             // Convert to 1 or 0.
868             $tempstr = strtolower($param);
869             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
870                 $param = 1;
871             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
872                 $param = 0;
873             } else {
874                 $param = empty($param) ? 0 : 1;
875             }
876             return $param;
878         case PARAM_NOTAGS:
879             // Strip all tags.
880             $param = fix_utf8($param);
881             return strip_tags($param);
883         case PARAM_TEXT:
884             // Leave only tags needed for multilang.
885             $param = fix_utf8($param);
886             // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
887             // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
888             do {
889                 if (strpos($param, '</lang>') !== false) {
890                     // Old and future mutilang syntax.
891                     $param = strip_tags($param, '<lang>');
892                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
893                         break;
894                     }
895                     $open = false;
896                     foreach ($matches[0] as $match) {
897                         if ($match === '</lang>') {
898                             if ($open) {
899                                 $open = false;
900                                 continue;
901                             } else {
902                                 break 2;
903                             }
904                         }
905                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
906                             break 2;
907                         } else {
908                             $open = true;
909                         }
910                     }
911                     if ($open) {
912                         break;
913                     }
914                     return $param;
916                 } else if (strpos($param, '</span>') !== false) {
917                     // Current problematic multilang syntax.
918                     $param = strip_tags($param, '<span>');
919                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
920                         break;
921                     }
922                     $open = false;
923                     foreach ($matches[0] as $match) {
924                         if ($match === '</span>') {
925                             if ($open) {
926                                 $open = false;
927                                 continue;
928                             } else {
929                                 break 2;
930                             }
931                         }
932                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
933                             break 2;
934                         } else {
935                             $open = true;
936                         }
937                     }
938                     if ($open) {
939                         break;
940                     }
941                     return $param;
942                 }
943             } while (false);
944             // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
945             return strip_tags($param);
947         case PARAM_COMPONENT:
948             // We do not want any guessing here, either the name is correct or not
949             // please note only normalised component names are accepted.
950             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]+$/', $param)) {
951                 return '';
952             }
953             if (strpos($param, '__') !== false) {
954                 return '';
955             }
956             if (strpos($param, 'mod_') === 0) {
957                 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
958                 if (substr_count($param, '_') != 1) {
959                     return '';
960                 }
961             }
962             return $param;
964         case PARAM_PLUGIN:
965         case PARAM_AREA:
966             // We do not want any guessing here, either the name is correct or not.
967             if (!is_valid_plugin_name($param)) {
968                 return '';
969             }
970             return $param;
972         case PARAM_SAFEDIR:
973             // Remove everything not a-zA-Z0-9_- .
974             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
976         case PARAM_SAFEPATH:
977             // Remove everything not a-zA-Z0-9/_- .
978             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
980         case PARAM_FILE:
981             // Strip all suspicious characters from filename.
982             $param = fix_utf8($param);
983             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
984             if ($param === '.' || $param === '..') {
985                 $param = '';
986             }
987             return $param;
989         case PARAM_PATH:
990             // Strip all suspicious characters from file path.
991             $param = fix_utf8($param);
992             $param = str_replace('\\', '/', $param);
994             // Explode the path and clean each element using the PARAM_FILE rules.
995             $breadcrumb = explode('/', $param);
996             foreach ($breadcrumb as $key => $crumb) {
997                 if ($crumb === '.' && $key === 0) {
998                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
999                 } else {
1000                     $crumb = clean_param($crumb, PARAM_FILE);
1001                 }
1002                 $breadcrumb[$key] = $crumb;
1003             }
1004             $param = implode('/', $breadcrumb);
1006             // Remove multiple current path (./././) and multiple slashes (///).
1007             $param = preg_replace('~//+~', '/', $param);
1008             $param = preg_replace('~/(\./)+~', '/', $param);
1009             return $param;
1011         case PARAM_HOST:
1012             // Allow FQDN or IPv4 dotted quad.
1013             $param = preg_replace('/[^\.\d\w-]/', '', $param );
1014             // Match ipv4 dotted quad.
1015             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
1016                 // Confirm values are ok.
1017                 if ( $match[0] > 255
1018                      || $match[1] > 255
1019                      || $match[3] > 255
1020                      || $match[4] > 255 ) {
1021                     // Hmmm, what kind of dotted quad is this?
1022                     $param = '';
1023                 }
1024             } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1025                        && !preg_match('/^[\.-]/',  $param) // No leading dots/hyphens.
1026                        && !preg_match('/[\.-]$/',  $param) // No trailing dots/hyphens.
1027                        ) {
1028                 // All is ok - $param is respected.
1029             } else {
1030                 // All is not ok...
1031                 $param='';
1032             }
1033             return $param;
1035         case PARAM_URL:
1036             // Allow safe urls.
1037             $param = fix_utf8($param);
1038             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
1039             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E-u-P-a?I?p?f?q?r?')) {
1040                 // All is ok, param is respected.
1041             } else {
1042                 // Not really ok.
1043                 $param ='';
1044             }
1045             return $param;
1047         case PARAM_LOCALURL:
1048             // Allow http absolute, root relative and relative URLs within wwwroot.
1049             $param = clean_param($param, PARAM_URL);
1050             if (!empty($param)) {
1052                 if ($param === $CFG->wwwroot) {
1053                     // Exact match;
1054                 } else if (preg_match(':^/:', $param)) {
1055                     // Root-relative, ok!
1056                 } else if (preg_match('/^' . preg_quote($CFG->wwwroot . '/', '/') . '/i', $param)) {
1057                     // Absolute, and matches our wwwroot.
1058                 } else {
1059                     // Relative - let's make sure there are no tricks.
1060                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1061                         // Looks ok.
1062                     } else {
1063                         $param = '';
1064                     }
1065                 }
1066             }
1067             return $param;
1069         case PARAM_PEM:
1070             $param = trim($param);
1071             // PEM formatted strings may contain letters/numbers and the symbols:
1072             //   forward slash: /
1073             //   plus sign:     +
1074             //   equal sign:    =
1075             //   , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
1076             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1077                 list($wholething, $body) = $matches;
1078                 unset($wholething, $matches);
1079                 $b64 = clean_param($body, PARAM_BASE64);
1080                 if (!empty($b64)) {
1081                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1082                 } else {
1083                     return '';
1084                 }
1085             }
1086             return '';
1088         case PARAM_BASE64:
1089             if (!empty($param)) {
1090                 // PEM formatted strings may contain letters/numbers and the symbols
1091                 //   forward slash: /
1092                 //   plus sign:     +
1093                 //   equal sign:    =.
1094                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1095                     return '';
1096                 }
1097                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1098                 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1099                 // than (or equal to) 64 characters long.
1100                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1101                     if ($i + 1 == $j) {
1102                         if (64 < strlen($lines[$i])) {
1103                             return '';
1104                         }
1105                         continue;
1106                     }
1108                     if (64 != strlen($lines[$i])) {
1109                         return '';
1110                     }
1111                 }
1112                 return implode("\n", $lines);
1113             } else {
1114                 return '';
1115             }
1117         case PARAM_TAG:
1118             $param = fix_utf8($param);
1119             // Please note it is not safe to use the tag name directly anywhere,
1120             // it must be processed with s(), urlencode() before embedding anywhere.
1121             // Remove some nasties.
1122             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1123             // Convert many whitespace chars into one.
1124             $param = preg_replace('/\s+/u', ' ', $param);
1125             $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
1126             return $param;
1128         case PARAM_TAGLIST:
1129             $param = fix_utf8($param);
1130             $tags = explode(',', $param);
1131             $result = array();
1132             foreach ($tags as $tag) {
1133                 $res = clean_param($tag, PARAM_TAG);
1134                 if ($res !== '') {
1135                     $result[] = $res;
1136                 }
1137             }
1138             if ($result) {
1139                 return implode(',', $result);
1140             } else {
1141                 return '';
1142             }
1144         case PARAM_CAPABILITY:
1145             if (get_capability_info($param)) {
1146                 return $param;
1147             } else {
1148                 return '';
1149             }
1151         case PARAM_PERMISSION:
1152             $param = (int)$param;
1153             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1154                 return $param;
1155             } else {
1156                 return CAP_INHERIT;
1157             }
1159         case PARAM_AUTH:
1160             $param = clean_param($param, PARAM_PLUGIN);
1161             if (empty($param)) {
1162                 return '';
1163             } else if (exists_auth_plugin($param)) {
1164                 return $param;
1165             } else {
1166                 return '';
1167             }
1169         case PARAM_LANG:
1170             $param = clean_param($param, PARAM_SAFEDIR);
1171             if (get_string_manager()->translation_exists($param)) {
1172                 return $param;
1173             } else {
1174                 // Specified language is not installed or param malformed.
1175                 return '';
1176             }
1178         case PARAM_THEME:
1179             $param = clean_param($param, PARAM_PLUGIN);
1180             if (empty($param)) {
1181                 return '';
1182             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1183                 return $param;
1184             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1185                 return $param;
1186             } else {
1187                 // Specified theme is not installed.
1188                 return '';
1189             }
1191         case PARAM_USERNAME:
1192             $param = fix_utf8($param);
1193             $param = trim($param);
1194             // Convert uppercase to lowercase MDL-16919.
1195             $param = core_text::strtolower($param);
1196             if (empty($CFG->extendedusernamechars)) {
1197                 $param = str_replace(" " , "", $param);
1198                 // Regular expression, eliminate all chars EXCEPT:
1199                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1200                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1201             }
1202             return $param;
1204         case PARAM_EMAIL:
1205             $param = fix_utf8($param);
1206             if (validate_email($param)) {
1207                 return $param;
1208             } else {
1209                 return '';
1210             }
1212         case PARAM_STRINGID:
1213             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1214                 return $param;
1215             } else {
1216                 return '';
1217             }
1219         case PARAM_TIMEZONE:
1220             // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
1221             $param = fix_utf8($param);
1222             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1223             if (preg_match($timezonepattern, $param)) {
1224                 return $param;
1225             } else {
1226                 return '';
1227             }
1229         default:
1230             // Doh! throw error, switched parameters in optional_param or another serious problem.
1231             print_error("unknownparamtype", '', '', $type);
1232     }
1235 /**
1236  * Whether the PARAM_* type is compatible in RTL.
1237  *
1238  * Being compatible with RTL means that the data they contain can flow
1239  * from right-to-left or left-to-right without compromising the user experience.
1240  *
1241  * Take URLs for example, they are not RTL compatible as they should always
1242  * flow from the left to the right. This also applies to numbers, email addresses,
1243  * configuration snippets, base64 strings, etc...
1244  *
1245  * This function tries to best guess which parameters can contain localised strings.
1246  *
1247  * @param string $paramtype Constant PARAM_*.
1248  * @return bool
1249  */
1250 function is_rtl_compatible($paramtype) {
1251     return $paramtype == PARAM_TEXT || $paramtype == PARAM_NOTAGS;
1254 /**
1255  * Makes sure the data is using valid utf8, invalid characters are discarded.
1256  *
1257  * Note: this function is not intended for full objects with methods and private properties.
1258  *
1259  * @param mixed $value
1260  * @return mixed with proper utf-8 encoding
1261  */
1262 function fix_utf8($value) {
1263     if (is_null($value) or $value === '') {
1264         return $value;
1266     } else if (is_string($value)) {
1267         if ((string)(int)$value === $value) {
1268             // Shortcut.
1269             return $value;
1270         }
1271         // No null bytes expected in our data, so let's remove it.
1272         $value = str_replace("\0", '', $value);
1274         // Note: this duplicates min_fix_utf8() intentionally.
1275         static $buggyiconv = null;
1276         if ($buggyiconv === null) {
1277             $buggyiconv = (!function_exists('iconv') or @iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1278         }
1280         if ($buggyiconv) {
1281             if (function_exists('mb_convert_encoding')) {
1282                 $subst = mb_substitute_character();
1283                 mb_substitute_character('');
1284                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1285                 mb_substitute_character($subst);
1287             } else {
1288                 // Warn admins on admin/index.php page.
1289                 $result = $value;
1290             }
1292         } else {
1293             $result = @iconv('UTF-8', 'UTF-8//IGNORE', $value);
1294         }
1296         return $result;
1298     } else if (is_array($value)) {
1299         foreach ($value as $k => $v) {
1300             $value[$k] = fix_utf8($v);
1301         }
1302         return $value;
1304     } else if (is_object($value)) {
1305         // Do not modify original.
1306         $value = clone($value);
1307         foreach ($value as $k => $v) {
1308             $value->$k = fix_utf8($v);
1309         }
1310         return $value;
1312     } else {
1313         // This is some other type, no utf-8 here.
1314         return $value;
1315     }
1318 /**
1319  * Return true if given value is integer or string with integer value
1320  *
1321  * @param mixed $value String or Int
1322  * @return bool true if number, false if not
1323  */
1324 function is_number($value) {
1325     if (is_int($value)) {
1326         return true;
1327     } else if (is_string($value)) {
1328         return ((string)(int)$value) === $value;
1329     } else {
1330         return false;
1331     }
1334 /**
1335  * Returns host part from url.
1336  *
1337  * @param string $url full url
1338  * @return string host, null if not found
1339  */
1340 function get_host_from_url($url) {
1341     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1342     if ($matches) {
1343         return $matches[1];
1344     }
1345     return null;
1348 /**
1349  * Tests whether anything was returned by text editor
1350  *
1351  * This function is useful for testing whether something you got back from
1352  * the HTML editor actually contains anything. Sometimes the HTML editor
1353  * appear to be empty, but actually you get back a <br> tag or something.
1354  *
1355  * @param string $string a string containing HTML.
1356  * @return boolean does the string contain any actual content - that is text,
1357  * images, objects, etc.
1358  */
1359 function html_is_blank($string) {
1360     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1363 /**
1364  * Set a key in global configuration
1365  *
1366  * Set a key/value pair in both this session's {@link $CFG} global variable
1367  * and in the 'config' database table for future sessions.
1368  *
1369  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1370  * In that case it doesn't affect $CFG.
1371  *
1372  * A NULL value will delete the entry.
1373  *
1374  * NOTE: this function is called from lib/db/upgrade.php
1375  *
1376  * @param string $name the key to set
1377  * @param string $value the value to set (without magic quotes)
1378  * @param string $plugin (optional) the plugin scope, default null
1379  * @return bool true or exception
1380  */
1381 function set_config($name, $value, $plugin=null) {
1382     global $CFG, $DB;
1384     if (empty($plugin)) {
1385         if (!array_key_exists($name, $CFG->config_php_settings)) {
1386             // So it's defined for this invocation at least.
1387             if (is_null($value)) {
1388                 unset($CFG->$name);
1389             } else {
1390                 // Settings from db are always strings.
1391                 $CFG->$name = (string)$value;
1392             }
1393         }
1395         if ($DB->get_field('config', 'name', array('name' => $name))) {
1396             if ($value === null) {
1397                 $DB->delete_records('config', array('name' => $name));
1398             } else {
1399                 $DB->set_field('config', 'value', $value, array('name' => $name));
1400             }
1401         } else {
1402             if ($value !== null) {
1403                 $config = new stdClass();
1404                 $config->name  = $name;
1405                 $config->value = $value;
1406                 $DB->insert_record('config', $config, false);
1407             }
1408         }
1409         if ($name === 'siteidentifier') {
1410             cache_helper::update_site_identifier($value);
1411         }
1412         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1413     } else {
1414         // Plugin scope.
1415         if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
1416             if ($value===null) {
1417                 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1418             } else {
1419                 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
1420             }
1421         } else {
1422             if ($value !== null) {
1423                 $config = new stdClass();
1424                 $config->plugin = $plugin;
1425                 $config->name   = $name;
1426                 $config->value  = $value;
1427                 $DB->insert_record('config_plugins', $config, false);
1428             }
1429         }
1430         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1431     }
1433     return true;
1436 /**
1437  * Get configuration values from the global config table
1438  * or the config_plugins table.
1439  *
1440  * If called with one parameter, it will load all the config
1441  * variables for one plugin, and return them as an object.
1442  *
1443  * If called with 2 parameters it will return a string single
1444  * value or false if the value is not found.
1445  *
1446  * NOTE: this function is called from lib/db/upgrade.php
1447  *
1448  * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
1449  *     that we need only fetch it once per request.
1450  * @param string $plugin full component name
1451  * @param string $name default null
1452  * @return mixed hash-like object or single value, return false no config found
1453  * @throws dml_exception
1454  */
1455 function get_config($plugin, $name = null) {
1456     global $CFG, $DB;
1458     static $siteidentifier = null;
1460     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1461         $forced =& $CFG->config_php_settings;
1462         $iscore = true;
1463         $plugin = 'core';
1464     } else {
1465         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1466             $forced =& $CFG->forced_plugin_settings[$plugin];
1467         } else {
1468             $forced = array();
1469         }
1470         $iscore = false;
1471     }
1473     if ($siteidentifier === null) {
1474         try {
1475             // This may fail during installation.
1476             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1477             // install the database.
1478             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1479         } catch (dml_exception $ex) {
1480             // Set siteidentifier to false. We don't want to trip this continually.
1481             $siteidentifier = false;
1482             throw $ex;
1483         }
1484     }
1486     if (!empty($name)) {
1487         if (array_key_exists($name, $forced)) {
1488             return (string)$forced[$name];
1489         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1490             return $siteidentifier;
1491         }
1492     }
1494     $cache = cache::make('core', 'config');
1495     $result = $cache->get($plugin);
1496     if ($result === false) {
1497         // The user is after a recordset.
1498         if (!$iscore) {
1499             $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
1500         } else {
1501             // This part is not really used any more, but anyway...
1502             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1503         }
1504         $cache->set($plugin, $result);
1505     }
1507     if (!empty($name)) {
1508         if (array_key_exists($name, $result)) {
1509             return $result[$name];
1510         }
1511         return false;
1512     }
1514     if ($plugin === 'core') {
1515         $result['siteidentifier'] = $siteidentifier;
1516     }
1518     foreach ($forced as $key => $value) {
1519         if (is_null($value) or is_array($value) or is_object($value)) {
1520             // We do not want any extra mess here, just real settings that could be saved in db.
1521             unset($result[$key]);
1522         } else {
1523             // Convert to string as if it went through the DB.
1524             $result[$key] = (string)$value;
1525         }
1526     }
1528     return (object)$result;
1531 /**
1532  * Removes a key from global configuration.
1533  *
1534  * NOTE: this function is called from lib/db/upgrade.php
1535  *
1536  * @param string $name the key to set
1537  * @param string $plugin (optional) the plugin scope
1538  * @return boolean whether the operation succeeded.
1539  */
1540 function unset_config($name, $plugin=null) {
1541     global $CFG, $DB;
1543     if (empty($plugin)) {
1544         unset($CFG->$name);
1545         $DB->delete_records('config', array('name' => $name));
1546         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1547     } else {
1548         $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1549         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1550     }
1552     return true;
1555 /**
1556  * Remove all the config variables for a given plugin.
1557  *
1558  * NOTE: this function is called from lib/db/upgrade.php
1559  *
1560  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1561  * @return boolean whether the operation succeeded.
1562  */
1563 function unset_all_config_for_plugin($plugin) {
1564     global $DB;
1565     // Delete from the obvious config_plugins first.
1566     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1567     // Next delete any suspect settings from config.
1568     $like = $DB->sql_like('name', '?', true, true, false, '|');
1569     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1570     $DB->delete_records_select('config', $like, $params);
1571     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1572     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1574     return true;
1577 /**
1578  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1579  *
1580  * All users are verified if they still have the necessary capability.
1581  *
1582  * @param string $value the value of the config setting.
1583  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1584  * @param bool $includeadmins include administrators.
1585  * @return array of user objects.
1586  */
1587 function get_users_from_config($value, $capability, $includeadmins = true) {
1588     if (empty($value) or $value === '$@NONE@$') {
1589         return array();
1590     }
1592     // We have to make sure that users still have the necessary capability,
1593     // it should be faster to fetch them all first and then test if they are present
1594     // instead of validating them one-by-one.
1595     $users = get_users_by_capability(context_system::instance(), $capability);
1596     if ($includeadmins) {
1597         $admins = get_admins();
1598         foreach ($admins as $admin) {
1599             $users[$admin->id] = $admin;
1600         }
1601     }
1603     if ($value === '$@ALL@$') {
1604         return $users;
1605     }
1607     $result = array(); // Result in correct order.
1608     $allowed = explode(',', $value);
1609     foreach ($allowed as $uid) {
1610         if (isset($users[$uid])) {
1611             $user = $users[$uid];
1612             $result[$user->id] = $user;
1613         }
1614     }
1616     return $result;
1620 /**
1621  * Invalidates browser caches and cached data in temp.
1622  *
1623  * @return void
1624  */
1625 function purge_all_caches() {
1626     purge_caches();
1629 /**
1630  * Selectively invalidate different types of cache.
1631  *
1632  * Purges the cache areas specified.  By default, this will purge all caches but can selectively purge specific
1633  * areas alone or in combination.
1634  *
1635  * @param bool[] $options Specific parts of the cache to purge. Valid options are:
1636  *        'muc'    Purge MUC caches?
1637  *        'theme'  Purge theme cache?
1638  *        'lang'   Purge language string cache?
1639  *        'js'     Purge javascript cache?
1640  *        'filter' Purge text filter cache?
1641  *        'other'  Purge all other caches?
1642  */
1643 function purge_caches($options = []) {
1644     $defaults = array_fill_keys(['muc', 'theme', 'lang', 'js', 'filter', 'other'], false);
1645     if (empty(array_filter($options))) {
1646         $options = array_fill_keys(array_keys($defaults), true); // Set all options to true.
1647     } else {
1648         $options = array_merge($defaults, array_intersect_key($options, $defaults)); // Override defaults with specified options.
1649     }
1650     if ($options['muc']) {
1651         cache_helper::purge_all();
1652     }
1653     if ($options['theme']) {
1654         theme_reset_all_caches();
1655     }
1656     if ($options['lang']) {
1657         get_string_manager()->reset_caches();
1658     }
1659     if ($options['js']) {
1660         js_reset_all_caches();
1661     }
1662     if ($options['filter']) {
1663         reset_text_filters_cache();
1664     }
1665     if ($options['other']) {
1666         purge_other_caches();
1667     }
1670 /**
1671  * Purge all non-MUC caches not otherwise purged in purge_caches.
1672  *
1673  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1674  * {@link phpunit_util::reset_dataroot()}
1675  */
1676 function purge_other_caches() {
1677     global $DB, $CFG;
1678     core_text::reset_caches();
1679     if (class_exists('core_plugin_manager')) {
1680         core_plugin_manager::reset_caches();
1681     }
1683     // Bump up cacherev field for all courses.
1684     try {
1685         increment_revision_number('course', 'cacherev', '');
1686     } catch (moodle_exception $e) {
1687         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1688     }
1690     $DB->reset_caches();
1692     // Purge all other caches: rss, simplepie, etc.
1693     clearstatcache();
1694     remove_dir($CFG->cachedir.'', true);
1696     // Make sure cache dir is writable, throws exception if not.
1697     make_cache_directory('');
1699     // This is the only place where we purge local caches, we are only adding files there.
1700     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1701     remove_dir($CFG->localcachedir, true);
1702     set_config('localcachedirpurged', time());
1703     make_localcache_directory('', true);
1704     \core\task\manager::clear_static_caches();
1707 /**
1708  * Get volatile flags
1709  *
1710  * @param string $type
1711  * @param int $changedsince default null
1712  * @return array records array
1713  */
1714 function get_cache_flags($type, $changedsince = null) {
1715     global $DB;
1717     $params = array('type' => $type, 'expiry' => time());
1718     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1719     if ($changedsince !== null) {
1720         $params['changedsince'] = $changedsince;
1721         $sqlwhere .= " AND timemodified > :changedsince";
1722     }
1723     $cf = array();
1724     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1725         foreach ($flags as $flag) {
1726             $cf[$flag->name] = $flag->value;
1727         }
1728     }
1729     return $cf;
1732 /**
1733  * Get volatile flags
1734  *
1735  * @param string $type
1736  * @param string $name
1737  * @param int $changedsince default null
1738  * @return string|false The cache flag value or false
1739  */
1740 function get_cache_flag($type, $name, $changedsince=null) {
1741     global $DB;
1743     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1745     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1746     if ($changedsince !== null) {
1747         $params['changedsince'] = $changedsince;
1748         $sqlwhere .= " AND timemodified > :changedsince";
1749     }
1751     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1754 /**
1755  * Set a volatile flag
1756  *
1757  * @param string $type the "type" namespace for the key
1758  * @param string $name the key to set
1759  * @param string $value the value to set (without magic quotes) - null will remove the flag
1760  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1761  * @return bool Always returns true
1762  */
1763 function set_cache_flag($type, $name, $value, $expiry = null) {
1764     global $DB;
1766     $timemodified = time();
1767     if ($expiry === null || $expiry < $timemodified) {
1768         $expiry = $timemodified + 24 * 60 * 60;
1769     } else {
1770         $expiry = (int)$expiry;
1771     }
1773     if ($value === null) {
1774         unset_cache_flag($type, $name);
1775         return true;
1776     }
1778     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1779         // This is a potential problem in DEBUG_DEVELOPER.
1780         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1781             return true; // No need to update.
1782         }
1783         $f->value        = $value;
1784         $f->expiry       = $expiry;
1785         $f->timemodified = $timemodified;
1786         $DB->update_record('cache_flags', $f);
1787     } else {
1788         $f = new stdClass();
1789         $f->flagtype     = $type;
1790         $f->name         = $name;
1791         $f->value        = $value;
1792         $f->expiry       = $expiry;
1793         $f->timemodified = $timemodified;
1794         $DB->insert_record('cache_flags', $f);
1795     }
1796     return true;
1799 /**
1800  * Removes a single volatile flag
1801  *
1802  * @param string $type the "type" namespace for the key
1803  * @param string $name the key to set
1804  * @return bool
1805  */
1806 function unset_cache_flag($type, $name) {
1807     global $DB;
1808     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1809     return true;
1812 /**
1813  * Garbage-collect volatile flags
1814  *
1815  * @return bool Always returns true
1816  */
1817 function gc_cache_flags() {
1818     global $DB;
1819     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1820     return true;
1823 // USER PREFERENCE API.
1825 /**
1826  * Refresh user preference cache. This is used most often for $USER
1827  * object that is stored in session, but it also helps with performance in cron script.
1828  *
1829  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1830  *
1831  * @package  core
1832  * @category preference
1833  * @access   public
1834  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1835  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1836  * @throws   coding_exception
1837  * @return   null
1838  */
1839 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1840     global $DB;
1841     // Static cache, we need to check on each page load, not only every 2 minutes.
1842     static $loadedusers = array();
1844     if (!isset($user->id)) {
1845         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1846     }
1848     if (empty($user->id) or isguestuser($user->id)) {
1849         // No permanent storage for not-logged-in users and guest.
1850         if (!isset($user->preference)) {
1851             $user->preference = array();
1852         }
1853         return;
1854     }
1856     $timenow = time();
1858     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1859         // Already loaded at least once on this page. Are we up to date?
1860         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1861             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1862             return;
1864         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1865             // No change since the lastcheck on this page.
1866             $user->preference['_lastloaded'] = $timenow;
1867             return;
1868         }
1869     }
1871     // OK, so we have to reload all preferences.
1872     $loadedusers[$user->id] = true;
1873     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1874     $user->preference['_lastloaded'] = $timenow;
1877 /**
1878  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1879  *
1880  * NOTE: internal function, do not call from other code.
1881  *
1882  * @package core
1883  * @access private
1884  * @param integer $userid the user whose prefs were changed.
1885  */
1886 function mark_user_preferences_changed($userid) {
1887     global $CFG;
1889     if (empty($userid) or isguestuser($userid)) {
1890         // No cache flags for guest and not-logged-in users.
1891         return;
1892     }
1894     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1897 /**
1898  * Sets a preference for the specified user.
1899  *
1900  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1901  *
1902  * When additional validation/permission check is needed it is better to use {@see useredit_update_user_preference()}
1903  *
1904  * @package  core
1905  * @category preference
1906  * @access   public
1907  * @param    string            $name  The key to set as preference for the specified user
1908  * @param    string            $value The value to set for the $name key in the specified user's
1909  *                                    record, null means delete current value.
1910  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1911  * @throws   coding_exception
1912  * @return   bool                     Always true or exception
1913  */
1914 function set_user_preference($name, $value, $user = null) {
1915     global $USER, $DB;
1917     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1918         throw new coding_exception('Invalid preference name in set_user_preference() call');
1919     }
1921     if (is_null($value)) {
1922         // Null means delete current.
1923         return unset_user_preference($name, $user);
1924     } else if (is_object($value)) {
1925         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1926     } else if (is_array($value)) {
1927         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1928     }
1929     // Value column maximum length is 1333 characters.
1930     $value = (string)$value;
1931     if (core_text::strlen($value) > 1333) {
1932         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1933     }
1935     if (is_null($user)) {
1936         $user = $USER;
1937     } else if (isset($user->id)) {
1938         // It is a valid object.
1939     } else if (is_numeric($user)) {
1940         $user = (object)array('id' => (int)$user);
1941     } else {
1942         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1943     }
1945     check_user_preferences_loaded($user);
1947     if (empty($user->id) or isguestuser($user->id)) {
1948         // No permanent storage for not-logged-in users and guest.
1949         $user->preference[$name] = $value;
1950         return true;
1951     }
1953     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1954         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1955             // Preference already set to this value.
1956             return true;
1957         }
1958         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1960     } else {
1961         $preference = new stdClass();
1962         $preference->userid = $user->id;
1963         $preference->name   = $name;
1964         $preference->value  = $value;
1965         $DB->insert_record('user_preferences', $preference);
1966     }
1968     // Update value in cache.
1969     $user->preference[$name] = $value;
1970     // Update the $USER in case where we've not a direct reference to $USER.
1971     if ($user !== $USER && $user->id == $USER->id) {
1972         $USER->preference[$name] = $value;
1973     }
1975     // Set reload flag for other sessions.
1976     mark_user_preferences_changed($user->id);
1978     return true;
1981 /**
1982  * Sets a whole array of preferences for the current user
1983  *
1984  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1985  *
1986  * @package  core
1987  * @category preference
1988  * @access   public
1989  * @param    array             $prefarray An array of key/value pairs to be set
1990  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1991  * @return   bool                         Always true or exception
1992  */
1993 function set_user_preferences(array $prefarray, $user = null) {
1994     foreach ($prefarray as $name => $value) {
1995         set_user_preference($name, $value, $user);
1996     }
1997     return true;
2000 /**
2001  * Unsets a preference completely by deleting it from the database
2002  *
2003  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
2004  *
2005  * @package  core
2006  * @category preference
2007  * @access   public
2008  * @param    string            $name The key to unset as preference for the specified user
2009  * @param    stdClass|int|null $user A moodle user object or id, null means current user
2010  * @throws   coding_exception
2011  * @return   bool                    Always true or exception
2012  */
2013 function unset_user_preference($name, $user = null) {
2014     global $USER, $DB;
2016     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
2017         throw new coding_exception('Invalid preference name in unset_user_preference() call');
2018     }
2020     if (is_null($user)) {
2021         $user = $USER;
2022     } else if (isset($user->id)) {
2023         // It is a valid object.
2024     } else if (is_numeric($user)) {
2025         $user = (object)array('id' => (int)$user);
2026     } else {
2027         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
2028     }
2030     check_user_preferences_loaded($user);
2032     if (empty($user->id) or isguestuser($user->id)) {
2033         // No permanent storage for not-logged-in user and guest.
2034         unset($user->preference[$name]);
2035         return true;
2036     }
2038     // Delete from DB.
2039     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
2041     // Delete the preference from cache.
2042     unset($user->preference[$name]);
2043     // Update the $USER in case where we've not a direct reference to $USER.
2044     if ($user !== $USER && $user->id == $USER->id) {
2045         unset($USER->preference[$name]);
2046     }
2048     // Set reload flag for other sessions.
2049     mark_user_preferences_changed($user->id);
2051     return true;
2054 /**
2055  * Used to fetch user preference(s)
2056  *
2057  * If no arguments are supplied this function will return
2058  * all of the current user preferences as an array.
2059  *
2060  * If a name is specified then this function
2061  * attempts to return that particular preference value.  If
2062  * none is found, then the optional value $default is returned,
2063  * otherwise null.
2064  *
2065  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
2066  *
2067  * @package  core
2068  * @category preference
2069  * @access   public
2070  * @param    string            $name    Name of the key to use in finding a preference value
2071  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
2072  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
2073  * @throws   coding_exception
2074  * @return   string|mixed|null          A string containing the value of a single preference. An
2075  *                                      array with all of the preferences or null
2076  */
2077 function get_user_preferences($name = null, $default = null, $user = null) {
2078     global $USER;
2080     if (is_null($name)) {
2081         // All prefs.
2082     } else if (is_numeric($name) or $name === '_lastloaded') {
2083         throw new coding_exception('Invalid preference name in get_user_preferences() call');
2084     }
2086     if (is_null($user)) {
2087         $user = $USER;
2088     } else if (isset($user->id)) {
2089         // Is a valid object.
2090     } else if (is_numeric($user)) {
2091         if ($USER->id == $user) {
2092             $user = $USER;
2093         } else {
2094             $user = (object)array('id' => (int)$user);
2095         }
2096     } else {
2097         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2098     }
2100     check_user_preferences_loaded($user);
2102     if (empty($name)) {
2103         // All values.
2104         return $user->preference;
2105     } else if (isset($user->preference[$name])) {
2106         // The single string value.
2107         return $user->preference[$name];
2108     } else {
2109         // Default value (null if not specified).
2110         return $default;
2111     }
2114 // FUNCTIONS FOR HANDLING TIME.
2116 /**
2117  * Given Gregorian date parts in user time produce a GMT timestamp.
2118  *
2119  * @package core
2120  * @category time
2121  * @param int $year The year part to create timestamp of
2122  * @param int $month The month part to create timestamp of
2123  * @param int $day The day part to create timestamp of
2124  * @param int $hour The hour part to create timestamp of
2125  * @param int $minute The minute part to create timestamp of
2126  * @param int $second The second part to create timestamp of
2127  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2128  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2129  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2130  *             applied only if timezone is 99 or string.
2131  * @return int GMT timestamp
2132  */
2133 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2134     $date = new DateTime('now', core_date::get_user_timezone_object($timezone));
2135     $date->setDate((int)$year, (int)$month, (int)$day);
2136     $date->setTime((int)$hour, (int)$minute, (int)$second);
2138     $time = $date->getTimestamp();
2140     if ($time === false) {
2141         throw new coding_exception('getTimestamp() returned false, please ensure you have passed correct values.'.
2142             ' This can fail if year is more than 2038 and OS is 32 bit windows');
2143     }
2145     // Moodle BC DST stuff.
2146     if (!$applydst) {
2147         $time += dst_offset_on($time, $timezone);
2148     }
2150     return $time;
2154 /**
2155  * Format a date/time (seconds) as weeks, days, hours etc as needed
2156  *
2157  * Given an amount of time in seconds, returns string
2158  * formatted nicely as years, days, hours etc as needed
2159  *
2160  * @package core
2161  * @category time
2162  * @uses MINSECS
2163  * @uses HOURSECS
2164  * @uses DAYSECS
2165  * @uses YEARSECS
2166  * @param int $totalsecs Time in seconds
2167  * @param stdClass $str Should be a time object
2168  * @return string A nicely formatted date/time string
2169  */
2170 function format_time($totalsecs, $str = null) {
2172     $totalsecs = abs($totalsecs);
2174     if (!$str) {
2175         // Create the str structure the slow way.
2176         $str = new stdClass();
2177         $str->day   = get_string('day');
2178         $str->days  = get_string('days');
2179         $str->hour  = get_string('hour');
2180         $str->hours = get_string('hours');
2181         $str->min   = get_string('min');
2182         $str->mins  = get_string('mins');
2183         $str->sec   = get_string('sec');
2184         $str->secs  = get_string('secs');
2185         $str->year  = get_string('year');
2186         $str->years = get_string('years');
2187     }
2189     $years     = floor($totalsecs/YEARSECS);
2190     $remainder = $totalsecs - ($years*YEARSECS);
2191     $days      = floor($remainder/DAYSECS);
2192     $remainder = $totalsecs - ($days*DAYSECS);
2193     $hours     = floor($remainder/HOURSECS);
2194     $remainder = $remainder - ($hours*HOURSECS);
2195     $mins      = floor($remainder/MINSECS);
2196     $secs      = $remainder - ($mins*MINSECS);
2198     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2199     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2200     $sh = ($hours == 1) ? $str->hour : $str->hours;
2201     $sd = ($days == 1)  ? $str->day  : $str->days;
2202     $sy = ($years == 1)  ? $str->year  : $str->years;
2204     $oyears = '';
2205     $odays = '';
2206     $ohours = '';
2207     $omins = '';
2208     $osecs = '';
2210     if ($years) {
2211         $oyears  = $years .' '. $sy;
2212     }
2213     if ($days) {
2214         $odays  = $days .' '. $sd;
2215     }
2216     if ($hours) {
2217         $ohours = $hours .' '. $sh;
2218     }
2219     if ($mins) {
2220         $omins  = $mins .' '. $sm;
2221     }
2222     if ($secs) {
2223         $osecs  = $secs .' '. $ss;
2224     }
2226     if ($years) {
2227         return trim($oyears .' '. $odays);
2228     }
2229     if ($days) {
2230         return trim($odays .' '. $ohours);
2231     }
2232     if ($hours) {
2233         return trim($ohours .' '. $omins);
2234     }
2235     if ($mins) {
2236         return trim($omins .' '. $osecs);
2237     }
2238     if ($secs) {
2239         return $osecs;
2240     }
2241     return get_string('now');
2244 /**
2245  * Returns a formatted string that represents a date in user time.
2246  *
2247  * @package core
2248  * @category time
2249  * @param int $date the timestamp in UTC, as obtained from the database.
2250  * @param string $format strftime format. You should probably get this using
2251  *        get_string('strftime...', 'langconfig');
2252  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2253  *        not 99 then daylight saving will not be added.
2254  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2255  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2256  *        If false then the leading zero is maintained.
2257  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2258  * @return string the formatted date/time.
2259  */
2260 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2261     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2262     return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
2265 /**
2266  * Returns a html "time" tag with both the exact user date with timezone information
2267  * as a datetime attribute in the W3C format, and the user readable date and time as text.
2268  *
2269  * @package core
2270  * @category time
2271  * @param int $date the timestamp in UTC, as obtained from the database.
2272  * @param string $format strftime format. You should probably get this using
2273  *        get_string('strftime...', 'langconfig');
2274  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2275  *        not 99 then daylight saving will not be added.
2276  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2277  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2278  *        If false then the leading zero is maintained.
2279  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2280  * @return string the formatted date/time.
2281  */
2282 function userdate_htmltime($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2283     $userdatestr = userdate($date, $format, $timezone, $fixday, $fixhour);
2284     if (CLI_SCRIPT && !PHPUNIT_TEST) {
2285         return $userdatestr;
2286     }
2287     $machinedate = new DateTime();
2288     $machinedate->setTimestamp(intval($date));
2289     $machinedate->setTimezone(core_date::get_user_timezone_object());
2291     return html_writer::tag('time', $userdatestr, ['datetime' => $machinedate->format(DateTime::W3C)]);
2294 /**
2295  * Returns a formatted date ensuring it is UTF-8.
2296  *
2297  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2298  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2299  *
2300  * @param int $date the timestamp - since Moodle 2.9 this is a real UTC timestamp
2301  * @param string $format strftime format.
2302  * @param int|float|string $tz the user timezone
2303  * @return string the formatted date/time.
2304  * @since Moodle 2.3.3
2305  */
2306 function date_format_string($date, $format, $tz = 99) {
2307     global $CFG;
2309     $localewincharset = null;
2310     // Get the calendar type user is using.
2311     if ($CFG->ostype == 'WINDOWS') {
2312         $calendartype = \core_calendar\type_factory::get_calendar_instance();
2313         $localewincharset = $calendartype->locale_win_charset();
2314     }
2316     if ($localewincharset) {
2317         $format = core_text::convert($format, 'utf-8', $localewincharset);
2318     }
2320     date_default_timezone_set(core_date::get_user_timezone($tz));
2321     $datestring = strftime($format, $date);
2322     core_date::set_default_server_timezone();
2324     if ($localewincharset) {
2325         $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2326     }
2328     return $datestring;
2331 /**
2332  * Given a $time timestamp in GMT (seconds since epoch),
2333  * returns an array that represents the Gregorian date in user time
2334  *
2335  * @package core
2336  * @category time
2337  * @param int $time Timestamp in GMT
2338  * @param float|int|string $timezone user timezone
2339  * @return array An array that represents the date in user time
2340  */
2341 function usergetdate($time, $timezone=99) {
2342     date_default_timezone_set(core_date::get_user_timezone($timezone));
2343     $result = getdate($time);
2344     core_date::set_default_server_timezone();
2346     return $result;
2349 /**
2350  * Given a GMT timestamp (seconds since epoch), offsets it by
2351  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2352  *
2353  * NOTE: this function does not include DST properly,
2354  *       you should use the PHP date stuff instead!
2355  *
2356  * @package core
2357  * @category time
2358  * @param int $date Timestamp in GMT
2359  * @param float|int|string $timezone user timezone
2360  * @return int
2361  */
2362 function usertime($date, $timezone=99) {
2363     $userdate = new DateTime('@' . $date);
2364     $userdate->setTimezone(core_date::get_user_timezone_object($timezone));
2365     $dst = dst_offset_on($date, $timezone);
2367     return $date - $userdate->getOffset() + $dst;
2370 /**
2371  * Given a time, return the GMT timestamp of the most recent midnight
2372  * for the current user.
2373  *
2374  * @package core
2375  * @category time
2376  * @param int $date Timestamp in GMT
2377  * @param float|int|string $timezone user timezone
2378  * @return int Returns a GMT timestamp
2379  */
2380 function usergetmidnight($date, $timezone=99) {
2382     $userdate = usergetdate($date, $timezone);
2384     // Time of midnight of this user's day, in GMT.
2385     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2389 /**
2390  * Returns a string that prints the user's timezone
2391  *
2392  * @package core
2393  * @category time
2394  * @param float|int|string $timezone user timezone
2395  * @return string
2396  */
2397 function usertimezone($timezone=99) {
2398     $tz = core_date::get_user_timezone($timezone);
2399     return core_date::get_localised_timezone($tz);
2402 /**
2403  * Returns a float or a string which denotes the user's timezone
2404  * 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)
2405  * means that for this timezone there are also DST rules to be taken into account
2406  * Checks various settings and picks the most dominant of those which have a value
2407  *
2408  * @package core
2409  * @category time
2410  * @param float|int|string $tz timezone to calculate GMT time offset before
2411  *        calculating user timezone, 99 is default user timezone
2412  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2413  * @return float|string
2414  */
2415 function get_user_timezone($tz = 99) {
2416     global $USER, $CFG;
2418     $timezones = array(
2419         $tz,
2420         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2421         isset($USER->timezone) ? $USER->timezone : 99,
2422         isset($CFG->timezone) ? $CFG->timezone : 99,
2423         );
2425     $tz = 99;
2427     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2428     foreach ($timezones as $nextvalue) {
2429         if ((empty($tz) && !is_numeric($tz)) || $tz == 99) {
2430             $tz = $nextvalue;
2431         }
2432     }
2433     return is_numeric($tz) ? (float) $tz : $tz;
2436 /**
2437  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2438  * - Note: Daylight saving only works for string timezones and not for float.
2439  *
2440  * @package core
2441  * @category time
2442  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2443  * @param int|float|string $strtimezone user timezone
2444  * @return int
2445  */
2446 function dst_offset_on($time, $strtimezone = null) {
2447     $tz = core_date::get_user_timezone($strtimezone);
2448     $date = new DateTime('@' . $time);
2449     $date->setTimezone(new DateTimeZone($tz));
2450     if ($date->format('I') == '1') {
2451         if ($tz === 'Australia/Lord_Howe') {
2452             return 1800;
2453         }
2454         return 3600;
2455     }
2456     return 0;
2459 /**
2460  * Calculates when the day appears in specific month
2461  *
2462  * @package core
2463  * @category time
2464  * @param int $startday starting day of the month
2465  * @param int $weekday The day when week starts (normally taken from user preferences)
2466  * @param int $month The month whose day is sought
2467  * @param int $year The year of the month whose day is sought
2468  * @return int
2469  */
2470 function find_day_in_month($startday, $weekday, $month, $year) {
2471     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2473     $daysinmonth = days_in_month($month, $year);
2474     $daysinweek = count($calendartype->get_weekdays());
2476     if ($weekday == -1) {
2477         // Don't care about weekday, so return:
2478         //    abs($startday) if $startday != -1
2479         //    $daysinmonth otherwise.
2480         return ($startday == -1) ? $daysinmonth : abs($startday);
2481     }
2483     // From now on we 're looking for a specific weekday.
2484     // Give "end of month" its actual value, since we know it.
2485     if ($startday == -1) {
2486         $startday = -1 * $daysinmonth;
2487     }
2489     // Starting from day $startday, the sign is the direction.
2490     if ($startday < 1) {
2491         $startday = abs($startday);
2492         $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
2494         // This is the last such weekday of the month.
2495         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2496         if ($lastinmonth > $daysinmonth) {
2497             $lastinmonth -= $daysinweek;
2498         }
2500         // Find the first such weekday <= $startday.
2501         while ($lastinmonth > $startday) {
2502             $lastinmonth -= $daysinweek;
2503         }
2505         return $lastinmonth;
2506     } else {
2507         $indexweekday = dayofweek($startday, $month, $year);
2509         $diff = $weekday - $indexweekday;
2510         if ($diff < 0) {
2511             $diff += $daysinweek;
2512         }
2514         // This is the first such weekday of the month equal to or after $startday.
2515         $firstfromindex = $startday + $diff;
2517         return $firstfromindex;
2518     }
2521 /**
2522  * Calculate the number of days in a given month
2523  *
2524  * @package core
2525  * @category time
2526  * @param int $month The month whose day count is sought
2527  * @param int $year The year of the month whose day count is sought
2528  * @return int
2529  */
2530 function days_in_month($month, $year) {
2531     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2532     return $calendartype->get_num_days_in_month($year, $month);
2535 /**
2536  * Calculate the position in the week of a specific calendar day
2537  *
2538  * @package core
2539  * @category time
2540  * @param int $day The day of the date whose position in the week is sought
2541  * @param int $month The month of the date whose position in the week is sought
2542  * @param int $year The year of the date whose position in the week is sought
2543  * @return int
2544  */
2545 function dayofweek($day, $month, $year) {
2546     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2547     return $calendartype->get_weekday($year, $month, $day);
2550 // USER AUTHENTICATION AND LOGIN.
2552 /**
2553  * Returns full login url.
2554  *
2555  * Any form submissions for authentication to this URL must include username,
2556  * password as well as a logintoken generated by \core\session\manager::get_login_token().
2557  *
2558  * @return string login url
2559  */
2560 function get_login_url() {
2561     global $CFG;
2563     return "$CFG->wwwroot/login/index.php";
2566 /**
2567  * This function checks that the current user is logged in and has the
2568  * required privileges
2569  *
2570  * This function checks that the current user is logged in, and optionally
2571  * whether they are allowed to be in a particular course and view a particular
2572  * course module.
2573  * If they are not logged in, then it redirects them to the site login unless
2574  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2575  * case they are automatically logged in as guests.
2576  * If $courseid is given and the user is not enrolled in that course then the
2577  * user is redirected to the course enrolment page.
2578  * If $cm is given and the course module is hidden and the user is not a teacher
2579  * in the course then the user is redirected to the course home page.
2580  *
2581  * When $cm parameter specified, this function sets page layout to 'module'.
2582  * You need to change it manually later if some other layout needed.
2583  *
2584  * @package    core_access
2585  * @category   access
2586  *
2587  * @param mixed $courseorid id of the course or course object
2588  * @param bool $autologinguest default true
2589  * @param object $cm course module object
2590  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2591  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2592  *             in order to keep redirects working properly. MDL-14495
2593  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2594  * @return mixed Void, exit, and die depending on path
2595  * @throws coding_exception
2596  * @throws require_login_exception
2597  * @throws moodle_exception
2598  */
2599 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2600     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2602     // Must not redirect when byteserving already started.
2603     if (!empty($_SERVER['HTTP_RANGE'])) {
2604         $preventredirect = true;
2605     }
2607     if (AJAX_SCRIPT) {
2608         // We cannot redirect for AJAX scripts either.
2609         $preventredirect = true;
2610     }
2612     // Setup global $COURSE, themes, language and locale.
2613     if (!empty($courseorid)) {
2614         if (is_object($courseorid)) {
2615             $course = $courseorid;
2616         } else if ($courseorid == SITEID) {
2617             $course = clone($SITE);
2618         } else {
2619             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2620         }
2621         if ($cm) {
2622             if ($cm->course != $course->id) {
2623                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2624             }
2625             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2626             if (!($cm instanceof cm_info)) {
2627                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2628                 // db queries so this is not really a performance concern, however it is obviously
2629                 // better if you use get_fast_modinfo to get the cm before calling this.
2630                 $modinfo = get_fast_modinfo($course);
2631                 $cm = $modinfo->get_cm($cm->id);
2632             }
2633         }
2634     } else {
2635         // Do not touch global $COURSE via $PAGE->set_course(),
2636         // the reasons is we need to be able to call require_login() at any time!!
2637         $course = $SITE;
2638         if ($cm) {
2639             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2640         }
2641     }
2643     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2644     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2645     // risk leading the user back to the AJAX request URL.
2646     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2647         $setwantsurltome = false;
2648     }
2650     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2651     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !empty($CFG->dbsessions)) {
2652         if ($preventredirect) {
2653             throw new require_login_session_timeout_exception();
2654         } else {
2655             if ($setwantsurltome) {
2656                 $SESSION->wantsurl = qualified_me();
2657             }
2658             redirect(get_login_url());
2659         }
2660     }
2662     // If the user is not even logged in yet then make sure they are.
2663     if (!isloggedin()) {
2664         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2665             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2666                 // Misconfigured site guest, just redirect to login page.
2667                 redirect(get_login_url());
2668                 exit; // Never reached.
2669             }
2670             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2671             complete_user_login($guest);
2672             $USER->autologinguest = true;
2673             $SESSION->lang = $lang;
2674         } else {
2675             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2676             if ($preventredirect) {
2677                 throw new require_login_exception('You are not logged in');
2678             }
2680             if ($setwantsurltome) {
2681                 $SESSION->wantsurl = qualified_me();
2682             }
2684             $referer = get_local_referer(false);
2685             if (!empty($referer)) {
2686                 $SESSION->fromurl = $referer;
2687             }
2689             // Give auth plugins an opportunity to authenticate or redirect to an external login page
2690             $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
2691             foreach($authsequence as $authname) {
2692                 $authplugin = get_auth_plugin($authname);
2693                 $authplugin->pre_loginpage_hook();
2694                 if (isloggedin()) {
2695                     set_access_log_user();
2696                     break;
2697                 }
2698             }
2700             // If we're still not logged in then go to the login page
2701             if (!isloggedin()) {
2702                 redirect(get_login_url());
2703                 exit; // Never reached.
2704             }
2705         }
2706     }
2708     // Loginas as redirection if needed.
2709     if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
2710         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2711             if ($USER->loginascontext->instanceid != $course->id) {
2712                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2713             }
2714         }
2715     }
2717     // Check whether the user should be changing password (but only if it is REALLY them).
2718     if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
2719         $userauth = get_auth_plugin($USER->auth);
2720         if ($userauth->can_change_password() and !$preventredirect) {
2721             if ($setwantsurltome) {
2722                 $SESSION->wantsurl = qualified_me();
2723             }
2724             if ($changeurl = $userauth->change_password_url()) {
2725                 // Use plugin custom url.
2726                 redirect($changeurl);
2727             } else {
2728                 // Use moodle internal method.
2729                 redirect($CFG->wwwroot .'/login/change_password.php');
2730             }
2731         } else if ($userauth->can_change_password()) {
2732             throw new moodle_exception('forcepasswordchangenotice');
2733         } else {
2734             throw new moodle_exception('nopasswordchangeforced', 'auth');
2735         }
2736     }
2738     // Check that the user account is properly set up. If we can't redirect to
2739     // edit their profile and this is not a WS request, perform just the lax check.
2740     // It will allow them to use filepicker on the profile edit page.
2742     if ($preventredirect && !WS_SERVER) {
2743         $usernotfullysetup = user_not_fully_set_up($USER, false);
2744     } else {
2745         $usernotfullysetup = user_not_fully_set_up($USER, true);
2746     }
2748     if ($usernotfullysetup) {
2749         if ($preventredirect) {
2750             throw new moodle_exception('usernotfullysetup');
2751         }
2752         if ($setwantsurltome) {
2753             $SESSION->wantsurl = qualified_me();
2754         }
2755         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2756     }
2758     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2759     sesskey();
2761     if (\core\session\manager::is_loggedinas()) {
2762         // During a "logged in as" session we should force all content to be cleaned because the
2763         // logged in user will be viewing potentially malicious user generated content.
2764         // See MDL-63786 for more details.
2765         $CFG->forceclean = true;
2766     }
2768     // Do not bother admins with any formalities, except for activities pending deletion.
2769     if (is_siteadmin() && !($cm && $cm->deletioninprogress)) {
2770         // Set the global $COURSE.
2771         if ($cm) {
2772             $PAGE->set_cm($cm, $course);
2773             $PAGE->set_pagelayout('incourse');
2774         } else if (!empty($courseorid)) {
2775             $PAGE->set_course($course);
2776         }
2777         // Set accesstime or the user will appear offline which messes up messaging.
2778         // Do not update access time for webservice or ajax requests.
2779         if (!WS_SERVER && !AJAX_SCRIPT) {
2780             user_accesstime_log($course->id);
2781         }
2782         return;
2783     }
2785     // Scripts have a chance to declare that $USER->policyagreed should not be checked.
2786     // This is mostly for places where users are actually accepting the policies, to avoid the redirect loop.
2787     if (!defined('NO_SITEPOLICY_CHECK')) {
2788         define('NO_SITEPOLICY_CHECK', false);
2789     }
2791     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2792     // Do not test if the script explicitly asked for skipping the site policies check.
2793     if (!$USER->policyagreed && !is_siteadmin() && !NO_SITEPOLICY_CHECK) {
2794         $manager = new \core_privacy\local\sitepolicy\manager();
2795         if ($policyurl = $manager->get_redirect_url(isguestuser())) {
2796             if ($preventredirect) {
2797                 throw new moodle_exception('sitepolicynotagreed', 'error', '', $policyurl->out());
2798             }
2799             if ($setwantsurltome) {
2800                 $SESSION->wantsurl = qualified_me();
2801             }
2802             redirect($policyurl);
2803         }
2804     }
2806     // Fetch the system context, the course context, and prefetch its child contexts.
2807     $sysctx = context_system::instance();
2808     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2809     if ($cm) {
2810         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2811     } else {
2812         $cmcontext = null;
2813     }
2815     // If the site is currently under maintenance, then print a message.
2816     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:maintenanceaccess', $sysctx)) {
2817         if ($preventredirect) {
2818             throw new require_login_exception('Maintenance in progress');
2819         }
2820         $PAGE->set_context(null);
2821         print_maintenance_message();
2822     }
2824     // Make sure the course itself is not hidden.
2825     if ($course->id == SITEID) {
2826         // Frontpage can not be hidden.
2827     } else {
2828         if (is_role_switched($course->id)) {
2829             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
2830         } else {
2831             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2832                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
2833                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
2834                 if ($preventredirect) {
2835                     throw new require_login_exception('Course is hidden');
2836                 }
2837                 $PAGE->set_context(null);
2838                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2839                 // the navigation will mess up when trying to find it.
2840                 navigation_node::override_active_url(new moodle_url('/'));
2841                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2842             }
2843         }
2844     }
2846     // Is the user enrolled?
2847     if ($course->id == SITEID) {
2848         // Everybody is enrolled on the frontpage.
2849     } else {
2850         if (\core\session\manager::is_loggedinas()) {
2851             // Make sure the REAL person can access this course first.
2852             $realuser = \core\session\manager::get_realuser();
2853             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
2854                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2855                 if ($preventredirect) {
2856                     throw new require_login_exception('Invalid course login-as access');
2857                 }
2858                 $PAGE->set_context(null);
2859                 echo $OUTPUT->header();
2860                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2861             }
2862         }
2864         $access = false;
2866         if (is_role_switched($course->id)) {
2867             // Ok, user had to be inside this course before the switch.
2868             $access = true;
2870         } else if (is_viewing($coursecontext, $USER)) {
2871             // Ok, no need to mess with enrol.
2872             $access = true;
2874         } else {
2875             if (isset($USER->enrol['enrolled'][$course->id])) {
2876                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2877                     $access = true;
2878                     if (isset($USER->enrol['tempguest'][$course->id])) {
2879                         unset($USER->enrol['tempguest'][$course->id]);
2880                         remove_temp_course_roles($coursecontext);
2881                     }
2882                 } else {
2883                     // Expired.
2884                     unset($USER->enrol['enrolled'][$course->id]);
2885                 }
2886             }
2887             if (isset($USER->enrol['tempguest'][$course->id])) {
2888                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2889                     $access = true;
2890                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2891                     $access = true;
2892                 } else {
2893                     // Expired.
2894                     unset($USER->enrol['tempguest'][$course->id]);
2895                     remove_temp_course_roles($coursecontext);
2896                 }
2897             }
2899             if (!$access) {
2900                 // Cache not ok.
2901                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2902                 if ($until !== false) {
2903                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
2904                     if ($until == 0) {
2905                         $until = ENROL_MAX_TIMESTAMP;
2906                     }
2907                     $USER->enrol['enrolled'][$course->id] = $until;
2908                     $access = true;
2910                 } else {
2911                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
2912                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
2913                     $enrols = enrol_get_plugins(true);
2914                     // First ask all enabled enrol instances in course if they want to auto enrol user.
2915                     foreach ($instances as $instance) {
2916                         if (!isset($enrols[$instance->enrol])) {
2917                             continue;
2918                         }
2919                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2920                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2921                         if ($until !== false) {
2922                             if ($until == 0) {
2923                                 $until = ENROL_MAX_TIMESTAMP;
2924                             }
2925                             $USER->enrol['enrolled'][$course->id] = $until;
2926                             $access = true;
2927                             break;
2928                         }
2929                     }
2930                     // If not enrolled yet try to gain temporary guest access.
2931                     if (!$access) {
2932                         foreach ($instances as $instance) {
2933                             if (!isset($enrols[$instance->enrol])) {
2934                                 continue;
2935                             }
2936                             // Get a duration for the guest access, a timestamp in the future or false.
2937                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2938                             if ($until !== false and $until > time()) {
2939                                 $USER->enrol['tempguest'][$course->id] = $until;
2940                                 $access = true;
2941                                 break;
2942                             }
2943                         }
2944                     }
2945                 }
2946             }
2947         }
2949         if (!$access) {
2950             if ($preventredirect) {
2951                 throw new require_login_exception('Not enrolled');
2952             }
2953             if ($setwantsurltome) {
2954                 $SESSION->wantsurl = qualified_me();
2955             }
2956             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2957         }
2958     }
2960     // Check whether the activity has been scheduled for deletion. If so, then deny access, even for admins.
2961     if ($cm && $cm->deletioninprogress) {
2962         if ($preventredirect) {
2963             throw new moodle_exception('activityisscheduledfordeletion');
2964         }
2965         require_once($CFG->dirroot . '/course/lib.php');
2966         redirect(course_get_url($course), get_string('activityisscheduledfordeletion', 'error'));
2967     }
2969     // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
2970     if ($cm && !$cm->uservisible) {
2971         if ($preventredirect) {
2972             throw new require_login_exception('Activity is hidden');
2973         }
2974         // Get the error message that activity is not available and why (if explanation can be shown to the user).
2975         $PAGE->set_course($course);
2976         $renderer = $PAGE->get_renderer('course');
2977         $message = $renderer->course_section_cm_unavailable_error_message($cm);
2978         redirect(course_get_url($course), $message, null, \core\output\notification::NOTIFY_ERROR);
2979     }
2981     // Set the global $COURSE.
2982     if ($cm) {
2983         $PAGE->set_cm($cm, $course);
2984         $PAGE->set_pagelayout('incourse');
2985     } else if (!empty($courseorid)) {
2986         $PAGE->set_course($course);
2987     }
2989     // Finally access granted, update lastaccess times.
2990     // Do not update access time for webservice or ajax requests.
2991     if (!WS_SERVER && !AJAX_SCRIPT) {
2992         user_accesstime_log($course->id);
2993     }
2997 /**
2998  * This function just makes sure a user is logged out.
2999  *
3000  * @package    core_access
3001  * @category   access
3002  */
3003 function require_logout() {
3004     global $USER, $DB;
3006     if (!isloggedin()) {
3007         // This should not happen often, no need for hooks or events here.
3008         \core\session\manager::terminate_current();
3009         return;
3010     }
3012     // Execute hooks before action.
3013     $authplugins = array();
3014     $authsequence = get_enabled_auth_plugins();
3015     foreach ($authsequence as $authname) {
3016         $authplugins[$authname] = get_auth_plugin($authname);
3017         $authplugins[$authname]->prelogout_hook();
3018     }
3020     // Store info that gets removed during logout.
3021     $sid = session_id();
3022     $event = \core\event\user_loggedout::create(
3023         array(
3024             'userid' => $USER->id,
3025             'objectid' => $USER->id,
3026             'other' => array('sessionid' => $sid),
3027         )
3028     );
3029     if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
3030         $event->add_record_snapshot('sessions', $session);
3031     }
3033     // Clone of $USER object to be used by auth plugins.
3034     $user = fullclone($USER);
3036     // Delete session record and drop $_SESSION content.
3037     \core\session\manager::terminate_current();
3039     // Trigger event AFTER action.
3040     $event->trigger();
3042     // Hook to execute auth plugins redirection after event trigger.
3043     foreach ($authplugins as $authplugin) {
3044         $authplugin->postlogout_hook($user);
3045     }
3048 /**
3049  * Weaker version of require_login()
3050  *
3051  * This is a weaker version of {@link require_login()} which only requires login
3052  * when called from within a course rather than the site page, unless
3053  * the forcelogin option is turned on.
3054  * @see require_login()
3055  *
3056  * @package    core_access
3057  * @category   access
3058  *
3059  * @param mixed $courseorid The course object or id in question
3060  * @param bool $autologinguest Allow autologin guests if that is wanted
3061  * @param object $cm Course activity module if known
3062  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3063  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3064  *             in order to keep redirects working properly. MDL-14495
3065  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3066  * @return void
3067  * @throws coding_exception
3068  */
3069 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3070     global $CFG, $PAGE, $SITE;
3071     $issite = ((is_object($courseorid) and $courseorid->id == SITEID)
3072           or (!is_object($courseorid) and $courseorid == SITEID));
3073     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3074         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3075         // db queries so this is not really a performance concern, however it is obviously
3076         // better if you use get_fast_modinfo to get the cm before calling this.
3077         if (is_object($courseorid)) {
3078             $course = $courseorid;
3079         } else {
3080             $course = clone($SITE);
3081         }
3082         $modinfo = get_fast_modinfo($course);
3083         $cm = $modinfo->get_cm($cm->id);
3084     }
3085     if (!empty($CFG->forcelogin)) {
3086         // Login required for both SITE and courses.
3087         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3089     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3090         // Always login for hidden activities.
3091         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3093     } else if (isloggedin() && !isguestuser()) {
3094         // User is already logged in. Make sure the login is complete (user is fully setup, policies agreed).
3095         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3097     } else if ($issite) {
3098         // Login for SITE not required.
3099         // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3100         if (!empty($courseorid)) {
3101             if (is_object($courseorid)) {
3102                 $course = $courseorid;
3103             } else {
3104                 $course = clone $SITE;
3105             }
3106             if ($cm) {
3107                 if ($cm->course != $course->id) {
3108                     throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3109                 }
3110                 $PAGE->set_cm($cm, $course);
3111                 $PAGE->set_pagelayout('incourse');
3112             } else {
3113                 $PAGE->set_course($course);
3114             }
3115         } else {
3116             // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3117             $PAGE->set_course($PAGE->course);
3118         }
3119         // Do not update access time for webservice or ajax requests.
3120         if (!WS_SERVER && !AJAX_SCRIPT) {
3121             user_accesstime_log(SITEID);
3122         }
3123         return;
3125     } else {
3126         // Course login always required.
3127         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3128     }
3131 /**
3132  * Validates a user key, checking if the key exists, is not expired and the remote ip is correct.
3133  *
3134  * @param  string $keyvalue the key value
3135  * @param  string $script   unique script identifier
3136  * @param  int $instance    instance id
3137  * @return stdClass the key entry in the user_private_key table
3138  * @since Moodle 3.2
3139  * @throws moodle_exception
3140  */
3141 function validate_user_key($keyvalue, $script, $instance) {
3142     global $DB;
3144     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3145         print_error('invalidkey');
3146     }
3148     if (!empty($key->validuntil) and $key->validuntil < time()) {
3149         print_error('expiredkey');
3150     }
3152     if ($key->iprestriction) {
3153         $remoteaddr = getremoteaddr(null);
3154         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3155             print_error('ipmismatch');
3156         }
3157     }
3158     return $key;
3161 /**
3162  * Require key login. Function terminates with error if key not found or incorrect.
3163  *
3164  * @uses NO_MOODLE_COOKIES
3165  * @uses PARAM_ALPHANUM
3166  * @param string $script unique script identifier
3167  * @param int $instance optional instance id
3168  * @param string $keyvalue The key. If not supplied, this will be fetched from the current session.
3169  * @return int Instance ID
3170  */
3171 function require_user_key_login($script, $instance = null, $keyvalue = null) {
3172     global $DB;
3174     if (!NO_MOODLE_COOKIES) {
3175         print_error('sessioncookiesdisable');
3176     }
3178     // Extra safety.
3179     \core\session\manager::write_close();
3181     if (null === $keyvalue) {
3182         $keyvalue = required_param('key', PARAM_ALPHANUM);
3183     }
3185     $key = validate_user_key($keyvalue, $script, $instance);
3187     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3188         print_error('invaliduserid');
3189     }
3191     // Emulate normal session.
3192     enrol_check_plugins($user);
3193     \core\session\manager::set_user($user);
3195     // Note we are not using normal login.
3196     if (!defined('USER_KEY_LOGIN')) {
3197         define('USER_KEY_LOGIN', true);
3198     }
3200     // Return instance id - it might be empty.
3201     return $key->instance;
3204 /**
3205  * Creates a new private user access key.
3206  *
3207  * @param string $script unique target identifier
3208  * @param int $userid
3209  * @param int $instance optional instance id
3210  * @param string $iprestriction optional ip restricted access
3211  * @param int $validuntil key valid only until given data
3212  * @return string access key value
3213  */
3214 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3215     global $DB;
3217     $key = new stdClass();
3218     $key->script        = $script;
3219     $key->userid        = $userid;
3220     $key->instance      = $instance;
3221     $key->iprestriction = $iprestriction;
3222     $key->validuntil    = $validuntil;
3223     $key->timecreated   = time();
3225     // Something long and unique.
3226     $key->value         = md5($userid.'_'.time().random_string(40));
3227     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3228         // Must be unique.
3229         $key->value     = md5($userid.'_'.time().random_string(40));
3230     }
3231     $DB->insert_record('user_private_key', $key);
3232     return $key->value;
3235 /**
3236  * Delete the user's new private user access keys for a particular script.
3237  *
3238  * @param string $script unique target identifier
3239  * @param int $userid
3240  * @return void
3241  */
3242 function delete_user_key($script, $userid) {
3243     global $DB;
3244     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3247 /**
3248  * Gets a private user access key (and creates one if one doesn't exist).
3249  *
3250  * @param string $script unique target identifier
3251  * @param int $userid
3252  * @param int $instance optional instance id
3253  * @param string $iprestriction optional ip restricted access
3254  * @param int $validuntil key valid only until given date
3255  * @return string access key value
3256  */
3257 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3258     global $DB;
3260     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3261                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3262                                                          'validuntil' => $validuntil))) {
3263         return $key->value;
3264     } else {
3265         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3266     }
3270 /**
3271  * Modify the user table by setting the currently logged in user's last login to now.
3272  *
3273  * @return bool Always returns true
3274  */
3275 function update_user_login_times() {
3276     global $USER, $DB;
3278     if (isguestuser()) {
3279         // Do not update guest access times/ips for performance.
3280         return true;
3281     }
3283     $now = time();
3285     $user = new stdClass();
3286     $user->id = $USER->id;
3288     // Make sure all users that logged in have some firstaccess.
3289     if ($USER->firstaccess == 0) {
3290         $USER->firstaccess = $user->firstaccess = $now;
3291     }
3293     // Store the previous current as lastlogin.
3294     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3296     $USER->currentlogin = $user->currentlogin = $now;
3298     // Function user_accesstime_log() may not update immediately, better do it here.
3299     $USER->lastaccess = $user->lastaccess = $now;
3300     $USER->lastip = $user->lastip = getremoteaddr();
3302     // Note: do not call user_update_user() here because this is part of the login process,
3303     //       the login event means that these fields were updated.
3304     $DB->update_record('user', $user);
3305     return true;
3308 /**
3309  * Determines if a user has completed setting up their account.
3310  *
3311  * The lax mode (with $strict = false) has been introduced for special cases
3312  * only where we want to skip certain checks intentionally. This is valid in
3313  * certain mnet or ajax scenarios when the user cannot / should not be
3314  * redirected to edit their profile. In most cases, you should perform the
3315  * strict check.
3316  *
3317  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3318  * @param bool $strict Be more strict and assert id and custom profile fields set, too
3319  * @return bool
3320  */
3321 function user_not_fully_set_up($user, $strict = true) {
3322     global $CFG;
3323     require_once($CFG->dirroot.'/user/profile/lib.php');
3325     if (isguestuser($user)) {
3326         return false;
3327     }
3329     if (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)) {
3330         return true;
3331     }
3333     if ($strict) {
3334         if (empty($user->id)) {
3335             // Strict mode can be used with existing accounts only.
3336             return true;
3337         }
3338         if (!profile_has_required_custom_fields_set($user->id)) {
3339             return true;
3340         }
3341     }
3343     return false;
3346 /**
3347  * Check whether the user has exceeded the bounce threshold
3348  *
3349  * @param stdClass $user A {@link $USER} object
3350  * @return bool true => User has exceeded bounce threshold
3351  */
3352 function over_bounce_threshold($user) {
3353     global $CFG, $DB;
3355     if (empty($CFG->handlebounces)) {
3356         return false;
3357     }
3359     if (empty($user->id)) {
3360         // No real (DB) user, nothing to do here.
3361         return false;
3362     }
3364     // Set sensible defaults.
3365     if (empty($CFG->minbounces)) {
3366         $CFG->minbounces = 10;
3367     }
3368     if (empty($CFG->bounceratio)) {
3369         $CFG->bounceratio = .20;
3370     }
3371     $bouncecount = 0;
3372     $sendcount = 0;
3373     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3374         $bouncecount = $bounce->value;
3375     }
3376     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3377         $sendcount = $send->value;
3378     }
3379     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3382 /**
3383  * Used to increment or reset email sent count
3384  *
3385  * @param stdClass $user object containing an id
3386  * @param bool $reset will reset the count to 0
3387  * @return void
3388  */
3389 function set_send_count($user, $reset=false) {
3390     global $DB;
3392     if (empty($user->id)) {
3393         // No real (DB) user, nothing to do here.
3394         return;
3395     }
3397     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3398         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3399         $DB->update_record('user_preferences', $pref);
3400     } else if (!empty($reset)) {
3401         // If it's not there and we're resetting, don't bother. Make a new one.
3402         $pref = new stdClass();
3403         $pref->name   = 'email_send_count';
3404         $pref->value  = 1;
3405         $pref->userid = $user->id;
3406         $DB->insert_record('user_preferences', $pref, false);
3407     }
3410 /**
3411  * Increment or reset user's email bounce count
3412  *
3413  * @param stdClass $user object containing an id
3414  * @param bool $reset will reset the count to 0
3415  */
3416 function set_bounce_count($user, $reset=false) {
3417     global $DB;
3419     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3420         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3421         $DB->update_record('user_preferences', $pref);
3422     } else if (!empty($reset)) {
3423         // If it's not there and we're resetting, don't bother. Make a new one.
3424         $pref = new stdClass();
3425         $pref->name   = 'email_bounce_count';
3426         $pref->value  = 1;
3427         $pref->userid = $user->id;
3428         $DB->insert_record('user_preferences', $pref, false);
3429     }
3432 /**
3433  * Determines if the logged in user is currently moving an activity
3434  *
3435  * @param int $courseid The id of the course being tested
3436  * @return bool
3437  */
3438 function ismoving($courseid) {
3439     global $USER;
3441     if (!empty($USER->activitycopy)) {
3442         return ($USER->activitycopycourse == $courseid);
3443     }
3444     return false;
3447 /**
3448  * Returns a persons full name
3449  *
3450  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3451  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3452  * specify one.
3453  *
3454  * @param stdClass $user A {@link $USER} object to get full name of.
3455  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3456  * @return string
3457  */
3458 function fullname($user, $override=false) {
3459     global $CFG, $SESSION;
3461     if (!isset($user->firstname) and !isset($user->lastname)) {
3462         return '';
3463     }
3465     // Get all of the name fields.
3466     $allnames = get_all_user_name_fields();
3467     if ($CFG->debugdeveloper) {
3468         foreach ($allnames as $allname) {
3469             if (!property_exists($user, $allname)) {
3470                 // If all the user name fields are not set in the user object, then notify the programmer that it needs to be fixed.
3471                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3472                 // Message has been sent, no point in sending the message multiple times.
3473                 break;
3474             }
3475         }
3476     }
3478     if (!$override) {
3479         if (!empty($CFG->forcefirstname)) {
3480             $user->firstname = $CFG->forcefirstname;
3481         }
3482         if (!empty($CFG->forcelastname)) {
3483             $user->lastname = $CFG->forcelastname;
3484         }
3485     }
3487     if (!empty($SESSION->fullnamedisplay)) {
3488         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3489     }
3491     $template = null;
3492     // If the fullnamedisplay setting is available, set the template to that.
3493     if (isset($CFG->fullnamedisplay)) {
3494         $template = $CFG->fullnamedisplay;
3495     }
3496     // If the template is empty, or set to language, return the language string.
3497     if ((empty($template) || $template == 'language') && !$override) {
3498         return get_string('fullnamedisplay', null, $user);
3499     }
3501     // Check to see if we are displaying according to the alternative full name format.
3502     if ($override) {
3503         if (empty($CFG->alternativefullnameformat) || $CFG->alternativefullnameformat == 'language') {
3504             // Default to show just the user names according to the fullnamedisplay string.
3505             return get_string('fullnamedisplay', null, $user);
3506         } else {
3507             // If the override is true, then change the template to use the complete name.
3508             $template = $CFG->alternativefullnameformat;
3509         }
3510     }
3512     $requirednames = array();
3513     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3514     foreach ($allnames as $allname) {
3515         if (strpos($template, $allname) !== false) {
3516             $requirednames[] = $allname;
3517         }
3518     }
3520     $displayname = $template;
3521     // Switch in the actual data into the template.
3522     foreach ($requirednames as $altname) {
3523         if (isset($user->$altname)) {
3524             // Using empty() on the below if statement causes breakages.
3525             if ((string)$user->$altname == '') {
3526                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3527             } else {
3528                 $displayname = str_replace($altname, $user->$altname, $displayname);
3529             }
3530         } else {
3531             $displayname = str_replace($altname, 'EMPTY', $displayname);
3532         }
3533     }
3534     // Tidy up any misc. characters (Not perfect, but gets most characters).
3535     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3536     // katakana and parenthesis.
3537     $patterns = array();
3538     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3539     // filled in by a user.
3540     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3541     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3542     // This regular expression is to remove any double spaces in the display name.
3543     $patterns[] = '/\s{2,}/u';
3544     foreach ($patterns as $pattern) {
3545         $displayname = preg_replace($pattern, ' ', $displayname);
3546     }
3548     // Trimming $displayname will help the next check to ensure that we don't have a display name with spaces.
3549     $displayname = trim($displayname);
3550     if (empty($displayname)) {
3551         // Going with just the first name if no alternate fields are filled out. May be changed later depending on what
3552         // people in general feel is a good setting to fall back on.
3553         $displayname = $user->firstname;
3554     }
3555     return $displayname;
3558 /**
3559  * A centralised location for the all name fields. Returns an array / sql string snippet.
3560  *
3561  * @param bool $returnsql True for an sql select field snippet.
3562  * @param string $tableprefix table query prefix to use in front of each field.
3563  * @param string $prefix prefix added to the name fields e.g. authorfirstname.
3564  * @param string $fieldprefix sql field prefix e.g. id AS userid.
3565  * @param bool $order moves firstname and lastname to the top of the array / start of the string.
3566  * @return array|string All name fields.
3567  */
3568 function get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) {
3569     // This array is provided in this order because when called by fullname() (above) if firstname is before
3570     // firstnamephonetic str_replace() will change the wrong placeholder.
3571     $alternatenames = array('firstnamephonetic' => 'firstnamephonetic',
3572                             'lastnamephonetic' => 'lastnamephonetic',
3573                             'middlename' => 'middlename',
3574                             'alternatename' => 'alternatename',
3575                             'firstname' => 'firstname',
3576                             'lastname' => 'lastname');
3578     // Let's add a prefix to the array of user name fields if provided.
3579     if ($prefix) {
3580         foreach ($alternatenames as $key => $altname) {
3581             $alternatenames[$key] = $prefix . $altname;
3582         }
3583     }
3585     // If we want the end result to have firstname and lastname at the front / top of the result.
3586     if ($order) {
3587         // Move the last two elements (firstname, lastname) off the array and put them at the top.
3588         for ($i = 0; $i < 2; $i++) {
3589             // Get the last element.
3590             $lastelement = end($alternatenames);
3591             // Remove it from the array.
3592             unset($alternatenames[$lastelement]);
3593             // Put the element back on the top of the array.
3594             $alternatenames = array_merge(array($lastelement => $lastelement), $alternatenames);
3595         }
3596     }
3598     // Create an sql field snippet if requested.
3599     if ($returnsql) {
3600         if ($tableprefix) {
3601             if ($fieldprefix) {
3602                 foreach ($alternatenames as $key => $altname) {
3603                     $alternatenames[$key] = $tableprefix . '.' . $altname . ' AS ' . $fieldprefix . $altname;
3604                 }
3605             } else {
3606                 foreach ($alternatenames as $key => $altname) {
3607                     $alternatenames[$key] = $tableprefix . '.' . $altname;
3608                 }
3609             }
3610         }
3611         $alternatenames = implode(',', $alternatenames);
3612     }
3613     return $alternatenames;
3616 /**
3617  * Reduces lines of duplicated code for getting user name fields.
3618  *
3619  * See also {@link user_picture::unalias()}
3620  *
3621  * @param object $addtoobject Object to add user name fields to.
3622  * @param object $secondobject Object that contains user name field information.
3623  * @param string $prefix prefix to be added to all fields (including $additionalfields) e.g. authorfirstname.
3624  * @param array $additionalfields Additional fields to be matched with data in the second object.
3625  * The key can be set to the user table field name.
3626  * @return object User name fields.
3627  */
3628 function username_load_fields_from_object($addtoobject, $secondobject, $prefix = null, $additionalfields = null) {
3629     $fields = get_all_user_name_fields(false, null, $prefix);
3630     if ($additionalfields) {
3631         // Additional fields can specify their own 'alias' such as 'id' => 'userid'. This checks to see if
3632         // the key is a number and then sets the key to the array value.
3633         foreach ($additionalfields as $key => $value) {
3634             if (is_numeric($key)) {
3635                 $additionalfields[$value] = $prefix . $value;
3636                 unset($additionalfields[$key]);
3637             } else {
3638                 $additionalfields[$key] = $prefix . $value;
3639             }
3640         }
3641         $fields = array_merge($fields, $additionalfields);
3642     }
3643     foreach ($fields as $key => $field) {
3644         // Important that we have all of the user name fields present in the object that we are sending back.
3645      &