lib/moodlelib.php

   1 <?php
   2 // This file is part of Moodle - http://moodle.org/
   3 //
   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.
  13 //
  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/>.
  16
  17 /**
  18  * moodlelib.php - Moodle main library
  19  *
  20  * Main library file of miscellaneous general-purpose Moodle functions.
  21  * Other main libraries:
  22  *  - weblib.php      - functions that produce web output
  23  *  - datalib.php     - functions that access the database
  24  *
  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
  29  */
  30
  31 defined('MOODLE_INTERNAL') || die();
  32
  33 // CONSTANTS (Encased in phpdoc proper comments).
  34
  35 // Date and time constants.
  36 /**
  37  * Time constant - the number of seconds in a year
  38  */
  39 define('YEARSECS', 31536000);
  40
  41 /**
  42  * Time constant - the number of seconds in a week
  43  */
  44 define('WEEKSECS', 604800);
  45
  46 /**
  47  * Time constant - the number of seconds in a day
  48  */
  49 define('DAYSECS', 86400);
  50
  51 /**
  52  * Time constant - the number of seconds in an hour
  53  */
  54 define('HOURSECS', 3600);
  55
  56 /**
  57  * Time constant - the number of seconds in a minute
  58  */
  59 define('MINSECS', 60);
  60
  61 /**
  62  * Time constant - the number of minutes in a day
  63  */
  64 define('DAYMINS', 1440);
  65
  66 /**
  67  * Time constant - the number of minutes in an hour
  68  */
  69 define('HOURMINS', 60);
  70
  71 // Parameter constants - every call to optional_param(), required_param()
  72 // or clean_param() should have a specified type of parameter.
  73
  74 /**
  75  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
  76  */
  77 define('PARAM_ALPHA',    'alpha');
  78
  79 /**
  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
  82  */
  83 define('PARAM_ALPHAEXT', 'alphaext');
  84
  85 /**
  86  * PARAM_ALPHANUM - expected numbers and letters only.
  87  */
  88 define('PARAM_ALPHANUM', 'alphanum');
  89
  90 /**
  91  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
  92  */
  93 define('PARAM_ALPHANUMEXT', 'alphanumext');
  94
  95 /**
  96  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
  97  */
  98 define('PARAM_AUTH',  'auth');
  99
 100 /**
 101  * PARAM_BASE64 - Base 64 encoded format
 102  */
 103 define('PARAM_BASE64',   'base64');
 104
 105 /**
 106  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
 107  */
 108 define('PARAM_BOOL',     'bool');
 109
 110 /**
 111  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
 112  * checked against the list of capabilities in the database.
 113  */
 114 define('PARAM_CAPABILITY',   'capability');
 115
 116 /**
 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.
 122  */
 123 define('PARAM_CLEANHTML', 'cleanhtml');
 124
 125 /**
 126  * PARAM_EMAIL - an email address following the RFC
 127  */
 128 define('PARAM_EMAIL',   'email');
 129
 130 /**
 131  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
 132  */
 133 define('PARAM_FILE',   'file');
 134
 135 /**
 136  * PARAM_FLOAT - a real/floating point number.
 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
 145  */
 146 define('PARAM_FLOAT',  'float');
 147
 148 /**
 149  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
 150  */
 151 define('PARAM_HOST',     'host');
 152
 153 /**
 154  * PARAM_INT - integers only, use when expecting only numbers.
 155  */
 156 define('PARAM_INT',      'int');
 157
 158 /**
 159  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
 160  */
 161 define('PARAM_LANG',  'lang');
 162
 163 /**
 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!)
 166  */
 167 define('PARAM_LOCALURL', 'localurl');
 168
 169 /**
 170  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
 171  */
 172 define('PARAM_NOTAGS',   'notags');
 173
 174 /**
 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
 177  */
 178 define('PARAM_PATH',     'path');
 179
 180 /**
 181  * PARAM_PEM - Privacy Enhanced Mail format
 182  */
 183 define('PARAM_PEM',      'pem');
 184
 185 /**
 186  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
 187  */
 188 define('PARAM_PERMISSION',   'permission');
 189
 190 /**
 191  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
 192  */
 193 define('PARAM_RAW', 'raw');
 194
 195 /**
 196  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
 197  */
 198 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
 199
 200 /**
 201  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
 202  */
 203 define('PARAM_SAFEDIR',  'safedir');
 204
 205 /**
 206  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
 207  */
 208 define('PARAM_SAFEPATH',  'safepath');
 209
 210 /**
 211  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
 212  */
 213 define('PARAM_SEQUENCE',  'sequence');
 214
 215 /**
 216  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
 217  */
 218 define('PARAM_TAG',   'tag');
 219
 220 /**
 221  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
 222  */
 223 define('PARAM_TAGLIST',   'taglist');
 224
 225 /**
 226  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
 227  */
 228 define('PARAM_TEXT',  'text');
 229
 230 /**
 231  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
 232  */
 233 define('PARAM_THEME',  'theme');
 234
 235 /**
 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.
 238  */
 239 define('PARAM_URL',      'url');
 240
 241 /**
 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!!
 244  */
 245 define('PARAM_USERNAME',    'username');
 246
 247 /**
 248  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
 249  */
 250 define('PARAM_STRINGID',    'stringid');
 251
 252 // DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE.
 253 /**
 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 ;-)
 256  * @deprecated since 2.0
 257  */
 258 define('PARAM_CLEAN',    'clean');
 259
 260 /**
 261  * PARAM_INTEGER - deprecated alias for PARAM_INT
 262  * @deprecated since 2.0
 263  */
 264 define('PARAM_INTEGER',  'int');
 265
 266 /**
 267  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
 268  * @deprecated since 2.0
 269  */
 270 define('PARAM_NUMBER',  'float');
 271
 272 /**
 273  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
 274  * NOTE: originally alias for PARAM_APLHA
 275  * @deprecated since 2.0
 276  */
 277 define('PARAM_ACTION',   'alphanumext');
 278
 279 /**
 280  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
 281  * NOTE: originally alias for PARAM_APLHA
 282  * @deprecated since 2.0
 283  */
 284 define('PARAM_FORMAT',   'alphanumext');
 285
 286 /**
 287  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
 288  * @deprecated since 2.0
 289  */
 290 define('PARAM_MULTILANG',  'text');
 291
 292 /**
 293  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
 294  * string separated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
 295  * America/Port-au-Prince)
 296  */
 297 define('PARAM_TIMEZONE', 'timezone');
 298
 299 /**
 300  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
 301  */
 302 define('PARAM_CLEANFILE', 'file');
 303
 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  */
 310 define('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  */
 317 define('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  */
 324 define('PARAM_PLUGIN', 'plugin');
 325
 326
 327 // Web Services.
 328
 329 /**
 330  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
 331  */
 332 define('VALUE_REQUIRED', 1);
 333
 334 /**
 335  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
 336  */
 337 define('VALUE_OPTIONAL', 2);
 338
 339 /**
 340  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
 341  */
 342 define('VALUE_DEFAULT', 0);
 343
 344 /**
 345  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
 346  */
 347 define('NULL_NOT_ALLOWED', false);
 348
 349 /**
 350  * NULL_ALLOWED - the parameter can be set to null in the database
 351  */
 352 define('NULL_ALLOWED', true);
 353
 354 // Page types.
 355
 356 /**
 357  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
 358  */
 359 define('PAGE_COURSE_VIEW', 'course-view');
 360
 361 /** Get remote addr constant */
 362 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
 363 /** Get remote addr constant */
 364 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
 365
 366 // Blog access level constant declaration.
 367 define ('BLOG_USER_LEVEL', 1);
 368 define ('BLOG_GROUP_LEVEL', 2);
 369 define ('BLOG_COURSE_LEVEL', 3);
 370 define ('BLOG_SITE_LEVEL', 4);
 371 define ('BLOG_GLOBAL_LEVEL', 5);
 372
 373
 374 // Tag constants.
 375 /**
 376  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
 377  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
 378  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
 379  *
 380  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
 381  */
 382 define('TAG_MAX_LENGTH', 50);
 383
 384 // Password policy constants.
 385 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
 386 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
 387 define ('PASSWORD_DIGITS', '0123456789');
 388 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
 389
 390 // Feature constants.
 391 // Used for plugin_supports() to report features that are, or are not, supported by a module.
 392
 393 /** True if module can provide a grade */
 394 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
 395 /** True if module supports outcomes */
 396 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
 397 /** True if module supports advanced grading methods */
 398 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
 399 /** True if module controls the grade visibility over the gradebook */
 400 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
 401 /** True if module supports plagiarism plugins */
 402 define('FEATURE_PLAGIARISM', 'plagiarism');
 403
 404 /** True if module has code to track whether somebody viewed it */
 405 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
 406 /** True if module has custom completion rules */
 407 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
 408
 409 /** True if module has no 'view' page (like label) */
 410 define('FEATURE_NO_VIEW_LINK', 'viewlink');
 411 /** True if module supports outcomes */
 412 define('FEATURE_IDNUMBER', 'idnumber');
 413 /** True if module supports groups */
 414 define('FEATURE_GROUPS', 'groups');
 415 /** True if module supports groupings */
 416 define('FEATURE_GROUPINGS', 'groupings');
 417 /** True if module supports groupmembersonly */
 418 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
 419
 420 /** Type of module */
 421 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
 422 /** True if module supports intro editor */
 423 define('FEATURE_MOD_INTRO', 'mod_intro');
 424 /** True if module has default completion */
 425 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
 426
 427 define('FEATURE_COMMENT', 'comment');
 428
 429 define('FEATURE_RATE', 'rate');
 430 /** True if module supports backup/restore of moodle2 format */
 431 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
 432
 433 /** True if module can show description on course main page */
 434 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
 435
 436 /** Unspecified module archetype */
 437 define('MOD_ARCHETYPE_OTHER', 0);
 438 /** Resource-like type module */
 439 define('MOD_ARCHETYPE_RESOURCE', 1);
 440 /** Assignment module archetype */
 441 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
 442 /** System (not user-addable) module archetype */
 443 define('MOD_ARCHETYPE_SYSTEM', 3);
 444
 445 /**
 446  * Security token used for allowing access
 447  * from external application such as web services.
 448  * Scripts do not use any session, performance is relatively
 449  * low because we need to load access info in each request.
 450  * Scripts are executed in parallel.
 451  */
 452 define('EXTERNAL_TOKEN_PERMANENT', 0);
 453
 454 /**
 455  * Security token used for allowing access
 456  * of embedded applications, the code is executed in the
 457  * active user session. Token is invalidated after user logs out.
 458  * Scripts are executed serially - normal session locking is used.
 459  */
 460 define('EXTERNAL_TOKEN_EMBEDDED', 1);
 461
 462 /**
 463  * The home page should be the site home
 464  */
 465 define('HOMEPAGE_SITE', 0);
 466 /**
 467  * The home page should be the users my page
 468  */
 469 define('HOMEPAGE_MY', 1);
 470 /**
 471  * The home page can be chosen by the user
 472  */
 473 define('HOMEPAGE_USER', 2);
 474
 475 /**
 476  * Hub directory url (should be moodle.org)
 477  */
 478 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
 479
 480
 481 /**
 482  * Moodle.org url (should be moodle.org)
 483  */
 484 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
 485
 486 /**
 487  * Moodle mobile app service name
 488  */
 489 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
 490
 491 /**
 492  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
 493  */
 494 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
 495
 496 /**
 497  * Course display settings: display all sections on one page.
 498  */
 499 define('COURSE_DISPLAY_SINGLEPAGE', 0);
 500 /**
 501  * Course display settings: split pages into a page per section.
 502  */
 503 define('COURSE_DISPLAY_MULTIPAGE', 1);
 504
 505 /**
 506  * Authentication constant: String used in password field when password is not stored.
 507  */
 508 define('AUTH_PASSWORD_NOT_CACHED', 'not cached');
 509
 510 // PARAMETER HANDLING.
 511
 512 /**
 513  * Returns a particular value for the named variable, taken from
 514  * POST or GET.  If the parameter doesn't exist then an error is
 515  * thrown because we require this variable.
 516  *
 517  * This function should be used to initialise all required values
 518  * in a script that are based on parameters.  Usually it will be
 519  * used like this:
 520  *    $id = required_param('id', PARAM_INT);
 521  *
 522  * Please note the $type parameter is now required and the value can not be array.
 523  *
 524  * @param string $parname the name of the page parameter we want
 525  * @param string $type expected type of parameter
 526  * @return mixed
 527  * @throws coding_exception
 528  */
 529 function required_param($parname, $type) {
 530     if (func_num_args() != 2 or empty($parname) or empty($type)) {
 531         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
 532     }
 533     // POST has precedence.
 534     if (isset($_POST[$parname])) {
 535         $param = $_POST[$parname];
 536     } else if (isset($_GET[$parname])) {
 537         $param = $_GET[$parname];
 538     } else {
 539         print_error('missingparam', '', '', $parname);
 540     }
 541
 542     if (is_array($param)) {
 543         debugging('Invalid array parameter detected in required_param(): '.$parname);
 544         // TODO: switch to fatal error in Moodle 2.3.
 545         return required_param_array($parname, $type);
 546     }
 547
 548     return clean_param($param, $type);
 549 }
 550
 551 /**
 552  * Returns a particular array value for the named variable, taken from
 553  * POST or GET.  If the parameter doesn't exist then an error is
 554  * thrown because we require this variable.
 555  *
 556  * This function should be used to initialise all required values
 557  * in a script that are based on parameters.  Usually it will be
 558  * used like this:
 559  *    $ids = required_param_array('ids', PARAM_INT);
 560  *
 561  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
 562  *
 563  * @param string $parname the name of the page parameter we want
 564  * @param string $type expected type of parameter
 565  * @return array
 566  * @throws coding_exception
 567  */
 568 function required_param_array($parname, $type) {
 569     if (func_num_args() != 2 or empty($parname) or empty($type)) {
 570         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
 571     }
 572     // POST has precedence.
 573     if (isset($_POST[$parname])) {
 574         $param = $_POST[$parname];
 575     } else if (isset($_GET[$parname])) {
 576         $param = $_GET[$parname];
 577     } else {
 578         print_error('missingparam', '', '', $parname);
 579     }
 580     if (!is_array($param)) {
 581         print_error('missingparam', '', '', $parname);
 582     }
 583
 584     $result = array();
 585     foreach ($param as $key => $value) {
 586         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
 587             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
 588             continue;
 589         }
 590         $result[$key] = clean_param($value, $type);
 591     }
 592
 593     return $result;
 594 }
 595
 596 /**
 597  * Returns a particular value for the named variable, taken from
 598  * POST or GET, otherwise returning a given default.
 599  *
 600  * This function should be used to initialise all optional values
 601  * in a script that are based on parameters.  Usually it will be
 602  * used like this:
 603  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
 604  *
 605  * Please note the $type parameter is now required and the value can not be array.
 606  *
 607  * @param string $parname the name of the page parameter we want
 608  * @param mixed  $default the default value to return if nothing is found
 609  * @param string $type expected type of parameter
 610  * @return mixed
 611  * @throws coding_exception
 612  */
 613 function optional_param($parname, $default, $type) {
 614     if (func_num_args() != 3 or empty($parname) or empty($type)) {
 615         throw new coding_exception('optional_param requires $parname, $default + $type to be specified (parameter: '.$parname.')');
 616     }
 617     if (!isset($default)) {
 618         $default = null;
 619     }
 620
 621     // POST has precedence.
 622     if (isset($_POST[$parname])) {
 623         $param = $_POST[$parname];
 624     } else if (isset($_GET[$parname])) {
 625         $param = $_GET[$parname];
 626     } else {
 627         return $default;
 628     }
 629
 630     if (is_array($param)) {
 631         debugging('Invalid array parameter detected in required_param(): '.$parname);
 632         // TODO: switch to $default in Moodle 2.3.
 633         return optional_param_array($parname, $default, $type);
 634     }
 635
 636     return clean_param($param, $type);
 637 }
 638
 639 /**
 640  * Returns a particular array value for the named variable, taken from
 641  * POST or GET, otherwise returning a given default.
 642  *
 643  * This function should be used to initialise all optional values
 644  * in a script that are based on parameters.  Usually it will be
 645  * used like this:
 646  *    $ids = optional_param('id', array(), PARAM_INT);
 647  *
 648  * Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
 649  *
 650  * @param string $parname the name of the page parameter we want
 651  * @param mixed $default the default value to return if nothing is found
 652  * @param string $type expected type of parameter
 653  * @return array
 654  * @throws coding_exception
 655  */
 656 function optional_param_array($parname, $default, $type) {
 657     if (func_num_args() != 3 or empty($parname) or empty($type)) {
 658         throw new coding_exception('optional_param_array requires $parname, $default + $type to be specified (parameter: '.$parname.')');
 659     }
 660
 661     // POST has precedence.
 662     if (isset($_POST[$parname])) {
 663         $param = $_POST[$parname];
 664     } else if (isset($_GET[$parname])) {
 665         $param = $_GET[$parname];
 666     } else {
 667         return $default;
 668     }
 669     if (!is_array($param)) {
 670         debugging('optional_param_array() expects array parameters only: '.$parname);
 671         return $default;
 672     }
 673
 674     $result = array();
 675     foreach ($param as $key => $value) {
 676         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
 677             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
 678             continue;
 679         }
 680         $result[$key] = clean_param($value, $type);
 681     }
 682
 683     return $result;
 684 }
 685
 686 /**
 687  * Strict validation of parameter values, the values are only converted
 688  * to requested PHP type. Internally it is using clean_param, the values
 689  * before and after cleaning must be equal - otherwise
 690  * an invalid_parameter_exception is thrown.
 691  * Objects and classes are not accepted.
 692  *
 693  * @param mixed $param
 694  * @param string $type PARAM_ constant
 695  * @param bool $allownull are nulls valid value?
 696  * @param string $debuginfo optional debug information
 697  * @return mixed the $param value converted to PHP type
 698  * @throws invalid_parameter_exception if $param is not of given type
 699  */
 700 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
 701     if (is_null($param)) {
 702         if ($allownull == NULL_ALLOWED) {
 703             return null;
 704         } else {
 705             throw new invalid_parameter_exception($debuginfo);
 706         }
 707     }
 708     if (is_array($param) or is_object($param)) {
 709         throw new invalid_parameter_exception($debuginfo);
 710     }
 711
 712     $cleaned = clean_param($param, $type);
 713
 714     if ($type == PARAM_FLOAT) {
 715         // Do not detect precision loss here.
 716         if (is_float($param) or is_int($param)) {
 717             // These always fit.
 718         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
 719             throw new invalid_parameter_exception($debuginfo);
 720         }
 721     } else if ((string)$param !== (string)$cleaned) {
 722         // Conversion to string is usually lossless.
 723         throw new invalid_parameter_exception($debuginfo);
 724     }
 725
 726     return $cleaned;
 727 }
 728
 729 /**
 730  * Makes sure array contains only the allowed types, this function does not validate array key names!
 731  *
 732  * <code>
 733  * $options = clean_param($options, PARAM_INT);
 734  * </code>
 735  *
 736  * @param array $param the variable array we are cleaning
 737  * @param string $type expected format of param after cleaning.
 738  * @param bool $recursive clean recursive arrays
 739  * @return array
 740  * @throws coding_exception
 741  */
 742 function clean_param_array(array $param = null, $type, $recursive = false) {
 743     // Convert null to empty array.
 744     $param = (array)$param;
 745     foreach ($param as $key => $value) {
 746         if (is_array($value)) {
 747             if ($recursive) {
 748                 $param[$key] = clean_param_array($value, $type, true);
 749             } else {
 750                 throw new coding_exception('clean_param_array can not process multidimensional arrays when $recursive is false.');
 751             }
 752         } else {
 753             $param[$key] = clean_param($value, $type);
 754         }
 755     }
 756     return $param;
 757 }
 758
 759 /**
 760  * Used by {@link optional_param()} and {@link required_param()} to
 761  * clean the variables and/or cast to specific types, based on
 762  * an options field.
 763  * <code>
 764  * $course->format = clean_param($course->format, PARAM_ALPHA);
 765  * $selectedgradeitem = clean_param($selectedgradeitem, PARAM_INT);
 766  * </code>
 767  *
 768  * @param mixed $param the variable we are cleaning
 769  * @param string $type expected format of param after cleaning.
 770  * @return mixed
 771  * @throws coding_exception
 772  */
 773 function clean_param($param, $type) {
 774     global $CFG;
 775
 776     if (is_array($param)) {
 777         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
 778     } else if (is_object($param)) {
 779         if (method_exists($param, '__toString')) {
 780             $param = $param->__toString();
 781         } else {
 782             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
 783         }
 784     }
 785
 786     switch ($type) {
 787         case PARAM_RAW:
 788             // No cleaning at all.
 789             $param = fix_utf8($param);
 790             return $param;
 791
 792         case PARAM_RAW_TRIMMED:
 793             // No cleaning, but strip leading and trailing whitespace.
 794             $param = fix_utf8($param);
 795             return trim($param);
 796
 797         case PARAM_CLEAN:
 798             // General HTML cleaning, try to use more specific type if possible this is deprecated!
 799             // Please use more specific type instead.
 800             if (is_numeric($param)) {
 801                 return $param;
 802             }
 803             $param = fix_utf8($param);
 804             // Sweep for scripts, etc.
 805             return clean_text($param);
 806
 807         case PARAM_CLEANHTML:
 808             // Clean html fragment.
 809             $param = fix_utf8($param);
 810             // Sweep for scripts, etc.
 811             $param = clean_text($param, FORMAT_HTML);
 812             return trim($param);
 813
 814         case PARAM_INT:
 815             // Convert to integer.
 816             return (int)$param;
 817
 818         case PARAM_FLOAT:
 819             // Convert to float.
 820             return (float)$param;
 821
 822         case PARAM_ALPHA:
 823             // Remove everything not `a-z`.
 824             return preg_replace('/[^a-zA-Z]/i', '', $param);
 825
 826         case PARAM_ALPHAEXT:
 827             // Remove everything not `a-zA-Z_-` (originally allowed "/" too).
 828             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
 829
 830         case PARAM_ALPHANUM:
 831             // Remove everything not `a-zA-Z0-9`.
 832             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
 833
 834         case PARAM_ALPHANUMEXT:
 835             // Remove everything not `a-zA-Z0-9_-`.
 836             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
 837
 838         case PARAM_SEQUENCE:
 839             // Remove everything not `0-9,`.
 840             return preg_replace('/[^0-9,]/i', '', $param);
 841
 842         case PARAM_BOOL:
 843             // Convert to 1 or 0.
 844             $tempstr = strtolower($param);
 845             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
 846                 $param = 1;
 847             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
 848                 $param = 0;
 849             } else {
 850                 $param = empty($param) ? 0 : 1;
 851             }
 852             return $param;
 853
 854         case PARAM_NOTAGS:
 855             // Strip all tags.
 856             $param = fix_utf8($param);
 857             return strip_tags($param);
 858
 859         case PARAM_TEXT:
 860             // Leave only tags needed for multilang.
 861             $param = fix_utf8($param);
 862             // If the multilang syntax is not correct we strip all tags because it would break xhtml strict which is required
 863             // for accessibility standards please note this cleaning does not strip unbalanced '>' for BC compatibility reasons.
 864             do {
 865                 if (strpos($param, '</lang>') !== false) {
 866                     // Old and future mutilang syntax.
 867                     $param = strip_tags($param, '<lang>');
 868                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
 869                         break;
 870                     }
 871                     $open = false;
 872                     foreach ($matches[0] as $match) {
 873                         if ($match === '</lang>') {
 874                             if ($open) {
 875                                 $open = false;
 876                                 continue;
 877                             } else {
 878                                 break 2;
 879                             }
 880                         }
 881                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
 882                             break 2;
 883                         } else {
 884                             $open = true;
 885                         }
 886                     }
 887                     if ($open) {
 888                         break;
 889                     }
 890                     return $param;
 891
 892                 } else if (strpos($param, '</span>') !== false) {
 893                     // Current problematic multilang syntax.
 894                     $param = strip_tags($param, '<span>');
 895                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
 896                         break;
 897                     }
 898                     $open = false;
 899                     foreach ($matches[0] as $match) {
 900                         if ($match === '</span>') {
 901                             if ($open) {
 902                                 $open = false;
 903                                 continue;
 904                             } else {
 905                                 break 2;
 906                             }
 907                         }
 908                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
 909                             break 2;
 910                         } else {
 911                             $open = true;
 912                         }
 913                     }
 914                     if ($open) {
 915                         break;
 916                     }
 917                     return $param;
 918                 }
 919             } while (false);
 920             // Easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string().
 921             return strip_tags($param);
 922
 923         case PARAM_COMPONENT:
 924             // We do not want any guessing here, either the name is correct or not
 925             // please note only normalised component names are accepted.
 926             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
 927                 return '';
 928             }
 929             if (strpos($param, '__') !== false) {
 930                 return '';
 931             }
 932             if (strpos($param, 'mod_') === 0) {
 933                 // Module names must not contain underscores because we need to differentiate them from invalid plugin types.
 934                 if (substr_count($param, '_') != 1) {
 935                     return '';
 936                 }
 937             }
 938             return $param;
 939
 940         case PARAM_PLUGIN:
 941         case PARAM_AREA:
 942             // We do not want any guessing here, either the name is correct or not.
 943             if (!is_valid_plugin_name($param)) {
 944                 return '';
 945             }
 946             return $param;
 947
 948         case PARAM_SAFEDIR:
 949             // Remove everything not a-zA-Z0-9_- .
 950             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
 951
 952         case PARAM_SAFEPATH:
 953             // Remove everything not a-zA-Z0-9/_- .
 954             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
 955
 956         case PARAM_FILE:
 957             // Strip all suspicious characters from filename.
 958             $param = fix_utf8($param);
 959             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
 960             if ($param === '.' || $param === '..') {
 961                 $param = '';
 962             }
 963             return $param;
 964
 965         case PARAM_PATH:
 966             // Strip all suspicious characters from file path.
 967             $param = fix_utf8($param);
 968             $param = str_replace('\\', '/', $param);
 969
 970             // Explode the path and clean each element using the PARAM_FILE rules.
 971             $breadcrumb = explode('/', $param);
 972             foreach ($breadcrumb as $key => $crumb) {
 973                 if ($crumb === '.' && $key === 0) {
 974                     // Special condition to allow for relative current path such as ./currentdirfile.txt.
 975                 } else {
 976                     $crumb = clean_param($crumb, PARAM_FILE);
 977                 }
 978                 $breadcrumb[$key] = $crumb;
 979             }
 980             $param = implode('/', $breadcrumb);
 981
 982             // Remove multiple current path (./././) and multiple slashes (///).
 983             $param = preg_replace('~//+~', '/', $param);
 984             $param = preg_replace('~/(\./)+~', '/', $param);
 985             return $param;
 986
 987         case PARAM_HOST:
 988             // Allow FQDN or IPv4 dotted quad.
 989             $param = preg_replace('/[^\.\d\w-]/', '', $param );
 990             // Match ipv4 dotted quad.
 991             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/', $param, $match)) {
 992                 // Confirm values are ok.
 993                 if ( $match[0] > 255
 994                      || $match[1] > 255
 995                      || $match[3] > 255
 996                      || $match[4] > 255 ) {
 997                     // Hmmm, what kind of dotted quad is this?
 998                     $param = '';
 999                 }
