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