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