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