5b2f3d1acff668c182b98fe9920a6848b883201c
[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', '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['filter']) {
1670         reset_text_filters_cache();
1671     }
1672     if ($options['other']) {
1673         purge_other_caches();
1674     }
1677 /**
1678  * Purge all non-MUC caches not otherwise purged in purge_caches.
1679  *
1680  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1681  * {@link phpunit_util::reset_dataroot()}
1682  */
1683 function purge_other_caches() {
1684     global $DB, $CFG;
1685     core_text::reset_caches();
1686     if (class_exists('core_plugin_manager')) {
1687         core_plugin_manager::reset_caches();
1688     }
1690     // Bump up cacherev field for all courses.
1691     try {
1692         increment_revision_number('course', 'cacherev', '');
1693     } catch (moodle_exception $e) {
1694         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1695     }
1697     $DB->reset_caches();
1699     // Purge all other caches: rss, simplepie, etc.
1700     clearstatcache();
1701     remove_dir($CFG->cachedir.'', true);
1703     // Make sure cache dir is writable, throws exception if not.
1704     make_cache_directory('');
1706     // This is the only place where we purge local caches, we are only adding files there.
1707     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1708     remove_dir($CFG->localcachedir, true);
1709     set_config('localcachedirpurged', time());
1710     make_localcache_directory('', true);
1711     \core\task\manager::clear_static_caches();
1714 /**
1715  * Get volatile flags
1716  *
1717  * @param string $type
1718  * @param int $changedsince default null
1719  * @return array records array
1720  */
1721 function get_cache_flags($type, $changedsince = null) {
1722     global $DB;
1724     $params = array('type' => $type, 'expiry' => time());
1725     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1726     if ($changedsince !== null) {
1727         $params['changedsince'] = $changedsince;
1728         $sqlwhere .= " AND timemodified > :changedsince";
1729     }
1730     $cf = array();
1731     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1732         foreach ($flags as $flag) {
1733             $cf[$flag->name] = $flag->value;
1734         }
1735     }
1736     return $cf;
1739 /**
1740  * Get volatile flags
1741  *
1742  * @param string $type
1743  * @param string $name
1744  * @param int $changedsince default null
1745  * @return string|false The cache flag value or false
1746  */
1747 function get_cache_flag($type, $name, $changedsince=null) {
1748     global $DB;
1750     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1752     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1753     if ($changedsince !== null) {
1754         $params['changedsince'] = $changedsince;
1755         $sqlwhere .= " AND timemodified > :changedsince";
1756     }
1758     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1761 /**
1762  * Set a volatile flag
1763  *
1764  * @param string $type the "type" namespace for the key
1765  * @param string $name the key to set
1766  * @param string $value the value to set (without magic quotes) - null will remove the flag
1767  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1768  * @return bool Always returns true
1769  */
1770 function set_cache_flag($type, $name, $value, $expiry = null) {
1771     global $DB;
1773     $timemodified = time();
1774     if ($expiry === null || $expiry < $timemodified) {
1775         $expiry = $timemodified + 24 * 60 * 60;
1776     } else {
1777         $expiry = (int)$expiry;
1778     }
1780     if ($value === null) {
1781         unset_cache_flag($type, $name);
1782         return true;
1783     }
1785     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1786         // This is a potential problem in DEBUG_DEVELOPER.
1787         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1788             return true; // No need to update.
1789         }
1790         $f->value        = $value;
1791         $f->expiry       = $expiry;
1792         $f->timemodified = $timemodified;
1793         $DB->update_record('cache_flags', $f);
1794     } else {
1795         $f = new stdClass();
1796         $f->flagtype     = $type;
1797         $f->name         = $name;
1798         $f->value        = $value;
1799         $f->expiry       = $expiry;
1800         $f->timemodified = $timemodified;
1801         $DB->insert_record('cache_flags', $f);
1802     }
1803     return true;
1806 /**
1807  * Removes a single volatile flag
1808  *
1809  * @param string $type the "type" namespace for the key
1810  * @param string $name the key to set
1811  * @return bool
1812  */
1813 function unset_cache_flag($type, $name) {
1814     global $DB;
1815     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1816     return true;
1819 /**
1820  * Garbage-collect volatile flags
1821  *
1822  * @return bool Always returns true
1823  */
1824 function gc_cache_flags() {
1825     global $DB;
1826     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1827     return true;
1830 // USER PREFERENCE API.
1832 /**
1833  * Refresh user preference cache. This is used most often for $USER
1834  * object that is stored in session, but it also helps with performance in cron script.
1835  *
1836  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1837  *
1838  * @package  core
1839  * @category preference
1840  * @access   public
1841  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1842  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1843  * @throws   coding_exception
1844  * @return   null
1845  */
1846 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1847     global $DB;
1848     // Static cache, we need to check on each page load, not only every 2 minutes.
1849     static $loadedusers = array();
1851     if (!isset($user->id)) {
1852         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1853     }
1855     if (empty($user->id) or isguestuser($user->id)) {
1856         // No permanent storage for not-logged-in users and guest.
1857         if (!isset($user->preference)) {
1858             $user->preference = array();
1859         }
1860         return;
1861     }
1863     $timenow = time();
1865     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1866         // Already loaded at least once on this page. Are we up to date?
1867         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1868             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1869             return;
1871         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1872             // No change since the lastcheck on this page.
1873             $user->preference['_lastloaded'] = $timenow;
1874             return;
1875         }
1876     }
1878     // OK, so we have to reload all preferences.
1879     $loadedusers[$user->id] = true;
1880     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1881     $user->preference['_lastloaded'] = $timenow;
1884 /**
1885  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1886  *
1887  * NOTE: internal function, do not call from other code.
1888  *
1889  * @package core
1890  * @access private
1891  * @param integer $userid the user whose prefs were changed.
1892  */
1893 function mark_user_preferences_changed($userid) {
1894     global $CFG;
1896     if (empty($userid) or isguestuser($userid)) {
1897         // No cache flags for guest and not-logged-in users.
1898         return;
1899     }
1901     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1904 /**
1905  * Sets a preference for the specified user.
1906  *
1907  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1908  *
1909  * When additional validation/permission check is needed it is better to use {@see useredit_update_user_preference()}
1910  *
1911  * @package  core
1912  * @category preference
1913  * @access   public
1914  * @param    string            $name  The key to set as preference for the specified user
1915  * @param    string            $value The value to set for the $name key in the specified user's
1916  *                                    record, null means delete current value.
1917  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1918  * @throws   coding_exception
1919  * @return   bool                     Always true or exception
1920  */
1921 function set_user_preference($name, $value, $user = null) {
1922     global $USER, $DB;
1924     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1925         throw new coding_exception('Invalid preference name in set_user_preference() call');
1926     }
1928     if (is_null($value)) {
1929         // Null means delete current.
1930         return unset_user_preference($name, $user);
1931     } else if (is_object($value)) {
1932         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1933     } else if (is_array($value)) {
1934         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1935     }
1936     // Value column maximum length is 1333 characters.
1937     $value = (string)$value;
1938     if (core_text::strlen($value) > 1333) {
1939         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1940     }
1942     if (is_null($user)) {
1943         $user = $USER;
1944     } else if (isset($user->id)) {
1945         // It is a valid object.
1946     } else if (is_numeric($user)) {
1947         $user = (object)array('id' => (int)$user);
1948     } else {
1949         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1950     }
1952     check_user_preferences_loaded($user);
1954     if (empty($user->id) or isguestuser($user->id)) {
1955         // No permanent storage for not-logged-in users and guest.
1956         $user->preference[$name] = $value;
1957         return true;
1958     }
1960     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1961         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1962             // Preference already set to this value.
1963             return true;
1964         }
1965         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1967     } else {
1968         $preference = new stdClass();
1969         $preference->userid = $user->id;
1970         $preference->name   = $name;
1971         $preference->value  = $value;
1972         $DB->insert_record('user_preferences', $preference);
1973     }
1975     // Update value in cache.
1976     $user->preference[$name] = $value;
1977     // Update the $USER in case where we've not a direct reference to $USER.
1978     if ($user !== $USER && $user->id == $USER->id) {
1979         $USER->preference[$name] = $value;
1980     }
1982     // Set reload flag for other sessions.
1983     mark_user_preferences_changed($user->id);
1985     return true;
1988 /**
1989  * Sets a whole array of preferences for the current user
1990  *
1991  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1992  *
1993  * @package  core
1994  * @category preference
1995  * @access   public
1996  * @param    array             $prefarray An array of key/value pairs to be set
1997  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1998  * @return   bool                         Always true or exception
1999  */
2000 function set_user_preferences(array $prefarray, $user = null) {
2001     foreach ($prefarray as $name => $value) {
2002         set_user_preference($name, $value, $user);
2003     }
2004     return true;
2007 /**
2008  * Unsets a preference completely by deleting it from the database
2009  *
2010  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
2011  *
2012  * @package  core
2013  * @category preference
2014  * @access   public
2015  * @param    string            $name The key to unset as preference for the specified user
2016  * @param    stdClass|int|null $user A moodle user object or id, null means current user
2017  * @throws   coding_exception
2018  * @return   bool                    Always true or exception
2019  */
2020 function unset_user_preference($name, $user = null) {
2021     global $USER, $DB;
2023     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
2024         throw new coding_exception('Invalid preference name in unset_user_preference() call');
2025     }
2027     if (is_null($user)) {
2028         $user = $USER;
2029     } else if (isset($user->id)) {
2030         // It is a valid object.
2031     } else if (is_numeric($user)) {
2032         $user = (object)array('id' => (int)$user);
2033     } else {
2034         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
2035     }
2037     check_user_preferences_loaded($user);
2039     if (empty($user->id) or isguestuser($user->id)) {
2040         // No permanent storage for not-logged-in user and guest.
2041         unset($user->preference[$name]);
2042         return true;
2043     }
2045     // Delete from DB.
2046     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
2048     // Delete the preference from cache.
2049     unset($user->preference[$name]);
2050     // Update the $USER in case where we've not a direct reference to $USER.
2051     if ($user !== $USER && $user->id == $USER->id) {
2052         unset($USER->preference[$name]);
2053     }
2055     // Set reload flag for other sessions.
2056     mark_user_preferences_changed($user->id);
2058     return true;
2061 /**
2062  * Used to fetch user preference(s)
2063  *
2064  * If no arguments are supplied this function will return
2065  * all of the current user preferences as an array.
2066  *
2067  * If a name is specified then this function
2068  * attempts to return that particular preference value.  If
2069  * none is found, then the optional value $default is returned,
2070  * otherwise null.
2071  *
2072  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
2073  *
2074  * @package  core
2075  * @category preference
2076  * @access   public
2077  * @param    string            $name    Name of the key to use in finding a preference value
2078  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
2079  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
2080  * @throws   coding_exception
2081  * @return   string|mixed|null          A string containing the value of a single preference. An
2082  *                                      array with all of the preferences or null
2083  */
2084 function get_user_preferences($name = null, $default = null, $user = null) {
2085     global $USER;
2087     if (is_null($name)) {
2088         // All prefs.
2089     } else if (is_numeric($name) or $name === '_lastloaded') {
2090         throw new coding_exception('Invalid preference name in get_user_preferences() call');
2091     }
2093     if (is_null($user)) {
2094         $user = $USER;
2095     } else if (isset($user->id)) {
2096         // Is a valid object.
2097     } else if (is_numeric($user)) {
2098         if ($USER->id == $user) {
2099             $user = $USER;
2100         } else {
2101             $user = (object)array('id' => (int)$user);
2102         }
2103     } else {
2104         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2105     }
2107     check_user_preferences_loaded($user);
2109     if (empty($name)) {
2110         // All values.
2111         return $user->preference;
2112     } else if (isset($user->preference[$name])) {
2113         // The single string value.
2114         return $user->preference[$name];
2115     } else {
2116         // Default value (null if not specified).
2117         return $default;
2118     }
2121 // FUNCTIONS FOR HANDLING TIME.
2123 /**
2124  * Given Gregorian date parts in user time produce a GMT timestamp.
2125  *
2126  * @package core
2127  * @category time
2128  * @param int $year The year part to create timestamp of
2129  * @param int $month The month part to create timestamp of
2130  * @param int $day The day part to create timestamp of
2131  * @param int $hour The hour part to create timestamp of
2132  * @param int $minute The minute part to create timestamp of
2133  * @param int $second The second part to create timestamp of
2134  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2135  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2136  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2137  *             applied only if timezone is 99 or string.
2138  * @return int GMT timestamp
2139  */
2140 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2141     $date = new DateTime('now', core_date::get_user_timezone_object($timezone));
2142     $date->setDate((int)$year, (int)$month, (int)$day);
2143     $date->setTime((int)$hour, (int)$minute, (int)$second);
2145     $time = $date->getTimestamp();
2147     if ($time === false) {
2148         throw new coding_exception('getTimestamp() returned false, please ensure you have passed correct values.'.
2149             ' This can fail if year is more than 2038 and OS is 32 bit windows');
2150     }
2152     // Moodle BC DST stuff.
2153     if (!$applydst) {
2154         $time += dst_offset_on($time, $timezone);
2155     }
2157     return $time;
2161 /**
2162  * Format a date/time (seconds) as weeks, days, hours etc as needed
2163  *
2164  * Given an amount of time in seconds, returns string
2165  * formatted nicely as years, days, hours etc as needed
2166  *
2167  * @package core
2168  * @category time
2169  * @uses MINSECS
2170  * @uses HOURSECS
2171  * @uses DAYSECS
2172  * @uses YEARSECS
2173  * @param int $totalsecs Time in seconds
2174  * @param stdClass $str Should be a time object
2175  * @return string A nicely formatted date/time string
2176  */
2177 function format_time($totalsecs, $str = null) {
2179     $totalsecs = abs($totalsecs);
2181     if (!$str) {
2182         // Create the str structure the slow way.
2183         $str = new stdClass();
2184         $str->day   = get_string('day');
2185         $str->days  = get_string('days');
2186         $str->hour  = get_string('hour');
2187         $str->hours = get_string('hours');
2188         $str->min   = get_string('min');
2189         $str->mins  = get_string('mins');
2190         $str->sec   = get_string('sec');
2191         $str->secs  = get_string('secs');
2192         $str->year  = get_string('year');
2193         $str->years = get_string('years');
2194     }
2196     $years     = floor($totalsecs/YEARSECS);
2197     $remainder = $totalsecs - ($years*YEARSECS);
2198     $days      = floor($remainder/DAYSECS);
2199     $remainder = $totalsecs - ($days*DAYSECS);
2200     $hours     = floor($remainder/HOURSECS);
2201     $remainder = $remainder - ($hours*HOURSECS);
2202     $mins      = floor($remainder/MINSECS);
2203     $secs      = $remainder - ($mins*MINSECS);
2205     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2206     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2207     $sh = ($hours == 1) ? $str->hour : $str->hours;
2208     $sd = ($days == 1)  ? $str->day  : $str->days;
2209     $sy = ($years == 1)  ? $str->year  : $str->years;
2211     $oyears = '';
2212     $odays = '';
2213     $ohours = '';
2214     $omins = '';
2215     $osecs = '';
2217     if ($years) {
2218         $oyears  = $years .' '. $sy;
2219     }
2220     if ($days) {
2221         $odays  = $days .' '. $sd;
2222     }
2223     if ($hours) {
2224         $ohours = $hours .' '. $sh;
2225     }
2226     if ($mins) {
2227         $omins  = $mins .' '. $sm;
2228     }
2229     if ($secs) {
2230         $osecs  = $secs .' '. $ss;
2231     }
2233     if ($years) {
2234         return trim($oyears .' '. $odays);
2235     }
2236     if ($days) {
2237         return trim($odays .' '. $ohours);
2238     }
2239     if ($hours) {
2240         return trim($ohours .' '. $omins);
2241     }
2242     if ($mins) {
2243         return trim($omins .' '. $osecs);
2244     }
2245     if ($secs) {
2246         return $osecs;
2247     }
2248     return get_string('now');
2251 /**
2252  * Returns a formatted string that represents a date in user time.
2253  *
2254  * @package core
2255  * @category time
2256  * @param int $date the timestamp in UTC, as obtained from the database.
2257  * @param string $format strftime format. You should probably get this using
2258  *        get_string('strftime...', 'langconfig');
2259  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2260  *        not 99 then daylight saving will not be added.
2261  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2262  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2263  *        If false then the leading zero is maintained.
2264  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2265  * @return string the formatted date/time.
2266  */
2267 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2268     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2269     return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
2272 /**
2273  * Returns a html "time" tag with both the exact user date with timezone information
2274  * as a datetime attribute in the W3C format, and the user readable date and time as text.
2275  *
2276  * @package core
2277  * @category time
2278  * @param int $date the timestamp in UTC, as obtained from the database.
2279  * @param string $format strftime format. You should probably get this using
2280  *        get_string('strftime...', 'langconfig');
2281  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2282  *        not 99 then daylight saving will not be added.
2283  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2284  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2285  *        If false then the leading zero is maintained.
2286  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2287  * @return string the formatted date/time.
2288  */
2289 function userdate_htmltime($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2290     $userdatestr = userdate($date, $format, $timezone, $fixday, $fixhour);
2291     if (CLI_SCRIPT && !PHPUNIT_TEST) {
2292         return $userdatestr;
2293     }
2294     $machinedate = new DateTime();
2295     $machinedate->setTimestamp(intval($date));
2296     $machinedate->setTimezone(core_date::get_user_timezone_object());
2298     return html_writer::tag('time', $userdatestr, ['datetime' => $machinedate->format(DateTime::W3C)]);
2301 /**
2302  * Returns a formatted date ensuring it is UTF-8.
2303  *
2304  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2305  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2306  *
2307  * @param int $date the timestamp - since Moodle 2.9 this is a real UTC timestamp
2308  * @param string $format strftime format.
2309  * @param int|float|string $tz the user timezone
2310  * @return string the formatted date/time.
2311  * @since Moodle 2.3.3
2312  */
2313 function date_format_string($date, $format, $tz = 99) {
2314     global $CFG;
2316     $localewincharset = null;
2317     // Get the calendar type user is using.
2318     if ($CFG->ostype == 'WINDOWS') {
2319         $calendartype = \core_calendar\type_factory::get_calendar_instance();
2320         $localewincharset = $calendartype->locale_win_charset();
2321     }
2323     if ($localewincharset) {
2324         $format = core_text::convert($format, 'utf-8', $localewincharset);
2325     }
2327     date_default_timezone_set(core_date::get_user_timezone($tz));
2328     $datestring = strftime($format, $date);
2329     core_date::set_default_server_timezone();
2331     if ($localewincharset) {
2332         $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2333     }
2335     return $datestring;
2338 /**
2339  * Given a $time timestamp in GMT (seconds since epoch),
2340  * returns an array that represents the Gregorian date in user time
2341  *
2342  * @package core
2343  * @category time
2344  * @param int $time Timestamp in GMT
2345  * @param float|int|string $timezone user timezone
2346  * @return array An array that represents the date in user time
2347  */
2348 function usergetdate($time, $timezone=99) {
2349     date_default_timezone_set(core_date::get_user_timezone($timezone));
2350     $result = getdate($time);
2351     core_date::set_default_server_timezone();
2353     return $result;
2356 /**
2357  * Given a GMT timestamp (seconds since epoch), offsets it by
2358  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2359  *
2360  * NOTE: this function does not include DST properly,
2361  *       you should use the PHP date stuff instead!
2362  *
2363  * @package core
2364  * @category time
2365  * @param int $date Timestamp in GMT
2366  * @param float|int|string $timezone user timezone
2367  * @return int
2368  */
2369 function usertime($date, $timezone=99) {
2370     $userdate = new DateTime('@' . $date);
2371     $userdate->setTimezone(core_date::get_user_timezone_object($timezone));
2372     $dst = dst_offset_on($date, $timezone);
2374     return $date - $userdate->getOffset() + $dst;
2377 /**
2378  * Given a time, return the GMT timestamp of the most recent midnight
2379  * for the current user.
2380  *
2381  * @package core
2382  * @category time
2383  * @param int $date Timestamp in GMT
2384  * @param float|int|string $timezone user timezone
2385  * @return int Returns a GMT timestamp
2386  */
2387 function usergetmidnight($date, $timezone=99) {
2389     $userdate = usergetdate($date, $timezone);
2391     // Time of midnight of this user's day, in GMT.
2392     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2396 /**
2397  * Returns a string that prints the user's timezone
2398  *
2399  * @package core
2400  * @category time
2401  * @param float|int|string $timezone user timezone
2402  * @return string
2403  */
2404 function usertimezone($timezone=99) {
2405     $tz = core_date::get_user_timezone($timezone);
2406     return core_date::get_localised_timezone($tz);
2409 /**
2410  * Returns a float or a string which denotes the user's timezone
2411  * 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)
2412  * means that for this timezone there are also DST rules to be taken into account
2413  * Checks various settings and picks the most dominant of those which have a value
2414  *
2415  * @package core
2416  * @category time
2417  * @param float|int|string $tz timezone to calculate GMT time offset before
2418  *        calculating user timezone, 99 is default user timezone
2419  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2420  * @return float|string
2421  */
2422 function get_user_timezone($tz = 99) {
2423     global $USER, $CFG;
2425     $timezones = array(
2426         $tz,
2427         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2428         isset($USER->timezone) ? $USER->timezone : 99,
2429         isset($CFG->timezone) ? $CFG->timezone : 99,
2430         );
2432     $tz = 99;
2434     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2435     foreach ($timezones as $nextvalue) {
2436         if ((empty($tz) && !is_numeric($tz)) || $tz == 99) {
2437             $tz = $nextvalue;
2438         }
2439     }
2440     return is_numeric($tz) ? (float) $tz : $tz;
2443 /**
2444  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2445  * - Note: Daylight saving only works for string timezones and not for float.
2446  *
2447  * @package core
2448  * @category time
2449  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2450  * @param int|float|string $strtimezone user timezone
2451  * @return int
2452  */
2453 function dst_offset_on($time, $strtimezone = null) {
2454     $tz = core_date::get_user_timezone($strtimezone);
2455     $date = new DateTime('@' . $time);
2456     $date->setTimezone(new DateTimeZone($tz));
2457     if ($date->format('I') == '1') {
2458         if ($tz === 'Australia/Lord_Howe') {
2459             return 1800;
2460         }
2461         return 3600;
2462     }
2463     return 0;
2466 /**
2467  * Calculates when the day appears in specific month
2468  *
2469  * @package core
2470  * @category time
2471  * @param int $startday starting day of the month
2472  * @param int $weekday The day when week starts (normally taken from user preferences)
2473  * @param int $month The month whose day is sought
2474  * @param int $year The year of the month whose day is sought
2475  * @return int
2476  */
2477 function find_day_in_month($startday, $weekday, $month, $year) {
2478     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2480     $daysinmonth = days_in_month($month, $year);
2481     $daysinweek = count($calendartype->get_weekdays());
2483     if ($weekday == -1) {
2484         // Don't care about weekday, so return:
2485         //    abs($startday) if $startday != -1
2486         //    $daysinmonth otherwise.
2487         return ($startday == -1) ? $daysinmonth : abs($startday);
2488     }
2490     // From now on we 're looking for a specific weekday.
2491     // Give "end of month" its actual value, since we know it.
2492     if ($startday == -1) {
2493         $startday = -1 * $daysinmonth;
2494     }
2496     // Starting from day $startday, the sign is the direction.
2497     if ($startday < 1) {
2498         $startday = abs($startday);
2499         $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
2501         // This is the last such weekday of the month.
2502         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2503         if ($lastinmonth > $daysinmonth) {
2504             $lastinmonth -= $daysinweek;
2505         }
2507         // Find the first such weekday <= $startday.
2508         while ($lastinmonth > $startday) {
2509             $lastinmonth -= $daysinweek;
2510         }
2512         return $lastinmonth;
2513     } else {
2514         $indexweekday = dayofweek($startday, $month, $year);
2516         $diff = $weekday - $indexweekday;
2517         if ($diff < 0) {
2518             $diff += $daysinweek;
2519         }
2521         // This is the first such weekday of the month equal to or after $startday.
2522         $firstfromindex = $startday + $diff;
2524         return $firstfromindex;
2525     }
2528 /**
2529  * Calculate the number of days in a given month
2530  *
2531  * @package core
2532  * @category time
2533  * @param int $month The month whose day count is sought
2534  * @param int $year The year of the month whose day count is sought
2535  * @return int
2536  */
2537 function days_in_month($month, $year) {
2538     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2539     return $calendartype->get_num_days_in_month($year, $month);
2542 /**
2543  * Calculate the position in the week of a specific calendar day
2544  *
2545  * @package core
2546  * @category time
2547  * @param int $day The day of the date whose position in the week is sought
2548  * @param int $month The month of the date whose position in the week is sought
2549  * @param int $year The year of the date whose position in the week is sought
2550  * @return int
2551  */
2552 function dayofweek($day, $month, $year) {
2553     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2554     return $calendartype->get_weekday($year, $month, $day);
2557 // USER AUTHENTICATION AND LOGIN.
2559 /**
2560  * Returns full login url.
2561  *
2562  * Any form submissions for authentication to this URL must include username,
2563  * password as well as a logintoken generated by \core\session\manager::get_login_token().
2564  *
2565  * @return string login url
2566  */
2567 function get_login_url() {
2568     global $CFG;
2570     return "$CFG->wwwroot/login/index.php";
2573 /**
2574  * This function checks that the current user is logged in and has the
2575  * required privileges
2576  *
2577  * This function checks that the current user is logged in, and optionally
2578  * whether they are allowed to be in a particular course and view a particular
2579  * course module.
2580  * If they are not logged in, then it redirects them to the site login unless
2581  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2582  * case they are automatically logged in as guests.
2583  * If $courseid is given and the user is not enrolled in that course then the
2584  * user is redirected to the course enrolment page.
2585  * If $cm is given and the course module is hidden and the user is not a teacher
2586  * in the course then the user is redirected to the course home page.
2587  *
2588  * When $cm parameter specified, this function sets page layout to 'module'.
2589  * You need to change it manually later if some other layout needed.
2590  *
2591  * @package    core_access
2592  * @category   access
2593  *
2594  * @param mixed $courseorid id of the course or course object
2595  * @param bool $autologinguest default true
2596  * @param object $cm course module object
2597  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2598  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2599  *             in order to keep redirects working properly. MDL-14495
2600  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2601  * @return mixed Void, exit, and die depending on path
2602  * @throws coding_exception
2603  * @throws require_login_exception
2604  * @throws moodle_exception
2605  */
2606 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2607     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2609     // Must not redirect when byteserving already started.
2610     if (!empty($_SERVER['HTTP_RANGE'])) {
2611         $preventredirect = true;
2612     }
2614     if (AJAX_SCRIPT) {
2615         // We cannot redirect for AJAX scripts either.
2616         $preventredirect = true;
2617     }
2619     // Setup global $COURSE, themes, language and locale.
2620     if (!empty($courseorid)) {
2621         if (is_object($courseorid)) {
2622             $course = $courseorid;
2623         } else if ($courseorid == SITEID) {
2624             $course = clone($SITE);
2625         } else {
2626             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2627         }
2628         if ($cm) {
2629             if ($cm->course != $course->id) {
2630                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2631             }
2632             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2633             if (!($cm instanceof cm_info)) {
2634                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2635                 // db queries so this is not really a performance concern, however it is obviously
2636                 // better if you use get_fast_modinfo to get the cm before calling this.
2637                 $modinfo = get_fast_modinfo($course);
2638                 $cm = $modinfo->get_cm($cm->id);
2639             }
2640         }
2641     } else {
2642         // Do not touch global $COURSE via $PAGE->set_course(),
2643         // the reasons is we need to be able to call require_login() at any time!!
2644         $course = $SITE;
2645         if ($cm) {
2646             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2647         }
2648     }
2650     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2651     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2652     // risk leading the user back to the AJAX request URL.
2653     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2654         $setwantsurltome = false;
2655     }
2657     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2658     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !empty($CFG->dbsessions)) {
2659         if ($preventredirect) {
2660             throw new require_login_session_timeout_exception();
2661         } else {
2662             if ($setwantsurltome) {
2663                 $SESSION->wantsurl = qualified_me();
2664             }
2665             redirect(get_login_url());
2666         }
2667     }
2669     // If the user is not even logged in yet then make sure they are.
2670     if (!isloggedin()) {
2671         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2672             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2673                 // Misconfigured site guest, just redirect to login page.
2674                 redirect(get_login_url());
2675                 exit; // Never reached.
2676             }
2677             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2678             complete_user_login($guest);
2679             $USER->autologinguest = true;
2680             $SESSION->lang = $lang;
2681         } else {
2682             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2683             if ($preventredirect) {
2684                 throw new require_login_exception('You are not logged in');
2685             }
2687             if ($setwantsurltome) {
2688                 $SESSION->wantsurl = qualified_me();
2689             }
2691             $referer = get_local_referer(false);
2692             if (!empty($referer)) {
2693                 $SESSION->fromurl = $referer;
2694             }
2696             // Give auth plugins an opportunity to authenticate or redirect to an external login page
2697             $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
2698             foreach($authsequence as $authname) {
2699                 $authplugin = get_auth_plugin($authname);
2700                 $authplugin->pre_loginpage_hook();
2701                 if (isloggedin()) {
2702                     if ($cm) {
2703                         $modinfo = get_fast_modinfo($course);
2704                         $cm = $modinfo->get_cm($cm->id);
2705                     }
2706                     set_access_log_user();
2707                     break;
2708                 }
2709             }
2711             // If we're still not logged in then go to the login page
2712             if (!isloggedin()) {
2713                 redirect(get_login_url());
2714                 exit; // Never reached.
2715             }
2716         }
2717     }
2719     // Loginas as redirection if needed.
2720     if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
2721         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2722             if ($USER->loginascontext->instanceid != $course->id) {
2723                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2724             }
2725         }
2726     }
2728     // Check whether the user should be changing password (but only if it is REALLY them).
2729     if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
2730         $userauth = get_auth_plugin($USER->auth);
2731         if ($userauth->can_change_password() and !$preventredirect) {
2732             if ($setwantsurltome) {
2733                 $SESSION->wantsurl = qualified_me();
2734             }
2735             if ($changeurl = $userauth->change_password_url()) {
2736                 // Use plugin custom url.
2737                 redirect($changeurl);
2738             } else {
2739                 // Use moodle internal method.
2740                 redirect($CFG->wwwroot .'/login/change_password.php');
2741             }
2742         } else if ($userauth->can_change_password()) {
2743             throw new moodle_exception('forcepasswordchangenotice');
2744         } else {
2745             throw new moodle_exception('nopasswordchangeforced', 'auth');
2746         }
2747     }
2749     // Check that the user account is properly set up. If we can't redirect to
2750     // edit their profile and this is not a WS request, perform just the lax check.
2751     // It will allow them to use filepicker on the profile edit page.
2753     if ($preventredirect && !WS_SERVER) {
2754         $usernotfullysetup = user_not_fully_set_up($USER, false);
2755     } else {
2756         $usernotfullysetup = user_not_fully_set_up($USER, true);
2757     }
2759     if ($usernotfullysetup) {
2760         if ($preventredirect) {
2761             throw new moodle_exception('usernotfullysetup');
2762         }
2763         if ($setwantsurltome) {
2764             $SESSION->wantsurl = qualified_me();
2765         }
2766         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2767     }
2769     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2770     sesskey();
2772     if (\core\session\manager::is_loggedinas()) {
2773         // During a "logged in as" session we should force all content to be cleaned because the
2774         // logged in user will be viewing potentially malicious user generated content.
2775         // See MDL-63786 for more details.
2776         $CFG->forceclean = true;
2777     }
2779     $afterlogins = get_plugins_with_function('after_require_login', 'lib.php');
2781     // Do not bother admins with any formalities, except for activities pending deletion.
2782     if (is_siteadmin() && !($cm && $cm->deletioninprogress)) {
2783         // Set the global $COURSE.
2784         if ($cm) {
2785             $PAGE->set_cm($cm, $course);
2786             $PAGE->set_pagelayout('incourse');
2787         } else if (!empty($courseorid)) {
2788             $PAGE->set_course($course);
2789         }
2790         // Set accesstime or the user will appear offline which messes up messaging.
2791         // Do not update access time for webservice or ajax requests.
2792         if (!WS_SERVER && !AJAX_SCRIPT) {
2793             user_accesstime_log($course->id);
2794         }
2796         foreach ($afterlogins as $plugintype => $plugins) {
2797             foreach ($plugins as $pluginfunction) {
2798                 $pluginfunction($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2799             }
2800         }
2801         return;
2802     }
2804     // Scripts have a chance to declare that $USER->policyagreed should not be checked.
2805     // This is mostly for places where users are actually accepting the policies, to avoid the redirect loop.
2806     if (!defined('NO_SITEPOLICY_CHECK')) {
2807         define('NO_SITEPOLICY_CHECK', false);
2808     }
2810     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2811     // Do not test if the script explicitly asked for skipping the site policies check.
2812     if (!$USER->policyagreed && !is_siteadmin() && !NO_SITEPOLICY_CHECK) {
2813         $manager = new \core_privacy\local\sitepolicy\manager();
2814         if ($policyurl = $manager->get_redirect_url(isguestuser())) {
2815             if ($preventredirect) {
2816                 throw new moodle_exception('sitepolicynotagreed', 'error', '', $policyurl->out());
2817             }
2818             if ($setwantsurltome) {
2819                 $SESSION->wantsurl = qualified_me();
2820             }
2821             redirect($policyurl);
2822         }
2823     }
2825     // Fetch the system context, the course context, and prefetch its child contexts.
2826     $sysctx = context_system::instance();
2827     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2828     if ($cm) {
2829         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2830     } else {
2831         $cmcontext = null;
2832     }
2834     // If the site is currently under maintenance, then print a message.
2835     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:maintenanceaccess', $sysctx)) {
2836         if ($preventredirect) {
2837             throw new require_login_exception('Maintenance in progress');
2838         }
2839         $PAGE->set_context(null);
2840         print_maintenance_message();
2841     }
2843     // Make sure the course itself is not hidden.
2844     if ($course->id == SITEID) {
2845         // Frontpage can not be hidden.
2846     } else {
2847         if (is_role_switched($course->id)) {
2848             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
2849         } else {
2850             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2851                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
2852                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
2853                 if ($preventredirect) {
2854                     throw new require_login_exception('Course is hidden');
2855                 }
2856                 $PAGE->set_context(null);
2857                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2858                 // the navigation will mess up when trying to find it.
2859                 navigation_node::override_active_url(new moodle_url('/'));
2860                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2861             }
2862         }
2863     }
2865     // Is the user enrolled?
2866     if ($course->id == SITEID) {
2867         // Everybody is enrolled on the frontpage.
2868     } else {
2869         if (\core\session\manager::is_loggedinas()) {
2870             // Make sure the REAL person can access this course first.
2871             $realuser = \core\session\manager::get_realuser();
2872             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
2873                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2874                 if ($preventredirect) {
2875                     throw new require_login_exception('Invalid course login-as access');
2876                 }
2877                 $PAGE->set_context(null);
2878                 echo $OUTPUT->header();
2879                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2880             }
2881         }
2883         $access = false;
2885         if (is_role_switched($course->id)) {
2886             // Ok, user had to be inside this course before the switch.
2887             $access = true;
2889         } else if (is_viewing($coursecontext, $USER)) {
2890             // Ok, no need to mess with enrol.
2891             $access = true;
2893         } else {
2894             if (isset($USER->enrol['enrolled'][$course->id])) {
2895                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2896                     $access = true;
2897                     if (isset($USER->enrol['tempguest'][$course->id])) {
2898                         unset($USER->enrol['tempguest'][$course->id]);
2899                         remove_temp_course_roles($coursecontext);
2900                     }
2901                 } else {
2902                     // Expired.
2903                     unset($USER->enrol['enrolled'][$course->id]);
2904                 }
2905             }
2906             if (isset($USER->enrol['tempguest'][$course->id])) {
2907                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2908                     $access = true;
2909                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2910                     $access = true;
2911                 } else {
2912                     // Expired.
2913                     unset($USER->enrol['tempguest'][$course->id]);
2914                     remove_temp_course_roles($coursecontext);
2915                 }
2916             }
2918             if (!$access) {
2919                 // Cache not ok.
2920                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2921                 if ($until !== false) {
2922                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
2923                     if ($until == 0) {
2924                         $until = ENROL_MAX_TIMESTAMP;
2925                     }
2926                     $USER->enrol['enrolled'][$course->id] = $until;
2927                     $access = true;
2929                 } else if (core_course_category::can_view_course_info($course)) {
2930                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
2931                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
2932                     $enrols = enrol_get_plugins(true);
2933                     // First ask all enabled enrol instances in course if they want to auto enrol user.
2934                     foreach ($instances as $instance) {
2935                         if (!isset($enrols[$instance->enrol])) {
2936                             continue;
2937                         }
2938                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2939                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2940                         if ($until !== false) {
2941                             if ($until == 0) {
2942                                 $until = ENROL_MAX_TIMESTAMP;
2943                             }
2944                             $USER->enrol['enrolled'][$course->id] = $until;
2945                             $access = true;
2946                             break;
2947                         }
2948                     }
2949                     // If not enrolled yet try to gain temporary guest access.
2950                     if (!$access) {
2951                         foreach ($instances as $instance) {
2952                             if (!isset($enrols[$instance->enrol])) {
2953                                 continue;
2954                             }
2955                             // Get a duration for the guest access, a timestamp in the future or false.
2956                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2957                             if ($until !== false and $until > time()) {
2958                                 $USER->enrol['tempguest'][$course->id] = $until;
2959                                 $access = true;
2960                                 break;
2961                             }
2962                         }
2963                     }
2964                 } else {
2965                     // User is not enrolled and is not allowed to browse courses here.
2966                     if ($preventredirect) {
2967                         throw new require_login_exception('Course is not available');
2968                     }
2969                     $PAGE->set_context(null);
2970                     // We need to override the navigation URL as the course won't have been added to the navigation and thus
2971                     // the navigation will mess up when trying to find it.
2972                     navigation_node::override_active_url(new moodle_url('/'));
2973                     notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2974                 }
2975             }
2976         }
2978         if (!$access) {
2979             if ($preventredirect) {
2980                 throw new require_login_exception('Not enrolled');
2981             }
2982             if ($setwantsurltome) {
2983                 $SESSION->wantsurl = qualified_me();
2984             }
2985             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2986         }
2987     }
2989     // Check whether the activity has been scheduled for deletion. If so, then deny access, even for admins.
2990     if ($cm && $cm->deletioninprogress) {
2991         if ($preventredirect) {
2992             throw new moodle_exception('activityisscheduledfordeletion');
2993         }
2994         require_once($CFG->dirroot . '/course/lib.php');
2995         redirect(course_get_url($course), get_string('activityisscheduledfordeletion', 'error'));
2996     }
2998     // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
2999     if ($cm && !$cm->uservisible) {
3000         if ($preventredirect) {
3001             throw new require_login_exception('Activity is hidden');
3002         }
3003         // Get the error message that activity is not available and why (if explanation can be shown to the user).
3004         $PAGE->set_course($course);
3005         $renderer = $PAGE->get_renderer('course');
3006         $message = $renderer->course_section_cm_unavailable_error_message($cm);
3007         redirect(course_get_url($course), $message, null, \core\output\notification::NOTIFY_ERROR);
3008     }
3010     // Set the global $COURSE.
3011     if ($cm) {
3012         $PAGE->set_cm($cm, $course);
3013         $PAGE->set_pagelayout('incourse');
3014     } else if (!empty($courseorid)) {
3015         $PAGE->set_course($course);
3016     }
3018     foreach ($afterlogins as $plugintype => $plugins) {
3019         foreach ($plugins as $pluginfunction) {
3020             $pluginfunction($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3021         }
3022     }
3024     // Finally access granted, update lastaccess times.
3025     // Do not update access time for webservice or ajax requests.
3026     if (!WS_SERVER && !AJAX_SCRIPT) {
3027         user_accesstime_log($course->id);
3028     }
3031 /**
3032  * A convenience function for where we must be logged in as admin
3033  * @return void
3034  */
3035 function require_admin() {
3036     require_login(null, false);
3037     require_capability('moodle/site:config', context_system::instance());
3040 /**
3041  * This function just makes sure a user is logged out.
3042  *
3043  * @package    core_access
3044  * @category   access
3045  */
3046 function require_logout() {
3047     global $USER, $DB;
3049     if (!isloggedin()) {
3050         // This should not happen often, no need for hooks or events here.
3051         \core\session\manager::terminate_current();
3052         return;
3053     }
3055     // Execute hooks before action.
3056     $authplugins = array();
3057     $authsequence = get_enabled_auth_plugins();
3058     foreach ($authsequence as $authname) {
3059         $authplugins[$authname] = get_auth_plugin($authname);
3060         $authplugins[$authname]->prelogout_hook();
3061     }
3063     // Store info that gets removed during logout.
3064     $sid = session_id();
3065     $event = \core\event\user_loggedout::create(
3066         array(
3067             'userid' => $USER->id,
3068             'objectid' => $USER->id,
3069             'other' => array('sessionid' => $sid),
3070         )
3071     );
3072     if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
3073         $event->add_record_snapshot('sessions', $session);
3074     }
3076     // Clone of $USER object to be used by auth plugins.
3077     $user = fullclone($USER);
3079     // Delete session record and drop $_SESSION content.
3080     \core\session\manager::terminate_current();
3082     // Trigger event AFTER action.
3083     $event->trigger();
3085     // Hook to execute auth plugins redirection after event trigger.
3086     foreach ($authplugins as $authplugin) {
3087         $authplugin->postlogout_hook($user);
3088     }
3091 /**
3092  * Weaker version of require_login()
3093  *
3094  * This is a weaker version of {@link require_login()} which only requires login
3095  * when called from within a course rather than the site page, unless
3096  * the forcelogin option is turned on.
3097  * @see require_login()
3098  *
3099  * @package    core_access
3100  * @category   access
3101  *
3102  * @param mixed $courseorid The course object or id in question
3103  * @param bool $autologinguest Allow autologin guests if that is wanted
3104  * @param object $cm Course activity module if known
3105  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3106  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3107  *             in order to keep redirects working properly. MDL-14495
3108  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3109  * @return void
3110  * @throws coding_exception
3111  */
3112 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3113     global $CFG, $PAGE, $SITE;
3114     $issite = ((is_object($courseorid) and $courseorid->id == SITEID)
3115           or (!is_object($courseorid) and $courseorid == SITEID));
3116     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3117         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3118         // db queries so this is not really a performance concern, however it is obviously
3119         // better if you use get_fast_modinfo to get the cm before calling this.
3120         if (is_object($courseorid)) {
3121             $course = $courseorid;
3122         } else {
3123             $course = clone($SITE);
3124         }
3125         $modinfo = get_fast_modinfo($course);
3126         $cm = $modinfo->get_cm($cm->id);
3127     }
3128     if (!empty($CFG->forcelogin)) {
3129         // Login required for both SITE and courses.
3130         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3132     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3133         // Always login for hidden activities.
3134         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3136     } else if (isloggedin() && !isguestuser()) {
3137         // User is already logged in. Make sure the login is complete (user is fully setup, policies agreed).
3138         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3140     } else if ($issite) {
3141         // Login for SITE not required.
3142         // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3143         if (!empty($courseorid)) {
3144             if (is_object($courseorid)) {
3145                 $course = $courseorid;
3146             } else {
3147                 $course = clone $SITE;
3148             }
3149             if ($cm) {
3150                 if ($cm->course != $course->id) {
3151                     throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3152                 }
3153                 $PAGE->set_cm($cm, $course);
3154                 $PAGE->set_pagelayout('incourse');
3155             } else {
3156                 $PAGE->set_course($course);
3157             }
3158         } else {
3159             // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3160             $PAGE->set_course($PAGE->course);
3161         }
3162         // Do not update access time for webservice or ajax requests.
3163         if (!WS_SERVER && !AJAX_SCRIPT) {
3164             user_accesstime_log(SITEID);
3165         }
3166         return;
3168     } else {
3169         // Course login always required.
3170         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3171     }
3174 /**
3175  * Validates a user key, checking if the key exists, is not expired and the remote ip is correct.
3176  *
3177  * @param  string $keyvalue the key value
3178  * @param  string $script   unique script identifier
3179  * @param  int $instance    instance id
3180  * @return stdClass the key entry in the user_private_key table
3181  * @since Moodle 3.2
3182  * @throws moodle_exception
3183  */
3184 function validate_user_key($keyvalue, $script, $instance) {
3185     global $DB;
3187     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3188         print_error('invalidkey');
3189     }
3191     if (!empty($key->validuntil) and $key->validuntil < time()) {
3192         print_error('expiredkey');
3193     }
3195     if ($key->iprestriction) {
3196         $remoteaddr = getremoteaddr(null);
3197         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3198             print_error('ipmismatch');
3199         }
3200     }
3201     return $key;
3204 /**
3205  * Require key login. Function terminates with error if key not found or incorrect.
3206  *
3207  * @uses NO_MOODLE_COOKIES
3208  * @uses PARAM_ALPHANUM
3209  * @param string $script unique script identifier
3210  * @param int $instance optional instance id
3211  * @param string $keyvalue The key. If not supplied, this will be fetched from the current session.
3212  * @return int Instance ID
3213  */
3214 function require_user_key_login($script, $instance = null, $keyvalue = null) {
3215     global $DB;
3217     if (!NO_MOODLE_COOKIES) {
3218         print_error('sessioncookiesdisable');
3219     }
3221     // Extra safety.
3222     \core\session\manager::write_close();
3224     if (null === $keyvalue) {
3225         $keyvalue = required_param('key', PARAM_ALPHANUM);
3226     }
3228     $key = validate_user_key($keyvalue, $script, $instance);
3230     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3231         print_error('invaliduserid');
3232     }
3234     // Emulate normal session.
3235     enrol_check_plugins($user);
3236     \core\session\manager::set_user($user);
3238     // Note we are not using normal login.
3239     if (!defined('USER_KEY_LOGIN')) {
3240         define('USER_KEY_LOGIN', true);
3241     }
3243     // Return instance id - it might be empty.
3244     return $key->instance;
3247 /**
3248  * Creates a new private user access key.
3249  *
3250  * @param string $script unique target identifier
3251  * @param int $userid
3252  * @param int $instance optional instance id
3253  * @param string $iprestriction optional ip restricted access
3254  * @param int $validuntil key valid only until given data
3255  * @return string access key value
3256  */
3257 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3258     global $DB;
3260     $key = new stdClass();
3261     $key->script        = $script;
3262     $key->userid        = $userid;
3263     $key->instance      = $instance;
3264     $key->iprestriction = $iprestriction;
3265     $key->validuntil    = $validuntil;
3266     $key->timecreated   = time();
3268     // Something long and unique.
3269     $key->value         = md5($userid.'_'.time().random_string(40));
3270     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3271         // Must be unique.
3272         $key->value     = md5($userid.'_'.time().random_string(40));
3273     }
3274     $DB->insert_record('user_private_key', $key);
3275     return $key->value;
3278 /**
3279  * Delete the user's new private user access keys for a particular script.
3280  *
3281  * @param string $script unique target identifier
3282  * @param int $userid
3283  * @return void
3284  */
3285 function delete_user_key($script, $userid) {
3286     global $DB;
3287     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3290 /**
3291  * Gets a private user access key (and creates one if one doesn't exist).
3292  *
3293  * @param string $script unique target identifier
3294  * @param int $userid
3295  * @param int $instance optional instance id
3296  * @param string $iprestriction optional ip restricted access
3297  * @param int $validuntil key valid only until given date
3298  * @return string access key value
3299  */
3300 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3301     global $DB;
3303     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3304                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3305                                                          'validuntil' => $validuntil))) {
3306         return $key->value;
3307     } else {
3308         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3309     }
3313 /**
3314  * Modify the user table by setting the currently logged in user's last login to now.
3315  *
3316  * @return bool Always returns true
3317  */
3318 function update_user_login_times() {
3319     global $USER, $DB;
3321     if (isguestuser()) {
3322         // Do not update guest access times/ips for performance.
3323         return true;
3324     }
3326     $now = time();
3328     $user = new stdClass();
3329     $user->id = $USER->id;
3331     // Make sure all users that logged in have some firstaccess.
3332     if ($USER->firstaccess == 0) {
3333         $USER->firstaccess = $user->firstaccess = $now;
3334     }
3336     // Store the previous current as lastlogin.
3337     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3339     $USER->currentlogin = $user->currentlogin = $now;
3341     // Function user_accesstime_log() may not update immediately, better do it here.
3342     $USER->lastaccess = $user->lastaccess = $now;
3343     $USER->lastip = $user->lastip = getremoteaddr();
3345     // Note: do not call user_update_user() here because this is part of the login process,
3346     //       the login event means that these fields were updated.
3347     $DB->update_record('user', $user);
3348     return true;
3351 /**
3352  * Determines if a user has completed setting up their account.
3353  *
3354  * The lax mode (with $strict = false) has been introduced for special cases
3355  * only where we want to skip certain checks intentionally. This is valid in
3356  * certain mnet or ajax scenarios when the user cannot / should not be
3357  * redirected to edit their profile. In most cases, you should perform the
3358  * strict check.
3359  *
3360  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3361  * @param bool $strict Be more strict and assert id and custom profile fields set, too
3362  * @return bool
3363  */
3364 function user_not_fully_set_up($user, $strict = true) {
3365     global $CFG;
3366     require_once($CFG->dirroot.'/user/profile/lib.php');
3368     if (isguestuser($user)) {
3369         return false;
3370     }
3372     if (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)) {
3373         return true;
3374     }
3376     if ($strict) {
3377         if (empty($user->id)) {
3378             // Strict mode can be used with existing accounts only.
3379             return true;
3380         }
3381         if (!profile_has_required_custom_fields_set($user->id)) {
3382             return true;
3383         }
3384     }
3386     return false;
3389 /**
3390  * Check whether the user has exceeded the bounce threshold
3391  *
3392  * @param stdClass $user A {@link $USER} object
3393  * @return bool true => User has exceeded bounce threshold
3394  */
3395 function over_bounce_threshold($user) {
3396     global $CFG, $DB;
3398     if (empty($CFG->handlebounces)) {
3399         return false;
3400     }
3402     if (empty($user->id)) {
3403         // No real (DB) user, nothing to do here.
3404         return false;
3405     }
3407     // Set sensible defaults.
3408     if (empty($CFG->minbounces)) {
3409         $CFG->minbounces = 10;
3410     }
3411     if (empty($CFG->bounceratio)) {
3412         $CFG->bounceratio = .20;
3413     }
3414     $bouncecount = 0;
3415     $sendcount = 0;
3416     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3417         $bouncecount = $bounce->value;
3418     }
3419     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3420         $sendcount = $send->value;
3421     }
3422     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3425 /**
3426  * Used to increment or reset email sent count
3427  *
3428  * @param stdClass $user object containing an id
3429  * @param bool $reset will reset the count to 0
3430  * @return void
3431  */
3432 function set_send_count($user, $reset=false) {
3433     global $DB;
3435     if (empty($user->id)) {
3436         // No real (DB) user, nothing to do here.
3437         return;
3438     }
3440     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3441         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3442         $DB->update_record('user_preferences', $pref);
3443     } else if (!empty($reset)) {
3444         // If it's not there and we're resetting, don't bother. Make a new one.
3445         $pref = new stdClass();
3446         $pref->name   = 'email_send_count';
3447         $pref->value  = 1;
3448         $pref->userid = $user->id;
3449         $DB->insert_record('user_preferences', $pref, false);
3450     }
3453 /**
3454  * Increment or reset user's email bounce count
3455  *
3456  * @param stdClass $user object containing an id
3457  * @param bool $reset will reset the count to 0
3458  */
3459 function set_bounce_count($user, $reset=false) {
3460     global $DB;
3462     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3463         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3464         $DB->update_record('user_preferences', $pref);
3465     } else if (!empty($reset)) {
3466         // If it's not there and we're resetting, don't bother. Make a new one.
3467         $pref = new stdClass();
3468         $pref->name   = 'email_bounce_count';
3469         $pref->value  = 1;
3470         $pref->userid = $user->id;
3471         $DB->insert_record('user_preferences', $pref, false);
3472     }
3475 /**
3476  * Determines if the logged in user is currently moving an activity
3477  *
3478  * @param int $courseid The id of the course being tested
3479  * @return bool
3480  */
3481 function ismoving($courseid) {
3482     global $USER;
3484     if (!empty($USER->activitycopy)) {
3485         return ($USER->activitycopycourse == $courseid);
3486     }
3487     return false;
3490 /**
3491  * Returns a persons full name
3492  *
3493  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3494  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3495  * specify one.
3496  *
3497  * @param stdClass $user A {@link $USER} object to get full name of.
3498  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3499  * @return string
3500  */
3501 function fullname($user, $override=false) {
3502     global $CFG, $SESSION;
3504     if (!isset($user->firstname) and !isset($user->lastname)) {
3505         return '';
3506     }
3508     // Get all of the name fields.
3509     $allnames = get_all_user_name_fields();
3510     if ($CFG->debugdeveloper) {
3511         foreach ($allnames as $allname) {
3512             if (!property_exists($user, $allname)) {
3513                 // If all the user name fields are not set in the user object, then notify the programmer that it needs to be fixed.
3514                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3515                 // Message has been sent, no point in sending the message multiple times.
3516                 break;
3517             }
3518         }
3519     }
3521     if (!$override) {
3522         if (!empty($CFG->forcefirstname)) {
3523             $user->firstname = $CFG->forcefirstname;
3524         }
3525         if (!empty($CFG->forcelastname)) {
3526             $user->lastname = $CFG->forcelastname;
3527         }
3528     }
3530     if (!empty($SESSION->fullnamedisplay)) {
3531         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3532     }
3534     $template = null;
3535     // If the fullnamedisplay setting is available, set the template to that.
3536     if (isset($CFG->fullnamedisplay)) {
3537         $template = $CFG->fullnamedisplay;
3538     }
3539     // If the template is empty, or set to language, return the language string.
3540     if ((empty($template) || $template == 'language') && !$override) {
3541         return get_string('fullnamedisplay', null, $user);
3542     }
3544     // Check to see if we are displaying according to the alternative full name format.
3545     if ($override) {
3546         if (empty($CFG->alternativefullnameformat) || $CFG->alternativefullnameformat == 'language') {
3547             // Default to show just the user names according to the fullnamedisplay string.
3548             return get_string('fullnamedisplay', null, $user);
3549         } else {
3550             // If the override is true, then change the template to use the complete name.
3551             $template = $CFG->alternativefullnameformat;
3552         }
3553     }
3555     $requirednames = array();
3556     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3557     foreach ($allnames as $allname) {
3558         if (strpos($template, $allname) !== false) {
3559             $requirednames[] = $allname;
3560         }
3561     }
3563     $displayname = $template;
3564     // Switch in the actual data into the template.
3565     foreach ($requirednames as $altname) {
3566         if (isset($user->$altname)) {
3567             // Using empty() on the below if statement causes breakages.
3568             if ((string)$user->$altname == '') {
3569                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3570             } else {
3571                 $displayname = str_replace($altname, $user->$altname, $displayname);
3572             }
3573         } else {
3574             $displayname = str_replace($altname, 'EMPTY', $displayname);
3575         }
3576     }
3577     // Tidy up any misc. characters (Not perfect, but gets most characters).
3578     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3579     // katakana and parenthesis.
3580     $patterns = array();
3581     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3582     // filled in by a user.
3583     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3584     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3585     // This regular expression is to remove any double spaces in the display name.
3586     $patterns[] = '/\s{2,}/u';
3587     foreach ($patterns as $pattern) {
3588         $displayname = preg_replace($pattern, ' ', $displayname);
3589     }
3591     // Trimming $displayname will help the next check to ensure that we don't have a display name with spaces.
3592     $displayname = trim($displayname);
3593     if (empty($displayname)) {
3594         // Going with just the first name if no alternate fields are filled out. May be changed later depending on what
3595         // people in general feel is a good setting to fall back on.
3596         $displayname = $user->firstname;
3597     }
3598     return $displayname;
3601 /**
3602  * A centralised location for the all name fields. Returns an array / sql string snippet.
3603  *
3604  * @param bool $returnsql True for an sql select field snippet.
3605  * @param string $tableprefix table query prefix to use in front of each field.
3606  * @param string $prefix prefix added to the name fields e.g. authorfirstname.
3607  * @param string $fieldprefix sql field prefix e.g. id AS userid.
3608  * @param bool $order moves firstname and lastname to the top of the array / start of the string.
3609  * @return array|string All name fields.
3610  */
3611 function get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) {
3612     // This array is provided in this order because when called by fullname() (above) if firstname is before
3613     // firstnamephonetic str_replace() will change the wrong placeholder.
3614     $alternatenames = array('firstnamephonetic' => 'firstnamephonetic',
3615                             'lastnamephonetic' => 'lastnamephonetic',
3616                             'middlename' => 'middlename',
3617                             'alternatename' => 'alternatename',
3618                             'firstname' => 'firstname',
3619                             'lastname' => 'lastname');
3621     // Let's add a prefix to the array of user name fields if provided.
3622     if ($prefix) {
3623         foreach ($alternatenames as $key => $altname) {
3624             $alternatenames[$key] = $prefix . $altname;
3625         }
3626     }
3628     // If we want the end result to have firstname and lastname at the front / top of the result.
3629     if ($order) {
3630         // Move the last two elements (firstname, lastname) off the array and put them at the top.
3631         for ($i = 0; $i < 2; $i++) {
3632             // Get the last element.
3633             $lastelement = end($alternatenames);
3634             // Remove it from the array.
3635             unset($alternatenames[$lastelement]);
3636             // Put the element back on the top of the array.
3637             $alternatenames = array_merge(array($lastelement => $lastelement), $alternatenames);
3638         }
3639     }
3641     // Create an sql field snippet if requested.
3642     if ($returnsql) {
3643         if ($tableprefix) {
3644             if ($fieldprefix) {
3645                 foreach ($alternatenames as $key => $altname) {
3646                     $alternatenames[$key] = $tableprefix . '.' . $altname . ' AS ' . $fieldprefix . $altname;
3647                 }
3648             } else {
3649                 foreach ($alternatenames as $key => $altname) {
3650                     $alternatenames[$key] = $tableprefix . '.' . $altname;
3651                 }
3652             }
3653         }
3654         $alternatenames = implode(',', $alternatenames);
3655     }
3656     return $alternatenames;
3659 /**
3660  * Reduces lines of duplicated code for getting user name fields.
3661  *
3662  * See also {@link user_picture::unalias()}
3663  *
3664  * @param object $addtoobject Object to add user name fields to.
3665  * @param object $secondobject Object that contains user name field information.
3666  * @param string $prefix prefix to be added to all fields (including $additionalfields) e.g. authorfirstname.
3667  * @param array $additionalfields Additional fields to be matched with data in the second object.
3668  * The key can be set to the user table field name.
3669  * @return object User name fields.
3670  */
3671 function username_load_fields_from_object($addtoobject, $secondobject, $prefix = null, $additionalfields = null) {
3672     $fields = get_all_user_name_fields(false, null, $prefix);
3673     if ($additionalfields) {
3674         // Additional fields can specify their own 'alias' such as 'id' => 'userid'. This checks to see if
3675         // the key is a number and then sets the key to the array value.
3676         foreach ($additionalfields as $key => $value) {
3677             if (is_numeric($key)) {
3678                 $additionalfields[$value] = $prefix . $value;
3679                 unset($additionalfields[$key]);
3680             } else {
3681                 $additionalfields[$key] = $prefix . $value;
3682             }
3683         }
3684         $fields = array_merge($fields, $additionalfields);
3685     }
3686     foreach ($fields as $key => $field) {
3687         // Important that we have all of the user name fields present in the object that we are sending back.
3688         $addtoobject->$key = '';
3689         if (isset($secondobject->$field)) {
3690             $addtoobject->$key = $secondobject->$field;
3691         }
3692     }
3693     return $addtoobject;
3696 /**
3697  * Returns an array of values in order of occurance in a provided string.
3698  * The key in the result is the character postion in the string.
3699  *
3700  * @param array $values Values to be found in the string format
3701  * @param string $stringformat The string which may contain values being searched for.
3702  * @return array An array of values in order according to placement in the string format.
3703  */
3704 function order_in_string($values, $stringformat) {
3705     $valuearray = array();
3706     foreach ($values as $value) {
3707         $pattern = "/$value\b/";
3708         // Using preg_match as strpos() may match values that are similar e.g. firstname and firstnamephonetic.
3709         if (preg_match($pattern, $stringformat)) {
3710             $replacement = "thing";
3711             // Replace the value with something more unique to ensure we get the right position when using strpos().
3712             $newformat = preg_replace($pattern, $replacement, $stringformat);
3713             $position = strpos($newformat, $replacement);
3714             $valuearray[$position] = $value;
3715         }
3716     }
3717     ksort($valuearray);
3718     return $valuearray;
3721 /**
3722  * Checks if current user is shown any extra fields when listing users.
3723  *
3724  * @param object $context Context
3725  * @param array $already Array of fields that we're going to show anyway
3726  *   so don't bother listing them
3727  * @return array Array of field names from user table, not including anything
3728  *   listed in $already
3729  */
3730 function get_extra_user_fields($context, $already = array()) {
3731     global $CFG;
3733     // Only users with permission get the extra fields.
3734     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3735         return array();
3736     }
3738     // Split showuseridentity on comma (filter needed in case the showuseridentity is empty).
3739     $extra = array_filter(explode(',', $CFG->showuseridentity));
3741     foreach ($extra as $key => $field) {
3742         if (in_array($field, $already)) {
3743             unset($extra[$key]);
3744         }
3745     }
3747     // If the identity fields are also among hidden fields, make sure the user can see them.
3748     $hiddenfields = array_filter(explode(',', $CFG->hiddenuserfields));
3749     $hiddenidentifiers = array_intersect($extra, $hiddenfields);
3751     if ($hiddenidentifiers) {
3752         if ($context->get_course_context(false)) {
3753             // We are somewhere inside a course.
3754             $canviewhiddenuserfields = has_capability('moodle/course:viewhiddenuserfields', $context);
3756         } else {
3757             // We are not inside a course.
3758             $canviewhiddenuserfields = has_capability('moodle/user:viewhiddendetails', $context);
3759         }
3761         if (!$canviewhiddenuserfields) {
3762             // Remove hidden identifiers from the list.
3763             $extra = array_diff($extra, $hiddenidentifiers);
3764         }
3765     }
3767     // Re-index the entries.
3768     $extra = array_values($extra);
3770     return $extra;
3773 /**
3774  * If the current user is to be shown extra user fields when listing or
3775  * selecting users, returns a string suitable for including in an SQL select
3776  * clause to retrieve those fields.
3777  *
3778  * @param context $context Context
3779  * @param string $alias Alias of user table, e.g. 'u' (default none)
3780  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3781  * @param array $already Array of fields that we're going to include anyway so don't list them (default none)
3782  * @return string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank
3783  */
3784 function get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array()) {
3785     $fields = get_extra_user_fields($context, $already);
3786     $result = '';
3787     // Add punctuation for alias.
3788     if ($alias !== '') {
3789         $alias .= '.';
3790     }
3791     foreach ($fields as $field) {
3792         $result .= ', ' . $alias . $field;
3793         if ($prefix) {
3794             $result .= ' AS ' . $prefix . $field;
3795         }
3796     }
3797     return $result;
3800 /**
3801  * Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.
3802  * @param string $field Field name, e.g. 'phone1'
3803  * @return string Text description taken from language file, e.g. 'Phone number'
3804  */
3805 function get_user_field_name($field) {
3806     // Some fields have language strings which are not the same as field name.
3807     switch ($field) {
3808         case 'url' : {
3809             return get_string('webpage');
3810         }
3811         case 'icq' : {
3812             return get_string('icqnumber');
3813         }
3814         case 'skype' : {
3815             return get_string('skypeid');
3816         }
3817         case 'aim' : {
3818             return get_string('aimid');
3819         }
3820         case 'yahoo' : {
3821             return get_string('yahooid');
3822         }
3823         case 'msn' : {
3824             return get_string('msnid');
3825         }
3826         case 'picture' : {
3827             return get_string('pictureofuser');
3828         }
3829     }
3830     // Otherwise just use the same lang string.
3831     return get_string($field);
3834 /**
3835  * Returns whether a given authentication plugin exists.
3836  *
3837  * @param string $auth Form of authentication to check for. Defaults to the global setting in {@link $CFG}.
3838  * @return boolean Whether the plugin is available.
3839  */
3840 function exists_auth_plugin($auth) {
3841     global $CFG;
3843     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3844         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3845     }
3846     return false;
3849 /**
3850  * Checks if a given plugin is in the list of enabled authentication plugins.
3851  *
3852  * @param string $auth Authentication plugin.
3853  * @return boolean Whether the plugin is enabled.
3854  */
3855 function is_enabled_auth($auth) {
3856     if (empty($auth)) {
3857         return false;
3858     }
3860     $enabled = get_enabled_auth_plugins();
3862     return in_array($auth, $enabled);
3865 /**
3866  * Returns an authentication plugin instance.
3867  *
3868  * @param string $auth name of authentication plugin
3869  * @return auth_plugin_base An instance of the required authentication plugin.
3870  */
3871 function get_auth_plugin($auth) {
3872     global $CFG;
3874     // Check the plugin exists first.
3875     if (! exists_auth_plugin($auth)) {
3876         print_error('authpluginnotfound', 'debug', '', $auth);
3877     }
3879     // Return auth plugin instance.
3880     require_once("{$CFG->dirroot}/auth/$auth/auth.php");
3881     $class = "auth_plugin_$auth";
3882     return new $class;
3885 /**
3886  * Returns array of active auth plugins.
3887  *
3888  * @param bool $fix fix $CFG->auth if needed
3889  * @return array
3890  */
3891 function get_enabled_auth_plugins($fix=false) {
3892     global $CFG;
3894     $default = array('manual', 'nologin');
3896     if (empty($CFG->auth)) {
3897         $auths = array();
3898     } else {
3899         $auths = explode(',', $CFG->auth);
3900     }
3902     if ($fix) {
3903         $auths = array_unique($auths);
3904         foreach ($auths as $k => $authname) {
3905             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3906                 unset($auths[$k]);
3907             }
3908         }
3909         $newconfig = implode(',', $auths);
3910         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3911             set_config('auth', $newconfig);
3912         }
3913     }
3915     return (array_merge($default, $auths));
3918 /**
3919  * Returns true if an internal authentication method is being used.
3920  * if method not specified then, global default is assumed
3921  *
3922  * @param string $auth Form of authentication required
3923  * @return bool
3924  */
3925 function is_internal_auth($auth) {
3926     // Throws error if bad $auth.
3927     $authplugin = get_auth_plugin($auth);
3928     return $authplugin->is_internal();
3931 /**
3932  * Returns true if the user is a 'restored' one.
3933  *
3934  * Used in the login process to inform the user and allow him/her to reset the password
3935  *
3936  * @param string $username username to be checked
3937  * @return bool
3938  */
3939 function is_restored_user($username) {
3940     global $CFG, $DB;
3942     return $DB->record_exists('user', array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id, 'password' => 'restored'));
3945 /**
3946  * Returns an array of user fields
3947  *
3948  * @return array User field/column names
3949  */
3950 function get_user_fieldnames() {
3951     global $DB;
3953     $fieldarray = $DB->get_columns('user');
3954     unset($fieldarray['id']);
3955     $fieldarray = array_keys($fieldarray);
3957     return $fieldarray;
3960 /**
3961  * Creates a bare-bones user record
3962  *
3963  * @todo Outline auth types and provide code example
3964  *
3965  * @param string $username New user's username to add to record
3966  * @param string $password New user's password to add to record
3967  * @param string $auth Form of authentication required
3968  * @return stdClass A complete user object
3969  */
3970 function create_user_record($username, $password, $auth = 'manual') {
3971     global $CFG, $DB;
3972     require_once($CFG->dirroot.'/user/profile/lib.php');
3973     require_once($CFG->dirroot.'/user/lib.php');
3975     // Just in case check text case.
3976     $username = trim(core_text::strtolower($username));
3978     $authplugin = get_auth_plugin($auth);
3979     $customfields = $authplugin->get_custom_user_profile_fields();
3980     $newuser = new stdClass();
3981     if ($newinfo = $authplugin->get_userinfo($username)) {
3982         $newinfo = truncate_userinfo($newinfo);
3983         foreach ($newinfo as $key => $value) {
3984             if (in_array($key, $authplugin->userfields) || (in_array($key, $customfields))) {
3985                 $newuser->$key = $value;
3986             }
3987         }
3988     }
3990     if (!empty($newuser->email)) {
3991         if (email_is_not_allowed($newuser->email)) {
3992             unset($newuser->email);
3993         }
3994     }
3996     if (!isset($newuser->city)) {
3997         $newuser->city = '';
3998     }
4000     $newuser->auth = $auth;
4001     $newuser->username = $username;
4003     // Fix for MDL-8480
4004     // user CFG lang for user if $newuser->lang is empty
4005     // or $user->lang is not an installed language.
4006     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
4007         $newuser->lang = $CFG->lang;
4008     }
4009     $newuser->confirmed = 1;
4010     $newuser->lastip = getremoteaddr();
4011     $newuser->timecreated = time();
4012     $newuser->timemodified = $newuser->timecreated;
4013     $newuser->mnethostid = $CFG->mnet_localhost_id;
4015     $newuser->id = user_create_user($newuser, false, false);
4017     // Save user profile data.
4018     profile_save_data($newuser);
4020     $user = get_complete_user_data('id', $newuser->id);
4021     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})) {
4022         set_user_preference('auth_forcepasswordchange', 1, $user);
4023     }
4024     // Set the password.
4025     update_internal_user_password($user, $password);
4027     // Trigger event.
4028     \core\event\user_created::create_from_userid($newuser->id)->trigger();
4030     return $user;
4033 /**
4034  * Will update a local user record from an external source (MNET users can not be updated using this method!).
4035  *
4036  * @param string $username user's username to update the record
4037  * @return stdClass A complete user object
4038  */
4039 function update_user_record($username) {
4040     global $DB, $CFG;
4041     // Just in case check text case.
4042     $username = trim(core_text::strtolower($username));
4044     $oldinfo = $DB->get_record('user', array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id), '*', MUST_EXIST);
4045     return update_user_record_by_id($oldinfo->id);
4048 /**
4049  * Will update a local user record from an external source (MNET users can not be updated using this method!).
4050  *
4051  * @param int $id user id
4052  * @return stdClass A complete user object
4053  */
4054 function update_user_record_by_id($id) {
4055     global $DB, $CFG;
4056     require_once($CFG->dirroot."/user/profile/lib.php");
4057     require_once($CFG->dirroot.'/user/lib.php');
4059     $params = array('mnethostid' => $CFG->mnet_localhost_id, 'id' => $id, 'deleted' => 0);
4060     $oldinfo = $DB->get_record('user', $params, '*', MUST_EXIST);
4062     $newuser = array();
4063     $userauth = get_auth_plugin($oldinfo->auth);
4065     if ($newinfo = $userauth->get_userinfo($oldinfo->username)) {
4066         $newinfo = truncate_userinfo($newinfo);
4067         $customfields = $userauth->get_custom_user_profile_fields();
4069         foreach ($newinfo as $key => $value) {
4070             $iscustom = in_array($key, $customfields);
4071             if (!$iscustom) {
4072                 $key = strtolower($key);
4073             }
4074             if ((!property_exists($oldinfo, $key) && !$iscustom) or $key === 'username' or $key === 'id'
4075                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
4076                 // Unknown or must not be changed.
4077                 continue;
4078             }
4079             if (empty($userauth->config->{'field_updatelocal_' . $key}) || empty($userauth->config->{'field_lock_' . $key})) {
4080                 continue;
4081             }
4082             $confval = $userauth->config->{'field_updatelocal_' . $key};
4083             $lockval = $userauth->config->{'field_lock_' . $key};
4084             if ($confval === 'onlogin') {
4085                 // MDL-4207 Don't overwrite modified user profile values with
4086                 // empty LDAP values when 'unlocked if empty' is set. The purpose
4087                 // of the setting 'unlocked if empty' is to allow the user to fill
4088                 // in a value for the selected field _if LDAP is giving
4089                 // nothing_ for this field. Thus it makes sense to let this value
4090                 // stand in until LDAP is giving a value for this field.
4091                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
4092                     if ($iscustom || (in_array($key, $userauth->userfields) &&
4093                             ((string)$oldinfo->$key !== (string)$value))) {
4094                         $newuser[$key] = (string)$value;
4095                     }
4096                 }
4097             }
4098         }
4099         if ($newuser) {
4100             $newuser['id'] = $oldinfo->id;
4101             $newuser['timemodified'] = time();
4102             user_update_user((object) $newuser, false, false);
4104             // Save user profile data.
4105             profile_save_data((object) $newuser);
4107             // Trigger event.
4108             \core\event\user_updated::create_from_userid($newuser['id'])->trigger();
4109         }
4110     }
4112     return get_complete_user_data('id', $oldinfo->id);
4115 /**
4116  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth) which may have large fields.
4117  *
4118  * @param array $info Array of user properties to truncate if needed
4119  * @return array The now truncated information that was passed in
4120  */
4121 function truncate_userinfo(array $info) {
4122     // Define the limits.
4123     $limit = array(
4124         'username'    => 100,
4125         'idnumber'    => 255,
4126         'firstname'   => 100,
4127         'lastname'    => 100,
4128         'email'       => 100,
4129         'icq'         =>  15,
4130         'phone1'      =>  20,
4131         'phone2'      =>  20,
4132         'institution' => 255,
4133         'department'  => 255,
4134         'address'     => 255,
4135         'city'        => 120,
4136         'country'     =>   2,
4137         'url'         => 255,
4138     );
4140     // Apply where needed.
4141     foreach (array_keys($info) as $key) {
4142         if (!empty($limit[$key])) {
4143             $info[$key] = trim(core_text::substr($info[$key], 0, $limit[$key]));
4144         }
4145     }
4147     return $info;
4150 /**
4151  * Marks user deleted in internal user database and notifies the auth plugin.
4152  * Also unenrols user from all roles and does other cleanup.
4153  *
4154  * Any plugin that needs to purge user data should register the 'user_deleted' event.
4155  *
4156  * @param stdClass $user full user object before delete
4157  * @return boolean success
4158  * @throws coding_exception if invalid $user parameter detected
4159  */
4160 function delete_user(stdClass $user) {
4161     global $CFG, $DB, $SESSION;
4162     require_once($CFG->libdir.'/grouplib.php');
4163     require_once($CFG->libdir.'/gradelib.php');
4164     require_once($CFG->dirroot.'/message/lib.php');
4165     require_once($CFG->dirroot.'/user/lib.php');
4167     // Make sure nobody sends bogus record type as parameter.
4168     if (!property_exists($user, 'id') or !property_exists($user, 'username')) {
4169         throw new coding_exception('Invalid $user parameter in delete_user() detected');
4170     }
4172     // Better not trust the parameter and fetch the latest info this will be very expensive anyway.
4173     if (!$user = $DB->get_record('user', array('id' => $user->id))) {
4174         debugging('Attempt to delete unknown user account.');
4175         return false;
4176     }
4178     // There must be always exactly one guest record, originally the guest account was identified by username only,
4179     // now we use $CFG->siteguest for performance reasons.
4180     if ($user->username === 'guest' or isguestuser($user)) {
4181         debugging('Guest user account can not be deleted.');
4182         return false;
4183     }
4185     // Admin can be theoretically from different auth plugin, but we want to prevent deletion of internal accoutns only,
4186     // if anything goes wrong ppl may force somebody to be admin via config.php setting $CFG->siteadmins.
4187     if ($user->auth === 'manual' and is_siteadmin($user)) {
4188         debugging('Local administrator accounts can not be deleted.');
4189         return false;
4190     }
4192     // Allow plugins to use this user object before we completely delete it.
4193     if ($pluginsfunction = get_plugins_with_function('pre_user_delete')) {
4194         foreach ($pluginsfunction as $plugintype => $plugins) {
4195             foreach ($plugins as $pluginfunction) {
4196                 $pluginfunction($user);
4197             }
4198         }
4199     }
4201     // Keep user record before updating it, as we have to pass this to user_deleted event.
4202     $olduser = clone $user;
4204     // Keep a copy of user context, we need it for event.
4205     $usercontext = context_user::instance($user->id);
4207     // Delete all grades - backup is kept in grade_grades_history table.
4208     grade_user_delete($user->id);
4210     // TODO: remove from cohorts using standard API here.
4212     // Remove user tags.
4213     core_tag_tag::remove_all_item_tags('core', 'user', $user->id);
4215     // Unconditionally unenrol from all courses.
4216     enrol_user_delete($user);
4218     // Unenrol from all roles in all contexts.
4219     // This might be slow but it is really needed - modules might do some extra cleanup!
4220     role_unassign_all(array('userid' => $user->id));
4222     // Now do a brute force cleanup.
4224     // Remove from all cohorts.
4225     $DB->delete_records('cohort_members', array('userid' => $user->id));
4227     // Remove from all groups.
4228     $DB->delete_records('groups_members', array('userid' => $user->id));
4230     // Brute force unenrol from all courses.
4231     $DB->delete_records('user_enrolments', array('userid' => $user->id));
4233     // Purge user preferences.
4234     $DB->delete_records('user_preferences', array('userid' => $user->id));
4236     // Purge user extra profile info.
4237     $DB->delete_records('user_info_data', array('userid' => $user->id));
4239     // Purge log of previous password hashes.
4240     $DB->delete_records('user_password_history', array('userid' => $user->id));
4242     // Last course access not necessary either.
4243     $DB->delete_records('user_lastaccess', array('userid' => $user->id));
4244     // Remove all user tokens.
4245     $DB->delete_records('external_tokens', array('userid' => $user->id));
4247     // Unauthorise the user for all services.
4248     $DB->delete_records('external_services_users', array('userid' => $user->id));
4250     // Remove users private keys.
4251     $DB->delete_records('user_private_key', array('userid' => $user->id));
4253     // Remove users customised pages.
4254     $DB->delete_records('my_pages', array('userid' => $user->id, 'private' => 1));
4256     // Delete user from $SESSION->bulk_users.
4257     if (isset($SESSION->bulk_users[$user->id])) {
4258         unset($SESSION->bulk_users[$user->id]);
4259     }
4261     // Force logout - may fail if file based sessions used, sorry.
4262     \core\session\manager::kill_user_sessions($user->id);
4264     // Generate username from email address, or a fake email.
4265     $delemail = !empty($user->email) ? $user->email : $user->username . '.' . $user->id . '@unknownemail.invalid';
4266     $delname = clean_param($delemail . "." . time(), PARAM_USERNAME);
4268     // Workaround for bulk deletes of users with the same email address.
4269     while ($DB->record_exists('user', array('username' => $delname))) { // No need to use mnethostid here.
4270         $delname++;
4271     }
4273     // Mark internal user record as "deleted".
4274     $updateuser = new stdClass();
4275     $updateuser->id           = $user->id;
4276     $updateuser->deleted      = 1;
4277     $updateuser->username     = $delname;            // Remember it just in case.
4278     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users.
4279     $updateuser->idnumber     = '';                  // Clear this field to free it up.
4280     $updateuser->picture      = 0;
4281     $updateuser->timemodified = time();
4283     // Don't trigger update event, as user is being deleted.
4284     user_update_user($updateuser, false, false);
4286     // Delete all content associated with the user context, but not the context itself.
4287     $usercontext->delete_content();
4289     // Any plugin that needs to cleanup should register this event.
4290     // Trigger event.
4291     $event = \core\event\user_deleted::create(
4292             array(
4293                 'objectid' => $user->id,
4294                 'relateduserid' => $user->id,
4295                 'context' => $usercontext,
4296                 'other' => array(
4297                     'username' => $user->username,
4298                     'email' => $user->email,
4299                     'idnumber' => $user->idnumber,
4300                     'picture' => $user->picture,
4301                     'mnethostid' => $user->mnethostid
4302                     )
4303                 )
4304             );
4305     $event->add_record_snapshot('user', $olduser);
4306     $event->trigger();
4308     // We will update the user's timemodified, as it will be passed to the user_deleted event, which
4309     // should know about this updated property persisted to the user's table.
4310     $user->timemodified = $updateuser->timemodified;
4312     // Notify auth plugin - do not block the delete even when plugin fails.
4313     $authplugin = get_auth_plugin($user->auth);
4314     $authplugin->user_delete($user);
4316     return true;
4319 /**
4320  *&