MDL-66147 core: add get_time_interval_string()
[moodle.git] / lib / moodlelib.php
CommitLineData
0d0a8bf6 1<?php
6759ad2f 2// This file is part of Moodle - http://moodle.org/
3//
0d0a8bf6 4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
6759ad2f 13//
0d0a8bf6 14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
65ccdd8c 16
7cf1c7bd 17/**
89dcb99d 18 * moodlelib.php - Moodle main library
7cf1c7bd 19 *
20 * Main library file of miscellaneous general-purpose Moodle functions.
21 * Other main libraries:
8c3dba73 22 * - weblib.php - functions that produce web output
23 * - datalib.php - functions that access the database
0d0a8bf6 24 *
78bfb562
PS
25 * @package core
26 * @subpackage lib
27 * @copyright 1999 onwards Martin Dougiamas http://dougiamas.com
28 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
7cf1c7bd 29 */
e1ecf0a0 30
78bfb562
PS
31defined('MOODLE_INTERNAL') || die();
32
ac7af0da 33// CONSTANTS (Encased in phpdoc proper comments).
f374fb10 34
ac7af0da 35// Date and time constants.
5602f7cf 36/**
37 * Time constant - the number of seconds in a year
38 */
5602f7cf 39define('YEARSECS', 31536000);
40
7a5672c9 41/**
2f87145b 42 * Time constant - the number of seconds in a week
7a5672c9 43 */
361855e6 44define('WEEKSECS', 604800);
2f87145b 45
46/**
47 * Time constant - the number of seconds in a day
48 */
7a5672c9 49define('DAYSECS', 86400);
2f87145b 50
51/**
52 * Time constant - the number of seconds in an hour
53 */
7a5672c9 54define('HOURSECS', 3600);
2f87145b 55
56/**
57 * Time constant - the number of seconds in a minute
58 */
7a5672c9 59define('MINSECS', 60);
2f87145b 60
61/**
62 * Time constant - the number of minutes in a day
63 */
7a5672c9 64define('DAYMINS', 1440);
2f87145b 65
66/**
67 * Time constant - the number of minutes in an hour
68 */
7a5672c9 69define('HOURMINS', 60);
f9903ed0 70
ac7af0da
SH
71// Parameter constants - every call to optional_param(), required_param()
72// or clean_param() should have a specified type of parameter.
03b31ea3 73
e0d346ff 74/**
03b31ea3 75 * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
e0d346ff 76 */
03b31ea3 77define('PARAM_ALPHA', 'alpha');
bbd3f2c4 78
79/**
03b31ea3 80 * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
81 * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
bbd3f2c4 82 */
03b31ea3 83define('PARAM_ALPHAEXT', 'alphaext');
bbd3f2c4 84
85/**
03b31ea3 86 * PARAM_ALPHANUM - expected numbers and letters only.
bbd3f2c4 87 */
03b31ea3 88define('PARAM_ALPHANUM', 'alphanum');
bbd3f2c4 89
90/**
03b31ea3 91 * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
bbd3f2c4 92 */
03b31ea3 93define('PARAM_ALPHANUMEXT', 'alphanumext');
bbd3f2c4 94
9dae915a 95/**
03b31ea3 96 * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
6e73ae10 97 */
03b31ea3 98define('PARAM_AUTH', 'auth');
6e73ae10 99
100/**
03b31ea3 101 * PARAM_BASE64 - Base 64 encoded format
9dae915a 102 */
03b31ea3 103define('PARAM_BASE64', 'base64');
9dae915a 104
bbd3f2c4 105/**
03b31ea3 106 * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
bbd3f2c4 107 */
03b31ea3 108define('PARAM_BOOL', 'bool');
bbd3f2c4 109
110/**
03b31ea3 111 * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
efb8c375 112 * checked against the list of capabilities in the database.
6e73ae10 113 */
03b31ea3 114define('PARAM_CAPABILITY', 'capability');
6e73ae10 115
116/**
2d2018ab 117 * PARAM_CLEANHTML - cleans submitted HTML code. Note that you almost never want
0ef25faa
R
118 * to use this. The normal mode of operation is to use PARAM_RAW when receiving
119 * the input (required/optional_param or formslib) and then sanitise the HTML
2d2018ab
TH
120 * using format_text on output. This is for the rare cases when you want to
121 * sanitise the HTML on input. This cleaning may also fix xhtml strictness.
bbd3f2c4 122 */
03b31ea3 123define('PARAM_CLEANHTML', 'cleanhtml');
bbd3f2c4 124
79f1d953 125/**
126 * PARAM_EMAIL - an email address following the RFC
127 */
128define('PARAM_EMAIL', 'email');
129
bbd3f2c4 130/**
03b31ea3 131 * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
bbd3f2c4 132 */
03b31ea3 133define('PARAM_FILE', 'file');
6e73ae10 134
135/**
03b31ea3 136 * PARAM_FLOAT - a real/floating point number.
7f5f3844
TH
137 *
138 * Note that you should not use PARAM_FLOAT for numbers typed in by the user.
139 * It does not work for languages that use , as a decimal separator.
13230ed7 140 * Use PARAM_LOCALISEDFLOAT instead.
6e73ae10 141 */
03b31ea3 142define('PARAM_FLOAT', 'float');
6e73ae10 143
13230ed7
SR
144/**
145 * PARAM_LOCALISEDFLOAT - a localised real/floating point number.
146 * This is preferred over PARAM_FLOAT for numbers typed in by the user.
147 * Cleans localised numbers to computer readable numbers; false for invalid numbers.
148 */
149define('PARAM_LOCALISEDFLOAT', 'localisedfloat');
150
6e73ae10 151/**
03b31ea3 152 * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
153 */
154define('PARAM_HOST', 'host');
155
156/**
157 * PARAM_INT - integers only, use when expecting only numbers.
6e73ae10 158 */
03b31ea3 159define('PARAM_INT', 'int');
160
161/**
162 * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
163 */
164define('PARAM_LANG', 'lang');
165
166/**
ac7af0da
SH
167 * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the
168 * others! Implies PARAM_URL!)
03b31ea3 169 */
170define('PARAM_LOCALURL', 'localurl');
bbd3f2c4 171
172/**
c59733ef 173 * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
bbd3f2c4 174 */
03b31ea3 175define('PARAM_NOTAGS', 'notags');
bbd3f2c4 176
6e73ae10 177/**
ac7af0da
SH
178 * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory
179 * traversals note: the leading slash is not removed, window drive letter is not allowed
31f26796 180 */
03b31ea3 181define('PARAM_PATH', 'path');
31f26796 182
6e73ae10 183/**
03b31ea3 184 * PARAM_PEM - Privacy Enhanced Mail format
c4ea5e78 185 */
03b31ea3 186define('PARAM_PEM', 'pem');
c4ea5e78 187
bbd3f2c4 188/**
03b31ea3 189 * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
bbd3f2c4 190 */
03b31ea3 191define('PARAM_PERMISSION', 'permission');
bbd3f2c4 192
bed79931 193/**
78fcdb5f 194 * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
bed79931 195 */
03b31ea3 196define('PARAM_RAW', 'raw');
bed79931 197
652599ec
TH
198/**
199 * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
200 */
201define('PARAM_RAW_TRIMMED', 'raw_trimmed');
202
bcef0319 203/**
03b31ea3 204 * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
bcef0319 205 */
03b31ea3 206define('PARAM_SAFEDIR', 'safedir');
bcef0319 207
e032888c 208/**
03b31ea3 209 * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
38fb8190 210 */
03b31ea3 211define('PARAM_SAFEPATH', 'safepath');
e032888c 212
bbd3f2c4 213/**
03b31ea3 214 * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9. Numbers and comma only.
bbd3f2c4 215 */
03b31ea3 216define('PARAM_SEQUENCE', 'sequence');
bbd3f2c4 217
218/**
03b31ea3 219 * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
bbd3f2c4 220 */
03b31ea3 221define('PARAM_TAG', 'tag');
bbd3f2c4 222
223/**
03b31ea3 224 * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
bbd3f2c4 225 */
03b31ea3 226define('PARAM_TAGLIST', 'taglist');
bbd3f2c4 227
228/**
b6059edc 229 * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
bbd3f2c4 230 */
03b31ea3 231define('PARAM_TEXT', 'text');
bbd3f2c4 232
bbd3f2c4 233/**
03b31ea3 234 * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
bbd3f2c4 235 */
03b31ea3 236define('PARAM_THEME', 'theme');
bbd3f2c4 237
238/**
ac7af0da
SH
239 * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but
240 * http://localhost.localdomain/ is ok.
bbd3f2c4 241 */
03b31ea3 242define('PARAM_URL', 'url');
243
07ed083e 244/**
ac7af0da
SH
245 * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user
246 * accounts, do NOT use when syncing with external systems!!
07ed083e
RW
247 */
248define('PARAM_USERNAME', 'username');
bbd3f2c4 249
fe6a248f
DM
250/**
251 * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
252 */
253define('PARAM_STRINGID', 'stringid');
03b31ea3 254
ac7af0da 255// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE.
bbd3f2c4 256/**
03b31ea3 257 * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
258 * It was one of the first types, that is why it is abused so much ;-)
44913c8d 259 * @deprecated since 2.0
bbd3f2c4 260 */
03b31ea3 261define('PARAM_CLEAN', 'clean');
bbd3f2c4 262
263/**
03b31ea3 264 * PARAM_INTEGER - deprecated alias for PARAM_INT
1e12c120 265 * @deprecated since 2.0
bbd3f2c4 266 */
03b31ea3 267define('PARAM_INTEGER', 'int');
bbd3f2c4 268
0e4af166 269/**
03b31ea3 270 * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
61cca0b7 271 * @deprecated since 2.0
0e4af166 272 */
03b31ea3 273define('PARAM_NUMBER', 'float');
0e4af166 274
03d820c7 275/**
efb8c375 276 * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
03b31ea3 277 * NOTE: originally alias for PARAM_APLHA
405aca35 278 * @deprecated since 2.0
03d820c7 279 */
03b31ea3 280define('PARAM_ACTION', 'alphanumext');
03d820c7 281
282/**
03b31ea3 283 * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
284 * NOTE: originally alias for PARAM_APLHA
405aca35 285 * @deprecated since 2.0
03d820c7 286 */
03b31ea3 287define('PARAM_FORMAT', 'alphanumext');
03d820c7 288
ad944e78 289/**
03b31ea3 290 * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
071e68f9 291 * @deprecated since 2.0
ad944e78 292 */
03b31ea3 293define('PARAM_MULTILANG', 'text');
03d820c7 294
ccc77f91
RT
295/**
296 * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
ac7af0da 297 * string separated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
ccc77f91
RT
298 * America/Port-au-Prince)
299 */
300define('PARAM_TIMEZONE', 'timezone');
301
faf75fe7 302/**
03b31ea3 303 * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
faf75fe7 304 */
03b31ea3 305define('PARAM_CLEANFILE', 'file');
306
aff24313
PS
307/**
308 * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
309 * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
310 * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
311 * NOTE: numbers and underscores are strongly discouraged in plugin names!
312 */
313define('PARAM_COMPONENT', 'component');
314
315/**
316 * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
317 * It is usually used together with context id and component.
318 * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
319 */
320define('PARAM_AREA', 'area');
321
322/**
159c2c91 323 * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'paypal', 'completionstatus'.
aff24313
PS
324 * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
325 * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
326 */
327define('PARAM_PLUGIN', 'plugin');
328
329
ac7af0da 330// Web Services.
03b31ea3 331
382b9cea 332/**
333 * VALUE_REQUIRED - if the parameter is not supplied, there is an error
334 */
335define('VALUE_REQUIRED', 1);
336
337/**
338 * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
339 */
340define('VALUE_OPTIONAL', 2);
341
342/**
343 * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
344 */
345define('VALUE_DEFAULT', 0);
03b31ea3 346
5a1861ee 347/**
348 * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
349 */
350define('NULL_NOT_ALLOWED', false);
351
352/**
353 * NULL_ALLOWED - the parameter can be set to null in the database
354 */
355define('NULL_ALLOWED', true);
faf75fe7 356
ac7af0da
SH
357// Page types.
358
bbd3f2c4 359/**
360 * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
8bd3fad3 361 */
362define('PAGE_COURSE_VIEW', 'course-view');
8bd3fad3 363
9bda43e6 364/** Get remote addr constant */
365define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
366/** Get remote addr constant */
367define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
6e73ae10 368
ac7af0da 369// Blog access level constant declaration.
feaf5d06 370define ('BLOG_USER_LEVEL', 1);
371define ('BLOG_GROUP_LEVEL', 2);
372define ('BLOG_COURSE_LEVEL', 3);
373define ('BLOG_SITE_LEVEL', 4);
374define ('BLOG_GLOBAL_LEVEL', 5);
375
6e73ae10 376
ac7af0da 377// Tag constants.
4eb718d8 378/**
a905364a 379 * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
6e73ae10 380 * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
381 * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
0d0a8bf6 382 *
383 * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
4eb718d8 384 */
ae040d4b 385define('TAG_MAX_LENGTH', 50);
4eb718d8 386
ac7af0da 387// Password policy constants.
6499395e 388define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
389define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
390define ('PASSWORD_DIGITS', '0123456789');
391define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
392
ac7af0da 393// Feature constants.
6e73ae10 394// Used for plugin_supports() to report features that are, or are not, supported by a module.
49f6e5f4 395
396/** True if module can provide a grade */
61fceb86 397define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
42f103be 398/** True if module supports outcomes */
399define('FEATURE_GRADE_OUTCOMES', 'outcomes');
b11f9da6
DM
400/** True if module supports advanced grading methods */
401define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
455dc0de
FM
402/** True if module controls the grade visibility over the gradebook */
403define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
50da4ddd
KG
404/** True if module supports plagiarism plugins */
405define('FEATURE_PLAGIARISM', 'plagiarism');
42f103be 406
49f6e5f4 407/** True if module has code to track whether somebody viewed it */
61fceb86 408define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
49f6e5f4 409/** True if module has custom completion rules */
61fceb86 410define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
49f6e5f4 411
0d8b6a69 412/** True if module has no 'view' page (like label) */
413define('FEATURE_NO_VIEW_LINK', 'viewlink');
de158ec5 414/** True (which is default) if the module wants support for setting the ID number for grade calculation purposes. */
42f103be 415define('FEATURE_IDNUMBER', 'idnumber');
416/** True if module supports groups */
417define('FEATURE_GROUPS', 'groups');
418/** True if module supports groupings */
419define('FEATURE_GROUPINGS', 'groupings');
061e6b28 420/**
421 * True if module supports groupmembersonly (which no longer exists)
422 * @deprecated Since Moodle 2.8
423 */
42f103be 424define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
425
aa54ed7b 426/** Type of module */
427define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
42f103be 428/** True if module supports intro editor */
dc5c2bd9 429define('FEATURE_MOD_INTRO', 'mod_intro');
42f103be 430/** True if module has default completion */
431define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
49f6e5f4 432
1bcb7eb5 433define('FEATURE_COMMENT', 'comment');
434
6c5fcef7 435define('FEATURE_RATE', 'rate');
4bfdcfcf
EL
436/** True if module supports backup/restore of moodle2 format */
437define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
a09aeee4 438
8c40662e 439/** True if module can show description on course main page */
440define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
441
b07ef13b
DP
442/** True if module uses the question bank */
443define('FEATURE_USES_QUESTIONS', 'usesquestions');
444
757a889b
MG
445/**
446 * Maximum filename char size
447 */
d609207c 448define('MAX_FILENAME_SIZE', 100);
757a889b 449
aa54ed7b 450/** Unspecified module archetype */
451define('MOD_ARCHETYPE_OTHER', 0);
452/** Resource-like type module */
453define('MOD_ARCHETYPE_RESOURCE', 1);
efb8c375 454/** Assignment module archetype */
aa54ed7b 455define('MOD_ARCHETYPE_ASSIGNMENT', 2);
5813c7f7 456/** System (not user-addable) module archetype */
457define('MOD_ARCHETYPE_SYSTEM', 3);
aa54ed7b 458
eec99048 459/**
460 * Security token used for allowing access
461 * from external application such as web services.
462 * Scripts do not use any session, performance is relatively
463 * low because we need to load access info in each request.
efb8c375 464 * Scripts are executed in parallel.
eec99048 465 */
466define('EXTERNAL_TOKEN_PERMANENT', 0);
467
468/**
469 * Security token used for allowing access
470 * of embedded applications, the code is executed in the
471 * active user session. Token is invalidated after user logs out.
472 * Scripts are executed serially - normal session locking is used.
473 */
474define('EXTERNAL_TOKEN_EMBEDDED', 1);
49f6e5f4 475
4766a50c
SH
476/**
477 * The home page should be the site home
478 */
479define('HOMEPAGE_SITE', 0);
480/**
481 * The home page should be the users my page
482 */
483define('HOMEPAGE_MY', 1);
484/**
485 * The home page can be chosen by the user
486 */
487define('HOMEPAGE_USER', 2);
fcce139a 488
94788de2 489/**
490 * Hub directory url (should be moodle.org)
491 */
7d792aee 492define('HUB_HUBDIRECTORYURL', "https://hubdirectory.moodle.org");
94788de2 493
494
495/**
7d792aee 496 * Moodle.net url (should be moodle.net)
94788de2 497 */
7d792aee
MG
498define('HUB_MOODLEORGHUBURL', "https://moodle.net");
499define('HUB_OLDMOODLEORGHUBURL', "http://hub.moodle.org");
94788de2 500
c1b65883
JM
501/**
502 * Moodle mobile app service name
503 */
504define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
94788de2 505
bc8da017
AD
506/**
507 * Indicates the user has the capabilities required to ignore activity and course file size restrictions
508 */
509define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
510
1f09018a 511/**
ac7af0da
SH
512 * Course display settings: display all sections on one page.
513 */
514define('COURSE_DISPLAY_SINGLEPAGE', 0);
515/**
516 * Course display settings: split pages into a page per section.
1f09018a 517 */
ac7af0da 518define('COURSE_DISPLAY_MULTIPAGE', 1);
1f09018a 519
ec2d8ceb 520/**
ac7af0da 521 * Authentication constant: String used in password field when password is not stored.
ec2d8ceb 522 */
ac7af0da 523define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
ec2d8ceb 524
9715f61a
AG
525/**
526 * Email from header to never include via information.
527 */
528define('EMAIL_VIA_NEVER', 0);
529
530/**
531 * Email from header to always include via information.
532 */
533define('EMAIL_VIA_ALWAYS', 1);
534
535/**
536 * Email from header to only include via information if the address is no-reply.
537 */
538define('EMAIL_VIA_NO_REPLY_ONLY', 2);
539
ac7af0da 540// PARAMETER HANDLING.
6b174680 541
e0d346ff 542/**
361855e6 543 * Returns a particular value for the named variable, taken from
544 * POST or GET. If the parameter doesn't exist then an error is
e0d346ff 545 * thrown because we require this variable.
546 *
361855e6 547 * This function should be used to initialise all required values
548 * in a script that are based on parameters. Usually it will be
e0d346ff 549 * used like this:
622365d2 550 * $id = required_param('id', PARAM_INT);
e0d346ff 551 *
2ca3bffa 552 * Please note the $type parameter is now required and the value can not be array.
44913c8d
PS
553 *
554 * @param string $parname the name of the page parameter we want
555 * @param string $type expected type of parameter
e0d346ff 556 * @return mixed
ac7af0da 557 * @throws coding_exception
e0d346ff 558 */
44913c8d 559function required_param($parname, $type) {
2ca3bffa
PS
560 if (func_num_args() != 2 or empty($parname) or empty($type)) {
561 throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
44913c8d 562 }
ac7af0da
SH
563 // POST has precedence.
564 if (isset($_POST[$parname])) {
a083b93c 565 $param = $_POST[$parname];
566 } else if (isset($_GET[$parname])) {
567 $param = $_GET[$parname];
e0d346ff 568 } else {
2f137aa1 569 print_error('missingparam', '', '', $parname);
e0d346ff 570 }
571
2ca3bffa
PS
572 if (is_array($param)) {
573 debugging('Invalid array parameter detected in required_param(): '.$parname);
ac7af0da 574 // TODO: switch to fatal error in Moodle 2.3.
2ca3bffa
PS
575 return required_param_array($parname, $type);
576 }
577
a083b93c 578 return clean_param($param, $type);
e0d346ff 579}
580
2ca3bffa
PS
581/**
582 * Returns a particular array value for the named variable, taken from
583 * POST or GET. If the parameter doesn't exist then an error is
584 * thrown because we require this variable.
585 *
586 * This function should be used to initialise all required values
587 * in a script that are based on parameters. Usually it will be
588 * used like this:
589 * $ids = required_param_array('ids', PARAM_INT);
590 *
591 * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
592 *
593 * @param string $parname the name of the page parameter we want
594 * @param string $type expected type of parameter
595 * @return array
ac7af0da 596 * @throws coding_exception
2ca3bffa
PS
597 */
598function required_param_array($parname, $type) {
599 if (func_num_args() != 2 or empty($parname) or empty($type)) {
600 throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
601 }
ac7af0da
SH
602 // POST has precedence.
603 if (isset($_POST[$parname])) {
2ca3bffa
PS
604 $param = $_POST[$parname];
605 } else if (isset($_GET[$parname])) {
606 $param = $_GET[$parname];
607 } else {
608 print_error('missingparam', '', '', $parname);
609 }
610 if (!is_array($param)) {
611 print_error('missingparam', '', '', $parname);
612 }
613
614 $result = array();
ac7af0da 615 foreach ($param as $key => $value) {
2ca3bffa
PS
616 if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
617 debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
618 continue;
619 }
ebdeccca 620 $result[$key] = clean_param($value, $type);
2ca3bffa
PS
621 }
622
623 return $result;
e0d346ff 624}
625
626/**
361855e6 627 * Returns a particular value for the named variable, taken from
e0d346ff 628 * POST or GET, otherwise returning a given default.
629 *
361855e6 630 * This function should be used to initialise all optional values
631 * in a script that are based on parameters. Usually it will be
e0d346ff 632 * used like this:
622365d2 633 * $name = optional_param('name', 'Fred', PARAM_TEXT);
e0d346ff 634 *
2ca3bffa 635 * Please note the $type parameter is now required and the value can not be array.
44913c8d 636 *
a083b93c 637 * @param string $parname the name of the page parameter we want
e0d346ff 638 * @param mixed $default the default value to return if nothing is found
44913c8d 639 * @param string $type expected type of parameter
e0d346ff 640 * @return mixed
ac7af0da 641 * @throws coding_exception
e0d346ff 642 */
44913c8d 643function optional_param($parname, $default, $type) {
2ca3bffa 644 if (func_num_args() != 3 or empty($parname) or empty($type)) {
ac7af0da 645 throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
44913c8d 646 }
44913c8d 647
ac7af0da
SH
648 // POST has precedence.
649 if (isset($_POST[$parname])) {
a083b93c 650 $param = $_POST[$parname];
651 } else if (isset($_GET[$parname])) {
652 $param = $_GET[$parname];
e0d346ff 653 } else {
654 return $default;
655 }
c7f4e3e2 656
2ca3bffa
PS
657 if (is_array($param)) {
658 debugging('Invalid array parameter detected in required_param(): '.$parname);
ac7af0da 659 // TODO: switch to $default in Moodle 2.3.
2ca3bffa
PS
660 return optional_param_array($parname, $default, $type);
661 }
662
a083b93c 663 return clean_param($param, $type);
e0d346ff 664}
665
2ca3bffa
PS
666/**
667 * Returns a particular array value for the named variable, taken from
668 * POST or GET, otherwise returning a given default.
669 *
670 * This function should be used to initialise all optional values
671 * in a script that are based on parameters. Usually it will be
672 * used like this:
673 * $ids = optional_param('id', array(), PARAM_INT);
674 *
ac7af0da 675 * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
2ca3bffa
PS
676 *
677 * @param string $parname the name of the page parameter we want
ac7af0da 678 * @param mixed $default the default value to return if nothing is found
2ca3bffa
PS
679 * @param string $type expected type of parameter
680 * @return array
ac7af0da 681 * @throws coding_exception
2ca3bffa
PS
682 */
683function optional_param_array($parname, $default, $type) {
684 if (func_num_args() != 3 or empty($parname) or empty($type)) {
ac7af0da 685 throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
2ca3bffa
PS
686 }
687
ac7af0da
SH
688 // POST has precedence.
689 if (isset($_POST[$parname])) {
2ca3bffa
PS
690 $param = $_POST[$parname];
691 } else if (isset($_GET[$parname])) {
692 $param = $_GET[$parname];
693 } else {
694 return $default;
695 }
696 if (!is_array($param)) {
697 debugging('optional_param_array() expects array parameters only: '.$parname);
698 return $default;
699 }
700
701 $result = array();
ac7af0da 702 foreach ($param as $key => $value) {
2ca3bffa
PS
703 if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
704 debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
705 continue;
706 }
ebdeccca 707 $result[$key] = clean_param($value, $type);
2ca3bffa
PS
708 }
709
710 return $result;
e0d346ff 711}
712
a3f7cbf6 713/**
714 * Strict validation of parameter values, the values are only converted
715 * to requested PHP type. Internally it is using clean_param, the values
716 * before and after cleaning must be equal - otherwise
717 * an invalid_parameter_exception is thrown.
efb8c375 718 * Objects and classes are not accepted.
a3f7cbf6 719 *
720 * @param mixed $param
2ca3bffa 721 * @param string $type PARAM_ constant
a3f7cbf6 722 * @param bool $allownull are nulls valid value?
723 * @param string $debuginfo optional debug information
fea52c11
PS
724 * @return mixed the $param value converted to PHP type
725 * @throws invalid_parameter_exception if $param is not of given type
a3f7cbf6 726 */
5a1861ee 727function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
a3f7cbf6 728 if (is_null($param)) {
5a1861ee 729 if ($allownull == NULL_ALLOWED) {
a3f7cbf6 730 return null;
731 } else {
732 throw new invalid_parameter_exception($debuginfo);
733 }
734 }
735 if (is_array($param) or is_object($param)) {
736 throw new invalid_parameter_exception($debuginfo);
737 }
738
739 $cleaned = clean_param($param, $type);
fea52c11
PS
740
741 if ($type == PARAM_FLOAT) {
742 // Do not detect precision loss here.
743 if (is_float($param) or is_int($param)) {
744 // These always fit.
745 } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
746 throw new invalid_parameter_exception($debuginfo);
747 }
748 } else if ((string)$param !== (string)$cleaned) {
ac7af0da 749 // Conversion to string is usually lossless.
a3f7cbf6 750 throw new invalid_parameter_exception($debuginfo);
751 }
752
753 return $cleaned;
754}
755
2ca3bffa 756/**
ac7af0da
SH
757 * Makes sure array contains only the allowed types, this function does not validate array key names!
758 *
2ca3bffa
PS
759 * <code>
760 * $options = clean_param($options, PARAM_INT);
761 * </code>
762 *
763 * @param array $param the variable array we are cleaning
764 * @param string $type expected format of param after cleaning.
765 * @param bool $recursive clean recursive arrays
766 * @return array
ac7af0da 767 * @throws coding_exception
2ca3bffa
PS
768 */
769function clean_param_array(array $param = null, $type, $recursive = false) {
ac7af0da
SH
770 // Convert null to empty array.
771 $param = (array)$param;
2ca3bffa
PS
772 foreach ($param as $key => $value) {
773 if (is_array($value)) {
774 if ($recursive) {
775 $param[$key] = clean_param_array($value, $type, true);
776 } else {
ac7af0da 777 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
2ca3bffa
PS
778 }
779 } else {
780 $param[$key] = clean_param($value, $type);
781 }
782 }
783 return $param;
784}
785
e0d346ff 786/**
361855e6 787 * Used by {@link optional_param()} and {@link required_param()} to
788 * clean the variables and/or cast to specific types, based on
e0d346ff 789 * an options field.
bbd3f2c4 790 * <code>
791 * $course->format = clean_param($course->format, PARAM_ALPHA);
ac7af0da 792 * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
bbd3f2c4 793 * </code>
e0d346ff 794 *
795 * @param mixed $param the variable we are cleaning
2ca3bffa 796 * @param string $type expected format of param after cleaning.
e0d346ff 797 * @return mixed
ac7af0da 798 * @throws coding_exception
e0d346ff 799 */
a083b93c 800function clean_param($param, $type) {
7744ea12 801 global $CFG;
c7f4e3e2 802
c16c1be7
PS
803 if (is_array($param)) {
804 throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
805 } else if (is_object($param)) {
806 if (method_exists($param, '__toString')) {
807 $param = $param->__toString();
808 } else {
809 throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
810 }
80bfd470 811 }
812
a083b93c 813 switch ($type) {
ac7af0da
SH
814 case PARAM_RAW:
815 // No cleaning at all.
78fcdb5f 816 $param = fix_utf8($param);
96e98ea6 817 return $param;
818
ac7af0da
SH
819 case PARAM_RAW_TRIMMED:
820 // No cleaning, but strip leading and trailing whitespace.
78fcdb5f 821 $param = fix_utf8($param);
652599ec
TH
822 return trim($param);
823
ac7af0da
SH
824 case PARAM_CLEAN:
825 // General HTML cleaning, try to use more specific type if possible this is deprecated!
826 // Please use more specific type instead.
a083b93c 827 if (is_numeric($param)) {
828 return $param;
829 }
78fcdb5f 830 $param = fix_utf8($param);
ac7af0da
SH
831 // Sweep for scripts, etc.
832 return clean_text($param);
3af57507 833
ac7af0da
SH
834 case PARAM_CLEANHTML:
835 // Clean html fragment.
78fcdb5f 836 $param = fix_utf8($param);
ac7af0da
SH
837 // Sweep for scripts, etc.
838 $param = clean_text($param, FORMAT_HTML);
a083b93c 839 return trim($param);
e0d346ff 840
a083b93c 841 case PARAM_INT:
ac7af0da
SH
842 // Convert to integer.
843 return (int)$param;
e0d346ff 844
6e73ae10 845 case PARAM_FLOAT:
ac7af0da
SH
846 // Convert to float.
847 return (float)$param;
9dae915a 848
13230ed7
SR
849 case PARAM_LOCALISEDFLOAT:
850 // Convert to float.
851 return unformat_float($param, true);
852
ac7af0da
SH
853 case PARAM_ALPHA:
854 // Remove everything not `a-z`.
6dbcacee 855 return preg_replace('/[^a-zA-Z]/i', '', $param);
e0d346ff 856
ac7af0da
SH
857 case PARAM_ALPHAEXT:
858 // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
6dbcacee 859 return preg_replace('/[^a-zA-Z_-]/i', '', $param);
6e73ae10 860
ac7af0da
SH
861 case PARAM_ALPHANUM:
862 // Remove everything not `a-zA-Z0-9`.
6dbcacee 863 return preg_replace('/[^A-Za-z0-9]/i', '', $param);
f24148ef 864
ac7af0da
SH
865 case PARAM_ALPHANUMEXT:
866 // Remove everything not `a-zA-Z0-9_-`.
6dbcacee 867 return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
0ed442f8 868
ac7af0da
SH
869 case PARAM_SEQUENCE:
870 // Remove everything not `0-9,`.
6dbcacee 871 return preg_replace('/[^0-9,]/i', '', $param);
0e4af166 872
ac7af0da
SH
873 case PARAM_BOOL:
874 // Convert to 1 or 0.
a083b93c 875 $tempstr = strtolower($param);
6e73ae10 876 if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
a083b93c 877 $param = 1;
6e73ae10 878 } else if ($tempstr === 'off' or $tempstr === 'no' or $tempstr === 'false') {
a083b93c 879 $param = 0;
880 } else {
881 $param = empty($param) ? 0 : 1;
882 }
883 return $param;
f24148ef 884
ac7af0da
SH
885 case PARAM_NOTAGS:
886 // Strip all tags.
78fcdb5f 887 $param = fix_utf8($param);
a083b93c 888 return strip_tags($param);
3af57507 889
ac7af0da
SH
890 case PARAM_TEXT:
891 // Leave only tags needed for multilang.
78fcdb5f 892 $param = fix_utf8($param);
ac7af0da
SH
893 // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
894 // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
b6059edc
PS
895 do {
896 if (strpos($param, '</lang>') !== false) {
ac7af0da 897 // Old and future mutilang syntax.
b6059edc
PS
898 $param = strip_tags($param, '<lang>');
899 if (!preg_match_all('/<.*>/suU', $param, $matches)) {
900 break;
901 }
902 $open = false;
903 foreach ($matches[0] as $match) {
904 if ($match === '</lang>') {
905 if ($open) {
906 $open = false;
907 continue;
908 } else {
909 break 2;
910 }
911 }
912 if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
913 break 2;
914 } else {
915 $open = true;
916 }
917 }
918 if ($open) {
919 break;
920 }
921 return $param;
922
923 } else if (strpos($param, '</span>') !== false) {
ac7af0da 924 // Current problematic multilang syntax.
b6059edc
PS
925 $param = strip_tags($param, '<span>');
926 if (!preg_match_all('/<.*>/suU', $param, $matches)) {
927 break;
928 }
929 $open = false;
930 foreach ($matches[0] as $match) {
931 if ($match === '</span>') {
932 if ($open) {
933 $open = false;
934 continue;
935 } else {
936 break 2;
937 }
938 }
939 if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
940 break 2;
941 } else {
942 $open = true;
943 }
944 }
945 if ($open) {
946 break;
947 }
948 return $param;
949 }
950 } while (false);
ac7af0da 951 // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
b6059edc 952 return strip_tags($param);
31f26796 953
aff24313 954 case PARAM_COMPONENT:
ac7af0da
SH
955 // We do not want any guessing here, either the name is correct or not
956 // please note only normalised component names are accepted.
a41d1ca0 957 if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]+$/', $param)) {
aff24313
PS
958 return '';
959 }
960 if (strpos($param, '__') !== false) {
961 return '';
962 }
963 if (strpos($param, 'mod_') === 0) {
ac7af0da 964 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
aff24313
PS
965 if (substr_count($param, '_') != 1) {
966 return '';
967 }
968 }
969 return $param;
970
971 case PARAM_PLUGIN:
972 case PARAM_AREA:
ac7af0da 973 // We do not want any guessing here, either the name is correct or not.
5f850735 974 if (!is_valid_plugin_name($param)) {
aff24313
PS
975 return '';
976 }
977 return $param;
978
ac7af0da
SH
979 case PARAM_SAFEDIR:
980 // Remove everything not a-zA-Z0-9_- .
6dbcacee 981 return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
95bfd207 982
ac7af0da
SH
983 case PARAM_SAFEPATH:
984 // Remove everything not a-zA-Z0-9/_- .
6759ad2f 985 return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
6e73ae10 986
ac7af0da
SH
987 case PARAM_FILE:
988 // Strip all suspicious characters from filename.
78fcdb5f 989 $param = fix_utf8($param);
14f3ad15 990 $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
caf16a57 991 if ($param === '.' || $param === '..') {
371a2ed0 992 $param = '';
993 }
a083b93c 994 return $param;
995
ac7af0da
SH
996 case PARAM_PATH:
997 // Strip all suspicious characters from file path.
78fcdb5f 998 $param = fix_utf8($param);
a083b93c 999 $param = str_replace('\\', '/', $param);
caf16a57
FM
1000
1001 // Explode the path and clean each element using the PARAM_FILE rules.
1002 $breadcrumb = explode('/', $param);
1003 foreach ($breadcrumb as $key => $crumb) {
1004 if ($crumb === '.' && $key === 0) {
1005 // Special condition to allow for relative current path such as ./currentdirfile.txt.
1006 } else {
1007 $crumb = clean_param($crumb, PARAM_FILE);
1008 }
1009 $breadcrumb[$key] = $crumb;
1010 }
1011 $param = implode('/', $breadcrumb);
1012
1013 // Remove multiple current path (./././) and multiple slashes (///).
6dbcacee 1014 $param = preg_replace('~//+~', '/', $param);
caf16a57
FM
1015 $param = preg_replace('~/(\./)+~', '/', $param);
1016 return $param;
a083b93c 1017
ac7af0da
SH
1018 case PARAM_HOST:
1019 // Allow FQDN or IPv4 dotted quad.
1020 $param = preg_replace('/[^\.\d\w-]/', '', $param );
1021 // Match ipv4 dotted quad.
1022 if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
1023 // Confirm values are ok.
a083b93c 1024 if ( $match[0] > 255
1025 || $match[1] > 255
1026 || $match[3] > 255
1027 || $match[4] > 255 ) {
ac7af0da 1028 // Hmmm, what kind of dotted quad is this?
a083b93c 1029 $param = '';
1030 }
ac7af0da
SH
1031 } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1032 && !preg_match('/^[\.-]/', $param) // No leading dots/hyphens.
1033 && !preg_match('/[\.-]$/', $param) // No trailing dots/hyphens.
a083b93c 1034 ) {
ac7af0da 1035 // All is ok - $param is respected.
a083b93c 1036 } else {
ac7af0da 1037 // All is not ok...
a083b93c 1038 $param='';
1039 }
1040 return $param;
7744ea12 1041
e5ece45e
RK
1042 case PARAM_URL:
1043 // Allow safe urls.
78fcdb5f 1044 $param = fix_utf8($param);
a083b93c 1045 include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
e5ece45e 1046 if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E-u-P-a?I?p?f?q?r?')) {
ac7af0da 1047 // All is ok, param is respected.
d2a9f7cc 1048 } else {
ac7af0da
SH
1049 // Not really ok.
1050 $param ='';
a083b93c 1051 }
1052 return $param;
1053
ac7af0da
SH
1054 case PARAM_LOCALURL:
1055 // Allow http absolute, root relative and relative URLs within wwwroot.
93684765 1056 $param = clean_param($param, PARAM_URL);
a083b93c 1057 if (!empty($param)) {
d031c2dc 1058
5c1f41f0
PS
1059 if ($param === $CFG->wwwroot) {
1060 // Exact match;
5c1f41f0 1061 } else if (preg_match(':^/:', $param)) {
ac7af0da 1062 // Root-relative, ok!
5c1f41f0 1063 } else if (preg_match('/^' . preg_quote($CFG->wwwroot . '/', '/') . '/i', $param)) {
ac7af0da 1064 // Absolute, and matches our wwwroot.
7744ea12 1065 } else {
ac7af0da 1066 // Relative - let's make sure there are no tricks.
4bea5e85 1067 if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
ac7af0da 1068 // Looks ok.
a083b93c 1069 } else {
1070 $param = '';
1071 }
d2a9f7cc 1072 }
7744ea12 1073 }
a083b93c 1074 return $param;
bcef0319 1075
03d820c7 1076 case PARAM_PEM:
1077 $param = trim($param);
ac7af0da
SH
1078 // PEM formatted strings may contain letters/numbers and the symbols:
1079 // forward slash: /
1080 // plus sign: +
1081 // equal sign: =
1082 // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
03d820c7 1083 if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1084 list($wholething, $body) = $matches;
1085 unset($wholething, $matches);
1086 $b64 = clean_param($body, PARAM_BASE64);
1087 if (!empty($b64)) {
1088 return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1089 } else {
1090 return '';
1091 }
1092 }
1093 return '';
bcef0319 1094
03d820c7 1095 case PARAM_BASE64:
1096 if (!empty($param)) {
1097 // PEM formatted strings may contain letters/numbers and the symbols
ac7af0da
SH
1098 // forward slash: /
1099 // plus sign: +
1100 // equal sign: =.
03d820c7 1101 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1102 return '';
1103 }
1104 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
ac7af0da
SH
1105 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1106 // than (or equal to) 64 characters long.
03d820c7 1107 for ($i=0, $j=count($lines); $i < $j; $i++) {
1108 if ($i + 1 == $j) {
1109 if (64 < strlen($lines[$i])) {
1110 return '';
1111 }
1112 continue;
1113 }
7744ea12 1114
03d820c7 1115 if (64 != strlen($lines[$i])) {
1116 return '';
1117 }
1118 }
ac7af0da 1119 return implode("\n", $lines);
03d820c7 1120 } else {
1121 return '';
1122 }
bcef0319 1123
1124 case PARAM_TAG:
78fcdb5f 1125 $param = fix_utf8($param);
34b93e39
PS
1126 // Please note it is not safe to use the tag name directly anywhere,
1127 // it must be processed with s(), urlencode() before embedding anywhere.
ac7af0da 1128 // Remove some nasties.
6b24e35e 1129 $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
ac7af0da 1130 // Convert many whitespace chars into one.
e737c2ff 1131 $param = preg_replace('/\s+/u', ' ', $param);
2f1e464a 1132 $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
c93c6b3b 1133 return $param;
bcef0319 1134
ae040d4b 1135 case PARAM_TAGLIST:
78fcdb5f 1136 $param = fix_utf8($param);
ae040d4b 1137 $tags = explode(',', $param);
1138 $result = array();
1139 foreach ($tags as $tag) {
1140 $res = clean_param($tag, PARAM_TAG);
6e73ae10 1141 if ($res !== '') {
ae040d4b 1142 $result[] = $res;
1143 }
1144 }
1145 if ($result) {
1146 return implode(',', $result);
1147 } else {
1148 return '';
0d626493 1149 }
1150
ad944e78 1151 case PARAM_CAPABILITY:
4f0c2d00 1152 if (get_capability_info($param)) {
ad944e78 1153 return $param;
1154 } else {
1155 return '';
1156 }
1157
faf75fe7 1158 case PARAM_PERMISSION:
1159 $param = (int)$param;
1160 if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1161 return $param;
1162 } else {
1163 return CAP_INHERIT;
1164 }
1165
03b31ea3 1166 case PARAM_AUTH:
aff24313
PS
1167 $param = clean_param($param, PARAM_PLUGIN);
1168 if (empty($param)) {
1169 return '';
1170 } else if (exists_auth_plugin($param)) {
03b31ea3 1171 return $param;
1172 } else {
1173 return '';
1174 }
1175
1176 case PARAM_LANG:
1177 $param = clean_param($param, PARAM_SAFEDIR);
ef686eb5 1178 if (get_string_manager()->translation_exists($param)) {
03b31ea3 1179 return $param;
1180 } else {
ac7af0da
SH
1181 // Specified language is not installed or param malformed.
1182 return '';
03b31ea3 1183 }
1184
1185 case PARAM_THEME:
aff24313
PS
1186 $param = clean_param($param, PARAM_PLUGIN);
1187 if (empty($param)) {
1188 return '';
1189 } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
73e504bc
PS
1190 return $param;
1191 } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
03b31ea3 1192 return $param;
1193 } else {
ac7af0da
SH
1194 // Specified theme is not installed.
1195 return '';
03b31ea3 1196 }
1197
07ed083e 1198 case PARAM_USERNAME:
78fcdb5f 1199 $param = fix_utf8($param);
77218e4a 1200 $param = trim($param);
ac7af0da 1201 // Convert uppercase to lowercase MDL-16919.
2f1e464a 1202 $param = core_text::strtolower($param);
34d2b19a 1203 if (empty($CFG->extendedusernamechars)) {
77218e4a 1204 $param = str_replace(" " , "", $param);
ac7af0da 1205 // Regular expression, eliminate all chars EXCEPT:
07ed083e
RW
1206 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1207 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
4f0c2d00 1208 }
07ed083e
RW
1209 return $param;
1210
79f1d953 1211 case PARAM_EMAIL:
78fcdb5f 1212 $param = fix_utf8($param);
79f1d953 1213 if (validate_email($param)) {
1214 return $param;
1215 } else {
1216 return '';
1217 }
1218
fe6a248f
DM
1219 case PARAM_STRINGID:
1220 if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1221 return $param;
1222 } else {
1223 return '';
1224 }
1225
ac7af0da
SH
1226 case PARAM_TIMEZONE:
1227 // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
78fcdb5f 1228 $param = fix_utf8($param);
8158ce79 1229 $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
ccc77f91
RT
1230 if (preg_match($timezonepattern, $param)) {
1231 return $param;
1232 } else {
1233 return '';
1234 }
1235
ac7af0da
SH
1236 default:
1237 // Doh! throw error, switched parameters in optional_param or another serious problem.
03b31ea3 1238 print_error("unknownparamtype", '', '', $type);
2ae28153 1239 }
e0d346ff 1240}
1241
8a40bc36
FM
1242/**
1243 * Whether the PARAM_* type is compatible in RTL.
1244 *
1245 * Being compatible with RTL means that the data they contain can flow
1246 * from right-to-left or left-to-right without compromising the user experience.
1247 *
1248 * Take URLs for example, they are not RTL compatible as they should always
1249 * flow from the left to the right. This also applies to numbers, email addresses,
1250 * configuration snippets, base64 strings, etc...
1251 *
1252 * This function tries to best guess which parameters can contain localised strings.
1253 *
1254 * @param string $paramtype Constant PARAM_*.
1255 * @return bool
1256 */
1257function is_rtl_compatible($paramtype) {
1258 return $paramtype == PARAM_TEXT || $paramtype == PARAM_NOTAGS;
1259}
1260
78fcdb5f
PS
1261/**
1262 * Makes sure the data is using valid utf8, invalid characters are discarded.
1263 *
1264 * Note: this function is not intended for full objects with methods and private properties.
1265 *
1266 * @param mixed $value
1267 * @return mixed with proper utf-8 encoding
1268 */
1269function fix_utf8($value) {
1270 if (is_null($value) or $value === '') {
1271 return $value;
1272
1273 } else if (is_string($value)) {
1274 if ((string)(int)$value === $value) {
ac7af0da 1275 // Shortcut.
78fcdb5f
PS
1276 return $value;
1277 }
bff1d60c
PS
1278 // No null bytes expected in our data, so let's remove it.
1279 $value = str_replace("\0", '', $value);
0aff15c2 1280
0aff15c2
PS
1281 // Note: this duplicates min_fix_utf8() intentionally.
1282 static $buggyiconv = null;
1283 if ($buggyiconv === null) {
dd47f210 1284 $buggyiconv = (!function_exists('iconv') or @iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
0aff15c2
PS
1285 }
1286
1287 if ($buggyiconv) {
1288 if (function_exists('mb_convert_encoding')) {
1289 $subst = mb_substitute_character();
1290 mb_substitute_character('');
1291 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1292 mb_substitute_character($subst);
1293
1294 } else {
1295 // Warn admins on admin/index.php page.
1296 $result = $value;
1297 }
1298
1299 } else {
dd47f210 1300 $result = @iconv('UTF-8', 'UTF-8//IGNORE', $value);
51b7297b 1301 }
0aff15c2 1302
51b7297b 1303 return $result;
78fcdb5f
PS
1304
1305 } else if (is_array($value)) {
ac7af0da 1306 foreach ($value as $k => $v) {
78fcdb5f
PS
1307 $value[$k] = fix_utf8($v);
1308 }
1309 return $value;
1310
1311 } else if (is_object($value)) {
ac7af0da
SH
1312 // Do not modify original.
1313 $value = clone($value);
1314 foreach ($value as $k => $v) {
78fcdb5f
PS
1315 $value->$k = fix_utf8($v);
1316 }
1317 return $value;
1318
1319 } else {
ac7af0da 1320 // This is some other type, no utf-8 here.
78fcdb5f
PS
1321 return $value;
1322 }
1323}
1324
6e73ae10 1325/**
1326 * Return true if given value is integer or string with integer value
0d0a8bf6 1327 *
1328 * @param mixed $value String or Int
1329 * @return bool true if number, false if not
6e73ae10 1330 */
1331function is_number($value) {
1332 if (is_int($value)) {
1333 return true;
1334 } else if (is_string($value)) {
1335 return ((string)(int)$value) === $value;
1336 } else {
1337 return false;
1338 }
1339}
7a530277 1340
aa282b10 1341/**
ac7af0da
SH
1342 * Returns host part from url.
1343 *
aa282b10 1344 * @param string $url full url
1345 * @return string host, null if not found
1346 */
1347function get_host_from_url($url) {
1348 preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1349 if ($matches) {
1350 return $matches[1];
1351 }
1352 return null;
1353}
1354
94a6d656 1355/**
0d0a8bf6 1356 * Tests whether anything was returned by text editor
1357 *
94a6d656 1358 * This function is useful for testing whether something you got back from
1359 * the HTML editor actually contains anything. Sometimes the HTML editor
1360 * appear to be empty, but actually you get back a <br> tag or something.
1361 *
1362 * @param string $string a string containing HTML.
1363 * @return boolean does the string contain any actual content - that is text,
efb8c375 1364 * images, objects, etc.
94a6d656 1365 */
1366function html_is_blank($string) {
1367 return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1368}
1369
7cf1c7bd 1370/**
1371 * Set a key in global configuration
1372 *
89dcb99d 1373 * Set a key/value pair in both this session's {@link $CFG} global variable
7cf1c7bd 1374 * and in the 'config' database table for future sessions.
e1ecf0a0 1375 *
1376 * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1377 * In that case it doesn't affect $CFG.
7cf1c7bd 1378 *
6fd511eb 1379 * A NULL value will delete the entry.
1380 *
08b51dd0
JO
1381 * NOTE: this function is called from lib/db/upgrade.php
1382 *
7cf1c7bd 1383 * @param string $name the key to set
9cdb766d 1384 * @param string $value the value to set (without magic quotes)
ac7af0da 1385 * @param string $plugin (optional) the plugin scope, default null
5e2f308b 1386 * @return bool true or exception
7cf1c7bd 1387 */
ac7af0da 1388function set_config($name, $value, $plugin=null) {
ae040d4b 1389 global $CFG, $DB;
42282810 1390
a4080313 1391 if (empty($plugin)) {
220a90c5 1392 if (!array_key_exists($name, $CFG->config_php_settings)) {
ac7af0da 1393 // So it's defined for this invocation at least.
220a90c5 1394 if (is_null($value)) {
1395 unset($CFG->$name);
1396 } else {
ac7af0da
SH
1397 // Settings from db are always strings.
1398 $CFG->$name = (string)$value;
220a90c5 1399 }
1400 }
e1ecf0a0 1401
ac7af0da 1402 if ($DB->get_field('config', 'name', array('name' => $name))) {
5e2f308b 1403 if ($value === null) {
ac7af0da 1404 $DB->delete_records('config', array('name' => $name));
6fd511eb 1405 } else {
ac7af0da 1406 $DB->set_field('config', 'value', $value, array('name' => $name));
6fd511eb 1407 }
a4080313 1408 } else {
5e2f308b 1409 if ($value !== null) {
365a5941 1410 $config = new stdClass();
5e2f308b 1411 $config->name = $name;
1412 $config->value = $value;
1413 $DB->insert_record('config', $config, false);
6fd511eb 1414 }
a4080313 1415 }
e0d9b7c0
SH
1416 if ($name === 'siteidentifier') {
1417 cache_helper::update_site_identifier($value);
1418 }
007bfe8b 1419 cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
ac7af0da
SH
1420 } else {
1421 // Plugin scope.
1422 if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
6fd511eb 1423 if ($value===null) {
ac7af0da 1424 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
6fd511eb 1425 } else {
ac7af0da 1426 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
6fd511eb 1427 }
a4080313 1428 } else {
5e2f308b 1429 if ($value !== null) {
365a5941 1430 $config = new stdClass();
5e2f308b 1431 $config->plugin = $plugin;
1432 $config->name = $name;
1433 $config->value = $value;
1434 $DB->insert_record('config_plugins', $config, false);
6fd511eb 1435 }
a4080313 1436 }
007bfe8b 1437 cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
a4080313 1438 }
5e2f308b 1439
1440 return true;
a4080313 1441}
1442
1443/**
e1ecf0a0 1444 * Get configuration values from the global config table
a4080313 1445 * or the config_plugins table.
1446 *
13daf6a2 1447 * If called with one parameter, it will load all the config
12bb0c3e 1448 * variables for one plugin, and return them as an object.
13daf6a2 1449 *
12bb0c3e
PS
1450 * If called with 2 parameters it will return a string single
1451 * value or false if the value is not found.
9220fba5 1452 *
08b51dd0
JO
1453 * NOTE: this function is called from lib/db/upgrade.php
1454 *
ac7af0da 1455 * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
e0d9b7c0 1456 * that we need only fetch it once per request.
12bb0c3e 1457 * @param string $plugin full component name
ac7af0da 1458 * @param string $name default null
07ab0c80 1459 * @return mixed hash-like object or single value, return false no config found
ac7af0da 1460 * @throws dml_exception
a4080313 1461 */
ac7af0da 1462function get_config($plugin, $name = null) {
ae040d4b 1463 global $CFG, $DB;
dfc9ba9b 1464
e0d9b7c0
SH
1465 static $siteidentifier = null;
1466
007bfe8b
SH
1467 if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1468 $forced =& $CFG->config_php_settings;
1469 $iscore = true;
1470 $plugin = 'core';
1471 } else {
1472 if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1473 $forced =& $CFG->forced_plugin_settings[$plugin];
1474 } else {
1475 $forced = array();
1476 }
1477 $iscore = false;
12bb0c3e
PS
1478 }
1479
e0d9b7c0
SH
1480 if ($siteidentifier === null) {
1481 try {
1482 // This may fail during installation.
1483 // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1484 // install the database.
1485 $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1486 } catch (dml_exception $ex) {
e0d9b7c0
SH
1487 // Set siteidentifier to false. We don't want to trip this continually.
1488 $siteidentifier = false;
1489 throw $ex;
1490 }
1491 }
1492
1493 if (!empty($name)) {
1494 if (array_key_exists($name, $forced)) {
1495 return (string)$forced[$name];
1496 } else if ($name === 'siteidentifier' && $plugin == 'core') {
1497 return $siteidentifier;
1498 }
007bfe8b
SH
1499 }
1500
1501 $cache = cache::make('core', 'config');
1502 $result = $cache->get($plugin);
d0749719 1503 if ($result === false) {
ac7af0da 1504 // The user is after a recordset.
007bfe8b 1505 if (!$iscore) {
ac7af0da 1506 $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
a4080313 1507 } else {
ac7af0da 1508 // This part is not really used any more, but anyway...
007bfe8b 1509 $result = $DB->get_records_menu('config', array(), '', 'name,value');;
a4080313 1510 }
007bfe8b 1511 $cache->set($plugin, $result);
a4080313 1512 }
1513
007bfe8b
SH
1514 if (!empty($name)) {
1515 if (array_key_exists($name, $result)) {
1516 return $result[$name];
bfb82da3 1517 }
007bfe8b
SH
1518 return false;
1519 }
e1ecf0a0 1520
e0d9b7c0
SH
1521 if ($plugin === 'core') {
1522 $result['siteidentifier'] = $siteidentifier;
1523 }
1524
007bfe8b
SH
1525 foreach ($forced as $key => $value) {
1526 if (is_null($value) or is_array($value) or is_object($value)) {
ac7af0da 1527 // We do not want any extra mess here, just real settings that could be saved in db.
007bfe8b
SH
1528 unset($result[$key]);
1529 } else {
ac7af0da 1530 // Convert to string as if it went through the DB.
007bfe8b 1531 $result[$key] = (string)$value;
12bb0c3e 1532 }
39917a09 1533 }
007bfe8b
SH
1534
1535 return (object)$result;
39917a09 1536}
1537
b0270f84 1538/**
ac7af0da 1539 * Removes a key from global configuration.
b0270f84 1540 *
08b51dd0
JO
1541 * NOTE: this function is called from lib/db/upgrade.php
1542 *
b0270f84 1543 * @param string $name the key to set
1544 * @param string $plugin (optional) the plugin scope
4b600aa0 1545 * @return boolean whether the operation succeeded.
b0270f84 1546 */
ac7af0da 1547function unset_config($name, $plugin=null) {
ae040d4b 1548 global $CFG, $DB;
b0270f84 1549
b0270f84 1550 if (empty($plugin)) {
4b600aa0 1551 unset($CFG->$name);
ac7af0da 1552 $DB->delete_records('config', array('name' => $name));
007bfe8b 1553 cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
5e623a33 1554 } else {
ac7af0da 1555 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
007bfe8b 1556 cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
b0270f84 1557 }
013376de 1558
1559 return true;
b0270f84 1560}
1561
4b600aa0 1562/**
1563 * Remove all the config variables for a given plugin.
ac7af0da 1564 *
c2ca2d8e 1565 * NOTE: this function is called from lib/db/upgrade.php
4b600aa0 1566 *
1567 * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1568 * @return boolean whether the operation succeeded.
1569 */
1570function unset_all_config_for_plugin($plugin) {
1571 global $DB;
ac7af0da 1572 // Delete from the obvious config_plugins first.
013376de 1573 $DB->delete_records('config_plugins', array('plugin' => $plugin));
ac7af0da 1574 // Next delete any suspect settings from config.
a4193166
PS
1575 $like = $DB->sql_like('name', '?', true, true, false, '|');
1576 $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1577 $DB->delete_records_select('config', $like, $params);
007bfe8b
SH
1578 // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1579 cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1580
013376de 1581 return true;
4b600aa0 1582}
1583
4413941f 1584/**
efb8c375 1585 * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
adf176d7
PS
1586 *
1587 * All users are verified if they still have the necessary capability.
1588 *
b3d960e6 1589 * @param string $value the value of the config setting.
4413941f 1590 * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
ac7af0da 1591 * @param bool $includeadmins include administrators.
4413941f 1592 * @return array of user objects.
1593 */
adf176d7 1594function get_users_from_config($value, $capability, $includeadmins = true) {
adf176d7
PS
1595 if (empty($value) or $value === '$@NONE@$') {
1596 return array();
4413941f 1597 }
adf176d7 1598
ac7af0da 1599 // We have to make sure that users still have the necessary capability,
adf176d7 1600 // it should be faster to fetch them all first and then test if they are present
ac7af0da 1601 // instead of validating them one-by-one.
b0c6dc1c 1602 $users = get_users_by_capability(context_system::instance(), $capability);
adf176d7
PS
1603 if ($includeadmins) {
1604 $admins = get_admins();
1605 foreach ($admins as $admin) {
1606 $users[$admin->id] = $admin;
1607 }
1608 }
1609
1610 if ($value === '$@ALL@$') {
1611 return $users;
1612 }
1613
ac7af0da 1614 $result = array(); // Result in correct order.
adf176d7
PS
1615 $allowed = explode(',', $value);
1616 foreach ($allowed as $uid) {
1617 if (isset($users[$uid])) {
1618 $user = $users[$uid];
1619 $result[$user->id] = $user;
1620 }
1621 }
1622
1623 return $result;
4413941f 1624}
1625
f87eab7e
PS
1626
1627/**
ac7af0da 1628 * Invalidates browser caches and cached data in temp.
52642d0d 1629 *
f87eab7e
PS
1630 * @return void
1631 */
1632function purge_all_caches() {
e3389c83
MJ
1633 purge_caches();
1634}
f87eab7e 1635
e3389c83
MJ
1636/**
1637 * Selectively invalidate different types of cache.
1638 *
1639 * Purges the cache areas specified. By default, this will purge all caches but can selectively purge specific
1640 * areas alone or in combination.
1641 *
1642 * @param bool[] $options Specific parts of the cache to purge. Valid options are:
1643 * 'muc' Purge MUC caches?
1644 * 'theme' Purge theme cache?
1645 * 'lang' Purge language string cache?
1646 * 'js' Purge javascript cache?
1647 * 'filter' Purge text filter cache?
1648 * 'other' Purge all other caches?
1649 */
1650function purge_caches($options = []) {
1651 $defaults = array_fill_keys(['muc', 'theme', 'lang', 'js', 'filter', 'other'], false);
1652 if (empty(array_filter($options))) {
1653 $options = array_fill_keys(array_keys($defaults), true); // Set all options to true.
1654 } else {
1655 $options = array_merge($defaults, array_intersect_key($options, $defaults)); // Override defaults with specified options.
1656 }
1657 if ($options['muc']) {
1658 cache_helper::purge_all();
1659 }
1660 if ($options['theme']) {
1661 theme_reset_all_caches();
1662 }
1663 if ($options['lang']) {
1664 get_string_manager()->reset_caches();
1665 }
1666 if ($options['js']) {
1667 js_reset_all_caches();
1668 }
1669 if ($options['filter']) {
1670 reset_text_filters_cache();
1671 }
1672 if ($options['other']) {
1673 purge_other_caches();
1674 }
1675}
1676
1677/**
1678 * Purge all non-MUC caches not otherwise purged in purge_caches.
1679 *
1680 * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1681 * {@link phpunit_util::reset_dataroot()}
1682 */
1683function purge_other_caches() {
1684 global $DB, $CFG;
2f1e464a 1685 core_text::reset_caches();
e87214bd
PS
1686 if (class_exists('core_plugin_manager')) {
1687 core_plugin_manager::reset_caches();
bde002b8 1688 }
f87eab7e 1689
299cfee5
MG
1690 // Bump up cacherev field for all courses.
1691 try {
1692 increment_revision_number('course', 'cacherev', '');
1693 } catch (moodle_exception $e) {
1694 // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1695 }
1696
d79d5ac2 1697 $DB->reset_caches();
d6a1f63b 1698
ac7af0da 1699 // Purge all other caches: rss, simplepie, etc.
54ced30d 1700 clearstatcache();
365bec4c 1701 remove_dir($CFG->cachedir.'', true);
f87eab7e 1702
ac7af0da 1703 // Make sure cache dir is writable, throws exception if not.
5a87c912 1704 make_cache_directory('');
f87eab7e 1705
85b38061
PS
1706 // This is the only place where we purge local caches, we are only adding files there.
1707 // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1708 remove_dir($CFG->localcachedir, true);
1709 set_config('localcachedirpurged', time());
1710 make_localcache_directory('', true);
309ae892 1711 \core\task\manager::clear_static_caches();
f87eab7e
PS
1712}
1713
bafd7e78 1714/**
1715 * Get volatile flags
1716 *
1717 * @param string $type
ac7af0da
SH
1718 * @param int $changedsince default null
1719 * @return array records array
bafd7e78 1720 */
ac7af0da 1721function get_cache_flags($type, $changedsince = null) {
ae040d4b 1722 global $DB;
bafd7e78 1723
ac7af0da 1724 $params = array('type' => $type, 'expiry' => time());
ae040d4b 1725 $sqlwhere = "flagtype = :type AND expiry >= :expiry";
ac7af0da 1726 if ($changedsince !== null) {
ae040d4b 1727 $params['changedsince'] = $changedsince;
1728 $sqlwhere .= " AND timemodified > :changedsince";
bafd7e78 1729 }
1730 $cf = array();
ae040d4b 1731 if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
bafd7e78 1732 foreach ($flags as $flag) {
1733 $cf[$flag->name] = $flag->value;
1734 }
1735 }
1736 return $cf;
1737}
1738
a489cf72 1739/**
1740 * Get volatile flags
1741 *
1742 * @param string $type
1743 * @param string $name
ac7af0da
SH
1744 * @param int $changedsince default null
1745 * @return string|false The cache flag value or false
a489cf72 1746 */
ac7af0da 1747function get_cache_flag($type, $name, $changedsince=null) {
ae040d4b 1748 global $DB;
a489cf72 1749
ac7af0da 1750 $params = array('type' => $type, 'name' => $name, 'expiry' => time());
a489cf72 1751
ae040d4b 1752 $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
ac7af0da 1753 if ($changedsince !== null) {
ae040d4b 1754 $params['changedsince'] = $changedsince;
1755 $sqlwhere .= " AND timemodified > :changedsince";
a489cf72 1756 }
ae040d4b 1757
1758 return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
a489cf72 1759}
bafd7e78 1760
1761/**
1762 * Set a volatile flag
1763 *
1764 * @param string $type the "type" namespace for the key
1765 * @param string $name the key to set
ac7af0da 1766 * @param string $value the value to set (without magic quotes) - null will remove the flag
bafd7e78 1767 * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
0d0a8bf6 1768 * @return bool Always returns true
bafd7e78 1769 */
ac7af0da 1770function set_cache_flag($type, $name, $value, $expiry = null) {
ae040d4b 1771 global $DB;
bafd7e78 1772
1773 $timemodified = time();
ac7af0da 1774 if ($expiry === null || $expiry < $timemodified) {
bafd7e78 1775 $expiry = $timemodified + 24 * 60 * 60;
1776 } else {
1777 $expiry = (int)$expiry;
1778 }
1779
ac7af0da
SH
1780 if ($value === null) {
1781 unset_cache_flag($type, $name);
013376de 1782 return true;
bafd7e78 1783 }
1784
ac7af0da
SH
1785 if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1786 // This is a potential problem in DEBUG_DEVELOPER.
128f0984 1787 if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
ac7af0da 1788 return true; // No need to update.
128f0984 1789 }
ae040d4b 1790 $f->value = $value;
bafd7e78 1791 $f->expiry = $expiry;
1792 $f->timemodified = $timemodified;
013376de 1793 $DB->update_record('cache_flags', $f);
bafd7e78 1794 } else {
365a5941 1795 $f = new stdClass();
bafd7e78 1796 $f->flagtype = $type;
1797 $f->name = $name;
ae040d4b 1798 $f->value = $value;
bafd7e78 1799 $f->expiry = $expiry;
1800 $f->timemodified = $timemodified;
013376de 1801 $DB->insert_record('cache_flags', $f);
bafd7e78 1802 }
013376de 1803 return true;
bafd7e78 1804}
1805
1806/**
1807 * Removes a single volatile flag
1808 *
1809 * @param string $type the "type" namespace for the key
1810 * @param string $name the key to set
bafd7e78 1811 * @return bool
1812 */
1813function unset_cache_flag($type, $name) {
ae040d4b 1814 global $DB;
ac7af0da 1815 $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
013376de 1816 return true;
bafd7e78 1817}
1818
1819/**
1820 * Garbage-collect volatile flags
1821 *
0d0a8bf6 1822 * @return bool Always returns true
bafd7e78 1823 */
1824function gc_cache_flags() {
ae040d4b 1825 global $DB;
013376de 1826 $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1827 return true;
bafd7e78 1828}
a4080313 1829
ac7af0da 1830// USER PREFERENCE API.
2660377f 1831
7cf1c7bd 1832/**
39461de3
PS
1833 * Refresh user preference cache. This is used most often for $USER
1834 * object that is stored in session, but it also helps with performance in cron script.
0d0a8bf6 1835 *
39461de3
PS
1836 * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1837 *
4d6b40a0
GGC
1838 * @package core
1839 * @category preference
1840 * @access public
1841 * @param stdClass $user User object. Preferences are preloaded into 'preference' property
1842 * @param int $cachelifetime Cache life time on the current page (in seconds)
1843 * @throws coding_exception
1844 * @return null
7cf1c7bd 1845 */
39461de3
PS
1846function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1847 global $DB;
ac7af0da
SH
1848 // Static cache, we need to check on each page load, not only every 2 minutes.
1849 static $loadedusers = array();
2660377f 1850
39461de3
PS
1851 if (!isset($user->id)) {
1852 throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1853 }
2660377f 1854
39461de3 1855 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1856 // No permanent storage for not-logged-in users and guest.
39461de3
PS
1857 if (!isset($user->preference)) {
1858 $user->preference = array();
2660377f 1859 }
39461de3 1860 return;
2660377f 1861 }
70812e39 1862
39461de3 1863 $timenow = time();
070e2616 1864
39461de3
PS
1865 if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1866 // Already loaded at least once on this page. Are we up to date?
1867 if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
ac7af0da 1868 // No need to reload - we are on the same page and we loaded prefs just a moment ago.
39461de3 1869 return;
70812e39 1870
39461de3 1871 } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
ac7af0da 1872 // No change since the lastcheck on this page.
39461de3
PS
1873 $user->preference['_lastloaded'] = $timenow;
1874 return;
70812e39 1875 }
c6d15803 1876 }
346c3e2f 1877
ac7af0da 1878 // OK, so we have to reload all preferences.
39461de3 1879 $loadedusers[$user->id] = true;
ac7af0da 1880 $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
39461de3 1881 $user->preference['_lastloaded'] = $timenow;
2660377f 1882}
1883
1884/**
ac7af0da 1885 * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
39461de3
PS
1886 *
1887 * NOTE: internal function, do not call from other code.
0d0a8bf6 1888 *
4d6b40a0 1889 * @package core
ac7af0da
SH
1890 * @access private
1891 * @param integer $userid the user whose prefs were changed.
2660377f 1892 */
1893function mark_user_preferences_changed($userid) {
39461de3
PS
1894 global $CFG;
1895
1896 if (empty($userid) or isguestuser($userid)) {
ac7af0da 1897 // No cache flags for guest and not-logged-in users.
39461de3 1898 return;
2660377f 1899 }
39461de3 1900
2660377f 1901 set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
70812e39 1902}
1903
7cf1c7bd 1904/**
39461de3 1905 * Sets a preference for the specified user.
0d0a8bf6 1906 *
4d6b40a0 1907 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
0d0a8bf6 1908 *
6e65554e
MG
1909 * When additional validation/permission check is needed it is better to use {@see useredit_update_user_preference()}
1910 *
4d6b40a0
GGC
1911 * @package core
1912 * @category preference
1913 * @access public
1914 * @param string $name The key to set as preference for the specified user
1915 * @param string $value The value to set for the $name key in the specified user's
1916 * record, null means delete current value.
1917 * @param stdClass|int|null $user A moodle user object or id, null means current user
1918 * @throws coding_exception
1919 * @return bool Always true or exception
7cf1c7bd 1920 */
39461de3 1921function set_user_preference($name, $value, $user = null) {
ae040d4b 1922 global $USER, $DB;
70812e39 1923
39461de3
PS
1924 if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1925 throw new coding_exception('Invalid preference name in set_user_preference() call');
70812e39 1926 }
1927
39461de3 1928 if (is_null($value)) {
ac7af0da 1929 // Null means delete current.
39461de3
PS
1930 return unset_user_preference($name, $user);
1931 } else if (is_object($value)) {
1932 throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1933 } else if (is_array($value)) {
1934 throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1935 }
ac7af0da 1936 // Value column maximum length is 1333 characters.
39461de3 1937 $value = (string)$value;
2f1e464a 1938 if (core_text::strlen($value) > 1333) {
8e54ce97
AD
1939 throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1940 }
39461de3
PS
1941
1942 if (is_null($user)) {
1943 $user = $USER;
1944 } else if (isset($user->id)) {
ac7af0da 1945 // It is a valid object.
39461de3 1946 } else if (is_numeric($user)) {
ac7af0da 1947 $user = (object)array('id' => (int)$user);
346c3e2f 1948 } else {
39461de3 1949 throw new coding_exception('Invalid $user parameter in set_user_preference() call');
346c3e2f 1950 }
1951
39461de3
PS
1952 check_user_preferences_loaded($user);
1953
1954 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1955 // No permanent storage for not-logged-in users and guest.
39461de3
PS
1956 $user->preference[$name] = $value;
1957 return true;
1958 }
346c3e2f 1959
ac7af0da 1960 if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
39461de3 1961 if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
ac7af0da 1962 // Preference already set to this value.
a1244706 1963 return true;
1964 }
ac7af0da 1965 $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
70812e39 1966
1967 } else {
365a5941 1968 $preference = new stdClass();
39461de3 1969 $preference->userid = $user->id;
ae040d4b 1970 $preference->name = $name;
39461de3 1971 $preference->value = $value;
013376de 1972 $DB->insert_record('user_preferences', $preference);
2660377f 1973 }
1974
ac7af0da 1975 // Update value in cache.
39461de3 1976 $user->preference[$name] = $value;
4ba4ecfa 1977 // Update the $USER in case where we've not a direct reference to $USER.
2524990d
TH
1978 if ($user !== $USER && $user->id == $USER->id) {
1979 $USER->preference[$name] = $value;
1980 }
39461de3 1981
ac7af0da 1982 // Set reload flag for other sessions.
39461de3 1983 mark_user_preferences_changed($user->id);
346c3e2f 1984
013376de 1985 return true;
2660377f 1986}
1987
1988/**
1989 * Sets a whole array of preferences for the current user
0d0a8bf6 1990 *
4d6b40a0 1991 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
39461de3 1992 *
4d6b40a0
GGC
1993 * @package core
1994 * @category preference
1995 * @access public
1996 * @param array $prefarray An array of key/value pairs to be set
1997 * @param stdClass|int|null $user A moodle user object or id, null means current user
1998 * @return bool Always true or exception
2660377f 1999 */
39461de3 2000function set_user_preferences(array $prefarray, $user = null) {
2660377f 2001 foreach ($prefarray as $name => $value) {
39461de3 2002 set_user_preference($name, $value, $user);
2660377f 2003 }
013376de 2004 return true;
70812e39 2005}
2006
6eb3e776 2007/**
2008 * Unsets a preference completely by deleting it from the database
0d0a8bf6 2009 *
4d6b40a0 2010 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
0d0a8bf6 2011 *
4d6b40a0
GGC
2012 * @package core
2013 * @category preference
2014 * @access public
2015 * @param string $name The key to unset as preference for the specified user
2016 * @param stdClass|int|null $user A moodle user object or id, null means current user
2017 * @throws coding_exception
2018 * @return bool Always true or exception
6eb3e776 2019 */
39461de3 2020function unset_user_preference($name, $user = null) {
ae040d4b 2021 global $USER, $DB;
6eb3e776 2022
39461de3
PS
2023 if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
2024 throw new coding_exception('Invalid preference name in unset_user_preference() call');
2025 }
2026
2027 if (is_null($user)) {
2028 $user = $USER;
2029 } else if (isset($user->id)) {
ac7af0da 2030 // It is a valid object.
39461de3 2031 } else if (is_numeric($user)) {
ac7af0da 2032 $user = (object)array('id' => (int)$user);
346c3e2f 2033 } else {
39461de3 2034 throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
346c3e2f 2035 }
2036
39461de3 2037 check_user_preferences_loaded($user);
013376de 2038
39461de3 2039 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 2040 // No permanent storage for not-logged-in user and guest.
39461de3
PS
2041 unset($user->preference[$name]);
2042 return true;
70812e39 2043 }
2044
ac7af0da
SH
2045 // Delete from DB.
2046 $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
39461de3 2047
ac7af0da 2048 // Delete the preference from cache.
39461de3 2049 unset($user->preference[$name]);
4ba4ecfa 2050 // Update the $USER in case where we've not a direct reference to $USER.
2524990d
TH
2051 if ($user !== $USER && $user->id == $USER->id) {
2052 unset($USER->preference[$name]);
2053 }
39461de3 2054
ac7af0da 2055 // Set reload flag for other sessions.
39461de3
PS
2056 mark_user_preferences_changed($user->id);
2057
013376de 2058 return true;
70812e39 2059}
2060
7cf1c7bd 2061/**
0d0a8bf6 2062 * Used to fetch user preference(s)
2063 *
7cf1c7bd 2064 * If no arguments are supplied this function will return
361855e6 2065 * all of the current user preferences as an array.
0d0a8bf6 2066 *
7cf1c7bd 2067 * If a name is specified then this function
2068 * attempts to return that particular preference value. If
2069 * none is found, then the optional value $default is returned,
ac7af0da 2070 * otherwise null.
0d0a8bf6 2071 *
4d6b40a0 2072 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
39461de3 2073 *
4d6b40a0
GGC
2074 * @package core
2075 * @category preference
2076 * @access public
2077 * @param string $name Name of the key to use in finding a preference value
2078 * @param mixed|null $default Value to be returned if the $name key is not set in the user preferences
2079 * @param stdClass|int|null $user A moodle user object or id, null means current user
2080 * @throws coding_exception
2081 * @return string|mixed|null A string containing the value of a single preference. An
2082 * array with all of the preferences or null
7cf1c7bd 2083 */
39461de3
PS
2084function get_user_preferences($name = null, $default = null, $user = null) {
2085 global $USER;
70812e39 2086
39461de3 2087 if (is_null($name)) {
ac7af0da 2088 // All prefs.
39461de3
PS
2089 } else if (is_numeric($name) or $name === '_lastloaded') {
2090 throw new coding_exception('Invalid preference name in get_user_preferences() call');
2091 }
346c3e2f 2092
39461de3
PS
2093 if (is_null($user)) {
2094 $user = $USER;
2095 } else if (isset($user->id)) {
ac7af0da 2096 // Is a valid object.
39461de3 2097 } else if (is_numeric($user)) {
8cba8d1a
AN
2098 if ($USER->id == $user) {
2099 $user = $USER;
2100 } else {
2101 $user = (object)array('id' => (int)$user);
2102 }
39461de3
PS
2103 } else {
2104 throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2105 }
2106
2107 check_user_preferences_loaded($user);
346c3e2f 2108
39461de3 2109 if (empty($name)) {
ac7af0da
SH
2110 // All values.
2111 return $user->preference;
39461de3 2112 } else if (isset($user->preference[$name])) {
ac7af0da
SH
2113 // The single string value.
2114 return $user->preference[$name];
346c3e2f 2115 } else {
ac7af0da
SH
2116 // Default value (null if not specified).
2117 return $default;
70812e39 2118 }
70812e39 2119}
2120
ac7af0da 2121// FUNCTIONS FOR HANDLING TIME.
39917a09 2122
7cf1c7bd 2123/**
e83bcc10 2124 * Given Gregorian date parts in user time produce a GMT timestamp.
7cf1c7bd 2125 *
9df12115
RT
2126 * @package core
2127 * @category time
68fbd8e1 2128 * @param int $year The year part to create timestamp of
2129 * @param int $month The month part to create timestamp of
2130 * @param int $day The day part to create timestamp of
2131 * @param int $hour The hour part to create timestamp of
2132 * @param int $minute The minute part to create timestamp of
2133 * @param int $second The second part to create timestamp of
9df12115
RT
2134 * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2135 * if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
6a0bf5c4
RT
2136 * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2137 * applied only if timezone is 99 or string.
9df12115 2138 * @return int GMT timestamp
7cf1c7bd 2139 */
9f1f6daf 2140function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
d6e7a63d
PS
2141 $date = new DateTime('now', core_date::get_user_timezone_object($timezone));
2142 $date->setDate((int)$year, (int)$month, (int)$day);
2143 $date->setTime((int)$hour, (int)$minute, (int)$second);
39917a09 2144
d6e7a63d 2145 $time = $date->getTimestamp();
33998d30 2146
9f2b916d
RT
2147 if ($time === false) {
2148 throw new coding_exception('getTimestamp() returned false, please ensure you have passed correct values.'.
2149 ' This can fail if year is more than 2038 and OS is 32 bit windows');
2150 }
2151
d6e7a63d
PS
2152 // Moodle BC DST stuff.
2153 if (!$applydst) {
2154 $time += dst_offset_on($time, $timezone);
9f1f6daf 2155 }
2156
196f2619 2157 return $time;
85cafb3e 2158
39917a09 2159}
2160
7cf1c7bd 2161/**
0d0a8bf6 2162 * Format a date/time (seconds) as weeks, days, hours etc as needed
2163 *
7cf1c7bd 2164 * Given an amount of time in seconds, returns string
8c42eef3 2165 * formatted nicely as years, days, hours etc as needed
7cf1c7bd 2166 *
9df12115
RT
2167 * @package core
2168 * @category time
2f87145b 2169 * @uses MINSECS
2170 * @uses HOURSECS
2171 * @uses DAYSECS
5602f7cf 2172 * @uses YEARSECS
0d0a8bf6 2173 * @param int $totalsecs Time in seconds
ac7af0da 2174 * @param stdClass $str Should be a time object
0d0a8bf6 2175 * @return string A nicely formatted date/time string
7cf1c7bd 2176 */
ac7af0da 2177function format_time($totalsecs, $str = null) {
c7e3ac2a 2178
6b174680 2179 $totalsecs = abs($totalsecs);
c7e3ac2a 2180
ac7af0da
SH
2181 if (!$str) {
2182 // Create the str structure the slow way.
b85b25eb 2183 $str = new stdClass();
b0ccd3fb 2184 $str->day = get_string('day');
2185 $str->days = get_string('days');
2186 $str->hour = get_string('hour');
2187 $str->hours = get_string('hours');
2188 $str->min = get_string('min');
2189 $str->mins = get_string('mins');
2190 $str->sec = get_string('sec');
2191 $str->secs = get_string('secs');
5602f7cf 2192 $str->year = get_string('year');
2193 $str->years = get_string('years');
8dbed6be 2194 }
2195
5602f7cf 2196 $years = floor($totalsecs/YEARSECS);
2197 $remainder = $totalsecs - ($years*YEARSECS);
5602f7cf 2198 $days = floor($remainder/DAYSECS);
7a5672c9 2199 $remainder = $totalsecs - ($days*DAYSECS);
2200 $hours = floor($remainder/HOURSECS);
2201 $remainder = $remainder - ($hours*HOURSECS);
2202 $mins = floor($remainder/MINSECS);
2203 $secs = $remainder - ($mins*MINSECS);
8dbed6be 2204
2205 $ss = ($secs == 1) ? $str->sec : $str->secs;
2206 $sm = ($mins == 1) ? $str->min : $str->mins;
2207 $sh = ($hours == 1) ? $str->hour : $str->hours;
2208 $sd = ($days == 1) ? $str->day : $str->days;
5602f7cf 2209 $sy = ($years == 1) ? $str->year : $str->years;
8dbed6be 2210
5602f7cf 2211 $oyears = '';
b0ccd3fb 2212 $odays = '';
2213 $ohours = '';
2214 $omins = '';
2215 $osecs = '';
9c9f7d77 2216
ac7af0da
SH
2217 if ($years) {
2218 $oyears = $years .' '. $sy;
2219 }
2220 if ($days) {
2221 $odays = $days .' '. $sd;
2222 }
2223 if ($hours) {
2224 $ohours = $hours .' '. $sh;
2225 }
2226 if ($mins) {
2227 $omins = $mins .' '. $sm;
2228 }
2229 if ($secs) {
2230 $osecs = $secs .' '. $ss;
2231 }
2232
2233 if ($years) {
2234 return trim($oyears .' '. $odays);
2235 }
2236 if ($days) {
2237 return trim($odays .' '. $ohours);
2238 }
2239 if ($hours) {
2240 return trim($ohours .' '. $omins);
2241 }
2242 if ($mins) {
2243 return trim($omins .' '. $osecs);
2244 }
2245 if ($secs) {
2246 return $osecs;
2247 }
b0ccd3fb 2248 return get_string('now');
6b174680 2249}
f9903ed0 2250
7cf1c7bd 2251/**
f59ab4ad 2252 * Returns a formatted string that represents a date in user time.
7cf1c7bd 2253 *
9df12115
RT
2254 * @package core
2255 * @category time
0a0cf09a 2256 * @param int $date the timestamp in UTC, as obtained from the database.
2257 * @param string $format strftime format. You should probably get this using
9df12115 2258 * get_string('strftime...', 'langconfig');
f59ab4ad 2259 * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
9df12115
RT
2260 * not 99 then daylight saving will not be added.
2261 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
0a0cf09a 2262 * @param bool $fixday If true (default) then the leading zero from %d is removed.
9df12115 2263 * If false then the leading zero is maintained.
d9498b38 2264 * @param bool $fixhour If true (default) then the leading zero from %I is removed.
0a0cf09a 2265 * @return string the formatted date/time.
7cf1c7bd 2266 */
d9498b38 2267function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
6eafa4dd 2268 $calendartype = \core_calendar\type_factory::get_calendar_instance();
f59ab4ad 2269 return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
873960de 2270}
2271
1bf3a76a
DW
2272/**
2273 * Returns a html "time" tag with both the exact user date with timezone information
2274 * as a datetime attribute in the W3C format, and the user readable date and time as text.
2275 *
2276 * @package core
2277 * @category time
2278 * @param int $date the timestamp in UTC, as obtained from the database.
2279 * @param string $format strftime format. You should probably get this using
2280 * get_string('strftime...', 'langconfig');
2281 * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
2282 * not 99 then daylight saving will not be added.
2283 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
2284 * @param bool $fixday If true (default) then the leading zero from %d is removed.
2285 * If false then the leading zero is maintained.
2286 * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2287 * @return string the formatted date/time.
2288 */
2289function userdate_htmltime($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2290 $userdatestr = userdate($date, $format, $timezone, $fixday, $fixhour);
2291 if (CLI_SCRIPT && !PHPUNIT_TEST) {
2292 return $userdatestr;
2293 }
2294 $machinedate = new DateTime();
2295 $machinedate->setTimestamp(intval($date));
2296 $machinedate->setTimezone(core_date::get_user_timezone_object());
2297
2298 return html_writer::tag('time', $userdatestr, ['datetime' => $machinedate->format(DateTime::W3C)]);
2299}
2300
15396bba
FM
2301/**
2302 * Returns a formatted date ensuring it is UTF-8.
2303 *
2304 * If we are running under Windows convert to Windows encoding and then back to UTF-8
2305 * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2306 *
d6e7a63d 2307 * @param int $date the timestamp - since Moodle 2.9 this is a real UTC timestamp
15396bba 2308 * @param string $format strftime format.
d6e7a63d 2309 * @param int|float|string $tz the user timezone
15396bba 2310 * @return string the formatted date/time.
5bcfd504 2311 * @since Moodle 2.3.3
15396bba
FM
2312 */
2313function date_format_string($date, $format, $tz = 99) {
2314 global $CFG;
d61d3e82
RT
2315
2316 $localewincharset = null;
2317 // Get the calendar type user is using.
2318 if ($CFG->ostype == 'WINDOWS') {
2319 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2320 $localewincharset = $calendartype->locale_win_charset();
2321 }
2322
d6e7a63d
PS
2323 if ($localewincharset) {
2324 $format = core_text::convert($format, 'utf-8', $localewincharset);
2325 }
2326
2327 date_default_timezone_set(core_date::get_user_timezone($tz));
2328 $datestring = strftime($format, $date);
2329 core_date::set_default_server_timezone();
2330
2331 if ($localewincharset) {
2332 $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
15396bba 2333 }
d6e7a63d 2334
15396bba
FM
2335 return $datestring;
2336}
2337
7cf1c7bd 2338/**
deed22ea 2339 * Given a $time timestamp in GMT (seconds since epoch),
40a6393e 2340 * returns an array that represents the Gregorian date in user time
7cf1c7bd 2341 *
9df12115
RT
2342 * @package core
2343 * @category time
deed22ea 2344 * @param int $time Timestamp in GMT
d6e7a63d 2345 * @param float|int|string $timezone user timezone
deed22ea 2346 * @return array An array that represents the date in user time
7cf1c7bd 2347 */
deed22ea 2348function usergetdate($time, $timezone=99) {
d6e7a63d
PS
2349 date_default_timezone_set(core_date::get_user_timezone($timezone));
2350 $result = getdate($time);
2351 core_date::set_default_server_timezone();
deed22ea 2352
d6e7a63d 2353 return $result;
d552ead0 2354}
2355
7cf1c7bd 2356/**
2357 * Given a GMT timestamp (seconds since epoch), offsets it by
2358 * the timezone. eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2359 *
d6e7a63d
PS
2360 * NOTE: this function does not include DST properly,
2361 * you should use the PHP date stuff instead!
2362 *
9df12115
RT
2363 * @package core
2364 * @category time
9df12115 2365 * @param int $date Timestamp in GMT
d6e7a63d 2366 * @param float|int|string $timezone user timezone
c6d15803 2367 * @return int
7cf1c7bd 2368 */
d552ead0 2369function usertime($date, $timezone=99) {
d6e7a63d
PS
2370 $userdate = new DateTime('@' . $date);
2371 $userdate->setTimezone(core_date::get_user_timezone_object($timezone));
2372 $dst = dst_offset_on($date, $timezone);
a36166d3 2373
d6e7a63d 2374 return $date - $userdate->getOffset() + $dst;
d552ead0 2375}
2376
612b210d
JD
2377/**
2378 * Get a formatted string representation of an interval between two unix timestamps.
2379 *
2380 * E.g.
2381 * $intervalstring = get_time_interval_string(12345600, 12345660);
2382 * Will produce the string:
2383 * '0d 0h 1m'
2384 *
2385 * @param int $time1 unix timestamp
2386 * @param int $time2 unix timestamp
2387 * @param string $format string (can be lang string) containing format chars: https://www.php.net/manual/en/dateinterval.format.php.
2388 * @return string the formatted string describing the time difference, e.g. '10d 11h 45m'.
2389 */
2390function get_time_interval_string(int $time1, int $time2, string $format = ''): string {
2391 $dtdate = new DateTime();
2392 $dtdate->setTimeStamp($time1);
2393 $dtdate2 = new DateTime();
2394 $dtdate2->setTimeStamp($time2);
2395 $interval = $dtdate2->diff($dtdate);
2396 $format = empty($format) ? get_string('relativedatestimediffformat', 'moodle') : $format;
2397 return $interval->format($format);
2398}
2399
8c3dba73 2400/**
2401 * Given a time, return the GMT timestamp of the most recent midnight
2402 * for the current user.
2403 *
9df12115
RT
2404 * @package core
2405 * @category time
e34d817e 2406 * @param int $date Timestamp in GMT
d6e7a63d 2407 * @param float|int|string $timezone user timezone
0d0a8bf6 2408 * @return int Returns a GMT timestamp
8c3dba73 2409 */
edf7fe8c 2410function usergetmidnight($date, $timezone=99) {
edf7fe8c 2411
edf7fe8c 2412 $userdate = usergetdate($date, $timezone);
4606d9bb 2413
ac7af0da 2414 // Time of midnight of this user's day, in GMT.
02f0527d 2415 return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
edf7fe8c 2416
2417}
2418
7cf1c7bd 2419/**
2420 * Returns a string that prints the user's timezone
2421 *
9df12115
RT
2422 * @package core
2423 * @category time
d6e7a63d 2424 * @param float|int|string $timezone user timezone
7cf1c7bd 2425 * @return string
2426 */
d552ead0 2427function usertimezone($timezone=99) {
d6e7a63d
PS
2428 $tz = core_date::get_user_timezone($timezone);
2429 return core_date::get_localised_timezone($tz);
61460dd6 2430}
2431
bbd3f2c4 2432/**
b2b68362 2433 * Returns a float or a string which denotes the user's timezone
2434 * 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)
2435 * means that for this timezone there are also DST rules to be taken into account
2436 * Checks various settings and picks the most dominant of those which have a value
bbd3f2c4 2437 *
9df12115
RT
2438 * @package core
2439 * @category time
2440 * @param float|int|string $tz timezone to calculate GMT time offset before
2441 * calculating user timezone, 99 is default user timezone
2442 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
2443 * @return float|string
bbd3f2c4 2444 */
e8904995 2445function get_user_timezone($tz = 99) {
2446 global $USER, $CFG;
43b59916 2447
f30fe8d0 2448 $timezones = array(
e8904995 2449 $tz,
2450 isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
43b59916 2451 isset($USER->timezone) ? $USER->timezone : 99,
2452 isset($CFG->timezone) ? $CFG->timezone : 99,
f30fe8d0 2453 );
43b59916 2454
e8904995 2455 $tz = 99;
43b59916 2456
ac7af0da 2457 // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
33683bc8
MG
2458 foreach ($timezones as $nextvalue) {
2459 if ((empty($tz) && !is_numeric($tz)) || $tz == 99) {
2460 $tz = $nextvalue;
2461 }
43b59916 2462 }
e8904995 2463 return is_numeric($tz) ? (float) $tz : $tz;
43b59916 2464}
2465
0d0a8bf6 2466/**
efb8c375 2467 * Calculates the Daylight Saving Offset for a given date/time (timestamp)
6a0bf5c4 2468 * - Note: Daylight saving only works for string timezones and not for float.
0d0a8bf6 2469 *
9df12115
RT
2470 * @package core
2471 * @category time
0d0a8bf6 2472 * @param int $time must NOT be compensated at all, it has to be a pure timestamp
d6e7a63d 2473 * @param int|float|string $strtimezone user timezone
0d0a8bf6 2474 * @return int
2475 */
ac7af0da 2476function dst_offset_on($time, $strtimezone = null) {
d6e7a63d
PS
2477 $tz = core_date::get_user_timezone($strtimezone);
2478 $date = new DateTime('@' . $time);
2479 $date->setTimezone(new DateTimeZone($tz));
2480 if ($date->format('I') == '1') {
2481 if ($tz === 'Australia/Lord_Howe') {
2482 return 1800;
c9e72798 2483 }
d6e7a63d 2484 return 3600;
c9e72798 2485 }
d6e7a63d 2486 return 0;
85cafb3e 2487}
02f0527d 2488
0d0a8bf6 2489/**
9df12115 2490 * Calculates when the day appears in specific month
0d0a8bf6 2491 *
9df12115
RT
2492 * @package core
2493 * @category time
2494 * @param int $startday starting day of the month
2495 * @param int $weekday The day when week starts (normally taken from user preferences)
2496 * @param int $month The month whose day is sought
2497 * @param int $year The year of the month whose day is sought
0d0a8bf6 2498 * @return int
2499 */
28902d99 2500function find_day_in_month($startday, $weekday, $month, $year) {
da304137 2501 $calendartype = \core_calendar\type_factory::get_calendar_instance();
8dc3f6cf 2502
2503 $daysinmonth = days_in_month($month, $year);
da304137 2504 $daysinweek = count($calendartype->get_weekdays());
8dc3f6cf 2505
ac7af0da 2506 if ($weekday == -1) {
28902d99 2507 // Don't care about weekday, so return:
2508 // abs($startday) if $startday != -1
ac7af0da 2509 // $daysinmonth otherwise.
28902d99 2510 return ($startday == -1) ? $daysinmonth : abs($startday);
8dc3f6cf 2511 }
2512
ac7af0da 2513 // From now on we 're looking for a specific weekday.
ac7af0da
SH
2514 // Give "end of month" its actual value, since we know it.
2515 if ($startday == -1) {
28902d99 2516 $startday = -1 * $daysinmonth;
2517 }
2518
ac7af0da 2519 // Starting from day $startday, the sign is the direction.
ac7af0da 2520 if ($startday < 1) {
28902d99 2521 $startday = abs($startday);
da304137 2522 $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
8dc3f6cf 2523
ac7af0da 2524 // This is the last such weekday of the month.
8dc3f6cf 2525 $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
ac7af0da 2526 if ($lastinmonth > $daysinmonth) {
da304137 2527 $lastinmonth -= $daysinweek;
42d36497 2528 }
8dc3f6cf 2529
ac7af0da
SH
2530 // Find the first such weekday <= $startday.
2531 while ($lastinmonth > $startday) {
da304137 2532 $lastinmonth -= $daysinweek;
42d36497 2533 }
8dc3f6cf 2534
2535 return $lastinmonth;
ac7af0da 2536 } else {
da304137 2537 $indexweekday = dayofweek($startday, $month, $year);
42d36497 2538
8dc3f6cf 2539 $diff = $weekday - $indexweekday;
ac7af0da 2540 if ($diff < 0) {
da304137 2541 $diff += $daysinweek;
42d36497 2542 }
42d36497 2543
ac7af0da 2544 // This is the first such weekday of the month equal to or after $startday.
28902d99 2545 $firstfromindex = $startday + $diff;
42d36497 2546
8dc3f6cf 2547 return $firstfromindex;
8dc3f6cf 2548 }
42d36497 2549}
2550
bbd3f2c4 2551/**
2552 * Calculate the number of days in a given month
2553 *
9df12115
RT
2554 * @package core
2555 * @category time
bbd3f2c4 2556 * @param int $month The month whose day count is sought
2557 * @param int $year The year of the month whose day count is sought
2558 * @return int
2559 */
42d36497 2560function days_in_month($month, $year) {
da304137
MN
2561 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2562 return $calendartype->get_num_days_in_month($year, $month);
42d36497 2563}
2564
bbd3f2c4 2565/**
2566 * Calculate the position in the week of a specific calendar day
2567 *
9df12115
RT
2568 * @package core
2569 * @category time
bbd3f2c4 2570 * @param int $day The day of the date whose position in the week is sought
2571 * @param int $month The month of the date whose position in the week is sought
2572 * @param int $year The year of the date whose position in the week is sought
2573 * @return int
2574 */
8dc3f6cf 2575function dayofweek($day, $month, $year) {
da304137
MN
2576 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2577 return $calendartype->get_weekday($year, $month, $day);
8dc3f6cf 2578}
2579
ac7af0da 2580// USER AUTHENTICATION AND LOGIN.
f9903ed0 2581
93f66983 2582/**
2583 * Returns full login url.
2584 *
6dfe4283
DW
2585 * Any form submissions for authentication to this URL must include username,
2586 * password as well as a logintoken generated by \core\session\manager::get_login_token().
2587 *
93f66983 2588 * @return string login url
2589 */
999b54af 2590function get_login_url() {
93f66983 2591 global $CFG;
2592
b58764ff 2593 return "$CFG->wwwroot/login/index.php";
93f66983 2594}
2595
7cf1c7bd 2596/**
ec81373f 2597 * This function checks that the current user is logged in and has the
2598 * required privileges
2599 *
7cf1c7bd 2600 * This function checks that the current user is logged in, and optionally
ec81373f 2601 * whether they are allowed to be in a particular course and view a particular
2602 * course module.
2603 * If they are not logged in, then it redirects them to the site login unless
d2a9f7cc 2604 * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
ec81373f 2605 * case they are automatically logged in as guests.
2606 * If $courseid is given and the user is not enrolled in that course then the
2607 * user is redirected to the course enrolment page.
efb8c375 2608 * If $cm is given and the course module is hidden and the user is not a teacher
ec81373f 2609 * in the course then the user is redirected to the course home page.
7cf1c7bd 2610 *
191b267b 2611 * When $cm parameter specified, this function sets page layout to 'module'.
4f0c2d00 2612 * You need to change it manually later if some other layout needed.
191b267b 2613 *
f76249cc
PS
2614 * @package core_access
2615 * @category access
2616 *
33ebaf7c 2617 * @param mixed $courseorid id of the course or course object
0d0a8bf6 2618 * @param bool $autologinguest default true
bbd3f2c4 2619 * @param object $cm course module object
f4013c10 2620 * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2621 * true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2622 * in order to keep redirects working properly. MDL-14495
df997f84 2623 * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
0d0a8bf6 2624 * @return mixed Void, exit, and die depending on path
ac7af0da
SH
2625 * @throws coding_exception
2626 * @throws require_login_exception
a428cf4a 2627 * @throws moodle_exception
7cf1c7bd 2628 */
ac7af0da 2629function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
f0202ae9 2630 global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
d8ba183c 2631
f22f1caf
PS
2632 // Must not redirect when byteserving already started.
2633 if (!empty($_SERVER['HTTP_RANGE'])) {
2634 $preventredirect = true;
2635 }
2636
2ed6be87
AN
2637 if (AJAX_SCRIPT) {
2638 // We cannot redirect for AJAX scripts either.
2639 $preventredirect = true;
2640 }
2641
ac7af0da 2642 // Setup global $COURSE, themes, language and locale.
c13a5e71 2643 if (!empty($courseorid)) {
2644 if (is_object($courseorid)) {
2645 $course = $courseorid;
2646 } else if ($courseorid == SITEID) {
2647 $course = clone($SITE);
2648 } else {
74df2951 2649 $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
c13a5e71 2650 }
95d28870 2651 if ($cm) {
df997f84
PS
2652 if ($cm->course != $course->id) {
2653 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2654 }
ac7af0da 2655 // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
47148151 2656 if (!($cm instanceof cm_info)) {
ac7af0da 2657 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
0d8b6a69 2658 // db queries so this is not really a performance concern, however it is obviously
2659 // better if you use get_fast_modinfo to get the cm before calling this.
2660 $modinfo = get_fast_modinfo($course);
2661 $cm = $modinfo->get_cm($cm->id);
2662 }
95d28870 2663 }
e88462a0 2664 } else {
ac7af0da 2665 // Do not touch global $COURSE via $PAGE->set_course(),
df997f84
PS
2666 // the reasons is we need to be able to call require_login() at any time!!
2667 $course = $SITE;
2668 if ($cm) {
2669 throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2670 }
c13a5e71 2671 }
be933850 2672
aa4a6566
SH
2673 // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2674 // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2675 // risk leading the user back to the AJAX request URL.
2676 if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2677 $setwantsurltome = false;
2678 }
2679
12fc11e7 2680 // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2ed6be87
AN
2681 if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !empty($CFG->dbsessions)) {
2682 if ($preventredirect) {
2683 throw new require_login_session_timeout_exception();
2684 } else {
2685 if ($setwantsurltome) {
2686 $SESSION->wantsurl = qualified_me();
2687 }
2688 redirect(get_login_url());
12fc11e7 2689 }
12fc11e7
DM
2690 }
2691
ac7af0da 2692 // If the user is not even logged in yet then make sure they are.
083c3743 2693 if (!isloggedin()) {
df997f84 2694 if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
999b54af 2695 if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
ac7af0da 2696 // Misconfigured site guest, just redirect to login page.
999b54af 2697 redirect(get_login_url());
ac7af0da 2698 exit; // Never reached.
df997f84 2699 }
999b54af 2700 $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
0342fc36 2701 complete_user_login($guest);
d9e07264 2702 $USER->autologinguest = true;
999b54af 2703 $SESSION->lang = $lang;
8a33e371 2704 } else {
ac7af0da 2705 // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
999b54af
PS
2706 if ($preventredirect) {
2707 throw new require_login_exception('You are not logged in');
2708 }
2709
2710 if ($setwantsurltome) {
f0202ae9 2711 $SESSION->wantsurl = qualified_me();
999b54af 2712 }
dcee0b94
SL
2713
2714 $referer = get_local_referer(false);
2715 if (!empty($referer)) {
2716 $SESSION->fromurl = $referer;
999b54af 2717 }
bf08e3f9
BH
2718
2719 // Give auth plugins an opportunity to authenticate or redirect to an external login page
2720 $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
2721 foreach($authsequence as $authname) {
2722 $authplugin = get_auth_plugin($authname);
2723 $authplugin->pre_loginpage_hook();
2724 if (isloggedin()) {
5ebbe1c3
IT
2725 if ($cm) {
2726 $modinfo = get_fast_modinfo($course);
2727 $cm = $modinfo->get_cm($cm->id);
2728 }
b940ca99 2729 set_access_log_user();
bf08e3f9
BH
2730 break;
2731 }
2732 }
2733
2734 // If we're still not logged in then go to the login page
2735 if (!isloggedin()) {
2736 redirect(get_login_url());
2737 exit; // Never reached.
2738 }
8a33e371 2739 }
f9903ed0 2740 }
808a3baa 2741
ac7af0da 2742 // Loginas as redirection if needed.
d79d5ac2 2743 if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
f6f66b03 2744 if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
df997f84 2745 if ($USER->loginascontext->instanceid != $course->id) {
3887fe4a 2746 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
5e623a33 2747 }
f6f66b03 2748 }
2749 }
2750
ac7af0da 2751 // Check whether the user should be changing password (but only if it is REALLY them).
d79d5ac2 2752 if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
21e2dcd9 2753 $userauth = get_auth_plugin($USER->auth);
df997f84 2754 if ($userauth->can_change_password() and !$preventredirect) {
af572078 2755 if ($setwantsurltome) {
f0202ae9 2756 $SESSION->wantsurl = qualified_me();
af572078 2757 }
80274abf 2758 if ($changeurl = $userauth->change_password_url()) {
ac7af0da 2759 // Use plugin custom url.
80274abf 2760 redirect($changeurl);
1437f0a5 2761 } else {
ac7af0da 2762 // Use moodle internal method.
b58764ff 2763 redirect($CFG->wwwroot .'/login/change_password.php');
1437f0a5 2764 }
80e0f0b8
JL
2765 } else if ($userauth->can_change_password()) {
2766 throw new moodle_exception('forcepasswordchangenotice');
d35757eb 2767 } else {
80e0f0b8 2768 throw new moodle_exception('nopasswordchangeforced', 'auth');
d35757eb 2769 }
2770 }
083c3743 2771
8df850ad 2772 // Check that the user account is properly set up. If we can't redirect to
eeae783c
JL
2773 // edit their profile and this is not a WS request, perform just the lax check.
2774 // It will allow them to use filepicker on the profile edit page.
8df850ad 2775
eeae783c 2776 if ($preventredirect && !WS_SERVER) {
8df850ad
DM
2777 $usernotfullysetup = user_not_fully_set_up($USER, false);
2778 } else {
2779 $usernotfullysetup = user_not_fully_set_up($USER, true);
2780 }
2781
2782 if ($usernotfullysetup) {
df997f84 2783 if ($preventredirect) {
80e0f0b8 2784 throw new moodle_exception('usernotfullysetup');
df997f84 2785 }
af572078 2786 if ($setwantsurltome) {
f0202ae9 2787 $SESSION->wantsurl = qualified_me();
af572078 2788 }
b0ccd3fb 2789 redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
808a3baa 2790 }
d8ba183c 2791
df997f84 2792 // Make sure the USER has a sesskey set up. Used for CSRF protection.
04280e85 2793 sesskey();
366dfa60 2794
93dda3bf
RW
2795 if (\core\session\manager::is_loggedinas()) {
2796 // During a "logged in as" session we should force all content to be cleaned because the
2797 // logged in user will be viewing potentially malicious user generated content.
2798 // See MDL-63786 for more details.
2799 $CFG->forceclean = true;
2800 }
2801
bf9f2555
BH
2802 $afterlogins = get_plugins_with_function('after_require_login', 'lib.php');
2803
a428cf4a
JD
2804 // Do not bother admins with any formalities, except for activities pending deletion.
2805 if (is_siteadmin() && !($cm && $cm->deletioninprogress)) {
1edd3d6f
MG
2806 // Set the global $COURSE.
2807 if ($cm) {
2808 $PAGE->set_cm($cm, $course);
2809 $PAGE->set_pagelayout('incourse');
2810 } else if (!empty($courseorid)) {
2811 $PAGE->set_course($course);
2812 }
ac7af0da 2813 // Set accesstime or the user will appear offline which messes up messaging.
160e77f9
DW
2814 // Do not update access time for webservice or ajax requests.
2815 if (!WS_SERVER && !AJAX_SCRIPT) {
2816 user_accesstime_log($course->id);
2817 }
bf9f2555
BH
2818
2819 foreach ($afterlogins as $plugintype => $plugins) {
2820 foreach ($plugins as $pluginfunction) {
2821 $pluginfunction($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
2822 }
2823 }
df997f84
PS
2824 return;
2825 }
2826
0bdc5785
DM
2827 // Scripts have a chance to declare that $USER->policyagreed should not be checked.
2828 // This is mostly for places where users are actually accepting the policies, to avoid the redirect loop.
2829 if (!defined('NO_SITEPOLICY_CHECK')) {
2830 define('NO_SITEPOLICY_CHECK', false);
2831 }
2832
ac7af0da 2833 // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
0bdc5785 2834 // Do not test if the script explicitly asked for skipping the site policies check.
1727c939
MG
2835 if (!$USER->policyagreed && !is_siteadmin() && !NO_SITEPOLICY_CHECK) {
2836 $manager = new \core_privacy\local\sitepolicy\manager();
2837 if ($policyurl = $manager->get_redirect_url(isguestuser())) {
b593d49d 2838 if ($preventredirect) {
1727c939 2839 throw new moodle_exception('sitepolicynotagreed', 'error', '', $policyurl->out());
b593d49d 2840 }
af572078 2841 if ($setwantsurltome) {
f0202ae9 2842 $SESSION->wantsurl = qualified_me();
af572078 2843 }
1727c939 2844 redirect($policyurl);
027a1604 2845 }
1695b680 2846 }
2847
ac7af0da 2848 // Fetch the system context, the course context, and prefetch its child contexts.
b0c6dc1c
AG
2849 $sysctx = context_system::instance();
2850 $coursecontext = context_course::instance($course->id, MUST_EXIST);
df997f84 2851 if ($cm) {
b0c6dc1c 2852 $cmcontext = context_module::instance($cm->id, MUST_EXIST);
df997f84
PS
2853 } else {
2854 $cmcontext = null;
2855 }
21e2dcd9 2856
ac7af0da 2857 // If the site is currently under maintenance, then print a message.
59c66f92 2858 if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:maintenanceaccess', $sysctx)) {
df997f84
PS
2859 if ($preventredirect) {
2860 throw new require_login_exception('Maintenance in progress');
2861 }
a4ea86f6 2862 $PAGE->set_context(null);
4fe2250a 2863 print_maintenance_message();
027a1604 2864 }
2865
ac7af0da 2866 // Make sure the course itself is not hidden.
df997f84 2867 if ($course->id == SITEID) {
ac7af0da 2868 // Frontpage can not be hidden.
df997f84 2869 } else {
f5c1e621 2870 if (is_role_switched($course->id)) {
ac7af0da 2871 // When switching roles ignore the hidden flag - user had to be in course to do the switch.
df997f84
PS
2872 } else {
2873 if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
ac7af0da
SH
2874 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
2875 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
df997f84
PS
2876 if ($preventredirect) {
2877 throw new require_login_exception('Course is hidden');
2878 }
1edd3d6f 2879 $PAGE->set_context(null);
ac7af0da
SH
2880 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2881 // the navigation will mess up when trying to find it.
a0a39b0d 2882 navigation_node::override_active_url(new moodle_url('/'));
df997f84
PS
2883 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2884 }
2885 }
2886 }
2887
ac7af0da 2888 // Is the user enrolled?
df997f84 2889 if ($course->id == SITEID) {
ac7af0da 2890 // Everybody is enrolled on the frontpage.
df997f84 2891 } else {
d79d5ac2 2892 if (\core\session\manager::is_loggedinas()) {
ac7af0da 2893 // Make sure the REAL person can access this course first.
d79d5ac2 2894 $realuser = \core\session\manager::get_realuser();
ac7af0da
SH
2895 if (!is_enrolled($coursecontext, $realuser->id, '', true) and
2896 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
df997f84
PS
2897 if ($preventredirect) {
2898 throw new require_login_exception('Invalid course login-as access');
2899 }
1edd3d6f 2900 $PAGE->set_context(null);
df997f84
PS
2901 echo $OUTPUT->header();
2902 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2903 }
2904 }
2905
df997f84
PS
2906 $access = false;
2907
dbd7282c 2908 if (is_role_switched($course->id)) {
ac7af0da 2909 // Ok, user had to be inside this course before the switch.
dbd7282c
PS
2910 $access = true;
2911
2912 } else if (is_viewing($coursecontext, $USER)) {
ac7af0da 2913 // Ok, no need to mess with enrol.
df997f84
PS
2914 $access = true;
2915
2916 } else {
2917 if (isset($USER->enrol['enrolled'][$course->id])) {
bbfdff34 2918 if ($USER->enrol['enrolled'][$course->id] > time()) {
df997f84 2919 $access = true;
bbfdff34
PS
2920 if (isset($USER->enrol['tempguest'][$course->id])) {
2921 unset($USER->enrol['tempguest'][$course->id]);
2922 remove_temp_course_roles($coursecontext);
2923 }
df997f84 2924 } else {
ac7af0da 2925 // Expired.
df997f84
PS
2926 unset($USER->enrol['enrolled'][$course->id]);
2927 }
2928 }
2929 if (isset($USER->enrol['tempguest'][$course->id])) {
2930 if ($USER->enrol['tempguest'][$course->id] == 0) {
2931 $access = true;
2932 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2933 $access = true;
2934 } else {
ac7af0da 2935 // Expired.
df997f84 2936 unset($USER->enrol['tempguest'][$course->id]);
e922fe23 2937 remove_temp_course_roles($coursecontext);
df997f84
PS
2938 }
2939 }
2940
ac7af0da
SH
2941 if (!$access) {
2942 // Cache not ok.
bbfdff34
PS
2943 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2944 if ($until !== false) {
ac7af0da 2945 // Active participants may always access, a timestamp in the future, 0 (always) or false.
bbfdff34
PS
2946 if ($until == 0) {
2947 $until = ENROL_MAX_TIMESTAMP;
df997f84 2948 }
bbfdff34
PS
2949 $USER->enrol['enrolled'][$course->id] = $until;
2950 $access = true;
2951
beff3806 2952 } else if (core_course_category::can_view_course_info($course)) {
ac7af0da
SH
2953 $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
2954 $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
bbfdff34 2955 $enrols = enrol_get_plugins(true);
ac7af0da
SH
2956 // First ask all enabled enrol instances in course if they want to auto enrol user.
2957 foreach ($instances as $instance) {
df997f84
PS
2958 if (!isset($enrols[$instance->enrol])) {
2959 continue;
2960 }
bbfdff34
PS
2961 // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2962 $until = $enrols[$instance->enrol]->try_autoenrol($instance);
df997f84 2963 if ($until !== false) {
bbfdff34
PS
2964 if ($until == 0) {
2965 $until = ENROL_MAX_TIMESTAMP;
2966 }
2967 $USER->enrol['enrolled'][$course->id] = $until;
df997f84
PS
2968 $access = true;
2969 break;
2970 }
2971 }
ac7af0da 2972 // If not enrolled yet try to gain temporary guest access.
bbfdff34 2973 if (!$access) {
ac7af0da 2974 foreach ($instances as $instance) {
bbfdff34
PS
2975 if (!isset($enrols[$instance->enrol])) {
2976 continue;
2977 }
2978 // Get a duration for the guest access, a timestamp in the future or false.
2979 $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2980 if ($until !== false and $until > time()) {
2981 $USER->enrol['tempguest'][$course->id] = $until;
2982 $access = true;
2983 break;
2984 }
2985 }
2986 }
beff3806
MG
2987 } else {
2988 // User is not enrolled and is not allowed to browse courses here.
2989 if ($preventredirect) {
2990 throw new require_login_exception('Course is not available');
2991 }
2992 $PAGE->set_context(null);
2993 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2994 // the navigation will mess up when trying to find it.
2995 navigation_node::override_active_url(new moodle_url('/'));
2996 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
df997f84
PS
2997 }
2998 }
2999 }
3000
3001 if (!$access) {
3002 if ($preventredirect) {
3003 throw new require_login_exception('Not enrolled');
3004 }
af572078 3005 if ($setwantsurltome) {
f0202ae9 3006 $SESSION->wantsurl = qualified_me();
af572078 3007 }
b3cb7264 3008 redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
df997f84
PS
3009 }
3010 }
3011
a428cf4a
JD
3012 // Check whether the activity has been scheduled for deletion. If so, then deny access, even for admins.
3013 if ($cm && $cm->deletioninprogress) {
3014 if ($preventredirect) {
3015 throw new moodle_exception('activityisscheduledfordeletion');
3016 }
3017 require_once($CFG->dirroot . '/course/lib.php');
3018 redirect(course_get_url($course), get_string('activityisscheduledfordeletion', 'error'));
3019 }
3020
061e6b28 3021 // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
0d8b6a69 3022 if ($cm && !$cm->uservisible) {
df997f84
PS
3023 if ($preventredirect) {
3024 throw new require_login_exception('Activity is hidden');
3025 }
592f3ae2
MG
3026 // Get the error message that activity is not available and why (if explanation can be shown to the user).
3027 $PAGE->set_course($course);
3028 $renderer = $PAGE->get_renderer('course');
2c3a34f0 3029 $message = $renderer->course_section_cm_unavailable_error_message($cm);
592f3ae2 3030 redirect(course_get_url($course), $message, null, \core\output\notification::NOTIFY_ERROR);
df997f84
PS
3031 }
3032
aad5b7f1 3033 // Set the global $COURSE.
3034 if ($cm) {
3035 $PAGE->set_cm($cm, $course);
3036 $PAGE->set_pagelayout('incourse');
3037 } else if (!empty($courseorid)) {
3038 $PAGE->set_course($course);
3039 }
3040
bf9f2555
BH
3041 foreach ($afterlogins as $plugintype => $plugins) {
3042 foreach ($plugins as $pluginfunction) {
3043 $pluginfunction($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3044 }
3045 }
3046
ac7af0da 3047 // Finally access granted, update lastaccess times.
160e77f9
DW
3048 // Do not update access time for webservice or ajax requests.
3049 if (!WS_SERVER && !AJAX_SCRIPT) {
3050 user_accesstime_log($course->id);
3051 }
f9903ed0 3052}
3053
1fc0c4bd
BH
3054/**
3055 * A convenience function for where we must be logged in as admin
3056 * @return void
3057 */
3058function require_admin() {
3059 require_login(null, false);
3060 require_capability('moodle/site:config', context_system::instance());
3061}
c4d0753b 3062
c4d0753b 3063/**
3064 * This function just makes sure a user is logged out.
3065 *
f76249cc 3066 * @package core_access
ac7af0da 3067 * @category access
c4d0753b 3068 */
3069function require_logout() {
d79d5ac2 3070 global $USER, $DB;
c4d0753b 3071
d79d5ac2
PS
3072 if (!isloggedin()) {
3073 // This should not happen often, no need for hooks or events here.
3074 \core\session\manager::terminate_current();
3075 return;
c4d0753b 3076 }
3077
d79d5ac2 3078 // Execute hooks before action.
f9f9d187 3079 $authplugins = array();
d79d5ac2
PS
3080 $authsequence = get_enabled_auth_plugins();
3081 foreach ($authsequence as $authname) {
f9f9d187
SL
3082 $authplugins[$authname] = get_auth_plugin($authname);
3083 $authplugins[$authname]->prelogout_hook();
d79d5ac2
PS
3084 }
3085
3086