f993bab402099981ef5d4e734b3043c80260707c
[moodle.git] / lib / moodlelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * moodlelib.php - Moodle main library
20  *
21  * Main library file of miscellaneous general-purpose Moodle functions.
22  * Other main libraries:
23  *  - weblib.php      - functions that produce web output
24  *  - datalib.php     - functions that access the database
25  *
26  * @package    core
27  * @subpackage lib
28  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
36 /// Date and time constants ///
37 /**
38  * Time constant - the number of seconds in a year
39  */
40 define('YEARSECS', 31536000);
42 /**
43  * Time constant - the number of seconds in a week
44  */
45 define('WEEKSECS', 604800);
47 /**
48  * Time constant - the number of seconds in a day
49  */
50 define('DAYSECS', 86400);
52 /**
53  * Time constant - the number of seconds in an hour
54  */
55 define('HOURSECS', 3600);
57 /**
58  * Time constant - the number of seconds in a minute
59  */
60 define('MINSECS', 60);
62 /**
63  * Time constant - the number of minutes in a day
64  */
65 define('DAYMINS', 1440);
67 /**
68  * Time constant - the number of minutes in an hour
69  */
70 define('HOURMINS', 60);
72 /// Parameter constants - every call to optional_param(), required_param()  ///
73 /// or clean_param() should have a specified type of parameter.  //////////////
77 /**
78  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
79  */
80 define('PARAM_ALPHA',    'alpha');
82 /**
83  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
84  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
85  */
86 define('PARAM_ALPHAEXT', 'alphaext');
88 /**
89  * PARAM_ALPHANUM - expected numbers and letters only.
90  */
91 define('PARAM_ALPHANUM', 'alphanum');
93 /**
94  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
95  */
96 define('PARAM_ALPHANUMEXT', 'alphanumext');
98 /**
99  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
100  */
101 define('PARAM_AUTH',  'auth');
103 /**
104  * PARAM_BASE64 - Base 64 encoded format
105  */
106 define('PARAM_BASE64',   'base64');
108 /**
109  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
110  */
111 define('PARAM_BOOL',     'bool');
113 /**
114  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
115  * checked against the list of capabilities in the database.
116  */
117 define('PARAM_CAPABILITY',   'capability');
119 /**
120  * PARAM_CLEANHTML - cleans submitted HTML code. use only for text in HTML format. This cleaning may fix xhtml strictness too.
121  */
122 define('PARAM_CLEANHTML', 'cleanhtml');
124 /**
125  * PARAM_EMAIL - an email address following the RFC
126  */
127 define('PARAM_EMAIL',   'email');
129 /**
130  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
131  */
132 define('PARAM_FILE',   'file');
134 /**
135  * PARAM_FLOAT - a real/floating point number.
136  */
137 define('PARAM_FLOAT',  'float');
139 /**
140  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
141  */
142 define('PARAM_HOST',     'host');
144 /**
145  * PARAM_INT - integers only, use when expecting only numbers.
146  */
147 define('PARAM_INT',      'int');
149 /**
150  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
151  */
152 define('PARAM_LANG',  'lang');
154 /**
155  * 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!)
156  */
157 define('PARAM_LOCALURL', 'localurl');
159 /**
160  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
161  */
162 define('PARAM_NOTAGS',   'notags');
164 /**
165  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
166  * note: the leading slash is not removed, window drive letter is not allowed
167  */
168 define('PARAM_PATH',     'path');
170 /**
171  * PARAM_PEM - Privacy Enhanced Mail format
172  */
173 define('PARAM_PEM',      'pem');
175 /**
176  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
177  */
178 define('PARAM_PERMISSION',   'permission');
180 /**
181  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
182  */
183 define('PARAM_RAW', 'raw');
185 /**
186  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
187  */
188 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
190 /**
191  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
192  */
193 define('PARAM_SAFEDIR',  'safedir');
195 /**
196  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
197  */
198 define('PARAM_SAFEPATH',  'safepath');
200 /**
201  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
202  */
203 define('PARAM_SEQUENCE',  'sequence');
205 /**
206  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
207  */
208 define('PARAM_TAG',   'tag');
210 /**
211  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
212  */
213 define('PARAM_TAGLIST',   'taglist');
215 /**
216  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
217  */
218 define('PARAM_TEXT',  'text');
220 /**
221  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
222  */
223 define('PARAM_THEME',  'theme');
225 /**
226  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
227  */
228 define('PARAM_URL',      'url');
230 /**
231  * 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!!
232  */
233 define('PARAM_USERNAME',    'username');
235 /**
236  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
237  */
238 define('PARAM_STRINGID',    'stringid');
240 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
241 /**
242  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
243  * It was one of the first types, that is why it is abused so much ;-)
244  * @deprecated since 2.0
245  */
246 define('PARAM_CLEAN',    'clean');
248 /**
249  * PARAM_INTEGER - deprecated alias for PARAM_INT
250  */
251 define('PARAM_INTEGER',  'int');
253 /**
254  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
255  */
256 define('PARAM_NUMBER',  'float');
258 /**
259  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
260  * NOTE: originally alias for PARAM_APLHA
261  */
262 define('PARAM_ACTION',   'alphanumext');
264 /**
265  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
266  * NOTE: originally alias for PARAM_APLHA
267  */
268 define('PARAM_FORMAT',   'alphanumext');
270 /**
271  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
272  */
273 define('PARAM_MULTILANG',  'text');
275 /**
276  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
277  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
278  * America/Port-au-Prince)
279  */
280 define('PARAM_TIMEZONE', 'timezone');
282 /**
283  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
284  */
285 define('PARAM_CLEANFILE', 'file');
287 /**
288  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
289  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
290  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
291  * NOTE: numbers and underscores are strongly discouraged in plugin names!
292  */
293 define('PARAM_COMPONENT', 'component');
295 /**
296  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
297  * It is usually used together with context id and component.
298  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
299  */
300 define('PARAM_AREA', 'area');
302 /**
303  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
304  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
305  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
306  */
307 define('PARAM_PLUGIN', 'plugin');
310 /// Web Services ///
312 /**
313  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
314  */
315 define('VALUE_REQUIRED', 1);
317 /**
318  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
319  */
320 define('VALUE_OPTIONAL', 2);
322 /**
323  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
324  */
325 define('VALUE_DEFAULT', 0);
327 /**
328  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
329  */
330 define('NULL_NOT_ALLOWED', false);
332 /**
333  * NULL_ALLOWED - the parameter can be set to null in the database
334  */
335 define('NULL_ALLOWED', true);
337 /// Page types ///
338 /**
339  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
340  */
341 define('PAGE_COURSE_VIEW', 'course-view');
343 /** Get remote addr constant */
344 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
345 /** Get remote addr constant */
346 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
348 /// Blog access level constant declaration ///
349 define ('BLOG_USER_LEVEL', 1);
350 define ('BLOG_GROUP_LEVEL', 2);
351 define ('BLOG_COURSE_LEVEL', 3);
352 define ('BLOG_SITE_LEVEL', 4);
353 define ('BLOG_GLOBAL_LEVEL', 5);
356 ///Tag constants///
357 /**
358  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
359  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
360  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
361  *
362  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
363  */
364 define('TAG_MAX_LENGTH', 50);
366 /// Password policy constants ///
367 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
368 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
369 define ('PASSWORD_DIGITS', '0123456789');
370 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
372 /// Feature constants ///
373 // Used for plugin_supports() to report features that are, or are not, supported by a module.
375 /** True if module can provide a grade */
376 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
377 /** True if module supports outcomes */
378 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
380 /** True if module has code to track whether somebody viewed it */
381 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
382 /** True if module has custom completion rules */
383 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
385 /** True if module has no 'view' page (like label) */
386 define('FEATURE_NO_VIEW_LINK', 'viewlink');
387 /** True if module supports outcomes */
388 define('FEATURE_IDNUMBER', 'idnumber');
389 /** True if module supports groups */
390 define('FEATURE_GROUPS', 'groups');
391 /** True if module supports groupings */
392 define('FEATURE_GROUPINGS', 'groupings');
393 /** True if module supports groupmembersonly */
394 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
396 /** Type of module */
397 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
398 /** True if module supports intro editor */
399 define('FEATURE_MOD_INTRO', 'mod_intro');
400 /** True if module has default completion */
401 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
403 define('FEATURE_COMMENT', 'comment');
405 define('FEATURE_RATE', 'rate');
406 /** True if module supports backup/restore of moodle2 format */
407 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
409 /** True if module can show description on course main page */
410 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
412 /** Unspecified module archetype */
413 define('MOD_ARCHETYPE_OTHER', 0);
414 /** Resource-like type module */
415 define('MOD_ARCHETYPE_RESOURCE', 1);
416 /** Assignment module archetype */
417 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
419 /**
420  * Security token used for allowing access
421  * from external application such as web services.
422  * Scripts do not use any session, performance is relatively
423  * low because we need to load access info in each request.
424  * Scripts are executed in parallel.
425  */
426 define('EXTERNAL_TOKEN_PERMANENT', 0);
428 /**
429  * Security token used for allowing access
430  * of embedded applications, the code is executed in the
431  * active user session. Token is invalidated after user logs out.
432  * Scripts are executed serially - normal session locking is used.
433  */
434 define('EXTERNAL_TOKEN_EMBEDDED', 1);
436 /**
437  * The home page should be the site home
438  */
439 define('HOMEPAGE_SITE', 0);
440 /**
441  * The home page should be the users my page
442  */
443 define('HOMEPAGE_MY', 1);
444 /**
445  * The home page can be chosen by the user
446  */
447 define('HOMEPAGE_USER', 2);
449 /**
450  * Hub directory url (should be moodle.org)
451  */
452 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
455 /**
456  * Moodle.org url (should be moodle.org)
457  */
458 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
460 /**
461  * Moodle mobile app service name
462  */
463 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
465 /// PARAMETER HANDLING ////////////////////////////////////////////////////
467 /**
468  * Returns a particular value for the named variable, taken from
469  * POST or GET.  If the parameter doesn't exist then an error is
470  * thrown because we require this variable.
471  *
472  * This function should be used to initialise all required values
473  * in a script that are based on parameters.  Usually it will be
474  * used like this:
475  *    $id = required_param('id', PARAM_INT);
476  *
477  * Please note the $type parameter is now required and the value can not be array.
478  *
479  * @param string $parname the name of the page parameter we want
480  * @param string $type expected type of parameter
481  * @return mixed
482  */
483 function required_param($parname, $type) {
484     if (func_num_args() != 2 or empty($parname) or empty($type)) {
485         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
486     }
487     if (isset($_POST[$parname])) {       // POST has precedence
488         $param = $_POST[$parname];
489     } else if (isset($_GET[$parname])) {
490         $param = $_GET[$parname];
491     } else {
492         print_error('missingparam', '', '', $parname);
493     }
495     if (is_array($param)) {
496         debugging('Invalid array parameter detected in required_param(): '.$parname);
497         // TODO: switch to fatal error in Moodle 2.3
498         //print_error('missingparam', '', '', $parname);
499         return required_param_array($parname, $type);
500     }
502     return clean_param($param, $type);
505 /**
506  * Returns a particular array value for the named variable, taken from
507  * POST or GET.  If the parameter doesn't exist then an error is
508  * thrown because we require this variable.
509  *
510  * This function should be used to initialise all required values
511  * in a script that are based on parameters.  Usually it will be
512  * used like this:
513  *    $ids = required_param_array('ids', PARAM_INT);
514  *
515  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
516  *
517  * @param string $parname the name of the page parameter we want
518  * @param string $type expected type of parameter
519  * @return array
520  */
521 function required_param_array($parname, $type) {
522     if (func_num_args() != 2 or empty($parname) or empty($type)) {
523         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
524     }
525     if (isset($_POST[$parname])) {       // POST has precedence
526         $param = $_POST[$parname];
527     } else if (isset($_GET[$parname])) {
528         $param = $_GET[$parname];
529     } else {
530         print_error('missingparam', '', '', $parname);
531     }
532     if (!is_array($param)) {
533         print_error('missingparam', '', '', $parname);
534     }
536     $result = array();
537     foreach($param as $key=>$value) {
538         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
539             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
540             continue;
541         }
542         $result[$key] = clean_param($value, $type);
543     }
545     return $result;
548 /**
549  * Returns a particular value for the named variable, taken from
550  * POST or GET, otherwise returning a given default.
551  *
552  * This function should be used to initialise all optional values
553  * in a script that are based on parameters.  Usually it will be
554  * used like this:
555  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
556  *
557  * Please note the $type parameter is now required and the value can not be array.
558  *
559  * @param string $parname the name of the page parameter we want
560  * @param mixed  $default the default value to return if nothing is found
561  * @param string $type expected type of parameter
562  * @return mixed
563  */
564 function optional_param($parname, $default, $type) {
565     if (func_num_args() != 3 or empty($parname) or empty($type)) {
566         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
567     }
568     if (!isset($default)) {
569         $default = null;
570     }
572     if (isset($_POST[$parname])) {       // POST has precedence
573         $param = $_POST[$parname];
574     } else if (isset($_GET[$parname])) {
575         $param = $_GET[$parname];
576     } else {
577         return $default;
578     }
580     if (is_array($param)) {
581         debugging('Invalid array parameter detected in required_param(): '.$parname);
582         // TODO: switch to $default in Moodle 2.3
583         //return $default;
584         return optional_param_array($parname, $default, $type);
585     }
587     return clean_param($param, $type);
590 /**
591  * Returns a particular array value for the named variable, taken from
592  * POST or GET, otherwise returning a given default.
593  *
594  * This function should be used to initialise all optional values
595  * in a script that are based on parameters.  Usually it will be
596  * used like this:
597  *    $ids = optional_param('id', array(), PARAM_INT);
598  *
599  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
600  *
601  * @param string $parname the name of the page parameter we want
602  * @param mixed  $default the default value to return if nothing is found
603  * @param string $type expected type of parameter
604  * @return array
605  */
606 function optional_param_array($parname, $default, $type) {
607     if (func_num_args() != 3 or empty($parname) or empty($type)) {
608         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
609     }
611     if (isset($_POST[$parname])) {       // POST has precedence
612         $param = $_POST[$parname];
613     } else if (isset($_GET[$parname])) {
614         $param = $_GET[$parname];
615     } else {
616         return $default;
617     }
618     if (!is_array($param)) {
619         debugging('optional_param_array() expects array parameters only: '.$parname);
620         return $default;
621     }
623     $result = array();
624     foreach($param as $key=>$value) {
625         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
626             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
627             continue;
628         }
629         $result[$key] = clean_param($value, $type);
630     }
632     return $result;
635 /**
636  * Strict validation of parameter values, the values are only converted
637  * to requested PHP type. Internally it is using clean_param, the values
638  * before and after cleaning must be equal - otherwise
639  * an invalid_parameter_exception is thrown.
640  * Objects and classes are not accepted.
641  *
642  * @param mixed $param
643  * @param string $type PARAM_ constant
644  * @param bool $allownull are nulls valid value?
645  * @param string $debuginfo optional debug information
646  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
647  */
648 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
649     if (is_null($param)) {
650         if ($allownull == NULL_ALLOWED) {
651             return null;
652         } else {
653             throw new invalid_parameter_exception($debuginfo);
654         }
655     }
656     if (is_array($param) or is_object($param)) {
657         throw new invalid_parameter_exception($debuginfo);
658     }
660     $cleaned = clean_param($param, $type);
661     if ((string)$param !== (string)$cleaned) {
662         // conversion to string is usually lossless
663         throw new invalid_parameter_exception($debuginfo);
664     }
666     return $cleaned;
669 /**
670  * Makes sure array contains only the allowed types,
671  * this function does not validate array key names!
672  * <code>
673  * $options = clean_param($options, PARAM_INT);
674  * </code>
675  *
676  * @param array $param the variable array we are cleaning
677  * @param string $type expected format of param after cleaning.
678  * @param bool $recursive clean recursive arrays
679  * @return array
680  */
681 function clean_param_array(array $param = null, $type, $recursive = false) {
682     $param = (array)$param; // convert null to empty array
683     foreach ($param as $key => $value) {
684         if (is_array($value)) {
685             if ($recursive) {
686                 $param[$key] = clean_param_array($value, $type, true);
687             } else {
688                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
689             }
690         } else {
691             $param[$key] = clean_param($value, $type);
692         }
693     }
694     return $param;
697 /**
698  * Used by {@link optional_param()} and {@link required_param()} to
699  * clean the variables and/or cast to specific types, based on
700  * an options field.
701  * <code>
702  * $course->format = clean_param($course->format, PARAM_ALPHA);
703  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
704  * </code>
705  *
706  * @param mixed $param the variable we are cleaning
707  * @param string $type expected format of param after cleaning.
708  * @return mixed
709  */
710 function clean_param($param, $type) {
712     global $CFG;
714     if (is_array($param)) {
715         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
716     } else if (is_object($param)) {
717         if (method_exists($param, '__toString')) {
718             $param = $param->__toString();
719         } else {
720             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
721         }
722     }
724     switch ($type) {
725         case PARAM_RAW:          // no cleaning at all
726             $param = fix_utf8($param);
727             return $param;
729         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
730             $param = fix_utf8($param);
731             return trim($param);
733         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
734             // this is deprecated!, please use more specific type instead
735             if (is_numeric($param)) {
736                 return $param;
737             }
738             $param = fix_utf8($param);
739             return clean_text($param);     // Sweep for scripts, etc
741         case PARAM_CLEANHTML:    // clean html fragment
742             $param = fix_utf8($param);
743             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
744             return trim($param);
746         case PARAM_INT:
747             return (int)$param;  // Convert to integer
749         case PARAM_FLOAT:
750         case PARAM_NUMBER:
751             return (float)$param;  // Convert to float
753         case PARAM_ALPHA:        // Remove everything not a-z
754             return preg_replace('/[^a-zA-Z]/i', '', $param);
756         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
757             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
759         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
760             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
762         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
763             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
765         case PARAM_SEQUENCE:     // Remove everything not 0-9,
766             return preg_replace('/[^0-9,]/i', '', $param);
768         case PARAM_BOOL:         // Convert to 1 or 0
769             $tempstr = strtolower($param);
770             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
771                 $param = 1;
772             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
773                 $param = 0;
774             } else {
775                 $param = empty($param) ? 0 : 1;
776             }
777             return $param;
779         case PARAM_NOTAGS:       // Strip all tags
780             $param = fix_utf8($param);
781             return strip_tags($param);
783         case PARAM_TEXT:    // leave only tags needed for multilang
784             $param = fix_utf8($param);
785             // if the multilang syntax is not correct we strip all tags
786             // because it would break xhtml strict which is required for accessibility standards
787             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
788             do {
789                 if (strpos($param, '</lang>') !== false) {
790                     // old and future mutilang syntax
791                     $param = strip_tags($param, '<lang>');
792                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
793                         break;
794                     }
795                     $open = false;
796                     foreach ($matches[0] as $match) {
797                         if ($match === '</lang>') {
798                             if ($open) {
799                                 $open = false;
800                                 continue;
801                             } else {
802                                 break 2;
803                             }
804                         }
805                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
806                             break 2;
807                         } else {
808                             $open = true;
809                         }
810                     }
811                     if ($open) {
812                         break;
813                     }
814                     return $param;
816                 } else if (strpos($param, '</span>') !== false) {
817                     // current problematic multilang syntax
818                     $param = strip_tags($param, '<span>');
819                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
820                         break;
821                     }
822                     $open = false;
823                     foreach ($matches[0] as $match) {
824                         if ($match === '</span>') {
825                             if ($open) {
826                                 $open = false;
827                                 continue;
828                             } else {
829                                 break 2;
830                             }
831                         }
832                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
833                             break 2;
834                         } else {
835                             $open = true;
836                         }
837                     }
838                     if ($open) {
839                         break;
840                     }
841                     return $param;
842                 }
843             } while (false);
844             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
845             return strip_tags($param);
847         case PARAM_COMPONENT:
848             // we do not want any guessing here, either the name is correct or not
849             // please note only normalised component names are accepted
850             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
851                 return '';
852             }
853             if (strpos($param, '__') !== false) {
854                 return '';
855             }
856             if (strpos($param, 'mod_') === 0) {
857                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
858                 if (substr_count($param, '_') != 1) {
859                     return '';
860                 }
861             }
862             return $param;
864         case PARAM_PLUGIN:
865         case PARAM_AREA:
866             // we do not want any guessing here, either the name is correct or not
867             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
868                 return '';
869             }
870             if (strpos($param, '__') !== false) {
871                 return '';
872             }
873             return $param;
875         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
876             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
878         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
879             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
881         case PARAM_FILE:         // Strip all suspicious characters from filename
882             $param = fix_utf8($param);
883             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
884             $param = preg_replace('~\.\.+~', '', $param);
885             if ($param === '.') {
886                 $param = '';
887             }
888             return $param;
890         case PARAM_PATH:         // Strip all suspicious characters from file path
891             $param = fix_utf8($param);
892             $param = str_replace('\\', '/', $param);
893             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
894             $param = preg_replace('~\.\.+~', '', $param);
895             $param = preg_replace('~//+~', '/', $param);
896             return preg_replace('~/(\./)+~', '/', $param);
898         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
899             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
900             // match ipv4 dotted quad
901             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
902                 // confirm values are ok
903                 if ( $match[0] > 255
904                      || $match[1] > 255
905                      || $match[3] > 255
906                      || $match[4] > 255 ) {
907                     // hmmm, what kind of dotted quad is this?
908                     $param = '';
909                 }
910             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
911                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
912                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
913                        ) {
914                 // all is ok - $param is respected
915             } else {
916                 // all is not ok...
917                 $param='';
918             }
919             return $param;
921         case PARAM_URL:          // allow safe ftp, http, mailto urls
922             $param = fix_utf8($param);
923             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
924             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
925                 // all is ok, param is respected
926             } else {
927                 $param =''; // not really ok
928             }
929             return $param;
931         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
932             $param = clean_param($param, PARAM_URL);
933             if (!empty($param)) {
934                 if (preg_match(':^/:', $param)) {
935                     // root-relative, ok!
936                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
937                     // absolute, and matches our wwwroot
938                 } else {
939                     // relative - let's make sure there are no tricks
940                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
941                         // looks ok.
942                     } else {
943                         $param = '';
944                     }
945                 }
946             }
947             return $param;
949         case PARAM_PEM:
950             $param = trim($param);
951             // PEM formatted strings may contain letters/numbers and the symbols
952             // forward slash: /
953             // plus sign:     +
954             // equal sign:    =
955             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
956             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
957                 list($wholething, $body) = $matches;
958                 unset($wholething, $matches);
959                 $b64 = clean_param($body, PARAM_BASE64);
960                 if (!empty($b64)) {
961                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
962                 } else {
963                     return '';
964                 }
965             }
966             return '';
968         case PARAM_BASE64:
969             if (!empty($param)) {
970                 // PEM formatted strings may contain letters/numbers and the symbols
971                 // forward slash: /
972                 // plus sign:     +
973                 // equal sign:    =
974                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
975                     return '';
976                 }
977                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
978                 // Each line of base64 encoded data must be 64 characters in
979                 // length, except for the last line which may be less than (or
980                 // equal to) 64 characters long.
981                 for ($i=0, $j=count($lines); $i < $j; $i++) {
982                     if ($i + 1 == $j) {
983                         if (64 < strlen($lines[$i])) {
984                             return '';
985                         }
986                         continue;
987                     }
989                     if (64 != strlen($lines[$i])) {
990                         return '';
991                     }
992                 }
993                 return implode("\n",$lines);
994             } else {
995                 return '';
996             }
998         case PARAM_TAG:
999             $param = fix_utf8($param);
1000             // Please note it is not safe to use the tag name directly anywhere,
1001             // it must be processed with s(), urlencode() before embedding anywhere.
1002             // remove some nasties
1003             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1004             //convert many whitespace chars into one
1005             $param = preg_replace('/\s+/', ' ', $param);
1006             $textlib = textlib_get_instance();
1007             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
1008             return $param;
1010         case PARAM_TAGLIST:
1011             $param = fix_utf8($param);
1012             $tags = explode(',', $param);
1013             $result = array();
1014             foreach ($tags as $tag) {
1015                 $res = clean_param($tag, PARAM_TAG);
1016                 if ($res !== '') {
1017                     $result[] = $res;
1018                 }
1019             }
1020             if ($result) {
1021                 return implode(',', $result);
1022             } else {
1023                 return '';
1024             }
1026         case PARAM_CAPABILITY:
1027             if (get_capability_info($param)) {
1028                 return $param;
1029             } else {
1030                 return '';
1031             }
1033         case PARAM_PERMISSION:
1034             $param = (int)$param;
1035             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1036                 return $param;
1037             } else {
1038                 return CAP_INHERIT;
1039             }
1041         case PARAM_AUTH:
1042             $param = clean_param($param, PARAM_PLUGIN);
1043             if (empty($param)) {
1044                 return '';
1045             } else if (exists_auth_plugin($param)) {
1046                 return $param;
1047             } else {
1048                 return '';
1049             }
1051         case PARAM_LANG:
1052             $param = clean_param($param, PARAM_SAFEDIR);
1053             if (get_string_manager()->translation_exists($param)) {
1054                 return $param;
1055             } else {
1056                 return ''; // Specified language is not installed or param malformed
1057             }
1059         case PARAM_THEME:
1060             $param = clean_param($param, PARAM_PLUGIN);
1061             if (empty($param)) {
1062                 return '';
1063             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1064                 return $param;
1065             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1066                 return $param;
1067             } else {
1068                 return '';  // Specified theme is not installed
1069             }
1071         case PARAM_USERNAME:
1072             $param = fix_utf8($param);
1073             $param = str_replace(" " , "", $param);
1074             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
1075             if (empty($CFG->extendedusernamechars)) {
1076                 // regular expression, eliminate all chars EXCEPT:
1077                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1078                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1079             }
1080             return $param;
1082         case PARAM_EMAIL:
1083             $param = fix_utf8($param);
1084             if (validate_email($param)) {
1085                 return $param;
1086             } else {
1087                 return '';
1088             }
1090         case PARAM_STRINGID:
1091             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1092                 return $param;
1093             } else {
1094                 return '';
1095             }
1097         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1098             $param = fix_utf8($param);
1099             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3]|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1100             if (preg_match($timezonepattern, $param)) {
1101                 return $param;
1102             } else {
1103                 return '';
1104             }
1106         default:                 // throw error, switched parameters in optional_param or another serious problem
1107             print_error("unknownparamtype", '', '', $type);
1108     }
1111 /**
1112  * Makes sure the data is using valid utf8, invalid characters are discarded.
1113  *
1114  * Note: this function is not intended for full objects with methods and private properties.
1115  *
1116  * @param mixed $value
1117  * @return mixed with proper utf-8 encoding
1118  */
1119 function fix_utf8($value) {
1120     if (is_null($value) or $value === '') {
1121         return $value;
1123     } else if (is_string($value)) {
1124         if ((string)(int)$value === $value) {
1125             // shortcut
1126             return $value;
1127         }
1128         return iconv('UTF-8', 'UTF-8//IGNORE', $value);
1130     } else if (is_array($value)) {
1131         foreach ($value as $k=>$v) {
1132             $value[$k] = fix_utf8($v);
1133         }
1134         return $value;
1136     } else if (is_object($value)) {
1137         $value = clone($value); // do not modify original
1138         foreach ($value as $k=>$v) {
1139             $value->$k = fix_utf8($v);
1140         }
1141         return $value;
1143     } else {
1144         // this is some other type, no utf-8 here
1145         return $value;
1146     }
1149 /**
1150  * Return true if given value is integer or string with integer value
1151  *
1152  * @param mixed $value String or Int
1153  * @return bool true if number, false if not
1154  */
1155 function is_number($value) {
1156     if (is_int($value)) {
1157         return true;
1158     } else if (is_string($value)) {
1159         return ((string)(int)$value) === $value;
1160     } else {
1161         return false;
1162     }
1165 /**
1166  * Returns host part from url
1167  * @param string $url full url
1168  * @return string host, null if not found
1169  */
1170 function get_host_from_url($url) {
1171     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1172     if ($matches) {
1173         return $matches[1];
1174     }
1175     return null;
1178 /**
1179  * Tests whether anything was returned by text editor
1180  *
1181  * This function is useful for testing whether something you got back from
1182  * the HTML editor actually contains anything. Sometimes the HTML editor
1183  * appear to be empty, but actually you get back a <br> tag or something.
1184  *
1185  * @param string $string a string containing HTML.
1186  * @return boolean does the string contain any actual content - that is text,
1187  * images, objects, etc.
1188  */
1189 function html_is_blank($string) {
1190     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1193 /**
1194  * Set a key in global configuration
1195  *
1196  * Set a key/value pair in both this session's {@link $CFG} global variable
1197  * and in the 'config' database table for future sessions.
1198  *
1199  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1200  * In that case it doesn't affect $CFG.
1201  *
1202  * A NULL value will delete the entry.
1203  *
1204  * @global object
1205  * @global object
1206  * @param string $name the key to set
1207  * @param string $value the value to set (without magic quotes)
1208  * @param string $plugin (optional) the plugin scope, default NULL
1209  * @return bool true or exception
1210  */
1211 function set_config($name, $value, $plugin=NULL) {
1212     global $CFG, $DB;
1214     if (empty($plugin)) {
1215         if (!array_key_exists($name, $CFG->config_php_settings)) {
1216             // So it's defined for this invocation at least
1217             if (is_null($value)) {
1218                 unset($CFG->$name);
1219             } else {
1220                 $CFG->$name = (string)$value; // settings from db are always strings
1221             }
1222         }
1224         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1225             if ($value === null) {
1226                 $DB->delete_records('config', array('name'=>$name));
1227             } else {
1228                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1229             }
1230         } else {
1231             if ($value !== null) {
1232                 $config = new stdClass();
1233                 $config->name  = $name;
1234                 $config->value = $value;
1235                 $DB->insert_record('config', $config, false);
1236             }
1237         }
1239     } else { // plugin scope
1240         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1241             if ($value===null) {
1242                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1243             } else {
1244                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1245             }
1246         } else {
1247             if ($value !== null) {
1248                 $config = new stdClass();
1249                 $config->plugin = $plugin;
1250                 $config->name   = $name;
1251                 $config->value  = $value;
1252                 $DB->insert_record('config_plugins', $config, false);
1253             }
1254         }
1255     }
1257     return true;
1260 /**
1261  * Get configuration values from the global config table
1262  * or the config_plugins table.
1263  *
1264  * If called with one parameter, it will load all the config
1265  * variables for one plugin, and return them as an object.
1266  *
1267  * If called with 2 parameters it will return a string single
1268  * value or false if the value is not found.
1269  *
1270  * @param string $plugin full component name
1271  * @param string $name default NULL
1272  * @return mixed hash-like object or single value, return false no config found
1273  */
1274 function get_config($plugin, $name = NULL) {
1275     global $CFG, $DB;
1277     // normalise component name
1278     if ($plugin === 'moodle' or $plugin === 'core') {
1279         $plugin = NULL;
1280     }
1282     if (!empty($name)) { // the user is asking for a specific value
1283         if (!empty($plugin)) {
1284             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1285                 // setting forced in config file
1286                 return $CFG->forced_plugin_settings[$plugin][$name];
1287             } else {
1288                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1289             }
1290         } else {
1291             if (array_key_exists($name, $CFG->config_php_settings)) {
1292                 // setting force in config file
1293                 return $CFG->config_php_settings[$name];
1294             } else {
1295                 return $DB->get_field('config', 'value', array('name'=>$name));
1296             }
1297         }
1298     }
1300     // the user is after a recordset
1301     if ($plugin) {
1302         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1303         if (isset($CFG->forced_plugin_settings[$plugin])) {
1304             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1305                 if (is_null($v) or is_array($v) or is_object($v)) {
1306                     // we do not want any extra mess here, just real settings that could be saved in db
1307                     unset($localcfg[$n]);
1308                 } else {
1309                     //convert to string as if it went through the DB
1310                     $localcfg[$n] = (string)$v;
1311                 }
1312             }
1313         }
1314         if ($localcfg) {
1315             return (object)$localcfg;
1316         } else {
1317             return null;
1318         }
1320     } else {
1321         // this part is not really used any more, but anyway...
1322         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1323         foreach($CFG->config_php_settings as $n=>$v) {
1324             if (is_null($v) or is_array($v) or is_object($v)) {
1325                 // we do not want any extra mess here, just real settings that could be saved in db
1326                 unset($localcfg[$n]);
1327             } else {
1328                 //convert to string as if it went through the DB
1329                 $localcfg[$n] = (string)$v;
1330             }
1331         }
1332         return (object)$localcfg;
1333     }
1336 /**
1337  * Removes a key from global configuration
1338  *
1339  * @param string $name the key to set
1340  * @param string $plugin (optional) the plugin scope
1341  * @global object
1342  * @return boolean whether the operation succeeded.
1343  */
1344 function unset_config($name, $plugin=NULL) {
1345     global $CFG, $DB;
1347     if (empty($plugin)) {
1348         unset($CFG->$name);
1349         $DB->delete_records('config', array('name'=>$name));
1350     } else {
1351         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1352     }
1354     return true;
1357 /**
1358  * Remove all the config variables for a given plugin.
1359  *
1360  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1361  * @return boolean whether the operation succeeded.
1362  */
1363 function unset_all_config_for_plugin($plugin) {
1364     global $DB;
1365     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1366     $like = $DB->sql_like('name', '?', true, true, false, '|');
1367     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1368     $DB->delete_records_select('config', $like, $params);
1369     return true;
1372 /**
1373  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1374  *
1375  * All users are verified if they still have the necessary capability.
1376  *
1377  * @param string $value the value of the config setting.
1378  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1379  * @param bool $include admins, include administrators
1380  * @return array of user objects.
1381  */
1382 function get_users_from_config($value, $capability, $includeadmins = true) {
1383     global $CFG, $DB;
1385     if (empty($value) or $value === '$@NONE@$') {
1386         return array();
1387     }
1389     // we have to make sure that users still have the necessary capability,
1390     // it should be faster to fetch them all first and then test if they are present
1391     // instead of validating them one-by-one
1392     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1393     if ($includeadmins) {
1394         $admins = get_admins();
1395         foreach ($admins as $admin) {
1396             $users[$admin->id] = $admin;
1397         }
1398     }
1400     if ($value === '$@ALL@$') {
1401         return $users;
1402     }
1404     $result = array(); // result in correct order
1405     $allowed = explode(',', $value);
1406     foreach ($allowed as $uid) {
1407         if (isset($users[$uid])) {
1408             $user = $users[$uid];
1409             $result[$user->id] = $user;
1410         }
1411     }
1413     return $result;
1417 /**
1418  * Invalidates browser caches and cached data in temp
1419  * @return void
1420  */
1421 function purge_all_caches() {
1422     global $CFG;
1424     reset_text_filters_cache();
1425     js_reset_all_caches();
1426     theme_reset_all_caches();
1427     get_string_manager()->reset_caches();
1429     // purge all other caches: rss, simplepie, etc.
1430     remove_dir($CFG->cachedir.'', true);
1432     // make sure cache dir is writable, throws exception if not
1433     make_cache_directory('');
1435     // hack: this script may get called after the purifier was initialised,
1436     // but we do not want to verify repeatedly this exists in each call
1437     make_cache_directory('htmlpurifier');
1439     clearstatcache();
1442 /**
1443  * Get volatile flags
1444  *
1445  * @param string $type
1446  * @param int    $changedsince default null
1447  * @return records array
1448  */
1449 function get_cache_flags($type, $changedsince=NULL) {
1450     global $DB;
1452     $params = array('type'=>$type, 'expiry'=>time());
1453     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1454     if ($changedsince !== NULL) {
1455         $params['changedsince'] = $changedsince;
1456         $sqlwhere .= " AND timemodified > :changedsince";
1457     }
1458     $cf = array();
1460     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1461         foreach ($flags as $flag) {
1462             $cf[$flag->name] = $flag->value;
1463         }
1464     }
1465     return $cf;
1468 /**
1469  * Get volatile flags
1470  *
1471  * @param string $type
1472  * @param string $name
1473  * @param int    $changedsince default null
1474  * @return records array
1475  */
1476 function get_cache_flag($type, $name, $changedsince=NULL) {
1477     global $DB;
1479     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1481     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1482     if ($changedsince !== NULL) {
1483         $params['changedsince'] = $changedsince;
1484         $sqlwhere .= " AND timemodified > :changedsince";
1485     }
1487     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1490 /**
1491  * Set a volatile flag
1492  *
1493  * @param string $type the "type" namespace for the key
1494  * @param string $name the key to set
1495  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1496  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1497  * @return bool Always returns true
1498  */
1499 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1500     global $DB;
1502     $timemodified = time();
1503     if ($expiry===NULL || $expiry < $timemodified) {
1504         $expiry = $timemodified + 24 * 60 * 60;
1505     } else {
1506         $expiry = (int)$expiry;
1507     }
1509     if ($value === NULL) {
1510         unset_cache_flag($type,$name);
1511         return true;
1512     }
1514     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1515         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1516             return true; //no need to update; helps rcache too
1517         }
1518         $f->value        = $value;
1519         $f->expiry       = $expiry;
1520         $f->timemodified = $timemodified;
1521         $DB->update_record('cache_flags', $f);
1522     } else {
1523         $f = new stdClass();
1524         $f->flagtype     = $type;
1525         $f->name         = $name;
1526         $f->value        = $value;
1527         $f->expiry       = $expiry;
1528         $f->timemodified = $timemodified;
1529         $DB->insert_record('cache_flags', $f);
1530     }
1531     return true;
1534 /**
1535  * Removes a single volatile flag
1536  *
1537  * @global object
1538  * @param string $type the "type" namespace for the key
1539  * @param string $name the key to set
1540  * @return bool
1541  */
1542 function unset_cache_flag($type, $name) {
1543     global $DB;
1544     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1545     return true;
1548 /**
1549  * Garbage-collect volatile flags
1550  *
1551  * @return bool Always returns true
1552  */
1553 function gc_cache_flags() {
1554     global $DB;
1555     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1556     return true;
1559 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1561 /**
1562  * Refresh user preference cache. This is used most often for $USER
1563  * object that is stored in session, but it also helps with performance in cron script.
1564  *
1565  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1566  *
1567  * @param stdClass $user user object, preferences are preloaded into ->preference property
1568  * @param int $cachelifetime cache life time on the current page (ins seconds)
1569  * @return void
1570  */
1571 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1572     global $DB;
1573     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1575     if (!isset($user->id)) {
1576         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1577     }
1579     if (empty($user->id) or isguestuser($user->id)) {
1580         // No permanent storage for not-logged-in users and guest
1581         if (!isset($user->preference)) {
1582             $user->preference = array();
1583         }
1584         return;
1585     }
1587     $timenow = time();
1589     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1590         // Already loaded at least once on this page. Are we up to date?
1591         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1592             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1593             return;
1595         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1596             // no change since the lastcheck on this page
1597             $user->preference['_lastloaded'] = $timenow;
1598             return;
1599         }
1600     }
1602     // OK, so we have to reload all preferences
1603     $loadedusers[$user->id] = true;
1604     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1605     $user->preference['_lastloaded'] = $timenow;
1608 /**
1609  * Called from set/delete_user_preferences, so that the prefs can
1610  * be correctly reloaded in different sessions.
1611  *
1612  * NOTE: internal function, do not call from other code.
1613  *
1614  * @param integer $userid the user whose prefs were changed.
1615  * @return void
1616  */
1617 function mark_user_preferences_changed($userid) {
1618     global $CFG;
1620     if (empty($userid) or isguestuser($userid)) {
1621         // no cache flags for guest and not-logged-in users
1622         return;
1623     }
1625     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1628 /**
1629  * Sets a preference for the specified user.
1630  *
1631  * If user object submitted, 'preference' property contains the preferences cache.
1632  *
1633  * @param string $name The key to set as preference for the specified user
1634  * @param string $value The value to set for the $name key in the specified user's record,
1635  *                      null means delete current value
1636  * @param stdClass|int $user A moodle user object or id, null means current user
1637  * @return bool always true or exception
1638  */
1639 function set_user_preference($name, $value, $user = null) {
1640     global $USER, $DB;
1642     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1643         throw new coding_exception('Invalid preference name in set_user_preference() call');
1644     }
1646     if (is_null($value)) {
1647         // null means delete current
1648         return unset_user_preference($name, $user);
1649     } else if (is_object($value)) {
1650         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1651     } else if (is_array($value)) {
1652         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1653     }
1654     $value = (string)$value;
1656     if (is_null($user)) {
1657         $user = $USER;
1658     } else if (isset($user->id)) {
1659         // $user is valid object
1660     } else if (is_numeric($user)) {
1661         $user = (object)array('id'=>(int)$user);
1662     } else {
1663         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1664     }
1666     check_user_preferences_loaded($user);
1668     if (empty($user->id) or isguestuser($user->id)) {
1669         // no permanent storage for not-logged-in users and guest
1670         $user->preference[$name] = $value;
1671         return true;
1672     }
1674     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1675         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1676             // preference already set to this value
1677             return true;
1678         }
1679         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1681     } else {
1682         $preference = new stdClass();
1683         $preference->userid = $user->id;
1684         $preference->name   = $name;
1685         $preference->value  = $value;
1686         $DB->insert_record('user_preferences', $preference);
1687     }
1689     // update value in cache
1690     $user->preference[$name] = $value;
1692     // set reload flag for other sessions
1693     mark_user_preferences_changed($user->id);
1695     return true;
1698 /**
1699  * Sets a whole array of preferences for the current user
1700  *
1701  * If user object submitted, 'preference' property contains the preferences cache.
1702  *
1703  * @param array $prefarray An array of key/value pairs to be set
1704  * @param stdClass|int $user A moodle user object or id, null means current user
1705  * @return bool always true or exception
1706  */
1707 function set_user_preferences(array $prefarray, $user = null) {
1708     foreach ($prefarray as $name => $value) {
1709         set_user_preference($name, $value, $user);
1710     }
1711     return true;
1714 /**
1715  * Unsets a preference completely by deleting it from the database
1716  *
1717  * If user object submitted, 'preference' property contains the preferences cache.
1718  *
1719  * @param string  $name The key to unset as preference for the specified user
1720  * @param stdClass|int $user A moodle user object or id, null means current user
1721  * @return bool always true or exception
1722  */
1723 function unset_user_preference($name, $user = null) {
1724     global $USER, $DB;
1726     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1727         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1728     }
1730     if (is_null($user)) {
1731         $user = $USER;
1732     } else if (isset($user->id)) {
1733         // $user is valid object
1734     } else if (is_numeric($user)) {
1735         $user = (object)array('id'=>(int)$user);
1736     } else {
1737         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1738     }
1740     check_user_preferences_loaded($user);
1742     if (empty($user->id) or isguestuser($user->id)) {
1743         // no permanent storage for not-logged-in user and guest
1744         unset($user->preference[$name]);
1745         return true;
1746     }
1748     // delete from DB
1749     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1751     // delete the preference from cache
1752     unset($user->preference[$name]);
1754     // set reload flag for other sessions
1755     mark_user_preferences_changed($user->id);
1757     return true;
1760 /**
1761  * Used to fetch user preference(s)
1762  *
1763  * If no arguments are supplied this function will return
1764  * all of the current user preferences as an array.
1765  *
1766  * If a name is specified then this function
1767  * attempts to return that particular preference value.  If
1768  * none is found, then the optional value $default is returned,
1769  * otherwise NULL.
1770  *
1771  * If user object submitted, 'preference' property contains the preferences cache.
1772  *
1773  * @param string $name Name of the key to use in finding a preference value
1774  * @param mixed $default Value to be returned if the $name key is not set in the user preferences
1775  * @param stdClass|int $user A moodle user object or id, null means current user
1776  * @return mixed string value or default
1777  */
1778 function get_user_preferences($name = null, $default = null, $user = null) {
1779     global $USER;
1781     if (is_null($name)) {
1782         // all prefs
1783     } else if (is_numeric($name) or $name === '_lastloaded') {
1784         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1785     }
1787     if (is_null($user)) {
1788         $user = $USER;
1789     } else if (isset($user->id)) {
1790         // $user is valid object
1791     } else if (is_numeric($user)) {
1792         $user = (object)array('id'=>(int)$user);
1793     } else {
1794         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1795     }
1797     check_user_preferences_loaded($user);
1799     if (empty($name)) {
1800         return $user->preference; // All values
1801     } else if (isset($user->preference[$name])) {
1802         return $user->preference[$name]; // The single string value
1803     } else {
1804         return $default; // Default value (null if not specified)
1805     }
1808 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1810 /**
1811  * Given date parts in user time produce a GMT timestamp.
1812  *
1813  * @todo Finish documenting this function
1814  * @param int $year The year part to create timestamp of
1815  * @param int $month The month part to create timestamp of
1816  * @param int $day The day part to create timestamp of
1817  * @param int $hour The hour part to create timestamp of
1818  * @param int $minute The minute part to create timestamp of
1819  * @param int $second The second part to create timestamp of
1820  * @param mixed $timezone Timezone modifier, if 99 then use default user's timezone
1821  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1822  *             applied only if timezone is 99 or string.
1823  * @return int timestamp
1824  */
1825 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1827     //save input timezone, required for dst offset check.
1828     $passedtimezone = $timezone;
1830     $timezone = get_user_timezone_offset($timezone);
1832     if (abs($timezone) > 13) {  //server time
1833         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1834     } else {
1835         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1836         $time = usertime($time, $timezone);
1838         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1839         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1840             $time -= dst_offset_on($time, $passedtimezone);
1841         }
1842     }
1844     return $time;
1848 /**
1849  * Format a date/time (seconds) as weeks, days, hours etc as needed
1850  *
1851  * Given an amount of time in seconds, returns string
1852  * formatted nicely as weeks, days, hours etc as needed
1853  *
1854  * @uses MINSECS
1855  * @uses HOURSECS
1856  * @uses DAYSECS
1857  * @uses YEARSECS
1858  * @param int $totalsecs Time in seconds
1859  * @param object $str Should be a time object
1860  * @return string A nicely formatted date/time string
1861  */
1862  function format_time($totalsecs, $str=NULL) {
1864     $totalsecs = abs($totalsecs);
1866     if (!$str) {  // Create the str structure the slow way
1867         $str->day   = get_string('day');
1868         $str->days  = get_string('days');
1869         $str->hour  = get_string('hour');
1870         $str->hours = get_string('hours');
1871         $str->min   = get_string('min');
1872         $str->mins  = get_string('mins');
1873         $str->sec   = get_string('sec');
1874         $str->secs  = get_string('secs');
1875         $str->year  = get_string('year');
1876         $str->years = get_string('years');
1877     }
1880     $years     = floor($totalsecs/YEARSECS);
1881     $remainder = $totalsecs - ($years*YEARSECS);
1882     $days      = floor($remainder/DAYSECS);
1883     $remainder = $totalsecs - ($days*DAYSECS);
1884     $hours     = floor($remainder/HOURSECS);
1885     $remainder = $remainder - ($hours*HOURSECS);
1886     $mins      = floor($remainder/MINSECS);
1887     $secs      = $remainder - ($mins*MINSECS);
1889     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1890     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1891     $sh = ($hours == 1) ? $str->hour : $str->hours;
1892     $sd = ($days == 1)  ? $str->day  : $str->days;
1893     $sy = ($years == 1)  ? $str->year  : $str->years;
1895     $oyears = '';
1896     $odays = '';
1897     $ohours = '';
1898     $omins = '';
1899     $osecs = '';
1901     if ($years)  $oyears  = $years .' '. $sy;
1902     if ($days)  $odays  = $days .' '. $sd;
1903     if ($hours) $ohours = $hours .' '. $sh;
1904     if ($mins)  $omins  = $mins .' '. $sm;
1905     if ($secs)  $osecs  = $secs .' '. $ss;
1907     if ($years) return trim($oyears .' '. $odays);
1908     if ($days)  return trim($odays .' '. $ohours);
1909     if ($hours) return trim($ohours .' '. $omins);
1910     if ($mins)  return trim($omins .' '. $osecs);
1911     if ($secs)  return $osecs;
1912     return get_string('now');
1915 /**
1916  * Returns a formatted string that represents a date in user time
1917  *
1918  * Returns a formatted string that represents a date in user time
1919  * <b>WARNING: note that the format is for strftime(), not date().</b>
1920  * Because of a bug in most Windows time libraries, we can't use
1921  * the nicer %e, so we have to use %d which has leading zeroes.
1922  * A lot of the fuss in the function is just getting rid of these leading
1923  * zeroes as efficiently as possible.
1924  *
1925  * If parameter fixday = true (default), then take off leading
1926  * zero from %d, else maintain it.
1927  *
1928  * @param int $date the timestamp in UTC, as obtained from the database.
1929  * @param string $format strftime format. You should probably get this using
1930  *      get_string('strftime...', 'langconfig');
1931  * @param mixed $timezone by default, uses the user's time zone. if numeric and
1932  *      not 99 then daylight saving will not be added.
1933  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1934  *      If false then the leading zero is maintained.
1935  * @return string the formatted date/time.
1936  */
1937 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1939     global $CFG;
1941     if (empty($format)) {
1942         $format = get_string('strftimedaydatetime', 'langconfig');
1943     }
1945     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1946         $fixday = false;
1947     } else if ($fixday) {
1948         $formatnoday = str_replace('%d', 'DD', $format);
1949         $fixday = ($formatnoday != $format);
1950     }
1952     //add daylight saving offset for string timezones only, as we can't get dst for
1953     //float values. if timezone is 99 (user default timezone), then try update dst.
1954     if ((99 == $timezone) || !is_numeric($timezone)) {
1955         $date += dst_offset_on($date, $timezone);
1956     }
1958     $timezone = get_user_timezone_offset($timezone);
1960     if (abs($timezone) > 13) {   /// Server time
1961         if ($fixday) {
1962             $datestring = strftime($formatnoday, $date);
1963             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1964             $datestring = str_replace('DD', $daystring, $datestring);
1965         } else {
1966             $datestring = strftime($format, $date);
1967         }
1968     } else {
1969         $date += (int)($timezone * 3600);
1970         if ($fixday) {
1971             $datestring = gmstrftime($formatnoday, $date);
1972             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1973             $datestring = str_replace('DD', $daystring, $datestring);
1974         } else {
1975             $datestring = gmstrftime($format, $date);
1976         }
1977     }
1979 /// If we are running under Windows convert from windows encoding to UTF-8
1980 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1982    if ($CFG->ostype == 'WINDOWS') {
1983        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1984            $textlib = textlib_get_instance();
1985            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1986        }
1987    }
1989     return $datestring;
1992 /**
1993  * Given a $time timestamp in GMT (seconds since epoch),
1994  * returns an array that represents the date in user time
1995  *
1996  * @todo Finish documenting this function
1997  * @uses HOURSECS
1998  * @param int $time Timestamp in GMT
1999  * @param mixed $timezone offset time with timezone, if float and not 99, then no
2000  *        dst offset is applyed
2001  * @return array An array that represents the date in user time
2002  */
2003 function usergetdate($time, $timezone=99) {
2005     //save input timezone, required for dst offset check.
2006     $passedtimezone = $timezone;
2008     $timezone = get_user_timezone_offset($timezone);
2010     if (abs($timezone) > 13) {    // Server time
2011         return getdate($time);
2012     }
2014     //add daylight saving offset for string timezones only, as we can't get dst for
2015     //float values. if timezone is 99 (user default timezone), then try update dst.
2016     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2017         $time += dst_offset_on($time, $passedtimezone);
2018     }
2020     $time += intval((float)$timezone * HOURSECS);
2022     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2024     //be careful to ensure the returned array matches that produced by getdate() above
2025     list(
2026         $getdate['month'],
2027         $getdate['weekday'],
2028         $getdate['yday'],
2029         $getdate['year'],
2030         $getdate['mon'],
2031         $getdate['wday'],
2032         $getdate['mday'],
2033         $getdate['hours'],
2034         $getdate['minutes'],
2035         $getdate['seconds']
2036     ) = explode('_', $datestring);
2038     return $getdate;
2041 /**
2042  * Given a GMT timestamp (seconds since epoch), offsets it by
2043  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2044  *
2045  * @uses HOURSECS
2046  * @param  int $date Timestamp in GMT
2047  * @param float $timezone
2048  * @return int
2049  */
2050 function usertime($date, $timezone=99) {
2052     $timezone = get_user_timezone_offset($timezone);
2054     if (abs($timezone) > 13) {
2055         return $date;
2056     }
2057     return $date - (int)($timezone * HOURSECS);
2060 /**
2061  * Given a time, return the GMT timestamp of the most recent midnight
2062  * for the current user.
2063  *
2064  * @param int $date Timestamp in GMT
2065  * @param float $timezone Defaults to user's timezone
2066  * @return int Returns a GMT timestamp
2067  */
2068 function usergetmidnight($date, $timezone=99) {
2070     $userdate = usergetdate($date, $timezone);
2072     // Time of midnight of this user's day, in GMT
2073     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2077 /**
2078  * Returns a string that prints the user's timezone
2079  *
2080  * @param float $timezone The user's timezone
2081  * @return string
2082  */
2083 function usertimezone($timezone=99) {
2085     $tz = get_user_timezone($timezone);
2087     if (!is_float($tz)) {
2088         return $tz;
2089     }
2091     if(abs($tz) > 13) { // Server time
2092         return get_string('serverlocaltime');
2093     }
2095     if($tz == intval($tz)) {
2096         // Don't show .0 for whole hours
2097         $tz = intval($tz);
2098     }
2100     if($tz == 0) {
2101         return 'UTC';
2102     }
2103     else if($tz > 0) {
2104         return 'UTC+'.$tz;
2105     }
2106     else {
2107         return 'UTC'.$tz;
2108     }
2112 /**
2113  * Returns a float which represents the user's timezone difference from GMT in hours
2114  * Checks various settings and picks the most dominant of those which have a value
2115  *
2116  * @global object
2117  * @global object
2118  * @param float $tz If this value is provided and not equal to 99, it will be returned as is and no other settings will be checked
2119  * @return float
2120  */
2121 function get_user_timezone_offset($tz = 99) {
2123     global $USER, $CFG;
2125     $tz = get_user_timezone($tz);
2127     if (is_float($tz)) {
2128         return $tz;
2129     } else {
2130         $tzrecord = get_timezone_record($tz);
2131         if (empty($tzrecord)) {
2132             return 99.0;
2133         }
2134         return (float)$tzrecord->gmtoff / HOURMINS;
2135     }
2138 /**
2139  * Returns an int which represents the systems's timezone difference from GMT in seconds
2140  *
2141  * @global object
2142  * @param mixed $tz timezone
2143  * @return int if found, false is timezone 99 or error
2144  */
2145 function get_timezone_offset($tz) {
2146     global $CFG;
2148     if ($tz == 99) {
2149         return false;
2150     }
2152     if (is_numeric($tz)) {
2153         return intval($tz * 60*60);
2154     }
2156     if (!$tzrecord = get_timezone_record($tz)) {
2157         return false;
2158     }
2159     return intval($tzrecord->gmtoff * 60);
2162 /**
2163  * Returns a float or a string which denotes the user's timezone
2164  * 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)
2165  * means that for this timezone there are also DST rules to be taken into account
2166  * Checks various settings and picks the most dominant of those which have a value
2167  *
2168  * @global object
2169  * @global object
2170  * @param mixed $tz If this value is provided and not equal to 99, it will be returned as is and no other settings will be checked
2171  * @return mixed
2172  */
2173 function get_user_timezone($tz = 99) {
2174     global $USER, $CFG;
2176     $timezones = array(
2177         $tz,
2178         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2179         isset($USER->timezone) ? $USER->timezone : 99,
2180         isset($CFG->timezone) ? $CFG->timezone : 99,
2181         );
2183     $tz = 99;
2185     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
2186         $tz = $next['value'];
2187     }
2189     return is_numeric($tz) ? (float) $tz : $tz;
2192 /**
2193  * Returns cached timezone record for given $timezonename
2194  *
2195  * @global object
2196  * @global object
2197  * @param string $timezonename
2198  * @return mixed timezonerecord object or false
2199  */
2200 function get_timezone_record($timezonename) {
2201     global $CFG, $DB;
2202     static $cache = NULL;
2204     if ($cache === NULL) {
2205         $cache = array();
2206     }
2208     if (isset($cache[$timezonename])) {
2209         return $cache[$timezonename];
2210     }
2212     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2213                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
2216 /**
2217  * Build and store the users Daylight Saving Time (DST) table
2218  *
2219  * @global object
2220  * @global object
2221  * @global object
2222  * @param mixed $from_year Start year for the table, defaults to 1971
2223  * @param mixed $to_year End year for the table, defaults to 2035
2224  * @param mixed $strtimezone, if null or 99 then user's default timezone is used
2225  * @return bool
2226  */
2227 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2228     global $CFG, $SESSION, $DB;
2230     $usertz = get_user_timezone($strtimezone);
2232     if (is_float($usertz)) {
2233         // Trivial timezone, no DST
2234         return false;
2235     }
2237     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2238         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2239         unset($SESSION->dst_offsets);
2240         unset($SESSION->dst_range);
2241     }
2243     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2244         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2245         // This will be the return path most of the time, pretty light computationally
2246         return true;
2247     }
2249     // Reaching here means we either need to extend our table or create it from scratch
2251     // Remember which TZ we calculated these changes for
2252     $SESSION->dst_offsettz = $usertz;
2254     if(empty($SESSION->dst_offsets)) {
2255         // If we 're creating from scratch, put the two guard elements in there
2256         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2257     }
2258     if(empty($SESSION->dst_range)) {
2259         // If creating from scratch
2260         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2261         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2263         // Fill in the array with the extra years we need to process
2264         $yearstoprocess = array();
2265         for($i = $from; $i <= $to; ++$i) {
2266             $yearstoprocess[] = $i;
2267         }
2269         // Take note of which years we have processed for future calls
2270         $SESSION->dst_range = array($from, $to);
2271     }
2272     else {
2273         // If needing to extend the table, do the same
2274         $yearstoprocess = array();
2276         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2277         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2279         if($from < $SESSION->dst_range[0]) {
2280             // Take note of which years we need to process and then note that we have processed them for future calls
2281             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2282                 $yearstoprocess[] = $i;
2283             }
2284             $SESSION->dst_range[0] = $from;
2285         }
2286         if($to > $SESSION->dst_range[1]) {
2287             // Take note of which years we need to process and then note that we have processed them for future calls
2288             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2289                 $yearstoprocess[] = $i;
2290             }
2291             $SESSION->dst_range[1] = $to;
2292         }
2293     }
2295     if(empty($yearstoprocess)) {
2296         // This means that there was a call requesting a SMALLER range than we have already calculated
2297         return true;
2298     }
2300     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2301     // Also, the array is sorted in descending timestamp order!
2303     // Get DB data
2305     static $presets_cache = array();
2306     if (!isset($presets_cache[$usertz])) {
2307         $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');
2308     }
2309     if(empty($presets_cache[$usertz])) {
2310         return false;
2311     }
2313     // Remove ending guard (first element of the array)
2314     reset($SESSION->dst_offsets);
2315     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2317     // Add all required change timestamps
2318     foreach($yearstoprocess as $y) {
2319         // Find the record which is in effect for the year $y
2320         foreach($presets_cache[$usertz] as $year => $preset) {
2321             if($year <= $y) {
2322                 break;
2323             }
2324         }
2326         $changes = dst_changes_for_year($y, $preset);
2328         if($changes === NULL) {
2329             continue;
2330         }
2331         if($changes['dst'] != 0) {
2332             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2333         }
2334         if($changes['std'] != 0) {
2335             $SESSION->dst_offsets[$changes['std']] = 0;
2336         }
2337     }
2339     // Put in a guard element at the top
2340     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2341     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2343     // Sort again
2344     krsort($SESSION->dst_offsets);
2346     return true;
2349 /**
2350  * Calculates the required DST change and returns a Timestamp Array
2351  *
2352  * @uses HOURSECS
2353  * @uses MINSECS
2354  * @param mixed $year Int or String Year to focus on
2355  * @param object $timezone Instatiated Timezone object
2356  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
2357  */
2358 function dst_changes_for_year($year, $timezone) {
2360     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2361         return NULL;
2362     }
2364     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2365     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2367     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2368     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2370     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2371     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2373     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2374     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2375     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2377     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2378     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2380     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2383 /**
2384  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2385  * - Note: Daylight saving only works for string timezones and not for float.
2386  *
2387  * @global object
2388  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2389  * @param mixed $strtimezone timezone for which offset is expected, if 99 or null
2390  *        then user's default timezone is used.
2391  * @return int
2392  */
2393 function dst_offset_on($time, $strtimezone = NULL) {
2394     global $SESSION;
2396     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2397         return 0;
2398     }
2400     reset($SESSION->dst_offsets);
2401     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2402         if($from <= $time) {
2403             break;
2404         }
2405     }
2407     // This is the normal return path
2408     if($offset !== NULL) {
2409         return $offset;
2410     }
2412     // Reaching this point means we haven't calculated far enough, do it now:
2413     // Calculate extra DST changes if needed and recurse. The recursion always
2414     // moves toward the stopping condition, so will always end.
2416     if($from == 0) {
2417         // We need a year smaller than $SESSION->dst_range[0]
2418         if($SESSION->dst_range[0] == 1971) {
2419             return 0;
2420         }
2421         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2422         return dst_offset_on($time, $strtimezone);
2423     }
2424     else {
2425         // We need a year larger than $SESSION->dst_range[1]
2426         if($SESSION->dst_range[1] == 2035) {
2427             return 0;
2428         }
2429         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2430         return dst_offset_on($time, $strtimezone);
2431     }
2434 /**
2435  * ?
2436  *
2437  * @todo Document what this function does
2438  * @param int $startday
2439  * @param int $weekday
2440  * @param int $month
2441  * @param int $year
2442  * @return int
2443  */
2444 function find_day_in_month($startday, $weekday, $month, $year) {
2446     $daysinmonth = days_in_month($month, $year);
2448     if($weekday == -1) {
2449         // Don't care about weekday, so return:
2450         //    abs($startday) if $startday != -1
2451         //    $daysinmonth otherwise
2452         return ($startday == -1) ? $daysinmonth : abs($startday);
2453     }
2455     // From now on we 're looking for a specific weekday
2457     // Give "end of month" its actual value, since we know it
2458     if($startday == -1) {
2459         $startday = -1 * $daysinmonth;
2460     }
2462     // Starting from day $startday, the sign is the direction
2464     if($startday < 1) {
2466         $startday = abs($startday);
2467         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2469         // This is the last such weekday of the month
2470         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2471         if($lastinmonth > $daysinmonth) {
2472             $lastinmonth -= 7;
2473         }
2475         // Find the first such weekday <= $startday
2476         while($lastinmonth > $startday) {
2477             $lastinmonth -= 7;
2478         }
2480         return $lastinmonth;
2482     }
2483     else {
2485         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2487         $diff = $weekday - $indexweekday;
2488         if($diff < 0) {
2489             $diff += 7;
2490         }
2492         // This is the first such weekday of the month equal to or after $startday
2493         $firstfromindex = $startday + $diff;
2495         return $firstfromindex;
2497     }
2500 /**
2501  * Calculate the number of days in a given month
2502  *
2503  * @param int $month The month whose day count is sought
2504  * @param int $year The year of the month whose day count is sought
2505  * @return int
2506  */
2507 function days_in_month($month, $year) {
2508    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2511 /**
2512  * Calculate the position in the week of a specific calendar day
2513  *
2514  * @param int $day The day of the date whose position in the week is sought
2515  * @param int $month The month of the date whose position in the week is sought
2516  * @param int $year The year of the date whose position in the week is sought
2517  * @return int
2518  */
2519 function dayofweek($day, $month, $year) {
2520     // I wonder if this is any different from
2521     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2522     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2525 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2527 /**
2528  * Returns full login url.
2529  *
2530  * @return string login url
2531  */
2532 function get_login_url() {
2533     global $CFG;
2535     $url = "$CFG->wwwroot/login/index.php";
2537     if (!empty($CFG->loginhttps)) {
2538         $url = str_replace('http:', 'https:', $url);
2539     }
2541     return $url;
2544 /**
2545  * This function checks that the current user is logged in and has the
2546  * required privileges
2547  *
2548  * This function checks that the current user is logged in, and optionally
2549  * whether they are allowed to be in a particular course and view a particular
2550  * course module.
2551  * If they are not logged in, then it redirects them to the site login unless
2552  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2553  * case they are automatically logged in as guests.
2554  * If $courseid is given and the user is not enrolled in that course then the
2555  * user is redirected to the course enrolment page.
2556  * If $cm is given and the course module is hidden and the user is not a teacher
2557  * in the course then the user is redirected to the course home page.
2558  *
2559  * When $cm parameter specified, this function sets page layout to 'module'.
2560  * You need to change it manually later if some other layout needed.
2561  *
2562  * @param mixed $courseorid id of the course or course object
2563  * @param bool $autologinguest default true
2564  * @param object $cm course module object
2565  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2566  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2567  *             in order to keep redirects working properly. MDL-14495
2568  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2569  * @return mixed Void, exit, and die depending on path
2570  */
2571 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2572     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2574     // setup global $COURSE, themes, language and locale
2575     if (!empty($courseorid)) {
2576         if (is_object($courseorid)) {
2577             $course = $courseorid;
2578         } else if ($courseorid == SITEID) {
2579             $course = clone($SITE);
2580         } else {
2581             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2582         }
2583         if ($cm) {
2584             if ($cm->course != $course->id) {
2585                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2586             }
2587             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2588             if (!($cm instanceof cm_info)) {
2589                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2590                 // db queries so this is not really a performance concern, however it is obviously
2591                 // better if you use get_fast_modinfo to get the cm before calling this.
2592                 $modinfo = get_fast_modinfo($course);
2593                 $cm = $modinfo->get_cm($cm->id);
2594             }
2595             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2596             $PAGE->set_pagelayout('incourse');
2597         } else {
2598             $PAGE->set_course($course); // set's up global $COURSE
2599         }
2600     } else {
2601         // do not touch global $COURSE via $PAGE->set_course(),
2602         // the reasons is we need to be able to call require_login() at any time!!
2603         $course = $SITE;
2604         if ($cm) {
2605             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2606         }
2607     }
2609     // If the user is not even logged in yet then make sure they are
2610     if (!isloggedin()) {
2611         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2612             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2613                 // misconfigured site guest, just redirect to login page
2614                 redirect(get_login_url());
2615                 exit; // never reached
2616             }
2617             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2618             complete_user_login($guest);
2619             $USER->autologinguest = true;
2620             $SESSION->lang = $lang;
2621         } else {
2622             //NOTE: $USER->site check was obsoleted by session test cookie,
2623             //      $USER->confirmed test is in login/index.php
2624             if ($preventredirect) {
2625                 throw new require_login_exception('You are not logged in');
2626             }
2628             if ($setwantsurltome) {
2629                 // TODO: switch to PAGE->url
2630                 $SESSION->wantsurl = $FULLME;
2631             }
2632             if (!empty($_SERVER['HTTP_REFERER'])) {
2633                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2634             }
2635             redirect(get_login_url());
2636             exit; // never reached
2637         }
2638     }
2640     // loginas as redirection if needed
2641     if ($course->id != SITEID and session_is_loggedinas()) {
2642         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2643             if ($USER->loginascontext->instanceid != $course->id) {
2644                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2645             }
2646         }
2647     }
2649     // check whether the user should be changing password (but only if it is REALLY them)
2650     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2651         $userauth = get_auth_plugin($USER->auth);
2652         if ($userauth->can_change_password() and !$preventredirect) {
2653             $SESSION->wantsurl = $FULLME;
2654             if ($changeurl = $userauth->change_password_url()) {
2655                 //use plugin custom url
2656                 redirect($changeurl);
2657             } else {
2658                 //use moodle internal method
2659                 if (empty($CFG->loginhttps)) {
2660                     redirect($CFG->wwwroot .'/login/change_password.php');
2661                 } else {
2662                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2663                     redirect($wwwroot .'/login/change_password.php');
2664                 }
2665             }
2666         } else {
2667             print_error('nopasswordchangeforced', 'auth');
2668         }
2669     }
2671     // Check that the user account is properly set up
2672     if (user_not_fully_set_up($USER)) {
2673         if ($preventredirect) {
2674             throw new require_login_exception('User not fully set-up');
2675         }
2676         $SESSION->wantsurl = $FULLME;
2677         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2678     }
2680     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2681     sesskey();
2683     // Do not bother admins with any formalities
2684     if (is_siteadmin()) {
2685         //set accesstime or the user will appear offline which messes up messaging
2686         user_accesstime_log($course->id);
2687         return;
2688     }
2690     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2691     if (!$USER->policyagreed and !is_siteadmin()) {
2692         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2693             if ($preventredirect) {
2694                 throw new require_login_exception('Policy not agreed');
2695             }
2696             $SESSION->wantsurl = $FULLME;
2697             redirect($CFG->wwwroot .'/user/policy.php');
2698         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2699             if ($preventredirect) {
2700                 throw new require_login_exception('Policy not agreed');
2701             }
2702             $SESSION->wantsurl = $FULLME;
2703             redirect($CFG->wwwroot .'/user/policy.php');
2704         }
2705     }
2707     // Fetch the system context, the course context, and prefetch its child contexts
2708     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2709     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2710     if ($cm) {
2711         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2712     } else {
2713         $cmcontext = null;
2714     }
2716     // If the site is currently under maintenance, then print a message
2717     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2718         if ($preventredirect) {
2719             throw new require_login_exception('Maintenance in progress');
2720         }
2722         print_maintenance_message();
2723     }
2725     // make sure the course itself is not hidden
2726     if ($course->id == SITEID) {
2727         // frontpage can not be hidden
2728     } else {
2729         if (is_role_switched($course->id)) {
2730             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2731         } else {
2732             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2733                 // originally there was also test of parent category visibility,
2734                 // BUT is was very slow in complex queries involving "my courses"
2735                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2736                 if ($preventredirect) {
2737                     throw new require_login_exception('Course is hidden');
2738                 }
2739                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2740             }
2741         }
2742     }
2744     // is the user enrolled?
2745     if ($course->id == SITEID) {
2746         // everybody is enrolled on the frontpage
2748     } else {
2749         if (session_is_loggedinas()) {
2750             // Make sure the REAL person can access this course first
2751             $realuser = session_get_realuser();
2752             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2753                 if ($preventredirect) {
2754                     throw new require_login_exception('Invalid course login-as access');
2755                 }
2756                 echo $OUTPUT->header();
2757                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2758             }
2759         }
2761         // very simple enrolment caching - changes in course setting are not reflected immediately
2762         if (!isset($USER->enrol)) {
2763             $USER->enrol = array();
2764             $USER->enrol['enrolled'] = array();
2765             $USER->enrol['tempguest'] = array();
2766         }
2768         $access = false;
2770         if (is_viewing($coursecontext, $USER)) {
2771             // ok, no need to mess with enrol
2772             $access = true;
2774         } else {
2775             if (isset($USER->enrol['enrolled'][$course->id])) {
2776                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2777                     $access = true;
2778                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2779                     $access = true;
2780                 } else {
2781                     //expired
2782                     unset($USER->enrol['enrolled'][$course->id]);
2783                 }
2784             }
2785             if (isset($USER->enrol['tempguest'][$course->id])) {
2786                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2787                     $access = true;
2788                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2789                     $access = true;
2790                 } else {
2791                     //expired
2792                     unset($USER->enrol['tempguest'][$course->id]);
2793                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2794                 }
2795             }
2797             if ($access) {
2798                 // cache ok
2799             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2800                 // active participants may always access
2801                 // TODO: refactor this into some new function
2802                 $now = time();
2803                 $sql = "SELECT MAX(ue.timeend)
2804                           FROM {user_enrolments} ue
2805                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2806                           JOIN {user} u ON u.id = ue.userid
2807                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2808                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2809                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2810                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2811                 $until = $DB->get_field_sql($sql, $params);
2812                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2813                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2814                 }
2816                 $USER->enrol['enrolled'][$course->id] = $until;
2817                 $access = true;
2819                 // remove traces of previous temp guest access
2820                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2822             } else {
2823                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2824                 $enrols = enrol_get_plugins(true);
2825                 // first ask all enabled enrol instances in course if they want to auto enrol user
2826                 foreach($instances as $instance) {
2827                     if (!isset($enrols[$instance->enrol])) {
2828                         continue;
2829                     }
2830                     // Get a duration for the guestaccess, a timestamp in the future or false.
2831                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2832                     if ($until !== false) {
2833                         $USER->enrol['enrolled'][$course->id] = $until;
2834                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2835                         $access = true;
2836                         break;
2837                     }
2838                 }
2839                 // if not enrolled yet try to gain temporary guest access
2840                 if (!$access) {
2841                     foreach($instances as $instance) {
2842                         if (!isset($enrols[$instance->enrol])) {
2843                             continue;
2844                         }
2845                         // Get a duration for the guestaccess, a timestamp in the future or false.
2846                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2847                         if ($until !== false) {
2848                             $USER->enrol['tempguest'][$course->id] = $until;
2849                             $access = true;
2850                             break;
2851                         }
2852                     }
2853                 }
2854             }
2855         }
2857         if (!$access) {
2858             if ($preventredirect) {
2859                 throw new require_login_exception('Not enrolled');
2860             }
2861             $SESSION->wantsurl = $FULLME;
2862             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2863         }
2864     }
2866     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
2867     // conditional availability, etc
2868     if ($cm && !$cm->uservisible) {
2869         if ($preventredirect) {
2870             throw new require_login_exception('Activity is hidden');
2871         }
2872         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2873     }
2875     // Finally access granted, update lastaccess times
2876     user_accesstime_log($course->id);
2880 /**
2881  * This function just makes sure a user is logged out.
2882  *
2883  * @global object
2884  */
2885 function require_logout() {
2886     global $USER;
2888     $params = $USER;
2890     if (isloggedin()) {
2891         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2893         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2894         foreach($authsequence as $authname) {
2895             $authplugin = get_auth_plugin($authname);
2896             $authplugin->prelogout_hook();
2897         }
2898     }
2900     events_trigger('user_logout', $params);
2901     session_get_instance()->terminate_current();
2902     unset($params);
2905 /**
2906  * Weaker version of require_login()
2907  *
2908  * This is a weaker version of {@link require_login()} which only requires login
2909  * when called from within a course rather than the site page, unless
2910  * the forcelogin option is turned on.
2911  * @see require_login()
2912  *
2913  * @global object
2914  * @param mixed $courseorid The course object or id in question
2915  * @param bool $autologinguest Allow autologin guests if that is wanted
2916  * @param object $cm Course activity module if known
2917  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2918  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2919  *             in order to keep redirects working properly. MDL-14495
2920  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2921  * @return void
2922  */
2923 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2924     global $CFG, $PAGE, $SITE;
2925     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
2926           or (!is_object($courseorid) and $courseorid == SITEID);
2927     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
2928         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2929         // db queries so this is not really a performance concern, however it is obviously
2930         // better if you use get_fast_modinfo to get the cm before calling this.
2931         if (is_object($courseorid)) {
2932             $course = $courseorid;
2933         } else {
2934             $course = clone($SITE);
2935         }
2936         $modinfo = get_fast_modinfo($course);
2937         $cm = $modinfo->get_cm($cm->id);
2938     }
2939     if (!empty($CFG->forcelogin)) {
2940         // login required for both SITE and courses
2941         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2943     } else if ($issite && !empty($cm) and !$cm->uservisible) {
2944         // always login for hidden activities
2945         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2947     } else if ($issite) {
2948               //login for SITE not required
2949         if ($cm and empty($cm->visible)) {
2950             // hidden activities are not accessible without login
2951             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2952         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2953             // not-logged-in users do not have any group membership
2954             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2955         } else {
2956             // We still need to instatiate PAGE vars properly so that things
2957             // that rely on it like navigation function correctly.
2958             if (!empty($courseorid)) {
2959                 if (is_object($courseorid)) {
2960                     $course = $courseorid;
2961                 } else {
2962                     $course = clone($SITE);
2963                 }
2964                 if ($cm) {
2965                     if ($cm->course != $course->id) {
2966                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2967                     }
2968                     $PAGE->set_cm($cm, $course);
2969                     $PAGE->set_pagelayout('incourse');
2970                 } else {
2971                     $PAGE->set_course($course);
2972                 }
2973             } else {
2974                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2975                 // up properly, set them up now.
2976                 $PAGE->set_course($PAGE->course);
2977             }
2978             //TODO: verify conditional activities here
2979             user_accesstime_log(SITEID);
2980             return;
2981         }
2983     } else {
2984         // course login always required
2985         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2986     }
2989 /**
2990  * Require key login. Function terminates with error if key not found or incorrect.
2991  *
2992  * @global object
2993  * @global object
2994  * @global object
2995  * @global object
2996  * @uses NO_MOODLE_COOKIES
2997  * @uses PARAM_ALPHANUM
2998  * @param string $script unique script identifier
2999  * @param int $instance optional instance id
3000  * @return int Instance ID
3001  */
3002 function require_user_key_login($script, $instance=null) {
3003     global $USER, $SESSION, $CFG, $DB;
3005     if (!NO_MOODLE_COOKIES) {
3006         print_error('sessioncookiesdisable');
3007     }
3009 /// extra safety
3010     @session_write_close();
3012     $keyvalue = required_param('key', PARAM_ALPHANUM);
3014     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3015         print_error('invalidkey');
3016     }
3018     if (!empty($key->validuntil) and $key->validuntil < time()) {
3019         print_error('expiredkey');
3020     }
3022     if ($key->iprestriction) {
3023         $remoteaddr = getremoteaddr(null);
3024         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3025             print_error('ipmismatch');
3026         }
3027     }
3029     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3030         print_error('invaliduserid');
3031     }
3033 /// emulate normal session
3034     session_set_user($user);
3036 /// note we are not using normal login
3037     if (!defined('USER_KEY_LOGIN')) {
3038         define('USER_KEY_LOGIN', true);
3039     }
3041 /// return instance id - it might be empty
3042     return $key->instance;
3045 /**
3046  * Creates a new private user access key.
3047  *
3048  * @global object
3049  * @param string $script unique target identifier
3050  * @param int $userid
3051  * @param int $instance optional instance id
3052  * @param string $iprestriction optional ip restricted access
3053  * @param timestamp $validuntil key valid only until given data
3054  * @return string access key value
3055  */
3056 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3057     global $DB;
3059     $key = new stdClass();
3060     $key->script        = $script;
3061     $key->userid        = $userid;
3062     $key->instance      = $instance;
3063     $key->iprestriction = $iprestriction;
3064     $key->validuntil    = $validuntil;
3065     $key->timecreated   = time();
3067     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3068     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3069         // must be unique
3070         $key->value     = md5($userid.'_'.time().random_string(40));
3071     }
3072     $DB->insert_record('user_private_key', $key);
3073     return $key->value;
3076 /**
3077  * Delete the user's new private user access keys for a particular script.
3078  *
3079  * @global object
3080  * @param string $script unique target identifier
3081  * @param int $userid
3082  * @return void
3083  */
3084 function delete_user_key($script,$userid) {
3085     global $DB;
3086     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3089 /**
3090  * Gets a private user access key (and creates one if one doesn't exist).
3091  *
3092  * @global object
3093  * @param string $script unique target identifier
3094  * @param int $userid
3095  * @param int $instance optional instance id
3096  * @param string $iprestriction optional ip restricted access
3097  * @param timestamp $validuntil key valid only until given data
3098  * @return string access key value
3099  */
3100 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3101     global $DB;
3103     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3104                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3105                                                          'validuntil'=>$validuntil))) {
3106         return $key->value;
3107     } else {
3108         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3109     }
3113 /**
3114  * Modify the user table by setting the currently logged in user's
3115  * last login to now.
3116  *
3117  * @global object
3118  * @global object
3119  * @return bool Always returns true
3120  */
3121 function update_user_login_times() {
3122     global $USER, $DB;
3124     $user = new stdClass();
3125     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3126     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
3128     $user->id = $USER->id;
3130     $DB->update_record('user', $user);
3131     return true;
3134 /**
3135  * Determines if a user has completed setting up their account.
3136  *
3137  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3138  * @return bool
3139  */
3140 function user_not_fully_set_up($user) {
3141     if (isguestuser($user)) {
3142         return false;
3143     }
3144     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3147 /**
3148  * Check whether the user has exceeded the bounce threshold
3149  *
3150  * @global object
3151  * @global object
3152  * @param user $user A {@link $USER} object
3153  * @return bool true=>User has exceeded bounce threshold
3154  */
3155 function over_bounce_threshold($user) {
3156     global $CFG, $DB;
3158     if (empty($CFG->handlebounces)) {
3159         return false;
3160     }
3162     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3163         return false;
3164     }
3166     // set sensible defaults
3167     if (empty($CFG->minbounces)) {
3168         $CFG->minbounces = 10;
3169     }
3170     if (empty($CFG->bounceratio)) {
3171         $CFG->bounceratio = .20;
3172     }
3173     $bouncecount = 0;
3174     $sendcount = 0;
3175     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3176         $bouncecount = $bounce->value;
3177     }
3178     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3179         $sendcount = $send->value;
3180     }
3181     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3184 /**
3185  * Used to increment or reset email sent count
3186  *
3187  * @global object
3188  * @param user $user object containing an id
3189  * @param bool $reset will reset the count to 0
3190  * @return void
3191  */
3192 function set_send_count($user,$reset=false) {
3193     global $DB;
3195     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3196         return;
3197     }
3199     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3200         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3201         $DB->update_record('user_preferences', $pref);
3202     }
3203     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3204         // make a new one
3205         $pref = new stdClass();
3206         $pref->name   = 'email_send_count';
3207         $pref->value  = 1;
3208         $pref->userid = $user->id;
3209         $DB->insert_record('user_preferences', $pref, false);
3210     }
3213 /**
3214  * Increment or reset user's email bounce count
3215  *
3216  * @global object
3217  * @param user $user object containing an id
3218  * @param bool $reset will reset the count to 0
3219  */
3220 function set_bounce_count($user,$reset=false) {
3221     global $DB;
3223     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3224         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3225         $DB->update_record('user_preferences', $pref);
3226     }
3227     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3228         // make a new one
3229         $pref = new stdClass();
3230         $pref->name   = 'email_bounce_count';
3231         $pref->value  = 1;
3232         $pref->userid = $user->id;
3233         $DB->insert_record('user_preferences', $pref, false);
3234     }
3237 /**
3238  * Keeps track of login attempts
3239  *
3240  * @global object
3241  */
3242 function update_login_count() {
3243     global $SESSION;
3245     $max_logins = 10;
3247     if (empty($SESSION->logincount)) {
3248         $SESSION->logincount = 1;
3249     } else {
3250         $SESSION->logincount++;
3251     }
3253     if ($SESSION->logincount > $max_logins) {
3254         unset($SESSION->wantsurl);
3255         print_error('errortoomanylogins');
3256     }
3259 /**
3260  * Resets login attempts
3261  *
3262  * @global object
3263  */
3264 function reset_login_count() {
3265     global $SESSION;
3267     $SESSION->logincount = 0;
3270 /**
3271  * Determines if the currently logged in user is in editing mode.
3272  * Note: originally this function had $userid parameter - it was not usable anyway
3273  *
3274  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3275  * @todo Deprecated function remove when ready
3276  *
3277  * @global object
3278  * @uses DEBUG_DEVELOPER
3279  * @return bool
3280  */
3281 function isediting() {
3282     global $PAGE;
3283     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3284     return $PAGE->user_is_editing();
3287 /**
3288  * Determines if the logged in user is currently moving an activity
3289  *
3290  * @global object
3291  * @param int $courseid The id of the course being tested
3292  * @return bool
3293  */
3294 function ismoving($courseid) {
3295     global $USER;
3297     if (!empty($USER->activitycopy)) {
3298         return ($USER->activitycopycourse == $courseid);
3299     }
3300     return false;
3303 /**
3304  * Returns a persons full name
3305  *
3306  * Given an object containing firstname and lastname
3307  * values, this function returns a string with the
3308  * full name of the person.
3309  * The result may depend on system settings
3310  * or language.  'override' will force both names
3311  * to be used even if system settings specify one.
3312  *
3313  * @global object
3314  * @global object
3315  * @param object $user A {@link $USER} object to get full name of
3316  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3317  * @return string
3318  */
3319 function fullname($user, $override=false) {
3320     global $CFG, $SESSION;
3322     if (!isset($user->firstname) and !isset($user->lastname)) {
3323         return '';
3324     }
3326     if (!$override) {
3327         if (!empty($CFG->forcefirstname)) {
3328             $user->firstname = $CFG->forcefirstname;
3329         }
3330         if (!empty($CFG->forcelastname)) {
3331             $user->lastname = $CFG->forcelastname;
3332         }
3333     }
3335     if (!empty($SESSION->fullnamedisplay)) {
3336         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3337     }
3339     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3340         return $user->firstname .' '. $user->lastname;
3342     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3343         return $user->lastname .' '. $user->firstname;
3345     } else if ($CFG->fullnamedisplay == 'firstname') {
3346         if ($override) {
3347             return get_string('fullnamedisplay', '', $user);
3348         } else {
3349             return $user->firstname;
3350         }
3351     }
3353     return get_string('fullnamedisplay', '', $user);
3356 /**
3357  * Returns whether a given authentication plugin exists.
3358  *
3359  * @global object
3360  * @param string $auth Form of authentication to check for. Defaults to the
3361  *        global setting in {@link $CFG}.
3362  * @return boolean Whether the plugin is available.
3363  */
3364 function exists_auth_plugin($auth) {
3365     global $CFG;
3367     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3368         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3369     }
3370     return false;
3373 /**
3374  * Checks if a given plugin is in the list of enabled authentication plugins.
3375  *
3376  * @param string $auth Authentication plugin.
3377  * @return boolean Whether the plugin is enabled.
3378  */
3379 function is_enabled_auth($auth) {
3380     if (empty($auth)) {
3381         return false;
3382     }
3384     $enabled = get_enabled_auth_plugins();
3386     return in_array($auth, $enabled);
3389 /**
3390  * Returns an authentication plugin instance.
3391  *
3392  * @global object
3393  * @param string $auth name of authentication plugin
3394  * @return auth_plugin_base An instance of the required authentication plugin.
3395  */
3396 function get_auth_plugin($auth) {
3397     global $CFG;
3399     // check the plugin exists first
3400     if (! exists_auth_plugin($auth)) {
3401         print_error('authpluginnotfound', 'debug', '', $auth);
3402     }
3404     // return auth plugin instance
3405     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3406     $class = "auth_plugin_$auth";
3407     return new $class;
3410 /**
3411  * Returns array of active auth plugins.
3412  *
3413  * @param bool $fix fix $CFG->auth if needed
3414  * @return array
3415  */
3416 function get_enabled_auth_plugins($fix=false) {
3417     global $CFG;
3419     $default = array('manual', 'nologin');
3421     if (empty($CFG->auth)) {
3422         $auths = array();
3423     } else {
3424         $auths = explode(',', $CFG->auth);
3425     }
3427     if ($fix) {
3428         $auths = array_unique($auths);
3429         foreach($auths as $k=>$authname) {
3430             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3431                 unset($auths[$k]);
3432             }
3433         }
3434         $newconfig = implode(',', $auths);
3435         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3436             set_config('auth', $newconfig);
3437         }
3438     }
3440     return (array_merge($default, $auths));
3443 /**
3444  * Returns true if an internal authentication method is being used.
3445  * if method not specified then, global default is assumed
3446  *
3447  * @param string $auth Form of authentication required
3448  * @return bool
3449  */
3450 function is_internal_auth($auth) {
3451     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3452     return $authplugin->is_internal();
3455 /**
3456  * Returns true if the user is a 'restored' one
3457  *
3458  * Used in the login process to inform the user
3459  * and allow him/her to reset the password
3460  *
3461  * @uses $CFG
3462  * @uses $DB
3463  * @param string $username username to be checked
3464  * @return bool
3465  */
3466 function is_restored_user($username) {
3467     global $CFG, $DB;
3469     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3472 /**
3473  * Returns an array of user fields
3474  *
3475  * @return array User field/column names
3476  */
3477 function get_user_fieldnames() {
3478     global $DB;
3480     $fieldarray = $DB->get_columns('user');
3481     unset($fieldarray['id']);
3482     $fieldarray = array_keys($fieldarray);
3484     return $fieldarray;
3487 /**
3488  * Creates a bare-bones user record
3489  *
3490  * @todo Outline auth types and provide code example
3491  *
3492  * @param string $username New user's username to add to record
3493  * @param string $password New user's password to add to record
3494  * @param string $auth Form of authentication required
3495  * @return stdClass A complete user object
3496  */
3497 function create_user_record($username, $password, $auth = 'manual') {
3498     global $CFG, $DB;
3500     //just in case check text case
3501     $username = trim(moodle_strtolower($username));
3503     $authplugin = get_auth_plugin($auth);
3505     $newuser = new stdClass();
3507     if ($newinfo = $authplugin->get_userinfo($username)) {
3508         $newinfo = truncate_userinfo($newinfo);
3509         foreach ($newinfo as $key => $value){
3510             $newuser->$key = $value;
3511         }
3512     }
3514     if (!empty($newuser->email)) {
3515         if (email_is_not_allowed($newuser->email)) {
3516             unset($newuser->email);
3517         }
3518     }
3520     if (!isset($newuser->city)) {
3521         $newuser->city = '';
3522     }
3524     $newuser->auth = $auth;
3525     $newuser->username = $username;
3527     // fix for MDL-8480
3528     // user CFG lang for user if $newuser->lang is empty
3529     // or $user->lang is not an installed language
3530     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3531         $newuser->lang = $CFG->lang;
3532     }
3533     $newuser->confirmed = 1;
3534     $newuser->lastip = getremoteaddr();
3535     $newuser->timemodified = time();
3536     $newuser->mnethostid = $CFG->mnet_localhost_id;
3538     $newuser->id = $DB->insert_record('user', $newuser);
3539     $user = get_complete_user_data('id', $newuser->id);
3540     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3541         set_user_preference('auth_forcepasswordchange', 1, $user);
3542     }
3543     update_internal_user_password($user, $password);
3545     // fetch full user record for the event, the complete user data contains too much info
3546     // and we want to be consistent with other places that trigger this event
3547     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3549     return $user;
3552 /**
3553  * Will update a local user record from an external source.
3554  * (MNET users can not be updated using this method!)
3555  *
3556  * @param string $username user's username to update the record
3557  * @return stdClass A complete user object
3558  */
3559 function update_user_record($username) {
3560     global $DB, $CFG;
3562     $username = trim(moodle_strtolower($username)); /// just in case check text case
3564     $oldinfo = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
3565     $newuser = array();
3566     $userauth = get_auth_plugin($oldinfo->auth);
3568     if ($newinfo = $userauth->get_userinfo($username)) {
3569         $newinfo = truncate_userinfo($newinfo);
3570         foreach ($newinfo as $key => $value){
3571             $key = strtolower($key);
3572             if (!property_exists($oldinfo, $key) or $key === 'username' or $key === 'id'
3573                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3574                 // unknown or must not be changed
3575                 continue;
3576             }
3577             $confval = $userauth->config->{'field_updatelocal_' . $key};
3578             $lockval = $userauth->config->{'field_lock_' . $key};
3579             if (empty($confval) || empty($lockval)) {
3580                 continue;
3581             }
3582             if ($confval === 'onlogin') {
3583                 // MDL-4207 Don't overwrite modified user profile values with
3584                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3585                 // of the setting 'unlocked if empty' is to allow the user to fill
3586                 // in a value for the selected field _if LDAP is giving
3587                 // nothing_ for this field. Thus it makes sense to let this value
3588                 // stand in until LDAP is giving a value for this field.
3589                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3590                     if ((string)$oldinfo->$key !== (string)$value) {
3591                         $newuser[$key] = (string)$value;
3592                     }
3593                 }
3594             }
3595         }
3596         if ($newuser) {
3597             $newuser['id'] = $oldinfo->id;
3598             $DB->update_record('user', $newuser);
3599             // fetch full user record for the event, the complete user data contains too much info
3600             // and we want to be consistent with other places that trigger this event
3601             events_trigger('user_updated', $DB->get_record('user', array('id'=>$oldinfo->id)));
3602         }
3603     }
3605     return get_complete_user_data('id', $oldinfo->id);
3608 /**
3609  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3610  * which may have large fields
3611  *
3612  * @todo Add vartype handling to ensure $info is an array
3613  *
3614  * @param array $info Array of user properties to truncate if needed
3615  * @return array The now truncated information that was passed in
3616  */
3617 function truncate_userinfo($info) {
3618     // define the limits
3619     $limit = array(
3620                     'username'    => 100,
3621                     'idnumber'    => 255,
3622                     'firstname'   => 100,
3623                     'lastname'    => 100,
3624                     'email'       => 100,
3625                     'icq'         =>  15,
3626                     'phone1'      =>  20,
3627                     'phone2'      =>  20,
3628                     'institution' =>  40,
3629                     'department'  =>  30,
3630                     'address'     =>  70,
3631                     'city'        => 120,
3632                     'country'     =>   2,
3633                     'url'         => 255,
3634                     );
3636     $textlib = textlib_get_instance();
3637     // apply where needed
3638     foreach (array_keys($info) as $key) {
3639         if (!empty($limit[$key])) {
3640             $info[$key] = trim($textlib->substr($info[$key],0, $limit[$key]));
3641         }
3642     }
3644     return $info;
3647 /**
3648  * Marks user deleted in internal user database and notifies the auth plugin.
3649  * Also unenrols user from all roles and does other cleanup.
3650  *
3651  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3652  *
3653  * @param stdClass $user full user object before delete
3654  * @return boolean always true
3655  */
3656 function delete_user($user) {
3657     global $CFG, $DB;
3658     require_once($CFG->libdir.'/grouplib.php');
3659     require_once($CFG->libdir.'/gradelib.php');
3660     require_once($CFG->dirroot.'/message/lib.php');
3661     require_once($CFG->dirroot.'/tag/lib.php');
3663     // delete all grades - backup is kept in grade_grades_history table
3664     grade_user_delete($user->id);
3666     //move unread messages from this user to read
3667     message_move_userfrom_unread2read($user->id);
3669     // TODO: remove from cohorts using standard API here
3671     // remove user tags
3672     tag_set('user', $user->id, array());
3674     // unconditionally unenrol from all courses
3675     enrol_user_delete($user);
3677     // unenrol from all roles in all contexts
3678     role_unassign_all(array('userid'=>$user->id)); // this might be slow but it is really needed - modules might do some extra cleanup!
3680     //now do a brute force cleanup
3682     // remove from all cohorts
3683     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3685     // remove from all groups
3686     $DB->delete_records('groups_members', array('userid'=>$user->id));
3688     // brute force unenrol from all courses
3689     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3691     // purge user preferences
3692     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3694     // purge user extra profile info
3695     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3697     // last course access not necessary either
3698     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3700     // force logout - may fail if file based sessions used, sorry
3701     session_kill_user($user->id);
3703     // now do a final accesslib cleanup - removes all role assignments in user context and context itself
3704     delete_context(CONTEXT_USER, $user->id);
3706     // workaround for bulk deletes of users with the same email address
3707     $delname = "$user->email.".time();
3708     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3709         $delname++;
3710     }
3712     // mark internal user record as "deleted"
3713     $updateuser = new stdClass();
3714     $updateuser->id           = $user->id;
3715     $updateuser->deleted      = 1;
3716     $updateuser->username     = $delname;            // Remember it just in case
3717     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3718     $updateuser->idnumber     = '';                  // Clear this field to free it up
3719     $updateuser->timemodified = time();
3721     $DB->update_record('user', $updateuser);
3723     // notify auth plugin - do not block the delete even when plugin fails
3724     $authplugin = get_auth_plugin($user->auth);
3725     $authplugin->user_delete($user);
3727     // any plugin that needs to cleanup should register this event
3728     events_trigger('user_deleted', $user);
3730     return true;
3733 /**
3734  * Retrieve the guest user object
3735  *
3736  * @global object
3737  * @global object
3738  * @return user A {@link $USER} object
3739  */
3740 function guest_user() {
3741     global $CFG, $DB;
3743     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
3744         $newuser->confirmed = 1;
3745         $newuser->lang = $CFG->lang;
3746         $newuser->lastip = getremoteaddr();
3747     }
3749     return $newuser;
3752 /**
3753  * Authenticates a user against the chosen authentication mechanism
3754  *
3755  * Given a username and password, this function looks them
3756  * up using the currently selected authentication mechanism,
3757  * and if the authentication is successful, it returns a
3758  * valid $user object from the 'user' table.
3759  *
3760  * Uses auth_ functions from the currently active auth module
3761  *
3762  * After authenticate_user_login() returns success, you will need to
3763  * log that the user has logged in, and call complete_user_login() to set
3764  * the session up.
3765  *
3766  * Note: this function works only with non-mnet accounts!
3767  *
3768  * @param string $username  User's username
3769  * @param string $password  User's password
3770  * @return user|flase A {@link $USER} object or false if error
3771  */
3772 function authenticate_user_login($username, $password) {
3773     global $CFG, $DB;
3775     $authsenabled = get_enabled_auth_plugins();
3777     if ($user = get_complete_user_data('username', $username, $CFG->mnet_localhost_id)) {
3778         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3779         if (!empty($user->suspended)) {
3780             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3781             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3782             return false;
3783         }
3784         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3785             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3786             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3787             return false;
3788         }
3789         $auths = array($auth);
3791     } else {
3792         // check if there's a deleted record (cheaply)
3793         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
3794             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3795             return false;
3796         }
3798         // User does not exist
3799         $auths = $authsenabled;
3800         $user = new stdClass();
3801         $user->id = 0;
3802     }
3804     foreach ($auths as $auth) {
3805         $authplugin = get_auth_plugin($auth);
3807         // on auth fail fall through to the next plugin
3808         if (!$authplugin->user_login($username, $password)) {
3809             continue;
3810         }
3812         // successful authentication
3813         if ($user->id) {                          // User already exists in database
3814             if (empty($user->auth)) {             // For some reason auth isn't set yet
3815                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3816                 $user->auth = $auth;
3817             }
3818             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3819                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3820                 $user->firstaccess = $user->timemodified;
3821             }
3823             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3825             if ($authplugin->is_synchronised_with_external()) { // update user record from external DB
3826                 $user = update_user_record($username);
3827             }
3828         } else {
3829             // if user not found and user creation is not disabled, create it
3830             if (empty($CFG->authpreventaccountcreation)) {
3831                 $user = create_user_record($username, $password, $auth);
3832             } else {
3833                 continue;
3834             }
3835         }
3837         $authplugin->sync_roles($user);
3839         foreach ($authsenabled as $hau) {
3840             $hauth = get_auth_plugin($hau);
3841             $hauth->user_authenticated_hook($user, $username, $password);
3842         }
3844         if (empty($user->id)) {
3845             return false;
3846         }
3848         if (!empty($user->suspended)) {
3849             // just in case some auth plugin suspended account
3850             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3851             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3852             return false;
3853         }
3855         return $user;
3856     }
3858     // failed if all the plugins have failed
3859     add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3860     if (debugging('', DEBUG_ALL)) {
3861         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3862     }
3863     return false;
3866 /**
3867  * Call to complete the user login process after authenticate_user_login()
3868  * has succeeded. It will setup the $USER variable and other required bits
3869  * and pieces.
3870  *
3871  * NOTE:
3872  * - It will NOT log anything -- up to the caller to decide what to log.
3873  * - this function does not set any cookies any more!
3874  *
3875  * @param object $user
3876  * @return object A {@link $USER} object - BC only, do not use
3877  */
3878 function complete_user_login($user) {
3879     global $CFG, $USER;
3881     // regenerate session id and delete old session,
3882     // this helps prevent session fixation attacks from the same domain
3883     session_regenerate_id(true);
3885     // check enrolments, load caps and setup $USER object
3886     session_set_user($user);
3888     // reload preferences from DB
3889     unset($user->preference);
3890     check_user_preferences_loaded($user);
3892     // update login times
3893     update_user_login_times();
3895     // extra session prefs init
3896     set_login_session_preferences();
3898     if (isguestuser()) {
3899         // no need to continue when user is THE guest
3900         return $USER;
3901     }
3903     /// Select password change url
3904     $userauth = get_auth_plugin($USER->auth);
3906     /// check whether the user should be changing password
3907     if (get_user_preferences('auth_forcepasswordchange', false)){
3908         if ($userauth->can_change_password()) {
3909             if ($changeurl = $userauth->change_password_url()) {
3910                 redirect($changeurl);
3911             } else {
3912                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3913             }
3914         } else {
3915             print_error('nopasswordchangeforced', 'auth');
3916         }
3917     }
3918     return $USER;
3921 /**
3922  * Compare password against hash stored in internal user table.
3923  * If necessary it also updates the stored hash to new format.
3924  *
3925  * @param stdClass $user (password property may be updated)
3926  * @param string $password plain text password
3927  * @return bool is password valid?
3928  */
3929 function validate_internal_user_password($user, $password) {
3930     global $CFG;
3932     if (!isset($CFG->passwordsaltmain)) {
3933         $CFG->passwordsaltmain = '';
3934     }
3936     $validated = false;
3938     if ($user->password === 'not cached') {
3939         // internal password is not used at all, it can not validate
3941     } else if ($user->password === md5($password.$CFG->passwordsaltmain)
3942             or $user->password === md5($password)
3943             or $user->password === md5(addslashes($password).$CFG->passwordsaltmain)
3944             or $user->password === md5(addslashes($password))) {
3945         // note: we are intentionally using the addslashes() here because we
3946         //       need to accept old password hashes of passwords with magic quotes
3947         $validated = true;
3949     } else {
3950         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3951             $alt = 'passwordsaltalt'.$i;
3952             if (!empty($CFG->$alt)) {
3953                 if ($user->password === md5($password.$CFG->$alt) or $user->password === md5(addslashes($password).$CFG->$alt)) {
3954                     $validated = true;
3955                     break;
3956                 }
3957             }
3958         }
3959     }
3961     if ($validated) {
3962         // force update of password hash using latest main password salt and encoding if needed
3963         update_internal_user_password($user, $password);
3964     }
3966     return $validated;
3969 /**
3970  * Calculate hashed value from password using current hash mechanism.
3971  *
3972  * @param string $password
3973  * @return string password hash
3974  */
3975 function hash_internal_user_password($password) {
3976     global $CFG;
3978     if (isset($CFG->passwordsaltmain)) {
3979         return md5($password.$CFG->passwordsaltmain);
3980     } else {
3981         return md5($password);
3982     }
3985 /**
3986  * Update password hash in user object.
3987  *
3988  * @param stdClass $user (password property may be updated)
3989  * @param string $password plain text password
3990  * @return bool always returns true
3991  */
3992 function update_internal_user_password($user, $password) {
3993     global $DB;
3995     $authplugin = get_auth_plugin($user->auth);
3996     if ($authplugin->prevent_local_passwords()) {
3997         $hashedpassword = 'not cached';
3998     } else {
3999         $hashedpassword = hash_internal_user_password($password);
4000     }
4002     if ($user->password !== $hashedpassword) {
4003         $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
4004         $user->password = $hashedpassword;
4005     }
4007     return true;
4010 /**
4011  * Get a complete user record, which includes all the info
4012  * in the user record.
4013  *
4014  * Intended for setting as $USER session variable
4015  *
4016  * @param string $field The user field to be checked for a given value.
4017  * @param string $value The value to match for $field.
4018  * @param int $mnethostid
4019  * @return mixed False, or A {@link $USER} object.
4020  */
4021 function get_complete_user_data($field, $value, $mnethostid = null) {
4022     global $CFG, $DB;
4024     if (!$field || !$value) {
4025         return false;
4026     }
4028 /// Build the WHERE clause for an SQL query
4029     $params = array('fieldval'=>$value);
4030     $constraints = "$field = :fieldval AND deleted <> 1";
4032     // If we are loading user data based on anything other than id,
4033     // we must also restrict our search based on mnet host.
4034     if ($field != 'id') {
4035         if (empty($mnethostid)) {
4036             // if empty, we restrict to local users
4037             $mnethostid = $CFG->mnet_localhost_id;
4038         }
4039     }
4040     if (!empty($mnethostid)) {
4041         $params['mnethostid'] = $mnethostid;
4042         $constraints .= " AND mnethostid = :mnethostid";
4043     }
4045 /// Get all the basic user data
4047     if (! $user = $DB->get_record_select('user', $constraints, $params)) {
4048         return false;
4049     }
4051 /// Get various settings and preferences
4053     // preload preference cache
4054     check_user_preferences_loaded($user);
4056     // load course enrolment related stuff
4057     $user->lastcourseaccess    = array(); // during last session
4058     $user->currentcourseaccess = array(); // during current session
4059     if ($lastaccesses = $DB->get_records('user_lastaccess', array('userid'=>$user->id))) {
4060         foreach ($lastaccesses as $lastaccess) {
4061             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
4062         }
4063     }
4065     $sql = "SELECT g.id, g.courseid
4066               FROM {groups} g, {groups_members} gm
4067              WHERE gm.groupid=g.id AND gm.userid=?";
4069     // this is a special hack to speedup calendar display
4070     $user->groupmember = array();
4071     if (!isguestuser($user)) {
4072         if ($groups = $DB->get_records_sql($sql, array($user->id))) {
4073             foreach ($groups as $group) {
4074                 if (!array_key_exists($group->courseid, $user->groupmember)) {
4075                     $user->groupmember[$group->courseid] = array();
4076                 }
4077                 $user->groupmember[$group->courseid][$group->id] = $group->id;
4078             }
4079         }
4080     }
4082 /// Add the custom profile fields to the user record
4083     $user->profile = array();
4084     if (!isguestuser($user)) {
4085         require_once($CFG->dirroot.'/user/profile/lib.php');
4086         profile_load_custom_fields($user);
4087     }
4089 /// Rewrite some variables if necessary
4090     if (!empty($user->description)) {
4091         $user->description = true;   // No need to cart all of it around
4092     }
4093     if (isguestuser($user)) {
4094         $user->lang       = $CFG->lang;               // Guest language always same as site
4095         $user->firstname  = get_string('guestuser');  // Name always in current language
4096         $user->lastname   = ' ';
4097     }
4099     return $user;
4102 /**
4103  * Validate a password against the configured password policy
4104  *
4105  * @global object
4106  * @param string $password the password to be checked against the password policy
4107  * @param string $errmsg the error message to display when the password doesn't comply with the policy.
4108  * @return bool true if the password is valid according to the policy. false otherwise.
4109  */
4110 function check_password_policy($password, &$errmsg) {
4111     global $CFG;
4113     if (empty($CFG->passwordpolicy)) {
4114         return true;
4115     }
4117     $textlib = textlib_get_instance();
4118     $errmsg = '';
4119     if ($textlib->strlen($password) < $CFG->minpasswordlength) {
4120         $errmsg .= '<div>'. get_string('errorminpasswordlength', 'auth', $CFG->minpasswordlength) .'</div>';
4122     }
4123     if (preg_match_all('/[[:digit:]]/u', $password, $matches) < $CFG->minpassworddigits) {
4124         $errmsg .= '<div>'. get_string('errorminpassworddigits', 'auth', $CFG->minpassworddigits) .'</div>';
4126     }
4127     if (preg_match_all('/[[:lower:]]/u', $password, $matches) < $CFG->minpasswordlower) {
4128         $errmsg .= '<div>'. get_string('errorminpasswordlower', 'auth', $CFG->minpasswordlower) .'</div>';
4130     }
4131     if (preg_match_all('/[[:upper:]]/u', $password, $matches) < $CFG->minpasswordupper) {
4132         $errmsg .= '<div>'. get_string('errorminpasswordupper', 'auth', $CFG->minpasswordupper) .'</div>';
4134     }
4135     if (preg_match_all('/[^[:upper:][:lower:][:digit:]]/u', $password, $matches) < $CFG->minpasswordnonalphanum) {
4136         $errmsg .= '<div>'. get_string('errorminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum) .'</div>';
4137     }
4138     if (!check_consecutive_identical_characters($password, $CFG->maxconsecutiveidentchars)) {
4139         $errmsg .= '<div>'. get_string('errormaxconsecutiveidentchars', 'auth', $CFG->maxconsecutiveidentchars) .'</div>';
4140     }
4142     if ($errmsg == '') {
4143         return true;
4144     } else {
4145         return false;
4146     }
4150 /**
4151  * When logging in, this function is run to set certain preferences
4152  * for the current SESSION
4153  *
4154  * @global object
4155  * @global object
4156  */
4157 function set_login_session_preferences() {
4158     global $SESSION, $CFG;
4160     $SESSION->justloggedin = true;
4162     unset($SESSION->lang);
4166 /**
4167  * Delete a course, including all related data from the database,
4168  * and any associated files.
4169  *
4170  * @global object
4171  * @global object
4172  * @param mixed $courseorid The id of the course or course object to delete.
4173  * @param bool $showfeedback Whether to display notifications of each action the function performs.
4174  * @return bool true if all the removals succeeded. false if there were any failures. If this
4175  *             method returns false, some of the removals will probably have succeeded, and others
4176  *             failed, but you have no way of knowing which.
4177  */
4178 function delete_course($courseorid, $showfeedback = true) {
4179     global $DB;
4181     if (is_object($courseorid)) {
4182         $courseid = $courseorid->id;
4183         $course   = $courseorid;
4184     } else {
4185         $courseid = $courseorid;
4186         if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
4187             return false;
4188         }
4189     }
4190     $context = get_context_instance(CONTEXT_COURSE, $courseid);
4192     // frontpage course can not be deleted!!
4193     if ($courseid == SITEID) {
4194         return false;
4195     }
4197     // make the course completely empty
4198     remove_course_contents($courseid, $showfeedback);
4200     // delete the course and related context instance
4201     delete_context(CONTEXT_COURSE, $courseid);
4202     $DB->delete_records("course", array("id"=>$courseid));
4204     //trigger events
4205     $course->context = $context; // you can not fetch context in the event because it was already deleted
4206     events_trigger('course_deleted', $course);
4208     return true;
4211 /**
4212  * Clear a course out completely, deleting all content
4213  * but don't delete the course itself.
4214  * This function does not verify any permissions.
4215  *
4216  * Please note this function also deletes all user enrolments,
4217  * enrolment instances and role assignments.
4218  *
4219  * @param int $courseid The id of the course that is being deleted
4220  * @param bool $showfeedback Whether to display notifications of each action the function performs.
4221  * @return bool true if all the removals succeeded. false if there were any failures. If this
4222  *             method returns false, some of the removals will probably have succeeded, and others
4223  *             failed, but you have no way of knowing which.
4224  */
4225 function remove_course_contents($courseid, $showfeedback = true) {
4226     global $CFG, $DB, $OUTPUT;
4227     require_once($CFG->libdir.'/completionlib.php');
4228     require_once($CFG->libdir.'/questionlib.php');
4229     require_once($CFG->libdir.'/gradelib.php');
4230     require_once($CFG->dirroot.'/group/lib.php');
4231     require_once($CFG->dirroot.'/tag/coursetagslib.php');
4233     $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
4234     $context = get_context_instance(CONTEXT_COURSE, $courseid, MUST_EXIST);
4236     $strdeleted = get_string('deleted');
4238     // Delete course completion information,
4239     // this has to be done before grades and enrols
4240     $cc = new completion_info($course);
4241     $cc->clear_criteria();
4243     // remove roles and enrolments
4244     role_unassign_all(array('contextid'=>$context->id), true);
4245     enrol_course_delete($course);
4247     // Clean up course formats (iterate through all formats in the even the course format was ever changed)
4248     $formats = get_plugin_list('format');
4249     foreach ($formats as $format=>$formatdir) {
4250         $formatdelete = 'format_'.$format.'_delete_course';
4251         $formatlib    = "$formatdir/lib.php";
4252         if (file_exists($formatlib)) {
4253             include_once($formatlib);
4254             if (function_exists($formatdelete)) {
4255                 if ($showfeedback) {
4256                     echo $OUTPUT->notification($strdeleted.' '.$format);
4257                 }
4258                 $formatdelete($course->id);
4259             }
4260         }
4261     }
4263     // Remove all data from gradebook - this needs to be done before course modules
4264     // because while deleting this information, the system may need to reference
4265     // the course modules that own the grades.
4266     remove_course_grades($courseid, $showfeedback);
4267     remove_grade_letters($context, $showfeedback);
4269     // Remove all data from availability and completion tables that is associated
4270     // with course-modules belonging to this course. Note this is done even if the
4271     // features are not enabled now, in case they were enabled previously
4272     $DB->delete_records_select('course_modules_completion',
4273            'coursemoduleid IN (SELECT id from {course_modules} WHERE course=?)',
4274            array($courseid));
4275     $DB->delete_records_select('course_modules_availability',
4276            'coursemoduleid IN (SELECT id from {course_modules} WHERE course=?)',
4277            array($courseid));
4279     // Delete course blocks - they may depend on modules so delete them first
4280     blocks_delete_all_for_context($context->id);
4282     // Delete every instance of every module
4283     if ($allmods = $DB->get_records('modules') ) {
4284         foreach ($allmods as $mod) {
4285             $modname = $mod->name;
4286             $modfile = $CFG->dirroot .'/mod/'. $modname .'/lib.php';
4287             $moddelete = $modname .'_delete_instance';       // Delete everything connected to an instance
4288             $moddeletecourse = $modname .'_delete_course';   // Delete other stray stuff (uncommon)
4289             $count=0;
4290             if (file_exists($modfile)) {
4291                 include_once($modfile);
4292                 if (function_exists($moddelete)) {
4293                     if ($instances = $DB->get_records($modname, array('course'=>$course->id))) {
4294                         foreach ($instances as $instance) {
4295                             if ($cm = get_coursemodule_from_instance($modname, $instance->id, $course->id)) {
4296                                 /// Delete activity context questions and question categories
4297                                 question_delete_activity($cm,  $showfeedback);
4298                             }
4299                             if ($moddelete($instance->id)) {
4300                                 $count++;
4302                             } else {
4303                                 echo $OUTPUT->notification('Could not delete '. $modname .' instance '. $instance->id .' ('. format_string($instance->name) .')');
4304                             }
4305                             if ($cm) {
4306                                 // delete cm and its context in correct order
4307                                 delete_context(CONTEXT_MODULE, $cm->id); // some callbacks may try to fetch context, better delete first
4308                                 $DB->delete_records('course_modules', array('id'=>$cm->id));
4309                             }
4310                         }
4311                     }
4312                 } else {
4313                     //note: we should probably delete these anyway
4314                     echo $OUTPUT->notification('Function '.$moddelete.'() doesn\'t exist!');
4315                 }
4317                 if (function_exists($moddeletecourse)) {
4318                     $moddeletecourse($course, $showfeedback);
4319                 }
4320             }
4321             if ($showfeedback) {
4322                 echo $OUTPUT->notification($strdeleted .' '. $count .' x '. $modname);
4323             }
4324         }
4325     }
4327     // Delete any groups, removing members and grouping/course links first.
4328     groups_delete_groupings($course->id, $showfeedback);
4329     groups_delete_groups($course->id, $showfeedback);
4331     // Delete questions and question categories
4332     question_delete_course($course, $showfeedback);
4334     // Delete course tags
4335     coursetag_delete_course_tags($course->id, $showfeedback);
4337     // Delete legacy files (just in case some files are still left there after conversion to new file api)
4338     fulldelete($CFG->dataroot.'/'.$course->id);
4340     // cleanup course record - remove links to delted stuff
4341     $oldcourse = new stdClass();
4342     $oldcourse->id                = $course->id;
4343     $oldcourse->summary           = '';
4344     $oldcourse->modinfo           = NULL;
4345     $oldcourse->legacyfiles       = 0;
4346     $oldcourse->defaultgroupingid = 0;
4347     $oldcourse->enablecompletion  = 0;
4348     $DB->update_record('course', $oldcourse);
4350     // Delete all related records in other tables that may have a courseid
4351     // This array stores the tables that need to be cleared, as
4352     // table_name => column_name that contains the course id.
4353     $tablestoclear = array(