MDL-21432 backup 2.0 - initial commit. Enable forum backup
[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_EMAIL - an email address following the RFC
128  */
129 define('PARAM_EMAIL',   'email');
131 /**
132  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
133  */
134 define('PARAM_FILE',   'file');
136 /**
137  * PARAM_FLOAT - a real/floating point number.
138  */
139 define('PARAM_FLOAT',  'float');
141 /**
142  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
143  */
144 define('PARAM_HOST',     'host');
146 /**
147  * PARAM_INT - integers only, use when expecting only numbers.
148  */
149 define('PARAM_INT',      'int');
151 /**
152  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
153  */
154 define('PARAM_LANG',  'lang');
156 /**
157  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the others! Implies PARAM_URL!)
158  */
159 define('PARAM_LOCALURL', 'localurl');
161 /**
162  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
163  */
164 define('PARAM_NOTAGS',   'notags');
166 /**
167  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
168  * note: the leading slash is not removed, window drive letter is not allowed
169  */
170 define('PARAM_PATH',     'path');
172 /**
173  * PARAM_PEM - Privacy Enhanced Mail format
174  */
175 define('PARAM_PEM',      'pem');
177 /**
178  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
179  */
180 define('PARAM_PERMISSION',   'permission');
182 /**
183  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way
184  */
185 define('PARAM_RAW', 'raw');
187 /**
188  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
189  */
190 define('PARAM_SAFEDIR',  'safedir');
192 /**
193  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
194  */
195 define('PARAM_SAFEPATH',  'safepath');
197 /**
198  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
199  */
200 define('PARAM_SEQUENCE',  'sequence');
202 /**
203  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
204  */
205 define('PARAM_TAG',   'tag');
207 /**
208  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
209  */
210 define('PARAM_TAGLIST',   'taglist');
212 /**
213  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
214  */
215 define('PARAM_TEXT',  'text');
217 /**
218  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
219  */
220 define('PARAM_THEME',  'theme');
222 /**
223  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not acceppted but http://localhost.localdomain/ is ok.
224  */
225 define('PARAM_URL',      'url');
227 /**
228  * PARAM_USERNAME - Clean username to only contains specified characters.
229  */
230 define('PARAM_USERNAME',    'username');
233 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
234 /**
235  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
236  * It was one of the first types, that is why it is abused so much ;-)
237  */
238 define('PARAM_CLEAN',    'clean');
240 /**
241  * PARAM_INTEGER - deprecated alias for PARAM_INT
242  */
243 define('PARAM_INTEGER',  'int');
245 /**
246  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
247  */
248 define('PARAM_NUMBER',  'float');
250 /**
251  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in formas and urls
252  * NOTE: originally alias for PARAM_APLHA
253  */
254 define('PARAM_ACTION',   'alphanumext');
256 /**
257  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
258  * NOTE: originally alias for PARAM_APLHA
259  */
260 define('PARAM_FORMAT',   'alphanumext');
262 /**
263  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
264  */
265 define('PARAM_MULTILANG',  'text');
267 /**
268  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
269  */
270 define('PARAM_CLEANFILE', 'file');
272 /// Web Services ///
274 /**
275  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
276  */
277 define('VALUE_REQUIRED', 1);
279 /**
280  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
281  */
282 define('VALUE_OPTIONAL', 2);
284 /**
285  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
286  */
287 define('VALUE_DEFAULT', 0);
289 /**
290  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
291  */
292 define('NULL_NOT_ALLOWED', false);
294 /**
295  * NULL_ALLOWED - the parameter can be set to null in the database
296  */
297 define('NULL_ALLOWED', true);
299 /// Page types ///
300 /**
301  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
302  */
303 define('PAGE_COURSE_VIEW', 'course-view');
305 /** Get remote addr constant */
306 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
307 /** Get remote addr constant */
308 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
310 /// Blog access level constant declaration ///
311 define ('BLOG_USER_LEVEL', 1);
312 define ('BLOG_GROUP_LEVEL', 2);
313 define ('BLOG_COURSE_LEVEL', 3);
314 define ('BLOG_SITE_LEVEL', 4);
315 define ('BLOG_GLOBAL_LEVEL', 5);
318 ///Tag constants///
319 /**
320  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
321  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
322  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
323  *
324  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
325  */
326 define('TAG_MAX_LENGTH', 50);
328 /// Password policy constants ///
329 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
330 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
331 define ('PASSWORD_DIGITS', '0123456789');
332 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
334 /// Feature constants ///
335 // Used for plugin_supports() to report features that are, or are not, supported by a module.
337 /** True if module can provide a grade */
338 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
339 /** True if module supports outcomes */
340 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
342 /** True if module has code to track whether somebody viewed it */
343 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
344 /** True if module has custom completion rules */
345 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
347 /** True if module supports outcomes */
348 define('FEATURE_IDNUMBER', 'idnumber');
349 /** True if module supports groups */
350 define('FEATURE_GROUPS', 'groups');
351 /** True if module supports groupings */
352 define('FEATURE_GROUPINGS', 'groupings');
353 /** True if module supports groupmembersonly */
354 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
356 /** Type of module */
357 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
358 /** True if module supports intro editor */
359 define('FEATURE_MOD_INTRO', 'mod_intro');
360 /** True if module has default completion */
361 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
363 define('FEATURE_COMMENT', 'comment');
365 define('FEATURE_RATE', 'rate');
366 /** True if module supports backup/restore of moodle2 format */
367 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
369 /** Unspecified module archetype */
370 define('MOD_ARCHETYPE_OTHER', 0);
371 /** Resource-like type module */
372 define('MOD_ARCHETYPE_RESOURCE', 1);
373 /** Assignemnt module archetype */
374 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
376 /**
377  * Security token used for allowing access
378  * from external application such as web services.
379  * Scripts do not use any session, performance is relatively
380  * low because we need to load access info in each request.
381  * Scrits are executed in parallel.
382  */
383 define('EXTERNAL_TOKEN_PERMANENT', 0);
385 /**
386  * Security token used for allowing access
387  * of embedded applications, the code is executed in the
388  * active user session. Token is invalidated after user logs out.
389  * Scripts are executed serially - normal session locking is used.
390  */
391 define('EXTERNAL_TOKEN_EMBEDDED', 1);
393 /// PARAMETER HANDLING ////////////////////////////////////////////////////
395 /**
396  * Returns a particular value for the named variable, taken from
397  * POST or GET.  If the parameter doesn't exist then an error is
398  * thrown because we require this variable.
399  *
400  * This function should be used to initialise all required values
401  * in a script that are based on parameters.  Usually it will be
402  * used like this:
403  *    $id = required_param('id', PARAM_INT);
404  *
405  * @param string $parname the name of the page parameter we want,
406  *                        default PARAM_CLEAN
407  * @param int $type expected type of parameter
408  * @return mixed
409  */
410 function required_param($parname, $type=PARAM_CLEAN) {
411     if (isset($_POST[$parname])) {       // POST has precedence
412         $param = $_POST[$parname];
413     } else if (isset($_GET[$parname])) {
414         $param = $_GET[$parname];
415     } else {
416         print_error('missingparam', '', '', $parname);
417     }
419     return clean_param($param, $type);
422 /**
423  * Returns a particular value for the named variable, taken from
424  * POST or GET, otherwise returning a given default.
425  *
426  * This function should be used to initialise all optional values
427  * in a script that are based on parameters.  Usually it will be
428  * used like this:
429  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
430  *
431  * @param string $parname the name of the page parameter we want
432  * @param mixed  $default the default value to return if nothing is found
433  * @param int $type expected type of parameter, default PARAM_CLEAN
434  * @return mixed
435  */
436 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
437     if (isset($_POST[$parname])) {       // POST has precedence
438         $param = $_POST[$parname];
439     } else if (isset($_GET[$parname])) {
440         $param = $_GET[$parname];
441     } else {
442         return $default;
443     }
445     return clean_param($param, $type);
448 /**
449  * Strict validation of parameter values, the values are only converted
450  * to requested PHP type. Internally it is using clean_param, the values
451  * before and after cleaning must be equal - otherwise
452  * an invalid_parameter_exception is thrown.
453  * Onjects and classes are not accepted.
454  *
455  * @param mixed $param
456  * @param int $type PARAM_ constant
457  * @param bool $allownull are nulls valid value?
458  * @param string $debuginfo optional debug information
459  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
460  */
461 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
462     if (is_null($param)) {
463         if ($allownull == NULL_ALLOWED) {
464             return null;
465         } else {
466             throw new invalid_parameter_exception($debuginfo);
467         }
468     }
469     if (is_array($param) or is_object($param)) {
470         throw new invalid_parameter_exception($debuginfo);
471     }
473     $cleaned = clean_param($param, $type);
474     if ((string)$param !== (string)$cleaned) {
475         // conversion to string is usually lossless
476         throw new invalid_parameter_exception($debuginfo);
477     }
479     return $cleaned;
482 /**
483  * Used by {@link optional_param()} and {@link required_param()} to
484  * clean the variables and/or cast to specific types, based on
485  * an options field.
486  * <code>
487  * $course->format = clean_param($course->format, PARAM_ALPHA);
488  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
489  * </code>
490  *
491  * @global object
492  * @uses PARAM_RAW
493  * @uses PARAM_CLEAN
494  * @uses PARAM_CLEANHTML
495  * @uses PARAM_INT
496  * @uses PARAM_FLOAT
497  * @uses PARAM_NUMBER
498  * @uses PARAM_ALPHA
499  * @uses PARAM_ALPHAEXT
500  * @uses PARAM_ALPHANUM
501  * @uses PARAM_ALPHANUMEXT
502  * @uses PARAM_SEQUENCE
503  * @uses PARAM_BOOL
504  * @uses PARAM_NOTAGS
505  * @uses PARAM_TEXT
506  * @uses PARAM_SAFEDIR
507  * @uses PARAM_SAFEPATH
508  * @uses PARAM_FILE
509  * @uses PARAM_PATH
510  * @uses PARAM_HOST
511  * @uses PARAM_URL
512  * @uses PARAM_LOCALURL
513  * @uses PARAM_PEM
514  * @uses PARAM_BASE64
515  * @uses PARAM_TAG
516  * @uses PARAM_SEQUENCE
517  * @uses PARAM_USERNAME
518  * @param mixed $param the variable we are cleaning
519  * @param int $type expected format of param after cleaning.
520  * @return mixed
521  */
522 function clean_param($param, $type) {
524     global $CFG;
526     if (is_array($param)) {              // Let's loop
527         $newparam = array();
528         foreach ($param as $key => $value) {
529             $newparam[$key] = clean_param($value, $type);
530         }
531         return $newparam;
532     }
534     switch ($type) {
535         case PARAM_RAW:          // no cleaning at all
536             return $param;
538         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
539             if (is_numeric($param)) {
540                 return $param;
541             }
542             return clean_text($param);     // Sweep for scripts, etc
544         case PARAM_CLEANHTML:    // prepare html fragment for display, do not store it into db!!
545             $param = clean_text($param);     // Sweep for scripts, etc
546             return trim($param);
548         case PARAM_INT:
549             return (int)$param;  // Convert to integer
551         case PARAM_FLOAT:
552         case PARAM_NUMBER:
553             return (float)$param;  // Convert to float
555         case PARAM_ALPHA:        // Remove everything not a-z
556             return preg_replace('/[^a-zA-Z]/i', '', $param);
558         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
559             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
561         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
562             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
564         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
565             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
567         case PARAM_SEQUENCE:     // Remove everything not 0-9,
568             return preg_replace('/[^0-9,]/i', '', $param);
570         case PARAM_BOOL:         // Convert to 1 or 0
571             $tempstr = strtolower($param);
572             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
573                 $param = 1;
574             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
575                 $param = 0;
576             } else {
577                 $param = empty($param) ? 0 : 1;
578             }
579             return $param;
581         case PARAM_NOTAGS:       // Strip all tags
582             return strip_tags($param);
584         case PARAM_TEXT:    // leave only tags needed for multilang
585             return clean_param(strip_tags($param, '<lang><span>'), PARAM_CLEAN);
587         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
588             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
590         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
591             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
593         case PARAM_FILE:         // Strip all suspicious characters from filename
594             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\/]~u', '', $param);
595             $param = preg_replace('~\.\.+~', '', $param);
596             if ($param === '.') {
597                 $param = '';
598             }
599             return $param;
601         case PARAM_PATH:         // Strip all suspicious characters from file path
602             $param = str_replace('\\', '/', $param);
603             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
604             $param = preg_replace('~\.\.+~', '', $param);
605             $param = preg_replace('~//+~', '/', $param);
606             return preg_replace('~/(\./)+~', '/', $param);
608         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
609             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
610             // match ipv4 dotted quad
611             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
612                 // confirm values are ok
613                 if ( $match[0] > 255
614                      || $match[1] > 255
615                      || $match[3] > 255
616                      || $match[4] > 255 ) {
617                     // hmmm, what kind of dotted quad is this?
618                     $param = '';
619                 }
620             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
621                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
622                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
623                        ) {
624                 // all is ok - $param is respected
625             } else {
626                 // all is not ok...
627                 $param='';
628             }
629             return $param;
631         case PARAM_URL:          // allow safe ftp, http, mailto urls
632             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
633             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
634                 // all is ok, param is respected
635             } else {
636                 $param =''; // not really ok
637             }
638             return $param;
640         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
641             $param = clean_param($param, PARAM_URL);
642             if (!empty($param)) {
643                 if (preg_match(':^/:', $param)) {
644                     // root-relative, ok!
645                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
646                     // absolute, and matches our wwwroot
647                 } else {
648                     // relative - let's make sure there are no tricks
649                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
650                         // looks ok.
651                     } else {
652                         $param = '';
653                     }
654                 }
655             }
656             return $param;
658         case PARAM_PEM:
659             $param = trim($param);
660             // PEM formatted strings may contain letters/numbers and the symbols
661             // forward slash: /
662             // plus sign:     +
663             // equal sign:    =
664             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
665             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
666                 list($wholething, $body) = $matches;
667                 unset($wholething, $matches);
668                 $b64 = clean_param($body, PARAM_BASE64);
669                 if (!empty($b64)) {
670                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
671                 } else {
672                     return '';
673                 }
674             }
675             return '';
677         case PARAM_BASE64:
678             if (!empty($param)) {
679                 // PEM formatted strings may contain letters/numbers and the symbols
680                 // forward slash: /
681                 // plus sign:     +
682                 // equal sign:    =
683                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
684                     return '';
685                 }
686                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
687                 // Each line of base64 encoded data must be 64 characters in
688                 // length, except for the last line which may be less than (or
689                 // equal to) 64 characters long.
690                 for ($i=0, $j=count($lines); $i < $j; $i++) {
691                     if ($i + 1 == $j) {
692                         if (64 < strlen($lines[$i])) {
693                             return '';
694                         }
695                         continue;
696                     }
698                     if (64 != strlen($lines[$i])) {
699                         return '';
700                     }
701                 }
702                 return implode("\n",$lines);
703             } else {
704                 return '';
705             }
707         case PARAM_TAG:
708             //as long as magic_quotes_gpc is used, a backslash will be a
709             //problem, so remove *all* backslash.
710             //$param = str_replace('\\', '', $param);
711             //remove some nasties
712             $param = preg_replace('~[[:cntrl:]]|[<>`]~', '', $param);
713             //convert many whitespace chars into one
714             $param = preg_replace('/\s+/', ' ', $param);
715             $textlib = textlib_get_instance();
716             $param = $textlib->substr(trim($param), 0, TAG_MAX_LENGTH);
717             return $param;
720         case PARAM_TAGLIST:
721             $tags = explode(',', $param);
722             $result = array();
723             foreach ($tags as $tag) {
724                 $res = clean_param($tag, PARAM_TAG);
725                 if ($res !== '') {
726                     $result[] = $res;
727                 }
728             }
729             if ($result) {
730                 return implode(',', $result);
731             } else {
732                 return '';
733             }
735         case PARAM_CAPABILITY:
736             if (get_capability_info($param)) {
737                 return $param;
738             } else {
739                 return '';
740             }
742         case PARAM_PERMISSION:
743             $param = (int)$param;
744             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
745                 return $param;
746             } else {
747                 return CAP_INHERIT;
748             }
750         case PARAM_AUTH:
751             $param = clean_param($param, PARAM_SAFEDIR);
752             if (exists_auth_plugin($param)) {
753                 return $param;
754             } else {
755                 return '';
756             }
758         case PARAM_LANG:
759             $param = clean_param($param, PARAM_SAFEDIR);
760             if (get_string_manager()->translation_exists($param)) {
761                 return $param;
762             } else {
763                 return ''; // Specified language is not installed or param malformed
764             }
766         case PARAM_THEME:
767             $param = clean_param($param, PARAM_SAFEDIR);
768             if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
769                 return $param;
770             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
771                 return $param;
772             } else {
773                 return '';  // Specified theme is not installed
774             }
776         case PARAM_USERNAME:
777             $param = str_replace(" " , "", $param);
778             $param = moodle_strtolower($param);  // Convert uppercase to lowercase MDL-16919
779             if (empty($CFG->extendedusernamechars)) {
780                 // regular expression, eliminate all chars EXCEPT:
781                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
782                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
783             }
784             return $param;
786         case PARAM_EMAIL:
787             if (validate_email($param)) {
788                 return $param;
789             } else {
790                 return '';
791             }
793         default:                 // throw error, switched parameters in optional_param or another serious problem
794             print_error("unknownparamtype", '', '', $type);
795     }
798 /**
799  * Return true if given value is integer or string with integer value
800  *
801  * @param mixed $value String or Int
802  * @return bool true if number, false if not
803  */
804 function is_number($value) {
805     if (is_int($value)) {
806         return true;
807     } else if (is_string($value)) {
808         return ((string)(int)$value) === $value;
809     } else {
810         return false;
811     }
814 /**
815  * Returns host part from url
816  * @param string $url full url
817  * @return string host, null if not found
818  */
819 function get_host_from_url($url) {
820     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
821     if ($matches) {
822         return $matches[1];
823     }
824     return null;
827 /**
828  * Tests whether anything was returned by text editor
829  *
830  * This function is useful for testing whether something you got back from
831  * the HTML editor actually contains anything. Sometimes the HTML editor
832  * appear to be empty, but actually you get back a <br> tag or something.
833  *
834  * @param string $string a string containing HTML.
835  * @return boolean does the string contain any actual content - that is text,
836  * images, objcts, etc.
837  */
838 function html_is_blank($string) {
839     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
842 /**
843  * Set a key in global configuration
844  *
845  * Set a key/value pair in both this session's {@link $CFG} global variable
846  * and in the 'config' database table for future sessions.
847  *
848  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
849  * In that case it doesn't affect $CFG.
850  *
851  * A NULL value will delete the entry.
852  *
853  * @global object
854  * @global object
855  * @param string $name the key to set
856  * @param string $value the value to set (without magic quotes)
857  * @param string $plugin (optional) the plugin scope, default NULL
858  * @return bool true or exception
859  */
860 function set_config($name, $value, $plugin=NULL) {
861     global $CFG, $DB;
863     if (empty($plugin)) {
864         if (!array_key_exists($name, $CFG->config_php_settings)) {
865             // So it's defined for this invocation at least
866             if (is_null($value)) {
867                 unset($CFG->$name);
868             } else {
869                 $CFG->$name = (string)$value; // settings from db are always strings
870             }
871         }
873         if ($DB->get_field('config', 'name', array('name'=>$name))) {
874             if ($value === null) {
875                 $DB->delete_records('config', array('name'=>$name));
876             } else {
877                 $DB->set_field('config', 'value', $value, array('name'=>$name));
878             }
879         } else {
880             if ($value !== null) {
881                 $config = new object();
882                 $config->name  = $name;
883                 $config->value = $value;
884                 $DB->insert_record('config', $config, false);
885             }
886         }
888     } else { // plugin scope
889         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
890             if ($value===null) {
891                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
892             } else {
893                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
894             }
895         } else {
896             if ($value !== null) {
897                 $config = new object();
898                 $config->plugin = $plugin;
899                 $config->name   = $name;
900                 $config->value  = $value;
901                 $DB->insert_record('config_plugins', $config, false);
902             }
903         }
904     }
906     return true;
909 /**
910  * Get configuration values from the global config table
911  * or the config_plugins table.
912  *
913  * If called with no parameters it will do the right thing
914  * generating $CFG safely from the database without overwriting
915  * existing values.
916  *
917  * If called with one parameter, it will load all the config
918  * variables for one pugin, and return them as an object.
919  *
920  * If called with 2 parameters it will return a $string single
921  * value or false of the value is not found.
922  *
923  * @global object
924  * @param string $plugin default NULL
925  * @param string $name default NULL
926  * @return mixed hash-like object or single value
927  */
928 function get_config($plugin=NULL, $name=NULL) {
929     global $CFG, $DB;
931     if (!empty($name)) { // the user is asking for a specific value
932         if (!empty($plugin)) {
933             return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
934         } else {
935             return $DB->get_field('config', 'value', array('name'=>$name));
936         }
937     }
939     // the user is after a recordset
940     if (!empty($plugin)) {
941         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
942         if (!empty($localcfg)) {
943             return (object)$localcfg;
944         } else {
945             return false;
946         }
947     } else {
948         // this was originally in setup.php
949         if ($configs = $DB->get_records('config')) {
950             $localcfg = (array)$CFG;
951             foreach ($configs as $config) {
952                 if (!isset($localcfg[$config->name])) {
953                     $localcfg[$config->name] = $config->value;
954                 }
955                 // do not complain anymore if config.php overrides settings from db
956             }
958             $localcfg = (object)$localcfg;
959             return $localcfg;
960         } else {
961             // preserve $CFG if DB returns nothing or error
962             return $CFG;
963         }
965     }
968 /**
969  * Removes a key from global configuration
970  *
971  * @param string $name the key to set
972  * @param string $plugin (optional) the plugin scope
973  * @global object
974  * @return boolean whether the operation succeeded.
975  */
976 function unset_config($name, $plugin=NULL) {
977     global $CFG, $DB;
979     if (empty($plugin)) {
980         unset($CFG->$name);
981         $DB->delete_records('config', array('name'=>$name));
982     } else {
983         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
984     }
986     return true;
989 /**
990  * Remove all the config variables for a given plugin.
991  *
992  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
993  * @return boolean whether the operation succeeded.
994  */
995 function unset_all_config_for_plugin($plugin) {
996     global $DB;
997     $DB->delete_records('config_plugins', array('plugin' => $plugin));
998     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
999     return true;
1002 /**
1003  * Use this funciton to get a list of users from a config setting of type admin_setting_users_with_capability.
1004  * @param string $value the value of the config setting.
1005  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1006  * @return array of user objects.
1007  */
1008 function get_users_from_config($value, $capability) {
1009     global $CFG;
1010     if ($value == '$@ALL@$') {
1011         $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1012     } else {
1013         list($where, $params) = $DB->get_in_or_equal(explode(',', $CFG->courserequestnotify));
1014         $params[] = $CFG->mnet_localhost_id;
1015         $users = $DB->get_records_select('user', 'username ' . $where . ' AND mnethostid = ?', $params);
1016     }
1017     return $users;
1020 /**
1021  * Get volatile flags
1022  *
1023  * @param string $type
1024  * @param int    $changedsince default null
1025  * @return records array
1026  */
1027 function get_cache_flags($type, $changedsince=NULL) {
1028     global $DB;
1030     $params = array('type'=>$type, 'expiry'=>time());
1031     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1032     if ($changedsince !== NULL) {
1033         $params['changedsince'] = $changedsince;
1034         $sqlwhere .= " AND timemodified > :changedsince";
1035     }
1036     $cf = array();
1038     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1039         foreach ($flags as $flag) {
1040             $cf[$flag->name] = $flag->value;
1041         }
1042     }
1043     return $cf;
1046 /**
1047  * Get volatile flags
1048  *
1049  * @param string $type
1050  * @param string $name
1051  * @param int    $changedsince default null
1052  * @return records array
1053  */
1054 function get_cache_flag($type, $name, $changedsince=NULL) {
1055     global $DB;
1057     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1059     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1060     if ($changedsince !== NULL) {
1061         $params['changedsince'] = $changedsince;
1062         $sqlwhere .= " AND timemodified > :changedsince";
1063     }
1065     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1068 /**
1069  * Set a volatile flag
1070  *
1071  * @param string $type the "type" namespace for the key
1072  * @param string $name the key to set
1073  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1074  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1075  * @return bool Always returns true
1076  */
1077 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1078     global $DB;
1080     $timemodified = time();
1081     if ($expiry===NULL || $expiry < $timemodified) {
1082         $expiry = $timemodified + 24 * 60 * 60;
1083     } else {
1084         $expiry = (int)$expiry;
1085     }
1087     if ($value === NULL) {
1088         unset_cache_flag($type,$name);
1089         return true;
1090     }
1092     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potentail problem in DEBUG_DEVELOPER
1093         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1094             return true; //no need to update; helps rcache too
1095         }
1096         $f->value        = $value;
1097         $f->expiry       = $expiry;
1098         $f->timemodified = $timemodified;
1099         $DB->update_record('cache_flags', $f);
1100     } else {
1101         $f = new object();
1102         $f->flagtype     = $type;
1103         $f->name         = $name;
1104         $f->value        = $value;
1105         $f->expiry       = $expiry;
1106         $f->timemodified = $timemodified;
1107         $DB->insert_record('cache_flags', $f);
1108     }
1109     return true;
1112 /**
1113  * Removes a single volatile flag
1114  *
1115  * @global object
1116  * @param string $type the "type" namespace for the key
1117  * @param string $name the key to set
1118  * @return bool
1119  */
1120 function unset_cache_flag($type, $name) {
1121     global $DB;
1122     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1123     return true;
1126 /**
1127  * Garbage-collect volatile flags
1128  *
1129  * @return bool Always returns true
1130  */
1131 function gc_cache_flags() {
1132     global $DB;
1133     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1134     return true;
1137 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1139 /**
1140  * Refresh current $USER session global variable with all their current preferences.
1141  *
1142  * @global object
1143  * @param mixed $time default null
1144  * @return void
1145  */
1146 function check_user_preferences_loaded($time = null) {
1147     global $USER, $DB;
1148     static $timenow = null; // Static cache, so we only check up-to-dateness once per request.
1150     if (!empty($USER->preference) && isset($USER->preference['_lastloaded'])) {
1151         // Already loaded. Are we up to date?
1153         if (is_null($timenow) || (!is_null($time) && $time != $timenow)) {
1154             $timenow = time();
1155             if (!get_cache_flag('userpreferenceschanged', $USER->id, $USER->preference['_lastloaded'])) {
1156                 // We are up-to-date.
1157                 return;
1158             }
1159         } else {
1160             // Already checked for up-to-date-ness.
1161             return;
1162         }
1163     }
1165     // OK, so we have to reload. Reset preference
1166     $USER->preference = array();
1168     if (!isloggedin() or isguestuser()) {
1169         // No permanent storage for not-logged-in user and guest
1171     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
1172         foreach ($preferences as $preference) {
1173             $USER->preference[$preference->name] = $preference->value;
1174         }
1175     }
1177     $USER->preference['_lastloaded'] = $timenow;
1180 /**
1181  * Called from set/delete_user_preferences, so that the prefs can be correctly reloaded.
1182  *
1183  * @global object
1184  * @global object
1185  * @param integer $userid the user whose prefs were changed.
1186  */
1187 function mark_user_preferences_changed($userid) {
1188     global $CFG, $USER;
1189     if ($userid == $USER->id) {
1190         check_user_preferences_loaded(time());
1191     }
1192     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1195 /**
1196  * Sets a preference for the current user
1197  *
1198  * Optionally, can set a preference for a different user object
1199  *
1200  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
1201  *
1202  * @global object
1203  * @global object
1204  * @param string $name The key to set as preference for the specified user
1205  * @param string $value The value to set forthe $name key in the specified user's record
1206  * @param int $otheruserid A moodle user ID, default null
1207  * @return bool
1208  */
1209 function set_user_preference($name, $value, $otheruserid=NULL) {
1210     global $USER, $DB;
1212     if (empty($name)) {
1213         return false;
1214     }
1216     $nostore = false;
1217     if (empty($otheruserid)){
1218         if (!isloggedin() or isguestuser()) {
1219             $nostore = true;
1220         }
1221         $userid = $USER->id;
1222     } else {
1223         if (isguestuser($otheruserid)) {
1224             $nostore = true;
1225         }
1226         $userid = $otheruserid;
1227     }
1229     if ($nostore) {
1230         // no permanent storage for not-logged-in user and guest
1232     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
1233         if ($preference->value === $value) {
1234             return true;
1235         }
1236         $DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id));
1238     } else {
1239         $preference = new object();
1240         $preference->userid = $userid;
1241         $preference->name   = $name;
1242         $preference->value  = (string)$value;
1243         $DB->insert_record('user_preferences', $preference);
1244     }
1246     mark_user_preferences_changed($userid);
1247     // update value in USER session if needed
1248     if ($userid == $USER->id) {
1249         $USER->preference[$name] = (string)$value;
1250         $USER->preference['_lastloaded'] = time();
1251     }
1253     return true;
1256 /**
1257  * Sets a whole array of preferences for the current user
1258  *
1259  * @param array $prefarray An array of key/value pairs to be set
1260  * @param int $otheruserid A moodle user ID
1261  * @return bool
1262  */
1263 function set_user_preferences($prefarray, $otheruserid=NULL) {
1265     if (!is_array($prefarray) or empty($prefarray)) {
1266         return false;
1267     }
1269     foreach ($prefarray as $name => $value) {
1270         set_user_preference($name, $value, $otheruserid);
1271     }
1272     return true;
1275 /**
1276  * Unsets a preference completely by deleting it from the database
1277  *
1278  * Optionally, can set a preference for a different user id
1279  *
1280  * @global object
1281  * @param string  $name The key to unset as preference for the specified user
1282  * @param int $otheruserid A moodle user ID
1283  */
1284 function unset_user_preference($name, $otheruserid=NULL) {
1285     global $USER, $DB;
1287     if (empty($otheruserid)){
1288         $userid = $USER->id;
1289         check_user_preferences_loaded();
1290     } else {
1291         $userid = $otheruserid;
1292     }
1294     //Then from DB
1295     $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
1297     mark_user_preferences_changed($userid);
1298     //Delete the preference from $USER if needed
1299     if ($userid == $USER->id) {
1300         unset($USER->preference[$name]);
1301         $USER->preference['_lastloaded'] = time();
1302     }
1304     return true;
1307 /**
1308  * Used to fetch user preference(s)
1309  *
1310  * If no arguments are supplied this function will return
1311  * all of the current user preferences as an array.
1312  *
1313  * If a name is specified then this function
1314  * attempts to return that particular preference value.  If
1315  * none is found, then the optional value $default is returned,
1316  * otherwise NULL.
1317  *
1318  * @global object
1319  * @global object
1320  * @param string $name Name of the key to use in finding a preference value
1321  * @param string $default Value to be returned if the $name key is not set in the user preferences
1322  * @param int $otheruserid A moodle user ID
1323  * @return string
1324  */
1325 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1326     global $USER, $DB;
1328     if (empty($otheruserid) || (isloggedin() && ($USER->id == $otheruserid))){
1329         check_user_preferences_loaded();
1331         if (empty($name)) {
1332             return $USER->preference; // All values
1333         } else if (array_key_exists($name, $USER->preference)) {
1334             return $USER->preference[$name]; // The single value
1335         } else {
1336             return $default; // Default value (or NULL)
1337         }
1339     } else {
1340         if (empty($name)) {
1341             return $DB->get_records_menu('user_preferences', array('userid'=>$otheruserid), '', 'name,value'); // All values
1342         } else if ($value = $DB->get_field('user_preferences', 'value', array('userid'=>$otheruserid, 'name'=>$name))) {
1343             return $value; // The single value
1344         } else {
1345             return $default; // Default value (or NULL)
1346         }
1347     }
1350 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1352 /**
1353  * Given date parts in user time produce a GMT timestamp.
1354  *
1355  * @todo Finish documenting this function
1356  * @param int $year The year part to create timestamp of
1357  * @param int $month The month part to create timestamp of
1358  * @param int $day The day part to create timestamp of
1359  * @param int $hour The hour part to create timestamp of
1360  * @param int $minute The minute part to create timestamp of
1361  * @param int $second The second part to create timestamp of
1362  * @param float $timezone Timezone modifier
1363  * @param bool $applydst Toggle Daylight Saving Time, default true
1364  * @return int timestamp
1365  */
1366 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1368     $strtimezone = NULL;
1369     if (!is_numeric($timezone)) {
1370         $strtimezone = $timezone;
1371     }
1373     $timezone = get_user_timezone_offset($timezone);
1375     if (abs($timezone) > 13) {
1376         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1377     } else {
1378         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1379         $time = usertime($time, $timezone);
1380         if($applydst) {
1381             $time -= dst_offset_on($time, $strtimezone);
1382         }
1383     }
1385     return $time;
1389 /**
1390  * Format a date/time (seconds) as weeks, days, hours etc as needed
1391  *
1392  * Given an amount of time in seconds, returns string
1393  * formatted nicely as weeks, days, hours etc as needed
1394  *
1395  * @uses MINSECS
1396  * @uses HOURSECS
1397  * @uses DAYSECS
1398  * @uses YEARSECS
1399  * @param int $totalsecs Time in seconds
1400  * @param object $str Should be a time object
1401  * @return string A nicely formatted date/time string
1402  */
1403  function format_time($totalsecs, $str=NULL) {
1405     $totalsecs = abs($totalsecs);
1407     if (!$str) {  // Create the str structure the slow way
1408         $str->day   = get_string('day');
1409         $str->days  = get_string('days');
1410         $str->hour  = get_string('hour');
1411         $str->hours = get_string('hours');
1412         $str->min   = get_string('min');
1413         $str->mins  = get_string('mins');
1414         $str->sec   = get_string('sec');
1415         $str->secs  = get_string('secs');
1416         $str->year  = get_string('year');
1417         $str->years = get_string('years');
1418     }
1421     $years     = floor($totalsecs/YEARSECS);
1422     $remainder = $totalsecs - ($years*YEARSECS);
1423     $days      = floor($remainder/DAYSECS);
1424     $remainder = $totalsecs - ($days*DAYSECS);
1425     $hours     = floor($remainder/HOURSECS);
1426     $remainder = $remainder - ($hours*HOURSECS);
1427     $mins      = floor($remainder/MINSECS);
1428     $secs      = $remainder - ($mins*MINSECS);
1430     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1431     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1432     $sh = ($hours == 1) ? $str->hour : $str->hours;
1433     $sd = ($days == 1)  ? $str->day  : $str->days;
1434     $sy = ($years == 1)  ? $str->year  : $str->years;
1436     $oyears = '';
1437     $odays = '';
1438     $ohours = '';
1439     $omins = '';
1440     $osecs = '';
1442     if ($years)  $oyears  = $years .' '. $sy;
1443     if ($days)  $odays  = $days .' '. $sd;
1444     if ($hours) $ohours = $hours .' '. $sh;
1445     if ($mins)  $omins  = $mins .' '. $sm;
1446     if ($secs)  $osecs  = $secs .' '. $ss;
1448     if ($years) return trim($oyears .' '. $odays);
1449     if ($days)  return trim($odays .' '. $ohours);
1450     if ($hours) return trim($ohours .' '. $omins);
1451     if ($mins)  return trim($omins .' '. $osecs);
1452     if ($secs)  return $osecs;
1453     return get_string('now');
1456 /**
1457  * Returns a formatted string that represents a date in user time
1458  *
1459  * Returns a formatted string that represents a date in user time
1460  * <b>WARNING: note that the format is for strftime(), not date().</b>
1461  * Because of a bug in most Windows time libraries, we can't use
1462  * the nicer %e, so we have to use %d which has leading zeroes.
1463  * A lot of the fuss in the function is just getting rid of these leading
1464  * zeroes as efficiently as possible.
1465  *
1466  * If parameter fixday = true (default), then take off leading
1467  * zero from %d, else mantain it.
1468  *
1469  * @param int $date the timestamp in UTC, as obtained from the database.
1470  * @param string $format strftime format. You should probably get this using
1471  *      get_string('strftime...', 'langconfig');
1472  * @param float $timezone by default, uses the user's time zone.
1473  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1474  *      If false then the leading zero is mantained.
1475  * @return string the formatted date/time.
1476  */
1477 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1479     global $CFG;
1481     $strtimezone = NULL;
1482     if (!is_numeric($timezone)) {
1483         $strtimezone = $timezone;
1484     }
1486     if (empty($format)) {
1487         $format = get_string('strftimedaydatetime', 'langconfig');
1488     }
1490     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1491         $fixday = false;
1492     } else if ($fixday) {
1493         $formatnoday = str_replace('%d', 'DD', $format);
1494         $fixday = ($formatnoday != $format);
1495     }
1497     $date += dst_offset_on($date, $strtimezone);
1499     $timezone = get_user_timezone_offset($timezone);
1501     if (abs($timezone) > 13) {   /// Server time
1502         if ($fixday) {
1503             $datestring = strftime($formatnoday, $date);
1504             $daystring  = str_replace(array(' 0', ' '), '', strftime(' %d', $date));
1505             $datestring = str_replace('DD', $daystring, $datestring);
1506         } else {
1507             $datestring = strftime($format, $date);
1508         }
1509     } else {
1510         $date += (int)($timezone * 3600);
1511         if ($fixday) {
1512             $datestring = gmstrftime($formatnoday, $date);
1513             $daystring  = str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date));
1514             $datestring = str_replace('DD', $daystring, $datestring);
1515         } else {
1516             $datestring = gmstrftime($format, $date);
1517         }
1518     }
1520 /// If we are running under Windows convert from windows encoding to UTF-8
1521 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1523    if ($CFG->ostype == 'WINDOWS') {
1524        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1525            $textlib = textlib_get_instance();
1526            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1527        }
1528    }
1530     return $datestring;
1533 /**
1534  * Given a $time timestamp in GMT (seconds since epoch),
1535  * returns an array that represents the date in user time
1536  *
1537  * @todo Finish documenting this function
1538  * @uses HOURSECS
1539  * @param int $time Timestamp in GMT
1540  * @param float $timezone ?
1541  * @return array An array that represents the date in user time
1542  */
1543 function usergetdate($time, $timezone=99) {
1545     $strtimezone = NULL;
1546     if (!is_numeric($timezone)) {
1547         $strtimezone = $timezone;
1548     }
1550     $timezone = get_user_timezone_offset($timezone);
1552     if (abs($timezone) > 13) {    // Server time
1553         return getdate($time);
1554     }
1556     // There is no gmgetdate so we use gmdate instead
1557     $time += dst_offset_on($time, $strtimezone);
1558     $time += intval((float)$timezone * HOURSECS);
1560     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1562     //be careful to ensure the returned array matches that produced by getdate() above
1563     list(
1564         $getdate['month'],
1565         $getdate['weekday'],
1566         $getdate['yday'],
1567         $getdate['year'],
1568         $getdate['mon'],
1569         $getdate['wday'],
1570         $getdate['mday'],
1571         $getdate['hours'],
1572         $getdate['minutes'],
1573         $getdate['seconds']
1574     ) = explode('_', $datestring);
1576     return $getdate;
1579 /**
1580  * Given a GMT timestamp (seconds since epoch), offsets it by
1581  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1582  *
1583  * @uses HOURSECS
1584  * @param  int $date Timestamp in GMT
1585  * @param float $timezone
1586  * @return int
1587  */
1588 function usertime($date, $timezone=99) {
1590     $timezone = get_user_timezone_offset($timezone);
1592     if (abs($timezone) > 13) {
1593         return $date;
1594     }
1595     return $date - (int)($timezone * HOURSECS);
1598 /**
1599  * Given a time, return the GMT timestamp of the most recent midnight
1600  * for the current user.
1601  *
1602  * @param int $date Timestamp in GMT
1603  * @param float $timezone Defaults to user's timezone
1604  * @return int Returns a GMT timestamp
1605  */
1606 function usergetmidnight($date, $timezone=99) {
1608     $userdate = usergetdate($date, $timezone);
1610     // Time of midnight of this user's day, in GMT
1611     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1615 /**
1616  * Returns a string that prints the user's timezone
1617  *
1618  * @param float $timezone The user's timezone
1619  * @return string
1620  */
1621 function usertimezone($timezone=99) {
1623     $tz = get_user_timezone($timezone);
1625     if (!is_float($tz)) {
1626         return $tz;
1627     }
1629     if(abs($tz) > 13) { // Server time
1630         return get_string('serverlocaltime');
1631     }
1633     if($tz == intval($tz)) {
1634         // Don't show .0 for whole hours
1635         $tz = intval($tz);
1636     }
1638     if($tz == 0) {
1639         return 'UTC';
1640     }
1641     else if($tz > 0) {
1642         return 'UTC+'.$tz;
1643     }
1644     else {
1645         return 'UTC'.$tz;
1646     }
1650 /**
1651  * Returns a float which represents the user's timezone difference from GMT in hours
1652  * Checks various settings and picks the most dominant of those which have a value
1653  *
1654  * @global object
1655  * @global object
1656  * @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
1657  * @return float
1658  */
1659 function get_user_timezone_offset($tz = 99) {
1661     global $USER, $CFG;
1663     $tz = get_user_timezone($tz);
1665     if (is_float($tz)) {
1666         return $tz;
1667     } else {
1668         $tzrecord = get_timezone_record($tz);
1669         if (empty($tzrecord)) {
1670             return 99.0;
1671         }
1672         return (float)$tzrecord->gmtoff / HOURMINS;
1673     }
1676 /**
1677  * Returns an int which represents the systems's timezone difference from GMT in seconds
1678  *
1679  * @global object
1680  * @param mixed $tz timezone
1681  * @return int if found, false is timezone 99 or error
1682  */
1683 function get_timezone_offset($tz) {
1684     global $CFG;
1686     if ($tz == 99) {
1687         return false;
1688     }
1690     if (is_numeric($tz)) {
1691         return intval($tz * 60*60);
1692     }
1694     if (!$tzrecord = get_timezone_record($tz)) {
1695         return false;
1696     }
1697     return intval($tzrecord->gmtoff * 60);
1700 /**
1701  * Returns a float or a string which denotes the user's timezone
1702  * 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)
1703  * means that for this timezone there are also DST rules to be taken into account
1704  * Checks various settings and picks the most dominant of those which have a value
1705  *
1706  * @global object
1707  * @global object
1708  * @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
1709  * @return mixed
1710  */
1711 function get_user_timezone($tz = 99) {
1712     global $USER, $CFG;
1714     $timezones = array(
1715         $tz,
1716         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1717         isset($USER->timezone) ? $USER->timezone : 99,
1718         isset($CFG->timezone) ? $CFG->timezone : 99,
1719         );
1721     $tz = 99;
1723     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1724         $tz = $next['value'];
1725     }
1727     return is_numeric($tz) ? (float) $tz : $tz;
1730 /**
1731  * Returns cached timezone record for given $timezonename
1732  *
1733  * @global object
1734  * @global object
1735  * @param string $timezonename
1736  * @return mixed timezonerecord object or false
1737  */
1738 function get_timezone_record($timezonename) {
1739     global $CFG, $DB;
1740     static $cache = NULL;
1742     if ($cache === NULL) {
1743         $cache = array();
1744     }
1746     if (isset($cache[$timezonename])) {
1747         return $cache[$timezonename];
1748     }
1750     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1751                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1754 /**
1755  * Build and store the users Daylight Saving Time (DST) table
1756  *
1757  * @global object
1758  * @global object
1759  * @global object
1760  * @param mixed $from_year Start year for the table, defaults to 1971
1761  * @param mixed $to_year End year for the table, defaults to 2035
1762  * @param mixed $strtimezone
1763  * @return bool
1764  */
1765 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1766     global $CFG, $SESSION, $DB;
1768     $usertz = get_user_timezone($strtimezone);
1770     if (is_float($usertz)) {
1771         // Trivial timezone, no DST
1772         return false;
1773     }
1775     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1776         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1777         unset($SESSION->dst_offsets);
1778         unset($SESSION->dst_range);
1779     }
1781     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1782         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1783         // This will be the return path most of the time, pretty light computationally
1784         return true;
1785     }
1787     // Reaching here means we either need to extend our table or create it from scratch
1789     // Remember which TZ we calculated these changes for
1790     $SESSION->dst_offsettz = $usertz;
1792     if(empty($SESSION->dst_offsets)) {
1793         // If we 're creating from scratch, put the two guard elements in there
1794         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1795     }
1796     if(empty($SESSION->dst_range)) {
1797         // If creating from scratch
1798         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1799         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1801         // Fill in the array with the extra years we need to process
1802         $yearstoprocess = array();
1803         for($i = $from; $i <= $to; ++$i) {
1804             $yearstoprocess[] = $i;
1805         }
1807         // Take note of which years we have processed for future calls
1808         $SESSION->dst_range = array($from, $to);
1809     }
1810     else {
1811         // If needing to extend the table, do the same
1812         $yearstoprocess = array();
1814         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1815         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1817         if($from < $SESSION->dst_range[0]) {
1818             // Take note of which years we need to process and then note that we have processed them for future calls
1819             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1820                 $yearstoprocess[] = $i;
1821             }
1822             $SESSION->dst_range[0] = $from;
1823         }
1824         if($to > $SESSION->dst_range[1]) {
1825             // Take note of which years we need to process and then note that we have processed them for future calls
1826             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1827                 $yearstoprocess[] = $i;
1828             }
1829             $SESSION->dst_range[1] = $to;
1830         }
1831     }
1833     if(empty($yearstoprocess)) {
1834         // This means that there was a call requesting a SMALLER range than we have already calculated
1835         return true;
1836     }
1838     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1839     // Also, the array is sorted in descending timestamp order!
1841     // Get DB data
1843     static $presets_cache = array();
1844     if (!isset($presets_cache[$usertz])) {
1845         $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');
1846     }
1847     if(empty($presets_cache[$usertz])) {
1848         return false;
1849     }
1851     // Remove ending guard (first element of the array)
1852     reset($SESSION->dst_offsets);
1853     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1855     // Add all required change timestamps
1856     foreach($yearstoprocess as $y) {
1857         // Find the record which is in effect for the year $y
1858         foreach($presets_cache[$usertz] as $year => $preset) {
1859             if($year <= $y) {
1860                 break;
1861             }
1862         }
1864         $changes = dst_changes_for_year($y, $preset);
1866         if($changes === NULL) {
1867             continue;
1868         }
1869         if($changes['dst'] != 0) {
1870             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1871         }
1872         if($changes['std'] != 0) {
1873             $SESSION->dst_offsets[$changes['std']] = 0;
1874         }
1875     }
1877     // Put in a guard element at the top
1878     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1879     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1881     // Sort again
1882     krsort($SESSION->dst_offsets);
1884     return true;
1887 /**
1888  * Calculates the required DST change and returns a Timestamp Array
1889  *
1890  * @uses HOURSECS
1891  * @uses MINSECS
1892  * @param mixed $year Int or String Year to focus on
1893  * @param object $timezone Instatiated Timezone object
1894  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
1895  */
1896 function dst_changes_for_year($year, $timezone) {
1898     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1899         return NULL;
1900     }
1902     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1903     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1905     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1906     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1908     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1909     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1911     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1912     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1913     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1915     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1916     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1918     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1921 /**
1922  * Calculates the Daylight Saving Offest for a given date/time (timestamp)
1923  *
1924  * @global object
1925  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
1926  * @return int
1927  */
1928 function dst_offset_on($time, $strtimezone = NULL) {
1929     global $SESSION;
1931     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
1932         return 0;
1933     }
1935     reset($SESSION->dst_offsets);
1936     while(list($from, $offset) = each($SESSION->dst_offsets)) {
1937         if($from <= $time) {
1938             break;
1939         }
1940     }
1942     // This is the normal return path
1943     if($offset !== NULL) {
1944         return $offset;
1945     }
1947     // Reaching this point means we haven't calculated far enough, do it now:
1948     // Calculate extra DST changes if needed and recurse. The recursion always
1949     // moves toward the stopping condition, so will always end.
1951     if($from == 0) {
1952         // We need a year smaller than $SESSION->dst_range[0]
1953         if($SESSION->dst_range[0] == 1971) {
1954             return 0;
1955         }
1956         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
1957         return dst_offset_on($time, $strtimezone);
1958     }
1959     else {
1960         // We need a year larger than $SESSION->dst_range[1]
1961         if($SESSION->dst_range[1] == 2035) {
1962             return 0;
1963         }
1964         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
1965         return dst_offset_on($time, $strtimezone);
1966     }
1969 /**
1970  * ?
1971  *
1972  * @todo Document what this function does
1973  * @param int $startday
1974  * @param int $weekday
1975  * @param int $month
1976  * @param int $year
1977  * @return int
1978  */
1979 function find_day_in_month($startday, $weekday, $month, $year) {
1981     $daysinmonth = days_in_month($month, $year);
1983     if($weekday == -1) {
1984         // Don't care about weekday, so return:
1985         //    abs($startday) if $startday != -1
1986         //    $daysinmonth otherwise
1987         return ($startday == -1) ? $daysinmonth : abs($startday);
1988     }
1990     // From now on we 're looking for a specific weekday
1992     // Give "end of month" its actual value, since we know it
1993     if($startday == -1) {
1994         $startday = -1 * $daysinmonth;
1995     }
1997     // Starting from day $startday, the sign is the direction
1999     if($startday < 1) {
2001         $startday = abs($startday);
2002         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2004         // This is the last such weekday of the month
2005         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2006         if($lastinmonth > $daysinmonth) {
2007             $lastinmonth -= 7;
2008         }
2010         // Find the first such weekday <= $startday
2011         while($lastinmonth > $startday) {
2012             $lastinmonth -= 7;
2013         }
2015         return $lastinmonth;
2017     }
2018     else {
2020         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
2022         $diff = $weekday - $indexweekday;
2023         if($diff < 0) {
2024             $diff += 7;
2025         }
2027         // This is the first such weekday of the month equal to or after $startday
2028         $firstfromindex = $startday + $diff;
2030         return $firstfromindex;
2032     }
2035 /**
2036  * Calculate the number of days in a given month
2037  *
2038  * @param int $month The month whose day count is sought
2039  * @param int $year The year of the month whose day count is sought
2040  * @return int
2041  */
2042 function days_in_month($month, $year) {
2043    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
2046 /**
2047  * Calculate the position in the week of a specific calendar day
2048  *
2049  * @param int $day The day of the date whose position in the week is sought
2050  * @param int $month The month of the date whose position in the week is sought
2051  * @param int $year The year of the date whose position in the week is sought
2052  * @return int
2053  */
2054 function dayofweek($day, $month, $year) {
2055     // I wonder if this is any different from
2056     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2057     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
2060 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2062 /**
2063  * Returns full login url.
2064  *
2065  * @global object
2066  * @param bool $loginguest add login guest param, return false
2067  * @return string login url
2068  */
2069 function get_login_url($loginguest=false) {
2070     global $CFG;
2072     if (empty($CFG->loginhttps) or $loginguest) { //do not require https for guest logins
2073         $loginguest = $loginguest ? '?loginguest=true' : '';
2074         $url = "$CFG->wwwroot/login/index.php$loginguest";
2076     } else {
2077         $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2078         $url = "$wwwroot/login/index.php";
2079     }
2081     return $url;
2084 /**
2085  * This function checks that the current user is logged in and has the
2086  * required privileges
2087  *
2088  * This function checks that the current user is logged in, and optionally
2089  * whether they are allowed to be in a particular course and view a particular
2090  * course module.
2091  * If they are not logged in, then it redirects them to the site login unless
2092  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2093  * case they are automatically logged in as guests.
2094  * If $courseid is given and the user is not enrolled in that course then the
2095  * user is redirected to the course enrolment page.
2096  * If $cm is given and the coursemodule is hidden and the user is not a teacher
2097  * in the course then the user is redirected to the course home page.
2098  *
2099  * When $cm parameter specified, this function sets page layout to 'module'.
2100  * You need to change it manually later if some other layout needed.
2101  *
2102  * @global object
2103  * @global object
2104  * @global object
2105  * @global object
2106  * @global string
2107  * @global object
2108  * @global object
2109  * @global object
2110  * @uses SITEID Define
2111  * @param mixed $courseorid id of the course or course object
2112  * @param bool $autologinguest default true
2113  * @param object $cm course module object
2114  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2115  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2116  *             in order to keep redirects working properly. MDL-14495
2117  * @return mixed Void, exit, and die depending on path
2118  */
2119 function require_login($courseorid=0, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2120     global $CFG, $SESSION, $USER, $COURSE, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2122 /// setup global $COURSE, themes, language and locale
2123     if (!empty($courseorid)) {
2124         if (is_object($courseorid)) {
2125             $course = $courseorid;
2126         } else if ($courseorid == SITEID) {
2127             $course = clone($SITE);
2128         } else {
2129             $course = $DB->get_record('course', array('id' => $courseorid));
2130             if (!$course) {
2131                 throw new moodle_exception('invalidcourseid');
2132             }
2133         }
2134         if ($cm) {
2135             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2136             $PAGE->set_pagelayout('incourse');
2137         } else {
2138             $PAGE->set_course($course); // set's up global $COURSE
2139         }
2140     } else {
2141         // do not touch global $COURSE via $PAGE->set_course() !!
2142     }
2144 /// If the user is not even logged in yet then make sure they are
2145     if (!isloggedin()) {
2146         //NOTE: $USER->site check was obsoleted by session test cookie,
2147         //      $USER->confirmed test is in login/index.php
2148         if ($setwantsurltome) {
2149             $SESSION->wantsurl = $FULLME;
2150         }
2151         if (!empty($_SERVER['HTTP_REFERER'])) {
2152             $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2153         }
2154         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests) and ($COURSE->id == SITEID or $COURSE->guest) ) {
2155             $loginguest = true;
2156         } else {
2157             $loginguest = false;
2158         }
2159         redirect(get_login_url($loginguest));
2160         exit; // never reached
2161     }
2163 /// loginas as redirection if needed
2164     if ($COURSE->id != SITEID and session_is_loggedinas()) {
2165         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2166             if ($USER->loginascontext->instanceid != $COURSE->id) {
2167                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2168             }
2169         }
2170     }
2172 /// check whether the user should be changing password (but only if it is REALLY them)
2173     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2174         $userauth = get_auth_plugin($USER->auth);
2175         if ($userauth->can_change_password()) {
2176             $SESSION->wantsurl = $FULLME;
2177             if ($changeurl = $userauth->change_password_url()) {
2178                 //use plugin custom url
2179                 redirect($changeurl);
2180             } else {
2181                 //use moodle internal method
2182                 if (empty($CFG->loginhttps)) {
2183                     redirect($CFG->wwwroot .'/login/change_password.php');
2184                 } else {
2185                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2186                     redirect($wwwroot .'/login/change_password.php');
2187                 }
2188             }
2189         } else {
2190             print_error('nopasswordchangeforced', 'auth');
2191         }
2192     }
2194 /// Check that the user account is properly set up
2195     if (user_not_fully_set_up($USER)) {
2196         $SESSION->wantsurl = $FULLME;
2197         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2198     }
2200 /// Make sure the USER has a sesskey set up.  Used for checking script parameters.
2201     sesskey();
2203     // Check that the user has agreed to a site policy if there is one
2204     if (!empty($CFG->sitepolicy)) {
2205         if (!$USER->policyagreed) {
2206             $SESSION->wantsurl = $FULLME;
2207             redirect($CFG->wwwroot .'/user/policy.php');
2208         }
2209     }
2211     // Fetch the system context, we are going to use it a lot.
2212     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2214 /// If the site is currently under maintenance, then print a message
2215     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2216         print_maintenance_message();
2217     }
2219 /// groupmembersonly access control
2220     if (!empty($CFG->enablegroupmembersonly) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2221         if (isguestuser() or !groups_has_membership($cm)) {
2222             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2223         }
2224     }
2226     // Fetch the course context, and prefetch its child contexts
2227     $coursecontext = get_context_instance(CONTEXT_COURSE, $COURSE->id, MUST_EXIST);
2228     if ($cm) {
2229         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2230     }
2232     // Conditional activity access control
2233     if (!empty($CFG->enableavailability) and $cm) {
2234         // We cache conditional access in session
2235         if (!isset($SESSION->conditionaccessok)) {
2236             $SESSION->conditionaccessok = array();
2237         }
2238         // If you have been allowed into the module once then you are allowed
2239         // in for rest of session, no need to do conditional checks
2240         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2241             // Get condition info (does a query for the availability table)
2242             require_once($CFG->libdir.'/conditionlib.php');
2243             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2244             // Check condition for user (this will do a query if the availability
2245             // information depends on grade or completion information)
2246             if ($ci->is_available($junk) || has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2247                 $SESSION->conditionaccessok[$cm->id] = true;
2248             } else {
2249                 print_error('activityiscurrentlyhidden');
2250             }
2251         }
2252     }
2254     if ($COURSE->id == SITEID) {
2255         /// Eliminate hidden site activities straight away
2256         if ($cm && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2257             redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2258         }
2259         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2260         return;
2262     } else {
2264         /// Check if the user can be in a particular course
2265         if (empty($USER->access['rsw'][$coursecontext->path])) {
2266             //
2267             // MDL-13900 - If the course or the parent category are hidden
2268             // and the user hasn't the 'course:viewhiddencourses' capability, prevent access
2269             //
2270             if ( !($COURSE->visible && course_parent_visible($COURSE)) && !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2271                 echo $OUTPUT->header();
2272                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2273             }
2274         }
2276         if (is_enrolled($coursecontext) or is_viewing($coursecontext)) {
2277             // Enrolled user or allowed to visit course (managers, inspectors, etc.)
2278             if (session_is_loggedinas()) {   // Make sure the REAL person can also access this course
2279                 $realuser = session_get_realuser();
2280                 if (!is_enrolled($coursecontext, $realuser->id) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2281                     echo $OUTPUT->header();
2282                     notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2283                 }
2284             }
2286             // Make sure they can read this activity too, if specified
2287             if ($cm && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2288                 redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course, get_string('activityiscurrentlyhidden'));
2289             }
2290             user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2291             return;   // User is allowed to see this course
2293         } else {
2294             // guest access
2295             switch ($COURSE->guest) {    /// Check course policy about guest access
2297                 case 1:    /// Guests always allowed
2298                     if ($cm and !$cm->visible) { // Not allowed to see module, send to course page
2299                         redirect($CFG->wwwroot.'/course/view.php?id='.$cm->course,
2300                                  get_string('activityiscurrentlyhidden'));
2301                     }
2303                     if ($USER->username != 'guest' and !empty($CFG->guestroleid)) {
2304                         // Non-guests who don't currently have access, check if they can be allowed in as a guest
2305                         // Temporarily assign them guest role for this context, if it fails later user is asked to enrol
2306                         $USER->access = load_temp_role($coursecontext, $CFG->guestroleid, $USER->access);
2307                     }
2309                     user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2310                     return;   // User is allowed to see this course
2312                 case 2:    /// Guests allowed with key
2313                     if (!empty($USER->enrolkey[$COURSE->id])) {   // Set by enrol/manual/enrol.php
2314                         user_accesstime_log($COURSE->id); /// Access granted, update lastaccess times
2315                         return true;
2316                     }
2317                     //  otherwise drop through to logic below (--> enrol.php)
2318                     break;
2320                 default:    /// Guests not allowed
2321                     $strloggedinasguest = get_string('loggedinasguest');
2322                     $PAGE->navbar->add($strloggedinasguest);
2323                     echo $OUTPUT->header();
2324                     if (empty($USER->access['rsw'][$coursecontext->path])) {  // Normal guest
2325                         notice(get_string('guestsnotallowed', '', format_string($COURSE->fullname)), get_login_url());
2326                     } else {
2327                         echo $OUTPUT->notification(get_string('guestsnotallowed', '', format_string($COURSE->fullname)));
2328                         echo '<div class="notifyproblem">'.switchroles_form($COURSE->id).'</div>';
2329                         echo $OUTPUT->footer();
2330                         exit;
2331                     }
2332                     break;
2333             }
2334         }
2336         // Currently not enrolled in the course, so see if they want to enrol
2337         $SESSION->wantsurl = $FULLME;
2338         redirect($CFG->wwwroot .'/course/enrol.php?id='. $COURSE->id);
2339         die;
2340     }
2344 /**
2345  * This function just makes sure a user is logged out.
2346  *
2347  * @global object
2348  */
2349 function require_logout() {
2350     global $USER;
2352     if (isloggedin()) {
2353         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2355         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2356         foreach($authsequence as $authname) {
2357             $authplugin = get_auth_plugin($authname);
2358             $authplugin->prelogout_hook();
2359         }
2360     }
2362     session_get_instance()->terminate_current();
2365 /**
2366  * Weaker version of require_login()
2367  *
2368  * This is a weaker version of {@link require_login()} which only requires login
2369  * when called from within a course rather than the site page, unless
2370  * the forcelogin option is turned on.
2371  * @see require_login()
2372  *
2373  * @global object
2374  * @param mixed $courseorid The course object or id in question
2375  * @param bool $autologinguest Allow autologin guests if that is wanted
2376  * @param object $cm Course activity module if known
2377  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2378  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2379  *             in order to keep redirects working properly. MDL-14495
2380  */
2381 function require_course_login($courseorid, $autologinguest=true, $cm=null, $setwantsurltome=true) {
2382     global $CFG, $PAGE, $SITE;
2383     if (!empty($CFG->forcelogin)) {
2384         // login required for both SITE and courses
2385         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2387     } else if (!empty($cm) and !$cm->visible) {
2388         // always login for hidden activities
2389         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2391     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2392           or (!is_object($courseorid) and $courseorid == SITEID)) {
2393               //login for SITE not required
2394         if ($cm and empty($cm->visible)) {
2395             // hidden activities are not accessible without login
2396             require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2397         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2398             // not-logged-in users do not have any group membership
2399             require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2400         } else {
2401             // We still need to instatiate PAGE vars properly so that things
2402             // that rely on it like navigation function correctly.
2403             if (!empty($courseorid)) {
2404                 if (is_object($courseorid)) {
2405                     $course = $courseorid;
2406                 } else {
2407                     $course = clone($SITE);
2408                 }
2409                 if ($cm) {
2410                     $PAGE->set_cm($cm, $course);
2411                     $PAGE->set_pagelayout('incourse');
2412                 } else {
2413                     $PAGE->set_course($course);
2414                 }
2415             } else {
2416                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2417                 // up properly, set them up now.
2418                 $PAGE->set_course($PAGE->course);
2419             }
2420             //TODO: verify conditional activities here
2421             user_accesstime_log(SITEID);
2422             return;
2423         }
2425     } else {
2426         // course login always required
2427         require_login($courseorid, $autologinguest, $cm, $setwantsurltome);
2428     }
2431 /**
2432  * Require key login. Function terminates with error if key not found or incorrect.
2433  *
2434  * @global object
2435  * @global object
2436  * @global object
2437  * @global object
2438  * @uses NO_MOODLE_COOKIES
2439  * @uses PARAM_ALPHANUM
2440  * @param string $script unique script identifier
2441  * @param int $instance optional instance id
2442  * @return int Instance ID
2443  */
2444 function require_user_key_login($script, $instance=null) {
2445     global $USER, $SESSION, $CFG, $DB;
2447     if (!NO_MOODLE_COOKIES) {
2448         print_error('sessioncookiesdisable');
2449     }
2451 /// extra safety
2452     @session_write_close();
2454     $keyvalue = required_param('key', PARAM_ALPHANUM);
2456     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2457         print_error('invalidkey');
2458     }
2460     if (!empty($key->validuntil) and $key->validuntil < time()) {
2461         print_error('expiredkey');
2462     }
2464     if ($key->iprestriction) {
2465         $remoteaddr = getremoteaddr();
2466         if ($remoteaddr == '' or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2467             print_error('ipmismatch');
2468         }
2469     }
2471     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2472         print_error('invaliduserid');
2473     }
2475 /// emulate normal session
2476     session_set_user($user);
2478 /// note we are not using normal login
2479     if (!defined('USER_KEY_LOGIN')) {
2480         define('USER_KEY_LOGIN', true);
2481     }
2483 /// return isntance id - it might be empty
2484     return $key->instance;
2487 /**
2488  * Creates a new private user access key.
2489  *
2490  * @global object
2491  * @param string $script unique target identifier
2492  * @param int $userid
2493  * @param int $instance optional instance id
2494  * @param string $iprestriction optional ip restricted access
2495  * @param timestamp $validuntil key valid only until given data
2496  * @return string access key value
2497  */
2498 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2499     global $DB;
2501     $key = new object();
2502     $key->script        = $script;
2503     $key->userid        = $userid;
2504     $key->instance      = $instance;
2505     $key->iprestriction = $iprestriction;
2506     $key->validuntil    = $validuntil;
2507     $key->timecreated   = time();
2509     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2510     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2511         // must be unique
2512         $key->value     = md5($userid.'_'.time().random_string(40));
2513     }
2514     $DB->insert_record('user_private_key', $key);
2515     return $key->value;
2518 /**
2519  * Modify the user table by setting the currently logged in user's
2520  * last login to now.
2521  *
2522  * @global object
2523  * @global object
2524  * @return bool Always returns true
2525  */
2526 function update_user_login_times() {
2527     global $USER, $DB;
2529     $user = new object();
2530     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2531     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2533     $user->id = $USER->id;
2535     $DB->update_record('user', $user);
2536     return true;
2539 /**
2540  * Determines if a user has completed setting up their account.
2541  *
2542  * @param user $user A {@link $USER} object to test for the existance of a valid name and email
2543  * @return bool
2544  */
2545 function user_not_fully_set_up($user) {
2546     return ($user->username != 'guest' and (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user)));
2549 /**
2550  * Check whether the user has exceeded the bounce threshold
2551  *
2552  * @global object
2553  * @global object
2554  * @param user $user A {@link $USER} object
2555  * @return bool true=>User has exceeded bounce threshold
2556  */
2557 function over_bounce_threshold($user) {
2558     global $CFG, $DB;
2560     if (empty($CFG->handlebounces)) {
2561         return false;
2562     }
2564     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2565         return false;
2566     }
2568     // set sensible defaults
2569     if (empty($CFG->minbounces)) {
2570         $CFG->minbounces = 10;
2571     }
2572     if (empty($CFG->bounceratio)) {
2573         $CFG->bounceratio = .20;
2574     }
2575     $bouncecount = 0;
2576     $sendcount = 0;
2577     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2578         $bouncecount = $bounce->value;
2579     }
2580     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2581         $sendcount = $send->value;
2582     }
2583     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2586 /**
2587  * Used to increment or reset email sent count
2588  *
2589  * @global object
2590  * @param user $user object containing an id
2591  * @param bool $reset will reset the count to 0
2592  * @return void
2593  */
2594 function set_send_count($user,$reset=false) {
2595     global $DB;
2597     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2598         return;
2599     }
2601     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2602         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2603         $DB->update_record('user_preferences', $pref);
2604     }
2605     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2606         // make a new one
2607         $pref = new object();
2608         $pref->name   = 'email_send_count';
2609         $pref->value  = 1;
2610         $pref->userid = $user->id;
2611         $DB->insert_record('user_preferences', $pref, false);
2612     }
2615 /**
2616  * Increment or reset user's email bounce count
2617  *
2618  * @global object
2619  * @param user $user object containing an id
2620  * @param bool $reset will reset the count to 0
2621  */
2622 function set_bounce_count($user,$reset=false) {
2623     global $DB;
2625     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2626         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2627         $DB->update_record('user_preferences', $pref);
2628     }
2629     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2630         // make a new one
2631         $pref = new object();
2632         $pref->name   = 'email_bounce_count';
2633         $pref->value  = 1;
2634         $pref->userid = $user->id;
2635         $DB->insert_record('user_preferences', $pref, false);
2636     }
2639 /**
2640  * Keeps track of login attempts
2641  *
2642  * @global object
2643  */
2644 function update_login_count() {
2645     global $SESSION;
2647     $max_logins = 10;
2649     if (empty($SESSION->logincount)) {
2650         $SESSION->logincount = 1;
2651     } else {
2652         $SESSION->logincount++;
2653     }
2655     if ($SESSION->logincount > $max_logins) {
2656         unset($SESSION->wantsurl);
2657         print_error('errortoomanylogins');
2658     }
2661 /**
2662  * Resets login attempts
2663  *
2664  * @global object
2665  */
2666 function reset_login_count() {
2667     global $SESSION;
2669     $SESSION->logincount = 0;
2672 /**
2673  * Sync all meta courses
2674  * Goes through all enrolment records for the courses inside all metacourses and syncs with them.
2675  * @see sync_metacourse()
2676  *
2677  * @global object
2678  */
2679 function sync_metacourses() {
2680     global $DB;
2682     if (!$courses = $DB->get_records('course', array('metacourse'=>1))) {
2683         return;
2684     }
2686     foreach ($courses as $course) {
2687         sync_metacourse($course);
2688     }
2691 /**
2692  * Returns reference to full info about modules in course (including visibility).
2693  * Cached and as fast as possible (0 or 1 db query).
2694  *
2695  * @global object
2696  * @global object
2697  * @global object
2698  * @uses CONTEXT_MODULE
2699  * @uses MAX_MODINFO_CACHE_SIZE
2700  * @param mixed $course object or 'reset' string to reset caches, modinfo may be updated in db
2701  * @param int $userid Defaults to current user id
2702  * @return mixed courseinfo object or nothing if resetting
2703  */
2704 function &get_fast_modinfo(&$course, $userid=0) {
2705     global $CFG, $USER, $DB;
2706     require_once($CFG->dirroot.'/course/lib.php');
2708     if (!empty($CFG->enableavailability)) {
2709         require_once($CFG->libdir.'/conditionlib.php');
2710     }
2712     static $cache = array();
2714     if ($course === 'reset') {
2715         $cache = array();
2716         $nothing = null;
2717         return $nothing; // we must return some reference
2718     }
2720     if (empty($userid)) {
2721         $userid = $USER->id;
2722     }
2724     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
2725         return $cache[$course->id];
2726     }
2728     if (empty($course->modinfo)) {
2729         // no modinfo yet - load it
2730         rebuild_course_cache($course->id);
2731         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2732     }
2734     $modinfo = new object();
2735     $modinfo->courseid  = $course->id;
2736     $modinfo->userid    = $userid;
2737     $modinfo->sections  = array();
2738     $modinfo->cms       = array();
2739     $modinfo->instances = array();
2740     $modinfo->groups    = null; // loaded only when really needed - the only one db query
2742     $info = unserialize($course->modinfo);
2743     if (!is_array($info)) {
2744         // hmm, something is wrong - lets try to fix it
2745         rebuild_course_cache($course->id);
2746         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2747         $info = unserialize($course->modinfo);
2748         if (!is_array($info)) {
2749             return $modinfo;
2750         }
2751     }
2753     if ($info) {
2754         // detect if upgrade required
2755         $first = reset($info);
2756         if (!isset($first->id)) {
2757             rebuild_course_cache($course->id);
2758             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2759             $info = unserialize($course->modinfo);
2760             if (!is_array($info)) {
2761                 return $modinfo;
2762             }
2763         }
2764     }
2766     $modlurals = array();
2768     // If we haven't already preloaded contexts for the course, do it now
2769     preload_course_contexts($course->id);
2771     foreach ($info as $mod) {
2772         if (empty($mod->name)) {
2773             // something is wrong here
2774             continue;
2775         }
2776         // reconstruct minimalistic $cm
2777         $cm = new object();
2778         $cm->id               = $mod->cm;
2779         $cm->instance         = $mod->id;
2780         $cm->course           = $course->id;
2781         $cm->modname          = $mod->mod;
2782         $cm->name             = $mod->name;
2783         $cm->visible          = $mod->visible;
2784         $cm->sectionnum       = $mod->section;
2785         $cm->groupmode        = $mod->groupmode;
2786         $cm->groupingid       = $mod->groupingid;
2787         $cm->groupmembersonly = $mod->groupmembersonly;
2788         $cm->indent           = $mod->indent;
2789         $cm->completion       = $mod->completion;
2790         $cm->extra            = isset($mod->extra) ? $mod->extra : '';
2791         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
2792         $cm->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
2793         $cm->uservisible      = true;
2794         if(!empty($CFG->enableavailability)) {
2795             // We must have completion information from modinfo. If it's not
2796             // there, cache needs rebuilding
2797             if(!isset($mod->availablefrom)) {
2798                 debugging('enableavailability option was changed; rebuilding '.
2799                     'cache for course '.$course->id);
2800                 rebuild_course_cache($course->id,true);
2801                 // Re-enter this routine to do it all properly
2802                 return get_fast_modinfo($course,$userid);
2803             }
2804             $cm->availablefrom    = $mod->availablefrom;
2805             $cm->availableuntil   = $mod->availableuntil;
2806             $cm->showavailability = $mod->showavailability;
2807             $cm->conditionscompletion = $mod->conditionscompletion;
2808             $cm->conditionsgrade  = $mod->conditionsgrade;
2809         }
2811         // preload long names plurals and also check module is installed properly
2812         if (!isset($modlurals[$cm->modname])) {
2813             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
2814                 continue;
2815             }
2816             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
2817         }
2818         $cm->modplural = $modlurals[$cm->modname];
2819         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
2821         if(!empty($CFG->enableavailability)) {
2822             // Unfortunately the next call really wants to call
2823             // get_fast_modinfo, but that would be recursive, so we fake up a
2824             // modinfo for it already
2825             if(empty($minimalmodinfo)) {
2826                 $minimalmodinfo=new stdClass();
2827                 $minimalmodinfo->cms=array();
2828                 foreach($info as $mod) {
2829                     if (empty($mod->name)) {
2830                         // something is wrong here
2831                         continue;
2832                     }
2833                     $minimalcm = new stdClass();
2834                     $minimalcm->id = $mod->cm;
2835                     $minimalcm->name = $mod->name;
2836                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
2837                 }
2838             }
2840             // Get availability information
2841             $ci = new condition_info($cm);
2842             $cm->available=$ci->is_available($cm->availableinfo, true, $userid, $minimalmodinfo);
2843         } else {
2844             $cm->available=true;
2845         }
2846         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
2847             $cm->uservisible = false;
2849         } else if (!empty($CFG->enablegroupmembersonly) and !empty($cm->groupmembersonly)
2850                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
2851             if (is_null($modinfo->groups)) {
2852                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
2853             }
2854             if (empty($modinfo->groups[$cm->groupingid])) {
2855                 $cm->uservisible = false;
2856             }
2857         }
2859         if (!isset($modinfo->instances[$cm->modname])) {
2860             $modinfo->instances[$cm->modname] = array();
2861         }
2862         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
2863         $modinfo->cms[$cm->id] =& $cm;
2865         // reconstruct sections
2866         if (!isset($modinfo->sections[$cm->sectionnum])) {
2867             $modinfo->sections[$cm->sectionnum] = array();
2868         }
2869         $modinfo->sections[$cm->sectionnum][] = $cm->id;
2871         unset($cm);
2872     }
2874     unset($cache[$course->id]); // prevent potential reference problems when switching users
2875     $cache[$course->id] = $modinfo;
2877     // Ensure cache does not use too much RAM
2878     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
2879         reset($cache);
2880         $key = key($cache);
2881         unset($cache[$key]);
2882     }
2884     return $cache[$course->id];
2887 /**
2888  * Goes through all enrolment records for the courses inside the metacourse and sync with them.
2889  *
2890  * @todo finish timeend and timestart maybe we could rely on cron
2891  *       job to do the cleaning from time to time
2892  *
2893  * @global object
2894  * @global object
2895  * @uses CONTEXT_COURSE
2896  * @param mixed $course the metacourse to synch. Either the course object itself, or the courseid.
2897  * @return bool Success
2898  */
2899 function sync_metacourse($course) {
2900     global $CFG, $DB;
2902     // Check the course is valid.
2903     if (!is_object($course)) {
2904         if (!$course = $DB->get_record('course', array('id'=>$course))) {
2905             return false; // invalid course id
2906         }
2907     }
2909     // Check that we actually have a metacourse.
2910     if (empty($course->metacourse)) {
2911         return false;
2912     }
2914     // Get a list of roles that should not be synced.
2915     if (!empty($CFG->nonmetacoursesyncroleids)) {
2916         $roleexclusions = 'ra.roleid NOT IN (' . $CFG->nonmetacoursesyncroleids . ') AND';
2917     } else {
2918         $roleexclusions = '';
2919     }
2921     // Get the context of the metacourse.
2922     $context = get_context_instance(CONTEXT_COURSE, $course->id); // SITEID can not be a metacourse
2924     // We do not ever want to unassign the list of metacourse manager, so get a list of them.
2925     if ($users = get_users_by_capability($context, 'moodle/course:managemetacourse')) {
2926         $managers = array_keys($users);
2927     } else {
2928         $managers = array();
2929     }
2931     // Get assignments of a user to a role that exist in a child course, but
2932     // not in the meta coure. That is, get a list of the assignments that need to be made.
2933     if (!$assignments = $DB->get_records_sql("
2934             SELECT ra.id, ra.roleid, ra.userid
2935               FROM {role_assignments} ra, {context} con, {course_meta} cm
2936              WHERE ra.contextid = con.id AND
2937                    con.contextlevel = ".CONTEXT_COURSE." AND
2938                    con.instanceid = cm.child_course AND
2939                    cm.parent_course = ? AND
2940                    $roleexclusions
2941                    NOT EXISTS (
2942                      SELECT 1
2943                        FROM {role_assignments} ra2
2944                       WHERE ra2.userid = ra.userid AND
2945                             ra2.roleid = ra.roleid AND
2946                             ra2.contextid = ?
2947                   )", array($course->id, $context->id))) {
2948         $assignments = array();
2949     }
2951     // Get assignments of a user to a role that exist in the meta course, but
2952     // not in any child courses. That is, get a list of the unassignments that need to be made.
2953     if (!$unassignments = $DB->get_records_sql("
2954             SELECT ra.id, ra.roleid, ra.userid
2955               FROM {role_assignments} ra
2956              WHERE ra.contextid = ? AND
2957                    $roleexclusions
2958                    NOT EXISTS (
2959                     SELECT 1
2960                       FROM {role_assignments} ra2, {context} con2, {course_meta} cm
2961                     WHERE ra2.userid = ra.userid AND
2962                           ra2.roleid = ra.roleid AND
2963                           ra2.contextid = con2.id AND
2964                           con2.contextlevel = " . CONTEXT_COURSE . " AND
2965                           con2.instanceid = cm.child_course AND
2966                           cm.parent_course = ?
2967                   )", array($context->id, $course->id))) {
2968         $unassignments = array();
2969     }
2971     $success = true;
2973     // Make the unassignments, if they are not managers.
2974     foreach ($unassignments as $unassignment) {
2975         if (!in_array($unassignment->userid, $managers)) {
2976             $success = role_unassign($unassignment->roleid, $unassignment->userid, 0, $context->id) && $success;
2977         }
2978     }
2980     // Make the assignments.
2981     foreach ($assignments as $assignment) {
2982         $success = role_assign($assignment->roleid, $assignment->userid, 0, $context->id, 0, 0) && $success;
2983     }
2985     return $success;
2987 // TODO: finish timeend and timestart
2988 // maybe we could rely on cron job to do the cleaning from time to time
2991 /**
2992  * Adds a record to the metacourse table and calls sync_metacoures
2993  *
2994  * @global object
2995  * @param int $metacourseid The Metacourse ID for the metacourse to add to
2996  * @param int $courseid The Course ID of the course to add
2997  * @return bool Success
2998  */
2999 function add_to_metacourse ($metacourseid, $courseid) {
3000     global $DB;
3002     if (!$metacourse = $DB->get_record("course", array("id"=>$metacourseid))) {
3003         return false;
3004     }
3006     if (!$course = $DB->get_record("course", array("id"=>$courseid))) {
3007         return false;
3008     }
3010     if (!$record = $DB->get_record("course_meta", array("parent_course"=>$metacourseid, "child_course"=>$courseid))) {
3011         $rec = new object();
3012         $rec->parent_course = $metacourseid;
3013         $rec->child_course  = $courseid;
3014         $DB->insert_record('course_meta', $rec);
3015         return sync_metacourse($metacourseid);
3016     }
3017     return true;
3021 /**
3022  * Removes the record from the metacourse table and calls sync_metacourse
3023  *
3024  * @global object
3025  * @param int $metacourseid The Metacourse ID for the metacourse to remove from
3026  * @param int $courseid The Course ID of the course to remove
3027  * @return bool Success
3028  */
3029 function remove_from_metacourse($metacourseid, $courseid) {
3030     global $DB;
3032     if ($DB->delete_records('course_meta', array('parent_course'=>$metacourseid, 'child_course'=>$courseid))) {
3033         return sync_metacourse($metacourseid);
3034     }
3035     return false;
3038 /**
3039  * Determines if the currently logged in user is in editing mode.
3040  * Note: originally this function had $userid parameter - it was not usable anyway
3041  *
3042  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3043  * @todo Deprecated function remove when ready
3044  *
3045  * @global object
3046  * @uses DEBUG_DEVELOPER
3047  * @return bool
3048  */
3049 function isediting() {
3050     global $PAGE;
3051     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3052     return $PAGE->user_is_editing();
3055 /**
3056  * Determines if the logged in user is currently moving an activity
3057  *
3058  * @global object
3059  * @param int $courseid The id of the course being tested
3060  * @return bool
3061  */
3062 function ismoving($courseid) {
3063     global $USER;
3065     if (!empty($USER->activitycopy)) {
3066         return ($USER->activitycopycourse == $courseid);
3067     }
3068     return false;
3071 /**
3072  * Returns a persons full name
3073  *
3074  * Given an object containing firstname and lastname
3075  * values, this function returns a string with the
3076  * full name of the person.
3077  * The result may depend on system settings
3078  * or language.  'override' will force both names
3079  * to be used even if system settings specify one.
3080  *
3081  * @global object
3082  * @global object
3083  * @param object $user A {@link $USER} object to get full name of
3084  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3085  * @return string
3086  */
3087 function fullname($user, $override=false) {
3088     global $CFG, $SESSION;
3090     if (!isset($user->firstname) and !isset($user->lastname)) {
3091         return '';
3092     }
3094     if (!$override) {
3095         if (!empty($CFG->forcefirstname)) {
3096             $user->firstname = $CFG->forcefirstname;
3097         }
3098         if (!empty($CFG->forcelastname)) {
3099             $user->lastname = $CFG->forcelastname;
3100         }
3101     }
3103     if (!empty($SESSION->fullnamedisplay)) {
3104         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3105     }
3107     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3108         return $user->firstname .' '. $user->lastname;
3110     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3111         return $user->lastname .' '. $user->firstname;
3113     } else if ($CFG->fullnamedisplay == 'firstname') {
3114         if ($override) {
3115             return get_string('fullnamedisplay', '', $user);
3116         } else {
3117             return $user->firstname;
3118         }
3119     }
3121     return get_string('fullnamedisplay', '', $user);
3124 /**
3125  * Returns whether a given authentication plugin exists.
3126  *
3127  * @global object
3128  * @param string $auth Form of authentication to check for. Defaults to the
3129  *        global setting in {@link $CFG}.
3130  * @return boolean Whether the plugin is available.
3131  */
3132 function exists_auth_plugin($auth) {
3133     global $CFG;
3135     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3136         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3137     }
3138     return false;
3141 /**
3142  * Checks if a given plugin is in the list of enabled authentication plugins.
3143  *
3144  * @param string $auth Authentication plugin.
3145  * @return boolean Whether the plugin is enabled.
3146  */
3147 function is_enabled_auth($auth) {
3148     if (empty($auth)) {
3149         return false;
3150     }
3152     $enabled = get_enabled_auth_plugins();
3154     return in_array($auth, $enabled);
3157 /**
3158  * Returns an authentication plugin instance.
3159  *
3160  * @global object
3161  * @param string $auth name of authentication plugin
3162  * @return auth_plugin_base An instance of the required authentication plugin.
3163  */
3164 function get_auth_plugin($auth) {
3165     global $CFG;
3167     // check the plugin exists first
3168     if (! exists_auth_plugin($auth)) {
3169         print_error('authpluginnotfound', 'debug', '', $auth);
3170     }
3172     // return auth plugin instance
3173     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3174     $class = "auth_plugin_$auth";
3175     return new $class;
3178 /**
3179  * Returns array of active auth plugins.
3180  *
3181  * @param bool $fix fix $CFG->auth if needed
3182  * @return array
3183  */
3184 function get_enabled_auth_plugins($fix=false) {
3185     global $CFG;
3187     $default = array('manual', 'nologin');
3189     if (empty($CFG->auth)) {
3190         $auths = array();
3191     } else {
3192         $auths = explode(',', $CFG->auth);
3193     }
3195     if ($fix) {
3196         $auths = array_unique($auths);
3197         foreach($auths as $k=>$authname) {
3198             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3199                 unset($auths[$k]);
3200             }
3201         }
3202         $newconfig = implode(',', $auths);
3203         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3204             set_config('auth', $newconfig);
3205         }
3206     }
3208     return (array_merge($default, $auths));
3211 /**
3212  * Returns true if an internal authentication method is being used.
3213  * if method not specified then, global default is assumed
3214  *
3215  * @param string $auth Form of authentication required
3216  * @return bool
3217  */
3218 function is_internal_auth($auth) {
3219     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3220     return $authplugin->is_internal();
3223 /**
3224  * Returns true if the user is a 'restored' one
3225  *
3226  * Used in the login process to inform the user
3227  * and allow him/her to reset the password
3228  *
3229  * @uses $CFG
3230  * @uses $DB
3231  * @param string $username username to be checked
3232  * @return bool
3233  */
3234 function is_restored_user($username) {
3235     global $CFG, $DB;
3237     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3240 /**
3241  * Returns an array of user fields
3242  *
3243  * @return array User field/column names
3244  */
3245 function get_user_fieldnames() {
3246     global $DB;
3248     $fieldarray = $DB->get_columns('user');
3249     unset($fieldarray['id']);
3250     $fieldarray = array_keys($fieldarray);
3252     return $fieldarray;
3255 /**
3256  * Creates a bare-bones user record
3257  *
3258  * @todo Outline auth types and provide code example
3259  *
3260  * @global object
3261  * @global object
3262  * @param string $username New user's username to add to record
3263  * @param string $password New user's password to add to record
3264  * @param string $auth Form of authentication required
3265  * @return object A {@link $USER} object
3266  */
3267 function create_user_record($username, $password, $auth='manual') {
3268     global $CFG, $DB;
3270     //just in case check text case
3271     $username = trim(moodle_strtolower($username));
3273     $authplugin = get_auth_plugin($auth);
3275     $newuser = new object();
3277     if ($newinfo = $authplugin->get_userinfo($username)) {
3278         $newinfo = truncate_userinfo($newinfo);
3279         foreach ($newinfo as $key => $value){
3280             $newuser->$key = $value;
3281         }
3282     }
3284     if (!empty($newuser->email)) {
3285         if (email_is_not_allowed($newuser->email)) {
3286             unset($newuser->email);
3287         }
3288     }
3290     if (!isset($newuser->city)) {
3291         $newuser->city = '';
3292     }
3294     $newuser->auth = $auth;
3295     $newuser->username = $username;
3297     // fix for MDL-8480
3298     // user CFG lang for user if $newuser->lang is empty
3299     // or $user->lang is not an installed language
3300     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3301         $newuser->lang = $CFG->lang;
3302     }
3303     $newuser->confirmed = 1;
3304     $newuser->lastip = getremoteaddr();
3305     $newuser->timemodified = time();
3306     $newuser->mnethostid = $CFG->mnet_localhost_id;
3308     $DB->insert_record('user', $newuser);
3309     $user = get_complete_user_data('username', $newuser->username);
3310     if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3311         set_user_preference('auth_forcepasswordchange', 1, $user->id);
3312     }
3313     update_internal_user_password($user, $password);
3314     return $user;
3317 /**
3318  * Will update a local user record from an external source
3319  *
3320  * @global object
3321  * @param string $username New user's username to add to record
3322  * @param string $authplugin Unused
3323  * @return user A {@link $USER} object
3324  */
3325 function update_user_record($username, $authplugin) {
3326     global $DB;
3328     $username = trim(moodle_strtolower($username)); /// just in case check text case
3330     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
3331     $userauth = get_auth_plugin($oldinfo->auth);
3333     if ($newinfo = $userauth->get_userinfo($username)) {
3334         $newinfo = truncate_userinfo($newinfo);
3335         foreach ($newinfo as $key => $value){
3336             if ($key === 'username') {
3337                 // 'username' is not a mapped updateable/lockable field, so skip it.
3338                 continue;
3339             }
3340             $confval = $userauth->config->{'field_updatelocal_' . $key};
3341             $lockval = $userauth->config->{'field_lock_' . $key};
3342             if (empty($confval) || empty($lockval)) {
3343                 continue;
3344             }
3345             if ($confval === 'onlogin') {
3346                 // MDL-4207 Don't overwrite modified user profile values with
3347                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3348                 // of the setting 'unlocked if empty' is to allow the user to fill
3349                 // in a value for the selected field _if LDAP is giving
3350                 // nothing_ for this field. Thus it makes sense to let this value
3351                 // stand in until LDAP is giving a value for this field.
3352                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3353                     $DB->set_field('user', $key, $value, array('username'=>$username));
3354                 }
3355             }
3356         }
3357     }
3359     return get_complete_user_data('username', $username);
3362 /**
3363  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3364  * which may have large fields
3365  *
3366  * @todo Add vartype handling to ensure $info is an array
3367  *
3368  * @param array $info Array of user properties to truncate if needed
3369  * @return array The now truncated information that was passed in
3370  */
3371 function truncate_userinfo($info) {
3372     // define the limits
3373     $limit = array(
3374                     'username'    => 100,
3375                     'idnumber'    => 255,
3376                     'firstname'   => 100,
3377                     'lastname'    => 100,
3378                     'email'       => 100,
3379                     'icq'         =>  15,
3380                     'phone1'      =>  20,
3381                     'phone2'      =>  20,
3382                     'institution' =>  40,
3383                     'department'  =>  30,
3384                     'address'     =>  70,
3385                     'city'        =>  20,
3386                     'country'     =>   2,
3387                     'url'         => 255,
3388                     );
3390     // apply where needed
3391     foreach (array_keys($info) as $key) {
3392         if (!empty($limit[$key])) {
3393             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
3394         }
3395     }
3397     return $info;
3400 /**
3401  * Marks user deleted in internal user database and notifies the auth plugin.
3402  * Also unenrols user from all roles and does other cleanup.
3403  *
3404  * @todo Decide if this transaction is really needed (look for internal TODO:)
3405  *
3406  * @global object
3407  * @global object
3408  * @param object $user Userobject before delete    (without system magic quotes)
3409  * @return boolean success
3410  */
3411 function delete_user($user) {
3412     global $CFG, $DB;
3413     require_once($CFG->libdir.'/grouplib.php');
3414     require_once($CFG->libdir.'/gradelib.php');
3415     require_once($CFG->dirroot.'/message/lib.php');
3417     // delete all grades - backup is kept in grade_grades_history table
3418     if ($grades = grade_grade::fetch_all(array('userid'=>$user->id))) {
3419         foreach ($grades as $grade) {
3420             $grade->delete('userdelete');
3421         }
3422     }
3424     //move unread messages from this user to read
3425     message_move_userfrom_unread2read($user->id);
3427     // remove from all groups
3428     $DB->delete_records('groups_members', array('userid'=>$user->id));
3430     // unenrol from all roles in all contexts
3431     role_unassign(0, $user->id); // this might be slow but it is really needed - modules might do some extra cleanup!
3433     // now do a final accesslib cleanup - removes all role assingments in user context and context itself
3434     delete_context(CONTEXT_USER, $user->id);
3436     require_once($CFG->dirroot.'/tag/lib.php');
3437     tag_set('user', $user->id, array());
3439     // workaround for bulk deletes of users with the same email address
3440     $delname = "$user->email.".time();
3441     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3442         $delname++;
3443     }
3445     // mark internal user record as "deleted"
3446     $updateuser = new object();
3447     $updateuser->id           = $user->id;
3448     $updateuser->deleted      = 1;
3449     $updateuser->username     = $delname;            // Remember it just in case
3450     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3451     $updateuser->idnumber     = '';                  // Clear this field to free it up
3452     $updateuser->timemodified = time();
3454     $DB->update_record('user', $updateuser);
3456     // notify auth plugin - do not block the delete even when plugin fails
3457     $authplugin = get_auth_plugin($user->auth);
3458     $authplugin->user_delete($user);
3460     events_trigger('user_deleted', $user);
3462     return true;
3465 /**
3466  * Retrieve the guest user object
3467  *
3468  * @global object
3469  * @global object
3470  * @return user A {@link $USER} object
3471  */
3472 function guest_user() {
3473     global $CFG, $DB;
3475     if ($newuser = $DB->get_record('user', array('username'=>'guest', 'mnethostid'=>$CFG->mnet_localhost_id))) {
3476         $newuser->confirmed = 1;
3477         $newuser->lang = $CFG->lang;
3478         $newuser->lastip = getremoteaddr();
3479     }
3481     return $newuser;
3484 /**
3485  * Authenticates a user against the chosen authentication mechanism
3486  *
3487  * Given a username and password, this function looks them
3488  * up using the currently selected authentication mechanism,
3489  * and if the authentication is successful, it returns a
3490  * valid $user object from the 'user' table.
3491  *
3492  * Uses auth_ functions from the currently active auth module
3493  *
3494  * After authenticate_user_login() returns success, you will need to
3495  * log that the user has logged in, and call complete_user_login() to set
3496  * the session up.
3497  *
3498  * @global object
3499  * @global object
3500  * @param string $username  User's username
3501  * @param string $password  User's password
3502  * @return user|flase A {@link $USER} object or false if error
3503  */
3504 function authenticate_user_login($username, $password) {
3505     global $CFG, $DB, $OUTPUT;
3507     $authsenabled = get_enabled_auth_plugins();
3509     if ($user = get_complete_user_data('username', $username)) {
3510         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3511         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3512             add_to_log(0, 'login', 'error', 'index.php', $username);
3513             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3514             return false;
3515         }
3516         $auths = array($auth);
3518     } else {
3519         // check if there's a deleted record (cheaply)
3520         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
3521             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3522             return false;
3523         }
3525         $auths = $authsenabled;
3526         $user = new object();
3527         $user->id = 0;     // User does not exist
3528     }
3530     foreach ($auths as $auth) {
3531         $authplugin = get_auth_plugin($auth);
3533         // on auth fail fall through to the next plugin
3534         if (!$authplugin->user_login($username, $password)) {
3535             continue;
3536         }
3538         // successful authentication
3539         if ($user->id) {                          // User already exists in database
3540             if (empty($user->auth)) {             // For some reason auth isn't set yet
3541                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3542                 $user->auth = $auth;
3543             }
3544             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3545                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3546                 $user->firstaccess = $user->timemodified;
3547             }
3549             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3551             if (!$authplugin->is_internal()) {            // update user record from external DB
3552                 $user = update_user_record($username, get_auth_plugin($user->auth));
3553             }
3554         } else {
3555             // if user not found, create him
3556             $user = create_user_record($username, $password, $auth);
3557         }
3559         $authplugin->sync_roles($user);
3561         foreach ($authsenabled as $hau) {
3562             $hauth = get_auth_plugin($hau);
3563             $hauth->user_authenticated_hook($user, $username, $password);
3564         }
3566     /// Log in to a second system if necessary
3567     /// NOTICE: /sso/ will be moved to auth and deprecated soon; use user_authenticated_hook() instead
3568         if (!empty($CFG->sso)) {
3569             include_once($CFG->dirroot .'/sso/'. $CFG->sso .'/lib.php');
3570             if (function_exists('sso_user_login')) {
3571                 if (!sso_user_login($username, $password)) {   // Perform the signon process
3572                     echo $OUTPUT->notification('Second sign-on failed');
3573                 }
3574             }
3575         }
3577         if ($user->id===0) {
3578             return false;
3579         }
3580         return $user;
3581     }
3583     // failed if all the plugins have failed
3584     add_to_log(0, 'login', 'error', 'index.php', $username);
3585     if (debugging('', DEBUG_ALL)) {
3586         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3587     }
3588     return false;
3591 /**
3592  * Call to complete the user login process after authenticate_user_login()
3593  * has succeeded. It will setup the $USER variable and other required bits
3594  * and pieces.
3595  *
3596  * NOTE:
3597  * - It will NOT log anything -- up to the caller to decide what to log.
3598  *
3599  * @global object
3600  * @global object
3601  * @global object
3602  * @param object $user
3603  * @param bool $setcookie
3604  * @return object A {@link $USER} object - BC only, do not use
3605  */
3606 function complete_user_login($user, $setcookie=true) {
3607     global $CFG, $USER, $SESSION;
3609     // regenerate session id and delete old session,
3610     // this helps prevent session fixation attacks from the same domain
3611     session_regenerate_id(true);
3613     // check enrolments, load caps and setup $USER object
3614     session_set_user($user);
3616     update_user_login_times();
3617     set_login_session_preferences();
3619     if ($setcookie) {
3620         if (empty($CFG->nolastloggedin)) {
3621             set_moodle_cookie($USER->username);
3622         } else {
3623             // do not store last logged in user in cookie
3624             // auth plugins can temporarily override this from loginpage_hook()
3625             // do not save $CFG->nolastloggedin in database!
3626             set_moodle_cookie('nobody');
3627         }
3628     }
3630     /// Select password change url
3631     $userauth = get_auth_plugin($USER->auth);
3633     /// check whether the user should be changing password
3634     if (get_user_preferences('auth_forcepasswordchange', false)){
3635         if ($userauth->can_change_password()) {
3636             if ($changeurl = $userauth->change_password_url()) {
3637                 redirect($changeurl);
3638             } else {
3639                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3640             }
3641         } else {
3642             print_error('nopasswordchangeforced', 'auth');
3643         }
3644     }
3645     return $USER;
3648 /**
3649  * Compare password against hash stored in internal user table.
3650  * If necessary it also updates the stored hash to new format.
3651  *
3652  * @global object
3653  * @param object $user
3654  * @param string $password plain text password
3655  * @return bool is password valid?
3656  */
3657 function validate_internal_user_password(&$user, $password) {
3658     global $CFG;
3660     if (!isset($CFG->passwordsaltmain)) {
3661         $CFG->passwordsaltmain = '';
3662     }
3664     $validated = false;
3666     // get password original encoding in case it was not updated to unicode yet
3667     $textlib = textlib_get_instance();
3668     $convpassword = $textlib->convert($password, 'utf-8', get_string('oldcharset', 'langconfig'));
3670     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)
3671         or $user->password == md5($convpassword.$CFG->passwordsaltmain) or $user->password == md5($convpassword)) {
3672         $validated = true;
3673     } else {
3674         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
3675             $alt = 'passwordsaltalt'.$i;
3676             if (!empty($CFG->$alt)) {
3677                 if ($user->password == md5($password.$CFG->$alt) or $user->password == md5($convpassword.$CFG->$alt)) {
3678                     $validated = true;
3679                     break;
3680                 }
3681             }
3682         }
3683     }
3685     if ($validated) {
3686         // force update of password hash using latest main password salt and encoding if needed
3687         update_internal_user_password($user, $password);
3688     }
3690     return $validated;
3693 /**
3694  * Calculate hashed value from password using current hash mechanism.
3695  *
3696  * @global object
3697  * @param string $password
3698  * @return string password hash
3699  */
3700 function hash_internal_user_password($password) {
3701     global $CFG;
3703     if (isset($CFG->passwordsaltmain)) {
3704         return md5($password.$CFG->passwordsaltmain);
3705     } else {
3706         return md5($password);
3707     }
3710 /**
3711  * Update pssword hash in user object.
3712  *
3713  * @global object
3714  * @global object
3715  * @param object $user
3716  * @param string $password plain text password
3717  * @return bool true if hash changed
3718  */
3719 function update_internal_user_password(&$user, $password) {
3720     global $CFG, $DB;
3722     $authplugin = get_auth_plugin($user->auth);
3723     if ($authplugin->prevent_local_passwords()) {
3724         $hashedpassword = 'not cached';
3725     } else {
3726         $hashedpassword = hash_internal_user_password($password);
3727     }
3729     $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
3730     return true;