cd7b102685c711712d2f6c9499794f3091135922
[moodle.git] / lib / moodlelib.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * moodlelib.php - Moodle main library
19  *
20  * Main library file of miscellaneous general-purpose Moodle functions.
21  * Other main libraries:
22  *  - weblib.php      - functions that produce web output
23  *  - datalib.php     - functions that access the database
24  *
25  * @package    core
26  * @subpackage lib
27  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
28  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 defined('MOODLE_INTERNAL') || die();
33 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
35 /// Date and time constants ///
36 /**
37  * Time constant - the number of seconds in a year
38  */
39 define('YEARSECS', 31536000);
41 /**
42  * Time constant - the number of seconds in a week
43  */
44 define('WEEKSECS', 604800);
46 /**
47  * Time constant - the number of seconds in a day
48  */
49 define('DAYSECS', 86400);
51 /**
52  * Time constant - the number of seconds in an hour
53  */
54 define('HOURSECS', 3600);
56 /**
57  * Time constant - the number of seconds in a minute
58  */
59 define('MINSECS', 60);
61 /**
62  * Time constant - the number of minutes in a day
63  */
64 define('DAYMINS', 1440);
66 /**
67  * Time constant - the number of minutes in an hour
68  */
69 define('HOURMINS', 60);
71 /// Parameter constants - every call to optional_param(), required_param()  ///
72 /// or clean_param() should have a specified type of parameter.  //////////////
76 /**
77  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
78  */
79 define('PARAM_ALPHA',    'alpha');
81 /**
82  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
83  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
84  */
85 define('PARAM_ALPHAEXT', 'alphaext');
87 /**
88  * PARAM_ALPHANUM - expected numbers and letters only.
89  */
90 define('PARAM_ALPHANUM', 'alphanum');
92 /**
93  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
94  */
95 define('PARAM_ALPHANUMEXT', 'alphanumext');
97 /**
98  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
99  */
100 define('PARAM_AUTH',  'auth');
102 /**
103  * PARAM_BASE64 - Base 64 encoded format
104  */
105 define('PARAM_BASE64',   'base64');
107 /**
108  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
109  */
110 define('PARAM_BOOL',     'bool');
112 /**
113  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
114  * checked against the list of capabilities in the database.
115  */
116 define('PARAM_CAPABILITY',   'capability');
118 /**
119  * PARAM_CLEANHTML - cleans submitted HTML code. use only for text in HTML format. This cleaning may fix xhtml strictness too.
120  */
121 define('PARAM_CLEANHTML', 'cleanhtml');
123 /**
124  * PARAM_EMAIL - an email address following the RFC
125  */
126 define('PARAM_EMAIL',   'email');
128 /**
129  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
130  */
131 define('PARAM_FILE',   'file');
133 /**
134  * PARAM_FLOAT - a real/floating point number.
135  *
136  * Note that you should not use PARAM_FLOAT for numbers typed in by the user.
137  * It does not work for languages that use , as a decimal separator.
138  * Instead, do something like
139  *     $rawvalue = required_param('name', PARAM_RAW);
140  *     // ... other code including require_login, which sets current lang ...
141  *     $realvalue = unformat_float($rawvalue);
142  *     // ... then use $realvalue
143  */
144 define('PARAM_FLOAT',  'float');
146 /**
147  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
148  */
149 define('PARAM_HOST',     'host');
151 /**
152  * PARAM_INT - integers only, use when expecting only numbers.
153  */
154 define('PARAM_INT',      'int');
156 /**
157  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
158  */
159 define('PARAM_LANG',  'lang');
161 /**
162  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the others! Implies PARAM_URL!)
163  */
164 define('PARAM_LOCALURL', 'localurl');
166 /**
167  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
168  */
169 define('PARAM_NOTAGS',   'notags');
171 /**
172  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
173  * note: the leading slash is not removed, window drive letter is not allowed
174  */
175 define('PARAM_PATH',     'path');
177 /**
178  * PARAM_PEM - Privacy Enhanced Mail format
179  */
180 define('PARAM_PEM',      'pem');
182 /**
183  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
184  */
185 define('PARAM_PERMISSION',   'permission');
187 /**
188  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
189  */
190 define('PARAM_RAW', 'raw');
192 /**
193  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
194  */
195 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
197 /**
198  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
199  */
200 define('PARAM_SAFEDIR',  'safedir');
202 /**
203  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
204  */
205 define('PARAM_SAFEPATH',  'safepath');
207 /**
208  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
209  */
210 define('PARAM_SEQUENCE',  'sequence');
212 /**
213  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
214  */
215 define('PARAM_TAG',   'tag');
217 /**
218  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
219  */
220 define('PARAM_TAGLIST',   'taglist');
222 /**
223  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
224  */
225 define('PARAM_TEXT',  'text');
227 /**
228  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
229  */
230 define('PARAM_THEME',  'theme');
232 /**
233  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
234  */
235 define('PARAM_URL',      'url');
237 /**
238  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
239  */
240 define('PARAM_USERNAME',    'username');
242 /**
243  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
244  */
245 define('PARAM_STRINGID',    'stringid');
247 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
248 /**
249  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
250  * It was one of the first types, that is why it is abused so much ;-)
251  * @deprecated since 2.0
252  */
253 define('PARAM_CLEAN',    'clean');
255 /**
256  * PARAM_INTEGER - deprecated alias for PARAM_INT
257  * @deprecated since 2.0
258  */
259 define('PARAM_INTEGER',  'int');
261 /**
262  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
263  * @deprecated since 2.0
264  */
265 define('PARAM_NUMBER',  'float');
267 /**
268  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
269  * NOTE: originally alias for PARAM_APLHA
270  * @deprecated since 2.0
271  */
272 define('PARAM_ACTION',   'alphanumext');
274 /**
275  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
276  * NOTE: originally alias for PARAM_APLHA
277  * @deprecated since 2.0
278  */
279 define('PARAM_FORMAT',   'alphanumext');
281 /**
282  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
283  * @deprecated since 2.0
284  */
285 define('PARAM_MULTILANG',  'text');
287 /**
288  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
289  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
290  * America/Port-au-Prince)
291  */
292 define('PARAM_TIMEZONE', 'timezone');
294 /**
295  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
296  */
297 define('PARAM_CLEANFILE', 'file');
299 /**
300  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
301  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
302  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
303  * NOTE: numbers and underscores are strongly discouraged in plugin names!
304  */
305 define('PARAM_COMPONENT', 'component');
307 /**
308  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
309  * It is usually used together with context id and component.
310  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
311  */
312 define('PARAM_AREA', 'area');
314 /**
315  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
316  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
317  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
318  */
319 define('PARAM_PLUGIN', 'plugin');
322 /// Web Services ///
324 /**
325  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
326  */
327 define('VALUE_REQUIRED', 1);
329 /**
330  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
331  */
332 define('VALUE_OPTIONAL', 2);
334 /**
335  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
336  */
337 define('VALUE_DEFAULT', 0);
339 /**
340  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
341  */
342 define('NULL_NOT_ALLOWED', false);
344 /**
345  * NULL_ALLOWED - the parameter can be set to null in the database
346  */
347 define('NULL_ALLOWED', true);
349 /// Page types ///
350 /**
351  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
352  */
353 define('PAGE_COURSE_VIEW', 'course-view');
355 /** Get remote addr constant */
356 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
357 /** Get remote addr constant */
358 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
360 /// Blog access level constant declaration ///
361 define ('BLOG_USER_LEVEL', 1);
362 define ('BLOG_GROUP_LEVEL', 2);
363 define ('BLOG_COURSE_LEVEL', 3);
364 define ('BLOG_SITE_LEVEL', 4);
365 define ('BLOG_GLOBAL_LEVEL', 5);
368 ///Tag constants///
369 /**
370  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
371  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
372  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
373  *
374  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
375  */
376 define('TAG_MAX_LENGTH', 50);
378 /// Password policy constants ///
379 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
380 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
381 define ('PASSWORD_DIGITS', '0123456789');
382 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
384 /// Feature constants ///
385 // Used for plugin_supports() to report features that are, or are not, supported by a module.
387 /** True if module can provide a grade */
388 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
389 /** True if module supports outcomes */
390 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
391 /** True if module supports advanced grading methods */
392 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
393 /** True if module controls the grade visibility over the gradebook */
394 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
395 /** True if module supports plagiarism plugins */
396 define('FEATURE_PLAGIARISM', 'plagiarism');
398 /** True if module has code to track whether somebody viewed it */
399 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
400 /** True if module has custom completion rules */
401 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
403 /** True if module has no 'view' page (like label) */
404 define('FEATURE_NO_VIEW_LINK', 'viewlink');
405 /** True if module supports outcomes */
406 define('FEATURE_IDNUMBER', 'idnumber');
407 /** True if module supports groups */
408 define('FEATURE_GROUPS', 'groups');
409 /** True if module supports groupings */
410 define('FEATURE_GROUPINGS', 'groupings');
411 /** True if module supports groupmembersonly */
412 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
414 /** Type of module */
415 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
416 /** True if module supports intro editor */
417 define('FEATURE_MOD_INTRO', 'mod_intro');
418 /** True if module has default completion */
419 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
421 define('FEATURE_COMMENT', 'comment');
423 define('FEATURE_RATE', 'rate');
424 /** True if module supports backup/restore of moodle2 format */
425 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
427 /** True if module can show description on course main page */
428 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
430 /** Unspecified module archetype */
431 define('MOD_ARCHETYPE_OTHER', 0);
432 /** Resource-like type module */
433 define('MOD_ARCHETYPE_RESOURCE', 1);
434 /** Assignment module archetype */
435 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
436 /** System (not user-addable) module archetype */
437 define('MOD_ARCHETYPE_SYSTEM', 3);
439 /**
440  * Security token used for allowing access
441  * from external application such as web services.
442  * Scripts do not use any session, performance is relatively
443  * low because we need to load access info in each request.
444  * Scripts are executed in parallel.
445  */
446 define('EXTERNAL_TOKEN_PERMANENT', 0);
448 /**
449  * Security token used for allowing access
450  * of embedded applications, the code is executed in the
451  * active user session. Token is invalidated after user logs out.
452  * Scripts are executed serially - normal session locking is used.
453  */
454 define('EXTERNAL_TOKEN_EMBEDDED', 1);
456 /**
457  * The home page should be the site home
458  */
459 define('HOMEPAGE_SITE', 0);
460 /**
461  * The home page should be the users my page
462  */
463 define('HOMEPAGE_MY', 1);
464 /**
465  * The home page can be chosen by the user
466  */
467 define('HOMEPAGE_USER', 2);
469 /**
470  * Hub directory url (should be moodle.org)
471  */
472 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
475 /**
476  * Moodle.org url (should be moodle.org)
477  */
478 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
480 /**
481  * Moodle mobile app service name
482  */
483 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
485 /**
486  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
487  */
488 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
490 /**
491  * Course display settings
492  */
493 define('COURSE_DISPLAY_SINGLEPAGE', 0); // display all sections on one page
494 define('COURSE_DISPLAY_MULTIPAGE', 1); // split pages into a page per section
496 /// PARAMETER HANDLING ////////////////////////////////////////////////////
498 /**
499  * Returns a particular value for the named variable, taken from
500  * POST or GET.  If the parameter doesn't exist then an error is
501  * thrown because we require this variable.
502  *
503  * This function should be used to initialise all required values
504  * in a script that are based on parameters.  Usually it will be
505  * used like this:
506  *    $id = required_param('id', PARAM_INT);
507  *
508  * Please note the $type parameter is now required and the value can not be array.
509  *
510  * @param string $parname the name of the page parameter we want
511  * @param string $type expected type of parameter
512  * @return mixed
513  */
514 function required_param($parname, $type) {
515     if (func_num_args() != 2 or empty($parname) or empty($type)) {
516         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
517     }
518     if (isset($_POST[$parname])) {       // POST has precedence
519         $param = $_POST[$parname];
520     } else if (isset($_GET[$parname])) {
521         $param = $_GET[$parname];
522     } else {
523         print_error('missingparam', '', '', $parname);
524     }
526     if (is_array($param)) {
527         debugging('Invalid array parameter detected in required_param(): '.$parname);
528         // TODO: switch to fatal error in Moodle 2.3
529         //print_error('missingparam', '', '', $parname);
530         return required_param_array($parname, $type);
531     }
533     return clean_param($param, $type);
536 /**
537  * Returns a particular array value for the named variable, taken from
538  * POST or GET.  If the parameter doesn't exist then an error is
539  * thrown because we require this variable.
540  *
541  * This function should be used to initialise all required values
542  * in a script that are based on parameters.  Usually it will be
543  * used like this:
544  *    $ids = required_param_array('ids', PARAM_INT);
545  *
546  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
547  *
548  * @param string $parname the name of the page parameter we want
549  * @param string $type expected type of parameter
550  * @return array
551  */
552 function required_param_array($parname, $type) {
553     if (func_num_args() != 2 or empty($parname) or empty($type)) {
554         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
555     }
556     if (isset($_POST[$parname])) {       // POST has precedence
557         $param = $_POST[$parname];
558     } else if (isset($_GET[$parname])) {
559         $param = $_GET[$parname];
560     } else {
561         print_error('missingparam', '', '', $parname);
562     }
563     if (!is_array($param)) {
564         print_error('missingparam', '', '', $parname);
565     }
567     $result = array();
568     foreach($param as $key=>$value) {
569         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
570             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
571             continue;
572         }
573         $result[$key] = clean_param($value, $type);
574     }
576     return $result;
579 /**
580  * Returns a particular value for the named variable, taken from
581  * POST or GET, otherwise returning a given default.
582  *
583  * This function should be used to initialise all optional values
584  * in a script that are based on parameters.  Usually it will be
585  * used like this:
586  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
587  *
588  * Please note the $type parameter is now required and the value can not be array.
589  *
590  * @param string $parname the name of the page parameter we want
591  * @param mixed  $default the default value to return if nothing is found
592  * @param string $type expected type of parameter
593  * @return mixed
594  */
595 function optional_param($parname, $default, $type) {
596     if (func_num_args() != 3 or empty($parname) or empty($type)) {
597         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
598     }
599     if (!isset($default)) {
600         $default = null;
601     }
603     if (isset($_POST[$parname])) {       // POST has precedence
604         $param = $_POST[$parname];
605     } else if (isset($_GET[$parname])) {
606         $param = $_GET[$parname];
607     } else {
608         return $default;
609     }
611     if (is_array($param)) {
612         debugging('Invalid array parameter detected in required_param(): '.$parname);
613         // TODO: switch to $default in Moodle 2.3
614         //return $default;
615         return optional_param_array($parname, $default, $type);
616     }
618     return clean_param($param, $type);
621 /**
622  * Returns a particular array value for the named variable, taken from
623  * POST or GET, otherwise returning a given default.
624  *
625  * This function should be used to initialise all optional values
626  * in a script that are based on parameters.  Usually it will be
627  * used like this:
628  *    $ids = optional_param('id', array(), PARAM_INT);
629  *
630  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
631  *
632  * @param string $parname the name of the page parameter we want
633  * @param mixed  $default the default value to return if nothing is found
634  * @param string $type expected type of parameter
635  * @return array
636  */
637 function optional_param_array($parname, $default, $type) {
638     if (func_num_args() != 3 or empty($parname) or empty($type)) {
639         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
640     }
642     if (isset($_POST[$parname])) {       // POST has precedence
643         $param = $_POST[$parname];
644     } else if (isset($_GET[$parname])) {
645         $param = $_GET[$parname];
646     } else {
647         return $default;
648     }
649     if (!is_array($param)) {
650         debugging('optional_param_array() expects array parameters only: '.$parname);
651         return $default;
652     }
654     $result = array();
655     foreach($param as $key=>$value) {
656         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
657             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
658             continue;
659         }
660         $result[$key] = clean_param($value, $type);
661     }
663     return $result;
666 /**
667  * Strict validation of parameter values, the values are only converted
668  * to requested PHP type. Internally it is using clean_param, the values
669  * before and after cleaning must be equal - otherwise
670  * an invalid_parameter_exception is thrown.
671  * Objects and classes are not accepted.
672  *
673  * @param mixed $param
674  * @param string $type PARAM_ constant
675  * @param bool $allownull are nulls valid value?
676  * @param string $debuginfo optional debug information
677  * @return mixed the $param value converted to PHP type
678  * @throws invalid_parameter_exception if $param is not of given type
679  */
680 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
681     if (is_null($param)) {
682         if ($allownull == NULL_ALLOWED) {
683             return null;
684         } else {
685             throw new invalid_parameter_exception($debuginfo);
686         }
687     }
688     if (is_array($param) or is_object($param)) {
689         throw new invalid_parameter_exception($debuginfo);
690     }
692     $cleaned = clean_param($param, $type);
694     if ($type == PARAM_FLOAT) {
695         // Do not detect precision loss here.
696         if (is_float($param) or is_int($param)) {
697             // These always fit.
698         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
699             throw new invalid_parameter_exception($debuginfo);
700         }
701     } else if ((string)$param !== (string)$cleaned) {
702         // conversion to string is usually lossless
703         throw new invalid_parameter_exception($debuginfo);
704     }
706     return $cleaned;
709 /**
710  * Makes sure array contains only the allowed types,
711  * this function does not validate array key names!
712  * <code>
713  * $options = clean_param($options, PARAM_INT);
714  * </code>
715  *
716  * @param array $param the variable array we are cleaning
717  * @param string $type expected format of param after cleaning.
718  * @param bool $recursive clean recursive arrays
719  * @return array
720  */
721 function clean_param_array(array $param = null, $type, $recursive = false) {
722     $param = (array)$param; // convert null to empty array
723     foreach ($param as $key => $value) {
724         if (is_array($value)) {
725             if ($recursive) {
726                 $param[$key] = clean_param_array($value, $type, true);
727             } else {
728                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
729             }
730         } else {
731             $param[$key] = clean_param($value, $type);
732         }
733     }
734     return $param;
737 /**
738  * Used by {@link optional_param()} and {@link required_param()} to
739  * clean the variables and/or cast to specific types, based on
740  * an options field.
741  * <code>
742  * $course->format = clean_param($course->format, PARAM_ALPHA);
743  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
744  * </code>
745  *
746  * @param mixed $param the variable we are cleaning
747  * @param string $type expected format of param after cleaning.
748  * @return mixed
749  */
750 function clean_param($param, $type) {
752     global $CFG;
754     if (is_array($param)) {
755         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
756     } else if (is_object($param)) {
757         if (method_exists($param, '__toString')) {
758             $param = $param->__toString();
759         } else {
760             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
761         }
762     }
764     switch ($type) {
765         case PARAM_RAW:          // no cleaning at all
766             $param = fix_utf8($param);
767             return $param;
769         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
770             $param = fix_utf8($param);
771             return trim($param);
773         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
774             // this is deprecated!, please use more specific type instead
775             if (is_numeric($param)) {
776                 return $param;
777             }
778             $param = fix_utf8($param);
779             return clean_text($param);     // Sweep for scripts, etc
781         case PARAM_CLEANHTML:    // clean html fragment
782             $param = fix_utf8($param);
783             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
784             return trim($param);
786         case PARAM_INT:
787             return (int)$param;  // Convert to integer
789         case PARAM_FLOAT:
790             return (float)$param;  // Convert to float
792         case PARAM_ALPHA:        // Remove everything not a-z
793             return preg_replace('/[^a-zA-Z]/i', '', $param);
795         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
796             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
798         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
799             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
801         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
802             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
804         case PARAM_SEQUENCE:     // Remove everything not 0-9,
805             return preg_replace('/[^0-9,]/i', '', $param);
807         case PARAM_BOOL:         // Convert to 1 or 0
808             $tempstr = strtolower($param);
809             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
810                 $param = 1;
811             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
812                 $param = 0;
813             } else {
814                 $param = empty($param) ? 0 : 1;
815             }
816             return $param;
818         case PARAM_NOTAGS:       // Strip all tags
819             $param = fix_utf8($param);
820             return strip_tags($param);
822         case PARAM_TEXT:    // leave only tags needed for multilang
823             $param = fix_utf8($param);
824             // if the multilang syntax is not correct we strip all tags
825             // because it would break xhtml strict which is required for accessibility standards
826             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
827             do {
828                 if (strpos($param, '</lang>') !== false) {
829                     // old and future mutilang syntax
830                     $param = strip_tags($param, '<lang>');
831                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
832                         break;
833                     }
834                     $open = false;
835                     foreach ($matches[0] as $match) {
836                         if ($match === '</lang>') {
837                             if ($open) {
838                                 $open = false;
839                                 continue;
840                             } else {
841                                 break 2;
842                             }
843                         }
844                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
845                             break 2;
846                         } else {
847                             $open = true;
848                         }
849                     }
850                     if ($open) {
851                         break;
852                     }
853                     return $param;
855                 } else if (strpos($param, '</span>') !== false) {
856                     // current problematic multilang syntax
857                     $param = strip_tags($param, '<span>');
858                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
859                         break;
860                     }
861                     $open = false;
862                     foreach ($matches[0] as $match) {
863                         if ($match === '</span>') {
864                             if ($open) {
865                                 $open = false;
866                                 continue;
867                             } else {
868                                 break 2;
869                             }
870                         }
871                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
872                             break 2;
873                         } else {
874                             $open = true;
875                         }
876                     }
877                     if ($open) {
878                         break;
879                     }
880                     return $param;
881                 }
882             } while (false);
883             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
884             return strip_tags($param);
886         case PARAM_COMPONENT:
887             // we do not want any guessing here, either the name is correct or not
888             // please note only normalised component names are accepted
889             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
890                 return '';
891             }
892             if (strpos($param, '__') !== false) {
893                 return '';
894             }
895             if (strpos($param, 'mod_') === 0) {
896                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
897                 if (substr_count($param, '_') != 1) {
898                     return '';
899                 }
900             }
901             return $param;
903         case PARAM_PLUGIN:
904         case PARAM_AREA:
905             // we do not want any guessing here, either the name is correct or not
906             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
907                 return '';
908             }
909             if (strpos($param, '__') !== false) {
910                 return '';
911             }
912             return $param;
914         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
915             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
917         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
918             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
920         case PARAM_FILE:         // Strip all suspicious characters from filename
921             $param = fix_utf8($param);
922             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
923             if ($param === '.' || $param === '..') {
924                 $param = '';
925             }
926             return $param;
928         case PARAM_PATH:         // Strip all suspicious characters from file path
929             $param = fix_utf8($param);
930             $param = str_replace('\\', '/', $param);
932             // Explode the path and clean each element using the PARAM_FILE rules.
933             $breadcrumb = explode('/', $param);
934             foreach ($breadcrumb as $key => $crumb) {
935                 if ($crumb === '.' && $key === 0) {
936                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
937                 } else {
938                     $crumb = clean_param($crumb, PARAM_FILE);
939                 }
940                 $breadcrumb[$key] = $crumb;
941             }
942             $param = implode('/', $breadcrumb);
944             // Remove multiple current path (./././) and multiple slashes (///).
945             $param = preg_replace('~//+~', '/', $param);
946             $param = preg_replace('~/(\./)+~', '/', $param);
947             return $param;
949         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
950             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
951             // match ipv4 dotted quad
952             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
953                 // confirm values are ok
954                 if ( $match[0] > 255
955                      || $match[1] > 255
956                      || $match[3] > 255
957                      || $match[4] > 255 ) {
958                     // hmmm, what kind of dotted quad is this?
959                     $param = '';
960                 }
961             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
962                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
963                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
964                        ) {
965                 // all is ok - $param is respected
966             } else {
967                 // all is not ok...
968                 $param='';
969             }
970             return $param;
972         case PARAM_URL:          // allow safe ftp, http, mailto urls
973             $param = fix_utf8($param);
974             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
975             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
976                 // all is ok, param is respected
977             } else {
978                 $param =''; // not really ok
979             }
980             return $param;
982         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
983             $param = clean_param($param, PARAM_URL);
984             if (!empty($param)) {
985                 if (preg_match(':^/:', $param)) {
986                     // root-relative, ok!
987                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
988                     // absolute, and matches our wwwroot
989                 } else {
990                     // relative - let's make sure there are no tricks
991                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
992                         // looks ok.
993                     } else {
994                         $param = '';
995                     }
996                 }
997             }
998             return $param;
1000         case PARAM_PEM:
1001             $param = trim($param);
1002             // PEM formatted strings may contain letters/numbers and the symbols
1003             // forward slash: /
1004             // plus sign:     +
1005             // equal sign:    =
1006             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
1007             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1008                 list($wholething, $body) = $matches;
1009                 unset($wholething, $matches);
1010                 $b64 = clean_param($body, PARAM_BASE64);
1011                 if (!empty($b64)) {
1012                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1013                 } else {
1014                     return '';
1015                 }
1016             }
1017             return '';
1019         case PARAM_BASE64:
1020             if (!empty($param)) {
1021                 // PEM formatted strings may contain letters/numbers and the symbols
1022                 // forward slash: /
1023                 // plus sign:     +
1024                 // equal sign:    =
1025                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1026                     return '';
1027                 }
1028                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1029                 // Each line of base64 encoded data must be 64 characters in
1030                 // length, except for the last line which may be less than (or
1031                 // equal to) 64 characters long.
1032                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1033                     if ($i + 1 == $j) {
1034                         if (64 < strlen($lines[$i])) {
1035                             return '';
1036                         }
1037                         continue;
1038                     }
1040                     if (64 != strlen($lines[$i])) {
1041                         return '';
1042                     }
1043                 }
1044                 return implode("\n",$lines);
1045             } else {
1046                 return '';
1047             }
1049         case PARAM_TAG:
1050             $param = fix_utf8($param);
1051             // Please note it is not safe to use the tag name directly anywhere,
1052             // it must be processed with s(), urlencode() before embedding anywhere.
1053             // remove some nasties
1054             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1055             //convert many whitespace chars into one
1056             $param = preg_replace('/\s+/', ' ', $param);
1057             $param = textlib::substr(trim($param), 0, TAG_MAX_LENGTH);
1058             return $param;
1060         case PARAM_TAGLIST:
1061             $param = fix_utf8($param);
1062             $tags = explode(',', $param);
1063             $result = array();
1064             foreach ($tags as $tag) {
1065                 $res = clean_param($tag, PARAM_TAG);
1066                 if ($res !== '') {
1067                     $result[] = $res;
1068                 }
1069             }
1070             if ($result) {
1071                 return implode(',', $result);
1072             } else {
1073                 return '';
1074             }
1076         case PARAM_CAPABILITY:
1077             if (get_capability_info($param)) {
1078                 return $param;
1079             } else {
1080                 return '';
1081             }
1083         case PARAM_PERMISSION:
1084             $param = (int)$param;
1085             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1086                 return $param;
1087             } else {
1088                 return CAP_INHERIT;
1089             }
1091         case PARAM_AUTH:
1092             $param = clean_param($param, PARAM_PLUGIN);
1093             if (empty($param)) {
1094                 return '';
1095             } else if (exists_auth_plugin($param)) {
1096                 return $param;
1097             } else {
1098                 return '';
1099             }
1101         case PARAM_LANG:
1102             $param = clean_param($param, PARAM_SAFEDIR);
1103             if (get_string_manager()->translation_exists($param)) {
1104                 return $param;
1105             } else {
1106                 return ''; // Specified language is not installed or param malformed
1107             }
1109         case PARAM_THEME:
1110             $param = clean_param($param, PARAM_PLUGIN);
1111             if (empty($param)) {
1112                 return '';
1113             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1114                 return $param;
1115             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1116                 return $param;
1117             } else {
1118                 return '';  // Specified theme is not installed
1119             }
1121         case PARAM_USERNAME:
1122             $param = fix_utf8($param);
1123             $param = str_replace(" " , "", $param);
1124             $param = textlib::strtolower($param);  // Convert uppercase to lowercase MDL-16919
1125             if (empty($CFG->extendedusernamechars)) {
1126                 // regular expression, eliminate all chars EXCEPT:
1127                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1128                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1129             }
1130             return $param;
1132         case PARAM_EMAIL:
1133             $param = fix_utf8($param);
1134             if (validate_email($param)) {
1135                 return $param;
1136             } else {
1137                 return '';
1138             }
1140         case PARAM_STRINGID:
1141             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1142                 return $param;
1143             } else {
1144                 return '';
1145             }
1147         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1148             $param = fix_utf8($param);
1149             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1150             if (preg_match($timezonepattern, $param)) {
1151                 return $param;
1152             } else {
1153                 return '';
1154             }
1156         default:                 // throw error, switched parameters in optional_param or another serious problem
1157             print_error("unknownparamtype", '', '', $type);
1158     }
1161 /**
1162  * Makes sure the data is using valid utf8, invalid characters are discarded.
1163  *
1164  * Note: this function is not intended for full objects with methods and private properties.
1165  *
1166  * @param mixed $value
1167  * @return mixed with proper utf-8 encoding
1168  */
1169 function fix_utf8($value) {
1170     if (is_null($value) or $value === '') {
1171         return $value;
1173     } else if (is_string($value)) {
1174         if ((string)(int)$value === $value) {
1175             // shortcut
1176             return $value;
1177         }
1179         // Lower error reporting because glibc throws bogus notices.
1180         $olderror = error_reporting();
1181         if ($olderror & E_NOTICE) {
1182             error_reporting($olderror ^ E_NOTICE);
1183         }
1185         // Note: this duplicates min_fix_utf8() intentionally.
1186         static $buggyiconv = null;
1187         if ($buggyiconv === null) {
1188             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1189         }
1191         if ($buggyiconv) {
1192             if (function_exists('mb_convert_encoding')) {
1193                 $subst = mb_substitute_character();
1194                 mb_substitute_character('');
1195                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1196                 mb_substitute_character($subst);
1198             } else {
1199                 // Warn admins on admin/index.php page.
1200                 $result = $value;
1201             }
1203         } else {
1204             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1205         }
1207         if ($olderror & E_NOTICE) {
1208             error_reporting($olderror);
1209         }
1211         return $result;
1213     } else if (is_array($value)) {
1214         foreach ($value as $k=>$v) {
1215             $value[$k] = fix_utf8($v);
1216         }
1217         return $value;
1219     } else if (is_object($value)) {
1220         $value = clone($value); // do not modify original
1221         foreach ($value as $k=>$v) {
1222             $value->$k = fix_utf8($v);
1223         }
1224         return $value;
1226     } else {
1227         // this is some other type, no utf-8 here
1228         return $value;
1229     }
1232 /**
1233  * Return true if given value is integer or string with integer value
1234  *
1235  * @param mixed $value String or Int
1236  * @return bool true if number, false if not
1237  */
1238 function is_number($value) {
1239     if (is_int($value)) {
1240         return true;
1241     } else if (is_string($value)) {
1242         return ((string)(int)$value) === $value;
1243     } else {
1244         return false;
1245     }
1248 /**
1249  * Returns host part from url
1250  * @param string $url full url
1251  * @return string host, null if not found
1252  */
1253 function get_host_from_url($url) {
1254     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1255     if ($matches) {
1256         return $matches[1];
1257     }
1258     return null;
1261 /**
1262  * Tests whether anything was returned by text editor
1263  *
1264  * This function is useful for testing whether something you got back from
1265  * the HTML editor actually contains anything. Sometimes the HTML editor
1266  * appear to be empty, but actually you get back a <br> tag or something.
1267  *
1268  * @param string $string a string containing HTML.
1269  * @return boolean does the string contain any actual content - that is text,
1270  * images, objects, etc.
1271  */
1272 function html_is_blank($string) {
1273     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1276 /**
1277  * Set a key in global configuration
1278  *
1279  * Set a key/value pair in both this session's {@link $CFG} global variable
1280  * and in the 'config' database table for future sessions.
1281  *
1282  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1283  * In that case it doesn't affect $CFG.
1284  *
1285  * A NULL value will delete the entry.
1286  *
1287  * @global object
1288  * @global object
1289  * @param string $name the key to set
1290  * @param string $value the value to set (without magic quotes)
1291  * @param string $plugin (optional) the plugin scope, default NULL
1292  * @return bool true or exception
1293  */
1294 function set_config($name, $value, $plugin=NULL) {
1295     global $CFG, $DB;
1297     if (empty($plugin)) {
1298         if (!array_key_exists($name, $CFG->config_php_settings)) {
1299             // So it's defined for this invocation at least
1300             if (is_null($value)) {
1301                 unset($CFG->$name);
1302             } else {
1303                 $CFG->$name = (string)$value; // settings from db are always strings
1304             }
1305         }
1307         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1308             if ($value === null) {
1309                 $DB->delete_records('config', array('name'=>$name));
1310             } else {
1311                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1312             }
1313         } else {
1314             if ($value !== null) {
1315                 $config = new stdClass();
1316                 $config->name  = $name;
1317                 $config->value = $value;
1318                 $DB->insert_record('config', $config, false);
1319             }
1320         }
1321         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1322     } else { // plugin scope
1323         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1324             if ($value===null) {
1325                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1326             } else {
1327                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1328             }
1329         } else {
1330             if ($value !== null) {
1331                 $config = new stdClass();
1332                 $config->plugin = $plugin;
1333                 $config->name   = $name;
1334                 $config->value  = $value;
1335                 $DB->insert_record('config_plugins', $config, false);
1336             }
1337         }
1338         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1339     }
1341     return true;
1344 /**
1345  * Get configuration values from the global config table
1346  * or the config_plugins table.
1347  *
1348  * If called with one parameter, it will load all the config
1349  * variables for one plugin, and return them as an object.
1350  *
1351  * If called with 2 parameters it will return a string single
1352  * value or false if the value is not found.
1353  *
1354  * @param string $plugin full component name
1355  * @param string $name default NULL
1356  * @return mixed hash-like object or single value, return false no config found
1357  */
1358 function get_config($plugin, $name = NULL) {
1359     global $CFG, $DB;
1361     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1362         $forced =& $CFG->config_php_settings;
1363         $iscore = true;
1364         $plugin = 'core';
1365     } else {
1366         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1367             $forced =& $CFG->forced_plugin_settings[$plugin];
1368         } else {
1369             $forced = array();
1370         }
1371         $iscore = false;
1372     }
1374     if (!empty($name) && array_key_exists($name, $forced)) {
1375         return (string)$forced[$name];
1376     }
1378     $cache = cache::make('core', 'config');
1379     $result = $cache->get($plugin);
1380     if (!$result) {
1381         // the user is after a recordset
1382         $result = new stdClass;
1383         if (!$iscore) {
1384             $result = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1385         } else {
1386             // this part is not really used any more, but anyway...
1387             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1388         }
1389         $cache->set($plugin, $result);
1390     }
1392     if (!empty($name)) {
1393         if (array_key_exists($name, $result)) {
1394             return $result[$name];
1395         }
1396         return false;
1397     }
1399     foreach ($forced as $key => $value) {
1400         if (is_null($value) or is_array($value) or is_object($value)) {
1401             // we do not want any extra mess here, just real settings that could be saved in db
1402             unset($result[$key]);
1403         } else {
1404             //convert to string as if it went through the DB
1405             $result[$key] = (string)$value;
1406         }
1407     }
1409     return (object)$result;
1412 /**
1413  * Removes a key from global configuration
1414  *
1415  * @param string $name the key to set
1416  * @param string $plugin (optional) the plugin scope
1417  * @global object
1418  * @return boolean whether the operation succeeded.
1419  */
1420 function unset_config($name, $plugin=NULL) {
1421     global $CFG, $DB;
1423     if (empty($plugin)) {
1424         unset($CFG->$name);
1425         $DB->delete_records('config', array('name'=>$name));
1426         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1427     } else {
1428         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1429         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1430     }
1432     return true;
1435 /**
1436  * Remove all the config variables for a given plugin.
1437  *
1438  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1439  * @return boolean whether the operation succeeded.
1440  */
1441 function unset_all_config_for_plugin($plugin) {
1442     global $DB;
1443     // Delete from the obvious config_plugins first
1444     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1445     // Next delete any suspect settings from config
1446     $like = $DB->sql_like('name', '?', true, true, false, '|');
1447     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1448     $DB->delete_records_select('config', $like, $params);
1449     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1450     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1452     return true;
1455 /**
1456  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1457  *
1458  * All users are verified if they still have the necessary capability.
1459  *
1460  * @param string $value the value of the config setting.
1461  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1462  * @param bool $include admins, include administrators
1463  * @return array of user objects.
1464  */
1465 function get_users_from_config($value, $capability, $includeadmins = true) {
1466     global $CFG, $DB;
1468     if (empty($value) or $value === '$@NONE@$') {
1469         return array();
1470     }
1472     // we have to make sure that users still have the necessary capability,
1473     // it should be faster to fetch them all first and then test if they are present
1474     // instead of validating them one-by-one
1475     $users = get_users_by_capability(context_system::instance(), $capability);
1476     if ($includeadmins) {
1477         $admins = get_admins();
1478         foreach ($admins as $admin) {
1479             $users[$admin->id] = $admin;
1480         }
1481     }
1483     if ($value === '$@ALL@$') {
1484         return $users;
1485     }
1487     $result = array(); // result in correct order
1488     $allowed = explode(',', $value);
1489     foreach ($allowed as $uid) {
1490         if (isset($users[$uid])) {
1491             $user = $users[$uid];
1492             $result[$user->id] = $user;
1493         }
1494     }
1496     return $result;
1500 /**
1501  * Invalidates browser caches and cached data in temp
1502  *
1503  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1504  * {@see phpunit_util::reset_dataroot()}
1505  *
1506  * @return void
1507  */
1508 function purge_all_caches() {
1509     global $CFG;
1511     reset_text_filters_cache();
1512     js_reset_all_caches();
1513     theme_reset_all_caches();
1514     get_string_manager()->reset_caches();
1515     textlib::reset_caches();
1517     cache_helper::purge_all();
1519     // purge all other caches: rss, simplepie, etc.
1520     remove_dir($CFG->cachedir.'', true);
1522     // make sure cache dir is writable, throws exception if not
1523     make_cache_directory('');
1525     // hack: this script may get called after the purifier was initialised,
1526     // but we do not want to verify repeatedly this exists in each call
1527     make_cache_directory('htmlpurifier');
1530 /**
1531  * Get volatile flags
1532  *
1533  * @param string $type
1534  * @param int    $changedsince default null
1535  * @return records array
1536  */
1537 function get_cache_flags($type, $changedsince=NULL) {
1538     global $DB;
1540     $params = array('type'=>$type, 'expiry'=>time());
1541     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1542     if ($changedsince !== NULL) {
1543         $params['changedsince'] = $changedsince;
1544         $sqlwhere .= " AND timemodified > :changedsince";
1545     }
1546     $cf = array();
1548     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1549         foreach ($flags as $flag) {
1550             $cf[$flag->name] = $flag->value;
1551         }
1552     }
1553     return $cf;
1556 /**
1557  * Get volatile flags
1558  *
1559  * @param string $type
1560  * @param string $name
1561  * @param int    $changedsince default null
1562  * @return records array
1563  */
1564 function get_cache_flag($type, $name, $changedsince=NULL) {
1565     global $DB;
1567     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1569     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1570     if ($changedsince !== NULL) {
1571         $params['changedsince'] = $changedsince;
1572         $sqlwhere .= " AND timemodified > :changedsince";
1573     }
1575     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1578 /**
1579  * Set a volatile flag
1580  *
1581  * @param string $type the "type" namespace for the key
1582  * @param string $name the key to set
1583  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1584  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1585  * @return bool Always returns true
1586  */
1587 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1588     global $DB;
1590     $timemodified = time();
1591     if ($expiry===NULL || $expiry < $timemodified) {
1592         $expiry = $timemodified + 24 * 60 * 60;
1593     } else {
1594         $expiry = (int)$expiry;
1595     }
1597     if ($value === NULL) {
1598         unset_cache_flag($type,$name);
1599         return true;
1600     }
1602     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1603         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1604             return true; //no need to update
1605         }
1606         $f->value        = $value;
1607         $f->expiry       = $expiry;
1608         $f->timemodified = $timemodified;
1609         $DB->update_record('cache_flags', $f);
1610     } else {
1611         $f = new stdClass();
1612         $f->flagtype     = $type;
1613         $f->name         = $name;
1614         $f->value        = $value;
1615         $f->expiry       = $expiry;
1616         $f->timemodified = $timemodified;
1617         $DB->insert_record('cache_flags', $f);
1618     }
1619     return true;
1622 /**
1623  * Removes a single volatile flag
1624  *
1625  * @global object
1626  * @param string $type the "type" namespace for the key
1627  * @param string $name the key to set
1628  * @return bool
1629  */
1630 function unset_cache_flag($type, $name) {
1631     global $DB;
1632     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1633     return true;
1636 /**
1637  * Garbage-collect volatile flags
1638  *
1639  * @return bool Always returns true
1640  */
1641 function gc_cache_flags() {
1642     global $DB;
1643     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1644     return true;
1647 // USER PREFERENCE API
1649 /**
1650  * Refresh user preference cache. This is used most often for $USER
1651  * object that is stored in session, but it also helps with performance in cron script.
1652  *
1653  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1654  *
1655  * @package  core
1656  * @category preference
1657  * @access   public
1658  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1659  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1660  * @throws   coding_exception
1661  * @return   null
1662  */
1663 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1664     global $DB;
1665     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1667     if (!isset($user->id)) {
1668         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1669     }
1671     if (empty($user->id) or isguestuser($user->id)) {
1672         // No permanent storage for not-logged-in users and guest
1673         if (!isset($user->preference)) {
1674             $user->preference = array();
1675         }
1676         return;
1677     }
1679     $timenow = time();
1681     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1682         // Already loaded at least once on this page. Are we up to date?
1683         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1684             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1685             return;
1687         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1688             // no change since the lastcheck on this page
1689             $user->preference['_lastloaded'] = $timenow;
1690             return;
1691         }
1692     }
1694     // OK, so we have to reload all preferences
1695     $loadedusers[$user->id] = true;
1696     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1697     $user->preference['_lastloaded'] = $timenow;
1700 /**
1701  * Called from set/unset_user_preferences, so that the prefs can
1702  * be correctly reloaded in different sessions.
1703  *
1704  * NOTE: internal function, do not call from other code.
1705  *
1706  * @package core
1707  * @access  private
1708  * @param   integer         $userid the user whose prefs were changed.
1709  */
1710 function mark_user_preferences_changed($userid) {
1711     global $CFG;
1713     if (empty($userid) or isguestuser($userid)) {
1714         // no cache flags for guest and not-logged-in users
1715         return;
1716     }
1718     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1721 /**
1722  * Sets a preference for the specified user.
1723  *
1724  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1725  *
1726  * @package  core
1727  * @category preference
1728  * @access   public
1729  * @param    string            $name  The key to set as preference for the specified user
1730  * @param    string            $value The value to set for the $name key in the specified user's
1731  *                                    record, null means delete current value.
1732  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1733  * @throws   coding_exception
1734  * @return   bool                     Always true or exception
1735  */
1736 function set_user_preference($name, $value, $user = null) {
1737     global $USER, $DB;
1739     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1740         throw new coding_exception('Invalid preference name in set_user_preference() call');
1741     }
1743     if (is_null($value)) {
1744         // null means delete current
1745         return unset_user_preference($name, $user);
1746     } else if (is_object($value)) {
1747         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1748     } else if (is_array($value)) {
1749         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1750     }
1751     $value = (string)$value;
1752     if (textlib::strlen($value) > 1333) { //value column maximum length is 1333 characters
1753         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1754     }
1756     if (is_null($user)) {
1757         $user = $USER;
1758     } else if (isset($user->id)) {
1759         // $user is valid object
1760     } else if (is_numeric($user)) {
1761         $user = (object)array('id'=>(int)$user);
1762     } else {
1763         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1764     }
1766     check_user_preferences_loaded($user);
1768     if (empty($user->id) or isguestuser($user->id)) {
1769         // no permanent storage for not-logged-in users and guest
1770         $user->preference[$name] = $value;
1771         return true;
1772     }
1774     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1775         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1776             // preference already set to this value
1777             return true;
1778         }
1779         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1781     } else {
1782         $preference = new stdClass();
1783         $preference->userid = $user->id;
1784         $preference->name   = $name;
1785         $preference->value  = $value;
1786         $DB->insert_record('user_preferences', $preference);
1787     }
1789     // update value in cache
1790     $user->preference[$name] = $value;
1792     // set reload flag for other sessions
1793     mark_user_preferences_changed($user->id);
1795     return true;
1798 /**
1799  * Sets a whole array of preferences for the current user
1800  *
1801  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1802  *
1803  * @package  core
1804  * @category preference
1805  * @access   public
1806  * @param    array             $prefarray An array of key/value pairs to be set
1807  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1808  * @return   bool                         Always true or exception
1809  */
1810 function set_user_preferences(array $prefarray, $user = null) {
1811     foreach ($prefarray as $name => $value) {
1812         set_user_preference($name, $value, $user);
1813     }
1814     return true;
1817 /**
1818  * Unsets a preference completely by deleting it from the database
1819  *
1820  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1821  *
1822  * @package  core
1823  * @category preference
1824  * @access   public
1825  * @param    string            $name The key to unset as preference for the specified user
1826  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1827  * @throws   coding_exception
1828  * @return   bool                    Always true or exception
1829  */
1830 function unset_user_preference($name, $user = null) {
1831     global $USER, $DB;
1833     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1834         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1835     }
1837     if (is_null($user)) {
1838         $user = $USER;
1839     } else if (isset($user->id)) {
1840         // $user is valid object
1841     } else if (is_numeric($user)) {
1842         $user = (object)array('id'=>(int)$user);
1843     } else {
1844         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1845     }
1847     check_user_preferences_loaded($user);
1849     if (empty($user->id) or isguestuser($user->id)) {
1850         // no permanent storage for not-logged-in user and guest
1851         unset($user->preference[$name]);
1852         return true;
1853     }
1855     // delete from DB
1856     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1858     // delete the preference from cache
1859     unset($user->preference[$name]);
1861     // set reload flag for other sessions
1862     mark_user_preferences_changed($user->id);
1864     return true;
1867 /**
1868  * Used to fetch user preference(s)
1869  *
1870  * If no arguments are supplied this function will return
1871  * all of the current user preferences as an array.
1872  *
1873  * If a name is specified then this function
1874  * attempts to return that particular preference value.  If
1875  * none is found, then the optional value $default is returned,
1876  * otherwise NULL.
1877  *
1878  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1879  *
1880  * @package  core
1881  * @category preference
1882  * @access   public
1883  * @param    string            $name    Name of the key to use in finding a preference value
1884  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1885  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1886  * @throws   coding_exception
1887  * @return   string|mixed|null          A string containing the value of a single preference. An
1888  *                                      array with all of the preferences or null
1889  */
1890 function get_user_preferences($name = null, $default = null, $user = null) {
1891     global $USER;
1893     if (is_null($name)) {
1894         // all prefs
1895     } else if (is_numeric($name) or $name === '_lastloaded') {
1896         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1897     }
1899     if (is_null($user)) {
1900         $user = $USER;
1901     } else if (isset($user->id)) {
1902         // $user is valid object
1903     } else if (is_numeric($user)) {
1904         $user = (object)array('id'=>(int)$user);
1905     } else {
1906         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1907     }
1909     check_user_preferences_loaded($user);
1911     if (empty($name)) {
1912         return $user->preference; // All values
1913     } else if (isset($user->preference[$name])) {
1914         return $user->preference[$name]; // The single string value
1915     } else {
1916         return $default; // Default value (null if not specified)
1917     }
1920 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1922 /**
1923  * Given date parts in user time produce a GMT timestamp.
1924  *
1925  * @package core
1926  * @category time
1927  * @param int $year The year part to create timestamp of
1928  * @param int $month The month part to create timestamp of
1929  * @param int $day The day part to create timestamp of
1930  * @param int $hour The hour part to create timestamp of
1931  * @param int $minute The minute part to create timestamp of
1932  * @param int $second The second part to create timestamp of
1933  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
1934  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
1935  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1936  *             applied only if timezone is 99 or string.
1937  * @return int GMT timestamp
1938  */
1939 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1941     //save input timezone, required for dst offset check.
1942     $passedtimezone = $timezone;
1944     $timezone = get_user_timezone_offset($timezone);
1946     if (abs($timezone) > 13) {  //server time
1947         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1948     } else {
1949         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1950         $time = usertime($time, $timezone);
1952         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1953         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1954             $time -= dst_offset_on($time, $passedtimezone);
1955         }
1956     }
1958     return $time;
1962 /**
1963  * Format a date/time (seconds) as weeks, days, hours etc as needed
1964  *
1965  * Given an amount of time in seconds, returns string
1966  * formatted nicely as weeks, days, hours etc as needed
1967  *
1968  * @package core
1969  * @category time
1970  * @uses MINSECS
1971  * @uses HOURSECS
1972  * @uses DAYSECS
1973  * @uses YEARSECS
1974  * @param int $totalsecs Time in seconds
1975  * @param object $str Should be a time object
1976  * @return string A nicely formatted date/time string
1977  */
1978  function format_time($totalsecs, $str=NULL) {
1980     $totalsecs = abs($totalsecs);
1982     if (!$str) {  // Create the str structure the slow way
1983         $str = new stdClass();
1984         $str->day   = get_string('day');
1985         $str->days  = get_string('days');
1986         $str->hour  = get_string('hour');
1987         $str->hours = get_string('hours');
1988         $str->min   = get_string('min');
1989         $str->mins  = get_string('mins');
1990         $str->sec   = get_string('sec');
1991         $str->secs  = get_string('secs');
1992         $str->year  = get_string('year');
1993         $str->years = get_string('years');
1994     }
1997     $years     = floor($totalsecs/YEARSECS);
1998     $remainder = $totalsecs - ($years*YEARSECS);
1999     $days      = floor($remainder/DAYSECS);
2000     $remainder = $totalsecs - ($days*DAYSECS);
2001     $hours     = floor($remainder/HOURSECS);
2002     $remainder = $remainder - ($hours*HOURSECS);
2003     $mins      = floor($remainder/MINSECS);
2004     $secs      = $remainder - ($mins*MINSECS);
2006     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2007     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2008     $sh = ($hours == 1) ? $str->hour : $str->hours;
2009     $sd = ($days == 1)  ? $str->day  : $str->days;
2010     $sy = ($years == 1)  ? $str->year  : $str->years;
2012     $oyears = '';
2013     $odays = '';
2014     $ohours = '';
2015     $omins = '';
2016     $osecs = '';
2018     if ($years)  $oyears  = $years .' '. $sy;
2019     if ($days)  $odays  = $days .' '. $sd;
2020     if ($hours) $ohours = $hours .' '. $sh;
2021     if ($mins)  $omins  = $mins .' '. $sm;
2022     if ($secs)  $osecs  = $secs .' '. $ss;
2024     if ($years) return trim($oyears .' '. $odays);
2025     if ($days)  return trim($odays .' '. $ohours);
2026     if ($hours) return trim($ohours .' '. $omins);
2027     if ($mins)  return trim($omins .' '. $osecs);
2028     if ($secs)  return $osecs;
2029     return get_string('now');
2032 /**
2033  * Returns a formatted string that represents a date in user time
2034  *
2035  * Returns a formatted string that represents a date in user time
2036  * <b>WARNING: note that the format is for strftime(), not date().</b>
2037  * Because of a bug in most Windows time libraries, we can't use
2038  * the nicer %e, so we have to use %d which has leading zeroes.
2039  * A lot of the fuss in the function is just getting rid of these leading
2040  * zeroes as efficiently as possible.
2041  *
2042  * If parameter fixday = true (default), then take off leading
2043  * zero from %d, else maintain it.
2044  *
2045  * @package core
2046  * @category time
2047  * @param int $date the timestamp in UTC, as obtained from the database.
2048  * @param string $format strftime format. You should probably get this using
2049  *        get_string('strftime...', 'langconfig');
2050  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
2051  *        not 99 then daylight saving will not be added.
2052  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2053  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2054  *        If false then the leading zero is maintained.
2055  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2056  * @return string the formatted date/time.
2057  */
2058 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2060     global $CFG;
2062     if (empty($format)) {
2063         $format = get_string('strftimedaydatetime', 'langconfig');
2064     }
2066     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
2067         $fixday = false;
2068     } else if ($fixday) {
2069         $formatnoday = str_replace('%d', 'DD', $format);
2070         $fixday = ($formatnoday != $format);
2071         $format = $formatnoday;
2072     }
2074     // Note: This logic about fixing 12-hour time to remove unnecessary leading
2075     // zero is required because on Windows, PHP strftime function does not
2076     // support the correct 'hour without leading zero' parameter (%l).
2077     if (!empty($CFG->nofixhour)) {
2078         // Config.php can force %I not to be fixed.
2079         $fixhour = false;
2080     } else if ($fixhour) {
2081         $formatnohour = str_replace('%I', 'HH', $format);
2082         $fixhour = ($formatnohour != $format);
2083         $format = $formatnohour;
2084     }
2086     //add daylight saving offset for string timezones only, as we can't get dst for
2087     //float values. if timezone is 99 (user default timezone), then try update dst.
2088     if ((99 == $timezone) || !is_numeric($timezone)) {
2089         $date += dst_offset_on($date, $timezone);
2090     }
2092     $timezone = get_user_timezone_offset($timezone);
2094     // If we are running under Windows convert to windows encoding and then back to UTF-8
2095     // (because it's impossible to specify UTF-8 to fetch locale info in Win32)
2097     if (abs($timezone) > 13) {   /// Server time
2098         $datestring = date_format_string($date, $format, $timezone);
2099         if ($fixday) {
2100             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
2101             $datestring = str_replace('DD', $daystring, $datestring);
2102         }
2103         if ($fixhour) {
2104             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
2105             $datestring = str_replace('HH', $hourstring, $datestring);
2106         }
2108     } else {
2109         $date += (int)($timezone * 3600);
2110         $datestring = date_format_string($date, $format, $timezone);
2111         if ($fixday) {
2112             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2113             $datestring = str_replace('DD', $daystring, $datestring);
2114         }
2115         if ($fixhour) {
2116             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2117             $datestring = str_replace('HH', $hourstring, $datestring);
2118         }
2119     }
2121     return $datestring;
2124 /**
2125  * Returns a formatted date ensuring it is UTF-8.
2126  *
2127  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2128  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2129  *
2130  * This function does not do any calculation regarding the user preferences and should
2131  * therefore receive the final date timestamp, format and timezone. Timezone being only used
2132  * to differenciate the use of server time or not (strftime() against gmstrftime()).
2133  *
2134  * @param int $date the timestamp.
2135  * @param string $format strftime format.
2136  * @param int|float $timezone the numerical timezone, typically returned by {@link get_user_timezone_offset()}.
2137  * @return string the formatted date/time.
2138  * @since 2.3.3
2139  */
2140 function date_format_string($date, $format, $tz = 99) {
2141     global $CFG;
2142     if (abs($tz) > 13) {
2143         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2144             $format = textlib::convert($format, 'utf-8', $localewincharset);
2145             $datestring = strftime($format, $date);
2146             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2147         } else {
2148             $datestring = strftime($format, $date);
2149         }
2150     } else {
2151         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2152             $format = textlib::convert($format, 'utf-8', $localewincharset);
2153             $datestring = gmstrftime($format, $date);
2154             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2155         } else {
2156             $datestring = gmstrftime($format, $date);
2157         }
2158     }
2159     return $datestring;
2162 /**
2163  * Given a $time timestamp in GMT (seconds since epoch),
2164  * returns an array that represents the date in user time
2165  *
2166  * @package core
2167  * @category time
2168  * @uses HOURSECS
2169  * @param int $time Timestamp in GMT
2170  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2171  *        dst offset is applyed {@link http://docs.moodle.org/dev/Time_API#Timezone}
2172  * @return array An array that represents the date in user time
2173  */
2174 function usergetdate($time, $timezone=99) {
2176     //save input timezone, required for dst offset check.
2177     $passedtimezone = $timezone;
2179     $timezone = get_user_timezone_offset($timezone);
2181     if (abs($timezone) > 13) {    // Server time
2182         return getdate($time);
2183     }
2185     //add daylight saving offset for string timezones only, as we can't get dst for
2186     //float values. if timezone is 99 (user default timezone), then try update dst.
2187     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2188         $time += dst_offset_on($time, $passedtimezone);
2189     }
2191     $time += intval((float)$timezone * HOURSECS);
2193     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2195     //be careful to ensure the returned array matches that produced by getdate() above
2196     list(
2197         $getdate['month'],
2198         $getdate['weekday'],
2199         $getdate['yday'],
2200         $getdate['year'],
2201         $getdate['mon'],
2202         $getdate['wday'],
2203         $getdate['mday'],
2204         $getdate['hours'],
2205         $getdate['minutes'],
2206         $getdate['seconds']
2207     ) = explode('_', $datestring);
2209     // set correct datatype to match with getdate()
2210     $getdate['seconds'] = (int)$getdate['seconds'];
2211     $getdate['yday'] = (int)$getdate['yday'] - 1; // gettime returns 0 through 365
2212     $getdate['year'] = (int)$getdate['year'];
2213     $getdate['mon'] = (int)$getdate['mon'];
2214     $getdate['wday'] = (int)$getdate['wday'];
2215     $getdate['mday'] = (int)$getdate['mday'];
2216     $getdate['hours'] = (int)$getdate['hours'];
2217     $getdate['minutes']  = (int)$getdate['minutes'];
2218     return $getdate;
2221 /**
2222  * Given a GMT timestamp (seconds since epoch), offsets it by
2223  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2224  *
2225  * @package core
2226  * @category time
2227  * @uses HOURSECS
2228  * @param int $date Timestamp in GMT
2229  * @param float|int|string $timezone timezone to calculate GMT time offset before
2230  *        calculating user time, 99 is default user timezone
2231  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2232  * @return int
2233  */
2234 function usertime($date, $timezone=99) {
2236     $timezone = get_user_timezone_offset($timezone);
2238     if (abs($timezone) > 13) {
2239         return $date;
2240     }
2241     return $date - (int)($timezone * HOURSECS);
2244 /**
2245  * Given a time, return the GMT timestamp of the most recent midnight
2246  * for the current user.
2247  *
2248  * @package core
2249  * @category time
2250  * @param int $date Timestamp in GMT
2251  * @param float|int|string $timezone timezone to calculate GMT time offset before
2252  *        calculating user midnight time, 99 is default user timezone
2253  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2254  * @return int Returns a GMT timestamp
2255  */
2256 function usergetmidnight($date, $timezone=99) {
2258     $userdate = usergetdate($date, $timezone);
2260     // Time of midnight of this user's day, in GMT
2261     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2265 /**
2266  * Returns a string that prints the user's timezone
2267  *
2268  * @package core
2269  * @category time
2270  * @param float|int|string $timezone timezone to calculate GMT time offset before
2271  *        calculating user timezone, 99 is default user timezone
2272  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2273  * @return string
2274  */
2275 function usertimezone($timezone=99) {
2277     $tz = get_user_timezone($timezone);
2279     if (!is_float($tz)) {
2280         return $tz;
2281     }
2283     if(abs($tz) > 13) { // Server time
2284         return get_string('serverlocaltime');
2285     }
2287     if($tz == intval($tz)) {
2288         // Don't show .0 for whole hours
2289         $tz = intval($tz);
2290     }
2292     if($tz == 0) {
2293         return 'UTC';
2294     }
2295     else if($tz > 0) {
2296         return 'UTC+'.$tz;
2297     }
2298     else {
2299         return 'UTC'.$tz;
2300     }
2304 /**
2305  * Returns a float which represents the user's timezone difference from GMT in hours
2306  * Checks various settings and picks the most dominant of those which have a value
2307  *
2308  * @package core
2309  * @category time
2310  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2311  *        99 is default user timezone
2312  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2313  * @return float
2314  */
2315 function get_user_timezone_offset($tz = 99) {
2317     global $USER, $CFG;
2319     $tz = get_user_timezone($tz);
2321     if (is_float($tz)) {
2322         return $tz;
2323     } else {
2324         $tzrecord = get_timezone_record($tz);
2325         if (empty($tzrecord)) {
2326             return 99.0;
2327         }
2328         return (float)$tzrecord->gmtoff / HOURMINS;
2329     }
2332 /**
2333  * Returns an int which represents the systems's timezone difference from GMT in seconds
2334  *
2335  * @package core
2336  * @category time
2337  * @param float|int|string $tz timezone for which offset is required.
2338  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2339  * @return int|bool if found, false is timezone 99 or error
2340  */
2341 function get_timezone_offset($tz) {
2342     global $CFG;
2344     if ($tz == 99) {
2345         return false;
2346     }
2348     if (is_numeric($tz)) {
2349         return intval($tz * 60*60);
2350     }
2352     if (!$tzrecord = get_timezone_record($tz)) {
2353         return false;
2354     }
2355     return intval($tzrecord->gmtoff * 60);
2358 /**
2359  * Returns a float or a string which denotes the user's timezone
2360  * 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)
2361  * means that for this timezone there are also DST rules to be taken into account
2362  * Checks various settings and picks the most dominant of those which have a value
2363  *
2364  * @package core
2365  * @category time
2366  * @param float|int|string $tz timezone to calculate GMT time offset before
2367  *        calculating user timezone, 99 is default user timezone
2368  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2369  * @return float|string
2370  */
2371 function get_user_timezone($tz = 99) {
2372     global $USER, $CFG;
2374     $timezones = array(
2375         $tz,
2376         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2377         isset($USER->timezone) ? $USER->timezone : 99,
2378         isset($CFG->timezone) ? $CFG->timezone : 99,
2379         );
2381     $tz = 99;
2383     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array
2384     while(((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2385         $tz = $next['value'];
2386     }
2387     return is_numeric($tz) ? (float) $tz : $tz;
2390 /**
2391  * Returns cached timezone record for given $timezonename
2392  *
2393  * @package core
2394  * @param string $timezonename name of the timezone
2395  * @return stdClass|bool timezonerecord or false
2396  */
2397 function get_timezone_record($timezonename) {
2398     global $CFG, $DB;
2399     static $cache = NULL;
2401     if ($cache === NULL) {
2402         $cache = array();
2403     }
2405     if (isset($cache[$timezonename])) {
2406         return $cache[$timezonename];
2407     }
2409     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2410                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2413 /**
2414  * Build and store the users Daylight Saving Time (DST) table
2415  *
2416  * @package core
2417  * @param int $from_year Start year for the table, defaults to 1971
2418  * @param int $to_year End year for the table, defaults to 2035
2419  * @param int|float|string $strtimezone, timezone to check if dst should be applyed.
2420  * @return bool
2421  */
2422 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2423     global $CFG, $SESSION, $DB;
2425     $usertz = get_user_timezone($strtimezone);
2427     if (is_float($usertz)) {
2428         // Trivial timezone, no DST
2429         return false;
2430     }
2432     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2433         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2434         unset($SESSION->dst_offsets);
2435         unset($SESSION->dst_range);
2436     }
2438     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2439         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2440         // This will be the return path most of the time, pretty light computationally
2441         return true;
2442     }
2444     // Reaching here means we either need to extend our table or create it from scratch
2446     // Remember which TZ we calculated these changes for
2447     $SESSION->dst_offsettz = $usertz;
2449     if(empty($SESSION->dst_offsets)) {
2450         // If we 're creating from scratch, put the two guard elements in there
2451         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2452     }
2453     if(empty($SESSION->dst_range)) {
2454         // If creating from scratch
2455         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2456         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2458         // Fill in the array with the extra years we need to process
2459         $yearstoprocess = array();
2460         for($i = $from; $i <= $to; ++$i) {
2461             $yearstoprocess[] = $i;
2462         }
2464         // Take note of which years we have processed for future calls
2465         $SESSION->dst_range = array($from, $to);
2466     }
2467     else {
2468         // If needing to extend the table, do the same
2469         $yearstoprocess = array();
2471         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2472         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2474         if($from < $SESSION->dst_range[0]) {
2475             // Take note of which years we need to process and then note that we have processed them for future calls
2476             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2477                 $yearstoprocess[] = $i;
2478             }
2479             $SESSION->dst_range[0] = $from;
2480         }
2481         if($to > $SESSION->dst_range[1]) {
2482             // Take note of which years we need to process and then note that we have processed them for future calls
2483             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2484                 $yearstoprocess[] = $i;
2485             }
2486             $SESSION->dst_range[1] = $to;
2487         }
2488     }
2490     if(empty($yearstoprocess)) {
2491         // This means that there was a call requesting a SMALLER range than we have already calculated
2492         return true;
2493     }
2495     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2496     // Also, the array is sorted in descending timestamp order!
2498     // Get DB data
2500     static $presets_cache = array();
2501     if (!isset($presets_cache[$usertz])) {
2502         $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');
2503     }
2504     if(empty($presets_cache[$usertz])) {
2505         return false;
2506     }
2508     // Remove ending guard (first element of the array)
2509     reset($SESSION->dst_offsets);
2510     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2512     // Add all required change timestamps
2513     foreach($yearstoprocess as $y) {
2514         // Find the record which is in effect for the year $y
2515         foreach($presets_cache[$usertz] as $year => $preset) {
2516             if($year <= $y) {
2517                 break;
2518             }
2519         }
2521         $changes = dst_changes_for_year($y, $preset);
2523         if($changes === NULL) {
2524             continue;
2525         }
2526         if($changes['dst'] != 0) {
2527             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2528         }
2529         if($changes['std'] != 0) {
2530             $SESSION->dst_offsets[$changes['std']] = 0;
2531         }
2532     }
2534     // Put in a guard element at the top
2535     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2536     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2538     // Sort again
2539     krsort($SESSION->dst_offsets);
2541     return true;
2544 /**
2545  * Calculates the required DST change and returns a Timestamp Array
2546  *
2547  * @package core
2548  * @category time
2549  * @uses HOURSECS
2550  * @uses MINSECS
2551  * @param int|string $year Int or String Year to focus on
2552  * @param object $timezone Instatiated Timezone object
2553  * @return array|null Array dst=>xx, 0=>xx, std=>yy, 1=>yy or NULL
2554  */
2555 function dst_changes_for_year($year, $timezone) {
2557     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2558         return NULL;
2559     }
2561     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2562     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2564     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2565     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2567     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2568     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2570     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2571     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2572     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2574     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2575     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2577     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2580 /**
2581  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2582  * - Note: Daylight saving only works for string timezones and not for float.
2583  *
2584  * @package core
2585  * @category time
2586  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2587  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2588  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2589  * @return int
2590  */
2591 function dst_offset_on($time, $strtimezone = NULL) {
2592     global $SESSION;
2594     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2595         return 0;
2596     }
2598     reset($SESSION->dst_offsets);
2599     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2600         if($from <= $time) {
2601             break;
2602         }
2603     }
2605     // This is the normal return path
2606     if($offset !== NULL) {
2607         return $offset;
2608     }
2610     // Reaching this point means we haven't calculated far enough, do it now:
2611     // Calculate extra DST changes if needed and recurse. The recursion always
2612     // moves toward the stopping condition, so will always end.
2614     if($from == 0) {
2615         // We need a year smaller than $SESSION->dst_range[0]
2616         if($SESSION->dst_range[0] == 1971) {
2617             return 0;
2618         }
2619         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2620         return dst_offset_on($time, $strtimezone);
2621     }
2622     else {
2623         // We need a year larger than $SESSION->dst_range[1]
2624         if($SESSION->dst_range[1] == 2035) {
2625             return 0;
2626         }
2627         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2628         return dst_offset_on($time, $strtimezone);
2629     }
2632 /**
2633  * Calculates when the day appears in specific month
2634  *
2635  * @package core
2636  * @category time
2637  * @param int $startday starting day of the month
2638  * @param int $weekday The day when week starts (normally taken from user preferences)
2639  * @param int $month The month whose day is sought
2640  * @param int $year The year of the month whose day is sought
2641  * @return int
2642  */
2643 function find_day_in_month($startday, $weekday, $month, $year) {
2645     $daysinmonth = days_in_month($month, $year);
2647     if($weekday == -1) {
2648         // Don't care about weekday, so return:
2649         //    abs($startday) if $startday != -1
2650         //    $daysinmonth otherwise
2651         return ($startday == -1) ? $daysinmonth : abs($startday);
2652     }
2654     // From now on we 're looking for a specific weekday
2656     // Give "end of month" its actual value, since we know it
2657     if($startday == -1) {
2658         $startday = -1 * $daysinmonth;
2659     }
2661     // Starting from day $startday, the sign is the direction
2663     if($startday < 1) {
2665         $startday = abs($startday);
2666         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2668         // This is the last such weekday of the month
2669         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2670         if($lastinmonth > $daysinmonth) {
2671             $lastinmonth -= 7;
2672         }
2674         // Find the first such weekday <= $startday
2675         while($lastinmonth > $startday) {
2676             $lastinmonth -= 7;
2677         }
2679         return $lastinmonth;
2681     }
2682     else {
2684         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2686         $diff = $weekday - $indexweekday;
2687         if($diff < 0) {
2688             $diff += 7;
2689         }
2691         // This is the first such weekday of the month equal to or after $startday
2692         $firstfromindex = $startday + $diff;
2694         return $firstfromindex;
2696     }
2699 /**
2700  * Calculate the number of days in a given month
2701  *
2702  * @package core
2703  * @category time
2704  * @param int $month The month whose day count is sought
2705  * @param int $year The year of the month whose day count is sought
2706  * @return int
2707  */
2708 function days_in_month($month, $year) {
2709    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2712 /**
2713  * Calculate the position in the week of a specific calendar day
2714  *
2715  * @package core
2716  * @category time
2717  * @param int $day The day of the date whose position in the week is sought
2718  * @param int $month The month of the date whose position in the week is sought
2719  * @param int $year The year of the date whose position in the week is sought
2720  * @return int
2721  */
2722 function dayofweek($day, $month, $year) {
2723     // I wonder if this is any different from
2724     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2725     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2728 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2730 /**
2731  * Returns full login url.
2732  *
2733  * @return string login url
2734  */
2735 function get_login_url() {
2736     global $CFG;
2738     $url = "$CFG->wwwroot/login/index.php";
2740     if (!empty($CFG->loginhttps)) {
2741         $url = str_replace('http:', 'https:', $url);
2742     }
2744     return $url;
2747 /**
2748  * This function checks that the current user is logged in and has the
2749  * required privileges
2750  *
2751  * This function checks that the current user is logged in, and optionally
2752  * whether they are allowed to be in a particular course and view a particular
2753  * course module.
2754  * If they are not logged in, then it redirects them to the site login unless
2755  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2756  * case they are automatically logged in as guests.
2757  * If $courseid is given and the user is not enrolled in that course then the
2758  * user is redirected to the course enrolment page.
2759  * If $cm is given and the course module is hidden and the user is not a teacher
2760  * in the course then the user is redirected to the course home page.
2761  *
2762  * When $cm parameter specified, this function sets page layout to 'module'.
2763  * You need to change it manually later if some other layout needed.
2764  *
2765  * @package    core_access
2766  * @category   access
2767  *
2768  * @param mixed $courseorid id of the course or course object
2769  * @param bool $autologinguest default true
2770  * @param object $cm course module object
2771  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2772  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2773  *             in order to keep redirects working properly. MDL-14495
2774  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2775  * @return mixed Void, exit, and die depending on path
2776  */
2777 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2778     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2780     // setup global $COURSE, themes, language and locale
2781     if (!empty($courseorid)) {
2782         if (is_object($courseorid)) {
2783             $course = $courseorid;
2784         } else if ($courseorid == SITEID) {
2785             $course = clone($SITE);
2786         } else {
2787             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2788         }
2789         if ($cm) {
2790             if ($cm->course != $course->id) {
2791                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2792             }
2793             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2794             if (!($cm instanceof cm_info)) {
2795                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2796                 // db queries so this is not really a performance concern, however it is obviously
2797                 // better if you use get_fast_modinfo to get the cm before calling this.
2798                 $modinfo = get_fast_modinfo($course);
2799                 $cm = $modinfo->get_cm($cm->id);
2800             }
2801             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2802             $PAGE->set_pagelayout('incourse');
2803         } else {
2804             $PAGE->set_course($course); // set's up global $COURSE
2805         }
2806     } else {
2807         // do not touch global $COURSE via $PAGE->set_course(),
2808         // the reasons is we need to be able to call require_login() at any time!!
2809         $course = $SITE;
2810         if ($cm) {
2811             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2812         }
2813     }
2815     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2816     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2817     // risk leading the user back to the AJAX request URL.
2818     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2819         $setwantsurltome = false;
2820     }
2822     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2823     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2824         if ($setwantsurltome) {
2825             $SESSION->wantsurl = qualified_me();
2826         }
2827         redirect(get_login_url());
2828     }
2830     // If the user is not even logged in yet then make sure they are
2831     if (!isloggedin()) {
2832         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2833             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2834                 // misconfigured site guest, just redirect to login page
2835                 redirect(get_login_url());
2836                 exit; // never reached
2837             }
2838             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2839             complete_user_login($guest);
2840             $USER->autologinguest = true;
2841             $SESSION->lang = $lang;
2842         } else {
2843             //NOTE: $USER->site check was obsoleted by session test cookie,
2844             //      $USER->confirmed test is in login/index.php
2845             if ($preventredirect) {
2846                 throw new require_login_exception('You are not logged in');
2847             }
2849             if ($setwantsurltome) {
2850                 $SESSION->wantsurl = qualified_me();
2851             }
2852             if (!empty($_SERVER['HTTP_REFERER'])) {
2853                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2854             }
2855             redirect(get_login_url());
2856             exit; // never reached
2857         }
2858     }
2860     // loginas as redirection if needed
2861     if ($course->id != SITEID and session_is_loggedinas()) {
2862         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2863             if ($USER->loginascontext->instanceid != $course->id) {
2864                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2865             }
2866         }
2867     }
2869     // check whether the user should be changing password (but only if it is REALLY them)
2870     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2871         $userauth = get_auth_plugin($USER->auth);
2872         if ($userauth->can_change_password() and !$preventredirect) {
2873             if ($setwantsurltome) {
2874                 $SESSION->wantsurl = qualified_me();
2875             }
2876             if ($changeurl = $userauth->change_password_url()) {
2877                 //use plugin custom url
2878                 redirect($changeurl);
2879             } else {
2880                 //use moodle internal method
2881                 if (empty($CFG->loginhttps)) {
2882                     redirect($CFG->wwwroot .'/login/change_password.php');
2883                 } else {
2884                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2885                     redirect($wwwroot .'/login/change_password.php');
2886                 }
2887             }
2888         } else {
2889             print_error('nopasswordchangeforced', 'auth');
2890         }
2891     }
2893     // Check that the user account is properly set up
2894     if (user_not_fully_set_up($USER)) {
2895         if ($preventredirect) {
2896             throw new require_login_exception('User not fully set-up');
2897         }
2898         if ($setwantsurltome) {
2899             $SESSION->wantsurl = qualified_me();
2900         }
2901         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2902     }
2904     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2905     sesskey();
2907     // Do not bother admins with any formalities
2908     if (is_siteadmin()) {
2909         //set accesstime or the user will appear offline which messes up messaging
2910         user_accesstime_log($course->id);
2911         return;
2912     }
2914     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2915     if (!$USER->policyagreed and !is_siteadmin()) {
2916         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2917             if ($preventredirect) {
2918                 throw new require_login_exception('Policy not agreed');
2919             }
2920             if ($setwantsurltome) {
2921                 $SESSION->wantsurl = qualified_me();
2922             }
2923             redirect($CFG->wwwroot .'/user/policy.php');
2924         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2925             if ($preventredirect) {
2926                 throw new require_login_exception('Policy not agreed');
2927             }
2928             if ($setwantsurltome) {
2929                 $SESSION->wantsurl = qualified_me();
2930             }
2931             redirect($CFG->wwwroot .'/user/policy.php');
2932         }
2933     }
2935     // Fetch the system context, the course context, and prefetch its child contexts
2936     $sysctx = context_system::instance();
2937     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2938     if ($cm) {
2939         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2940     } else {
2941         $cmcontext = null;
2942     }
2944     // If the site is currently under maintenance, then print a message
2945     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2946         if ($preventredirect) {
2947             throw new require_login_exception('Maintenance in progress');
2948         }
2950         print_maintenance_message();
2951     }
2953     // make sure the course itself is not hidden
2954     if ($course->id == SITEID) {
2955         // frontpage can not be hidden
2956     } else {
2957         if (is_role_switched($course->id)) {
2958             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2959         } else {
2960             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2961                 // originally there was also test of parent category visibility,
2962                 // BUT is was very slow in complex queries involving "my courses"
2963                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2964                 if ($preventredirect) {
2965                     throw new require_login_exception('Course is hidden');
2966                 }
2967                 // We need to override the navigation URL as the course won't have
2968                 // been added to the navigation and thus the navigation will mess up
2969                 // when trying to find it.
2970                 navigation_node::override_active_url(new moodle_url('/'));
2971                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2972             }
2973         }
2974     }
2976     // is the user enrolled?
2977     if ($course->id == SITEID) {
2978         // everybody is enrolled on the frontpage
2980     } else {
2981         if (session_is_loggedinas()) {
2982             // Make sure the REAL person can access this course first
2983             $realuser = session_get_realuser();
2984             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2985                 if ($preventredirect) {
2986                     throw new require_login_exception('Invalid course login-as access');
2987                 }
2988                 echo $OUTPUT->header();
2989                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2990             }
2991         }
2993         $access = false;
2995         if (is_role_switched($course->id)) {
2996             // ok, user had to be inside this course before the switch
2997             $access = true;
2999         } else if (is_viewing($coursecontext, $USER)) {
3000             // ok, no need to mess with enrol
3001             $access = true;
3003         } else {
3004             if (isset($USER->enrol['enrolled'][$course->id])) {
3005                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3006                     $access = true;
3007                     if (isset($USER->enrol['tempguest'][$course->id])) {
3008                         unset($USER->enrol['tempguest'][$course->id]);
3009                         remove_temp_course_roles($coursecontext);
3010                     }
3011                 } else {
3012                     //expired
3013                     unset($USER->enrol['enrolled'][$course->id]);
3014                 }
3015             }
3016             if (isset($USER->enrol['tempguest'][$course->id])) {
3017                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3018                     $access = true;
3019                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3020                     $access = true;
3021                 } else {
3022                     //expired
3023                     unset($USER->enrol['tempguest'][$course->id]);
3024                     remove_temp_course_roles($coursecontext);
3025                 }
3026             }
3028             if ($access) {
3029                 // cache ok
3030             } else {
3031                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3032                 if ($until !== false) {
3033                     // active participants may always access, a timestamp in the future, 0 (always) or false.
3034                     if ($until == 0) {
3035                         $until = ENROL_MAX_TIMESTAMP;
3036                     }
3037                     $USER->enrol['enrolled'][$course->id] = $until;
3038                     $access = true;
3040                 } else {
3041                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
3042                     $enrols = enrol_get_plugins(true);
3043                     // first ask all enabled enrol instances in course if they want to auto enrol user
3044                     foreach($instances as $instance) {
3045                         if (!isset($enrols[$instance->enrol])) {
3046                             continue;
3047                         }
3048                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3049                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3050                         if ($until !== false) {
3051                             if ($until == 0) {
3052                                 $until = ENROL_MAX_TIMESTAMP;
3053                             }
3054                             $USER->enrol['enrolled'][$course->id] = $until;
3055                             $access = true;
3056                             break;
3057                         }
3058                     }
3059                     // if not enrolled yet try to gain temporary guest access
3060                     if (!$access) {
3061                         foreach($instances as $instance) {
3062                             if (!isset($enrols[$instance->enrol])) {
3063                                 continue;
3064                             }
3065                             // Get a duration for the guest access, a timestamp in the future or false.
3066                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3067                             if ($until !== false and $until > time()) {
3068                                 $USER->enrol['tempguest'][$course->id] = $until;
3069                                 $access = true;
3070                                 break;
3071                             }
3072                         }
3073                     }
3074                 }
3075             }
3076         }
3078         if (!$access) {
3079             if ($preventredirect) {
3080                 throw new require_login_exception('Not enrolled');
3081             }
3082             if ($setwantsurltome) {
3083                 $SESSION->wantsurl = qualified_me();
3084             }
3085             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3086         }
3087     }
3089     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
3090     // conditional availability, etc
3091     if ($cm && !$cm->uservisible) {
3092         if ($preventredirect) {
3093             throw new require_login_exception('Activity is hidden');
3094         }
3095         if ($course->id != SITEID) {
3096             $url = new moodle_url('/course/view.php', array('id'=>$course->id));
3097         } else {
3098             $url = new moodle_url('/');
3099         }
3100         redirect($url, get_string('activityiscurrentlyhidden'));
3101     }
3103     // Finally access granted, update lastaccess times
3104     user_accesstime_log($course->id);
3108 /**
3109  * This function just makes sure a user is logged out.
3110  *
3111  * @package    core_access
3112  */
3113 function require_logout() {
3114     global $USER;
3116     $params = $USER;
3118     if (isloggedin()) {
3119         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
3121         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
3122         foreach($authsequence as $authname) {
3123             $authplugin = get_auth_plugin($authname);
3124             $authplugin->prelogout_hook();
3125         }
3126     }
3128     events_trigger('user_logout', $params);
3129     session_get_instance()->terminate_current();
3130     unset($params);
3133 /**
3134  * Weaker version of require_login()
3135  *
3136  * This is a weaker version of {@link require_login()} which only requires login
3137  * when called from within a course rather than the site page, unless
3138  * the forcelogin option is turned on.
3139  * @see require_login()
3140  *
3141  * @package    core_access
3142  * @category   access
3143  *
3144  * @param mixed $courseorid The course object or id in question
3145  * @param bool $autologinguest Allow autologin guests if that is wanted
3146  * @param object $cm Course activity module if known
3147  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3148  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3149  *             in order to keep redirects working properly. MDL-14495
3150  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3151  * @return void
3152  */
3153 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
3154     global $CFG, $PAGE, $SITE;
3155     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3156           or (!is_object($courseorid) and $courseorid == SITEID);
3157     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3158         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
3159         // db queries so this is not really a performance concern, however it is obviously
3160         // better if you use get_fast_modinfo to get the cm before calling this.
3161         if (is_object($courseorid)) {
3162             $course = $courseorid;
3163         } else {
3164             $course = clone($SITE);
3165         }
3166         $modinfo = get_fast_modinfo($course);
3167         $cm = $modinfo->get_cm($cm->id);
3168     }
3169     if (!empty($CFG->forcelogin)) {
3170         // login required for both SITE and courses
3171         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3173     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3174         // always login for hidden activities
3175         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3177     } else if ($issite) {
3178               //login for SITE not required
3179         if ($cm and empty($cm->visible)) {
3180             // hidden activities are not accessible without login
3181             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3182         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3183             // not-logged-in users do not have any group membership
3184             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3185         } else {
3186             // We still need to instatiate PAGE vars properly so that things
3187             // that rely on it like navigation function correctly.
3188             if (!empty($courseorid)) {
3189                 if (is_object($courseorid)) {
3190                     $course = $courseorid;
3191                 } else {
3192                     $course = clone($SITE);
3193                 }
3194                 if ($cm) {
3195                     if ($cm->course != $course->id) {
3196                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3197                     }
3198                     $PAGE->set_cm($cm, $course);
3199                     $PAGE->set_pagelayout('incourse');
3200                 } else {
3201                     $PAGE->set_course($course);
3202                 }
3203             } else {
3204                 // If $PAGE->course, and hence $PAGE->context, have not already been set
3205                 // up properly, set them up now.
3206                 $PAGE->set_course($PAGE->course);
3207             }
3208             //TODO: verify conditional activities here
3209             user_accesstime_log(SITEID);
3210             return;
3211         }
3213     } else {
3214         // course login always required
3215         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3216     }
3219 /**
3220  * Require key login. Function terminates with error if key not found or incorrect.
3221  *
3222  * @global object
3223  * @global object
3224  * @global object
3225  * @global object
3226  * @uses NO_MOODLE_COOKIES
3227  * @uses PARAM_ALPHANUM
3228  * @param string $script unique script identifier
3229  * @param int $instance optional instance id
3230  * @return int Instance ID
3231  */
3232 function require_user_key_login($script, $instance=null) {
3233     global $USER, $SESSION, $CFG, $DB;
3235     if (!NO_MOODLE_COOKIES) {
3236         print_error('sessioncookiesdisable');
3237     }
3239 /// extra safety
3240     @session_write_close();
3242     $keyvalue = required_param('key', PARAM_ALPHANUM);
3244     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3245         print_error('invalidkey');
3246     }
3248     if (!empty($key->validuntil) and $key->validuntil < time()) {
3249         print_error('expiredkey');
3250     }
3252     if ($key->iprestriction) {
3253         $remoteaddr = getremoteaddr(null);
3254         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3255             print_error('ipmismatch');
3256         }
3257     }
3259     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3260         print_error('invaliduserid');
3261     }
3263 /// emulate normal session
3264     enrol_check_plugins($user);
3265     session_set_user($user);
3267 /// note we are not using normal login
3268     if (!defined('USER_KEY_LOGIN')) {
3269         define('USER_KEY_LOGIN', true);
3270     }
3272 /// return instance id - it might be empty
3273     return $key->instance;
3276 /**
3277  * Creates a new private user access key.
3278  *
3279  * @global object
3280  * @param string $script unique target identifier
3281  * @param int $userid
3282  * @param int $instance optional instance id
3283  * @param string $iprestriction optional ip restricted access
3284  * @param timestamp $validuntil key valid only until given data
3285  * @return string access key value
3286  */
3287 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3288     global $DB;
3290     $key = new stdClass();
3291     $key->script        = $script;
3292     $key->userid        = $userid;
3293     $key->instance      = $instance;
3294     $key->iprestriction = $iprestriction;
3295     $key->validuntil    = $validuntil;
3296     $key->timecreated   = time();
3298     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3299     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3300         // must be unique
3301         $key->value     = md5($userid.'_'.time().random_string(40));
3302     }
3303     $DB->insert_record('user_private_key', $key);
3304     return $key->value;
3307 /**
3308  * Delete the user's new private user access keys for a particular script.
3309  *
3310  * @global object
3311  * @param string $script unique target identifier
3312  * @param int $userid
3313  * @return void
3314  */
3315 function delete_user_key($script,$userid) {
3316     global $DB;
3317     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3320 /**
3321  * Gets a private user access key (and creates one if one doesn't exist).
3322  *
3323  * @global object
3324  * @param string $script unique target identifier
3325  * @param int $userid
3326  * @param int $instance optional instance id
3327  * @param string $iprestriction optional ip restricted access
3328  * @param timestamp $validuntil key valid only until given data
3329  * @return string access key value
3330  */
3331 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3332     global $DB;
3334     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3335                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3336                                                          'validuntil'=>$validuntil))) {
3337         return $key->value;
3338     } else {
3339         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3340     }
3344 /**
3345  * Modify the user table by setting the currently logged in user's
3346  * last login to now.
3347  *
3348  * @global object
3349  * @global object
3350  * @return bool Always returns true
3351  */
3352 function update_user_login_times() {
3353     global $USER, $DB;
3355     if (isguestuser()) {
3356         // Do not update guest access times/ips for performance.
3357         return true;
3358     }
3360     $now = time();
3362     $user = new stdClass();
3363     $user->id = $USER->id;
3365     // Make sure all users that logged in have some firstaccess.
3366     if ($USER->firstaccess == 0) {
3367         $USER->firstaccess = $user->firstaccess = $now;
3368     }
3370     // Store the previous current as lastlogin.
3371     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3373     $USER->currentlogin = $user->currentlogin = $now;
3375     // Function user_accesstime_log() may not update immediately, better do it here.
3376     $USER->lastaccess = $user->lastaccess = $now;
3377     $USER->lastip = $user->lastip = getremoteaddr();
3379     $DB->update_record('user', $user);
3380     return true;
3383 /**
3384  * Determines if a user has completed setting up their account.
3385  *
3386  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3387  * @return bool
3388  */
3389 function user_not_fully_set_up($user) {
3390     if (isguestuser($user)) {
3391         return false;
3392     }
3393     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3396 /**
3397  * Check whether the user has exceeded the bounce threshold
3398  *
3399  * @global object
3400  * @global object
3401  * @param user $user A {@link $USER} object
3402  * @return bool true=>User has exceeded bounce threshold
3403  */
3404 function over_bounce_threshold($user) {
3405     global $CFG, $DB;
3407     if (empty($CFG->handlebounces)) {
3408         return false;
3409     }
3411     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3412         return false;
3413     }
3415     // set sensible defaults
3416     if (empty($CFG->minbounces)) {
3417         $CFG->minbounces = 10;
3418     }
3419     if (empty($CFG->bounceratio)) {
3420         $CFG->bounceratio = .20;
3421     }
3422     $bouncecount = 0;
3423     $sendcount = 0;
3424     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3425         $bouncecount = $bounce->value;
3426     }
3427     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3428         $sendcount = $send->value;
3429     }
3430     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3433 /**
3434  * Used to increment or reset email sent count
3435  *
3436  * @global object
3437  * @param user $user object containing an id
3438  * @param bool $reset will reset the count to 0
3439  * @return void
3440  */
3441 function set_send_count($user,$reset=false) {
3442     global $DB;
3444     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3445         return;
3446     }
3448     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3449         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3450         $DB->update_record('user_preferences', $pref);
3451     }
3452     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3453         // make a new one
3454         $pref = new stdClass();
3455         $pref->name   = 'email_send_count';
3456         $pref->value  = 1;
3457         $pref->userid = $user->id;
3458         $DB->insert_record('user_preferences', $pref, false);
3459     }
3462 /**
3463  * Increment or reset user's email bounce count
3464  *
3465  * @global object
3466  * @param user $user object containing an id
3467  * @param bool $reset will reset the count to 0
3468  */
3469 function set_bounce_count($user,$reset=false) {
3470     global $DB;
3472     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3473         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3474         $DB->update_record('user_preferences', $pref);
3475     }
3476     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3477         // make a new one
3478         $pref = new stdClass();
3479         $pref->name   = 'email_bounce_count';
3480         $pref->value  = 1;
3481         $pref->userid = $user->id;
3482         $DB->insert_record('user_preferences', $pref, false);
3483     }
3486 /**
3487  * Determines if the currently logged in user is in editing mode.
3488  * Note: originally this function had $userid parameter - it was not usable anyway
3489  *
3490  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3491  * @todo Deprecated function remove when ready
3492  *
3493  * @global object
3494  * @uses DEBUG_DEVELOPER
3495  * @return bool
3496  */
3497 function isediting() {
3498     global $PAGE;
3499     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3500     return $PAGE->user_is_editing();
3503 /**
3504  * Determines if the logged in user is currently moving an activity
3505  *
3506  * @global object
3507  * @param int $courseid The id of the course being tested
3508  * @return bool
3509  */
3510 function ismoving($courseid) {
3511     global $USER;
3513     if (!empty($USER->activitycopy)) {
3514         return ($USER->activitycopycourse == $courseid);
3515     }
3516     return false;
3519 /**
3520  * Returns a persons full name
3521  *
3522  * Given an object containing firstname and lastname
3523  * values, this function returns a string with the
3524  * full name of the person.
3525  * The result may depend on system settings
3526  * or language.  'override' will force both names
3527  * to be used even if system settings specify one.
3528  *
3529  * @global object
3530  * @global object
3531  * @param object $user A {@link $USER} object to get full name of
3532  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3533  * @return string
3534  */
3535 function fullname($user, $override=false) {
3536     global $CFG, $SESSION;
3538     if (!isset($user->firstname) and !isset($user->lastname)) {
3539         return '';
3540     }
3542     if (!$override) {
3543         if (!empty($CFG->forcefirstname)) {
3544             $user->firstname = $CFG->forcefirstname;
3545         }
3546         if (!empty($CFG->forcelastname)) {
3547             $user->lastname = $CFG->forcelastname;
3548         }
3549     }
3551     if (!empty($SESSION->fullnamedisplay)) {
3552         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3553     }
3555     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3556         return $user->firstname .' '. $user->lastname;
3558     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3559         return $user->lastname .' '. $user->firstname;
3561     } else if ($CFG->fullnamedisplay == 'firstname') {
3562         if ($override) {
3563             return get_string('fullnamedisplay', '', $user);
3564         } else {
3565             return $user->firstname;
3566         }
3567     }
3569     return get_string('fullnamedisplay', '', $user);
3572 /**
3573  * Checks if current user is shown any extra fields when listing users.
3574  * @param object $context Context
3575  * @param array $already Array of fields that we're going to show anyway
3576  *   so don't bother listing them
3577  * @return array Array of field names from user table, not including anything
3578  *   listed in $already
3579  */
3580 function get_extra_user_fields($context, $already = array()) {
3581     global $CFG;
3583     // Only users with permission get the extra fields
3584     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3585         return array();
3586     }
3588     // Split showuseridentity on comma
3589     if (empty($CFG->showuseridentity)) {
3590         // Explode gives wrong result with empty string
3591         $extra = array();
3592     } else {
3593         $extra =  explode(',', $CFG->showuseridentity);
3594     }
3595     $renumber = false;
3596     foreach ($extra as $key => $field) {
3597         if (in_array($field, $already)) {
3598             unset($extra[$key]);
3599             $renumber = true;
3600         }
3601     }
3602     if ($renumber) {
3603         // For consistency, if entries are removed from array, renumber it
3604         // so they are numbered as you would expect
3605         $extra = array_merge($extra);
3606     }
3607     return $extra;
3610 /**
3611  * If the current user is to be shown extra user fields when listing or
3612  * selecting users, returns a string suitable for including in an SQL select
3613  * clause to retrieve those fields.
3614  * @param object $context Context
3615  * @param string $alias Alias of user table, e.g. 'u' (default none)
3616  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3617  * @param array $already Array of fields that we're going to include anyway
3618  *   so don't list them (default none)
3619  * @return string Partial SQL select clause, beginning with comma, for example
3620  *   ',u.idnumber,u.department' unless it is blank
3621  */
3622 function get_extra_user_fields_sql($context, $alias='', $prefix='',
3623         $already = array()) {
3624     $fields = get_extra_user_fields($context, $already);
3625     $result = '';
3626     // Add punctuation for alias
3627     if ($alias !== '') {
3628         $alias .= '.';
3629     }
3630     foreach ($fields as $field) {
3631         $result .= ', ' . $alias . $field;
3632         if ($prefix) {
3633             $result .= ' AS ' . $prefix . $field;
3634         }
3635     }
3636     return $result;
3639 /**
3640  * Returns the display name of a field in the user table. Works for most fields
3641  * that are commonly displayed to users.
3642  * @param string $field Field name, e.g. 'phone1'
3643  * @return string Text description taken from language file, e.g. 'Phone number'
3644  */
3645 function get_user_field_name($field) {
3646     // Some fields have language strings which are not the same as field name
3647     switch ($field) {
3648         case 'phone1' : return get_string('phone');
3649         case 'url' : return get_string('webpage');
3650         case 'icq' : return get_string('icqnumber');
3651         case 'skype' : return get_string('skypeid');
3652         case 'aim' : return get_string('aimid');
3653         case 'yahoo' : return get_string('yahooid');
3654         case 'msn' : return get_string('msnid');
3655     }
3656     // Otherwise just use the same lang string
3657     return get_string($field);
3660 /**
3661  * Returns whether a given authentication plugin exists.
3662  *
3663  * @global object
3664  * @param string $auth Form of authentication to check for. Defaults to the
3665  *        global setting in {@link $CFG}.
3666  * @return boolean Whether the plugin is available.
3667  */
3668 function exists_auth_plugin($auth) {
3669     global $CFG;
3671     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3672         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3673     }
3674     return false;
3677 /**
3678  * Checks if a given plugin is in the list of enabled authentication plugins.
3679  *
3680  * @param string $auth Authentication plugin.
3681  * @return boolean Whether the plugin is enabled.
3682  */
3683 function is_enabled_auth($auth) {
3684     if (empty($auth)) {
3685         return false;
3686     }
3688     $enabled = get_enabled_auth_plugins();
3690     return in_array($auth, $enabled);
3693 /**
3694  * Returns an authentication plugin instance.
3695  *
3696  * @global object
3697  * @param string $auth name of authentication plugin
3698  * @return auth_plugin_base An instance of the required authentication plugin.
3699  */
3700 function get_auth_plugin($auth) {
3701     global $CFG;
3703     // check the plugin exists first
3704     if (! exists_auth_plugin($auth)) {
3705         print_error('authpluginnotfound', 'debug', '', $auth);
3706     }
3708     // return auth plugin instance
3709     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3710     $class = "auth_plugin_$auth";
3711     return new $class;
3714 /**
3715  * Returns array of active auth plugins.
3716  *
3717  * @param bool $fix fix $CFG->auth if needed
3718  * @return array
3719  */
3720 function get_enabled_auth_plugins($fix=false) {
3721     global $CFG;
3723     $default = array('manual', 'nologin');
3725     if (empty($CFG->auth)) {
3726         $auths = array();
3727     } else {
3728         $auths = explode(',', $CFG->auth);
3729     }
3731     if ($fix) {
3732         $auths = array_unique($auths);
3733         foreach($auths as $k=>$authname) {
3734             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3735                 unset($auths[$k]);
3736             }
3737         }
3738         $newconfig = implode(',', $auths);
3739         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3740             set_config('auth', $newconfig);
3741         }
3742     }
3744     return (array_merge($default, $auths));
3747 /**
3748  * Returns true if an internal authentication method is being used.
3749  * if method not specified then, global default is assumed
3750  *
3751  * @param string $auth Form of authentication required
3752  * @return bool
3753  */
3754 function is_internal_auth($auth) {
3755     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3756     return $authplugin->is_internal();
3759 /**
3760  * Returns true if the user is a 'restored' one
3761  *
3762  * Used in the login process to inform the user
3763  * and allow him/her to reset the password
3764  *
3765  * @uses $CFG
3766  * @uses $DB
3767  * @param string $username username to be checked
3768  * @return bool
3769  */
3770 function is_restored_user($username) {
3771     global $CFG, $DB;
3773     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3776 /**
3777  * Returns an array of user fields
3778  *
3779  * @return array User field/column names
3780  */
3781 function get_user_fieldnames() {
3782     global $DB;
3784     $fieldarray = $DB->get_columns('user');
3785     unset($fieldarray['id']);
3786     $fieldarray = array_keys($fieldarray);
3788     return $fieldarray;
3791 /**
3792  * Creates a bare-bones user record
3793  *
3794  * @todo Outline auth types and provide code example
3795  *
3796  * @param string $username New user's username to add to record
3797  * @param string $password New user's password to add to record
3798  * @param string $auth Form of authentication required
3799  * @return stdClass A complete user object
3800  */
3801 function create_user_record($username, $password, $auth = 'manual') {
3802     global $CFG, $DB;
3804     //just in case check text case
3805     $username = trim(textlib::strtolower($username));
3807     $authplugin = get_auth_plugin($auth);
3809     $newuser = new stdClass();
3811     if ($newinfo = $authplugin->get_userinfo($username)) {
3812         $newinfo = truncate_userinfo($newinfo);
3813         foreach ($newinfo as $key => $value){
3814             $newuser->$key = $value;
3815         }
3816     }
3818     if (!empty($newuser->email)) {
3819         if (email_is_not_allowed($newuser->email)) {
3820             unset($newuser->email);
3821         }
3822     }
3824     if (!isset($newuser->city)) {
3825         $newuser->city = '';
3826     }
3828     $newuser->auth = $auth;
3829     $newuser->username = $username;
3831     // fix for MDL-8480
3832     // user CFG lang for user if $newuser->lang is empty
3833     // or $user->lang is not an installed language
3834     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3835         $newuser->lang = $CFG->lang;
3836     }
3837     $newuser->confirmed = 1;
3838     $newuser->lastip = getremoteaddr();
3839     $newuser->timecreated = time();
3840     $newuser->timemodified = $newuser->timecreated;
3841     $newuser->mnethostid = $CFG->mnet_localhost_id;
3843     $newuser->id = $DB->insert_record('user', $newuser);
3844     $user = get_complete_user_data('id', $newuser->id);
3845     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3846         set_user_preference('auth_forcepasswordchange', 1, $user);
3847     }
3848     update_internal_user_password($user, $password);
3850     // fetch full user record for the event, the complete user data contains too much info
3851     // and we want to be consistent with other places that trigger this event
3852     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3854     return $user;
3857 /**
3858  * Will update a local user record from an external source.
3859  * (MNET users can not be updated using this method!)
3860  *
3861  * @param string $username user's username to update the record
3862  * @return stdClass A complete user object
3863  */
3864 function update_user_record($username) {
3865     global $DB, $CFG;
3867     $username = trim(textlib::strtolower($username)); /// just in case check text case
3869     $oldinfo = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
3870     $newuser = array();
3871     $userauth = get_auth_plugin($oldinfo->auth);
3873     if ($newinfo = $userauth->get_userinfo($username)) {
3874         $newinfo = truncate_userinfo($newinfo);
3875         foreach ($newinfo as $key => $value){
3876             $key = strtolower($key);
3877             if (!property_exists($oldinfo, $key) or $key === 'username' or $key === 'id'
3878                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3879                 // unknown or must not be changed
3880                 continue;
3881             }
3882             $confval = $userauth->config->{'field_updatelocal_' . $key};
3883             $lockval = $userauth->config->{'field_lock_' . $key};
3884             if (empty($confval) || empty($lockval)) {
3885                 continue;
3886             }
3887             if ($confval === 'onlogin') {
3888                 // MDL-4207 Don't overwrite modified user profile values with
3889                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3890                 // of the setting 'unlocked if empty' is to allow the user to fill
3891                 // in a value for the selected field _if LDAP is giving
3892                 // nothing_ for this field. Thus it makes sense to let this value
3893                 // stand in until LDAP is giving a value for this field.
3894                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3895                     if ((string)$oldinfo->$key !== (string)$value) {
3896                         $newuser[$key] = (string)$value;
3897                     }
3898                 }
3899             }
3900         }
3901         if ($newuser) {
3902             $newuser['id'] = $oldinfo->id;
3903             $newuser['timemodified'] = time();
3904             $DB->update_record('user', $newuser);
3905             // fetch full user record for the event, the complete user data contains too much info
3906             // and we want to be consistent with other places that trigger this event
3907             events_trigger('user_updated', $DB->get_record('user', array('id'=>$oldinfo->id)));
3908         }
3909     }
3911     return get_complete_user_data('id', $oldinfo->id);
3914 /**
3915  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3916  * which may have large fields
3917  *
3918  * @todo Add vartype handling to ensure $info is an array
3919  *
3920  * @param array $info Array of user properties to truncate if needed
3921  * @return array The now truncated information that was passed in
3922  */
3923 function truncate_userinfo($info) {
3924     // define the limits
3925     $limit = array(
3926                     'username'    => 100,
3927                     'idnumber'    => 255,
3928                     'firstname'   => 100,
3929                     'lastname'    => 100,
3930                     'email'       => 100,
3931                     'icq'         =>  15,
3932                     'phone1'      =>  20,
3933                     'phone2'      =>  20,
3934                     'institution' =>  40,
3935                     'department'  =>  30,
3936                     'address'     =>  70,
3937                     'city'        => 120,
3938                     'country'     =>   2,
3939                     'url'         => 255,
3940                     );
3942     // apply where needed
3943     foreach (array_keys($info) as $key) {
3944         if (!empty($limit[$key])) {
3945             $info[$key] = trim(textlib::substr($info[$key],0, $limit[$key]));
3946         }
3947     }
3949     return $info;
3952 /**
3953  * Marks user deleted in internal user database and notifies the auth plugin.
3954  * Also unenrols user from all roles and does other cleanup.
3955  *
3956  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3957  *
3958  * @param stdClass $user full user object before delete
3959  * @return boolean success
3960  * @throws coding_exception if invalid $user parameter detected
3961  */
3962 function delete_user(stdClass $user) {
3963     global $CFG, $DB;
3964     require_once($CFG->libdir.'/grouplib.php');
3965     require_once($CFG->libdir.'/gradelib.php');
3966     require_once($CFG->dirroot.'/message/lib.php');
3967     require_once($CFG->dirroot.'/tag/lib.php');
3969     // Make sure nobody sends bogus record type as parameter.
3970     if (!property_exists($user, 'id') or !property_exists($user, 'username')) {
3971         throw new coding_exception('Invalid $user parameter in delete_user() detected');
3972     }
3974     // Better not trust the parameter and fetch the latest info,
3975     // this will be very expensive anyway.
3976     if (!$user = $DB->get_record('user', array('id'=>$user->id))) {
3977         debugging('Attempt to delete unknown user account.');
3978         return false;
3979     }
3981     // There must be always exactly one guest record,
3982     // originally the guest account was identified by username only,
3983     // now we use $CFG->siteguest for performance reasons.
3984     if ($user->username === 'guest' or isguestuser($user)) {
3985         debugging('Guest user account can not be deleted.');
3986         return false;
3987     }
3989     // Admin can be theoretically from different auth plugin,
3990     // but we want to prevent deletion of internal accoutns only,
3991     // if anything goes wrong ppl may force somebody to be admin via
3992     // config.php setting $CFG->siteadmins.
3993     if ($user->auth === 'manual' and is_siteadmin($user)) {
3994         debugging('Local administrator accounts can not be deleted.');
3995         return false;
3996     }
3998     // delete all grades - backup is kept in grade_grades_history table
3999     grade_user_delete($user->id);
4001     //move unread messages from this user to read
4002     message_move_userfrom_unread2read($user->id);
4004     // TODO: remove from cohorts using standard API here
4006     // remove user tags
4007     tag_set('user', $user->id, array());
4009     // unconditionally unenrol from all courses
4010     enrol_user_delete($user);
4012     // unenrol from all roles in all contexts
4013     role_unassign_all(array('userid'=>$user->id)); // this might be slow but it is really needed - modules might do some extra cleanup!
4015     //now do a brute force cleanup
4017     // remove from all cohorts
4018     $DB->delete_records('cohort_members', array('userid'=>$user->id));
4020     // remove from all groups
4021     $DB->delete_records('groups_members', array('userid'=>$user->id));
4023     // brute force unenrol from all courses
4024     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
4026     // purge user preferences
4027     $DB->delete_records('user_preferences', array('userid'=>$user->id));
4029     // purge user extra profile info
4030     $DB->delete_records('user_info_data', array('userid'=>$user->id));
4032     // last course access not necessary either
4033     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
4035     // remove all user tokens
4036     $DB->delete_records('external_tokens', array('userid'=>$user->id));
4038     // unauthorise the user for all services
4039     $DB->delete_records('external_services_users', array('userid'=>$user->id));
4041     // force logout - may fail if file based sessions used, sorry
4042     session_kill_user($user->id);
4044     // now do a final accesslib cleanup - removes all role assignments in user context and context itself
4045     delete_context(CONTEXT_USER, $user->id);
4047     // workaround for bulk deletes of users with the same email address
4048     $delname = "$user->email.".time();
4049     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
4050         $delname++;
4051     }
4053     // mark internal user record as "deleted"
4054     $updateuser = new stdClass();
4055     $updateuser->id           = $user->id;
4056     $updateuser->deleted      = 1;
4057     $updateuser->username     = $delname;            // Remember it just in case
4058     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
4059     $updateuser->idnumber     = '';                  // Clear this field to free it up
4060     $updateuser->picture      = 0;
4061     $updateuser->timemodified = time();
4063     $DB->update_record('user', $updateuser);
4064     // Add this action to log
4065     add_to_log(SITEID, 'user', 'delete', "view.php?id=$user->id", $user->firstname.' '.$user->lastname);
4068     // We will update the user's timemodified, as it will be passed to the user_deleted event, which
4069     // should know about this updated property persisted to the user's table.
4070     $user->timemodified = $updateuser->timemodified;
4072     // notify auth plugin - do not block the delete even when plugin fails
4073     $authplugin = get_auth_plugin($user->auth);
4074     $authplugin->user_delete($user);
4076     // any plugin that needs to cleanup should register this event
4077     events_trigger('user_deleted', $user);
4079     return true;
4082 /**
4083  * Retrieve the guest user object
4084  *
4085  * @global object
4086  * @global object
4087  * @return user A {@link $USER} object
4088  */
4089 function guest_user() {
4090     global $CFG, $DB;
4092     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
4093         $newuser->confirmed = 1;
4094         $newuser->lang = $CFG->lang;
4095         $newuser->lastip = getremoteaddr();
4096     }
4098     return $newuser;
4101 /**
4102  * Authenticates a user against the chosen authentication mechanism
4103  *
4104  * Given a username and password, this function looks them
4105  * up using the currently selected authentication mechanism,
4106  * and if the authentication is successful, it returns a
4107  * valid $user object from the 'user' table.
4108  *
4109  * Uses auth_ functions from the currently active auth module
4110  *
4111  * After authenticate_user_login() returns success, you will need to
4112  * log that the user has logged in, and call complete_user_login() to set
4113  * the session up.
4114  *
4115  * Note: this function works only with non-mnet accounts!
4116  *
4117  * @param string $username  User's username
4118  * @param string $password  User's password
4119  * @param bool $ignorelockout useful when guessing is prevented by other mechanism such as captcha or SSO
4120  * @param int $failurereason login failure reason, can be used in renderers (it may disclose if account exists)
4121  * @return stdClass|false A {@link $USER} object or false if error
4122  */
4123 function authenticate_user_login($username, $password, $ignorelockout=false, &$failurereason=null) {
4124     global $CFG, $DB;
4125     require_once("$CFG->libdir/authlib.php");
4127     $authsenabled = get_enabled_auth_plugins();
4129     if ($user = get_complete_user_data('username', $username, $CFG->mnet_localhost_id)) {
4130         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
4131         if (!empty($user->suspended)) {
4132             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4133             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4134             $failurereason = AUTH_LOGIN_SUSPENDED;
4135             return false;
4136         }
4137         if ($auth=='nologin' or !is_enabled_auth($auth)) {
4138             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4139             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4140             $failurereason = AUTH_LOGIN_SUSPENDED; // Legacy way to suspend user.
4141             return false;
4142         }
4143         $auths = array($auth);
4145     } else {
4146         // Check if there's a deleted record (cheaply), this should not happen because we mangle usernames in delete_user().
4147         if ($DB->get_field('user', 'id', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id,  'deleted'=>1))) {
4148             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4149             $failurereason = AUTH_LOGIN_NOUSER;
4150             return false;
4151         }
4153         // Do not try to authenticate non-existent accounts when user creation is not disabled.
4154         if (!empty($CFG->authpreventaccountcreation)) {
4155             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4156             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Unknown user, can not create new accounts:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4157             $failurereason = AUTH_LOGIN_NOUSER;
4158             return false;
4159         }
4161         // User does not exist
4162         $auths = $authsenabled;
4163         $user = new stdClass();
4164         $user->id = 0;
4165     }
4167     if ($ignorelockout) {
4168         // Some other mechanism protects against brute force password guessing,
4169         // for example login form might include reCAPTCHA or this function
4170         // is called from a SSO script.
4172     } else if ($user->id) {
4173         // Verify login lockout after other ways that may prevent user login.
4174         if (login_is_lockedout($user)) {
4175             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4176             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Login lockout:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4177             $failurereason = AUTH_LOGIN_LOCKOUT;
4178             return false;
4179         }
4181     } else {
4182         // We can not lockout non-existing accounts.
4183     }
4185     foreach ($auths as $auth) {
4186         $authplugin = get_auth_plugin($auth);
4188         // on auth fail fall through to the next plugin
4189         if (!$authplugin->user_login($username, $password)) {
4190             continue;
4191         }
4193         // successful authentication
4194         if ($user->id) {                          // User already exists in database
4195             if (empty($user->auth)) {             // For some reason auth isn't set yet
4196                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
4197                 $user->auth = $auth;
4198             }
4200             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
4202             if ($authplugin->is_synchronised_with_external()) { // update user record from external DB
4203                 $user = update_user_record($username);
4204             }
4205         } else {
4206             // Create account, we verified above that user creation is allowed.
4207             $user = create_user_record($username, $password, $auth);
4208         }
4210         $authplugin->sync_roles($user);
4212         foreach ($authsenabled as $hau) {
4213             $hauth = get_auth_plugin($hau);
4214             $hauth->user_authenticated_hook($user, $username, $password);
4215         }
4217         if (empty($user->id)) {
4218             $failurereason = AUTH_LOGIN_NOUSER;
4219             return false;
4220         }
4222         if (!empty($user->suspended)) {
4223             // just in case some auth plugin suspended account
4224             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4225             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4226             $failurereason = AUTH_LOGIN_SUSPENDED;
4227             return false;
4228         }
4230         login_attempt_valid($user);
4231         $failurereason = AUTH_LOGIN_OK;
4232         return $user;
4233     }
4235     // failed if all the plugins have failed
4236     add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4237     if (debugging('', DEBUG_ALL)) {
4238         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4239     }
4241     if ($user->id) {
4242         login_attempt_failed($user);
4243         $failurereason = AUTH_LOGIN_FAILED;
4244     } else {
4245         $failurereason = AUTH_LOGIN_NOUSER;
4246     }
4248     return false;
4251 /**
4252  * Call to complete the user login process after authenticate_user_login()
4253  * has succeeded. It will setup the $USER variable and other required bits
4254  * and pieces.
4255  *
4256  * NOTE:
4257  * - It will NOT log anything -- up to the caller to decide what to log.
4258  * - this function does not set any cookies any more!
4259  *
4260  * @param object $user
4261  * @return object A {@link $USER} object - BC only, do not use
4262  */
4263 function complete_user_login($user) {
4264     global $CFG, $USER;
4266     // regenerate session id and delete old session,
4267     // this helps prevent session fixation attacks from the same domain
4268     session_regenerate_id(true);
4270     // let enrol plugins deal with new enrolments if necessary
4271     enrol_check_plugins($user);
4273     // check enrolments, load caps and setup $USER object
4274     session_set_user($user);
4276     // reload preferences from DB
4277     unset($USER->preference);
4278     check_user_preferences_loaded($USER);
4280     // update login times
4281     update_user_login_times();
4283     // extra session prefs init
4284     set_login_session_preferences();
4286     if (isguestuser()) {
4287         // no need to continue when user is THE guest
4288         return $USER;
4289     }
4291     /// Select password change url
4292     $userauth = get_auth_plugin($USER->auth);
4294     /// check whether the user should be changing password
4295     if (get_user_preferences('auth_forcepasswordchange', false)){
4296         if ($userauth->can_change_password()) {
4297             if ($changeurl = $userauth->change_password_url()) {
4298                 redirect($changeurl);
4299             } else {
4300                 redirect($CFG->httpswwwroot.'/login/change_password.php');
4301             }
4302         } else {
4303             print_error('nopasswordchangeforced', 'auth');
4304         }
4305     }
4306     return $USER;
4309 /**
4310  * Compare password against hash stored in internal user table.
4311  * If necessary it also updates the stored hash to new format.
4312  *
4313  * @param stdClass $user (password property may be updated)
4314  * @param string $password plain text password
4315  * @return bool is password valid?
4316  */
4317 function validate_internal_user_password($user, $password) {
4318     global $CFG;
4320     if (!isset($CFG->passwordsaltmain)) {
4321         $CFG->passwordsaltmain = '';
4322     }
4324     $validated = false;
4326     if ($user->password === 'not cached') {
4327         // internal password is not used at all, it can not validate
4329     } else if ($user->password === md5($password.$CFG->passwordsaltmain)
4330             or $user->password === md5($password)
4331             or $user->password === md5(addslashes($password).$CFG->passwordsaltmain)
4332             or $user->password === md5(addslashes($password))) {
4333         // note: we are intentionally using the addslashes() here because we
4334         //       need to accept old password hashes of passwords with magic quotes
4335         $validated = true;
4337     } else {
4338         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?