MDL-11719 increased size of idnumber in user table - needed for some enrolment plugin...
[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  * note: do not forget to addslashes() before storing into database!
201  */
202 define('PARAM_CLEANHTML',0x1000);
204 /**
205  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "/-_" allowed,
206  * suitable for include() and require()
207  * @TODO: should we rename this function to PARAM_SAFEDIRS??
208  */
209 define('PARAM_ALPHAEXT', 0x2000);
211 /**
212  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
213  */
214 define('PARAM_SAFEDIR',  0x4000);
216 /**
217  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
218  */
219 define('PARAM_SEQUENCE',  0x8000);
221 /**
222  * PARAM_PEM - Privacy Enhanced Mail format
223  */
224 define('PARAM_PEM',      0x10000);
226 /**
227  * PARAM_BASE64 - Base 64 encoded format
228  */
229 define('PARAM_BASE64',   0x20000);
232 /// Page types ///
233 /**
234  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
235  */
236 define('PAGE_COURSE_VIEW', 'course-view');
238 /// Debug levels ///
239 /** no warnings at all */
240 define ('DEBUG_NONE', 0);
241 /** E_ERROR | E_PARSE */
242 define ('DEBUG_MINIMAL', 5);
243 /** E_ERROR | E_PARSE | E_WARNING | E_NOTICE */
244 define ('DEBUG_NORMAL', 15);
245 /** E_ALL without E_STRICT for now, do show recoverable fatal errors */
246 define ('DEBUG_ALL', 6143);
247 /** DEBUG_ALL with extra Moodle debug messages - (DEBUG_ALL | 32768) */
248 define ('DEBUG_DEVELOPER', 38911);
250 /**
251  * Blog access level constant declaration
252  */
253 define ('BLOG_USER_LEVEL', 1);
254 define ('BLOG_GROUP_LEVEL', 2);
255 define ('BLOG_COURSE_LEVEL', 3);
256 define ('BLOG_SITE_LEVEL', 4);
257 define ('BLOG_GLOBAL_LEVEL', 5);
259 /**
260  * Tag constanst
261  */
262 //To prevent problems with multibytes strings, this should not exceed the 
263 //length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
264 define('TAG_MAX_LENGTH', 50); 
266 /**
267  * Password policy constants
268  */
269 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
270 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
271 define ('PASSWORD_DIGITS', '0123456789');
272 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
274 if (!defined('SORT_LOCALE_STRING')) { // PHP < 4.4.0 - TODO: remove in 2.0
275     define('SORT_LOCALE_STRING', SORT_STRING);
279 /// PARAMETER HANDLING ////////////////////////////////////////////////////
281 /**
282  * Returns a particular value for the named variable, taken from
283  * POST or GET.  If the parameter doesn't exist then an error is
284  * thrown because we require this variable.
285  *
286  * This function should be used to initialise all required values
287  * in a script that are based on parameters.  Usually it will be
288  * used like this:
289  *    $id = required_param('id');
290  *
291  * @param string $parname the name of the page parameter we want
292  * @param int $type expected type of parameter
293  * @return mixed
294  */
295 function required_param($parname, $type=PARAM_CLEAN) {
297     // detect_unchecked_vars addition
298     global $CFG;
299     if (!empty($CFG->detect_unchecked_vars)) {
300         global $UNCHECKED_VARS;
301         unset ($UNCHECKED_VARS->vars[$parname]);
302     }
304     if (isset($_POST[$parname])) {       // POST has precedence
305         $param = $_POST[$parname];
306     } else if (isset($_GET[$parname])) {
307         $param = $_GET[$parname];
308     } else {
309         print_error('A required parameter ('.$parname.') was missing');
310     }
312     return clean_param($param, $type);
315 /**
316  * Returns a particular value for the named variable, taken from
317  * POST or GET, otherwise returning a given default.
318  *
319  * This function should be used to initialise all optional values
320  * in a script that are based on parameters.  Usually it will be
321  * used like this:
322  *    $name = optional_param('name', 'Fred');
323  *
324  * @param string $parname the name of the page parameter we want
325  * @param mixed  $default the default value to return if nothing is found
326  * @param int $type expected type of parameter
327  * @return mixed
328  */
329 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
331     // detect_unchecked_vars addition
332     global $CFG;
333     if (!empty($CFG->detect_unchecked_vars)) {
334         global $UNCHECKED_VARS;
335         unset ($UNCHECKED_VARS->vars[$parname]);
336     }
338     if (isset($_POST[$parname])) {       // POST has precedence
339         $param = $_POST[$parname];
340     } else if (isset($_GET[$parname])) {
341         $param = $_GET[$parname];
342     } else {
343         return $default;
344     }
346     return clean_param($param, $type);
349 /**
350  * Used by {@link optional_param()} and {@link required_param()} to
351  * clean the variables and/or cast to specific types, based on
352  * an options field.
353  * <code>
354  * $course->format = clean_param($course->format, PARAM_ALPHA);
355  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
356  * </code>
357  *
358  * @uses $CFG
359  * @uses PARAM_RAW
360  * @uses PARAM_CLEAN
361  * @uses PARAM_CLEANHTML
362  * @uses PARAM_INT
363  * @uses PARAM_NUMBER
364  * @uses PARAM_ALPHA
365  * @uses PARAM_ALPHANUM
366  * @uses PARAM_ALPHAEXT
367  * @uses PARAM_SEQUENCE
368  * @uses PARAM_BOOL
369  * @uses PARAM_NOTAGS
370  * @uses PARAM_TEXT
371  * @uses PARAM_SAFEDIR
372  * @uses PARAM_CLEANFILE
373  * @uses PARAM_FILE
374  * @uses PARAM_PATH
375  * @uses PARAM_HOST
376  * @uses PARAM_URL
377  * @uses PARAM_LOCALURL
378  * @uses PARAM_PEM
379  * @uses PARAM_BASE64
380  * @uses PARAM_TAG
381  * @uses PARAM_SEQUENCE
382  * @param mixed $param the variable we are cleaning
383  * @param int $type expected format of param after cleaning.
384  * @return mixed
385  */
386 function clean_param($param, $type) {
388     global $CFG;
390     if (is_array($param)) {              // Let's loop
391         $newparam = array();
392         foreach ($param as $key => $value) {
393             $newparam[$key] = clean_param($value, $type);
394         }
395         return $newparam;
396     }
398     switch ($type) {
399         case PARAM_RAW:          // no cleaning at all
400             return $param;
402         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
403             if (is_numeric($param)) {
404                 return $param;
405             }
406             $param = stripslashes($param);   // Needed for kses to work fine
407             $param = clean_text($param);     // Sweep for scripts, etc
408             return addslashes($param);       // Restore original request parameter slashes
410         case PARAM_CLEANHTML:    // prepare html fragment for display, do not store it into db!!
411             $param = stripslashes($param);   // Remove any slashes
412             $param = clean_text($param);     // Sweep for scripts, etc
413             return trim($param);
415         case PARAM_INT:
416             return (int)$param;  // Convert to integer
418         case PARAM_NUMBER:
419             return (float)$param;  // Convert to integer
421         case PARAM_ALPHA:        // Remove everything not a-z
422             return eregi_replace('[^a-zA-Z]', '', $param);
424         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
425             return eregi_replace('[^A-Za-z0-9]', '', $param);
427         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z/_-
428             return eregi_replace('[^a-zA-Z/_-]', '', $param);
430         case PARAM_SEQUENCE:     // Remove everything not 0-9,
431             return eregi_replace('[^0-9,]', '', $param);
433         case PARAM_BOOL:         // Convert to 1 or 0
434             $tempstr = strtolower($param);
435             if ($tempstr == 'on' or $tempstr == 'yes' ) {
436                 $param = 1;
437             } else if ($tempstr == 'off' or $tempstr == 'no') {
438                 $param = 0;
439             } else {
440                 $param = empty($param) ? 0 : 1;
441             }
442             return $param;
444         case PARAM_NOTAGS:       // Strip all tags
445             return strip_tags($param);
447         case PARAM_TEXT:    // leave only tags needed for multilang
448             return clean_param(strip_tags($param, '<lang><span>'), PARAM_CLEAN);
450         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
451             return eregi_replace('[^a-zA-Z0-9_-]', '', $param);
453         case PARAM_CLEANFILE:    // allow only safe characters
454             return clean_filename($param);
456         case PARAM_FILE:         // Strip all suspicious characters from filename
457             $param = ereg_replace('[[:cntrl:]]|[<>"`\|\':\\/]', '', $param);
458             $param = ereg_replace('\.\.+', '', $param);
459             if($param == '.') {
460                 $param = '';
461             }
462             return $param;
464         case PARAM_PATH:         // Strip all suspicious characters from file path
465             $param = str_replace('\\\'', '\'', $param);
466             $param = str_replace('\\"', '"', $param);
467             $param = str_replace('\\', '/', $param);
468             $param = ereg_replace('[[:cntrl:]]|[<>"`\|\':]', '', $param);
469             $param = ereg_replace('\.\.+', '', $param);
470             $param = ereg_replace('//+', '/', $param);
471             return ereg_replace('/(\./)+', '/', $param);
473         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
474             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
475             // match ipv4 dotted quad
476             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
477                 // confirm values are ok
478                 if ( $match[0] > 255
479                      || $match[1] > 255
480                      || $match[3] > 255
481                      || $match[4] > 255 ) {
482                     // hmmm, what kind of dotted quad is this?
483                     $param = '';
484                 }
485             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
486                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
487                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
488                        ) {
489                 // all is ok - $param is respected
490             } else {
491                 // all is not ok...
492                 $param='';
493             }
494             return $param;
496         case PARAM_URL:          // allow safe ftp, http, mailto urls
497             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
498             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
499                 // all is ok, param is respected
500             } else {
501                 $param =''; // not really ok
502             }
503             return $param;
505         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
506             $param = clean_param($param, PARAM_URL);
507             if (!empty($param)) {
508                 if (preg_match(':^/:', $param)) {
509                     // root-relative, ok!
510                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
511                     // absolute, and matches our wwwroot
512                 } else {
513                     // relative - let's make sure there are no tricks
514                     if (validateUrlSyntax($param, 's-u-P-a-p-f+q?r?')) {
515                         // looks ok.
516                     } else {
517                         $param = '';
518                     }
519                 }
520             }
521             return $param;
523         case PARAM_PEM:
524             $param = trim($param);
525             // PEM formatted strings may contain letters/numbers and the symbols
526             // forward slash: /
527             // plus sign:     +
528             // equal sign:    =
529             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
530             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
531                 list($wholething, $body) = $matches;
532                 unset($wholething, $matches);
533                 $b64 = clean_param($body, PARAM_BASE64);
534                 if (!empty($b64)) {
535                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
536                 } else {
537                     return '';
538                 }
539             }
540             return '';
542         case PARAM_BASE64:
543             if (!empty($param)) {
544                 // PEM formatted strings may contain letters/numbers and the symbols
545                 // forward slash: /
546                 // plus sign:     +
547                 // equal sign:    =
548                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
549                     return '';
550                 }
551                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
552                 // Each line of base64 encoded data must be 64 characters in
553                 // length, except for the last line which may be less than (or
554                 // equal to) 64 characters long.
555                 for ($i=0, $j=count($lines); $i < $j; $i++) {
556                     if ($i + 1 == $j) {
557                         if (64 < strlen($lines[$i])) {
558                             return '';
559                         }
560                         continue;
561                     }
563                     if (64 != strlen($lines[$i])) {
564                         return '';
565                     }
566                 }
567                 return implode("\n",$lines);
568             } else {
569                 return '';
570             }
572         case PARAM_TAG:
573             //as long as magic_quotes_gpc is used, a backslash will be a 
574             //problem, so remove *all* backslash.
575             $param = str_replace('\\', '', $param);
576             //convert many whitespace chars into one
577             $param = preg_replace('/\s+/', ' ', $param);
578             $textlib = textlib_get_instance();
579             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
580             return $param;
583         case PARAM_TAGLIST:      
584             $tags = explode(',', $param);   
585             $result = array();      
586             foreach ($tags as $tag) {   
587                 $res = clean_param($tag, PARAM_TAG);    
588                 if ($res != '') {   
589                     $result[] = $res;   
590                 }   
591             }   
592             if ($result) {      
593                 return implode(',', $result);   
594             } else {    
595                 return '';      
596             }
598         default:                 // throw error, switched parameters in optional_param or another serious problem
599             print_error("Unknown parameter type: $type");
600     }
605 /**
606  * Set a key in global configuration
607  *
608  * Set a key/value pair in both this session's {@link $CFG} global variable
609  * and in the 'config' database table for future sessions.
610  *
611  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
612  * In that case it doesn't affect $CFG.
613  *
614  * A NULL value will delete the entry.
615  *
616  * @param string $name the key to set
617  * @param string $value the value to set (without magic quotes)
618  * @param string $plugin (optional) the plugin scope
619  * @uses $CFG
620  * @return bool
621  */
622 function set_config($name, $value, $plugin=NULL) {
623 /// No need for get_config because they are usually always available in $CFG
625     global $CFG;
627     if (empty($plugin)) {
628         if (!array_key_exists($name, $CFG->config_php_settings)) {
629             // So it's defined for this invocation at least
630             if (is_null($value)) {
631                 unset($CFG->$name);
632             } else {
633                 $CFG->$name = (string)$value; // settings from db are always strings
634             }
635         }
637         if (get_field('config', 'name', 'name', $name)) {
638             if ($value===null) {
639                 return delete_records('config', 'name', $name);
640             } else {
641                 return set_field('config', 'value', addslashes($value), 'name', $name);
642             }
643         } else {
644             if ($value===null) {
645                 return true;
646             }
647             $config = new object();
648             $config->name = $name;
649             $config->value = addslashes($value);
650             return insert_record('config', $config);
651         }
652     } else { // plugin scope
653         if ($id = get_field('config_plugins', 'id', 'name', $name, 'plugin', $plugin)) {
654             if ($value===null) {
655                 return delete_records('config_plugins', 'name', $name, 'plugin', $plugin);
656             } else {
657                 return set_field('config_plugins', 'value', addslashes($value), 'id', $id);
658             }
659         } else {
660             if ($value===null) {
661                 return true;
662             }
663             $config = new object();
664             $config->plugin = addslashes($plugin);
665             $config->name   = $name;
666             $config->value  = addslashes($value);
667             return insert_record('config_plugins', $config);
668         }
669     }
672 /**
673  * Get configuration values from the global config table
674  * or the config_plugins table.
675  *
676  * If called with no parameters it will do the right thing
677  * generating $CFG safely from the database without overwriting
678  * existing values.
679  *
680  * If called with 2 parameters it will return a $string single
681  * value or false of the value is not found.
682  *
683  * @param string $plugin
684  * @param string $name
685  * @uses $CFG
686  * @return hash-like object or single value
687  *
688  */
689 function get_config($plugin=NULL, $name=NULL) {
691     global $CFG;
693     if (!empty($name)) { // the user is asking for a specific value
694         if (!empty($plugin)) {
695             return get_field('config_plugins', 'value', 'plugin' , $plugin, 'name', $name);
696         } else {
697             return get_field('config', 'value', 'name', $name);
698         }
699     }
701     // the user is after a recordset
702     if (!empty($plugin)) {
703         if ($configs=get_records('config_plugins', 'plugin', $plugin, '', 'name,value')) {
704             $configs = (array)$configs;
705             $localcfg = array();
706             foreach ($configs as $config) {
707                 $localcfg[$config->name] = $config->value;
708             }
709             return (object)$localcfg;
710         } else {
711             return false;
712         }
713     } else {
714         // this was originally in setup.php
715         if ($configs = get_records('config')) {
716             $localcfg = (array)$CFG;
717             foreach ($configs as $config) {
718                 if (!isset($localcfg[$config->name])) {
719                     $localcfg[$config->name] = $config->value;
720                 }
721                 // do not complain anymore if config.php overrides settings from db
722             }
724             $localcfg = (object)$localcfg;
725             return $localcfg;
726         } else {
727             // preserve $CFG if DB returns nothing or error
728             return $CFG;
729         }
731     }
734 /**
735  * Removes a key from global configuration
736  *
737  * @param string $name the key to set
738  * @param string $plugin (optional) the plugin scope
739  * @uses $CFG
740  * @return bool
741  */
742 function unset_config($name, $plugin=NULL) {
744     global $CFG;
746     unset($CFG->$name);
748     if (empty($plugin)) {
749         return delete_records('config', 'name', $name);
750     } else {
751         return delete_records('config_plugins', 'name', $name, 'plugin', $plugin);
752     }
755 /**
756  * Get volatile flags
757  *
758  * @param string $type
759  * @param int    $changedsince
760  * @return records array
761  *
762  */
763 function get_cache_flags($type, $changedsince=NULL) {
765     $type = addslashes($type);
767     $sqlwhere = 'flagtype=\'' . $type . '\' AND expiry >= ' . time();
768     if ($changedsince !== NULL) {
769         $changedsince = (int)$changedsince;
770         $sqlwhere .= ' AND timemodified > ' . $changedsince;
771     }
772     $cf = array();
773     if ($flags=get_records_select('cache_flags', $sqlwhere, '', 'name,value')) {
774         foreach ($flags as $flag) {
775             $cf[$flag->name] = $flag->value;
776         }
777     }
778     return $cf;
781 /**
782  * Get volatile flags
783  *
784  * @param string $type
785  * @param string $name
786  * @param int    $changedsince
787  * @return records array
788  *
789  */
790 function get_cache_flag($type, $name, $changedsince=NULL) {
792     $type = addslashes($type);
793     $name = addslashes($name);
795     $sqlwhere = 'flagtype=\'' . $type . '\' AND name=\'' . $name . '\' AND expiry >= ' . time();
796     if ($changedsince !== NULL) {
797         $changedsince = (int)$changedsince;
798         $sqlwhere .= ' AND timemodified > ' . $changedsince;
799     }
800     return get_field_select('cache_flags', 'value', $sqlwhere);
803 /**
804  * Set a volatile flag
805  *
806  * @param string $type the "type" namespace for the key
807  * @param string $name the key to set
808  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
809  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
810  * @return bool
811  */
812 function set_cache_flag($type, $name, $value, $expiry=NULL) {
815     $timemodified = time();
816     if ($expiry===NULL || $expiry < $timemodified) {
817         $expiry = $timemodified + 24 * 60 * 60;
818     } else {
819         $expiry = (int)$expiry;
820     }
822     if ($value === NULL) {
823         return unset_cache_flag($type,$name);
824     }
826     $type = addslashes($type);
827     $name = addslashes($name);
828     if ($f = get_record('cache_flags', 'name', $name, 'flagtype', $type)) { // this is a potentail problem in DEBUG_DEVELOPER
829         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
830             return true; //no need to update; helps rcache too
831         }
832         $f->value        = addslashes($value);
833         $f->expiry       = $expiry;
834         $f->timemodified = $timemodified;
835         return update_record('cache_flags', $f);
836     } else {
837         $f = new object();
838         $f->flagtype     = $type;
839         $f->name         = $name;
840         $f->value        = addslashes($value);
841         $f->expiry       = $expiry;
842         $f->timemodified = $timemodified;
843         return (bool)insert_record('cache_flags', $f);
844     }
847 /**
848  * Removes a single volatile flag
849  *
850  * @param string $type the "type" namespace for the key
851  * @param string $name the key to set
852  * @uses $CFG
853  * @return bool
854  */
855 function unset_cache_flag($type, $name) {
857     return delete_records('cache_flags',
858                           'name', addslashes($name),
859                           'flagtype', addslashes($type));
862 /**
863  * Garbage-collect volatile flags
864  *
865  */
866 function gc_cache_flags() {
867     return delete_records_select('cache_flags', 'expiry < ' . time());
870 /**
871  * Refresh current $USER session global variable with all their current preferences.
872  * @uses $USER
873  */
874 function reload_user_preferences() {
876     global $USER;
878     //reset preference
879     $USER->preference = array();
881     if (!isloggedin() or isguestuser()) {
882         // no permanent storage for not-logged-in user and guest
884     } else if ($preferences = get_records('user_preferences', 'userid', $USER->id)) {
885         foreach ($preferences as $preference) {
886             $USER->preference[$preference->name] = $preference->value;
887         }
888     }
890     return true;
893 /**
894  * Sets a preference for the current user
895  * Optionally, can set a preference for a different user object
896  * @uses $USER
897  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
899  * @param string $name The key to set as preference for the specified user
900  * @param string $value The value to set forthe $name key in the specified user's record
901  * @param int $otheruserid A moodle user ID
902  * @return bool
903  */
904 function set_user_preference($name, $value, $otheruserid=NULL) {
906     global $USER;
908     if (!isset($USER->preference)) {
909         reload_user_preferences();
910     }
912     if (empty($name)) {
913         return false;
914     }
916     $nostore = false;
918     if (empty($otheruserid)){
919         if (!isloggedin() or isguestuser()) {
920             $nostore = true;
921         }
922         $userid = $USER->id;
923     } else {
924         if (isguestuser($otheruserid)) {
925             $nostore = true;
926         }
927         $userid = $otheruserid;
928     }
930     $return = true;
931     if ($nostore) {
932         // no permanent storage for not-logged-in user and guest
934     } else if ($preference = get_record('user_preferences', 'userid', $userid, 'name', addslashes($name))) {
935         if ($preference->value === $value) {
936             return true;
937         }
938         if (!set_field('user_preferences', 'value', addslashes((string)$value), 'id', $preference->id)) {
939             $return = false;
940         }
942     } else {
943         $preference = new object();
944         $preference->userid = $userid;
945         $preference->name   = addslashes($name);
946         $preference->value  = addslashes((string)$value);
947         if (!insert_record('user_preferences', $preference)) {
948             $return = false;
949         }
950     }
952     // update value in USER session if needed
953     if ($userid == $USER->id) {
954         $USER->preference[$name] = (string)$value;
955     }
957     return $return;
960 /**
961  * Unsets a preference completely by deleting it from the database
962  * Optionally, can set a preference for a different user id
963  * @uses $USER
964  * @param string  $name The key to unset as preference for the specified user
965  * @param int $otheruserid A moodle user ID
966  */
967 function unset_user_preference($name, $otheruserid=NULL) {
969     global $USER;
971     if (!isset($USER->preference)) {
972         reload_user_preferences();
973     }
975     if (empty($otheruserid)){
976         $userid = $USER->id;
977     } else {
978         $userid = $otheruserid;
979     }
981     //Delete the preference from $USER if needed
982     if ($userid == $USER->id) {
983         unset($USER->preference[$name]);
984     }
986     //Then from DB
987     return delete_records('user_preferences', 'userid', $userid, 'name', addslashes($name));
991 /**
992  * Sets a whole array of preferences for the current user
993  * @param array $prefarray An array of key/value pairs to be set
994  * @param int $otheruserid A moodle user ID
995  * @return bool
996  */
997 function set_user_preferences($prefarray, $otheruserid=NULL) {
999     if (!is_array($prefarray) or empty($prefarray)) {
1000         return false;
1001     }
1003     $return = true;
1004     foreach ($prefarray as $name => $value) {
1005         // The order is important; test for return is done first
1006         $return = (set_user_preference($name, $value, $otheruserid) && $return);
1007     }
1008     return $return;
1011 /**
1012  * If no arguments are supplied this function will return
1013  * all of the current user preferences as an array.
1014  * If a name is specified then this function
1015  * attempts to return that particular preference value.  If
1016  * none is found, then the optional value $default is returned,
1017  * otherwise NULL.
1018  * @param string $name Name of the key to use in finding a preference value
1019  * @param string $default Value to be returned if the $name key is not set in the user preferences
1020  * @param int $otheruserid A moodle user ID
1021  * @uses $USER
1022  * @return string
1023  */
1024 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1025     global $USER;
1027     if (!isset($USER->preference)) {
1028         reload_user_preferences();
1029     }
1031     if (empty($otheruserid)){
1032         $userid = $USER->id;
1033     } else {
1034         $userid = $otheruserid;
1035     }
1037     if ($userid == $USER->id) {
1038         $preference = $USER->preference;
1040     } else {
1041         $preference = array();
1042         if ($prefdata = get_records('user_preferences', 'userid', $userid)) {
1043             foreach ($prefdata as $pref) {
1044                 $preference[$pref->name] = $pref->value;
1045             }
1046         }
1047     }
1049     if (empty($name)) {
1050         return $preference;            // All values
1052     } else if (array_key_exists($name, $preference)) {
1053         return $preference[$name];    // The single value
1055     } else {
1056         return $default;              // Default value (or NULL)
1057     }
1061 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1063 /**
1064  * Given date parts in user time produce a GMT timestamp.
1065  *
1066  * @param int $year The year part to create timestamp of
1067  * @param int $month The month part to create timestamp of
1068  * @param int $day The day part to create timestamp of
1069  * @param int $hour The hour part to create timestamp of
1070  * @param int $minute The minute part to create timestamp of
1071  * @param int $second The second part to create timestamp of
1072  * @param float $timezone ?
1073  * @param bool $applydst ?
1074  * @return int timestamp
1075  * @todo Finish documenting this function
1076  */
1077 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1079     $strtimezone = NULL;
1080     if (!is_numeric($timezone)) {
1081         $strtimezone = $timezone;
1082     }
1084     $timezone = get_user_timezone_offset($timezone);
1086     if (abs($timezone) > 13) {
1087         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1088     } else {
1089         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1090         $time = usertime($time, $timezone);
1091         if($applydst) {
1092             $time -= dst_offset_on($time, $strtimezone);
1093         }
1094     }
1096     return $time;
1100 /**
1101  * Given an amount of time in seconds, returns string
1102  * formatted nicely as weeks, days, hours etc as needed
1103  *
1104  * @uses MINSECS
1105  * @uses HOURSECS
1106  * @uses DAYSECS
1107  * @uses YEARSECS
1108  * @param int $totalsecs ?
1109  * @param array $str ?
1110  * @return string
1111  */
1112  function format_time($totalsecs, $str=NULL) {
1114     $totalsecs = abs($totalsecs);
1116     if (!$str) {  // Create the str structure the slow way
1117         $str->day   = get_string('day');
1118         $str->days  = get_string('days');
1119         $str->hour  = get_string('hour');
1120         $str->hours = get_string('hours');
1121         $str->min   = get_string('min');
1122         $str->mins  = get_string('mins');
1123         $str->sec   = get_string('sec');
1124         $str->secs  = get_string('secs');
1125         $str->year  = get_string('year');
1126         $str->years = get_string('years');
1127     }
1130     $years     = floor($totalsecs/YEARSECS);
1131     $remainder = $totalsecs - ($years*YEARSECS);
1132     $days      = floor($remainder/DAYSECS);
1133     $remainder = $totalsecs - ($days*DAYSECS);
1134     $hours     = floor($remainder/HOURSECS);
1135     $remainder = $remainder - ($hours*HOURSECS);
1136     $mins      = floor($remainder/MINSECS);
1137     $secs      = $remainder - ($mins*MINSECS);
1139     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1140     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1141     $sh = ($hours == 1) ? $str->hour : $str->hours;
1142     $sd = ($days == 1)  ? $str->day  : $str->days;
1143     $sy = ($years == 1)  ? $str->year  : $str->years;
1145     $oyears = '';
1146     $odays = '';
1147     $ohours = '';
1148     $omins = '';
1149     $osecs = '';
1151     if ($years)  $oyears  = $years .' '. $sy;
1152     if ($days)  $odays  = $days .' '. $sd;
1153     if ($hours) $ohours = $hours .' '. $sh;
1154     if ($mins)  $omins  = $mins .' '. $sm;
1155     if ($secs)  $osecs  = $secs .' '. $ss;
1157     if ($years) return trim($oyears .' '. $odays);
1158     if ($days)  return trim($odays .' '. $ohours);
1159     if ($hours) return trim($ohours .' '. $omins);
1160     if ($mins)  return trim($omins .' '. $osecs);
1161     if ($secs)  return $osecs;
1162     return get_string('now');
1165 /**
1166  * Returns a formatted string that represents a date in user time
1167  * <b>WARNING: note that the format is for strftime(), not date().</b>
1168  * Because of a bug in most Windows time libraries, we can't use
1169  * the nicer %e, so we have to use %d which has leading zeroes.
1170  * A lot of the fuss in the function is just getting rid of these leading
1171  * zeroes as efficiently as possible.
1172  *
1173  * If parameter fixday = true (default), then take off leading
1174  * zero from %d, else mantain it.
1175  *
1176  * @uses HOURSECS
1177  * @param  int $date timestamp in GMT
1178  * @param string $format strftime format
1179  * @param float $timezone
1180  * @param bool $fixday If true (default) then the leading
1181  * zero from %d is removed. If false then the leading zero is mantained.
1182  * @return string
1183  */
1184 function userdate($date, $format='', $timezone=99, $fixday = true) {
1186     global $CFG;
1188     $strtimezone = NULL;
1189     if (!is_numeric($timezone)) {
1190         $strtimezone = $timezone;
1191     }
1193     if (empty($format)) {
1194         $format = get_string('strftimedaydatetime');
1195     }
1197     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1198         $fixday = false;
1199     } else if ($fixday) {
1200         $formatnoday = str_replace('%d', 'DD', $format);
1201         $fixday = ($formatnoday != $format);
1202     }
1204     $date += dst_offset_on($date, $strtimezone);
1206     $timezone = get_user_timezone_offset($timezone);
1208     if (abs($timezone) > 13) {   /// Server time
1209         if ($fixday) {
1210             $datestring = strftime($formatnoday, $date);
1211             $daystring  = str_replace(' 0', '', strftime(' %d', $date));
1212             $datestring = str_replace('DD', $daystring, $datestring);
1213         } else {
1214             $datestring = strftime($format, $date);
1215         }
1216     } else {
1217         $date += (int)($timezone * 3600);
1218         if ($fixday) {
1219             $datestring = gmstrftime($formatnoday, $date);
1220             $daystring  = str_replace(' 0', '', gmstrftime(' %d', $date));
1221             $datestring = str_replace('DD', $daystring, $datestring);
1222         } else {
1223             $datestring = gmstrftime($format, $date);
1224         }
1225     }
1227 /// If we are running under Windows convert from windows encoding to UTF-8
1228 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1230    if ($CFG->ostype == 'WINDOWS') {
1231        if ($localewincharset = get_string('localewincharset')) {
1232            $textlib = textlib_get_instance();
1233            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1234        }
1235    }
1237     return $datestring;
1240 /**
1241  * Given a $time timestamp in GMT (seconds since epoch),
1242  * returns an array that represents the date in user time
1243  *
1244  * @uses HOURSECS
1245  * @param int $time Timestamp in GMT
1246  * @param float $timezone ?
1247  * @return array An array that represents the date in user time
1248  * @todo Finish documenting this function
1249  */
1250 function usergetdate($time, $timezone=99) {
1252     $strtimezone = NULL;
1253     if (!is_numeric($timezone)) {
1254         $strtimezone = $timezone;
1255     }
1257     $timezone = get_user_timezone_offset($timezone);
1259     if (abs($timezone) > 13) {    // Server time
1260         return getdate($time);
1261     }
1263     // There is no gmgetdate so we use gmdate instead
1264     $time += dst_offset_on($time, $strtimezone);
1265     $time += intval((float)$timezone * HOURSECS);
1267     $datestring = gmstrftime('%S_%M_%H_%d_%m_%Y_%w_%j_%A_%B', $time);
1269     list(
1270         $getdate['seconds'],
1271         $getdate['minutes'],
1272         $getdate['hours'],
1273         $getdate['mday'],
1274         $getdate['mon'],
1275         $getdate['year'],
1276         $getdate['wday'],
1277         $getdate['yday'],
1278         $getdate['weekday'],
1279         $getdate['month']
1280     ) = explode('_', $datestring);
1282     return $getdate;
1285 /**
1286  * Given a GMT timestamp (seconds since epoch), offsets it by
1287  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1288  *
1289  * @uses HOURSECS
1290  * @param  int $date Timestamp in GMT
1291  * @param float $timezone
1292  * @return int
1293  */
1294 function usertime($date, $timezone=99) {
1296     $timezone = get_user_timezone_offset($timezone);
1298     if (abs($timezone) > 13) {
1299         return $date;
1300     }
1301     return $date - (int)($timezone * HOURSECS);
1304 /**
1305  * Given a time, return the GMT timestamp of the most recent midnight
1306  * for the current user.
1307  *
1308  * @param int $date Timestamp in GMT
1309  * @param float $timezone ?
1310  * @return ?
1311  */
1312 function usergetmidnight($date, $timezone=99) {
1314     $userdate = usergetdate($date, $timezone);
1316     // Time of midnight of this user's day, in GMT
1317     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1321 /**
1322  * Returns a string that prints the user's timezone
1323  *
1324  * @param float $timezone The user's timezone
1325  * @return string
1326  */
1327 function usertimezone($timezone=99) {
1329     $tz = get_user_timezone($timezone);
1331     if (!is_float($tz)) {
1332         return $tz;
1333     }
1335     if(abs($tz) > 13) { // Server time
1336         return get_string('serverlocaltime');
1337     }
1339     if($tz == intval($tz)) {
1340         // Don't show .0 for whole hours
1341         $tz = intval($tz);
1342     }
1344     if($tz == 0) {
1345         return 'UTC';
1346     }
1347     else if($tz > 0) {
1348         return 'UTC+'.$tz;
1349     }
1350     else {
1351         return 'UTC'.$tz;
1352     }
1356 /**
1357  * Returns a float which represents the user's timezone difference from GMT in hours
1358  * Checks various settings and picks the most dominant of those which have a value
1359  *
1360  * @uses $CFG
1361  * @uses $USER
1362  * @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
1363  * @return int
1364  */
1365 function get_user_timezone_offset($tz = 99) {
1367     global $USER, $CFG;
1369     $tz = get_user_timezone($tz);
1371     if (is_float($tz)) {
1372         return $tz;
1373     } else {
1374         $tzrecord = get_timezone_record($tz);
1375         if (empty($tzrecord)) {
1376             return 99.0;
1377         }
1378         return (float)$tzrecord->gmtoff / HOURMINS;
1379     }
1382 /**
1383  * Returns an int which represents the systems's timezone difference from GMT in seconds
1384  * @param mixed $tz timezone
1385  * @return int if found, false is timezone 99 or error
1386  */
1387 function get_timezone_offset($tz) {
1388     global $CFG;
1390     if ($tz == 99) {
1391         return false;
1392     }
1394     if (is_numeric($tz)) {
1395         return intval($tz * 60*60);
1396     }
1398     if (!$tzrecord = get_timezone_record($tz)) {
1399         return false;
1400     }
1401     return intval($tzrecord->gmtoff * 60);
1404 /**
1405  * Returns a float or a string which denotes the user's timezone
1406  * 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)
1407  * means that for this timezone there are also DST rules to be taken into account
1408  * Checks various settings and picks the most dominant of those which have a value
1409  *
1410  * @uses $USER
1411  * @uses $CFG
1412  * @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
1413  * @return mixed
1414  */
1415 function get_user_timezone($tz = 99) {
1416     global $USER, $CFG;
1418     $timezones = array(
1419         $tz,
1420         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1421         isset($USER->timezone) ? $USER->timezone : 99,
1422         isset($CFG->timezone) ? $CFG->timezone : 99,
1423         );
1425     $tz = 99;
1427     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1428         $tz = $next['value'];
1429     }
1431     return is_numeric($tz) ? (float) $tz : $tz;
1434 /**
1435  * ?
1436  *
1437  * @uses $CFG
1438  * @uses $db
1439  * @param string $timezonename ?
1440  * @return object
1441  */
1442 function get_timezone_record($timezonename) {
1443     global $CFG, $db;
1444     static $cache = NULL;
1446     if ($cache === NULL) {
1447         $cache = array();
1448     }
1450     if (isset($cache[$timezonename])) {
1451         return $cache[$timezonename];
1452     }
1454     return $cache[$timezonename] = get_record_sql('SELECT * FROM '.$CFG->prefix.'timezone
1455                                       WHERE name = '.$db->qstr($timezonename).' ORDER BY year DESC', true);
1458 /**
1459  * ?
1460  *
1461  * @uses $CFG
1462  * @uses $USER
1463  * @param ? $fromyear ?
1464  * @param ? $to_year ?
1465  * @return bool
1466  */
1467 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1468     global $CFG, $SESSION;
1470     $usertz = get_user_timezone($strtimezone);
1472     if (is_float($usertz)) {
1473         // Trivial timezone, no DST
1474         return false;
1475     }
1477     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1478         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1479         unset($SESSION->dst_offsets);
1480         unset($SESSION->dst_range);
1481     }
1483     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1484         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1485         // This will be the return path most of the time, pretty light computationally
1486         return true;
1487     }
1489     // Reaching here means we either need to extend our table or create it from scratch
1491     // Remember which TZ we calculated these changes for
1492     $SESSION->dst_offsettz = $usertz;
1494     if(empty($SESSION->dst_offsets)) {
1495         // If we 're creating from scratch, put the two guard elements in there
1496         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1497     }
1498     if(empty($SESSION->dst_range)) {
1499         // If creating from scratch
1500         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1501         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1503         // Fill in the array with the extra years we need to process
1504         $yearstoprocess = array();
1505         for($i = $from; $i <= $to; ++$i) {
1506             $yearstoprocess[] = $i;
1507         }
1509         // Take note of which years we have processed for future calls
1510         $SESSION->dst_range = array($from, $to);
1511     }
1512     else {
1513         // If needing to extend the table, do the same
1514         $yearstoprocess = array();
1516         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1517         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1519         if($from < $SESSION->dst_range[0]) {
1520             // Take note of which years we need to process and then note that we have processed them for future calls
1521             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1522                 $yearstoprocess[] = $i;
1523             }
1524             $SESSION->dst_range[0] = $from;
1525         }
1526         if($to > $SESSION->dst_range[1]) {
1527             // Take note of which years we need to process and then note that we have processed them for future calls
1528             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1529                 $yearstoprocess[] = $i;
1530             }
1531             $SESSION->dst_range[1] = $to;
1532         }
1533     }
1535     if(empty($yearstoprocess)) {
1536         // This means that there was a call requesting a SMALLER range than we have already calculated
1537         return true;
1538     }
1540     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1541     // Also, the array is sorted in descending timestamp order!
1543     // Get DB data
1545     static $presets_cache = array();
1546     if (!isset($presets_cache[$usertz])) {
1547         $presets_cache[$usertz] = get_records('timezone', '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');
1548     }
1549     if(empty($presets_cache[$usertz])) {
1550         return false;
1551     }
1553     // Remove ending guard (first element of the array)
1554     reset($SESSION->dst_offsets);
1555     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1557     // Add all required change timestamps
1558     foreach($yearstoprocess as $y) {
1559         // Find the record which is in effect for the year $y
1560         foreach($presets_cache[$usertz] as $year => $preset) {
1561             if($year <= $y) {
1562                 break;
1563             }
1564         }
1566         $changes = dst_changes_for_year($y, $preset);
1568         if($changes === NULL) {
1569             continue;
1570         }
1571         if($changes['dst'] != 0) {
1572             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1573         }
1574         if($changes['std'] != 0) {
1575             $SESSION->dst_offsets[$changes['std']] = 0;
1576         }
1577     }
1579     // Put in a guard element at the top
1580     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1581     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1583     // Sort again
1584     krsort($SESSION->dst_offsets);
1586     return true;
1589 function dst_changes_for_year($year, $timezone) {
1591     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1592         return NULL;
1593     }
1595     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1596     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1598     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1599     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1601     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1602     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1604     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1605     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1606     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1608     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1609     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1611     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1614 // $time must NOT be compensated at all, it has to be a pure timestamp
1615 function dst_offset_on($time, $strtimezone = NULL) {
1616     global $SESSION;
1618     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
1619         return 0;
1620     }
1622     reset($SESSION->dst_offsets);
1623     while(list($from, $offset) = each($SESSION->dst_offsets)) {
1624         if($from <= $time) {
1625             break;
1626         }
1627     }
1629     // This is the normal return path
1630     if($offset !== NULL) {
1631         return $offset;
1632     }
1634     // Reaching this point means we haven't calculated far enough, do it now:
1635     // Calculate extra DST changes if needed and recurse. The recursion always
1636     // moves toward the stopping condition, so will always end.
1638     if($from == 0) {
1639         // We need a year smaller than $SESSION->dst_range[0]
1640         if($SESSION->dst_range[0] == 1971) {
1641             return 0;
1642         }
1643         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
1644         return dst_offset_on($time, $strtimezone);
1645     }
1646     else {
1647         // We need a year larger than $SESSION->dst_range[1]
1648         if($SESSION->dst_range[1] == 2035) {
1649             return 0;
1650         }
1651         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
1652         return dst_offset_on($time, $strtimezone);
1653     }
1656 function find_day_in_month($startday, $weekday, $month, $year) {
1658     $daysinmonth = days_in_month($month, $year);
1660     if($weekday == -1) {
1661         // Don't care about weekday, so return:
1662         //    abs($startday) if $startday != -1
1663         //    $daysinmonth otherwise
1664         return ($startday == -1) ? $daysinmonth : abs($startday);
1665     }
1667     // From now on we 're looking for a specific weekday
1669     // Give "end of month" its actual value, since we know it
1670     if($startday == -1) {
1671         $startday = -1 * $daysinmonth;
1672     }
1674     // Starting from day $startday, the sign is the direction
1676     if($startday < 1) {
1678         $startday = abs($startday);
1679         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1681         // This is the last such weekday of the month
1682         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
1683         if($lastinmonth > $daysinmonth) {
1684             $lastinmonth -= 7;
1685         }
1687         // Find the first such weekday <= $startday
1688         while($lastinmonth > $startday) {
1689             $lastinmonth -= 7;
1690         }
1692         return $lastinmonth;
1694     }
1695     else {
1697         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
1699         $diff = $weekday - $indexweekday;
1700         if($diff < 0) {
1701             $diff += 7;
1702         }
1704         // This is the first such weekday of the month equal to or after $startday
1705         $firstfromindex = $startday + $diff;
1707         return $firstfromindex;
1709     }
1712 /**
1713  * Calculate the number of days in a given month
1714  *
1715  * @param int $month The month whose day count is sought
1716  * @param int $year The year of the month whose day count is sought
1717  * @return int
1718  */
1719 function days_in_month($month, $year) {
1720    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
1723 /**
1724  * Calculate the position in the week of a specific calendar day
1725  *
1726  * @param int $day The day of the date whose position in the week is sought
1727  * @param int $month The month of the date whose position in the week is sought
1728  * @param int $year The year of the date whose position in the week is sought
1729  * @return int
1730  */
1731 function dayofweek($day, $month, $year) {
1732     // I wonder if this is any different from
1733     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1734     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
1737 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
1739 /**
1740  * Makes sure that $USER->sesskey exists, if $USER itself exists. It sets a new sesskey
1741  * if one does not already exist, but does not overwrite existing sesskeys. Returns the
1742  * sesskey string if $USER exists, or boolean false if not.
1743  *
1744  * @uses $USER
1745  * @return string
1746  */
1747 function sesskey() {
1748     global $USER;
1750     if(!isset($USER)) {
1751         return false;
1752     }
1754     if (empty($USER->sesskey)) {
1755         $USER->sesskey = random_string(10);
1756     }
1758     return $USER->sesskey;
1762 /**
1763  * For security purposes, this function will check that the currently
1764  * given sesskey (passed as a parameter to the script or this function)
1765  * matches that of the current user.
1766  *
1767  * @param string $sesskey optionally provided sesskey
1768  * @return bool
1769  */
1770 function confirm_sesskey($sesskey=NULL) {
1771     global $USER;
1773     if (!empty($USER->ignoresesskey) || !empty($CFG->ignoresesskey)) {
1774         return true;
1775     }
1777     if (empty($sesskey)) {
1778         $sesskey = required_param('sesskey', PARAM_RAW);  // Check script parameters
1779     }
1781     if (!isset($USER->sesskey)) {
1782         return false;
1783     }
1785     return ($USER->sesskey === $sesskey);
1788 /**
1789  * Setup all global $CFG course variables, set locale and also themes
1790  * This function can be used on pages that do not require login instead of require_login()
1791  *
1792  * @param mixed $courseorid id of the course or course object
1793  */
1794 function course_setup($courseorid=0) {
1795     global $COURSE, $CFG, $SITE;
1797 /// Redefine global $COURSE if needed
1798     if (empty($courseorid)) {
1799         // no change in global $COURSE - for backwards compatibiltiy
1800         // if require_rogin() used after require_login($courseid);
1801     } else if (is_object($courseorid)) {
1802         $COURSE = clone($courseorid);
1803     } else {
1804         global $course; // used here only to prevent repeated fetching from DB - may be removed later
1805         if ($courseorid == SITEID) {
1806             $COURSE = clone($SITE);
1807         } else if (!empty($course->id) and $course->id == $courseorid) {
1808             $COURSE = clone($course);
1809         } else {
1810             if (!$COURSE = get_record('course', 'id', $courseorid)) {
1811                 print_error('Invalid course ID');
1812             }
1813         }
1814     }
1816 /// set locale and themes
1817     moodle_setlocale();
1818     theme_setup();
1822 /**
1823  * This function checks that the current user is logged in and has the
1824  * required privileges
1825  *
1826  * This function checks that the current user is logged in, and optionally
1827  * whether they are allowed to be in a particular course and view a particular
1828  * course module.
1829  * If they are not logged in, then it redirects them to the site login unless
1830  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
1831  * case they are automatically logged in as guests.
1832  * If $courseid is given and the user is not enrolled in that course then the
1833  * user is redirected to the course enrolment page.
1834  * If $cm is given and the coursemodule is hidden and the user is not a teacher
1835  * in the course then the user is redirected to the course home page.
1836  *
1837  * @uses $CFG
1838  * @uses $SESSION
1839  * @uses $USER
1840  * @uses $FULLME
1841  * @uses SITEID
1842  * @uses $COURSE
1843  * @param mixed $courseorid id of the course or course object
1844  * @param bool $autologinguest
1845  * @param object $cm course module object
1846  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
1847  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
1848  *             in order to keep redirects working properly. MDL-14495
1849  */
1850 function require_login($courseorid=0, $autologinguest=true, $cm=null, $setwantsurltome=true) {
1852     global $CFG, $SESSION, $USER, $COURSE, $FULLME;
1854 /// setup global $COURSE, themes, language and locale
1855     course_setup($courseorid);
1857 /// If the user is not even logged in yet then make sure they are
1858     if (!isloggedin()) {
1859         //NOTE: $USER->site check was obsoleted by session test cookie,
1860         //      $USER->confirmed test is in login/index.php
1861         if ($setwantsurltome) {
1862             $SESSION->wantsurl = $FULLME;
1863         }
1864         if (!empty($_SERVER['HTTP_REFERER'])) {
1865             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
1866         }
1867         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests) and ($COURSE->id == SITEID or $COURSE->guest) ) {
1868             $loginguest = '?loginguest=true';
1869         } else {
1870             $loginguest = '';
1871         }
1872         if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
1873             redirect($CFG->wwwroot .'/login/index.php'. $loginguest);
1874         } else {
1875             $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1876             redirect($wwwroot .'/login/index.php');
1877         }
1878         exit;
1879     }
1881 /// loginas as redirection if needed
1882     if ($COURSE->id != SITEID and !empty($USER->realuser)) {
1883         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
1884             if ($USER->loginascontext->instanceid != $COURSE->id) {
1885                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
1886             }
1887         }
1888     }
1890 /// check whether the user should be changing password (but only if it is REALLY them)
1891     if (get_user_preferences('auth_forcepasswordchange') && empty($USER->realuser)) {
1892         $userauth = get_auth_plugin($USER->auth);
1893         if ($userauth->can_change_password()) {
1894             $SESSION->wantsurl = $FULLME;
1895             if ($changeurl = $userauth->change_password_url()) {
1896                 //use plugin custom url
1897                 redirect($changeurl);
1898             } else {
1899                 //use moodle internal method
1900                 if (empty($CFG->loginhttps)) {
1901                     redirect($CFG->wwwroot .'/login/change_password.php');
1902                 } else {
1903                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1904                     redirect($wwwroot .'/login/change_password.php');
1905                 }
1906             }
1907         } else {
1908             print_error('nopasswordchangeforced', 'auth');
1909         }
1910     }
1912 /// Check that the user account is properly set up
1913     if (user_not_fully_set_up($USER)) {
1914         $SESSION->wantsurl = $FULLME;
1915         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
1916     }
1918 /// Make sure current IP matches the one for this session (if required)
1919     if (!empty($CFG->tracksessionip)) {
1920         if ($USER->sessionIP != md5(getremoteaddr())) {
1921             print_error('sessionipnomatch', 'error');
1922         }
1923     }
1925 /// Make sure the USER has a sesskey set up.  Used for checking script parameters.
1926     sesskey();
1928     // Check that the user has agreed to a site policy if there is one
1929     if (!empty($CFG->sitepolicy)) {
1930         if (!$USER->policyagreed) {
1931             $SESSION->wantsurl = $FULLME;
1932             redirect($CFG->wwwroot .'/user/policy.php');
1933         }
1934     }
1936     // Fetch the system context, we are going to use it a lot.
1937     $sysctx = get_context_instance(CONTEXT_SYSTEM);
1939 /// If the site is currently under maintenance, then print a message
1940     if (!has_capability('moodle/site:config', $sysctx)) {
1941         if (file_exists($CFG->dataroot.'/'.SITEID.'/maintenance.html')) {
1942             print_maintenance_message();
1943             exit;
1944         }
1945     }
1947 /// groupmembersonly access control
1948     if (!empty($CFG->enablegroupings) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
1949         if (isguestuser() or !groups_has_membership($cm)) {
1950             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
1951         }
1952     }
1954     // Fetch the course context, and prefetch its child contexts
1955     if (!isset($COURSE->context)) {
1956         if ( ! $COURSE->context = get_context_instance(CONTEXT_COURSE, $COURSE->id) ) {
1957             print_error('nocontext');        
1958         }
1959     }
1960     if ($COURSE->id == SITEID) {
1961         /// Eliminate hidden site activities straight away
1962         if (!empty($cm) && !$cm->visible 
1963             && !has_capability('moodle/course:viewhiddenactivities', $COURSE->context)) {
1964             redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
1965         }
1966         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
1967         return;
1969     } else {
1971         /// Check if the user can be in a particular course
1972         if (empty($USER->access['rsw'][$COURSE->context->path])) {
1973             //
1974             // MDL-13900 - If the course or the parent category are hidden
1975             // and the user hasn't the 'course:viewhiddencourses' capability, prevent access
1976             //
1977             if ( !($COURSE->visible && course_parent_visible($COURSE)) &&
1978                    !has_capability('moodle/course:viewhiddencourses', $COURSE->context)) {
1979                 print_header_simple();
1980                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
1981             }
1982         }
1984     /// Non-guests who don't currently have access, check if they can be allowed in as a guest
1986         if ($USER->username != 'guest' and !has_capability('moodle/course:view', $COURSE->context)) {
1987             if ($COURSE->guest == 1) {
1988                  // Temporarily assign them guest role for this context, if it fails later user is asked to enrol
1989                  $USER->access = load_temp_role($COURSE->context, $CFG->guestroleid, $USER->access);
1990             }
1991         }
1993     /// If the user is a guest then treat them according to the course policy about guests
1995         if (has_capability('moodle/legacy:guest', $COURSE->context, NULL, false)) {
1996             if (has_capability('moodle/site:doanything', $sysctx)) {
1997                 // administrators must be able to access any course - even if somebody gives them guest access
1998                 user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
1999                 return;
2000             }
2002             switch ($COURSE->guest) {    /// Check course policy about guest access
2004                 case 1:    /// Guests always allowed 
2005                     if (!has_capability('moodle/course:view', $COURSE->context)) {    // Prohibited by capability
2006                         print_header_simple();
2007                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), "$CFG->wwwroot/login/index.php");
2008                     }
2009                     if (!empty($cm) and !$cm->visible) { // Not allowed to see module, send to course page
2010                         redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course,
2011                                  get_string('activityiscurrentlyhidden'));
2012                     }
2014                     user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2015                     return;   // User is allowed to see this course
2017                     break;
2019                 case 2:    /// Guests allowed with key
2020                     if (!empty($USER->enrolkey[$COURSE->id])) {   // Set by enrol/manual/enrol.php
2021                         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2022                         return true;
2023                     }
2024                     //  otherwise drop through to logic below (--> enrol.php)
2025                     break;
2027                 default:    /// Guests not allowed
2028                     $strloggedinasguest = get_string('loggedinasguest');
2029                     print_header_simple('', '',
2030                             build_navigation(array(array('name' => $strloggedinasguest, 'link' => null, 'type' => 'misc'))));
2031                     if (empty($USER->access['rsw'][$COURSE->context->path])) {  // Normal guest
2032                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), "$CFG->wwwroot/login/index.php");
2033                     } else {
2034                         notify(get_string('guestsnotallowed', '', format_string($COURSE->fullname)));
2035                         echo '<div class="notifyproblem">'.switchroles_form($COURSE->id).'</div>';
2036                         print_footer($COURSE);
2037                         exit;
2038                     }
2039                     break;
2040             }
2042     /// For non-guests, check if they have course view access
2044         } else if (has_capability('moodle/course:view', $COURSE->context)) {
2045             if (!empty($USER->realuser)) {   // Make sure the REAL person can also access this course
2046                 if (!has_capability('moodle/course:view', $COURSE->context, $USER->realuser)) {
2047                     print_header_simple();
2048                     notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2049                 }
2050             }
2052         /// Make sure they can read this activity too, if specified
2054             if (!empty($cm) and !$cm->visible and !has_capability('moodle/course:viewhiddenactivities', $COURSE->context)) { 
2055                 redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course, get_string('activityiscurrentlyhidden'));
2056             }
2057             user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2058             return;   // User is allowed to see this course
2060         }
2063     /// Currently not enrolled in the course, so see if they want to enrol
2064         $SESSION->wantsurl = $FULLME;
2065         redirect($CFG->wwwroot .'/course/enrol.php?id='. $COURSE->id);
2066         die;
2067     }
2072 /**
2073  * This function just makes sure a user is logged out.
2074  *
2075  * @uses $CFG
2076  * @uses $USER
2077  */
2078 function require_logout() {
2080     global $USER, $CFG, $SESSION;
2082     if (isloggedin()) {
2083         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2085         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2086         foreach($authsequence as $authname) {
2087             $authplugin = get_auth_plugin($authname);
2088             $authplugin->prelogout_hook();
2089         }
2090     }
2092     // Initialize variable to pass-by-reference to headers_sent(&$file, &$line)
2093     $file = $line = null;
2094     if (headers_sent($file, $line)) {
2095         error_log('MoodleSessionTest cookie could not be set in moodlelib.php:'.__LINE__);
2096         error_log('Headers were already sent in file: '.$file.' on line '.$line);
2097     } else {
2098         setcookie('MoodleSessionTest'.$CFG->sessioncookie, '', time() - 3600, $CFG->sessioncookiepath, '', $CFG->cookiesecure, $CFG->cookiehttponly);
2099     }
2101     unset($_SESSION['USER']);
2102     unset($_SESSION['SESSION']);
2104     unset($SESSION);
2105     unset($USER);
2109 /**
2110  * This is a weaker version of {@link require_login()} which only requires login
2111  * when called from within a course rather than the site page, unless
2112  * the forcelogin option is turned on.
2113  *
2114  * @uses $CFG
2115  * @param mixed $courseorid The course object or id in question
2116  * @param bool $autologinguest Allow autologin guests if that is wanted
2117  * @param object $cm Course activity module if known
2118  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2119  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2120  *             in order to keep redirects working properly. MDL-14495
2121  */
2122 function require_course_login($courseorid, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2123     global $CFG;
2124     if (!empty($CFG->forcelogin)) {
2125         // login required for both SITE and courses
2126         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2128     } else if (!empty($cm) and !$cm->visible) {
2129         // always login for hidden activities
2130         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2132     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2133           or (!is_object($courseorid) and $courseorid == SITEID)) {
2134         //login for SITE not required
2135         user_accesstime_log(SITEID);
2136         return;
2138     } else {
2139         // course login always required
2140         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2141     }
2144 /**
2145  * Require key login. Function terminates with error if key not found or incorrect.
2146  * @param string $script unique script identifier
2147  * @param int $instance optional instance id
2148  */
2149 function require_user_key_login($script, $instance=null) {
2150     global $nomoodlecookie, $USER, $SESSION, $CFG;
2152     if (empty($nomoodlecookie)) {
2153         print_error('Incorrect use of require_key_login() - session cookies must be disabled!');
2154     }
2156 /// extra safety
2157     @session_write_close();
2159     $keyvalue = required_param('key', PARAM_ALPHANUM);
2161     if (!$key = get_record('user_private_key', 'script', $script, 'value', $keyvalue, 'instance', $instance)) {
2162         print_error('Incorrect key');
2163     }
2165     if (!empty($key->validuntil) and $key->validuntil < time()) {
2166         print_error('Expired key');
2167     }
2169     if ($key->iprestriction) {
2170         $remoteaddr = getremoteaddr();
2171         if ($remoteaddr == '' or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2172             print_error('Client IP address mismatch');
2173         }
2174     }
2176     if (!$user = get_record('user', 'id', $key->userid)) {
2177         print_error('Incorrect user record');
2178     }
2180 /// emulate normal session
2181     $SESSION = new object();
2182     $USER    = $user;
2184 /// note we are not using normal login
2185     if (!defined('USER_KEY_LOGIN')) {
2186         define('USER_KEY_LOGIN', true);
2187     }
2189     load_all_capabilities();
2191 /// return isntance id - it might be empty
2192     return $key->instance;
2195 /**
2196  * Creates a new private user access key.
2197  * @param string $script unique target identifier
2198  * @param int $userid
2199  * @param instance $int optional instance id
2200  * @param string $iprestriction optional ip restricted access
2201  * @param timestamp $validuntil key valid only until given data
2202  * @return string access key value
2203  */
2204 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2205     $key = new object();
2206     $key->script        = $script;
2207     $key->userid        = $userid;
2208     $key->instance      = $instance;
2209     $key->iprestriction = $iprestriction;
2210     $key->validuntil    = $validuntil;
2211     $key->timecreated   = time();
2213     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2214     while (record_exists('user_private_key', 'value', $key->value)) {
2215         // must be unique
2216         $key->value     = md5($userid.'_'.time().random_string(40));
2217     }
2219     if (!insert_record('user_private_key', $key)) {
2220         print_error('Can not insert new key');
2221     }
2223     return $key->value;
2226 /**
2227  * Modify the user table by setting the currently logged in user's
2228  * last login to now.
2229  *
2230  * @uses $USER
2231  * @return bool
2232  */
2233 function update_user_login_times() {
2234     global $USER;
2236     $user = new object();
2237     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2238     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2240     $user->id = $USER->id;
2242     return update_record('user', $user);
2245 /**
2246  * Determines if a user has completed setting up their account.
2247  *
2248  * @param user $user A {@link $USER} object to test for the existance of a valid name and email
2249  * @return bool
2250  */
2251 function user_not_fully_set_up($user) {
2252     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2255 function over_bounce_threshold($user) {
2257     global $CFG;
2259     if (empty($CFG->handlebounces)) {
2260         return false;
2261     }
2262     // set sensible defaults
2263     if (empty($CFG->minbounces)) {
2264         $CFG->minbounces = 10;
2265     }
2266     if (empty($CFG->bounceratio)) {
2267         $CFG->bounceratio = .20;
2268     }
2269     $bouncecount = 0;
2270     $sendcount = 0;
2271     if ($bounce = get_record('user_preferences','userid',$user->id,'name','email_bounce_count')) {
2272         $bouncecount = $bounce->value;
2273     }
2274     if ($send = get_record('user_preferences','userid',$user->id,'name','email_send_count')) {
2275         $sendcount = $send->value;
2276     }
2277     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2280 /**
2281  * @param $user - object containing an id
2282  * @param $reset - will reset the count to 0
2283  */
2284 function set_send_count($user,$reset=false) {
2285     if ($pref = get_record('user_preferences','userid',$user->id,'name','email_send_count')) {
2286         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2287         update_record('user_preferences',$pref);
2288     }
2289     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2290         // make a new one
2291         $pref->name = 'email_send_count';
2292         $pref->value = 1;
2293         $pref->userid = $user->id;
2294         insert_record('user_preferences',$pref, false);
2295     }
2298 /**
2299 * @param $user - object containing an id
2300  * @param $reset - will reset the count to 0
2301  */
2302 function set_bounce_count($user,$reset=false) {
2303     if ($pref = get_record('user_preferences','userid',$user->id,'name','email_bounce_count')) {
2304         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2305         update_record('user_preferences',$pref);
2306     }
2307     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2308         // make a new one
2309         $pref->name = 'email_bounce_count';
2310         $pref->value = 1;
2311         $pref->userid = $user->id;
2312         insert_record('user_preferences',$pref, false);
2313     }
2316 /**
2317  * Keeps track of login attempts
2318  *
2319  * @uses $SESSION
2320  */
2321 function update_login_count() {
2323     global $SESSION;
2325     $max_logins = 10;
2327     if (empty($SESSION->logincount)) {
2328         $SESSION->logincount = 1;
2329     } else {
2330         $SESSION->logincount++;
2331     }
2333     if ($SESSION->logincount > $max_logins) {
2334         unset($SESSION->wantsurl);
2335         print_error('errortoomanylogins');
2336     }
2339 /**
2340  * Resets login attempts
2341  *
2342  * @uses $SESSION
2343  */
2344 function reset_login_count() {
2345     global $SESSION;
2347     $SESSION->logincount = 0;
2350 function sync_metacourses() {
2352     global $CFG;
2354     if (!$courses = get_records('course', 'metacourse', 1)) {
2355         return;
2356     }
2358     foreach ($courses as $course) {
2359         sync_metacourse($course);
2360     }
2363 /**
2364  * Goes through all enrolment records for the courses inside the metacourse and sync with them.
2365  *
2366  * @param mixed $course the metacourse to synch. Either the course object itself, or the courseid.
2367  */
2368 function sync_metacourse($course) {
2369     global $CFG;
2371     // Check the course is valid.
2372     if (!is_object($course)) {
2373         if (!$course = get_record('course', 'id', $course)) {
2374             return false; // invalid course id
2375         }
2376     }
2378     // Check that we actually have a metacourse.
2379     if (empty($course->metacourse)) {
2380         return false;
2381     }
2383     // Get a list of roles that should not be synced.
2384     if (!empty($CFG->nonmetacoursesyncroleids)) {
2385         $roleexclusions = 'ra.roleid NOT IN (' . $CFG->nonmetacoursesyncroleids . ') AND';
2386     } else {
2387         $roleexclusions = '';
2388     }
2390     // Get the context of the metacourse.
2391     $context = get_context_instance(CONTEXT_COURSE, $course->id); // SITEID can not be a metacourse
2393     // We do not ever want to unassign the list of metacourse manager, so get a list of them.
2394     if ($users = get_users_by_capability($context, 'moodle/course:managemetacourse')) {
2395         $managers = array_keys($users);
2396     } else {
2397         $managers = array();
2398     }
2400     // Get assignments of a user to a role that exist in a child course, but
2401     // not in the meta coure. That is, get a list of the assignments that need to be made.
2402     if (!$assignments = get_records_sql("
2403             SELECT
2404                 ra.id, ra.roleid, ra.userid
2405             FROM
2406                 {$CFG->prefix}role_assignments ra,
2407                 {$CFG->prefix}context con,
2408                 {$CFG->prefix}course_meta cm
2409             WHERE
2410                 ra.contextid = con.id AND
2411                 con.contextlevel = " . CONTEXT_COURSE . " AND
2412                 con.instanceid = cm.child_course AND
2413                 cm.parent_course = {$course->id} AND
2414                 $roleexclusions
2415                 NOT EXISTS (
2416                     SELECT 1 FROM
2417                         {$CFG->prefix}role_assignments ra2
2418                     WHERE
2419                         ra2.userid = ra.userid AND
2420                         ra2.roleid = ra.roleid AND
2421                         ra2.contextid = {$context->id}
2422                 )
2423     ")) {
2424         $assignments = array();
2425     }
2427     // Get assignments of a user to a role that exist in the meta course, but
2428     // not in any child courses. That is, get a list of the unassignments that need to be made.
2429     if (!$unassignments = get_records_sql("
2430             SELECT
2431                 ra.id, ra.roleid, ra.userid
2432             FROM
2433                 {$CFG->prefix}role_assignments ra
2434             WHERE
2435                 ra.contextid = {$context->id} AND
2436                 $roleexclusions
2437                 NOT EXISTS (
2438                     SELECT 1 FROM
2439                         {$CFG->prefix}role_assignments ra2,
2440                         {$CFG->prefix}context con2,
2441                         {$CFG->prefix}course_meta cm
2442                     WHERE
2443                         ra2.userid = ra.userid AND
2444                         ra2.roleid = ra.roleid AND
2445                         ra2.contextid = con2.id AND
2446                         con2.contextlevel = " . CONTEXT_COURSE . " AND
2447                         con2.instanceid = cm.child_course AND
2448                         cm.parent_course = {$course->id}
2449                 )
2450     ")) {
2451         $unassignments = array();
2452     }
2454     $success = true;
2456     // Make the unassignments, if they are not managers.
2457     foreach ($unassignments as $unassignment) {
2458         if (!in_array($unassignment->userid, $managers)) {
2459             $success = role_unassign($unassignment->roleid, $unassignment->userid, 0, $context->id) && $success;
2460         }
2461     }
2463     // Make the assignments.
2464     foreach ($assignments as $assignment) {
2465         $success = role_assign($assignment->roleid, $assignment->userid, 0, $context->id) && $success;
2466     }
2468     return $success;
2470 // TODO: finish timeend and timestart
2471 // maybe we could rely on cron job to do the cleaning from time to time
2474 /**
2475  * Adds a record to the metacourse table and calls sync_metacoures
2476  */
2477 function add_to_metacourse ($metacourseid, $courseid) {
2479     if (!$metacourse = get_record("course","id",$metacourseid)) {
2480         return false;
2481     }
2483     if (!$course = get_record("course","id",$courseid)) {
2484         return false;
2485     }
2487     if (!$record = get_record("course_meta","parent_course",$metacourseid,"child_course",$courseid)) {
2488         $rec = new object();
2489         $rec->parent_course = $metacourseid;
2490         $rec->child_course = $courseid;
2491         if (!insert_record('course_meta',$rec)) {
2492             return false;
2493         }
2494         return sync_metacourse($metacourseid);
2495     }
2496     return true;
2500 /**
2501  * Removes the record from the metacourse table and calls sync_metacourse
2502  */
2503 function remove_from_metacourse($metacourseid, $courseid) {
2505     if (delete_records('course_meta','parent_course',$metacourseid,'child_course',$courseid)) {
2506         return sync_metacourse($metacourseid);
2507     }
2508     return false;
2512 /**
2513  * Determines if a user is currently logged in
2514  *
2515  * @uses $USER
2516  * @return bool
2517  */
2518 function isloggedin() {
2519     global $USER;
2521     return (!empty($USER->id));
2524 /**
2525  * Determines if a user is logged in as real guest user with username 'guest'.
2526  * This function is similar to original isguest() in 1.6 and earlier.
2527  * Current isguest() is deprecated - do not use it anymore.
2528  *
2529  * @param $user mixed user object or id, $USER if not specified
2530  * @return bool true if user is the real guest user, false if not logged in or other user
2531  */
2532 function isguestuser($user=NULL) {
2533     global $USER;
2534     if ($user === NULL) {
2535         $user = $USER;
2536     } else if (is_numeric($user)) {
2537         $user = get_record('user', 'id', $user, '', '', '', '', 'id, username');
2538     }
2540     if (empty($user->id)) {
2541         return false; // not logged in, can not be guest
2542     }
2544     return ($user->username == 'guest');
2547 /**
2548  * Determines if the currently logged in user is in editing mode.
2549  * Note: originally this function had $userid parameter - it was not usable anyway
2550  *
2551  * @uses $USER, $PAGE
2552  * @return bool
2553  */
2554 function isediting() {
2555     global $USER, $PAGE;
2557     if (empty($USER->editing)) {
2558         return false;
2559     } elseif (is_object($PAGE) && method_exists($PAGE,'user_allowed_editing')) {
2560         return $PAGE->user_allowed_editing();
2561     }
2562     return true;//false;
2565 /**
2566  * Determines if the logged in user is currently moving an activity
2567  *
2568  * @uses $USER
2569  * @param int $courseid The id of the course being tested
2570  * @return bool
2571  */
2572 function ismoving($courseid) {
2573     global $USER;
2575     if (!empty($USER->activitycopy)) {
2576         return ($USER->activitycopycourse == $courseid);
2577     }
2578     return false;
2581 /**
2582  * Given an object containing firstname and lastname
2583  * values, this function returns a string with the
2584  * full name of the person.
2585  * The result may depend on system settings
2586  * or language.  'override' will force both names
2587  * to be used even if system settings specify one.
2588  *
2589  * @uses $CFG
2590  * @uses $SESSION
2591  * @param object $user A {@link $USER} object to get full name of
2592  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
2593  */
2594 function fullname($user, $override=false) {
2596     global $CFG, $SESSION;
2598     if (!isset($user->firstname) and !isset($user->lastname)) {
2599         return '';
2600     }
2602     if (!$override) {
2603         if (!empty($CFG->forcefirstname)) {
2604             $user->firstname = $CFG->forcefirstname;
2605         }
2606         if (!empty($CFG->forcelastname)) {
2607             $user->lastname = $CFG->forcelastname;
2608         }
2609     }
2611     if (!empty($SESSION->fullnamedisplay)) {
2612         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
2613     }
2615     if ($CFG->fullnamedisplay == 'firstname lastname') {
2616         return $user->firstname .' '. $user->lastname;
2618     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
2619         return $user->lastname .' '. $user->firstname;
2621     } else if ($CFG->fullnamedisplay == 'firstname') {
2622         if ($override) {
2623             return get_string('fullnamedisplay', '', $user);
2624         } else {
2625             return $user->firstname;
2626         }
2627     }
2629     return get_string('fullnamedisplay', '', $user);
2632 /**
2633  * Sets a moodle cookie with an encrypted string
2634  *
2635  * @uses $CFG
2636  * @uses DAYSECS
2637  * @uses HOURSECS
2638  * @param string $thing The string to encrypt and place in a cookie
2639  */
2640 function set_moodle_cookie($thing) {
2641     global $CFG;
2643     if ($thing == 'guest') {  // Ignore guest account
2644         return;
2645     }
2647     $cookiename = 'MOODLEID_'.$CFG->sessioncookie;
2649     $days = 60;
2650     $seconds = DAYSECS*$days;
2652     // no need to set secure or http cookie only here - it is not secret
2653     setCookie($cookiename, '', time() - HOURSECS, $CFG->sessioncookiepath);
2654     setCookie($cookiename, rc4encrypt($thing), time()+$seconds, $CFG->sessioncookiepath);
2657 /**
2658  * Gets a moodle cookie with an encrypted string
2659  *
2660  * @uses $CFG
2661  * @return string
2662  */
2663 function get_moodle_cookie() {
2664     global $CFG;
2666     $cookiename = 'MOODLEID_'.$CFG->sessioncookie;
2668     if (empty($_COOKIE[$cookiename])) {
2669         return '';
2670     } else {
2671         $thing = rc4decrypt($_COOKIE[$cookiename]);
2672         return ($thing == 'guest') ? '': $thing;  // Ignore guest account
2673     }
2676 /**
2677  * Returns whether a given authentication plugin exists.
2678  *
2679  * @uses $CFG
2680  * @param string $auth Form of authentication to check for. Defaults to the
2681  *        global setting in {@link $CFG}.
2682  * @return boolean Whether the plugin is available.
2683  */
2684 function exists_auth_plugin($auth) {
2685     global $CFG;
2687     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
2688         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
2689     }
2690     return false;
2693 /**
2694  * Checks if a given plugin is in the list of enabled authentication plugins.
2695  *
2696  * @param string $auth Authentication plugin.
2697  * @return boolean Whether the plugin is enabled.
2698  */
2699 function is_enabled_auth($auth) {
2700     if (empty($auth)) {
2701         return false;
2702     }
2704     $enabled = get_enabled_auth_plugins();
2706     return in_array($auth, $enabled);
2709 /**
2710  * Returns an authentication plugin instance.
2711  *
2712  * @uses $CFG
2713  * @param string $auth name of authentication plugin
2714  * @return object An instance of the required authentication plugin.
2715  */
2716 function get_auth_plugin($auth) {
2717     global $CFG;
2719     // check the plugin exists first
2720     if (! exists_auth_plugin($auth)) {
2721         print_error("Authentication plugin '$auth' not found.");
2722     }
2724     // return auth plugin instance
2725     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
2726     $class = "auth_plugin_$auth";
2727     return new $class;
2730 /**
2731  * Returns array of active auth plugins.
2732  *
2733  * @param bool $fix fix $CFG->auth if needed
2734  * @return array
2735  */
2736 function get_enabled_auth_plugins($fix=false) {
2737     global $CFG;
2739     $default = array('manual', 'nologin');
2741     if (empty($CFG->auth)) {
2742         $auths = array();
2743     } else {
2744         $auths = explode(',', $CFG->auth);
2745     }
2747     if ($fix) {
2748         $auths = array_unique($auths);
2749         foreach($auths as $k=>$authname) {
2750             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
2751                 unset($auths[$k]);
2752             }
2753         }
2754         $newconfig = implode(',', $auths);
2755         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
2756             set_config('auth', $newconfig);
2757         }
2758     }
2760     return (array_merge($default, $auths));
2763 /**
2764  * Returns true if an internal authentication method is being used.
2765  * if method not specified then, global default is assumed
2766  *
2767  * @uses $CFG
2768  * @param string $auth Form of authentication required
2769  * @return bool
2770  */
2771 function is_internal_auth($auth) {
2772     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
2773     return $authplugin->is_internal();
2776 /**
2777  * Returns an array of user fields
2778  *
2779  * @uses $CFG
2780  * @uses $db
2781  * @return array User field/column names
2782  */
2783 function get_user_fieldnames() {
2785     global $CFG, $db;
2787     $fieldarray = $db->MetaColumnNames($CFG->prefix.'user');
2788     unset($fieldarray['ID']);
2790     return $fieldarray;
2793 /**
2794  * Creates the default "guest" user. Used both from
2795  * admin/index.php and login/index.php
2796  * @return mixed user object created or boolean false if the creation has failed
2797  */
2798 function create_guest_record() {
2800     global $CFG;
2802     $guest = new stdClass();
2803     $guest->auth        = 'manual';
2804     $guest->username    = 'guest';
2805     $guest->password    = hash_internal_user_password('guest');
2806     $guest->firstname   = addslashes(get_string('guestuser'));
2807     $guest->lastname    = ' ';
2808     $guest->email       = 'root@localhost';
2809     $guest->description = addslashes(get_string('guestuserinfo'));
2810     $guest->mnethostid  = $CFG->mnet_localhost_id;
2811     $guest->confirmed   = 1;
2812     $guest->lang        = $CFG->lang;
2813     $guest->timemodified= time();
2815     if (! $guest->id = insert_record("user", $guest)) {
2816         return false;
2817     }
2819     return $guest;
2822 /**
2823  * Creates a bare-bones user record
2824  *
2825  * @uses $CFG
2826  * @param string $username New user's username to add to record
2827  * @param string $password New user's password to add to record
2828  * @param string $auth Form of authentication required
2829  * @return object A {@link $USER} object
2830  * @todo Outline auth types and provide code example
2831  */
2832 function create_user_record($username, $password, $auth='manual') {
2833     global $CFG;
2835     //just in case check text case
2836     $username = trim(moodle_strtolower($username));
2838     $authplugin = get_auth_plugin($auth);
2840     if ($newinfo = $authplugin->get_userinfo($username)) {
2841         $newinfo = truncate_userinfo($newinfo);
2842         foreach ($newinfo as $key => $value){
2843             $newuser->$key = addslashes($value);
2844         }
2845     }
2847     if (!empty($newuser->email)) {
2848         if (email_is_not_allowed($newuser->email)) {
2849             unset($newuser->email);
2850         }
2851     }
2853     $newuser->auth = $auth;
2854     $newuser->username = $username;
2856     // fix for MDL-8480
2857     // user CFG lang for user if $newuser->lang is empty
2858     // or $user->lang is not an installed language
2859     $sitelangs = array_keys(get_list_of_languages());
2860     if (empty($newuser->lang) || !in_array($newuser->lang, $sitelangs)) {
2861         $newuser -> lang = $CFG->lang;
2862     }
2863     $newuser->confirmed = 1;
2864     $newuser->lastip = getremoteaddr();
2865     $newuser->timemodified = time();
2866     $newuser->mnethostid = $CFG->mnet_localhost_id;
2868     if (insert_record('user', $newuser)) {
2869         $user = get_complete_user_data('username', $newuser->username);
2870         if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
2871             set_user_preference('auth_forcepasswordchange', 1, $user->id);
2872         }
2873         update_internal_user_password($user, $password);
2874         return $user;
2875     }
2876     return false;
2879 /**
2880  * Will update a local user record from an external source
2881  *
2882  * @uses $CFG
2883  * @param string $username New user's username to add to record
2884  * @return user A {@link $USER} object
2885  */
2886 function update_user_record($username, $authplugin) {
2887     $username = trim(moodle_strtolower($username)); /// just in case check text case
2889     $oldinfo = get_record('user', 'username', $username, '','','','', 'username, auth');
2890     $userauth = get_auth_plugin($oldinfo->auth);
2892     if ($newinfo = $userauth->get_userinfo($username)) {
2893         $newinfo = truncate_userinfo($newinfo);
2894         foreach ($newinfo as $key => $value){
2895             $confkey = 'field_updatelocal_' . $key;
2896             if (!empty($userauth->config->$confkey) and $userauth->config->$confkey === 'onlogin') {
2897                 $value = addslashes(stripslashes($value));   // Just in case
2898                 set_field('user', $key, $value, 'username', $username)
2899                     or error_log("Error updating $key for $username");
2900             }
2901         }
2902     }
2904     return get_complete_user_data('username', $username);
2907 function truncate_userinfo($info) {
2908 /// will truncate userinfo as it comes from auth_get_userinfo (from external auth)
2909 /// which may have large fields
2911     // define the limits
2912     $limit = array(
2913                     'username'    => 100,
2914                     'idnumber'    => 255,
2915                     'firstname'   => 100,
2916                     'lastname'    => 100,
2917                     'email'       => 100,
2918                     'icq'         =>  15,
2919                     'phone1'      =>  20,
2920                     'phone2'      =>  20,
2921                     'institution' =>  40,
2922                     'department'  =>  30,
2923                     'address'     =>  70,
2924                     'city'        =>  20,
2925                     'country'     =>   2,
2926                     'url'         => 255,
2927                     );
2929     // apply where needed
2930     foreach (array_keys($info) as $key) {
2931         if (!empty($limit[$key])) {
2932             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
2933         }
2934     }
2936     return $info;
2939 /**
2940  * Marks user deleted in internal user database and notifies the auth plugin.
2941  * Also unenrols user from all roles and does other cleanup.
2942  * @param object $user       Userobject before delete    (without system magic quotes)
2943  * @return boolean success
2944  */
2945 function delete_user($user) {
2946     global $CFG;
2947     require_once($CFG->libdir.'/grouplib.php');
2948     require_once($CFG->libdir.'/gradelib.php');
2950     begin_sql();
2952     // delete all grades - backup is kept in grade_grades_history table
2953     if ($grades = grade_grade::fetch_all(array('userid'=>$user->id))) {
2954         foreach ($grades as $grade) {
2955             $grade->delete('userdelete');
2956         }
2957     }
2959     // remove from all groups
2960     delete_records('groups_members', 'userid', $user->id);
2962     // unenrol from all roles in all contexts
2963     role_unassign(0, $user->id); // this might be slow but it is really needed - modules might do some extra cleanup!
2965     // now do a final accesslib cleanup - removes all role assingments in user context and context itself
2966     delete_context(CONTEXT_USER, $user->id);
2968     require_once($CFG->dirroot.'/tag/lib.php');
2969     tag_set('user', $user->id, array());
2971     // workaround for bulk deletes of users with the same email address
2972     $delname = addslashes("$user->email.".time());
2973     while (record_exists('user', 'username', $delname)) { // no need to use mnethostid here
2974         $delname++;
2975     }
2977     // mark internal user record as "deleted"
2978     $updateuser = new object();
2979     $updateuser->id           = $user->id;
2980     $updateuser->deleted      = 1;
2981     $updateuser->username     = $delname;         // Remember it just in case
2982     $updateuser->email        = '';               // Clear this field to free it up
2983     $updateuser->idnumber     = '';               // Clear this field to free it up
2984     $updateuser->timemodified = time();
2986     if (update_record('user', $updateuser)) {
2987         commit_sql();
2988         // notify auth plugin - do not block the delete even when plugin fails
2989         $authplugin = get_auth_plugin($user->auth);
2990         $authplugin->user_delete($user);
2991         return true;
2993     } else {
2994         rollback_sql();
2995         return false;
2996     }
2999 /**
3000  * Retrieve the guest user object
3001  *
3002  * @uses $CFG
3003  * @return user A {@link $USER} object
3004  */
3005 function guest_user() {
3006     global $CFG;
3008     if ($newuser = get_record('user', 'username', 'guest', 'mnethostid',  $CFG->mnet_localhost_id)) {
3009         $newuser->confirmed = 1;
3010         $newuser->lang = $CFG->lang;
3011         $newuser->lastip = getremoteaddr();
3012     }
3014     return $newuser;
3017 /**
3018  * Given a username and password, this function looks them
3019  * up using the currently selected authentication mechanism,
3020  * and if the authentication is successful, it returns a
3021  * valid $user object from the 'user' table.
3022  *
3023  * Uses auth_ functions from the currently active auth module
3024  *
3025  * After authenticate_user_login() returns success, you will need to
3026  * log that the user has logged in, and call complete_user_login() to set
3027  * the session up.
3028  *
3029  * @uses $CFG
3030  * @param string $username  User's username (with system magic quotes)
3031  * @param string $password  User's password (with system magic quotes)
3032  * @return user|flase A {@link $USER} object or false if error
3033  */
3034 function authenticate_user_login($username, $password) {
3036     global $CFG;
3038     $authsenabled = get_enabled_auth_plugins();
3040     if ($user = get_complete_user_data('username', $username)) {
3041         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3042         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3043             add_to_log(0, 'login', 'error', 'index.php', $username);
3044             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3045             return false;
3046         }
3047         if (!empty($user->deleted)) {
3048             add_to_log(0, 'login', 'error', 'index.php', $username);
3049             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3050             return false;
3051         }
3052         $auths = array($auth);
3054     } else {
3055         $auths = $authsenabled;
3056         $user = new object();
3057         $user->id = 0;     // User does not exist
3058     }
3060     foreach ($auths as $auth) {
3061         $authplugin = get_auth_plugin($auth);
3063         // on auth fail fall through to the next plugin
3064         if (!$authplugin->user_login($username, $password)) {
3065             continue;
3066         }
3068         // successful authentication
3069         if ($user->id) {                          // User already exists in database
3070             if (empty($user->auth)) {             // For some reason auth isn't set yet
3071                 set_field('user', 'auth', $auth, 'username', $username);
3072                 $user->auth = $auth;
3073             }
3075             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3077             if (!$authplugin->is_internal()) {            // update user record from external DB
3078                 $user = update_user_record($username, get_auth_plugin($user->auth));
3079             }
3080         } else {
3081             // if user not found, create him
3082             $user = create_user_record($username, $password, $auth);
3083         }
3085         $authplugin->sync_roles($user);
3087         foreach ($authsenabled as $hau) {
3088             $hauth = get_auth_plugin($hau);
3089             $hauth->user_authenticated_hook($user, $username, $password);
3090         }
3092     /// Log in to a second system if necessary
3093     /// NOTICE: /sso/ will be moved to auth and deprecated soon; use user_authenticated_hook() instead
3094         if (!empty($CFG->sso)) {
3095             include_once($CFG->dirroot .'/sso/'. $CFG->sso .'/lib.php');
3096             if (function_exists('sso_user_login')) {
3097                 if (!sso_user_login($username, $password)) {   // Perform the signon process
3098                     notify('Second sign-on failed');
3099                 }
3100             }
3101         }
3103         if ($user->id===0) {
3104             return false;
3105         }
3106         return $user;
3107     }
3109     // failed if all the plugins have failed
3110     add_to_log(0, 'login', 'error', 'index.php', $username);
3111     if (debugging('', DEBUG_ALL)) {
3112         error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3113     }
3114     return false;
3117 /**
3118  * Call to complete the user login process after authenticate_user_login()
3119  * has succeeded. It will setup the $USER variable and other required bits
3120  * and pieces.
3121  * 
3122  * NOTE:
3123  * - It will NOT log anything -- up to the caller to decide what to log.
3124  *
3125  *
3126  *
3127  * @uses $CFG, $USER
3128  * @param string $user obj
3129  * @return user|flase A {@link $USER} object or false if error
3130  */
3131 function complete_user_login($user) {
3132     global $CFG, $USER;
3133     
3134     $USER = $user; // this is required because we need to access preferences here!
3136     reload_user_preferences();
3138     update_user_login_times();
3139     if (empty($CFG->nolastloggedin)) {
3140         set_moodle_cookie($USER->username);
3141     } else {
3142         // do not store last logged in user in cookie
3143         // auth plugins can temporarily override this from loginpage_hook()
3144         // do not save $CFG->nolastloggedin in database!
3145         set_moodle_cookie('nobody');
3146     }
3147     set_login_session_preferences();
3149     // Call enrolment plugins
3150     check_enrolment_plugins($user);
3152     /// This is what lets the user do anything on the site :-)
3153     load_all_capabilities();
3155     /// Select password change url
3156     $userauth = get_auth_plugin($USER->auth);
3158     /// check whether the user should be changing password
3159     if (get_user_preferences('auth_forcepasswordchange', false)){
3160         if ($userauth->can_change_password()) {
3161             if ($changeurl = $userauth->change_password_url()) {
3162                 redirect($changeurl);
3163             } else {
3164                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3165             }
3166         } else {
3167             print_error('nopasswordchangeforced', 'auth');
3168         }
3169     }
3170     return $USER;
3173 /**
3174  * Compare password against hash stored in internal user table.
3175  * If necessary it also updates the stored hash to new format.
3176  *
3177  * @param object user
3178  * @param string plain text password
3179  * @return bool is password valid?
3180  */
3181 function validate_internal_user_password(&$user, $password) {
3182     global $CFG;
3184     if (!isset($CFG->passwordsaltmain)) {
3185         $CFG->passwordsaltmain = '';
3186     }
3188     $validated = false;
3190     // get password original encoding in case it was not updated to unicode yet
3191     $textlib = textlib_get_instance();
3192     $convpassword = $textlib->convert($password, 'utf-8', get_string('oldcharset'));
3194     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)
3195         or $user->password == md5($convpassword.$CFG->passwordsaltmain) or $user->password == md5($convpassword)) {
3196         $validated = true;
3197     } else {
3198         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3199             $alt = 'passwordsaltalt'.$i;
3200             if (!empty($CFG->$alt)) {
3201                 if ($user->password == md5($password.$CFG->$alt) or $user->password == md5($convpassword.$CFG->$alt)) {
3202                     $validated = true;
3203                     break;
3204                 }
3205             }
3206         }
3207     }
3209     if ($validated) {
3210         // force update of password hash using latest main password salt and encoding if needed
3211         update_internal_user_password($user, $password);
3212     }
3214     return $validated;
3217 /**
3218  * Calculate hashed value from password using current hash mechanism.
3219  *
3220  * @param string password
3221  * @return string password hash
3222  */
3223 function hash_internal_user_password($password) {
3224     global $CFG;
3226     if (isset($CFG->passwordsaltmain)) {
3227         return md5($password.$CFG->passwordsaltmain);
3228     } else {
3229         return md5($password);
3230     }
3233 /**
3234  * Update pssword hash in user object.
3235  *
3236  * @param object user
3237  * @param string plain text password
3238  * @param bool store changes also in db, default true
3239  * @return true if hash changed
3240  */
3241 function update_internal_user_password(&$user, $password) {
3242     global $CFG;
3244     $authplugin = get_auth_plugin($user->auth);
3245     if (!empty($authplugin->config->preventpassindb)) {
3246         $hashedpassword = 'not cached';
3247     } else {
3248         $hashedpassword = hash_internal_user_password($password);
3249     }
3251     return set_field('user', 'password',  $hashedpassword, 'id', $user->id);
3254 /**
3255  * Get a complete user record, which includes all the info
3256  * in the user record
3257  * Intended for setting as $USER session variable
3258  *
3259  * @uses $CFG
3260  * @uses SITEID
3261  * @param string $field The user field to be checked for a given value.
3262  * @param string $value The value to match for $field.
3263  * @return user A {@link $USER} object.
3264  */
3265 function get_complete_user_data($field, $value, $mnethostid=null) {
3267     global $CFG;
3269     if (!$field || !$value) {
3270         return false;
3271     }
3273 /// Build the WHERE clause for an SQL query
3275     $constraints = $field .' = \''. $value .'\' AND deleted <> \'1\'';
3277     if (is_null($mnethostid)) {
3278         // if null, we restrict to local users
3279         // ** testing for local user can be done with
3280         //    mnethostid = $CFG->mnet_localhost_id
3281         //    or with
3282         //    auth != 'mnet'
3283         //    but the first one is FAST with our indexes
3284         $mnethostid = $CFG->mnet_localhost_id;
3285     }
3286     $mnethostid = (int)$mnethostid;
3287     $constraints .= ' AND mnethostid = \''.$mnethostid.'\'';
3289 /// Get all the basic user data
3291     if (! $user = get_record_select('user', $constraints)) {
3292         return false;
3293     }
3295 /// Get various settings and preferences
3297     if ($displays = get_records('course_display', 'userid', $user->id)) {
3298         foreach ($displays as $display) {
3299             $user->display[$display->course] = $display->display;
3300         }
3301     }
3303     $user->preference = get_user_preferences(null, null, $user->id);
3305     $user->lastcourseaccess    = array(); // during last session
3306     $user->currentcourseaccess = array(); // during current session
3307     if ($lastaccesses = get_records('user_lastaccess', 'userid', $user->id)) {
3308         foreach ($lastaccesses as $lastaccess) {
3309             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
3310         }
3311     }
3313     $sql = "SELECT g.id, g.courseid
3314               FROM {$CFG->prefix}groups g, {$CFG->prefix}groups_members gm
3315              WHERE gm.groupid=g.id AND gm.userid={$user->id}";
3317     // this is a special hack to speedup calendar display
3318     $user->groupmember = array();
3319     if ($groups = get_records_sql($sql)) {
3320         foreach ($groups as $group) {
3321             if (!array_key_exists($group->courseid, $user->groupmember)) {
3322                 $user->groupmember[$group->courseid] = array();
3323             }
3324             $user->groupmember[$group->courseid][$group->id] = $group->id;
3325         }
3326     }
3328 /// Add the custom profile fields to the user record
3329     include_once($CFG->dirroot.'/user/profile/lib.php');
3330     $customfields = (array)profile_user_record($user->id);
3331     foreach ($customfields as $cname=>$cvalue) {
3332         if (!isset($user->$cname)) { // Don't overwrite any standard fields
3333             $user->$cname = $cvalue;
3334         }
3335     }
3337 /// Rewrite some variables if necessary
3338     if (!empty($user->description)) {
3339         $user->description = true;   // No need to cart all of it around
3340     }
3341     if ($user->username == 'guest') {
3342         $user->lang       = $CFG->lang;               // Guest language always same as site
3343         $user->firstname  = get_string('guestuser');  // Name always in current language
3344         $user->lastname   = ' ';
3345     }
3347     $user->sesskey  = random_string(10);
3348     $user->sessionIP = md5(getremoteaddr());   // Store the current IP in the session
3350     return $user;
3353 /**
3354  * @uses $CFG
3355  * @param string $password the password to be checked agains the password policy
3356  * @param string $errmsg the error message to display when the password doesn't comply with the policy.
3357  * @return bool true if the password is valid according to the policy. false otherwise.
3358  */
3359 function check_password_policy($password, &$errmsg) {
3360     global $CFG;
3362     if (empty($CFG->passwordpolicy)) {
3363         return true;
3364     }
3366     $textlib = textlib_get_instance();
3367     $errmsg = '';
3368     if ($textlib->strlen($password) < $CFG->minpasswordlength) {
3369         $errmsg = get_string('errorminpasswordlength', 'auth', $CFG->minpasswordlength);
3371     } else if (preg_match_all('/[[:digit:]]/u', $password, $matches) < $CFG->minpassworddigits) {
3372         $errmsg = get_string('errorminpassworddigits', 'auth', $CFG->minpassworddigits);
3374     } else if (preg_match_all('/[[:lower:]]/u', $password, $matches) < $CFG->minpasswordlower) {
3375         $errmsg = get_string('errorminpasswordlower', 'auth', $CFG->minpasswordlower);
3377     } else if (preg_match_all('/[[:upper:]]/u', $password, $matches) < $CFG->minpasswordupper) {
3378         $errmsg = get_string('errorminpasswordupper', 'auth', $CFG->minpasswordupper);
3380     } else if (preg_match_all('/[^[:upper:][:lower:][:digit:]]/u', $password, $matches) < $CFG->minpasswordnonalphanum) {
3381         $errmsg = get_string('errorminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3383     } else if ($password == 'admin' or $password == 'password') {
3384         $errmsg = get_string('unsafepassword');
3385     }
3387     if ($errmsg == '') {
3388         return true;
3389     } else {
3390         return false;
3391     }
3395 /**
3396  * When logging in, this function is run to set certain preferences
3397  * for the current SESSION
3398  */
3399 function set_login_session_preferences() {
3400     global $SESSION, $CFG;
3402     $SESSION->justloggedin = true;
3404     unset($SESSION->lang);
3406     // Restore the calendar filters, if saved
3407     if (intval(get_user_preferences('calendar_persistflt', 0))) {
3408         include_once($CFG->dirroot.'/calendar/lib.php');
3409         calendar_set_filters_status(get_user_preferences('calendav_savedflt', 0xff));
3410     }
3414 /**
3415  * Delete a course, including all related data from the database,
3416  * and any associated files from the moodledata folder.
3417  *
3418  * @param int $courseid The id of the course to delete.
3419  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3420  * @return bool true if all the removals succeeded. false if there were any failures. If this
3421  *             method returns false, some of the removals will probably have succeeded, and others
3422  *             failed, but you have no way of knowing which.
3423  */
3424 function delete_course($courseid, $showfeedback = true) {
3425     global $CFG;
3426     $result = true;
3428     // frontpage course can not be deleted!!
3429     if ($courseid == SITEID) {
3430         return false;
3431     }
3433     if (!remove_course_contents($courseid, $showfeedback)) {
3434         if ($showfeedback) {
3435             notify("An error occurred while deleting some of the course contents.");
3436         }
3437         $result = false;
3438     }
3440     if (!delete_records("course", "id", $courseid)) {
3441         if ($showfeedback) {
3442             notify("An error occurred while deleting the main course record.");
3443         }
3444         $result = false;
3445     }
3447 /// Delete all roles and overiddes in the course context
3448     if (!delete_context(CONTEXT_COURSE, $courseid)) {
3449         if ($showfeedback) {
3450             notify("An error occurred while deleting the main course context.");
3451         }
3452         $result = false;
3453     }
3455     if (!fulldelete($CFG->dataroot.'/'.$courseid)) {
3456         if ($showfeedback) {
3457             notify("An error occurred while deleting the course files.");
3458         }
3459         $result = false;
3460     }
3462     return $result;
3465 /**
3466  * Clear a course out completely, deleting all content
3467  * but don't delete the course itself
3468  *
3469  * @uses $CFG
3470  * @param int $courseid The id of the course that is being deleted
3471  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3472  * @return bool true if all the removals succeeded. false if there were any failures. If this
3473  *             method returns false, some of the removals will probably have succeeded, and others
3474  *             failed, but you have no way of knowing which.
3475  */
3476 function remove_course_contents($courseid, $showfeedback=true) {
3478     global $CFG;
3479     require_once($CFG->libdir.'/questionlib.php');
3480     require_once($CFG->libdir.'/gradelib.php');
3482     $result = true;
3484     if (! $course = get_record('course', 'id', $courseid)) {
3485         print_error('Course ID was incorrect (can\'t find it)');
3486     }
3488     $strdeleted = get_string('deleted');
3490 /// First delete every instance of every module
3492     if ($allmods = get_records('modules') ) {
3493         foreach ($allmods as $mod) {
3494             $modname = $mod->name;
3495             $modfile = $CFG->dirroot .'/mod/'. $modname .'/lib.php';
3496             $moddelete = $modname .'_delete_instance';       // Delete everything connected to an instance
3497             $moddeletecourse = $modname .'_delete_course';   // Delete other stray stuff (uncommon)
3498             $count=0;
3499             if (file_exists($modfile)) {
3500                 include_once($modfile);
3501                 if (function_exists($moddelete)) {
3502                     if ($instances = get_records($modname, 'course', $course->id)) {
3503                         foreach ($instances as $instance) {
3504                             if ($cm = get_coursemodule_from_instance($modname, $instance->id, $course->id)) {
3505                                 /// Delete activity context questions and question categories
3506                                 question_delete_activity($cm,  $showfeedback);
3507                             }
3508                             if ($moddelete($instance->id)) {
3509                                 $count++;
3511                             } else {
3512                                 notify('Could not delete '. $modname .' instance '. $instance->id .' ('. format_string($instance->name) .')');
3513                                 $result = false;
3514                             }
3515                             if ($cm) {
3516                                 // delete cm and its context in correct order
3517                                 delete_records('course_modules', 'id', $cm->id);
3518                                 delete_context(CONTEXT_MODULE, $cm->id);
3519                             }
3520                         }
3521                     }
3522                 } else {
3523                     notify('Function '.$moddelete.'() doesn\'t exist!');
3524                     $result = false;
3525                 }
3527                 if (function_exists($moddeletecourse)) {
3528                     $moddeletecourse($course, $showfeedback);
3529                 }
3530             }
3531             if ($showfeedback) {
3532                 notify($strdeleted .' '. $count .' x '. $modname);
3533             }
3534         }
3535     } else {
3536         print_error('No modules are installed!');
3537     }
3539 /// Give local code a chance to delete its references to this course.
3540     require_once('locallib.php');
3541     notify_local_delete_course($courseid, $showfeedback);
3543 /// Delete course blocks
3545     if ($blocks = get_records_sql("SELECT *
3546                                    FROM {$CFG->prefix}block_instance
3547                                    WHERE pagetype = '".PAGE_COURSE_VIEW."'
3548                                    AND pageid = $course->id")) {
3549         if (delete_records('block_instance', 'pagetype', PAGE_COURSE_VIEW, 'pageid', $course->id)) {
3550             if ($showfeedback) {
3551                 notify($strdeleted .' block_instance');
3552             }
3554             require_once($CFG->libdir.'/blocklib.php');
3555             foreach ($blocks as $block) {  /// Delete any associated contexts for this block
3557                 delete_context(CONTEXT_BLOCK, $block->id);
3559                 // fix for MDL-7164
3560                 // Get the block object and call instance_delete()
3561                 if (!$record = blocks_get_record($block->blockid)) {
3562                     $result = false;
3563                     continue;
3564                 }
3565                 if (!$obj = block_instance($record->name, $block)) {
3566                     $result = false;
3567                     continue;
3568                 }
3569                 // Return value ignored, in core mods this does not do anything, but just in case
3570                 // third party blocks might have stuff to clean up
3571                 // we execute this anyway
3572                 $obj->instance_delete();
3574             }
3575         } else {
3576             $result = false;
3577         }
3578     }
3580 /// Delete any groups, removing members and grouping/course links first.
3581     require_once($CFG->dirroot.'/group/lib.php');
3582     groups_delete_groupings($courseid, $showfeedback);
3583     groups_delete_groups($courseid, $showfeedback);
3585 /// Delete all related records in other tables that may have a courseid
3586 /// This array stores the tables that need to be cleared, as
3587 /// table_name => column_name that contains the course id.
3589     $tablestoclear = array(
3590         'event' => 'courseid', // Delete events
3591         'log' => 'course', // Delete logs
3592         'course_sections' => 'course', // Delete any course stuff
3593         'course_modules' => 'course',
3594         'backup_courses' => 'courseid', // Delete scheduled backup stuff
3595         'user_lastaccess' => 'courseid',
3596         'backup_log' => 'courseid'
3597     );
3598     foreach ($tablestoclear as $table => $col) {
3599         if (delete_records($table, $col, $course->id)) {
3600             if ($showfeedback) {
3601                 notify($strdeleted . ' ' . $table);
3602             }
3603         } else {
3604             $result = false;
3605         }
3606     }
3609 /// Clean up metacourse stuff
3611     if ($course->metacourse) {
3612         delete_records("course_meta","parent_course",$course->id);
3613         sync_metacourse($course->id); // have to do it here so the enrolments get nuked. sync_metacourses won't find it without the id.
3614         if ($showfeedback) {
3615             notify("$strdeleted course_meta");
3616         }
3617     } else {
3618         if ($parents = get_records("course_meta","child_course",$course->id)) {
3619             foreach ($parents as $parent) {
3620                 remove_from_metacourse($parent->parent_course,$parent->child_course); // this will do the unenrolments as well.
3621             }
3622             if ($showfeedback) {
3623                 notify("$strdeleted course_meta");
3624             }
3625         }
3626     }
3628 /// Delete questions and question categories
3629     question_delete_course($course, $showfeedback);
3631 /// Remove all data from gradebook
3632     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3633     remove_course_grades($courseid, $showfeedback);
3634     remove_grade_letters($context, $showfeedback);
3636     return $result;
3639 /**
3640  * Change dates in module - used from course reset.
3641  * @param strin $modname forum, assignent, etc
3642  * @param array $fields array of date fields from mod table
3643  * @param int $timeshift time difference
3644  * @return success
3645  */
3646 function shift_course_mod_dates($modname, $fields, $timeshift, $courseid) {
3647     global $CFG;
3648     include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
3650     $return = true;
3651     foreach ($fields as $field) {
3652         $updatesql = "UPDATE {$CFG->prefix}$modname
3653                           SET $field = $field + ($timeshift)
3654                         WHERE course=$courseid AND $field<>0 AND $field<>0";
3655         $return = execute_sql($updatesql, false) && $return;
3656     }
3658     $refreshfunction = $modname.'_refresh_events';
3659     if (function_exists($refreshfunction)) {
3660         $refreshfunction($courseid);
3661     }
3663     return $return;
3666 /**
3667  * This function will empty a course of user data.
3668  * It will retain the activities and the structure of the course.
3669  * @param object $data an object containing all the settings including courseid (without magic quotes)
3670  * @return array status array of array component, item, error
3671  */
3672 function reset_course_userdata($data) {
3673     global $CFG, $USER;
3674     require_once($CFG->libdir.'/gradelib.php');
3675     require_once($CFG->dirroot.'/group/lib.php');
3677     $data->courseid = $data->id;
3678     $context = get_context_instance(CONTEXT_COURSE, $data->courseid);
3680     // calculate the time shift of dates
3681     if (!empty($data->reset_start_date)) {
3682         // time part of course startdate should be zero
3683         $data->timeshift = $data->reset_start_date - usergetmidnight($data->reset_start_date_old);
3684     } else {
3685         $data->timeshift = 0;
3686     }
3688     // result array: component, item, error
3689     $status = array();
3691     // start the resetting
3692     $componentstr = get_string('general');
3694     // move the course start time
3695     if (!empty($data->reset_start_date) and $data->timeshift) {
3696         // change course start data
3697         set_field('course', 'startdate', $data->reset_start_date, 'id', $data->courseid);
3698         // update all course and group events - do not move activity events
3699         $updatesql = "UPDATE {$CFG->prefix}event
3700                          SET timestart = timestart + ({$data->timeshift})
3701                        WHERE courseid={$data->courseid} AND instance=0";
3702         execute_sql($updatesql, false);
3704         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3705     }
3707     if (!empty($data->reset_logs)) {
3708         delete_records('log', 'course', $data->courseid);
3709         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletelogs'), 'error'=>false);
3710     }
3712     if (!empty($data->reset_events)) {
3713         delete_records('event', 'courseid', $data->courseid);
3714         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteevents', 'calendar'), 'error'=>false);
3715     }
3717     if (!empty($data->reset_notes)) {
3718         require_once($CFG->dirroot.'/notes/lib.php');
3719         note_delete_all($data->courseid);
3720         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotes', 'notes'), 'error'=>false);
3721     }
3723     $componentstr = get_string('roles');
3725     if (!empty($data->reset_roles_overrides)) {
3726         $children = get_child_contexts($context);
3727         foreach ($children as $child) {
3728           &n