880ebe80ed614104cb45841a3ff78689ef0579e2
[moodle.git] / lib / moodlelib.php
1 <?php // $Id$
3 ///////////////////////////////////////////////////////////////////////////
4 //                                                                       //
5 // NOTICE OF COPYRIGHT                                                   //
6 //                                                                       //
7 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
8 //          http://moodle.org                                            //
9 //                                                                       //
10 // Copyright (C) 1999 onwards Martin Dougiamas  http://dougiamas.com     //
11 //                                                                       //
12 // This program is free software; you can redistribute it and/or modify  //
13 // it under the terms of the GNU General Public License as published by  //
14 // the Free Software Foundation; either version 2 of the License, or     //
15 // (at your option) any later version.                                   //
16 //                                                                       //
17 // This program is distributed in the hope that it will be useful,       //
18 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
19 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
20 // GNU General Public License for more details:                          //
21 //                                                                       //
22 //          http://www.gnu.org/copyleft/gpl.html                         //
23 //                                                                       //
24 ///////////////////////////////////////////////////////////////////////////
26 /**
27  * moodlelib.php - Moodle main library
28  *
29  * Main library file of miscellaneous general-purpose Moodle functions.
30  * Other main libraries:
31  *  - weblib.php      - functions that produce web output
32  *  - datalib.php     - functions that access the database
33  * @author Martin Dougiamas
34  * @version $Id$
35  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
36  * @package moodlecore
37  */
39 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
41 /**
42  * Used by some scripts to check they are being called by Moodle
43  */
44 define('MOODLE_INTERNAL', true);
46 /// Date and time constants ///
47 /**
48  * Time constant - the number of seconds in a year
49  */
51 define('YEARSECS', 31536000);
53 /**
54  * Time constant - the number of seconds in a week
55  */
56 define('WEEKSECS', 604800);
58 /**
59  * Time constant - the number of seconds in a day
60  */
61 define('DAYSECS', 86400);
63 /**
64  * Time constant - the number of seconds in an hour
65  */
66 define('HOURSECS', 3600);
68 /**
69  * Time constant - the number of seconds in a minute
70  */
71 define('MINSECS', 60);
73 /**
74  * Time constant - the number of minutes in a day
75  */
76 define('DAYMINS', 1440);
78 /**
79  * Time constant - the number of minutes in an hour
80  */
81 define('HOURMINS', 60);
83 /// Parameter constants - every call to optional_param(), required_param()  ///
84 /// or clean_param() should have a specified type of parameter.  //////////////
86 /**
87  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way;
88  * originally was 0, but changed because we need to detect unknown
89  * parameter types and swiched order in clean_param().
90  */
91 define('PARAM_RAW', 666);
93 /**
94  * PARAM_CLEAN - obsoleted, please try to use more specific type of parameter.
95  * It was one of the first types, that is why it is abused so much ;-)
96  */
97 define('PARAM_CLEAN',    0x0001);
99 /**
100  * PARAM_INT - integers only, use when expecting only numbers.
101  */
102 define('PARAM_INT',      0x0002);
104 /**
105  * PARAM_INTEGER - an alias for PARAM_INT
106  */
107 define('PARAM_INTEGER',  0x0002);
109 /**
110  * PARAM_NUMBER - a real/floating point number.
111  */
112 define('PARAM_NUMBER',  0x000a);
114 /**
115  * PARAM_ALPHA - contains only english letters.
116  */
117 define('PARAM_ALPHA',    0x0004);
119 /**
120  * PARAM_ACTION - an alias for PARAM_ALPHA, use for various actions in formas and urls
121  * @TODO: should we alias it to PARAM_ALPHANUM ?
122  */
123 define('PARAM_ACTION',   0x0004);
125 /**
126  * PARAM_FORMAT - an alias for PARAM_ALPHA, use for names of plugins, formats, etc.
127  * @TODO: should we alias it to PARAM_ALPHANUM ?
128  */
129 define('PARAM_FORMAT',   0x0004);
131 /**
132  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
133  */
134 define('PARAM_NOTAGS',   0x0008);
136  /**
137  * PARAM_MULTILANG - alias of PARAM_TEXT.
138  */
139 define('PARAM_MULTILANG',  0x0009);
141  /**
142  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
143  */
144 define('PARAM_TEXT',  0x0009);
146 /**
147  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
148  */
149 define('PARAM_FILE',     0x0010);
151 /**
152  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international alphanumeric with spaces
153  */
154 define('PARAM_TAG',   0x0011);
156 /**
157  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
158  */
159 define('PARAM_TAGLIST',   0x0012);
161 /**
162  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
163  * note: the leading slash is not removed, window drive letter is not allowed
164  */
165 define('PARAM_PATH',     0x0020);
167 /**
168  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
169  */
170 define('PARAM_HOST',     0x0040);
172 /**
173  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not acceppted but http://localhost.localdomain/ is ok.
174  */
175 define('PARAM_URL',      0x0080);
177 /**
178  * 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!)
179  */
180 define('PARAM_LOCALURL', 0x0180);
182 /**
183  * PARAM_CLEANFILE - safe file name, all dangerous and regional chars are removed,
184  * use when you want to store a new file submitted by students
185  */
186 define('PARAM_CLEANFILE',0x0200);
188 /**
189  * PARAM_ALPHANUM - expected numbers and letters only.
190  */
191 define('PARAM_ALPHANUM', 0x0400);
193 /**
194  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
195  */
196 define('PARAM_BOOL',     0x0800);
198 /**
199  * PARAM_CLEANHTML - cleans submitted HTML code and removes slashes
200  */
201 define('PARAM_CLEANHTML',0x1000);
203 /**
204  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "/-_" allowed,
205  * suitable for include() and require()
206  * @TODO: should we rename this function to PARAM_SAFEDIRS??
207  */
208 define('PARAM_ALPHAEXT', 0x2000);
210 /**
211  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
212  */
213 define('PARAM_SAFEDIR',  0x4000);
215 /**
216  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
217  */
218 define('PARAM_SEQUENCE',  0x8000);
220 /**
221  * PARAM_PEM - Privacy Enhanced Mail format
222  */
223 define('PARAM_PEM',      0x10000);
225 /**
226  * PARAM_BASE64 - Base 64 encoded format
227  */
228 define('PARAM_BASE64',   0x20000);
231 /// Page types ///
232 /**
233  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
234  */
235 define('PAGE_COURSE_VIEW', 'course-view');
237 /// Debug levels ///
238 /** no warnings at all */
239 define ('DEBUG_NONE', 0);
240 /** E_ERROR | E_PARSE */
241 define ('DEBUG_MINIMAL', 5);
242 /** E_ERROR | E_PARSE | E_WARNING | E_NOTICE */
243 define ('DEBUG_NORMAL', 15);
244 /** E_ALL without E_STRICT for now, do show recoverable fatal errors */
245 define ('DEBUG_ALL', 6143);
246 /** DEBUG_ALL with extra Moodle debug messages - (DEBUG_ALL | 32768) */
247 define ('DEBUG_DEVELOPER', 38911);
249 /**
250  * Blog access level constant declaration
251  */
252 define ('BLOG_USER_LEVEL', 1);
253 define ('BLOG_GROUP_LEVEL', 2);
254 define ('BLOG_COURSE_LEVEL', 3);
255 define ('BLOG_SITE_LEVEL', 4);
256 define ('BLOG_GLOBAL_LEVEL', 5);
258 /**
259  * Tag constants
260  */
261 //To prevent problems with multibytes strings, this should not exceed the
262 //length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
263 define('TAG_MAX_LENGTH', 50);
265 /**
266  * Password policy constants
267  */
268 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
269 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
270 define ('PASSWORD_DIGITS', '0123456789');
271 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
273 // Feature constants. Used for plugin_supports() to report features that are,
274 // or are not, supported by a module.
276 /** True if module can provide a grade */
277 define('FEATURE_GRADE_HAS_GRADE','grade_has_grade');
278 /** True if module has code to track whether somebody viewed it */
279 define('FEATURE_COMPLETION_TRACKS_VIEWS','completion_tracks_views');
280 /** True if module has custom completion rules */
281 define('FEATURE_COMPLETION_HAS_RULES','completion_has_rules');
285 /// PARAMETER HANDLING ////////////////////////////////////////////////////
287 /**
288  * Returns a particular value for the named variable, taken from
289  * POST or GET.  If the parameter doesn't exist then an error is
290  * thrown because we require this variable.
291  *
292  * This function should be used to initialise all required values
293  * in a script that are based on parameters.  Usually it will be
294  * used like this:
295  *    $id = required_param('id');
296  *
297  * @param string $parname the name of the page parameter we want
298  * @param int $type expected type of parameter
299  * @return mixed
300  */
301 function required_param($parname, $type=PARAM_CLEAN) {
302     if (isset($_POST[$parname])) {       // POST has precedence
303         $param = $_POST[$parname];
304     } else if (isset($_GET[$parname])) {
305         $param = $_GET[$parname];
306     } else {
307         print_error('missingparam', '', '', $parname);
308     }
310     return clean_param($param, $type);
313 /**
314  * Returns a particular value for the named variable, taken from
315  * POST or GET, otherwise returning a given default.
316  *
317  * This function should be used to initialise all optional values
318  * in a script that are based on parameters.  Usually it will be
319  * used like this:
320  *    $name = optional_param('name', 'Fred');
321  *
322  * @param string $parname the name of the page parameter we want
323  * @param mixed  $default the default value to return if nothing is found
324  * @param int $type expected type of parameter
325  * @return mixed
326  */
327 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
328     if (isset($_POST[$parname])) {       // POST has precedence
329         $param = $_POST[$parname];
330     } else if (isset($_GET[$parname])) {
331         $param = $_GET[$parname];
332     } else {
333         return $default;
334     }
336     return clean_param($param, $type);
339 /**
340  * Used by {@link optional_param()} and {@link required_param()} to
341  * clean the variables and/or cast to specific types, based on
342  * an options field.
343  * <code>
344  * $course->format = clean_param($course->format, PARAM_ALPHA);
345  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
346  * </code>
347  *
348  * @uses $CFG
349  * @uses PARAM_RAW
350  * @uses PARAM_CLEAN
351  * @uses PARAM_CLEANHTML
352  * @uses PARAM_INT
353  * @uses PARAM_NUMBER
354  * @uses PARAM_ALPHA
355  * @uses PARAM_ALPHANUM
356  * @uses PARAM_ALPHAEXT
357  * @uses PARAM_SEQUENCE
358  * @uses PARAM_BOOL
359  * @uses PARAM_NOTAGS
360  * @uses PARAM_TEXT
361  * @uses PARAM_SAFEDIR
362  * @uses PARAM_CLEANFILE
363  * @uses PARAM_FILE
364  * @uses PARAM_PATH
365  * @uses PARAM_HOST
366  * @uses PARAM_URL
367  * @uses PARAM_LOCALURL
368  * @uses PARAM_PEM
369  * @uses PARAM_BASE64
370  * @uses PARAM_TAG
371  * @uses PARAM_SEQUENCE
372  * @param mixed $param the variable we are cleaning
373  * @param int $type expected format of param after cleaning.
374  * @return mixed
375  */
376 function clean_param($param, $type) {
378     global $CFG;
380     if (is_array($param)) {              // Let's loop
381         $newparam = array();
382         foreach ($param as $key => $value) {
383             $newparam[$key] = clean_param($value, $type);
384         }
385         return $newparam;
386     }
388     switch ($type) {
389         case PARAM_RAW:          // no cleaning at all
390             return $param;
392         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
393             if (is_numeric($param)) {
394                 return $param;
395             }
396             return clean_text($param);     // Sweep for scripts, etc
398         case PARAM_CLEANHTML:    // prepare html fragment for display, do not store it into db!!
399             $param = clean_text($param);     // Sweep for scripts, etc
400             return trim($param);
402         case PARAM_INT:
403             return (int)$param;  // Convert to integer
405         case PARAM_NUMBER:
406             return (float)$param;  // Convert to integer
408         case PARAM_ALPHA:        // Remove everything not a-z
409             return eregi_replace('[^a-zA-Z]', '', $param);
411         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
412             return eregi_replace('[^A-Za-z0-9]', '', $param);
414         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z/_-
415             return eregi_replace('[^a-zA-Z/_-]', '', $param);
417         case PARAM_SEQUENCE:     // Remove everything not 0-9,
418             return eregi_replace('[^0-9,]', '', $param);
420         case PARAM_BOOL:         // Convert to 1 or 0
421             $tempstr = strtolower($param);
422             if ($tempstr == 'on' or $tempstr == 'yes' ) {
423                 $param = 1;
424             } else if ($tempstr == 'off' or $tempstr == 'no') {
425                 $param = 0;
426             } else {
427                 $param = empty($param) ? 0 : 1;
428             }
429             return $param;
431         case PARAM_NOTAGS:       // Strip all tags
432             return strip_tags($param);
434         case PARAM_TEXT:    // leave only tags needed for multilang
435             return clean_param(strip_tags($param, '<lang><span>'), PARAM_CLEAN);
437         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
438             return eregi_replace('[^a-zA-Z0-9_-]', '', $param);
440         case PARAM_CLEANFILE:    // allow only safe characters
441             return clean_filename($param);
443         case PARAM_FILE:         // Strip all suspicious characters from filename
444             $param = ereg_replace('[[:cntrl:]]|[<>"`\|\':\\/]', '', $param);
445             $param = ereg_replace('\.\.+', '', $param);
446             if($param == '.') {
447                 $param = '';
448             }
449             return $param;
451         case PARAM_PATH:         // Strip all suspicious characters from file path
452             $param = str_replace('\\\'', '\'', $param);
453             $param = str_replace('\\"', '"', $param);
454             $param = str_replace('\\', '/', $param);
455             $param = ereg_replace('[[:cntrl:]]|[<>"`\|\':]', '', $param);
456             $param = ereg_replace('\.\.+', '', $param);
457             $param = ereg_replace('//+', '/', $param);
458             return ereg_replace('/(\./)+', '/', $param);
460         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
461             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
462             // match ipv4 dotted quad
463             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
464                 // confirm values are ok
465                 if ( $match[0] > 255
466                      || $match[1] > 255
467                      || $match[3] > 255
468                      || $match[4] > 255 ) {
469                     // hmmm, what kind of dotted quad is this?
470                     $param = '';
471                 }
472             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
473                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
474                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
475                        ) {
476                 // all is ok - $param is respected
477             } else {
478                 // all is not ok...
479                 $param='';
480             }
481             return $param;
483         case PARAM_URL:          // allow safe ftp, http, mailto urls
484             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
485             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
486                 // all is ok, param is respected
487             } else {
488                 $param =''; // not really ok
489             }
490             return $param;
492         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
493             $param = clean_param($param, PARAM_URL);
494             if (!empty($param)) {
495                 if (preg_match(':^/:', $param)) {
496                     // root-relative, ok!
497                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
498                     // absolute, and matches our wwwroot
499                 } else {
500                     // relative - let's make sure there are no tricks
501                     if (validateUrlSyntax($param, 's-u-P-a-p-f+q?r?')) {
502                         // looks ok.
503                     } else {
504                         $param = '';
505                     }
506                 }
507             }
508             return $param;
510         case PARAM_PEM:
511             $param = trim($param);
512             // PEM formatted strings may contain letters/numbers and the symbols
513             // forward slash: /
514             // plus sign:     +
515             // equal sign:    =
516             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
517             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
518                 list($wholething, $body) = $matches;
519                 unset($wholething, $matches);
520                 $b64 = clean_param($body, PARAM_BASE64);
521                 if (!empty($b64)) {
522                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
523                 } else {
524                     return '';
525                 }
526             }
527             return '';
529         case PARAM_BASE64:
530             if (!empty($param)) {
531                 // PEM formatted strings may contain letters/numbers and the symbols
532                 // forward slash: /
533                 // plus sign:     +
534                 // equal sign:    =
535                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
536                     return '';
537                 }
538                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
539                 // Each line of base64 encoded data must be 64 characters in
540                 // length, except for the last line which may be less than (or
541                 // equal to) 64 characters long.
542                 for ($i=0, $j=count($lines); $i < $j; $i++) {
543                     if ($i + 1 == $j) {
544                         if (64 < strlen($lines[$i])) {
545                             return '';
546                         }
547                         continue;
548                     }
550                     if (64 != strlen($lines[$i])) {
551                         return '';
552                     }
553                 }
554                 return implode("\n",$lines);
555             } else {
556                 return '';
557             }
559         case PARAM_TAG:
560             //as long as magic_quotes_gpc is used, a backslash will be a
561             //problem, so remove *all* backslash.
562             $param = str_replace('\\', '', $param);
563             //convert many whitespace chars into one
564             $param = preg_replace('/\s+/', ' ', $param);
565             $textlib = textlib_get_instance();
566             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
567             return $param;
570         case PARAM_TAGLIST:
571             $tags = explode(',', $param);
572             $result = array();
573             foreach ($tags as $tag) {
574                 $res = clean_param($tag, PARAM_TAG);
575                 if ($res != '') {
576                     $result[] = $res;
577                 }
578             }
579             if ($result) {
580                 return implode(',', $result);
581             } else {
582                 return '';
583             }
585         default:                 // throw error, switched parameters in optional_param or another serious problem
586             print_error("unknowparamtype", '', '', $type);
587     }
592 /**
593  * Set a key in global configuration
594  *
595  * Set a key/value pair in both this session's {@link $CFG} global variable
596  * and in the 'config' database table for future sessions.
597  *
598  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
599  * In that case it doesn't affect $CFG.
600  *
601  * A NULL value will delete the entry.
602  *
603  * No need for get_config because they are usually always available in $CFG
604  *
605  * @param string $name the key to set
606  * @param string $value the value to set (without magic quotes)
607  * @param string $plugin (optional) the plugin scope
608  * @uses $CFG
609  * @return bool
610  */
611 function set_config($name, $value, $plugin=NULL) {
612     global $CFG, $DB;
614     if (empty($plugin)) {
615         if (!array_key_exists($name, $CFG->config_php_settings)) {
616             // So it's defined for this invocation at least
617             if (is_null($value)) {
618                 unset($CFG->$name);
619             } else {
620                 $CFG->$name = (string)$value; // settings from db are always strings
621             }
622         }
624         if ($DB->get_field('config', 'name', array('name'=>$name))) {
625             if ($value===null) {
626                 return $DB->delete_records('config', array('name'=>$name));
627             } else {
628                 return $DB->set_field('config', 'value', $value, array('name'=>$name));
629             }
630         } else {
631             if ($value===null) {
632                 return true;
633             }
634             $config = new object();
635             $config->name  = $name;
636             $config->value = $value;
637             return $DB->insert_record('config', $config);
638         }
640     } else { // plugin scope
641         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
642             if ($value===null) {
643                 return $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
644             } else {
645                 return $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
646             }
647         } else {
648             if ($value===null) {
649                 return true;
650             }
651             $config = new object();
652             $config->plugin = $plugin;
653             $config->name   = $name;
654             $config->value  = $value;
655             return $DB->insert_record('config_plugins', $config);
656         }
657     }
660 /**
661  * Get configuration values from the global config table
662  * or the config_plugins table.
663  *
664  * If called with no parameters it will do the right thing
665  * generating $CFG safely from the database without overwriting
666  * existing values.
667  *
668  * If called with 2 parameters it will return a $string single
669  * value or false of the value is not found.
670  *
671  * @param string $plugin
672  * @param string $name
673  * @uses $CFG
674  * @return hash-like object or single value
675  *
676  */
677 function get_config($plugin=NULL, $name=NULL) {
678     global $CFG, $DB;
680     if (!empty($name)) { // the user is asking for a specific value
681         if (!empty($plugin)) {
682             return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
683         } else {
684             return $DB->get_field('config', 'value', array('name'=>$name));
685         }
686     }
688     // the user is after a recordset
689     if (!empty($plugin)) {
690         if ($configs = $DB->get_records('config_plugins', array('plugin'=>$plugin), '', 'name,value')) {
691             $configs = (array)$configs;
692             $localcfg = array();
693             foreach ($configs as $config) {
694                 $localcfg[$config->name] = $config->value;
695             }
696             return (object)$localcfg;
697         } else {
698             return false;
699         }
700     } else {
701         // this was originally in setup.php
702         if ($configs = $DB->get_records('config')) {
703             $localcfg = (array)$CFG;
704             foreach ($configs as $config) {
705                 if (!isset($localcfg[$config->name])) {
706                     $localcfg[$config->name] = $config->value;
707                 }
708                 // do not complain anymore if config.php overrides settings from db
709             }
711             $localcfg = (object)$localcfg;
712             return $localcfg;
713         } else {
714             // preserve $CFG if DB returns nothing or error
715             return $CFG;
716         }
718     }
721 /**
722  * Removes a key from global configuration
723  *
724  * @param string $name the key to set
725  * @param string $plugin (optional) the plugin scope
726  * @uses $CFG
727  * @return bool
728  */
729 function unset_config($name, $plugin=NULL) {
730     global $CFG, $DB;
732     unset($CFG->$name);
734     if (empty($plugin)) {
735         return $DB->delete_records('config', array('name'=>$name));
736     } else {
737         return $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
738     }
741 /**
742  * Get volatile flags
743  *
744  * @param string $type
745  * @param int    $changedsince
746  * @return records array
747  *
748  */
749 function get_cache_flags($type, $changedsince=NULL) {
750     global $DB;
752     $params = array('type'=>$type, 'expiry'=>time());
753     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
754     if ($changedsince !== NULL) {
755         $params['changedsince'] = $changedsince;
756         $sqlwhere .= " AND timemodified > :changedsince";
757     }
758     $cf = array();
760     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
761         foreach ($flags as $flag) {
762             $cf[$flag->name] = $flag->value;
763         }
764     }
765     return $cf;
768 /**
769  * Get volatile flags
770  *
771  * @param string $type
772  * @param string $name
773  * @param int    $changedsince
774  * @return records array
775  *
776  */
777 function get_cache_flag($type, $name, $changedsince=NULL) {
778     global $DB;
780     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
782     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
783     if ($changedsince !== NULL) {
784         $params['changedsince'] = $changedsince;
785         $sqlwhere .= " AND timemodified > :changedsince";
786     }
788     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
791 /**
792  * Set a volatile flag
793  *
794  * @param string $type the "type" namespace for the key
795  * @param string $name the key to set
796  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
797  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
798  * @return bool
799  */
800 function set_cache_flag($type, $name, $value, $expiry=NULL) {
801     global $DB;
803     $timemodified = time();
804     if ($expiry===NULL || $expiry < $timemodified) {
805         $expiry = $timemodified + 24 * 60 * 60;
806     } else {
807         $expiry = (int)$expiry;
808     }
810     if ($value === NULL) {
811         return unset_cache_flag($type,$name);
812     }
814     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type))) { // this is a potentail problem in DEBUG_DEVELOPER
815         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
816             return true; //no need to update; helps rcache too
817         }
818         $f->value        = $value;
819         $f->expiry       = $expiry;
820         $f->timemodified = $timemodified;
821         return $DB->update_record('cache_flags', $f);
822     } else {
823         $f = new object();
824         $f->flagtype     = $type;
825         $f->name         = $name;
826         $f->value        = $value;
827         $f->expiry       = $expiry;
828         $f->timemodified = $timemodified;
829         return (bool)$DB->insert_record('cache_flags', $f);
830     }
833 /**
834  * Removes a single volatile flag
835  *
836  * @param string $type the "type" namespace for the key
837  * @param string $name the key to set
838  * @uses $CFG
839  * @return bool
840  */
841 function unset_cache_flag($type, $name) {
842     global $DB;
843     return $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
846 /**
847  * Garbage-collect volatile flags
848  *
849  */
850 function gc_cache_flags() {
851     global $DB;
852     return $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
855 /**
856  * Refresh current $USER session global variable with all their current preferences.
857  * @uses $USER
858  */
859 function reload_user_preferences() {
860     global $USER, $DB;
862     //reset preference
863     $USER->preference = array();
865     if (!isloggedin() or isguestuser()) {
866         // no permanent storage for not-logged-in user and guest
868     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
869         foreach ($preferences as $preference) {
870             $USER->preference[$preference->name] = $preference->value;
871         }
872     }
874     return true;
877 /**
878  * Sets a preference for the current user
879  * Optionally, can set a preference for a different user object
880  * @uses $USER
881  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
883  * @param string $name The key to set as preference for the specified user
884  * @param string $value The value to set forthe $name key in the specified user's record
885  * @param int $otheruserid A moodle user ID
886  * @return bool
887  */
888 function set_user_preference($name, $value, $otheruserid=NULL) {
889     global $USER, $DB;
891     if (!isset($USER->preference)) {
892         reload_user_preferences();
893     }
895     if (empty($name)) {
896         return false;
897     }
899     $nostore = false;
901     if (empty($otheruserid)){
902         if (!isloggedin() or isguestuser()) {
903             $nostore = true;
904         }
905         $userid = $USER->id;
906     } else {
907         if (isguestuser($otheruserid)) {
908             $nostore = true;
909         }
910         $userid = $otheruserid;
911     }
913     $return = true;
914     if ($nostore) {
915         // no permanent storage for not-logged-in user and guest
917     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
918         if ($preference->value === $value) {
919             return true;
920         }
921         if (!$DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id))) {
922             $return = false;
923         }
925     } else {
926         $preference = new object();
927         $preference->userid = $userid;
928         $preference->name   = $name;
929         $preference->value  = (string)$value;
930         if (!$DB->insert_record('user_preferences', $preference)) {
931             $return = false;
932         }
933     }
935     // update value in USER session if needed
936     if ($userid == $USER->id) {
937         $USER->preference[$name] = (string)$value;
938     }
940     return $return;
943 /**
944  * Unsets a preference completely by deleting it from the database
945  * Optionally, can set a preference for a different user id
946  * @uses $USER
947  * @param string  $name The key to unset as preference for the specified user
948  * @param int $otheruserid A moodle user ID
949  */
950 function unset_user_preference($name, $otheruserid=NULL) {
951     global $USER, $DB;
953     if (!isset($USER->preference)) {
954         reload_user_preferences();
955     }
957     if (empty($otheruserid)){
958         $userid = $USER->id;
959     } else {
960         $userid = $otheruserid;
961     }
963     //Delete the preference from $USER if needed
964     if ($userid == $USER->id) {
965         unset($USER->preference[$name]);
966     }
968     //Then from DB
969     return $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
973 /**
974  * Sets a whole array of preferences for the current user
975  * @param array $prefarray An array of key/value pairs to be set
976  * @param int $otheruserid A moodle user ID
977  * @return bool
978  */
979 function set_user_preferences($prefarray, $otheruserid=NULL) {
981     if (!is_array($prefarray) or empty($prefarray)) {
982         return false;
983     }
985     $return = true;
986     foreach ($prefarray as $name => $value) {
987         // The order is important; test for return is done first
988         $return = (set_user_preference($name, $value, $otheruserid) && $return);
989     }
990     return $return;
993 /**
994  * If no arguments are supplied this function will return
995  * all of the current user preferences as an array.
996  * If a name is specified then this function
997  * attempts to return that particular preference value.  If
998  * none is found, then the optional value $default is returned,
999  * otherwise NULL.
1000  * @param string $name Name of the key to use in finding a preference value
1001  * @param string $default Value to be returned if the $name key is not set in the user preferences
1002  * @param int $otheruserid A moodle user ID
1003  * @uses $USER
1004  * @return string
1005  */
1006 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1007     global $USER, $DB;
1009     if (!isset($USER->preference)) {
1010         reload_user_preferences();
1011     }
1013     if (empty($otheruserid)){
1014         $userid = $USER->id;
1015     } else {
1016         $userid = $otheruserid;
1017     }
1019     if ($userid == $USER->id) {
1020         $preference = $USER->preference;
1022     } else {
1023         $preference = array();
1024         if ($prefdata = $DB->get_records('user_preferences', array('userid'=>$userid))) {
1025             foreach ($prefdata as $pref) {
1026                 $preference[$pref->name] = $pref->value;
1027             }
1028         }
1029     }
1031     if (empty($name)) {
1032         return $preference;            // All values
1034     } else if (array_key_exists($name, $preference)) {
1035         return $preference[$name];    // The single value
1037     } else {
1038         return $default;              // Default value (or NULL)
1039     }
1043 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1045 /**
1046  * Given date parts in user time produce a GMT timestamp.
1047  *
1048  * @param int $year The year part to create timestamp of
1049  * @param int $month The month part to create timestamp of
1050  * @param int $day The day part to create timestamp of
1051  * @param int $hour The hour part to create timestamp of
1052  * @param int $minute The minute part to create timestamp of
1053  * @param int $second The second part to create timestamp of
1054  * @param float $timezone ?
1055  * @param bool $applydst ?
1056  * @return int timestamp
1057  * @todo Finish documenting this function
1058  */
1059 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1061     $strtimezone = NULL;
1062     if (!is_numeric($timezone)) {
1063         $strtimezone = $timezone;
1064     }
1066     $timezone = get_user_timezone_offset($timezone);
1068     if (abs($timezone) > 13) {
1069         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1070     } else {
1071         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1072         $time = usertime($time, $timezone);
1073         if($applydst) {
1074             $time -= dst_offset_on($time, $strtimezone);
1075         }
1076     }
1078     return $time;
1082 /**
1083  * Given an amount of time in seconds, returns string
1084  * formatted nicely as weeks, days, hours etc as needed
1085  *
1086  * @uses MINSECS
1087  * @uses HOURSECS
1088  * @uses DAYSECS
1089  * @uses YEARSECS
1090  * @param int $totalsecs ?
1091  * @param array $str ?
1092  * @return string
1093  */
1094  function format_time($totalsecs, $str=NULL) {
1096     $totalsecs = abs($totalsecs);
1098     if (!$str) {  // Create the str structure the slow way
1099         $str->day   = get_string('day');
1100         $str->days  = get_string('days');
1101         $str->hour  = get_string('hour');
1102         $str->hours = get_string('hours');
1103         $str->min   = get_string('min');
1104         $str->mins  = get_string('mins');
1105         $str->sec   = get_string('sec');
1106         $str->secs  = get_string('secs');
1107         $str->year  = get_string('year');
1108         $str->years = get_string('years');
1109     }
1112     $years     = floor($totalsecs/YEARSECS);
1113     $remainder = $totalsecs - ($years*YEARSECS);
1114     $days      = floor($remainder/DAYSECS);
1115     $remainder = $totalsecs - ($days*DAYSECS);
1116     $hours     = floor($remainder/HOURSECS);
1117     $remainder = $remainder - ($hours*HOURSECS);
1118     $mins      = floor($remainder/MINSECS);
1119     $secs      = $remainder - ($mins*MINSECS);
1121     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1122     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1123     $sh = ($hours == 1) ? $str->hour : $str->hours;
1124     $sd = ($days == 1)  ? $str->day  : $str->days;
1125     $sy = ($years == 1)  ? $str->year  : $str->years;
1127     $oyears = '';
1128     $odays = '';
1129     $ohours = '';
1130     $omins = '';
1131     $osecs = '';
1133     if ($years)  $oyears  = $years .' '. $sy;
1134     if ($days)  $odays  = $days .' '. $sd;
1135     if ($hours) $ohours = $hours .' '. $sh;
1136     if ($mins)  $omins  = $mins .' '. $sm;
1137     if ($secs)  $osecs  = $secs .' '. $ss;
1139     if ($years) return trim($oyears .' '. $odays);
1140     if ($days)  return trim($odays .' '. $ohours);
1141     if ($hours) return trim($ohours .' '. $omins);
1142     if ($mins)  return trim($omins .' '. $osecs);
1143     if ($secs)  return $osecs;
1144     return get_string('now');
1147 /**
1148  * Returns a formatted string that represents a date in user time
1149  * <b>WARNING: note that the format is for strftime(), not date().</b>
1150  * Because of a bug in most Windows time libraries, we can't use
1151  * the nicer %e, so we have to use %d which has leading zeroes.
1152  * A lot of the fuss in the function is just getting rid of these leading
1153  * zeroes as efficiently as possible.
1154  *
1155  * If parameter fixday = true (default), then take off leading
1156  * zero from %d, else mantain it.
1157  *
1158  * @uses HOURSECS
1159  * @param  int $date timestamp in GMT
1160  * @param string $format strftime format
1161  * @param float $timezone
1162  * @param bool $fixday If true (default) then the leading
1163  * zero from %d is removed. If false then the leading zero is mantained.
1164  * @return string
1165  */
1166 function userdate($date, $format='', $timezone=99, $fixday = true) {
1168     global $CFG;
1170     $strtimezone = NULL;
1171     if (!is_numeric($timezone)) {
1172         $strtimezone = $timezone;
1173     }
1175     if (empty($format)) {
1176         $format = get_string('strftimedaydatetime');
1177     }
1179     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1180         $fixday = false;
1181     } else if ($fixday) {
1182         $formatnoday = str_replace('%d', 'DD', $format);
1183         $fixday = ($formatnoday != $format);
1184     }
1186     $date += dst_offset_on($date, $strtimezone);
1188     $timezone = get_user_timezone_offset($timezone);
1190     if (abs($timezone) > 13) {   /// Server time
1191         if ($fixday) {
1192             $datestring = strftime($formatnoday, $date);
1193             $daystring  = str_replace(' 0', '', strftime(' %d', $date));
1194             $datestring = str_replace('DD', $daystring, $datestring);
1195         } else {
1196             $datestring = strftime($format, $date);
1197         }
1198     } else {
1199         $date += (int)($timezone * 3600);
1200         if ($fixday) {
1201             $datestring = gmstrftime($formatnoday, $date);
1202             $daystring  = str_replace(' 0', '', gmstrftime(' %d', $date));
1203             $datestring = str_replace('DD', $daystring, $datestring);
1204         } else {
1205             $datestring = gmstrftime($format, $date);
1206         }
1207     }
1209 /// If we are running under Windows convert from windows encoding to UTF-8
1210 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1212    if ($CFG->ostype == 'WINDOWS') {
1213        if ($localewincharset = get_string('localewincharset')) {
1214            $textlib = textlib_get_instance();
1215            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1216        }
1217    }
1219     return $datestring;
1222 /**
1223  * Given a $time timestamp in GMT (seconds since epoch),
1224  * returns an array that represents the date in user time
1225  *
1226  * @uses HOURSECS
1227  * @param int $time Timestamp in GMT
1228  * @param float $timezone ?
1229  * @return array An array that represents the date in user time
1230  * @todo Finish documenting this function
1231  */
1232 function usergetdate($time, $timezone=99) {
1234     $strtimezone = NULL;
1235     if (!is_numeric($timezone)) {
1236         $strtimezone = $timezone;
1237     }
1239     $timezone = get_user_timezone_offset($timezone);
1241     if (abs($timezone) > 13) {    // Server time
1242         return getdate($time);
1243     }
1245     // There is no gmgetdate so we use gmdate instead
1246     $time += dst_offset_on($time, $strtimezone);
1247     $time += intval((float)$timezone * HOURSECS);
1249     $datestring = gmstrftime('%S_%M_%H_%d_%m_%Y_%w_%j_%A_%B', $time);
1251     list(
1252         $getdate['seconds'],
1253         $getdate['minutes'],
1254         $getdate['hours'],
1255         $getdate['mday'],
1256         $getdate['mon'],
1257         $getdate['year'],
1258         $getdate['wday'],
1259         $getdate['yday'],
1260         $getdate['weekday'],
1261         $getdate['month']
1262     ) = explode('_', $datestring);
1264     return $getdate;
1267 /**
1268  * Given a GMT timestamp (seconds since epoch), offsets it by
1269  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1270  *
1271  * @uses HOURSECS
1272  * @param  int $date Timestamp in GMT
1273  * @param float $timezone
1274  * @return int
1275  */
1276 function usertime($date, $timezone=99) {
1278     $timezone = get_user_timezone_offset($timezone);
1280     if (abs($timezone) > 13) {
1281         return $date;
1282     }
1283     return $date - (int)($timezone * HOURSECS);
1286 /**
1287  * Given a time, return the GMT timestamp of the most recent midnight
1288  * for the current user.
1289  *
1290  * @param int $date Timestamp in GMT
1291  * @param float $timezone ?
1292  * @return ?
1293  */
1294 function usergetmidnight($date, $timezone=99) {
1296     $userdate = usergetdate($date, $timezone);
1298     // Time of midnight of this user's day, in GMT
1299     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1303 /**
1304  * Returns a string that prints the user's timezone
1305  *
1306  * @param float $timezone The user's timezone
1307  * @return string
1308  */
1309 function usertimezone($timezone=99) {
1311     $tz = get_user_timezone($timezone);
1313     if (!is_float($tz)) {
1314         return $tz;
1315     }
1317     if(abs($tz) > 13) { // Server time
1318         return get_string('serverlocaltime');
1319     }
1321     if($tz == intval($tz)) {
1322         // Don't show .0 for whole hours
1323         $tz = intval($tz);
1324     }
1326     if($tz == 0) {
1327         return 'UTC';
1328     }
1329     else if($tz > 0) {
1330         return 'UTC+'.$tz;
1331     }
1332     else {
1333         return 'UTC'.$tz;
1334     }
1338 /**
1339  * Returns a float which represents the user's timezone difference from GMT in hours
1340  * Checks various settings and picks the most dominant of those which have a value
1341  *
1342  * @uses $CFG
1343  * @uses $USER
1344  * @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
1345  * @return int
1346  */
1347 function get_user_timezone_offset($tz = 99) {
1349     global $USER, $CFG;
1351     $tz = get_user_timezone($tz);
1353     if (is_float($tz)) {
1354         return $tz;
1355     } else {
1356         $tzrecord = get_timezone_record($tz);
1357         if (empty($tzrecord)) {
1358             return 99.0;
1359         }
1360         return (float)$tzrecord->gmtoff / HOURMINS;
1361     }
1364 /**
1365  * Returns an int which represents the systems's timezone difference from GMT in seconds
1366  * @param mixed $tz timezone
1367  * @return int if found, false is timezone 99 or error
1368  */
1369 function get_timezone_offset($tz) {
1370     global $CFG;
1372     if ($tz == 99) {
1373         return false;
1374     }
1376     if (is_numeric($tz)) {
1377         return intval($tz * 60*60);
1378     }
1380     if (!$tzrecord = get_timezone_record($tz)) {
1381         return false;
1382     }
1383     return intval($tzrecord->gmtoff * 60);
1386 /**
1387  * Returns a float or a string which denotes the user's timezone
1388  * 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)
1389  * means that for this timezone there are also DST rules to be taken into account
1390  * Checks various settings and picks the most dominant of those which have a value
1391  *
1392  * @uses $USER
1393  * @uses $CFG
1394  * @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
1395  * @return mixed
1396  */
1397 function get_user_timezone($tz = 99) {
1398     global $USER, $CFG;
1400     $timezones = array(
1401         $tz,
1402         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1403         isset($USER->timezone) ? $USER->timezone : 99,
1404         isset($CFG->timezone) ? $CFG->timezone : 99,
1405         );
1407     $tz = 99;
1409     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1410         $tz = $next['value'];
1411     }
1413     return is_numeric($tz) ? (float) $tz : $tz;
1416 /**
1417  * Returns cached timezone record for given $timezonename
1418  *
1419  * @param string $timezonename
1420  * @return mixed timezonerecord object or false
1421  */
1422 function get_timezone_record($timezonename) {
1423     global $CFG, $DB;
1424     static $cache = NULL;
1426     if ($cache === NULL) {
1427         $cache = array();
1428     }
1430     if (isset($cache[$timezonename])) {
1431         return $cache[$timezonename];
1432     }
1434     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1435                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1438 /**
1439  * ?
1440  *
1441  * @uses $CFG
1442  * @uses $USER
1443  * @param ? $fromyear ?
1444  * @param ? $to_year ?
1445  * @return bool
1446  */
1447 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1448     global $CFG, $SESSION, $DB;
1450     $usertz = get_user_timezone($strtimezone);
1452     if (is_float($usertz)) {
1453         // Trivial timezone, no DST
1454         return false;
1455     }
1457     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1458         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1459         unset($SESSION->dst_offsets);
1460         unset($SESSION->dst_range);
1461     }
1463     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1464         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1465         // This will be the return path most of the time, pretty light computationally
1466         return true;
1467     }
1469     // Reaching here means we either need to extend our table or create it from scratch
1471     // Remember which TZ we calculated these changes for
1472     $SESSION->dst_offsettz = $usertz;
1474     if(empty($SESSION->dst_offsets)) {
1475         // If we 're creating from scratch, put the two guard elements in there
1476         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1477     }
1478     if(empty($SESSION->dst_range)) {
1479         // If creating from scratch
1480         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1481         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1483         // Fill in the array with the extra years we need to process
1484         $yearstoprocess = array();
1485         for($i = $from; $i <= $to; ++$i) {
1486             $yearstoprocess[] = $i;
1487         }
1489         // Take note of which years we have processed for future calls
1490         $SESSION->dst_range = array($from, $to);
1491     }
1492     else {
1493         // If needing to extend the table, do the same
1494         $yearstoprocess = array();
1496         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1497         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1499         if($from < $SESSION->dst_range[0]) {
1500             // Take note of which years we need to process and then note that we have processed them for future calls
1501             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1502                 $yearstoprocess[] = $i;
1503             }
1504             $SESSION->dst_range[0] = $from;
1505         }
1506         if($to > $SESSION->dst_range[1]) {
1507             // Take note of which years we need to process and then note that we have processed them for future calls
1508             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1509                 $yearstoprocess[] = $i;
1510             }
1511             $SESSION->dst_range[1] = $to;
1512         }
1513     }
1515     if(empty($yearstoprocess)) {
1516         // This means that there was a call requesting a SMALLER range than we have already calculated
1517         return true;
1518     }
1520     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1521     // Also, the array is sorted in descending timestamp order!
1523     // Get DB data
1525     static $presets_cache = array();
1526     if (!isset($presets_cache[$usertz])) {
1527         $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');
1528     }
1529     if(empty($presets_cache[$usertz])) {
1530         return false;
1531     }
1533     // Remove ending guard (first element of the array)
1534     reset($SESSION->dst_offsets);
1535     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1537     // Add all required change timestamps
1538     foreach($yearstoprocess as $y) {
1539         // Find the record which is in effect for the year $y
1540         foreach($presets_cache[$usertz] as $year => $preset) {
1541             if($year <= $y) {
1542                 break;
1543             }
1544         }
1546         $changes = dst_changes_for_year($y, $preset);
1548         if($changes === NULL) {
1549             continue;
1550         }
1551         if($changes['dst'] != 0) {
1552             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1553         }
1554         if($changes['std'] != 0) {
1555             $SESSION->dst_offsets[$changes['std']] = 0;
1556         }
1557     }
1559     // Put in a guard element at the top
1560     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1561     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1563     // Sort again
1564     krsort($SESSION->dst_offsets);
1566     return true;
1569 function dst_changes_for_year($year, $timezone) {
1571     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1572         return NULL;
1573     }
1575     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1576     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1578     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1579     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1581     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1582     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1584     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1585     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1586     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1588     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1589     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1591     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1594 // $time must NOT be compensated at all, it has to be a pure timestamp
1595 function dst_offset_on($time, $strtimezone = NULL) {
1596     global $SESSION;
1598     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
1599         return 0;
1600     }
1602     reset($SESSION->dst_offsets);
1603     while(list($from, $offset) = each($SESSION->dst_offsets)) {
1604         if($from <= $time) {
1605             break;
1606         }
1607     }
1609     // This is the normal return path
1610     if($offset !== NULL) {
1611         return $offset;
1612     }
1614     // Reaching this point means we haven't calculated far enough, do it now:
1615     // Calculate extra DST changes if needed and recurse. The recursion always
1616     // moves toward the stopping condition, so will always end.
1618     if($from == 0) {
1619         // We need a year smaller than $SESSION->dst_range[0]
1620         if($SESSION->dst_range[0] == 1971) {
1621             return 0;
1622         }
1623         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
1624         return dst_offset_on($time, $strtimezone);
1625     }
1626     else {
1627         // We need a year larger than $SESSION->dst_range[1]
1628         if($SESSION->dst_range[1] == 2035) {
1629             return 0;
1630         }
1631         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
1632         return dst_offset_on($time, $strtimezone);
1633     }
1636 function find_day_in_month($startday, $weekday, $month, $year) {
1638     $daysinmonth = days_in_month($month, $year);
1640     if($weekday == -1) {
1641         // Don't care about weekday, so return:
1642         //    abs($startday) if $startday != -1
1643         //    $daysinmonth otherwise
1644         return ($startday == -1) ? $daysinmonth : abs($startday);
1645     }
1647     // From now on we 're looking for a specific weekday
1649     // Give "end of month" its actual value, since we know it
1650     if($startday == -1) {
1651         $startday = -1 * $daysinmonth;
1652     }
1654     // Starting from day $startday, the sign is the direction
1656     if($startday < 1) {
1658         $startday = abs($startday);
1659         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1661         // This is the last such weekday of the month
1662         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
1663         if($lastinmonth > $daysinmonth) {
1664             $lastinmonth -= 7;
1665         }
1667         // Find the first such weekday <= $startday
1668         while($lastinmonth > $startday) {
1669             $lastinmonth -= 7;
1670         }
1672         return $lastinmonth;
1674     }
1675     else {
1677         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
1679         $diff = $weekday - $indexweekday;
1680         if($diff < 0) {
1681             $diff += 7;
1682         }
1684         // This is the first such weekday of the month equal to or after $startday
1685         $firstfromindex = $startday + $diff;
1687         return $firstfromindex;
1689     }
1692 /**
1693  * Calculate the number of days in a given month
1694  *
1695  * @param int $month The month whose day count is sought
1696  * @param int $year The year of the month whose day count is sought
1697  * @return int
1698  */
1699 function days_in_month($month, $year) {
1700    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
1703 /**
1704  * Calculate the position in the week of a specific calendar day
1705  *
1706  * @param int $day The day of the date whose position in the week is sought
1707  * @param int $month The month of the date whose position in the week is sought
1708  * @param int $year The year of the date whose position in the week is sought
1709  * @return int
1710  */
1711 function dayofweek($day, $month, $year) {
1712     // I wonder if this is any different from
1713     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1714     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
1717 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
1719 /**
1720  * Makes sure that $USER->sesskey exists, if $USER itself exists. It sets a new sesskey
1721  * if one does not already exist, but does not overwrite existing sesskeys. Returns the
1722  * sesskey string if $USER exists, or boolean false if not.
1723  *
1724  * @uses $USER
1725  * @return string
1726  */
1727 function sesskey() {
1728     global $USER;
1730     if(!isset($USER)) {
1731         return false;
1732     }
1734     if (empty($USER->sesskey)) {
1735         $USER->sesskey = random_string(10);
1736     }
1738     return $USER->sesskey;
1742 /**
1743  * For security purposes, this function will check that the currently
1744  * given sesskey (passed as a parameter to the script or this function)
1745  * matches that of the current user.
1746  *
1747  * @param string $sesskey optionally provided sesskey
1748  * @return bool
1749  */
1750 function confirm_sesskey($sesskey=NULL) {
1751     global $USER;
1753     if (!empty($USER->ignoresesskey) || !empty($CFG->ignoresesskey)) {
1754         return true;
1755     }
1757     if (empty($sesskey)) {
1758         $sesskey = required_param('sesskey', PARAM_RAW);  // Check script parameters
1759     }
1761     if (!isset($USER->sesskey)) {
1762         return false;
1763     }
1765     return ($USER->sesskey === $sesskey);
1768 /**
1769  * Setup all global $CFG course variables, set locale and also themes
1770  * This function can be used on pages that do not require login instead of require_login()
1771  *
1772  * @param mixed $courseorid id of the course or course object
1773  */
1774 function course_setup($courseorid=0) {
1775     global $COURSE, $SITE, $DB;
1777 /// Redefine global $COURSE if needed
1778     if (empty($courseorid)) {
1779         // no change in global $COURSE - for backwards compatibiltiy
1780         // if require_rogin() used after require_login($courseid);
1781     } else if (is_object($courseorid)) {
1782         $COURSE = clone($courseorid);
1783     } else {
1784         global $course; // used here only to prevent repeated fetching from DB - may be removed later
1785         if ($courseorid == SITEID) {
1786             $COURSE = clone($SITE);
1787         } else if (!empty($course->id) and $course->id == $courseorid) {
1788             $COURSE = clone($course);
1789         } else {
1790             if (!$COURSE = $DB->get_record('course', array('id'=>$courseorid))) {
1791                 print_error('invalidcourseid');
1792             }
1793         }
1794     }
1796 /// set locale and themes
1797     moodle_setlocale();
1798     theme_setup();
1802 /**
1803  * This function checks that the current user is logged in and has the
1804  * required privileges
1805  *
1806  * This function checks that the current user is logged in, and optionally
1807  * whether they are allowed to be in a particular course and view a particular
1808  * course module.
1809  * If they are not logged in, then it redirects them to the site login unless
1810  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
1811  * case they are automatically logged in as guests.
1812  * If $courseid is given and the user is not enrolled in that course then the
1813  * user is redirected to the course enrolment page.
1814  * If $cm is given and the coursemodule is hidden and the user is not a teacher
1815  * in the course then the user is redirected to the course home page.
1816  *
1817  * @uses $CFG
1818  * @uses $SESSION
1819  * @uses $USER
1820  * @uses $FULLME
1821  * @uses SITEID
1822  * @uses $COURSE
1823  * @param mixed $courseorid id of the course or course object
1824  * @param bool $autologinguest
1825  * @param object $cm course module object
1826  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
1827  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
1828  *             in order to keep redirects working properly. MDL-14495
1829  */
1830 function require_login($courseorid=0, $autologinguest=true, $cm=null, $setwantsurltome=true) {
1831     global $CFG, $SESSION, $USER, $COURSE, $FULLME;
1833 /// setup global $COURSE, themes, language and locale
1834     course_setup($courseorid);
1836 /// If the user is not even logged in yet then make sure they are
1837     if (!isloggedin()) {
1838         //NOTE: $USER->site check was obsoleted by session test cookie,
1839         //      $USER->confirmed test is in login/index.php
1840         if ($setwantsurltome) {
1841             $SESSION->wantsurl = $FULLME;
1842         }
1843         if (!empty($_SERVER['HTTP_REFERER'])) {
1844             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
1845         }
1846         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests) and ($COURSE->id == SITEID or $COURSE->guest) ) {
1847             $loginguest = '?loginguest=true';
1848         } else {
1849             $loginguest = '';
1850         }
1851         if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
1852             redirect($CFG->wwwroot .'/login/index.php'. $loginguest);
1853         } else {
1854             $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1855             redirect($wwwroot .'/login/index.php');
1856         }
1857         exit;
1858     }
1860 /// loginas as redirection if needed
1861     if ($COURSE->id != SITEID and !empty($USER->realuser)) {
1862         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
1863             if ($USER->loginascontext->instanceid != $COURSE->id) {
1864                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
1865             }
1866         }
1867     }
1869 /// check whether the user should be changing password (but only if it is REALLY them)
1870     if (get_user_preferences('auth_forcepasswordchange') && empty($USER->realuser)) {
1871         $userauth = get_auth_plugin($USER->auth);
1872         if ($userauth->can_change_password()) {
1873             $SESSION->wantsurl = $FULLME;
1874             if ($changeurl = $userauth->change_password_url()) {
1875                 //use plugin custom url
1876                 redirect($changeurl);
1877             } else {
1878                 //use moodle internal method
1879                 if (empty($CFG->loginhttps)) {
1880                     redirect($CFG->wwwroot .'/login/change_password.php');
1881                 } else {
1882                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1883                     redirect($wwwroot .'/login/change_password.php');
1884                 }
1885             }
1886         } else {
1887             print_error('nopasswordchangeforced', 'auth');
1888         }
1889     }
1891 /// Check that the user account is properly set up
1892     if (user_not_fully_set_up($USER)) {
1893         $SESSION->wantsurl = $FULLME;
1894         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
1895     }
1897 /// Make sure current IP matches the one for this session (if required)
1898     if (!empty($CFG->tracksessionip)) {
1899         if ($USER->sessionIP != md5(getremoteaddr())) {
1900             print_error('sessionipnomatch', 'error');
1901         }
1902     }
1904 /// Make sure the USER has a sesskey set up.  Used for checking script parameters.
1905     sesskey();
1907     // Check that the user has agreed to a site policy if there is one
1908     if (!empty($CFG->sitepolicy)) {
1909         if (!$USER->policyagreed) {
1910             $SESSION->wantsurl = $FULLME;
1911             redirect($CFG->wwwroot .'/user/policy.php');
1912         }
1913     }
1915     // Fetch the system context, we are going to use it a lot.
1916     $sysctx = get_context_instance(CONTEXT_SYSTEM);
1918 /// If the site is currently under maintenance, then print a message
1919     if (!has_capability('moodle/site:config', $sysctx)) {
1920         if (file_exists($CFG->dataroot.'/'.SITEID.'/maintenance.html')) {
1921             print_maintenance_message();
1922             exit;
1923         }
1924     }
1926 /// groupmembersonly access control
1927     if (!empty($CFG->enablegroupings) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
1928         if (isguestuser() or !groups_has_membership($cm)) {
1929             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
1930         }
1931     }
1933     // Fetch the course context, and prefetch its child contexts
1934     if (!isset($COURSE->context)) {
1935         if ( ! $COURSE->context = get_context_instance(CONTEXT_COURSE, $COURSE->id) ) {
1936             print_error('nocontext');
1937         }
1938     }
1939     if ($COURSE->id == SITEID) {
1940         /// Eliminate hidden site activities straight away
1941         if (!empty($cm) && !$cm->visible
1942             && !has_capability('moodle/course:viewhiddenactivities', $COURSE->context)) {
1943             redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
1944         }
1945         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
1946         return;
1948     } else {
1950         /// Check if the user can be in a particular course
1951         if (empty($USER->access['rsw'][$COURSE->context->path])) {
1952             //
1953             // MDL-13900 - If the course or the parent category are hidden
1954             // and the user hasn't the 'course:viewhiddencourses' capability, prevent access
1955             //
1956             if ( !($COURSE->visible && course_parent_visible($COURSE)) &&
1957                    !has_capability('moodle/course:viewhiddencourses', $COURSE->context)) {
1958                 print_header_simple();
1959                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
1960             }
1961         }
1963     /// Non-guests who don't currently have access, check if they can be allowed in as a guest
1965         if ($USER->username != 'guest' and !has_capability('moodle/course:view', $COURSE->context)) {
1966             if ($COURSE->guest == 1) {
1967                  // Temporarily assign them guest role for this context, if it fails later user is asked to enrol
1968                  $USER->access = load_temp_role($COURSE->context, $CFG->guestroleid, $USER->access);
1969             }
1970         }
1972     /// If the user is a guest then treat them according to the course policy about guests
1974         if (has_capability('moodle/legacy:guest', $COURSE->context, NULL, false)) {
1975             if (has_capability('moodle/site:doanything', $sysctx)) {
1976                 // administrators must be able to access any course - even if somebody gives them guest access
1977                 user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
1978                 return;
1979             }
1981             switch ($COURSE->guest) {    /// Check course policy about guest access
1983                 case 1:    /// Guests always allowed
1984                     if (!has_capability('moodle/course:view', $COURSE->context)) {    // Prohibited by capability
1985                         print_header_simple();
1986                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), "$CFG->wwwroot/login/index.php");
1987                     }
1988                     if (!empty($cm) and !$cm->visible) { // Not allowed to see module, send to course page
1989                         redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course,
1990                                  get_string('activityiscurrentlyhidden'));
1991                     }
1993                     user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
1994                     return;   // User is allowed to see this course
1996                     break;
1998                 case 2:    /// Guests allowed with key
1999                     if (!empty($USER->enrolkey[$COURSE->id])) {   // Set by enrol/manual/enrol.php
2000                         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2001                         return true;
2002                     }
2003                     //  otherwise drop through to logic below (--> enrol.php)
2004                     break;
2006                 default:    /// Guests not allowed
2007                     $strloggedinasguest = get_string('loggedinasguest');
2008                     print_header_simple('', '',
2009                             build_navigation(array(array('name' => $strloggedinasguest, 'link' => null, 'type' => 'misc'))));
2010                     if (empty($USER->access['rsw'][$COURSE->context->path])) {  // Normal guest
2011                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), "$CFG->wwwroot/login/index.php");
2012                     } else {
2013                         notify(get_string('guestsnotallowed', '', format_string($COURSE->fullname)));
2014                         echo '<div class="notifyproblem">'.switchroles_form($COURSE->id).'</div>';
2015                         print_footer($COURSE);
2016                         exit;
2017                     }
2018                     break;
2019             }
2021     /// For non-guests, check if they have course view access
2023         } else if (has_capability('moodle/course:view', $COURSE->context)) {
2024             if (!empty($USER->realuser)) {   // Make sure the REAL person can also access this course
2025                 if (!has_capability('moodle/course:view', $COURSE->context, $USER->realuser)) {
2026                     print_header_simple();
2027                     notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2028                 }
2029             }
2031         /// Make sure they can read this activity too, if specified
2033             if (!empty($cm) and !$cm->visible and !has_capability('moodle/course:viewhiddenactivities', $COURSE->context)) {
2034                 redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course, get_string('activityiscurrentlyhidden'));
2035             }
2036             user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2037             return;   // User is allowed to see this course
2039         }
2042     /// Currently not enrolled in the course, so see if they want to enrol
2043         $SESSION->wantsurl = $FULLME;
2044         redirect($CFG->wwwroot .'/course/enrol.php?id='. $COURSE->id);
2045         die;
2046     }
2051 /**
2052  * This function just makes sure a user is logged out.
2053  *
2054  * @uses $CFG
2055  * @uses $USER
2056  */
2057 function require_logout() {
2058     global $USER, $CFG, $SESSION;
2060     if (isloggedin()) {
2061         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2063         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2064         foreach($authsequence as $authname) {
2065             $authplugin = get_auth_plugin($authname);
2066             $authplugin->prelogout_hook();
2067         }
2068     }
2070     $SESSION->terminate();
2073 /**
2074  * This is a weaker version of {@link require_login()} which only requires login
2075  * when called from within a course rather than the site page, unless
2076  * the forcelogin option is turned on.
2077  *
2078  * @uses $CFG
2079  * @param mixed $courseorid The course object or id in question
2080  * @param bool $autologinguest Allow autologin guests if that is wanted
2081  * @param object $cm Course activity module if known
2082  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2083  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2084  *             in order to keep redirects working properly. MDL-14495
2085  */
2086 function require_course_login($courseorid, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2087     global $CFG;
2088     if (!empty($CFG->forcelogin)) {
2089         // login required for both SITE and courses
2090         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2092     } else if (!empty($cm) and !$cm->visible) {
2093         // always login for hidden activities
2094         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2096     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2097           or (!is_object($courseorid) and $courseorid == SITEID)) {
2098         //login for SITE not required
2099         user_accesstime_log(SITEID);
2100         return;
2102     } else {
2103         // course login always required
2104         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2105     }
2108 /**
2109  * Require key login. Function terminates with error if key not found or incorrect.
2110  * @param string $script unique script identifier
2111  * @param int $instance optional instance id
2112  */
2113 function require_user_key_login($script, $instance=null) {
2114     global $USER, $SESSION, $CFG, $DB;
2116     if (!NO_MOODLE_COOKIES) {
2117         print_error('sessioncookiesdisable');
2118     }
2120 /// extra safety
2121     @session_write_close();
2123     $keyvalue = required_param('key', PARAM_ALPHANUM);
2125     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2126         print_error('invalidkey');
2127     }
2129     if (!empty($key->validuntil) and $key->validuntil < time()) {
2130         print_error('expiredkey');
2131     }
2133     if ($key->iprestriction) {
2134         $remoteaddr = getremoteaddr();
2135         if ($remoteaddr == '' or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2136             print_error('ipmismatch');
2137         }
2138     }
2140     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2141         print_error('invaliduserid');
2142     }
2144 /// emulate normal session
2145     $USER    = $user;
2147 /// note we are not using normal login
2148     if (!defined('USER_KEY_LOGIN')) {
2149         define('USER_KEY_LOGIN', true);
2150     }
2152     load_all_capabilities();
2154 /// return isntance id - it might be empty
2155     return $key->instance;
2158 /**
2159  * Creates a new private user access key.
2160  * @param string $script unique target identifier
2161  * @param int $userid
2162  * @param instance $int optional instance id
2163  * @param string $iprestriction optional ip restricted access
2164  * @param timestamp $validuntil key valid only until given data
2165  * @return string access key value
2166  */
2167 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2168     global $DB;
2170     $key = new object();
2171     $key->script        = $script;
2172     $key->userid        = $userid;
2173     $key->instance      = $instance;
2174     $key->iprestriction = $iprestriction;
2175     $key->validuntil    = $validuntil;
2176     $key->timecreated   = time();
2178     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2179     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2180         // must be unique
2181         $key->value     = md5($userid.'_'.time().random_string(40));
2182     }
2184     if (!$DB->insert_record('user_private_key', $key)) {
2185         print_error('cannotinsertkey');
2186     }
2188     return $key->value;
2191 /**
2192  * Modify the user table by setting the currently logged in user's
2193  * last login to now.
2194  *
2195  * @uses $USER
2196  * @return bool
2197  */
2198 function update_user_login_times() {
2199     global $USER, $DB;
2201     $user = new object();
2202     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2203     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2205     $user->id = $USER->id;
2207     return $DB->update_record('user', $user);
2210 /**
2211  * Determines if a user has completed setting up their account.
2212  *
2213  * @param user $user A {@link $USER} object to test for the existance of a valid name and email
2214  * @return bool
2215  */
2216 function user_not_fully_set_up($user) {
2217     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2220 function over_bounce_threshold($user) {
2221     global $CFG, $DB;
2223     if (empty($CFG->handlebounces)) {
2224         return false;
2225     }
2226     // set sensible defaults
2227     if (empty($CFG->minbounces)) {
2228         $CFG->minbounces = 10;
2229     }
2230     if (empty($CFG->bounceratio)) {
2231         $CFG->bounceratio = .20;
2232     }
2233     $bouncecount = 0;
2234     $sendcount = 0;
2235     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2236         $bouncecount = $bounce->value;
2237     }
2238     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2239         $sendcount = $send->value;
2240     }
2241     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2244 /**
2245  * @param $user - object containing an id
2246  * @param $reset - will reset the count to 0
2247  */
2248 function set_send_count($user,$reset=false) {
2249     global $DB;
2251     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2252         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2253         $DB->update_record('user_preferences', $pref);
2254     }
2255     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2256         // make a new one
2257         $pref = new object();
2258         $pref->name   = 'email_send_count';
2259         $pref->value  = 1;
2260         $pref->userid = $user->id;
2261         $DB->insert_record('user_preferences', $pref, false);
2262     }
2265 /**
2266 * @param $user - object containing an id
2267  * @param $reset - will reset the count to 0
2268  */
2269 function set_bounce_count($user,$reset=false) {
2270     global $DB;
2272     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2273         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2274         $DB->update_record('user_preferences', $pref);
2275     }
2276     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2277         // make a new one
2278         $pref = new object();
2279         $pref->name   = 'email_bounce_count';
2280         $pref->value  = 1;
2281         $pref->userid = $user->id;
2282         $DB->insert_record('user_preferences', $pref, false);
2283     }
2286 /**
2287  * Keeps track of login attempts
2288  *
2289  * @uses $SESSION
2290  */
2291 function update_login_count() {
2292     global $SESSION;
2294     $max_logins = 10;
2296     if (empty($SESSION->logincount)) {
2297         $SESSION->logincount = 1;
2298     } else {
2299         $SESSION->logincount++;
2300     }
2302     if ($SESSION->logincount > $max_logins) {
2303         unset($SESSION->wantsurl);
2304         print_error('errortoomanylogins');
2305     }
2308 /**
2309  * Resets login attempts
2310  *
2311  * @uses $SESSION
2312  */
2313 function reset_login_count() {
2314     global $SESSION;
2316     $SESSION->logincount = 0;
2319 function sync_metacourses() {
2320     global $DB;
2322     if (!$courses = $DB->get_records('course', array('metacourse'=>1))) {
2323         return;
2324     }
2326     foreach ($courses as $course) {
2327         sync_metacourse($course);
2328     }
2331 /**
2332  * Goes through all enrolment records for the courses inside the metacourse and sync with them.
2333  *
2334  * @param mixed $course the metacourse to synch. Either the course object itself, or the courseid.
2335  */
2336 function sync_metacourse($course) {
2337     global $CFG, $DB;
2339     // Check the course is valid.
2340     if (!is_object($course)) {
2341         if (!$course = $DB->get_record('course', array('id'=>$course))) {
2342             return false; // invalid course id
2343         }
2344     }
2346     // Check that we actually have a metacourse.
2347     if (empty($course->metacourse)) {
2348         return false;
2349     }
2351     // Get a list of roles that should not be synced.
2352     if (!empty($CFG->nonmetacoursesyncroleids)) {
2353         $roleexclusions = 'ra.roleid NOT IN (' . $CFG->nonmetacoursesyncroleids . ') AND';
2354     } else {
2355         $roleexclusions = '';
2356     }
2358     // Get the context of the metacourse.
2359     $context = get_context_instance(CONTEXT_COURSE, $course->id); // SITEID can not be a metacourse
2361     // We do not ever want to unassign the list of metacourse manager, so get a list of them.
2362     if ($users = get_users_by_capability($context, 'moodle/course:managemetacourse')) {
2363         $managers = array_keys($users);
2364     } else {
2365         $managers = array();
2366     }
2368     // Get assignments of a user to a role that exist in a child course, but
2369     // not in the meta coure. That is, get a list of the assignments that need to be made.
2370     if (!$assignments = $DB->get_records_sql("
2371             SELECT ra.id, ra.roleid, ra.userid
2372               FROM {role_assignments} ra, {context} con, {course_meta} cm
2373              WHERE ra.contextid = con.id AND
2374                    con.contextlevel = ".CONTEXT_COURSE." AND
2375                    con.instanceid = cm.child_course AND
2376                    cm.parent_course = ? AND
2377                    $roleexclusions
2378                    NOT EXISTS (
2379                      SELECT 1
2380                        FROM {role_assignments} ra2
2381                       WHERE ra2.userid = ra.userid AND
2382                             ra2.roleid = ra.roleid AND
2383                             ra2.contextid = ?
2384                   )", array($course->id, $context->id))) {
2385         $assignments = array();
2386     }
2388     // Get assignments of a user to a role that exist in the meta course, but
2389     // not in any child courses. That is, get a list of the unassignments that need to be made.
2390     if (!$unassignments = $DB->get_records_sql("
2391             SELECT ra.id, ra.roleid, ra.userid
2392               FROM {role_assignments} ra
2393              WHERE ra.contextid = ? AND
2394                    $roleexclusions
2395                    NOT EXISTS (
2396                     SELECT 1
2397                       FROM {role_assignments} ra2, {context} con2, {course_meta} cm
2398                     WHERE ra2.userid = ra.userid AND
2399                           ra2.roleid = ra.roleid AND
2400                           ra2.contextid = con2.id AND
2401                           con2.contextlevel = " . CONTEXT_COURSE . " AND
2402                           con2.instanceid = cm.child_course AND
2403                           cm.parent_course = ?
2404                   )", array($context->id, $course->id))) {
2405         $unassignments = array();
2406     }
2408     $success = true;
2410     // Make the unassignments, if they are not managers.
2411     foreach ($unassignments as $unassignment) {
2412         if (!in_array($unassignment->userid, $managers)) {
2413             $success = role_unassign($unassignment->roleid, $unassignment->userid, 0, $context->id) && $success;
2414         }
2415     }
2417     // Make the assignments.
2418     foreach ($assignments as $assignment) {
2419         $success = role_assign($assignment->roleid, $assignment->userid, 0, $context->id) && $success;
2420     }
2422     return $success;
2424 // TODO: finish timeend and timestart
2425 // maybe we could rely on cron job to do the cleaning from time to time
2428 /**
2429  * Adds a record to the metacourse table and calls sync_metacoures
2430  */
2431 function add_to_metacourse ($metacourseid, $courseid) {
2432     global $DB;
2434     if (!$metacourse = $DB->get_record("course", array("id"=>$metacourseid))) {
2435         return false;
2436     }
2438     if (!$course = $DB->get_record("course", array("id"=>$courseid))) {
2439         return false;
2440     }
2442     if (!$record = $DB->get_record("course_meta", array("parent_course"=>$metacourseid, "child_course"=>$courseid))) {
2443         $rec = new object();
2444         $rec->parent_course = $metacourseid;
2445         $rec->child_course  = $courseid;
2446         if (!$DB->insert_record('course_meta', $rec)) {
2447             return false;
2448         }
2449         return sync_metacourse($metacourseid);
2450     }
2451     return true;
2455 /**
2456  * Removes the record from the metacourse table and calls sync_metacourse
2457  */
2458 function remove_from_metacourse($metacourseid, $courseid) {
2459     global $DB;
2461     if ($DB->delete_records('course_meta', array('parent_course'=>$metacourseid, 'child_course'=>$courseid))) {
2462         return sync_metacourse($metacourseid);
2463     }
2464     return false;
2468 /**
2469  * Determines if a user is currently logged in
2470  *
2471  * @uses $USER
2472  * @return bool
2473  */
2474 function isloggedin() {
2475     global $USER;
2477     return (!empty($USER->id));
2480 /**
2481  * Determines if a user is logged in as real guest user with username 'guest'.
2482  * This function is similar to original isguest() in 1.6 and earlier.
2483  * Current isguest() is deprecated - do not use it anymore.
2484  *
2485  * @param $user mixed user object or id, $USER if not specified
2486  * @return bool true if user is the real guest user, false if not logged in or other user
2487  */
2488 function isguestuser($user=NULL) {
2489     global $USER, $DB;
2491     if ($user === NULL) {
2492         $user = $USER;
2493     } else if (is_numeric($user)) {
2494         $user = $DB->get_record('user', array('id'=>$user), 'id, username');
2495     }
2497     if (empty($user->id)) {
2498         return false; // not logged in, can not be guest
2499     }
2501     return ($user->username == 'guest');
2504 /**
2505  * Determines if the currently logged in user is in editing mode.
2506  * Note: originally this function had $userid parameter - it was not usable anyway
2507  *
2508  * @uses $USER, $PAGE
2509  * @return bool
2510  */
2511 function isediting() {
2512     global $USER, $PAGE;
2514     if (empty($USER->editing)) {
2515         return false;
2516     } elseif (is_object($PAGE) && method_exists($PAGE,'user_allowed_editing')) {
2517         return $PAGE->user_allowed_editing();
2518     }
2519     return true;//false;
2522 /**
2523  * Determines if the logged in user is currently moving an activity
2524  *
2525  * @uses $USER
2526  * @param int $courseid The id of the course being tested
2527  * @return bool
2528  */
2529 function ismoving($courseid) {
2530     global $USER;
2532     if (!empty($USER->activitycopy)) {
2533         return ($USER->activitycopycourse == $courseid);
2534     }
2535     return false;
2538 /**
2539  * Given an object containing firstname and lastname
2540  * values, this function returns a string with the
2541  * full name of the person.
2542  * The result may depend on system settings
2543  * or language.  'override' will force both names
2544  * to be used even if system settings specify one.
2545  *
2546  * @uses $CFG
2547  * @uses $SESSION
2548  * @param object $user A {@link $USER} object to get full name of
2549  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
2550  */
2551 function fullname($user, $override=false) {
2552     global $CFG, $SESSION;
2554     if (!isset($user->firstname) and !isset($user->lastname)) {
2555         return '';
2556     }
2558     if (!$override) {
2559         if (!empty($CFG->forcefirstname)) {
2560             $user->firstname = $CFG->forcefirstname;
2561         }
2562         if (!empty($CFG->forcelastname)) {
2563             $user->lastname = $CFG->forcelastname;
2564         }
2565     }
2567     if (!empty($SESSION->fullnamedisplay)) {
2568         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
2569     }
2571     if ($CFG->fullnamedisplay == 'firstname lastname') {
2572         return $user->firstname .' '. $user->lastname;
2574     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
2575         return $user->lastname .' '. $user->firstname;
2577     } else if ($CFG->fullnamedisplay == 'firstname') {
2578         if ($override) {
2579             return get_string('fullnamedisplay', '', $user);
2580         } else {
2581             return $user->firstname;
2582         }
2583     }
2585     return get_string('fullnamedisplay', '', $user);
2588 /**
2589  * Returns whether a given authentication plugin exists.
2590  *
2591  * @uses $CFG
2592  * @param string $auth Form of authentication to check for. Defaults to the
2593  *        global setting in {@link $CFG}.
2594  * @return boolean Whether the plugin is available.
2595  */
2596 function exists_auth_plugin($auth) {
2597     global $CFG;
2599     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
2600         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
2601     }
2602     return false;
2605 /**
2606  * Checks if a given plugin is in the list of enabled authentication plugins.
2607  *
2608  * @param string $auth Authentication plugin.
2609  * @return boolean Whether the plugin is enabled.
2610  */
2611 function is_enabled_auth($auth) {
2612     if (empty($auth)) {
2613         return false;
2614     }
2616     $enabled = get_enabled_auth_plugins();
2618     return in_array($auth, $enabled);
2621 /**
2622  * Returns an authentication plugin instance.
2623  *
2624  * @uses $CFG
2625  * @param string $auth name of authentication plugin
2626  * @return object An instance of the required authentication plugin.
2627  */
2628 function get_auth_plugin($auth) {
2629     global $CFG;
2631     // check the plugin exists first
2632     if (! exists_auth_plugin($auth)) {
2633         print_error('authpluginnotfound', 'debug', '', $auth);
2634     }
2636     // return auth plugin instance
2637     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
2638     $class = "auth_plugin_$auth";
2639     return new $class;
2642 /**
2643  * Returns array of active auth plugins.
2644  *
2645  * @param bool $fix fix $CFG->auth if needed
2646  * @return array
2647  */
2648 function get_enabled_auth_plugins($fix=false) {
2649     global $CFG;
2651     $default = array('manual', 'nologin');
2653     if (empty($CFG->auth)) {
2654         $auths = array();
2655     } else {
2656         $auths = explode(',', $CFG->auth);
2657     }
2659     if ($fix) {
2660         $auths = array_unique($auths);
2661         foreach($auths as $k=>$authname) {
2662             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
2663                 unset($auths[$k]);
2664             }
2665         }
2666         $newconfig = implode(',', $auths);
2667         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
2668             set_config('auth', $newconfig);
2669         }
2670     }
2672     return (array_merge($default, $auths));
2675 /**
2676  * Returns true if an internal authentication method is being used.
2677  * if method not specified then, global default is assumed
2678  *
2679  * @uses $CFG
2680  * @param string $auth Form of authentication required
2681  * @return bool
2682  */
2683 function is_internal_auth($auth) {
2684     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
2685     return $authplugin->is_internal();
2688 /**
2689  * Returns an array of user fields
2690  *
2691  * @return array User field/column names
2692  */
2693 function get_user_fieldnames() {
2694     global $DB;
2696     $fieldarray = $DB->get_columns('user');
2697     unset($fieldarray['id']);
2698     $fieldarray = array_keys($fieldarray);
2700     return $fieldarray;
2703 /**
2704  * Creates the default "guest" user. Used both from
2705  * admin/index.php and login/index.php
2706  * @return mixed user object created or boolean false if the creation has failed
2707  */
2708 function create_guest_record() {
2709     global $CFG, $DB;
2711     $guest = new object();
2712     $guest->auth        = 'manual';
2713     $guest->username    = 'guest';
2714     $guest->password    = hash_internal_user_password('guest');
2715     $guest->firstname   = get_string('guestuser');
2716     $guest->lastname    = ' ';
2717     $guest->email       = 'root@localhost';
2718     $guest->description = get_string('guestuserinfo');
2719     $guest->mnethostid  = $CFG->mnet_localhost_id;
2720     $guest->confirmed   = 1;
2721     $guest->lang        = $CFG->lang;
2722     $guest->timemodified= time();
2724     if (! $guest->id = $DB->insert_record('user', $guest)) {
2725         return false;
2726     }
2728     return $guest;
2731 /**
2732  * Creates a bare-bones user record
2733  *
2734  * @uses $CFG
2735  * @param string $username New user's username to add to record
2736  * @param string $password New user's password to add to record
2737  * @param string $auth Form of authentication required
2738  * @return object A {@link $USER} object
2739  * @todo Outline auth types and provide code example
2740  */
2741 function create_user_record($username, $password, $auth='manual') {
2742     global $CFG, $DB;
2744     //just in case check text case
2745     $username = trim(moodle_strtolower($username));
2747     $authplugin = get_auth_plugin($auth);
2749     $newuser = new object();
2751     if ($newinfo = $authplugin->get_userinfo($username)) {
2752         $newinfo = truncate_userinfo($newinfo);
2753         foreach ($newinfo as $key => $value){
2754             $newuser->$key = $value;
2755         }
2756     }
2758     if (!empty($newuser->email)) {
2759         if (email_is_not_allowed($newuser->email)) {
2760             unset($newuser->email);
2761         }
2762     }
2764     $newuser->auth = $auth;
2765     $newuser->username = $username;
2767     // fix for MDL-8480
2768     // user CFG lang for user if $newuser->lang is empty
2769     // or $user->lang is not an installed language
2770     $sitelangs = array_keys(get_list_of_languages());
2771     if (empty($newuser->lang) || !in_array($newuser->lang, $sitelangs)) {
2772         $newuser -> lang = $CFG->lang;
2773     }
2774     $newuser->confirmed = 1;
2775     $newuser->lastip = getremoteaddr();
2776     $newuser->timemodified = time();
2777     $newuser->mnethostid = $CFG->mnet_localhost_id;
2779     if ($DB->insert_record('user', $newuser)) {
2780         $user = get_complete_user_data('username', $newuser->username);
2781         if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
2782             set_user_preference('auth_forcepasswordchange', 1, $user->id);
2783         }
2784         update_internal_user_password($user, $password);
2785         return $user;
2786     }
2787     return false;
2790 /**
2791  * Will update a local user record from an external source
2792  *
2793  * @uses $CFG
2794  * @param string $username New user's username to add to record
2795  * @return user A {@link $USER} object
2796  */
2797 function update_user_record($username, $authplugin) {
2798     global $DB;
2800     $username = trim(moodle_strtolower($username)); /// just in case check text case
2802     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
2803     $userauth = get_auth_plugin($oldinfo->auth);
2805     if ($newinfo = $userauth->get_userinfo($username)) {
2806         $newinfo = truncate_userinfo($newinfo);
2807         foreach ($newinfo as $key => $value){
2808             $confval = $userauth->config->{'field_updatelocal_' . $key};
2809             $lockval = $userauth->config->{'field_lock_' . $key};
2810             if (empty($confval) || empty($lockval)) {
2811                 continue;
2812             }
2813             if ($confval === 'onlogin') {
2814                 // MDL-4207 Don't overwrite modified user profile values with
2815                 // empty LDAP values when 'unlocked if empty' is set. The purpose
2816                 // of the setting 'unlocked if empty' is to allow the user to fill
2817                 // in a value for the selected field _if LDAP is giving
2818                 // nothing_ for this field. Thus it makes sense to let this value
2819                 // stand in until LDAP is giving a value for this field.
2820                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
2821                     $DB->set_field('user', $key, $value, 'username', $username)
2822                         || error_log("Error updating $key for $username");
2823                 }
2824             }
2825         }
2826     }
2828     return get_complete_user_data('username', $username);
2831 /**
2832  * will truncate userinfo as it comes from auth_get_userinfo (from external auth)
2833  * which may have large fields
2834  */
2835 function truncate_userinfo($info) {
2836     // define the limits
2837     $limit = array(
2838                     'username'    => 100,
2839                     'idnumber'    => 255,
2840                     'firstname'   => 100,
2841                     'lastname'    => 100,
2842                     'email'       => 100,
2843                     'icq'         =>  15,
2844                     'phone1'      =>  20,
2845                     'phone2'      =>  20,
2846                     'institution' =>  40,
2847                     'department'  =>  30,
2848                     'address'     =>  70,
2849                     'city'        =>  20,
2850                     'country'     =>   2,
2851                     'url'         => 255,
2852                     );
2854     // apply where needed
2855     foreach (array_keys($info) as $key) {
2856         if (!empty($limit[$key])) {
2857             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
2858         }
2859     }
2861     return $info;
2864 /**
2865  * Marks user deleted in internal user database and notifies the auth plugin.
2866  * Also unenrols user from all roles and does other cleanup.
2867  * @param object $user       Userobject before delete    (without system magic quotes)
2868  * @return boolean success
2869  */
2870 function delete_user($user) {
2871     global $CFG, $DB;
2872     require_once($CFG->libdir.'/grouplib.php');
2873     require_once($CFG->libdir.'/gradelib.php');
2875     $DB->begin_sql();
2877     // delete all grades - backup is kept in grade_grades_history table
2878     if ($grades = grade_grade::fetch_all(array('userid'=>$user->id))) {
2879         foreach ($grades as $grade) {
2880             $grade->delete('userdelete');
2881         }
2882     }
2884     // remove from all groups
2885     $DB->delete_records('groups_members', array('userid'=>$user->id));
2887     // unenrol from all roles in all contexts
2888     role_unassign(0, $user->id); // this might be slow but it is really needed - modules might do some extra cleanup!
2890     // now do a final accesslib cleanup - removes all role assingments in user context and context itself
2891     delete_context(CONTEXT_USER, $user->id);
2893     require_once($CFG->dirroot.'/tag/lib.php');
2894     tag_set('user', $user->id, array());
2896     // workaround for bulk deletes of users with the same email address
2897     $delname = "$user->email.".time();
2898     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
2899         $delname++;
2900     }
2902     // mark internal user record as "deleted"
2903     $updateuser = new object();
2904     $updateuser->id           = $user->id;
2905     $updateuser->deleted      = 1;
2906     $updateuser->username     = $delname;         // Remember it just in case
2907     $updateuser->email        = '';               // Clear this field to free it up
2908     $updateuser->idnumber     = '';               // Clear this field to free it up
2909     $updateuser->timemodified = time();
2911     if ($DB->update_record('user', $updateuser)) {
2912         $DB->commit_sql();
2913         // notify auth plugin - do not block the delete even when plugin fails
2914         $authplugin = get_auth_plugin($user->auth);
2915         $authplugin->user_delete($user);
2917         events_trigger('user_deleted', $user);
2918         return true;
2920     } else {
2921         $DB->rollback_sql();
2922         return false;
2923     }
2926 /**
2927  * Retrieve the guest user object
2928  *
2929  * @uses $CFG
2930  * @return user A {@link $USER} object
2931  */
2932 function guest_user() {
2933     global $CFG, $DB;
2935     if ($newuser = $DB->get_record('user', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
2936         $newuser->confirmed = 1;
2937         $newuser->lang = $CFG->lang;
2938         $newuser->lastip = getremoteaddr();
2939     }
2941     return $newuser;
2944 /**
2945  * Given a username and password, this function looks them
2946  * up using the currently selected authentication mechanism,
2947  * and if the authentication is successful, it returns a
2948  * valid $user object from the 'user' table.
2949  *
2950  * Uses auth_ functions from the currently active auth module
2951  *
2952  * After authenticate_user_login() returns success, you will need to
2953  * log that the user has logged in, and call complete_user_login() to set
2954  * the session up.
2955  *
2956  * @uses $CFG
2957  * @param string $username  User's username
2958  * @param string $password  User's password
2959  * @return user|flase A {@link $USER} object or false if error
2960  */
2961 function authenticate_user_login($username, $password) {
2962     global $CFG, $DB;
2964     $authsenabled = get_enabled_auth_plugins();
2966     if ($user = get_complete_user_data('username', $username)) {
2967         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
2968         if ($auth=='nologin' or !is_enabled_auth($auth)) {
2969             add_to_log(0, 'login', 'error', 'index.php', $username);
2970             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
2971             return false;
2972         }
2973         if (!empty($user->deleted)) {
2974             add_to_log(0, 'login', 'error', 'index.php', $username);
2975             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
2976             return false;
2977         }
2978         $auths = array($auth);
2980     } else {
2981         $auths = $authsenabled;
2982         $user = new object();
2983         $user->id = 0;     // User does not exist
2984     }
2986     foreach ($auths as $auth) {
2987         $authplugin = get_auth_plugin($auth);
2989         // on auth fail fall through to the next plugin
2990         if (!$authplugin->user_login($username, $password)) {
2991             continue;
2992         }
2994         // successful authentication
2995         if ($user->id) {                          // User already exists in database
2996             if (empty($user->auth)) {             // For some reason auth isn't set yet
2997                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
2998                 $user->auth = $auth;
2999             }
3001             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3003             if (!$authplugin->is_internal()) {            // update user record from external DB
3004                 $user = update_user_record($username, get_auth_plugin($user->auth));
3005             }
3006         } else {
3007             // if user not found, create him
3008             $user = create_user_record($username, $password, $auth);
3009         }
3011         $authplugin->sync_roles($user);
3013         foreach ($authsenabled as $hau) {
3014             $hauth = get_auth_plugin($hau);
3015             $hauth->user_authenticated_hook($user, $username, $password);
3016         }
3018     /// Log in to a second system if necessary
3019     /// NOTICE: /sso/ will be moved to auth and deprecated soon; use user_authenticated_hook() instead
3020         if (!empty($CFG->sso)) {
3021             include_once($CFG->dirroot .'/sso/'. $CFG->sso .'/lib.php');
3022             if (function_exists('sso_user_login')) {
3023                 if (!sso_user_login($username, $password)) {   // Perform the signon process
3024                     notify('Second sign-on failed');
3025                 }
3026             }
3027         }
3029         if ($user->id===0) {
3030             return false;
3031         }
3032         return $user;
3033     }
3035     // failed if all the plugins have failed
3036     add_to_log(0, 'login', 'error', 'index.php', $username);
3037     if (debugging('', DEBUG_ALL)) {
3038         error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3039     }
3040     return false;
3043 /**
3044  * Call to complete the user login process after authenticate_user_login()
3045  * has succeeded. It will setup the $USER variable and other required bits
3046  * and pieces.
3047  *
3048  * NOTE:
3049  * - It will NOT log anything -- up to the caller to decide what to log.
3050  *
3051  *
3052  *
3053  * @uses $CFG, $USER
3054  * @param string $user obj
3055  * @return user|flase A {@link $USER} object or false if error
3056  */
3057 function complete_user_login($user) {
3058     global $CFG, $USER, $SESSION;
3060     $USER = $user; // this is required because we need to access preferences here!
3062     reload_user_preferences();
3064     update_user_login_times();
3065     if (empty($CFG->nolastloggedin)) {
3066         $SESSION->set_moodle_cookie($USER->username);
3067     } else {
3068         // do not store last logged in user in cookie
3069         // auth plugins can temporarily override this from loginpage_hook()
3070         // do not save $CFG->nolastloggedin in database!
3071         $SESSION->set_moodle_cookie('nobody');
3072     }
3073     set_login_session_preferences();
3075     // Call enrolment plugins
3076     check_enrolment_plugins($user);
3078     /// This is what lets the user do anything on the site :-)
3079     load_all_capabilities();
3081     /// Select password change url
3082     $userauth = get_auth_plugin($USER->auth);
3084     /// check whether the user should be changing password
3085     if (get_user_preferences('auth_forcepasswordchange', false)){
3086         if ($userauth->can_change_password()) {
3087             if ($changeurl = $userauth->change_password_url()) {
3088                 redirect($changeurl);
3089             } else {
3090                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3091             }
3092         } else {
3093             print_error('nopasswordchangeforced', 'auth');
3094         }
3095     }
3096     return $USER;
3099 /**
3100  * Compare password against hash stored in internal user table.
3101  * If necessary it also updates the stored hash to new format.
3102  *
3103  * @param object user
3104  * @param string plain text password
3105  * @return bool is password valid?
3106  */
3107 function validate_internal_user_password(&$user, $password) {
3108     global $CFG;
3110     if (!isset($CFG->passwordsaltmain)) {
3111         $CFG->passwordsaltmain = '';
3112     }
3114     $validated = false;
3116     // get password original encoding in case it was not updated to unicode yet
3117     $textlib = textlib_get_instance();
3118     $convpassword = $textlib->convert($password, 'utf-8', get_string('oldcharset'));
3120     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)
3121         or $user->password == md5($convpassword.$CFG->passwordsaltmain) or $user->password == md5($convpassword)) {
3122         $validated = true;
3123     } else {
3124         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3125             $alt = 'passwordsaltalt'.$i;
3126             if (!empty($CFG->$alt)) {
3127                 if ($user->password == md5($password.$CFG->$alt) or $user->password == md5($convpassword.$CFG->$alt)) {
3128                     $validated = true;
3129                     break;
3130                 }
3131             }
3132         }
3133     }
3135     if ($validated) {
3136         // force update of password hash using latest main password salt and encoding if needed
3137         update_internal_user_password($user, $password);
3138     }
3140     return $validated;
3143 /**
3144  * Calculate hashed value from password using current hash mechanism.
3145  *
3146  * @param string password
3147  * @return string password hash
3148  */
3149 function hash_internal_user_password($password) {
3150     global $CFG;
3152     if (isset($CFG->passwordsaltmain)) {
3153         return md5($password.$CFG->passwordsaltmain);
3154     } else {
3155         return md5($password);
3156     }
3159 /**
3160  * Update pssword hash in user object.
3161  *
3162  * @param object user
3163  * @param string plain text password
3164  * @param bool store changes also in db, default true
3165  * @return true if hash changed
3166  */
3167 function update_internal_user_password(&$user, $password) {
3168     global $CFG, $DB;
3170     $authplugin = get_auth_plugin($user->auth);
3171     if (!empty($authplugin->config->preventpassindb)) {
3172         $hashedpassword = 'not cached';
3173     } else {
3174         $hashedpassword = hash_internal_user_password($password);
3175     }
3177     return $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
3180 /**
3181  * Get a complete user record, which includes all the info
3182  * in the user record
3183  * Intended for setting as $USER session variable
3184  *
3185  * @uses $CFG
3186  * @uses SITEID
3187  * @param string $field The user field to be checked for a given value.
3188  * @param string $value The value to match for $field.
3189  * @return user A {@link $USER} object.
3190  */
3191 function get_complete_user_data($field, $value, $mnethostid=null) {
3192     global $CFG, $DB;
3194     if (!$field || !$value) {
3195         return false;
3196     }
3198 /// Build the WHERE clause for an SQL query
3199     $params = array('fieldval'=>$value);
3200     $constraints = "$field = :fieldval AND deleted <> 1";
3202     if (is_null($mnethostid)) {
3203         // if null, we restrict to local users
3204         // ** testing for local user can be done with
3205         //    mnethostid = $CFG->mnet_localhost_id
3206         //    or with
3207         //    auth != 'mnet'
3208         //    but the first one is FAST with our indexes
3209         $mnethostid = $CFG->mnet_localhost_id;
3210     }
3211     $params['mnethostid'] = $mnethostid;
3212     $constraints .= " AND mnethostid = :mnethostid";
3214 /// Get all the basic user data
3216     if (! $user = $DB->get_record_select('user', $constraints, $params)) {
3217         return false;
3218     }
3220 /// Get various settings and preferences
3222     if ($displays = $DB->get_records('course_display', array('userid'=>$user->id))) {
3223         foreach ($displays as $display) {
3224             $user->display[$display->course] = $display->display;
3225         }
3226     }
3228     $user->preference = get_user_preferences(null, null, $user->id);
3230     $user->lastcourseaccess    = array(); // during last session
3231     $user->currentcourseaccess = array(); // during current session
3232     if ($lastaccesses = $DB->get_records('user_lastaccess', array('userid'=>$user->id))) {
3233         foreach ($lastaccesses as $lastaccess) {
3234             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
3235         }
3236     }
3238     $sql = "SELECT g.id, g.courseid
3239               FROM {groups} g, {groups_members} gm
3240              WHERE gm.groupid=g.id AND gm.userid=?";
3242     // this is a special hack to speedup calendar display
3243     $user->groupmember = array();
3244     if ($groups = $DB->get_records_sql($sql, array($user->id))) {
3245         foreach ($groups as $group) {
3246             if (!array_key_exists($group->courseid, $user->groupmember)) {
3247                 $user->groupmember[$group->courseid] = array();
3248             }
3249             $user->groupmember[$group->courseid][$group->id] = $group->id;
3250         }
3251     }
3253 /// Add the custom profile fields to the user record
3254     require_once($CFG->dirroot.'/user/profile/lib.php');
3255     $customfields = (array)profile_user_record($user->id);
3256     foreach ($customfields as $cname=>$cvalue) {
3257         if (!isset($user->$cname)) { // Don't overwrite any standard fields
3258             $user->$cname = $cvalue;
3259         }
3260     }
3262 /// Rewrite some variables if necessary
3263     if (!empty($user->description)) {
3264         $user->description = true;   // No need to cart all of it around
3265     }
3266     if ($user->username == 'guest') {
3267         $user->lang       = $CFG->lang;               // Guest language always same as site
3268         $user->firstname  = get_string('guestuser');  // Name always in current language
3269         $user->lastname   = ' ';
3270     }
3272     $user->sesskey  = random_string(10);
3273     $user->sessionIP = md5(getremoteaddr());   // Store the current IP in the session
3275     return $user;
3278 /**
3279  * @uses $CFG
3280  * @param string $password the password to be checked agains the password policy
3281  * @param string $errmsg the error message to display when the password doesn't comply with the policy.
3282  * @return bool true if the password is valid according to the policy. false otherwise.
3283  */
3284 function check_password_policy($password, &$errmsg) {
3285     global $CFG;
3287     if (empty($CFG->passwordpolicy)) {
3288         return true;
3289     }
3291     $textlib = textlib_get_instance();
3292     $errmsg = '';
3293     if ($textlib->strlen($password) < $CFG->minpasswordlength) {
3294         $errmsg = get_string('errorminpasswordlength', 'auth', $CFG->minpasswordlength);
3296     } else if (preg_match_all('/[[:digit:]]/u', $password, $matches) < $CFG->minpassworddigits) {
3297         $errmsg = get_string('errorminpassworddigits', 'auth', $CFG->minpassworddigits);
3299     } else if (preg_match_all('/[[:lower:]]/u', $password, $matches) < $CFG->minpasswordlower) {
3300         $errmsg = get_string('errorminpasswordlower', 'auth', $CFG->minpasswordlower);
3302     } else if (preg_match_all('/[[:upper:]]/u', $password, $matches) < $CFG->minpasswordupper) {
3303         $errmsg = get_string('errorminpasswordupper', 'auth', $CFG->minpasswordupper);
3305     } else if (preg_match_all('/[^[:upper:][:lower:][:digit:]]/u', $password, $matches) < $CFG->minpasswordnonalphanum) {
3306         $errmsg = get_string('errorminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3308     } else if ($password == 'admin' or $password == 'password') {
3309         $errmsg = get_string('unsafepassword');
3310     }
3312     if ($errmsg == '') {
3313         return true;
3314     } else {
3315         return false;
3316     }
3320 /**
3321  * When logging in, this function is run to set certain preferences
3322  * for the current SESSION
3323  */
3324 function set_login_session_preferences() {
3325     global $SESSION, $CFG;
3327     $SESSION->justloggedin = true;
3329     unset($SESSION->lang);
3331     // Restore the calendar filters, if saved
3332     if (intval(get_user_preferences('calendar_persistflt', 0))) {
3333         include_once($CFG->dirroot.'/calendar/lib.php');
3334         calendar_set_filters_status(get_user_preferences('calendav_savedflt', 0xff));
3335     }
3339 /**
3340  * Delete a course, including all related data from the database,
3341  * and any associated files from the moodledata folder.
3342  *
3343  * @param mixed $courseorid The id of the course or course object to delete.
3344  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3345  * @return bool true if all the removals succeeded. false if there were any failures. If this
3346  *             method returns false, some of the removals will probably have succeeded, and others
3347  *             failed, but you have no way of knowing which.
3348  */
3349 function delete_course($courseorid, $showfeedback = true) {
3350     global $CFG, $DB;
3351     $result = true;
3353     if (is_object($courseorid)) {
3354         $courseid = $courseorid->id;
3355         $course   = $courseorid;
3356     } else {
3357         $courseid = $courseorid;
3358         if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
3359             return false;
3360         } 
3361     }
3363     // frontpage course can not be deleted!!
3364     if ($courseid == SITEID) {
3365         return false;
3366     }
3368     if (!remove_course_contents($courseid, $showfeedback)) {
3369         if ($showfeedback) {
3370             notify("An error occurred while deleting some of the course contents.");
3371         }
3372         $result = false;
3373     }
3375     if (!$DB->delete_records("course", array("id"=>$courseid))) {
3376         if ($showfeedback) {
3377             notify("An error occurred while deleting the main course record.");
3378         }
3379         $result = false;
3380     }
3382 /// Delete all roles and overiddes in the course context
3383     if (!delete_context(CONTEXT_COURSE, $courseid)) {
3384         if ($showfeedback) {
3385             notify("An error occurred while deleting the main course context.");
3386         }
3387         $result = false;
3388     }
3390     if (!fulldelete($CFG->dataroot.'/'.$courseid)) {
3391         if ($showfeedback) {
3392             notify("An error occurred while deleting the course files.");
3393         }
3394         $result = false;
3395     }
3397     if ($result) {
3398         //trigger events
3399         events_trigger('course_deleted', $course);
3400     }
3402     return $result;
3405 /**
3406  * Clear a course out completely, deleting all content
3407  * but don't delete the course itself
3408  *
3409  * @uses $CFG
3410  * @param int $courseid The id of the course that is being deleted
3411  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3412  * @return bool true if all the removals succeeded. false if there were any failures. If this
3413  *             method returns false, some of the removals will probably have succeeded, and others
3414  *             failed, but you have no way of knowing which.
3415  */
3416 function remove_course_contents($courseid, $showfeedback=true) {
3417     global $CFG, $DB;
3418     require_once($CFG->libdir.'/questionlib.php');
3419     require_once($CFG->libdir.'/gradelib.php');
3421     $result = true;
3423     if (! $course = $DB->get_record('course', array('id'=>$courseid))) {
3424         print_error('invalidcourseid');
3425     }
3427     $strdeleted = get_string('deleted');
3429 /// First delete every instance of every module
3431     if ($allmods = $DB->get_records('modules') ) {
3432         foreach ($allmods as $mod) {
3433             $modname = $mod->name;
3434             $modfile = $CFG->dirroot .'/mod/'. $modname .'/lib.php';
3435             $moddelete = $modname .'_delete_instance';       // Delete everything connected to an instance
3436             $moddeletecourse = $modname .'_delete_course';   // Delete other stray stuff (uncommon)
3437             $count=0;
3438             if (file_exists($modfile)) {
3439                 include_once($modfile);
3440                 if (function_exists($moddelete)) {
3441                     if ($instances = $DB->get_records($modname, array('course'=>$course->id))) {
3442                         foreach ($instances as $instance) {
3443                             if ($cm = get_coursemodule_from_instance($modname, $instance->id, $course->id)) {
3444                                 /// Delete activity context questions and question categories
3445                                 question_delete_activity($cm,  $showfeedback);
3446                             }
3447                             if ($moddelete($instance->id)) {
3448                                 $count++;
3450                             } else {
3451                                 notify('Could not delete '. $modname .' instance '. $instance->id .' ('. format_string($instance->name) .')');
3452                                 $result = false;
3453                             }
3454                             if ($cm) {
3455                                 // delete cm and its context in correct order
3456                                 $DB->delete_records('course_modules', array('id'=>$cm->id));
3457                                 delete_context(CONTEXT_MODULE, $cm->id);
3458                             }
3459                         }
3460                     }
3461                 } else {
3462                     notify('Function '.$moddelete.'() doesn\'t exist!');
3463                     $result = false;
3464                 }
3466                 if (function_exists($moddeletecourse)) {
3467                     $moddeletecourse($course, $showfeedback);
3468                 }
3469             }
3470             if ($showfeedback) {
3471                 notify($strdeleted .' '. $count .' x '. $modname);
3472             }
3473         }
3474     } else {
3475         print_error('nomodules', 'debug');
3476     }
3478 /// Give local code a chance to delete its references to this course.
3479     require_once('locallib.php');
3480     notify_local_delete_course($courseid, $showfeedback);
3482 /// Delete course blocks
3484     if ($blocks = $DB->get_records_sql("SELECT *
3485                                           FROM {block_instance}
3486                                          WHERE pagetype = '".PAGE_COURSE_VIEW."'
3487                                                AND pageid = ?", array($course->id))) {
3488         if ($DB->delete_records('block_instance', array('pagetype'=>PAGE_COURSE_VIEW, 'pageid'=>$course->id))) {
3489             if ($showfeedback) {
3490                 notify($strdeleted .' block_instance');
3491             }
3493             require_once($CFG->libdir.'/blocklib.php');
3494             foreach ($blocks as $block) {  /// Delete any associated contexts for this block
3496                 delete_context(CONTEXT_BLOCK, $block->id);
3498                 // fix for MDL-7164
3499                 // Get the block object and call instance_delete()
3500                 if (!$record = blocks_get_record($block->blockid)) {
3501                     $result = false;
3502                     continue;
3503                 }
3504                 if (!$obj = block_instance($record->name, $block)) {
3505                     $result = false;
3506                     continue;
3507                 }
3508                 // Return value ignored, in core mods this does not do anything, but just in case
3509                 // third party blocks might have stuff to clean up
3510                 // we execute this anyway
3511                 $obj->instance_delete();
3513             }
3514         } else {
3515             $result = false;
3516         }
3517     }
3519 /// Delete any groups, removing members and grouping/course links first.
3520     require_once($CFG->dirroot.'/group/lib.php');
3521     groups_delete_groupings($courseid, $showfeedback);
3522     groups_delete_groups($courseid, $showfeedback);
3524 /// Delete all related records in other tables that may have a courseid
3525 /// This array stores the tables that need to be cleared, as
3526 /// table_name => column_name that contains the course id.
3528     $tablestoclear = array(
3529         'event' => 'courseid', // Delete events
3530         'log' => 'course', // Delete logs
3531         'course_sections' => 'course', // Delete any course stuff
3532         'course_modules' => 'course',
3533         'backup_courses' => 'courseid', // Delete scheduled backup stuff
3534         'user_lastaccess' => 'courseid',
3535         'backup_log' => 'courseid'
3536     );
3537     foreach ($tablestoclear as $table => $col) {
3538         if ($DB->delete_records($table, array($col=>$course->id))) {
3539             if ($showfeedback) {
3540                 notify($strdeleted . ' ' . $table);
3541             }
3542         } else {
3543             $result = false;
3544         }
3545     }
3548 /// Clean up metacourse stuff
3550     if ($course->metacourse) {
3551         $DB->delete_records("course_meta", array("parent_course"=>$course->id));
3552         sync_metacourse($course->id); // have to do it here so the enrolments get nuked. sync_metacourses won't find it without the id.
3553         if ($showfeedback) {
3554             notify("$strdeleted course_meta");
3555         }
3556     } else {
3557         if ($parents = $DB->get_records("course_meta", array("child_course"=>$course->id))) {
3558             foreach ($parents as $parent) {
3559                 remove_from_metacourse($parent->parent_course,$parent->child_course); // this will do the unenrolments as well.
3560             }
3561             if ($showfeedback) {
3562                 notify("$strdeleted course_meta");
3563             }
3564         }
3565     }
3567 /// Delete questions and question categories
3568     question_delete_course($course, $showfeedback);
3570 /// Remove all data from gradebook
3571     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3572     remove_course_grades($courseid, $showfeedback);
3573     remove_grade_letters($context, $showfeedback);
3575 /// Delete course tags
3576     require_once($CFG->dirroot.'/tag/coursetagslib.php');
3577     coursetag_delete_course_tags($course->id, $showfeedback);
3579     return $result;
3582 /**
3583  * Change dates in module - used from course reset.
3584  * @param strin $modname forum, assignent, etc
3585  * @param array $fields array of date fields from mod table
3586  * @param int $timeshift time difference
3587  * @return success
3588  */
3589 function shift_course_mod_dates($modname, $fields, $timeshift, $courseid) {
3590     global $CFG, $DB;
3591     include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
3593     $return = true;
3594     foreach ($fields as $field) {
3595         $updatesql = "UPDATE {".$modname."}
3596                           SET $field = $field + ?
3597                         WHERE course=? AND $field<>0 AND $field<>0";
3598         $return = $DB->execute($updatesql, array($timeshift, $courseid)) && $return;
3599     }
3601     $refreshfunction = $modname.'_refresh_events';
3602     if (function_exists($refreshfunction)) {
3603         $refreshfunction($courseid);
3604     }
3606     return $return;
3609 /**
3610  * This function will empty a course of user data.
3611  * It will retain the activities and the structure of the course.
3612  * @param object $data an object containing all the settings including courseid (without magic quotes)
3613  * @return array status array of array component, item, error
3614  */
3615 function reset_course_userdata($data) {
3616     global $CFG, $USER, $DB;
3617     require_once($CFG->libdir.'/gradelib.php');
3618     require_once($CFG->dirroot.'/group/lib.php');
3620     $data->courseid = $data->id;
3621     $context = get_context_instance(CONTEXT_COURSE, $data->courseid);
3623     // calculate the time shift of dates
3624     if (!empty($data->reset_start_date)) {
3625         // time part of course startdate should be zero
3626         $data->timeshift = $data->reset_start_date - usergetmidnight($data->reset_start_date_old);
3627     } else {
3628         $data->timeshift = 0;
3629     }
3631     // result array: component, item, error
3632     $status = array();
3634     // start the resetting
3635     $componentstr = get_string('general');
3637     // move the course start time
3638     if (!empty($data->reset_start_date) and $data->timeshift) {
3639         // change course start data
3640         $DB->set_field('course', 'startdate', $data->reset_start_date, array('id'=>$data->courseid));
3641         // update all course and group events - do not move activity events
3642         $updatesql = "UPDATE {event}
3643                          SET timestart = timestart + ?
3644                        WHERE courseid=? AND instance=0";
3645         $DB->execute($updatesql, array($data->timeshift, $data->courseid));
3647         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3648     }
3650     if (!empty($data->reset_logs)) {
3651         $DB->delete_records('log', array('course'=>$data->courseid));
3652         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletelogs'), 'error'=>false);
3653     }
3655     if (!empty($data->reset_events)) {
3656         $DB->delete_records('event', array('courseid'=>$data->courseid));
3657         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteevents', 'calendar'), 'error'=>false);
3658     }
3660     if (!empty($data->reset_notes)) {
3661         require_once($CFG->dirroot.'/notes/lib.php');
3662         note_delete_all($data->courseid);
3663         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotes', 'notes'), 'error'=>false);
3664     }
3666     $componentstr = get_string('roles');
3668     if (!empty($data->reset_roles_overrides)) {
3669         $children = get_child_contexts($context);
3670         foreach ($children as $child) {
3671             $DB->delete_records('role_capabilities', array('contextid'=>$child->id));
3672         }
3673         $DB->delete_records('role_capabilities', array('contextid'=>$context->id));
3674         //force refresh for logged in users
3675         mark_context_dirty($context->path);
3676         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletecourseoverrides', 'role'), 'error'=>false);
3677     }
3679     if (!empty($data->reset_roles_local)) {
3680         $children = get_child_contexts($context);
3681         foreach ($children as $child) {
3682             role_unassign(0, 0, 0, $child->id);
3683         }
3684         //force refresh for logged in users
3685         mark_context_dirty($context->path);
3686         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletelocalroles', 'role'), 'error'=>false);
3687     }
3689     // First unenrol users - this cleans some of related user data too, such as forum subscriptions, tracking, etc.
3690     $data->unenrolled = array();
3691     if (!empty($data->reset_roles)) {
3692         foreach($data->reset_roles as $roleid) {
3693             if ($users = get_role_users($roleid, $context, false, 'u.id', 'u.id ASC')) {
3694                 foreach ($users as $user) {
3695                     role_unassign($roleid, $user->id, 0, $context->id);
3696                     if (!has_capability('moodle/course:view', $context, $user->id)) {
3697                         $data->unenrolled[$user->id] = $user->id;
3698                     }
3699                 }
3700             }
3701         }
3702     }
3703     if (!empty($data->unenrolled)) {
3704         $status[] = array('component'=>$componentstr, 'item'=>get_string('unenrol').' ('.count($data->unenrolled).')', 'error'=>false);
3705     }
3708     $componentstr = get_string('groups');
3710     // remove all group members
3711     if (!empty($data->reset_groups_members)) {
3712         groups_delete_group_members($data->courseid);
3713         $status[] = array('component'=>$componentstr, 'item'=>get_string('removegroupsmembers', 'group'), 'error'=>false);
3714     }
3716     // remove all groups
3717     if (!empty($data->reset_groups_remove)) {
3718         groups_delete_groups($data-&