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