Merge branch 'MDL-29662' of git://github.com/timhunt/moodle
[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             $param = preg_replace('~\.\.+~', '', $param);
924             if ($param === '.') {
925                 $param = '';
926             }
927             return $param;
929         case PARAM_PATH:         // Strip all suspicious characters from file path
930             $param = fix_utf8($param);
931             $param = str_replace('\\', '/', $param);
932             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
933             $param = preg_replace('~\.\.+~', '', $param);
934             $param = preg_replace('~//+~', '/', $param);
935             return preg_replace('~/(\./)+~', '/', $param);
937         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
938             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
939             // match ipv4 dotted quad
940             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
941                 // confirm values are ok
942                 if ( $match[0] > 255
943                      || $match[1] > 255
944                      || $match[3] > 255
945                      || $match[4] > 255 ) {
946                     // hmmm, what kind of dotted quad is this?
947                     $param = '';
948                 }
949             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
950                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
951                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
952                        ) {
953                 // all is ok - $param is respected
954             } else {
955                 // all is not ok...
956                 $param='';
957             }
958             return $param;
960         case PARAM_URL:          // allow safe ftp, http, mailto urls
961             $param = fix_utf8($param);
962             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
963             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
964                 // all is ok, param is respected
965             } else {
966                 $param =''; // not really ok
967             }
968             return $param;
970         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
971             $param = clean_param($param, PARAM_URL);
972             if (!empty($param)) {
973                 if (preg_match(':^/:', $param)) {
974                     // root-relative, ok!
975                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
976                     // absolute, and matches our wwwroot
977                 } else {
978                     // relative - let's make sure there are no tricks
979                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
980                         // looks ok.
981                     } else {
982                         $param = '';
983                     }
984                 }
985             }
986             return $param;
988         case PARAM_PEM:
989             $param = trim($param);
990             // PEM formatted strings may contain letters/numbers and the symbols
991             // forward slash: /
992             // plus sign:     +
993             // equal sign:    =
994             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
995             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
996                 list($wholething, $body) = $matches;
997                 unset($wholething, $matches);
998                 $b64 = clean_param($body, PARAM_BASE64);
999                 if (!empty($b64)) {
1000                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1001                 } else {
1002                     return '';
1003                 }
1004             }
1005             return '';
1007         case PARAM_BASE64:
1008             if (!empty($param)) {
1009                 // PEM formatted strings may contain letters/numbers and the symbols
1010                 // forward slash: /
1011                 // plus sign:     +
1012                 // equal sign:    =
1013                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1014                     return '';
1015                 }
1016                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1017                 // Each line of base64 encoded data must be 64 characters in
1018                 // length, except for the last line which may be less than (or
1019                 // equal to) 64 characters long.
1020                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1021                     if ($i + 1 == $j) {
1022                         if (64 < strlen($lines[$i])) {
1023                             return '';
1024                         }
1025                         continue;
1026                     }
1028                     if (64 != strlen($lines[$i])) {
1029                         return '';
1030                     }
1031                 }
1032                 return implode("\n",$lines);
1033             } else {
1034                 return '';
1035             }
1037         case PARAM_TAG:
1038             $param = fix_utf8($param);
1039             // Please note it is not safe to use the tag name directly anywhere,
1040             // it must be processed with s(), urlencode() before embedding anywhere.
1041             // remove some nasties
1042             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1043             //convert many whitespace chars into one
1044             $param = preg_replace('/\s+/', ' ', $param);
1045             $param = textlib::substr(trim($param), 0, TAG_MAX_LENGTH);
1046             return $param;
1048         case PARAM_TAGLIST:
1049             $param = fix_utf8($param);
1050             $tags = explode(',', $param);
1051             $result = array();
1052             foreach ($tags as $tag) {
1053                 $res = clean_param($tag, PARAM_TAG);
1054                 if ($res !== '') {
1055                     $result[] = $res;
1056                 }
1057             }
1058             if ($result) {
1059                 return implode(',', $result);
1060             } else {
1061                 return '';
1062             }
1064         case PARAM_CAPABILITY:
1065             if (get_capability_info($param)) {
1066                 return $param;
1067             } else {
1068                 return '';
1069             }
1071         case PARAM_PERMISSION:
1072             $param = (int)$param;
1073             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1074                 return $param;
1075             } else {
1076                 return CAP_INHERIT;
1077             }
1079         case PARAM_AUTH:
1080             $param = clean_param($param, PARAM_PLUGIN);
1081             if (empty($param)) {
1082                 return '';
1083             } else if (exists_auth_plugin($param)) {
1084                 return $param;
1085             } else {
1086                 return '';
1087             }
1089         case PARAM_LANG:
1090             $param = clean_param($param, PARAM_SAFEDIR);
1091             if (get_string_manager()->translation_exists($param)) {
1092                 return $param;
1093             } else {
1094                 return ''; // Specified language is not installed or param malformed
1095             }
1097         case PARAM_THEME:
1098             $param = clean_param($param, PARAM_PLUGIN);
1099             if (empty($param)) {
1100                 return '';
1101             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1102                 return $param;
1103             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1104                 return $param;
1105             } else {
1106                 return '';  // Specified theme is not installed
1107             }
1109         case PARAM_USERNAME:
1110             $param = fix_utf8($param);
1111             $param = str_replace(" " , "", $param);
1112             $param = textlib::strtolower($param);  // Convert uppercase to lowercase MDL-16919
1113             if (empty($CFG->extendedusernamechars)) {
1114                 // regular expression, eliminate all chars EXCEPT:
1115                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1116                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1117             }
1118             return $param;
1120         case PARAM_EMAIL:
1121             $param = fix_utf8($param);
1122             if (validate_email($param)) {
1123                 return $param;
1124             } else {
1125                 return '';
1126             }
1128         case PARAM_STRINGID:
1129             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1130                 return $param;
1131             } else {
1132                 return '';
1133             }
1135         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1136             $param = fix_utf8($param);
1137             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3]|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1138             if (preg_match($timezonepattern, $param)) {
1139                 return $param;
1140             } else {
1141                 return '';
1142             }
1144         default:                 // throw error, switched parameters in optional_param or another serious problem
1145             print_error("unknownparamtype", '', '', $type);
1146     }
1149 /**
1150  * Makes sure the data is using valid utf8, invalid characters are discarded.
1151  *
1152  * Note: this function is not intended for full objects with methods and private properties.
1153  *
1154  * @param mixed $value
1155  * @return mixed with proper utf-8 encoding
1156  */
1157 function fix_utf8($value) {
1158     if (is_null($value) or $value === '') {
1159         return $value;
1161     } else if (is_string($value)) {
1162         if ((string)(int)$value === $value) {
1163             // shortcut
1164             return $value;
1165         }
1167         // Lower error reporting because glibc throws bogus notices.
1168         $olderror = error_reporting();
1169         if ($olderror & E_NOTICE) {
1170             error_reporting($olderror ^ E_NOTICE);
1171         }
1173         // Note: this duplicates min_fix_utf8() intentionally.
1174         static $buggyiconv = null;
1175         if ($buggyiconv === null) {
1176             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1177         }
1179         if ($buggyiconv) {
1180             if (function_exists('mb_convert_encoding')) {
1181                 $subst = mb_substitute_character();
1182                 mb_substitute_character('');
1183                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1184                 mb_substitute_character($subst);
1186             } else {
1187                 // Warn admins on admin/index.php page.
1188                 $result = $value;
1189             }
1191         } else {
1192             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1193         }
1195         if ($olderror & E_NOTICE) {
1196             error_reporting($olderror);
1197         }
1199         return $result;
1201     } else if (is_array($value)) {
1202         foreach ($value as $k=>$v) {
1203             $value[$k] = fix_utf8($v);
1204         }
1205         return $value;
1207     } else if (is_object($value)) {
1208         $value = clone($value); // do not modify original
1209         foreach ($value as $k=>$v) {
1210             $value->$k = fix_utf8($v);
1211         }
1212         return $value;
1214     } else {
1215         // this is some other type, no utf-8 here
1216         return $value;
1217     }
1220 /**
1221  * Return true if given value is integer or string with integer value
1222  *
1223  * @param mixed $value String or Int
1224  * @return bool true if number, false if not
1225  */
1226 function is_number($value) {
1227     if (is_int($value)) {
1228         return true;
1229     } else if (is_string($value)) {
1230         return ((string)(int)$value) === $value;
1231     } else {
1232         return false;
1233     }
1236 /**
1237  * Returns host part from url
1238  * @param string $url full url
1239  * @return string host, null if not found
1240  */
1241 function get_host_from_url($url) {
1242     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1243     if ($matches) {
1244         return $matches[1];
1245     }
1246     return null;
1249 /**
1250  * Tests whether anything was returned by text editor
1251  *
1252  * This function is useful for testing whether something you got back from
1253  * the HTML editor actually contains anything. Sometimes the HTML editor
1254  * appear to be empty, but actually you get back a <br> tag or something.
1255  *
1256  * @param string $string a string containing HTML.
1257  * @return boolean does the string contain any actual content - that is text,
1258  * images, objects, etc.
1259  */
1260 function html_is_blank($string) {
1261     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1264 /**
1265  * Set a key in global configuration
1266  *
1267  * Set a key/value pair in both this session's {@link $CFG} global variable
1268  * and in the 'config' database table for future sessions.
1269  *
1270  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1271  * In that case it doesn't affect $CFG.
1272  *
1273  * A NULL value will delete the entry.
1274  *
1275  * @global object
1276  * @global object
1277  * @param string $name the key to set
1278  * @param string $value the value to set (without magic quotes)
1279  * @param string $plugin (optional) the plugin scope, default NULL
1280  * @return bool true or exception
1281  */
1282 function set_config($name, $value, $plugin=NULL) {
1283     global $CFG, $DB;
1285     if (empty($plugin)) {
1286         if (!array_key_exists($name, $CFG->config_php_settings)) {
1287             // So it's defined for this invocation at least
1288             if (is_null($value)) {
1289                 unset($CFG->$name);
1290             } else {
1291                 $CFG->$name = (string)$value; // settings from db are always strings
1292             }
1293         }
1295         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1296             if ($value === null) {
1297                 $DB->delete_records('config', array('name'=>$name));
1298             } else {
1299                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1300             }
1301         } else {
1302             if ($value !== null) {
1303                 $config = new stdClass();
1304                 $config->name  = $name;
1305                 $config->value = $value;
1306                 $DB->insert_record('config', $config, false);
1307             }
1308         }
1310     } else { // plugin scope
1311         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1312             if ($value===null) {
1313                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1314             } else {
1315                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1316             }
1317         } else {
1318             if ($value !== null) {
1319                 $config = new stdClass();
1320                 $config->plugin = $plugin;
1321                 $config->name   = $name;
1322                 $config->value  = $value;
1323                 $DB->insert_record('config_plugins', $config, false);
1324             }
1325         }
1326     }
1328     return true;
1331 /**
1332  * Get configuration values from the global config table
1333  * or the config_plugins table.
1334  *
1335  * If called with one parameter, it will load all the config
1336  * variables for one plugin, and return them as an object.
1337  *
1338  * If called with 2 parameters it will return a string single
1339  * value or false if the value is not found.
1340  *
1341  * @param string $plugin full component name
1342  * @param string $name default NULL
1343  * @return mixed hash-like object or single value, return false no config found
1344  */
1345 function get_config($plugin, $name = NULL) {
1346     global $CFG, $DB;
1348     // normalise component name
1349     if ($plugin === 'moodle' or $plugin === 'core') {
1350         $plugin = NULL;
1351     }
1353     if (!empty($name)) { // the user is asking for a specific value
1354         if (!empty($plugin)) {
1355             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1356                 // setting forced in config file
1357                 return $CFG->forced_plugin_settings[$plugin][$name];
1358             } else {
1359                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1360             }
1361         } else {
1362             if (array_key_exists($name, $CFG->config_php_settings)) {
1363                 // setting force in config file
1364                 return $CFG->config_php_settings[$name];
1365             } else {
1366                 return $DB->get_field('config', 'value', array('name'=>$name));
1367             }
1368         }
1369     }
1371     // the user is after a recordset
1372     if ($plugin) {
1373         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1374         if (isset($CFG->forced_plugin_settings[$plugin])) {
1375             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1376                 if (is_null($v) or is_array($v) or is_object($v)) {
1377                     // we do not want any extra mess here, just real settings that could be saved in db
1378                     unset($localcfg[$n]);
1379                 } else {
1380                     //convert to string as if it went through the DB
1381                     $localcfg[$n] = (string)$v;
1382                 }
1383             }
1384         }
1385         if ($localcfg) {
1386             return (object)$localcfg;
1387         } else {
1388             return new stdClass();
1389         }
1391     } else {
1392         // this part is not really used any more, but anyway...
1393         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1394         foreach($CFG->config_php_settings as $n=>$v) {
1395             if (is_null($v) or is_array($v) or is_object($v)) {
1396                 // we do not want any extra mess here, just real settings that could be saved in db
1397                 unset($localcfg[$n]);
1398             } else {
1399                 //convert to string as if it went through the DB
1400                 $localcfg[$n] = (string)$v;
1401             }
1402         }
1403         return (object)$localcfg;
1404     }
1407 /**
1408  * Removes a key from global configuration
1409  *
1410  * @param string $name the key to set
1411  * @param string $plugin (optional) the plugin scope
1412  * @global object
1413  * @return boolean whether the operation succeeded.
1414  */
1415 function unset_config($name, $plugin=NULL) {
1416     global $CFG, $DB;
1418     if (empty($plugin)) {
1419         unset($CFG->$name);
1420         $DB->delete_records('config', array('name'=>$name));
1421     } else {
1422         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1423     }
1425     return true;
1428 /**
1429  * Remove all the config variables for a given plugin.
1430  *
1431  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1432  * @return boolean whether the operation succeeded.
1433  */
1434 function unset_all_config_for_plugin($plugin) {
1435     global $DB;
1436     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1437     $like = $DB->sql_like('name', '?', true, true, false, '|');
1438     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1439     $DB->delete_records_select('config', $like, $params);
1440     return true;
1443 /**
1444  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1445  *
1446  * All users are verified if they still have the necessary capability.
1447  *
1448  * @param string $value the value of the config setting.
1449  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1450  * @param bool $include admins, include administrators
1451  * @return array of user objects.
1452  */
1453 function get_users_from_config($value, $capability, $includeadmins = true) {
1454     global $CFG, $DB;
1456     if (empty($value) or $value === '$@NONE@$') {
1457         return array();
1458     }
1460     // we have to make sure that users still have the necessary capability,
1461     // it should be faster to fetch them all first and then test if they are present
1462     // instead of validating them one-by-one
1463     $users = get_users_by_capability(context_system::instance(), $capability);
1464     if ($includeadmins) {
1465         $admins = get_admins();
1466         foreach ($admins as $admin) {
1467             $users[$admin->id] = $admin;
1468         }
1469     }
1471     if ($value === '$@ALL@$') {
1472         return $users;
1473     }
1475     $result = array(); // result in correct order
1476     $allowed = explode(',', $value);
1477     foreach ($allowed as $uid) {
1478         if (isset($users[$uid])) {
1479             $user = $users[$uid];
1480             $result[$user->id] = $user;
1481         }
1482     }
1484     return $result;
1488 /**
1489  * Invalidates browser caches and cached data in temp
1490  * @return void
1491  */
1492 function purge_all_caches() {
1493     global $CFG;
1495     reset_text_filters_cache();
1496     js_reset_all_caches();
1497     theme_reset_all_caches();
1498     get_string_manager()->reset_caches();
1499     textlib::reset_caches();
1501     // purge all other caches: rss, simplepie, etc.
1502     remove_dir($CFG->cachedir.'', true);
1504     // make sure cache dir is writable, throws exception if not
1505     make_cache_directory('');
1507     // hack: this script may get called after the purifier was initialised,
1508     // but we do not want to verify repeatedly this exists in each call
1509     make_cache_directory('htmlpurifier');
1512 /**
1513  * Get volatile flags
1514  *
1515  * @param string $type
1516  * @param int    $changedsince default null
1517  * @return records array
1518  */
1519 function get_cache_flags($type, $changedsince=NULL) {
1520     global $DB;
1522     $params = array('type'=>$type, 'expiry'=>time());
1523     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1524     if ($changedsince !== NULL) {
1525         $params['changedsince'] = $changedsince;
1526         $sqlwhere .= " AND timemodified > :changedsince";
1527     }
1528     $cf = array();
1530     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1531         foreach ($flags as $flag) {
1532             $cf[$flag->name] = $flag->value;
1533         }
1534     }
1535     return $cf;
1538 /**
1539  * Get volatile flags
1540  *
1541  * @param string $type
1542  * @param string $name
1543  * @param int    $changedsince default null
1544  * @return records array
1545  */
1546 function get_cache_flag($type, $name, $changedsince=NULL) {
1547     global $DB;
1549     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1551     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1552     if ($changedsince !== NULL) {
1553         $params['changedsince'] = $changedsince;
1554         $sqlwhere .= " AND timemodified > :changedsince";
1555     }
1557     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1560 /**
1561  * Set a volatile flag
1562  *
1563  * @param string $type the "type" namespace for the key
1564  * @param string $name the key to set
1565  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1566  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1567  * @return bool Always returns true
1568  */
1569 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1570     global $DB;
1572     $timemodified = time();
1573     if ($expiry===NULL || $expiry < $timemodified) {
1574         $expiry = $timemodified + 24 * 60 * 60;
1575     } else {
1576         $expiry = (int)$expiry;
1577     }
1579     if ($value === NULL) {
1580         unset_cache_flag($type,$name);
1581         return true;
1582     }
1584     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1585         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1586             return true; //no need to update; helps rcache too
1587         }
1588         $f->value        = $value;
1589         $f->expiry       = $expiry;
1590         $f->timemodified = $timemodified;
1591         $DB->update_record('cache_flags', $f);
1592     } else {
1593         $f = new stdClass();
1594         $f->flagtype     = $type;
1595         $f->name         = $name;
1596         $f->value        = $value;
1597         $f->expiry       = $expiry;
1598         $f->timemodified = $timemodified;
1599         $DB->insert_record('cache_flags', $f);
1600     }
1601     return true;
1604 /**
1605  * Removes a single volatile flag
1606  *
1607  * @global object
1608  * @param string $type the "type" namespace for the key
1609  * @param string $name the key to set
1610  * @return bool
1611  */
1612 function unset_cache_flag($type, $name) {
1613     global $DB;
1614     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1615     return true;
1618 /**
1619  * Garbage-collect volatile flags
1620  *
1621  * @return bool Always returns true
1622  */
1623 function gc_cache_flags() {
1624     global $DB;
1625     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1626     return true;
1629 // USER PREFERENCE API
1631 /**
1632  * Refresh user preference cache. This is used most often for $USER
1633  * object that is stored in session, but it also helps with performance in cron script.
1634  *
1635  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1636  *
1637  * @package  core
1638  * @category preference
1639  * @access   public
1640  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1641  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1642  * @throws   coding_exception
1643  * @return   null
1644  */
1645 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1646     global $DB;
1647     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1649     if (!isset($user->id)) {
1650         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1651     }
1653     if (empty($user->id) or isguestuser($user->id)) {
1654         // No permanent storage for not-logged-in users and guest
1655         if (!isset($user->preference)) {
1656             $user->preference = array();
1657         }
1658         return;
1659     }
1661     $timenow = time();
1663     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1664         // Already loaded at least once on this page. Are we up to date?
1665         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1666             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1667             return;
1669         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1670             // no change since the lastcheck on this page
1671             $user->preference['_lastloaded'] = $timenow;
1672             return;
1673         }
1674     }
1676     // OK, so we have to reload all preferences
1677     $loadedusers[$user->id] = true;
1678     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1679     $user->preference['_lastloaded'] = $timenow;
1682 /**
1683  * Called from set/unset_user_preferences, so that the prefs can
1684  * be correctly reloaded in different sessions.
1685  *
1686  * NOTE: internal function, do not call from other code.
1687  *
1688  * @package core
1689  * @access  private
1690  * @param   integer         $userid the user whose prefs were changed.
1691  */
1692 function mark_user_preferences_changed($userid) {
1693     global $CFG;
1695     if (empty($userid) or isguestuser($userid)) {
1696         // no cache flags for guest and not-logged-in users
1697         return;
1698     }
1700     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1703 /**
1704  * Sets a preference for the specified user.
1705  *
1706  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1707  *
1708  * @package  core
1709  * @category preference
1710  * @access   public
1711  * @param    string            $name  The key to set as preference for the specified user
1712  * @param    string            $value The value to set for the $name key in the specified user's
1713  *                                    record, null means delete current value.
1714  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1715  * @throws   coding_exception
1716  * @return   bool                     Always true or exception
1717  */
1718 function set_user_preference($name, $value, $user = null) {
1719     global $USER, $DB;
1721     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1722         throw new coding_exception('Invalid preference name in set_user_preference() call');
1723     }
1725     if (is_null($value)) {
1726         // null means delete current
1727         return unset_user_preference($name, $user);
1728     } else if (is_object($value)) {
1729         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1730     } else if (is_array($value)) {
1731         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1732     }
1733     $value = (string)$value;
1734     if (textlib::strlen($value) > 1333) { //value column maximum length is 1333 characters
1735         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1736     }
1738     if (is_null($user)) {
1739         $user = $USER;
1740     } else if (isset($user->id)) {
1741         // $user is valid object
1742     } else if (is_numeric($user)) {
1743         $user = (object)array('id'=>(int)$user);
1744     } else {
1745         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1746     }
1748     check_user_preferences_loaded($user);
1750     if (empty($user->id) or isguestuser($user->id)) {
1751         // no permanent storage for not-logged-in users and guest
1752         $user->preference[$name] = $value;
1753         return true;
1754     }
1756     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1757         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1758             // preference already set to this value
1759             return true;
1760         }
1761         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1763     } else {
1764         $preference = new stdClass();
1765         $preference->userid = $user->id;
1766         $preference->name   = $name;
1767         $preference->value  = $value;
1768         $DB->insert_record('user_preferences', $preference);
1769     }
1771     // update value in cache
1772     $user->preference[$name] = $value;
1774     // set reload flag for other sessions
1775     mark_user_preferences_changed($user->id);
1777     return true;
1780 /**
1781  * Sets a whole array of preferences for the current user
1782  *
1783  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1784  *
1785  * @package  core
1786  * @category preference
1787  * @access   public
1788  * @param    array             $prefarray An array of key/value pairs to be set
1789  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1790  * @return   bool                         Always true or exception
1791  */
1792 function set_user_preferences(array $prefarray, $user = null) {
1793     foreach ($prefarray as $name => $value) {
1794         set_user_preference($name, $value, $user);
1795     }
1796     return true;
1799 /**
1800  * Unsets a preference completely by deleting it from the database
1801  *
1802  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1803  *
1804  * @package  core
1805  * @category preference
1806  * @access   public
1807  * @param    string            $name The key to unset as preference for the specified user
1808  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1809  * @throws   coding_exception
1810  * @return   bool                    Always true or exception
1811  */
1812 function unset_user_preference($name, $user = null) {
1813     global $USER, $DB;
1815     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1816         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1817     }
1819     if (is_null($user)) {
1820         $user = $USER;
1821     } else if (isset($user->id)) {
1822         // $user is valid object
1823     } else if (is_numeric($user)) {
1824         $user = (object)array('id'=>(int)$user);
1825     } else {
1826         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1827     }
1829     check_user_preferences_loaded($user);
1831     if (empty($user->id) or isguestuser($user->id)) {
1832         // no permanent storage for not-logged-in user and guest
1833         unset($user->preference[$name]);
1834         return true;
1835     }
1837     // delete from DB
1838     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1840     // delete the preference from cache
1841     unset($user->preference[$name]);
1843     // set reload flag for other sessions
1844     mark_user_preferences_changed($user->id);
1846     return true;
1849 /**
1850  * Used to fetch user preference(s)
1851  *
1852  * If no arguments are supplied this function will return
1853  * all of the current user preferences as an array.
1854  *
1855  * If a name is specified then this function
1856  * attempts to return that particular preference value.  If
1857  * none is found, then the optional value $default is returned,
1858  * otherwise NULL.
1859  *
1860  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1861  *
1862  * @package  core
1863  * @category preference
1864  * @access   public
1865  * @param    string            $name    Name of the key to use in finding a preference value
1866  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1867  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1868  * @throws   coding_exception
1869  * @return   string|mixed|null          A string containing the value of a single preference. An
1870  *                                      array with all of the preferences or null
1871  */
1872 function get_user_preferences($name = null, $default = null, $user = null) {
1873     global $USER;
1875     if (is_null($name)) {
1876         // all prefs
1877     } else if (is_numeric($name) or $name === '_lastloaded') {
1878         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1879     }
1881     if (is_null($user)) {
1882         $user = $USER;
1883     } else if (isset($user->id)) {
1884         // $user is valid object
1885     } else if (is_numeric($user)) {
1886         $user = (object)array('id'=>(int)$user);
1887     } else {
1888         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1889     }
1891     check_user_preferences_loaded($user);
1893     if (empty($name)) {
1894         return $user->preference; // All values
1895     } else if (isset($user->preference[$name])) {
1896         return $user->preference[$name]; // The single string value
1897     } else {
1898         return $default; // Default value (null if not specified)
1899     }
1902 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1904 /**
1905  * Given date parts in user time produce a GMT timestamp.
1906  *
1907  * @package core
1908  * @category time
1909  * @param int $year The year part to create timestamp of
1910  * @param int $month The month part to create timestamp of
1911  * @param int $day The day part to create timestamp of
1912  * @param int $hour The hour part to create timestamp of
1913  * @param int $minute The minute part to create timestamp of
1914  * @param int $second The second part to create timestamp of
1915  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
1916  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
1917  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1918  *             applied only if timezone is 99 or string.
1919  * @return int GMT timestamp
1920  */
1921 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1923     //save input timezone, required for dst offset check.
1924     $passedtimezone = $timezone;
1926     $timezone = get_user_timezone_offset($timezone);
1928     if (abs($timezone) > 13) {  //server time
1929         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1930     } else {
1931         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1932         $time = usertime($time, $timezone);
1934         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1935         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1936             $time -= dst_offset_on($time, $passedtimezone);
1937         }
1938     }
1940     return $time;
1944 /**
1945  * Format a date/time (seconds) as weeks, days, hours etc as needed
1946  *
1947  * Given an amount of time in seconds, returns string
1948  * formatted nicely as weeks, days, hours etc as needed
1949  *
1950  * @package core
1951  * @category time
1952  * @uses MINSECS
1953  * @uses HOURSECS
1954  * @uses DAYSECS
1955  * @uses YEARSECS
1956  * @param int $totalsecs Time in seconds
1957  * @param object $str Should be a time object
1958  * @return string A nicely formatted date/time string
1959  */
1960  function format_time($totalsecs, $str=NULL) {
1962     $totalsecs = abs($totalsecs);
1964     if (!$str) {  // Create the str structure the slow way
1965         $str = new stdClass();
1966         $str->day   = get_string('day');
1967         $str->days  = get_string('days');
1968         $str->hour  = get_string('hour');
1969         $str->hours = get_string('hours');
1970         $str->min   = get_string('min');
1971         $str->mins  = get_string('mins');
1972         $str->sec   = get_string('sec');
1973         $str->secs  = get_string('secs');
1974         $str->year  = get_string('year');
1975         $str->years = get_string('years');
1976     }
1979     $years     = floor($totalsecs/YEARSECS);
1980     $remainder = $totalsecs - ($years*YEARSECS);
1981     $days      = floor($remainder/DAYSECS);
1982     $remainder = $totalsecs - ($days*DAYSECS);
1983     $hours     = floor($remainder/HOURSECS);
1984     $remainder = $remainder - ($hours*HOURSECS);
1985     $mins      = floor($remainder/MINSECS);
1986     $secs      = $remainder - ($mins*MINSECS);
1988     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1989     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1990     $sh = ($hours == 1) ? $str->hour : $str->hours;
1991     $sd = ($days == 1)  ? $str->day  : $str->days;
1992     $sy = ($years == 1)  ? $str->year  : $str->years;
1994     $oyears = '';
1995     $odays = '';
1996     $ohours = '';
1997     $omins = '';
1998     $osecs = '';
2000     if ($years)  $oyears  = $years .' '. $sy;
2001     if ($days)  $odays  = $days .' '. $sd;
2002     if ($hours) $ohours = $hours .' '. $sh;
2003     if ($mins)  $omins  = $mins .' '. $sm;
2004     if ($secs)  $osecs  = $secs .' '. $ss;
2006     if ($years) return trim($oyears .' '. $odays);
2007     if ($days)  return trim($odays .' '. $ohours);
2008     if ($hours) return trim($ohours .' '. $omins);
2009     if ($mins)  return trim($omins .' '. $osecs);
2010     if ($secs)  return $osecs;
2011     return get_string('now');
2014 /**
2015  * Returns a formatted string that represents a date in user time
2016  *
2017  * Returns a formatted string that represents a date in user time
2018  * <b>WARNING: note that the format is for strftime(), not date().</b>
2019  * Because of a bug in most Windows time libraries, we can't use
2020  * the nicer %e, so we have to use %d which has leading zeroes.
2021  * A lot of the fuss in the function is just getting rid of these leading
2022  * zeroes as efficiently as possible.
2023  *
2024  * If parameter fixday = true (default), then take off leading
2025  * zero from %d, else maintain it.
2026  *
2027  * @package core
2028  * @category time
2029  * @param int $date the timestamp in UTC, as obtained from the database.
2030  * @param string $format strftime format. You should probably get this using
2031  *        get_string('strftime...', 'langconfig');
2032  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
2033  *        not 99 then daylight saving will not be added.
2034  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2035  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2036  *        If false then the leading zero is maintained.
2037  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2038  * @return string the formatted date/time.
2039  */
2040 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2042     global $CFG;
2044     if (empty($format)) {
2045         $format = get_string('strftimedaydatetime', 'langconfig');
2046     }
2048     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
2049         $fixday = false;
2050     } else if ($fixday) {
2051         $formatnoday = str_replace('%d', 'DD', $format);
2052         $fixday = ($formatnoday != $format);
2053         $format = $formatnoday;
2054     }
2056     // Note: This logic about fixing 12-hour time to remove unnecessary leading
2057     // zero is required because on Windows, PHP strftime function does not
2058     // support the correct 'hour without leading zero' parameter (%l).
2059     if (!empty($CFG->nofixhour)) {
2060         // Config.php can force %I not to be fixed.
2061         $fixhour = false;
2062     } else if ($fixhour) {
2063         $formatnohour = str_replace('%I', 'HH', $format);
2064         $fixhour = ($formatnohour != $format);
2065         $format = $formatnohour;
2066     }
2068     //add daylight saving offset for string timezones only, as we can't get dst for
2069     //float values. if timezone is 99 (user default timezone), then try update dst.
2070     if ((99 == $timezone) || !is_numeric($timezone)) {
2071         $date += dst_offset_on($date, $timezone);
2072     }
2074     $timezone = get_user_timezone_offset($timezone);
2076     // If we are running under Windows convert to windows encoding and then back to UTF-8
2077     // (because it's impossible to specify UTF-8 to fetch locale info in Win32)
2079     if (abs($timezone) > 13) {   /// Server time
2080         if ($CFG->ostype == 'WINDOWS' and ($localewincharset = get_string('localewincharset', 'langconfig'))) {
2081             $format = textlib::convert($format, 'utf-8', $localewincharset);
2082             $datestring = strftime($format, $date);
2083             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2084         } else {
2085             $datestring = strftime($format, $date);
2086         }
2087         if ($fixday) {
2088             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
2089             $datestring = str_replace('DD', $daystring, $datestring);
2090         }
2091         if ($fixhour) {
2092             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
2093             $datestring = str_replace('HH', $hourstring, $datestring);
2094         }
2096     } else {
2097         $date += (int)($timezone * 3600);
2098         if ($CFG->ostype == 'WINDOWS' and ($localewincharset = get_string('localewincharset', 'langconfig'))) {
2099             $format = textlib::convert($format, 'utf-8', $localewincharset);
2100             $datestring = gmstrftime($format, $date);
2101             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2102         } else {
2103             $datestring = gmstrftime($format, $date);
2104         }
2105         if ($fixday) {
2106             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2107             $datestring = str_replace('DD', $daystring, $datestring);
2108         }
2109         if ($fixhour) {
2110             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2111             $datestring = str_replace('HH', $hourstring, $datestring);
2112         }
2113     }
2115     return $datestring;
2118 /**
2119  * Given a $time timestamp in GMT (seconds since epoch),
2120  * returns an array that represents the date in user time
2121  *
2122  * @package core
2123  * @category time
2124  * @uses HOURSECS
2125  * @param int $time Timestamp in GMT
2126  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2127  *        dst offset is applyed {@link http://docs.moodle.org/dev/Time_API#Timezone}
2128  * @return array An array that represents the date in user time
2129  */
2130 function usergetdate($time, $timezone=99) {
2132     //save input timezone, required for dst offset check.
2133     $passedtimezone = $timezone;
2135     $timezone = get_user_timezone_offset($timezone);
2137     if (abs($timezone) > 13) {    // Server time
2138         return getdate($time);
2139     }
2141     //add daylight saving offset for string timezones only, as we can't get dst for
2142     //float values. if timezone is 99 (user default timezone), then try update dst.
2143     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2144         $time += dst_offset_on($time, $passedtimezone);
2145     }
2147     $time += intval((float)$timezone * HOURSECS);
2149     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2151     //be careful to ensure the returned array matches that produced by getdate() above
2152     list(
2153         $getdate['month'],
2154         $getdate['weekday'],
2155         $getdate['yday'],
2156         $getdate['year'],
2157         $getdate['mon'],
2158         $getdate['wday'],
2159         $getdate['mday'],
2160         $getdate['hours'],
2161         $getdate['minutes'],
2162         $getdate['seconds']
2163     ) = explode('_', $datestring);
2165     // set correct datatype to match with getdate()
2166     $getdate['seconds'] = (int)$getdate['seconds'];
2167     $getdate['yday'] = (int)$getdate['yday'] - 1; // gettime returns 0 through 365
2168     $getdate['year'] = (int)$getdate['year'];
2169     $getdate['mon'] = (int)$getdate['mon'];
2170     $getdate['wday'] = (int)$getdate['wday'];
2171     $getdate['mday'] = (int)$getdate['mday'];
2172     $getdate['hours'] = (int)$getdate['hours'];
2173     $getdate['minutes']  = (int)$getdate['minutes'];
2174     return $getdate;
2177 /**
2178  * Given a GMT timestamp (seconds since epoch), offsets it by
2179  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2180  *
2181  * @package core
2182  * @category time
2183  * @uses HOURSECS
2184  * @param int $date Timestamp in GMT
2185  * @param float|int|string $timezone timezone to calculate GMT time offset before
2186  *        calculating user time, 99 is default user timezone
2187  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2188  * @return int
2189  */
2190 function usertime($date, $timezone=99) {
2192     $timezone = get_user_timezone_offset($timezone);
2194     if (abs($timezone) > 13) {
2195         return $date;
2196     }
2197     return $date - (int)($timezone * HOURSECS);
2200 /**
2201  * Given a time, return the GMT timestamp of the most recent midnight
2202  * for the current user.
2203  *
2204  * @package core
2205  * @category time
2206  * @param int $date Timestamp in GMT
2207  * @param float|int|string $timezone timezone to calculate GMT time offset before
2208  *        calculating user midnight time, 99 is default user timezone
2209  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2210  * @return int Returns a GMT timestamp
2211  */
2212 function usergetmidnight($date, $timezone=99) {
2214     $userdate = usergetdate($date, $timezone);
2216     // Time of midnight of this user's day, in GMT
2217     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2221 /**
2222  * Returns a string that prints the user's timezone
2223  *
2224  * @package core
2225  * @category time
2226  * @param float|int|string $timezone timezone to calculate GMT time offset before
2227  *        calculating user timezone, 99 is default user timezone
2228  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2229  * @return string
2230  */
2231 function usertimezone($timezone=99) {
2233     $tz = get_user_timezone($timezone);
2235     if (!is_float($tz)) {
2236         return $tz;
2237     }
2239     if(abs($tz) > 13) { // Server time
2240         return get_string('serverlocaltime');
2241     }
2243     if($tz == intval($tz)) {
2244         // Don't show .0 for whole hours
2245         $tz = intval($tz);
2246     }
2248     if($tz == 0) {
2249         return 'UTC';
2250     }
2251     else if($tz > 0) {
2252         return 'UTC+'.$tz;
2253     }
2254     else {
2255         return 'UTC'.$tz;
2256     }
2260 /**
2261  * Returns a float which represents the user's timezone difference from GMT in hours
2262  * Checks various settings and picks the most dominant of those which have a value
2263  *
2264  * @package core
2265  * @category time
2266  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2267  *        99 is default user timezone
2268  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2269  * @return float
2270  */
2271 function get_user_timezone_offset($tz = 99) {
2273     global $USER, $CFG;
2275     $tz = get_user_timezone($tz);
2277     if (is_float($tz)) {
2278         return $tz;
2279     } else {
2280         $tzrecord = get_timezone_record($tz);
2281         if (empty($tzrecord)) {
2282             return 99.0;
2283         }
2284         return (float)$tzrecord->gmtoff / HOURMINS;
2285     }
2288 /**
2289  * Returns an int which represents the systems's timezone difference from GMT in seconds
2290  *
2291  * @package core
2292  * @category time
2293  * @param float|int|string $tz timezone for which offset is required.
2294  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2295  * @return int|bool if found, false is timezone 99 or error
2296  */
2297 function get_timezone_offset($tz) {
2298     global $CFG;
2300     if ($tz == 99) {
2301         return false;
2302     }
2304     if (is_numeric($tz)) {
2305         return intval($tz * 60*60);
2306     }
2308     if (!$tzrecord = get_timezone_record($tz)) {
2309         return false;
2310     }
2311     return intval($tzrecord->gmtoff * 60);
2314 /**
2315  * Returns a float or a string which denotes the user's timezone
2316  * 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)
2317  * means that for this timezone there are also DST rules to be taken into account
2318  * Checks various settings and picks the most dominant of those which have a value
2319  *
2320  * @package core
2321  * @category time
2322  * @param float|int|string $tz timezone to calculate GMT time offset before
2323  *        calculating user timezone, 99 is default user timezone
2324  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2325  * @return float|string
2326  */
2327 function get_user_timezone($tz = 99) {
2328     global $USER, $CFG;
2330     $timezones = array(
2331         $tz,
2332         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2333         isset($USER->timezone) ? $USER->timezone : 99,
2334         isset($CFG->timezone) ? $CFG->timezone : 99,
2335         );
2337     $tz = 99;
2339     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array
2340     while(((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2341         $tz = $next['value'];
2342     }
2343     return is_numeric($tz) ? (float) $tz : $tz;
2346 /**
2347  * Returns cached timezone record for given $timezonename
2348  *
2349  * @package core
2350  * @param string $timezonename name of the timezone
2351  * @return stdClass|bool timezonerecord or false
2352  */
2353 function get_timezone_record($timezonename) {
2354     global $CFG, $DB;
2355     static $cache = NULL;
2357     if ($cache === NULL) {
2358         $cache = array();
2359     }
2361     if (isset($cache[$timezonename])) {
2362         return $cache[$timezonename];
2363     }
2365     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2366                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2369 /**
2370  * Build and store the users Daylight Saving Time (DST) table
2371  *
2372  * @package core
2373  * @param int $from_year Start year for the table, defaults to 1971
2374  * @param int $to_year End year for the table, defaults to 2035
2375  * @param int|float|string $strtimezone, timezone to check if dst should be applyed.
2376  * @return bool
2377  */
2378 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2379     global $CFG, $SESSION, $DB;
2381     $usertz = get_user_timezone($strtimezone);
2383     if (is_float($usertz)) {
2384         // Trivial timezone, no DST
2385         return false;
2386     }
2388     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2389         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2390         unset($SESSION->dst_offsets);
2391         unset($SESSION->dst_range);
2392     }
2394     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2395         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2396         // This will be the return path most of the time, pretty light computationally
2397         return true;
2398     }
2400     // Reaching here means we either need to extend our table or create it from scratch
2402     // Remember which TZ we calculated these changes for
2403     $SESSION->dst_offsettz = $usertz;
2405     if(empty($SESSION->dst_offsets)) {
2406         // If we 're creating from scratch, put the two guard elements in there
2407         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2408     }
2409     if(empty($SESSION->dst_range)) {
2410         // If creating from scratch
2411         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2412         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2414         // Fill in the array with the extra years we need to process
2415         $yearstoprocess = array();
2416         for($i = $from; $i <= $to; ++$i) {
2417             $yearstoprocess[] = $i;
2418         }
2420         // Take note of which years we have processed for future calls
2421         $SESSION->dst_range = array($from, $to);
2422     }
2423     else {
2424         // If needing to extend the table, do the same
2425         $yearstoprocess = array();
2427         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2428         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2430         if($from < $SESSION->dst_range[0]) {
2431             // Take note of which years we need to process and then note that we have processed them for future calls
2432             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2433                 $yearstoprocess[] = $i;
2434             }
2435             $SESSION->dst_range[0] = $from;
2436         }
2437         if($to > $SESSION->dst_range[1]) {
2438             // Take note of which years we need to process and then note that we have processed them for future calls
2439             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2440                 $yearstoprocess[] = $i;
2441             }
2442             $SESSION->dst_range[1] = $to;
2443         }
2444     }
2446     if(empty($yearstoprocess)) {
2447         // This means that there was a call requesting a SMALLER range than we have already calculated
2448         return true;
2449     }
2451     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2452     // Also, the array is sorted in descending timestamp order!
2454     // Get DB data
2456     static $presets_cache = array();
2457     if (!isset($presets_cache[$usertz])) {
2458         $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');
2459     }
2460     if(empty($presets_cache[$usertz])) {
2461         return false;
2462     }
2464     // Remove ending guard (first element of the array)
2465     reset($SESSION->dst_offsets);
2466     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2468     // Add all required change timestamps
2469     foreach($yearstoprocess as $y) {
2470         // Find the record which is in effect for the year $y
2471         foreach($presets_cache[$usertz] as $year => $preset) {
2472             if($year <= $y) {
2473                 break;
2474             }
2475         }
2477         $changes = dst_changes_for_year($y, $preset);
2479         if($changes === NULL) {
2480             continue;
2481         }
2482         if($changes['dst'] != 0) {
2483             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2484         }
2485         if($changes['std'] != 0) {
2486             $SESSION->dst_offsets[$changes['std']] = 0;
2487         }
2488     }
2490     // Put in a guard element at the top
2491     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2492     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2494     // Sort again
2495     krsort($SESSION->dst_offsets);
2497     return true;
2500 /**
2501  * Calculates the required DST change and returns a Timestamp Array
2502  *
2503  * @package core
2504  * @category time
2505  * @uses HOURSECS
2506  * @uses MINSECS
2507  * @param int|string $year Int or String Year to focus on
2508  * @param object $timezone Instatiated Timezone object
2509  * @return array|null Array dst=>xx, 0=>xx, std=>yy, 1=>yy or NULL
2510  */
2511 function dst_changes_for_year($year, $timezone) {
2513     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2514         return NULL;
2515     }
2517     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2518     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2520     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2521     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2523     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2524     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2526     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2527     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2528     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2530     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2531     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2533     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2536 /**
2537  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2538  * - Note: Daylight saving only works for string timezones and not for float.
2539  *
2540  * @package core
2541  * @category time
2542  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2543  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2544  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2545  * @return int
2546  */
2547 function dst_offset_on($time, $strtimezone = NULL) {
2548     global $SESSION;
2550     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2551         return 0;
2552     }
2554     reset($SESSION->dst_offsets);
2555     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2556         if($from <= $time) {
2557             break;
2558         }
2559     }
2561     // This is the normal return path
2562     if($offset !== NULL) {
2563         return $offset;
2564     }
2566     // Reaching this point means we haven't calculated far enough, do it now:
2567     // Calculate extra DST changes if needed and recurse. The recursion always
2568     // moves toward the stopping condition, so will always end.
2570     if($from == 0) {
2571         // We need a year smaller than $SESSION->dst_range[0]
2572         if($SESSION->dst_range[0] == 1971) {
2573             return 0;
2574         }
2575         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2576         return dst_offset_on($time, $strtimezone);
2577     }
2578     else {
2579         // We need a year larger than $SESSION->dst_range[1]
2580         if($SESSION->dst_range[1] == 2035) {
2581             return 0;
2582         }
2583         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2584         return dst_offset_on($time, $strtimezone);
2585     }
2588 /**
2589  * Calculates when the day appears in specific month
2590  *
2591  * @package core
2592  * @category time
2593  * @param int $startday starting day of the month
2594  * @param int $weekday The day when week starts (normally taken from user preferences)
2595  * @param int $month The month whose day is sought
2596  * @param int $year The year of the month whose day is sought
2597  * @return int
2598  */
2599 function find_day_in_month($startday, $weekday, $month, $year) {
2601     $daysinmonth = days_in_month($month, $year);
2603     if($weekday == -1) {
2604         // Don't care about weekday, so return:
2605         //    abs($startday) if $startday != -1
2606         //    $daysinmonth otherwise
2607         return ($startday == -1) ? $daysinmonth : abs($startday);
2608     }
2610     // From now on we 're looking for a specific weekday
2612     // Give "end of month" its actual value, since we know it
2613     if($startday == -1) {
2614         $startday = -1 * $daysinmonth;
2615     }
2617     // Starting from day $startday, the sign is the direction
2619     if($startday < 1) {
2621         $startday = abs($startday);
2622         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2624         // This is the last such weekday of the month
2625         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2626         if($lastinmonth > $daysinmonth) {
2627             $lastinmonth -= 7;
2628         }
2630         // Find the first such weekday <= $startday
2631         while($lastinmonth > $startday) {
2632             $lastinmonth -= 7;
2633         }
2635         return $lastinmonth;
2637     }
2638     else {
2640         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2642         $diff = $weekday - $indexweekday;
2643         if($diff < 0) {
2644             $diff += 7;
2645         }
2647         // This is the first such weekday of the month equal to or after $startday
2648         $firstfromindex = $startday + $diff;
2650         return $firstfromindex;
2652     }
2655 /**
2656  * Calculate the number of days in a given month
2657  *
2658  * @package core
2659  * @category time
2660  * @param int $month The month whose day count is sought
2661  * @param int $year The year of the month whose day count is sought
2662  * @return int
2663  */
2664 function days_in_month($month, $year) {
2665    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2668 /**
2669  * Calculate the position in the week of a specific calendar day
2670  *
2671  * @package core
2672  * @category time
2673  * @param int $day The day of the date whose position in the week is sought
2674  * @param int $month The month of the date whose position in the week is sought
2675  * @param int $year The year of the date whose position in the week is sought
2676  * @return int
2677  */
2678 function dayofweek($day, $month, $year) {
2679     // I wonder if this is any different from
2680     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2681     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2684 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2686 /**
2687  * Returns full login url.
2688  *
2689  * @return string login url
2690  */
2691 function get_login_url() {
2692     global $CFG;
2694     $url = "$CFG->wwwroot/login/index.php";
2696     if (!empty($CFG->loginhttps)) {
2697         $url = str_replace('http:', 'https:', $url);
2698     }
2700     return $url;
2703 /**
2704  * This function checks that the current user is logged in and has the
2705  * required privileges
2706  *
2707  * This function checks that the current user is logged in, and optionally
2708  * whether they are allowed to be in a particular course and view a particular
2709  * course module.
2710  * If they are not logged in, then it redirects them to the site login unless
2711  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2712  * case they are automatically logged in as guests.
2713  * If $courseid is given and the user is not enrolled in that course then the
2714  * user is redirected to the course enrolment page.
2715  * If $cm is given and the course module is hidden and the user is not a teacher
2716  * in the course then the user is redirected to the course home page.
2717  *
2718  * When $cm parameter specified, this function sets page layout to 'module'.
2719  * You need to change it manually later if some other layout needed.
2720  *
2721  * @package    core_access
2722  * @category   access
2723  *
2724  * @param mixed $courseorid id of the course or course object
2725  * @param bool $autologinguest default true
2726  * @param object $cm course module object
2727  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2728  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2729  *             in order to keep redirects working properly. MDL-14495
2730  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2731  * @return mixed Void, exit, and die depending on path
2732  */
2733 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2734     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2736     // setup global $COURSE, themes, language and locale
2737     if (!empty($courseorid)) {
2738         if (is_object($courseorid)) {
2739             $course = $courseorid;
2740         } else if ($courseorid == SITEID) {
2741             $course = clone($SITE);
2742         } else {
2743             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2744         }
2745         if ($cm) {
2746             if ($cm->course != $course->id) {
2747                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2748             }
2749             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2750             if (!($cm instanceof cm_info)) {
2751                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2752                 // db queries so this is not really a performance concern, however it is obviously
2753                 // better if you use get_fast_modinfo to get the cm before calling this.
2754                 $modinfo = get_fast_modinfo($course);
2755                 $cm = $modinfo->get_cm($cm->id);
2756             }
2757             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2758             $PAGE->set_pagelayout('incourse');
2759         } else {
2760             $PAGE->set_course($course); // set's up global $COURSE
2761         }
2762     } else {
2763         // do not touch global $COURSE via $PAGE->set_course(),
2764         // the reasons is we need to be able to call require_login() at any time!!
2765         $course = $SITE;
2766         if ($cm) {
2767             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2768         }
2769     }
2771     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2772     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2773     // risk leading the user back to the AJAX request URL.
2774     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2775         $setwantsurltome = false;
2776     }
2778     // If the user is not even logged in yet then make sure they are
2779     if (!isloggedin()) {
2780         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2781             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2782                 // misconfigured site guest, just redirect to login page
2783                 redirect(get_login_url());
2784                 exit; // never reached
2785             }
2786             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2787             complete_user_login($guest);
2788             $USER->autologinguest = true;
2789             $SESSION->lang = $lang;
2790         } else {
2791             //NOTE: $USER->site check was obsoleted by session test cookie,
2792             //      $USER->confirmed test is in login/index.php
2793             if ($preventredirect) {
2794                 throw new require_login_exception('You are not logged in');
2795             }
2797             if ($setwantsurltome) {
2798                 $SESSION->wantsurl = qualified_me();
2799             }
2800             if (!empty($_SERVER['HTTP_REFERER'])) {
2801                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2802             }
2803             redirect(get_login_url());
2804             exit; // never reached
2805         }
2806     }
2808     // loginas as redirection if needed
2809     if ($course->id != SITEID and session_is_loggedinas()) {
2810         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2811             if ($USER->loginascontext->instanceid != $course->id) {
2812                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2813             }
2814         }
2815     }
2817     // check whether the user should be changing password (but only if it is REALLY them)
2818     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2819         $userauth = get_auth_plugin($USER->auth);
2820         if ($userauth->can_change_password() and !$preventredirect) {
2821             if ($setwantsurltome) {
2822                 $SESSION->wantsurl = qualified_me();
2823             }
2824             if ($changeurl = $userauth->change_password_url()) {
2825                 //use plugin custom url
2826                 redirect($changeurl);
2827             } else {
2828                 //use moodle internal method
2829                 if (empty($CFG->loginhttps)) {
2830                     redirect($CFG->wwwroot .'/login/change_password.php');
2831                 } else {
2832                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2833                     redirect($wwwroot .'/login/change_password.php');
2834                 }
2835             }
2836         } else {
2837             print_error('nopasswordchangeforced', 'auth');
2838         }
2839     }
2841     // Check that the user account is properly set up
2842     if (user_not_fully_set_up($USER)) {
2843         if ($preventredirect) {
2844             throw new require_login_exception('User not fully set-up');
2845         }
2846         if ($setwantsurltome) {
2847             $SESSION->wantsurl = qualified_me();
2848         }
2849         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2850     }
2852     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2853     sesskey();
2855     // Do not bother admins with any formalities
2856     if (is_siteadmin()) {
2857         //set accesstime or the user will appear offline which messes up messaging
2858         user_accesstime_log($course->id);
2859         return;
2860     }
2862     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2863     if (!$USER->policyagreed and !is_siteadmin()) {
2864         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2865             if ($preventredirect) {
2866                 throw new require_login_exception('Policy not agreed');
2867             }
2868             if ($setwantsurltome) {
2869                 $SESSION->wantsurl = qualified_me();
2870             }
2871             redirect($CFG->wwwroot .'/user/policy.php');
2872         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2873             if ($preventredirect) {
2874                 throw new require_login_exception('Policy not agreed');
2875             }
2876             if ($setwantsurltome) {
2877                 $SESSION->wantsurl = qualified_me();
2878             }
2879             redirect($CFG->wwwroot .'/user/policy.php');
2880         }
2881     }
2883     // Fetch the system context, the course context, and prefetch its child contexts
2884     $sysctx = context_system::instance();
2885     $coursecontext = context_course::instance($course->id, MUST_EXIST);
2886     if ($cm) {
2887         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
2888     } else {
2889         $cmcontext = null;
2890     }
2892     // If the site is currently under maintenance, then print a message
2893     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2894         if ($preventredirect) {
2895             throw new require_login_exception('Maintenance in progress');
2896         }
2898         print_maintenance_message();
2899     }
2901     // make sure the course itself is not hidden
2902     if ($course->id == SITEID) {
2903         // frontpage can not be hidden
2904     } else {
2905         if (is_role_switched($course->id)) {
2906             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2907         } else {
2908             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2909                 // originally there was also test of parent category visibility,
2910                 // BUT is was very slow in complex queries involving "my courses"
2911                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2912                 if ($preventredirect) {
2913                     throw new require_login_exception('Course is hidden');
2914                 }
2915                 // We need to override the navigation URL as the course won't have
2916                 // been added to the navigation and thus the navigation will mess up
2917                 // when trying to find it.
2918                 navigation_node::override_active_url(new moodle_url('/'));
2919                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2920             }
2921         }
2922     }
2924     // is the user enrolled?
2925     if ($course->id == SITEID) {
2926         // everybody is enrolled on the frontpage
2928     } else {
2929         if (session_is_loggedinas()) {
2930             // Make sure the REAL person can access this course first
2931             $realuser = session_get_realuser();
2932             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2933                 if ($preventredirect) {
2934                     throw new require_login_exception('Invalid course login-as access');
2935                 }
2936                 echo $OUTPUT->header();
2937                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2938             }
2939         }
2941         $access = false;
2943         if (is_role_switched($course->id)) {
2944             // ok, user had to be inside this course before the switch
2945             $access = true;
2947         } else if (is_viewing($coursecontext, $USER)) {
2948             // ok, no need to mess with enrol
2949             $access = true;
2951         } else {
2952             if (isset($USER->enrol['enrolled'][$course->id])) {
2953                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2954                     $access = true;
2955                     if (isset($USER->enrol['tempguest'][$course->id])) {
2956                         unset($USER->enrol['tempguest'][$course->id]);
2957                         remove_temp_course_roles($coursecontext);
2958                     }
2959                 } else {
2960                     //expired
2961                     unset($USER->enrol['enrolled'][$course->id]);
2962                 }
2963             }
2964             if (isset($USER->enrol['tempguest'][$course->id])) {
2965                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2966                     $access = true;
2967                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2968                     $access = true;
2969                 } else {
2970                     //expired
2971                     unset($USER->enrol['tempguest'][$course->id]);
2972                     remove_temp_course_roles($coursecontext);
2973                 }
2974             }
2976             if ($access) {
2977                 // cache ok
2978             } else {
2979                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2980                 if ($until !== false) {
2981                     // active participants may always access, a timestamp in the future, 0 (always) or false.
2982                     if ($until == 0) {
2983                         $until = ENROL_MAX_TIMESTAMP;
2984                     }
2985                     $USER->enrol['enrolled'][$course->id] = $until;
2986                     $access = true;
2988                 } else {
2989                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2990                     $enrols = enrol_get_plugins(true);
2991                     // first ask all enabled enrol instances in course if they want to auto enrol user
2992                     foreach($instances as $instance) {
2993                         if (!isset($enrols[$instance->enrol])) {
2994                             continue;
2995                         }
2996                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2997                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2998                         if ($until !== false) {
2999                             if ($until == 0) {
3000                                 $until = ENROL_MAX_TIMESTAMP;
3001                             }
3002                             $USER->enrol['enrolled'][$course->id] = $until;
3003                             $access = true;
3004                             break;
3005                         }
3006                     }
3007                     // if not enrolled yet try to gain temporary guest access
3008                     if (!$access) {
3009                         foreach($instances as $instance) {
3010                             if (!isset($enrols[$instance->enrol])) {
3011                                 continue;
3012                             }
3013                             // Get a duration for the guest access, a timestamp in the future or false.
3014                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3015                             if ($until !== false and $until > time()) {
3016                                 $USER->enrol['tempguest'][$course->id] = $until;
3017                                 $access = true;
3018                                 break;
3019                             }
3020                         }
3021                     }
3022                 }
3023             }
3024         }
3026         if (!$access) {
3027             if ($preventredirect) {
3028                 throw new require_login_exception('Not enrolled');
3029             }
3030             if ($setwantsurltome) {
3031                 $SESSION->wantsurl = qualified_me();
3032             }
3033             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3034         }
3035     }
3037     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
3038     // conditional availability, etc
3039     if ($cm && !$cm->uservisible) {
3040         if ($preventredirect) {
3041             throw new require_login_exception('Activity is hidden');
3042         }
3043         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
3044     }
3046     // Finally access granted, update lastaccess times
3047     user_accesstime_log($course->id);
3051 /**
3052  * This function just makes sure a user is logged out.
3053  *
3054  * @package    core_access
3055  */
3056 function require_logout() {
3057     global $USER;
3059     $params = $USER;
3061     if (isloggedin()) {
3062         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
3064         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
3065         foreach($authsequence as $authname) {
3066             $authplugin = get_auth_plugin($authname);
3067             $authplugin->prelogout_hook();
3068         }
3069     }
3071     events_trigger('user_logout', $params);
3072     session_get_instance()->terminate_current();
3073     unset($params);
3076 /**
3077  * Weaker version of require_login()
3078  *
3079  * This is a weaker version of {@link require_login()} which only requires login
3080  * when called from within a course rather than the site page, unless
3081  * the forcelogin option is turned on.
3082  * @see require_login()
3083  *
3084  * @package    core_access
3085  * @category   access
3086  *
3087  * @param mixed $courseorid The course object or id in question
3088  * @param bool $autologinguest Allow autologin guests if that is wanted
3089  * @param object $cm Course activity module if known
3090  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3091  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3092  *             in order to keep redirects working properly. MDL-14495
3093  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3094  * @return void
3095  */
3096 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
3097     global $CFG, $PAGE, $SITE;
3098     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3099           or (!is_object($courseorid) and $courseorid == SITEID);
3100     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3101         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
3102         // db queries so this is not really a performance concern, however it is obviously
3103         // better if you use get_fast_modinfo to get the cm before calling this.
3104         if (is_object($courseorid)) {
3105             $course = $courseorid;
3106         } else {
3107             $course = clone($SITE);
3108         }
3109         $modinfo = get_fast_modinfo($course);
3110         $cm = $modinfo->get_cm($cm->id);
3111     }
3112     if (!empty($CFG->forcelogin)) {
3113         // login required for both SITE and courses
3114         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3116     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3117         // always login for hidden activities
3118         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3120     } else if ($issite) {
3121               //login for SITE not required
3122         if ($cm and empty($cm->visible)) {
3123             // hidden activities are not accessible without login
3124             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3125         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3126             // not-logged-in users do not have any group membership
3127             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3128         } else {
3129             // We still need to instatiate PAGE vars properly so that things
3130             // that rely on it like navigation function correctly.
3131             if (!empty($courseorid)) {
3132                 if (is_object($courseorid)) {
3133                     $course = $courseorid;
3134                 } else {
3135                     $course = clone($SITE);
3136                 }
3137                 if ($cm) {
3138                     if ($cm->course != $course->id) {
3139                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3140                     }
3141                     $PAGE->set_cm($cm, $course);
3142                     $PAGE->set_pagelayout('incourse');
3143                 } else {
3144                     $PAGE->set_course($course);
3145                 }
3146             } else {
3147                 // If $PAGE->course, and hence $PAGE->context, have not already been set
3148                 // up properly, set them up now.
3149                 $PAGE->set_course($PAGE->course);
3150             }
3151             //TODO: verify conditional activities here
3152             user_accesstime_log(SITEID);
3153             return;
3154         }
3156     } else {
3157         // course login always required
3158         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3159     }
3162 /**
3163  * Require key login. Function terminates with error if key not found or incorrect.
3164  *
3165  * @global object
3166  * @global object
3167  * @global object
3168  * @global object
3169  * @uses NO_MOODLE_COOKIES
3170  * @uses PARAM_ALPHANUM
3171  * @param string $script unique script identifier
3172  * @param int $instance optional instance id
3173  * @return int Instance ID
3174  */
3175 function require_user_key_login($script, $instance=null) {
3176     global $USER, $SESSION, $CFG, $DB;
3178     if (!NO_MOODLE_COOKIES) {
3179         print_error('sessioncookiesdisable');
3180     }
3182 /// extra safety
3183     @session_write_close();
3185     $keyvalue = required_param('key', PARAM_ALPHANUM);
3187     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3188         print_error('invalidkey');
3189     }
3191     if (!empty($key->validuntil) and $key->validuntil < time()) {
3192         print_error('expiredkey');
3193     }
3195     if ($key->iprestriction) {
3196         $remoteaddr = getremoteaddr(null);
3197         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3198             print_error('ipmismatch');
3199         }
3200     }
3202     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3203         print_error('invaliduserid');
3204     }
3206 /// emulate normal session
3207     enrol_check_plugins($user);
3208     session_set_user($user);
3210 /// note we are not using normal login
3211     if (!defined('USER_KEY_LOGIN')) {
3212         define('USER_KEY_LOGIN', true);
3213     }
3215 /// return instance id - it might be empty
3216     return $key->instance;
3219 /**
3220  * Creates a new private user access key.
3221  *
3222  * @global object
3223  * @param string $script unique target identifier
3224  * @param int $userid
3225  * @param int $instance optional instance id
3226  * @param string $iprestriction optional ip restricted access
3227  * @param timestamp $validuntil key valid only until given data
3228  * @return string access key value
3229  */
3230 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3231     global $DB;
3233     $key = new stdClass();
3234     $key->script        = $script;
3235     $key->userid        = $userid;
3236     $key->instance      = $instance;
3237     $key->iprestriction = $iprestriction;
3238     $key->validuntil    = $validuntil;
3239     $key->timecreated   = time();
3241     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3242     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3243         // must be unique
3244         $key->value     = md5($userid.'_'.time().random_string(40));
3245     }
3246     $DB->insert_record('user_private_key', $key);
3247     return $key->value;
3250 /**
3251  * Delete the user's new private user access keys for a particular script.
3252  *
3253  * @global object
3254  * @param string $script unique target identifier
3255  * @param int $userid
3256  * @return void
3257  */
3258 function delete_user_key($script,$userid) {
3259     global $DB;
3260     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3263 /**
3264  * Gets a private user access key (and creates one if one doesn't exist).
3265  *
3266  * @global object
3267  * @param string $script unique target identifier
3268  * @param int $userid
3269  * @param int $instance optional instance id
3270  * @param string $iprestriction optional ip restricted access
3271  * @param timestamp $validuntil key valid only until given data
3272  * @return string access key value
3273  */
3274 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3275     global $DB;
3277     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3278                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3279                                                          'validuntil'=>$validuntil))) {
3280         return $key->value;
3281     } else {
3282         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3283     }
3287 /**
3288  * Modify the user table by setting the currently logged in user's
3289  * last login to now.
3290  *
3291  * @global object
3292  * @global object
3293  * @return bool Always returns true
3294  */
3295 function update_user_login_times() {
3296     global $USER, $DB;
3298     $now = time();
3300     $user = new stdClass();
3301     $user->id = $USER->id;
3303     // Make sure all users that logged in have some firstaccess.
3304     if ($USER->firstaccess == 0) {
3305         $USER->firstaccess = $user->firstaccess = $now;
3306     }
3308     // Store the previous current as lastlogin.
3309     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3311     $USER->currentlogin = $user->currentlogin = $now;
3313     // Function user_accesstime_log() may not update immediately, better do it here.
3314     $USER->lastaccess = $user->lastaccess = $now;
3315     $USER->lastip = $user->lastip = getremoteaddr();
3317     $DB->update_record('user', $user);
3318     return true;
3321 /**
3322  * Determines if a user has completed setting up their account.
3323  *
3324  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3325  * @return bool
3326  */
3327 function user_not_fully_set_up($user) {
3328     if (isguestuser($user)) {
3329         return false;
3330     }
3331     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3334 /**
3335  * Check whether the user has exceeded the bounce threshold
3336  *
3337  * @global object
3338  * @global object
3339  * @param user $user A {@link $USER} object
3340  * @return bool true=>User has exceeded bounce threshold
3341  */
3342 function over_bounce_threshold($user) {
3343     global $CFG, $DB;
3345     if (empty($CFG->handlebounces)) {
3346         return false;
3347     }
3349     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3350         return false;
3351     }
3353     // set sensible defaults
3354     if (empty($CFG->minbounces)) {
3355         $CFG->minbounces = 10;
3356     }
3357     if (empty($CFG->bounceratio)) {
3358         $CFG->bounceratio = .20;
3359     }
3360     $bouncecount = 0;
3361     $sendcount = 0;
3362     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3363         $bouncecount = $bounce->value;
3364     }
3365     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3366         $sendcount = $send->value;
3367     }
3368     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3371 /**
3372  * Used to increment or reset email sent count
3373  *
3374  * @global object
3375  * @param user $user object containing an id
3376  * @param bool $reset will reset the count to 0
3377  * @return void
3378  */
3379 function set_send_count($user,$reset=false) {
3380     global $DB;
3382     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3383         return;
3384     }
3386     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3387         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3388         $DB->update_record('user_preferences', $pref);
3389     }
3390     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3391         // make a new one
3392         $pref = new stdClass();
3393         $pref->name   = 'email_send_count';
3394         $pref->value  = 1;
3395         $pref->userid = $user->id;
3396         $DB->insert_record('user_preferences', $pref, false);
3397     }
3400 /**
3401  * Increment or reset user's email bounce count
3402  *
3403  * @global object
3404  * @param user $user object containing an id
3405  * @param bool $reset will reset the count to 0
3406  */
3407 function set_bounce_count($user,$reset=false) {
3408     global $DB;
3410     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3411         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3412         $DB->update_record('user_preferences', $pref);
3413     }
3414     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3415         // make a new one
3416         $pref = new stdClass();
3417         $pref->name   = 'email_bounce_count';
3418         $pref->value  = 1;
3419         $pref->userid = $user->id;
3420         $DB->insert_record('user_preferences', $pref, false);
3421     }
3424 /**
3425  * Keeps track of login attempts
3426  *
3427  * @global object
3428  */
3429 function update_login_count() {
3430     global $SESSION;
3432     $max_logins = 10;
3434     if (empty($SESSION->logincount)) {
3435         $SESSION->logincount = 1;
3436     } else {
3437         $SESSION->logincount++;
3438     }
3440     if ($SESSION->logincount > $max_logins) {
3441         unset($SESSION->wantsurl);
3442         print_error('errortoomanylogins');
3443     }
3446 /**
3447  * Resets login attempts
3448  *
3449  * @global object
3450  */
3451 function reset_login_count() {
3452     global $SESSION;
3454     $SESSION->logincount = 0;
3457 /**
3458  * Determines if the currently logged in user is in editing mode.
3459  * Note: originally this function had $userid parameter - it was not usable anyway
3460  *
3461  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3462  * @todo Deprecated function remove when ready
3463  *
3464  * @global object
3465  * @uses DEBUG_DEVELOPER
3466  * @return bool
3467  */
3468 function isediting() {
3469     global $PAGE;
3470     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3471     return $PAGE->user_is_editing();
3474 /**
3475  * Determines if the logged in user is currently moving an activity
3476  *
3477  * @global object
3478  * @param int $courseid The id of the course being tested
3479  * @return bool
3480  */
3481 function ismoving($courseid) {
3482     global $USER;
3484     if (!empty($USER->activitycopy)) {
3485         return ($USER->activitycopycourse == $courseid);
3486     }
3487     return false;
3490 /**
3491  * Returns a persons full name
3492  *
3493  * Given an object containing firstname and lastname
3494  * values, this function returns a string with the
3495  * full name of the person.
3496  * The result may depend on system settings
3497  * or language.  'override' will force both names
3498  * to be used even if system settings specify one.
3499  *
3500  * @global object
3501  * @global object
3502  * @param object $user A {@link $USER} object to get full name of
3503  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3504  * @return string
3505  */
3506 function fullname($user, $override=false) {
3507     global $CFG, $SESSION;
3509     if (!isset($user->firstname) and !isset($user->lastname)) {
3510         return '';
3511     }
3513     if (!$override) {
3514         if (!empty($CFG->forcefirstname)) {
3515             $user->firstname = $CFG->forcefirstname;
3516         }
3517         if (!empty($CFG->forcelastname)) {
3518             $user->lastname = $CFG->forcelastname;
3519         }
3520     }
3522     if (!empty($SESSION->fullnamedisplay)) {
3523         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3524     }
3526     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3527         return $user->firstname .' '. $user->lastname;
3529     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3530         return $user->lastname .' '. $user->firstname;
3532     } else if ($CFG->fullnamedisplay == 'firstname') {
3533         if ($override) {
3534             return get_string('fullnamedisplay', '', $user);
3535         } else {
3536             return $user->firstname;
3537         }
3538     }
3540     return get_string('fullnamedisplay', '', $user);
3543 /**
3544  * Checks if current user is shown any extra fields when listing users.
3545  * @param object $context Context
3546  * @param array $already Array of fields that we're going to show anyway
3547  *   so don't bother listing them
3548  * @return array Array of field names from user table, not including anything
3549  *   listed in $already
3550  */
3551 function get_extra_user_fields($context, $already = array()) {
3552     global $CFG;
3554     // Only users with permission get the extra fields
3555     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3556         return array();
3557     }
3559     // Split showuseridentity on comma
3560     if (empty($CFG->showuseridentity)) {
3561         // Explode gives wrong result with empty string
3562         $extra = array();
3563     } else {
3564         $extra =  explode(',', $CFG->showuseridentity);
3565     }
3566     $renumber = false;
3567     foreach ($extra as $key => $field) {
3568         if (in_array($field, $already)) {
3569             unset($extra[$key]);
3570             $renumber = true;
3571         }
3572     }
3573     if ($renumber) {
3574         // For consistency, if entries are removed from array, renumber it
3575         // so they are numbered as you would expect
3576         $extra = array_merge($extra);
3577     }
3578     return $extra;
3581 /**
3582  * If the current user is to be shown extra user fields when listing or
3583  * selecting users, returns a string suitable for including in an SQL select
3584  * clause to retrieve those fields.
3585  * @param object $context Context
3586  * @param string $alias Alias of user table, e.g. 'u' (default none)
3587  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3588  * @param array $already Array of fields that we're going to include anyway
3589  *   so don't list them (default none)
3590  * @return string Partial SQL select clause, beginning with comma, for example
3591  *   ',u.idnumber,u.department' unless it is blank
3592  */
3593 function get_extra_user_fields_sql($context, $alias='', $prefix='',
3594         $already = array()) {
3595     $fields = get_extra_user_fields($context, $already);
3596     $result = '';
3597     // Add punctuation for alias
3598     if ($alias !== '') {
3599         $alias .= '.';
3600     }
3601     foreach ($fields as $field) {
3602         $result .= ', ' . $alias . $field;
3603         if ($prefix) {
3604             $result .= ' AS ' . $prefix . $field;
3605         }
3606     }
3607     return $result;
3610 /**
3611  * Returns the display name of a field in the user table. Works for most fields
3612  * that are commonly displayed to users.
3613  * @param string $field Field name, e.g. 'phone1'
3614  * @return string Text description taken from language file, e.g. 'Phone number'
3615  */
3616 function get_user_field_name($field) {
3617     // Some fields have language strings which are not the same as field name
3618     switch ($field) {
3619         case 'phone1' : return get_string('phone');
3620         case 'url' : return get_string('webpage');
3621         case 'icq' : return get_string('icqnumber');
3622         case 'skype' : return get_string('skypeid');
3623         case 'aim' : return get_string('aimid');
3624         case 'yahoo' : return get_string('yahooid');
3625         case 'msn' : return get_string('msnid');
3626     }
3627     // Otherwise just use the same lang string
3628     return get_string($field);
3631 /**
3632  * Returns whether a given authentication plugin exists.
3633  *
3634  * @global object
3635  * @param string $auth Form of authentication to check for. Defaults to the
3636  *        global setting in {@link $CFG}.
3637  * @return boolean Whether the plugin is available.
3638  */
3639 function exists_auth_plugin($auth) {
3640     global $CFG;
3642     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3643         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3644     }
3645     return false;
3648 /**
3649  * Checks if a given plugin is in the list of enabled authentication plugins.
3650  *
3651  * @param string $auth Authentication plugin.
3652  * @return boolean Whether the plugin is enabled.
3653  */
3654 function is_enabled_auth($auth) {
3655     if (empty($auth)) {
3656         return false;
3657     }
3659     $enabled = get_enabled_auth_plugins();
3661     return in_array($auth, $enabled);
3664 /**
3665  * Returns an authentication plugin instance.