MDL-31514 Lib: Time format to remove unwanted zeros caused errors on Windows servers
[moodle.git] / lib / moodlelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * moodlelib.php - Moodle main library
20  *
21  * Main library file of miscellaneous general-purpose Moodle functions.
22  * Other main libraries:
23  *  - weblib.php      - functions that produce web output
24  *  - datalib.php     - functions that access the database
25  *
26  * @package    core
27  * @subpackage lib
28  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
36 /// Date and time constants ///
37 /**
38  * Time constant - the number of seconds in a year
39  */
40 define('YEARSECS', 31536000);
42 /**
43  * Time constant - the number of seconds in a week
44  */
45 define('WEEKSECS', 604800);
47 /**
48  * Time constant - the number of seconds in a day
49  */
50 define('DAYSECS', 86400);
52 /**
53  * Time constant - the number of seconds in an hour
54  */
55 define('HOURSECS', 3600);
57 /**
58  * Time constant - the number of seconds in a minute
59  */
60 define('MINSECS', 60);
62 /**
63  * Time constant - the number of minutes in a day
64  */
65 define('DAYMINS', 1440);
67 /**
68  * Time constant - the number of minutes in an hour
69  */
70 define('HOURMINS', 60);
72 /// Parameter constants - every call to optional_param(), required_param()  ///
73 /// or clean_param() should have a specified type of parameter.  //////////////
77 /**
78  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
79  */
80 define('PARAM_ALPHA',    'alpha');
82 /**
83  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
84  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
85  */
86 define('PARAM_ALPHAEXT', 'alphaext');
88 /**
89  * PARAM_ALPHANUM - expected numbers and letters only.
90  */
91 define('PARAM_ALPHANUM', 'alphanum');
93 /**
94  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
95  */
96 define('PARAM_ALPHANUMEXT', 'alphanumext');
98 /**
99  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
100  */
101 define('PARAM_AUTH',  'auth');
103 /**
104  * PARAM_BASE64 - Base 64 encoded format
105  */
106 define('PARAM_BASE64',   'base64');
108 /**
109  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
110  */
111 define('PARAM_BOOL',     'bool');
113 /**
114  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
115  * checked against the list of capabilities in the database.
116  */
117 define('PARAM_CAPABILITY',   'capability');
119 /**
120  * PARAM_CLEANHTML - cleans submitted HTML code. use only for text in HTML format. This cleaning may fix xhtml strictness too.
121  */
122 define('PARAM_CLEANHTML', 'cleanhtml');
124 /**
125  * PARAM_EMAIL - an email address following the RFC
126  */
127 define('PARAM_EMAIL',   'email');
129 /**
130  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
131  */
132 define('PARAM_FILE',   'file');
134 /**
135  * PARAM_FLOAT - a real/floating point number.
136  */
137 define('PARAM_FLOAT',  'float');
139 /**
140  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
141  */
142 define('PARAM_HOST',     'host');
144 /**
145  * PARAM_INT - integers only, use when expecting only numbers.
146  */
147 define('PARAM_INT',      'int');
149 /**
150  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
151  */
152 define('PARAM_LANG',  'lang');
154 /**
155  * 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!)
156  */
157 define('PARAM_LOCALURL', 'localurl');
159 /**
160  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
161  */
162 define('PARAM_NOTAGS',   'notags');
164 /**
165  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
166  * note: the leading slash is not removed, window drive letter is not allowed
167  */
168 define('PARAM_PATH',     'path');
170 /**
171  * PARAM_PEM - Privacy Enhanced Mail format
172  */
173 define('PARAM_PEM',      'pem');
175 /**
176  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
177  */
178 define('PARAM_PERMISSION',   'permission');
180 /**
181  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
182  */
183 define('PARAM_RAW', 'raw');
185 /**
186  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
187  */
188 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
190 /**
191  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
192  */
193 define('PARAM_SAFEDIR',  'safedir');
195 /**
196  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
197  */
198 define('PARAM_SAFEPATH',  'safepath');
200 /**
201  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
202  */
203 define('PARAM_SEQUENCE',  'sequence');
205 /**
206  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
207  */
208 define('PARAM_TAG',   'tag');
210 /**
211  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
212  */
213 define('PARAM_TAGLIST',   'taglist');
215 /**
216  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
217  */
218 define('PARAM_TEXT',  'text');
220 /**
221  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
222  */
223 define('PARAM_THEME',  'theme');
225 /**
226  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
227  */
228 define('PARAM_URL',      'url');
230 /**
231  * 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!!
232  */
233 define('PARAM_USERNAME',    'username');
235 /**
236  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
237  */
238 define('PARAM_STRINGID',    'stringid');
240 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
241 /**
242  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
243  * It was one of the first types, that is why it is abused so much ;-)
244  * @deprecated since 2.0
245  */
246 define('PARAM_CLEAN',    'clean');
248 /**
249  * PARAM_INTEGER - deprecated alias for PARAM_INT
250  */
251 define('PARAM_INTEGER',  'int');
253 /**
254  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
255  */
256 define('PARAM_NUMBER',  'float');
258 /**
259  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
260  * NOTE: originally alias for PARAM_APLHA
261  */
262 define('PARAM_ACTION',   'alphanumext');
264 /**
265  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
266  * NOTE: originally alias for PARAM_APLHA
267  */
268 define('PARAM_FORMAT',   'alphanumext');
270 /**
271  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
272  */
273 define('PARAM_MULTILANG',  'text');
275 /**
276  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
277  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
278  * America/Port-au-Prince)
279  */
280 define('PARAM_TIMEZONE', 'timezone');
282 /**
283  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
284  */
285 define('PARAM_CLEANFILE', 'file');
287 /**
288  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
289  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
290  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
291  * NOTE: numbers and underscores are strongly discouraged in plugin names!
292  */
293 define('PARAM_COMPONENT', 'component');
295 /**
296  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
297  * It is usually used together with context id and component.
298  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
299  */
300 define('PARAM_AREA', 'area');
302 /**
303  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
304  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
305  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
306  */
307 define('PARAM_PLUGIN', 'plugin');
310 /// Web Services ///
312 /**
313  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
314  */
315 define('VALUE_REQUIRED', 1);
317 /**
318  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
319  */
320 define('VALUE_OPTIONAL', 2);
322 /**
323  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
324  */
325 define('VALUE_DEFAULT', 0);
327 /**
328  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
329  */
330 define('NULL_NOT_ALLOWED', false);
332 /**
333  * NULL_ALLOWED - the parameter can be set to null in the database
334  */
335 define('NULL_ALLOWED', true);
337 /// Page types ///
338 /**
339  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
340  */
341 define('PAGE_COURSE_VIEW', 'course-view');
343 /** Get remote addr constant */
344 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
345 /** Get remote addr constant */
346 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
348 /// Blog access level constant declaration ///
349 define ('BLOG_USER_LEVEL', 1);
350 define ('BLOG_GROUP_LEVEL', 2);
351 define ('BLOG_COURSE_LEVEL', 3);
352 define ('BLOG_SITE_LEVEL', 4);
353 define ('BLOG_GLOBAL_LEVEL', 5);
356 ///Tag constants///
357 /**
358  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
359  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
360  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
361  *
362  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
363  */
364 define('TAG_MAX_LENGTH', 50);
366 /// Password policy constants ///
367 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
368 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
369 define ('PASSWORD_DIGITS', '0123456789');
370 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
372 /// Feature constants ///
373 // Used for plugin_supports() to report features that are, or are not, supported by a module.
375 /** True if module can provide a grade */
376 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
377 /** True if module supports outcomes */
378 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
379 /** True if module supports advanced grading methods */
380 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
382 /** True if module has code to track whether somebody viewed it */
383 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
384 /** True if module has custom completion rules */
385 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
387 /** True if module has no 'view' page (like label) */
388 define('FEATURE_NO_VIEW_LINK', 'viewlink');
389 /** True if module supports outcomes */
390 define('FEATURE_IDNUMBER', 'idnumber');
391 /** True if module supports groups */
392 define('FEATURE_GROUPS', 'groups');
393 /** True if module supports groupings */
394 define('FEATURE_GROUPINGS', 'groupings');
395 /** True if module supports groupmembersonly */
396 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
398 /** Type of module */
399 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
400 /** True if module supports intro editor */
401 define('FEATURE_MOD_INTRO', 'mod_intro');
402 /** True if module has default completion */
403 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
405 define('FEATURE_COMMENT', 'comment');
407 define('FEATURE_RATE', 'rate');
408 /** True if module supports backup/restore of moodle2 format */
409 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
411 /** True if module can show description on course main page */
412 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
414 /** Unspecified module archetype */
415 define('MOD_ARCHETYPE_OTHER', 0);
416 /** Resource-like type module */
417 define('MOD_ARCHETYPE_RESOURCE', 1);
418 /** Assignment module archetype */
419 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
420 /** System (not user-addable) module archetype */
421 define('MOD_ARCHETYPE_SYSTEM', 3);
423 /**
424  * Security token used for allowing access
425  * from external application such as web services.
426  * Scripts do not use any session, performance is relatively
427  * low because we need to load access info in each request.
428  * Scripts are executed in parallel.
429  */
430 define('EXTERNAL_TOKEN_PERMANENT', 0);
432 /**
433  * Security token used for allowing access
434  * of embedded applications, the code is executed in the
435  * active user session. Token is invalidated after user logs out.
436  * Scripts are executed serially - normal session locking is used.
437  */
438 define('EXTERNAL_TOKEN_EMBEDDED', 1);
440 /**
441  * The home page should be the site home
442  */
443 define('HOMEPAGE_SITE', 0);
444 /**
445  * The home page should be the users my page
446  */
447 define('HOMEPAGE_MY', 1);
448 /**
449  * The home page can be chosen by the user
450  */
451 define('HOMEPAGE_USER', 2);
453 /**
454  * Hub directory url (should be moodle.org)
455  */
456 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
459 /**
460  * Moodle.org url (should be moodle.org)
461  */
462 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
464 /**
465  * Moodle mobile app service name
466  */
467 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
469 /// PARAMETER HANDLING ////////////////////////////////////////////////////
471 /**
472  * Returns a particular value for the named variable, taken from
473  * POST or GET.  If the parameter doesn't exist then an error is
474  * thrown because we require this variable.
475  *
476  * This function should be used to initialise all required values
477  * in a script that are based on parameters.  Usually it will be
478  * used like this:
479  *    $id = required_param('id', PARAM_INT);
480  *
481  * Please note the $type parameter is now required and the value can not be array.
482  *
483  * @param string $parname the name of the page parameter we want
484  * @param string $type expected type of parameter
485  * @return mixed
486  */
487 function required_param($parname, $type) {
488     if (func_num_args() != 2 or empty($parname) or empty($type)) {
489         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
490     }
491     if (isset($_POST[$parname])) {       // POST has precedence
492         $param = $_POST[$parname];
493     } else if (isset($_GET[$parname])) {
494         $param = $_GET[$parname];
495     } else {
496         print_error('missingparam', '', '', $parname);
497     }
499     if (is_array($param)) {
500         debugging('Invalid array parameter detected in required_param(): '.$parname);
501         // TODO: switch to fatal error in Moodle 2.3
502         //print_error('missingparam', '', '', $parname);
503         return required_param_array($parname, $type);
504     }
506     return clean_param($param, $type);
509 /**
510  * Returns a particular array value for the named variable, taken from
511  * POST or GET.  If the parameter doesn't exist then an error is
512  * thrown because we require this variable.
513  *
514  * This function should be used to initialise all required values
515  * in a script that are based on parameters.  Usually it will be
516  * used like this:
517  *    $ids = required_param_array('ids', PARAM_INT);
518  *
519  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
520  *
521  * @param string $parname the name of the page parameter we want
522  * @param string $type expected type of parameter
523  * @return array
524  */
525 function required_param_array($parname, $type) {
526     if (func_num_args() != 2 or empty($parname) or empty($type)) {
527         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
528     }
529     if (isset($_POST[$parname])) {       // POST has precedence
530         $param = $_POST[$parname];
531     } else if (isset($_GET[$parname])) {
532         $param = $_GET[$parname];
533     } else {
534         print_error('missingparam', '', '', $parname);
535     }
536     if (!is_array($param)) {
537         print_error('missingparam', '', '', $parname);
538     }
540     $result = array();
541     foreach($param as $key=>$value) {
542         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
543             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
544             continue;
545         }
546         $result[$key] = clean_param($value, $type);
547     }
549     return $result;
552 /**
553  * Returns a particular value for the named variable, taken from
554  * POST or GET, otherwise returning a given default.
555  *
556  * This function should be used to initialise all optional values
557  * in a script that are based on parameters.  Usually it will be
558  * used like this:
559  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
560  *
561  * Please note the $type parameter is now required and the value can not be array.
562  *
563  * @param string $parname the name of the page parameter we want
564  * @param mixed  $default the default value to return if nothing is found
565  * @param string $type expected type of parameter
566  * @return mixed
567  */
568 function optional_param($parname, $default, $type) {
569     if (func_num_args() != 3 or empty($parname) or empty($type)) {
570         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
571     }
572     if (!isset($default)) {
573         $default = null;
574     }
576     if (isset($_POST[$parname])) {       // POST has precedence
577         $param = $_POST[$parname];
578     } else if (isset($_GET[$parname])) {
579         $param = $_GET[$parname];
580     } else {
581         return $default;
582     }
584     if (is_array($param)) {
585         debugging('Invalid array parameter detected in required_param(): '.$parname);
586         // TODO: switch to $default in Moodle 2.3
587         //return $default;
588         return optional_param_array($parname, $default, $type);
589     }
591     return clean_param($param, $type);
594 /**
595  * Returns a particular array value for the named variable, taken from
596  * POST or GET, otherwise returning a given default.
597  *
598  * This function should be used to initialise all optional values
599  * in a script that are based on parameters.  Usually it will be
600  * used like this:
601  *    $ids = optional_param('id', array(), PARAM_INT);
602  *
603  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
604  *
605  * @param string $parname the name of the page parameter we want
606  * @param mixed  $default the default value to return if nothing is found
607  * @param string $type expected type of parameter
608  * @return array
609  */
610 function optional_param_array($parname, $default, $type) {
611     if (func_num_args() != 3 or empty($parname) or empty($type)) {
612         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
613     }
615     if (isset($_POST[$parname])) {       // POST has precedence
616         $param = $_POST[$parname];
617     } else if (isset($_GET[$parname])) {
618         $param = $_GET[$parname];
619     } else {
620         return $default;
621     }
622     if (!is_array($param)) {
623         debugging('optional_param_array() expects array parameters only: '.$parname);
624         return $default;
625     }
627     $result = array();
628     foreach($param as $key=>$value) {
629         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
630             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
631             continue;
632         }
633         $result[$key] = clean_param($value, $type);
634     }
636     return $result;
639 /**
640  * Strict validation of parameter values, the values are only converted
641  * to requested PHP type. Internally it is using clean_param, the values
642  * before and after cleaning must be equal - otherwise
643  * an invalid_parameter_exception is thrown.
644  * Objects and classes are not accepted.
645  *
646  * @param mixed $param
647  * @param string $type PARAM_ constant
648  * @param bool $allownull are nulls valid value?
649  * @param string $debuginfo optional debug information
650  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
651  */
652 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
653     if (is_null($param)) {
654         if ($allownull == NULL_ALLOWED) {
655             return null;
656         } else {
657             throw new invalid_parameter_exception($debuginfo);
658         }
659     }
660     if (is_array($param) or is_object($param)) {
661         throw new invalid_parameter_exception($debuginfo);
662     }
664     $cleaned = clean_param($param, $type);
665     if ((string)$param !== (string)$cleaned) {
666         // conversion to string is usually lossless
667         throw new invalid_parameter_exception($debuginfo);
668     }
670     return $cleaned;
673 /**
674  * Makes sure array contains only the allowed types,
675  * this function does not validate array key names!
676  * <code>
677  * $options = clean_param($options, PARAM_INT);
678  * </code>
679  *
680  * @param array $param the variable array we are cleaning
681  * @param string $type expected format of param after cleaning.
682  * @param bool $recursive clean recursive arrays
683  * @return array
684  */
685 function clean_param_array(array $param = null, $type, $recursive = false) {
686     $param = (array)$param; // convert null to empty array
687     foreach ($param as $key => $value) {
688         if (is_array($value)) {
689             if ($recursive) {
690                 $param[$key] = clean_param_array($value, $type, true);
691             } else {
692                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
693             }
694         } else {
695             $param[$key] = clean_param($value, $type);
696         }
697     }
698     return $param;
701 /**
702  * Used by {@link optional_param()} and {@link required_param()} to
703  * clean the variables and/or cast to specific types, based on
704  * an options field.
705  * <code>
706  * $course->format = clean_param($course->format, PARAM_ALPHA);
707  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
708  * </code>
709  *
710  * @param mixed $param the variable we are cleaning
711  * @param string $type expected format of param after cleaning.
712  * @return mixed
713  */
714 function clean_param($param, $type) {
716     global $CFG;
718     if (is_array($param)) {
719         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
720     } else if (is_object($param)) {
721         if (method_exists($param, '__toString')) {
722             $param = $param->__toString();
723         } else {
724             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
725         }
726     }
728     switch ($type) {
729         case PARAM_RAW:          // no cleaning at all
730             $param = fix_utf8($param);
731             return $param;
733         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
734             $param = fix_utf8($param);
735             return trim($param);
737         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
738             // this is deprecated!, please use more specific type instead
739             if (is_numeric($param)) {
740                 return $param;
741             }
742             $param = fix_utf8($param);
743             return clean_text($param);     // Sweep for scripts, etc
745         case PARAM_CLEANHTML:    // clean html fragment
746             $param = fix_utf8($param);
747             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
748             return trim($param);
750         case PARAM_INT:
751             return (int)$param;  // Convert to integer
753         case PARAM_FLOAT:
754         case PARAM_NUMBER:
755             return (float)$param;  // Convert to float
757         case PARAM_ALPHA:        // Remove everything not a-z
758             return preg_replace('/[^a-zA-Z]/i', '', $param);
760         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
761             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
763         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
764             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
766         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
767             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
769         case PARAM_SEQUENCE:     // Remove everything not 0-9,
770             return preg_replace('/[^0-9,]/i', '', $param);
772         case PARAM_BOOL:         // Convert to 1 or 0
773             $tempstr = strtolower($param);
774             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
775                 $param = 1;
776             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
777                 $param = 0;
778             } else {
779                 $param = empty($param) ? 0 : 1;
780             }
781             return $param;
783         case PARAM_NOTAGS:       // Strip all tags
784             $param = fix_utf8($param);
785             return strip_tags($param);
787         case PARAM_TEXT:    // leave only tags needed for multilang
788             $param = fix_utf8($param);
789             // if the multilang syntax is not correct we strip all tags
790             // because it would break xhtml strict which is required for accessibility standards
791             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
792             do {
793                 if (strpos($param, '</lang>') !== false) {
794                     // old and future mutilang syntax
795                     $param = strip_tags($param, '<lang>');
796                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
797                         break;
798                     }
799                     $open = false;
800                     foreach ($matches[0] as $match) {
801                         if ($match === '</lang>') {
802                             if ($open) {
803                                 $open = false;
804                                 continue;
805                             } else {
806                                 break 2;
807                             }
808                         }
809                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
810                             break 2;
811                         } else {
812                             $open = true;
813                         }
814                     }
815                     if ($open) {
816                         break;
817                     }
818                     return $param;
820                 } else if (strpos($param, '</span>') !== false) {
821                     // current problematic multilang syntax
822                     $param = strip_tags($param, '<span>');
823                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
824                         break;
825                     }
826                     $open = false;
827                     foreach ($matches[0] as $match) {
828                         if ($match === '</span>') {
829                             if ($open) {
830                                 $open = false;
831                                 continue;
832                             } else {
833                                 break 2;
834                             }
835                         }
836                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
837                             break 2;
838                         } else {
839                             $open = true;
840                         }
841                     }
842                     if ($open) {
843                         break;
844                     }
845                     return $param;
846                 }
847             } while (false);
848             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
849             return strip_tags($param);
851         case PARAM_COMPONENT:
852             // we do not want any guessing here, either the name is correct or not
853             // please note only normalised component names are accepted
854             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
855                 return '';
856             }
857             if (strpos($param, '__') !== false) {
858                 return '';
859             }
860             if (strpos($param, 'mod_') === 0) {
861                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
862                 if (substr_count($param, '_') != 1) {
863                     return '';
864                 }
865             }
866             return $param;
868         case PARAM_PLUGIN:
869         case PARAM_AREA:
870             // we do not want any guessing here, either the name is correct or not
871             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
872                 return '';
873             }
874             if (strpos($param, '__') !== false) {
875                 return '';
876             }
877             return $param;
879         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
880             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
882         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
883             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
885         case PARAM_FILE:         // Strip all suspicious characters from filename
886             $param = fix_utf8($param);
887             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
888             $param = preg_replace('~\.\.+~', '', $param);
889             if ($param === '.') {
890                 $param = '';
891             }
892             return $param;
894         case PARAM_PATH:         // Strip all suspicious characters from file path
895             $param = fix_utf8($param);
896             $param = str_replace('\\', '/', $param);
897             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
898             $param = preg_replace('~\.\.+~', '', $param);
899             $param = preg_replace('~//+~', '/', $param);
900             return preg_replace('~/(\./)+~', '/', $param);
902         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
903             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
904             // match ipv4 dotted quad
905             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
906                 // confirm values are ok
907                 if ( $match[0] > 255
908                      || $match[1] > 255
909                      || $match[3] > 255
910                      || $match[4] > 255 ) {
911                     // hmmm, what kind of dotted quad is this?
912                     $param = '';
913                 }
914             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
915                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
916                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
917                        ) {
918                 // all is ok - $param is respected
919             } else {
920                 // all is not ok...
921                 $param='';
922             }
923             return $param;
925         case PARAM_URL:          // allow safe ftp, http, mailto urls
926             $param = fix_utf8($param);
927             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
928             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
929                 // all is ok, param is respected
930             } else {
931                 $param =''; // not really ok
932             }
933             return $param;
935         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
936             $param = clean_param($param, PARAM_URL);
937             if (!empty($param)) {
938                 if (preg_match(':^/:', $param)) {
939                     // root-relative, ok!
940                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
941                     // absolute, and matches our wwwroot
942                 } else {
943                     // relative - let's make sure there are no tricks
944                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
945                         // looks ok.
946                     } else {
947                         $param = '';
948                     }
949                 }
950             }
951             return $param;
953         case PARAM_PEM:
954             $param = trim($param);
955             // PEM formatted strings may contain letters/numbers and the symbols
956             // forward slash: /
957             // plus sign:     +
958             // equal sign:    =
959             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
960             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
961                 list($wholething, $body) = $matches;
962                 unset($wholething, $matches);
963                 $b64 = clean_param($body, PARAM_BASE64);
964                 if (!empty($b64)) {
965                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
966                 } else {
967                     return '';
968                 }
969             }
970             return '';
972         case PARAM_BASE64:
973             if (!empty($param)) {
974                 // PEM formatted strings may contain letters/numbers and the symbols
975                 // forward slash: /
976                 // plus sign:     +
977                 // equal sign:    =
978                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
979                     return '';
980                 }
981                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
982                 // Each line of base64 encoded data must be 64 characters in
983                 // length, except for the last line which may be less than (or
984                 // equal to) 64 characters long.
985                 for ($i=0, $j=count($lines); $i < $j; $i++) {
986                     if ($i + 1 == $j) {
987                         if (64 < strlen($lines[$i])) {
988                             return '';
989                         }
990                         continue;
991                     }
993                     if (64 != strlen($lines[$i])) {
994                         return '';
995                     }
996                 }
997                 return implode("\n",$lines);
998             } else {
999                 return '';
1000             }
1002         case PARAM_TAG:
1003             $param = fix_utf8($param);
1004             // Please note it is not safe to use the tag name directly anywhere,
1005             // it must be processed with s(), urlencode() before embedding anywhere.
1006             // remove some nasties
1007             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1008             //convert many whitespace chars into one
1009             $param = preg_replace('/\s+/', ' ', $param);
1010             $textlib = textlib_get_instance();
1011             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
1012             return $param;
1014         case PARAM_TAGLIST:
1015             $param = fix_utf8($param);
1016             $tags = explode(',', $param);
1017             $result = array();
1018             foreach ($tags as $tag) {
1019                 $res = clean_param($tag, PARAM_TAG);
1020                 if ($res !== '') {
1021                     $result[] = $res;
1022                 }
1023             }
1024             if ($result) {
1025                 return implode(',', $result);
1026             } else {
1027                 return '';
1028             }
1030         case PARAM_CAPABILITY:
1031             if (get_capability_info($param)) {
1032                 return $param;
1033             } else {
1034                 return '';
1035             }
1037         case PARAM_PERMISSION:
1038             $param = (int)$param;
1039             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1040                 return $param;
1041             } else {
1042                 return CAP_INHERIT;
1043             }
1045         case PARAM_AUTH:
1046             $param = clean_param($param, PARAM_PLUGIN);
1047             if (empty($param)) {
1048                 return '';
1049             } else if (exists_auth_plugin($param)) {
1050                 return $param;
1051             } else {
1052                 return '';
1053             }
1055         case PARAM_LANG:
1056             $param = clean_param($param, PARAM_SAFEDIR);
1057             if (get_string_manager()->translation_exists($param)) {
1058                 return $param;
1059             } else {
1060                 return ''; // Specified language is not installed or param malformed
1061             }
1063         case PARAM_THEME:
1064             $param = clean_param($param, PARAM_PLUGIN);
1065             if (empty($param)) {
1066                 return '';
1067             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1068                 return $param;
1069             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1070                 return $param;
1071             } else {
1072                 return '';  // Specified theme is not installed
1073             }
1075         case PARAM_USERNAME:
1076             $param = fix_utf8($param);
1077             $param = str_replace(" " , "", $param);
1078             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
1079             if (empty($CFG->extendedusernamechars)) {
1080                 // regular expression, eliminate all chars EXCEPT:
1081                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1082                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1083             }
1084             return $param;
1086         case PARAM_EMAIL:
1087             $param = fix_utf8($param);
1088             if (validate_email($param)) {
1089                 return $param;
1090             } else {
1091                 return '';
1092             }
1094         case PARAM_STRINGID:
1095             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1096                 return $param;
1097             } else {
1098                 return '';
1099             }
1101         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1102             $param = fix_utf8($param);
1103             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3]|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1104             if (preg_match($timezonepattern, $param)) {
1105                 return $param;
1106             } else {
1107                 return '';
1108             }
1110         default:                 // throw error, switched parameters in optional_param or another serious problem
1111             print_error("unknownparamtype", '', '', $type);
1112     }
1115 /**
1116  * Makes sure the data is using valid utf8, invalid characters are discarded.
1117  *
1118  * Note: this function is not intended for full objects with methods and private properties.
1119  *
1120  * @param mixed $value
1121  * @return mixed with proper utf-8 encoding
1122  */
1123 function fix_utf8($value) {
1124     if (is_null($value) or $value === '') {
1125         return $value;
1127     } else if (is_string($value)) {
1128         if ((string)(int)$value === $value) {
1129             // shortcut
1130             return $value;
1131         }
1132         return iconv('UTF-8', 'UTF-8//IGNORE', $value);
1134     } else if (is_array($value)) {
1135         foreach ($value as $k=>$v) {
1136             $value[$k] = fix_utf8($v);
1137         }
1138         return $value;
1140     } else if (is_object($value)) {
1141         $value = clone($value); // do not modify original
1142         foreach ($value as $k=>$v) {
1143             $value->$k = fix_utf8($v);
1144         }
1145         return $value;
1147     } else {
1148         // this is some other type, no utf-8 here
1149         return $value;
1150     }
1153 /**
1154  * Return true if given value is integer or string with integer value
1155  *
1156  * @param mixed $value String or Int
1157  * @return bool true if number, false if not
1158  */
1159 function is_number($value) {
1160     if (is_int($value)) {
1161         return true;
1162     } else if (is_string($value)) {
1163         return ((string)(int)$value) === $value;
1164     } else {
1165         return false;
1166     }
1169 /**
1170  * Returns host part from url
1171  * @param string $url full url
1172  * @return string host, null if not found
1173  */
1174 function get_host_from_url($url) {
1175     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1176     if ($matches) {
1177         return $matches[1];
1178     }
1179     return null;
1182 /**
1183  * Tests whether anything was returned by text editor
1184  *
1185  * This function is useful for testing whether something you got back from
1186  * the HTML editor actually contains anything. Sometimes the HTML editor
1187  * appear to be empty, but actually you get back a <br> tag or something.
1188  *
1189  * @param string $string a string containing HTML.
1190  * @return boolean does the string contain any actual content - that is text,
1191  * images, objects, etc.
1192  */
1193 function html_is_blank($string) {
1194     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1197 /**
1198  * Set a key in global configuration
1199  *
1200  * Set a key/value pair in both this session's {@link $CFG} global variable
1201  * and in the 'config' database table for future sessions.
1202  *
1203  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1204  * In that case it doesn't affect $CFG.
1205  *
1206  * A NULL value will delete the entry.
1207  *
1208  * @global object
1209  * @global object
1210  * @param string $name the key to set
1211  * @param string $value the value to set (without magic quotes)
1212  * @param string $plugin (optional) the plugin scope, default NULL
1213  * @return bool true or exception
1214  */
1215 function set_config($name, $value, $plugin=NULL) {
1216     global $CFG, $DB;
1218     if (empty($plugin)) {
1219         if (!array_key_exists($name, $CFG->config_php_settings)) {
1220             // So it's defined for this invocation at least
1221             if (is_null($value)) {
1222                 unset($CFG->$name);
1223             } else {
1224                 $CFG->$name = (string)$value; // settings from db are always strings
1225             }
1226         }
1228         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1229             if ($value === null) {
1230                 $DB->delete_records('config', array('name'=>$name));
1231             } else {
1232                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1233             }
1234         } else {
1235             if ($value !== null) {
1236                 $config = new stdClass();
1237                 $config->name  = $name;
1238                 $config->value = $value;
1239                 $DB->insert_record('config', $config, false);
1240             }
1241         }
1243     } else { // plugin scope
1244         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1245             if ($value===null) {
1246                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1247             } else {
1248                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1249             }
1250         } else {
1251             if ($value !== null) {
1252                 $config = new stdClass();
1253                 $config->plugin = $plugin;
1254                 $config->name   = $name;
1255                 $config->value  = $value;
1256                 $DB->insert_record('config_plugins', $config, false);
1257             }
1258         }
1259     }
1261     return true;
1264 /**
1265  * Get configuration values from the global config table
1266  * or the config_plugins table.
1267  *
1268  * If called with one parameter, it will load all the config
1269  * variables for one plugin, and return them as an object.
1270  *
1271  * If called with 2 parameters it will return a string single
1272  * value or false if the value is not found.
1273  *
1274  * @param string $plugin full component name
1275  * @param string $name default NULL
1276  * @return mixed hash-like object or single value, return false no config found
1277  */
1278 function get_config($plugin, $name = NULL) {
1279     global $CFG, $DB;
1281     // normalise component name
1282     if ($plugin === 'moodle' or $plugin === 'core') {
1283         $plugin = NULL;
1284     }
1286     if (!empty($name)) { // the user is asking for a specific value
1287         if (!empty($plugin)) {
1288             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1289                 // setting forced in config file
1290                 return $CFG->forced_plugin_settings[$plugin][$name];
1291             } else {
1292                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1293             }
1294         } else {
1295             if (array_key_exists($name, $CFG->config_php_settings)) {
1296                 // setting force in config file
1297                 return $CFG->config_php_settings[$name];
1298             } else {
1299                 return $DB->get_field('config', 'value', array('name'=>$name));
1300             }
1301         }
1302     }
1304     // the user is after a recordset
1305     if ($plugin) {
1306         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1307         if (isset($CFG->forced_plugin_settings[$plugin])) {
1308             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1309                 if (is_null($v) or is_array($v) or is_object($v)) {
1310                     // we do not want any extra mess here, just real settings that could be saved in db
1311                     unset($localcfg[$n]);
1312                 } else {
1313                     //convert to string as if it went through the DB
1314                     $localcfg[$n] = (string)$v;
1315                 }
1316             }
1317         }
1318         if ($localcfg) {
1319             return (object)$localcfg;
1320         } else {
1321             return new stdClass();
1322         }
1324     } else {
1325         // this part is not really used any more, but anyway...
1326         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1327         foreach($CFG->config_php_settings as $n=>$v) {
1328             if (is_null($v) or is_array($v) or is_object($v)) {
1329                 // we do not want any extra mess here, just real settings that could be saved in db
1330                 unset($localcfg[$n]);
1331             } else {
1332                 //convert to string as if it went through the DB
1333                 $localcfg[$n] = (string)$v;
1334             }
1335         }
1336         return (object)$localcfg;
1337     }
1340 /**
1341  * Removes a key from global configuration
1342  *
1343  * @param string $name the key to set
1344  * @param string $plugin (optional) the plugin scope
1345  * @global object
1346  * @return boolean whether the operation succeeded.
1347  */
1348 function unset_config($name, $plugin=NULL) {
1349     global $CFG, $DB;
1351     if (empty($plugin)) {
1352         unset($CFG->$name);
1353         $DB->delete_records('config', array('name'=>$name));
1354     } else {
1355         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1356     }
1358     return true;
1361 /**
1362  * Remove all the config variables for a given plugin.
1363  *
1364  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1365  * @return boolean whether the operation succeeded.
1366  */
1367 function unset_all_config_for_plugin($plugin) {
1368     global $DB;
1369     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1370     $like = $DB->sql_like('name', '?', true, true, false, '|');
1371     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1372     $DB->delete_records_select('config', $like, $params);
1373     return true;
1376 /**
1377  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1378  *
1379  * All users are verified if they still have the necessary capability.
1380  *
1381  * @param string $value the value of the config setting.
1382  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1383  * @param bool $include admins, include administrators
1384  * @return array of user objects.
1385  */
1386 function get_users_from_config($value, $capability, $includeadmins = true) {
1387     global $CFG, $DB;
1389     if (empty($value) or $value === '$@NONE@$') {
1390         return array();
1391     }
1393     // we have to make sure that users still have the necessary capability,
1394     // it should be faster to fetch them all first and then test if they are present
1395     // instead of validating them one-by-one
1396     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1397     if ($includeadmins) {
1398         $admins = get_admins();
1399         foreach ($admins as $admin) {
1400             $users[$admin->id] = $admin;
1401         }
1402     }
1404     if ($value === '$@ALL@$') {
1405         return $users;
1406     }
1408     $result = array(); // result in correct order
1409     $allowed = explode(',', $value);
1410     foreach ($allowed as $uid) {
1411         if (isset($users[$uid])) {
1412             $user = $users[$uid];
1413             $result[$user->id] = $user;
1414         }
1415     }
1417     return $result;
1421 /**
1422  * Invalidates browser caches and cached data in temp
1423  * @return void
1424  */
1425 function purge_all_caches() {
1426     global $CFG;
1428     reset_text_filters_cache();
1429     js_reset_all_caches();
1430     theme_reset_all_caches();
1431     get_string_manager()->reset_caches();
1433     // purge all other caches: rss, simplepie, etc.
1434     remove_dir($CFG->cachedir.'', true);
1436     // make sure cache dir is writable, throws exception if not
1437     make_cache_directory('');
1439     // hack: this script may get called after the purifier was initialised,
1440     // but we do not want to verify repeatedly this exists in each call
1441     make_cache_directory('htmlpurifier');
1444 /**
1445  * Get volatile flags
1446  *
1447  * @param string $type
1448  * @param int    $changedsince default null
1449  * @return records array
1450  */
1451 function get_cache_flags($type, $changedsince=NULL) {
1452     global $DB;
1454     $params = array('type'=>$type, 'expiry'=>time());
1455     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1456     if ($changedsince !== NULL) {
1457         $params['changedsince'] = $changedsince;
1458         $sqlwhere .= " AND timemodified > :changedsince";
1459     }
1460     $cf = array();
1462     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1463         foreach ($flags as $flag) {
1464             $cf[$flag->name] = $flag->value;
1465         }
1466     }
1467     return $cf;
1470 /**
1471  * Get volatile flags
1472  *
1473  * @param string $type
1474  * @param string $name
1475  * @param int    $changedsince default null
1476  * @return records array
1477  */
1478 function get_cache_flag($type, $name, $changedsince=NULL) {
1479     global $DB;
1481     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1483     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1484     if ($changedsince !== NULL) {
1485         $params['changedsince'] = $changedsince;
1486         $sqlwhere .= " AND timemodified > :changedsince";
1487     }
1489     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1492 /**
1493  * Set a volatile flag
1494  *
1495  * @param string $type the "type" namespace for the key
1496  * @param string $name the key to set
1497  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1498  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1499  * @return bool Always returns true
1500  */
1501 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1502     global $DB;
1504     $timemodified = time();
1505     if ($expiry===NULL || $expiry < $timemodified) {
1506         $expiry = $timemodified + 24 * 60 * 60;
1507     } else {
1508         $expiry = (int)$expiry;
1509     }
1511     if ($value === NULL) {
1512         unset_cache_flag($type,$name);
1513         return true;
1514     }
1516     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1517         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1518             return true; //no need to update; helps rcache too
1519         }
1520         $f->value        = $value;
1521         $f->expiry       = $expiry;
1522         $f->timemodified = $timemodified;
1523         $DB->update_record('cache_flags', $f);
1524     } else {
1525         $f = new stdClass();
1526         $f->flagtype     = $type;
1527         $f->name         = $name;
1528         $f->value        = $value;
1529         $f->expiry       = $expiry;
1530         $f->timemodified = $timemodified;
1531         $DB->insert_record('cache_flags', $f);
1532     }
1533     return true;
1536 /**
1537  * Removes a single volatile flag
1538  *
1539  * @global object
1540  * @param string $type the "type" namespace for the key
1541  * @param string $name the key to set
1542  * @return bool
1543  */
1544 function unset_cache_flag($type, $name) {
1545     global $DB;
1546     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1547     return true;
1550 /**
1551  * Garbage-collect volatile flags
1552  *
1553  * @return bool Always returns true
1554  */
1555 function gc_cache_flags() {
1556     global $DB;
1557     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1558     return true;
1561 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1563 /**
1564  * Refresh user preference cache. This is used most often for $USER
1565  * object that is stored in session, but it also helps with performance in cron script.
1566  *
1567  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1568  *
1569  * @param stdClass $user user object, preferences are preloaded into ->preference property
1570  * @param int $cachelifetime cache life time on the current page (ins seconds)
1571  * @return void
1572  */
1573 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1574     global $DB;
1575     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1577     if (!isset($user->id)) {
1578         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1579     }
1581     if (empty($user->id) or isguestuser($user->id)) {
1582         // No permanent storage for not-logged-in users and guest
1583         if (!isset($user->preference)) {
1584             $user->preference = array();
1585         }
1586         return;
1587     }
1589     $timenow = time();
1591     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1592         // Already loaded at least once on this page. Are we up to date?
1593         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1594             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1595             return;
1597         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1598             // no change since the lastcheck on this page
1599             $user->preference['_lastloaded'] = $timenow;
1600             return;
1601         }
1602     }
1604     // OK, so we have to reload all preferences
1605     $loadedusers[$user->id] = true;
1606     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1607     $user->preference['_lastloaded'] = $timenow;
1610 /**
1611  * Called from set/delete_user_preferences, so that the prefs can
1612  * be correctly reloaded in different sessions.
1613  *
1614  * NOTE: internal function, do not call from other code.
1615  *
1616  * @param integer $userid the user whose prefs were changed.
1617  * @return void
1618  */
1619 function mark_user_preferences_changed($userid) {
1620     global $CFG;
1622     if (empty($userid) or isguestuser($userid)) {
1623         // no cache flags for guest and not-logged-in users
1624         return;
1625     }
1627     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1630 /**
1631  * Sets a preference for the specified user.
1632  *
1633  * If user object submitted, 'preference' property contains the preferences cache.
1634  *
1635  * @param string $name The key to set as preference for the specified user
1636  * @param string $value The value to set for the $name key in the specified user's record,
1637  *                      null means delete current value
1638  * @param stdClass|int $user A moodle user object or id, null means current user
1639  * @return bool always true or exception
1640  */
1641 function set_user_preference($name, $value, $user = null) {
1642     global $USER, $DB;
1644     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1645         throw new coding_exception('Invalid preference name in set_user_preference() call');
1646     }
1648     if (is_null($value)) {
1649         // null means delete current
1650         return unset_user_preference($name, $user);
1651     } else if (is_object($value)) {
1652         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1653     } else if (is_array($value)) {
1654         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1655     }
1656     $value = (string)$value;
1657     if (textlib::strlen($value) > 1333) { //value column maximum length is 1333 characters
1658         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1659     }
1661     if (is_null($user)) {
1662         $user = $USER;
1663     } else if (isset($user->id)) {
1664         // $user is valid object
1665     } else if (is_numeric($user)) {
1666         $user = (object)array('id'=>(int)$user);
1667     } else {
1668         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1669     }
1671     check_user_preferences_loaded($user);
1673     if (empty($user->id) or isguestuser($user->id)) {
1674         // no permanent storage for not-logged-in users and guest
1675         $user->preference[$name] = $value;
1676         return true;
1677     }
1679     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1680         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1681             // preference already set to this value
1682             return true;
1683         }
1684         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1686     } else {
1687         $preference = new stdClass();
1688         $preference->userid = $user->id;
1689         $preference->name   = $name;
1690         $preference->value  = $value;
1691         $DB->insert_record('user_preferences', $preference);
1692     }
1694     // update value in cache
1695     $user->preference[$name] = $value;
1697     // set reload flag for other sessions
1698     mark_user_preferences_changed($user->id);
1700     return true;
1703 /**
1704  * Sets a whole array of preferences for the current user
1705  *
1706  * If user object submitted, 'preference' property contains the preferences cache.
1707  *
1708  * @param array $prefarray An array of key/value pairs to be set
1709  * @param stdClass|int $user A moodle user object or id, null means current user
1710  * @return bool always true or exception
1711  */
1712 function set_user_preferences(array $prefarray, $user = null) {
1713     foreach ($prefarray as $name => $value) {
1714         set_user_preference($name, $value, $user);
1715     }
1716     return true;
1719 /**
1720  * Unsets a preference completely by deleting it from the database
1721  *
1722  * If user object submitted, 'preference' property contains the preferences cache.
1723  *
1724  * @param string  $name The key to unset as preference for the specified user
1725  * @param stdClass|int $user A moodle user object or id, null means current user
1726  * @return bool always true or exception
1727  */
1728 function unset_user_preference($name, $user = null) {
1729     global $USER, $DB;
1731     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1732         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1733     }
1735     if (is_null($user)) {
1736         $user = $USER;
1737     } else if (isset($user->id)) {
1738         // $user is valid object
1739     } else if (is_numeric($user)) {
1740         $user = (object)array('id'=>(int)$user);
1741     } else {
1742         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1743     }
1745     check_user_preferences_loaded($user);
1747     if (empty($user->id) or isguestuser($user->id)) {
1748         // no permanent storage for not-logged-in user and guest
1749         unset($user->preference[$name]);
1750         return true;
1751     }
1753     // delete from DB
1754     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1756     // delete the preference from cache
1757     unset($user->preference[$name]);
1759     // set reload flag for other sessions
1760     mark_user_preferences_changed($user->id);
1762     return true;
1765 /**
1766  * Used to fetch user preference(s)
1767  *
1768  * If no arguments are supplied this function will return
1769  * all of the current user preferences as an array.
1770  *
1771  * If a name is specified then this function
1772  * attempts to return that particular preference value.  If
1773  * none is found, then the optional value $default is returned,
1774  * otherwise NULL.
1775  *
1776  * If user object submitted, 'preference' property contains the preferences cache.
1777  *
1778  * @param string $name Name of the key to use in finding a preference value
1779  * @param mixed $default Value to be returned if the $name key is not set in the user preferences
1780  * @param stdClass|int $user A moodle user object or id, null means current user
1781  * @return mixed string value or default
1782  */
1783 function get_user_preferences($name = null, $default = null, $user = null) {
1784     global $USER;
1786     if (is_null($name)) {
1787         // all prefs
1788     } else if (is_numeric($name) or $name === '_lastloaded') {
1789         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1790     }
1792     if (is_null($user)) {
1793         $user = $USER;
1794     } else if (isset($user->id)) {
1795         // $user is valid object
1796     } else if (is_numeric($user)) {
1797         $user = (object)array('id'=>(int)$user);
1798     } else {
1799         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1800     }
1802     check_user_preferences_loaded($user);
1804     if (empty($name)) {
1805         return $user->preference; // All values
1806     } else if (isset($user->preference[$name])) {
1807         return $user->preference[$name]; // The single string value
1808     } else {
1809         return $default; // Default value (null if not specified)
1810     }
1813 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1815 /**
1816  * Given date parts in user time produce a GMT timestamp.
1817  *
1818  * @package core
1819  * @category time
1820  * @param int $year The year part to create timestamp of
1821  * @param int $month The month part to create timestamp of
1822  * @param int $day The day part to create timestamp of
1823  * @param int $hour The hour part to create timestamp of
1824  * @param int $minute The minute part to create timestamp of
1825  * @param int $second The second part to create timestamp of
1826  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
1827  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
1828  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1829  *             applied only if timezone is 99 or string.
1830  * @return int GMT timestamp
1831  */
1832 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1834     //save input timezone, required for dst offset check.
1835     $passedtimezone = $timezone;
1837     $timezone = get_user_timezone_offset($timezone);
1839     if (abs($timezone) > 13) {  //server time
1840         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1841     } else {
1842         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1843         $time = usertime($time, $timezone);
1845         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1846         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1847             $time -= dst_offset_on($time, $passedtimezone);
1848         }
1849     }
1851     return $time;
1855 /**
1856  * Format a date/time (seconds) as weeks, days, hours etc as needed
1857  *
1858  * Given an amount of time in seconds, returns string
1859  * formatted nicely as weeks, days, hours etc as needed
1860  *
1861  * @package core
1862  * @category time
1863  * @uses MINSECS
1864  * @uses HOURSECS
1865  * @uses DAYSECS
1866  * @uses YEARSECS
1867  * @param int $totalsecs Time in seconds
1868  * @param object $str Should be a time object
1869  * @return string A nicely formatted date/time string
1870  */
1871  function format_time($totalsecs, $str=NULL) {
1873     $totalsecs = abs($totalsecs);
1875     if (!$str) {  // Create the str structure the slow way
1876         $str = new stdClass();
1877         $str->day   = get_string('day');
1878         $str->days  = get_string('days');
1879         $str->hour  = get_string('hour');
1880         $str->hours = get_string('hours');
1881         $str->min   = get_string('min');
1882         $str->mins  = get_string('mins');
1883         $str->sec   = get_string('sec');
1884         $str->secs  = get_string('secs');
1885         $str->year  = get_string('year');
1886         $str->years = get_string('years');
1887     }
1890     $years     = floor($totalsecs/YEARSECS);
1891     $remainder = $totalsecs - ($years*YEARSECS);
1892     $days      = floor($remainder/DAYSECS);
1893     $remainder = $totalsecs - ($days*DAYSECS);
1894     $hours     = floor($remainder/HOURSECS);
1895     $remainder = $remainder - ($hours*HOURSECS);
1896     $mins      = floor($remainder/MINSECS);
1897     $secs      = $remainder - ($mins*MINSECS);
1899     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1900     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1901     $sh = ($hours == 1) ? $str->hour : $str->hours;
1902     $sd = ($days == 1)  ? $str->day  : $str->days;
1903     $sy = ($years == 1)  ? $str->year  : $str->years;
1905     $oyears = '';
1906     $odays = '';
1907     $ohours = '';
1908     $omins = '';
1909     $osecs = '';
1911     if ($years)  $oyears  = $years .' '. $sy;
1912     if ($days)  $odays  = $days .' '. $sd;
1913     if ($hours) $ohours = $hours .' '. $sh;
1914     if ($mins)  $omins  = $mins .' '. $sm;
1915     if ($secs)  $osecs  = $secs .' '. $ss;
1917     if ($years) return trim($oyears .' '. $odays);
1918     if ($days)  return trim($odays .' '. $ohours);
1919     if ($hours) return trim($ohours .' '. $omins);
1920     if ($mins)  return trim($omins .' '. $osecs);
1921     if ($secs)  return $osecs;
1922     return get_string('now');
1925 /**
1926  * Returns a formatted string that represents a date in user time
1927  *
1928  * Returns a formatted string that represents a date in user time
1929  * <b>WARNING: note that the format is for strftime(), not date().</b>
1930  * Because of a bug in most Windows time libraries, we can't use
1931  * the nicer %e, so we have to use %d which has leading zeroes.
1932  * A lot of the fuss in the function is just getting rid of these leading
1933  * zeroes as efficiently as possible.
1934  *
1935  * If parameter fixday = true (default), then take off leading
1936  * zero from %d, else maintain it.
1937  *
1938  * @package core
1939  * @category time
1940  * @param int $date the timestamp in UTC, as obtained from the database.
1941  * @param string $format strftime format. You should probably get this using
1942  *        get_string('strftime...', 'langconfig');
1943  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
1944  *        not 99 then daylight saving will not be added.
1945  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
1946  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1947  *        If false then the leading zero is maintained.
1948  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
1949  * @return string the formatted date/time.
1950  */
1951 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
1953     global $CFG;
1955     if (empty($format)) {
1956         $format = get_string('strftimedaydatetime', 'langconfig');
1957     }
1959     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1960         $fixday = false;
1961     } else if ($fixday) {
1962         $formatnoday = str_replace('%d', 'DD', $format);
1963         $fixday = ($formatnoday != $format);
1964         $format = $formatnoday;
1965     }
1967     // Note: This logic about fixing 12-hour time to remove unnecessary leading
1968     // zero is required because on Windows, PHP strftime function does not
1969     // support the correct 'hour without leading zero' parameter (%l).
1970     if (!empty($CFG->nofixhour)) {
1971         // Config.php can force %I not to be fixed.
1972         $fixhour = false;
1973     } else if ($fixhour) {
1974         $formatnohour = str_replace('%I', 'HH', $format);
1975         $fixhour = ($formatnohour != $format);
1976         $format = $formatnohour;
1977     }
1979     //add daylight saving offset for string timezones only, as we can't get dst for
1980     //float values. if timezone is 99 (user default timezone), then try update dst.
1981     if ((99 == $timezone) || !is_numeric($timezone)) {
1982         $date += dst_offset_on($date, $timezone);
1983     }
1985     $timezone = get_user_timezone_offset($timezone);
1987     if (abs($timezone) > 13) {   /// Server time
1988         $datestring = strftime($format, $date);
1989         if ($fixday) {
1990             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1991             $datestring = str_replace('DD', $daystring, $datestring);
1992         }
1993         if ($fixhour) {
1994             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
1995             $datestring = str_replace('HH', $hourstring, $datestring);
1996         }
1997     } else {
1998         $date += (int)($timezone * 3600);
1999         $datestring = gmstrftime($format, $date);
2000         if ($fixday) {
2001             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2002             $datestring = str_replace('DD', $daystring, $datestring);
2003         }
2004         if ($fixhour) {
2005             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2006             $datestring = str_replace('HH', $hourstring, $datestring);
2007         }
2008     }
2010 /// If we are running under Windows convert from windows encoding to UTF-8
2011 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
2013    if ($CFG->ostype == 'WINDOWS') {
2014        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
2015            $textlib = textlib_get_instance();
2016            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
2017        }
2018     }
2020     return $datestring;
2023 /**
2024  * Given a $time timestamp in GMT (seconds since epoch),
2025  * returns an array that represents the date in user time
2026  *
2027  * @package core
2028  * @category time
2029  * @uses HOURSECS
2030  * @param int $time Timestamp in GMT
2031  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2032  *        dst offset is applyed {@link http://docs.moodle.org/dev/Time_API#Timezone}
2033  * @return array An array that represents the date in user time
2034  */
2035 function usergetdate($time, $timezone=99) {
2037     //save input timezone, required for dst offset check.
2038     $passedtimezone = $timezone;
2040     $timezone = get_user_timezone_offset($timezone);
2042     if (abs($timezone) > 13) {    // Server time
2043         return getdate($time);
2044     }
2046     //add daylight saving offset for string timezones only, as we can't get dst for
2047     //float values. if timezone is 99 (user default timezone), then try update dst.
2048     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2049         $time += dst_offset_on($time, $passedtimezone);
2050     }
2052     $time += intval((float)$timezone * HOURSECS);
2054     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2056     //be careful to ensure the returned array matches that produced by getdate() above
2057     list(
2058         $getdate['month'],
2059         $getdate['weekday'],
2060         $getdate['yday'],
2061         $getdate['year'],
2062         $getdate['mon'],
2063         $getdate['wday'],
2064         $getdate['mday'],
2065         $getdate['hours'],
2066         $getdate['minutes'],
2067         $getdate['seconds']
2068     ) = explode('_', $datestring);
2070     return $getdate;
2073 /**
2074  * Given a GMT timestamp (seconds since epoch), offsets it by
2075  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2076  *
2077  * @package core
2078  * @category time
2079  * @uses HOURSECS
2080  * @param int $date Timestamp in GMT
2081  * @param float|int|string $timezone timezone to calculate GMT time offset before
2082  *        calculating user time, 99 is default user timezone
2083  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2084  * @return int
2085  */
2086 function usertime($date, $timezone=99) {
2088     $timezone = get_user_timezone_offset($timezone);
2090     if (abs($timezone) > 13) {
2091         return $date;
2092     }
2093     return $date - (int)($timezone * HOURSECS);
2096 /**
2097  * Given a time, return the GMT timestamp of the most recent midnight
2098  * for the current user.
2099  *
2100  * @package core
2101  * @category time
2102  * @param int $date Timestamp in GMT
2103  * @param float|int|string $timezone timezone to calculate GMT time offset before
2104  *        calculating user midnight time, 99 is default user timezone
2105  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2106  * @return int Returns a GMT timestamp
2107  */
2108 function usergetmidnight($date, $timezone=99) {
2110     $userdate = usergetdate($date, $timezone);
2112     // Time of midnight of this user's day, in GMT
2113     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2117 /**
2118  * Returns a string that prints the user's timezone
2119  *
2120  * @package core
2121  * @category time
2122  * @param float|int|string $timezone timezone to calculate GMT time offset before
2123  *        calculating user timezone, 99 is default user timezone
2124  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2125  * @return string
2126  */
2127 function usertimezone($timezone=99) {
2129     $tz = get_user_timezone($timezone);
2131     if (!is_float($tz)) {
2132         return $tz;
2133     }
2135     if(abs($tz) > 13) { // Server time
2136         return get_string('serverlocaltime');
2137     }
2139     if($tz == intval($tz)) {
2140         // Don't show .0 for whole hours
2141         $tz = intval($tz);
2142     }
2144     if($tz == 0) {
2145         return 'UTC';
2146     }
2147     else if($tz > 0) {
2148         return 'UTC+'.$tz;
2149     }
2150     else {
2151         return 'UTC'.$tz;
2152     }
2156 /**
2157  * Returns a float which represents the user's timezone difference from GMT in hours
2158  * Checks various settings and picks the most dominant of those which have a value
2159  *
2160  * @package core
2161  * @category time
2162  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2163  *        99 is default user timezone
2164  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2165  * @return float
2166  */
2167 function get_user_timezone_offset($tz = 99) {
2169     global $USER, $CFG;
2171     $tz = get_user_timezone($tz);
2173     if (is_float($tz)) {
2174         return $tz;
2175     } else {
2176         $tzrecord = get_timezone_record($tz);
2177         if (empty($tzrecord)) {
2178             return 99.0;
2179         }
2180         return (float)$tzrecord->gmtoff / HOURMINS;
2181     }
2184 /**
2185  * Returns an int which represents the systems's timezone difference from GMT in seconds
2186  *
2187  * @package core
2188  * @category time
2189  * @param float|int|string $tz timezone for which offset is required.
2190  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2191  * @return int|bool if found, false is timezone 99 or error
2192  */
2193 function get_timezone_offset($tz) {
2194     global $CFG;
2196     if ($tz == 99) {
2197         return false;
2198     }
2200     if (is_numeric($tz)) {
2201         return intval($tz * 60*60);
2202     }
2204     if (!$tzrecord = get_timezone_record($tz)) {
2205         return false;
2206     }
2207     return intval($tzrecord->gmtoff * 60);
2210 /**
2211  * Returns a float or a string which denotes the user's timezone
2212  * 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)
2213  * means that for this timezone there are also DST rules to be taken into account
2214  * Checks various settings and picks the most dominant of those which have a value
2215  *
2216  * @package core
2217  * @category time
2218  * @param float|int|string $tz timezone to calculate GMT time offset before
2219  *        calculating user timezone, 99 is default user timezone
2220  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2221  * @return float|string
2222  */
2223 function get_user_timezone($tz = 99) {
2224     global $USER, $CFG;
2226     $timezones = array(
2227         $tz,
2228         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2229         isset($USER->timezone) ? $USER->timezone : 99,
2230         isset($CFG->timezone) ? $CFG->timezone : 99,
2231         );
2233     $tz = 99;
2235     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
2236         $tz = $next['value'];
2237     }
2239     return is_numeric($tz) ? (float) $tz : $tz;
2242 /**
2243  * Returns cached timezone record for given $timezonename
2244  *
2245  * @package core
2246  * @param string $timezonename name of the timezone
2247  * @return stdClass|bool timezonerecord or false
2248  */
2249 function get_timezone_record($timezonename) {
2250     global $CFG, $DB;
2251     static $cache = NULL;
2253     if ($cache === NULL) {
2254         $cache = array();
2255     }
2257     if (isset($cache[$timezonename])) {
2258         return $cache[$timezonename];
2259     }
2261     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2262                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2265 /**
2266  * Build and store the users Daylight Saving Time (DST) table
2267  *
2268  * @package core
2269  * @param int $from_year Start year for the table, defaults to 1971
2270  * @param int $to_year End year for the table, defaults to 2035
2271  * @param int|float|string $strtimezone, timezone to check if dst should be applyed.
2272  * @return bool
2273  */
2274 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2275     global $CFG, $SESSION, $DB;
2277     $usertz = get_user_timezone($strtimezone);
2279     if (is_float($usertz)) {
2280         // Trivial timezone, no DST
2281         return false;
2282     }
2284     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2285         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2286         unset($SESSION->dst_offsets);
2287         unset($SESSION->dst_range);
2288     }
2290     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2291         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2292         // This will be the return path most of the time, pretty light computationally
2293         return true;
2294     }
2296     // Reaching here means we either need to extend our table or create it from scratch
2298     // Remember which TZ we calculated these changes for
2299     $SESSION->dst_offsettz = $usertz;
2301     if(empty($SESSION->dst_offsets)) {
2302         // If we 're creating from scratch, put the two guard elements in there
2303         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2304     }
2305     if(empty($SESSION->dst_range)) {
2306         // If creating from scratch
2307         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2308         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2310         // Fill in the array with the extra years we need to process
2311         $yearstoprocess = array();
2312         for($i = $from; $i <= $to; ++$i) {
2313             $yearstoprocess[] = $i;
2314         }
2316         // Take note of which years we have processed for future calls
2317         $SESSION->dst_range = array($from, $to);
2318     }
2319     else {
2320         // If needing to extend the table, do the same
2321         $yearstoprocess = array();
2323         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2324         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2326         if($from < $SESSION->dst_range[0]) {
2327             // Take note of which years we need to process and then note that we have processed them for future calls
2328             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2329                 $yearstoprocess[] = $i;
2330             }
2331             $SESSION->dst_range[0] = $from;
2332         }
2333         if($to > $SESSION->dst_range[1]) {
2334             // Take note of which years we need to process and then note that we have processed them for future calls
2335             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2336                 $yearstoprocess[] = $i;
2337             }
2338             $SESSION->dst_range[1] = $to;
2339         }
2340     }
2342     if(empty($yearstoprocess)) {
2343         // This means that there was a call requesting a SMALLER range than we have already calculated
2344         return true;
2345     }
2347     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2348     // Also, the array is sorted in descending timestamp order!
2350     // Get DB data
2352     static $presets_cache = array();
2353     if (!isset($presets_cache[$usertz])) {
2354         $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');
2355     }
2356     if(empty($presets_cache[$usertz])) {
2357         return false;
2358     }
2360     // Remove ending guard (first element of the array)
2361     reset($SESSION->dst_offsets);
2362     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2364     // Add all required change timestamps
2365     foreach($yearstoprocess as $y) {
2366         // Find the record which is in effect for the year $y
2367         foreach($presets_cache[$usertz] as $year => $preset) {
2368             if($year <= $y) {
2369                 break;
2370             }
2371         }
2373         $changes = dst_changes_for_year($y, $preset);
2375         if($changes === NULL) {
2376             continue;
2377         }
2378         if($changes['dst'] != 0) {
2379             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2380         }
2381         if($changes['std'] != 0) {
2382             $SESSION->dst_offsets[$changes['std']] = 0;
2383         }
2384     }
2386     // Put in a guard element at the top
2387     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2388     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2390     // Sort again
2391     krsort($SESSION->dst_offsets);
2393     return true;
2396 /**
2397  * Calculates the required DST change and returns a Timestamp Array
2398  *
2399  * @package core
2400  * @category time
2401  * @uses HOURSECS
2402  * @uses MINSECS
2403  * @param int|string $year Int or String Year to focus on
2404  * @param object $timezone Instatiated Timezone object
2405  * @return array|null Array dst=>xx, 0=>xx, std=>yy, 1=>yy or NULL
2406  */
2407 function dst_changes_for_year($year, $timezone) {
2409     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2410         return NULL;
2411     }
2413     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2414     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2416     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2417     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2419     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2420     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2422     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2423     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2424     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2426     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2427     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2429     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2432 /**
2433  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2434  * - Note: Daylight saving only works for string timezones and not for float.
2435  *
2436  * @package core
2437  * @category time
2438  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2439  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2440  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2441  * @return int
2442  */
2443 function dst_offset_on($time, $strtimezone = NULL) {
2444     global $SESSION;
2446     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2447         return 0;
2448     }
2450     reset($SESSION->dst_offsets);
2451     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2452         if($from <= $time) {
2453             break;
2454         }
2455     }
2457     // This is the normal return path
2458     if($offset !== NULL) {
2459         return $offset;
2460     }
2462     // Reaching this point means we haven't calculated far enough, do it now:
2463     // Calculate extra DST changes if needed and recurse. The recursion always
2464     // moves toward the stopping condition, so will always end.
2466     if($from == 0) {
2467         // We need a year smaller than $SESSION->dst_range[0]
2468         if($SESSION->dst_range[0] == 1971) {
2469             return 0;
2470         }
2471         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2472         return dst_offset_on($time, $strtimezone);
2473     }
2474     else {
2475         // We need a year larger than $SESSION->dst_range[1]
2476         if($SESSION->dst_range[1] == 2035) {
2477             return 0;
2478         }
2479         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2480         return dst_offset_on($time, $strtimezone);
2481     }
2484 /**
2485  * Calculates when the day appears in specific month
2486  *
2487  * @package core
2488  * @category time
2489  * @param int $startday starting day of the month
2490  * @param int $weekday The day when week starts (normally taken from user preferences)
2491  * @param int $month The month whose day is sought
2492  * @param int $year The year of the month whose day is sought
2493  * @return int
2494  */
2495 function find_day_in_month($startday, $weekday, $month, $year) {
2497     $daysinmonth = days_in_month($month, $year);
2499     if($weekday == -1) {
2500         // Don't care about weekday, so return:
2501         //    abs($startday) if $startday != -1
2502         //    $daysinmonth otherwise
2503         return ($startday == -1) ? $daysinmonth : abs($startday);
2504     }
2506     // From now on we 're looking for a specific weekday
2508     // Give "end of month" its actual value, since we know it
2509     if($startday == -1) {
2510         $startday = -1 * $daysinmonth;
2511     }
2513     // Starting from day $startday, the sign is the direction
2515     if($startday < 1) {
2517         $startday = abs($startday);
2518         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2520         // This is the last such weekday of the month
2521         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2522         if($lastinmonth > $daysinmonth) {
2523             $lastinmonth -= 7;
2524         }
2526         // Find the first such weekday <= $startday
2527         while($lastinmonth > $startday) {
2528             $lastinmonth -= 7;
2529         }
2531         return $lastinmonth;
2533     }
2534     else {
2536         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2538         $diff = $weekday - $indexweekday;
2539         if($diff < 0) {
2540             $diff += 7;
2541         }
2543         // This is the first such weekday of the month equal to or after $startday
2544         $firstfromindex = $startday + $diff;
2546         return $firstfromindex;
2548     }
2551 /**
2552  * Calculate the number of days in a given month
2553  *
2554  * @package core
2555  * @category time
2556  * @param int $month The month whose day count is sought
2557  * @param int $year The year of the month whose day count is sought
2558  * @return int
2559  */
2560 function days_in_month($month, $year) {
2561    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2564 /**
2565  * Calculate the position in the week of a specific calendar day
2566  *
2567  * @package core
2568  * @category time
2569  * @param int $day The day of the date whose position in the week is sought
2570  * @param int $month The month of the date whose position in the week is sought
2571  * @param int $year The year of the date whose position in the week is sought
2572  * @return int
2573  */
2574 function dayofweek($day, $month, $year) {
2575     // I wonder if this is any different from
2576     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2577     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2580 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2582 /**
2583  * Returns full login url.
2584  *
2585  * @return string login url
2586  */
2587 function get_login_url() {
2588     global $CFG;
2590     $url = "$CFG->wwwroot/login/index.php";
2592     if (!empty($CFG->loginhttps)) {
2593         $url = str_replace('http:', 'https:', $url);
2594     }
2596     return $url;
2599 /**
2600  * This function checks that the current user is logged in and has the
2601  * required privileges
2602  *
2603  * This function checks that the current user is logged in, and optionally
2604  * whether they are allowed to be in a particular course and view a particular
2605  * course module.
2606  * If they are not logged in, then it redirects them to the site login unless
2607  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2608  * case they are automatically logged in as guests.
2609  * If $courseid is given and the user is not enrolled in that course then the
2610  * user is redirected to the course enrolment page.
2611  * If $cm is given and the course module is hidden and the user is not a teacher
2612  * in the course then the user is redirected to the course home page.
2613  *
2614  * When $cm parameter specified, this function sets page layout to 'module'.
2615  * You need to change it manually later if some other layout needed.
2616  *
2617  * @param mixed $courseorid id of the course or course object
2618  * @param bool $autologinguest default true
2619  * @param object $cm course module object
2620  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2621  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2622  *             in order to keep redirects working properly. MDL-14495
2623  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2624  * @return mixed Void, exit, and die depending on path
2625  */
2626 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2627     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2629     // setup global $COURSE, themes, language and locale
2630     if (!empty($courseorid)) {
2631         if (is_object($courseorid)) {
2632             $course = $courseorid;
2633         } else if ($courseorid == SITEID) {
2634             $course = clone($SITE);
2635         } else {
2636             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2637         }
2638         if ($cm) {
2639             if ($cm->course != $course->id) {
2640                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2641             }
2642             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2643             if (!($cm instanceof cm_info)) {
2644                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2645                 // db queries so this is not really a performance concern, however it is obviously
2646                 // better if you use get_fast_modinfo to get the cm before calling this.
2647                 $modinfo = get_fast_modinfo($course);
2648                 $cm = $modinfo->get_cm($cm->id);
2649             }
2650             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2651             $PAGE->set_pagelayout('incourse');
2652         } else {
2653             $PAGE->set_course($course); // set's up global $COURSE
2654         }
2655     } else {
2656         // do not touch global $COURSE via $PAGE->set_course(),
2657         // the reasons is we need to be able to call require_login() at any time!!
2658         $course = $SITE;
2659         if ($cm) {
2660             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2661         }
2662     }
2664     // If the user is not even logged in yet then make sure they are
2665     if (!isloggedin()) {
2666         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2667             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2668                 // misconfigured site guest, just redirect to login page
2669                 redirect(get_login_url());
2670                 exit; // never reached
2671             }
2672             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2673             complete_user_login($guest);
2674             $USER->autologinguest = true;
2675             $SESSION->lang = $lang;
2676         } else {
2677             //NOTE: $USER->site check was obsoleted by session test cookie,
2678             //      $USER->confirmed test is in login/index.php
2679             if ($preventredirect) {
2680                 throw new require_login_exception('You are not logged in');
2681             }
2683             if ($setwantsurltome) {
2684                 // TODO: switch to PAGE->url
2685                 $SESSION->wantsurl = $FULLME;
2686             }
2687             if (!empty($_SERVER['HTTP_REFERER'])) {
2688                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2689             }
2690             redirect(get_login_url());
2691             exit; // never reached
2692         }
2693     }
2695     // loginas as redirection if needed
2696     if ($course->id != SITEID and session_is_loggedinas()) {
2697         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2698             if ($USER->loginascontext->instanceid != $course->id) {
2699                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2700             }
2701         }
2702     }
2704     // check whether the user should be changing password (but only if it is REALLY them)
2705     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2706         $userauth = get_auth_plugin($USER->auth);
2707         if ($userauth->can_change_password() and !$preventredirect) {
2708             $SESSION->wantsurl = $FULLME;
2709             if ($changeurl = $userauth->change_password_url()) {
2710                 //use plugin custom url
2711                 redirect($changeurl);
2712             } else {
2713                 //use moodle internal method
2714                 if (empty($CFG->loginhttps)) {
2715                     redirect($CFG->wwwroot .'/login/change_password.php');
2716                 } else {
2717                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2718                     redirect($wwwroot .'/login/change_password.php');
2719                 }
2720             }
2721         } else {
2722             print_error('nopasswordchangeforced', 'auth');
2723         }
2724     }
2726     // Check that the user account is properly set up
2727     if (user_not_fully_set_up($USER)) {
2728         if ($preventredirect) {
2729             throw new require_login_exception('User not fully set-up');
2730         }
2731         $SESSION->wantsurl = $FULLME;
2732         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2733     }
2735     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2736     sesskey();
2738     // Do not bother admins with any formalities
2739     if (is_siteadmin()) {
2740         //set accesstime or the user will appear offline which messes up messaging
2741         user_accesstime_log($course->id);
2742         return;
2743     }
2745     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2746     if (!$USER->policyagreed and !is_siteadmin()) {
2747         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2748             if ($preventredirect) {
2749                 throw new require_login_exception('Policy not agreed');
2750             }
2751             $SESSION->wantsurl = $FULLME;
2752             redirect($CFG->wwwroot .'/user/policy.php');
2753         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2754             if ($preventredirect) {
2755                 throw new require_login_exception('Policy not agreed');
2756             }
2757             $SESSION->wantsurl = $FULLME;
2758             redirect($CFG->wwwroot .'/user/policy.php');
2759         }
2760     }
2762     // Fetch the system context, the course context, and prefetch its child contexts
2763     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2764     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2765     if ($cm) {
2766         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2767     } else {
2768         $cmcontext = null;
2769     }
2771     // If the site is currently under maintenance, then print a message
2772     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2773         if ($preventredirect) {
2774             throw new require_login_exception('Maintenance in progress');
2775         }
2777         print_maintenance_message();
2778     }
2780     // make sure the course itself is not hidden
2781     if ($course->id == SITEID) {
2782         // frontpage can not be hidden
2783     } else {
2784         if (is_role_switched($course->id)) {
2785             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2786         } else {
2787             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2788                 // originally there was also test of parent category visibility,
2789                 // BUT is was very slow in complex queries involving "my courses"
2790                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2791                 if ($preventredirect) {
2792                     throw new require_login_exception('Course is hidden');
2793                 }
2794                 // We need to override the navigation URL as the course won't have
2795                 // been added to the navigation and thus the navigation will mess up
2796                 // when trying to find it.
2797                 navigation_node::override_active_url(new moodle_url('/'));
2798                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2799             }
2800         }
2801     }
2803     // is the user enrolled?
2804     if ($course->id == SITEID) {
2805         // everybody is enrolled on the frontpage
2807     } else {
2808         if (session_is_loggedinas()) {
2809             // Make sure the REAL person can access this course first
2810             $realuser = session_get_realuser();
2811             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2812                 if ($preventredirect) {
2813                     throw new require_login_exception('Invalid course login-as access');
2814                 }
2815                 echo $OUTPUT->header();
2816                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2817             }
2818         }
2820         $access = false;
2822         if (is_role_switched($course->id)) {
2823             // ok, user had to be inside this course before the switch
2824             $access = true;
2826         } else if (is_viewing($coursecontext, $USER)) {
2827             // ok, no need to mess with enrol
2828             $access = true;
2830         } else {
2831             if (isset($USER->enrol['enrolled'][$course->id])) {
2832                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2833                     $access = true;
2834                     if (isset($USER->enrol['tempguest'][$course->id])) {
2835                         unset($USER->enrol['tempguest'][$course->id]);
2836                         remove_temp_course_roles($coursecontext);
2837                     }
2838                 } else {
2839                     //expired
2840                     unset($USER->enrol['enrolled'][$course->id]);
2841                 }
2842             }
2843             if (isset($USER->enrol['tempguest'][$course->id])) {
2844                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2845                     $access = true;
2846                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2847                     $access = true;
2848                 } else {
2849                     //expired
2850                     unset($USER->enrol['tempguest'][$course->id]);
2851                     remove_temp_course_roles($coursecontext);
2852                 }
2853             }
2855             if ($access) {
2856                 // cache ok
2857             } else {
2858                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2859                 if ($until !== false) {
2860                     // active participants may always access, a timestamp in the future, 0 (always) or false.
2861                     if ($until == 0) {
2862                         $until = ENROL_MAX_TIMESTAMP;
2863                     }
2864                     $USER->enrol['enrolled'][$course->id] = $until;
2865                     $access = true;
2867                 } else {
2868                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2869                     $enrols = enrol_get_plugins(true);
2870                     // first ask all enabled enrol instances in course if they want to auto enrol user
2871                     foreach($instances as $instance) {
2872                         if (!isset($enrols[$instance->enrol])) {
2873                             continue;
2874                         }
2875                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2876                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2877                         if ($until !== false) {
2878                             if ($until == 0) {
2879                                 $until = ENROL_MAX_TIMESTAMP;
2880                             }
2881                             $USER->enrol['enrolled'][$course->id] = $until;
2882                             $access = true;
2883                             break;
2884                         }
2885                     }
2886                     // if not enrolled yet try to gain temporary guest access
2887                     if (!$access) {
2888                         foreach($instances as $instance) {
2889                             if (!isset($enrols[$instance->enrol])) {
2890                                 continue;
2891                             }
2892                             // Get a duration for the guest access, a timestamp in the future or false.
2893                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2894                             if ($until !== false and $until > time()) {
2895                                 $USER->enrol['tempguest'][$course->id] = $until;
2896                                 $access = true;
2897                                 break;
2898                             }
2899                         }
2900                     }
2901                 }
2902             }
2903         }
2905         if (!$access) {
2906             if ($preventredirect) {
2907                 throw new require_login_exception('Not enrolled');
2908             }
2909             $SESSION->wantsurl = $FULLME;
2910             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2911         }
2912     }
2914     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
2915     // conditional availability, etc
2916     if ($cm && !$cm->uservisible) {
2917         if ($preventredirect) {
2918             throw new require_login_exception('Activity is hidden');
2919         }
2920         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2921     }
2923     // Finally access granted, update lastaccess times
2924     user_accesstime_log($course->id);
2928 /**
2929  * This function just makes sure a user is logged out.
2930  *
2931  * @global object
2932  */
2933 function require_logout() {
2934     global $USER;
2936     $params = $USER;
2938     if (isloggedin()) {
2939         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2941         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2942         foreach($authsequence as $authname) {
2943             $authplugin = get_auth_plugin($authname);
2944             $authplugin->prelogout_hook();
2945         }
2946     }
2948     events_trigger('user_logout', $params);
2949     session_get_instance()->terminate_current();
2950     unset($params);
2953 /**
2954  * Weaker version of require_login()
2955  *
2956  * This is a weaker version of {@link require_login()} which only requires login
2957  * when called from within a course rather than the site page, unless
2958  * the forcelogin option is turned on.
2959  * @see require_login()
2960  *
2961  * @global object
2962  * @param mixed $courseorid The course object or id in question
2963  * @param bool $autologinguest Allow autologin guests if that is wanted
2964  * @param object $cm Course activity module if known
2965  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2966  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2967  *             in order to keep redirects working properly. MDL-14495
2968  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2969  * @return void
2970  */
2971 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2972     global $CFG, $PAGE, $SITE;
2973     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
2974           or (!is_object($courseorid) and $courseorid == SITEID);
2975     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
2976         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2977         // db queries so this is not really a performance concern, however it is obviously
2978         // better if you use get_fast_modinfo to get the cm before calling this.
2979         if (is_object($courseorid)) {
2980             $course = $courseorid;
2981         } else {
2982             $course = clone($SITE);
2983         }
2984         $modinfo = get_fast_modinfo($course);
2985         $cm = $modinfo->get_cm($cm->id);
2986     }
2987     if (!empty($CFG->forcelogin)) {
2988         // login required for both SITE and courses
2989         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2991     } else if ($issite && !empty($cm) and !$cm->uservisible) {
2992         // always login for hidden activities
2993         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2995     } else if ($issite) {
2996               //login for SITE not required
2997         if ($cm and empty($cm->visible)) {
2998             // hidden activities are not accessible without login
2999             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3000         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3001             // not-logged-in users do not have any group membership
3002             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3003         } else {
3004             // We still need to instatiate PAGE vars properly so that things
3005             // that rely on it like navigation function correctly.
3006             if (!empty($courseorid)) {
3007                 if (is_object($courseorid)) {
3008                     $course = $courseorid;
3009                 } else {
3010                     $course = clone($SITE);
3011                 }
3012                 if ($cm) {
3013                     if ($cm->course != $course->id) {
3014                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3015                     }
3016                     $PAGE->set_cm($cm, $course);
3017                     $PAGE->set_pagelayout('incourse');
3018                 } else {
3019                     $PAGE->set_course($course);
3020                 }
3021             } else {
3022                 // If $PAGE->course, and hence $PAGE->context, have not already been set
3023                 // up properly, set them up now.
3024                 $PAGE->set_course($PAGE->course);
3025             }
3026             //TODO: verify conditional activities here
3027             user_accesstime_log(SITEID);
3028             return;
3029         }
3031     } else {
3032         // course login always required
3033         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3034     }
3037 /**
3038  * Require key login. Function terminates with error if key not found or incorrect.
3039  *
3040  * @global object
3041  * @global object
3042  * @global object
3043  * @global object
3044  * @uses NO_MOODLE_COOKIES
3045  * @uses PARAM_ALPHANUM
3046  * @param string $script unique script identifier
3047  * @param int $instance optional instance id
3048  * @return int Instance ID
3049  */
3050 function require_user_key_login($script, $instance=null) {
3051     global $USER, $SESSION, $CFG, $DB;
3053     if (!NO_MOODLE_COOKIES) {
3054         print_error('sessioncookiesdisable');
3055     }
3057 /// extra safety
3058     @session_write_close();
3060     $keyvalue = required_param('key', PARAM_ALPHANUM);
3062     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3063         print_error('invalidkey');
3064     }
3066     if (!empty($key->validuntil) and $key->validuntil < time()) {
3067         print_error('expiredkey');
3068     }
3070     if ($key->iprestriction) {
3071         $remoteaddr = getremoteaddr(null);
3072         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3073             print_error('ipmismatch');
3074         }
3075     }
3077     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3078         print_error('invaliduserid');
3079     }
3081 /// emulate normal session
3082     enrol_check_plugins($user);
3083     session_set_user($user);
3085 /// note we are not using normal login
3086     if (!defined('USER_KEY_LOGIN')) {
3087         define('USER_KEY_LOGIN', true);
3088     }
3090 /// return instance id - it might be empty
3091     return $key->instance;
3094 /**
3095  * Creates a new private user access key.
3096  *
3097  * @global object
3098  * @param string $script unique target identifier
3099  * @param int $userid
3100  * @param int $instance optional instance id
3101  * @param string $iprestriction optional ip restricted access
3102  * @param timestamp $validuntil key valid only until given data
3103  * @return string access key value
3104  */
3105 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3106     global $DB;
3108     $key = new stdClass();
3109     $key->script        = $script;
3110     $key->userid        = $userid;
3111     $key->instance      = $instance;
3112     $key->iprestriction = $iprestriction;
3113     $key->validuntil    = $validuntil;
3114     $key->timecreated   = time();
3116     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3117     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3118         // must be unique
3119         $key->value     = md5($userid.'_'.time().random_string(40));
3120     }
3121     $DB->insert_record('user_private_key', $key);
3122     return $key->value;
3125 /**
3126  * Delete the user's new private user access keys for a particular script.
3127  *
3128  * @global object
3129  * @param string $script unique target identifier
3130  * @param int $userid
3131  * @return void
3132  */
3133 function delete_user_key($script,$userid) {
3134     global $DB;
3135     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3138 /**
3139  * Gets a private user access key (and creates one if one doesn't exist).
3140  *
3141  * @global object
3142  * @param string $script unique target identifier
3143  * @param int $userid
3144  * @param int $instance optional instance id
3145  * @param string $iprestriction optional ip restricted access
3146  * @param timestamp $validuntil key valid only until given data
3147  * @return string access key value
3148  */
3149 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3150     global $DB;
3152     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3153                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3154                                                          'validuntil'=>$validuntil))) {
3155         return $key->value;
3156     } else {
3157         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3158     }
3162 /**
3163  * Modify the user table by setting the currently logged in user's
3164  * last login to now.
3165  *
3166  * @global object
3167  * @global object
3168  * @return bool Always returns true
3169  */
3170 function update_user_login_times() {
3171     global $USER, $DB;
3173     $user = new stdClass();
3174     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3175     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
3177     $user->id = $USER->id;
3179     $DB->update_record('user', $user);
3180     return true;
3183 /**
3184  * Determines if a user has completed setting up their account.
3185  *
3186  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3187  * @return bool
3188  */
3189 function user_not_fully_set_up($user) {
3190     if (isguestuser($user)) {
3191         return false;
3192     }
3193     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3196 /**
3197  * Check whether the user has exceeded the bounce threshold
3198  *
3199  * @global object
3200  * @global object
3201  * @param user $user A {@link $USER} object
3202  * @return bool true=>User has exceeded bounce threshold
3203  */
3204 function over_bounce_threshold($user) {
3205     global $CFG, $DB;
3207     if (empty($CFG->handlebounces)) {
3208         return false;
3209     }
3211     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3212         return false;
3213     }
3215     // set sensible defaults
3216     if (empty($CFG->minbounces)) {
3217         $CFG->minbounces = 10;
3218     }
3219     if (empty($CFG->bounceratio)) {
3220         $CFG->bounceratio = .20;
3221     }
3222     $bouncecount = 0;
3223     $sendcount = 0;
3224     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3225         $bouncecount = $bounce->value;
3226     }
3227     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3228         $sendcount = $send->value;
3229     }
3230     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3233 /**
3234  * Used to increment or reset email sent count
3235  *
3236  * @global object
3237  * @param user $user object containing an id
3238  * @param bool $reset will reset the count to 0
3239  * @return void
3240  */
3241 function set_send_count($user,$reset=false) {
3242     global $DB;
3244     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3245         return;
3246     }
3248     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3249         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3250         $DB->update_record('user_preferences', $pref);
3251     }
3252     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3253         // make a new one
3254         $pref = new stdClass();
3255         $pref->name   = 'email_send_count';
3256         $pref->value  = 1;
3257         $pref->userid = $user->id;
3258         $DB->insert_record('user_preferences', $pref, false);
3259     }
3262 /**
3263  * Increment or reset user's email bounce count
3264  *
3265  * @global object
3266  * @param user $user object containing an id
3267  * @param bool $reset will reset the count to 0
3268  */
3269 function set_bounce_count($user,$reset=false) {
3270     global $DB;
3272     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3273         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3274         $DB->update_record('user_preferences', $pref);
3275     }
3276     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3277         // make a new one
3278         $pref = new stdClass();
3279         $pref->name   = 'email_bounce_count';
3280         $pref->value  = 1;
3281         $pref->userid = $user->id;
3282         $DB->insert_record('user_preferences', $pref, false);
3283     }
3286 /**
3287  * Keeps track of login attempts
3288  *
3289  * @global object
3290  */
3291 function update_login_count() {
3292     global $SESSION;
3294     $max_logins = 10;
3296     if (empty($SESSION->logincount)) {
3297         $SESSION->logincount = 1;
3298     } else {
3299         $SESSION->logincount++;
3300     }
3302     if ($SESSION->logincount > $max_logins) {
3303         unset($SESSION->wantsurl);
3304         print_error('errortoomanylogins');
3305     }
3308 /**
3309  * Resets login attempts
3310  *
3311  * @global object
3312  */
3313 function reset_login_count() {
3314     global $SESSION;
3316     $SESSION->logincount = 0;
3319 /**
3320  * Determines if the currently logged in user is in editing mode.
3321  * Note: originally this function had $userid parameter - it was not usable anyway
3322  *
3323  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3324  * @todo Deprecated function remove when ready
3325  *
3326  * @global object
3327  * @uses DEBUG_DEVELOPER
3328  * @return bool
3329  */
3330 function isediting() {
3331     global $PAGE;
3332     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3333     return $PAGE->user_is_editing();
3336 /**
3337  * Determines if the logged in user is currently moving an activity
3338  *
3339  * @global object
3340  * @param int $courseid The id of the course being tested
3341  * @return bool
3342  */
3343 function ismoving($courseid) {
3344     global $USER;
3346     if (!empty($USER->activitycopy)) {
3347         return ($USER->activitycopycourse == $courseid);
3348     }
3349     return false;
3352 /**
3353  * Returns a persons full name
3354  *
3355  * Given an object containing firstname and lastname
3356  * values, this function returns a string with the
3357  * full name of the person.
3358  * The result may depend on system settings
3359  * or language.  'override' will force both names
3360  * to be used even if system settings specify one.
3361  *
3362  * @global object
3363  * @global object
3364  * @param object $user A {@link $USER} object to get full name of
3365  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3366  * @return string
3367  */
3368 function fullname($user, $override=false) {
3369     global $CFG, $SESSION;
3371     if (!isset($user->firstname) and !isset($user->lastname)) {
3372         return '';
3373     }
3375     if (!$override) {
3376         if (!empty($CFG->forcefirstname)) {
3377             $user->firstname = $CFG->forcefirstname;
3378         }
3379         if (!empty($CFG->forcelastname)) {
3380             $user->lastname = $CFG->forcelastname;
3381         }
3382     }
3384     if (!empty($SESSION->fullnamedisplay)) {
3385         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3386     }
3388     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3389         return $user->firstname .' '. $user->lastname;
3391     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3392         return $user->lastname .' '. $user->firstname;
3394     } else if ($CFG->fullnamedisplay == 'firstname') {
3395         if ($override) {
3396             return get_string('fullnamedisplay', '', $user);
3397         } else {
3398             return $user->firstname;
3399         }
3400     }
3402     return get_string('fullnamedisplay', '', $user);
3405 /**
3406  * Checks if current user is shown any extra fields when listing users.
3407  * @param object $context Context
3408  * @param array $already Array of fields that we're going to show anyway
3409  *   so don't bother listing them
3410  * @return array Array of field names from user table, not including anything
3411  *   listed in $already
3412  */
3413 function get_extra_user_fields($context, $already = array()) {
3414     global $CFG;
3416     // Only users with permission get the extra fields
3417     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3418         return array();
3419     }
3421     // Split showuseridentity on comma
3422     if (empty($CFG->showuseridentity)) {
3423         // Explode gives wrong result with empty string
3424         $extra = array();
3425     } else {
3426         $extra =  explode(',', $CFG->showuseridentity);
3427     }
3428     $renumber = false;
3429     foreach ($extra as $key => $field) {
3430         if (in_array($field, $already)) {
3431             unset($extra[$key]);
3432             $renumber = true;
3433         }
3434     }
3435     if ($renumber) {
3436         // For consistency, if entries are removed from array, renumber it
3437         // so they are numbered as you would expect
3438         $extra = array_merge($extra);
3439     }
3440     return $extra;
3443 /**
3444  * If the current user is to be shown extra user fields when listing or
3445  * selecting users, returns a string suitable for including in an SQL select
3446  * clause to retrieve those fields.
3447  * @param object $context Context
3448  * @param string $alias Alias of user table, e.g. 'u' (default none)
3449  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3450  * @param array $already Array of fields that we're going to include anyway
3451  *   so don't list them (default none)
3452  * @return string Partial SQL select clause, beginning with comma, for example
3453  *   ',u.idnumber,u.department' unless it is blank
3454  */
3455 function get_extra_user_fields_sql($context, $alias='', $prefix='',
3456         $already = array()) {
3457     $fields = get_extra_user_fields($context, $already);
3458     $result = '';
3459     // Add punctuation for alias
3460     if ($alias !== '') {
3461         $alias .= '.';
3462     }
3463     foreach ($fields as $field) {
3464         $result .= ', ' . $alias . $field;
3465         if ($prefix) {
3466             $result .= ' AS ' . $prefix . $field;
3467         }
3468     }
3469     return $result;
3472 /**
3473  * Returns the display name of a field in the user table. Works for most fields
3474  * that are commonly displayed to users.
3475  * @param string $field Field name, e.g. 'phone1'
3476  * @return string Text description taken from language file, e.g. 'Phone number'
3477  */
3478 function get_user_field_name($field) {
3479     // Some fields have language strings which are not the same as field name
3480     switch ($field) {
3481         case 'phone1' : return get_string('phone');
3482     }
3483     // Otherwise just use the same lang string
3484     return get_string($field);
3487 /**
3488  * Returns whether a given authentication plugin exists.
3489  *
3490  * @global object
3491  * @param string $auth Form of authentication to check for. Defaults to the
3492  *        global setting in {@link $CFG}.
3493  * @return boolean Whether the plugin is available.
3494  */
3495 function exists_auth_plugin($auth) {
3496     global $CFG;
3498     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3499         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3500     }
3501     return false;
3504 /**
3505  * Checks if a given plugin is in the list of enabled authentication plugins.
3506  *
3507  * @param string $auth Authentication plugin.
3508  * @return boolean Whether the plugin is enabled.
3509  */
3510 function is_enabled_auth($auth) {
3511     if (empty($auth)) {
3512         return false;
3513     }
3515     $enabled = get_enabled_auth_plugins();
3517     return in_array($auth, $enabled);
3520 /**
3521  * Returns an authentication plugin instance.
3522  *
3523  * @global object
3524  * @param string $auth name of authentication plugin
3525  * @return auth_plugin_base An instance of the required authentication plugin.
3526  */
3527 function get_auth_plugin($auth) {
3528     global $CFG;
3530     // check the plugin exists first
3531     if (! exists_auth_plugin($auth)) {
3532         print_error('authpluginnotfound', 'debug', '', $auth);
3533     }
3535     // return auth plugin instance
3536     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3537     $class = "auth_plugin_$auth";
3538     return new $class;
3541 /**
3542  * Returns array of active auth plugins.
3543  *
3544  * @param bool $fix fix $CFG->auth if needed
3545  * @return array
3546  */
3547 function get_enabled_auth_plugins($fix=false) {
3548     global $CFG;
3550     $default = array('manual', 'nologin');
3552     if (empty($CFG->auth)) {
3553         $auths = array();
3554     } else {
3555         $auths = explode(',', $CFG->auth);
3556     }
3558     if ($fix) {
3559         $auths = array_unique($auths);
3560         foreach($auths as $k=>$authname) {
3561             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3562                 unset($auths[$k]);
3563             }
3564         }
3565         $newconfig = implode(',', $auths);
3566         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3567             set_config('auth', $newconfig);
3568         }
3569     }
3571     return (array_merge($default, $auths));
3574 /**
3575  * Returns true if an internal authentication method is being used.
3576  * if method not specified then, global default is assumed
3577  *
3578  * @param string $auth Form of authentication required
3579  * @return bool
3580  */
3581 function is_internal_auth($auth) {
3582     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3583     return $authplugin->is_internal();
3586 /**
3587  * Returns true if the user is a 'restored' one
3588  *
3589  * Used in the login process to inform the user
3590  * and allow him/her to reset the password
3591  *
3592  * @uses $CFG
3593  * @uses $DB
3594  * @param string $username username to be checked
3595  * @return bool
3596  */
3597 function is_restored_user($username) {
3598     global $CFG, $DB;
3600     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3603 /**
3604  * Returns an array of user fields
3605  *
3606  * @return array User field/column names
3607  */
3608 function get_user_fieldnames() {
3609     global $DB;
3611     $fieldarray = $DB->get_columns('user');
3612     unset($fieldarray['id']);
3613     $fieldarray = array_keys($fieldarray);
3615     return $fieldarray;
3618 /**
3619  * Creates a bare-bones user record
3620  *
3621  * @todo Outline auth types and provide code example
3622  *
3623  * @param string $username New user's username to add to record
3624  * @param string $password New user's password to add to record
3625  * @param string $auth Form of authentication required
3626  * @return stdClass A complete user object
3627  */
3628 function create_user_record($username, $password, $auth = 'manual') {
3629     global $CFG, $DB;
3631     //just in case check text case
3632     $username = trim(moodle_strtolower($username));
3634     $authplugin = get_auth_plugin($auth);
3636     $newuser = new stdClass();
3638     if ($newinfo = $authplugin->get_userinfo($username)) {
3639         $newinfo = truncate_userinfo($newinfo);
3640         foreach ($newinfo as $key => $value){
3641             $newuser->$key = $value;
3642         }
3643     }
3645     if (!empty($newuser->email)) {
3646         if (email_is_not_allowed($newuser->email)) {
3647             unset($newuser->email);
3648         }
3649     }
3651     if (!isset($newuser->city)) {
3652         $newuser->city = '';
3653     }
3655     $newuser->auth = $auth;
3656     $newuser->username = $username;
3658     // fix for MDL-8480
3659     // user CFG lang for user if $newuser->lang is empty
3660     // or $user->lang is not an installed language
3661     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3662         $newuser->lang = $CFG->lang;
3663     }
3664     $newuser->confirmed = 1;
3665     $newuser->lastip = getremoteaddr();
3666     $newuser->timecreated = time();
3667     $newuser->timemodified = $newuser->timecreated;
3668     $newuser->mnethostid = $CFG->mnet_localhost_id;
3670     $newuser->id = $DB->insert_record('user', $newuser);
3671     $user = get_complete_user_data('id', $newuser->id);
3672     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3673         set_user_preference('auth_forcepasswordchange', 1, $user);
3674     }
3675     update_internal_user_password($user, $password);
3677     // fetch full user record for the event, the complete user data contains too much info
3678     // and we want to be consistent with other places that trigger this event
3679     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3681     return $user;
3684 /**
3685  * Will update a local user record from an external source.
3686  * (MNET users can not be updated using this method!)
3687  *
3688  * @param string $username user's username to update the record