MDL-19676 MDL-14408 MDL-8776 Blog improvements
[moodle.git] / lib / moodlelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * moodlelib.php - Moodle main library
20  *
21  * Main library file of miscellaneous general-purpose Moodle functions.
22  * Other main libraries:
23  *  - weblib.php      - functions that produce web output
24  *  - datalib.php     - functions that access the database
25  *
26  * @package   moodlecore
27  * @copyright 1999 onwards Martin Dougiamas  http://dougiamas.com
28  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
29  */
31 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
33 /**
34  * Used by some scripts to check they are being called by Moodle
35  */
36 define('MOODLE_INTERNAL', true);
38 /// Date and time constants ///
39 /**
40  * Time constant - the number of seconds in a year
41  */
42 define('YEARSECS', 31536000);
44 /**
45  * Time constant - the number of seconds in a week
46  */
47 define('WEEKSECS', 604800);
49 /**
50  * Time constant - the number of seconds in a day
51  */
52 define('DAYSECS', 86400);
54 /**
55  * Time constant - the number of seconds in an hour
56  */
57 define('HOURSECS', 3600);
59 /**
60  * Time constant - the number of seconds in a minute
61  */
62 define('MINSECS', 60);
64 /**
65  * Time constant - the number of minutes in a day
66  */
67 define('DAYMINS', 1440);
69 /**
70  * Time constant - the number of minutes in an hour
71  */
72 define('HOURMINS', 60);
74 /// Parameter constants - every call to optional_param(), required_param()  ///
75 /// or clean_param() should have a specified type of parameter.  //////////////
79 /**
80  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
81  */
82 define('PARAM_ALPHA',    'alpha');
84 /**
85  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
86  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
87  */
88 define('PARAM_ALPHAEXT', 'alphaext');
90 /**
91  * PARAM_ALPHANUM - expected numbers and letters only.
92  */
93 define('PARAM_ALPHANUM', 'alphanum');
95 /**
96  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
97  */
98 define('PARAM_ALPHANUMEXT', 'alphanumext');
100 /**
101  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
102  */
103 define('PARAM_AUTH',  'auth');
105 /**
106  * PARAM_BASE64 - Base 64 encoded format
107  */
108 define('PARAM_BASE64',   'base64');
110 /**
111  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
112  */
113 define('PARAM_BOOL',     'bool');
115 /**
116  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
117  * checked against the list of capabilties in the database.
118  */
119 define('PARAM_CAPABILITY',   'capability');
121 /**
122  * PARAM_CLEANHTML - cleans submitted HTML code and removes slashes. It stays as HTML.
123  */
124 define('PARAM_CLEANHTML', 'cleanhtml');
126 /**
127  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
128  */
129 define('PARAM_FILE',   'file');
131 /**
132  * PARAM_FLOAT - a real/floating point number.
133  */
134 define('PARAM_FLOAT',  'float');
136 /**
137  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
138  */
139 define('PARAM_HOST',     'host');
141 /**
142  * PARAM_INT - integers only, use when expecting only numbers.
143  */
144 define('PARAM_INT',      'int');
146 /**
147  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
148  */
149 define('PARAM_LANG',  'lang');
151 /**
152  * 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!)
153  */
154 define('PARAM_LOCALURL', 'localurl');
156 /**
157  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
158  */
159 define('PARAM_NOTAGS',   'notags');
161 /**
162  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
163  * note: the leading slash is not removed, window drive letter is not allowed
164  */
165 define('PARAM_PATH',     'path');
167 /**
168  * PARAM_PEM - Privacy Enhanced Mail format
169  */
170 define('PARAM_PEM',      'pem');
172 /**
173  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
174  */
175 define('PARAM_PERMISSION',   'permission');
177 /**
178  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way
179  */
180 define('PARAM_RAW', 'raw');
182 /**
183  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
184  */
185 define('PARAM_SAFEDIR',  'safedir');
187 /**
188  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
189  */
190 define('PARAM_SAFEPATH',  'safepath');
192 /**
193  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
194  */
195 define('PARAM_SEQUENCE',  'sequence');
197 /**
198  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
199  */
200 define('PARAM_TAG',   'tag');
202 /**
203  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
204  */
205 define('PARAM_TAGLIST',   'taglist');
207 /**
208  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
209  */
210 define('PARAM_TEXT',  'text');
212 /**
213  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
214  */
215 define('PARAM_THEME',  'theme');
217 /**
218  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not acceppted but http://localhost.localdomain/ is ok.
219  */
220 define('PARAM_URL',      'url');
224 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
225 /**
226  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
227  * It was one of the first types, that is why it is abused so much ;-)
228  */
229 define('PARAM_CLEAN',    'clean');
231 /**
232  * PARAM_INTEGER - deprecated alias for PARAM_INT
233  */
234 define('PARAM_INTEGER',  'int');
236 /**
237  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
238  */
239 define('PARAM_NUMBER',  'float');
241 /**
242  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in formas and urls
243  * NOTE: originally alias for PARAM_APLHA
244  */
245 define('PARAM_ACTION',   'alphanumext');
247 /**
248  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
249  * NOTE: originally alias for PARAM_APLHA
250  */
251 define('PARAM_FORMAT',   'alphanumext');
253 /**
254  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
255  */
256 define('PARAM_MULTILANG',  'text');
258 /**
259  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
260  */
261 define('PARAM_CLEANFILE', 'file');
266 /// Page types ///
267 /**
268  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
269  */
270 define('PAGE_COURSE_VIEW', 'course-view');
272 /** Get remote addr constant */
273 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
274 /** Get remote addr constant */
275 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
277 /// Blog access level constant declaration ///
278 define ('BLOG_USER_LEVEL', 1);
279 define ('BLOG_GROUP_LEVEL', 2);
280 define ('BLOG_COURSE_LEVEL', 3);
281 define ('BLOG_SITE_LEVEL', 4);
282 define ('BLOG_GLOBAL_LEVEL', 5);
285 ///Tag constants///
286 /**
287  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
288  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
289  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
290  *
291  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
292  */
293 define('TAG_MAX_LENGTH', 50);
295 /// Password policy constants ///
296 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
297 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
298 define ('PASSWORD_DIGITS', '0123456789');
299 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
301 /// Feature constants ///
302 // Used for plugin_supports() to report features that are, or are not, supported by a module.
304 /** True if module can provide a grade */
305 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
306 /** True if module supports outcomes */
307 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
309 /** True if module has code to track whether somebody viewed it */
310 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
311 /** True if module has custom completion rules */
312 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
314 /** True if module supports outcomes */
315 define('FEATURE_IDNUMBER', 'idnumber');
316 /** True if module supports groups */
317 define('FEATURE_GROUPS', 'groups');
318 /** True if module supports groupings */
319 define('FEATURE_GROUPINGS', 'groupings');
320 /** True if module supports groupmembersonly */
321 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
323 /** Type of module */
324 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
325 /** True if module supports intro editor */
326 define('FEATURE_MOD_INTRO', 'mod_intro');
327 /** True if module supports subplugins */
328 define('FEATURE_MOD_SUBPLUGINS', 'mod_subplugins');
329 /** True if module has default completion */
330 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
332 define('FEATURE_COMMENT', 'comment');
334 /** Unspecified module archetype */
335 define('MOD_ARCHETYPE_OTHER', 0);
336 /** Resource-like type module */
337 define('MOD_ARCHETYPE_RESOURCE', 1);
338 /** Assignemnt module archetype */
339 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
342 /// PARAMETER HANDLING ////////////////////////////////////////////////////
344 /**
345  * Returns a particular value for the named variable, taken from
346  * POST or GET.  If the parameter doesn't exist then an error is
347  * thrown because we require this variable.
348  *
349  * This function should be used to initialise all required values
350  * in a script that are based on parameters.  Usually it will be
351  * used like this:
352  *    $id = required_param('id', PARAM_INT);
353  *
354  * @param string $parname the name of the page parameter we want,
355  *                        default PARAM_CLEAN
356  * @param int $type expected type of parameter
357  * @return mixed
358  */
359 function required_param($parname, $type=PARAM_CLEAN) {
360     if (isset($_POST[$parname])) {       // POST has precedence
361         $param = $_POST[$parname];
362     } else if (isset($_GET[$parname])) {
363         $param = $_GET[$parname];
364     } else {
365         print_error('missingparam', '', '', $parname);
366     }
368     return clean_param($param, $type);
371 /**
372  * Returns a particular value for the named variable, taken from
373  * POST or GET, otherwise returning a given default.
374  *
375  * This function should be used to initialise all optional values
376  * in a script that are based on parameters.  Usually it will be
377  * used like this:
378  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
379  *
380  * @param string $parname the name of the page parameter we want
381  * @param mixed  $default the default value to return if nothing is found
382  * @param int $type expected type of parameter, default PARAM_CLEAN
383  * @return mixed
384  */
385 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
386     if (isset($_POST[$parname])) {       // POST has precedence
387         $param = $_POST[$parname];
388     } else if (isset($_GET[$parname])) {
389         $param = $_GET[$parname];
390     } else {
391         return $default;
392     }
394     return clean_param($param, $type);
397 /**
398  * Strict validation of parameter values, the values are only converted
399  * to requested PHP type. Internally it is using clean_param, the values
400  * before and after cleaning must be equal - otherwise
401  * an invalid_parameter_exception is thrown.
402  * Onjects and classes are not accepted.
403  *
404  * @param mixed $param
405  * @param int $type PARAM_ constant
406  * @param bool $allownull are nulls valid value?
407  * @param string $debuginfo optional debug information
408  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
409  */
410 function validate_param($param, $type, $allownull=false, $debuginfo='') {
411     if (is_null($param)) {
412         if ($allownull) {
413             return null;
414         } else {
415             throw new invalid_parameter_exception($debuginfo);
416         }
417     }
418     if (is_array($param) or is_object($param)) {
419         throw new invalid_parameter_exception($debuginfo);
420     }
422     $cleaned = clean_param($param, $type);
423     if ((string)$param !== (string)$cleaned) {
424         // conversion to string is usually lossless
425         throw new invalid_parameter_exception($debuginfo);
426     }
428     return $cleaned;
431 /**
432  * Used by {@link optional_param()} and {@link required_param()} to
433  * clean the variables and/or cast to specific types, based on
434  * an options field.
435  * <code>
436  * $course->format = clean_param($course->format, PARAM_ALPHA);
437  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
438  * </code>
439  *
440  * @global object
441  * @uses PARAM_RAW
442  * @uses PARAM_CLEAN
443  * @uses PARAM_CLEANHTML
444  * @uses PARAM_INT
445  * @uses PARAM_FLOAT
446  * @uses PARAM_NUMBER
447  * @uses PARAM_ALPHA
448  * @uses PARAM_ALPHAEXT
449  * @uses PARAM_ALPHANUM
450  * @uses PARAM_ALPHANUMEXT
451  * @uses PARAM_SEQUENCE
452  * @uses PARAM_BOOL
453  * @uses PARAM_NOTAGS
454  * @uses PARAM_TEXT
455  * @uses PARAM_SAFEDIR
456  * @uses PARAM_SAFEPATH
457  * @uses PARAM_FILE
458  * @uses PARAM_PATH
459  * @uses PARAM_HOST
460  * @uses PARAM_URL
461  * @uses PARAM_LOCALURL
462  * @uses PARAM_PEM
463  * @uses PARAM_BASE64
464  * @uses PARAM_TAG
465  * @uses PARAM_SEQUENCE
466  * @param mixed $param the variable we are cleaning
467  * @param int $type expected format of param after cleaning.
468  * @return mixed
469  */
470 function clean_param($param, $type) {
472     global $CFG;
474     if (is_array($param)) {              // Let's loop
475         $newparam = array();
476         foreach ($param as $key => $value) {
477             $newparam[$key] = clean_param($value, $type);
478         }
479         return $newparam;
480     }
482     switch ($type) {
483         case PARAM_RAW:          // no cleaning at all
484             return $param;
486         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
487             if (is_numeric($param)) {
488                 return $param;
489             }
490             return clean_text($param);     // Sweep for scripts, etc
492         case PARAM_CLEANHTML:    // prepare html fragment for display, do not store it into db!!
493             $param = clean_text($param);     // Sweep for scripts, etc
494             return trim($param);
496         case PARAM_INT:
497             return (int)$param;  // Convert to integer
499         case PARAM_FLOAT:
500         case PARAM_NUMBER:
501             return (float)$param;  // Convert to float
503         case PARAM_ALPHA:        // Remove everything not a-z
504             return preg_replace('/[^a-zA-Z]/i', '', $param);
506         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
507             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
509         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
510             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
512         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
513             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
515         case PARAM_SEQUENCE:     // Remove everything not 0-9,
516             return preg_replace('/[^0-9,]/i', '', $param);
518         case PARAM_BOOL:         // Convert to 1 or 0
519             $tempstr = strtolower($param);
520             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
521                 $param = 1;
522             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
523                 $param = 0;
524             } else {
525                 $param = empty($param) ? 0 : 1;
526             }
527             return $param;
529         case PARAM_NOTAGS:       // Strip all tags
530             return strip_tags($param);
532         case PARAM_TEXT:    // leave only tags needed for multilang
533             return clean_param(strip_tags($param, '<lang><span>'), PARAM_CLEAN);
535         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
536             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
538         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
539             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
541         case PARAM_FILE:         // Strip all suspicious characters from filename
542             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\/]~u', '', $param);
543             $param = preg_replace('~\.\.+~', '', $param);
544             if ($param === '.') {
545                 $param = '';
546             }
547             return $param;
549         case PARAM_PATH:         // Strip all suspicious characters from file path
550             $param = str_replace('\\', '/', $param);
551             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
552             $param = preg_replace('~\.\.+~', '', $param);
553             $param = preg_replace('~//+~', '/', $param);
554             return preg_replace('~/(\./)+~', '/', $param);
556         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
557             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
558             // match ipv4 dotted quad
559             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
560                 // confirm values are ok
561                 if ( $match[0] > 255
562                      || $match[1] > 255
563                      || $match[3] > 255
564                      || $match[4] > 255 ) {
565                     // hmmm, what kind of dotted quad is this?
566                     $param = '';
567                 }
568             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
569                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
570                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
571                        ) {
572                 // all is ok - $param is respected
573             } else {
574                 // all is not ok...
575                 $param='';
576             }
577             return $param;
579         case PARAM_URL:          // allow safe ftp, http, mailto urls
580             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
581             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
582                 // all is ok, param is respected
583             } else {
584                 $param =''; // not really ok
585             }
586             return $param;
588         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
589             $param = clean_param($param, PARAM_URL);
590             if (!empty($param)) {
591                 if (preg_match(':^/:', $param)) {
592                     // root-relative, ok!
593                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
594                     // absolute, and matches our wwwroot
595                 } else {
596                     // relative - let's make sure there are no tricks
597                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
598                         // looks ok.
599                     } else {
600                         $param = '';
601                     }
602                 }
603             }
604             return $param;
606         case PARAM_PEM:
607             $param = trim($param);
608             // PEM formatted strings may contain letters/numbers and the symbols
609             // forward slash: /
610             // plus sign:     +
611             // equal sign:    =
612             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
613             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
614                 list($wholething, $body) = $matches;
615                 unset($wholething, $matches);
616                 $b64 = clean_param($body, PARAM_BASE64);
617                 if (!empty($b64)) {
618                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
619                 } else {
620                     return '';
621                 }
622             }
623             return '';
625         case PARAM_BASE64:
626             if (!empty($param)) {
627                 // PEM formatted strings may contain letters/numbers and the symbols
628                 // forward slash: /
629                 // plus sign:     +
630                 // equal sign:    =
631                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
632                     return '';
633                 }
634                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
635                 // Each line of base64 encoded data must be 64 characters in
636                 // length, except for the last line which may be less than (or
637                 // equal to) 64 characters long.
638                 for ($i=0, $j=count($lines); $i < $j; $i++) {
639                     if ($i + 1 == $j) {
640                         if (64 < strlen($lines[$i])) {
641                             return '';
642                         }
643                         continue;
644                     }
646                     if (64 != strlen($lines[$i])) {
647                         return '';
648                     }
649                 }
650                 return implode("\n",$lines);
651             } else {
652                 return '';
653             }
655         case PARAM_TAG:
656             //as long as magic_quotes_gpc is used, a backslash will be a
657             //problem, so remove *all* backslash.
658             //$param = str_replace('\\', '', $param);
659             //remove some nasties
660             $param = preg_replace('~[[:cntrl:]]|[<>`]~', '', $param);
661             //convert many whitespace chars into one
662             $param = preg_replace('/\s+/', ' ', $param);
663             $textlib = textlib_get_instance();
664             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
665             return $param;
668         case PARAM_TAGLIST:
669             $tags = explode(',', $param);
670             $result = array();
671             foreach ($tags as $tag) {
672                 $res = clean_param($tag, PARAM_TAG);
673                 if ($res !== '') {
674                     $result[] = $res;
675                 }
676             }
677             if ($result) {
678                 return implode(',', $result);
679             } else {
680                 return '';
681             }
683         case PARAM_CAPABILITY:
684             if (is_valid_capability($param)) {
685                 return $param;
686             } else {
687                 return '';
688             }
690         case PARAM_PERMISSION:
691             $param = (int)$param;
692             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
693                 return $param;
694             } else {
695                 return CAP_INHERIT;
696             }
698         case PARAM_AUTH:
699             $param = clean_param($param, PARAM_SAFEDIR);
700             if (exists_auth_plugin($param)) {
701                 return $param;
702             } else {
703                 return '';
704             }
706         case PARAM_LANG:
707             $param = clean_param($param, PARAM_SAFEDIR);
708             $langs = get_list_of_languages(false, true);
709             if (in_array($param, $langs)) {
710                 return $param;
711             } else {
712                 return '';  // Specified language is not installed
713             }
715         case PARAM_THEME:
716             $param = clean_param($param, PARAM_SAFEDIR);
717             if (file_exists($CFG->dirroot.'/theme/'.$param)) {
718                 return $param;
719             } else {
720                 return '';  // Specified theme is not installed
721             }
723         default:                 // throw error, switched parameters in optional_param or another serious problem
724             print_error("unknownparamtype", '', '', $type);
725     }
728 /**
729  * Return true if given value is integer or string with integer value
730  *
731  * @param mixed $value String or Int
732  * @return bool true if number, false if not
733  */
734 function is_number($value) {
735     if (is_int($value)) {
736         return true;
737     } else if (is_string($value)) {
738         return ((string)(int)$value) === $value;
739     } else {
740         return false;
741     }
744 /**
745  * Returns host part from url
746  * @param string $url full url
747  * @return string host, null if not found
748  */
749 function get_host_from_url($url) {
750     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
751     if ($matches) {
752         return $matches[1];
753     }
754     return null;
757 /**
758  * Tests whether anything was returned by text editor
759  *
760  * This function is useful for testing whether something you got back from
761  * the HTML editor actually contains anything. Sometimes the HTML editor
762  * appear to be empty, but actually you get back a <br> tag or something.
763  *
764  * @param string $string a string containing HTML.
765  * @return boolean does the string contain any actual content - that is text,
766  * images, objcts, etc.
767  */
768 function html_is_blank($string) {
769     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
772 /**
773  * Set a key in global configuration
774  *
775  * Set a key/value pair in both this session's {@link $CFG} global variable
776  * and in the 'config' database table for future sessions.
777  *
778  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
779  * In that case it doesn't affect $CFG.
780  *
781  * A NULL value will delete the entry.
782  *
783  * @global object
784  * @global object
785  * @param string $name the key to set
786  * @param string $value the value to set (without magic quotes)
787  * @param string $plugin (optional) the plugin scope, default NULL
788  * @return bool true or exception
789  */
790 function set_config($name, $value, $plugin=NULL) {
791     global $CFG, $DB;
793     if (empty($plugin)) {
794         if (!array_key_exists($name, $CFG->config_php_settings)) {
795             // So it's defined for this invocation at least
796             if (is_null($value)) {
797                 unset($CFG->$name);
798             } else {
799                 $CFG->$name = (string)$value; // settings from db are always strings
800             }
801         }
803         if ($DB->get_field('config', 'name', array('name'=>$name))) {
804             if ($value === null) {
805                 $DB->delete_records('config', array('name'=>$name));
806             } else {
807                 $DB->set_field('config', 'value', $value, array('name'=>$name));
808             }
809         } else {
810             if ($value !== null) {
811                 $config = new object();
812                 $config->name  = $name;
813                 $config->value = $value;
814                 $DB->insert_record('config', $config, false);
815             }
816         }
818     } else { // plugin scope
819         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
820             if ($value===null) {
821                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
822             } else {
823                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
824             }
825         } else {
826             if ($value !== null) {
827                 $config = new object();
828                 $config->plugin = $plugin;
829                 $config->name   = $name;
830                 $config->value  = $value;
831                 $DB->insert_record('config_plugins', $config, false);
832             }
833         }
834     }
836     return true;
839 /**
840  * Get configuration values from the global config table
841  * or the config_plugins table.
842  *
843  * If called with no parameters it will do the right thing
844  * generating $CFG safely from the database without overwriting
845  * existing values.
846  *
847  * If called with one parameter, it will load all the config
848  * variables for one pugin, and return them as an object.
849  *
850  * If called with 2 parameters it will return a $string single
851  * value or false of the value is not found.
852  *
853  * @global object
854  * @param string $plugin default NULL
855  * @param string $name default NULL
856  * @return mixed hash-like object or single value
857  */
858 function get_config($plugin=NULL, $name=NULL) {
859     global $CFG, $DB;
861     if (!empty($name)) { // the user is asking for a specific value
862         if (!empty($plugin)) {
863             return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
864         } else {
865             return $DB->get_field('config', 'value', array('name'=>$name));
866         }
867     }
869     // the user is after a recordset
870     if (!empty($plugin)) {
871         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
872         if (!empty($localcfg)) {
873             return (object)$localcfg;
874         } else {
875             return false;
876         }
877     } else {
878         // this was originally in setup.php
879         if ($configs = $DB->get_records('config')) {
880             $localcfg = (array)$CFG;
881             foreach ($configs as $config) {
882                 if (!isset($localcfg[$config->name])) {
883                     $localcfg[$config->name] = $config->value;
884                 }
885                 // do not complain anymore if config.php overrides settings from db
886             }
888             $localcfg = (object)$localcfg;
889             return $localcfg;
890         } else {
891             // preserve $CFG if DB returns nothing or error
892             return $CFG;
893         }
895     }
898 /**
899  * Removes a key from global configuration
900  *
901  * @param string $name the key to set
902  * @param string $plugin (optional) the plugin scope
903  * @global object
904  * @return boolean whether the operation succeeded.
905  */
906 function unset_config($name, $plugin=NULL) {
907     global $CFG, $DB;
909     if (empty($plugin)) {
910         unset($CFG->$name);
911         $DB->delete_records('config', array('name'=>$name));
912     } else {
913         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
914     }
916     return true;
919 /**
920  * Remove all the config variables for a given plugin.
921  *
922  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
923  * @return boolean whether the operation succeeded.
924  */
925 function unset_all_config_for_plugin($plugin) {
926     global $DB;
927     $DB->delete_records('config_plugins', array('plugin' => $plugin));
928     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
929     return true;
932 /**
933  * Use this funciton to get a list of users from a config setting of type admin_setting_users_with_capability.
934  * @param string $value the value of the config setting.
935  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
936  * @return array of user objects.
937  */
938 function get_users_from_config($value, $capability) {
939     global $CFG;
940     if ($value == '$@ALL@$') {
941         $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
942     } else {
943         list($where, $params) = $DB->get_in_or_equal(explode(',', $CFG->courserequestnotify));
944         $params[] = $CFG->mnet_localhost_id;
945         $users = $DB->get_records_select('user', 'username ' . $where . ' AND mnethostid = ?', $params);
946     }
947     return $users;
950 /**
951  * Get volatile flags
952  *
953  * @param string $type
954  * @param int    $changedsince default null
955  * @return records array
956  */
957 function get_cache_flags($type, $changedsince=NULL) {
958     global $DB;
960     $params = array('type'=>$type, 'expiry'=>time());
961     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
962     if ($changedsince !== NULL) {
963         $params['changedsince'] = $changedsince;
964         $sqlwhere .= " AND timemodified > :changedsince";
965     }
966     $cf = array();
968     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
969         foreach ($flags as $flag) {
970             $cf[$flag->name] = $flag->value;
971         }
972     }
973     return $cf;
976 /**
977  * Get volatile flags
978  *
979  * @param string $type
980  * @param string $name
981  * @param int    $changedsince default null
982  * @return records array
983  */
984 function get_cache_flag($type, $name, $changedsince=NULL) {
985     global $DB;
987     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
989     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
990     if ($changedsince !== NULL) {
991         $params['changedsince'] = $changedsince;
992         $sqlwhere .= " AND timemodified > :changedsince";
993     }
995     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
998 /**
999  * Set a volatile flag
1000  *
1001  * @param string $type the "type" namespace for the key
1002  * @param string $name the key to set
1003  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1004  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1005  * @return bool Always returns true
1006  */
1007 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1008     global $DB;
1010     $timemodified = time();
1011     if ($expiry===NULL || $expiry < $timemodified) {
1012         $expiry = $timemodified + 24 * 60 * 60;
1013     } else {
1014         $expiry = (int)$expiry;
1015     }
1017     if ($value === NULL) {
1018         unset_cache_flag($type,$name);
1019         return true;
1020     }
1022     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potentail problem in DEBUG_DEVELOPER
1023         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1024             return true; //no need to update; helps rcache too
1025         }
1026         $f->value        = $value;
1027         $f->expiry       = $expiry;
1028         $f->timemodified = $timemodified;
1029         $DB->update_record('cache_flags', $f);
1030     } else {
1031         $f = new object();
1032         $f->flagtype     = $type;
1033         $f->name         = $name;
1034         $f->value        = $value;
1035         $f->expiry       = $expiry;
1036         $f->timemodified = $timemodified;
1037         $DB->insert_record('cache_flags', $f);
1038     }
1039     return true;
1042 /**
1043  * Removes a single volatile flag
1044  *
1045  * @global object
1046  * @param string $type the "type" namespace for the key
1047  * @param string $name the key to set
1048  * @return bool
1049  */
1050 function unset_cache_flag($type, $name) {
1051     global $DB;
1052     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1053     return true;
1056 /**
1057  * Garbage-collect volatile flags
1058  *
1059  * @return bool Always returns true
1060  */
1061 function gc_cache_flags() {
1062     global $DB;
1063     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1064     return true;
1067 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1069 /**
1070  * Refresh current $USER session global variable with all their current preferences.
1071  *
1072  * @global object
1073  * @param mixed $time default null
1074  * @return void
1075  */
1076 function check_user_preferences_loaded($time = null) {
1077     global $USER, $DB;
1078     static $timenow = null; // Static cache, so we only check up-to-dateness once per request.
1080     if (!empty($USER->preference) && isset($USER->preference['_lastloaded'])) {
1081         // Already loaded. Are we up to date?
1083         if (is_null($timenow) || (!is_null($time) && $time != $timenow)) {
1084             $timenow = time();
1085             if (!get_cache_flag('userpreferenceschanged', $USER->id, $USER->preference['_lastloaded'])) {
1086                 // We are up-to-date.
1087                 return;
1088             }
1089         } else {
1090             // Already checked for up-to-date-ness.
1091             return;
1092         }
1093     }
1095     // OK, so we have to reload. Reset preference
1096     $USER->preference = array();
1098     if (!isloggedin() or isguestuser()) {
1099         // No permanent storage for not-logged-in user and guest
1101     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
1102         foreach ($preferences as $preference) {
1103             $USER->preference[$preference->name] = $preference->value;
1104         }
1105     }
1107     $USER->preference['_lastloaded'] = $timenow;
1110 /**
1111  * Called from set/delete_user_preferences, so that the prefs can be correctly reloaded.
1112  *
1113  * @global object
1114  * @global object
1115  * @param integer $userid the user whose prefs were changed.
1116  */
1117 function mark_user_preferences_changed($userid) {
1118     global $CFG, $USER;
1119     if ($userid == $USER->id) {
1120         check_user_preferences_loaded(time());
1121     }
1122     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1125 /**
1126  * Sets a preference for the current user
1127  *
1128  * Optionally, can set a preference for a different user object
1129  *
1130  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
1131  *
1132  * @global object
1133  * @global object
1134  * @param string $name The key to set as preference for the specified user
1135  * @param string $value The value to set forthe $name key in the specified user's record
1136  * @param int $otheruserid A moodle user ID, default null
1137  * @return bool
1138  */
1139 function set_user_preference($name, $value, $otheruserid=NULL) {
1140     global $USER, $DB;
1142     if (empty($name)) {
1143         return false;
1144     }
1146     $nostore = false;
1147     if (empty($otheruserid)){
1148         if (!isloggedin() or isguestuser()) {
1149             $nostore = true;
1150         }
1151         $userid = $USER->id;
1152     } else {
1153         if (isguestuser($otheruserid)) {
1154             $nostore = true;
1155         }
1156         $userid = $otheruserid;
1157     }
1159     if ($nostore) {
1160         // no permanent storage for not-logged-in user and guest
1162     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
1163         if ($preference->value === $value) {
1164             return true;
1165         }
1166         $DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id));
1168     } else {
1169         $preference = new object();
1170         $preference->userid = $userid;
1171         $preference->name   = $name;
1172         $preference->value  = (string)$value;
1173         $DB->insert_record('user_preferences', $preference);
1174     }
1176     mark_user_preferences_changed($userid);
1177     // update value in USER session if needed
1178     if ($userid == $USER->id) {
1179         $USER->preference[$name] = (string)$value;
1180         $USER->preference['_lastloaded'] = time();
1181     }
1183     return true;
1186 /**
1187  * Sets a whole array of preferences for the current user
1188  *
1189  * @param array $prefarray An array of key/value pairs to be set
1190  * @param int $otheruserid A moodle user ID
1191  * @return bool
1192  */
1193 function set_user_preferences($prefarray, $otheruserid=NULL) {
1195     if (!is_array($prefarray) or empty($prefarray)) {
1196         return false;
1197     }
1199     foreach ($prefarray as $name => $value) {
1200         set_user_preference($name, $value, $otheruserid);
1201     }
1202     return true;
1205 /**
1206  * Unsets a preference completely by deleting it from the database
1207  *
1208  * Optionally, can set a preference for a different user id
1209  *
1210  * @global object
1211  * @param string  $name The key to unset as preference for the specified user
1212  * @param int $otheruserid A moodle user ID
1213  */
1214 function unset_user_preference($name, $otheruserid=NULL) {
1215     global $USER, $DB;
1217     if (empty($otheruserid)){
1218         $userid = $USER->id;
1219         check_user_preferences_loaded();
1220     } else {
1221         $userid = $otheruserid;
1222     }
1224     //Then from DB
1225     $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
1227     mark_user_preferences_changed($userid);
1228     //Delete the preference from $USER if needed
1229     if ($userid == $USER->id) {
1230         unset($USER->preference[$name]);
1231         $USER->preference['_lastloaded'] = time();
1232     }
1234     return true;
1237 /**
1238  * Used to fetch user preference(s)
1239  *
1240  * If no arguments are supplied this function will return
1241  * all of the current user preferences as an array.
1242  *
1243  * If a name is specified then this function
1244  * attempts to return that particular preference value.  If
1245  * none is found, then the optional value $default is returned,
1246  * otherwise NULL.
1247  *
1248  * @global object
1249  * @global object
1250  * @param string $name Name of the key to use in finding a preference value
1251  * @param string $default Value to be returned if the $name key is not set in the user preferences
1252  * @param int $otheruserid A moodle user ID
1253  * @return string
1254  */
1255 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1256     global $USER, $DB;
1258     if (empty($otheruserid) || (!empty($USER->id) && ($USER->id == $otheruserid))){
1259         check_user_preferences_loaded();
1261         if (empty($name)) {
1262             return $USER->preference; // All values
1263         } else if (array_key_exists($name, $USER->preference)) {
1264             return $USER->preference[$name]; // The single value
1265         } else {
1266             return $default; // Default value (or NULL)
1267         }
1269     } else {
1270         if (empty($name)) {
1271             return $DB->get_records_menu('user_preferences', array('userid'=>$otheruserid), '', 'name,value'); // All values
1272         } else if ($value = $DB->get_field('user_preferences', 'value', array('userid'=>$otheruserid, 'name'=>$name))) {
1273             return $value; // The single value
1274         } else {
1275             return $default; // Default value (or NULL)
1276         }
1277     }
1280 /**
1281  * You need to call this function if you wish to use the set_user_preference
1282  * method in javascript_static.php, to white-list the preference you want to update
1283  * from JavaScript, and to specify the type of cleaning you expect to be done on
1284  * values.
1285  *
1286  * @global object
1287  * @param string $name the name of the user_perference we should allow to be
1288  *      updated by remote calls.
1289  * @param integer $paramtype one of the PARAM_{TYPE} constants, user to clean
1290  *      submitted values before set_user_preference is called.
1291  */
1292 function user_preference_allow_ajax_update($name, $paramtype) {
1293     global $USER, $PAGE;
1295     // Make sure that the required JavaScript libraries are loaded.
1296     $PAGE->requires->yui_lib('connection');
1298     // Record in the session that this user_preference is allowed to updated remotely.
1299     $USER->ajax_updatable_user_prefs[$name] = $paramtype;
1302 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1304 /**
1305  * Given date parts in user time produce a GMT timestamp.
1306  *
1307  * @todo Finish documenting this function
1308  * @param int $year The year part to create timestamp of
1309  * @param int $month The month part to create timestamp of
1310  * @param int $day The day part to create timestamp of
1311  * @param int $hour The hour part to create timestamp of
1312  * @param int $minute The minute part to create timestamp of
1313  * @param int $second The second part to create timestamp of
1314  * @param float $timezone Timezone modifier
1315  * @param bool $applydst Toggle Daylight Saving Time, default true
1316  * @return int timestamp
1317  */
1318 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1320     $strtimezone = NULL;
1321     if (!is_numeric($timezone)) {
1322         $strtimezone = $timezone;
1323     }
1325     $timezone = get_user_timezone_offset($timezone);
1327     if (abs($timezone) > 13) {
1328         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1329     } else {
1330         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1331         $time = usertime($time, $timezone);
1332         if($applydst) {
1333             $time -= dst_offset_on($time, $strtimezone);
1334         }
1335     }
1337     return $time;
1341 /**
1342  * Format a date/time (seconds) as weeks, days, hours etc as needed
1343  *
1344  * Given an amount of time in seconds, returns string
1345  * formatted nicely as weeks, days, hours etc as needed
1346  *
1347  * @uses MINSECS
1348  * @uses HOURSECS
1349  * @uses DAYSECS
1350  * @uses YEARSECS
1351  * @param int $totalsecs Time in seconds
1352  * @param object $str Should be a time object
1353  * @return string A nicely formatted date/time string
1354  */
1355  function format_time($totalsecs, $str=NULL) {
1357     $totalsecs = abs($totalsecs);
1359     if (!$str) {  // Create the str structure the slow way
1360         $str->day   = get_string('day');
1361         $str->days  = get_string('days');
1362         $str->hour  = get_string('hour');
1363         $str->hours = get_string('hours');
1364         $str->min   = get_string('min');
1365         $str->mins  = get_string('mins');
1366         $str->sec   = get_string('sec');
1367         $str->secs  = get_string('secs');
1368         $str->year  = get_string('year');
1369         $str->years = get_string('years');
1370     }
1373     $years     = floor($totalsecs/YEARSECS);
1374     $remainder = $totalsecs - ($years*YEARSECS);
1375     $days      = floor($remainder/DAYSECS);
1376     $remainder = $totalsecs - ($days*DAYSECS);
1377     $hours     = floor($remainder/HOURSECS);
1378     $remainder = $remainder - ($hours*HOURSECS);
1379     $mins      = floor($remainder/MINSECS);
1380     $secs      = $remainder - ($mins*MINSECS);
1382     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1383     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1384     $sh = ($hours == 1) ? $str->hour : $str->hours;
1385     $sd = ($days == 1)  ? $str->day  : $str->days;
1386     $sy = ($years == 1)  ? $str->year  : $str->years;
1388     $oyears = '';
1389     $odays = '';
1390     $ohours = '';
1391     $omins = '';
1392     $osecs = '';
1394     if ($years)  $oyears  = $years .' '. $sy;
1395     if ($days)  $odays  = $days .' '. $sd;
1396     if ($hours) $ohours = $hours .' '. $sh;
1397     if ($mins)  $omins  = $mins .' '. $sm;
1398     if ($secs)  $osecs  = $secs .' '. $ss;
1400     if ($years) return trim($oyears .' '. $odays);
1401     if ($days)  return trim($odays .' '. $ohours);
1402     if ($hours) return trim($ohours .' '. $omins);
1403     if ($mins)  return trim($omins .' '. $osecs);
1404     if ($secs)  return $osecs;
1405     return get_string('now');
1408 /**
1409  * Returns a formatted string that represents a date in user time
1410  *
1411  * Returns a formatted string that represents a date in user time
1412  * <b>WARNING: note that the format is for strftime(), not date().</b>
1413  * Because of a bug in most Windows time libraries, we can't use
1414  * the nicer %e, so we have to use %d which has leading zeroes.
1415  * A lot of the fuss in the function is just getting rid of these leading
1416  * zeroes as efficiently as possible.
1417  *
1418  * If parameter fixday = true (default), then take off leading
1419  * zero from %d, else mantain it.
1420  *
1421  * @param int $date the timestamp in UTC, as obtained from the database.
1422  * @param string $format strftime format. You should probably get this using
1423  *      get_string('strftime...', 'langconfig');
1424  * @param float $timezone by default, uses the user's time zone.
1425  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1426  *      If false then the leading zero is mantained.
1427  * @return string the formatted date/time.
1428  */
1429 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1431     global $CFG;
1433     $strtimezone = NULL;
1434     if (!is_numeric($timezone)) {
1435         $strtimezone = $timezone;
1436     }
1438     if (empty($format)) {
1439         $format = get_string('strftimedaydatetime', 'langconfig');
1440     }
1442     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1443         $fixday = false;
1444     } else if ($fixday) {
1445         $formatnoday = str_replace('%d', 'DD', $format);
1446         $fixday = ($formatnoday != $format);
1447     }
1449     $date += dst_offset_on($date, $strtimezone);
1451     $timezone = get_user_timezone_offset($timezone);
1453     if (abs($timezone) > 13) {   /// Server time
1454         if ($fixday) {
1455             $datestring = strftime($formatnoday, $date);
1456             $daystring  = str_replace(array(' 0', ' '), '', strftime(' %d', $date));
1457             $datestring = str_replace('DD', $daystring, $datestring);
1458         } else {
1459             $datestring = strftime($format, $date);
1460         }
1461     } else {
1462         $date += (int)($timezone * 3600);
1463         if ($fixday) {
1464             $datestring = gmstrftime($formatnoday, $date);
1465             $daystring  = str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date));
1466             $datestring = str_replace('DD', $daystring, $datestring);
1467         } else {
1468             $datestring = gmstrftime($format, $date);
1469         }
1470     }
1472 /// If we are running under Windows convert from windows encoding to UTF-8
1473 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1475    if ($CFG->ostype == 'WINDOWS') {
1476        if ($localewincharset = get_string('localewincharset')) {
1477            $textlib = textlib_get_instance();
1478            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1479        }
1480    }
1482     return $datestring;
1485 /**
1486  * Given a $time timestamp in GMT (seconds since epoch),
1487  * returns an array that represents the date in user time
1488  *
1489  * @todo Finish documenting this function
1490  * @uses HOURSECS
1491  * @param int $time Timestamp in GMT
1492  * @param float $timezone ?
1493  * @return array An array that represents the date in user time
1494  */
1495 function usergetdate($time, $timezone=99) {
1497     $strtimezone = NULL;
1498     if (!is_numeric($timezone)) {
1499         $strtimezone = $timezone;
1500     }
1502     $timezone = get_user_timezone_offset($timezone);
1504     if (abs($timezone) > 13) {    // Server time
1505         return getdate($time);
1506     }
1508     // There is no gmgetdate so we use gmdate instead
1509     $time += dst_offset_on($time, $strtimezone);
1510     $time += intval((float)$timezone * HOURSECS);
1512     $datestring = gmstrftime('%S_%M_%H_%d_%m_%Y_%w_%j_%A_%B', $time);
1514     list(
1515         $getdate['seconds'],
1516         $getdate['minutes'],
1517         $getdate['hours'],
1518         $getdate['mday'],
1519         $getdate['mon'],
1520         $getdate['year'],
1521         $getdate['wday'],
1522         $getdate['yday'],
1523         $getdate['weekday'],
1524         $getdate['month']
1525     ) = explode('_', $datestring);
1527     return $getdate;
1530 /**
1531  * Given a GMT timestamp (seconds since epoch), offsets it by
1532  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1533  *
1534  * @uses HOURSECS
1535  * @param  int $date Timestamp in GMT
1536  * @param float $timezone
1537  * @return int
1538  */
1539 function usertime($date, $timezone=99) {
1541     $timezone = get_user_timezone_offset($timezone);
1543     if (abs($timezone) > 13) {
1544         return $date;
1545     }
1546     return $date - (int)($timezone * HOURSECS);
1549 /**
1550  * Given a time, return the GMT timestamp of the most recent midnight
1551  * for the current user.
1552  *
1553  * @param int $date Timestamp in GMT
1554  * @param float $timezone Defaults to user's timezone
1555  * @return int Returns a GMT timestamp
1556  */
1557 function usergetmidnight($date, $timezone=99) {
1559     $userdate = usergetdate($date, $timezone);
1561     // Time of midnight of this user's day, in GMT
1562     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1566 /**
1567  * Returns a string that prints the user's timezone
1568  *
1569  * @param float $timezone The user's timezone
1570  * @return string
1571  */
1572 function usertimezone($timezone=99) {
1574     $tz = get_user_timezone($timezone);
1576     if (!is_float($tz)) {
1577         return $tz;
1578     }
1580     if(abs($tz) > 13) { // Server time
1581         return get_string('serverlocaltime');
1582     }
1584     if($tz == intval($tz)) {
1585         // Don't show .0 for whole hours
1586         $tz = intval($tz);
1587     }
1589     if($tz == 0) {
1590         return 'UTC';
1591     }
1592     else if($tz > 0) {
1593         return 'UTC+'.$tz;
1594     }
1595     else {
1596         return 'UTC'.$tz;
1597     }
1601 /**
1602  * Returns a float which represents the user's timezone difference from GMT in hours
1603  * Checks various settings and picks the most dominant of those which have a value
1604  *
1605  * @global object
1606  * @global object
1607  * @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
1608  * @return float
1609  */
1610 function get_user_timezone_offset($tz = 99) {
1612     global $USER, $CFG;
1614     $tz = get_user_timezone($tz);
1616     if (is_float($tz)) {
1617         return $tz;
1618     } else {
1619         $tzrecord = get_timezone_record($tz);
1620         if (empty($tzrecord)) {
1621             return 99.0;
1622         }
1623         return (float)$tzrecord->gmtoff / HOURMINS;
1624     }
1627 /**
1628  * Returns an int which represents the systems's timezone difference from GMT in seconds
1629  *
1630  * @global object
1631  * @param mixed $tz timezone
1632  * @return int if found, false is timezone 99 or error
1633  */
1634 function get_timezone_offset($tz) {
1635     global $CFG;
1637     if ($tz == 99) {
1638         return false;
1639     }
1641     if (is_numeric($tz)) {
1642         return intval($tz * 60*60);
1643     }
1645     if (!$tzrecord = get_timezone_record($tz)) {
1646         return false;
1647     }
1648     return intval($tzrecord->gmtoff * 60);
1651 /**
1652  * Returns a float or a string which denotes the user's timezone
1653  * 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)
1654  * means that for this timezone there are also DST rules to be taken into account
1655  * Checks various settings and picks the most dominant of those which have a value
1656  *
1657  * @global object
1658  * @global object
1659  * @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
1660  * @return mixed
1661  */
1662 function get_user_timezone($tz = 99) {
1663     global $USER, $CFG;
1665     $timezones = array(
1666         $tz,
1667         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1668         isset($USER->timezone) ? $USER->timezone : 99,
1669         isset($CFG->timezone) ? $CFG->timezone : 99,
1670         );
1672     $tz = 99;
1674     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1675         $tz = $next['value'];
1676     }
1678     return is_numeric($tz) ? (float) $tz : $tz;
1681 /**
1682  * Returns cached timezone record for given $timezonename
1683  *
1684  * @global object
1685  * @global object
1686  * @param string $timezonename
1687  * @return mixed timezonerecord object or false
1688  */
1689 function get_timezone_record($timezonename) {
1690     global $CFG, $DB;
1691     static $cache = NULL;
1693     if ($cache === NULL) {
1694         $cache = array();
1695     }
1697     if (isset($cache[$timezonename])) {
1698         return $cache[$timezonename];
1699     }
1701     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1702                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1705 /**
1706  * Build and store the users Daylight Saving Time (DST) table
1707  *
1708  * @global object
1709  * @global object
1710  * @global object
1711  * @param mixed $from_year Start year for the table, defaults to 1971
1712  * @param mixed $to_year End year for the table, defaults to 2035
1713  * @param mixed $strtimezone
1714  * @return bool
1715  */
1716 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1717     global $CFG, $SESSION, $DB;
1719     $usertz = get_user_timezone($strtimezone);
1721     if (is_float($usertz)) {
1722         // Trivial timezone, no DST
1723         return false;
1724     }
1726     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1727         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1728         unset($SESSION->dst_offsets);
1729         unset($SESSION->dst_range);
1730     }
1732     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1733         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1734         // This will be the return path most of the time, pretty light computationally
1735         return true;
1736     }
1738     // Reaching here means we either need to extend our table or create it from scratch
1740     // Remember which TZ we calculated these changes for
1741     $SESSION->dst_offsettz = $usertz;
1743     if(empty($SESSION->dst_offsets)) {
1744         // If we 're creating from scratch, put the two guard elements in there
1745         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1746     }
1747     if(empty($SESSION->dst_range)) {
1748         // If creating from scratch
1749         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1750         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1752         // Fill in the array with the extra years we need to process
1753         $yearstoprocess = array();
1754         for($i = $from; $i <= $to; ++$i) {
1755             $yearstoprocess[] = $i;
1756         }
1758         // Take note of which years we have processed for future calls
1759         $SESSION->dst_range = array($from, $to);
1760     }
1761     else {
1762         // If needing to extend the table, do the same
1763         $yearstoprocess = array();
1765         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1766         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1768         if($from < $SESSION->dst_range[0]) {
1769             // Take note of which years we need to process and then note that we have processed them for future calls
1770             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1771                 $yearstoprocess[] = $i;
1772             }
1773             $SESSION->dst_range[0] = $from;
1774         }
1775         if($to > $SESSION->dst_range[1]) {
1776             // Take note of which years we need to process and then note that we have processed them for future calls
1777             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1778                 $yearstoprocess[] = $i;
1779             }
1780             $SESSION->dst_range[1] = $to;
1781         }
1782     }
1784     if(empty($yearstoprocess)) {
1785         // This means that there was a call requesting a SMALLER range than we have already calculated
1786         return true;
1787     }
1789     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1790     // Also, the array is sorted in descending timestamp order!
1792     // Get DB data
1794     static $presets_cache = array();
1795     if (!isset($presets_cache[$usertz])) {
1796         $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');
1797     }
1798     if(empty($presets_cache[$usertz])) {
1799         return false;
1800     }
1802     // Remove ending guard (first element of the array)
1803     reset($SESSION->dst_offsets);
1804     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1806     // Add all required change timestamps
1807     foreach($yearstoprocess as $y) {
1808         // Find the record which is in effect for the year $y
1809         foreach($presets_cache[$usertz] as $year => $preset) {
1810             if($year <= $y) {
1811                 break;
1812             }
1813         }
1815         $changes = dst_changes_for_year($y, $preset);
1817         if($changes === NULL) {
1818             continue;
1819         }
1820         if($changes['dst'] != 0) {
1821             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1822         }
1823         if($changes['std'] != 0) {
1824             $SESSION->dst_offsets[$changes['std']] = 0;
1825         }
1826     }
1828     // Put in a guard element at the top
1829     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1830     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1832     // Sort again
1833     krsort($SESSION->dst_offsets);
1835     return true;
1838 /**
1839  * Calculates the required DST change and returns a Timestamp Array
1840  *
1841  * @uses HOURSECS
1842  * @uses MINSECS
1843  * @param mixed $year Int or String Year to focus on
1844  * @param object $timezone Instatiated Timezone object
1845  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
1846  */
1847 function dst_changes_for_year($year, $timezone) {
1849     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1850         return NULL;
1851     }
1853     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1854     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1856     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1857     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1859     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1860     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1862     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1863     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1864     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1866     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1867     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1869     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1872 /**
1873  * Calculates the Daylight Saving Offest for a given date/time (timestamp)
1874  *
1875  * @global object
1876  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
1877  * @return int
1878  */
1879 function dst_offset_on($time, $strtimezone = NULL) {
1880     global $SESSION;
1882     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
1883         return 0;
1884     }
1886     reset($SESSION->dst_offsets);
1887     while(list($from, $offset) = each($SESSION->dst_offsets)) {
1888         if($from <= $time) {
1889             break;
1890         }
1891     }
1893     // This is the normal return path
1894     if($offset !== NULL) {
1895         return $offset;
1896     }
1898     // Reaching this point means we haven't calculated far enough, do it now:
1899     // Calculate extra DST changes if needed and recurse. The recursion always
1900     // moves toward the stopping condition, so will always end.
1902     if($from == 0) {
1903         // We need a year smaller than $SESSION->dst_range[0]
1904         if($SESSION->dst_range[0] == 1971) {
1905             return 0;
1906         }
1907         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
1908         return dst_offset_on($time, $strtimezone);
1909     }
1910     else {
1911         // We need a year larger than $SESSION->dst_range[1]
1912         if($SESSION->dst_range[1] == 2035) {
1913             return 0;
1914         }
1915         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
1916         return dst_offset_on($time, $strtimezone);
1917     }
1920 /**
1921  * ?
1922  *
1923  * @todo Document what this function does
1924  * @param int $startday
1925  * @param int $weekday
1926  * @param int $month
1927  * @param int $year
1928  * @return int
1929  */
1930 function find_day_in_month($startday, $weekday, $month, $year) {
1932     $daysinmonth = days_in_month($month, $year);
1934     if($weekday == -1) {
1935         // Don't care about weekday, so return:
1936         //    abs($startday) if $startday != -1
1937         //    $daysinmonth otherwise
1938         return ($startday == -1) ? $daysinmonth : abs($startday);
1939     }
1941     // From now on we 're looking for a specific weekday
1943     // Give "end of month" its actual value, since we know it
1944     if($startday == -1) {
1945         $startday = -1 * $daysinmonth;
1946     }
1948     // Starting from day $startday, the sign is the direction
1950     if($startday < 1) {
1952         $startday = abs($startday);
1953         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
1955         // This is the last such weekday of the month
1956         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
1957         if($lastinmonth > $daysinmonth) {
1958             $lastinmonth -= 7;
1959         }
1961         // Find the first such weekday <= $startday
1962         while($lastinmonth > $startday) {
1963             $lastinmonth -= 7;
1964         }
1966         return $lastinmonth;
1968     }
1969     else {
1971         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
1973         $diff = $weekday - $indexweekday;
1974         if($diff < 0) {
1975             $diff += 7;
1976         }
1978         // This is the first such weekday of the month equal to or after $startday
1979         $firstfromindex = $startday + $diff;
1981         return $firstfromindex;
1983     }
1986 /**
1987  * Calculate the number of days in a given month
1988  *
1989  * @param int $month The month whose day count is sought
1990  * @param int $year The year of the month whose day count is sought
1991  * @return int
1992  */
1993 function days_in_month($month, $year) {
1994    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
1997 /**
1998  * Calculate the position in the week of a specific calendar day
1999  *
2000  * @param int $day The day of the date whose position in the week is sought
2001  * @param int $month The month of the date whose position in the week is sought
2002  * @param int $year The year of the date whose position in the week is sought
2003  * @return int
2004  */
2005 function dayofweek($day, $month, $year) {
2006     // I wonder if this is any different from
2007     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2008     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
2011 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2013 /**
2014  * Returns full login url.
2015  *
2016  * @global object
2017  * @param bool $loginguest add login guest param, return false
2018  * @return string login url
2019  */
2020 function get_login_url($loginguest=false) {
2021     global $CFG;
2023     if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
2024         $loginguest = $loginguest ? '?loginguest=true' : '';
2025         $url = "$CFG->wwwroot/login/index.php$loginguest";
2027     } else {
2028         $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2029         $url = "$wwwroot/login/index.php";
2030     }
2032     return $url;
2035 /**
2036  * This function checks that the current user is logged in and has the
2037  * required privileges
2038  *
2039  * This function checks that the current user is logged in, and optionally
2040  * whether they are allowed to be in a particular course and view a particular
2041  * course module.
2042  * If they are not logged in, then it redirects them to the site login unless
2043  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2044  * case they are automatically logged in as guests.
2045  * If $courseid is given and the user is not enrolled in that course then the
2046  * user is redirected to the course enrolment page.
2047  * If $cm is given and the coursemodule is hidden and the user is not a teacher
2048  * in the course then the user is redirected to the course home page.
2049  *
2050  * @global object
2051  * @global object
2052  * @global object
2053  * @global object
2054  * @global string
2055  * @global object
2056  * @global object
2057  * @global object
2058  * @uses SITEID Define
2059  * @param mixed $courseorid id of the course or course object
2060  * @param bool $autologinguest default true
2061  * @param object $cm course module object
2062  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2063  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2064  *             in order to keep redirects working properly. MDL-14495
2065  * @return mixed Void, exit, and die depending on path
2066  */
2067 function require_login($courseorid=0, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2068     global $CFG, $SESSION, $USER, $COURSE, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2070 /// setup global $COURSE, themes, language and locale
2071     if (!empty($courseorid)) {
2072         if (is_object($courseorid)) {
2073             $course = $courseorid;
2074         } else if ($courseorid == SITEID) {
2075             $course = clone($SITE);
2076         } else {
2077             $course = $DB->get_record('course', array('id' => $courseorid));
2078             if (!$course) {
2079                 throw new moodle_exception('invalidcourseid');
2080             }
2081         }
2082         if ($cm) {
2083             $PAGE->set_cm($cm, $course);
2084         } else {
2085             $PAGE->set_course($course);
2086         }
2087     } else {
2088         // If $PAGE->course, and hence $PAGE->context, have not already been set
2089         // up properly, set them up now.
2090         $PAGE->set_course($PAGE->course);
2091     }
2093 /// If the user is not even logged in yet then make sure they are
2094     if (!isloggedin()) {
2095         //NOTE: $USER->site check was obsoleted by session test cookie,
2096         //      $USER->confirmed test is in login/index.php
2097         if ($setwantsurltome) {
2098             $SESSION->wantsurl = $FULLME;
2099         }
2100         if (!empty($_SERVER['HTTP_REFERER'])) {
2101             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2102         }
2103         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests) and ($COURSE->id == SITEID or $COURSE->guest) ) {
2104             $loginguest = true;
2105         } else {
2106             $loginguest = false;
2107         }
2108         redirect(get_login_url($loginguest));
2109         exit; // never reached
2110     }
2112 /// loginas as redirection if needed
2113     if ($COURSE->id != SITEID and session_is_loggedinas()) {
2114         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2115             if ($USER->loginascontext->instanceid != $COURSE->id) {
2116                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2117             }
2118         }
2119     }
2121 /// check whether the user should be changing password (but only if it is REALLY them)
2122     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2123         $userauth = get_auth_plugin($USER->auth);
2124         if ($userauth->can_change_password()) {
2125             $SESSION->wantsurl = $FULLME;
2126             if ($changeurl = $userauth->change_password_url()) {
2127                 //use plugin custom url
2128                 redirect($changeurl);
2129             } else {
2130                 //use moodle internal method
2131                 if (empty($CFG->loginhttps)) {
2132                     redirect($CFG->wwwroot .'/login/change_password.php');
2133                 } else {
2134                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2135                     redirect($wwwroot .'/login/change_password.php');
2136                 }
2137             }
2138         } else {
2139             print_error('nopasswordchangeforced', 'auth');
2140         }
2141     }
2143 /// Check that the user account is properly set up
2144     if (user_not_fully_set_up($USER)) {
2145         $SESSION->wantsurl = $FULLME;
2146         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2147     }
2149 /// Make sure the USER has a sesskey set up.  Used for checking script parameters.
2150     sesskey();
2152     // Check that the user has agreed to a site policy if there is one
2153     if (!empty($CFG->sitepolicy)) {
2154         if (!$USER->policyagreed) {
2155             $SESSION->wantsurl = $FULLME;
2156             redirect($CFG->wwwroot .'/user/policy.php');
2157         }
2158     }
2160     // Fetch the system context, we are going to use it a lot.
2161     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2163 /// If the site is currently under maintenance, then print a message
2164     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2165         print_maintenance_message();
2166     }
2168 /// groupmembersonly access control
2169     if (!empty($CFG->enablegroupings) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2170         if (isguestuser() or !groups_has_membership($cm)) {
2171             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2172         }
2173     }
2175     // Fetch the course context, and prefetch its child contexts
2176     if (!isset($COURSE->context)) {
2177         if ( ! $COURSE->context = get_context_instance(CONTEXT_COURSE, $COURSE->id) ) {
2178             print_error('nocontext');
2179         }
2180     }
2181     if (!empty($cm) && !isset($cm->context)) {
2182         if ( ! $cm->context = get_context_instance(CONTEXT_MODULE, $cm->id) ) {
2183             print_error('nocontext');
2184         }
2185     }
2187     // Conditional activity access control
2188     if(!empty($CFG->enableavailability) and $cm) {
2189         // We cache conditional access in session
2190         if(!isset($SESSION->conditionaccessok)) {
2191             $SESSION->conditionaccessok = array();
2192         }
2193         // If you have been allowed into the module once then you are allowed
2194         // in for rest of session, no need to do conditional checks
2195         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2196             // Get condition info (does a query for the availability table)
2197             require_once($CFG->libdir.'/conditionlib.php');
2198             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2199             // Check condition for user (this will do a query if the availability
2200             // information depends on grade or completion information)
2201             if ($ci->is_available($junk) ||
2202                 has_capability('moodle/course:viewhiddenactivities', $cm->context)) {
2203                 $SESSION->conditionaccessok[$cm->id] = true;
2204             } else {
2205                 print_error('activityiscurrentlyhidden');
2206             }
2207         }
2208     }
2210     if ($COURSE->id == SITEID) {
2211         /// Eliminate hidden site activities straight away
2212         if (!empty($cm) && !$cm->visible
2213             && !has_capability('moodle/course:viewhiddenactivities', $cm->context)) {
2214             redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2215         }
2216         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2217         return;
2219     } else {
2221         /// Check if the user can be in a particular course
2222         if (empty($USER->access['rsw'][$COURSE->context->path])) {
2223             //
2224             // MDL-13900 - If the course or the parent category are hidden
2225             // and the user hasn't the 'course:viewhiddencourses' capability, prevent access
2226             //
2227             if ( !($COURSE->visible && course_parent_visible($COURSE)) &&
2228                    !has_capability('moodle/course:viewhiddencourses', $COURSE->context)) {
2229                 echo $OUTPUT->header();
2230                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2231             }
2232         }
2234     /// Non-guests who don't currently have access, check if they can be allowed in as a guest
2236         if ($USER->username != 'guest' and !has_capability('moodle/course:view', $COURSE->context)) {
2237             if ($COURSE->guest == 1) {
2238                  // Temporarily assign them guest role for this context, if it fails later user is asked to enrol
2239                  $USER->access = load_temp_role($COURSE->context, $CFG->guestroleid, $USER->access);
2240             }
2241         }
2243     /// If the user is a guest then treat them according to the course policy about guests
2245         if (has_capability('moodle/legacy:guest', $COURSE->context, NULL, false)) {
2246             if (has_capability('moodle/site:doanything', $sysctx)) {
2247                 // administrators must be able to access any course - even if somebody gives them guest access
2248                 user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2249                 return;
2250             }
2252             switch ($COURSE->guest) {    /// Check course policy about guest access
2254                 case 1:    /// Guests always allowed
2255                     if (!has_capability('moodle/course:view', $COURSE->context)) {    // Prohibited by capability
2256                         echo $OUTPUT->header();
2257                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), get_login_url());
2258                     }
2259                     if (!empty($cm) and !$cm->visible) { // Not allowed to see module, send to course page
2260                         redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course,
2261                                  get_string('activityiscurrentlyhidden'));
2262                     }
2264                     user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2265                     return;   // User is allowed to see this course
2267                     break;
2269                 case 2:    /// Guests allowed with key
2270                     if (!empty($USER->enrolkey[$COURSE->id])) {   // Set by enrol/manual/enrol.php
2271                         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2272                         return true;
2273                     }
2274                     //  otherwise drop through to logic below (--> enrol.php)
2275                     break;
2277                 default:    /// Guests not allowed
2278                     $strloggedinasguest = get_string('loggedinasguest');
2279                     $PAGE->navbar->add($strloggedinasguest);
2280                     echo $OUTPUT->header();
2281                     if (empty($USER->access['rsw'][$COURSE->context->path])) {  // Normal guest
2282                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), get_login_url());
2283                     } else {
2284                         echo $OUTPUT->notification(get_string('guestsnotallowed', '', format_string($COURSE->fullname)));
2285                         echo '<div class="notifyproblem">'.switchroles_form($COURSE->id).'</div>';
2286                         echo $OUTPUT->footer();
2287                         exit;
2288                     }
2289                     break;
2290             }
2292     /// For non-guests, check if they have course view access
2294         } else if (has_capability('moodle/course:view', $COURSE->context)) {
2295             if (session_is_loggedinas()) {   // Make sure the REAL person can also access this course
2296                 $realuser = session_get_realuser();
2297                 if (!has_capability('moodle/course:view', $COURSE->context, $realuser->id)) {
2298                     echo $OUTPUT->header();
2299                     notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2300                 }
2301             }
2303         /// Make sure they can read this activity too, if specified
2305             if (!empty($cm) && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cm->context)) {
2306                 redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course, get_string('activityiscurrentlyhidden'));
2307             }
2308             user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2309             return;   // User is allowed to see this course
2311         }
2314     /// Currently not enrolled in the course, so see if they want to enrol
2315         $SESSION->wantsurl = $FULLME;
2316         redirect($CFG->wwwroot .'/course/enrol.php?id='. $COURSE->id);
2317         die;
2318     }
2322 /**
2323  * This function just makes sure a user is logged out.
2324  *
2325  * @global object
2326  */
2327 function require_logout() {
2328     global $USER;
2330     if (isloggedin()) {
2331         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2333         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2334         foreach($authsequence as $authname) {
2335             $authplugin = get_auth_plugin($authname);
2336             $authplugin->prelogout_hook();
2337         }
2338     }
2340     session_get_instance()->terminate_current();
2343 /**
2344  * Weaker version of require_login()
2345  *
2346  * This is a weaker version of {@link require_login()} which only requires login
2347  * when called from within a course rather than the site page, unless
2348  * the forcelogin option is turned on.
2349  * @see require_login()
2350  *
2351  * @global object
2352  * @param mixed $courseorid The course object or id in question
2353  * @param bool $autologinguest Allow autologin guests if that is wanted
2354  * @param object $cm Course activity module if known
2355  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2356  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2357  *             in order to keep redirects working properly. MDL-14495
2358  */
2359 function require_course_login($courseorid, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2360     global $CFG;
2361     if (!empty($CFG->forcelogin)) {
2362         // login required for both SITE and courses
2363         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2365     } else if (!empty($cm) and !$cm->visible) {
2366         // always login for hidden activities
2367         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2369     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2370           or (!is_object($courseorid) and $courseorid == SITEID)) {
2371               //login for SITE not required
2372         if ($cm and empty($cm->visible)) {
2373             // hidden activities are not accessible without login
2374             require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2375         } else if ($cm and !empty($CFG->enablegroupings) and $cm->groupmembersonly) {
2376             // not-logged-in users do not have any group membership
2377             require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2378         } else {
2379             //TODO: verify conditional activities here
2380             user_accesstime_log(SITEID);
2381             return;
2382         }
2384     } else {
2385         // course login always required
2386         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2387     }
2390 /**
2391  * Require key login. Function terminates with error if key not found or incorrect.
2392  *
2393  * @global object
2394  * @global object
2395  * @global object
2396  * @global object
2397  * @uses NO_MOODLE_COOKIES
2398  * @uses PARAM_ALPHANUM
2399  * @param string $script unique script identifier
2400  * @param int $instance optional instance id
2401  * @return int Instance ID
2402  */
2403 function require_user_key_login($script, $instance=null) {
2404     global $USER, $SESSION, $CFG, $DB;
2406     if (!NO_MOODLE_COOKIES) {
2407         print_error('sessioncookiesdisable');
2408     }
2410 /// extra safety
2411     @session_write_close();
2413     $keyvalue = required_param('key', PARAM_ALPHANUM);
2415     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2416         print_error('invalidkey');
2417     }
2419     if (!empty($key->validuntil) and $key->validuntil < time()) {
2420         print_error('expiredkey');
2421     }
2423     if ($key->iprestriction) {
2424         $remoteaddr = getremoteaddr();
2425         if ($remoteaddr == '' or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2426             print_error('ipmismatch');
2427         }
2428     }
2430     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2431         print_error('invaliduserid');
2432     }
2434 /// emulate normal session
2435     session_set_user($user);
2437 /// note we are not using normal login
2438     if (!defined('USER_KEY_LOGIN')) {
2439         define('USER_KEY_LOGIN', true);
2440     }
2442 /// return isntance id - it might be empty
2443     return $key->instance;
2446 /**
2447  * Creates a new private user access key.
2448  *
2449  * @global object
2450  * @param string $script unique target identifier
2451  * @param int $userid
2452  * @param int $instance optional instance id
2453  * @param string $iprestriction optional ip restricted access
2454  * @param timestamp $validuntil key valid only until given data
2455  * @return string access key value
2456  */
2457 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2458     global $DB;
2460     $key = new object();
2461     $key->script        = $script;
2462     $key->userid        = $userid;
2463     $key->instance      = $instance;
2464     $key->iprestriction = $iprestriction;
2465     $key->validuntil    = $validuntil;
2466     $key->timecreated   = time();
2468     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2469     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2470         // must be unique
2471         $key->value     = md5($userid.'_'.time().random_string(40));
2472     }
2473     $DB->insert_record('user_private_key', $key);
2474     return $key->value;
2477 /**
2478  * Modify the user table by setting the currently logged in user's
2479  * last login to now.
2480  *
2481  * @global object
2482  * @global object
2483  * @return bool Always returns true
2484  */
2485 function update_user_login_times() {
2486     global $USER, $DB;
2488     $user = new object();
2489     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2490     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2492     $user->id = $USER->id;
2494     $DB->update_record('user', $user);
2495     return true;
2498 /**
2499  * Determines if a user has completed setting up their account.
2500  *
2501  * @param user $user A {@link $USER} object to test for the existance of a valid name and email
2502  * @return bool
2503  */
2504 function user_not_fully_set_up($user) {
2505     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2508 /**
2509  * Check whether the user has exceeded the bounce threshold
2510  *
2511  * @global object
2512  * @global object
2513  * @param user $user A {@link $USER} object
2514  * @return bool true=>User has exceeded bounce threshold
2515  */
2516 function over_bounce_threshold($user) {
2517     global $CFG, $DB;
2519     if (empty($CFG->handlebounces)) {
2520         return false;
2521     }
2523     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2524         return false;
2525     }
2527     // set sensible defaults
2528     if (empty($CFG->minbounces)) {
2529         $CFG->minbounces = 10;
2530     }
2531     if (empty($CFG->bounceratio)) {
2532         $CFG->bounceratio = .20;
2533     }
2534     $bouncecount = 0;
2535     $sendcount = 0;
2536     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2537         $bouncecount = $bounce->value;
2538     }
2539     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2540         $sendcount = $send->value;
2541     }
2542     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2545 /**
2546  * Used to increment or reset email sent count
2547  *
2548  * @global object
2549  * @param user $user object containing an id
2550  * @param bool $reset will reset the count to 0
2551  * @return void
2552  */
2553 function set_send_count($user,$reset=false) {
2554     global $DB;
2556     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2557         return;
2558     }
2560     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2561         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2562         $DB->update_record('user_preferences', $pref);
2563     }
2564     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2565         // make a new one
2566         $pref = new object();
2567         $pref->name   = 'email_send_count';
2568         $pref->value  = 1;
2569         $pref->userid = $user->id;
2570         $DB->insert_record('user_preferences', $pref, false);
2571     }
2574 /**
2575  * Increment or reset user's email bounce count
2576  *
2577  * @global object
2578  * @param user $user object containing an id
2579  * @param bool $reset will reset the count to 0
2580  */
2581 function set_bounce_count($user,$reset=false) {
2582     global $DB;
2584     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2585         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2586         $DB->update_record('user_preferences', $pref);
2587     }
2588     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2589         // make a new one
2590         $pref = new object();
2591         $pref->name   = 'email_bounce_count';
2592         $pref->value  = 1;
2593         $pref->userid = $user->id;
2594         $DB->insert_record('user_preferences', $pref, false);
2595     }
2598 /**
2599  * Keeps track of login attempts
2600  *
2601  * @global object
2602  */
2603 function update_login_count() {
2604     global $SESSION;
2606     $max_logins = 10;
2608     if (empty($SESSION->logincount)) {
2609         $SESSION->logincount = 1;
2610     } else {
2611         $SESSION->logincount++;
2612     }
2614     if ($SESSION->logincount > $max_logins) {
2615         unset($SESSION->wantsurl);
2616         print_error('errortoomanylogins');
2617     }
2620 /**
2621  * Resets login attempts
2622  *
2623  * @global object
2624  */
2625 function reset_login_count() {
2626     global $SESSION;
2628     $SESSION->logincount = 0;
2631 /**
2632  * Sync all meta courses
2633  * Goes through all enrolment records for the courses inside all metacourses and syncs with them.
2634  * @see sync_metacourse()
2635  *
2636  * @global object
2637  */
2638 function sync_metacourses() {
2639     global $DB;
2641     if (!$courses = $DB->get_records('course', array('metacourse'=>1))) {
2642         return;
2643     }
2645     foreach ($courses as $course) {
2646         sync_metacourse($course);
2647     }
2650 /**
2651  * Returns reference to full info about modules in course (including visibility).
2652  * Cached and as fast as possible (0 or 1 db query).
2653  *
2654  * @global object
2655  * @global object
2656  * @global object
2657  * @uses CONTEXT_MODULE
2658  * @uses MAX_MODINFO_CACHE_SIZE
2659  * @param mixed $course object or 'reset' string to reset caches, modinfo may be updated in db
2660  * @param int $userid Defaults to current user id
2661  * @return mixed courseinfo object or nothing if resetting
2662  */
2663 function &get_fast_modinfo(&$course, $userid=0) {
2664     global $CFG, $USER, $DB;
2665     require_once($CFG->dirroot.'/course/lib.php');
2667     if (!empty($CFG->enableavailability)) {
2668         require_once($CFG->libdir.'/conditionlib.php');
2669     }
2671     static $cache = array();
2673     if ($course === 'reset') {
2674         $cache = array();
2675         $nothing = null;
2676         return $nothing; // we must return some reference
2677     }
2679     if (empty($userid)) {
2680         $userid = $USER->id;
2681     }
2683     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
2684         return $cache[$course->id];
2685     }
2687     if (empty($course->modinfo)) {
2688         // no modinfo yet - load it
2689         rebuild_course_cache($course->id);
2690         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2691     }
2693     $modinfo = new object();
2694     $modinfo->courseid  = $course->id;
2695     $modinfo->userid    = $userid;
2696     $modinfo->sections  = array();
2697     $modinfo->cms       = array();
2698     $modinfo->instances = array();
2699     $modinfo->groups    = null; // loaded only when really needed - the only one db query
2701     $info = unserialize($course->modinfo);
2702     if (!is_array($info)) {
2703         // hmm, something is wrong - lets try to fix it
2704         rebuild_course_cache($course->id);
2705         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2706         $info = unserialize($course->modinfo);
2707         if (!is_array($info)) {
2708             return $modinfo;
2709         }
2710     }
2712     if ($info) {
2713         // detect if upgrade required
2714         $first = reset($info);
2715         if (!isset($first->id)) {
2716             rebuild_course_cache($course->id);
2717             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2718             $info = unserialize($course->modinfo);
2719             if (!is_array($info)) {
2720                 return $modinfo;
2721             }
2722         }
2723     }
2725     $modlurals = array();
2727     // If we haven't already preloaded contexts for the course, do it now
2728     preload_course_contexts($course->id);
2730     foreach ($info as $mod) {
2731         if (empty($mod->name)) {
2732             // something is wrong here
2733             continue;
2734         }
2735         // reconstruct minimalistic $cm
2736         $cm = new object();
2737         $cm->id               = $mod->cm;
2738         $cm->instance         = $mod->id;
2739         $cm->course           = $course->id;
2740         $cm->modname          = $mod->mod;
2741         $cm->name             = urldecode($mod->name);
2742         $cm->visible          = $mod->visible;
2743         $cm->sectionnum       = $mod->section;
2744         $cm->groupmode        = $mod->groupmode;
2745         $cm->groupingid       = $mod->groupingid;
2746         $cm->groupmembersonly = $mod->groupmembersonly;
2747         $cm->indent           = $mod->indent;
2748         $cm->completion       = $mod->completion;
2749         $cm->extra            = isset($mod->extra) ? urldecode($mod->extra) : '';
2750         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
2751         $cm->uservisible      = true;
2752         if(!empty($CFG->enableavailability)) {
2753             // We must have completion information from modinfo. If it's not
2754             // there, cache needs rebuilding
2755             if(!isset($mod->availablefrom)) {
2756                 debugging('enableavailability option was changed; rebuilding '.
2757                     'cache for course '.$course->id);
2758                 rebuild_course_cache($course->id,true);
2759                 // Re-enter this routine to do it all properly
2760                 return get_fast_modinfo($course,$userid);
2761             }
2762             $cm->availablefrom    = $mod->availablefrom;
2763             $cm->availableuntil   = $mod->availableuntil;
2764             $cm->showavailability = $mod->showavailability;
2765             $cm->conditionscompletion = $mod->conditionscompletion;
2766             $cm->conditionsgrade  = $mod->conditionsgrade;
2767         }
2769         // preload long names plurals and also check module is installed properly
2770         if (!isset($modlurals[$cm->modname])) {
2771             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
2772                 continue;
2773             }
2774             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
2775         }
2776         $cm->modplural = $modlurals[$cm->modname];
2777         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
2779         if(!empty($CFG->enableavailability)) {
2780             // Unfortunately the next call really wants to call
2781             // get_fast_modinfo, but that would be recursive, so we fake up a
2782             // modinfo for it already
2783             if(empty($minimalmodinfo)) {
2784                 $minimalmodinfo=new stdClass();
2785                 $minimalmodinfo->cms=array();
2786                 foreach($info as $mod) {
2787                     $minimalcm=new stdClass();
2788                     $minimalcm->id=$mod->cm;
2789                     $minimalcm->name=urldecode($mod->name);
2790                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
2791                 }
2792             }
2794             // Get availability information
2795             $ci = new condition_info($cm);
2796             $cm->available=$ci->is_available($cm->availableinfo,true,$userid,
2797                 $minimalmodinfo);
2798         } else {
2799             $cm->available=true;
2800         }
2801         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
2802             $cm->uservisible = false;
2804         } else if (!empty($CFG->enablegroupings) and !empty($cm->groupmembersonly)
2805                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
2806             if (is_null($modinfo->groups)) {
2807                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
2808             }
2809             if (empty($modinfo->groups[$cm->groupingid])) {
2810                 $cm->uservisible = false;
2811             }
2812         }
2814         if (!isset($modinfo->instances[$cm->modname])) {
2815             $modinfo->instances[$cm->modname] = array();
2816         }
2817         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
2818         $modinfo->cms[$cm->id] =& $cm;
2820         // reconstruct sections
2821         if (!isset($modinfo->sections[$cm->sectionnum])) {
2822             $modinfo->sections[$cm->sectionnum] = array();
2823         }
2824         $modinfo->sections[$cm->sectionnum][] = $cm->id;
2826         unset($cm);
2827     }
2829     unset($cache[$course->id]); // prevent potential reference problems when switching users
2830     $cache[$course->id] = $modinfo;
2832     // Ensure cache does not use too much RAM
2833     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
2834         reset($cache);
2835         $key = key($cache);
2836         unset($cache[$key]);
2837     }
2839     return $cache[$course->id];
2842 /**
2843  * Goes through all enrolment records for the courses inside the metacourse and sync with them.
2844  *
2845  * @todo finish timeend and timestart maybe we could rely on cron
2846  *       job to do the cleaning from time to time
2847  *
2848  * @global object
2849  * @global object
2850  * @uses CONTEXT_COURSE
2851  * @param mixed $course the metacourse to synch. Either the course object itself, or the courseid.
2852  * @return bool Success
2853  */
2854 function sync_metacourse($course) {
2855     global $CFG, $DB;
2857     // Check the course is valid.
2858     if (!is_object($course)) {
2859         if (!$course = $DB->get_record('course', array('id'=>$course))) {
2860             return false; // invalid course id
2861         }
2862     }
2864     // Check that we actually have a metacourse.
2865     if (empty($course->metacourse)) {
2866         return false;
2867     }
2869     // Get a list of roles that should not be synced.
2870     if (!empty($CFG->nonmetacoursesyncroleids)) {
2871         $roleexclusions = 'ra.roleid NOT IN (' . $CFG->nonmetacoursesyncroleids . ') AND';
2872     } else {
2873         $roleexclusions = '';
2874     }
2876     // Get the context of the metacourse.
2877     $context = get_context_instance(CONTEXT_COURSE, $course->id); // SITEID can not be a metacourse
2879     // We do not ever want to unassign the list of metacourse manager, so get a list of them.
2880     if ($users = get_users_by_capability($context, 'moodle/course:managemetacourse')) {
2881         $managers = array_keys($users);
2882     } else {
2883         $managers = array();
2884     }
2886     // Get assignments of a user to a role that exist in a child course, but
2887     // not in the meta coure. That is, get a list of the assignments that need to be made.
2888     if (!$assignments = $DB->get_records_sql("
2889             SELECT ra.id, ra.roleid, ra.userid
2890               FROM {role_assignments} ra, {context} con, {course_meta} cm
2891              WHERE ra.contextid = con.id AND
2892                    con.contextlevel = ".CONTEXT_COURSE." AND
2893                    con.instanceid = cm.child_course AND
2894                    cm.parent_course = ? AND
2895                    $roleexclusions
2896                    NOT EXISTS (
2897                      SELECT 1
2898                        FROM {role_assignments} ra2
2899                       WHERE ra2.userid = ra.userid AND
2900                             ra2.roleid = ra.roleid AND
2901                             ra2.contextid = ?
2902                   )", array($course->id, $context->id))) {
2903         $assignments = array();
2904     }
2906     // Get assignments of a user to a role that exist in the meta course, but
2907     // not in any child courses. That is, get a list of the unassignments that need to be made.
2908     if (!$unassignments = $DB->get_records_sql("
2909             SELECT ra.id, ra.roleid, ra.userid
2910               FROM {role_assignments} ra
2911              WHERE ra.contextid = ? AND
2912                    $roleexclusions
2913                    NOT EXISTS (
2914                     SELECT 1
2915                       FROM {role_assignments} ra2, {context} con2, {course_meta} cm
2916                     WHERE ra2.userid = ra.userid AND
2917                           ra2.roleid = ra.roleid AND
2918                           ra2.contextid = con2.id AND
2919                           con2.contextlevel = " . CONTEXT_COURSE . " AND
2920                           con2.instanceid = cm.child_course AND
2921                           cm.parent_course = ?
2922                   )", array($context->id, $course->id))) {
2923         $unassignments = array();
2924     }
2926     $success = true;
2928     // Make the unassignments, if they are not managers.
2929     foreach ($unassignments as $unassignment) {
2930         if (!in_array($unassignment->userid, $managers)) {
2931             $success = role_unassign($unassignment->roleid, $unassignment->userid, 0, $context->id) && $success;
2932         }
2933     }
2935     // Make the assignments.
2936     foreach ($assignments as $assignment) {
2937         $success = role_assign($assignment->roleid, $assignment->userid, 0, $context->id) && $success;
2938     }
2940     return $success;
2942 // TODO: finish timeend and timestart
2943 // maybe we could rely on cron job to do the cleaning from time to time
2946 /**
2947  * Adds a record to the metacourse table and calls sync_metacoures
2948  *
2949  * @global object
2950  * @param int $metacourseid The Metacourse ID for the metacourse to add to
2951  * @param int $courseid The Course ID of the course to add
2952  * @return bool Success
2953  */
2954 function add_to_metacourse ($metacourseid, $courseid) {
2955     global $DB;
2957     if (!$metacourse = $DB->get_record("course", array("id"=>$metacourseid))) {
2958         return false;
2959     }
2961     if (!$course = $DB->get_record("course", array("id"=>$courseid))) {
2962         return false;
2963     }
2965     if (!$record = $DB->get_record("course_meta", array("parent_course"=>$metacourseid, "child_course"=>$courseid))) {
2966         $rec = new object();
2967         $rec->parent_course = $metacourseid;
2968         $rec->child_course  = $courseid;
2969         $DB->insert_record('course_meta', $rec);
2970         return sync_metacourse($metacourseid);
2971     }
2972     return true;
2976 /**
2977  * Removes the record from the metacourse table and calls sync_metacourse
2978  *
2979  * @global object
2980  * @param int $metacourseid The Metacourse ID for the metacourse to remove from
2981  * @param int $courseid The Course ID of the course to remove
2982  * @return bool Success
2983  */
2984 function remove_from_metacourse($metacourseid, $courseid) {
2985     global $DB;
2987     if ($DB->delete_records('course_meta', array('parent_course'=>$metacourseid, 'child_course'=>$courseid))) {
2988         return sync_metacourse($metacourseid);
2989     }
2990     return false;
2994 /**
2995  * Determines if a user is currently logged in
2996  *
2997  * @global object
2998  * @return bool
2999  */
3000 function isloggedin() {
3001     global $USER;
3003     return (!empty($USER->id));
3006 /**
3007  * Determines if a user is logged in as real guest user with username 'guest'.
3008  * This function is similar to original isguest() in 1.6 and earlier.
3009  * Current isguest() is deprecated - do not use it anymore.
3010  *
3011  * @global object
3012  * @global object
3013  * @param int $user mixed user object or id, $USER if not specified
3014  * @return bool true if user is the real guest user, false if not logged in or other user
3015  */
3016 function isguestuser($user=NULL) {
3017     global $USER, $DB;
3019     if ($user === NULL) {
3020         $user = $USER;
3021     } else if (is_numeric($user)) {
3022         $user = $DB->get_record('user', array('id'=>$user), 'id, username');
3023     }
3025     if (empty($user->id)) {
3026         return false; // not logged in, can not be guest
3027     }
3029     return ($user->username == 'guest');
3032 /**
3033  * Determines if the currently logged in user is in editing mode.
3034  * Note: originally this function had $userid parameter - it was not usable anyway
3035  *
3036  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3037  * @todo Deprecated function remove when ready
3038  *
3039  * @global object
3040  * @uses DEBUG_DEVELOPER
3041  * @return bool
3042  */
3043 function isediting() {
3044     global $PAGE;
3045     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3046     return $PAGE->user_is_editing();
3049 /**
3050  * Determines if the logged in user is currently moving an activity
3051  *
3052  * @global object
3053  * @param int $courseid The id of the course being tested
3054  * @return bool
3055  */
3056 function ismoving($courseid) {
3057     global $USER;
3059     if (!empty($USER->activitycopy)) {
3060         return ($USER->activitycopycourse == $courseid);
3061     }
3062     return false;
3065 /**
3066  * Returns a persons full name
3067  *
3068  * Given an object containing firstname and lastname
3069  * values, this function returns a string with the
3070  * full name of the person.
3071  * The result may depend on system settings
3072  * or language.  'override' will force both names
3073  * to be used even if system settings specify one.
3074  *
3075  * @global object
3076  * @global object
3077  * @param object $user A {@link $USER} object to get full name of
3078  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3079  * @return string
3080  */
3081 function fullname($user, $override=false) {
3082     global $CFG, $SESSION;
3084     if (!isset($user->firstname) and !isset($user->lastname)) {
3085         return '';
3086     }
3088     if (!$override) {
3089         if (!empty($CFG->forcefirstname)) {
3090             $user->firstname = $CFG->forcefirstname;
3091         }
3092         if (!empty($CFG->forcelastname)) {
3093             $user->lastname = $CFG->forcelastname;
3094         }
3095     }
3097     if (!empty($SESSION->fullnamedisplay)) {
3098         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3099     }
3101     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3102         return $user->firstname .' '. $user->lastname;
3104     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3105         return $user->lastname .' '. $user->firstname;
3107     } else if ($CFG->fullnamedisplay == 'firstname') {
3108         if ($override) {
3109             return get_string('fullnamedisplay', '', $user);
3110         } else {
3111             return $user->firstname;
3112         }
3113     }
3115     return get_string('fullnamedisplay', '', $user);
3118 /**
3119  * Returns whether a given authentication plugin exists.
3120  *
3121  * @global object
3122  * @param string $auth Form of authentication to check for. Defaults to the
3123  *        global setting in {@link $CFG}.
3124  * @return boolean Whether the plugin is available.
3125  */
3126 function exists_auth_plugin($auth) {
3127     global $CFG;
3129     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3130         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3131     }
3132     return false;
3135 /**
3136  * Checks if a given plugin is in the list of enabled authentication plugins.
3137  *
3138  * @param string $auth Authentication plugin.
3139  * @return boolean Whether the plugin is enabled.
3140  */
3141 function is_enabled_auth($auth) {
3142     if (empty($auth)) {
3143         return false;
3144     }
3146     $enabled = get_enabled_auth_plugins();
3148     return in_array($auth, $enabled);
3151 /**
3152  * Returns an authentication plugin instance.
3153  *
3154  * @global object
3155  * @param string $auth name of authentication plugin
3156  * @return object An instance of the required authentication plugin.
3157  */
3158 function get_auth_plugin($auth) {
3159     global $CFG;
3161     // check the plugin exists first
3162     if (! exists_auth_plugin($auth)) {
3163         print_error('authpluginnotfound', 'debug', '', $auth);
3164     }
3166     // return auth plugin instance
3167     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3168     $class = "auth_plugin_$auth";
3169     return new $class;
3172 /**
3173  * Returns array of active auth plugins.
3174  *
3175  * @param bool $fix fix $CFG->auth if needed
3176  * @return array
3177  */
3178 function get_enabled_auth_plugins($fix=false) {
3179     global $CFG;
3181     $default = array('manual', 'nologin');
3183     if (empty($CFG->auth)) {
3184         $auths = array();
3185     } else {
3186         $auths = explode(',', $CFG->auth);
3187     }
3189     if ($fix) {
3190         $auths = array_unique($auths);
3191         foreach($auths as $k=>$authname) {
3192             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3193                 unset($auths[$k]);
3194             }
3195         }
3196         $newconfig = implode(',', $auths);
3197         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3198             set_config('auth', $newconfig);
3199         }
3200     }
3202     return (array_merge($default, $auths));
3205 /**
3206  * Returns true if an internal authentication method is being used.
3207  * if method not specified then, global default is assumed
3208  *
3209  * @param string $auth Form of authentication required
3210  * @return bool
3211  */
3212 function is_internal_auth($auth) {
3213     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3214     return $authplugin->is_internal();
3217 /**
3218  * Returns an array of user fields
3219  *
3220  * @return array User field/column names
3221  */
3222 function get_user_fieldnames() {
3223     global $DB;
3225     $fieldarray = $DB->get_columns('user');
3226     unset($fieldarray['id']);
3227     $fieldarray = array_keys($fieldarray);
3229     return $fieldarray;
3232 /**
3233  * Creates a bare-bones user record
3234  *
3235  * @todo Outline auth types and provide code example
3236  *
3237  * @global object
3238  * @global object
3239  * @param string $username New user's username to add to record
3240  * @param string $password New user's password to add to record
3241  * @param string $auth Form of authentication required
3242  * @return object A {@link $USER} object
3243  */
3244 function create_user_record($username, $password, $auth='manual') {
3245     global $CFG, $DB;
3247     //just in case check text case
3248     $username = trim(moodle_strtolower($username));
3250     $authplugin = get_auth_plugin($auth);
3252     $newuser = new object();
3254     if ($newinfo = $authplugin->get_userinfo($username)) {
3255         $newinfo = truncate_userinfo($newinfo);
3256         foreach ($newinfo as $key => $value){
3257             $newuser->$key = $value;
3258         }
3259     }
3261     if (!empty($newuser->email)) {
3262         if (email_is_not_allowed($newuser->email)) {
3263             unset($newuser->email);
3264         }
3265     }
3267     if (!isset($newuser->city)) {
3268         $newuser->city = '';
3269     }
3271     $newuser->auth = $auth;
3272     $newuser->username = $username;
3274     // fix for MDL-8480
3275     // user CFG lang for user if $newuser->lang is empty
3276     // or $user->lang is not an installed language
3277     $sitelangs = array_keys(get_list_of_languages());
3278     if (empty($newuser->lang) || !in_array($newuser->lang, $sitelangs)) {
3279         $newuser->lang = $CFG->lang;
3280     }
3281     $newuser->confirmed = 1;
3282     $newuser->lastip = getremoteaddr();
3283     $newuser->timemodified = time();
3284     $newuser->mnethostid = $CFG->mnet_localhost_id;
3286     $DB->insert_record('user', $newuser);
3287     $user = get_complete_user_data('username', $newuser->username);
3288     if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3289         set_user_preference('auth_forcepasswordchange', 1, $user->id);
3290     }
3291     update_internal_user_password($user, $password);
3292     return $user;
3295 /**
3296  * Will update a local user record from an external source
3297  *
3298  * @global object
3299  * @param string $username New user's username to add to record
3300  * @param string $authplugin Unused
3301  * @return user A {@link $USER} object
3302  */
3303 function update_user_record($username, $authplugin) {
3304     global $DB;
3306     $username = trim(moodle_strtolower($username)); /// just in case check text case
3308     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
3309     $userauth = get_auth_plugin($oldinfo->auth);
3311     if ($newinfo = $userauth->get_userinfo($username)) {
3312         $newinfo = truncate_userinfo($newinfo);
3313         foreach ($newinfo as $key => $value){
3314             if ($key === 'username') {
3315                 // 'username' is not a mapped updateable/lockable field, so skip it.
3316                 continue;
3317             }
3318             $confval = $userauth->config->{'field_updatelocal_' . $key};
3319             $lockval = $userauth->config->{'field_lock_' . $key};
3320             if (empty($confval) || empty($lockval)) {
3321                 continue;
3322             }
3323             if ($confval === 'onlogin') {
3324                 // MDL-4207 Don't overwrite modified user profile values with
3325                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3326                 // of the setting 'unlocked if empty' is to allow the user to fill
3327                 // in a value for the selected field _if LDAP is giving
3328                 // nothing_ for this field. Thus it makes sense to let this value
3329                 // stand in until LDAP is giving a value for this field.
3330                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3331                     $DB->set_field('user', $key, $value, array('username'=>$username));
3332                 }
3333             }
3334         }
3335     }
3337     return get_complete_user_data('username', $username);
3340 /**
3341  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3342  * which may have large fields
3343  *
3344  * @todo Add vartype handling to ensure $info is an array
3345  *
3346  * @param array $info Array of user properties to truncate if needed
3347  * @return array The now truncated information that was passed in
3348  */
3349 function truncate_userinfo($info) {
3350     // define the limits
3351     $limit = array(
3352                     'username'    => 100,
3353                     'idnumber'    => 255,
3354                     'firstname'   => 100,
3355                     'lastname'    => 100,
3356                     'email'       => 100,
3357                     'icq'         =>  15,
3358                     'phone1'      =>  20,
3359                     'phone2'      =>  20,
3360                     'institution' =>  40,
3361                     'department'  =>  30,
3362                     'address'     =>  70,
3363                     'city'        =>  20,
3364                     'country'     =>   2,
3365                     'url'         => 255,
3366                     );
3368     // apply where needed
3369     foreach (array_keys($info) as $key) {
3370         if (!empty($limit[$key])) {
3371             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
3372         }
3373     }
3375     return $info;
3378 /**
3379  * Marks user deleted in internal user database and notifies the auth plugin.
3380  * Also unenrols user from all roles and does other cleanup.
3381  *
3382  * @todo Decide if this transaction is really needed (look for internal TODO:)
3383  *
3384  * @global object
3385  * @global object
3386  * @param object $user Userobject before delete    (without system magic quotes)
3387  * @return boolean success
3388  */
3389 function delete_user($user) {
3390     global $CFG, $DB;
3391     require_once($CFG->libdir.'/grouplib.php');
3392     require_once($CFG->libdir.'/gradelib.php');
3393     require_once($CFG->dirroot.'/message/lib.php');
3395     // TODO: decide if this transaction is really needed
3396     $DB->begin_sql();
3398     try {
3399         // delete all grades - backup is kept in grade_grades_history table
3400         if ($grades = grade_grade::fetch_all(array('userid'=>$user->id))) {
3401             foreach ($grades as $grade) {
3402                 $grade->delete('userdelete');
3403             }
3404         }
3406         //move unread messages from this user to read
3407         message_move_userfrom_unread2read($user->id);
3409         // remove from all groups
3410         $DB->delete_records('groups_members', array('userid'=>$user->id));
3412         // unenrol from all roles in all contexts
3413         role_unassign(0, $user->id); // this might be slow but it is really needed - modules might do some extra cleanup!
3415         // now do a final accesslib cleanup - removes all role assingments in user context and context itself
3416         delete_context(CONTEXT_USER, $user->id);
3418         require_once($CFG->dirroot.'/tag/lib.php');
3419         tag_set('user', $user->id, array());
3421         // workaround for bulk deletes of users with the same email address
3422         $delname = "$user->email.".time();
3423         while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3424             $delname++;
3425         }
3427         // mark internal user record as "deleted"
3428         $updateuser = new object();
3429         $updateuser->id           = $user->id;
3430         $updateuser->deleted      = 1;
3431         $updateuser->username     = $delname;         // Remember it just in case
3432         $updateuser->email        = '';               // Clear this field to free it up
3433         $updateuser->idnumber     = '';               // Clear this field to free it up
3434         $updateuser->timemodified = time();
3436         $DB->update_record('user', $updateuser);
3438         $DB->commit_sql();
3440         // notify auth plugin - do not block the delete even when plugin fails
3441         $authplugin = get_auth_plugin($user->auth);
3442         $authplugin->user_delete($user);
3444         events_trigger('user_deleted', $user);
3446     } catch (Exception $e) {
3447         $DB->rollback_sql();
3448         throw $e;
3449     }
3451     return true;
3454 /**
3455  * Retrieve the guest user object
3456  *
3457  * @global object
3458  * @global object
3459  * @return user A {@link $USER} object
3460  */
3461 function guest_user() {
3462     global $CFG, $DB;
3464     if ($newuser = $DB->get_record('user', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
3465         $newuser->confirmed = 1;
3466         $newuser->lang = $CFG->lang;
3467         $newuser->lastip = getremoteaddr();
3468     }
3470     return $newuser;
3473 /**
3474  * Authenticates a user against the chosen authentication mechanism
3475  *
3476  * Given a username and password, this function looks them
3477  * up using the currently selected authentication mechanism,
3478  * and if the authentication is successful, it returns a
3479  * valid $user object from the 'user' table.
3480  *
3481  * Uses auth_ functions from the currently active auth module
3482  *
3483  * After authenticate_user_login() returns success, you will need to
3484  * log that the user has logged in, and call complete_user_login() to set
3485  * the session up.
3486  *
3487  * @global object
3488  * @global object
3489  * @param string $username  User's username
3490  * @param string $password  User's password
3491  * @return user|flase A {@link $USER} object or false if error
3492  */
3493 function authenticate_user_login($username, $password) {
3494     global $CFG, $DB, $OUTPUT;
3496     $authsenabled = get_enabled_auth_plugins();
3498     if ($user = get_complete_user_data('username', $username)) {
3499         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3500         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3501             add_to_log(0, 'login', 'error', 'index.php', $username);
3502             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3503             return false;
3504         }
3505         $auths = array($auth);
3507     } else {
3508         // check if there's a deleted record (cheaply)
3509         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
3510             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3511             return false;
3512         }
3514         $auths = $authsenabled;
3515         $user = new object();
3516         $user->id = 0;     // User does not exist
3517     }
3519     foreach ($auths as $auth) {
3520         $authplugin = get_auth_plugin($auth);
3522         // on auth fail fall through to the next plugin
3523         if (!$authplugin->user_login($username, $password)) {
3524             continue;
3525         }
3527         // successful authentication
3528         if ($user->id) {                          // User already exists in database
3529             if (empty($user->auth)) {             // For some reason auth isn't set yet
3530                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3531                 $user->auth = $auth;
3532             }
3533             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3534                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3535                 $user->firstaccess = $user->timemodified;
3536             }
3538             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3540             if (!$authplugin->is_internal()) {            // update user record from external DB
3541                 $user = update_user_record($username, get_auth_plugin($user->auth));
3542             }
3543         } else {
3544             // if user not found, create him
3545             $user = create_user_record($username, $password, $auth);
3546         }
3548         $authplugin->sync_roles($user);
3550         foreach ($authsenabled as $hau) {
3551             $hauth = get_auth_plugin($hau);
3552             $hauth->user_authenticated_hook($user, $username, $password);
3553         }
3555     /// Log in to a second system if necessary
3556     /// NOTICE: /sso/ will be moved to auth and deprecated soon; use user_authenticated_hook() instead
3557         if (!empty($CFG->sso)) {
3558             include_once($CFG->dirroot .'/sso/'. $CFG->sso .'/lib.php');
3559             if (function_exists('sso_user_login')) {
3560                 if (!sso_user_login($username, $password)) {   // Perform the signon process
3561                     echo $OUTPUT->notification('Second sign-on failed');
3562                 }
3563             }
3564         }
3566         if ($user->id===0) {
3567             return false;
3568         }
3569         return $user;
3570     }
3572     // failed if all the plugins have failed
3573     add_to_log(0, 'login', 'error', 'index.php', $username);
3574     if (debugging('', DEBUG_ALL)) {
3575         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3576     }
3577     return false;
3580 /**
3581  * Call to complete the user login process after authenticate_user_login()
3582  * has succeeded. It will setup the $USER variable and other required bits
3583  * and pieces.
3584  *
3585  * NOTE:
3586  * - It will NOT log anything -- up to the caller to decide what to log.
3587  *
3588  * @global object
3589  * @global object
3590  * @global object
3591  * @param object $user
3592  * @param bool $setcookie
3593  * @return object A {@link $USER} object - BC only, do not use
3594  */
3595 function complete_user_login($user, $setcookie=true) {
3596     global $CFG, $USER, $SESSION;
3598     // regenerate session id and delete old session,
3599     // this helps prevent session fixation attacks from the same domain
3600     session_regenerate_id(true);
3602     // check enrolments, load caps and setup $USER object
3603     session_set_user($user);
3605     update_user_login_times();
3606     set_login_session_preferences();
3608     if ($setcookie) {
3609         if (empty($CFG->nolastloggedin)) {
3610             set_moodle_cookie($USER->username);
3611         } else {
3612             // do not store last logged in user in cookie
3613             // auth plugins can temporarily override this from loginpage_hook()
3614             // do not save $CFG->nolastloggedin in database!
3615             set_moodle_cookie('nobody');
3616         }
3617     }
3619     /// Select password change url
3620     $userauth = get_auth_plugin($USER->auth);
3622     /// check whether the user should be changing password
3623     if (get_user_preferences('auth_forcepasswordchange', false)){
3624         if ($userauth->can_change_password()) {
3625             if ($changeurl = $userauth->change_password_url()) {
3626                 redirect($changeurl);
3627             } else {
3628                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3629             }
3630         } else {
3631             print_error('nopasswordchangeforced', 'auth');
3632         }
3633     }
3634     return $USER;
3637 /**
3638  * Compare password against hash stored in internal user table.
3639  * If necessary it also updates the stored hash to new format.
3640  *
3641  * @global object
3642  * @param object $user
3643  * @param string $password plain text password
3644  * @return bool is password valid?
3645  */
3646 function validate_internal_user_password(&$user, $password) {
3647     global $CFG;
3649     if (!isset($CFG->passwordsaltmain)) {
3650         $CFG->passwordsaltmain = '';
3651     }
3653     $validated = false;
3655     // get password original encoding in case it was not updated to unicode yet
3656     $textlib = textlib_get_instance();
3657     $convpassword = $textlib->convert($password, 'utf-8', get_string('oldcharset'));
3659     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)
3660         or $user->password == md5($convpassword.$CFG->passwordsaltmain) or $user->password == md5($convpassword)) {
3661         $validated = true;
3662     } else {
3663         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3664             $alt = 'passwordsaltalt'.$i;
3665             if (!empty($CFG->$alt)) {
3666                 if ($user->password == md5($password.$CFG->$alt) or $user->password == md5($convpassword.$CFG->$alt)) {
3667                     $validated = true;
3668                     break;
3669                 }
3670             }
3671         }
3672     }
3674     if ($validated) {
3675         // force update of password hash using latest main password salt and encoding if needed
3676         update_internal_user_password($user, $password);
3677     }
3679     return $validated;
3682 /**
3683  * Calculate hashed value from password using current hash mechanism.
3684  *
3685  * @global object
3686  * @param string $password
3687  * @return string password hash
3688  */
3689 function hash_internal_user_password($password) {
3690     global $CFG;
3692     if (isset($CFG->passwordsaltmain)) {
3693         return md5($password.$CFG->passwordsaltmain);
3694     } else {
3695         return md5($password);
3696     }
3699 /**
3700  * Update pssword hash in user object.
3701  *
3702  * @global object
3703  * @global object
3704  * @param object $user
3705  * @param string $password plain text password
3706  * @return bool true if hash changed
3707  */
3708 function update_internal_user_password(&$user, $password) {
3709     global $CFG, $DB;
3711     $authplugin = get_auth_plugin($user->auth);
3712     if (!empty($authplugin->config->preventpassindb)) {
3713         $hashedpassword = 'not cached';
3714     } else {
3715         $hashedpassword = hash_internal_user_password($password);
3716     }
3718     $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
3719     return true;
3722 /**
3723  * Get a complete user record, which includes all the info
3724  * in the user record.
3725  *
3726  * Intended for setting as $USER session variable
3727  *
3728  * @global object
3729  * @global object
3730  * @uses SITEID
3731  * @param string $field The user field to be checked for a given value.
3732  * @param string $value The value to match for $field.
3733  * @param int $mnethostid
3734  * @return mixed False, or A {@link $USER} object.
3735  */
3736 function get_complete_user_data($field, $value, $mnethostid=null) {
3737     global $CFG, $DB;