MDL-37324 fix phpmailer method case names and standardise phpmailer init
[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 /** Unspecified module archetype */
437 define('MOD_ARCHETYPE_OTHER', 0);
438 /** Resource-like type module */
439 define('MOD_ARCHETYPE_RESOURCE', 1);
440 /** Assignment module archetype */
441 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
442 /** System (not user-addable) module archetype */
443 define('MOD_ARCHETYPE_SYSTEM', 3);
445 /**
446  * Security token used for allowing access
447  * from external application such as web services.
448  * Scripts do not use any session, performance is relatively
449  * low because we need to load access info in each request.
450  * Scripts are executed in parallel.
451  */
452 define('EXTERNAL_TOKEN_PERMANENT', 0);
454 /**
455  * Security token used for allowing access
456  * of embedded applications, the code is executed in the
457  * active user session. Token is invalidated after user logs out.
458  * Scripts are executed serially - normal session locking is used.
459  */
460 define('EXTERNAL_TOKEN_EMBEDDED', 1);
462 /**
463  * The home page should be the site home
464  */
465 define('HOMEPAGE_SITE', 0);
466 /**
467  * The home page should be the users my page
468  */
469 define('HOMEPAGE_MY', 1);
470 /**
471  * The home page can be chosen by the user
472  */
473 define('HOMEPAGE_USER', 2);
475 /**
476  * Hub directory url (should be moodle.org)
477  */
478 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
481 /**
482  * Moodle.org url (should be moodle.org)
483  */
484 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
486 /**
487  * Moodle mobile app service name
488  */
489 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
491 /**
492  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
493  */
494 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
496 /**
497  * Course display settings: display all sections on one page.
498  */
499 define('COURSE_DISPLAY_SINGLEPAGE', 0);
500 /**
501  * Course display settings: split pages into a page per section.
502  */
503 define('COURSE_DISPLAY_MULTIPAGE', 1);
505 /**
506  * Authentication constant: String used in password field when password is not stored.
507  */
508 define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
510 // PARAMETER HANDLING.
512 /**
513  * Returns a particular value for the named variable, taken from
514  * POST or GET.  If the parameter doesn't exist then an error is
515  * thrown because we require this variable.
516  *
517  * This function should be used to initialise all required values
518  * in a script that are based on parameters.  Usually it will be
519  * used like this:
520  *    $id = required_param('id', PARAM_INT);
521  *
522  * Please note the $type parameter is now required and the value can not be array.
523  *
524  * @param string $parname the name of the page parameter we want
525  * @param string $type expected type of parameter
526  * @return mixed
527  * @throws coding_exception
528  */
529 function required_param($parname, $type) {
530     if (func_num_args() != 2 or empty($parname) or empty($type)) {
531         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
532     }
533     // POST has precedence.
534     if (isset($_POST[$parname])) {
535         $param = $_POST[$parname];
536     } else if (isset($_GET[$parname])) {
537         $param = $_GET[$parname];
538     } else {
539         print_error('missingparam', '', '', $parname);
540     }
542     if (is_array($param)) {
543         debugging('Invalid array parameter detected in required_param(): '.$parname);
544         // TODO: switch to fatal error in Moodle 2.3.
545         return required_param_array($parname, $type);
546     }
548     return clean_param($param, $type);
551 /**
552  * Returns a particular array value for the named variable, taken from
553  * POST or GET.  If the parameter doesn't exist then an error is
554  * thrown because we require this variable.
555  *
556  * This function should be used to initialise all required values
557  * in a script that are based on parameters.  Usually it will be
558  * used like this:
559  *    $ids = required_param_array('ids', PARAM_INT);
560  *
561  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
562  *
563  * @param string $parname the name of the page parameter we want
564  * @param string $type expected type of parameter
565  * @return array
566  * @throws coding_exception
567  */
568 function required_param_array($parname, $type) {
569     if (func_num_args() != 2 or empty($parname) or empty($type)) {
570         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
571     }
572     // POST has precedence.
573     if (isset($_POST[$parname])) {
574         $param = $_POST[$parname];
575     } else if (isset($_GET[$parname])) {
576         $param = $_GET[$parname];
577     } else {
578         print_error('missingparam', '', '', $parname);
579     }
580     if (!is_array($param)) {
581         print_error('missingparam', '', '', $parname);
582     }
584     $result = array();
585     foreach ($param as $key => $value) {
586         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
587             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
588             continue;
589         }
590         $result[$key] = clean_param($value, $type);
591     }
593     return $result;
596 /**
597  * Returns a particular value for the named variable, taken from
598  * POST or GET, otherwise returning a given default.
599  *
600  * This function should be used to initialise all optional values
601  * in a script that are based on parameters.  Usually it will be
602  * used like this:
603  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
604  *
605  * Please note the $type parameter is now required and the value can not be array.
606  *
607  * @param string $parname the name of the page parameter we want
608  * @param mixed  $default the default value to return if nothing is found
609  * @param string $type expected type of parameter
610  * @return mixed
611  * @throws coding_exception
612  */
613 function optional_param($parname, $default, $type) {
614     if (func_num_args() != 3 or empty($parname) or empty($type)) {
615         throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
616     }
617     if (!isset($default)) {
618         $default = null;
619     }
621     // POST has precedence.
622     if (isset($_POST[$parname])) {
623         $param = $_POST[$parname];
624     } else if (isset($_GET[$parname])) {
625         $param = $_GET[$parname];
626     } else {
627         return $default;
628     }
630     if (is_array($param)) {
631         debugging('Invalid array parameter detected in required_param(): '.$parname);
632         // TODO: switch to $default in Moodle 2.3.
633         return optional_param_array($parname, $default, $type);
634     }
636     return clean_param($param, $type);
639 /**
640  * Returns a particular array value for the named variable, taken from
641  * POST or GET, otherwise returning a given default.
642  *
643  * This function should be used to initialise all optional values
644  * in a script that are based on parameters.  Usually it will be
645  * used like this:
646  *    $ids = optional_param('id', array(), PARAM_INT);
647  *
648  * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
649  *
650  * @param string $parname the name of the page parameter we want
651  * @param mixed $default the default value to return if nothing is found
652  * @param string $type expected type of parameter
653  * @return array
654  * @throws coding_exception
655  */
656 function optional_param_array($parname, $default, $type) {
657     if (func_num_args() != 3 or empty($parname) or empty($type)) {
658         throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
659     }
661     // POST has precedence.
662     if (isset($_POST[$parname])) {
663         $param = $_POST[$parname];
664     } else if (isset($_GET[$parname])) {
665         $param = $_GET[$parname];
666     } else {
667         return $default;
668     }
669     if (!is_array($param)) {
670         debugging('optional_param_array() expects array parameters only: '.$parname);
671         return $default;
672     }
674     $result = array();
675     foreach ($param as $key => $value) {
676         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
677             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
678             continue;
679         }
680         $result[$key] = clean_param($value, $type);
681     }
683     return $result;
686 /**
687  * Strict validation of parameter values, the values are only converted
688  * to requested PHP type. Internally it is using clean_param, the values
689  * before and after cleaning must be equal - otherwise
690  * an invalid_parameter_exception is thrown.
691  * Objects and classes are not accepted.
692  *
693  * @param mixed $param
694  * @param string $type PARAM_ constant
695  * @param bool $allownull are nulls valid value?
696  * @param string $debuginfo optional debug information
697  * @return mixed the $param value converted to PHP type
698  * @throws invalid_parameter_exception if $param is not of given type
699  */
700 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
701     if (is_null($param)) {
702         if ($allownull == NULL_ALLOWED) {
703             return null;
704         } else {
705             throw new invalid_parameter_exception($debuginfo);
706         }
707     }
708     if (is_array($param) or is_object($param)) {
709         throw new invalid_parameter_exception($debuginfo);
710     }
712     $cleaned = clean_param($param, $type);
714     if ($type == PARAM_FLOAT) {
715         // Do not detect precision loss here.
716         if (is_float($param) or is_int($param)) {
717             // These always fit.
718         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
719             throw new invalid_parameter_exception($debuginfo);
720         }
721     } else if ((string)$param !== (string)$cleaned) {
722         // Conversion to string is usually lossless.
723         throw new invalid_parameter_exception($debuginfo);
724     }
726     return $cleaned;
729 /**
730  * Makes sure array contains only the allowed types, this function does not validate array key names!
731  *
732  * <code>
733  * $options = clean_param($options, PARAM_INT);
734  * </code>
735  *
736  * @param array $param the variable array we are cleaning
737  * @param string $type expected format of param after cleaning.
738  * @param bool $recursive clean recursive arrays
739  * @return array
740  * @throws coding_exception
741  */
742 function clean_param_array(array $param = null, $type, $recursive = false) {
743     // Convert null to empty array.
744     $param = (array)$param;
745     foreach ($param as $key => $value) {
746         if (is_array($value)) {
747             if ($recursive) {
748                 $param[$key] = clean_param_array($value, $type, true);
749             } else {
750                 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
751             }
752         } else {
753             $param[$key] = clean_param($value, $type);
754         }
755     }
756     return $param;
759 /**
760  * Used by {@link optional_param()} and {@link required_param()} to
761  * clean the variables and/or cast to specific types, based on
762  * an options field.
763  * <code>
764  * $course->format = clean_param($course->format, PARAM_ALPHA);
765  * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
766  * </code>
767  *
768  * @param mixed $param the variable we are cleaning
769  * @param string $type expected format of param after cleaning.
770  * @return mixed
771  * @throws coding_exception
772  */
773 function clean_param($param, $type) {
774     global $CFG;
776     if (is_array($param)) {
777         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
778     } else if (is_object($param)) {
779         if (method_exists($param, '__toString')) {
780             $param = $param->__toString();
781         } else {
782             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
783         }
784     }
786     switch ($type) {
787         case PARAM_RAW:
788             // No cleaning at all.
789             $param = fix_utf8($param);
790             return $param;
792         case PARAM_RAW_TRIMMED:
793             // No cleaning, but strip leading and trailing whitespace.
794             $param = fix_utf8($param);
795             return trim($param);
797         case PARAM_CLEAN:
798             // General HTML cleaning, try to use more specific type if possible this is deprecated!
799             // Please use more specific type instead.
800             if (is_numeric($param)) {
801                 return $param;
802             }
803             $param = fix_utf8($param);
804             // Sweep for scripts, etc.
805             return clean_text($param);
807         case PARAM_CLEANHTML:
808             // Clean html fragment.
809             $param = fix_utf8($param);
810             // Sweep for scripts, etc.
811             $param = clean_text($param, FORMAT_HTML);
812             return trim($param);
814         case PARAM_INT:
815             // Convert to integer.
816             return (int)$param;
818         case PARAM_FLOAT:
819             // Convert to float.
820             return (float)$param;
822         case PARAM_ALPHA:
823             // Remove everything not `a-z`.
824             return preg_replace('/[^a-zA-Z]/i', '', $param);
826         case PARAM_ALPHAEXT:
827             // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
828             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
830         case PARAM_ALPHANUM:
831             // Remove everything not `a-zA-Z0-9`.
832             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
834         case PARAM_ALPHANUMEXT:
835             // Remove everything not `a-zA-Z0-9_-`.
836             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
838         case PARAM_SEQUENCE:
839             // Remove everything not `0-9,`.
840             return preg_replace('/[^0-9,]/i', '', $param);
842         case PARAM_BOOL:
843             // Convert to 1 or 0.
844             $tempstr = strtolower($param);
845             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
846                 $param = 1;
847             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
848                 $param = 0;
849             } else {
850                 $param = empty($param) ? 0 : 1;
851             }
852             return $param;
854         case PARAM_NOTAGS:
855             // Strip all tags.
856             $param = fix_utf8($param);
857             return strip_tags($param);
859         case PARAM_TEXT:
860             // Leave only tags needed for multilang.
861             $param = fix_utf8($param);
862             // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
863             // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
864             do {
865                 if (strpos($param, '</lang>') !== false) {
866                     // Old and future mutilang syntax.
867                     $param = strip_tags($param, '<lang>');
868                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
869                         break;
870                     }
871                     $open = false;
872                     foreach ($matches[0] as $match) {
873                         if ($match === '</lang>') {
874                             if ($open) {
875                                 $open = false;
876                                 continue;
877                             } else {
878                                 break 2;
879                             }
880                         }
881                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
882                             break 2;
883                         } else {
884                             $open = true;
885                         }
886                     }
887                     if ($open) {
888                         break;
889                     }
890                     return $param;
892                 } else if (strpos($param, '</span>') !== false) {
893                     // Current problematic multilang syntax.
894                     $param = strip_tags($param, '<span>');
895                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
896                         break;
897                     }
898                     $open = false;
899                     foreach ($matches[0] as $match) {
900                         if ($match === '</span>') {
901                             if ($open) {
902                                 $open = false;
903                                 continue;
904                             } else {
905                                 break 2;
906                             }
907                         }
908                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
909                             break 2;
910                         } else {
911                             $open = true;
912                         }
913                     }
914                     if ($open) {
915                         break;
916                     }
917                     return $param;
918                 }
919             } while (false);
920             // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
921             return strip_tags($param);
923         case PARAM_COMPONENT:
924             // We do not want any guessing here, either the name is correct or not
925             // please note only normalised component names are accepted.
926             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
927                 return '';
928             }
929             if (strpos($param, '__') !== false) {
930                 return '';
931             }
932             if (strpos($param, 'mod_') === 0) {
933                 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
934                 if (substr_count($param, '_') != 1) {
935                     return '';
936                 }
937             }
938             return $param;
940         case PARAM_PLUGIN:
941         case PARAM_AREA:
942             // We do not want any guessing here, either the name is correct or not.
943             if (!is_valid_plugin_name($param)) {
944                 return '';
945             }
946             return $param;
948         case PARAM_SAFEDIR:
949             // Remove everything not a-zA-Z0-9_- .
950             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
952         case PARAM_SAFEPATH:
953             // Remove everything not a-zA-Z0-9/_- .
954             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
956         case PARAM_FILE:
957             // Strip all suspicious characters from filename.
958             $param = fix_utf8($param);
959             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
960             if ($param === '.' || $param === '..') {
961                 $param = '';
962             }
963             return $param;
965         case PARAM_PATH:
966             // Strip all suspicious characters from file path.
967             $param = fix_utf8($param);
968             $param = str_replace('\\', '/', $param);
970             // Explode the path and clean each element using the PARAM_FILE rules.
971             $breadcrumb = explode('/', $param);
972             foreach ($breadcrumb as $key => $crumb) {
973                 if ($crumb === '.' && $key === 0) {
974                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
975                 } else {
976                     $crumb = clean_param($crumb, PARAM_FILE);
977                 }
978                 $breadcrumb[$key] = $crumb;
979             }
980             $param = implode('/', $breadcrumb);
982             // Remove multiple current path (./././) and multiple slashes (///).
983             $param = preg_replace('~//+~', '/', $param);
984             $param = preg_replace('~/(\./)+~', '/', $param);
985             return $param;
987         case PARAM_HOST:
988             // Allow FQDN or IPv4 dotted quad.
989             $param = preg_replace('/[^\.\d\w-]/', '', $param );
990             // Match ipv4 dotted quad.
991             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
992                 // Confirm values are ok.
993                 if ( $match[0] > 255
994                      || $match[1] > 255
995                      || $match[3] > 255
996                      || $match[4] > 255 ) {
997                     // Hmmm, what kind of dotted quad is this?
998                     $param = '';
999                 }
1000             } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1001                        && !preg_match('/^[\.-]/',  $param) // No leading dots/hyphens.
1002                        && !preg_match('/[\.-]$/',  $param) // No trailing dots/hyphens.
1003                        ) {
1004                 // All is ok - $param is respected.
1005             } else {
1006                 // All is not ok...
1007                 $param='';
1008             }
1009             return $param;
1011         case PARAM_URL:          // Allow safe ftp, http, mailto urls.
1012             $param = fix_utf8($param);
1013             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
1014             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
1015                 // All is ok, param is respected.
1016             } else {
1017                 // Not really ok.
1018                 $param ='';
1019             }
1020             return $param;
1022         case PARAM_LOCALURL:
1023             // Allow http absolute, root relative and relative URLs within wwwroot.
1024             $param = clean_param($param, PARAM_URL);
1025             if (!empty($param)) {
1026                 if (preg_match(':^/:', $param)) {
1027                     // Root-relative, ok!
1028                 } else if (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i', $param)) {
1029                     // Absolute, and matches our wwwroot.
1030                 } else {
1031                     // Relative - let's make sure there are no tricks.
1032                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1033                         // Looks ok.
1034                     } else {
1035                         $param = '';
1036                     }
1037                 }
1038             }
1039             return $param;
1041         case PARAM_PEM:
1042             $param = trim($param);
1043             // PEM formatted strings may contain letters/numbers and the symbols:
1044             //   forward slash: /
1045             //   plus sign:     +
1046             //   equal sign:    =
1047             //   , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
1048             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1049                 list($wholething, $body) = $matches;
1050                 unset($wholething, $matches);
1051                 $b64 = clean_param($body, PARAM_BASE64);
1052                 if (!empty($b64)) {
1053                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1054                 } else {
1055                     return '';
1056                 }
1057             }
1058             return '';
1060         case PARAM_BASE64:
1061             if (!empty($param)) {
1062                 // PEM formatted strings may contain letters/numbers and the symbols
1063                 //   forward slash: /
1064                 //   plus sign:     +
1065                 //   equal sign:    =.
1066                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1067                     return '';
1068                 }
1069                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1070                 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1071                 // than (or equal to) 64 characters long.
1072                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1073                     if ($i + 1 == $j) {
1074                         if (64 < strlen($lines[$i])) {
1075                             return '';
1076                         }
1077                         continue;
1078                     }
1080                     if (64 != strlen($lines[$i])) {
1081                         return '';
1082                     }
1083                 }
1084                 return implode("\n", $lines);
1085             } else {
1086                 return '';
1087             }
1089         case PARAM_TAG:
1090             $param = fix_utf8($param);
1091             // Please note it is not safe to use the tag name directly anywhere,
1092             // it must be processed with s(), urlencode() before embedding anywhere.
1093             // Remove some nasties.
1094             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1095             // Convert many whitespace chars into one.
1096             $param = preg_replace('/\s+/', ' ', $param);
1097             $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
1098             return $param;
1100         case PARAM_TAGLIST:
1101             $param = fix_utf8($param);
1102             $tags = explode(',', $param);
1103             $result = array();
1104             foreach ($tags as $tag) {
1105                 $res = clean_param($tag, PARAM_TAG);
1106                 if ($res !== '') {
1107                     $result[] = $res;
1108                 }
1109             }
1110             if ($result) {
1111                 return implode(',', $result);
1112             } else {
1113                 return '';
1114             }
1116         case PARAM_CAPABILITY:
1117             if (get_capability_info($param)) {
1118                 return $param;
1119             } else {
1120                 return '';
1121             }
1123         case PARAM_PERMISSION:
1124             $param = (int)$param;
1125             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1126                 return $param;
1127             } else {
1128                 return CAP_INHERIT;
1129             }
1131         case PARAM_AUTH:
1132             $param = clean_param($param, PARAM_PLUGIN);
1133             if (empty($param)) {
1134                 return '';
1135             } else if (exists_auth_plugin($param)) {
1136                 return $param;
1137             } else {
1138                 return '';
1139             }
1141         case PARAM_LANG:
1142             $param = clean_param($param, PARAM_SAFEDIR);
1143             if (get_string_manager()->translation_exists($param)) {
1144                 return $param;
1145             } else {
1146                 // Specified language is not installed or param malformed.
1147                 return '';
1148             }
1150         case PARAM_THEME:
1151             $param = clean_param($param, PARAM_PLUGIN);
1152             if (empty($param)) {
1153                 return '';
1154             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1155                 return $param;
1156             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1157                 return $param;
1158             } else {
1159                 // Specified theme is not installed.
1160                 return '';
1161             }
1163         case PARAM_USERNAME:
1164             $param = fix_utf8($param);
1165             $param = str_replace(" " , "", $param);
1166             // Convert uppercase to lowercase MDL-16919.
1167             $param = core_text::strtolower($param);
1168             if (empty($CFG->extendedusernamechars)) {
1169                 // Regular expression, eliminate all chars EXCEPT:
1170                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1171                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1172             }
1173             return $param;
1175         case PARAM_EMAIL:
1176             $param = fix_utf8($param);
1177             if (validate_email($param)) {
1178                 return $param;
1179             } else {
1180                 return '';
1181             }
1183         case PARAM_STRINGID:
1184             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1185                 return $param;
1186             } else {
1187                 return '';
1188             }
1190         case PARAM_TIMEZONE:
1191             // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
1192             $param = fix_utf8($param);
1193             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1194             if (preg_match($timezonepattern, $param)) {
1195                 return $param;
1196             } else {
1197                 return '';
1198             }
1200         default:
1201             // Doh! throw error, switched parameters in optional_param or another serious problem.
1202             print_error("unknownparamtype", '', '', $type);
1203     }
1206 /**
1207  * Makes sure the data is using valid utf8, invalid characters are discarded.
1208  *
1209  * Note: this function is not intended for full objects with methods and private properties.
1210  *
1211  * @param mixed $value
1212  * @return mixed with proper utf-8 encoding
1213  */
1214 function fix_utf8($value) {
1215     if (is_null($value) or $value === '') {
1216         return $value;
1218     } else if (is_string($value)) {
1219         if ((string)(int)$value === $value) {
1220             // Shortcut.
1221             return $value;
1222         }
1223         // No null bytes expected in our data, so let's remove it.
1224         $value = str_replace("\0", '', $value);
1226         // Lower error reporting because glibc throws bogus notices.
1227         $olderror = error_reporting();
1228         if ($olderror & E_NOTICE) {
1229             error_reporting($olderror ^ E_NOTICE);
1230         }
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         if ($olderror & E_NOTICE) {
1255             error_reporting($olderror);
1256         }
1258         return $result;
1260     } else if (is_array($value)) {
1261         foreach ($value as $k => $v) {
1262             $value[$k] = fix_utf8($v);
1263         }
1264         return $value;
1266     } else if (is_object($value)) {
1267         // Do not modify original.
1268         $value = clone($value);
1269         foreach ($value as $k => $v) {
1270             $value->$k = fix_utf8($v);
1271         }
1272         return $value;
1274     } else {
1275         // This is some other type, no utf-8 here.
1276         return $value;
1277     }
1280 /**
1281  * Return true if given value is integer or string with integer value
1282  *
1283  * @param mixed $value String or Int
1284  * @return bool true if number, false if not
1285  */
1286 function is_number($value) {
1287     if (is_int($value)) {
1288         return true;
1289     } else if (is_string($value)) {
1290         return ((string)(int)$value) === $value;
1291     } else {
1292         return false;
1293     }
1296 /**
1297  * Returns host part from url.
1298  *
1299  * @param string $url full url
1300  * @return string host, null if not found
1301  */
1302 function get_host_from_url($url) {
1303     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1304     if ($matches) {
1305         return $matches[1];
1306     }
1307     return null;
1310 /**
1311  * Tests whether anything was returned by text editor
1312  *
1313  * This function is useful for testing whether something you got back from
1314  * the HTML editor actually contains anything. Sometimes the HTML editor
1315  * appear to be empty, but actually you get back a <br> tag or something.
1316  *
1317  * @param string $string a string containing HTML.
1318  * @return boolean does the string contain any actual content - that is text,
1319  * images, objects, etc.
1320  */
1321 function html_is_blank($string) {
1322     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1325 /**
1326  * Set a key in global configuration
1327  *
1328  * Set a key/value pair in both this session's {@link $CFG} global variable
1329  * and in the 'config' database table for future sessions.
1330  *
1331  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1332  * In that case it doesn't affect $CFG.
1333  *
1334  * A NULL value will delete the entry.
1335  *
1336  * @param string $name the key to set
1337  * @param string $value the value to set (without magic quotes)
1338  * @param string $plugin (optional) the plugin scope, default null
1339  * @return bool true or exception
1340  */
1341 function set_config($name, $value, $plugin=null) {
1342     global $CFG, $DB;
1344     if (empty($plugin)) {
1345         if (!array_key_exists($name, $CFG->config_php_settings)) {
1346             // So it's defined for this invocation at least.
1347             if (is_null($value)) {
1348                 unset($CFG->$name);
1349             } else {
1350                 // Settings from db are always strings.
1351                 $CFG->$name = (string)$value;
1352             }
1353         }
1355         if ($DB->get_field('config', 'name', array('name' => $name))) {
1356             if ($value === null) {
1357                 $DB->delete_records('config', array('name' => $name));
1358             } else {
1359                 $DB->set_field('config', 'value', $value, array('name' => $name));
1360             }
1361         } else {
1362             if ($value !== null) {
1363                 $config = new stdClass();
1364                 $config->name  = $name;
1365                 $config->value = $value;
1366                 $DB->insert_record('config', $config, false);
1367             }
1368         }
1369         if ($name === 'siteidentifier') {
1370             cache_helper::update_site_identifier($value);
1371         }
1372         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1373     } else {
1374         // Plugin scope.
1375         if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
1376             if ($value===null) {
1377                 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1378             } else {
1379                 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
1380             }
1381         } else {
1382             if ($value !== null) {
1383                 $config = new stdClass();
1384                 $config->plugin = $plugin;
1385                 $config->name   = $name;
1386                 $config->value  = $value;
1387                 $DB->insert_record('config_plugins', $config, false);
1388             }
1389         }
1390         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1391     }
1393     return true;
1396 /**
1397  * Get configuration values from the global config table
1398  * or the config_plugins table.
1399  *
1400  * If called with one parameter, it will load all the config
1401  * variables for one plugin, and return them as an object.
1402  *
1403  * If called with 2 parameters it will return a string single
1404  * value or false if the value is not found.
1405  *
1406  * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
1407  *     that we need only fetch it once per request.
1408  * @param string $plugin full component name
1409  * @param string $name default null
1410  * @return mixed hash-like object or single value, return false no config found
1411  * @throws dml_exception
1412  */
1413 function get_config($plugin, $name = null) {
1414     global $CFG, $DB;
1416     static $siteidentifier = null;
1418     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1419         $forced =& $CFG->config_php_settings;
1420         $iscore = true;
1421         $plugin = 'core';
1422     } else {
1423         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1424             $forced =& $CFG->forced_plugin_settings[$plugin];
1425         } else {
1426             $forced = array();
1427         }
1428         $iscore = false;
1429     }
1431     if ($siteidentifier === null) {
1432         try {
1433             // This may fail during installation.
1434             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1435             // install the database.
1436             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1437         } catch (dml_exception $ex) {
1438             // Set siteidentifier to false. We don't want to trip this continually.
1439             $siteidentifier = false;
1440             throw $ex;
1441         }
1442     }
1444     if (!empty($name)) {
1445         if (array_key_exists($name, $forced)) {
1446             return (string)$forced[$name];
1447         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1448             return $siteidentifier;
1449         }
1450     }
1452     $cache = cache::make('core', 'config');
1453     $result = $cache->get($plugin);
1454     if ($result === false) {
1455         // The user is after a recordset.
1456         if (!$iscore) {
1457             $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
1458         } else {
1459             // This part is not really used any more, but anyway...
1460             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1461         }
1462         $cache->set($plugin, $result);
1463     }
1465     if (!empty($name)) {
1466         if (array_key_exists($name, $result)) {
1467             return $result[$name];
1468         }
1469         return false;
1470     }
1472     if ($plugin === 'core') {
1473         $result['siteidentifier'] = $siteidentifier;
1474     }
1476     foreach ($forced as $key => $value) {
1477         if (is_null($value) or is_array($value) or is_object($value)) {
1478             // We do not want any extra mess here, just real settings that could be saved in db.
1479             unset($result[$key]);
1480         } else {
1481             // Convert to string as if it went through the DB.
1482             $result[$key] = (string)$value;
1483         }
1484     }
1486     return (object)$result;
1489 /**
1490  * Removes a key from global configuration.
1491  *
1492  * @param string $name the key to set
1493  * @param string $plugin (optional) the plugin scope
1494  * @return boolean whether the operation succeeded.
1495  */
1496 function unset_config($name, $plugin=null) {
1497     global $CFG, $DB;
1499     if (empty($plugin)) {
1500         unset($CFG->$name);
1501         $DB->delete_records('config', array('name' => $name));
1502         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1503     } else {
1504         $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1505         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1506     }
1508     return true;
1511 /**
1512  * Remove all the config variables for a given plugin.
1513  *
1514  * NOTE: this function is called from lib/db/upgrade.php
1515  *
1516  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1517  * @return boolean whether the operation succeeded.
1518  */
1519 function unset_all_config_for_plugin($plugin) {
1520     global $DB;
1521     // Delete from the obvious config_plugins first.
1522     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1523     // Next delete any suspect settings from config.
1524     $like = $DB->sql_like('name', '?', true, true, false, '|');
1525     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1526     $DB->delete_records_select('config', $like, $params);
1527     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1528     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1530     return true;
1533 /**
1534  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1535  *
1536  * All users are verified if they still have the necessary capability.
1537  *
1538  * @param string $value the value of the config setting.
1539  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1540  * @param bool $includeadmins include administrators.
1541  * @return array of user objects.
1542  */
1543 function get_users_from_config($value, $capability, $includeadmins = true) {
1544     if (empty($value) or $value === '$@NONE@$') {
1545         return array();
1546     }
1548     // We have to make sure that users still have the necessary capability,
1549     // it should be faster to fetch them all first and then test if they are present
1550     // instead of validating them one-by-one.
1551     $users = get_users_by_capability(context_system::instance(), $capability);
1552     if ($includeadmins) {
1553         $admins = get_admins();
1554         foreach ($admins as $admin) {
1555             $users[$admin->id] = $admin;
1556         }
1557     }
1559     if ($value === '$@ALL@$') {
1560         return $users;
1561     }
1563     $result = array(); // Result in correct order.
1564     $allowed = explode(',', $value);
1565     foreach ($allowed as $uid) {
1566         if (isset($users[$uid])) {
1567             $user = $users[$uid];
1568             $result[$user->id] = $user;
1569         }
1570     }
1572     return $result;
1576 /**
1577  * Invalidates browser caches and cached data in temp.
1578  *
1579  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1580  * {@link phpunit_util::reset_dataroot()}
1581  *
1582  * @return void
1583  */
1584 function purge_all_caches() {
1585     global $CFG;
1587     reset_text_filters_cache();
1588     js_reset_all_caches();
1589     theme_reset_all_caches();
1590     get_string_manager()->reset_caches();
1591     core_text::reset_caches();
1593     // Bump up cacherev field for all courses.
1594     try {
1595         increment_revision_number('course', 'cacherev', '');
1596     } catch (moodle_exception $e) {
1597         // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1598     }
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;
2180     if (abs($tz) > 13) {
2181         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2182             $format = core_text::convert($format, 'utf-8', $localewincharset);
2183             $datestring = strftime($format, $date);
2184             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2185         } else {
2186             $datestring = strftime($format, $date);
2187         }
2188     } else {
2189         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2190             $format = core_text::convert($format, 'utf-8', $localewincharset);
2191             $datestring = gmstrftime($format, $date);
2192             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2193         } else {
2194             $datestring = gmstrftime($format, $date);
2195         }
2196     }
2197     return $datestring;
2200 /**
2201  * Given a $time timestamp in GMT (seconds since epoch),
2202  * returns an array that represents the date in user time
2203  *
2204  * @package core
2205  * @category time
2206  * @uses HOURSECS
2207  * @param int $time Timestamp in GMT
2208  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2209  *        dst offset is applied {@link http://docs.moodle.org/dev/Time_API#Timezone}
2210  * @return array An array that represents the date in user time
2211  */
2212 function usergetdate($time, $timezone=99) {
2214     // Save input timezone, required for dst offset check.
2215     $passedtimezone = $timezone;
2217     $timezone = get_user_timezone_offset($timezone);
2219     if (abs($timezone) > 13) {
2220         // Server time.
2221         return getdate($time);
2222     }
2224     // Add daylight saving offset for string timezones only, as we can't get dst for
2225     // float values. if timezone is 99 (user default timezone), then try update dst.
2226     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2227         $time += dst_offset_on($time, $passedtimezone);
2228     }
2230     $time += intval((float)$timezone * HOURSECS);
2232     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2234     // Be careful to ensure the returned array matches that produced by getdate() above.
2235     list(
2236         $getdate['month'],
2237         $getdate['weekday'],
2238         $getdate['yday'],
2239         $getdate['year'],
2240         $getdate['mon'],
2241         $getdate['wday'],
2242         $getdate['mday'],
2243         $getdate['hours'],
2244         $getdate['minutes'],
2245         $getdate['seconds']
2246     ) = explode('_', $datestring);
2248     // Set correct datatype to match with getdate().
2249     $getdate['seconds'] = (int)$getdate['seconds'];
2250     $getdate['yday'] = (int)$getdate['yday'] - 1; // The function gmstrftime returns 0 through 365.
2251     $getdate['year'] = (int)$getdate['year'];
2252     $getdate['mon'] = (int)$getdate['mon'];
2253     $getdate['wday'] = (int)$getdate['wday'];
2254     $getdate['mday'] = (int)$getdate['mday'];
2255     $getdate['hours'] = (int)$getdate['hours'];
2256     $getdate['minutes'] = (int)$getdate['minutes'];
2257     return $getdate;
2260 /**
2261  * Given a GMT timestamp (seconds since epoch), offsets it by
2262  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2263  *
2264  * @package core
2265  * @category time
2266  * @uses HOURSECS
2267  * @param int $date Timestamp in GMT
2268  * @param float|int|string $timezone timezone to calculate GMT time offset before
2269  *        calculating user time, 99 is default user timezone
2270  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2271  * @return int
2272  */
2273 function usertime($date, $timezone=99) {
2275     $timezone = get_user_timezone_offset($timezone);
2277     if (abs($timezone) > 13) {
2278         return $date;
2279     }
2280     return $date - (int)($timezone * HOURSECS);
2283 /**
2284  * Given a time, return the GMT timestamp of the most recent midnight
2285  * for the current user.
2286  *
2287  * @package core
2288  * @category time
2289  * @param int $date Timestamp in GMT
2290  * @param float|int|string $timezone timezone to calculate GMT time offset before
2291  *        calculating user midnight time, 99 is default user timezone
2292  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2293  * @return int Returns a GMT timestamp
2294  */
2295 function usergetmidnight($date, $timezone=99) {
2297     $userdate = usergetdate($date, $timezone);
2299     // Time of midnight of this user's day, in GMT.
2300     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2304 /**
2305  * Returns a string that prints the user's timezone
2306  *
2307  * @package core
2308  * @category time
2309  * @param float|int|string $timezone timezone to calculate GMT time offset before
2310  *        calculating user timezone, 99 is default user timezone
2311  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2312  * @return string
2313  */
2314 function usertimezone($timezone=99) {
2316     $tz = get_user_timezone($timezone);
2318     if (!is_float($tz)) {
2319         return $tz;
2320     }
2322     if (abs($tz) > 13) {
2323         // Server time.
2324         return get_string('serverlocaltime');
2325     }
2327     if ($tz == intval($tz)) {
2328         // Don't show .0 for whole hours.
2329         $tz = intval($tz);
2330     }
2332     if ($tz == 0) {
2333         return 'UTC';
2334     } else if ($tz > 0) {
2335         return 'UTC+'.$tz;
2336     } else {
2337         return 'UTC'.$tz;
2338     }
2342 /**
2343  * Returns a float which represents the user's timezone difference from GMT in hours
2344  * Checks various settings and picks the most dominant of those which have a value
2345  *
2346  * @package core
2347  * @category time
2348  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2349  *        99 is default user timezone
2350  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2351  * @return float
2352  */
2353 function get_user_timezone_offset($tz = 99) {
2354     $tz = get_user_timezone($tz);
2356     if (is_float($tz)) {
2357         return $tz;
2358     } else {
2359         $tzrecord = get_timezone_record($tz);
2360         if (empty($tzrecord)) {
2361             return 99.0;
2362         }
2363         return (float)$tzrecord->gmtoff / HOURMINS;
2364     }
2367 /**
2368  * Returns an int which represents the systems's timezone difference from GMT in seconds
2369  *
2370  * @package core
2371  * @category time
2372  * @param float|int|string $tz timezone for which offset is required.
2373  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2374  * @return int|bool if found, false is timezone 99 or error
2375  */
2376 function get_timezone_offset($tz) {
2377     if ($tz == 99) {
2378         return false;
2379     }
2381     if (is_numeric($tz)) {
2382         return intval($tz * 60*60);
2383     }
2385     if (!$tzrecord = get_timezone_record($tz)) {
2386         return false;
2387     }
2388     return intval($tzrecord->gmtoff * 60);
2391 /**
2392  * Returns a float or a string which denotes the user's timezone
2393  * 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)
2394  * means that for this timezone there are also DST rules to be taken into account
2395  * Checks various settings and picks the most dominant of those which have a value
2396  *
2397  * @package core
2398  * @category time
2399  * @param float|int|string $tz timezone to calculate GMT time offset before
2400  *        calculating user timezone, 99 is default user timezone
2401  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2402  * @return float|string
2403  */
2404 function get_user_timezone($tz = 99) {
2405     global $USER, $CFG;
2407     $timezones = array(
2408         $tz,
2409         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2410         isset($USER->timezone) ? $USER->timezone : 99,
2411         isset($CFG->timezone) ? $CFG->timezone : 99,
2412         );
2414     $tz = 99;
2416     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2417     while (((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2418         $tz = $next['value'];
2419     }
2420     return is_numeric($tz) ? (float) $tz : $tz;
2423 /**
2424  * Returns cached timezone record for given $timezonename
2425  *
2426  * @package core
2427  * @param string $timezonename name of the timezone
2428  * @return stdClass|bool timezonerecord or false
2429  */
2430 function get_timezone_record($timezonename) {
2431     global $DB;
2432     static $cache = null;
2434     if ($cache === null) {
2435         $cache = array();
2436     }
2438     if (isset($cache[$timezonename])) {
2439         return $cache[$timezonename];
2440     }
2442     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2443                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2446 /**
2447  * Build and store the users Daylight Saving Time (DST) table
2448  *
2449  * @package core
2450  * @param int $fromyear Start year for the table, defaults to 1971
2451  * @param int $toyear End year for the table, defaults to 2035
2452  * @param int|float|string $strtimezone timezone to check if dst should be applied.
2453  * @return bool
2454  */
2455 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2456     global $SESSION, $DB;
2458     $usertz = get_user_timezone($strtimezone);
2460     if (is_float($usertz)) {
2461         // Trivial timezone, no DST.
2462         return false;
2463     }
2465     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2466         // We have pre-calculated values, but the user's effective TZ has changed in the meantime, so reset.
2467         unset($SESSION->dst_offsets);
2468         unset($SESSION->dst_range);
2469     }
2471     if (!empty($SESSION->dst_offsets) && empty($fromyear) && empty($toyear)) {
2472         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table.
2473         // This will be the return path most of the time, pretty light computationally.
2474         return true;
2475     }
2477     // Reaching here means we either need to extend our table or create it from scratch.
2479     // Remember which TZ we calculated these changes for.
2480     $SESSION->dst_offsettz = $usertz;
2482     if (empty($SESSION->dst_offsets)) {
2483         // If we 're creating from scratch, put the two guard elements in there.
2484         $SESSION->dst_offsets = array(1 => null, 0 => null);
2485     }
2486     if (empty($SESSION->dst_range)) {
2487         // If creating from scratch.
2488         $from = max((empty($fromyear) ? intval(date('Y')) - 3 : $fromyear), 1971);
2489         $to   = min((empty($toyear)   ? intval(date('Y')) + 3 : $toyear),   2035);
2491         // Fill in the array with the extra years we need to process.
2492         $yearstoprocess = array();
2493         for ($i = $from; $i <= $to; ++$i) {
2494             $yearstoprocess[] = $i;
2495         }
2497         // Take note of which years we have processed for future calls.
2498         $SESSION->dst_range = array($from, $to);
2499     } else {
2500         // If needing to extend the table, do the same.
2501         $yearstoprocess = array();
2503         $from = max((empty($fromyear) ? $SESSION->dst_range[0] : $fromyear), 1971);
2504         $to   = min((empty($toyear)   ? $SESSION->dst_range[1] : $toyear),   2035);
2506         if ($from < $SESSION->dst_range[0]) {
2507             // Take note of which years we need to process and then note that we have processed them for future calls.
2508             for ($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2509                 $yearstoprocess[] = $i;
2510             }
2511             $SESSION->dst_range[0] = $from;
2512         }
2513         if ($to > $SESSION->dst_range[1]) {
2514             // Take note of which years we need to process and then note that we have processed them for future calls.
2515             for ($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2516                 $yearstoprocess[] = $i;
2517             }
2518             $SESSION->dst_range[1] = $to;
2519         }
2520     }
2522     if (empty($yearstoprocess)) {
2523         // This means that there was a call requesting a SMALLER range than we have already calculated.
2524         return true;
2525     }
2527     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2528     // Also, the array is sorted in descending timestamp order!
2530     // Get DB data.
2532     static $presetscache = array();
2533     if (!isset($presetscache[$usertz])) {
2534         $presetscache[$usertz] = $DB->get_records('timezone', array('name' => $usertz),
2535             'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, '.
2536             'std_startday, std_weekday, std_skipweeks, std_time');
2537     }
2538     if (empty($presetscache[$usertz])) {
2539         return false;
2540     }
2542     // Remove ending guard (first element of the array).
2543     reset($SESSION->dst_offsets);
2544     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2546     // Add all required change timestamps.
2547     foreach ($yearstoprocess as $y) {
2548         // Find the record which is in effect for the year $y.
2549         foreach ($presetscache[$usertz] as $year => $preset) {
2550             if ($year <= $y) {
2551                 break;
2552             }
2553         }
2555         $changes = dst_changes_for_year($y, $preset);
2557         if ($changes === null) {
2558             continue;
2559         }
2560         if ($changes['dst'] != 0) {
2561             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2562         }
2563         if ($changes['std'] != 0) {
2564             $SESSION->dst_offsets[$changes['std']] = 0;
2565         }
2566     }
2568     // Put in a guard element at the top.
2569     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2570     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = null; // DAYSECS is arbitrary, any "small" number will do.
2572     // Sort again.
2573     krsort($SESSION->dst_offsets);
2575     return true;
2578 /**
2579  * Calculates the required DST change and returns a Timestamp Array
2580  *
2581  * @package core
2582  * @category time
2583  * @uses HOURSECS
2584  * @uses MINSECS
2585  * @param int|string $year Int or String Year to focus on
2586  * @param object $timezone Instatiated Timezone object
2587  * @return array|null Array dst => xx, 0 => xx, std => yy, 1 => yy or null
2588  */
2589 function dst_changes_for_year($year, $timezone) {
2591     if ($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 &&
2592         $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2593         return null;
2594     }
2596     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2597     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2599     list($dsthour, $dstmin) = explode(':', $timezone->dst_time);
2600     list($stdhour, $stdmin) = explode(':', $timezone->std_time);
2602     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2603     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2605     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2606     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2607     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2609     $timedst += $dsthour * HOURSECS + $dstmin * MINSECS;
2610     $timestd += $stdhour * HOURSECS + $stdmin * MINSECS;
2612     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2615 /**
2616  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2617  * - Note: Daylight saving only works for string timezones and not for float.
2618  *
2619  * @package core
2620  * @category time
2621  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2622  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2623  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2624  * @return int
2625  */
2626 function dst_offset_on($time, $strtimezone = null) {
2627     global $SESSION;
2629     if (!calculate_user_dst_table(null, null, $strtimezone) || empty($SESSION->dst_offsets)) {
2630         return 0;
2631     }
2633     reset($SESSION->dst_offsets);
2634     while (list($from, $offset) = each($SESSION->dst_offsets)) {
2635         if ($from <= $time) {
2636             break;
2637         }
2638     }
2640     // This is the normal return path.
2641     if ($offset !== null) {
2642         return $offset;
2643     }
2645     // Reaching this point means we haven't calculated far enough, do it now:
2646     // Calculate extra DST changes if needed and recurse. The recursion always
2647     // moves toward the stopping condition, so will always end.
2649     if ($from == 0) {
2650         // We need a year smaller than $SESSION->dst_range[0].
2651         if ($SESSION->dst_range[0] == 1971) {
2652             return 0;
2653         }
2654         calculate_user_dst_table($SESSION->dst_range[0] - 5, null, $strtimezone);
2655         return dst_offset_on($time, $strtimezone);
2656     } else {
2657         // We need a year larger than $SESSION->dst_range[1].
2658         if ($SESSION->dst_range[1] == 2035) {
2659             return 0;
2660         }
2661         calculate_user_dst_table(null, $SESSION->dst_range[1] + 5, $strtimezone);
2662         return dst_offset_on($time, $strtimezone);
2663     }
2666 /**
2667  * Calculates when the day appears in specific month
2668  *
2669  * @package core
2670  * @category time
2671  * @param int $startday starting day of the month
2672  * @param int $weekday The day when week starts (normally taken from user preferences)
2673  * @param int $month The month whose day is sought
2674  * @param int $year The year of the month whose day is sought
2675  * @return int
2676  */
2677 function find_day_in_month($startday, $weekday, $month, $year) {
2679     $daysinmonth = days_in_month($month, $year);
2681     if ($weekday == -1) {
2682         // Don't care about weekday, so return:
2683         //    abs($startday) if $startday != -1
2684         //    $daysinmonth otherwise.
2685         return ($startday == -1) ? $daysinmonth : abs($startday);
2686     }
2688     // From now on we 're looking for a specific weekday.
2690     // Give "end of month" its actual value, since we know it.
2691     if ($startday == -1) {
2692         $startday = -1 * $daysinmonth;
2693     }
2695     // Starting from day $startday, the sign is the direction.
2697     if ($startday < 1) {
2699         $startday = abs($startday);
2700         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2702         // This is the last such weekday of the month.
2703         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2704         if ($lastinmonth > $daysinmonth) {
2705             $lastinmonth -= 7;
2706         }
2708         // Find the first such weekday <= $startday.
2709         while ($lastinmonth > $startday) {
2710             $lastinmonth -= 7;
2711         }
2713         return $lastinmonth;
2715     } else {
2717         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2719         $diff = $weekday - $indexweekday;
2720         if ($diff < 0) {
2721             $diff += 7;
2722         }
2724         // This is the first such weekday of the month equal to or after $startday.
2725         $firstfromindex = $startday + $diff;
2727         return $firstfromindex;
2729     }
2732 /**
2733  * Calculate the number of days in a given month
2734  *
2735  * @package core
2736  * @category time
2737  * @param int $month The month whose day count is sought
2738  * @param int $year The year of the month whose day count is sought
2739  * @return int
2740  */
2741 function days_in_month($month, $year) {
2742     return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2745 /**
2746  * Calculate the position in the week of a specific calendar day
2747  *
2748  * @package core
2749  * @category time
2750  * @param int $day The day of the date whose position in the week is sought
2751  * @param int $month The month of the date whose position in the week is sought
2752  * @param int $year The year of the date whose position in the week is sought
2753  * @return int
2754  */
2755 function dayofweek($day, $month, $year) {
2756     // I wonder if this is any different from strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));.
2757     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2760 // USER AUTHENTICATION AND LOGIN.
2762 /**
2763  * Returns full login url.
2764  *
2765  * @return string login url
2766  */
2767 function get_login_url() {
2768     global $CFG;
2770     $url = "$CFG->wwwroot/login/index.php";
2772     if (!empty($CFG->loginhttps)) {
2773         $url = str_replace('http:', 'https:', $url);
2774     }
2776     return $url;
2779 /**
2780  * This function checks that the current user is logged in and has the
2781  * required privileges
2782  *
2783  * This function checks that the current user is logged in, and optionally
2784  * whether they are allowed to be in a particular course and view a particular
2785  * course module.
2786  * If they are not logged in, then it redirects them to the site login unless
2787  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2788  * case they are automatically logged in as guests.
2789  * If $courseid is given and the user is not enrolled in that course then the
2790  * user is redirected to the course enrolment page.
2791  * If $cm is given and the course module is hidden and the user is not a teacher
2792  * in the course then the user is redirected to the course home page.
2793  *
2794  * When $cm parameter specified, this function sets page layout to 'module'.
2795  * You need to change it manually later if some other layout needed.
2796  *
2797  * @package    core_access
2798  * @category   access
2799  *
2800  * @param mixed $courseorid id of the course or course object
2801  * @param bool $autologinguest default true
2802  * @param object $cm course module object
2803  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2804  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2805  *             in order to keep redirects working properly. MDL-14495
2806  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2807  * @return mixed Void, exit, and die depending on path
2808  * @throws coding_exception
2809  * @throws require_login_exception
2810  */
2811 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2812     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2814     // Must not redirect when byteserving already started.
2815     if (!empty($_SERVER['HTTP_RANGE'])) {
2816         $preventredirect = true;
2817     }
2819     // Setup global $COURSE, themes, language and locale.
2820     if (!empty($courseorid)) {
2821         if (is_object($courseorid)) {
2822             $course = $courseorid;
2823         } else if ($courseorid == SITEID) {
2824             $course = clone($SITE);
2825         } else {
2826             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2827         }
2828         if ($cm) {
2829             if ($cm->course != $course->id) {
2830                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2831             }
2832             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2833             if (!($cm instanceof cm_info)) {
2834                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2835                 // db queries so this is not really a performance concern, however it is obviously
2836                 // better if you use get_fast_modinfo to get the cm before calling this.
2837                 $modinfo = get_fast_modinfo($course);
2838                 $cm = $modinfo->get_cm($cm->id);
2839             }
2840             $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
2841             $PAGE->set_pagelayout('incourse');
2842         } else {
2843             $PAGE->set_course($course); // Set's up global $COURSE.
2844         }
2845     } else {
2846         // Do not touch global $COURSE via $PAGE->set_course(),
2847         // the reasons is we need to be able to call require_login() at any time!!
2848         $course = $SITE;
2849         if ($cm) {
2850             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2851         }
2852     }
2854     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2855     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2856     // risk leading the user back to the AJAX request URL.
2857     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2858         $setwantsurltome = false;
2859     }
2861     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2862     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2863         if ($setwantsurltome) {
2864             $SESSION->wantsurl = qualified_me();
2865         }
2866         redirect(get_login_url());
2867     }
2869     // If the user is not even logged in yet then make sure they are.
2870     if (!isloggedin()) {
2871         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2872             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2873                 // Misconfigured site guest, just redirect to login page.
2874                 redirect(get_login_url());
2875                 exit; // Never reached.
2876             }
2877             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2878             complete_user_login($guest);
2879             $USER->autologinguest = true;
2880             $SESSION->lang = $lang;
2881         } else {
2882             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2883             if ($preventredirect) {
2884                 throw new require_login_exception('You are not logged in');
2885             }
2887             if ($setwantsurltome) {
2888                 $SESSION->wantsurl = qualified_me();
2889             }
2890             if (!empty($_SERVER['HTTP_REFERER'])) {
2891                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2892             }
2893             redirect(get_login_url());
2894             exit; // Never reached.
2895         }
2896     }
2898     // Loginas as redirection if needed.
2899     if ($course->id != SITEID and session_is_loggedinas()) {
2900         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2901             if ($USER->loginascontext->instanceid != $course->id) {
2902                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2903             }
2904         }
2905     }
2907     // Check whether the user should be changing password (but only if it is REALLY them).
2908     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2909         $userauth = get_auth_plugin($USER->auth);
2910         if ($userauth->can_change_password() and !$preventredirect) {
2911             if ($setwantsurltome) {
2912                 $SESSION->wantsurl = qualified_me();
2913             }
2914             if ($changeurl = $userauth->change_password_url()) {
2915                 // Use plugin custom url.
2916                 redirect($changeurl);
2917             } else {
2918                 // Use moodle internal method.
2919                 if (empty($CFG->loginhttps)) {
2920                     redirect($CFG->wwwroot .'/login/change_password.php');
2921                 } else {
2922                     $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
2923                     redirect($wwwroot .'/login/change_password.php');
2924                 }
2925             }
2926         } else {
2927             print_error('nopasswordchangeforced', 'auth');
2928         }
2929     }
2931     // Check that the user account is properly set up.
2932     if (user_not_fully_set_up($USER)) {
2933         if ($preventredirect) {
2934             throw new require_login_exception('User not fully set-up');
2935         }
2936         if ($setwantsurltome) {
2937             $SESSION->wantsurl = qualified_me();
2938         }
2939         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2940     }
2942     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2943     sesskey();
2945     // Do not bother admins with any formalities.
2946     if (is_siteadmin()) {
2947         // Set accesstime or the user will appear offline which messes up messaging.
2948         user_accesstime_log($course->id);
2949         return;
2950     }
2952     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
2953     if (!$USER->policyagreed and !is_siteadmin()) {
2954         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2955             if ($preventredirect) {
2956                 throw new require_login_exception('Policy not agreed');
2957             }
2958             if ($setwantsurltome) {
2959                 $SESSION->wantsurl = qualified_me();
2960             }
2961             redirect($CFG->wwwroot .'/user/policy.php');
2962         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2963             if ($preventredirect) {
2964                 throw new require_login_exception('Policy not agreed');
2965             }
2966             if ($setwantsurltome) {
2967                 $SESSION->wantsurl = qualified_me();
2968             }
2969             redirect($CFG->wwwroot .'/user/policy.php');
2970         }
2971     }
2973     // Fetch the system context, the course context, and prefetch its child contexts.
2974     $sysctx = context_system::instance();
2975     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2976     if ($cm) {
2977         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2978     } else {
2979         $cmcontext = null;
2980     }
2982     // If the site is currently under maintenance, then print a message.
2983     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2984         if ($preventredirect) {
2985             throw new require_login_exception('Maintenance in progress');
2986         }
2988         print_maintenance_message();
2989     }
2991     // Make sure the course itself is not hidden.
2992     if ($course->id == SITEID) {
2993         // Frontpage can not be hidden.
2994     } else {
2995         if (is_role_switched($course->id)) {
2996             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
2997         } else {
2998             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2999                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
3000                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
3001                 if ($preventredirect) {
3002                     throw new require_login_exception('Course is hidden');
3003                 }
3004                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
3005                 // the navigation will mess up when trying to find it.
3006                 navigation_node::override_active_url(new moodle_url('/'));
3007                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
3008             }
3009         }
3010     }
3012     // Is the user enrolled?
3013     if ($course->id == SITEID) {
3014         // Everybody is enrolled on the frontpage.
3015     } else {
3016         if (session_is_loggedinas()) {
3017             // Make sure the REAL person can access this course first.
3018             $realuser = session_get_realuser();
3019             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
3020                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
3021                 if ($preventredirect) {
3022                     throw new require_login_exception('Invalid course login-as access');
3023                 }
3024                 echo $OUTPUT->header();
3025                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
3026             }
3027         }
3029         $access = false;
3031         if (is_role_switched($course->id)) {
3032             // Ok, user had to be inside this course before the switch.
3033             $access = true;
3035         } else if (is_viewing($coursecontext, $USER)) {
3036             // Ok, no need to mess with enrol.
3037             $access = true;
3039         } else {
3040             if (isset($USER->enrol['enrolled'][$course->id])) {
3041                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3042                     $access = true;
3043                     if (isset($USER->enrol['tempguest'][$course->id])) {
3044                         unset($USER->enrol['tempguest'][$course->id]);
3045                         remove_temp_course_roles($coursecontext);
3046                     }
3047                 } else {
3048                     // Expired.
3049                     unset($USER->enrol['enrolled'][$course->id]);
3050                 }
3051             }
3052             if (isset($USER->enrol['tempguest'][$course->id])) {
3053                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3054                     $access = true;
3055                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3056                     $access = true;
3057                 } else {
3058                     // Expired.
3059                     unset($USER->enrol['tempguest'][$course->id]);
3060                     remove_temp_course_roles($coursecontext);
3061                 }
3062             }
3064             if (!$access) {
3065                 // Cache not ok.
3066                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3067                 if ($until !== false) {
3068                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
3069                     if ($until == 0) {
3070                         $until = ENROL_MAX_TIMESTAMP;
3071                     }
3072                     $USER->enrol['enrolled'][$course->id] = $until;
3073                     $access = true;
3075                 } else {
3076                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
3077                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
3078                     $enrols = enrol_get_plugins(true);
3079                     // First ask all enabled enrol instances in course if they want to auto enrol user.
3080                     foreach ($instances as $instance) {
3081                         if (!isset($enrols[$instance->enrol])) {
3082                             continue;
3083                         }
3084                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3085                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3086                         if ($until !== false) {
3087                             if ($until == 0) {
3088                                 $until = ENROL_MAX_TIMESTAMP;
3089                             }
3090                             $USER->enrol['enrolled'][$course->id] = $until;
3091                             $access = true;
3092                             break;
3093                         }
3094                     }
3095                     // If not enrolled yet try to gain temporary guest access.
3096                     if (!$access) {
3097                         foreach ($instances as $instance) {
3098                             if (!isset($enrols[$instance->enrol])) {
3099                                 continue;
3100                             }
3101                             // Get a duration for the guest access, a timestamp in the future or false.
3102                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3103                             if ($until !== false and $until > time()) {
3104                                 $USER->enrol['tempguest'][$course->id] = $until;
3105                                 $access = true;
3106                                 break;
3107                             }
3108                         }
3109                     }
3110                 }
3111             }
3112         }
3114         if (!$access) {
3115             if ($preventredirect) {
3116                 throw new require_login_exception('Not enrolled');
3117             }
3118             if ($setwantsurltome) {
3119                 $SESSION->wantsurl = qualified_me();
3120             }
3121             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3122         }
3123     }
3125     // Check visibility of activity to current user; includes visible flag, groupmembersonly, conditional availability, etc.
3126     if ($cm && !$cm->uservisible) {
3127         if ($preventredirect) {
3128             throw new require_login_exception('Activity is hidden');
3129         }
3130         if ($course->id != SITEID) {
3131             $url = new moodle_url('/course/view.php', array('id' => $course->id));
3132         } else {
3133             $url = new moodle_url('/');
3134         }
3135         redirect($url, get_string('activityiscurrentlyhidden'));
3136     }
3138     // Finally access granted, update lastaccess times.
3139     user_accesstime_log($course->id);
3143 /**
3144  * This function just makes sure a user is logged out.
3145  *
3146  * @package    core_access
3147  * @category   access
3148  */
3149 function require_logout() {
3150     global $USER;
3152     if (isloggedin()) {
3153         $authsequence = get_enabled_auth_plugins(); // Auths, in sequence.
3154         foreach ($authsequence as $authname) {
3155             $authplugin = get_auth_plugin($authname);
3156             $authplugin->prelogout_hook();
3157         }
3158     }
3160     $event = \core\event\user_loggedout::create(
3161             array(
3162                 'objectid' => $USER->id,
3163                 'context' => context_user::instance($USER->id)
3164                 )
3165             );
3166     $event->trigger();
3168     session_get_instance()->terminate_current();
3169     unset($GLOBALS['USER']);
3172 /**
3173  * Weaker version of require_login()
3174  *
3175  * This is a weaker version of {@link require_login()} which only requires login
3176  * when called from within a course rather than the site page, unless
3177  * the forcelogin option is turned on.
3178  * @see require_login()
3179  *
3180  * @package    core_access
3181  * @category   access
3182  *
3183  * @param mixed $courseorid The course object or id in question
3184  * @param bool $autologinguest Allow autologin guests if that is wanted
3185  * @param object $cm Course activity module if known
3186  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3187  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3188  *             in order to keep redirects working properly. MDL-14495
3189  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3190  * @return void
3191  * @throws coding_exception
3192  */
3193 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3194     global $CFG, $PAGE, $SITE;
3195     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3196           or (!is_object($courseorid) and $courseorid == SITEID);
3197     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3198         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3199         // db queries so this is not really a performance concern, however it is obviously
3200         // better if you use get_fast_modinfo to get the cm before calling this.
3201         if (is_object($courseorid)) {
3202             $course = $courseorid;
3203         } else {
3204             $course = clone($SITE);
3205         }
3206         $modinfo = get_fast_modinfo($course);
3207         $cm = $modinfo->get_cm($cm->id);
3208     }
3209     if (!empty($CFG->forcelogin)) {
3210         // Login required for both SITE and courses.
3211         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3213     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3214         // Always login for hidden activities.
3215         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3217     } else if ($issite) {
3218         // Login for SITE not required.
3219         if ($cm and empty($cm->visible)) {
3220             // Hidden activities are not accessible without login.
3221             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3222         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3223             // Not-logged-in users do not have any group membership.
3224             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3225         } else {
3226             // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3227             if (!empty($courseorid)) {
3228                 if (is_object($courseorid)) {
3229                     $course = $courseorid;
3230                 } else {
3231                     $course = clone($SITE);
3232                 }
3233                 if ($cm) {
3234                     if ($cm->course != $course->id) {
3235                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3236                     }
3237                     $PAGE->set_cm($cm, $course);
3238                     $PAGE->set_pagelayout('incourse');
3239                 } else {
3240                     $PAGE->set_course($course);
3241                 }
3242             } else {
3243                 // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3244                 $PAGE->set_course($PAGE->course);
3245             }
3246             // TODO: verify conditional activities here.
3247             user_accesstime_log(SITEID);
3248             return;
3249         }
3251     } else {
3252         // Course login always required.
3253         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3254     }
3257 /**
3258  * Require key login. Function terminates with error if key not found or incorrect.
3259  *
3260  * @uses NO_MOODLE_COOKIES
3261  * @uses PARAM_ALPHANUM
3262  * @param string $script unique script identifier
3263  * @param int $instance optional instance id
3264  * @return int Instance ID
3265  */
3266 function require_user_key_login($script, $instance=null) {
3267     global $DB;
3269     if (!NO_MOODLE_COOKIES) {
3270         print_error('sessioncookiesdisable');
3271     }
3273     // Extra safety.
3274     @session_write_close();
3276     $keyvalue = required_param('key', PARAM_ALPHANUM);
3278     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3279         print_error('invalidkey');
3280     }
3282     if (!empty($key->validuntil) and $key->validuntil < time()) {
3283         print_error('expiredkey');
3284     }
3286     if ($key->iprestriction) {
3287         $remoteaddr = getremoteaddr(null);
3288         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3289             print_error('ipmismatch');
3290         }
3291     }
3293     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3294         print_error('invaliduserid');
3295     }
3297     // Emulate normal session.
3298     enrol_check_plugins($user);
3299     session_set_user($user);
3301     // Note we are not using normal login.
3302     if (!defined('USER_KEY_LOGIN')) {
3303         define('USER_KEY_LOGIN', true);
3304     }
3306     // Return instance id - it might be empty.
3307     return $key->instance;
3310 /**
3311  * Creates a new private user access key.
3312  *
3313  * @param string $script unique target identifier
3314  * @param int $userid
3315  * @param int $instance optional instance id
3316  * @param string $iprestriction optional ip restricted access
3317  * @param timestamp $validuntil key valid only until given data
3318  * @return string access key value
3319  */
3320 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3321     global $DB;
3323     $key = new stdClass();
3324     $key->script        = $script;
3325     $key->userid        = $userid;
3326     $key->instance      = $instance;
3327     $key->iprestriction = $iprestriction;
3328     $key->validuntil    = $validuntil;
3329     $key->timecreated   = time();
3331     // Something long and unique.
3332     $key->value         = md5($userid.'_'.time().random_string(40));
3333     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3334         // Must be unique.
3335         $key->value     = md5($userid.'_'.time().random_string(40));
3336     }
3337     $DB->insert_record('user_private_key', $key);
3338     return $key->value;
3341 /**
3342  * Delete the user's new private user access keys for a particular script.
3343  *
3344  * @param string $script unique target identifier
3345  * @param int $userid
3346  * @return void
3347  */
3348 function delete_user_key($script, $userid) {
3349     global $DB;
3350     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3353 /**
3354  * Gets a private user access key (and creates one if one doesn't exist).
3355  *
3356  * @param string $script unique target identifier
3357  * @param int $userid
3358  * @param int $instance optional instance id
3359  * @param string $iprestriction optional ip restricted access
3360  * @param timestamp $validuntil key valid only until given data
3361  * @return string access key value
3362  */
3363 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3364     global $DB;
3366     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3367                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3368                                                          'validuntil' => $validuntil))) {
3369         return $key->value;
3370     } else {
3371         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3372     }
3376 /**
3377  * Modify the user table by setting the currently logged in user's last login to now.
3378  *
3379  * @return bool Always returns true
3380  */
3381 function update_user_login_times() {
3382     global $USER, $DB, $CFG;
3384     require_once($CFG->dirroot.'/user/lib.php');
3386     if (isguestuser()) {
3387         // Do not update guest access times/ips for performance.
3388         return true;
3389     }
3391     $now = time();
3393     $user = new stdClass();
3394     $user->id = $USER->id;
3396     // Make sure all users that logged in have some firstaccess.
3397     if ($USER->firstaccess == 0) {
3398         $USER->firstaccess = $user->firstaccess = $now;
3399     }
3401     // Store the previous current as lastlogin.
3402     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3404     $USER->currentlogin = $user->currentlogin = $now;
3406     // Function user_accesstime_log() may not update immediately, better do it here.
3407     $USER->lastaccess = $user->lastaccess = $now;
3408     $USER->lastip = $user->lastip = getremoteaddr();
3410     user_update_user($user, false);
3411     return true;
3414 /**
3415  * Determines if a user has completed setting up their account.
3416  *
3417  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3418  * @return bool
3419  */
3420 function user_not_fully_set_up($user) {
3421     if (isguestuser($user)) {
3422         return false;
3423     }
3424     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3427 /**
3428  * Check whether the user has exceeded the bounce threshold
3429  *
3430  * @param stdClass $user A {@link $USER} object
3431  * @return bool true => User has exceeded bounce threshold
3432  */
3433 function over_bounce_threshold($user) {
3434     global $CFG, $DB;
3436     if (empty($CFG->handlebounces)) {
3437         return false;
3438     }
3440     if (empty($user->id)) {
3441         // No real (DB) user, nothing to do here.
3442         return false;
3443     }
3445     // Set sensible defaults.
3446     if (empty($CFG->minbounces)) {
3447         $CFG->minbounces = 10;
3448     }
3449     if (empty($CFG->bounceratio)) {
3450         $CFG->bounceratio = .20;
3451     }
3452     $bouncecount = 0;
3453     $sendcount = 0;
3454     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3455         $bouncecount = $bounce->value;
3456     }
3457     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3458         $sendcount = $send->value;
3459     }
3460     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3463 /**
3464  * Used to increment or reset email sent count
3465  *
3466  * @param stdClass $user object containing an id
3467  * @param bool $reset will reset the count to 0
3468  * @return void
3469  */
3470 function set_send_count($user, $reset=false) {
3471     global $DB;
3473     if (empty($user->id)) {
3474         // No real (DB) user, nothing to do here.
3475         return;
3476     }
3478     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3479         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3480         $DB->update_record('user_preferences', $pref);
3481     } else if (!empty($reset)) {
3482         // If it's not there and we're resetting, don't bother. Make a new one.
3483         $pref = new stdClass();
3484         $pref->name   = 'email_send_count';
3485         $pref->value  = 1;
3486         $pref->userid = $user->id;
3487         $DB->insert_record('user_preferences', $pref, false);
3488     }
3491 /**
3492  * Increment or reset user's email bounce count
3493  *
3494  * @param stdClass $user object containing an id
3495  * @param bool $reset will reset the count to 0
3496  */
3497 function set_bounce_count($user, $reset=false) {
3498     global $DB;
3500     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3501         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3502         $DB->update_record('user_preferences', $pref);
3503     } else if (!empty($reset)) {
3504         // If it's not there and we're resetting, don't bother. Make a new one.
3505         $pref = new stdClass();
3506         $pref->name   = 'email_bounce_count';
3507         $pref->value  = 1;
3508         $pref->userid = $user->id;
3509         $DB->insert_record('user_preferences', $pref, false);
3510     }
3513 /**
3514  * Determines if the logged in user is currently moving an activity
3515  *
3516  * @param int $courseid The id of the course being tested
3517  * @return bool
3518  */
3519 function ismoving($courseid) {
3520     global $USER;
3522     if (!empty($USER->activitycopy)) {
3523         return ($USER->activitycopycourse == $courseid);
3524     }
3525     return false;
3528 /**
3529  * Returns a persons full name
3530  *
3531  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3532  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3533  * specify one.
3534  *
3535  * @param stdClass $user A {@link $USER} object to get full name of.
3536  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3537  * @return string
3538  */
3539 function fullname($user, $override=false) {
3540     global $CFG, $SESSION;
3542     if (!isset($user->firstname) and !isset($user->lastname)) {
3543         return '';
3544     }
3546     if (!$override) {
3547         if (!empty($CFG->forcefirstname)) {
3548             $user->firstname = $CFG->forcefirstname;
3549         }
3550         if (!empty($CFG->forcelastname)) {
3551             $user->lastname = $CFG->forcelastname;
3552         }
3553     }
3555     if (!empty($SESSION->fullnamedisplay)) {
3556         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3557     }
3559     $template = null;
3560     // If the fullnamedisplay setting is available, set the template to that.
3561     if (isset($CFG->fullnamedisplay)) {
3562         $template = $CFG->fullnamedisplay;
3563     }
3564     // If the template is empty, or set to language, or $override is set, return the language string.
3565     if (empty($template) || $template == 'language' || $override) {
3566         return get_string('fullnamedisplay', null, $user);
3567     }
3569     // Get all of the name fields.
3570     $allnames = get_all_user_name_fields();
3571     $requirednames = array();
3572     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3573     foreach ($allnames as $allname) {
3574         if (strpos($template, $allname) !== false) {
3575             $requirednames[] = $allname;
3576             // If the field is in the template but not set in the user object then notify the programmer that it needs to be fixed.
3577             if (!array_key_exists($allname, $user)) {
3578                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3579             }
3580         }
3581     }
3583     $displayname = $template;
3584     // Switch in the actual data into the template.
3585     foreach ($requirednames as $altname) {
3586         if (isset($user->$altname)) {
3587             // Using empty() on the below if statement causes breakages.
3588             if ((string)$user->$altname == '') {
3589                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3590             } else {
3591                 $displayname = str_replace($altname, $user->$altname, $displayname);
3592             }
3593         } else {
3594             $displayname = str_replace($altname, 'EMPTY', $displayname);
3595         }
3596     }
3597     // Tidy up any misc. characters (Not perfect, but gets most characters).
3598     // Don't remove the "u" at the end of the first expression unless you want garbled characters when combining hiragana or
3599     // katakana and parenthesis.
3600     $patterns = array();
3601     // This regular expression replacement is to fix problems such as 'James () Kirk' Where 'Tiberius' (middlename) has not been
3602     // filled in by a user.
3603     // The special characters are Japanese brackets that are common enough to make allowances for them (not covered by :punct:).
3604     $patterns[] = '/[[:punct:]「」]*EMPTY[[:punct:]「」]*/u';
3605     // This regular expression is to remove any double spaces in the display name.
3606     $patterns[] = '/\s{2,}/';
3607     foreach ($patterns as $pattern) {
3608         $displayname = preg_replace($pattern, ' ', $displayname);
3609     }
3611     // Trimming $displayname will help the next check to ensure that we don't have a display name with spaces.
3612     $displayname = trim($displayname);
3613     if (empty($displayname)) {
3614         // Going with just the first name if no alternate fields are filled out. May be changed later depending on what
3615         // people in general feel is a good setting to fall back on.
3616         $displayname = $user->firstname;
3617     }
3618     return $displayname;
3621 /**
3622  * A centralised location for the all name fields. Returns an array / sql string snippet.
3623  *
3624  * @param bool $returnsql True for an sql select field snippet.
3625  * @param string $alias table alias to use in front of each field.
3626  * @return array|string All name fields.
3627  */
3628 function get_all_user_name_fields($returnsql = false, $alias = null) {
3629     $alternatenames = array('firstnamephonetic',
3630                             'lastnamephonetic',
3631                             'middlename',
3632                             'alternatename',
3633                             'firstname',
3634                             'lastname');
3635     if ($returnsql) {
3636         if ($alias) {
3637             foreach ($alternatenames as $key => $altname) {
3638                 $alternatenames[$key] = "$alias.$altname";
3639             }
3640         }
3641         $alternatenames = implode(',', $alternatenames);
3642     }
3643     return $alternatenames;
3646 /**
3647  * Returns an array of values in order of occurance in a provided string.
3648  * The key in the result is the character postion in the string.
3649  *
3650  * @param array $values Values to be found in the string format