MDL-51427 user: correctly use strings for phone1 and phone2
[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
TH
117 * PARAM_CLEANHTML - cleans submitted HTML code. Note that you almost never want
118 * to use this. The normal mode of operation is to use PARAM_RAW when recieving
119 * the input (required/optional_param or formslib) and then sanitse the HTML
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/**
320 * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
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
aa54ed7b 442/** Unspecified module archetype */
443define('MOD_ARCHETYPE_OTHER', 0);
444/** Resource-like type module */
445define('MOD_ARCHETYPE_RESOURCE', 1);
efb8c375 446/** Assignment module archetype */
aa54ed7b 447define('MOD_ARCHETYPE_ASSIGNMENT', 2);
5813c7f7 448/** System (not user-addable) module archetype */
449define('MOD_ARCHETYPE_SYSTEM', 3);
aa54ed7b 450
50ae8814
MN
451/** Return this from modname_get_types callback to use default display in activity chooser */
452define('MOD_SUBTYPE_NO_CHILDREN', 'modsubtypenochildren');
453
eec99048 454/**
455 * Security token used for allowing access
456 * from external application such as web services.
457 * Scripts do not use any session, performance is relatively
458 * low because we need to load access info in each request.
efb8c375 459 * Scripts are executed in parallel.
eec99048 460 */
461define('EXTERNAL_TOKEN_PERMANENT', 0);
462
463/**
464 * Security token used for allowing access
465 * of embedded applications, the code is executed in the
466 * active user session. Token is invalidated after user logs out.
467 * Scripts are executed serially - normal session locking is used.
468 */
469define('EXTERNAL_TOKEN_EMBEDDED', 1);
49f6e5f4 470
4766a50c
SH
471/**
472 * The home page should be the site home
473 */
474define('HOMEPAGE_SITE', 0);
475/**
476 * The home page should be the users my page
477 */
478define('HOMEPAGE_MY', 1);
479/**
480 * The home page can be chosen by the user
481 */
482define('HOMEPAGE_USER', 2);
fcce139a 483
94788de2 484/**
485 * Hub directory url (should be moodle.org)
486 */
487define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
488
489
490/**
491 * Moodle.org url (should be moodle.org)
492 */
493define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
494
c1b65883
JM
495/**
496 * Moodle mobile app service name
497 */
498define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
94788de2 499
bc8da017
AD
500/**
501 * Indicates the user has the capabilities required to ignore activity and course file size restrictions
502 */
503define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
504
1f09018a 505/**
ac7af0da
SH
506 * Course display settings: display all sections on one page.
507 */
508define('COURSE_DISPLAY_SINGLEPAGE', 0);
509/**
510 * Course display settings: split pages into a page per section.
1f09018a 511 */
ac7af0da 512define('COURSE_DISPLAY_MULTIPAGE', 1);
1f09018a 513
ec2d8ceb 514/**
ac7af0da 515 * Authentication constant: String used in password field when password is not stored.
ec2d8ceb 516 */
ac7af0da 517define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
ec2d8ceb 518
ac7af0da 519// PARAMETER HANDLING.
6b174680 520
e0d346ff 521/**
361855e6 522 * Returns a particular value for the named variable, taken from
523 * POST or GET. If the parameter doesn't exist then an error is
e0d346ff 524 * thrown because we require this variable.
525 *
361855e6 526 * This function should be used to initialise all required values
527 * in a script that are based on parameters. Usually it will be
e0d346ff 528 * used like this:
622365d2 529 * $id = required_param('id', PARAM_INT);
e0d346ff 530 *
2ca3bffa 531 * Please note the $type parameter is now required and the value can not be array.
44913c8d
PS
532 *
533 * @param string $parname the name of the page parameter we want
534 * @param string $type expected type of parameter
e0d346ff 535 * @return mixed
ac7af0da 536 * @throws coding_exception
e0d346ff 537 */
44913c8d 538function required_param($parname, $type) {
2ca3bffa
PS
539 if (func_num_args() != 2 or empty($parname) or empty($type)) {
540 throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
44913c8d 541 }
ac7af0da
SH
542 // POST has precedence.
543 if (isset($_POST[$parname])) {
a083b93c 544 $param = $_POST[$parname];
545 } else if (isset($_GET[$parname])) {
546 $param = $_GET[$parname];
e0d346ff 547 } else {
2f137aa1 548 print_error('missingparam', '', '', $parname);
e0d346ff 549 }
550
2ca3bffa
PS
551 if (is_array($param)) {
552 debugging('Invalid array parameter detected in required_param(): '.$parname);
ac7af0da 553 // TODO: switch to fatal error in Moodle 2.3.
2ca3bffa
PS
554 return required_param_array($parname, $type);
555 }
556
a083b93c 557 return clean_param($param, $type);
e0d346ff 558}
559
2ca3bffa
PS
560/**
561 * Returns a particular array value for the named variable, taken from
562 * POST or GET. If the parameter doesn't exist then an error is
563 * thrown because we require this variable.
564 *
565 * This function should be used to initialise all required values
566 * in a script that are based on parameters. Usually it will be
567 * used like this:
568 * $ids = required_param_array('ids', PARAM_INT);
569 *
570 * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
571 *
572 * @param string $parname the name of the page parameter we want
573 * @param string $type expected type of parameter
574 * @return array
ac7af0da 575 * @throws coding_exception
2ca3bffa
PS
576 */
577function required_param_array($parname, $type) {
578 if (func_num_args() != 2 or empty($parname) or empty($type)) {
579 throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
580 }
ac7af0da
SH
581 // POST has precedence.
582 if (isset($_POST[$parname])) {
2ca3bffa
PS
583 $param = $_POST[$parname];
584 } else if (isset($_GET[$parname])) {
585 $param = $_GET[$parname];
586 } else {
587 print_error('missingparam', '', '', $parname);
588 }
589 if (!is_array($param)) {
590 print_error('missingparam', '', '', $parname);
591 }
592
593 $result = array();
ac7af0da 594 foreach ($param as $key => $value) {
2ca3bffa
PS
595 if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
596 debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
597 continue;
598 }
ebdeccca 599 $result[$key] = clean_param($value, $type);
2ca3bffa
PS
600 }
601
602 return $result;
e0d346ff 603}
604
605/**
361855e6 606 * Returns a particular value for the named variable, taken from
e0d346ff 607 * POST or GET, otherwise returning a given default.
608 *
361855e6 609 * This function should be used to initialise all optional values
610 * in a script that are based on parameters. Usually it will be
e0d346ff 611 * used like this:
622365d2 612 * $name = optional_param('name', 'Fred', PARAM_TEXT);
e0d346ff 613 *
2ca3bffa 614 * Please note the $type parameter is now required and the value can not be array.
44913c8d 615 *
a083b93c 616 * @param string $parname the name of the page parameter we want
e0d346ff 617 * @param mixed $default the default value to return if nothing is found
44913c8d 618 * @param string $type expected type of parameter
e0d346ff 619 * @return mixed
ac7af0da 620 * @throws coding_exception
e0d346ff 621 */
44913c8d 622function optional_param($parname, $default, $type) {
2ca3bffa 623 if (func_num_args() != 3 or empty($parname) or empty($type)) {
ac7af0da 624 throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
44913c8d 625 }
44913c8d 626
ac7af0da
SH
627 // POST has precedence.
628 if (isset($_POST[$parname])) {
a083b93c 629 $param = $_POST[$parname];
630 } else if (isset($_GET[$parname])) {
631 $param = $_GET[$parname];
e0d346ff 632 } else {
633 return $default;
634 }
c7f4e3e2 635
2ca3bffa
PS
636 if (is_array($param)) {
637 debugging('Invalid array parameter detected in required_param(): '.$parname);
ac7af0da 638 // TODO: switch to $default in Moodle 2.3.
2ca3bffa
PS
639 return optional_param_array($parname, $default, $type);
640 }
641
a083b93c 642 return clean_param($param, $type);
e0d346ff 643}
644
2ca3bffa
PS
645/**
646 * Returns a particular array value for the named variable, taken from
647 * POST or GET, otherwise returning a given default.
648 *
649 * This function should be used to initialise all optional values
650 * in a script that are based on parameters. Usually it will be
651 * used like this:
652 * $ids = optional_param('id', array(), PARAM_INT);
653 *
ac7af0da 654 * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
2ca3bffa
PS
655 *
656 * @param string $parname the name of the page parameter we want
ac7af0da 657 * @param mixed $default the default value to return if nothing is found
2ca3bffa
PS
658 * @param string $type expected type of parameter
659 * @return array
ac7af0da 660 * @throws coding_exception
2ca3bffa
PS
661 */
662function optional_param_array($parname, $default, $type) {
663 if (func_num_args() != 3 or empty($parname) or empty($type)) {
ac7af0da 664 throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
2ca3bffa
PS
665 }
666
ac7af0da
SH
667 // POST has precedence.
668 if (isset($_POST[$parname])) {
2ca3bffa
PS
669 $param = $_POST[$parname];
670 } else if (isset($_GET[$parname])) {
671 $param = $_GET[$parname];
672 } else {
673 return $default;
674 }
675 if (!is_array($param)) {
676 debugging('optional_param_array() expects array parameters only: '.$parname);
677 return $default;
678 }
679
680 $result = array();
ac7af0da 681 foreach ($param as $key => $value) {
2ca3bffa
PS
682 if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
683 debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
684 continue;
685 }
ebdeccca 686 $result[$key] = clean_param($value, $type);
2ca3bffa
PS
687 }
688
689 return $result;
e0d346ff 690}
691
a3f7cbf6 692/**
693 * Strict validation of parameter values, the values are only converted
694 * to requested PHP type. Internally it is using clean_param, the values
695 * before and after cleaning must be equal - otherwise
696 * an invalid_parameter_exception is thrown.
efb8c375 697 * Objects and classes are not accepted.
a3f7cbf6 698 *
699 * @param mixed $param
2ca3bffa 700 * @param string $type PARAM_ constant
a3f7cbf6 701 * @param bool $allownull are nulls valid value?
702 * @param string $debuginfo optional debug information
fea52c11
PS
703 * @return mixed the $param value converted to PHP type
704 * @throws invalid_parameter_exception if $param is not of given type
a3f7cbf6 705 */
5a1861ee 706function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
a3f7cbf6 707 if (is_null($param)) {
5a1861ee 708 if ($allownull == NULL_ALLOWED) {
a3f7cbf6 709 return null;
710 } else {
711 throw new invalid_parameter_exception($debuginfo);
712 }
713 }
714 if (is_array($param) or is_object($param)) {
715 throw new invalid_parameter_exception($debuginfo);
716 }
717
718 $cleaned = clean_param($param, $type);
fea52c11
PS
719
720 if ($type == PARAM_FLOAT) {
721 // Do not detect precision loss here.
722 if (is_float($param) or is_int($param)) {
723 // These always fit.
724 } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
725 throw new invalid_parameter_exception($debuginfo);
726 }
727 } else if ((string)$param !== (string)$cleaned) {
ac7af0da 728 // Conversion to string is usually lossless.
a3f7cbf6 729 throw new invalid_parameter_exception($debuginfo);
730 }
731
732 return $cleaned;
733}
734
2ca3bffa 735/**
ac7af0da
SH
736 * Makes sure array contains only the allowed types, this function does not validate array key names!
737 *
2ca3bffa
PS
738 * <code>
739 * $options = clean_param($options, PARAM_INT);
740 * </code>
741 *
742 * @param array $param the variable array we are cleaning
743 * @param string $type expected format of param after cleaning.
744 * @param bool $recursive clean recursive arrays
745 * @return array
ac7af0da 746 * @throws coding_exception
2ca3bffa
PS
747 */
748function clean_param_array(array $param = null, $type, $recursive = false) {
ac7af0da
SH
749 // Convert null to empty array.
750 $param = (array)$param;
2ca3bffa
PS
751 foreach ($param as $key => $value) {
752 if (is_array($value)) {
753 if ($recursive) {
754 $param[$key] = clean_param_array($value, $type, true);
755 } else {
ac7af0da 756 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
2ca3bffa
PS
757 }
758 } else {
759 $param[$key] = clean_param($value, $type);
760 }
761 }
762 return $param;
763}
764
e0d346ff 765/**
361855e6 766 * Used by {@link optional_param()} and {@link required_param()} to
767 * clean the variables and/or cast to specific types, based on
e0d346ff 768 * an options field.
bbd3f2c4 769 * <code>
770 * $course->format = clean_param($course->format, PARAM_ALPHA);
ac7af0da 771 * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
bbd3f2c4 772 * </code>
e0d346ff 773 *
774 * @param mixed $param the variable we are cleaning
2ca3bffa 775 * @param string $type expected format of param after cleaning.
e0d346ff 776 * @return mixed
ac7af0da 777 * @throws coding_exception
e0d346ff 778 */
a083b93c 779function clean_param($param, $type) {
7744ea12 780 global $CFG;
c7f4e3e2 781
c16c1be7
PS
782 if (is_array($param)) {
783 throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
784 } else if (is_object($param)) {
785 if (method_exists($param, '__toString')) {
786 $param = $param->__toString();
787 } else {
788 throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
789 }
80bfd470 790 }
791
a083b93c 792 switch ($type) {
ac7af0da
SH
793 case PARAM_RAW:
794 // No cleaning at all.
78fcdb5f 795 $param = fix_utf8($param);
96e98ea6 796 return $param;
797
ac7af0da
SH
798 case PARAM_RAW_TRIMMED:
799 // No cleaning, but strip leading and trailing whitespace.
78fcdb5f 800 $param = fix_utf8($param);
652599ec
TH
801 return trim($param);
802
ac7af0da
SH
803 case PARAM_CLEAN:
804 // General HTML cleaning, try to use more specific type if possible this is deprecated!
805 // Please use more specific type instead.
a083b93c 806 if (is_numeric($param)) {
807 return $param;
808 }
78fcdb5f 809 $param = fix_utf8($param);
ac7af0da
SH
810 // Sweep for scripts, etc.
811 return clean_text($param);
3af57507 812
ac7af0da
SH
813 case PARAM_CLEANHTML:
814 // Clean html fragment.
78fcdb5f 815 $param = fix_utf8($param);
ac7af0da
SH
816 // Sweep for scripts, etc.
817 $param = clean_text($param, FORMAT_HTML);
a083b93c 818 return trim($param);
e0d346ff 819
a083b93c 820 case PARAM_INT:
ac7af0da
SH
821 // Convert to integer.
822 return (int)$param;
e0d346ff 823
6e73ae10 824 case PARAM_FLOAT:
ac7af0da
SH
825 // Convert to float.
826 return (float)$param;
9dae915a 827
ac7af0da
SH
828 case PARAM_ALPHA:
829 // Remove everything not `a-z`.
6dbcacee 830 return preg_replace('/[^a-zA-Z]/i', '', $param);
e0d346ff 831
ac7af0da
SH
832 case PARAM_ALPHAEXT:
833 // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
6dbcacee 834 return preg_replace('/[^a-zA-Z_-]/i', '', $param);
6e73ae10 835
ac7af0da
SH
836 case PARAM_ALPHANUM:
837 // Remove everything not `a-zA-Z0-9`.
6dbcacee 838 return preg_replace('/[^A-Za-z0-9]/i', '', $param);
f24148ef 839
ac7af0da
SH
840 case PARAM_ALPHANUMEXT:
841 // Remove everything not `a-zA-Z0-9_-`.
6dbcacee 842 return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
0ed442f8 843
ac7af0da
SH
844 case PARAM_SEQUENCE:
845 // Remove everything not `0-9,`.
6dbcacee 846 return preg_replace('/[^0-9,]/i', '', $param);
0e4af166 847
ac7af0da
SH
848 case PARAM_BOOL:
849 // Convert to 1 or 0.
a083b93c 850 $tempstr = strtolower($param);
6e73ae10 851 if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
a083b93c 852 $param = 1;
6e73ae10 853 } else if ($tempstr === 'off' or $tempstr === 'no' or $tempstr === 'false') {
a083b93c 854 $param = 0;
855 } else {
856 $param = empty($param) ? 0 : 1;
857 }
858 return $param;
f24148ef 859
ac7af0da
SH
860 case PARAM_NOTAGS:
861 // Strip all tags.
78fcdb5f 862 $param = fix_utf8($param);
a083b93c 863 return strip_tags($param);
3af57507 864
ac7af0da
SH
865 case PARAM_TEXT:
866 // Leave only tags needed for multilang.
78fcdb5f 867 $param = fix_utf8($param);
ac7af0da
SH
868 // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
869 // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
b6059edc
PS
870 do {
871 if (strpos($param, '</lang>') !== false) {
ac7af0da 872 // Old and future mutilang syntax.
b6059edc
PS
873 $param = strip_tags($param, '<lang>');
874 if (!preg_match_all('/<.*>/suU', $param, $matches)) {
875 break;
876 }
877 $open = false;
878 foreach ($matches[0] as $match) {
879 if ($match === '</lang>') {
880 if ($open) {
881 $open = false;
882 continue;
883 } else {
884 break 2;
885 }
886 }
887 if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
888 break 2;
889 } else {
890 $open = true;
891 }
892 }
893 if ($open) {
894 break;
895 }
896 return $param;
897
898 } else if (strpos($param, '</span>') !== false) {
ac7af0da 899 // Current problematic multilang syntax.
b6059edc
PS
900 $param = strip_tags($param, '<span>');
901 if (!preg_match_all('/<.*>/suU', $param, $matches)) {
902 break;
903 }
904 $open = false;
905 foreach ($matches[0] as $match) {
906 if ($match === '</span>') {
907 if ($open) {
908 $open = false;
909 continue;
910 } else {
911 break 2;
912 }
913 }
914 if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
915 break 2;
916 } else {
917 $open = true;
918 }
919 }
920 if ($open) {
921 break;
922 }
923 return $param;
924 }
925 } while (false);
ac7af0da 926 // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
b6059edc 927 return strip_tags($param);
31f26796 928
aff24313 929 case PARAM_COMPONENT:
ac7af0da
SH
930 // We do not want any guessing here, either the name is correct or not
931 // please note only normalised component names are accepted.
a41d1ca0 932 if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]+$/', $param)) {
aff24313
PS
933 return '';
934 }
935 if (strpos($param, '__') !== false) {
936 return '';
937 }
938 if (strpos($param, 'mod_') === 0) {
ac7af0da 939 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
aff24313
PS
940 if (substr_count($param, '_') != 1) {
941 return '';
942 }
943 }
944 return $param;
945
946 case PARAM_PLUGIN:
947 case PARAM_AREA:
ac7af0da 948 // We do not want any guessing here, either the name is correct or not.
5f850735 949 if (!is_valid_plugin_name($param)) {
aff24313
PS
950 return '';
951 }
952 return $param;
953
ac7af0da
SH
954 case PARAM_SAFEDIR:
955 // Remove everything not a-zA-Z0-9_- .
6dbcacee 956 return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
95bfd207 957
ac7af0da
SH
958 case PARAM_SAFEPATH:
959 // Remove everything not a-zA-Z0-9/_- .
6759ad2f 960 return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
6e73ae10 961
ac7af0da
SH
962 case PARAM_FILE:
963 // Strip all suspicious characters from filename.
78fcdb5f 964 $param = fix_utf8($param);
14f3ad15 965 $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
caf16a57 966 if ($param === '.' || $param === '..') {
371a2ed0 967 $param = '';
968 }
a083b93c 969 return $param;
970
ac7af0da
SH
971 case PARAM_PATH:
972 // Strip all suspicious characters from file path.
78fcdb5f 973 $param = fix_utf8($param);
a083b93c 974 $param = str_replace('\\', '/', $param);
caf16a57
FM
975
976 // Explode the path and clean each element using the PARAM_FILE rules.
977 $breadcrumb = explode('/', $param);
978 foreach ($breadcrumb as $key => $crumb) {
979 if ($crumb === '.' && $key === 0) {
980 // Special condition to allow for relative current path such as ./currentdirfile.txt.
981 } else {
982 $crumb = clean_param($crumb, PARAM_FILE);
983 }
984 $breadcrumb[$key] = $crumb;
985 }
986 $param = implode('/', $breadcrumb);
987
988 // Remove multiple current path (./././) and multiple slashes (///).
6dbcacee 989 $param = preg_replace('~//+~', '/', $param);
caf16a57
FM
990 $param = preg_replace('~/(\./)+~', '/', $param);
991 return $param;
a083b93c 992
ac7af0da
SH
993 case PARAM_HOST:
994 // Allow FQDN or IPv4 dotted quad.
995 $param = preg_replace('/[^\.\d\w-]/', '', $param );
996 // Match ipv4 dotted quad.
997 if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
998 // Confirm values are ok.
a083b93c 999 if ( $match[0] > 255
1000 || $match[1] > 255
1001 || $match[3] > 255
1002 || $match[4] > 255 ) {
ac7af0da 1003 // Hmmm, what kind of dotted quad is this?
a083b93c 1004 $param = '';
1005 }
ac7af0da
SH
1006 } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1007 && !preg_match('/^[\.-]/', $param) // No leading dots/hyphens.
1008 && !preg_match('/[\.-]$/', $param) // No trailing dots/hyphens.
a083b93c 1009 ) {
ac7af0da 1010 // All is ok - $param is respected.
a083b93c 1011 } else {
ac7af0da 1012 // All is not ok...
a083b93c 1013 $param='';
1014 }
1015 return $param;
7744ea12 1016
ac7af0da 1017 case PARAM_URL: // Allow safe ftp, http, mailto urls.
78fcdb5f 1018 $param = fix_utf8($param);
a083b93c 1019 include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
5301205a 1020 if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
ac7af0da 1021 // All is ok, param is respected.
d2a9f7cc 1022 } else {
ac7af0da
SH
1023 // Not really ok.
1024 $param ='';
a083b93c 1025 }
1026 return $param;
1027
ac7af0da
SH
1028 case PARAM_LOCALURL:
1029 // Allow http absolute, root relative and relative URLs within wwwroot.
93684765 1030 $param = clean_param($param, PARAM_URL);
a083b93c 1031 if (!empty($param)) {
d031c2dc
FM
1032
1033 // Simulate the HTTPS version of the site.
1034 $httpswwwroot = str_replace('http://', 'https://', $CFG->wwwroot);
1035
5c1f41f0
PS
1036 if ($param === $CFG->wwwroot) {
1037 // Exact match;
1038 } else if (!empty($CFG->loginhttps) && $param === $httpswwwroot) {
1039 // Exact match;
1040 } else if (preg_match(':^/:', $param)) {
ac7af0da 1041 // Root-relative, ok!
5c1f41f0 1042 } else if (preg_match('/^' . preg_quote($CFG->wwwroot . '/', '/') . '/i', $param)) {
ac7af0da 1043 // Absolute, and matches our wwwroot.
5c1f41f0 1044 } else if (!empty($CFG->loginhttps) && preg_match('/^' . preg_quote($httpswwwroot . '/', '/') . '/i', $param)) {
d031c2dc 1045 // Absolute, and matches our httpswwwroot.
7744ea12 1046 } else {
ac7af0da 1047 // Relative - let's make sure there are no tricks.
4bea5e85 1048 if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
ac7af0da 1049 // Looks ok.
a083b93c 1050 } else {
1051 $param = '';
1052 }
d2a9f7cc 1053 }
7744ea12 1054 }
a083b93c 1055 return $param;
bcef0319 1056
03d820c7 1057 case PARAM_PEM:
1058 $param = trim($param);
ac7af0da
SH
1059 // PEM formatted strings may contain letters/numbers and the symbols:
1060 // forward slash: /
1061 // plus sign: +
1062 // equal sign: =
1063 // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
03d820c7 1064 if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1065 list($wholething, $body) = $matches;
1066 unset($wholething, $matches);
1067 $b64 = clean_param($body, PARAM_BASE64);
1068 if (!empty($b64)) {
1069 return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1070 } else {
1071 return '';
1072 }
1073 }
1074 return '';
bcef0319 1075
03d820c7 1076 case PARAM_BASE64:
1077 if (!empty($param)) {
1078 // PEM formatted strings may contain letters/numbers and the symbols
ac7af0da
SH
1079 // forward slash: /
1080 // plus sign: +
1081 // equal sign: =.
03d820c7 1082 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1083 return '';
1084 }
1085 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
ac7af0da
SH
1086 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1087 // than (or equal to) 64 characters long.
03d820c7 1088 for ($i=0, $j=count($lines); $i < $j; $i++) {
1089 if ($i + 1 == $j) {
1090 if (64 < strlen($lines[$i])) {
1091 return '';
1092 }
1093 continue;
1094 }
7744ea12 1095
03d820c7 1096 if (64 != strlen($lines[$i])) {
1097 return '';
1098 }
1099 }
ac7af0da 1100 return implode("\n", $lines);
03d820c7 1101 } else {
1102 return '';
1103 }
bcef0319 1104
1105 case PARAM_TAG:
78fcdb5f 1106 $param = fix_utf8($param);
34b93e39
PS
1107 // Please note it is not safe to use the tag name directly anywhere,
1108 // it must be processed with s(), urlencode() before embedding anywhere.
ac7af0da 1109 // Remove some nasties.
6b24e35e 1110 $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
ac7af0da 1111 // Convert many whitespace chars into one.
e737c2ff 1112 $param = preg_replace('/\s+/u', ' ', $param);
2f1e464a 1113 $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
c93c6b3b 1114 return $param;
bcef0319 1115
ae040d4b 1116 case PARAM_TAGLIST:
78fcdb5f 1117 $param = fix_utf8($param);
ae040d4b 1118 $tags = explode(',', $param);
1119 $result = array();
1120 foreach ($tags as $tag) {
1121 $res = clean_param($tag, PARAM_TAG);
6e73ae10 1122 if ($res !== '') {
ae040d4b 1123 $result[] = $res;
1124 }
1125 }
1126 if ($result) {
1127 return implode(',', $result);
1128 } else {
1129 return '';
0d626493 1130 }
1131
ad944e78 1132 case PARAM_CAPABILITY:
4f0c2d00 1133 if (get_capability_info($param)) {
ad944e78 1134 return $param;
1135 } else {
1136 return '';
1137 }
1138
faf75fe7 1139 case PARAM_PERMISSION:
1140 $param = (int)$param;
1141 if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1142 return $param;
1143 } else {
1144 return CAP_INHERIT;
1145 }
1146
03b31ea3 1147 case PARAM_AUTH:
aff24313
PS
1148 $param = clean_param($param, PARAM_PLUGIN);
1149 if (empty($param)) {
1150 return '';
1151 } else if (exists_auth_plugin($param)) {
03b31ea3 1152 return $param;
1153 } else {
1154 return '';
1155 }
1156
1157 case PARAM_LANG:
1158 $param = clean_param($param, PARAM_SAFEDIR);
ef686eb5 1159 if (get_string_manager()->translation_exists($param)) {
03b31ea3 1160 return $param;
1161 } else {
ac7af0da
SH
1162 // Specified language is not installed or param malformed.
1163 return '';
03b31ea3 1164 }
1165
1166 case PARAM_THEME:
aff24313
PS
1167 $param = clean_param($param, PARAM_PLUGIN);
1168 if (empty($param)) {
1169 return '';
1170 } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
73e504bc
PS
1171 return $param;
1172 } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
03b31ea3 1173 return $param;
1174 } else {
ac7af0da
SH
1175 // Specified theme is not installed.
1176 return '';
03b31ea3 1177 }
1178
07ed083e 1179 case PARAM_USERNAME:
78fcdb5f 1180 $param = fix_utf8($param);
77218e4a 1181 $param = trim($param);
ac7af0da 1182 // Convert uppercase to lowercase MDL-16919.
2f1e464a 1183 $param = core_text::strtolower($param);
34d2b19a 1184 if (empty($CFG->extendedusernamechars)) {
77218e4a 1185 $param = str_replace(" " , "", $param);
ac7af0da 1186 // Regular expression, eliminate all chars EXCEPT:
07ed083e
RW
1187 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1188 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
4f0c2d00 1189 }
07ed083e
RW
1190 return $param;
1191
79f1d953 1192 case PARAM_EMAIL:
78fcdb5f 1193 $param = fix_utf8($param);
79f1d953 1194 if (validate_email($param)) {
1195 return $param;
1196 } else {
1197 return '';
1198 }
1199
fe6a248f
DM
1200 case PARAM_STRINGID:
1201 if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1202 return $param;
1203 } else {
1204 return '';
1205 }
1206
ac7af0da
SH
1207 case PARAM_TIMEZONE:
1208 // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
78fcdb5f 1209 $param = fix_utf8($param);
8158ce79 1210 $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
ccc77f91
RT
1211 if (preg_match($timezonepattern, $param)) {
1212 return $param;
1213 } else {
1214 return '';
1215 }
1216
ac7af0da
SH
1217 default:
1218 // Doh! throw error, switched parameters in optional_param or another serious problem.
03b31ea3 1219 print_error("unknownparamtype", '', '', $type);
2ae28153 1220 }
e0d346ff 1221}
1222
78fcdb5f
PS
1223/**
1224 * Makes sure the data is using valid utf8, invalid characters are discarded.
1225 *
1226 * Note: this function is not intended for full objects with methods and private properties.
1227 *
1228 * @param mixed $value
1229 * @return mixed with proper utf-8 encoding
1230 */
1231function fix_utf8($value) {
1232 if (is_null($value) or $value === '') {
1233 return $value;
1234
1235 } else if (is_string($value)) {
1236 if ((string)(int)$value === $value) {
ac7af0da 1237 // Shortcut.
78fcdb5f
PS
1238 return $value;
1239 }
bff1d60c
PS
1240 // No null bytes expected in our data, so let's remove it.
1241 $value = str_replace("\0", '', $value);
0aff15c2 1242
0aff15c2
PS
1243 // Note: this duplicates min_fix_utf8() intentionally.
1244 static $buggyiconv = null;
1245 if ($buggyiconv === null) {
dd47f210 1246 $buggyiconv = (!function_exists('iconv') or @iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
0aff15c2
PS
1247 }
1248
1249 if ($buggyiconv) {
1250 if (function_exists('mb_convert_encoding')) {
1251 $subst = mb_substitute_character();
1252 mb_substitute_character('');
1253 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1254 mb_substitute_character($subst);
1255
1256 } else {
1257 // Warn admins on admin/index.php page.
1258 $result = $value;
1259 }
1260
1261 } else {
dd47f210 1262 $result = @iconv('UTF-8', 'UTF-8//IGNORE', $value);
51b7297b 1263 }
0aff15c2 1264
51b7297b 1265 return $result;
78fcdb5f
PS
1266
1267 } else if (is_array($value)) {
ac7af0da 1268 foreach ($value as $k => $v) {
78fcdb5f
PS
1269 $value[$k] = fix_utf8($v);
1270 }
1271 return $value;
1272
1273 } else if (is_object($value)) {
ac7af0da
SH
1274 // Do not modify original.
1275 $value = clone($value);
1276 foreach ($value as $k => $v) {
78fcdb5f
PS
1277 $value->$k = fix_utf8($v);
1278 }
1279 return $value;
1280
1281 } else {
ac7af0da 1282 // This is some other type, no utf-8 here.
78fcdb5f
PS
1283 return $value;
1284 }
1285}
1286
6e73ae10 1287/**
1288 * Return true if given value is integer or string with integer value
0d0a8bf6 1289 *
1290 * @param mixed $value String or Int
1291 * @return bool true if number, false if not
6e73ae10 1292 */
1293function is_number($value) {
1294 if (is_int($value)) {
1295 return true;
1296 } else if (is_string($value)) {
1297 return ((string)(int)$value) === $value;
1298 } else {
1299 return false;
1300 }
1301}
7a530277 1302
aa282b10 1303/**
ac7af0da
SH
1304 * Returns host part from url.
1305 *
aa282b10 1306 * @param string $url full url
1307 * @return string host, null if not found
1308 */
1309function get_host_from_url($url) {
1310 preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1311 if ($matches) {
1312 return $matches[1];
1313 }
1314 return null;
1315}
1316
94a6d656 1317/**
0d0a8bf6 1318 * Tests whether anything was returned by text editor
1319 *
94a6d656 1320 * This function is useful for testing whether something you got back from
1321 * the HTML editor actually contains anything. Sometimes the HTML editor
1322 * appear to be empty, but actually you get back a <br> tag or something.
1323 *
1324 * @param string $string a string containing HTML.
1325 * @return boolean does the string contain any actual content - that is text,
efb8c375 1326 * images, objects, etc.
94a6d656 1327 */
1328function html_is_blank($string) {
1329 return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1330}
1331
7cf1c7bd 1332/**
1333 * Set a key in global configuration
1334 *
89dcb99d 1335 * Set a key/value pair in both this session's {@link $CFG} global variable
7cf1c7bd 1336 * and in the 'config' database table for future sessions.
e1ecf0a0 1337 *
1338 * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1339 * In that case it doesn't affect $CFG.
7cf1c7bd 1340 *
6fd511eb 1341 * A NULL value will delete the entry.
1342 *
08b51dd0
JO
1343 * NOTE: this function is called from lib/db/upgrade.php
1344 *
7cf1c7bd 1345 * @param string $name the key to set
9cdb766d 1346 * @param string $value the value to set (without magic quotes)
ac7af0da 1347 * @param string $plugin (optional) the plugin scope, default null
5e2f308b 1348 * @return bool true or exception
7cf1c7bd 1349 */
ac7af0da 1350function set_config($name, $value, $plugin=null) {
ae040d4b 1351 global $CFG, $DB;
42282810 1352
a4080313 1353 if (empty($plugin)) {
220a90c5 1354 if (!array_key_exists($name, $CFG->config_php_settings)) {
ac7af0da 1355 // So it's defined for this invocation at least.
220a90c5 1356 if (is_null($value)) {
1357 unset($CFG->$name);
1358 } else {
ac7af0da
SH
1359 // Settings from db are always strings.
1360 $CFG->$name = (string)$value;
220a90c5 1361 }
1362 }
e1ecf0a0 1363
ac7af0da 1364 if ($DB->get_field('config', 'name', array('name' => $name))) {
5e2f308b 1365 if ($value === null) {
ac7af0da 1366 $DB->delete_records('config', array('name' => $name));
6fd511eb 1367 } else {
ac7af0da 1368 $DB->set_field('config', 'value', $value, array('name' => $name));
6fd511eb 1369 }
a4080313 1370 } else {
5e2f308b 1371 if ($value !== null) {
365a5941 1372 $config = new stdClass();
5e2f308b 1373 $config->name = $name;
1374 $config->value = $value;
1375 $DB->insert_record('config', $config, false);
6fd511eb 1376 }
a4080313 1377 }
e0d9b7c0
SH
1378 if ($name === 'siteidentifier') {
1379 cache_helper::update_site_identifier($value);
1380 }
007bfe8b 1381 cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
ac7af0da
SH
1382 } else {
1383 // Plugin scope.
1384 if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
6fd511eb 1385 if ($value===null) {
ac7af0da 1386 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
6fd511eb 1387 } else {
ac7af0da 1388 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
6fd511eb 1389 }
a4080313 1390 } else {
5e2f308b 1391 if ($value !== null) {
365a5941 1392 $config = new stdClass();
5e2f308b 1393 $config->plugin = $plugin;
1394 $config->name = $name;
1395 $config->value = $value;
1396 $DB->insert_record('config_plugins', $config, false);
6fd511eb 1397 }
a4080313 1398 }
007bfe8b 1399 cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
a4080313 1400 }
5e2f308b 1401
1402 return true;
a4080313 1403}
1404
1405/**
e1ecf0a0 1406 * Get configuration values from the global config table
a4080313 1407 * or the config_plugins table.
1408 *
13daf6a2 1409 * If called with one parameter, it will load all the config
12bb0c3e 1410 * variables for one plugin, and return them as an object.
13daf6a2 1411 *
12bb0c3e
PS
1412 * If called with 2 parameters it will return a string single
1413 * value or false if the value is not found.
9220fba5 1414 *
08b51dd0
JO
1415 * NOTE: this function is called from lib/db/upgrade.php
1416 *
ac7af0da 1417 * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
e0d9b7c0 1418 * that we need only fetch it once per request.
12bb0c3e 1419 * @param string $plugin full component name
ac7af0da 1420 * @param string $name default null
07ab0c80 1421 * @return mixed hash-like object or single value, return false no config found
ac7af0da 1422 * @throws dml_exception
a4080313 1423 */
ac7af0da 1424function get_config($plugin, $name = null) {
ae040d4b 1425 global $CFG, $DB;
dfc9ba9b 1426
e0d9b7c0
SH
1427 static $siteidentifier = null;
1428
007bfe8b
SH
1429 if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1430 $forced =& $CFG->config_php_settings;
1431 $iscore = true;
1432 $plugin = 'core';
1433 } else {
1434 if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1435 $forced =& $CFG->forced_plugin_settings[$plugin];
1436 } else {
1437 $forced = array();
1438 }
1439 $iscore = false;
12bb0c3e
PS
1440 }
1441
e0d9b7c0
SH
1442 if ($siteidentifier === null) {
1443 try {
1444 // This may fail during installation.
1445 // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1446 // install the database.
1447 $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1448 } catch (dml_exception $ex) {
e0d9b7c0
SH
1449 // Set siteidentifier to false. We don't want to trip this continually.
1450 $siteidentifier = false;
1451 throw $ex;
1452 }
1453 }
1454
1455 if (!empty($name)) {
1456 if (array_key_exists($name, $forced)) {
1457 return (string)$forced[$name];
1458 } else if ($name === 'siteidentifier' && $plugin == 'core') {
1459 return $siteidentifier;
1460 }
007bfe8b
SH
1461 }
1462
1463 $cache = cache::make('core', 'config');
1464 $result = $cache->get($plugin);
d0749719 1465 if ($result === false) {
ac7af0da 1466 // The user is after a recordset.
007bfe8b 1467 if (!$iscore) {
ac7af0da 1468 $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
a4080313 1469 } else {
ac7af0da 1470 // This part is not really used any more, but anyway...
007bfe8b 1471 $result = $DB->get_records_menu('config', array(), '', 'name,value');;
a4080313 1472 }
007bfe8b 1473 $cache->set($plugin, $result);
a4080313 1474 }
1475
007bfe8b
SH
1476 if (!empty($name)) {
1477 if (array_key_exists($name, $result)) {
1478 return $result[$name];
bfb82da3 1479 }
007bfe8b
SH
1480 return false;
1481 }
e1ecf0a0 1482
e0d9b7c0
SH
1483 if ($plugin === 'core') {
1484 $result['siteidentifier'] = $siteidentifier;
1485 }
1486
007bfe8b
SH
1487 foreach ($forced as $key => $value) {
1488 if (is_null($value) or is_array($value) or is_object($value)) {
ac7af0da 1489 // We do not want any extra mess here, just real settings that could be saved in db.
007bfe8b
SH
1490 unset($result[$key]);
1491 } else {
ac7af0da 1492 // Convert to string as if it went through the DB.
007bfe8b 1493 $result[$key] = (string)$value;
12bb0c3e 1494 }
39917a09 1495 }
007bfe8b
SH
1496
1497 return (object)$result;
39917a09 1498}
1499
b0270f84 1500/**
ac7af0da 1501 * Removes a key from global configuration.
b0270f84 1502 *
08b51dd0
JO
1503 * NOTE: this function is called from lib/db/upgrade.php
1504 *
b0270f84 1505 * @param string $name the key to set
1506 * @param string $plugin (optional) the plugin scope
4b600aa0 1507 * @return boolean whether the operation succeeded.
b0270f84 1508 */
ac7af0da 1509function unset_config($name, $plugin=null) {
ae040d4b 1510 global $CFG, $DB;
b0270f84 1511
b0270f84 1512 if (empty($plugin)) {
4b600aa0 1513 unset($CFG->$name);
ac7af0da 1514 $DB->delete_records('config', array('name' => $name));
007bfe8b 1515 cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
5e623a33 1516 } else {
ac7af0da 1517 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
007bfe8b 1518 cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
b0270f84 1519 }
013376de 1520
1521 return true;
b0270f84 1522}
1523
4b600aa0 1524/**
1525 * Remove all the config variables for a given plugin.
ac7af0da 1526 *
c2ca2d8e 1527 * NOTE: this function is called from lib/db/upgrade.php
4b600aa0 1528 *
1529 * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1530 * @return boolean whether the operation succeeded.
1531 */
1532function unset_all_config_for_plugin($plugin) {
1533 global $DB;
ac7af0da 1534 // Delete from the obvious config_plugins first.
013376de 1535 $DB->delete_records('config_plugins', array('plugin' => $plugin));
ac7af0da 1536 // Next delete any suspect settings from config.
a4193166
PS
1537 $like = $DB->sql_like('name', '?', true, true, false, '|');
1538 $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1539 $DB->delete_records_select('config', $like, $params);
007bfe8b
SH
1540 // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1541 cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1542
013376de 1543 return true;
4b600aa0 1544}
1545
4413941f 1546/**
efb8c375 1547 * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
adf176d7
PS
1548 *
1549 * All users are verified if they still have the necessary capability.
1550 *
b3d960e6 1551 * @param string $value the value of the config setting.
4413941f 1552 * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
ac7af0da 1553 * @param bool $includeadmins include administrators.
4413941f 1554 * @return array of user objects.
1555 */
adf176d7 1556function get_users_from_config($value, $capability, $includeadmins = true) {
adf176d7
PS
1557 if (empty($value) or $value === '$@NONE@$') {
1558 return array();
4413941f 1559 }
adf176d7 1560
ac7af0da 1561 // We have to make sure that users still have the necessary capability,
adf176d7 1562 // it should be faster to fetch them all first and then test if they are present
ac7af0da 1563 // instead of validating them one-by-one.
b0c6dc1c 1564 $users = get_users_by_capability(context_system::instance(), $capability);
adf176d7
PS
1565 if ($includeadmins) {
1566 $admins = get_admins();
1567 foreach ($admins as $admin) {
1568 $users[$admin->id] = $admin;
1569 }
1570 }
1571
1572 if ($value === '$@ALL@$') {
1573 return $users;
1574 }
1575
ac7af0da 1576 $result = array(); // Result in correct order.
adf176d7
PS
1577 $allowed = explode(',', $value);
1578 foreach ($allowed as $uid) {
1579 if (isset($users[$uid])) {
1580 $user = $users[$uid];
1581 $result[$user->id] = $user;
1582 }
1583 }
1584
1585 return $result;
4413941f 1586}
1587
f87eab7e
PS
1588
1589/**
ac7af0da 1590 * Invalidates browser caches and cached data in temp.
52642d0d
SH
1591 *
1592 * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
ac7af0da 1593 * {@link phpunit_util::reset_dataroot()}
52642d0d 1594 *
f87eab7e
PS
1595 * @return void
1596 */
1597function purge_all_caches() {
d79d5ac2 1598 global $CFG, $DB;
f87eab7e 1599
f87eab7e
PS
1600 reset_text_filters_cache();
1601 js_reset_all_caches();
1602 theme_reset_all_caches();
1603 get_string_manager()->reset_caches();
2f1e464a 1604 core_text::reset_caches();
e87214bd
PS
1605 if (class_exists('core_plugin_manager')) {
1606 core_plugin_manager::reset_caches();
bde002b8 1607 }
f87eab7e 1608
299cfee5
MG
1609 // Bump up cacherev field for all courses.
1610 try {
1611 increment_revision_number('course', 'cacherev', '');
1612 } catch (moodle_exception $e) {
1613 // Ignore exception since this function is also called before upgrade script when field course.cacherev does not exist yet.
1614 }
1615
d79d5ac2 1616 $DB->reset_caches();
d6a1f63b
SH
1617 cache_helper::purge_all();
1618
ac7af0da 1619 // Purge all other caches: rss, simplepie, etc.
365bec4c 1620 remove_dir($CFG->cachedir.'', true);
f87eab7e 1621
ac7af0da 1622 // Make sure cache dir is writable, throws exception if not.
5a87c912 1623 make_cache_directory('');
f87eab7e 1624
85b38061
PS
1625 // This is the only place where we purge local caches, we are only adding files there.
1626 // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1627 remove_dir($CFG->localcachedir, true);
1628 set_config('localcachedirpurged', time());
1629 make_localcache_directory('', true);
309ae892 1630 \core\task\manager::clear_static_caches();
f87eab7e
PS
1631}
1632
bafd7e78 1633/**
1634 * Get volatile flags
1635 *
1636 * @param string $type
ac7af0da
SH
1637 * @param int $changedsince default null
1638 * @return array records array
bafd7e78 1639 */
ac7af0da 1640function get_cache_flags($type, $changedsince = null) {
ae040d4b 1641 global $DB;
bafd7e78 1642
ac7af0da 1643 $params = array('type' => $type, 'expiry' => time());
ae040d4b 1644 $sqlwhere = "flagtype = :type AND expiry >= :expiry";
ac7af0da 1645 if ($changedsince !== null) {
ae040d4b 1646 $params['changedsince'] = $changedsince;
1647 $sqlwhere .= " AND timemodified > :changedsince";
bafd7e78 1648 }
1649 $cf = array();
ae040d4b 1650 if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
bafd7e78 1651 foreach ($flags as $flag) {
1652 $cf[$flag->name] = $flag->value;
1653 }
1654 }
1655 return $cf;
1656}
1657
a489cf72 1658/**
1659 * Get volatile flags
1660 *
1661 * @param string $type
1662 * @param string $name
ac7af0da
SH
1663 * @param int $changedsince default null
1664 * @return string|false The cache flag value or false
a489cf72 1665 */
ac7af0da 1666function get_cache_flag($type, $name, $changedsince=null) {
ae040d4b 1667 global $DB;
a489cf72 1668
ac7af0da 1669 $params = array('type' => $type, 'name' => $name, 'expiry' => time());
a489cf72 1670
ae040d4b 1671 $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
ac7af0da 1672 if ($changedsince !== null) {
ae040d4b 1673 $params['changedsince'] = $changedsince;
1674 $sqlwhere .= " AND timemodified > :changedsince";
a489cf72 1675 }
ae040d4b 1676
1677 return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
a489cf72 1678}
bafd7e78 1679
1680/**
1681 * Set a volatile flag
1682 *
1683 * @param string $type the "type" namespace for the key
1684 * @param string $name the key to set
ac7af0da 1685 * @param string $value the value to set (without magic quotes) - null will remove the flag
bafd7e78 1686 * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
0d0a8bf6 1687 * @return bool Always returns true
bafd7e78 1688 */
ac7af0da 1689function set_cache_flag($type, $name, $value, $expiry = null) {
ae040d4b 1690 global $DB;
bafd7e78 1691
1692 $timemodified = time();
ac7af0da 1693 if ($expiry === null || $expiry < $timemodified) {
bafd7e78 1694 $expiry = $timemodified + 24 * 60 * 60;
1695 } else {
1696 $expiry = (int)$expiry;
1697 }
1698
ac7af0da
SH
1699 if ($value === null) {
1700 unset_cache_flag($type, $name);
013376de 1701 return true;
bafd7e78 1702 }
1703
ac7af0da
SH
1704 if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1705 // This is a potential problem in DEBUG_DEVELOPER.
128f0984 1706 if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
ac7af0da 1707 return true; // No need to update.
128f0984 1708 }
ae040d4b 1709 $f->value = $value;
bafd7e78 1710 $f->expiry = $expiry;
1711 $f->timemodified = $timemodified;
013376de 1712 $DB->update_record('cache_flags', $f);
bafd7e78 1713 } else {
365a5941 1714 $f = new stdClass();
bafd7e78 1715 $f->flagtype = $type;
1716 $f->name = $name;
ae040d4b 1717 $f->value = $value;
bafd7e78 1718 $f->expiry = $expiry;
1719 $f->timemodified = $timemodified;
013376de 1720 $DB->insert_record('cache_flags', $f);
bafd7e78 1721 }
013376de 1722 return true;
bafd7e78 1723}
1724
1725/**
1726 * Removes a single volatile flag
1727 *
1728 * @param string $type the "type" namespace for the key
1729 * @param string $name the key to set
bafd7e78 1730 * @return bool
1731 */
1732function unset_cache_flag($type, $name) {
ae040d4b 1733 global $DB;
ac7af0da 1734 $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
013376de 1735 return true;
bafd7e78 1736}
1737
1738/**
1739 * Garbage-collect volatile flags
1740 *
0d0a8bf6 1741 * @return bool Always returns true
bafd7e78 1742 */
1743function gc_cache_flags() {
ae040d4b 1744 global $DB;
013376de 1745 $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1746 return true;
bafd7e78 1747}
a4080313 1748
ac7af0da 1749// USER PREFERENCE API.
2660377f 1750
7cf1c7bd 1751/**
39461de3
PS
1752 * Refresh user preference cache. This is used most often for $USER
1753 * object that is stored in session, but it also helps with performance in cron script.
0d0a8bf6 1754 *
39461de3
PS
1755 * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1756 *
4d6b40a0
GGC
1757 * @package core
1758 * @category preference
1759 * @access public
1760 * @param stdClass $user User object. Preferences are preloaded into 'preference' property
1761 * @param int $cachelifetime Cache life time on the current page (in seconds)
1762 * @throws coding_exception
1763 * @return null
7cf1c7bd 1764 */
39461de3
PS
1765function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1766 global $DB;
ac7af0da
SH
1767 // Static cache, we need to check on each page load, not only every 2 minutes.
1768 static $loadedusers = array();
2660377f 1769
39461de3
PS
1770 if (!isset($user->id)) {
1771 throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1772 }
2660377f 1773
39461de3 1774 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1775 // No permanent storage for not-logged-in users and guest.
39461de3
PS
1776 if (!isset($user->preference)) {
1777 $user->preference = array();
2660377f 1778 }
39461de3 1779 return;
2660377f 1780 }
70812e39 1781
39461de3 1782 $timenow = time();
070e2616 1783
39461de3
PS
1784 if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1785 // Already loaded at least once on this page. Are we up to date?
1786 if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
ac7af0da 1787 // No need to reload - we are on the same page and we loaded prefs just a moment ago.
39461de3 1788 return;
70812e39 1789
39461de3 1790 } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
ac7af0da 1791 // No change since the lastcheck on this page.
39461de3
PS
1792 $user->preference['_lastloaded'] = $timenow;
1793 return;
70812e39 1794 }
c6d15803 1795 }
346c3e2f 1796
ac7af0da 1797 // OK, so we have to reload all preferences.
39461de3 1798 $loadedusers[$user->id] = true;
ac7af0da 1799 $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
39461de3 1800 $user->preference['_lastloaded'] = $timenow;
2660377f 1801}
1802
1803/**
ac7af0da 1804 * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
39461de3
PS
1805 *
1806 * NOTE: internal function, do not call from other code.
0d0a8bf6 1807 *
4d6b40a0 1808 * @package core
ac7af0da
SH
1809 * @access private
1810 * @param integer $userid the user whose prefs were changed.
2660377f 1811 */
1812function mark_user_preferences_changed($userid) {
39461de3
PS
1813 global $CFG;
1814
1815 if (empty($userid) or isguestuser($userid)) {
ac7af0da 1816 // No cache flags for guest and not-logged-in users.
39461de3 1817 return;
2660377f 1818 }
39461de3 1819
2660377f 1820 set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
70812e39 1821}
1822
7cf1c7bd 1823/**
39461de3 1824 * Sets a preference for the specified user.
0d0a8bf6 1825 *
4d6b40a0 1826 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
0d0a8bf6 1827 *
4d6b40a0
GGC
1828 * @package core
1829 * @category preference
1830 * @access public
1831 * @param string $name The key to set as preference for the specified user
1832 * @param string $value The value to set for the $name key in the specified user's
1833 * record, null means delete current value.
1834 * @param stdClass|int|null $user A moodle user object or id, null means current user
1835 * @throws coding_exception
1836 * @return bool Always true or exception
7cf1c7bd 1837 */
39461de3 1838function set_user_preference($name, $value, $user = null) {
ae040d4b 1839 global $USER, $DB;
70812e39 1840
39461de3
PS
1841 if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1842 throw new coding_exception('Invalid preference name in set_user_preference() call');
70812e39 1843 }
1844
39461de3 1845 if (is_null($value)) {
ac7af0da 1846 // Null means delete current.
39461de3
PS
1847 return unset_user_preference($name, $user);
1848 } else if (is_object($value)) {
1849 throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1850 } else if (is_array($value)) {
1851 throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1852 }
ac7af0da 1853 // Value column maximum length is 1333 characters.
39461de3 1854 $value = (string)$value;
2f1e464a 1855 if (core_text::strlen($value) > 1333) {
8e54ce97
AD
1856 throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1857 }
39461de3
PS
1858
1859 if (is_null($user)) {
1860 $user = $USER;
1861 } else if (isset($user->id)) {
ac7af0da 1862 // It is a valid object.
39461de3 1863 } else if (is_numeric($user)) {
ac7af0da 1864 $user = (object)array('id' => (int)$user);
346c3e2f 1865 } else {
39461de3 1866 throw new coding_exception('Invalid $user parameter in set_user_preference() call');
346c3e2f 1867 }
1868
39461de3
PS
1869 check_user_preferences_loaded($user);
1870
1871 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1872 // No permanent storage for not-logged-in users and guest.
39461de3
PS
1873 $user->preference[$name] = $value;
1874 return true;
1875 }
346c3e2f 1876
ac7af0da 1877 if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
39461de3 1878 if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
ac7af0da 1879 // Preference already set to this value.
a1244706 1880 return true;
1881 }
ac7af0da 1882 $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
70812e39 1883
1884 } else {
365a5941 1885 $preference = new stdClass();
39461de3 1886 $preference->userid = $user->id;
ae040d4b 1887 $preference->name = $name;
39461de3 1888 $preference->value = $value;
013376de 1889 $DB->insert_record('user_preferences', $preference);
2660377f 1890 }
1891
ac7af0da 1892 // Update value in cache.
39461de3
PS
1893 $user->preference[$name] = $value;
1894
ac7af0da 1895 // Set reload flag for other sessions.
39461de3 1896 mark_user_preferences_changed($user->id);
346c3e2f 1897
013376de 1898 return true;
2660377f 1899}
1900
1901/**
1902 * Sets a whole array of preferences for the current user
0d0a8bf6 1903 *
4d6b40a0 1904 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
39461de3 1905 *
4d6b40a0
GGC
1906 * @package core
1907 * @category preference
1908 * @access public
1909 * @param array $prefarray An array of key/value pairs to be set
1910 * @param stdClass|int|null $user A moodle user object or id, null means current user
1911 * @return bool Always true or exception
2660377f 1912 */
39461de3 1913function set_user_preferences(array $prefarray, $user = null) {
2660377f 1914 foreach ($prefarray as $name => $value) {
39461de3 1915 set_user_preference($name, $value, $user);
2660377f 1916 }
013376de 1917 return true;
70812e39 1918}
1919
6eb3e776 1920/**
1921 * Unsets a preference completely by deleting it from the database
0d0a8bf6 1922 *
4d6b40a0 1923 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
0d0a8bf6 1924 *
4d6b40a0
GGC
1925 * @package core
1926 * @category preference
1927 * @access public
1928 * @param string $name The key to unset as preference for the specified user
1929 * @param stdClass|int|null $user A moodle user object or id, null means current user
1930 * @throws coding_exception
1931 * @return bool Always true or exception
6eb3e776 1932 */
39461de3 1933function unset_user_preference($name, $user = null) {
ae040d4b 1934 global $USER, $DB;
6eb3e776 1935
39461de3
PS
1936 if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1937 throw new coding_exception('Invalid preference name in unset_user_preference() call');
1938 }
1939
1940 if (is_null($user)) {
1941 $user = $USER;
1942 } else if (isset($user->id)) {
ac7af0da 1943 // It is a valid object.
39461de3 1944 } else if (is_numeric($user)) {
ac7af0da 1945 $user = (object)array('id' => (int)$user);
346c3e2f 1946 } else {
39461de3 1947 throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
346c3e2f 1948 }
1949
39461de3 1950 check_user_preferences_loaded($user);
013376de 1951
39461de3 1952 if (empty($user->id) or isguestuser($user->id)) {
ac7af0da 1953 // No permanent storage for not-logged-in user and guest.
39461de3
PS
1954 unset($user->preference[$name]);
1955 return true;
70812e39 1956 }
1957
ac7af0da
SH
1958 // Delete from DB.
1959 $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
39461de3 1960
ac7af0da 1961 // Delete the preference from cache.
39461de3
PS
1962 unset($user->preference[$name]);
1963
ac7af0da 1964 // Set reload flag for other sessions.
39461de3
PS
1965 mark_user_preferences_changed($user->id);
1966
013376de 1967 return true;
70812e39 1968}
1969
7cf1c7bd 1970/**
0d0a8bf6 1971 * Used to fetch user preference(s)
1972 *
7cf1c7bd 1973 * If no arguments are supplied this function will return
361855e6 1974 * all of the current user preferences as an array.
0d0a8bf6 1975 *
7cf1c7bd 1976 * If a name is specified then this function
1977 * attempts to return that particular preference value. If
1978 * none is found, then the optional value $default is returned,
ac7af0da 1979 * otherwise null.
0d0a8bf6 1980 *
4d6b40a0 1981 * If a $user object is submitted it's 'preference' property is used for the preferences cache.
39461de3 1982 *
4d6b40a0
GGC
1983 * @package core
1984 * @category preference
1985 * @access public
1986 * @param string $name Name of the key to use in finding a preference value
1987 * @param mixed|null $default Value to be returned if the $name key is not set in the user preferences
1988 * @param stdClass|int|null $user A moodle user object or id, null means current user
1989 * @throws coding_exception
1990 * @return string|mixed|null A string containing the value of a single preference. An
1991 * array with all of the preferences or null
7cf1c7bd 1992 */
39461de3
PS
1993function get_user_preferences($name = null, $default = null, $user = null) {
1994 global $USER;
70812e39 1995
39461de3 1996 if (is_null($name)) {
ac7af0da 1997 // All prefs.
39461de3
PS
1998 } else if (is_numeric($name) or $name === '_lastloaded') {
1999 throw new coding_exception('Invalid preference name in get_user_preferences() call');
2000 }
346c3e2f 2001
39461de3
PS
2002 if (is_null($user)) {
2003 $user = $USER;
2004 } else if (isset($user->id)) {
ac7af0da 2005 // Is a valid object.
39461de3 2006 } else if (is_numeric($user)) {
ac7af0da 2007 $user = (object)array('id' => (int)$user);
39461de3
PS
2008 } else {
2009 throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
2010 }
2011
2012 check_user_preferences_loaded($user);
346c3e2f 2013
39461de3 2014 if (empty($name)) {
ac7af0da
SH
2015 // All values.
2016 return $user->preference;
39461de3 2017 } else if (isset($user->preference[$name])) {
ac7af0da
SH
2018 // The single string value.
2019 return $user->preference[$name];
346c3e2f 2020 } else {
ac7af0da
SH
2021 // Default value (null if not specified).
2022 return $default;
70812e39 2023 }
70812e39 2024}
2025
ac7af0da 2026// FUNCTIONS FOR HANDLING TIME.
39917a09 2027
7cf1c7bd 2028/**
c6d15803 2029 * Given date parts in user time produce a GMT timestamp.
7cf1c7bd 2030 *
9df12115
RT
2031 * @package core
2032 * @category time
68fbd8e1 2033 * @param int $year The year part to create timestamp of
2034 * @param int $month The month part to create timestamp of
2035 * @param int $day The day part to create timestamp of
2036 * @param int $hour The hour part to create timestamp of
2037 * @param int $minute The minute part to create timestamp of
2038 * @param int $second The second part to create timestamp of
9df12115
RT
2039 * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2040 * if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
6a0bf5c4
RT
2041 * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2042 * applied only if timezone is 99 or string.
9df12115 2043 * @return int GMT timestamp
7cf1c7bd 2044 */
9f1f6daf 2045function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
d6e7a63d
PS
2046 $date = new DateTime('now', core_date::get_user_timezone_object($timezone));
2047 $date->setDate((int)$year, (int)$month, (int)$day);
2048 $date->setTime((int)$hour, (int)$minute, (int)$second);
39917a09 2049
d6e7a63d 2050 $time = $date->getTimestamp();
33998d30 2051
d6e7a63d
PS
2052 // Moodle BC DST stuff.
2053 if (!$applydst) {
2054 $time += dst_offset_on($time, $timezone);
9f1f6daf 2055 }
2056
196f2619 2057 return $time;
85cafb3e 2058
39917a09 2059}
2060
7cf1c7bd 2061/**
0d0a8bf6 2062 * Format a date/time (seconds) as weeks, days, hours etc as needed
2063 *
7cf1c7bd 2064 * Given an amount of time in seconds, returns string
5602f7cf 2065 * formatted nicely as weeks, days, hours etc as needed
7cf1c7bd 2066 *
9df12115
RT
2067 * @package core
2068 * @category time
2f87145b 2069 * @uses MINSECS
2070 * @uses HOURSECS
2071 * @uses DAYSECS
5602f7cf 2072 * @uses YEARSECS
0d0a8bf6 2073 * @param int $totalsecs Time in seconds
ac7af0da 2074 * @param stdClass $str Should be a time object
0d0a8bf6 2075 * @return string A nicely formatted date/time string
7cf1c7bd 2076 */
ac7af0da 2077function format_time($totalsecs, $str = null) {
c7e3ac2a 2078
6b174680 2079 $totalsecs = abs($totalsecs);
c7e3ac2a 2080
ac7af0da
SH
2081 if (!$str) {
2082 // Create the str structure the slow way.
b85b25eb 2083 $str = new stdClass();
b0ccd3fb 2084 $str->day = get_string('day');
2085 $str->days = get_string('days');
2086 $str->hour = get_string('hour');
2087 $str->hours = get_string('hours');
2088 $str->min = get_string('min');
2089 $str->mins = get_string('mins');
2090 $str->sec = get_string('sec');
2091 $str->secs = get_string('secs');
5602f7cf 2092 $str->year = get_string('year');
2093 $str->years = get_string('years');
8dbed6be 2094 }
2095
5602f7cf 2096 $years = floor($totalsecs/YEARSECS);
2097 $remainder = $totalsecs - ($years*YEARSECS);
5602f7cf 2098 $days = floor($remainder/DAYSECS);
7a5672c9 2099 $remainder = $totalsecs - ($days*DAYSECS);
2100 $hours = floor($remainder/HOURSECS);
2101 $remainder = $remainder - ($hours*HOURSECS);
2102 $mins = floor($remainder/MINSECS);
2103 $secs = $remainder - ($mins*MINSECS);
8dbed6be 2104
2105 $ss = ($secs == 1) ? $str->sec : $str->secs;
2106 $sm = ($mins == 1) ? $str->min : $str->mins;
2107 $sh = ($hours == 1) ? $str->hour : $str->hours;
2108 $sd = ($days == 1) ? $str->day : $str->days;
5602f7cf 2109 $sy = ($years == 1) ? $str->year : $str->years;
8dbed6be 2110
5602f7cf 2111 $oyears = '';
b0ccd3fb 2112 $odays = '';
2113 $ohours = '';
2114 $omins = '';
2115 $osecs = '';
9c9f7d77 2116
ac7af0da
SH
2117 if ($years) {
2118 $oyears = $years .' '. $sy;
2119 }
2120 if ($days) {
2121 $odays = $days .' '. $sd;
2122 }
2123 if ($hours) {
2124 $ohours = $hours .' '. $sh;
2125 }
2126 if ($mins) {
2127 $omins = $mins .' '. $sm;
2128 }
2129 if ($secs) {
2130 $osecs = $secs .' '. $ss;
2131 }
2132
2133 if ($years) {
2134 return trim($oyears .' '. $odays);
2135 }
2136 if ($days) {
2137 return trim($odays .' '. $ohours);
2138 }
2139 if ($hours) {
2140 return trim($ohours .' '. $omins);
2141 }
2142 if ($mins) {
2143 return trim($omins .' '. $osecs);
2144 }
2145 if ($secs) {
2146 return $osecs;
2147 }
b0ccd3fb 2148 return get_string('now');
6b174680 2149}
f9903ed0 2150
7cf1c7bd 2151/**
f59ab4ad 2152 * Returns a formatted string that represents a date in user time.
7cf1c7bd 2153 *
9df12115
RT
2154 * @package core
2155 * @category time
0a0cf09a 2156 * @param int $date the timestamp in UTC, as obtained from the database.
2157 * @param string $format strftime format. You should probably get this using
9df12115 2158 * get_string('strftime...', 'langconfig');
f59ab4ad 2159 * @param int|float|string $timezone by default, uses the user's time zone. if numeric and
9df12115
RT
2160 * not 99 then daylight saving will not be added.
2161 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
0a0cf09a 2162 * @param bool $fixday If true (default) then the leading zero from %d is removed.
9df12115 2163 * If false then the leading zero is maintained.
d9498b38 2164 * @param bool $fixhour If true (default) then the leading zero from %I is removed.
0a0cf09a 2165 * @return string the formatted date/time.
7cf1c7bd 2166 */
d9498b38 2167function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
6eafa4dd 2168 $calendartype = \core_calendar\type_factory::get_calendar_instance();
f59ab4ad 2169 return $calendartype->timestamp_to_date_string($date, $format, $timezone, $fixday, $fixhour);
873960de 2170}
2171
15396bba
FM
2172/**
2173 * Returns a formatted date ensuring it is UTF-8.
2174 *
2175 * If we are running under Windows convert to Windows encoding and then back to UTF-8
2176 * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2177 *
d6e7a63d 2178 * @param int $date the timestamp - since Moodle 2.9 this is a real UTC timestamp
15396bba 2179 * @param string $format strftime format.
d6e7a63d 2180 * @param int|float|string $tz the user timezone
15396bba 2181 * @return string the formatted date/time.
5bcfd504 2182 * @since Moodle 2.3.3
15396bba
FM
2183 */
2184function date_format_string($date, $format, $tz = 99) {
2185 global $CFG;
d61d3e82
RT
2186
2187 $localewincharset = null;
2188 // Get the calendar type user is using.
2189 if ($CFG->ostype == 'WINDOWS') {
2190 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2191 $localewincharset = $calendartype->locale_win_charset();
2192 }
2193
d6e7a63d
PS
2194 if ($localewincharset) {
2195 $format = core_text::convert($format, 'utf-8', $localewincharset);
2196 }
2197
2198 date_default_timezone_set(core_date::get_user_timezone($tz));
2199 $datestring = strftime($format, $date);
2200 core_date::set_default_server_timezone();
2201
2202 if ($localewincharset) {
2203 $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
15396bba 2204 }
d6e7a63d 2205
15396bba
FM
2206 return $datestring;
2207}
2208
7cf1c7bd 2209/**
deed22ea
MN
2210 * Given a $time timestamp in GMT (seconds since epoch),
2211 * returns an array that represents the date in user time
7cf1c7bd 2212 *
9df12115
RT
2213 * @package core
2214 * @category time
deed22ea 2215 * @param int $time Timestamp in GMT
d6e7a63d 2216 * @param float|int|string $timezone user timezone
deed22ea 2217 * @return array An array that represents the date in user time
7cf1c7bd 2218 */
deed22ea 2219function usergetdate($time, $timezone=99) {
d6e7a63d
PS
2220 date_default_timezone_set(core_date::get_user_timezone($timezone));
2221 $result = getdate($time);
2222 core_date::set_default_server_timezone();
deed22ea 2223
d6e7a63d 2224 return $result;
d552ead0 2225}
2226
7cf1c7bd 2227/**
2228 * Given a GMT timestamp (seconds since epoch), offsets it by
2229 * the timezone. eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2230 *
d6e7a63d
PS
2231 * NOTE: this function does not include DST properly,
2232 * you should use the PHP date stuff instead!
2233 *
9df12115
RT
2234 * @package core
2235 * @category time
9df12115 2236 * @param int $date Timestamp in GMT
d6e7a63d 2237 * @param float|int|string $timezone user timezone
c6d15803 2238 * @return int
7cf1c7bd 2239 */
d552ead0 2240function usertime($date, $timezone=99) {
d6e7a63d
PS
2241 $userdate = new DateTime('@' . $date);
2242 $userdate->setTimezone(core_date::get_user_timezone_object($timezone));
2243 $dst = dst_offset_on($date, $timezone);
a36166d3 2244
d6e7a63d 2245 return $date - $userdate->getOffset() + $dst;
d552ead0 2246}
2247
8c3dba73 2248/**
2249 * Given a time, return the GMT timestamp of the most recent midnight
2250 * for the current user.
2251 *
9df12115
RT
2252 * @package core
2253 * @category time
e34d817e 2254 * @param int $date Timestamp in GMT
d6e7a63d 2255 * @param float|int|string $timezone user timezone
0d0a8bf6 2256 * @return int Returns a GMT timestamp
8c3dba73 2257 */
edf7fe8c 2258function usergetmidnight($date, $timezone=99) {
edf7fe8c 2259
edf7fe8c 2260 $userdate = usergetdate($date, $timezone);
4606d9bb 2261
ac7af0da 2262 // Time of midnight of this user's day, in GMT.
02f0527d 2263 return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
edf7fe8c 2264
2265}
2266
7cf1c7bd 2267/**
2268 * Returns a string that prints the user's timezone
2269 *
9df12115
RT
2270 * @package core
2271 * @category time
d6e7a63d 2272 * @param float|int|string $timezone user timezone
7cf1c7bd 2273 * @return string
2274 */
d552ead0 2275function usertimezone($timezone=99) {
d6e7a63d
PS
2276 $tz = core_date::get_user_timezone($timezone);
2277 return core_date::get_localised_timezone($tz);
61460dd6 2278}
2279
bbd3f2c4 2280/**
b2b68362 2281 * Returns a float or a string which denotes the user's timezone
2282 * 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)
2283 * means that for this timezone there are also DST rules to be taken into account
2284 * Checks various settings and picks the most dominant of those which have a value
bbd3f2c4 2285 *
9df12115
RT
2286 * @package core
2287 * @category time
2288 * @param float|int|string $tz timezone to calculate GMT time offset before
2289 * calculating user timezone, 99 is default user timezone
2290 * {@link http://docs.moodle.org/dev/Time_API#Timezone}
2291 * @return float|string
bbd3f2c4 2292 */
e8904995 2293function get_user_timezone($tz = 99) {
2294 global $USER, $CFG;
43b59916 2295
f30fe8d0 2296 $timezones = array(
e8904995 2297 $tz,
2298 isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
43b59916 2299 isset($USER->timezone) ? $USER->timezone : 99,
2300 isset($CFG->timezone) ? $CFG->timezone : 99,
f30fe8d0 2301 );
43b59916 2302
e8904995 2303 $tz = 99;
43b59916 2304
ac7af0da
SH
2305 // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2306 while (((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
e8904995 2307 $tz = $next['value'];
43b59916 2308 }
e8904995 2309 return is_numeric($tz) ? (float) $tz : $tz;
43b59916 2310}
2311
0d0a8bf6 2312/**
efb8c375 2313 * Calculates the Daylight Saving Offset for a given date/time (timestamp)
6a0bf5c4 2314 * - Note: Daylight saving only works for string timezones and not for float.
0d0a8bf6 2315 *
9df12115
RT
2316 * @package core
2317 * @category time
0d0a8bf6 2318 * @param int $time must NOT be compensated at all, it has to be a pure timestamp
d6e7a63d 2319 * @param int|float|string $strtimezone user timezone
0d0a8bf6 2320 * @return int
2321 */
ac7af0da 2322function dst_offset_on($time, $strtimezone = null) {
d6e7a63d
PS
2323 $tz = core_date::get_user_timezone($strtimezone);
2324 $date = new DateTime('@' . $time);
2325 $date->setTimezone(new DateTimeZone($tz));
2326 if ($date->format('I') == '1') {
2327 if ($tz === 'Australia/Lord_Howe') {
2328 return 1800;
c9e72798 2329 }
d6e7a63d 2330 return 3600;
c9e72798 2331 }
d6e7a63d 2332 return 0;
85cafb3e 2333}
02f0527d 2334
0d0a8bf6 2335/**
9df12115 2336 * Calculates when the day appears in specific month
0d0a8bf6 2337 *
9df12115
RT
2338 * @package core
2339 * @category time
2340 * @param int $startday starting day of the month
2341 * @param int $weekday The day when week starts (normally taken from user preferences)
2342 * @param int $month The month whose day is sought
2343 * @param int $year The year of the month whose day is sought
0d0a8bf6 2344 * @return int
2345 */
28902d99 2346function find_day_in_month($startday, $weekday, $month, $year) {
da304137 2347 $calendartype = \core_calendar\type_factory::get_calendar_instance();
8dc3f6cf 2348
2349 $daysinmonth = days_in_month($month, $year);
da304137 2350 $daysinweek = count($calendartype->get_weekdays());
8dc3f6cf 2351
ac7af0da 2352 if ($weekday == -1) {
28902d99 2353 // Don't care about weekday, so return:
2354 // abs($startday) if $startday != -1
ac7af0da 2355 // $daysinmonth otherwise.
28902d99 2356 return ($startday == -1) ? $daysinmonth : abs($startday);
8dc3f6cf 2357 }
2358
ac7af0da 2359 // From now on we 're looking for a specific weekday.
ac7af0da
SH
2360 // Give "end of month" its actual value, since we know it.
2361 if ($startday == -1) {
28902d99 2362 $startday = -1 * $daysinmonth;
2363 }
2364
ac7af0da 2365 // Starting from day $startday, the sign is the direction.
ac7af0da 2366 if ($startday < 1) {
28902d99 2367 $startday = abs($startday);
da304137 2368 $lastmonthweekday = dayofweek($daysinmonth, $month, $year);
8dc3f6cf 2369
ac7af0da 2370 // This is the last such weekday of the month.
8dc3f6cf 2371 $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
ac7af0da 2372 if ($lastinmonth > $daysinmonth) {
da304137 2373 $lastinmonth -= $daysinweek;
42d36497 2374 }
8dc3f6cf 2375
ac7af0da
SH
2376 // Find the first such weekday <= $startday.
2377 while ($lastinmonth > $startday) {
da304137 2378 $lastinmonth -= $daysinweek;
42d36497 2379 }
8dc3f6cf 2380
2381 return $lastinmonth;
ac7af0da 2382 } else {
da304137 2383 $indexweekday = dayofweek($startday, $month, $year);
42d36497 2384
8dc3f6cf 2385 $diff = $weekday - $indexweekday;
ac7af0da 2386 if ($diff < 0) {
da304137 2387 $diff += $daysinweek;
42d36497 2388 }
42d36497 2389
ac7af0da 2390 // This is the first such weekday of the month equal to or after $startday.
28902d99 2391 $firstfromindex = $startday + $diff;
42d36497 2392
8dc3f6cf 2393 return $firstfromindex;
8dc3f6cf 2394 }
42d36497 2395}
2396
bbd3f2c4 2397/**
2398 * Calculate the number of days in a given month
2399 *
9df12115
RT
2400 * @package core
2401 * @category time
bbd3f2c4 2402 * @param int $month The month whose day count is sought
2403 * @param int $year The year of the month whose day count is sought
2404 * @return int
2405 */
42d36497 2406function days_in_month($month, $year) {
da304137
MN
2407 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2408 return $calendartype->get_num_days_in_month($year, $month);
42d36497 2409}
2410
bbd3f2c4 2411/**
2412 * Calculate the position in the week of a specific calendar day
2413 *
9df12115
RT
2414 * @package core
2415 * @category time
bbd3f2c4 2416 * @param int $day The day of the date whose position in the week is sought
2417 * @param int $month The month of the date whose position in the week is sought
2418 * @param int $year The year of the date whose position in the week is sought
2419 * @return int
2420 */
8dc3f6cf 2421function dayofweek($day, $month, $year) {
da304137
MN
2422 $calendartype = \core_calendar\type_factory::get_calendar_instance();
2423 return $calendartype->get_weekday($year, $month, $day);
8dc3f6cf 2424}
2425
ac7af0da 2426// USER AUTHENTICATION AND LOGIN.
f9903ed0 2427
93f66983 2428/**
2429 * Returns full login url.
2430 *
93f66983 2431 * @return string login url
2432 */
999b54af 2433function get_login_url() {
93f66983 2434 global $CFG;
2435
999b54af 2436 $url = "$CFG->wwwroot/login/index.php";
93f66983 2437
999b54af
PS
2438 if (!empty($CFG->loginhttps)) {
2439 $url = str_replace('http:', 'https:', $url);
93f66983 2440 }
2441
2442 return $url;
2443}
2444
7cf1c7bd 2445/**
ec81373f 2446 * This function checks that the current user is logged in and has the
2447 * required privileges
2448 *
7cf1c7bd 2449 * This function checks that the current user is logged in, and optionally
ec81373f 2450 * whether they are allowed to be in a particular course and view a particular
2451 * course module.
2452 * If they are not logged in, then it redirects them to the site login unless
d2a9f7cc 2453 * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
ec81373f 2454 * case they are automatically logged in as guests.
2455 * If $courseid is given and the user is not enrolled in that course then the
2456 * user is redirected to the course enrolment page.
efb8c375 2457 * If $cm is given and the course module is hidden and the user is not a teacher
ec81373f 2458 * in the course then the user is redirected to the course home page.
7cf1c7bd 2459 *
191b267b 2460 * When $cm parameter specified, this function sets page layout to 'module'.
4f0c2d00 2461 * You need to change it manually later if some other layout needed.
191b267b 2462 *
f76249cc
PS
2463 * @package core_access
2464 * @category access
2465 *
33ebaf7c 2466 * @param mixed $courseorid id of the course or course object
0d0a8bf6 2467 * @param bool $autologinguest default true
bbd3f2c4 2468 * @param object $cm course module object
f4013c10 2469 * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2470 * true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2471 * in order to keep redirects working properly. MDL-14495
df997f84 2472 * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
0d0a8bf6 2473 * @return mixed Void, exit, and die depending on path
ac7af0da
SH
2474 * @throws coding_exception
2475 * @throws require_login_exception
7cf1c7bd 2476 */
ac7af0da 2477function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
f0202ae9 2478 global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
d8ba183c 2479
f22f1caf
PS
2480 // Must not redirect when byteserving already started.
2481 if (!empty($_SERVER['HTTP_RANGE'])) {
2482 $preventredirect = true;
2483 }
2484
2ed6be87
AN
2485 if (AJAX_SCRIPT) {
2486 // We cannot redirect for AJAX scripts either.
2487 $preventredirect = true;
2488 }
2489
ac7af0da 2490 // Setup global $COURSE, themes, language and locale.
c13a5e71 2491 if (!empty($courseorid)) {
2492 if (is_object($courseorid)) {
2493 $course = $courseorid;
2494 } else if ($courseorid == SITEID) {
2495 $course = clone($SITE);
2496 } else {
74df2951 2497 $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
c13a5e71 2498 }
95d28870 2499 if ($cm) {
df997f84
PS
2500 if ($cm->course != $course->id) {
2501 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2502 }
ac7af0da 2503 // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
47148151 2504 if (!($cm instanceof cm_info)) {
ac7af0da 2505 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
0d8b6a69 2506 // db queries so this is not really a performance concern, however it is obviously
2507 // better if you use get_fast_modinfo to get the cm before calling this.
2508 $modinfo = get_fast_modinfo($course);
2509 $cm = $modinfo->get_cm($cm->id);
2510 }
95d28870 2511 }
e88462a0 2512 } else {
ac7af0da 2513 // Do not touch global $COURSE via $PAGE->set_course(),
df997f84
PS
2514 // the reasons is we need to be able to call require_login() at any time!!
2515 $course = $SITE;
2516 if ($cm) {
2517 throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2518 }
c13a5e71 2519 }
be933850 2520
aa4a6566
SH
2521 // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2522 // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2523 // risk leading the user back to the AJAX request URL.
2524 if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2525 $setwantsurltome = false;
2526 }
2527
12fc11e7 2528 // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2ed6be87
AN
2529 if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !empty($CFG->dbsessions)) {
2530 if ($preventredirect) {
2531 throw new require_login_session_timeout_exception();
2532 } else {
2533 if ($setwantsurltome) {
2534 $SESSION->wantsurl = qualified_me();
2535 }
2536 redirect(get_login_url());
12fc11e7 2537 }
12fc11e7
DM
2538 }
2539
ac7af0da 2540 // If the user is not even logged in yet then make sure they are.
083c3743 2541 if (!isloggedin()) {
df997f84 2542 if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
999b54af 2543 if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
ac7af0da 2544 // Misconfigured site guest, just redirect to login page.
999b54af 2545 redirect(get_login_url());
ac7af0da 2546 exit; // Never reached.
df997f84 2547 }
999b54af 2548 $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
0342fc36 2549 complete_user_login($guest);
d9e07264 2550 $USER->autologinguest = true;
999b54af 2551 $SESSION->lang = $lang;
8a33e371 2552 } else {
ac7af0da 2553 // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
999b54af
PS
2554 if ($preventredirect) {
2555 throw new require_login_exception('You are not logged in');
2556 }
2557
2558 if ($setwantsurltome) {
f0202ae9 2559 $SESSION->wantsurl = qualified_me();
999b54af 2560 }
dcee0b94
SL
2561
2562 $referer = get_local_referer(false);
2563 if (!empty($referer)) {
2564 $SESSION->fromurl = $referer;
999b54af 2565 }
bf08e3f9
BH
2566
2567 // Give auth plugins an opportunity to authenticate or redirect to an external login page
2568 $authsequence = get_enabled_auth_plugins(true); // auths, in sequence
2569 foreach($authsequence as $authname) {
2570 $authplugin = get_auth_plugin($authname);
2571 $authplugin->pre_loginpage_hook();
2572 if (isloggedin()) {
2573 break;
2574 }
2575 }
2576
2577 // If we're still not logged in then go to the login page
2578 if (!isloggedin()) {
2579 redirect(get_login_url());
2580 exit; // Never reached.
2581 }
8a33e371 2582 }
f9903ed0 2583 }
808a3baa 2584
ac7af0da 2585 // Loginas as redirection if needed.
d79d5ac2 2586 if ($course->id != SITEID and \core\session\manager::is_loggedinas()) {
f6f66b03 2587 if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
df997f84 2588 if ($USER->loginascontext->instanceid != $course->id) {
3887fe4a 2589 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
5e623a33 2590 }
f6f66b03 2591 }
2592 }
2593
ac7af0da 2594 // Check whether the user should be changing password (but only if it is REALLY them).
d79d5ac2 2595 if (get_user_preferences('auth_forcepasswordchange') && !\core\session\manager::is_loggedinas()) {
21e2dcd9 2596 $userauth = get_auth_plugin($USER->auth);
df997f84 2597 if ($userauth->can_change_password() and !$preventredirect) {
af572078 2598 if ($setwantsurltome) {
f0202ae9 2599 $SESSION->wantsurl = qualified_me();
af572078 2600 }
80274abf 2601 if ($changeurl = $userauth->change_password_url()) {
ac7af0da 2602 // Use plugin custom url.
80274abf 2603 redirect($changeurl);
1437f0a5 2604 } else {
ac7af0da 2605 // Use moodle internal method.
9696bd89 2606 if (empty($CFG->loginhttps)) {
2607 redirect($CFG->wwwroot .'/login/change_password.php');
2608 } else {
ac7af0da 2609 $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
9696bd89 2610 redirect($wwwroot .'/login/change_password.php');
2611 }
1437f0a5 2612 }
d35757eb 2613 } else {
a8ee7194 2614 print_error('nopasswordchangeforced', 'auth');
d35757eb 2615 }
2616 }
083c3743 2617
ac7af0da 2618 // Check that the user account is properly set up.
808a3baa 2619 if (user_not_fully_set_up($USER)) {
df997f84
PS
2620 if ($preventredirect) {
2621 throw new require_login_exception('User not fully set-up');
2622 }
af572078 2623 if ($setwantsurltome) {
f0202ae9 2624 $SESSION->wantsurl = qualified_me();
af572078 2625 }
b0ccd3fb 2626 redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
808a3baa 2627 }
d8ba183c 2628
df997f84 2629 // Make sure the USER has a sesskey set up. Used for CSRF protection.
04280e85 2630 sesskey();
366dfa60 2631
ac7af0da 2632 // Do not bother admins with any formalities.
df997f84 2633 if (is_siteadmin()) {
1edd3d6f
MG
2634 // Set the global $COURSE.
2635 if ($cm) {
2636 $PAGE->set_cm($cm, $course);
2637 $PAGE->set_pagelayout('incourse');
2638 } else if (!empty($courseorid)) {
2639 $PAGE->set_course($course);
2640 }
ac7af0da 2641 // Set accesstime or the user will appear offline which messes up messaging.
1560760f 2642 user_accesstime_log($course->id);
df997f84
PS
2643 return;
2644 }
2645
ac7af0da 2646 // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
b593d49d
PS
2647 if (!$USER->policyagreed and !is_siteadmin()) {
2648 if (!empty($CFG->sitepolicy) and !isguestuser()) {
2649 if ($preventredirect) {
2650 throw new require_login_exception('Policy not agreed');
2651 }
af572078 2652 if ($setwantsurltome) {
f0202ae9 2653 $SESSION->wantsurl = qualified_me();
af572078 2654 }
b593d49d
PS
2655 redirect($CFG->wwwroot .'/user/policy.php');
2656 } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2657 if ($preventredirect) {
2658 throw new require_login_exception('Policy not agreed');
2659 }
af572078 2660 if ($setwantsurltome) {
f0202ae9 2661 $SESSION->wantsurl = qualified_me();
af572078 2662 }
027a1604 2663 redirect($CFG->wwwroot .'/user/policy.php');
027a1604 2664 }
1695b680 2665 }
2666
ac7af0da 2667 // Fetch the system context, the course context, and prefetch its child contexts.
b0c6dc1c
AG
2668 $sysctx = context_system::instance();
2669 $coursecontext = context_course::instance($course->id, MUST_EXIST);
df997f84 2670 if ($cm) {
b0c6dc1c 2671 $cmcontext = context_module::instance($cm->id, MUST_EXIST);
df997f84
PS
2672 } else {
2673 $cmcontext = null;
2674 }
21e2dcd9 2675
ac7af0da 2676 // If the site is currently under maintenance, then print a message.
4fe2250a 2677 if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
df997f84
PS
2678 if ($preventredirect) {
2679 throw new require_login_exception('Maintenance in progress');
2680 }
2681
4fe2250a 2682 print_maintenance_message();
027a1604 2683 }
2684
ac7af0da 2685 // Make sure the course itself is not hidden.
df997f84 2686 if ($course->id == SITEID) {
ac7af0da 2687 // Frontpage can not be hidden.
df997f84 2688 } else {
f5c1e621 2689 if (is_role_switched($course->id)) {
ac7af0da 2690 // When switching roles ignore the hidden flag - user had to be in course to do the switch.
df997f84
PS
2691 } else {
2692 if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
ac7af0da
SH
2693 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
2694 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
df997f84
PS
2695 if ($preventredirect) {
2696 throw new require_login_exception('Course is hidden');
2697 }
1edd3d6f 2698 $PAGE->set_context(null);
ac7af0da
SH
2699 // We need to override the navigation URL as the course won't have been added to the navigation and thus
2700 // the navigation will mess up when trying to find it.
a0a39b0d 2701 navigation_node::override_active_url(new moodle_url('/'));
df997f84
PS
2702 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2703 }
2704 }
2705 }
2706
ac7af0da 2707 // Is the user enrolled?
df997f84 2708 if ($course->id == SITEID) {
ac7af0da 2709 // Everybody is enrolled on the frontpage.
df997f84 2710 } else {
d79d5ac2 2711 if (\core\session\manager::is_loggedinas()) {
ac7af0da 2712 // Make sure the REAL person can access this course first.
d79d5ac2 2713 $realuser = \core\session\manager::get_realuser();
ac7af0da
SH
2714 if (!is_enrolled($coursecontext, $realuser->id, '', true) and
2715 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
df997f84
PS
2716 if ($preventredirect) {
2717 throw new require_login_exception('Invalid course login-as access');
2718 }
1edd3d6f 2719 $PAGE->set_context(null);
df997f84
PS
2720 echo $OUTPUT->header();
2721 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2722 }
2723 }
2724
df997f84
PS
2725 $access = false;
2726
dbd7282c 2727 if (is_role_switched($course->id)) {
ac7af0da 2728 // Ok, user had to be inside this course before the switch.
dbd7282c
PS
2729 $access = true;
2730
2731 } else if (is_viewing($coursecontext, $USER)) {
ac7af0da 2732 // Ok, no need to mess with enrol.
df997f84
PS
2733 $access = true;
2734
2735 } else {
2736 if (isset($USER->enrol['enrolled'][$course->id])) {
bbfdff34 2737 if ($USER->enrol['enrolled'][$course->id] > time()) {
df997f84 2738 $access = true;
bbfdff34
PS
2739 if (isset($USER->enrol['tempguest'][$course->id])) {
2740 unset($USER->enrol['tempguest'][$course->id]);
2741 remove_temp_course_roles($coursecontext);
2742 }
df997f84 2743 } else {
ac7af0da 2744 // Expired.
df997f84
PS
2745 unset($USER->enrol['enrolled'][$course->id]);
2746 }
2747 }
2748 if (isset($USER->enrol['tempguest'][$course->id])) {
2749 if ($USER->enrol['tempguest'][$course->id] == 0) {
2750 $access = true;
2751 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2752 $access = true;
2753 } else {
ac7af0da 2754 // Expired.
df997f84 2755 unset($USER->enrol['tempguest'][$course->id]);
e922fe23 2756 remove_temp_course_roles($coursecontext);
df997f84
PS
2757 }
2758 }
2759
ac7af0da
SH
2760 if (!$access) {
2761 // Cache not ok.
bbfdff34
PS
2762 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2763 if ($until !== false) {
ac7af0da 2764 // Active participants may always access, a timestamp in the future, 0 (always) or false.
bbfdff34
PS
2765 if ($until == 0) {
2766 $until = ENROL_MAX_TIMESTAMP;
df997f84 2767 }
bbfdff34
PS
2768 $USER->enrol['enrolled'][$course->id] = $until;
2769 $access = true;
2770
2771 } else {
ac7af0da
SH
2772 $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
2773 $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
bbfdff34 2774 $enrols = enrol_get_plugins(true);
ac7af0da
SH
2775 // First ask all enabled enrol instances in course if they want to auto enrol user.
2776 foreach ($instances as $instance) {
df997f84
PS
2777 if (!isset($enrols[$instance->enrol])) {
2778 continue;
2779 }
bbfdff34
PS
2780 // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2781 $until = $enrols[$instance->enrol]->try_autoenrol($instance);
df997f84 2782 if ($until !== false) {
bbfdff34
PS
2783 if ($until == 0) {
2784 $until = ENROL_MAX_TIMESTAMP;
2785 }
2786 $USER->enrol['enrolled'][$course->id] = $until;
df997f84
PS
2787 $access = true;
2788 break;
2789 }
2790 }
ac7af0da 2791 // If not enrolled yet try to gain temporary guest access.
bbfdff34 2792 if (!$access) {
ac7af0da 2793 foreach ($instances as $instance) {
bbfdff34
PS
2794 if (!isset($enrols[$instance->enrol])) {
2795 continue;
2796 }
2797 // Get a duration for the guest access, a timestamp in the future or false.
2798 $until = $enrols[$instance->enrol]->try_guestaccess($instance);
2799 if ($until !== false and $until > time()) {
2800 $USER->enrol['tempguest'][$course->id] = $until;
2801 $access = true;
2802 break;
2803 }
2804 }
2805 }
df997f84
PS
2806 }
2807 }
2808 }
2809
2810 if (!$access) {
2811 if ($preventredirect) {
2812 throw new require_login_exception('Not enrolled');
2813 }
af572078 2814 if ($setwantsurltome) {
f0202ae9 2815 $SESSION->wantsurl = qualified_me();
af572078 2816 }
b3cb7264 2817 redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
df997f84
PS
2818 }
2819 }
2820
061e6b28 2821 // Check visibility of activity to current user; includes visible flag, conditional availability, etc.
0d8b6a69 2822 if ($cm && !$cm->uservisible) {
df997f84
PS
2823 if ($preventredirect) {
2824 throw new require_login_exception('Activity is hidden');
2825 }
ee17c773 2826 if ($course->id != SITEID) {
ac7af0da 2827 $url = new moodle_url('/course/view.php', array('id' => $course->id));
ee17c773
PS
2828 } else {
2829 $url = new moodle_url('/');
2830 }
2831 redirect($url, get_string('activityiscurrentlyhidden'));
df997f84
PS
2832 }
2833
aad5b7f1 2834 // Set the global $COURSE.
2835 if ($cm) {
2836 $PAGE->set_cm($cm, $course);
2837 $PAGE->set_pagelayout('incourse');
2838 } else if (!empty($courseorid)) {
2839 $PAGE->set_course($course);
2840 }
2841
ac7af0da 2842 // Finally access granted, update lastaccess times.
df997f84 2843 user_accesstime_log($course->id);
f9903ed0 2844}
2845
c4d0753b 2846
c4d0753b 2847/**
2848 * This function just makes sure a user is logged out.
2849 *
f76249cc 2850 * @package core_access
ac7af0da 2851 * @category access
c4d0753b 2852 */
2853function require_logout() {
d79d5ac2 2854 global $USER, $DB;
c4d0753b 2855
d79d5ac2
PS
2856 if (!isloggedin()) {
2857 // This should not happen often, no need for hooks or events here.
2858 \core\session\manager::terminate_current();
2859 return;
c4d0753b 2860 }
2861
d79d5ac2 2862 // Execute hooks before action.
f9f9d187 2863 $authplugins = array();
d79d5ac2
PS
2864 $authsequence = get_enabled_auth_plugins();
2865 foreach ($authsequence as $authname) {
f9f9d187
SL
2866 $authplugins[$authname] = get_auth_plugin($authname);
2867 $authplugins[$authname]->prelogout_hook();
d79d5ac2
PS
2868 }
2869
2870 // Store info that gets removed during logout.
2871 $sid = session_id();
bb78e249 2872 $event = \core\event\user_loggedout::create(
d79d5ac2
PS
2873 array(
2874 'userid' => $USER->id,
2875 'objectid' => $USER->id,
2876 'other' => array('sessionid' => $sid),
2877 )
2878 );
2879 if ($session = $DB->get_record('sessions', array('sid'=>$sid))) {
2880 $event->add_record_snapshot('sessions', $session);
2881 }
bb78e249 2882
f9f9d187
SL
2883 // Clone of $USER object to be used by auth plugins.
2884 $user = fullclone($USER);
2885
d79d5ac2
PS
2886 // Delete session record and drop $_SESSION content.
2887 \core\session\manager::terminate_current();
2888
2889 // Trigger event AFTER action.
2890 $event->trigger();
f9f9d187
SL
2891
2892 // Hook to execute auth plugins redirection after event trigger.
2893 foreach ($authplugins as $authplugin) {
2894 $authplugin->postlogout_hook($user);
2895 }
c4d0753b 2896}
2897
7cf1c7bd 2898/**
0d0a8bf6 2899 * Weaker version of require_login()
2900 *
7cf1c7bd 2901 * This is a weaker version of {@link require_login()} which only requires login
2902 * when called from within a course rather than the site page, unless
2903 * the forcelogin option is turned on.
0d0a8bf6 2904 * @see require_login()
7cf1c7bd 2905 *
f76249cc
PS
2906 * @package core_access
2907 * @category access
2908 *
33ebaf7c 2909 * @param mixed $courseorid The course object or id in question
bbd3f2c4 2910 * @param bool $autologinguest Allow autologin guests if that is wanted
4febb58f 2911 * @param object $cm Course activity module if known
f4013c10 2912 * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2913 * true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2914 * in order to keep redirects working properly. MDL-14495
df997f84
PS
2915 * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2916 * @return void
ac7af0da 2917 * @throws coding_exception
7cf1c7bd 2918 */
ac7af0da 2919function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
862940c0 2920 global $CFG, $PAGE, $SITE;
9d202aed
PS
2921 $issite = ((is_object($courseorid) and $courseorid->id == SITEID)
2922 or (!is_object($courseorid) and $courseorid == SITEID));
d4fb0e26 2923 if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
ac7af0da 2924 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
0d8b6a69 2925 // db queries so this is not really a performance concern, however it is obviously
2926 // better if you use get_fast_modinfo to get the cm before calling this.
2927 if (is_object($courseorid)) {
2928 $course = $courseorid;
2929 } else {
2930 $course = clone($SITE);
2931 }
2932 $modinfo = get_fast_modinfo($course);
2933 $cm = $modinfo->get_cm($cm->id);
2934 }
1596edff 2935 if (!empty($CFG->forcelogin)) {
ac7af0da 2936 // Login required for both SITE and courses.
df997f84 2937 require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
63c9ee99 2938
0d8b6a69 2939 } else if ($issite && !empty($cm) and !$cm->uservisible) {
ac7af0da 2940 // Always login for hidden activities.
df997f84 2941 require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
63c9ee99 2942
0d8b6a69 2943 } else if ($issite) {
ac7af0da 2944 // Login for SITE not required.
48c79eb3 2945 // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
2946 if (!empty($courseorid)) {
2947 if (is_object($courseorid)) {
2948 $course = $courseorid;
2949 } else {
2950 $course = clone $SITE;
2951 }
2952 if ($cm) {
2953 if ($cm->course != $course->id) {
2954 throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
862940c0 2955 }
48c79eb3 2956 $PAGE->set_cm($cm, $course);
2957 $PAGE->set_pagelayout('incourse');
862940c0 2958 } else {
48c79eb3 2959 $PAGE->set_course($course);
862940c0 2960 }
48c79eb3 2961 } else {
2962 // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
2963 $PAGE->set_course($PAGE->course);
9950c88f 2964 }
48c79eb3 2965 user_accesstime_log(SITEID);
2966 return;
63c9ee99 2967
33ebaf7c 2968 } else {
ac7af0da 2969 // Course login always required.
df997f84 2970 require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
f950af3c 2971 }
2972}
2973
61c6071f 2974/**
2975 * Require key login. Function terminates with error if key not found or incorrect.
0d0a8bf6 2976 *
0d0a8bf6 2977 * @uses NO_MOODLE_COOKIES
2978 * @uses PARAM_ALPHANUM
61c6071f 2979 * @param string $script unique script identifier
2980 * @param int $instance optional instance id
0d0a8bf6 2981 * @return int Instance ID
61c6071f 2982 */
2983function require_user_key_login($script, $instance=null) {
ac7af0da 2984 global $DB;
61c6071f 2985
82dd4f42 2986 if (!NO_MOODLE_COOKIES) {
2f137aa1 2987 print_error('sessioncookiesdisable');
61c6071f 2988 }
2989
ac7af0da 2990 // Extra safety.
d79d5ac2 2991 \core\session\manager::write_close();
61c6071f 2992
2993 $keyvalue = required_param('key', PARAM_ALPHANUM);
2994
ac7af0da 2995 if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
2f137aa1 2996 print_error('invalidkey');
61c6071f 2997 }
2998
2999 if (!empty($key->validuntil) and $key->validuntil < time()) {
2f137aa1 3000 print_error('expiredkey');
61c6071f 3001 }
3002
e436033f 3003 if ($key->iprestriction) {
765a1d4b
MD
3004 $remoteaddr = getremoteaddr(null);
3005 if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
2f137aa1 3006 print_error('ipmismatch');
e436033f 3007 }
61c6071f 3008 }
3009
ac7af0da 3010 if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
2f137aa1 3011 print_error('invaliduserid');
61c6071f 3012 }
3013
ac7af0da 3014 // Emulate normal session.
e922fe23 3015 enrol_check_plugins($user);
d79d5ac2 3016 \core\session\manager::set_user($user);
61c6071f 3017
ac7af0da 3018 // Note we are not using normal login.
e2fa911b 3019 if (!defined('USER_KEY_LOGIN')) {
3020 define('USER_KEY_LOGIN', true);
3021 }
3022
ac7af0da 3023 // Return instance id - it might be empty.
61c6071f 3024 return $key->instance;
3025}
3026
3027/**
3028 * Creates a new private user access key.
0d0a8bf6 3029 *
61c6071f 3030 * @param string $script unique target identifier
3031 * @param int $userid
0d0a8bf6 3032 * @param int $instance optional instance id
61c6071f 3033 * @param string $iprestriction optional ip restricted access
3034 * @param timestamp $validuntil key valid only until given data
3035 * @return string access key value
3036 */
3037function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
ae040d4b 3038 global $DB;
3039
365a5941 3040 $key = new stdClass();
61c6071f 3041 $key->script = $script;
3042 $key->userid = $userid;
3043 $key->instance = $instance;
3044 $key->iprestriction = $iprestriction;
3045 $key->validuntil = $validuntil;
3046 $key->timecreated = time();
3047
ac7af0da
SH
3048 // Something long and unique.
3049 $key->value = md5($userid.'_'.time().random_string(40));
3050 while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3051 // Must be unique.
61c6071f 3052 $key->value = md5($userid.'_'.time().random_string(40));