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