Merge branch 'MDL-66551-master' of git://github.com/lameze/moodle
[moodle.git] / lib / moodlelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * moodlelib.php - Moodle main library
19  *
20  * Main library file of miscellaneous general-purpose Moodle functions.
21  * Other main libraries:
22  *  - weblib.php      - functions that produce web output
23  *  - datalib.php     - functions that access the database
24  *
25  * @package    core
26  * @subpackage lib
27  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 defined('MOODLE_INTERNAL') || die();
33 // CONSTANTS (Encased in phpdoc proper comments).
35 // Date and time constants.
36 /**
37  * Time constant - the number of seconds in a year
38  */
39 define('YEARSECS', 31536000);
41 /**
42  * Time constant - the number of seconds in a week
43  */
44 define('WEEKSECS', 604800);
46 /**
47  * Time constant - the number of seconds in a day
48  */
49 define('DAYSECS', 86400);
51 /**
52  * Time constant - the number of seconds in an hour
53  */
54 define('HOURSECS', 3600);
56 /**
57  * Time constant - the number of seconds in a minute
58  */
59 define('MINSECS', 60);
61 /**
62  * Time constant - the number of minutes in a day
63  */
64 define('DAYMINS', 1440);
66 /**
67  * Time constant - the number of minutes in an hour
68  */
69 define('HOURMINS', 60);
71 // Parameter constants - every call to optional_param(), required_param()
72 // or clean_param() should have a specified type of parameter.
74 /**
75  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
76  */
77 define('PARAM_ALPHA',    'alpha');
79 /**
80  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
81  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
82  */
83 define('PARAM_ALPHAEXT', 'alphaext');
85 /**
86  * PARAM_ALPHANUM - expected numbers and letters only.
87  */
88 define('PARAM_ALPHANUM', 'alphanum');
90 /**
91  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
92  */
93 define('PARAM_ALPHANUMEXT', 'alphanumext');
95 /**
96  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
97  */
98 define('PARAM_AUTH',  'auth');
100 /**
101  * PARAM_BASE64 - Base 64 encoded format
102  */
103 define('PARAM_BASE64',   'base64');
105 /**
106  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
107  */
108 define('PARAM_BOOL',     'bool');
110 /**
111  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
112  * checked against the list of capabilities in the database.
113  */
114 define('PARAM_CAPABILITY',   'capability');
116 /**
117  * PARAM_CLEANHTML - cleans submitted HTML code. Note that you almost never want
118  * to use this. The normal mode of operation is to use PARAM_RAW when 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  * Use PARAM_LOCALISEDFLOAT instead.
141  */
142 define('PARAM_FLOAT',  'float');
144 /**
145  * PARAM_LOCALISEDFLOAT - a localised real/floating point number.
146  * This is preferred over PARAM_FLOAT for numbers typed in by the user.
147  * Cleans localised numbers to computer readable numbers; false for invalid numbers.
148  */
149 define('PARAM_LOCALISEDFLOAT',  'localisedfloat');
151 /**
152  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
153  */
154 define('PARAM_HOST',     'host');
156 /**
157  * PARAM_INT - integers only, use when expecting only numbers.
158  */
159 define('PARAM_INT',      'int');
161 /**
162  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
163  */
164 define('PARAM_LANG',  'lang');
166 /**
167  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the
168  * others! Implies PARAM_URL!)
169  */
170 define('PARAM_LOCALURL', 'localurl');
172 /**
173  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
174  */
175 define('PARAM_NOTAGS',   'notags');
177 /**
178  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory
179  * traversals note: the leading slash is not removed, window drive letter is not allowed
180  */
181 define('PARAM_PATH',     'path');
183 /**
184  * PARAM_PEM - Privacy Enhanced Mail format
185  */
186 define('PARAM_PEM',      'pem');
188 /**
189  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
190  */
191 define('PARAM_PERMISSION',   'permission');
193 /**
194  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
195  */
196 define('PARAM_RAW', 'raw');
198 /**
199  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
200  */
201 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
203 /**
204  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
205  */
206 define('PARAM_SAFEDIR',  'safedir');
208 /**
209  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
210  */
211 define('PARAM_SAFEPATH',  'safepath');
213 /**
214  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
215  */
216 define('PARAM_SEQUENCE',  'sequence');
218 /**
219  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
220  */
221 define('PARAM_TAG',   'tag');
223 /**
224  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
225  */
226 define('PARAM_TAGLIST',   'taglist');
228 /**
229  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
230  */
231 define('PARAM_TEXT',  'text');
233 /**
234  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
235  */
236 define('PARAM_THEME',  'theme');
238 /**
239  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but
240  * http://localhost.localdomain/ is ok.
241  */
242 define('PARAM_URL',      'url');
244 /**
245  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user
246  * accounts, do NOT use when syncing with external systems!!
247  */
248 define('PARAM_USERNAME',    'username');
250 /**
251  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
252  */
253 define('PARAM_STRINGID',    'stringid');
255 // DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE.
256 /**
257  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
258  * It was one of the first types, that is why it is abused so much ;-)
259  * @deprecated since 2.0
260  */
261 define('PARAM_CLEAN',    'clean');
263 /**
264  * PARAM_INTEGER - deprecated alias for PARAM_INT
265  * @deprecated since 2.0
266  */
267 define('PARAM_INTEGER',  'int');
269 /**
270  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
271  * @deprecated since 2.0
272  */
273 define('PARAM_NUMBER',  'float');
275 /**
276  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
277  * NOTE: originally alias for PARAM_APLHA
278  * @deprecated since 2.0
279  */
280 define('PARAM_ACTION',   'alphanumext');
282 /**
283  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
284  * NOTE: originally alias for PARAM_APLHA
285  * @deprecated since 2.0
286  */
287 define('PARAM_FORMAT',   'alphanumext');
289 /**
290  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
291  * @deprecated since 2.0
292  */
293 define('PARAM_MULTILANG',  'text');
295 /**
296  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
297  * string separated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
298  * America/Port-au-Prince)
299  */
300 define('PARAM_TIMEZONE', 'timezone');
302 /**
303  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
304  */
305 define('PARAM_CLEANFILE', 'file');
307 /**
308  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
309  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
310  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
311  * NOTE: numbers and underscores are strongly discouraged in plugin names!
312  */
313 define('PARAM_COMPONENT', 'component');
315 /**
316  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
317  * It is usually used together with context id and component.
318  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
319  */
320 define('PARAM_AREA', 'area');
322 /**
323  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'paypal', 'completionstatus'.
324  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
325  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
326  */
327 define('PARAM_PLUGIN', 'plugin');
330 // Web Services.
332 /**
333  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
334  */
335 define('VALUE_REQUIRED', 1);
337 /**
338  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
339  */
340 define('VALUE_OPTIONAL', 2);
342 /**
343  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
344  */
345 define('VALUE_DEFAULT', 0);
347 /**
348  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
349  */
350 define('NULL_NOT_ALLOWED', false);
352 /**
353  * NULL_ALLOWED - the parameter can be set to null in the database
354  */
355 define('NULL_ALLOWED', true);
357 // Page types.
359 /**
360  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
361  */
362 define('PAGE_COURSE_VIEW', 'course-view');
364 /** Get remote addr constant */
365 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
366 /** Get remote addr constant */
367 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
369 // Blog access level constant declaration.
370 define ('BLOG_USER_LEVEL', 1);
371 define ('BLOG_GROUP_LEVEL', 2);
372 define ('BLOG_COURSE_LEVEL', 3);
373 define ('BLOG_SITE_LEVEL', 4);
374 define ('BLOG_GLOBAL_LEVEL', 5);
377 // Tag constants.
378 /**
379  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
380  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
381  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
382  *
383  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
384  */
385 define('TAG_MAX_LENGTH', 50);
387 // Password policy constants.
388 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
389 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
390 define ('PASSWORD_DIGITS', '0123456789');
391 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
393 // Feature constants.
394 // Used for plugin_supports() to report features that are, or are not, supported by a module.
396 /** True if module can provide a grade */
397 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
398 /** True if module supports outcomes */
399 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
400 /** True if module supports advanced grading methods */
401 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
402 /** True if module controls the grade visibility over the gradebook */
403 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
404 /** True if module supports plagiarism plugins */
405 define('FEATURE_PLAGIARISM', 'plagiarism');
407 /** True if module has code to track whether somebody viewed it */
408 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
409 /** True if module has custom completion rules */
410 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
412 /** True if module has no 'view' page (like label) */
413 define('FEATURE_NO_VIEW_LINK', 'viewlink');
414 /** True (which is default) if the module wants support for setting the ID number for grade calculation purposes. */
415 define('FEATURE_IDNUMBER', 'idnumber');
416 /** True if module supports groups */
417 define('FEATURE_GROUPS', 'groups');
418 /** True if module supports groupings */
419 define('FEATURE_GROUPINGS', 'groupings');
420 /**
421  * True if module supports groupmembersonly (which no longer exists)
422  * @deprecated Since Moodle 2.8
423  */
424 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
426 /** Type of module */
427 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
428 /** True if module supports intro editor */
429 define('FEATURE_MOD_INTRO', 'mod_intro');
430 /** True if module has default completion */
431 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
433 define('FEATURE_COMMENT', 'comment');
435 define('FEATURE_RATE', 'rate');
436 /** True if module supports backup/restore of moodle2 format */
437 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
439 /** True if module can show description on course main page */
440 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
442 /** True if module uses the question bank */
443 define('FEATURE_USES_QUESTIONS', 'usesquestions');
445 /**
446  * Maximum filename char size
447  */
448 define('MAX_FILENAME_SIZE', 100);
450 /** Unspecified module archetype */
451 define('MOD_ARCHETYPE_OTHER', 0);
452 /** Resource-like type module */
453 define('MOD_ARCHETYPE_RESOURCE', 1);
454 /** Assignment module archetype */
455 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
456 /** System (not user-addable) module archetype */
457 define('MOD_ARCHETYPE_SYSTEM', 3);
459 /**
460  * Security token used for allowing access
461  * from external application such as web services.
462  * Scripts do not use any session, performance is relatively
463  * low because we need to load access info in each request.
464  * Scripts are executed in parallel.
465  */
466 define('EXTERNAL_TOKEN_PERMANENT', 0);
468 /**
469  * Security token used for allowing access
470  * of embedded applications, the code is executed in the
471  * active user session. Token is invalidated after user logs out.
472  * Scripts are executed serially - normal session locking is used.
473  */
474 define('EXTERNAL_TOKEN_EMBEDDED', 1);
476 /**
477  * The home page should be the site home
478  */
479 define('HOMEPAGE_SITE', 0);
480 /**
481  * The home page should be the users my page
482  */
483 define('HOMEPAGE_MY', 1);
484 /**
485  * The home page can be chosen by the user
486  */
487 define('HOMEPAGE_USER', 2);
489 /**
490  * Hub directory url (should be moodle.org)
491  */
492 define('HUB_HUBDIRECTORYURL', "https://hubdirectory.moodle.org");
495 /**
496  * Moodle.net url (should be moodle.net)
497  */
498 define('HUB_MOODLEORGHUBURL', "https://moodle.net");
499 define('HUB_OLDMOODLEORGHUBURL', "http://hub.moodle.org");
501 /**
502  * Moodle mobile app service name
503  */
504 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
506 /**
507  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
508  */
509 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
511 /**
512  * Course display settings: display all sections on one page.
513  */
514 define('COURSE_DISPLAY_SINGLEPAGE', 0);
515 /**
516  * Course display settings: split pages into a page per section.
517  */
518 define('COURSE_DISPLAY_MULTIPAGE', 1);
520 /**
521  * Authentication constant: String used in password field when password is not stored.
522  */
523 define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
525 /**
526  * Email from header to never include via information.
527  */
528 define('EMAIL_VIA_NEVER', 0);
530 /**
531  * Email from header to always include via information.
532  */
533 define('EMAIL_VIA_ALWAYS', 1);
535 /**
536  * Email from header to only include via information if the address is no-reply.
537  */
538 define('EMAIL_VIA_NO_REPLY_ONLY', 2);
540 // PARAMETER HANDLING.
542 /**
543  * Returns a particular value for the named variable, taken from
544  * POST or GET.  If the parameter doesn't exist then an error is
545  * thrown because we require this variable.
546  *
547  * This function should be used to initialise all required values
548  * in a script that are based on parameters.  Usually it will be
549  * used like this:
550  *    $id = required_param('id', PARAM_INT);
551  *
552  * Please note the $type parameter is now required and the value can not be array.
553  *
554  * @param string $parname the name of the page parameter we want
555  * @param string $type expected type of parameter
556  * @return mixed
557  * @throws coding_exception
558  */
559 function required_param($parname, $type) {
560     if (func_num_args() != 2 or empty($parname) or empty($type)) {
561         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
562     }
563     // POST has precedence.
564     if (isset($_POST[$parname])) {
565         $param = $_POST[$parname];
566     } else if (isset($_GET[$parname])) {
567         $param = $_GET[$parname];
568     } else {
569         print_error('missingparam', '', '', $parname);
570     }
572     if (is_array($param)) {
573         debugging('Invalid array parameter detected in required_param(): '.$parname);
574         // TODO: switch to fatal error in Moodle 2.3.
575         return required_param_array($parname, $type);
576     }
578     return clean_param($param, $type);
581 /**
582  * Returns a particular array value for the named variable, taken from
583  * POST or GET.  If the parameter doesn't exist then an error is
584  * thrown because we require this variable.
585  *
586  * This function should be used to initialise all required values
587  * in a script that are based on parameters.  Usually it will be
588  * used like this:
589  *    $ids = required_param_array('ids', PARAM_INT);
590  *
591  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
592  *
593  * @param string $parname the name of the page parameter we want
594  * @param string $type expected type of parameter
595  * @return array
596  * @throws coding_exception
597  */
598 function required_param_array($parname, $type) {
599     if (func_num_args() != 2 or empty($parname) or empty($type)) {
600         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
601     }
602     // POST has precedence.
603     if (isset($_POST[$parname])) {
604         $param = $_POST[$parname];
605     } else if (isset($_GET[$parname])) {
606         $param = $_GET[$parname];
607     } else {
608         print_error('missingparam', '', '', $parname);
609     }
610     if (!is_array($param)) {
611         print_error('missingparam', '', '', $parname);
612     }
614     $result = array();
615     foreach ($param as $key => $value) {
616         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
617             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
618             continue;
619         }
620         $result[$key] = clean_param($value, $type);
621     }
623     return $result;
626 /**
627  * Returns a particular value for the named variable, taken from
628  * POST or GET, otherwise returning a given default.
629  *
630  * This function should be used to initialise all optional values
631  * in a script that are based on parameters.  Usually it will be
632  * used like this:
633  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
634  *
635  * Please note the $type parameter is now required and the value can not be array.
636  *
637  * @param string $parname the name of the page parameter we want
638  * @param mixed  $default the default value to return if nothing is found
639  * @param string $type expected type of parameter
640  * @return mixed
641  * @throws coding_exception
642  */
643 function optional_param($parname, $default, $type) {
644     if (func_num_args() != 3 or empty($parname) or empty($type)) {
645         throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
646     }
648     // POST has precedence.
649     if (isset($_POST[$parname])) {
650         $param = $_POST[$parname];
651     } else if (isset($_GET[$parname])) {
652         $param = $_GET[$parname];
653     } else {
654         return $default;
655     }
657     if (is_array($param)) {
658         debugging('Invalid array parameter detected in required_param(): '.$parname);
659         // TODO: switch to $default in Moodle 2.3.
660         return optional_param_array($parname, $default, $type);
661     }
663     return clean_param($param, $type);
666 /**
667  * Returns a particular array value for the named variable, taken from
668  * POST or GET, otherwise returning a given default.
669  *
670  * This function should be used to initialise all optional values
671  * in a script that are based on parameters.  Usually it will be
672  * used like this:
673  *    $ids = optional_param('id', array(), PARAM_INT);
674  *
675  * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
676  *
677  * @param string $parname the name of the page parameter we want
678  * @param mixed $default the default value to return if nothing is found
679  * @param string $type expected type of parameter
680  * @return array
681  * @throws coding_exception
682  */
683 function optional_param_array($parname, $default, $type) {
684     if (func_num_args() != 3 or empty($parname) or empty($type)) {
685         throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
686     }
688     // POST has precedence.
689     if (isset($_POST[$parname])) {
690         $param = $_POST[$parname];
691     } else if (isset($_GET[$parname])) {
692         $param = $_GET[$parname];
693     } else {
694         return $default;
695     }
696     if (!is_array($param)) {
697         debugging('optional_param_array() expects array parameters only: '.$parname);
698         return $default;
699     }
701     $result = array();
702     foreach ($param as $key => $value) {
703         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
704             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
705             continue;
706         }
707         $result[$key] = clean_param($value, $type);
708     }
710     return $result;
713 /**
714  * Strict validation of parameter values, the values are only converted
715  * to requested PHP type. Internally it is using clean_param, the values
716  * before and after cleaning must be equal - otherwise
717  * an invalid_parameter_exception is thrown.
718  * Objects and classes are not accepted.
719  *
720  * @param mixed $param
721  * @param string $type PARAM_ constant
722  * @param bool $allownull are nulls valid value?
723  * @param string $debuginfo optional debug information
724  * @return mixed the $param value converted to PHP type
725  * @throws invalid_parameter_exception if $param is not of given type
726  */
727 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
728     if (is_null($param)) {
729         if ($allownull == NULL_ALLOWED) {
730             return null;
731         } else {
732             throw new invalid_parameter_exception($debuginfo);
733         }
734     }
735     if (is_array($param) or is_object($param)) {
736         throw new invalid_parameter_exception($debuginfo);
737     }
739     $cleaned = clean_param($param, $type);
741     if ($type == PARAM_FLOAT) {
742         // Do not detect precision loss here.
743         if (is_float($param) or is_int($param)) {
744             // These always fit.
745         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
746             throw new invalid_parameter_exception($debuginfo);
747         }
748     } else if ((string)$param !== (string)$cleaned) {
749         // Conversion to string is usually lossless.
750         throw new invalid_parameter_exception($debuginfo);
751     }
753     return $cleaned;
756 /**
757  * Makes sure array contains only the allowed types, this function does not validate array key names!
758  *
759  * <code>
760  * $options = clean_param($options, PARAM_INT);
761  * </code>
762  *
763  * @param array $param the variable array we are cleaning
764  * @param string $type expected format of param after cleaning.
765  * @param bool $recursive clean recursive arrays
766  * @return array
767  * @throws coding_exception
768  */
769 function clean_param_array(array $param = null, $type, $recursive = false) {
770     // Convert null to empty array.
771     $param = (array)$param;
772     foreach ($param as $key => $value) {
773         if (is_array($value)) {
774             if ($recursive) {
775                 $param[$key] = clean_param_array($value, $type, true);
776             } else {
777                 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
778             }
779         } else {
780             $param[$key] = clean_param($value, $type);
781         }
782     }
783     return $param;
786 /**
787  * Used by {@link optional_param()} and {@link required_param()} to
788  * clean the variables and/or cast to specific types, based on
789  * an options field.
790  * <code>
791  * $course->format = clean_param($course->format, PARAM_ALPHA);
792  * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
793  * </code>
794  *
795  * @param mixed $param the variable we are cleaning
796  * @param string $type expected format of param after cleaning.
797  * @return mixed
798  * @throws coding_exception
799  */
800 function clean_param($param, $type) {
801     global $CFG;
803     if (is_array($param)) {
804         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
805     } else if (is_object($param)) {
806         if (method_exists($param, '__toString')) {
807             $param = $param->__toString();
808         } else {
809             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
810         }
811     }
813     switch ($type) {
814         case PARAM_RAW:
815             // No cleaning at all.
816             $param = fix_utf8($param);
817             return $param;
819         case PARAM_RAW_TRIMMED:
820             // No cleaning, but strip leading and trailing whitespace.
821             $param = fix_utf8($param);
822             return trim($param);
824         case PARAM_CLEAN:
825             // General HTML cleaning, try to use more specific type if possible this is deprecated!
826             // Please use more specific type instead.
827             if (is_numeric($param)) {
828                 return $param;
829             }
830             $param = fix_utf8($param);
831             // Sweep for scripts, etc.
832             return clean_text($param);
834         case PARAM_CLEANHTML:
835             // Clean html fragment.
836             $param = fix_utf8($param);
837             // Sweep for scripts, etc.
838             $param = clean_text($param, FORMAT_HTML);
839             return trim($param);
841         case PARAM_INT:
842             // Convert to integer.
843             return (int)$param;
845         case PARAM_FLOAT:
846             // Convert to float.
847             return (float)$param;
849         case PARAM_LOCALISEDFLOAT:
850             // Convert to float.
851             return unformat_float($param, true);
853         case PARAM_ALPHA:
854             // Remove everything not `a-z`.
855             return preg_replace('/[^a-zA-Z]/i', '', $param);
857         case PARAM_ALPHAEXT:
858             // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
859             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
861         case PARAM_ALPHANUM:
862             // Remove everything not `a-zA-Z0-9`.
863             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
865         case PARAM_ALPHANUMEXT:
866             // Remove everything not `a-zA-Z0-9_-`.
867             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
869         case PARAM_SEQUENCE:
870             // Remove everything not `0-9,`.
871             return preg_replace('/[^0-9,]/i', '', $param);
873         case PARAM_BOOL:
874             // Convert to 1 or 0.
875             $tempstr = strtolower($param);
876             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
877                 $param = 1;
878             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
879                 $param = 0;
880             } else {
881                 $param = empty($param) ? 0 : 1;
882             }
883             return $param;
885         case PARAM_NOTAGS:
886             // Strip all tags.
887             $param = fix_utf8($param);
888             return strip_tags($param);
890         case PARAM_TEXT:
891             // Leave only tags needed for multilang.
892             $param = fix_utf8($param);
893             // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
894             // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
895             do {
896                 if (strpos($param, '</lang>') !== false) {
897                     // Old and future mutilang syntax.
898                     $param = strip_tags($param, '<lang>');
899                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
900                         break;
901                     }
902                     $open = false;
903                     foreach ($matches[0] as $match) {
904                         if ($match === '</lang>') {
905                             if ($open) {
906                                 $open = false;
907                                 continue;
908                             } else {
909                                 break 2;
910                             }
911                         }
912                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
913                             break 2;
914                         } else {
915                             $open = true;
916                         }
917                     }
918                     if ($open) {
919                         break;
920                     }
921                     return $param;
923                 } else if (strpos($param, '</span>') !== false) {
924                     // Current problematic multilang syntax.
925                     $param = strip_tags($param, '<span>');
926                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
927                         break;
928                     }
929                     $open = false;
930                     foreach ($matches[0] as $match) {
931                         if ($match === '</span>') {
932                             if ($open) {
933                                 $open = false;
934                                 continue;
935                             } else {
936                                 break 2;
937                             }
938                         }
939                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
940                             break 2;
941                         } else {
942                             $open = true;
943                         }
944                     }
945                     if ($open) {
946                         break;
947                     }
948                     return $param;
949                 }
950             } while (false);
951             // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
952             return strip_tags($param);
954         case PARAM_COMPONENT:
955             // We do not want any guessing here, either the name is correct or not
956             // please note only normalised component names are accepted.
957             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]+$/', $param)) {
958                 return '';
959             }
960             if (strpos($param, '__') !== false) {
961                 return '';
962             }
963             if (strpos($param, 'mod_') === 0) {
964                 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
965                 if (substr_count($param, '_') != 1) {
966                     return '';
967                 }
968             }
969             return $param;
971         case PARAM_PLUGIN:
972         case PARAM_AREA:
973             // We do not want any guessing here, either the name is correct or not.
974             if (!is_valid_plugin_name($param)) {
975                 return '';
976             }
977             return $param;
979         case PARAM_SAFEDIR:
980             // Remove everything not a-zA-Z0-9_- .
981             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
983         case PARAM_SAFEPATH:
984             // Remove everything not a-zA-Z0-9/_- .
985             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
987         case PARAM_FILE:
988             // Strip all suspicious characters from filename.
989             $param = fix_utf8($param);
990             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
991             if ($param === '.' || $param === '..') {
992                 $param = '';
993             }
994             return $param;
996         case PARAM_PATH:
997             // Strip all suspicious characters from file path.
998             $param = fix_utf8($param);
999             $param = str_replace('\\', '/', $param);
1001             // Explode the path and clean each element using the PARAM_FILE rules.
1002             $breadcrumb = explode('/', $param);
1003             foreach ($breadcrumb as $key => $crumb) {
1004                 if ($crumb === '.' && $key === 0) {
1005                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
1006                 } else {
1007                     $crumb = clean_param($crumb, PARAM_FILE);
1008                 }
1009                 $breadcrumb[$key] = $crumb;
1010             }
1011             $param = implode('/', $breadcrumb);
1013             // Remove multiple current path (./././) and multiple slashes (///).
1014             $param = preg_replace('~//+~', '/', $param);
1015             $param = preg_replace('~/(\./)+~', '/', $param);
1016             return $param;
1018         case PARAM_HOST:
1019             // Allow FQDN or IPv4 dotted quad.
1020             $param = preg_replace('/[^\.\d\w-]/', '', $param );
1021             // Match ipv4 dotted quad.
1022             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
1023                 // Confirm values are ok.
1024                 if ( $match[0] > 255
1025                      || $match[1] > 255
1026                      || $match[3] > 255
1027                      || $match[4] > 255 ) {
1028                     // Hmmm, what kind of dotted quad is this?
1029                     $param = '';
1030                 }
1031             } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1032                        && !preg_match('/^[\.-]/',  $param) // No leading dots/hyphens.
1033                        && !preg_match('/[\.-]$/',  $param) // No trailing dots/hyphens.
1034                        ) {
1035                 // All is ok - $param is respected.
1036             } else {
1037                 // All is not ok...
1038                 $param='';
1039             }
1040             return $param;
1042         case PARAM_URL:
1043             // Allow safe urls.
1044             $param = fix_utf8($param);
1045             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
1046             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E-u-P-a?I?p?f?q?r?')) {
1047                 // All is ok, param is respected.
1048             } else {
1049                 // Not really ok.
1050                 $param ='';
1051             }
1052             return $param;
1054         case PARAM_LOCALURL:
1055             // Allow http absolute, root relative and relative URLs within wwwroot.
1056             $param = clean_param($param, PARAM_URL);
1057             if (!empty($param)) {
1059                 if ($param === $CFG->wwwroot) {
1060                     // Exact match;
1061                 } else if (preg_match(':^/:', $param)) {
1062                     // Root-relative, ok!
1063                 } else if (preg_match('/^' . preg_quote($CFG->wwwroot . '/', '/') . '/i', $param)) {
1064                     // Absolute, and matches our wwwroot.
1065                 } else {
1066                     // Relative - let's make sure there are no tricks.
1067                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1068                         // Looks ok.
1069                     } else {
1070                         $param = '';
1071                     }
1072                 }
1073             }
1074             return $param;
1076         case PARAM_PEM:
1077             $param = trim($param);
1078             // PEM formatted strings may contain letters/numbers and the symbols:
1079             //   forward slash: /
1080             //   plus sign:     +
1081             //   equal sign:    =
1082             //   , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
1083             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1084                 list($wholething, $body) = $matches;
1085                 unset($wholething, $matches);
1086                 $b64 = clean_param($body, PARAM_BASE64);
1087                 if (!empty($b64)) {
1088                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1089                 } else {
1090                     return '';
1091                 }
1092             }
1093             return '';
1095         case PARAM_BASE64:
1096             if (!empty($param)) {
1097                 // PEM formatted strings may contain letters/numbers and the symbols
1098                 //   forward slash: /
1099                 //   plus sign:     +
1100                 //   equal sign:    =.
1101                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1102                     return '';
1103                 }
1104                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1105                 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1106                 // than (or equal to) 64 characters long.
1107                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1108                     if ($i + 1 == $j) {
1109                         if (64 < strlen($lines[$i])) {
1110                             return '';
1111                         }
1112                         continue;
1113                     }
1115                     if (64 != strlen($lines[$i])) {
1116                         return '';
1117                     }
1118                 }
1119                 return implode("\n", $lines);
1120             } else {
1121                 return '';
1122             }
1124         case PARAM_TAG:
1125             $param = fix_utf8($param);
1126             // Please note it is not safe to use the tag name directly anywhere,
1127             // it must be processed with s(), urlencode() before embedding anywhere.
1128             // Remove some nasties.
1129             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1130             // Convert many whitespace chars into one.
1131             $param = preg_replace('/\s+/u', ' ', $param);
1132             $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
1133             return $param;
1135         case PARAM_TAGLIST:
1136             $param = fix_utf8($param);
1137             $tags = explode(',', $param);
1138             $result = array();
1139             foreach ($tags as $tag) {
1140                 $res = clean_param($tag, PARAM_TAG);
1141                 if ($res !== '') {
1142                     $result[] = $res;
1143                 }
1144             }
1145             if ($result) {
1146                 return implode(',', $result);
1147             } else {
1148                 return '';
1149             }
1151         case PARAM_CAPABILITY:
1152             if (get_capability_info($param)) {
1153                 return $param;
1154             } else {
1155                 return '';
1156             }
1158         case PARAM_PERMISSION:
1159             $param = (int)$param;
1160             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1161                 return $param;
1162             } else {
1163                 return CAP_INHERIT;
1164             }
1166         case PARAM_AUTH:
1167             $param = clean_param($param, PARAM_PLUGIN);
1168             if (empty($param)) {
1169                 return '';
1170             } else if (exists_auth_plugin($param)) {
1171                 return $param;
1172             } else {
1173                 return '';
1174             }
1176         case PARAM_LANG:
1177             $param = clean_param($param, PARAM_SAFEDIR);
1178             if (get_string_manager()->translation_exists($param)) {
1179                 return $param;
1180             } else {
1181                 // Specified language is not installed or param malformed.
1182                 return '';
1183             }
1185         case PARAM_THEME:
1186             $param = clean_param($param, PARAM_PLUGIN);
1187             if (empty($param)) {
1188                 return '';
1189             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1190                 return $param;
1191             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1192                 return $param;
1193             } else {
1194                 // Specified theme is not installed.
1195                 return '';
1196             }
1198         case PARAM_USERNAME:
1199             $param = fix_utf8($param);
1200             $param = trim($param);
1201             // Convert uppercase to lowercase MDL-16919.
1202             $param = core_text::strtolower($param);
1203             if (empty($CFG->extendedusernamechars)) {
1204                 $param = str_replace(" " , "", $param);
1205                 // Regular expression, eliminate all chars EXCEPT:
1206                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1207                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1208             }
1209             return $param;
1211         case PARAM_EMAIL:
1212             $param = fix_utf8($param);
1213             if (validate_email($param)) {
1214                 return $param;
1215             } else {
1216                 return '';
1217             }
1219         case PARAM_STRINGID:
1220             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1221                 return $param;
1222             } else {
1223                 return '';
1224             }
1226         case PARAM_TIMEZONE:
1227             // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
1228             $param = fix_utf8($param);
1229             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1230             if (preg_match($timezonepattern, $param)) {
1231                 return $param;
1232             } else {
1233                 return '';
1234             }
1236         default:
1237             // Doh! throw error, switched parameters in optional_param or another serious problem.
1238             print_error("unknownparamtype", '', '', $type);
1239     }
1242 /**
1243  * Whether the PARAM_* type is compatible in RTL.
1244  *
1245  * Being compatible with RTL means that the data they contain can flow
1246  * from right-to-left or left-to-right without compromising the user experience.
1247  *
1248  * Take URLs for example, they are not RTL compatible as they should always
1249  * flow from the left to the right. This also applies to numbers, email addresses,
1250  * configuration snippets, base64 strings, etc...
1251  *
1252  * This function tries to best guess which parameters can contain localised strings.
1253  *
1254  * @param string $paramtype Constant PARAM_*.
1255  * @return bool
1256  */
1257 function is_rtl_compatible($paramtype) {
1258     return $paramtype == PARAM_TEXT || $paramtype == PARAM_NOTAGS;
1261 /**
1262  * Makes sure the data is using valid utf8, invalid characters are discarded.
1263  *
1264  * Note: this function is not intended for full objects with methods and private properties.
1265  *
1266  * @param mixed $value
1267  * @return mixed with proper utf-8 encoding
1268  */
1269 function fix_utf8($value) {
1270     if (is_null($value) or $value === '') {
1271         return $value;
1273     } else if (is_string($value)) {
1274         if ((string)(int)$value === $value) {
1275             // Shortcut.
1276             return $value;
1277         }
1278         // No null bytes expected in our data, so let's remove it.
1279         $value = str_replace("\0", '', $value);
1281         // Note: this duplicates min_fix_utf8() intentionally.
1282         static $buggyiconv = null;
1283         if ($buggyiconv === null) {
1284             $buggyiconv = (!function_exists('iconv') or @iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1285         }
1287         if ($buggyiconv) {
1288             if (function_exists('mb_convert_encoding')) {
1289                 $subst = mb_substitute_character();
1290                 mb_substitute_character('');
1291                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1292                 mb_substitute_character($subst);
1294             } else {
1295                 // Warn admins on admin/index.php page.
1296                 $result = $value;
1297             }
1299         } else {
1300             $result = @iconv('UTF-8', 'UTF-8//IGNORE', $value);
1301         }
1303         return $result;
1305     } else if (is_array($value)) {
1306         foreach ($value as $k => $v) {
1307             $value[$k] = fix_utf8($v);
1308         }
1309         return $value;
1311     } else if (is_object($value)) {
1312         // Do not modify original.
1313         $value = clone($value);
1314         foreach ($value as $k => $v) {
1315             $value->$k = fix_utf8($v);
1316         }
1317         return $value;
1319     } else {
1320         // This is some other type, no utf-8 here.
1321         return $value;
1322     }
1325 /**
1326  * Return true if given value is integer or string with integer value
1327  *
1328  * @param mixed $value String or Int
1329  * @return bool true if number, false if not
1330  */
1331 function is_number($value) {
1332     if (is_int($value)) {
1333         return true;
1334     } else if (is_string($value)) {
1335         return ((string)(int)$value) === $value;
1336     } else {
1337         return false;
1338     }
1341 /**
1342  * Returns host part from url.
1343  *
1344  * @param string $url full url
1345  * @return string host, null if not found
1346  */
1347 function get_host_from_url($url) {
1348     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1349     if ($matches) {
1350         return $matches[1];
1351     }
1352     return null;
1355 /**
1356  * Tests whether anything was returned by text editor
1357  *
1358  * This function is useful for testing whether something you got back from
1359  * the HTML editor actually contains anything. Sometimes the HTML editor
1360  * appear to be empty, but actually you get back a <br> tag or something.
1361  *
1362  * @param string $string a string containing HTML.
1363  * @return boolean does the string contain any actual content - that is text,
1364  * images, objects, etc.
1365  */
1366 function html_is_blank($string) {
1367     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1370 /**
1371  * Set a key in global configuration
1372  *
1373  * Set a key/value pair in both this session's {@link $CFG} global variable
1374  * and in the 'config' database table for future sessions.
1375  *
1376  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1377  * In that case it doesn't affect $CFG.
1378  *
1379  * A NULL value will delete the entry.
1380  *
1381  * NOTE: this function is called from lib/db/upgrade.php
1382  *
1383  * @param string $name the key to set
1384  * @param string $value the value to set (without magic quotes)
1385  * @param string $plugin (optional) the plugin scope, default null
1386  * @return bool true or exception
1387  */
1388 function set_config($name, $value, $plugin=null) {
1389     global $CFG, $DB;
1391     if (empty($plugin)) {
1392         if (!array_key_exists($name, $CFG->config_php_settings)) {
1393             // So it's defined for this invocation at least.
1394             if (is_null($value)) {
1395                 unset($CFG->$name);
1396             } else {
1397                 // Settings from db are always strings.
1398                 $CFG->$name = (string)$value;
1399             }
1400         }
1402         if ($DB->get_field('config', 'name', array('name' => $name))) {
1403             if ($value === null) {
1404                 $DB->delete_records('config', array('name' => $name));
1405             } else {
1406                 $DB->set_field('config', 'value', $value, array('name' => $name));
1407             }
1408         } else {
1409             if ($value !== null) {
1410                 $config = new stdClass();
1411                 $config->name  = $name;
1412                 $config->value = $value;
1413                 $DB->insert_record('config', $config, false);
1414             }
1415         }
1416         if ($name === 'siteidentifier') {
1417             cache_helper::update_site_identifier($value);
1418         }
1419         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1420     } else {
1421         // Plugin scope.
1422         if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
1423             if ($value===null) {
1424                 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1425             } else {
1426                 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
1427             }
1428         } else {
1429             if ($value !== null) {
1430                 $config = new stdClass();
1431                 $config->plugin = $plugin;
1432                 $config->name   = $name;
1433                 $config->value  = $value;
1434                 $DB->insert_record('config_plugins', $config, false);
1435             }
1436         }
1437         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1438     }
1440     return true;
1443 /**
1444  * Get configuration values from the global config table
1445  * or the config_plugins table.
1446  *
1447  * If called with one parameter, it will load all the config
1448  * variables for one plugin, and return them as an object.
1449  *
1450  * If called with 2 parameters it will return a string single
1451  * value or false if the value is not found.
1452  *
1453  * NOTE: this function is called from lib/db/upgrade.php
1454  *
1455  * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
1456  *     that we need only fetch it once per request.
1457  * @param string $plugin full component name
1458  * @param string $name default null
1459  * @return mixed hash-like object or single value, return false no config found
1460  * @throws dml_exception
1461  */
1462 function get_config($plugin, $name = null) {
1463     global $CFG, $DB;
1465     static $siteidentifier = null;
1467     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1468         $forced =& $CFG->config_php_settings;
1469         $iscore = true;
1470         $plugin = 'core';
1471     } else {
1472         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1473             $forced =& $CFG->forced_plugin_settings[$plugin];
1474         } else {
1475             $forced = array();
1476         }
1477         $iscore = false;
1478     }
1480     if ($siteidentifier === null) {
1481         try {
1482             // This may fail during installation.
1483             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1484             // install the database.
1485             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1486         } catch (dml_exception $ex) {
1487             // Set siteidentifier to false. We don't want to trip this continually.
1488             $siteidentifier = false;
1489             throw $ex;
1490         }
1491     }
1493     if (!empty($name)) {
1494         if (array_key_exists($name, $forced)) {
1495             return (string)$forced[$name];
1496         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1497             return $siteidentifier;
1498         }
1499     }
1501     $cache = cache::make('core', 'config');
1502     $result = $cache->get($plugin);
1503     if ($result === false) {
1504         // The user is after a recordset.
1505         if (!$iscore) {
1506             $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
1507         } else {
1508             // This part is not really used any more, but anyway...
1509             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1510         }
1511         $cache->set($plugin, $result);
1512     }
1514     if (!empty($name)) {
1515         if (array_key_exists($name, $result)) {
1516             return $result[$name];
1517         }
1518         return false;
1519     }
1521     if ($plugin === 'core') {
1522         $result['siteidentifier'] = $siteidentifier;
1523     }
1525     foreach ($forced as $key => $value) {
1526         if (is_null($value) or is_array($value) or is_object($value)) {
1527             // We do not want any extra mess here, just real settings that could be saved in db.
1528             unset($result[$key]);
1529         } else {
1530             // Convert to string as if it went through the DB.
1531             $result[$key] = (string)$value;
1532         }
1533     }
1535     return (object)$result;
1538 /**
1539  * Removes a key from global configuration.
1540  *
1541  * NOTE: this function is called from lib/db/upgrade.php
1542  *
1543  * @param string $name the key to set
1544  * @param string $plugin (optional) the plugin scope
1545  * @return boolean whether the operation succeeded.
1546  */
1547 function unset_config($name, $plugin=null) {
1548     global $CFG, $DB;
1550     if (empty($plugin)) {
1551         unset($CFG->$name);
1552         $DB->delete_records('config', array('name' => $name));
1553         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1554     } else {
1555         $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1556         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1557     }
1559     return true;
1562 /**
1563  * Remove all the config variables for a given plugin.
1564  *
1565  * NOTE: this function is called from lib/db/upgrade.php
1566  *
1567  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1568  * @return boolean whether the operation succeeded.
1569  */
1570 function unset_all_config_for_plugin($plugin) {
1571     global $DB;
1572     // Delete from the obvious config_plugins first.
1573     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1574     // Next delete any suspect settings from config.
1575     $like = $DB->sql_like('name', '?', true, true, false, '|');
1576     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1577     $DB->delete_records_select('config', $like, $params);
1578     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1579     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1581     return true;
1584 /**
1585  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1586  *
1587  * All users are verified if they still have the necessary capability.
1588  *
1589  * @param string $value the value of the config setting.
1590  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1591  * @param bool $includeadmins include administrators.
1592  * @return array of user objects.
1593  */
1594 function get_users_from_config($value, $capability, $includeadmins = true) {
1595     if (empty($value) or $value === '$@NONE@$') {
1596         return array();
1597     }
1599     // We have to make sure that users still have the necessary capability,
1600     // it should be faster to fetch them all first and then test if they are present
1601     // instead of validating them one-by-one.
1602     $users = get_users_by_capability(context_system::instance(), $capability);
1603     if ($includeadmins) {
1604         $admins = get_admins();
1605         foreach ($admins as $admin) {
1606             $users[$admin->id] = $admin;
1607         }
1608     }
1610     if ($value === '$@ALL@$') {
1611         return $users;
1612     }
1614     $result = array(); // Result in correct order.
1615     $allowed = explode(',', $value);
1616     foreach ($allowed as $uid) {
1617         if (isset($users[$uid])) {
1618             $user = $users[$uid];
1619             $result[$user->id] = $user;
1620         }
1621     }
1623     return $result;
1627 /**
1628  * Invalidates browser caches and cached data in temp.
1629  *
1630  * @return void
1631  */
1632 function purge_all_caches() {
1633     purge_caches();
1636 /**
1637  * Selectively invalidate different types of cache.
1638  *
1639  * Purges the cache areas specified.  By default, this will purge all caches but can selectively purge specific
1640  * areas alone or in combination.
1641  *
1642  * @param bool[] $options Specific parts of the cache to purge. Valid options are:
1643  *        'muc'    Purge MUC caches?
1644  *        'theme'  Purge theme cache?
1645  *        'lang'   Purge language string cache?
1646  *        'js'     Purge javascript cache?
1647  *        'filter' Purge text filter cache?
1648  *        'other'  Purge all other caches?
1649  */
1650 function purge_caches($options = []) {
1651     $defaults = array_fill_keys(['muc', 'theme', 'lang', 'js', 'template', 'filter', 'other'], false);
1652     if (empty(array_filter($options))) {
1653         $options = array_fill_keys(array_keys($defaults), true); // Set all options to true.
1654     } else {
1655         $options = array_merge($defaults, array_intersect_key($options, $defaults)); // Override defaults with specified options.
1656     }
1657     if ($options['muc']) {
1658         cache_helper::purge_all();
1659     }
1660     if ($options['theme']) {
1661         theme_reset_all_caches();
1662     }
1663     if ($options['lang']) {
1664         get_string_manager()->reset_caches();
1665     }
1666     if ($options['js']) {
1667         js_reset_all_caches();
1668     }
1669     if ($options['template']) {
1670         template_reset_all_caches();
1671     }
1672     if ($options['filter']) {
1673         reset_text_filters_cache();
1674     }
1675     if ($options['other']) {
1676         purge_other_caches();
1677     }
1680 /**
1681  * Purge all non-MUC caches not otherwise purged in purge_caches.
1682  *
1683  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1684  * {@link phpunit_util::reset_dataroot()}
1685  */
1686 function purge_other_caches() {
1687     global $DB, $CFG;
1688     core_text::reset_caches();
1689     if (class_exists('core_plugin_manager')) {
1690         core_plugin_manager::reset_caches();
1691     }
1693     // Bump up cacherev field for all courses.
1694     try {
1695         increment_revision_number('course', 'cacherev', '');
1696     } catch (moodle_exception $e) {
1697         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1698     }
1700     $DB->reset_caches();
1702     // Purge all other caches: rss, simplepie, etc.
1703     clearstatcache();
1704     remove_dir($CFG->cachedir.'', true);
1706     // Make sure cache dir is writable, throws exception if not.
1707     make_cache_directory('');
1709     // This is the only place where we purge local caches, we are only adding files there.
1710     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1711     remove_dir($CFG->localcachedir, true);
1712     set_config('localcachedirpurged', time());
1713     make_localcache_directory('', true);
1714     \core\task\manager::clear_static_caches();
1717 /**
1718  * Get volatile flags
1719  *
1720  * @param string $type
1721  * @param int $changedsince default null
1722  * @return array records array
1723  */
1724 function get_cache_flags($type, $changedsince = null) {
1725     global $DB;
1727     $params = array('type' => $type, 'expiry' => time());
1728     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1729     if ($changedsince !== null) {
1730         $params['changedsince'] = $changedsince;
1731         $sqlwhere .= " AND timemodified > :changedsince";
1732     }
1733     $cf = array();
1734     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1735         foreach ($flags as $flag) {
1736             $cf[$flag->name] = $flag->value;
1737         }
1738     }
1739     return $cf;
1742 /**
1743  * Get volatile flags
1744  *
1745  * @param string $type
1746  * @param string $name
1747  * @param int $changedsince default null
1748  * @return string|false The cache flag value or false
1749  */
1750 function get_cache_flag($type, $name, $changedsince=null) {
1751     global $DB;
1753     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1755     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1756     if ($changedsince !== null) {
1757         $params['changedsince'] = $changedsince;
1758         $sqlwhere .= " AND timemodified > :changedsince";
1759     }
1761     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1764 /**
1765  * Set a volatile flag
1766  *
1767  * @param string $type the "type" namespace for the key
1768  * @param string $name the key to set
1769  * @param string $value the value to set (without magic quotes) - null will remove the flag
1770  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1771  * @return bool Always returns true
1772  */
1773 function set_cache_flag($type, $name, $value, $expiry = null) {
1774     global $DB;
1776     $timemodified = time();
1777     if ($expiry === null || $expiry < $timemodified) {
1778         $expiry = $timemodified + 24 * 60 * 60;
1779     } else {
1780         $expiry = (int)$expiry;
1781     }
1783     if ($value === null) {
1784         unset_cache_flag($type, $name);
1785         return true;
1786     }
1788     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1789         // This is a potential problem in DEBUG_DEVELOPER.
1790         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1791             return true; // No need to update.
1792         }
1793         $f->value        = $value;
1794         $f->expiry       = $expiry;
1795         $f->timemodified = $timemodified;
1796         $DB->update_record('cache_flags', $f);
1797     } else {
1798         $f = new stdClass();
1799         $f->flagtype     = $type;
1800         $f->name         = $name;
1801         $f->value        = $value;
1802         $f->expiry       = $expiry;
1803         $f->timemodified = $timemodified;
1804         $DB->insert_record('cache_flags', $f);
1805     }
1806     return true;
1809 /**
1810  * Removes a single volatile flag
1811  *
1812  * @param string $type the "type" namespace for the key
1813  * @param string $name the key to set
1814  * @return bool
1815  */
1816 function unset_cache_flag($type, $name) {
1817     global $DB;
1818     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1819     return true;
1822 /**
1823  * Garbage-collect volatile flags
1824  *
1825  * @return bool Always returns true
1826  */
1827 function gc_cache_flags() {
1828     global $DB;
1829     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1830     return true;
1833 // USER PREFERENCE API.
1835 /**
1836  * Refresh user preference cache. This is used most often for $USER
1837  * object that is stored in session, but it also helps with performance in cron script.
1838  *
1839  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1840  *
1841  * @package  core
1842  * @category preference
1843  * @access   public
1844  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1845  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1846  * @throws   coding_exception
1847  * @return   null
1848  */
1849 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1850     global $DB;
1851     // Static cache, we need to check on each page load, not only every 2 minutes.
1852     static $loadedusers = array();
1854     if (!isset($user->id)) {
1855         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1856     }
1858     if (empty($user->id) or isguestuser($user->id)) {
1859         // No permanent storage for not-logged-in users and guest.
1860         if (!isset($user->preference)) {
1861             $user->preference = array();
1862         }
1863         return;
1864     }
1866     $timenow = time();
1868     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1869         // Already loaded at least once on this page. Are we up to date?
1870         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1871             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1872             return;
1874         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1875             // No change since the lastcheck on this page.
1876             $user->preference['_lastloaded'] = $timenow;
1877             return;
1878         }
1879     }
1881     // OK, so we have to reload all preferences.
1882     $loadedusers[$user->id] = true;
1883     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1884     $user->preference['_lastloaded'] = $timenow;
1887 /**
1888  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1889  *
1890  * NOTE: internal function, do not call from other code.
1891  *
1892  * @package core
1893  * @access private
1894  * @param integer $userid the user whose prefs were changed.
1895  */
1896 function mark_user_preferences_changed($userid) {
1897     global $CFG;
1899     if (empty($userid) or isguestuser($userid)) {
1900         // No cache flags for guest and not-logged-in users.
1901         return;
1902     }
1904     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1907 /**
1908  * Sets a preference for the specified user.
1909  *
1910  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1911  *
1912  * When additional validation/permission check is needed it is better to use {@see useredit_update_user_preference()}
1913  *
1914  * @package  core
1915  * @category preference
1916  * @access   public
1917  * @param    string            $name  The key to set as preference for the specified user
1918  * @param    string            $value The value to set for the $name key in the specified user's
1919  *                                    record, null means delete current value.
1920  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1921  * @throws   coding_exception
1922  * @return   bool                     Always true or exception
1923  */
1924 function set_user_preference($name, $value, $user = null) {
1925     global $USER, $DB;
1927     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1928         throw new coding_exception('Invalid preference name in set_user_preference() call');
1929     }
1931     if (is_null($value)) {
1932         // Null means delete current.
1933         return unset_user_preference($name, $user);
1934     } else if (is_object($value)) {
1935         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1936     } else if (is_array($value)) {
1937         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1938     }
1939     // Value column maximum length is 1333 characters.
1940     $value = (string)$value;
1941     if (core_text::strlen($value) > 1333) {
1942         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1943     }
1945     if (is_null($user)) {
1946         $user = $USER;
1947     } else if (isset($user->id)) {
1948         // It is a valid object.
1949     } else if (is_numeric($user)) {
1950         $user = (object)array('id' => (int)$user);
1951     } else {
1952         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1953     }
1955     check_user_preferences_loaded($user);
1957     if (empty($user->id) or isguestuser($user->id)) {
1958         // No permanent storage for not-logged-in users and guest.
1959         $user->preference[$name] = $value;
1960         return true;
1961     }
1963     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1964         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1965             // Preference already set to this value.
1966             return true;
1967         }
1968         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1970     } else {
1971         $preference = new stdClass();
1972         $preference->userid = $user->id;
1973         $preference->name   = $name;
1974         $preference->value  = $value;
1975         $DB->insert_record('user_preferences', $preference);
1976     }
1978     // Update value in cache.
1979     $user->preference[$name] = $value;
1980     // Update the $USER in case where we've not a direct reference to $USER.
1981     if ($user !== $USER && $user->id == $USER->id) {
1982         $USER->preference[$name] = $value;
1983     }
1985     // Set reload flag for other sessions.
1986     mark_user_preferences_changed($user->id);
1988     return true;
1991 /**
1992  * Sets a whole array of preferences for the current user
1993  *
1994  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1995  *
1996  * @package  core
1997  * @category preference
1998  * @access   public
1999  * @param    array             $prefarray An array of key/value pairs to be set
2000  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
2001  * @return   bool                         Always true or exception
2002  */
2003 function set_user_preferences(array $prefarray, $user = null) {
2004     foreach ($prefarray as $name => $value) {
2005         set_user_preference($name, $value, $user);
2006     }
2007     return true;
2010 /**
2011  * Unsets a preference completely by deleting it from the database
2012  *
2013  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
2014  *
2015  * @package  core
2016  * @category preference
2017  * @access   public
2018  * @param    string            $name The key to unset as preference for the specified user
2019  * @param    stdClass|int|null $user A moodle user object or id, null means current user
2020  * @throws   coding_exception
2021  * @return   bool                    Always true or exception
2022  */
2023 function unset_user_preference($name, $user = null) {
2024     global $USER, $DB;
2026     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
2027         throw new coding_exception('Invalid preference name in unset_user_preference() call');
2028     }
2030     if (is_null($user)) {
2031         $user = $USER;
2032     } else if (isset($user->id)) {
2033         // It is a valid object.
2034     } else if (is_numeric($user)) {
2035         $user = (object)array('id' => (int)$user);
2036     } else {
2037         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
2038     }
2040     check_user_preferences_loaded($user);
2042     if (empty($user->id) or isguestuser($user->id)) {
2043         // No permanent storage for not-logged-in user and guest.
2044         unset($user->preference[$name]);
2045         return true;
2046     }
2048     // Delete from DB.
2049     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
2051     // Delete the preference from cache.
2052     unset($user->preference[$name]);
2053     // Update the $USER in case where we've not a direct reference to $USER.
2054     if ($user !== $USER && $user->id == $USER->id) {
2055         unset($USER->preference[$name]);
2056     }
2058     // Set reload flag for other sessions.
2059     mark_user_preferences_changed($user->id);
2061     return true;
2064 /**
2065  * Used to fetch user preference(s)
2066  *
2067  * If no arguments are supplied this function will return
2068  * all of the current user preferences as an array.
2069  *
2070  * If a name is specified then this function
2071  * attempts to return that particular preference value.  If
2072  * none is found, then the optional value $default is returned,
2073  * otherwise null.
2074  *
2075  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
2076  *
2077  * @package  core
2078  * @category preference
2079  * @access   public
2080  * @param    string            $name    Name of the key to use in finding a preference value
2081  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
2082  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
2083  * @throws   coding_exception
2084  * @return   string|mixed|null          A string containing the value of a single preference. An
2085  *                                      array with all of the preferences or null
2086  */
2087 function get_user_preferences($name = null, $default = null, $user = null) {
2088     global $USER;
2090     if (is_null($name)) {
2091         // All prefs.
2092     } else if (is_numeric($name) or $name === '_lastloaded') {
2093         throw new coding_exception('Invalid preference name in get_user_preferences() call');
2094     }
2096     if (is_null($user)) {
2097         $user = $USER;
2098     } else if (isset($user->id)) {
2099         // Is a valid object.
2100     } else if (is_numeric($user)) {
2101         if ($USER->id == $user) {
2102             $user = $USER;
2103         } else {
2104             $user = (object)array('id' => (int)$user);
2105         }
2106     } else {
2107         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2108     }
2110     check_user_preferences_loaded($user);
2112     if (empty($name)) {
2113         // All values.
2114         return $user->preference;
2115     } else if (isset($user->preference[$name])) {
2116         // The single string value.
2117         return $user->preference[$name];
2118     } else {
2119         // Default value (null if not specified).
2120         return $default;
2121     }
2124 // FUNCTIONS FOR HANDLING TIME.
2126 /**
2127  * Given Gregorian date parts in user time produce a GMT timestamp.
2128  *
2129  * @package core
2130  * @category time
2131  * @param int $year The year part to create timestamp of
2132  * @param int $month The month part to create timestamp of
2133  * @param int $day The day part to create timestamp of
2134  * @param int $hour The hour part to create timestamp of
2135  * @param int $minute The minute part to create timestamp of
2136  * @param int $second The second part to create timestamp of
2137  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2138  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2139  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2140  *             applied only if timezone is 99 or string.
2141  * @return int GMT timestamp
2142  */
2143 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2144     $date = new DateTime('now', core_date::get_user_timezone_object($timezone));
2145     $date->setDate((int)$year, (int)$month, (int)$day);
2146     $date->setTime((int)$hour, (int)$minute, (int)$second);
2148     $time = $date->getTimestamp();
2150     if ($time === false) {
2151         throw new coding_exception('getTimestamp() returned false, please ensure you have passed correct values.'.
2152             ' This can fail if year is more than 2038 and OS is 32 bit windows');
2153     }
2155     // Moodle BC DST stuff.
2156     if (!$applydst) {
2157         $time += dst_offset_on($time, $timezone);
2158     }
2160     return $time;
2164 /**
2165  * Format a date/time (seconds) as weeks, days, hours etc as needed
2166  *
2167  * Given an amount of time in seconds, returns string
2168  * formatted nicely as years, days, hours etc as needed
2169  *
2170  * @package core
2171  * @category time
2172  * @uses MINSECS
2173  * @uses HOURSECS
2174  * @uses DAYSECS
2175  * @uses YEARSECS
2176  * @param int $totalsecs Time in seconds
2177  * @param stdClass $str Should be a time object
2178  * @return string A nicely formatted date/time string
2179  */
2180 function format_time($totalsecs, $str = null) {
2182     $totalsecs = abs($totalsecs);
2184     if (!$str) {
2185         // Create the str structure the slow way.
2186         $str = new stdClass();
2187         $str->day   = get_string('day');
2188         $str->days  = get_string('days');
2189         $str->hour  = get_string('hour');
2190         $str->hours = get_string('hours');
2191         $str->min   = get_string('min');
2192         $str->mins  = get_string('mins');
2193         $str->sec   = get_string('sec');
2194         $str->secs  = get_string('secs');
2195         $str->year  = get_string('year');
2196         $str->years = get_string('years');
2197     }
2199     $years     = floor($totalsecs/YEARSECS);
2200     $remainder = $totalsecs - ($years*YEARSECS);
2201     $days      = floor($remainder/DAYSECS);
2202     $remainder = $totalsecs - ($days*DAYSECS);
2203     $hours     = floor($remainder/HOURSECS);
2204     $remainder = $remainder - ($hours*HOURSECS);
2205     $mins      = floor($remainder/MINSECS);
2206     $secs      = $remainder - ($mins*MINSECS);
2208     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2209     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2210     $sh = ($hours == 1) ? $str->hour : $str->hours;
2211     $sd = ($days == 1)  ? $str->day  : $str->days;
2212     $sy = ($years == 1)  ? $str->year  : $str->years;
2214     $oyears = '';
2215     $odays = '';
2216     $ohours = '';
2217     $omins = '';
2218     $osecs = '';
2220     if ($years) {
2221         $oyears  = $years .' '. $sy;
2222     }
2223     if ($days) {
2224         $odays  = $days .' '. $sd;
2225     }
2226     if ($hours) {
2227         $ohours = $hours .' '. $sh;
2228     }
2229     if ($mins) {
2230         $omins  = $mins .' '. $sm;
2231     }
2232     if ($secs) {
2233         $osecs  = $secs .' '. $ss;
2234     }
2236     if ($years) {
2237         return trim($oyears .' '. $odays);
2238     }
2239     if ($days) {
2240         return trim($odays .' '. $ohours);
2241     }
2242     if ($hours) {
2243         return trim($ohours .' '. $omins);
2244     }
2245     if ($mins) {
2246         return trim($omins .' '. $osecs);
2247     }
2248     if ($secs) {
2249         return $osecs;
2250     }
2251     return get_string('now');
2254 /**
2255  * Returns a formatted string that represents a date in user time.
2256  *
2257  * @package core
2258  * @category time
2259  * @param int $date the timestamp in UTC, as obtained from the database.
2260  * @param string $format strftime format. You should probably get this using
2261  *        get_string('strftime...', 'langconfig');
2262  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2263  *        not 99 then daylight saving will not be added.
2264  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2265  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2266  *        If false then the leading zero is maintained.
2267  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2268  * @return string the formatted date/time.
2269  */
2270 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2271     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2272     return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
2275 /**
2276  * Returns a html "time" tag with both the exact user date with timezone information
2277  * as a datetime attribute in the W3C format, and the user readable date and time as text.
2278  *
2279  * @package core
2280  * @category time
2281  * @param int $date the timestamp in UTC, as obtained from the database.
2282  * @param string $format strftime format. You should probably get this using
2283  *        get_string('strftime...', 'langconfig');
2284  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2285  *        not 99 then daylight saving will not be added.
2286  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2287  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2288  *        If false then the leading zero is maintained.
2289  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2290  * @return string the formatted date/time.
2291  */
2292 function userdate_htmltime($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2293     $userdatestr = userdate($date, $format, $timezone, $fixday, $fixhour);
2294     if (CLI_SCRIPT && !PHPUNIT_TEST) {
2295         return $userdatestr;
2296     }
2297     $machinedate = new DateTime();
2298     $machinedate->setTimestamp(intval($date));
2299     $machinedate->setTimezone(core_date::get_user_timezone_object());
2301     return html_writer::tag('time', $userdatestr, ['datetime' => $machinedate->format(DateTime::W3C)]);
2304 /**
2305  * Returns a formatted date ensuring it is UTF-8.
2306  *
2307  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2308  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2309  *
2310  * @param int $date the timestamp - since Moodle 2.9 this is a real UTC timestamp
2311  * @param string $format strftime format.
2312  * @param int|float|string $tz the user timezone
2313  * @return string the formatted date/time.
2314  * @since Moodle 2.3.3
2315  */
2316 function date_format_string($date, $format, $tz = 99) {
2317     global $CFG;
2319     $localewincharset = null;
2320     // Get the calendar type user is using.
2321     if ($CFG->ostype == 'WINDOWS') {
2322         $calendartype = \core_calendar\type_factory::get_calendar_instance();
2323         $localewincharset = $calendartype->locale_win_charset();
2324     }
2326     if ($localewincharset) {
2327         $format = core_text::convert($format, 'utf-8', $localewincharset);
2328     }
2330     date_default_timezone_set(core_date::get_user_timezone($tz));
2331     $datestring = strftime($format, $date);
2332     core_date::set_default_server_timezone();
2334     if ($localewincharset) {
2335         $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2336     }
2338     return $datestring;
2341 /**
2342  * Given a $time timestamp in GMT (seconds since epoch),
2343  * returns an array that represents the Gregorian date in user time
2344  *
2345  * @package core
2346  * @category time
2347  * @param int $time Timestamp in GMT
2348  * @param float|int|string $timezone user timezone
2349  * @return array An array that represents the date in user time
2350  */
2351 function usergetdate($time, $timezone=99) {
2352     date_default_timezone_set(core_date::get_user_timezone($timezone));
2353     $result = getdate($time);
2354     core_date::set_default_server_timezone();
2356     return $result;
2359 /**
2360  * Given a GMT timestamp (seconds since epoch), offsets it by
2361  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2362  *
2363  * NOTE: this function does not include DST properly,
2364  *       you should use the PHP date stuff instead!
2365  *
2366  * @package core
2367  * @category time
2368  * @param int $date Timestamp in GMT
2369  * @param float|int|string $timezone user timezone
2370  * @return int
2371  */
2372 function usertime($date, $timezone=99) {
2373     $userdate = new DateTime('@' . $date);
2374     $userdate->setTimezone(core_date::get_user_timezone_object($timezone));
2375     $dst = dst_offset_on($date, $timezone);
2377     return $date - $userdate->getOffset() + $dst;
2380 /**
2381  * Get a formatted string representation of an interval between two unix timestamps.
2382  *
2383  * E.g.
2384  * $intervalstring = get_time_interval_string(12345600, 12345660);
2385  * Will produce the string:
2386  * '0d 0h 1m'
2387  *
2388  * @param int $time1 unix timestamp
2389  * @param int $time2 unix timestamp
2390  * @param string $format string (can be lang string) containing format chars: https://www.php.net/manual/en/dateinterval.format.php.
2391  * @return string the formatted string describing the time difference, e.g. '10d 11h 45m'.
2392  */
2393 function get_time_interval_string(int $time1, int $time2, string $format = ''): string {
2394     $dtdate = new DateTime();
2395     $dtdate->setTimeStamp($time1);
2396     $dtdate2 = new DateTime();
2397     $dtdate2->setTimeStamp($time2);
2398     $interval = $dtdate2->diff($dtdate);
2399     $format = empty($format) ? get_string('relativedatestimediffformat', 'moodle') : $format;
2400     return $interval->format($format);
2403 /**
2404  * Given a time, return the GMT timestamp of the most recent midnight
2405  * for the current user.
2406  *
2407  * @package core
2408  * @category time
2409  * @param int $date Timestamp in GMT
2410  * @param float|int|string $timezone user timezone
2411  * @return int Returns a GMT timestamp
2412  */
2413 function usergetmidnight($date, $timezone=99) {
2415     $userdate = usergetdate($date, $timezone);
2417     // Time of midnight of this user's day, in GMT.
2418     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2422 /**
2423  * Returns a string that prints the user's timezone
2424  *
2425  * @package core
2426  * @category time
2427  * @param float|int|string $timezone user timezone
2428  * @return string
2429  */
2430 function usertimezone($timezone=99) {
2431     $tz = core_date::get_user_timezone($timezone);
2432     return core_date::get_localised_timezone($tz);
2435 /**
2436  * Returns a float or a string which denotes the user's timezone
2437  * 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)
2438  * means that for this timezone there are also DST rules to be taken into account
2439  * Checks various settings and picks the most dominant of those which have a value
2440  *
2441  * @package core
2442  * @category time
2443  * @param float|int|string $tz timezone to calculate GMT time offset before
2444  *        calculating user timezone, 99 is default user timezone
2445  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2446  * @return float|string
2447  */
2448 function get_user_timezone($tz = 99) {
2449     global $USER, $CFG;
2451     $timezones = array(
2452         $tz,
2453         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2454         isset($USER->timezone) ? $USER->timezone : 99,
2455         isset($CFG->timezone) ? $CFG->timezone : 99,
2456         );
2458     $tz = 99;
2460     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2461     foreach ($timezones as $nextvalue) {
2462         if ((empty($tz) && !is_numeric($tz)) || $tz == 99) {
2463             $tz = $nextvalue;
2464         }
2465     }
2466     return is_numeric($tz) ? (float) $tz : $tz;
2469 /**
2470  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2471  * - Note: Daylight saving only works for string timezones and not for float.
2472  *
2473  * @package core
2474  * @category time
2475  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2476  * @param int|float|string $strtimezone user timezone
2477  * @return int
2478  */
2479 function dst_offset_on($time, $strtimezone = null) {
2480     $tz = core_date::get_user_timezone($strtimezone);
2481     $date = new DateTime('@' . $time);
2482     $date->setTimezone(new DateTimeZone($tz));
2483     if ($date->format('I') == '1') {
2484         if ($tz === 'Australia/Lord_Howe') {
2485             return 1800;
2486         }
2487         return 3600;
2488     }
2489     return 0;
2492 /**
2493  * Calculates when the day appears in specific month
2494  *
2495  * @package core
2496  * @category time
2497  * @param int $startday starting day of the month
2498  * @param int $weekday The day when week starts (normally taken from user preferences)
2499  * @param int $month The month whose day is sought
2500  * @param int $year The year of the month whose day is sought
2501  * @return int
2502  */
2503 function find_day_in_month($startday, $weekday, $month, $year) {
2504     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2506     $daysinmonth = days_in_month($month, $year);
2507     $daysinweek = count($calendartype->get_weekdays());
2509     if ($weekday == -1) {
2510         // Don't care about weekday, so return:
2511         //    abs($startday) if $startday != -1
2512         //    $daysinmonth otherwise.
2513         return ($startday == -1) ? $daysinmonth : abs($startday);
2514     }
2516     // From now on we 're looking for a specific weekday.
2517     // Give "end of month" its actual value, since we know it.
2518     if ($startday == -1) {
2519         $startday = -1 * $daysinmonth;
2520     }
2522     // Starting from day $startday, the sign is the direction.
2523     if ($startday < 1) {
2524         $startday = abs($startday);
2525         $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
2527         // This is the last such weekday of the month.
2528         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2529         if ($lastinmonth > $daysinmonth) {
2530             $lastinmonth -= $daysinweek;
2531         }
2533         // Find the first such weekday <= $startday.
2534         while ($lastinmonth > $startday) {
2535             $lastinmonth -= $daysinweek;
2536         }
2538         return $lastinmonth;
2539     } else {
2540         $indexweekday = dayofweek($startday, $month, $year);
2542         $diff = $weekday - $indexweekday;
2543         if ($diff < 0) {
2544             $diff += $daysinweek;
2545         }
2547         // This is the first such weekday of the month equal to or after $startday.
2548         $firstfromindex = $startday + $diff;
2550         return $firstfromindex;
2551     }
2554 /**
2555  * Calculate the number of days in a given month
2556  *
2557  * @package core
2558  * @category time
2559  * @param int $month The month whose day count is sought
2560  * @param int $year The year of the month whose day count is sought
2561  * @return int
2562  */
2563 function days_in_month($month, $year) {
2564     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2565     return $calendartype->get_num_days_in_month($year, $month);
2568 /**
2569  * Calculate the position in the week of a specific calendar day
2570  *
2571  * @package core
2572  * @category time
2573  * @param int $day The day of the date whose position in the week is sought
2574  * @param int $month The month of the date whose position in the week is sought
2575  * @param int $year The year of the date whose position in the week is sought
2576  * @return int
2577  */
2578 function dayofweek($day, $month, $year) {
2579     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2580     return $calendartype->get_weekday($year, $month, $day);
2583 // USER AUTHENTICATION AND LOGIN.
2585 /**
2586  * Returns full login url.
2587  *
2588  * Any form submissions for authentication to this URL must include username,
2589  * password as well as a logintoken generated by \core\session\manager::get_login_token().
2590  *
2591  * @return string login url
2592  */
2593 function get_login_url() {
2594     global $CFG;
2596     return "$CFG->wwwroot/login/index.php";
2599 /**
2600  * This function checks that the current user is logged in and has the
2601  * required privileges
2602  *
2603  * This function checks that the current user is logged in, and optionally
2604  * whether they are allowed to be in a particular course and view a particular
2605  * course module.
2606  * If they are not logged in, then it redirects them to the site login unless
2607  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2608  * case they are automatically logged in as guests.
2609  * If $courseid is given and the user is not enrolled in that course then the
2610  * user is redirected to the course enrolment page.
2611  * If $cm is given and the course module is hidden and the user is not a teacher
2612  * in the course then the user is redirected to the course home page.
2613  *
2614  * When $cm parameter specified, this function sets page layout to 'module'.
2615  * You need to change it manually later if some other layout needed.
2616  *
2617  * @package    core_access
2618  * @category   access
2619  *
2620  * @param mixed $courseorid id of the course or course object
2621  * @param bool $autologinguest default true
2622  * @param object $cm course module object
2623  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2624  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2625  *             in order to keep redirects working properly. MDL-14495
2626  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2627  * @return mixed Void, exit, and die depending on path
2628  * @throws coding_exception
2629  * @throws require_login_exception
2630  * @throws moodle_exception
2631  */
2632 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2633     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2635     // Must not redirect when byteserving already started.
2636     if (!empty($_SERVER['HTTP_RANGE'])) {
2637         $preventredirect = true;
2638     }
2640     if (AJAX_SCRIPT) {
2641         // We cannot redirect for AJAX scripts either.
2642         $preventredirect = true;
2643     }
2645     // Setup global $COURSE, themes, language and locale.
2646     if (!empty($courseorid)) {
2647         if (is_object($courseorid)) {
2648             $course = $courseorid;
2649         } else if ($courseorid == SITEID) {
2650             $course = clone($SITE);
2651         } else {
2652             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2653         }
2654         if ($cm) {
2655             if ($cm->course != $course->id) {
2656                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2657             }
2658             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2659             if (!($cm instanceof cm_info)) {
2660                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2661                 // db queries so this is not really a performance concern, however it is obviously
2662                 // better if you use get_fast_modinfo to get the cm before calling this.
2663                 $modinfo = get_fast_modinfo($course);
2664                 $cm = $modinfo->get_cm($cm->id);
2665             }
2666         }
2667     } else {
2668         // Do not touch global $COURSE via $PAGE->set_course(),
2669         // the reasons is we need to be able to call require_login() at any time!!
2670         $course = $SITE;
2671         if ($cm) {
2672             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2673         }
2674     }
2676     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2677     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2678     // risk leading the user back to the AJAX request URL.
2679     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2680         $setwantsurltome = false;
2681     }
2683     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2684     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !empty($CFG->dbsessions)) {
2685         if ($preventredirect) {
2686             throw new require_login_session_timeout_exception();
2687         } else {
2688             if ($setwantsurltome) {
2689                 $SESSION->wantsurl = qualified_me();
2690             }
2691             redirect(get_login_url());
2692         }
2693     }
2695     // If the user is not even logged in yet then make sure they are.
2696     if (!isloggedin()) {
2697         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2698             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2699                 // Misconfigured site guest, just redirect to login page.
2700                 redirect(get_login_url());
2701                 exit; // Never reached.
2702             }
2703             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2704             complete_user_login($guest);
2705             $USER->autologinguest = true;
2706             $SESSION->lang = $lang;
2707         } else {
2708             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2709             if ($preventredirect) {
2710                 throw new require_login_exception('You are not logged in');
2711             }
2713             if ($setwantsurltome) {
2714                 $SESSION->wantsurl = qualified_me();
2715             }
2717             $referer = get_local_referer(false);
2718             if (!empty($referer)) {
2719                 $SESSION->fromurl = $referer;
2720             }
2722             // Give auth plugins an opportunity to authenticate or redirect to an external login page
2723             $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
2724             foreach($authsequence as $authname) {
2725                 $authplugin = get_auth_plugin($authname);
2726                 $authplugin->pre_loginpage_hook();
2727                 if (isloggedin()) {
2728                     if ($cm) {
2729                         $modinfo = get_fast_modinfo($course);
2730                         $cm = $modinfo->get_cm($cm->id);
2731                     }
2732                     set_access_log_user();
2733                     break;
2734                 }
2735             }
2737             // If we're still not logged in then go to the login page
2738             if (!isloggedin()) {
2739                 redirect(get_login_url());
2740                 exit; // Never reached.
2741             }
2742         }
2743     }
2745     // Loginas as redirection if needed.
2746     if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
2747         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2748             if ($USER->loginascontext->instanceid != $course->id) {
2749                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2750             }
2751         }
2752     }
2754     // Check whether the user should be changing password (but only if it is REALLY them).
2755     if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
2756         $userauth = get_auth_plugin($USER->auth);
2757         if ($userauth->can_change_password() and !$preventredirect) {
2758             if ($setwantsurltome) {
2759                 $SESSION->wantsurl = qualified_me();
2760             }
2761             if ($changeurl = $userauth->change_password_url()) {
2762                 // Use plugin custom url.
2763                 redirect($changeurl);
2764             } else {
2765                 // Use moodle internal method.
2766                 redirect($CFG->wwwroot .'/login/change_password.php');
2767             }
2768         } else if ($userauth->can_change_password()) {
2769             throw new moodle_exception('forcepasswordchangenotice');
2770         } else {
2771             throw new moodle_exception('nopasswordchangeforced', 'auth');
2772         }
2773     }
2775     // Check that the user account is properly set up. If we can't redirect to
2776     // edit their profile and this is not a WS request, perform just the lax check.
2777     // It will allow them to use filepicker on the profile edit page.
2779     if ($preventredirect && !WS_SERVER) {
2780         $usernotfullysetup = user_not_fully_set_up($USER, false);
2781     } else {
2782         $usernotfullysetup = user_not_fully_set_up($USER, true);
2783     }
2785     if ($usernotfullysetup) {
2786         if ($preventredirect) {
2787             throw new moodle_exception('usernotfullysetup');
2788         }
2789         if ($setwantsurltome) {
2790             $SESSION->wantsurl = qualified_me();
2791         }
2792         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2793     }
2795     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2796     sesskey();
2798     if (\core\session\manager::is_loggedinas()) {
2799         // During a "logged in as" session we should force all content to be cleaned because the
2800         // logged in user will be viewing potentially malicious user generated content.
2801         // See MDL-63786 for more details.
2802         $CFG->forceclean = true;
2803     }
2805     $afterlogins = get_plugins_with_function('after_require_login', 'lib.php');
2807     // Do not bother admins with any formalities, except for activities pending deletion.
2808     if (is_siteadmin() && !($cm && $cm->deletioninprogress)) {
2809         // Set the global $COURSE.
2810         if ($cm) {
2811             $PAGE->set_cm($cm, $course);
2812             $PAGE->set_pagelayout('incourse');
2813         } else if (!empty($courseorid)) {
2814             $PAGE->set_course($course);
2815         }
2816         // Set accesstime or the user will appear offline which messes up messaging.
2817         // Do not update access time for webservice or ajax requests.
2818         if (!WS_SERVER && !AJAX_SCRIPT) {
2819             user_accesstime_log($course->id);
2820         }
2822         foreach ($afterlogins as $plugintype => $plugins) {
2823             foreach ($plugins as $pluginfunction) {
2824                 $pluginfunction($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2825             }
2826         }
2827         return;
2828     }
2830     // Scripts have a chance to declare that $USER->policyagreed should not be checked.
2831     // This is mostly for places where users are actually accepting the policies, to avoid the redirect loop.
2832     if (!defined('NO_SITEPOLICY_CHECK')) {
2833         define('NO_SITEPOLICY_CHECK', false);
2834     }
2836     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2837     // Do not test if the script explicitly asked for skipping the site policies check.
2838     if (!$USER->policyagreed && !is_siteadmin() && !NO_SITEPOLICY_CHECK) {
2839         $manager = new \core_privacy\local\sitepolicy\manager();
2840         if ($policyurl = $manager->get_redirect_url(isguestuser())) {
2841             if ($preventredirect) {
2842                 throw new moodle_exception('sitepolicynotagreed', 'error', '', $policyurl->out());
2843             }
2844             if ($setwantsurltome) {
2845                 $SESSION->wantsurl = qualified_me();
2846             }
2847             redirect($policyurl);
2848         }
2849     }
2851     // Fetch the system context, the course context, and prefetch its child contexts.
2852     $sysctx = context_system::instance();
2853     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2854     if ($cm) {
2855         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2856     } else {
2857         $cmcontext = null;
2858     }
2860     // If the site is currently under maintenance, then print a message.
2861     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:maintenanceaccess', $sysctx)) {
2862         if ($preventredirect) {
2863             throw new require_login_exception('Maintenance in progress');
2864         }
2865         $PAGE->set_context(null);
2866         print_maintenance_message();
2867     }
2869     // Make sure the course itself is not hidden.
2870     if ($course->id == SITEID) {
2871         // Frontpage can not be hidden.
2872     } else {
2873         if (is_role_switched($course->id)) {
2874             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
2875         } else {
2876             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2877                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
2878                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
2879                 if ($preventredirect) {
2880                     throw new require_login_exception('Course is hidden');
2881                 }
2882                 $PAGE->set_context(null);
2883                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2884                 // the navigation will mess up when trying to find it.
2885                 navigation_node::override_active_url(new moodle_url('/'));
2886                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2887             }
2888         }
2889     }
2891     // Is the user enrolled?
2892     if ($course->id == SITEID) {
2893         // Everybody is enrolled on the frontpage.
2894     } else {
2895         if (\core\session\manager::is_loggedinas()) {
2896             // Make sure the REAL person can access this course first.
2897             $realuser = \core\session\manager::get_realuser();
2898             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
2899                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2900                 if ($preventredirect) {
2901                     throw new require_login_exception('Invalid course login-as access');
2902                 }
2903                 $PAGE->set_context(null);
2904                 echo $OUTPUT->header();
2905                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2906             }
2907         }
2909         $access = false;
2911         if (is_role_switched($course->id)) {
2912             // Ok, user had to be inside this course before the switch.
2913             $access = true;
2915         } else if (is_viewing($coursecontext, $USER)) {
2916             // Ok, no need to mess with enrol.
2917             $access = true;
2919         } else {
2920             if (isset($USER->enrol['enrolled'][$course->id])) {
2921                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2922                     $access = true;
2923                     if (isset($USER->enrol['tempguest'][$course->id])) {
2924                         unset($USER->enrol['tempguest'][$course->id]);
2925                         remove_temp_course_roles($coursecontext);
2926                     }
2927                 } else {
2928                     // Expired.
2929                     unset($USER->enrol['enrolled'][$course->id]);
2930                 }
2931             }
2932             if (isset($USER->enrol['tempguest'][$course->id])) {
2933                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2934                     $access = true;
2935                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2936                     $access = true;
2937                 } else {
2938                     // Expired.
2939                     unset($USER->enrol['tempguest'][$course->id]);
2940                     remove_temp_course_roles($coursecontext);
2941                 }
2942             }
2944             if (!$access) {
2945                 // Cache not ok.
2946                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2947                 if ($until !== false) {
2948                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
2949                     if ($until == 0) {
2950                         $until = ENROL_MAX_TIMESTAMP;
2951                     }
2952                     $USER->enrol['enrolled'][$course->id] = $until;
2953                     $access = true;
2955                 } else if (core_course_category::can_view_course_info($course)) {
2956                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
2957                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
2958                     $enrols = enrol_get_plugins(true);
2959                     // First ask all enabled enrol instances in course if they want to auto enrol user.
2960                     foreach ($instances as $instance) {
2961                         if (!isset($enrols[$instance->enrol])) {
2962                             continue;
2963                         }
2964                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2965                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2966                         if ($until !== false) {
2967                             if ($until == 0) {
2968                                 $until = ENROL_MAX_TIMESTAMP;
2969                             }
2970                             $USER->enrol['enrolled'][$course->id] = $until;
2971                             $access = true;
2972                             break;
2973                         }
2974                     }
2975                     // If not enrolled yet try to gain temporary guest access.
2976                     if (!$access) {
2977                         foreach ($instances as $instance) {
2978                             if (!isset($enrols[$instance->enrol])) {
2979                                 continue;
2980                             }
2981                             // Get a duration for the guest access, a timestamp in the future or false.
2982                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2983                             if ($until !== false and $until > time()) {
2984                                 $USER->enrol['tempguest'][$course->id] = $until;
2985                                 $access = true;
2986                                 break;
2987                             }
2988                         }
2989                     }
2990                 } else {
2991                     // User is not enrolled and is not allowed to browse courses here.
2992                     if ($preventredirect) {
2993                         throw new require_login_exception('Course is not available');
2994                     }
2995                     $PAGE->set_context(null);
2996                     // We need to override the navigation URL as the course won't have been added to the navigation and thus
2997                     // the navigation will mess up when trying to find it.
2998                     navigation_node::override_active_url(new moodle_url('/'));
2999                     notice(get_string('coursehidden'), $CFG->wwwroot .'/');
3000                 }
3001             }
3002         }
3004         if (!$access) {
3005             if ($preventredirect) {
3006                 throw new require_login_exception('Not enrolled');
3007             }
3008             if ($setwantsurltome) {
3009                 $SESSION->wantsurl = qualified_me();
3010             }
3011             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3012         }
3013     }
3015     // Check whether the activity has been scheduled for deletion. If so, then deny access, even for admins.
3016     if ($cm && $cm->deletioninprogress) {
3017         if ($preventredirect) {
3018             throw new moodle_exception('activityisscheduledfordeletion');
3019         }
3020         require_once($CFG->dirroot . '/course/lib.php');
3021         redirect(course_get_url($course), get_string('activityisscheduledfordeletion', 'error'));
3022     }
3024     // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
3025     if ($cm && !$cm->uservisible) {
3026         if ($preventredirect) {
3027             throw new require_login_exception('Activity is hidden');
3028         }
3029         // Get the error message that activity is not available and why (if explanation can be shown to the user).
3030         $PAGE->set_course($course);
3031         $renderer = $PAGE->get_renderer('course');
3032         $message = $renderer->course_section_cm_unavailable_error_message($cm);
3033         redirect(course_get_url($course), $message, null, \core\output\notification::NOTIFY_ERROR);
3034     }
3036     // Set the global $COURSE.
3037     if ($cm) {
3038         $PAGE->set_cm($cm, $course);
3039         $PAGE->set_pagelayout('incourse');
3040     } else if (!empty($courseorid)) {
3041         $PAGE->set_course($course);
3042     }
3044     foreach ($afterlogins as $plugintype => $plugins) {
3045         foreach ($plugins as $pluginfunction) {
3046             $pluginfunction($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3047         }
3048     }
3050     // Finally access granted, update lastaccess times.
3051     // Do not update access time for webservice or ajax requests.
3052     if (!WS_SERVER && !AJAX_SCRIPT) {
3053         user_accesstime_log($course->id);
3054     }
3057 /**
3058  * A convenience function for where we must be logged in as admin
3059  * @return void
3060  */
3061 function require_admin() {
3062     require_login(null, false);
3063     require_capability('moodle/site:config', context_system::instance());
3066 /**
3067  * This function just makes sure a user is logged out.
3068  *
3069  * @package    core_access
3070  * @category   access
3071  */
3072 function require_logout() {
3073     global $USER, $DB;
3075     if (!isloggedin()) {
3076         // This should not happen often, no need for hooks or events here.
3077         \core\session\manager::terminate_current();
3078         return;
3079     }
3081     // Execute hooks before action.
3082     $authplugins = array();
3083     $authsequence = get_enabled_auth_plugins();
3084     foreach ($authsequence as $authname) {
3085         $authplugins[$authname] = get_auth_plugin($authname);
3086         $authplugins[$authname]->prelogout_hook();
3087     }
3089     // Store info that gets removed during logout.
3090     $sid = session_id();
3091     $event = \core\event\user_loggedout::create(
3092         array(
3093             'userid' => $USER->id,
3094             'objectid' => $USER->id,
3095             'other' => array('sessionid' => $sid),
3096         )
3097     );
3098     if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
3099         $event->add_record_snapshot('sessions', $session);
3100     }
3102     // Clone of $USER object to be used by auth plugins.
3103     $user = fullclone($USER);
3105     // Delete session record and drop $_SESSION content.
3106     \core\session\manager::terminate_current();
3108     // Trigger event AFTER action.
3109     $event->trigger();
3111     // Hook to execute auth plugins redirection after event trigger.
3112     foreach ($authplugins as $authplugin) {
3113         $authplugin->postlogout_hook($user);
3114     }
3117 /**
3118  * Weaker version of require_login()
3119  *
3120  * This is a weaker version of {@link require_login()} which only requires login
3121  * when called from within a course rather than the site page, unless
3122  * the forcelogin option is turned on.
3123  * @see require_login()
3124  *
3125  * @package    core_access
3126  * @category   access
3127  *
3128  * @param mixed $courseorid The course object or id in question
3129  * @param bool $autologinguest Allow autologin guests if that is wanted
3130  * @param object $cm Course activity module if known
3131  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3132  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3133  *             in order to keep redirects working properly. MDL-14495
3134  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3135  * @return void
3136  * @throws coding_exception
3137  */
3138 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3139     global $CFG, $PAGE, $SITE;
3140     $issite = ((is_object($courseorid) and $courseorid->id == SITEID)
3141           or (!is_object($courseorid) and $courseorid == SITEID));
3142     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3143         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3144         // db queries so this is not really a performance concern, however it is obviously
3145         // better if you use get_fast_modinfo to get the cm before calling this.
3146         if (is_object($courseorid)) {
3147             $course = $courseorid;
3148         } else {
3149             $course = clone($SITE);
3150         }
3151         $modinfo = get_fast_modinfo($course);
3152         $cm = $modinfo->get_cm($cm->id);
3153     }
3154     if (!empty($CFG->forcelogin)) {
3155         // Login required for both SITE and courses.
3156         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3158     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3159         // Always login for hidden activities.
3160         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3162     } else if (isloggedin() && !isguestuser()) {
3163         // User is already logged in. Make sure the login is complete (user is fully setup, policies agreed).
3164         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3166     } else if ($issite) {
3167         // Login for SITE not required.
3168         // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3169         if (!empty($courseorid)) {
3170             if (is_object($courseorid)) {
3171                 $course = $courseorid;
3172             } else {
3173                 $course = clone $SITE;
3174             }
3175             if ($cm) {
3176                 if ($cm->course != $course->id) {
3177                     throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3178                 }
3179                 $PAGE->set_cm($cm, $course);
3180                 $PAGE->set_pagelayout('incourse');
3181             } else {
3182                 $PAGE->set_course($course);
3183             }
3184         } else {
3185             // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3186             $PAGE->set_course($PAGE->course);
3187         }
3188         // Do not update access time for webservice or ajax requests.
3189         if (!WS_SERVER && !AJAX_SCRIPT) {
3190             user_accesstime_log(SITEID);
3191         }
3192         return;
3194     } else {
3195         // Course login always required.
3196         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3197     }
3200 /**
3201  * Validates a user key, checking if the key exists, is not expired and the remote ip is correct.
3202  *
3203  * @param  string $keyvalue the key value
3204  * @param  string $script   unique script identifier
3205  * @param  int $instance    instance id
3206  * @return stdClass the key entry in the user_private_key table
3207  * @since Moodle 3.2
3208  * @throws moodle_exception
3209  */
3210 function validate_user_key($keyvalue, $script, $instance) {
3211     global $DB;
3213     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3214         print_error('invalidkey');
3215     }
3217     if (!empty($key->validuntil) and $key->validuntil < time()) {
3218         print_error('expiredkey');
3219     }
3221     if ($key->iprestriction) {
3222         $remoteaddr = getremoteaddr(null);
3223         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3224             print_error('ipmismatch');
3225         }
3226     }
3227     return $key;
3230 /**
3231  * Require key login. Function terminates with error if key not found or incorrect.
3232  *
3233  * @uses NO_MOODLE_COOKIES
3234  * @uses PARAM_ALPHANUM
3235  * @param string $script unique script identifier
3236  * @param int $instance optional instance id
3237  * @param string $keyvalue The key. If not supplied, this will be fetched from the current session.
3238  * @return int Instance ID
3239  */
3240 function require_user_key_login($script, $instance = null, $keyvalue = null) {
3241     global $DB;
3243     if (!NO_MOODLE_COOKIES) {
3244         print_error('sessioncookiesdisable');
3245     }
3247     // Extra safety.
3248     \core\session\manager::write_close();
3250     if (null === $keyvalue) {
3251         $keyvalue = required_param('key', PARAM_ALPHANUM);
3252     }
3254     $key = validate_user_key($keyvalue, $script, $instance);
3256     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3257         print_error('invaliduserid');
3258     }
3260     // Emulate normal session.
3261     enrol_check_plugins($user);
3262     \core\session\manager::set_user($user);
3264     // Note we are not using normal login.
3265     if (!defined('USER_KEY_LOGIN')) {
3266         define('USER_KEY_LOGIN', true);
3267     }
3269     // Return instance id - it might be empty.
3270     return $key->instance;
3273 /**
3274  * Creates a new private user access key.
3275  *
3276  * @param string $script unique target identifier
3277  * @param int $userid
3278  * @param int $instance optional instance id
3279  * @param string $iprestriction optional ip restricted access
3280  * @param int $validuntil key valid only until given data
3281  * @return string access key value
3282  */
3283 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3284     global $DB;
3286     $key = new stdClass();
3287     $key->script        = $script;
3288     $key->userid        = $userid;
3289     $key->instance      = $instance;
3290     $key->iprestriction = $iprestriction;
3291     $key->validuntil    = $validuntil;
3292     $key->timecreated   = time();
3294     // Something long and unique.
3295     $key->value         = md5($userid.'_'.time().random_string(40));
3296     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3297         // Must be unique.
3298         $key->value     = md5($userid.'_'.time().random_string(40));
3299     }
3300     $DB->insert_record('user_private_key', $key);
3301     return $key->value;
3304 /**
3305  * Delete the user's new private user access keys for a particular script.
3306  *
3307  * @param string $script unique target identifier
3308  * @param int $userid
3309  * @return void
3310  */
3311 function delete_user_key($script, $userid) {
3312     global $DB;
3313     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3316 /**
3317  * Gets a private user access key (and creates one if one doesn't exist).
3318  *
3319  * @param string $script unique target identifier
3320  * @param int $userid
3321  * @param int $instance optional instance id
3322  * @param string $iprestriction optional ip restricted access
3323  * @param int $validuntil key valid only until given date
3324  * @return string access key value
3325  */
3326 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3327     global $DB;
3329     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3330                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3331                                                          'validuntil' => $validuntil))) {
3332         return $key->value;
3333     } else {
3334         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3335     }
3339 /**
3340  * Modify the user table by setting the currently logged in user's last login to now.
3341  *
3342  * @return bool Always returns true
3343  */
3344 function update_user_login_times() {
3345     global $USER, $DB;
3347     if (isguestuser()) {
3348         // Do not update guest access times/ips for performance.
3349         return true;
3350     }
3352     $now = time();
3354     $user = new stdClass();
3355     $user->id = $USER->id;
3357     // Make sure all users that logged in have some firstaccess.
3358     if ($USER->firstaccess == 0) {
3359         $USER->firstaccess = $user->firstaccess = $now;
3360     }
3362     // Store the previous current as lastlogin.
3363     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3365     $USER->currentlogin = $user->currentlogin = $now;
3367     // Function user_accesstime_log() may not update immediately, better do it here.
3368     $USER->lastaccess = $user->lastaccess = $now;
3369     $USER->lastip = $user->lastip = getremoteaddr();
3371     // Note: do not call user_update_user() here because this is part of the login process,
3372     //       the login event means that these fields were updated.
3373     $DB->update_record('user', $user);
3374     return true;
3377 /**
3378  * Determines if a user has completed setting up their account.
3379  *
3380  * The lax mode (with $strict = false) has been introduced for special cases
3381  * only where we want to skip certain checks intentionally. This is valid in
3382  * certain mnet or ajax scenarios when the user cannot / should not be
3383  * redirected to edit their profile. In most cases, you should perform the
3384  * strict check.
3385  *
3386  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3387  * @param bool $strict Be more strict and assert id and custom profile fields set, too
3388  * @return bool
3389  */
3390 function user_not_fully_set_up($user, $strict = true) {
3391     global $CFG;
3392     require_once($CFG->dirroot.'/user/profile/lib.php');
3394     if (isguestuser($user)) {
3395         return false;
3396     }
3398     if (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)) {
3399         return true;
3400     }
3402     if ($strict) {
3403         if (empty($user->id)) {
3404             // Strict mode can be used with existing accounts only.
3405             return true;
3406         }
3407         if (!profile_has_required_custom_fields_set($user->id)) {
3408             return true;
3409         }
3410     }
3412     return false;
3415 /**
3416  * Check whether the user has exceeded the bounce threshold
3417  *
3418  * @param stdClass $user A {@link $USER} object
3419  * @return bool true => User has exceeded bounce threshold
3420  */
3421 function over_bounce_threshold($user) {
3422     global $CFG, $DB;
3424     if (empty($CFG->handlebounces)) {
3425         return false;
3426     }
3428     if (empty($user->id)) {
3429         // No real (DB) user, nothing to do here.
3430         return false;
3431     }
3433     // Set sensible defaults.
3434     if (empty($CFG->minbounces)) {
3435         $CFG->minbounces = 10;
3436     }
3437     if (empty($CFG->bounceratio)) {
3438         $CFG->bounceratio = .20;
3439     }
3440     $bouncecount = 0;
3441     $sendcount = 0;
3442     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3443         $bouncecount = $bounce->value;
3444     }
3445     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3446         $sendcount = $send->value;
3447     }
3448     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3451 /**
3452  * Used to increment or reset email sent count
3453  *
3454  * @param stdClass $user object containing an id
3455  * @param bool $reset will reset the count to 0
3456  * @return void
3457  */
3458 function set_send_count($user, $reset=false) {
3459     global $DB;
3461     if (empty($user->id)) {
3462         // No real (DB) user, nothing to do here.
3463         return;
3464     }
3466     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3467         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3468         $DB->update_record('user_preferences', $pref);
3469     } else if (!empty($reset)) {
3470         // If it's not there and we're resetting, don't bother. Make a new one.
3471         $pref = new stdClass();
3472         $pref->name   = 'email_send_count';
3473         $pref->value  = 1;
3474         $pref->userid = $user->id;
3475         $DB->insert_record('user_preferences', $pref, false);
3476     }
3479 /**
3480  * Increment or reset user's email bounce count
3481  *
3482  * @param stdClass $user object containing an id
3483  * @param bool $reset will reset the count to 0
3484  */
3485 function set_bounce_count($user, $reset=false) {
3486     global $DB;
3488     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3489         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3490         $DB->update_record('user_preferences', $pref);
3491     } else if (!empty($reset)) {
3492         // If it's not there and we're resetting, don't bother. Make a new one.
3493         $pref = new stdClass();
3494         $pref->name   = 'email_bounce_count';
3495         $pref->value  = 1;
3496         $pref->userid = $user->id;
3497         $DB->insert_record('user_preferences', $pref, false);
3498     }
3501 /**
3502  * Determines if the logged in user is currently moving an activity
3503  *
3504  * @param int $courseid The id of the course being tested
3505  * @return bool
3506  */
3507 function ismoving($courseid) {
3508     global $USER;
3510     if (!empty($USER->activitycopy)) {
3511         return ($USER->activitycopycourse == $courseid);
3512     }
3513     return false;
3516 /**
3517  * Returns a persons full name
3518  *
3519  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3520  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3521  * specify one.
3522  *
3523  * @param stdClass $user A {@link $USER} object to get full name of.
3524  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3525  * @return string
3526  */
3527 function fullname($user, $override=false) {
3528     global $CFG, $SESSION;
3530     if (!isset($user->firstname) and !isset($user->lastname)) {
3531         return '';
3532     }
3534     // Get all of the name fields.
3535     $allnames = get_all_user_name_fields();
3536     if ($CFG->debugdeveloper) {
3537         foreach ($allnames as $allname) {
3538             if (!property_exists($user, $allname)) {
3539                 // If all the user name fields are not set in the user object, then notify the programmer that it needs to be fixed.
3540                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3541                 // Message has been sent, no point in sending the message multiple times.
3542                 break;
3543             }
3544         }
3545     }
3547     if (!$override) {
3548         if (!empty($CFG->forcefirstname)) {
3549             $user->firstname = $CFG->forcefirstname;
3550         }
3551         if (!empty($CFG->forcelastname)) {
3552             $user->lastname = $CFG->forcelastname;
3553         }
3554     }
3556     if (!empty($SESSION->fullnamedisplay)) {
3557         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3558     }
3560     $template = null;
3561     // If the fullnamedisplay setting is available, set the template to that.
3562     if (isset($CFG->fullnamedisplay)) {
3563         $template = $CFG->fullnamedisplay;
3564     }
3565     // If the template is empty, or set to language, return the language string.
3566     if ((empty($template) || $template == 'language') && !$override) {
3567         return get_string('fullnamedisplay', null, $user);
3568     }
3570     // Check to see if we are displaying according to the alternative full name format.
3571     if ($override) {
3572         if (empty($CFG->alternativefullnameformat) || $CFG->alternativefullnameformat == 'language') {
3573             // Default to show just the user names according to the fullnamedisplay string.
3574             return get_string('fullnamedisplay', null, $user);
3575         } else {
3576             // If the override is true, then change the template to use the complete name.
3577             $template = $CFG->alternativefullnameformat;
3578         }
3579     }
3581     $requirednames = array();
3582     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3583     foreach ($allnames as $allname) {
3584         if (strpos($template, $allname) !== false) {
3585             $requirednames[] = $allname;
3586         }
3587     }
3589     $displayname = $template;
3590     // Switch in the actual data into the template.
3591     foreach ($requirednames as $altname) {
3592         if (isset($user->$altname)) {
3593             // Using empty() on the below if statement causes breakages.
3594             if ((string)$user->$altname == '') {
3595                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3596             } else {
3597                 $displayname = str_replace($altname, $user->$altname, $displayname);
3598             }
3599         } else {
3600             $displayname = str_replace($altname, 'EMPTY', $displayname);
3601         }
3602     }
3603     // Tidy up any misc. characters (Not perfect, but gets most characters).
3604     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3605     // katakana and parenthesis.
3606     $patterns = array();
3607     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3608     // filled in by a user.
3609     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3610     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3611     // This regular expression is to remove any double spaces in the display name.
3612     $patterns[] = '/\s{2,}/u';
3613     foreach ($patterns as $pattern) {
3614         $displayname = preg_replace($pattern, ' ', $displayname);
3615     }
3617     // Trimming $displayname will help the next check to ensure that we don't have a display name with spaces.
3618     $displayname = trim($displayname);
3619     if (empty($displayname)) {
3620         // Going with just the first name if no alternate fields are filled out. May be changed later depending on what
3621         // people in general feel is a good setting to fall back on.
3622         $displayname = $user->firstname;
3623     }
3624     return $displayname;
3627 /**
3628  * A centralised location for the all name fields. Returns an array / sql string snippet.
3629  *
3630  * @param bool $returnsql True for an sql select field snippet.
3631  * @param string $tableprefix table query prefix to use in front of each field.
3632  * @param string $prefix prefix added to the name fields e.g. authorfirstname.
3633  * @param string $fieldprefix sql field prefix e.g. id AS userid.
3634  * @param bool $order moves firstname and lastname to the top of the array / start of the string.
3635  * @return array|string All name fields.
3636  */
3637 function get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) {
3638     // This array is provided in this order because when called by fullname() (above) if firstname is before
3639     // firstnamephonetic str_replace() will change the wrong placeholder.
3640     $alternatenames = array('firstnamephonetic' => 'firstnamephonetic',
3641                             'lastnamephonetic' => 'lastnamephonetic',
3642                             'middlename' => 'middlename',
3643                             'alternatename' => 'alternatename',
3644                             'firstname' => 'firstname',
3645                             'lastname' => 'lastname');
3647     // Let's add a prefix to the array of user name fields if provided.