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