MDL-43758 performance: New metric, time spent by the database
[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 /** True if module supports groupmembersonly */
418 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
420 /** Type of module */
421 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
422 /** True if module supports intro editor */
423 define('FEATURE_MOD_INTRO', 'mod_intro');
424 /** True if module has default completion */
425 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
427 define('FEATURE_COMMENT', 'comment');
429 define('FEATURE_RATE', 'rate');
430 /** True if module supports backup/restore of moodle2 format */
431 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
433 /** True if module can show description on course main page */
434 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
436 /** True if module uses the question bank */
437 define('FEATURE_USES_QUESTIONS', 'usesquestions');
439 /** Unspecified module archetype */
440 define('MOD_ARCHETYPE_OTHER', 0);
441 /** Resource-like type module */
442 define('MOD_ARCHETYPE_RESOURCE', 1);
443 /** Assignment module archetype */
444 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
445 /** System (not user-addable) module archetype */
446 define('MOD_ARCHETYPE_SYSTEM', 3);
448 /** Return this from modname_get_types callback to use default display in activity chooser */
449 define('MOD_SUBTYPE_NO_CHILDREN', 'modsubtypenochildren');
451 /**
452  * Security token used for allowing access
453  * from external application such as web services.
454  * Scripts do not use any session, performance is relatively
455  * low because we need to load access info in each request.
456  * Scripts are executed in parallel.
457  */
458 define('EXTERNAL_TOKEN_PERMANENT', 0);
460 /**
461  * Security token used for allowing access
462  * of embedded applications, the code is executed in the
463  * active user session. Token is invalidated after user logs out.
464  * Scripts are executed serially - normal session locking is used.
465  */
466 define('EXTERNAL_TOKEN_EMBEDDED', 1);
468 /**
469  * The home page should be the site home
470  */
471 define('HOMEPAGE_SITE', 0);
472 /**
473  * The home page should be the users my page
474  */
475 define('HOMEPAGE_MY', 1);
476 /**
477  * The home page can be chosen by the user
478  */
479 define('HOMEPAGE_USER', 2);
481 /**
482  * Hub directory url (should be moodle.org)
483  */
484 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
487 /**
488  * Moodle.org url (should be moodle.org)
489  */
490 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
492 /**
493  * Moodle mobile app service name
494  */
495 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
497 /**
498  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
499  */
500 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
502 /**
503  * Course display settings: display all sections on one page.
504  */
505 define('COURSE_DISPLAY_SINGLEPAGE', 0);
506 /**
507  * Course display settings: split pages into a page per section.
508  */
509 define('COURSE_DISPLAY_MULTIPAGE', 1);
511 /**
512  * Authentication constant: String used in password field when password is not stored.
513  */
514 define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
516 // PARAMETER HANDLING.
518 /**
519  * Returns a particular value for the named variable, taken from
520  * POST or GET.  If the parameter doesn't exist then an error is
521  * thrown because we require this variable.
522  *
523  * This function should be used to initialise all required values
524  * in a script that are based on parameters.  Usually it will be
525  * used like this:
526  *    $id = required_param('id', PARAM_INT);
527  *
528  * Please note the $type parameter is now required and the value can not be array.
529  *
530  * @param string $parname the name of the page parameter we want
531  * @param string $type expected type of parameter
532  * @return mixed
533  * @throws coding_exception
534  */
535 function required_param($parname, $type) {
536     if (func_num_args() != 2 or empty($parname) or empty($type)) {
537         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
538     }
539     // POST has precedence.
540     if (isset($_POST[$parname])) {
541         $param = $_POST[$parname];
542     } else if (isset($_GET[$parname])) {
543         $param = $_GET[$parname];
544     } else {
545         print_error('missingparam', '', '', $parname);
546     }
548     if (is_array($param)) {
549         debugging('Invalid array parameter detected in required_param(): '.$parname);
550         // TODO: switch to fatal error in Moodle 2.3.
551         return required_param_array($parname, $type);
552     }
554     return clean_param($param, $type);
557 /**
558  * Returns a particular array value for the named variable, taken from
559  * POST or GET.  If the parameter doesn't exist then an error is
560  * thrown because we require this variable.
561  *
562  * This function should be used to initialise all required values
563  * in a script that are based on parameters.  Usually it will be
564  * used like this:
565  *    $ids = required_param_array('ids', PARAM_INT);
566  *
567  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
568  *
569  * @param string $parname the name of the page parameter we want
570  * @param string $type expected type of parameter
571  * @return array
572  * @throws coding_exception
573  */
574 function required_param_array($parname, $type) {
575     if (func_num_args() != 2 or empty($parname) or empty($type)) {
576         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
577     }
578     // POST has precedence.
579     if (isset($_POST[$parname])) {
580         $param = $_POST[$parname];
581     } else if (isset($_GET[$parname])) {
582         $param = $_GET[$parname];
583     } else {
584         print_error('missingparam', '', '', $parname);
585     }
586     if (!is_array($param)) {
587         print_error('missingparam', '', '', $parname);
588     }
590     $result = array();
591     foreach ($param as $key => $value) {
592         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
593             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
594             continue;
595         }
596         $result[$key] = clean_param($value, $type);
597     }
599     return $result;
602 /**
603  * Returns a particular value for the named variable, taken from
604  * POST or GET, otherwise returning a given default.
605  *
606  * This function should be used to initialise all optional values
607  * in a script that are based on parameters.  Usually it will be
608  * used like this:
609  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
610  *
611  * Please note the $type parameter is now required and the value can not be array.
612  *
613  * @param string $parname the name of the page parameter we want
614  * @param mixed  $default the default value to return if nothing is found
615  * @param string $type expected type of parameter
616  * @return mixed
617  * @throws coding_exception
618  */
619 function optional_param($parname, $default, $type) {
620     if (func_num_args() != 3 or empty($parname) or empty($type)) {
621         throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
622     }
623     if (!isset($default)) {
624         $default = null;
625     }
627     // POST has precedence.
628     if (isset($_POST[$parname])) {
629         $param = $_POST[$parname];
630     } else if (isset($_GET[$parname])) {
631         $param = $_GET[$parname];
632     } else {
633         return $default;
634     }
636     if (is_array($param)) {
637         debugging('Invalid array parameter detected in required_param(): '.$parname);
638         // TODO: switch to $default in Moodle 2.3.
639         return optional_param_array($parname, $default, $type);
640     }
642     return clean_param($param, $type);
645 /**
646  * Returns a particular array value for the named variable, taken from
647  * POST or GET, otherwise returning a given default.
648  *
649  * This function should be used to initialise all optional values
650  * in a script that are based on parameters.  Usually it will be
651  * used like this:
652  *    $ids = optional_param('id', array(), PARAM_INT);
653  *
654  * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
655  *
656  * @param string $parname the name of the page parameter we want
657  * @param mixed $default the default value to return if nothing is found
658  * @param string $type expected type of parameter
659  * @return array
660  * @throws coding_exception
661  */
662 function optional_param_array($parname, $default, $type) {
663     if (func_num_args() != 3 or empty($parname) or empty($type)) {
664         throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
665     }
667     // POST has precedence.
668     if (isset($_POST[$parname])) {
669         $param = $_POST[$parname];
670     } else if (isset($_GET[$parname])) {
671         $param = $_GET[$parname];
672     } else {
673         return $default;
674     }
675     if (!is_array($param)) {
676         debugging('optional_param_array() expects array parameters only: '.$parname);
677         return $default;
678     }
680     $result = array();
681     foreach ($param as $key => $value) {
682         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
683             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
684             continue;
685         }
686         $result[$key] = clean_param($value, $type);
687     }
689     return $result;
692 /**
693  * Strict validation of parameter values, the values are only converted
694  * to requested PHP type. Internally it is using clean_param, the values
695  * before and after cleaning must be equal - otherwise
696  * an invalid_parameter_exception is thrown.
697  * Objects and classes are not accepted.
698  *
699  * @param mixed $param
700  * @param string $type PARAM_ constant
701  * @param bool $allownull are nulls valid value?
702  * @param string $debuginfo optional debug information
703  * @return mixed the $param value converted to PHP type
704  * @throws invalid_parameter_exception if $param is not of given type
705  */
706 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
707     if (is_null($param)) {
708         if ($allownull == NULL_ALLOWED) {
709             return null;
710         } else {
711             throw new invalid_parameter_exception($debuginfo);
712         }
713     }
714     if (is_array($param) or is_object($param)) {
715         throw new invalid_parameter_exception($debuginfo);
716     }
718     $cleaned = clean_param($param, $type);
720     if ($type == PARAM_FLOAT) {
721         // Do not detect precision loss here.
722         if (is_float($param) or is_int($param)) {
723             // These always fit.
724         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
725             throw new invalid_parameter_exception($debuginfo);
726         }
727     } else if ((string)$param !== (string)$cleaned) {
728         // Conversion to string is usually lossless.
729         throw new invalid_parameter_exception($debuginfo);
730     }
732     return $cleaned;
735 /**
736  * Makes sure array contains only the allowed types, this function does not validate array key names!
737  *
738  * <code>
739  * $options = clean_param($options, PARAM_INT);
740  * </code>
741  *
742  * @param array $param the variable array we are cleaning
743  * @param string $type expected format of param after cleaning.
744  * @param bool $recursive clean recursive arrays
745  * @return array
746  * @throws coding_exception
747  */
748 function clean_param_array(array $param = null, $type, $recursive = false) {
749     // Convert null to empty array.
750     $param = (array)$param;
751     foreach ($param as $key => $value) {
752         if (is_array($value)) {
753             if ($recursive) {
754                 $param[$key] = clean_param_array($value, $type, true);
755             } else {
756                 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
757             }
758         } else {
759             $param[$key] = clean_param($value, $type);
760         }
761     }
762     return $param;
765 /**
766  * Used by {@link optional_param()} and {@link required_param()} to
767  * clean the variables and/or cast to specific types, based on
768  * an options field.
769  * <code>
770  * $course->format = clean_param($course->format, PARAM_ALPHA);
771  * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
772  * </code>
773  *
774  * @param mixed $param the variable we are cleaning
775  * @param string $type expected format of param after cleaning.
776  * @return mixed
777  * @throws coding_exception
778  */
779 function clean_param($param, $type) {
780     global $CFG;
782     if (is_array($param)) {
783         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
784     } else if (is_object($param)) {
785         if (method_exists($param, '__toString')) {
786             $param = $param->__toString();
787         } else {
788             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
789         }
790     }
792     switch ($type) {
793         case PARAM_RAW:
794             // No cleaning at all.
795             $param = fix_utf8($param);
796             return $param;
798         case PARAM_RAW_TRIMMED:
799             // No cleaning, but strip leading and trailing whitespace.
800             $param = fix_utf8($param);
801             return trim($param);
803         case PARAM_CLEAN:
804             // General HTML cleaning, try to use more specific type if possible this is deprecated!
805             // Please use more specific type instead.
806             if (is_numeric($param)) {
807                 return $param;
808             }
809             $param = fix_utf8($param);
810             // Sweep for scripts, etc.
811             return clean_text($param);
813         case PARAM_CLEANHTML:
814             // Clean html fragment.
815             $param = fix_utf8($param);
816             // Sweep for scripts, etc.
817             $param = clean_text($param, FORMAT_HTML);
818             return trim($param);
820         case PARAM_INT:
821             // Convert to integer.
822             return (int)$param;
824         case PARAM_FLOAT:
825             // Convert to float.
826             return (float)$param;
828         case PARAM_ALPHA:
829             // Remove everything not `a-z`.
830             return preg_replace('/[^a-zA-Z]/i', '', $param);
832         case PARAM_ALPHAEXT:
833             // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
834             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
836         case PARAM_ALPHANUM:
837             // Remove everything not `a-zA-Z0-9`.
838             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
840         case PARAM_ALPHANUMEXT:
841             // Remove everything not `a-zA-Z0-9_-`.
842             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
844         case PARAM_SEQUENCE:
845             // Remove everything not `0-9,`.
846             return preg_replace('/[^0-9,]/i', '', $param);
848         case PARAM_BOOL:
849             // Convert to 1 or 0.
850             $tempstr = strtolower($param);
851             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
852                 $param = 1;
853             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
854                 $param = 0;
855             } else {
856                 $param = empty($param) ? 0 : 1;
857             }
858             return $param;
860         case PARAM_NOTAGS:
861             // Strip all tags.
862             $param = fix_utf8($param);
863             return strip_tags($param);
865         case PARAM_TEXT:
866             // Leave only tags needed for multilang.
867             $param = fix_utf8($param);
868             // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
869             // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
870             do {
871                 if (strpos($param, '</lang>') !== false) {
872                     // Old and future mutilang syntax.
873                     $param = strip_tags($param, '<lang>');
874                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
875                         break;
876                     }
877                     $open = false;
878                     foreach ($matches[0] as $match) {
879                         if ($match === '</lang>') {
880                             if ($open) {
881                                 $open = false;
882                                 continue;
883                             } else {
884                                 break 2;
885                             }
886                         }
887                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
888                             break 2;
889                         } else {
890                             $open = true;
891                         }
892                     }
893                     if ($open) {
894                         break;
895                     }
896                     return $param;
898                 } else if (strpos($param, '</span>') !== false) {
899                     // Current problematic multilang syntax.
900                     $param = strip_tags($param, '<span>');
901                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
902                         break;
903                     }
904                     $open = false;
905                     foreach ($matches[0] as $match) {
906                         if ($match === '</span>') {
907                             if ($open) {
908                                 $open = false;
909                                 continue;
910                             } else {
911                                 break 2;
912                             }
913                         }
914                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
915                             break 2;
916                         } else {
917                             $open = true;
918                         }
919                     }
920                     if ($open) {
921                         break;
922                     }
923                     return $param;
924                 }
925             } while (false);
926             // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
927             return strip_tags($param);
929         case PARAM_COMPONENT:
930             // We do not want any guessing here, either the name is correct or not
931             // please note only normalised component names are accepted.
932             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]+$/', $param)) {
933                 return '';
934             }
935             if (strpos($param, '__') !== false) {
936                 return '';
937             }
938             if (strpos($param, 'mod_') === 0) {
939                 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
940                 if (substr_count($param, '_') != 1) {
941                     return '';
942                 }
943             }
944             return $param;
946         case PARAM_PLUGIN:
947         case PARAM_AREA:
948             // We do not want any guessing here, either the name is correct or not.
949             if (!is_valid_plugin_name($param)) {
950                 return '';
951             }
952             return $param;
954         case PARAM_SAFEDIR:
955             // Remove everything not a-zA-Z0-9_- .
956             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
958         case PARAM_SAFEPATH:
959             // Remove everything not a-zA-Z0-9/_- .
960             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
962         case PARAM_FILE:
963             // Strip all suspicious characters from filename.
964             $param = fix_utf8($param);
965             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
966             if ($param === '.' || $param === '..') {
967                 $param = '';
968             }
969             return $param;
971         case PARAM_PATH:
972             // Strip all suspicious characters from file path.
973             $param = fix_utf8($param);
974             $param = str_replace('\\', '/', $param);
976             // Explode the path and clean each element using the PARAM_FILE rules.
977             $breadcrumb = explode('/', $param);
978             foreach ($breadcrumb as $key => $crumb) {
979                 if ($crumb === '.' && $key === 0) {
980                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
981                 } else {
982                     $crumb = clean_param($crumb, PARAM_FILE);
983                 }
984                 $breadcrumb[$key] = $crumb;
985             }
986             $param = implode('/', $breadcrumb);
988             // Remove multiple current path (./././) and multiple slashes (///).
989             $param = preg_replace('~//+~', '/', $param);
990             $param = preg_replace('~/(\./)+~', '/', $param);
991             return $param;
993         case PARAM_HOST:
994             // Allow FQDN or IPv4 dotted quad.
995             $param = preg_replace('/[^\.\d\w-]/', '', $param );
996             // Match ipv4 dotted quad.
997             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
998                 // Confirm values are ok.
999                 if ( $match[0] > 255
1000                      || $match[1] > 255
1001                      || $match[3] > 255
1002                      || $match[4] > 255 ) {
1003                     // Hmmm, what kind of dotted quad is this?
1004                     $param = '';
1005                 }
1006             } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1007                        && !preg_match('/^[\.-]/',  $param) // No leading dots/hyphens.
1008                        && !preg_match('/[\.-]$/',  $param) // No trailing dots/hyphens.
1009                        ) {
1010                 // All is ok - $param is respected.
1011             } else {
1012                 // All is not ok...
1013                 $param='';
1014             }
1015             return $param;
1017         case PARAM_URL:          // Allow safe ftp, http, mailto urls.
1018             $param = fix_utf8($param);
1019             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
1020             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
1021                 // All is ok, param is respected.
1022             } else {
1023                 // Not really ok.
1024                 $param ='';
1025             }
1026             return $param;
1028         case PARAM_LOCALURL:
1029             // Allow http absolute, root relative and relative URLs within wwwroot.
1030             $param = clean_param($param, PARAM_URL);
1031             if (!empty($param)) {
1032                 if (preg_match(':^/:', $param)) {
1033                     // Root-relative, ok!
1034                 } else if (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i', $param)) {
1035                     // Absolute, and matches our wwwroot.
1036                 } else {
1037                     // Relative - let's make sure there are no tricks.
1038                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1039                         // Looks ok.
1040                     } else {
1041                         $param = '';
1042                     }
1043                 }
1044             }
1045             return $param;
1047         case PARAM_PEM:
1048             $param = trim($param);
1049             // PEM formatted strings may contain letters/numbers and the symbols:
1050             //   forward slash: /
1051             //   plus sign:     +
1052             //   equal sign:    =
1053             //   , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
1054             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1055                 list($wholething, $body) = $matches;
1056                 unset($wholething, $matches);
1057                 $b64 = clean_param($body, PARAM_BASE64);
1058                 if (!empty($b64)) {
1059                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1060                 } else {
1061                     return '';
1062                 }
1063             }
1064             return '';
1066         case PARAM_BASE64:
1067             if (!empty($param)) {
1068                 // PEM formatted strings may contain letters/numbers and the symbols
1069                 //   forward slash: /
1070                 //   plus sign:     +
1071                 //   equal sign:    =.
1072                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1073                     return '';
1074                 }
1075                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1076                 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1077                 // than (or equal to) 64 characters long.
1078                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1079                     if ($i + 1 == $j) {
1080                         if (64 < strlen($lines[$i])) {
1081                             return '';
1082                         }
1083                         continue;
1084                     }
1086                     if (64 != strlen($lines[$i])) {
1087                         return '';
1088                     }
1089                 }
1090                 return implode("\n", $lines);
1091             } else {
1092                 return '';
1093             }
1095         case PARAM_TAG:
1096             $param = fix_utf8($param);
1097             // Please note it is not safe to use the tag name directly anywhere,
1098             // it must be processed with s(), urlencode() before embedding anywhere.
1099             // Remove some nasties.
1100             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1101             // Convert many whitespace chars into one.
1102             $param = preg_replace('/\s+/', ' ', $param);
1103             $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
1104             return $param;
1106         case PARAM_TAGLIST:
1107             $param = fix_utf8($param);
1108             $tags = explode(',', $param);
1109             $result = array();
1110             foreach ($tags as $tag) {
1111                 $res = clean_param($tag, PARAM_TAG);
1112                 if ($res !== '') {
1113                     $result[] = $res;
1114                 }
1115             }
1116             if ($result) {
1117                 return implode(',', $result);
1118             } else {
1119                 return '';
1120             }
1122         case PARAM_CAPABILITY:
1123             if (get_capability_info($param)) {
1124                 return $param;
1125             } else {
1126                 return '';
1127             }
1129         case PARAM_PERMISSION:
1130             $param = (int)$param;
1131             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1132                 return $param;
1133             } else {
1134                 return CAP_INHERIT;
1135             }
1137         case PARAM_AUTH:
1138             $param = clean_param($param, PARAM_PLUGIN);
1139             if (empty($param)) {
1140                 return '';
1141             } else if (exists_auth_plugin($param)) {
1142                 return $param;
1143             } else {
1144                 return '';
1145             }
1147         case PARAM_LANG:
1148             $param = clean_param($param, PARAM_SAFEDIR);
1149             if (get_string_manager()->translation_exists($param)) {
1150                 return $param;
1151             } else {
1152                 // Specified language is not installed or param malformed.
1153                 return '';
1154             }
1156         case PARAM_THEME:
1157             $param = clean_param($param, PARAM_PLUGIN);
1158             if (empty($param)) {
1159                 return '';
1160             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1161                 return $param;
1162             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1163                 return $param;
1164             } else {
1165                 // Specified theme is not installed.
1166                 return '';
1167             }
1169         case PARAM_USERNAME:
1170             $param = fix_utf8($param);
1171             $param = str_replace(" " , "", $param);
1172             // Convert uppercase to lowercase MDL-16919.
1173             $param = core_text::strtolower($param);
1174             if (empty($CFG->extendedusernamechars)) {
1175                 // Regular expression, eliminate all chars EXCEPT:
1176                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1177                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1178             }
1179             return $param;
1181         case PARAM_EMAIL:
1182             $param = fix_utf8($param);
1183             if (validate_email($param)) {
1184                 return $param;
1185             } else {
1186                 return '';
1187             }
1189         case PARAM_STRINGID:
1190             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1191                 return $param;
1192             } else {
1193                 return '';
1194             }
1196         case PARAM_TIMEZONE:
1197             // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
1198             $param = fix_utf8($param);
1199             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1200             if (preg_match($timezonepattern, $param)) {
1201                 return $param;
1202             } else {
1203                 return '';
1204             }
1206         default:
1207             // Doh! throw error, switched parameters in optional_param or another serious problem.
1208             print_error("unknownparamtype", '', '', $type);
1209     }
1212 /**
1213  * Makes sure the data is using valid utf8, invalid characters are discarded.
1214  *
1215  * Note: this function is not intended for full objects with methods and private properties.
1216  *
1217  * @param mixed $value
1218  * @return mixed with proper utf-8 encoding
1219  */
1220 function fix_utf8($value) {
1221     if (is_null($value) or $value === '') {
1222         return $value;
1224     } else if (is_string($value)) {
1225         if ((string)(int)$value === $value) {
1226             // Shortcut.
1227             return $value;
1228         }
1229         // No null bytes expected in our data, so let's remove it.
1230         $value = str_replace("\0", '', $value);
1232         // Note: this duplicates min_fix_utf8() intentionally.
1233         static $buggyiconv = null;
1234         if ($buggyiconv === null) {
1235             $buggyiconv = (!function_exists('iconv') or @iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1236         }
1238         if ($buggyiconv) {
1239             if (function_exists('mb_convert_encoding')) {
1240                 $subst = mb_substitute_character();
1241                 mb_substitute_character('');
1242                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1243                 mb_substitute_character($subst);
1245             } else {
1246                 // Warn admins on admin/index.php page.
1247                 $result = $value;
1248             }
1250         } else {
1251             $result = @iconv('UTF-8', 'UTF-8//IGNORE', $value);
1252         }
1254         return $result;
1256     } else if (is_array($value)) {
1257         foreach ($value as $k => $v) {
1258             $value[$k] = fix_utf8($v);
1259         }
1260         return $value;
1262     } else if (is_object($value)) {
1263         // Do not modify original.
1264         $value = clone($value);
1265         foreach ($value as $k => $v) {
1266             $value->$k = fix_utf8($v);
1267         }
1268         return $value;
1270     } else {
1271         // This is some other type, no utf-8 here.
1272         return $value;
1273     }
1276 /**
1277  * Return true if given value is integer or string with integer value
1278  *
1279  * @param mixed $value String or Int
1280  * @return bool true if number, false if not
1281  */
1282 function is_number($value) {
1283     if (is_int($value)) {
1284         return true;
1285     } else if (is_string($value)) {
1286         return ((string)(int)$value) === $value;
1287     } else {
1288         return false;
1289     }
1292 /**
1293  * Returns host part from url.
1294  *
1295  * @param string $url full url
1296  * @return string host, null if not found
1297  */
1298 function get_host_from_url($url) {
1299     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1300     if ($matches) {
1301         return $matches[1];
1302     }
1303     return null;
1306 /**
1307  * Tests whether anything was returned by text editor
1308  *
1309  * This function is useful for testing whether something you got back from
1310  * the HTML editor actually contains anything. Sometimes the HTML editor
1311  * appear to be empty, but actually you get back a <br> tag or something.
1312  *
1313  * @param string $string a string containing HTML.
1314  * @return boolean does the string contain any actual content - that is text,
1315  * images, objects, etc.
1316  */
1317 function html_is_blank($string) {
1318     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1321 /**
1322  * Set a key in global configuration
1323  *
1324  * Set a key/value pair in both this session's {@link $CFG} global variable
1325  * and in the 'config' database table for future sessions.
1326  *
1327  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1328  * In that case it doesn't affect $CFG.
1329  *
1330  * A NULL value will delete the entry.
1331  *
1332  * @param string $name the key to set
1333  * @param string $value the value to set (without magic quotes)
1334  * @param string $plugin (optional) the plugin scope, default null
1335  * @return bool true or exception
1336  */
1337 function set_config($name, $value, $plugin=null) {
1338     global $CFG, $DB;
1340     if (empty($plugin)) {
1341         if (!array_key_exists($name, $CFG->config_php_settings)) {
1342             // So it's defined for this invocation at least.
1343             if (is_null($value)) {
1344                 unset($CFG->$name);
1345             } else {
1346                 // Settings from db are always strings.
1347                 $CFG->$name = (string)$value;
1348             }
1349         }
1351         if ($DB->get_field('config', 'name', array('name' => $name))) {
1352             if ($value === null) {
1353                 $DB->delete_records('config', array('name' => $name));
1354             } else {
1355                 $DB->set_field('config', 'value', $value, array('name' => $name));
1356             }
1357         } else {
1358             if ($value !== null) {
1359                 $config = new stdClass();
1360                 $config->name  = $name;
1361                 $config->value = $value;
1362                 $DB->insert_record('config', $config, false);
1363             }
1364         }
1365         if ($name === 'siteidentifier') {
1366             cache_helper::update_site_identifier($value);
1367         }
1368         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1369     } else {
1370         // Plugin scope.
1371         if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
1372             if ($value===null) {
1373                 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1374             } else {
1375                 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
1376             }
1377         } else {
1378             if ($value !== null) {
1379                 $config = new stdClass();
1380                 $config->plugin = $plugin;
1381                 $config->name   = $name;
1382                 $config->value  = $value;
1383                 $DB->insert_record('config_plugins', $config, false);
1384             }
1385         }
1386         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1387     }
1389     return true;
1392 /**
1393  * Get configuration values from the global config table
1394  * or the config_plugins table.
1395  *
1396  * If called with one parameter, it will load all the config
1397  * variables for one plugin, and return them as an object.
1398  *
1399  * If called with 2 parameters it will return a string single
1400  * value or false if the value is not found.
1401  *
1402  * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
1403  *     that we need only fetch it once per request.
1404  * @param string $plugin full component name
1405  * @param string $name default null
1406  * @return mixed hash-like object or single value, return false no config found
1407  * @throws dml_exception
1408  */
1409 function get_config($plugin, $name = null) {
1410     global $CFG, $DB;
1412     static $siteidentifier = null;
1414     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1415         $forced =& $CFG->config_php_settings;
1416         $iscore = true;
1417         $plugin = 'core';
1418     } else {
1419         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1420             $forced =& $CFG->forced_plugin_settings[$plugin];
1421         } else {
1422             $forced = array();
1423         }
1424         $iscore = false;
1425     }
1427     if ($siteidentifier === null) {
1428         try {
1429             // This may fail during installation.
1430             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1431             // install the database.
1432             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1433         } catch (dml_exception $ex) {
1434             // Set siteidentifier to false. We don't want to trip this continually.
1435             $siteidentifier = false;
1436             throw $ex;
1437         }
1438     }
1440     if (!empty($name)) {
1441         if (array_key_exists($name, $forced)) {
1442             return (string)$forced[$name];
1443         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1444             return $siteidentifier;
1445         }
1446     }
1448     $cache = cache::make('core', 'config');
1449     $result = $cache->get($plugin);
1450     if ($result === false) {
1451         // The user is after a recordset.
1452         if (!$iscore) {
1453             $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
1454         } else {
1455             // This part is not really used any more, but anyway...
1456             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1457         }
1458         $cache->set($plugin, $result);
1459     }
1461     if (!empty($name)) {
1462         if (array_key_exists($name, $result)) {
1463             return $result[$name];
1464         }
1465         return false;
1466     }
1468     if ($plugin === 'core') {
1469         $result['siteidentifier'] = $siteidentifier;
1470     }
1472     foreach ($forced as $key => $value) {
1473         if (is_null($value) or is_array($value) or is_object($value)) {
1474             // We do not want any extra mess here, just real settings that could be saved in db.
1475             unset($result[$key]);
1476         } else {
1477             // Convert to string as if it went through the DB.
1478             $result[$key] = (string)$value;
1479         }
1480     }
1482     return (object)$result;
1485 /**
1486  * Removes a key from global configuration.
1487  *
1488  * @param string $name the key to set
1489  * @param string $plugin (optional) the plugin scope
1490  * @return boolean whether the operation succeeded.
1491  */
1492 function unset_config($name, $plugin=null) {
1493     global $CFG, $DB;
1495     if (empty($plugin)) {
1496         unset($CFG->$name);
1497         $DB->delete_records('config', array('name' => $name));
1498         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1499     } else {
1500         $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1501         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1502     }
1504     return true;
1507 /**
1508  * Remove all the config variables for a given plugin.
1509  *
1510  * NOTE: this function is called from lib/db/upgrade.php
1511  *
1512  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1513  * @return boolean whether the operation succeeded.
1514  */
1515 function unset_all_config_for_plugin($plugin) {
1516     global $DB;
1517     // Delete from the obvious config_plugins first.
1518     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1519     // Next delete any suspect settings from config.
1520     $like = $DB->sql_like('name', '?', true, true, false, '|');
1521     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1522     $DB->delete_records_select('config', $like, $params);
1523     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1524     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1526     return true;
1529 /**
1530  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1531  *
1532  * All users are verified if they still have the necessary capability.
1533  *
1534  * @param string $value the value of the config setting.
1535  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1536  * @param bool $includeadmins include administrators.
1537  * @return array of user objects.
1538  */
1539 function get_users_from_config($value, $capability, $includeadmins = true) {
1540     if (empty($value) or $value === '$@NONE@$') {
1541         return array();
1542     }
1544     // We have to make sure that users still have the necessary capability,
1545     // it should be faster to fetch them all first and then test if they are present
1546     // instead of validating them one-by-one.
1547     $users = get_users_by_capability(context_system::instance(), $capability);
1548     if ($includeadmins) {
1549         $admins = get_admins();
1550         foreach ($admins as $admin) {
1551             $users[$admin->id] = $admin;
1552         }
1553     }
1555     if ($value === '$@ALL@$') {
1556         return $users;
1557     }
1559     $result = array(); // Result in correct order.
1560     $allowed = explode(',', $value);
1561     foreach ($allowed as $uid) {
1562         if (isset($users[$uid])) {
1563             $user = $users[$uid];
1564             $result[$user->id] = $user;
1565         }
1566     }
1568     return $result;
1572 /**
1573  * Invalidates browser caches and cached data in temp.
1574  *
1575  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1576  * {@link phpunit_util::reset_dataroot()}
1577  *
1578  * @return void
1579  */
1580 function purge_all_caches() {
1581     global $CFG, $DB;
1583     reset_text_filters_cache();
1584     js_reset_all_caches();
1585     theme_reset_all_caches();
1586     get_string_manager()->reset_caches();
1587     core_text::reset_caches();
1588     if (class_exists('core_plugin_manager')) {
1589         core_plugin_manager::reset_caches();
1590     }
1592     // Bump up cacherev field for all courses.
1593     try {
1594         increment_revision_number('course', 'cacherev', '');
1595     } catch (moodle_exception $e) {
1596         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1597     }
1599     $DB->reset_caches();
1600     cache_helper::purge_all();
1602     // Purge all other caches: rss, simplepie, etc.
1603     remove_dir($CFG->cachedir.'', true);
1605     // Make sure cache dir is writable, throws exception if not.
1606     make_cache_directory('');
1608     // This is the only place where we purge local caches, we are only adding files there.
1609     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1610     remove_dir($CFG->localcachedir, true);
1611     set_config('localcachedirpurged', time());
1612     make_localcache_directory('', true);
1615 /**
1616  * Get volatile flags
1617  *
1618  * @param string $type
1619  * @param int $changedsince default null
1620  * @return array records array
1621  */
1622 function get_cache_flags($type, $changedsince = null) {
1623     global $DB;
1625     $params = array('type' => $type, 'expiry' => time());
1626     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1627     if ($changedsince !== null) {
1628         $params['changedsince'] = $changedsince;
1629         $sqlwhere .= " AND timemodified > :changedsince";
1630     }
1631     $cf = array();
1632     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1633         foreach ($flags as $flag) {
1634             $cf[$flag->name] = $flag->value;
1635         }
1636     }
1637     return $cf;
1640 /**
1641  * Get volatile flags
1642  *
1643  * @param string $type
1644  * @param string $name
1645  * @param int $changedsince default null
1646  * @return string|false The cache flag value or false
1647  */
1648 function get_cache_flag($type, $name, $changedsince=null) {
1649     global $DB;
1651     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1653     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1654     if ($changedsince !== null) {
1655         $params['changedsince'] = $changedsince;
1656         $sqlwhere .= " AND timemodified > :changedsince";
1657     }
1659     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1662 /**
1663  * Set a volatile flag
1664  *
1665  * @param string $type the "type" namespace for the key
1666  * @param string $name the key to set
1667  * @param string $value the value to set (without magic quotes) - null will remove the flag
1668  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1669  * @return bool Always returns true
1670  */
1671 function set_cache_flag($type, $name, $value, $expiry = null) {
1672     global $DB;
1674     $timemodified = time();
1675     if ($expiry === null || $expiry < $timemodified) {
1676         $expiry = $timemodified + 24 * 60 * 60;
1677     } else {
1678         $expiry = (int)$expiry;
1679     }
1681     if ($value === null) {
1682         unset_cache_flag($type, $name);
1683         return true;
1684     }
1686     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1687         // This is a potential problem in DEBUG_DEVELOPER.
1688         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1689             return true; // No need to update.
1690         }
1691         $f->value        = $value;
1692         $f->expiry       = $expiry;
1693         $f->timemodified = $timemodified;
1694         $DB->update_record('cache_flags', $f);
1695     } else {
1696         $f = new stdClass();
1697         $f->flagtype     = $type;
1698         $f->name         = $name;
1699         $f->value        = $value;
1700         $f->expiry       = $expiry;
1701         $f->timemodified = $timemodified;
1702         $DB->insert_record('cache_flags', $f);
1703     }
1704     return true;
1707 /**
1708  * Removes a single volatile flag
1709  *
1710  * @param string $type the "type" namespace for the key
1711  * @param string $name the key to set
1712  * @return bool
1713  */
1714 function unset_cache_flag($type, $name) {
1715     global $DB;
1716     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1717     return true;
1720 /**
1721  * Garbage-collect volatile flags
1722  *
1723  * @return bool Always returns true
1724  */
1725 function gc_cache_flags() {
1726     global $DB;
1727     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1728     return true;
1731 // USER PREFERENCE API.
1733 /**
1734  * Refresh user preference cache. This is used most often for $USER
1735  * object that is stored in session, but it also helps with performance in cron script.
1736  *
1737  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1738  *
1739  * @package  core
1740  * @category preference
1741  * @access   public
1742  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1743  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1744  * @throws   coding_exception
1745  * @return   null
1746  */
1747 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1748     global $DB;
1749     // Static cache, we need to check on each page load, not only every 2 minutes.
1750     static $loadedusers = array();
1752     if (!isset($user->id)) {
1753         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1754     }
1756     if (empty($user->id) or isguestuser($user->id)) {
1757         // No permanent storage for not-logged-in users and guest.
1758         if (!isset($user->preference)) {
1759             $user->preference = array();
1760         }
1761         return;
1762     }
1764     $timenow = time();
1766     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1767         // Already loaded at least once on this page. Are we up to date?
1768         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1769             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1770             return;
1772         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1773             // No change since the lastcheck on this page.
1774             $user->preference['_lastloaded'] = $timenow;
1775             return;
1776         }
1777     }
1779     // OK, so we have to reload all preferences.
1780     $loadedusers[$user->id] = true;
1781     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1782     $user->preference['_lastloaded'] = $timenow;
1785 /**
1786  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1787  *
1788  * NOTE: internal function, do not call from other code.
1789  *
1790  * @package core
1791  * @access private
1792  * @param integer $userid the user whose prefs were changed.
1793  */
1794 function mark_user_preferences_changed($userid) {
1795     global $CFG;
1797     if (empty($userid) or isguestuser($userid)) {
1798         // No cache flags for guest and not-logged-in users.
1799         return;
1800     }
1802     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1805 /**
1806  * Sets a preference for the specified user.
1807  *
1808  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1809  *
1810  * @package  core
1811  * @category preference
1812  * @access   public
1813  * @param    string            $name  The key to set as preference for the specified user
1814  * @param    string            $value The value to set for the $name key in the specified user's
1815  *                                    record, null means delete current value.
1816  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1817  * @throws   coding_exception
1818  * @return   bool                     Always true or exception
1819  */
1820 function set_user_preference($name, $value, $user = null) {
1821     global $USER, $DB;
1823     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1824         throw new coding_exception('Invalid preference name in set_user_preference() call');
1825     }
1827     if (is_null($value)) {
1828         // Null means delete current.
1829         return unset_user_preference($name, $user);
1830     } else if (is_object($value)) {
1831         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1832     } else if (is_array($value)) {
1833         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1834     }
1835     // Value column maximum length is 1333 characters.
1836     $value = (string)$value;
1837     if (core_text::strlen($value) > 1333) {
1838         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1839     }
1841     if (is_null($user)) {
1842         $user = $USER;
1843     } else if (isset($user->id)) {
1844         // It is a valid object.
1845     } else if (is_numeric($user)) {
1846         $user = (object)array('id' => (int)$user);
1847     } else {
1848         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1849     }
1851     check_user_preferences_loaded($user);
1853     if (empty($user->id) or isguestuser($user->id)) {
1854         // No permanent storage for not-logged-in users and guest.
1855         $user->preference[$name] = $value;
1856         return true;
1857     }
1859     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1860         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1861             // Preference already set to this value.
1862             return true;
1863         }
1864         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1866     } else {
1867         $preference = new stdClass();
1868         $preference->userid = $user->id;
1869         $preference->name   = $name;
1870         $preference->value  = $value;
1871         $DB->insert_record('user_preferences', $preference);
1872     }
1874     // Update value in cache.
1875     $user->preference[$name] = $value;
1877     // Set reload flag for other sessions.
1878     mark_user_preferences_changed($user->id);
1880     return true;
1883 /**
1884  * Sets a whole array of preferences for the current user
1885  *
1886  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1887  *
1888  * @package  core
1889  * @category preference
1890  * @access   public
1891  * @param    array             $prefarray An array of key/value pairs to be set
1892  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1893  * @return   bool                         Always true or exception
1894  */
1895 function set_user_preferences(array $prefarray, $user = null) {
1896     foreach ($prefarray as $name => $value) {
1897         set_user_preference($name, $value, $user);
1898     }
1899     return true;
1902 /**
1903  * Unsets a preference completely by deleting it from the database
1904  *
1905  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1906  *
1907  * @package  core
1908  * @category preference
1909  * @access   public
1910  * @param    string            $name The key to unset as preference for the specified user
1911  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1912  * @throws   coding_exception
1913  * @return   bool                    Always true or exception
1914  */
1915 function unset_user_preference($name, $user = null) {
1916     global $USER, $DB;
1918     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1919         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1920     }
1922     if (is_null($user)) {
1923         $user = $USER;
1924     } else if (isset($user->id)) {
1925         // It is a valid object.
1926     } else if (is_numeric($user)) {
1927         $user = (object)array('id' => (int)$user);
1928     } else {
1929         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1930     }
1932     check_user_preferences_loaded($user);
1934     if (empty($user->id) or isguestuser($user->id)) {
1935         // No permanent storage for not-logged-in user and guest.
1936         unset($user->preference[$name]);
1937         return true;
1938     }
1940     // Delete from DB.
1941     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
1943     // Delete the preference from cache.
1944     unset($user->preference[$name]);
1946     // Set reload flag for other sessions.
1947     mark_user_preferences_changed($user->id);
1949     return true;
1952 /**
1953  * Used to fetch user preference(s)
1954  *
1955  * If no arguments are supplied this function will return
1956  * all of the current user preferences as an array.
1957  *
1958  * If a name is specified then this function
1959  * attempts to return that particular preference value.  If
1960  * none is found, then the optional value $default is returned,
1961  * otherwise null.
1962  *
1963  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1964  *
1965  * @package  core
1966  * @category preference
1967  * @access   public
1968  * @param    string            $name    Name of the key to use in finding a preference value
1969  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1970  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1971  * @throws   coding_exception
1972  * @return   string|mixed|null          A string containing the value of a single preference. An
1973  *                                      array with all of the preferences or null
1974  */
1975 function get_user_preferences($name = null, $default = null, $user = null) {
1976     global $USER;
1978     if (is_null($name)) {
1979         // All prefs.
1980     } else if (is_numeric($name) or $name === '_lastloaded') {
1981         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1982     }
1984     if (is_null($user)) {
1985         $user = $USER;
1986     } else if (isset($user->id)) {
1987         // Is a valid object.
1988     } else if (is_numeric($user)) {
1989         $user = (object)array('id' => (int)$user);
1990     } else {
1991         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1992     }
1994     check_user_preferences_loaded($user);
1996     if (empty($name)) {
1997         // All values.
1998         return $user->preference;
1999     } else if (isset($user->preference[$name])) {
2000         // The single string value.
2001         return $user->preference[$name];
2002     } else {
2003         // Default value (null if not specified).
2004         return $default;
2005     }
2008 // FUNCTIONS FOR HANDLING TIME.
2010 /**
2011  * Given date parts in user time produce a GMT timestamp.
2012  *
2013  * @package core
2014  * @category time
2015  * @param int $year The year part to create timestamp of
2016  * @param int $month The month part to create timestamp of
2017  * @param int $day The day part to create timestamp of
2018  * @param int $hour The hour part to create timestamp of
2019  * @param int $minute The minute part to create timestamp of
2020  * @param int $second The second part to create timestamp of
2021  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2022  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2023  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2024  *             applied only if timezone is 99 or string.
2025  * @return int GMT timestamp
2026  */
2027 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2029     // Save input timezone, required for dst offset check.
2030     $passedtimezone = $timezone;
2032     $timezone = get_user_timezone_offset($timezone);
2034     if (abs($timezone) > 13) {
2035         // Server time.
2036         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2037     } else {
2038         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2039         $time = usertime($time, $timezone);
2041         // Apply dst for string timezones or if 99 then try dst offset with user's default timezone.
2042         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
2043             $time -= dst_offset_on($time, $passedtimezone);
2044         }
2045     }
2047     return $time;
2051 /**
2052  * Format a date/time (seconds) as weeks, days, hours etc as needed
2053  *
2054  * Given an amount of time in seconds, returns string
2055  * formatted nicely as weeks, days, hours etc as needed
2056  *
2057  * @package core
2058  * @category time
2059  * @uses MINSECS
2060  * @uses HOURSECS
2061  * @uses DAYSECS
2062  * @uses YEARSECS
2063  * @param int $totalsecs Time in seconds
2064  * @param stdClass $str Should be a time object
2065  * @return string A nicely formatted date/time string
2066  */
2067 function format_time($totalsecs, $str = null) {
2069     $totalsecs = abs($totalsecs);
2071     if (!$str) {
2072         // Create the str structure the slow way.
2073         $str = new stdClass();
2074         $str->day   = get_string('day');
2075         $str->days  = get_string('days');
2076         $str->hour  = get_string('hour');
2077         $str->hours = get_string('hours');
2078         $str->min   = get_string('min');
2079         $str->mins  = get_string('mins');
2080         $str->sec   = get_string('sec');
2081         $str->secs  = get_string('secs');
2082         $str->year  = get_string('year');
2083         $str->years = get_string('years');
2084     }
2086     $years     = floor($totalsecs/YEARSECS);
2087     $remainder = $totalsecs - ($years*YEARSECS);
2088     $days      = floor($remainder/DAYSECS);
2089     $remainder = $totalsecs - ($days*DAYSECS);
2090     $hours     = floor($remainder/HOURSECS);
2091     $remainder = $remainder - ($hours*HOURSECS);
2092     $mins      = floor($remainder/MINSECS);
2093     $secs      = $remainder - ($mins*MINSECS);
2095     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2096     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2097     $sh = ($hours == 1) ? $str->hour : $str->hours;
2098     $sd = ($days == 1)  ? $str->day  : $str->days;
2099     $sy = ($years == 1)  ? $str->year  : $str->years;
2101     $oyears = '';
2102     $odays = '';
2103     $ohours = '';
2104     $omins = '';
2105     $osecs = '';
2107     if ($years) {
2108         $oyears  = $years .' '. $sy;
2109     }
2110     if ($days) {
2111         $odays  = $days .' '. $sd;
2112     }
2113     if ($hours) {
2114         $ohours = $hours .' '. $sh;
2115     }
2116     if ($mins) {
2117         $omins  = $mins .' '. $sm;
2118     }
2119     if ($secs) {
2120         $osecs  = $secs .' '. $ss;
2121     }
2123     if ($years) {
2124         return trim($oyears .' '. $odays);
2125     }
2126     if ($days) {
2127         return trim($odays .' '. $ohours);
2128     }
2129     if ($hours) {
2130         return trim($ohours .' '. $omins);
2131     }
2132     if ($mins) {
2133         return trim($omins .' '. $osecs);
2134     }
2135     if ($secs) {
2136         return $osecs;
2137     }
2138     return get_string('now');
2141 /**
2142  * Returns a formatted string that represents a date in user time.
2143  *
2144  * @package core
2145  * @category time
2146  * @param int $date the timestamp in UTC, as obtained from the database.
2147  * @param string $format strftime format. You should probably get this using
2148  *        get_string('strftime...', 'langconfig');
2149  * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2150  *        not 99 then daylight saving will not be added.
2151  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2152  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2153  *        If false then the leading zero is maintained.
2154  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2155  * @return string the formatted date/time.
2156  */
2157 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2158     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2159     return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
2162 /**
2163  * Returns a formatted date ensuring it is UTF-8.
2164  *
2165  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2166  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2167  *
2168  * This function does not do any calculation regarding the user preferences and should
2169  * therefore receive the final date timestamp, format and timezone. Timezone being only used
2170  * to differentiate the use of server time or not (strftime() against gmstrftime()).
2171  *
2172  * @param int $date the timestamp.
2173  * @param string $format strftime format.
2174  * @param int|float $tz the numerical timezone, typically returned by {@link get_user_timezone_offset()}.
2175  * @return string the formatted date/time.
2176  * @since 2.3.3
2177  */
2178 function date_format_string($date, $format, $tz = 99) {
2179     global $CFG;
2181     $localewincharset = null;
2182     // Get the calendar type user is using.
2183     if ($CFG->ostype == 'WINDOWS') {
2184         $calendartype = \core_calendar\type_factory::get_calendar_instance();
2185         $localewincharset = $calendartype->locale_win_charset();
2186     }
2188     if (abs($tz) > 13) {
2189         if ($localewincharset) {
2190             $format = core_text::convert($format, 'utf-8', $localewincharset);
2191             $datestring = strftime($format, $date);
2192             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2193         } else {
2194             $datestring = strftime($format, $date);
2195         }
2196     } else {
2197         if ($localewincharset) {
2198             $format = core_text::convert($format, 'utf-8', $localewincharset);
2199             $datestring = gmstrftime($format, $date);
2200             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2201         } else {
2202             $datestring = gmstrftime($format, $date);
2203         }
2204     }
2205     return $datestring;
2208 /**
2209  * Given a $time timestamp in GMT (seconds since epoch),
2210  * returns an array that represents the date in user time
2211  *
2212  * @package core
2213  * @category time
2214  * @uses HOURSECS
2215  * @param int $time Timestamp in GMT
2216  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2217  *        dst offset is applied {@link http://docs.moodle.org/dev/Time_API#Timezone}
2218  * @return array An array that represents the date in user time
2219  */
2220 function usergetdate($time, $timezone=99) {
2222     // Save input timezone, required for dst offset check.
2223     $passedtimezone = $timezone;
2225     $timezone = get_user_timezone_offset($timezone);
2227     if (abs($timezone) > 13) {
2228         // Server time.
2229         return getdate($time);
2230     }
2232     // Add daylight saving offset for string timezones only, as we can't get dst for
2233     // float values. if timezone is 99 (user default timezone), then try update dst.
2234     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2235         $time += dst_offset_on($time, $passedtimezone);
2236     }
2238     $time += intval((float)$timezone * HOURSECS);
2240     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2242     // Be careful to ensure the returned array matches that produced by getdate() above.
2243     list(
2244         $getdate['month'],
2245         $getdate['weekday'],
2246         $getdate['yday'],
2247         $getdate['year'],
2248         $getdate['mon'],
2249         $getdate['wday'],
2250         $getdate['mday'],
2251         $getdate['hours'],
2252         $getdate['minutes'],
2253         $getdate['seconds']
2254     ) = explode('_', $datestring);
2256     // Set correct datatype to match with getdate().
2257     $getdate['seconds'] = (int)$getdate['seconds'];
2258     $getdate['yday'] = (int)$getdate['yday'] - 1; // The function gmstrftime returns 0 through 365.
2259     $getdate['year'] = (int)$getdate['year'];
2260     $getdate['mon'] = (int)$getdate['mon'];
2261     $getdate['wday'] = (int)$getdate['wday'];
2262     $getdate['mday'] = (int)$getdate['mday'];
2263     $getdate['hours'] = (int)$getdate['hours'];
2264     $getdate['minutes'] = (int)$getdate['minutes'];
2265     return $getdate;
2268 /**
2269  * Given a GMT timestamp (seconds since epoch), offsets it by
2270  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2271  *
2272  * @package core
2273  * @category time
2274  * @uses HOURSECS
2275  * @param int $date Timestamp in GMT
2276  * @param float|int|string $timezone timezone to calculate GMT time offset before
2277  *        calculating user time, 99 is default user timezone
2278  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2279  * @return int
2280  */
2281 function usertime($date, $timezone=99) {
2283     $timezone = get_user_timezone_offset($timezone);
2285     if (abs($timezone) > 13) {
2286         return $date;
2287     }
2288     return $date - (int)($timezone * HOURSECS);
2291 /**
2292  * Given a time, return the GMT timestamp of the most recent midnight
2293  * for the current user.
2294  *
2295  * @package core
2296  * @category time
2297  * @param int $date Timestamp in GMT
2298  * @param float|int|string $timezone timezone to calculate GMT time offset before
2299  *        calculating user midnight time, 99 is default user timezone
2300  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2301  * @return int Returns a GMT timestamp
2302  */
2303 function usergetmidnight($date, $timezone=99) {
2305     $userdate = usergetdate($date, $timezone);
2307     // Time of midnight of this user's day, in GMT.
2308     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2312 /**
2313  * Returns a string that prints the user's timezone
2314  *
2315  * @package core
2316  * @category time
2317  * @param float|int|string $timezone timezone to calculate GMT time offset before
2318  *        calculating user timezone, 99 is default user timezone
2319  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2320  * @return string
2321  */
2322 function usertimezone($timezone=99) {
2324     $tz = get_user_timezone($timezone);
2326     if (!is_float($tz)) {
2327         return $tz;
2328     }
2330     if (abs($tz) > 13) {
2331         // Server time.
2332         return get_string('serverlocaltime');
2333     }
2335     if ($tz == intval($tz)) {
2336         // Don't show .0 for whole hours.
2337         $tz = intval($tz);
2338     }
2340     if ($tz == 0) {
2341         return 'UTC';
2342     } else if ($tz > 0) {
2343         return 'UTC+'.$tz;
2344     } else {
2345         return 'UTC'.$tz;
2346     }
2350 /**
2351  * Returns a float which represents the user's timezone difference from GMT in hours
2352  * Checks various settings and picks the most dominant of those which have a value
2353  *
2354  * @package core
2355  * @category time
2356  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2357  *        99 is default user timezone
2358  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2359  * @return float
2360  */
2361 function get_user_timezone_offset($tz = 99) {
2362     $tz = get_user_timezone($tz);
2364     if (is_float($tz)) {
2365         return $tz;
2366     } else {
2367         $tzrecord = get_timezone_record($tz);
2368         if (empty($tzrecord)) {
2369             return 99.0;
2370         }
2371         return (float)$tzrecord->gmtoff / HOURMINS;
2372     }
2375 /**
2376  * Returns an int which represents the systems's timezone difference from GMT in seconds
2377  *
2378  * @package core
2379  * @category time
2380  * @param float|int|string $tz timezone for which offset is required.
2381  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2382  * @return int|bool if found, false is timezone 99 or error
2383  */
2384 function get_timezone_offset($tz) {
2385     if ($tz == 99) {
2386         return false;
2387     }
2389     if (is_numeric($tz)) {
2390         return intval($tz * 60*60);
2391     }
2393     if (!$tzrecord = get_timezone_record($tz)) {
2394         return false;
2395     }
2396     return intval($tzrecord->gmtoff * 60);
2399 /**
2400  * Returns a float or a string which denotes the user's timezone
2401  * 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)
2402  * means that for this timezone there are also DST rules to be taken into account
2403  * Checks various settings and picks the most dominant of those which have a value
2404  *
2405  * @package core
2406  * @category time
2407  * @param float|int|string $tz timezone to calculate GMT time offset before
2408  *        calculating user timezone, 99 is default user timezone
2409  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2410  * @return float|string
2411  */
2412 function get_user_timezone($tz = 99) {
2413     global $USER, $CFG;
2415     $timezones = array(
2416         $tz,
2417         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2418         isset($USER->timezone) ? $USER->timezone : 99,
2419         isset($CFG->timezone) ? $CFG->timezone : 99,
2420         );
2422     $tz = 99;
2424     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2425     while (((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2426         $tz = $next['value'];
2427     }
2428     return is_numeric($tz) ? (float) $tz : $tz;
2431 /**
2432  * Returns cached timezone record for given $timezonename
2433  *
2434  * @package core
2435  * @param string $timezonename name of the timezone
2436  * @return stdClass|bool timezonerecord or false
2437  */
2438 function get_timezone_record($timezonename) {
2439     global $DB;
2440     static $cache = null;
2442     if ($cache === null) {
2443         $cache = array();
2444     }
2446     if (isset($cache[$timezonename])) {
2447         return $cache[$timezonename];
2448     }
2450     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2451                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2454 /**
2455  * Build and store the users Daylight Saving Time (DST) table
2456  *
2457  * @package core
2458  * @param int $fromyear Start year for the table, defaults to 1971
2459  * @param int $toyear End year for the table, defaults to 2035
2460  * @param int|float|string $strtimezone timezone to check if dst should be applied.
2461  * @return bool
2462  */
2463 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2464     global $SESSION, $DB;
2466     $usertz = get_user_timezone($strtimezone);
2468     if (is_float($usertz)) {
2469         // Trivial timezone, no DST.
2470         return false;
2471     }
2473     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2474         // We have pre-calculated values, but the user's effective TZ has changed in the meantime, so reset.
2475         unset($SESSION->dst_offsets);
2476         unset($SESSION->dst_range);
2477     }
2479     if (!empty($SESSION->dst_offsets) && empty($fromyear) && empty($toyear)) {
2480         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table.
2481         // This will be the return path most of the time, pretty light computationally.
2482         return true;
2483     }
2485     // Reaching here means we either need to extend our table or create it from scratch.
2487     // Remember which TZ we calculated these changes for.
2488     $SESSION->dst_offsettz = $usertz;
2490     if (empty($SESSION->dst_offsets)) {
2491         // If we 're creating from scratch, put the two guard elements in there.
2492         $SESSION->dst_offsets = array(1 => null, 0 => null);
2493     }
2494     if (empty($SESSION->dst_range)) {
2495         // If creating from scratch.
2496         $from = max((empty($fromyear) ? intval(date('Y')) - 3 : $fromyear), 1971);
2497         $to   = min((empty($toyear)   ? intval(date('Y')) + 3 : $toyear),   2035);
2499         // Fill in the array with the extra years we need to process.
2500         $yearstoprocess = array();
2501         for ($i = $from; $i <= $to; ++$i) {
2502             $yearstoprocess[] = $i;
2503         }
2505         // Take note of which years we have processed for future calls.
2506         $SESSION->dst_range = array($from, $to);
2507     } else {
2508         // If needing to extend the table, do the same.
2509         $yearstoprocess = array();
2511         $from = max((empty($fromyear) ? $SESSION->dst_range[0] : $fromyear), 1971);
2512         $to   = min((empty($toyear)   ? $SESSION->dst_range[1] : $toyear),   2035);
2514         if ($from < $SESSION->dst_range[0]) {
2515             // Take note of which years we need to process and then note that we have processed them for future calls.
2516             for ($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2517                 $yearstoprocess[] = $i;
2518             }
2519             $SESSION->dst_range[0] = $from;
2520         }
2521         if ($to > $SESSION->dst_range[1]) {
2522             // Take note of which years we need to process and then note that we have processed them for future calls.
2523             for ($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2524                 $yearstoprocess[] = $i;
2525             }
2526             $SESSION->dst_range[1] = $to;
2527         }
2528     }
2530     if (empty($yearstoprocess)) {
2531         // This means that there was a call requesting a SMALLER range than we have already calculated.
2532         return true;
2533     }
2535     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2536     // Also, the array is sorted in descending timestamp order!
2538     // Get DB data.
2540     static $presetscache = array();
2541     if (!isset($presetscache[$usertz])) {
2542         $presetscache[$usertz] = $DB->get_records('timezone', array('name' => $usertz),
2543             'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, '.
2544             'std_startday, std_weekday, std_skipweeks, std_time');
2545     }
2546     if (empty($presetscache[$usertz])) {
2547         return false;
2548     }
2550     // Remove ending guard (first element of the array).
2551     reset($SESSION->dst_offsets);
2552     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2554     // Add all required change timestamps.
2555     foreach ($yearstoprocess as $y) {
2556         // Find the record which is in effect for the year $y.
2557         foreach ($presetscache[$usertz] as $year => $preset) {
2558             if ($year <= $y) {
2559                 break;
2560             }
2561         }
2563         $changes = dst_changes_for_year($y, $preset);
2565         if ($changes === null) {
2566             continue;
2567         }
2568         if ($changes['dst'] != 0) {
2569             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2570         }
2571         if ($changes['std'] != 0) {
2572             $SESSION->dst_offsets[$changes['std']] = 0;
2573         }
2574     }
2576     // Put in a guard element at the top.
2577     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2578     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = null; // DAYSECS is arbitrary, any "small" number will do.
2580     // Sort again.
2581     krsort($SESSION->dst_offsets);
2583     return true;
2586 /**
2587  * Calculates the required DST change and returns a Timestamp Array
2588  *
2589  * @package core
2590  * @category time
2591  * @uses HOURSECS
2592  * @uses MINSECS
2593  * @param int|string $year Int or String Year to focus on
2594  * @param object $timezone Instatiated Timezone object
2595  * @return array|null Array dst => xx, 0 => xx, std => yy, 1 => yy or null
2596  */
2597 function dst_changes_for_year($year, $timezone) {
2599     if ($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 &&
2600         $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2601         return null;
2602     }
2604     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2605     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2607     list($dsthour, $dstmin) = explode(':', $timezone->dst_time);
2608     list($stdhour, $stdmin) = explode(':', $timezone->std_time);
2610     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2611     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2613     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2614     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2615     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2617     $timedst += $dsthour * HOURSECS + $dstmin * MINSECS;
2618     $timestd += $stdhour * HOURSECS + $stdmin * MINSECS;
2620     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2623 /**
2624  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2625  * - Note: Daylight saving only works for string timezones and not for float.
2626  *
2627  * @package core
2628  * @category time
2629  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2630  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2631  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2632  * @return int
2633  */
2634 function dst_offset_on($time, $strtimezone = null) {
2635     global $SESSION;
2637     if (!calculate_user_dst_table(null, null, $strtimezone) || empty($SESSION->dst_offsets)) {
2638         return 0;
2639     }
2641     reset($SESSION->dst_offsets);
2642     while (list($from, $offset) = each($SESSION->dst_offsets)) {
2643         if ($from <= $time) {
2644             break;
2645         }
2646     }
2648     // This is the normal return path.
2649     if ($offset !== null) {
2650         return $offset;
2651     }
2653     // Reaching this point means we haven't calculated far enough, do it now:
2654     // Calculate extra DST changes if needed and recurse. The recursion always
2655     // moves toward the stopping condition, so will always end.
2657     if ($from == 0) {
2658         // We need a year smaller than $SESSION->dst_range[0].
2659         if ($SESSION->dst_range[0] == 1971) {
2660             return 0;
2661         }
2662         calculate_user_dst_table($SESSION->dst_range[0] - 5, null, $strtimezone);
2663         return dst_offset_on($time, $strtimezone);
2664     } else {
2665         // We need a year larger than $SESSION->dst_range[1].
2666         if ($SESSION->dst_range[1] == 2035) {
2667             return 0;
2668         }
2669         calculate_user_dst_table(null, $SESSION->dst_range[1] + 5, $strtimezone);
2670         return dst_offset_on($time, $strtimezone);
2671     }
2674 /**
2675  * Calculates when the day appears in specific month
2676  *
2677  * @package core
2678  * @category time
2679  * @param int $startday starting day of the month
2680  * @param int $weekday The day when week starts (normally taken from user preferences)
2681  * @param int $month The month whose day is sought
2682  * @param int $year The year of the month whose day is sought
2683  * @return int
2684  */
2685 function find_day_in_month($startday, $weekday, $month, $year) {
2686     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2688     $daysinmonth = days_in_month($month, $year);
2689     $daysinweek = count($calendartype->get_weekdays());
2691     if ($weekday == -1) {
2692         // Don't care about weekday, so return:
2693         //    abs($startday) if $startday != -1
2694         //    $daysinmonth otherwise.
2695         return ($startday == -1) ? $daysinmonth : abs($startday);
2696     }
2698     // From now on we 're looking for a specific weekday.
2699     // Give "end of month" its actual value, since we know it.
2700     if ($startday == -1) {
2701         $startday = -1 * $daysinmonth;
2702     }
2704     // Starting from day $startday, the sign is the direction.
2705     if ($startday < 1) {
2706         $startday = abs($startday);
2707         $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
2709         // This is the last such weekday of the month.
2710         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2711         if ($lastinmonth > $daysinmonth) {
2712             $lastinmonth -= $daysinweek;
2713         }
2715         // Find the first such weekday <= $startday.
2716         while ($lastinmonth > $startday) {
2717             $lastinmonth -= $daysinweek;
2718         }
2720         return $lastinmonth;
2721     } else {
2722         $indexweekday = dayofweek($startday, $month, $year);
2724         $diff = $weekday - $indexweekday;
2725         if ($diff < 0) {
2726             $diff += $daysinweek;
2727         }
2729         // This is the first such weekday of the month equal to or after $startday.
2730         $firstfromindex = $startday + $diff;
2732         return $firstfromindex;
2733     }
2736 /**
2737  * Calculate the number of days in a given month
2738  *
2739  * @package core
2740  * @category time
2741  * @param int $month The month whose day count is sought
2742  * @param int $year The year of the month whose day count is sought
2743  * @return int
2744  */
2745 function days_in_month($month, $year) {
2746     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2747     return $calendartype->get_num_days_in_month($year, $month);
2750 /**
2751  * Calculate the position in the week of a specific calendar day
2752  *
2753  * @package core
2754  * @category time
2755  * @param int $day The day of the date whose position in the week is sought
2756  * @param int $month The month of the date whose position in the week is sought
2757  * @param int $year The year of the date whose position in the week is sought
2758  * @return int
2759  */
2760 function dayofweek($day, $month, $year) {
2761     $calendartype = \core_calendar\type_factory::get_calendar_instance();
2762     return $calendartype->get_weekday($year, $month, $day);
2765 // USER AUTHENTICATION AND LOGIN.
2767 /**
2768  * Returns full login url.
2769  *
2770  * @return string login url
2771  */
2772 function get_login_url() {
2773     global $CFG;
2775     $url = "$CFG->wwwroot/login/index.php";
2777     if (!empty($CFG->loginhttps)) {
2778         $url = str_replace('http:', 'https:', $url);
2779     }
2781     return $url;
2784 /**
2785  * This function checks that the current user is logged in and has the
2786  * required privileges
2787  *
2788  * This function checks that the current user is logged in, and optionally
2789  * whether they are allowed to be in a particular course and view a particular
2790  * course module.
2791  * If they are not logged in, then it redirects them to the site login unless
2792  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2793  * case they are automatically logged in as guests.
2794  * If $courseid is given and the user is not enrolled in that course then the
2795  * user is redirected to the course enrolment page.
2796  * If $cm is given and the course module is hidden and the user is not a teacher
2797  * in the course then the user is redirected to the course home page.
2798  *
2799  * When $cm parameter specified, this function sets page layout to 'module'.
2800  * You need to change it manually later if some other layout needed.
2801  *
2802  * @package    core_access
2803  * @category   access
2804  *
2805  * @param mixed $courseorid id of the course or course object
2806  * @param bool $autologinguest default true
2807  * @param object $cm course module object
2808  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2809  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2810  *             in order to keep redirects working properly. MDL-14495
2811  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2812  * @return mixed Void, exit, and die depending on path
2813  * @throws coding_exception
2814  * @throws require_login_exception
2815  */
2816 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2817     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2819     // Must not redirect when byteserving already started.
2820     if (!empty($_SERVER['HTTP_RANGE'])) {
2821         $preventredirect = true;
2822     }
2824     // Setup global $COURSE, themes, language and locale.
2825     if (!empty($courseorid)) {
2826         if (is_object($courseorid)) {
2827             $course = $courseorid;
2828         } else if ($courseorid == SITEID) {
2829             $course = clone($SITE);
2830         } else {
2831             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2832         }
2833         if ($cm) {
2834             if ($cm->course != $course->id) {
2835                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2836             }
2837             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2838             if (!($cm instanceof cm_info)) {
2839                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2840                 // db queries so this is not really a performance concern, however it is obviously
2841                 // better if you use get_fast_modinfo to get the cm before calling this.
2842                 $modinfo = get_fast_modinfo($course);
2843                 $cm = $modinfo->get_cm($cm->id);
2844             }
2845             $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
2846             $PAGE->set_pagelayout('incourse');
2847         } else {
2848             $PAGE->set_course($course); // Set's up global $COURSE.
2849         }
2850     } else {
2851         // Do not touch global $COURSE via $PAGE->set_course(),
2852         // the reasons is we need to be able to call require_login() at any time!!
2853         $course = $SITE;
2854         if ($cm) {
2855             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2856         }
2857     }
2859     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2860     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2861     // risk leading the user back to the AJAX request URL.
2862     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2863         $setwantsurltome = false;
2864     }
2866     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2867     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2868         if ($setwantsurltome) {
2869             $SESSION->wantsurl = qualified_me();
2870         }
2871         redirect(get_login_url());
2872     }
2874     // If the user is not even logged in yet then make sure they are.
2875     if (!isloggedin()) {
2876         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2877             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2878                 // Misconfigured site guest, just redirect to login page.
2879                 redirect(get_login_url());
2880                 exit; // Never reached.
2881             }
2882             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2883             complete_user_login($guest);
2884             $USER->autologinguest = true;
2885             $SESSION->lang = $lang;
2886         } else {
2887             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2888             if ($preventredirect) {
2889                 throw new require_login_exception('You are not logged in');
2890             }
2892             if ($setwantsurltome) {
2893                 $SESSION->wantsurl = qualified_me();
2894             }
2895             if (!empty($_SERVER['HTTP_REFERER'])) {
2896                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2897             }
2898             redirect(get_login_url());
2899             exit; // Never reached.
2900         }
2901     }
2903     // Loginas as redirection if needed.
2904     if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
2905         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2906             if ($USER->loginascontext->instanceid != $course->id) {
2907                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2908             }
2909         }
2910     }
2912     // Check whether the user should be changing password (but only if it is REALLY them).
2913     if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
2914         $userauth = get_auth_plugin($USER->auth);
2915         if ($userauth->can_change_password() and !$preventredirect) {
2916             if ($setwantsurltome) {
2917                 $SESSION->wantsurl = qualified_me();
2918             }
2919             if ($changeurl = $userauth->change_password_url()) {
2920                 // Use plugin custom url.
2921                 redirect($changeurl);
2922             } else {
2923                 // Use moodle internal method.
2924                 if (empty($CFG->loginhttps)) {
2925                     redirect($CFG->wwwroot .'/login/change_password.php');
2926                 } else {
2927                     $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
2928                     redirect($wwwroot .'/login/change_password.php');
2929                 }
2930             }
2931         } else {
2932             print_error('nopasswordchangeforced', 'auth');
2933         }
2934     }
2936     // Check that the user account is properly set up.
2937     if (user_not_fully_set_up($USER)) {
2938         if ($preventredirect) {
2939             throw new require_login_exception('User not fully set-up');
2940         }
2941         if ($setwantsurltome) {
2942             $SESSION->wantsurl = qualified_me();
2943         }
2944         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2945     }
2947     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2948     sesskey();
2950     // Do not bother admins with any formalities.
2951     if (is_siteadmin()) {
2952         // Set accesstime or the user will appear offline which messes up messaging.
2953         user_accesstime_log($course->id);
2954         return;
2955     }
2957     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2958     if (!$USER->policyagreed and !is_siteadmin()) {
2959         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2960             if ($preventredirect) {
2961                 throw new require_login_exception('Policy not agreed');
2962             }
2963             if ($setwantsurltome) {
2964                 $SESSION->wantsurl = qualified_me();
2965             }
2966             redirect($CFG->wwwroot .'/user/policy.php');
2967         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2968             if ($preventredirect) {
2969                 throw new require_login_exception('Policy not agreed');
2970             }
2971             if ($setwantsurltome) {
2972                 $SESSION->wantsurl = qualified_me();
2973             }
2974             redirect($CFG->wwwroot .'/user/policy.php');
2975         }
2976     }
2978     // Fetch the system context, the course context, and prefetch its child contexts.
2979     $sysctx = context_system::instance();
2980     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2981     if ($cm) {
2982         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2983     } else {
2984         $cmcontext = null;
2985     }
2987     // If the site is currently under maintenance, then print a message.
2988     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2989         if ($preventredirect) {
2990             throw new require_login_exception('Maintenance in progress');
2991         }
2993         print_maintenance_message();
2994     }
2996     // Make sure the course itself is not hidden.
2997     if ($course->id == SITEID) {
2998         // Frontpage can not be hidden.
2999     } else {
3000         if (is_role_switched($course->id)) {
3001             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
3002         } else {
3003             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
3004                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
3005                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
3006                 if ($preventredirect) {
3007                     throw new require_login_exception('Course is hidden');
3008                 }
3009                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
3010                 // the navigation will mess up when trying to find it.
3011                 navigation_node::override_active_url(new moodle_url('/'));
3012                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
3013             }
3014         }
3015     }
3017     // Is the user enrolled?
3018     if ($course->id == SITEID) {
3019         // Everybody is enrolled on the frontpage.
3020     } else {
3021         if (\core\session\manager::is_loggedinas()) {
3022             // Make sure the REAL person can access this course first.
3023             $realuser = \core\session\manager::get_realuser();
3024             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
3025                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
3026                 if ($preventredirect) {
3027                     throw new require_login_exception('Invalid course login-as access');
3028                 }
3029                 echo $OUTPUT->header();
3030                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
3031             }
3032         }
3034         $access = false;
3036         if (is_role_switched($course->id)) {
3037             // Ok, user had to be inside this course before the switch.
3038             $access = true;
3040         } else if (is_viewing($coursecontext, $USER)) {
3041             // Ok, no need to mess with enrol.
3042             $access = true;
3044         } else {
3045             if (isset($USER->enrol['enrolled'][$course->id])) {
3046                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3047                     $access = true;
3048                     if (isset($USER->enrol['tempguest'][$course->id])) {
3049                         unset($USER->enrol['tempguest'][$course->id]);
3050                         remove_temp_course_roles($coursecontext);
3051                     }
3052                 } else {
3053                     // Expired.
3054                     unset($USER->enrol['enrolled'][$course->id]);
3055                 }
3056             }
3057             if (isset($USER->enrol['tempguest'][$course->id])) {
3058                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3059                     $access = true;
3060                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3061                     $access = true;
3062                 } else {
3063                     // Expired.
3064                     unset($USER->enrol['tempguest'][$course->id]);
3065                     remove_temp_course_roles($coursecontext);
3066                 }
3067             }
3069             if (!$access) {
3070                 // Cache not ok.
3071                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3072                 if ($until !== false) {
3073                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
3074                     if ($until == 0) {
3075                         $until = ENROL_MAX_TIMESTAMP;
3076                     }
3077                     $USER->enrol['enrolled'][$course->id] = $until;
3078                     $access = true;
3080                 } else {
3081                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
3082                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
3083                     $enrols = enrol_get_plugins(true);
3084                     // First ask all enabled enrol instances in course if they want to auto enrol user.
3085                     foreach ($instances as $instance) {
3086                         if (!isset($enrols[$instance->enrol])) {
3087                             continue;
3088                         }
3089                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3090                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3091                         if ($until !== false) {
3092                             if ($until == 0) {
3093                                 $until = ENROL_MAX_TIMESTAMP;
3094                             }
3095                             $USER->enrol['enrolled'][$course->id] = $until;
3096                             $access = true;
3097                             break;
3098                         }
3099                     }
3100                     // If not enrolled yet try to gain temporary guest access.
3101                     if (!$access) {
3102                         foreach ($instances as $instance) {
3103                             if (!isset($enrols[$instance->enrol])) {
3104                                 continue;
3105                             }
3106                             // Get a duration for the guest access, a timestamp in the future or false.
3107                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3108                             if ($until !== false and $until > time()) {
3109                                 $USER->enrol['tempguest'][$course->id] = $until;
3110                                 $access = true;
3111                                 break;
3112                             }
3113                         }
3114                     }
3115                 }
3116             }
3117         }
3119         if (!$access) {
3120             if ($preventredirect) {
3121                 throw new require_login_exception('Not enrolled');
3122             }
3123             if ($setwantsurltome) {
3124                 $SESSION->wantsurl = qualified_me();
3125             }
3126             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3127         }
3128     }
3130     // Check visibility of activity to current user; includes visible flag, groupmembersonly, conditional availability, etc.
3131     if ($cm && !$cm->uservisible) {
3132         if ($preventredirect) {
3133             throw new require_login_exception('Activity is hidden');
3134         }
3135         if ($course->id != SITEID) {
3136             $url = new moodle_url('/course/view.php', array('id' => $course->id));
3137         } else {
3138             $url = new moodle_url('/');
3139         }
3140         redirect($url, get_string('activityiscurrentlyhidden'));
3141     }
3143     // Finally access granted, update lastaccess times.
3144     user_accesstime_log($course->id);
3148 /**
3149  * This function just makes sure a user is logged out.
3150  *
3151  * @package    core_access
3152  * @category   access
3153  */
3154 function require_logout() {
3155     global $USER, $DB;
3157     if (!isloggedin()) {
3158         // This should not happen often, no need for hooks or events here.
3159         \core\session\manager::terminate_current();
3160         return;
3161     }
3163     // Execute hooks before action.
3164     $authsequence = get_enabled_auth_plugins();
3165     foreach ($authsequence as $authname) {
3166         $authplugin = get_auth_plugin($authname);
3167         $authplugin->prelogout_hook();
3168     }
3170     // Store info that gets removed during logout.
3171     $sid = session_id();
3172     $event = \core\event\user_loggedout::create(
3173         array(
3174             'userid' => $USER->id,
3175             'objectid' => $USER->id,
3176             'other' => array('sessionid' => $sid),
3177         )
3178     );
3179     if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
3180         $event->add_record_snapshot('sessions', $session);
3181     }
3183     // Delete session record and drop $_SESSION content.
3184     \core\session\manager::terminate_current();
3186     // Trigger event AFTER action.
3187     $event->trigger();
3190 /**
3191  * Weaker version of require_login()
3192  *
3193  * This is a weaker version of {@link require_login()} which only requires login
3194  * when called from within a course rather than the site page, unless
3195  * the forcelogin option is turned on.
3196  * @see require_login()
3197  *
3198  * @package    core_access
3199  * @category   access
3200  *
3201  * @param mixed $courseorid The course object or id in question
3202  * @param bool $autologinguest Allow autologin guests if that is wanted
3203  * @param object $cm Course activity module if known
3204  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3205  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3206  *             in order to keep redirects working properly. MDL-14495
3207  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3208  * @return void
3209  * @throws coding_exception
3210  */
3211 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3212     global $CFG, $PAGE, $SITE;
3213     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3214           or (!is_object($courseorid) and $courseorid == SITEID);
3215     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3216         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3217         // db queries so this is not really a performance concern, however it is obviously
3218         // better if you use get_fast_modinfo to get the cm before calling this.
3219         if (is_object($courseorid)) {
3220             $course = $courseorid;
3221         } else {
3222             $course = clone($SITE);
3223         }
3224         $modinfo = get_fast_modinfo($course);
3225         $cm = $modinfo->get_cm($cm->id);
3226     }
3227     if (!empty($CFG->forcelogin)) {
3228         // Login required for both SITE and courses.
3229         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3231     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3232         // Always login for hidden activities.
3233         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3235     } else if ($issite) {
3236         // Login for SITE not required.
3237         if ($cm and empty($cm->visible)) {
3238             // Hidden activities are not accessible without login.
3239             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3240         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3241             // Not-logged-in users do not have any group membership.
3242             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3243         } else {
3244             // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3245             if (!empty($courseorid)) {
3246                 if (is_object($courseorid)) {
3247                     $course = $courseorid;
3248                 } else {
3249                     $course = clone($SITE);
3250                 }
3251                 if ($cm) {
3252                     if ($cm->course != $course->id) {
3253                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3254                     }
3255                     $PAGE->set_cm($cm, $course);
3256                     $PAGE->set_pagelayout('incourse');
3257                 } else {
3258                     $PAGE->set_course($course);
3259                 }
3260             } else {
3261                 // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3262                 $PAGE->set_course($PAGE->course);
3263             }
3264             // TODO: verify conditional activities here.
3265             user_accesstime_log(SITEID);
3266             return;
3267         }
3269     } else {
3270         // Course login always required.
3271         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3272     }
3275 /**
3276  * Require key login. Function terminates with error if key not found or incorrect.
3277  *
3278  * @uses NO_MOODLE_COOKIES
3279  * @uses PARAM_ALPHANUM
3280  * @param string $script unique script identifier
3281  * @param int $instance optional instance id
3282  * @return int Instance ID
3283  */
3284 function require_user_key_login($script, $instance=null) {
3285     global $DB;
3287     if (!NO_MOODLE_COOKIES) {
3288         print_error('sessioncookiesdisable');
3289     }
3291     // Extra safety.
3292     \core\session\manager::write_close();
3294     $keyvalue = required_param('key', PARAM_ALPHANUM);
3296     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3297         print_error('invalidkey');
3298     }
3300     if (!empty($key->validuntil) and $key->validuntil < time()) {
3301         print_error('expiredkey');
3302     }
3304     if ($key->iprestriction) {
3305         $remoteaddr = getremoteaddr(null);
3306         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3307             print_error('ipmismatch');
3308         }
3309     }
3311     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3312         print_error('invaliduserid');
3313     }
3315     // Emulate normal session.
3316     enrol_check_plugins($user);
3317     \core\session\manager::set_user($user);
3319     // Note we are not using normal login.
3320     if (!defined('USER_KEY_LOGIN')) {
3321         define('USER_KEY_LOGIN', true);
3322     }
3324     // Return instance id - it might be empty.
3325     return $key->instance;
3328 /**
3329  * Creates a new private user access key.
3330  *
3331  * @param string $script unique target identifier
3332  * @param int $userid
3333  * @param int $instance optional instance id
3334  * @param string $iprestriction optional ip restricted access
3335  * @param timestamp $validuntil key valid only until given data
3336  * @return string access key value
3337  */
3338 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3339     global $DB;
3341     $key = new stdClass();
3342     $key->script        = $script;
3343     $key->userid        = $userid;
3344     $key->instance      = $instance;
3345     $key->iprestriction = $iprestriction;
3346     $key->validuntil    = $validuntil;
3347     $key->timecreated   = time();
3349     // Something long and unique.
3350     $key->value         = md5($userid.'_'.time().random_string(40));
3351     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3352         // Must be unique.
3353         $key->value     = md5($userid.'_'.time().random_string(40));
3354     }
3355     $DB->insert_record('user_private_key', $key);
3356     return $key->value;
3359 /**
3360  * Delete the user's new private user access keys for a particular script.
3361  *
3362  * @param string $script unique target identifier
3363  * @param int $userid
3364  * @return void
3365  */
3366 function delete_user_key($script, $userid) {
3367     global $DB;
3368     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3371 /**
3372  * Gets a private user access key (and creates one if one doesn't exist).
3373  *
3374  * @param string $script unique target identifier
3375  * @param int $userid
3376  * @param int $instance optional instance id
3377  * @param string $iprestriction optional ip restricted access
3378  * @param timestamp $validuntil key valid only until given data
3379  * @return string access key value
3380  */
3381 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3382     global $DB;
3384     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3385                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3386                                                          'validuntil' => $validuntil))) {
3387         return $key->value;
3388     } else {
3389         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3390     }
3394 /**
3395  * Modify the user table by setting the currently logged in user's last login to now.
3396  *
3397  * @return bool Always returns true
3398  */
3399 function update_user_login_times() {
3400     global $USER, $DB, $CFG;
3402     require_once($CFG->dirroot.'/user/lib.php');
3404     if (isguestuser()) {
3405         // Do not update guest access times/ips for performance.
3406         return true;
3407     }
3409     $now = time();
3411     $user = new stdClass();
3412     $user->id = $USER->id;
3414     // Make sure all users that logged in have some firstaccess.
3415     if ($USER->firstaccess == 0) {
3416         $USER->firstaccess = $user->firstaccess = $now;
3417     }
3419     // Store the previous current as lastlogin.
3420     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3422     $USER->currentlogin = $user->currentlogin = $now;
3424     // Function user_accesstime_log() may not update immediately, better do it here.
3425     $USER->lastaccess = $user->lastaccess = $now;
3426     $USER->lastip = $user->lastip = getremoteaddr();
3428     user_update_user($user, false);
3429     return true;
3432 /**
3433  * Determines if a user has completed setting up their account.
3434  *
3435  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3436  * @return bool
3437  */
3438 function user_not_fully_set_up($user) {
3439     if (isguestuser($user)) {
3440         return false;
3441     }
3442     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3445 /**
3446  * Check whether the user has exceeded the bounce threshold
3447  *
3448  * @param stdClass $user A {@link $USER} object
3449  * @return bool true => User has exceeded bounce threshold
3450  */
3451 function over_bounce_threshold($user) {
3452     global $CFG, $DB;
3454     if (empty($CFG->handlebounces)) {
3455         return false;
3456     }
3458     if (empty($user->id)) {
3459         // No real (DB) user, nothing to do here.
3460         return false;
3461     }
3463     // Set sensible defaults.
3464     if (empty($CFG->minbounces)) {
3465         $CFG->minbounces = 10;
3466     }
3467     if (empty($CFG->bounceratio)) {
3468         $CFG->bounceratio = .20;
3469     }
3470     $bouncecount = 0;
3471     $sendcount = 0;
3472     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3473         $bouncecount = $bounce->value;
3474     }
3475     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3476         $sendcount = $send->value;
3477     }
3478     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3481 /**
3482  * Used to increment or reset email sent count
3483  *
3484  * @param stdClass $user object containing an id
3485  * @param bool $reset will reset the count to 0
3486  * @return void
3487  */
3488 function set_send_count($user, $reset=false) {
3489     global $DB;
3491     if (empty($user->id)) {
3492         // No real (DB) user, nothing to do here.
3493         return;
3494     }
3496     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3497         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3498         $DB->update_record('user_preferences', $pref);
3499     } else if (!empty($reset)) {
3500         // If it's not there and we're resetting, don't bother. Make a new one.
3501         $pref = new stdClass();
3502         $pref->name   = 'email_send_count';
3503         $pref->value  = 1;
3504         $pref->userid = $user->id;
3505         $DB->insert_record('user_preferences', $pref, false);
3506     }
3509 /**
3510  * Increment or reset user's email bounce count
3511  *
3512  * @param stdClass $user object containing an id
3513  * @param bool $reset will reset the count to 0
3514  */
3515 function set_bounce_count($user, $reset=false) {
3516     global $DB;
3518     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3519         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3520         $DB->update_record('user_preferences', $pref);
3521     } else if (!empty($reset)) {
3522         // If it's not there and we're resetting, don't bother. Make a new one.
3523         $pref = new stdClass();
3524         $pref->name   = 'email_bounce_count';
3525         $pref->value  = 1;
3526         $pref->userid = $user->id;
3527         $DB->insert_record('user_preferences', $pref, false);
3528     }
3531 /**
3532  * Determines if the logged in user is currently moving an activity
3533  *
3534  * @param int $courseid The id of the course being tested
3535  * @return bool
3536  */
3537 function ismoving($courseid) {
3538     global $USER;
3540     if (!empty($USER->activitycopy)) {
3541         return ($USER->activitycopycourse == $courseid);
3542     }
3543     return false;
3546 /**
3547  * Returns a persons full name
3548  *
3549  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3550  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3551  * specify one.
3552  *
3553  * @param stdClass $user A {@link $USER} object to get full name of.
3554  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3555  * @return string
3556  */
3557 function fullname($user, $override=false) {
3558     global $CFG, $SESSION;
3560     if (!isset($user->firstname) and !isset($user->lastname)) {
3561         return '';
3562     }
3564     // Get all of the name fields.
3565     $allnames = get_all_user_name_fields();
3566     if ($CFG->debugdeveloper) {
3567         foreach ($allnames as $allname) {
3568             if (!array_key_exists($allname, $user)) {
3569                 // If all the user name fields are not set in the user object, then notify the programmer that it needs to be fixed.
3570                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3571                 // Message has been sent, no point in sending the message multiple times.
3572                 break;
3573             }
3574         }
3575     }
3577     if (!$override) {
3578         if (!empty($CFG->forcefirstname)) {
3579             $user->firstname = $CFG->forcefirstname;
3580         }
3581         if (!empty($CFG->forcelastname)) {
3582             $user->lastname = $CFG->forcelastname;
3583         }
3584     }
3586     if (!empty($SESSION->fullnamedisplay)) {
3587         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3588     }
3590     $template = null;
3591     // If the fullnamedisplay setting is available, set the template to that.
3592     if (isset($CFG->fullnamedisplay)) {
3593         $template = $CFG->fullnamedisplay;
3594     }
3595     // If the template is empty, or set to language, or $override is set, return the language string.
3596     if (empty($template) || $template == 'language' || $override) {
3597         return get_string('fullnamedisplay', null, $user);
3598     }
3600     $requirednames = array();
3601     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3602     foreach ($allnames as $allname) {
3603         if (strpos($template, $allname) !== false) {
3604             $requirednames[] = $allname;
3605         }
3606     }
3608     $displayname = $template;
3609     // Switch in the actual data into the template.
3610     foreach ($requirednames as $altname) {
3611         if (isset($user->$altname)) {
3612             // Using empty() on the below if statement causes breakages.
3613             if ((string)$user->$altname == '') {
3614                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3615             } else {
3616                 $displayname = str_replace($altname, $user->$altname, $displayname);
3617             }
3618         } else {
3619             $displayname = str_replace($altname, 'EMPTY', $displayname);
3620         }
3621     }
3622     // Tidy up any misc. characters (Not perfect, but gets most characters).
3623     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3624     // katakana and parenthesis.
3625     $patterns = array();
3626     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3627     // filled in by a user.
3628     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3629     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3630     // This regular expression is to remove any double spaces in the display name.
3631     $patterns[] = '/\s{2,}/u';
3632     foreach ($patterns as $pattern) {
3633         $displayname = preg_replace($pattern, ' ', $displayname);
3634     }
3636     // Trimming $displayname will help the next check to ensure that we don't have a display name with spaces.
3637     $displayname = trim($displayname);
3638     if (empty($displayname)) {
3639         // Going with just the first name if no alternate fields are filled out. May be changed later depending on what
3640         // people in general feel is a good setting to fall back on.
3641         $displayname = $user->firstname;
3642     }
3643     return $displayname;
3646 /**
3647  * A centralised location for the all name fields. Returns an array / sql string snippet.
3648  *
3649  * @param bool $returnsql True for an sql select field snippet.
3650  * @param string $tableprefix table query prefix to use in front of each field.
3651  * @param string $prefix prefix added to the name fields e.g. authorfirstname.
3652  * @param string $fieldprefix sql field prefix e.g. id AS userid.