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