MDL-30592 moodlelib: minor phpdocs/debug tweaks
[moodle.git] / lib / moodlelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * moodlelib.php - Moodle main library
20  *
21  * Main library file of miscellaneous general-purpose Moodle functions.
22  * Other main libraries:
23  *  - weblib.php      - functions that produce web output
24  *  - datalib.php     - functions that access the database
25  *
26  * @package    core
27  * @subpackage lib
28  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
36 /// Date and time constants ///
37 /**
38  * Time constant - the number of seconds in a year
39  */
40 define('YEARSECS', 31536000);
42 /**
43  * Time constant - the number of seconds in a week
44  */
45 define('WEEKSECS', 604800);
47 /**
48  * Time constant - the number of seconds in a day
49  */
50 define('DAYSECS', 86400);
52 /**
53  * Time constant - the number of seconds in an hour
54  */
55 define('HOURSECS', 3600);
57 /**
58  * Time constant - the number of seconds in a minute
59  */
60 define('MINSECS', 60);
62 /**
63  * Time constant - the number of minutes in a day
64  */
65 define('DAYMINS', 1440);
67 /**
68  * Time constant - the number of minutes in an hour
69  */
70 define('HOURMINS', 60);
72 /// Parameter constants - every call to optional_param(), required_param()  ///
73 /// or clean_param() should have a specified type of parameter.  //////////////
77 /**
78  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
79  */
80 define('PARAM_ALPHA',    'alpha');
82 /**
83  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
84  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
85  */
86 define('PARAM_ALPHAEXT', 'alphaext');
88 /**
89  * PARAM_ALPHANUM - expected numbers and letters only.
90  */
91 define('PARAM_ALPHANUM', 'alphanum');
93 /**
94  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
95  */
96 define('PARAM_ALPHANUMEXT', 'alphanumext');
98 /**
99  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
100  */
101 define('PARAM_AUTH',  'auth');
103 /**
104  * PARAM_BASE64 - Base 64 encoded format
105  */
106 define('PARAM_BASE64',   'base64');
108 /**
109  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
110  */
111 define('PARAM_BOOL',     'bool');
113 /**
114  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
115  * checked against the list of capabilities in the database.
116  */
117 define('PARAM_CAPABILITY',   'capability');
119 /**
120  * PARAM_CLEANHTML - cleans submitted HTML code. use only for text in HTML format. This cleaning may fix xhtml strictness too.
121  */
122 define('PARAM_CLEANHTML', 'cleanhtml');
124 /**
125  * PARAM_EMAIL - an email address following the RFC
126  */
127 define('PARAM_EMAIL',   'email');
129 /**
130  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
131  */
132 define('PARAM_FILE',   'file');
134 /**
135  * PARAM_FLOAT - a real/floating point number.
136  */
137 define('PARAM_FLOAT',  'float');
139 /**
140  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
141  */
142 define('PARAM_HOST',     'host');
144 /**
145  * PARAM_INT - integers only, use when expecting only numbers.
146  */
147 define('PARAM_INT',      'int');
149 /**
150  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
151  */
152 define('PARAM_LANG',  'lang');
154 /**
155  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the others! Implies PARAM_URL!)
156  */
157 define('PARAM_LOCALURL', 'localurl');
159 /**
160  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
161  */
162 define('PARAM_NOTAGS',   'notags');
164 /**
165  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
166  * note: the leading slash is not removed, window drive letter is not allowed
167  */
168 define('PARAM_PATH',     'path');
170 /**
171  * PARAM_PEM - Privacy Enhanced Mail format
172  */
173 define('PARAM_PEM',      'pem');
175 /**
176  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
177  */
178 define('PARAM_PERMISSION',   'permission');
180 /**
181  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
182  */
183 define('PARAM_RAW', 'raw');
185 /**
186  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
187  */
188 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
190 /**
191  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
192  */
193 define('PARAM_SAFEDIR',  'safedir');
195 /**
196  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
197  */
198 define('PARAM_SAFEPATH',  'safepath');
200 /**
201  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
202  */
203 define('PARAM_SEQUENCE',  'sequence');
205 /**
206  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
207  */
208 define('PARAM_TAG',   'tag');
210 /**
211  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
212  */
213 define('PARAM_TAGLIST',   'taglist');
215 /**
216  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
217  */
218 define('PARAM_TEXT',  'text');
220 /**
221  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
222  */
223 define('PARAM_THEME',  'theme');
225 /**
226  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
227  */
228 define('PARAM_URL',      'url');
230 /**
231  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
232  */
233 define('PARAM_USERNAME',    'username');
235 /**
236  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
237  */
238 define('PARAM_STRINGID',    'stringid');
240 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
241 /**
242  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
243  * It was one of the first types, that is why it is abused so much ;-)
244  * @deprecated since 2.0
245  */
246 define('PARAM_CLEAN',    'clean');
248 /**
249  * PARAM_INTEGER - deprecated alias for PARAM_INT
250  */
251 define('PARAM_INTEGER',  'int');
253 /**
254  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
255  */
256 define('PARAM_NUMBER',  'float');
258 /**
259  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
260  * NOTE: originally alias for PARAM_APLHA
261  */
262 define('PARAM_ACTION',   'alphanumext');
264 /**
265  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
266  * NOTE: originally alias for PARAM_APLHA
267  */
268 define('PARAM_FORMAT',   'alphanumext');
270 /**
271  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
272  */
273 define('PARAM_MULTILANG',  'text');
275 /**
276  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
277  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
278  * America/Port-au-Prince)
279  */
280 define('PARAM_TIMEZONE', 'timezone');
282 /**
283  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
284  */
285 define('PARAM_CLEANFILE', 'file');
287 /**
288  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
289  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
290  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
291  * NOTE: numbers and underscores are strongly discouraged in plugin names!
292  */
293 define('PARAM_COMPONENT', 'component');
295 /**
296  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
297  * It is usually used together with context id and component.
298  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
299  */
300 define('PARAM_AREA', 'area');
302 /**
303  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
304  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
305  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
306  */
307 define('PARAM_PLUGIN', 'plugin');
310 /// Web Services ///
312 /**
313  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
314  */
315 define('VALUE_REQUIRED', 1);
317 /**
318  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
319  */
320 define('VALUE_OPTIONAL', 2);
322 /**
323  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
324  */
325 define('VALUE_DEFAULT', 0);
327 /**
328  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
329  */
330 define('NULL_NOT_ALLOWED', false);
332 /**
333  * NULL_ALLOWED - the parameter can be set to null in the database
334  */
335 define('NULL_ALLOWED', true);
337 /// Page types ///
338 /**
339  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
340  */
341 define('PAGE_COURSE_VIEW', 'course-view');
343 /** Get remote addr constant */
344 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
345 /** Get remote addr constant */
346 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
348 /// Blog access level constant declaration ///
349 define ('BLOG_USER_LEVEL', 1);
350 define ('BLOG_GROUP_LEVEL', 2);
351 define ('BLOG_COURSE_LEVEL', 3);
352 define ('BLOG_SITE_LEVEL', 4);
353 define ('BLOG_GLOBAL_LEVEL', 5);
356 ///Tag constants///
357 /**
358  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
359  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
360  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
361  *
362  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
363  */
364 define('TAG_MAX_LENGTH', 50);
366 /// Password policy constants ///
367 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
368 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
369 define ('PASSWORD_DIGITS', '0123456789');
370 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
372 /// Feature constants ///
373 // Used for plugin_supports() to report features that are, or are not, supported by a module.
375 /** True if module can provide a grade */
376 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
377 /** True if module supports outcomes */
378 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
379 /** True if module supports advanced grading methods */
380 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
382 /** True if module has code to track whether somebody viewed it */
383 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
384 /** True if module has custom completion rules */
385 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
387 /** True if module has no 'view' page (like label) */
388 define('FEATURE_NO_VIEW_LINK', 'viewlink');
389 /** True if module supports outcomes */
390 define('FEATURE_IDNUMBER', 'idnumber');
391 /** True if module supports groups */
392 define('FEATURE_GROUPS', 'groups');
393 /** True if module supports groupings */
394 define('FEATURE_GROUPINGS', 'groupings');
395 /** True if module supports groupmembersonly */
396 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
398 /** Type of module */
399 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
400 /** True if module supports intro editor */
401 define('FEATURE_MOD_INTRO', 'mod_intro');
402 /** True if module has default completion */
403 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
405 define('FEATURE_COMMENT', 'comment');
407 define('FEATURE_RATE', 'rate');
408 /** True if module supports backup/restore of moodle2 format */
409 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
411 /** True if module can show description on course main page */
412 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
414 /** Unspecified module archetype */
415 define('MOD_ARCHETYPE_OTHER', 0);
416 /** Resource-like type module */
417 define('MOD_ARCHETYPE_RESOURCE', 1);
418 /** Assignment module archetype */
419 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
421 /**
422  * Security token used for allowing access
423  * from external application such as web services.
424  * Scripts do not use any session, performance is relatively
425  * low because we need to load access info in each request.
426  * Scripts are executed in parallel.
427  */
428 define('EXTERNAL_TOKEN_PERMANENT', 0);
430 /**
431  * Security token used for allowing access
432  * of embedded applications, the code is executed in the
433  * active user session. Token is invalidated after user logs out.
434  * Scripts are executed serially - normal session locking is used.
435  */
436 define('EXTERNAL_TOKEN_EMBEDDED', 1);
438 /**
439  * The home page should be the site home
440  */
441 define('HOMEPAGE_SITE', 0);
442 /**
443  * The home page should be the users my page
444  */
445 define('HOMEPAGE_MY', 1);
446 /**
447  * The home page can be chosen by the user
448  */
449 define('HOMEPAGE_USER', 2);
451 /**
452  * Hub directory url (should be moodle.org)
453  */
454 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
457 /**
458  * Moodle.org url (should be moodle.org)
459  */
460 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
462 /**
463  * Moodle mobile app service name
464  */
465 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
467 /// PARAMETER HANDLING ////////////////////////////////////////////////////
469 /**
470  * Returns a particular value for the named variable, taken from
471  * POST or GET.  If the parameter doesn't exist then an error is
472  * thrown because we require this variable.
473  *
474  * This function should be used to initialise all required values
475  * in a script that are based on parameters.  Usually it will be
476  * used like this:
477  *    $id = required_param('id', PARAM_INT);
478  *
479  * Please note the $type parameter is now required and the value can not be array.
480  *
481  * @param string $parname the name of the page parameter we want
482  * @param string $type expected type of parameter
483  * @return mixed
484  */
485 function required_param($parname, $type) {
486     if (func_num_args() != 2 or empty($parname) or empty($type)) {
487         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
488     }
489     if (isset($_POST[$parname])) {       // POST has precedence
490         $param = $_POST[$parname];
491     } else if (isset($_GET[$parname])) {
492         $param = $_GET[$parname];
493     } else {
494         print_error('missingparam', '', '', $parname);
495     }
497     if (is_array($param)) {
498         debugging('Invalid array parameter detected in required_param(): '.$parname);
499         // TODO: switch to fatal error in Moodle 2.3
500         //print_error('missingparam', '', '', $parname);
501         return required_param_array($parname, $type);
502     }
504     return clean_param($param, $type);
507 /**
508  * Returns a particular array value for the named variable, taken from
509  * POST or GET.  If the parameter doesn't exist then an error is
510  * thrown because we require this variable.
511  *
512  * This function should be used to initialise all required values
513  * in a script that are based on parameters.  Usually it will be
514  * used like this:
515  *    $ids = required_param_array('ids', PARAM_INT);
516  *
517  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
518  *
519  * @param string $parname the name of the page parameter we want
520  * @param string $type expected type of parameter
521  * @return array
522  */
523 function required_param_array($parname, $type) {
524     if (func_num_args() != 2 or empty($parname) or empty($type)) {
525         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
526     }
527     if (isset($_POST[$parname])) {       // POST has precedence
528         $param = $_POST[$parname];
529     } else if (isset($_GET[$parname])) {
530         $param = $_GET[$parname];
531     } else {
532         print_error('missingparam', '', '', $parname);
533     }
534     if (!is_array($param)) {
535         print_error('missingparam', '', '', $parname);
536     }
538     $result = array();
539     foreach($param as $key=>$value) {
540         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
541             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
542             continue;
543         }
544         $result[$key] = clean_param($value, $type);
545     }
547     return $result;
550 /**
551  * Returns a particular value for the named variable, taken from
552  * POST or GET, otherwise returning a given default.
553  *
554  * This function should be used to initialise all optional values
555  * in a script that are based on parameters.  Usually it will be
556  * used like this:
557  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
558  *
559  * Please note the $type parameter is now required and the value can not be array.
560  *
561  * @param string $parname the name of the page parameter we want
562  * @param mixed  $default the default value to return if nothing is found
563  * @param string $type expected type of parameter
564  * @return mixed
565  */
566 function optional_param($parname, $default, $type) {
567     if (func_num_args() != 3 or empty($parname) or empty($type)) {
568         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
569     }
570     if (!isset($default)) {
571         $default = null;
572     }
574     if (isset($_POST[$parname])) {       // POST has precedence
575         $param = $_POST[$parname];
576     } else if (isset($_GET[$parname])) {
577         $param = $_GET[$parname];
578     } else {
579         return $default;
580     }
582     if (is_array($param)) {
583         debugging('Invalid array parameter detected in required_param(): '.$parname);
584         // TODO: switch to $default in Moodle 2.3
585         //return $default;
586         return optional_param_array($parname, $default, $type);
587     }
589     return clean_param($param, $type);
592 /**
593  * Returns a particular array value for the named variable, taken from
594  * POST or GET, otherwise returning a given default.
595  *
596  * This function should be used to initialise all optional values
597  * in a script that are based on parameters.  Usually it will be
598  * used like this:
599  *    $ids = optional_param('id', array(), PARAM_INT);
600  *
601  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
602  *
603  * @param string $parname the name of the page parameter we want
604  * @param mixed  $default the default value to return if nothing is found
605  * @param string $type expected type of parameter
606  * @return array
607  */
608 function optional_param_array($parname, $default, $type) {
609     if (func_num_args() != 3 or empty($parname) or empty($type)) {
610         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
611     }
613     if (isset($_POST[$parname])) {       // POST has precedence
614         $param = $_POST[$parname];
615     } else if (isset($_GET[$parname])) {
616         $param = $_GET[$parname];
617     } else {
618         return $default;
619     }
620     if (!is_array($param)) {
621         debugging('optional_param_array() expects array parameters only: '.$parname);
622         return $default;
623     }
625     $result = array();
626     foreach($param as $key=>$value) {
627         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
628             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
629             continue;
630         }
631         $result[$key] = clean_param($value, $type);
632     }
634     return $result;
637 /**
638  * Strict validation of parameter values, the values are only converted
639  * to requested PHP type. Internally it is using clean_param, the values
640  * before and after cleaning must be equal - otherwise
641  * an invalid_parameter_exception is thrown.
642  * Objects and classes are not accepted.
643  *
644  * @param mixed $param
645  * @param string $type PARAM_ constant
646  * @param bool $allownull are nulls valid value?
647  * @param string $debuginfo optional debug information
648  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
649  */
650 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
651     if (is_null($param)) {
652         if ($allownull == NULL_ALLOWED) {
653             return null;
654         } else {
655             throw new invalid_parameter_exception($debuginfo);
656         }
657     }
658     if (is_array($param) or is_object($param)) {
659         throw new invalid_parameter_exception($debuginfo);
660     }
662     $cleaned = clean_param($param, $type);
663     if ((string)$param !== (string)$cleaned) {
664         // conversion to string is usually lossless
665         throw new invalid_parameter_exception($debuginfo);
666     }
668     return $cleaned;
671 /**
672  * Makes sure array contains only the allowed types,
673  * this function does not validate array key names!
674  * <code>
675  * $options = clean_param($options, PARAM_INT);
676  * </code>
677  *
678  * @param array $param the variable array we are cleaning
679  * @param string $type expected format of param after cleaning.
680  * @param bool $recursive clean recursive arrays
681  * @return array
682  */
683 function clean_param_array(array $param = null, $type, $recursive = false) {
684     $param = (array)$param; // convert null to empty array
685     foreach ($param as $key => $value) {
686         if (is_array($value)) {
687             if ($recursive) {
688                 $param[$key] = clean_param_array($value, $type, true);
689             } else {
690                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
691             }
692         } else {
693             $param[$key] = clean_param($value, $type);
694         }
695     }
696     return $param;
699 /**
700  * Used by {@link optional_param()} and {@link required_param()} to
701  * clean the variables and/or cast to specific types, based on
702  * an options field.
703  * <code>
704  * $course->format = clean_param($course->format, PARAM_ALPHA);
705  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
706  * </code>
707  *
708  * @param mixed $param the variable we are cleaning
709  * @param string $type expected format of param after cleaning.
710  * @return mixed
711  */
712 function clean_param($param, $type) {
714     global $CFG;
716     if (is_array($param)) {
717         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
718     } else if (is_object($param)) {
719         if (method_exists($param, '__toString')) {
720             $param = $param->__toString();
721         } else {
722             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
723         }
724     }
726     switch ($type) {
727         case PARAM_RAW:          // no cleaning at all
728             $param = fix_utf8($param);
729             return $param;
731         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
732             $param = fix_utf8($param);
733             return trim($param);
735         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
736             // this is deprecated!, please use more specific type instead
737             if (is_numeric($param)) {
738                 return $param;
739             }
740             $param = fix_utf8($param);
741             return clean_text($param);     // Sweep for scripts, etc
743         case PARAM_CLEANHTML:    // clean html fragment
744             $param = fix_utf8($param);
745             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
746             return trim($param);
748         case PARAM_INT:
749             return (int)$param;  // Convert to integer
751         case PARAM_FLOAT:
752         case PARAM_NUMBER:
753             return (float)$param;  // Convert to float
755         case PARAM_ALPHA:        // Remove everything not a-z
756             return preg_replace('/[^a-zA-Z]/i', '', $param);
758         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
759             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
761         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
762             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
764         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
765             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
767         case PARAM_SEQUENCE:     // Remove everything not 0-9,
768             return preg_replace('/[^0-9,]/i', '', $param);
770         case PARAM_BOOL:         // Convert to 1 or 0
771             $tempstr = strtolower($param);
772             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
773                 $param = 1;
774             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
775                 $param = 0;
776             } else {
777                 $param = empty($param) ? 0 : 1;
778             }
779             return $param;
781         case PARAM_NOTAGS:       // Strip all tags
782             $param = fix_utf8($param);
783             return strip_tags($param);
785         case PARAM_TEXT:    // leave only tags needed for multilang
786             $param = fix_utf8($param);
787             // if the multilang syntax is not correct we strip all tags
788             // because it would break xhtml strict which is required for accessibility standards
789             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
790             do {
791                 if (strpos($param, '</lang>') !== false) {
792                     // old and future mutilang syntax
793                     $param = strip_tags($param, '<lang>');
794                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
795                         break;
796                     }
797                     $open = false;
798                     foreach ($matches[0] as $match) {
799                         if ($match === '</lang>') {
800                             if ($open) {
801                                 $open = false;
802                                 continue;
803                             } else {
804                                 break 2;
805                             }
806                         }
807                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
808                             break 2;
809                         } else {
810                             $open = true;
811                         }
812                     }
813                     if ($open) {
814                         break;
815                     }
816                     return $param;
818                 } else if (strpos($param, '</span>') !== false) {
819                     // current problematic multilang syntax
820                     $param = strip_tags($param, '<span>');
821                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
822                         break;
823                     }
824                     $open = false;
825                     foreach ($matches[0] as $match) {
826                         if ($match === '</span>') {
827                             if ($open) {
828                                 $open = false;
829                                 continue;
830                             } else {
831                                 break 2;
832                             }
833                         }
834                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
835                             break 2;
836                         } else {
837                             $open = true;
838                         }
839                     }
840                     if ($open) {
841                         break;
842                     }
843                     return $param;
844                 }
845             } while (false);
846             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
847             return strip_tags($param);
849         case PARAM_COMPONENT:
850             // we do not want any guessing here, either the name is correct or not
851             // please note only normalised component names are accepted
852             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
853                 return '';
854             }
855             if (strpos($param, '__') !== false) {
856                 return '';
857             }
858             if (strpos($param, 'mod_') === 0) {
859                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
860                 if (substr_count($param, '_') != 1) {
861                     return '';
862                 }
863             }
864             return $param;
866         case PARAM_PLUGIN:
867         case PARAM_AREA:
868             // we do not want any guessing here, either the name is correct or not
869             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
870                 return '';
871             }
872             if (strpos($param, '__') !== false) {
873                 return '';
874             }
875             return $param;
877         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
878             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
880         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
881             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
883         case PARAM_FILE:         // Strip all suspicious characters from filename
884             $param = fix_utf8($param);
885             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
886             $param = preg_replace('~\.\.+~', '', $param);
887             if ($param === '.') {
888                 $param = '';
889             }
890             return $param;
892         case PARAM_PATH:         // Strip all suspicious characters from file path
893             $param = fix_utf8($param);
894             $param = str_replace('\\', '/', $param);
895             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
896             $param = preg_replace('~\.\.+~', '', $param);
897             $param = preg_replace('~//+~', '/', $param);
898             return preg_replace('~/(\./)+~', '/', $param);
900         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
901             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
902             // match ipv4 dotted quad
903             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
904                 // confirm values are ok
905                 if ( $match[0] > 255
906                      || $match[1] > 255
907                      || $match[3] > 255
908                      || $match[4] > 255 ) {
909                     // hmmm, what kind of dotted quad is this?
910                     $param = '';
911                 }
912             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
913                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
914                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
915                        ) {
916                 // all is ok - $param is respected
917             } else {
918                 // all is not ok...
919                 $param='';
920             }
921             return $param;
923         case PARAM_URL:          // allow safe ftp, http, mailto urls
924             $param = fix_utf8($param);
925             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
926             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
927                 // all is ok, param is respected
928             } else {
929                 $param =''; // not really ok
930             }
931             return $param;
933         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
934             $param = clean_param($param, PARAM_URL);
935             if (!empty($param)) {
936                 if (preg_match(':^/:', $param)) {
937                     // root-relative, ok!
938                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
939                     // absolute, and matches our wwwroot
940                 } else {
941                     // relative - let's make sure there are no tricks
942                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
943                         // looks ok.
944                     } else {
945                         $param = '';
946                     }
947                 }
948             }
949             return $param;
951         case PARAM_PEM:
952             $param = trim($param);
953             // PEM formatted strings may contain letters/numbers and the symbols
954             // forward slash: /
955             // plus sign:     +
956             // equal sign:    =
957             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
958             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
959                 list($wholething, $body) = $matches;
960                 unset($wholething, $matches);
961                 $b64 = clean_param($body, PARAM_BASE64);
962                 if (!empty($b64)) {
963                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
964                 } else {
965                     return '';
966                 }
967             }
968             return '';
970         case PARAM_BASE64:
971             if (!empty($param)) {
972                 // PEM formatted strings may contain letters/numbers and the symbols
973                 // forward slash: /
974                 // plus sign:     +
975                 // equal sign:    =
976                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
977                     return '';
978                 }
979                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
980                 // Each line of base64 encoded data must be 64 characters in
981                 // length, except for the last line which may be less than (or
982                 // equal to) 64 characters long.
983                 for ($i=0, $j=count($lines); $i < $j; $i++) {
984                     if ($i + 1 == $j) {
985                         if (64 < strlen($lines[$i])) {
986                             return '';
987                         }
988                         continue;
989                     }
991                     if (64 != strlen($lines[$i])) {
992                         return '';
993                     }
994                 }
995                 return implode("\n",$lines);
996             } else {
997                 return '';
998             }
1000         case PARAM_TAG:
1001             $param = fix_utf8($param);
1002             // Please note it is not safe to use the tag name directly anywhere,
1003             // it must be processed with s(), urlencode() before embedding anywhere.
1004             // remove some nasties
1005             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1006             //convert many whitespace chars into one
1007             $param = preg_replace('/\s+/', ' ', $param);
1008             $textlib = textlib_get_instance();
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 = moodle_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 null;
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 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
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  * @param stdClass $user user object, preferences are preloaded into ->preference property
1568  * @param int $cachelifetime cache life time on the current page (ins seconds)
1569  * @return void
1570  */
1571 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1572     global $DB;
1573     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1575     if (!isset($user->id)) {
1576         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1577     }
1579     if (empty($user->id) or isguestuser($user->id)) {
1580         // No permanent storage for not-logged-in users and guest
1581         if (!isset($user->preference)) {
1582             $user->preference = array();
1583         }
1584         return;
1585     }
1587     $timenow = time();
1589     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1590         // Already loaded at least once on this page. Are we up to date?
1591         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1592             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1593             return;
1595         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1596             // no change since the lastcheck on this page
1597             $user->preference['_lastloaded'] = $timenow;
1598             return;
1599         }
1600     }
1602     // OK, so we have to reload all preferences
1603     $loadedusers[$user->id] = true;
1604     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1605     $user->preference['_lastloaded'] = $timenow;
1608 /**
1609  * Called from set/delete_user_preferences, so that the prefs can
1610  * be correctly reloaded in different sessions.
1611  *
1612  * NOTE: internal function, do not call from other code.
1613  *
1614  * @param integer $userid the user whose prefs were changed.
1615  * @return void
1616  */
1617 function mark_user_preferences_changed($userid) {
1618     global $CFG;
1620     if (empty($userid) or isguestuser($userid)) {
1621         // no cache flags for guest and not-logged-in users
1622         return;
1623     }
1625     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1628 /**
1629  * Sets a preference for the specified user.
1630  *
1631  * If user object submitted, 'preference' property contains the preferences cache.
1632  *
1633  * @param string $name The key to set as preference for the specified user
1634  * @param string $value The value to set for the $name key in the specified user's record,
1635  *                      null means delete current value
1636  * @param stdClass|int $user A moodle user object or id, null means current user
1637  * @return bool always true or exception
1638  */
1639 function set_user_preference($name, $value, $user = null) {
1640     global $USER, $DB;
1642     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1643         throw new coding_exception('Invalid preference name in set_user_preference() call');
1644     }
1646     if (is_null($value)) {
1647         // null means delete current
1648         return unset_user_preference($name, $user);
1649     } else if (is_object($value)) {
1650         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1651     } else if (is_array($value)) {
1652         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1653     }
1654     $value = (string)$value;
1656     if (is_null($user)) {
1657         $user = $USER;
1658     } else if (isset($user->id)) {
1659         // $user is valid object
1660     } else if (is_numeric($user)) {
1661         $user = (object)array('id'=>(int)$user);
1662     } else {
1663         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1664     }
1666     check_user_preferences_loaded($user);
1668     if (empty($user->id) or isguestuser($user->id)) {
1669         // no permanent storage for not-logged-in users and guest
1670         $user->preference[$name] = $value;
1671         return true;
1672     }
1674     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1675         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1676             // preference already set to this value
1677             return true;
1678         }
1679         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1681     } else {
1682         $preference = new stdClass();
1683         $preference->userid = $user->id;
1684         $preference->name   = $name;
1685         $preference->value  = $value;
1686         $DB->insert_record('user_preferences', $preference);
1687     }
1689     // update value in cache
1690     $user->preference[$name] = $value;
1692     // set reload flag for other sessions
1693     mark_user_preferences_changed($user->id);
1695     return true;
1698 /**
1699  * Sets a whole array of preferences for the current user
1700  *
1701  * If user object submitted, 'preference' property contains the preferences cache.
1702  *
1703  * @param array $prefarray An array of key/value pairs to be set
1704  * @param stdClass|int $user A moodle user object or id, null means current user
1705  * @return bool always true or exception
1706  */
1707 function set_user_preferences(array $prefarray, $user = null) {
1708     foreach ($prefarray as $name => $value) {
1709         set_user_preference($name, $value, $user);
1710     }
1711     return true;
1714 /**
1715  * Unsets a preference completely by deleting it from the database
1716  *
1717  * If user object submitted, 'preference' property contains the preferences cache.
1718  *
1719  * @param string  $name The key to unset as preference for the specified user
1720  * @param stdClass|int $user A moodle user object or id, null means current user
1721  * @return bool always true or exception
1722  */
1723 function unset_user_preference($name, $user = null) {
1724     global $USER, $DB;
1726     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1727         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1728     }
1730     if (is_null($user)) {
1731         $user = $USER;
1732     } else if (isset($user->id)) {
1733         // $user is valid object
1734     } else if (is_numeric($user)) {
1735         $user = (object)array('id'=>(int)$user);
1736     } else {
1737         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1738     }
1740     check_user_preferences_loaded($user);
1742     if (empty($user->id) or isguestuser($user->id)) {
1743         // no permanent storage for not-logged-in user and guest
1744         unset($user->preference[$name]);
1745         return true;
1746     }
1748     // delete from DB
1749     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1751     // delete the preference from cache
1752     unset($user->preference[$name]);
1754     // set reload flag for other sessions
1755     mark_user_preferences_changed($user->id);
1757     return true;
1760 /**
1761  * Used to fetch user preference(s)
1762  *
1763  * If no arguments are supplied this function will return
1764  * all of the current user preferences as an array.
1765  *
1766  * If a name is specified then this function
1767  * attempts to return that particular preference value.  If
1768  * none is found, then the optional value $default is returned,
1769  * otherwise NULL.
1770  *
1771  * If user object submitted, 'preference' property contains the preferences cache.
1772  *
1773  * @param string $name Name of the key to use in finding a preference value
1774  * @param mixed $default Value to be returned if the $name key is not set in the user preferences
1775  * @param stdClass|int $user A moodle user object or id, null means current user
1776  * @return mixed string value or default
1777  */
1778 function get_user_preferences($name = null, $default = null, $user = null) {
1779     global $USER;
1781     if (is_null($name)) {
1782         // all prefs
1783     } else if (is_numeric($name) or $name === '_lastloaded') {
1784         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1785     }
1787     if (is_null($user)) {
1788         $user = $USER;
1789     } else if (isset($user->id)) {
1790         // $user is valid object
1791     } else if (is_numeric($user)) {
1792         $user = (object)array('id'=>(int)$user);
1793     } else {
1794         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1795     }
1797     check_user_preferences_loaded($user);
1799     if (empty($name)) {
1800         return $user->preference; // All values
1801     } else if (isset($user->preference[$name])) {
1802         return $user->preference[$name]; // The single string value
1803     } else {
1804         return $default; // Default value (null if not specified)
1805     }
1808 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1810 /**
1811  * Given date parts in user time produce a GMT timestamp.
1812  *
1813  * @todo Finish documenting this function
1814  * @param int $year The year part to create timestamp of
1815  * @param int $month The month part to create timestamp of
1816  * @param int $day The day part to create timestamp of
1817  * @param int $hour The hour part to create timestamp of
1818  * @param int $minute The minute part to create timestamp of
1819  * @param int $second The second part to create timestamp of
1820  * @param mixed $timezone Timezone modifier, if 99 then use default user's timezone
1821  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1822  *             applied only if timezone is 99 or string.
1823  * @return int timestamp
1824  */
1825 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1827     //save input timezone, required for dst offset check.
1828     $passedtimezone = $timezone;
1830     $timezone = get_user_timezone_offset($timezone);
1832     if (abs($timezone) > 13) {  //server time
1833         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1834     } else {
1835         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1836         $time = usertime($time, $timezone);
1838         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1839         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1840             $time -= dst_offset_on($time, $passedtimezone);
1841         }
1842     }
1844     return $time;
1848 /**
1849  * Format a date/time (seconds) as weeks, days, hours etc as needed
1850  *
1851  * Given an amount of time in seconds, returns string
1852  * formatted nicely as weeks, days, hours etc as needed
1853  *
1854  * @uses MINSECS
1855  * @uses HOURSECS
1856  * @uses DAYSECS
1857  * @uses YEARSECS
1858  * @param int $totalsecs Time in seconds
1859  * @param object $str Should be a time object
1860  * @return string A nicely formatted date/time string
1861  */
1862  function format_time($totalsecs, $str=NULL) {
1864     $totalsecs = abs($totalsecs);
1866     if (!$str) {  // Create the str structure the slow way
1867         $str->day   = get_string('day');
1868         $str->days  = get_string('days');
1869         $str->hour  = get_string('hour');
1870         $str->hours = get_string('hours');
1871         $str->min   = get_string('min');
1872         $str->mins  = get_string('mins');
1873         $str->sec   = get_string('sec');
1874         $str->secs  = get_string('secs');
1875         $str->year  = get_string('year');
1876         $str->years = get_string('years');
1877     }
1880     $years     = floor($totalsecs/YEARSECS);
1881     $remainder = $totalsecs - ($years*YEARSECS);
1882     $days      = floor($remainder/DAYSECS);
1883     $remainder = $totalsecs - ($days*DAYSECS);
1884     $hours     = floor($remainder/HOURSECS);
1885     $remainder = $remainder - ($hours*HOURSECS);
1886     $mins      = floor($remainder/MINSECS);
1887     $secs      = $remainder - ($mins*MINSECS);
1889     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1890     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1891     $sh = ($hours == 1) ? $str->hour : $str->hours;
1892     $sd = ($days == 1)  ? $str->day  : $str->days;
1893     $sy = ($years == 1)  ? $str->year  : $str->years;
1895     $oyears = '';
1896     $odays = '';
1897     $ohours = '';
1898     $omins = '';
1899     $osecs = '';
1901     if ($years)  $oyears  = $years .' '. $sy;
1902     if ($days)  $odays  = $days .' '. $sd;
1903     if ($hours) $ohours = $hours .' '. $sh;
1904     if ($mins)  $omins  = $mins .' '. $sm;
1905     if ($secs)  $osecs  = $secs .' '. $ss;
1907     if ($years) return trim($oyears .' '. $odays);
1908     if ($days)  return trim($odays .' '. $ohours);
1909     if ($hours) return trim($ohours .' '. $omins);
1910     if ($mins)  return trim($omins .' '. $osecs);
1911     if ($secs)  return $osecs;
1912     return get_string('now');
1915 /**
1916  * Returns a formatted string that represents a date in user time
1917  *
1918  * Returns a formatted string that represents a date in user time
1919  * <b>WARNING: note that the format is for strftime(), not date().</b>
1920  * Because of a bug in most Windows time libraries, we can't use
1921  * the nicer %e, so we have to use %d which has leading zeroes.
1922  * A lot of the fuss in the function is just getting rid of these leading
1923  * zeroes as efficiently as possible.
1924  *
1925  * If parameter fixday = true (default), then take off leading
1926  * zero from %d, else maintain it.
1927  *
1928  * @param int $date the timestamp in UTC, as obtained from the database.
1929  * @param string $format strftime format. You should probably get this using
1930  *      get_string('strftime...', 'langconfig');
1931  * @param mixed $timezone by default, uses the user's time zone. if numeric and
1932  *      not 99 then daylight saving will not be added.
1933  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1934  *      If false then the leading zero is maintained.
1935  * @return string the formatted date/time.
1936  */
1937 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1939     global $CFG;
1941     if (empty($format)) {
1942         $format = get_string('strftimedaydatetime', 'langconfig');
1943     }
1945     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1946         $fixday = false;
1947     } else if ($fixday) {
1948         $formatnoday = str_replace('%d', 'DD', $format);
1949         $fixday = ($formatnoday != $format);
1950     }
1952     //add daylight saving offset for string timezones only, as we can't get dst for
1953     //float values. if timezone is 99 (user default timezone), then try update dst.
1954     if ((99 == $timezone) || !is_numeric($timezone)) {
1955         $date += dst_offset_on($date, $timezone);
1956     }
1958     $timezone = get_user_timezone_offset($timezone);
1960     if (abs($timezone) > 13) {   /// Server time
1961         if ($fixday) {
1962             $datestring = strftime($formatnoday, $date);
1963             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1964             $datestring = str_replace('DD', $daystring, $datestring);
1965         } else {
1966             $datestring = strftime($format, $date);
1967         }
1968     } else {
1969         $date += (int)($timezone * 3600);
1970         if ($fixday) {
1971             $datestring = gmstrftime($formatnoday, $date);
1972             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1973             $datestring = str_replace('DD', $daystring, $datestring);
1974         } else {
1975             $datestring = gmstrftime($format, $date);
1976         }
1977     }
1979 /// If we are running under Windows convert from windows encoding to UTF-8
1980 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1982    if ($CFG->ostype == 'WINDOWS') {
1983        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1984            $textlib = textlib_get_instance();
1985            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1986        }
1987    }
1989     return $datestring;
1992 /**
1993  * Given a $time timestamp in GMT (seconds since epoch),
1994  * returns an array that represents the date in user time
1995  *
1996  * @todo Finish documenting this function
1997  * @uses HOURSECS
1998  * @param int $time Timestamp in GMT
1999  * @param mixed $timezone offset time with timezone, if float and not 99, then no
2000  *        dst offset is applyed
2001  * @return array An array that represents the date in user time
2002  */
2003 function usergetdate($time, $timezone=99) {
2005     //save input timezone, required for dst offset check.
2006     $passedtimezone = $timezone;
2008     $timezone = get_user_timezone_offset($timezone);
2010     if (abs($timezone) > 13) {    // Server time
2011         return getdate($time);
2012     }
2014     //add daylight saving offset for string timezones only, as we can't get dst for
2015     //float values. if timezone is 99 (user default timezone), then try update dst.
2016     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2017         $time += dst_offset_on($time, $passedtimezone);
2018     }
2020     $time += intval((float)$timezone * HOURSECS);
2022     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2024     //be careful to ensure the returned array matches that produced by getdate() above
2025     list(
2026         $getdate['month'],
2027         $getdate['weekday'],
2028         $getdate['yday'],
2029         $getdate['year'],
2030         $getdate['mon'],
2031         $getdate['wday'],
2032         $getdate['mday'],
2033         $getdate['hours'],
2034         $getdate['minutes'],
2035         $getdate['seconds']
2036     ) = explode('_', $datestring);
2038     return $getdate;
2041 /**
2042  * Given a GMT timestamp (seconds since epoch), offsets it by
2043  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2044  *
2045  * @uses HOURSECS
2046  * @param  int $date Timestamp in GMT
2047  * @param float $timezone
2048  * @return int
2049  */
2050 function usertime($date, $timezone=99) {
2052     $timezone = get_user_timezone_offset($timezone);
2054     if (abs($timezone) > 13) {
2055         return $date;
2056     }
2057     return $date - (int)($timezone * HOURSECS);
2060 /**
2061  * Given a time, return the GMT timestamp of the most recent midnight
2062  * for the current user.
2063  *
2064  * @param int $date Timestamp in GMT
2065  * @param float $timezone Defaults to user's timezone
2066  * @return int Returns a GMT timestamp
2067  */
2068 function usergetmidnight($date, $timezone=99) {
2070     $userdate = usergetdate($date, $timezone);
2072     // Time of midnight of this user's day, in GMT
2073     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2077 /**
2078  * Returns a string that prints the user's timezone
2079  *
2080  * @param float $timezone The user's timezone
2081  * @return string
2082  */
2083 function usertimezone($timezone=99) {
2085     $tz = get_user_timezone($timezone);
2087     if (!is_float($tz)) {
2088         return $tz;
2089     }
2091     if(abs($tz) > 13) { // Server time
2092         return get_string('serverlocaltime');
2093     }
2095     if($tz == intval($tz)) {
2096         // Don't show .0 for whole hours
2097         $tz = intval($tz);
2098     }
2100     if($tz == 0) {
2101         return 'UTC';
2102     }
2103     else if($tz > 0) {
2104         return 'UTC+'.$tz;
2105     }
2106     else {
2107         return 'UTC'.$tz;
2108     }
2112 /**
2113  * Returns a float which represents the user's timezone difference from GMT in hours
2114  * Checks various settings and picks the most dominant of those which have a value
2115  *
2116  * @global object
2117  * @global object
2118  * @param float $tz If this value is provided and not equal to 99, it will be returned as is and no other settings will be checked
2119  * @return float
2120  */
2121 function get_user_timezone_offset($tz = 99) {
2123     global $USER, $CFG;
2125     $tz = get_user_timezone($tz);
2127     if (is_float($tz)) {
2128         return $tz;
2129     } else {
2130         $tzrecord = get_timezone_record($tz);
2131         if (empty($tzrecord)) {
2132             return 99.0;
2133         }
2134         return (float)$tzrecord->gmtoff / HOURMINS;
2135     }
2138 /**
2139  * Returns an int which represents the systems's timezone difference from GMT in seconds
2140  *
2141  * @global object
2142  * @param mixed $tz timezone
2143  * @return int if found, false is timezone 99 or error
2144  */
2145 function get_timezone_offset($tz) {
2146     global $CFG;
2148     if ($tz == 99) {
2149         return false;
2150     }
2152     if (is_numeric($tz)) {
2153         return intval($tz * 60*60);
2154     }
2156     if (!$tzrecord = get_timezone_record($tz)) {
2157         return false;
2158     }
2159     return intval($tzrecord->gmtoff * 60);
2162 /**
2163  * Returns a float or a string which denotes the user's timezone
2164  * 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)
2165  * means that for this timezone there are also DST rules to be taken into account
2166  * Checks various settings and picks the most dominant of those which have a value
2167  *
2168  * @global object
2169  * @global object
2170  * @param mixed $tz If this value is provided and not equal to 99, it will be returned as is and no other settings will be checked
2171  * @return mixed
2172  */
2173 function get_user_timezone($tz = 99) {
2174     global $USER, $CFG;
2176     $timezones = array(
2177         $tz,
2178         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2179         isset($USER->timezone) ? $USER->timezone : 99,
2180         isset($CFG->timezone) ? $CFG->timezone : 99,
2181         );
2183     $tz = 99;
2185     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
2186         $tz = $next['value'];
2187     }
2189     return is_numeric($tz) ? (float) $tz : $tz;
2192 /**
2193  * Returns cached timezone record for given $timezonename
2194  *
2195  * @global object
2196  * @global object
2197  * @param string $timezonename
2198  * @return mixed timezonerecord object or false
2199  */
2200 function get_timezone_record($timezonename) {
2201     global $CFG, $DB;
2202     static $cache = NULL;
2204     if ($cache === NULL) {
2205         $cache = array();
2206     }
2208     if (isset($cache[$timezonename])) {
2209         return $cache[$timezonename];
2210     }
2212     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2213                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
2216 /**
2217  * Build and store the users Daylight Saving Time (DST) table
2218  *
2219  * @global object
2220  * @global object
2221  * @global object
2222  * @param mixed $from_year Start year for the table, defaults to 1971
2223  * @param mixed $to_year End year for the table, defaults to 2035
2224  * @param mixed $strtimezone, if null or 99 then user's default timezone is used
2225  * @return bool
2226  */
2227 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2228     global $CFG, $SESSION, $DB;
2230     $usertz = get_user_timezone($strtimezone);
2232     if (is_float($usertz)) {
2233         // Trivial timezone, no DST
2234         return false;
2235     }
2237     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2238         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2239         unset($SESSION->dst_offsets);
2240         unset($SESSION->dst_range);
2241     }
2243     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2244         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2245         // This will be the return path most of the time, pretty light computationally
2246         return true;
2247     }
2249     // Reaching here means we either need to extend our table or create it from scratch
2251     // Remember which TZ we calculated these changes for
2252     $SESSION->dst_offsettz = $usertz;
2254     if(empty($SESSION->dst_offsets)) {
2255         // If we 're creating from scratch, put the two guard elements in there
2256         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2257     }
2258     if(empty($SESSION->dst_range)) {
2259         // If creating from scratch
2260         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2261         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2263         // Fill in the array with the extra years we need to process
2264         $yearstoprocess = array();
2265         for($i = $from; $i <= $to; ++$i) {
2266             $yearstoprocess[] = $i;
2267         }
2269         // Take note of which years we have processed for future calls
2270         $SESSION->dst_range = array($from, $to);
2271     }
2272     else {
2273         // If needing to extend the table, do the same
2274         $yearstoprocess = array();
2276         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2277         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2279         if($from < $SESSION->dst_range[0]) {
2280             // Take note of which years we need to process and then note that we have processed them for future calls
2281             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2282                 $yearstoprocess[] = $i;
2283             }
2284             $SESSION->dst_range[0] = $from;
2285         }
2286         if($to > $SESSION->dst_range[1]) {
2287             // Take note of which years we need to process and then note that we have processed them for future calls
2288             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2289                 $yearstoprocess[] = $i;
2290             }
2291             $SESSION->dst_range[1] = $to;
2292         }
2293     }
2295     if(empty($yearstoprocess)) {
2296         // This means that there was a call requesting a SMALLER range than we have already calculated
2297         return true;
2298     }
2300     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2301     // Also, the array is sorted in descending timestamp order!
2303     // Get DB data
2305     static $presets_cache = array();
2306     if (!isset($presets_cache[$usertz])) {
2307         $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');
2308     }
2309     if(empty($presets_cache[$usertz])) {
2310         return false;
2311     }
2313     // Remove ending guard (first element of the array)
2314     reset($SESSION->dst_offsets);
2315     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2317     // Add all required change timestamps
2318     foreach($yearstoprocess as $y) {
2319         // Find the record which is in effect for the year $y
2320         foreach($presets_cache[$usertz] as $year => $preset) {
2321             if($year <= $y) {
2322                 break;
2323             }
2324         }
2326         $changes = dst_changes_for_year($y, $preset);
2328         if($changes === NULL) {
2329             continue;
2330         }
2331         if($changes['dst'] != 0) {
2332             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2333         }
2334         if($changes['std'] != 0) {
2335             $SESSION->dst_offsets[$changes['std']] = 0;
2336         }
2337     }
2339     // Put in a guard element at the top
2340     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2341     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2343     // Sort again
2344     krsort($SESSION->dst_offsets);
2346     return true;
2349 /**
2350  * Calculates the required DST change and returns a Timestamp Array
2351  *
2352  * @uses HOURSECS
2353  * @uses MINSECS
2354  * @param mixed $year Int or String Year to focus on
2355  * @param object $timezone Instatiated Timezone object
2356  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
2357  */
2358 function dst_changes_for_year($year, $timezone) {
2360     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2361         return NULL;
2362     }
2364     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2365     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2367     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2368     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2370     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2371     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2373     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2374     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2375     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2377     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2378     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2380     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2383 /**
2384  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2385  * - Note: Daylight saving only works for string timezones and not for float.
2386  *
2387  * @global object
2388  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2389  * @param mixed $strtimezone timezone for which offset is expected, if 99 or null
2390  *        then user's default timezone is used.
2391  * @return int
2392  */
2393 function dst_offset_on($time, $strtimezone = NULL) {
2394     global $SESSION;
2396     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2397         return 0;
2398     }
2400     reset($SESSION->dst_offsets);
2401     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2402         if($from <= $time) {
2403             break;
2404         }
2405     }
2407     // This is the normal return path
2408     if($offset !== NULL) {
2409         return $offset;
2410     }
2412     // Reaching this point means we haven't calculated far enough, do it now:
2413     // Calculate extra DST changes if needed and recurse. The recursion always
2414     // moves toward the stopping condition, so will always end.
2416     if($from == 0) {
2417         // We need a year smaller than $SESSION->dst_range[0]
2418         if($SESSION->dst_range[0] == 1971) {
2419             return 0;
2420         }
2421         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2422         return dst_offset_on($time, $strtimezone);
2423     }
2424     else {
2425         // We need a year larger than $SESSION->dst_range[1]
2426         if($SESSION->dst_range[1] == 2035) {
2427             return 0;
2428         }
2429         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2430         return dst_offset_on($time, $strtimezone);
2431     }
2434 /**
2435  * ?
2436  *
2437  * @todo Document what this function does
2438  * @param int $startday
2439  * @param int $weekday
2440  * @param int $month
2441  * @param int $year
2442  * @return int
2443  */
2444 function find_day_in_month($startday, $weekday, $month, $year) {
2446     $daysinmonth = days_in_month($month, $year);
2448     if($weekday == -1) {
2449         // Don't care about weekday, so return:
2450         //    abs($startday) if $startday != -1
2451         //    $daysinmonth otherwise
2452         return ($startday == -1) ? $daysinmonth : abs($startday);
2453     }
2455     // From now on we 're looking for a specific weekday
2457     // Give "end of month" its actual value, since we know it
2458     if($startday == -1) {
2459         $startday = -1 * $daysinmonth;
2460     }
2462     // Starting from day $startday, the sign is the direction
2464     if($startday < 1) {
2466         $startday = abs($startday);
2467         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2469         // This is the last such weekday of the month
2470         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2471         if($lastinmonth > $daysinmonth) {
2472             $lastinmonth -= 7;
2473         }
2475         // Find the first such weekday <= $startday
2476         while($lastinmonth > $startday) {
2477             $lastinmonth -= 7;
2478         }
2480         return $lastinmonth;
2482     }
2483     else {
2485         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2487         $diff = $weekday - $indexweekday;
2488         if($diff < 0) {
2489             $diff += 7;
2490         }
2492         // This is the first such weekday of the month equal to or after $startday
2493         $firstfromindex = $startday + $diff;
2495         return $firstfromindex;
2497     }
2500 /**
2501  * Calculate the number of days in a given month
2502  *
2503  * @param int $month The month whose day count is sought
2504  * @param int $year The year of the month whose day count is sought
2505  * @return int
2506  */
2507 function days_in_month($month, $year) {
2508    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2511 /**
2512  * Calculate the position in the week of a specific calendar day
2513  *
2514  * @param int $day The day of the date whose position in the week is sought
2515  * @param int $month The month of the date whose position in the week is sought
2516  * @param int $year The year of the date whose position in the week is sought
2517  * @return int
2518  */
2519 function dayofweek($day, $month, $year) {
2520     // I wonder if this is any different from
2521     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2522     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2525 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2527 /**
2528  * Returns full login url.
2529  *
2530  * @return string login url
2531  */
2532 function get_login_url() {
2533     global $CFG;
2535     $url = "$CFG->wwwroot/login/index.php";
2537     if (!empty($CFG->loginhttps)) {
2538         $url = str_replace('http:', 'https:', $url);
2539     }
2541     return $url;
2544 /**
2545  * This function checks that the current user is logged in and has the
2546  * required privileges
2547  *
2548  * This function checks that the current user is logged in, and optionally
2549  * whether they are allowed to be in a particular course and view a particular
2550  * course module.
2551  * If they are not logged in, then it redirects them to the site login unless
2552  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2553  * case they are automatically logged in as guests.
2554  * If $courseid is given and the user is not enrolled in that course then the
2555  * user is redirected to the course enrolment page.
2556  * If $cm is given and the course module is hidden and the user is not a teacher
2557  * in the course then the user is redirected to the course home page.
2558  *
2559  * When $cm parameter specified, this function sets page layout to 'module'.
2560  * You need to change it manually later if some other layout needed.
2561  *
2562  * @param mixed $courseorid id of the course or course object
2563  * @param bool $autologinguest default true
2564  * @param object $cm course module object
2565  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2566  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2567  *             in order to keep redirects working properly. MDL-14495
2568  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2569  * @return mixed Void, exit, and die depending on path
2570  */
2571 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2572     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2574     // setup global $COURSE, themes, language and locale
2575     if (!empty($courseorid)) {
2576         if (is_object($courseorid)) {
2577             $course = $courseorid;
2578         } else if ($courseorid == SITEID) {
2579             $course = clone($SITE);
2580         } else {
2581             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2582         }
2583         if ($cm) {
2584             if ($cm->course != $course->id) {
2585                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2586             }
2587             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2588             if (!($cm instanceof cm_info)) {
2589                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2590                 // db queries so this is not really a performance concern, however it is obviously
2591                 // better if you use get_fast_modinfo to get the cm before calling this.
2592                 $modinfo = get_fast_modinfo($course);
2593                 $cm = $modinfo->get_cm($cm->id);
2594             }
2595             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2596             $PAGE->set_pagelayout('incourse');
2597         } else {
2598             $PAGE->set_course($course); // set's up global $COURSE
2599         }
2600     } else {
2601         // do not touch global $COURSE via $PAGE->set_course(),
2602         // the reasons is we need to be able to call require_login() at any time!!
2603         $course = $SITE;
2604         if ($cm) {
2605             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2606         }
2607     }
2609     // If the user is not even logged in yet then make sure they are
2610     if (!isloggedin()) {
2611         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2612             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2613                 // misconfigured site guest, just redirect to login page
2614                 redirect(get_login_url());
2615                 exit; // never reached
2616             }
2617             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2618             complete_user_login($guest);
2619             $USER->autologinguest = true;
2620             $SESSION->lang = $lang;
2621         } else {
2622             //NOTE: $USER->site check was obsoleted by session test cookie,
2623             //      $USER->confirmed test is in login/index.php
2624             if ($preventredirect) {
2625                 throw new require_login_exception('You are not logged in');
2626             }
2628             if ($setwantsurltome) {
2629                 // TODO: switch to PAGE->url
2630                 $SESSION->wantsurl = $FULLME;
2631             }
2632             if (!empty($_SERVER['HTTP_REFERER'])) {
2633                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2634             }
2635             redirect(get_login_url());
2636             exit; // never reached
2637         }
2638     }
2640     // loginas as redirection if needed
2641     if ($course->id != SITEID and session_is_loggedinas()) {
2642         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2643             if ($USER->loginascontext->instanceid != $course->id) {
2644                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2645             }
2646         }
2647     }
2649     // check whether the user should be changing password (but only if it is REALLY them)
2650     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2651         $userauth = get_auth_plugin($USER->auth);
2652         if ($userauth->can_change_password() and !$preventredirect) {
2653             $SESSION->wantsurl = $FULLME;
2654             if ($changeurl = $userauth->change_password_url()) {
2655                 //use plugin custom url
2656                 redirect($changeurl);
2657             } else {
2658                 //use moodle internal method
2659                 if (empty($CFG->loginhttps)) {
2660                     redirect($CFG->wwwroot .'/login/change_password.php');
2661                 } else {
2662                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2663                     redirect($wwwroot .'/login/change_password.php');
2664                 }
2665             }
2666         } else {
2667             print_error('nopasswordchangeforced', 'auth');
2668         }
2669     }
2671     // Check that the user account is properly set up
2672     if (user_not_fully_set_up($USER)) {
2673         if ($preventredirect) {
2674             throw new require_login_exception('User not fully set-up');
2675         }
2676         $SESSION->wantsurl = $FULLME;
2677         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2678     }
2680     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2681     sesskey();
2683     // Do not bother admins with any formalities
2684     if (is_siteadmin()) {
2685         //set accesstime or the user will appear offline which messes up messaging
2686         user_accesstime_log($course->id);
2687         return;
2688     }
2690     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2691     if (!$USER->policyagreed and !is_siteadmin()) {
2692         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2693             if ($preventredirect) {
2694                 throw new require_login_exception('Policy not agreed');
2695             }
2696             $SESSION->wantsurl = $FULLME;
2697             redirect($CFG->wwwroot .'/user/policy.php');
2698         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2699             if ($preventredirect) {
2700                 throw new require_login_exception('Policy not agreed');
2701             }
2702             $SESSION->wantsurl = $FULLME;
2703             redirect($CFG->wwwroot .'/user/policy.php');
2704         }
2705     }
2707     // Fetch the system context, the course context, and prefetch its child contexts
2708     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2709     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2710     if ($cm) {
2711         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2712     } else {
2713         $cmcontext = null;
2714     }
2716     // If the site is currently under maintenance, then print a message
2717     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2718         if ($preventredirect) {
2719             throw new require_login_exception('Maintenance in progress');
2720         }
2722         print_maintenance_message();
2723     }
2725     // make sure the course itself is not hidden
2726     if ($course->id == SITEID) {
2727         // frontpage can not be hidden
2728     } else {
2729         if (is_role_switched($course->id)) {
2730             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2731         } else {
2732             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2733                 // originally there was also test of parent category visibility,
2734                 // BUT is was very slow in complex queries involving "my courses"
2735                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2736                 if ($preventredirect) {
2737                     throw new require_login_exception('Course is hidden');
2738                 }
2739                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2740             }
2741         }
2742     }
2744     // is the user enrolled?
2745     if ($course->id == SITEID) {
2746         // everybody is enrolled on the frontpage
2748     } else {
2749         if (session_is_loggedinas()) {
2750             // Make sure the REAL person can access this course first
2751             $realuser = session_get_realuser();
2752             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2753                 if ($preventredirect) {
2754                     throw new require_login_exception('Invalid course login-as access');
2755                 }
2756                 echo $OUTPUT->header();
2757                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2758             }
2759         }
2761         $access = false;
2763         if (is_role_switched($course->id)) {
2764             // ok, user had to be inside this course before the switch
2765             $access = true;
2767         } else if (is_viewing($coursecontext, $USER)) {
2768             // ok, no need to mess with enrol
2769             $access = true;
2771         } else {
2772             if (isset($USER->enrol['enrolled'][$course->id])) {
2773                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2774                     $access = true;
2775                     if (isset($USER->enrol['tempguest'][$course->id])) {
2776                         unset($USER->enrol['tempguest'][$course->id]);
2777                         remove_temp_course_roles($coursecontext);
2778                     }
2779                 } else {
2780                     //expired
2781                     unset($USER->enrol['enrolled'][$course->id]);
2782                 }
2783             }
2784             if (isset($USER->enrol['tempguest'][$course->id])) {
2785                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2786                     $access = true;
2787                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2788                     $access = true;
2789                 } else {
2790                     //expired
2791                     unset($USER->enrol['tempguest'][$course->id]);
2792                     remove_temp_course_roles($coursecontext);
2793                 }
2794             }
2796             if ($access) {
2797                 // cache ok
2798             } else {
2799                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2800                 if ($until !== false) {
2801                     // active participants may always access, a timestamp in the future, 0 (always) or false.
2802                     if ($until == 0) {
2803                         $until = ENROL_MAX_TIMESTAMP;
2804                     }
2805                     $USER->enrol['enrolled'][$course->id] = $until;
2806                     $access = true;
2808                 } else {
2809                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2810                     $enrols = enrol_get_plugins(true);
2811                     // first ask all enabled enrol instances in course if they want to auto enrol user
2812                     foreach($instances as $instance) {
2813                         if (!isset($enrols[$instance->enrol])) {
2814                             continue;
2815                         }
2816                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2817                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2818                         if ($until !== false) {
2819                             if ($until == 0) {
2820                                 $until = ENROL_MAX_TIMESTAMP;
2821                             }
2822                             $USER->enrol['enrolled'][$course->id] = $until;
2823                             $access = true;
2824                             break;
2825                         }
2826                     }
2827                     // if not enrolled yet try to gain temporary guest access
2828                     if (!$access) {
2829                         foreach($instances as $instance) {
2830                             if (!isset($enrols[$instance->enrol])) {
2831                                 continue;
2832                             }
2833                             // Get a duration for the guest access, a timestamp in the future or false.
2834                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2835                             if ($until !== false and $until > time()) {
2836                                 $USER->enrol['tempguest'][$course->id] = $until;
2837                                 $access = true;
2838                                 break;
2839                             }
2840                         }
2841                     }
2842                 }
2843             }
2844         }
2846         if (!$access) {
2847             if ($preventredirect) {
2848                 throw new require_login_exception('Not enrolled');
2849             }
2850             $SESSION->wantsurl = $FULLME;
2851             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2852         }
2853     }
2855     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
2856     // conditional availability, etc
2857     if ($cm && !$cm->uservisible) {
2858         if ($preventredirect) {
2859             throw new require_login_exception('Activity is hidden');
2860         }
2861         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2862     }
2864     // Finally access granted, update lastaccess times
2865     user_accesstime_log($course->id);
2869 /**
2870  * This function just makes sure a user is logged out.
2871  *
2872  * @global object
2873  */
2874 function require_logout() {
2875     global $USER;
2877     $params = $USER;
2879     if (isloggedin()) {
2880         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2882         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2883         foreach($authsequence as $authname) {
2884             $authplugin = get_auth_plugin($authname);
2885             $authplugin->prelogout_hook();
2886         }
2887     }
2889     events_trigger('user_logout', $params);
2890     session_get_instance()->terminate_current();
2891     unset($params);
2894 /**
2895  * Weaker version of require_login()
2896  *
2897  * This is a weaker version of {@link require_login()} which only requires login
2898  * when called from within a course rather than the site page, unless
2899  * the forcelogin option is turned on.
2900  * @see require_login()
2901  *
2902  * @global object
2903  * @param mixed $courseorid The course object or id in question
2904  * @param bool $autologinguest Allow autologin guests if that is wanted
2905  * @param object $cm Course activity module if known
2906  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2907  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2908  *             in order to keep redirects working properly. MDL-14495
2909  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2910  * @return void
2911  */
2912 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2913     global $CFG, $PAGE, $SITE;
2914     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
2915           or (!is_object($courseorid) and $courseorid == SITEID);
2916     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
2917         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2918         // db queries so this is not really a performance concern, however it is obviously
2919         // better if you use get_fast_modinfo to get the cm before calling this.
2920         if (is_object($courseorid)) {
2921             $course = $courseorid;
2922         } else {
2923             $course = clone($SITE);
2924         }
2925         $modinfo = get_fast_modinfo($course);
2926         $cm = $modinfo->get_cm($cm->id);
2927     }
2928     if (!empty($CFG->forcelogin)) {
2929         // login required for both SITE and courses
2930         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2932     } else if ($issite && !empty($cm) and !$cm->uservisible) {
2933         // always login for hidden activities
2934         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2936     } else if ($issite) {
2937               //login for SITE not required
2938         if ($cm and empty($cm->visible)) {
2939             // hidden activities are not accessible without login
2940             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2941         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2942             // not-logged-in users do not have any group membership
2943             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2944         } else {
2945             // We still need to instatiate PAGE vars properly so that things
2946             // that rely on it like navigation function correctly.
2947             if (!empty($courseorid)) {
2948                 if (is_object($courseorid)) {
2949                     $course = $courseorid;
2950                 } else {
2951                     $course = clone($SITE);
2952                 }
2953                 if ($cm) {
2954                     if ($cm->course != $course->id) {
2955                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2956                     }
2957                     $PAGE->set_cm($cm, $course);
2958                     $PAGE->set_pagelayout('incourse');
2959                 } else {
2960                     $PAGE->set_course($course);
2961                 }
2962             } else {
2963                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2964                 // up properly, set them up now.
2965                 $PAGE->set_course($PAGE->course);
2966             }
2967             //TODO: verify conditional activities here
2968             user_accesstime_log(SITEID);
2969             return;
2970         }
2972     } else {
2973         // course login always required
2974         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2975     }
2978 /**
2979  * Require key login. Function terminates with error if key not found or incorrect.
2980  *
2981  * @global object
2982  * @global object
2983  * @global object
2984  * @global object
2985  * @uses NO_MOODLE_COOKIES
2986  * @uses PARAM_ALPHANUM
2987  * @param string $script unique script identifier
2988  * @param int $instance optional instance id
2989  * @return int Instance ID
2990  */
2991 function require_user_key_login($script, $instance=null) {
2992     global $USER, $SESSION, $CFG, $DB;
2994     if (!NO_MOODLE_COOKIES) {
2995         print_error('sessioncookiesdisable');
2996     }
2998 /// extra safety
2999     @session_write_close();
3001     $keyvalue = required_param('key', PARAM_ALPHANUM);
3003     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3004         print_error('invalidkey');
3005     }
3007     if (!empty($key->validuntil) and $key->validuntil < time()) {
3008         print_error('expiredkey');
3009     }
3011     if ($key->iprestriction) {
3012         $remoteaddr = getremoteaddr(null);
3013         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3014             print_error('ipmismatch');
3015         }
3016     }
3018     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3019         print_error('invaliduserid');
3020     }
3022 /// emulate normal session
3023     enrol_check_plugins($user);
3024     session_set_user($user);
3026 /// note we are not using normal login
3027     if (!defined('USER_KEY_LOGIN')) {
3028         define('USER_KEY_LOGIN', true);
3029     }
3031 /// return instance id - it might be empty
3032     return $key->instance;
3035 /**
3036  * Creates a new private user access key.
3037  *
3038  * @global object
3039  * @param string $script unique target identifier
3040  * @param int $userid
3041  * @param int $instance optional instance id
3042  * @param string $iprestriction optional ip restricted access
3043  * @param timestamp $validuntil key valid only until given data
3044  * @return string access key value
3045  */
3046 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3047     global $DB;
3049     $key = new stdClass();
3050     $key->script        = $script;
3051     $key->userid        = $userid;
3052     $key->instance      = $instance;
3053     $key->iprestriction = $iprestriction;
3054     $key->validuntil    = $validuntil;
3055     $key->timecreated   = time();
3057     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3058     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3059         // must be unique
3060         $key->value     = md5($userid.'_'.time().random_string(40));
3061     }
3062     $DB->insert_record('user_private_key', $key);
3063     return $key->value;
3066 /**
3067  * Delete the user's new private user access keys for a particular script.
3068  *
3069  * @global object
3070  * @param string $script unique target identifier
3071  * @param int $userid
3072  * @return void
3073  */
3074 function delete_user_key($script,$userid) {
3075     global $DB;
3076     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3079 /**
3080  * Gets a private user access key (and creates one if one doesn't exist).
3081  *
3082  * @global object
3083  * @param string $script unique target identifier
3084  * @param int $userid
3085  * @param int $instance optional instance id
3086  * @param string $iprestriction optional ip restricted access
3087  * @param timestamp $validuntil key valid only until given data
3088  * @return string access key value
3089  */
3090 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3091     global $DB;
3093     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3094                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3095                                                          'validuntil'=>$validuntil))) {
3096         return $key->value;
3097     } else {
3098         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3099     }
3103 /**
3104  * Modify the user table by setting the currently logged in user's
3105  * last login to now.
3106  *
3107  * @global object
3108  * @global object
3109  * @return bool Always returns true
3110  */
3111 function update_user_login_times() {
3112     global $USER, $DB;
3114     $user = new stdClass();
3115     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3116     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
3118     $user->id = $USER->id;
3120     $DB->update_record('user', $user);
3121     return true;
3124 /**
3125  * Determines if a user has completed setting up their account.
3126  *
3127  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3128  * @return bool
3129  */
3130 function user_not_fully_set_up($user) {
3131     if (isguestuser($user)) {
3132         return false;
3133     }
3134     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3137 /**
3138  * Check whether the user has exceeded the bounce threshold
3139  *
3140  * @global object
3141  * @global object
3142  * @param user $user A {@link $USER} object
3143  * @return bool true=>User has exceeded bounce threshold
3144  */
3145 function over_bounce_threshold($user) {
3146     global $CFG, $DB;
3148     if (empty($CFG->handlebounces)) {
3149         return false;
3150     }
3152     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3153         return false;
3154     }
3156     // set sensible defaults
3157     if (empty($CFG->minbounces)) {
3158         $CFG->minbounces = 10;
3159     }
3160     if (empty($CFG->bounceratio)) {
3161         $CFG->bounceratio = .20;
3162     }
3163     $bouncecount = 0;
3164     $sendcount = 0;
3165     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3166         $bouncecount = $bounce->value;
3167     }
3168     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3169         $sendcount = $send->value;
3170     }
3171     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3174 /**
3175  * Used to increment or reset email sent count
3176  *
3177  * @global object
3178  * @param user $user object containing an id
3179  * @param bool $reset will reset the count to 0
3180  * @return void
3181  */
3182 function set_send_count($user,$reset=false) {
3183     global $DB;
3185     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3186         return;
3187     }
3189     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3190         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3191         $DB->update_record('user_preferences', $pref);
3192     }
3193     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3194         // make a new one
3195         $pref = new stdClass();
3196         $pref->name   = 'email_send_count';
3197         $pref->value  = 1;
3198         $pref->userid = $user->id;
3199         $DB->insert_record('user_preferences', $pref, false);
3200     }
3203 /**
3204  * Increment or reset user's email bounce count
3205  *
3206  * @global object
3207  * @param user $user object containing an id
3208  * @param bool $reset will reset the count to 0
3209  */
3210 function set_bounce_count($user,$reset=false) {
3211     global $DB;
3213     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3214         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3215         $DB->update_record('user_preferences', $pref);
3216     }
3217     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3218         // make a new one
3219         $pref = new stdClass();
3220         $pref->name   = 'email_bounce_count';
3221         $pref->value  = 1;
3222         $pref->userid = $user->id;
3223         $DB->insert_record('user_preferences', $pref, false);
3224     }
3227 /**
3228  * Keeps track of login attempts
3229  *
3230  * @global object
3231  */
3232 function update_login_count() {
3233     global $SESSION;
3235     $max_logins = 10;
3237     if (empty($SESSION->logincount)) {
3238         $SESSION->logincount = 1;
3239     } else {
3240         $SESSION->logincount++;
3241     }
3243     if ($SESSION->logincount > $max_logins) {
3244         unset($SESSION->wantsurl);
3245         print_error('errortoomanylogins');
3246     }
3249 /**
3250  * Resets login attempts
3251  *
3252  * @global object
3253  */
3254 function reset_login_count() {
3255     global $SESSION;
3257     $SESSION->logincount = 0;
3260 /**
3261  * Determines if the currently logged in user is in editing mode.
3262  * Note: originally this function had $userid parameter - it was not usable anyway
3263  *
3264  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3265  * @todo Deprecated function remove when ready
3266  *
3267  * @global object
3268  * @uses DEBUG_DEVELOPER
3269  * @return bool
3270  */
3271 function isediting() {
3272     global $PAGE;
3273     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3274     return $PAGE->user_is_editing();
3277 /**
3278  * Determines if the logged in user is currently moving an activity
3279  *
3280  * @global object
3281  * @param int $courseid The id of the course being tested
3282  * @return bool
3283  */
3284 function ismoving($courseid) {
3285     global $USER;
3287     if (!empty($USER->activitycopy)) {
3288         return ($USER->activitycopycourse == $courseid);
3289     }
3290     return false;
3293 /**
3294  * Returns a persons full name
3295  *
3296  * Given an object containing firstname and lastname
3297  * values, this function returns a string with the
3298  * full name of the person.
3299  * The result may depend on system settings
3300  * or language.  'override' will force both names
3301  * to be used even if system settings specify one.
3302  *
3303  * @global object
3304  * @global object
3305  * @param object $user A {@link $USER} object to get full name of
3306  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3307  * @return string
3308  */
3309 function fullname($user, $override=false) {
3310     global $CFG, $SESSION;
3312     if (!isset($user->firstname) and !isset($user->lastname)) {
3313         return '';
3314     }
3316     if (!$override) {
3317         if (!empty($CFG->forcefirstname)) {
3318             $user->firstname = $CFG->forcefirstname;
3319         }
3320         if (!empty($CFG->forcelastname)) {
3321             $user->lastname = $CFG->forcelastname;
3322         }
3323     }
3325     if (!empty($SESSION->fullnamedisplay)) {
3326         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3327     }
3329     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3330         return $user->firstname .' '. $user->lastname;
3332     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3333         return $user->lastname .' '. $user->firstname;
3335     } else if ($CFG->fullnamedisplay == 'firstname') {
3336         if ($override) {
3337             return get_string('fullnamedisplay', '', $user);
3338         } else {
3339             return $user->firstname;
3340         }
3341     }
3343     return get_string('fullnamedisplay', '', $user);
3346 /**
3347  * Checks if current user is shown any extra fields when listing users.
3348  * @param object $context Context
3349  * @param array $already Array of fields that we're going to show anyway
3350  *   so don't bother listing them
3351  * @return array Array of field names from user table, not including anything
3352  *   listed in $already
3353  */
3354 function get_extra_user_fields($context, $already = array()) {
3355     global $CFG;
3357     // Only users with permission get the extra fields
3358     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3359         return array();
3360     }
3362     // Split showuseridentity on comma
3363     if ($CFG->showuseridentity === '') {
3364         // Explode gives wrong result with empty string
3365         $extra = array();
3366     } else {
3367         $extra =  explode(',', $CFG->showuseridentity);
3368     }
3369     $renumber = false;
3370     foreach ($extra as $key => $field) {
3371         if (in_array($field, $already)) {
3372             unset($extra[$key]);
3373             $renumber = true;
3374         }
3375     }
3376     if ($renumber) {
3377         // For consistency, if entries are removed from array, renumber it
3378         // so they are numbered as you would expect
3379         $extra = array_merge($extra);
3380     }
3381     return $extra;
3384 /**
3385  * If the current user is to be shown extra user fields when listing or
3386  * selecting users, returns a string suitable for including in an SQL select
3387  * clause to retrieve those fields.
3388  * @param object $context Context
3389  * @param string $alias Alias of user table, e.g. 'u' (default none)
3390  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3391  * @param array $already Array of fields that we're going to include anyway
3392  *   so don't list them (default none)
3393  * @return string Partial SQL select clause, beginning with comma, for example
3394  *   ',u.idnumber,u.department' unless it is blank
3395  */
3396 function get_extra_user_fields_sql($context, $alias='', $prefix='',
3397         $already = array()) {
3398     $fields = get_extra_user_fields($context, $already);
3399     $result = '';
3400     // Add punctuation for alias
3401     if ($alias !== '') {
3402         $alias .= '.';
3403     }
3404     foreach ($fields as $field) {
3405         $result .= ', ' . $alias . $field;
3406         if ($prefix) {
3407             $result .= ' AS ' . $prefix . $field;
3408         }
3409     }
3410     return $result;
3413 /**
3414  * Returns the display name of a field in the user table. Works for most fields
3415  * that are commonly displayed to users.
3416  * @param string $field Field name, e.g. 'phone1'
3417  * @return string Text description taken from language file, e.g. 'Phone number'
3418  */
3419 function get_user_field_name($field) {
3420     // Some fields have language strings which are not the same as field name
3421     switch ($field) {
3422         case 'phone1' : return get_string('phone');
3423     }
3424     // Otherwise just use the same lang string
3425     return get_string($field);
3428 /**
3429  * Returns whether a given authentication plugin exists.
3430  *
3431  * @global object
3432  * @param string $auth Form of authentication to check for. Defaults to the
3433  *        global setting in {@link $CFG}.
3434  * @return boolean Whether the plugin is available.
3435  */
3436 function exists_auth_plugin($auth) {
3437     global $CFG;
3439     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3440         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3441     }
3442     return false;
3445 /**
3446  * Checks if a given plugin is in the list of enabled authentication plugins.
3447  *
3448  * @param string $auth Authentication plugin.
3449  * @return boolean Whether the plugin is enabled.
3450  */
3451 function is_enabled_auth($auth) {
3452     if (empty($auth)) {
3453         return false;
3454     }
3456     $enabled = get_enabled_auth_plugins();
3458     return in_array($auth, $enabled);
3461 /**
3462  * Returns an authentication plugin instance.
3463  *
3464  * @global object
3465  * @param string $auth name of authentication plugin
3466  * @return auth_plugin_base An instance of the required authentication plugin.
3467  */
3468 function get_auth_plugin($auth) {
3469     global $CFG;
3471     // check the plugin exists first
3472     if (! exists_auth_plugin($auth)) {
3473         print_error('authpluginnotfound', 'debug', '', $auth);
3474     }
3476     // return auth plugin instance
3477     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3478     $class = "auth_plugin_$auth";
3479     return new $class;
3482 /**
3483  * Returns array of active auth plugins.
3484  *
3485  * @param bool $fix fix $CFG->auth if needed
3486  * @return array
3487  */
3488 function get_enabled_auth_plugins($fix=false) {
3489     global $CFG;
3491     $default = array('manual', 'nologin');
3493     if (empty($CFG->auth)) {
3494         $auths = array();
3495     } else {
3496         $auths = explode(',', $CFG->auth);
3497     }
3499     if ($fix) {
3500         $auths = array_unique($auths);
3501         foreach($auths as $k=>$authname) {
3502             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3503                 unset($auths[$k]);
3504             }
3505         }
3506         $newconfig = implode(',', $auths);
3507         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3508             set_config('auth', $newconfig);
3509         }
3510     }
3512     return (array_merge($default, $auths));
3515 /**
3516  * Returns true if an internal authentication method is being used.
3517  * if method not specified then, global default is assumed
3518  *
3519  * @param string $auth Form of authentication required
3520  * @return bool
3521  */
3522 function is_internal_auth($auth) {
3523     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3524     return $authplugin->is_internal();
3527 /**
3528  * Returns true if the user is a 'restored' one
3529  *
3530  * Used in the login process to inform the user
3531  * and allow him/her to reset the password
3532  *
3533  * @uses $CFG
3534  * @uses $DB
3535  * @param string $username username to be checked
3536  * @return bool
3537  */
3538 function is_restored_user($username) {
3539     global $CFG, $DB;
3541     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3544 /**
3545  * Returns an array of user fields
3546  *
3547  * @return array User field/column names
3548  */
3549 function get_user_fieldnames() {
3550     global $DB;
3552     $fieldarray = $DB->get_columns('user');
3553     unset($fieldarray['id']);
3554     $fieldarray = array_keys($fieldarray);
3556     return $fieldarray;
3559 /**
3560  * Creates a bare-bones user record
3561  *
3562  * @todo Outline auth types and provide code example
3563  *
3564  * @param string $username New user's username to add to record
3565  * @param string $password New user's password to add to record
3566  * @param string $auth Form of authentication required
3567  * @return stdClass A complete user object
3568  */
3569 function create_user_record($username, $password, $auth = 'manual') {
3570     global $CFG, $DB;
3572     //just in case check text case
3573     $username = trim(moodle_strtolower($username));
3575     $authplugin = get_auth_plugin($auth);
3577     $newuser = new stdClass();
3579     if ($newinfo = $authplugin->get_userinfo($username)) {
3580         $newinfo = truncate_userinfo($newinfo);
3581         foreach ($newinfo as $key => $value){
3582             $newuser->$key = $value;
3583         }
3584     }
3586     if (!empty($newuser->email)) {
3587         if (email_is_not_allowed($newuser->email)) {
3588             unset($newuser->email);
3589         }
3590     }
3592     if (!isset($newuser->city)) {
3593         $newuser->city = '';
3594     }
3596     $newuser->auth = $auth;
3597     $newuser->username = $username;
3599     // fix for MDL-8480
3600     // user CFG lang for user if $newuser->lang is empty
3601     // or $user->lang is not an installed language
3602     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3603         $newuser->lang = $CFG->lang;
3604     }
3605     $newuser->confirmed = 1;
3606     $newuser->lastip = getremoteaddr();
3607     $newuser->timemodified = time();
3608     $newuser->mnethostid = $CFG->mnet_localhost_id;
3610     $newuser->id = $DB->insert_record('user', $newuser);
3611     $user = get_complete_user_data('id', $newuser->id);
3612     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3613         set_user_preference('auth_forcepasswordchange', 1, $user);
3614     }
3615     update_internal_user_password($user, $password);
3617     // fetch full user record for the event, the complete user data contains too much info
3618     // and we want to be consistent with other places that trigger this event
3619     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3621     return $user;
3624 /**
3625  * Will update a local user record from an external source.
3626  * (MNET users can not be updated using this method!)
3627  *
3628  * @param string $username user's username to update the record
3629  * @return stdClass A complete user object
3630  */
3631 function update_user_record($username) {
3632     global $DB, $CFG;
3634     $username = trim(moodle_strtolower($username)); /// just in case check text case
3636     $oldinfo = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
3637     $newuser = array();
3638     $userauth = get_auth_plugin($oldinfo->auth);
3640     if ($newinfo = $userauth->get_userinfo($username)) {
3641         $newinfo = truncate_userinfo($newinfo);
3642         foreach ($newinfo as $key => $value){
3643             $key = strtolower($key);
3644             if (!property_exists($oldinfo, $key) or $key === 'username' or $key === 'id'
3645                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3646                 // unknown or must not be changed
3647                 continue;
3648             }
3649             $confval = $userauth->config->{'field_updatelocal_' . $key};
3650             $lockval = $userauth->config->{'field_lock_' . $key};
3651             if (empty($confval) || empty($lockval)) {
3652                 continue;
3653             }
3654             if ($confval === 'onlogin') {
3655                 // MDL-4207 Don't overwrite modified user profile values with
3656                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3657                 // of the setting 'unlocked if empty' is to allow the user to fill
3658                 // in a value for the selected field _if LDAP is giving
3659                 // nothing_ for this field. Thus it makes sense to let this value
3660                 // stand in until LDAP is giving a value for this field.
3661                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3662                     if ((string)$oldinfo->$key !== (string)$value) {
3663                         $newuser[$key] = (string)$value;
3664                     }
3665                 }
3666             }
3667         }
3668         if ($newuser) {
3669             $newuser['id'] = $oldinfo->id;
3670             $DB->update_record('user', $newuser);
3671             // fetch full user record for the event, the complete user data contains too much info
3672             // and we want to be consistent with other places that trigger this event
3673             events_trigger('user_updated', $DB->get_record('user', array('id'=>$oldinfo->id)));
3674         }
3675     }
3677     return get_complete_user_data('id', $oldinfo->id);
3680 /**
3681  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3682  * which may have large fields
3683  *
3684  * @todo Add vartype handling to ensure $info is an array
3685  *
3686  * @param array $info Array of user properties to truncate if needed
3687  * @return array The now truncated information that&n