daf9497ccce3a093679356abdf0c397ee250c669
[moodle.git] / lib / moodlelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * moodlelib.php - Moodle main library
20  *
21  * Main library file of miscellaneous general-purpose Moodle functions.
22  * Other main libraries:
23  *  - weblib.php      - functions that produce web output
24  *  - datalib.php     - functions that access the database
25  *
26  * @package   moodlecore
27  * @copyright 1999 onwards Martin Dougiamas  http://dougiamas.com
28  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
33 /**
34  * Used by some scripts to check they are being called by Moodle
35  */
36 define('MOODLE_INTERNAL', true);
38 /// Date and time constants ///
39 /**
40  * Time constant - the number of seconds in a year
41  */
42 define('YEARSECS', 31536000);
44 /**
45  * Time constant - the number of seconds in a week
46  */
47 define('WEEKSECS', 604800);
49 /**
50  * Time constant - the number of seconds in a day
51  */
52 define('DAYSECS', 86400);
54 /**
55  * Time constant - the number of seconds in an hour
56  */
57 define('HOURSECS', 3600);
59 /**
60  * Time constant - the number of seconds in a minute
61  */
62 define('MINSECS', 60);
64 /**
65  * Time constant - the number of minutes in a day
66  */
67 define('DAYMINS', 1440);
69 /**
70  * Time constant - the number of minutes in an hour
71  */
72 define('HOURMINS', 60);
74 /// Parameter constants - every call to optional_param(), required_param()  ///
75 /// or clean_param() should have a specified type of parameter.  //////////////
79 /**
80  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
81  */
82 define('PARAM_ALPHA',    'alpha');
84 /**
85  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
86  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
87  */
88 define('PARAM_ALPHAEXT', 'alphaext');
90 /**
91  * PARAM_ALPHANUM - expected numbers and letters only.
92  */
93 define('PARAM_ALPHANUM', 'alphanum');
95 /**
96  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
97  */
98 define('PARAM_ALPHANUMEXT', 'alphanumext');
100 /**
101  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
102  */
103 define('PARAM_AUTH',  'auth');
105 /**
106  * PARAM_BASE64 - Base 64 encoded format
107  */
108 define('PARAM_BASE64',   'base64');
110 /**
111  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
112  */
113 define('PARAM_BOOL',     'bool');
115 /**
116  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
117  * checked against the list of capabilities in the database.
118  */
119 define('PARAM_CAPABILITY',   'capability');
121 /**
122  * PARAM_CLEANHTML - cleans submitted HTML code and removes slashes. It stays as HTML.
123  */
124 define('PARAM_CLEANHTML', 'cleanhtml');
126 /**
127  * PARAM_EMAIL - an email address following the RFC
128  */
129 define('PARAM_EMAIL',   'email');
131 /**
132  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
133  */
134 define('PARAM_FILE',   'file');
136 /**
137  * PARAM_FLOAT - a real/floating point number.
138  */
139 define('PARAM_FLOAT',  'float');
141 /**
142  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
143  */
144 define('PARAM_HOST',     'host');
146 /**
147  * PARAM_INT - integers only, use when expecting only numbers.
148  */
149 define('PARAM_INT',      'int');
151 /**
152  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
153  */
154 define('PARAM_LANG',  'lang');
156 /**
157  * 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!)
158  */
159 define('PARAM_LOCALURL', 'localurl');
161 /**
162  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
163  */
164 define('PARAM_NOTAGS',   'notags');
166 /**
167  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
168  * note: the leading slash is not removed, window drive letter is not allowed
169  */
170 define('PARAM_PATH',     'path');
172 /**
173  * PARAM_PEM - Privacy Enhanced Mail format
174  */
175 define('PARAM_PEM',      'pem');
177 /**
178  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
179  */
180 define('PARAM_PERMISSION',   'permission');
182 /**
183  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way
184  */
185 define('PARAM_RAW', 'raw');
187 /**
188  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
189  */
190 define('PARAM_SAFEDIR',  'safedir');
192 /**
193  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
194  */
195 define('PARAM_SAFEPATH',  'safepath');
197 /**
198  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
199  */
200 define('PARAM_SEQUENCE',  'sequence');
202 /**
203  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
204  */
205 define('PARAM_TAG',   'tag');
207 /**
208  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
209  */
210 define('PARAM_TAGLIST',   'taglist');
212 /**
213  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
214  */
215 define('PARAM_TEXT',  'text');
217 /**
218  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
219  */
220 define('PARAM_THEME',  'theme');
222 /**
223  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
224  */
225 define('PARAM_URL',      'url');
227 /**
228  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
229  */
230 define('PARAM_USERNAME',    'username');
232 /**
233  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
234  */
235 define('PARAM_STRINGID',    'stringid');
237 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
238 /**
239  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
240  * It was one of the first types, that is why it is abused so much ;-)
241  */
242 define('PARAM_CLEAN',    'clean');
244 /**
245  * PARAM_INTEGER - deprecated alias for PARAM_INT
246  */
247 define('PARAM_INTEGER',  'int');
249 /**
250  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
251  */
252 define('PARAM_NUMBER',  'float');
254 /**
255  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
256  * NOTE: originally alias for PARAM_APLHA
257  */
258 define('PARAM_ACTION',   'alphanumext');
260 /**
261  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
262  * NOTE: originally alias for PARAM_APLHA
263  */
264 define('PARAM_FORMAT',   'alphanumext');
266 /**
267  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
268  */
269 define('PARAM_MULTILANG',  'text');
271 /**
272  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
273  */
274 define('PARAM_CLEANFILE', 'file');
276 /// Web Services ///
278 /**
279  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
280  */
281 define('VALUE_REQUIRED', 1);
283 /**
284  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
285  */
286 define('VALUE_OPTIONAL', 2);
288 /**
289  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
290  */
291 define('VALUE_DEFAULT', 0);
293 /**
294  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
295  */
296 define('NULL_NOT_ALLOWED', false);
298 /**
299  * NULL_ALLOWED - the parameter can be set to null in the database
300  */
301 define('NULL_ALLOWED', true);
303 /// Page types ///
304 /**
305  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
306  */
307 define('PAGE_COURSE_VIEW', 'course-view');
309 /** Get remote addr constant */
310 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
311 /** Get remote addr constant */
312 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
314 /// Blog access level constant declaration ///
315 define ('BLOG_USER_LEVEL', 1);
316 define ('BLOG_GROUP_LEVEL', 2);
317 define ('BLOG_COURSE_LEVEL', 3);
318 define ('BLOG_SITE_LEVEL', 4);
319 define ('BLOG_GLOBAL_LEVEL', 5);
322 ///Tag constants///
323 /**
324  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
325  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
326  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
327  *
328  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
329  */
330 define('TAG_MAX_LENGTH', 50);
332 /// Password policy constants ///
333 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
334 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
335 define ('PASSWORD_DIGITS', '0123456789');
336 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
338 /// Feature constants ///
339 // Used for plugin_supports() to report features that are, or are not, supported by a module.
341 /** True if module can provide a grade */
342 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
343 /** True if module supports outcomes */
344 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
346 /** True if module has code to track whether somebody viewed it */
347 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
348 /** True if module has custom completion rules */
349 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
351 /** True if module supports outcomes */
352 define('FEATURE_IDNUMBER', 'idnumber');
353 /** True if module supports groups */
354 define('FEATURE_GROUPS', 'groups');
355 /** True if module supports groupings */
356 define('FEATURE_GROUPINGS', 'groupings');
357 /** True if module supports groupmembersonly */
358 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
360 /** Type of module */
361 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
362 /** True if module supports intro editor */
363 define('FEATURE_MOD_INTRO', 'mod_intro');
364 /** True if module has default completion */
365 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
367 define('FEATURE_COMMENT', 'comment');
369 define('FEATURE_RATE', 'rate');
370 /** True if module supports backup/restore of moodle2 format */
371 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
373 /** Unspecified module archetype */
374 define('MOD_ARCHETYPE_OTHER', 0);
375 /** Resource-like type module */
376 define('MOD_ARCHETYPE_RESOURCE', 1);
377 /** Assignment module archetype */
378 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
380 /**
381  * Security token used for allowing access
382  * from external application such as web services.
383  * Scripts do not use any session, performance is relatively
384  * low because we need to load access info in each request.
385  * Scripts are executed in parallel.
386  */
387 define('EXTERNAL_TOKEN_PERMANENT', 0);
389 /**
390  * Security token used for allowing access
391  * of embedded applications, the code is executed in the
392  * active user session. Token is invalidated after user logs out.
393  * Scripts are executed serially - normal session locking is used.
394  */
395 define('EXTERNAL_TOKEN_EMBEDDED', 1);
397 /**
398  * The home page should be the site home
399  */
400 define('HOMEPAGE_SITE', 0);
401 /**
402  * The home page should be the users my page
403  */
404 define('HOMEPAGE_MY', 1);
405 /**
406  * The home page can be chosen by the user
407  */
408 define('HOMEPAGE_USER', 2);
410 /**
411  * Hub directory url (should be moodle.org)
412  */
413 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
416 /**
417  * Moodle.org url (should be moodle.org)
418  */
419 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
422 /// PARAMETER HANDLING ////////////////////////////////////////////////////
424 /**
425  * Returns a particular value for the named variable, taken from
426  * POST or GET.  If the parameter doesn't exist then an error is
427  * thrown because we require this variable.
428  *
429  * This function should be used to initialise all required values
430  * in a script that are based on parameters.  Usually it will be
431  * used like this:
432  *    $id = required_param('id', PARAM_INT);
433  *
434  * @param string $parname the name of the page parameter we want,
435  *                        default PARAM_CLEAN
436  * @param int $type expected type of parameter
437  * @return mixed
438  */
439 function required_param($parname, $type=PARAM_CLEAN) {
440     if (isset($_POST[$parname])) {       // POST has precedence
441         $param = $_POST[$parname];
442     } else if (isset($_GET[$parname])) {
443         $param = $_GET[$parname];
444     } else {
445         print_error('missingparam', '', '', $parname);
446     }
448     return clean_param($param, $type);
451 /**
452  * Returns a particular value for the named variable, taken from
453  * POST or GET, otherwise returning a given default.
454  *
455  * This function should be used to initialise all optional values
456  * in a script that are based on parameters.  Usually it will be
457  * used like this:
458  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
459  *
460  * @param string $parname the name of the page parameter we want
461  * @param mixed  $default the default value to return if nothing is found
462  * @param int $type expected type of parameter, default PARAM_CLEAN
463  * @return mixed
464  */
465 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
466     if (isset($_POST[$parname])) {       // POST has precedence
467         $param = $_POST[$parname];
468     } else if (isset($_GET[$parname])) {
469         $param = $_GET[$parname];
470     } else {
471         return $default;
472     }
474     return clean_param($param, $type);
477 /**
478  * Strict validation of parameter values, the values are only converted
479  * to requested PHP type. Internally it is using clean_param, the values
480  * before and after cleaning must be equal - otherwise
481  * an invalid_parameter_exception is thrown.
482  * Objects and classes are not accepted.
483  *
484  * @param mixed $param
485  * @param int $type PARAM_ constant
486  * @param bool $allownull are nulls valid value?
487  * @param string $debuginfo optional debug information
488  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
489  */
490 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
491     if (is_null($param)) {
492         if ($allownull == NULL_ALLOWED) {
493             return null;
494         } else {
495             throw new invalid_parameter_exception($debuginfo);
496         }
497     }
498     if (is_array($param) or is_object($param)) {
499         throw new invalid_parameter_exception($debuginfo);
500     }
502     $cleaned = clean_param($param, $type);
503     if ((string)$param !== (string)$cleaned) {
504         // conversion to string is usually lossless
505         throw new invalid_parameter_exception($debuginfo);
506     }
508     return $cleaned;
511 /**
512  * Used by {@link optional_param()} and {@link required_param()} to
513  * clean the variables and/or cast to specific types, based on
514  * an options field.
515  * <code>
516  * $course->format = clean_param($course->format, PARAM_ALPHA);
517  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
518  * </code>
519  *
520  * @param mixed $param the variable we are cleaning
521  * @param int $type expected format of param after cleaning.
522  * @return mixed
523  */
524 function clean_param($param, $type) {
526     global $CFG;
528     if (is_array($param)) {              // Let's loop
529         $newparam = array();
530         foreach ($param as $key => $value) {
531             $newparam[$key] = clean_param($value, $type);
532         }
533         return $newparam;
534     }
536     switch ($type) {
537         case PARAM_RAW:          // no cleaning at all
538             return $param;
540         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
541             if (is_numeric($param)) {
542                 return $param;
543             }
544             return clean_text($param);     // Sweep for scripts, etc
546         case PARAM_CLEANHTML:    // prepare html fragment for display, do not store it into db!!
547             $param = clean_text($param);     // Sweep for scripts, etc
548             return trim($param);
550         case PARAM_INT:
551             return (int)$param;  // Convert to integer
553         case PARAM_FLOAT:
554         case PARAM_NUMBER:
555             return (float)$param;  // Convert to float
557         case PARAM_ALPHA:        // Remove everything not a-z
558             return preg_replace('/[^a-zA-Z]/i', '', $param);
560         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
561             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
563         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
564             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
566         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
567             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
569         case PARAM_SEQUENCE:     // Remove everything not 0-9,
570             return preg_replace('/[^0-9,]/i', '', $param);
572         case PARAM_BOOL:         // Convert to 1 or 0
573             $tempstr = strtolower($param);
574             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
575                 $param = 1;
576             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
577                 $param = 0;
578             } else {
579                 $param = empty($param) ? 0 : 1;
580             }
581             return $param;
583         case PARAM_NOTAGS:       // Strip all tags
584             return strip_tags($param);
586         case PARAM_TEXT:    // leave only tags needed for multilang
587             return clean_param(strip_tags($param, '<lang><span>'), PARAM_CLEAN);
589         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
590             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
592         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
593             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
595         case PARAM_FILE:         // Strip all suspicious characters from filename
596             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
597             $param = preg_replace('~\.\.+~', '', $param);
598             if ($param === '.') {
599                 $param = '';
600             }
601             return $param;
603         case PARAM_PATH:         // Strip all suspicious characters from file path
604             $param = str_replace('\\', '/', $param);
605             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
606             $param = preg_replace('~\.\.+~', '', $param);
607             $param = preg_replace('~//+~', '/', $param);
608             return preg_replace('~/(\./)+~', '/', $param);
610         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
611             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
612             // match ipv4 dotted quad
613             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
614                 // confirm values are ok
615                 if ( $match[0] > 255
616                      || $match[1] > 255
617                      || $match[3] > 255
618                      || $match[4] > 255 ) {
619                     // hmmm, what kind of dotted quad is this?
620                     $param = '';
621                 }
622             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
623                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
624                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
625                        ) {
626                 // all is ok - $param is respected
627             } else {
628                 // all is not ok...
629                 $param='';
630             }
631             return $param;
633         case PARAM_URL:          // allow safe ftp, http, mailto urls
634             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
635             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
636                 // all is ok, param is respected
637             } else {
638                 $param =''; // not really ok
639             }
640             return $param;
642         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
643             $param = clean_param($param, PARAM_URL);
644             if (!empty($param)) {
645                 if (preg_match(':^/:', $param)) {
646                     // root-relative, ok!
647                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
648                     // absolute, and matches our wwwroot
649                 } else {
650                     // relative - let's make sure there are no tricks
651                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
652                         // looks ok.
653                     } else {
654                         $param = '';
655                     }
656                 }
657             }
658             return $param;
660         case PARAM_PEM:
661             $param = trim($param);
662             // PEM formatted strings may contain letters/numbers and the symbols
663             // forward slash: /
664             // plus sign:     +
665             // equal sign:    =
666             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
667             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
668                 list($wholething, $body) = $matches;
669                 unset($wholething, $matches);
670                 $b64 = clean_param($body, PARAM_BASE64);
671                 if (!empty($b64)) {
672                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
673                 } else {
674                     return '';
675                 }
676             }
677             return '';
679         case PARAM_BASE64:
680             if (!empty($param)) {
681                 // PEM formatted strings may contain letters/numbers and the symbols
682                 // forward slash: /
683                 // plus sign:     +
684                 // equal sign:    =
685                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
686                     return '';
687                 }
688                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
689                 // Each line of base64 encoded data must be 64 characters in
690                 // length, except for the last line which may be less than (or
691                 // equal to) 64 characters long.
692                 for ($i=0, $j=count($lines); $i < $j; $i++) {
693                     if ($i + 1 == $j) {
694                         if (64 < strlen($lines[$i])) {
695                             return '';
696                         }
697                         continue;
698                     }
700                     if (64 != strlen($lines[$i])) {
701                         return '';
702                     }
703                 }
704                 return implode("\n",$lines);
705             } else {
706                 return '';
707             }
709         case PARAM_TAG:
710             //as long as magic_quotes_gpc is used, a backslash will be a
711             //problem, so remove *all* backslash.
712             //$param = str_replace('\\', '', $param);
713             //remove some nasties
714             $param = preg_replace('~[[:cntrl:]]|[<>`]~', '', $param);
715             //convert many whitespace chars into one
716             $param = preg_replace('/\s+/', ' ', $param);
717             $textlib = textlib_get_instance();
718             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
719             return $param;
722         case PARAM_TAGLIST:
723             $tags = explode(',', $param);
724             $result = array();
725             foreach ($tags as $tag) {
726                 $res = clean_param($tag, PARAM_TAG);
727                 if ($res !== '') {
728                     $result[] = $res;
729                 }
730             }
731             if ($result) {
732                 return implode(',', $result);
733             } else {
734                 return '';
735             }
737         case PARAM_CAPABILITY:
738             if (get_capability_info($param)) {
739                 return $param;
740             } else {
741                 return '';
742             }
744         case PARAM_PERMISSION:
745             $param = (int)$param;
746             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
747                 return $param;
748             } else {
749                 return CAP_INHERIT;
750             }
752         case PARAM_AUTH:
753             $param = clean_param($param, PARAM_SAFEDIR);
754             if (exists_auth_plugin($param)) {
755                 return $param;
756             } else {
757                 return '';
758             }
760         case PARAM_LANG:
761             $param = clean_param($param, PARAM_SAFEDIR);
762             if (get_string_manager()->translation_exists($param)) {
763                 return $param;
764             } else {
765                 return ''; // Specified language is not installed or param malformed
766             }
768         case PARAM_THEME:
769             $param = clean_param($param, PARAM_SAFEDIR);
770             if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
771                 return $param;
772             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
773                 return $param;
774             } else {
775                 return '';  // Specified theme is not installed
776             }
778         case PARAM_USERNAME:
779             $param = str_replace(" " , "", $param);
780             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
781             if (empty($CFG->extendedusernamechars)) {
782                 // regular expression, eliminate all chars EXCEPT:
783                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
784                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
785             }
786             return $param;
788         case PARAM_EMAIL:
789             if (validate_email($param)) {
790                 return $param;
791             } else {
792                 return '';
793             }
795         case PARAM_STRINGID:
796             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
797                 return $param;
798             } else {
799                 return '';
800             }
802         default:                 // throw error, switched parameters in optional_param or another serious problem
803             print_error("unknownparamtype", '', '', $type);
804     }
807 /**
808  * Return true if given value is integer or string with integer value
809  *
810  * @param mixed $value String or Int
811  * @return bool true if number, false if not
812  */
813 function is_number($value) {
814     if (is_int($value)) {
815         return true;
816     } else if (is_string($value)) {
817         return ((string)(int)$value) === $value;
818     } else {
819         return false;
820     }
823 /**
824  * Returns host part from url
825  * @param string $url full url
826  * @return string host, null if not found
827  */
828 function get_host_from_url($url) {
829     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
830     if ($matches) {
831         return $matches[1];
832     }
833     return null;
836 /**
837  * Tests whether anything was returned by text editor
838  *
839  * This function is useful for testing whether something you got back from
840  * the HTML editor actually contains anything. Sometimes the HTML editor
841  * appear to be empty, but actually you get back a <br> tag or something.
842  *
843  * @param string $string a string containing HTML.
844  * @return boolean does the string contain any actual content - that is text,
845  * images, objects, etc.
846  */
847 function html_is_blank($string) {
848     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
851 /**
852  * Set a key in global configuration
853  *
854  * Set a key/value pair in both this session's {@link $CFG} global variable
855  * and in the 'config' database table for future sessions.
856  *
857  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
858  * In that case it doesn't affect $CFG.
859  *
860  * A NULL value will delete the entry.
861  *
862  * @global object
863  * @global object
864  * @param string $name the key to set
865  * @param string $value the value to set (without magic quotes)
866  * @param string $plugin (optional) the plugin scope, default NULL
867  * @return bool true or exception
868  */
869 function set_config($name, $value, $plugin=NULL) {
870     global $CFG, $DB;
872     if (empty($plugin)) {
873         if (!array_key_exists($name, $CFG->config_php_settings)) {
874             // So it's defined for this invocation at least
875             if (is_null($value)) {
876                 unset($CFG->$name);
877             } else {
878                 $CFG->$name = (string)$value; // settings from db are always strings
879             }
880         }
882         if ($DB->get_field('config', 'name', array('name'=>$name))) {
883             if ($value === null) {
884                 $DB->delete_records('config', array('name'=>$name));
885             } else {
886                 $DB->set_field('config', 'value', $value, array('name'=>$name));
887             }
888         } else {
889             if ($value !== null) {
890                 $config = new object();
891                 $config->name  = $name;
892                 $config->value = $value;
893                 $DB->insert_record('config', $config, false);
894             }
895         }
897     } else { // plugin scope
898         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
899             if ($value===null) {
900                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
901             } else {
902                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
903             }
904         } else {
905             if ($value !== null) {
906                 $config = new object();
907                 $config->plugin = $plugin;
908                 $config->name   = $name;
909                 $config->value  = $value;
910                 $DB->insert_record('config_plugins', $config, false);
911             }
912         }
913     }
915     return true;
918 /**
919  * Get configuration values from the global config table
920  * or the config_plugins table.
921  *
922  * If called with one parameter, it will load all the config
923  * variables for one plugin, and return them as an object.
924  *
925  * If called with 2 parameters it will return a string single
926  * value or false if the value is not found.
927  *
928  * @param string $plugin full component name
929  * @param string $name default NULL
930  * @return mixed hash-like object or single value, return false no config found
931  */
932 function get_config($plugin, $name = NULL) {
933     global $CFG, $DB;
935     // normalise component name
936     if ($plugin === 'moodle' or $plugin === 'core') {
937         $plugin = NULL;
938     }
940     if (!empty($name)) { // the user is asking for a specific value
941         if (!empty($plugin)) {
942             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
943                 // setting forced in config file
944                 return $CFG->forced_plugin_settings[$plugin][$name];
945             } else {
946                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
947             }
948         } else {
949             if (array_key_exists($name, $CFG->config_php_settings)) {
950                 // setting force in config file
951                 return $CFG->config_php_settings[$name];
952             } else {
953                 return $DB->get_field('config', 'value', array('name'=>$name));
954             }
955         }
956     }
958     // the user is after a recordset
959     if ($plugin) {
960         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
961         if (isset($CFG->forced_plugin_settings[$plugin])) {
962             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
963                 if (is_null($v) or is_array($v) or is_object($v)) {
964                     // we do not want any extra mess here, just real settings that could be saved in db
965                     unset($localcfg[$n]);
966                 } else {
967                     //convert to string as if it went through the DB
968                     $localcfg[$n] = (string)$v;
969                 }
970             }
971         }
972         return (object)$localcfg;
974     } else {
975         // this part is not really used any more, but anyway...
976         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
977         foreach($CFG->config_php_settings as $n=>$v) {
978             if (is_null($v) or is_array($v) or is_object($v)) {
979                 // we do not want any extra mess here, just real settings that could be saved in db
980                 unset($localcfg[$n]);
981             } else {
982                 //convert to string as if it went through the DB
983                 $localcfg[$n] = (string)$v;
984             }
985         }
986         return (object)$localcfg;
987     }
990 /**
991  * Removes a key from global configuration
992  *
993  * @param string $name the key to set
994  * @param string $plugin (optional) the plugin scope
995  * @global object
996  * @return boolean whether the operation succeeded.
997  */
998 function unset_config($name, $plugin=NULL) {
999     global $CFG, $DB;
1001     if (empty($plugin)) {
1002         unset($CFG->$name);
1003         $DB->delete_records('config', array('name'=>$name));
1004     } else {
1005         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1006     }
1008     return true;
1011 /**
1012  * Remove all the config variables for a given plugin.
1013  *
1014  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1015  * @return boolean whether the operation succeeded.
1016  */
1017 function unset_all_config_for_plugin($plugin) {
1018     global $DB;
1019     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1020     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
1021     return true;
1024 /**
1025  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1026  *
1027  * All users are verified if they still have the necessary capability.
1028  *
1029  * @param string $value the value of the config setting.
1030  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1031  * @param bool $include admins, include administrators
1032  * @return array of user objects.
1033  */
1034 function get_users_from_config($value, $capability, $includeadmins = true) {
1035     global $CFG, $DB;
1037     if (empty($value) or $value === '$@NONE@$') {
1038         return array();
1039     }
1041     // we have to make sure that users still have the necessary capability,
1042     // it should be faster to fetch them all first and then test if they are present
1043     // instead of validating them one-by-one
1044     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1045     if ($includeadmins) {
1046         $admins = get_admins();
1047         foreach ($admins as $admin) {
1048             $users[$admin->id] = $admin;
1049         }
1050     }
1052     if ($value === '$@ALL@$') {
1053         return $users;
1054     }
1056     $result = array(); // result in correct order
1057     $allowed = explode(',', $value);
1058     foreach ($allowed as $uid) {
1059         if (isset($users[$uid])) {
1060             $user = $users[$uid];
1061             $result[$user->id] = $user;
1062         }
1063     }
1065     return $result;
1069 /**
1070  * Invalidates browser caches and cached data in temp
1071  * @return void
1072  */
1073 function purge_all_caches() {
1074     global $CFG;
1076     remove_dir("$CFG->dataroot/rss", true);
1078     reset_text_filters_cache();
1079     js_reset_all_caches();
1080     theme_reset_all_caches();
1081     get_string_manager()->reset_caches();
1083     // purge all other caches: simplepie, etc.
1084     remove_dir($CFG->dataroot.'/cache', true);
1086     // some more diagnostics in case site is misconfigured
1087     if (!check_dir_exists($CFG->dataroot.'/cache', true, true)) {
1088         debugging('Can not create cache directory, please check permissions in dataroot.');
1089     } else if (!is_writeable($CFG->dataroot.'/cache')) {
1090         debugging('Cache directory is not writeable, please verify permissions in dataroot.');
1091     }
1093     clearstatcache();
1096 /**
1097  * Get volatile flags
1098  *
1099  * @param string $type
1100  * @param int    $changedsince default null
1101  * @return records array
1102  */
1103 function get_cache_flags($type, $changedsince=NULL) {
1104     global $DB;
1106     $params = array('type'=>$type, 'expiry'=>time());
1107     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1108     if ($changedsince !== NULL) {
1109         $params['changedsince'] = $changedsince;
1110         $sqlwhere .= " AND timemodified > :changedsince";
1111     }
1112     $cf = array();
1114     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1115         foreach ($flags as $flag) {
1116             $cf[$flag->name] = $flag->value;
1117         }
1118     }
1119     return $cf;
1122 /**
1123  * Get volatile flags
1124  *
1125  * @param string $type
1126  * @param string $name
1127  * @param int    $changedsince default null
1128  * @return records array
1129  */
1130 function get_cache_flag($type, $name, $changedsince=NULL) {
1131     global $DB;
1133     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1135     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1136     if ($changedsince !== NULL) {
1137         $params['changedsince'] = $changedsince;
1138         $sqlwhere .= " AND timemodified > :changedsince";
1139     }
1141     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1144 /**
1145  * Set a volatile flag
1146  *
1147  * @param string $type the "type" namespace for the key
1148  * @param string $name the key to set
1149  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1150  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1151  * @return bool Always returns true
1152  */
1153 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1154     global $DB;
1156     $timemodified = time();
1157     if ($expiry===NULL || $expiry < $timemodified) {
1158         $expiry = $timemodified + 24 * 60 * 60;
1159     } else {
1160         $expiry = (int)$expiry;
1161     }
1163     if ($value === NULL) {
1164         unset_cache_flag($type,$name);
1165         return true;
1166     }
1168     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potentail problem in DEBUG_DEVELOPER
1169         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1170             return true; //no need to update; helps rcache too
1171         }
1172         $f->value        = $value;
1173         $f->expiry       = $expiry;
1174         $f->timemodified = $timemodified;
1175         $DB->update_record('cache_flags', $f);
1176     } else {
1177         $f = new object();
1178         $f->flagtype     = $type;
1179         $f->name         = $name;
1180         $f->value        = $value;
1181         $f->expiry       = $expiry;
1182         $f->timemodified = $timemodified;
1183         $DB->insert_record('cache_flags', $f);
1184     }
1185     return true;
1188 /**
1189  * Removes a single volatile flag
1190  *
1191  * @global object
1192  * @param string $type the "type" namespace for the key
1193  * @param string $name the key to set
1194  * @return bool
1195  */
1196 function unset_cache_flag($type, $name) {
1197     global $DB;
1198     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1199     return true;
1202 /**
1203  * Garbage-collect volatile flags
1204  *
1205  * @return bool Always returns true
1206  */
1207 function gc_cache_flags() {
1208     global $DB;
1209     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1210     return true;
1213 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1215 /**
1216  * Refresh current $USER session global variable with all their current preferences.
1217  *
1218  * @global object
1219  * @param mixed $time default null
1220  * @return void
1221  */
1222 function check_user_preferences_loaded($time = null) {
1223     global $USER, $DB;
1224     static $timenow = null; // Static cache, so we only check up-to-dateness once per request.
1226     if (!empty($USER->preference) && isset($USER->preference['_lastloaded'])) {
1227         // Already loaded. Are we up to date?
1229         if (is_null($timenow) || (!is_null($time) && $time != $timenow)) {
1230             $timenow = time();
1231             if (!get_cache_flag('userpreferenceschanged', $USER->id, $USER->preference['_lastloaded'])) {
1232                 // We are up-to-date.
1233                 return;
1234             }
1235         } else {
1236             // Already checked for up-to-date-ness.
1237             return;
1238         }
1239     }
1241     // OK, so we have to reload. Reset preference
1242     $USER->preference = array();
1244     if (!isloggedin() or isguestuser()) {
1245         // No permanent storage for not-logged-in user and guest
1247     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
1248         foreach ($preferences as $preference) {
1249             $USER->preference[$preference->name] = $preference->value;
1250         }
1251     }
1253     $USER->preference['_lastloaded'] = $timenow;
1256 /**
1257  * Called from set/delete_user_preferences, so that the prefs can be correctly reloaded.
1258  *
1259  * @global object
1260  * @global object
1261  * @param integer $userid the user whose prefs were changed.
1262  */
1263 function mark_user_preferences_changed($userid) {
1264     global $CFG, $USER;
1265     if ($userid == $USER->id) {
1266         check_user_preferences_loaded(time());
1267     }
1268     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1271 /**
1272  * Sets a preference for the current user
1273  *
1274  * Optionally, can set a preference for a different user object
1275  *
1276  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
1277  *
1278  * @global object
1279  * @global object
1280  * @param string $name The key to set as preference for the specified user
1281  * @param string $value The value to set for the $name key in the specified user's record
1282  * @param int $otheruserid A moodle user ID, default null
1283  * @return bool
1284  */
1285 function set_user_preference($name, $value, $otheruserid=NULL) {
1286     global $USER, $DB;
1288     if (empty($name)) {
1289         return false;
1290     }
1292     $nostore = false;
1293     if (empty($otheruserid)){
1294         if (!isloggedin() or isguestuser()) {
1295             $nostore = true;
1296         }
1297         $userid = $USER->id;
1298     } else {
1299         if (isguestuser($otheruserid)) {
1300             $nostore = true;
1301         }
1302         $userid = $otheruserid;
1303     }
1305     if ($nostore) {
1306         // no permanent storage for not-logged-in user and guest
1308     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
1309         if ($preference->value === $value) {
1310             return true;
1311         }
1312         $DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id));
1314     } else {
1315         $preference = new object();
1316         $preference->userid = $userid;
1317         $preference->name   = $name;
1318         $preference->value  = (string)$value;
1319         $DB->insert_record('user_preferences', $preference);
1320     }
1322     mark_user_preferences_changed($userid);
1323     // update value in USER session if needed
1324     if ($userid == $USER->id) {
1325         $USER->preference[$name] = (string)$value;
1326         $USER->preference['_lastloaded'] = time();
1327     }
1329     return true;
1332 /**
1333  * Sets a whole array of preferences for the current user
1334  *
1335  * @param array $prefarray An array of key/value pairs to be set
1336  * @param int $otheruserid A moodle user ID
1337  * @return bool
1338  */
1339 function set_user_preferences($prefarray, $otheruserid=NULL) {
1341     if (!is_array($prefarray) or empty($prefarray)) {
1342         return false;
1343     }
1345     foreach ($prefarray as $name => $value) {
1346         set_user_preference($name, $value, $otheruserid);
1347     }
1348     return true;
1351 /**
1352  * Unsets a preference completely by deleting it from the database
1353  *
1354  * Optionally, can set a preference for a different user id
1355  *
1356  * @global object
1357  * @param string  $name The key to unset as preference for the specified user
1358  * @param int $otheruserid A moodle user ID
1359  */
1360 function unset_user_preference($name, $otheruserid=NULL) {
1361     global $USER, $DB;
1363     if (empty($otheruserid)){
1364         $userid = $USER->id;
1365         check_user_preferences_loaded();
1366     } else {
1367         $userid = $otheruserid;
1368     }
1370     //Then from DB
1371     $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
1373     mark_user_preferences_changed($userid);
1374     //Delete the preference from $USER if needed
1375     if ($userid == $USER->id) {
1376         unset($USER->preference[$name]);
1377         $USER->preference['_lastloaded'] = time();
1378     }
1380     return true;
1383 /**
1384  * Used to fetch user preference(s)
1385  *
1386  * If no arguments are supplied this function will return
1387  * all of the current user preferences as an array.
1388  *
1389  * If a name is specified then this function
1390  * attempts to return that particular preference value.  If
1391  * none is found, then the optional value $default is returned,
1392  * otherwise NULL.
1393  *
1394  * @global object
1395  * @global object
1396  * @param string $name Name of the key to use in finding a preference value
1397  * @param string $default Value to be returned if the $name key is not set in the user preferences
1398  * @param int $otheruserid A moodle user ID
1399  * @return string
1400  */
1401 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1402     global $USER, $DB;
1404     if (empty($otheruserid) || (isloggedin() && ($USER->id == $otheruserid))){
1405         check_user_preferences_loaded();
1407         if (empty($name)) {
1408             return $USER->preference; // All values
1409         } else if (array_key_exists($name, $USER->preference)) {
1410             return $USER->preference[$name]; // The single value
1411         } else {
1412             return $default; // Default value (or NULL)
1413         }
1415     } else {
1416         if (empty($name)) {
1417             return $DB->get_records_menu('user_preferences', array('userid'=>$otheruserid), '', 'name,value'); // All values
1418         } else if ($value = $DB->get_field('user_preferences', 'value', array('userid'=>$otheruserid, 'name'=>$name))) {
1419             return $value; // The single value
1420         } else {
1421             return $default; // Default value (or NULL)
1422         }
1423     }
1426 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1428 /**
1429  * Given date parts in user time produce a GMT timestamp.
1430  *
1431  * @todo Finish documenting this function
1432  * @param int $year The year part to create timestamp of
1433  * @param int $month The month part to create timestamp of
1434  * @param int $day The day part to create timestamp of
1435  * @param int $hour The hour part to create timestamp of
1436  * @param int $minute The minute part to create timestamp of
1437  * @param int $second The second part to create timestamp of
1438  * @param float $timezone Timezone modifier
1439  * @param bool $applydst Toggle Daylight Saving Time, default true
1440  * @return int timestamp
1441  */
1442 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1444     $strtimezone = NULL;
1445     if (!is_numeric($timezone)) {
1446         $strtimezone = $timezone;
1447     }
1449     $timezone = get_user_timezone_offset($timezone);
1451     if (abs($timezone) > 13) {
1452         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1453     } else {
1454         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1455         $time = usertime($time, $timezone);
1456         if($applydst) {
1457             $time -= dst_offset_on($time, $strtimezone);
1458         }
1459     }
1461     return $time;
1465 /**
1466  * Format a date/time (seconds) as weeks, days, hours etc as needed
1467  *
1468  * Given an amount of time in seconds, returns string
1469  * formatted nicely as weeks, days, hours etc as needed
1470  *
1471  * @uses MINSECS
1472  * @uses HOURSECS
1473  * @uses DAYSECS
1474  * @uses YEARSECS
1475  * @param int $totalsecs Time in seconds
1476  * @param object $str Should be a time object
1477  * @return string A nicely formatted date/time string
1478  */
1479  function format_time($totalsecs, $str=NULL) {
1481     $totalsecs = abs($totalsecs);
1483     if (!$str) {  // Create the str structure the slow way
1484         $str->day   = get_string('day');
1485         $str->days  = get_string('days');
1486         $str->hour  = get_string('hour');
1487         $str->hours = get_string('hours');
1488         $str->min   = get_string('min');
1489         $str->mins  = get_string('mins');
1490         $str->sec   = get_string('sec');
1491         $str->secs  = get_string('secs');
1492         $str->year  = get_string('year');
1493         $str->years = get_string('years');
1494     }
1497     $years     = floor($totalsecs/YEARSECS);
1498     $remainder = $totalsecs - ($years*YEARSECS);
1499     $days      = floor($remainder/DAYSECS);
1500     $remainder = $totalsecs - ($days*DAYSECS);
1501     $hours     = floor($remainder/HOURSECS);
1502     $remainder = $remainder - ($hours*HOURSECS);
1503     $mins      = floor($remainder/MINSECS);
1504     $secs      = $remainder - ($mins*MINSECS);
1506     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1507     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1508     $sh = ($hours == 1) ? $str->hour : $str->hours;
1509     $sd = ($days == 1)  ? $str->day  : $str->days;
1510     $sy = ($years == 1)  ? $str->year  : $str->years;
1512     $oyears = '';
1513     $odays = '';
1514     $ohours = '';
1515     $omins = '';
1516     $osecs = '';
1518     if ($years)  $oyears  = $years .' '. $sy;
1519     if ($days)  $odays  = $days .' '. $sd;
1520     if ($hours) $ohours = $hours .' '. $sh;
1521     if ($mins)  $omins  = $mins .' '. $sm;
1522     if ($secs)  $osecs  = $secs .' '. $ss;
1524     if ($years) return trim($oyears .' '. $odays);
1525     if ($days)  return trim($odays .' '. $ohours);
1526     if ($hours) return trim($ohours .' '. $omins);
1527     if ($mins)  return trim($omins .' '. $osecs);
1528     if ($secs)  return $osecs;
1529     return get_string('now');
1532 /**
1533  * Returns a formatted string that represents a date in user time
1534  *
1535  * Returns a formatted string that represents a date in user time
1536  * <b>WARNING: note that the format is for strftime(), not date().</b>
1537  * Because of a bug in most Windows time libraries, we can't use
1538  * the nicer %e, so we have to use %d which has leading zeroes.
1539  * A lot of the fuss in the function is just getting rid of these leading
1540  * zeroes as efficiently as possible.
1541  *
1542  * If parameter fixday = true (default), then take off leading
1543  * zero from %d, else maintain it.
1544  *
1545  * @param int $date the timestamp in UTC, as obtained from the database.
1546  * @param string $format strftime format. You should probably get this using
1547  *      get_string('strftime...', 'langconfig');
1548  * @param float $timezone by default, uses the user's time zone.
1549  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1550  *      If false then the leading zero is maintained.
1551  * @return string the formatted date/time.
1552  */
1553 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1555     global $CFG;
1557     $strtimezone = NULL;
1558     if (!is_numeric($timezone)) {
1559         $strtimezone = $timezone;
1560     }
1562     if (empty($format)) {
1563         $format = get_string('strftimedaydatetime', 'langconfig');
1564     }
1566     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1567         $fixday = false;
1568     } else if ($fixday) {
1569         $formatnoday = str_replace('%d', 'DD', $format);
1570         $fixday = ($formatnoday != $format);
1571     }
1573     $date += dst_offset_on($date, $strtimezone);
1575     $timezone = get_user_timezone_offset($timezone);
1577     if (abs($timezone) > 13) {   /// Server time
1578         if ($fixday) {
1579             $datestring = strftime($formatnoday, $date);
1580             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1581             $datestring = str_replace('DD', $daystring, $datestring);
1582         } else {
1583             $datestring = strftime($format, $date);
1584         }
1585     } else {
1586         $date += (int)($timezone * 3600);
1587         if ($fixday) {
1588             $datestring = gmstrftime($formatnoday, $date);
1589             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1590             $datestring = str_replace('DD', $daystring, $datestring);
1591         } else {
1592             $datestring = gmstrftime($format, $date);
1593         }
1594     }
1596 /// If we are running under Windows convert from windows encoding to UTF-8
1597 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1599    if ($CFG->ostype == 'WINDOWS') {
1600        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1601            $textlib = textlib_get_instance();
1602            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1603        }
1604    }
1606     return $datestring;
1609 /**
1610  * Given a $time timestamp in GMT (seconds since epoch),
1611  * returns an array that represents the date in user time
1612  *
1613  * @todo Finish documenting this function
1614  * @uses HOURSECS
1615  * @param int $time Timestamp in GMT
1616  * @param float $timezone ?
1617  * @return array An array that represents the date in user time
1618  */
1619 function usergetdate($time, $timezone=99) {
1621     $strtimezone = NULL;
1622     if (!is_numeric($timezone)) {
1623         $strtimezone = $timezone;
1624     }
1626     $timezone = get_user_timezone_offset($timezone);
1628     if (abs($timezone) > 13) {    // Server time
1629         return getdate($time);
1630     }
1632     // There is no gmgetdate so we use gmdate instead
1633     $time += dst_offset_on($time, $strtimezone);
1634     $time += intval((float)$timezone * HOURSECS);
1636     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1638     //be careful to ensure the returned array matches that produced by getdate() above
1639     list(
1640         $getdate['month'],
1641         $getdate['weekday'],
1642         $getdate['yday'],
1643         $getdate['year'],
1644         $getdate['mon'],
1645         $getdate['wday'],
1646         $getdate['mday'],
1647         $getdate['hours'],
1648         $getdate['minutes'],
1649         $getdate['seconds']
1650     ) = explode('_', $datestring);
1652     return $getdate;
1655 /**
1656  * Given a GMT timestamp (seconds since epoch), offsets it by
1657  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1658  *
1659  * @uses HOURSECS
1660  * @param  int $date Timestamp in GMT
1661  * @param float $timezone
1662  * @return int
1663  */
1664 function usertime($date, $timezone=99) {
1666     $timezone = get_user_timezone_offset($timezone);
1668     if (abs($timezone) > 13) {
1669         return $date;
1670     }
1671     return $date - (int)($timezone * HOURSECS);
1674 /**
1675  * Given a time, return the GMT timestamp of the most recent midnight
1676  * for the current user.
1677  *
1678  * @param int $date Timestamp in GMT
1679  * @param float $timezone Defaults to user's timezone
1680  * @return int Returns a GMT timestamp
1681  */
1682 function usergetmidnight($date, $timezone=99) {
1684     $userdate = usergetdate($date, $timezone);
1686     // Time of midnight of this user's day, in GMT
1687     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1691 /**
1692  * Returns a string that prints the user's timezone
1693  *
1694  * @param float $timezone The user's timezone
1695  * @return string
1696  */
1697 function usertimezone($timezone=99) {
1699     $tz = get_user_timezone($timezone);
1701     if (!is_float($tz)) {
1702         return $tz;
1703     }
1705     if(abs($tz) > 13) { // Server time
1706         return get_string('serverlocaltime');
1707     }
1709     if($tz == intval($tz)) {
1710         // Don't show .0 for whole hours
1711         $tz = intval($tz);
1712     }
1714     if($tz == 0) {
1715         return 'UTC';
1716     }
1717     else if($tz > 0) {
1718         return 'UTC+'.$tz;
1719     }
1720     else {
1721         return 'UTC'.$tz;
1722     }
1726 /**
1727  * Returns a float which represents the user's timezone difference from GMT in hours
1728  * Checks various settings and picks the most dominant of those which have a value
1729  *
1730  * @global object
1731  * @global object
1732  * @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
1733  * @return float
1734  */
1735 function get_user_timezone_offset($tz = 99) {
1737     global $USER, $CFG;
1739     $tz = get_user_timezone($tz);
1741     if (is_float($tz)) {
1742         return $tz;
1743     } else {
1744         $tzrecord = get_timezone_record($tz);
1745         if (empty($tzrecord)) {
1746             return 99.0;
1747         }
1748         return (float)$tzrecord->gmtoff / HOURMINS;
1749     }
1752 /**
1753  * Returns an int which represents the systems's timezone difference from GMT in seconds
1754  *
1755  * @global object
1756  * @param mixed $tz timezone
1757  * @return int if found, false is timezone 99 or error
1758  */
1759 function get_timezone_offset($tz) {
1760     global $CFG;
1762     if ($tz == 99) {
1763         return false;
1764     }
1766     if (is_numeric($tz)) {
1767         return intval($tz * 60*60);
1768     }
1770     if (!$tzrecord = get_timezone_record($tz)) {
1771         return false;
1772     }
1773     return intval($tzrecord->gmtoff * 60);
1776 /**
1777  * Returns a float or a string which denotes the user's timezone
1778  * 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)
1779  * means that for this timezone there are also DST rules to be taken into account
1780  * Checks various settings and picks the most dominant of those which have a value
1781  *
1782  * @global object
1783  * @global object
1784  * @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
1785  * @return mixed
1786  */
1787 function get_user_timezone($tz = 99) {
1788     global $USER, $CFG;
1790     $timezones = array(
1791         $tz,
1792         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1793         isset($USER->timezone) ? $USER->timezone : 99,
1794         isset($CFG->timezone) ? $CFG->timezone : 99,
1795         );
1797     $tz = 99;
1799     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1800         $tz = $next['value'];
1801     }
1803     return is_numeric($tz) ? (float) $tz : $tz;
1806 /**
1807  * Returns cached timezone record for given $timezonename
1808  *
1809  * @global object
1810  * @global object
1811  * @param string $timezonename
1812  * @return mixed timezonerecord object or false
1813  */
1814 function get_timezone_record($timezonename) {
1815     global $CFG, $DB;
1816     static $cache = NULL;
1818     if ($cache === NULL) {
1819         $cache = array();
1820     }
1822     if (isset($cache[$timezonename])) {
1823         return $cache[$timezonename];
1824     }
1826     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1827                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1830 /**
1831  * Build and store the users Daylight Saving Time (DST) table
1832  *
1833  * @global object
1834  * @global object
1835  * @global object
1836  * @param mixed $from_year Start year for the table, defaults to 1971
1837  * @param mixed $to_year End year for the table, defaults to 2035
1838  * @param mixed $strtimezone
1839  * @return bool
1840  */
1841 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1842     global $CFG, $SESSION, $DB;
1844     $usertz = get_user_timezone($strtimezone);
1846     if (is_float($usertz)) {
1847         // Trivial timezone, no DST
1848         return false;
1849     }
1851     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1852         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1853         unset($SESSION->dst_offsets);
1854         unset($SESSION->dst_range);
1855     }
1857     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1858         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1859         // This will be the return path most of the time, pretty light computationally
1860         return true;
1861     }
1863     // Reaching here means we either need to extend our table or create it from scratch
1865     // Remember which TZ we calculated these changes for
1866     $SESSION->dst_offsettz = $usertz;
1868     if(empty($SESSION->dst_offsets)) {
1869         // If we 're creating from scratch, put the two guard elements in there
1870         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1871     }
1872     if(empty($SESSION->dst_range)) {
1873         // If creating from scratch
1874         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1875         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1877         // Fill in the array with the extra years we need to process
1878         $yearstoprocess = array();
1879         for($i = $from; $i <= $to; ++$i) {
1880             $yearstoprocess[] = $i;
1881         }
1883         // Take note of which years we have processed for future calls
1884         $SESSION->dst_range = array($from, $to);
1885     }
1886     else {
1887         // If needing to extend the table, do the same
1888         $yearstoprocess = array();
1890         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1891         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1893         if($from < $SESSION->dst_range[0]) {
1894             // Take note of which years we need to process and then note that we have processed them for future calls
1895             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1896                 $yearstoprocess[] = $i;
1897             }
1898             $SESSION->dst_range[0] = $from;
1899         }
1900         if($to > $SESSION->dst_range[1]) {
1901             // Take note of which years we need to process and then note that we have processed them for future calls
1902             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1903                 $yearstoprocess[] = $i;
1904             }
1905             $SESSION->dst_range[1] = $to;
1906         }
1907     }
1909     if(empty($yearstoprocess)) {
1910         // This means that there was a call requesting a SMALLER range than we have already calculated
1911         return true;
1912     }
1914     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1915     // Also, the array is sorted in descending timestamp order!
1917     // Get DB data
1919     static $presets_cache = array();
1920     if (!isset($presets_cache[$usertz])) {
1921         $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');
1922     }
1923     if(empty($presets_cache[$usertz])) {
1924         return false;
1925     }
1927     // Remove ending guard (first element of the array)
1928     reset($SESSION->dst_offsets);
1929     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1931     // Add all required change timestamps
1932     foreach($yearstoprocess as $y) {
1933         // Find the record which is in effect for the year $y
1934         foreach($presets_cache[$usertz] as $year => $preset) {
1935             if($year <= $y) {
1936                 break;
1937             }
1938         }
1940         $changes = dst_changes_for_year($y, $preset);
1942         if($changes === NULL) {
1943             continue;
1944         }
1945         if($changes['dst'] != 0) {
1946             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1947         }
1948         if($changes['std'] != 0) {
1949             $SESSION->dst_offsets[$changes['std']] = 0;
1950         }
1951     }
1953     // Put in a guard element at the top
1954     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1955     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1957     // Sort again
1958     krsort($SESSION->dst_offsets);
1960     return true;
1963 /**
1964  * Calculates the required DST change and returns a Timestamp Array
1965  *
1966  * @uses HOURSECS
1967  * @uses MINSECS
1968  * @param mixed $year Int or String Year to focus on
1969  * @param object $timezone Instatiated Timezone object
1970  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
1971  */
1972 function dst_changes_for_year($year, $timezone) {
1974     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1975         return NULL;
1976     }
1978     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1979     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1981     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1982     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1984     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1985     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1987     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1988     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1989     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1991     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1992     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1994     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1997 /**
1998  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
1999  *
2000  * @global object
2001  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2002  * @return int
2003  */
2004 function dst_offset_on($time, $strtimezone = NULL) {
2005     global $SESSION;
2007     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2008         return 0;
2009     }
2011     reset($SESSION->dst_offsets);
2012     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2013         if($from <= $time) {
2014             break;
2015         }
2016     }
2018     // This is the normal return path
2019     if($offset !== NULL) {
2020         return $offset;
2021     }
2023     // Reaching this point means we haven't calculated far enough, do it now:
2024     // Calculate extra DST changes if needed and recurse. The recursion always
2025     // moves toward the stopping condition, so will always end.
2027     if($from == 0) {
2028         // We need a year smaller than $SESSION->dst_range[0]
2029         if($SESSION->dst_range[0] == 1971) {
2030             return 0;
2031         }
2032         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2033         return dst_offset_on($time, $strtimezone);
2034     }
2035     else {
2036         // We need a year larger than $SESSION->dst_range[1]
2037         if($SESSION->dst_range[1] == 2035) {
2038             return 0;
2039         }
2040         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2041         return dst_offset_on($time, $strtimezone);
2042     }
2045 /**
2046  * ?
2047  *
2048  * @todo Document what this function does
2049  * @param int $startday
2050  * @param int $weekday
2051  * @param int $month
2052  * @param int $year
2053  * @return int
2054  */
2055 function find_day_in_month($startday, $weekday, $month, $year) {
2057     $daysinmonth = days_in_month($month, $year);
2059     if($weekday == -1) {
2060         // Don't care about weekday, so return:
2061         //    abs($startday) if $startday != -1
2062         //    $daysinmonth otherwise
2063         return ($startday == -1) ? $daysinmonth : abs($startday);
2064     }
2066     // From now on we 're looking for a specific weekday
2068     // Give "end of month" its actual value, since we know it
2069     if($startday == -1) {
2070         $startday = -1 * $daysinmonth;
2071     }
2073     // Starting from day $startday, the sign is the direction
2075     if($startday < 1) {
2077         $startday = abs($startday);
2078         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2080         // This is the last such weekday of the month
2081         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2082         if($lastinmonth > $daysinmonth) {
2083             $lastinmonth -= 7;
2084         }
2086         // Find the first such weekday <= $startday
2087         while($lastinmonth > $startday) {
2088             $lastinmonth -= 7;
2089         }
2091         return $lastinmonth;
2093     }
2094     else {
2096         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
2098         $diff = $weekday - $indexweekday;
2099         if($diff < 0) {
2100             $diff += 7;
2101         }
2103         // This is the first such weekday of the month equal to or after $startday
2104         $firstfromindex = $startday + $diff;
2106         return $firstfromindex;
2108     }
2111 /**
2112  * Calculate the number of days in a given month
2113  *
2114  * @param int $month The month whose day count is sought
2115  * @param int $year The year of the month whose day count is sought
2116  * @return int
2117  */
2118 function days_in_month($month, $year) {
2119    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
2122 /**
2123  * Calculate the position in the week of a specific calendar day
2124  *
2125  * @param int $day The day of the date whose position in the week is sought
2126  * @param int $month The month of the date whose position in the week is sought
2127  * @param int $year The year of the date whose position in the week is sought
2128  * @return int
2129  */
2130 function dayofweek($day, $month, $year) {
2131     // I wonder if this is any different from
2132     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2133     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
2136 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2138 /**
2139  * Returns full login url.
2140  *
2141  * @global object
2142  * @param bool $loginguest add login guest param, return false
2143  * @return string login url
2144  */
2145 function get_login_url($loginguest=false) {
2146     global $CFG;
2148     if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
2149         $loginguest = $loginguest ? '?loginguest=true' : '';
2150         $url = "$CFG->wwwroot/login/index.php$loginguest";
2152     } else {
2153         $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2154         $url = "$wwwroot/login/index.php";
2155     }
2157     return $url;
2160 /**
2161  * This function checks that the current user is logged in and has the
2162  * required privileges
2163  *
2164  * This function checks that the current user is logged in, and optionally
2165  * whether they are allowed to be in a particular course and view a particular
2166  * course module.
2167  * If they are not logged in, then it redirects them to the site login unless
2168  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2169  * case they are automatically logged in as guests.
2170  * If $courseid is given and the user is not enrolled in that course then the
2171  * user is redirected to the course enrolment page.
2172  * If $cm is given and the course module is hidden and the user is not a teacher
2173  * in the course then the user is redirected to the course home page.
2174  *
2175  * When $cm parameter specified, this function sets page layout to 'module'.
2176  * You need to change it manually later if some other layout needed.
2177  *
2178  * @param mixed $courseorid id of the course or course object
2179  * @param bool $autologinguest default true
2180  * @param object $cm course module object
2181  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2182  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2183  *             in order to keep redirects working properly. MDL-14495
2184  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2185  * @return mixed Void, exit, and die depending on path
2186  */
2187 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2188     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2190     // setup global $COURSE, themes, language and locale
2191     if (!empty($courseorid)) {
2192         if (is_object($courseorid)) {
2193             $course = $courseorid;
2194         } else if ($courseorid == SITEID) {
2195             $course = clone($SITE);
2196         } else {
2197             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2198         }
2199         if ($cm) {
2200             if ($cm->course != $course->id) {
2201                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2202             }
2203             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2204             $PAGE->set_pagelayout('incourse');
2205         } else {
2206             $PAGE->set_course($course); // set's up global $COURSE
2207         }
2208     } else {
2209         // do not touch global $COURSE via $PAGE->set_course(),
2210         // the reasons is we need to be able to call require_login() at any time!!
2211         $course = $SITE;
2212         if ($cm) {
2213             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2214         }
2215     }
2217     // If the user is not even logged in yet then make sure they are
2218     if (!isloggedin()) {
2219         //NOTE: $USER->site check was obsoleted by session test cookie,
2220         //      $USER->confirmed test is in login/index.php
2221         if ($preventredirect) {
2222             throw new require_login_exception('You are not logged in');
2223         }
2225         if ($setwantsurltome) {
2226             $SESSION->wantsurl = $FULLME;
2227         }
2228         if (!empty($_SERVER['HTTP_REFERER'])) {
2229             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2230         }
2231         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2232             if ($course->id == SITEID) {
2233                 $loginguest = true;
2234             } else {
2235                 $loginguest = false;
2236             }
2237         } else {
2238             $loginguest = false;
2239         }
2240         redirect(get_login_url($loginguest));
2241         exit; // never reached
2242     }
2244     // loginas as redirection if needed
2245     if ($course->id != SITEID and session_is_loggedinas()) {
2246         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2247             if ($USER->loginascontext->instanceid != $course->id) {
2248                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2249             }
2250         }
2251     }
2253     // check whether the user should be changing password (but only if it is REALLY them)
2254     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2255         $userauth = get_auth_plugin($USER->auth);
2256         if ($userauth->can_change_password() and !$preventredirect) {
2257             $SESSION->wantsurl = $FULLME;
2258             if ($changeurl = $userauth->change_password_url()) {
2259                 //use plugin custom url
2260                 redirect($changeurl);
2261             } else {
2262                 //use moodle internal method
2263                 if (empty($CFG->loginhttps)) {
2264                     redirect($CFG->wwwroot .'/login/change_password.php');
2265                 } else {
2266                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2267                     redirect($wwwroot .'/login/change_password.php');
2268                 }
2269             }
2270         } else {
2271             print_error('nopasswordchangeforced', 'auth');
2272         }
2273     }
2275     // Check that the user account is properly set up
2276     if (user_not_fully_set_up($USER)) {
2277         if ($preventredirect) {
2278             throw new require_login_exception('User not fully set-up');
2279         }
2280         $SESSION->wantsurl = $FULLME;
2281         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2282     }
2284     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2285     sesskey();
2287     // Do not bother admins with any formalities
2288     if (is_siteadmin()) {
2289         //set accesstime or the user will appear offline which messes up messaging
2290         user_accesstime_log($course->id);
2291         return;
2292     }
2294     // Check that the user has agreed to a site policy if there is one
2295     if (!empty($CFG->sitepolicy)) {
2296         if ($preventredirect) {
2297             throw new require_login_exception('Policy not agreed');
2298         }
2299         if (!$USER->policyagreed) {
2300             $SESSION->wantsurl = $FULLME;
2301             redirect($CFG->wwwroot .'/user/policy.php');
2302         }
2303     }
2305     // Fetch the system context, the course context, and prefetch its child contexts
2306     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2307     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2308     if ($cm) {
2309         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2310     } else {
2311         $cmcontext = null;
2312     }
2314     // If the site is currently under maintenance, then print a message
2315     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2316         if ($preventredirect) {
2317             throw new require_login_exception('Maintenance in progress');
2318         }
2320         print_maintenance_message();
2321     }
2323     // make sure the course itself is not hidden
2324     if ($course->id == SITEID) {
2325         // frontpage can not be hidden
2326     } else {
2327         if (!empty($USER->access['rsw'][$coursecontext->path])) {
2328             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2329         } else {
2330             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2331                 // originally there was also test of parent category visibility,
2332                 // BUT is was very slow in complex queries involving "my courses"
2333                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2334                 if ($preventredirect) {
2335                     throw new require_login_exception('Course is hidden');
2336                 }
2337                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2338             }
2339         }
2340     }
2342     // is the user enrolled?
2343     if ($course->id == SITEID) {
2344         // everybody is enrolled on the frontpage
2346     } else {
2347         if (session_is_loggedinas()) {
2348             // Make sure the REAL person can access this course first
2349             $realuser = session_get_realuser();
2350             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2351                 if ($preventredirect) {
2352                     throw new require_login_exception('Invalid course login-as access');
2353                 }
2354                 echo $OUTPUT->header();
2355                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2356             }
2357         }
2359         // very simple enrolment caching - changes in course setting are not reflected immediately
2360         if (!isset($USER->enrol)) {
2361             $USER->enrol = array();
2362             $USER->enrol['enrolled'] = array();
2363             $USER->enrol['tempguest'] = array();
2364         }
2366         $access = false;
2368         if (is_viewing($coursecontext, $USER)) {
2369             // ok, no need to mess with enrol
2370             $access = true;
2372         } else {
2373             if (isset($USER->enrol['enrolled'][$course->id])) {
2374                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2375                     $access = true;
2376                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2377                     $access = true;
2378                 } else {
2379                     //expired
2380                     unset($USER->enrol['enrolled'][$course->id]);
2381                 }
2382             }
2383             if (isset($USER->enrol['tempguest'][$course->id])) {
2384                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2385                     $access = true;
2386                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2387                     $access = true;
2388                 } else {
2389                     //expired
2390                     unset($USER->enrol['tempguest'][$course->id]);
2391                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2392                 }
2393             }
2395             if ($access) {
2396                 // cache ok
2397             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2398                 // active participants may always access
2399                 // TODO: refactor this into some new function
2400                 $now = time();
2401                 $sql = "SELECT MAX(ue.timeend)
2402                           FROM {user_enrolments} ue
2403                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2404                           JOIN {user} u ON u.id = ue.userid
2405                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2406                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2407                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2408                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2409                 $until = $DB->get_field_sql($sql, $params);
2410                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2411                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2412                 }
2414                 $USER->enrol['enrolled'][$course->id] = $until;
2415                 $access = true;
2417                 // remove traces of previous temp guest access
2418                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2420             } else {
2421                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2422                 $enrols = enrol_get_plugins(true);
2423                 // first ask all enabled enrol instances in course if they want to auto enrol user
2424                 foreach($instances as $instance) {
2425                     if (!isset($enrols[$instance->enrol])) {
2426                         continue;
2427                     }
2428                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2429                     if ($until !== false) {
2430                         $USER->enrol['enrolled'][$course->id] = $until;
2431                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2432                         $access = true;
2433                         break;
2434                     }
2435                 }
2436                 // if not enrolled yet try to gain temporary guest access
2437                 if (!$access) {
2438                     foreach($instances as $instance) {
2439                         if (!isset($enrols[$instance->enrol])) {
2440                             continue;
2441                         }
2442                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2443                         if ($until !== false) {
2444                             $USER->enrol['tempguest'][$course->id] = $until;
2445                             $access = true;
2446                             break;
2447                         }
2448                     }
2449                 }
2450             }
2451         }
2453         if (!$access) {
2454             if ($preventredirect) {
2455                 throw new require_login_exception('Not enrolled');
2456             }
2457             $SESSION->wantsurl = $FULLME;
2458             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2459         }
2460     }
2462     // test visibility
2463     if ($cm && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2464         if ($preventredirect) {
2465             throw new require_login_exception('Activity is hidden');
2466         }
2467         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2468     }
2470     // groupmembersonly access control
2471     if (!empty($CFG->enablegroupmembersonly) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2472         if (isguestuser() or !groups_has_membership($cm)) {
2473             if ($preventredirect) {
2474                 throw new require_login_exception('Not member of a group');
2475             }
2476             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2477         }
2478     }
2480     // Conditional activity access control
2481     if (!empty($CFG->enableavailability) and $cm) {
2482         // TODO: this is going to work with login-as-user, sorry!
2483         // We cache conditional access in session
2484         if (!isset($SESSION->conditionaccessok)) {
2485             $SESSION->conditionaccessok = array();
2486         }
2487         // If you have been allowed into the module once then you are allowed
2488         // in for rest of session, no need to do conditional checks
2489         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2490             // Get condition info (does a query for the availability table)
2491             require_once($CFG->libdir.'/conditionlib.php');
2492             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2493             // Check condition for user (this will do a query if the availability
2494             // information depends on grade or completion information)
2495             if ($ci->is_available($junk) || has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2496                 $SESSION->conditionaccessok[$cm->id] = true;
2497             } else {
2498                 print_error('activityiscurrentlyhidden');
2499             }
2500         }
2501     }
2503     // Finally access granted, update lastaccess times
2504     user_accesstime_log($course->id);
2508 /**
2509  * This function just makes sure a user is logged out.
2510  *
2511  * @global object
2512  */
2513 function require_logout() {
2514     global $USER;
2516     if (isloggedin()) {
2517         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2519         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2520         foreach($authsequence as $authname) {
2521             $authplugin = get_auth_plugin($authname);
2522             $authplugin->prelogout_hook();
2523         }
2524     }
2526     session_get_instance()->terminate_current();
2529 /**
2530  * Weaker version of require_login()
2531  *
2532  * This is a weaker version of {@link require_login()} which only requires login
2533  * when called from within a course rather than the site page, unless
2534  * the forcelogin option is turned on.
2535  * @see require_login()
2536  *
2537  * @global object
2538  * @param mixed $courseorid The course object or id in question
2539  * @param bool $autologinguest Allow autologin guests if that is wanted
2540  * @param object $cm Course activity module if known
2541  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2542  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2543  *             in order to keep redirects working properly. MDL-14495
2544  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2545  * @return void
2546  */
2547 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2548     global $CFG, $PAGE, $SITE;
2549     if (!empty($CFG->forcelogin)) {
2550         // login required for both SITE and courses
2551         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2553     } else if (!empty($cm) and !$cm->visible) {
2554         // always login for hidden activities
2555         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2557     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2558           or (!is_object($courseorid) and $courseorid == SITEID)) {
2559               //login for SITE not required
2560         if ($cm and empty($cm->visible)) {
2561             // hidden activities are not accessible without login
2562             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2563         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2564             // not-logged-in users do not have any group membership
2565             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2566         } else {
2567             // We still need to instatiate PAGE vars properly so that things
2568             // that rely on it like navigation function correctly.
2569             if (!empty($courseorid)) {
2570                 if (is_object($courseorid)) {
2571                     $course = $courseorid;
2572                 } else {
2573                     $course = clone($SITE);
2574                 }
2575                 if ($cm) {
2576                     if ($cm->course != $course->id) {
2577                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2578                     }
2579                     $PAGE->set_cm($cm, $course);
2580                     $PAGE->set_pagelayout('incourse');
2581                 } else {
2582                     $PAGE->set_course($course);
2583                 }
2584             } else {
2585                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2586                 // up properly, set them up now.
2587                 $PAGE->set_course($PAGE->course);
2588             }
2589             //TODO: verify conditional activities here
2590             user_accesstime_log(SITEID);
2591             return;
2592         }
2594     } else {
2595         // course login always required
2596         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2597     }
2600 /**
2601  * Require key login. Function terminates with error if key not found or incorrect.
2602  *
2603  * @global object
2604  * @global object
2605  * @global object
2606  * @global object
2607  * @uses NO_MOODLE_COOKIES
2608  * @uses PARAM_ALPHANUM
2609  * @param string $script unique script identifier
2610  * @param int $instance optional instance id
2611  * @return int Instance ID
2612  */
2613 function require_user_key_login($script, $instance=null) {
2614     global $USER, $SESSION, $CFG, $DB;
2616     if (!NO_MOODLE_COOKIES) {
2617         print_error('sessioncookiesdisable');
2618     }
2620 /// extra safety
2621     @session_write_close();
2623     $keyvalue = required_param('key', PARAM_ALPHANUM);
2625     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2626         print_error('invalidkey');
2627     }
2629     if (!empty($key->validuntil) and $key->validuntil < time()) {
2630         print_error('expiredkey');
2631     }
2633     if ($key->iprestriction) {
2634         $remoteaddr = getremoteaddr(null);
2635         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2636             print_error('ipmismatch');
2637         }
2638     }
2640     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2641         print_error('invaliduserid');
2642     }
2644 /// emulate normal session
2645     session_set_user($user);
2647 /// note we are not using normal login
2648     if (!defined('USER_KEY_LOGIN')) {
2649         define('USER_KEY_LOGIN', true);
2650     }
2652 /// return isntance id - it might be empty
2653     return $key->instance;
2656 /**
2657  * Creates a new private user access key.
2658  *
2659  * @global object
2660  * @param string $script unique target identifier
2661  * @param int $userid
2662  * @param int $instance optional instance id
2663  * @param string $iprestriction optional ip restricted access
2664  * @param timestamp $validuntil key valid only until given data
2665  * @return string access key value
2666  */
2667 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2668     global $DB;
2670     $key = new object();
2671     $key->script        = $script;
2672     $key->userid        = $userid;
2673     $key->instance      = $instance;
2674     $key->iprestriction = $iprestriction;
2675     $key->validuntil    = $validuntil;
2676     $key->timecreated   = time();
2678     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2679     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2680         // must be unique
2681         $key->value     = md5($userid.'_'.time().random_string(40));
2682     }
2683     $DB->insert_record('user_private_key', $key);
2684     return $key->value;
2687 /**
2688  * Delete the user's new private user access keys for a particular script.
2689  *
2690  * @global object
2691  * @param string $script unique target identifier
2692  * @param int $userid
2693  * @return void
2694  */
2695 function delete_user_key($script,$userid) {
2696     global $DB;
2697     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
2700 /**
2701  * Gets a private user access key (and creates one if one doesn't exist).
2702  *
2703  * @global object
2704  * @param string $script unique target identifier
2705  * @param int $userid
2706  * @param int $instance optional instance id
2707  * @param string $iprestriction optional ip restricted access
2708  * @param timestamp $validuntil key valid only until given data
2709  * @return string access key value
2710  */
2711 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2712     global $DB;
2714     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
2715                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
2716                                                          'validuntil'=>$validuntil))) {
2717         return $key->value;
2718     } else {
2719         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
2720     }
2724 /**
2725  * Modify the user table by setting the currently logged in user's
2726  * last login to now.
2727  *
2728  * @global object
2729  * @global object
2730  * @return bool Always returns true
2731  */
2732 function update_user_login_times() {
2733     global $USER, $DB;
2735     $user = new object();
2736     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2737     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2739     $user->id = $USER->id;
2741     $DB->update_record('user', $user);
2742     return true;
2745 /**
2746  * Determines if a user has completed setting up their account.
2747  *
2748  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
2749  * @return bool
2750  */
2751 function user_not_fully_set_up($user) {
2752     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2755 /**
2756  * Check whether the user has exceeded the bounce threshold
2757  *
2758  * @global object
2759  * @global object
2760  * @param user $user A {@link $USER} object
2761  * @return bool true=>User has exceeded bounce threshold
2762  */
2763 function over_bounce_threshold($user) {
2764     global $CFG, $DB;
2766     if (empty($CFG->handlebounces)) {
2767         return false;
2768     }
2770     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2771         return false;
2772     }
2774     // set sensible defaults
2775     if (empty($CFG->minbounces)) {
2776         $CFG->minbounces = 10;
2777     }
2778     if (empty($CFG->bounceratio)) {
2779         $CFG->bounceratio = .20;
2780     }
2781     $bouncecount = 0;
2782     $sendcount = 0;
2783     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2784         $bouncecount = $bounce->value;
2785     }
2786     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2787         $sendcount = $send->value;
2788     }
2789     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2792 /**
2793  * Used to increment or reset email sent count
2794  *
2795  * @global object
2796  * @param user $user object containing an id
2797  * @param bool $reset will reset the count to 0
2798  * @return void
2799  */
2800 function set_send_count($user,$reset=false) {
2801     global $DB;
2803     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2804         return;
2805     }
2807     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2808         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2809         $DB->update_record('user_preferences', $pref);
2810     }
2811     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2812         // make a new one
2813         $pref = new object();
2814         $pref->name   = 'email_send_count';
2815         $pref->value  = 1;
2816         $pref->userid = $user->id;
2817         $DB->insert_record('user_preferences', $pref, false);
2818     }
2821 /**
2822  * Increment or reset user's email bounce count
2823  *
2824  * @global object
2825  * @param user $user object containing an id
2826  * @param bool $reset will reset the count to 0
2827  */
2828 function set_bounce_count($user,$reset=false) {
2829     global $DB;
2831     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2832         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2833         $DB->update_record('user_preferences', $pref);
2834     }
2835     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2836         // make a new one
2837         $pref = new object();
2838         $pref->name   = 'email_bounce_count';
2839         $pref->value  = 1;
2840         $pref->userid = $user->id;
2841         $DB->insert_record('user_preferences', $pref, false);
2842     }
2845 /**
2846  * Keeps track of login attempts
2847  *
2848  * @global object
2849  */
2850 function update_login_count() {
2851     global $SESSION;
2853     $max_logins = 10;
2855     if (empty($SESSION->logincount)) {
2856         $SESSION->logincount = 1;
2857     } else {
2858         $SESSION->logincount++;
2859     }
2861     if ($SESSION->logincount > $max_logins) {
2862         unset($SESSION->wantsurl);
2863         print_error('errortoomanylogins');
2864     }
2867 /**
2868  * Resets login attempts
2869  *
2870  * @global object
2871  */
2872 function reset_login_count() {
2873     global $SESSION;
2875     $SESSION->logincount = 0;
2878 /**
2879  * Returns reference to full info about modules in course (including visibility).
2880  * Cached and as fast as possible (0 or 1 db query).
2881  *
2882  * @global object
2883  * @global object
2884  * @global object
2885  * @uses CONTEXT_MODULE
2886  * @uses MAX_MODINFO_CACHE_SIZE
2887  * @param mixed $course object or 'reset' string to reset caches, modinfo may be updated in db
2888  * @param int $userid Defaults to current user id
2889  * @return mixed courseinfo object or nothing if resetting
2890  */
2891 function &get_fast_modinfo(&$course, $userid=0) {
2892     global $CFG, $USER, $DB;
2893     require_once($CFG->dirroot.'/course/lib.php');
2895     if (!empty($CFG->enableavailability)) {
2896         require_once($CFG->libdir.'/conditionlib.php');
2897     }
2899     static $cache = array();
2901     if ($course === 'reset') {
2902         $cache = array();
2903         $nothing = null;
2904         return $nothing; // we must return some reference
2905     }
2907     if (empty($userid)) {
2908         $userid = $USER->id;
2909     }
2911     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
2912         return $cache[$course->id];
2913     }
2915     if (empty($course->modinfo)) {
2916         // no modinfo yet - load it
2917         rebuild_course_cache($course->id);
2918         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2919     }
2921     $modinfo = new object();
2922     $modinfo->courseid  = $course->id;
2923     $modinfo->userid    = $userid;
2924     $modinfo->sections  = array();
2925     $modinfo->cms       = array();
2926     $modinfo->instances = array();
2927     $modinfo->groups    = null; // loaded only when really needed - the only one db query
2929     $info = unserialize($course->modinfo);
2930     if (!is_array($info)) {
2931         // hmm, something is wrong - lets try to fix it
2932         rebuild_course_cache($course->id);
2933         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2934         $info = unserialize($course->modinfo);
2935         if (!is_array($info)) {
2936             return $modinfo;
2937         }
2938     }
2940     if ($info) {
2941         // detect if upgrade required
2942         $first = reset($info);
2943         if (!isset($first->id)) {
2944             rebuild_course_cache($course->id);
2945             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2946             $info = unserialize($course->modinfo);
2947             if (!is_array($info)) {
2948                 return $modinfo;
2949             }
2950         }
2951     }
2953     $modlurals = array();
2955     // If we haven't already preloaded contexts for the course, do it now
2956     preload_course_contexts($course->id);
2958     foreach ($info as $mod) {
2959         if (empty($mod->name)) {
2960             // something is wrong here
2961             continue;
2962         }
2963         // reconstruct minimalistic $cm
2964         $cm = new object();
2965         $cm->id               = $mod->cm;
2966         $cm->instance         = $mod->id;
2967         $cm->course           = $course->id;
2968         $cm->modname          = $mod->mod;
2969         $cm->idnumber         = $mod->idnumber;
2970         $cm->name             = $mod->name;
2971         $cm->visible          = $mod->visible;
2972         $cm->sectionnum       = $mod->section;
2973         $cm->groupmode        = $mod->groupmode;
2974         $cm->groupingid       = $mod->groupingid;
2975         $cm->groupmembersonly = $mod->groupmembersonly;
2976         $cm->indent           = $mod->indent;
2977         $cm->completion       = $mod->completion;
2978         $cm->extra            = isset($mod->extra) ? $mod->extra : '';
2979         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
2980         $cm->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
2981         $cm->uservisible      = true;
2982         if(!empty($CFG->enableavailability)) {
2983             // We must have completion information from modinfo. If it's not
2984             // there, cache needs rebuilding
2985             if(!isset($mod->availablefrom)) {
2986                 debugging('enableavailability option was changed; rebuilding '.
2987                     'cache for course '.$course->id);
2988                 rebuild_course_cache($course->id,true);
2989                 // Re-enter this routine to do it all properly
2990                 return get_fast_modinfo($course,$userid);
2991             }
2992             $cm->availablefrom    = $mod->availablefrom;
2993             $cm->availableuntil   = $mod->availableuntil;
2994             $cm->showavailability = $mod->showavailability;
2995             $cm->conditionscompletion = $mod->conditionscompletion;
2996             $cm->conditionsgrade  = $mod->conditionsgrade;
2997         }
2999         // preload long names plurals and also check module is installed properly
3000         if (!isset($modlurals[$cm->modname])) {
3001             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
3002                 continue;
3003             }
3004             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
3005         }
3006         $cm->modplural = $modlurals[$cm->modname];
3007         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
3009         if(!empty($CFG->enableavailability)) {
3010             // Unfortunately the next call really wants to call
3011             // get_fast_modinfo, but that would be recursive, so we fake up a
3012             // modinfo for it already
3013             if(empty($minimalmodinfo)) {
3014                 $minimalmodinfo=new stdClass();
3015                 $minimalmodinfo->cms=array();
3016                 foreach($info as $mod) {
3017                     if (empty($mod->name)) {
3018                         // something is wrong here
3019                         continue;
3020                     }
3021                     $minimalcm = new stdClass();
3022                     $minimalcm->id = $mod->cm;
3023                     $minimalcm->name = $mod->name;
3024                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
3025                 }
3026             }
3028             // Get availability information
3029             $ci = new condition_info($cm);
3030             $cm->available=$ci->is_available($cm->availableinfo, true, $userid, $minimalmodinfo);
3031         } else {
3032             $cm->available=true;
3033         }
3034         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
3035             $cm->uservisible = false;
3037         } else if (!empty($CFG->enablegroupmembersonly) and !empty($cm->groupmembersonly)
3038                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
3039             if (is_null($modinfo->groups)) {
3040                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
3041             }
3042             if (empty($modinfo->groups[$cm->groupingid])) {
3043                 $cm->uservisible = false;
3044             }
3045         }
3047         if (!isset($modinfo->instances[$cm->modname])) {
3048             $modinfo->instances[$cm->modname] = array();
3049         }
3050         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
3051         $modinfo->cms[$cm->id] =& $cm;
3053         // reconstruct sections
3054         if (!isset($modinfo->sections[$cm->sectionnum])) {
3055             $modinfo->sections[$cm->sectionnum] = array();
3056         }
3057         $modinfo->sections[$cm->sectionnum][] = $cm->id;
3059         unset($cm);
3060     }
3062     unset($cache[$course->id]); // prevent potential reference problems when switching users
3063     $cache[$course->id] = $modinfo;
3065     // Ensure cache does not use too much RAM
3066     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
3067         reset($cache);
3068         $key = key($cache);
3069         unset($cache[$key]);
3070     }
3072     return $cache[$course->id];
3075 /**
3076  * Determines if the currently logged in user is in editing mode.
3077  * Note: originally this function had $userid parameter - it was not usable anyway
3078  *
3079  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3080  * @todo Deprecated function remove when ready
3081  *
3082  * @global object
3083  * @uses DEBUG_DEVELOPER
3084  * @return bool
3085  */
3086 function isediting() {
3087     global $PAGE;
3088     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3089     return $PAGE->user_is_editing();
3092 /**
3093  * Determines if the logged in user is currently moving an activity
3094  *
3095  * @global object
3096  * @param int $courseid The id of the course being tested
3097  * @return bool
3098  */
3099 function ismoving($courseid) {
3100     global $USER;
3102     if (!empty($USER->activitycopy)) {
3103         return ($USER->activitycopycourse == $courseid);
3104     }
3105     return false;
3108 /**
3109  * Returns a persons full name
3110  *
3111  * Given an object containing firstname and lastname
3112  * values, this function returns a string with the
3113  * full name of the person.
3114  * The result may depend on system settings
3115  * or language.  'override' will force both names
3116  * to be used even if system settings specify one.
3117  *
3118  * @global object
3119  * @global object
3120  * @param object $user A {@link $USER} object to get full name of
3121  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3122  * @return string
3123  */
3124 function fullname($user, $override=false) {
3125     global $CFG, $SESSION;
3127     if (!isset($user->firstname) and !isset($user->lastname)) {
3128         return '';
3129     }
3131     if (!$override) {
3132         if (!empty($CFG->forcefirstname)) {
3133             $user->firstname = $CFG->forcefirstname;
3134         }
3135         if (!empty($CFG->forcelastname)) {
3136             $user->lastname = $CFG->forcelastname;
3137         }
3138     }
3140     if (!empty($SESSION->fullnamedisplay)) {
3141         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3142     }
3144     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3145         return $user->firstname .' '. $user->lastname;
3147     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3148         return $user->lastname .' '. $user->firstname;
3150     } else if ($CFG->fullnamedisplay == 'firstname') {
3151         if ($override) {
3152             return get_string('fullnamedisplay', '', $user);
3153         } else {
3154             return $user->firstname;
3155         }
3156     }
3158     return get_string('fullnamedisplay', '', $user);
3161 /**
3162  * Returns whether a given authentication plugin exists.
3163  *
3164  * @global object
3165  * @param string $auth Form of authentication to check for. Defaults to the
3166  *        global setting in {@link $CFG}.
3167  * @return boolean Whether the plugin is available.
3168  */
3169 function exists_auth_plugin($auth) {
3170     global $CFG;
3172     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3173         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3174     }
3175     return false;
3178 /**
3179  * Checks if a given plugin is in the list of enabled authentication plugins.
3180  *
3181  * @param string $auth Authentication plugin.
3182  * @return boolean Whether the plugin is enabled.
3183  */
3184 function is_enabled_auth($auth) {
3185     if (empty($auth)) {
3186         return false;
3187     }
3189     $enabled = get_enabled_auth_plugins();
3191     return in_array($auth, $enabled);
3194 /**
3195  * Returns an authentication plugin instance.
3196  *
3197  * @global object
3198  * @param string $auth name of authentication plugin
3199  * @return auth_plugin_base An instance of the required authentication plugin.
3200  */
3201 function get_auth_plugin($auth) {
3202     global $CFG;
3204     // check the plugin exists first
3205     if (! exists_auth_plugin($auth)) {
3206         print_error('authpluginnotfound', 'debug', '', $auth);
3207     }
3209     // return auth plugin instance
3210     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3211     $class = "auth_plugin_$auth";
3212     return new $class;
3215 /**
3216  * Returns array of active auth plugins.
3217  *
3218  * @param bool $fix fix $CFG->auth if needed
3219  * @return array
3220  */
3221 function get_enabled_auth_plugins($fix=false) {
3222     global $CFG;
3224     $default = array('manual', 'nologin');
3226     if (empty($CFG->auth)) {
3227         $auths = array();
3228     } else {
3229         $auths = explode(',', $CFG->auth);
3230     }
3232     if ($fix) {
3233         $auths = array_unique($auths);
3234         foreach($auths as $k=>$authname) {
3235             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3236                 unset($auths[$k]);
3237             }
3238         }
3239         $newconfig = implode(',', $auths);
3240         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3241             set_config('auth', $newconfig);
3242         }
3243     }
3245     return (array_merge($default, $auths));
3248 /**
3249  * Returns true if an internal authentication method is being used.
3250  * if method not specified then, global default is assumed
3251  *
3252  * @param string $auth Form of authentication required
3253  * @return bool
3254  */
3255 function is_internal_auth($auth) {
3256     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3257     return $authplugin->is_internal();
3260 /**
3261  * Returns true if the user is a 'restored' one
3262  *
3263  * Used in the login process to inform the user
3264  * and allow him/her to reset the password
3265  *
3266  * @uses $CFG
3267  * @uses $DB
3268  * @param string $username username to be checked
3269  * @return bool
3270  */
3271 function is_restored_user($username) {
3272     global $CFG, $DB;
3274     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3277 /**
3278  * Returns an array of user fields
3279  *
3280  * @return array User field/column names
3281  */
3282 function get_user_fieldnames() {
3283     global $DB;
3285     $fieldarray = $DB->get_columns('user');
3286     unset($fieldarray['id']);
3287     $fieldarray = array_keys($fieldarray);
3289     return $fieldarray;
3292 /**
3293  * Creates a bare-bones user record
3294  *
3295  * @todo Outline auth types and provide code example
3296  *
3297  * @global object
3298  * @global object
3299  * @param string $username New user's username to add to record
3300  * @param string $password New user's password to add to record
3301  * @param string $auth Form of authentication required
3302  * @return object A {@link $USER} object
3303  */
3304 function create_user_record($username, $password, $auth='manual') {
3305     global $CFG, $DB;
3307     //just in case check text case
3308     $username = trim(moodle_strtolower($username));
3310     $authplugin = get_auth_plugin($auth);
3312     $newuser = new object();
3314     if ($newinfo = $authplugin->get_userinfo($username)) {
3315         $newinfo = truncate_userinfo($newinfo);
3316         foreach ($newinfo as $key => $value){
3317             $newuser->$key = $value;
3318         }
3319     }
3321     if (!empty($newuser->email)) {
3322         if (email_is_not_allowed($newuser->email)) {
3323             unset($newuser->email);
3324         }
3325     }
3327     if (!isset($newuser->city)) {
3328         $newuser->city = '';
3329     }
3331     $newuser->auth = $auth;
3332     $newuser->username = $username;
3334     // fix for MDL-8480
3335     // user CFG lang for user if $newuser->lang is empty
3336     // or $user->lang is not an installed language
3337     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3338         $newuser->lang = $CFG->lang;
3339     }
3340     $newuser->confirmed = 1;
3341     $newuser->lastip = getremoteaddr();
3342     $newuser->timemodified = time();
3343     $newuser->mnethostid = $CFG->mnet_localhost_id;
3345     $DB->insert_record('user', $newuser);
3346     $user = get_complete_user_data('username', $newuser->username);
3347     if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3348         set_user_preference('auth_forcepasswordchange', 1, $user->id);
3349     }
3350     update_internal_user_password($user, $password);
3351     return $user;
3354 /**
3355  * Will update a local user record from an external source
3356  *
3357  * @global object
3358  * @param string $username New user's username to add to record
3359  * @param string $authplugin Unused
3360  * @return user A {@link $USER} object
3361  */
3362 function update_user_record($username, $authplugin) {
3363     global $DB;
3365     $username = trim(moodle_strtolower($username)); /// just in case check text case
3367     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
3368     $userauth = get_auth_plugin($oldinfo->auth);
3370     if ($newinfo = $userauth->get_userinfo($username)) {
3371         $newinfo = truncate_userinfo($newinfo);
3372         foreach ($newinfo as $key => $value){
3373             if ($key === 'username') {
3374                 // 'username' is not a mapped updateable/lockable field, so skip it.
3375                 continue;
3376             }
3377             $confval = $userauth->config->{'field_updatelocal_' . $key};
3378             $lockval = $userauth->config->{'field_lock_' . $key};
3379             if (empty($confval) || empty($lockval)) {
3380                 continue;
3381             }
3382             if ($confval === 'onlogin') {
3383                 // MDL-4207 Don't overwrite modified user profile values with
3384                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3385                 // of the setting 'unlocked if empty' is to allow the user to fill
3386                 // in a value for the selected field _if LDAP is giving
3387                 // nothing_ for this field. Thus it makes sense to let this value
3388                 // stand in until LDAP is giving a value for this field.
3389                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3390                     $DB->set_field('user', $key, $value, array('username'=>$username));
3391                 }
3392             }
3393         }
3394     }
3396     return get_complete_user_data('username', $username);
3399 /**
3400  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3401  * which may have large fields
3402  *
3403  * @todo Add vartype handling to ensure $info is an array
3404  *
3405  * @param array $info Array of user properties to truncate if needed
3406  * @return array The now truncated information that was passed in
3407  */
3408 function truncate_userinfo($info) {
3409     // define the limits
3410     $limit = array(
3411                     'username'    => 100,
3412                     'idnumber'    => 255,
3413                     'firstname'   => 100,
3414                     'lastname'    => 100,
3415                     'email'       => 100,
3416                     'icq'         =>  15,
3417                     'phone1'      =>  20,
3418                     'phone2'      =>  20,
3419                     'institution' =>  40,
3420                     'department'  =>  30,
3421                     'address'     =>  70,
3422                     'city'        => 120,
3423                     'country'     =>   2,
3424                     'url'         => 255,
3425                     );
3427     // apply where needed
3428     foreach (array_keys($info) as $key) {
3429         if (!empty($limit[$key])) {
3430             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
3431         }
3432     }
3434     return $info;
3437 /**
3438  * Marks user deleted in internal user database and notifies the auth plugin.
3439  * Also unenrols user from all roles and does other cleanup.
3440  *
3441  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3442  *
3443  * @param object $user User object before delete
3444  * @return boolean always true
3445  */
3446 function delete_user($user) {
3447     global $CFG, $DB;
3448     require_once($CFG->libdir.'/grouplib.php');
3449     require_once($CFG->libdir.'/gradelib.php');
3450     require_once($CFG->dirroot.'/message/lib.php');
3452     // delete all grades - backup is kept in grade_grades_history table
3453     grade_user_delete($user->id);
3455     //move unread messages from this user to read
3456     message_move_userfrom_unread2read($user->id);
3458     // remove from all cohorts
3459     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3461     // remove from all groups
3462     $DB->delete_records('groups_members', array('userid'=>$user->id));
3464     // brute force unenrol from all courses
3465     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3467     // purge user preferences
3468     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3470     // purge user extra profile info
3471     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3473     // last course access not necessary either
3474     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3476     // final accesslib cleanup - removes all role assignments in user context and context itself, files, etc.
3477     delete_context(CONTEXT_USER, $user->id);
3479     require_once($CFG->dirroot.'/tag/lib.php');
3480     tag_set('user', $user->id, array());
3482     // workaround for bulk deletes of users with the same email address
3483     $delname = "$user->email.".time();
3484     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3485         $delname++;
3486     }
3488     // mark internal user record as "deleted"
3489     $updateuser = new object();
3490     $updateuser->id           = $user->id;
3491     $updateuser->deleted      = 1;
3492     $updateuser->username     = $delname;            // Remember it just in case
3493     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3494     $updateuser->idnumber     = '';                  // Clear this field to free it up
3495     $updateuser->timemodified = time();
3497     $DB->update_record('user', $updateuser);
3499     // notify auth plugin - do not block the delete even when plugin fails
3500     $authplugin = get_auth_plugin($user->auth);
3501     $authplugin->user_delete($user);
3503     // any plugin that needs to cleanup should register this event
3504     events_trigger('user_deleted', $user);
3506     return true;
3509 /**
3510  * Retrieve the guest user object
3511  *
3512  * @global object
3513  * @global object
3514  * @return user A {@link $USER} object
3515  */
3516 function guest_user() {
3517     global $CFG, $DB;
3519     if ($newuser = $DB->get_record('user', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
3520         $newuser->confirmed = 1;
3521         $newuser->lang = $CFG->lang;
3522         $newuser->lastip = getremoteaddr();
3523     }
3525     return $newuser;
3528 /**
3529  * Authenticates a user against the chosen authentication mechanism
3530  *
3531  * Given a username and password, this function looks them
3532  * up using the currently selected authentication mechanism,
3533  * and if the authentication is successful, it returns a
3534  * valid $user object from the 'user' table.
3535  *
3536  * Uses auth_ functions from the currently active auth module
3537  *
3538  * After authenticate_user_login() returns success, you will need to
3539  * log that the user has logged in, and call complete_user_login() to set
3540  * the session up.
3541  *
3542  * @global object
3543  * @global object
3544  * @param string $username  User's username
3545  * @param string $password  User's password
3546  * @return user|flase A {@link $USER} object or false if error
3547  */
3548 function authenticate_user_login($username, $password) {
3549     global $CFG, $DB, $OUTPUT;
3551     $authsenabled = get_enabled_auth_plugins();
3553     if ($user = get_complete_user_data('username', $username)) {
3554         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3555         if (!empty($user->suspended)) {
3556             add_to_log(0, 'login', 'error', 'index.php', $username);
3557             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3558             return false;
3559         }
3560         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3561             add_to_log(0, 'login', 'error', 'index.php', $username);
3562             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3563             return false;
3564         }
3565         $auths = array($auth);
3567     } else {
3568         // check if there's a deleted record (cheaply)
3569         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
3570             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3571             return false;
3572         }
3574         $auths = $authsenabled;
3575         $user = new object();
3576         $user->id = 0;     // User does not exist
3577     }
3579     foreach ($auths as $auth) {
3580         $authplugin = get_auth_plugin($auth);
3582         // on auth fail fall through to the next plugin
3583         if (!$authplugin->user_login($username, $password)) {
3584             continue;
3585         }
3587         // successful authentication
3588         if ($user->id) {                          // User already exists in database
3589             if (empty($user->auth)) {             // For some reason auth isn't set yet
3590                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3591                 $user->auth = $auth;
3592             }
3593             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3594                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3595                 $user->firstaccess = $user->timemodified;
3596             }
3598             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3600             if (!$authplugin->is_internal()) {            // update user record from external DB
3601                 $user = update_user_record($username, get_auth_plugin($user->auth));
3602             }
3603         } else {
3604             // if user not found, create him
3605             $user = create_user_record($username, $password, $auth);
3606         }
3608         $authplugin->sync_roles($user);
3610         foreach ($authsenabled as $hau) {
3611             $hauth = get_auth_plugin($hau);
3612             $hauth->user_authenticated_hook($user, $username, $password);
3613         }
3615         if (empty($user->id)) {
3616             return false;
3617         }
3619         if (!empty($user->suspended)) {
3620             // just in case some auth plugin suspended account
3621             add_to_log(0, 'login', 'error', 'index.php', $username);
3622             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3623             return false;
3624         }
3626         return $user;
3627     }
3629     // failed if all the plugins have failed
3630     add_to_log(0, 'login', 'error', 'index.php', $username);
3631     if (debugging('', DEBUG_ALL)) {
3632         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3633     }
3634     return false;
3637 /**
3638  * Call to complete the user login process after authenticate_user_login()
3639  * has succeeded. It will setup the $USER variable and other required bits
3640  * and pieces.
3641  *
3642  * NOTE:
3643  * - It will NOT log anything -- up to the caller to decide what to log.
3644  *
3645  * @global object
3646  * @global object
3647  * @global object
3648  * @param object $user
3649  * @param bool $setcookie
3650  * @return object A {@link $USER} object - BC only, do not use
3651  */
3652 function complete_user_login($user, $setcookie=true) {
3653     global $CFG, $USER, $SESSION;
3655     // regenerate session id and delete old session,
3656     // this helps prevent session fixation attacks from the same domain
3657     session_regenerate_id(true);
3659     // check enrolments, load caps and setup $USER object
3660     session_set_user($user);
3662     update_user_login_times();
3663     set_login_session_preferences();
3665     if ($setcookie) {
3666         if (empty($CFG->nolastloggedin)) {
3667             set_moodle_cookie($USER->username);
3668         } else {
3669             // do not store last logged in user in cookie
3670             // auth plugins can temporarily override this from loginpage_hook()
3671             // do not save $CFG->nolastloggedin in database!
3672             set_moodle_cookie('nobody');
3673         }
3674     }
3676     /// Select password change url
3677     $userauth = get_auth_plugin($USER->auth);
3679     /// check whether the user should be changing password
3680     if (get_user_preferences('auth_forcepasswordchange', false)){
3681         if ($userauth->can_change_password()) {
3682             if ($changeurl = $userauth->change_password_url()) {
3683                 redirect($changeurl);
3684             } else {
3685                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3686             }
3687         } else {
3688             print_error('nopasswordchangeforced', 'auth');
3689         }
3690     }
3691     return $USER;
3694 /**
3695  * Compare password against hash stored in internal user table.
3696  * If necessary it also updates the stored hash to new format.
3697  *
3698  * @global object
3699  * @param object $user
3700  * @param string $password plain text password
3701  * @return bool is password valid?
3702  */
3703 function validate_internal_user_password(&$user, $password) {
3704     global $CFG;
3706     if (!isset($CFG->passwordsaltmain)) {
3707         $CFG->passwordsaltmain = '';
3708     }
3710     $validated = false;
3712     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)) {
3713         $validated = true;
3714     } else {
3715         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3716             $alt = 'passwordsaltalt'.$i;
3717             if (!empty($CFG->$alt)) {
3718                 if ($user->password == md5($password.$CFG->$alt)) {
3719                     $validated = true;
3720                     break;
3721                 }
3722             }
3723         }
3724     }
3726     if ($validated) {
3727         // force update of password hash using latest main password salt and encoding if needed
3728         update_internal_user_password($user, $password);
3729     }
3731     return $validated;
3734 /**
3735  * Calculate hashed value from password using current hash mechanism.
3736  *
3737  * @global object
3738  * @param string $password
3739  * @return string password hash
3740  */
3741 function hash_internal_user_password($password) {
3742     global $CFG;
3744     if (isset($CFG->passwordsaltmain)) {
3745         return md5($password.$CFG->passwordsaltmain);
3746     } else {
3747         return md5($password);
3748     }
3751 /**
3752  * Update password hash in user object.
3753  *
3754  * @global object
3755  * @global object
3756  * @param object $user
3757  * @param string $password plain text password
3758  * @return bool true if hash changed
3759  */
3760 function update_internal_user_password(&$user, $password) {
3761     global $CFG, $DB;
3763     $authplugin = get_auth_plugin($user->auth);
3764     if ($authplugin->prevent_local_passwords()) {
3765         $hashedpassword = 'not cached';
3766     } else {
3767         $hashedpassword = hash_internal_user_password($password);
3768     }
3770     $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
3771     return true;
3774 /**
3775  * Get a complete user record, which includes all the info
3776  * in the user record.
3777  *
3778  * Intended for setting as $USER session variable
3779  *
3780  * @global object
3781  * @global object
3782  * @uses SITEID
3783  * @param string $field The user field to be checked for a given value.
3784  * @param string $value The value to match for $field.
3785  * @param int $mnethostid
3786  * @return mixed False, or A {@link $USER} object.
3787  */
3788 function get_complete_user_data($field, $value, $mnethostid=null) {
3789     global $CFG, $DB;
3791     if (!$field || !$value) {
3792         return false;
3793     }
3795 /// Build the WHERE clause for an SQL query
3796     $params = array('fieldval'=>$value);
3797     $constraints = "$field = :fieldval AND deleted <> 1";
3799     // If we are loading user data based on anything other than id,
3800     // we must also restrict our search based on mnet host.
3801     if ($field != 'id') {
3802         if (empty($mnethostid)) {
3803             // if empty, we restrict to local users
3804             $mnethostid = $CFG->mnet_localhost_id;
3805         }
3806     }
3807     if (!empty($mnethostid)) {
3808         $params['mnethostid'] = $mnethostid;
3809         $constraints .= " AND mnethostid = :mnethostid";
3810     }
3812 /// Get all the basic user data
3814     if (! $user = $DB->get_record_select('user', $constraints, $params)) {
3815         return false;
3816     }
3818 /// Get various settings and preferences
3820     if ($displays = $DB->get_records('course_display', array('userid'=>$user->id))) {
3821         foreach ($displays as $display) {
3822             $user->display[$display->course] = $display->display;
3823         }
3824     }
3826     $user->preference = get_user_preferences(null, null, $user->id);
3827     $user->preference['_lastloaded'] = time();
3829     $user->lastcourseaccess    = array(); // during last session
3830     $user->currentcourseaccess = array(); // during current session
3831     if ($lastaccesses = $DB->get_records('user_lastaccess', array('userid'=>$user->id))) {
3832         foreach ($lastaccesses as $lastaccess) {
3833             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
3834         }
3835     }
3837     $sql = "SELECT g.id, g.courseid
3838               FROM {groups} g, {groups_members} gm
3839              WHERE gm.groupid=g.id AND gm.userid=?";
3841     // this is a special hack to speedup calendar display
3842     $user->groupmember = array();
3843     if ($groups = $DB->get_records_sql($sql, array($user->id))) {
3844         foreach ($groups as $group) {
3845             if (!array_key_exists($group->courseid, $user->groupmember)) {
3846                 $user->groupmember[$group->courseid] = array();
3847             }
3848             $user->groupmember[$group->courseid][$group->id] = $group->id;
3849         }
3850     }
3852 /// Add the custom profile fields to the user record
3853     require_once($CFG->dirroot.'/user/profile/lib.php');
3854     $customfields = (array)profile_user_record($user->id);
3855     foreach ($customfields as $cname=>$cvalue) {
3856         if (!isset($user->$cname)) { // Don't overwrite any standard fields
3857             $user->$cname = $cvalue;
3858         }
3859     }
3861 /// Rewrite some variables if necessary
3862     if (!empty($user->description)) {
3863         $user->description = true;   // No need to cart all of it around
3864     }
3865     if ($user->username == 'guest') {
3866         $user->lang       = $CFG->lang;               // Guest language always same as site
3867         $user->firstname  = get_string('guestuser');  // Name always in current language
3868         $user->lastname   = ' ';
3869     }
3871     return $user;
3874 /**
3875  * Validate a password against the configured password policy
3876  *
3877  * @global object
3878  * @param string $password the password to be checked against the password policy
3879  * @param string $errmsg the error message to display when the password doesn't comply with the policy.
3880  * @return bool true if the password is valid according to the policy. false otherwise.
3881  */
3882 function check_password_policy($password, &$errmsg) {
3883     global $CFG;
3885     if (empty($CFG->passwordpolicy)) {
3886         return true;
3887     }
3889     $textlib = textlib_get_instance();
3890     $errmsg = '';
3891     if ($textlib->strlen($password) < $CFG->minpasswordlength) {
3892         $errmsg .= '<div>'. get_string('errorminpasswordlength', 'auth', $CFG->minpasswordlength) .'</div>';
3894     }
3895     if (preg_match_all('/[[:digit:]]/u', $password, $matches) < $CFG->minpassworddigits) {
3896         $errmsg .= '<div>'. get_string('errorminpassworddigits', 'auth', $CFG->minpassworddigits) .'</div>';
3898     }
3899     if (preg_match_all('/[[:lower:]]/u', $password, $matches) < $CFG->minpasswordlower) {
3900         $errmsg .= '<div>'. get_string('errorminpasswordlower', 'auth', $CFG->minpasswordlower) .'</div>';
3902     }
3903     if (preg_match_all('/[[:upper:]]/u', $password, $matches) < $CFG->minpasswordupper) {
3904         $errmsg .= '<div>'. get_string('errorminpasswordupper', 'auth', $CFG->minpasswordupper) .'</div>';
3906     }
3907     if (preg_match_all('/[^[:upper:][:lower:][:digit:]]/u', $password, $matches) < $CFG->minpasswordnonalphanum) {
3908         $errmsg .= '<div>'. get_string('errorminpasswordnonalphanum', 'auth', $CFG->minpasswordnonalphanum) .'</div>';
3909     }
3910     if (!check_consecutive_identical_characters($password, $CFG->maxconsecutiveidentchars)) {
3911         $errmsg .= '<div>'. get_string('errormaxconsecutiveidentchars', 'auth', $CFG->maxconsecutiveidentchars) .'</div>';
3912     }
3914     if ($errmsg == '') {
3915         return true;
3916     } else {
3917         return false;
3918     }
3922 /**
3923  * When logging in, this function is run to set certain preferences
3924  * for the current SESSION
3925  *
3926  * @global object
3927  * @global object
3928  */
3929 function set_login_session_preferences() {
3930     global $SESSION, $CFG;
3932     $SESSION->justloggedin = true;
3934     unset($SESSION->lang);
3936     // Restore the calendar filters, if saved
3937     if (intval(get_user_preferences('calendar_persistflt', 0))) {
3938         include_once($CFG->dirroot.'/calendar/lib.php');
3939         calendar_set_filters_status(get_user_preferences('calendar_savedflt', 0xff));
3940     }
3944 /**
3945  * Delete a course, including all related data from the database,
3946  * and any associated files from the moodledata folder.
3947  *
3948  * @global object
3949  * @global object
3950  * @param mixed $courseorid The id of the course or course object to delete.
3951  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3952  * @return bool true if all the removals succeeded. false if there were any failures. If this
3953  *             method returns false, some of the removals will probably have succeeded, and others
3954  *             failed, but you have no way of knowing which.
3955  */
3956 function delete_course($courseorid, $showfeedback = true) {
3957     global $CFG, $DB, $OUTPUT;
3959     if (is_object($courseorid)) {
3960         $courseid = $courseorid->id;
3961         $course   = $courseorid;
3962     } else {
3963         $courseid = $courseorid;
3964         if (!$course = $DB->get_record('course', array('id'=>$courseid))) {
3965             return false;
3966         }
3967     }
3969     // frontpage course can not be deleted!!
3970     if ($courseid == SITEID) {
3971         return false;
3972     }
3974     remove_course_contents($courseid, $showfeedback);
3976     $DB->delete_records("course", array("id"=>$courseid));
3978     // Delete all roles and overiddes in the course context
3979     delete_context(CONTEXT_COURSE, $courseid);
3981     //trigger events
3982     events_trigger('course_deleted', $course);
3984     return true;
3987 /**
3988  * Clear a course out completely, deleting all content
3989  * but don't delete the course itself
3990  *
3991  * @global object
3992  * @global object
3993  * @param int $courseid The id of the course that is being deleted
3994  * @param bool $showfeedback Whether to display notifications of each action the function performs.
3995  * @return bool true if all the removals succeeded. false if there were any failures. If this
3996  *             method returns false, some of the removals will probably have succeeded, and others
3997  *             failed, but you have no way of knowing which.
3998  */
3999 function remove_course_contents($courseid, $showfeedback=true) {
4000     global $CFG, $DB, $OUTPUT;
4001     require_once($CFG->libdir.'/questionlib.php');
4002     require_once($CFG->libdir.'/gradelib.php');
4004     $course = $DB->get_record('course', array('id'=>$courseid), '*', MUST_EXIST);
4005     $context = get_context_instance(CONTEXT_COURSE, $courseid, MUST_EXIST);
4007     $strdeleted = get_string('deleted');
4009 /// Clean up course formats (iterate through all formats in the even the course format was ever changed)
4010     $formats = get_plugin_list('format');
4011     foreach ($formats as $format=>$formatdir) {
4012         $formatdelete = 'format_'.$format.'_delete_course';
4013         $formatlib    = "$formatdir/lib.php";
4014         if (file_exists($formatlib)) {
4015             include_once($formatlib);
4016             if (function_exists($formatdelete)) {
4017                 if ($showfeedback) {
4018                     echo $OUTPUT->notification($strdeleted.' '.$format);
4019                 }
4020                 $formatdelete($course->id);
4021             }
4022         }
4023     }
4025 /// Delete every instance of every module
4027     if ($allmods = $DB->get_records('modules') ) {
4028         foreach ($allmods as $mod) {
4029             $modname = $mod->name;
4030             $modfile = $CFG->dirroot .'/mod/'. $modname .'/lib.php';
4031             $moddelete = $modname .'_delete_instance';       // Delete everything connected to an instance
4032             $moddeletecourse = $modname .'_delete_course';   // Delete other stray stuff (uncommon)
4033             $count=0;
4034             if (file_exists($modfile)) {
4035                 include_once($modfile);
4036                 if (function_exists($moddelete)) {
4037                     if ($instances = $DB->get_records($modname, array('course'=>$course->id))) {
4038                         foreach ($instances as $instance) {
4039                             if ($cm = get_coursemodule_from_instance($modname, $instance->id, $course->id)) {
4040                                 /// Delete activity context questions and question categories
4041                                 question_delete_activity($cm,  $showfeedback);
4042                             }
4043                             if ($moddelete($instance->id)) {
4044                                 $count++;
4046                             } else {
4047                                 echo $OUTPUT->notification('Could not delete '. $modname .' instance '. $instance->id .' ('. format_string($instance->name) .')');
4048                             }
4049                             if ($cm) {
4050                                 // delete cm and its context in correct order
4051                                 $DB->delete_records('course_modules', array('id'=>$cm->id));
4052                                 delete_context(CONTEXT_MODULE, $cm->id);
4053                             }
4054                         }
4055                     }
4056                 } else {
4057                     echo $OUTPUT->notification('Function '.$moddelete.'() doesn\'t exist!');
4058                 }
4060                 if (function_exists($moddeletecourse)) {
4061                     $moddeletecourse($course, $showfeedback);
4062                 }
4063             }
4064             if ($showfeedback) {
4065                 echo $OUTPUT->notification($strdeleted .' '. $count .' x '. $modname);
4066             }
4067         }
4068     }
4070 /// Delete course blocks
4071     blocks_delete_all_for_context($context->id);
4073 /// Delete any groups, removing members and grouping/course links first.
4074     require_once($CFG->dirroot.'/group/lib.php');
4075     groups_delete_groupings($courseid, $showfeedback);
4076     groups_delete_groups($courseid, $showfeedback);
4078 /// Delete all related records in other tables that may have a courseid
4079 /// This array stores the tables that need to be cleared, as
4080 /// table_name => column_name that contains the course id.
4082     $tablestoclear = array(
4083         'event' => 'courseid', // Delete events
4084         'log' => 'course', // Delete logs
4085         'course_sections' => 'course', // Delete any course stuff
4086         'course_modules' => 'course',
4087         'backup_courses' => 'courseid', // Delete scheduled backup stuff
4088         'user_lastaccess' => 'courseid',
4089         'backup_log' => 'courseid'
4090     );
4091     foreach ($tablestoclear as $table => $col) {
4092         $DB->delete_records($table, array($col=>$course->id));
4093     }
4095 /// Delete questions and question categories
4096     question_delete_course($course, $showfeedback);
4098 /// Remove all data from gradebook
4099     remove_course_grades($courseid, $showfeedback);
4100     remove_grade_letters($context, $showfeedback);
4102 /// Delete course tags
4103     require_once($CFG->dirroot.'/tag/coursetagslib.php');
4104     coursetag_delete_course_tags($course->id, $showfeedback);
4106     // Delete legacy files
4107     fulldelete($CFG->dataroot.'/'.$courseid);
4109     //trigger events
4110     events_trigger('course_content_removed', $course);
4112     return true;
4115 /**
4116  * Change dates in module - used from course reset.
4117  *
4118  * @global object
4119  * @global object
4120  * @param string $modname forum, assignment, etc
4121  * @param array $fields array of date fields from mod table
4122  * @param int $timeshift time difference
4123  * @param int $courseid
4124  * @return bool success
4125  */
4126 function shift_course_mod_dates($modname, $fields, $timeshift, $courseid) {
4127     global $CFG, $DB;
4128     include_once($CFG->dirroot.'/mod/'.$modname.'/lib.php');
4130     $return = true;
4131     foreach ($fields as $field) {
4132         $updatesql = "UPDATE {".$modname."}
4133                           SET $field = $field + ?
4134                         WHERE course=? AND $field<>0 AND $field<>0";
4135         $return = $DB->execute($updatesql, array($timeshift, $courseid)) && $return;
4136     }
4138     $refreshfunction = $modname.'_refresh_events';
4139     if (function_exists($refreshfunction)) {
4140         $refreshfunction($courseid);
4141     }
4143     return $return;
4146 /**
4147  * This function will empty a course of user data.
4148  * It will retain the activities and the structure of the course.
4149  *
4150  * @param object $data an object containing all the settings including courseid (without magic quotes)
4151  * @return array status array of array component, item, error
4152  */
4153 function reset_course_userdata($data) {
4154     global $CFG, $USER, $DB;
4155     require_once($CFG->libdir.'/gradelib.php');
4156     require_once($CFG->dirroot.'/group/lib.php');
4158     $data->courseid = $data->id;
4159     $context = get_context_instance(CONTEXT_COURSE, $data->courseid);
4161     // calculate the time shift of dates
4162     if (!empty($data->reset_start_date)) {
4163         // time part of course startdate should be zero
4164         $data->timeshift = $data->reset_start_date - usergetmidnight($data->reset_start_date_old);
4165     } else {
4166         $data->timeshift = 0;
4167     }
4169     // result array: component, item, error
4170     $status = array();
4172     // start the resetting
4173     $componentstr = get_string('general');
4175     // move the course start time
4176     if (!empty($data->reset_start_date) and $data->timeshift) {
4177         // change course start data
4178         $DB->set_field('course', 'startdate', $data->reset_start_date, array('id'=>$data->courseid));
4179         // update all course and group events - do not move activity events
4180         $updatesql = "UPDATE {event}
4181                          SET timestart = timestart + ?
4182                        WHERE courseid=? AND instance=0";
4183         $DB->execute($updatesql, array($data->timeshift, $data->courseid));
4185         $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false);
4186     }
4188     if (!empty($data->reset_logs)) {
4189         $DB->delete_records('log', array('course'=>$data->courseid));
4190         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletelogs'), 'error'=>false);
4191     }
4193     if (!empty($data->reset_events)) {
4194         $DB->delete_records('event', array('courseid'=>$data->courseid));
4195         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteevents', 'calendar'), 'error'=>false);
4196     }
4198     if (!empty($data->reset_notes)) {
4199         require_once($CFG->dirroot.'/notes/lib.php');
4200         note_delete_all($data->courseid);
4201         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletenotes', 'notes'), 'error'=>false);
4202     }
4204     if (!empty($data->delete_blog_associations)) {
4205         require_once($CFG->dirroot.'/blog/lib.php');
4206         blog_remove_associations_for_course($data->courseid);
4207         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteblogassociations', 'blog'), 'error'=>false);
4208     }
4210     $componentstr = get_string('roles');
4212     if (!empty($data->reset_roles_overrides)) {
4213         $children = get_child_contexts($context);
4214         foreach ($children as $child) {
4215             $DB->delete_records('role_capabilities', array('contextid'=>$child->id));
4216         }
4217         $DB->delete_records('role_capabilities', array('contextid'=>$context->id));
4218         //force refresh for logged in users
4219         mark_context_dirty($context->path);
4220         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletecourseoverrides', 'role'), 'error'=>false);
4221     }
4223     if (!empty($data->reset_roles_local)) {
4224         $children = get_child_contexts($context);
4225         foreach ($children as $child) {
4226             role_unassign_all(array('contextid'=>$child->id));
4227         }
4228         //force refresh for logged in users
4229         mark_context_dirty($context->path);
4230         $status[] = array('component'=>$componentstr, 'item'=>get_string('deletelocalroles', 'role'), 'error'=>false);
4231     }
4233     // First unenrol users - this cleans some of related user data too, such as forum subscriptions, tracking, etc.
4234     $data->unenrolled = array();
4235     if (!empty($data->unenrol_users)) {
4236         $plugins = enrol_get_plugins(true);
4237         $instances = enrol_get_instances($data->courseid, true);
4238         foreach ($instances as $key=>$instance) {
4239             if (!isset($plugins[$instance->enrol])) {
4240                 unset($instances[$key]);
4241                 continue;
4242             }
4243             if (!$plugins[$instance->enrol]->allow_unenrol($instance)) {
4244                 unset($instances[$key]);
4245             }
4246         }
4248         $sqlempty = $DB->sql_empty();
4249         foreach($data->unenrol_users as $withroleid) {
4250             $sql = "SELECT DISTINCT ue.userid, ue.enrolid
4251                       FROM {user_enrolments} ue
4252                       JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
4253                       JOIN {context} c ON (c.contextlevel = :courselevel AND c.instanceid = e.courseid)
4254                       JOIN {role_assignments} ra ON (ra.contextid = c.id AND ra.roleid = :roleid AND ra.userid = ue.userid)";
4255             $params = array('courseid'=>$data->courseid, 'roleid'=>$withroleid, 'courselevel'=>CONTEXT_COURSE);
4257             $rs = $DB->get_recordset_sql($sql, $params);
4258             foreach ($rs as $ue) {
4259                 if (!isset($instances[$ue->enrolid])) {
4260                     continue;
4261                 }
4262                 $plugins[$instances[$ue->enrolid]->enrol]->unenrol_user($instances[$ue->enrolid], $ue->userid);
4263                 $data->unenrolled[$ue->userid] = $ue->userid;
4264             }
4265         }
4266     }
4267     if (!empty($data->unenrolled)) {
4268         $status[] = array('component'=>$componentstr, 'item'=>get_string('unenrol', 'enrol').' ('.count($data->unenrolled).')', 'error'=>false);
4269     }
4272     $componentstr = get_string('groups');
4274     // remove all group members
4275     if (!empty($data->reset_groups_members)) {
4276         groups_delete_group_members($data->courseid);
4277         $status[] = array('component'=>$componentstr, 'item'=>get_string('removegroupsmembers', 'group'), 'error'=>false);
4278     }
4280     // remove all groups
4281     if (!empty($data->reset_groups_remove)) {
4282         groups_delete_groups($data->courseid, false);
4283         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallgroups', 'group'), 'error'=>false);
4284     }
4286     // remove all grouping members
4287     if (!empty($data->reset_groupings_members)) {
4288         groups_delete_groupings_groups($data->courseid, false);
4289         $status[] = array('component'=>$componentstr, 'item'=>get_string('removegroupingsmembers', 'group'), 'error'=>false);
4290     }
4292     // remove all groupings
4293     if (!empty($data->reset_groupings_remove)) {
4294         groups_delete_groupings($data->courseid, false);
4295         $status[] = array('component'=>$componentstr, 'item'=>get_string('deleteallgroupings', 'group'), 'error'=>false);
4296     }
4298     // Look in every instance of every module for data to delete
4299     $unsupported_mods = array();
4300     if ($allmods = $DB->get_records('modules') ) {
4301         foreach ($allmods as $mod) {
4302             $modname = $mod->name;
4303             if (!$DB->count_records($modname, array('course'=>$data->courseid))) {
4304                 continue; // skip mods with no instances
4305             }
4306             $modfile = $CFG->dirroot.'/mod/'. $modname.'/lib.php';
4307             $moddeleteuserdata = $modname.'_reset_userdata';   // Function to delete user data
4308             if (file_exists($modfile)) {
4309                 include_once($modfile);
4310                 if (function_exists($moddeleteuserdata)) {
4311                     $modstatus = $moddeleteuserdata($data);
4312                     if (is_array($modstatus)) {
4313                         $status = array_merge($status, $modstatus);
4314                     } else {
4315                         debugging('Module '.$modname.' returned incorrect staus - must be an array!');
4316                     }
4317                 } else {
4318                     $unsupported_mods[] = $mod;
4319                 }
4320             } else {
4321                 debugging('Missing lib.php in '.$modname.' module!');
4322             }
4323         }
4324     }
4326     // mention unsupported mods
4327     if (!empty($unsupported_mods)) {
4328         foreach($unsupported_mods as $mod) {
4329             $status[] = array('component'=>get_string('modulenameplural', $mod->name), 'item'=>'', 'error'=>get_string('resetnotimplemented'));
4330         }
4331     }
4334     $componentstr = get_string('gradebook', 'grades');
4335     // reset gradebook
4336     if (!empty($data->reset_gradebook_items)) {
4337         remove_course_grades($data->courseid, false);
4338         grade_grab_course_grades($data->courseid);
4339         grade_regrade_final_grades($data->courseid);
4340         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeallcourseitems', 'grades'), 'error'=>false);
4342     } else if (!empty($data->reset_gradebook_grades)) {
4343         grade_course_reset($data->courseid);
4344         $status[] = array('component'=>$componentstr, 'item'=>get_string('removeallcoursegrades', 'grades'), 'error'=>false);
4345     }
4347     return $status;
4350 /**
4351  * Generate an email processing address
4352  *
4353  * @param int $modid
4354  * @param string $modargs
4355  * @return string Returns email processing address
4356  */
4357 function generate_email_processing_address($modid,$modargs) {
4358     global $CFG;
4360     $header = $CFG->mailprefix . substr(base64_encode(pack('C',$modid)),0,2).$modargs;
4361     return $header . substr(md5($header.get_site_identifier()),0,16).'@'.$CFG->maildomain;
4364 /**
4365  * ?
4366  *
4367  * @todo Finish documenting this function
4368  *
4369  * @global object
4370  * @param string $modargs
4371  * @param string $body Currently unused
4372  */
4373 function moodle_process_email($modargs,$body) {
4374     global $DB;
4376     // the first char should be an unencoded letter. We'll take this as an action
4377     switch ($modargs{0}) {
4378         case 'B': { // bounce
4379             list(,$userid) = unpack('V',base64_decode(substr($modargs,1,8)));
4380             if ($user = $DB->get_record("user", array('id'=>$userid), "id,email")) {
4381                 // check the half md5 of their email
4382                 $md5check = substr(md5($user->email),0,16);
4383                 if ($md5check == substr($modargs, -16)) {
4384                     set_bounce_count($user);
4385                 }
4386                 // else maybe they've already changed it?
4387        &nb