MDL-35332 lib: Improve security of hashed passwords
[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.  //////////////
76 /**
77  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
78  */
79 define('PARAM_ALPHA',    'alpha');
81 /**
82  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
83  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
84  */
85 define('PARAM_ALPHAEXT', 'alphaext');
87 /**
88  * PARAM_ALPHANUM - expected numbers and letters only.
89  */
90 define('PARAM_ALPHANUM', 'alphanum');
92 /**
93  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
94  */
95 define('PARAM_ALPHANUMEXT', 'alphanumext');
97 /**
98  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
99  */
100 define('PARAM_AUTH',  'auth');
102 /**
103  * PARAM_BASE64 - Base 64 encoded format
104  */
105 define('PARAM_BASE64',   'base64');
107 /**
108  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
109  */
110 define('PARAM_BOOL',     'bool');
112 /**
113  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
114  * checked against the list of capabilities in the database.
115  */
116 define('PARAM_CAPABILITY',   'capability');
118 /**
119  * PARAM_CLEANHTML - cleans submitted HTML code. use only for text in HTML format. This cleaning may fix xhtml strictness too.
120  */
121 define('PARAM_CLEANHTML', 'cleanhtml');
123 /**
124  * PARAM_EMAIL - an email address following the RFC
125  */
126 define('PARAM_EMAIL',   'email');
128 /**
129  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
130  */
131 define('PARAM_FILE',   'file');
133 /**
134  * PARAM_FLOAT - a real/floating point number.
135  *
136  * Note that you should not use PARAM_FLOAT for numbers typed in by the user.
137  * It does not work for languages that use , as a decimal separator.
138  * Instead, do something like
139  *     $rawvalue = required_param('name', PARAM_RAW);
140  *     // ... other code including require_login, which sets current lang ...
141  *     $realvalue = unformat_float($rawvalue);
142  *     // ... then use $realvalue
143  */
144 define('PARAM_FLOAT',  'float');
146 /**
147  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
148  */
149 define('PARAM_HOST',     'host');
151 /**
152  * PARAM_INT - integers only, use when expecting only numbers.
153  */
154 define('PARAM_INT',      'int');
156 /**
157  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
158  */
159 define('PARAM_LANG',  'lang');
161 /**
162  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the others! Implies PARAM_URL!)
163  */
164 define('PARAM_LOCALURL', 'localurl');
166 /**
167  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
168  */
169 define('PARAM_NOTAGS',   'notags');
171 /**
172  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
173  * note: the leading slash is not removed, window drive letter is not allowed
174  */
175 define('PARAM_PATH',     'path');
177 /**
178  * PARAM_PEM - Privacy Enhanced Mail format
179  */
180 define('PARAM_PEM',      'pem');
182 /**
183  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
184  */
185 define('PARAM_PERMISSION',   'permission');
187 /**
188  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
189  */
190 define('PARAM_RAW', 'raw');
192 /**
193  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
194  */
195 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
197 /**
198  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
199  */
200 define('PARAM_SAFEDIR',  'safedir');
202 /**
203  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
204  */
205 define('PARAM_SAFEPATH',  'safepath');
207 /**
208  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
209  */
210 define('PARAM_SEQUENCE',  'sequence');
212 /**
213  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
214  */
215 define('PARAM_TAG',   'tag');
217 /**
218  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
219  */
220 define('PARAM_TAGLIST',   'taglist');
222 /**
223  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
224  */
225 define('PARAM_TEXT',  'text');
227 /**
228  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
229  */
230 define('PARAM_THEME',  'theme');
232 /**
233  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
234  */
235 define('PARAM_URL',      'url');
237 /**
238  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
239  */
240 define('PARAM_USERNAME',    'username');
242 /**
243  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
244  */
245 define('PARAM_STRINGID',    'stringid');
247 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
248 /**
249  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
250  * It was one of the first types, that is why it is abused so much ;-)
251  * @deprecated since 2.0
252  */
253 define('PARAM_CLEAN',    'clean');
255 /**
256  * PARAM_INTEGER - deprecated alias for PARAM_INT
257  * @deprecated since 2.0
258  */
259 define('PARAM_INTEGER',  'int');
261 /**
262  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
263  * @deprecated since 2.0
264  */
265 define('PARAM_NUMBER',  'float');
267 /**
268  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
269  * NOTE: originally alias for PARAM_APLHA
270  * @deprecated since 2.0
271  */
272 define('PARAM_ACTION',   'alphanumext');
274 /**
275  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
276  * NOTE: originally alias for PARAM_APLHA
277  * @deprecated since 2.0
278  */
279 define('PARAM_FORMAT',   'alphanumext');
281 /**
282  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
283  * @deprecated since 2.0
284  */
285 define('PARAM_MULTILANG',  'text');
287 /**
288  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
289  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
290  * America/Port-au-Prince)
291  */
292 define('PARAM_TIMEZONE', 'timezone');
294 /**
295  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
296  */
297 define('PARAM_CLEANFILE', 'file');
299 /**
300  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
301  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
302  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
303  * NOTE: numbers and underscores are strongly discouraged in plugin names!
304  */
305 define('PARAM_COMPONENT', 'component');
307 /**
308  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
309  * It is usually used together with context id and component.
310  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
311  */
312 define('PARAM_AREA', 'area');
314 /**
315  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
316  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
317  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
318  */
319 define('PARAM_PLUGIN', 'plugin');
322 /// Web Services ///
324 /**
325  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
326  */
327 define('VALUE_REQUIRED', 1);
329 /**
330  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
331  */
332 define('VALUE_OPTIONAL', 2);
334 /**
335  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
336  */
337 define('VALUE_DEFAULT', 0);
339 /**
340  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
341  */
342 define('NULL_NOT_ALLOWED', false);
344 /**
345  * NULL_ALLOWED - the parameter can be set to null in the database
346  */
347 define('NULL_ALLOWED', true);
349 /// Page types ///
350 /**
351  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
352  */
353 define('PAGE_COURSE_VIEW', 'course-view');
355 /** Get remote addr constant */
356 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
357 /** Get remote addr constant */
358 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
360 /// Blog access level constant declaration ///
361 define ('BLOG_USER_LEVEL', 1);
362 define ('BLOG_GROUP_LEVEL', 2);
363 define ('BLOG_COURSE_LEVEL', 3);
364 define ('BLOG_SITE_LEVEL', 4);
365 define ('BLOG_GLOBAL_LEVEL', 5);
368 ///Tag constants///
369 /**
370  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
371  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
372  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
373  *
374  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
375  */
376 define('TAG_MAX_LENGTH', 50);
378 /// Password policy constants ///
379 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
380 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
381 define ('PASSWORD_DIGITS', '0123456789');
382 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
384 /// Feature constants ///
385 // Used for plugin_supports() to report features that are, or are not, supported by a module.
387 /** True if module can provide a grade */
388 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
389 /** True if module supports outcomes */
390 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
391 /** True if module supports advanced grading methods */
392 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
393 /** True if module controls the grade visibility over the gradebook */
394 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
395 /** True if module supports plagiarism plugins */
396 define('FEATURE_PLAGIARISM', 'plagiarism');
398 /** True if module has code to track whether somebody viewed it */
399 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
400 /** True if module has custom completion rules */
401 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
403 /** True if module has no 'view' page (like label) */
404 define('FEATURE_NO_VIEW_LINK', 'viewlink');
405 /** True if module supports outcomes */
406 define('FEATURE_IDNUMBER', 'idnumber');
407 /** True if module supports groups */
408 define('FEATURE_GROUPS', 'groups');
409 /** True if module supports groupings */
410 define('FEATURE_GROUPINGS', 'groupings');
411 /** True if module supports groupmembersonly */
412 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
414 /** Type of module */
415 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
416 /** True if module supports intro editor */
417 define('FEATURE_MOD_INTRO', 'mod_intro');
418 /** True if module has default completion */
419 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
421 define('FEATURE_COMMENT', 'comment');
423 define('FEATURE_RATE', 'rate');
424 /** True if module supports backup/restore of moodle2 format */
425 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
427 /** True if module can show description on course main page */
428 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
430 /** Unspecified module archetype */
431 define('MOD_ARCHETYPE_OTHER', 0);
432 /** Resource-like type module */
433 define('MOD_ARCHETYPE_RESOURCE', 1);
434 /** Assignment module archetype */
435 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
436 /** System (not user-addable) module archetype */
437 define('MOD_ARCHETYPE_SYSTEM', 3);
439 /**
440  * Security token used for allowing access
441  * from external application such as web services.
442  * Scripts do not use any session, performance is relatively
443  * low because we need to load access info in each request.
444  * Scripts are executed in parallel.
445  */
446 define('EXTERNAL_TOKEN_PERMANENT', 0);
448 /**
449  * Security token used for allowing access
450  * of embedded applications, the code is executed in the
451  * active user session. Token is invalidated after user logs out.
452  * Scripts are executed serially - normal session locking is used.
453  */
454 define('EXTERNAL_TOKEN_EMBEDDED', 1);
456 /**
457  * The home page should be the site home
458  */
459 define('HOMEPAGE_SITE', 0);
460 /**
461  * The home page should be the users my page
462  */
463 define('HOMEPAGE_MY', 1);
464 /**
465  * The home page can be chosen by the user
466  */
467 define('HOMEPAGE_USER', 2);
469 /**
470  * Hub directory url (should be moodle.org)
471  */
472 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
475 /**
476  * Moodle.org url (should be moodle.org)
477  */
478 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
480 /**
481  * Moodle mobile app service name
482  */
483 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
485 /**
486  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
487  */
488 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
490 /**
491  * Course display settings
492  */
493 define('COURSE_DISPLAY_SINGLEPAGE', 0); // display all sections on one page
494 define('COURSE_DISPLAY_MULTIPAGE', 1); // split pages into a page per section
496 /**
497  * Authentication constants.
498  */
499 define('AUTH_PASSWORD_NOT_CACHED', 'not cached'); // String used in password field when password is not stored.
501 /// PARAMETER HANDLING ////////////////////////////////////////////////////
503 /**
504  * Returns a particular value for the named variable, taken from
505  * POST or GET.  If the parameter doesn't exist then an error is
506  * thrown because we require this variable.
507  *
508  * This function should be used to initialise all required values
509  * in a script that are based on parameters.  Usually it will be
510  * used like this:
511  *    $id = required_param('id', PARAM_INT);
512  *
513  * Please note the $type parameter is now required and the value can not be array.
514  *
515  * @param string $parname the name of the page parameter we want
516  * @param string $type expected type of parameter
517  * @return mixed
518  */
519 function required_param($parname, $type) {
520     if (func_num_args() != 2 or empty($parname) or empty($type)) {
521         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
522     }
523     if (isset($_POST[$parname])) {       // POST has precedence
524         $param = $_POST[$parname];
525     } else if (isset($_GET[$parname])) {
526         $param = $_GET[$parname];
527     } else {
528         print_error('missingparam', '', '', $parname);
529     }
531     if (is_array($param)) {
532         debugging('Invalid array parameter detected in required_param(): '.$parname);
533         // TODO: switch to fatal error in Moodle 2.3
534         //print_error('missingparam', '', '', $parname);
535         return required_param_array($parname, $type);
536     }
538     return clean_param($param, $type);
541 /**
542  * Returns a particular array value for the named variable, taken from
543  * POST or GET.  If the parameter doesn't exist then an error is
544  * thrown because we require this variable.
545  *
546  * This function should be used to initialise all required values
547  * in a script that are based on parameters.  Usually it will be
548  * used like this:
549  *    $ids = required_param_array('ids', PARAM_INT);
550  *
551  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
552  *
553  * @param string $parname the name of the page parameter we want
554  * @param string $type expected type of parameter
555  * @return array
556  */
557 function required_param_array($parname, $type) {
558     if (func_num_args() != 2 or empty($parname) or empty($type)) {
559         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
560     }
561     if (isset($_POST[$parname])) {       // POST has precedence
562         $param = $_POST[$parname];
563     } else if (isset($_GET[$parname])) {
564         $param = $_GET[$parname];
565     } else {
566         print_error('missingparam', '', '', $parname);
567     }
568     if (!is_array($param)) {
569         print_error('missingparam', '', '', $parname);
570     }
572     $result = array();
573     foreach($param as $key=>$value) {
574         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
575             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
576             continue;
577         }
578         $result[$key] = clean_param($value, $type);
579     }
581     return $result;
584 /**
585  * Returns a particular value for the named variable, taken from
586  * POST or GET, otherwise returning a given default.
587  *
588  * This function should be used to initialise all optional values
589  * in a script that are based on parameters.  Usually it will be
590  * used like this:
591  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
592  *
593  * Please note the $type parameter is now required and the value can not be array.
594  *
595  * @param string $parname the name of the page parameter we want
596  * @param mixed  $default the default value to return if nothing is found
597  * @param string $type expected type of parameter
598  * @return mixed
599  */
600 function optional_param($parname, $default, $type) {
601     if (func_num_args() != 3 or empty($parname) or empty($type)) {
602         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
603     }
604     if (!isset($default)) {
605         $default = null;
606     }
608     if (isset($_POST[$parname])) {       // POST has precedence
609         $param = $_POST[$parname];
610     } else if (isset($_GET[$parname])) {
611         $param = $_GET[$parname];
612     } else {
613         return $default;
614     }
616     if (is_array($param)) {
617         debugging('Invalid array parameter detected in required_param(): '.$parname);
618         // TODO: switch to $default in Moodle 2.3
619         //return $default;
620         return optional_param_array($parname, $default, $type);
621     }
623     return clean_param($param, $type);
626 /**
627  * Returns a particular array value for the named variable, taken from
628  * POST or GET, otherwise returning a given default.
629  *
630  * This function should be used to initialise all optional values
631  * in a script that are based on parameters.  Usually it will be
632  * used like this:
633  *    $ids = optional_param('id', array(), PARAM_INT);
634  *
635  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
636  *
637  * @param string $parname the name of the page parameter we want
638  * @param mixed  $default the default value to return if nothing is found
639  * @param string $type expected type of parameter
640  * @return array
641  */
642 function optional_param_array($parname, $default, $type) {
643     if (func_num_args() != 3 or empty($parname) or empty($type)) {
644         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
645     }
647     if (isset($_POST[$parname])) {       // POST has precedence
648         $param = $_POST[$parname];
649     } else if (isset($_GET[$parname])) {
650         $param = $_GET[$parname];
651     } else {
652         return $default;
653     }
654     if (!is_array($param)) {
655         debugging('optional_param_array() expects array parameters only: '.$parname);
656         return $default;
657     }
659     $result = array();
660     foreach($param as $key=>$value) {
661         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
662             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
663             continue;
664         }
665         $result[$key] = clean_param($value, $type);
666     }
668     return $result;
671 /**
672  * Strict validation of parameter values, the values are only converted
673  * to requested PHP type. Internally it is using clean_param, the values
674  * before and after cleaning must be equal - otherwise
675  * an invalid_parameter_exception is thrown.
676  * Objects and classes are not accepted.
677  *
678  * @param mixed $param
679  * @param string $type PARAM_ constant
680  * @param bool $allownull are nulls valid value?
681  * @param string $debuginfo optional debug information
682  * @return mixed the $param value converted to PHP type
683  * @throws invalid_parameter_exception if $param is not of given type
684  */
685 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
686     if (is_null($param)) {
687         if ($allownull == NULL_ALLOWED) {
688             return null;
689         } else {
690             throw new invalid_parameter_exception($debuginfo);
691         }
692     }
693     if (is_array($param) or is_object($param)) {
694         throw new invalid_parameter_exception($debuginfo);
695     }
697     $cleaned = clean_param($param, $type);
699     if ($type == PARAM_FLOAT) {
700         // Do not detect precision loss here.
701         if (is_float($param) or is_int($param)) {
702             // These always fit.
703         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
704             throw new invalid_parameter_exception($debuginfo);
705         }
706     } else if ((string)$param !== (string)$cleaned) {
707         // conversion to string is usually lossless
708         throw new invalid_parameter_exception($debuginfo);
709     }
711     return $cleaned;
714 /**
715  * Makes sure array contains only the allowed types,
716  * this function does not validate array key names!
717  * <code>
718  * $options = clean_param($options, PARAM_INT);
719  * </code>
720  *
721  * @param array $param the variable array we are cleaning
722  * @param string $type expected format of param after cleaning.
723  * @param bool $recursive clean recursive arrays
724  * @return array
725  */
726 function clean_param_array(array $param = null, $type, $recursive = false) {
727     $param = (array)$param; // convert null to empty array
728     foreach ($param as $key => $value) {
729         if (is_array($value)) {
730             if ($recursive) {
731                 $param[$key] = clean_param_array($value, $type, true);
732             } else {
733                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
734             }
735         } else {
736             $param[$key] = clean_param($value, $type);
737         }
738     }
739     return $param;
742 /**
743  * Used by {@link optional_param()} and {@link required_param()} to
744  * clean the variables and/or cast to specific types, based on
745  * an options field.
746  * <code>
747  * $course->format = clean_param($course->format, PARAM_ALPHA);
748  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
749  * </code>
750  *
751  * @param mixed $param the variable we are cleaning
752  * @param string $type expected format of param after cleaning.
753  * @return mixed
754  */
755 function clean_param($param, $type) {
757     global $CFG;
759     if (is_array($param)) {
760         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
761     } else if (is_object($param)) {
762         if (method_exists($param, '__toString')) {
763             $param = $param->__toString();
764         } else {
765             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
766         }
767     }
769     switch ($type) {
770         case PARAM_RAW:          // no cleaning at all
771             $param = fix_utf8($param);
772             return $param;
774         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
775             $param = fix_utf8($param);
776             return trim($param);
778         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
779             // this is deprecated!, please use more specific type instead
780             if (is_numeric($param)) {
781                 return $param;
782             }
783             $param = fix_utf8($param);
784             return clean_text($param);     // Sweep for scripts, etc
786         case PARAM_CLEANHTML:    // clean html fragment
787             $param = fix_utf8($param);
788             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
789             return trim($param);
791         case PARAM_INT:
792             return (int)$param;  // Convert to integer
794         case PARAM_FLOAT:
795             return (float)$param;  // Convert to float
797         case PARAM_ALPHA:        // Remove everything not a-z
798             return preg_replace('/[^a-zA-Z]/i', '', $param);
800         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
801             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
803         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
804             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
806         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
807             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
809         case PARAM_SEQUENCE:     // Remove everything not 0-9,
810             return preg_replace('/[^0-9,]/i', '', $param);
812         case PARAM_BOOL:         // Convert to 1 or 0
813             $tempstr = strtolower($param);
814             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
815                 $param = 1;
816             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
817                 $param = 0;
818             } else {
819                 $param = empty($param) ? 0 : 1;
820             }
821             return $param;
823         case PARAM_NOTAGS:       // Strip all tags
824             $param = fix_utf8($param);
825             return strip_tags($param);
827         case PARAM_TEXT:    // leave only tags needed for multilang
828             $param = fix_utf8($param);
829             // if the multilang syntax is not correct we strip all tags
830             // because it would break xhtml strict which is required for accessibility standards
831             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
832             do {
833                 if (strpos($param, '</lang>') !== false) {
834                     // old and future mutilang syntax
835                     $param = strip_tags($param, '<lang>');
836                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
837                         break;
838                     }
839                     $open = false;
840                     foreach ($matches[0] as $match) {
841                         if ($match === '</lang>') {
842                             if ($open) {
843                                 $open = false;
844                                 continue;
845                             } else {
846                                 break 2;
847                             }
848                         }
849                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
850                             break 2;
851                         } else {
852                             $open = true;
853                         }
854                     }
855                     if ($open) {
856                         break;
857                     }
858                     return $param;
860                 } else if (strpos($param, '</span>') !== false) {
861                     // current problematic multilang syntax
862                     $param = strip_tags($param, '<span>');
863                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
864                         break;
865                     }
866                     $open = false;
867                     foreach ($matches[0] as $match) {
868                         if ($match === '</span>') {
869                             if ($open) {
870                                 $open = false;
871                                 continue;
872                             } else {
873                                 break 2;
874                             }
875                         }
876                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
877                             break 2;
878                         } else {
879                             $open = true;
880                         }
881                     }
882                     if ($open) {
883                         break;
884                     }
885                     return $param;
886                 }
887             } while (false);
888             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
889             return strip_tags($param);
891         case PARAM_COMPONENT:
892             // we do not want any guessing here, either the name is correct or not
893             // please note only normalised component names are accepted
894             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
895                 return '';
896             }
897             if (strpos($param, '__') !== false) {
898                 return '';
899             }
900             if (strpos($param, 'mod_') === 0) {
901                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
902                 if (substr_count($param, '_') != 1) {
903                     return '';
904                 }
905             }
906             return $param;
908         case PARAM_PLUGIN:
909         case PARAM_AREA:
910             // we do not want any guessing here, either the name is correct or not
911             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
912                 return '';
913             }
914             if (strpos($param, '__') !== false) {
915                 return '';
916             }
917             return $param;
919         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
920             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
922         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
923             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
925         case PARAM_FILE:         // Strip all suspicious characters from filename
926             $param = fix_utf8($param);
927             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
928             if ($param === '.' || $param === '..') {
929                 $param = '';
930             }
931             return $param;
933         case PARAM_PATH:         // Strip all suspicious characters from file path
934             $param = fix_utf8($param);
935             $param = str_replace('\\', '/', $param);
937             // Explode the path and clean each element using the PARAM_FILE rules.
938             $breadcrumb = explode('/', $param);
939             foreach ($breadcrumb as $key => $crumb) {
940                 if ($crumb === '.' && $key === 0) {
941                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
942                 } else {
943                     $crumb = clean_param($crumb, PARAM_FILE);
944                 }
945                 $breadcrumb[$key] = $crumb;
946             }
947             $param = implode('/', $breadcrumb);
949             // Remove multiple current path (./././) and multiple slashes (///).
950             $param = preg_replace('~//+~', '/', $param);
951             $param = preg_replace('~/(\./)+~', '/', $param);
952             return $param;
954         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
955             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
956             // match ipv4 dotted quad
957             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
958                 // confirm values are ok
959                 if ( $match[0] > 255
960                      || $match[1] > 255
961                      || $match[3] > 255
962                      || $match[4] > 255 ) {
963                     // hmmm, what kind of dotted quad is this?
964                     $param = '';
965                 }
966             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
967                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
968                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
969                        ) {
970                 // all is ok - $param is respected
971             } else {
972                 // all is not ok...
973                 $param='';
974             }
975             return $param;
977         case PARAM_URL:          // allow safe ftp, http, mailto urls
978             $param = fix_utf8($param);
979             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
980             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
981                 // all is ok, param is respected
982             } else {
983                 $param =''; // not really ok
984             }
985             return $param;
987         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
988             $param = clean_param($param, PARAM_URL);
989             if (!empty($param)) {
990                 if (preg_match(':^/:', $param)) {
991                     // root-relative, ok!
992                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
993                     // absolute, and matches our wwwroot
994                 } else {
995                     // relative - let's make sure there are no tricks
996                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
997                         // looks ok.
998                     } else {
999                         $param = '';
1000                     }
1001                 }
1002             }
1003             return $param;
1005         case PARAM_PEM:
1006             $param = trim($param);
1007             // PEM formatted strings may contain letters/numbers and the symbols
1008             // forward slash: /
1009             // plus sign:     +
1010             // equal sign:    =
1011             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
1012             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1013                 list($wholething, $body) = $matches;
1014                 unset($wholething, $matches);
1015                 $b64 = clean_param($body, PARAM_BASE64);
1016                 if (!empty($b64)) {
1017                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1018                 } else {
1019                     return '';
1020                 }
1021             }
1022             return '';
1024         case PARAM_BASE64:
1025             if (!empty($param)) {
1026                 // PEM formatted strings may contain letters/numbers and the symbols
1027                 // forward slash: /
1028                 // plus sign:     +
1029                 // equal sign:    =
1030                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1031                     return '';
1032                 }
1033                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1034                 // Each line of base64 encoded data must be 64 characters in
1035                 // length, except for the last line which may be less than (or
1036                 // equal to) 64 characters long.
1037                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1038                     if ($i + 1 == $j) {
1039                         if (64 < strlen($lines[$i])) {
1040                             return '';
1041                         }
1042                         continue;
1043                     }
1045                     if (64 != strlen($lines[$i])) {
1046                         return '';
1047                     }
1048                 }
1049                 return implode("\n",$lines);
1050             } else {
1051                 return '';
1052             }
1054         case PARAM_TAG:
1055             $param = fix_utf8($param);
1056             // Please note it is not safe to use the tag name directly anywhere,
1057             // it must be processed with s(), urlencode() before embedding anywhere.
1058             // remove some nasties
1059             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1060             //convert many whitespace chars into one
1061             $param = preg_replace('/\s+/', ' ', $param);
1062             $param = textlib::substr(trim($param), 0, TAG_MAX_LENGTH);
1063             return $param;
1065         case PARAM_TAGLIST:
1066             $param = fix_utf8($param);
1067             $tags = explode(',', $param);
1068             $result = array();
1069             foreach ($tags as $tag) {
1070                 $res = clean_param($tag, PARAM_TAG);
1071                 if ($res !== '') {
1072                     $result[] = $res;
1073                 }
1074             }
1075             if ($result) {
1076                 return implode(',', $result);
1077             } else {
1078                 return '';
1079             }
1081         case PARAM_CAPABILITY:
1082             if (get_capability_info($param)) {
1083                 return $param;
1084             } else {
1085                 return '';
1086             }
1088         case PARAM_PERMISSION:
1089             $param = (int)$param;
1090             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1091                 return $param;
1092             } else {
1093                 return CAP_INHERIT;
1094             }
1096         case PARAM_AUTH:
1097             $param = clean_param($param, PARAM_PLUGIN);
1098             if (empty($param)) {
1099                 return '';
1100             } else if (exists_auth_plugin($param)) {
1101                 return $param;
1102             } else {
1103                 return '';
1104             }
1106         case PARAM_LANG:
1107             $param = clean_param($param, PARAM_SAFEDIR);
1108             if (get_string_manager()->translation_exists($param)) {
1109                 return $param;
1110             } else {
1111                 return ''; // Specified language is not installed or param malformed
1112             }
1114         case PARAM_THEME:
1115             $param = clean_param($param, PARAM_PLUGIN);
1116             if (empty($param)) {
1117                 return '';
1118             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1119                 return $param;
1120             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1121                 return $param;
1122             } else {
1123                 return '';  // Specified theme is not installed
1124             }
1126         case PARAM_USERNAME:
1127             $param = fix_utf8($param);
1128             $param = str_replace(" " , "", $param);
1129             $param = textlib::strtolower($param);  // Convert uppercase to lowercase MDL-16919
1130             if (empty($CFG->extendedusernamechars)) {
1131                 // regular expression, eliminate all chars EXCEPT:
1132                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1133                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1134             }
1135             return $param;
1137         case PARAM_EMAIL:
1138             $param = fix_utf8($param);
1139             if (validate_email($param)) {
1140                 return $param;
1141             } else {
1142                 return '';
1143             }
1145         case PARAM_STRINGID:
1146             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1147                 return $param;
1148             } else {
1149                 return '';
1150             }
1152         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1153             $param = fix_utf8($param);
1154             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1155             if (preg_match($timezonepattern, $param)) {
1156                 return $param;
1157             } else {
1158                 return '';
1159             }
1161         default:                 // throw error, switched parameters in optional_param or another serious problem
1162             print_error("unknownparamtype", '', '', $type);
1163     }
1166 /**
1167  * Makes sure the data is using valid utf8, invalid characters are discarded.
1168  *
1169  * Note: this function is not intended for full objects with methods and private properties.
1170  *
1171  * @param mixed $value
1172  * @return mixed with proper utf-8 encoding
1173  */
1174 function fix_utf8($value) {
1175     if (is_null($value) or $value === '') {
1176         return $value;
1178     } else if (is_string($value)) {
1179         if ((string)(int)$value === $value) {
1180             // shortcut
1181             return $value;
1182         }
1184         // Lower error reporting because glibc throws bogus notices.
1185         $olderror = error_reporting();
1186         if ($olderror & E_NOTICE) {
1187             error_reporting($olderror ^ E_NOTICE);
1188         }
1190         // Note: this duplicates min_fix_utf8() intentionally.
1191         static $buggyiconv = null;
1192         if ($buggyiconv === null) {
1193             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1194         }
1196         if ($buggyiconv) {
1197             if (function_exists('mb_convert_encoding')) {
1198                 $subst = mb_substitute_character();
1199                 mb_substitute_character('');
1200                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1201                 mb_substitute_character($subst);
1203             } else {
1204                 // Warn admins on admin/index.php page.
1205                 $result = $value;
1206             }
1208         } else {
1209             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1210         }
1212         if ($olderror & E_NOTICE) {
1213             error_reporting($olderror);
1214         }
1216         return $result;
1218     } else if (is_array($value)) {
1219         foreach ($value as $k=>$v) {
1220             $value[$k] = fix_utf8($v);
1221         }
1222         return $value;
1224     } else if (is_object($value)) {
1225         $value = clone($value); // do not modify original
1226         foreach ($value as $k=>$v) {
1227             $value->$k = fix_utf8($v);
1228         }
1229         return $value;
1231     } else {
1232         // this is some other type, no utf-8 here
1233         return $value;
1234     }
1237 /**
1238  * Return true if given value is integer or string with integer value
1239  *
1240  * @param mixed $value String or Int
1241  * @return bool true if number, false if not
1242  */
1243 function is_number($value) {
1244     if (is_int($value)) {
1245         return true;
1246     } else if (is_string($value)) {
1247         return ((string)(int)$value) === $value;
1248     } else {
1249         return false;
1250     }
1253 /**
1254  * Returns host part from url
1255  * @param string $url full url
1256  * @return string host, null if not found
1257  */
1258 function get_host_from_url($url) {
1259     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1260     if ($matches) {
1261         return $matches[1];
1262     }
1263     return null;
1266 /**
1267  * Tests whether anything was returned by text editor
1268  *
1269  * This function is useful for testing whether something you got back from
1270  * the HTML editor actually contains anything. Sometimes the HTML editor
1271  * appear to be empty, but actually you get back a <br> tag or something.
1272  *
1273  * @param string $string a string containing HTML.
1274  * @return boolean does the string contain any actual content - that is text,
1275  * images, objects, etc.
1276  */
1277 function html_is_blank($string) {
1278     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1281 /**
1282  * Set a key in global configuration
1283  *
1284  * Set a key/value pair in both this session's {@link $CFG} global variable
1285  * and in the 'config' database table for future sessions.
1286  *
1287  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1288  * In that case it doesn't affect $CFG.
1289  *
1290  * A NULL value will delete the entry.
1291  *
1292  * @global object
1293  * @global object
1294  * @param string $name the key to set
1295  * @param string $value the value to set (without magic quotes)
1296  * @param string $plugin (optional) the plugin scope, default NULL
1297  * @return bool true or exception
1298  */
1299 function set_config($name, $value, $plugin=NULL) {
1300     global $CFG, $DB;
1302     if (empty($plugin)) {
1303         if (!array_key_exists($name, $CFG->config_php_settings)) {
1304             // So it's defined for this invocation at least
1305             if (is_null($value)) {
1306                 unset($CFG->$name);
1307             } else {
1308                 $CFG->$name = (string)$value; // settings from db are always strings
1309             }
1310         }
1312         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1313             if ($value === null) {
1314                 $DB->delete_records('config', array('name'=>$name));
1315             } else {
1316                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1317             }
1318         } else {
1319             if ($value !== null) {
1320                 $config = new stdClass();
1321                 $config->name  = $name;
1322                 $config->value = $value;
1323                 $DB->insert_record('config', $config, false);
1324             }
1325         }
1326         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1327     } else { // plugin scope
1328         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1329             if ($value===null) {
1330                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1331             } else {
1332                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1333             }
1334         } else {
1335             if ($value !== null) {
1336                 $config = new stdClass();
1337                 $config->plugin = $plugin;
1338                 $config->name   = $name;
1339                 $config->value  = $value;
1340                 $DB->insert_record('config_plugins', $config, false);
1341             }
1342         }
1343         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1344     }
1346     return true;
1349 /**
1350  * Get configuration values from the global config table
1351  * or the config_plugins table.
1352  *
1353  * If called with one parameter, it will load all the config
1354  * variables for one plugin, and return them as an object.
1355  *
1356  * If called with 2 parameters it will return a string single
1357  * value or false if the value is not found.
1358  *
1359  * @param string $plugin full component name
1360  * @param string $name default NULL
1361  * @return mixed hash-like object or single value, return false no config found
1362  */
1363 function get_config($plugin, $name = NULL) {
1364     global $CFG, $DB;
1366     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1367         $forced =& $CFG->config_php_settings;
1368         $iscore = true;
1369         $plugin = 'core';
1370     } else {
1371         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1372             $forced =& $CFG->forced_plugin_settings[$plugin];
1373         } else {
1374             $forced = array();
1375         }
1376         $iscore = false;
1377     }
1379     if (!empty($name) && array_key_exists($name, $forced)) {
1380         return (string)$forced[$name];
1381     }
1383     $cache = cache::make('core', 'config');
1384     $result = $cache->get($plugin);
1385     if (!$result) {
1386         // the user is after a recordset
1387         $result = new stdClass;
1388         if (!$iscore) {
1389             $result = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1390         } else {
1391             // this part is not really used any more, but anyway...
1392             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1393         }
1394         $cache->set($plugin, $result);
1395     }
1397     if (!empty($name)) {
1398         if (array_key_exists($name, $result)) {
1399             return $result[$name];
1400         }
1401         return false;
1402     }
1404     foreach ($forced as $key => $value) {
1405         if (is_null($value) or is_array($value) or is_object($value)) {
1406             // we do not want any extra mess here, just real settings that could be saved in db
1407             unset($result[$key]);
1408         } else {
1409             //convert to string as if it went through the DB
1410             $result[$key] = (string)$value;
1411         }
1412     }
1414     return (object)$result;
1417 /**
1418  * Removes a key from global configuration
1419  *
1420  * @param string $name the key to set
1421  * @param string $plugin (optional) the plugin scope
1422  * @global object
1423  * @return boolean whether the operation succeeded.
1424  */
1425 function unset_config($name, $plugin=NULL) {
1426     global $CFG, $DB;
1428     if (empty($plugin)) {
1429         unset($CFG->$name);
1430         $DB->delete_records('config', array('name'=>$name));
1431         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1432     } else {
1433         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1434         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1435     }
1437     return true;
1440 /**
1441  * Remove all the config variables for a given plugin.
1442  *
1443  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1444  * @return boolean whether the operation succeeded.
1445  */
1446 function unset_all_config_for_plugin($plugin) {
1447     global $DB;
1448     // Delete from the obvious config_plugins first
1449     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1450     // Next delete any suspect settings from config
1451     $like = $DB->sql_like('name', '?', true, true, false, '|');
1452     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1453     $DB->delete_records_select('config', $like, $params);
1454     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1455     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1457     return true;
1460 /**
1461  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1462  *
1463  * All users are verified if they still have the necessary capability.
1464  *
1465  * @param string $value the value of the config setting.
1466  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1467  * @param bool $include admins, include administrators
1468  * @return array of user objects.
1469  */
1470 function get_users_from_config($value, $capability, $includeadmins = true) {
1471     global $CFG, $DB;
1473     if (empty($value) or $value === '$@NONE@$') {
1474         return array();
1475     }
1477     // we have to make sure that users still have the necessary capability,
1478     // it should be faster to fetch them all first and then test if they are present
1479     // instead of validating them one-by-one
1480     $users = get_users_by_capability(context_system::instance(), $capability);
1481     if ($includeadmins) {
1482         $admins = get_admins();
1483         foreach ($admins as $admin) {
1484             $users[$admin->id] = $admin;
1485         }
1486     }
1488     if ($value === '$@ALL@$') {
1489         return $users;
1490     }
1492     $result = array(); // result in correct order
1493     $allowed = explode(',', $value);
1494     foreach ($allowed as $uid) {
1495         if (isset($users[$uid])) {
1496             $user = $users[$uid];
1497             $result[$user->id] = $user;
1498         }
1499     }
1501     return $result;
1505 /**
1506  * Invalidates browser caches and cached data in temp
1507  *
1508  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1509  * {@see phpunit_util::reset_dataroot()}
1510  *
1511  * @return void
1512  */
1513 function purge_all_caches() {
1514     global $CFG;
1516     reset_text_filters_cache();
1517     js_reset_all_caches();
1518     theme_reset_all_caches();
1519     get_string_manager()->reset_caches();
1520     textlib::reset_caches();
1522     cache_helper::purge_all();
1524     // purge all other caches: rss, simplepie, etc.
1525     remove_dir($CFG->cachedir.'', true);
1527     // make sure cache dir is writable, throws exception if not
1528     make_cache_directory('');
1530     // hack: this script may get called after the purifier was initialised,
1531     // but we do not want to verify repeatedly this exists in each call
1532     make_cache_directory('htmlpurifier');
1535 /**
1536  * Get volatile flags
1537  *
1538  * @param string $type
1539  * @param int    $changedsince default null
1540  * @return records array
1541  */
1542 function get_cache_flags($type, $changedsince=NULL) {
1543     global $DB;
1545     $params = array('type'=>$type, 'expiry'=>time());
1546     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1547     if ($changedsince !== NULL) {
1548         $params['changedsince'] = $changedsince;
1549         $sqlwhere .= " AND timemodified > :changedsince";
1550     }
1551     $cf = array();
1553     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1554         foreach ($flags as $flag) {
1555             $cf[$flag->name] = $flag->value;
1556         }
1557     }
1558     return $cf;
1561 /**
1562  * Get volatile flags
1563  *
1564  * @param string $type
1565  * @param string $name
1566  * @param int    $changedsince default null
1567  * @return records array
1568  */
1569 function get_cache_flag($type, $name, $changedsince=NULL) {
1570     global $DB;
1572     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1574     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1575     if ($changedsince !== NULL) {
1576         $params['changedsince'] = $changedsince;
1577         $sqlwhere .= " AND timemodified > :changedsince";
1578     }
1580     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1583 /**
1584  * Set a volatile flag
1585  *
1586  * @param string $type the "type" namespace for the key
1587  * @param string $name the key to set
1588  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1589  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1590  * @return bool Always returns true
1591  */
1592 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1593     global $DB;
1595     $timemodified = time();
1596     if ($expiry===NULL || $expiry < $timemodified) {
1597         $expiry = $timemodified + 24 * 60 * 60;
1598     } else {
1599         $expiry = (int)$expiry;
1600     }
1602     if ($value === NULL) {
1603         unset_cache_flag($type,$name);
1604         return true;
1605     }
1607     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1608         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1609             return true; //no need to update
1610         }
1611         $f->value        = $value;
1612         $f->expiry       = $expiry;
1613         $f->timemodified = $timemodified;
1614         $DB->update_record('cache_flags', $f);
1615     } else {
1616         $f = new stdClass();
1617         $f->flagtype     = $type;
1618         $f->name         = $name;
1619         $f->value        = $value;
1620         $f->expiry       = $expiry;
1621         $f->timemodified = $timemodified;
1622         $DB->insert_record('cache_flags', $f);
1623     }
1624     return true;
1627 /**
1628  * Removes a single volatile flag
1629  *
1630  * @global object
1631  * @param string $type the "type" namespace for the key
1632  * @param string $name the key to set
1633  * @return bool
1634  */
1635 function unset_cache_flag($type, $name) {
1636     global $DB;
1637     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1638     return true;
1641 /**
1642  * Garbage-collect volatile flags
1643  *
1644  * @return bool Always returns true
1645  */
1646 function gc_cache_flags() {
1647     global $DB;
1648     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1649     return true;
1652 // USER PREFERENCE API
1654 /**
1655  * Refresh user preference cache. This is used most often for $USER
1656  * object that is stored in session, but it also helps with performance in cron script.
1657  *
1658  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1659  *
1660  * @package  core
1661  * @category preference
1662  * @access   public
1663  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1664  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1665  * @throws   coding_exception
1666  * @return   null
1667  */
1668 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1669     global $DB;
1670     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1672     if (!isset($user->id)) {
1673         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1674     }
1676     if (empty($user->id) or isguestuser($user->id)) {
1677         // No permanent storage for not-logged-in users and guest
1678         if (!isset($user->preference)) {
1679             $user->preference = array();
1680         }
1681         return;
1682     }
1684     $timenow = time();
1686     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1687         // Already loaded at least once on this page. Are we up to date?
1688         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1689             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1690             return;
1692         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1693             // no change since the lastcheck on this page
1694             $user->preference['_lastloaded'] = $timenow;
1695             return;
1696         }
1697     }
1699     // OK, so we have to reload all preferences
1700     $loadedusers[$user->id] = true;
1701     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1702     $user->preference['_lastloaded'] = $timenow;
1705 /**
1706  * Called from set/unset_user_preferences, so that the prefs can
1707  * be correctly reloaded in different sessions.
1708  *
1709  * NOTE: internal function, do not call from other code.
1710  *
1711  * @package core
1712  * @access  private
1713  * @param   integer         $userid the user whose prefs were changed.
1714  */
1715 function mark_user_preferences_changed($userid) {
1716     global $CFG;
1718     if (empty($userid) or isguestuser($userid)) {
1719         // no cache flags for guest and not-logged-in users
1720         return;
1721     }
1723     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1726 /**
1727  * Sets a preference for the specified user.
1728  *
1729  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1730  *
1731  * @package  core
1732  * @category preference
1733  * @access   public
1734  * @param    string            $name  The key to set as preference for the specified user
1735  * @param    string            $value The value to set for the $name key in the specified user's
1736  *                                    record, null means delete current value.
1737  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1738  * @throws   coding_exception
1739  * @return   bool                     Always true or exception
1740  */
1741 function set_user_preference($name, $value, $user = null) {
1742     global $USER, $DB;
1744     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1745         throw new coding_exception('Invalid preference name in set_user_preference() call');
1746     }
1748     if (is_null($value)) {
1749         // null means delete current
1750         return unset_user_preference($name, $user);
1751     } else if (is_object($value)) {
1752         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1753     } else if (is_array($value)) {
1754         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1755     }
1756     $value = (string)$value;
1757     if (textlib::strlen($value) > 1333) { //value column maximum length is 1333 characters
1758         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1759     }
1761     if (is_null($user)) {
1762         $user = $USER;
1763     } else if (isset($user->id)) {
1764         // $user is valid object
1765     } else if (is_numeric($user)) {
1766         $user = (object)array('id'=>(int)$user);
1767     } else {
1768         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1769     }
1771     check_user_preferences_loaded($user);
1773     if (empty($user->id) or isguestuser($user->id)) {
1774         // no permanent storage for not-logged-in users and guest
1775         $user->preference[$name] = $value;
1776         return true;
1777     }
1779     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1780         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1781             // preference already set to this value
1782             return true;
1783         }
1784         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1786     } else {
1787         $preference = new stdClass();
1788         $preference->userid = $user->id;
1789         $preference->name   = $name;
1790         $preference->value  = $value;
1791         $DB->insert_record('user_preferences', $preference);
1792     }
1794     // update value in cache
1795     $user->preference[$name] = $value;
1797     // set reload flag for other sessions
1798     mark_user_preferences_changed($user->id);
1800     return true;
1803 /**
1804  * Sets a whole array of preferences for the current user
1805  *
1806  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1807  *
1808  * @package  core
1809  * @category preference
1810  * @access   public
1811  * @param    array             $prefarray An array of key/value pairs to be set
1812  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1813  * @return   bool                         Always true or exception
1814  */
1815 function set_user_preferences(array $prefarray, $user = null) {
1816     foreach ($prefarray as $name => $value) {
1817         set_user_preference($name, $value, $user);
1818     }
1819     return true;
1822 /**
1823  * Unsets a preference completely by deleting it from the database
1824  *
1825  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1826  *
1827  * @package  core
1828  * @category preference
1829  * @access   public
1830  * @param    string            $name The key to unset as preference for the specified user
1831  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1832  * @throws   coding_exception
1833  * @return   bool                    Always true or exception
1834  */
1835 function unset_user_preference($name, $user = null) {
1836     global $USER, $DB;
1838     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1839         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1840     }
1842     if (is_null($user)) {
1843         $user = $USER;
1844     } else if (isset($user->id)) {
1845         // $user is valid object
1846     } else if (is_numeric($user)) {
1847         $user = (object)array('id'=>(int)$user);
1848     } else {
1849         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1850     }
1852     check_user_preferences_loaded($user);
1854     if (empty($user->id) or isguestuser($user->id)) {
1855         // no permanent storage for not-logged-in user and guest
1856         unset($user->preference[$name]);
1857         return true;
1858     }
1860     // delete from DB
1861     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1863     // delete the preference from cache
1864     unset($user->preference[$name]);
1866     // set reload flag for other sessions
1867     mark_user_preferences_changed($user->id);
1869     return true;
1872 /**
1873  * Used to fetch user preference(s)
1874  *
1875  * If no arguments are supplied this function will return
1876  * all of the current user preferences as an array.
1877  *
1878  * If a name is specified then this function
1879  * attempts to return that particular preference value.  If
1880  * none is found, then the optional value $default is returned,
1881  * otherwise NULL.
1882  *
1883  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1884  *
1885  * @package  core
1886  * @category preference
1887  * @access   public
1888  * @param    string            $name    Name of the key to use in finding a preference value
1889  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1890  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1891  * @throws   coding_exception
1892  * @return   string|mixed|null          A string containing the value of a single preference. An
1893  *                                      array with all of the preferences or null
1894  */
1895 function get_user_preferences($name = null, $default = null, $user = null) {
1896     global $USER;
1898     if (is_null($name)) {
1899         // all prefs
1900     } else if (is_numeric($name) or $name === '_lastloaded') {
1901         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1902     }
1904     if (is_null($user)) {
1905         $user = $USER;
1906     } else if (isset($user->id)) {
1907         // $user is valid object
1908     } else if (is_numeric($user)) {
1909         $user = (object)array('id'=>(int)$user);
1910     } else {
1911         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1912     }
1914     check_user_preferences_loaded($user);
1916     if (empty($name)) {
1917         return $user->preference; // All values
1918     } else if (isset($user->preference[$name])) {
1919         return $user->preference[$name]; // The single string value
1920     } else {
1921         return $default; // Default value (null if not specified)
1922     }
1925 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1927 /**
1928  * Given date parts in user time produce a GMT timestamp.
1929  *
1930  * @package core
1931  * @category time
1932  * @param int $year The year part to create timestamp of
1933  * @param int $month The month part to create timestamp of
1934  * @param int $day The day part to create timestamp of
1935  * @param int $hour The hour part to create timestamp of
1936  * @param int $minute The minute part to create timestamp of
1937  * @param int $second The second part to create timestamp of
1938  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
1939  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
1940  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1941  *             applied only if timezone is 99 or string.
1942  * @return int GMT timestamp
1943  */
1944 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1946     //save input timezone, required for dst offset check.
1947     $passedtimezone = $timezone;
1949     $timezone = get_user_timezone_offset($timezone);
1951     if (abs($timezone) > 13) {  //server time
1952         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1953     } else {
1954         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1955         $time = usertime($time, $timezone);
1957         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1958         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1959             $time -= dst_offset_on($time, $passedtimezone);
1960         }
1961     }
1963     return $time;
1967 /**
1968  * Format a date/time (seconds) as weeks, days, hours etc as needed
1969  *
1970  * Given an amount of time in seconds, returns string
1971  * formatted nicely as weeks, days, hours etc as needed
1972  *
1973  * @package core
1974  * @category time
1975  * @uses MINSECS
1976  * @uses HOURSECS
1977  * @uses DAYSECS
1978  * @uses YEARSECS
1979  * @param int $totalsecs Time in seconds
1980  * @param object $str Should be a time object
1981  * @return string A nicely formatted date/time string
1982  */
1983  function format_time($totalsecs, $str=NULL) {
1985     $totalsecs = abs($totalsecs);
1987     if (!$str) {  // Create the str structure the slow way
1988         $str = new stdClass();
1989         $str->day   = get_string('day');
1990         $str->days  = get_string('days');
1991         $str->hour  = get_string('hour');
1992         $str->hours = get_string('hours');
1993         $str->min   = get_string('min');
1994         $str->mins  = get_string('mins');
1995         $str->sec   = get_string('sec');
1996         $str->secs  = get_string('secs');
1997         $str->year  = get_string('year');
1998         $str->years = get_string('years');
1999     }
2002     $years     = floor($totalsecs/YEARSECS);
2003     $remainder = $totalsecs - ($years*YEARSECS);
2004     $days      = floor($remainder/DAYSECS);
2005     $remainder = $totalsecs - ($days*DAYSECS);
2006     $hours     = floor($remainder/HOURSECS);
2007     $remainder = $remainder - ($hours*HOURSECS);
2008     $mins      = floor($remainder/MINSECS);
2009     $secs      = $remainder - ($mins*MINSECS);
2011     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2012     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2013     $sh = ($hours == 1) ? $str->hour : $str->hours;
2014     $sd = ($days == 1)  ? $str->day  : $str->days;
2015     $sy = ($years == 1)  ? $str->year  : $str->years;
2017     $oyears = '';
2018     $odays = '';
2019     $ohours = '';
2020     $omins = '';
2021     $osecs = '';
2023     if ($years)  $oyears  = $years .' '. $sy;
2024     if ($days)  $odays  = $days .' '. $sd;
2025     if ($hours) $ohours = $hours .' '. $sh;
2026     if ($mins)  $omins  = $mins .' '. $sm;
2027     if ($secs)  $osecs  = $secs .' '. $ss;
2029     if ($years) return trim($oyears .' '. $odays);
2030     if ($days)  return trim($odays .' '. $ohours);
2031     if ($hours) return trim($ohours .' '. $omins);
2032     if ($mins)  return trim($omins .' '. $osecs);
2033     if ($secs)  return $osecs;
2034     return get_string('now');
2037 /**
2038  * Returns a formatted string that represents a date in user time
2039  *
2040  * Returns a formatted string that represents a date in user time
2041  * <b>WARNING: note that the format is for strftime(), not date().</b>
2042  * Because of a bug in most Windows time libraries, we can't use
2043  * the nicer %e, so we have to use %d which has leading zeroes.
2044  * A lot of the fuss in the function is just getting rid of these leading
2045  * zeroes as efficiently as possible.
2046  *
2047  * If parameter fixday = true (default), then take off leading
2048  * zero from %d, else maintain it.
2049  *
2050  * @package core
2051  * @category time
2052  * @param int $date the timestamp in UTC, as obtained from the database.
2053  * @param string $format strftime format. You should probably get this using
2054  *        get_string('strftime...', 'langconfig');
2055  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
2056  *        not 99 then daylight saving will not be added.
2057  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2058  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2059  *        If false then the leading zero is maintained.
2060  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2061  * @return string the formatted date/time.
2062  */
2063 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2065     global $CFG;
2067     if (empty($format)) {
2068         $format = get_string('strftimedaydatetime', 'langconfig');
2069     }
2071     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
2072         $fixday = false;
2073     } else if ($fixday) {
2074         $formatnoday = str_replace('%d', 'DD', $format);
2075         $fixday = ($formatnoday != $format);
2076         $format = $formatnoday;
2077     }
2079     // Note: This logic about fixing 12-hour time to remove unnecessary leading
2080     // zero is required because on Windows, PHP strftime function does not
2081     // support the correct 'hour without leading zero' parameter (%l).
2082     if (!empty($CFG->nofixhour)) {
2083         // Config.php can force %I not to be fixed.
2084         $fixhour = false;
2085     } else if ($fixhour) {
2086         $formatnohour = str_replace('%I', 'HH', $format);
2087         $fixhour = ($formatnohour != $format);
2088         $format = $formatnohour;
2089     }
2091     //add daylight saving offset for string timezones only, as we can't get dst for
2092     //float values. if timezone is 99 (user default timezone), then try update dst.
2093     if ((99 == $timezone) || !is_numeric($timezone)) {
2094         $date += dst_offset_on($date, $timezone);
2095     }
2097     $timezone = get_user_timezone_offset($timezone);
2099     // If we are running under Windows convert to windows encoding and then back to UTF-8
2100     // (because it's impossible to specify UTF-8 to fetch locale info in Win32)
2102     if (abs($timezone) > 13) {   /// Server time
2103         $datestring = date_format_string($date, $format, $timezone);
2104         if ($fixday) {
2105             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
2106             $datestring = str_replace('DD', $daystring, $datestring);
2107         }
2108         if ($fixhour) {
2109             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
2110             $datestring = str_replace('HH', $hourstring, $datestring);
2111         }
2113     } else {
2114         $date += (int)($timezone * 3600);
2115         $datestring = date_format_string($date, $format, $timezone);
2116         if ($fixday) {
2117             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2118             $datestring = str_replace('DD', $daystring, $datestring);
2119         }
2120         if ($fixhour) {
2121             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2122             $datestring = str_replace('HH', $hourstring, $datestring);
2123         }
2124     }
2126     return $datestring;
2129 /**
2130  * Returns a formatted date ensuring it is UTF-8.
2131  *
2132  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2133  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2134  *
2135  * This function does not do any calculation regarding the user preferences and should
2136  * therefore receive the final date timestamp, format and timezone. Timezone being only used
2137  * to differenciate the use of server time or not (strftime() against gmstrftime()).
2138  *
2139  * @param int $date the timestamp.
2140  * @param string $format strftime format.
2141  * @param int|float $timezone the numerical timezone, typically returned by {@link get_user_timezone_offset()}.
2142  * @return string the formatted date/time.
2143  * @since 2.3.3
2144  */
2145 function date_format_string($date, $format, $tz = 99) {
2146     global $CFG;
2147     if (abs($tz) > 13) {
2148         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2149             $format = textlib::convert($format, 'utf-8', $localewincharset);
2150             $datestring = strftime($format, $date);
2151             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2152         } else {
2153             $datestring = strftime($format, $date);
2154         }
2155     } else {
2156         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2157             $format = textlib::convert($format, 'utf-8', $localewincharset);
2158             $datestring = gmstrftime($format, $date);
2159             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2160         } else {
2161             $datestring = gmstrftime($format, $date);
2162         }
2163     }
2164     return $datestring;
2167 /**
2168  * Given a $time timestamp in GMT (seconds since epoch),
2169  * returns an array that represents the date in user time
2170  *
2171  * @package core
2172  * @category time
2173  * @uses HOURSECS
2174  * @param int $time Timestamp in GMT
2175  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2176  *        dst offset is applyed {@link http://docs.moodle.org/dev/Time_API#Timezone}
2177  * @return array An array that represents the date in user time
2178  */
2179 function usergetdate($time, $timezone=99) {
2181     //save input timezone, required for dst offset check.
2182     $passedtimezone = $timezone;
2184     $timezone = get_user_timezone_offset($timezone);
2186     if (abs($timezone) > 13) {    // Server time
2187         return getdate($time);
2188     }
2190     //add daylight saving offset for string timezones only, as we can't get dst for
2191     //float values. if timezone is 99 (user default timezone), then try update dst.
2192     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2193         $time += dst_offset_on($time, $passedtimezone);
2194     }
2196     $time += intval((float)$timezone * HOURSECS);
2198     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2200     //be careful to ensure the returned array matches that produced by getdate() above
2201     list(
2202         $getdate['month'],
2203         $getdate['weekday'],
2204         $getdate['yday'],
2205         $getdate['year'],
2206         $getdate['mon'],
2207         $getdate['wday'],
2208         $getdate['mday'],
2209         $getdate['hours'],
2210         $getdate['minutes'],
2211         $getdate['seconds']
2212     ) = explode('_', $datestring);
2214     // set correct datatype to match with getdate()
2215     $getdate['seconds'] = (int)$getdate['seconds'];
2216     $getdate['yday'] = (int)$getdate['yday'] - 1; // gettime returns 0 through 365
2217     $getdate['year'] = (int)$getdate['year'];
2218     $getdate['mon'] = (int)$getdate['mon'];
2219     $getdate['wday'] = (int)$getdate['wday'];
2220     $getdate['mday'] = (int)$getdate['mday'];
2221     $getdate['hours'] = (int)$getdate['hours'];
2222     $getdate['minutes']  = (int)$getdate['minutes'];
2223     return $getdate;
2226 /**
2227  * Given a GMT timestamp (seconds since epoch), offsets it by
2228  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2229  *
2230  * @package core
2231  * @category time
2232  * @uses HOURSECS
2233  * @param int $date Timestamp in GMT
2234  * @param float|int|string $timezone timezone to calculate GMT time offset before
2235  *        calculating user time, 99 is default user timezone
2236  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2237  * @return int
2238  */
2239 function usertime($date, $timezone=99) {
2241     $timezone = get_user_timezone_offset($timezone);
2243     if (abs($timezone) > 13) {
2244         return $date;
2245     }
2246     return $date - (int)($timezone * HOURSECS);
2249 /**
2250  * Given a time, return the GMT timestamp of the most recent midnight
2251  * for the current user.
2252  *
2253  * @package core
2254  * @category time
2255  * @param int $date Timestamp in GMT
2256  * @param float|int|string $timezone timezone to calculate GMT time offset before
2257  *        calculating user midnight time, 99 is default user timezone
2258  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2259  * @return int Returns a GMT timestamp
2260  */
2261 function usergetmidnight($date, $timezone=99) {
2263     $userdate = usergetdate($date, $timezone);
2265     // Time of midnight of this user's day, in GMT
2266     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2270 /**
2271  * Returns a string that prints the user's timezone
2272  *
2273  * @package core
2274  * @category time
2275  * @param float|int|string $timezone timezone to calculate GMT time offset before
2276  *        calculating user timezone, 99 is default user timezone
2277  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2278  * @return string
2279  */
2280 function usertimezone($timezone=99) {
2282     $tz = get_user_timezone($timezone);
2284     if (!is_float($tz)) {
2285         return $tz;
2286     }
2288     if(abs($tz) > 13) { // Server time
2289         return get_string('serverlocaltime');
2290     }
2292     if($tz == intval($tz)) {
2293         // Don't show .0 for whole hours
2294         $tz = intval($tz);
2295     }
2297     if($tz == 0) {
2298         return 'UTC';
2299     }
2300     else if($tz > 0) {
2301         return 'UTC+'.$tz;
2302     }
2303     else {
2304         return 'UTC'.$tz;
2305     }
2309 /**
2310  * Returns a float which represents the user's timezone difference from GMT in hours
2311  * Checks various settings and picks the most dominant of those which have a value
2312  *
2313  * @package core
2314  * @category time
2315  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2316  *        99 is default user timezone
2317  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2318  * @return float
2319  */
2320 function get_user_timezone_offset($tz = 99) {
2322     global $USER, $CFG;
2324     $tz = get_user_timezone($tz);
2326     if (is_float($tz)) {
2327         return $tz;
2328     } else {
2329         $tzrecord = get_timezone_record($tz);
2330         if (empty($tzrecord)) {
2331             return 99.0;
2332         }
2333         return (float)$tzrecord->gmtoff / HOURMINS;
2334     }
2337 /**
2338  * Returns an int which represents the systems's timezone difference from GMT in seconds
2339  *
2340  * @package core
2341  * @category time
2342  * @param float|int|string $tz timezone for which offset is required.
2343  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2344  * @return int|bool if found, false is timezone 99 or error
2345  */
2346 function get_timezone_offset($tz) {
2347     global $CFG;
2349     if ($tz == 99) {
2350         return false;
2351     }
2353     if (is_numeric($tz)) {
2354         return intval($tz * 60*60);
2355     }
2357     if (!$tzrecord = get_timezone_record($tz)) {
2358         return false;
2359     }
2360     return intval($tzrecord->gmtoff * 60);
2363 /**
2364  * Returns a float or a string which denotes the user's timezone
2365  * 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)
2366  * means that for this timezone there are also DST rules to be taken into account
2367  * Checks various settings and picks the most dominant of those which have a value
2368  *
2369  * @package core
2370  * @category time
2371  * @param float|int|string $tz timezone to calculate GMT time offset before
2372  *        calculating user timezone, 99 is default user timezone
2373  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2374  * @return float|string
2375  */
2376 function get_user_timezone($tz = 99) {
2377     global $USER, $CFG;
2379     $timezones = array(
2380         $tz,
2381         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2382         isset($USER->timezone) ? $USER->timezone : 99,
2383         isset($CFG->timezone) ? $CFG->timezone : 99,
2384         );
2386     $tz = 99;
2388     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array
2389     while(((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2390         $tz = $next['value'];
2391     }
2392     return is_numeric($tz) ? (float) $tz : $tz;
2395 /**
2396  * Returns cached timezone record for given $timezonename
2397  *
2398  * @package core
2399  * @param string $timezonename name of the timezone
2400  * @return stdClass|bool timezonerecord or false
2401  */
2402 function get_timezone_record($timezonename) {
2403     global $CFG, $DB;
2404     static $cache = NULL;
2406     if ($cache === NULL) {
2407         $cache = array();
2408     }
2410     if (isset($cache[$timezonename])) {
2411         return $cache[$timezonename];
2412     }
2414     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2415                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2418 /**
2419  * Build and store the users Daylight Saving Time (DST) table
2420  *
2421  * @package core
2422  * @param int $from_year Start year for the table, defaults to 1971
2423  * @param int $to_year End year for the table, defaults to 2035
2424  * @param int|float|string $strtimezone, timezone to check if dst should be applyed.
2425  * @return bool
2426  */
2427 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2428     global $CFG, $SESSION, $DB;
2430     $usertz = get_user_timezone($strtimezone);
2432     if (is_float($usertz)) {
2433         // Trivial timezone, no DST
2434         return false;
2435     }
2437     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2438         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2439         unset($SESSION->dst_offsets);
2440         unset($SESSION->dst_range);
2441     }
2443     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2444         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2445         // This will be the return path most of the time, pretty light computationally
2446         return true;
2447     }
2449     // Reaching here means we either need to extend our table or create it from scratch
2451     // Remember which TZ we calculated these changes for
2452     $SESSION->dst_offsettz = $usertz;
2454     if(empty($SESSION->dst_offsets)) {
2455         // If we 're creating from scratch, put the two guard elements in there
2456         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2457     }
2458     if(empty($SESSION->dst_range)) {
2459         // If creating from scratch
2460         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2461         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2463         // Fill in the array with the extra years we need to process
2464         $yearstoprocess = array();
2465         for($i = $from; $i <= $to; ++$i) {
2466             $yearstoprocess[] = $i;
2467         }
2469         // Take note of which years we have processed for future calls
2470         $SESSION->dst_range = array($from, $to);
2471     }
2472     else {
2473         // If needing to extend the table, do the same
2474         $yearstoprocess = array();
2476         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2477         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2479         if($from < $SESSION->dst_range[0]) {
2480             // Take note of which years we need to process and then note that we have processed them for future calls
2481             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2482                 $yearstoprocess[] = $i;
2483             }
2484             $SESSION->dst_range[0] = $from;
2485         }
2486         if($to > $SESSION->dst_range[1]) {
2487             // Take note of which years we need to process and then note that we have processed them for future calls
2488             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2489                 $yearstoprocess[] = $i;
2490             }
2491             $SESSION->dst_range[1] = $to;
2492         }
2493     }
2495     if(empty($yearstoprocess)) {
2496         // This means that there was a call requesting a SMALLER range than we have already calculated
2497         return true;
2498     }
2500     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2501     // Also, the array is sorted in descending timestamp order!
2503     // Get DB data
2505     static $presets_cache = array();
2506     if (!isset($presets_cache[$usertz])) {
2507         $presets_cache[$usertz] = $DB->get_records('timezone', array('name'=>$usertz), 'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, std_startday, std_weekday, std_skipweeks, std_time');
2508     }
2509     if(empty($presets_cache[$usertz])) {
2510         return false;
2511     }
2513     // Remove ending guard (first element of the array)
2514     reset($SESSION->dst_offsets);
2515     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2517     // Add all required change timestamps
2518     foreach($yearstoprocess as $y) {
2519         // Find the record which is in effect for the year $y
2520         foreach($presets_cache[$usertz] as $year => $preset) {
2521             if($year <= $y) {
2522                 break;
2523             }
2524         }
2526         $changes = dst_changes_for_year($y, $preset);
2528         if($changes === NULL) {
2529             continue;
2530         }
2531         if($changes['dst'] != 0) {
2532             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2533         }
2534         if($changes['std'] != 0) {
2535             $SESSION->dst_offsets[$changes['std']] = 0;
2536         }
2537     }
2539     // Put in a guard element at the top
2540     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2541     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2543     // Sort again
2544     krsort($SESSION->dst_offsets);
2546     return true;
2549 /**
2550  * Calculates the required DST change and returns a Timestamp Array
2551  *
2552  * @package core
2553  * @category time
2554  * @uses HOURSECS
2555  * @uses MINSECS
2556  * @param int|string $year Int or String Year to focus on
2557  * @param object $timezone Instatiated Timezone object
2558  * @return array|null Array dst=>xx, 0=>xx, std=>yy, 1=>yy or NULL
2559  */
2560 function dst_changes_for_year($year, $timezone) {
2562     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2563         return NULL;
2564     }
2566     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2567     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2569     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2570     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2572     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2573     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2575     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2576     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2577     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2579     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2580     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2582     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2585 /**
2586  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2587  * - Note: Daylight saving only works for string timezones and not for float.
2588  *
2589  * @package core
2590  * @category time
2591  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2592  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2593  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2594  * @return int
2595  */
2596 function dst_offset_on($time, $strtimezone = NULL) {
2597     global $SESSION;
2599     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2600         return 0;
2601     }
2603     reset($SESSION->dst_offsets);
2604     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2605         if($from <= $time) {
2606             break;
2607         }
2608     }
2610     // This is the normal return path
2611     if($offset !== NULL) {
2612         return $offset;
2613     }
2615     // Reaching this point means we haven't calculated far enough, do it now:
2616     // Calculate extra DST changes if needed and recurse. The recursion always
2617     // moves toward the stopping condition, so will always end.
2619     if($from == 0) {
2620         // We need a year smaller than $SESSION->dst_range[0]
2621         if($SESSION->dst_range[0] == 1971) {
2622             return 0;
2623         }
2624         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2625         return dst_offset_on($time, $strtimezone);
2626     }
2627     else {
2628         // We need a year larger than $SESSION->dst_range[1]
2629         if($SESSION->dst_range[1] == 2035) {
2630             return 0;
2631         }
2632         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2633         return dst_offset_on($time, $strtimezone);
2634     }
2637 /**
2638  * Calculates when the day appears in specific month
2639  *
2640  * @package core
2641  * @category time
2642  * @param int $startday starting day of the month
2643  * @param int $weekday The day when week starts (normally taken from user preferences)
2644  * @param int $month The month whose day is sought
2645  * @param int $year The year of the month whose day is sought
2646  * @return int
2647  */
2648 function find_day_in_month($startday, $weekday, $month, $year) {
2650     $daysinmonth = days_in_month($month, $year);
2652     if($weekday == -1) {
2653         // Don't care about weekday, so return:
2654         //    abs($startday) if $startday != -1
2655         //    $daysinmonth otherwise
2656         return ($startday == -1) ? $daysinmonth : abs($startday);
2657     }
2659     // From now on we 're looking for a specific weekday
2661     // Give "end of month" its actual value, since we know it
2662     if($startday == -1) {
2663         $startday = -1 * $daysinmonth;
2664     }
2666     // Starting from day $startday, the sign is the direction
2668     if($startday < 1) {
2670         $startday = abs($startday);
2671         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2673         // This is the last such weekday of the month
2674         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2675         if($lastinmonth > $daysinmonth) {
2676             $lastinmonth -= 7;
2677         }
2679         // Find the first such weekday <= $startday
2680         while($lastinmonth > $startday) {
2681             $lastinmonth -= 7;
2682         }
2684         return $lastinmonth;
2686     }
2687     else {
2689         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2691         $diff = $weekday - $indexweekday;
2692         if($diff < 0) {
2693             $diff += 7;
2694         }
2696         // This is the first such weekday of the month equal to or after $startday
2697         $firstfromindex = $startday + $diff;
2699         return $firstfromindex;
2701     }
2704 /**
2705  * Calculate the number of days in a given month
2706  *
2707  * @package core
2708  * @category time
2709  * @param int $month The month whose day count is sought
2710  * @param int $year The year of the month whose day count is sought
2711  * @return int
2712  */
2713 function days_in_month($month, $year) {
2714    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2717 /**
2718  * Calculate the position in the week of a specific calendar day
2719  *
2720  * @package core
2721  * @category time
2722  * @param int $day The day of the date whose position in the week is sought
2723  * @param int $month The month of the date whose position in the week is sought
2724  * @param int $year The year of the date whose position in the week is sought
2725  * @return int
2726  */
2727 function dayofweek($day, $month, $year) {
2728     // I wonder if this is any different from
2729     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2730     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2733 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2735 /**
2736  * Returns full login url.
2737  *
2738  * @return string login url
2739  */
2740 function get_login_url() {
2741     global $CFG;
2743     $url = "$CFG->wwwroot/login/index.php";
2745     if (!empty($CFG->loginhttps)) {
2746         $url = str_replace('http:', 'https:', $url);
2747     }
2749     return $url;
2752 /**
2753  * This function checks that the current user is logged in and has the
2754  * required privileges
2755  *
2756  * This function checks that the current user is logged in, and optionally
2757  * whether they are allowed to be in a particular course and view a particular
2758  * course module.
2759  * If they are not logged in, then it redirects them to the site login unless
2760  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2761  * case they are automatically logged in as guests.
2762  * If $courseid is given and the user is not enrolled in that course then the
2763  * user is redirected to the course enrolment page.
2764  * If $cm is given and the course module is hidden and the user is not a teacher
2765  * in the course then the user is redirected to the course home page.
2766  *
2767  * When $cm parameter specified, this function sets page layout to 'module'.
2768  * You need to change it manually later if some other layout needed.
2769  *
2770  * @package    core_access
2771  * @category   access
2772  *
2773  * @param mixed $courseorid id of the course or course object
2774  * @param bool $autologinguest default true
2775  * @param object $cm course module object
2776  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2777  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2778  *             in order to keep redirects working properly. MDL-14495
2779  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2780  * @return mixed Void, exit, and die depending on path
2781  */
2782 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2783     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2785     // setup global $COURSE, themes, language and locale
2786     if (!empty($courseorid)) {
2787         if (is_object($courseorid)) {
2788             $course = $courseorid;
2789         } else if ($courseorid == SITEID) {
2790             $course = clone($SITE);
2791         } else {
2792             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2793         }
2794         if ($cm) {
2795             if ($cm->course != $course->id) {
2796                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2797             }
2798             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2799             if (!($cm instanceof cm_info)) {
2800                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2801                 // db queries so this is not really a performance concern, however it is obviously
2802                 // better if you use get_fast_modinfo to get the cm before calling this.
2803                 $modinfo = get_fast_modinfo($course);
2804                 $cm = $modinfo->get_cm($cm->id);
2805             }
2806             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2807             $PAGE->set_pagelayout('incourse');
2808         } else {
2809             $PAGE->set_course($course); // set's up global $COURSE
2810         }
2811     } else {
2812         // do not touch global $COURSE via $PAGE->set_course(),
2813         // the reasons is we need to be able to call require_login() at any time!!
2814         $course = $SITE;
2815         if ($cm) {
2816             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2817         }
2818     }
2820     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2821     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2822     // risk leading the user back to the AJAX request URL.
2823     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2824         $setwantsurltome = false;
2825     }
2827     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2828     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2829         if ($setwantsurltome) {
2830             $SESSION->wantsurl = qualified_me();
2831         }
2832         redirect(get_login_url());
2833     }
2835     // If the user is not even logged in yet then make sure they are
2836     if (!isloggedin()) {
2837         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2838             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2839                 // misconfigured site guest, just redirect to login page
2840                 redirect(get_login_url());
2841                 exit; // never reached
2842             }
2843             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2844             complete_user_login($guest);
2845             $USER->autologinguest = true;
2846             $SESSION->lang = $lang;
2847         } else {
2848             //NOTE: $USER->site check was obsoleted by session test cookie,
2849             //      $USER->confirmed test is in login/index.php
2850             if ($preventredirect) {
2851                 throw new require_login_exception('You are not logged in');
2852             }
2854             if ($setwantsurltome) {
2855                 $SESSION->wantsurl = qualified_me();
2856             }
2857             if (!empty($_SERVER['HTTP_REFERER'])) {
2858                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2859             }
2860             redirect(get_login_url());
2861             exit; // never reached
2862         }
2863     }
2865     // loginas as redirection if needed
2866     if ($course->id != SITEID and session_is_loggedinas()) {
2867         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2868             if ($USER->loginascontext->instanceid != $course->id) {
2869                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2870             }
2871         }
2872     }
2874     // check whether the user should be changing password (but only if it is REALLY them)
2875     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2876         $userauth = get_auth_plugin($USER->auth);
2877         if ($userauth->can_change_password() and !$preventredirect) {
2878             if ($setwantsurltome) {
2879                 $SESSION->wantsurl = qualified_me();
2880             }
2881             if ($changeurl = $userauth->change_password_url()) {
2882                 //use plugin custom url
2883                 redirect($changeurl);
2884             } else {
2885                 //use moodle internal method
2886                 if (empty($CFG->loginhttps)) {
2887                     redirect($CFG->wwwroot .'/login/change_password.php');
2888                 } else {
2889                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2890                     redirect($wwwroot .'/login/change_password.php');
2891                 }
2892             }
2893         } else {
2894             print_error('nopasswordchangeforced', 'auth');
2895         }
2896     }
2898     // Check that the user account is properly set up
2899     if (user_not_fully_set_up($USER)) {
2900         if ($preventredirect) {
2901             throw new require_login_exception('User not fully set-up');
2902         }
2903         if ($setwantsurltome) {
2904             $SESSION->wantsurl = qualified_me();
2905         }
2906         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2907     }
2909     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2910     sesskey();
2912     // Do not bother admins with any formalities
2913     if (is_siteadmin()) {
2914         //set accesstime or the user will appear offline which messes up messaging
2915         user_accesstime_log($course->id);
2916         return;
2917     }
2919     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2920     if (!$USER->policyagreed and !is_siteadmin()) {
2921         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2922             if ($preventredirect) {
2923                 throw new require_login_exception('Policy not agreed');
2924             }
2925             if ($setwantsurltome) {
2926                 $SESSION->wantsurl = qualified_me();
2927             }
2928             redirect($CFG->wwwroot .'/user/policy.php');
2929         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2930             if ($preventredirect) {
2931                 throw new require_login_exception('Policy not agreed');
2932             }
2933             if ($setwantsurltome) {
2934                 $SESSION->wantsurl = qualified_me();
2935             }
2936             redirect($CFG->wwwroot .'/user/policy.php');
2937         }
2938     }
2940     // Fetch the system context, the course context, and prefetch its child contexts
2941     $sysctx = context_system::instance();
2942     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2943     if ($cm) {
2944         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2945     } else {
2946         $cmcontext = null;
2947     }
2949     // If the site is currently under maintenance, then print a message
2950     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2951         if ($preventredirect) {
2952             throw new require_login_exception('Maintenance in progress');
2953         }
2955         print_maintenance_message();
2956     }
2958     // make sure the course itself is not hidden
2959     if ($course->id == SITEID) {
2960         // frontpage can not be hidden
2961     } else {
2962         if (is_role_switched($course->id)) {
2963             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2964         } else {
2965             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2966                 // originally there was also test of parent category visibility,
2967                 // BUT is was very slow in complex queries involving "my courses"
2968                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2969                 if ($preventredirect) {
2970                     throw new require_login_exception('Course is hidden');
2971                 }
2972                 // We need to override the navigation URL as the course won't have
2973                 // been added to the navigation and thus the navigation will mess up
2974                 // when trying to find it.
2975                 navigation_node::override_active_url(new moodle_url('/'));
2976                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2977             }
2978         }
2979     }
2981     // is the user enrolled?
2982     if ($course->id == SITEID) {
2983         // everybody is enrolled on the frontpage
2985     } else {
2986         if (session_is_loggedinas()) {
2987             // Make sure the REAL person can access this course first
2988             $realuser = session_get_realuser();
2989             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2990                 if ($preventredirect) {
2991                     throw new require_login_exception('Invalid course login-as access');
2992                 }
2993                 echo $OUTPUT->header();
2994                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2995             }
2996         }
2998         $access = false;
3000         if (is_role_switched($course->id)) {
3001             // ok, user had to be inside this course before the switch
3002             $access = true;
3004         } else if (is_viewing($coursecontext, $USER)) {
3005             // ok, no need to mess with enrol
3006             $access = true;
3008         } else {
3009             if (isset($USER->enrol['enrolled'][$course->id])) {
3010                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3011                     $access = true;
3012                     if (isset($USER->enrol['tempguest'][$course->id])) {
3013                         unset($USER->enrol['tempguest'][$course->id]);
3014                         remove_temp_course_roles($coursecontext);
3015                     }
3016                 } else {
3017                     //expired
3018                     unset($USER->enrol['enrolled'][$course->id]);
3019                 }
3020             }
3021             if (isset($USER->enrol['tempguest'][$course->id])) {
3022                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3023                     $access = true;
3024                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3025                     $access = true;
3026                 } else {
3027                     //expired
3028                     unset($USER->enrol['tempguest'][$course->id]);
3029                     remove_temp_course_roles($coursecontext);
3030                 }
3031             }
3033             if ($access) {
3034                 // cache ok
3035             } else {
3036                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3037                 if ($until !== false) {
3038                     // active participants may always access, a timestamp in the future, 0 (always) or false.
3039                     if ($until == 0) {
3040                         $until = ENROL_MAX_TIMESTAMP;
3041                     }
3042                     $USER->enrol['enrolled'][$course->id] = $until;
3043                     $access = true;
3045                 } else {
3046                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
3047                     $enrols = enrol_get_plugins(true);
3048                     // first ask all enabled enrol instances in course if they want to auto enrol user
3049                     foreach($instances as $instance) {
3050                         if (!isset($enrols[$instance->enrol])) {
3051                             continue;
3052                         }
3053                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3054                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3055                         if ($until !== false) {
3056                             if ($until == 0) {
3057                                 $until = ENROL_MAX_TIMESTAMP;
3058                             }
3059                             $USER->enrol['enrolled'][$course->id] = $until;
3060                             $access = true;
3061                             break;
3062                         }
3063                     }
3064                     // if not enrolled yet try to gain temporary guest access
3065                     if (!$access) {
3066                         foreach($instances as $instance) {
3067                             if (!isset($enrols[$instance->enrol])) {
3068                                 continue;
3069                             }
3070                             // Get a duration for the guest access, a timestamp in the future or false.
3071                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3072                             if ($until !== false and $until > time()) {
3073                                 $USER->enrol['tempguest'][$course->id] = $until;
3074                                 $access = true;
3075                                 break;
3076                             }
3077                         }
3078                     }
3079                 }
3080             }
3081         }
3083         if (!$access) {
3084             if ($preventredirect) {
3085                 throw new require_login_exception('Not enrolled');
3086             }
3087             if ($setwantsurltome) {
3088                 $SESSION->wantsurl = qualified_me();
3089             }
3090             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3091         }
3092     }
3094     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
3095     // conditional availability, etc
3096     if ($cm && !$cm->uservisible) {
3097         if ($preventredirect) {
3098             throw new require_login_exception('Activity is hidden');
3099         }
3100         if ($course->id != SITEID) {
3101             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
3102         } else {
3103             $url = new moodle_url('/');
3104         }
3105         redirect($url, get_string('activityiscurrentlyhidden'));
3106     }
3108     // Finally access granted, update lastaccess times
3109     user_accesstime_log($course->id);
3113 /**
3114  * This function just makes sure a user is logged out.
3115  *
3116  * @package    core_access
3117  */
3118 function require_logout() {
3119     global $USER;
3121     $params = $USER;
3123     if (isloggedin()) {
3124         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
3126         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
3127         foreach($authsequence as $authname) {
3128             $authplugin = get_auth_plugin($authname);
3129             $authplugin->prelogout_hook();
3130         }
3131     }
3133     events_trigger('user_logout', $params);
3134     session_get_instance()->terminate_current();
3135     unset($params);
3138 /**
3139  * Weaker version of require_login()
3140  *
3141  * This is a weaker version of {@link require_login()} which only requires login
3142  * when called from within a course rather than the site page, unless
3143  * the forcelogin option is turned on.
3144  * @see require_login()
3145  *
3146  * @package    core_access
3147  * @category   access
3148  *
3149  * @param mixed $courseorid The course object or id in question
3150  * @param bool $autologinguest Allow autologin guests if that is wanted
3151  * @param object $cm Course activity module if known
3152  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3153  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3154  *             in order to keep redirects working properly. MDL-14495
3155  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3156  * @return void
3157  */
3158 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
3159     global $CFG, $PAGE, $SITE;
3160     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3161           or (!is_object($courseorid) and $courseorid == SITEID);
3162     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3163         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
3164         // db queries so this is not really a performance concern, however it is obviously
3165         // better if you use get_fast_modinfo to get the cm before calling this.
3166         if (is_object($courseorid)) {
3167             $course = $courseorid;
3168         } else {
3169             $course = clone($SITE);
3170         }
3171         $modinfo = get_fast_modinfo($course);
3172         $cm = $modinfo->get_cm($cm->id);
3173     }
3174     if (!empty($CFG->forcelogin)) {
3175         // login required for both SITE and courses
3176         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3178     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3179         // always login for hidden activities
3180         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3182     } else if ($issite) {
3183               //login for SITE not required
3184         if ($cm and empty($cm->visible)) {
3185             // hidden activities are not accessible without login
3186             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3187         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3188             // not-logged-in users do not have any group membership
3189             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3190         } else {
3191             // We still need to instatiate PAGE vars properly so that things
3192             // that rely on it like navigation function correctly.
3193             if (!empty($courseorid)) {
3194                 if (is_object($courseorid)) {
3195                     $course = $courseorid;
3196                 } else {
3197                     $course = clone($SITE);
3198                 }
3199                 if ($cm) {
3200                     if ($cm->course != $course->id) {
3201                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3202                     }
3203                     $PAGE->set_cm($cm, $course);
3204                     $PAGE->set_pagelayout('incourse');
3205                 } else {
3206                     $PAGE->set_course($course);
3207                 }
3208             } else {
3209                 // If $PAGE->course, and hence $PAGE->context, have not already been set
3210                 // up properly, set them up now.
3211                 $PAGE->set_course($PAGE->course);
3212             }
3213             //TODO: verify conditional activities here
3214             user_accesstime_log(SITEID);
3215             return;
3216         }
3218     } else {
3219         // course login always required
3220         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3221     }
3224 /**
3225  * Require key login. Function terminates with error if key not found or incorrect.
3226  *
3227  * @global object
3228  * @global object
3229  * @global object
3230  * @global object
3231  * @uses NO_MOODLE_COOKIES
3232  * @uses PARAM_ALPHANUM
3233  * @param string $script unique script identifier
3234  * @param int $instance optional instance id
3235  * @return int Instance ID
3236  */
3237 function require_user_key_login($script, $instance=null) {
3238     global $USER, $SESSION, $CFG, $DB;
3240     if (!NO_MOODLE_COOKIES) {
3241         print_error('sessioncookiesdisable');
3242     }
3244 /// extra safety
3245     @session_write_close();
3247     $keyvalue = required_param('key', PARAM_ALPHANUM);
3249     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3250         print_error('invalidkey');
3251     }
3253     if (!empty($key->validuntil) and $key->validuntil < time()) {
3254         print_error('expiredkey');
3255     }
3257     if ($key->iprestriction) {
3258         $remoteaddr = getremoteaddr(null);
3259         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3260             print_error('ipmismatch');
3261         }
3262     }
3264     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3265         print_error('invaliduserid');
3266     }
3268 /// emulate normal session
3269     enrol_check_plugins($user);
3270     session_set_user($user);
3272 /// note we are not using normal login
3273     if (!defined('USER_KEY_LOGIN')) {
3274         define('USER_KEY_LOGIN', true);
3275     }
3277 /// return instance id - it might be empty
3278     return $key->instance;
3281 /**
3282  * Creates a new private user access key.
3283  *
3284  * @global object
3285  * @param string $script unique target identifier
3286  * @param int $userid
3287  * @param int $instance optional instance id
3288  * @param string $iprestriction optional ip restricted access
3289  * @param timestamp $validuntil key valid only until given data
3290  * @return string access key value
3291  */
3292 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3293     global $DB;
3295     $key = new stdClass();
3296     $key->script        = $script;
3297     $key->userid        = $userid;
3298     $key->instance      = $instance;
3299     $key->iprestriction = $iprestriction;
3300     $key->validuntil    = $validuntil;
3301     $key->timecreated   = time();
3303     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3304     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3305         // must be unique
3306         $key->value     = md5($userid.'_'.time().random_string(40));
3307     }
3308     $DB->insert_record('user_private_key', $key);
3309     return $key->value;
3312 /**
3313  * Delete the user's new private user access keys for a particular script.
3314  *
3315  * @global object
3316  * @param string $script unique target identifier
3317  * @param int $userid
3318  * @return void
3319  */
3320 function delete_user_key($script,$userid) {
3321     global $DB;
3322     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3325 /**
3326  * Gets a private user access key (and creates one if one doesn't exist).
3327  *
3328  * @global object
3329  * @param string $script unique target identifier
3330  * @param int $userid
3331  * @param int $instance optional instance id
3332  * @param string $iprestriction optional ip restricted access
3333  * @param timestamp $validuntil key valid only until given data
3334  * @return string access key value
3335  */
3336 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3337     global $DB;
3339     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3340                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3341                                                          'validuntil'=>$validuntil))) {
3342         return $key->value;
3343     } else {
3344         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3345     }
3349 /**
3350  * Modify the user table by setting the currently logged in user's
3351  * last login to now.
3352  *
3353  * @global object
3354  * @global object
3355  * @return bool Always returns true
3356  */
3357 function update_user_login_times() {
3358     global $USER, $DB;
3360     if (isguestuser()) {
3361         // Do not update guest access times/ips for performance.
3362         return true;
3363     }
3365     $now = time();
3367     $user = new stdClass();
3368     $user->id = $USER->id;
3370     // Make sure all users that logged in have some firstaccess.
3371     if ($USER->firstaccess == 0) {
3372         $USER->firstaccess = $user->firstaccess = $now;
3373     }
3375     // Store the previous current as lastlogin.
3376     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3378     $USER->currentlogin = $user->currentlogin = $now;
3380     // Function user_accesstime_log() may not update immediately, better do it here.
3381     $USER->lastaccess = $user->lastaccess = $now;
3382     $USER->lastip = $user->lastip = getremoteaddr();
3384     $DB->update_record('user', $user);
3385     return true;
3388 /**
3389  * Determines if a user has completed setting up their account.
3390  *
3391  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3392  * @return bool
3393  */
3394 function user_not_fully_set_up($user) {
3395     if (isguestuser($user)) {
3396         return false;
3397     }
3398     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3401 /**
3402  * Check whether the user has exceeded the bounce threshold
3403  *
3404  * @global object
3405  * @global object
3406  * @param user $user A {@link $USER} object
3407  * @return bool true=>User has exceeded bounce threshold
3408  */
3409 function over_bounce_threshold($user) {
3410     global $CFG, $DB;
3412     if (empty($CFG->handlebounces)) {
3413         return false;
3414     }
3416     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3417         return false;
3418     }
3420     // set sensible defaults
3421     if (empty($CFG->minbounces)) {
3422         $CFG->minbounces = 10;
3423     }
3424     if (empty($CFG->bounceratio)) {
3425         $CFG->bounceratio = .20;
3426     }
3427     $bouncecount = 0;
3428     $sendcount = 0;
3429     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3430         $bouncecount = $bounce->value;
3431     }
3432     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3433         $sendcount = $send->value;
3434     }
3435     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3438 /**
3439  * Used to increment or reset email sent count
3440  *
3441  * @global object
3442  * @param user $user object containing an id
3443  * @param bool $reset will reset the count to 0
3444  * @return void
3445  */
3446 function set_send_count($user,$reset=false) {
3447     global $DB;
3449     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3450         return;
3451     }
3453     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3454         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3455         $DB->update_record('user_preferences', $pref);
3456     }
3457     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3458         // make a new one
3459         $pref = new stdClass();
3460         $pref->name   = 'email_send_count';
3461         $pref->value  = 1;
3462         $pref->userid = $user->id;
3463         $DB->insert_record('user_preferences', $pref, false);
3464     }
3467 /**
3468  * Increment or reset user's email bounce count
3469  *
3470  * @global object
3471  * @param user $user object containing an id
3472  * @param bool $reset will reset the count to 0
3473  */
3474 function set_bounce_count($user,$reset=false) {
3475     global $DB;
3477     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3478         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3479         $DB->update_record('user_preferences', $pref);
3480     }
3481     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3482         // make a new one
3483         $pref = new stdClass();
3484         $pref->name   = 'email_bounce_count';
3485         $pref->value  = 1;
3486         $pref->userid = $user->id;
3487         $DB->insert_record('user_preferences', $pref, false);
3488     }
3491 /**
3492  * Determines if the currently logged in user is in editing mode.
3493  * Note: originally this function had $userid parameter - it was not usable anyway
3494  *
3495  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3496  * @todo Deprecated function remove when ready
3497  *
3498  * @global object
3499  * @uses DEBUG_DEVELOPER
3500  * @return bool
3501  */
3502 function isediting() {
3503     global $PAGE;
3504     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3505     return $PAGE->user_is_editing();
3508 /**
3509  * Determines if the logged in user is currently moving an activity
3510  *
3511  * @global object
3512  * @param int $courseid The id of the course being tested
3513  * @return bool
3514  */
3515 function ismoving($courseid) {
3516     global $USER;
3518     if (!empty($USER->activitycopy)) {
3519         return ($USER->activitycopycourse == $courseid);
3520     }
3521     return false;
3524 /**
3525  * Returns a persons full name
3526  *
3527  * Given an object containing firstname and lastname
3528  * values, this function returns a string with the
3529  * full name of the person.
3530  * The result may depend on system settings
3531  * or language.  'override' will force both names
3532  * to be used even if system settings specify one.
3533  *
3534  * @global object
3535  * @global object
3536  * @param object $user A {@link $USER} object to get full name of
3537  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3538  * @return string
3539  */
3540 function fullname($user, $override=false) {
3541     global $CFG, $SESSION;
3543     if (!isset($user->firstname) and !isset($user->lastname)) {
3544         return '';
3545     }
3547     if (!$override) {
3548         if (!empty($CFG->forcefirstname)) {
3549             $user->firstname = $CFG->forcefirstname;
3550         }
3551         if (!empty($CFG->forcelastname)) {
3552             $user->lastname = $CFG->forcelastname;
3553         }
3554     }
3556     if (!empty($SESSION->fullnamedisplay)) {
3557         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3558     }
3560     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3561         return $user->firstname .' '. $user->lastname;
3563     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3564         return $user->lastname .' '. $user->firstname;
3566     } else if ($CFG->fullnamedisplay == 'firstname') {
3567         if ($override) {
3568             return get_string('fullnamedisplay', '', $user);
3569         } else {
3570             return $user->firstname;
3571         }
3572     }
3574     return get_string('fullnamedisplay', '', $user);
3577 /**
3578  * Checks if current user is shown any extra fields when listing users.
3579  * @param object $context Context
3580  * @param array $already Array of fields that we're going to show anyway
3581  *   so don't bother listing them
3582  * @return array Array of field names from user table, not including anything
3583  *   listed in $already
3584  */
3585 function get_extra_user_fields($context, $already = array()) {
3586     global $CFG;
3588     // Only users with permission get the extra fields
3589     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3590         return array();
3591     }
3593     // Split showuseridentity on comma
3594     if (empty($CFG->showuseridentity)) {
3595         // Explode gives wrong result with empty string
3596         $extra = array();
3597     } else {
3598         $extra =  explode(',', $CFG->showuseridentity);
3599     }
3600     $renumber = false;
3601     foreach ($extra as $key => $field) {
3602         if (in_array($field, $already)) {
3603             unset($extra[$key]);
3604             $renumber = true;
3605         }
3606     }
3607     if ($renumber) {
3608         // For consistency, if entries are removed from array, renumber it
3609         // so they are numbered as you would expect
3610         $extra = array_merge($extra);
3611     }
3612     return $extra;
3615 /**
3616  * If the current user is to be shown extra user fields when listing or
3617  * selecting users, returns a string suitable for including in an SQL select
3618  * clause to retrieve those fields.
3619  * @param object $context Context
3620  * @param string $alias Alias of user table, e.g. 'u' (default none)
3621  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3622  * @param array $already Array of fields that we're going to include anyway
3623  *   so don't list them (default none)
3624  * @return string Partial SQL select clause, beginning with comma, for example
3625  *   ',u.idnumber,u.department' unless it is blank
3626  */
3627 function get_extra_user_fields_sql($context, $alias='', $prefix='',
3628         $already = array()) {
3629     $fields = get_extra_user_fields($context, $already);
3630     $result = '';
3631     // Add punctuation for alias
3632     if ($alias !== '') {
3633         $alias .= '.';
3634     }
3635     foreach ($fields as $field) {
3636         $result .= ', ' . $alias . $field;
3637         if ($prefix) {
3638             $result .= ' AS ' . $prefix . $field;
3639         }
3640     }
3641     return $result;
3644 /**
3645  * Returns the display name of a field in the user table. Works for most fields
3646  * that are commonly displayed to users.
3647  * @param string $field Field name, e.g. 'phone1'
3648  * @return string Text description taken from language file, e.g. 'Phone number'
3649  */
3650 function get_user_field_name($field) {
3651     // Some fields have language strings which are not the same as field name
3652     switch ($field) {
3653         case 'phone1' : return get_string('phone');
3654         case 'url' : return get_string('webpage');
3655         case 'icq' : return get_string('icqnumber');
3656         case 'skype' : return get_string('skypeid');
3657         case 'aim' : return get_string('aimid');
3658         case 'yahoo' : return get_string('yahooid');