Completion MDL-23995 Completion, availability data not deleted with modules/course
[moodle.git] / lib / moodlelib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * moodlelib.php - Moodle main library
20  *
21  * Main library file of miscellaneous general-purpose Moodle functions.
22  * Other main libraries:
23  *  - weblib.php      - functions that produce web output
24  *  - datalib.php     - functions that access the database
25  *
26  * @package    core
27  * @subpackage lib
28  * @copyright  1999 onwards Martin Dougiamas  http://dougiamas.com
29  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
30  */
32 defined('MOODLE_INTERNAL') || die();
34 /// CONSTANTS (Encased in phpdoc proper comments)/////////////////////////
36 /// Date and time constants ///
37 /**
38  * Time constant - the number of seconds in a year
39  */
40 define('YEARSECS', 31536000);
42 /**
43  * Time constant - the number of seconds in a week
44  */
45 define('WEEKSECS', 604800);
47 /**
48  * Time constant - the number of seconds in a day
49  */
50 define('DAYSECS', 86400);
52 /**
53  * Time constant - the number of seconds in an hour
54  */
55 define('HOURSECS', 3600);
57 /**
58  * Time constant - the number of seconds in a minute
59  */
60 define('MINSECS', 60);
62 /**
63  * Time constant - the number of minutes in a day
64  */
65 define('DAYMINS', 1440);
67 /**
68  * Time constant - the number of minutes in an hour
69  */
70 define('HOURMINS', 60);
72 /// Parameter constants - every call to optional_param(), required_param()  ///
73 /// or clean_param() should have a specified type of parameter.  //////////////
77 /**
78  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
79  */
80 define('PARAM_ALPHA',    'alpha');
82 /**
83  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
84  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
85  */
86 define('PARAM_ALPHAEXT', 'alphaext');
88 /**
89  * PARAM_ALPHANUM - expected numbers and letters only.
90  */
91 define('PARAM_ALPHANUM', 'alphanum');
93 /**
94  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
95  */
96 define('PARAM_ALPHANUMEXT', 'alphanumext');
98 /**
99  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
100  */
101 define('PARAM_AUTH',  'auth');
103 /**
104  * PARAM_BASE64 - Base 64 encoded format
105  */
106 define('PARAM_BASE64',   'base64');
108 /**
109  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
110  */
111 define('PARAM_BOOL',     'bool');
113 /**
114  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
115  * checked against the list of capabilities in the database.
116  */
117 define('PARAM_CAPABILITY',   'capability');
119 /**
120  * PARAM_CLEANHTML - cleans submitted HTML code and removes slashes. It stays as HTML.
121  */
122 define('PARAM_CLEANHTML', 'cleanhtml');
124 /**
125  * PARAM_EMAIL - an email address following the RFC
126  */
127 define('PARAM_EMAIL',   'email');
129 /**
130  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
131  */
132 define('PARAM_FILE',   'file');
134 /**
135  * PARAM_FLOAT - a real/floating point number.
136  */
137 define('PARAM_FLOAT',  'float');
139 /**
140  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
141  */
142 define('PARAM_HOST',     'host');
144 /**
145  * PARAM_INT - integers only, use when expecting only numbers.
146  */
147 define('PARAM_INT',      'int');
149 /**
150  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
151  */
152 define('PARAM_LANG',  'lang');
154 /**
155  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the others! Implies PARAM_URL!)
156  */
157 define('PARAM_LOCALURL', 'localurl');
159 /**
160  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
161  */
162 define('PARAM_NOTAGS',   'notags');
164 /**
165  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
166  * note: the leading slash is not removed, window drive letter is not allowed
167  */
168 define('PARAM_PATH',     'path');
170 /**
171  * PARAM_PEM - Privacy Enhanced Mail format
172  */
173 define('PARAM_PEM',      'pem');
175 /**
176  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
177  */
178 define('PARAM_PERMISSION',   'permission');
180 /**
181  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way
182  */
183 define('PARAM_RAW', 'raw');
185 /**
186  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
187  */
188 define('PARAM_SAFEDIR',  'safedir');
190 /**
191  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
192  */
193 define('PARAM_SAFEPATH',  'safepath');
195 /**
196  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
197  */
198 define('PARAM_SEQUENCE',  'sequence');
200 /**
201  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
202  */
203 define('PARAM_TAG',   'tag');
205 /**
206  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
207  */
208 define('PARAM_TAGLIST',   'taglist');
210 /**
211  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags.
212  */
213 define('PARAM_TEXT',  'text');
215 /**
216  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
217  */
218 define('PARAM_THEME',  'theme');
220 /**
221  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
222  */
223 define('PARAM_URL',      'url');
225 /**
226  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
227  */
228 define('PARAM_USERNAME',    'username');
230 /**
231  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
232  */
233 define('PARAM_STRINGID',    'stringid');
235 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
236 /**
237  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
238  * It was one of the first types, that is why it is abused so much ;-)
239  */
240 define('PARAM_CLEAN',    'clean');
242 /**
243  * PARAM_INTEGER - deprecated alias for PARAM_INT
244  */
245 define('PARAM_INTEGER',  'int');
247 /**
248  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
249  */
250 define('PARAM_NUMBER',  'float');
252 /**
253  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
254  * NOTE: originally alias for PARAM_APLHA
255  */
256 define('PARAM_ACTION',   'alphanumext');
258 /**
259  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
260  * NOTE: originally alias for PARAM_APLHA
261  */
262 define('PARAM_FORMAT',   'alphanumext');
264 /**
265  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
266  */
267 define('PARAM_MULTILANG',  'text');
269 /**
270  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
271  */
272 define('PARAM_CLEANFILE', 'file');
274 /// Web Services ///
276 /**
277  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
278  */
279 define('VALUE_REQUIRED', 1);
281 /**
282  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
283  */
284 define('VALUE_OPTIONAL', 2);
286 /**
287  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
288  */
289 define('VALUE_DEFAULT', 0);
291 /**
292  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
293  */
294 define('NULL_NOT_ALLOWED', false);
296 /**
297  * NULL_ALLOWED - the parameter can be set to null in the database
298  */
299 define('NULL_ALLOWED', true);
301 /// Page types ///
302 /**
303  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
304  */
305 define('PAGE_COURSE_VIEW', 'course-view');
307 /** Get remote addr constant */
308 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
309 /** Get remote addr constant */
310 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
312 /// Blog access level constant declaration ///
313 define ('BLOG_USER_LEVEL', 1);
314 define ('BLOG_GROUP_LEVEL', 2);
315 define ('BLOG_COURSE_LEVEL', 3);
316 define ('BLOG_SITE_LEVEL', 4);
317 define ('BLOG_GLOBAL_LEVEL', 5);
320 ///Tag constants///
321 /**
322  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
323  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
324  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
325  *
326  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
327  */
328 define('TAG_MAX_LENGTH', 50);
330 /// Password policy constants ///
331 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
332 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
333 define ('PASSWORD_DIGITS', '0123456789');
334 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
336 /// Feature constants ///
337 // Used for plugin_supports() to report features that are, or are not, supported by a module.
339 /** True if module can provide a grade */
340 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
341 /** True if module supports outcomes */
342 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
344 /** True if module has code to track whether somebody viewed it */
345 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
346 /** True if module has custom completion rules */
347 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
349 /** True if module supports outcomes */
350 define('FEATURE_IDNUMBER', 'idnumber');
351 /** True if module supports groups */
352 define('FEATURE_GROUPS', 'groups');
353 /** True if module supports groupings */
354 define('FEATURE_GROUPINGS', 'groupings');
355 /** True if module supports groupmembersonly */
356 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
358 /** Type of module */
359 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
360 /** True if module supports intro editor */
361 define('FEATURE_MOD_INTRO', 'mod_intro');
362 /** True if module has default completion */
363 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
365 define('FEATURE_COMMENT', 'comment');
367 define('FEATURE_RATE', 'rate');
368 /** True if module supports backup/restore of moodle2 format */
369 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
371 /** Unspecified module archetype */
372 define('MOD_ARCHETYPE_OTHER', 0);
373 /** Resource-like type module */
374 define('MOD_ARCHETYPE_RESOURCE', 1);
375 /** Assignment module archetype */
376 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
378 /**
379  * Security token used for allowing access
380  * from external application such as web services.
381  * Scripts do not use any session, performance is relatively
382  * low because we need to load access info in each request.
383  * Scripts are executed in parallel.
384  */
385 define('EXTERNAL_TOKEN_PERMANENT', 0);
387 /**
388  * Security token used for allowing access
389  * of embedded applications, the code is executed in the
390  * active user session. Token is invalidated after user logs out.
391  * Scripts are executed serially - normal session locking is used.
392  */
393 define('EXTERNAL_TOKEN_EMBEDDED', 1);
395 /**
396  * The home page should be the site home
397  */
398 define('HOMEPAGE_SITE', 0);
399 /**
400  * The home page should be the users my page
401  */
402 define('HOMEPAGE_MY', 1);
403 /**
404  * The home page can be chosen by the user
405  */
406 define('HOMEPAGE_USER', 2);
408 /**
409  * Hub directory url (should be moodle.org)
410  */
411 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
414 /**
415  * Moodle.org url (should be moodle.org)
416  */
417 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
420 /// PARAMETER HANDLING ////////////////////////////////////////////////////
422 /**
423  * Returns a particular value for the named variable, taken from
424  * POST or GET.  If the parameter doesn't exist then an error is
425  * thrown because we require this variable.
426  *
427  * This function should be used to initialise all required values
428  * in a script that are based on parameters.  Usually it will be
429  * used like this:
430  *    $id = required_param('id', PARAM_INT);
431  *
432  * @param string $parname the name of the page parameter we want,
433  *                        default PARAM_CLEAN
434  * @param int $type expected type of parameter
435  * @return mixed
436  */
437 function required_param($parname, $type=PARAM_CLEAN) {
438     if (isset($_POST[$parname])) {       // POST has precedence
439         $param = $_POST[$parname];
440     } else if (isset($_GET[$parname])) {
441         $param = $_GET[$parname];
442     } else {
443         print_error('missingparam', '', '', $parname);
444     }
446     return clean_param($param, $type);
449 /**
450  * Returns a particular value for the named variable, taken from
451  * POST or GET, otherwise returning a given default.
452  *
453  * This function should be used to initialise all optional values
454  * in a script that are based on parameters.  Usually it will be
455  * used like this:
456  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
457  *
458  * @param string $parname the name of the page parameter we want
459  * @param mixed  $default the default value to return if nothing is found
460  * @param int $type expected type of parameter, default PARAM_CLEAN
461  * @return mixed
462  */
463 function optional_param($parname, $default=NULL, $type=PARAM_CLEAN) {
464     if (isset($_POST[$parname])) {       // POST has precedence
465         $param = $_POST[$parname];
466     } else if (isset($_GET[$parname])) {
467         $param = $_GET[$parname];
468     } else {
469         return $default;
470     }
472     return clean_param($param, $type);
475 /**
476  * Strict validation of parameter values, the values are only converted
477  * to requested PHP type. Internally it is using clean_param, the values
478  * before and after cleaning must be equal - otherwise
479  * an invalid_parameter_exception is thrown.
480  * Objects and classes are not accepted.
481  *
482  * @param mixed $param
483  * @param int $type PARAM_ constant
484  * @param bool $allownull are nulls valid value?
485  * @param string $debuginfo optional debug information
486  * @return mixed the $param value converted to PHP type or invalid_parameter_exception
487  */
488 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
489     if (is_null($param)) {
490         if ($allownull == NULL_ALLOWED) {
491             return null;
492         } else {
493             throw new invalid_parameter_exception($debuginfo);
494         }
495     }
496     if (is_array($param) or is_object($param)) {
497         throw new invalid_parameter_exception($debuginfo);
498     }
500     $cleaned = clean_param($param, $type);
501     if ((string)$param !== (string)$cleaned) {
502         // conversion to string is usually lossless
503         throw new invalid_parameter_exception($debuginfo);
504     }
506     return $cleaned;
509 /**
510  * Used by {@link optional_param()} and {@link required_param()} to
511  * clean the variables and/or cast to specific types, based on
512  * an options field.
513  * <code>
514  * $course->format = clean_param($course->format, PARAM_ALPHA);
515  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_CLEAN);
516  * </code>
517  *
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:]]|[<>`]~u', '', $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         case PARAM_STRINGID:
794             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
795                 return $param;
796             } else {
797                 return '';
798             }
800         default:                 // throw error, switched parameters in optional_param or another serious problem
801             print_error("unknownparamtype", '', '', $type);
802     }
805 /**
806  * Return true if given value is integer or string with integer value
807  *
808  * @param mixed $value String or Int
809  * @return bool true if number, false if not
810  */
811 function is_number($value) {
812     if (is_int($value)) {
813         return true;
814     } else if (is_string($value)) {
815         return ((string)(int)$value) === $value;
816     } else {
817         return false;
818     }
821 /**
822  * Returns host part from url
823  * @param string $url full url
824  * @return string host, null if not found
825  */
826 function get_host_from_url($url) {
827     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
828     if ($matches) {
829         return $matches[1];
830     }
831     return null;
834 /**
835  * Tests whether anything was returned by text editor
836  *
837  * This function is useful for testing whether something you got back from
838  * the HTML editor actually contains anything. Sometimes the HTML editor
839  * appear to be empty, but actually you get back a <br> tag or something.
840  *
841  * @param string $string a string containing HTML.
842  * @return boolean does the string contain any actual content - that is text,
843  * images, objects, etc.
844  */
845 function html_is_blank($string) {
846     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
849 /**
850  * Set a key in global configuration
851  *
852  * Set a key/value pair in both this session's {@link $CFG} global variable
853  * and in the 'config' database table for future sessions.
854  *
855  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
856  * In that case it doesn't affect $CFG.
857  *
858  * A NULL value will delete the entry.
859  *
860  * @global object
861  * @global object
862  * @param string $name the key to set
863  * @param string $value the value to set (without magic quotes)
864  * @param string $plugin (optional) the plugin scope, default NULL
865  * @return bool true or exception
866  */
867 function set_config($name, $value, $plugin=NULL) {
868     global $CFG, $DB;
870     if (empty($plugin)) {
871         if (!array_key_exists($name, $CFG->config_php_settings)) {
872             // So it's defined for this invocation at least
873             if (is_null($value)) {
874                 unset($CFG->$name);
875             } else {
876                 $CFG->$name = (string)$value; // settings from db are always strings
877             }
878         }
880         if ($DB->get_field('config', 'name', array('name'=>$name))) {
881             if ($value === null) {
882                 $DB->delete_records('config', array('name'=>$name));
883             } else {
884                 $DB->set_field('config', 'value', $value, array('name'=>$name));
885             }
886         } else {
887             if ($value !== null) {
888                 $config = new object();
889                 $config->name  = $name;
890                 $config->value = $value;
891                 $DB->insert_record('config', $config, false);
892             }
893         }
895     } else { // plugin scope
896         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
897             if ($value===null) {
898                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
899             } else {
900                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
901             }
902         } else {
903             if ($value !== null) {
904                 $config = new object();
905                 $config->plugin = $plugin;
906                 $config->name   = $name;
907                 $config->value  = $value;
908                 $DB->insert_record('config_plugins', $config, false);
909             }
910         }
911     }
913     return true;
916 /**
917  * Get configuration values from the global config table
918  * or the config_plugins table.
919  *
920  * If called with one parameter, it will load all the config
921  * variables for one plugin, and return them as an object.
922  *
923  * If called with 2 parameters it will return a string single
924  * value or false if the value is not found.
925  *
926  * @param string $plugin full component name
927  * @param string $name default NULL
928  * @return mixed hash-like object or single value, return false no config found
929  */
930 function get_config($plugin, $name = NULL) {
931     global $CFG, $DB;
933     // normalise component name
934     if ($plugin === 'moodle' or $plugin === 'core') {
935         $plugin = NULL;
936     }
938     if (!empty($name)) { // the user is asking for a specific value
939         if (!empty($plugin)) {
940             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
941                 // setting forced in config file
942                 return $CFG->forced_plugin_settings[$plugin][$name];
943             } else {
944                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
945             }
946         } else {
947             if (array_key_exists($name, $CFG->config_php_settings)) {
948                 // setting force in config file
949                 return $CFG->config_php_settings[$name];
950             } else {
951                 return $DB->get_field('config', 'value', array('name'=>$name));
952             }
953         }
954     }
956     // the user is after a recordset
957     if ($plugin) {
958         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
959         if (isset($CFG->forced_plugin_settings[$plugin])) {
960             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
961                 if (is_null($v) or is_array($v) or is_object($v)) {
962                     // we do not want any extra mess here, just real settings that could be saved in db
963                     unset($localcfg[$n]);
964                 } else {
965                     //convert to string as if it went through the DB
966                     $localcfg[$n] = (string)$v;
967                 }
968             }
969         }
970         return (object)$localcfg;
972     } else {
973         // this part is not really used any more, but anyway...
974         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
975         foreach($CFG->config_php_settings as $n=>$v) {
976             if (is_null($v) or is_array($v) or is_object($v)) {
977                 // we do not want any extra mess here, just real settings that could be saved in db
978                 unset($localcfg[$n]);
979             } else {
980                 //convert to string as if it went through the DB
981                 $localcfg[$n] = (string)$v;
982             }
983         }
984         return (object)$localcfg;
985     }
988 /**
989  * Removes a key from global configuration
990  *
991  * @param string $name the key to set
992  * @param string $plugin (optional) the plugin scope
993  * @global object
994  * @return boolean whether the operation succeeded.
995  */
996 function unset_config($name, $plugin=NULL) {
997     global $CFG, $DB;
999     if (empty($plugin)) {
1000         unset($CFG->$name);
1001         $DB->delete_records('config', array('name'=>$name));
1002     } else {
1003         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1004     }
1006     return true;
1009 /**
1010  * Remove all the config variables for a given plugin.
1011  *
1012  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1013  * @return boolean whether the operation succeeded.
1014  */
1015 function unset_all_config_for_plugin($plugin) {
1016     global $DB;
1017     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1018     $DB->delete_records_select('config', 'name LIKE ?', array($plugin . '_%'));
1019     return true;
1022 /**
1023  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1024  *
1025  * All users are verified if they still have the necessary capability.
1026  *
1027  * @param string $value the value of the config setting.
1028  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1029  * @param bool $include admins, include administrators
1030  * @return array of user objects.
1031  */
1032 function get_users_from_config($value, $capability, $includeadmins = true) {
1033     global $CFG, $DB;
1035     if (empty($value) or $value === '$@NONE@$') {
1036         return array();
1037     }
1039     // we have to make sure that users still have the necessary capability,
1040     // it should be faster to fetch them all first and then test if they are present
1041     // instead of validating them one-by-one
1042     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1043     if ($includeadmins) {
1044         $admins = get_admins();
1045         foreach ($admins as $admin) {
1046             $users[$admin->id] = $admin;
1047         }
1048     }
1050     if ($value === '$@ALL@$') {
1051         return $users;
1052     }
1054     $result = array(); // result in correct order
1055     $allowed = explode(',', $value);
1056     foreach ($allowed as $uid) {
1057         if (isset($users[$uid])) {
1058             $user = $users[$uid];
1059             $result[$user->id] = $user;
1060         }
1061     }
1063     return $result;
1067 /**
1068  * Invalidates browser caches and cached data in temp
1069  * @return void
1070  */
1071 function purge_all_caches() {
1072     global $CFG;
1074     reset_text_filters_cache();
1075     js_reset_all_caches();
1076     theme_reset_all_caches();
1077     get_string_manager()->reset_caches();
1079     // purge all other caches: rss, simplepie, etc.
1080     remove_dir($CFG->dataroot.'/cache', true);
1082     // make sure cache dir is writable, throws exception if not
1083     make_upload_directory('cache');
1085     clearstatcache();
1088 /**
1089  * Get volatile flags
1090  *
1091  * @param string $type
1092  * @param int    $changedsince default null
1093  * @return records array
1094  */
1095 function get_cache_flags($type, $changedsince=NULL) {
1096     global $DB;
1098     $params = array('type'=>$type, 'expiry'=>time());
1099     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1100     if ($changedsince !== NULL) {
1101         $params['changedsince'] = $changedsince;
1102         $sqlwhere .= " AND timemodified > :changedsince";
1103     }
1104     $cf = array();
1106     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1107         foreach ($flags as $flag) {
1108             $cf[$flag->name] = $flag->value;
1109         }
1110     }
1111     return $cf;
1114 /**
1115  * Get volatile flags
1116  *
1117  * @param string $type
1118  * @param string $name
1119  * @param int    $changedsince default null
1120  * @return records array
1121  */
1122 function get_cache_flag($type, $name, $changedsince=NULL) {
1123     global $DB;
1125     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1127     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1128     if ($changedsince !== NULL) {
1129         $params['changedsince'] = $changedsince;
1130         $sqlwhere .= " AND timemodified > :changedsince";
1131     }
1133     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1136 /**
1137  * Set a volatile flag
1138  *
1139  * @param string $type the "type" namespace for the key
1140  * @param string $name the key to set
1141  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1142  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1143  * @return bool Always returns true
1144  */
1145 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1146     global $DB;
1148     $timemodified = time();
1149     if ($expiry===NULL || $expiry < $timemodified) {
1150         $expiry = $timemodified + 24 * 60 * 60;
1151     } else {
1152         $expiry = (int)$expiry;
1153     }
1155     if ($value === NULL) {
1156         unset_cache_flag($type,$name);
1157         return true;
1158     }
1160     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potentail problem in DEBUG_DEVELOPER
1161         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1162             return true; //no need to update; helps rcache too
1163         }
1164         $f->value        = $value;
1165         $f->expiry       = $expiry;
1166         $f->timemodified = $timemodified;
1167         $DB->update_record('cache_flags', $f);
1168     } else {
1169         $f = new object();
1170         $f->flagtype     = $type;
1171         $f->name         = $name;
1172         $f->value        = $value;
1173         $f->expiry       = $expiry;
1174         $f->timemodified = $timemodified;
1175         $DB->insert_record('cache_flags', $f);
1176     }
1177     return true;
1180 /**
1181  * Removes a single volatile flag
1182  *
1183  * @global object
1184  * @param string $type the "type" namespace for the key
1185  * @param string $name the key to set
1186  * @return bool
1187  */
1188 function unset_cache_flag($type, $name) {
1189     global $DB;
1190     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1191     return true;
1194 /**
1195  * Garbage-collect volatile flags
1196  *
1197  * @return bool Always returns true
1198  */
1199 function gc_cache_flags() {
1200     global $DB;
1201     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1202     return true;
1205 /// FUNCTIONS FOR HANDLING USER PREFERENCES ////////////////////////////////////
1207 /**
1208  * Refresh current $USER session global variable with all their current preferences.
1209  *
1210  * @global object
1211  * @param mixed $time default null
1212  * @return void
1213  */
1214 function check_user_preferences_loaded($time = null) {
1215     global $USER, $DB;
1216     static $timenow = null; // Static cache, so we only check up-to-dateness once per request.
1218     if (!empty($USER->preference) && isset($USER->preference['_lastloaded'])) {
1219         // Already loaded. Are we up to date?
1221         if (is_null($timenow) || (!is_null($time) && $time != $timenow)) {
1222             $timenow = time();
1223             if (!get_cache_flag('userpreferenceschanged', $USER->id, $USER->preference['_lastloaded'])) {
1224                 // We are up-to-date.
1225                 return;
1226             }
1227         } else {
1228             // Already checked for up-to-date-ness.
1229             return;
1230         }
1231     }
1233     // OK, so we have to reload. Reset preference
1234     $USER->preference = array();
1236     if (!isloggedin() or isguestuser()) {
1237         // No permanent storage for not-logged-in user and guest
1239     } else if ($preferences = $DB->get_records('user_preferences', array('userid'=>$USER->id))) {
1240         foreach ($preferences as $preference) {
1241             $USER->preference[$preference->name] = $preference->value;
1242         }
1243     }
1245     $USER->preference['_lastloaded'] = $timenow;
1248 /**
1249  * Called from set/delete_user_preferences, so that the prefs can be correctly reloaded.
1250  *
1251  * @global object
1252  * @global object
1253  * @param integer $userid the user whose prefs were changed.
1254  */
1255 function mark_user_preferences_changed($userid) {
1256     global $CFG, $USER;
1257     if ($userid == $USER->id) {
1258         check_user_preferences_loaded(time());
1259     }
1260     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1263 /**
1264  * Sets a preference for the current user
1265  *
1266  * Optionally, can set a preference for a different user object
1267  *
1268  * @todo Add a better description and include usage examples. Add inline links to $USER and user functions in above line.
1269  *
1270  * @global object
1271  * @global object
1272  * @param string $name The key to set as preference for the specified user
1273  * @param string $value The value to set for the $name key in the specified user's record
1274  * @param int $otheruserid A moodle user ID, default null
1275  * @return bool
1276  */
1277 function set_user_preference($name, $value, $otheruserid=NULL) {
1278     global $USER, $DB;
1280     if (empty($name)) {
1281         return false;
1282     }
1284     $nostore = false;
1285     if (empty($otheruserid)){
1286         if (!isloggedin() or isguestuser()) {
1287             $nostore = true;
1288         }
1289         $userid = $USER->id;
1290     } else {
1291         if (isguestuser($otheruserid)) {
1292             $nostore = true;
1293         }
1294         $userid = $otheruserid;
1295     }
1297     if ($nostore) {
1298         // no permanent storage for not-logged-in user and guest
1300     } else if ($preference = $DB->get_record('user_preferences', array('userid'=>$userid, 'name'=>$name))) {
1301         if ($preference->value === $value) {
1302             return true;
1303         }
1304         $DB->set_field('user_preferences', 'value', (string)$value, array('id'=>$preference->id));
1306     } else {
1307         $preference = new object();
1308         $preference->userid = $userid;
1309         $preference->name   = $name;
1310         $preference->value  = (string)$value;
1311         $DB->insert_record('user_preferences', $preference);
1312     }
1314     mark_user_preferences_changed($userid);
1315     // update value in USER session if needed
1316     if ($userid == $USER->id) {
1317         $USER->preference[$name] = (string)$value;
1318         $USER->preference['_lastloaded'] = time();
1319     }
1321     return true;
1324 /**
1325  * Sets a whole array of preferences for the current user
1326  *
1327  * @param array $prefarray An array of key/value pairs to be set
1328  * @param int $otheruserid A moodle user ID
1329  * @return bool
1330  */
1331 function set_user_preferences($prefarray, $otheruserid=NULL) {
1333     if (!is_array($prefarray) or empty($prefarray)) {
1334         return false;
1335     }
1337     foreach ($prefarray as $name => $value) {
1338         set_user_preference($name, $value, $otheruserid);
1339     }
1340     return true;
1343 /**
1344  * Unsets a preference completely by deleting it from the database
1345  *
1346  * Optionally, can set a preference for a different user id
1347  *
1348  * @global object
1349  * @param string  $name The key to unset as preference for the specified user
1350  * @param int $otheruserid A moodle user ID
1351  */
1352 function unset_user_preference($name, $otheruserid=NULL) {
1353     global $USER, $DB;
1355     if (empty($otheruserid)){
1356         $userid = $USER->id;
1357         check_user_preferences_loaded();
1358     } else {
1359         $userid = $otheruserid;
1360     }
1362     //Then from DB
1363     $DB->delete_records('user_preferences', array('userid'=>$userid, 'name'=>$name));
1365     mark_user_preferences_changed($userid);
1366     //Delete the preference from $USER if needed
1367     if ($userid == $USER->id) {
1368         unset($USER->preference[$name]);
1369         $USER->preference['_lastloaded'] = time();
1370     }
1372     return true;
1375 /**
1376  * Used to fetch user preference(s)
1377  *
1378  * If no arguments are supplied this function will return
1379  * all of the current user preferences as an array.
1380  *
1381  * If a name is specified then this function
1382  * attempts to return that particular preference value.  If
1383  * none is found, then the optional value $default is returned,
1384  * otherwise NULL.
1385  *
1386  * @global object
1387  * @global object
1388  * @param string $name Name of the key to use in finding a preference value
1389  * @param string $default Value to be returned if the $name key is not set in the user preferences
1390  * @param int $otheruserid A moodle user ID
1391  * @return string
1392  */
1393 function get_user_preferences($name=NULL, $default=NULL, $otheruserid=NULL) {
1394     global $USER, $DB;
1396     if (empty($otheruserid) || (isloggedin() && ($USER->id == $otheruserid))){
1397         check_user_preferences_loaded();
1399         if (empty($name)) {
1400             return $USER->preference; // All values
1401         } else if (array_key_exists($name, $USER->preference)) {
1402             return $USER->preference[$name]; // The single value
1403         } else {
1404             return $default; // Default value (or NULL)
1405         }
1407     } else {
1408         if (empty($name)) {
1409             return $DB->get_records_menu('user_preferences', array('userid'=>$otheruserid), '', 'name,value'); // All values
1410         } else if ($value = $DB->get_field('user_preferences', 'value', array('userid'=>$otheruserid, 'name'=>$name))) {
1411             return $value; // The single value
1412         } else {
1413             return $default; // Default value (or NULL)
1414         }
1415     }
1418 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1420 /**
1421  * Given date parts in user time produce a GMT timestamp.
1422  *
1423  * @todo Finish documenting this function
1424  * @param int $year The year part to create timestamp of
1425  * @param int $month The month part to create timestamp of
1426  * @param int $day The day part to create timestamp of
1427  * @param int $hour The hour part to create timestamp of
1428  * @param int $minute The minute part to create timestamp of
1429  * @param int $second The second part to create timestamp of
1430  * @param float $timezone Timezone modifier
1431  * @param bool $applydst Toggle Daylight Saving Time, default true
1432  * @return int timestamp
1433  */
1434 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1436     $strtimezone = NULL;
1437     if (!is_numeric($timezone)) {
1438         $strtimezone = $timezone;
1439     }
1441     $timezone = get_user_timezone_offset($timezone);
1443     if (abs($timezone) > 13) {
1444         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1445     } else {
1446         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1447         $time = usertime($time, $timezone);
1448         if($applydst) {
1449             $time -= dst_offset_on($time, $strtimezone);
1450         }
1451     }
1453     return $time;
1457 /**
1458  * Format a date/time (seconds) as weeks, days, hours etc as needed
1459  *
1460  * Given an amount of time in seconds, returns string
1461  * formatted nicely as weeks, days, hours etc as needed
1462  *
1463  * @uses MINSECS
1464  * @uses HOURSECS
1465  * @uses DAYSECS
1466  * @uses YEARSECS
1467  * @param int $totalsecs Time in seconds
1468  * @param object $str Should be a time object
1469  * @return string A nicely formatted date/time string
1470  */
1471  function format_time($totalsecs, $str=NULL) {
1473     $totalsecs = abs($totalsecs);
1475     if (!$str) {  // Create the str structure the slow way
1476         $str->day   = get_string('day');
1477         $str->days  = get_string('days');
1478         $str->hour  = get_string('hour');
1479         $str->hours = get_string('hours');
1480         $str->min   = get_string('min');
1481         $str->mins  = get_string('mins');
1482         $str->sec   = get_string('sec');
1483         $str->secs  = get_string('secs');
1484         $str->year  = get_string('year');
1485         $str->years = get_string('years');
1486     }
1489     $years     = floor($totalsecs/YEARSECS);
1490     $remainder = $totalsecs - ($years*YEARSECS);
1491     $days      = floor($remainder/DAYSECS);
1492     $remainder = $totalsecs - ($days*DAYSECS);
1493     $hours     = floor($remainder/HOURSECS);
1494     $remainder = $remainder - ($hours*HOURSECS);
1495     $mins      = floor($remainder/MINSECS);
1496     $secs      = $remainder - ($mins*MINSECS);
1498     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1499     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1500     $sh = ($hours == 1) ? $str->hour : $str->hours;
1501     $sd = ($days == 1)  ? $str->day  : $str->days;
1502     $sy = ($years == 1)  ? $str->year  : $str->years;
1504     $oyears = '';
1505     $odays = '';
1506     $ohours = '';
1507     $omins = '';
1508     $osecs = '';
1510     if ($years)  $oyears  = $years .' '. $sy;
1511     if ($days)  $odays  = $days .' '. $sd;
1512     if ($hours) $ohours = $hours .' '. $sh;
1513     if ($mins)  $omins  = $mins .' '. $sm;
1514     if ($secs)  $osecs  = $secs .' '. $ss;
1516     if ($years) return trim($oyears .' '. $odays);
1517     if ($days)  return trim($odays .' '. $ohours);
1518     if ($hours) return trim($ohours .' '. $omins);
1519     if ($mins)  return trim($omins .' '. $osecs);
1520     if ($secs)  return $osecs;
1521     return get_string('now');
1524 /**
1525  * Returns a formatted string that represents a date in user time
1526  *
1527  * Returns a formatted string that represents a date in user time
1528  * <b>WARNING: note that the format is for strftime(), not date().</b>
1529  * Because of a bug in most Windows time libraries, we can't use
1530  * the nicer %e, so we have to use %d which has leading zeroes.
1531  * A lot of the fuss in the function is just getting rid of these leading
1532  * zeroes as efficiently as possible.
1533  *
1534  * If parameter fixday = true (default), then take off leading
1535  * zero from %d, else maintain it.
1536  *
1537  * @param int $date the timestamp in UTC, as obtained from the database.
1538  * @param string $format strftime format. You should probably get this using
1539  *      get_string('strftime...', 'langconfig');
1540  * @param float $timezone by default, uses the user's time zone.
1541  * @param bool $fixday If true (default) then the leading zero from %d is removed.
1542  *      If false then the leading zero is maintained.
1543  * @return string the formatted date/time.
1544  */
1545 function userdate($date, $format = '', $timezone = 99, $fixday = true) {
1547     global $CFG;
1549     $strtimezone = NULL;
1550     if (!is_numeric($timezone)) {
1551         $strtimezone = $timezone;
1552     }
1554     if (empty($format)) {
1555         $format = get_string('strftimedaydatetime', 'langconfig');
1556     }
1558     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
1559         $fixday = false;
1560     } else if ($fixday) {
1561         $formatnoday = str_replace('%d', 'DD', $format);
1562         $fixday = ($formatnoday != $format);
1563     }
1565     $date += dst_offset_on($date, $strtimezone);
1567     $timezone = get_user_timezone_offset($timezone);
1569     if (abs($timezone) > 13) {   /// Server time
1570         if ($fixday) {
1571             $datestring = strftime($formatnoday, $date);
1572             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
1573             $datestring = str_replace('DD', $daystring, $datestring);
1574         } else {
1575             $datestring = strftime($format, $date);
1576         }
1577     } else {
1578         $date += (int)($timezone * 3600);
1579         if ($fixday) {
1580             $datestring = gmstrftime($formatnoday, $date);
1581             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
1582             $datestring = str_replace('DD', $daystring, $datestring);
1583         } else {
1584             $datestring = gmstrftime($format, $date);
1585         }
1586     }
1588 /// If we are running under Windows convert from windows encoding to UTF-8
1589 /// (because it's impossible to specify UTF-8 to fetch locale info in Win32)
1591    if ($CFG->ostype == 'WINDOWS') {
1592        if ($localewincharset = get_string('localewincharset', 'langconfig')) {
1593            $textlib = textlib_get_instance();
1594            $datestring = $textlib->convert($datestring, $localewincharset, 'utf-8');
1595        }
1596    }
1598     return $datestring;
1601 /**
1602  * Given a $time timestamp in GMT (seconds since epoch),
1603  * returns an array that represents the date in user time
1604  *
1605  * @todo Finish documenting this function
1606  * @uses HOURSECS
1607  * @param int $time Timestamp in GMT
1608  * @param float $timezone ?
1609  * @return array An array that represents the date in user time
1610  */
1611 function usergetdate($time, $timezone=99) {
1613     $strtimezone = NULL;
1614     if (!is_numeric($timezone)) {
1615         $strtimezone = $timezone;
1616     }
1618     $timezone = get_user_timezone_offset($timezone);
1620     if (abs($timezone) > 13) {    // Server time
1621         return getdate($time);
1622     }
1624     // There is no gmgetdate so we use gmdate instead
1625     $time += dst_offset_on($time, $strtimezone);
1626     $time += intval((float)$timezone * HOURSECS);
1628     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
1630     //be careful to ensure the returned array matches that produced by getdate() above
1631     list(
1632         $getdate['month'],
1633         $getdate['weekday'],
1634         $getdate['yday'],
1635         $getdate['year'],
1636         $getdate['mon'],
1637         $getdate['wday'],
1638         $getdate['mday'],
1639         $getdate['hours'],
1640         $getdate['minutes'],
1641         $getdate['seconds']
1642     ) = explode('_', $datestring);
1644     return $getdate;
1647 /**
1648  * Given a GMT timestamp (seconds since epoch), offsets it by
1649  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
1650  *
1651  * @uses HOURSECS
1652  * @param  int $date Timestamp in GMT
1653  * @param float $timezone
1654  * @return int
1655  */
1656 function usertime($date, $timezone=99) {
1658     $timezone = get_user_timezone_offset($timezone);
1660     if (abs($timezone) > 13) {
1661         return $date;
1662     }
1663     return $date - (int)($timezone * HOURSECS);
1666 /**
1667  * Given a time, return the GMT timestamp of the most recent midnight
1668  * for the current user.
1669  *
1670  * @param int $date Timestamp in GMT
1671  * @param float $timezone Defaults to user's timezone
1672  * @return int Returns a GMT timestamp
1673  */
1674 function usergetmidnight($date, $timezone=99) {
1676     $userdate = usergetdate($date, $timezone);
1678     // Time of midnight of this user's day, in GMT
1679     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
1683 /**
1684  * Returns a string that prints the user's timezone
1685  *
1686  * @param float $timezone The user's timezone
1687  * @return string
1688  */
1689 function usertimezone($timezone=99) {
1691     $tz = get_user_timezone($timezone);
1693     if (!is_float($tz)) {
1694         return $tz;
1695     }
1697     if(abs($tz) > 13) { // Server time
1698         return get_string('serverlocaltime');
1699     }
1701     if($tz == intval($tz)) {
1702         // Don't show .0 for whole hours
1703         $tz = intval($tz);
1704     }
1706     if($tz == 0) {
1707         return 'UTC';
1708     }
1709     else if($tz > 0) {
1710         return 'UTC+'.$tz;
1711     }
1712     else {
1713         return 'UTC'.$tz;
1714     }
1718 /**
1719  * Returns a float which represents the user's timezone difference from GMT in hours
1720  * Checks various settings and picks the most dominant of those which have a value
1721  *
1722  * @global object
1723  * @global object
1724  * @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
1725  * @return float
1726  */
1727 function get_user_timezone_offset($tz = 99) {
1729     global $USER, $CFG;
1731     $tz = get_user_timezone($tz);
1733     if (is_float($tz)) {
1734         return $tz;
1735     } else {
1736         $tzrecord = get_timezone_record($tz);
1737         if (empty($tzrecord)) {
1738             return 99.0;
1739         }
1740         return (float)$tzrecord->gmtoff / HOURMINS;
1741     }
1744 /**
1745  * Returns an int which represents the systems's timezone difference from GMT in seconds
1746  *
1747  * @global object
1748  * @param mixed $tz timezone
1749  * @return int if found, false is timezone 99 or error
1750  */
1751 function get_timezone_offset($tz) {
1752     global $CFG;
1754     if ($tz == 99) {
1755         return false;
1756     }
1758     if (is_numeric($tz)) {
1759         return intval($tz * 60*60);
1760     }
1762     if (!$tzrecord = get_timezone_record($tz)) {
1763         return false;
1764     }
1765     return intval($tzrecord->gmtoff * 60);
1768 /**
1769  * Returns a float or a string which denotes the user's timezone
1770  * 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)
1771  * means that for this timezone there are also DST rules to be taken into account
1772  * Checks various settings and picks the most dominant of those which have a value
1773  *
1774  * @global object
1775  * @global object
1776  * @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
1777  * @return mixed
1778  */
1779 function get_user_timezone($tz = 99) {
1780     global $USER, $CFG;
1782     $timezones = array(
1783         $tz,
1784         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
1785         isset($USER->timezone) ? $USER->timezone : 99,
1786         isset($CFG->timezone) ? $CFG->timezone : 99,
1787         );
1789     $tz = 99;
1791     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
1792         $tz = $next['value'];
1793     }
1795     return is_numeric($tz) ? (float) $tz : $tz;
1798 /**
1799  * Returns cached timezone record for given $timezonename
1800  *
1801  * @global object
1802  * @global object
1803  * @param string $timezonename
1804  * @return mixed timezonerecord object or false
1805  */
1806 function get_timezone_record($timezonename) {
1807     global $CFG, $DB;
1808     static $cache = NULL;
1810     if ($cache === NULL) {
1811         $cache = array();
1812     }
1814     if (isset($cache[$timezonename])) {
1815         return $cache[$timezonename];
1816     }
1818     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
1819                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), true);
1822 /**
1823  * Build and store the users Daylight Saving Time (DST) table
1824  *
1825  * @global object
1826  * @global object
1827  * @global object
1828  * @param mixed $from_year Start year for the table, defaults to 1971
1829  * @param mixed $to_year End year for the table, defaults to 2035
1830  * @param mixed $strtimezone
1831  * @return bool
1832  */
1833 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
1834     global $CFG, $SESSION, $DB;
1836     $usertz = get_user_timezone($strtimezone);
1838     if (is_float($usertz)) {
1839         // Trivial timezone, no DST
1840         return false;
1841     }
1843     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
1844         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
1845         unset($SESSION->dst_offsets);
1846         unset($SESSION->dst_range);
1847     }
1849     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
1850         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
1851         // This will be the return path most of the time, pretty light computationally
1852         return true;
1853     }
1855     // Reaching here means we either need to extend our table or create it from scratch
1857     // Remember which TZ we calculated these changes for
1858     $SESSION->dst_offsettz = $usertz;
1860     if(empty($SESSION->dst_offsets)) {
1861         // If we 're creating from scratch, put the two guard elements in there
1862         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
1863     }
1864     if(empty($SESSION->dst_range)) {
1865         // If creating from scratch
1866         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
1867         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
1869         // Fill in the array with the extra years we need to process
1870         $yearstoprocess = array();
1871         for($i = $from; $i <= $to; ++$i) {
1872             $yearstoprocess[] = $i;
1873         }
1875         // Take note of which years we have processed for future calls
1876         $SESSION->dst_range = array($from, $to);
1877     }
1878     else {
1879         // If needing to extend the table, do the same
1880         $yearstoprocess = array();
1882         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
1883         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
1885         if($from < $SESSION->dst_range[0]) {
1886             // Take note of which years we need to process and then note that we have processed them for future calls
1887             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
1888                 $yearstoprocess[] = $i;
1889             }
1890             $SESSION->dst_range[0] = $from;
1891         }
1892         if($to > $SESSION->dst_range[1]) {
1893             // Take note of which years we need to process and then note that we have processed them for future calls
1894             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
1895                 $yearstoprocess[] = $i;
1896             }
1897             $SESSION->dst_range[1] = $to;
1898         }
1899     }
1901     if(empty($yearstoprocess)) {
1902         // This means that there was a call requesting a SMALLER range than we have already calculated
1903         return true;
1904     }
1906     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
1907     // Also, the array is sorted in descending timestamp order!
1909     // Get DB data
1911     static $presets_cache = array();
1912     if (!isset($presets_cache[$usertz])) {
1913         $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');
1914     }
1915     if(empty($presets_cache[$usertz])) {
1916         return false;
1917     }
1919     // Remove ending guard (first element of the array)
1920     reset($SESSION->dst_offsets);
1921     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
1923     // Add all required change timestamps
1924     foreach($yearstoprocess as $y) {
1925         // Find the record which is in effect for the year $y
1926         foreach($presets_cache[$usertz] as $year => $preset) {
1927             if($year <= $y) {
1928                 break;
1929             }
1930         }
1932         $changes = dst_changes_for_year($y, $preset);
1934         if($changes === NULL) {
1935             continue;
1936         }
1937         if($changes['dst'] != 0) {
1938             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
1939         }
1940         if($changes['std'] != 0) {
1941             $SESSION->dst_offsets[$changes['std']] = 0;
1942         }
1943     }
1945     // Put in a guard element at the top
1946     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
1947     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
1949     // Sort again
1950     krsort($SESSION->dst_offsets);
1952     return true;
1955 /**
1956  * Calculates the required DST change and returns a Timestamp Array
1957  *
1958  * @uses HOURSECS
1959  * @uses MINSECS
1960  * @param mixed $year Int or String Year to focus on
1961  * @param object $timezone Instatiated Timezone object
1962  * @return mixed Null, or Array dst=>xx, 0=>xx, std=>yy, 1=>yy
1963  */
1964 function dst_changes_for_year($year, $timezone) {
1966     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
1967         return NULL;
1968     }
1970     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
1971     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
1973     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
1974     list($std_hour, $std_min) = explode(':', $timezone->std_time);
1976     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
1977     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
1979     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
1980     // This has the advantage of being able to have negative values for hour, i.e. for timezones
1981     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
1983     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
1984     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
1986     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
1989 /**
1990  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
1991  *
1992  * @global object
1993  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
1994  * @return int
1995  */
1996 function dst_offset_on($time, $strtimezone = NULL) {
1997     global $SESSION;
1999     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2000         return 0;
2001     }
2003     reset($SESSION->dst_offsets);
2004     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2005         if($from <= $time) {
2006             break;
2007         }
2008     }
2010     // This is the normal return path
2011     if($offset !== NULL) {
2012         return $offset;
2013     }
2015     // Reaching this point means we haven't calculated far enough, do it now:
2016     // Calculate extra DST changes if needed and recurse. The recursion always
2017     // moves toward the stopping condition, so will always end.
2019     if($from == 0) {
2020         // We need a year smaller than $SESSION->dst_range[0]
2021         if($SESSION->dst_range[0] == 1971) {
2022             return 0;
2023         }
2024         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2025         return dst_offset_on($time, $strtimezone);
2026     }
2027     else {
2028         // We need a year larger than $SESSION->dst_range[1]
2029         if($SESSION->dst_range[1] == 2035) {
2030             return 0;
2031         }
2032         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2033         return dst_offset_on($time, $strtimezone);
2034     }
2037 /**
2038  * ?
2039  *
2040  * @todo Document what this function does
2041  * @param int $startday
2042  * @param int $weekday
2043  * @param int $month
2044  * @param int $year
2045  * @return int
2046  */
2047 function find_day_in_month($startday, $weekday, $month, $year) {
2049     $daysinmonth = days_in_month($month, $year);
2051     if($weekday == -1) {
2052         // Don't care about weekday, so return:
2053         //    abs($startday) if $startday != -1
2054         //    $daysinmonth otherwise
2055         return ($startday == -1) ? $daysinmonth : abs($startday);
2056     }
2058     // From now on we 're looking for a specific weekday
2060     // Give "end of month" its actual value, since we know it
2061     if($startday == -1) {
2062         $startday = -1 * $daysinmonth;
2063     }
2065     // Starting from day $startday, the sign is the direction
2067     if($startday < 1) {
2069         $startday = abs($startday);
2070         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2072         // This is the last such weekday of the month
2073         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2074         if($lastinmonth > $daysinmonth) {
2075             $lastinmonth -= 7;
2076         }
2078         // Find the first such weekday <= $startday
2079         while($lastinmonth > $startday) {
2080             $lastinmonth -= 7;
2081         }
2083         return $lastinmonth;
2085     }
2086     else {
2088         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year, 0));
2090         $diff = $weekday - $indexweekday;
2091         if($diff < 0) {
2092             $diff += 7;
2093         }
2095         // This is the first such weekday of the month equal to or after $startday
2096         $firstfromindex = $startday + $diff;
2098         return $firstfromindex;
2100     }
2103 /**
2104  * Calculate the number of days in a given month
2105  *
2106  * @param int $month The month whose day count is sought
2107  * @param int $year The year of the month whose day count is sought
2108  * @return int
2109  */
2110 function days_in_month($month, $year) {
2111    return intval(date('t', mktime(12, 0, 0, $month, 1, $year, 0)));
2114 /**
2115  * Calculate the position in the week of a specific calendar day
2116  *
2117  * @param int $day The day of the date whose position in the week is sought
2118  * @param int $month The month of the date whose position in the week is sought
2119  * @param int $year The year of the date whose position in the week is sought
2120  * @return int
2121  */
2122 function dayofweek($day, $month, $year) {
2123     // I wonder if this is any different from
2124     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2125     return intval(date('w', mktime(12, 0, 0, $month, $day, $year, 0)));
2128 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2130 /**
2131  * Returns full login url.
2132  *
2133  * @return string login url
2134  */
2135 function get_login_url() {
2136     global $CFG;
2138     $url = "$CFG->wwwroot/login/index.php";
2140     if (!empty($CFG->loginhttps)) {
2141         $url = str_replace('http:', 'https:', $url);
2142     }
2144     return $url;
2147 /**
2148  * This function checks that the current user is logged in and has the
2149  * required privileges
2150  *
2151  * This function checks that the current user is logged in, and optionally
2152  * whether they are allowed to be in a particular course and view a particular
2153  * course module.
2154  * If they are not logged in, then it redirects them to the site login unless
2155  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2156  * case they are automatically logged in as guests.
2157  * If $courseid is given and the user is not enrolled in that course then the
2158  * user is redirected to the course enrolment page.
2159  * If $cm is given and the course module is hidden and the user is not a teacher
2160  * in the course then the user is redirected to the course home page.
2161  *
2162  * When $cm parameter specified, this function sets page layout to 'module'.
2163  * You need to change it manually later if some other layout needed.
2164  *
2165  * @param mixed $courseorid id of the course or course object
2166  * @param bool $autologinguest default true
2167  * @param object $cm course module object
2168  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2169  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2170  *             in order to keep redirects working properly. MDL-14495
2171  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2172  * @return mixed Void, exit, and die depending on path
2173  */
2174 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2175     global $CFG, $SESSION, $USER, $FULLME, $PAGE, $SITE, $DB, $OUTPUT;
2177     // setup global $COURSE, themes, language and locale
2178     if (!empty($courseorid)) {
2179         if (is_object($courseorid)) {
2180             $course = $courseorid;
2181         } else if ($courseorid == SITEID) {
2182             $course = clone($SITE);
2183         } else {
2184             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2185         }
2186         if ($cm) {
2187             if ($cm->course != $course->id) {
2188                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2189             }
2190             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2191             $PAGE->set_pagelayout('incourse');
2192         } else {
2193             $PAGE->set_course($course); // set's up global $COURSE
2194         }
2195     } else {
2196         // do not touch global $COURSE via $PAGE->set_course(),
2197         // the reasons is we need to be able to call require_login() at any time!!
2198         $course = $SITE;
2199         if ($cm) {
2200             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2201         }
2202     }
2204     // If the user is not even logged in yet then make sure they are
2205     if (!isloggedin()) {
2206         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2207             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2208                 // misconfigured site guest, just redirect to login page
2209                 redirect(get_login_url());
2210                 exit; // never reached
2211             }
2212             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2213             complete_user_login($guest, false);
2214             $SESSION->lang = $lang;
2215         } else {
2216             //NOTE: $USER->site check was obsoleted by session test cookie,
2217             //      $USER->confirmed test is in login/index.php
2218             if ($preventredirect) {
2219                 throw new require_login_exception('You are not logged in');
2220             }
2222             if ($setwantsurltome) {
2223                 // TODO: switch to PAGE->url
2224                 $SESSION->wantsurl = $FULLME;
2225             }
2226             if (!empty($_SERVER['HTTP_REFERER'])) {
2227                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2228             }
2229             redirect(get_login_url());
2230             exit; // never reached
2231         }
2232     }
2234     // loginas as redirection if needed
2235     if ($course->id != SITEID and session_is_loggedinas()) {
2236         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2237             if ($USER->loginascontext->instanceid != $course->id) {
2238                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2239             }
2240         }
2241     }
2243     // check whether the user should be changing password (but only if it is REALLY them)
2244     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2245         $userauth = get_auth_plugin($USER->auth);
2246         if ($userauth->can_change_password() and !$preventredirect) {
2247             $SESSION->wantsurl = $FULLME;
2248             if ($changeurl = $userauth->change_password_url()) {
2249                 //use plugin custom url
2250                 redirect($changeurl);
2251             } else {
2252                 //use moodle internal method
2253                 if (empty($CFG->loginhttps)) {
2254                     redirect($CFG->wwwroot .'/login/change_password.php');
2255                 } else {
2256                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2257                     redirect($wwwroot .'/login/change_password.php');
2258                 }
2259             }
2260         } else {
2261             print_error('nopasswordchangeforced', 'auth');
2262         }
2263     }
2265     // Check that the user account is properly set up
2266     if (user_not_fully_set_up($USER)) {
2267         if ($preventredirect) {
2268             throw new require_login_exception('User not fully set-up');
2269         }
2270         $SESSION->wantsurl = $FULLME;
2271         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2272     }
2274     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2275     sesskey();
2277     // Do not bother admins with any formalities
2278     if (is_siteadmin()) {
2279         //set accesstime or the user will appear offline which messes up messaging
2280         user_accesstime_log($course->id);
2281         return;
2282     }
2284     // Check that the user has agreed to a site policy if there is one
2285     if (!empty($CFG->sitepolicy)) {
2286         if ($preventredirect) {
2287             throw new require_login_exception('Policy not agreed');
2288         }
2289         if (!$USER->policyagreed) {
2290             $SESSION->wantsurl = $FULLME;
2291             redirect($CFG->wwwroot .'/user/policy.php');
2292         }
2293     }
2295     // Fetch the system context, the course context, and prefetch its child contexts
2296     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2297     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2298     if ($cm) {
2299         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2300     } else {
2301         $cmcontext = null;
2302     }
2304     // If the site is currently under maintenance, then print a message
2305     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2306         if ($preventredirect) {
2307             throw new require_login_exception('Maintenance in progress');
2308         }
2310         print_maintenance_message();
2311     }
2313     // make sure the course itself is not hidden
2314     if ($course->id == SITEID) {
2315         // frontpage can not be hidden
2316     } else {
2317         if (is_role_switched($course->id)) {
2318             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2319         } else {
2320             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2321                 // originally there was also test of parent category visibility,
2322                 // BUT is was very slow in complex queries involving "my courses"
2323                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2324                 if ($preventredirect) {
2325                     throw new require_login_exception('Course is hidden');
2326                 }
2327                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2328             }
2329         }
2330     }
2332     // is the user enrolled?
2333     if ($course->id == SITEID) {
2334         // everybody is enrolled on the frontpage
2336     } else {
2337         if (session_is_loggedinas()) {
2338             // Make sure the REAL person can access this course first
2339             $realuser = session_get_realuser();
2340             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2341                 if ($preventredirect) {
2342                     throw new require_login_exception('Invalid course login-as access');
2343                 }
2344                 echo $OUTPUT->header();
2345                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2346             }
2347         }
2349         // very simple enrolment caching - changes in course setting are not reflected immediately
2350         if (!isset($USER->enrol)) {
2351             $USER->enrol = array();
2352             $USER->enrol['enrolled'] = array();
2353             $USER->enrol['tempguest'] = array();
2354         }
2356         $access = false;
2358         if (is_viewing($coursecontext, $USER)) {
2359             // ok, no need to mess with enrol
2360             $access = true;
2362         } else {
2363             if (isset($USER->enrol['enrolled'][$course->id])) {
2364                 if ($USER->enrol['enrolled'][$course->id] == 0) {
2365                     $access = true;
2366                 } else if ($USER->enrol['enrolled'][$course->id] > time()) {
2367                     $access = true;
2368                 } else {
2369                     //expired
2370                     unset($USER->enrol['enrolled'][$course->id]);
2371                 }
2372             }
2373             if (isset($USER->enrol['tempguest'][$course->id])) {
2374                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2375                     $access = true;
2376                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2377                     $access = true;
2378                 } else {
2379                     //expired
2380                     unset($USER->enrol['tempguest'][$course->id]);
2381                     $USER->access = remove_temp_roles($coursecontext, $USER->access);
2382                 }
2383             }
2385             if ($access) {
2386                 // cache ok
2387             } else if (is_enrolled($coursecontext, $USER, '', true)) {
2388                 // active participants may always access
2389                 // TODO: refactor this into some new function
2390                 $now = time();
2391                 $sql = "SELECT MAX(ue.timeend)
2392                           FROM {user_enrolments} ue
2393                           JOIN {enrol} e ON (e.id = ue.enrolid AND e.courseid = :courseid)
2394                           JOIN {user} u ON u.id = ue.userid
2395                          WHERE ue.userid = :userid AND ue.status = :active AND e.status = :enabled AND u.deleted = 0
2396                                AND ue.timestart < :now1 AND (ue.timeend = 0 OR ue.timeend > :now2)";
2397                 $params = array('enabled'=>ENROL_INSTANCE_ENABLED, 'active'=>ENROL_USER_ACTIVE,
2398                                 'userid'=>$USER->id, 'courseid'=>$coursecontext->instanceid, 'now1'=>$now, 'now2'=>$now);
2399                 $until = $DB->get_field_sql($sql, $params);
2400                 if (!$until or $until > time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD) {
2401                     $until = time() + ENROL_REQUIRE_LOGIN_CACHE_PERIOD;
2402                 }
2404                 $USER->enrol['enrolled'][$course->id] = $until;
2405                 $access = true;
2407                 // remove traces of previous temp guest access
2408                 $USER->access = remove_temp_roles($coursecontext, $USER->access);
2410             } else {
2411                 $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2412                 $enrols = enrol_get_plugins(true);
2413                 // first ask all enabled enrol instances in course if they want to auto enrol user
2414                 foreach($instances as $instance) {
2415                     if (!isset($enrols[$instance->enrol])) {
2416                         continue;
2417                     }
2418                     $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2419                     if ($until !== false) {
2420                         $USER->enrol['enrolled'][$course->id] = $until;
2421                         $USER->access = remove_temp_roles($coursecontext, $USER->access);
2422                         $access = true;
2423                         break;
2424                     }
2425                 }
2426                 // if not enrolled yet try to gain temporary guest access
2427                 if (!$access) {
2428                     foreach($instances as $instance) {
2429                         if (!isset($enrols[$instance->enrol])) {
2430                             continue;
2431                         }
2432                         $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2433                         if ($until !== false) {
2434                             $USER->enrol['tempguest'][$course->id] = $until;
2435                             $access = true;
2436                             break;
2437                         }
2438                     }
2439                 }
2440             }
2441         }
2443         if (!$access) {
2444             if ($preventredirect) {
2445                 throw new require_login_exception('Not enrolled');
2446             }
2447             $SESSION->wantsurl = $FULLME;
2448             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
2449         }
2450     }
2452     // test visibility
2453     if ($cm && !$cm->visible && !has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2454         if ($preventredirect) {
2455             throw new require_login_exception('Activity is hidden');
2456         }
2457         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
2458     }
2460     // groupmembersonly access control
2461     if (!empty($CFG->enablegroupmembersonly) and $cm and $cm->groupmembersonly and !has_capability('moodle/site:accessallgroups', get_context_instance(CONTEXT_MODULE, $cm->id))) {
2462         if (isguestuser() or !groups_has_membership($cm)) {
2463             if ($preventredirect) {
2464                 throw new require_login_exception('Not member of a group');
2465             }
2466             print_error('groupmembersonlyerror', 'group', $CFG->wwwroot.'/course/view.php?id='.$cm->course);
2467         }
2468     }
2470     // Conditional activity access control
2471     if (!empty($CFG->enableavailability) and $cm) {
2472         // TODO: this is going to work with login-as-user, sorry!
2473         // We cache conditional access in session
2474         if (!isset($SESSION->conditionaccessok)) {
2475             $SESSION->conditionaccessok = array();
2476         }
2477         // If you have been allowed into the module once then you are allowed
2478         // in for rest of session, no need to do conditional checks
2479         if (!array_key_exists($cm->id, $SESSION->conditionaccessok)) {
2480             // Get condition info (does a query for the availability table)
2481             require_once($CFG->libdir.'/conditionlib.php');
2482             $ci = new condition_info($cm, CONDITION_MISSING_EXTRATABLE);
2483             // Check condition for user (this will do a query if the availability
2484             // information depends on grade or completion information)
2485             if ($ci->is_available($junk) || has_capability('moodle/course:viewhiddenactivities', $cmcontext)) {
2486                 $SESSION->conditionaccessok[$cm->id] = true;
2487             } else {
2488                 print_error('activityiscurrentlyhidden');
2489             }
2490         }
2491     }
2493     // Finally access granted, update lastaccess times
2494     user_accesstime_log($course->id);
2498 /**
2499  * This function just makes sure a user is logged out.
2500  *
2501  * @global object
2502  */
2503 function require_logout() {
2504     global $USER;
2506     if (isloggedin()) {
2507         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
2509         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
2510         foreach($authsequence as $authname) {
2511             $authplugin = get_auth_plugin($authname);
2512             $authplugin->prelogout_hook();
2513         }
2514     }
2516     session_get_instance()->terminate_current();
2519 /**
2520  * Weaker version of require_login()
2521  *
2522  * This is a weaker version of {@link require_login()} which only requires login
2523  * when called from within a course rather than the site page, unless
2524  * the forcelogin option is turned on.
2525  * @see require_login()
2526  *
2527  * @global object
2528  * @param mixed $courseorid The course object or id in question
2529  * @param bool $autologinguest Allow autologin guests if that is wanted
2530  * @param object $cm Course activity module if known
2531  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2532  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2533  *             in order to keep redirects working properly. MDL-14495
2534  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2535  * @return void
2536  */
2537 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2538     global $CFG, $PAGE, $SITE;
2539     if (!empty($CFG->forcelogin)) {
2540         // login required for both SITE and courses
2541         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2543     } else if (!empty($cm) and !$cm->visible) {
2544         // always login for hidden activities
2545         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2547     } else if ((is_object($courseorid) and $courseorid->id == SITEID)
2548           or (!is_object($courseorid) and $courseorid == SITEID)) {
2549               //login for SITE not required
2550         if ($cm and empty($cm->visible)) {
2551             // hidden activities are not accessible without login
2552             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2553         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
2554             // not-logged-in users do not have any group membership
2555             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2556         } else {
2557             // We still need to instatiate PAGE vars properly so that things
2558             // that rely on it like navigation function correctly.
2559             if (!empty($courseorid)) {
2560                 if (is_object($courseorid)) {
2561                     $course = $courseorid;
2562                 } else {
2563                     $course = clone($SITE);
2564                 }
2565                 if ($cm) {
2566                     if ($cm->course != $course->id) {
2567                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
2568                     }
2569                     $PAGE->set_cm($cm, $course);
2570                     $PAGE->set_pagelayout('incourse');
2571                 } else {
2572                     $PAGE->set_course($course);
2573                 }
2574             } else {
2575                 // If $PAGE->course, and hence $PAGE->context, have not already been set
2576                 // up properly, set them up now.
2577                 $PAGE->set_course($PAGE->course);
2578             }
2579             //TODO: verify conditional activities here
2580             user_accesstime_log(SITEID);
2581             return;
2582         }
2584     } else {
2585         // course login always required
2586         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2587     }
2590 /**
2591  * Require key login. Function terminates with error if key not found or incorrect.
2592  *
2593  * @global object
2594  * @global object
2595  * @global object
2596  * @global object
2597  * @uses NO_MOODLE_COOKIES
2598  * @uses PARAM_ALPHANUM
2599  * @param string $script unique script identifier
2600  * @param int $instance optional instance id
2601  * @return int Instance ID
2602  */
2603 function require_user_key_login($script, $instance=null) {
2604     global $USER, $SESSION, $CFG, $DB;
2606     if (!NO_MOODLE_COOKIES) {
2607         print_error('sessioncookiesdisable');
2608     }
2610 /// extra safety
2611     @session_write_close();
2613     $keyvalue = required_param('key', PARAM_ALPHANUM);
2615     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
2616         print_error('invalidkey');
2617     }
2619     if (!empty($key->validuntil) and $key->validuntil < time()) {
2620         print_error('expiredkey');
2621     }
2623     if ($key->iprestriction) {
2624         $remoteaddr = getremoteaddr(null);
2625         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2626             print_error('ipmismatch');
2627         }
2628     }
2630     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
2631         print_error('invaliduserid');
2632     }
2634 /// emulate normal session
2635     session_set_user($user);
2637 /// note we are not using normal login
2638     if (!defined('USER_KEY_LOGIN')) {
2639         define('USER_KEY_LOGIN', true);
2640     }
2642 /// return instance id - it might be empty
2643     return $key->instance;
2646 /**
2647  * Creates a new private user access key.
2648  *
2649  * @global object
2650  * @param string $script unique target identifier
2651  * @param int $userid
2652  * @param int $instance optional instance id
2653  * @param string $iprestriction optional ip restricted access
2654  * @param timestamp $validuntil key valid only until given data
2655  * @return string access key value
2656  */
2657 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2658     global $DB;
2660     $key = new object();
2661     $key->script        = $script;
2662     $key->userid        = $userid;
2663     $key->instance      = $instance;
2664     $key->iprestriction = $iprestriction;
2665     $key->validuntil    = $validuntil;
2666     $key->timecreated   = time();
2668     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
2669     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
2670         // must be unique
2671         $key->value     = md5($userid.'_'.time().random_string(40));
2672     }
2673     $DB->insert_record('user_private_key', $key);
2674     return $key->value;
2677 /**
2678  * Delete the user's new private user access keys for a particular script.
2679  *
2680  * @global object
2681  * @param string $script unique target identifier
2682  * @param int $userid
2683  * @return void
2684  */
2685 function delete_user_key($script,$userid) {
2686     global $DB;
2687     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
2690 /**
2691  * Gets a private user access key (and creates one if one doesn't exist).
2692  *
2693  * @global object
2694  * @param string $script unique target identifier
2695  * @param int $userid
2696  * @param int $instance optional instance id
2697  * @param string $iprestriction optional ip restricted access
2698  * @param timestamp $validuntil key valid only until given data
2699  * @return string access key value
2700  */
2701 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
2702     global $DB;
2704     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
2705                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
2706                                                          'validuntil'=>$validuntil))) {
2707         return $key->value;
2708     } else {
2709         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
2710     }
2714 /**
2715  * Modify the user table by setting the currently logged in user's
2716  * last login to now.
2717  *
2718  * @global object
2719  * @global object
2720  * @return bool Always returns true
2721  */
2722 function update_user_login_times() {
2723     global $USER, $DB;
2725     $user = new object();
2726     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
2727     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
2729     $user->id = $USER->id;
2731     $DB->update_record('user', $user);
2732     return true;
2735 /**
2736  * Determines if a user has completed setting up their account.
2737  *
2738  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
2739  * @return bool
2740  */
2741 function user_not_fully_set_up($user) {
2742     if (isguestuser($user)) {
2743         return false;
2744     }
2745     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
2748 /**
2749  * Check whether the user has exceeded the bounce threshold
2750  *
2751  * @global object
2752  * @global object
2753  * @param user $user A {@link $USER} object
2754  * @return bool true=>User has exceeded bounce threshold
2755  */
2756 function over_bounce_threshold($user) {
2757     global $CFG, $DB;
2759     if (empty($CFG->handlebounces)) {
2760         return false;
2761     }
2763     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2764         return false;
2765     }
2767     // set sensible defaults
2768     if (empty($CFG->minbounces)) {
2769         $CFG->minbounces = 10;
2770     }
2771     if (empty($CFG->bounceratio)) {
2772         $CFG->bounceratio = .20;
2773     }
2774     $bouncecount = 0;
2775     $sendcount = 0;
2776     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2777         $bouncecount = $bounce->value;
2778     }
2779     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2780         $sendcount = $send->value;
2781     }
2782     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
2785 /**
2786  * Used to increment or reset email sent count
2787  *
2788  * @global object
2789  * @param user $user object containing an id
2790  * @param bool $reset will reset the count to 0
2791  * @return void
2792  */
2793 function set_send_count($user,$reset=false) {
2794     global $DB;
2796     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
2797         return;
2798     }
2800     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
2801         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2802         $DB->update_record('user_preferences', $pref);
2803     }
2804     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2805         // make a new one
2806         $pref = new object();
2807         $pref->name   = 'email_send_count';
2808         $pref->value  = 1;
2809         $pref->userid = $user->id;
2810         $DB->insert_record('user_preferences', $pref, false);
2811     }
2814 /**
2815  * Increment or reset user's email bounce count
2816  *
2817  * @global object
2818  * @param user $user object containing an id
2819  * @param bool $reset will reset the count to 0
2820  */
2821 function set_bounce_count($user,$reset=false) {
2822     global $DB;
2824     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
2825         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
2826         $DB->update_record('user_preferences', $pref);
2827     }
2828     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
2829         // make a new one
2830         $pref = new object();
2831         $pref->name   = 'email_bounce_count';
2832         $pref->value  = 1;
2833         $pref->userid = $user->id;
2834         $DB->insert_record('user_preferences', $pref, false);
2835     }
2838 /**
2839  * Keeps track of login attempts
2840  *
2841  * @global object
2842  */
2843 function update_login_count() {
2844     global $SESSION;
2846     $max_logins = 10;
2848     if (empty($SESSION->logincount)) {
2849         $SESSION->logincount = 1;
2850     } else {
2851         $SESSION->logincount++;
2852     }
2854     if ($SESSION->logincount > $max_logins) {
2855         unset($SESSION->wantsurl);
2856         print_error('errortoomanylogins');
2857     }
2860 /**
2861  * Resets login attempts
2862  *
2863  * @global object
2864  */
2865 function reset_login_count() {
2866     global $SESSION;
2868     $SESSION->logincount = 0;
2871 /**
2872  * Returns reference to full info about modules in course (including visibility).
2873  * Cached and as fast as possible (0 or 1 db query).
2874  *
2875  * @global object
2876  * @global object
2877  * @global object
2878  * @uses CONTEXT_MODULE
2879  * @uses MAX_MODINFO_CACHE_SIZE
2880  * @param mixed $course object or 'reset' string to reset caches, modinfo may be updated in db
2881  * @param int $userid Defaults to current user id
2882  * @return mixed courseinfo object or nothing if resetting
2883  */
2884 function &get_fast_modinfo(&$course, $userid=0) {
2885     global $CFG, $USER, $DB;
2886     require_once($CFG->dirroot.'/course/lib.php');
2888     if (!empty($CFG->enableavailability)) {
2889         require_once($CFG->libdir.'/conditionlib.php');
2890     }
2892     static $cache = array();
2894     if ($course === 'reset') {
2895         $cache = array();
2896         $nothing = null;
2897         return $nothing; // we must return some reference
2898     }
2900     if (empty($userid)) {
2901         $userid = $USER->id;
2902     }
2904     if (array_key_exists($course->id, $cache) and $cache[$course->id]->userid == $userid) {
2905         return $cache[$course->id];
2906     }
2908     if (empty($course->modinfo)) {
2909         // no modinfo yet - load it
2910         rebuild_course_cache($course->id);
2911         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2912     }
2914     $modinfo = new object();
2915     $modinfo->courseid  = $course->id;
2916     $modinfo->userid    = $userid;
2917     $modinfo->sections  = array();
2918     $modinfo->cms       = array();
2919     $modinfo->instances = array();
2920     $modinfo->groups    = null; // loaded only when really needed - the only one db query
2922     $info = unserialize($course->modinfo);
2923     if (!is_array($info)) {
2924         // hmm, something is wrong - lets try to fix it
2925         rebuild_course_cache($course->id);
2926         $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2927         $info = unserialize($course->modinfo);
2928         if (!is_array($info)) {
2929             return $modinfo;
2930         }
2931     }
2933     if ($info) {
2934         // detect if upgrade required
2935         $first = reset($info);
2936         if (!isset($first->id)) {
2937             rebuild_course_cache($course->id);
2938             $course->modinfo = $DB->get_field('course', 'modinfo', array('id'=>$course->id));
2939             $info = unserialize($course->modinfo);
2940             if (!is_array($info)) {
2941                 return $modinfo;
2942             }
2943         }
2944     }
2946     $modlurals = array();
2948     // If we haven't already preloaded contexts for the course, do it now
2949     preload_course_contexts($course->id);
2951     foreach ($info as $mod) {
2952         if (empty($mod->name)) {
2953             // something is wrong here
2954             continue;
2955         }
2956         // reconstruct minimalistic $cm
2957         $cm = new object();
2958         $cm->id               = $mod->cm;
2959         $cm->instance         = $mod->id;
2960         $cm->course           = $course->id;
2961         $cm->modname          = $mod->mod;
2962         $cm->idnumber         = $mod->idnumber;
2963         $cm->name             = $mod->name;
2964         $cm->visible          = $mod->visible;
2965         $cm->sectionnum       = $mod->section;
2966         $cm->groupmode        = $mod->groupmode;
2967         $cm->groupingid       = $mod->groupingid;
2968         $cm->groupmembersonly = $mod->groupmembersonly;
2969         $cm->indent           = $mod->indent;
2970         $cm->completion       = $mod->completion;
2971         $cm->extra            = isset($mod->extra) ? $mod->extra : '';
2972         $cm->icon             = isset($mod->icon) ? $mod->icon : '';
2973         $cm->iconcomponent    = isset($mod->iconcomponent) ? $mod->iconcomponent : '';
2974         $cm->uservisible      = true;
2975         if(!empty($CFG->enableavailability)) {
2976             // We must have completion information from modinfo. If it's not
2977             // there, cache needs rebuilding
2978             if(!isset($mod->availablefrom)) {
2979                 debugging('enableavailability option was changed; rebuilding '.
2980                     'cache for course '.$course->id);
2981                 rebuild_course_cache($course->id,true);
2982                 // Re-enter this routine to do it all properly
2983                 return get_fast_modinfo($course,$userid);
2984             }
2985             $cm->availablefrom    = $mod->availablefrom;
2986             $cm->availableuntil   = $mod->availableuntil;
2987             $cm->showavailability = $mod->showavailability;
2988             $cm->conditionscompletion = $mod->conditionscompletion;
2989             $cm->conditionsgrade  = $mod->conditionsgrade;
2990         }
2992         // preload long names plurals and also check module is installed properly
2993         if (!isset($modlurals[$cm->modname])) {
2994             if (!file_exists("$CFG->dirroot/mod/$cm->modname/lib.php")) {
2995                 continue;
2996             }
2997             $modlurals[$cm->modname] = get_string('modulenameplural', $cm->modname);
2998         }
2999         $cm->modplural = $modlurals[$cm->modname];
3000         $modcontext = get_context_instance(CONTEXT_MODULE,$cm->id);
3002         if(!empty($CFG->enableavailability)) {
3003             // Unfortunately the next call really wants to call
3004             // get_fast_modinfo, but that would be recursive, so we fake up a
3005             // modinfo for it already
3006             if(empty($minimalmodinfo)) {
3007                 $minimalmodinfo=new stdClass();
3008                 $minimalmodinfo->cms=array();
3009                 foreach($info as $mod) {
3010                     if (empty($mod->name)) {
3011                         // something is wrong here
3012                         continue;
3013                     }
3014                     $minimalcm = new stdClass();
3015                     $minimalcm->id = $mod->cm;
3016                     $minimalcm->name = $mod->name;
3017                     $minimalmodinfo->cms[$minimalcm->id]=$minimalcm;
3018                 }
3019             }
3021             // Get availability information
3022             $ci = new condition_info($cm);
3023             $cm->available=$ci->is_available($cm->availableinfo, true, $userid, $minimalmodinfo);
3024         } else {
3025             $cm->available=true;
3026         }
3027         if ((!$cm->visible or !$cm->available) and !has_capability('moodle/course:viewhiddenactivities', $modcontext, $userid)) {
3028             $cm->uservisible = false;
3030         } else if (!empty($CFG->enablegroupmembersonly) and !empty($cm->groupmembersonly)
3031                 and !has_capability('moodle/site:accessallgroups', $modcontext, $userid)) {
3032             if (is_null($modinfo->groups)) {
3033                 $modinfo->groups = groups_get_user_groups($course->id, $userid);
3034             }
3035             if (empty($modinfo->groups[$cm->groupingid])) {
3036                 $cm->uservisible = false;
3037             }
3038         }
3040         if (!isset($modinfo->instances[$cm->modname])) {
3041             $modinfo->instances[$cm->modname] = array();
3042         }
3043         $modinfo->instances[$cm->modname][$cm->instance] =& $cm;
3044         $modinfo->cms[$cm->id] =& $cm;
3046         // reconstruct sections
3047         if (!isset($modinfo->sections[$cm->sectionnum])) {
3048             $modinfo->sections[$cm->sectionnum] = array();
3049         }
3050         $modinfo->sections[$cm->sectionnum][] = $cm->id;
3052         unset($cm);
3053     }
3055     unset($cache[$course->id]); // prevent potential reference problems when switching users
3056     $cache[$course->id] = $modinfo;
3058     // Ensure cache does not use too much RAM
3059     if (count($cache) > MAX_MODINFO_CACHE_SIZE) {
3060         reset($cache);
3061         $key = key($cache);
3062         unset($cache[$key]);
3063     }
3065     return $cache[$course->id];
3068 /**
3069  * Determines if the currently logged in user is in editing mode.
3070  * Note: originally this function had $userid parameter - it was not usable anyway
3071  *
3072  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3073  * @todo Deprecated function remove when ready
3074  *
3075  * @global object
3076  * @uses DEBUG_DEVELOPER
3077  * @return bool
3078  */
3079 function isediting() {
3080     global $PAGE;
3081     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3082     return $PAGE->user_is_editing();
3085 /**
3086  * Determines if the logged in user is currently moving an activity
3087  *
3088  * @global object
3089  * @param int $courseid The id of the course being tested
3090  * @return bool
3091  */
3092 function ismoving($courseid) {
3093     global $USER;
3095     if (!empty($USER->activitycopy)) {
3096         return ($USER->activitycopycourse == $courseid);
3097     }
3098     return false;
3101 /**
3102  * Returns a persons full name
3103  *
3104  * Given an object containing firstname and lastname
3105  * values, this function returns a string with the
3106  * full name of the person.
3107  * The result may depend on system settings
3108  * or language.  'override' will force both names
3109  * to be used even if system settings specify one.
3110  *
3111  * @global object
3112  * @global object
3113  * @param object $user A {@link $USER} object to get full name of
3114  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3115  * @return string
3116  */
3117 function fullname($user, $override=false) {
3118     global $CFG, $SESSION;
3120     if (!isset($user->firstname) and !isset($user->lastname)) {
3121         return '';
3122     }
3124     if (!$override) {
3125         if (!empty($CFG->forcefirstname)) {
3126             $user->firstname = $CFG->forcefirstname;
3127         }
3128         if (!empty($CFG->forcelastname)) {
3129             $user->lastname = $CFG->forcelastname;
3130         }
3131     }
3133     if (!empty($SESSION->fullnamedisplay)) {
3134         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3135     }
3137     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3138         return $user->firstname .' '. $user->lastname;
3140     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3141         return $user->lastname .' '. $user->firstname;
3143     } else if ($CFG->fullnamedisplay == 'firstname') {
3144         if ($override) {
3145             return get_string('fullnamedisplay', '', $user);
3146         } else {
3147             return $user->firstname;
3148         }
3149     }
3151     return get_string('fullnamedisplay', '', $user);
3154 /**
3155  * Returns whether a given authentication plugin exists.
3156  *
3157  * @global object
3158  * @param string $auth Form of authentication to check for. Defaults to the
3159  *        global setting in {@link $CFG}.
3160  * @return boolean Whether the plugin is available.
3161  */
3162 function exists_auth_plugin($auth) {
3163     global $CFG;
3165     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3166         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3167     }
3168     return false;
3171 /**
3172  * Checks if a given plugin is in the list of enabled authentication plugins.
3173  *
3174  * @param string $auth Authentication plugin.
3175  * @return boolean Whether the plugin is enabled.
3176  */
3177 function is_enabled_auth($auth) {
3178     if (empty($auth)) {
3179         return false;
3180     }
3182     $enabled = get_enabled_auth_plugins();
3184     return in_array($auth, $enabled);
3187 /**
3188  * Returns an authentication plugin instance.
3189  *
3190  * @global object
3191  * @param string $auth name of authentication plugin
3192  * @return auth_plugin_base An instance of the required authentication plugin.
3193  */
3194 function get_auth_plugin($auth) {
3195     global $CFG;
3197     // check the plugin exists first
3198     if (! exists_auth_plugin($auth)) {
3199         print_error('authpluginnotfound', 'debug', '', $auth);
3200     }
3202     // return auth plugin instance
3203     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3204     $class = "auth_plugin_$auth";
3205     return new $class;
3208 /**
3209  * Returns array of active auth plugins.
3210  *
3211  * @param bool $fix fix $CFG->auth if needed
3212  * @return array
3213  */
3214 function get_enabled_auth_plugins($fix=false) {
3215     global $CFG;
3217     $default = array('manual', 'nologin');
3219     if (empty($CFG->auth)) {
3220         $auths = array();
3221     } else {
3222         $auths = explode(',', $CFG->auth);
3223     }
3225     if ($fix) {
3226         $auths = array_unique($auths);
3227         foreach($auths as $k=>$authname) {
3228             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3229                 unset($auths[$k]);
3230             }
3231         }
3232         $newconfig = implode(',', $auths);
3233         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3234             set_config('auth', $newconfig);
3235         }
3236     }
3238     return (array_merge($default, $auths));
3241 /**
3242  * Returns true if an internal authentication method is being used.
3243  * if method not specified then, global default is assumed
3244  *
3245  * @param string $auth Form of authentication required
3246  * @return bool
3247  */
3248 function is_internal_auth($auth) {
3249     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3250     return $authplugin->is_internal();
3253 /**
3254  * Returns true if the user is a 'restored' one
3255  *
3256  * Used in the login process to inform the user
3257  * and allow him/her to reset the password
3258  *
3259  * @uses $CFG
3260  * @uses $DB
3261  * @param string $username username to be checked
3262  * @return bool
3263  */
3264 function is_restored_user($username) {
3265     global $CFG, $DB;
3267     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3270 /**
3271  * Returns an array of user fields
3272  *
3273  * @return array User field/column names
3274  */
3275 function get_user_fieldnames() {
3276     global $DB;
3278     $fieldarray = $DB->get_columns('user');
3279     unset($fieldarray['id']);
3280     $fieldarray = array_keys($fieldarray);
3282     return $fieldarray;
3285 /**
3286  * Creates a bare-bones user record
3287  *
3288  * @todo Outline auth types and provide code example
3289  *
3290  * @global object
3291  * @global object
3292  * @param string $username New user's username to add to record
3293  * @param string $password New user's password to add to record
3294  * @param string $auth Form of authentication required
3295  * @return object A {@link $USER} object
3296  */
3297 function create_user_record($username, $password, $auth='manual') {
3298     global $CFG, $DB;
3300     //just in case check text case
3301     $username = trim(moodle_strtolower($username));
3303     $authplugin = get_auth_plugin($auth);
3305     $newuser = new object();
3307     if ($newinfo = $authplugin->get_userinfo($username)) {
3308         $newinfo = truncate_userinfo($newinfo);
3309         foreach ($newinfo as $key => $value){
3310             $newuser->$key = $value;
3311         }
3312     }
3314     if (!empty($newuser->email)) {
3315         if (email_is_not_allowed($newuser->email)) {
3316             unset($newuser->email);
3317         }
3318     }
3320     if (!isset($newuser->city)) {
3321         $newuser->city = '';
3322     }
3324     $newuser->auth = $auth;
3325     $newuser->username = $username;
3327     // fix for MDL-8480
3328     // user CFG lang for user if $newuser->lang is empty
3329     // or $user->lang is not an installed language
3330     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3331         $newuser->lang = $CFG->lang;
3332     }
3333     $newuser->confirmed = 1;
3334     $newuser->lastip = getremoteaddr();
3335     $newuser->timemodified = time();
3336     $newuser->mnethostid = $CFG->mnet_localhost_id;
3338     $DB->insert_record('user', $newuser);
3339     $user = get_complete_user_data('username', $newuser->username);
3340     if(!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3341         set_user_preference('auth_forcepasswordchange', 1, $user->id);
3342     }
3343     update_internal_user_password($user, $password);
3344     return $user;
3347 /**
3348  * Will update a local user record from an external source
3349  *
3350  * @global object
3351  * @param string $username New user's username to add to record
3352  * @param string $authplugin Unused
3353  * @return user A {@link $USER} object
3354  */
3355 function update_user_record($username, $authplugin) {
3356     global $DB;
3358     $username = trim(moodle_strtolower($username)); /// just in case check text case
3360     $oldinfo = $DB->get_record('user', array('username'=>$username), 'username, auth');
3361     $userauth = get_auth_plugin($oldinfo->auth);
3363     if ($newinfo = $userauth->get_userinfo($username)) {
3364         $newinfo = truncate_userinfo($newinfo);
3365         foreach ($newinfo as $key => $value){
3366             if ($key === 'username') {
3367                 // 'username' is not a mapped updateable/lockable field, so skip it.
3368                 continue;
3369             }
3370             $confval = $userauth->config->{'field_updatelocal_' . $key};
3371             $lockval = $userauth->config->{'field_lock_' . $key};
3372             if (empty($confval) || empty($lockval)) {
3373                 continue;
3374             }
3375             if ($confval === 'onlogin') {
3376                 // MDL-4207 Don't overwrite modified user profile values with
3377                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3378                 // of the setting 'unlocked if empty' is to allow the user to fill
3379                 // in a value for the selected field _if LDAP is giving
3380                 // nothing_ for this field. Thus it makes sense to let this value
3381                 // stand in until LDAP is giving a value for this field.
3382                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3383                     $DB->set_field('user', $key, $value, array('username'=>$username));
3384                 }
3385             }
3386         }
3387     }
3389     return get_complete_user_data('username', $username);
3392 /**
3393  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3394  * which may have large fields
3395  *
3396  * @todo Add vartype handling to ensure $info is an array
3397  *
3398  * @param array $info Array of user properties to truncate if needed
3399  * @return array The now truncated information that was passed in
3400  */
3401 function truncate_userinfo($info) {
3402     // define the limits
3403     $limit = array(
3404                     'username'    => 100,
3405                     'idnumber'    => 255,
3406                     'firstname'   => 100,
3407                     'lastname'    => 100,
3408                     'email'       => 100,
3409                     'icq'         =>  15,
3410                     'phone1'      =>  20,
3411                     'phone2'      =>  20,
3412                     'institution' =>  40,
3413                     'department'  =>  30,
3414                     'address'     =>  70,
3415                     'city'        => 120,
3416                     'country'     =>   2,
3417                     'url'         => 255,
3418                     );
3420     // apply where needed
3421     foreach (array_keys($info) as $key) {
3422         if (!empty($limit[$key])) {
3423             $info[$key] = trim(substr($info[$key],0, $limit[$key]));
3424         }
3425     }
3427     return $info;
3430 /**
3431  * Marks user deleted in internal user database and notifies the auth plugin.
3432  * Also unenrols user from all roles and does other cleanup.
3433  *
3434  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3435  *
3436  * @param object $user User object before delete
3437  * @return boolean always true
3438  */
3439 function delete_user($user) {
3440     global $CFG, $DB;
3441     require_once($CFG->libdir.'/grouplib.php');
3442     require_once($CFG->libdir.'/gradelib.php');
3443     require_once($CFG->dirroot.'/message/lib.php');
3445     // delete all grades - backup is kept in grade_grades_history table
3446     grade_user_delete($user->id);
3448     //move unread messages from this user to read
3449     message_move_userfrom_unread2read($user->id);
3451     // remove from all cohorts
3452     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3454     // remove from all groups
3455     $DB->delete_records('groups_members', array('userid'=>$user->id));
3457     // brute force unenrol from all courses
3458     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3460     // purge user preferences
3461     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3463     // purge user extra profile info
3464     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3466     // last course access not necessary either
3467     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3469     // final accesslib cleanup - removes all role assignments in user context and context itself, files, etc.
3470     delete_context(CONTEXT_USER, $user->id);
3472     require_once($CFG->dirroot.'/tag/lib.php');
3473     tag_set('user', $user->id, array());
3475     // workaround for bulk deletes of users with the same email address
3476     $delname = "$user->email.".time();
3477     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3478         $delname++;
3479     }
3481     // mark internal user record as "deleted"
3482     $updateuser = new object();
3483     $updateuser->id           = $user->id;
3484     $updateuser->deleted      = 1;
3485     $updateuser->username     = $delname;            // Remember it just in case
3486     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3487     $updateuser->idnumber     = '';                  // Clear this field to free it up
3488     $updateuser->timemodified = time();
3490     $DB->update_record('user', $updateuser);
3492     // notify auth plugin - do not block the delete even when plugin fails
3493     $authplugin = get_auth_plugin($user->auth);
3494     $authplugin->user_delete($user);
3496     // any plugin that needs to cleanup should register this event
3497     events_trigger('user_deleted', $user);
3499     return true;
3502 /**
3503  * Retrieve the guest user object
3504  *
3505  * @global object
3506  * @global object
3507  * @return user A {@link $USER} object
3508  */
3509 function guest_user() {
3510     global $CFG, $DB;
3512     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
3513         $newuser->confirmed = 1;
3514         $newuser->lang = $CFG->lang;
3515         $newuser->lastip = getremoteaddr();
3516     }
3518     return $newuser;
3521 /**
3522  * Authenticates a user against the chosen authentication mechanism
3523  *
3524  * Given a username and password, this function looks them
3525  * up using the currently selected authentication mechanism,
3526  * and if the authentication is successful, it returns a
3527  * valid $user object from the 'user' table.
3528  *
3529  * Uses auth_ functions from the currently active auth module
3530  *
3531  * After authenticate_user_login() returns success, you will need to
3532  * log that the user has logged in, and call complete_user_login() to set
3533  * the session up.
3534  *
3535  * @global object
3536  * @global object
3537  * @param string $username  User's username
3538  * @param string $password  User's password
3539  * @return user|flase A {@link $USER} object or false if error
3540  */
3541 function authenticate_user_login($username, $password) {
3542     global $CFG, $DB, $OUTPUT;
3544     $authsenabled = get_enabled_auth_plugins();
3546     if ($user = get_complete_user_data('username', $username)) {
3547         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
3548         if (!empty($user->suspended)) {
3549             add_to_log(0, 'login', 'error', 'index.php', $username);
3550             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3551             return false;
3552         }
3553         if ($auth=='nologin' or !is_enabled_auth($auth)) {
3554             add_to_log(0, 'login', 'error', 'index.php', $username);
3555             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3556             return false;
3557         }
3558         $auths = array($auth);
3560     } else {
3561         // check if there's a deleted record (cheaply)
3562         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
3563             error_log('[client '.$_SERVER['REMOTE_ADDR']."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3564             return false;
3565         }
3567         $auths = $authsenabled;
3568         $user = new object();
3569         $user->id = 0;     // User does not exist
3570     }
3572     foreach ($auths as $auth) {
3573         $authplugin = get_auth_plugin($auth);
3575         // on auth fail fall through to the next plugin
3576         if (!$authplugin->user_login($username, $password)) {
3577             continue;
3578         }
3580         // successful authentication
3581         if ($user->id) {                          // User already exists in database
3582             if (empty($user->auth)) {             // For some reason auth isn't set yet
3583                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
3584                 $user->auth = $auth;
3585             }
3586             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
3587                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
3588                 $user->firstaccess = $user->timemodified;
3589             }
3591             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
3593             if (!$authplugin->is_internal()) {            // update user record from external DB
3594                 $user = update_user_record($username, get_auth_plugin($user->auth));
3595             }
3596         } else {
3597             // if user not found, create him
3598             $user = create_user_record($username, $password, $auth);
3599         }
3601         $authplugin->sync_roles($user);
3603         foreach ($authsenabled as $hau) {
3604             $hauth = get_auth_plugin($hau);
3605             $hauth->user_authenticated_hook($user, $username, $password);
3606         }
3608         if (empty($user->id)) {
3609             return false;
3610         }
3612         if (!empty($user->suspended)) {
3613             // just in case some auth plugin suspended account
3614             add_to_log(0, 'login', 'error', 'index.php', $username);
3615             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3616             return false;
3617         }
3619         return $user;
3620     }
3622     // failed if all the plugins have failed
3623     add_to_log(0, 'login', 'error', 'index.php', $username);
3624     if (debugging('', DEBUG_ALL)) {
3625         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
3626     }
3627     return false;
3630 /**
3631  * Call to complete the user login process after authenticate_user_login()
3632  * has succeeded. It will setup the $USER variable and other required bits
3633  * and pieces.
3634  *
3635  * NOTE:
3636  * - It will NOT log anything -- up to the caller to decide what to log.
3637  *
3638  * @global object
3639  * @global object
3640  * @global object
3641  * @param object $user
3642  * @param bool $setcookie
3643  * @return object A {@link $USER} object - BC only, do not use
3644  */
3645 function complete_user_login($user, $setcookie=true) {
3646     global $CFG, $USER, $SESSION;
3648     // regenerate session id and delete old session,
3649     // this helps prevent session fixation attacks from the same domain
3650     session_regenerate_id(true);
3652     // check enrolments, load caps and setup $USER object
3653     session_set_user($user);
3655     update_user_login_times();
3656     set_login_session_preferences();
3658     if (isguestuser()) {
3659         // no need to continue when user is THE guest
3660         return $USER;
3661     }
3663     if ($setcookie) {
3664         if (empty($CFG->nolastloggedin)) {
3665             set_moodle_cookie($USER->username);
3666         } else {
3667             // do not store last logged in user in cookie
3668             // auth plugins can temporarily override this from loginpage_hook()
3669             // do not save $CFG->nolastloggedin in database!
3670             set_moodle_cookie('nobody');
3671         }
3672     }
3674     /// Select password change url
3675     $userauth = get_auth_plugin($USER->auth);
3677     /// check whether the user should be changing password
3678     if (get_user_preferences('auth_forcepasswordchange', false)){
3679         if ($userauth->can_change_password()) {
3680             if ($changeurl = $userauth->change_password_url()) {
3681                 redirect($changeurl);
3682             } else {
3683                 redirect($CFG->httpswwwroot.'/login/change_password.php');
3684             }
3685         } else {
3686             print_error('nopasswordchangeforced', 'auth');
3687         }
3688     }
3689     return $USER;
3692 /**
3693  * Compare password against hash stored in internal user table.
3694  * If necessary it also updates the stored hash to new format.
3695  *
3696  * @global object
3697  * @param object $user
3698  * @param string $password plain text password
3699  * @return bool is password valid?
3700  */
3701 function validate_internal_user_password(&$user, $password) {
3702     global $CFG;
3704     if (!isset($CFG->passwordsaltmain)) {
3705         $CFG->passwordsaltmain = '';
3706     }
3708     $validated = false;
3710     if ($user->password == md5($password.$CFG->passwordsaltmain) or $user->password == md5($password)) {
3711         $validated = true;
3712     } else {
3713         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?