Merge branch 'wip-MDL-40356-master' of git://github.com/abgreeve/moodle
[moodle.git] / lib / moodlelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * moodlelib.php - Moodle main library
19  *
20  * Main library file of miscellaneous general-purpose Moodle functions.
21  * Other main libraries:
22  *  - weblib.php      - functions that produce web output
23  *  - datalib.php     - functions that access the database
24  *
25  * @package    core
26  * @subpackage lib
27  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 defined('MOODLE_INTERNAL') || die();
33 // CONSTANTS (Encased in phpdoc proper comments).
35 // Date and time constants.
36 /**
37  * Time constant - the number of seconds in a year
38  */
39 define('YEARSECS', 31536000);
41 /**
42  * Time constant - the number of seconds in a week
43  */
44 define('WEEKSECS', 604800);
46 /**
47  * Time constant - the number of seconds in a day
48  */
49 define('DAYSECS', 86400);
51 /**
52  * Time constant - the number of seconds in an hour
53  */
54 define('HOURSECS', 3600);
56 /**
57  * Time constant - the number of seconds in a minute
58  */
59 define('MINSECS', 60);
61 /**
62  * Time constant - the number of minutes in a day
63  */
64 define('DAYMINS', 1440);
66 /**
67  * Time constant - the number of minutes in an hour
68  */
69 define('HOURMINS', 60);
71 // Parameter constants - every call to optional_param(), required_param()
72 // or clean_param() should have a specified type of parameter.
74 /**
75  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
76  */
77 define('PARAM_ALPHA',    'alpha');
79 /**
80  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
81  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
82  */
83 define('PARAM_ALPHAEXT', 'alphaext');
85 /**
86  * PARAM_ALPHANUM - expected numbers and letters only.
87  */
88 define('PARAM_ALPHANUM', 'alphanum');
90 /**
91  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
92  */
93 define('PARAM_ALPHANUMEXT', 'alphanumext');
95 /**
96  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
97  */
98 define('PARAM_AUTH',  'auth');
100 /**
101  * PARAM_BASE64 - Base 64 encoded format
102  */
103 define('PARAM_BASE64',   'base64');
105 /**
106  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
107  */
108 define('PARAM_BOOL',     'bool');
110 /**
111  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
112  * checked against the list of capabilities in the database.
113  */
114 define('PARAM_CAPABILITY',   'capability');
116 /**
117  * PARAM_CLEANHTML - cleans submitted HTML code. Note that you almost never want
118  * to use this. The normal mode of operation is to use PARAM_RAW when 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 if module supports outcomes */
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)) {
1035                 if (preg_match(':^/:', $param)) {
1036                     // Root-relative, ok!
1037                 } else if (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i', $param)) {
1038                     // Absolute, and matches our wwwroot.
1039                 } else {
1040                     // Relative - let's make sure there are no tricks.
1041                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1042                         // Looks ok.
1043                     } else {
1044                         $param = '';
1045                     }
1046                 }
1047             }
1048             return $param;
1050         case PARAM_PEM:
1051             $param = trim($param);
1052             // PEM formatted strings may contain letters/numbers and the symbols:
1053             //   forward slash: /
1054             //   plus sign:     +
1055             //   equal sign:    =
1056             //   , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
1057             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1058                 list($wholething, $body) = $matches;
1059                 unset($wholething, $matches);
1060                 $b64 = clean_param($body, PARAM_BASE64);
1061                 if (!empty($b64)) {
1062                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1063                 } else {
1064                     return '';
1065                 }
1066             }
1067             return '';
1069         case PARAM_BASE64:
1070             if (!empty($param)) {
1071                 // PEM formatted strings may contain letters/numbers and the symbols
1072                 //   forward slash: /
1073                 //   plus sign:     +
1074                 //   equal sign:    =.
1075                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1076                     return '';
1077                 }
1078                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1079                 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1080                 // than (or equal to) 64 characters long.
1081                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1082                     if ($i + 1 == $j) {
1083                         if (64 < strlen($lines[$i])) {
1084                             return '';
1085                         }
1086                         continue;
1087                     }
1089                     if (64 != strlen($lines[$i])) {
1090                         return '';
1091                     }
1092                 }
1093                 return implode("\n", $lines);
1094             } else {
1095                 return '';
1096             }
1098         case PARAM_TAG:
1099             $param = fix_utf8($param);
1100             // Please note it is not safe to use the tag name directly anywhere,
1101             // it must be processed with s(), urlencode() before embedding anywhere.
1102             // Remove some nasties.
1103             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1104             // Convert many whitespace chars into one.
1105             $param = preg_replace('/\s+/', ' ', $param);
1106             $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
1107             return $param;
1109         case PARAM_TAGLIST:
1110             $param = fix_utf8($param);
1111             $tags = explode(',', $param);
1112             $result = array();
1113             foreach ($tags as $tag) {
1114                 $res = clean_param($tag, PARAM_TAG);
1115                 if ($res !== '') {
1116                     $result[] = $res;
1117                 }
1118             }
1119             if ($result) {
1120                 return implode(',', $result);
1121             } else {
1122                 return '';
1123             }
1125         case PARAM_CAPABILITY:
1126             if (get_capability_info($param)) {
1127                 return $param;
1128             } else {
1129                 return '';
1130             }
1132         case PARAM_PERMISSION:
1133             $param = (int)$param;
1134             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1135                 return $param;
1136             } else {
1137                 return CAP_INHERIT;
1138             }
1140         case PARAM_AUTH:
1141             $param = clean_param($param, PARAM_PLUGIN);
1142             if (empty($param)) {
1143                 return '';
1144             } else if (exists_auth_plugin($param)) {
1145                 return $param;
1146             } else {
1147                 return '';
1148             }
1150         case PARAM_LANG:
1151             $param = clean_param($param, PARAM_SAFEDIR);
1152             if (get_string_manager()->translation_exists($param)) {
1153                 return $param;
1154             } else {
1155                 // Specified language is not installed or param malformed.
1156                 return '';
1157             }
1159         case PARAM_THEME:
1160             $param = clean_param($param, PARAM_PLUGIN);
1161             if (empty($param)) {
1162                 return '';
1163             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1164                 return $param;
1165             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1166                 return $param;
1167             } else {
1168                 // Specified theme is not installed.
1169                 return '';
1170             }
1172         case PARAM_USERNAME:
1173             $param = fix_utf8($param);
1174             $param = str_replace(" " , "", $param);
1175             // Convert uppercase to lowercase MDL-16919.
1176             $param = core_text::strtolower($param);
1177             if (empty($CFG->extendedusernamechars)) {
1178                 // Regular expression, eliminate all chars EXCEPT:
1179                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1180                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1181             }
1182             return $param;
1184         case PARAM_EMAIL:
1185             $param = fix_utf8($param);
1186             if (validate_email($param)) {
1187                 return $param;
1188             } else {
1189                 return '';
1190             }
1192         case PARAM_STRINGID:
1193             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1194                 return $param;
1195             } else {
1196                 return '';
1197             }
1199         case PARAM_TIMEZONE:
1200             // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
1201             $param = fix_utf8($param);
1202             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1203             if (preg_match($timezonepattern, $param)) {
1204                 return $param;
1205             } else {
1206                 return '';
1207             }
1209         default:
1210             // Doh! throw error, switched parameters in optional_param or another serious problem.
1211             print_error("unknownparamtype", '', '', $type);
1212     }
1215 /**
1216  * Makes sure the data is using valid utf8, invalid characters are discarded.
1217  *
1218  * Note: this function is not intended for full objects with methods and private properties.
1219  *
1220  * @param mixed $value
1221  * @return mixed with proper utf-8 encoding
1222  */
1223 function fix_utf8($value) {
1224     if (is_null($value) or $value === '') {
1225         return $value;
1227     } else if (is_string($value)) {
1228         if ((string)(int)$value === $value) {
1229             // Shortcut.
1230             return $value;
1231         }
1232         // No null bytes expected in our data, so let's remove it.
1233         $value = str_replace("\0", '', $value);
1235         // Note: this duplicates min_fix_utf8() intentionally.
1236         static $buggyiconv = null;
1237         if ($buggyiconv === null) {
1238             $buggyiconv = (!function_exists('iconv') or @iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1239         }
1241         if ($buggyiconv) {
1242             if (function_exists('mb_convert_encoding')) {
1243                 $subst = mb_substitute_character();
1244                 mb_substitute_character('');
1245                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1246                 mb_substitute_character($subst);
1248             } else {
1249                 // Warn admins on admin/index.php page.
1250                 $result = $value;
1251             }
1253         } else {
1254             $result = @iconv('UTF-8', 'UTF-8//IGNORE', $value);
1255         }
1257         return $result;
1259     } else if (is_array($value)) {
1260         foreach ($value as $k => $v) {
1261             $value[$k] = fix_utf8($v);
1262         }
1263         return $value;
1265     } else if (is_object($value)) {
1266         // Do not modify original.
1267         $value = clone($value);
1268         foreach ($value as $k => $v) {
1269             $value->$k = fix_utf8($v);
1270         }
1271         return $value;
1273     } else {
1274         // This is some other type, no utf-8 here.
1275         return $value;
1276     }
1279 /**
1280  * Return true if given value is integer or string with integer value
1281  *
1282  * @param mixed $value String or Int
1283  * @return bool true if number, false if not
1284  */
1285 function is_number($value) {
1286     if (is_int($value)) {
1287         return true;
1288     } else if (is_string($value)) {
1289         return ((string)(int)$value) === $value;
1290     } else {
1291         return false;
1292     }
1295 /**
1296  * Returns host part from url.
1297  *
1298  * @param string $url full url
1299  * @return string host, null if not found
1300  */
1301 function get_host_from_url($url) {
1302     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1303     if ($matches) {
1304         return $matches[1];
1305     }
1306     return null;
1309 /**
1310  * Tests whether anything was returned by text editor
1311  *
1312  * This function is useful for testing whether something you got back from
1313  * the HTML editor actually contains anything. Sometimes the HTML editor
1314  * appear to be empty, but actually you get back a <br> tag or something.
1315  *
1316  * @param string $string a string containing HTML.
1317  * @return boolean does the string contain any actual content - that is text,
1318  * images, objects, etc.
1319  */
1320 function html_is_blank($string) {
1321     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1324 /**
1325  * Set a key in global configuration
1326  *
1327  * Set a key/value pair in both this session's {@link $CFG} global variable
1328  * and in the 'config' database table for future sessions.
1329  *
1330  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1331  * In that case it doesn't affect $CFG.
1332  *
1333  * A NULL value will delete the entry.
1334  *
1335  * NOTE: this function is called from lib/db/upgrade.php
1336  *
1337  * @param string $name the key to set
1338  * @param string $value the value to set (without magic quotes)
1339  * @param string $plugin (optional) the plugin scope, default null
1340  * @return bool true or exception
1341  */
1342 function set_config($name, $value, $plugin=null) {
1343     global $CFG, $DB;
1345     if (empty($plugin)) {
1346         if (!array_key_exists($name, $CFG->config_php_settings)) {
1347             // So it's defined for this invocation at least.
1348             if (is_null($value)) {
1349                 unset($CFG->$name);
1350             } else {
1351                 // Settings from db are always strings.
1352                 $CFG->$name = (string)$value;
1353             }
1354         }
1356         if ($DB->get_field('config', 'name', array('name' => $name))) {
1357             if ($value === null) {
1358                 $DB->delete_records('config', array('name' => $name));
1359             } else {
1360                 $DB->set_field('config', 'value', $value, array('name' => $name));
1361             }
1362         } else {
1363             if ($value !== null) {
1364                 $config = new stdClass();
1365                 $config->name  = $name;
1366                 $config->value = $value;
1367                 $DB->insert_record('config', $config, false);
1368             }
1369         }
1370         if ($name === 'siteidentifier') {
1371             cache_helper::update_site_identifier($value);
1372         }
1373         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1374     } else {
1375         // Plugin scope.
1376         if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
1377             if ($value===null) {
1378                 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1379             } else {
1380                 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
1381             }
1382         } else {
1383             if ($value !== null) {
1384                 $config = new stdClass();
1385                 $config->plugin = $plugin;
1386                 $config->name   = $name;
1387                 $config->value  = $value;
1388                 $DB->insert_record('config_plugins', $config, false);
1389             }
1390         }
1391         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1392     }
1394     return true;
1397 /**
1398  * Get configuration values from the global config table
1399  * or the config_plugins table.
1400  *
1401  * If called with one parameter, it will load all the config
1402  * variables for one plugin, and return them as an object.
1403  *
1404  * If called with 2 parameters it will return a string single
1405  * value or false if the value is not found.
1406  *
1407  * NOTE: this function is called from lib/db/upgrade.php
1408  *
1409  * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
1410  *     that we need only fetch it once per request.
1411  * @param string $plugin full component name
1412  * @param string $name default null
1413  * @return mixed hash-like object or single value, return false no config found
1414  * @throws dml_exception
1415  */
1416 function get_config($plugin, $name = null) {
1417     global $CFG, $DB;
1419     static $siteidentifier = null;
1421     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1422         $forced =& $CFG->config_php_settings;
1423         $iscore = true;
1424         $plugin = 'core';
1425     } else {
1426         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1427             $forced =& $CFG->forced_plugin_settings[$plugin];
1428         } else {
1429             $forced = array();
1430         }
1431         $iscore = false;
1432     }
1434     if ($siteidentifier === null) {
1435         try {
1436             // This may fail during installation.
1437             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1438             // install the database.
1439             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1440         } catch (dml_exception $ex) {
1441             // Set siteidentifier to false. We don't want to trip this continually.
1442             $siteidentifier = false;
1443             throw $ex;
1444         }
1445     }
1447     if (!empty($name)) {
1448         if (array_key_exists($name, $forced)) {
1449             return (string)$forced[$name];
1450         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1451             return $siteidentifier;
1452         }
1453     }
1455     $cache = cache::make('core', 'config');
1456     $result = $cache->get($plugin);
1457     if ($result === false) {
1458         // The user is after a recordset.
1459         if (!$iscore) {
1460             $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
1461         } else {
1462             // This part is not really used any more, but anyway...
1463             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1464         }
1465         $cache->set($plugin, $result);
1466     }
1468     if (!empty($name)) {
1469         if (array_key_exists($name, $result)) {
1470             return $result[$name];
1471         }
1472         return false;
1473     }
1475     if ($plugin === 'core') {
1476         $result['siteidentifier'] = $siteidentifier;
1477     }
1479     foreach ($forced as $key => $value) {
1480         if (is_null($value) or is_array($value) or is_object($value)) {
1481             // We do not want any extra mess here, just real settings that could be saved in db.
1482             unset($result[$key]);
1483         } else {
1484             // Convert to string as if it went through the DB.
1485             $result[$key] = (string)$value;
1486         }
1487     }
1489     return (object)$result;
1492 /**
1493  * Removes a key from global configuration.
1494  *
1495  * NOTE: this function is called from lib/db/upgrade.php
1496  *
1497  * @param string $name the key to set
1498  * @param string $plugin (optional) the plugin scope
1499  * @return boolean whether the operation succeeded.
1500  */
1501 function unset_config($name, $plugin=null) {
1502     global $CFG, $DB;
1504     if (empty($plugin)) {
1505         unset($CFG->$name);
1506         $DB->delete_records('config', array('name' => $name));
1507         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1508     } else {
1509         $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1510         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1511     }
1513     return true;
1516 /**
1517  * Remove all the config variables for a given plugin.
1518  *
1519  * NOTE: this function is called from lib/db/upgrade.php
1520  *
1521  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1522  * @return boolean whether the operation succeeded.
1523  */
1524 function unset_all_config_for_plugin($plugin) {
1525     global $DB;
1526     // Delete from the obvious config_plugins first.
1527     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1528     // Next delete any suspect settings from config.
1529     $like = $DB->sql_like('name', '?', true, true, false, '|');
1530     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1531     $DB->delete_records_select('config', $like, $params);
1532     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1533     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1535     return true;
1538 /**
1539  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1540  *
1541  * All users are verified if they still have the necessary capability.
1542  *
1543  * @param string $value the value of the config setting.
1544  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1545  * @param bool $includeadmins include administrators.
1546  * @return array of user objects.
1547  */
1548 function get_users_from_config($value, $capability, $includeadmins = true) {
1549     if (empty($value) or $value === '$@NONE@$') {
1550         return array();
1551     }
1553     // We have to make sure that users still have the necessary capability,
1554     // it should be faster to fetch them all first and then test if they are present
1555     // instead of validating them one-by-one.
1556     $users = get_users_by_capability(context_system::instance(), $capability);
1557     if ($includeadmins) {
1558         $admins = get_admins();
1559         foreach ($admins as $admin) {
1560             $users[$admin->id] = $admin;
1561         }
1562     }
1564     if ($value === '$@ALL@$') {
1565         return $users;
1566     }
1568     $result = array(); // Result in correct order.
1569     $allowed = explode(',', $value);
1570     foreach ($allowed as $uid) {
1571         if (isset($users[$uid])) {
1572             $user = $users[$uid];
1573             $result[$user->id] = $user;
1574         }
1575     }
1577     return $result;
1581 /**
1582  * Invalidates browser caches and cached data in temp.
1583  *
1584  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1585  * {@link phpunit_util::reset_dataroot()}
1586  *
1587  * @return void
1588  */
1589 function purge_all_caches() {
1590     global $CFG, $DB;
1592     reset_text_filters_cache();
1593     js_reset_all_caches();
1594     theme_reset_all_caches();
1595     get_string_manager()->reset_caches();
1596     core_text::reset_caches();
1597     if (class_exists('core_plugin_manager')) {
1598         core_plugin_manager::reset_caches();
1599     }
1601     // Bump up cacherev field for all courses.
1602     try {
1603         increment_revision_number('course', 'cacherev', '');
1604     } catch (moodle_exception $e) {
1605         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1606     }
1608     $DB->reset_caches();
1609     cache_helper::purge_all();
1611     // Purge all other caches: rss, simplepie, etc.
1612     remove_dir($CFG->cachedir.'', true);
1614     // Make sure cache dir is writable, throws exception if not.
1615     make_cache_directory('');
1617     // This is the only place where we purge local caches, we are only adding files there.
1618     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1619     remove_dir($CFG->localcachedir, true);
1620     set_config('localcachedirpurged', time());
1621     make_localcache_directory('', true);
1622     \core\task\manager::clear_static_caches();
1625 /**
1626  * Get volatile flags
1627  *
1628  * @param string $type
1629  * @param int $changedsince default null
1630  * @return array records array
1631  */
1632 function get_cache_flags($type, $changedsince = null) {
1633     global $DB;
1635     $params = array('type' => $type, 'expiry' => time());
1636     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1637     if ($changedsince !== null) {
1638         $params['changedsince'] = $changedsince;
1639         $sqlwhere .= " AND timemodified > :changedsince";
1640     }
1641     $cf = array();
1642     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1643         foreach ($flags as $flag) {
1644             $cf[$flag->name] = $flag->value;
1645         }
1646     }
1647     return $cf;
1650 /**
1651  * Get volatile flags
1652  *
1653  * @param string $type
1654  * @param string $name
1655  * @param int $changedsince default null
1656  * @return string|false The cache flag value or false
1657  */
1658 function get_cache_flag($type, $name, $changedsince=null) {
1659     global $DB;
1661     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1663     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1664     if ($changedsince !== null) {
1665         $params['changedsince'] = $changedsince;
1666         $sqlwhere .= " AND timemodified > :changedsince";
1667     }
1669     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1672 /**
1673  * Set a volatile flag
1674  *
1675  * @param string $type the "type" namespace for the key
1676  * @param string $name the key to set
1677  * @param string $value the value to set (without magic quotes) - null will remove the flag
1678  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1679  * @return bool Always returns true
1680  */
1681 function set_cache_flag($type, $name, $value, $expiry = null) {
1682     global $DB;
1684     $timemodified = time();
1685     if ($expiry === null || $expiry < $timemodified) {
1686         $expiry = $timemodified + 24 * 60 * 60;
1687     } else {
1688         $expiry = (int)$expiry;
1689     }
1691     if ($value === null) {
1692         unset_cache_flag($type, $name);
1693         return true;
1694     }
1696     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1697         // This is a potential problem in DEBUG_DEVELOPER.
1698         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1699             return true; // No need to update.
1700         }
1701         $f->value        = $value;
1702         $f->expiry       = $expiry;
1703         $f->timemodified = $timemodified;
1704         $DB->update_record('cache_flags', $f);
1705     } else {
1706         $f = new stdClass();
1707         $f->flagtype     = $type;
1708         $f->name         = $name;
1709         $f->value        = $value;
1710         $f->expiry       = $expiry;
1711         $f->timemodified = $timemodified;
1712         $DB->insert_record('cache_flags', $f);
1713     }
1714     return true;
1717 /**
1718  * Removes a single volatile flag
1719  *
1720  * @param string $type the "type" namespace for the key
1721  * @param string $name the key to set
1722  * @return bool
1723  */
1724 function unset_cache_flag($type, $name) {
1725     global $DB;
1726     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1727     return true;
1730 /**
1731  * Garbage-collect volatile flags
1732  *
1733  * @return bool Always returns true
1734  */
1735 function gc_cache_flags() {
1736     global $DB;
1737     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1738     return true;
1741 // USER PREFERENCE API.
1743 /**
1744  * Refresh user preference cache. This is used most often for $USER
1745  * object that is stored in session, but it also helps with performance in cron script.
1746  *
1747  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1748  *
1749  * @package  core
1750  * @category preference
1751  * @access   public
1752  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1753  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1754  * @throws   coding_exception
1755  * @return   null
1756  */
1757 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1758     global $DB;
1759     // Static cache, we need to check on each page load, not only every 2 minutes.
1760     static $loadedusers = array();
1762     if (!isset($user->id)) {
1763         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1764     }
1766     if (empty($user->id) or isguestuser($user->id)) {
1767         // No permanent storage for not-logged-in users and guest.
1768         if (!isset($user->preference)) {
1769             $user->preference = array();
1770         }
1771         return;
1772     }
1774     $timenow = time();
1776     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1777         // Already loaded at least once on this page. Are we up to date?
1778         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1779             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1780             return;
1782         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1783             // No change since the lastcheck on this page.
1784             $user->preference['_lastloaded'] = $timenow;
1785             return;
1786         }
1787     }
1789     // OK, so we have to reload all preferences.
1790     $loadedusers[$user->id] = true;
1791     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1792     $user->preference['_lastloaded'] = $timenow;
1795 /**
1796  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1797  *
1798  * NOTE: internal function, do not call from other code.
1799  *
1800  * @package core
1801  * @access private
1802  * @param integer $userid the user whose prefs were changed.
1803  */
1804 function mark_user_preferences_changed($userid) {
1805     global $CFG;
1807     if (empty($userid) or isguestuser($userid)) {
1808         // No cache flags for guest and not-logged-in users.
1809         return;
1810     }
1812     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1815 /**
1816  * Sets a preference for the specified user.
1817  *
1818  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1819  *
1820  * @package  core
1821  * @category preference
1822  * @access   public
1823  * @param    string            $name  The key to set as preference for the specified user
1824  * @param    string            $value The value to set for the $name key in the specified user's
1825  *                                    record, null means delete current value.
1826  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1827  * @throws   coding_exception
1828  * @return   bool                     Always true or exception
1829  */
1830 function set_user_preference($name, $value, $user = null) {
1831     global $USER, $DB;
1833     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1834         throw new coding_exception('Invalid preference name in set_user_preference() call');
1835     }
1837     if (is_null($value)) {
1838         // Null means delete current.
1839         return unset_user_preference($name, $user);
1840     } else if (is_object($value)) {
1841         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1842     } else if (is_array($value)) {
1843         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1844     }
1845     // Value column maximum length is 1333 characters.
1846     $value = (string)$value;
1847     if (core_text::strlen($value) > 1333) {
1848         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1849     }
1851     if (is_null($user)) {
1852         $user = $USER;
1853     } else if (isset($user->id)) {
1854         // It is a valid object.
1855     } else if (is_numeric($user)) {
1856         $user = (object)array('id' => (int)$user);
1857     } else {
1858         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1859     }
1861     check_user_preferences_loaded($user);
1863     if (empty($user->id) or isguestuser($user->id)) {
1864         // No permanent storage for not-logged-in users and guest.
1865         $user->preference[$name] = $value;
1866         return true;
1867     }
1869     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1870         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1871             // Preference already set to this value.
1872             return true;
1873         }
1874         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1876     } else {
1877         $preference = new stdClass();
1878         $preference->userid = $user->id;
1879         $preference->name   = $name;
1880         $preference->value  = $value;
1881         $DB->insert_record('user_preferences', $preference);
1882     }
1884     // Update value in cache.
1885     $user->preference[$name] = $value;
1887     // Set reload flag for other sessions.
1888     mark_user_preferences_changed($user->id);
1890     return true;
1893 /**
1894  * Sets a whole array of preferences for the current user
1895  *
1896  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1897  *
1898  * @package  core
1899  * @category preference
1900  * @access   public
1901  * @param    array             $prefarray An array of key/value pairs to be set
1902  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1903  * @return   bool                         Always true or exception
1904  */
1905 function set_user_preferences(array $prefarray, $user = null) {
1906     foreach ($prefarray as $name => $value) {
1907         set_user_preference($name, $value, $user);
1908     }
1909     return true;
1912 /**
1913  * Unsets a preference completely by deleting it from the database
1914  *
1915  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1916  *
1917  * @package  core
1918  * @category preference
1919  * @access   public
1920  * @param    string            $name The key to unset as preference for the specified user
1921  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1922  * @throws   coding_exception
1923  * @return   bool                    Always true or exception
1924  */
1925 function unset_user_preference($name, $user = null) {
1926     global $USER, $DB;
1928     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1929         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1930     }
1932     if (is_null($user)) {
1933         $user = $USER;
1934     } else if (isset($user->id)) {
1935         // It is a valid object.
1936     } else if (is_numeric($user)) {
1937         $user = (object)array('id' => (int)$user);
1938     } else {
1939         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1940     }
1942     check_user_preferences_loaded($user);
1944     if (empty($user->id) or isguestuser($user->id)) {
1945         // No permanent storage for not-logged-in user and guest.
1946         unset($user->preference[$name]);
1947         return true;
1948     }
1950     // Delete from DB.
1951     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
1953     // Delete the preference from cache.
1954     unset($user->preference[$name]);
1956     // Set reload flag for other sessions.
1957     mark_user_preferences_changed($user->id);
1959     return true;
1962 /**
1963  * Used to fetch user preference(s)
1964  *
1965  * If no arguments are supplied this function will return
1966  * all of the current user preferences as an array.
1967  *
1968  * If a name is specified then this function
1969  * attempts to return that particular preference value.  If
1970  * none is found, then the optional value $default is returned,
1971  * otherwise null.
1972  *
1973  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1974  *
1975  * @package  core
1976  * @category preference
1977  * @access   public
1978  * @param    string            $name    Name of the key to use in finding a preference value
1979  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1980  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1981  * @throws   coding_exception
1982  * @return   string|mixed|null          A string containing the value of a single preference. An
1983  *                                      array with all of the preferences or null
1984  */
1985 function get_user_preferences($name = null, $default = null, $user = null) {
1986     global $USER;
1988     if (is_null($name)) {
1989         // All prefs.
1990     } else if (is_numeric($name) or $name === '_lastloaded') {
1991         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1992     }
1994     if (is_null($user)) {
1995         $user = $USER;
1996     } else if (isset($user->id)) {
1997         // Is a valid object.
1998     } else if (is_numeric($user)) {
1999         $user = (object)array('id' => (int)$user);
2000     } else {
2001         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2002     }
2004     check_user_preferences_loaded($user);
2006     if (empty($name)) {
2007         // All values.
2008         return $user->preference;
2009     } else if (isset($user->preference[$name])) {
2010         // The single string value.
2011         return $user->preference[$name];
2012     } else {
2013         // Default value (null if not specified).
2014         return $default;
2015     }
2018 // FUNCTIONS FOR HANDLING TIME.
2020 /**
2021  * Given date parts in user time produce a GMT timestamp.
2022  *
2023  * @package core
2024  * @category time
2025  * @param int $year The year part to create timestamp of
2026  * @param int $month The month part to create timestamp of
2027  * @param int $day The day part to create timestamp of
2028  * @param int $hour The hour part to create timestamp of
2029  * @param int $minute The minute part to create timestamp of
2030  * @param int $second The second part to create timestamp of
2031  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2032  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2033  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2034  *             applied only if timezone is 99 or string.
2035  * @return int GMT timestamp
2036  */
2037 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2039     // Save input timezone, required for dst offset check.
2040     $passedtimezone = $timezone;
2042     $timezone = get_user_timezone_offset($timezone);
2044     if (abs($timezone) > 13) {
2045         // Server time.
2046         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2047     } else {
2048         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2049         $time = usertime($time, $timezone);
2051         // Apply dst for string timezones or if 99 then try dst offset with user's default timezone.
2052         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
2053             $time -= dst_offset_on($time, $passedtimezone);
2054         }
2055     }
2057     return $time;
2061 /**
2062  * Format a date/time (seconds) as weeks, days, hours etc as needed
2063  *
2064  * Given an amount of time in seconds, returns string
2065  * formatted nicely as weeks, days, hours etc as needed
2066  *
2067  * @package core
2068  * @category time
2069  * @uses MINSECS
2070  * @uses HOURSECS
2071  * @uses DAYSECS
2072  * @uses YEARSECS
2073  * @param int $totalsecs Time in seconds
2074  * @param stdClass $str Should be a time object
2075  * @return string A nicely formatted date/time string
2076  */
2077 function format_time($totalsecs, $str = null) {
2079     $totalsecs = abs($totalsecs);
2081     if (!$str) {
2082         // Create the str structure the slow way.
2083         $str = new stdClass();
2084         $str->day   = get_string('day');
2085         $str->days  = get_string('days');
2086         $str->hour  = get_string('hour');
2087         $str->hours = get_string('hours');
2088         $str->min   = get_string('min');
2089         $str->mins  = get_string('mins');
2090         $str->sec   = get_string('sec');
2091         $str->secs  = get_string('secs');
2092         $str->year  = get_string('year');
2093         $str->years = get_string('years');
2094     }
2096     $years     = floor($totalsecs/YEARSECS);
2097     $remainder = $totalsecs - ($years*YEARSECS);
2098     $days      = floor($remainder/DAYSECS);
2099     $remainder = $totalsecs - ($days*DAYSECS);
2100     $hours     = floor($remainder/HOURSECS);
2101     $remainder = $remainder - ($hours*HOURSECS);
2102     $mins      = floor($remainder/MINSECS);
2103     $secs      = $remainder - ($mins*MINSECS);
2105     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2106     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2107     $sh = ($hours == 1) ? $str->hour : $str->hours;
2108     $sd = ($days == 1)  ? $str->day  : $str->days;
2109     $sy = ($years == 1)  ? $str->year  : $str->years;
2111     $oyears = '';
2112     $odays = '';
2113     $ohours = '';
2114     $omins = '';
2115     $osecs = '';
2117     if ($years) {
2118         $oyears  = $years .' '. $sy;
2119     }
2120     if ($days) {
2121         $odays  = $days .' '. $sd;
2122     }
2123     if ($hours) {
2124         $ohours = $hours .' '. $sh;
2125     }
2126     if ($mins) {
2127         $omins  = $mins .' '. $sm;
2128     }
2129     if ($secs) {
2130         $osecs  = $secs .' '. $ss;
2131     }
2133     if ($years) {
2134         return trim($oyears .' '. $odays);
2135     }
2136     if ($days) {
2137         return trim($odays .' '. $ohours);
2138     }
2139     if ($hours) {
2140         return trim($ohours .' '. $omins);
2141     }
2142     if ($mins) {
2143         return trim($omins .' '. $osecs);
2144     }
2145     if ($secs) {
2146         return $osecs;
2147     }
2148     return get_string('now');
2151 /**
2152  * Returns a formatted string that represents a date in user time.
2153  *
2154  * @package core
2155  * @category time
2156  * @param int $date the timestamp in UTC, as obtained from the database.
2157  * @param string $format strftime format. You should probably get this using
2158  *        get_string('strftime...', 'langconfig');
2159  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2160  *        not 99 then daylight saving will not be added.
2161  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2162  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2163  *        If false then the leading zero is maintained.
2164  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2165  * @return string the formatted date/time.
2166  */
2167 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2168     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2169     return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
2172 /**
2173  * Returns a formatted date ensuring it is UTF-8.
2174  *
2175  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2176  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2177  *
2178  * This function does not do any calculation regarding the user preferences and should
2179  * therefore receive the final date timestamp, format and timezone. Timezone being only used
2180  * to differentiate the use of server time or not (strftime() against gmstrftime()).
2181  *
2182  * @param int $date the timestamp.
2183  * @param string $format strftime format.
2184  * @param int|float $tz the numerical timezone, typically returned by {@link get_user_timezone_offset()}.
2185  * @return string the formatted date/time.
2186  * @since Moodle 2.3.3
2187  */
2188 function date_format_string($date, $format, $tz = 99) {
2189     global $CFG;
2191     $localewincharset = null;
2192     // Get the calendar type user is using.
2193     if ($CFG->ostype == 'WINDOWS') {
2194         $calendartype = \core_calendar\type_factory::get_calendar_instance();
2195         $localewincharset = $calendartype->locale_win_charset();
2196     }
2198     if (abs($tz) > 13) {
2199         if ($localewincharset) {
2200             $format = core_text::convert($format, 'utf-8', $localewincharset);
2201             $datestring = strftime($format, $date);
2202             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2203         } else {
2204             $datestring = strftime($format, $date);
2205         }
2206     } else {
2207         if ($localewincharset) {
2208             $format = core_text::convert($format, 'utf-8', $localewincharset);
2209             $datestring = gmstrftime($format, $date);
2210             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2211         } else {
2212             $datestring = gmstrftime($format, $date);
2213         }
2214     }
2215     return $datestring;
2218 /**
2219  * Given a $time timestamp in GMT (seconds since epoch),
2220  * returns an array that represents the date in user time
2221  *
2222  * @package core
2223  * @category time
2224  * @uses HOURSECS
2225  * @param int $time Timestamp in GMT
2226  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2227  *        dst offset is applied {@link http://docs.moodle.org/dev/Time_API#Timezone}
2228  * @return array An array that represents the date in user time
2229  */
2230 function usergetdate($time, $timezone=99) {
2232     // Save input timezone, required for dst offset check.
2233     $passedtimezone = $timezone;
2235     $timezone = get_user_timezone_offset($timezone);
2237     if (abs($timezone) > 13) {
2238         // Server time.
2239         return getdate($time);
2240     }
2242     // Add daylight saving offset for string timezones only, as we can't get dst for
2243     // float values. if timezone is 99 (user default timezone), then try update dst.
2244     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2245         $time += dst_offset_on($time, $passedtimezone);
2246     }
2248     $time += intval((float)$timezone * HOURSECS);
2250     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2252     // Be careful to ensure the returned array matches that produced by getdate() above.
2253     list(
2254         $getdate['month'],
2255         $getdate['weekday'],
2256         $getdate['yday'],
2257         $getdate['year'],
2258         $getdate['mon'],
2259         $getdate['wday'],
2260         $getdate['mday'],
2261         $getdate['hours'],
2262         $getdate['minutes'],
2263         $getdate['seconds']
2264     ) = explode('_', $datestring);
2266     // Set correct datatype to match with getdate().
2267     $getdate['seconds'] = (int)$getdate['seconds'];
2268     $getdate['yday'] = (int)$getdate['yday'] - 1; // The function gmstrftime returns 0 through 365.
2269     $getdate['year'] = (int)$getdate['year'];
2270     $getdate['mon'] = (int)$getdate['mon'];
2271     $getdate['wday'] = (int)$getdate['wday'];
2272     $getdate['mday'] = (int)$getdate['mday'];
2273     $getdate['hours'] = (int)$getdate['hours'];
2274     $getdate['minutes'] = (int)$getdate['minutes'];
2275     return $getdate;
2278 /**
2279  * Given a GMT timestamp (seconds since epoch), offsets it by
2280  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2281  *
2282  * @package core
2283  * @category time
2284  * @uses HOURSECS
2285  * @param int $date Timestamp in GMT
2286  * @param float|int|string $timezone timezone to calculate GMT time offset before
2287  *        calculating user time, 99 is default user timezone
2288  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2289  * @return int
2290  */
2291 function usertime($date, $timezone=99) {
2293     $timezone = get_user_timezone_offset($timezone);
2295     if (abs($timezone) > 13) {
2296         return $date;
2297     }
2298     return $date - (int)($timezone * HOURSECS);
2301 /**
2302  * Given a time, return the GMT timestamp of the most recent midnight
2303  * for the current user.
2304  *
2305  * @package core
2306  * @category time
2307  * @param int $date Timestamp in GMT
2308  * @param float|int|string $timezone timezone to calculate GMT time offset before
2309  *        calculating user midnight time, 99 is default user timezone
2310  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2311  * @return int Returns a GMT timestamp
2312  */
2313 function usergetmidnight($date, $timezone=99) {
2315     $userdate = usergetdate($date, $timezone);
2317     // Time of midnight of this user's day, in GMT.
2318     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2322 /**
2323  * Returns a string that prints the user's timezone
2324  *
2325  * @package core
2326  * @category time
2327  * @param float|int|string $timezone timezone to calculate GMT time offset before
2328  *        calculating user timezone, 99 is default user timezone
2329  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2330  * @return string
2331  */
2332 function usertimezone($timezone=99) {
2334     $tz = get_user_timezone($timezone);
2336     if (!is_float($tz)) {
2337         return $tz;
2338     }
2340     if (abs($tz) > 13) {
2341         // Server time.
2342         return get_string('serverlocaltime');
2343     }
2345     if ($tz == intval($tz)) {
2346         // Don't show .0 for whole hours.
2347         $tz = intval($tz);
2348     }
2350     if ($tz == 0) {
2351         return 'UTC';
2352     } else if ($tz > 0) {
2353         return 'UTC+'.$tz;
2354     } else {
2355         return 'UTC'.$tz;
2356     }
2360 /**
2361  * Returns a float which represents the user's timezone difference from GMT in hours
2362  * Checks various settings and picks the most dominant of those which have a value
2363  *
2364  * @package core
2365  * @category time
2366  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2367  *        99 is default user timezone
2368  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2369  * @return float
2370  */
2371 function get_user_timezone_offset($tz = 99) {
2372     $tz = get_user_timezone($tz);
2374     if (is_float($tz)) {
2375         return $tz;
2376     } else {
2377         $tzrecord = get_timezone_record($tz);
2378         if (empty($tzrecord)) {
2379             return 99.0;
2380         }
2381         return (float)$tzrecord->gmtoff / HOURMINS;
2382     }
2385 /**
2386  * Returns an int which represents the systems's timezone difference from GMT in seconds
2387  *
2388  * @package core
2389  * @category time
2390  * @param float|int|string $tz timezone for which offset is required.
2391  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2392  * @return int|bool if found, false is timezone 99 or error
2393  */
2394 function get_timezone_offset($tz) {
2395     if ($tz == 99) {
2396         return false;
2397     }
2399     if (is_numeric($tz)) {
2400         return intval($tz * 60*60);
2401     }
2403     if (!$tzrecord = get_timezone_record($tz)) {
2404         return false;
2405     }
2406     return intval($tzrecord->gmtoff * 60);
2409 /**
2410  * Returns a float or a string which denotes the user's timezone
2411  * A float value means that a simple offset from GMT is used, while a string (it will be the name of a timezone in the database)
2412  * means that for this timezone there are also DST rules to be taken into account
2413  * Checks various settings and picks the most dominant of those which have a value
2414  *
2415  * @package core
2416  * @category time
2417  * @param float|int|string $tz timezone to calculate GMT time offset before
2418  *        calculating user timezone, 99 is default user timezone
2419  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2420  * @return float|string
2421  */
2422 function get_user_timezone($tz = 99) {
2423     global $USER, $CFG;
2425     $timezones = array(
2426         $tz,
2427         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2428         isset($USER->timezone) ? $USER->timezone : 99,
2429         isset($CFG->timezone) ? $CFG->timezone : 99,
2430         );
2432     $tz = 99;
2434     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2435     while (((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2436         $tz = $next['value'];
2437     }
2438     return is_numeric($tz) ? (float) $tz : $tz;
2441 /**
2442  * Returns cached timezone record for given $timezonename
2443  *
2444  * @package core
2445  * @param string $timezonename name of the timezone
2446  * @return stdClass|bool timezonerecord or false
2447  */
2448 function get_timezone_record($timezonename) {
2449     global $DB;
2450     static $cache = null;
2452     if ($cache === null) {
2453         $cache = array();
2454     }
2456     if (isset($cache[$timezonename])) {
2457         return $cache[$timezonename];
2458     }
2460     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2461                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2464 /**
2465  * Build and store the users Daylight Saving Time (DST) table
2466  *
2467  * @package core
2468  * @param int $fromyear Start year for the table, defaults to 1971
2469  * @param int $toyear End year for the table, defaults to 2035
2470  * @param int|float|string $strtimezone timezone to check if dst should be applied.
2471  * @return bool
2472  */
2473 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2474     global $SESSION, $DB;
2476     $usertz = get_user_timezone($strtimezone);
2478     if (is_float($usertz)) {
2479         // Trivial timezone, no DST.
2480         return false;
2481     }
2483     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2484         // We have pre-calculated values, but the user's effective TZ has changed in the meantime, so reset.
2485         unset($SESSION->dst_offsets);
2486         unset($SESSION->dst_range);
2487     }
2489     if (!empty($SESSION->dst_offsets) && empty($fromyear) && empty($toyear)) {
2490         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table.
2491         // This will be the return path most of the time, pretty light computationally.
2492         return true;
2493     }
2495     // Reaching here means we either need to extend our table or create it from scratch.
2497     // Remember which TZ we calculated these changes for.
2498     $SESSION->dst_offsettz = $usertz;
2500     if (empty($SESSION->dst_offsets)) {
2501         // If we 're creating from scratch, put the two guard elements in there.
2502         $SESSION->dst_offsets = array(1 => null, 0 => null);
2503     }
2504     if (empty($SESSION->dst_range)) {
2505         // If creating from scratch.
2506         $from = max((empty($fromyear) ? intval(date('Y')) - 3 : $fromyear), 1971);
2507         $to   = min((empty($toyear)   ? intval(date('Y')) + 3 : $toyear),   2035);
2509         // Fill in the array with the extra years we need to process.
2510         $yearstoprocess = array();
2511         for ($i = $from; $i <= $to; ++$i) {
2512             $yearstoprocess[] = $i;
2513         }
2515         // Take note of which years we have processed for future calls.
2516         $SESSION->dst_range = array($from, $to);
2517     } else {
2518         // If needing to extend the table, do the same.
2519         $yearstoprocess = array();
2521         $from = max((empty($fromyear) ? $SESSION->dst_range[0] : $fromyear), 1971);
2522         $to   = min((empty($toyear)   ? $SESSION->dst_range[1] : $toyear),   2035);
2524         if ($from < $SESSION->dst_range[0]) {
2525             // Take note of which years we need to process and then note that we have processed them for future calls.
2526             for ($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2527                 $yearstoprocess[] = $i;
2528             }
2529             $SESSION->dst_range[0] = $from;
2530         }
2531         if ($to > $SESSION->dst_range[1]) {
2532             // Take note of which years we need to process and then note that we have processed them for future calls.
2533             for ($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2534                 $yearstoprocess[] = $i;
2535             }
2536             $SESSION->dst_range[1] = $to;
2537         }
2538     }
2540     if (empty($yearstoprocess)) {
2541         // This means that there was a call requesting a SMALLER range than we have already calculated.
2542         return true;
2543     }
2545     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2546     // Also, the array is sorted in descending timestamp order!
2548     // Get DB data.
2550     static $presetscache = array();
2551     if (!isset($presetscache[$usertz])) {
2552         $presetscache[$usertz] = $DB->get_records('timezone', array('name' => $usertz),
2553             'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, '.
2554             'std_startday, std_weekday, std_skipweeks, std_time');
2555     }
2556     if (empty($presetscache[$usertz])) {
2557         return false;
2558     }
2560     // Remove ending guard (first element of the array).
2561     reset($SESSION->dst_offsets);
2562     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2564     // Add all required change timestamps.
2565     foreach ($yearstoprocess as $y) {
2566         // Find the record which is in effect for the year $y.
2567         foreach ($presetscache[$usertz] as $year => $preset) {
2568             if ($year <= $y) {
2569                 break;
2570             }
2571         }
2573         $changes = dst_changes_for_year($y, $preset);
2575         if ($changes === null) {
2576             continue;
2577         }
2578         if ($changes['dst'] != 0) {
2579             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2580         }
2581         if ($changes['std'] != 0) {
2582             $SESSION->dst_offsets[$changes['std']] = 0;
2583         }
2584     }
2586     // Put in a guard element at the top.
2587     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2588     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = null; // DAYSECS is arbitrary, any "small" number will do.
2590     // Sort again.
2591     krsort($SESSION->dst_offsets);
2593     return true;
2596 /**
2597  * Calculates the required DST change and returns a Timestamp Array
2598  *
2599  * @package core
2600  * @category time
2601  * @uses HOURSECS
2602  * @uses MINSECS
2603  * @param int|string $year Int or String Year to focus on
2604  * @param object $timezone Instatiated Timezone object
2605  * @return array|null Array dst => xx, 0 => xx, std => yy, 1 => yy or null
2606  */
2607 function dst_changes_for_year($year, $timezone) {
2609     if ($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 &&
2610         $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2611         return null;
2612     }
2614     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2615     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2617     list($dsthour, $dstmin) = explode(':', $timezone->dst_time);
2618     list($stdhour, $stdmin) = explode(':', $timezone->std_time);
2620     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2621     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2623     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2624     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2625     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2627     $timedst += $dsthour * HOURSECS + $dstmin * MINSECS;
2628     $timestd += $stdhour * HOURSECS + $stdmin * MINSECS;
2630     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2633 /**
2634  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2635  * - Note: Daylight saving only works for string timezones and not for float.
2636  *
2637  * @package core
2638  * @category time
2639  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2640  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2641  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2642  * @return int
2643  */
2644 function dst_offset_on($time, $strtimezone = null) {
2645     global $SESSION;
2647     if (!calculate_user_dst_table(null, null, $strtimezone) || empty($SESSION->dst_offsets)) {
2648         return 0;
2649     }
2651     reset($SESSION->dst_offsets);
2652     while (list($from, $offset) = each($SESSION->dst_offsets)) {
2653         if ($from <= $time) {
2654             break;
2655         }
2656     }
2658     // This is the normal return path.
2659     if ($offset !== null) {
2660         return $offset;
2661     }
2663     // Reaching this point means we haven't calculated far enough, do it now:
2664     // Calculate extra DST changes if needed and recurse. The recursion always
2665     // moves toward the stopping condition, so will always end.
2667     if ($from == 0) {
2668         // We need a year smaller than $SESSION->dst_range[0].
2669         if ($SESSION->dst_range[0] == 1971) {
2670             return 0;
2671         }
2672         calculate_user_dst_table($SESSION->dst_range[0] - 5, null, $strtimezone);
2673         return dst_offset_on($time, $strtimezone);
2674     } else {
2675         // We need a year larger than $SESSION->dst_range[1].
2676         if ($SESSION->dst_range[1] == 2035) {
2677             return 0;
2678         }
2679         calculate_user_dst_table(null, $SESSION->dst_range[1] + 5, $strtimezone);
2680         return dst_offset_on($time, $strtimezone);
2681     }
2684 /**
2685  * Calculates when the day appears in specific month
2686  *
2687  * @package core
2688  * @category time
2689  * @param int $startday starting day of the month
2690  * @param int $weekday The day when week starts (normally taken from user preferences)
2691  * @param int $month The month whose day is sought
2692  * @param int $year The year of the month whose day is sought
2693  * @return int
2694  */
2695 function find_day_in_month($startday, $weekday, $month, $year) {
2696     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2698     $daysinmonth = days_in_month($month, $year);
2699     $daysinweek = count($calendartype->get_weekdays());
2701     if ($weekday == -1) {
2702         // Don't care about weekday, so return:
2703         //    abs($startday) if $startday != -1
2704         //    $daysinmonth otherwise.
2705         return ($startday == -1) ? $daysinmonth : abs($startday);
2706     }
2708     // From now on we 're looking for a specific weekday.
2709     // Give "end of month" its actual value, since we know it.
2710     if ($startday == -1) {
2711         $startday = -1 * $daysinmonth;
2712     }
2714     // Starting from day $startday, the sign is the direction.
2715     if ($startday < 1) {
2716         $startday = abs($startday);
2717         $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
2719         // This is the last such weekday of the month.
2720         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2721         if ($lastinmonth > $daysinmonth) {
2722             $lastinmonth -= $daysinweek;
2723         }
2725         // Find the first such weekday <= $startday.
2726         while ($lastinmonth > $startday) {
2727             $lastinmonth -= $daysinweek;
2728         }
2730         return $lastinmonth;
2731     } else {
2732         $indexweekday = dayofweek($startday, $month, $year);
2734         $diff = $weekday - $indexweekday;
2735         if ($diff < 0) {
2736             $diff += $daysinweek;
2737         }
2739         // This is the first such weekday of the month equal to or after $startday.
2740         $firstfromindex = $startday + $diff;
2742         return $firstfromindex;
2743     }
2746 /**
2747  * Calculate the number of days in a given month
2748  *
2749  * @package core
2750  * @category time
2751  * @param int $month The month whose day count is sought
2752  * @param int $year The year of the month whose day count is sought
2753  * @return int
2754  */
2755 function days_in_month($month, $year) {
2756     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2757     return $calendartype->get_num_days_in_month($year, $month);
2760 /**
2761  * Calculate the position in the week of a specific calendar day
2762  *
2763  * @package core
2764  * @category time
2765  * @param int $day The day of the date whose position in the week is sought
2766  * @param int $month The month of the date whose position in the week is sought
2767  * @param int $year The year of the date whose position in the week is sought
2768  * @return int
2769  */
2770 function dayofweek($day, $month, $year) {
2771     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2772     return $calendartype->get_weekday($year, $month, $day);
2775 // USER AUTHENTICATION AND LOGIN.
2777 /**
2778  * Returns full login url.
2779  *
2780  * @return string login url
2781  */
2782 function get_login_url() {
2783     global $CFG;
2785     $url = "$CFG->wwwroot/login/index.php";
2787     if (!empty($CFG->loginhttps)) {
2788         $url = str_replace('http:', 'https:', $url);
2789     }
2791     return $url;
2794 /**
2795  * This function checks that the current user is logged in and has the
2796  * required privileges
2797  *
2798  * This function checks that the current user is logged in, and optionally
2799  * whether they are allowed to be in a particular course and view a particular
2800  * course module.
2801  * If they are not logged in, then it redirects them to the site login unless
2802  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2803  * case they are automatically logged in as guests.
2804  * If $courseid is given and the user is not enrolled in that course then the
2805  * user is redirected to the course enrolment page.
2806  * If $cm is given and the course module is hidden and the user is not a teacher
2807  * in the course then the user is redirected to the course home page.
2808  *
2809  * When $cm parameter specified, this function sets page layout to 'module'.
2810  * You need to change it manually later if some other layout needed.
2811  *
2812  * @package    core_access
2813  * @category   access
2814  *
2815  * @param mixed $courseorid id of the course or course object
2816  * @param bool $autologinguest default true
2817  * @param object $cm course module object
2818  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2819  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2820  *             in order to keep redirects working properly. MDL-14495
2821  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2822  * @return mixed Void, exit, and die depending on path
2823  * @throws coding_exception
2824  * @throws require_login_exception
2825  */
2826 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2827     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2829     // Must not redirect when byteserving already started.
2830     if (!empty($_SERVER['HTTP_RANGE'])) {
2831         $preventredirect = true;
2832     }
2834     // Setup global $COURSE, themes, language and locale.
2835     if (!empty($courseorid)) {
2836         if (is_object($courseorid)) {
2837             $course = $courseorid;
2838         } else if ($courseorid == SITEID) {
2839             $course = clone($SITE);
2840         } else {
2841             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2842         }
2843         if ($cm) {
2844             if ($cm->course != $course->id) {
2845                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2846             }
2847             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2848             if (!($cm instanceof cm_info)) {
2849                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2850                 // db queries so this is not really a performance concern, however it is obviously
2851                 // better if you use get_fast_modinfo to get the cm before calling this.
2852                 $modinfo = get_fast_modinfo($course);
2853                 $cm = $modinfo->get_cm($cm->id);
2854             }
2855             $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
2856             $PAGE->set_pagelayout('incourse');
2857         } else {
2858             $PAGE->set_course($course); // Set's up global $COURSE.
2859         }
2860     } else {
2861         // Do not touch global $COURSE via $PAGE->set_course(),
2862         // the reasons is we need to be able to call require_login() at any time!!
2863         $course = $SITE;
2864         if ($cm) {
2865             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2866         }
2867     }
2869     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2870     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2871     // risk leading the user back to the AJAX request URL.
2872     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2873         $setwantsurltome = false;
2874     }
2876     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2877     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2878         if ($setwantsurltome) {
2879             $SESSION->wantsurl = qualified_me();
2880         }
2881         redirect(get_login_url());
2882     }
2884     // If the user is not even logged in yet then make sure they are.
2885     if (!isloggedin()) {
2886         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2887             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2888                 // Misconfigured site guest, just redirect to login page.
2889                 redirect(get_login_url());
2890                 exit; // Never reached.
2891             }
2892             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2893             complete_user_login($guest);
2894             $USER->autologinguest = true;
2895             $SESSION->lang = $lang;
2896         } else {
2897             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2898             if ($preventredirect) {
2899                 throw new require_login_exception('You are not logged in');
2900             }
2902             if ($setwantsurltome) {
2903                 $SESSION->wantsurl = qualified_me();
2904             }
2905             if (!empty($_SERVER['HTTP_REFERER'])) {
2906                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2907             }
2908             redirect(get_login_url());
2909             exit; // Never reached.
2910         }
2911     }
2913     // Loginas as redirection if needed.
2914     if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
2915         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2916             if ($USER->loginascontext->instanceid != $course->id) {
2917                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2918             }
2919         }
2920     }
2922     // Check whether the user should be changing password (but only if it is REALLY them).
2923     if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
2924         $userauth = get_auth_plugin($USER->auth);
2925         if ($userauth->can_change_password() and !$preventredirect) {
2926             if ($setwantsurltome) {
2927                 $SESSION->wantsurl = qualified_me();
2928             }
2929             if ($changeurl = $userauth->change_password_url()) {
2930                 // Use plugin custom url.
2931                 redirect($changeurl);
2932             } else {
2933                 // Use moodle internal method.
2934                 if (empty($CFG->loginhttps)) {
2935                     redirect($CFG->wwwroot .'/login/change_password.php');
2936                 } else {
2937                     $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
2938                     redirect($wwwroot .'/login/change_password.php');
2939                 }
2940             }
2941         } else {
2942             print_error('nopasswordchangeforced', 'auth');
2943         }
2944     }
2946     // Check that the user account is properly set up.
2947     if (user_not_fully_set_up($USER)) {
2948         if ($preventredirect) {
2949             throw new require_login_exception('User not fully set-up');
2950         }
2951         if ($setwantsurltome) {
2952             $SESSION->wantsurl = qualified_me();
2953         }
2954         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2955     }
2957     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2958     sesskey();
2960     // Do not bother admins with any formalities.
2961     if (is_siteadmin()) {
2962         // Set accesstime or the user will appear offline which messes up messaging.
2963         user_accesstime_log($course->id);
2964         return;
2965     }
2967     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2968     if (!$USER->policyagreed and !is_siteadmin()) {
2969         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2970             if ($preventredirect) {
2971                 throw new require_login_exception('Policy not agreed');
2972             }
2973             if ($setwantsurltome) {
2974                 $SESSION->wantsurl = qualified_me();
2975             }
2976             redirect($CFG->wwwroot .'/user/policy.php');
2977         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2978             if ($preventredirect) {
2979                 throw new require_login_exception('Policy not agreed');
2980             }
2981             if ($setwantsurltome) {
2982                 $SESSION->wantsurl = qualified_me();
2983             }
2984             redirect($CFG->wwwroot .'/user/policy.php');
2985         }
2986     }
2988     // Fetch the system context, the course context, and prefetch its child contexts.
2989     $sysctx = context_system::instance();
2990     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2991     if ($cm) {
2992         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2993     } else {
2994         $cmcontext = null;
2995     }
2997     // If the site is currently under maintenance, then print a message.
2998     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2999         if ($preventredirect) {
3000             throw new require_login_exception('Maintenance in progress');
3001         }
3003         print_maintenance_message();
3004     }
3006     // Make sure the course itself is not hidden.
3007     if ($course->id == SITEID) {
3008         // Frontpage can not be hidden.
3009     } else {
3010         if (is_role_switched($course->id)) {
3011             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
3012         } else {
3013             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
3014                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
3015                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
3016                 if ($preventredirect) {
3017                     throw new require_login_exception('Course is hidden');
3018                 }
3019                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
3020                 // the navigation will mess up when trying to find it.
3021                 navigation_node::override_active_url(new moodle_url('/'));
3022                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
3023             }
3024         }
3025     }
3027     // Is the user enrolled?
3028     if ($course->id == SITEID) {
3029         // Everybody is enrolled on the frontpage.
3030     } else {
3031         if (\core\session\manager::is_loggedinas()) {
3032             // Make sure the REAL person can access this course first.
3033             $realuser = \core\session\manager::get_realuser();
3034             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
3035                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
3036                 if ($preventredirect) {
3037                     throw new require_login_exception('Invalid course login-as access');
3038                 }
3039                 echo $OUTPUT->header();
3040                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
3041             }
3042         }
3044         $access = false;
3046         if (is_role_switched($course->id)) {
3047             // Ok, user had to be inside this course before the switch.
3048             $access = true;
3050         } else if (is_viewing($coursecontext, $USER)) {
3051             // Ok, no need to mess with enrol.
3052             $access = true;
3054         } else {
3055             if (isset($USER->enrol['enrolled'][$course->id])) {
3056                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3057                     $access = true;
3058                     if (isset($USER->enrol['tempguest'][$course->id])) {
3059                         unset($USER->enrol['tempguest'][$course->id]);
3060                         remove_temp_course_roles($coursecontext);
3061                     }
3062                 } else {
3063                     // Expired.
3064                     unset($USER->enrol['enrolled'][$course->id]);
3065                 }
3066             }
3067             if (isset($USER->enrol['tempguest'][$course->id])) {
3068                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3069                     $access = true;
3070                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3071                     $access = true;
3072                 } else {
3073                     // Expired.
3074                     unset($USER->enrol['tempguest'][$course->id]);
3075                     remove_temp_course_roles($coursecontext);
3076                 }
3077             }
3079             if (!$access) {
3080                 // Cache not ok.
3081                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3082                 if ($until !== false) {
3083                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
3084                     if ($until == 0) {
3085                         $until = ENROL_MAX_TIMESTAMP;
3086                     }
3087                     $USER->enrol['enrolled'][$course->id] = $until;
3088                     $access = true;
3090                 } else {
3091                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
3092                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
3093                     $enrols = enrol_get_plugins(true);
3094                     // First ask all enabled enrol instances in course if they want to auto enrol user.
3095                     foreach ($instances as $instance) {
3096                         if (!isset($enrols[$instance->enrol])) {
3097                             continue;
3098                         }
3099                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3100                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3101                         if ($until !== false) {
3102                             if ($until == 0) {
3103                                 $until = ENROL_MAX_TIMESTAMP;
3104                             }
3105                             $USER->enrol['enrolled'][$course->id] = $until;
3106                             $access = true;
3107                             break;
3108                         }
3109                     }
3110                     // If not enrolled yet try to gain temporary guest access.
3111                     if (!$access) {
3112                         foreach ($instances as $instance) {
3113                             if (!isset($enrols[$instance->enrol])) {
3114                                 continue;
3115                             }
3116                             // Get a duration for the guest access, a timestamp in the future or false.
3117                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3118                             if ($until !== false and $until > time()) {
3119                                 $USER->enrol['tempguest'][$course->id] = $until;
3120                                 $access = true;
3121                                 break;
3122                             }
3123                         }
3124                     }
3125                 }
3126             }
3127         }
3129         if (!$access) {
3130             if ($preventredirect) {
3131                 throw new require_login_exception('Not enrolled');
3132             }
3133             if ($setwantsurltome) {
3134                 $SESSION->wantsurl = qualified_me();
3135             }
3136             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3137         }
3138     }
3140     // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
3141     if ($cm && !$cm->uservisible) {
3142         if ($preventredirect) {
3143             throw new require_login_exception('Activity is hidden');
3144         }
3145         if ($course->id != SITEID) {
3146             $url = new moodle_url('/course/view.php', array('id' => $course->id));
3147         } else {
3148             $url = new moodle_url('/');
3149         }
3150         redirect($url, get_string('activityiscurrentlyhidden'));
3151     }
3153     // Finally access granted, update lastaccess times.
3154     user_accesstime_log($course->id);
3158 /**
3159  * This function just makes sure a user is logged out.
3160  *
3161  * @package    core_access
3162  * @category   access
3163  */
3164 function require_logout() {
3165     global $USER, $DB;
3167     if (!isloggedin()) {
3168         // This should not happen often, no need for hooks or events here.
3169         \core\session\manager::terminate_current();
3170         return;
3171     }
3173     // Execute hooks before action.
3174     $authplugins = array();
3175     $authsequence = get_enabled_auth_plugins();
3176     foreach ($authsequence as $authname) {
3177         $authplugins[$authname] = get_auth_plugin($authname);
3178         $authplugins[$authname]->prelogout_hook();
3179     }
3181     // Store info that gets removed during logout.
3182     $sid = session_id();
3183     $event = \core\event\user_loggedout::create(
3184         array(
3185             'userid' => $USER->id,
3186             'objectid' => $USER->id,
3187             'other' => array('sessionid' => $sid),
3188         )
3189     );
3190     if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
3191         $event->add_record_snapshot('sessions', $session);
3192     }
3194     // Clone of $USER object to be used by auth plugins.
3195     $user = fullclone($USER);
3197     // Delete session record and drop $_SESSION content.
3198     \core\session\manager::terminate_current();
3200     // Trigger event AFTER action.
3201     $event->trigger();
3203     // Hook to execute auth plugins redirection after event trigger.
3204     foreach ($authplugins as $authplugin) {
3205         $authplugin->postlogout_hook($user);
3206     }
3209 /**
3210  * Weaker version of require_login()
3211  *
3212  * This is a weaker version of {@link require_login()} which only requires login
3213  * when called from within a course rather than the site page, unless
3214  * the forcelogin option is turned on.
3215  * @see require_login()
3216  *
3217  * @package    core_access
3218  * @category   access
3219  *
3220  * @param mixed $courseorid The course object or id in question
3221  * @param bool $autologinguest Allow autologin guests if that is wanted
3222  * @param object $cm Course activity module if known
3223  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3224  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3225  *             in order to keep redirects working properly. MDL-14495
3226  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3227  * @return void
3228  * @throws coding_exception
3229  */
3230 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3231     global $CFG, $PAGE, $SITE;
3232     $issite = ((is_object($courseorid) and $courseorid->id == SITEID)
3233           or (!is_object($courseorid) and $courseorid == SITEID));
3234     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3235         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3236         // db queries so this is not really a performance concern, however it is obviously
3237         // better if you use get_fast_modinfo to get the cm before calling this.
3238         if (is_object($courseorid)) {
3239             $course = $courseorid;
3240         } else {
3241             $course = clone($SITE);
3242         }
3243         $modinfo = get_fast_modinfo($course);
3244         $cm = $modinfo->get_cm($cm->id);
3245     }
3246     if (!empty($CFG->forcelogin)) {
3247         // Login required for both SITE and courses.
3248         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3250     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3251         // Always login for hidden activities.
3252         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3254     } else if ($issite) {
3255         // Login for SITE not required.
3256         // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3257         if (!empty($courseorid)) {
3258             if (is_object($courseorid)) {
3259                 $course = $courseorid;
3260             } else {
3261                 $course = clone $SITE;
3262             }
3263             if ($cm) {
3264                 if ($cm->course != $course->id) {
3265                     throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3266                 }
3267                 $PAGE->set_cm($cm, $course);
3268                 $PAGE->set_pagelayout('incourse');
3269             } else {
3270                 $PAGE->set_course($course);
3271             }
3272         } else {
3273             // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3274             $PAGE->set_course($PAGE->course);
3275         }
3276         user_accesstime_log(SITEID);
3277         return;
3279     } else {
3280         // Course login always required.
3281         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3282     }
3285 /**
3286  * Require key login. Function terminates with error if key not found or incorrect.
3287  *
3288  * @uses NO_MOODLE_COOKIES
3289  * @uses PARAM_ALPHANUM
3290  * @param string $script unique script identifier
3291  * @param int $instance optional instance id
3292  * @return int Instance ID
3293  */
3294 function require_user_key_login($script, $instance=null) {
3295     global $DB;
3297     if (!NO_MOODLE_COOKIES) {
3298         print_error('sessioncookiesdisable');
3299     }
3301     // Extra safety.
3302     \core\session\manager::write_close();
3304     $keyvalue = required_param('key', PARAM_ALPHANUM);
3306     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3307         print_error('invalidkey');
3308     }
3310     if (!empty($key->validuntil) and $key->validuntil < time()) {
3311         print_error('expiredkey');
3312     }
3314     if ($key->iprestriction) {
3315         $remoteaddr = getremoteaddr(null);
3316         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3317             print_error('ipmismatch');
3318         }
3319     }
3321     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3322         print_error('invaliduserid');
3323     }
3325     // Emulate normal session.
3326     enrol_check_plugins($user);
3327     \core\session\manager::set_user($user);
3329     // Note we are not using normal login.
3330     if (!defined('USER_KEY_LOGIN')) {
3331         define('USER_KEY_LOGIN', true);
3332     }
3334     // Return instance id - it might be empty.
3335     return $key->instance;
3338 /**
3339  * Creates a new private user access key.
3340  *
3341  * @param string $script unique target identifier
3342  * @param int $userid
3343  * @param int $instance optional instance id
3344  * @param string $iprestriction optional ip restricted access
3345  * @param timestamp $validuntil key valid only until given data
3346  * @return string access key value
3347  */
3348 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3349     global $DB;
3351     $key = new stdClass();
3352     $key->script        = $script;
3353     $key->userid        = $userid;
3354     $key->instance      = $instance;
3355     $key->iprestriction = $iprestriction;
3356     $key->validuntil    = $validuntil;
3357     $key->timecreated   = time();
3359     // Something long and unique.
3360     $key->value         = md5($userid.'_'.time().random_string(40));
3361     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3362         // Must be unique.
3363         $key->value     = md5($userid.'_'.time().random_string(40));
3364     }
3365     $DB->insert_record('user_private_key', $key);
3366     return $key->value;
3369 /**
3370  * Delete the user's new private user access keys for a particular script.
3371  *
3372  * @param string $script unique target identifier
3373  * @param int $userid
3374  * @return void
3375  */
3376 function delete_user_key($script, $userid) {
3377     global $DB;
3378     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3381 /**
3382  * Gets a private user access key (and creates one if one doesn't exist).
3383  *
3384  * @param string $script unique target identifier
3385  * @param int $userid
3386  * @param int $instance optional instance id
3387  * @param string $iprestriction optional ip restricted access
3388  * @param timestamp $validuntil key valid only until given data
3389  * @return string access key value
3390  */
3391 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3392     global $DB;
3394     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3395                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3396                                                          'validuntil' => $validuntil))) {
3397         return $key->value;
3398     } else {
3399         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3400     }
3404 /**
3405  * Modify the user table by setting the currently logged in user's last login to now.
3406  *
3407  * @return bool Always returns true
3408  */
3409 function update_user_login_times() {
3410     global $USER, $DB;
3412     if (isguestuser()) {
3413         // Do not update guest access times/ips for performance.
3414         return true;
3415     }
3417     $now = time();
3419     $user = new stdClass();
3420     $user->id = $USER->id;
3422     // Make sure all users that logged in have some firstaccess.
3423     if ($USER->firstaccess == 0) {
3424         $USER->firstaccess = $user->firstaccess = $now;
3425     }
3427     // Store the previous current as lastlogin.
3428     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3430     $USER->currentlogin = $user->currentlogin = $now;
3432     // Function user_accesstime_log() may not update immediately, better do it here.
3433     $USER->lastaccess = $user->lastaccess = $now;
3434     $USER->lastip = $user->lastip = getremoteaddr();
3436     // Note: do not call user_update_user() here because this is part of the login process,
3437     //       the login event means that these fields were updated.
3438     $DB->update_record('user', $user);
3439     return true;
3442 /**
3443  * Determines if a user has completed setting up their account.
3444  *
3445  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3446  * @return bool
3447  */
3448 function user_not_fully_set_up($user) {
3449     if (isguestuser($user)) {
3450         return false;
3451     }
3452     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3455 /**
3456  * Check whether the user has exceeded the bounce threshold
3457  *
3458  * @param stdClass $user A {@link $USER} object
3459  * @return bool true => User has exceeded bounce threshold
3460  */
3461 function over_bounce_threshold($user) {
3462     global $CFG, $DB;
3464     if (empty($CFG->handlebounces)) {
3465         return false;
3466     }
3468     if (empty($user->id)) {
3469         // No real (DB) user, nothing to do here.
3470         return false;
3471     }
3473     // Set sensible defaults.
3474     if (empty($CFG->minbounces)) {
3475         $CFG->minbounces = 10;
3476     }
3477     if (empty($CFG->bounceratio)) {
3478         $CFG->bounceratio = .20;
3479     }
3480     $bouncecount = 0;
3481     $sendcount = 0;
3482     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3483         $bouncecount = $bounce->value;
3484     }
3485     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3486         $sendcount = $send->value;
3487     }
3488     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3491 /**
3492  * Used to increment or reset email sent count
3493  *
3494  * @param stdClass $user object containing an id
3495  * @param bool $reset will reset the count to 0
3496  * @return void
3497  */
3498 function set_send_count($user, $reset=false) {
3499     global $DB;
3501     if (empty($user->id)) {
3502         // No real (DB) user, nothing to do here.
3503         return;
3504     }
3506     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3507         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3508         $DB->update_record('user_preferences', $pref);
3509     } else if (!empty($reset)) {
3510         // If it's not there and we're resetting, don't bother. Make a new one.
3511         $pref = new stdClass();
3512         $pref->name   = 'email_send_count';
3513         $pref->value  = 1;
3514         $pref->userid = $user->id;
3515         $DB->insert_record('user_preferences', $pref, false);
3516     }
3519 /**
3520  * Increment or reset user's email bounce count
3521  *
3522  * @param stdClass $user object containing an id
3523  * @param bool $reset will reset the count to 0
3524  */
3525 function set_bounce_count($user, $reset=false) {
3526     global $DB;
3528     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3529         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3530         $DB->update_record('user_preferences', $pref);
3531     } else if (!empty($reset)) {
3532         // If it's not there and we're resetting, don't bother. Make a new one.
3533         $pref = new stdClass();
3534         $pref->name   = 'email_bounce_count';
3535         $pref->value  = 1;
3536         $pref->userid = $user->id;
3537         $DB->insert_record('user_preferences', $pref, false);
3538     }
3541 /**
3542  * Determines if the logged in user is currently moving an activity
3543  *
3544  * @param int $courseid The id of the course being tested
3545  * @return bool
3546  */
3547 function ismoving($courseid) {
3548     global $USER;
3550     if (!empty($USER->activitycopy)) {
3551         return ($USER->activitycopycourse == $courseid);
3552     }
3553     return false;
3556 /**
3557  * Returns a persons full name
3558  *
3559  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3560  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3561  * specify one.
3562  *
3563  * @param stdClass $user A {@link $USER} object to get full name of.
3564  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3565  * @return string
3566  */
3567 function fullname($user, $override=false) {
3568     global $CFG, $SESSION;
3570     if (!isset($user->firstname) and !isset($user->lastname)) {
3571         return '';
3572     }
3574     // Get all of the name fields.
3575     $allnames = get_all_user_name_fields();
3576     if ($CFG->debugdeveloper) {
3577         foreach ($allnames as $allname) {
3578             if (!array_key_exists($allname, $user)) {
3579                 // If all the user name fields are not set in the user object, then notify the programmer that it needs to be fixed.
3580                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3581                 // Message has been sent, no point in sending the message multiple times.
3582                 break;
3583             }
3584         }
3585     }
3587     if (!$override) {
3588         if (!empty($CFG->forcefirstname)) {
3589             $user->firstname = $CFG->forcefirstname;
3590         }
3591         if (!empty($CFG->forcelastname)) {
3592             $user->lastname = $CFG->forcelastname;
3593         }
3594     }
3596     if (!empty($SESSION->fullnamedisplay)) {
3597         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3598     }
3600     $template = null;
3601     // If the fullnamedisplay setting is available, set the template to that.
3602     if (isset($CFG->fullnamedisplay)) {
3603         $template = $CFG->fullnamedisplay;
3604     }
3605     // If the template is empty, or set to language, return the language string.
3606     if ((empty($template) || $template == 'language') && !$override) {
3607         return get_string('fullnamedisplay', null, $user);
3608     }
3610     // Check to see if we are displaying according to the alternative full name format.
3611     if ($override) {
3612         if (empty($CFG->alternativefullnameformat) || $CFG->alternativefullnameformat == 'language') {
3613             // Default to show just the user names according to the fullnamedisplay string.
3614             return get_string('fullnamedisplay', null, $user);
3615         } else {
3616             // If the override is true, then change the template to use the complete name.
3617             $template = $CFG->alternativefullnameformat;
3618         }
3619     }
3621     $requirednames = array();
3622     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3623     foreach ($allnames as $allname) {
3624         if (strpos($template, $allname) !== false) {
3625             $requirednames[] = $allname;
3626         }
3627     }
3629     $displayname = $template;
3630     // Switch in the actual data into the template.
3631     foreach ($requirednames as $altname) {
3632         if (isset($user->$altname)) {
3633             // Using empty() on the below if statement causes breakages.
3634             if ((string)$user->$altname == '') {
3635                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3636             } else {
3637                 $displayname = str_replace($altname, $user->$altname, $displayname);
3638             }
3639         } else {
3640             $displayname = str_replace($altname, 'EMPTY', $displayname);
3641         }
3642     }
3643     // Tidy up any misc. characters (Not perfect, but gets most characters).
3644     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3645     // katakana and parenthesis.
3646     $patterns = array();
3647     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3648     // filled in by a user.
3649     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3650     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3651     // This regular expression is to remove any double spaces in the display name.
3652     $patterns[] = '/\s{2,}/u';
3653     foreach ($patterns as $pattern) {
3654         $displayname = preg_replace($pattern, ' ', $displayname);
3655     }