1000             } else if ( preg_match('/^[\w\d\.-]+$/', $param) // Dots, hyphens, numbers.
1001                        && !preg_match('/^[\.-]/',  $param) // No leading dots/hyphens.
1002                        && !preg_match('/[\.-]$/',  $param) // No trailing dots/hyphens.
1003                        ) {
1004                 // All is ok - $param is respected.
1005             } else {
1006                 // All is not ok...
1007                 $param='';
1008             }
1009             return $param;
1010
1011         case PARAM_URL:          // Allow safe ftp, http, mailto urls.
1012             $param = fix_utf8($param);
1013             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
1014             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
1015                 // All is ok, param is respected.
1016             } else {
1017                 // Not really ok.
1018                 $param ='';
1019             }
1020             return $param;
1021
1022         case PARAM_LOCALURL:
1023             // Allow http absolute, root relative and relative URLs within wwwroot.
1024             $param = clean_param($param, PARAM_URL);
1025             if (!empty($param)) {
1026                 if (preg_match(':^/:', $param)) {
1027                     // Root-relative, ok!
1028                 } else if (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i', $param)) {
1029                     // Absolute, and matches our wwwroot.
1030                 } else {
1031                     // Relative - let's make sure there are no tricks.
1032                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
1033                         // Looks ok.
1034                     } else {
1035                         $param = '';
1036                     }
1037                 }
1038             }
1039             return $param;
1040
1041         case PARAM_PEM:
1042             $param = trim($param);
1043             // PEM formatted strings may contain letters/numbers and the symbols:
1044             //   forward slash: /
1045             //   plus sign:     +
1046             //   equal sign:    =
1047             //   , surrounded by BEGIN and END CERTIFICATE prefix and suffixes.
1048             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
1049                 list($wholething, $body) = $matches;
1050                 unset($wholething, $matches);
1051                 $b64 = clean_param($body, PARAM_BASE64);
1052                 if (!empty($b64)) {
1053                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
1054                 } else {
1055                     return '';
1056                 }
1057             }
1058             return '';
1059
1060         case PARAM_BASE64:
1061             if (!empty($param)) {
1062                 // PEM formatted strings may contain letters/numbers and the symbols
1063                 //   forward slash: /
1064                 //   plus sign:     +
1065                 //   equal sign:    =.
1066                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1067                     return '';
1068                 }
1069                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1070                 // Each line of base64 encoded data must be 64 characters in length, except for the last line which may be less
1071                 // than (or equal to) 64 characters long.
1072                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1073                     if ($i + 1 == $j) {
1074                         if (64 < strlen($lines[$i])) {
1075                             return '';
1076                         }
1077                         continue;
1078                     }
1079
1080                     if (64 != strlen($lines[$i])) {
1081                         return '';
1082                     }
1083                 }
1084                 return implode("\n", $lines);
1085             } else {
1086                 return '';
1087             }
1088
1089         case PARAM_TAG:
1090             $param = fix_utf8($param);
1091             // Please note it is not safe to use the tag name directly anywhere,
1092             // it must be processed with s(), urlencode() before embedding anywhere.
1093             // Remove some nasties.
1094             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1095             // Convert many whitespace chars into one.
1096             $param = preg_replace('/\s+/', ' ', $param);
1097             $param = core_text::substr(trim($param), 0, TAG_MAX_LENGTH);
1098             return $param;
1099
1100         case PARAM_TAGLIST:
1101             $param = fix_utf8($param);
1102             $tags = explode(',', $param);
1103             $result = array();
1104             foreach ($tags as $tag) {
1105                 $res = clean_param($tag, PARAM_TAG);
1106                 if ($res !== '') {
1107                     $result[] = $res;
1108                 }
1109             }
1110             if ($result) {
1111                 return implode(',', $result);
1112             } else {
1113                 return '';
1114             }
1115
1116         case PARAM_CAPABILITY:
1117             if (get_capability_info($param)) {
1118                 return $param;
1119             } else {
1120                 return '';
1121             }
1122
1123         case PARAM_PERMISSION:
1124             $param = (int)$param;
1125             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1126                 return $param;
1127             } else {
1128                 return CAP_INHERIT;
1129             }
1130
1131         case PARAM_AUTH:
1132             $param = clean_param($param, PARAM_PLUGIN);
1133             if (empty($param)) {
1134                 return '';
1135             } else if (exists_auth_plugin($param)) {
1136                 return $param;
1137             } else {
1138                 return '';
1139             }
1140
1141         case PARAM_LANG:
1142             $param = clean_param($param, PARAM_SAFEDIR);
1143             if (get_string_manager()->translation_exists($param)) {
1144                 return $param;
1145             } else {
1146                 // Specified language is not installed or param malformed.
1147                 return '';
1148             }
1149
1150         case PARAM_THEME:
1151             $param = clean_param($param, PARAM_PLUGIN);
1152             if (empty($param)) {
1153                 return '';
1154             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1155                 return $param;
1156             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1157                 return $param;
1158             } else {
1159                 // Specified theme is not installed.
1160                 return '';
1161             }
1162
1163         case PARAM_USERNAME:
1164             $param = fix_utf8($param);
1165             $param = str_replace(" " , "", $param);
1166             // Convert uppercase to lowercase MDL-16919.
1167             $param = core_text::strtolower($param);
1168             if (empty($CFG->extendedusernamechars)) {
1169                 // Regular expression, eliminate all chars EXCEPT:
1170                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1171                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1172             }
1173             return $param;
1174
1175         case PARAM_EMAIL:
1176             $param = fix_utf8($param);
1177             if (validate_email($param)) {
1178                 return $param;
1179             } else {
1180                 return '';
1181             }
1182
1183         case PARAM_STRINGID:
1184             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1185                 return $param;
1186             } else {
1187                 return '';
1188             }
1189
1190         case PARAM_TIMEZONE:
1191             // Can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'.
1192             $param = fix_utf8($param);
1193             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3](\.0)?|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1194             if (preg_match($timezonepattern, $param)) {
1195                 return $param;
1196             } else {
1197                 return '';
1198             }
1199
1200         default:
1201             // Doh! throw error, switched parameters in optional_param or another serious problem.
1202             print_error("unknownparamtype", '', '', $type);
1203     }
1204 }
1205
1206 /**
1207  * Makes sure the data is using valid utf8, invalid characters are discarded.
1208  *
1209  * Note: this function is not intended for full objects with methods and private properties.
1210  *
1211  * @param mixed $value
1212  * @return mixed with proper utf-8 encoding
1213  */
1214 function fix_utf8($value) {
1215     if (is_null($value) or $value === '') {
1216         return $value;
1217
1218     } else if (is_string($value)) {
1219         if ((string)(int)$value === $value) {
1220             // Shortcut.
1221             return $value;
1222         }
1223
1224         // Lower error reporting because glibc throws bogus notices.
1225         $olderror = error_reporting();
1226         if ($olderror & E_NOTICE) {
1227             error_reporting($olderror ^ E_NOTICE);
1228         }
1229
1230         // Note: this duplicates min_fix_utf8() intentionally.
1231         static $buggyiconv = null;
1232         if ($buggyiconv === null) {
1233             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1234         }
1235
1236         if ($buggyiconv) {
1237             if (function_exists('mb_convert_encoding')) {
1238                 $subst = mb_substitute_character();
1239                 mb_substitute_character('');
1240                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1241                 mb_substitute_character($subst);
1242
1243             } else {
1244                 // Warn admins on admin/index.php page.
1245                 $result = $value;
1246             }
1247
1248         } else {
1249             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1250         }
1251
1252         if ($olderror & E_NOTICE) {
1253             error_reporting($olderror);
1254         }
1255
1256         return $result;
1257
1258     } else if (is_array($value)) {
1259         foreach ($value as $k => $v) {
1260             $value[$k] = fix_utf8($v);
1261         }
1262         return $value;
1263
1264     } else if (is_object($value)) {
1265         // Do not modify original.
1266         $value = clone($value);
1267         foreach ($value as $k => $v) {
1268             $value->$k = fix_utf8($v);
1269         }
1270         return $value;
1271
1272     } else {
1273         // This is some other type, no utf-8 here.
1274         return $value;
1275     }
1276 }
1277
1278 /**
1279  * Return true if given value is integer or string with integer value
1280  *
1281  * @param mixed $value String or Int
1282  * @return bool true if number, false if not
1283  */
1284 function is_number($value) {
1285     if (is_int($value)) {
1286         return true;
1287     } else if (is_string($value)) {
1288         return ((string)(int)$value) === $value;
1289     } else {
1290         return false;
1291     }
1292 }
1293
1294 /**
1295  * Returns host part from url.
1296  *
1297  * @param string $url full url
1298  * @return string host, null if not found
1299  */
1300 function get_host_from_url($url) {
1301     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1302     if ($matches) {
1303         return $matches[1];
1304     }
1305     return null;
1306 }
1307
1308 /**
1309  * Tests whether anything was returned by text editor
1310  *
1311  * This function is useful for testing whether something you got back from
1312  * the HTML editor actually contains anything. Sometimes the HTML editor
1313  * appear to be empty, but actually you get back a <br> tag or something.
1314  *
1315  * @param string $string a string containing HTML.
1316  * @return boolean does the string contain any actual content - that is text,
1317  * images, objects, etc.
1318  */
1319 function html_is_blank($string) {
1320     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1321 }
1322
1323 /**
1324  * Set a key in global configuration
1325  *
1326  * Set a key/value pair in both this session's {@link $CFG} global variable
1327  * and in the 'config' database table for future sessions.
1328  *
1329  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1330  * In that case it doesn't affect $CFG.
1331  *
1332  * A NULL value will delete the entry.
1333  *
1334  * @param string $name the key to set
1335  * @param string $value the value to set (without magic quotes)
1336  * @param string $plugin (optional) the plugin scope, default null
1337  * @return bool true or exception
1338  */
1339 function set_config($name, $value, $plugin=null) {
1340     global $CFG, $DB;
1341
1342     if (empty($plugin)) {
1343         if (!array_key_exists($name, $CFG->config_php_settings)) {
1344             // So it's defined for this invocation at least.
1345             if (is_null($value)) {
1346                 unset($CFG->$name);
1347             } else {
1348                 // Settings from db are always strings.
1349                 $CFG->$name = (string)$value;
1350             }
1351         }
1352
1353         if ($DB->get_field('config', 'name', array('name' => $name))) {
1354             if ($value === null) {
1355                 $DB->delete_records('config', array('name' => $name));
1356             } else {
1357                 $DB->set_field('config', 'value', $value, array('name' => $name));
1358             }
1359         } else {
1360             if ($value !== null) {
1361                 $config = new stdClass();
1362                 $config->name  = $name;
1363                 $config->value = $value;
1364                 $DB->insert_record('config', $config, false);
1365             }
1366         }
1367         if ($name === 'siteidentifier') {
1368             cache_helper::update_site_identifier($value);
1369         }
1370         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1371     } else {
1372         // Plugin scope.
1373         if ($id = $DB->get_field('config_plugins', 'id', array('name' => $name, 'plugin' => $plugin))) {
1374             if ($value===null) {
1375                 $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1376             } else {
1377                 $DB->set_field('config_plugins', 'value', $value, array('id' => $id));
1378             }
1379         } else {
1380             if ($value !== null) {
1381                 $config = new stdClass();
1382                 $config->plugin = $plugin;
1383                 $config->name   = $name;
1384                 $config->value  = $value;
1385                 $DB->insert_record('config_plugins', $config, false);
1386             }
1387         }
1388         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1389     }
1390
1391     return true;
1392 }
1393
1394 /**
1395  * Get configuration values from the global config table
1396  * or the config_plugins table.
1397  *
1398  * If called with one parameter, it will load all the config
1399  * variables for one plugin, and return them as an object.
1400  *
1401  * If called with 2 parameters it will return a string single
1402  * value or false if the value is not found.
1403  *
1404  * @static string|false $siteidentifier The site identifier is not cached. We use this static cache so
1405  *     that we need only fetch it once per request.
1406  * @param string $plugin full component name
1407  * @param string $name default null
1408  * @return mixed hash-like object or single value, return false no config found
1409  * @throws dml_exception
1410  */
1411 function get_config($plugin, $name = null) {
1412     global $CFG, $DB;
1413
1414     static $siteidentifier = null;
1415
1416     if ($plugin === 'moodle' || $plugin === 'core' || empty($plugin)) {
1417         $forced =& $CFG->config_php_settings;
1418         $iscore = true;
1419         $plugin = 'core';
1420     } else {
1421         if (array_key_exists($plugin, $CFG->forced_plugin_settings)) {
1422             $forced =& $CFG->forced_plugin_settings[$plugin];
1423         } else {
1424             $forced = array();
1425         }
1426         $iscore = false;
1427     }
1428
1429     if ($siteidentifier === null) {
1430         try {
1431             // This may fail during installation.
1432             // If you have a look at {@link initialise_cfg()} you will see that this is how we detect the need to
1433             // install the database.
1434             $siteidentifier = $DB->get_field('config', 'value', array('name' => 'siteidentifier'));
1435         } catch (dml_exception $ex) {
1436             // Set siteidentifier to false. We don't want to trip this continually.
1437             $siteidentifier = false;
1438             throw $ex;
1439         }
1440     }
1441
1442     if (!empty($name)) {
1443         if (array_key_exists($name, $forced)) {
1444             return (string)$forced[$name];
1445         } else if ($name === 'siteidentifier' && $plugin == 'core') {
1446             return $siteidentifier;
1447         }
1448     }
1449
1450     $cache = cache::make('core', 'config');
1451     $result = $cache->get($plugin);
1452     if ($result === false) {
1453         // The user is after a recordset.
1454         if (!$iscore) {
1455             $result = $DB->get_records_menu('config_plugins', array('plugin' => $plugin), '', 'name,value');
1456         } else {
1457             // This part is not really used any more, but anyway...
1458             $result = $DB->get_records_menu('config', array(), '', 'name,value');;
1459         }
1460         $cache->set($plugin, $result);
1461     }
1462
1463     if (!empty($name)) {
1464         if (array_key_exists($name, $result)) {
1465             return $result[$name];
1466         }
1467         return false;
1468     }
1469
1470     if ($plugin === 'core') {
1471         $result['siteidentifier'] = $siteidentifier;
1472     }
1473
1474     foreach ($forced as $key => $value) {
1475         if (is_null($value) or is_array($value) or is_object($value)) {
1476             // We do not want any extra mess here, just real settings that could be saved in db.
1477             unset($result[$key]);
1478         } else {
1479             // Convert to string as if it went through the DB.
1480             $result[$key] = (string)$value;
1481         }
1482     }
1483
1484     return (object)$result;
1485 }
1486
1487 /**
1488  * Removes a key from global configuration.
1489  *
1490  * @param string $name the key to set
1491  * @param string $plugin (optional) the plugin scope
1492  * @return boolean whether the operation succeeded.
1493  */
1494 function unset_config($name, $plugin=null) {
1495     global $CFG, $DB;
1496
1497     if (empty($plugin)) {
1498         unset($CFG->$name);
1499         $DB->delete_records('config', array('name' => $name));
1500         cache_helper::invalidate_by_definition('core', 'config', array(), 'core');
1501     } else {
1502         $DB->delete_records('config_plugins', array('name' => $name, 'plugin' => $plugin));
1503         cache_helper::invalidate_by_definition('core', 'config', array(), $plugin);
1504     }
1505
1506     return true;
1507 }
1508
1509 /**
1510  * Remove all the config variables for a given plugin.
1511  *
1512  * NOTE: this function is called from lib/db/upgrade.php
1513  *
1514  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1515  * @return boolean whether the operation succeeded.
1516  */
1517 function unset_all_config_for_plugin($plugin) {
1518     global $DB;
1519     // Delete from the obvious config_plugins first.
1520     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1521     // Next delete any suspect settings from config.
1522     $like = $DB->sql_like('name', '?', true, true, false, '|');
1523     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1524     $DB->delete_records_select('config', $like, $params);
1525     // Finally clear both the plugin cache and the core cache (suspect settings now removed from core).
1526     cache_helper::invalidate_by_definition('core', 'config', array(), array('core', $plugin));
1527
1528     return true;
1529 }
1530
1531 /**
1532  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1533  *
1534  * All users are verified if they still have the necessary capability.
1535  *
1536  * @param string $value the value of the config setting.
1537  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1538  * @param bool $includeadmins include administrators.
1539  * @return array of user objects.
1540  */
1541 function get_users_from_config($value, $capability, $includeadmins = true) {
1542     if (empty($value) or $value === '$@NONE@$') {
1543         return array();
1544     }
1545
1546     // We have to make sure that users still have the necessary capability,
1547     // it should be faster to fetch them all first and then test if they are present
1548     // instead of validating them one-by-one.
1549     $users = get_users_by_capability(context_system::instance(), $capability);
1550     if ($includeadmins) {
1551         $admins = get_admins();
1552         foreach ($admins as $admin) {
1553             $users[$admin->id] = $admin;
1554         }
1555     }
1556
1557     if ($value === '$@ALL@$') {
1558         return $users;
1559     }
1560
1561     $result = array(); // Result in correct order.
1562     $allowed = explode(',', $value);
1563     foreach ($allowed as $uid) {
1564         if (isset($users[$uid])) {
1565             $user = $users[$uid];
1566             $result[$user->id] = $user;
1567         }
1568     }
1569
1570     return $result;
1571 }
1572
1573
1574 /**
1575  * Invalidates browser caches and cached data in temp.
1576  *
1577  * IMPORTANT - If you are adding anything here to do with the cache directory you should also have a look at
1578  * {@link phpunit_util::reset_dataroot()}
1579  *
1580  * @return void
1581  */
1582 function purge_all_caches() {
1583     global $CFG;
1584
1585     reset_text_filters_cache();
1586     js_reset_all_caches();
1587     theme_reset_all_caches();
1588     get_string_manager()->reset_caches();
1589     core_text::reset_caches();
1590
1591     cache_helper::purge_all();
1592
1593     // Purge all other caches: rss, simplepie, etc.
1594     remove_dir($CFG->cachedir.'', true);
1595
1596     // Make sure cache dir is writable, throws exception if not.
1597     make_cache_directory('');
1598
1599     // This is the only place where we purge local caches, we are only adding files there.
1600     // The $CFG->localcachedirpurged flag forces local directories to be purged on cluster nodes.
1601     remove_dir($CFG->localcachedir, true);
1602     set_config('localcachedirpurged', time());
1603     make_localcache_directory('', true);
1604 }
1605
1606 /**
1607  * Get volatile flags
1608  *
1609  * @param string $type
1610  * @param int $changedsince default null
1611  * @return array records array
1612  */
1613 function get_cache_flags($type, $changedsince = null) {
1614     global $DB;
1615
1616     $params = array('type' => $type, 'expiry' => time());
1617     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1618     if ($changedsince !== null) {
1619         $params['changedsince'] = $changedsince;
1620         $sqlwhere .= " AND timemodified > :changedsince";
1621     }
1622     $cf = array();
1623     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1624         foreach ($flags as $flag) {
1625             $cf[$flag->name] = $flag->value;
1626         }
1627     }
1628     return $cf;
1629 }
1630
1631 /**
1632  * Get volatile flags
1633  *
1634  * @param string $type
1635  * @param string $name
1636  * @param int $changedsince default null
1637  * @return string|false The cache flag value or false
1638  */
1639 function get_cache_flag($type, $name, $changedsince=null) {
1640     global $DB;
1641
1642     $params = array('type' => $type, 'name' => $name, 'expiry' => time());
1643
1644     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1645     if ($changedsince !== null) {
1646         $params['changedsince'] = $changedsince;
1647         $sqlwhere .= " AND timemodified > :changedsince";
1648     }
1649
1650     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1651 }
1652
1653 /**
1654  * Set a volatile flag
1655  *
1656  * @param string $type the "type" namespace for the key
1657  * @param string $name the key to set
1658  * @param string $value the value to set (without magic quotes) - null will remove the flag
1659  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1660  * @return bool Always returns true
1661  */
1662 function set_cache_flag($type, $name, $value, $expiry = null) {
1663     global $DB;
1664
1665     $timemodified = time();
1666     if ($expiry === null || $expiry < $timemodified) {
1667         $expiry = $timemodified + 24 * 60 * 60;
1668     } else {
1669         $expiry = (int)$expiry;
1670     }
1671
1672     if ($value === null) {
1673         unset_cache_flag($type, $name);
1674         return true;
1675     }
1676
1677     if ($f = $DB->get_record('cache_flags', array('name' => $name, 'flagtype' => $type), '*', IGNORE_MULTIPLE)) {
1678         // This is a potential problem in DEBUG_DEVELOPER.
1679         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1680             return true; // No need to update.
1681         }
1682         $f->value        = $value;
1683         $f->expiry       = $expiry;
1684         $f->timemodified = $timemodified;
1685         $DB->update_record('cache_flags', $f);
1686     } else {
1687         $f = new stdClass();
1688         $f->flagtype     = $type;
1689         $f->name         = $name;
1690         $f->value        = $value;
1691         $f->expiry       = $expiry;
1692         $f->timemodified = $timemodified;
1693         $DB->insert_record('cache_flags', $f);
1694     }
1695     return true;
1696 }
1697
1698 /**
1699  * Removes a single volatile flag
1700  *
1701  * @param string $type the "type" namespace for the key
1702  * @param string $name the key to set
1703  * @return bool
1704  */
1705 function unset_cache_flag($type, $name) {
1706     global $DB;
1707     $DB->delete_records('cache_flags', array('name' => $name, 'flagtype' => $type));
1708     return true;
1709 }
1710
1711 /**
1712  * Garbage-collect volatile flags
1713  *
1714  * @return bool Always returns true
1715  */
1716 function gc_cache_flags() {
1717     global $DB;
1718     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1719     return true;
1720 }
1721
1722 // USER PREFERENCE API.
1723
1724 /**
1725  * Refresh user preference cache. This is used most often for $USER
1726  * object that is stored in session, but it also helps with performance in cron script.
1727  *
1728  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1729  *
1730  * @package  core
1731  * @category preference
1732  * @access   public
1733  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1734  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1735  * @throws   coding_exception
1736  * @return   null
1737  */
1738 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1739     global $DB;
1740     // Static cache, we need to check on each page load, not only every 2 minutes.
1741     static $loadedusers = array();
1742
1743     if (!isset($user->id)) {
1744         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1745     }
1746
1747     if (empty($user->id) or isguestuser($user->id)) {
1748         // No permanent storage for not-logged-in users and guest.
1749         if (!isset($user->preference)) {
1750             $user->preference = array();
1751         }
1752         return;
1753     }
1754
1755     $timenow = time();
1756
1757     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1758         // Already loaded at least once on this page. Are we up to date?
1759         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1760             // No need to reload - we are on the same page and we loaded prefs just a moment ago.
1761             return;
1762
1763         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1764             // No change since the lastcheck on this page.
1765             $user->preference['_lastloaded'] = $timenow;
1766             return;
1767         }
1768     }
1769
1770     // OK, so we have to reload all preferences.
1771     $loadedusers[$user->id] = true;
1772     $user->preference = $DB->get_records_menu('user_preferences', array('userid' => $user->id), '', 'name,value'); // All values.
1773     $user->preference['_lastloaded'] = $timenow;
1774 }
1775
1776 /**
1777  * Called from set/unset_user_preferences, so that the prefs can be correctly reloaded in different sessions.
1778  *
1779  * NOTE: internal function, do not call from other code.
1780  *
1781  * @package core
1782  * @access private
1783  * @param integer $userid the user whose prefs were changed.
1784  */
1785 function mark_user_preferences_changed($userid) {
1786     global $CFG;
1787
1788     if (empty($userid) or isguestuser($userid)) {
1789         // No cache flags for guest and not-logged-in users.
1790         return;
1791     }
1792
1793     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1794 }
1795
1796 /**
1797  * Sets a preference for the specified user.
1798  *
1799  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1800  *
1801  * @package  core
1802  * @category preference
1803  * @access   public
1804  * @param    string            $name  The key to set as preference for the specified user
1805  * @param    string            $value The value to set for the $name key in the specified user's
1806  *                                    record, null means delete current value.
1807  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1808  * @throws   coding_exception
1809  * @return   bool                     Always true or exception
1810  */
1811 function set_user_preference($name, $value, $user = null) {
1812     global $USER, $DB;
1813
1814     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1815         throw new coding_exception('Invalid preference name in set_user_preference() call');
1816     }
1817
1818     if (is_null($value)) {
1819         // Null means delete current.
1820         return unset_user_preference($name, $user);
1821     } else if (is_object($value)) {
1822         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1823     } else if (is_array($value)) {
1824         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1825     }
1826     // Value column maximum length is 1333 characters.
1827     $value = (string)$value;
1828     if (core_text::strlen($value) > 1333) {
1829         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1830     }
1831
1832     if (is_null($user)) {
1833         $user = $USER;
1834     } else if (isset($user->id)) {
1835         // It is a valid object.
1836     } else if (is_numeric($user)) {
1837         $user = (object)array('id' => (int)$user);
1838     } else {
1839         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1840     }
1841
1842     check_user_preferences_loaded($user);
1843
1844     if (empty($user->id) or isguestuser($user->id)) {
1845         // No permanent storage for not-logged-in users and guest.
1846         $user->preference[$name] = $value;
1847         return true;
1848     }
1849
1850     if ($preference = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => $name))) {
1851         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1852             // Preference already set to this value.
1853             return true;
1854         }
1855         $DB->set_field('user_preferences', 'value', $value, array('id' => $preference->id));
1856
1857     } else {
1858         $preference = new stdClass();
1859         $preference->userid = $user->id;
1860         $preference->name   = $name;
1861         $preference->value  = $value;
1862         $DB->insert_record('user_preferences', $preference);
1863     }
1864
1865     // Update value in cache.
1866     $user->preference[$name] = $value;
1867
1868     // Set reload flag for other sessions.
1869     mark_user_preferences_changed($user->id);
1870
1871     return true;
1872 }
1873
1874 /**
1875  * Sets a whole array of preferences for the current user
1876  *
1877  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1878  *
1879  * @package  core
1880  * @category preference
1881  * @access   public
1882  * @param    array             $prefarray An array of key/value pairs to be set
1883  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1884  * @return   bool                         Always true or exception
1885  */
1886 function set_user_preferences(array $prefarray, $user = null) {
1887     foreach ($prefarray as $name => $value) {
1888         set_user_preference($name, $value, $user);
1889     }
1890     return true;
1891 }
1892
1893 /**
1894  * Unsets a preference completely by deleting it from the database
1895  *
1896  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1897  *
1898  * @package  core
1899  * @category preference
1900  * @access   public
1901  * @param    string            $name The key to unset as preference for the specified user
1902  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1903  * @throws   coding_exception
1904  * @return   bool                    Always true or exception
1905  */
1906 function unset_user_preference($name, $user = null) {
1907     global $USER, $DB;
1908
1909     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1910         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1911     }
1912
1913     if (is_null($user)) {
1914         $user = $USER;
1915     } else if (isset($user->id)) {
1916         // It is a valid object.
1917     } else if (is_numeric($user)) {
1918         $user = (object)array('id' => (int)$user);
1919     } else {
1920         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1921     }
1922
1923     check_user_preferences_loaded($user);
1924
1925     if (empty($user->id) or isguestuser($user->id)) {
1926         // No permanent storage for not-logged-in user and guest.
1927         unset($user->preference[$name]);
1928         return true;
1929     }
1930
1931     // Delete from DB.
1932     $DB->delete_records('user_preferences', array('userid' => $user->id, 'name' => $name));
1933
1934     // Delete the preference from cache.
1935     unset($user->preference[$name]);
1936
1937     // Set reload flag for other sessions.
1938     mark_user_preferences_changed($user->id);
1939
1940     return true;
1941 }
1942
1943 /**
1944  * Used to fetch user preference(s)
1945  *
1946  * If no arguments are supplied this function will return
1947  * all of the current user preferences as an array.
1948  *
1949  * If a name is specified then this function
1950  * attempts to return that particular preference value.  If
1951  * none is found, then the optional value $default is returned,
1952  * otherwise null.
1953  *
1954  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1955  *
1956  * @package  core
1957  * @category preference
1958  * @access   public
1959  * @param    string            $name    Name of the key to use in finding a preference value
1960  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1961  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1962  * @throws   coding_exception
1963  * @return   string|mixed|null          A string containing the value of a single preference. An
1964  *                                      array with all of the preferences or null
1965  */
1966 function get_user_preferences($name = null, $default = null, $user = null) {
1967     global $USER;
1968
1969     if (is_null($name)) {
1970         // All prefs.
1971     } else if (is_numeric($name) or $name === '_lastloaded') {
1972         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1973     }
1974
1975     if (is_null($user)) {
1976         $user = $USER;
1977     } else if (isset($user->id)) {
1978         // Is a valid object.
1979     } else if (is_numeric($user)) {
1980         $user = (object)array('id' => (int)$user);
1981     } else {
1982         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1983     }
1984
1985     check_user_preferences_loaded($user);
1986
1987     if (empty($name)) {
1988         // All values.
1989         return $user->preference;
1990     } else if (isset($user->preference[$name])) {
1991         // The single string value.
1992         return $user->preference[$name];
1993     } else {
1994         // Default value (null if not specified).
1995         return $default;
1996     }
1997 }
1998
1999 // FUNCTIONS FOR HANDLING TIME.
2000
2001 /**
2002  * Given date parts in user time produce a GMT timestamp.
2003  *
2004  * @package core
2005  * @category time
2006  * @param int $year The year part to create timestamp of
2007  * @param int $month The month part to create timestamp of
2008  * @param int $day The day part to create timestamp of
2009  * @param int $hour The hour part to create timestamp of
2010  * @param int $minute The minute part to create timestamp of
2011  * @param int $second The second part to create timestamp of
2012  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
2013  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
2014  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
2015  *             applied only if timezone is 99 or string.
2016  * @return int GMT timestamp
2017  */
2018 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
2019
2020     // Save input timezone, required for dst offset check.
2021     $passedtimezone = $timezone;
2022
2023     $timezone = get_user_timezone_offset($timezone);
2024
2025     if (abs($timezone) > 13) {
2026         // Server time.
2027         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2028     } else {
2029         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
2030         $time = usertime($time, $timezone);
2031
2032         // Apply dst for string timezones or if 99 then try dst offset with user's default timezone.
2033         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
2034             $time -= dst_offset_on($time, $passedtimezone);
2035         }
2036     }
2037
2038     return $time;
2039
2040 }
2041
2042 /**
2043  * Format a date/time (seconds) as weeks, days, hours etc as needed
2044  *
2045  * Given an amount of time in seconds, returns string
2046  * formatted nicely as weeks, days, hours etc as needed
2047  *
2048  * @package core
2049  * @category time
2050  * @uses MINSECS
2051  * @uses HOURSECS
2052  * @uses DAYSECS
2053  * @uses YEARSECS
2054  * @param int $totalsecs Time in seconds
2055  * @param stdClass $str Should be a time object
2056  * @return string A nicely formatted date/time string
2057  */
2058 function format_time($totalsecs, $str = null) {
2059
2060     $totalsecs = abs($totalsecs);
2061
2062     if (!$str) {
2063         // Create the str structure the slow way.
2064         $str = new stdClass();
2065         $str->day   = get_string('day');
2066         $str->days  = get_string('days');
2067         $str->hour  = get_string('hour');
2068         $str->hours = get_string('hours');
2069         $str->min   = get_string('min');
2070         $str->mins  = get_string('mins');
2071         $str->sec   = get_string('sec');
2072         $str->secs  = get_string('secs');
2073         $str->year  = get_string('year');
2074         $str->years = get_string('years');
2075     }
2076
2077     $years     = floor($totalsecs/YEARSECS);
2078     $remainder = $totalsecs - ($years*YEARSECS);
2079     $days      = floor($remainder/DAYSECS);
2080     $remainder = $totalsecs - ($days*DAYSECS);
2081     $hours     = floor($remainder/HOURSECS);
2082     $remainder = $remainder - ($hours*HOURSECS);
2083     $mins      = floor($remainder/MINSECS);
2084     $secs      = $remainder - ($mins*MINSECS);
2085
2086     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
2087     $sm = ($mins == 1)  ? $str->min  : $str->mins;
2088     $sh = ($hours == 1) ? $str->hour : $str->hours;
2089     $sd = ($days == 1)  ? $str->day  : $str->days;
2090     $sy = ($years == 1)  ? $str->year  : $str->years;
2091
2092     $oyears = '';
2093     $odays = '';
2094     $ohours = '';
2095     $omins = '';
2096     $osecs = '';
2097
2098     if ($years) {
2099         $oyears  = $years .' '. $sy;
2100     }
2101     if ($days) {
2102         $odays  = $days .' '. $sd;
2103     }
2104     if ($hours) {
2105         $ohours = $hours .' '. $sh;
2106     }
2107     if ($mins) {
2108         $omins  = $mins .' '. $sm;
2109     }
2110     if ($secs) {
2111         $osecs  = $secs .' '. $ss;
2112     }
2113
2114     if ($years) {
2115         return trim($oyears .' '. $odays);
2116     }
2117     if ($days) {
2118         return trim($odays .' '. $ohours);
2119     }
2120     if ($hours) {
2121         return trim($ohours .' '. $omins);
2122     }
2123     if ($mins) {
2124         return trim($omins .' '. $osecs);
2125     }
2126     if ($secs) {
2127         return $osecs;
2128     }
2129     return get_string('now');
2130 }
2131
2132 /**
2133  * Returns a formatted string that represents a date in user time
2134  *
2135  * Returns a formatted string that represents a date in user time
2136  * <b>WARNING: note that the format is for strftime(), not date().</b>
2137  * Because of a bug in most Windows time libraries, we can't use
2138  * the nicer %e, so we have to use %d which has leading zeroes.
2139  * A lot of the fuss in the function is just getting rid of these leading
2140  * zeroes as efficiently as possible.
2141  *
2142  * If parameter fixday = true (default), then take off leading
2143  * zero from %d, else maintain it.
2144  *
2145  * @package core
2146  * @category time
2147  * @param int $date the timestamp in UTC, as obtained from the database.
2148  * @param string $format strftime format. You should probably get this using
2149  *        get_string('strftime...', 'langconfig');
2150  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
2151  *        not 99 then daylight saving will not be added.
2152  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2153  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2154  *        If false then the leading zero is maintained.
2155  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2156  * @return string the formatted date/time.
2157  */
2158 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2159
2160     global $CFG;
2161
2162     if (empty($format)) {
2163         $format = get_string('strftimedaydatetime', 'langconfig');
2164     }
2165
2166     if (!empty($CFG->nofixday)) {
2167         // Config.php can force %d not to be fixed.
2168         $fixday = false;
2169     } else if ($fixday) {
2170         $formatnoday = str_replace('%d', 'DD', $format);
2171         $fixday = ($formatnoday != $format);
2172         $format = $formatnoday;
2173     }
2174
2175     // Note: This logic about fixing 12-hour time to remove unnecessary leading
2176     // zero is required because on Windows, PHP strftime function does not
2177     // support the correct 'hour without leading zero' parameter (%l).
2178     if (!empty($CFG->nofixhour)) {
2179         // Config.php can force %I not to be fixed.
2180         $fixhour = false;
2181     } else if ($fixhour) {
2182         $formatnohour = str_replace('%I', 'HH', $format);
2183         $fixhour = ($formatnohour != $format);
2184         $format = $formatnohour;
2185     }
2186
2187     // Add daylight saving offset for string timezones only, as we can't get dst for
2188     // float values. if timezone is 99 (user default timezone), then try update dst.
2189     if ((99 == $timezone) || !is_numeric($timezone)) {
2190         $date += dst_offset_on($date, $timezone);
2191     }
2192
2193     $timezone = get_user_timezone_offset($timezone);
2194
2195     // If we are running under Windows convert to windows encoding and then back to UTF-8
2196     // (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2197
2198     if (abs($timezone) > 13) {
2199         // Server time.
2200         $datestring = date_format_string($date, $format, $timezone);
2201         if ($fixday) {
2202             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
2203             $datestring = str_replace('DD', $daystring, $datestring);
2204         }
2205         if ($fixhour) {
2206             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
2207             $datestring = str_replace('HH', $hourstring, $datestring);
2208         }
2209
2210     } else {
2211         $date += (int)($timezone * 3600);
2212         $datestring = date_format_string($date, $format, $timezone);
2213         if ($fixday) {
2214             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2215             $datestring = str_replace('DD', $daystring, $datestring);
2216         }
2217         if ($fixhour) {
2218             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2219             $datestring = str_replace('HH', $hourstring, $datestring);
2220         }
2221     }
2222
2223     return $datestring;
2224 }
2225
2226 /**
2227  * Returns a formatted date ensuring it is UTF-8.
2228  *
2229  * If we are running under Windows convert to Windows encoding and then back to UTF-8
2230  * (because it's impossible to specify UTF-8 to fetch locale info in Win32).
2231  *
2232  * This function does not do any calculation regarding the user preferences and should
2233  * therefore receive the final date timestamp, format and timezone. Timezone being only used
2234  * to differentiate the use of server time or not (strftime() against gmstrftime()).
2235  *
2236  * @param int $date the timestamp.
2237  * @param string $format strftime format.
2238  * @param int|float $tz the numerical timezone, typically returned by {@link get_user_timezone_offset()}.
2239  * @return string the formatted date/time.
2240  * @since 2.3.3
2241  */
2242 function date_format_string($date, $format, $tz = 99) {
2243     global $CFG;
2244     if (abs($tz) > 13) {
2245         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2246             $format = core_text::convert($format, 'utf-8', $localewincharset);
2247             $datestring = strftime($format, $date);
2248             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2249         } else {
2250             $datestring = strftime($format, $date);
2251         }
2252     } else {
2253         if ($CFG->ostype == 'WINDOWS' and $localewincharset = get_string('localewincharset', 'langconfig')) {
2254             $format = core_text::convert($format, 'utf-8', $localewincharset);
2255             $datestring = gmstrftime($format, $date);
2256             $datestring = core_text::convert($datestring, $localewincharset, 'utf-8');
2257         } else {
2258             $datestring = gmstrftime($format, $date);
2259         }
2260     }
2261     return $datestring;
2262 }
2263
2264 /**
2265  * Given a $time timestamp in GMT (seconds since epoch),
2266  * returns an array that represents the date in user time
2267  *
2268  * @package core
2269  * @category time
2270  * @uses HOURSECS
2271  * @param int $time Timestamp in GMT
2272  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2273  *        dst offset is applied {@link http://docs.moodle.org/dev/Time_API#Timezone}
2274  * @return array An array that represents the date in user time
2275  */
2276 function usergetdate($time, $timezone=99) {
2277
2278     // Save input timezone, required for dst offset check.
2279     $passedtimezone = $timezone;
2280
2281     $timezone = get_user_timezone_offset($timezone);
2282
2283     if (abs($timezone) > 13) {
2284         // Server time.
2285         return getdate($time);
2286     }
2287
2288     // Add daylight saving offset for string timezones only, as we can't get dst for
2289     // float values. if timezone is 99 (user default timezone), then try update dst.
2290     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2291         $time += dst_offset_on($time, $passedtimezone);
2292     }
2293
2294     $time += intval((float)$timezone * HOURSECS);
2295
2296     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2297
2298     // Be careful to ensure the returned array matches that produced by getdate() above.
2299     list(
2300         $getdate['month'],
2301         $getdate['weekday'],
2302         $getdate['yday'],
2303         $getdate['year'],
2304         $getdate['mon'],
2305         $getdate['wday'],
2306         $getdate['mday'],
2307         $getdate['hours'],
2308         $getdate['minutes'],
2309         $getdate['seconds']
2310     ) = explode('_', $datestring);
2311
2312     // Set correct datatype to match with getdate().
2313     $getdate['seconds'] = (int)$getdate['seconds'];
2314     $getdate['yday'] = (int)$getdate['yday'] - 1; // The function gmstrftime returns 0 through 365.
2315     $getdate['year'] = (int)$getdate['year'];
2316     $getdate['mon'] = (int)$getdate['mon'];
2317     $getdate['wday'] = (int)$getdate['wday'];
2318     $getdate['mday'] = (int)$getdate['mday'];
2319     $getdate['hours'] = (int)$getdate['hours'];
2320     $getdate['minutes']  = (int)$getdate['minutes'];
2321     return $getdate;
2322 }
2323
2324 /**
2325  * Given a GMT timestamp (seconds since epoch), offsets it by
2326  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2327  *
2328  * @package core
2329  * @category time
2330  * @uses HOURSECS
2331  * @param int $date Timestamp in GMT
2332  * @param float|int|string $timezone timezone to calculate GMT time offset before
2333  *        calculating user time, 99 is default user timezone
2334  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2335  * @return int
2336  */
2337 function usertime($date, $timezone=99) {
2338
2339     $timezone = get_user_timezone_offset($timezone);
2340
2341     if (abs($timezone) > 13) {
2342         return $date;
2343     }
2344     return $date - (int)($timezone * HOURSECS);
2345 }
2346
2347 /**
2348  * Given a time, return the GMT timestamp of the most recent midnight
2349  * for the current user.
2350  *
2351  * @package core
2352  * @category time
2353  * @param int $date Timestamp in GMT
2354  * @param float|int|string $timezone timezone to calculate GMT time offset before
2355  *        calculating user midnight time, 99 is default user timezone
2356  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2357  * @return int Returns a GMT timestamp
2358  */
2359 function usergetmidnight($date, $timezone=99) {
2360
2361     $userdate = usergetdate($date, $timezone);
2362
2363     // Time of midnight of this user's day, in GMT.
2364     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2365
2366 }
2367
2368 /**
2369  * Returns a string that prints the user's timezone
2370  *
2371  * @package core
2372  * @category time
2373  * @param float|int|string $timezone timezone to calculate GMT time offset before
2374  *        calculating user timezone, 99 is default user timezone
2375  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2376  * @return string
2377  */
2378 function usertimezone($timezone=99) {
2379
2380     $tz = get_user_timezone($timezone);
2381
2382     if (!is_float($tz)) {
2383         return $tz;
2384     }
2385
2386     if (abs($tz) > 13) {
2387         // Server time.
2388         return get_string('serverlocaltime');
2389     }
2390
2391     if ($tz == intval($tz)) {
2392         // Don't show .0 for whole hours.
2393         $tz = intval($tz);
2394     }
2395
2396     if ($tz == 0) {
2397         return 'UTC';
2398     } else if ($tz > 0) {
2399         return 'UTC+'.$tz;
2400     } else {
2401         return 'UTC'.$tz;
2402     }
2403
2404 }
2405
2406 /**
2407  * Returns a float which represents the user's timezone difference from GMT in hours
2408  * Checks various settings and picks the most dominant of those which have a value
2409  *
2410  * @package core
2411  * @category time
2412  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2413  *        99 is default user timezone
2414  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2415  * @return float
2416  */
2417 function get_user_timezone_offset($tz = 99) {
2418     $tz = get_user_timezone($tz);
2419
2420     if (is_float($tz)) {
2421         return $tz;
2422     } else {
2423         $tzrecord = get_timezone_record($tz);
2424         if (empty($tzrecord)) {
2425             return 99.0;
2426         }
2427         return (float)$tzrecord->gmtoff / HOURMINS;
2428     }
2429 }
2430
2431 /**
2432  * Returns an int which represents the systems's timezone difference from GMT in seconds
2433  *
2434  * @package core
2435  * @category time
2436  * @param float|int|string $tz timezone for which offset is required.
2437  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2438  * @return int|bool if found, false is timezone 99 or error
2439  */
2440 function get_timezone_offset($tz) {
2441     if ($tz == 99) {
2442         return false;
2443     }
2444
2445     if (is_numeric($tz)) {
2446         return intval($tz * 60*60);
2447     }
2448
2449     if (!$tzrecord = get_timezone_record($tz)) {
2450         return false;
2451     }
2452     return intval($tzrecord->gmtoff * 60);
2453 }
2454
2455 /**
2456  * Returns a float or a string which denotes the user's timezone
2457  * 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)
2458  * means that for this timezone there are also DST rules to be taken into account
2459  * Checks various settings and picks the most dominant of those which have a value
2460  *
2461  * @package core
2462  * @category time
2463  * @param float|int|string $tz timezone to calculate GMT time offset before
2464  *        calculating user timezone, 99 is default user timezone
2465  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2466  * @return float|string
2467  */
2468 function get_user_timezone($tz = 99) {
2469     global $USER, $CFG;
2470
2471     $timezones = array(
2472         $tz,
2473         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2474         isset($USER->timezone) ? $USER->timezone : 99,
2475         isset($CFG->timezone) ? $CFG->timezone : 99,
2476         );
2477
2478     $tz = 99;
2479
2480     // Loop while $tz is, empty but not zero, or 99, and there is another timezone is the array.
2481     while (((empty($tz) && !is_numeric($tz)) || $tz == 99) && $next = each($timezones)) {
2482         $tz = $next['value'];
2483     }
2484     return is_numeric($tz) ? (float) $tz : $tz;
2485 }
2486
2487 /**
2488  * Returns cached timezone record for given $timezonename
2489  *
2490  * @package core
2491  * @param string $timezonename name of the timezone
2492  * @return stdClass|bool timezonerecord or false
2493  */
2494 function get_timezone_record($timezonename) {
2495     global $DB;
2496     static $cache = null;
2497
2498     if ($cache === null) {
2499         $cache = array();
2500     }
2501
2502     if (isset($cache[$timezonename])) {
2503         return $cache[$timezonename];
2504     }
2505
2506     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2507                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2508 }
2509
2510 /**
2511  * Build and store the users Daylight Saving Time (DST) table
2512  *
2513  * @package core
2514  * @param int $fromyear Start year for the table, defaults to 1971
2515  * @param int $toyear End year for the table, defaults to 2035
2516  * @param int|float|string $strtimezone timezone to check if dst should be applied.
2517  * @return bool
2518  */
2519 function calculate_user_dst_table($fromyear = null, $toyear = null, $strtimezone = null) {
2520     global $SESSION, $DB;
2521
2522     $usertz = get_user_timezone($strtimezone);
2523
2524     if (is_float($usertz)) {
2525         // Trivial timezone, no DST.
2526         return false;
2527     }
2528
2529     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2530         // We have pre-calculated values, but the user's effective TZ has changed in the meantime, so reset.
2531         unset($SESSION->dst_offsets);
2532         unset($SESSION->dst_range);
2533     }
2534
2535     if (!empty($SESSION->dst_offsets) && empty($fromyear) && empty($toyear)) {
2536         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table.
2537         // This will be the return path most of the time, pretty light computationally.
2538         return true;
2539     }
2540
2541     // Reaching here means we either need to extend our table or create it from scratch.
2542
2543     // Remember which TZ we calculated these changes for.
2544     $SESSION->dst_offsettz = $usertz;
2545
2546     if (empty($SESSION->dst_offsets)) {
2547         // If we 're creating from scratch, put the two guard elements in there.
2548         $SESSION->dst_offsets = array(1 => null, 0 => null);
2549     }
2550     if (empty($SESSION->dst_range)) {
2551         // If creating from scratch.
2552         $from = max((empty($fromyear) ? intval(date('Y')) - 3 : $fromyear), 1971);
2553         $to   = min((empty($toyear)   ? intval(date('Y')) + 3 : $toyear),   2035);
2554
2555         // Fill in the array with the extra years we need to process.
2556         $yearstoprocess = array();
2557         for ($i = $from; $i <= $to; ++$i) {
2558             $yearstoprocess[] = $i;
2559         }
2560
2561         // Take note of which years we have processed for future calls.
2562         $SESSION->dst_range = array($from, $to);
2563     } else {
2564         // If needing to extend the table, do the same.
2565         $yearstoprocess = array();
2566
2567         $from = max((empty($fromyear) ? $SESSION->dst_range[0] : $fromyear), 1971);
2568         $to   = min((empty($toyear)   ? $SESSION->dst_range[1] : $toyear),   2035);
2569
2570         if ($from < $SESSION->dst_range[0]) {
2571             // Take note of which years we need to process and then note that we have processed them for future calls.
2572             for ($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2573                 $yearstoprocess[] = $i;
2574             }
2575             $SESSION->dst_range[0] = $from;
2576         }
2577         if ($to > $SESSION->dst_range[1]) {
2578             // Take note of which years we need to process and then note that we have processed them for future calls.
2579             for ($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2580                 $yearstoprocess[] = $i;
2581             }
2582             $SESSION->dst_range[1] = $to;
2583         }
2584     }
2585
2586     if (empty($yearstoprocess)) {
2587         // This means that there was a call requesting a SMALLER range than we have already calculated.
2588         return true;
2589     }
2590
2591     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2592     // Also, the array is sorted in descending timestamp order!
2593
2594     // Get DB data.
2595
2596     static $presetscache = array();
2597     if (!isset($presetscache[$usertz])) {
2598         $presetscache[$usertz] = $DB->get_records('timezone', array('name' => $usertz),
2599             'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, '.
2600             'std_startday, std_weekday, std_skipweeks, std_time');
2601     }
2602     if (empty($presetscache[$usertz])) {
2603         return false;
2604     }
2605
2606     // Remove ending guard (first element of the array).
2607     reset($SESSION->dst_offsets);
2608     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2609
2610     // Add all required change timestamps.
2611     foreach ($yearstoprocess as $y) {
2612         // Find the record which is in effect for the year $y.
2613         foreach ($presetscache[$usertz] as $year => $preset) {
2614             if ($year <= $y) {
2615                 break;
2616             }
2617         }
2618
2619         $changes = dst_changes_for_year($y, $preset);
2620
2621         if ($changes === null) {
2622             continue;
2623         }
2624         if ($changes['dst'] != 0) {
2625             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2626         }
2627         if ($changes['std'] != 0) {
2628             $SESSION->dst_offsets[$changes['std']] = 0;
2629         }
2630     }
2631
2632     // Put in a guard element at the top.
2633     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2634     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = null; // DAYSECS is arbitrary, any "small" number will do.
2635
2636     // Sort again.
2637     krsort($SESSION->dst_offsets);
2638
2639     return true;
2640 }
2641
2642 /**
2643  * Calculates the required DST change and returns a Timestamp Array
2644  *
2645  * @package core
2646  * @category time
2647  * @uses HOURSECS
2648  * @uses MINSECS
2649  * @param int|string $year Int or String Year to focus on
2650  * @param object $timezone Instatiated Timezone object
2651  * @return array|null Array dst => xx, 0 => xx, std => yy, 1 => yy or null
2652  */
2653 function dst_changes_for_year($year, $timezone) {
2654
2655     if ($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 &&
2656         $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2657         return null;
2658     }
2659
2660     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2661     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2662
2663     list($dsthour, $dstmin) = explode(':', $timezone->dst_time);
2664     list($stdhour, $stdmin) = explode(':', $timezone->std_time);
2665
2666     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2667     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2668
2669     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2670     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2671     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2672
2673     $timedst += $dsthour * HOURSECS + $dstmin * MINSECS;
2674     $timestd += $stdhour * HOURSECS + $stdmin * MINSECS;
2675
2676     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2677 }
2678
2679 /**
2680  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2681  * - Note: Daylight saving only works for string timezones and not for float.
2682  *
2683  * @package core
2684  * @category time
2685  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2686  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2687  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2688  * @return int
2689  */
2690 function dst_offset_on($time, $strtimezone = null) {
2691     global $SESSION;
2692
2693     if (!calculate_user_dst_table(null, null, $strtimezone) || empty($SESSION->dst_offsets)) {
2694         return 0;
2695     }
2696
2697     reset($SESSION->dst_offsets);
2698     while (list($from, $offset) = each($SESSION->dst_offsets)) {
2699         if ($from <= $time) {
2700             break;
2701         }
2702     }
2703
2704     // This is the normal return path.
2705     if ($offset !== null) {
2706         return $offset;
2707     }
2708
2709     // Reaching this point means we haven't calculated far enough, do it now:
2710     // Calculate extra DST changes if needed and recurse. The recursion always
2711     // moves toward the stopping condition, so will always end.
2712
2713     if ($from == 0) {
2714         // We need a year smaller than $SESSION->dst_range[0].
2715         if ($SESSION->dst_range[0] == 1971) {
2716             return 0;
2717         }
2718         calculate_user_dst_table($SESSION->dst_range[0] - 5, null, $strtimezone);
2719         return dst_offset_on($time, $strtimezone);
2720     } else {
2721         // We need a year larger than $SESSION->dst_range[1].
2722         if ($SESSION->dst_range[1] == 2035) {
2723             return 0;
2724         }
2725         calculate_user_dst_table(null, $SESSION->dst_range[1] + 5, $strtimezone);
2726         return dst_offset_on($time, $strtimezone);
2727     }
2728 }
2729
2730 /**
2731  * Calculates when the day appears in specific month
2732  *
2733  * @package core
2734  * @category time
2735  * @param int $startday starting day of the month
2736  * @param int $weekday The day when week starts (normally taken from user preferences)
2737  * @param int $month The month whose day is sought
2738  * @param int $year The year of the month whose day is sought
2739  * @return int
2740  */
2741 function find_day_in_month($startday, $weekday, $month, $year) {
2742
2743     $daysinmonth = days_in_month($month, $year);
2744
2745     if ($weekday == -1) {
2746         // Don't care about weekday, so return:
2747         //    abs($startday) if $startday != -1
2748         //    $daysinmonth otherwise.
2749         return ($startday == -1) ? $daysinmonth : abs($startday);
2750     }
2751
2752     // From now on we 're looking for a specific weekday.
2753
2754     // Give "end of month" its actual value, since we know it.
2755     if ($startday == -1) {
2756         $startday = -1 * $daysinmonth;
2757     }
2758
2759     // Starting from day $startday, the sign is the direction.
2760
2761     if ($startday < 1) {
2762
2763         $startday = abs($startday);
2764         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2765
2766         // This is the last such weekday of the month.
2767         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2768         if ($lastinmonth > $daysinmonth) {
2769             $lastinmonth -= 7;
2770         }
2771
2772         // Find the first such weekday <= $startday.
2773         while ($lastinmonth > $startday) {
2774             $lastinmonth -= 7;
2775         }
2776
2777         return $lastinmonth;
2778
2779     } else {
2780
2781         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2782
2783         $diff = $weekday - $indexweekday;
2784         if ($diff < 0) {
2785             $diff += 7;
2786         }
2787
2788         // This is the first such weekday of the month equal to or after $startday.
2789         $firstfromindex = $startday + $diff;
2790
2791         return $firstfromindex;
2792
2793     }
2794 }
2795
2796 /**
2797  * Calculate the number of days in a given month
2798  *
2799  * @package core
2800  * @category time
2801  * @param int $month The month whose day count is sought
2802  * @param int $year The year of the month whose day count is sought
2803  * @return int
2804  */
2805 function days_in_month($month, $year) {
2806     return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2807 }
2808
2809 /**
2810  * Calculate the position in the week of a specific calendar day
2811  *
2812  * @package core
2813  * @category time
2814  * @param int $day The day of the date whose position in the week is sought
2815  * @param int $month The month of the date whose position in the week is sought
2816  * @param int $year The year of the date whose position in the week is sought
2817  * @return int
2818  */
2819 function dayofweek($day, $month, $year) {
2820     // I wonder if this is any different from strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));.
2821     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2822 }
2823
2824 // USER AUTHENTICATION AND LOGIN.
2825
2826 /**
2827  * Returns full login url.
2828  *
2829  * @return string login url
2830  */
2831 function get_login_url() {
2832     global $CFG;
2833
2834     $url = "$CFG->wwwroot/login/index.php";
2835
2836     if (!empty($CFG->loginhttps)) {
2837         $url = str_replace('http:', 'https:', $url);
2838     }
2839
2840     return $url;
2841 }
2842
2843 /**
2844  * This function checks that the current user is logged in and has the
2845  * required privileges
2846  *
2847  * This function checks that the current user is logged in, and optionally
2848  * whether they are allowed to be in a particular course and view a particular
2849  * course module.
2850  * If they are not logged in, then it redirects them to the site login unless
2851  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2852  * case they are automatically logged in as guests.
2853  * If $courseid is given and the user is not enrolled in that course then the
2854  * user is redirected to the course enrolment page.
2855  * If $cm is given and the course module is hidden and the user is not a teacher
2856  * in the course then the user is redirected to the course home page.
2857  *
2858  * When $cm parameter specified, this function sets page layout to 'module'.
2859  * You need to change it manually later if some other layout needed.
2860  *
2861  * @package    core_access
2862  * @category   access
2863  *
2864  * @param mixed $courseorid id of the course or course object
2865  * @param bool $autologinguest default true
2866  * @param object $cm course module object
2867  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2868  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2869  *             in order to keep redirects working properly. MDL-14495
2870  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2871  * @return mixed Void, exit, and die depending on path
2872  * @throws coding_exception
2873  * @throws require_login_exception
2874  */
2875 function require_login($courseorid = null, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
2876     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2877
2878     // Must not redirect when byteserving already started.
2879     if (!empty($_SERVER['HTTP_RANGE'])) {
2880         $preventredirect = true;
2881     }
2882
2883     // Setup global $COURSE, themes, language and locale.
2884     if (!empty($courseorid)) {
2885         if (is_object($courseorid)) {
2886             $course = $courseorid;
2887         } else if ($courseorid == SITEID) {
2888             $course = clone($SITE);
2889         } else {
2890             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2891         }
2892         if ($cm) {
2893             if ($cm->course != $course->id) {
2894                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2895             }
2896             // Make sure we have a $cm from get_fast_modinfo as this contains activity access details.
2897             if (!($cm instanceof cm_info)) {
2898                 // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
2899                 // db queries so this is not really a performance concern, however it is obviously
2900                 // better if you use get_fast_modinfo to get the cm before calling this.
2901                 $modinfo = get_fast_modinfo($course);
2902                 $cm = $modinfo->get_cm($cm->id);
2903             }
2904             $PAGE->set_cm($cm, $course); // Set's up global $COURSE.
2905             $PAGE->set_pagelayout('incourse');
2906         } else {
2907             $PAGE->set_course($course); // Set's up global $COURSE.
2908         }
2909     } else {
2910         // Do not touch global $COURSE via $PAGE->set_course(),
2911         // the reasons is we need to be able to call require_login() at any time!!
2912         $course = $SITE;
2913         if ($cm) {
2914             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2915         }
2916     }
2917
2918     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2919     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2920     // risk leading the user back to the AJAX request URL.
2921     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2922         $setwantsurltome = false;
2923     }
2924
2925     // Redirect to the login page if session has expired, only with dbsessions enabled (MDL-35029) to maintain current behaviour.
2926     if ((!isloggedin() or isguestuser()) && !empty($SESSION->has_timed_out) && !$preventredirect && !empty($CFG->dbsessions)) {
2927         if ($setwantsurltome) {
2928             $SESSION->wantsurl = qualified_me();
2929         }
2930         redirect(get_login_url());
2931     }
2932
2933     // If the user is not even logged in yet then make sure they are.
2934     if (!isloggedin()) {
2935         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2936             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2937                 // Misconfigured site guest, just redirect to login page.
2938                 redirect(get_login_url());
2939                 exit; // Never reached.
2940             }
2941             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2942             complete_user_login($guest);
2943             $USER->autologinguest = true;
2944             $SESSION->lang = $lang;
2945         } else {
2946             // NOTE: $USER->site check was obsoleted by session test cookie, $USER->confirmed test is in login/index.php.
2947             if ($preventredirect) {
2948                 throw new require_login_exception('You are not logged in');
2949             }
2950
2951             if ($setwantsurltome) {
2952                 $SESSION->wantsurl = qualified_me();
2953             }
2954             if (!empty($_SERVER['HTTP_REFERER'])) {
2955                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2956             }
2957             redirect(get_login_url());
2958             exit; // Never reached.
2959         }
2960     }
2961
2962     // Loginas as redirection if needed.
2963     if ($course->id != SITEID and session_is_loggedinas()) {
2964         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2965             if ($USER->loginascontext->instanceid != $course->id) {
2966                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2967             }
2968         }
2969     }
2970
2971     // Check whether the user should be changing password (but only if it is REALLY them).
2972     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2973         $userauth = get_auth_plugin($USER->auth);
2974         if ($userauth->can_change_password() and !$preventredirect) {
2975             if ($setwantsurltome) {
2976                 $SESSION->wantsurl = qualified_me();
2977             }
2978             if ($changeurl = $userauth->change_password_url()) {
2979                 // Use plugin custom url.
2980                 redirect($changeurl);
2981             } else {
2982                 // Use moodle internal method.
2983                 if (empty($CFG->loginhttps)) {
2984                     redirect($CFG->wwwroot .'/login/change_password.php');
2985                 } else {
2986                     $wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
2987                     redirect($wwwroot .'/login/change_password.php');
2988                 }
2989             }
2990         } else {
2991             print_error('nopasswordchangeforced', 'auth');
2992         }
2993     }
2994
2995     // Check that the user account is properly set up.
2996     if (user_not_fully_set_up($USER)) {
2997         if ($preventredirect) {
2998             throw new require_login_exception('User not fully set-up');
2999         }
3000         if ($setwantsurltome) {
3001             $SESSION->wantsurl = qualified_me();
3002         }
3003         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
3004     }
3005
3006     // Make sure the USER has a sesskey set up. Used for CSRF protection.
3007     sesskey();
3008
3009     // Do not bother admins with any formalities.
3010     if (is_siteadmin()) {
3011         // Set accesstime or the user will appear offline which messes up messaging.
3012         user_accesstime_log($course->id);
3013         return;
3014     }
3015
3016     // Check that the user has agreed to a site policy if there is one - do not test in case of admins.
3017     if (!$USER->policyagreed and !is_siteadmin()) {
3018         if (!empty($CFG->sitepolicy) and !isguestuser()) {
3019             if ($preventredirect) {
3020                 throw new require_login_exception('Policy not agreed');
3021             }
3022             if ($setwantsurltome) {
3023                 $SESSION->wantsurl = qualified_me();
3024             }
3025             redirect($CFG->wwwroot .'/user/policy.php');
3026         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
3027             if ($preventredirect) {
3028                 throw new require_login_exception('Policy not agreed');
3029             }
3030             if ($setwantsurltome) {
3031                 $SESSION->wantsurl = qualified_me();
3032             }
3033             redirect($CFG->wwwroot .'/user/policy.php');
3034         }
3035     }
3036
3037     // Fetch the system context, the course context, and prefetch its child contexts.
3038     $sysctx = context_system::instance();
3039     $coursecontext = context_course::instance($course->id, MUST_EXIST);
3040     if ($cm) {
3041         $cmcontext = context_module::instance($cm->id, MUST_EXIST);
3042     } else {
3043         $cmcontext = null;
3044     }
3045
3046     // If the site is currently under maintenance, then print a message.
3047     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
3048         if ($preventredirect) {
3049             throw new require_login_exception('Maintenance in progress');
3050         }
3051
3052         print_maintenance_message();
3053     }
3054
3055     // Make sure the course itself is not hidden.
3056     if ($course->id == SITEID) {
3057         // Frontpage can not be hidden.
3058     } else {
3059         if (is_role_switched($course->id)) {
3060             // When switching roles ignore the hidden flag - user had to be in course to do the switch.
3061         } else {
3062             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
3063                 // Originally there was also test of parent category visibility, BUT is was very slow in complex queries
3064                 // involving "my courses" now it is also possible to simply hide all courses user is not enrolled in :-).
3065                 if ($preventredirect) {
3066                     throw new require_login_exception('Course is hidden');
3067                 }
3068                 // We need to override the navigation URL as the course won't have been added to the navigation and thus
3069                 // the navigation will mess up when trying to find it.
3070                 navigation_node::override_active_url(new moodle_url('/'));
3071                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
3072             }
3073         }
3074     }
3075
3076     // Is the user enrolled?
3077     if ($course->id == SITEID) {
3078         // Everybody is enrolled on the frontpage.
3079     } else {
3080         if (session_is_loggedinas()) {
3081             // Make sure the REAL person can access this course first.
3082             $realuser = session_get_realuser();
3083             if (!is_enrolled($coursecontext, $realuser->id, '', true) and
3084                 !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
3085                 if ($preventredirect) {
3086                     throw new require_login_exception('Invalid course login-as access');
3087                 }
3088                 echo $OUTPUT->header();
3089                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
3090             }
3091         }
3092
3093         $access = false;
3094
3095         if (is_role_switched($course->id)) {
3096             // Ok, user had to be inside this course before the switch.
3097             $access = true;
3098
3099         } else if (is_viewing($coursecontext, $USER)) {
3100             // Ok, no need to mess with enrol.
3101             $access = true;
3102
3103         } else {
3104             if (isset($USER->enrol['enrolled'][$course->id])) {
3105                 if ($USER->enrol['enrolled'][$course->id] > time()) {
3106                     $access = true;
3107                     if (isset($USER->enrol['tempguest'][$course->id])) {
3108                         unset($USER->enrol['tempguest'][$course->id]);
3109                         remove_temp_course_roles($coursecontext);
3110                     }
3111                 } else {
3112                     // Expired.
3113                     unset($USER->enrol['enrolled'][$course->id]);
3114                 }
3115             }
3116             if (isset($USER->enrol['tempguest'][$course->id])) {
3117                 if ($USER->enrol['tempguest'][$course->id] == 0) {
3118                     $access = true;
3119                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
3120                     $access = true;
3121                 } else {
3122                     // Expired.
3123                     unset($USER->enrol['tempguest'][$course->id]);
3124                     remove_temp_course_roles($coursecontext);
3125                 }
3126             }
3127
3128             if (!$access) {
3129                 // Cache not ok.
3130                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
3131                 if ($until !== false) {
3132                     // Active participants may always access, a timestamp in the future, 0 (always) or false.
3133                     if ($until == 0) {
3134                         $until = ENROL_MAX_TIMESTAMP;
3135                     }
3136                     $USER->enrol['enrolled'][$course->id] = $until;
3137                     $access = true;
3138
3139                 } else {
3140                     $params = array('courseid' => $course->id, 'status' => ENROL_INSTANCE_ENABLED);
3141                     $instances = $DB->get_records('enrol', $params, 'sortorder, id ASC');
3142                     $enrols = enrol_get_plugins(true);
3143                     // First ask all enabled enrol instances in course if they want to auto enrol user.
3144                     foreach ($instances as $instance) {
3145                         if (!isset($enrols[$instance->enrol])) {
3146                             continue;
3147                         }
3148                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
3149                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
3150                         if ($until !== false) {
3151                             if ($until == 0) {
3152                                 $until = ENROL_MAX_TIMESTAMP;
3153                             }
3154                             $USER->enrol['enrolled'][$course->id] = $until;
3155                             $access = true;
3156                             break;
3157                         }
3158                     }
3159                     // If not enrolled yet try to gain temporary guest access.
3160                     if (!$access) {
3161                         foreach ($instances as $instance) {
3162                             if (!isset($enrols[$instance->enrol])) {
3163                                 continue;
3164                             }
3165                             // Get a duration for the guest access, a timestamp in the future or false.
3166                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3167                             if ($until !== false and $until > time()) {
3168                                 $USER->enrol['tempguest'][$course->id] = $until;
3169                                 $access = true;
3170                                 break;
3171                             }
3172                         }
3173                     }
3174                 }
3175             }
3176         }
3177
3178         if (!$access) {
3179             if ($preventredirect) {
3180                 throw new require_login_exception('Not enrolled');
3181             }
3182             if ($setwantsurltome) {
3183                 $SESSION->wantsurl = qualified_me();
3184             }
3185             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3186         }
3187     }
3188
3189     // Check visibility of activity to current user; includes visible flag, groupmembersonly, conditional availability, etc.
3190     if ($cm && !$cm->uservisible) {
3191         if ($preventredirect) {
3192             throw new require_login_exception('Activity is hidden');
3193         }
3194         if ($course->id != SITEID) {
3195             $url = new moodle_url('/course/view.php', array('id' => $course->id));
3196         } else {
3197             $url = new moodle_url('/');
3198         }
3199         redirect($url, get_string('activityiscurrentlyhidden'));
3200     }
3201
3202     // Finally access granted, update lastaccess times.
3203     user_accesstime_log($course->id);
3204 }
3205
3206
3207 /**
3208  * This function just makes sure a user is logged out.
3209  *
3210  * @package    core_access
3211  * @category   access
3212  */
3213 function require_logout() {
3214     global $USER;
3215
3216     $params = $USER;
3217
3218     if (isloggedin()) {
3219         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
3220
3221         $authsequence = get_enabled_auth_plugins(); // Auths, in sequence.
3222         foreach ($authsequence as $authname) {
3223             $authplugin = get_auth_plugin($authname);
3224             $authplugin->prelogout_hook();
3225         }
3226     }
3227
3228     events_trigger('user_logout', $params);
3229     session_get_instance()->terminate_current();
3230     unset($params);
3231 }
3232
3233 /**
3234  * Weaker version of require_login()
3235  *
3236  * This is a weaker version of {@link require_login()} which only requires login
3237  * when called from within a course rather than the site page, unless
3238  * the forcelogin option is turned on.
3239  * @see require_login()
3240  *
3241  * @package    core_access
3242  * @category   access
3243  *
3244  * @param mixed $courseorid The course object or id in question
3245  * @param bool $autologinguest Allow autologin guests if that is wanted
3246  * @param object $cm Course activity module if known
3247  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3248  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3249  *             in order to keep redirects working properly. MDL-14495
3250  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3251  * @return void
3252  * @throws coding_exception
3253  */
3254 function require_course_login($courseorid, $autologinguest = true, $cm = null, $setwantsurltome = true, $preventredirect = false) {
3255     global $CFG, $PAGE, $SITE;
3256     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3257           or (!is_object($courseorid) and $courseorid == SITEID);
3258     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3259         // Note: nearly all pages call get_fast_modinfo anyway and it does not make any
3260         // db queries so this is not really a performance concern, however it is obviously
3261         // better if you use get_fast_modinfo to get the cm before calling this.
3262         if (is_object($courseorid)) {
3263             $course = $courseorid;
3264         } else {
3265             $course = clone($SITE);
3266         }
3267         $modinfo = get_fast_modinfo($course);
3268         $cm = $modinfo->get_cm($cm->id);
3269     }
3270     if (!empty($CFG->forcelogin)) {
3271         // Login required for both SITE and courses.
3272         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3273
3274     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3275         // Always login for hidden activities.
3276         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3277
3278     } else if ($issite) {
3279         // Login for SITE not required.
3280         if ($cm and empty($cm->visible)) {
3281             // Hidden activities are not accessible without login.
3282             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3283         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3284             // Not-logged-in users do not have any group membership.
3285             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3286         } else {
3287             // We still need to instatiate PAGE vars properly so that things that rely on it like navigation function correctly.
3288             if (!empty($courseorid)) {
3289                 if (is_object($courseorid)) {
3290                     $course = $courseorid;
3291                 } else {
3292                     $course = clone($SITE);
3293                 }
3294                 if ($cm) {
3295                     if ($cm->course != $course->id) {
3296                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3297                     }
3298                     $PAGE->set_cm($cm, $course);
3299                     $PAGE->set_pagelayout('incourse');
3300                 } else {
3301                     $PAGE->set_course($course);
3302                 }
3303             } else {
3304                 // If $PAGE->course, and hence $PAGE->context, have not already been set up properly, set them up now.
3305                 $PAGE->set_course($PAGE->course);
3306             }
3307             // TODO: verify conditional activities here.
3308             user_accesstime_log(SITEID);
3309             return;
3310         }
3311
3312     } else {
3313         // Course login always required.
3314         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3315     }
3316 }
3317
3318 /**
3319  * Require key login. Function terminates with error if key not found or incorrect.
3320  *
3321  * @uses NO_MOODLE_COOKIES
3322  * @uses PARAM_ALPHANUM
3323  * @param string $script unique script identifier
3324  * @param int $instance optional instance id
3325  * @return int Instance ID
3326  */
3327 function require_user_key_login($script, $instance=null) {
3328     global $DB;
3329
3330     if (!NO_MOODLE_COOKIES) {
3331         print_error('sessioncookiesdisable');
3332     }
3333
3334     // Extra safety.
3335     @session_write_close();
3336
3337     $keyvalue = required_param('key', PARAM_ALPHANUM);
3338
3339     if (!$key = $DB->get_record('user_private_key', array('script' => $script, 'value' => $keyvalue, 'instance' => $instance))) {
3340         print_error('invalidkey');
3341     }
3342
3343     if (!empty($key->validuntil) and $key->validuntil < time()) {
3344         print_error('expiredkey');
3345     }
3346
3347     if ($key->iprestriction) {
3348         $remoteaddr = getremoteaddr(null);
3349         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3350             print_error('ipmismatch');
3351         }
3352     }
3353
3354     if (!$user = $DB->get_record('user', array('id' => $key->userid))) {
3355         print_error('invaliduserid');
3356     }
3357
3358     // Emulate normal session.
3359     enrol_check_plugins($user);
3360     session_set_user($user);
3361
3362     // Note we are not using normal login.
3363     if (!defined('USER_KEY_LOGIN')) {
3364         define('USER_KEY_LOGIN', true);
3365     }
3366
3367     // Return instance id - it might be empty.
3368     return $key->instance;
3369 }
3370
3371 /**
3372  * Creates a new private user access key.
3373  *
3374  * @param string $script unique target identifier
3375  * @param int $userid
3376  * @param int $instance optional instance id
3377  * @param string $iprestriction optional ip restricted access
3378  * @param timestamp $validuntil key valid only until given data
3379  * @return string access key value
3380  */
3381 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3382     global $DB;
3383
3384     $key = new stdClass();
3385     $key->script        = $script;
3386     $key->userid        = $userid;
3387     $key->instance      = $instance;
3388     $key->iprestriction = $iprestriction;
3389     $key->validuntil    = $validuntil;
3390     $key->timecreated   = time();
3391
3392     // Something long and unique.
3393     $key->value         = md5($userid.'_'.time().random_string(40));
3394     while ($DB->record_exists('user_private_key', array('value' => $key->value))) {
3395         // Must be unique.
3396         $key->value     = md5($userid.'_'.time().random_string(40));
3397     }
3398     $DB->insert_record('user_private_key', $key);
3399     return $key->value;
3400 }
3401
3402 /**
3403  * Delete the user's new private user access keys for a particular script.
3404  *
3405  * @param string $script unique target identifier
3406  * @param int $userid
3407  * @return void
3408  */
3409 function delete_user_key($script, $userid) {
3410     global $DB;
3411     $DB->delete_records('user_private_key', array('script' => $script, 'userid' => $userid));
3412 }
3413
3414 /**
3415  * Gets a private user access key (and creates one if one doesn't exist).
3416  *
3417  * @param string $script unique target identifier
3418  * @param int $userid
3419  * @param int $instance optional instance id
3420  * @param string $iprestriction optional ip restricted access
3421  * @param timestamp $validuntil key valid only until given data
3422  * @return string access key value
3423  */
3424 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3425     global $DB;
3426
3427     if ($key = $DB->get_record('user_private_key', array('script' => $script, 'userid' => $userid,
3428                                                          'instance' => $instance, 'iprestriction' => $iprestriction,
3429                                                          'validuntil' => $validuntil))) {
3430         return $key->value;
3431     } else {
3432         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3433     }
3434 }
3435
3436
3437 /**
3438  * Modify the user table by setting the currently logged in user's last login to now.
3439  *
3440  * @return bool Always returns true
3441  */
3442 function update_user_login_times() {
3443     global $USER, $DB;
3444
3445     if (isguestuser()) {
3446         // Do not update guest access times/ips for performance.
3447         return true;
3448     }
3449
3450     $now = time();
3451
3452     $user = new stdClass();
3453     $user->id = $USER->id;
3454
3455     // Make sure all users that logged in have some firstaccess.
3456     if ($USER->firstaccess == 0) {
3457         $USER->firstaccess = $user->firstaccess = $now;
3458     }
3459
3460     // Store the previous current as lastlogin.
3461     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3462
3463     $USER->currentlogin = $user->currentlogin = $now;
3464
3465     // Function user_accesstime_log() may not update immediately, better do it here.
3466     $USER->lastaccess = $user->lastaccess = $now;
3467     $USER->lastip = $user->lastip = getremoteaddr();
3468
3469     $DB->update_record('user', $user);
3470     return true;
3471 }
3472
3473 /**
3474  * Determines if a user has completed setting up their account.
3475  *
3476  * @param stdClass $user A {@link $USER} object to test for the existence of a valid name and email
3477  * @return bool
3478  */
3479 function user_not_fully_set_up($user) {
3480     if (isguestuser($user)) {
3481         return false;
3482     }
3483     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3484 }
3485
3486 /**
3487  * Check whether the user has exceeded the bounce threshold
3488  *
3489  * @param stdClass $user A {@link $USER} object
3490  * @return bool true => User has exceeded bounce threshold
3491  */
3492 function over_bounce_threshold($user) {
3493     global $CFG, $DB;
3494
3495     if (empty($CFG->handlebounces)) {
3496         return false;
3497     }
3498
3499     if (empty($user->id)) {
3500         // No real (DB) user, nothing to do here.
3501         return false;
3502     }
3503
3504     // Set sensible defaults.
3505     if (empty($CFG->minbounces)) {
3506         $CFG->minbounces = 10;
3507     }
3508     if (empty($CFG->bounceratio)) {
3509         $CFG->bounceratio = .20;
3510     }
3511     $bouncecount = 0;
3512     $sendcount = 0;
3513     if ($bounce = $DB->get_record('user_preferences', array ('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3514         $bouncecount = $bounce->value;
3515     }
3516     if ($send = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3517         $sendcount = $send->value;
3518     }
3519     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3520 }
3521
3522 /**
3523  * Used to increment or reset email sent count
3524  *
3525  * @param stdClass $user object containing an id
3526  * @param bool $reset will reset the count to 0
3527  * @return void
3528  */
3529 function set_send_count($user, $reset=false) {
3530     global $DB;
3531
3532     if (empty($user->id)) {
3533         // No real (DB) user, nothing to do here.
3534         return;
3535     }
3536
3537     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_send_count'))) {
3538         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3539         $DB->update_record('user_preferences', $pref);
3540     } else if (!empty($reset)) {
3541         // If it's not there and we're resetting, don't bother. Make a new one.
3542         $pref = new stdClass();
3543         $pref->name   = 'email_send_count';
3544         $pref->value  = 1;
3545         $pref->userid = $user->id;
3546         $DB->insert_record('user_preferences', $pref, false);
3547     }
3548 }
3549
3550 /**
3551  * Increment or reset user's email bounce count
3552  *
3553  * @param stdClass $user object containing an id
3554  * @param bool $reset will reset the count to 0
3555  */
3556 function set_bounce_count($user, $reset=false) {
3557     global $DB;
3558
3559     if ($pref = $DB->get_record('user_preferences', array('userid' => $user->id, 'name' => 'email_bounce_count'))) {
3560         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3561         $DB->update_record('user_preferences', $pref);
3562     } else if (!empty($reset)) {
3563         // If it's not there and we're resetting, don't bother. Make a new one.
3564         $pref = new stdClass();
3565         $pref->name   = 'email_bounce_count';
3566         $pref->value  = 1;
3567         $pref->userid = $user->id;
3568         $DB->insert_record('user_preferences', $pref, false);
3569     }
3570 }
3571
3572 /**
3573  * Determines if the logged in user is currently moving an activity
3574  *
3575  * @param int $courseid The id of the course being tested
3576  * @return bool
3577  */
3578 function ismoving($courseid) {
3579     global $USER;
3580
3581     if (!empty($USER->activitycopy)) {
3582         return ($USER->activitycopycourse == $courseid);
3583     }
3584     return false;
3585 }
3586
3587 /**
3588  * Returns a persons full name
3589  *
3590  * Given an object containing all of the users name values, this function returns a string with the full name of the person.
3591  * The result may depend on system settings or language.  'override' will force both names to be used even if system settings
3592  * specify one.
3593  *
3594  * @param stdClass $user A {@link $USER} object to get full name of.
3595  * @param bool $override If true then the name will be firstname followed by lastname rather than adhering to fullnamedisplay.
3596  * @return string
3597  */
3598 function fullname($user, $override=false) {
3599     global $CFG, $SESSION;
3600
3601     if (!isset($user->firstname) and !isset($user->lastname)) {
3602         return '';
3603     }
3604
3605     if (!$override) {
3606         if (!empty($CFG->forcefirstname)) {
3607             $user->firstname = $CFG->forcefirstname;
3608         }
3609         if (!empty($CFG->forcelastname)) {
3610             $user->lastname = $CFG->forcelastname;
3611         }
3612     }
3613
3614     if (!empty($SESSION->fullnamedisplay)) {
3615         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3616     }
3617
3618     $template = null;
3619     // If the fullnamedisplay setting is available, set the template to that.
3620     if (isset($CFG->fullnamedisplay)) {
3621         $template = $CFG->fullnamedisplay;
3622     }
3623     // If the template is empty, or set to language, or $override is set, return the language string.
3624     if (empty($template) || $template == 'language' || $override) {
3625         return get_string('fullnamedisplay', null, $user);
3626     }
3627
3628     // Get all of the name fields.
3629     $allnames = get_all_user_name_fields();
3630     $requirednames = array();
3631     // With each name, see if it is in the display name template, and add it to the required names array if it is.
3632     foreach ($allnames as $allname) {
3633         if (strpos($template, $allname) !== false) {
3634             $requirednames[] = $allname;
3635             // If the field is in the template but not set in the user object then notify the programmer that it needs to be fixed.
3636             if (!array_key_exists($allname, $user)) {
3637                 debugging('You need to update your sql to include additional name fields in the user object.', DEBUG_DEVELOPER);
3638             }
3639         }
3640     }
3641
3642     $displayname = $template;
3643     // Switch in the actual data into the template.
3644     foreach ($requirednames as $altname) {
3645         if (isset($user->$altname)) {
3646             // Using empty() on the below if statement causes breakages.
3647             if ((string)$user->$altname == '') {
3648                 $displayname = str_replace($altname, 'EMPTY', $displayname);
3649             } else {
3650                 $displayname = str_replace($altname, $user->$altname, $displayname);
3651             }
3652         } else {
3653             $displayname = str_replace($altname, 'EMPTY', $displayname);
3654         }
3655     }
3656     // Tidy up any misc. characters (Not perfect, but gets most characters).