6d0e8c9146cb63888a219fe753f4113ac9f4600e
[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('missingparam', '', '', $parname);
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("unknowparamtype", '', '', $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  * No need for get_config because they are usually always available in $CFG
617  *
618  * @param string $name the key to set
619  * @param string $value the value to set (without magic quotes)
620  * @param string $plugin (optional) the plugin scope
621  * @uses $CFG
622  * @return bool
623  */
624 function set_config($name, $value, $plugin=NULL) {
625     global $CFG, $DB;
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 ($DB->get_field('config', 'name', array('name'=>$name))) {
638             if ($value===null) {
639                 return $DB->delete_records('config', array('name'=>$name));
640             } else {
641                 return $DB->set_field('config', 'value', $value, array('name'=>$name));
642             }
643         } else {
644             if ($value===null) {
645                 return true;
646             }
647             $config = new object();
648             $config->name  = $name;
649             $config->value = $value;
650             return $DB->insert_record('config', $config);
651         }
653     } else { // plugin scope
654         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
655             if ($value===null) {
656                 return $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
657             } else {
658                 return $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
659             }
660         } else {
661             if ($value===null) {
662                 return true;
663             }
664             $config = new object();
665             $config->plugin = $plugin;
666             $config->name   = $name;
667             $config->value  = $value;
668             return $DB->insert_record('config_plugins', $config);
669         }
670     }
673 /**
674  * Get configuration values from the global config table
675  * or the config_plugins table.
676  *
677  * If called with no parameters it will do the right thing
678  * generating $CFG safely from the database without overwriting
679  * existing values.
680  *
681  * If called with 2 parameters it will return a $string single
682  * value or false of the value is not found.
683  *
684  * @param string $plugin
685  * @param string $name
686  * @uses $CFG
687  * @return hash-like object or single value
688  *
689  */
690 function get_config($plugin=NULL, $name=NULL) {
691     global $CFG, $DB;
693     if (!empty($name)) { // the user is asking for a specific value
694         if (!empty($plugin)) {
695             return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
696         } else {
697             return $DB->get_field('config', 'value', array('name'=>$name));
698         }
699     }
701     // the user is after a recordset
702     if (!empty($plugin)) {
703         if ($configs = $DB->get_records('config_plugins', array('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 = $DB->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) {
743     global $CFG, $DB;
745     unset($CFG->$name);
747     if (empty($plugin)) {
748         return $DB->delete_records('config', array('name'=>$name));
749     } else {
750         return $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
751     }
754 /**
755  * Get volatile flags
756  *
757  * @param string $type
758  * @param int    $changedsince
759  * @return records array
760  *
761  */
762 function get_cache_flags($type, $changedsince=NULL) {
763     global $DB;
765     $params = array('type'=>$type, 'expiry'=>time());
766     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
767     if ($changedsince !== NULL) {
768         $params['changedsince'] = $changedsince;
769         $sqlwhere .= " AND timemodified > :changedsince";
770     }
771     $cf = array();
773     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', '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) {
791     global $DB;
793     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
795     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
796     if ($changedsince !== NULL) {
797         $params['changedsince'] = $changedsince;
798         $sqlwhere .= " AND timemodified > :changedsince";
799     }
801     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
804 /**
805  * Set a volatile flag
806  *
807  * @param string $type the "type" namespace for the key
808  * @param string $name the key to set
809  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
810  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
811  * @return bool
812  */
813 function set_cache_flag($type, $name, $value, $expiry=NULL) {
814     global $DB;
816     $timemodified = time();
817     if ($expiry===NULL || $expiry < $timemodified) {
818         $expiry = $timemodified + 24 * 60 * 60;
819     } else {
820         $expiry = (int)$expiry;
821     }
823     if ($value === NULL) {
824         return unset_cache_flag($type,$name);
825     }
827     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type))) { // this is a potentail problem in DEBUG_DEVELOPER
828         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
829             return true; //no need to update; helps rcache too
830         }
831         $f->value        = $value;
832         $f->expiry       = $expiry;
833         $f->timemodified = $timemodified;
834         return $DB->update_record('cache_flags', $f);
835     } else {
836         $f = new object();
837         $f->flagtype     = $type;
838         $f->name         = $name;
839         $f->value        = $value;
840         $f->expiry       = $expiry;
841         $f->timemodified = $timemodified;
842         return (bool)$DB->insert_record('cache_flags', $f);
843     }
846 /**
847  * Removes a single volatile flag
848  *
849  * @param string $type the "type" namespace for the key
850  * @param string $name the key to set
851  * @uses $CFG
852  * @return bool
853  */
854 function unset_cache_flag($type, $name) {
855     global $DB;
856     return $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
859 /**
860  * Garbage-collect volatile flags
861  *
862  */
863 function gc_cache_flags() {
864     global $DB;
865     return $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
868 /**
869  * Refresh current $USER session global variable with all their current preferences.
870  * @uses $USER
871  */
872 function reload_user_preferences() {
873     global $USER, $DB;
875     //reset preference
876     $USER->preference = array();
878     if (!isloggedin() or isguestuser()) {
879         // no permanent storage for not-logged-in user and guest
881     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
882         foreach ($preferences as $preference) {
883             $USER->preference[$preference->name] = $preference->value;
884         }
885     }
887     return true;
890 /**
891  * Sets a preference for the current user
892  * Optionally, can set a preference for a different user object
893  * @uses $USER
894  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
896  * @param string $name The key to set as preference for the specified user
897  * @param string $value The value to set forthe $name key in the specified user's record
898  * @param int $otheruserid A moodle user ID
899  * @return bool
900  */
901 function set_user_preference($name, $value, $otheruserid=NULL) {
902     global $USER, $DB;
904     if (!isset($USER->preference)) {
905         reload_user_preferences();
906     }
908     if (empty($name)) {
909         return false;
910     }
912     $nostore = false;
914     if (empty($otheruserid)){
915         if (!isloggedin() or isguestuser()) {
916             $nostore = true;
917         }
918         $userid = $USER->id;
919     } else {
920         if (isguestuser($otheruserid)) {
921             $nostore = true;
922         }
923         $userid = $otheruserid;
924     }
926     $return = true;
927     if ($nostore) {
928         // no permanent storage for not-logged-in user and guest
930     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
931         if ($preference->value === $value) {
932             return true;
933         }
934         if (!$DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id))) {
935             $return = false;
936         }
938     } else {
939         $preference = new object();
940         $preference->userid = $userid;
941         $preference->name   = $name;
942         $preference->value  = (string)$value;
943         if (!$DB->insert_record('user_preferences', $preference)) {
944             $return = false;
945         }
946     }
948     // update value in USER session if needed
949     if ($userid == $USER->id) {
950         $USER->preference[$name] = (string)$value;
951     }
953     return $return;
956 /**
957  * Unsets a preference completely by deleting it from the database
958  * Optionally, can set a preference for a different user id
959  * @uses $USER
960  * @param string  $name The key to unset as preference for the specified user
961  * @param int $otheruserid A moodle user ID
962  */
963 function unset_user_preference($name, $otheruserid=NULL) {
964     global $USER, $DB;
966     if (!isset($USER->preference)) {
967         reload_user_preferences();
968     }
970     if (empty($otheruserid)){
971         $userid = $USER->id;
972     } else {
973         $userid = $otheruserid;
974     }
976     //Delete the preference from $USER if needed
977     if ($userid == $USER->id) {
978         unset($USER->preference[$name]);
979     }
981     //Then from DB
982     return $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
986 /**
987  * Sets a whole array of preferences for the current user
988  * @param array $prefarray An array of key/value pairs to be set
989  * @param int $otheruserid A moodle user ID
990  * @return bool
991  */
992 function set_user_preferences($prefarray, $otheruserid=NULL) {
994     if (!is_array($prefarray) or empty($prefarray)) {
995         return false;
996     }
998     $return = true;
999     foreach ($prefarray as $name => $value) {
1000         // The order is important; test for return is done first
1001         $return = (set_user_preference($name, $value, $otheruserid) && $return);
1002     }
1003     return $return;
1006 /**
1007  * If no arguments are supplied this function will return
1008  * all of the current user preferences as an array.
1009  * If a name is specified then this function
1010  * attempts to return that particular preference value.  If
1011  * none is found, then the optional value $default is returned,
1012  * otherwise NULL.
1013  * @param string $name Name of the key to use in finding a preference value
1014  * @param string $default Value to be returned if the $name key is not set in the user preferences
1015  * @param int $otheruserid A moodle user ID
1016  * @uses $USER
1017  * @return string
1018  */
1019 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1020     global $USER, $DB;
1022     if (!isset($USER->preference)) {
1023         reload_user_preferences();
1024     }
1026     if (empty($otheruserid)){
1027         $userid = $USER->id;
1028     } else {
1029         $userid = $otheruserid;
1030     }
1032     if ($userid == $USER->id) {
1033         $preference = $USER->preference;
1035     } else {
1036         $preference = array();
1037         if ($prefdata = $DB->get_records('user_preferences', array('userid'=>$userid))) {
1038             foreach ($prefdata as $pref) {
1039                 $preference[$pref->name] = $pref->value;
1040             }
1041         }
1042     }
1044     if (empty($name)) {
1045         return $preference;            // All values
1047     } else if (array_key_exists($name, $preference)) {
1048         return $preference[$name];    // The single value
1050     } else {
1051         return $default;              // Default value (or NULL)
1052     }
1056 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1058 /**
1059  * Given date parts in user time produce a GMT timestamp.
1060  *
1061  * @param int $year The year part to create timestamp of
1062  * @param int $month The month part to create timestamp of
1063  * @param int $day The day part to create timestamp of
1064  * @param int $hour The hour part to create timestamp of
1065  * @param int $minute The minute part to create timestamp of
1066  * @param int $second The second part to create timestamp of
1067  * @param float $timezone ?
1068  * @param bool $applydst ?
1069  * @return int timestamp
1070  * @todo Finish documenting this function
1071  */
1072 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1074     $strtimezone = NULL;
1075     if (!is_numeric($timezone)) {
1076         $strtimezone = $timezone;
1077     }
1079     $timezone = get_user_timezone_offset($timezone);
1081     if (abs($timezone) > 13) {
1082         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1083     } else {
1084         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1085         $time = usertime($time, $timezone);
1086         if($applydst) {
1087             $time -= dst_offset_on($time, $strtimezone);
1088         }
1089     }
1091     return $time;
1095 /**
1096  * Given an amount of time in seconds, returns string
1097  * formatted nicely as weeks, days, hours etc as needed
1098  *
1099  * @uses MINSECS
1100  * @uses HOURSECS
1101  * @uses DAYSECS
1102  * @uses YEARSECS
1103  * @param int $totalsecs ?
1104  * @param array $str ?
1105  * @return string
1106  */
1107  function format_time($totalsecs, $str=NULL) {
1109     $totalsecs = abs($totalsecs);
1111     if (!$str) {  // Create the str structure the slow way
1112         $str->day   = get_string('day');
1113         $str->days  = get_string('days');
1114         $str->hour  = get_string('hour');
1115         $str->hours = get_string('hours');
1116         $str->min   = get_string('min');
1117         $str->mins  = get_string('mins');
1118         $str->sec   = get_string('sec');
1119         $str->secs  = get_string('secs');
1120         $str->year  = get_string('year');
1121         $str->years = get_string('years');
1122     }
1125     $years     = floor($totalsecs/YEARSECS);
1126     $remainder = $totalsecs - ($years*YEARSECS);
1127     $days      = floor($remainder/DAYSECS);
1128     $remainder = $totalsecs - ($days*DAYSECS);
1129     $hours     = floor($remainder/HOURSECS);
1130     $remainder = $remainder - ($hours*HOURSECS);
1131     $mins      = floor($remainder/MINSECS);
1132     $secs      = $remainder - ($mins*MINSECS);
1134     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1135     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1136     $sh = ($hours == 1) ? $str->hour : $str->hours;
1137     $sd = ($days == 1)  ? $str->day  : $str->days;
1138     $sy = ($years == 1)  ? $str->year  : $str->years;
1140     $oyears = '';
1141     $odays = '';
1142     $ohours = '';
1143     $omins = '';
1144     $osecs = '';
1146     if ($years)  $oyears  = $years .' '. $sy;
1147     if ($days)  $odays  = $days .' '. $sd;
1148     if ($hours) $ohours = $hours .' '. $sh;
1149     if ($mins)  $omins  = $mins .' '. $sm;
1150     if ($secs)  $osecs  = $secs .' '. $ss;
1152     if ($years) return trim($oyears .' '. $odays);
1153     if ($days)  return trim($odays .' '. $ohours);
1154     if ($hours) return trim($ohours .' '. $omins);
1155     if ($mins)  return trim($omins .' '. $osecs);
1156     if ($secs)  return $osecs;
1157     return get_string('now');
1160 /**
1161  * Returns a formatted string that represents a date in user time
1162  * <b>WARNING: note that the format is for strftime(), not date().</b>
1163  * Because of a bug in most Windows time libraries, we can't use
1164  * the nicer %e, so we have to use %d which has leading zeroes.
1165  * A lot of the fuss in the function is just getting rid of these leading
1166  * zeroes as efficiently as possible.
1167  *
1168  * If parameter fixday = true (default), then take off leading
1169  * zero from %d, else mantain it.
1170  *
1171  * @uses HOURSECS
1172  * @param  int $date timestamp in GMT
1173  * @param string $format strftime format
1174  * @param float $timezone
1175  * @param bool $fixday If true (default) then the leading
1176  * zero from %d is removed. If false then the leading zero is mantained.
1177  * @return string
1178  */
1179 function userdate($date, $format='', $timezone=99, $fixday = true) {
1181     global $CFG;
1183     $strtimezone = NULL;
1184     if (!is_numeric($timezone)) {
1185         $strtimezone = $timezone;
1186     }
1188     if (empty($format)) {
1189         $format = get_string('strftimedaydatetime');
1190     }
1192     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1193         $fixday = false;
1194     } else if ($fixday) {
1195         $formatnoday = str_replace('%d', 'DD', $format);
1196         $fixday = ($formatnoday != $format);
1197     }
1199     $date += dst_offset_on($date, $strtimezone);
1201     $timezone = get_user_timezone_offset($timezone);
1203     if (abs($timezone) > 13) {   /// Server time
1204         if ($fixday) {
1205             $datestring = strftime($formatnoday, $date);
1206             $daystring  = str_replace(' 0', '', strftime(' %d', $date));
1207             $datestring = str_replace('DD', $daystring, $datestring);
1208         } else {
1209             $datestring = strftime($format, $date);
1210         }
1211     } else {
1212         $date += (int)($timezone * 3600);
1213         if ($fixday) {
1214             $datestring = gmstrftime($formatnoday, $date);
1215             $daystring  = str_replace(' 0', '', gmstrftime(' %d', $date));
1216             $datestring = str_replace('DD', $daystring, $datestring);
1217         } else {
1218             $datestring = gmstrftime($format, $date);
1219         }
1220     }
1222 /// If we are running under Windows convert from windows encoding to UTF-8
1223 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1225    if ($CFG->ostype == 'WINDOWS') {
1226        if ($localewincharset = get_string('localewincharset')) {
1227            $textlib = textlib_get_instance();
1228            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1229        }
1230    }
1232     return $datestring;
1235 /**
1236  * Given a $time timestamp in GMT (seconds since epoch),
1237  * returns an array that represents the date in user time
1238  *
1239  * @uses HOURSECS
1240  * @param int $time Timestamp in GMT
1241  * @param float $timezone ?
1242  * @return array An array that represents the date in user time
1243  * @todo Finish documenting this function
1244  */
1245 function usergetdate($time, $timezone=99) {
1247     $strtimezone = NULL;
1248     if (!is_numeric($timezone)) {
1249         $strtimezone = $timezone;
1250     }
1252     $timezone = get_user_timezone_offset($timezone);
1254     if (abs($timezone) > 13) {    // Server time
1255         return getdate($time);
1256     }
1258     // There is no gmgetdate so we use gmdate instead
1259     $time += dst_offset_on($time, $strtimezone);
1260     $time += intval((float)$timezone * HOURSECS);
1262     $datestring = gmstrftime('%S_%M_%H_%d_%m_%Y_%w_%j_%A_%B', $time);
1264     list(
1265         $getdate['seconds'],
1266         $getdate['minutes'],
1267         $getdate['hours'],
1268         $getdate['mday'],
1269         $getdate['mon'],
1270         $getdate['year'],
1271         $getdate['wday'],
1272         $getdate['yday'],
1273         $getdate['weekday'],
1274         $getdate['month']
1275     ) = explode('_', $datestring);
1277     return $getdate;
1280 /**
1281  * Given a GMT timestamp (seconds since epoch), offsets it by
1282  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1283  *
1284  * @uses HOURSECS
1285  * @param  int $date Timestamp in GMT
1286  * @param float $timezone
1287  * @return int
1288  */
1289 function usertime($date, $timezone=99) {
1291     $timezone = get_user_timezone_offset($timezone);
1293     if (abs($timezone) > 13) {
1294         return $date;
1295     }
1296     return $date - (int)($timezone * HOURSECS);
1299 /**
1300  * Given a time, return the GMT timestamp of the most recent midnight
1301  * for the current user.
1302  *
1303  * @param int $date Timestamp in GMT
1304  * @param float $timezone ?
1305  * @return ?
1306  */
1307 function usergetmidnight($date, $timezone=99) {
1309     $userdate = usergetdate($date, $timezone);
1311     // Time of midnight of this user's day, in GMT
1312     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1316 /**
1317  * Returns a string that prints the user's timezone
1318  *
1319  * @param float $timezone The user's timezone
1320  * @return string
1321  */
1322 function usertimezone($timezone=99) {
1324     $tz = get_user_timezone($timezone);
1326     if (!is_float($tz)) {
1327         return $tz;
1328     }
1330     if(abs($tz) > 13) { // Server time
1331         return get_string('serverlocaltime');
1332     }
1334     if($tz == intval($tz)) {
1335         // Don't show .0 for whole hours
1336         $tz = intval($tz);
1337     }
1339     if($tz == 0) {
1340         return 'UTC';
1341     }
1342     else if($tz > 0) {
1343         return 'UTC+'.$tz;
1344     }
1345     else {
1346         return 'UTC'.$tz;
1347     }
1351 /**
1352  * Returns a float which represents the user's timezone difference from GMT in hours
1353  * Checks various settings and picks the most dominant of those which have a value
1354  *
1355  * @uses $CFG
1356  * @uses $USER
1357  * @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
1358  * @return int
1359  */
1360 function get_user_timezone_offset($tz = 99) {
1362     global $USER, $CFG;
1364     $tz = get_user_timezone($tz);
1366     if (is_float($tz)) {
1367         return $tz;
1368     } else {
1369         $tzrecord = get_timezone_record($tz);
1370         if (empty($tzrecord)) {
1371             return 99.0;
1372         }
1373         return (float)$tzrecord->gmtoff / HOURMINS;
1374     }
1377 /**
1378  * Returns an int which represents the systems's timezone difference from GMT in seconds
1379  * @param mixed $tz timezone
1380  * @return int if found, false is timezone 99 or error
1381  */
1382 function get_timezone_offset($tz) {
1383     global $CFG;
1385     if ($tz == 99) {
1386         return false;
1387     }
1389     if (is_numeric($tz)) {
1390         return intval($tz * 60*60);
1391     }
1393     if (!$tzrecord = get_timezone_record($tz)) {
1394         return false;
1395     }
1396     return intval($tzrecord->gmtoff * 60);
1399 /**
1400  * Returns a float or a string which denotes the user's timezone
1401  * 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)
1402  * means that for this timezone there are also DST rules to be taken into account
1403  * Checks various settings and picks the most dominant of those which have a value
1404  *
1405  * @uses $USER
1406  * @uses $CFG
1407  * @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
1408  * @return mixed
1409  */
1410 function get_user_timezone($tz = 99) {
1411     global $USER, $CFG;
1413     $timezones = array(
1414         $tz,
1415         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1416         isset($USER->timezone) ? $USER->timezone : 99,
1417         isset($CFG->timezone) ? $CFG->timezone : 99,
1418         );
1420     $tz = 99;
1422     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1423         $tz = $next['value'];
1424     }
1426     return is_numeric($tz) ? (float) $tz : $tz;
1429 /**
1430  * Returns cached timezone record for given $timezonename
1431  *
1432  * @param string $timezonename
1433  * @return mixed timezonerecord object or false
1434  */
1435 function get_timezone_record($timezonename) {
1436     global $CFG, $DB;
1437     static $cache = NULL;
1439     if ($cache === NULL) {
1440         $cache = array();
1441     }
1443     if (isset($cache[$timezonename])) {
1444         return $cache[$timezonename];
1445     }
1447     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1448                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1451 /**
1452  * ?
1453  *
1454  * @uses $CFG
1455  * @uses $USER
1456  * @param ? $fromyear ?
1457  * @param ? $to_year ?
1458  * @return bool
1459  */
1460 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1461     global $CFG, $SESSION, $DB;
1463     $usertz = get_user_timezone($strtimezone);
1465     if (is_float($usertz)) {
1466         // Trivial timezone, no DST
1467         return false;
1468     }
1470     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1471         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1472         unset($SESSION->dst_offsets);
1473         unset($SESSION->dst_range);
1474     }
1476     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1477         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1478         // This will be the return path most of the time, pretty light computationally
1479         return true;
1480     }
1482     // Reaching here means we either need to extend our table or create it from scratch
1484     // Remember which TZ we calculated these changes for
1485     $SESSION->dst_offsettz = $usertz;
1487     if(empty($SESSION->dst_offsets)) {
1488         // If we 're creating from scratch, put the two guard elements in there
1489         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1490     }
1491     if(empty($SESSION->dst_range)) {
1492         // If creating from scratch
1493         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1494         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1496         // Fill in the array with the extra years we need to process
1497         $yearstoprocess = array();
1498         for($i = $from; $i <= $to; ++$i) {
1499             $yearstoprocess[] = $i;
1500         }
1502         // Take note of which years we have processed for future calls
1503         $SESSION->dst_range = array($from, $to);
1504     }
1505     else {
1506         // If needing to extend the table, do the same
1507         $yearstoprocess = array();
1509         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1510         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1512         if($from < $SESSION->dst_range[0]) {
1513             // Take note of which years we need to process and then note that we have processed them for future calls
1514             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1515                 $yearstoprocess[] = $i;
1516             }
1517             $SESSION->dst_range[0] = $from;
1518         }
1519         if($to > $SESSION->dst_range[1]) {
1520             // Take note of which years we need to process and then note that we have processed them for future calls
1521             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1522                 $yearstoprocess[] = $i;
1523             }
1524             $SESSION->dst_range[1] = $to;
1525         }
1526     }
1528     if(empty($yearstoprocess)) {
1529         // This means that there was a call requesting a SMALLER range than we have already calculated
1530         return true;
1531     }
1533     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1534     // Also, the array is sorted in descending timestamp order!
1536     // Get DB data
1538     static $presets_cache = array();
1539     if (!isset($presets_cache[$usertz])) {
1540         $presets_cache[$usertz] = $DB->get_records('timezone', array('name'=>$usertz), 'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, std_startday, std_weekday, std_skipweeks, std_time');
1541     }
1542     if(empty($presets_cache[$usertz])) {
1543         return false;
1544     }
1546     // Remove ending guard (first element of the array)
1547     reset($SESSION->dst_offsets);
1548     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1550     // Add all required change timestamps
1551     foreach($yearstoprocess as $y) {
1552         // Find the record which is in effect for the year $y
1553         foreach($presets_cache[$usertz] as $year => $preset) {
1554             if($year <= $y) {
1555                 break;
1556             }
1557         }
1559         $changes = dst_changes_for_year($y, $preset);
1561         if($changes === NULL) {
1562             continue;
1563         }
1564         if($changes['dst'] != 0) {
1565             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1566         }
1567         if($changes['std'] != 0) {
1568             $SESSION->dst_offsets[$changes['std']] = 0;
1569         }
1570     }
1572     // Put in a guard element at the top
1573     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1574     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1576     // Sort again
1577     krsort($SESSION->dst_offsets);
1579     return true;
1582 function dst_changes_for_year($year, $timezone) {
1584     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1585         return NULL;
1586     }
1588     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1589     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1591     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1592     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1594     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1595     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1597     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1598     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1599     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1601     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1602     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1604     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1607 // $time must NOT be compensated at all, it has to be a pure timestamp
1608 function dst_offset_on($time, $strtimezone = NULL) {
1609     global $SESSION;
1611     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
1612         return 0;
1613     }
1615     reset($SESSION->dst_offsets);
1616     while(list($from, $offset) = each($SESSION->dst_offsets)) {
1617         if($from <= $time) {
1618             break;
1619         }
1620     }
1622     // This is the normal return path
1623     if($offset !== NULL) {
1624         return $offset;
1625     }
1627     // Reaching this point means we haven't calculated far enough, do it now:
1628     // Calculate extra DST changes if needed and recurse. The recursion always
1629     // moves toward the stopping condition, so will always end.
1631     if($from == 0) {
1632         // We need a year smaller than $SESSION->dst_range[0]
1633         if($SESSION->dst_range[0] == 1971) {
1634             return 0;
1635         }
1636         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
1637         return dst_offset_on($time, $strtimezone);
1638     }
1639     else {
1640         // We need a year larger than $SESSION->dst_range[1]
1641         if($SESSION->dst_range[1] == 2035) {
1642             return 0;
1643         }
1644         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
1645         return dst_offset_on($time, $strtimezone);
1646     }
1649 function find_day_in_month($startday, $weekday, $month, $year) {
1651     $daysinmonth = days_in_month($month, $year);
1653     if($weekday == -1) {
1654         // Don't care about weekday, so return:
1655         //    abs($startday) if $startday != -1
1656         //    $daysinmonth otherwise
1657         return ($startday == -1) ? $daysinmonth : abs($startday);
1658     }
1660     // From now on we 're looking for a specific weekday
1662     // Give "end of month" its actual value, since we know it
1663     if($startday == -1) {
1664         $startday = -1 * $daysinmonth;
1665     }
1667     // Starting from day $startday, the sign is the direction
1669     if($startday < 1) {
1671         $startday = abs($startday);
1672         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1674         // This is the last such weekday of the month
1675         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
1676         if($lastinmonth > $daysinmonth) {
1677             $lastinmonth -= 7;
1678         }
1680         // Find the first such weekday <= $startday
1681         while($lastinmonth > $startday) {
1682             $lastinmonth -= 7;
1683         }
1685         return $lastinmonth;
1687     }
1688     else {
1690         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
1692         $diff = $weekday - $indexweekday;
1693         if($diff < 0) {
1694             $diff += 7;
1695         }
1697         // This is the first such weekday of the month equal to or after $startday
1698         $firstfromindex = $startday + $diff;
1700         return $firstfromindex;
1702     }
1705 /**
1706  * Calculate the number of days in a given month
1707  *
1708  * @param int $month The month whose day count is sought
1709  * @param int $year The year of the month whose day count is sought
1710  * @return int
1711  */
1712 function days_in_month($month, $year) {
1713    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
1716 /**
1717  * Calculate the position in the week of a specific calendar day
1718  *
1719  * @param int $day The day of the date whose position in the week is sought
1720  * @param int $month The month of the date whose position in the week is sought
1721  * @param int $year The year of the date whose position in the week is sought
1722  * @return int
1723  */
1724 function dayofweek($day, $month, $year) {
1725     // I wonder if this is any different from
1726     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1727     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
1730 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
1732 /**
1733  * Makes sure that $USER->sesskey exists, if $USER itself exists. It sets a new sesskey
1734  * if one does not already exist, but does not overwrite existing sesskeys. Returns the
1735  * sesskey string if $USER exists, or boolean false if not.
1736  *
1737  * @uses $USER
1738  * @return string
1739  */
1740 function sesskey() {
1741     global $USER;
1743     if(!isset($USER)) {
1744         return false;
1745     }
1747     if (empty($USER->sesskey)) {
1748         $USER->sesskey = random_string(10);
1749     }
1751     return $USER->sesskey;
1755 /**
1756  * For security purposes, this function will check that the currently
1757  * given sesskey (passed as a parameter to the script or this function)
1758  * matches that of the current user.
1759  *
1760  * @param string $sesskey optionally provided sesskey
1761  * @return bool
1762  */
1763 function confirm_sesskey($sesskey=NULL) {
1764     global $USER;
1766     if (!empty($USER->ignoresesskey) || !empty($CFG->ignoresesskey)) {
1767         return true;
1768     }
1770     if (empty($sesskey)) {
1771         $sesskey = required_param('sesskey', PARAM_RAW);  // Check script parameters
1772     }
1774     if (!isset($USER->sesskey)) {
1775         return false;
1776     }
1778     return ($USER->sesskey === $sesskey);
1781 /**
1782  * Setup all global $CFG course variables, set locale and also themes
1783  * This function can be used on pages that do not require login instead of require_login()
1784  *
1785  * @param mixed $courseorid id of the course or course object
1786  */
1787 function course_setup($courseorid=0) {
1788     global $COURSE, $SITE, $DB;
1790 /// Redefine global $COURSE if needed
1791     if (empty($courseorid)) {
1792         // no change in global $COURSE - for backwards compatibiltiy
1793         // if require_rogin() used after require_login($courseid);
1794     } else if (is_object($courseorid)) {
1795         $COURSE = clone($courseorid);
1796     } else {
1797         global $course; // used here only to prevent repeated fetching from DB - may be removed later
1798         if ($courseorid == SITEID) {
1799             $COURSE = clone($SITE);
1800         } else if (!empty($course->id) and $course->id == $courseorid) {
1801             $COURSE = clone($course);
1802         } else {
1803             if (!$COURSE = $DB->get_record('course', array('id'=>$courseorid))) {
1804                 print_error('invalidcourseid');
1805             }
1806         }
1807     }
1809 /// set locale and themes
1810     moodle_setlocale();
1811     theme_setup();
1815 /**
1816  * This function checks that the current user is logged in and has the
1817  * required privileges
1818  *
1819  * This function checks that the current user is logged in, and optionally
1820  * whether they are allowed to be in a particular course and view a particular
1821  * course module.
1822  * If they are not logged in, then it redirects them to the site login unless
1823  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
1824  * case they are automatically logged in as guests.
1825  * If $courseid is given and the user is not enrolled in that course then the
1826  * user is redirected to the course enrolment page.
1827  * If $cm is given and the coursemodule is hidden and the user is not a teacher
1828  * in the course then the user is redirected to the course home page.
1829  *
1830  * @uses $CFG
1831  * @uses $SESSION
1832  * @uses $USER
1833  * @uses $FULLME
1834  * @uses SITEID
1835  * @uses $COURSE
1836  * @param mixed $courseorid id of the course or course object
1837  * @param bool $autologinguest
1838  * @param object $cm course module object
1839  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
1840  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
1841  *             in order to keep redirects working properly. MDL-14495
1842  */
1843 function require_login($courseorid=0, $autologinguest=true, $cm=null, $setwantsurltome=true) {
1844     global $CFG, $SESSION, $USER, $COURSE, $FULLME;
1846 /// setup global $COURSE, themes, language and locale
1847     course_setup($courseorid);
1849 /// If the user is not even logged in yet then make sure they are
1850     if (!isloggedin()) {
1851         //NOTE: $USER->site check was obsoleted by session test cookie,
1852         //      $USER->confirmed test is in login/index.php
1853         if ($setwantsurltome) {
1854             $SESSION->wantsurl = $FULLME;
1855         }
1856         if (!empty($_SERVER['HTTP_REFERER'])) {
1857             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
1858         }
1859         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests) and ($COURSE->id == SITEID or $COURSE->guest) ) {
1860             $loginguest = '?loginguest=true';
1861         } else {
1862             $loginguest = '';
1863         }
1864         if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
1865             redirect($CFG->wwwroot .'/login/index.php'. $loginguest);
1866         } else {
1867             $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1868             redirect($wwwroot .'/login/index.php');
1869         }
1870         exit;
1871     }
1873 /// loginas as redirection if needed
1874     if ($COURSE->id != SITEID and !empty($USER->realuser)) {
1875         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
1876             if ($USER->loginascontext->instanceid != $COURSE->id) {
1877                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
1878             }
1879         }
1880     }
1882 /// check whether the user should be changing password (but only if it is REALLY them)
1883     if (get_user_preferences('auth_forcepasswordchange') && empty($USER->realuser)) {
1884         $userauth = get_auth_plugin($USER->auth);
1885         if ($userauth->can_change_password()) {
1886             $SESSION->wantsurl = $FULLME;
1887             if ($changeurl = $userauth->change_password_url()) {
1888                 //use plugin custom url
1889                 redirect($changeurl);
1890             } else {
1891                 //use moodle internal method
1892                 if (empty($CFG->loginhttps)) {
1893                     redirect($CFG->wwwroot .'/login/change_password.php');
1894                 } else {
1895                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1896                     redirect($wwwroot .'/login/change_password.php');
1897                 }
1898             }
1899         } else {
1900             print_error('nopasswordchangeforced', 'auth');
1901         }
1902     }
1904 /// Check that the user account is properly set up
1905     if (user_not_fully_set_up($USER)) {
1906         $SESSION->wantsurl = $FULLME;
1907         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
1908     }
1910 /// Make sure current IP matches the one for this session (if required)
1911     if (!empty($CFG->tracksessionip)) {
1912         if ($USER->sessionIP != md5(getremoteaddr())) {
1913             print_error('sessionipnomatch', 'error');
1914         }
1915     }
1917 /// Make sure the USER has a sesskey set up.  Used for checking script parameters.
1918     sesskey();
1920     // Check that the user has agreed to a site policy if there is one
1921     if (!empty($CFG->sitepolicy)) {
1922         if (!$USER->policyagreed) {
1923             $SESSION->wantsurl = $FULLME;
1924             redirect($CFG->wwwroot .'/user/policy.php');
1925         }
1926     }
1928     // Fetch the system context, we are going to use it a lot.
1929     $sysctx = get_context_instance(CONTEXT_SYSTEM);
1931 /// If the site is currently under maintenance, then print a message
1932     if (!has_capability('moodle/site:config', $sysctx)) {
1933         if (file_exists($CFG->dataroot.'/'.SITEID.'/maintenance.html')) {
1934             print_maintenance_message();
1935             exit;
1936         }
1937     }
1939 /// groupmembersonly access control
1940     if (!empty($CFG->enablegroupings) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
1941         if (isguestuser() or !groups_has_membership($cm)) {
1942             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
1943         }
1944     }
1946     // Fetch the course context, and prefetch its child contexts
1947     if (!isset($COURSE->context)) {
1948         if ( ! $COURSE->context = get_context_instance(CONTEXT_COURSE, $COURSE->id) ) {
1949             print_error('nocontext');
1950         }
1951     }
1952     if ($COURSE->id == SITEID) {
1953         /// Eliminate hidden site activities straight away
1954         if (!empty($cm) && !$cm->visible
1955             && !has_capability('moodle/course:viewhiddenactivities', $COURSE->context)) {
1956             redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
1957         }
1958         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
1959         return;
1961     } else {
1963         /// Check if the user can be in a particular course
1964         if (empty($USER->access['rsw'][$COURSE->context->path])) {
1965             //
1966             // MDL-13900 - If the course or the parent category are hidden
1967             // and the user hasn't the 'course:viewhiddencourses' capability, prevent access
1968             //
1969             if ( !($COURSE->visible && course_parent_visible($COURSE)) &&
1970                    !has_capability('moodle/course:viewhiddencourses', $COURSE->context)) {
1971                 print_header_simple();
1972                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
1973             }
1974         }
1976     /// Non-guests who don't currently have access, check if they can be allowed in as a guest
1978         if ($USER->username != 'guest' and !has_capability('moodle/course:view', $COURSE->context)) {
1979             if ($COURSE->guest == 1) {
1980                  // Temporarily assign them guest role for this context, if it fails later user is asked to enrol
1981                  $USER->access = load_temp_role($COURSE->context, $CFG->guestroleid, $USER->access);
1982             }
1983         }
1985     /// If the user is a guest then treat them according to the course policy about guests
1987         if (has_capability('moodle/legacy:guest', $COURSE->context, NULL, false)) {
1988             if (has_capability('moodle/site:doanything', $sysctx)) {
1989                 // administrators must be able to access any course - even if somebody gives them guest access
1990                 user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
1991                 return;
1992             }
1994             switch ($COURSE->guest) {    /// Check course policy about guest access
1996                 case 1:    /// Guests always allowed
1997                     if (!has_capability('moodle/course:view', $COURSE->context)) {    // Prohibited by capability
1998                         print_header_simple();
1999                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), "$CFG->wwwroot/login/index.php");
2000                     }
2001                     if (!empty($cm) and !$cm->visible) { // Not allowed to see module, send to course page
2002                         redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course,
2003                                  get_string('activityiscurrentlyhidden'));
2004                     }
2006                     user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2007                     return;   // User is allowed to see this course
2009                     break;
2011                 case 2:    /// Guests allowed with key
2012                     if (!empty($USER->enrolkey[$COURSE->id])) {   // Set by enrol/manual/enrol.php
2013                         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2014                         return true;
2015                     }
2016                     //  otherwise drop through to logic below (--> enrol.php)
2017                     break;
2019                 default:    /// Guests not allowed
2020                     $strloggedinasguest = get_string('loggedinasguest');
2021                     print_header_simple('', '',
2022                             build_navigation(array(array('name' => $strloggedinasguest, 'link' => null, 'type' => 'misc'))));
2023                     if (empty($USER->access['rsw'][$COURSE->context->path])) {  // Normal guest
2024                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), "$CFG->wwwroot/login/index.php");
2025                     } else {
2026                         notify(get_string('guestsnotallowed', '', format_string($COURSE->fullname)));
2027                         echo '<div class="notifyproblem">'.switchroles_form($COURSE->id).'</div>';
2028                         print_footer($COURSE);
2029                         exit;
2030                     }
2031                     break;
2032             }
2034     /// For non-guests, check if they have course view access
2036         } else if (has_capability('moodle/course:view', $COURSE->context)) {
2037             if (!empty($USER->realuser)) {   // Make sure the REAL person can also access this course
2038                 if (!has_capability('moodle/course:view', $COURSE->context, $USER->realuser)) {
2039                     print_header_simple();
2040                     notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2041                 }
2042             }
2044         /// Make sure they can read this activity too, if specified
2046             if (!empty($cm) and !$cm->visible and !has_capability('moodle/course:viewhiddenactivities', $COURSE->context)) {
2047                 redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course, get_string('activityiscurrentlyhidden'));
2048             }
2049             user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2050             return;   // User is allowed to see this course
2052         }
2055     /// Currently not enrolled in the course, so see if they want to enrol
2056         $SESSION->wantsurl = $FULLME;
2057         redirect($CFG->wwwroot .'/course/enrol.php?id='. $COURSE->id);
2058         die;
2059     }
2064 /**
2065  * This function just makes sure a user is logged out.
2066  *
2067  * @uses $CFG
2068  * @uses $USER
2069  */
2070 function require_logout() {
2072     global $USER, $CFG, $SESSION;
2074     if (isloggedin()) {
2075         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2077         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2078         foreach($authsequence as $authname) {
2079             $authplugin = get_auth_plugin($authname);
2080             $authplugin->prelogout_hook();
2081         }
2082     }
2084     // Initialize variable to pass-by-reference to headers_sent(&$file, &$line)
2085     $file = $line = null;
2086     if (headers_sent($file, $line)) {
2087         error_log('MoodleSessionTest cookie could not be set in moodlelib.php:'.__LINE__);
2088         error_log('Headers were already sent in file: '.$file.' on line '.$line);
2089     } else {
2090         setcookie('MoodleSessionTest'.$CFG->sessioncookie, '', time() - 3600, $CFG->sessioncookiepath, '', $CFG->cookiesecure, $CFG->cookiehttponly);
2091     }
2093     unset($_SESSION['USER']);
2094     unset($_SESSION['SESSION']);
2096     unset($SESSION);
2097     unset($USER);
2101 /**
2102  * This is a weaker version of {@link require_login()} which only requires login
2103  * when called from within a course rather than the site page, unless
2104  * the forcelogin option is turned on.
2105  *
2106  * @uses $CFG
2107  * @param mixed $courseorid The course object or id in question
2108  * @param bool $autologinguest Allow autologin guests if that is wanted
2109  * @param object $cm Course activity module if known
2110  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2111  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2112  *             in order to keep redirects working properly. MDL-14495
2113  */
2114 function require_course_login($courseorid, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2115     global $CFG;
2116     if (!empty($CFG->forcelogin)) {
2117         // login required for both SITE and courses
2118         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2120     } else if (!empty($cm) and !$cm->visible) {
2121         // always login for hidden activities
2122         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2124     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2125           or (!is_object($courseorid) and $courseorid == SITEID)) {
2126         //login for SITE not required
2127         user_accesstime_log(SITEID);
2128         return;
2130     } else {
2131         // course login always required
2132         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2133     }
2136 /**
2137  * Require key login. Function terminates with error if key not found or incorrect.
2138  * @param string $script unique script identifier
2139  * @param int $instance optional instance id
2140  */
2141 function require_user_key_login($script, $instance=null) {
2142     global $nomoodlecookie, $USER, $SESSION, $CFG, $DB;
2144     if (empty($nomoodlecookie)) {
2145         print_error('sessioncookiesdisable');
2146     }
2148 /// extra safety
2149     @session_write_close();
2151     $keyvalue = required_param('key', PARAM_ALPHANUM);
2153     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2154         print_error('invalidkey');
2155     }
2157     if (!empty($key->validuntil) and $key->validuntil < time()) {
2158         print_error('expiredkey');
2159     }
2161     if ($key->iprestriction) {
2162         $remoteaddr = getremoteaddr();
2163         if ($remoteaddr == '' or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2164             print_error('ipmismatch');
2165         }
2166     }
2168     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2169         print_error('invaliduserid');
2170     }
2172 /// emulate normal session
2173     $SESSION = new object();
2174     $USER    = $user;
2176 /// note we are not using normal login
2177     if (!defined('USER_KEY_LOGIN')) {
2178         define('USER_KEY_LOGIN', true);
2179     }
2181     load_all_capabilities();
2183 /// return isntance id - it might be empty
2184     return $key->instance;
2187 /**
2188  * Creates a new private user access key.
2189  * @param string $script unique target identifier
2190  * @param int $userid
2191  * @param instance $int optional instance id
2192  * @param string $iprestriction optional ip restricted access
2193  * @param timestamp $validuntil key valid only until given data
2194  * @return string access key value
2195  */
2196 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2197     global $DB;
2199     $key = new object();
2200     $key->script        = $script;
2201     $key->userid        = $userid;
2202     $key->instance      = $instance;
2203     $key->iprestriction = $iprestriction;
2204     $key->validuntil    = $validuntil;
2205     $key->timecreated   = time();
2207     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2208     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2209         // must be unique
2210         $key->value     = md5($userid.'_'.time().random_string(40));
2211     }
2213     if (!$DB->insert_record('user_private_key', $key)) {
2214         print_error('cannotinsertkey');
2215     }
2217     return $key->value;
2220 /**
2221  * Modify the user table by setting the currently logged in user's
2222  * last login to now.
2223  *
2224  * @uses $USER
2225  * @return bool
2226  */
2227 function update_user_login_times() {
2228     global $USER, $DB;
2230     $user = new object();
2231     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2232     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2234     $user->id = $USER->id;
2236     return $DB->update_record('user', $user);
2239 /**
2240  * Determines if a user has completed setting up their account.
2241  *
2242  * @param user $user A {@link $USER} object to test for the existance of a valid name and email
2243  * @return bool
2244  */
2245 function user_not_fully_set_up($user) {
2246     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2249 function over_bounce_threshold($user) {
2250     global $CFG, $DB;
2252     if (empty($CFG->handlebounces)) {
2253         return false;
2254     }
2255     // set sensible defaults
2256     if (empty($CFG->minbounces)) {
2257         $CFG->minbounces = 10;
2258     }
2259     if (empty($CFG->bounceratio)) {
2260         $CFG->bounceratio = .20;
2261     }
2262     $bouncecount = 0;
2263     $sendcount = 0;
2264     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2265         $bouncecount = $bounce->value;
2266     }
2267     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2268         $sendcount = $send->value;
2269     }
2270     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2273 /**
2274  * @param $user - object containing an id
2275  * @param $reset - will reset the count to 0
2276  */
2277 function set_send_count($user,$reset=false) {
2278     global $DB;
2280     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2281         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2282         $DB->update_record('user_preferences', $pref);
2283     }
2284     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2285         // make a new one
2286         $pref = new object();
2287         $pref->name   = 'email_send_count';
2288         $pref->value  = 1;
2289         $pref->userid = $user->id;
2290         $DB->insert_record('user_preferences', $pref, false);
2291     }
2294 /**
2295 * @param $user - object containing an id
2296  * @param $reset - will reset the count to 0
2297  */
2298 function set_bounce_count($user,$reset=false) {
2299     global $DB;
2301     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2302         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2303         $DB->update_record('user_preferences', $pref);
2304     }
2305     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2306         // make a new one
2307         $pref = new object();
2308         $pref->name   = 'email_bounce_count';
2309         $pref->value  = 1;
2310         $pref->userid = $user->id;
2311         $DB->insert_record('user_preferences', $pref, false);
2312     }
2315 /**
2316  * Keeps track of login attempts
2317  *
2318  * @uses $SESSION
2319  */
2320 function update_login_count() {
2321     global $SESSION;
2323     $max_logins = 10;
2325     if (empty($SESSION->logincount)) {
2326         $SESSION->logincount = 1;
2327     } else {
2328         $SESSION->logincount++;
2329     }
2331     if ($SESSION->logincount > $max_logins) {
2332         unset($SESSION->wantsurl);
2333         print_error('errortoomanylogins');
2334     }
2337 /**
2338  * Resets login attempts
2339  *
2340  * @uses $SESSION
2341  */
2342 function reset_login_count() {
2343     global $SESSION;
2345     $SESSION->logincount = 0;
2348 function sync_metacourses() {
2349     global $DB;
2351     if (!$courses = $DB->get_records('course', array('metacourse'=>1))) {
2352         return;
2353     }
2355     foreach ($courses as $course) {
2356         sync_metacourse($course);
2357     }
2360 /**
2361  * Goes through all enrolment records for the courses inside the metacourse and sync with them.
2362  *
2363  * @param mixed $course the metacourse to synch. Either the course object itself, or the courseid.
2364  */
2365 function sync_metacourse($course) {
2366     global $CFG, $DB;
2368     // Check the course is valid.
2369     if (!is_object($course)) {
2370         if (!$course = $DB->get_record('course', array('id'=>$course))) {
2371             return false; // invalid course id
2372         }
2373     }
2375     // Check that we actually have a metacourse.
2376     if (empty($course->metacourse)) {
2377         return false;
2378     }
2380     // Get a list of roles that should not be synced.
2381     if (!empty($CFG->nonmetacoursesyncroleids)) {
2382         $roleexclusions = 'ra.roleid NOT IN (' . $CFG->nonmetacoursesyncroleids . ') AND';
2383     } else {
2384         $roleexclusions = '';
2385     }
2387     // Get the context of the metacourse.
2388     $context = get_context_instance(CONTEXT_COURSE, $course->id); // SITEID can not be a metacourse
2390     // We do not ever want to unassign the list of metacourse manager, so get a list of them.
2391     if ($users = get_users_by_capability($context, 'moodle/course:managemetacourse')) {
2392         $managers = array_keys($users);
2393     } else {
2394         $managers = array();
2395     }
2397     // Get assignments of a user to a role that exist in a child course, but
2398     // not in the meta coure. That is, get a list of the assignments that need to be made.
2399     if (!$assignments = $DB->get_records_sql("
2400             SELECT ra.id, ra.roleid, ra.userid
2401               FROM {role_assignments} ra, {context} con, {course_meta} cm
2402              WHERE ra.contextid = con.id AND
2403                    con.contextlevel = ".CONTEXT_COURSE." AND
2404                    con.instanceid = cm.child_course AND
2405                    cm.parent_course = ? AND
2406                    $roleexclusions
2407                    NOT EXISTS (
2408                      SELECT 1
2409                        FROM {role_assignments} ra2
2410                       WHERE ra2.userid = ra.userid AND
2411                             ra2.roleid = ra.roleid AND
2412                             ra2.contextid = ?
2413                   )", array($course->id, $context->id))) {
2414         $assignments = array();
2415     }
2417     // Get assignments of a user to a role that exist in the meta course, but
2418     // not in any child courses. That is, get a list of the unassignments that need to be made.
2419     if (!$unassignments = $DB->get_records_sql("
2420             SELECT ra.id, ra.roleid, ra.userid
2421               FROM {role_assignments} ra
2422              WHERE ra.contextid = ? AND
2423                    $roleexclusions
2424                    NOT EXISTS (
2425                     SELECT 1
2426                       FROM {role_assignments} ra2, {context} con2, {course_meta} cm
2427                     WHERE ra2.userid = ra.userid AND
2428                           ra2.roleid = ra.roleid AND
2429                           ra2.contextid = con2.id AND
2430                           con2.contextlevel = " . CONTEXT_COURSE . " AND
2431                           con2.instanceid = cm.child_course AND
2432                           cm.parent_course = ?
2433                   )", array($context->id, $course->id))) {
2434         $unassignments = array();
2435     }
2437     $success = true;
2439     // Make the unassignments, if they are not managers.
2440     foreach ($unassignments as $unassignment) {
2441         if (!in_array($unassignment->userid, $managers)) {
2442             $success = role_unassign($unassignment->roleid, $unassignment->userid, 0, $context->id) && $success;
2443         }
2444     }
2446     // Make the assignments.
2447     foreach ($assignments as $assignment) {
2448         $success = role_assign($assignment->roleid, $assignment->userid, 0, $context->id) && $success;
2449     }
2451     return $success;
2453 // TODO: finish timeend and timestart
2454 // maybe we could rely on cron job to do the cleaning from time to time
2457 /**
2458  * Adds a record to the metacourse table and calls sync_metacoures
2459  */
2460 function add_to_metacourse ($metacourseid, $courseid) {
2461     global $DB;
2463     if (!$metacourse = $DB->get_record("course", array("id"=>$metacourseid))) {
2464         return false;
2465     }
2467     if (!$course = $DB->get_record("course", array("id"=>$courseid))) {
2468         return false;
2469     }
2471     if (!$record = $DB->get_record("course_meta", array("parent_course"=>$metacourseid, "child_course"=>$courseid))) {
2472         $rec = new object();
2473         $rec->parent_course = $metacourseid;
2474         $rec->child_course  = $courseid;
2475         if (!$DB->insert_record('course_meta', $rec)) {
2476             return false;
2477         }
2478         return sync_metacourse($metacourseid);
2479     }
2480     return true;
2484 /**
2485  * Removes the record from the metacourse table and calls sync_metacourse
2486  */
2487 function remove_from_metacourse($metacourseid, $courseid) {
2488     global $DB;
2490     if ($DB->delete_records('course_meta', array('parent_course'=>$metacourseid, 'child_course'=>$courseid))) {
2491         return sync_metacourse($metacourseid);
2492     }
2493     return false;
2497 /**
2498  * Determines if a user is currently logged in
2499  *
2500  * @uses $USER
2501  * @return bool
2502  */
2503 function isloggedin() {
2504     global $USER;
2506     return (!empty($USER->id));
2509 /**
2510  * Determines if a user is logged in as real guest user with username 'guest'.
2511  * This function is similar to original isguest() in 1.6 and earlier.
2512  * Current isguest() is deprecated - do not use it anymore.
2513  *
2514  * @param $user mixed user object or id, $USER if not specified
2515  * @return bool true if user is the real guest user, false if not logged in or other user
2516  */
2517 function isguestuser($user=NULL) {
2518     global $USER, $DB;
2520     if ($user === NULL) {
2521         $user = $USER;
2522     } else if (is_numeric($user)) {
2523         $user = $DB->get_record('user', array('id'=>$user), 'id, username');
2524     }
2526     if (empty($user->id)) {
2527         return false; // not logged in, can not be guest
2528     }
2530     return ($user->username == 'guest');
2533 /**
2534  * Determines if the currently logged in user is in editing mode.
2535  * Note: originally this function had $userid parameter - it was not usable anyway
2536  *
2537  * @uses $USER, $PAGE
2538  * @return bool
2539  */
2540 function isediting() {
2541     global $USER, $PAGE;
2543     if (empty($USER->editing)) {
2544         return false;
2545     } elseif (is_object($PAGE) && method_exists($PAGE,'user_allowed_editing')) {
2546         return $PAGE->user_allowed_editing();
2547     }
2548     return true;//false;
2551 /**
2552  * Determines if the logged in user is currently moving an activity
2553  *
2554  * @uses $USER
2555  * @param int $courseid The id of the course being tested
2556  * @return bool
2557  */
2558 function ismoving($courseid) {
2559     global $USER;
2561     if (!empty($USER->activitycopy)) {
2562         return ($USER->activitycopycourse == $courseid);
2563     }
2564     return false;
2567 /**
2568  * Given an object containing firstname and lastname
2569  * values, this function returns a string with the
2570  * full name of the person.
2571  * The result may depend on system settings
2572  * or language.  'override' will force both names
2573  * to be used even if system settings specify one.
2574  *
2575  * @uses $CFG
2576  * @uses $SESSION
2577  * @param object $user A {@link $USER} object to get full name of
2578  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
2579  */
2580 function fullname($user, $override=false) {
2581     global $CFG, $SESSION;
2583     if (!isset($user->firstname) and !isset($user->lastname)) {
2584         return '';
2585     }
2587     if (!$override) {
2588         if (!empty($CFG->forcefirstname)) {
2589             $user->firstname = $CFG->forcefirstname;
2590         }
2591         if (!empty($CFG->forcelastname)) {
2592             $user->lastname = $CFG->forcelastname;
2593         }
2594     }
2596     if (!empty($SESSION->fullnamedisplay)) {
2597         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
2598     }
2600     if ($CFG->fullnamedisplay == 'firstname lastname') {
2601         return $user->firstname .' '. $user->lastname;
2603     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
2604         return $user->lastname .' '. $user->firstname;
2606     } else if ($CFG->fullnamedisplay == 'firstname') {
2607         if ($override) {
2608             return get_string('fullnamedisplay', '', $user);
2609         } else {
2610             return $user->firstname;
2611         }
2612     }
2614     return get_string('fullnamedisplay', '', $user);
2617 /**
2618  * Sets a moodle cookie with an encrypted string
2619  *
2620  * @uses $CFG
2621  * @uses DAYSECS
2622  * @uses HOURSECS
2623  * @param string $thing The string to encrypt and place in a cookie
2624  */
2625 function set_moodle_cookie($thing) {
2626     global $CFG;
2628     if ($thing == 'guest') {  // Ignore guest account
2629         return;
2630     }
2632     $cookiename = 'MOODLEID_'.$CFG->sessioncookie;
2634     $days = 60;
2635     $seconds = DAYSECS*$days;
2637     // no need to set secure or http cookie only here - it is not secret
2638     setCookie($cookiename, '', time() - HOURSECS, $CFG->sessioncookiepath);
2639     setCookie($cookiename, rc4encrypt($thing), time()+$seconds, $CFG->sessioncookiepath);
2642 /**
2643  * Gets a moodle cookie with an encrypted string
2644  *
2645  * @uses $CFG
2646  * @return string
2647  */
2648 function get_moodle_cookie() {
2649     global $CFG;
2651     $cookiename = 'MOODLEID_'.$CFG->sessioncookie;
2653     if (empty($_COOKIE[$cookiename])) {
2654         return '';
2655     } else {
2656         $thing = rc4decrypt($_COOKIE[$cookiename]);
2657         return ($thing == 'guest') ? '': $thing;  // Ignore guest account
2658     }
2661 /**
2662  * Returns whether a given authentication plugin exists.
2663  *
2664  * @uses $CFG
2665  * @param string $auth Form of authentication to check for. Defaults to the
2666  *        global setting in {@link $CFG}.
2667  * @return boolean Whether the plugin is available.
2668  */
2669 function exists_auth_plugin($auth) {
2670     global $CFG;
2672     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
2673         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
2674     }
2675     return false;
2678 /**
2679  * Checks if a given plugin is in the list of enabled authentication plugins.
2680  *
2681  * @param string $auth Authentication plugin.
2682  * @return boolean Whether the plugin is enabled.
2683  */
2684 function is_enabled_auth($auth) {
2685     if (empty($auth)) {
2686         return false;
2687     }
2689     $enabled = get_enabled_auth_plugins();
2691     return in_array($auth, $enabled);
2694 /**
2695  * Returns an authentication plugin instance.
2696  *
2697  * @uses $CFG
2698  * @param string $auth name of authentication plugin
2699  * @return object An instance of the required authentication plugin.
2700  */
2701 function get_auth_plugin($auth) {
2702     global $CFG;
2704     // check the plugin exists first
2705     if (! exists_auth_plugin($auth)) {
2706         print_error('authpluginnotfound', 'debug', '', $auth);
2707     }
2709     // return auth plugin instance
2710     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
2711     $class = "auth_plugin_$auth";
2712     return new $class;
2715 /**
2716  * Returns array of active auth plugins.
2717  *
2718  * @param bool $fix fix $CFG->auth if needed
2719  * @return array
2720  */
2721 function get_enabled_auth_plugins($fix=false) {
2722     global $CFG;
2724     $default = array('manual', 'nologin');
2726     if (empty($CFG->auth)) {
2727         $auths = array();
2728     } else {
2729         $auths = explode(',', $CFG->auth);
2730     }
2732     if ($fix) {
2733         $auths = array_unique($auths);
2734         foreach($auths as $k=>$authname) {
2735             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
2736                 unset($auths[$k]);
2737             }
2738         }
2739         $newconfig = implode(',', $auths);
2740         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
2741             set_config('auth', $newconfig);
2742         }
2743     }
2745     return (array_merge($default, $auths));
2748 /**
2749  * Returns true if an internal authentication method is being used.
2750  * if method not specified then, global default is assumed
2751  *
2752  * @uses $CFG
2753  * @param string $auth Form of authentication required
2754  * @return bool
2755  */
2756 function is_internal_auth($auth) {
2757     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
2758     return $authplugin->is_internal();
2761 /**
2762  * Returns an array of user fields
2763  *
2764  * @return array User field/column names
2765  */
2766 function get_user_fieldnames() {
2767     global $DB;
2769     $fieldarray = $DB->get_columns('user');
2770     unset($fieldarray['id']);
2771     $fieldarray = array_keys($fieldarray);
2773     return $fieldarray;
2776 /**
2777  * Creates the default "guest" user. Used both from
2778  * admin/index.php and login/index.php
2779  * @return mixed user object created or boolean false if the creation has failed
2780  */
2781 function create_guest_record() {
2782     global $CFG, $DB;
2784     $guest = new object();
2785     $guest->auth        = 'manual';
2786     $guest->username    = 'guest';
2787     $guest->password    = hash_internal_user_password('guest');
2788     $guest->firstname   = get_string('guestuser');
2789     $guest->lastname    = ' ';
2790     $guest->email       = 'root@localhost';
2791     $guest->description = get_string('guestuserinfo');
2792     $guest->mnethostid  = $CFG->mnet_localhost_id;
2793     $guest->confirmed   = 1;
2794     $guest->lang        = $CFG->lang;
2795     $guest->timemodified= time();
2797     if (! $guest->id = $DB->insert_record('user', $guest)) {
2798         return false;
2799     }
2801     return $guest;
2804 /**
2805  * Creates a bare-bones user record
2806  *
2807  * @uses $CFG
2808  * @param string $username New user's username to add to record
2809  * @param string $password New user's password to add to record
2810  * @param string $auth Form of authentication required
2811  * @return object A {@link $USER} object
2812  * @todo Outline auth types and provide code example
2813  */
2814 function create_user_record($username, $password, $auth='manual') {
2815     global $CFG, $DB;
2817     //just in case check text case
2818     $username = trim(moodle_strtolower($username));
2820     $authplugin = get_auth_plugin($auth);
2822     $newuser = new object();
2824     if ($newinfo = $authplugin->get_userinfo($username)) {
2825         $newinfo = truncate_userinfo($newinfo);
2826         foreach ($newinfo as $key => $value){
2827             $newuser->$key = $value;
2828         }
2829     }
2831     if (!empty($newuser->email)) {
2832         if (email_is_not_allowed($newuser->email)) {
2833             unset($newuser->email);
2834         }
2835     }
2837     $newuser->auth = $auth;
2838     $newuser->username = $username;
2840     // fix for MDL-8480
2841     // user CFG lang for user if $newuser->lang is empty
2842     // or $user->lang is not an installed language
2843     $sitelangs = array_keys(get_list_of_languages());
2844     if (empty($newuser->lang) || !in_array($newuser->lang, $sitelangs)) {
2845         $newuser -> lang = $CFG->lang;
2846     }
2847     $newuser->confirmed = 1;
2848     $newuser->lastip = getremoteaddr();
2849     $newuser->timemodified = time();
2850     $newuser->mnethostid = $CFG->mnet_localhost_id;
2852     if ($DB->insert_record('user', $newuser)) {
2853         $user = get_complete_user_data('username', $newuser->username);
2854         if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
2855             set_user_preference('auth_forcepasswordchange', 1, $user->id);
2856         }
2857         update_internal_user_password($user, $password);
2858         return $user;
2859     }
2860     return false;
2863 /**
2864  * Will update a local user record from an external source
2865  *
2866  * @uses $CFG
2867  * @param string $username New user's username to add to record
2868  * @return user A {@link $USER} object
2869  */
2870 function update_user_record($username, $authplugin) {
2871     global $DB;
2873     $username = trim(moodle_strtolower($username)); /// just in case check text case
2875     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
2876     $userauth = get_auth_plugin($oldinfo->auth);
2878     if ($newinfo = $userauth->get_userinfo($username)) {
2879         $newinfo = truncate_userinfo($newinfo);
2880         foreach ($newinfo as $key => $value){
2881             $confval = $userauth->config->{'field_updatelocal_' . $key};
2882             $lockval = $userauth->config->{'field_lock_' . $key};
2883             if (empty($confval) || empty($lockval)) {
2884                 continue;
2885             }
2886             if ($confval === 'onlogin') {
2887                 // MDL-4207 Don't overwrite modified user profile values with
2888                 // empty LDAP values when 'unlocked if empty' is set. The purpose
2889                 // of the setting 'unlocked if empty' is to allow the user to fill
2890                 // in a value for the selected field _if LDAP is giving
2891                 // nothing_ for this field. Thus it makes sense to let this value
2892                 // stand in until LDAP is giving a value for this field.
2893                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
2894                     $DB->set_field('user', $key, $value, 'username', $username)
2895                         || error_log("Error updating $key for $username");
2896                 }
2897             }
2898         }
2899     }
2901     return get_complete_user_data('username', $username);
2904 /**
2905  * will truncate userinfo as it comes from auth_get_userinfo (from external auth) 
2906  * which may have large fields
2907  */
2908 function truncate_userinfo($info) {
2909     // define the limits
2910     $limit = array(
2911                     'username'    => 100,
2912                     'idnumber'    => 255,
2913                     'firstname'   => 100,
2914                     'lastname'    => 100,
2915                     'email'       => 100,
2916                     'icq'         =>  15,
2917                     'phone1'      =>  20,
2918                     'phone2'      =>  20,
2919                     'institution' =>  40,
2920                     'department'  =>  30,
2921                     'address'     =>  70,
2922                     'city'        =>  20,
2923                     'country'     =>   2,
2924                     'url'         => 255,
2925                     );
2927     // apply where needed
2928     foreach (array_keys($info) as $key) {
2929         if (!empty($limit[$key])) {
2930             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
2931         }
2932     }
2934     return $info;
2937 /**
2938  * Marks user deleted in internal user database and notifies the auth plugin.
2939  * Also unenrols user from all roles and does other cleanup.
2940  * @param object $user       Userobject before delete    (without system magic quotes)
2941  * @return boolean success
2942  */
2943 function delete_user($user) {
2944     global $CFG, $DB;
2945     require_once($CFG->libdir.'/grouplib.php');
2946     require_once($CFG->libdir.'/gradelib.php');
2948     $DB->begin_sql();
2950     // delete all grades - backup is kept in grade_grades_history table
2951     if ($grades = grade_grade::fetch_all(array('userid'=>$user->id))) {
2952         foreach ($grades as $grade) {
2953             $grade->delete('userdelete');
2954         }
2955     }
2957     // remove from all groups
2958     $DB->delete_records('groups_members', array('userid'=>$user->id));
2960     // unenrol from all roles in all contexts
2961     role_unassign(0, $user->id); // this might be slow but it is really needed - modules might do some extra cleanup!
2963     // now do a final accesslib cleanup - removes all role assingments in user context and context itself
2964     delete_context(CONTEXT_USER, $user->id);
2966     require_once($CFG->dirroot.'/tag/lib.php');
2967     tag_set('user', $user->id, array());
2969     // workaround for bulk deletes of users with the same email address
2970     $delname = "$user->email.".time();
2971     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
2972         $delname++;
2973     }
2975     // mark internal user record as "deleted"
2976     $updateuser = new object();
2977     $updateuser->id           = $user->id;
2978     $updateuser->deleted      = 1;
2979     $updateuser->username     = $delname;         // Remember it just in case
2980     $updateuser->email        = '';               // Clear this field to free it up
2981     $updateuser->idnumber     = '';               // Clear this field to free it up
2982     $updateuser->timemodified = time();
2984     if ($DB->update_record('user', $updateuser)) {
2985         $DB->commit_sql();
2986         // notify auth plugin - do not block the delete even when plugin fails
2987         $authplugin = get_auth_plugin($user->auth);
2988         $authplugin->user_delete($user);
2989         return true;
2991     } else {
2992         $DB->rollback_sql();
2993         return false;
2994     }
2997 /**
2998  * Retrieve the guest user object
2999  *
3000  * @uses $CFG
3001  * @return user A {@link $USER} object
3002  */
3003 function guest_user() {
3004     global $CFG, $DB;
3006     if ($newuser = $DB->get_record('user', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
3007         $newuser->confirmed = 1;
3008         $newuser->lang = $CFG->lang;
3009         $newuser->lastip = getremoteaddr();
3010     }
3012     return $newuser;
3015 /**
3016  * Given a username and password, this function looks them
3017  * up using the currently selected authentication mechanism,
3018  * and if the authentication is successful, it returns a
3019  * valid $user object from the 'user' table.
3020  *
3021  * Uses auth_ functions from the currently active auth module
3022  *
3023  * After authenticate_user_login() returns success, you will need to
3024  * log that the user has logged in, and call complete_user_login() to set
3025  * the session up.
3026  *
3027  * @uses $CFG
3028  * @param string $username  User's username
3029  * @param string $password  User's password
3030  * @return user|flase A {@link $USER} object or false if error
3031  */
3032 function authenticate_user_login($username, $password) {
3033     global $CFG, $DB;
3035     $authsenabled = get_enabled_auth_plugins();
3037     if ($user = get_complete_user_data('username', $username)) {
3038         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3039         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3040             add_to_log(0, 'login', 'error', 'index.php', $username);
3041             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3042             return false;
3043         }
3044         if (!empty($user->deleted)) {
3045             add_to_log(0, 'login', 'error', 'index.php', $username);
3046             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3047             return false;
3048         }
3049         $auths = array($auth);
3051     } else {
3052         $auths = $authsenabled;
3053         $user = new object();
3054         $user->id = 0;     // User does not exist
3055     }
3057     foreach ($auths as $auth) {
3058         $authplugin = get_auth_plugin($auth);
3060         // on auth fail fall through to the next plugin
3061         if (!$authplugin->user_login($username, $password)) {
3062             continue;
3063         }
3065         // successful authentication
3066         if ($user->id) {                          // User already exists in database
3067             if (empty($user->auth)) {             // For some reason auth isn't set yet
3068                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3069                 $user->auth = $auth;
3070             }
3072             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3074             if (!$authplugin->is_internal()) {            // update user record from external DB
3075                 $user = update_user_record($username, get_auth_plugin($user->auth));
3076             }
3077         } else {
3078             // if user not found, create him
3079             $user = create_user_record($username, $password, $auth);
3080         }
3082         $authplugin->sync_roles($user);
3084         foreach ($authsenabled as $hau) {
3085             $hauth = get_auth_plugin($hau);
3086             $hauth->user_authenticated_hook($user, $username, $password);
3087         }
3089     /// Log in to a second system if necessary
3090     /// NOTICE: /sso/ will be moved to auth and deprecated soon; use user_authenticated_hook() instead
3091         if (!empty($CFG->sso)) {
3092             include_once($CFG->dirroot .'/sso/'. $CFG->sso .'/lib.php');
3093             if (function_exists('sso_user_login')) {
3094                 if (!sso_user_login($username, $password)) {   // Perform the signon process
3095                     notify('Second sign-on failed');
3096                 }
3097             }
3098         }
3100         if ($user->id===0) {
3101             return false;
3102         }
3103         return $user;
3104     }
3106     // failed if all the plugins have failed
3107     add_to_log(0, 'login', 'error', 'index.php', $username);
3108     if (debugging('', DEBUG_ALL)) {
3109         error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3110     }
3111     return false;
3114 /**
3115  * Call to complete the user login process after authenticate_user_login()
3116  * has succeeded. It will setup the $USER variable and other required bits
3117  * and pieces.
3118  *
3119  * NOTE:
3120  * - It will NOT log anything -- up to the caller to decide what to log.
3121  *
3122  *
3123  *
3124  * @uses $CFG, $USER
3125  * @param string $user obj
3126  * @return user|flase A {@link $USER} object or false if error
3127  */
3128 function complete_user_login($user) {
3129     global $CFG, $USER;
3131     $USER = $user; // this is required because we need to access preferences here!
3133     reload_user_preferences();
3135     update_user_login_times();
3136     if (empty($CFG->nolastloggedin)) {
3137         set_moodle_cookie($USER->username);
3138     } else {
3139         // do not store last logged in user in cookie
3140         // auth plugins can temporarily override this from loginpage_hook()
3141         // do not save $CFG->nolastloggedin in database!
3142         set_moodle_cookie('nobody');
3143     }
3144     set_login_session_preferences();
3146     // Call enrolment plugins
3147     check_enrolment_plugins($user);
3149     /// This is what lets the user do anything on the site :-)
3150     load_all_capabilities();
3152     /// Select password change url
3153     $userauth = get_auth_plugin($USER->auth);
3155     /// check whether the user should be changing password
3156     if (get_user_preferences('auth_forcepasswordchange', false)){
3157         if ($userauth->can_change_password()) {
3158             if ($changeurl = $userauth->change_password_url()) {
3159                 redirect($changeurl);
3160             } else {
3161                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3162             }
3163         } else {
3164             print_error('nopasswordchangeforced', 'auth');
3165         }
3166     }
3167     return $USER;
3170 /**
3171  * Compare password against hash stored in internal user table.
3172  * If necessary it also updates the stored hash to new format.
3173  *
3174  * @param object user
3175  * @param string plain text password
3176  * @return bool is password valid?
3177  */
3178 function validate_internal_user_password(&$user, $password) {
3179     global $CFG;
3181     if (!isset($CFG->passwordsaltmain)) {
3182         $CFG->passwordsaltmain = '';
3183     }
3185     $validated = false;
3187     // get password original encoding in case it was not updated to unicode yet
3188     $textlib = textlib_get_instance();
3189     $convpassword = $textlib->convert($password, 'utf-8', get_string('oldcharset'));
3191     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)
3192         or $user->password == md5($convpassword.$CFG->passwordsaltmain) or $user->password == md5($convpassword)) {
3193         $validated = true;
3194     } else {
3195         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3196             $alt = 'passwordsaltalt'.$i;
3197             if (!empty($CFG->$alt)) {
3198                 if ($user->password == md5($password.$CFG->$alt) or $user->password == md5($convpassword.$CFG->$alt)) {
3199                     $validated = true;
3200                     break;
3201                 }
3202             }
3203         }
3204     }
3206     if ($validated) {
3207         // force update of password hash using latest main password salt and encoding if needed
3208         update_internal_user_password($user, $password);
3209     }
3211     return $validated;
3214 /**
3215  * Calculate hashed value from password using current hash mechanism.
3216  *
3217  * @param string password
3218  * @return string password hash
3219  */
3220 function hash_internal_user_password($password) {
3221     global $CFG;
3223     if (isset($CFG->passwordsaltmain)) {
3224         return md5($password.$CFG->passwordsaltmain);
3225     } else {
3226         return md5($password);
3227     }
3230 /**
3231  * Update pssword hash in user object.
3232  *
3233  * @param object user
3234  * @param string plain text password
3235  * @param bool store changes also in db, default true
3236  * @return true if hash changed
3237  */
3238 function update_internal_user_password(&$user, $password) {
3239     global $CFG, $DB;
3241     $authplugin = get_auth_plugin($user->auth);
3242     if (!empty($authplugin->config->preventpassindb)) {
3243         $hashedpassword = 'not cached';
3244     } else {
3245         $hashedpassword = hash_internal_user_password($password);
3246     }
3248     return $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
3251 /**
3252  * Get a complete user record, which includes all the info
3253  * in the user record
3254  * Intended for setting as $USER session variable
3255  *
3256  * @uses $CFG
3257  * @uses SITEID
3258  * @param string $field The user field to be checked for a given value.
3259  * @param string $value The value to match for $field.
3260  * @return user A {@link $USER} object.
3261  */
3262 function get_complete_user_data($field, $value, $mnethostid=null) {
3263     global $CFG, $DB;
3265     if (!$field || !$value) {
3266         return false;
3267     }
3269 /// Build the WHERE clause for an SQL query
3270     $params = array('fieldval'=>$value);
3271     $constraints = "$field = :fieldval AND deleted <> 1";
3273     if (is_null($mnethostid)) {
3274         // if null, we restrict to local users
3275         // ** testing for local user can be done with
3276         //    mnethostid = $CFG->mnet_localhost_id
3277         //    or with
3278         //    auth != 'mnet'
3279         //    but the first one is FAST with our indexes
3280         $mnethostid = $CFG->mnet_localhost_id;
3281     }
3282     $params['mnethostid'] = $mnethostid;
3283     $constraints .= " AND mnethostid = :mnethostid";
3285 /// Get all the basic user data
3287     if (! $user = $DB->get_record_select('user', $constraints, $params)) {
3288         return false;
3289     }
3291 /// Get various settings and preferences
3293     if ($displays = $DB->get_records('course_display', array('userid'=>$user->id))) {
3294         foreach ($displays as $display) {
3295             $user->display[$display->course] = $display->display;
3296         }
3297     }
3299     $user->preference = get_user_preferences(null, null, $user->id);
3301     $user->lastcourseaccess    = array(); // during last session
3302     $user->currentcourseaccess = array(); // during current session
3303     if ($lastaccesses = $DB->get_records('user_lastaccess', array('userid'=>$user->id))) {
3304         foreach ($lastaccesses as $lastaccess) {
3305             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
3306         }
3307     }
3309     $sql = "SELECT g.id, g.courseid
3310               FROM {groups} g, {groups_members} gm
3311              WHERE gm.groupid=g.id AND gm.userid=?";
3313     // this is a special hack to speedup calendar display
3314     $user->groupmember = array();
3315     if ($groups = $DB->get_records_sql($sql, array($user->id))) {
3316         foreach ($groups as $group) {
3317             if (!array_key_exists($group->courseid, $user->groupmember)) {
3318                 $user->groupmember[$group->courseid] = array();
3319             }
3320             $user->groupmember[$group->courseid][$group->id] = $group->id;
3321         }
3322     }
3324 /// Add the custom profile fields to the user record
3325     require_once($CFG->dirroot.'/user/profile/lib.php');
3326     $customfields = (array)profile_user_record($user->id);
3327     foreach ($customfields as $cname=>$cvalue) {
3328         if (!isset($user->$cname)) { // Don't overwrite any standard fields
3329             $user->$cname = $cvalue;
3330         }
3331     }
3333 /// Rewrite some variables if necessary
3334     if (!empty($user->description)) {
3335         $user->description = true;   // No need to cart all of it around
3336     }
3337     if ($user->username == 'guest') {
3338         $user->lang       = $CFG->lang;               // Guest language always same as site
3339         $user->firstname  = get_string('guestuser');  // Name always in current language
3340         $user->lastname   = ' ';
3341     }
3343     $user->sesskey  = random_string(10);
3344     $user->sessionIP = md5(getremoteaddr());   // Store the current IP in the session
3346     return $user;
3349 /**
3350  * @uses $CFG
3351  * @param string $password the password to be checked agains the password policy
3352  * @param string $errmsg the error message to display when the password doesn't comply with the policy.
3353  * @return bool true if the password is valid according to the policy. false otherwise.
3354  */
3355 function check_password_policy($password, &$errmsg) {
3356     global $CFG;
3358     if (empty($CFG->passwordpolicy)) {
3359         return true;
3360     }
3362     $textlib = textlib_get_instance();
3363     $errmsg = '';
3364     if ($textlib->strlen($password) < $CFG->minpasswordlength) {
3365         $errmsg = get_string('errorminpasswordlength', 'auth', $CFG->minpasswordlength);
3367     } else if (preg_match_all('/[[:digit:]]/u', $password, $matches) < $CFG->minpassworddigits) {
3368         $errmsg = get_string('errorminpassworddigits', 'auth', $CFG->minpassworddigits);
3370     } else if (preg_match_all('/[[:lower:]]/u', $password, $matches) < $CFG->minpasswordlower) {
3371         $errmsg = get_string('errorminpasswordlower', 'auth', $CFG->minpasswordlower);
3373     } else if (preg_match_all('/[[:upper:]]/u', $password, $matches) < $CFG->minpasswordupper) {
3374         $errmsg = get_string('errorminpasswordupper', 'auth', $CFG->minpasswordupper);
3376     } else if (preg_match_all('/[^[:upper:][:lower:][:digit:]]/u', $password, $matches) < $CFG->minpasswordnonalphanum) {
3377         $errmsg = get_string('errorminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum);
3379     } else if ($password == 'admin' or $password == 'password') {
3380         $errmsg = get_string('unsafepassword');
3381     }
3383     if ($errmsg == '') {
3384         return true;
3385     } else {
3386         return false;
3387     }
3391 /**
3392  * When logging in, this function is run to set certain preferences
3393  * for the current SESSION
3394  */
3395 function set_login_session_preferences() {
3396     global $SESSION, $CFG;
3398     $SESSION->justloggedin = true;
3400     unset($SESSION->lang);
3402     // Restore the calendar filters, if saved
3403     if (intval(get_user_preferences('calendar_persistflt', 0))) {
3404         include_once($CFG->dirroot.'/calendar/lib.php');
3405         calendar_set_filters_status(get_user_preferences('calendav_savedflt', 0xff));
3406     }
3410 /**
3411  * Delete a course, including all related data from the database,
3412  * and any associated files from the moodledata folder.
3413  *
3414  * @param int $courseid The id of the course to delete.
3415  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3416  * @return bool true if all the removals succeeded. false if there were any failures. If this
3417  *             method returns false, some of the removals will probably have succeeded, and others
3418  *             failed, but you have no way of knowing which.
3419  */
3420 function delete_course($courseid, $showfeedback = true) {
3421     global $CFG, $DB;
3422     $result = true;
3424     // frontpage course can not be deleted!!
3425     if ($courseid == SITEID) {
3426         return false;
3427     }
3429     if (!remove_course_contents($courseid, $showfeedback)) {
3430         if ($showfeedback) {
3431             notify("An error occurred while deleting some of the course contents.");
3432         }
3433         $result = false;
3434     }
3436     if (!$DB->delete_records("course", array("id"=>$courseid))) {
3437         if ($showfeedback) {
3438             notify("An error occurred while deleting the main course record.");
3439         }
3440         $result = false;
3441     }
3443 /// Delete all roles and overiddes in the course context
3444     if (!delete_context(CONTEXT_COURSE, $courseid)) {
3445         if ($showfeedback) {
3446             notify("An error occurred while deleting the main course context.");
3447         }
3448         $result = false;
3449     }
3451     if (!fulldelete($CFG->dataroot.'/'.$courseid)) {
3452         if ($showfeedback) {
3453             notify("An error occurred while deleting the course files.");
3454         }
3455         $result = false;
3456     }
3458     return $result;
3461 /**
3462  * Clear a course out completely, deleting all content
3463  * but don't delete the course itself
3464  *
3465  * @uses $CFG
3466  * @param int $courseid The id of the course that is being deleted
3467  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3468  * @return bool true if all the removals succeeded. false if there were any failures. If this
3469  *             method returns false, some of the removals will probably have succeeded, and others
3470  *             failed, but you have no way of knowing which.
3471  */
3472 function remove_course_contents($courseid, $showfeedback=true) {
3473     global $CFG, $DB;
3474     require_once($CFG->libdir.'/questionlib.php');
3475     require_once($CFG->libdir.'/gradelib.php');
3477     $result = true;
3479     if (! $course = $DB->get_record('course', array('id'=>$courseid))) {
3480         print_error('invalidcourseid');
3481     }
3483     $strdeleted = get_string('deleted');
3485 /// First delete every instance of every module
3487     if ($allmods = $DB->get_records('modules') ) {
3488         foreach ($allmods as $mod) {
3489             $modname = $mod->name;
3490             $modfile = $CFG->dirroot .'/mod/'. $modname .'/lib.php';
3491             $moddelete = $modname .'_delete_instance';       // Delete everything connected to an instance
3492             $moddeletecourse = $modname .'_delete_course';   // Delete other stray stuff (uncommon)
3493             $count=0;
3494             if (file_exists($modfile)) {
3495                 include_once($modfile);
3496                 if (function_exists($moddelete)) {
3497                     if ($instances = $DB->get_records($modname, array('course'=>$course->id))) {
3498                         foreach ($instances as $instance) {
3499                             if ($cm = get_coursemodule_from_instance($modname, $instance->id, $course->id)) {
3500                                 /// Delete activity context questions and question categories
3501                                 question_delete_activity($cm,  $showfeedback);
3502                             }
3503                             if ($moddelete($instance->id)) {
3504                                 $count++;
3506                             } else {
3507                                 notify('Could not delete '. $modname .' instance '. $instance->id .' ('. format_string($instance->name) .')');
3508                                 $result = false;
3509                             }
3510                             if ($cm) {
3511                                 // delete cm and its context in correct order
3512                                 $DB->delete_records('course_modules', array('id'=>$cm->id));
3513                                 delete_context(CONTEXT_MODULE, $cm->id);
3514                             }
3515                         }
3516                     }
3517                 } else {
3518                     notify('Function '.$moddelete.'() doesn\'t exist!');
3519                     $result = false;
3520                 }
3522                 if (function_exists($moddeletecourse)) {
3523                     $moddeletecourse($course, $showfeedback);
3524                 }
3525             }
3526             if ($showfeedback) {
3527                 notify($strdeleted .' '. $count .' x '. $modname);
3528             }
3529         }
3530     } else {
3531         print_error('nomodules', 'debug');
3532     }
3534 /// Give local code a chance to delete its references to this course.
3535     require_once('locallib.php');
3536     notify_local_delete_course($courseid, $showfeedback);
3538 /// Delete course blocks
3540     if ($blocks = $DB->get_records_sql("SELECT *
3541                                           FROM {block_instance}
3542                                          WHERE pagetype = '".PAGE_COURSE_VIEW."'
3543                                                AND pageid = ?", array($course->id))) {
3544         if ($DB->delete_records('block_instance', array('pagetype'=>PAGE_COURSE_VIEW, 'pageid'=>$course->id))) {
3545             if ($showfeedback) {
3546                 notify($strdeleted .' block_instance');
3547             }
3549             require_once($CFG->libdir.'/blocklib.php');
3550             foreach ($blocks as $block) {  /// Delete any associated contexts for this block
3552                 delete_context(CONTEXT_BLOCK, $block->id);
3554                 // fix for MDL-7164
3555                 // Get the block object and call instance_delete()
3556                 if (!$record = blocks_get_record($block->blockid)) {
3557                     $result = false;
3558                     continue;
3559                 }
3560                 if (!$obj = block_instance($record->name, $block)) {
3561                     $result = false;
3562                     continue;
3563                 }
3564                 // Return value ignored, in core mods this does not do anything, but just in case
3565                 // third party blocks might have stuff to clean up
3566                 // we execute this anyway
3567                 $obj->instance_delete();
3569             }
3570         } else {
3571             $result = false;
3572         }
3573     }
3575 /// Delete any groups, removing members and grouping/course links first.
3576     require_once($CFG->dirroot.'/group/lib.php');
3577     groups_delete_groupings($courseid, $showfeedback);
3578     groups_delete_groups($courseid, $showfeedback);
3580 /// Delete all related records in other tables that may have a courseid
3581 /// This array stores the tables that need to be cleared, as
3582 /// table_name => column_name that contains the course id.
3584     $tablestoclear = array(
3585         'event' => 'courseid', // Delete events
3586         'log' => 'course', // Delete logs
3587         'course_sections' => 'course', // Delete any course stuff
3588         'course_modules' => 'course',
3589         'backup_courses' => 'courseid', // Delete scheduled backup stuff
3590         'user_lastaccess' => 'courseid',
3591         'backup_log' => 'courseid'
3592     );
3593     foreach ($tablestoclear as $table => $col) {
3594         if ($DB->delete_records($table, array($col=>$course->id))) {
3595             if ($showfeedback) {
3596                 notify($strdeleted . ' ' . $table);
3597             }
3598         } else {
3599             $result = false;
3600         }
3601     }
3604 /// Clean up metacourse stuff
3606     if ($course->metacourse) {
3607         $DB->delete_records("course_meta", array("parent_course"=>$course->id));
3608         sync_metacourse($course->id); // have to do it here so the enrolments get nuked. sync_metacourses won't find it without the id.
3609         if ($showfeedback) {
3610             notify("$strdeleted course_meta");
3611         }
3612     } else {
3613         if ($parents = $DB->get_records("course_meta", array("child_course"=>$course->id))) {
3614             foreach ($parents as $parent) {
3615                 remove_from_metacourse($parent->parent_course,$parent->child_course); // this will do the unenrolments as well.
3616             }
3617             if ($showfeedback) {
3618                 notify("$strdeleted course_meta");
3619             }
3620         }
3621     }
3623 /// Delete questions and question categories
3624     question_delete_course($course, $showfeedback);
3626 /// Remove all data from gradebook
3627     $context = get_context_instance(CONTEXT_COURSE, $courseid);
3628     remove_course_grades($courseid, $showfeedback);
3629     remove_grade_letters($context, $showfeedback);
3631     return $result;
3634 /**
3635  * Change dates in module - used from course reset.
3636  * @param strin $modname forum, assignent, etc
3637  * @param array $fields array of date fields from mod table
3638  * @param int $timeshift time difference
3639  * @return success
3640  */
3641 function shift_course_mod_dates($modname, $fields, $timeshift, $courseid) {
3642     global $CFG, $DB;
3643     include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
3645     $return = true;
3646     foreach ($fields as $field) {
3647         $updatesql = "UPDATE {".$modname."}
3648                           SET $field = $field + ?
3649                         WHERE course=? AND $field<>0 AND $field<>0";
3650         $return = $DB->execute($updatesql, array($timeshift, $courseid)) && $return;
3651     }
3653     $refreshfunction = $modname.'_refresh_events';
3654     if (function_exists($refreshfunction)) {
3655         $refreshfunction($courseid);
3656     }
3658     return $return;
3661 /**
3662  * This function will empty a course of user data.
3663  * It will retain the activities and the structure of the course.
3664  * @param object $data an object containing all the settings including courseid (without magic quotes)
3665  * @return array status array of array component, item, error
3666  */
3667 function reset_course_userdata($data) {
3668     global $CFG, $USER, $DB;
3669     require_once($CFG->libdir.'/gradelib.php');
3670     require_once($CFG->dirroot.'/group/lib.php');
3672     $data->courseid = $data->id;
3673     $context = get_context_instance(CONTEXT_COURSE, $data->courseid);
3675     // calculate the time shift of dates
3676     if (!empty($data->reset_start_date)) {
3677         // time part of course startdate should be zero
3678         $data->timeshift = $data->reset_start_date - usergetmidnight($data->reset_start_date_old);
3679     } else {
3680         $data->timeshift = 0;
3681     }
3683     // result array: component, item, error
3684     $status = array();
3686     // start the resetting
3687     $componentstr = get_string('general');
3689     // move the course start time
3690     if (!empty($data->reset_start_date) and $data->timeshift) {
3691         // change course start data
3692         $DB->set_field('course', 'startdate', $data->reset_start_date, array('id'=>$data->courseid));
3693         // update all course and group events - do not move activity events
3694         $updatesql = "UPDATE {$CFG->prefix}event
3695                          SET timestart = timestart + ?
3696                        WHERE courseid=? AND instance=0";
3697         $DB->execute($updatesql, array($data->timeshift, $data->courseid));
3699         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
3700     }
3702     if (!empty($data->reset_logs)) {
3703         $DB->delete_records('log', array('course'=>$data->courseid));
3704         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletelogs'), 'error'=>false);
3705     }
3707     if (!empty($data->reset_events)) {
3708         $DB->delete_records('event', array('courseid'=>$data->courseid));
3709         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteevents', 'calendar'), 'error'=>false);
3710     }
3712     if (!empty($data->reset_notes)) {
3713         require_once($CFG->dirroot.'/notes/lib.php');
3714         note_delete_all($data->courseid);
3715         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotes', 'notes'), 'error'=>false);
3716     }
3718     $componentstr = get_string('roles');
3720     if (!empty($data->reset_roles_overrides)) {
3721         $children = get_child_contexts($context);
3722         foreach ($children as $child) {
3723             $DB->delete_records('role_capabilities', array('contextid'=>$child->id));
3724         }
3725      &