04b0022b4dbb8488a6da06f71971cb019f2ed06e
[moodle.git] / lib / moodlelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * moodlelib.php - Moodle main library
19  *
20  * Main library file of miscellaneous general-purpose Moodle functions.
21  * Other main libraries:
22  *  - weblib.php      - functions that produce web output
23  *  - datalib.php     - functions that access the database
24  *
25  * @package    core
26  * @subpackage lib
27  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 defined('MOODLE_INTERNAL') || die();
33 // CONSTANTS (Encased in phpdoc proper comments).
35 // Date and time constants.
36 /**
37  * Time constant - the number of seconds in a year
38  */
39 define('YEARSECS', 31536000);
41 /**
42  * Time constant - the number of seconds in a week
43  */
44 define('WEEKSECS', 604800);
46 /**
47  * Time constant - the number of seconds in a day
48  */
49 define('DAYSECS', 86400);
51 /**
52  * Time constant - the number of seconds in an hour
53  */
54 define('HOURSECS', 3600);
56 /**
57  * Time constant - the number of seconds in a minute
58  */
59 define('MINSECS', 60);
61 /**
62  * Time constant - the number of minutes in a day
63  */
64 define('DAYMINS', 1440);
66 /**
67  * Time constant - the number of minutes in an hour
68  */
69 define('HOURMINS', 60);
71 // Parameter constants - every call to optional_param(), required_param()
72 // or clean_param() should have a specified type of parameter.
74 /**
75  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
76  */
77 define('PARAM_ALPHA',    'alpha');
79 /**
80  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
81  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
82  */
83 define('PARAM_ALPHAEXT', 'alphaext');
85 /**
86  * PARAM_ALPHANUM - expected numbers and letters only.
87  */
88 define('PARAM_ALPHANUM', 'alphanum');
90 /**
91  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
92  */
93 define('PARAM_ALPHANUMEXT', 'alphanumext');
95 /**
96  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
97  */
98 define('PARAM_AUTH',  'auth');
100 /**
101  * PARAM_BASE64 - Base 64 encoded format
102  */
103 define('PARAM_BASE64',   'base64');
105 /**
106  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
107  */
108 define('PARAM_BOOL',     'bool');
110 /**
111  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
112  * checked against the list of capabilities in the database.
113  */
114 define('PARAM_CAPABILITY',   'capability');
116 /**
117  * PARAM_CLEANHTML - cleans submitted HTML code. Note that you almost never want
118  * to use this. The normal mode of operation is to use PARAM_RAW when receiving
119  * the input (required/optional_param or formslib) and then sanitise the HTML
120  * using format_text on output. This is for the rare cases when you want to
121  * sanitise the HTML on input. This cleaning may also fix xhtml strictness.
122  */
123 define('PARAM_CLEANHTML', 'cleanhtml');
125 /**
126  * PARAM_EMAIL - an email address following the RFC
127  */
128 define('PARAM_EMAIL',   'email');
130 /**
131  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
132  */
133 define('PARAM_FILE',   'file');
135 /**
136  * PARAM_FLOAT - a real/floating point number.
137  *
138  * Note that you should not use PARAM_FLOAT for numbers typed in by the user.
139  * It does not work for languages that use , as a decimal separator.
140  * Instead, do something like
141  *     $rawvalue = required_param('name', PARAM_RAW);
142  *     // ... other code including require_login, which sets current lang ...
143  *     $realvalue = unformat_float($rawvalue);
144  *     // ... then use $realvalue
145  */
146 define('PARAM_FLOAT',  'float');
148 /**
149  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
150  */
151 define('PARAM_HOST',     'host');
153 /**
154  * PARAM_INT - integers only, use when expecting only numbers.
155  */
156 define('PARAM_INT',      'int');
158 /**
159  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
160  */
161 define('PARAM_LANG',  'lang');
163 /**
164  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the
165  * others! Implies PARAM_URL!)
166  */
167 define('PARAM_LOCALURL', 'localurl');
169 /**
170  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
171  */
172 define('PARAM_NOTAGS',   'notags');
174 /**
175  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory
176  * traversals note: the leading slash is not removed, window drive letter is not allowed
177  */
178 define('PARAM_PATH',     'path');
180 /**
181  * PARAM_PEM - Privacy Enhanced Mail format
182  */
183 define('PARAM_PEM',      'pem');
185 /**
186  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
187  */
188 define('PARAM_PERMISSION',   'permission');
190 /**
191  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
192  */
193 define('PARAM_RAW', 'raw');
195 /**
196  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
197  */
198 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
200 /**
201  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
202  */
203 define('PARAM_SAFEDIR',  'safedir');
205 /**
206  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
207  */
208 define('PARAM_SAFEPATH',  'safepath');
210 /**
211  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
212  */
213 define('PARAM_SEQUENCE',  'sequence');
215 /**
216  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
217  */
218 define('PARAM_TAG',   'tag');
220 /**
221  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
222  */
223 define('PARAM_TAGLIST',   'taglist');
225 /**
226  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
227  */
228 define('PARAM_TEXT',  'text');
230 /**
231  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
232  */
233 define('PARAM_THEME',  'theme');
235 /**
236  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but
237  * http://localhost.localdomain/ is ok.
238  */
239 define('PARAM_URL',      'url');
241 /**
242  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user
243  * accounts, do NOT use when syncing with external systems!!
244  */
245 define('PARAM_USERNAME',    'username');
247 /**
248  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
249  */
250 define('PARAM_STRINGID',    'stringid');
252 // DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE.
253 /**
254  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
255  * It was one of the first types, that is why it is abused so much ;-)
256  * @deprecated since 2.0
257  */
258 define('PARAM_CLEAN',    'clean');
260 /**
261  * PARAM_INTEGER - deprecated alias for PARAM_INT
262  * @deprecated since 2.0
263  */
264 define('PARAM_INTEGER',  'int');
266 /**
267  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
268  * @deprecated since 2.0
269  */
270 define('PARAM_NUMBER',  'float');
272 /**
273  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
274  * NOTE: originally alias for PARAM_APLHA
275  * @deprecated since 2.0
276  */
277 define('PARAM_ACTION',   'alphanumext');
279 /**
280  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
281  * NOTE: originally alias for PARAM_APLHA
282  * @deprecated since 2.0
283  */
284 define('PARAM_FORMAT',   'alphanumext');
286 /**
287  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
288  * @deprecated since 2.0
289  */
290 define('PARAM_MULTILANG',  'text');
292 /**
293  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
294  * string separated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
295  * America/Port-au-Prince)
296  */
297 define('PARAM_TIMEZONE', 'timezone');
299 /**
300  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
301  */
302 define('PARAM_CLEANFILE', 'file');
304 /**
305  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
306  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
307  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
308  * NOTE: numbers and underscores are strongly discouraged in plugin names!
309  */
310 define('PARAM_COMPONENT', 'component');
312 /**
313  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
314  * It is usually used together with context id and component.
315  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
316  */
317 define('PARAM_AREA', 'area');
319 /**
320  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'paypal', 'completionstatus'.
321  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
322  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
323  */
324 define('PARAM_PLUGIN', 'plugin');
327 // Web Services.
329 /**
330  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
331  */
332 define('VALUE_REQUIRED', 1);
334 /**
335  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
336  */
337 define('VALUE_OPTIONAL', 2);
339 /**
340  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
341  */
342 define('VALUE_DEFAULT', 0);
344 /**
345  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
346  */
347 define('NULL_NOT_ALLOWED', false);
349 /**
350  * NULL_ALLOWED - the parameter can be set to null in the database
351  */
352 define('NULL_ALLOWED', true);
354 // Page types.
356 /**
357  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
358  */
359 define('PAGE_COURSE_VIEW', 'course-view');
361 /** Get remote addr constant */
362 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
363 /** Get remote addr constant */
364 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
366 // Blog access level constant declaration.
367 define ('BLOG_USER_LEVEL', 1);
368 define ('BLOG_GROUP_LEVEL', 2);
369 define ('BLOG_COURSE_LEVEL', 3);
370 define ('BLOG_SITE_LEVEL', 4);
371 define ('BLOG_GLOBAL_LEVEL', 5);
374 // Tag constants.
375 /**
376  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
377  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
378  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
379  *
380  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
381  */
382 define('TAG_MAX_LENGTH', 50);
384 // Password policy constants.
385 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
386 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
387 define ('PASSWORD_DIGITS', '0123456789');
388 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
390 // Feature constants.
391 // Used for plugin_supports() to report features that are, or are not, supported by a module.
393 /** True if module can provide a grade */
394 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
395 /** True if module supports outcomes */
396 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
397 /** True if module supports advanced grading methods */
398 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
399 /** True if module controls the grade visibility over the gradebook */
400 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
401 /** True if module supports plagiarism plugins */
402 define('FEATURE_PLAGIARISM', 'plagiarism');
404 /** True if module has code to track whether somebody viewed it */
405 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
406 /** True if module has custom completion rules */
407 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
409 /** True if module has no 'view' page (like label) */
410 define('FEATURE_NO_VIEW_LINK', 'viewlink');
411 /** True (which is default) if the module wants support for setting the ID number for grade calculation purposes. */
412 define('FEATURE_IDNUMBER', 'idnumber');
413 /** True if module supports groups */
414 define('FEATURE_GROUPS', 'groups');
415 /** True if module supports groupings */
416 define('FEATURE_GROUPINGS', 'groupings');
417 /**
418  * True if module supports groupmembersonly (which no longer exists)
419  * @deprecated Since Moodle 2.8
420  */
421 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
423 /** Type of module */
424 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
425 /** True if module supports intro editor */
426 define('FEATURE_MOD_INTRO', 'mod_intro');
427 /** True if module has default completion */
428 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
430 define('FEATURE_COMMENT', 'comment');
432 define('FEATURE_RATE', 'rate');
433 /** True if module supports backup/restore of moodle2 format */
434 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
436 /** True if module can show description on course main page */
437 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
439 /** True if module uses the question bank */
440 define('FEATURE_USES_QUESTIONS', 'usesquestions');
442 /**
443  * Maximum filename char size
444  */
445 define('MAX_FILENAME_SIZE', 100);
447 /** Unspecified module archetype */
448 define('MOD_ARCHETYPE_OTHER', 0);
449 /** Resource-like type module */
450 define('MOD_ARCHETYPE_RESOURCE', 1);
451 /** Assignment module archetype */
452 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
453 /** System (not user-addable) module archetype */
454 define('MOD_ARCHETYPE_SYSTEM', 3);
456 /**
457  * Return this from modname_get_types callback to use default display in activity chooser.
458  * Deprecated, will be removed in 3.5, TODO MDL-53697.
459  * @deprecated since Moodle 3.1
460  */
461 define('MOD_SUBTYPE_NO_CHILDREN', 'modsubtypenochildren');
463 /**
464  * Security token used for allowing access
465  * from external application such as web services.
466  * Scripts do not use any session, performance is relatively
467  * low because we need to load access info in each request.
468  * Scripts are executed in parallel.
469  */
470 define('EXTERNAL_TOKEN_PERMANENT', 0);
472 /**
473  * Security token used for allowing access
474  * of embedded applications, the code is executed in the
475  * active user session. Token is invalidated after user logs out.
476  * Scripts are executed serially - normal session locking is used.
477  */
478 define('EXTERNAL_TOKEN_EMBEDDED', 1);
480 /**
481  * The home page should be the site home
482  */
483 define('HOMEPAGE_SITE', 0);
484 /**
485  * The home page should be the users my page
486  */
487 define('HOMEPAGE_MY', 1);
488 /**
489  * The home page can be chosen by the user
490  */
491 define('HOMEPAGE_USER', 2);
493 /**
494  * Hub directory url (should be moodle.org)
495  */
496 define('HUB_HUBDIRECTORYURL', "https://hubdirectory.moodle.org");
499 /**
500  * Moodle.net url (should be moodle.net)
501  */
502 define('HUB_MOODLEORGHUBURL', "https://moodle.net");
503 define('HUB_OLDMOODLEORGHUBURL', "http://hub.moodle.org");
505 /**
506  * Moodle mobile app service name
507  */
508 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
510 /**
511  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
512  */
513 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
515 /**
516  * Course display settings: display all sections on one page.
517  */
518 define('COURSE_DISPLAY_SINGLEPAGE', 0);
519 /**
520  * Course display settings: split pages into a page per section.
521  */
522 define('COURSE_DISPLAY_MULTIPAGE', 1);
524 /**
525  * Authentication constant: String used in password field when password is not stored.
526  */
527 define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
529 /**
530  * Email from header to never include via information.
531  */
532 define('EMAIL_VIA_NEVER', 0);
534 /**
535  * Email from header to always include via information.
536  */
537 define('EMAIL_VIA_ALWAYS', 1);
539 /**
540  * Email from header to only include via information if the address is no-reply.
541  */
542 define('EMAIL_VIA_NO_REPLY_ONLY', 2);
544 // PARAMETER HANDLING.
546 /**
547  * Returns a particular value for the named variable, taken from
548  * POST or GET.  If the parameter doesn't exist then an error is
549  * thrown because we require this variable.
550  *
551  * This function should be used to initialise all required values
552  * in a script that are based on parameters.  Usually it will be
553  * used like this:
554  *    $id = required_param('id', PARAM_INT);
555  *
556  * Please note the $type parameter is now required and the value can not be array.
557  *
558  * @param string $parname the name of the page parameter we want
559  * @param string $type expected type of parameter
560  * @return mixed
561  * @throws coding_exception
562  */
563 function required_param($parname, $type) {
564     if (func_num_args() != 2 or empty($parname) or empty($type)) {
565         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
566     }
567     // POST has precedence.
568     if (isset($_POST[$parname])) {
569         $param = $_POST[$parname];
570     } else if (isset($_GET[$parname])) {
571         $param = $_GET[$parname];
572     } else {
573         print_error('missingparam', '', '', $parname);
574     }
576     if (is_array($param)) {
577         debugging('Invalid array parameter detected in required_param(): '.$parname);
578         // TODO: switch to fatal error in Moodle 2.3.
579         return required_param_array($parname, $type);
580     }
582     return clean_param($param, $type);
585 /**
586  * Returns a particular array value for the named variable, taken from
587  * POST or GET.  If the parameter doesn't exist then an error is
588  * thrown because we require this variable.
589  *
590  * This function should be used to initialise all required values
591  * in a script that are based on parameters.  Usually it will be
592  * used like this:
593  *    $ids = required_param_array('ids', PARAM_INT);
594  *
595  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
596  *
597  * @param string $parname the name of the page parameter we want
598  * @param string $type expected type of parameter
599  * @return array
600  * @throws coding_exception
601  */
602 function required_param_array($parname, $type) {
603     if (func_num_args() != 2 or empty($parname) or empty($type)) {
604         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
605     }
606     // POST has precedence.
607     if (isset($_POST[$parname])) {
608         $param = $_POST[$parname];
609     } else if (isset($_GET[$parname])) {
610         $param = $_GET[$parname];
611     } else {
612         print_error('missingparam', '', '', $parname);
613     }
614     if (!is_array($param)) {
615         print_error('missingparam', '', '', $parname);
616     }
618     $result = array();
619     foreach ($param as $key => $value) {
620         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
621             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
622             continue;
623         }
624         $result[$key] = clean_param($value, $type);
625     }
627     return $result;
630 /**
631  * Returns a particular value for the named variable, taken from
632  * POST or GET, otherwise returning a given default.
633  *
634  * This function should be used to initialise all optional values
635  * in a script that are based on parameters.  Usually it will be
636  * used like this:
637  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
638  *
639  * Please note the $type parameter is now required and the value can not be array.
640  *
641  * @param string $parname the name of the page parameter we want
642  * @param mixed  $default the default value to return if nothing is found
643  * @param string $type expected type of parameter
644  * @return mixed
645  * @throws coding_exception
646  */
647 function optional_param($parname, $default, $type) {
648     if (func_num_args() != 3 or empty($parname) or empty($type)) {
649         throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
650     }
652     // POST has precedence.
653     if (isset($_POST[$parname])) {
654         $param = $_POST[$parname];
655     } else if (isset($_GET[$parname])) {
656         $param = $_GET[$parname];
657     } else {
658         return $default;
659     }
661     if (is_array($param)) {
662         debugging('Invalid array parameter detected in required_param(): '.$parname);
663         // TODO: switch to $default in Moodle 2.3.
664         return optional_param_array($parname, $default, $type);
665     }
667     return clean_param($param, $type);
670 /**
671  * Returns a particular array value for the named variable, taken from
672  * POST or GET, otherwise returning a given default.
673  *
674  * This function should be used to initialise all optional values
675  * in a script that are based on parameters.  Usually it will be
676  * used like this:
677  *    $ids = optional_param('id', array(), PARAM_INT);
678  *
679  * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
680  *
681  * @param string $parname the name of the page parameter we want
682  * @param mixed $default the default value to return if nothing is found
683  * @param string $type expected type of parameter
684  * @return array
685  * @throws coding_exception
686  */
687 function optional_param_array($parname, $default, $type) {
688     if (func_num_args() != 3 or empty($parname) or empty($type)) {
689         throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
690     }
692     // POST has precedence.
693     if (isset($_POST[$parname])) {
694         $param = $_POST[$parname];
695     } else if (isset($_GET[$parname])) {
696         $param = $_GET[$parname];
697     } else {
698         return $default;
699     }
700     if (!is_array($param)) {
701         debugging('optional_param_array() expects array parameters only: '.$parname);
702         return $default;
703     }
705     $result = array();
706     foreach ($param as $key => $value) {
707         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
708             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
709             continue;
710         }
711         $result[$key] = clean_param($value, $type);
712     }
714     return $result;
717 /**
718  * Strict validation of parameter values, the values are only converted
719  * to requested PHP type. Internally it is using clean_param, the values
720  * before and after cleaning must be equal - otherwise
721  * an invalid_parameter_exception is thrown.
722  * Objects and classes are not accepted.
723  *
724  * @param mixed $param
725  * @param string $type PARAM_ constant
726  * @param bool $allownull are nulls valid value?
727  * @param string $debuginfo optional debug information
728  * @return mixed the $param value converted to PHP type
729  * @throws invalid_parameter_exception if $param is not of given type
730  */
731 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
732     if (is_null($param)) {
733         if ($allownull == NULL_ALLOWED) {
734             return null;
735         } else {
736             throw new invalid_parameter_exception($debuginfo);
737         }
738     }
739     if (is_array($param) or is_object($param)) {
740         throw new invalid_parameter_exception($debuginfo);
741     }
743     $cleaned = clean_param($param, $type);
745     if ($type == PARAM_FLOAT) {
746         // Do not detect precision loss here.
747         if (is_float($param) or is_int($param)) {
748             // These always fit.
749         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
750             throw new invalid_parameter_exception($debuginfo);
751         }
752     } else if ((string)$param !== (string)$cleaned) {
753         // Conversion to string is usually lossless.
754         throw new invalid_parameter_exception($debuginfo);
755     }
757     return $cleaned;
760 /**
761  * Makes sure array contains only the allowed types, this function does not validate array key names!
762  *
763  * <code>
764  * $options = clean_param($options, PARAM_INT);
765  * </code>
766  *
767  * @param array $param the variable array we are cleaning
768  * @param string $type expected format of param after cleaning.
769  * @param bool $recursive clean recursive arrays
770  * @return array
771  * @throws coding_exception
772  */
773 function clean_param_array(array $param = null, $type, $recursive = false) {
774     // Convert null to empty array.
775     $param = (array)$param;
776     foreach ($param as $key => $value) {
777         if (is_array($value)) {
778             if ($recursive) {
779                 $param[$key] = clean_param_array($value, $type, true);
780             } else {
781                 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
782             }
783         } else {
784             $param[$key] = clean_param($value, $type);
785         }
786     }
787     return $param;
790 /**
791  * Used by {@link optional_param()} and {@link required_param()} to
792  * clean the variables and/or cast to specific types, based on
793  * an options field.
794  * <code>
795  * $course->format = clean_param($course->format, PARAM_ALPHA);
796  * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
797  * </code>
798  *
799  * @param mixed $param the variable we are cleaning
800  * @param string $type expected format of param after cleaning.
801  * @return mixed
802  * @throws coding_exception
803  */
804 function clean_param($param, $type) {
805     global $CFG;
807     if (is_array($param)) {
808         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
809     } else if (is_object($param)) {
810         if (method_exists($param, '__toString')) {
811             $param = $param->__toString();
812         } else {
813             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
814         }
815     }
817     switch ($type) {
818         case PARAM_RAW:
819             // No cleaning at all.
820             $param = fix_utf8($param);
821             return $param;
823         case PARAM_RAW_TRIMMED:
824             // No cleaning, but strip leading and trailing whitespace.
825             $param = fix_utf8($param);
826             return trim($param);
828         case PARAM_CLEAN:
829             // General HTML cleaning, try to use more specific type if possible this is deprecated!
830             // Please use more specific type instead.
831             if (is_numeric($param)) {
832                 return $param;
833             }
834             $param = fix_utf8($param);
835             // Sweep for scripts, etc.
836             return clean_text($param);
838         case PARAM_CLEANHTML:
839             // Clean html fragment.
840             $param = fix_utf8($param);
841             // Sweep for scripts, etc.
842             $param = clean_text($param, FORMAT_HTML);
843             return trim($param);
845         case PARAM_INT:
846             // Convert to integer.
847             return (int)$param;
849         case PARAM_FLOAT:
850             // Convert to float.
851             return (float)$param;
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  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1631  * {@link phpunit_util::reset_dataroot()}
1632  *
1633  * @return void
1634  */
1635 function purge_all_caches() {
1636     global $CFG, $DB;
1638     reset_text_filters_cache();
1639     js_reset_all_caches();
1640     theme_reset_all_caches();
1641     get_string_manager()->reset_caches();
1642     core_text::reset_caches();
1643     if (class_exists('core_plugin_manager')) {
1644         core_plugin_manager::reset_caches();
1645     }
1647     // Bump up cacherev field for all courses.
1648     try {
1649         increment_revision_number('course', 'cacherev', '');
1650     } catch (moodle_exception $e) {
1651         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1652     }
1654     $DB->reset_caches();
1655     cache_helper::purge_all();
1657     // Purge all other caches: rss, simplepie, etc.
1658     clearstatcache();
1659     remove_dir($CFG->cachedir.'', true);
1661     // Make sure cache dir is writable, throws exception if not.
1662     make_cache_directory('');
1664     // This is the only place where we purge local caches, we are only adding files there.
1665     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1666     remove_dir($CFG->localcachedir, true);
1667     set_config('localcachedirpurged', time());
1668     make_localcache_directory('', true);
1669     \core\task\manager::clear_static_caches();
1672 /**
1673  * Get volatile flags
1674  *
1675  * @param string $type
1676  * @param int $changedsince default null
1677  * @return array records array
1678  */
1679 function get_cache_flags($type, $changedsince = null) {
1680     global $DB;
1682     $params = array('type' => $type, 'expiry' => time());
1683     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1684     if ($changedsince !== null) {
1685         $params['changedsince'] = $changedsince;
1686         $sqlwhere .= " AND timemodified > :changedsince";
1687     }
1688     $cf = array();
1689     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1690         foreach ($flags as $flag) {
1691             $cf[$flag->name] = $flag->value;
1692         }
1693     }
1694     return $cf;
1697 /**
1698  * Get volatile flags
1699  *
1700  * @param string $type
1701  * @param string $name
1702  * @param int $changedsince default null
1703  * @return string|false The cache flag value or false
1704  */
1705 function get_cache_flag($type, $name, $changedsince=null) {
1706     global $DB;
1708     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1710     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1711     if ($changedsince !== null) {
1712         $params['changedsince'] = $changedsince;
1713         $sqlwhere .= " AND timemodified > :changedsince";
1714     }
1716     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1719 /**
1720  * Set a volatile flag
1721  *
1722  * @param string $type the "type" namespace for the key
1723  * @param string $name the key to set
1724  * @param string $value the value to set (without magic quotes) - null will remove the flag
1725  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1726  * @return bool Always returns true
1727  */
1728 function set_cache_flag($type, $name, $value, $expiry = null) {
1729     global $DB;
1731     $timemodified = time();
1732     if ($expiry === null || $expiry < $timemodified) {
1733         $expiry = $timemodified + 24 * 60 * 60;
1734     } else {
1735         $expiry = (int)$expiry;
1736     }
1738     if ($value === null) {
1739         unset_cache_flag($type, $name);
1740         return true;
1741     }
1743     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1744         // This is a potential problem in DEBUG_DEVELOPER.
1745         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1746             return true; // No need to update.
1747         }
1748         $f->value        = $value;
1749         $f->expiry       = $expiry;
1750         $f->timemodified = $timemodified;
1751         $DB->update_record('cache_flags', $f);
1752     } else {
1753         $f = new stdClass();
1754         $f->flagtype     = $type;
1755         $f->name         = $name;
1756         $f->value        = $value;
1757         $f->expiry       = $expiry;
1758         $f->timemodified = $timemodified;
1759         $DB->insert_record('cache_flags', $f);
1760     }
1761     return true;
1764 /**
1765  * Removes a single volatile flag
1766  *
1767  * @param string $type the "type" namespace for the key
1768  * @param string $name the key to set
1769  * @return bool
1770  */
1771 function unset_cache_flag($type, $name) {
1772     global $DB;
1773     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1774     return true;
1777 /**
1778  * Garbage-collect volatile flags
1779  *
1780  * @return bool Always returns true
1781  */
1782 function gc_cache_flags() {
1783     global $DB;
1784     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1785     return true;
1788 // USER PREFERENCE API.
1790 /**
1791  * Refresh user preference cache. This is used most often for $USER
1792  * object that is stored in session, but it also helps with performance in cron script.
1793  *
1794  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1795  *
1796  * @package  core
1797  * @category preference
1798  * @access   public
1799  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1800  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1801  * @throws   coding_exception
1802  * @return   null
1803  */
1804 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1805     global $DB;
1806     // Static cache, we need to check on each page load, not only every 2 minutes.
1807     static $loadedusers = array();
1809     if (!isset($user->id)) {
1810         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1811     }
1813     if (empty($user->id) or isguestuser($user->id)) {
1814         // No permanent storage for not-logged-in users and guest.
1815         if (!isset($user->preference)) {
1816             $user->preference = array();
1817         }
1818         return;
1819     }
1821     $timenow = time();
1823     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1824         // Already loaded at least once on this page. Are we up to date?
1825         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1826             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1827             return;
1829         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1830             // No change since the lastcheck on this page.
1831             $user->preference['_lastloaded'] = $timenow;
1832             return;
1833         }
1834     }
1836     // OK, so we have to reload all preferences.
1837     $loadedusers[$user->id] = true;
1838     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1839     $user->preference['_lastloaded'] = $timenow;
1842 /**
1843  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1844  *
1845  * NOTE: internal function, do not call from other code.
1846  *
1847  * @package core
1848  * @access private
1849  * @param integer $userid the user whose prefs were changed.
1850  */
1851 function mark_user_preferences_changed($userid) {
1852     global $CFG;
1854     if (empty($userid) or isguestuser($userid)) {
1855         // No cache flags for guest and not-logged-in users.
1856         return;
1857     }
1859     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1862 /**
1863  * Sets a preference for the specified user.
1864  *
1865  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1866  *
1867  * When additional validation/permission check is needed it is better to use {@see useredit_update_user_preference()}
1868  *
1869  * @package  core
1870  * @category preference
1871  * @access   public
1872  * @param    string            $name  The key to set as preference for the specified user
1873  * @param    string            $value The value to set for the $name key in the specified user's
1874  *                                    record, null means delete current value.
1875  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1876  * @throws   coding_exception
1877  * @return   bool                     Always true or exception
1878  */
1879 function set_user_preference($name, $value, $user = null) {
1880     global $USER, $DB;
1882     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1883         throw new coding_exception('Invalid preference name in set_user_preference() call');
1884     }
1886     if (is_null($value)) {
1887         // Null means delete current.
1888         return unset_user_preference($name, $user);
1889     } else if (is_object($value)) {
1890         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1891     } else if (is_array($value)) {
1892         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1893     }
1894     // Value column maximum length is 1333 characters.
1895     $value = (string)$value;
1896     if (core_text::strlen($value) > 1333) {
1897         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1898     }
1900     if (is_null($user)) {
1901         $user = $USER;
1902     } else if (isset($user->id)) {
1903         // It is a valid object.
1904     } else if (is_numeric($user)) {
1905         $user = (object)array('id' => (int)$user);
1906     } else {
1907         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1908     }
1910     check_user_preferences_loaded($user);
1912     if (empty($user->id) or isguestuser($user->id)) {
1913         // No permanent storage for not-logged-in users and guest.
1914         $user->preference[$name] = $value;
1915         return true;
1916     }
1918     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1919         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1920             // Preference already set to this value.
1921             return true;
1922         }
1923         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1925     } else {
1926         $preference = new stdClass();
1927         $preference->userid = $user->id;
1928         $preference->name   = $name;
1929         $preference->value  = $value;
1930         $DB->insert_record('user_preferences', $preference);
1931     }
1933     // Update value in cache.
1934     $user->preference[$name] = $value;
1935     // Update the $USER in case where we've not a direct reference to $USER.
1936     if ($user !== $USER && $user->id == $USER->id) {
1937         $USER->preference[$name] = $value;
1938     }
1940     // Set reload flag for other sessions.
1941     mark_user_preferences_changed($user->id);
1943     return true;
1946 /**
1947  * Sets a whole array of preferences for the current user
1948  *
1949  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1950  *
1951  * @package  core
1952  * @category preference
1953  * @access   public
1954  * @param    array             $prefarray An array of key/value pairs to be set
1955  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1956  * @return   bool                         Always true or exception
1957  */
1958 function set_user_preferences(array $prefarray, $user = null) {
1959     foreach ($prefarray as $name => $value) {
1960         set_user_preference($name, $value, $user);
1961     }
1962     return true;
1965 /**
1966  * Unsets a preference completely by deleting it from the database
1967  *
1968  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1969  *
1970  * @package  core
1971  * @category preference
1972  * @access   public
1973  * @param    string            $name The key to unset as preference for the specified user
1974  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1975  * @throws   coding_exception
1976  * @return   bool                    Always true or exception
1977  */
1978 function unset_user_preference($name, $user = null) {
1979     global $USER, $DB;
1981     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1982         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1983     }
1985     if (is_null($user)) {
1986         $user = $USER;
1987     } else if (isset($user->id)) {
1988         // It is a valid object.
1989     } else if (is_numeric($user)) {
1990         $user = (object)array('id' => (int)$user);
1991     } else {
1992         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1993     }
1995     check_user_preferences_loaded($user);
1997     if (empty($user->id) or isguestuser($user->id)) {
1998         // No permanent storage for not-logged-in user and guest.
1999         unset($user->preference[$name]);
2000         return true;
2001     }
2003     // Delete from DB.
2004     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
2006     // Delete the preference from cache.
2007     unset($user->preference[$name]);
2008     // Update the $USER in case where we've not a direct reference to $USER.
2009     if ($user !== $USER && $user->id == $USER->id) {
2010         unset($USER->preference[$name]);
2011     }
2013     // Set reload flag for other sessions.
2014     mark_user_preferences_changed($user->id);
2016     return true;
2019 /**
2020  * Used to fetch user preference(s)
2021  *
2022  * If no arguments are supplied this function will return
2023  * all of the current user preferences as an array.
2024  *
2025  * If a name is specified then this function
2026  * attempts to return that particular preference value.  If
2027  * none is found, then the optional value $default is returned,
2028  * otherwise null.
2029  *
2030  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
2031  *
2032  * @package  core
2033  * @category preference
2034  * @access   public
2035  * @param    string            $name    Name of the key to use in finding a preference value
2036  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
2037  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
2038  * @throws   coding_exception
2039  * @return   string|mixed|null          A string containing the value of a single preference. An
2040  *                                      array with all of the preferences or null
2041  */
2042 function get_user_preferences($name = null, $default = null, $user = null) {
2043     global $USER;
2045     if (is_null($name)) {
2046         // All prefs.
2047     } else if (is_numeric($name) or $name === '_lastloaded') {
2048         throw new coding_exception('Invalid preference name in get_user_preferences() call');
2049     }
2051     if (is_null($user)) {
2052         $user = $USER;
2053     } else if (isset($user->id)) {
2054         // Is a valid object.
2055     } else if (is_numeric($user)) {
2056         $user = (object)array('id' => (int)$user);
2057     } else {
2058         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2059     }
2061     check_user_preferences_loaded($user);
2063     if (empty($name)) {
2064         // All values.
2065         return $user->preference;
2066     } else if (isset($user->preference[$name])) {
2067         // The single string value.
2068         return $user->preference[$name];
2069     } else {
2070         // Default value (null if not specified).
2071         return $default;
2072     }
2075 // FUNCTIONS FOR HANDLING TIME.
2077 /**
2078  * Given Gregorian date parts in user time produce a GMT timestamp.
2079  *
2080  * @package core
2081  * @category time
2082  * @param int $year The year part to create timestamp of
2083  * @param int $month The month part to create timestamp of
2084  * @param int $day The day part to create timestamp of
2085  * @param int $hour The hour part to create timestamp of
2086  * @param int $minute The minute part to create timestamp of
2087  * @param int $second The second part to create timestamp of
2088  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2089  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2090  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2091  *             applied only if timezone is 99 or string.
2092  * @return int GMT timestamp
2093  */
2094 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2095     $date = new DateTime('now', core_date::get_user_timezone_object($timezone));
2096     $date->setDate((int)$year, (int)$month, (int)$day);
2097     $date->setTime((int)$hour, (int)$minute, (int)$second);
2099     $time = $date->getTimestamp();
2101     if ($time === false) {
2102         throw new coding_exception('getTimestamp() returned false, please ensure you have passed correct values.'.
2103             ' This can fail if year is more than 2038 and OS is 32 bit windows');
2104     }
2106     // Moodle BC DST stuff.
2107     if (!$applydst) {
2108         $time += dst_offset_on($time, $timezone);
2109     }
2111     return $time;
2115 /**
2116  * Format a date/time (seconds) as weeks, days, hours etc as needed
2117  *
2118  * Given an amount of time in seconds, returns string
2119  * formatted nicely as years, days, hours etc as needed
2120  *
2121  * @package core
2122  * @category time
2123  * @uses MINSECS
2124  * @uses HOURSECS
2125  * @uses DAYSECS
2126  * @uses YEARSECS
2127  * @param int $totalsecs Time in seconds
2128  * @param stdClass $str Should be a time object
2129  * @return string A nicely formatted date/time string
2130  */
2131 function format_time($totalsecs, $str = null) {
2133     $totalsecs = abs($totalsecs);
2135     if (!$str) {
2136         // Create the str structure the slow way.
2137         $str = new stdClass();
2138         $str->day   = get_string('day');
2139         $str->days  = get_string('days');
2140         $str->hour  = get_string('hour');
2141         $str->hours = get_string('hours');
2142         $str->min   = get_string('min');
2143         $str->mins  = get_string('mins');
2144         $str->sec   = get_string('sec');
2145         $str->secs  = get_string('secs');
2146         $str->year  = get_string('year');
2147         $str->years = get_string('years');
2148     }
2150     $years     = floor($totalsecs/YEARSECS);
2151     $remainder = $totalsecs - ($years*YEARSECS);
2152     $days      = floor($remainder/DAYSECS);
2153     $remainder = $totalsecs - ($days*DAYSECS);
2154     $hours     = floor($remainder/HOURSECS);
2155     $remainder = $remainder - ($hours*HOURSECS);
2156     $mins      = floor($remainder/MINSECS);
2157     $secs      = $remainder - ($mins*MINSECS);
2159     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2160     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2161     $sh = ($hours == 1) ? $str->hour : $str->hours;
2162     $sd = ($days == 1)  ? $str->day  : $str->days;
2163     $sy = ($years == 1)  ? $str->year  : $str->years;
2165     $oyears = '';
2166     $odays = '';
2167     $ohours = '';
2168     $omins = '';
2169     $osecs = '';
2171     if ($years) {
2172         $oyears  = $years .' '. $sy;
2173     }
2174     if ($days) {
2175         $odays  = $days .' '. $sd;
2176     }
2177     if ($hours) {
2178         $ohours = $hours .' '. $sh;
2179     }
2180     if ($mins) {
2181         $omins  = $mins .' '. $sm;
2182     }
2183     if ($secs) {
2184         $osecs  = $secs .' '. $ss;
2185     }
2187     if ($years) {
2188         return trim($oyears .' '. $odays);
2189     }
2190     if ($days) {
2191         return trim($odays .' '. $ohours);
2192     }
2193     if ($hours) {
2194         return trim($ohours .' '. $omins);
2195     }
2196     if ($mins) {
2197         return trim($omins .' '. $osecs);
2198     }
2199     if ($secs) {
2200         return $osecs;
2201     }
2202     return get_string('now');
2205 /**
2206  * Returns a formatted string that represents a date in user time.
2207  *
2208  * @package core
2209  * @category time
2210  * @param int $date the timestamp in UTC, as obtained from the database.
2211  * @param string $format strftime format. You should probably get this using
2212  *        get_string('strftime...', 'langconfig');
2213  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2214  *        not 99 then daylight saving will not be added.
2215  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2216  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2217  *        If false then the leading zero is maintained.
2218  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2219  * @return string the formatted date/time.
2220  */
2221 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2222     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2223     return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
2226 /**
2227  * Returns a formatted date ensuring it is UTF-8.
2228  *
2229  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2230  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2231  *
2232  * @param int $date the timestamp - since Moodle 2.9 this is a real UTC timestamp
2233  * @param string $format strftime format.
2234  * @param int|float|string $tz the user timezone
2235  * @return string the formatted date/time.
2236  * @since Moodle 2.3.3
2237  */
2238 function date_format_string($date, $format, $tz = 99) {
2239     global $CFG;
2241     $localewincharset = null;
2242     // Get the calendar type user is using.
2243     if ($CFG->ostype == 'WINDOWS') {
2244         $calendartype = \core_calendar\type_factory::get_calendar_instance();
2245         $localewincharset = $calendartype->locale_win_charset();
2246     }
2248     if ($localewincharset) {
2249         $format = core_text::convert($format, 'utf-8', $localewincharset);
2250     }
2252     date_default_timezone_set(core_date::get_user_timezone($tz));
2253     $datestring = strftime($format, $date);
2254     core_date::set_default_server_timezone();
2256     if ($localewincharset) {
2257         $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2258     }
2260     return $datestring;
2263 /**
2264  * Given a $time timestamp in GMT (seconds since epoch),
2265  * returns an array that represents the Gregorian date in user time
2266  *
2267  * @package core
2268  * @category time
2269  * @param int $time Timestamp in GMT
2270  * @param float|int|string $timezone user timezone
2271  * @return array An array that represents the date in user time
2272  */
2273 function usergetdate($time, $timezone=99) {
2274     date_default_timezone_set(core_date::get_user_timezone($timezone));
2275     $result = getdate($time);
2276     core_date::set_default_server_timezone();
2278     return $result;
2281 /**
2282  * Given a GMT timestamp (seconds since epoch), offsets it by
2283  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2284  *
2285  * NOTE: this function does not include DST properly,
2286  *       you should use the PHP date stuff instead!
2287  *
2288  * @package core
2289  * @category time
2290  * @param int $date Timestamp in GMT
2291  * @param float|int|string $timezone user timezone
2292  * @return int
2293  */
2294 function usertime($date, $timezone=99) {
2295     $userdate = new DateTime('@' . $date);
2296     $userdate->setTimezone(core_date::get_user_timezone_object($timezone));
2297     $dst = dst_offset_on($date, $timezone);
2299     return $date - $userdate->getOffset() + $dst;
2302 /**
2303  * Given a time, return the GMT timestamp of the most recent midnight
2304  * for the current user.
2305  *
2306  * @package core
2307  * @category time
2308  * @param int $date Timestamp in GMT
2309  * @param float|int|string $timezone user timezone
2310  * @return int Returns a GMT timestamp
2311  */
2312 function usergetmidnight($date, $timezone=99) {
2314     $userdate = usergetdate($date, $timezone);
2316     // Time of midnight of this user's day, in GMT.
2317     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2321 /**
2322  * Returns a string that prints the user's timezone
2323  *
2324  * @package core
2325  * @category time
2326  * @param float|int|string $timezone user timezone
2327  * @return string
2328  */
2329 function usertimezone($timezone=99) {
2330     $tz = core_date::get_user_timezone($timezone);
2331     return core_date::get_localised_timezone($tz);
2334 /**
2335  * Returns a float or a string which denotes the user's timezone
2336  * 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)
2337  * means that for this timezone there are also DST rules to be taken into account
2338  * Checks various settings and picks the most dominant of those which have a value
2339  *
2340  * @package core
2341  * @category time
2342  * @param float|int|string $tz timezone to calculate GMT time offset before
2343  *        calculating user timezone, 99 is default user timezone
2344  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2345  * @return float|string
2346  */
2347 function get_user_timezone($tz = 99) {
2348     global $USER, $CFG;
2350     $timezones = array(
2351         $tz,
2352         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2353         isset($USER->timezone) ? $USER->timezone : 99,
2354         isset($CFG->timezone) ? $CFG->timezone : 99,
2355         );
2357     $tz = 99;
2359     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2360     foreach ($timezones as $nextvalue) {
2361         if ((empty($tz) && !is_numeric($tz)) || $tz == 99) {
2362             $tz = $nextvalue;
2363         }
2364     }
2365     return is_numeric($tz) ? (float) $tz : $tz;
2368 /**
2369  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2370  * - Note: Daylight saving only works for string timezones and not for float.
2371  *
2372  * @package core
2373  * @category time
2374  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2375  * @param int|float|string $strtimezone user timezone
2376  * @return int
2377  */
2378 function dst_offset_on($time, $strtimezone = null) {
2379     $tz = core_date::get_user_timezone($strtimezone);
2380     $date = new DateTime('@' . $time);
2381     $date->setTimezone(new DateTimeZone($tz));
2382     if ($date->format('I') == '1') {
2383         if ($tz === 'Australia/Lord_Howe') {
2384             return 1800;
2385         }
2386         return 3600;
2387     }
2388     return 0;
2391 /**
2392  * Calculates when the day appears in specific month
2393  *
2394  * @package core
2395  * @category time
2396  * @param int $startday starting day of the month
2397  * @param int $weekday The day when week starts (normally taken from user preferences)
2398  * @param int $month The month whose day is sought
2399  * @param int $year The year of the month whose day is sought
2400  * @return int
2401  */
2402 function find_day_in_month($startday, $weekday, $month, $year) {
2403     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2405     $daysinmonth = days_in_month($month, $year);
2406     $daysinweek = count($calendartype->get_weekdays());
2408     if ($weekday == -1) {
2409         // Don't care about weekday, so return:
2410         //    abs($startday) if $startday != -1
2411         //    $daysinmonth otherwise.
2412         return ($startday == -1) ? $daysinmonth : abs($startday);
2413     }
2415     // From now on we 're looking for a specific weekday.
2416     // Give "end of month" its actual value, since we know it.
2417     if ($startday == -1) {
2418         $startday = -1 * $daysinmonth;
2419     }
2421     // Starting from day $startday, the sign is the direction.
2422     if ($startday < 1) {
2423         $startday = abs($startday);
2424         $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
2426         // This is the last such weekday of the month.
2427         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2428         if ($lastinmonth > $daysinmonth) {
2429             $lastinmonth -= $daysinweek;
2430         }
2432         // Find the first such weekday <= $startday.
2433         while ($lastinmonth > $startday) {
2434             $lastinmonth -= $daysinweek;
2435         }
2437         return $lastinmonth;
2438     } else {
2439         $indexweekday = dayofweek($startday, $month, $year);
2441         $diff = $weekday - $indexweekday;
2442         if ($diff < 0) {
2443             $diff += $daysinweek;
2444         }
2446         // This is the first such weekday of the month equal to or after $startday.
2447         $firstfromindex = $startday + $diff;
2449         return $firstfromindex;
2450     }
2453 /**
2454  * Calculate the number of days in a given month
2455  *
2456  * @package core
2457  * @category time
2458  * @param int $month The month whose day count is sought
2459  * @param int $year The year of the month whose day count is sought
2460  * @return int
2461  */
2462 function days_in_month($month, $year) {
2463     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2464     return $calendartype->get_num_days_in_month($year, $month);
2467 /**
2468  * Calculate the position in the week of a specific calendar day
2469  *
2470  * @package core
2471  * @category time
2472  * @param int $day The day of the date whose position in the week is sought
2473  * @param int $month The month of the date whose position in the week is sought
2474  * @param int $year The year of the date whose position in the week is sought
2475  * @return int
2476  */
2477 function dayofweek($day, $month, $year) {
2478     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2479     return $calendartype->get_weekday($year, $month, $day);
2482 // USER AUTHENTICATION AND LOGIN.
2484 /**
2485  * Returns full login url.
2486  *
2487  * @return string login url
2488  */
2489 function get_login_url() {
2490     global $CFG;
2492     return "$CFG->wwwroot/login/index.php";
2495 /**
2496  * This function checks that the current user is logged in and has the
2497  * required privileges
2498  *
2499  * This function checks that the current user is logged in, and optionally
2500  * whether they are allowed to be in a particular course and view a particular
2501  * course module.
2502  * If they are not logged in, then it redirects them to the site login unless
2503  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2504  * case they are automatically logged in as guests.
2505  * If $courseid is given and the user is not enrolled in that course then the
2506  * user is redirected to the course enrolment page.
2507  * If $cm is given and the course module is hidden and the user is not a teacher
2508  * in the course then the user is redirected to the course home page.
2509  *
2510  * When $cm parameter specified, this function sets page layout to 'module'.
2511  * You need to change it manually later if some other layout needed.
2512  *
2513  * @package    core_access
2514  * @category   access
2515  *
2516  * @param mixed $courseorid id of the course or course object
2517  * @param bool $autologinguest default true
2518  * @param object $cm course module object
2519  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2520  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2521  *             in order to keep redirects working properly. MDL-14495
2522  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2523  * @return mixed Void, exit, and die depending on path
2524  * @throws coding_exception
2525  * @throws require_login_exception
2526  * @throws moodle_exception
2527  */
2528 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2529     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2531     // Must not redirect when byteserving already started.
2532     if (!empty($_SERVER['HTTP_RANGE'])) {
2533         $preventredirect = true;
2534     }
2536     if (AJAX_SCRIPT) {
2537         // We cannot redirect for AJAX scripts either.
2538         $preventredirect = true;
2539     }
2541     // Setup global $COURSE, themes, language and locale.
2542     if (!empty($courseorid)) {
2543         if (is_object($courseorid)) {
2544             $course = $courseorid;
2545         } else if ($courseorid == SITEID) {
2546             $course = clone($SITE);
2547         } else {
2548             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2549         }
2550         if ($cm) {
2551             if ($cm->course != $course->id) {
2552                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2553             }
2554             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2555             if (!($cm instanceof cm_info)) {
2556                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2557                 // db queries so this is not really a performance concern, however it is obviously
2558                 // better if you use get_fast_modinfo to get the cm before calling this.
2559                 $modinfo = get_fast_modinfo($course);
2560                 $cm = $modinfo->get_cm($cm->id);
2561             }
2562         }
2563     } else {
2564         // Do not touch global $COURSE via $PAGE->set_course(),
2565         // the reasons is we need to be able to call require_login() at any time!!
2566         $course = $SITE;
2567         if ($cm) {
2568             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2569         }
2570     }
2572     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2573     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2574     // risk leading the user back to the AJAX request URL.
2575     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2576         $setwantsurltome = false;
2577     }
2579     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2580     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !empty($CFG->dbsessions)) {
2581         if ($preventredirect) {
2582             throw new require_login_session_timeout_exception();
2583         } else {
2584             if ($setwantsurltome) {
2585                 $SESSION->wantsurl = qualified_me();
2586             }
2587             redirect(get_login_url());
2588         }
2589     }
2591     // If the user is not even logged in yet then make sure they are.
2592     if (!isloggedin()) {
2593         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2594             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2595                 // Misconfigured site guest, just redirect to login page.
2596                 redirect(get_login_url());
2597                 exit; // Never reached.
2598             }
2599             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2600             complete_user_login($guest);
2601             $USER->autologinguest = true;
2602             $SESSION->lang = $lang;
2603         } else {
2604             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2605             if ($preventredirect) {
2606                 throw new require_login_exception('You are not logged in');
2607             }
2609             if ($setwantsurltome) {
2610                 $SESSION->wantsurl = qualified_me();
2611             }
2613             $referer = get_local_referer(false);
2614             if (!empty($referer)) {
2615                 $SESSION->fromurl = $referer;
2616             }
2618             // Give auth plugins an opportunity to authenticate or redirect to an external login page
2619             $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
2620             foreach($authsequence as $authname) {
2621                 $authplugin = get_auth_plugin($authname);
2622                 $authplugin->pre_loginpage_hook();
2623                 if (isloggedin()) {
2624                     break;
2625                 }
2626             }
2628             // If we're still not logged in then go to the login page
2629             if (!isloggedin()) {
2630                 redirect(get_login_url());
2631                 exit; // Never reached.
2632             }
2633         }
2634     }
2636     // Loginas as redirection if needed.
2637     if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
2638         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2639             if ($USER->loginascontext->instanceid != $course->id) {
2640                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2641             }
2642         }
2643     }
2645     // Check whether the user should be changing password (but only if it is REALLY them).
2646     if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
2647         $userauth = get_auth_plugin($USER->auth);
2648         if ($userauth->can_change_password() and !$preventredirect) {
2649             if ($setwantsurltome) {
2650                 $SESSION->wantsurl = qualified_me();
2651             }
2652             if ($changeurl = $userauth->change_password_url()) {
2653                 // Use plugin custom url.
2654                 redirect($changeurl);
2655             } else {
2656                 // Use moodle internal method.
2657                 redirect($CFG->wwwroot .'/login/change_password.php');
2658             }
2659         } else if ($userauth->can_change_password()) {
2660             throw new moodle_exception('forcepasswordchangenotice');
2661         } else {
2662             throw new moodle_exception('nopasswordchangeforced', 'auth');
2663         }
2664     }
2666     // Check that the user account is properly set up. If we can't redirect to
2667     // edit their profile and this is not a WS request, perform just the lax check.
2668     // It will allow them to use filepicker on the profile edit page.
2670     if ($preventredirect && !WS_SERVER) {
2671         $usernotfullysetup = user_not_fully_set_up($USER, false);
2672     } else {
2673         $usernotfullysetup = user_not_fully_set_up($USER, true);
2674     }
2676     if ($usernotfullysetup) {
2677         if ($preventredirect) {
2678             throw new moodle_exception('usernotfullysetup');
2679         }
2680         if ($setwantsurltome) {
2681             $SESSION->wantsurl = qualified_me();
2682         }
2683         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2684     }
2686     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2687     sesskey();
2689     // Do not bother admins with any formalities, except for activities pending deletion.
2690     if (is_siteadmin() && !($cm && $cm->deletioninprogress)) {
2691         // Set the global $COURSE.
2692         if ($cm) {
2693             $PAGE->set_cm($cm, $course);
2694             $PAGE->set_pagelayout('incourse');
2695         } else if (!empty($courseorid)) {
2696             $PAGE->set_course($course);
2697         }
2698         // Set accesstime or the user will appear offline which messes up messaging.
2699         user_accesstime_log($course->id);
2700         return;
2701     }
2703     // Scripts have a chance to declare that $USER->policyagreed should not be checked.
2704     // This is mostly for places where users are actually accepting the policies, to avoid the redirect loop.
2705     if (!defined('NO_SITEPOLICY_CHECK')) {
2706         define('NO_SITEPOLICY_CHECK', false);
2707     }
2709     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2710     // Do not test if the script explicitly asked for skipping the site policies check.
2711     if (!$USER->policyagreed && !is_siteadmin() && !NO_SITEPOLICY_CHECK) {
2712         $manager = new \core_privacy\local\sitepolicy\manager();
2713         if ($policyurl = $manager->get_redirect_url(isguestuser())) {
2714             if ($preventredirect) {
2715                 throw new moodle_exception('sitepolicynotagreed', 'error', '', $policyurl->out());
2716             }
2717             if ($setwantsurltome) {
2718                 $SESSION->wantsurl = qualified_me();
2719             }
2720             redirect($policyurl);
2721         }
2722     }
2724     // Fetch the system context, the course context, and prefetch its child contexts.
2725     $sysctx = context_system::instance();
2726     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2727     if ($cm) {
2728         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2729     } else {
2730         $cmcontext = null;
2731     }
2733     // If the site is currently under maintenance, then print a message.
2734     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:maintenanceaccess', $sysctx)) {
2735         if ($preventredirect) {
2736             throw new require_login_exception('Maintenance in progress');
2737         }
2738         $PAGE->set_context(null);
2739         print_maintenance_message();
2740     }
2742     // Make sure the course itself is not hidden.
2743     if ($course->id == SITEID) {
2744         // Frontpage can not be hidden.
2745     } else {
2746         if (is_role_switched($course->id)) {
2747             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
2748         } else {
2749             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2750                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
2751                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
2752                 if ($preventredirect) {
2753                     throw new require_login_exception('Course is hidden');
2754                 }
2755                 $PAGE->set_context(null);
2756                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2757                 // the navigation will mess up when trying to find it.
2758                 navigation_node::override_active_url(new moodle_url('/'));
2759                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2760             }
2761         }
2762     }
2764     // Is the user enrolled?
2765     if ($course->id == SITEID) {
2766         // Everybody is enrolled on the frontpage.
2767     } else {
2768         if (\core\session\manager::is_loggedinas()) {
2769             // Make sure the REAL person can access this course first.
2770             $realuser = \core\session\manager::get_realuser();
2771             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
2772                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2773                 if ($preventredirect) {
2774                     throw new require_login_exception('Invalid course login-as access');
2775                 }
2776                 $PAGE->set_context(null);
2777                 echo $OUTPUT->header();
2778                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2779             }
2780         }
2782         $access = false;
2784         if (is_role_switched($course->id)) {
2785             // Ok, user had to be inside this course before the switch.
2786             $access = true;
2788         } else if (is_viewing($coursecontext, $USER)) {
2789             // Ok, no need to mess with enrol.
2790             $access = true;
2792         } else {
2793             if (isset($USER->enrol['enrolled'][$course->id])) {
2794                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2795                     $access = true;
2796                     if (isset($USER->enrol['tempguest'][$course->id])) {
2797                         unset($USER->enrol['tempguest'][$course->id]);
2798                         remove_temp_course_roles($coursecontext);
2799                     }
2800                 } else {
2801                     // Expired.
2802                     unset($USER->enrol['enrolled'][$course->id]);
2803                 }
2804             }
2805             if (isset($USER->enrol['tempguest'][$course->id])) {
2806                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2807                     $access = true;
2808                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2809                     $access = true;
2810                 } else {
2811                     // Expired.
2812                     unset($USER->enrol['tempguest'][$course->id]);
2813                     remove_temp_course_roles($coursecontext);
2814                 }
2815             }
2817             if (!$access) {
2818                 // Cache not ok.
2819                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2820                 if ($until !== false) {
2821                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
2822                     if ($until == 0) {
2823                         $until = ENROL_MAX_TIMESTAMP;
2824                     }
2825                     $USER->enrol['enrolled'][$course->id] = $until;
2826                     $access = true;
2828                 } else {
2829                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
2830                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
2831                     $enrols = enrol_get_plugins(true);
2832                     // First ask all enabled enrol instances in course if they want to auto enrol user.
2833                     foreach ($instances as $instance) {
2834                         if (!isset($enrols[$instance->enrol])) {
2835                             continue;
2836                         }
2837                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2838                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2839                         if ($until !== false) {
2840                             if ($until == 0) {
2841                                 $until = ENROL_MAX_TIMESTAMP;
2842                             }
2843                             $USER->enrol['enrolled'][$course->id] = $until;
2844                             $access = true;
2845                             break;
2846                         }
2847                     }
2848                     // If not enrolled yet try to gain temporary guest access.
2849                     if (!$access) {
2850                         foreach ($instances as $instance) {
2851                             if (!isset($enrols[$instance->enrol])) {
2852                                 continue;
2853                             }
2854                             // Get a duration for the guest access, a timestamp in the future or false.
2855                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2856                             if ($until !== false and $until > time()) {
2857                                 $USER->enrol['tempguest'][$course->id] = $until;
2858                                 $access = true;
2859                                 break;
2860                             }
2861                         }
2862                     }
2863                 }
2864             }
2865         }
2867         if (!$access) {
2868             if ($preventredirect) {
2869                 throw new require_login_exception('Not enrolled');
2870             }
2871             if ($setwantsurltome) {
2872                 $SESSION->wantsurl = qualified_me();
2873             }
2874             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2875         }
2876     }
2878     // Check whether the activity has been scheduled for deletion. If so, then deny access, even for admins.
2879     if ($cm && $cm->deletioninprogress) {
2880         if ($preventredirect) {
2881             throw new moodle_exception('activityisscheduledfordeletion');
2882         }
2883         require_once($CFG->dirroot . '/course/lib.php');
2884         redirect(course_get_url($course), get_string('activityisscheduledfordeletion', 'error'));
2885     }
2887     // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
2888     if ($cm && !$cm->uservisible) {
2889         if ($preventredirect) {
2890             throw new require_login_exception('Activity is hidden');
2891         }
2892         // Get the error message that activity is not available and why (if explanation can be shown to the user).
2893         $PAGE->set_course($course);
2894         $renderer = $PAGE->get_renderer('course');
2895         $message = $renderer->course_section_cm_unavailable_error_message($cm);
2896         redirect(course_get_url($course), $message, null, \core\output\notification::NOTIFY_ERROR);
2897     }
2899     // Set the global $COURSE.
2900     if ($cm) {
2901         $PAGE->set_cm($cm, $course);
2902         $PAGE->set_pagelayout('incourse');
2903     } else if (!empty($courseorid)) {
2904         $PAGE->set_course($course);
2905     }
2907     // Finally access granted, update lastaccess times.
2908     user_accesstime_log($course->id);
2912 /**
2913  * This function just makes sure a user is logged out.
2914  *
2915  * @package    core_access
2916  * @category   access
2917  */
2918 function require_logout() {
2919     global $USER, $DB;
2921     if (!isloggedin()) {
2922         // This should not happen often, no need for hooks or events here.
2923         \core\session\manager::terminate_current();
2924         return;
2925     }
2927     // Execute hooks before action.
2928     $authplugins = array();
2929     $authsequence = get_enabled_auth_plugins();
2930     foreach ($authsequence as $authname) {
2931         $authplugins[$authname] = get_auth_plugin($authname);
2932         $authplugins[$authname]->prelogout_hook();
2933     }
2935     // Store info that gets removed during logout.
2936     $sid = session_id();
2937     $event = \core\event\user_loggedout::create(
2938         array(
2939             'userid' => $USER->id,
2940             'objectid' => $USER->id,
2941             'other' => array('sessionid' => $sid),
2942         )
2943     );
2944     if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
2945         $event->add_record_snapshot('sessions', $session);
2946     }
2948     // Clone of $USER object to be used by auth plugins.
2949     $user = fullclone($USER);
2951     // Delete session record and drop $_SESSION content.
2952     \core\session\manager::terminate_current();
2954     // Trigger event AFTER action.
2955     $event->trigger();
2957     // Hook to execute auth plugins redirection after event trigger.
2958     foreach ($authplugins as $authplugin) {
2959         $authplugin->postlogout_hook($user);
2960     }
2963 /**
2964  * Weaker version of require_login()
2965  *
2966  * This is a weaker version of {@link require_login()} which only requires login
2967  * when called from within a course rather than the site page, unless
2968  * the forcelogin option is turned on.
2969  * @see require_login()
2970  *
2971  * @package    core_access
2972  * @category   access
2973  *
2974  * @param mixed $courseorid The course object or id in question
2975  * @param bool $autologinguest Allow autologin guests if that is wanted
2976  * @param object $cm Course activity module if known
2977  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2978  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2979  *             in order to keep redirects working properly. MDL-14495
2980  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2981  * @return void
2982  * @throws coding_exception
2983  */
2984 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2985     global $CFG, $PAGE, $SITE;
2986     $issite = ((is_object($courseorid) and $courseorid->id == SITEID)
2987           or (!is_object($courseorid) and $courseorid == SITEID));
2988     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
2989         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2990         // db queries so this is not really a performance concern, however it is obviously
2991         // better if you use get_fast_modinfo to get the cm before calling this.
2992         if (is_object($courseorid)) {
2993             $course = $courseorid;
2994         } else {
2995             $course = clone($SITE);
2996         }
2997         $modinfo = get_fast_modinfo($course);
2998         $cm = $modinfo->get_cm($cm->id);
2999     }
3000     if (!empty($CFG->forcelogin)) {
3001         // Login required for both SITE and courses.
3002         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3004     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3005         // Always login for hidden activities.
3006         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3008     } else if ($issite) {
3009         // Login for SITE not required.
3010         // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3011         if (!empty($courseorid)) {
3012             if (is_object($courseorid)) {
3013                 $course = $courseorid;
3014             } else {
3015                 $course = clone $SITE;
3016             }
3017             if ($cm) {
3018                 if ($cm->course != $course->id) {
3019                     throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3020                 }
3021                 $PAGE->set_cm($cm, $course);
3022                 $PAGE->set_pagelayout('incourse');
3023             } else {
3024                 $PAGE->set_course($course);
3025             }
3026         } else {
3027             // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3028             $PAGE->set_course($PAGE->course);
3029         }
3030         user_accesstime_log(SITEID);
3031         return;
3033     } else {
3034         // Course login always required.
3035         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3036     }
3039 /**
3040  * Validates a user key, checking if the key exists, is not expired and the remote ip is correct.
3041  *
3042  * @param  string $keyvalue the key value
3043  * @param  string $script   unique script identifier
3044  * @param  int $instance    instance id
3045  * @return stdClass the key entry in the user_private_key table
3046  * @since Moodle 3.2
3047  * @throws moodle_exception
3048  */
3049 function validate_user_key($keyvalue, $script, $instance) {
3050     global $DB;
3052     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3053         print_error('invalidkey');
3054     }
3056     if (!empty($key->validuntil) and $key->validuntil < time()) {
3057         print_error('expiredkey');
3058     }
3060     if ($key->iprestriction) {
3061         $remoteaddr = getremoteaddr(null);
3062         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3063             print_error('ipmismatch');
3064         }
3065     }
3066     return $key;
3069 /**
3070  * Require key login. Function terminates with error if key not found or incorrect.
3071  *
3072  * @uses NO_MOODLE_COOKIES
3073  * @uses PARAM_ALPHANUM
3074  * @param string $script unique script identifier
3075  * @param int $instance optional instance id
3076  * @return int Instance ID
3077  */
3078 function require_user_key_login($script, $instance=null) {
3079     global $DB;
3081     if (!NO_MOODLE_COOKIES) {
3082         print_error('sessioncookiesdisable');
3083     }
3085     // Extra safety.
3086     \core\session\manager::write_close();
3088     $keyvalue = required_param('key', PARAM_ALPHANUM);
3090     $key = validate_user_key($keyvalue, $script, $instance);
3092     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3093         print_error('invaliduserid');
3094     }
3096     // Emulate normal session.
3097     enrol_check_plugins($user);
3098     \core\session\manager::set_user($user);
3100     // Note we are not using normal login.
3101     if (!defined('USER_KEY_LOGIN')) {
3102         define('USER_KEY_LOGIN', true);
3103     }
3105     // Return instance id - it might be empty.
3106     return $key->instance;
3109 /**
3110  * Creates a new private user access key.
3111  *
3112  * @param string $script unique target identifier
3113  * @param int $userid
3114  * @param int $instance optional instance id
3115  * @param string $iprestriction optional ip restricted access
3116  * @param int $validuntil key valid only until given data
3117  * @return string access key value
3118  */
3119 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3120     global $DB;
3122     $key = new stdClass();
3123     $key->script        = $script;
3124     $key->userid        = $userid;
3125     $key->instance      = $instance;
3126     $key->iprestriction = $iprestriction;
3127     $key->validuntil    = $validuntil;
3128     $key->timecreated   = time();
3130     // Something long and unique.
3131     $key->value         = md5($userid.'_'.time().random_string(40));
3132     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3133         // Must be unique.
3134         $key->value     = md5($userid.'_'.time().random_string(40));
3135     }
3136     $DB->insert_record('user_private_key', $key);
3137     return $key->value;
3140 /**
3141  * Delete the user's new private user access keys for a particular script.
3142  *
3143  * @param string $script unique target identifier
3144  * @param int $userid
3145  * @return void
3146  */
3147 function delete_user_key($script, $userid) {
3148     global $DB;
3149     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3152 /**
3153  * Gets a private user access key (and creates one if one doesn't exist).
3154  *
3155  * @param string $script unique target identifier
3156  * @param int $userid
3157  * @param int $instance optional instance id
3158  * @param string $iprestriction optional ip restricted access
3159  * @param int $validuntil key valid only until given date
3160  * @return string access key value
3161  */
3162 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3163     global $DB;
3165     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3166                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3167                                                          'validuntil' => $validuntil))) {
3168         return $key->value;
3169     } else {
3170         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3171     }
3175 /**
3176  * Modify the user table by setting the currently logged in user's last login to now.
3177  *
3178  * @return bool Always returns true
3179  */
3180 function update_user_login_times() {
3181     global $USER, $DB;
3183     if (isguestuser()) {
3184         // Do not update guest access times/ips for performance.
3185         return true;
3186     }
3188     $now = time();
3190     $user = new stdClass();
3191     $user->id = $USER->id;
3193     // Make sure all users that logged in have some firstaccess.
3194     if ($USER->firstaccess == 0) {
3195         $USER->firstaccess = $user->firstaccess = $now;
3196     }
3198     // Store the previous current as lastlogin.
3199     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3201     $USER->currentlogin = $user->currentlogin = $now;
3203     // Function user_accesstime_log() may not update immediately, better do it here.
3204     $USER->lastaccess = $user->lastaccess = $now;
3205     $USER->lastip = $user->lastip = getremoteaddr();
3207     // Note: do not call user_update_user() here because this is part of the login process,
3208     //       the login event means that these fields were updated.
3209     $DB->update_record('user', $user);
3210     return true;
3213 /**
3214  * Determines if a user has completed setting up their account.
3215  *
3216  * The lax mode (with $strict = false) has been introduced for special cases
3217  * only where we want to skip certain checks intentionally. This is valid in
3218  * certain mnet or ajax scenarios when the user cannot / should not be
3219  * redirected to edit their profile. In most cases, you should perform the
3220  * strict check.
3221  *
3222  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3223  * @param bool $strict Be more strict and assert id and custom profile fields set, too
3224  * @return bool
3225  */
3226 function user_not_fully_set_up($user, $strict = true) {
3227     global $CFG;
3228     require_once($CFG->dirroot.'/user/profile/lib.php');
3230     if (isguestuser($user)) {
3231         return false;
3232     }
3234     if (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)) {
3235         return true;
3236     }
3238     if ($strict) {
3239         if (empty($user->id)) {
3240             // Strict mode can be used with existing accounts only.
3241             return true;
3242         }
3243         if (!profile_has_required_custom_fields_set($user->id)) {
3244             return true;
3245         }
3246     }
3248     return false;
3251 /**
3252  * Check whether the user has exceeded the bounce threshold
3253  *
3254  * @param stdClass $user A {@link $USER} object
3255  * @return bool true => User has exceeded bounce threshold
3256  */
3257 function over_bounce_threshold($user) {
3258     global $CFG, $DB;
3260     if (empty($CFG->handlebounces)) {
3261         return false;
3262     }
3264     if (empty($user->id)) {
3265         // No real (DB) user, nothing to do here.
3266         return false;
3267     }
3269     // Set sensible defaults.
3270     if (empty($CFG->minbounces)) {
3271         $CFG->minbounces = 10;
3272     }
3273     if (empty($CFG->bounceratio)) {
3274         $CFG->bounceratio = .20;
3275     }
3276     $bouncecount = 0;
3277     $sendcount = 0;
3278     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3279         $bouncecount = $bounce->value;
3280     }
3281     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3282         $sendcount = $send->value;
3283     }
3284     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3287 /**
3288  * Used to increment or reset email sent count
3289  *
3290  * @param stdClass $user object containing an id
3291  * @param bool $reset will reset the count to 0
3292  * @return void
3293  */
3294 function set_send_count($user, $reset=false) {
3295     global $DB;
3297     if (empty($user->id)) {
3298         // No real (DB) user, nothing to do here.
3299         return;
3300     }
3302     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3303         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3304         $DB->update_record('user_preferences', $pref);
3305     } else if (!empty($reset)) {
3306         // If it's not there and we're resetting, don't bother. Make a new one.
3307         $pref = new stdClass();
3308         $pref->name   = 'email_send_count';
3309         $pref->value  = 1;
3310         $pref->userid = $user->id;
3311         $DB->insert_record('user_preferences', $pref, false);
3312     }
3315 /**
3316  * Increment or reset user's email bounce count
3317  *
3318  * @param stdClass $user object containing an id
3319  * @param bool $reset will reset the count to 0
3320  */
3321 function set_bounce_count($user, $reset=false) {
3322     global $DB;
3324     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3325         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3326         $DB->update_record('user_preferences', $pref);
3327     } else if (!empty($reset)) {
3328         // If it's not there and we're resetting, don't bother. Make a new one.
3329         $pref = new stdClass();
3330         $pref->name   = 'email_bounce_count';
3331         $pref->value  = 1;
3332         $pref->userid = $user->id;
3333         $DB->insert_record('user_preferences', $pref, false);
3334     }
3337 /**
3338  * Determines if the logged in user is currently moving an activity
3339  *
3340  * @param int $courseid The id of the course being tested
3341  * @return bool
3342  */
3343 function ismoving($courseid) {
3344     global $USER;
3346     if (!empty($USER->activitycopy)) {
3347         return ($USER->activitycopycourse == $courseid);
3348     }
3349     return false;
3352 /**
3353  * Returns a persons full name
3354  *
3355  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3356  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3357  * specify one.
3358  *
3359  * @param stdClass $user A {@link $USER} object to get full name of.
3360  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3361  * @return string
3362  */
3363 function fullname($user, $override=false) {
3364     global $CFG, $SESSION;
3366     if (!isset($user->firstname) and !isset($user->lastname)) {
3367         return '';
3368     }
3370     // Get all of the name fields.
3371     $allnames = get_all_user_name_fields();
3372     if ($CFG->debugdeveloper) {
3373         foreach ($allnames as $allname) {
3374             if (!property_exists($user, $allname)) {
3375                 // If all the user name fields are not set in the user object, then notify the programmer that it needs to be fixed.
3376                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3377                 // Message has been sent, no point in sending the message multiple times.
3378                 break;
3379             }
3380         }
3381     }
3383     if (!$override) {
3384         if (!empty($CFG->forcefirstname)) {
3385             $user->firstname = $CFG->forcefirstname;
3386         }
3387         if (!empty($CFG->forcelastname)) {
3388             $user->lastname = $CFG->forcelastname;
3389         }
3390     }
3392     if (!empty($SESSION->fullnamedisplay)) {
3393         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3394     }
3396     $template = null;
3397     // If the fullnamedisplay setting is available, set the template to that.
3398     if (isset($CFG->fullnamedisplay)) {
3399         $template = $CFG->fullnamedisplay;
3400     }
3401     // If the template is empty, or set to language, return the language string.
3402     if ((empty($template) || $template == 'language') && !$override) {
3403         return get_string('fullnamedisplay', null, $user);
3404     }
3406     // Check to see if we are displaying according to the alternative full name format.
3407     if ($override) {
3408         if (empty($CFG->alternativefullnameformat) || $CFG->alternativefullnameformat == 'language') {
3409             // Default to show just the user names according to the fullnamedisplay string.
3410             return get_string('fullnamedisplay', null, $user);
3411         } else {
3412             // If the override is true, then change the template to use the complete name.
3413             $template = $CFG->alternativefullnameformat;
3414         }
3415     }
3417     $requirednames = array();
3418     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3419     foreach ($allnames as $allname) {
3420         if (strpos($template, $allname) !== false) {
3421             $requirednames[] = $allname;
3422         }
3423     }
3425     $displayname = $template;
3426     // Switch in the actual data into the template.
3427     foreach ($requirednames as $altname) {
3428         if (isset($user->$altname)) {
3429             // Using empty() on the below if statement causes breakages.
3430             if ((string)$user->$altname == '') {
3431                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3432             } else {
3433                 $displayname = str_replace($altname, $user->$altname, $displayname);
3434             }
3435         } else {
3436             $displayname = str_replace($altname, 'EMPTY', $displayname);
3437         }
3438     }
3439     // Tidy up any misc. characters (Not perfect, but gets most characters).
3440     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3441     // katakana and parenthesis.
3442     $patterns = array();
3443     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3444     // filled in by a user.
3445     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3446     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3447     // This regular expression is to remove any double spaces in the display name.
3448     $patterns[] = '/\s{2,}/u';
3449     foreach ($patterns as $pattern) {
3450         $displayname = preg_replace($pattern, ' ', $displayname);
3451     }
3453     // Trimming $displayname will help the next check to ensure that we don't have a display name with spaces.
3454     $displayname = trim($displayname);
3455     if (empty($displayname)) {
3456         // Going with just the first name if no alternate fields are filled out. May be changed later depending on what
3457         // people in general feel is a good setting to fall back on.
3458         $displayname = $user->firstname;
3459     }
3460     return $displayname;
3463 /**
3464  * A centralised location for the all name fields. Returns an array / sql string snippet.
3465  *
3466  * @param bool $returnsql True for an sql select field snippet.
3467  * @param string $tableprefix table query prefix to use in front of each field.
3468  * @param string $prefix prefix added to the name fields e.g. authorfirstname.
3469  * @param string $fieldprefix sql field prefix e.g. id AS userid.
3470  * @param bool $order moves firstname and lastname to the top of the array / start of the string.
3471  * @return array|string All name fields.
3472  */
3473 function get_all_user_name_fields($returnsql = false, $tableprefix = null, $prefix = null, $fieldprefix = null, $order = false) {
3474     // This array is provided in this order because when called by fullname() (above) if firstname is before
3475     // firstnamephonetic str_replace() will change the wrong placeholder.
3476     $alternatenames = array('firstnamephonetic' => 'firstnamephonetic',
3477                             'lastnamephonetic' => 'lastnamephonetic',
3478                             'middlename' => 'middlename',
3479                             'alternatename' => 'alternatename',
3480                             'firstname' => 'firstname',
3481                             'lastname' => 'lastname');
3483     // Let's add a prefix to the array of user name fields if provided.
3484     if ($prefix) {
3485         foreach ($alternatenames as $key => $altname) {
3486             $alternatenames[$key] = $prefix . $altname;
3487         }
3488     }
3490     // If we want the end result to have firstname and lastname at the front / top of the result.
3491     if ($order) {
3492         // Move the last two elements (firstname, lastname) off the array and put them at the top.
3493         for ($i = 0; $i < 2; $i++) {
3494             // Get the last element.
3495             $lastelement = end($alternatenames);
3496             // Remove it from the array.
3497             unset($alternatenames[$lastelement]);
3498             // Put the element back on the top of the array.
3499             $alternatenames = array_merge(array($lastelement => $lastelement), $alternatenames);
3500         }
3501     }
3503     // Create an sql field snippet if requested.
3504     if ($returnsql) {
3505         if ($tableprefix) {
3506             if ($fieldprefix) {
3507                 foreach ($alternatenames as $key => $altname) {
3508                     $alternatenames[$key] = $tableprefix . '.' . $altname . ' AS ' . $fieldprefix . $altname;
3509                 }
3510             } else {
3511                 foreach ($alternatenames as $key => $altname) {
3512                     $alternatenames[$key] = $tableprefix . '.' . $altname;
3513                 }
3514             }
3515         }
3516         $alternatenames = implode(',', $alternatenames);
3517     }
3518     return $alternatenames;
3521 /**
3522  * Reduces lines of duplicated code for getting user name fields.
3523  *
3524  * See also {@link user_picture::unalias()}
3525  *
3526  * @param object $addtoobject Object to add user name fields to.
3527  * @param object $secondobject Object that contains user name field information.
3528  * @param string $prefix prefix to be added to all fields (including $additionalfields) e.g. authorfirstname.
3529  * @param array $additionalfields Additional fields to be matched with data in the second object.
3530  * The key can be set to the user table field name.
3531  * @return object User name fields.
3532  */
3533 function username_load_fields_from_object($addtoobject, $secondobject, $prefix = null, $additionalfields = null) {
3534     $fields = get_all_user_name_fields(false, null, $prefix);
3535     if ($additionalfields) {
3536         // Additional fields can specify their own 'alias' such as 'id' => 'userid'. This checks to see if
3537         // the key is a number and then sets the key to the array value.
3538         foreach ($additionalfields as $key => $value) {
3539             if (is_numeric($key)) {
3540                 $additionalfields[$value] = $prefix . $value;
3541                 unset($additionalfields[$key]);
3542             } else {
3543                 $additionalfields[$key] = $prefix . $value;
3544             }
3545         }
3546         $fields = array_merge($fields, $additionalfields);
3547     }
3548     foreach ($fields as $key => $field) {
3549         // Important that we have all of the user name fields present in the object that we are sending back.
3550         $addtoobject->$key = '';
3551         if (isset($secondobject->$field)) {
3552             $addtoobject->$key = $secondobject->$field;
3553         }
3554     }
3555     return $addtoobject;
3558 /**
3559  * Returns an array of values in order of occurance in a provided string.
3560  * The key in the result is the character postion in the string.
3561  *
3562  * @param array $values Values to be found in the string format
3563  * @param string $stringformat The string which may contain values being searched for.
3564  * @return array An array of values in order according to placement in the string format.
3565  */
3566 function order_in_string($values, $stringformat) {
3567     $valuearray = array();
3568     foreach ($values as $value) {
3569         $pattern = "/$value\b/";
3570         // Using preg_match as strpos() may match values that are similar e.g. firstname and firstnamephonetic.
3571         if (preg_match($pattern, $stringformat)) {
3572             $replacement = "thing";
3573             // Replace the value with something more unique to ensure we get the right position when using strpos().
3574             $newformat = preg_replace($pattern, $replacement, $stringformat);
3575             $position = strpos($newformat, $replacement);
3576             $valuearray[$position] = $value;
3577         }
3578     }
3579     ksort($valuearray);
3580     return $valuearray;
3583 /**
3584  * Checks if current user is shown any extra fields when listing users.
3585  *
3586  * @param object $context Context
3587  * @param array $already Array of fields that we're going to show anyway
3588  *   so don't bother listing them
3589  * @return array Array of field names from user table, not including anything
3590  *   listed in $already
3591  */
3592 function get_extra_user_fields($context, $already = array()) {
3593     global $CFG;
3595     // Only users with permission get the extra fields.
3596     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3597         return array();
3598     }
3600     // Split showuseridentity on comma.
3601     if (empty($CFG->showuseridentity)) {
3602         // Explode gives wrong result with empty string.
3603         $extra = array();
3604     } else {
3605         $extra =  explode(',', $CFG->showuseridentity);
3606     }
3607     $renumber = false;
3608     foreach ($extra as $key => $field) {
3609         if (in_array($field, $already)) {
3610             unset($extra[$key]);
3611             $renumber = true;
3612         }
3613     }
3614     if ($renumber) {
3615         // For consistency, if entries are removed from array, renumber it
3616         // so they are numbered as you would expect.
3617         $extra = array_merge($extra);
3618     }
3619     return $extra;
3622 /**
3623  * If the current user is to be shown extra user fields when listing or
3624  * selecting users, returns a string suitable for including in an SQL select
3625  * clause to retrieve those fields.
3626  *
3627  * @param context $context Context
3628  * @param string $alias Alias of user table, e.g. 'u' (default none)
3629  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3630  * @param array $already Array of fields that we're going to include anyway so don't list them (default none)
3631  * @return string Partial SQL select clause, beginning with comma, for example ',u.idnumber,u.department' unless it is blank
3632  */
3633 function get_extra_user_fields_sql($context, $alias='', $prefix='', $already = array()) {
3634     $fields = get_extra_user_fields($context, $already);
3635     $result = '';
3636     // Add punctuation for alias.
3637     if ($alias !== '') {
3638         $alias .= '.';
3639     }
3640     foreach ($fields as $field) {
3641         $result .= ', ' . $alias . $field;
3642         if ($prefix) {
3643             $result .= ' AS ' . $prefix . $field;
3644         }
3645     }
3646     return $result;
3649 /**
3650  * Returns the display name of a field in the user table. Works for most fields that are commonly displayed to users.
3651  * @param string $field Field name, e.g. 'phone1'
3652  * @return string Text description taken from language file, e.g. 'Phone number'
3653  */
3654 function get_user_field_name($field) {
3655     // Some fields have language strings which are not the same as field name.
3656     switch ($field) {
3657         case 'url' : {
3658             return get_string('webpage');
3659         }
3660         case 'icq' : {
3661             return get_string('icqnumber');
3662         }
3663         case 'skype' : {
3664             return get_string('skypeid');
3665         }
3666         case 'aim' : {
3667             return get_string('aimid');
3668         }
3669         case 'yahoo' : {
3670             return get_string('yahooid');
3671         }
3672         case 'msn' : {
3673             return get_string('msnid');
3674         }
3675         case 'picture' : {
3676             return get_string('pictureofuser');
3677         }
3678     }
3679     // Otherwise just use the same lang string.
3680     return get_string($field);
3683 /**
3684  * Returns whether a given authentication plugin exists.
3685  *
3686  * @param string $auth Form of authentication to check for. Defaults to the global setting in {@link $CFG}.
3687  * @return boolean Whether the plugin is available.
3688  */
3689 function exists_auth_plugin($auth) {
3690     global $CFG;
3692     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3693         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3694     }
3695     return false;
3698 /**
3699  * Checks if a given plugin is in the list of enabled authentication plugins.
3700  *
3701  * @param string $auth Authentication plugin.
3702  * @return boolean Whether the plugin is enabled.
3703  */
3704 function is_enabled_auth($auth) {
3705     if (empty($auth)) {
3706         return false;
3707     }
3709     $enabled = get_enabled_auth_plugins();
3711     return in_array($auth, $enabled);
3714 /**
3715  * Returns an authentication plugin instance.
3716  *
3717  * @param string $auth name of authentication plugin
3718  * @return auth_plugin_base An instance of the required authentication plugin.
3719  */
3720 function get_auth_plugin($auth) {
3721     global $CFG;
3723     // Check the plugin exists first.
3724     if (! exists_auth_plugin($auth)) {
3725         print_error('authpluginnotfound', 'debug', '', $auth);
3726     }
3728     // Return auth plugin instance.
3729     require_once("{$CFG->dirroot}/auth/$auth/auth.php");
3730     $class = "auth_plugin_$auth";
3731     return new $class;
3734 /**
3735  * Returns array of active auth plugins.
3736  *
3737  * @param bool $fix fix $CFG->auth if needed
3738  * @return array
3739  */
3740 function get_enabled_auth_plugins($fix=false) {
3741     global $CFG;
3743     $default = array('manual', 'nologin');
3745     if (empty($CFG->auth)) {
3746         $auths = array();
3747     } else {
3748         $auths = explode(',', $CFG->auth);
3749     }
3751     if ($fix) {
3752         $auths = array_unique($auths);
3753         foreach ($auths as $k => $authname) {
3754             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3755                 unset($auths[$k]);
3756             }
3757         }
3758         $newconfig = implode(',', $auths);
3759         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3760             set_config('auth', $newconfig);
3761         }
3762     }
3764     return (array_merge($default, $auths));
3767 /**
3768  * Returns true if an internal authentication method is being used.
3769  * if method not specified then, global default is assumed
3770  *
3771  * @param string $auth Form of authentication required
3772  * @return bool
3773  */
3774 function is_internal_auth($auth) {
3775     // Throws error if bad $auth.
3776     $authplugin = get_auth_plugin($auth);
3777     return $authplugin->is_internal();
3780 /**
3781  * Returns true if the user is a 'restored' one.
3782  *
3783  * Used in the login process to inform the user and allow him/her to reset the password
3784  *
3785  * @param string $username username to be checked
3786  * @return bool
3787  */
3788 function is_restored_user($username) {
3789     global $CFG, $DB;
3791     return $DB->record_exists('user', array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id, 'password' => 'restored'));
3794 /**
3795  * Returns an array of user fields
3796  *
3797  * @return array User field/column names
3798  */
3799 function get_user_fieldnames() {
3800     global $DB;
3802     $fieldarray = $DB->get_columns('user');
3803     unset($fieldarray['id']);
3804     $fieldarray = array_keys($fieldarray);
3806     return $fieldarray;
3809 /**
3810  * Creates a bare-bones user record
3811  *
3812  * @todo Outline auth types and provide code example
3813  *
3814  * @param string $username New user's username to add to record
3815  * @param string $password New user's password to add to record
3816  * @param string $auth Form of authentication required
3817  * @return stdClass A complete user object
3818  */
3819 function create_user_record($username, $password, $auth = 'manual') {
3820     global $CFG, $DB;
3821     require_once($CFG->dirroot.'/user/profile/lib.php');
3822     require_once($CFG->dirroot.'/user/lib.php');
3824     // Just in case check text case.
3825     $username = trim(core_text::strtolower($username));
3827     $authplugin = get_auth_plugin($auth);
3828     $customfields = $authplugin->get_custom_user_profile_fields();
3829     $newuser = new stdClass();
3830     if ($newinfo = $authplugin->get_userinfo($username)) {
3831         $newinfo = truncate_userinfo($newinfo);
3832         foreach ($newinfo as $key => $value) {
3833             if (in_array($key, $authplugin->userfields) || (in_array($key, $customfields))) {
3834                 $newuser->$key = $value;
3835             }
3836         }
3837     }
3839     if (!empty($newuser->email)) {
3840         if (email_is_not_allowed($newuser->email)) {
3841             unset($newuser->email);
3842         }
3843     }
3845     if (!isset($newuser->city)) {
3846         $newuser->city = '';
3847     }
3849     $newuser->auth = $auth;
3850     $newuser->username = $username;
3852     // Fix for MDL-8480
3853     // user CFG lang for user if $newuser->lang is empty
3854     // or $user->lang is not an installed language.
3855     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3856         $newuser->lang = $CFG->lang;
3857     }
3858     $newuser->confirmed = 1;
3859     $newuser->lastip = getremoteaddr();
3860     $newuser->timecreated = time();
3861     $newuser->timemodified = $newuser->timecreated;
3862     $newuser->mnethostid = $CFG->mnet_localhost_id;
3864     $newuser->id = user_create_user($newuser, false, false);
3866     // Save user profile data.
3867     profile_save_data($newuser);
3869     $user = get_complete_user_data('id', $newuser->id);
3870     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})) {
3871         set_user_preference('auth_forcepasswordchange', 1, $user);
3872     }
3873     // Set the password.
3874     update_internal_user_password($user, $password);
3876     // Trigger event.
3877     \core\event\user_created::create_from_userid($newuser->id)->trigger();
3879     return $user;
3882 /**
3883  * Will update a local user record from an external source (MNET users can not be updated using this method!).
3884  *
3885  * @param string $username user's username to update the record
3886  * @return stdClass A complete user object
3887  */
3888 function update_user_record($username) {
3889     global $DB, $CFG;
3890     // Just in case check text case.
3891     $username = trim(core_text::strtolower($username));
3893     $oldinfo = $DB->get_record('user', array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id), '*', MUST_EXIST);
3894     return update_user_record_by_id($oldinfo->id);
3897 /**
3898  * Will update a local user record from an external source (MNET users can not be updated using this method!).
3899  *
3900  * @param int $id user id
3901  * @return stdClass A complete user object
3902  */
3903 function update_user_record_by_id($id) {
3904     global $DB, $CFG;
3905     require_once($CFG->dirroot."/user/profile/lib.php");
3906     require_once($CFG->dirroot.'/user/lib.php');
3908     $params = array('mnethostid' => $CFG->mnet_localhost_id, 'id' => $id, 'deleted' => 0);
3909     $oldinfo = $DB->get_record('user', $params, '*', MUST_EXIST);
3911     $newuser = array();
3912     $userauth = get_auth_plugin($oldinfo->auth);
3914     if ($newinfo = $userauth->get_userinfo($oldinfo->username)) {
3915         $newinfo = truncate_userinfo($newinfo);
3916         $customfields = $userauth->get_custom_user_profile_fields();
3918         foreach ($newinfo as $key => $value) {
3919             $iscustom = in_array($key, $customfields);
3920             if (!$iscustom) {
3921                 $key = strtolower($key);
3922             }
3923             if ((!property_exists($oldinfo, $key) && !$iscustom) or $key === 'username' or $key === 'id'
3924                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3925                 // Unknown or must not be changed.
3926                 continue;
3927             }
3928             if (empty($userauth->config->{'field_updatelocal_' . $key}) || empty($userauth->config->{'field_lock_' . $key})) {
3929                 continue;
3930             }
3931             $confval = $userauth->config->{'field_updatelocal_' . $key};
3932             $lockval = $userauth->config->{'field_lock_' . $key};
3933             if ($confval === 'onlogin') {
3934                 // MDL-4207 Don't overwrite modified user profile values with
3935                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3936                 // of the setting 'unlocked if empty' is to allow the user to fill
3937                 // in a value for the selected field _if LDAP is giving
3938                 // nothing_ for this field. Thus it makes sense to let this value
3939                 // stand in until LDAP is giving a value for this field.
3940                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3941                     if ($iscustom || (in_array($key, $userauth->userfields) &&
3942                             ((string)$oldinfo->$key !== (string)$value))) {
3943                         $newuser[$key] = (string)$value;
3944                     }
3945                 }
3946             }
3947         }
3948         if ($newuser) {
3949             $newuser['id'] = $oldinfo->id;
3950             $newuser['timemodified'] = time();
3951             user_update_user((object) $newuser, false, false);
3953             // Save user profile data.
3954             profile_save_data((object) $newuser);
3956             // Trigger event.
3957             \core\event\user_updated::create_from_userid($newuser['id'])->trigger();
3958         }
3959     }
3961     return get_complete_user_data('id', $oldinfo->id);
3964 /**
3965  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth) which may have large fields.
3966  *
3967  * @param array $info Array of user properties to truncate if needed
3968  * @return array The now truncated information that was passed in
3969  */
3970 function truncate_userinfo(array $info) {
3971     // Define the limits.
3972     $limit = array(
3973         'username'    => 100,
3974         'idnumber'    => 255,
3975         'firstname'   => 100,
3976         'lastname'    => 100,
3977         'email'       => 100,
3978         'icq'         =>  15,
3979         'phone1'      =>  20,
3980         'phone2'      =>  20,
3981         'institution' => 255,
3982         'department'  => 255,
3983         'address'     => 255,
3984         'city'        => 120,
3985         'country'     =>   2,
3986         'url'         => 255,
3987     );
3989     // Apply where needed.
3990     foreach (array_keys($info) as $key) {
3991         if (!empty($limit[$key])) {
3992             $info[$key] = trim(core_text::substr($info[$key], 0, $limit[$key]));
3993         }
3994     }
3996     return $info;
3999 /**
4000  * Marks user deleted in internal user database and notifies the auth plugin.
4001  * Also unenrols user from all roles and does other cleanup.
4002  *
4003  * Any plugin that needs to purge user data should register the 'user_deleted' event.
4004  *
4005  * @param stdClass $user full user object before delete
4006  * @return boolean success
4007  * @throws coding_exception if invalid $user parameter detected
4008  */
4009 function delete_user(stdClass $user) {
4010     global $CFG, $DB;
4011     require_once($CFG->libdir.'/grouplib.php');
4012     require_once($CFG->libdir.'/gradelib.php');
4013     require_once($CFG->dirroot.'/message/lib.php');
4014     require_once($CFG->dirroot.'/user/lib.php');
4016     // Make sure nobody sends bogus record type as parameter.
4017     if (!property_exists($user, 'id') or !property_exists($user, 'username')) {
4018         throw new coding_exception('Invalid $user parameter in delete_user() detected');
4019     }
4021     // Better not trust the parameter and fetch the latest info this will be very expensive anyway.
4022     if (!$user = $DB->get_record('user', array('id' => $user->id))) {
4023         debugging('Attempt to delete unknown user account.');
4024         return false;
4025     }
4027     // There must be always exactly one guest record, originally the guest account was identified by username only,
4028     // now we use $CFG->siteguest for performance reasons.
4029     if ($user->username === 'guest' or isguestuser($user)) {
4030         debugging('Guest user account can not be deleted.');
4031         return false;
4032     }
4034     // Admin can be theoretically from different auth plugin, but we want to prevent deletion of internal accoutns only,
4035     // if anything goes wrong ppl may force somebody to be admin via config.php setting $CFG->siteadmins.
4036     if ($user->auth === 'manual' and is_siteadmin($user)) {
4037         debugging('Local administrator accounts can not be deleted.');
4038         return false;
4039     }
4041     // Allow plugins to use this user object before we completely delete it.
4042     if ($pluginsfunction = get_plugins_with_function('pre_user_delete')) {
4043         foreach ($pluginsfunction as $plugintype => $plugins) {
4044             foreach ($plugins as $pluginfunction) {
4045                 $pluginfunction($user);
4046             }
4047         }
4048     }
4050     // Keep user record before updating it, as we have to pass this to user_deleted event.
4051     $olduser = clone $user;
4053     // Keep a copy of user context, we need it for event.
4054     $usercontext = context_user::instance($user->id);
4056     // Delete all grades - backup is kept in grade_grades_history table.
4057     grade_user_delete($user->id);
4059     // TODO: remove from cohorts using standard API here.
4061     // Remove user tags.
4062     core_tag_tag::remove_all_item_tags('core', 'user', $user->id);
4064     // Unconditionally unenrol from all courses.
4065     enrol_user_delete($user);
4067     // Unenrol from all roles in all contexts.
4068     // This might be slow but it is really needed - modules might do some extra cleanup!
4069     role_unassign_all(array('userid' => $user->id));
4071     // Now do a brute force cleanup.
4073     // Remove from all cohorts.
4074     $DB->delete_records('cohort_members', array('userid' => $user->id));
4076     // Remove from all groups.
4077     $DB->delete_records('groups_members', array('userid' => $user->id));
4079     // Brute force unenrol from all courses.
4080     $DB->delete_records('user_enrolments', array('userid' => $user->id));
4082     // Purge user preferences.
4083     $DB->delete_records('user_preferences', array('userid' => $user->id));
4085     // Purge user extra profile info.
4086     $DB->delete_records('user_info_data', array('userid' => $user->id));
4088     // Purge log of previous password hashes.
4089     $DB->delete_records('user_password_history', array('userid' => $user->id));
4091     // Last course access not necessary either.
4092     $DB->delete_records('user_lastaccess', array('userid' => $user->id));
4093     // Remove all user tokens.
4094     $DB->delete_records('external_tokens', array('userid' => $user->id));
4096     // Unauthorise the user for all services.
4097     $DB->delete_records('external_services_users', array('userid' => $user->id));
4099     // Remove users private keys.
4100     $DB->delete_records('user_private_key', array('userid' => $user->id));
4102     // Remove users customised pages.
4103     $DB->delete_records('my_pages', array('userid' => $user->id, 'private' => 1));
4105     // Force logout - may fail if file based sessions used, sorry.
4106     \core\session\manager::kill_user_sessions($user->id);
4108     // Generate username from email address, or a fake email.
4109     $delemail = !empty($user->email) ? $user->email : $user->username . '.' . $user->id . '@unknownemail.invalid';
4110     $delname = clean_param($delemail . "." . time(), PARAM_USERNAME);
4112     // Workaround for bulk deletes of users with the same email address.
4113     while ($DB->record_exists('user', array('username' => $delname))) { // No need to use mnethostid here.
4114         $delname++;
4115     }
4117     // Mark internal user record as "deleted".
4118     $updateuser = new stdClass();
4119     $updateuser->id           = $user->id;
4120     $updateuser->deleted      = 1;
4121     $updateuser->username     = $delname;            // Remember it just in case.
4122     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users.
4123     $updateuser->idnumber     = '';                  // Clear this field to free it up.
4124     $updateuser->picture      = 0;
4125     $updateuser->timemodified = time();
4127     // Don't trigger update event, as user is being deleted.
4128     user_update_user($updateuser, false, false);
4130     // Now do a final accesslib cleanup - removes all role assignments in user context and context itself.
4131     context_helper::delete_instance(CONTEXT_USER, $user->id);
4133     // Any plugin that needs to cleanup should register this event.
4134     // Trigger event.
4135     $event = \core\event\user_deleted::create(
4136             array(
4137                 'objectid' => $user->id,
4138                 'relateduserid' => $user->id,
4139                 'context' => $usercontext,
4140                 'other' => array(
4141                     'username' => $user->username,
4142                     'email' => $user->email,
4143                     'idnumber' => $user->idnumber,
4144                     'picture' => $user->picture,
4145                     'mnethostid' => $user->mnethostid
4146                     )
4147                 )
4148             );
4149     $event->add_record_snapshot('user', $olduser);
4150     $event->trigger();
4152     // We will update the user's timemodified, as it will be passed to the user_deleted event, which
4153     // should know about this updated property persisted to the user's table.
4154     $user->timemodified = $updateuser->timemodified;
4156     // Notify auth plugin - do not block the delete even when plugin fails.
4157     $authplugin = get_auth_plugin($user->auth);
4158     $authplugin->user_delete($user);
4160     return true;
4163 /**
4164  * Retrieve the guest user object.
4165  *
4166  * @return stdClass A {@link $USER} object
4167  */
4168 function guest_user() {
4169     global $CFG, $DB;
4171     if ($newuser = $DB->get_record('user', array('id' => $CFG->siteguest))) {
4172         $newuser->confirmed = 1;
4173         $newuser->lang = $CFG->lang;
4174         $newuser->lastip = getremoteaddr();
4175     }
4177     return $newuser;
4180 /**
4181  * Authenticates a user against the chosen authentication mechanism
4182  *
4183  * Given a username and password, this function looks them
4184  * up using the currently selected authentication mechanism,
4185  * and if the authentication is successful, it returns a
4186  * valid $user object from the 'user' table.
4187  *
4188  * Uses auth_ functions from the currently active auth module
4189  *
4190  * After authenticate_user_login() returns success, you will need to
4191  * log that the user has logged in, and call complete_user_login() to set
4192  * the session up.
4193  *
4194  * Note: this function works only with non-mnet accounts!
4195  *
4196  * @param string $username  User's username (or also email if $CFG->authloginviaemail enabled)
4197  * @param string $password  User's password
4198  * @param bool $ignorelockout useful when guessing is prevented by other mechanism such as captcha or SSO
4199  * @param int $failurereason login failure reason, can be used in renderers (it may disclose if account exists)
4200  * @return stdClass|false A {@link $USER} object or false if error
4201  */
4202 function authenticate_user_login($username, $password, $ignorelockout=false, &$failurereason=null) {
4203     global $CFG, $DB;
4204     require_once("$CFG->libdir/authlib.php");
4206     if ($user = get_complete_user_data('username', $username, $CFG->mnet_localhost_id)) {
4207         // we have found the user
4209     } else if (!empty($CFG->authloginviaemail)) {
4210         if ($email = clean_param($username, PARAM_EMAIL)) {
4211             $select = "mnethostid = :mnethostid AND LOWER(email) = LOWER(:email) AND deleted = 0";
4212             $params = array('mnethostid' => $CFG->mnet_localhost_id, 'email' => $email);
4213             $users = $DB->get_records_select('user', $select, $params, 'id', 'id', 0, 2);
4214             if (count($users) === 1) {
4215                 // Use email for login only if unique.
4216                 $user = reset($users);
4217                 $user = get_complete_user_data('id', $user->id);
4218                 $username = $user->username;
4219             }
4220             unset($users);
4221         }
4222     }
4224     $authsenabled = get_enabled_auth_plugins();
4226     if ($user) {
4227         // Use manual if auth not set.
4228         $auth = empty($user->auth) ? 'manual' : $user->auth;
4230         if (in_array($user->auth, $authsenabled)) {
4231             $authplugin = get_auth_plugin($user->auth);
4232             $authplugin->pre_user_login_hook($user);
4233         }
4235         if (!empty($user->suspended)) {
4236             $failurereason = AUTH_LOGIN_SUSPENDED;
4238             // Trigger login failed event.
4239             $event = \core\event\user_login_failed::create(array('userid' => $user->id,
4240                     'other' => array('username' => $username, 'reason' => $failurereason)));
4241             $event->trigger();
4242             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4243             return false;
4244         }
4245         if ($auth=='nologin' or !is_enabled_auth($auth)) {
4246             // Legacy way to suspend user.
4247             $failurereason = AUTH_LOGIN_SUSPENDED;
4249             // Trigger login failed event.
4250             $event = \core\event\user_login_failed::create(array('userid' => $user->id,
4251                     'other' => array('username' => $username, 'reason' => $failurereason)));
4252             $event->trigger();
4253             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4254             return false;
4255         }
4256         $auths = array($auth);
4258     } else {
4259         // Check if there's a deleted record (cheaply), this should not happen because we mangle usernames in delete_user().
4260         if ($DB->get_field('user', 'id', array('username' => $username, 'mnethostid' => $CFG->mnet_localhost_id,  'deleted' => 1))) {
4261             $failurereason = AUTH_LOGIN_NOUSER;
4263             // Trigger login failed event.
4264             $event = \core\event\user_login_failed::create(array('other' => array('username' => $username,
4265                     'reason' => $failurereason)));
4266             $event->trigger();
4267             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4268             return false;
4269         }
4271         // User does not exist.
4272         $auths = $authsenabled;
4273         $user = new stdClass();
4274         $user->id = 0;
4275     }
4277     if ($ignorelockout) {
4278         // Some other mechanism protects against brute force password guessing, for example login form might include reCAPTCHA
4279         // or this function is called from a SSO script.
4280     } else if ($user->id) {
4281         // Verify login lockout after other ways that may prevent user login.
4282         if (login_is_lockedout($user)) {
4283             $failurereason = AUTH_LOGIN_LOCKOUT;
4285             // Trigger login failed event.
4286             $event = \core\event\user_login_failed::create(array('userid' => $user->id,
4287                     'other' => array('username' => $username, 'reason' => $failurereason)));
4288             $event->trigger();
4290             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Login lockout:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4291             return false;
4292         }
4293     } else {
4294         // We can not lockout non-existing accounts.
4295     }
4297     foreach ($auths as $auth) {
4298         $authplugin = get_auth_plugin($auth);
4300         // On auth fail fall through to the next plugin.
4301         if (!$authplugin->user_login($username, $password)) {
4302             continue;
4303         }
4305         // Successful authentication.
4306         if ($user->id) {
4307             // User already exists in database.
4308             if (empty($user->auth)) {
4309                 // For some reason auth isn't set yet.
4310                 $DB->set_field('user', 'auth', $auth, array('id' => $user->id));
4311                 $user->auth = $auth;
4312             }
4314             // If the existing hash is using an out-of-date algorithm (or the legacy md5 algorithm), then we should update to
4315             // the current hash algorithm while we have access to the user's password.
4316             update_internal_user_password($user, $password);