1d105870089eda0dfb23087597666dda94797b23
[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');
388 /** True if module controls the grade visibility over the gradebook */
389 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
391 /** True if module has code to track whether somebody viewed it */
392 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
393 /** True if module has custom completion rules */
394 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
396 /** True if module has no 'view' page (like label) */
397 define('FEATURE_NO_VIEW_LINK', 'viewlink');
398 /** True if module supports outcomes */
399 define('FEATURE_IDNUMBER', 'idnumber');
400 /** True if module supports groups */
401 define('FEATURE_GROUPS', 'groups');
402 /** True if module supports groupings */
403 define('FEATURE_GROUPINGS', 'groupings');
404 /** True if module supports groupmembersonly */
405 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
407 /** Type of module */
408 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
409 /** True if module supports intro editor */
410 define('FEATURE_MOD_INTRO', 'mod_intro');
411 /** True if module has default completion */
412 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
414 define('FEATURE_COMMENT', 'comment');
416 define('FEATURE_RATE', 'rate');
417 /** True if module supports backup/restore of moodle2 format */
418 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
420 /** True if module can show description on course main page */
421 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
423 /** Unspecified module archetype */
424 define('MOD_ARCHETYPE_OTHER', 0);
425 /** Resource-like type module */
426 define('MOD_ARCHETYPE_RESOURCE', 1);
427 /** Assignment module archetype */
428 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
429 /** System (not user-addable) module archetype */
430 define('MOD_ARCHETYPE_SYSTEM', 3);
432 /**
433  * Security token used for allowing access
434  * from external application such as web services.
435  * Scripts do not use any session, performance is relatively
436  * low because we need to load access info in each request.
437  * Scripts are executed in parallel.
438  */
439 define('EXTERNAL_TOKEN_PERMANENT', 0);
441 /**
442  * Security token used for allowing access
443  * of embedded applications, the code is executed in the
444  * active user session. Token is invalidated after user logs out.
445  * Scripts are executed serially - normal session locking is used.
446  */
447 define('EXTERNAL_TOKEN_EMBEDDED', 1);
449 /**
450  * The home page should be the site home
451  */
452 define('HOMEPAGE_SITE', 0);
453 /**
454  * The home page should be the users my page
455  */
456 define('HOMEPAGE_MY', 1);
457 /**
458  * The home page can be chosen by the user
459  */
460 define('HOMEPAGE_USER', 2);
462 /**
463  * Hub directory url (should be moodle.org)
464  */
465 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
468 /**
469  * Moodle.org url (should be moodle.org)
470  */
471 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
473 /**
474  * Moodle mobile app service name
475  */
476 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
478 /**
479  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
480  */
481 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
483 /**
484  * Course display settings
485  */
486 define('COURSE_DISPLAY_SINGLEPAGE', 0); // display all sections on one page
487 define('COURSE_DISPLAY_MULTIPAGE', 1); // split pages into a page per section
489 /// PARAMETER HANDLING ////////////////////////////////////////////////////
491 /**
492  * Returns a particular value for the named variable, taken from
493  * POST or GET.  If the parameter doesn't exist then an error is
494  * thrown because we require this variable.
495  *
496  * This function should be used to initialise all required values
497  * in a script that are based on parameters.  Usually it will be
498  * used like this:
499  *    $id = required_param('id', PARAM_INT);
500  *
501  * Please note the $type parameter is now required and the value can not be array.
502  *
503  * @param string $parname the name of the page parameter we want
504  * @param string $type expected type of parameter
505  * @return mixed
506  */
507 function required_param($parname, $type) {
508     if (func_num_args() != 2 or empty($parname) or empty($type)) {
509         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
510     }
511     if (isset($_POST[$parname])) {       // POST has precedence
512         $param = $_POST[$parname];
513     } else if (isset($_GET[$parname])) {
514         $param = $_GET[$parname];
515     } else {
516         print_error('missingparam', '', '', $parname);
517     }
519     if (is_array($param)) {
520         debugging('Invalid array parameter detected in required_param(): '.$parname);
521         // TODO: switch to fatal error in Moodle 2.3
522         //print_error('missingparam', '', '', $parname);
523         return required_param_array($parname, $type);
524     }
526     return clean_param($param, $type);
529 /**
530  * Returns a particular array value for the named variable, taken from
531  * POST or GET.  If the parameter doesn't exist then an error is
532  * thrown because we require this variable.
533  *
534  * This function should be used to initialise all required values
535  * in a script that are based on parameters.  Usually it will be
536  * used like this:
537  *    $ids = required_param_array('ids', PARAM_INT);
538  *
539  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
540  *
541  * @param string $parname the name of the page parameter we want
542  * @param string $type expected type of parameter
543  * @return array
544  */
545 function required_param_array($parname, $type) {
546     if (func_num_args() != 2 or empty($parname) or empty($type)) {
547         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
548     }
549     if (isset($_POST[$parname])) {       // POST has precedence
550         $param = $_POST[$parname];
551     } else if (isset($_GET[$parname])) {
552         $param = $_GET[$parname];
553     } else {
554         print_error('missingparam', '', '', $parname);
555     }
556     if (!is_array($param)) {
557         print_error('missingparam', '', '', $parname);
558     }
560     $result = array();
561     foreach($param as $key=>$value) {
562         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
563             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
564             continue;
565         }
566         $result[$key] = clean_param($value, $type);
567     }
569     return $result;
572 /**
573  * Returns a particular value for the named variable, taken from
574  * POST or GET, otherwise returning a given default.
575  *
576  * This function should be used to initialise all optional values
577  * in a script that are based on parameters.  Usually it will be
578  * used like this:
579  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
580  *
581  * Please note the $type parameter is now required and the value can not be array.
582  *
583  * @param string $parname the name of the page parameter we want
584  * @param mixed  $default the default value to return if nothing is found
585  * @param string $type expected type of parameter
586  * @return mixed
587  */
588 function optional_param($parname, $default, $type) {
589     if (func_num_args() != 3 or empty($parname) or empty($type)) {
590         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
591     }
592     if (!isset($default)) {
593         $default = null;
594     }
596     if (isset($_POST[$parname])) {       // POST has precedence
597         $param = $_POST[$parname];
598     } else if (isset($_GET[$parname])) {
599         $param = $_GET[$parname];
600     } else {
601         return $default;
602     }
604     if (is_array($param)) {
605         debugging('Invalid array parameter detected in required_param(): '.$parname);
606         // TODO: switch to $default in Moodle 2.3
607         //return $default;
608         return optional_param_array($parname, $default, $type);
609     }
611     return clean_param($param, $type);
614 /**
615  * Returns a particular array value for the named variable, taken from
616  * POST or GET, otherwise returning a given default.
617  *
618  * This function should be used to initialise all optional values
619  * in a script that are based on parameters.  Usually it will be
620  * used like this:
621  *    $ids = optional_param('id', array(), PARAM_INT);
622  *
623  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
624  *
625  * @param string $parname the name of the page parameter we want
626  * @param mixed  $default the default value to return if nothing is found
627  * @param string $type expected type of parameter
628  * @return array
629  */
630 function optional_param_array($parname, $default, $type) {
631     if (func_num_args() != 3 or empty($parname) or empty($type)) {
632         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
633     }
635     if (isset($_POST[$parname])) {       // POST has precedence
636         $param = $_POST[$parname];
637     } else if (isset($_GET[$parname])) {
638         $param = $_GET[$parname];
639     } else {
640         return $default;
641     }
642     if (!is_array($param)) {
643         debugging('optional_param_array() expects array parameters only: '.$parname);
644         return $default;
645     }
647     $result = array();
648     foreach($param as $key=>$value) {
649         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
650             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
651             continue;
652         }
653         $result[$key] = clean_param($value, $type);
654     }
656     return $result;
659 /**
660  * Strict validation of parameter values, the values are only converted
661  * to requested PHP type. Internally it is using clean_param, the values
662  * before and after cleaning must be equal - otherwise
663  * an invalid_parameter_exception is thrown.
664  * Objects and classes are not accepted.
665  *
666  * @param mixed $param
667  * @param string $type PARAM_ constant
668  * @param bool $allownull are nulls valid value?
669  * @param string $debuginfo optional debug information
670  * @return mixed the $param value converted to PHP type
671  * @throws invalid_parameter_exception if $param is not of given type
672  */
673 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
674     if (is_null($param)) {
675         if ($allownull == NULL_ALLOWED) {
676             return null;
677         } else {
678             throw new invalid_parameter_exception($debuginfo);
679         }
680     }
681     if (is_array($param) or is_object($param)) {
682         throw new invalid_parameter_exception($debuginfo);
683     }
685     $cleaned = clean_param($param, $type);
687     if ($type == PARAM_FLOAT) {
688         // Do not detect precision loss here.
689         if (is_float($param) or is_int($param)) {
690             // These always fit.
691         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
692             throw new invalid_parameter_exception($debuginfo);
693         }
694     } else if ((string)$param !== (string)$cleaned) {
695         // conversion to string is usually lossless
696         throw new invalid_parameter_exception($debuginfo);
697     }
699     return $cleaned;
702 /**
703  * Makes sure array contains only the allowed types,
704  * this function does not validate array key names!
705  * <code>
706  * $options = clean_param($options, PARAM_INT);
707  * </code>
708  *
709  * @param array $param the variable array we are cleaning
710  * @param string $type expected format of param after cleaning.
711  * @param bool $recursive clean recursive arrays
712  * @return array
713  */
714 function clean_param_array(array $param = null, $type, $recursive = false) {
715     $param = (array)$param; // convert null to empty array
716     foreach ($param as $key => $value) {
717         if (is_array($value)) {
718             if ($recursive) {
719                 $param[$key] = clean_param_array($value, $type, true);
720             } else {
721                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
722             }
723         } else {
724             $param[$key] = clean_param($value, $type);
725         }
726     }
727     return $param;
730 /**
731  * Used by {@link optional_param()} and {@link required_param()} to
732  * clean the variables and/or cast to specific types, based on
733  * an options field.
734  * <code>
735  * $course->format = clean_param($course->format, PARAM_ALPHA);
736  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
737  * </code>
738  *
739  * @param mixed $param the variable we are cleaning
740  * @param string $type expected format of param after cleaning.
741  * @return mixed
742  */
743 function clean_param($param, $type) {
745     global $CFG;
747     if (is_array($param)) {
748         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
749     } else if (is_object($param)) {
750         if (method_exists($param, '__toString')) {
751             $param = $param->__toString();
752         } else {
753             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
754         }
755     }
757     switch ($type) {
758         case PARAM_RAW:          // no cleaning at all
759             $param = fix_utf8($param);
760             return $param;
762         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
763             $param = fix_utf8($param);
764             return trim($param);
766         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
767             // this is deprecated!, please use more specific type instead
768             if (is_numeric($param)) {
769                 return $param;
770             }
771             $param = fix_utf8($param);
772             return clean_text($param);     // Sweep for scripts, etc
774         case PARAM_CLEANHTML:    // clean html fragment
775             $param = fix_utf8($param);
776             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
777             return trim($param);
779         case PARAM_INT:
780             return (int)$param;  // Convert to integer
782         case PARAM_FLOAT:
783         case PARAM_NUMBER:
784             return (float)$param;  // Convert to float
786         case PARAM_ALPHA:        // Remove everything not a-z
787             return preg_replace('/[^a-zA-Z]/i', '', $param);
789         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
790             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
792         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
793             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
795         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
796             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
798         case PARAM_SEQUENCE:     // Remove everything not 0-9,
799             return preg_replace('/[^0-9,]/i', '', $param);
801         case PARAM_BOOL:         // Convert to 1 or 0
802             $tempstr = strtolower($param);
803             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
804                 $param = 1;
805             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
806                 $param = 0;
807             } else {
808                 $param = empty($param) ? 0 : 1;
809             }
810             return $param;
812         case PARAM_NOTAGS:       // Strip all tags
813             $param = fix_utf8($param);
814             return strip_tags($param);
816         case PARAM_TEXT:    // leave only tags needed for multilang
817             $param = fix_utf8($param);
818             // if the multilang syntax is not correct we strip all tags
819             // because it would break xhtml strict which is required for accessibility standards
820             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
821             do {
822                 if (strpos($param, '</lang>') !== false) {
823                     // old and future mutilang syntax
824                     $param = strip_tags($param, '<lang>');
825                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
826                         break;
827                     }
828                     $open = false;
829                     foreach ($matches[0] as $match) {
830                         if ($match === '</lang>') {
831                             if ($open) {
832                                 $open = false;
833                                 continue;
834                             } else {
835                                 break 2;
836                             }
837                         }
838                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
839                             break 2;
840                         } else {
841                             $open = true;
842                         }
843                     }
844                     if ($open) {
845                         break;
846                     }
847                     return $param;
849                 } else if (strpos($param, '</span>') !== false) {
850                     // current problematic multilang syntax
851                     $param = strip_tags($param, '<span>');
852                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
853                         break;
854                     }
855                     $open = false;
856                     foreach ($matches[0] as $match) {
857                         if ($match === '</span>') {
858                             if ($open) {
859                                 $open = false;
860                                 continue;
861                             } else {
862                                 break 2;
863                             }
864                         }
865                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
866                             break 2;
867                         } else {
868                             $open = true;
869                         }
870                     }
871                     if ($open) {
872                         break;
873                     }
874                     return $param;
875                 }
876             } while (false);
877             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
878             return strip_tags($param);
880         case PARAM_COMPONENT:
881             // we do not want any guessing here, either the name is correct or not
882             // please note only normalised component names are accepted
883             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
884                 return '';
885             }
886             if (strpos($param, '__') !== false) {
887                 return '';
888             }
889             if (strpos($param, 'mod_') === 0) {
890                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
891                 if (substr_count($param, '_') != 1) {
892                     return '';
893                 }
894             }
895             return $param;
897         case PARAM_PLUGIN:
898         case PARAM_AREA:
899             // we do not want any guessing here, either the name is correct or not
900             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
901                 return '';
902             }
903             if (strpos($param, '__') !== false) {
904                 return '';
905             }
906             return $param;
908         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
909             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
911         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
912             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
914         case PARAM_FILE:         // Strip all suspicious characters from filename
915             $param = fix_utf8($param);
916             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
917             $param = preg_replace('~\.\.+~', '', $param);
918             if ($param === '.') {
919                 $param = '';
920             }
921             return $param;
923         case PARAM_PATH:         // Strip all suspicious characters from file path
924             $param = fix_utf8($param);
925             $param = str_replace('\\', '/', $param);
926             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
927             $param = preg_replace('~\.\.+~', '', $param);
928             $param = preg_replace('~//+~', '/', $param);
929             return preg_replace('~/(\./)+~', '/', $param);
931         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
932             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
933             // match ipv4 dotted quad
934             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
935                 // confirm values are ok
936                 if ( $match[0] > 255
937                      || $match[1] > 255
938                      || $match[3] > 255
939                      || $match[4] > 255 ) {
940                     // hmmm, what kind of dotted quad is this?
941                     $param = '';
942                 }
943             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
944                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
945                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
946                        ) {
947                 // all is ok - $param is respected
948             } else {
949                 // all is not ok...
950                 $param='';
951             }
952             return $param;
954         case PARAM_URL:          // allow safe ftp, http, mailto urls
955             $param = fix_utf8($param);
956             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
957             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
958                 // all is ok, param is respected
959             } else {
960                 $param =''; // not really ok
961             }
962             return $param;
964         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
965             $param = clean_param($param, PARAM_URL);
966             if (!empty($param)) {
967                 if (preg_match(':^/:', $param)) {
968                     // root-relative, ok!
969                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
970                     // absolute, and matches our wwwroot
971                 } else {
972                     // relative - let's make sure there are no tricks
973                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
974                         // looks ok.
975                     } else {
976                         $param = '';
977                     }
978                 }
979             }
980             return $param;
982         case PARAM_PEM:
983             $param = trim($param);
984             // PEM formatted strings may contain letters/numbers and the symbols
985             // forward slash: /
986             // plus sign:     +
987             // equal sign:    =
988             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
989             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
990                 list($wholething, $body) = $matches;
991                 unset($wholething, $matches);
992                 $b64 = clean_param($body, PARAM_BASE64);
993                 if (!empty($b64)) {
994                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
995                 } else {
996                     return '';
997                 }
998             }
999             return '';
1001         case PARAM_BASE64:
1002             if (!empty($param)) {
1003                 // PEM formatted strings may contain letters/numbers and the symbols
1004                 // forward slash: /
1005                 // plus sign:     +
1006                 // equal sign:    =
1007                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1008                     return '';
1009                 }
1010                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1011                 // Each line of base64 encoded data must be 64 characters in
1012                 // length, except for the last line which may be less than (or
1013                 // equal to) 64 characters long.
1014                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1015                     if ($i + 1 == $j) {
1016                         if (64 < strlen($lines[$i])) {
1017                             return '';
1018                         }
1019                         continue;
1020                     }
1022                     if (64 != strlen($lines[$i])) {
1023                         return '';
1024                     }
1025                 }
1026                 return implode("\n",$lines);
1027             } else {
1028                 return '';
1029             }
1031         case PARAM_TAG:
1032             $param = fix_utf8($param);
1033             // Please note it is not safe to use the tag name directly anywhere,
1034             // it must be processed with s(), urlencode() before embedding anywhere.
1035             // remove some nasties
1036             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1037             //convert many whitespace chars into one
1038             $param = preg_replace('/\s+/', ' ', $param);
1039             $param = textlib::substr(trim($param), 0, TAG_MAX_LENGTH);
1040             return $param;
1042         case PARAM_TAGLIST:
1043             $param = fix_utf8($param);
1044             $tags = explode(',', $param);
1045             $result = array();
1046             foreach ($tags as $tag) {
1047                 $res = clean_param($tag, PARAM_TAG);
1048                 if ($res !== '') {
1049                     $result[] = $res;
1050                 }
1051             }
1052             if ($result) {
1053                 return implode(',', $result);
1054             } else {
1055                 return '';
1056             }
1058         case PARAM_CAPABILITY:
1059             if (get_capability_info($param)) {
1060                 return $param;
1061             } else {
1062                 return '';
1063             }
1065         case PARAM_PERMISSION:
1066             $param = (int)$param;
1067             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1068                 return $param;
1069             } else {
1070                 return CAP_INHERIT;
1071             }
1073         case PARAM_AUTH:
1074             $param = clean_param($param, PARAM_PLUGIN);
1075             if (empty($param)) {
1076                 return '';
1077             } else if (exists_auth_plugin($param)) {
1078                 return $param;
1079             } else {
1080                 return '';
1081             }
1083         case PARAM_LANG:
1084             $param = clean_param($param, PARAM_SAFEDIR);
1085             if (get_string_manager()->translation_exists($param)) {
1086                 return $param;
1087             } else {
1088                 return ''; // Specified language is not installed or param malformed
1089             }
1091         case PARAM_THEME:
1092             $param = clean_param($param, PARAM_PLUGIN);
1093             if (empty($param)) {
1094                 return '';
1095             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1096                 return $param;
1097             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1098                 return $param;
1099             } else {
1100                 return '';  // Specified theme is not installed
1101             }
1103         case PARAM_USERNAME:
1104             $param = fix_utf8($param);
1105             $param = str_replace(" " , "", $param);
1106             $param = textlib::strtolower($param);  // Convert uppercase to lowercase MDL-16919
1107             if (empty($CFG->extendedusernamechars)) {
1108                 // regular expression, eliminate all chars EXCEPT:
1109                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1110                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1111             }
1112             return $param;
1114         case PARAM_EMAIL:
1115             $param = fix_utf8($param);
1116             if (validate_email($param)) {
1117                 return $param;
1118             } else {
1119                 return '';
1120             }
1122         case PARAM_STRINGID:
1123             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1124                 return $param;
1125             } else {
1126                 return '';
1127             }
1129         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1130             $param = fix_utf8($param);
1131             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3]|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1132             if (preg_match($timezonepattern, $param)) {
1133                 return $param;
1134             } else {
1135                 return '';
1136             }
1138         default:                 // throw error, switched parameters in optional_param or another serious problem
1139             print_error("unknownparamtype", '', '', $type);
1140     }
1143 /**
1144  * Makes sure the data is using valid utf8, invalid characters are discarded.
1145  *
1146  * Note: this function is not intended for full objects with methods and private properties.
1147  *
1148  * @param mixed $value
1149  * @return mixed with proper utf-8 encoding
1150  */
1151 function fix_utf8($value) {
1152     if (is_null($value) or $value === '') {
1153         return $value;
1155     } else if (is_string($value)) {
1156         if ((string)(int)$value === $value) {
1157             // shortcut
1158             return $value;
1159         }
1161         // Lower error reporting because glibc throws bogus notices.
1162         $olderror = error_reporting();
1163         if ($olderror & E_NOTICE) {
1164             error_reporting($olderror ^ E_NOTICE);
1165         }
1167         // Note: this duplicates min_fix_utf8() intentionally.
1168         static $buggyiconv = null;
1169         if ($buggyiconv === null) {
1170             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1171         }
1173         if ($buggyiconv) {
1174             if (function_exists('mb_convert_encoding')) {
1175                 $subst = mb_substitute_character();
1176                 mb_substitute_character('');
1177                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1178                 mb_substitute_character($subst);
1180             } else {
1181                 // Warn admins on admin/index.php page.
1182                 $result = $value;
1183             }
1185         } else {
1186             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1187         }
1189         if ($olderror & E_NOTICE) {
1190             error_reporting($olderror);
1191         }
1193         return $result;
1195     } else if (is_array($value)) {
1196         foreach ($value as $k=>$v) {
1197             $value[$k] = fix_utf8($v);
1198         }
1199         return $value;
1201     } else if (is_object($value)) {
1202         $value = clone($value); // do not modify original
1203         foreach ($value as $k=>$v) {
1204             $value->$k = fix_utf8($v);
1205         }
1206         return $value;
1208     } else {
1209         // this is some other type, no utf-8 here
1210         return $value;
1211     }
1214 /**
1215  * Return true if given value is integer or string with integer value
1216  *
1217  * @param mixed $value String or Int
1218  * @return bool true if number, false if not
1219  */
1220 function is_number($value) {
1221     if (is_int($value)) {
1222         return true;
1223     } else if (is_string($value)) {
1224         return ((string)(int)$value) === $value;
1225     } else {
1226         return false;
1227     }
1230 /**
1231  * Returns host part from url
1232  * @param string $url full url
1233  * @return string host, null if not found
1234  */
1235 function get_host_from_url($url) {
1236     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1237     if ($matches) {
1238         return $matches[1];
1239     }
1240     return null;
1243 /**
1244  * Tests whether anything was returned by text editor
1245  *
1246  * This function is useful for testing whether something you got back from
1247  * the HTML editor actually contains anything. Sometimes the HTML editor
1248  * appear to be empty, but actually you get back a <br> tag or something.
1249  *
1250  * @param string $string a string containing HTML.
1251  * @return boolean does the string contain any actual content - that is text,
1252  * images, objects, etc.
1253  */
1254 function html_is_blank($string) {
1255     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1258 /**
1259  * Set a key in global configuration
1260  *
1261  * Set a key/value pair in both this session's {@link $CFG} global variable
1262  * and in the 'config' database table for future sessions.
1263  *
1264  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1265  * In that case it doesn't affect $CFG.
1266  *
1267  * A NULL value will delete the entry.
1268  *
1269  * @global object
1270  * @global object
1271  * @param string $name the key to set
1272  * @param string $value the value to set (without magic quotes)
1273  * @param string $plugin (optional) the plugin scope, default NULL
1274  * @return bool true or exception
1275  */
1276 function set_config($name, $value, $plugin=NULL) {
1277     global $CFG, $DB;
1279     if (empty($plugin)) {
1280         if (!array_key_exists($name, $CFG->config_php_settings)) {
1281             // So it's defined for this invocation at least
1282             if (is_null($value)) {
1283                 unset($CFG->$name);
1284             } else {
1285                 $CFG->$name = (string)$value; // settings from db are always strings
1286             }
1287         }
1289         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1290             if ($value === null) {
1291                 $DB->delete_records('config', array('name'=>$name));
1292             } else {
1293                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1294             }
1295         } else {
1296             if ($value !== null) {
1297                 $config = new stdClass();
1298                 $config->name  = $name;
1299                 $config->value = $value;
1300                 $DB->insert_record('config', $config, false);
1301             }
1302         }
1304     } else { // plugin scope
1305         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1306             if ($value===null) {
1307                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1308             } else {
1309                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1310             }
1311         } else {
1312             if ($value !== null) {
1313                 $config = new stdClass();
1314                 $config->plugin = $plugin;
1315                 $config->name   = $name;
1316                 $config->value  = $value;
1317                 $DB->insert_record('config_plugins', $config, false);
1318             }
1319         }
1320     }
1322     return true;
1325 /**
1326  * Get configuration values from the global config table
1327  * or the config_plugins table.
1328  *
1329  * If called with one parameter, it will load all the config
1330  * variables for one plugin, and return them as an object.
1331  *
1332  * If called with 2 parameters it will return a string single
1333  * value or false if the value is not found.
1334  *
1335  * @param string $plugin full component name
1336  * @param string $name default NULL
1337  * @return mixed hash-like object or single value, return false no config found
1338  */
1339 function get_config($plugin, $name = NULL) {
1340     global $CFG, $DB;
1342     // normalise component name
1343     if ($plugin === 'moodle' or $plugin === 'core') {
1344         $plugin = NULL;
1345     }
1347     if (!empty($name)) { // the user is asking for a specific value
1348         if (!empty($plugin)) {
1349             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1350                 // setting forced in config file
1351                 return $CFG->forced_plugin_settings[$plugin][$name];
1352             } else {
1353                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1354             }
1355         } else {
1356             if (array_key_exists($name, $CFG->config_php_settings)) {
1357                 // setting force in config file
1358                 return $CFG->config_php_settings[$name];
1359             } else {
1360                 return $DB->get_field('config', 'value', array('name'=>$name));
1361             }
1362         }
1363     }
1365     // the user is after a recordset
1366     if ($plugin) {
1367         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1368         if (isset($CFG->forced_plugin_settings[$plugin])) {
1369             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1370                 if (is_null($v) or is_array($v) or is_object($v)) {
1371                     // we do not want any extra mess here, just real settings that could be saved in db
1372                     unset($localcfg[$n]);
1373                 } else {
1374                     //convert to string as if it went through the DB
1375                     $localcfg[$n] = (string)$v;
1376                 }
1377             }
1378         }
1379         if ($localcfg) {
1380             return (object)$localcfg;
1381         } else {
1382             return new stdClass();
1383         }
1385     } else {
1386         // this part is not really used any more, but anyway...
1387         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1388         foreach($CFG->config_php_settings as $n=>$v) {
1389             if (is_null($v) or is_array($v) or is_object($v)) {
1390                 // we do not want any extra mess here, just real settings that could be saved in db
1391                 unset($localcfg[$n]);
1392             } else {
1393                 //convert to string as if it went through the DB
1394                 $localcfg[$n] = (string)$v;
1395             }
1396         }
1397         return (object)$localcfg;
1398     }
1401 /**
1402  * Removes a key from global configuration
1403  *
1404  * @param string $name the key to set
1405  * @param string $plugin (optional) the plugin scope
1406  * @global object
1407  * @return boolean whether the operation succeeded.
1408  */
1409 function unset_config($name, $plugin=NULL) {
1410     global $CFG, $DB;
1412     if (empty($plugin)) {
1413         unset($CFG->$name);
1414         $DB->delete_records('config', array('name'=>$name));
1415     } else {
1416         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1417     }
1419     return true;
1422 /**
1423  * Remove all the config variables for a given plugin.
1424  *
1425  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1426  * @return boolean whether the operation succeeded.
1427  */
1428 function unset_all_config_for_plugin($plugin) {
1429     global $DB;
1430     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1431     $like = $DB->sql_like('name', '?', true, true, false, '|');
1432     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1433     $DB->delete_records_select('config', $like, $params);
1434     return true;
1437 /**
1438  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1439  *
1440  * All users are verified if they still have the necessary capability.
1441  *
1442  * @param string $value the value of the config setting.
1443  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1444  * @param bool $include admins, include administrators
1445  * @return array of user objects.
1446  */
1447 function get_users_from_config($value, $capability, $includeadmins = true) {
1448     global $CFG, $DB;
1450     if (empty($value) or $value === '$@NONE@$') {
1451         return array();
1452     }
1454     // we have to make sure that users still have the necessary capability,
1455     // it should be faster to fetch them all first and then test if they are present
1456     // instead of validating them one-by-one
1457     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1458     if ($includeadmins) {
1459         $admins = get_admins();
1460         foreach ($admins as $admin) {
1461             $users[$admin->id] = $admin;
1462         }
1463     }
1465     if ($value === '$@ALL@$') {
1466         return $users;
1467     }
1469     $result = array(); // result in correct order
1470     $allowed = explode(',', $value);
1471     foreach ($allowed as $uid) {
1472         if (isset($users[$uid])) {
1473             $user = $users[$uid];
1474             $result[$user->id] = $user;
1475         }
1476     }
1478     return $result;
1482 /**
1483  * Invalidates browser caches and cached data in temp
1484  * @return void
1485  */
1486 function purge_all_caches() {
1487     global $CFG;
1489     reset_text_filters_cache();
1490     js_reset_all_caches();
1491     theme_reset_all_caches();
1492     get_string_manager()->reset_caches();
1493     textlib::reset_caches();
1495     // purge all other caches: rss, simplepie, etc.
1496     remove_dir($CFG->cachedir.'', true);
1498     // make sure cache dir is writable, throws exception if not
1499     make_cache_directory('');
1501     // hack: this script may get called after the purifier was initialised,
1502     // but we do not want to verify repeatedly this exists in each call
1503     make_cache_directory('htmlpurifier');
1506 /**
1507  * Get volatile flags
1508  *
1509  * @param string $type
1510  * @param int    $changedsince default null
1511  * @return records array
1512  */
1513 function get_cache_flags($type, $changedsince=NULL) {
1514     global $DB;
1516     $params = array('type'=>$type, 'expiry'=>time());
1517     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1518     if ($changedsince !== NULL) {
1519         $params['changedsince'] = $changedsince;
1520         $sqlwhere .= " AND timemodified > :changedsince";
1521     }
1522     $cf = array();
1524     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1525         foreach ($flags as $flag) {
1526             $cf[$flag->name] = $flag->value;
1527         }
1528     }
1529     return $cf;
1532 /**
1533  * Get volatile flags
1534  *
1535  * @param string $type
1536  * @param string $name
1537  * @param int    $changedsince default null
1538  * @return records array
1539  */
1540 function get_cache_flag($type, $name, $changedsince=NULL) {
1541     global $DB;
1543     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1545     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1546     if ($changedsince !== NULL) {
1547         $params['changedsince'] = $changedsince;
1548         $sqlwhere .= " AND timemodified > :changedsince";
1549     }
1551     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1554 /**
1555  * Set a volatile flag
1556  *
1557  * @param string $type the "type" namespace for the key
1558  * @param string $name the key to set
1559  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1560  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1561  * @return bool Always returns true
1562  */
1563 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1564     global $DB;
1566     $timemodified = time();
1567     if ($expiry===NULL || $expiry < $timemodified) {
1568         $expiry = $timemodified + 24 * 60 * 60;
1569     } else {
1570         $expiry = (int)$expiry;
1571     }
1573     if ($value === NULL) {
1574         unset_cache_flag($type,$name);
1575         return true;
1576     }
1578     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1579         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1580             return true; //no need to update; helps rcache too
1581         }
1582         $f->value        = $value;
1583         $f->expiry       = $expiry;
1584         $f->timemodified = $timemodified;
1585         $DB->update_record('cache_flags', $f);
1586     } else {
1587         $f = new stdClass();
1588         $f->flagtype     = $type;
1589         $f->name         = $name;
1590         $f->value        = $value;
1591         $f->expiry       = $expiry;
1592         $f->timemodified = $timemodified;
1593         $DB->insert_record('cache_flags', $f);
1594     }
1595     return true;
1598 /**
1599  * Removes a single volatile flag
1600  *
1601  * @global object
1602  * @param string $type the "type" namespace for the key
1603  * @param string $name the key to set
1604  * @return bool
1605  */
1606 function unset_cache_flag($type, $name) {
1607     global $DB;
1608     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1609     return true;
1612 /**
1613  * Garbage-collect volatile flags
1614  *
1615  * @return bool Always returns true
1616  */
1617 function gc_cache_flags() {
1618     global $DB;
1619     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1620     return true;
1623 // USER PREFERENCE API
1625 /**
1626  * Refresh user preference cache. This is used most often for $USER
1627  * object that is stored in session, but it also helps with performance in cron script.
1628  *
1629  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1630  *
1631  * @package  core
1632  * @category preference
1633  * @access   public
1634  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1635  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1636  * @throws   coding_exception
1637  * @return   null
1638  */
1639 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1640     global $DB;
1641     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1643     if (!isset($user->id)) {
1644         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1645     }
1647     if (empty($user->id) or isguestuser($user->id)) {
1648         // No permanent storage for not-logged-in users and guest
1649         if (!isset($user->preference)) {
1650             $user->preference = array();
1651         }
1652         return;
1653     }
1655     $timenow = time();
1657     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1658         // Already loaded at least once on this page. Are we up to date?
1659         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1660             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1661             return;
1663         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1664             // no change since the lastcheck on this page
1665             $user->preference['_lastloaded'] = $timenow;
1666             return;
1667         }
1668     }
1670     // OK, so we have to reload all preferences
1671     $loadedusers[$user->id] = true;
1672     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1673     $user->preference['_lastloaded'] = $timenow;
1676 /**
1677  * Called from set/unset_user_preferences, so that the prefs can
1678  * be correctly reloaded in different sessions.
1679  *
1680  * NOTE: internal function, do not call from other code.
1681  *
1682  * @package core
1683  * @access  private
1684  * @param   integer         $userid the user whose prefs were changed.
1685  */
1686 function mark_user_preferences_changed($userid) {
1687     global $CFG;
1689     if (empty($userid) or isguestuser($userid)) {
1690         // no cache flags for guest and not-logged-in users
1691         return;
1692     }
1694     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1697 /**
1698  * Sets a preference for the specified user.
1699  *
1700  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1701  *
1702  * @package  core
1703  * @category preference
1704  * @access   public
1705  * @param    string            $name  The key to set as preference for the specified user
1706  * @param    string            $value The value to set for the $name key in the specified user's
1707  *                                    record, null means delete current value.
1708  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1709  * @throws   coding_exception
1710  * @return   bool                     Always true or exception
1711  */
1712 function set_user_preference($name, $value, $user = null) {
1713     global $USER, $DB;
1715     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1716         throw new coding_exception('Invalid preference name in set_user_preference() call');
1717     }
1719     if (is_null($value)) {
1720         // null means delete current
1721         return unset_user_preference($name, $user);
1722     } else if (is_object($value)) {
1723         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1724     } else if (is_array($value)) {
1725         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1726     }
1727     $value = (string)$value;
1728     if (textlib::strlen($value) > 1333) { //value column maximum length is 1333 characters
1729         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1730     }
1732     if (is_null($user)) {
1733         $user = $USER;
1734     } else if (isset($user->id)) {
1735         // $user is valid object
1736     } else if (is_numeric($user)) {
1737         $user = (object)array('id'=>(int)$user);
1738     } else {
1739         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1740     }
1742     check_user_preferences_loaded($user);
1744     if (empty($user->id) or isguestuser($user->id)) {
1745         // no permanent storage for not-logged-in users and guest
1746         $user->preference[$name] = $value;
1747         return true;
1748     }
1750     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1751         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1752             // preference already set to this value
1753             return true;
1754         }
1755         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1757     } else {
1758         $preference = new stdClass();
1759         $preference->userid = $user->id;
1760         $preference->name   = $name;
1761         $preference->value  = $value;
1762         $DB->insert_record('user_preferences', $preference);
1763     }
1765     // update value in cache
1766     $user->preference[$name] = $value;
1768     // set reload flag for other sessions
1769     mark_user_preferences_changed($user->id);
1771     return true;
1774 /**
1775  * Sets a whole array of preferences for the current user
1776  *
1777  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1778  *
1779  * @package  core
1780  * @category preference
1781  * @access   public
1782  * @param    array             $prefarray An array of key/value pairs to be set
1783  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1784  * @return   bool                         Always true or exception
1785  */
1786 function set_user_preferences(array $prefarray, $user = null) {
1787     foreach ($prefarray as $name => $value) {
1788         set_user_preference($name, $value, $user);
1789     }
1790     return true;
1793 /**
1794  * Unsets a preference completely by deleting it from the database
1795  *
1796  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1797  *
1798  * @package  core
1799  * @category preference
1800  * @access   public
1801  * @param    string            $name The key to unset as preference for the specified user
1802  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1803  * @throws   coding_exception
1804  * @return   bool                    Always true or exception
1805  */
1806 function unset_user_preference($name, $user = null) {
1807     global $USER, $DB;
1809     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1810         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1811     }
1813     if (is_null($user)) {
1814         $user = $USER;
1815     } else if (isset($user->id)) {
1816         // $user is valid object
1817     } else if (is_numeric($user)) {
1818         $user = (object)array('id'=>(int)$user);
1819     } else {
1820         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1821     }
1823     check_user_preferences_loaded($user);
1825     if (empty($user->id) or isguestuser($user->id)) {
1826         // no permanent storage for not-logged-in user and guest
1827         unset($user->preference[$name]);
1828         return true;
1829     }
1831     // delete from DB
1832     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1834     // delete the preference from cache
1835     unset($user->preference[$name]);
1837     // set reload flag for other sessions
1838     mark_user_preferences_changed($user->id);
1840     return true;
1843 /**
1844  * Used to fetch user preference(s)
1845  *
1846  * If no arguments are supplied this function will return
1847  * all of the current user preferences as an array.
1848  *
1849  * If a name is specified then this function
1850  * attempts to return that particular preference value.  If
1851  * none is found, then the optional value $default is returned,
1852  * otherwise NULL.
1853  *
1854  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1855  *
1856  * @package  core
1857  * @category preference
1858  * @access   public
1859  * @param    string            $name    Name of the key to use in finding a preference value
1860  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1861  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1862  * @throws   coding_exception
1863  * @return   string|mixed|null          A string containing the value of a single preference. An
1864  *                                      array with all of the preferences or null
1865  */
1866 function get_user_preferences($name = null, $default = null, $user = null) {
1867     global $USER;
1869     if (is_null($name)) {
1870         // all prefs
1871     } else if (is_numeric($name) or $name === '_lastloaded') {
1872         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1873     }
1875     if (is_null($user)) {
1876         $user = $USER;
1877     } else if (isset($user->id)) {
1878         // $user is valid object
1879     } else if (is_numeric($user)) {
1880         $user = (object)array('id'=>(int)$user);
1881     } else {
1882         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1883     }
1885     check_user_preferences_loaded($user);
1887     if (empty($name)) {
1888         return $user->preference; // All values
1889     } else if (isset($user->preference[$name])) {
1890         return $user->preference[$name]; // The single string value
1891     } else {
1892         return $default; // Default value (null if not specified)
1893     }
1896 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1898 /**
1899  * Given date parts in user time produce a GMT timestamp.
1900  *
1901  * @package core
1902  * @category time
1903  * @param int $year The year part to create timestamp of
1904  * @param int $month The month part to create timestamp of
1905  * @param int $day The day part to create timestamp of
1906  * @param int $hour The hour part to create timestamp of
1907  * @param int $minute The minute part to create timestamp of
1908  * @param int $second The second part to create timestamp of
1909  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
1910  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
1911  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1912  *             applied only if timezone is 99 or string.
1913  * @return int GMT timestamp
1914  */
1915 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1917     //save input timezone, required for dst offset check.
1918     $passedtimezone = $timezone;
1920     $timezone = get_user_timezone_offset($timezone);
1922     if (abs($timezone) > 13) {  //server time
1923         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1924     } else {
1925         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1926         $time = usertime($time, $timezone);
1928         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1929         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1930             $time -= dst_offset_on($time, $passedtimezone);
1931         }
1932     }
1934     return $time;
1938 /**
1939  * Format a date/time (seconds) as weeks, days, hours etc as needed
1940  *
1941  * Given an amount of time in seconds, returns string
1942  * formatted nicely as weeks, days, hours etc as needed
1943  *
1944  * @package core
1945  * @category time
1946  * @uses MINSECS
1947  * @uses HOURSECS
1948  * @uses DAYSECS
1949  * @uses YEARSECS
1950  * @param int $totalsecs Time in seconds
1951  * @param object $str Should be a time object
1952  * @return string A nicely formatted date/time string
1953  */
1954  function format_time($totalsecs, $str=NULL) {
1956     $totalsecs = abs($totalsecs);
1958     if (!$str) {  // Create the str structure the slow way
1959         $str = new stdClass();
1960         $str->day   = get_string('day');
1961         $str->days  = get_string('days');
1962         $str->hour  = get_string('hour');
1963         $str->hours = get_string('hours');
1964         $str->min   = get_string('min');
1965         $str->mins  = get_string('mins');
1966         $str->sec   = get_string('sec');
1967         $str->secs  = get_string('secs');
1968         $str->year  = get_string('year');
1969         $str->years = get_string('years');
1970     }
1973     $years     = floor($totalsecs/YEARSECS);
1974     $remainder = $totalsecs - ($years*YEARSECS);
1975     $days      = floor($remainder/DAYSECS);
1976     $remainder = $totalsecs - ($days*DAYSECS);
1977     $hours     = floor($remainder/HOURSECS);
1978     $remainder = $remainder - ($hours*HOURSECS);
1979     $mins      = floor($remainder/MINSECS);
1980     $secs      = $remainder - ($mins*MINSECS);
1982     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1983     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1984     $sh = ($hours == 1) ? $str->hour : $str->hours;
1985     $sd = ($days == 1)  ? $str->day  : $str->days;
1986     $sy = ($years == 1)  ? $str->year  : $str->years;
1988     $oyears = '';
1989     $odays = '';
1990     $ohours = '';
1991     $omins = '';
1992     $osecs = '';
1994     if ($years)  $oyears  = $years .' '. $sy;
1995     if ($days)  $odays  = $days .' '. $sd;
1996     if ($hours) $ohours = $hours .' '. $sh;
1997     if ($mins)  $omins  = $mins .' '. $sm;
1998     if ($secs)  $osecs  = $secs .' '. $ss;
2000     if ($years) return trim($oyears .' '. $odays);
2001     if ($days)  return trim($odays .' '. $ohours);
2002     if ($hours) return trim($ohours .' '. $omins);
2003     if ($mins)  return trim($omins .' '. $osecs);
2004     if ($secs)  return $osecs;
2005     return get_string('now');
2008 /**
2009  * Returns a formatted string that represents a date in user time
2010  *
2011  * Returns a formatted string that represents a date in user time
2012  * <b>WARNING: note that the format is for strftime(), not date().</b>
2013  * Because of a bug in most Windows time libraries, we can't use
2014  * the nicer %e, so we have to use %d which has leading zeroes.
2015  * A lot of the fuss in the function is just getting rid of these leading
2016  * zeroes as efficiently as possible.
2017  *
2018  * If parameter fixday = true (default), then take off leading
2019  * zero from %d, else maintain it.
2020  *
2021  * @package core
2022  * @category time
2023  * @param int $date the timestamp in UTC, as obtained from the database.
2024  * @param string $format strftime format. You should probably get this using
2025  *        get_string('strftime...', 'langconfig');
2026  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
2027  *        not 99 then daylight saving will not be added.
2028  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2029  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2030  *        If false then the leading zero is maintained.
2031  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2032  * @return string the formatted date/time.
2033  */
2034 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2036     global $CFG;
2038     if (empty($format)) {
2039         $format = get_string('strftimedaydatetime', 'langconfig');
2040     }
2042     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
2043         $fixday = false;
2044     } else if ($fixday) {
2045         $formatnoday = str_replace('%d', 'DD', $format);
2046         $fixday = ($formatnoday != $format);
2047         $format = $formatnoday;
2048     }
2050     // Note: This logic about fixing 12-hour time to remove unnecessary leading
2051     // zero is required because on Windows, PHP strftime function does not
2052     // support the correct 'hour without leading zero' parameter (%l).
2053     if (!empty($CFG->nofixhour)) {
2054         // Config.php can force %I not to be fixed.
2055         $fixhour = false;
2056     } else if ($fixhour) {
2057         $formatnohour = str_replace('%I', 'HH', $format);
2058         $fixhour = ($formatnohour != $format);
2059         $format = $formatnohour;
2060     }
2062     //add daylight saving offset for string timezones only, as we can't get dst for
2063     //float values. if timezone is 99 (user default timezone), then try update dst.
2064     if ((99 == $timezone) || !is_numeric($timezone)) {
2065         $date += dst_offset_on($date, $timezone);
2066     }
2068     $timezone = get_user_timezone_offset($timezone);
2070     // If we are running under Windows convert to windows encoding and then back to UTF-8
2071     // (because it's impossible to specify UTF-8 to fetch locale info in Win32)
2073     if (abs($timezone) > 13) {   /// Server time
2074         if ($CFG->ostype == 'WINDOWS' and ($localewincharset = get_string('localewincharset', 'langconfig'))) {
2075             $format = textlib::convert($format, 'utf-8', $localewincharset);
2076             $datestring = strftime($format, $date);
2077             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2078         } else {
2079             $datestring = strftime($format, $date);
2080         }
2081         if ($fixday) {
2082             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
2083             $datestring = str_replace('DD', $daystring, $datestring);
2084         }
2085         if ($fixhour) {
2086             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
2087             $datestring = str_replace('HH', $hourstring, $datestring);
2088         }
2090     } else {
2091         $date += (int)($timezone * 3600);
2092         if ($CFG->ostype == 'WINDOWS' and ($localewincharset = get_string('localewincharset', 'langconfig'))) {
2093             $format = textlib::convert($format, 'utf-8', $localewincharset);
2094             $datestring = gmstrftime($format, $date);
2095             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2096         } else {
2097             $datestring = gmstrftime($format, $date);
2098         }
2099         if ($fixday) {
2100             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2101             $datestring = str_replace('DD', $daystring, $datestring);
2102         }
2103         if ($fixhour) {
2104             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2105             $datestring = str_replace('HH', $hourstring, $datestring);
2106         }
2107     }
2109     return $datestring;
2112 /**
2113  * Given a $time timestamp in GMT (seconds since epoch),
2114  * returns an array that represents the date in user time
2115  *
2116  * @package core
2117  * @category time
2118  * @uses HOURSECS
2119  * @param int $time Timestamp in GMT
2120  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2121  *        dst offset is applyed {@link http://docs.moodle.org/dev/Time_API#Timezone}
2122  * @return array An array that represents the date in user time
2123  */
2124 function usergetdate($time, $timezone=99) {
2126     //save input timezone, required for dst offset check.
2127     $passedtimezone = $timezone;
2129     $timezone = get_user_timezone_offset($timezone);
2131     if (abs($timezone) > 13) {    // Server time
2132         return getdate($time);
2133     }
2135     //add daylight saving offset for string timezones only, as we can't get dst for
2136     //float values. if timezone is 99 (user default timezone), then try update dst.
2137     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2138         $time += dst_offset_on($time, $passedtimezone);
2139     }
2141     $time += intval((float)$timezone * HOURSECS);
2143     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2145     //be careful to ensure the returned array matches that produced by getdate() above
2146     list(
2147         $getdate['month'],
2148         $getdate['weekday'],
2149         $getdate['yday'],
2150         $getdate['year'],
2151         $getdate['mon'],
2152         $getdate['wday'],
2153         $getdate['mday'],
2154         $getdate['hours'],
2155         $getdate['minutes'],
2156         $getdate['seconds']
2157     ) = explode('_', $datestring);
2159     // set correct datatype to match with getdate()
2160     $getdate['seconds'] = (int)$getdate['seconds'];
2161     $getdate['yday'] = (int)$getdate['yday'] - 1; // gettime returns 0 through 365
2162     $getdate['year'] = (int)$getdate['year'];
2163     $getdate['mon'] = (int)$getdate['mon'];
2164     $getdate['wday'] = (int)$getdate['wday'];
2165     $getdate['mday'] = (int)$getdate['mday'];
2166     $getdate['hours'] = (int)$getdate['hours'];
2167     $getdate['minutes']  = (int)$getdate['minutes'];
2168     return $getdate;
2171 /**
2172  * Given a GMT timestamp (seconds since epoch), offsets it by
2173  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2174  *
2175  * @package core
2176  * @category time
2177  * @uses HOURSECS
2178  * @param int $date Timestamp in GMT
2179  * @param float|int|string $timezone timezone to calculate GMT time offset before
2180  *        calculating user time, 99 is default user timezone
2181  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2182  * @return int
2183  */
2184 function usertime($date, $timezone=99) {
2186     $timezone = get_user_timezone_offset($timezone);
2188     if (abs($timezone) > 13) {
2189         return $date;
2190     }
2191     return $date - (int)($timezone * HOURSECS);
2194 /**
2195  * Given a time, return the GMT timestamp of the most recent midnight
2196  * for the current user.
2197  *
2198  * @package core
2199  * @category time
2200  * @param int $date Timestamp in GMT
2201  * @param float|int|string $timezone timezone to calculate GMT time offset before
2202  *        calculating user midnight time, 99 is default user timezone
2203  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2204  * @return int Returns a GMT timestamp
2205  */
2206 function usergetmidnight($date, $timezone=99) {
2208     $userdate = usergetdate($date, $timezone);
2210     // Time of midnight of this user's day, in GMT
2211     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2215 /**
2216  * Returns a string that prints the user's timezone
2217  *
2218  * @package core
2219  * @category time
2220  * @param float|int|string $timezone timezone to calculate GMT time offset before
2221  *        calculating user timezone, 99 is default user timezone
2222  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2223  * @return string
2224  */
2225 function usertimezone($timezone=99) {
2227     $tz = get_user_timezone($timezone);
2229     if (!is_float($tz)) {
2230         return $tz;
2231     }
2233     if(abs($tz) > 13) { // Server time
2234         return get_string('serverlocaltime');
2235     }
2237     if($tz == intval($tz)) {
2238         // Don't show .0 for whole hours
2239         $tz = intval($tz);
2240     }
2242     if($tz == 0) {
2243         return 'UTC';
2244     }
2245     else if($tz > 0) {
2246         return 'UTC+'.$tz;
2247     }
2248     else {
2249         return 'UTC'.$tz;
2250     }
2254 /**
2255  * Returns a float which represents the user's timezone difference from GMT in hours
2256  * Checks various settings and picks the most dominant of those which have a value
2257  *
2258  * @package core
2259  * @category time
2260  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2261  *        99 is default user timezone
2262  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2263  * @return float
2264  */
2265 function get_user_timezone_offset($tz = 99) {
2267     global $USER, $CFG;
2269     $tz = get_user_timezone($tz);
2271     if (is_float($tz)) {
2272         return $tz;
2273     } else {
2274         $tzrecord = get_timezone_record($tz);
2275         if (empty($tzrecord)) {
2276             return 99.0;
2277         }
2278         return (float)$tzrecord->gmtoff / HOURMINS;
2279     }
2282 /**
2283  * Returns an int which represents the systems's timezone difference from GMT in seconds
2284  *
2285  * @package core
2286  * @category time
2287  * @param float|int|string $tz timezone for which offset is required.
2288  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2289  * @return int|bool if found, false is timezone 99 or error
2290  */
2291 function get_timezone_offset($tz) {
2292     global $CFG;
2294     if ($tz == 99) {
2295         return false;
2296     }
2298     if (is_numeric($tz)) {
2299         return intval($tz * 60*60);
2300     }
2302     if (!$tzrecord = get_timezone_record($tz)) {
2303         return false;
2304     }
2305     return intval($tzrecord->gmtoff * 60);
2308 /**
2309  * Returns a float or a string which denotes the user's timezone
2310  * 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)
2311  * means that for this timezone there are also DST rules to be taken into account
2312  * Checks various settings and picks the most dominant of those which have a value
2313  *
2314  * @package core
2315  * @category time
2316  * @param float|int|string $tz timezone to calculate GMT time offset before
2317  *        calculating user timezone, 99 is default user timezone
2318  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2319  * @return float|string
2320  */
2321 function get_user_timezone($tz = 99) {
2322     global $USER, $CFG;
2324     $timezones = array(
2325         $tz,
2326         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2327         isset($USER->timezone) ? $USER->timezone : 99,
2328         isset($CFG->timezone) ? $CFG->timezone : 99,
2329         );
2331     $tz = 99;
2333     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array
2334     while(((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2335         $tz = $next['value'];
2336     }
2337     return is_numeric($tz) ? (float) $tz : $tz;
2340 /**
2341  * Returns cached timezone record for given $timezonename
2342  *
2343  * @package core
2344  * @param string $timezonename name of the timezone
2345  * @return stdClass|bool timezonerecord or false
2346  */
2347 function get_timezone_record($timezonename) {
2348     global $CFG, $DB;
2349     static $cache = NULL;
2351     if ($cache === NULL) {
2352         $cache = array();
2353     }
2355     if (isset($cache[$timezonename])) {
2356         return $cache[$timezonename];
2357     }
2359     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2360                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2363 /**
2364  * Build and store the users Daylight Saving Time (DST) table
2365  *
2366  * @package core
2367  * @param int $from_year Start year for the table, defaults to 1971
2368  * @param int $to_year End year for the table, defaults to 2035
2369  * @param int|float|string $strtimezone, timezone to check if dst should be applyed.
2370  * @return bool
2371  */
2372 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2373     global $CFG, $SESSION, $DB;
2375     $usertz = get_user_timezone($strtimezone);
2377     if (is_float($usertz)) {
2378         // Trivial timezone, no DST
2379         return false;
2380     }
2382     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2383         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2384         unset($SESSION->dst_offsets);
2385         unset($SESSION->dst_range);
2386     }
2388     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2389         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2390         // This will be the return path most of the time, pretty light computationally
2391         return true;
2392     }
2394     // Reaching here means we either need to extend our table or create it from scratch
2396     // Remember which TZ we calculated these changes for
2397     $SESSION->dst_offsettz = $usertz;
2399     if(empty($SESSION->dst_offsets)) {
2400         // If we 're creating from scratch, put the two guard elements in there
2401         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2402     }
2403     if(empty($SESSION->dst_range)) {
2404         // If creating from scratch
2405         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2406         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2408         // Fill in the array with the extra years we need to process
2409         $yearstoprocess = array();
2410         for($i = $from; $i <= $to; ++$i) {
2411             $yearstoprocess[] = $i;
2412         }
2414         // Take note of which years we have processed for future calls
2415         $SESSION->dst_range = array($from, $to);
2416     }
2417     else {
2418         // If needing to extend the table, do the same
2419         $yearstoprocess = array();
2421         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2422         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2424         if($from < $SESSION->dst_range[0]) {
2425             // Take note of which years we need to process and then note that we have processed them for future calls
2426             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2427                 $yearstoprocess[] = $i;
2428             }
2429             $SESSION->dst_range[0] = $from;
2430         }
2431         if($to > $SESSION->dst_range[1]) {
2432             // Take note of which years we need to process and then note that we have processed them for future calls
2433             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2434                 $yearstoprocess[] = $i;
2435             }
2436             $SESSION->dst_range[1] = $to;
2437         }
2438     }
2440     if(empty($yearstoprocess)) {
2441         // This means that there was a call requesting a SMALLER range than we have already calculated
2442         return true;
2443     }
2445     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2446     // Also, the array is sorted in descending timestamp order!
2448     // Get DB data
2450     static $presets_cache = array();
2451     if (!isset($presets_cache[$usertz])) {
2452         $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');
2453     }
2454     if(empty($presets_cache[$usertz])) {
2455         return false;
2456     }
2458     // Remove ending guard (first element of the array)
2459     reset($SESSION->dst_offsets);
2460     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2462     // Add all required change timestamps
2463     foreach($yearstoprocess as $y) {
2464         // Find the record which is in effect for the year $y
2465         foreach($presets_cache[$usertz] as $year => $preset) {
2466             if($year <= $y) {
2467                 break;
2468             }
2469         }
2471         $changes = dst_changes_for_year($y, $preset);
2473         if($changes === NULL) {
2474             continue;
2475         }
2476         if($changes['dst'] != 0) {
2477             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2478         }
2479         if($changes['std'] != 0) {
2480             $SESSION->dst_offsets[$changes['std']] = 0;
2481         }
2482     }
2484     // Put in a guard element at the top
2485     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2486     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2488     // Sort again
2489     krsort($SESSION->dst_offsets);
2491     return true;
2494 /**
2495  * Calculates the required DST change and returns a Timestamp Array
2496  *
2497  * @package core
2498  * @category time
2499  * @uses HOURSECS
2500  * @uses MINSECS
2501  * @param int|string $year Int or String Year to focus on
2502  * @param object $timezone Instatiated Timezone object
2503  * @return array|null Array dst=>xx, 0=>xx, std=>yy, 1=>yy or NULL
2504  */
2505 function dst_changes_for_year($year, $timezone) {
2507     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2508         return NULL;
2509     }
2511     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2512     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2514     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2515     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2517     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2518     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2520     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2521     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2522     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2524     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2525     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2527     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2530 /**
2531  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2532  * - Note: Daylight saving only works for string timezones and not for float.
2533  *
2534  * @package core
2535  * @category time
2536  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2537  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2538  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2539  * @return int
2540  */
2541 function dst_offset_on($time, $strtimezone = NULL) {
2542     global $SESSION;
2544     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2545         return 0;
2546     }
2548     reset($SESSION->dst_offsets);
2549     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2550         if($from <= $time) {
2551             break;
2552         }
2553     }
2555     // This is the normal return path
2556     if($offset !== NULL) {
2557         return $offset;
2558     }
2560     // Reaching this point means we haven't calculated far enough, do it now:
2561     // Calculate extra DST changes if needed and recurse. The recursion always
2562     // moves toward the stopping condition, so will always end.
2564     if($from == 0) {
2565         // We need a year smaller than $SESSION->dst_range[0]
2566         if($SESSION->dst_range[0] == 1971) {
2567             return 0;
2568         }
2569         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2570         return dst_offset_on($time, $strtimezone);
2571     }
2572     else {
2573         // We need a year larger than $SESSION->dst_range[1]
2574         if($SESSION->dst_range[1] == 2035) {
2575             return 0;
2576         }
2577         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2578         return dst_offset_on($time, $strtimezone);
2579     }
2582 /**
2583  * Calculates when the day appears in specific month
2584  *
2585  * @package core
2586  * @category time
2587  * @param int $startday starting day of the month
2588  * @param int $weekday The day when week starts (normally taken from user preferences)
2589  * @param int $month The month whose day is sought
2590  * @param int $year The year of the month whose day is sought
2591  * @return int
2592  */
2593 function find_day_in_month($startday, $weekday, $month, $year) {
2595     $daysinmonth = days_in_month($month, $year);
2597     if($weekday == -1) {
2598         // Don't care about weekday, so return:
2599         //    abs($startday) if $startday != -1
2600         //    $daysinmonth otherwise
2601         return ($startday == -1) ? $daysinmonth : abs($startday);
2602     }
2604     // From now on we 're looking for a specific weekday
2606     // Give "end of month" its actual value, since we know it
2607     if($startday == -1) {
2608         $startday = -1 * $daysinmonth;
2609     }
2611     // Starting from day $startday, the sign is the direction
2613     if($startday < 1) {
2615         $startday = abs($startday);
2616         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2618         // This is the last such weekday of the month
2619         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2620         if($lastinmonth > $daysinmonth) {
2621             $lastinmonth -= 7;
2622         }
2624         // Find the first such weekday <= $startday
2625         while($lastinmonth > $startday) {
2626             $lastinmonth -= 7;
2627         }
2629         return $lastinmonth;
2631     }
2632     else {
2634         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2636         $diff = $weekday - $indexweekday;
2637         if($diff < 0) {
2638             $diff += 7;
2639         }
2641         // This is the first such weekday of the month equal to or after $startday
2642         $firstfromindex = $startday + $diff;
2644         return $firstfromindex;
2646     }
2649 /**
2650  * Calculate the number of days in a given month
2651  *
2652  * @package core
2653  * @category time
2654  * @param int $month The month whose day count is sought
2655  * @param int $year The year of the month whose day count is sought
2656  * @return int
2657  */
2658 function days_in_month($month, $year) {
2659    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2662 /**
2663  * Calculate the position in the week of a specific calendar day
2664  *
2665  * @package core
2666  * @category time
2667  * @param int $day The day of the date whose position in the week is sought
2668  * @param int $month The month of the date whose position in the week is sought
2669  * @param int $year The year of the date whose position in the week is sought
2670  * @return int
2671  */
2672 function dayofweek($day, $month, $year) {
2673     // I wonder if this is any different from
2674     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2675     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2678 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2680 /**
2681  * Returns full login url.
2682  *
2683  * @return string login url
2684  */
2685 function get_login_url() {
2686     global $CFG;
2688     $url = "$CFG->wwwroot/login/index.php";
2690     if (!empty($CFG->loginhttps)) {
2691         $url = str_replace('http:', 'https:', $url);
2692     }
2694     return $url;
2697 /**
2698  * This function checks that the current user is logged in and has the
2699  * required privileges
2700  *
2701  * This function checks that the current user is logged in, and optionally
2702  * whether they are allowed to be in a particular course and view a particular
2703  * course module.
2704  * If they are not logged in, then it redirects them to the site login unless
2705  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2706  * case they are automatically logged in as guests.
2707  * If $courseid is given and the user is not enrolled in that course then the
2708  * user is redirected to the course enrolment page.
2709  * If $cm is given and the course module is hidden and the user is not a teacher
2710  * in the course then the user is redirected to the course home page.
2711  *
2712  * When $cm parameter specified, this function sets page layout to 'module'.
2713  * You need to change it manually later if some other layout needed.
2714  *
2715  * @package    core_access
2716  * @category   access
2717  *
2718  * @param mixed $courseorid id of the course or course object
2719  * @param bool $autologinguest default true
2720  * @param object $cm course module object
2721  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2722  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2723  *             in order to keep redirects working properly. MDL-14495
2724  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2725  * @return mixed Void, exit, and die depending on path
2726  */
2727 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2728     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2730     // setup global $COURSE, themes, language and locale
2731     if (!empty($courseorid)) {
2732         if (is_object($courseorid)) {
2733             $course = $courseorid;
2734         } else if ($courseorid == SITEID) {
2735             $course = clone($SITE);
2736         } else {
2737             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2738         }
2739         if ($cm) {
2740             if ($cm->course != $course->id) {
2741                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2742             }
2743             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2744             if (!($cm instanceof cm_info)) {
2745                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2746                 // db queries so this is not really a performance concern, however it is obviously
2747                 // better if you use get_fast_modinfo to get the cm before calling this.
2748                 $modinfo = get_fast_modinfo($course);
2749                 $cm = $modinfo->get_cm($cm->id);
2750             }
2751             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2752             $PAGE->set_pagelayout('incourse');
2753         } else {
2754             $PAGE->set_course($course); // set's up global $COURSE
2755         }
2756     } else {
2757         // do not touch global $COURSE via $PAGE->set_course(),
2758         // the reasons is we need to be able to call require_login() at any time!!
2759         $course = $SITE;
2760         if ($cm) {
2761             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2762         }
2763     }
2765     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2766     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2767     // risk leading the user back to the AJAX request URL.
2768     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2769         $setwantsurltome = false;
2770     }
2772     // If the user is not even logged in yet then make sure they are
2773     if (!isloggedin()) {
2774         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2775             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2776                 // misconfigured site guest, just redirect to login page
2777                 redirect(get_login_url());
2778                 exit; // never reached
2779             }
2780             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2781             complete_user_login($guest);
2782             $USER->autologinguest = true;
2783             $SESSION->lang = $lang;
2784         } else {
2785             //NOTE: $USER->site check was obsoleted by session test cookie,
2786             //      $USER->confirmed test is in login/index.php
2787             if ($preventredirect) {
2788                 throw new require_login_exception('You are not logged in');
2789             }
2791             if ($setwantsurltome) {
2792                 $SESSION->wantsurl = qualified_me();
2793             }
2794             if (!empty($_SERVER['HTTP_REFERER'])) {
2795                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2796             }
2797             redirect(get_login_url());
2798             exit; // never reached
2799         }
2800     }
2802     // loginas as redirection if needed
2803     if ($course->id != SITEID and session_is_loggedinas()) {
2804         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2805             if ($USER->loginascontext->instanceid != $course->id) {
2806                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2807             }
2808         }
2809     }
2811     // check whether the user should be changing password (but only if it is REALLY them)
2812     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2813         $userauth = get_auth_plugin($USER->auth);
2814         if ($userauth->can_change_password() and !$preventredirect) {
2815             if ($setwantsurltome) {
2816                 $SESSION->wantsurl = qualified_me();
2817             }
2818             if ($changeurl = $userauth->change_password_url()) {
2819                 //use plugin custom url
2820                 redirect($changeurl);
2821             } else {
2822                 //use moodle internal method
2823                 if (empty($CFG->loginhttps)) {
2824                     redirect($CFG->wwwroot .'/login/change_password.php');
2825                 } else {
2826                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2827                     redirect($wwwroot .'/login/change_password.php');
2828                 }
2829             }
2830         } else {
2831             print_error('nopasswordchangeforced', 'auth');
2832         }
2833     }
2835     // Check that the user account is properly set up
2836     if (user_not_fully_set_up($USER)) {
2837         if ($preventredirect) {
2838             throw new require_login_exception('User not fully set-up');
2839         }
2840         if ($setwantsurltome) {
2841             $SESSION->wantsurl = qualified_me();
2842         }
2843         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2844     }
2846     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2847     sesskey();
2849     // Do not bother admins with any formalities
2850     if (is_siteadmin()) {
2851         //set accesstime or the user will appear offline which messes up messaging
2852         user_accesstime_log($course->id);
2853         return;
2854     }
2856     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2857     if (!$USER->policyagreed and !is_siteadmin()) {
2858         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2859             if ($preventredirect) {
2860                 throw new require_login_exception('Policy not agreed');
2861             }
2862             if ($setwantsurltome) {
2863                 $SESSION->wantsurl = qualified_me();
2864             }
2865             redirect($CFG->wwwroot .'/user/policy.php');
2866         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2867             if ($preventredirect) {
2868                 throw new require_login_exception('Policy not agreed');
2869             }
2870             if ($setwantsurltome) {
2871                 $SESSION->wantsurl = qualified_me();
2872             }
2873             redirect($CFG->wwwroot .'/user/policy.php');
2874         }
2875     }
2877     // Fetch the system context, the course context, and prefetch its child contexts
2878     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2879     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2880     if ($cm) {
2881         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2882     } else {
2883         $cmcontext = null;
2884     }
2886     // If the site is currently under maintenance, then print a message
2887     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2888         if ($preventredirect) {
2889             throw new require_login_exception('Maintenance in progress');
2890         }
2892         print_maintenance_message();
2893     }
2895     // make sure the course itself is not hidden
2896     if ($course->id == SITEID) {
2897         // frontpage can not be hidden
2898     } else {
2899         if (is_role_switched($course->id)) {
2900             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2901         } else {
2902             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2903                 // originally there was also test of parent category visibility,
2904                 // BUT is was very slow in complex queries involving "my courses"
2905                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2906                 if ($preventredirect) {
2907                     throw new require_login_exception('Course is hidden');
2908                 }
2909                 // We need to override the navigation URL as the course won't have
2910                 // been added to the navigation and thus the navigation will mess up
2911                 // when trying to find it.
2912                 navigation_node::override_active_url(new moodle_url('/'));
2913                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2914             }
2915         }
2916     }
2918     // is the user enrolled?
2919     if ($course->id == SITEID) {
2920         // everybody is enrolled on the frontpage
2922     } else {
2923         if (session_is_loggedinas()) {
2924             // Make sure the REAL person can access this course first
2925             $realuser = session_get_realuser();
2926             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2927                 if ($preventredirect) {
2928                     throw new require_login_exception('Invalid course login-as access');
2929                 }
2930                 echo $OUTPUT->header();
2931                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2932             }
2933         }
2935         $access = false;
2937         if (is_role_switched($course->id)) {
2938             // ok, user had to be inside this course before the switch
2939             $access = true;
2941         } else if (is_viewing($coursecontext, $USER)) {
2942             // ok, no need to mess with enrol
2943             $access = true;
2945         } else {
2946             if (isset($USER->enrol['enrolled'][$course->id])) {
2947                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2948                     $access = true;
2949                     if (isset($USER->enrol['tempguest'][$course->id])) {
2950                         unset($USER->enrol['tempguest'][$course->id]);
2951                         remove_temp_course_roles($coursecontext);
2952                     }
2953                 } else {
2954                     //expired
2955                     unset($USER->enrol['enrolled'][$course->id]);
2956                 }
2957             }
2958             if (isset($USER->enrol['tempguest'][$course->id])) {
2959                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2960                     $access = true;
2961                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2962                     $access = true;
2963                 } else {
2964                     //expired
2965                     unset($USER->enrol['tempguest'][$course->id]);
2966                     remove_temp_course_roles($coursecontext);
2967                 }
2968             }
2970             if ($access) {
2971                 // cache ok
2972             } else {
2973                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2974                 if ($until !== false) {
2975                     // active participants may always access, a timestamp in the future, 0 (always) or false.
2976                     if ($until == 0) {
2977                         $until = ENROL_MAX_TIMESTAMP;
2978                     }
2979                     $USER->enrol['enrolled'][$course->id] = $until;
2980                     $access = true;
2982                 } else {
2983                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2984                     $enrols = enrol_get_plugins(true);
2985                     // first ask all enabled enrol instances in course if they want to auto enrol user
2986                     foreach($instances as $instance) {
2987                         if (!isset($enrols[$instance->enrol])) {
2988                             continue;
2989                         }
2990                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2991                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2992                         if ($until !== false) {
2993                             if ($until == 0) {
2994                                 $until = ENROL_MAX_TIMESTAMP;
2995                             }
2996                             $USER->enrol['enrolled'][$course->id] = $until;
2997                             $access = true;
2998                             break;
2999                         }
3000                     }
3001                     // if not enrolled yet try to gain temporary guest access
3002                     if (!$access) {
3003                         foreach($instances as $instance) {
3004                             if (!isset($enrols[$instance->enrol])) {
3005                                 continue;
3006                             }
3007                             // Get a duration for the guest access, a timestamp in the future or false.
3008                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3009                             if ($until !== false and $until > time()) {
3010                                 $USER->enrol['tempguest'][$course->id] = $until;
3011                                 $access = true;
3012                                 break;
3013                             }
3014                         }
3015                     }
3016                 }
3017             }
3018         }
3020         if (!$access) {
3021             if ($preventredirect) {
3022                 throw new require_login_exception('Not enrolled');
3023             }
3024             if ($setwantsurltome) {
3025                 $SESSION->wantsurl = qualified_me();
3026             }
3027             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3028         }
3029     }
3031     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
3032     // conditional availability, etc
3033     if ($cm && !$cm->uservisible) {
3034         if ($preventredirect) {
3035             throw new require_login_exception('Activity is hidden');
3036         }
3037         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
3038     }
3040     // Finally access granted, update lastaccess times
3041     user_accesstime_log($course->id);
3045 /**
3046  * This function just makes sure a user is logged out.
3047  *
3048  * @package    core_access
3049  */
3050 function require_logout() {
3051     global $USER;
3053     $params = $USER;
3055     if (isloggedin()) {
3056         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
3058         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
3059         foreach($authsequence as $authname) {
3060             $authplugin = get_auth_plugin($authname);
3061             $authplugin->prelogout_hook();
3062         }
3063     }
3065     events_trigger('user_logout', $params);
3066     session_get_instance()->terminate_current();
3067     unset($params);
3070 /**
3071  * Weaker version of require_login()
3072  *
3073  * This is a weaker version of {@link require_login()} which only requires login
3074  * when called from within a course rather than the site page, unless
3075  * the forcelogin option is turned on.
3076  * @see require_login()
3077  *
3078  * @package    core_access
3079  * @category   access
3080  *
3081  * @param mixed $courseorid The course object or id in question
3082  * @param bool $autologinguest Allow autologin guests if that is wanted
3083  * @param object $cm Course activity module if known
3084  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3085  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3086  *             in order to keep redirects working properly. MDL-14495
3087  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3088  * @return void
3089  */
3090 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
3091     global $CFG, $PAGE, $SITE;
3092     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3093           or (!is_object($courseorid) and $courseorid == SITEID);
3094     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3095         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
3096         // db queries so this is not really a performance concern, however it is obviously
3097         // better if you use get_fast_modinfo to get the cm before calling this.
3098         if (is_object($courseorid)) {
3099             $course = $courseorid;
3100         } else {
3101             $course = clone($SITE);
3102         }
3103         $modinfo = get_fast_modinfo($course);
3104         $cm = $modinfo->get_cm($cm->id);
3105     }
3106     if (!empty($CFG->forcelogin)) {
3107         // login required for both SITE and courses
3108         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3110     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3111         // always login for hidden activities
3112         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3114     } else if ($issite) {
3115               //login for SITE not required
3116         if ($cm and empty($cm->visible)) {
3117             // hidden activities are not accessible without login
3118             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3119         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3120             // not-logged-in users do not have any group membership
3121             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3122         } else {
3123             // We still need to instatiate PAGE vars properly so that things
3124             // that rely on it like navigation function correctly.
3125             if (!empty($courseorid)) {
3126                 if (is_object($courseorid)) {
3127                     $course = $courseorid;
3128                 } else {
3129                     $course = clone($SITE);
3130                 }
3131                 if ($cm) {
3132                     if ($cm->course != $course->id) {
3133                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3134                     }
3135                     $PAGE->set_cm($cm, $course);
3136                     $PAGE->set_pagelayout('incourse');
3137                 } else {
3138                     $PAGE->set_course($course);
3139                 }
3140             } else {
3141                 // If $PAGE->course, and hence $PAGE->context, have not already been set
3142                 // up properly, set them up now.
3143                 $PAGE->set_course($PAGE->course);
3144             }
3145             //TODO: verify conditional activities here
3146             user_accesstime_log(SITEID);
3147             return;
3148         }
3150     } else {
3151         // course login always required
3152         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3153     }
3156 /**
3157  * Require key login. Function terminates with error if key not found or incorrect.
3158  *
3159  * @global object
3160  * @global object
3161  * @global object
3162  * @global object
3163  * @uses NO_MOODLE_COOKIES
3164  * @uses PARAM_ALPHANUM
3165  * @param string $script unique script identifier
3166  * @param int $instance optional instance id
3167  * @return int Instance ID
3168  */
3169 function require_user_key_login($script, $instance=null) {
3170     global $USER, $SESSION, $CFG, $DB;
3172     if (!NO_MOODLE_COOKIES) {
3173         print_error('sessioncookiesdisable');
3174     }
3176 /// extra safety
3177     @session_write_close();
3179     $keyvalue = required_param('key', PARAM_ALPHANUM);
3181     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3182         print_error('invalidkey');
3183     }
3185     if (!empty($key->validuntil) and $key->validuntil < time()) {
3186         print_error('expiredkey');
3187     }
3189     if ($key->iprestriction) {
3190         $remoteaddr = getremoteaddr(null);
3191         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3192             print_error('ipmismatch');
3193         }
3194     }
3196     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3197         print_error('invaliduserid');
3198     }
3200 /// emulate normal session
3201     enrol_check_plugins($user);
3202     session_set_user($user);
3204 /// note we are not using normal login
3205     if (!defined('USER_KEY_LOGIN')) {
3206         define('USER_KEY_LOGIN', true);
3207     }
3209 /// return instance id - it might be empty
3210     return $key->instance;
3213 /**
3214  * Creates a new private user access key.
3215  *
3216  * @global object
3217  * @param string $script unique target identifier
3218  * @param int $userid
3219  * @param int $instance optional instance id
3220  * @param string $iprestriction optional ip restricted access
3221  * @param timestamp $validuntil key valid only until given data
3222  * @return string access key value
3223  */
3224 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3225     global $DB;
3227     $key = new stdClass();
3228     $key->script        = $script;
3229     $key->userid        = $userid;
3230     $key->instance      = $instance;
3231     $key->iprestriction = $iprestriction;
3232     $key->validuntil    = $validuntil;
3233     $key->timecreated   = time();
3235     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3236     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3237         // must be unique
3238         $key->value     = md5($userid.'_'.time().random_string(40));
3239     }
3240     $DB->insert_record('user_private_key', $key);
3241     return $key->value;
3244 /**
3245  * Delete the user's new private user access keys for a particular script.
3246  *
3247  * @global object
3248  * @param string $script unique target identifier
3249  * @param int $userid
3250  * @return void
3251  */
3252 function delete_user_key($script,$userid) {
3253     global $DB;
3254     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3257 /**
3258  * Gets a private user access key (and creates one if one doesn't exist).
3259  *
3260  * @global object
3261  * @param string $script unique target identifier
3262  * @param int $userid
3263  * @param int $instance optional instance id
3264  * @param string $iprestriction optional ip restricted access
3265  * @param timestamp $validuntil key valid only until given data
3266  * @return string access key value
3267  */
3268 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3269     global $DB;
3271     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3272                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3273                                                          'validuntil'=>$validuntil))) {
3274         return $key->value;
3275     } else {
3276         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3277     }
3281 /**
3282  * Modify the user table by setting the currently logged in user's
3283  * last login to now.
3284  *
3285  * @global object
3286  * @global object
3287  * @return bool Always returns true
3288  */
3289 function update_user_login_times() {
3290     global $USER, $DB;
3292     if (isguestuser()) {
3293         // Do not update guest access times/ips for performance.
3294         return true;
3295     }
3297     $now = time();
3299     $user = new stdClass();
3300     $user->id = $USER->id;
3302     // Make sure all users that logged in have some firstaccess.
3303     if ($USER->firstaccess == 0) {
3304         $USER->firstaccess = $user->firstaccess = $now;
3305     }
3307     // Store the previous current as lastlogin.
3308     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3310     $USER->currentlogin = $user->currentlogin = $now;
3312     // Function user_accesstime_log() may not update immediately, better do it here.
3313     $USER->lastaccess = $user->lastaccess = $now;
3314     $USER->lastip = $user->lastip = getremoteaddr();
3316     $DB->update_record('user', $user);
3317     return true;
3320 /**
3321  * Determines if a user has completed setting up their account.
3322  *
3323  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3324  * @return bool
3325  */
3326 function user_not_fully_set_up($user) {
3327     if (isguestuser($user)) {
3328         return false;
3329     }
3330     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3333 /**
3334  * Check whether the user has exceeded the bounce threshold
3335  *
3336  * @global object
3337  * @global object
3338  * @param user $user A {@link $USER} object
3339  * @return bool true=>User has exceeded bounce threshold
3340  */
3341 function over_bounce_threshold($user) {
3342     global $CFG, $DB;
3344     if (empty($CFG->handlebounces)) {
3345         return false;
3346     }
3348     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3349         return false;
3350     }
3352     // set sensible defaults
3353     if (empty($CFG->minbounces)) {
3354         $CFG->minbounces = 10;
3355     }
3356     if (empty($CFG->bounceratio)) {
3357         $CFG->bounceratio = .20;
3358     }
3359     $bouncecount = 0;
3360     $sendcount = 0;
3361     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3362         $bouncecount = $bounce->value;
3363     }
3364     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3365         $sendcount = $send->value;
3366     }
3367     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3370 /**
3371  * Used to increment or reset email sent count
3372  *
3373  * @global object
3374  * @param user $user object containing an id
3375  * @param bool $reset will reset the count to 0
3376  * @return void
3377  */
3378 function set_send_count($user,$reset=false) {
3379     global $DB;
3381     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3382         return;
3383     }
3385     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3386         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3387         $DB->update_record('user_preferences', $pref);
3388     }
3389     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3390         // make a new one
3391         $pref = new stdClass();
3392         $pref->name   = 'email_send_count';
3393         $pref->value  = 1;
3394         $pref->userid = $user->id;
3395         $DB->insert_record('user_preferences', $pref, false);
3396     }
3399 /**
3400  * Increment or reset user's email bounce count
3401  *
3402  * @global object
3403  * @param user $user object containing an id
3404  * @param bool $reset will reset the count to 0
3405  */
3406 function set_bounce_count($user,$reset=false) {
3407     global $DB;
3409     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3410         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3411         $DB->update_record('user_preferences', $pref);
3412     }
3413     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3414         // make a new one
3415         $pref = new stdClass();
3416         $pref->name   = 'email_bounce_count';
3417         $pref->value  = 1;
3418         $pref->userid = $user->id;
3419         $DB->insert_record('user_preferences', $pref, false);
3420     }
3423 /**
3424  * Keeps track of login attempts
3425  *
3426  * @global object
3427  */
3428 function update_login_count() {
3429     global $SESSION;
3431     $max_logins = 10;
3433     if (empty($SESSION->logincount)) {
3434         $SESSION->logincount = 1;
3435     } else {
3436         $SESSION->logincount++;
3437     }
3439     if ($SESSION->logincount > $max_logins) {
3440         unset($SESSION->wantsurl);
3441         print_error('errortoomanylogins');
3442     }
3445 /**
3446  * Resets login attempts
3447  *
3448  * @global object
3449  */
3450 function reset_login_count() {
3451     global $SESSION;
3453     $SESSION->logincount = 0;
3456 /**
3457  * Determines if the currently logged in user is in editing mode.
3458  * Note: originally this function had $userid parameter - it was not usable anyway
3459  *
3460  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3461  * @todo Deprecated function remove when ready
3462  *
3463  * @global object
3464  * @uses DEBUG_DEVELOPER
3465  * @return bool
3466  */
3467 function isediting() {
3468     global $PAGE;
3469     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3470     return $PAGE->user_is_editing();
3473 /**
3474  * Determines if the logged in user is currently moving an activity
3475  *
3476  * @global object
3477  * @param int $courseid The id of the course being tested
3478  * @return bool
3479  */
3480 function ismoving($courseid) {
3481     global $USER;
3483     if (!empty($USER->activitycopy)) {
3484         return ($USER->activitycopycourse == $courseid);
3485     }
3486     return false;
3489 /**
3490  * Returns a persons full name
3491  *
3492  * Given an object containing firstname and lastname
3493  * values, this function returns a string with the
3494  * full name of the person.
3495  * The result may depend on system settings
3496  * or language.  'override' will force both names
3497  * to be used even if system settings specify one.
3498  *
3499  * @global object
3500  * @global object
3501  * @param object $user A {@link $USER} object to get full name of
3502  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3503  * @return string
3504  */
3505 function fullname($user, $override=false) {
3506     global $CFG, $SESSION;
3508     if (!isset($user->firstname) and !isset($user->lastname)) {
3509         return '';
3510     }
3512     if (!$override) {
3513         if (!empty($CFG->forcefirstname)) {
3514             $user->firstname = $CFG->forcefirstname;
3515         }
3516         if (!empty($CFG->forcelastname)) {
3517             $user->lastname = $CFG->forcelastname;
3518         }
3519     }
3521     if (!empty($SESSION->fullnamedisplay)) {
3522         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3523     }
3525     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3526         return $user->firstname .' '. $user->lastname;
3528     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3529         return $user->lastname .' '. $user->firstname;
3531     } else if ($CFG->fullnamedisplay == 'firstname') {
3532         if ($override) {
3533             return get_string('fullnamedisplay', '', $user);
3534         } else {
3535             return $user->firstname;
3536         }
3537     }
3539     return get_string('fullnamedisplay', '', $user);
3542 /**
3543  * Checks if current user is shown any extra fields when listing users.
3544  * @param object $context Context
3545  * @param array $already Array of fields that we're going to show anyway
3546  *   so don't bother listing them
3547  * @return array Array of field names from user table, not including anything
3548  *   listed in $already
3549  */
3550 function get_extra_user_fields($context, $already = array()) {
3551     global $CFG;
3553     // Only users with permission get the extra fields
3554     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3555         return array();
3556     }
3558     // Split showuseridentity on comma
3559     if (empty($CFG->showuseridentity)) {
3560         // Explode gives wrong result with empty string
3561         $extra = array();
3562     } else {
3563         $extra =  explode(',', $CFG->showuseridentity);
3564     }
3565     $renumber = false;
3566     foreach ($extra as $key => $field) {
3567         if (in_array($field, $already)) {
3568             unset($extra[$key]);
3569             $renumber = true;
3570         }
3571     }
3572     if ($renumber) {
3573         // For consistency, if entries are removed from array, renumber it
3574         // so they are numbered as you would expect
3575         $extra = array_merge($extra);
3576     }
3577     return $extra;
3580 /**
3581  * If the current user is to be shown extra user fields when listing or
3582  * selecting users, returns a string suitable for including in an SQL select
3583  * clause to retrieve those fields.
3584  * @param object $context Context
3585  * @param string $alias Alias of user table, e.g. 'u' (default none)
3586  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3587  * @param array $already Array of fields that we're going to include anyway
3588  *   so don't list them (default none)
3589  * @return string Partial SQL select clause, beginning with comma, for example
3590  *   ',u.idnumber,u.department' unless it is blank
3591  */
3592 function get_extra_user_fields_sql($context, $alias='', $prefix='',
3593         $already = array()) {
3594     $fields = get_extra_user_fields($context, $already);
3595     $result = '';
3596     // Add punctuation for alias
3597     if ($alias !== '') {
3598         $alias .= '.';
3599     }
3600     foreach ($fields as $field) {
3601         $result .= ', ' . $alias . $field;
3602         if ($prefix) {
3603             $result .= ' AS ' . $prefix . $field;
3604         }
3605     }
3606     return $result;
3609 /**
3610  * Returns the display name of a field in the user table. Works for most fields
3611  * that are commonly displayed to users.
3612  * @param string $field Field name, e.g. 'phone1'
3613  * @return string Text description taken from language file, e.g. 'Phone number'
3614  */
3615 function get_user_field_name($field) {
3616     // Some fields have language strings which are not the same as field name
3617     switch ($field) {
3618         case 'phone1' : return get_string('phone');
3619     }
3620     // Otherwise just use the same lang string
3621     return get_string($field);
3624 /**
3625  * Returns whether a given authentication plugin exists.
3626  *
3627  * @global object
3628  * @param string $auth Form of authentication to check for. Defaults to the
3629  *        global setting in {@link $CFG}.
3630  * @return boolean Whether the plugin is available.
3631  */
3632 function exists_auth_plugin($auth) {
3633     global $CFG;
3635     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3636         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3637     }
3638     return false;
3641 /**
3642  * Checks if a given plugin is in the list of enabled authentication plugins.
3643  *
3644  * @param string $auth Authentication plugin.
3645  * @return boolean Whether the plugin is enabled.
3646  */
3647 function is_enabled_auth($auth) {
3648     if (empty($auth)) {
3649         return false;
3650     }
3652     $enabled = get_enabled_auth_plugins();
3654     return in_array($auth, $enabled);
3657 /**
3658  * Returns an authentication plugin instance.
3659  *
3660  * @global object
3661  * @param string $auth name of authentication plugin
3662  * @return auth_plugin_base An instance of the required authentication plugin.
3663  */
3664 function get_auth_plugin($auth) {
3665     global $CFG;
3667     // check the plugin exists first
3668     if (! exists_auth_plugin($auth)) {
3669         print_error('authpluginnotfound', 'debug', '', $auth);
3670     }