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