message MDL-25148 using method on $PAGE to allow or disallow popup notifications
[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    core
27  * @subpackage lib
28  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
36 /// Date and time constants ///
37 /**
38  * Time constant - the number of seconds in a year
39  */
40 define('YEARSECS', 31536000);
42 /**
43  * Time constant - the number of seconds in a week
44  */
45 define('WEEKSECS', 604800);
47 /**
48  * Time constant - the number of seconds in a day
49  */
50 define('DAYSECS', 86400);
52 /**
53  * Time constant - the number of seconds in an hour
54  */
55 define('HOURSECS', 3600);
57 /**
58  * Time constant - the number of seconds in a minute
59  */
60 define('MINSECS', 60);
62 /**
63  * Time constant - the number of minutes in a day
64  */
65 define('DAYMINS', 1440);
67 /**
68  * Time constant - the number of minutes in an hour
69  */
70 define('HOURMINS', 60);
72 /// Parameter constants - every call to optional_param(), required_param()  ///
73 /// or clean_param() should have a specified type of parameter.  //////////////
77 /**
78  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
79  */
80 define('PARAM_ALPHA',    'alpha');
82 /**
83  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
84  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
85  */
86 define('PARAM_ALPHAEXT', 'alphaext');
88 /**
89  * PARAM_ALPHANUM - expected numbers and letters only.
90  */
91 define('PARAM_ALPHANUM', 'alphanum');
93 /**
94  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
95  */
96 define('PARAM_ALPHANUMEXT', 'alphanumext');
98 /**
99  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
100  */
101 define('PARAM_AUTH',  'auth');
103 /**
104  * PARAM_BASE64 - Base 64 encoded format
105  */
106 define('PARAM_BASE64',   'base64');
108 /**
109  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
110  */
111 define('PARAM_BOOL',     'bool');
113 /**
114  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
115  * checked against the list of capabilities in the database.
116  */
117 define('PARAM_CAPABILITY',   'capability');
119 /**
120  * PARAM_CLEANHTML - cleans submitted HTML code. use only for text in HTML format. This cleaning may fix xhtml strictness too.
121  */
122 define('PARAM_CLEANHTML', 'cleanhtml');
124 /**
125  * PARAM_EMAIL - an email address following the RFC
126  */
127 define('PARAM_EMAIL',   'email');
129 /**
130  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
131  */
132 define('PARAM_FILE',   'file');
134 /**
135  * PARAM_FLOAT - a real/floating point number.
136  */
137 define('PARAM_FLOAT',  'float');
139 /**
140  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
141  */
142 define('PARAM_HOST',     'host');
144 /**
145  * PARAM_INT - integers only, use when expecting only numbers.
146  */
147 define('PARAM_INT',      'int');
149 /**
150  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
151  */
152 define('PARAM_LANG',  'lang');
154 /**
155  * 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!)
156  */
157 define('PARAM_LOCALURL', 'localurl');
159 /**
160  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
161  */
162 define('PARAM_NOTAGS',   'notags');
164 /**
165  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
166  * note: the leading slash is not removed, window drive letter is not allowed
167  */
168 define('PARAM_PATH',     'path');
170 /**
171  * PARAM_PEM - Privacy Enhanced Mail format
172  */
173 define('PARAM_PEM',      'pem');
175 /**
176  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
177  */
178 define('PARAM_PERMISSION',   'permission');
180 /**
181  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way
182  */
183 define('PARAM_RAW', 'raw');
185 /**
186  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
187  */
188 define('PARAM_SAFEDIR',  'safedir');
190 /**
191  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
192  */
193 define('PARAM_SAFEPATH',  'safepath');
195 /**
196  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
197  */
198 define('PARAM_SEQUENCE',  'sequence');
200 /**
201  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
202  */
203 define('PARAM_TAG',   'tag');
205 /**
206  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
207  */
208 define('PARAM_TAGLIST',   'taglist');
210 /**
211  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
212  */
213 define('PARAM_TEXT',  'text');
215 /**
216  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
217  */
218 define('PARAM_THEME',  'theme');
220 /**
221  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
222  */
223 define('PARAM_URL',      'url');
225 /**
226  * 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!!
227  */
228 define('PARAM_USERNAME',    'username');
230 /**
231  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
232  */
233 define('PARAM_STRINGID',    'stringid');
235 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
236 /**
237  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
238  * It was one of the first types, that is why it is abused so much ;-)
239  * @deprecated since 2.0
240  */
241 define('PARAM_CLEAN',    'clean');
243 /**
244  * PARAM_INTEGER - deprecated alias for PARAM_INT
245  */
246 define('PARAM_INTEGER',  'int');
248 /**
249  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
250  */
251 define('PARAM_NUMBER',  'float');
253 /**
254  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
255  * NOTE: originally alias for PARAM_APLHA
256  */
257 define('PARAM_ACTION',   'alphanumext');
259 /**
260  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
261  * NOTE: originally alias for PARAM_APLHA
262  */
263 define('PARAM_FORMAT',   'alphanumext');
265 /**
266  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
267  */
268 define('PARAM_MULTILANG',  'text');
270 /**
271  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
272  */
273 define('PARAM_CLEANFILE', 'file');
275 /// Web Services ///
277 /**
278  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
279  */
280 define('VALUE_REQUIRED', 1);
282 /**
283  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
284  */
285 define('VALUE_OPTIONAL', 2);
287 /**
288  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
289  */
290 define('VALUE_DEFAULT', 0);
292 /**
293  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
294  */
295 define('NULL_NOT_ALLOWED', false);
297 /**
298  * NULL_ALLOWED - the parameter can be set to null in the database
299  */
300 define('NULL_ALLOWED', true);
302 /// Page types ///
303 /**
304  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
305  */
306 define('PAGE_COURSE_VIEW', 'course-view');
308 /** Get remote addr constant */
309 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
310 /** Get remote addr constant */
311 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
313 /// Blog access level constant declaration ///
314 define ('BLOG_USER_LEVEL', 1);
315 define ('BLOG_GROUP_LEVEL', 2);
316 define ('BLOG_COURSE_LEVEL', 3);
317 define ('BLOG_SITE_LEVEL', 4);
318 define ('BLOG_GLOBAL_LEVEL', 5);
321 ///Tag constants///
322 /**
323  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
324  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
325  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
326  *
327  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
328  */
329 define('TAG_MAX_LENGTH', 50);
331 /// Password policy constants ///
332 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
333 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
334 define ('PASSWORD_DIGITS', '0123456789');
335 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
337 /// Feature constants ///
338 // Used for plugin_supports() to report features that are, or are not, supported by a module.
340 /** True if module can provide a grade */
341 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
342 /** True if module supports outcomes */
343 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
345 /** True if module has code to track whether somebody viewed it */
346 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
347 /** True if module has custom completion rules */
348 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
350 /** True if module supports outcomes */
351 define('FEATURE_IDNUMBER', 'idnumber');
352 /** True if module supports groups */
353 define('FEATURE_GROUPS', 'groups');
354 /** True if module supports groupings */
355 define('FEATURE_GROUPINGS', 'groupings');
356 /** True if module supports groupmembersonly */
357 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
359 /** Type of module */
360 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
361 /** True if module supports intro editor */
362 define('FEATURE_MOD_INTRO', 'mod_intro');
363 /** True if module has default completion */
364 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
366 define('FEATURE_COMMENT', 'comment');
368 define('FEATURE_RATE', 'rate');
369 /** True if module supports backup/restore of moodle2 format */
370 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
372 /** Unspecified module archetype */
373 define('MOD_ARCHETYPE_OTHER', 0);
374 /** Resource-like type module */
375 define('MOD_ARCHETYPE_RESOURCE', 1);
376 /** Assignment module archetype */
377 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
379 /**
380  * Security token used for allowing access
381  * from external application such as web services.
382  * Scripts do not use any session, performance is relatively
383  * low because we need to load access info in each request.
384  * Scripts are executed in parallel.
385  */
386 define('EXTERNAL_TOKEN_PERMANENT', 0);
388 /**
389  * Security token used for allowing access
390  * of embedded applications, the code is executed in the
391  * active user session. Token is invalidated after user logs out.
392  * Scripts are executed serially - normal session locking is used.
393  */
394 define('EXTERNAL_TOKEN_EMBEDDED', 1);
396 /**
397  * The home page should be the site home
398  */
399 define('HOMEPAGE_SITE', 0);
400 /**
401  * The home page should be the users my page
402  */
403 define('HOMEPAGE_MY', 1);
404 /**
405  * The home page can be chosen by the user
406  */
407 define('HOMEPAGE_USER', 2);
409 /**
410  * Hub directory url (should be moodle.org)
411  */
412 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
415 /**
416  * Moodle.org url (should be moodle.org)
417  */
418 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
421 /// PARAMETER HANDLING ////////////////////////////////////////////////////
423 /**
424  * Returns a particular value for the named variable, taken from
425  * POST or GET.  If the parameter doesn't exist then an error is
426  * thrown because we require this variable.
427  *
428  * This function should be used to initialise all required values
429  * in a script that are based on parameters.  Usually it will be
430  * used like this:
431  *    $id = required_param('id', PARAM_INT);
432  *
433  * Please note the $type parameter is now required,
434  * for now PARAM_CLEAN is used for backwards compatibility only.
435  *
436  * @param string $parname the name of the page parameter we want
437  * @param string $type expected type of parameter
438  * @return mixed
439  */
440 function required_param($parname, $type) {
441     if (!isset($type)) {
442         debugging('required_param() requires $type to be specified.');
443         $type = PARAM_CLEAN; // for now let's use this deprecated type
444     }
445     if (isset($_POST[$parname])) {       // POST has precedence
446         $param = $_POST[$parname];
447     } else if (isset($_GET[$parname])) {
448         $param = $_GET[$parname];
449     } else {
450         print_error('missingparam', '', '', $parname);
451     }
453     return clean_param($param, $type);
456 /**
457  * Returns a particular value for the named variable, taken from
458  * POST or GET, otherwise returning a given default.
459  *
460  * This function should be used to initialise all optional values
461  * in a script that are based on parameters.  Usually it will be
462  * used like this:
463  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
464  *
465  * Please note $default and $type parameters are now required,
466  * for now PARAM_CLEAN is used for backwards compatibility only.
467  *
468  * @param string $parname the name of the page parameter we want
469  * @param mixed  $default the default value to return if nothing is found
470  * @param string $type expected type of parameter
471  * @return mixed
472  */
473 function optional_param($parname, $default, $type) {
474     if (!isset($type)) {
475         debugging('optional_param() requires $default and $type to be specified.');
476         $type = PARAM_CLEAN; // for now let's use this deprecated type
477     }
478     if (!isset($default)) {
479         $default = null;
480     }
482     if (isset($_POST[$parname])) {       // POST has precedence
483         $param = $_POST[$parname];
484     } else if (isset($_GET[$parname])) {
485         $param = $_GET[$parname];
486     } else {
487         return $default;
488     }
490     return clean_param($param, $type);
493 /**
494  * Strict validation of parameter values, the values are only converted
495  * to requested PHP type. Internally it is using clean_param, the values
496  * before and after cleaning must be equal - otherwise
497  * an invalid_parameter_exception is thrown.
498  * Objects and classes are not accepted.
499  *
500  * @param mixed $param
501  * @param int $type PARAM_ constant
502  * @param bool $allownull are nulls valid value?
503  * @param string $debuginfo optional debug information
504  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
505  */
506 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
507     if (is_null($param)) {
508         if ($allownull == NULL_ALLOWED) {
509             return null;
510         } else {
511             throw new invalid_parameter_exception($debuginfo);
512         }
513     }
514     if (is_array($param) or is_object($param)) {
515         throw new invalid_parameter_exception($debuginfo);
516     }
518     $cleaned = clean_param($param, $type);
519     if ((string)$param !== (string)$cleaned) {
520         // conversion to string is usually lossless
521         throw new invalid_parameter_exception($debuginfo);
522     }
524     return $cleaned;
527 /**
528  * Used by {@link optional_param()} and {@link required_param()} to
529  * clean the variables and/or cast to specific types, based on
530  * an options field.
531  * <code>
532  * $course->format = clean_param($course->format, PARAM_ALPHA);
533  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
534  * </code>
535  *
536  * @param mixed $param the variable we are cleaning
537  * @param int $type expected format of param after cleaning.
538  * @return mixed
539  */
540 function clean_param($param, $type) {
542     global $CFG;
544     if (is_array($param)) {              // Let's loop
545         $newparam = array();
546         foreach ($param as $key => $value) {
547             $newparam[$key] = clean_param($value, $type);
548         }
549         return $newparam;
550     }
552     switch ($type) {
553         case PARAM_RAW:          // no cleaning at all
554             return $param;
556         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
557             // this is deprecated!, please use more specific type instead
558             if (is_numeric($param)) {
559                 return $param;
560             }
561             return clean_text($param);     // Sweep for scripts, etc
563         case PARAM_CLEANHTML:    // clean html fragment
564             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
565             return trim($param);
567         case PARAM_INT:
568             return (int)$param;  // Convert to integer
570         case PARAM_FLOAT:
571         case PARAM_NUMBER:
572             return (float)$param;  // Convert to float
574         case PARAM_ALPHA:        // Remove everything not a-z
575             return preg_replace('/[^a-zA-Z]/i', '', $param);
577         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
578             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
580         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
581             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
583         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
584             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
586         case PARAM_SEQUENCE:     // Remove everything not 0-9,
587             return preg_replace('/[^0-9,]/i', '', $param);
589         case PARAM_BOOL:         // Convert to 1 or 0
590             $tempstr = strtolower($param);
591             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
592                 $param = 1;
593             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
594                 $param = 0;
595             } else {
596                 $param = empty($param) ? 0 : 1;
597             }
598             return $param;
600         case PARAM_NOTAGS:       // Strip all tags
601             return strip_tags($param);
603         case PARAM_TEXT:    // leave only tags needed for multilang
604             // if the multilang syntax is not correct we strip all tags
605             // because it would break xhtml strict which is required for accessibility standards
606             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
607             do {
608                 if (strpos($param, '</lang>') !== false) {
609                     // old and future mutilang syntax
610                     $param = strip_tags($param, '<lang>');
611                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
612                         break;
613                     }
614                     $open = false;
615                     foreach ($matches[0] as $match) {
616                         if ($match === '</lang>') {
617                             if ($open) {
618                                 $open = false;
619                                 continue;
620                             } else {
621                                 break 2;
622                             }
623                         }
624                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
625                             break 2;
626                         } else {
627                             $open = true;
628                         }
629                     }
630                     if ($open) {
631                         break;
632                     }
633                     return $param;
635                 } else if (strpos($param, '</span>') !== false) {
636                     // current problematic multilang syntax
637                     $param = strip_tags($param, '<span>');
638                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
639                         break;
640                     }
641                     $open = false;
642                     foreach ($matches[0] as $match) {
643                         if ($match === '</span>') {
644                             if ($open) {
645                                 $open = false;
646                                 continue;
647                             } else {
648                                 break 2;
649                             }
650                         }
651                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
652                             break 2;
653                         } else {
654                             $open = true;
655                         }
656                     }
657                     if ($open) {
658                         break;
659                     }
660                     return $param;
661                 }
662             } while (false);
663             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
664             return strip_tags($param);
666         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
667             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
669         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
670             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
672         case PARAM_FILE:         // Strip all suspicious characters from filename
673             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
674             $param = preg_replace('~\.\.+~', '', $param);
675             if ($param === '.') {
676                 $param = '';
677             }
678             return $param;
680         case PARAM_PATH:         // Strip all suspicious characters from file path
681             $param = str_replace('\\', '/', $param);
682             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
683             $param = preg_replace('~\.\.+~', '', $param);
684             $param = preg_replace('~//+~', '/', $param);
685             return preg_replace('~/(\./)+~', '/', $param);
687         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
688             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
689             // match ipv4 dotted quad
690             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
691                 // confirm values are ok
692                 if ( $match[0] > 255
693                      || $match[1] > 255
694                      || $match[3] > 255
695                      || $match[4] > 255 ) {
696                     // hmmm, what kind of dotted quad is this?
697                     $param = '';
698                 }
699             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
700                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
701                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
702                        ) {
703                 // all is ok - $param is respected
704             } else {
705                 // all is not ok...
706                 $param='';
707             }
708             return $param;
710         case PARAM_URL:          // allow safe ftp, http, mailto urls
711             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
712             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
713                 // all is ok, param is respected
714             } else {
715                 $param =''; // not really ok
716             }
717             return $param;
719         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
720             $param = clean_param($param, PARAM_URL);
721             if (!empty($param)) {
722                 if (preg_match(':^/:', $param)) {
723                     // root-relative, ok!
724                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
725                     // absolute, and matches our wwwroot
726                 } else {
727                     // relative - let's make sure there are no tricks
728                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
729                         // looks ok.
730                     } else {
731                         $param = '';
732                     }
733                 }
734             }
735             return $param;
737         case PARAM_PEM:
738             $param = trim($param);
739             // PEM formatted strings may contain letters/numbers and the symbols
740             // forward slash: /
741             // plus sign:     +
742             // equal sign:    =
743             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
744             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
745                 list($wholething, $body) = $matches;
746                 unset($wholething, $matches);
747                 $b64 = clean_param($body, PARAM_BASE64);
748                 if (!empty($b64)) {
749                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
750                 } else {
751                     return '';
752                 }
753             }
754             return '';
756         case PARAM_BASE64:
757             if (!empty($param)) {
758                 // PEM formatted strings may contain letters/numbers and the symbols
759                 // forward slash: /
760                 // plus sign:     +
761                 // equal sign:    =
762                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
763                     return '';
764                 }
765                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
766                 // Each line of base64 encoded data must be 64 characters in
767                 // length, except for the last line which may be less than (or
768                 // equal to) 64 characters long.
769                 for ($i=0, $j=count($lines); $i < $j; $i++) {
770                     if ($i + 1 == $j) {
771                         if (64 < strlen($lines[$i])) {
772                             return '';
773                         }
774                         continue;
775                     }
777                     if (64 != strlen($lines[$i])) {
778                         return '';
779                     }
780                 }
781                 return implode("\n",$lines);
782             } else {
783                 return '';
784             }
786         case PARAM_TAG:
787             //as long as magic_quotes_gpc is used, a backslash will be a
788             //problem, so remove *all* backslash.
789             //$param = str_replace('\\', '', $param);
790             //remove some nasties
791             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
792             //convert many whitespace chars into one
793             $param = preg_replace('/\s+/', ' ', $param);
794             $textlib = textlib_get_instance();
795             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
796             return $param;
799         case PARAM_TAGLIST:
800             $tags = explode(',', $param);
801             $result = array();
802             foreach ($tags as $tag) {
803                 $res = clean_param($tag, PARAM_TAG);
804                 if ($res !== '') {
805                     $result[] = $res;
806                 }
807             }
808             if ($result) {
809                 return implode(',', $result);
810             } else {
811                 return '';
812             }
814         case PARAM_CAPABILITY:
815             if (get_capability_info($param)) {
816                 return $param;
817             } else {
818                 return '';
819             }
821         case PARAM_PERMISSION:
822             $param = (int)$param;
823             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
824                 return $param;
825             } else {
826                 return CAP_INHERIT;
827             }
829         case PARAM_AUTH:
830             $param = clean_param($param, PARAM_SAFEDIR);
831             if (exists_auth_plugin($param)) {
832                 return $param;
833             } else {
834                 return '';
835             }
837         case PARAM_LANG:
838             $param = clean_param($param, PARAM_SAFEDIR);
839             if (get_string_manager()->translation_exists($param)) {
840                 return $param;
841             } else {
842                 return ''; // Specified language is not installed or param malformed
843             }
845         case PARAM_THEME:
846             $param = clean_param($param, PARAM_SAFEDIR);
847             if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
848                 return $param;
849             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
850                 return $param;
851             } else {
852                 return '';  // Specified theme is not installed
853             }
855         case PARAM_USERNAME:
856             $param = str_replace(" " , "", $param);
857             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
858             if (empty($CFG->extendedusernamechars)) {
859                 // regular expression, eliminate all chars EXCEPT:
860                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
861                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
862             }
863             return $param;
865         case PARAM_EMAIL:
866             if (validate_email($param)) {
867                 return $param;
868             } else {
869                 return '';
870             }
872         case PARAM_STRINGID:
873             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
874                 return $param;
875             } else {
876                 return '';
877             }
879         default:                 // throw error, switched parameters in optional_param or another serious problem
880             print_error("unknownparamtype", '', '', $type);
881     }
884 /**
885  * Return true if given value is integer or string with integer value
886  *
887  * @param mixed $value String or Int
888  * @return bool true if number, false if not
889  */
890 function is_number($value) {
891     if (is_int($value)) {
892         return true;
893     } else if (is_string($value)) {
894         return ((string)(int)$value) === $value;
895     } else {
896         return false;
897     }
900 /**
901  * Returns host part from url
902  * @param string $url full url
903  * @return string host, null if not found
904  */
905 function get_host_from_url($url) {
906     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
907     if ($matches) {
908         return $matches[1];
909     }
910     return null;
913 /**
914  * Tests whether anything was returned by text editor
915  *
916  * This function is useful for testing whether something you got back from
917  * the HTML editor actually contains anything. Sometimes the HTML editor
918  * appear to be empty, but actually you get back a <br> tag or something.
919  *
920  * @param string $string a string containing HTML.
921  * @return boolean does the string contain any actual content - that is text,
922  * images, objects, etc.
923  */
924 function html_is_blank($string) {
925     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
928 /**
929  * Set a key in global configuration
930  *
931  * Set a key/value pair in both this session's {@link $CFG} global variable
932  * and in the 'config' database table for future sessions.
933  *
934  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
935  * In that case it doesn't affect $CFG.
936  *
937  * A NULL value will delete the entry.
938  *
939  * @global object
940  * @global object
941  * @param string $name the key to set
942  * @param string $value the value to set (without magic quotes)
943  * @param string $plugin (optional) the plugin scope, default NULL
944  * @return bool true or exception
945  */
946 function set_config($name, $value, $plugin=NULL) {
947     global $CFG, $DB;
949     if (empty($plugin)) {
950         if (!array_key_exists($name, $CFG->config_php_settings)) {
951             // So it's defined for this invocation at least
952             if (is_null($value)) {
953                 unset($CFG->$name);
954             } else {
955                 $CFG->$name = (string)$value; // settings from db are always strings
956             }
957         }
959         if ($DB->get_field('config', 'name', array('name'=>$name))) {
960             if ($value === null) {
961                 $DB->delete_records('config', array('name'=>$name));
962             } else {
963                 $DB->set_field('config', 'value', $value, array('name'=>$name));
964             }
965         } else {
966             if ($value !== null) {
967                 $config = new stdClass();
968                 $config->name  = $name;
969                 $config->value = $value;
970                 $DB->insert_record('config', $config, false);
971             }
972         }
974     } else { // plugin scope
975         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
976             if ($value===null) {
977                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
978             } else {
979                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
980             }
981         } else {
982             if ($value !== null) {
983                 $config = new stdClass();
984                 $config->plugin = $plugin;
985                 $config->name   = $name;
986                 $config->value  = $value;
987                 $DB->insert_record('config_plugins', $config, false);
988             }
989         }
990     }
992     return true;
995 /**
996  * Get configuration values from the global config table
997  * or the config_plugins table.
998  *
999  * If called with one parameter, it will load all the config
1000  * variables for one plugin, and return them as an object.
1001  *
1002  * If called with 2 parameters it will return a string single
1003  * value or false if the value is not found.
1004  *
1005  * @param string $plugin full component name
1006  * @param string $name default NULL
1007  * @return mixed hash-like object or single value, return false no config found
1008  */
1009 function get_config($plugin, $name = NULL) {
1010     global $CFG, $DB;
1012     // normalise component name
1013     if ($plugin === 'moodle' or $plugin === 'core') {
1014         $plugin = NULL;
1015     }
1017     if (!empty($name)) { // the user is asking for a specific value
1018         if (!empty($plugin)) {
1019             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1020                 // setting forced in config file
1021                 return $CFG->forced_plugin_settings[$plugin][$name];
1022             } else {
1023                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1024             }
1025         } else {
1026             if (array_key_exists($name, $CFG->config_php_settings)) {
1027                 // setting force in config file
1028                 return $CFG->config_php_settings[$name];
1029             } else {
1030                 return $DB->get_field('config', 'value', array('name'=>$name));
1031             }
1032         }
1033     }
1035     // the user is after a recordset
1036     if ($plugin) {
1037         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1038         if (isset($CFG->forced_plugin_settings[$plugin])) {
1039             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1040                 if (is_null($v) or is_array($v) or is_object($v)) {
1041                     // we do not want any extra mess here, just real settings that could be saved in db
1042                     unset($localcfg[$n]);
1043                 } else {
1044                     //convert to string as if it went through the DB
1045                     $localcfg[$n] = (string)$v;
1046                 }
1047             }
1048         }
1049         if ($localcfg) {
1050             return (object)$localcfg;
1051         } else {
1052             return null;
1053         }
1055     } else {
1056         // this part is not really used any more, but anyway...
1057         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1058         foreach($CFG->config_php_settings as $n=>$v) {
1059             if (is_null($v) or is_array($v) or is_object($v)) {
1060                 // we do not want any extra mess here, just real settings that could be saved in db
1061                 unset($localcfg[$n]);
1062             } else {
1063                 //convert to string as if it went through the DB
1064                 $localcfg[$n] = (string)$v;
1065             }
1066         }
1067         return (object)$localcfg;
1068     }
1071 /**
1072  * Removes a key from global configuration
1073  *
1074  * @param string $name the key to set
1075  * @param string $plugin (optional) the plugin scope
1076  * @global object
1077  * @return boolean whether the operation succeeded.
1078  */
1079 function unset_config($name, $plugin=NULL) {
1080     global $CFG, $DB;
1082     if (empty($plugin)) {
1083         unset($CFG->$name);
1084         $DB->delete_records('config', array('name'=>$name));
1085     } else {
1086         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1087     }
1089     return true;
1092 /**
1093  * Remove all the config variables for a given plugin.
1094  *
1095  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1096  * @return boolean whether the operation succeeded.
1097  */
1098 function unset_all_config_for_plugin($plugin) {
1099     global $DB;
1100     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1101     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
1102     return true;
1105 /**
1106  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1107  *
1108  * All users are verified if they still have the necessary capability.
1109  *
1110  * @param string $value the value of the config setting.
1111  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1112  * @param bool $include admins, include administrators
1113  * @return array of user objects.
1114  */
1115 function get_users_from_config($value, $capability, $includeadmins = true) {
1116     global $CFG, $DB;
1118     if (empty($value) or $value === '$@NONE@$') {
1119         return array();
1120     }
1122     // we have to make sure that users still have the necessary capability,
1123     // it should be faster to fetch them all first and then test if they are present
1124     // instead of validating them one-by-one
1125     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1126     if ($includeadmins) {
1127         $admins = get_admins();
1128         foreach ($admins as $admin) {
1129             $users[$admin->id] = $admin;
1130         }
1131     }
1133     if ($value === '$@ALL@$') {
1134         return $users;
1135     }
1137     $result = array(); // result in correct order
1138     $allowed = explode(',', $value);
1139     foreach ($allowed as $uid) {
1140         if (isset($users[$uid])) {
1141             $user = $users[$uid];
1142             $result[$user->id] = $user;
1143         }
1144     }
1146     return $result;
1150 /**
1151  * Invalidates browser caches and cached data in temp
1152  * @return void
1153  */
1154 function purge_all_caches() {
1155     global $CFG;
1157     reset_text_filters_cache();
1158     js_reset_all_caches();
1159     theme_reset_all_caches();
1160     get_string_manager()->reset_caches();
1162     // purge all other caches: rss, simplepie, etc.
1163     remove_dir($CFG->dataroot.'/cache', true);
1165     // make sure cache dir is writable, throws exception if not
1166     make_upload_directory('cache');
1168     clearstatcache();
1171 /**
1172  * Get volatile flags
1173  *
1174  * @param string $type
1175  * @param int    $changedsince default null
1176  * @return records array
1177  */
1178 function get_cache_flags($type, $changedsince=NULL) {
1179     global $DB;
1181     $params = array('type'=>$type, 'expiry'=>time());
1182     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1183     if ($changedsince !== NULL) {
1184         $params['changedsince'] = $changedsince;
1185         $sqlwhere .= " AND timemodified > :changedsince";
1186     }
1187     $cf = array();
1189     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1190         foreach ($flags as $flag) {
1191             $cf[$flag->name] = $flag->value;
1192         }
1193     }
1194     return $cf;
1197 /**
1198  * Get volatile flags
1199  *
1200  * @param string $type
1201  * @param string $name
1202  * @param int    $changedsince default null
1203  * @return records array
1204  */
1205 function get_cache_flag($type, $name, $changedsince=NULL) {
1206     global $DB;
1208     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1210     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1211     if ($changedsince !== NULL) {
1212         $params['changedsince'] = $changedsince;
1213         $sqlwhere .= " AND timemodified > :changedsince";
1214     }
1216     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1219 /**
1220  * Set a volatile flag
1221  *
1222  * @param string $type the "type" namespace for the key
1223  * @param string $name the key to set
1224  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1225  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1226  * @return bool Always returns true
1227  */
1228 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1229     global $DB;
1231     $timemodified = time();
1232     if ($expiry===NULL || $expiry < $timemodified) {
1233         $expiry = $timemodified + 24 * 60 * 60;
1234     } else {
1235         $expiry = (int)$expiry;
1236     }
1238     if ($value === NULL) {
1239         unset_cache_flag($type,$name);
1240         return true;
1241     }
1243     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1244         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1245             return true; //no need to update; helps rcache too
1246         }
1247         $f->value        = $value;
1248         $f->expiry       = $expiry;
1249         $f->timemodified = $timemodified;
1250         $DB->update_record('cache_flags', $f);
1251     } else {
1252         $f = new stdClass();
1253         $f->flagtype     = $type;
1254         $f->name         = $name;
1255         $f->value        = $value;
1256         $f->expiry       = $expiry;
1257         $f->timemodified = $timemodified;
1258         $DB->insert_record('cache_flags', $f);
1259     }
1260     return true;
1263 /**
1264  * Removes a single volatile flag
1265  *
1266  * @global object
1267  * @param string $type the "type" namespace for the key
1268  * @param string $name the key to set
1269  * @return bool
1270  */
1271 function unset_cache_flag($type, $name) {
1272     global $DB;
1273     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1274     return true;
1277 /**
1278  * Garbage-collect volatile flags
1279  *
1280  * @return bool Always returns true
1281  */
1282 function gc_cache_flags() {
1283     global $DB;
1284     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1285     return true;
1288 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1290 /**
1291  * Refresh user preference cache. This is used most often for $USER
1292  * object that is stored in session, but it also helps with performance in cron script.
1293  *
1294  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1295  *
1296  * @param stdClass $user user object, preferences are preloaded into ->preference property
1297  * @param int $cachelifetime cache life time on the current page (ins seconds)
1298  * @return void
1299  */
1300 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1301     global $DB;
1302     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1304     if (!isset($user->id)) {
1305         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1306     }
1308     if (empty($user->id) or isguestuser($user->id)) {
1309         // No permanent storage for not-logged-in users and guest
1310         if (!isset($user->preference)) {
1311             $user->preference = array();
1312         }
1313         return;
1314     }
1316     $timenow = time();
1318     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1319         // Already loaded at least once on this page. Are we up to date?
1320         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1321             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1322             return;
1324         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1325             // no change since the lastcheck on this page
1326             $user->preference['_lastloaded'] = $timenow;
1327             return;
1328         }
1329     }
1331     // OK, so we have to reload all preferences
1332     $loadedusers[$user->id] = true;
1333     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1334     $user->preference['_lastloaded'] = $timenow;
1337 /**
1338  * Called from set/delete_user_preferences, so that the prefs can
1339  * be correctly reloaded in different sessions.
1340  *
1341  * NOTE: internal function, do not call from other code.
1342  *
1343  * @param integer $userid the user whose prefs were changed.
1344  * @return void
1345  */
1346 function mark_user_preferences_changed($userid) {
1347     global $CFG;
1349     if (empty($userid) or isguestuser($userid)) {
1350         // no cache flags for guest and not-logged-in users
1351         return;
1352     }
1354     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1357 /**
1358  * Sets a preference for the specified user.
1359  *
1360  * If user object submitted, 'preference' property contains the preferences cache.
1361  *
1362  * @param string $name The key to set as preference for the specified user
1363  * @param string $value The value to set for the $name key in the specified user's record,
1364  *                      null means delete current value
1365  * @param stdClass|int $user A moodle user object or id, null means current user
1366  * @return bool always true or exception
1367  */
1368 function set_user_preference($name, $value, $user = null) {
1369     global $USER, $DB;
1371     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1372         throw new coding_exception('Invalid preference name in set_user_preference() call');
1373     }
1375     if (is_null($value)) {
1376         // null means delete current
1377         return unset_user_preference($name, $user);
1378     } else if (is_object($value)) {
1379         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1380     } else if (is_array($value)) {
1381         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1382     }
1383     $value = (string)$value;
1385     if (is_null($user)) {
1386         $user = $USER;
1387     } else if (isset($user->id)) {
1388         // $user is valid object
1389     } else if (is_numeric($user)) {
1390         $user = (object)array('id'=>(int)$user);
1391     } else {
1392         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1393     }
1395     check_user_preferences_loaded($user);
1397     if (empty($user->id) or isguestuser($user->id)) {
1398         // no permanent storage for not-logged-in users and guest
1399         $user->preference[$name] = $value;
1400         return true;
1401     }
1403     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1404         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1405             // preference already set to this value
1406             return true;
1407         }
1408         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1410     } else {
1411         $preference = new stdClass();
1412         $preference->userid = $user->id;
1413         $preference->name   = $name;
1414         $preference->value  = $value;
1415         $DB->insert_record('user_preferences', $preference);
1416     }
1418     // update value in cache
1419     $user->preference[$name] = $value;
1421     // set reload flag for other sessions
1422     mark_user_preferences_changed($user->id);
1424     return true;
1427 /**
1428  * Sets a whole array of preferences for the current user
1429  *
1430  * If user object submitted, 'preference' property contains the preferences cache.
1431  *
1432  * @param array $prefarray An array of key/value pairs to be set
1433  * @param stdClass|int $user A moodle user object or id, null means current user
1434  * @return bool always true or exception
1435  */
1436 function set_user_preferences(array $prefarray, $user = null) {
1437     foreach ($prefarray as $name => $value) {
1438         set_user_preference($name, $value, $user);
1439     }
1440     return true;
1443 /**
1444  * Unsets a preference completely by deleting it from the database
1445  *
1446  * If user object submitted, 'preference' property contains the preferences cache.
1447  *
1448  * @param string  $name The key to unset as preference for the specified user
1449  * @param stdClass|int $user A moodle user object or id, null means current user
1450  * @return bool always true or exception
1451  */
1452 function unset_user_preference($name, $user = null) {
1453     global $USER, $DB;
1455     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1456         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1457     }
1459     if (is_null($user)) {
1460         $user = $USER;
1461     } else if (isset($user->id)) {
1462         // $user is valid object
1463     } else if (is_numeric($user)) {
1464         $user = (object)array('id'=>(int)$user);
1465     } else {
1466         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1467     }
1469     check_user_preferences_loaded($user);
1471     if (empty($user->id) or isguestuser($user->id)) {
1472         // no permanent storage for not-logged-in user and guest
1473         unset($user->preference[$name]);
1474         return true;
1475     }
1477     // delete from DB
1478     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1480     // delete the preference from cache
1481     unset($user->preference[$name]);
1483     // set reload flag for other sessions
1484     mark_user_preferences_changed($user->id);
1486     return true;
1489 /**
1490  * Used to fetch user preference(s)
1491  *
1492  * If no arguments are supplied this function will return
1493  * all of the current user preferences as an array.
1494  *
1495  * If a name is specified then this function
1496  * attempts to return that particular preference value.  If
1497  * none is found, then the optional value $default is returned,
1498  * otherwise NULL.
1499  *
1500  * If user object submitted, 'preference' property contains the preferences cache.
1501  *
1502  * @param string $name Name of the key to use in finding a preference value
1503  * @param mixed $default Value to be returned if the $name key is not set in the user preferences
1504  * @param stdClass|int $user A moodle user object or id, null means current user
1505  * @return mixed string value or default
1506  */
1507 function get_user_preferences($name = null, $default = null, $user = null) {
1508     global $USER;
1510     if (is_null($name)) {
1511         // all prefs
1512     } else if (is_numeric($name) or $name === '_lastloaded') {
1513         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1514     }
1516     if (is_null($user)) {
1517         $user = $USER;
1518     } else if (isset($user->id)) {
1519         // $user is valid object
1520     } else if (is_numeric($user)) {
1521         $user = (object)array('id'=>(int)$user);
1522     } else {
1523         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1524     }
1526     check_user_preferences_loaded($user);
1528     if (empty($name)) {
1529         return $user->preference; // All values
1530     } else if (isset($user->preference[$name])) {
1531         return $user->preference[$name]; // The single string value
1532     } else {
1533         return $default; // Default value (null if not specified)
1534     }
1537 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1539 /**
1540  * Given date parts in user time produce a GMT timestamp.
1541  *
1542  * @todo Finish documenting this function
1543  * @param int $year The year part to create timestamp of
1544  * @param int $month The month part to create timestamp of
1545  * @param int $day The day part to create timestamp of
1546  * @param int $hour The hour part to create timestamp of
1547  * @param int $minute The minute part to create timestamp of
1548  * @param int $second The second part to create timestamp of
1549  * @param float $timezone Timezone modifier
1550  * @param bool $applydst Toggle Daylight Saving Time, default true
1551  * @return int timestamp
1552  */
1553 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1555     $strtimezone = NULL;
1556     if (!is_numeric($timezone)) {
1557         $strtimezone = $timezone;
1558     }
1560     $timezone = get_user_timezone_offset($timezone);
1562     if (abs($timezone) > 13) {
1563         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1564     } else {
1565         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1566         $time = usertime($time, $timezone);
1567         if($applydst) {
1568             $time -= dst_offset_on($time, $strtimezone);
1569         }
1570     }
1572     return $time;
1576 /**
1577  * Format a date/time (seconds) as weeks, days, hours etc as needed
1578  *
1579  * Given an amount of time in seconds, returns string
1580  * formatted nicely as weeks, days, hours etc as needed
1581  *
1582  * @uses MINSECS
1583  * @uses HOURSECS
1584  * @uses DAYSECS
1585  * @uses YEARSECS
1586  * @param int $totalsecs Time in seconds
1587  * @param object $str Should be a time object
1588  * @return string A nicely formatted date/time string
1589  */
1590  function format_time($totalsecs, $str=NULL) {
1592     $totalsecs = abs($totalsecs);
1594     if (!$str) {  // Create the str structure the slow way
1595         $str->day   = get_string('day');
1596         $str->days  = get_string('days');
1597         $str->hour  = get_string('hour');
1598         $str->hours = get_string('hours');
1599         $str->min   = get_string('min');
1600         $str->mins  = get_string('mins');
1601         $str->sec   = get_string('sec');
1602         $str->secs  = get_string('secs');
1603         $str->year  = get_string('year');
1604         $str->years = get_string('years');
1605     }
1608     $years     = floor($totalsecs/YEARSECS);
1609     $remainder = $totalsecs - ($years*YEARSECS);
1610     $days      = floor($remainder/DAYSECS);
1611     $remainder = $totalsecs - ($days*DAYSECS);
1612     $hours     = floor($remainder/HOURSECS);
1613     $remainder = $remainder - ($hours*HOURSECS);
1614     $mins      = floor($remainder/MINSECS);
1615     $secs      = $remainder - ($mins*MINSECS);
1617     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1618     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1619     $sh = ($hours == 1) ? $str->hour : $str->hours;
1620     $sd = ($days == 1)  ? $str->day  : $str->days;
1621     $sy = ($years == 1)  ? $str->year  : $str->years;
1623     $oyears = '';
1624     $odays = '';
1625     $ohours = '';
1626     $omins = '';
1627     $osecs = '';
1629     if ($years)  $oyears  = $years .' '. $sy;
1630     if ($days)  $odays  = $days .' '. $sd;
1631     if ($hours) $ohours = $hours .' '. $sh;
1632     if ($mins)  $omins  = $mins .' '. $sm;
1633     if ($secs)  $osecs  = $secs .' '. $ss;
1635     if ($years) return trim($oyears .' '. $odays);
1636     if ($days)  return trim($odays .' '. $ohours);
1637     if ($hours) return trim($ohours .' '. $omins);
1638     if ($mins)  return trim($omins .' '. $osecs);
1639     if ($secs)  return $osecs;
1640     return get_string('now');
1643 /**
1644  * Returns a formatted string that represents a date in user time
1645  *
1646  * Returns a formatted string that represents a date in user time
1647  * <b>WARNING: note that the format is for strftime(), not date().</b>
1648  * Because of a bug in most Windows time libraries, we can't use
1649  * the nicer %e, so we have to use %d which has leading zeroes.
1650  * A lot of the fuss in the function is just getting rid of these leading
1651  * zeroes as efficiently as possible.
1652  *
1653  * If parameter fixday = true (default), then take off leading
1654  * zero from %d, else maintain it.
1655  *
1656  * @param int $date the timestamp in UTC, as obtained from the database.
1657  * @param string $format strftime format. You should probably get this using
1658  *      get_string('strftime...', 'langconfig');
1659  * @param float $timezone by default, uses the user's time zone.
1660  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1661  *      If false then the leading zero is maintained.
1662  * @return string the formatted date/time.
1663  */
1664 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1666     global $CFG;
1668     $strtimezone = NULL;
1669     if (!is_numeric($timezone)) {
1670         $strtimezone = $timezone;
1671     }
1673     if (empty($format)) {
1674         $format = get_string('strftimedaydatetime', 'langconfig');
1675     }
1677     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1678         $fixday = false;
1679     } else if ($fixday) {
1680         $formatnoday = str_replace('%d', 'DD', $format);
1681         $fixday = ($formatnoday != $format);
1682     }
1684     $date += dst_offset_on($date, $strtimezone);
1686     $timezone = get_user_timezone_offset($timezone);
1688     if (abs($timezone) > 13) {   /// Server time
1689         if ($fixday) {
1690             $datestring = strftime($formatnoday, $date);
1691             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1692             $datestring = str_replace('DD', $daystring, $datestring);
1693         } else {
1694             $datestring = strftime($format, $date);
1695         }
1696     } else {
1697         $date += (int)($timezone * 3600);
1698         if ($fixday) {
1699             $datestring = gmstrftime($formatnoday, $date);
1700             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1701             $datestring = str_replace('DD', $daystring, $datestring);
1702         } else {
1703             $datestring = gmstrftime($format, $date);
1704         }
1705     }
1707 /// If we are running under Windows convert from windows encoding to UTF-8
1708 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1710    if ($CFG->ostype == 'WINDOWS') {
1711        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1712            $textlib = textlib_get_instance();
1713            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1714        }
1715    }
1717     return $datestring;
1720 /**
1721  * Given a $time timestamp in GMT (seconds since epoch),
1722  * returns an array that represents the date in user time
1723  *
1724  * @todo Finish documenting this function
1725  * @uses HOURSECS
1726  * @param int $time Timestamp in GMT
1727  * @param float $timezone ?
1728  * @return array An array that represents the date in user time
1729  */
1730 function usergetdate($time, $timezone=99) {
1732     $strtimezone = NULL;
1733     if (!is_numeric($timezone)) {
1734         $strtimezone = $timezone;
1735     }
1737     $timezone = get_user_timezone_offset($timezone);
1739     if (abs($timezone) > 13) {    // Server time
1740         return getdate($time);
1741     }
1743     // There is no gmgetdate so we use gmdate instead
1744     $time += dst_offset_on($time, $strtimezone);
1745     $time += intval((float)$timezone * HOURSECS);
1747     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1749     //be careful to ensure the returned array matches that produced by getdate() above
1750     list(
1751         $getdate['month'],
1752         $getdate['weekday'],
1753         $getdate['yday'],
1754         $getdate['year'],
1755         $getdate['mon'],
1756         $getdate['wday'],
1757         $getdate['mday'],
1758         $getdate['hours'],
1759         $getdate['minutes'],
1760         $getdate['seconds']
1761     ) = explode('_', $datestring);
1763     return $getdate;
1766 /**
1767  * Given a GMT timestamp (seconds since epoch), offsets it by
1768  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1769  *
1770  * @uses HOURSECS
1771  * @param  int $date Timestamp in GMT
1772  * @param float $timezone
1773  * @return int
1774  */
1775 function usertime($date, $timezone=99) {
1777     $timezone = get_user_timezone_offset($timezone);
1779     if (abs($timezone) > 13) {
1780         return $date;
1781     }
1782     return $date - (int)($timezone * HOURSECS);
1785 /**
1786  * Given a time, return the GMT timestamp of the most recent midnight
1787  * for the current user.
1788  *
1789  * @param int $date Timestamp in GMT
1790  * @param float $timezone Defaults to user's timezone
1791  * @return int Returns a GMT timestamp
1792  */
1793 function usergetmidnight($date, $timezone=99) {
1795     $userdate = usergetdate($date, $timezone);
1797     // Time of midnight of this user's day, in GMT
1798     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1802 /**
1803  * Returns a string that prints the user's timezone
1804  *
1805  * @param float $timezone The user's timezone
1806  * @return string
1807  */
1808 function usertimezone($timezone=99) {
1810     $tz = get_user_timezone($timezone);
1812     if (!is_float($tz)) {
1813         return $tz;
1814     }
1816     if(abs($tz) > 13) { // Server time
1817         return get_string('serverlocaltime');
1818     }
1820     if($tz == intval($tz)) {
1821         // Don't show .0 for whole hours
1822         $tz = intval($tz);
1823     }
1825     if($tz == 0) {
1826         return 'UTC';
1827     }
1828     else if($tz > 0) {
1829         return 'UTC+'.$tz;
1830     }
1831     else {
1832         return 'UTC'.$tz;
1833     }
1837 /**
1838  * Returns a float which represents the user's timezone difference from GMT in hours
1839  * Checks various settings and picks the most dominant of those which have a value
1840  *
1841  * @global object
1842  * @global object
1843  * @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
1844  * @return float
1845  */
1846 function get_user_timezone_offset($tz = 99) {
1848     global $USER, $CFG;
1850     $tz = get_user_timezone($tz);
1852     if (is_float($tz)) {
1853         return $tz;
1854     } else {
1855         $tzrecord = get_timezone_record($tz);
1856         if (empty($tzrecord)) {
1857             return 99.0;
1858         }
1859         return (float)$tzrecord->gmtoff / HOURMINS;
1860     }
1863 /**
1864  * Returns an int which represents the systems's timezone difference from GMT in seconds
1865  *
1866  * @global object
1867  * @param mixed $tz timezone
1868  * @return int if found, false is timezone 99 or error
1869  */
1870 function get_timezone_offset($tz) {
1871     global $CFG;
1873     if ($tz == 99) {
1874         return false;
1875     }
1877     if (is_numeric($tz)) {
1878         return intval($tz * 60*60);
1879     }
1881     if (!$tzrecord = get_timezone_record($tz)) {
1882         return false;
1883     }
1884     return intval($tzrecord->gmtoff * 60);
1887 /**
1888  * Returns a float or a string which denotes the user's timezone
1889  * 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)
1890  * means that for this timezone there are also DST rules to be taken into account
1891  * Checks various settings and picks the most dominant of those which have a value
1892  *
1893  * @global object
1894  * @global object
1895  * @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
1896  * @return mixed
1897  */
1898 function get_user_timezone($tz = 99) {
1899     global $USER, $CFG;
1901     $timezones = array(
1902         $tz,
1903         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1904         isset($USER->timezone) ? $USER->timezone : 99,
1905         isset($CFG->timezone) ? $CFG->timezone : 99,
1906         );
1908     $tz = 99;
1910     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1911         $tz = $next['value'];
1912     }
1914     return is_numeric($tz) ? (float) $tz : $tz;
1917 /**
1918  * Returns cached timezone record for given $timezonename
1919  *
1920  * @global object
1921  * @global object
1922  * @param string $timezonename
1923  * @return mixed timezonerecord object or false
1924  */
1925 function get_timezone_record($timezonename) {
1926     global $CFG, $DB;
1927     static $cache = NULL;
1929     if ($cache === NULL) {
1930         $cache = array();
1931     }
1933     if (isset($cache[$timezonename])) {
1934         return $cache[$timezonename];
1935     }
1937     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1938                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1941 /**
1942  * Build and store the users Daylight Saving Time (DST) table
1943  *
1944  * @global object
1945  * @global object
1946  * @global object
1947  * @param mixed $from_year Start year for the table, defaults to 1971
1948  * @param mixed $to_year End year for the table, defaults to 2035
1949  * @param mixed $strtimezone
1950  * @return bool
1951  */
1952 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1953     global $CFG, $SESSION, $DB;
1955     $usertz = get_user_timezone($strtimezone);
1957     if (is_float($usertz)) {
1958         // Trivial timezone, no DST
1959         return false;
1960     }
1962     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1963         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1964         unset($SESSION->dst_offsets);
1965         unset($SESSION->dst_range);
1966     }
1968     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1969         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1970         // This will be the return path most of the time, pretty light computationally
1971         return true;
1972     }
1974     // Reaching here means we either need to extend our table or create it from scratch
1976     // Remember which TZ we calculated these changes for
1977     $SESSION->dst_offsettz = $usertz;
1979     if(empty($SESSION->dst_offsets)) {
1980         // If we 're creating from scratch, put the two guard elements in there
1981         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1982     }
1983     if(empty($SESSION->dst_range)) {
1984         // If creating from scratch
1985         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1986         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1988         // Fill in the array with the extra years we need to process
1989         $yearstoprocess = array();
1990         for($i = $from; $i <= $to; ++$i) {
1991             $yearstoprocess[] = $i;
1992         }
1994         // Take note of which years we have processed for future calls
1995         $SESSION->dst_range = array($from, $to);
1996     }
1997     else {
1998         // If needing to extend the table, do the same
1999         $yearstoprocess = array();
2001         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2002         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2004         if($from < $SESSION->dst_range[0]) {
2005             // Take note of which years we need to process and then note that we have processed them for future calls
2006             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2007                 $yearstoprocess[] = $i;
2008             }
2009             $SESSION->dst_range[0] = $from;
2010         }
2011         if($to > $SESSION->dst_range[1]) {
2012             // Take note of which years we need to process and then note that we have processed them for future calls
2013             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2014                 $yearstoprocess[] = $i;
2015             }
2016             $SESSION->dst_range[1] = $to;
2017         }
2018     }
2020     if(empty($yearstoprocess)) {
2021         // This means that there was a call requesting a SMALLER range than we have already calculated
2022         return true;
2023     }
2025     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2026     // Also, the array is sorted in descending timestamp order!
2028     // Get DB data
2030     static $presets_cache = array();
2031     if (!isset($presets_cache[$usertz])) {
2032         $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');
2033     }
2034     if(empty($presets_cache[$usertz])) {
2035         return false;
2036     }
2038     // Remove ending guard (first element of the array)
2039     reset($SESSION->dst_offsets);
2040     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2042     // Add all required change timestamps
2043     foreach($yearstoprocess as $y) {
2044         // Find the record which is in effect for the year $y
2045         foreach($presets_cache[$usertz] as $year => $preset) {
2046             if($year <= $y) {
2047                 break;
2048             }
2049         }
2051         $changes = dst_changes_for_year($y, $preset);
2053         if($changes === NULL) {
2054             continue;
2055         }
2056         if($changes['dst'] != 0) {
2057             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2058         }
2059         if($changes['std'] != 0) {
2060             $SESSION->dst_offsets[$changes['std']] = 0;
2061         }
2062     }
2064     // Put in a guard element at the top
2065     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2066     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2068     // Sort again
2069     krsort($SESSION->dst_offsets);
2071     return true;
2074 /**
2075  * Calculates the required DST change and returns a Timestamp Array
2076  *
2077  * @uses HOURSECS
2078  * @uses MINSECS
2079  * @param mixed $year Int or String Year to focus on
2080  * @param object $timezone Instatiated Timezone object
2081  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
2082  */
2083 function dst_changes_for_year($year, $timezone) {
2085     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2086         return NULL;
2087     }
2089     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2090     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2092     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2093     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2095     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2096     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2098     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2099     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2100     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2102     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2103     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2105     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2108 /**
2109  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2110  *
2111  * @global object
2112  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2113  * @return int
2114  */
2115 function dst_offset_on($time, $strtimezone = NULL) {
2116     global $SESSION;
2118     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2119         return 0;
2120     }
2122     reset($SESSION->dst_offsets);
2123     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2124         if($from <= $time) {
2125             break;
2126         }
2127     }
2129     // This is the normal return path
2130     if($offset !== NULL) {
2131         return $offset;
2132     }
2134     // Reaching this point means we haven't calculated far enough, do it now:
2135     // Calculate extra DST changes if needed and recurse. The recursion always
2136     // moves toward the stopping condition, so will always end.
2138     if($from == 0) {
2139         // We need a year smaller than $SESSION->dst_range[0]
2140         if($SESSION->dst_range[0] == 1971) {
2141             return 0;
2142         }
2143         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2144         return dst_offset_on($time, $strtimezone);
2145     }
2146     else {
2147         // We need a year larger than $SESSION->dst_range[1]
2148         if($SESSION->dst_range[1] == 2035) {
2149             return 0;
2150         }
2151         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2152         return dst_offset_on($time, $strtimezone);
2153     }
2156 /**
2157  * ?
2158  *
2159  * @todo Document what this function does
2160  * @param int $startday
2161  * @param int $weekday
2162  * @param int $month
2163  * @param int $year
2164  * @return int
2165  */
2166 function find_day_in_month($startday, $weekday, $month, $year) {
2168     $daysinmonth = days_in_month($month, $year);
2170     if($weekday == -1) {
2171         // Don't care about weekday, so return:
2172         //    abs($startday) if $startday != -1
2173         //    $daysinmonth otherwise
2174         return ($startday == -1) ? $daysinmonth : abs($startday);
2175     }
2177     // From now on we 're looking for a specific weekday
2179     // Give "end of month" its actual value, since we know it
2180     if($startday == -1) {
2181         $startday = -1 * $daysinmonth;
2182     }
2184     // Starting from day $startday, the sign is the direction
2186     if($startday < 1) {
2188         $startday = abs($startday);
2189         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2191         // This is the last such weekday of the month
2192         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2193         if($lastinmonth > $daysinmonth) {
2194             $lastinmonth -= 7;
2195         }
2197         // Find the first such weekday <= $startday
2198         while($lastinmonth > $startday) {
2199             $lastinmonth -= 7;
2200         }
2202         return $lastinmonth;
2204     }
2205     else {
2207         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2209         $diff = $weekday - $indexweekday;
2210         if($diff < 0) {
2211             $diff += 7;
2212         }
2214         // This is the first such weekday of the month equal to or after $startday
2215         $firstfromindex = $startday + $diff;
2217         return $firstfromindex;
2219     }
2222 /**
2223  * Calculate the number of days in a given month
2224  *
2225  * @param int $month The month whose day count is sought
2226  * @param int $year The year of the month whose day count is sought
2227  * @return int
2228  */
2229 function days_in_month($month, $year) {
2230    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2233 /**
2234  * Calculate the position in the week of a specific calendar day
2235  *
2236  * @param int $day The day of the date whose position in the week is sought
2237  * @param int $month The month of the date whose position in the week is sought
2238  * @param int $year The year of the date whose position in the week is sought
2239  * @return int
2240  */
2241 function dayofweek($day, $month, $year) {
2242     // I wonder if this is any different from
2243     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2244     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2247 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2249 /**
2250  * Returns full login url.
2251  *
2252  * @return string login url
2253  */
2254 function get_login_url() {
2255     global $CFG;
2257     $url = "$CFG->wwwroot/login/index.php";
2259     if (!empty($CFG->loginhttps)) {
2260         $url = str_replace('http:', 'https:', $url);
2261     }
2263     return $url;
2266 /**
2267  * This function checks that the current user is logged in and has the
2268  * required privileges
2269  *
2270  * This function checks that the current user is logged in, and optionally
2271  * whether they are allowed to be in a particular course and view a particular
2272  * course module.
2273  * If they are not logged in, then it redirects them to the site login unless
2274  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2275  * case they are automatically logged in as guests.
2276  * If $courseid is given and the user is not enrolled in that course then the
2277  * user is redirected to the course enrolment page.
2278  * If $cm is given and the course module is hidden and the user is not a teacher
2279  * in the course then the user is redirected to the course home page.
2280  *
2281  * When $cm parameter specified, this function sets page layout to 'module'.
2282  * You need to change it manually later if some other layout needed.
2283  *
2284  * @param mixed $courseorid id of the course or course object
2285  * @param bool $autologinguest default true
2286  * @param object $cm course module object
2287  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2288  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2289  *             in order to keep redirects working properly. MDL-14495
2290  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2291  * @return mixed Void, exit, and die depending on path
2292  */
2293 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2294     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2296     // setup global $COURSE, themes, language and locale
2297     if (!empty($courseorid)) {
2298         if (is_object($courseorid)) {
2299             $course = $courseorid;
2300         } else if ($courseorid == SITEID) {
2301             $course = clone($SITE);
2302         } else {
2303             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2304         }
2305         if ($cm) {
2306             if ($cm->course != $course->id) {
2307                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2308             }
2309             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2310             $PAGE->set_pagelayout('incourse');
2311         } else {
2312             $PAGE->set_course($course); // set's up global $COURSE
2313         }
2314     } else {
2315         // do not touch global $COURSE via $PAGE->set_course(),
2316         // the reasons is we need to be able to call require_login() at any time!!
2317         $course = $SITE;
2318         if ($cm) {
2319             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2320         }
2321     }
2323     // If the user is not even logged in yet then make sure they are
2324     if (!isloggedin()) {
2325         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2326             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2327                 // misconfigured site guest, just redirect to login page
2328                 redirect(get_login_url());
2329                 exit; // never reached
2330             }
2331             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2332             complete_user_login($guest, false);
2333             $SESSION->lang = $lang;
2334         } else {
2335             //NOTE: $USER->site check was obsoleted by session test cookie,
2336             //      $USER->confirmed test is in login/index.php
2337             if ($preventredirect) {
2338                 throw new require_login_exception('You are not logged in');
2339             }
2341             if ($setwantsurltome) {
2342                 // TODO: switch to PAGE->url
2343                 $SESSION->wantsurl = $FULLME;
2344             }
2345             if (!empty($_SERVER['HTTP_REFERER'])) {
2346                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2347             }
2348             redirect(get_login_url());
2349             exit; // never reached
2350         }
2351     }
2353     // loginas as redirection if needed
2354     if ($course->id != SITEID and session_is_loggedinas()) {
2355         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2356             if ($USER->loginascontext->instanceid != $course->id) {
2357                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2358             }
2359         }
2360     }
2362     // check whether the user should be changing password (but only if it is REALLY them)
2363     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2364         $userauth = get_auth_plugin($USER->auth);
2365         if ($userauth->can_change_password() and !$preventredirect) {
2366             $SESSION->wantsurl = $FULLME;
2367             if ($changeurl = $userauth->change_password_url()) {
2368                 //use plugin custom url
2369                 redirect($changeurl);
2370             } else {
2371                 //use moodle internal method
2372                 if (empty($CFG->loginhttps)) {
2373                     redirect($CFG->wwwroot .'/login/change_password.php');
2374                 } else {
2375                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2376                     redirect($wwwroot .'/login/change_password.php');
2377                 }
2378             }
2379         } else {
2380             print_error('nopasswordchangeforced', 'auth');
2381         }
2382     }
2384     // Check that the user account is properly set up
2385     if (user_not_fully_set_up($USER)) {
2386         if ($preventredirect) {
2387             throw new require_login_exception('User not fully set-up');
2388         }
2389         $SESSION->wantsurl = $FULLME;
2390         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2391     }
2393     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2394     sesskey();
2396     // Do not bother admins with any formalities
2397     if (is_siteadmin()) {
2398         //set accesstime or the user will appear offline which messes up messaging
2399         user_accesstime_log($course->id);
2400         return;
2401     }
2403     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2404     if (!$USER->policyagreed and !is_siteadmin()) {
2405         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2406             if ($preventredirect) {
2407                 throw new require_login_exception('Policy not agreed');
2408             }
2409             $SESSION->wantsurl = $FULLME;
2410             redirect($CFG->wwwroot .'/user/policy.php');
2411         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2412             if ($preventredirect) {
2413                 throw new require_login_exception('Policy not agreed');
2414             }
2415             $SESSION->wantsurl = $FULLME;
2416             redirect($CFG->wwwroot .'/user/policy.php');
2417         }
2418     }
2420     // Fetch the system context, the course context, and prefetch its child contexts
2421     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2422     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2423     if ($cm) {
2424         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2425     } else {
2426         $cmcontext = null;
2427     }
2429     // If the site is currently under maintenance, then print a message
2430     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2431         if ($preventredirect) {
2432             throw new require_login_exception('Maintenance in progress');
2433         }
2435         print_maintenance_message();
2436     }
2438     // make sure the course itself is not hidden
2439     if ($course->id == SITEID) {
2440         // frontpage can not be hidden
2441     } else {
2442         if (is_role_switched($course->id)) {
2443             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2444         } else {
2445             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2446                 // originally there was also test of parent category visibility,
2447                 // BUT is was very slow in complex queries involving "my courses"
2448                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2449                 if ($preventredirect) {
2450                     throw new require_login_exception('Course is hidden');
2451                 }
2452                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2453             }
2454         }
2455     }
2457     // is the user enrolled?
2458     if ($course->id == SITEID) {
2459         // everybody is enrolled on the frontpage
2461     } else {
2462         if (session_is_loggedinas()) {
2463             // Make sure the REAL person can access this course first
2464             $realuser = session_get_realuser();
2465             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2466                 if ($preventredirect) {
2467                     throw new require_login_exception('Invalid course login-as access');
2468                 }
2469                 echo $OUTPUT->header();
2470                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2471             }
2472         }
2474         // very simple enrolment caching - changes in course setting are not reflected immediately
2475         if (!isset($USER->enrol)) {
2476             $USER->enrol = array();
2477             $USER->enrol['enrolled'] = array();
2478             $USER->enrol['tempguest'] = array();
2479         }
2481         $access = false;
2483         if (is_viewing($coursecontext, $USER)) {
2484             // ok, no need to mess with enrol
2485             $access = true;
2487         } else {
2488             if (isset($USER->enrol['enrolled'][$course->id])) {
2489                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2490                     $access = true;
2491                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2492                     $access = true;
2493                 } else {
2494                     //expired
2495                     unset($USER->enrol['enrolled'][$course->id]);
2496                 }
2497             }
2498             if (isset($USER->enrol['tempguest'][$course->id])) {
2499                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2500                     $access = true;
2501                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2502                     $access = true;
2503                 } else {
2504                     //expired
2505                     unset($USER->enrol['tempguest'][$course->id]);
2506                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2507                 }
2508             }
2510             if ($access) {
2511                 // cache ok
2512             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2513                 // active participants may always access
2514                 // TODO: refactor this into some new function
2515                 $now = time();
2516                 $sql = "SELECT MAX(ue.timeend)
2517                           FROM {user_enrolments} ue
2518                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2519                           JOIN {user} u ON u.id = ue.userid
2520                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2521                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2522                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2523                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2524                 $until = $DB->get_field_sql($sql, $params);
2525                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2526                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2527                 }
2529                 $USER->enrol['enrolled'][$course->id] = $until;
2530                 $access = true;
2532                 // remove traces of previous temp guest access
2533                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2535             } else {
2536                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2537                 $enrols = enrol_get_plugins(true);
2538                 // first ask all enabled enrol instances in course if they want to auto enrol user
2539                 foreach($instances as $instance) {
2540                     if (!isset($enrols[$instance->enrol])) {
2541                         continue;
2542                     }
2543                     // Get a duration for the guestaccess, a timestamp in the future or false.
2544                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2545                     if ($until !== false) {
2546                         $USER->enrol['enrolled'][$course->id] = $until;
2547                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2548                         $access = true;
2549                         break;
2550                     }
2551                 }
2552                 // if not enrolled yet try to gain temporary guest access
2553                 if (!$access) {
2554                     foreach($instances as $instance) {
2555                         if (!isset($enrols[$instance->enrol])) {
2556                             continue;
2557                         }
2558                         // Get a duration for the guestaccess, a timestamp in the future or false.
2559                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2560                         if ($until !== false) {
2561                             $USER->enrol['tempguest'][$course->id] = $until;
2562                             $access = true;
2563                             break;
2564                         }
2565                     }
2566                 }
2567             }
2568         }
2570         if (!$access) {
2571             if ($preventredirect) {
2572                 throw new require_login_exception('Not enrolled');
2573             }
2574             $SESSION->wantsurl = $FULLME;
2575             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2576         }
2577     }
2579     // test visibility
2580     if ($cm && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2581         if ($preventredirect) {
2582             throw new require_login_exception('Activity is hidden');
2583         }
2584         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2585     }
2587     // groupmembersonly access control
2588     if (!empty($CFG->enablegroupmembersonly) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2589         if (isguestuser() or !groups_has_membership($cm)) {
2590             if ($preventredirect) {
2591                 throw new require_login_exception('Not member of a group');
2592             }
2593             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2594         }
2595     }
2597     // Conditional activity access control
2598     if (!empty($CFG->enableavailability) and $cm) {
2599         // TODO: this is going to work with login-as-user, sorry!
2600         // We cache conditional access in session
2601         if (!isset($SESSION->conditionaccessok)) {
2602             $SESSION->conditionaccessok = array();
2603         }
2604         // If you have been allowed into the module once then you are allowed
2605         // in for rest of session, no need to do conditional checks
2606         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2607             // Get condition info (does a query for the availability table)
2608             require_once($CFG->libdir.'/conditionlib.php');
2609             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2610             // Check condition for user (this will do a query if the availability
2611             // information depends on grade or completion information)
2612             if ($ci->is_available($junk) || has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2613                 $SESSION->conditionaccessok[$cm->id] = true;
2614             } else {
2615                 print_error('activityiscurrentlyhidden');
2616             }
2617         }
2618     }
2620     // Finally access granted, update lastaccess times
2621     user_accesstime_log($course->id);
2625 /**
2626  * This function just makes sure a user is logged out.
2627  *
2628  * @global object
2629  */
2630 function require_logout() {
2631     global $USER;
2633     $params = $USER;
2635     if (isloggedin()) {
2636         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2638         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2639         foreach($authsequence as $authname) {
2640             $authplugin = get_auth_plugin($authname);
2641             $authplugin->prelogout_hook();
2642         }
2643     }
2645     events_trigger('user_logout', $params);
2646     session_get_instance()->terminate_current();
2647     unset($params);
2650 /**
2651  * Weaker version of require_login()
2652  *
2653  * This is a weaker version of {@link require_login()} which only requires login
2654  * when called from within a course rather than the site page, unless
2655  * the forcelogin option is turned on.
2656  * @see require_login()
2657  *
2658  * @global object
2659  * @param mixed $courseorid The course object or id in question
2660  * @param bool $autologinguest Allow autologin guests if that is wanted
2661  * @param object $cm Course activity module if known
2662  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2663  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2664  *             in order to keep redirects working properly. MDL-14495
2665  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2666  * @return void
2667  */
2668 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2669     global $CFG, $PAGE, $SITE;
2670     if (!empty($CFG->forcelogin)) {
2671         // login required for both SITE and courses
2672         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2674     } else if (!empty($cm) and !$cm->visible) {
2675         // always login for hidden activities
2676         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2678     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2679           or (!is_object($courseorid) and $courseorid == SITEID)) {
2680               //login for SITE not required
2681         if ($cm and empty($cm->visible)) {
2682             // hidden activities are not accessible without login
2683             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2684         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2685             // not-logged-in users do not have any group membership
2686             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2687         } else {
2688             // We still need to instatiate PAGE vars properly so that things
2689             // that rely on it like navigation function correctly.
2690             if (!empty($courseorid)) {
2691                 if (is_object($courseorid)) {
2692                     $course = $courseorid;
2693                 } else {
2694                     $course = clone($SITE);
2695                 }
2696                 if ($cm) {
2697                     if ($cm->course != $course->id) {
2698                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2699                     }
2700                     $PAGE->set_cm($cm, $course);
2701                     $PAGE->set_pagelayout('incourse');
2702                 } else {
2703                     $PAGE->set_course($course);
2704                 }
2705             } else {
2706                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2707                 // up properly, set them up now.
2708                 $PAGE->set_course($PAGE->course);
2709             }
2710             //TODO: verify conditional activities here
2711             user_accesstime_log(SITEID);
2712             return;
2713         }
2715     } else {
2716         // course login always required
2717         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2718     }
2721 /**
2722  * Require key login. Function terminates with error if key not found or incorrect.
2723  *
2724  * @global object
2725  * @global object
2726  * @global object
2727  * @global object
2728  * @uses NO_MOODLE_COOKIES
2729  * @uses PARAM_ALPHANUM
2730  * @param string $script unique script identifier
2731  * @param int $instance optional instance id
2732  * @return int Instance ID
2733  */
2734 function require_user_key_login($script, $instance=null) {
2735     global $USER, $SESSION, $CFG, $DB;
2737     if (!NO_MOODLE_COOKIES) {
2738         print_error('sessioncookiesdisable');
2739     }
2741 /// extra safety
2742     @session_write_close();
2744     $keyvalue = required_param('key', PARAM_ALPHANUM);
2746     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2747         print_error('invalidkey');
2748     }
2750     if (!empty($key->validuntil) and $key->validuntil < time()) {
2751         print_error('expiredkey');
2752     }
2754     if ($key->iprestriction) {
2755         $remoteaddr = getremoteaddr(null);
2756         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2757             print_error('ipmismatch');
2758         }
2759     }
2761     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2762         print_error('invaliduserid');
2763     }
2765 /// emulate normal session
2766     session_set_user($user);
2768 /// note we are not using normal login
2769     if (!defined('USER_KEY_LOGIN')) {
2770         define('USER_KEY_LOGIN', true);
2771     }
2773 /// return instance id - it might be empty
2774     return $key->instance;
2777 /**
2778  * Creates a new private user access key.
2779  *
2780  * @global object
2781  * @param string $script unique target identifier
2782  * @param int $userid
2783  * @param int $instance optional instance id
2784  * @param string $iprestriction optional ip restricted access
2785  * @param timestamp $validuntil key valid only until given data
2786  * @return string access key value
2787  */
2788 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2789     global $DB;
2791     $key = new stdClass();
2792     $key->script        = $script;
2793     $key->userid        = $userid;
2794     $key->instance      = $instance;
2795     $key->iprestriction = $iprestriction;
2796     $key->validuntil    = $validuntil;
2797     $key->timecreated   = time();
2799     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2800     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2801         // must be unique
2802         $key->value     = md5($userid.'_'.time().random_string(40));
2803     }
2804     $DB->insert_record('user_private_key', $key);
2805     return $key->value;
2808 /**
2809  * Delete the user's new private user access keys for a particular script.
2810  *
2811  * @global object
2812  * @param string $script unique target identifier
2813  * @param int $userid
2814  * @return void
2815  */
2816 function delete_user_key($script,$userid) {
2817     global $DB;
2818     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
2821 /**
2822  * Gets a private user access key (and creates one if one doesn't exist).
2823  *
2824  * @global object
2825  * @param string $script unique target identifier
2826  * @param int $userid
2827  * @param int $instance optional instance id
2828  * @param string $iprestriction optional ip restricted access
2829  * @param timestamp $validuntil key valid only until given data
2830  * @return string access key value
2831  */
2832 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2833     global $DB;
2835     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
2836                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
2837                                                          'validuntil'=>$validuntil))) {
2838         return $key->value;
2839     } else {
2840         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
2841     }
2845 /**
2846  * Modify the user table by setting the currently logged in user's
2847  * last login to now.
2848  *
2849  * @global object
2850  * @global object
2851  * @return bool Always returns true
2852  */
2853 function update_user_login_times() {
2854     global $USER, $DB;
2856     $user = new stdClass();
2857     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2858     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2860     $user->id = $USER->id;
2862     $DB->update_record('user', $user);
2863     return true;
2866 /**
2867  * Determines if a user has completed setting up their account.
2868  *
2869  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
2870  * @return bool
2871  */
2872 function user_not_fully_set_up($user) {
2873     if (isguestuser($user)) {
2874         return false;
2875     }
2876     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
2879 /**
2880  * Check whether the user has exceeded the bounce threshold
2881  *
2882  * @global object
2883  * @global object
2884  * @param user $user A {@link $USER} object
2885  * @return bool true=>User has exceeded bounce threshold
2886  */
2887 function over_bounce_threshold($user) {
2888     global $CFG, $DB;
2890     if (empty($CFG->handlebounces)) {
2891         return false;
2892     }
2894     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2895         return false;
2896     }
2898     // set sensible defaults
2899     if (empty($CFG->minbounces)) {
2900         $CFG->minbounces = 10;
2901     }
2902     if (empty($CFG->bounceratio)) {
2903         $CFG->bounceratio = .20;
2904     }
2905     $bouncecount = 0;
2906     $sendcount = 0;
2907     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2908         $bouncecount = $bounce->value;
2909     }
2910     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2911         $sendcount = $send->value;
2912     }
2913     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2916 /**
2917  * Used to increment or reset email sent count
2918  *
2919  * @global object
2920  * @param user $user object containing an id
2921  * @param bool $reset will reset the count to 0
2922  * @return void
2923  */
2924 function set_send_count($user,$reset=false) {
2925     global $DB;
2927     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2928         return;
2929     }
2931     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2932         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2933         $DB->update_record('user_preferences', $pref);
2934     }
2935     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2936         // make a new one
2937         $pref = new stdClass();
2938         $pref->name   = 'email_send_count';
2939         $pref->value  = 1;
2940         $pref->userid = $user->id;
2941         $DB->insert_record('user_preferences', $pref, false);
2942     }
2945 /**
2946  * Increment or reset user's email bounce count
2947  *
2948  * @global object
2949  * @param user $user object containing an id
2950  * @param bool $reset will reset the count to 0
2951  */
2952 function set_bounce_count($user,$reset=false) {
2953     global $DB;
2955     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2956         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2957         $DB->update_record('user_preferences', $pref);
2958     }
2959     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2960         // make a new one
2961         $pref = new stdClass();
2962         $pref->name   = 'email_bounce_count';
2963         $pref->value  = 1;
2964         $pref->userid = $user->id;
2965         $DB->insert_record('user_preferences', $pref, false);
2966     }
2969 /**
2970  * Keeps track of login attempts
2971  *
2972  * @global object
2973  */
2974 function update_login_count() {
2975     global $SESSION;
2977     $max_logins = 10;
2979     if (empty($SESSION->logincount)) {
2980         $SESSION->logincount = 1;
2981     } else {
2982         $SESSION->logincount++;
2983     }
2985     if ($SESSION->logincount > $max_logins) {
2986         unset($SESSION->wantsurl);
2987         print_error('errortoomanylogins');
2988     }
2991 /**
2992  * Resets login attempts
2993  *
2994  * @global object
2995  */
2996 function reset_login_count() {
2997     global $SESSION;
2999     $SESSION->logincount = 0;
3002 /**
3003  * Returns reference to full info about modules in course (including visibility).
3004  * Cached and as fast as possible (0 or 1 db query).
3005  *
3006  * @global object
3007  * @global object
3008  * @global object
3009  * @uses CONTEXT_MODULE
3010  * @uses MAX_MODINFO_CACHE_SIZE
3011  * @param mixed $course object or 'reset' string to reset caches, modinfo may be updated in db
3012  * @param int $userid Defaults to current user id
3013  * @return mixed courseinfo object or nothing if resetting
3014  */
3015 function &get_fast_modinfo(&$course, $userid=0) {
3016     global $CFG, $USER, $DB;
3017     require_once($CFG->dirroot.'/course/lib.php');
3019     if (!empty($CFG->enableavailability)) {
3020         require_once($CFG->libdir.'/conditionlib.php');
3021     }
3023     static $cache = array();
3025     if ($course === 'reset') {
3026         $cache = array();
3027         $nothing = null;
3028         return $nothing; // we must return some reference
3029     }
3031     if (empty($userid)) {
3032         $userid = $USER->id;
3033     }
3035     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
3036         return $cache[$course->id];
3037     }
3039     if (empty($course->modinfo)) {
3040         // no modinfo yet - load it
3041         rebuild_course_cache($course->id);
3042         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
3043     }
3045     $modinfo = new stdClass();
3046     $modinfo->courseid  = $course->id;
3047     $modinfo->userid    = $userid;
3048     $modinfo->sections  = array();
3049     $modinfo->cms       = array();
3050     $modinfo->instances = array();
3051     $modinfo->groups    = null; // loaded only when really needed - the only one db query
3053     $info = unserialize($course->modinfo);
3054     if (!is_array($info)) {
3055         // hmm, something is wrong - lets try to fix it
3056         rebuild_course_cache($course->id);
3057         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
3058         $info = unserialize($course->modinfo);
3059         if (!is_array($info)) {
3060             return $modinfo;
3061         }
3062     }
3064     if ($info) {
3065         // detect if upgrade required
3066         $first = reset($info);
3067         if (!isset($first->id)) {
3068             rebuild_course_cache($course->id);
3069             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
3070             $info = unserialize($course->modinfo);
3071             if (!is_array($info)) {
3072                 return $modinfo;
3073             }
3074         }
3075     }
3077     $modlurals = array();
3079     // If we haven't already preloaded contexts for the course, do it now
3080     preload_course_contexts($course->id);
3082     foreach ($info as $mod) {
3083         if (empty($mod->name)) {
3084             // something is wrong here
3085             continue;
3086         }
3087         // reconstruct minimalistic $cm
3088         $cm = new stdClass();
3089         $cm->id               = $mod->cm;
3090         $cm->instance         = $mod->id;
3091         $cm->course           = $course->id;
3092         $cm->modname          = $mod->mod;
3093         $cm->idnumber         = $mod->idnumber;
3094         $cm->name             = $mod->name;
3095         $cm->visible          = $mod->visible;
3096         $cm->sectionnum       = $mod->section;
3097         $cm->groupmode        = $mod->groupmode;
3098         $cm->groupingid       = $mod->groupingid;
3099         $cm->groupmembersonly = $mod->groupmembersonly;
3100         $cm->indent           = $mod->indent;
3101         $cm->completion       = $mod->completion;
3102         $cm->extra            = isset($mod->extra) ? $mod->extra : '';
3103         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
3104         $cm->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
3105         $cm->uservisible      = true;
3106         if (!empty($CFG->enableavailability)) {
3107             // We must have completion information from modinfo. If it's not
3108             // there, cache needs rebuilding
3109             if(!isset($mod->availablefrom)) {
3110                 debugging('enableavailability option was changed; rebuilding '.
3111                     'cache for course '.$course->id);
3112                 rebuild_course_cache($course->id,true);
3113                 // Re-enter this routine to do it all properly
3114                 return get_fast_modinfo($course, $userid);
3115             }
3116             $cm->availablefrom    = $mod->availablefrom;
3117             $cm->availableuntil   = $mod->availableuntil;
3118             $cm->showavailability = $mod->showavailability;
3119             $cm->conditionscompletion = $mod->conditionscompletion;
3120             $cm->conditionsgrade  = $mod->conditionsgrade;
3121         }
3123         // preload long names plurals and also check module is installed properly
3124         if (!isset($modlurals[$cm->modname])) {
3125             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
3126                 continue;
3127             }
3128             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
3129         }
3130         $cm->modplural = $modlurals[$cm->modname];
3131         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
3133         if (!empty($CFG->enableavailability)) {
3134             // Unfortunately the next call really wants to call
3135             // get_fast_modinfo, but that would be recursive, so we fake up a
3136             // modinfo for it already
3137             if (empty($minimalmodinfo)) { //TODO: this is suspicious (skodak)
3138                 $minimalmodinfo = new stdClass();
3139                 $minimalmodinfo->cms = array();
3140                 foreach($info as $mod) {
3141                     if (empty($mod->name)) {
3142                         // something is wrong here
3143                         continue;
3144                     }
3145                     $minimalcm = new stdClass();
3146                     $minimalcm->id = $mod->cm;
3147                     $minimalcm->name = $mod->name;
3148                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
3149                 }
3150             }
3152             // Get availability information
3153             $ci = new condition_info($cm);
3154             $cm->available = $ci->is_available($cm->availableinfo, true, $userid, $minimalmodinfo);
3155         } else {
3156             $cm->available = true;
3157         }
3158         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
3159             $cm->uservisible = false;
3161         } else if (!empty($CFG->enablegroupmembersonly) and !empty($cm->groupmembersonly)
3162                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
3163             if (is_null($modinfo->groups)) {
3164                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
3165             }
3166             if (empty($modinfo->groups[$cm->groupingid])) {
3167                 $cm->uservisible = false;
3168             }
3169         }
3171         if (!isset($modinfo->instances[$cm->modname])) {
3172             $modinfo->instances[$cm->modname] = array();
3173         }
3174         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
3175         $modinfo->cms[$cm->id] =& $cm;
3177         // reconstruct sections
3178         if (!isset($modinfo->sections[$cm->sectionnum])) {
3179             $modinfo->sections[$cm->sectionnum] = array();
3180         }
3181         $modinfo->sections[$cm->sectionnum][] = $cm->id;
3183         unset($cm);
3184     }
3186     unset($cache[$course->id]); // prevent potential reference problems when switching users
3187     $cache[$course->id] = $modinfo;
3189     // Ensure cache does not use too much RAM
3190     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
3191         reset($cache);
3192         $key = key($cache);
3193         unset($cache[$key]);
3194     }
3196     return $cache[$course->id];
3199 /**
3200  * Determines if the currently logged in user is in editing mode.
3201  * Note: originally this function had $userid parameter - it was not usable anyway
3202  *
3203  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3204  * @todo Deprecated function remove when ready
3205  *
3206  * @global object
3207  * @uses DEBUG_DEVELOPER
3208  * @return bool
3209  */
3210 function isediting() {
3211     global $PAGE;
3212     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3213     return $PAGE->user_is_editing();
3216 /**
3217  * Determines if the logged in user is currently moving an activity
3218  *
3219  * @global object
3220  * @param int $courseid The id of the course being tested
3221  * @return bool
3222  */
3223 function ismoving($courseid) {
3224     global $USER;
3226     if (!empty($USER->activitycopy)) {
3227         return ($USER->activitycopycourse == $courseid);
3228     }
3229     return false;
3232 /**
3233  * Returns a persons full name
3234  *
3235  * Given an object containing firstname and lastname
3236  * values, this function returns a string with the
3237  * full name of the person.
3238  * The result may depend on system settings
3239  * or language.  'override' will force both names
3240  * to be used even if system settings specify one.
3241  *
3242  * @global object
3243  * @global object
3244  * @param object $user A {@link $USER} object to get full name of
3245  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3246  * @return string
3247  */
3248 function fullname($user, $override=false) {
3249     global $CFG, $SESSION;
3251     if (!isset($user->firstname) and !isset($user->lastname)) {
3252         return '';
3253     }
3255     if (!$override) {
3256         if (!empty($CFG->forcefirstname)) {
3257             $user->firstname = $CFG->forcefirstname;
3258         }
3259         if (!empty($CFG->forcelastname)) {
3260             $user->lastname = $CFG->forcelastname;
3261         }
3262     }
3264     if (!empty($SESSION->fullnamedisplay)) {
3265         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3266     }
3268     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3269         return $user->firstname .' '. $user->lastname;
3271     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3272         return $user->lastname .' '. $user->firstname;
3274     } else if ($CFG->fullnamedisplay == 'firstname') {
3275         if ($override) {
3276             return get_string('fullnamedisplay', '', $user);
3277         } else {
3278             return $user->firstname;
3279         }
3280     }
3282     return get_string('fullnamedisplay', '', $user);
3285 /**
3286  * Returns whether a given authentication plugin exists.
3287  *
3288  * @global object
3289  * @param string $auth Form of authentication to check for. Defaults to the
3290  *        global setting in {@link $CFG}.
3291  * @return boolean Whether the plugin is available.
3292  */
3293 function exists_auth_plugin($auth) {
3294     global $CFG;
3296     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3297         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3298     }
3299     return false;
3302 /**
3303  * Checks if a given plugin is in the list of enabled authentication plugins.
3304  *
3305  * @param string $auth Authentication plugin.
3306  * @return boolean Whether the plugin is enabled.
3307  */
3308 function is_enabled_auth($auth) {
3309     if (empty($auth)) {
3310         return false;
3311     }
3313     $enabled = get_enabled_auth_plugins();
3315     return in_array($auth, $enabled);
3318 /**
3319  * Returns an authentication plugin instance.
3320  *
3321  * @global object
3322  * @param string $auth name of authentication plugin
3323  * @return auth_plugin_base An instance of the required authentication plugin.
3324  */
3325 function get_auth_plugin($auth) {
3326     global $CFG;
3328     // check the plugin exists first
3329     if (! exists_auth_plugin($auth)) {
3330         print_error('authpluginnotfound', 'debug', '', $auth);
3331     }
3333     // return auth plugin instance
3334     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3335     $class = "auth_plugin_$auth";
3336     return new $class;
3339 /**
3340  * Returns array of active auth plugins.
3341  *
3342  * @param bool $fix fix $CFG->auth if needed
3343  * @return array
3344  */
3345 function get_enabled_auth_plugins($fix=false) {
3346     global $CFG;
3348     $default = array('manual', 'nologin');
3350     if (empty($CFG->auth)) {
3351         $auths = array();
3352     } else {
3353         $auths = explode(',', $CFG->auth);
3354     }
3356     if ($fix) {
3357         $auths = array_unique($auths);
3358         foreach($auths as $k=>$authname) {
3359             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3360                 unset($auths[$k]);
3361             }
3362         }
3363         $newconfig = implode(',', $auths);
3364         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3365             set_config('auth', $newconfig);
3366         }
3367     }
3369     return (array_merge($default, $auths));
3372 /**
3373  * Returns true if an internal authentication method is being used.
3374  * if method not specified then, global default is assumed
3375  *
3376  * @param string $auth Form of authentication required
3377  * @return bool
3378  */
3379 function is_internal_auth($auth) {
3380     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3381     return $authplugin->is_internal();
3384 /**
3385  * Returns true if the user is a 'restored' one
3386  *
3387  * Used in the login process to inform the user
3388  * and allow him/her to reset the password
3389  *
3390  * @uses $CFG
3391  * @uses $DB
3392  * @param string $username username to be checked
3393  * @return bool
3394  */
3395 function is_restored_user($username) {
3396     global $CFG, $DB;
3398     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3401 /**
3402  * Returns an array of user fields
3403  *
3404  * @return array User field/column names
3405  */
3406 function get_user_fieldnames() {
3407     global $DB;
3409     $fieldarray = $DB->get_columns('user');
3410     unset($fieldarray['id']);
3411     $fieldarray = array_keys($fieldarray);
3413     return $fieldarray;
3416 /**
3417  * Creates a bare-bones user record
3418  *
3419  * @todo Outline auth types and provide code example
3420  *
3421  * @global object
3422  * @global object
3423  * @param string $username New user's username to add to record
3424  * @param string $password New user's password to add to record
3425  * @param string $auth Form of authentication required
3426  * @return object A {@link $USER} object
3427  */
3428 function create_user_record($username, $password, $auth='manual') {
3429     global $CFG, $DB;
3431     //just in case check text case
3432     $username = trim(moodle_strtolower($username));
3434     $authplugin = get_auth_plugin($auth);
3436     $newuser = new stdClass();
3438     if ($newinfo = $authplugin->get_userinfo($username)) {
3439         $newinfo = truncate_userinfo($newinfo);
3440         foreach ($newinfo as $key => $value){
3441             $newuser->$key = $value;
3442         }
3443     }
3445     if (!empty($newuser->email)) {
3446         if (email_is_not_allowed($newuser->email)) {
3447             unset($newuser->email);
3448         }
3449     }
3451     if (!isset($newuser->city)) {
3452         $newuser->city = '';
3453     }
3455     $newuser->auth = $auth;
3456     $newuser->username = $username;
3458     // fix for MDL-8480
3459     // user CFG lang for user if $newuser->lang is empty
3460     // or $user->lang is not an installed language
3461     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3462         $newuser->lang = $CFG->lang;
3463     }
3464     $newuser->confirmed = 1;
3465     $newuser->lastip = getremoteaddr();
3466     $newuser->timemodified = time();
3467     $newuser->mnethostid = $CFG->mnet_localhost_id;
3469     $DB->insert_record('user', $newuser);
3470     $user = get_complete_user_data('username', $newuser->username);
3471     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3472         set_user_preference('auth_forcepasswordchange', 1, $user->id);
3473     }
3474     update_internal_user_password($user, $password);
3475     return $user;
3478 /**
3479  * Will update a local user record from an external source
3480  *
3481  * @global object
3482  * @param string $username New user's username to add to record
3483  * @param string $authplugin Unused
3484  * @return user A {@link $USER} object
3485  */
3486 function update_user_record($username, $authplugin) {
3487     global $DB;
3489     $username = trim(moodle_strtolower($username)); /// just in case check text case
3491     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
3492     $userauth = get_auth_plugin($oldinfo->auth);
3494     if ($newinfo = $userauth->get_userinfo($username)) {
3495         $newinfo = truncate_userinfo($newinfo);
3496         foreach ($newinfo as $key => $value){
3497             if ($key === 'username') {
3498                 // 'username' is not a mapped updateable/lockable field, so skip it.
3499                 continue;
3500             }
3501             $confval = $userauth->config->{'field_updatelocal_' . $key};
3502             $lockval = $userauth->config->{'field_lock_' . $key};
3503             if (empty($confval) || empty($lockval)) {
3504                 continue;
3505             }
3506             if ($confval === 'onlogin') {
3507                 // MDL-4207 Don't overwrite modified user profile values with
3508                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3509                 // of the setting 'unlocked if empty' is to allow the user to fill
3510                 // in a value for the selected field _if LDAP is giving
3511                 // nothing_ for this field. Thus it makes sense to let this value
3512                 // stand in until LDAP is giving a value for this field.
3513                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3514                     $DB->set_field('user', $key, $value, array('username'=>$username));
3515                 }
3516             }
3517         }
3518     }
3520     return get_complete_user_data('username', $username);
3523 /**
3524  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3525  * which may have large fields
3526  *
3527  * @todo Add vartype handling to ensure $info is an array
3528  *
3529  * @param array $info Array of user properties to truncate if needed
3530  * @return array The now truncated information that was passed in
3531  */
3532 function truncate_userinfo($info) {
3533     // define the limits
3534     $limit = array(
3535                     'username'    => 100,
3536                     'idnumber'    => 255,
3537                     'firstname'   => 100,
3538                     'lastname'    => 100,
3539                     'email'       => 100,
3540                     'icq'         =>  15,
3541                     'phone1'      =>  20,
3542                     'phone2'      =>  20,
3543                     'institution' =>  40,
3544                     'department'  =>  30,
3545                     'address'     =>  70,
3546                     'city'        => 120,
3547                     'country'     =>   2,
3548                     'url'         => 255,
3549                     );
3551     $textlib = textlib_get_instance();
3552     // apply where needed
3553     foreach (array_keys($info) as $key) {
3554         if (!empty($limit[$key])) {
3555             $info[$key] = trim($textlib->substr($info[$key],0, $limit[$key]));
3556         }
3557     }
3559     return $info;
3562 /**
3563  * Marks user deleted in internal user database and notifies the auth plugin.
3564  * Also unenrols user from all roles and does other cleanup.
3565  *
3566  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3567  *
3568  * @param object $user User object before delete
3569  * @return boolean always true
3570  */
3571 function delete_user($user) {
3572     global $CFG, $DB;
3573     require_once($CFG->libdir.'/grouplib.php');
3574     require_once($CFG->libdir.'/gradelib.php');
3575     require_once($CFG->dirroot.'/message/lib.php');
3576     require_once($CFG->dirroot.'/tag/lib.php');
3578     // delete all grades - backup is kept in grade_grades_history table
3579     grade_user_delete($user->id);
3581     //move unread messages from this user to read
3582     message_move_userfrom_unread2read($user->id);
3584     // TODO: remove from cohorts using standard API here
3586     // remove user tags
3587     tag_set('user', $user->id, array());
3589     // unconditionally unenrol from all courses
3590     enrol_user_delete($user);
3592     // unenrol from all roles in all contexts
3593     role_unassign_all(array('userid'=>$user->id)); // this might be slow but it is really needed - modules might do some extra cleanup!
3595     //now do a brute force cleanup
3597     // remove from all cohorts
3598     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3600     // remove from all groups
3601     $DB->delete_records('groups_members', array('userid'=>$user->id));
3603     // brute force unenrol from all courses
3604     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3606     // purge user preferences
3607     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3609     // purge user extra profile info
3610     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3612     // last course access not necessary either
3613     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3615     // now do a final accesslib cleanup - removes all role assignments in user context and context itself
3616     delete_context(CONTEXT_USER, $user->id);
3618     // workaround for bulk deletes of users with the same email address
3619     $delname = "$user->email.".time();
3620     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3621         $delname++;
3622     }
3624     // mark internal user record as "deleted"
3625     $updateuser = new stdClass();
3626     $updateuser->id           = $user->id;
3627     $updateuser->deleted      = 1;
3628     $updateuser->username     = $delname;            // Remember it just in case
3629     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3630     $updateuser->idnumber     = '';                  // Clear this field to free it up
3631     $updateuser->timemodified = time();
3633     $DB->update_record('user', $updateuser);
3635     // notify auth plugin - do not block the delete even when plugin fails
3636     $authplugin = get_auth_plugin($user->auth);
3637     $authplugin->user_delete($user);
3639     // any plugin that needs to cleanup should register this event
3640     events_trigger('user_deleted', $user);
3642     return true;
3645 /**
3646  * Retrieve the guest user object
3647  *
3648  * @global object
3649  * @global object
3650  * @return user A {@link $USER} object
3651  */
3652 function guest_user() {
3653     global $CFG, $DB;
3655     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
3656         $newuser->confirmed = 1;
3657         $newuser->lang = $CFG->lang;
3658         $newuser->lastip = getremoteaddr();
3659     }
3661     return $newuser;
3664 /**
3665  * Authenticates a user against the chosen authentication mechanism
3666  *
3667  * Given a username and password, this function looks them
3668  * up using the currently selected authentication mechanism,
3669  * and if the authentication is successful, it returns a
3670  * valid $user object from the 'user' table.
3671  *
3672  * Uses auth_ functions from the currently active auth module
3673  *
3674  * After authenticate_user_login() returns success, you will need to
3675  * log that the user has logged in, and call complete_user_login() to set
3676  * the session up.
3677  *
3678  * Note: this function works only with non-mnet accounts!
3679  *
3680  * @param string $username  User's username
3681  * @param string $password  User's password
3682  * @return user|flase A {@link $USER} object or false if error
3683  */
3684 function authenticate_user_login($username, $password) {
3685     global $CFG, $DB;
3687     $authsenabled = get_enabled_auth_plugins();
3689     if ($user = get_complete_user_data('username', $username, $CFG->mnet_localhost_id)) {
3690         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if a