30eb4212b6d86e4153005bfe4c65b5581cbef798
[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
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_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
277  */
278 define('PARAM_CLEANFILE', 'file');
280 /// Web Services ///
282 /**
283  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
284  */
285 define('VALUE_REQUIRED', 1);
287 /**
288  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
289  */
290 define('VALUE_OPTIONAL', 2);
292 /**
293  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
294  */
295 define('VALUE_DEFAULT', 0);
297 /**
298  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
299  */
300 define('NULL_NOT_ALLOWED', false);
302 /**
303  * NULL_ALLOWED - the parameter can be set to null in the database
304  */
305 define('NULL_ALLOWED', true);
307 /// Page types ///
308 /**
309  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
310  */
311 define('PAGE_COURSE_VIEW', 'course-view');
313 /** Get remote addr constant */
314 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
315 /** Get remote addr constant */
316 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
318 /// Blog access level constant declaration ///
319 define ('BLOG_USER_LEVEL', 1);
320 define ('BLOG_GROUP_LEVEL', 2);
321 define ('BLOG_COURSE_LEVEL', 3);
322 define ('BLOG_SITE_LEVEL', 4);
323 define ('BLOG_GLOBAL_LEVEL', 5);
326 ///Tag constants///
327 /**
328  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
329  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
330  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
331  *
332  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
333  */
334 define('TAG_MAX_LENGTH', 50);
336 /// Password policy constants ///
337 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
338 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
339 define ('PASSWORD_DIGITS', '0123456789');
340 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
342 /// Feature constants ///
343 // Used for plugin_supports() to report features that are, or are not, supported by a module.
345 /** True if module can provide a grade */
346 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
347 /** True if module supports outcomes */
348 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
350 /** True if module has code to track whether somebody viewed it */
351 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
352 /** True if module has custom completion rules */
353 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
355 /** True if module supports outcomes */
356 define('FEATURE_IDNUMBER', 'idnumber');
357 /** True if module supports groups */
358 define('FEATURE_GROUPS', 'groups');
359 /** True if module supports groupings */
360 define('FEATURE_GROUPINGS', 'groupings');
361 /** True if module supports groupmembersonly */
362 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
364 /** Type of module */
365 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
366 /** True if module supports intro editor */
367 define('FEATURE_MOD_INTRO', 'mod_intro');
368 /** True if module has default completion */
369 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
371 define('FEATURE_COMMENT', 'comment');
373 define('FEATURE_RATE', 'rate');
374 /** True if module supports backup/restore of moodle2 format */
375 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
377 /** Unspecified module archetype */
378 define('MOD_ARCHETYPE_OTHER', 0);
379 /** Resource-like type module */
380 define('MOD_ARCHETYPE_RESOURCE', 1);
381 /** Assignment module archetype */
382 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
384 /**
385  * Security token used for allowing access
386  * from external application such as web services.
387  * Scripts do not use any session, performance is relatively
388  * low because we need to load access info in each request.
389  * Scripts are executed in parallel.
390  */
391 define('EXTERNAL_TOKEN_PERMANENT', 0);
393 /**
394  * Security token used for allowing access
395  * of embedded applications, the code is executed in the
396  * active user session. Token is invalidated after user logs out.
397  * Scripts are executed serially - normal session locking is used.
398  */
399 define('EXTERNAL_TOKEN_EMBEDDED', 1);
401 /**
402  * The home page should be the site home
403  */
404 define('HOMEPAGE_SITE', 0);
405 /**
406  * The home page should be the users my page
407  */
408 define('HOMEPAGE_MY', 1);
409 /**
410  * The home page can be chosen by the user
411  */
412 define('HOMEPAGE_USER', 2);
414 /**
415  * Hub directory url (should be moodle.org)
416  */
417 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
420 /**
421  * Moodle.org url (should be moodle.org)
422  */
423 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
426 /// PARAMETER HANDLING ////////////////////////////////////////////////////
428 /**
429  * Returns a particular value for the named variable, taken from
430  * POST or GET.  If the parameter doesn't exist then an error is
431  * thrown because we require this variable.
432  *
433  * This function should be used to initialise all required values
434  * in a script that are based on parameters.  Usually it will be
435  * used like this:
436  *    $id = required_param('id', PARAM_INT);
437  *
438  * Please note the $type parameter is now required,
439  * for now PARAM_CLEAN is used for backwards compatibility only.
440  *
441  * @param string $parname the name of the page parameter we want
442  * @param string $type expected type of parameter
443  * @return mixed
444  */
445 function required_param($parname, $type) {
446     if (!isset($type)) {
447         debugging('required_param() requires $type to be specified.');
448         $type = PARAM_CLEAN; // for now let's use this deprecated type
449     }
450     if (isset($_POST[$parname])) {       // POST has precedence
451         $param = $_POST[$parname];
452     } else if (isset($_GET[$parname])) {
453         $param = $_GET[$parname];
454     } else {
455         print_error('missingparam', '', '', $parname);
456     }
458     return clean_param($param, $type);
461 /**
462  * Returns a particular value for the named variable, taken from
463  * POST or GET, otherwise returning a given default.
464  *
465  * This function should be used to initialise all optional values
466  * in a script that are based on parameters.  Usually it will be
467  * used like this:
468  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
469  *
470  * Please note $default and $type parameters are now required,
471  * for now PARAM_CLEAN is used for backwards compatibility only.
472  *
473  * @param string $parname the name of the page parameter we want
474  * @param mixed  $default the default value to return if nothing is found
475  * @param string $type expected type of parameter
476  * @return mixed
477  */
478 function optional_param($parname, $default, $type) {
479     if (!isset($type)) {
480         debugging('optional_param() requires $default and $type to be specified.');
481         $type = PARAM_CLEAN; // for now let's use this deprecated type
482     }
483     if (!isset($default)) {
484         $default = null;
485     }
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         return $default;
493     }
495     return clean_param($param, $type);
498 /**
499  * Strict validation of parameter values, the values are only converted
500  * to requested PHP type. Internally it is using clean_param, the values
501  * before and after cleaning must be equal - otherwise
502  * an invalid_parameter_exception is thrown.
503  * Objects and classes are not accepted.
504  *
505  * @param mixed $param
506  * @param int $type PARAM_ constant
507  * @param bool $allownull are nulls valid value?
508  * @param string $debuginfo optional debug information
509  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
510  */
511 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
512     if (is_null($param)) {
513         if ($allownull == NULL_ALLOWED) {
514             return null;
515         } else {
516             throw new invalid_parameter_exception($debuginfo);
517         }
518     }
519     if (is_array($param) or is_object($param)) {
520         throw new invalid_parameter_exception($debuginfo);
521     }
523     $cleaned = clean_param($param, $type);
524     if ((string)$param !== (string)$cleaned) {
525         // conversion to string is usually lossless
526         throw new invalid_parameter_exception($debuginfo);
527     }
529     return $cleaned;
532 /**
533  * Used by {@link optional_param()} and {@link required_param()} to
534  * clean the variables and/or cast to specific types, based on
535  * an options field.
536  * <code>
537  * $course->format = clean_param($course->format, PARAM_ALPHA);
538  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
539  * </code>
540  *
541  * @param mixed $param the variable we are cleaning
542  * @param int $type expected format of param after cleaning.
543  * @return mixed
544  */
545 function clean_param($param, $type) {
547     global $CFG;
549     if (is_array($param)) {              // Let's loop
550         $newparam = array();
551         foreach ($param as $key => $value) {
552             $newparam[$key] = clean_param($value, $type);
553         }
554         return $newparam;
555     }
557     switch ($type) {
558         case PARAM_RAW:          // no cleaning at all
559             return $param;
561         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
562             return trim($param);
564         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
565             // this is deprecated!, please use more specific type instead
566             if (is_numeric($param)) {
567                 return $param;
568             }
569             return clean_text($param);     // Sweep for scripts, etc
571         case PARAM_CLEANHTML:    // clean html fragment
572             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
573             return trim($param);
575         case PARAM_INT:
576             return (int)$param;  // Convert to integer
578         case PARAM_FLOAT:
579         case PARAM_NUMBER:
580             return (float)$param;  // Convert to float
582         case PARAM_ALPHA:        // Remove everything not a-z
583             return preg_replace('/[^a-zA-Z]/i', '', $param);
585         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
586             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
588         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
589             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
591         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
592             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
594         case PARAM_SEQUENCE:     // Remove everything not 0-9,
595             return preg_replace('/[^0-9,]/i', '', $param);
597         case PARAM_BOOL:         // Convert to 1 or 0
598             $tempstr = strtolower($param);
599             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
600                 $param = 1;
601             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
602                 $param = 0;
603             } else {
604                 $param = empty($param) ? 0 : 1;
605             }
606             return $param;
608         case PARAM_NOTAGS:       // Strip all tags
609             return strip_tags($param);
611         case PARAM_TEXT:    // leave only tags needed for multilang
612             // if the multilang syntax is not correct we strip all tags
613             // because it would break xhtml strict which is required for accessibility standards
614             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
615             do {
616                 if (strpos($param, '</lang>') !== false) {
617                     // old and future mutilang syntax
618                     $param = strip_tags($param, '<lang>');
619                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
620                         break;
621                     }
622                     $open = false;
623                     foreach ($matches[0] as $match) {
624                         if ($match === '</lang>') {
625                             if ($open) {
626                                 $open = false;
627                                 continue;
628                             } else {
629                                 break 2;
630                             }
631                         }
632                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
633                             break 2;
634                         } else {
635                             $open = true;
636                         }
637                     }
638                     if ($open) {
639                         break;
640                     }
641                     return $param;
643                 } else if (strpos($param, '</span>') !== false) {
644                     // current problematic multilang syntax
645                     $param = strip_tags($param, '<span>');
646                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
647                         break;
648                     }
649                     $open = false;
650                     foreach ($matches[0] as $match) {
651                         if ($match === '</span>') {
652                             if ($open) {
653                                 $open = false;
654                                 continue;
655                             } else {
656                                 break 2;
657                             }
658                         }
659                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
660                             break 2;
661                         } else {
662                             $open = true;
663                         }
664                     }
665                     if ($open) {
666                         break;
667                     }
668                     return $param;
669                 }
670             } while (false);
671             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
672             return strip_tags($param);
674         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
675             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
677         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
678             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
680         case PARAM_FILE:         // Strip all suspicious characters from filename
681             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
682             $param = preg_replace('~\.\.+~', '', $param);
683             if ($param === '.') {
684                 $param = '';
685             }
686             return $param;
688         case PARAM_PATH:         // Strip all suspicious characters from file path
689             $param = str_replace('\\', '/', $param);
690             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
691             $param = preg_replace('~\.\.+~', '', $param);
692             $param = preg_replace('~//+~', '/', $param);
693             return preg_replace('~/(\./)+~', '/', $param);
695         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
696             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
697             // match ipv4 dotted quad
698             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
699                 // confirm values are ok
700                 if ( $match[0] > 255
701                      || $match[1] > 255
702                      || $match[3] > 255
703                      || $match[4] > 255 ) {
704                     // hmmm, what kind of dotted quad is this?
705                     $param = '';
706                 }
707             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
708                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
709                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
710                        ) {
711                 // all is ok - $param is respected
712             } else {
713                 // all is not ok...
714                 $param='';
715             }
716             return $param;
718         case PARAM_URL:          // allow safe ftp, http, mailto urls
719             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
720             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
721                 // all is ok, param is respected
722             } else {
723                 $param =''; // not really ok
724             }
725             return $param;
727         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
728             $param = clean_param($param, PARAM_URL);
729             if (!empty($param)) {
730                 if (preg_match(':^/:', $param)) {
731                     // root-relative, ok!
732                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
733                     // absolute, and matches our wwwroot
734                 } else {
735                     // relative - let's make sure there are no tricks
736                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
737                         // looks ok.
738                     } else {
739                         $param = '';
740                     }
741                 }
742             }
743             return $param;
745         case PARAM_PEM:
746             $param = trim($param);
747             // PEM formatted strings may contain letters/numbers and the symbols
748             // forward slash: /
749             // plus sign:     +
750             // equal sign:    =
751             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
752             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
753                 list($wholething, $body) = $matches;
754                 unset($wholething, $matches);
755                 $b64 = clean_param($body, PARAM_BASE64);
756                 if (!empty($b64)) {
757                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
758                 } else {
759                     return '';
760                 }
761             }
762             return '';
764         case PARAM_BASE64:
765             if (!empty($param)) {
766                 // PEM formatted strings may contain letters/numbers and the symbols
767                 // forward slash: /
768                 // plus sign:     +
769                 // equal sign:    =
770                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
771                     return '';
772                 }
773                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
774                 // Each line of base64 encoded data must be 64 characters in
775                 // length, except for the last line which may be less than (or
776                 // equal to) 64 characters long.
777                 for ($i=0, $j=count($lines); $i < $j; $i++) {
778                     if ($i + 1 == $j) {
779                         if (64 < strlen($lines[$i])) {
780                             return '';
781                         }
782                         continue;
783                     }
785                     if (64 != strlen($lines[$i])) {
786                         return '';
787                     }
788                 }
789                 return implode("\n",$lines);
790             } else {
791                 return '';
792             }
794         case PARAM_TAG:
795             //as long as magic_quotes_gpc is used, a backslash will be a
796             //problem, so remove *all* backslash.
797             //$param = str_replace('\\', '', $param);
798             //remove some nasties
799             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
800             //convert many whitespace chars into one
801             $param = preg_replace('/\s+/', ' ', $param);
802             $textlib = textlib_get_instance();
803             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
804             return $param;
807         case PARAM_TAGLIST:
808             $tags = explode(',', $param);
809             $result = array();
810             foreach ($tags as $tag) {
811                 $res = clean_param($tag, PARAM_TAG);
812                 if ($res !== '') {
813                     $result[] = $res;
814                 }
815             }
816             if ($result) {
817                 return implode(',', $result);
818             } else {
819                 return '';
820             }
822         case PARAM_CAPABILITY:
823             if (get_capability_info($param)) {
824                 return $param;
825             } else {
826                 return '';
827             }
829         case PARAM_PERMISSION:
830             $param = (int)$param;
831             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
832                 return $param;
833             } else {
834                 return CAP_INHERIT;
835             }
837         case PARAM_AUTH:
838             $param = clean_param($param, PARAM_SAFEDIR);
839             if (exists_auth_plugin($param)) {
840                 return $param;
841             } else {
842                 return '';
843             }
845         case PARAM_LANG:
846             $param = clean_param($param, PARAM_SAFEDIR);
847             if (get_string_manager()->translation_exists($param)) {
848                 return $param;
849             } else {
850                 return ''; // Specified language is not installed or param malformed
851             }
853         case PARAM_THEME:
854             $param = clean_param($param, PARAM_SAFEDIR);
855             if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
856                 return $param;
857             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
858                 return $param;
859             } else {
860                 return '';  // Specified theme is not installed
861             }
863         case PARAM_USERNAME:
864             $param = str_replace(" " , "", $param);
865             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
866             if (empty($CFG->extendedusernamechars)) {
867                 // regular expression, eliminate all chars EXCEPT:
868                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
869                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
870             }
871             return $param;
873         case PARAM_EMAIL:
874             if (validate_email($param)) {
875                 return $param;
876             } else {
877                 return '';
878             }
880         case PARAM_STRINGID:
881             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
882                 return $param;
883             } else {
884                 return '';
885             }
887         default:                 // throw error, switched parameters in optional_param or another serious problem
888             print_error("unknownparamtype", '', '', $type);
889     }
892 /**
893  * Return true if given value is integer or string with integer value
894  *
895  * @param mixed $value String or Int
896  * @return bool true if number, false if not
897  */
898 function is_number($value) {
899     if (is_int($value)) {
900         return true;
901     } else if (is_string($value)) {
902         return ((string)(int)$value) === $value;
903     } else {
904         return false;
905     }
908 /**
909  * Returns host part from url
910  * @param string $url full url
911  * @return string host, null if not found
912  */
913 function get_host_from_url($url) {
914     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
915     if ($matches) {
916         return $matches[1];
917     }
918     return null;
921 /**
922  * Tests whether anything was returned by text editor
923  *
924  * This function is useful for testing whether something you got back from
925  * the HTML editor actually contains anything. Sometimes the HTML editor
926  * appear to be empty, but actually you get back a <br> tag or something.
927  *
928  * @param string $string a string containing HTML.
929  * @return boolean does the string contain any actual content - that is text,
930  * images, objects, etc.
931  */
932 function html_is_blank($string) {
933     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
936 /**
937  * Set a key in global configuration
938  *
939  * Set a key/value pair in both this session's {@link $CFG} global variable
940  * and in the 'config' database table for future sessions.
941  *
942  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
943  * In that case it doesn't affect $CFG.
944  *
945  * A NULL value will delete the entry.
946  *
947  * @global object
948  * @global object
949  * @param string $name the key to set
950  * @param string $value the value to set (without magic quotes)
951  * @param string $plugin (optional) the plugin scope, default NULL
952  * @return bool true or exception
953  */
954 function set_config($name, $value, $plugin=NULL) {
955     global $CFG, $DB;
957     if (empty($plugin)) {
958         if (!array_key_exists($name, $CFG->config_php_settings)) {
959             // So it's defined for this invocation at least
960             if (is_null($value)) {
961                 unset($CFG->$name);
962             } else {
963                 $CFG->$name = (string)$value; // settings from db are always strings
964             }
965         }
967         if ($DB->get_field('config', 'name', array('name'=>$name))) {
968             if ($value === null) {
969                 $DB->delete_records('config', array('name'=>$name));
970             } else {
971                 $DB->set_field('config', 'value', $value, array('name'=>$name));
972             }
973         } else {
974             if ($value !== null) {
975                 $config = new stdClass();
976                 $config->name  = $name;
977                 $config->value = $value;
978                 $DB->insert_record('config', $config, false);
979             }
980         }
982     } else { // plugin scope
983         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
984             if ($value===null) {
985                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
986             } else {
987                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
988             }
989         } else {
990             if ($value !== null) {
991                 $config = new stdClass();
992                 $config->plugin = $plugin;
993                 $config->name   = $name;
994                 $config->value  = $value;
995                 $DB->insert_record('config_plugins', $config, false);
996             }
997         }
998     }
1000     return true;
1003 /**
1004  * Get configuration values from the global config table
1005  * or the config_plugins table.
1006  *
1007  * If called with one parameter, it will load all the config
1008  * variables for one plugin, and return them as an object.
1009  *
1010  * If called with 2 parameters it will return a string single
1011  * value or false if the value is not found.
1012  *
1013  * @param string $plugin full component name
1014  * @param string $name default NULL
1015  * @return mixed hash-like object or single value, return false no config found
1016  */
1017 function get_config($plugin, $name = NULL) {
1018     global $CFG, $DB;
1020     // normalise component name
1021     if ($plugin === 'moodle' or $plugin === 'core') {
1022         $plugin = NULL;
1023     }
1025     if (!empty($name)) { // the user is asking for a specific value
1026         if (!empty($plugin)) {
1027             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1028                 // setting forced in config file
1029                 return $CFG->forced_plugin_settings[$plugin][$name];
1030             } else {
1031                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1032             }
1033         } else {
1034             if (array_key_exists($name, $CFG->config_php_settings)) {
1035                 // setting force in config file
1036                 return $CFG->config_php_settings[$name];
1037             } else {
1038                 return $DB->get_field('config', 'value', array('name'=>$name));
1039             }
1040         }
1041     }
1043     // the user is after a recordset
1044     if ($plugin) {
1045         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1046         if (isset($CFG->forced_plugin_settings[$plugin])) {
1047             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1048                 if (is_null($v) or is_array($v) or is_object($v)) {
1049                     // we do not want any extra mess here, just real settings that could be saved in db
1050                     unset($localcfg[$n]);
1051                 } else {
1052                     //convert to string as if it went through the DB
1053                     $localcfg[$n] = (string)$v;
1054                 }
1055             }
1056         }
1057         if ($localcfg) {
1058             return (object)$localcfg;
1059         } else {
1060             return null;
1061         }
1063     } else {
1064         // this part is not really used any more, but anyway...
1065         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1066         foreach($CFG->config_php_settings as $n=>$v) {
1067             if (is_null($v) or is_array($v) or is_object($v)) {
1068                 // we do not want any extra mess here, just real settings that could be saved in db
1069                 unset($localcfg[$n]);
1070             } else {
1071                 //convert to string as if it went through the DB
1072                 $localcfg[$n] = (string)$v;
1073             }
1074         }
1075         return (object)$localcfg;
1076     }
1079 /**
1080  * Removes a key from global configuration
1081  *
1082  * @param string $name the key to set
1083  * @param string $plugin (optional) the plugin scope
1084  * @global object
1085  * @return boolean whether the operation succeeded.
1086  */
1087 function unset_config($name, $plugin=NULL) {
1088     global $CFG, $DB;
1090     if (empty($plugin)) {
1091         unset($CFG->$name);
1092         $DB->delete_records('config', array('name'=>$name));
1093     } else {
1094         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1095     }
1097     return true;
1100 /**
1101  * Remove all the config variables for a given plugin.
1102  *
1103  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1104  * @return boolean whether the operation succeeded.
1105  */
1106 function unset_all_config_for_plugin($plugin) {
1107     global $DB;
1108     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1109     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
1110     return true;
1113 /**
1114  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1115  *
1116  * All users are verified if they still have the necessary capability.
1117  *
1118  * @param string $value the value of the config setting.
1119  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1120  * @param bool $include admins, include administrators
1121  * @return array of user objects.
1122  */
1123 function get_users_from_config($value, $capability, $includeadmins = true) {
1124     global $CFG, $DB;
1126     if (empty($value) or $value === '$@NONE@$') {
1127         return array();
1128     }
1130     // we have to make sure that users still have the necessary capability,
1131     // it should be faster to fetch them all first and then test if they are present
1132     // instead of validating them one-by-one
1133     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1134     if ($includeadmins) {
1135         $admins = get_admins();
1136         foreach ($admins as $admin) {
1137             $users[$admin->id] = $admin;
1138         }
1139     }
1141     if ($value === '$@ALL@$') {
1142         return $users;
1143     }
1145     $result = array(); // result in correct order
1146     $allowed = explode(',', $value);
1147     foreach ($allowed as $uid) {
1148         if (isset($users[$uid])) {
1149             $user = $users[$uid];
1150             $result[$user->id] = $user;
1151         }
1152     }
1154     return $result;
1158 /**
1159  * Invalidates browser caches and cached data in temp
1160  * @return void
1161  */
1162 function purge_all_caches() {
1163     global $CFG;
1165     reset_text_filters_cache();
1166     js_reset_all_caches();
1167     theme_reset_all_caches();
1168     get_string_manager()->reset_caches();
1170     // purge all other caches: rss, simplepie, etc.
1171     remove_dir($CFG->dataroot.'/cache', true);
1173     // make sure cache dir is writable, throws exception if not
1174     make_upload_directory('cache');
1176     clearstatcache();
1179 /**
1180  * Get volatile flags
1181  *
1182  * @param string $type
1183  * @param int    $changedsince default null
1184  * @return records array
1185  */
1186 function get_cache_flags($type, $changedsince=NULL) {
1187     global $DB;
1189     $params = array('type'=>$type, 'expiry'=>time());
1190     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1191     if ($changedsince !== NULL) {
1192         $params['changedsince'] = $changedsince;
1193         $sqlwhere .= " AND timemodified > :changedsince";
1194     }
1195     $cf = array();
1197     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1198         foreach ($flags as $flag) {
1199             $cf[$flag->name] = $flag->value;
1200         }
1201     }
1202     return $cf;
1205 /**
1206  * Get volatile flags
1207  *
1208  * @param string $type
1209  * @param string $name
1210  * @param int    $changedsince default null
1211  * @return records array
1212  */
1213 function get_cache_flag($type, $name, $changedsince=NULL) {
1214     global $DB;
1216     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1218     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1219     if ($changedsince !== NULL) {
1220         $params['changedsince'] = $changedsince;
1221         $sqlwhere .= " AND timemodified > :changedsince";
1222     }
1224     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1227 /**
1228  * Set a volatile flag
1229  *
1230  * @param string $type the "type" namespace for the key
1231  * @param string $name the key to set
1232  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1233  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1234  * @return bool Always returns true
1235  */
1236 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1237     global $DB;
1239     $timemodified = time();
1240     if ($expiry===NULL || $expiry < $timemodified) {
1241         $expiry = $timemodified + 24 * 60 * 60;
1242     } else {
1243         $expiry = (int)$expiry;
1244     }
1246     if ($value === NULL) {
1247         unset_cache_flag($type,$name);
1248         return true;
1249     }
1251     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1252         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1253             return true; //no need to update; helps rcache too
1254         }
1255         $f->value        = $value;
1256         $f->expiry       = $expiry;
1257         $f->timemodified = $timemodified;
1258         $DB->update_record('cache_flags', $f);
1259     } else {
1260         $f = new stdClass();
1261         $f->flagtype     = $type;
1262         $f->name         = $name;
1263         $f->value        = $value;
1264         $f->expiry       = $expiry;
1265         $f->timemodified = $timemodified;
1266         $DB->insert_record('cache_flags', $f);
1267     }
1268     return true;
1271 /**
1272  * Removes a single volatile flag
1273  *
1274  * @global object
1275  * @param string $type the "type" namespace for the key
1276  * @param string $name the key to set
1277  * @return bool
1278  */
1279 function unset_cache_flag($type, $name) {
1280     global $DB;
1281     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1282     return true;
1285 /**
1286  * Garbage-collect volatile flags
1287  *
1288  * @return bool Always returns true
1289  */
1290 function gc_cache_flags() {
1291     global $DB;
1292     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1293     return true;
1296 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1298 /**
1299  * Refresh user preference cache. This is used most often for $USER
1300  * object that is stored in session, but it also helps with performance in cron script.
1301  *
1302  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1303  *
1304  * @param stdClass $user user object, preferences are preloaded into ->preference property
1305  * @param int $cachelifetime cache life time on the current page (ins seconds)
1306  * @return void
1307  */
1308 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1309     global $DB;
1310     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1312     if (!isset($user->id)) {
1313         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1314     }
1316     if (empty($user->id) or isguestuser($user->id)) {
1317         // No permanent storage for not-logged-in users and guest
1318         if (!isset($user->preference)) {
1319             $user->preference = array();
1320         }
1321         return;
1322     }
1324     $timenow = time();
1326     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1327         // Already loaded at least once on this page. Are we up to date?
1328         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1329             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1330             return;
1332         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1333             // no change since the lastcheck on this page
1334             $user->preference['_lastloaded'] = $timenow;
1335             return;
1336         }
1337     }
1339     // OK, so we have to reload all preferences
1340     $loadedusers[$user->id] = true;
1341     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1342     $user->preference['_lastloaded'] = $timenow;
1345 /**
1346  * Called from set/delete_user_preferences, so that the prefs can
1347  * be correctly reloaded in different sessions.
1348  *
1349  * NOTE: internal function, do not call from other code.
1350  *
1351  * @param integer $userid the user whose prefs were changed.
1352  * @return void
1353  */
1354 function mark_user_preferences_changed($userid) {
1355     global $CFG;
1357     if (empty($userid) or isguestuser($userid)) {
1358         // no cache flags for guest and not-logged-in users
1359         return;
1360     }
1362     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1365 /**
1366  * Sets a preference for the specified user.
1367  *
1368  * If user object submitted, 'preference' property contains the preferences cache.
1369  *
1370  * @param string $name The key to set as preference for the specified user
1371  * @param string $value The value to set for the $name key in the specified user's record,
1372  *                      null means delete current value
1373  * @param stdClass|int $user A moodle user object or id, null means current user
1374  * @return bool always true or exception
1375  */
1376 function set_user_preference($name, $value, $user = null) {
1377     global $USER, $DB;
1379     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1380         throw new coding_exception('Invalid preference name in set_user_preference() call');
1381     }
1383     if (is_null($value)) {
1384         // null means delete current
1385         return unset_user_preference($name, $user);
1386     } else if (is_object($value)) {
1387         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1388     } else if (is_array($value)) {
1389         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1390     }
1391     $value = (string)$value;
1393     if (is_null($user)) {
1394         $user = $USER;
1395     } else if (isset($user->id)) {
1396         // $user is valid object
1397     } else if (is_numeric($user)) {
1398         $user = (object)array('id'=>(int)$user);
1399     } else {
1400         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1401     }
1403     check_user_preferences_loaded($user);
1405     if (empty($user->id) or isguestuser($user->id)) {
1406         // no permanent storage for not-logged-in users and guest
1407         $user->preference[$name] = $value;
1408         return true;
1409     }
1411     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1412         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1413             // preference already set to this value
1414             return true;
1415         }
1416         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1418     } else {
1419         $preference = new stdClass();
1420         $preference->userid = $user->id;
1421         $preference->name   = $name;
1422         $preference->value  = $value;
1423         $DB->insert_record('user_preferences', $preference);
1424     }
1426     // update value in cache
1427     $user->preference[$name] = $value;
1429     // set reload flag for other sessions
1430     mark_user_preferences_changed($user->id);
1432     return true;
1435 /**
1436  * Sets a whole array of preferences for the current user
1437  *
1438  * If user object submitted, 'preference' property contains the preferences cache.
1439  *
1440  * @param array $prefarray An array of key/value pairs to be set
1441  * @param stdClass|int $user A moodle user object or id, null means current user
1442  * @return bool always true or exception
1443  */
1444 function set_user_preferences(array $prefarray, $user = null) {
1445     foreach ($prefarray as $name => $value) {
1446         set_user_preference($name, $value, $user);
1447     }
1448     return true;
1451 /**
1452  * Unsets a preference completely by deleting it from the database
1453  *
1454  * If user object submitted, 'preference' property contains the preferences cache.
1455  *
1456  * @param string  $name The key to unset as preference for the specified user
1457  * @param stdClass|int $user A moodle user object or id, null means current user
1458  * @return bool always true or exception
1459  */
1460 function unset_user_preference($name, $user = null) {
1461     global $USER, $DB;
1463     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1464         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1465     }
1467     if (is_null($user)) {
1468         $user = $USER;
1469     } else if (isset($user->id)) {
1470         // $user is valid object
1471     } else if (is_numeric($user)) {
1472         $user = (object)array('id'=>(int)$user);
1473     } else {
1474         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1475     }
1477     check_user_preferences_loaded($user);
1479     if (empty($user->id) or isguestuser($user->id)) {
1480         // no permanent storage for not-logged-in user and guest
1481         unset($user->preference[$name]);
1482         return true;
1483     }
1485     // delete from DB
1486     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1488     // delete the preference from cache
1489     unset($user->preference[$name]);
1491     // set reload flag for other sessions
1492     mark_user_preferences_changed($user->id);
1494     return true;
1497 /**
1498  * Used to fetch user preference(s)
1499  *
1500  * If no arguments are supplied this function will return
1501  * all of the current user preferences as an array.
1502  *
1503  * If a name is specified then this function
1504  * attempts to return that particular preference value.  If
1505  * none is found, then the optional value $default is returned,
1506  * otherwise NULL.
1507  *
1508  * If user object submitted, 'preference' property contains the preferences cache.
1509  *
1510  * @param string $name Name of the key to use in finding a preference value
1511  * @param mixed $default Value to be returned if the $name key is not set in the user preferences
1512  * @param stdClass|int $user A moodle user object or id, null means current user
1513  * @return mixed string value or default
1514  */
1515 function get_user_preferences($name = null, $default = null, $user = null) {
1516     global $USER;
1518     if (is_null($name)) {
1519         // all prefs
1520     } else if (is_numeric($name) or $name === '_lastloaded') {
1521         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1522     }
1524     if (is_null($user)) {
1525         $user = $USER;
1526     } else if (isset($user->id)) {
1527         // $user is valid object
1528     } else if (is_numeric($user)) {
1529         $user = (object)array('id'=>(int)$user);
1530     } else {
1531         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1532     }
1534     check_user_preferences_loaded($user);
1536     if (empty($name)) {
1537         return $user->preference; // All values
1538     } else if (isset($user->preference[$name])) {
1539         return $user->preference[$name]; // The single string value
1540     } else {
1541         return $default; // Default value (null if not specified)
1542     }
1545 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1547 /**
1548  * Given date parts in user time produce a GMT timestamp.
1549  *
1550  * @todo Finish documenting this function
1551  * @param int $year The year part to create timestamp of
1552  * @param int $month The month part to create timestamp of
1553  * @param int $day The day part to create timestamp of
1554  * @param int $hour The hour part to create timestamp of
1555  * @param int $minute The minute part to create timestamp of
1556  * @param int $second The second part to create timestamp of
1557  * @param float $timezone Timezone modifier
1558  * @param bool $applydst Toggle Daylight Saving Time, default true
1559  * @return int timestamp
1560  */
1561 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1563     $strtimezone = NULL;
1564     if (!is_numeric($timezone)) {
1565         $strtimezone = $timezone;
1566     }
1568     $timezone = get_user_timezone_offset($timezone);
1570     if (abs($timezone) > 13) {
1571         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1572     } else {
1573         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1574         $time = usertime($time, $timezone);
1575         if($applydst) {
1576             $time -= dst_offset_on($time, $strtimezone);
1577         }
1578     }
1580     return $time;
1584 /**
1585  * Format a date/time (seconds) as weeks, days, hours etc as needed
1586  *
1587  * Given an amount of time in seconds, returns string
1588  * formatted nicely as weeks, days, hours etc as needed
1589  *
1590  * @uses MINSECS
1591  * @uses HOURSECS
1592  * @uses DAYSECS
1593  * @uses YEARSECS
1594  * @param int $totalsecs Time in seconds
1595  * @param object $str Should be a time object
1596  * @return string A nicely formatted date/time string
1597  */
1598  function format_time($totalsecs, $str=NULL) {
1600     $totalsecs = abs($totalsecs);
1602     if (!$str) {  // Create the str structure the slow way
1603         $str->day   = get_string('day');
1604         $str->days  = get_string('days');
1605         $str->hour  = get_string('hour');
1606         $str->hours = get_string('hours');
1607         $str->min   = get_string('min');
1608         $str->mins  = get_string('mins');
1609         $str->sec   = get_string('sec');
1610         $str->secs  = get_string('secs');
1611         $str->year  = get_string('year');
1612         $str->years = get_string('years');
1613     }
1616     $years     = floor($totalsecs/YEARSECS);
1617     $remainder = $totalsecs - ($years*YEARSECS);
1618     $days      = floor($remainder/DAYSECS);
1619     $remainder = $totalsecs - ($days*DAYSECS);
1620     $hours     = floor($remainder/HOURSECS);
1621     $remainder = $remainder - ($hours*HOURSECS);
1622     $mins      = floor($remainder/MINSECS);
1623     $secs      = $remainder - ($mins*MINSECS);
1625     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1626     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1627     $sh = ($hours == 1) ? $str->hour : $str->hours;
1628     $sd = ($days == 1)  ? $str->day  : $str->days;
1629     $sy = ($years == 1)  ? $str->year  : $str->years;
1631     $oyears = '';
1632     $odays = '';
1633     $ohours = '';
1634     $omins = '';
1635     $osecs = '';
1637     if ($years)  $oyears  = $years .' '. $sy;
1638     if ($days)  $odays  = $days .' '. $sd;
1639     if ($hours) $ohours = $hours .' '. $sh;
1640     if ($mins)  $omins  = $mins .' '. $sm;
1641     if ($secs)  $osecs  = $secs .' '. $ss;
1643     if ($years) return trim($oyears .' '. $odays);
1644     if ($days)  return trim($odays .' '. $ohours);
1645     if ($hours) return trim($ohours .' '. $omins);
1646     if ($mins)  return trim($omins .' '. $osecs);
1647     if ($secs)  return $osecs;
1648     return get_string('now');
1651 /**
1652  * Returns a formatted string that represents a date in user time
1653  *
1654  * Returns a formatted string that represents a date in user time
1655  * <b>WARNING: note that the format is for strftime(), not date().</b>
1656  * Because of a bug in most Windows time libraries, we can't use
1657  * the nicer %e, so we have to use %d which has leading zeroes.
1658  * A lot of the fuss in the function is just getting rid of these leading
1659  * zeroes as efficiently as possible.
1660  *
1661  * If parameter fixday = true (default), then take off leading
1662  * zero from %d, else maintain it.
1663  *
1664  * @param int $date the timestamp in UTC, as obtained from the database.
1665  * @param string $format strftime format. You should probably get this using
1666  *      get_string('strftime...', 'langconfig');
1667  * @param float $timezone by default, uses the user's time zone.
1668  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1669  *      If false then the leading zero is maintained.
1670  * @return string the formatted date/time.
1671  */
1672 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1674     global $CFG;
1676     $strtimezone = NULL;
1677     if (!is_numeric($timezone)) {
1678         $strtimezone = $timezone;
1679     }
1681     if (empty($format)) {
1682         $format = get_string('strftimedaydatetime', 'langconfig');
1683     }
1685     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1686         $fixday = false;
1687     } else if ($fixday) {
1688         $formatnoday = str_replace('%d', 'DD', $format);
1689         $fixday = ($formatnoday != $format);
1690     }
1692     $date += dst_offset_on($date, $strtimezone);
1694     $timezone = get_user_timezone_offset($timezone);
1696     if (abs($timezone) > 13) {   /// Server time
1697         if ($fixday) {
1698             $datestring = strftime($formatnoday, $date);
1699             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1700             $datestring = str_replace('DD', $daystring, $datestring);
1701         } else {
1702             $datestring = strftime($format, $date);
1703         }
1704     } else {
1705         $date += (int)($timezone * 3600);
1706         if ($fixday) {
1707             $datestring = gmstrftime($formatnoday, $date);
1708             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1709             $datestring = str_replace('DD', $daystring, $datestring);
1710         } else {
1711             $datestring = gmstrftime($format, $date);
1712         }
1713     }
1715 /// If we are running under Windows convert from windows encoding to UTF-8
1716 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1718    if ($CFG->ostype == 'WINDOWS') {
1719        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1720            $textlib = textlib_get_instance();
1721            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1722        }
1723    }
1725     return $datestring;
1728 /**
1729  * Given a $time timestamp in GMT (seconds since epoch),
1730  * returns an array that represents the date in user time
1731  *
1732  * @todo Finish documenting this function
1733  * @uses HOURSECS
1734  * @param int $time Timestamp in GMT
1735  * @param float $timezone ?
1736  * @return array An array that represents the date in user time
1737  */
1738 function usergetdate($time, $timezone=99) {
1740     $strtimezone = NULL;
1741     if (!is_numeric($timezone)) {
1742         $strtimezone = $timezone;
1743     }
1745     $timezone = get_user_timezone_offset($timezone);
1747     if (abs($timezone) > 13) {    // Server time
1748         return getdate($time);
1749     }
1751     // There is no gmgetdate so we use gmdate instead
1752     $time += dst_offset_on($time, $strtimezone);
1753     $time += intval((float)$timezone * HOURSECS);
1755     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1757     //be careful to ensure the returned array matches that produced by getdate() above
1758     list(
1759         $getdate['month'],
1760         $getdate['weekday'],
1761         $getdate['yday'],
1762         $getdate['year'],
1763         $getdate['mon'],
1764         $getdate['wday'],
1765         $getdate['mday'],
1766         $getdate['hours'],
1767         $getdate['minutes'],
1768         $getdate['seconds']
1769     ) = explode('_', $datestring);
1771     return $getdate;
1774 /**
1775  * Given a GMT timestamp (seconds since epoch), offsets it by
1776  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1777  *
1778  * @uses HOURSECS
1779  * @param  int $date Timestamp in GMT
1780  * @param float $timezone
1781  * @return int
1782  */
1783 function usertime($date, $timezone=99) {
1785     $timezone = get_user_timezone_offset($timezone);
1787     if (abs($timezone) > 13) {
1788         return $date;
1789     }
1790     return $date - (int)($timezone * HOURSECS);
1793 /**
1794  * Given a time, return the GMT timestamp of the most recent midnight
1795  * for the current user.
1796  *
1797  * @param int $date Timestamp in GMT
1798  * @param float $timezone Defaults to user's timezone
1799  * @return int Returns a GMT timestamp
1800  */
1801 function usergetmidnight($date, $timezone=99) {
1803     $userdate = usergetdate($date, $timezone);
1805     // Time of midnight of this user's day, in GMT
1806     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1810 /**
1811  * Returns a string that prints the user's timezone
1812  *
1813  * @param float $timezone The user's timezone
1814  * @return string
1815  */
1816 function usertimezone($timezone=99) {
1818     $tz = get_user_timezone($timezone);
1820     if (!is_float($tz)) {
1821         return $tz;
1822     }
1824     if(abs($tz) > 13) { // Server time
1825         return get_string('serverlocaltime');
1826     }
1828     if($tz == intval($tz)) {
1829         // Don't show .0 for whole hours
1830         $tz = intval($tz);
1831     }
1833     if($tz == 0) {
1834         return 'UTC';
1835     }
1836     else if($tz > 0) {
1837         return 'UTC+'.$tz;
1838     }
1839     else {
1840         return 'UTC'.$tz;
1841     }
1845 /**
1846  * Returns a float which represents the user's timezone difference from GMT in hours
1847  * Checks various settings and picks the most dominant of those which have a value
1848  *
1849  * @global object
1850  * @global object
1851  * @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
1852  * @return float
1853  */
1854 function get_user_timezone_offset($tz = 99) {
1856     global $USER, $CFG;
1858     $tz = get_user_timezone($tz);
1860     if (is_float($tz)) {
1861         return $tz;
1862     } else {
1863         $tzrecord = get_timezone_record($tz);
1864         if (empty($tzrecord)) {
1865             return 99.0;
1866         }
1867         return (float)$tzrecord->gmtoff / HOURMINS;
1868     }
1871 /**
1872  * Returns an int which represents the systems's timezone difference from GMT in seconds
1873  *
1874  * @global object
1875  * @param mixed $tz timezone
1876  * @return int if found, false is timezone 99 or error
1877  */
1878 function get_timezone_offset($tz) {
1879     global $CFG;
1881     if ($tz == 99) {
1882         return false;
1883     }
1885     if (is_numeric($tz)) {
1886         return intval($tz * 60*60);
1887     }
1889     if (!$tzrecord = get_timezone_record($tz)) {
1890         return false;
1891     }
1892     return intval($tzrecord->gmtoff * 60);
1895 /**
1896  * Returns a float or a string which denotes the user's timezone
1897  * 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)
1898  * means that for this timezone there are also DST rules to be taken into account
1899  * Checks various settings and picks the most dominant of those which have a value
1900  *
1901  * @global object
1902  * @global object
1903  * @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
1904  * @return mixed
1905  */
1906 function get_user_timezone($tz = 99) {
1907     global $USER, $CFG;
1909     $timezones = array(
1910         $tz,
1911         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1912         isset($USER->timezone) ? $USER->timezone : 99,
1913         isset($CFG->timezone) ? $CFG->timezone : 99,
1914         );
1916     $tz = 99;
1918     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1919         $tz = $next['value'];
1920     }
1922     return is_numeric($tz) ? (float) $tz : $tz;
1925 /**
1926  * Returns cached timezone record for given $timezonename
1927  *
1928  * @global object
1929  * @global object
1930  * @param string $timezonename
1931  * @return mixed timezonerecord object or false
1932  */
1933 function get_timezone_record($timezonename) {
1934     global $CFG, $DB;
1935     static $cache = NULL;
1937     if ($cache === NULL) {
1938         $cache = array();
1939     }
1941     if (isset($cache[$timezonename])) {
1942         return $cache[$timezonename];
1943     }
1945     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1946                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1949 /**
1950  * Build and store the users Daylight Saving Time (DST) table
1951  *
1952  * @global object
1953  * @global object
1954  * @global object
1955  * @param mixed $from_year Start year for the table, defaults to 1971
1956  * @param mixed $to_year End year for the table, defaults to 2035
1957  * @param mixed $strtimezone
1958  * @return bool
1959  */
1960 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1961     global $CFG, $SESSION, $DB;
1963     $usertz = get_user_timezone($strtimezone);
1965     if (is_float($usertz)) {
1966         // Trivial timezone, no DST
1967         return false;
1968     }
1970     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1971         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1972         unset($SESSION->dst_offsets);
1973         unset($SESSION->dst_range);
1974     }
1976     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1977         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1978         // This will be the return path most of the time, pretty light computationally
1979         return true;
1980     }
1982     // Reaching here means we either need to extend our table or create it from scratch
1984     // Remember which TZ we calculated these changes for
1985     $SESSION->dst_offsettz = $usertz;
1987     if(empty($SESSION->dst_offsets)) {
1988         // If we 're creating from scratch, put the two guard elements in there
1989         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1990     }
1991     if(empty($SESSION->dst_range)) {
1992         // If creating from scratch
1993         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1994         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1996         // Fill in the array with the extra years we need to process
1997         $yearstoprocess = array();
1998         for($i = $from; $i <= $to; ++$i) {
1999             $yearstoprocess[] = $i;
2000         }
2002         // Take note of which years we have processed for future calls
2003         $SESSION->dst_range = array($from, $to);
2004     }
2005     else {
2006         // If needing to extend the table, do the same
2007         $yearstoprocess = array();
2009         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2010         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2012         if($from < $SESSION->dst_range[0]) {
2013             // Take note of which years we need to process and then note that we have processed them for future calls
2014             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2015                 $yearstoprocess[] = $i;
2016             }
2017             $SESSION->dst_range[0] = $from;
2018         }
2019         if($to > $SESSION->dst_range[1]) {
2020             // Take note of which years we need to process and then note that we have processed them for future calls
2021             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2022                 $yearstoprocess[] = $i;
2023             }
2024             $SESSION->dst_range[1] = $to;
2025         }
2026     }
2028     if(empty($yearstoprocess)) {
2029         // This means that there was a call requesting a SMALLER range than we have already calculated
2030         return true;
2031     }
2033     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2034     // Also, the array is sorted in descending timestamp order!
2036     // Get DB data
2038     static $presets_cache = array();
2039     if (!isset($presets_cache[$usertz])) {
2040         $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');
2041     }
2042     if(empty($presets_cache[$usertz])) {
2043         return false;
2044     }
2046     // Remove ending guard (first element of the array)
2047     reset($SESSION->dst_offsets);
2048     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2050     // Add all required change timestamps
2051     foreach($yearstoprocess as $y) {
2052         // Find the record which is in effect for the year $y
2053         foreach($presets_cache[$usertz] as $year => $preset) {
2054             if($year <= $y) {
2055                 break;
2056             }
2057         }
2059         $changes = dst_changes_for_year($y, $preset);
2061         if($changes === NULL) {
2062             continue;
2063         }
2064         if($changes['dst'] != 0) {
2065             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2066         }
2067         if($changes['std'] != 0) {
2068             $SESSION->dst_offsets[$changes['std']] = 0;
2069         }
2070     }
2072     // Put in a guard element at the top
2073     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2074     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2076     // Sort again
2077     krsort($SESSION->dst_offsets);
2079     return true;
2082 /**
2083  * Calculates the required DST change and returns a Timestamp Array
2084  *
2085  * @uses HOURSECS
2086  * @uses MINSECS
2087  * @param mixed $year Int or String Year to focus on
2088  * @param object $timezone Instatiated Timezone object
2089  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
2090  */
2091 function dst_changes_for_year($year, $timezone) {
2093     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2094         return NULL;
2095     }
2097     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2098     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2100     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2101     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2103     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2104     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2106     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2107     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2108     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2110     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2111     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2113     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2116 /**
2117  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2118  *
2119  * @global object
2120  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2121  * @return int
2122  */
2123 function dst_offset_on($time, $strtimezone = NULL) {
2124     global $SESSION;
2126     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2127         return 0;
2128     }
2130     reset($SESSION->dst_offsets);
2131     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2132         if($from <= $time) {
2133             break;
2134         }
2135     }
2137     // This is the normal return path
2138     if($offset !== NULL) {
2139         return $offset;
2140     }
2142     // Reaching this point means we haven't calculated far enough, do it now:
2143     // Calculate extra DST changes if needed and recurse. The recursion always
2144     // moves toward the stopping condition, so will always end.
2146     if($from == 0) {
2147         // We need a year smaller than $SESSION->dst_range[0]
2148         if($SESSION->dst_range[0] == 1971) {
2149             return 0;
2150         }
2151         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2152         return dst_offset_on($time, $strtimezone);
2153     }
2154     else {
2155         // We need a year larger than $SESSION->dst_range[1]
2156         if($SESSION->dst_range[1] == 2035) {
2157             return 0;
2158         }
2159         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2160         return dst_offset_on($time, $strtimezone);
2161     }
2164 /**
2165  * ?
2166  *
2167  * @todo Document what this function does
2168  * @param int $startday
2169  * @param int $weekday
2170  * @param int $month
2171  * @param int $year
2172  * @return int
2173  */
2174 function find_day_in_month($startday, $weekday, $month, $year) {
2176     $daysinmonth = days_in_month($month, $year);
2178     if($weekday == -1) {
2179         // Don't care about weekday, so return:
2180         //    abs($startday) if $startday != -1
2181         //    $daysinmonth otherwise
2182         return ($startday == -1) ? $daysinmonth : abs($startday);
2183     }
2185     // From now on we 're looking for a specific weekday
2187     // Give "end of month" its actual value, since we know it
2188     if($startday == -1) {
2189         $startday = -1 * $daysinmonth;
2190     }
2192     // Starting from day $startday, the sign is the direction
2194     if($startday < 1) {
2196         $startday = abs($startday);
2197         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2199         // This is the last such weekday of the month
2200         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2201         if($lastinmonth > $daysinmonth) {
2202             $lastinmonth -= 7;
2203         }
2205         // Find the first such weekday <= $startday
2206         while($lastinmonth > $startday) {
2207             $lastinmonth -= 7;
2208         }
2210         return $lastinmonth;
2212     }
2213     else {
2215         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2217         $diff = $weekday - $indexweekday;
2218         if($diff < 0) {
2219             $diff += 7;
2220         }
2222         // This is the first such weekday of the month equal to or after $startday
2223         $firstfromindex = $startday + $diff;
2225         return $firstfromindex;
2227     }
2230 /**
2231  * Calculate the number of days in a given month
2232  *
2233  * @param int $month The month whose day count is sought
2234  * @param int $year The year of the month whose day count is sought
2235  * @return int
2236  */
2237 function days_in_month($month, $year) {
2238    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2241 /**
2242  * Calculate the position in the week of a specific calendar day
2243  *
2244  * @param int $day The day of the date whose position in the week is sought
2245  * @param int $month The month of the date whose position in the week is sought
2246  * @param int $year The year of the date whose position in the week is sought
2247  * @return int
2248  */
2249 function dayofweek($day, $month, $year) {
2250     // I wonder if this is any different from
2251     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2252     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2255 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2257 /**
2258  * Returns full login url.
2259  *
2260  * @return string login url
2261  */
2262 function get_login_url() {
2263     global $CFG;
2265     $url = "$CFG->wwwroot/login/index.php";
2267     if (!empty($CFG->loginhttps)) {
2268         $url = str_replace('http:', 'https:', $url);
2269     }
2271     return $url;
2274 /**
2275  * This function checks that the current user is logged in and has the
2276  * required privileges
2277  *
2278  * This function checks that the current user is logged in, and optionally
2279  * whether they are allowed to be in a particular course and view a particular
2280  * course module.
2281  * If they are not logged in, then it redirects them to the site login unless
2282  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2283  * case they are automatically logged in as guests.
2284  * If $courseid is given and the user is not enrolled in that course then the
2285  * user is redirected to the course enrolment page.
2286  * If $cm is given and the course module is hidden and the user is not a teacher
2287  * in the course then the user is redirected to the course home page.
2288  *
2289  * When $cm parameter specified, this function sets page layout to 'module'.
2290  * You need to change it manually later if some other layout needed.
2291  *
2292  * @param mixed $courseorid id of the course or course object
2293  * @param bool $autologinguest default true
2294  * @param object $cm course module object
2295  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2296  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2297  *             in order to keep redirects working properly. MDL-14495
2298  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2299  * @return mixed Void, exit, and die depending on path
2300  */
2301 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2302     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2304     // setup global $COURSE, themes, language and locale
2305     if (!empty($courseorid)) {
2306         if (is_object($courseorid)) {
2307             $course = $courseorid;
2308         } else if ($courseorid == SITEID) {
2309             $course = clone($SITE);
2310         } else {
2311             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2312         }
2313         if ($cm) {
2314             if ($cm->course != $course->id) {
2315                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2316             }
2317             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2318             $PAGE->set_pagelayout('incourse');
2319         } else {
2320             $PAGE->set_course($course); // set's up global $COURSE
2321         }
2322     } else {
2323         // do not touch global $COURSE via $PAGE->set_course(),
2324         // the reasons is we need to be able to call require_login() at any time!!
2325         $course = $SITE;
2326         if ($cm) {
2327             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2328         }
2329     }
2331     // If the user is not even logged in yet then make sure they are
2332     if (!isloggedin()) {
2333         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2334             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2335                 // misconfigured site guest, just redirect to login page
2336                 redirect(get_login_url());
2337                 exit; // never reached
2338             }
2339             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2340             complete_user_login($guest, false);
2341             $USER->autologinguest = true;
2342             $SESSION->lang = $lang;
2343         } else {
2344             //NOTE: $USER->site check was obsoleted by session test cookie,
2345             //      $USER->confirmed test is in login/index.php
2346             if ($preventredirect) {
2347                 throw new require_login_exception('You are not logged in');
2348             }
2350             if ($setwantsurltome) {
2351                 // TODO: switch to PAGE->url
2352                 $SESSION->wantsurl = $FULLME;
2353             }
2354             if (!empty($_SERVER['HTTP_REFERER'])) {
2355                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2356             }
2357             redirect(get_login_url());
2358             exit; // never reached
2359         }
2360     }
2362     // loginas as redirection if needed
2363     if ($course->id != SITEID and session_is_loggedinas()) {
2364         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2365             if ($USER->loginascontext->instanceid != $course->id) {
2366                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2367             }
2368         }
2369     }
2371     // check whether the user should be changing password (but only if it is REALLY them)
2372     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2373         $userauth = get_auth_plugin($USER->auth);
2374         if ($userauth->can_change_password() and !$preventredirect) {
2375             $SESSION->wantsurl = $FULLME;
2376             if ($changeurl = $userauth->change_password_url()) {
2377                 //use plugin custom url
2378                 redirect($changeurl);
2379             } else {
2380                 //use moodle internal method
2381                 if (empty($CFG->loginhttps)) {
2382                     redirect($CFG->wwwroot .'/login/change_password.php');
2383                 } else {
2384                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2385                     redirect($wwwroot .'/login/change_password.php');
2386                 }
2387             }
2388         } else {
2389             print_error('nopasswordchangeforced', 'auth');
2390         }
2391     }
2393     // Check that the user account is properly set up
2394     if (user_not_fully_set_up($USER)) {
2395         if ($preventredirect) {
2396             throw new require_login_exception('User not fully set-up');
2397         }
2398         $SESSION->wantsurl = $FULLME;
2399         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2400     }
2402     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2403     sesskey();
2405     // Do not bother admins with any formalities
2406     if (is_siteadmin()) {
2407         //set accesstime or the user will appear offline which messes up messaging
2408         user_accesstime_log($course->id);
2409         return;
2410     }
2412     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2413     if (!$USER->policyagreed and !is_siteadmin()) {
2414         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2415             if ($preventredirect) {
2416                 throw new require_login_exception('Policy not agreed');
2417             }
2418             $SESSION->wantsurl = $FULLME;
2419             redirect($CFG->wwwroot .'/user/policy.php');
2420         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2421             if ($preventredirect) {
2422                 throw new require_login_exception('Policy not agreed');
2423             }
2424             $SESSION->wantsurl = $FULLME;
2425             redirect($CFG->wwwroot .'/user/policy.php');
2426         }
2427     }
2429     // Fetch the system context, the course context, and prefetch its child contexts
2430     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2431     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2432     if ($cm) {
2433         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2434     } else {
2435         $cmcontext = null;
2436     }
2438     // If the site is currently under maintenance, then print a message
2439     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2440         if ($preventredirect) {
2441             throw new require_login_exception('Maintenance in progress');
2442         }
2444         print_maintenance_message();
2445     }
2447     // make sure the course itself is not hidden
2448     if ($course->id == SITEID) {
2449         // frontpage can not be hidden
2450     } else {
2451         if (is_role_switched($course->id)) {
2452             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2453         } else {
2454             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2455                 // originally there was also test of parent category visibility,
2456                 // BUT is was very slow in complex queries involving "my courses"
2457                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2458                 if ($preventredirect) {
2459                     throw new require_login_exception('Course is hidden');
2460                 }
2461                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2462             }
2463         }
2464     }
2466     // is the user enrolled?
2467     if ($course->id == SITEID) {
2468         // everybody is enrolled on the frontpage
2470     } else {
2471         if (session_is_loggedinas()) {
2472             // Make sure the REAL person can access this course first
2473             $realuser = session_get_realuser();
2474             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2475                 if ($preventredirect) {
2476                     throw new require_login_exception('Invalid course login-as access');
2477                 }
2478                 echo $OUTPUT->header();
2479                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2480             }
2481         }
2483         // very simple enrolment caching - changes in course setting are not reflected immediately
2484         if (!isset($USER->enrol)) {
2485             $USER->enrol = array();
2486             $USER->enrol['enrolled'] = array();
2487             $USER->enrol['tempguest'] = array();
2488         }
2490         $access = false;
2492         if (is_viewing($coursecontext, $USER)) {
2493             // ok, no need to mess with enrol
2494             $access = true;
2496         } else {
2497             if (isset($USER->enrol['enrolled'][$course->id])) {
2498                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2499                     $access = true;
2500                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2501                     $access = true;
2502                 } else {
2503                     //expired
2504                     unset($USER->enrol['enrolled'][$course->id]);
2505                 }
2506             }
2507             if (isset($USER->enrol['tempguest'][$course->id])) {
2508                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2509                     $access = true;
2510                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2511                     $access = true;
2512                 } else {
2513                     //expired
2514                     unset($USER->enrol['tempguest'][$course->id]);
2515                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2516                 }
2517             }
2519             if ($access) {
2520                 // cache ok
2521             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2522                 // active participants may always access
2523                 // TODO: refactor this into some new function
2524                 $now = time();
2525                 $sql = "SELECT MAX(ue.timeend)
2526                           FROM {user_enrolments} ue
2527                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2528                           JOIN {user} u ON u.id = ue.userid
2529                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2530                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2531                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2532                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2533                 $until = $DB->get_field_sql($sql, $params);
2534                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2535                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2536                 }
2538                 $USER->enrol['enrolled'][$course->id] = $until;
2539                 $access = true;
2541                 // remove traces of previous temp guest access
2542                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2544             } else {
2545                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2546                 $enrols = enrol_get_plugins(true);
2547                 // first ask all enabled enrol instances in course if they want to auto enrol user
2548                 foreach($instances as $instance) {
2549                     if (!isset($enrols[$instance->enrol])) {
2550                         continue;
2551                     }
2552                     // Get a duration for the guestaccess, a timestamp in the future or false.
2553                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2554                     if ($until !== false) {
2555                         $USER->enrol['enrolled'][$course->id] = $until;
2556                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2557                         $access = true;
2558                         break;
2559                     }
2560                 }
2561                 // if not enrolled yet try to gain temporary guest access
2562                 if (!$access) {
2563                     foreach($instances as $instance) {
2564                         if (!isset($enrols[$instance->enrol])) {
2565                             continue;
2566                         }
2567                         // Get a duration for the guestaccess, a timestamp in the future or false.
2568                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2569                         if ($until !== false) {
2570                             $USER->enrol['tempguest'][$course->id] = $until;
2571                             $access = true;
2572                             break;
2573                         }
2574                     }
2575                 }
2576             }
2577         }
2579         if (!$access) {
2580             if ($preventredirect) {
2581                 throw new require_login_exception('Not enrolled');
2582             }
2583             $SESSION->wantsurl = $FULLME;
2584             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2585         }
2586     }
2588     // test visibility
2589     if ($cm && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2590         if ($preventredirect) {
2591             throw new require_login_exception('Activity is hidden');
2592         }
2593         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2594     }
2596     // groupmembersonly access control
2597     if (!empty($CFG->enablegroupmembersonly) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2598         if (isguestuser() or !groups_has_membership($cm)) {
2599             if ($preventredirect) {
2600                 throw new require_login_exception('Not member of a group');
2601             }
2602             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2603         }
2604     }
2606     // Conditional activity access control
2607     if (!empty($CFG->enableavailability) and $cm) {
2608         // TODO: this is going to work with login-as-user, sorry!
2609         // We cache conditional access in session
2610         if (!isset($SESSION->conditionaccessok)) {
2611             $SESSION->conditionaccessok = array();
2612         }
2613         // If you have been allowed into the module once then you are allowed
2614         // in for rest of session, no need to do conditional checks
2615         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2616             // Get condition info (does a query for the availability table)
2617             require_once($CFG->libdir.'/conditionlib.php');
2618             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2619             // Check condition for user (this will do a query if the availability
2620             // information depends on grade or completion information)
2621             if ($ci->is_available($junk) || has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2622                 $SESSION->conditionaccessok[$cm->id] = true;
2623             } else {
2624                 print_error('activityiscurrentlyhidden');
2625             }
2626         }
2627     }
2629     // Finally access granted, update lastaccess times
2630     user_accesstime_log($course->id);
2634 /**
2635  * This function just makes sure a user is logged out.
2636  *
2637  * @global object
2638  */
2639 function require_logout() {
2640     global $USER;
2642     $params = $USER;
2644     if (isloggedin()) {
2645         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2647         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2648         foreach($authsequence as $authname) {
2649             $authplugin = get_auth_plugin($authname);
2650             $authplugin->prelogout_hook();
2651         }
2652     }
2654     events_trigger('user_logout', $params);
2655     session_get_instance()->terminate_current();
2656     unset($params);
2659 /**
2660  * Weaker version of require_login()
2661  *
2662  * This is a weaker version of {@link require_login()} which only requires login
2663  * when called from within a course rather than the site page, unless
2664  * the forcelogin option is turned on.
2665  * @see require_login()
2666  *
2667  * @global object
2668  * @param mixed $courseorid The course object or id in question
2669  * @param bool $autologinguest Allow autologin guests if that is wanted
2670  * @param object $cm Course activity module if known
2671  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2672  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2673  *             in order to keep redirects working properly. MDL-14495
2674  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2675  * @return void
2676  */
2677 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2678     global $CFG, $PAGE, $SITE;
2679     if (!empty($CFG->forcelogin)) {
2680         // login required for both SITE and courses
2681         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2683     } else if (!empty($cm) and !$cm->visible) {
2684         // always login for hidden activities
2685         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2687     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2688           or (!is_object($courseorid) and $courseorid == SITEID)) {
2689               //login for SITE not required
2690         if ($cm and empty($cm->visible)) {
2691             // hidden activities are not accessible without login
2692             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2693         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2694             // not-logged-in users do not have any group membership
2695             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2696         } else {
2697             // We still need to instatiate PAGE vars properly so that things
2698             // that rely on it like navigation function correctly.
2699             if (!empty($courseorid)) {
2700                 if (is_object($courseorid)) {
2701                     $course = $courseorid;
2702                 } else {
2703                     $course = clone($SITE);
2704                 }
2705                 if ($cm) {
2706                     if ($cm->course != $course->id) {
2707                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2708                     }
2709                     $PAGE->set_cm($cm, $course);
2710                     $PAGE->set_pagelayout('incourse');
2711                 } else {
2712                     $PAGE->set_course($course);
2713                 }
2714             } else {
2715                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2716                 // up properly, set them up now.
2717                 $PAGE->set_course($PAGE->course);
2718             }
2719             //TODO: verify conditional activities here
2720             user_accesstime_log(SITEID);
2721             return;
2722         }
2724     } else {
2725         // course login always required
2726         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2727     }
2730 /**
2731  * Require key login. Function terminates with error if key not found or incorrect.
2732  *
2733  * @global object
2734  * @global object
2735  * @global object
2736  * @global object
2737  * @uses NO_MOODLE_COOKIES
2738  * @uses PARAM_ALPHANUM
2739  * @param string $script unique script identifier
2740  * @param int $instance optional instance id
2741  * @return int Instance ID
2742  */
2743 function require_user_key_login($script, $instance=null) {
2744     global $USER, $SESSION, $CFG, $DB;
2746     if (!NO_MOODLE_COOKIES) {
2747         print_error('sessioncookiesdisable');
2748     }
2750 /// extra safety
2751     @session_write_close();
2753     $keyvalue = required_param('key', PARAM_ALPHANUM);
2755     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2756         print_error('invalidkey');
2757     }
2759     if (!empty($key->validuntil) and $key->validuntil < time()) {
2760         print_error('expiredkey');
2761     }
2763     if ($key->iprestriction) {
2764         $remoteaddr = getremoteaddr(null);
2765         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2766             print_error('ipmismatch');
2767         }
2768     }
2770     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2771         print_error('invaliduserid');
2772     }
2774 /// emulate normal session
2775     session_set_user($user);
2777 /// note we are not using normal login
2778     if (!defined('USER_KEY_LOGIN')) {
2779         define('USER_KEY_LOGIN', true);
2780     }
2782 /// return instance id - it might be empty
2783     return $key->instance;
2786 /**
2787  * Creates a new private user access key.
2788  *
2789  * @global object
2790  * @param string $script unique target identifier
2791  * @param int $userid
2792  * @param int $instance optional instance id
2793  * @param string $iprestriction optional ip restricted access
2794  * @param timestamp $validuntil key valid only until given data
2795  * @return string access key value
2796  */
2797 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2798     global $DB;
2800     $key = new stdClass();
2801     $key->script        = $script;
2802     $key->userid        = $userid;
2803     $key->instance      = $instance;
2804     $key->iprestriction = $iprestriction;
2805     $key->validuntil    = $validuntil;
2806     $key->timecreated   = time();
2808     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2809     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2810         // must be unique
2811         $key->value     = md5($userid.'_'.time().random_string(40));
2812     }
2813     $DB->insert_record('user_private_key', $key);
2814     return $key->value;
2817 /**
2818  * Delete the user's new private user access keys for a particular script.
2819  *
2820  * @global object
2821  * @param string $script unique target identifier
2822  * @param int $userid
2823  * @return void
2824  */
2825 function delete_user_key($script,$userid) {
2826     global $DB;
2827     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
2830 /**
2831  * Gets a private user access key (and creates one if one doesn't exist).
2832  *
2833  * @global object
2834  * @param string $script unique target identifier
2835  * @param int $userid
2836  * @param int $instance optional instance id
2837  * @param string $iprestriction optional ip restricted access
2838  * @param timestamp $validuntil key valid only until given data
2839  * @return string access key value
2840  */
2841 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2842     global $DB;
2844     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
2845                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
2846                                                          'validuntil'=>$validuntil))) {
2847         return $key->value;
2848     } else {
2849         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
2850     }
2854 /**
2855  * Modify the user table by setting the currently logged in user's
2856  * last login to now.
2857  *
2858  * @global object
2859  * @global object
2860  * @return bool Always returns true
2861  */
2862 function update_user_login_times() {
2863     global $USER, $DB;
2865     $user = new stdClass();
2866     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2867     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2869     $user->id = $USER->id;
2871     $DB->update_record('user', $user);
2872     return true;
2875 /**
2876  * Determines if a user has completed setting up their account.
2877  *
2878  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
2879  * @return bool
2880  */
2881 function user_not_fully_set_up($user) {
2882     if (isguestuser($user)) {
2883         return false;
2884     }
2885     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
2888 /**
2889  * Check whether the user has exceeded the bounce threshold
2890  *
2891  * @global object
2892  * @global object
2893  * @param user $user A {@link $USER} object
2894  * @return bool true=>User has exceeded bounce threshold
2895  */
2896 function over_bounce_threshold($user) {
2897     global $CFG, $DB;
2899     if (empty($CFG->handlebounces)) {
2900         return false;
2901     }
2903     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2904         return false;
2905     }
2907     // set sensible defaults
2908     if (empty($CFG->minbounces)) {
2909         $CFG->minbounces = 10;
2910     }
2911     if (empty($CFG->bounceratio)) {
2912         $CFG->bounceratio = .20;
2913     }
2914     $bouncecount = 0;
2915     $sendcount = 0;
2916     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2917         $bouncecount = $bounce->value;
2918     }
2919     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2920         $sendcount = $send->value;
2921     }
2922     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2925 /**
2926  * Used to increment or reset email sent count
2927  *
2928  * @global object
2929  * @param user $user object containing an id
2930  * @param bool $reset will reset the count to 0
2931  * @return void
2932  */
2933 function set_send_count($user,$reset=false) {
2934     global $DB;
2936     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2937         return;
2938     }
2940     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2941         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2942         $DB->update_record('user_preferences', $pref);
2943     }
2944     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2945         // make a new one
2946         $pref = new stdClass();
2947         $pref->name   = 'email_send_count';
2948         $pref->value  = 1;
2949         $pref->userid = $user->id;
2950         $DB->insert_record('user_preferences', $pref, false);
2951     }
2954 /**
2955  * Increment or reset user's email bounce count
2956  *
2957  * @global object
2958  * @param user $user object containing an id
2959  * @param bool $reset will reset the count to 0
2960  */
2961 function set_bounce_count($user,$reset=false) {
2962     global $DB;
2964     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2965         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2966         $DB->update_record('user_preferences', $pref);
2967     }
2968     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2969         // make a new one
2970         $pref = new stdClass();
2971         $pref->name   = 'email_bounce_count';
2972         $pref->value  = 1;
2973         $pref->userid = $user->id;
2974         $DB->insert_record('user_preferences', $pref, false);
2975     }
2978 /**
2979  * Keeps track of login attempts
2980  *
2981  * @global object
2982  */
2983 function update_login_count() {
2984     global $SESSION;
2986     $max_logins = 10;
2988     if (empty($SESSION->logincount)) {
2989         $SESSION->logincount = 1;
2990     } else {
2991         $SESSION->logincount++;
2992     }
2994     if ($SESSION->logincount > $max_logins) {
2995         unset($SESSION->wantsurl);
2996         print_error('errortoomanylogins');
2997     }
3000 /**
3001  * Resets login attempts
3002  *
3003  * @global object
3004  */
3005 function reset_login_count() {
3006     global $SESSION;
3008     $SESSION->logincount = 0;
3011 /**
3012  * Returns reference to full info about modules in course (including visibility).
3013  * Cached and as fast as possible (0 or 1 db query).
3014  *
3015  * @global object
3016  * @global object
3017  * @global object
3018  * @uses CONTEXT_MODULE
3019  * @uses MAX_MODINFO_CACHE_SIZE
3020  * @param mixed $course object or 'reset' string to reset caches, modinfo may be updated in db
3021  * @param int $userid Defaults to current user id
3022  * @return mixed courseinfo object or nothing if resetting
3023  */
3024 function &get_fast_modinfo(&$course, $userid=0) {
3025     global $CFG, $USER, $DB;
3026     require_once($CFG->dirroot.'/course/lib.php');
3028     if (!empty($CFG->enableavailability)) {
3029         require_once($CFG->libdir.'/conditionlib.php');
3030     }
3032     static $cache = array();
3034     if ($course === 'reset') {
3035         $cache = array();
3036         $nothing = null;
3037         return $nothing; // we must return some reference
3038     }
3040     if (empty($userid)) {
3041         $userid = $USER->id;
3042     }
3044     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
3045         return $cache[$course->id];
3046     }
3048     if (empty($course->modinfo)) {
3049         // no modinfo yet - load it
3050         rebuild_course_cache($course->id);
3051         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
3052     }
3054     $modinfo = new stdClass();
3055     $modinfo->courseid  = $course->id;
3056     $modinfo->userid    = $userid;
3057     $modinfo->sections  = array();
3058     $modinfo->cms       = array();
3059     $modinfo->instances = array();
3060     $modinfo->groups    = null; // loaded only when really needed - the only one db query
3062     $info = unserialize($course->modinfo);
3063     if (!is_array($info)) {
3064         // hmm, something is wrong - lets try to fix it
3065         rebuild_course_cache($course->id);
3066         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
3067         $info = unserialize($course->modinfo);
3068         if (!is_array($info)) {
3069             return $modinfo;
3070         }
3071     }
3073     if ($info) {
3074         // detect if upgrade required
3075         $first = reset($info);
3076         if (!isset($first->id)) {
3077             rebuild_course_cache($course->id);
3078             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
3079             $info = unserialize($course->modinfo);
3080             if (!is_array($info)) {
3081                 return $modinfo;
3082             }
3083         }
3084     }
3086     $modlurals = array();
3088     // If we haven't already preloaded contexts for the course, do it now
3089     preload_course_contexts($course->id);
3091     foreach ($info as $mod) {
3092         if (empty($mod->name)) {
3093             // something is wrong here
3094             continue;
3095         }
3096         // reconstruct minimalistic $cm
3097         $cm = new stdClass();
3098         $cm->id               = $mod->cm;
3099         $cm->instance         = $mod->id;
3100         $cm->course           = $course->id;
3101         $cm->modname          = $mod->mod;
3102         $cm->idnumber         = $mod->idnumber;
3103         $cm->name             = $mod->name;
3104         $cm->visible          = $mod->visible;
3105         $cm->sectionnum       = $mod->section;
3106         $cm->groupmode        = $mod->groupmode;
3107         $cm->groupingid       = $mod->groupingid;
3108         $cm->groupmembersonly = $mod->groupmembersonly;
3109         $cm->indent           = $mod->indent;
3110         $cm->completion       = $mod->completion;
3111         $cm->extra            = isset($mod->extra) ? $mod->extra : '';
3112         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
3113         $cm->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
3114         $cm->uservisible      = true;
3115         if (!empty($CFG->enableavailability)) {
3116             // We must have completion information from modinfo. If it's not
3117             // there, cache needs rebuilding
3118             if(!isset($mod->availablefrom)) {
3119                 debugging('enableavailability option was changed; rebuilding '.
3120                     'cache for course '.$course->id);
3121                 rebuild_course_cache($course->id,true);
3122                 // Re-enter this routine to do it all properly
3123                 return get_fast_modinfo($course, $userid);
3124             }
3125             $cm->availablefrom    = $mod->availablefrom;
3126             $cm->availableuntil   = $mod->availableuntil;
3127             $cm->showavailability = $mod->showavailability;
3128             $cm->conditionscompletion = $mod->conditionscompletion;
3129             $cm->conditionsgrade  = $mod->conditionsgrade;
3130         }
3132         // preload long names plurals and also check module is installed properly
3133         if (!isset($modlurals[$cm->modname])) {
3134             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
3135                 continue;
3136             }
3137             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
3138         }
3139         $cm->modplural = $modlurals[$cm->modname];
3140         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
3142         if (!empty($CFG->enableavailability)) {
3143             // Unfortunately the next call really wants to call
3144             // get_fast_modinfo, but that would be recursive, so we fake up a
3145             // modinfo for it already
3146             if (empty($minimalmodinfo)) { //TODO: this is suspicious (skodak)
3147                 $minimalmodinfo = new stdClass();
3148                 $minimalmodinfo->cms = array();
3149                 foreach($info as $mod) {
3150                     if (empty($mod->name)) {
3151                         // something is wrong here
3152                         continue;
3153                     }
3154                     $minimalcm = new stdClass();
3155                     $minimalcm->id = $mod->cm;
3156                     $minimalcm->name = $mod->name;
3157                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
3158                 }
3159             }
3161             // Get availability information
3162             $ci = new condition_info($cm);
3163             $cm->available = $ci->is_available($cm->availableinfo, true, $userid, $minimalmodinfo);
3164         } else {
3165             $cm->available = true;
3166         }
3167         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
3168             $cm->uservisible = false;
3170         } else if (!empty($CFG->enablegroupmembersonly) and !empty($cm->groupmembersonly)
3171                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
3172             if (is_null($modinfo->groups)) {
3173                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
3174             }
3175             if (empty($modinfo->groups[$cm->groupingid])) {
3176                 $cm->uservisible = false;
3177             }
3178         }
3180         if (!isset($modinfo->instances[$cm->modname])) {
3181             $modinfo->instances[$cm->modname] = array();
3182         }
3183         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
3184         $modinfo->cms[$cm->id] =& $cm;
3186         // reconstruct sections
3187         if (!isset($modinfo->sections[$cm->sectionnum])) {
3188             $modinfo->sections[$cm->sectionnum] = array();
3189         }
3190         $modinfo->sections[$cm->sectionnum][] = $cm->id;
3192         unset($cm);
3193     }
3195     unset($cache[$course->id]); // prevent potential reference problems when switching users
3196     $cache[$course->id] = $modinfo;
3198     // Ensure cache does not use too much RAM
3199     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
3200         reset($cache);
3201         $key = key($cache);
3202         unset($cache[$key]);
3203     }
3205     return $cache[$course->id];
3208 /**
3209  * Determines if the currently logged in user is in editing mode.
3210  * Note: originally this function had $userid parameter - it was not usable anyway
3211  *
3212  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3213  * @todo Deprecated function remove when ready
3214  *
3215  * @global object
3216  * @uses DEBUG_DEVELOPER
3217  * @return bool
3218  */
3219 function isediting() {
3220     global $PAGE;
3221     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3222     return $PAGE->user_is_editing();
3225 /**
3226  * Determines if the logged in user is currently moving an activity
3227  *
3228  * @global object
3229  * @param int $courseid The id of the course being tested
3230  * @return bool
3231  */
3232 function ismoving($courseid) {
3233     global $USER;
3235     if (!empty($USER->activitycopy)) {
3236         return ($USER->activitycopycourse == $courseid);
3237     }
3238     return false;
3241 /**
3242  * Returns a persons full name
3243  *
3244  * Given an object containing firstname and lastname
3245  * values, this function returns a string with the
3246  * full name of the person.
3247  * The result may depend on system settings
3248  * or language.  'override' will force both names
3249  * to be used even if system settings specify one.
3250  *
3251  * @global object
3252  * @global object
3253  * @param object $user A {@link $USER} object to get full name of
3254  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3255  * @return string
3256  */
3257 function fullname($user, $override=false) {
3258     global $CFG, $SESSION;
3260     if (!isset($user->firstname) and !isset($user->lastname)) {
3261         return '';
3262     }
3264     if (!$override) {
3265         if (!empty($CFG->forcefirstname)) {
3266             $user->firstname = $CFG->forcefirstname;
3267         }
3268         if (!empty($CFG->forcelastname)) {
3269             $user->lastname = $CFG->forcelastname;
3270         }
3271     }
3273     if (!empty($SESSION->fullnamedisplay)) {
3274         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3275     }
3277     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3278         return $user->firstname .' '. $user->lastname;
3280     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3281         return $user->lastname .' '. $user->firstname;
3283     } else if ($CFG->fullnamedisplay == 'firstname') {
3284         if ($override) {
3285             return get_string('fullnamedisplay', '', $user);
3286         } else {
3287             return $user->firstname;
3288         }
3289     }
3291     return get_string('fullnamedisplay', '', $user);
3294 /**
3295  * Returns whether a given authentication plugin exists.
3296  *
3297  * @global object
3298  * @param string $auth Form of authentication to check for. Defaults to the
3299  *        global setting in {@link $CFG}.
3300  * @return boolean Whether the plugin is available.
3301  */
3302 function exists_auth_plugin($auth) {
3303     global $CFG;
3305     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3306         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3307     }
3308     return false;
3311 /**
3312  * Checks if a given plugin is in the list of enabled authentication plugins.
3313  *
3314  * @param string $auth Authentication plugin.
3315  * @return boolean Whether the plugin is enabled.
3316  */
3317 function is_enabled_auth($auth) {
3318     if (empty($auth)) {
3319         return false;
3320     }
3322     $enabled = get_enabled_auth_plugins();
3324     return in_array($auth, $enabled);
3327 /**
3328  * Returns an authentication plugin instance.
3329  *
3330  * @global object
3331  * @param string $auth name of authentication plugin
3332  * @return auth_plugin_base An instance of the required authentication plugin.
3333  */
3334 function get_auth_plugin($auth) {
3335     global $CFG;
3337     // check the plugin exists first
3338     if (! exists_auth_plugin($auth)) {
3339         print_error('authpluginnotfound', 'debug', '', $auth);
3340     }
3342     // return auth plugin instance
3343     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3344     $class = "auth_plugin_$auth";
3345     return new $class;
3348 /**
3349  * Returns array of active auth plugins.
3350  *
3351  * @param bool $fix fix $CFG->auth if needed
3352  * @return array
3353  */
3354 function get_enabled_auth_plugins($fix=false) {
3355     global $CFG;
3357     $default = array('manual', 'nologin');
3359     if (empty($CFG->auth)) {
3360         $auths = array();
3361     } else {
3362         $auths = explode(',', $CFG->auth);
3363     }
3365     if ($fix) {
3366         $auths = array_unique($auths);
3367         foreach($auths as $k=>$authname) {
3368             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3369                 unset($auths[$k]);
3370             }
3371         }
3372         $newconfig = implode(',', $auths);
3373         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3374             set_config('auth', $newconfig);
3375         }
3376     }
3378     return (array_merge($default, $auths));
3381 /**
3382  * Returns true if an internal authentication method is being used.
3383  * if method not specified then, global default is assumed
3384  *
3385  * @param string $auth Form of authentication required
3386  * @return bool
3387  */
3388 function is_internal_auth($auth) {
3389     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3390     return $authplugin->is_internal();
3393 /**
3394  * Returns true if the user is a 'restored' one
3395  *
3396  * Used in the login process to inform the user
3397  * and allow him/her to reset the password
3398  *
3399  * @uses $CFG
3400  * @uses $DB
3401  * @param string $username username to be checked
3402  * @return bool
3403  */
3404 function is_restored_user($username) {
3405     global $CFG, $DB;
3407     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3410 /**
3411  * Returns an array of user fields
3412  *
3413  * @return array User field/column names
3414  */
3415 function get_user_fieldnames() {
3416     global $DB;
3418     $fieldarray = $DB->get_columns('user');
3419     unset($fieldarray['id']);
3420     $fieldarray = array_keys($fieldarray);
3422     return $fieldarray;
3425 /**
3426  * Creates a bare-bones user record
3427  *
3428  * @todo Outline auth types and provide code example
3429  *
3430  * @param string $username New user's username to add to record
3431  * @param string $password New user's password to add to record
3432  * @param string $auth Form of authentication required
3433  * @return stdClass A complete user object
3434  */
3435 function create_user_record($username, $password, $auth = 'manual') {
3436     global $CFG, $DB;
3438     //just in case check text case
3439     $username = trim(moodle_strtolower($username));
3441     $authplugin = get_auth_plugin($auth);
3443     $newuser = new stdClass();
3445     if ($newinfo = $authplugin->get_userinfo($username)) {
3446         $newinfo = truncate_userinfo($newinfo);
3447         foreach ($newinfo as $key => $value){
3448             $newuser->$key = $value;
3449         }
3450     }
3452     if (!empty($newuser->email)) {
3453         if (email_is_not_allowed($newuser->email)) {
3454             unset($newuser->email);
3455         }
3456     }
3458     if (!isset($newuser->city)) {
3459         $newuser->city = '';
3460     }
3462     $newuser->auth = $auth;
3463     $newuser->username = $username;
3465     // fix for MDL-8480
3466     // user CFG lang for user if $newuser->lang is empty
3467     // or $user->lang is not an installed language
3468     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3469         $newuser->lang = $CFG->lang;
3470     }
3471     $newuser->confirmed = 1;
3472     $newuser->lastip = getremoteaddr();
3473     $newuser->timemodified = time();
3474     $newuser->mnethostid = $CFG->mnet_localhost_id;
3476     $newuser->id = $DB->insert_record('user', $newuser);
3477     $user = get_complete_user_data('id', $newuser->id);
3478     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3479         set_user_preference('auth_forcepasswordchange', 1, $user);
3480     }
3481     update_internal_user_password($user, $password);
3483     // fetch full user record for the event, the complete user data contains too much info
3484     // and we want to be consistent with other places that trigger this event
3485     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3487     return $user;
3490 /**
3491  * Will update a local user record from an external source.
3492  * (MNET users can not be updated using this method!)
3493  *
3494  * @param string $username user's username to update the record
3495  * @return stdClass A complete user object
3496  */
3497 function update_user_record($username) {
3498     global $DB, $CFG;
3500     $username = trim(moodle_strtolower($username)); /// just in case check text case
3502     $oldinfo = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
3503     $newuser = array();
3504     $userauth = get_auth_plugin($oldinfo->auth);
3506     if ($newinfo = $userauth->get_userinfo($username)) {
3507         $newinfo = truncate_userinfo($newinfo);
3508         foreach ($newinfo as $key => $value){
3509             $key = strtolower($key);
3510             if (!property_exists($oldinfo, $key) or $key === 'username' or $key === 'id'
3511                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3512                 // unknown or must not be changed
3513                 continue;
3514             }
3515             $confval = $userauth->config->{'field_updatelocal_' . $key};
3516             $lockval = $userauth->config->{'field_lock_' . $key};
3517             if (empty($confval) || empty($lockval)) {
3518                 continue;
3519             }
3520             if ($confval === 'onlogin') {
3521                 // MDL-4207 Don't overwrite modified user profile values with
3522                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3523                 // of the setting 'unlocked if empty' is to allow the user to fill
3524                 // in a value for the selected field _if LDAP is giving
3525                 // nothing_ for this field. Thus it makes sense to let this value
3526                 // stand in until LDAP is giving a value for this field.
3527                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3528                     if ((string)$oldinfo->$key !== (string)$value) {
3529                         $newuser[$key] = (string)$value;
3530                     }
3531                 }
3532             }
3533         }
3534         if ($newuser) {
3535             $newuser['id'] = $oldinfo->id;
3536             $DB->update_record('user', $newuser);
3537             // fetch full user record for the event, the complete user data contains too much info
3538             // and we want to be consistent with other places that trigger this event
3539             events_trigger('user_updated', $DB->get_record('user', array('id'=>$oldinfo->id)));
3540         }
3541     }
3543     return get_complete_user_data('id', $oldinfo->id);
3546 /**
3547  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3548  * which may have large fields
3549  *
3550  * @todo Add vartype handling to ensure $info is an array
3551  *
3552  * @param array $info Array of user properties to truncate if needed
3553  * @return array The now truncated information that was passed in
3554  */
3555 function truncate_userinfo($info) {
3556     // define the limits
3557     $limit = array(
3558                     'username'    => 100,
3559                     'idnumber'    => 255,
3560                     'firstname'   => 100,
3561                     'lastname'    => 100,
3562                     'email'       => 100,
3563                     'icq'         =>  15,
3564                     'phone1'      =>  20,
3565                     'phone2'      =>  20,
3566                     'institution' =>  40,
3567                     'department'  =>  30,
3568                     'address'     =>  70,
3569                     'city'        => 120,
3570                     'country'     =>   2,
3571                     'url'         => 255,
3572                     );
3574     $textlib = textlib_get_instance();
3575     // apply where needed
3576     foreach (array_keys($info) as $key) {
3577         if (!empty($limit[$key])) {
3578             $info[$key] = trim($textlib->substr($info[$key],0, $limit[$key]));
3579         }
3580     }
3582     return $info;
3585 /**
3586  * Marks user deleted in internal user database and notifies the auth plugin.
3587  * Also unenrols user from all roles and does other cleanup.
3588  *
3589  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3590  *
3591  * @param object $user User object before delete
3592  * @return boolean always true
3593  */
3594 function delete_user($user) {
3595     global $CFG, $DB;
3596     require_once($CFG->libdir.'/grouplib.php');
3597     require_once($CFG->libdir.'/gradelib.php');
3598     require_once($CFG->dirroot.'/message/lib.php');
3599     require_once($CFG->dirroot.'/tag/lib.php');
3601     // delete all grades - backup is kept in grade_grades_history table
3602     grade_user_delete($user->id);
3604     //move unread messages from this user to read
3605     message_move_userfrom_unread2read($user->id);
3607     // TODO: remove from cohorts using standard API here
3609     // remove user tags
3610     tag_set('user', $user->id, array());
3612     // unconditionally unenrol from all courses
3613     enrol_user_delete($user);
3615     // unenrol from all roles in all contexts
3616     role_unassign_all(array('userid'=>$user->id)); // this might be slow but it is really needed - modules might do some extra cleanup!
3618     //now do a brute force cleanup
3620     // remove from all cohorts
3621     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3623     // remove from all groups
3624     $DB->delete_records('groups_members', array('userid'=>$user->id));
3626     // brute force unenrol from all courses
3627     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3629     // purge user preferences
3630     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3632     // purge user extra profile info
3633     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3635     // last course access not necessary either
3636     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3638     // now do a final accesslib cleanup - removes all role assignments in user context and context itself
3639     delete_context(CONTEXT_USER, $user->id);
3641     // workaround for bulk deletes of users with the same email address
3642     $delname = "$user->email.".time();
3643     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3644         $delname++;
3645     }
3647     // mark internal user record as "deleted"
3648     $updateuser = new stdClass();
3649     $updateuser->id           = $user->id;
3650     $updateuser->deleted      = 1;
3651     $updateuser->username     = $delname;            // Remember it just in case
3652     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3653     $updateuser->idnumber     = '';                  // Clear this field to free it up
3654     $updateuser->timemodified = time();
3656     $DB->update_record('user', $updateuser);
3658     // notify auth plugin - do not block the delete even when plugin fails
3659     $authplugin = get_auth_plugin($user->auth);
3660     $authplugin->user_delete($user);
3662     // any plugin that needs to cleanup should register this event
3663     events_trigger('user_deleted', $user);
3665     return true;
3668 /**
3669  * Retrieve the guest user object
3670  *
3671  * @global object
3672  * @global object
3673  * @return user A {@link $USER} object
3674  */
3675 function guest_user() {
3676     global $CFG, $DB;
3678     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
3679         $newuser->confirmed = 1;
3680         $newuser->lang = $CFG->lang;
3681         $newuser->lastip = getremoteaddr();
3682     }
3684     return $newuser;
3687 /**
3688  * Authenticates a user against the chosen authentication mechanism
3689  *
3690  * Given a username and password, this function looks them
3691  * up using the currently selected authentication mechanism,
3692  * and if the authentication is successful, it returns a
3693  * valid $user object from the 'user' table.
3694  *
3695  * Uses auth_ functions from the currently active auth module
3696  *
3697  * After authenticate_user_login() returns success, you will need to
3698  * log that the user has logged in, and call complete_user_login() to set
3699  * the session up.
3700  *
3701  * Note: this function works only with non-mnet accounts!
3702  *
3703  * @param string $username  User's username
3704  * @param string $password  User's password
3705  * @return user|flase A {@link $USER} object or false if error
3706  */
3707 function authenticate_user_login($username, $password) {
3708     global $CFG, $DB;
3710     $authsenabled = get_enabled_auth_plugins();
3712     if ($user = get_complete_user_data('username', $username, $CFG->mnet_localhost_id)) {
3713         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3714         if (!empty($user->suspended)) {
3715             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3716             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3717             return false;
3718         }
3719         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3720             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3721             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3722             return false;
3723         }
3724         $auths = array($auth);
3726     } else {
3727         // check if there's a deleted record (cheaply)
3728         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
3729             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3730             return false;
3731         }
3733         // User does not exist
3734         $auths = $authsenabled;
3735         $user = new stdClass();
3736         $user->id = 0;
3737     }
3739     foreach ($auths as $auth) {
3740         $authplugin = get_auth_plugin($auth);
3742         // on auth fail fall through to the next plugin
3743         if (!$authplugin->user_login($username, $password)) {
3744             continue;
3745         }
3747         // successful authentication
3748         if ($user->id) {                          // User already exists in database
3749             if (empty($user->auth)) {             // For some reason auth isn't set yet
3750                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3751                 $user->auth = $auth;
3752             }
3753             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3754                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3755                 $user->firstaccess = $user->timemodified;
3756             }
3758             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3760             if ($authplugin->is_synchronised_with_external()) { // update user record from external DB
3761                 $user = update_user_record($username);
3762             }
3763         } else {
3764             // if user not found, create him
3765             $user = create_user_record($username, $password, $auth);
3766         }
3768         $authplugin->sync_roles($user);
3770         foreach ($authsenabled as $hau) {
3771             $hauth = get_auth_plugin($hau);
3772             $hauth->user_authenticated_hook($user, $username, $password);
3773         }
3775         if (empty($user->id)) {
3776             return false;
3777         }
3779         if (!empty($user->suspended)) {
3780             // just in case some auth plugin suspended account
3781             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3782             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3783             return false;
3784         }
3786         return $user;
3787     }
3789     // failed if all the plugins have failed
3790     add_to_log(SITEID, 'login', 'error', 'index.php', $username);
3791     if (debugging('', DEBUG_ALL)) {
3792         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3793     }
3794     return false;
3797 /**
3798  * Call to complete the user login process after authenticate_user_login()
3799  * has succeeded. It will setup the $USER variable and other required bits
3800  * and pieces.
3801  *
3802  * NOTE:
3803  * - It will NOT log anything -- up to the caller to decide what to log.
3804  *
3805  * @param object $user
3806  * @param bool $setcookie
3807  * @return object A {@link $USER} object - BC only, do not use
3808  */
3809 function complete_user_login($user, $setcookie=true) {
3810     global $CFG, $USER;
3812     // regenerate session id and delete old session,
3813     // this helps prevent session fixation attacks from the same domain
3814     session_regenerate_id(true);
3816     // check enrolments, load caps and setup $USER object
3817     session_set_user($user);
3819     // reload preferences from DB
3820     unset($user->preference);
3821     check_user_preferences_loaded($user);
3823     // update login times
3824     update_user_login_times();
3826     // extra session prefs init
3827     set_login_session_preferences();
3829     if (isguestuser()) {
3830         // no need to continue when user is THE guest
3831         return $USER;
3832     }
3834     if ($setcookie) {
3835         if (empty($CFG->nolastloggedin)) {
3836             set_moodle_cookie($USER->username);
3837         } else {
3838             // do not store last logged in user in cookie
3839             // auth plugins can temporarily override this from loginpage_hook()
3840             // do not save $CFG->nolastloggedin in database!
3841             set_moodle_cookie('');
3842         }
3843     }
3845     /// Select password change url
3846     $userauth = get_auth_plugin($USER->auth);
3848     /// check whether the user should be changing password
3849     if (get_user_preferences('auth_forcepasswordchange', false)){
3850         if ($userauth->can_change_password()) {
3851             if ($changeurl = $userauth->change_password_url()) {
3852                 redirect($changeurl);
3853             } else {
3854                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3855             }
3856         } else {
3857             print_error('nopasswordchangeforced', 'auth');
3858         }
3859     }
3860     return $USER;
3863 /**
3864  * Compare password against hash stored in internal user table.
3865  * If necessary it also updates the stored hash to new format.
3866  *
3867  * @param stdClass $user (password property may be updated)
3868  * @param string $password plain text password
3869  * @return bool is password valid?
3870  */
3871 function validate_internal_user_password($user, $password) {
3872     global $CFG;
3874     if (!isset($CFG->passwordsaltmain)) {
3875         $CFG->passwordsaltmain = '';
3876     }
3878     $validated = false;
3880     if ($user->password === 'not cached') {
3881         // internal password is not used at all, it can not validate
3883     } else if ($user->password === md5($password.$CFG->passwordsaltmain)
3884             or $user->password === md5($password)
3885             or $user->password === md5(addslashes($password).$CFG->passwordsaltmain)
3886             or $user->password === md5(addslashes($password))) {
3887         // note: we are intentionally using the addslashes() here because we
3888         //       need to accept old password hashes of passwords with magic quotes
3889         $validated = true;
3891     } else {
3892         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3893             $alt = 'passwordsaltalt'.$i;
3894             if (!empty($CFG->$alt)) {
3895                 if ($user->password === md5($password.$CFG->$alt) or $user->password === md5(addslashes($password).$CFG->$alt)) {
3896                     $validated = true;
3897                     break;
3898                 }
3899             }
3900         }
3901     }
3903     if ($validated) {
3904         // force update of password hash using latest main password salt and encoding if needed
3905         update_internal_user_password($user, $password);
3906     }
3908     return $validated;
3911 /**
3912  * Calculate hashed value from password using current hash mechanism.
3913  *
3914  * @param string $password
3915  * @return string password hash
3916  */
3917 function hash_internal_user_password($password) {
3918     global $CFG;
3920     if (isset($CFG->passwordsaltmain)) {
3921         return md5($password.$CFG->passwordsaltmain);
3922     } else {
3923         return md5($password);
3924     }
3927 /**
3928  * Update password hash in user object.
3929  *
3930  * @param stdClass $user (password property may be updated)
3931  * @param string $password plain text password
3932  * @return bool always returns true
3933  */
3934 function update_internal_user_password($user, $password) {
3935     global $DB;
3937     $authplugin = get_auth_plugin($user->auth);
3938     if ($authplugin->prevent_local_passwords()) {
3939         $hashedpassword = 'not cached';
3940     } else {
3941         $hashedpassword = hash_internal_user_password($password);
3942     }
3944     if ($user->password !== $hashedpassword) {
3945         $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
3946         $user->password = $hashedpassword;
3947     }
3949     return true;
3952 /**
3953  * Get a complete user record, which includes all the info
3954  * in the user record.
3955  *
3956  * Intended for setting as $USER session variable
3957  *
3958  * @param string $field The user field to be checked for a given value.
3959  * @param string $value The value to match for $field.
3960  * @param int $mnethostid
3961  * @return mixed False, or A {@link $USER} object.
3962  */
3963 function get_complete_user_data($field, $value, $mnethostid = null) {
3964     global $CFG, $DB;
3966     if (!$field || !$value) {
3967         return false;
3968     }
3970 /// Build the WHERE clause for an SQL query
3971     $params = array('fieldval'=>$value);
3972     $constraints = "$field = :fieldval AND deleted <> 1";
3974     // If we are loading user data based on anything other than id,
3975     // we must also restrict our search based on mnet host.
3976     if ($field != 'id') {
3977         if (empty($mnethostid)) {
3978             // if empty, we restrict to local users
3979             $mnethostid = $CFG->mnet_localhost_id;
3980         }
3981     }
3982     if (!empty($mnethostid)) {
3983         $params['mnethostid'] = $mnethostid;
3984         $constraints .= " AND mnethostid = :mnethostid";
3985     }
3987 /// Get all the basic user data
3989     if (! $user = $DB->get_record_select('user', $constraints, $params)) {
3990         return false;
3991     }
3993 /// Get various settings and preferences
3995     if ($displays = $DB->get_records('course_display', array('userid'=>$user->id))) {
3996         foreach ($displays as $display) {
3997             $user->display[$display->course] = $display->display;
3998         }
3999     }
4001     // preload preference cache
4002     check_user_preferences_loaded($user);
4004     // load course enrolment related stuff
4005     $user->lastcourseaccess    = array(); // during last session
4006     $user->currentcourseaccess = array(); // during current session
4007     if ($lastaccesses = $DB->get_records('user_lastaccess', array('userid'=>$user->id))) {
4008         foreach ($lastaccesses as $lastaccess) {
4009             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
4010         }
4011     }
4013     $sql = "SELECT g.id, g.courseid
4014               FROM {groups} g, {groups_members} gm
4015              WHERE gm.groupid=g.id AND gm.userid=?";
4017     // this is a special hack to speedup calendar display
4018     $user->groupmember = array();
4019     if ($groups = $DB->get_records_sql($sql, array($user->id))) {
4020         foreach ($groups as $group) {
4021             if (!array_key_exists($group->courseid, $user->groupmember)) {
4022                 $user->groupmember[$group->courseid] = array();
4023             }
4024             $user->groupmember[$group->courseid][$group->id] = $group->id;
4025         }
4026     }
4028 /// Add the custom profile fields to the user record
4029     require_once($CFG->dirroot.'/user/profile/lib.php');
4030     profile_load_custom_fields($user);
4032 /// Rewrite some variables if necessary
4033     if (!empty($user->description)) {
4034         $user->description = true;   // No need to cart all of it around
4035     }
4036     if (isguestuser($user)) {
4037         $user->lang       = $CFG->lang;               // Guest language always same as site
4038         $user->firstname  = get_string('guestuser');  // Name always in current language
4039         $user->lastname   = ' ';
4040     }
4042     return $user;
4045 /**
4046  * Validate a password against the configured password policy
4047  *
4048  * @global object
4049  * @param string $password the password to be checked against the password policy
4050  * @param string $errmsg the error message to display when the password doesn't comply with the policy.
4051  * @return bool true if the password is valid according to the policy. false otherwise.
4052  */
4053 function check_password_policy($password, &$errmsg) {
4054     global $CFG;
4056     if (empty($CFG->passwordpolicy)) {
4057         return true;
4058     }
4060     $textlib = textlib_get_instance();
4061     $errmsg = '';
4062     if ($textlib->strlen($password) < $CFG->minpasswordlength) {
4063         $errmsg .= '<div>'. get_string('errorminpasswordlength', 'auth', $CFG->minpasswordlength) .'</div>';
4065     }
4066     if (preg_match_all('/[[:digit:]]/u', $password, $matches) < $CFG->minpassworddigits) {
4067         $errmsg .= '<div>'. get_string('errorminpassworddigits', 'auth', $CFG->minpassworddigits) .'</div>';
4069     }
4070     if (preg_match_all('/[[:lower:]]/u', $password, $matches) < $CFG->minpasswordlower) {
4071         $errmsg .= '<div>'. get_string('errorminpasswordlower', 'auth', $CFG->minpasswordlower) .'</div>';
4073     }
4074     if (preg_match_all('/[[:upper:]]/u', $password, $matches) < $CFG->minpasswordupper) {
4075         $errmsg .= '<div>'. get_string('errorminpasswordupper', 'auth', $CFG->minpasswordupper) .'</div>';
4077     }
4078     if (preg_match_all('/[^[:upper:][:lower:][:digit:]]/u', $password, $matches) < $CFG->minpasswordnonalphanum) {
4079         $errmsg .= '<div>'. get_string('errorminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum) .'</div>';
4080     }
4081     if (!check_consecutive_identical_characters($password, $CFG->maxconsecutiveidentchars)) {
4082         $errmsg .= '<div>'. get_string('errormaxconsecutiveidentchars', 'auth', $CFG->maxconsecutiveidentchars) .'</div>';
4083     }
4085     if ($errmsg == '') {
4086         return true;
4087     } else {
4088         return false;
4089     }
4093 /**
4094  * When logging in, this function is run to set certain preferences
4095  * for the current SESSION
4096  *
4097  * @global object
4098  * @global object
4099  */
4100 function set_login_session_preferences() {
4101     global $SESSION, $CFG;
4103     $SESSION->justloggedin = true;
4105     unset($SESSION->lang);
4107     // Restore the calendar filters, if saved
4108     if (intval(get_user_preferences('calendar_persistflt', 0))) {
4109         include_once($CFG->dirroot.'/calendar/lib.php');
4110         calendar_set_filters_status(get_user_preferences('calendar_savedflt', 0xff));
4111     }
4115 /**
4116  * Delete a course, including all related data from the database,
4117  * and any associated files.
4118  *
4119  * @global object
4120  * @global object
4121  * @param mixed $courseorid The id of the course or course object to delete.
4122  * @param bool $showfeedback Whether to display notifications of each action the function performs.
4123  * @return bool true if all the removals succeeded. false if there were any failures. If this
4124  *             method returns false, some of the removals will probably have succeeded, and others
4125  *             failed, but you have no way of knowing which.
4126  */
4127 function delete_course($courseorid, $showfeedback = true) {
4128     global $DB;
4130     if (is_object($courseorid)) {
4131         $courseid = $courseorid->id;
4132         $course   = $courseorid;
4133     } else {
4134         $courseid = $courseorid;
4135         if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
4136             return false;
4137         }
4138     }
4139     $context = get_context_instance(CONTEXT_COURSE, $courseid);
4141     // frontpage course can not be deleted!!
4142     if ($courseid == SITEID) {
4143         return false;
4144     }
4146     // make the course completely empty
4147     remove_course_contents($courseid, $showfeedback);
4149     // delete the course and related context instance
4150     delete_context(CONTEXT_COURSE, $courseid);
4151     $DB->delete_records("course", array("id"=>$courseid));
4153     //trigger events
4154     $course->context = $context; // you can not fetch context in the event because it was already deleted
4155     events_trigger('course_deleted', $course);
4157     return true;
4160 /**
4161  * Clear a course out completely, deleting all content
4162  * but don't delete the course itself.
4163  * This function does not verify any permissions.
4164  *
4165  * Please note this function also deletes all user enrolments,
4166  * enrolment instances and role assignments.
4167  *
4168  * @param int $courseid The id of the course that is being deleted
4169  * @param bool $showfeedback Whether to display notifications of each action the function performs.
4170  * @return bool true if all the removals succeeded. false if there were any failures. If this
4171  *             method returns false, some of the removals will probably have succeeded, and others
4172  *             failed, but you have no way of knowing which.
4173  */
4174 function remove_course_contents($courseid, $showfeedback = true) {
4175     global $CFG, $DB, $OUTPUT;
4176     require_once($CFG->libdir.'/completionlib.php');
4177     require_once($CFG->libdir.'/questionlib.php');
4178     require_once($CFG->libdir.'/gradelib.php');
4179     require_once($CFG->dirroot.'/group/lib.php');
4180     require_once($CFG->dirroot.'/tag/coursetagslib.php');
4182     $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
4183     $context = get_context_instance(CONTEXT_COURSE, $courseid, MUST_EXIST);
4185     $strdeleted = get_string('deleted');
4187     // Delete course completion information,
4188     // this has to be done before grades and enrols
4189     $cc = new completion_info($course);
4190     $cc->clear_criteria();
4192     // remove roles and enrolments
4193     role_unassign_all(array('contextid'=>$context->id), true);
4194     enrol_course_delete($course);
4196     // Clean up course formats (iterate through all formats in the even the course format was ever changed)
4197     $formats = get_plugin_list('format');
4198     foreach ($formats as $format=>$formatdir) {
4199         $formatdelete = 'format_'.$format.'_delete_course';
4200         $formatlib    = "$formatdir/lib.php";
4201         if (file_exists($formatlib)) {
4202             include_once($formatlib);
4203             if (function_exists($formatdelete)) {
4204                 if ($showfeedback) {
4205                     echo $OUTPUT->notification($strdeleted.' '.$format);
4206                 }
4207                 $formatdelete($course->id);
4208             }
4209         }
4210     }
4212     // Remove all data from gradebook - this needs to be done before course modules
4213     // because while deleting this information, the system may need to reference
4214     // the course modules that own the grades.
4215     remove_course_grades($courseid, $showfeedback);
4216     remove_grade_letters($context, $showfeedback);
4218     // Remove all data from availability and completion tables that is associated
4219     // with course-modules belonging to this course. Note this is done even if the
4220     // features are not enabled now, in case they were enabled previously
4221     $DB->delete_records_select('course_modules_completion',
4222            'coursemoduleid IN (SELECT id from {course_modules} WHERE course=?)',
4223            array($courseid));
4224     $DB->delete_records_select('course_modules_availability',
4225            'coursemoduleid IN (SELECT id from {course_modules} WHERE course=?)',
4226            array($courseid));
4228     // Delete course blocks - they may depend on modules so delete them first
4229     blocks_delete_all_for_context($context->id);
4231     // Delete every instance of every module
4232     if ($allmods = $DB->get_records('modules') ) {
4233         foreach ($allmods as $mod) {
4234             $modname = $mod->name;
4235             $modfile = $CFG->dirroot .'/mod/'. $modname .'/lib.php';
4236             $moddelete = $modname .'_delete_instance';       // Delete everything connected to an instance
4237             $moddeletecourse = $modname .'_delete_course';   // Delete other stray stuff (uncommon)
4238             $count=0;
4239             if (file_exists($modfile)) {
4240                 include_once($modfile);
4241                 if (function_exists($moddelete)) {
4242                     if ($instances = $DB->get_records($modname, array('course'=>$course->id))) {
4243                         foreach ($instances as $instance) {
4244                             if ($cm = get_coursemodule_from_instance($modname, $instance->id, $course->id)) {
4245                                 /// Delete activity context questions and question categories
4246                                 question_delete_activity($cm,  $showfeedback);
4247                             }
4248                             if ($moddelete($instance->id)) {
4249                                 $count++;
4251                             } else {
4252                                 echo $OUTPUT->notification('Could not delete '. $modname .' instance '. $instance->id .' ('. format_string($instance->name) .')');
4253                             }
4254                             if ($cm) {
4255                                 // delete cm and its context in correct order
4256                                 delete_context(CONTEXT_MODULE, $cm->id); // some callbacks may try to fetch context, better delete first
4257                                 $DB->delete_records('course_modules', array('id'=>$cm->id));
4258                             }
4259                         }
4260                     }
4261                 } else {
4262                     //note: we should probably delete these anyway
4263                     echo $OUTPUT->notification('Function '.$moddelete.'() doesn\'t exist!');
4264                 }
4266                 if (function_exists($moddeletecourse)) {
4267                     $moddeletecourse($course, $showfeedback);
4268                 }
4269             }
4270             if ($showfeedback) {
4271                 echo $OUTPUT->notification($strdeleted .' '. $count .' x '. $modname);
4272             }
4273         }
4274     }
4276     // Delete any groups, removing members and grouping/course links first.
4277     groups_delete_groupings($course->id, $showfeedback);
4278     groups_delete_groups($course->id, $showfeedback);
4280     // Delete questions and question categories
4281     question_delete_course($course, $showfeedback);
4283     // Delete course tags
4284     coursetag_delete_course_tags($course->id, $showfeedback);
4286     // Delete legacy files (just in case some files are still left there after conversion to new file api)
4287     fulldelete($CFG->dataroot.'/'.$course->id);
4289     // cleanup course record - remove links to delted stuff
4290     $oldcourse = new stdClass();
4291     $oldcourse->id                = $course->id;
4292     $oldcourse->summary           = '';
4293     $oldcourse->modinfo           = NULL;
4294     $oldcourse->legacyfiles       = 0;
4295     $oldcourse->defaultgroupingid = 0;
4296     $oldcourse->enablecompletion  = 0;
4297     $DB->update_record('course', $oldcourse);
4299     // Delete all related records in other tables that may have a courseid
4300     // This array stores the tables that need to be cleared, as
4301     // table_name => column_name that contains the course id.
4302     $tablestoclear = array(
4303         'event' => 'courseid', // Delete events
4304         'log' => 'course', // Delete logs
4305         'course_sections' => 'course', // Delete any course stuff
4306         'course_modules' => 'course',
4307         'course_display' => 'course',
4308         'backup_courses' => 'courseid', // Delete scheduled backup stuff
4309         'user_lastaccess' => 'courseid',
4310         'backup_log' => 'courseid'
4311     );
4312     foreach ($tablestoclear as $table => $col) {
4313         $DB->delete_records($table, array($col=>$course->id));
4314     }
4316     // Delete all remaining stuff linked to context,
4317     // such as remaining roles, files, comments, etc.
4318     // Keep the context record for now.
4319     delete_context(CONTEXT_COURSE, $course->id, false);
4321     //trigger events
4322     $course->context = $context; // you can not access context in cron event later after course is deleted
4323     events_trigger('course_content_removed', $course);
4325     return true;
4328 /**
4329  * Change dates in module - used from course reset.
4330  *
4331  * @global object
4332  * @global object
4333  * @param string $modname forum, assignment, etc
4334  * @param array $fields array of date fields from mod table
4335  * @param int $timeshift time difference
4336  * @param int $courseid
4337  * @return bool success
4338  */
4339 function shift_course_mod_dates($modname, $fields, $timeshift, $courseid) {
4340     global $CFG, $DB;
4341     include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
4343     $return = true;
4344     foreach ($fields as $field) {
4345         $updatesql = "UPDATE {".$modname."}
4346                           SET $field = $field + ?
4347                         WHERE course=? AND $field<>0 AND $field<>0";
4348         $return = $DB->execute($updatesql, array($timeshift, $courseid)) && $return;
4349     }
4351     $refreshfunction = $modname.'_refresh_events';
4352     if (function_exists($refreshfunction)) {
4353         $refreshfunction($courseid);
4354     }