MDL-18910 moving modedit features to modname_supports()
[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  * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
35  * @package moodlecore
36  */
38 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
40 /**
41  * Used by some scripts to check they are being called by Moodle
42  */
43 define('MOODLE_INTERNAL', true);
45 /// Date and time constants ///
46 /**
47  * Time constant - the number of seconds in a year
48  */
49 define('YEARSECS', 31536000);
51 /**
52  * Time constant - the number of seconds in a week
53  */
54 define('WEEKSECS', 604800);
56 /**
57  * Time constant - the number of seconds in a day
58  */
59 define('DAYSECS', 86400);
61 /**
62  * Time constant - the number of seconds in an hour
63  */
64 define('HOURSECS', 3600);
66 /**
67  * Time constant - the number of seconds in a minute
68  */
69 define('MINSECS', 60);
71 /**
72  * Time constant - the number of minutes in a day
73  */
74 define('DAYMINS', 1440);
76 /**
77  * Time constant - the number of minutes in an hour
78  */
79 define('HOURMINS', 60);
81 /// Parameter constants - every call to optional_param(), required_param()  ///
82 /// or clean_param() should have a specified type of parameter.  //////////////
84 /**
85  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way;
86  * originally was 0, but changed because we need to detect unknown
87  * parameter types and swiched order in clean_param().
88  */
89 define('PARAM_RAW', 666);
91 /**
92  * PARAM_CLEAN - obsoleted, please try to use more specific type of parameter.
93  * It was one of the first types, that is why it is abused so much ;-)
94  */
95 define('PARAM_CLEAN',    0x0001);
97 /**
98  * PARAM_INT - integers only, use when expecting only numbers.
99  */
100 define('PARAM_INT',      0x0002);
102 /**
103  * PARAM_INTEGER - an alias for PARAM_INT
104  */
105 define('PARAM_INTEGER',  0x0002);
107 /**
108  * PARAM_FLOAT - a real/floating point number.
109  */
110 define('PARAM_FLOAT',  0x000a);
112 /**
113  * PARAM_NUMBER - alias of PARAM_FLOAT, deprecated - do not use
114  */
115 define('PARAM_NUMBER',  0x000a);
117 /**
118  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
119  */
120 define('PARAM_ALPHA',    0x0004);
122 /**
123  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
124  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
125  */
126 define('PARAM_ALPHAEXT', 0x2000);
128 /**
129  * PARAM_ALPHANUM - expected numbers and letters only.
130  */
131 define('PARAM_ALPHANUM', 0x0400);
133 /**
134  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
135  */
136 define('PARAM_ALPHANUMEXT', 0x4000);
138 /**
139  * PARAM_ACTION - an alias for PARAM_ALPHANUMEXT, use for various actions in formas and urls
140  * NOTE: originally alias for PARAM_APLHA
141  */
142 define('PARAM_ACTION',   0x4000);
144 /**
145  * PARAM_FORMAT - an alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
146  * NOTE: originally alias for PARAM_APLHA
147  */
148 define('PARAM_FORMAT',   0x4000);
150 /**
151  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
152  */
153 define('PARAM_NOTAGS',   0x0008);
155 /**
156  * PARAM_MULTILANG - alias of PARAM_TEXT.
157  */
158 define('PARAM_MULTILANG',  0x0009);
160 /**
161  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
162  */
163 define('PARAM_TEXT',  0x0009);
165 /**
166  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
167  */
168 define('PARAM_FILE',     0x0010);
170 /**
171  * PARAM_CLEANFILE - alias of PARAM_FILE; originally was removing regional chars too
172  * NOTE: obsoleted do not use anymore
173  */
174 define('PARAM_CLEANFILE',0x0010);
176 /**
177  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
178  */
179 define('PARAM_TAG',   0x0011);
181 /**
182  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
183  */
184 define('PARAM_TAGLIST',   0x0012);
186 /**
187  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
188  * note: the leading slash is not removed, window drive letter is not allowed
189  */
190 define('PARAM_PATH',     0x0020);
192 /**
193  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
194  */
195 define('PARAM_HOST',     0x0040);
197 /**
198  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not acceppted but http://localhost.localdomain/ is ok.
199  */
200 define('PARAM_URL',      0x0080);
202 /**
203  * 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!)
204  */
205 define('PARAM_LOCALURL', 0x0180);
207 /**
208  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
209  */
210 define('PARAM_BOOL',     0x0800);
212 /**
213  * PARAM_CLEANHTML - cleans submitted HTML code and removes slashes
214  */
215 define('PARAM_CLEANHTML',0x1000);
217 /**
218  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
219  */
220 define('PARAM_SAFEDIR',  0x4000);
222 /**
223  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
224  */
225 define('PARAM_SAFEPATH',  0x4001);
227 /**
228  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
229  */
230 define('PARAM_SEQUENCE',  0x8000);
232 /**
233  * PARAM_PEM - Privacy Enhanced Mail format
234  */
235 define('PARAM_PEM',      0x10000);
237 /**
238  * PARAM_BASE64 - Base 64 encoded format
239  */
240 define('PARAM_BASE64',   0x20000);
242 /**
243  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
244  * checked against the list of capabilties in the database.
245  */
246 define('PARAM_CAPABILITY',   0x40000);
248 /**
249  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
250  */
251 define('PARAM_PERMISSION',   0x80000);
253 /// Page types ///
254 /**
255  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
256  */
257 define('PAGE_COURSE_VIEW', 'course-view');
259 /// Debug levels ///
260 /** no warnings at all */
261 define ('DEBUG_NONE', 0);
262 /** E_ERROR | E_PARSE */
263 define ('DEBUG_MINIMAL', 5);
264 /** E_ERROR | E_PARSE | E_WARNING | E_NOTICE */
265 define ('DEBUG_NORMAL', 15);
266 /** E_ALL without E_STRICT for now, do show recoverable fatal errors */
267 define ('DEBUG_ALL', 6143);
268 /** DEBUG_ALL with extra Moodle debug messages - (DEBUG_ALL | 32768) */
269 define ('DEBUG_DEVELOPER', 38911);
271 /** Get remote addr constant */
272 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
273 /** Get remote addr constant */
274 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
276 /// Blog access level constant declaration ///
277 define ('BLOG_USER_LEVEL', 1);
278 define ('BLOG_GROUP_LEVEL', 2);
279 define ('BLOG_COURSE_LEVEL', 3);
280 define ('BLOG_SITE_LEVEL', 4);
281 define ('BLOG_GLOBAL_LEVEL', 5);
284 ///Tag constants///
285 /**
286  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
287  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
288  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
289  */
290 define('TAG_MAX_LENGTH', 50);
292 /// Password policy constants ///
293 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
294 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
295 define ('PASSWORD_DIGITS', '0123456789');
296 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
298 /// Feature constants ///
299 // Used for plugin_supports() to report features that are, or are not, supported by a module.
301 /** True if module can provide a grade */
302 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
303 /** True if module supports outcomes */
304 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
306 /** True if module has code to track whether somebody viewed it */
307 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
308 /** True if module has custom completion rules */
309 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
311 /** True if module supports outcomes */
312 define('FEATURE_IDNUMBER', 'idnumber');
313 /** True if module supports groups */
314 define('FEATURE_GROUPS', 'groups');
315 /** True if module supports groupings */
316 define('FEATURE_GROUPINGS', 'groupings');
317 /** True if module supports groupmembersonly */
318 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
320 /** True if module supports intro editor */
321 define('FEATURE_MODEDIT_INTRO_EDITOR', 'modedit_intro_editor');
322 /** True if module has default completion */
323 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
326 /// PARAMETER HANDLING ////////////////////////////////////////////////////
328 /**
329  * Returns a particular value for the named variable, taken from
330  * POST or GET.  If the parameter doesn't exist then an error is
331  * thrown because we require this variable.
332  *
333  * This function should be used to initialise all required values
334  * in a script that are based on parameters.  Usually it will be
335  * used like this:
336  *    $id = required_param('id');
337  *
338  * @param string $parname the name of the page parameter we want
339  * @param int $type expected type of parameter
340  * @return mixed
341  */
342 function required_param($parname, $type=PARAM_CLEAN) {
343     if (isset($_POST[$parname])) {       // POST has precedence
344         $param = $_POST[$parname];
345     } else if (isset($_GET[$parname])) {
346         $param = $_GET[$parname];
347     } else {
348         print_error('missingparam', '', '', $parname);
349     }
351     return clean_param($param, $type);
354 /**
355  * Returns a particular value for the named variable, taken from
356  * POST or GET, otherwise returning a given default.
357  *
358  * This function should be used to initialise all optional values
359  * in a script that are based on parameters.  Usually it will be
360  * used like this:
361  *    $name = optional_param('name', 'Fred');
362  *
363  * @param string $parname the name of the page parameter we want
364  * @param mixed  $default the default value to return if nothing is found
365  * @param int $type expected type of parameter
366  * @return mixed
367  */
368 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
369     if (isset($_POST[$parname])) {       // POST has precedence
370         $param = $_POST[$parname];
371     } else if (isset($_GET[$parname])) {
372         $param = $_GET[$parname];
373     } else {
374         return $default;
375     }
377     return clean_param($param, $type);
380 /**
381  * Used by {@link optional_param()} and {@link required_param()} to
382  * clean the variables and/or cast to specific types, based on
383  * an options field.
384  * <code>
385  * $course->format = clean_param($course->format, PARAM_ALPHA);
386  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
387  * </code>
388  *
389  * @uses $CFG
390  * @uses PARAM_RAW
391  * @uses PARAM_CLEAN
392  * @uses PARAM_CLEANHTML
393  * @uses PARAM_INT
394  * @uses PARAM_FLOAT
395  * @uses PARAM_NUMBER
396  * @uses PARAM_ALPHA
397  * @uses PARAM_ALPHAEXT
398  * @uses PARAM_ALPHANUM
399  * @uses PARAM_ALPHANUMEXT
400  * @uses PARAM_SEQUENCE
401  * @uses PARAM_BOOL
402  * @uses PARAM_NOTAGS
403  * @uses PARAM_TEXT
404  * @uses PARAM_SAFEDIR
405  * @uses PARAM_SAFEPATH
406  * @uses PARAM_FILE
407  * @uses PARAM_PATH
408  * @uses PARAM_HOST
409  * @uses PARAM_URL
410  * @uses PARAM_LOCALURL
411  * @uses PARAM_PEM
412  * @uses PARAM_BASE64
413  * @uses PARAM_TAG
414  * @uses PARAM_SEQUENCE
415  * @param mixed $param the variable we are cleaning
416  * @param int $type expected format of param after cleaning.
417  * @return mixed
418  */
419 function clean_param($param, $type) {
421     global $CFG;
423     if (is_array($param)) {              // Let's loop
424         $newparam = array();
425         foreach ($param as $key => $value) {
426             $newparam[$key] = clean_param($value, $type);
427         }
428         return $newparam;
429     }
431     switch ($type) {
432         case PARAM_RAW:          // no cleaning at all
433             return $param;
435         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
436             if (is_numeric($param)) {
437                 return $param;
438             }
439             return clean_text($param);     // Sweep for scripts, etc
441         case PARAM_CLEANHTML:    // prepare html fragment for display, do not store it into db!!
442             $param = clean_text($param);     // Sweep for scripts, etc
443             return trim($param);
445         case PARAM_INT:
446             return (int)$param;  // Convert to integer
448         case PARAM_FLOAT:
449         case PARAM_NUMBER:
450             return (float)$param;  // Convert to float
452         case PARAM_ALPHA:        // Remove everything not a-z
453             return eregi_replace('[^a-zA-Z]', '', $param);
455         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
456             return eregi_replace('[^a-zA-Z_-]', '', $param);
458         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
459             return eregi_replace('[^A-Za-z0-9]', '', $param);
461         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
462             return eregi_replace('[^A-Za-z0-9_-]', '', $param);
464         case PARAM_SEQUENCE:     // Remove everything not 0-9,
465             return eregi_replace('[^0-9,]', '', $param);
467         case PARAM_BOOL:         // Convert to 1 or 0
468             $tempstr = strtolower($param);
469             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
470                 $param = 1;
471             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
472                 $param = 0;
473             } else {
474                 $param = empty($param) ? 0 : 1;
475             }
476             return $param;
478         case PARAM_NOTAGS:       // Strip all tags
479             return strip_tags($param);
481         case PARAM_TEXT:    // leave only tags needed for multilang
482             return clean_param(strip_tags($param, '<lang><span>'), PARAM_CLEAN);
484         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
485             return eregi_replace('[^a-zA-Z0-9_-]', '', $param);
487         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
488             return eregi_replace('[^a-zA-Z0-9/_-]', '', $param);
490         case PARAM_FILE:         // Strip all suspicious characters from filename
491             $param = ereg_replace('[[:cntrl:]]|[&<>"`\|\':\\/]', '', $param);
492             $param = ereg_replace('\.\.+', '', $param);
493             if ($param === '.') {
494                 $param = '';
495             }
496             return $param;
498         case PARAM_PATH:         // Strip all suspicious characters from file path
499             $param = str_replace('\\', '/', $param);
500             $param = ereg_replace('[[:cntrl:]]|[&<>"`\|\':]', '', $param);
501             $param = ereg_replace('\.\.+', '', $param);
502             $param = ereg_replace('//+', '/', $param);
503             return ereg_replace('/(\./)+', '/', $param);
505         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
506             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
507             // match ipv4 dotted quad
508             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
509                 // confirm values are ok
510                 if ( $match[0] > 255
511                      || $match[1] > 255
512                      || $match[3] > 255
513                      || $match[4] > 255 ) {
514                     // hmmm, what kind of dotted quad is this?
515                     $param = '';
516                 }
517             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
518                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
519                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
520                        ) {
521                 // all is ok - $param is respected
522             } else {
523                 // all is not ok...
524                 $param='';
525             }
526             return $param;
528         case PARAM_URL:          // allow safe ftp, http, mailto urls
529             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
530             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
531                 // all is ok, param is respected
532             } else {
533                 $param =''; // not really ok
534             }
535             return $param;
537         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
538             $param = clean_param($param, PARAM_URL);
539             if (!empty($param)) {
540                 if (preg_match(':^/:', $param)) {
541                     // root-relative, ok!
542                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
543                     // absolute, and matches our wwwroot
544                 } else {
545                     // relative - let's make sure there are no tricks
546                     if (validateUrlSyntax($param, 's-u-P-a-p-f+q?r?')) {
547                         // looks ok.
548                     } else {
549                         $param = '';
550                     }
551                 }
552             }
553             return $param;
555         case PARAM_PEM:
556             $param = trim($param);
557             // PEM formatted strings may contain letters/numbers and the symbols
558             // forward slash: /
559             // plus sign:     +
560             // equal sign:    =
561             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
562             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
563                 list($wholething, $body) = $matches;
564                 unset($wholething, $matches);
565                 $b64 = clean_param($body, PARAM_BASE64);
566                 if (!empty($b64)) {
567                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
568                 } else {
569                     return '';
570                 }
571             }
572             return '';
574         case PARAM_BASE64:
575             if (!empty($param)) {
576                 // PEM formatted strings may contain letters/numbers and the symbols
577                 // forward slash: /
578                 // plus sign:     +
579                 // equal sign:    =
580                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
581                     return '';
582                 }
583                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
584                 // Each line of base64 encoded data must be 64 characters in
585                 // length, except for the last line which may be less than (or
586                 // equal to) 64 characters long.
587                 for ($i=0, $j=count($lines); $i < $j; $i++) {
588                     if ($i + 1 == $j) {
589                         if (64 < strlen($lines[$i])) {
590                             return '';
591                         }
592                         continue;
593                     }
595                     if (64 != strlen($lines[$i])) {
596                         return '';
597                     }
598                 }
599                 return implode("\n",$lines);
600             } else {
601                 return '';
602             }
604         case PARAM_TAG:
605             //as long as magic_quotes_gpc is used, a backslash will be a
606             //problem, so remove *all* backslash.
607             //$param = str_replace('\\', '', $param);
608             //remove some nasties
609             $param = ereg_replace('[[:cntrl:]]|[<>`]', '', $param);
610             //convert many whitespace chars into one
611             $param = preg_replace('/\s+/', ' ', $param);
612             $textlib = textlib_get_instance();
613             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
614             return $param;
617         case PARAM_TAGLIST:
618             $tags = explode(',', $param);
619             $result = array();
620             foreach ($tags as $tag) {
621                 $res = clean_param($tag, PARAM_TAG);
622                 if ($res !== '') {
623                     $result[] = $res;
624                 }
625             }
626             if ($result) {
627                 return implode(',', $result);
628             } else {
629                 return '';
630             }
632         case PARAM_CAPABILITY:
633             if (is_valid_capability($param)) {
634                 return $param;
635             } else {
636                 return '';
637             }
639         case PARAM_PERMISSION:
640             $param = (int)$param;
641             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
642                 return $param;
643             } else {
644                 return CAP_INHERIT;
645             }
647         default:                 // throw error, switched parameters in optional_param or another serious problem
648             print_error("unknowparamtype", '', '', $type);
649     }
652 /**
653  * Return true if given value is integer or string with integer value
654  */
655 function is_number($value) {
656     if (is_int($value)) {
657         return true;
658     } else if (is_string($value)) {
659         return ((string)(int)$value) === $value;
660     } else {
661         return false;
662     }
665 /**
666  * This function is useful for testing whether something you got back from
667  * the HTML editor actually contains anything. Sometimes the HTML editor
668  * appear to be empty, but actually you get back a <br> tag or something.
669  *
670  * @param string $string a string containing HTML.
671  * @return boolean does the string contain any actual content - that is text,
672  * images, objcts, etc.
673  */
674 function html_is_blank($string) {
675     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
678 /**
679  * Set a key in global configuration
680  *
681  * Set a key/value pair in both this session's {@link $CFG} global variable
682  * and in the 'config' database table for future sessions.
683  *
684  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
685  * In that case it doesn't affect $CFG.
686  *
687  * A NULL value will delete the entry.
688  *
689  * @param string $name the key to set
690  * @param string $value the value to set (without magic quotes)
691  * @param string $plugin (optional) the plugin scope
692  * @uses $CFG
693  * @return bool true or exception
694  */
695 function set_config($name, $value, $plugin=NULL) {
696     global $CFG, $DB;
698     if (empty($plugin)) {
699         if (!array_key_exists($name, $CFG->config_php_settings)) {
700             // So it's defined for this invocation at least
701             if (is_null($value)) {
702                 unset($CFG->$name);
703             } else {
704                 $CFG->$name = (string)$value; // settings from db are always strings
705             }
706         }
708         if ($DB->get_field('config', 'name', array('name'=>$name))) {
709             if ($value === null) {
710                 $DB->delete_records('config', array('name'=>$name));
711             } else {
712                 $DB->set_field('config', 'value', $value, array('name'=>$name));
713             }
714         } else {
715             if ($value !== null) {
716                 $config = new object();
717                 $config->name  = $name;
718                 $config->value = $value;
719                 $DB->insert_record('config', $config, false);
720             }
721         }
723     } else { // plugin scope
724         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
725             if ($value===null) {
726                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
727             } else {
728                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
729             }
730         } else {
731             if ($value !== null) {
732                 $config = new object();
733                 $config->plugin = $plugin;
734                 $config->name   = $name;
735                 $config->value  = $value;
736                 $DB->insert_record('config_plugins', $config, false);
737             }
738         }
739     }
741     return true;
744 /**
745  * Get configuration values from the global config table
746  * or the config_plugins table.
747  *
748  * If called with no parameters it will do the right thing
749  * generating $CFG safely from the database without overwriting
750  * existing values.
751  *
752  * If called with one parameter, it will load all the config
753  * variables for one pugin, and return them as an object.
754  *
755  * If called with 2 parameters it will return a $string single
756  * value or false of the value is not found.
757  *
758  * @param string $plugin
759  * @param string $name
760  * @uses $CFG
761  * @return hash-like object or single value
762  *
763  */
764 function get_config($plugin=NULL, $name=NULL) {
765     global $CFG, $DB;
767     if (!empty($name)) { // the user is asking for a specific value
768         if (!empty($plugin)) {
769             return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
770         } else {
771             return $DB->get_field('config', 'value', array('name'=>$name));
772         }
773     }
775     // the user is after a recordset
776     if (!empty($plugin)) {
777         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
778         if (!empty($localcfg)) {
779             return (object)$localcfg;
780         } else {
781             return false;
782         }
783     } else {
784         // this was originally in setup.php
785         if ($configs = $DB->get_records('config')) {
786             $localcfg = (array)$CFG;
787             foreach ($configs as $config) {
788                 if (!isset($localcfg[$config->name])) {
789                     $localcfg[$config->name] = $config->value;
790                 }
791                 // do not complain anymore if config.php overrides settings from db
792             }
794             $localcfg = (object)$localcfg;
795             return $localcfg;
796         } else {
797             // preserve $CFG if DB returns nothing or error
798             return $CFG;
799         }
801     }
804 /**
805  * Removes a key from global configuration
806  *
807  * @param string $name the key to set
808  * @param string $plugin (optional) the plugin scope
809  * @uses $CFG
810  * @return boolean whether the operation succeeded.
811  */
812 function unset_config($name, $plugin=NULL) {
813     global $CFG, $DB;
815     if (empty($plugin)) {
816         unset($CFG->$name);
817         $DB->delete_records('config', array('name'=>$name));
818     } else {
819         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
820     }
822     return true;
825 /**
826  * Remove all the config variables for a given plugin.
827  *
828  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
829  * @return boolean whether the operation succeeded.
830  */
831 function unset_all_config_for_plugin($plugin) {
832     global $DB;
833     $DB->delete_records('config_plugins', array('plugin' => $plugin));
834     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
835     return true;
838 /**
839  * Use this funciton to get a list of users from a config setting of type admin_setting_users_with_capability.
840  * @param string $value the value of the config setting.
841  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
842  * @return array of user objects.
843  */
844 function get_users_from_config($value, $capability) {
845     global $CFG;
846     if ($value == '$@ALL@$') {
847         $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
848     } else {
849         list($where, $params) = $DB->get_in_or_equal(explode(',', $CFG->courserequestnotify));
850         $params[] = $CFG->mnet_localhost_id;
851         $users = $DB->get_records_select('user', 'username ' . $where . ' AND mnethostid = ?', $params);
852     }
853     return $users;
856 /**
857  * Get volatile flags
858  *
859  * @param string $type
860  * @param int    $changedsince
861  * @return records array
862  *
863  */
864 function get_cache_flags($type, $changedsince=NULL) {
865     global $DB;
867     $params = array('type'=>$type, 'expiry'=>time());
868     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
869     if ($changedsince !== NULL) {
870         $params['changedsince'] = $changedsince;
871         $sqlwhere .= " AND timemodified > :changedsince";
872     }
873     $cf = array();
875     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
876         foreach ($flags as $flag) {
877             $cf[$flag->name] = $flag->value;
878         }
879     }
880     return $cf;
883 /**
884  * Get volatile flags
885  *
886  * @param string $type
887  * @param string $name
888  * @param int    $changedsince
889  * @return records array
890  *
891  */
892 function get_cache_flag($type, $name, $changedsince=NULL) {
893     global $DB;
895     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
897     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
898     if ($changedsince !== NULL) {
899         $params['changedsince'] = $changedsince;
900         $sqlwhere .= " AND timemodified > :changedsince";
901     }
903     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
906 /**
907  * Set a volatile flag
908  *
909  * @param string $type the "type" namespace for the key
910  * @param string $name the key to set
911  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
912  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
913  * @return bool
914  */
915 function set_cache_flag($type, $name, $value, $expiry=NULL) {
916     global $DB;
918     $timemodified = time();
919     if ($expiry===NULL || $expiry < $timemodified) {
920         $expiry = $timemodified + 24 * 60 * 60;
921     } else {
922         $expiry = (int)$expiry;
923     }
925     if ($value === NULL) {
926         unset_cache_flag($type,$name);
927         return true;
928     }
930     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type))) { // this is a potentail problem in DEBUG_DEVELOPER
931         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
932             return true; //no need to update; helps rcache too
933         }
934         $f->value        = $value;
935         $f->expiry       = $expiry;
936         $f->timemodified = $timemodified;
937         $DB->update_record('cache_flags', $f);
938     } else {
939         $f = new object();
940         $f->flagtype     = $type;
941         $f->name         = $name;
942         $f->value        = $value;
943         $f->expiry       = $expiry;
944         $f->timemodified = $timemodified;
945         $DB->insert_record('cache_flags', $f);
946     }
947     return true;
950 /**
951  * Removes a single volatile flag
952  *
953  * @param string $type the "type" namespace for the key
954  * @param string $name the key to set
955  * @uses $CFG
956  * @return bool
957  */
958 function unset_cache_flag($type, $name) {
959     global $DB;
960     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
961     return true;
964 /**
965  * Garbage-collect volatile flags
966  *
967  */
968 function gc_cache_flags() {
969     global $DB;
970     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
971     return true;
974 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
976 /**
977  * Refresh current $USER session global variable with all their current preferences.
978  * @uses $USER
979  */
980 function check_user_preferences_loaded($time = null) {
981     global $USER, $DB;
982     static $timenow = null; // Static cache, so we only check up-to-dateness once per request.
984     if (!empty($USER->preference) && isset($USER->preference['_lastloaded'])) {
985         // Already loaded. Are we up to date?
987         if (is_null($timenow) || (!is_null($time) && $time != $timenow)) {
988             $timenow = time();
989             if (!get_cache_flag('userpreferenceschanged', $USER->id, $USER->preference['_lastloaded'])) {
990                 // We are up-to-date.
991                 return;
992             }
993         } else {
994             // Already checked for up-to-date-ness.
995             return;
996         }
997     }
999     // OK, so we have to reload. Reset preference
1000     $USER->preference = array();
1002     if (!isloggedin() or isguestuser()) {
1003         // No permanent storage for not-logged-in user and guest
1005     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
1006         foreach ($preferences as $preference) {
1007             $USER->preference[$preference->name] = $preference->value;
1008         }
1009     }
1011     $USER->preference['_lastloaded'] = $timenow;
1014 /**
1015  * Called from set/delete_user_preferences, so that the prefs can be correctly reloaded.
1016  * @param integer $userid the user whose prefs were changed.
1017  */
1018 function mark_user_preferences_changed($userid) {
1019     global $CFG, $USER;
1020     if ($userid == $USER->id) {
1021         check_user_preferences_loaded(time());
1022     }
1023     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1026 /**
1027  * Sets a preference for the current user
1028  * Optionally, can set a preference for a different user object
1029  * @uses $USER
1030  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
1032  * @param string $name The key to set as preference for the specified user
1033  * @param string $value The value to set forthe $name key in the specified user's record
1034  * @param int $otheruserid A moodle user ID
1035  * @return bool
1036  */
1037 function set_user_preference($name, $value, $otheruserid=NULL) {
1038     global $USER, $DB;
1040     if (empty($name)) {
1041         return false;
1042     }
1044     $nostore = false;
1045     if (empty($otheruserid)){
1046         if (!isloggedin() or isguestuser()) {
1047             $nostore = true;
1048         }
1049         $userid = $USER->id;
1050     } else {
1051         if (isguestuser($otheruserid)) {
1052             $nostore = true;
1053         }
1054         $userid = $otheruserid;
1055     }
1057     if ($nostore) {
1058         // no permanent storage for not-logged-in user and guest
1060     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
1061         if ($preference->value === $value) {
1062             return true;
1063         }
1064         $DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id));
1066     } else {
1067         $preference = new object();
1068         $preference->userid = $userid;
1069         $preference->name   = $name;
1070         $preference->value  = (string)$value;
1071         $DB->insert_record('user_preferences', $preference);
1072     }
1074     mark_user_preferences_changed($userid);
1075     // update value in USER session if needed
1076     if ($userid == $USER->id) {
1077         $USER->preference[$name] = (string)$value;
1078         $USER->preference['_lastloaded'] = time();
1079     }
1081     return true;
1084 /**
1085  * Sets a whole array of preferences for the current user
1086  * @param array $prefarray An array of key/value pairs to be set
1087  * @param int $otheruserid A moodle user ID
1088  * @return bool
1089  */
1090 function set_user_preferences($prefarray, $otheruserid=NULL) {
1092     if (!is_array($prefarray) or empty($prefarray)) {
1093         return false;
1094     }
1096     foreach ($prefarray as $name => $value) {
1097         set_user_preference($name, $value, $otheruserid);
1098     }
1099     return true;
1102 /**
1103  * Unsets a preference completely by deleting it from the database
1104  * Optionally, can set a preference for a different user id
1105  * @uses $USER
1106  * @param string  $name The key to unset as preference for the specified user
1107  * @param int $otheruserid A moodle user ID
1108  */
1109 function unset_user_preference($name, $otheruserid=NULL) {
1110     global $USER, $DB;
1112     if (empty($otheruserid)){
1113         $userid = $USER->id;
1114         check_user_preferences_loaded();
1115     } else {
1116         $userid = $otheruserid;
1117     }
1119     //Then from DB
1120     $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
1122     mark_user_preferences_changed($userid);
1123     //Delete the preference from $USER if needed
1124     if ($userid == $USER->id) {
1125         unset($USER->preference[$name]);
1126         $USER->preference['_lastloaded'] = time();
1127     }
1129     return true;
1132 /**
1133  * If no arguments are supplied this function will return
1134  * all of the current user preferences as an array.
1135  * If a name is specified then this function
1136  * attempts to return that particular preference value.  If
1137  * none is found, then the optional value $default is returned,
1138  * otherwise NULL.
1139  * @param string $name Name of the key to use in finding a preference value
1140  * @param string $default Value to be returned if the $name key is not set in the user preferences
1141  * @param int $otheruserid A moodle user ID
1142  * @uses $USER
1143  * @return string
1144  */
1145 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1146     global $USER, $DB;
1148     if (empty($otheruserid) || (!empty($USER->id) && ($USER->id == $otheruserid))){
1149         check_user_preferences_loaded();
1151         if (empty($name)) {
1152             return $USER->preference; // All values
1153         } else if (array_key_exists($name, $USER->preference)) {
1154             return $USER->preference[$name]; // The single value
1155         } else {
1156             return $default; // Default value (or NULL)
1157         }
1159     } else {
1160         if (empty($name)) {
1161             return $DB->get_records_menu('user_preferences', array('userid'=>$otheruserid), '', 'name,value'); // All values
1162         } else if ($value = $DB->get_field('user_preferences', 'value', array('userid'=>$otheruserid, 'name'=>$name))) {
1163             return $value; // The single value
1164         } else {
1165             return $default; // Default value (or NULL)
1166         }
1167     }
1170 /**
1171  * You need to call this function if you wish to use the set_user_preference
1172  * method in javascript_static.php, to white-list the preference you want to update
1173  * from JavaScript, and to specify the type of cleaning you expect to be done on
1174  * values.
1175  *
1176  * @param string $name the name of the user_perference we should allow to be
1177  *      updated by remote calls.
1178  * @param integer $paramtype one of the PARAM_{TYPE} constants, user to clean
1179  *      submitted values before set_user_preference is called.
1180  */
1181 function user_preference_allow_ajax_update($name, $paramtype) {
1182     global $USER;
1184     // Make sure that the required JavaScript libraries are loaded.
1185     require_js(array('yui_yahoo', 'yui_connection'));
1187     // Record in the session that this user_preference is allowed to updated remotely.
1188     $USER->ajax_updatable_user_prefs[$name] = $paramtype;
1191 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1193 /**
1194  * Given date parts in user time produce a GMT timestamp.
1195  *
1196  * @param int $year The year part to create timestamp of
1197  * @param int $month The month part to create timestamp of
1198  * @param int $day The day part to create timestamp of
1199  * @param int $hour The hour part to create timestamp of
1200  * @param int $minute The minute part to create timestamp of
1201  * @param int $second The second part to create timestamp of
1202  * @param float $timezone ?
1203  * @param bool $applydst ?
1204  * @return int timestamp
1205  * @todo Finish documenting this function
1206  */
1207 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1209     $strtimezone = NULL;
1210     if (!is_numeric($timezone)) {
1211         $strtimezone = $timezone;
1212     }
1214     $timezone = get_user_timezone_offset($timezone);
1216     if (abs($timezone) > 13) {
1217         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1218     } else {
1219         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1220         $time = usertime($time, $timezone);
1221         if($applydst) {
1222             $time -= dst_offset_on($time, $strtimezone);
1223         }
1224     }
1226     return $time;
1230 /**
1231  * Given an amount of time in seconds, returns string
1232  * formatted nicely as weeks, days, hours etc as needed
1233  *
1234  * @uses MINSECS
1235  * @uses HOURSECS
1236  * @uses DAYSECS
1237  * @uses YEARSECS
1238  * @param int $totalsecs ?
1239  * @param array $str ?
1240  * @return string
1241  */
1242  function format_time($totalsecs, $str=NULL) {
1244     $totalsecs = abs($totalsecs);
1246     if (!$str) {  // Create the str structure the slow way
1247         $str->day   = get_string('day');
1248         $str->days  = get_string('days');
1249         $str->hour  = get_string('hour');
1250         $str->hours = get_string('hours');
1251         $str->min   = get_string('min');
1252         $str->mins  = get_string('mins');
1253         $str->sec   = get_string('sec');
1254         $str->secs  = get_string('secs');
1255         $str->year  = get_string('year');
1256         $str->years = get_string('years');
1257     }
1260     $years     = floor($totalsecs/YEARSECS);
1261     $remainder = $totalsecs - ($years*YEARSECS);
1262     $days      = floor($remainder/DAYSECS);
1263     $remainder = $totalsecs - ($days*DAYSECS);
1264     $hours     = floor($remainder/HOURSECS);
1265     $remainder = $remainder - ($hours*HOURSECS);
1266     $mins      = floor($remainder/MINSECS);
1267     $secs      = $remainder - ($mins*MINSECS);
1269     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1270     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1271     $sh = ($hours == 1) ? $str->hour : $str->hours;
1272     $sd = ($days == 1)  ? $str->day  : $str->days;
1273     $sy = ($years == 1)  ? $str->year  : $str->years;
1275     $oyears = '';
1276     $odays = '';
1277     $ohours = '';
1278     $omins = '';
1279     $osecs = '';
1281     if ($years)  $oyears  = $years .' '. $sy;
1282     if ($days)  $odays  = $days .' '. $sd;
1283     if ($hours) $ohours = $hours .' '. $sh;
1284     if ($mins)  $omins  = $mins .' '. $sm;
1285     if ($secs)  $osecs  = $secs .' '. $ss;
1287     if ($years) return trim($oyears .' '. $odays);
1288     if ($days)  return trim($odays .' '. $ohours);
1289     if ($hours) return trim($ohours .' '. $omins);
1290     if ($mins)  return trim($omins .' '. $osecs);
1291     if ($secs)  return $osecs;
1292     return get_string('now');
1295 /**
1296  * Returns a formatted string that represents a date in user time
1297  * <b>WARNING: note that the format is for strftime(), not date().</b>
1298  * Because of a bug in most Windows time libraries, we can't use
1299  * the nicer %e, so we have to use %d which has leading zeroes.
1300  * A lot of the fuss in the function is just getting rid of these leading
1301  * zeroes as efficiently as possible.
1302  *
1303  * If parameter fixday = true (default), then take off leading
1304  * zero from %d, else mantain it.
1305  *
1306  * @param int $date the timestamp in UTC, as obtained from the database.
1307  * @param string $format strftime format. You should probably get this using
1308  *      get_string('strftime...', 'langconfig');
1309  * @param float $timezone by default, uses the user's time zone.
1310  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1311  *      If false then the leading zero is mantained.
1312  * @return string the formatted date/time.
1313  */
1314 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1316     global $CFG;
1318     $strtimezone = NULL;
1319     if (!is_numeric($timezone)) {
1320         $strtimezone = $timezone;
1321     }
1323     if (empty($format)) {
1324         $format = get_string('strftimedaydatetime', 'langconfig');
1325     }
1327     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1328         $fixday = false;
1329     } else if ($fixday) {
1330         $formatnoday = str_replace('%d', 'DD', $format);
1331         $fixday = ($formatnoday != $format);
1332     }
1334     $date += dst_offset_on($date, $strtimezone);
1336     $timezone = get_user_timezone_offset($timezone);
1338     if (abs($timezone) > 13) {   /// Server time
1339         if ($fixday) {
1340             $datestring = strftime($formatnoday, $date);
1341             $daystring  = str_replace(array(' 0', ' '), '', strftime(' %d', $date));
1342             $datestring = str_replace('DD', $daystring, $datestring);
1343         } else {
1344             $datestring = strftime($format, $date);
1345         }
1346     } else {
1347         $date += (int)($timezone * 3600);
1348         if ($fixday) {
1349             $datestring = gmstrftime($formatnoday, $date);
1350             $daystring  = str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date));
1351             $datestring = str_replace('DD', $daystring, $datestring);
1352         } else {
1353             $datestring = gmstrftime($format, $date);
1354         }
1355     }
1357 /// If we are running under Windows convert from windows encoding to UTF-8
1358 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1360    if ($CFG->ostype == 'WINDOWS') {
1361        if ($localewincharset = get_string('localewincharset')) {
1362            $textlib = textlib_get_instance();
1363            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1364        }
1365    }
1367     return $datestring;
1370 /**
1371  * Given a $time timestamp in GMT (seconds since epoch),
1372  * returns an array that represents the date in user time
1373  *
1374  * @uses HOURSECS
1375  * @param int $time Timestamp in GMT
1376  * @param float $timezone ?
1377  * @return array An array that represents the date in user time
1378  * @todo Finish documenting this function
1379  */
1380 function usergetdate($time, $timezone=99) {
1382     $strtimezone = NULL;
1383     if (!is_numeric($timezone)) {
1384         $strtimezone = $timezone;
1385     }
1387     $timezone = get_user_timezone_offset($timezone);
1389     if (abs($timezone) > 13) {    // Server time
1390         return getdate($time);
1391     }
1393     // There is no gmgetdate so we use gmdate instead
1394     $time += dst_offset_on($time, $strtimezone);
1395     $time += intval((float)$timezone * HOURSECS);
1397     $datestring = gmstrftime('%S_%M_%H_%d_%m_%Y_%w_%j_%A_%B', $time);
1399     list(
1400         $getdate['seconds'],
1401         $getdate['minutes'],
1402         $getdate['hours'],
1403         $getdate['mday'],
1404         $getdate['mon'],
1405         $getdate['year'],
1406         $getdate['wday'],
1407         $getdate['yday'],
1408         $getdate['weekday'],
1409         $getdate['month']
1410     ) = explode('_', $datestring);
1412     return $getdate;
1415 /**
1416  * Given a GMT timestamp (seconds since epoch), offsets it by
1417  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1418  *
1419  * @uses HOURSECS
1420  * @param  int $date Timestamp in GMT
1421  * @param float $timezone
1422  * @return int
1423  */
1424 function usertime($date, $timezone=99) {
1426     $timezone = get_user_timezone_offset($timezone);
1428     if (abs($timezone) > 13) {
1429         return $date;
1430     }
1431     return $date - (int)($timezone * HOURSECS);
1434 /**
1435  * Given a time, return the GMT timestamp of the most recent midnight
1436  * for the current user.
1437  *
1438  * @param int $date Timestamp in GMT
1439  * @param float $timezone ?
1440  * @return ?
1441  */
1442 function usergetmidnight($date, $timezone=99) {
1444     $userdate = usergetdate($date, $timezone);
1446     // Time of midnight of this user's day, in GMT
1447     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1451 /**
1452  * Returns a string that prints the user's timezone
1453  *
1454  * @param float $timezone The user's timezone
1455  * @return string
1456  */
1457 function usertimezone($timezone=99) {
1459     $tz = get_user_timezone($timezone);
1461     if (!is_float($tz)) {
1462         return $tz;
1463     }
1465     if(abs($tz) > 13) { // Server time
1466         return get_string('serverlocaltime');
1467     }
1469     if($tz == intval($tz)) {
1470         // Don't show .0 for whole hours
1471         $tz = intval($tz);
1472     }
1474     if($tz == 0) {
1475         return 'UTC';
1476     }
1477     else if($tz > 0) {
1478         return 'UTC+'.$tz;
1479     }
1480     else {
1481         return 'UTC'.$tz;
1482     }
1486 /**
1487  * Returns a float which represents the user's timezone difference from GMT in hours
1488  * Checks various settings and picks the most dominant of those which have a value
1489  *
1490  * @uses $CFG
1491  * @uses $USER
1492  * @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
1493  * @return int
1494  */
1495 function get_user_timezone_offset($tz = 99) {
1497     global $USER, $CFG;
1499     $tz = get_user_timezone($tz);
1501     if (is_float($tz)) {
1502         return $tz;
1503     } else {
1504         $tzrecord = get_timezone_record($tz);
1505         if (empty($tzrecord)) {
1506             return 99.0;
1507         }
1508         return (float)$tzrecord->gmtoff / HOURMINS;
1509     }
1512 /**
1513  * Returns an int which represents the systems's timezone difference from GMT in seconds
1514  * @param mixed $tz timezone
1515  * @return int if found, false is timezone 99 or error
1516  */
1517 function get_timezone_offset($tz) {
1518     global $CFG;
1520     if ($tz == 99) {
1521         return false;
1522     }
1524     if (is_numeric($tz)) {
1525         return intval($tz * 60*60);
1526     }
1528     if (!$tzrecord = get_timezone_record($tz)) {
1529         return false;
1530     }
1531     return intval($tzrecord->gmtoff * 60);
1534 /**
1535  * Returns a float or a string which denotes the user's timezone
1536  * 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)
1537  * means that for this timezone there are also DST rules to be taken into account
1538  * Checks various settings and picks the most dominant of those which have a value
1539  *
1540  * @uses $USER
1541  * @uses $CFG
1542  * @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
1543  * @return mixed
1544  */
1545 function get_user_timezone($tz = 99) {
1546     global $USER, $CFG;
1548     $timezones = array(
1549         $tz,
1550         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1551         isset($USER->timezone) ? $USER->timezone : 99,
1552         isset($CFG->timezone) ? $CFG->timezone : 99,
1553         );
1555     $tz = 99;
1557     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1558         $tz = $next['value'];
1559     }
1561     return is_numeric($tz) ? (float) $tz : $tz;
1564 /**
1565  * Returns cached timezone record for given $timezonename
1566  *
1567  * @param string $timezonename
1568  * @return mixed timezonerecord object or false
1569  */
1570 function get_timezone_record($timezonename) {
1571     global $CFG, $DB;
1572     static $cache = NULL;
1574     if ($cache === NULL) {
1575         $cache = array();
1576     }
1578     if (isset($cache[$timezonename])) {
1579         return $cache[$timezonename];
1580     }
1582     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1583                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1586 /**
1587  * ?
1588  *
1589  * @uses $CFG
1590  * @uses $USER
1591  * @param ? $fromyear ?
1592  * @param ? $to_year ?
1593  * @return bool
1594  */
1595 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1596     global $CFG, $SESSION, $DB;
1598     $usertz = get_user_timezone($strtimezone);
1600     if (is_float($usertz)) {
1601         // Trivial timezone, no DST
1602         return false;
1603     }
1605     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1606         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1607         unset($SESSION->dst_offsets);
1608         unset($SESSION->dst_range);
1609     }
1611     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1612         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1613         // This will be the return path most of the time, pretty light computationally
1614         return true;
1615     }
1617     // Reaching here means we either need to extend our table or create it from scratch
1619     // Remember which TZ we calculated these changes for
1620     $SESSION->dst_offsettz = $usertz;
1622     if(empty($SESSION->dst_offsets)) {
1623         // If we 're creating from scratch, put the two guard elements in there
1624         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1625     }
1626     if(empty($SESSION->dst_range)) {
1627         // If creating from scratch
1628         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1629         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1631         // Fill in the array with the extra years we need to process
1632         $yearstoprocess = array();
1633         for($i = $from; $i <= $to; ++$i) {
1634             $yearstoprocess[] = $i;
1635         }
1637         // Take note of which years we have processed for future calls
1638         $SESSION->dst_range = array($from, $to);
1639     }
1640     else {
1641         // If needing to extend the table, do the same
1642         $yearstoprocess = array();
1644         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1645         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1647         if($from < $SESSION->dst_range[0]) {
1648             // Take note of which years we need to process and then note that we have processed them for future calls
1649             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1650                 $yearstoprocess[] = $i;
1651             }
1652             $SESSION->dst_range[0] = $from;
1653         }
1654         if($to > $SESSION->dst_range[1]) {
1655             // Take note of which years we need to process and then note that we have processed them for future calls
1656             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1657                 $yearstoprocess[] = $i;
1658             }
1659             $SESSION->dst_range[1] = $to;
1660         }
1661     }
1663     if(empty($yearstoprocess)) {
1664         // This means that there was a call requesting a SMALLER range than we have already calculated
1665         return true;
1666     }
1668     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1669     // Also, the array is sorted in descending timestamp order!
1671     // Get DB data
1673     static $presets_cache = array();
1674     if (!isset($presets_cache[$usertz])) {
1675         $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');
1676     }
1677     if(empty($presets_cache[$usertz])) {
1678         return false;
1679     }
1681     // Remove ending guard (first element of the array)
1682     reset($SESSION->dst_offsets);
1683     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1685     // Add all required change timestamps
1686     foreach($yearstoprocess as $y) {
1687         // Find the record which is in effect for the year $y
1688         foreach($presets_cache[$usertz] as $year => $preset) {
1689             if($year <= $y) {
1690                 break;
1691             }
1692         }
1694         $changes = dst_changes_for_year($y, $preset);
1696         if($changes === NULL) {
1697             continue;
1698         }
1699         if($changes['dst'] != 0) {
1700             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1701         }
1702         if($changes['std'] != 0) {
1703             $SESSION->dst_offsets[$changes['std']] = 0;
1704         }
1705     }
1707     // Put in a guard element at the top
1708     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1709     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1711     // Sort again
1712     krsort($SESSION->dst_offsets);
1714     return true;
1717 function dst_changes_for_year($year, $timezone) {
1719     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1720         return NULL;
1721     }
1723     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1724     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1726     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1727     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1729     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1730     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1732     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1733     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1734     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1736     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1737     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1739     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1742 // $time must NOT be compensated at all, it has to be a pure timestamp
1743 function dst_offset_on($time, $strtimezone = NULL) {
1744     global $SESSION;
1746     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
1747         return 0;
1748     }
1750     reset($SESSION->dst_offsets);
1751     while(list($from, $offset) = each($SESSION->dst_offsets)) {
1752         if($from <= $time) {
1753             break;
1754         }
1755     }
1757     // This is the normal return path
1758     if($offset !== NULL) {
1759         return $offset;
1760     }
1762     // Reaching this point means we haven't calculated far enough, do it now:
1763     // Calculate extra DST changes if needed and recurse. The recursion always
1764     // moves toward the stopping condition, so will always end.
1766     if($from == 0) {
1767         // We need a year smaller than $SESSION->dst_range[0]
1768         if($SESSION->dst_range[0] == 1971) {
1769             return 0;
1770         }
1771         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
1772         return dst_offset_on($time, $strtimezone);
1773     }
1774     else {
1775         // We need a year larger than $SESSION->dst_range[1]
1776         if($SESSION->dst_range[1] == 2035) {
1777             return 0;
1778         }
1779         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
1780         return dst_offset_on($time, $strtimezone);
1781     }
1784 function find_day_in_month($startday, $weekday, $month, $year) {
1786     $daysinmonth = days_in_month($month, $year);
1788     if($weekday == -1) {
1789         // Don't care about weekday, so return:
1790         //    abs($startday) if $startday != -1
1791         //    $daysinmonth otherwise
1792         return ($startday == -1) ? $daysinmonth : abs($startday);
1793     }
1795     // From now on we 're looking for a specific weekday
1797     // Give "end of month" its actual value, since we know it
1798     if($startday == -1) {
1799         $startday = -1 * $daysinmonth;
1800     }
1802     // Starting from day $startday, the sign is the direction
1804     if($startday < 1) {
1806         $startday = abs($startday);
1807         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1809         // This is the last such weekday of the month
1810         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
1811         if($lastinmonth > $daysinmonth) {
1812             $lastinmonth -= 7;
1813         }
1815         // Find the first such weekday <= $startday
1816         while($lastinmonth > $startday) {
1817             $lastinmonth -= 7;
1818         }
1820         return $lastinmonth;
1822     }
1823     else {
1825         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
1827         $diff = $weekday - $indexweekday;
1828         if($diff < 0) {
1829             $diff += 7;
1830         }
1832         // This is the first such weekday of the month equal to or after $startday
1833         $firstfromindex = $startday + $diff;
1835         return $firstfromindex;
1837     }
1840 /**
1841  * Calculate the number of days in a given month
1842  *
1843  * @param int $month The month whose day count is sought
1844  * @param int $year The year of the month whose day count is sought
1845  * @return int
1846  */
1847 function days_in_month($month, $year) {
1848    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
1851 /**
1852  * Calculate the position in the week of a specific calendar day
1853  *
1854  * @param int $day The day of the date whose position in the week is sought
1855  * @param int $month The month of the date whose position in the week is sought
1856  * @param int $year The year of the date whose position in the week is sought
1857  * @return int
1858  */
1859 function dayofweek($day, $month, $year) {
1860     // I wonder if this is any different from
1861     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1862     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
1865 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
1867 /**
1868  * Setup all global $CFG course variables, set locale and also themes
1869  * This function can be used on pages that do not require login instead of require_login()
1870  *
1871  * @param mixed $courseorid id of the course or course object
1872  */
1873 function course_setup($courseorid=0) {
1874     global $COURSE, $SITE, $DB;
1876 /// Redefine global $COURSE if needed
1877     if (empty($courseorid)) {
1878         // no change in global $COURSE - for backwards compatibiltiy
1879         // if require_rogin() used after require_login($courseid);
1880     } else if (is_object($courseorid)) {
1881         $COURSE = clone($courseorid);
1882     } else {
1883         if ($courseorid == SITEID) {
1884             $COURSE = clone($SITE);
1885         } else {
1886             if (!$COURSE = $DB->get_record('course', array('id'=>$courseorid))) {
1887                 print_error('invalidcourseid');
1888             }
1889         }
1890     }
1892 /// set locale and themes
1893     moodle_setlocale();
1894     theme_setup();
1898 /**
1899  * Returns full login url.
1900  *
1901  * @param bool $loginguest add login guest param
1902  * @return string login url
1903  */
1904 function get_login_url($loginguest=false) {
1905     global $CFG;
1907     if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
1908         $loginguest = $loginguest ? '?loginguest=true' : '';
1909         $url = "$CFG->wwwroot/login/index.php$loginguest";
1911     } else {
1912         $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1913         $url = "$wwwroot/login/index.php";
1914     }
1916     return $url;
1919 /**
1920  * This function checks that the current user is logged in and has the
1921  * required privileges
1922  *
1923  * This function checks that the current user is logged in, and optionally
1924  * whether they are allowed to be in a particular course and view a particular
1925  * course module.
1926  * If they are not logged in, then it redirects them to the site login unless
1927  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
1928  * case they are automatically logged in as guests.
1929  * If $courseid is given and the user is not enrolled in that course then the
1930  * user is redirected to the course enrolment page.
1931  * If $cm is given and the coursemodule is hidden and the user is not a teacher
1932  * in the course then the user is redirected to the course home page.
1933  *
1934  * @uses $CFG
1935  * @uses $SESSION
1936  * @uses $USER
1937  * @uses $FULLME
1938  * @uses SITEID
1939  * @uses $COURSE
1940  * @param mixed $courseorid id of the course or course object
1941  * @param bool $autologinguest
1942  * @param object $cm course module object
1943  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
1944  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
1945  *             in order to keep redirects working properly. MDL-14495
1946  */
1947 function require_login($courseorid=0, $autologinguest=true, $cm=null, $setwantsurltome=true) {
1948     global $CFG, $SESSION, $USER, $COURSE, $FULLME;
1950 /// setup global $COURSE, themes, language and locale
1951     course_setup($courseorid);
1953 /// If the user is not even logged in yet then make sure they are
1954     if (!isloggedin()) {
1955         //NOTE: $USER->site check was obsoleted by session test cookie,
1956         //      $USER->confirmed test is in login/index.php
1957         if ($setwantsurltome) {
1958             $SESSION->wantsurl = $FULLME;
1959         }
1960         if (!empty($_SERVER['HTTP_REFERER'])) {
1961             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
1962         }
1963         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests) and ($COURSE->id == SITEID or $COURSE->guest) ) {
1964             $loginguest = true;
1965         } else {
1966             $loginguest = false;
1967         }
1968         redirect(get_login_url($loginguest));
1969         exit; // never reached
1970     }
1972 /// loginas as redirection if needed
1973     if ($COURSE->id != SITEID and session_is_loggedinas()) {
1974         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
1975             if ($USER->loginascontext->instanceid != $COURSE->id) {
1976                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
1977             }
1978         }
1979     }
1981 /// check whether the user should be changing password (but only if it is REALLY them)
1982     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
1983         $userauth = get_auth_plugin($USER->auth);
1984         if ($userauth->can_change_password()) {
1985             $SESSION->wantsurl = $FULLME;
1986             if ($changeurl = $userauth->change_password_url()) {
1987                 //use plugin custom url
1988                 redirect($changeurl);
1989             } else {
1990                 //use moodle internal method
1991                 if (empty($CFG->loginhttps)) {
1992                     redirect($CFG->wwwroot .'/login/change_password.php');
1993                 } else {
1994                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
1995                     redirect($wwwroot .'/login/change_password.php');
1996                 }
1997             }
1998         } else {
1999             print_error('nopasswordchangeforced', 'auth');
2000         }
2001     }
2003 /// Check that the user account is properly set up
2004     if (user_not_fully_set_up($USER)) {
2005         $SESSION->wantsurl = $FULLME;
2006         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2007     }
2009 /// Make sure the USER has a sesskey set up.  Used for checking script parameters.
2010     sesskey();
2012     // Check that the user has agreed to a site policy if there is one
2013     if (!empty($CFG->sitepolicy)) {
2014         if (!$USER->policyagreed) {
2015             $SESSION->wantsurl = $FULLME;
2016             redirect($CFG->wwwroot .'/user/policy.php');
2017         }
2018     }
2020     // Fetch the system context, we are going to use it a lot.
2021     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2023 /// If the site is currently under maintenance, then print a message
2024     if (!has_capability('moodle/site:config', $sysctx)) {
2025         if (file_exists($CFG->dataroot.'/'.SITEID.'/maintenance.html')) {
2026             print_maintenance_message();
2027             exit;
2028         }
2029     }
2031 /// groupmembersonly access control
2032     if (!empty($CFG->enablegroupings) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2033         if (isguestuser() or !groups_has_membership($cm)) {
2034             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2035         }
2036     }
2038     // Fetch the course context, and prefetch its child contexts
2039     if (!isset($COURSE->context)) {
2040         if ( ! $COURSE->context = get_context_instance(CONTEXT_COURSE, $COURSE->id) ) {
2041             print_error('nocontext');
2042         }
2043     }
2044     if (!empty($cm) && !isset($cm->context)) {
2045         if ( ! $cm->context = get_context_instance(CONTEXT_MODULE, $cm->id) ) {
2046             print_error('nocontext');
2047         }
2048     }
2050     // Conditional activity access control
2051     if(!empty($CFG->enableavailability) and $cm) {
2052         // We cache conditional access in session
2053         if(!isset($SESSION->conditionaccessok)) {
2054             $SESSION->conditionaccessok = array();
2055         }
2056         // If you have been allowed into the module once then you are allowed
2057         // in for rest of session, no need to do conditional checks
2058         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2059             // Get condition info (does a query for the availability table)
2060             require_once($CFG->libdir.'/conditionlib.php');
2061             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2062             // Check condition for user (this will do a query if the availability
2063             // information depends on grade or completion information)
2064             if ($ci->is_available($junk) ||
2065                 has_capability('moodle/course:viewhiddenactivities', $cm->context)) {
2066                 $SESSION->conditionaccessok[$cm->id] = true;
2067             } else {
2068                 print_error('activityiscurrentlyhidden');
2069             }
2070         }
2071     }
2073     if ($COURSE->id == SITEID) {
2074         /// Eliminate hidden site activities straight away
2075         if (!empty($cm) && !$cm->visible
2076             && !has_capability('moodle/course:viewhiddenactivities', $cm->context)) {
2077             redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2078         }
2079         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2080         return;
2082     } else {
2084         /// Check if the user can be in a particular course
2085         if (empty($USER->access['rsw'][$COURSE->context->path])) {
2086             //
2087             // MDL-13900 - If the course or the parent category are hidden
2088             // and the user hasn't the 'course:viewhiddencourses' capability, prevent access
2089             //
2090             if ( !($COURSE->visible && course_parent_visible($COURSE)) &&
2091                    !has_capability('moodle/course:viewhiddencourses', $COURSE->context)) {
2092                 print_header_simple();
2093                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2094             }
2095         }
2097     /// Non-guests who don't currently have access, check if they can be allowed in as a guest
2099         if ($USER->username != 'guest' and !has_capability('moodle/course:view', $COURSE->context)) {
2100             if ($COURSE->guest == 1) {
2101                  // Temporarily assign them guest role for this context, if it fails later user is asked to enrol
2102                  $USER->access = load_temp_role($COURSE->context, $CFG->guestroleid, $USER->access);
2103             }
2104         }
2106     /// If the user is a guest then treat them according to the course policy about guests
2108         if (has_capability('moodle/legacy:guest', $COURSE->context, NULL, false)) {
2109             if (has_capability('moodle/site:doanything', $sysctx)) {
2110                 // administrators must be able to access any course - even if somebody gives them guest access
2111                 user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2112                 return;
2113             }
2115             switch ($COURSE->guest) {    /// Check course policy about guest access
2117                 case 1:    /// Guests always allowed
2118                     if (!has_capability('moodle/course:view', $COURSE->context)) {    // Prohibited by capability
2119                         print_header_simple();
2120                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), get_login_url());
2121                     }
2122                     if (!empty($cm) and !$cm->visible) { // Not allowed to see module, send to course page
2123                         redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course,
2124                                  get_string('activityiscurrentlyhidden'));
2125                     }
2127                     user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2128                     return;   // User is allowed to see this course
2130                     break;
2132                 case 2:    /// Guests allowed with key
2133                     if (!empty($USER->enrolkey[$COURSE->id])) {   // Set by enrol/manual/enrol.php
2134                         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2135                         return true;
2136                     }
2137                     //  otherwise drop through to logic below (--> enrol.php)
2138                     break;
2140                 default:    /// Guests not allowed
2141                     $strloggedinasguest = get_string('loggedinasguest');
2142                     print_header_simple('', '',
2143                             build_navigation(array(array('name' => $strloggedinasguest, 'link' => null, 'type' => 'misc'))));
2144                     if (empty($USER->access['rsw'][$COURSE->context->path])) {  // Normal guest
2145                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), get_login_url());
2146                     } else {
2147                         notify(get_string('guestsnotallowed', '', format_string($COURSE->fullname)));
2148                         echo '<div class="notifyproblem">'.switchroles_form($COURSE->id).'</div>';
2149                         print_footer($COURSE);
2150                         exit;
2151                     }
2152                     break;
2153             }
2155     /// For non-guests, check if they have course view access
2157         } else if (has_capability('moodle/course:view', $COURSE->context)) {
2158             if (session_is_loggedinas()) {   // Make sure the REAL person can also access this course
2159                 $realuser = session_get_realuser();
2160                 if (!has_capability('moodle/course:view', $COURSE->context, $realuser->id)) {
2161                     print_header_simple();
2162                     notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2163                 }
2164             }
2166         /// Make sure they can read this activity too, if specified
2168             if (!empty($cm) && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cm->context)) {
2169                 redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course, get_string('activityiscurrentlyhidden'));
2170             }
2171             user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2172             return;   // User is allowed to see this course
2174         }
2177     /// Currently not enrolled in the course, so see if they want to enrol
2178         $SESSION->wantsurl = $FULLME;
2179         redirect($CFG->wwwroot .'/course/enrol.php?id='. $COURSE->id);
2180         die;
2181     }
2186 /**
2187  * This function just makes sure a user is logged out.
2188  *
2189  * @uses $CFG
2190  * @uses $USER
2191  */
2192 function require_logout() {
2193     global $USER;
2195     if (isloggedin()) {
2196         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2198         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2199         foreach($authsequence as $authname) {
2200             $authplugin = get_auth_plugin($authname);
2201             $authplugin->prelogout_hook();
2202         }
2203     }
2205     session_get_instance()->terminate_current();
2208 /**
2209  * This is a weaker version of {@link require_login()} which only requires login
2210  * when called from within a course rather than the site page, unless
2211  * the forcelogin option is turned on.
2212  *
2213  * @uses $CFG
2214  * @param mixed $courseorid The course object or id in question
2215  * @param bool $autologinguest Allow autologin guests if that is wanted
2216  * @param object $cm Course activity module if known
2217  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2218  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2219  *             in order to keep redirects working properly. MDL-14495
2220  */
2221 function require_course_login($courseorid, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2222     global $CFG;
2223     if (!empty($CFG->forcelogin)) {
2224         // login required for both SITE and courses
2225         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2227     } else if (!empty($cm) and !$cm->visible) {
2228         // always login for hidden activities
2229         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2231     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2232           or (!is_object($courseorid) and $courseorid == SITEID)) {
2233         //login for SITE not required
2234         user_accesstime_log(SITEID);
2235         return;
2237     } else {
2238         // course login always required
2239         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2240     }
2243 /**
2244  * Require key login. Function terminates with error if key not found or incorrect.
2245  * @param string $script unique script identifier
2246  * @param int $instance optional instance id
2247  */
2248 function require_user_key_login($script, $instance=null) {
2249     global $USER, $SESSION, $CFG, $DB;
2251     if (!NO_MOODLE_COOKIES) {
2252         print_error('sessioncookiesdisable');
2253     }
2255 /// extra safety
2256     @session_write_close();
2258     $keyvalue = required_param('key', PARAM_ALPHANUM);
2260     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2261         print_error('invalidkey');
2262     }
2264     if (!empty($key->validuntil) and $key->validuntil < time()) {
2265         print_error('expiredkey');
2266     }
2268     if ($key->iprestriction) {
2269         $remoteaddr = getremoteaddr();
2270         if ($remoteaddr == '' or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2271             print_error('ipmismatch');
2272         }
2273     }
2275     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2276         print_error('invaliduserid');
2277     }
2279 /// emulate normal session
2280     session_set_user($user);
2282 /// note we are not using normal login
2283     if (!defined('USER_KEY_LOGIN')) {
2284         define('USER_KEY_LOGIN', true);
2285     }
2287 /// return isntance id - it might be empty
2288     return $key->instance;
2291 /**
2292  * Creates a new private user access key.
2293  * @param string $script unique target identifier
2294  * @param int $userid
2295  * @param instance $int optional instance id
2296  * @param string $iprestriction optional ip restricted access
2297  * @param timestamp $validuntil key valid only until given data
2298  * @return string access key value
2299  */
2300 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2301     global $DB;
2303     $key = new object();
2304     $key->script        = $script;
2305     $key->userid        = $userid;
2306     $key->instance      = $instance;
2307     $key->iprestriction = $iprestriction;
2308     $key->validuntil    = $validuntil;
2309     $key->timecreated   = time();
2311     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2312     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2313         // must be unique
2314         $key->value     = md5($userid.'_'.time().random_string(40));
2315     }
2317     if (!$DB->insert_record('user_private_key', $key)) {
2318         print_error('cannotinsertkey');
2319     }
2321     return $key->value;
2324 /**
2325  * Modify the user table by setting the currently logged in user's
2326  * last login to now.
2327  *
2328  * @uses $USER
2329  * @return bool
2330  */
2331 function update_user_login_times() {
2332     global $USER, $DB;
2334     $user = new object();
2335     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2336     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2338     $user->id = $USER->id;
2340     $DB->update_record('user', $user);
2341     return true;
2344 /**
2345  * Determines if a user has completed setting up their account.
2346  *
2347  * @param user $user A {@link $USER} object to test for the existance of a valid name and email
2348  * @return bool
2349  */
2350 function user_not_fully_set_up($user) {
2351     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2354 function over_bounce_threshold($user) {
2355     global $CFG, $DB;
2357     if (empty($CFG->handlebounces)) {
2358         return false;
2359     }
2361     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2362         return false;
2363     }
2365     // set sensible defaults
2366     if (empty($CFG->minbounces)) {
2367         $CFG->minbounces = 10;
2368     }
2369     if (empty($CFG->bounceratio)) {
2370         $CFG->bounceratio = .20;
2371     }
2372     $bouncecount = 0;
2373     $sendcount = 0;
2374     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2375         $bouncecount = $bounce->value;
2376     }
2377     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2378         $sendcount = $send->value;
2379     }
2380     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2383 /**
2384  * @param $user - object containing an id
2385  * @param $reset - will reset the count to 0
2386  */
2387 function set_send_count($user,$reset=false) {
2388     global $DB;
2390     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2391         return;
2392     }
2394     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2395         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2396         $DB->update_record('user_preferences', $pref);
2397     }
2398     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2399         // make a new one
2400         $pref = new object();
2401         $pref->name   = 'email_send_count';
2402         $pref->value  = 1;
2403         $pref->userid = $user->id;
2404         $DB->insert_record('user_preferences', $pref, false);
2405     }
2408 /**
2409 * @param $user - object containing an id
2410  * @param $reset - will reset the count to 0
2411  */
2412 function set_bounce_count($user,$reset=false) {
2413     global $DB;
2415     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2416         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2417         $DB->update_record('user_preferences', $pref);
2418     }
2419     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2420         // make a new one
2421         $pref = new object();
2422         $pref->name   = 'email_bounce_count';
2423         $pref->value  = 1;
2424         $pref->userid = $user->id;
2425         $DB->insert_record('user_preferences', $pref, false);
2426     }
2429 /**
2430  * Keeps track of login attempts
2431  *
2432  * @uses $SESSION
2433  */
2434 function update_login_count() {
2435     global $SESSION;
2437     $max_logins = 10;
2439     if (empty($SESSION->logincount)) {
2440         $SESSION->logincount = 1;
2441     } else {
2442         $SESSION->logincount++;
2443     }
2445     if ($SESSION->logincount > $max_logins) {
2446         unset($SESSION->wantsurl);
2447         print_error('errortoomanylogins');
2448     }
2451 /**
2452  * Resets login attempts
2453  *
2454  * @uses $SESSION
2455  */
2456 function reset_login_count() {
2457     global $SESSION;
2459     $SESSION->logincount = 0;
2462 function sync_metacourses() {
2463     global $DB;
2465     if (!$courses = $DB->get_records('course', array('metacourse'=>1))) {
2466         return;
2467     }
2469     foreach ($courses as $course) {
2470         sync_metacourse($course);
2471     }
2474 /**
2475  * Goes through all enrolment records for the courses inside the metacourse and sync with them.
2476  *
2477  * @param mixed $course the metacourse to synch. Either the course object itself, or the courseid.
2478  */
2479 function sync_metacourse($course) {
2480     global $CFG, $DB;
2482     // Check the course is valid.
2483     if (!is_object($course)) {
2484         if (!$course = $DB->get_record('course', array('id'=>$course))) {
2485             return false; // invalid course id
2486         }
2487     }
2489     // Check that we actually have a metacourse.
2490     if (empty($course->metacourse)) {
2491         return false;
2492     }
2494     // Get a list of roles that should not be synced.
2495     if (!empty($CFG->nonmetacoursesyncroleids)) {
2496         $roleexclusions = 'ra.roleid NOT IN (' . $CFG->nonmetacoursesyncroleids . ') AND';
2497     } else {
2498         $roleexclusions = '';
2499     }
2501     // Get the context of the metacourse.
2502     $context = get_context_instance(CONTEXT_COURSE, $course->id); // SITEID can not be a metacourse
2504     // We do not ever want to unassign the list of metacourse manager, so get a list of them.
2505     if ($users = get_users_by_capability($context, 'moodle/course:managemetacourse')) {
2506         $managers = array_keys($users);
2507     } else {
2508         $managers = array();
2509     }
2511     // Get assignments of a user to a role that exist in a child course, but
2512     // not in the meta coure. That is, get a list of the assignments that need to be made.
2513     if (!$assignments = $DB->get_records_sql("
2514             SELECT ra.id, ra.roleid, ra.userid
2515               FROM {role_assignments} ra, {context} con, {course_meta} cm
2516              WHERE ra.contextid = con.id AND
2517                    con.contextlevel = ".CONTEXT_COURSE." AND
2518                    con.instanceid = cm.child_course AND
2519                    cm.parent_course = ? AND
2520                    $roleexclusions
2521                    NOT EXISTS (
2522                      SELECT 1
2523                        FROM {role_assignments} ra2
2524                       WHERE ra2.userid = ra.userid AND
2525                             ra2.roleid = ra.roleid AND
2526                             ra2.contextid = ?
2527                   )", array($course->id, $context->id))) {
2528         $assignments = array();
2529     }
2531     // Get assignments of a user to a role that exist in the meta course, but
2532     // not in any child courses. That is, get a list of the unassignments that need to be made.
2533     if (!$unassignments = $DB->get_records_sql("
2534             SELECT ra.id, ra.roleid, ra.userid
2535               FROM {role_assignments} ra
2536              WHERE ra.contextid = ? AND
2537                    $roleexclusions
2538                    NOT EXISTS (
2539                     SELECT 1
2540                       FROM {role_assignments} ra2, {context} con2, {course_meta} cm
2541                     WHERE ra2.userid = ra.userid AND
2542                           ra2.roleid = ra.roleid AND
2543                           ra2.contextid = con2.id AND
2544                           con2.contextlevel = " . CONTEXT_COURSE . " AND
2545                           con2.instanceid = cm.child_course AND
2546                           cm.parent_course = ?
2547                   )", array($context->id, $course->id))) {
2548         $unassignments = array();
2549     }
2551     $success = true;
2553     // Make the unassignments, if they are not managers.
2554     foreach ($unassignments as $unassignment) {
2555         if (!in_array($unassignment->userid, $managers)) {
2556             $success = role_unassign($unassignment->roleid, $unassignment->userid, 0, $context->id) && $success;
2557         }
2558     }
2560     // Make the assignments.
2561     foreach ($assignments as $assignment) {
2562         $success = role_assign($assignment->roleid, $assignment->userid, 0, $context->id) && $success;
2563     }
2565     return $success;
2567 // TODO: finish timeend and timestart
2568 // maybe we could rely on cron job to do the cleaning from time to time
2571 /**
2572  * Adds a record to the metacourse table and calls sync_metacoures
2573  */
2574 function add_to_metacourse ($metacourseid, $courseid) {
2575     global $DB;
2577     if (!$metacourse = $DB->get_record("course", array("id"=>$metacourseid))) {
2578         return false;
2579     }
2581     if (!$course = $DB->get_record("course", array("id"=>$courseid))) {
2582         return false;
2583     }
2585     if (!$record = $DB->get_record("course_meta", array("parent_course"=>$metacourseid, "child_course"=>$courseid))) {
2586         $rec = new object();
2587         $rec->parent_course = $metacourseid;
2588         $rec->child_course  = $courseid;
2589         $DB->insert_record('course_meta', $rec);
2590         return sync_metacourse($metacourseid);
2591     }
2592     return true;
2596 /**
2597  * Removes the record from the metacourse table and calls sync_metacourse
2598  */
2599 function remove_from_metacourse($metacourseid, $courseid) {
2600     global $DB;
2602     if ($DB->delete_records('course_meta', array('parent_course'=>$metacourseid, 'child_course'=>$courseid))) {
2603         return sync_metacourse($metacourseid);
2604     }
2605     return false;
2609 /**
2610  * Determines if a user is currently logged in
2611  *
2612  * @uses $USER
2613  * @return bool
2614  */
2615 function isloggedin() {
2616     global $USER;
2618     return (!empty($USER->id));
2621 /**
2622  * Determines if a user is logged in as real guest user with username 'guest'.
2623  * This function is similar to original isguest() in 1.6 and earlier.
2624  * Current isguest() is deprecated - do not use it anymore.
2625  *
2626  * @param $user mixed user object or id, $USER if not specified
2627  * @return bool true if user is the real guest user, false if not logged in or other user
2628  */
2629 function isguestuser($user=NULL) {
2630     global $USER, $DB;
2632     if ($user === NULL) {
2633         $user = $USER;
2634     } else if (is_numeric($user)) {
2635         $user = $DB->get_record('user', array('id'=>$user), 'id, username');
2636     }
2638     if (empty($user->id)) {
2639         return false; // not logged in, can not be guest
2640     }
2642     return ($user->username == 'guest');
2645 /**
2646  * Determines if the currently logged in user is in editing mode.
2647  * Note: originally this function had $userid parameter - it was not usable anyway
2648  *
2649  * @uses $USER, $PAGE
2650  * @return bool
2651  */
2652 function isediting() {
2653     global $USER, $PAGE;
2655     if (empty($USER->editing)) {
2656         return false;
2657     } elseif (is_object($PAGE) && method_exists($PAGE,'user_allowed_editing')) {
2658         return $PAGE->user_allowed_editing();
2659     }
2660     return true;//false;
2663 /**
2664  * Determines if the logged in user is currently moving an activity
2665  *
2666  * @uses $USER
2667  * @param int $courseid The id of the course being tested
2668  * @return bool
2669  */
2670 function ismoving($courseid) {
2671     global $USER;
2673     if (!empty($USER->activitycopy)) {
2674         return ($USER->activitycopycourse == $courseid);
2675     }
2676     return false;
2679 /**
2680  * Given an object containing firstname and lastname
2681  * values, this function returns a string with the
2682  * full name of the person.
2683  * The result may depend on system settings
2684  * or language.  'override' will force both names
2685  * to be used even if system settings specify one.
2686  *
2687  * @uses $CFG
2688  * @uses $SESSION
2689  * @param object $user A {@link $USER} object to get full name of
2690  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
2691  */
2692 function fullname($user, $override=false) {
2693     global $CFG, $SESSION;
2695     if (!isset($user->firstname) and !isset($user->lastname)) {
2696         return '';
2697     }
2699     if (!$override) {
2700         if (!empty($CFG->forcefirstname)) {
2701             $user->firstname = $CFG->forcefirstname;
2702         }
2703         if (!empty($CFG->forcelastname)) {
2704             $user->lastname = $CFG->forcelastname;
2705         }
2706     }
2708     if (!empty($SESSION->fullnamedisplay)) {
2709         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
2710     }
2712     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
2713         return $user->firstname .' '. $user->lastname;
2715     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
2716         return $user->lastname .' '. $user->firstname;
2718     } else if ($CFG->fullnamedisplay == 'firstname') {
2719         if ($override) {
2720             return get_string('fullnamedisplay', '', $user);
2721         } else {
2722             return $user->firstname;
2723         }
2724     }
2726     return get_string('fullnamedisplay', '', $user);
2729 /**
2730  * Returns whether a given authentication plugin exists.
2731  *
2732  * @uses $CFG
2733  * @param string $auth Form of authentication to check for. Defaults to the
2734  *        global setting in {@link $CFG}.
2735  * @return boolean Whether the plugin is available.
2736  */
2737 function exists_auth_plugin($auth) {
2738     global $CFG;
2740     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
2741         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
2742     }
2743     return false;
2746 /**
2747  * Checks if a given plugin is in the list of enabled authentication plugins.
2748  *
2749  * @param string $auth Authentication plugin.
2750  * @return boolean Whether the plugin is enabled.
2751  */
2752 function is_enabled_auth($auth) {
2753     if (empty($auth)) {
2754         return false;
2755     }
2757     $enabled = get_enabled_auth_plugins();
2759     return in_array($auth, $enabled);
2762 /**
2763  * Returns an authentication plugin instance.
2764  *
2765  * @uses $CFG
2766  * @param string $auth name of authentication plugin
2767  * @return object An instance of the required authentication plugin.
2768  */
2769 function get_auth_plugin($auth) {
2770     global $CFG;
2772     // check the plugin exists first
2773     if (! exists_auth_plugin($auth)) {
2774         print_error('authpluginnotfound', 'debug', '', $auth);
2775     }
2777     // return auth plugin instance
2778     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
2779     $class = "auth_plugin_$auth";
2780     return new $class;
2783 /**
2784  * Returns array of active auth plugins.
2785  *
2786  * @param bool $fix fix $CFG->auth if needed
2787  * @return array
2788  */
2789 function get_enabled_auth_plugins($fix=false) {
2790     global $CFG;
2792     $default = array('manual', 'nologin');
2794     if (empty($CFG->auth)) {
2795         $auths = array();
2796     } else {
2797         $auths = explode(',', $CFG->auth);
2798     }
2800     if ($fix) {
2801         $auths = array_unique($auths);
2802         foreach($auths as $k=>$authname) {
2803             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
2804                 unset($auths[$k]);
2805             }
2806         }
2807         $newconfig = implode(',', $auths);
2808         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
2809             set_config('auth', $newconfig);
2810         }
2811     }
2813     return (array_merge($default, $auths));
2816 /**
2817  * Returns true if an internal authentication method is being used.
2818  * if method not specified then, global default is assumed
2819  *
2820  * @uses $CFG
2821  * @param string $auth Form of authentication required
2822  * @return bool
2823  */
2824 function is_internal_auth($auth) {
2825     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
2826     return $authplugin->is_internal();
2829 /**
2830  * Returns an array of user fields
2831  *
2832  * @return array User field/column names
2833  */
2834 function get_user_fieldnames() {
2835     global $DB;
2837     $fieldarray = $DB->get_columns('user');
2838     unset($fieldarray['id']);
2839     $fieldarray = array_keys($fieldarray);
2841     return $fieldarray;
2844 /**
2845  * Creates a bare-bones user record
2846  *
2847  * @uses $CFG
2848  * @param string $username New user's username to add to record
2849  * @param string $password New user's password to add to record
2850  * @param string $auth Form of authentication required
2851  * @return object A {@link $USER} object
2852  * @todo Outline auth types and provide code example
2853  */
2854 function create_user_record($username, $password, $auth='manual') {
2855     global $CFG, $DB;
2857     //just in case check text case
2858     $username = trim(moodle_strtolower($username));
2860     $authplugin = get_auth_plugin($auth);
2862     $newuser = new object();
2864     if ($newinfo = $authplugin->get_userinfo($username)) {
2865         $newinfo = truncate_userinfo($newinfo);
2866         foreach ($newinfo as $key => $value){
2867             $newuser->$key = $value;
2868         }
2869     }
2871     if (!empty($newuser->email)) {
2872         if (email_is_not_allowed($newuser->email)) {
2873             unset($newuser->email);
2874         }
2875     }
2877     if (!isset($newuser->city)) {
2878         $newuser->city = '';
2879     }
2881     $newuser->auth = $auth;
2882     $newuser->username = $username;
2884     // fix for MDL-8480
2885     // user CFG lang for user if $newuser->lang is empty
2886     // or $user->lang is not an installed language
2887     $sitelangs = array_keys(get_list_of_languages());
2888     if (empty($newuser->lang) || !in_array($newuser->lang, $sitelangs)) {
2889         $newuser->lang = $CFG->lang;
2890     }
2891     $newuser->confirmed = 1;
2892     $newuser->lastip = getremoteaddr();
2893     $newuser->timemodified = time();
2894     $newuser->mnethostid = $CFG->mnet_localhost_id;
2896     $DB->insert_record('user', $newuser);
2897     $user = get_complete_user_data('username', $newuser->username);
2898     if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
2899         set_user_preference('auth_forcepasswordchange', 1, $user->id);
2900     }
2901     update_internal_user_password($user, $password);
2902     return $user;
2905 /**
2906  * Will update a local user record from an external source
2907  *
2908  * @uses $CFG
2909  * @param string $username New user's username to add to record
2910  * @return user A {@link $USER} object
2911  */
2912 function update_user_record($username, $authplugin) {
2913     global $DB;
2915     $username = trim(moodle_strtolower($username)); /// just in case check text case
2917     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
2918     $userauth = get_auth_plugin($oldinfo->auth);
2920     if ($newinfo = $userauth->get_userinfo($username)) {
2921         $newinfo = truncate_userinfo($newinfo);
2922         foreach ($newinfo as $key => $value){
2923             if ($key === 'username') {
2924                 // 'username' is not a mapped updateable/lockable field, so skip it.
2925                 continue;
2926             }
2927             $confval = $userauth->config->{'field_updatelocal_' . $key};
2928             $lockval = $userauth->config->{'field_lock_' . $key};
2929             if (empty($confval) || empty($lockval)) {
2930                 continue;
2931             }
2932             if ($confval === 'onlogin') {
2933                 // MDL-4207 Don't overwrite modified user profile values with
2934                 // empty LDAP values when 'unlocked if empty' is set. The purpose
2935                 // of the setting 'unlocked if empty' is to allow the user to fill
2936                 // in a value for the selected field _if LDAP is giving
2937                 // nothing_ for this field. Thus it makes sense to let this value
2938                 // stand in until LDAP is giving a value for this field.
2939                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
2940                     $DB->set_field('user', $key, $value, array('username'=>$username));
2941                 }
2942             }
2943         }
2944     }
2946     return get_complete_user_data('username', $username);
2949 /**
2950  * will truncate userinfo as it comes from auth_get_userinfo (from external auth)
2951  * which may have large fields
2952  */
2953 function truncate_userinfo($info) {
2954     // define the limits
2955     $limit = array(
2956                     'username'    => 100,
2957                     'idnumber'    => 255,
2958                     'firstname'   => 100,
2959                     'lastname'    => 100,
2960                     'email'       => 100,
2961                     'icq'         =>  15,
2962                     'phone1'      =>  20,
2963                     'phone2'      =>  20,
2964                     'institution' =>  40,
2965                     'department'  =>  30,
2966                     'address'     =>  70,
2967                     'city'        =>  20,
2968                     'country'     =>   2,
2969                     'url'         => 255,
2970                     );
2972     // apply where needed
2973     foreach (array_keys($info) as $key) {
2974         if (!empty($limit[$key])) {
2975             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
2976         }
2977     }
2979     return $info;
2982 /**
2983  * Marks user deleted in internal user database and notifies the auth plugin.
2984  * Also unenrols user from all roles and does other cleanup.
2985  * @param object $user       Userobject before delete    (without system magic quotes)
2986  * @return boolean success
2987  */
2988 function delete_user($user) {
2989     global $CFG, $DB;
2990     require_once($CFG->libdir.'/grouplib.php');
2991     require_once($CFG->libdir.'/gradelib.php');
2993     // TODO: decide if this transaction is really needed
2994     $DB->begin_sql();
2996     try {
2997         // delete all grades - backup is kept in grade_grades_history table
2998         if ($grades = grade_grade::fetch_all(array('userid'=>$user->id))) {
2999             foreach ($grades as $grade) {
3000                 $grade->delete('userdelete');
3001             }
3002         }
3004         // remove from all groups
3005         $DB->delete_records('groups_members', array('userid'=>$user->id));
3007         // unenrol from all roles in all contexts
3008         role_unassign(0, $user->id); // this might be slow but it is really needed - modules might do some extra cleanup!
3010         // now do a final accesslib cleanup - removes all role assingments in user context and context itself
3011         delete_context(CONTEXT_USER, $user->id);
3013         require_once($CFG->dirroot.'/tag/lib.php');
3014         tag_set('user', $user->id, array());
3016         // workaround for bulk deletes of users with the same email address
3017         $delname = "$user->email.".time();
3018         while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3019             $delname++;
3020         }
3022         // mark internal user record as "deleted"
3023         $updateuser = new object();
3024         $updateuser->id           = $user->id;
3025         $updateuser->deleted      = 1;
3026         $updateuser->username     = $delname;         // Remember it just in case
3027         $updateuser->email        = '';               // Clear this field to free it up
3028         $updateuser->idnumber     = '';               // Clear this field to free it up
3029         $updateuser->timemodified = time();
3031         $DB->update_record('user', $updateuser);
3033         $DB->commit_sql();
3035         // notify auth plugin - do not block the delete even when plugin fails
3036         $authplugin = get_auth_plugin($user->auth);
3037         $authplugin->user_delete($user);
3039         events_trigger('user_deleted', $user);
3041     } catch (Exception $e) {
3042         $DB->rollback_sql();
3043         throw $e;
3044     }
3046     return true;
3049 /**
3050  * Retrieve the guest user object
3051  *
3052  * @uses $CFG
3053  * @return user A {@link $USER} object
3054  */
3055 function guest_user() {
3056     global $CFG, $DB;
3058     if ($newuser = $DB->get_record('user', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
3059         $newuser->confirmed = 1;
3060         $newuser->lang = $CFG->lang;
3061         $newuser->lastip = getremoteaddr();
3062     }
3064     return $newuser;
3067 /**
3068  * Given a username and password, this function looks them
3069  * up using the currently selected authentication mechanism,
3070  * and if the authentication is successful, it returns a
3071  * valid $user object from the 'user' table.
3072  *
3073  * Uses auth_ functions from the currently active auth module
3074  *
3075  * After authenticate_user_login() returns success, you will need to
3076  * log that the user has logged in, and call complete_user_login() to set
3077  * the session up.
3078  *
3079  * @uses $CFG
3080  * @param string $username  User's username
3081  * @param string $password  User's password
3082  * @return user|flase A {@link $USER} object or false if error
3083  */
3084 function authenticate_user_login($username, $password) {
3085     global $CFG, $DB;
3087     $authsenabled = get_enabled_auth_plugins();
3089     if ($user = get_complete_user_data('username', $username)) {
3090         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3091         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3092             add_to_log(0, 'login', 'error', 'index.php', $username);
3093             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3094             return false;
3095         }
3096         if (!empty($user->deleted)) {
3097             add_to_log(0, 'login', 'error', 'index.php', $username);
3098             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3099             return false;
3100         }
3101         $auths = array($auth);
3103     } else {
3104         $auths = $authsenabled;
3105         $user = new object();
3106         $user->id = 0;     // User does not exist
3107     }
3109     foreach ($auths as $auth) {
3110         $authplugin = get_auth_plugin($auth);
3112         // on auth fail fall through to the next plugin
3113         if (!$authplugin->user_login($username, $password)) {
3114             continue;
3115         }
3117         // successful authentication
3118         if ($user->id) {                          // User already exists in database
3119             if (empty($user->auth)) {             // For some reason auth isn't set yet
3120                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3121                 $user->auth = $auth;
3122             }
3123             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3124                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3125                 $user->firstaccess = $user->timemodified;
3126             }
3128             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3130             if (!$authplugin->is_internal()) {            // update user record from external DB
3131                 $user = update_user_record($username, get_auth_plugin($user->auth));
3132             }
3133         } else {
3134             // if user not found, create him
3135             $user = create_user_record($username, $password, $auth);
3136         }
3138         $authplugin->sync_roles($user);
3140         foreach ($authsenabled as $hau) {
3141             $hauth = get_auth_plugin($hau);
3142             $hauth->user_authenticated_hook($user, $username, $password);
3143         }
3145     /// Log in to a second system if necessary
3146     /// NOTICE: /sso/ will be moved to auth and deprecated soon; use user_authenticated_hook() instead
3147         if (!empty($CFG->sso)) {
3148             include_once($CFG->dirroot .'/sso/'. $CFG->sso .'/lib.php');
3149             if (function_exists('sso_user_login')) {
3150                 if (!sso_user_login($username, $password)) {   // Perform the signon process
3151                     notify('Second sign-on failed');
3152                 }
3153             }
3154         }
3156         if ($user->id===0) {
3157             return false;
3158         }
3159         return $user;
3160     }
3162     // failed if all the plugins have failed
3163     add_to_log(0, 'login', 'error', 'index.php', $username);
3164     if (debugging('', DEBUG_ALL)) {
3165         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3166     }
3167     return false;
3170 /**
3171  * Call to complete the user login process after authenticate_user_login()
3172  * has succeeded. It will setup the $USER variable and other required bits
3173  * and pieces.
3174  *
3175  * NOTE:
3176  * - It will NOT log anything -- up to the caller to decide what to log.
3177  *
3178  * @uses $CFG, $USER
3179  * @param string $user obj
3180  * @return object A {@link $USER} object - BC only, do not use
3181  */
3182 function complete_user_login($user, $setcookie=true) {
3183     global $CFG, $USER, $SESSION;
3185     // check enrolments, load caps and setup $USER object
3186     session_set_user($user);
3188     update_user_login_times();
3189     set_login_session_preferences();
3191     if ($setcookie) {
3192         if (empty($CFG->nolastloggedin)) {
3193             set_moodle_cookie($USER->username);
3194         } else {
3195             // do not store last logged in user in cookie
3196             // auth plugins can temporarily override this from loginpage_hook()
3197             // do not save $CFG->nolastloggedin in database!
3198             set_moodle_cookie('nobody');
3199         }
3200     }
3202     /// Select password change url
3203     $userauth = get_auth_plugin($USER->auth);
3205     /// check whether the user should be changing password
3206     if (get_user_preferences('auth_forcepasswordchange', false)){
3207         if ($userauth->can_change_password()) {
3208             if ($changeurl = $userauth->change_password_url()) {
3209                 redirect($changeurl);
3210             } else {
3211                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3212             }
3213         } else {
3214             print_error('nopasswordchangeforced', 'auth');
3215         }
3216     }
3217     return $USER;
3220 /**
3221  * Compare password against hash stored in internal user table.
3222  * If necessary it also updates the stored hash to new format.
3223  *
3224  * @param object user
3225  * @param string plain text password
3226  * @return bool is password valid?
3227  */
3228 function validate_internal_user_password(&$user, $password) {
3229     global $CFG;
3231     if (!isset($CFG->passwordsaltmain)) {
3232         $CFG->passwordsaltmain = '';
3233     }
3235     $validated = false;
3237     // get password original encoding in case it was not updated to unicode yet
3238     $textlib = textlib_get_instance();
3239     $convpassword = $textlib->convert($password, 'utf-8', get_string('oldcharset'));
3241     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)
3242         or $user->password == md5($convpassword.$CFG->passwordsaltmain) or $user->password == md5($convpassword)) {
3243         $validated = true;
3244     } else {
3245         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3246             $alt = 'passwordsaltalt'.$i;
3247             if (!empty($CFG->$alt)) {
3248                 if ($user->password == md5($password.$CFG->$alt) or $user->password == md5($convpassword.$CFG->$alt)) {
3249                     $validated = true;
3250                     break;
3251                 }
3252             }
3253         }
3254     }
3256     if ($validated) {
3257         // force update of password hash using latest main password salt and encoding if needed
3258         update_internal_user_password($user, $password);
3259     }
3261     return $validated;
3264 /**
3265  * Calculate hashed value from password using current hash mechanism.
3266  *
3267  * @param string password
3268  * @return string password hash
3269  */
3270 function hash_internal_user_password($password) {
3271     global $CFG;
3273     if (isset($CFG->passwordsaltmain)) {
3274         return md5($password.$CFG->passwordsaltmain);
3275     } else {
3276         return md5($password);
3277     }
3280 /**
3281  * Update pssword hash in user object.
3282  *
3283  * @param object user
3284  * @param string plain text password
3285  * @param bool store changes also in db, default true
3286  * @return true if hash changed
3287  */
3288 function update_internal_user_password(&$user, $password) {
3289     global $CFG, $DB;
3291     $authplugin = get_auth_plugin($user->auth);
3292     if (!empty($authplugin->config->preventpassindb)) {
3293         $hashedpassword = 'not cached';
3294     } else {
3295         $hashedpassword = hash_internal_user_password($password);
3296     }
3298     $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
3299     return true;
3302 /**
3303  * Get a complete user record, which includes all the info
3304  * in the user record
3305  * Intended for setting as $USER session variable
3306  *
3307  * @uses $CFG
3308  * @uses SITEID
3309  * @param string $field The user field to be checked for a given value.
3310  * @param string $value The value to match for $field.
3311  * @return user A {@link $USER} object.
3312  */
3313 function get_complete_user_data($field, $value, $mnethostid=null) {
3314     global $CFG, $DB;
3316     if (!$field || !$value) {
3317         return false;
3318     }
3320 /// Build the WHERE clause for an SQL query
3321     $params = array('fieldval'=>$value);
3322     $constraints = "$field = :fieldval AND deleted <> 1";
3324     // If we are loading user data based on anything other than id,
3325     // we must also restrict our search based on mnet host.
3326     if ($field != 'id') {
3327         if (empty($mnethostid)) {
3328             // if empty, we restrict to local users
3329             $mnethostid = $CFG->mnet_localhost_id;
3330         }
3331     }
3332     if (!empty($mnethostid)) {
3333         $params['mnethostid'] = $mnethostid;
3334         $constraints .= " AND mnethostid = :mnethostid";
3335     }
3337 /// Get all the basic user data
3339     if (! $user = $DB->get_record_select('user', $constraints, $params)) {
3340         return false;
3341     }
3343 /// Get various settings and preferences
3345     if ($displays = $DB->get_records('course_display', array('userid'=>$user->id))) {
3346         foreach ($displays as $display) {
3347             $user->display[$display->course] = $display->display;
3348         }
3349     }
3351     $user->preference = get_user_preferences(null, null, $user->id);
3352     $user->preference['_lastloaded'] = time();
3354     $user->lastcourseaccess    = array(); // during last session
3355     $user->currentcourseaccess = array(); // during current session
3356     if ($lastaccesses = $DB->get_records('user_lastaccess', array('userid'=>$user->id))) {
3357         foreach ($lastaccesses as $lastaccess) {
3358             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
3359         }
3360     }
3362     $sql = "SELECT g.id, g.courseid
3363               FROM {groups} g, {groups_members} gm
3364              WHERE gm.groupid=g.id AND gm.userid=?";
3366     // this is a special hack to speedup calendar display
3367     $user->groupmember = array();
3368     if ($groups = $DB->get_records_sql($sql, array($user->id))) {
3369         foreach ($groups as $group) {
3370             if (!array_key_exists($group->courseid, $user->groupmember)) {
3371                 $user->groupmember[$group->courseid] = array();
3372             }
3373             $user->groupmember[$group->courseid][$group->id] = $group->id;
3374         }
3375     }
3377 /// Add the custom profile fields to the user record
3378     require_once($CFG->dirroot.'/user/profile/lib.php');
3379     $customfields = (array)profile_user_record($user->id);
3380     foreach ($customfields as $cname=>$cvalue) {
3381         if (!isset($user->$cname)) { // Don't overwrite any standard fields
3382             $user->$cname = $cvalue;
3383         }
3384     }
3386 /// Rewrite some variables if necessary
3387     if (!empty($user->description)) {
3388         $user->description = true;   // No need to cart all of it around
3389     }
3390     if ($user->username == 'guest') {
3391         $user->lang       = $CFG->lang;               // Guest language always same as site
3392         $user->firstname  = get_string('guestuser');  // Name always in current language
3393         $user->lastname   = ' ';
3394     }
3396     return $user;
3399 /**
3400  * @uses $CFG
3401  * @param string $password the password to be checked agains the password policy
3402  * @param string $errmsg the error message to display when the password doesn't comply with the policy.
3403  * @return bool true if the password is valid according to the policy. false otherwise.
3404  */
3405 function check_password_policy($password, &$errmsg) {
3406     global $CFG;
3408     if (empty($CFG->passwordpolicy)) {
3409         return true;
3410     }
3412     $textlib = textlib_get_instance();
3413     $errmsg = '';
3414     if ($textlib->strlen($password) < $CFG->minpasswordlength) {
3415         $errmsg .= '<div>'. get_string('errorminpasswordlength', 'auth', $CFG->minpasswordlength) .'</div>';
3417     }
3418     if (preg_match_all('/[[:digit:]]/u', $password, $matches) < $CFG->minpassworddigits) {
3419         $errmsg .= '<div>'. get_string('errorminpassworddigits', 'auth', $CFG->minpassworddigits) .'</div>';
3421     }
3422     if (preg_match_all('/[[:lower:]]/u', $password, $matches) < $CFG->minpasswordlower) {
3423         $errmsg .= '<div>'. get_string('errorminpasswordlower', 'auth', $CFG->minpasswordlower) .'</div>';
3425     }
3426     if (preg_match_all('/[[:upper:]]/u', $password, $matches) < $CFG->minpasswordupper) {
3427         $errmsg .= '<div>'. get_string('errorminpasswordupper', 'auth', $CFG->minpasswordupper) .'</div>';
3429     }
3430     if (preg_match_all('/[^[:upper:][:lower:][:digit:]]/u', $password, $matches) < $CFG->minpasswordnonalphanum) {
3431         $errmsg .= '<div>'. get_string('errorminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum) .'</div>';
3432     }
3433     if (!check_consecutive_identical_characters($password, $CFG->maxconsecutiveidentchars)) {
3434         $errmsg .= '<div>'. get_string('errormaxconsecutiveidentchars', 'auth', $CFG->maxconsecutiveidentchars) .'</div>';
3435     }
3437     if ($errmsg == '') {
3438         return true;
3439     } else {
3440         return false;
3441     }
3445 /**
3446  * When logging in, this function is run to set certain preferences
3447  * for the current SESSION
3448  */
3449 function set_login_session_preferences() {
3450     global $SESSION, $CFG;
3452     $SESSION->justloggedin = true;
3454     unset($SESSION->lang);
3456     // Restore the calendar filters, if saved
3457     if (intval(get_user_preferences('calendar_persistflt', 0))) {
3458         include_once($CFG->dirroot.'/calendar/lib.php');
3459         calendar_set_filters_status(get_user_preferences('calendar_savedflt', 0xff));
3460     }
3464 /**
3465  * Delete a course, including all related data from the database,
3466  * and any associated files from the moodledata folder.
3467  *
3468  * @param mixed $courseorid The id of the course or course object to delete.
3469  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3470  * @return bool true if all the removals succeeded. false if there were any failures. If this
3471  *             method returns false, some of the removals will probably have succeeded, and others
3472  *             failed, but you have no way of knowing which.
3473  */
3474 function delete_course($courseorid, $showfeedback = true) {
3475     global $CFG, $DB;
3476     $result = true;
3478     if (is_object($courseorid)) {
3479         $courseid = $courseorid->id;
3480         $course   = $courseorid;
3481     } else {
3482         $courseid = $courseorid;
3483         if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
3484             return false;
3485         }
3486     }
3488     // frontpage course can not be deleted!!
3489     if ($courseid == SITEID) {
3490         return false;
3491     }
3493     if (!remove_course_contents($courseid, $showfeedback)) {
3494         if ($showfeedback) {
3495             notify("An error occurred while deleting some of the course contents.");
3496         }
3497         $result = false;
3498     }
3500     $DB->delete_records("course", array("id"=>$courseid));
3502 /// Delete all roles and overiddes in the course context
3503     if (!delete_context(CONTEXT_COURSE, $courseid)) {
3504         if ($showfeedback) {
3505             notify("An error occurred while deleting the main course context.");
3506         }
3507         $result = false;
3508     }
3510     if (!fulldelete($CFG->dataroot.'/'.$courseid)) {
3511         if ($showfeedback) {
3512             notify("An error occurred while deleting the course files.");
3513         }
3514         $result = false;
3515     }
3517     if ($result) {
3518         //trigger events
3519         events_trigger('course_deleted', $course);
3520     }
3522     return $result;
3525 /**
3526  * Clear a course out completely, deleting all content
3527  * but don't delete the course itself
3528  *
3529  * @uses $CFG
3530  * @param int $courseid The id of the course that is being deleted
3531  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3532  * @return bool true if all the removals succeeded. false if there were any failures. If this
3533  *             method returns false, some of the removals will probably have succeeded, and others
3534  *             failed, but you have no way of knowing which.
3535  */
3536 function remove_course_contents($courseid, $showfeedback=true) {
3537     global $CFG, $DB;
3538     require_once($CFG->libdir.'/questionlib.php');
3539     require_once($CFG->libdir.'/gradelib.php');
3541     $result = true;
3543     if (! $course = $DB->get_record('course', array('id'=>$courseid))) {
3544         print_error('invalidcourseid');
3545     }
3547     $strdeleted = get_string('deleted');
3549 /// Clean up course formats (iterate through all formats in the even the course format was ever changed)
3550     $formats = get_list_of_plugins('course/format');
3551     foreach ($formats as $format) {
3552         $formatdelete = $format.'_course_format_delete_course';
3553         $formatlib    = "$CFG->dirroot/course/format/$format/lib.php";
3554         if (file_exists($formatlib)) {
3555             include_once($formatlib);
3556             if (function_exists($formatdelete)) {
3557                 if ($showfeedback) {
3558                     notify($strdeleted.' '.$format);
3559                 }
3560                 $formatdelete($course->id);
3561             }
3562         }
3563     }
3565 /// Delete every instance of every module
3567     if ($allmods = $DB->get_records('modules') ) {
3568         foreach ($allmods as $mod) {
3569             $modname = $mod->name;
3570             $modfile = $CFG->dirroot .'/mod/'. $modname .'/lib.php';
3571             $moddelete = $modname .'_delete_instance';       // Delete everything connected to an instance
3572             $moddeletecourse = $modname .'_delete_course';   // Delete other stray stuff (uncommon)
3573             $count=0;
3574             if (file_exists($modfile)) {
3575                 include_once($modfile);
3576                 if (function_exists($moddelete)) {
3577                     if ($instances = $DB->get_records($modname, array('course'=>$course->id))) {
3578                         foreach ($instances as $instance) {
3579                             if ($cm = get_coursemodule_from_instance($modname, $instance->id, $course->id)) {
3580                                 /// Delete activity context questions and question categories
3581                                 question_delete_activity($cm,  $showfeedback);
3582                             }
3583                             if ($moddelete($instance->id)) {
3584                                 $count++;
3586                             } else {
3587                                 notify('Could not delete '. $modname .' instance '. $instance->id .' ('. format_string($instance->name) .')');
3588                                 $result = false;
3589                             }
3590                             if ($cm) {
3591                                 // delete cm and its context in correct order
3592                                 $DB->delete_records('course_modules', array('id'=>$cm->id));
3593                                 delete_context(CONTEXT_MODULE, $cm->id);
3594                             }
3595                         }
3596                     }
3597                 } else {
3598                     notify('Function '.$moddelete.'() doesn\'t exist!');
3599                     $result = false;
3600                 }
3602                 if (function_exists($moddeletecourse)) {
3603                     $moddeletecourse($course, $showfeedback);
3604                 }
3605             }
3606             if ($showfeedback) {
3607                 notify($strdeleted .' '. $count .' x '. $modname);
3608             }
3609         }
3610     } else {
3611         print_error('nomodules', 'debug');
3612     }
3614 /// Give local code a chance to delete its references to this course.
3615     require_once($CFG->libdir.'/locallib.php');
3616     notify_local_delete_course($courseid, $showfeedback);
3618 /// Delete course blocks
3620     if ($blocks = $DB->get_records_sql("SELECT *
3621                                           FROM {block_instance}
3622                                          WHERE pagetype = '".PAGE_COURSE_VIEW."'
3623                                                AND pageid = ?", array($course->id))) {
3624         if ($DB->delete_records('block_instance', array('pagetype'=>PAGE_COURSE_VIEW, 'pageid'=>$course->id))) {
3625             if ($showfeedback) {
3626                 notify($strdeleted .' block_instance');
3627             }
3629             require_once($CFG->libdir.'/blocklib.php');
3630             foreach ($blocks as $block) {  /// Delete any associated contexts for this block
3632                 delete_context(CONTEXT_BLOCK, $block->id);
3634                 // fix for MDL-7164
3635                 // Get the block object and call instance_delete()
3636                 if (!$record = blocks_get_record($block->blockid)) {
3637                     $result = false;
3638                     continue;
3639                 }
3640                 if (!$obj = block_instance($record->name, $block)) {
3641                     $result = false;
3642                     continue;
3643                 }
3644                 // Return value ignored, in core mods this does not do anything, but just in case
3645                 // third party blocks might have stuff to clean up
3646                 // we execute this anyway
3647                 $obj->instance_delete();
3649             }
3650         } else {
3651             $result = false;
3652         }
3653     }
3655 /// Delete any groups, removing members and grouping/course links first.
3656     require_once($CFG->dirroot.'/group/lib.php');
3657     groups_delete_groupings($courseid, $showfeedback);
3658     groups_delete_groups($courseid, $showfeedback);
3660 /// Delete all related records in other tables that may have a courseid
3661 /// This array stores the tables that need to be cleared, as
3662 /// table_name => column_name that contains the course id.
3664     $tablestoclear = array(
3665         'event' => 'courseid', // Delete events
3666         'log' => 'course', // Delete logs
3667         'course_sections' => 'course', // Delete any course stuff
3668         'course_modules' => 'course',
3669         'backup_courses' => 'courseid', // Delete scheduled backup stuff
3670         'user_lastaccess' => 'courseid',
3671         'backup_log' => 'courseid'
3672     );
3673     foreach ($tablestoclear as $table => $col) {
3674         if ($DB->delete_records($table, array($col=>$course->id))) {
3675             if ($showfeedback) {
3676                 notify($strdeleted . ' ' . $table);
3677             }
3678         } else {
3679             $result = false;
3680         }
3681     }
3684 /// Clean up metacourse stuff
3686     if ($course->metacourse) {
3687         $DB->delete_records("course_meta", array("parent_course"=>$course->id));
3688         sync_metacourse($course->id); // have to do it here so the enrolments get nuked. sync_metacourses won't find it without the id.
3689         if ($showfeedback) {
3690             notify("$strdeleted course_meta");
3691         }
3692     } else {
3693         if ($parents = $DB->get_records("course_meta", array("child_course"=>$course->id))) {
3694             foreach ($parents as $parent) {
3695                 remove_from_metacourse($parent->parent_course,$parent->child_course); // this will do the unenrolments as well.
3696             }
3697             if ($showfeedback) {
3698                 notify("$strdeleted course_meta");
3699             }
3700         }
3701     }