MDL-62240 file: Add includehash to shorten_filename + unit tests
[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.
140 * Instead, do something like
141 * $rawvalue = required_param('name', PARAM_RAW);
142 * // ... other code including require_login, which sets current lang ...
143 * $realvalue = unformat_float($rawvalue);
144 * // ... then use $realvalue
6e73ae10 145 */
03b31ea3 146define('PARAM_FLOAT', 'float');
6e73ae10 147
148/**
03b31ea3 149 * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
150 */
151define('PARAM_HOST', 'host');
152
153/**
154 * PARAM_INT - integers only, use when expecting only numbers.
6e73ae10 155 */
03b31ea3 156define('PARAM_INT', 'int');
157
158/**
159 * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
160 */
161define('PARAM_LANG', 'lang');
162
163/**
ac7af0da
SH
164 * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the
165 * others! Implies PARAM_URL!)
03b31ea3 166 */
167define('PARAM_LOCALURL', 'localurl');
bbd3f2c4 168
169/**
c59733ef 170 * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
bbd3f2c4 171 */
03b31ea3 172define('PARAM_NOTAGS', 'notags');
bbd3f2c4 173
6e73ae10 174/**
ac7af0da
SH
175 * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory
176 * traversals note: the leading slash is not removed, window drive letter is not allowed
31f26796 177 */
03b31ea3 178define('PARAM_PATH', 'path');
31f26796 179
6e73ae10 180/**
03b31ea3 181 * PARAM_PEM - Privacy Enhanced Mail format
c4ea5e78 182 */
03b31ea3 183define('PARAM_PEM', 'pem');
c4ea5e78 184
bbd3f2c4 185/**
03b31ea3 186 * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
bbd3f2c4 187 */
03b31ea3 188define('PARAM_PERMISSION', 'permission');
bbd3f2c4 189
bed79931 190/**
78fcdb5f 191 * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
bed79931 192 */
03b31ea3 193define('PARAM_RAW', 'raw');
bed79931 194
652599ec
TH
195/**
196 * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
197 */
198define('PARAM_RAW_TRIMMED', 'raw_trimmed');
199
bcef0319 200/**
03b31ea3 201 * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
bcef0319 202 */
03b31ea3 203define('PARAM_SAFEDIR', 'safedir');
bcef0319 204
e032888c 205/**
03b31ea3 206 * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
38fb8190 207 */
03b31ea3 208define('PARAM_SAFEPATH', 'safepath');
e032888c 209
bbd3f2c4 210/**
03b31ea3 211 * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9. Numbers and comma only.
bbd3f2c4 212 */
03b31ea3 213define('PARAM_SEQUENCE', 'sequence');
bbd3f2c4 214
215/**
03b31ea3 216 * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
bbd3f2c4 217 */
03b31ea3 218define('PARAM_TAG', 'tag');
bbd3f2c4 219
220/**
03b31ea3 221 * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
bbd3f2c4 222 */
03b31ea3 223define('PARAM_TAGLIST', 'taglist');
bbd3f2c4 224
225/**
b6059edc 226 * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
bbd3f2c4 227 */
03b31ea3 228define('PARAM_TEXT', 'text');
bbd3f2c4 229
bbd3f2c4 230/**
03b31ea3 231 * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
bbd3f2c4 232 */
03b31ea3 233define('PARAM_THEME', 'theme');
bbd3f2c4 234
235/**
ac7af0da
SH
236 * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but
237 * http://localhost.localdomain/ is ok.
bbd3f2c4 238 */
03b31ea3 239define('PARAM_URL', 'url');
240
07ed083e 241/**
ac7af0da
SH
242 * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user
243 * accounts, do NOT use when syncing with external systems!!
07ed083e
RW
244 */
245define('PARAM_USERNAME', 'username');
bbd3f2c4 246
fe6a248f
DM
247/**
248 * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
249 */
250define('PARAM_STRINGID', 'stringid');
03b31ea3 251
ac7af0da 252// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE.
bbd3f2c4 253/**
03b31ea3 254 * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
255 * It was one of the first types, that is why it is abused so much ;-)
44913c8d 256 * @deprecated since 2.0
bbd3f2c4 257 */
03b31ea3 258define('PARAM_CLEAN', 'clean');
bbd3f2c4 259
260/**
03b31ea3 261 * PARAM_INTEGER - deprecated alias for PARAM_INT
1e12c120 262 * @deprecated since 2.0
bbd3f2c4 263 */
03b31ea3 264define('PARAM_INTEGER', 'int');
bbd3f2c4 265
0e4af166 266/**
03b31ea3 267 * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
61cca0b7 268 * @deprecated since 2.0
0e4af166 269 */
03b31ea3 270define('PARAM_NUMBER', 'float');
0e4af166 271
03d820c7 272/**
efb8c375 273 * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
03b31ea3 274 * NOTE: originally alias for PARAM_APLHA
405aca35 275 * @deprecated since 2.0
03d820c7 276 */
03b31ea3 277define('PARAM_ACTION', 'alphanumext');
03d820c7 278
279/**
03b31ea3 280 * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
281 * NOTE: originally alias for PARAM_APLHA
405aca35 282 * @deprecated since 2.0
03d820c7 283 */
03b31ea3 284define('PARAM_FORMAT', 'alphanumext');
03d820c7 285
ad944e78 286/**
03b31ea3 287 * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
071e68f9 288 * @deprecated since 2.0
ad944e78 289 */
03b31ea3 290define('PARAM_MULTILANG', 'text');
03d820c7 291
ccc77f91
RT
292/**
293 * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
ac7af0da 294 * string separated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
ccc77f91
RT
295 * America/Port-au-Prince)
296 */
297define('PARAM_TIMEZONE', 'timezone');
298
faf75fe7 299/**
03b31ea3 300 * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
faf75fe7 301 */
03b31ea3 302define('PARAM_CLEANFILE', 'file');
303
aff24313
PS
304/**
305 * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
306 * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
307 * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
308 * NOTE: numbers and underscores are strongly discouraged in plugin names!
309 */
310define('PARAM_COMPONENT', 'component');
311
312/**
313 * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
314 * It is usually used together with context id and component.
315 * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
316 */
317define('PARAM_AREA', 'area');
318
319/**
159c2c91 320 * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'paypal', 'completionstatus'.
aff24313
PS
321 * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
322 * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
323 */
324define('PARAM_PLUGIN', 'plugin');
325
326
ac7af0da 327// Web Services.
03b31ea3 328
382b9cea 329/**
330 * VALUE_REQUIRED - if the parameter is not supplied, there is an error
331 */
332define('VALUE_REQUIRED', 1);
333
334/**
335 * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
336 */
337define('VALUE_OPTIONAL', 2);
338
339/**
340 * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
341 */
342define('VALUE_DEFAULT', 0);
03b31ea3 343
5a1861ee 344/**
345 * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
346 */
347define('NULL_NOT_ALLOWED', false);
348
349/**
350 * NULL_ALLOWED - the parameter can be set to null in the database
351 */
352define('NULL_ALLOWED', true);
faf75fe7 353
ac7af0da
SH
354// Page types.
355
bbd3f2c4 356/**
357 * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
8bd3fad3 358 */
359define('PAGE_COURSE_VIEW', 'course-view');
8bd3fad3 360
9bda43e6 361/** Get remote addr constant */
362define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
363/** Get remote addr constant */
364define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
6e73ae10 365
ac7af0da 366// Blog access level constant declaration.
feaf5d06 367define ('BLOG_USER_LEVEL', 1);
368define ('BLOG_GROUP_LEVEL', 2);
369define ('BLOG_COURSE_LEVEL', 3);
370define ('BLOG_SITE_LEVEL', 4);
371define ('BLOG_GLOBAL_LEVEL', 5);
372
6e73ae10 373
ac7af0da 374// Tag constants.
4eb718d8 375/**
a905364a 376 * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
6e73ae10 377 * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
378 * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
0d0a8bf6 379 *
380 * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
4eb718d8 381 */
ae040d4b 382define('TAG_MAX_LENGTH', 50);
4eb718d8 383
ac7af0da 384// Password policy constants.
6499395e 385define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
386define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
387define ('PASSWORD_DIGITS', '0123456789');
388define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
389
ac7af0da 390// Feature constants.
6e73ae10 391// Used for plugin_supports() to report features that are, or are not, supported by a module.
49f6e5f4 392
393/** True if module can provide a grade */
61fceb86 394define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
42f103be 395/** True if module supports outcomes */
396define('FEATURE_GRADE_OUTCOMES', 'outcomes');
b11f9da6
DM
397/** True if module supports advanced grading methods */
398define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
455dc0de
FM
399/** True if module controls the grade visibility over the gradebook */
400define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
50da4ddd
KG
401/** True if module supports plagiarism plugins */
402define('FEATURE_PLAGIARISM', 'plagiarism');
42f103be 403
49f6e5f4 404/** True if module has code to track whether somebody viewed it */
61fceb86 405define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
49f6e5f4 406/** True if module has custom completion rules */
61fceb86 407define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
49f6e5f4 408
0d8b6a69 409/** True if module has no 'view' page (like label) */
410define('FEATURE_NO_VIEW_LINK', 'viewlink');
de158ec5 411/** True (which is default) if the module wants support for setting the ID number for grade calculation purposes. */
42f103be 412define('FEATURE_IDNUMBER', 'idnumber');
413/** True if module supports groups */
414define('FEATURE_GROUPS', 'groups');
415/** True if module supports groupings */
416define('FEATURE_GROUPINGS', 'groupings');
061e6b28 417/**
418 * True if module supports groupmembersonly (which no longer exists)
419 * @deprecated Since Moodle 2.8
420 */
42f103be 421define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
422
aa54ed7b 423/** Type of module */
424define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
42f103be 425/** True if module supports intro editor */
dc5c2bd9 426define('FEATURE_MOD_INTRO', 'mod_intro');
42f103be 427/** True if module has default completion */
428define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
49f6e5f4 429
1bcb7eb5 430define('FEATURE_COMMENT', 'comment');
431
6c5fcef7 432define('FEATURE_RATE', 'rate');
4bfdcfcf
EL
433/** True if module supports backup/restore of moodle2 format */
434define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
a09aeee4 435
8c40662e 436/** True if module can show description on course main page */
437define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
438
b07ef13b
DP
439/** True if module uses the question bank */
440define('FEATURE_USES_QUESTIONS', 'usesquestions');
441
757a889b
MG
442/**
443 * Maximum filename char size
444 */
d609207c 445define('MAX_FILENAME_SIZE', 100);
757a889b 446
aa54ed7b 447/** Unspecified module archetype */
448define('MOD_ARCHETYPE_OTHER', 0);
449/** Resource-like type module */
450define('MOD_ARCHETYPE_RESOURCE', 1);
efb8c375 451/** Assignment module archetype */
aa54ed7b 452define('MOD_ARCHETYPE_ASSIGNMENT', 2);
5813c7f7 453/** System (not user-addable) module archetype */
454define('MOD_ARCHETYPE_SYSTEM', 3);
aa54ed7b 455
9ca0420e
MG
456/**
457 * Return this from modname_get_types callback to use default display in activity chooser.
458 * Deprecated, will be removed in 3.5, TODO MDL-53697.
459 * @deprecated since Moodle 3.1
460 */
50ae8814
MN
461define('MOD_SUBTYPE_NO_CHILDREN', 'modsubtypenochildren');
462
eec99048 463/**
464 * Security token used for allowing access
465 * from external application such as web services.
466 * Scripts do not use any session, performance is relatively
467 * low because we need to load access info in each request.
efb8c375 468 * Scripts are executed in parallel.
eec99048 469 */
470define('EXTERNAL_TOKEN_PERMANENT', 0);
471
472/**
473 * Security token used for allowing access
474 * of embedded applications, the code is executed in the
475 * active user session. Token is invalidated after user logs out.
476 * Scripts are executed serially - normal session locking is used.
477 */
478define('EXTERNAL_TOKEN_EMBEDDED', 1);
49f6e5f4 479
4766a50c
SH
480/**
481 * The home page should be the site home
482 */
483define('HOMEPAGE_SITE', 0);
484/**
485 * The home page should be the users my page
486 */
487define('HOMEPAGE_MY', 1);
488/**
489 * The home page can be chosen by the user
490 */
491define('HOMEPAGE_USER', 2);
fcce139a 492
94788de2 493/**
494 * Hub directory url (should be moodle.org)
495 */
7d792aee 496define('HUB_HUBDIRECTORYURL', "https://hubdirectory.moodle.org");
94788de2 497
498
499/**
7d792aee 500 * Moodle.net url (should be moodle.net)
94788de2 501 */
7d792aee
MG
502define('HUB_MOODLEORGHUBURL', "https://moodle.net");
503define('HUB_OLDMOODLEORGHUBURL', "http://hub.moodle.org");
94788de2 504
c1b65883
JM
505/**
506 * Moodle mobile app service name
507 */
508define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
94788de2 509
bc8da017
AD
510/**
511 * Indicates the user has the capabilities required to ignore activity and course file size restrictions
512 */
513define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
514
1f09018a 515/**
ac7af0da
SH
516 * Course display settings: display all sections on one page.
517 */
518define('COURSE_DISPLAY_SINGLEPAGE', 0);
519/**
520 * Course display settings: split pages into a page per section.
1f09018a 521 */
ac7af0da 522define('COURSE_DISPLAY_MULTIPAGE', 1);
1f09018a 523
ec2d8ceb 524/**
ac7af0da 525 * Authentication constant: String used in password field when password is not stored.
ec2d8ceb 526 */
ac7af0da 527define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
ec2d8ceb 528
9715f61a
AG
529/**
530 * Email from header to never include via information.
531 */
532define('EMAIL_VIA_NEVER', 0);
533
534/**
535 * Email from header to always include via information.
536 */
537define('EMAIL_VIA_ALWAYS', 1);
538
539/**
540 * Email from header to only include via information if the address is no-reply.
541 */
542define('EMAIL_VIA_NO_REPLY_ONLY', 2);
543
ac7af0da 544// PARAMETER HANDLING.
6b174680 545
e0d346ff 546/**
361855e6 547 * Returns a particular value for the named variable, taken from
548 * POST or GET. If the parameter doesn't exist then an error is
e0d346ff 549 * thrown because we require this variable.
550 *
361855e6 551 * This function should be used to initialise all required values
552 * in a script that are based on parameters. Usually it will be
e0d346ff 553 * used like this:
622365d2 554 * $id = required_param('id', PARAM_INT);
e0d346ff 555 *
2ca3bffa 556 * Please note the $type parameter is now required and the value can not be array.
44913c8d
PS
557 *
558 * @param string $parname the name of the page parameter we want
559 * @param string $type expected type of parameter
e0d346ff 560 * @return mixed
ac7af0da 561 * @throws coding_exception
e0d346ff 562 */
44913c8d 563function required_param($parname, $type) {
2ca3bffa
PS
564 if (func_num_args() != 2 or empty($parname) or empty($type)) {
565 throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
44913c8d 566 }
ac7af0da
SH
567 // POST has precedence.
568 if (isset($_POST[$parname])) {
a083b93c 569 $param = $_POST[$parname];
570 } else if (isset($_GET[$parname])) {
571 $param = $_GET[$parname];
e0d346ff 572 } else {
2f137aa1 573 print_error('missingparam', '', '', $parname);
e0d346ff 574 }
575
2ca3bffa
PS
576 if (is_array($param)) {
577 debugging('Invalid array parameter detected in required_param(): '.$parname);
ac7af0da 578 // TODO: switch to fatal error in Moodle 2.3.
2ca3bffa
PS
579 return required_param_array($parname, $type);
580 }
581
a083b93c 582 return clean_param($param, $type);
e0d346ff 583}
584
2ca3bffa
PS
585/**
586 * Returns a particular array value for the named variable, taken from
587 * POST or GET. If the parameter doesn't exist then an error is
588 * thrown because we require this variable.
589 *
590 * This function should be used to initialise all required values
591 * in a script that are based on parameters. Usually it will be
592 * used like this:
593 * $ids = required_param_array('ids', PARAM_INT);
594 *
595 * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
596 *
597 * @param string $parname the name of the page parameter we want
598 * @param string $type expected type of parameter
599 * @return array
ac7af0da 600 * @throws coding_exception
2ca3bffa
PS
601 */
602function required_param_array($parname, $type) {
603 if (func_num_args() != 2 or empty($parname) or empty($type)) {
604 throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
605 }
ac7af0da
SH
606 // POST has precedence.
607 if (isset($_POST[$parname])) {
2ca3bffa
PS
608 $param = $_POST[$parname];
609 } else if (isset($_GET[$parname])) {
610 $param = $_GET[$parname];
611 } else {
612 print_error('missingparam', '', '', $parname);
613 }
614 if (!is_array($param)) {
615 print_error('missingparam', '', '', $parname);
616 }
617
618 $result = array();
ac7af0da 619 foreach ($param as $key => $value) {
2ca3bffa
PS
620 if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
621 debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
622 continue;
623 }
ebdeccca 624 $result[$key] = clean_param($value, $type);
2ca3bffa
PS
625 }
626
627 return $result;
e0d346ff 628}
629
630/**
361855e6 631 * Returns a particular value for the named variable, taken from
e0d346ff 632 * POST or GET, otherwise returning a given default.
633 *
361855e6 634 * This function should be used to initialise all optional values
635 * in a script that are based on parameters. Usually it will be
e0d346ff 636 * used like this:
622365d2 637 * $name = optional_param('name', 'Fred', PARAM_TEXT);
e0d346ff 638 *
2ca3bffa 639 * Please note the $type parameter is now required and the value can not be array.
44913c8d 640 *
a083b93c 641 * @param string $parname the name of the page parameter we want
e0d346ff 642 * @param mixed $default the default value to return if nothing is found
44913c8d 643 * @param string $type expected type of parameter
e0d346ff 644 * @return mixed
ac7af0da 645 * @throws coding_exception
e0d346ff 646 */
44913c8d 647function optional_param($parname, $default, $type) {
2ca3bffa 648 if (func_num_args() != 3 or empty($parname) or empty($type)) {
ac7af0da 649 throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
44913c8d 650 }
44913c8d 651
ac7af0da
SH
652 // POST has precedence.
653 if (isset($_POST[$parname])) {
a083b93c 654 $param = $_POST[$parname];
655 } else if (isset($_GET[$parname])) {
656 $param = $_GET[$parname];
e0d346ff 657 } else {
658 return $default;
659 }
c7f4e3e2 660
2ca3bffa
PS
661 if (is_array($param)) {
662 debugging('Invalid array parameter detected in required_param(): '.$parname);
ac7af0da 663 // TODO: switch to $default in Moodle 2.3.
2ca3bffa
PS
664 return optional_param_array($parname, $default, $type);
665 }
666
a083b93c 667 return clean_param($param, $type);
e0d346ff 668}
669
2ca3bffa
PS
670/**
671 * Returns a particular array value for the named variable, taken from
672 * POST or GET, otherwise returning a given default.
673 *
674 * This function should be used to initialise all optional values
675 * in a script that are based on parameters. Usually it will be
676 * used like this:
677 * $ids = optional_param('id', array(), PARAM_INT);
678 *
ac7af0da 679 * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
2ca3bffa
PS
680 *
681 * @param string $parname the name of the page parameter we want
ac7af0da 682 * @param mixed $default the default value to return if nothing is found
2ca3bffa
PS
683 * @param string $type expected type of parameter
684 * @return array
ac7af0da 685 * @throws coding_exception
2ca3bffa
PS
686 */
687function optional_param_array($parname, $default, $type) {
688 if (func_num_args() != 3 or empty($parname) or empty($type)) {
ac7af0da 689 throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
2ca3bffa
PS
690 }
691
ac7af0da
SH
692 // POST has precedence.
693 if (isset($_POST[$parname])) {
2ca3bffa
PS
694 $param = $_POST[$parname];
695 } else if (isset($_GET[$parname])) {
696 $param = $_GET[$parname];
697 } else {
698 return $default;
699 }
700 if (!is_array($param)) {
701 debugging('optional_param_array() expects array parameters only: '.$parname);
702 return $default;
703 }
704
705 $result = array();
ac7af0da 706 foreach ($param as $key => $value) {
2ca3bffa
PS
707 if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
708 debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
709 continue;
710 }
ebdeccca 711 $result[$key] = clean_param($value, $type);
2ca3bffa
PS
712 }
713
714 return $result;
e0d346ff 715}
716
a3f7cbf6 717/**
718 * Strict validation of parameter values, the values are only converted
719 * to requested PHP type. Internally it is using clean_param, the values
720 * before and after cleaning must be equal - otherwise
721 * an invalid_parameter_exception is thrown.
efb8c375 722 * Objects and classes are not accepted.
a3f7cbf6 723 *
724 * @param mixed $param
2ca3bffa 725 * @param string $type PARAM_ constant
a3f7cbf6 726 * @param bool $allownull are nulls valid value?
727 * @param string $debuginfo optional debug information
fea52c11
PS
728 * @return mixed the $param value converted to PHP type
729 * @throws invalid_parameter_exception if $param is not of given type
a3f7cbf6 730 */
5a1861ee 731function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
a3f7cbf6 732 if (is_null($param)) {
5a1861ee 733 if ($allownull == NULL_ALLOWED) {
a3f7cbf6 734 return null;
735 } else {
736 throw new invalid_parameter_exception($debuginfo);
737 }
738 }
739 if (is_array($param) or is_object($param)) {
740 throw new invalid_parameter_exception($debuginfo);
741 }
742
743 $cleaned = clean_param($param, $type);
fea52c11
PS
744
745 if ($type == PARAM_FLOAT) {
746 // Do not detect precision loss here.
747 if (is_float($param) or is_int($param)) {
748 // These always fit.
749 } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
750 throw new invalid_parameter_exception($debuginfo);
751 }
752 } else if ((string)$param !== (string)$cleaned) {
ac7af0da 753 // Conversion to string is usually lossless.
a3f7cbf6 754 throw new invalid_parameter_exception($debuginfo);
755 }
756
757 return $cleaned;
758}
759
2ca3bffa 760/**
ac7af0da
SH
761 * Makes sure array contains only the allowed types, this function does not validate array key names!
762 *
2ca3bffa
PS
763 * <code>
764 * $options = clean_param($options, PARAM_INT);
765 * </code>
766 *
767 * @param array $param the variable array we are cleaning
768 * @param string $type expected format of param after cleaning.
769 * @param bool $recursive clean recursive arrays
770 * @return array
ac7af0da 771 * @throws coding_exception
2ca3bffa
PS
772 */
773function clean_param_array(array $param = null, $type, $recursive = false) {
ac7af0da
SH
774 // Convert null to empty array.
775 $param = (array)$param;
2ca3bffa
PS
776 foreach ($param as $key => $value) {
777 if (is_array($value)) {
778 if ($recursive) {
779 $param[$key] = clean_param_array($value, $type, true);
780 } else {
ac7af0da 781 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
2ca3bffa
PS
782 }
783 } else {
784 $param[$key] = clean_param($value, $type);
785 }
786 }
787 return $param;
788}
789
e0d346ff 790/**
361855e6 791 * Used by {@link optional_param()} and {@link required_param()} to
792 * clean the variables and/or cast to specific types, based on
e0d346ff 793 * an options field.
bbd3f2c4 794 * <code>
795 * $course->format = clean_param($course->format, PARAM_ALPHA);
ac7af0da 796 * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
bbd3f2c4 797 * </code>
e0d346ff 798 *
799 * @param mixed $param the variable we are cleaning
2ca3bffa 800 * @param string $type expected format of param after cleaning.
e0d346ff 801 * @return mixed
ac7af0da 802 * @throws coding_exception
e0d346ff 803 */
a083b93c 804function clean_param($param, $type) {
7744ea12 805 global $CFG;
c7f4e3e2 806
c16c1be7
PS
807 if (is_array($param)) {
808 throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
809 } else if (is_object($param)) {
810 if (method_exists($param, '__toString')) {
811 $param = $param->__toString();
812 } else {
813 throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
814 }
80bfd470 815 }
816
a083b93c 817 switch ($type) {
ac7af0da
SH
818 case PARAM_RAW:
819 // No cleaning at all.
78fcdb5f 820 $param = fix_utf8($param);
96e98ea6 821 return $param;
822
ac7af0da
SH
823 case PARAM_RAW_TRIMMED:
824 // No cleaning, but strip leading and trailing whitespace.
78fcdb5f 825 $param = fix_utf8($param);
652599ec
TH
826 return trim($param);
827
ac7af0da
SH
828 case PARAM_CLEAN:
829 // General HTML cleaning, try to use more specific type if possible this is deprecated!
830 // Please use more specific type instead.
a083b93c 831 if (is_numeric($param)) {
832 return $param;
833 }
78fcdb5f 834 $param = fix_utf8($param);
ac7af0da
SH
835 // Sweep for scripts, etc.
836 return clean_text($param);
3af57507 837
ac7af0da
SH
838 case PARAM_CLEANHTML:
839 // Clean html fragment.
78fcdb5f 840 $param = fix_utf8($param);
ac7af0da
SH
841 // Sweep for scripts, etc.
842 $param = clean_text($param, FORMAT_HTML);
a083b93c 843 return trim($param);
e0d346ff 844
a083b93c 845 case PARAM_INT:
ac7af0da
SH
846 // Convert to integer.
847 return (int)$param;
e0d346ff 848
6e73ae10 849 case PARAM_FLOAT:
ac7af0da
SH
850 // Convert to float.
851 return (float)$param;
9dae915a 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
SH
1629 *
1630 * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
ac7af0da 1631 * {@link phpunit_util::reset_dataroot()}
52642d0d 1632 *
f87eab7e
PS
1633 * @return void
1634 */
1635function purge_all_caches() {
d79d5ac2 1636 global $CFG, $DB;
f87eab7e 1637
f87eab7e
PS
1638 reset_text_filters_cache();
1639 js_reset_all_caches();
1640 theme_reset_all_caches();
1641 get_string_manager()->reset_caches();
2f1e464a 1642 core_text::reset_caches();
e87214bd
PS
1643 if (class_exists('core_plugin_manager')) {
1644 core_plugin_manager::reset_caches();
bde002b8 1645 }
f87eab7e 1646
299cfee5
MG
1647 // Bump up cacherev field for all courses.
1648 try {
1649 increment_revision_number('course', 'cacherev', '');
1650 } catch (moodle_exception $e) {
1651 // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1652 }
1653
d79d5ac2 1654 $DB->reset_caches();
d6a1f63b
SH
1655 cache_helper::purge_all();
1656
ac7af0da 1657 // Purge all other caches: rss, simplepie, etc.
54ced30d 1658 clearstatcache();
365bec4c 1659 remove_dir($CFG->cachedir.'', true);
f87eab7e 1660
ac7af0da 1661 // Make sure cache dir is writable, throws exception if not.
5a87c912 1662 make_cache_directory('');
f87eab7e 1663
85b38061
PS
1664 // This is the only place where we purge local caches, we are only adding files there.
1665 // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1666 remove_dir($CFG->localcachedir, true);
1667 set_config('localcachedirpurged', time());
1668 make_localcache_directory('', true);
309ae892 1669 \core\task\manager::clear_static_caches();
f87eab7e
PS
1670}
1671
bafd7e78 1672/**
1673 * Get volatile flags
1674 *
1675 * @param string $type
ac7af0da
SH
1676 * @param int $changedsince default null
1677 * @return array records array
bafd7e78 1678 */
ac7af0da 1679function get_cache_flags($type, $changedsince = null) {
ae040d4b 1680 global $DB;
bafd7e78 1681
ac7af0da 1682 $params = array('type' => $type, 'expiry' => time());
ae040d4b 1683 $sqlwhere = "flagtype = :type AND expiry >= :expiry";
ac7af0da 1684 if ($changedsince !== null) {
ae040d4b 1685 $params['changedsince'] = $changedsince;
1686 $sqlwhere .= " AND timemodified > :changedsince";
bafd7e78 1687 }
1688 $cf = array();
ae040d4b 1689 if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
bafd7e78 1690 foreach ($flags as $flag) {
1691 $cf[$flag->name] = $flag->value;
1692 }
1693 }
1694 return $cf;
1695}
1696
a489cf72 1697/**
1698 * Get volatile flags
1699 *
1700 * @param string $type
1701 * @param string $name
ac7af0da
SH
1702 * @param int $changedsince default null
1703 * @return string|false The cache flag value or false
a489cf72 1704 */
ac7af0da 1705function get_cache_flag($type, $name, $changedsince=null) {
ae040d4b 1706 global $DB;
a489cf72 1707
ac7af0da 1708 $params = array('type' => $type, 'name' => $name, 'expiry' => time());
a489cf72 1709
ae040d4b 1710 $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
ac7af0da 1711 if ($changedsince !== null) {
ae040d4b 1712 $params['changedsince'] = $changedsince;
1713 $sqlwhere .= " AND timemodified > :changedsince";
a489cf72 1714 }
ae040d4b 1715
1716 return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
a489cf72 1717}
bafd7e78 1718
1719/**
1720 * Set a volatile flag
1721 *
1722 * @param string $type the "type" namespace for the key
1723 * @param string $name the key to set
ac7af0da 1724 * @param string $value the value to set (without magic quotes) - null will remove the flag
bafd7e78 1725 * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
0d0a8bf6 1726 * @return bool Always returns true
bafd7e78 1727 */
ac7af0da 1728function set_cache_flag($type, $name, $value, $expiry = null) {
ae040d4b 1729 global $DB;
bafd7e78 1730
1731 $timemodified = time();
ac7af0da 1732 if ($expiry === null || $expiry < $timemodified) {
bafd7e78 1733 $expiry = $timemodified + 24 * 60 * 60;
1734 } else {
1735 $expiry = (int)$expiry;
1736 }
1737
ac7af0da
SH
1738 if ($value === null) {
1739 unset_cache_flag($type, $name);
013376de 1740 return true;
bafd7e78 1741 }
1742
ac7af0da
SH
1743 if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1744 // This is a potential problem in DEBUG_DEVELOPER.
128f0984 1745 if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
ac7af0da 1746 return true; // No need to update.
128f0984 1747 }
ae040d4b 1748 $f->value = $value;
bafd7e78 1749 $f->expiry = $expiry;
1750 $f->timemodified = $timemodified;
013376de 1751 $DB->update_record('cache_flags', $f);
bafd7e78 1752 } else {
365a5941 1753 $f = new stdClass();
bafd7e78 1754 $f->flagtype = $type;
1755 $f->name = $name;
ae040d4b 1756 $f->value = $value;
bafd7e78 1757 $f->expiry = $expiry;
1758 $f->timemodified = $timemodified;
013376de 1759 $DB->insert_record('cache_flags', $f);
bafd7e78 1760 }
013376de 1761 return true;
bafd7e78 1762}
1763
1764/**
1765 * Removes a single volatile flag
1766 *
1767 * @param string $type the "type" namespace for the key
1768 * @param string $name the key to set
bafd7e78 1769 * @return bool
1770 */
1771function unset_cache_flag($type, $name) {
ae040d4b 1772 global $DB;
ac7af0da 1773 $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
013376de 1774 return true;
bafd7e78 1775}
1776
1777/**
1778 * Garbage-collect volatile flags
1779 *
0d0a8bf6 1780 * @return bool Always returns true
bafd7e78 1781 */
1782function gc_cache_flags() {
ae040d4b 1783 global $DB;
013376de 1784 $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1785 return true;
bafd7e78 1786}
a4080313 1787
ac7af0da 1788// USER PREFERENCE API.
2660377f 1789
7cf1c7bd 1790/**
39461de3
PS
1791 * Refresh user preference cache. This is used most often for $USER
1792 * object that is stored in session, but it also helps with performance in cron script.
0d0a8bf6 1793 *
39461de3
PS
1794 * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1795 *
4d6b40a0
GGC
1796 * @package core
1797 * @category preference
1798 * @access public
1799 * @param stdClass $user User object. Preferences are preloaded into 'preference' property
1800 * @param int $cachelifetime Cache life time on the current page (in seconds)
1801 * @throws coding_exception
1802 * @return null
7cf1c7bd 1803 */
39461de3
PS
1804function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1805 global $DB;
ac7af0da
SH
1806 // Static cache, we need to check on each page load, not only every 2 minutes.
1807 static $loadedusers = array();
2660377f 1808
39461de3
PS
1809 if (!isset($user->id)) {
1810 throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1811 }
2660377f 1812
39461de3 1813 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1814 // No permanent storage for not-logged-in users and guest.
39461de3
PS
1815 if (!isset($user->preference)) {
1816 $user->preference = array();
2660377f 1817 }
39461de3 1818 return;
2660377f 1819 }
70812e39 1820
39461de3 1821 $timenow = time();
070e2616 1822
39461de3
PS
1823 if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1824 // Already loaded at least once on this page. Are we up to date?
1825 if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
ac7af0da 1826 // No need to reload - we are on the same page and we loaded prefs just a moment ago.
39461de3 1827 return;
70812e39 1828
39461de3 1829 } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
ac7af0da 1830 // No change since the lastcheck on this page.
39461de3
PS
1831 $user->preference['_lastloaded'] = $timenow;
1832 return;
70812e39 1833 }
c6d15803 1834 }
346c3e2f 1835
ac7af0da 1836 // OK, so we have to reload all preferences.
39461de3 1837 $loadedusers[$user->id] = true;
ac7af0da 1838 $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
39461de3 1839 $user->preference['_lastloaded'] = $timenow;
2660377f 1840}
1841
1842/**
ac7af0da 1843 * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
39461de3
PS
1844 *
1845 * NOTE: internal function, do not call from other code.
0d0a8bf6 1846 *
4d6b40a0 1847 * @package core
ac7af0da
SH
1848 * @access private
1849 * @param integer $userid the user whose prefs were changed.
2660377f 1850 */
1851function mark_user_preferences_changed($userid) {
39461de3
PS
1852 global $CFG;
1853
1854 if (empty($userid) or isguestuser($userid)) {
ac7af0da 1855 // No cache flags for guest and not-logged-in users.
39461de3 1856 return;
2660377f 1857 }
39461de3 1858
2660377f 1859 set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
70812e39 1860}
1861
7cf1c7bd 1862/**
39461de3 1863 * Sets a preference for the specified user.
0d0a8bf6 1864 *
4d6b40a0 1865 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
0d0a8bf6 1866 *
6e65554e
MG
1867 * When additional validation/permission check is needed it is better to use {@see useredit_update_user_preference()}
1868 *
4d6b40a0
GGC
1869 * @package core
1870 * @category preference
1871 * @access public
1872 * @param string $name The key to set as preference for the specified user
1873 * @param string $value The value to set for the $name key in the specified user's
1874 * record, null means delete current value.
1875 * @param stdClass|int|null $user A moodle user object or id, null means current user
1876 * @throws coding_exception
1877 * @return bool Always true or exception
7cf1c7bd 1878 */
39461de3 1879function set_user_preference($name, $value, $user = null) {
ae040d4b 1880 global $USER, $DB;
70812e39 1881
39461de3
PS
1882 if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1883 throw new coding_exception('Invalid preference name in set_user_preference() call');
70812e39 1884 }
1885
39461de3 1886 if (is_null($value)) {
ac7af0da 1887 // Null means delete current.
39461de3
PS
1888 return unset_user_preference($name, $user);
1889 } else if (is_object($value)) {
1890 throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1891 } else if (is_array($value)) {
1892 throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1893 }
ac7af0da 1894 // Value column maximum length is 1333 characters.
39461de3 1895 $value = (string)$value;
2f1e464a 1896 if (core_text::strlen($value) > 1333) {
8e54ce97
AD
1897 throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1898 }
39461de3
PS
1899
1900 if (is_null($user)) {
1901 $user = $USER;
1902 } else if (isset($user->id)) {
ac7af0da 1903 // It is a valid object.
39461de3 1904 } else if (is_numeric($user)) {
ac7af0da 1905 $user = (object)array('id' => (int)$user);
346c3e2f 1906 } else {
39461de3 1907 throw new coding_exception('Invalid $user parameter in set_user_preference() call');
346c3e2f 1908 }
1909
39461de3
PS
1910 check_user_preferences_loaded($user);
1911
1912 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1913 // No permanent storage for not-logged-in users and guest.
39461de3
PS
1914 $user->preference[$name] = $value;
1915 return true;
1916 }
346c3e2f 1917
ac7af0da 1918 if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
39461de3 1919 if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
ac7af0da 1920 // Preference already set to this value.
a1244706 1921 return true;
1922 }
ac7af0da 1923 $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
70812e39 1924
1925 } else {
365a5941 1926 $preference = new stdClass();
39461de3 1927 $preference->userid = $user->id;
ae040d4b 1928 $preference->name = $name;
39461de3 1929 $preference->value = $value;
013376de 1930 $DB->insert_record('user_preferences', $preference);
2660377f 1931 }
1932
ac7af0da 1933 // Update value in cache.
39461de3 1934 $user->preference[$name] = $value;
4ba4ecfa 1935 // Update the $USER in case where we've not a direct reference to $USER.
2524990d
TH
1936 if ($user !== $USER && $user->id == $USER->id) {
1937 $USER->preference[$name] = $value;
1938 }
39461de3 1939
ac7af0da 1940 // Set reload flag for other sessions.
39461de3 1941 mark_user_preferences_changed($user->id);
346c3e2f 1942
013376de 1943 return true;
2660377f 1944}
1945
1946/**
1947 * Sets a whole array of preferences for the current user
0d0a8bf6 1948 *
4d6b40a0 1949 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
39461de3 1950 *
4d6b40a0
GGC
1951 * @package core
1952 * @category preference
1953 * @access public
1954 * @param array $prefarray An array of key/value pairs to be set
1955 * @param stdClass|int|null $user A moodle user object or id, null means current user
1956 * @return bool Always true or exception
2660377f 1957 */
39461de3 1958function set_user_preferences(array $prefarray, $user = null) {
2660377f 1959 foreach ($prefarray as $name => $value) {
39461de3 1960 set_user_preference($name, $value, $user);
2660377f 1961 }
013376de 1962 return true;
70812e39 1963}
1964
6eb3e776 1965/**
1966 * Unsets a preference completely by deleting it from the database
0d0a8bf6 1967 *
4d6b40a0 1968 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
0d0a8bf6 1969 *
4d6b40a0
GGC
1970 * @package core
1971 * @category preference
1972 * @access public
1973 * @param string $name The key to unset as preference for the specified user
1974 * @param stdClass|int|null $user A moodle user object or id, null means current user
1975 * @throws coding_exception
1976 * @return bool Always true or exception
6eb3e776 1977 */
39461de3 1978function unset_user_preference($name, $user = null) {
ae040d4b 1979 global $USER, $DB;
6eb3e776 1980
39461de3
PS
1981 if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1982 throw new coding_exception('Invalid preference name in unset_user_preference() call');
1983 }
1984
1985 if (is_null($user)) {
1986 $user = $USER;
1987 } else if (isset($user->id)) {
ac7af0da 1988 // It is a valid object.
39461de3 1989 } else if (is_numeric($user)) {
ac7af0da 1990 $user = (object)array('id' => (int)$user);
346c3e2f 1991 } else {
39461de3 1992 throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
346c3e2f 1993 }
1994
39461de3 1995 check_user_preferences_loaded($user);
013376de 1996
39461de3 1997 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1998 // No permanent storage for not-logged-in user and guest.
39461de3
PS
1999 unset($user->preference[$name]);
2000 return true;
70812e39 2001 }
2002
ac7af0da
SH
2003 // Delete from DB.
2004 $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
39461de3 2005
ac7af0da 2006 // Delete the preference from cache.
39461de3 2007 unset($user->preference[$name]);
4ba4ecfa 2008 // Update the $USER in case where we've not a direct reference to $USER.
2524990d
TH
2009 if ($user !== $USER && $user->id == $USER->id) {
2010 unset($USER->preference[$name]);
2011 }
39461de3 2012
ac7af0da 2013 // Set reload flag for other sessions.
39461de3
PS
2014 mark_user_preferences_changed($user->id);
2015
013376de 2016 return true;
70812e39 2017}
2018
7cf1c7bd 2019/**
0d0a8bf6 2020 * Used to fetch user preference(s)
2021 *
7cf1c7bd 2022 * If no arguments are supplied this function will return
361855e6 2023 * all of the current user preferences as an array.
0d0a8bf6 2024 *
7cf1c7bd 2025 * If a name is specified then this function
2026 * attempts to return that particular preference value. If
2027 * none is found, then the optional value $default is returned,
ac7af0da 2028 * otherwise null.
0d0a8bf6 2029 *
4d6b40a0 2030 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
39461de3 2031 *
4d6b40a0
GGC
2032 * @package core
2033 * @category preference
2034 * @access public
2035 * @param string $name Name of the key to use in finding a preference value
2036 * @param mixed|null $default Value to be returned if the $name key is not set in the user preferences
2037 * @param stdClass|int|null $user A moodle user object or id, null means current user
2038 * @throws coding_exception
2039 * @return string|mixed|null A string containing the value of a single preference. An
2040 * array with all of the preferences or null
7cf1c7bd 2041 */
39461de3
PS
2042function get_user_preferences($name = null, $default = null, $user = null) {
2043 global $USER;
70812e39 2044
39461de3 2045 if (is_null($name)) {
ac7af0da 2046 // All prefs.
39461de3
PS
2047 } else if (is_numeric($name) or $name === '_lastloaded') {
2048 throw new coding_exception('Invalid preference name in get_user_preferences() call');
2049 }
346c3e2f 2050
39461de3
PS
2051 if (is_null($user)) {
2052 $user = $USER;
2053 } else if (isset($user->id)) {
ac7af0da 2054 // Is a valid object.
39461de3 2055 } else if (is_numeric($user)) {
ac7af0da 2056 $user = (object)array('id' => (int)$user);
39461de3
PS
2057 } else {
2058 throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2059 }
2060
2061 check_user_preferences_loaded($user);
346c3e2f 2062
39461de3 2063 if (empty($name)) {
ac7af0da
SH
2064 // All values.
2065 return $user->preference;
39461de3 2066 } else if (isset($user->preference[$name])) {
ac7af0da
SH
2067 // The single string value.
2068 return $user->preference[$name];
346c3e2f 2069 } else {
ac7af0da
SH
2070 // Default value (null if not specified).
2071 return $default;
70812e39 2072 }
70812e39 2073}
2074
ac7af0da 2075// FUNCTIONS FOR HANDLING TIME.
39917a09 2076
7cf1c7bd 2077/**
e83bcc10 2078 * Given Gregorian date parts in user time produce a GMT timestamp.
7cf1c7bd 2079 *
9df12115
RT
2080 * @package core
2081 * @category time
68fbd8e1 2082 * @param int $year The year part to create timestamp of
2083 * @param int $month The month part to create timestamp of
2084 * @param int $day The day part to create timestamp of
2085 * @param int $hour The hour part to create timestamp of
2086 * @param int $minute The minute part to create timestamp of
2087 * @param int $second The second part to create timestamp of
9df12115
RT
2088 * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2089 * if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
6a0bf5c4
RT
2090 * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2091 * applied only if timezone is 99 or string.
9df12115 2092 * @return int GMT timestamp
7cf1c7bd 2093 */
9f1f6daf 2094function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
d6e7a63d
PS
2095 $date = new DateTime('now', core_date::get_user_timezone_object($timezone));
2096 $date->setDate((int)$year, (int)$month, (int)$day);
2097 $date->setTime((int)$hour, (int)$minute, (int)$second);
39917a09 2098
d6e7a63d 2099 $time = $date->getTimestamp();
33998d30 2100
9f2b916d
RT
2101 if ($time === false) {
2102 throw new coding_exception('getTimestamp() returned false, please ensure you have passed correct values.'.
2103 ' This can fail if year is more than 2038 and OS is 32 bit windows');
2104 }
2105
d6e7a63d
PS
2106 // Moodle BC DST stuff.
2107 if (!$applydst) {
2108 $time += dst_offset_on($time, $timezone);
9f1f6daf 2109 }
2110
196f2619 2111 return $time;
85cafb3e 2112
39917a09 2113}
2114
7cf1c7bd 2115/**
0d0a8bf6 2116 * Format a date/time (seconds) as weeks, days, hours etc as needed
2117 *
7cf1c7bd 2118 * Given an amount of time in seconds, returns string
8c42eef3 2119 * formatted nicely as years, days, hours etc as needed
7cf1c7bd 2120 *
9df12115
RT
2121 * @package core
2122 * @category time
2f87145b 2123 * @uses MINSECS
2124 * @uses HOURSECS
2125 * @uses DAYSECS
5602f7cf 2126 * @uses YEARSECS
0d0a8bf6 2127 * @param int $totalsecs Time in seconds
ac7af0da 2128 * @param stdClass $str Should be a time object
0d0a8bf6 2129 * @return string A nicely formatted date/time string
7cf1c7bd 2130 */
ac7af0da 2131function format_time($totalsecs, $str = null) {
c7e3ac2a 2132
6b174680 2133 $totalsecs = abs($totalsecs);
c7e3ac2a 2134
ac7af0da
SH
2135 if (!$str) {
2136 // Create the str structure the slow way.
b85b25eb 2137 $str = new stdClass();
b0ccd3fb 2138 $str->day = get_string('day');
2139 $str->days = get_string('days');
2140 $str->hour = get_string('hour');
2141 $str->hours = get_string('hours');
2142 $str->min = get_string('min');
2143 $str->mins = get_string('mins');
2144 $str->sec = get_string('sec');
2145 $str->secs = get_string('secs');
5602f7cf 2146 $str->year = get_string('year');
2147 $str->years = get_string('years');
8dbed6be 2148 }
2149
5602f7cf 2150 $years = floor($totalsecs/YEARSECS);
2151 $remainder = $totalsecs - ($years*YEARSECS);
5602f7cf 2152 $days = floor($remainder/DAYSECS);
7a5672c9 2153 $remainder = $totalsecs - ($days*DAYSECS);
2154 $hours = floor($remainder/HOURSECS);
2155 $remainder = $remainder - ($hours*HOURSECS);
2156 $mins = floor($remainder/MINSECS);
2157 $secs = $remainder - ($mins*MINSECS);
8dbed6be 2158
2159 $ss = ($secs == 1) ? $str->sec : $str->secs;
2160 $sm = ($mins == 1) ? $str->min : $str->mins;
2161 $sh = ($hours == 1) ? $str->hour : $str->hours;
2162 $sd = ($days == 1) ? $str->day : $str->days;
5602f7cf 2163 $sy = ($years == 1) ? $str->year : $str->years;
8dbed6be 2164
5602f7cf 2165 $oyears = '';
b0ccd3fb 2166 $odays = '';
2167 $ohours = '';
2168 $omins = '';
2169 $osecs = '';
9c9f7d77 2170
ac7af0da
SH
2171 if ($years) {
2172 $oyears = $years .' '. $sy;
2173 }
2174 if ($days) {
2175 $odays = $days .' '. $sd;
2176 }
2177 if ($hours) {
2178 $ohours = $hours .' '. $sh;
2179 }
2180 if ($mins) {
2181 $omins = $mins .' '. $sm;
2182 }
2183 if ($secs) {
2184 $osecs = $secs .' '. $ss;
2185 }
2186
2187 if ($years) {
2188 return trim($oyears .' '. $odays);
2189 }
2190 if ($days) {
2191 return trim($odays .' '. $ohours);
2192 }
2193 if ($hours) {
2194 return trim($ohours .' '. $omins);
2195 }
2196 if ($mins) {
2197 return trim($omins .' '. $osecs);
2198 }
2199 if ($secs) {
2200 return $osecs;
2201 }
b0ccd3fb 2202 return get_string('now');
6b174680 2203}
f9903ed0 2204
7cf1c7bd 2205/**
f59ab4ad 2206 * Returns a formatted string that represents a date in user time.
7cf1c7bd 2207 *
9df12115
RT
2208 * @package core
2209 * @category time
0a0cf09a 2210 * @param int $date the timestamp in UTC, as obtained from the database.
2211 * @param string $format strftime format. You should probably get this using
9df12115 2212 * get_string('strftime...', 'langconfig');
f59ab4ad 2213 * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
9df12115
RT
2214 * not 99 then daylight saving will not be added.
2215 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
0a0cf09a 2216 * @param bool $fixday If true (default) then the leading zero from %d is removed.
9df12115 2217 * If false then the leading zero is maintained.
d9498b38 2218 * @param bool $fixhour If true (default) then the leading zero from %I is removed.
0a0cf09a 2219 * @return string the formatted date/time.
7cf1c7bd 2220 */
d9498b38 2221function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
6eafa4dd 2222 $calendartype = \core_calendar\type_factory::get_calendar_instance();
f59ab4ad 2223 return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
873960de 2224}
2225
15396bba
FM
2226/**
2227 * Returns a formatted date ensuring it is UTF-8.
2228 *
2229 * If we are running under Windows convert to Windows encoding and then back to UTF-8
2230 * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2231 *
d6e7a63d 2232 * @param int $date the timestamp - since Moodle 2.9 this is a real UTC timestamp
15396bba 2233 * @param string $format strftime format.
d6e7a63d 2234 * @param int|float|string $tz the user timezone
15396bba 2235 * @return string the formatted date/time.
5bcfd504 2236 * @since Moodle 2.3.3
15396bba
FM
2237 */
2238function date_format_string($date, $format, $tz = 99) {
2239 global $CFG;
d61d3e82
RT
2240
2241 $localewincharset = null;
2242 // Get the calendar type user is using.
2243 if ($CFG->ostype == 'WINDOWS') {
2244 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2245 $localewincharset = $calendartype->locale_win_charset();
2246 }
2247
d6e7a63d
PS
2248 if ($localewincharset) {
2249 $format = core_text::convert($format, 'utf-8', $localewincharset);
2250 }
2251
2252 date_default_timezone_set(core_date::get_user_timezone($tz));
2253 $datestring = strftime($format, $date);
2254 core_date::set_default_server_timezone();
2255
2256 if ($localewincharset) {
2257 $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
15396bba 2258 }
d6e7a63d 2259
15396bba
FM
2260 return $datestring;
2261}
2262
7cf1c7bd 2263/**
deed22ea 2264 * Given a $time timestamp in GMT (seconds since epoch),
40a6393e 2265 * returns an array that represents the Gregorian date in user time
7cf1c7bd 2266 *
9df12115
RT
2267 * @package core
2268 * @category time
deed22ea 2269 * @param int $time Timestamp in GMT
d6e7a63d 2270 * @param float|int|string $timezone user timezone
deed22ea 2271 * @return array An array that represents the date in user time
7cf1c7bd 2272 */
deed22ea 2273function usergetdate($time, $timezone=99) {
d6e7a63d
PS
2274 date_default_timezone_set(core_date::get_user_timezone($timezone));
2275 $result = getdate($time);
2276 core_date::set_default_server_timezone();
deed22ea 2277
d6e7a63d 2278 return $result;
d552ead0 2279}
2280
7cf1c7bd 2281/**
2282 * Given a GMT timestamp (seconds since epoch), offsets it by
2283 * the timezone. eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2284 *
d6e7a63d
PS
2285 * NOTE: this function does not include DST properly,
2286 * you should use the PHP date stuff instead!
2287 *
9df12115
RT
2288 * @package core
2289 * @category time
9df12115 2290 * @param int $date Timestamp in GMT
d6e7a63d 2291 * @param float|int|string $timezone user timezone
c6d15803 2292 * @return int
7cf1c7bd 2293 */
d552ead0 2294function usertime($date, $timezone=99) {
d6e7a63d
PS
2295 $userdate = new DateTime('@' . $date);
2296 $userdate->setTimezone(core_date::get_user_timezone_object($timezone));
2297 $dst = dst_offset_on($date, $timezone);
a36166d3 2298
d6e7a63d 2299 return $date - $userdate->getOffset() + $dst;
d552ead0 2300}
2301
8c3dba73 2302/**
2303 * Given a time, return the GMT timestamp of the most recent midnight
2304 * for the current user.
2305 *
9df12115
RT
2306 * @package core
2307 * @category time
e34d817e 2308 * @param int $date Timestamp in GMT
d6e7a63d 2309 * @param float|int|string $timezone user timezone
0d0a8bf6 2310 * @return int Returns a GMT timestamp
8c3dba73 2311 */
edf7fe8c 2312function usergetmidnight($date, $timezone=99) {
edf7fe8c 2313
edf7fe8c 2314 $userdate = usergetdate($date, $timezone);
4606d9bb 2315
ac7af0da 2316 // Time of midnight of this user's day, in GMT.
02f0527d 2317 return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
edf7fe8c 2318
2319}
2320
7cf1c7bd 2321/**
2322 * Returns a string that prints the user's timezone
2323 *
9df12115
RT
2324 * @package core
2325 * @category time
d6e7a63d 2326 * @param float|int|string $timezone user timezone
7cf1c7bd 2327 * @return string
2328 */
d552ead0 2329function usertimezone($timezone=99) {
d6e7a63d
PS
2330 $tz = core_date::get_user_timezone($timezone);
2331 return core_date::get_localised_timezone($tz);
61460dd6 2332}
2333
bbd3f2c4 2334/**
b2b68362 2335 * Returns a float or a string which denotes the user's timezone
2336 * 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)
2337 * means that for this timezone there are also DST rules to be taken into account
2338 * Checks various settings and picks the most dominant of those which have a value
bbd3f2c4 2339 *
9df12115
RT
2340 * @package core
2341 * @category time
2342 * @param float|int|string $tz timezone to calculate GMT time offset before
2343 * calculating user timezone, 99 is default user timezone
2344 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
2345 * @return float|string
bbd3f2c4 2346 */
e8904995 2347function get_user_timezone($tz = 99) {
2348 global $USER, $CFG;
43b59916 2349
f30fe8d0 2350 $timezones = array(
e8904995 2351 $tz,
2352 isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
43b59916 2353 isset($USER->timezone) ? $USER->timezone : 99,
2354 isset($CFG->timezone) ? $CFG->timezone : 99,
f30fe8d0 2355 );
43b59916 2356
e8904995 2357 $tz = 99;
43b59916 2358
ac7af0da 2359 // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
33683bc8
MG
2360 foreach ($timezones as $nextvalue) {
2361 if ((empty($tz) && !is_numeric($tz)) || $tz == 99) {
2362 $tz = $nextvalue;
2363 }
43b59916 2364 }
e8904995 2365 return is_numeric($tz) ? (float) $tz : $tz;
43b59916 2366}
2367
0d0a8bf6 2368/**
efb8c375 2369 * Calculates the Daylight Saving Offset for a given date/time (timestamp)
6a0bf5c4 2370 * - Note: Daylight saving only works for string timezones and not for float.
0d0a8bf6 2371 *
9df12115
RT
2372 * @package core
2373 * @category time
0d0a8bf6 2374 * @param int $time must NOT be compensated at all, it has to be a pure timestamp
d6e7a63d 2375 * @param int|float|string $strtimezone user timezone
0d0a8bf6 2376 * @return int
2377 */
ac7af0da 2378function dst_offset_on($time, $strtimezone = null) {
d6e7a63d
PS
2379 $tz = core_date::get_user_timezone($strtimezone);
2380 $date = new DateTime('@' . $time);
2381 $date->setTimezone(new DateTimeZone($tz));
2382 if ($date->format('I') == '1') {
2383 if ($tz === 'Australia/Lord_Howe') {
2384 return 1800;
c9e72798 2385 }
d6e7a63d 2386 return 3600;
c9e72798 2387 }
d6e7a63d 2388 return 0;
85cafb3e 2389}
02f0527d 2390
0d0a8bf6 2391/**
9df12115 2392 * Calculates when the day appears in specific month
0d0a8bf6 2393 *
9df12115
RT
2394 * @package core
2395 * @category time
2396 * @param int $startday starting day of the month
2397 * @param int $weekday The day when week starts (normally taken from user preferences)
2398 * @param int $month The month whose day is sought
2399 * @param int $year The year of the month whose day is sought
0d0a8bf6 2400 * @return int
2401 */
28902d99 2402function find_day_in_month($startday, $weekday, $month, $year) {
da304137 2403 $calendartype = \core_calendar\type_factory::get_calendar_instance();
8dc3f6cf 2404
2405 $daysinmonth = days_in_month($month, $year);
da304137 2406 $daysinweek = count($calendartype->get_weekdays());
8dc3f6cf 2407
ac7af0da 2408 if ($weekday == -1) {
28902d99 2409 // Don't care about weekday, so return:
2410 // abs($startday) if $startday != -1
ac7af0da 2411 // $daysinmonth otherwise.
28902d99 2412 return ($startday == -1) ? $daysinmonth : abs($startday);
8dc3f6cf 2413 }
2414
ac7af0da 2415 // From now on we 're looking for a specific weekday.
ac7af0da
SH
2416 // Give "end of month" its actual value, since we know it.
2417 if ($startday == -1) {
28902d99 2418 $startday = -1 * $daysinmonth;
2419 }
2420
ac7af0da 2421 // Starting from day $startday, the sign is the direction.
ac7af0da 2422 if ($startday < 1) {
28902d99 2423 $startday = abs($startday);
da304137 2424 $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
8dc3f6cf 2425
ac7af0da 2426 // This is the last such weekday of the month.
8dc3f6cf 2427 $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
ac7af0da 2428 if ($lastinmonth > $daysinmonth) {
da304137 2429 $lastinmonth -= $daysinweek;
42d36497 2430 }
8dc3f6cf 2431
ac7af0da
SH
2432 // Find the first such weekday <= $startday.
2433 while ($lastinmonth > $startday) {
da304137 2434 $lastinmonth -= $daysinweek;
42d36497 2435 }
8dc3f6cf 2436
2437 return $lastinmonth;
ac7af0da 2438 } else {
da304137 2439 $indexweekday = dayofweek($startday, $month, $year);
42d36497 2440
8dc3f6cf 2441 $diff = $weekday - $indexweekday;
ac7af0da 2442 if ($diff < 0) {
da304137 2443 $diff += $daysinweek;
42d36497 2444 }
42d36497 2445
ac7af0da 2446 // This is the first such weekday of the month equal to or after $startday.
28902d99 2447 $firstfromindex = $startday + $diff;
42d36497 2448
8dc3f6cf 2449 return $firstfromindex;
8dc3f6cf 2450 }
42d36497 2451}
2452
bbd3f2c4 2453/**
2454 * Calculate the number of days in a given month
2455 *
9df12115
RT
2456 * @package core
2457 * @category time
bbd3f2c4 2458 * @param int $month The month whose day count is sought
2459 * @param int $year The year of the month whose day count is sought
2460 * @return int
2461 */
42d36497 2462function days_in_month($month, $year) {
da304137
MN
2463 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2464 return $calendartype->get_num_days_in_month($year, $month);
42d36497 2465}
2466
bbd3f2c4 2467/**
2468 * Calculate the position in the week of a specific calendar day
2469 *
9df12115
RT
2470 * @package core
2471 * @category time
bbd3f2c4 2472 * @param int $day The day of the date whose position in the week is sought
2473 * @param int $month The month of the date whose position in the week is sought
2474 * @param int $year The year of the date whose position in the week is sought
2475 * @return int
2476 */
8dc3f6cf 2477function dayofweek($day, $month, $year) {
da304137
MN
2478 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2479 return $calendartype->get_weekday($year, $month, $day);
8dc3f6cf 2480}
2481
ac7af0da 2482// USER AUTHENTICATION AND LOGIN.
f9903ed0 2483
93f66983 2484/**
2485 * Returns full login url.
2486 *
93f66983 2487 * @return string login url
2488 */
999b54af 2489function get_login_url() {
93f66983 2490 global $CFG;
2491
b58764ff 2492 return "$CFG->wwwroot/login/index.php";
93f66983 2493}
2494
7cf1c7bd 2495/**
ec81373f 2496 * This function checks that the current user is logged in and has the
2497 * required privileges
2498 *
7cf1c7bd 2499 * This function checks that the current user is logged in, and optionally
ec81373f 2500 * whether they are allowed to be in a particular course and view a particular
2501 * course module.
2502 * If they are not logged in, then it redirects them to the site login unless
d2a9f7cc 2503 * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
ec81373f 2504 * case they are automatically logged in as guests.
2505 * If $courseid is given and the user is not enrolled in that course then the
2506 * user is redirected to the course enrolment page.
efb8c375 2507 * If $cm is given and the course module is hidden and the user is not a teacher
ec81373f 2508 * in the course then the user is redirected to the course home page.
7cf1c7bd 2509 *
191b267b 2510 * When $cm parameter specified, this function sets page layout to 'module'.
4f0c2d00 2511 * You need to change it manually later if some other layout needed.
191b267b 2512 *
f76249cc
PS
2513 * @package core_access
2514 * @category access
2515 *
33ebaf7c 2516 * @param mixed $courseorid id of the course or course object
0d0a8bf6 2517 * @param bool $autologinguest default true
bbd3f2c4 2518 * @param object $cm course module object
f4013c10 2519 * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2520 * true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2521 * in order to keep redirects working properly. MDL-14495
df997f84 2522 * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
0d0a8bf6 2523 * @return mixed Void, exit, and die depending on path
ac7af0da
SH
2524 * @throws coding_exception
2525 * @throws require_login_exception
a428cf4a 2526 * @throws moodle_exception
7cf1c7bd 2527 */
ac7af0da 2528function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
f0202ae9 2529 global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
d8ba183c 2530
f22f1caf
PS
2531 // Must not redirect when byteserving already started.
2532 if (!empty($_SERVER['HTTP_RANGE'])) {
2533 $preventredirect = true;
2534 }
2535
2ed6be87
AN
2536 if (AJAX_SCRIPT) {
2537 // We cannot redirect for AJAX scripts either.
2538 $preventredirect = true;
2539 }
2540
ac7af0da 2541 // Setup global $COURSE, themes, language and locale.
c13a5e71 2542 if (!empty($courseorid)) {
2543 if (is_object($courseorid)) {
2544 $course = $courseorid;
2545 } else if ($courseorid == SITEID) {
2546 $course = clone($SITE);
2547 } else {
74df2951 2548 $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
c13a5e71 2549 }
95d28870 2550 if ($cm) {
df997f84
PS
2551 if ($cm->course != $course->id) {
2552 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2553 }
ac7af0da 2554 // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
47148151 2555 if (!($cm instanceof cm_info)) {
ac7af0da 2556 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
0d8b6a69 2557 // db queries so this is not really a performance concern, however it is obviously
2558 // better if you use get_fast_modinfo to get the cm before calling this.
2559 $modinfo = get_fast_modinfo($course);
2560 $cm = $modinfo->get_cm($cm->id);
2561 }
95d28870 2562 }
e88462a0 2563 } else {
ac7af0da 2564 // Do not touch global $COURSE via $PAGE->set_course(),
df997f84
PS
2565 // the reasons is we need to be able to call require_login() at any time!!
2566 $course = $SITE;
2567 if ($cm) {
2568 throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2569 }
c13a5e71 2570 }
be933850 2571
aa4a6566
SH
2572 // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2573 // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2574 // risk leading the user back to the AJAX request URL.
2575 if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2576 $setwantsurltome = false;
2577 }
2578
12fc11e7 2579 // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2ed6be87
AN
2580 if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !empty($CFG->dbsessions)) {
2581 if ($preventredirect) {
2582 throw new require_login_session_timeout_exception();
2583 } else {
2584 if ($setwantsurltome) {
2585 $SESSION->wantsurl = qualified_me();
2586 }
2587 redirect(get_login_url());
12fc11e7 2588 }
12fc11e7
DM
2589 }
2590
ac7af0da 2591 // If the user is not even logged in yet then make sure they are.
083c3743 2592 if (!isloggedin()) {
df997f84 2593 if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
999b54af 2594 if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
ac7af0da 2595 // Misconfigured site guest, just redirect to login page.
999b54af 2596 redirect(get_login_url());
ac7af0da 2597 exit; // Never reached.
df997f84 2598 }
999b54af 2599 $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
0342fc36 2600 complete_user_login($guest);
d9e07264 2601 $USER->autologinguest = true;
999b54af 2602 $SESSION->lang = $lang;
8a33e371 2603 } else {
ac7af0da 2604 // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
999b54af
PS
2605 if ($preventredirect) {
2606 throw new require_login_exception('You are not logged in');
2607 }
2608
2609 if ($setwantsurltome) {
f0202ae9 2610 $SESSION->wantsurl = qualified_me();
999b54af 2611 }
dcee0b94
SL
2612
2613 $referer = get_local_referer(false);
2614 if (!empty($referer)) {
2615 $SESSION->fromurl = $referer;
999b54af 2616 }
bf08e3f9
BH
2617
2618 // Give auth plugins an opportunity to authenticate or redirect to an external login page
2619 $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
2620 foreach($authsequence as $authname) {
2621 $authplugin = get_auth_plugin($authname);
2622 $authplugin->pre_loginpage_hook();
2623 if (isloggedin()) {
2624 break;
2625 }
2626 }
2627
2628 // If we're still not logged in then go to the login page
2629 if (!isloggedin()) {
2630 redirect(get_login_url());
2631 exit; // Never reached.
2632 }
8a33e371 2633 }
f9903ed0 2634 }
808a3baa 2635
ac7af0da 2636 // Loginas as redirection if needed.
d79d5ac2 2637 if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
f6f66b03 2638 if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
df997f84 2639 if ($USER->loginascontext->instanceid != $course->id) {
3887fe4a 2640 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
5e623a33 2641 }
f6f66b03 2642 }
2643 }
2644
ac7af0da 2645 // Check whether the user should be changing password (but only if it is REALLY them).
d79d5ac2 2646 if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
21e2dcd9 2647 $userauth = get_auth_plugin($USER->auth);
df997f84 2648 if ($userauth->can_change_password() and !$preventredirect) {
af572078 2649 if ($setwantsurltome) {
f0202ae9 2650 $SESSION->wantsurl = qualified_me();
af572078 2651 }
80274abf 2652 if ($changeurl = $userauth->change_password_url()) {
ac7af0da 2653 // Use plugin custom url.
80274abf 2654 redirect($changeurl);
1437f0a5 2655 } else {
ac7af0da 2656 // Use moodle internal method.
b58764ff 2657 redirect($CFG->wwwroot .'/login/change_password.php');
1437f0a5 2658 }
80e0f0b8
JL
2659 } else if ($userauth->can_change_password()) {
2660 throw new moodle_exception('forcepasswordchangenotice');
d35757eb 2661 } else {
80e0f0b8 2662 throw new moodle_exception('nopasswordchangeforced', 'auth');
d35757eb 2663 }
2664 }
083c3743 2665
8df850ad 2666 // Check that the user account is properly set up. If we can't redirect to
eeae783c
JL
2667 // edit their profile and this is not a WS request, perform just the lax check.
2668 // It will allow them to use filepicker on the profile edit page.
8df850ad 2669
eeae783c 2670 if ($preventredirect && !WS_SERVER) {
8df850ad
DM
2671 $usernotfullysetup = user_not_fully_set_up($USER, false);
2672 } else {
2673 $usernotfullysetup = user_not_fully_set_up($USER, true);
2674 }
2675
2676 if ($usernotfullysetup) {
df997f84 2677 if ($preventredirect) {
80e0f0b8 2678 throw new moodle_exception('usernotfullysetup');
df997f84 2679 }
af572078 2680 if ($setwantsurltome) {
f0202ae9 2681 $SESSION->wantsurl = qualified_me();
af572078 2682 }
b0ccd3fb 2683 redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
808a3baa 2684 }
d8ba183c 2685
df997f84 2686 // Make sure the USER has a sesskey set up. Used for CSRF protection.
04280e85 2687 sesskey();
366dfa60 2688
a428cf4a
JD
2689 // Do not bother admins with any formalities, except for activities pending deletion.
2690 if (is_siteadmin() && !($cm && $cm->deletioninprogress)) {
1edd3d6f
MG
2691 // Set the global $COURSE.
2692 if ($cm) {
2693 $PAGE->set_cm($cm, $course);
2694 $PAGE->set_pagelayout('incourse');
2695 } else if (!empty($courseorid)) {
2696 $PAGE->set_course($course);
2697 }
ac7af0da 2698 // Set accesstime or the user will appear offline which messes up messaging.
1560760f 2699 user_accesstime_log($course->id);
df997f84
PS
2700 return;
2701 }
2702
0bdc5785
DM
2703 // Scripts have a chance to declare that $USER->policyagreed should not be checked.
2704 // This is mostly for places where users are actually accepting the policies, to avoid the redirect loop.
2705 if (!defined('NO_SITEPOLICY_CHECK')) {
2706 define('NO_SITEPOLICY_CHECK', false);
2707 }
2708
ac7af0da 2709 // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
0bdc5785 2710 // Do not test if the script explicitly asked for skipping the site policies check.
1727c939
MG
2711 if (!$USER->policyagreed && !is_siteadmin() && !NO_SITEPOLICY_CHECK) {
2712 $manager = new \core_privacy\local\sitepolicy\manager();
2713 if ($policyurl = $manager->get_redirect_url(isguestuser())) {
b593d49d 2714 if ($preventredirect) {
1727c939 2715 throw new moodle_exception('sitepolicynotagreed', 'error', '', $policyurl->out());
b593d49d 2716 }
af572078 2717 if ($setwantsurltome) {
f0202ae9 2718 $SESSION->wantsurl = qualified_me();
af572078 2719 }
1727c939 2720 redirect($policyurl);
027a1604 2721 }
1695b680 2722 }
2723
ac7af0da 2724 // Fetch the system context, the course context, and prefetch its child contexts.
b0c6dc1c
AG
2725 $sysctx = context_system::instance();
2726 $coursecontext = context_course::instance($course->id, MUST_EXIST);
df997f84 2727 if ($cm) {
b0c6dc1c 2728 $cmcontext = context_module::instance($cm->id, MUST_EXIST);
df997f84
PS
2729 } else {
2730 $cmcontext = null;
2731 }
21e2dcd9 2732
ac7af0da 2733 // If the site is currently under maintenance, then print a message.
59c66f92 2734 if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:maintenanceaccess', $sysctx)) {
df997f84
PS
2735 if ($preventredirect) {
2736 throw new require_login_exception('Maintenance in progress');
2737 }
a4ea86f6 2738 $PAGE->set_context(null);
4fe2250a 2739 print_maintenance_message();
027a1604 2740 }
2741
ac7af0da 2742 // Make sure the course itself is not hidden.
df997f84 2743 if ($course->id == SITEID) {
ac7af0da 2744 // Frontpage can not be hidden.
df997f84 2745 } else {
f5c1e621 2746 if (is_role_switched($course->id)) {
ac7af0da 2747 // When switching roles ignore the hidden flag - user had to be in course to do the switch.
df997f84
PS
2748 } else {
2749 if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
ac7af0da
SH
2750 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
2751 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
df997f84
PS
2752 if ($preventredirect) {
2753 throw new require_login_exception('Course is hidden');
2754 }
1edd3d6f 2755 $PAGE->set_context(null);
ac7af0da
SH
2756 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2757 // the navigation will mess up when trying to find it.
a0a39b0d 2758 navigation_node::override_active_url(new moodle_url('/'));
df997f84
PS
2759 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2760 }
2761 }
2762 }
2763
ac7af0da 2764 // Is the user enrolled?
df997f84 2765 if ($course->id == SITEID) {
ac7af0da 2766 // Everybody is enrolled on the frontpage.
df997f84 2767 } else {
d79d5ac2 2768 if (\core\session\manager::is_loggedinas()) {
ac7af0da 2769 // Make sure the REAL person can access this course first.
d79d5ac2 2770 $realuser = \core\session\manager::get_realuser();
ac7af0da
SH
2771 if (!is_enrolled($coursecontext, $realuser->id, '', true) and
2772 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
df997f84
PS
2773 if ($preventredirect) {
2774 throw new require_login_exception('Invalid course login-as access');
2775 }
1edd3d6f 2776 $PAGE->set_context(null);
df997f84
PS
2777 echo $OUTPUT->header();
2778 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2779 }
2780 }
2781
df997f84
PS
2782 $access = false;
2783
dbd7282c 2784 if (is_role_switched($course->id)) {
ac7af0da 2785 // Ok, user had to be inside this course before the switch.
dbd7282c
PS
2786 $access = true;
2787
2788 } else if (is_viewing($coursecontext, $USER)) {
ac7af0da 2789 // Ok, no need to mess with enrol.
df997f84
PS
2790 $access = true;
2791
2792 } else {
2793 if (isset($USER->enrol['enrolled'][$course->id])) {
bbfdff34 2794 if ($USER->enrol['enrolled'][$course->id] > time()) {
df997f84 2795 $access = true;
bbfdff34
PS
2796 if (isset($USER->enrol['tempguest'][$course->id])) {
2797 unset($USER->enrol['tempguest'][$course->id]);
2798 remove_temp_course_roles($coursecontext);
2799 }
df997f84 2800 } else {
ac7af0da 2801 // Expired.
df997f84
PS
2802 unset($USER->enrol['enrolled'][$course->id]);
2803 }
2804 }
2805 if (isset($USER->enrol['tempguest'][$course->id])) {
2806 if ($USER->enrol['tempguest'][$course->id] == 0) {
2807 $access = true;
2808 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2809 $access = true;
2810 } else {
ac7af0da 2811 // Expired.
df997f84 2812 unset($USER->enrol['tempguest'][$course->id]);
e922fe23 2813 remove_temp_course_roles($coursecontext);
df997f84
PS
2814 }
2815 }
2816
ac7af0da
SH
2817 if (!$access) {
2818 // Cache not ok.
bbfdff34
PS
2819 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2820 if ($until !== false) {
ac7af0da 2821 // Active participants may always access, a timestamp in the future, 0 (always) or false.
bbfdff34
PS
2822 if ($until == 0) {
2823 $until = ENROL_MAX_TIMESTAMP;
df997f84 2824 }
bbfdff34
PS
2825 $USER->enrol['enrolled'][$course->id] = $until;
2826 $access = true;
2827
2828 } else {
ac7af0da
SH
2829 $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
2830 $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
bbfdff34 2831 $enrols = enrol_get_plugins(true);
ac7af0da
SH
2832 // First ask all enabled enrol instances in course if they want to auto enrol user.
2833 foreach ($instances as $instance) {
df997f84
PS
2834 if (!isset($enrols[$instance->enrol])) {
2835 continue;
2836 }
bbfdff34
PS
2837 // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2838 $until = $enrols[$instance->enrol]->try_autoenrol($instance);
df997f84 2839 if ($until !== false) {
bbfdff34
PS
2840 if ($until == 0) {
2841 $until = ENROL_MAX_TIMESTAMP;
2842 }
2843 $USER->enrol['enrolled'][$course->id] = $until;
df997f84
PS
2844 $access = true;
2845 break;
2846 }
2847 }
ac7af0da 2848 // If not enrolled yet try to gain temporary guest access.
bbfdff34 2849 if (!$access) {
ac7af0da 2850 foreach ($instances as $instance) {
bbfdff34
PS
2851 if (!isset($enrols[$instance->enrol])) {
2852 continue;
2853 }
2854 // Get a duration for the guest access, a timestamp in the future or false.
2855 $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2856 if ($until !== false and $until > time()) {
2857 $USER->enrol['tempguest'][$course->id] = $until;
2858 $access = true;
2859 break;
2860 }
2861 }
2862 }
df997f84
PS
2863 }
2864 }
2865 }
2866
2867 if (!$access) {
2868 if ($preventredirect) {
2869 throw new require_login_exception('Not enrolled');
2870 }
af572078 2871 if ($setwantsurltome) {
f0202ae9 2872 $SESSION->wantsurl = qualified_me();
af572078 2873 }
b3cb7264 2874 redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
df997f84
PS
2875 }
2876 }
2877
a428cf4a
JD
2878 // Check whether the activity has been scheduled for deletion. If so, then deny access, even for admins.
2879 if ($cm && $cm->deletioninprogress) {
2880 if ($preventredirect) {
2881 throw new moodle_exception('activityisscheduledfordeletion');
2882 }
2883 require_once($CFG->dirroot . '/course/lib.php');
2884 redirect(course_get_url($course), get_string('activityisscheduledfordeletion', 'error'));
2885 }
2886
061e6b28 2887 // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
0d8b6a69 2888 if ($cm && !$cm->uservisible) {
df997f84
PS
2889 if ($preventredirect) {
2890 throw new require_login_exception('Activity is hidden');
2891 }
592f3ae2
MG
2892 // Get the error message that activity is not available and why (if explanation can be shown to the user).
2893 $PAGE->set_course($course);
2894 $renderer = $PAGE->get_renderer('course');
2c3a34f0 2895 $message = $renderer->course_section_cm_unavailable_error_message($cm);
592f3ae2 2896 redirect(course_get_url($course), $message, null, \core\output\notification::NOTIFY_ERROR);
df997f84
PS
2897 }
2898
aad5b7f1 2899 // Set the global $COURSE.
2900 if ($cm) {
2901 $PAGE->set_cm($cm, $course);
2902 $PAGE->set_pagelayout('incourse');
2903 } else if (!empty($courseorid)) {
2904 $PAGE->set_course($course);
2905 }
2906
ac7af0da 2907 // Finally access granted, update lastaccess times.
df997f84 2908 user_accesstime_log($course->id);
f9903ed0 2909}
2910
c4d0753b 2911
c4d0753b 2912/**
2913 * This function just makes sure a user is logged out.
2914 *
f76249cc 2915 * @package core_access
ac7af0da 2916 * @category access
c4d0753b 2917 */
2918function require_logout() {
d79d5ac2 2919 global $USER, $DB;
c4d0753b 2920
d79d5ac2
PS
2921 if (!isloggedin()) {
2922 // This should not happen often, no need for hooks or events here.
2923 \core\session\manager::terminate_current();
2924 return;
c4d0753b 2925 }
2926
d79d5ac2 2927 // Execute hooks before action.
f9f9d187 2928 $authplugins = array();
d79d5ac2
PS
2929 $authsequence = get_enabled_auth_plugins();
2930 foreach ($authsequence as $authname) {
f9f9d187
SL
2931 $authplugins[$authname] = get_auth_plugin($authname);
2932 $authplugins[$authname]->prelogout_hook();
d79d5ac2
PS
2933 }
2934
2935 // Store info that gets removed during logout.
2936 $sid = session_id();
bb78e249 2937 $event = \core\event\user_loggedout::create(
d79d5ac2
PS
2938 array(
2939 'userid' => $USER->id,
2940 'objectid' => $USER->id,
2941 'other' => array('sessionid' => $sid),
2942 )
2943 );
2944 if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
2945 $event->add_record_snapshot('sessions', $session);
2946 }
bb78e249 2947
f9f9d187
SL
2948 // Clone of $USER object to be used by auth plugins.
2949 $user = fullclone($USER);
2950
d79d5ac2
PS
2951 // Delete session record and drop $_SESSION content.
2952 \core\session\manager::terminate_current();
2953
2954 // Trigger event AFTER action.
2955 $event->trigger();
f9f9d187
SL
2956
2957 // Hook to execute auth plugins redirection after event trigger.
2958 foreach ($authplugins as $authplugin) {
2959 $authplugin->postlogout_hook($user);
2960 }
c4d0753b 2961}
2962
7cf1c7bd 2963/**
0d0a8bf6 2964 * Weaker version of require_login()
2965 *
7cf1c7bd 2966 * This is a weaker version of {@link require_login()} which only requires login
2967 * when called from within a course rather than the site page, unless
2968 * the forcelogin option is turned on.
0d0a8bf6 2969 * @see require_login()
7cf1c7bd 2970 *
f76249cc
PS
2971 * @package core_access
2972 * @category access
2973 *
33ebaf7c 2974 * @param mixed $courseorid The course object or id in question
bbd3f2c4 2975 * @param bool $autologinguest Allow autologin guests if that is wanted
4febb58f 2976 * @param object $cm Course activity module if known
f4013c10 2977 * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2978 * true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2979 * in order to keep redirects working properly. MDL-14495
df997f84
PS
2980 * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2981 * @return void
ac7af0da 2982 * @throws coding_exception
7cf1c7bd 2983 */
ac7af0da 2984function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
862940c0 2985 global $CFG, $PAGE, $SITE;
9d202aed
PS
2986 $issite = ((is_object($courseorid) and $courseorid->id == SITEID)
2987 or (!is_object($courseorid) and $courseorid == SITEID));
d4fb0e26 2988 if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
ac7af0da 2989 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
0d8b6a69 2990 // db queries so this is not really a performance concern, however it is obviously
2991 // better if you use get_fast_modinfo to get the cm before calling this.
2992 if (is_object($courseorid)) {
2993 $course = $courseorid;
2994 } else {
2995 $course = clone($SITE);
2996 }
2997 $modinfo = get_fast_modinfo($course);
2998 $cm = $modinfo->get_cm($cm->id);
2999 }
1596edff 3000 if (!empty($CFG->forcelogin)) {
ac7af0da 3001 // Login required for both SITE and courses.
df997f84 3002 require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
63c9ee99 3003
0d8b6a69 3004 } else if ($issite && !empty($cm) and !$cm->uservisible) {
ac7af0da 3005 // Always login for hidden activities.
df997f84 3006 require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
63c9ee99 3007
0d8b6a69 3008 } else if ($issite) {
ac7af0da 3009 // Login for SITE not required.
48c79eb3 3010 // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3011 if (!empty($courseorid)) {
3012 if (is_object($courseorid)) {
3013 $course = $courseorid;
3014 } else {
3015 $course = clone $SITE;
3016 }
3017 if ($cm) {
3018 if ($cm->course != $course->id) {
3019 throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
862940c0 3020 }
48c79eb3 3021 $PAGE->set_cm($cm, $course);
3022 $PAGE->set_pagelayout('incourse');
862940c0 3023 } else {
48c79eb3 3024 $PAGE->set_course($course);
862940c0 3025 }
48c79eb3 3026 } else {
3027 // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3028 $PAGE->set_course($PAGE->course);
9950c88f 3029 }
48c79eb3 3030 user_accesstime_log(SITEID);
3031 return;
63c9ee99 3032
33ebaf7c 3033 } else {
ac7af0da 3034 // Course login always required.
df997f84 3035 require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
f950af3c 3036 }
3037}
3038
961c9549
JL
3039/**
3040 * Validates a user key, checking if the key exists, is not expired and the remote ip is correct.
3041 *
3042 * @param string $keyvalue the key value
3043 * @param string $script unique script identifier
3044 * @param int $instance instance id
3045 * @return stdClass the key entry in the user_private_key table
3046 * @since Moodle 3.2
3047 * @throws moodle_exception
3048 */
3049function validate_user_key($keyvalue, $script, $instance) {
3050 global $DB;
3051
3052 if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3053 print_error('invalidkey');
3054 }
3055
3056 if (!empty($key->validuntil) and $key->validuntil < time()) {
3057 print_error('expiredkey');
3058 }
3059