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
  76 /**
  77  * PARAM_ALPHA - contains only english ascii letters a-zA-Z.
  78  */
  79 define('PARAM_ALPHA',    'alpha');
  80
  81 /**
  82  * PARAM_ALPHAEXT the same contents as PARAM_ALPHA plus the chars in quotes: "_-" allowed
  83  * NOTE: originally this allowed "/" too, please use PARAM_SAFEPATH if "/" needed
  84  */
  85 define('PARAM_ALPHAEXT', 'alphaext');
  86
  87 /**
  88  * PARAM_ALPHANUM - expected numbers and letters only.
  89  */
  90 define('PARAM_ALPHANUM', 'alphanum');
  91
  92 /**
  93  * PARAM_ALPHANUMEXT - expected numbers, letters only and _-.
  94  */
  95 define('PARAM_ALPHANUMEXT', 'alphanumext');
  96
  97 /**
  98  * PARAM_AUTH - actually checks to make sure the string is a valid auth plugin
  99  */
 100 define('PARAM_AUTH',  'auth');
 101
 102 /**
 103  * PARAM_BASE64 - Base 64 encoded format
 104  */
 105 define('PARAM_BASE64',   'base64');
 106
 107 /**
 108  * PARAM_BOOL - converts input into 0 or 1, use for switches in forms and urls.
 109  */
 110 define('PARAM_BOOL',     'bool');
 111
 112 /**
 113  * PARAM_CAPABILITY - A capability name, like 'moodle/role:manage'. Actually
 114  * checked against the list of capabilities in the database.
 115  */
 116 define('PARAM_CAPABILITY',   'capability');
 117
 118 /**
 119  * PARAM_CLEANHTML - cleans submitted HTML code. use only for text in HTML format. This cleaning may fix xhtml strictness too.
 120  */
 121 define('PARAM_CLEANHTML', 'cleanhtml');
 122
 123 /**
 124  * PARAM_EMAIL - an email address following the RFC
 125  */
 126 define('PARAM_EMAIL',   'email');
 127
 128 /**
 129  * PARAM_FILE - safe file name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
 130  */
 131 define('PARAM_FILE',   'file');
 132
 133 /**
 134  * PARAM_FLOAT - a real/floating point number.
 135  *
 136  * Note that you should not use PARAM_FLOAT for numbers typed in by the user.
 137  * It does not work for languages that use , as a decimal separator.
 138  * Instead, do something like
 139  *     $rawvalue = required_param('name', PARAM_RAW);
 140  *     // ... other code including require_login, which sets current lang ...
 141  *     $realvalue = unformat_float($rawvalue);
 142  *     // ... then use $realvalue
 143  */
 144 define('PARAM_FLOAT',  'float');
 145
 146 /**
 147  * PARAM_HOST - expected fully qualified domain name (FQDN) or an IPv4 dotted quad (IP address)
 148  */
 149 define('PARAM_HOST',     'host');
 150
 151 /**
 152  * PARAM_INT - integers only, use when expecting only numbers.
 153  */
 154 define('PARAM_INT',      'int');
 155
 156 /**
 157  * PARAM_LANG - checks to see if the string is a valid installed language in the current site.
 158  */
 159 define('PARAM_LANG',  'lang');
 160
 161 /**
 162  * PARAM_LOCALURL - expected properly formatted URL as well as one that refers to the local server itself. (NOT orthogonal to the others! Implies PARAM_URL!)
 163  */
 164 define('PARAM_LOCALURL', 'localurl');
 165
 166 /**
 167  * PARAM_NOTAGS - all html tags are stripped from the text. Do not abuse this type.
 168  */
 169 define('PARAM_NOTAGS',   'notags');
 170
 171 /**
 172  * PARAM_PATH - safe relative path name, all dangerous chars are stripped, protects against XSS, SQL injections and directory traversals
 173  * note: the leading slash is not removed, window drive letter is not allowed
 174  */
 175 define('PARAM_PATH',     'path');
 176
 177 /**
 178  * PARAM_PEM - Privacy Enhanced Mail format
 179  */
 180 define('PARAM_PEM',      'pem');
 181
 182 /**
 183  * PARAM_PERMISSION - A permission, one of CAP_INHERIT, CAP_ALLOW, CAP_PREVENT or CAP_PROHIBIT.
 184  */
 185 define('PARAM_PERMISSION',   'permission');
 186
 187 /**
 188  * PARAM_RAW specifies a parameter that is not cleaned/processed in any way except the discarding of the invalid utf-8 characters
 189  */
 190 define('PARAM_RAW', 'raw');
 191
 192 /**
 193  * PARAM_RAW_TRIMMED like PARAM_RAW but leading and trailing whitespace is stripped.
 194  */
 195 define('PARAM_RAW_TRIMMED', 'raw_trimmed');
 196
 197 /**
 198  * PARAM_SAFEDIR - safe directory name, suitable for include() and require()
 199  */
 200 define('PARAM_SAFEDIR',  'safedir');
 201
 202 /**
 203  * PARAM_SAFEPATH - several PARAM_SAFEDIR joined by "/", suitable for include() and require(), plugin paths, etc.
 204  */
 205 define('PARAM_SAFEPATH',  'safepath');
 206
 207 /**
 208  * PARAM_SEQUENCE - expects a sequence of numbers like 8 to 1,5,6,4,6,8,9.  Numbers and comma only.
 209  */
 210 define('PARAM_SEQUENCE',  'sequence');
 211
 212 /**
 213  * PARAM_TAG - one tag (interests, blogs, etc.) - mostly international characters and space, <> not supported
 214  */
 215 define('PARAM_TAG',   'tag');
 216
 217 /**
 218  * PARAM_TAGLIST - list of tags separated by commas (interests, blogs, etc.)
 219  */
 220 define('PARAM_TAGLIST',   'taglist');
 221
 222 /**
 223  * PARAM_TEXT - general plain text compatible with multilang filter, no other html tags. Please note '<', or '>' are allowed here.
 224  */
 225 define('PARAM_TEXT',  'text');
 226
 227 /**
 228  * PARAM_THEME - Checks to see if the string is a valid theme name in the current site
 229  */
 230 define('PARAM_THEME',  'theme');
 231
 232 /**
 233  * PARAM_URL - expected properly formatted URL. Please note that domain part is required, http://localhost/ is not accepted but http://localhost.localdomain/ is ok.
 234  */
 235 define('PARAM_URL',      'url');
 236
 237 /**
 238  * PARAM_USERNAME - Clean username to only contains allowed characters. This is to be used ONLY when manually creating user accounts, do NOT use when syncing with external systems!!
 239  */
 240 define('PARAM_USERNAME',    'username');
 241
 242 /**
 243  * PARAM_STRINGID - used to check if the given string is valid string identifier for get_string()
 244  */
 245 define('PARAM_STRINGID',    'stringid');
 246
 247 ///// DEPRECATED PARAM TYPES OR ALIASES - DO NOT USE FOR NEW CODE  /////
 248 /**
 249  * PARAM_CLEAN - obsoleted, please use a more specific type of parameter.
 250  * It was one of the first types, that is why it is abused so much ;-)
 251  * @deprecated since 2.0
 252  */
 253 define('PARAM_CLEAN',    'clean');
 254
 255 /**
 256  * PARAM_INTEGER - deprecated alias for PARAM_INT
 257  */
 258 define('PARAM_INTEGER',  'int');
 259
 260 /**
 261  * PARAM_NUMBER - deprecated alias of PARAM_FLOAT
 262  */
 263 define('PARAM_NUMBER',  'float');
 264
 265 /**
 266  * PARAM_ACTION - deprecated alias for PARAM_ALPHANUMEXT, use for various actions in forms and urls
 267  * NOTE: originally alias for PARAM_APLHA
 268  */
 269 define('PARAM_ACTION',   'alphanumext');
 270
 271 /**
 272  * PARAM_FORMAT - deprecated alias for PARAM_ALPHANUMEXT, use for names of plugins, formats, etc.
 273  * NOTE: originally alias for PARAM_APLHA
 274  */
 275 define('PARAM_FORMAT',   'alphanumext');
 276
 277 /**
 278  * PARAM_MULTILANG - deprecated alias of PARAM_TEXT.
 279  */
 280 define('PARAM_MULTILANG',  'text');
 281
 282 /**
 283  * PARAM_TIMEZONE - expected timezone. Timezone can be int +-(0-13) or float +-(0.5-12.5) or
 284  * string seperated by '/' and can have '-' &/ '_' (eg. America/North_Dakota/New_Salem
 285  * America/Port-au-Prince)
 286  */
 287 define('PARAM_TIMEZONE', 'timezone');
 288
 289 /**
 290  * PARAM_CLEANFILE - deprecated alias of PARAM_FILE; originally was removing regional chars too
 291  */
 292 define('PARAM_CLEANFILE', 'file');
 293
 294 /**
 295  * PARAM_COMPONENT is used for full component names (aka frankenstyle) such as 'mod_forum', 'core_rating', 'auth_ldap'.
 296  * Short legacy subsystem names and module names are accepted too ex: 'forum', 'rating', 'user'.
 297  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
 298  * NOTE: numbers and underscores are strongly discouraged in plugin names!
 299  */
 300 define('PARAM_COMPONENT', 'component');
 301
 302 /**
 303  * PARAM_AREA is a name of area used when addressing files, comments, ratings, etc.
 304  * It is usually used together with context id and component.
 305  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
 306  */
 307 define('PARAM_AREA', 'area');
 308
 309 /**
 310  * PARAM_PLUGIN is used for plugin names such as 'forum', 'glossary', 'ldap', 'radius', 'paypal', 'completionstatus'.
 311  * Only lowercase ascii letters, numbers and underscores are allowed, it has to start with a letter.
 312  * NOTE: numbers and underscores are strongly discouraged in plugin names! Underscores are forbidden in module names.
 313  */
 314 define('PARAM_PLUGIN', 'plugin');
 315
 316
 317 /// Web Services ///
 318
 319 /**
 320  * VALUE_REQUIRED - if the parameter is not supplied, there is an error
 321  */
 322 define('VALUE_REQUIRED', 1);
 323
 324 /**
 325  * VALUE_OPTIONAL - if the parameter is not supplied, then the param has no value
 326  */
 327 define('VALUE_OPTIONAL', 2);
 328
 329 /**
 330  * VALUE_DEFAULT - if the parameter is not supplied, then the default value is used
 331  */
 332 define('VALUE_DEFAULT', 0);
 333
 334 /**
 335  * NULL_NOT_ALLOWED - the parameter can not be set to null in the database
 336  */
 337 define('NULL_NOT_ALLOWED', false);
 338
 339 /**
 340  * NULL_ALLOWED - the parameter can be set to null in the database
 341  */
 342 define('NULL_ALLOWED', true);
 343
 344 /// Page types ///
 345 /**
 346  * PAGE_COURSE_VIEW is a definition of a page type. For more information on the page class see moodle/lib/pagelib.php.
 347  */
 348 define('PAGE_COURSE_VIEW', 'course-view');
 349
 350 /** Get remote addr constant */
 351 define('GETREMOTEADDR_SKIP_HTTP_CLIENT_IP', '1');
 352 /** Get remote addr constant */
 353 define('GETREMOTEADDR_SKIP_HTTP_X_FORWARDED_FOR', '2');
 354
 355 /// Blog access level constant declaration ///
 356 define ('BLOG_USER_LEVEL', 1);
 357 define ('BLOG_GROUP_LEVEL', 2);
 358 define ('BLOG_COURSE_LEVEL', 3);
 359 define ('BLOG_SITE_LEVEL', 4);
 360 define ('BLOG_GLOBAL_LEVEL', 5);
 361
 362
 363 ///Tag constants///
 364 /**
 365  * To prevent problems with multibytes strings,Flag updating in nav not working on the review page. this should not exceed the
 366  * length of "varchar(255) / 3 (bytes / utf-8 character) = 85".
 367  * TODO: this is not correct, varchar(255) are 255 unicode chars ;-)
 368  *
 369  * @todo define(TAG_MAX_LENGTH) this is not correct, varchar(255) are 255 unicode chars ;-)
 370  */
 371 define('TAG_MAX_LENGTH', 50);
 372
 373 /// Password policy constants ///
 374 define ('PASSWORD_LOWER', 'abcdefghijklmnopqrstuvwxyz');
 375 define ('PASSWORD_UPPER', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ');
 376 define ('PASSWORD_DIGITS', '0123456789');
 377 define ('PASSWORD_NONALPHANUM', '.,;:!?_-+/*@#&$');
 378
 379 /// Feature constants ///
 380 // Used for plugin_supports() to report features that are, or are not, supported by a module.
 381
 382 /** True if module can provide a grade */
 383 define('FEATURE_GRADE_HAS_GRADE', 'grade_has_grade');
 384 /** True if module supports outcomes */
 385 define('FEATURE_GRADE_OUTCOMES', 'outcomes');
 386 /** True if module supports advanced grading methods */
 387 define('FEATURE_ADVANCED_GRADING', 'grade_advanced_grading');
 388 /** True if module controls the grade visibility over the gradebook */
 389 define('FEATURE_CONTROLS_GRADE_VISIBILITY', 'controlsgradevisbility');
 390
 391 /** True if module has code to track whether somebody viewed it */
 392 define('FEATURE_COMPLETION_TRACKS_VIEWS', 'completion_tracks_views');
 393 /** True if module has custom completion rules */
 394 define('FEATURE_COMPLETION_HAS_RULES', 'completion_has_rules');
 395
 396 /** True if module has no 'view' page (like label) */
 397 define('FEATURE_NO_VIEW_LINK', 'viewlink');
 398 /** True if module supports outcomes */
 399 define('FEATURE_IDNUMBER', 'idnumber');
 400 /** True if module supports groups */
 401 define('FEATURE_GROUPS', 'groups');
 402 /** True if module supports groupings */
 403 define('FEATURE_GROUPINGS', 'groupings');
 404 /** True if module supports groupmembersonly */
 405 define('FEATURE_GROUPMEMBERSONLY', 'groupmembersonly');
 406
 407 /** Type of module */
 408 define('FEATURE_MOD_ARCHETYPE', 'mod_archetype');
 409 /** True if module supports intro editor */
 410 define('FEATURE_MOD_INTRO', 'mod_intro');
 411 /** True if module has default completion */
 412 define('FEATURE_MODEDIT_DEFAULT_COMPLETION', 'modedit_default_completion');
 413
 414 define('FEATURE_COMMENT', 'comment');
 415
 416 define('FEATURE_RATE', 'rate');
 417 /** True if module supports backup/restore of moodle2 format */
 418 define('FEATURE_BACKUP_MOODLE2', 'backup_moodle2');
 419
 420 /** True if module can show description on course main page */
 421 define('FEATURE_SHOW_DESCRIPTION', 'showdescription');
 422
 423 /** Unspecified module archetype */
 424 define('MOD_ARCHETYPE_OTHER', 0);
 425 /** Resource-like type module */
 426 define('MOD_ARCHETYPE_RESOURCE', 1);
 427 /** Assignment module archetype */
 428 define('MOD_ARCHETYPE_ASSIGNMENT', 2);
 429 /** System (not user-addable) module archetype */
 430 define('MOD_ARCHETYPE_SYSTEM', 3);
 431
 432 /**
 433  * Security token used for allowing access
 434  * from external application such as web services.
 435  * Scripts do not use any session, performance is relatively
 436  * low because we need to load access info in each request.
 437  * Scripts are executed in parallel.
 438  */
 439 define('EXTERNAL_TOKEN_PERMANENT', 0);
 440
 441 /**
 442  * Security token used for allowing access
 443  * of embedded applications, the code is executed in the
 444  * active user session. Token is invalidated after user logs out.
 445  * Scripts are executed serially - normal session locking is used.
 446  */
 447 define('EXTERNAL_TOKEN_EMBEDDED', 1);
 448
 449 /**
 450  * The home page should be the site home
 451  */
 452 define('HOMEPAGE_SITE', 0);
 453 /**
 454  * The home page should be the users my page
 455  */
 456 define('HOMEPAGE_MY', 1);
 457 /**
 458  * The home page can be chosen by the user
 459  */
 460 define('HOMEPAGE_USER', 2);
 461
 462 /**
 463  * Hub directory url (should be moodle.org)
 464  */
 465 define('HUB_HUBDIRECTORYURL', "http://hubdirectory.moodle.org");
 466
 467
 468 /**
 469  * Moodle.org url (should be moodle.org)
 470  */
 471 define('HUB_MOODLEORGHUBURL', "http://hub.moodle.org");
 472
 473 /**
 474  * Moodle mobile app service name
 475  */
 476 define('MOODLE_OFFICIAL_MOBILE_SERVICE', 'moodle_mobile_app');
 477
 478 /**
 479  * Indicates the user has the capabilities required to ignore activity and course file size restrictions
 480  */
 481 define('USER_CAN_IGNORE_FILE_SIZE_LIMITS', -1);
 482
 483 /// PARAMETER HANDLING ////////////////////////////////////////////////////
 484
 485 /**
 486  * Returns a particular value for the named variable, taken from
 487  * POST or GET.  If the parameter doesn't exist then an error is
 488  * thrown because we require this variable.
 489  *
 490  * This function should be used to initialise all required values
 491  * in a script that are based on parameters.  Usually it will be
 492  * used like this:
 493  *    $id = required_param('id', PARAM_INT);
 494  *
 495  * Please note the $type parameter is now required and the value can not be array.
 496  *
 497  * @param string $parname the name of the page parameter we want
 498  * @param string $type expected type of parameter
 499  * @return mixed
 500  */
 501 function required_param($parname, $type) {
 502     if (func_num_args() != 2 or empty($parname) or empty($type)) {
 503         throw new coding_exception('required_param() requires $parname and $type to be specified (parameter: '.$parname.')');
 504     }
 505     if (isset($_POST[$parname])) {       // POST has precedence
 506         $param = $_POST[$parname];
 507     } else if (isset($_GET[$parname])) {
 508         $param = $_GET[$parname];
 509     } else {
 510         print_error('missingparam', '', '', $parname);
 511     }
 512
 513     if (is_array($param)) {
 514         debugging('Invalid array parameter detected in required_param(): '.$parname);
 515         // TODO: switch to fatal error in Moodle 2.3
 516         //print_error('missingparam', '', '', $parname);
 517         return required_param_array($parname, $type);
 518     }
 519
 520     return clean_param($param, $type);
 521 }
 522
 523 /**
 524  * Returns a particular array value for the named variable, taken from
 525  * POST or GET.  If the parameter doesn't exist then an error is
 526  * thrown because we require this variable.
 527  *
 528  * This function should be used to initialise all required values
 529  * in a script that are based on parameters.  Usually it will be
 530  * used like this:
 531  *    $ids = required_param_array('ids', PARAM_INT);
 532  *
 533  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
 534  *
 535  * @param string $parname the name of the page parameter we want
 536  * @param string $type expected type of parameter
 537  * @return array
 538  */
 539 function required_param_array($parname, $type) {
 540     if (func_num_args() != 2 or empty($parname) or empty($type)) {
 541         throw new coding_exception('required_param_array() requires $parname and $type to be specified (parameter: '.$parname.')');
 542     }
 543     if (isset($_POST[$parname])) {       // POST has precedence
 544         $param = $_POST[$parname];
 545     } else if (isset($_GET[$parname])) {
 546         $param = $_GET[$parname];
 547     } else {
 548         print_error('missingparam', '', '', $parname);
 549     }
 550     if (!is_array($param)) {
 551         print_error('missingparam', '', '', $parname);
 552     }
 553
 554     $result = array();
 555     foreach($param as $key=>$value) {
 556         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
 557             debugging('Invalid key name in required_param_array() detected: '.$key.', parameter: '.$parname);
 558             continue;
 559         }
 560         $result[$key] = clean_param($value, $type);
 561     }
 562
 563     return $result;
 564 }
 565
 566 /**
 567  * Returns a particular value for the named variable, taken from
 568  * POST or GET, otherwise returning a given default.
 569  *
 570  * This function should be used to initialise all optional values
 571  * in a script that are based on parameters.  Usually it will be
 572  * used like this:
 573  *    $name = optional_param('name', 'Fred', PARAM_TEXT);
 574  *
 575  * Please note the $type parameter is now required and the value can not be array.
 576  *
 577  * @param string $parname the name of the page parameter we want
 578  * @param mixed  $default the default value to return if nothing is found
 579  * @param string $type expected type of parameter
 580  * @return mixed
 581  */
 582 function optional_param($parname, $default, $type) {
 583     if (func_num_args() != 3 or empty($parname) or empty($type)) {
 584         throw new coding_exception('optional_param() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
 585     }
 586     if (!isset($default)) {
 587         $default = null;
 588     }
 589
 590     if (isset($_POST[$parname])) {       // POST has precedence
 591         $param = $_POST[$parname];
 592     } else if (isset($_GET[$parname])) {
 593         $param = $_GET[$parname];
 594     } else {
 595         return $default;
 596     }
 597
 598     if (is_array($param)) {
 599         debugging('Invalid array parameter detected in required_param(): '.$parname);
 600         // TODO: switch to $default in Moodle 2.3
 601         //return $default;
 602         return optional_param_array($parname, $default, $type);
 603     }
 604
 605     return clean_param($param, $type);
 606 }
 607
 608 /**
 609  * Returns a particular array value for the named variable, taken from
 610  * POST or GET, otherwise returning a given default.
 611  *
 612  * This function should be used to initialise all optional values
 613  * in a script that are based on parameters.  Usually it will be
 614  * used like this:
 615  *    $ids = optional_param('id', array(), PARAM_INT);
 616  *
 617  *  Note: arrays of arrays are not supported, only alphanumeric keys with _ and - are supported
 618  *
 619  * @param string $parname the name of the page parameter we want
 620  * @param mixed  $default the default value to return if nothing is found
 621  * @param string $type expected type of parameter
 622  * @return array
 623  */
 624 function optional_param_array($parname, $default, $type) {
 625     if (func_num_args() != 3 or empty($parname) or empty($type)) {
 626         throw new coding_exception('optional_param_array() requires $parname, $default and $type to be specified (parameter: '.$parname.')');
 627     }
 628
 629     if (isset($_POST[$parname])) {       // POST has precedence
 630         $param = $_POST[$parname];
 631     } else if (isset($_GET[$parname])) {
 632         $param = $_GET[$parname];
 633     } else {
 634         return $default;
 635     }
 636     if (!is_array($param)) {
 637         debugging('optional_param_array() expects array parameters only: '.$parname);
 638         return $default;
 639     }
 640
 641     $result = array();
 642     foreach($param as $key=>$value) {
 643         if (!preg_match('/^[a-z0-9_-]+$/i', $key)) {
 644             debugging('Invalid key name in optional_param_array() detected: '.$key.', parameter: '.$parname);
 645             continue;
 646         }
 647         $result[$key] = clean_param($value, $type);
 648     }
 649
 650     return $result;
 651 }
 652
 653 /**
 654  * Strict validation of parameter values, the values are only converted
 655  * to requested PHP type. Internally it is using clean_param, the values
 656  * before and after cleaning must be equal - otherwise
 657  * an invalid_parameter_exception is thrown.
 658  * Objects and classes are not accepted.
 659  *
 660  * @param mixed $param
 661  * @param string $type PARAM_ constant
 662  * @param bool $allownull are nulls valid value?
 663  * @param string $debuginfo optional debug information
 664  * @return mixed the $param value converted to PHP type
 665  * @throws invalid_parameter_exception if $param is not of given type
 666  */
 667 function validate_param($param, $type, $allownull=NULL_NOT_ALLOWED, $debuginfo='') {
 668     if (is_null($param)) {
 669         if ($allownull == NULL_ALLOWED) {
 670             return null;
 671         } else {
 672             throw new invalid_parameter_exception($debuginfo);
 673         }
 674     }
 675     if (is_array($param) or is_object($param)) {
 676         throw new invalid_parameter_exception($debuginfo);
 677     }
 678
 679     $cleaned = clean_param($param, $type);
 680
 681     if ($type == PARAM_FLOAT) {
 682         // Do not detect precision loss here.
 683         if (is_float($param) or is_int($param)) {
 684             // These always fit.
 685         } else if (!is_numeric($param) or !preg_match('/^[\+-]?[0-9]*\.?[0-9]*(e[-+]?[0-9]+)?$/i', (string)$param)) {
 686             throw new invalid_parameter_exception($debuginfo);
 687         }
 688     } else if ((string)$param !== (string)$cleaned) {
 689         // conversion to string is usually lossless
 690         throw new invalid_parameter_exception($debuginfo);
 691     }
 692
 693     return $cleaned;
 694 }
 695
 696 /**
 697  * Makes sure array contains only the allowed types,
 698  * this function does not validate array key names!
 699  * <code>
 700  * $options = clean_param($options, PARAM_INT);
 701  * </code>
 702  *
 703  * @param array $param the variable array we are cleaning
 704  * @param string $type expected format of param after cleaning.
 705  * @param bool $recursive clean recursive arrays
 706  * @return array
 707  */
 708 function clean_param_array(array $param = null, $type, $recursive = false) {
 709     $param = (array)$param; // convert null to empty array
 710     foreach ($param as $key => $value) {
 711         if (is_array($value)) {
 712             if ($recursive) {
 713                 $param[$key] = clean_param_array($value, $type, true);
 714             } else {
 715                 throw new coding_exception('clean_param_array() can not process multidimensional arrays when $recursive is false.');
 716             }
 717         } else {
 718             $param[$key] = clean_param($value, $type);
 719         }
 720     }
 721     return $param;
 722 }
 723
 724 /**
 725  * Used by {@link optional_param()} and {@link required_param()} to
 726  * clean the variables and/or cast to specific types, based on
 727  * an options field.
 728  * <code>
 729  * $course->format = clean_param($course->format, PARAM_ALPHA);
 730  * $selectedgrade_item = clean_param($selectedgrade_item, PARAM_INT);
 731  * </code>
 732  *
 733  * @param mixed $param the variable we are cleaning
 734  * @param string $type expected format of param after cleaning.
 735  * @return mixed
 736  */
 737 function clean_param($param, $type) {
 738
 739     global $CFG;
 740
 741     if (is_array($param)) {
 742         throw new coding_exception('clean_param() can not process arrays, please use clean_param_array() instead.');
 743     } else if (is_object($param)) {
 744         if (method_exists($param, '__toString')) {
 745             $param = $param->__toString();
 746         } else {
 747             throw new coding_exception('clean_param() can not process objects, please use clean_param_array() instead.');
 748         }
 749     }
 750
 751     switch ($type) {
 752         case PARAM_RAW:          // no cleaning at all
 753             $param = fix_utf8($param);
 754             return $param;
 755
 756         case PARAM_RAW_TRIMMED:         // no cleaning, but strip leading and trailing whitespace.
 757             $param = fix_utf8($param);
 758             return trim($param);
 759
 760         case PARAM_CLEAN:        // General HTML cleaning, try to use more specific type if possible
 761             // this is deprecated!, please use more specific type instead
 762             if (is_numeric($param)) {
 763                 return $param;
 764             }
 765             $param = fix_utf8($param);
 766             return clean_text($param);     // Sweep for scripts, etc
 767
 768         case PARAM_CLEANHTML:    // clean html fragment
 769             $param = fix_utf8($param);
 770             $param = clean_text($param, FORMAT_HTML);     // Sweep for scripts, etc
 771             return trim($param);
 772
 773         case PARAM_INT:
 774             return (int)$param;  // Convert to integer
 775
 776         case PARAM_FLOAT:
 777         case PARAM_NUMBER:
 778             return (float)$param;  // Convert to float
 779
 780         case PARAM_ALPHA:        // Remove everything not a-z
 781             return preg_replace('/[^a-zA-Z]/i', '', $param);
 782
 783         case PARAM_ALPHAEXT:     // Remove everything not a-zA-Z_- (originally allowed "/" too)
 784             return preg_replace('/[^a-zA-Z_-]/i', '', $param);
 785
 786         case PARAM_ALPHANUM:     // Remove everything not a-zA-Z0-9
 787             return preg_replace('/[^A-Za-z0-9]/i', '', $param);
 788
 789         case PARAM_ALPHANUMEXT:     // Remove everything not a-zA-Z0-9_-
 790             return preg_replace('/[^A-Za-z0-9_-]/i', '', $param);
 791
 792         case PARAM_SEQUENCE:     // Remove everything not 0-9,
 793             return preg_replace('/[^0-9,]/i', '', $param);
 794
 795         case PARAM_BOOL:         // Convert to 1 or 0
 796             $tempstr = strtolower($param);
 797             if ($tempstr === 'on' or $tempstr === 'yes' or $tempstr === 'true') {
 798                 $param = 1;
 799             } else if ($tempstr === 'off' or $tempstr === 'no'  or $tempstr === 'false') {
 800                 $param = 0;
 801             } else {
 802                 $param = empty($param) ? 0 : 1;
 803             }
 804             return $param;
 805
 806         case PARAM_NOTAGS:       // Strip all tags
 807             $param = fix_utf8($param);
 808             return strip_tags($param);
 809
 810         case PARAM_TEXT:    // leave only tags needed for multilang
 811             $param = fix_utf8($param);
 812             // if the multilang syntax is not correct we strip all tags
 813             // because it would break xhtml strict which is required for accessibility standards
 814             // please note this cleaning does not strip unbalanced '>' for BC compatibility reasons
 815             do {
 816                 if (strpos($param, '</lang>') !== false) {
 817                     // old and future mutilang syntax
 818                     $param = strip_tags($param, '<lang>');
 819                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
 820                         break;
 821                     }
 822                     $open = false;
 823                     foreach ($matches[0] as $match) {
 824                         if ($match === '</lang>') {
 825                             if ($open) {
 826                                 $open = false;
 827                                 continue;
 828                             } else {
 829                                 break 2;
 830                             }
 831                         }
 832                         if (!preg_match('/^<lang lang="[a-zA-Z0-9_-]+"\s*>$/u', $match)) {
 833                             break 2;
 834                         } else {
 835                             $open = true;
 836                         }
 837                     }
 838                     if ($open) {
 839                         break;
 840                     }
 841                     return $param;
 842
 843                 } else if (strpos($param, '</span>') !== false) {
 844                     // current problematic multilang syntax
 845                     $param = strip_tags($param, '<span>');
 846                     if (!preg_match_all('/<.*>/suU', $param, $matches)) {
 847                         break;
 848                     }
 849                     $open = false;
 850                     foreach ($matches[0] as $match) {
 851                         if ($match === '</span>') {
 852                             if ($open) {
 853                                 $open = false;
 854                                 continue;
 855                             } else {
 856                                 break 2;
 857                             }
 858                         }
 859                         if (!preg_match('/^<span(\s+lang="[a-zA-Z0-9_-]+"|\s+class="multilang"){2}\s*>$/u', $match)) {
 860                             break 2;
 861                         } else {
 862                             $open = true;
 863                         }
 864                     }
 865                     if ($open) {
 866                         break;
 867                     }
 868                     return $param;
 869                 }
 870             } while (false);
 871             // easy, just strip all tags, if we ever want to fix orphaned '&' we have to do that in format_string()
 872             return strip_tags($param);
 873
 874         case PARAM_COMPONENT:
 875             // we do not want any guessing here, either the name is correct or not
 876             // please note only normalised component names are accepted
 877             if (!preg_match('/^[a-z]+(_[a-z][a-z0-9_]*)?[a-z0-9]$/', $param)) {
 878                 return '';
 879             }
 880             if (strpos($param, '__') !== false) {
 881                 return '';
 882             }
 883             if (strpos($param, 'mod_') === 0) {
 884                 // module names must not contain underscores because we need to differentiate them from invalid plugin types
 885                 if (substr_count($param, '_') != 1) {
 886                     return '';
 887                 }
 888             }
 889             return $param;
 890
 891         case PARAM_PLUGIN:
 892         case PARAM_AREA:
 893             // we do not want any guessing here, either the name is correct or not
 894             if (!preg_match('/^[a-z][a-z0-9_]*[a-z0-9]$/', $param)) {
 895                 return '';
 896             }
 897             if (strpos($param, '__') !== false) {
 898                 return '';
 899             }
 900             return $param;
 901
 902         case PARAM_SAFEDIR:      // Remove everything not a-zA-Z0-9_-
 903             return preg_replace('/[^a-zA-Z0-9_-]/i', '', $param);
 904
 905         case PARAM_SAFEPATH:     // Remove everything not a-zA-Z0-9/_-
 906             return preg_replace('/[^a-zA-Z0-9\/_-]/i', '', $param);
 907
 908         case PARAM_FILE:         // Strip all suspicious characters from filename
 909             $param = fix_utf8($param);
 910             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':\\\\/]~u', '', $param);
 911             $param = preg_replace('~\.\.+~', '', $param);
 912             if ($param === '.') {
 913                 $param = '';
 914             }
 915             return $param;
 916
 917         case PARAM_PATH:         // Strip all suspicious characters from file path
 918             $param = fix_utf8($param);
 919             $param = str_replace('\\', '/', $param);
 920             $param = preg_replace('~[[:cntrl:]]|[&<>"`\|\':]~u', '', $param);
 921             $param = preg_replace('~\.\.+~', '', $param);
 922             $param = preg_replace('~//+~', '/', $param);
 923             return preg_replace('~/(\./)+~', '/', $param);
 924
 925         case PARAM_HOST:         // allow FQDN or IPv4 dotted quad
 926             $param = preg_replace('/[^\.\d\w-]/','', $param ); // only allowed chars
 927             // match ipv4 dotted quad
 928             if (preg_match('/(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})/',$param, $match)){
 929                 // confirm values are ok
 930                 if ( $match[0] > 255
 931                      || $match[1] > 255
 932                      || $match[3] > 255
 933                      || $match[4] > 255 ) {
 934                     // hmmm, what kind of dotted quad is this?
 935                     $param = '';
 936                 }
 937             } elseif ( preg_match('/^[\w\d\.-]+$/', $param) // dots, hyphens, numbers
 938                        && !preg_match('/^[\.-]/',  $param) // no leading dots/hyphens
 939                        && !preg_match('/[\.-]$/',  $param) // no trailing dots/hyphens
 940                        ) {
 941                 // all is ok - $param is respected
 942             } else {
 943                 // all is not ok...
 944                 $param='';
 945             }
 946             return $param;
 947
 948         case PARAM_URL:          // allow safe ftp, http, mailto urls
 949             $param = fix_utf8($param);
 950             include_once($CFG->dirroot . '/lib/validateurlsyntax.php');
 951             if (!empty($param) && validateUrlSyntax($param, 's?H?S?F?E?u-P-a?I?p?f?q?r?')) {
 952                 // all is ok, param is respected
 953             } else {
 954                 $param =''; // not really ok
 955             }
 956             return $param;
 957
 958         case PARAM_LOCALURL:     // allow http absolute, root relative and relative URLs within wwwroot
 959             $param = clean_param($param, PARAM_URL);
 960             if (!empty($param)) {
 961                 if (preg_match(':^/:', $param)) {
 962                     // root-relative, ok!
 963                 } elseif (preg_match('/^'.preg_quote($CFG->wwwroot, '/').'/i',$param)) {
 964                     // absolute, and matches our wwwroot
 965                 } else {
 966                     // relative - let's make sure there are no tricks
 967                     if (validateUrlSyntax('/' . $param, 's-u-P-a-p-f+q?r?')) {
 968                         // looks ok.
 969                     } else {
 970                         $param = '';
 971                     }
 972                 }
 973             }
 974             return $param;
 975
 976         case PARAM_PEM:
 977             $param = trim($param);
 978             // PEM formatted strings may contain letters/numbers and the symbols
 979             // forward slash: /
 980             // plus sign:     +
 981             // equal sign:    =
 982             // , surrounded by BEGIN and END CERTIFICATE prefix and suffixes
 983             if (preg_match('/^-----BEGIN CERTIFICATE-----([\s\w\/\+=]+)-----END CERTIFICATE-----$/', trim($param), $matches)) {
 984                 list($wholething, $body) = $matches;
 985                 unset($wholething, $matches);
 986                 $b64 = clean_param($body, PARAM_BASE64);
 987                 if (!empty($b64)) {
 988                     return "-----BEGIN CERTIFICATE-----\n$b64\n-----END CERTIFICATE-----\n";
 989                 } else {
 990                     return '';
 991                 }
 992             }
 993             return '';
 994
 995         case PARAM_BASE64:
 996             if (!empty($param)) {
 997                 // PEM formatted strings may contain letters/numbers and the symbols
 998                 // forward slash: /
 999                 // plus sign:     +
1000                 // equal sign:    =
1001                 if (0 >= preg_match('/^([\s\w\/\+=]+)$/', trim($param))) {
1002                     return '';
1003                 }
1004                 $lines = preg_split('/[\s]+/', $param, -1, PREG_SPLIT_NO_EMPTY);
1005                 // Each line of base64 encoded data must be 64 characters in
1006                 // length, except for the last line which may be less than (or
1007                 // equal to) 64 characters long.
1008                 for ($i=0, $j=count($lines); $i < $j; $i++) {
1009                     if ($i + 1 == $j) {
1010                         if (64 < strlen($lines[$i])) {
1011                             return '';
1012                         }
1013                         continue;
1014                     }
1015
1016                     if (64 != strlen($lines[$i])) {
1017                         return '';
1018                     }
1019                 }
1020                 return implode("\n",$lines);
1021             } else {
1022                 return '';
1023             }
1024
1025         case PARAM_TAG:
1026             $param = fix_utf8($param);
1027             // Please note it is not safe to use the tag name directly anywhere,
1028             // it must be processed with s(), urlencode() before embedding anywhere.
1029             // remove some nasties
1030             $param = preg_replace('~[[:cntrl:]]|[<>`]~u', '', $param);
1031             //convert many whitespace chars into one
1032             $param = preg_replace('/\s+/', ' ', $param);
1033             $param = textlib::substr(trim($param), 0, TAG_MAX_LENGTH);
1034             return $param;
1035
1036         case PARAM_TAGLIST:
1037             $param = fix_utf8($param);
1038             $tags = explode(',', $param);
1039             $result = array();
1040             foreach ($tags as $tag) {
1041                 $res = clean_param($tag, PARAM_TAG);
1042                 if ($res !== '') {
1043                     $result[] = $res;
1044                 }
1045             }
1046             if ($result) {
1047                 return implode(',', $result);
1048             } else {
1049                 return '';
1050             }
1051
1052         case PARAM_CAPABILITY:
1053             if (get_capability_info($param)) {
1054                 return $param;
1055             } else {
1056                 return '';
1057             }
1058
1059         case PARAM_PERMISSION:
1060             $param = (int)$param;
1061             if (in_array($param, array(CAP_INHERIT, CAP_ALLOW, CAP_PREVENT, CAP_PROHIBIT))) {
1062                 return $param;
1063             } else {
1064                 return CAP_INHERIT;
1065             }
1066
1067         case PARAM_AUTH:
1068             $param = clean_param($param, PARAM_PLUGIN);
1069             if (empty($param)) {
1070                 return '';
1071             } else if (exists_auth_plugin($param)) {
1072                 return $param;
1073             } else {
1074                 return '';
1075             }
1076
1077         case PARAM_LANG:
1078             $param = clean_param($param, PARAM_SAFEDIR);
1079             if (get_string_manager()->translation_exists($param)) {
1080                 return $param;
1081             } else {
1082                 return ''; // Specified language is not installed or param malformed
1083             }
1084
1085         case PARAM_THEME:
1086             $param = clean_param($param, PARAM_PLUGIN);
1087             if (empty($param)) {
1088                 return '';
1089             } else if (file_exists("$CFG->dirroot/theme/$param/config.php")) {
1090                 return $param;
1091             } else if (!empty($CFG->themedir) and file_exists("$CFG->themedir/$param/config.php")) {
1092                 return $param;
1093             } else {
1094                 return '';  // Specified theme is not installed
1095             }
1096
1097         case PARAM_USERNAME:
1098             $param = fix_utf8($param);
1099             $param = str_replace(" " , "", $param);
1100             $param = textlib::strtolower($param);  // Convert uppercase to lowercase MDL-16919
1101             if (empty($CFG->extendedusernamechars)) {
1102                 // regular expression, eliminate all chars EXCEPT:
1103                 // alphanum, dash (-), underscore (_), at sign (@) and period (.) characters.
1104                 $param = preg_replace('/[^-\.@_a-z0-9]/', '', $param);
1105             }
1106             return $param;
1107
1108         case PARAM_EMAIL:
1109             $param = fix_utf8($param);
1110             if (validate_email($param)) {
1111                 return $param;
1112             } else {
1113                 return '';
1114             }
1115
1116         case PARAM_STRINGID:
1117             if (preg_match('|^[a-zA-Z][a-zA-Z0-9\.:/_-]*$|', $param)) {
1118                 return $param;
1119             } else {
1120                 return '';
1121             }
1122
1123         case PARAM_TIMEZONE:    //can be int, float(with .5 or .0) or string seperated by '/' and can have '-_'
1124             $param = fix_utf8($param);
1125             $timezonepattern = '/^(([+-]?(0?[0-9](\.[5|0])?|1[0-3]|1[0-2]\.5))|(99)|[[:alnum:]]+(\/?[[:alpha:]_-])+)$/';
1126             if (preg_match($timezonepattern, $param)) {
1127                 return $param;
1128             } else {
1129                 return '';
1130             }
1131
1132         default:                 // throw error, switched parameters in optional_param or another serious problem
1133             print_error("unknownparamtype", '', '', $type);
1134     }
1135 }
1136
1137 /**
1138  * Makes sure the data is using valid utf8, invalid characters are discarded.
1139  *
1140  * Note: this function is not intended for full objects with methods and private properties.
1141  *
1142  * @param mixed $value
1143  * @return mixed with proper utf-8 encoding
1144  */
1145 function fix_utf8($value) {
1146     if (is_null($value) or $value === '') {
1147         return $value;
1148
1149     } else if (is_string($value)) {
1150         if ((string)(int)$value === $value) {
1151             // shortcut
1152             return $value;
1153         }
1154
1155         // Lower error reporting because glibc throws bogus notices.
1156         $olderror = error_reporting();
1157         if ($olderror & E_NOTICE) {
1158             error_reporting($olderror ^ E_NOTICE);
1159         }
1160
1161         // Note: this duplicates min_fix_utf8() intentionally.
1162         static $buggyiconv = null;
1163         if ($buggyiconv === null) {
1164             $buggyiconv = (!function_exists('iconv') or iconv('UTF-8', 'UTF-8//IGNORE', '100'.chr(130).'€') !== '100€');
1165         }
1166
1167         if ($buggyiconv) {
1168             if (function_exists('mb_convert_encoding')) {
1169                 $subst = mb_substitute_character();
1170                 mb_substitute_character('');
1171                 $result = mb_convert_encoding($value, 'utf-8', 'utf-8');
1172                 mb_substitute_character($subst);
1173
1174             } else {
1175                 // Warn admins on admin/index.php page.
1176                 $result = $value;
1177             }
1178
1179         } else {
1180             $result = iconv('UTF-8', 'UTF-8//IGNORE', $value);
1181         }
1182
1183         if ($olderror & E_NOTICE) {
1184             error_reporting($olderror);
1185         }
1186
1187         return $result;
1188
1189     } else if (is_array($value)) {
1190         foreach ($value as $k=>$v) {
1191             $value[$k] = fix_utf8($v);
1192         }
1193         return $value;
1194
1195     } else if (is_object($value)) {
1196         $value = clone($value); // do not modify original
1197         foreach ($value as $k=>$v) {
1198             $value->$k = fix_utf8($v);
1199         }
1200         return $value;
1201
1202     } else {
1203         // this is some other type, no utf-8 here
1204         return $value;
1205     }
1206 }
1207
1208 /**
1209  * Return true if given value is integer or string with integer value
1210  *
1211  * @param mixed $value String or Int
1212  * @return bool true if number, false if not
1213  */
1214 function is_number($value) {
1215     if (is_int($value)) {
1216         return true;
1217     } else if (is_string($value)) {
1218         return ((string)(int)$value) === $value;
1219     } else {
1220         return false;
1221     }
1222 }
1223
1224 /**
1225  * Returns host part from url
1226  * @param string $url full url
1227  * @return string host, null if not found
1228  */
1229 function get_host_from_url($url) {
1230     preg_match('|^[a-z]+://([a-zA-Z0-9-.]+)|i', $url, $matches);
1231     if ($matches) {
1232         return $matches[1];
1233     }
1234     return null;
1235 }
1236
1237 /**
1238  * Tests whether anything was returned by text editor
1239  *
1240  * This function is useful for testing whether something you got back from
1241  * the HTML editor actually contains anything. Sometimes the HTML editor
1242  * appear to be empty, but actually you get back a <br> tag or something.
1243  *
1244  * @param string $string a string containing HTML.
1245  * @return boolean does the string contain any actual content - that is text,
1246  * images, objects, etc.
1247  */
1248 function html_is_blank($string) {
1249     return trim(strip_tags($string, '<img><object><applet><input><select><textarea><hr>')) == '';
1250 }
1251
1252 /**
1253  * Set a key in global configuration
1254  *
1255  * Set a key/value pair in both this session's {@link $CFG} global variable
1256  * and in the 'config' database table for future sessions.
1257  *
1258  * Can also be used to update keys for plugin-scoped configs in config_plugin table.
1259  * In that case it doesn't affect $CFG.
1260  *
1261  * A NULL value will delete the entry.
1262  *
1263  * @global object
1264  * @global object
1265  * @param string $name the key to set
1266  * @param string $value the value to set (without magic quotes)
1267  * @param string $plugin (optional) the plugin scope, default NULL
1268  * @return bool true or exception
1269  */
1270 function set_config($name, $value, $plugin=NULL) {
1271     global $CFG, $DB;
1272
1273     if (empty($plugin)) {
1274         if (!array_key_exists($name, $CFG->config_php_settings)) {
1275             // So it's defined for this invocation at least
1276             if (is_null($value)) {
1277                 unset($CFG->$name);
1278             } else {
1279                 $CFG->$name = (string)$value; // settings from db are always strings
1280             }
1281         }
1282
1283         if ($DB->get_field('config', 'name', array('name'=>$name))) {
1284             if ($value === null) {
1285                 $DB->delete_records('config', array('name'=>$name));
1286             } else {
1287                 $DB->set_field('config', 'value', $value, array('name'=>$name));
1288             }
1289         } else {
1290             if ($value !== null) {
1291                 $config = new stdClass();
1292                 $config->name  = $name;
1293                 $config->value = $value;
1294                 $DB->insert_record('config', $config, false);
1295             }
1296         }
1297
1298     } else { // plugin scope
1299         if ($id = $DB->get_field('config_plugins', 'id', array('name'=>$name, 'plugin'=>$plugin))) {
1300             if ($value===null) {
1301                 $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1302             } else {
1303                 $DB->set_field('config_plugins', 'value', $value, array('id'=>$id));
1304             }
1305         } else {
1306             if ($value !== null) {
1307                 $config = new stdClass();
1308                 $config->plugin = $plugin;
1309                 $config->name   = $name;
1310                 $config->value  = $value;
1311                 $DB->insert_record('config_plugins', $config, false);
1312             }
1313         }
1314     }
1315
1316     return true;
1317 }
1318
1319 /**
1320  * Get configuration values from the global config table
1321  * or the config_plugins table.
1322  *
1323  * If called with one parameter, it will load all the config
1324  * variables for one plugin, and return them as an object.
1325  *
1326  * If called with 2 parameters it will return a string single
1327  * value or false if the value is not found.
1328  *
1329  * @param string $plugin full component name
1330  * @param string $name default NULL
1331  * @return mixed hash-like object or single value, return false no config found
1332  */
1333 function get_config($plugin, $name = NULL) {
1334     global $CFG, $DB;
1335
1336     // normalise component name
1337     if ($plugin === 'moodle' or $plugin === 'core') {
1338         $plugin = NULL;
1339     }
1340
1341     if (!empty($name)) { // the user is asking for a specific value
1342         if (!empty($plugin)) {
1343             if (isset($CFG->forced_plugin_settings[$plugin]) and array_key_exists($name, $CFG->forced_plugin_settings[$plugin])) {
1344                 // setting forced in config file
1345                 return $CFG->forced_plugin_settings[$plugin][$name];
1346             } else {
1347                 return $DB->get_field('config_plugins', 'value', array('plugin'=>$plugin, 'name'=>$name));
1348             }
1349         } else {
1350             if (array_key_exists($name, $CFG->config_php_settings)) {
1351                 // setting force in config file
1352                 return $CFG->config_php_settings[$name];
1353             } else {
1354                 return $DB->get_field('config', 'value', array('name'=>$name));
1355             }
1356         }
1357     }
1358
1359     // the user is after a recordset
1360     if ($plugin) {
1361         $localcfg = $DB->get_records_menu('config_plugins', array('plugin'=>$plugin), '', 'name,value');
1362         if (isset($CFG->forced_plugin_settings[$plugin])) {
1363             foreach($CFG->forced_plugin_settings[$plugin] as $n=>$v) {
1364                 if (is_null($v) or is_array($v) or is_object($v)) {
1365                     // we do not want any extra mess here, just real settings that could be saved in db
1366                     unset($localcfg[$n]);
1367                 } else {
1368                     //convert to string as if it went through the DB
1369                     $localcfg[$n] = (string)$v;
1370                 }
1371             }
1372         }
1373         if ($localcfg) {
1374             return (object)$localcfg;
1375         } else {
1376             return new stdClass();
1377         }
1378
1379     } else {
1380         // this part is not really used any more, but anyway...
1381         $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
1382         foreach($CFG->config_php_settings as $n=>$v) {
1383             if (is_null($v) or is_array($v) or is_object($v)) {
1384                 // we do not want any extra mess here, just real settings that could be saved in db
1385                 unset($localcfg[$n]);
1386             } else {
1387                 //convert to string as if it went through the DB
1388                 $localcfg[$n] = (string)$v;
1389             }
1390         }
1391         return (object)$localcfg;
1392     }
1393 }
1394
1395 /**
1396  * Removes a key from global configuration
1397  *
1398  * @param string $name the key to set
1399  * @param string $plugin (optional) the plugin scope
1400  * @global object
1401  * @return boolean whether the operation succeeded.
1402  */
1403 function unset_config($name, $plugin=NULL) {
1404     global $CFG, $DB;
1405
1406     if (empty($plugin)) {
1407         unset($CFG->$name);
1408         $DB->delete_records('config', array('name'=>$name));
1409     } else {
1410         $DB->delete_records('config_plugins', array('name'=>$name, 'plugin'=>$plugin));
1411     }
1412
1413     return true;
1414 }
1415
1416 /**
1417  * Remove all the config variables for a given plugin.
1418  *
1419  * @param string $plugin a plugin, for example 'quiz' or 'qtype_multichoice';
1420  * @return boolean whether the operation succeeded.
1421  */
1422 function unset_all_config_for_plugin($plugin) {
1423     global $DB;
1424     $DB->delete_records('config_plugins', array('plugin' => $plugin));
1425     $like = $DB->sql_like('name', '?', true, true, false, '|');
1426     $params = array($DB->sql_like_escape($plugin.'_', '|') . '%');
1427     $DB->delete_records_select('config', $like, $params);
1428     return true;
1429 }
1430
1431 /**
1432  * Use this function to get a list of users from a config setting of type admin_setting_users_with_capability.
1433  *
1434  * All users are verified if they still have the necessary capability.
1435  *
1436  * @param string $value the value of the config setting.
1437  * @param string $capability the capability - must match the one passed to the admin_setting_users_with_capability constructor.
1438  * @param bool $include admins, include administrators
1439  * @return array of user objects.
1440  */
1441 function get_users_from_config($value, $capability, $includeadmins = true) {
1442     global $CFG, $DB;
1443
1444     if (empty($value) or $value === '$@NONE@$') {
1445         return array();
1446     }
1447
1448     // we have to make sure that users still have the necessary capability,
1449     // it should be faster to fetch them all first and then test if they are present
1450     // instead of validating them one-by-one
1451     $users = get_users_by_capability(get_context_instance(CONTEXT_SYSTEM), $capability);
1452     if ($includeadmins) {
1453         $admins = get_admins();
1454         foreach ($admins as $admin) {
1455             $users[$admin->id] = $admin;
1456         }
1457     }
1458
1459     if ($value === '$@ALL@$') {
1460         return $users;
1461     }
1462
1463     $result = array(); // result in correct order
1464     $allowed = explode(',', $value);
1465     foreach ($allowed as $uid) {
1466         if (isset($users[$uid])) {
1467             $user = $users[$uid];
1468             $result[$user->id] = $user;
1469         }
1470     }
1471
1472     return $result;
1473 }
1474
1475
1476 /**
1477  * Invalidates browser caches and cached data in temp
1478  * @return void
1479  */
1480 function purge_all_caches() {
1481     global $CFG;
1482
1483     reset_text_filters_cache();
1484     js_reset_all_caches();
1485     theme_reset_all_caches();
1486     get_string_manager()->reset_caches();
1487     textlib::reset_caches();
1488
1489     // purge all other caches: rss, simplepie, etc.
1490     remove_dir($CFG->cachedir.'', true);
1491
1492     // make sure cache dir is writable, throws exception if not
1493     make_cache_directory('');
1494
1495     // hack: this script may get called after the purifier was initialised,
1496     // but we do not want to verify repeatedly this exists in each call
1497     make_cache_directory('htmlpurifier');
1498 }
1499
1500 /**
1501  * Get volatile flags
1502  *
1503  * @param string $type
1504  * @param int    $changedsince default null
1505  * @return records array
1506  */
1507 function get_cache_flags($type, $changedsince=NULL) {
1508     global $DB;
1509
1510     $params = array('type'=>$type, 'expiry'=>time());
1511     $sqlwhere = "flagtype = :type AND expiry >= :expiry";
1512     if ($changedsince !== NULL) {
1513         $params['changedsince'] = $changedsince;
1514         $sqlwhere .= " AND timemodified > :changedsince";
1515     }
1516     $cf = array();
1517
1518     if ($flags = $DB->get_records_select('cache_flags', $sqlwhere, $params, '', 'name,value')) {
1519         foreach ($flags as $flag) {
1520             $cf[$flag->name] = $flag->value;
1521         }
1522     }
1523     return $cf;
1524 }
1525
1526 /**
1527  * Get volatile flags
1528  *
1529  * @param string $type
1530  * @param string $name
1531  * @param int    $changedsince default null
1532  * @return records array
1533  */
1534 function get_cache_flag($type, $name, $changedsince=NULL) {
1535     global $DB;
1536
1537     $params = array('type'=>$type, 'name'=>$name, 'expiry'=>time());
1538
1539     $sqlwhere = "flagtype = :type AND name = :name AND expiry >= :expiry";
1540     if ($changedsince !== NULL) {
1541         $params['changedsince'] = $changedsince;
1542         $sqlwhere .= " AND timemodified > :changedsince";
1543     }
1544
1545     return $DB->get_field_select('cache_flags', 'value', $sqlwhere, $params);
1546 }
1547
1548 /**
1549  * Set a volatile flag
1550  *
1551  * @param string $type the "type" namespace for the key
1552  * @param string $name the key to set
1553  * @param string $value the value to set (without magic quotes) - NULL will remove the flag
1554  * @param int $expiry (optional) epoch indicating expiry - defaults to now()+ 24hs
1555  * @return bool Always returns true
1556  */
1557 function set_cache_flag($type, $name, $value, $expiry=NULL) {
1558     global $DB;
1559
1560     $timemodified = time();
1561     if ($expiry===NULL || $expiry < $timemodified) {
1562         $expiry = $timemodified + 24 * 60 * 60;
1563     } else {
1564         $expiry = (int)$expiry;
1565     }
1566
1567     if ($value === NULL) {
1568         unset_cache_flag($type,$name);
1569         return true;
1570     }
1571
1572     if ($f = $DB->get_record('cache_flags', array('name'=>$name, 'flagtype'=>$type), '*', IGNORE_MULTIPLE)) { // this is a potential problem in DEBUG_DEVELOPER
1573         if ($f->value == $value and $f->expiry == $expiry and $f->timemodified == $timemodified) {
1574             return true; //no need to update; helps rcache too
1575         }
1576         $f->value        = $value;
1577         $f->expiry       = $expiry;
1578         $f->timemodified = $timemodified;
1579         $DB->update_record('cache_flags', $f);
1580     } else {
1581         $f = new stdClass();
1582         $f->flagtype     = $type;
1583         $f->name         = $name;
1584         $f->value        = $value;
1585         $f->expiry       = $expiry;
1586         $f->timemodified = $timemodified;
1587         $DB->insert_record('cache_flags', $f);
1588     }
1589     return true;
1590 }
1591
1592 /**
1593  * Removes a single volatile flag
1594  *
1595  * @global object
1596  * @param string $type the "type" namespace for the key
1597  * @param string $name the key to set
1598  * @return bool
1599  */
1600 function unset_cache_flag($type, $name) {
1601     global $DB;
1602     $DB->delete_records('cache_flags', array('name'=>$name, 'flagtype'=>$type));
1603     return true;
1604 }
1605
1606 /**
1607  * Garbage-collect volatile flags
1608  *
1609  * @return bool Always returns true
1610  */
1611 function gc_cache_flags() {
1612     global $DB;
1613     $DB->delete_records_select('cache_flags', 'expiry < ?', array(time()));
1614     return true;
1615 }
1616
1617 // USER PREFERENCE API
1618
1619 /**
1620  * Refresh user preference cache. This is used most often for $USER
1621  * object that is stored in session, but it also helps with performance in cron script.
1622  *
1623  * Preferences for each user are loaded on first use on every page, then again after the timeout expires.
1624  *
1625  * @package  core
1626  * @category preference
1627  * @access   public
1628  * @param    stdClass         $user          User object. Preferences are preloaded into 'preference' property
1629  * @param    int              $cachelifetime Cache life time on the current page (in seconds)
1630  * @throws   coding_exception
1631  * @return   null
1632  */
1633 function check_user_preferences_loaded(stdClass $user, $cachelifetime = 120) {
1634     global $DB;
1635     static $loadedusers = array(); // Static cache, we need to check on each page load, not only every 2 minutes.
1636
1637     if (!isset($user->id)) {
1638         throw new coding_exception('Invalid $user parameter in check_user_preferences_loaded() call, missing id field');
1639     }
1640
1641     if (empty($user->id) or isguestuser($user->id)) {
1642         // No permanent storage for not-logged-in users and guest
1643         if (!isset($user->preference)) {
1644             $user->preference = array();
1645         }
1646         return;
1647     }
1648
1649     $timenow = time();
1650
1651     if (isset($loadedusers[$user->id]) and isset($user->preference) and isset($user->preference['_lastloaded'])) {
1652         // Already loaded at least once on this page. Are we up to date?
1653         if ($user->preference['_lastloaded'] + $cachelifetime > $timenow) {
1654             // no need to reload - we are on the same page and we loaded prefs just a moment ago
1655             return;
1656
1657         } else if (!get_cache_flag('userpreferenceschanged', $user->id, $user->preference['_lastloaded'])) {
1658             // no change since the lastcheck on this page
1659             $user->preference['_lastloaded'] = $timenow;
1660             return;
1661         }
1662     }
1663
1664     // OK, so we have to reload all preferences
1665     $loadedusers[$user->id] = true;
1666     $user->preference = $DB->get_records_menu('user_preferences', array('userid'=>$user->id), '', 'name,value'); // All values
1667     $user->preference['_lastloaded'] = $timenow;
1668 }
1669
1670 /**
1671  * Called from set/unset_user_preferences, so that the prefs can
1672  * be correctly reloaded in different sessions.
1673  *
1674  * NOTE: internal function, do not call from other code.
1675  *
1676  * @package core
1677  * @access  private
1678  * @param   integer         $userid the user whose prefs were changed.
1679  */
1680 function mark_user_preferences_changed($userid) {
1681     global $CFG;
1682
1683     if (empty($userid) or isguestuser($userid)) {
1684         // no cache flags for guest and not-logged-in users
1685         return;
1686     }
1687
1688     set_cache_flag('userpreferenceschanged', $userid, 1, time() + $CFG->sessiontimeout);
1689 }
1690
1691 /**
1692  * Sets a preference for the specified user.
1693  *
1694  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1695  *
1696  * @package  core
1697  * @category preference
1698  * @access   public
1699  * @param    string            $name  The key to set as preference for the specified user
1700  * @param    string            $value The value to set for the $name key in the specified user's
1701  *                                    record, null means delete current value.
1702  * @param    stdClass|int|null $user  A moodle user object or id, null means current user
1703  * @throws   coding_exception
1704  * @return   bool                     Always true or exception
1705  */
1706 function set_user_preference($name, $value, $user = null) {
1707     global $USER, $DB;
1708
1709     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1710         throw new coding_exception('Invalid preference name in set_user_preference() call');
1711     }
1712
1713     if (is_null($value)) {
1714         // null means delete current
1715         return unset_user_preference($name, $user);
1716     } else if (is_object($value)) {
1717         throw new coding_exception('Invalid value in set_user_preference() call, objects are not allowed');
1718     } else if (is_array($value)) {
1719         throw new coding_exception('Invalid value in set_user_preference() call, arrays are not allowed');
1720     }
1721     $value = (string)$value;
1722     if (textlib::strlen($value) > 1333) { //value column maximum length is 1333 characters
1723         throw new coding_exception('Invalid value in set_user_preference() call, value is is too long for the value column');
1724     }
1725
1726     if (is_null($user)) {
1727         $user = $USER;
1728     } else if (isset($user->id)) {
1729         // $user is valid object
1730     } else if (is_numeric($user)) {
1731         $user = (object)array('id'=>(int)$user);
1732     } else {
1733         throw new coding_exception('Invalid $user parameter in set_user_preference() call');
1734     }
1735
1736     check_user_preferences_loaded($user);
1737
1738     if (empty($user->id) or isguestuser($user->id)) {
1739         // no permanent storage for not-logged-in users and guest
1740         $user->preference[$name] = $value;
1741         return true;
1742     }
1743
1744     if ($preference = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>$name))) {
1745         if ($preference->value === $value and isset($user->preference[$name]) and $user->preference[$name] === $value) {
1746             // preference already set to this value
1747             return true;
1748         }
1749         $DB->set_field('user_preferences', 'value', $value, array('id'=>$preference->id));
1750
1751     } else {
1752         $preference = new stdClass();
1753         $preference->userid = $user->id;
1754         $preference->name   = $name;
1755         $preference->value  = $value;
1756         $DB->insert_record('user_preferences', $preference);
1757     }
1758
1759     // update value in cache
1760     $user->preference[$name] = $value;
1761
1762     // set reload flag for other sessions
1763     mark_user_preferences_changed($user->id);
1764
1765     return true;
1766 }
1767
1768 /**
1769  * Sets a whole array of preferences for the current user
1770  *
1771  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1772  *
1773  * @package  core
1774  * @category preference
1775  * @access   public
1776  * @param    array             $prefarray An array of key/value pairs to be set
1777  * @param    stdClass|int|null $user      A moodle user object or id, null means current user
1778  * @return   bool                         Always true or exception
1779  */
1780 function set_user_preferences(array $prefarray, $user = null) {
1781     foreach ($prefarray as $name => $value) {
1782         set_user_preference($name, $value, $user);
1783     }
1784     return true;
1785 }
1786
1787 /**
1788  * Unsets a preference completely by deleting it from the database
1789  *
1790  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1791  *
1792  * @package  core
1793  * @category preference
1794  * @access   public
1795  * @param    string            $name The key to unset as preference for the specified user
1796  * @param    stdClass|int|null $user A moodle user object or id, null means current user
1797  * @throws   coding_exception
1798  * @return   bool                    Always true or exception
1799  */
1800 function unset_user_preference($name, $user = null) {
1801     global $USER, $DB;
1802
1803     if (empty($name) or is_numeric($name) or $name === '_lastloaded') {
1804         throw new coding_exception('Invalid preference name in unset_user_preference() call');
1805     }
1806
1807     if (is_null($user)) {
1808         $user = $USER;
1809     } else if (isset($user->id)) {
1810         // $user is valid object
1811     } else if (is_numeric($user)) {
1812         $user = (object)array('id'=>(int)$user);
1813     } else {
1814         throw new coding_exception('Invalid $user parameter in unset_user_preference() call');
1815     }
1816
1817     check_user_preferences_loaded($user);
1818
1819     if (empty($user->id) or isguestuser($user->id)) {
1820         // no permanent storage for not-logged-in user and guest
1821         unset($user->preference[$name]);
1822         return true;
1823     }
1824
1825     // delete from DB
1826     $DB->delete_records('user_preferences', array('userid'=>$user->id, 'name'=>$name));
1827
1828     // delete the preference from cache
1829     unset($user->preference[$name]);
1830
1831     // set reload flag for other sessions
1832     mark_user_preferences_changed($user->id);
1833
1834     return true;
1835 }
1836
1837 /**
1838  * Used to fetch user preference(s)
1839  *
1840  * If no arguments are supplied this function will return
1841  * all of the current user preferences as an array.
1842  *
1843  * If a name is specified then this function
1844  * attempts to return that particular preference value.  If
1845  * none is found, then the optional value $default is returned,
1846  * otherwise NULL.
1847  *
1848  * If a $user object is submitted it's 'preference' property is used for the preferences cache.
1849  *
1850  * @package  core
1851  * @category preference
1852  * @access   public
1853  * @param    string            $name    Name of the key to use in finding a preference value
1854  * @param    mixed|null        $default Value to be returned if the $name key is not set in the user preferences
1855  * @param    stdClass|int|null $user    A moodle user object or id, null means current user
1856  * @throws   coding_exception
1857  * @return   string|mixed|null          A string containing the value of a single preference. An
1858  *                                      array with all of the preferences or null
1859  */
1860 function get_user_preferences($name = null, $default = null, $user = null) {
1861     global $USER;
1862
1863     if (is_null($name)) {
1864         // all prefs
1865     } else if (is_numeric($name) or $name === '_lastloaded') {
1866         throw new coding_exception('Invalid preference name in get_user_preferences() call');
1867     }
1868
1869     if (is_null($user)) {
1870         $user = $USER;
1871     } else if (isset($user->id)) {
1872         // $user is valid object
1873     } else if (is_numeric($user)) {
1874         $user = (object)array('id'=>(int)$user);
1875     } else {
1876         throw new coding_exception('Invalid $user parameter in get_user_preferences() call');
1877     }
1878
1879     check_user_preferences_loaded($user);
1880
1881     if (empty($name)) {
1882         return $user->preference; // All values
1883     } else if (isset($user->preference[$name])) {
1884         return $user->preference[$name]; // The single string value
1885     } else {
1886         return $default; // Default value (null if not specified)
1887     }
1888 }
1889
1890 /// FUNCTIONS FOR HANDLING TIME ////////////////////////////////////////////
1891
1892 /**
1893  * Given date parts in user time produce a GMT timestamp.
1894  *
1895  * @package core
1896  * @category time
1897  * @param int $year The year part to create timestamp of
1898  * @param int $month The month part to create timestamp of
1899  * @param int $day The day part to create timestamp of
1900  * @param int $hour The hour part to create timestamp of
1901  * @param int $minute The minute part to create timestamp of
1902  * @param int $second The second part to create timestamp of
1903  * @param int|float|string $timezone Timezone modifier, used to calculate GMT time offset.
1904  *             if 99 then default user's timezone is used {@link http://docs.moodle.org/dev/Time_API#Timezone}
1905  * @param bool $applydst Toggle Daylight Saving Time, default true, will be
1906  *             applied only if timezone is 99 or string.
1907  * @return int GMT timestamp
1908  */
1909 function make_timestamp($year, $month=1, $day=1, $hour=0, $minute=0, $second=0, $timezone=99, $applydst=true) {
1910
1911     //save input timezone, required for dst offset check.
1912     $passedtimezone = $timezone;
1913
1914     $timezone = get_user_timezone_offset($timezone);
1915
1916     if (abs($timezone) > 13) {  //server time
1917         $time = mktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1918     } else {
1919         $time = gmmktime((int)$hour, (int)$minute, (int)$second, (int)$month, (int)$day, (int)$year);
1920         $time = usertime($time, $timezone);
1921
1922         //Apply dst for string timezones or if 99 then try dst offset with user's default timezone
1923         if ($applydst && ((99 == $passedtimezone) || !is_numeric($passedtimezone))) {
1924             $time -= dst_offset_on($time, $passedtimezone);
1925         }
1926     }
1927
1928     return $time;
1929
1930 }
1931
1932 /**
1933  * Format a date/time (seconds) as weeks, days, hours etc as needed
1934  *
1935  * Given an amount of time in seconds, returns string
1936  * formatted nicely as weeks, days, hours etc as needed
1937  *
1938  * @package core
1939  * @category time
1940  * @uses MINSECS
1941  * @uses HOURSECS
1942  * @uses DAYSECS
1943  * @uses YEARSECS
1944  * @param int $totalsecs Time in seconds
1945  * @param object $str Should be a time object
1946  * @return string A nicely formatted date/time string
1947  */
1948  function format_time($totalsecs, $str=NULL) {
1949
1950     $totalsecs = abs($totalsecs);
1951
1952     if (!$str) {  // Create the str structure the slow way
1953         $str = new stdClass();
1954         $str->day   = get_string('day');
1955         $str->days  = get_string('days');
1956         $str->hour  = get_string('hour');
1957         $str->hours = get_string('hours');
1958         $str->min   = get_string('min');
1959         $str->mins  = get_string('mins');
1960         $str->sec   = get_string('sec');
1961         $str->secs  = get_string('secs');
1962         $str->year  = get_string('year');
1963         $str->years = get_string('years');
1964     }
1965
1966
1967     $years     = floor($totalsecs/YEARSECS);
1968     $remainder = $totalsecs - ($years*YEARSECS);
1969     $days      = floor($remainder/DAYSECS);
1970     $remainder = $totalsecs - ($days*DAYSECS);
1971     $hours     = floor($remainder/HOURSECS);
1972     $remainder = $remainder - ($hours*HOURSECS);
1973     $mins      = floor($remainder/MINSECS);
1974     $secs      = $remainder - ($mins*MINSECS);
1975
1976     $ss = ($secs == 1)  ? $str->sec  : $str->secs;
1977     $sm = ($mins == 1)  ? $str->min  : $str->mins;
1978     $sh = ($hours == 1) ? $str->hour : $str->hours;
1979     $sd = ($days == 1)  ? $str->day  : $str->days;
1980     $sy = ($years == 1)  ? $str->year  : $str->years;
1981
1982     $oyears = '';
1983     $odays = '';
1984     $ohours = '';
1985     $omins = '';
1986     $osecs = '';
1987
1988     if ($years)  $oyears  = $years .' '. $sy;
1989     if ($days)  $odays  = $days .' '. $sd;
1990     if ($hours) $ohours = $hours .' '. $sh;
1991     if ($mins)  $omins  = $mins .' '. $sm;
1992     if ($secs)  $osecs  = $secs .' '. $ss;
1993
1994     if ($years) return trim($oyears .' '. $odays);
1995     if ($days)  return trim($odays .' '. $ohours);
1996     if ($hours) return trim($ohours .' '. $omins);
1997     if ($mins)  return trim($omins .' '. $osecs);
1998     if ($secs)  return $osecs;
1999     return get_string('now');
2000 }
2001
2002 /**
2003  * Returns a formatted string that represents a date in user time
2004  *
2005  * Returns a formatted string that represents a date in user time
2006  * <b>WARNING: note that the format is for strftime(), not date().</b>
2007  * Because of a bug in most Windows time libraries, we can't use
2008  * the nicer %e, so we have to use %d which has leading zeroes.
2009  * A lot of the fuss in the function is just getting rid of these leading
2010  * zeroes as efficiently as possible.
2011  *
2012  * If parameter fixday = true (default), then take off leading
2013  * zero from %d, else maintain it.
2014  *
2015  * @package core
2016  * @category time
2017  * @param int $date the timestamp in UTC, as obtained from the database.
2018  * @param string $format strftime format. You should probably get this using
2019  *        get_string('strftime...', 'langconfig');
2020  * @param int|float|string  $timezone by default, uses the user's time zone. if numeric and
2021  *        not 99 then daylight saving will not be added.
2022  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2023  * @param bool $fixday If true (default) then the leading zero from %d is removed.
2024  *        If false then the leading zero is maintained.
2025  * @param bool $fixhour If true (default) then the leading zero from %I is removed.
2026  * @return string the formatted date/time.
2027  */
2028 function userdate($date, $format = '', $timezone = 99, $fixday = true, $fixhour = true) {
2029
2030     global $CFG;
2031
2032     if (empty($format)) {
2033         $format = get_string('strftimedaydatetime', 'langconfig');
2034     }
2035
2036     if (!empty($CFG->nofixday)) {  // Config.php can force %d not to be fixed.
2037         $fixday = false;
2038     } else if ($fixday) {
2039         $formatnoday = str_replace('%d', 'DD', $format);
2040         $fixday = ($formatnoday != $format);
2041         $format = $formatnoday;
2042     }
2043
2044     // Note: This logic about fixing 12-hour time to remove unnecessary leading
2045     // zero is required because on Windows, PHP strftime function does not
2046     // support the correct 'hour without leading zero' parameter (%l).
2047     if (!empty($CFG->nofixhour)) {
2048         // Config.php can force %I not to be fixed.
2049         $fixhour = false;
2050     } else if ($fixhour) {
2051         $formatnohour = str_replace('%I', 'HH', $format);
2052         $fixhour = ($formatnohour != $format);
2053         $format = $formatnohour;
2054     }
2055
2056     //add daylight saving offset for string timezones only, as we can't get dst for
2057     //float values. if timezone is 99 (user default timezone), then try update dst.
2058     if ((99 == $timezone) || !is_numeric($timezone)) {
2059         $date += dst_offset_on($date, $timezone);
2060     }
2061
2062     $timezone = get_user_timezone_offset($timezone);
2063
2064     // If we are running under Windows convert to windows encoding and then back to UTF-8
2065     // (because it's impossible to specify UTF-8 to fetch locale info in Win32)
2066
2067     if (abs($timezone) > 13) {   /// Server time
2068         if ($CFG->ostype == 'WINDOWS' and ($localewincharset = get_string('localewincharset', 'langconfig'))) {
2069             $format = textlib::convert($format, 'utf-8', $localewincharset);
2070             $datestring = strftime($format, $date);
2071             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2072         } else {
2073             $datestring = strftime($format, $date);
2074         }
2075         if ($fixday) {
2076             $daystring  = ltrim(str_replace(array(' 0', ' '), '', strftime(' %d', $date)));
2077             $datestring = str_replace('DD', $daystring, $datestring);
2078         }
2079         if ($fixhour) {
2080             $hourstring = ltrim(str_replace(array(' 0', ' '), '', strftime(' %I', $date)));
2081             $datestring = str_replace('HH', $hourstring, $datestring);
2082         }
2083
2084     } else {
2085         $date += (int)($timezone * 3600);
2086         if ($CFG->ostype == 'WINDOWS' and ($localewincharset = get_string('localewincharset', 'langconfig'))) {
2087             $format = textlib::convert($format, 'utf-8', $localewincharset);
2088             $datestring = gmstrftime($format, $date);
2089             $datestring = textlib::convert($datestring, $localewincharset, 'utf-8');
2090         } else {
2091             $datestring = gmstrftime($format, $date);
2092         }
2093         if ($fixday) {
2094             $daystring  = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %d', $date)));
2095             $datestring = str_replace('DD', $daystring, $datestring);
2096         }
2097         if ($fixhour) {
2098             $hourstring = ltrim(str_replace(array(' 0', ' '), '', gmstrftime(' %I', $date)));
2099             $datestring = str_replace('HH', $hourstring, $datestring);
2100         }
2101     }
2102
2103     return $datestring;
2104 }
2105
2106 /**
2107  * Given a $time timestamp in GMT (seconds since epoch),
2108  * returns an array that represents the date in user time
2109  *
2110  * @package core
2111  * @category time
2112  * @uses HOURSECS
2113  * @param int $time Timestamp in GMT
2114  * @param float|int|string $timezone offset's time with timezone, if float and not 99, then no
2115  *        dst offset is applyed {@link http://docs.moodle.org/dev/Time_API#Timezone}
2116  * @return array An array that represents the date in user time
2117  */
2118 function usergetdate($time, $timezone=99) {
2119
2120     //save input timezone, required for dst offset check.
2121     $passedtimezone = $timezone;
2122
2123     $timezone = get_user_timezone_offset($timezone);
2124
2125     if (abs($timezone) > 13) {    // Server time
2126         return getdate($time);
2127     }
2128
2129     //add daylight saving offset for string timezones only, as we can't get dst for
2130     //float values. if timezone is 99 (user default timezone), then try update dst.
2131     if ($passedtimezone == 99 || !is_numeric($passedtimezone)) {
2132         $time += dst_offset_on($time, $passedtimezone);
2133     }
2134
2135     $time += intval((float)$timezone * HOURSECS);
2136
2137     $datestring = gmstrftime('%B_%A_%j_%Y_%m_%w_%d_%H_%M_%S', $time);
2138
2139     //be careful to ensure the returned array matches that produced by getdate() above
2140     list(
2141         $getdate['month'],
2142         $getdate['weekday'],
2143         $getdate['yday'],
2144         $getdate['year'],
2145         $getdate['mon'],
2146         $getdate['wday'],
2147         $getdate['mday'],
2148         $getdate['hours'],
2149         $getdate['minutes'],
2150         $getdate['seconds']
2151     ) = explode('_', $datestring);
2152
2153     // set correct datatype to match with getdate()
2154     $getdate['seconds'] = (int)$getdate['seconds'];
2155     $getdate['yday'] = (int)$getdate['yday'] - 1; // gettime returns 0 through 365
2156     $getdate['year'] = (int)$getdate['year'];
2157     $getdate['mon'] = (int)$getdate['mon'];
2158     $getdate['wday'] = (int)$getdate['wday'];
2159     $getdate['mday'] = (int)$getdate['mday'];
2160     $getdate['hours'] = (int)$getdate['hours'];
2161     $getdate['minutes']  = (int)$getdate['minutes'];
2162     return $getdate;
2163 }
2164
2165 /**
2166  * Given a GMT timestamp (seconds since epoch), offsets it by
2167  * the timezone.  eg 3pm in India is 3pm GMT - 7 * 3600 seconds
2168  *
2169  * @package core
2170  * @category time
2171  * @uses HOURSECS
2172  * @param int $date Timestamp in GMT
2173  * @param float|int|string $timezone timezone to calculate GMT time offset before
2174  *        calculating user time, 99 is default user timezone
2175  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2176  * @return int
2177  */
2178 function usertime($date, $timezone=99) {
2179
2180     $timezone = get_user_timezone_offset($timezone);
2181
2182     if (abs($timezone) > 13) {
2183         return $date;
2184     }
2185     return $date - (int)($timezone * HOURSECS);
2186 }
2187
2188 /**
2189  * Given a time, return the GMT timestamp of the most recent midnight
2190  * for the current user.
2191  *
2192  * @package core
2193  * @category time
2194  * @param int $date Timestamp in GMT
2195  * @param float|int|string $timezone timezone to calculate GMT time offset before
2196  *        calculating user midnight time, 99 is default user timezone
2197  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2198  * @return int Returns a GMT timestamp
2199  */
2200 function usergetmidnight($date, $timezone=99) {
2201
2202     $userdate = usergetdate($date, $timezone);
2203
2204     // Time of midnight of this user's day, in GMT
2205     return make_timestamp($userdate['year'], $userdate['mon'], $userdate['mday'], 0, 0, 0, $timezone);
2206
2207 }
2208
2209 /**
2210  * Returns a string that prints the user's timezone
2211  *
2212  * @package core
2213  * @category time
2214  * @param float|int|string $timezone timezone to calculate GMT time offset before
2215  *        calculating user timezone, 99 is default user timezone
2216  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2217  * @return string
2218  */
2219 function usertimezone($timezone=99) {
2220
2221     $tz = get_user_timezone($timezone);
2222
2223     if (!is_float($tz)) {
2224         return $tz;
2225     }
2226
2227     if(abs($tz) > 13) { // Server time
2228         return get_string('serverlocaltime');
2229     }
2230
2231     if($tz == intval($tz)) {
2232         // Don't show .0 for whole hours
2233         $tz = intval($tz);
2234     }
2235
2236     if($tz == 0) {
2237         return 'UTC';
2238     }
2239     else if($tz > 0) {
2240         return 'UTC+'.$tz;
2241     }
2242     else {
2243         return 'UTC'.$tz;
2244     }
2245
2246 }
2247
2248 /**
2249  * Returns a float which represents the user's timezone difference from GMT in hours
2250  * Checks various settings and picks the most dominant of those which have a value
2251  *
2252  * @package core
2253  * @category time
2254  * @param float|int|string $tz timezone to calculate GMT time offset for user,
2255  *        99 is default user timezone
2256  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2257  * @return float
2258  */
2259 function get_user_timezone_offset($tz = 99) {
2260
2261     global $USER, $CFG;
2262
2263     $tz = get_user_timezone($tz);
2264
2265     if (is_float($tz)) {
2266         return $tz;
2267     } else {
2268         $tzrecord = get_timezone_record($tz);
2269         if (empty($tzrecord)) {
2270             return 99.0;
2271         }
2272         return (float)$tzrecord->gmtoff / HOURMINS;
2273     }
2274 }
2275
2276 /**
2277  * Returns an int which represents the systems's timezone difference from GMT in seconds
2278  *
2279  * @package core
2280  * @category time
2281  * @param float|int|string $tz timezone for which offset is required.
2282  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2283  * @return int|bool if found, false is timezone 99 or error
2284  */
2285 function get_timezone_offset($tz) {
2286     global $CFG;
2287
2288     if ($tz == 99) {
2289         return false;
2290     }
2291
2292     if (is_numeric($tz)) {
2293         return intval($tz * 60*60);
2294     }
2295
2296     if (!$tzrecord = get_timezone_record($tz)) {
2297         return false;
2298     }
2299     return intval($tzrecord->gmtoff * 60);
2300 }
2301
2302 /**
2303  * Returns a float or a string which denotes the user's timezone
2304  * 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)
2305  * means that for this timezone there are also DST rules to be taken into account
2306  * Checks various settings and picks the most dominant of those which have a value
2307  *
2308  * @package core
2309  * @category time
2310  * @param float|int|string $tz timezone to calculate GMT time offset before
2311  *        calculating user timezone, 99 is default user timezone
2312  *        {@link http://docs.moodle.org/dev/Time_API#Timezone}
2313  * @return float|string
2314  */
2315 function get_user_timezone($tz = 99) {
2316     global $USER, $CFG;
2317
2318     $timezones = array(
2319         $tz,
2320         isset($CFG->forcetimezone) ? $CFG->forcetimezone : 99,
2321         isset($USER->timezone) ? $USER->timezone : 99,
2322         isset($CFG->timezone) ? $CFG->timezone : 99,
2323         );
2324
2325     $tz = 99;
2326
2327     while(($tz == '' || $tz == 99 || $tz == NULL) && $next = each($timezones)) {
2328         $tz = $next['value'];
2329     }
2330
2331     return is_numeric($tz) ? (float) $tz : $tz;
2332 }
2333
2334 /**
2335  * Returns cached timezone record for given $timezonename
2336  *
2337  * @package core
2338  * @param string $timezonename name of the timezone
2339  * @return stdClass|bool timezonerecord or false
2340  */
2341 function get_timezone_record($timezonename) {
2342     global $CFG, $DB;
2343     static $cache = NULL;
2344
2345     if ($cache === NULL) {
2346         $cache = array();
2347     }
2348
2349     if (isset($cache[$timezonename])) {
2350         return $cache[$timezonename];
2351     }
2352
2353     return $cache[$timezonename] = $DB->get_record_sql('SELECT * FROM {timezone}
2354                                                         WHERE name = ? ORDER BY year DESC', array($timezonename), IGNORE_MULTIPLE);
2355 }
2356
2357 /**
2358  * Build and store the users Daylight Saving Time (DST) table
2359  *
2360  * @package core
2361  * @param int $from_year Start year for the table, defaults to 1971
2362  * @param int $to_year End year for the table, defaults to 2035
2363  * @param int|float|string $strtimezone, timezone to check if dst should be applyed.
2364  * @return bool
2365  */
2366 function calculate_user_dst_table($from_year = NULL, $to_year = NULL, $strtimezone = NULL) {
2367     global $CFG, $SESSION, $DB;
2368
2369     $usertz = get_user_timezone($strtimezone);
2370
2371     if (is_float($usertz)) {
2372         // Trivial timezone, no DST
2373         return false;
2374     }
2375
2376     if (!empty($SESSION->dst_offsettz) && $SESSION->dst_offsettz != $usertz) {
2377         // We have precalculated values, but the user's effective TZ has changed in the meantime, so reset
2378         unset($SESSION->dst_offsets);
2379         unset($SESSION->dst_range);
2380     }
2381
2382     if (!empty($SESSION->dst_offsets) && empty($from_year) && empty($to_year)) {
2383         // Repeat calls which do not request specific year ranges stop here, we have already calculated the table
2384         // This will be the return path most of the time, pretty light computationally
2385         return true;
2386     }
2387
2388     // Reaching here means we either need to extend our table or create it from scratch
2389
2390     // Remember which TZ we calculated these changes for
2391     $SESSION->dst_offsettz = $usertz;
2392
2393     if(empty($SESSION->dst_offsets)) {
2394         // If we 're creating from scratch, put the two guard elements in there
2395         $SESSION->dst_offsets = array(1 => NULL, 0 => NULL);
2396     }
2397     if(empty($SESSION->dst_range)) {
2398         // If creating from scratch
2399         $from = max((empty($from_year) ? intval(date('Y')) - 3 : $from_year), 1971);
2400         $to   = min((empty($to_year)   ? intval(date('Y')) + 3 : $to_year),   2035);
2401
2402         // Fill in the array with the extra years we need to process
2403         $yearstoprocess = array();
2404         for($i = $from; $i <= $to; ++$i) {
2405             $yearstoprocess[] = $i;
2406         }
2407
2408         // Take note of which years we have processed for future calls
2409         $SESSION->dst_range = array($from, $to);
2410     }
2411     else {
2412         // If needing to extend the table, do the same
2413         $yearstoprocess = array();
2414
2415         $from = max((empty($from_year) ? $SESSION->dst_range[0] : $from_year), 1971);
2416         $to   = min((empty($to_year)   ? $SESSION->dst_range[1] : $to_year),   2035);
2417
2418         if($from < $SESSION->dst_range[0]) {
2419             // Take note of which years we need to process and then note that we have processed them for future calls
2420             for($i = $from; $i < $SESSION->dst_range[0]; ++$i) {
2421                 $yearstoprocess[] = $i;
2422             }
2423             $SESSION->dst_range[0] = $from;
2424         }
2425         if($to > $SESSION->dst_range[1]) {
2426             // Take note of which years we need to process and then note that we have processed them for future calls
2427             for($i = $SESSION->dst_range[1] + 1; $i <= $to; ++$i) {
2428                 $yearstoprocess[] = $i;
2429             }
2430             $SESSION->dst_range[1] = $to;
2431         }
2432     }
2433
2434     if(empty($yearstoprocess)) {
2435         // This means that there was a call requesting a SMALLER range than we have already calculated
2436         return true;
2437     }
2438
2439     // From now on, we know that the array has at least the two guard elements, and $yearstoprocess has the years we need
2440     // Also, the array is sorted in descending timestamp order!
2441
2442     // Get DB data
2443
2444     static $presets_cache = array();
2445     if (!isset($presets_cache[$usertz])) {
2446         $presets_cache[$usertz] = $DB->get_records('timezone', array('name'=>$usertz), 'year DESC', 'year, gmtoff, dstoff, dst_month, dst_startday, dst_weekday, dst_skipweeks, dst_time, std_month, std_startday, std_weekday, std_skipweeks, std_time');
2447     }
2448     if(empty($presets_cache[$usertz])) {
2449         return false;
2450     }
2451
2452     // Remove ending guard (first element of the array)
2453     reset($SESSION->dst_offsets);
2454     unset($SESSION->dst_offsets[key($SESSION->dst_offsets)]);
2455
2456     // Add all required change timestamps
2457     foreach($yearstoprocess as $y) {
2458         // Find the record which is in effect for the year $y
2459         foreach($presets_cache[$usertz] as $year => $preset) {
2460             if($year <= $y) {
2461                 break;
2462             }
2463         }
2464
2465         $changes = dst_changes_for_year($y, $preset);
2466
2467         if($changes === NULL) {
2468             continue;
2469         }
2470         if($changes['dst'] != 0) {
2471             $SESSION->dst_offsets[$changes['dst']] = $preset->dstoff * MINSECS;
2472         }
2473         if($changes['std'] != 0) {
2474             $SESSION->dst_offsets[$changes['std']] = 0;
2475         }
2476     }
2477
2478     // Put in a guard element at the top
2479     $maxtimestamp = max(array_keys($SESSION->dst_offsets));
2480     $SESSION->dst_offsets[($maxtimestamp + DAYSECS)] = NULL; // DAYSECS is arbitrary, any "small" number will do
2481
2482     // Sort again
2483     krsort($SESSION->dst_offsets);
2484
2485     return true;
2486 }
2487
2488 /**
2489  * Calculates the required DST change and returns a Timestamp Array
2490  *
2491  * @package core
2492  * @category time
2493  * @uses HOURSECS
2494  * @uses MINSECS
2495  * @param int|string $year Int or String Year to focus on
2496  * @param object $timezone Instatiated Timezone object
2497  * @return array|null Array dst=>xx, 0=>xx, std=>yy, 1=>yy or NULL
2498  */
2499 function dst_changes_for_year($year, $timezone) {
2500
2501     if($timezone->dst_startday == 0 && $timezone->dst_weekday == 0 && $timezone->std_startday == 0 && $timezone->std_weekday == 0) {
2502         return NULL;
2503     }
2504
2505     $monthdaydst = find_day_in_month($timezone->dst_startday, $timezone->dst_weekday, $timezone->dst_month, $year);
2506     $monthdaystd = find_day_in_month($timezone->std_startday, $timezone->std_weekday, $timezone->std_month, $year);
2507
2508     list($dst_hour, $dst_min) = explode(':', $timezone->dst_time);
2509     list($std_hour, $std_min) = explode(':', $timezone->std_time);
2510
2511     $timedst = make_timestamp($year, $timezone->dst_month, $monthdaydst, 0, 0, 0, 99, false);
2512     $timestd = make_timestamp($year, $timezone->std_month, $monthdaystd, 0, 0, 0, 99, false);
2513
2514     // Instead of putting hour and minute in make_timestamp(), we add them afterwards.
2515     // This has the advantage of being able to have negative values for hour, i.e. for timezones
2516     // where GMT time would be in the PREVIOUS day than the local one on which DST changes.
2517
2518     $timedst += $dst_hour * HOURSECS + $dst_min * MINSECS;
2519     $timestd += $std_hour * HOURSECS + $std_min * MINSECS;
2520
2521     return array('dst' => $timedst, 0 => $timedst, 'std' => $timestd, 1 => $timestd);
2522 }
2523
2524 /**
2525  * Calculates the Daylight Saving Offset for a given date/time (timestamp)
2526  * - Note: Daylight saving only works for string timezones and not for float.
2527  *
2528  * @package core
2529  * @category time
2530  * @param int $time must NOT be compensated at all, it has to be a pure timestamp
2531  * @param int|float|string $strtimezone timezone for which offset is expected, if 99 or null
2532  *        then user's default timezone is used. {@link http://docs.moodle.org/dev/Time_API#Timezone}
2533  * @return int
2534  */
2535 function dst_offset_on($time, $strtimezone = NULL) {
2536     global $SESSION;
2537
2538     if(!calculate_user_dst_table(NULL, NULL, $strtimezone) || empty($SESSION->dst_offsets)) {
2539         return 0;
2540     }
2541
2542     reset($SESSION->dst_offsets);
2543     while(list($from, $offset) = each($SESSION->dst_offsets)) {
2544         if($from <= $time) {
2545             break;
2546         }
2547     }
2548
2549     // This is the normal return path
2550     if($offset !== NULL) {
2551         return $offset;
2552     }
2553
2554     // Reaching this point means we haven't calculated far enough, do it now:
2555     // Calculate extra DST changes if needed and recurse. The recursion always
2556     // moves toward the stopping condition, so will always end.
2557
2558     if($from == 0) {
2559         // We need a year smaller than $SESSION->dst_range[0]
2560         if($SESSION->dst_range[0] == 1971) {
2561             return 0;
2562         }
2563         calculate_user_dst_table($SESSION->dst_range[0] - 5, NULL, $strtimezone);
2564         return dst_offset_on($time, $strtimezone);
2565     }
2566     else {
2567         // We need a year larger than $SESSION->dst_range[1]
2568         if($SESSION->dst_range[1] == 2035) {
2569             return 0;
2570         }
2571         calculate_user_dst_table(NULL, $SESSION->dst_range[1] + 5, $strtimezone);
2572         return dst_offset_on($time, $strtimezone);
2573     }
2574 }
2575
2576 /**
2577  * Calculates when the day appears in specific month
2578  *
2579  * @package core
2580  * @category time
2581  * @param int $startday starting day of the month
2582  * @param int $weekday The day when week starts (normally taken from user preferences)
2583  * @param int $month The month whose day is sought
2584  * @param int $year The year of the month whose day is sought
2585  * @return int
2586  */
2587 function find_day_in_month($startday, $weekday, $month, $year) {
2588
2589     $daysinmonth = days_in_month($month, $year);
2590
2591     if($weekday == -1) {
2592         // Don't care about weekday, so return:
2593         //    abs($startday) if $startday != -1
2594         //    $daysinmonth otherwise
2595         return ($startday == -1) ? $daysinmonth : abs($startday);
2596     }
2597
2598     // From now on we 're looking for a specific weekday
2599
2600     // Give "end of month" its actual value, since we know it
2601     if($startday == -1) {
2602         $startday = -1 * $daysinmonth;
2603     }
2604
2605     // Starting from day $startday, the sign is the direction
2606
2607     if($startday < 1) {
2608
2609         $startday = abs($startday);
2610         $lastmonthweekday  = strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year));
2611
2612         // This is the last such weekday of the month
2613         $lastinmonth = $daysinmonth + $weekday - $lastmonthweekday;
2614         if($lastinmonth > $daysinmonth) {
2615             $lastinmonth -= 7;
2616         }
2617
2618         // Find the first such weekday <= $startday
2619         while($lastinmonth > $startday) {
2620             $lastinmonth -= 7;
2621         }
2622
2623         return $lastinmonth;
2624
2625     }
2626     else {
2627
2628         $indexweekday = strftime('%w', mktime(12, 0, 0, $month, $startday, $year));
2629
2630         $diff = $weekday - $indexweekday;
2631         if($diff < 0) {
2632             $diff += 7;
2633         }
2634
2635         // This is the first such weekday of the month equal to or after $startday
2636         $firstfromindex = $startday + $diff;
2637
2638         return $firstfromindex;
2639
2640     }
2641 }
2642
2643 /**
2644  * Calculate the number of days in a given month
2645  *
2646  * @package core
2647  * @category time
2648  * @param int $month The month whose day count is sought
2649  * @param int $year The year of the month whose day count is sought
2650  * @return int
2651  */
2652 function days_in_month($month, $year) {
2653    return intval(date('t', mktime(12, 0, 0, $month, 1, $year)));
2654 }
2655
2656 /**
2657  * Calculate the position in the week of a specific calendar day
2658  *
2659  * @package core
2660  * @category time
2661  * @param int $day The day of the date whose position in the week is sought
2662  * @param int $month The month of the date whose position in the week is sought
2663  * @param int $year The year of the date whose position in the week is sought
2664  * @return int
2665  */
2666 function dayofweek($day, $month, $year) {
2667     // I wonder if this is any different from
2668     // strftime('%w', mktime(12, 0, 0, $month, $daysinmonth, $year, 0));
2669     return intval(date('w', mktime(12, 0, 0, $month, $day, $year)));
2670 }
2671
2672 /// USER AUTHENTICATION AND LOGIN ////////////////////////////////////////
2673
2674 /**
2675  * Returns full login url.
2676  *
2677  * @return string login url
2678  */
2679 function get_login_url() {
2680     global $CFG;
2681
2682     $url = "$CFG->wwwroot/login/index.php";
2683
2684     if (!empty($CFG->loginhttps)) {
2685         $url = str_replace('http:', 'https:', $url);
2686     }
2687
2688     return $url;
2689 }
2690
2691 /**
2692  * This function checks that the current user is logged in and has the
2693  * required privileges
2694  *
2695  * This function checks that the current user is logged in, and optionally
2696  * whether they are allowed to be in a particular course and view a particular
2697  * course module.
2698  * If they are not logged in, then it redirects them to the site login unless
2699  * $autologinguest is set and {@link $CFG}->autologinguests is set to 1 in which
2700  * case they are automatically logged in as guests.
2701  * If $courseid is given and the user is not enrolled in that course then the
2702  * user is redirected to the course enrolment page.
2703  * If $cm is given and the course module is hidden and the user is not a teacher
2704  * in the course then the user is redirected to the course home page.
2705  *
2706  * When $cm parameter specified, this function sets page layout to 'module'.
2707  * You need to change it manually later if some other layout needed.
2708  *
2709  * @package    core_access
2710  * @category   access
2711  *
2712  * @param mixed $courseorid id of the course or course object
2713  * @param bool $autologinguest default true
2714  * @param object $cm course module object
2715  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
2716  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
2717  *             in order to keep redirects working properly. MDL-14495
2718  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
2719  * @return mixed Void, exit, and die depending on path
2720  */
2721 function require_login($courseorid = NULL, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
2722     global $CFG, $SESSION, $USER, $PAGE, $SITE, $DB, $OUTPUT;
2723
2724     // setup global $COURSE, themes, language and locale
2725     if (!empty($courseorid)) {
2726         if (is_object($courseorid)) {
2727             $course = $courseorid;
2728         } else if ($courseorid == SITEID) {
2729             $course = clone($SITE);
2730         } else {
2731             $course = $DB->get_record('course', array('id' => $courseorid), '*', MUST_EXIST);
2732         }
2733         if ($cm) {
2734             if ($cm->course != $course->id) {
2735                 throw new coding_exception('course and cm parameters in require_login() call do not match!!');
2736             }
2737             // make sure we have a $cm from get_fast_modinfo as this contains activity access details
2738             if (!($cm instanceof cm_info)) {
2739                 // note: nearly all pages call get_fast_modinfo anyway and it does not make any
2740                 // db queries so this is not really a performance concern, however it is obviously
2741                 // better if you use get_fast_modinfo to get the cm before calling this.
2742                 $modinfo = get_fast_modinfo($course);
2743                 $cm = $modinfo->get_cm($cm->id);
2744             }
2745             $PAGE->set_cm($cm, $course); // set's up global $COURSE
2746             $PAGE->set_pagelayout('incourse');
2747         } else {
2748             $PAGE->set_course($course); // set's up global $COURSE
2749         }
2750     } else {
2751         // do not touch global $COURSE via $PAGE->set_course(),
2752         // the reasons is we need to be able to call require_login() at any time!!
2753         $course = $SITE;
2754         if ($cm) {
2755             throw new coding_exception('cm parameter in require_login() requires valid course parameter!');
2756         }
2757     }
2758
2759     // If this is an AJAX request and $setwantsurltome is true then we need to override it and set it to false.
2760     // Otherwise the AJAX request URL will be set to $SESSION->wantsurl and events such as self enrolment in the future
2761     // risk leading the user back to the AJAX request URL.
2762     if ($setwantsurltome && defined('AJAX_SCRIPT') && AJAX_SCRIPT) {
2763         $setwantsurltome = false;
2764     }
2765
2766     // If the user is not even logged in yet then make sure they are
2767     if (!isloggedin()) {
2768         if ($autologinguest and !empty($CFG->guestloginbutton) and !empty($CFG->autologinguests)) {
2769             if (!$guest = get_complete_user_data('id', $CFG->siteguest)) {
2770                 // misconfigured site guest, just redirect to login page
2771                 redirect(get_login_url());
2772                 exit; // never reached
2773             }
2774             $lang = isset($SESSION->lang) ? $SESSION->lang : $CFG->lang;
2775             complete_user_login($guest);
2776             $USER->autologinguest = true;
2777             $SESSION->lang = $lang;
2778         } else {
2779             //NOTE: $USER->site check was obsoleted by session test cookie,
2780             //      $USER->confirmed test is in login/index.php
2781             if ($preventredirect) {
2782                 throw new require_login_exception('You are not logged in');
2783             }
2784
2785             if ($setwantsurltome) {
2786                 $SESSION->wantsurl = qualified_me();
2787             }
2788             if (!empty($_SERVER['HTTP_REFERER'])) {
2789                 $SESSION->fromurl  = $_SERVER['HTTP_REFERER'];
2790             }
2791             redirect(get_login_url());
2792             exit; // never reached
2793         }
2794     }
2795
2796     // loginas as redirection if needed
2797     if ($course->id != SITEID and session_is_loggedinas()) {
2798         if ($USER->loginascontext->contextlevel == CONTEXT_COURSE) {
2799             if ($USER->loginascontext->instanceid != $course->id) {
2800                 print_error('loginasonecourse', '', $CFG->wwwroot.'/course/view.php?id='.$USER->loginascontext->instanceid);
2801             }
2802         }
2803     }
2804
2805     // check whether the user should be changing password (but only if it is REALLY them)
2806     if (get_user_preferences('auth_forcepasswordchange') && !session_is_loggedinas()) {
2807         $userauth = get_auth_plugin($USER->auth);
2808         if ($userauth->can_change_password() and !$preventredirect) {
2809             if ($setwantsurltome) {
2810                 $SESSION->wantsurl = qualified_me();
2811             }
2812             if ($changeurl = $userauth->change_password_url()) {
2813                 //use plugin custom url
2814                 redirect($changeurl);
2815             } else {
2816                 //use moodle internal method
2817                 if (empty($CFG->loginhttps)) {
2818                     redirect($CFG->wwwroot .'/login/change_password.php');
2819                 } else {
2820                     $wwwroot = str_replace('http:','https:', $CFG->wwwroot);
2821                     redirect($wwwroot .'/login/change_password.php');
2822                 }
2823             }
2824         } else {
2825             print_error('nopasswordchangeforced', 'auth');
2826         }
2827     }
2828
2829     // Check that the user account is properly set up
2830     if (user_not_fully_set_up($USER)) {
2831         if ($preventredirect) {
2832             throw new require_login_exception('User not fully set-up');
2833         }
2834         if ($setwantsurltome) {
2835             $SESSION->wantsurl = qualified_me();
2836         }
2837         redirect($CFG->wwwroot .'/user/edit.php?id='. $USER->id .'&amp;course='. SITEID);
2838     }
2839
2840     // Make sure the USER has a sesskey set up. Used for CSRF protection.
2841     sesskey();
2842
2843     // Do not bother admins with any formalities
2844     if (is_siteadmin()) {
2845         //set accesstime or the user will appear offline which messes up messaging
2846         user_accesstime_log($course->id);
2847         return;
2848     }
2849
2850     // Check that the user has agreed to a site policy if there is one - do not test in case of admins
2851     if (!$USER->policyagreed and !is_siteadmin()) {
2852         if (!empty($CFG->sitepolicy) and !isguestuser()) {
2853             if ($preventredirect) {
2854                 throw new require_login_exception('Policy not agreed');
2855             }
2856             if ($setwantsurltome) {
2857                 $SESSION->wantsurl = qualified_me();
2858             }
2859             redirect($CFG->wwwroot .'/user/policy.php');
2860         } else if (!empty($CFG->sitepolicyguest) and isguestuser()) {
2861             if ($preventredirect) {
2862                 throw new require_login_exception('Policy not agreed');
2863             }
2864             if ($setwantsurltome) {
2865                 $SESSION->wantsurl = qualified_me();
2866             }
2867             redirect($CFG->wwwroot .'/user/policy.php');
2868         }
2869     }
2870
2871     // Fetch the system context, the course context, and prefetch its child contexts
2872     $sysctx = get_context_instance(CONTEXT_SYSTEM);
2873     $coursecontext = get_context_instance(CONTEXT_COURSE, $course->id, MUST_EXIST);
2874     if ($cm) {
2875         $cmcontext = get_context_instance(CONTEXT_MODULE, $cm->id, MUST_EXIST);
2876     } else {
2877         $cmcontext = null;
2878     }
2879
2880     // If the site is currently under maintenance, then print a message
2881     if (!empty($CFG->maintenance_enabled) and !has_capability('moodle/site:config', $sysctx)) {
2882         if ($preventredirect) {
2883             throw new require_login_exception('Maintenance in progress');
2884         }
2885
2886         print_maintenance_message();
2887     }
2888
2889     // make sure the course itself is not hidden
2890     if ($course->id == SITEID) {
2891         // frontpage can not be hidden
2892     } else {
2893         if (is_role_switched($course->id)) {
2894             // when switching roles ignore the hidden flag - user had to be in course to do the switch
2895         } else {
2896             if (!$course->visible and !has_capability('moodle/course:viewhiddencourses', $coursecontext)) {
2897                 // originally there was also test of parent category visibility,
2898                 // BUT is was very slow in complex queries involving "my courses"
2899                 // now it is also possible to simply hide all courses user is not enrolled in :-)
2900                 if ($preventredirect) {
2901                     throw new require_login_exception('Course is hidden');
2902                 }
2903                 // We need to override the navigation URL as the course won't have
2904                 // been added to the navigation and thus the navigation will mess up
2905                 // when trying to find it.
2906                 navigation_node::override_active_url(new moodle_url('/'));
2907                 notice(get_string('coursehidden'), $CFG->wwwroot .'/');
2908             }
2909         }
2910     }
2911
2912     // is the user enrolled?
2913     if ($course->id == SITEID) {
2914         // everybody is enrolled on the frontpage
2915
2916     } else {
2917         if (session_is_loggedinas()) {
2918             // Make sure the REAL person can access this course first
2919             $realuser = session_get_realuser();
2920             if (!is_enrolled($coursecontext, $realuser->id, '', true) and !is_viewing($coursecontext, $realuser->id) and !is_siteadmin($realuser->id)) {
2921                 if ($preventredirect) {
2922                     throw new require_login_exception('Invalid course login-as access');
2923                 }
2924                 echo $OUTPUT->header();
2925                 notice(get_string('studentnotallowed', '', fullname($USER, true)), $CFG->wwwroot .'/');
2926             }
2927         }
2928
2929         $access = false;
2930
2931         if (is_role_switched($course->id)) {
2932             // ok, user had to be inside this course before the switch
2933             $access = true;
2934
2935         } else if (is_viewing($coursecontext, $USER)) {
2936             // ok, no need to mess with enrol
2937             $access = true;
2938
2939         } else {
2940             if (isset($USER->enrol['enrolled'][$course->id])) {
2941                 if ($USER->enrol['enrolled'][$course->id] > time()) {
2942                     $access = true;
2943                     if (isset($USER->enrol['tempguest'][$course->id])) {
2944                         unset($USER->enrol['tempguest'][$course->id]);
2945                         remove_temp_course_roles($coursecontext);
2946                     }
2947                 } else {
2948                     //expired
2949                     unset($USER->enrol['enrolled'][$course->id]);
2950                 }
2951             }
2952             if (isset($USER->enrol['tempguest'][$course->id])) {
2953                 if ($USER->enrol['tempguest'][$course->id] == 0) {
2954                     $access = true;
2955                 } else if ($USER->enrol['tempguest'][$course->id] > time()) {
2956                     $access = true;
2957                 } else {
2958                     //expired
2959                     unset($USER->enrol['tempguest'][$course->id]);
2960                     remove_temp_course_roles($coursecontext);
2961                 }
2962             }
2963
2964             if ($access) {
2965                 // cache ok
2966             } else {
2967                 $until = enrol_get_enrolment_end($coursecontext->instanceid, $USER->id);
2968                 if ($until !== false) {
2969                     // active participants may always access, a timestamp in the future, 0 (always) or false.
2970                     if ($until == 0) {
2971                         $until = ENROL_MAX_TIMESTAMP;
2972                     }
2973                     $USER->enrol['enrolled'][$course->id] = $until;
2974                     $access = true;
2975
2976                 } else {
2977                     $instances = $DB->get_records('enrol', array('courseid'=>$course->id, 'status'=>ENROL_INSTANCE_ENABLED), 'sortorder, id ASC');
2978                     $enrols = enrol_get_plugins(true);
2979                     // first ask all enabled enrol instances in course if they want to auto enrol user
2980                     foreach($instances as $instance) {
2981                         if (!isset($enrols[$instance->enrol])) {
2982                             continue;
2983                         }
2984                         // Get a duration for the enrolment, a timestamp in the future, 0 (always) or false.
2985                         $until = $enrols[$instance->enrol]->try_autoenrol($instance);
2986                         if ($until !== false) {
2987                             if ($until == 0) {
2988                                 $until = ENROL_MAX_TIMESTAMP;
2989                             }
2990                             $USER->enrol['enrolled'][$course->id] = $until;
2991                             $access = true;
2992                             break;
2993                         }
2994                     }
2995                     // if not enrolled yet try to gain temporary guest access
2996                     if (!$access) {
2997                         foreach($instances as $instance) {
2998                             if (!isset($enrols[$instance->enrol])) {
2999                                 continue;
3000                             }
3001                             // Get a duration for the guest access, a timestamp in the future or false.
3002                             $until = $enrols[$instance->enrol]->try_guestaccess($instance);
3003                             if ($until !== false and $until > time()) {
3004                                 $USER->enrol['tempguest'][$course->id] = $until;
3005                                 $access = true;
3006                                 break;
3007                             }
3008                         }
3009                     }
3010                 }
3011             }
3012         }
3013
3014         if (!$access) {
3015             if ($preventredirect) {
3016                 throw new require_login_exception('Not enrolled');
3017             }
3018             if ($setwantsurltome) {
3019                 $SESSION->wantsurl = qualified_me();
3020             }
3021             redirect($CFG->wwwroot .'/enrol/index.php?id='. $course->id);
3022         }
3023     }
3024
3025     // Check visibility of activity to current user; includes visible flag, groupmembersonly,
3026     // conditional availability, etc
3027     if ($cm && !$cm->uservisible) {
3028         if ($preventredirect) {
3029             throw new require_login_exception('Activity is hidden');
3030         }
3031         redirect($CFG->wwwroot, get_string('activityiscurrentlyhidden'));
3032     }
3033
3034     // Finally access granted, update lastaccess times
3035     user_accesstime_log($course->id);
3036 }
3037
3038
3039 /**
3040  * This function just makes sure a user is logged out.
3041  *
3042  * @package    core_access
3043  */
3044 function require_logout() {
3045     global $USER;
3046
3047     $params = $USER;
3048
3049     if (isloggedin()) {
3050         add_to_log(SITEID, "user", "logout", "view.php?id=$USER->id&course=".SITEID, $USER->id, 0, $USER->id);
3051
3052         $authsequence = get_enabled_auth_plugins(); // auths, in sequence
3053         foreach($authsequence as $authname) {
3054             $authplugin = get_auth_plugin($authname);
3055             $authplugin->prelogout_hook();
3056         }
3057     }
3058
3059     events_trigger('user_logout', $params);
3060     session_get_instance()->terminate_current();
3061     unset($params);
3062 }
3063
3064 /**
3065  * Weaker version of require_login()
3066  *
3067  * This is a weaker version of {@link require_login()} which only requires login
3068  * when called from within a course rather than the site page, unless
3069  * the forcelogin option is turned on.
3070  * @see require_login()
3071  *
3072  * @package    core_access
3073  * @category   access
3074  *
3075  * @param mixed $courseorid The course object or id in question
3076  * @param bool $autologinguest Allow autologin guests if that is wanted
3077  * @param object $cm Course activity module if known
3078  * @param bool $setwantsurltome Define if we want to set $SESSION->wantsurl, defaults to
3079  *             true. Used to avoid (=false) some scripts (file.php...) to set that variable,
3080  *             in order to keep redirects working properly. MDL-14495
3081  * @param bool $preventredirect set to true in scripts that can not redirect (CLI, rss feeds, etc.), throws exceptions
3082  * @return void
3083  */
3084 function require_course_login($courseorid, $autologinguest = true, $cm = NULL, $setwantsurltome = true, $preventredirect = false) {
3085     global $CFG, $PAGE, $SITE;
3086     $issite = (is_object($courseorid) and $courseorid->id == SITEID)
3087           or (!is_object($courseorid) and $courseorid == SITEID);
3088     if ($issite && !empty($cm) && !($cm instanceof cm_info)) {
3089         // note: nearly all pages call get_fast_modinfo anyway and it does not make any
3090         // db queries so this is not really a performance concern, however it is obviously
3091         // better if you use get_fast_modinfo to get the cm before calling this.
3092         if (is_object($courseorid)) {
3093             $course = $courseorid;
3094         } else {
3095             $course = clone($SITE);
3096         }
3097         $modinfo = get_fast_modinfo($course);
3098         $cm = $modinfo->get_cm($cm->id);
3099     }
3100     if (!empty($CFG->forcelogin)) {
3101         // login required for both SITE and courses
3102         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3103
3104     } else if ($issite && !empty($cm) and !$cm->uservisible) {
3105         // always login for hidden activities
3106         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3107
3108     } else if ($issite) {
3109               //login for SITE not required
3110         if ($cm and empty($cm->visible)) {
3111             // hidden activities are not accessible without login
3112             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3113         } else if ($cm and !empty($CFG->enablegroupmembersonly) and $cm->groupmembersonly) {
3114             // not-logged-in users do not have any group membership
3115             require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3116         } else {
3117             // We still need to instatiate PAGE vars properly so that things
3118             // that rely on it like navigation function correctly.
3119             if (!empty($courseorid)) {
3120                 if (is_object($courseorid)) {
3121                     $course = $courseorid;
3122                 } else {
3123                     $course = clone($SITE);
3124                 }
3125                 if ($cm) {
3126                     if ($cm->course != $course->id) {
3127                         throw new coding_exception('course and cm parameters in require_course_login() call do not match!!');
3128                     }
3129                     $PAGE->set_cm($cm, $course);
3130                     $PAGE->set_pagelayout('incourse');
3131                 } else {
3132                     $PAGE->set_course($course);
3133                 }
3134             } else {
3135                 // If $PAGE->course, and hence $PAGE->context, have not already been set
3136                 // up properly, set them up now.
3137                 $PAGE->set_course($PAGE->course);
3138             }
3139             //TODO: verify conditional activities here
3140             user_accesstime_log(SITEID);
3141             return;
3142         }
3143
3144     } else {
3145         // course login always required
3146         require_login($courseorid, $autologinguest, $cm, $setwantsurltome, $preventredirect);
3147     }
3148 }
3149
3150 /**
3151  * Require key login. Function terminates with error if key not found or incorrect.
3152  *
3153  * @global object
3154  * @global object
3155  * @global object
3156  * @global object
3157  * @uses NO_MOODLE_COOKIES
3158  * @uses PARAM_ALPHANUM
3159  * @param string $script unique script identifier
3160  * @param int $instance optional instance id
3161  * @return int Instance ID
3162  */
3163 function require_user_key_login($script, $instance=null) {
3164     global $USER, $SESSION, $CFG, $DB;
3165
3166     if (!NO_MOODLE_COOKIES) {
3167         print_error('sessioncookiesdisable');
3168     }
3169
3170 /// extra safety
3171     @session_write_close();
3172
3173     $keyvalue = required_param('key', PARAM_ALPHANUM);
3174
3175     if (!$key = $DB->get_record('user_private_key', array('script'=>$script, 'value'=>$keyvalue, 'instance'=>$instance))) {
3176         print_error('invalidkey');
3177     }
3178
3179     if (!empty($key->validuntil) and $key->validuntil < time()) {
3180         print_error('expiredkey');
3181     }
3182
3183     if ($key->iprestriction) {
3184         $remoteaddr = getremoteaddr(null);
3185         if (empty($remoteaddr) or !address_in_subnet($remoteaddr, $key->iprestriction)) {
3186             print_error('ipmismatch');
3187         }
3188     }
3189
3190     if (!$user = $DB->get_record('user', array('id'=>$key->userid))) {
3191         print_error('invaliduserid');
3192     }
3193
3194 /// emulate normal session
3195     enrol_check_plugins($user);
3196     session_set_user($user);
3197
3198 /// note we are not using normal login
3199     if (!defined('USER_KEY_LOGIN')) {
3200         define('USER_KEY_LOGIN', true);
3201     }
3202
3203 /// return instance id - it might be empty
3204     return $key->instance;
3205 }
3206
3207 /**
3208  * Creates a new private user access key.
3209  *
3210  * @global object
3211  * @param string $script unique target identifier
3212  * @param int $userid
3213  * @param int $instance optional instance id
3214  * @param string $iprestriction optional ip restricted access
3215  * @param timestamp $validuntil key valid only until given data
3216  * @return string access key value
3217  */
3218 function create_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3219     global $DB;
3220
3221     $key = new stdClass();
3222     $key->script        = $script;
3223     $key->userid        = $userid;
3224     $key->instance      = $instance;
3225     $key->iprestriction = $iprestriction;
3226     $key->validuntil    = $validuntil;
3227     $key->timecreated   = time();
3228
3229     $key->value         = md5($userid.'_'.time().random_string(40)); // something long and unique
3230     while ($DB->record_exists('user_private_key', array('value'=>$key->value))) {
3231         // must be unique
3232         $key->value     = md5($userid.'_'.time().random_string(40));
3233     }
3234     $DB->insert_record('user_private_key', $key);
3235     return $key->value;
3236 }
3237
3238 /**
3239  * Delete the user's new private user access keys for a particular script.
3240  *
3241  * @global object
3242  * @param string $script unique target identifier
3243  * @param int $userid
3244  * @return void
3245  */
3246 function delete_user_key($script,$userid) {
3247     global $DB;
3248     $DB->delete_records('user_private_key', array('script'=>$script, 'userid'=>$userid));
3249 }
3250
3251 /**
3252  * Gets a private user access key (and creates one if one doesn't exist).
3253  *
3254  * @global object
3255  * @param string $script unique target identifier
3256  * @param int $userid
3257  * @param int $instance optional instance id
3258  * @param string $iprestriction optional ip restricted access
3259  * @param timestamp $validuntil key valid only until given data
3260  * @return string access key value
3261  */
3262 function get_user_key($script, $userid, $instance=null, $iprestriction=null, $validuntil=null) {
3263     global $DB;
3264
3265     if ($key = $DB->get_record('user_private_key', array('script'=>$script, 'userid'=>$userid,
3266                                                          'instance'=>$instance, 'iprestriction'=>$iprestriction,
3267                                                          'validuntil'=>$validuntil))) {
3268         return $key->value;
3269     } else {
3270         return create_user_key($script, $userid, $instance, $iprestriction, $validuntil);
3271     }
3272 }
3273
3274
3275 /**
3276  * Modify the user table by setting the currently logged in user's
3277  * last login to now.
3278  *
3279  * @global object
3280  * @global object
3281  * @return bool Always returns true
3282  */
3283 function update_user_login_times() {
3284     global $USER, $DB;
3285
3286     $user = new stdClass();
3287     $USER->lastlogin = $user->lastlogin = $USER->currentlogin;
3288     $USER->currentlogin = $user->lastaccess = $user->currentlogin = time();
3289
3290     $user->id = $USER->id;
3291
3292     $DB->update_record('user', $user);
3293     return true;
3294 }
3295
3296 /**
3297  * Determines if a user has completed setting up their account.
3298  *
3299  * @param user $user A {@link $USER} object to test for the existence of a valid name and email
3300  * @return bool
3301  */
3302 function user_not_fully_set_up($user) {
3303     if (isguestuser($user)) {
3304         return false;
3305     }
3306     return (empty($user->firstname) or empty($user->lastname) or empty($user->email) or over_bounce_threshold($user));
3307 }
3308
3309 /**
3310  * Check whether the user has exceeded the bounce threshold
3311  *
3312  * @global object
3313  * @global object
3314  * @param user $user A {@link $USER} object
3315  * @return bool true=>User has exceeded bounce threshold
3316  */
3317 function over_bounce_threshold($user) {
3318     global $CFG, $DB;
3319
3320     if (empty($CFG->handlebounces)) {
3321         return false;
3322     }
3323
3324     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3325         return false;
3326     }
3327
3328     // set sensible defaults
3329     if (empty($CFG->minbounces)) {
3330         $CFG->minbounces = 10;
3331     }
3332     if (empty($CFG->bounceratio)) {
3333         $CFG->bounceratio = .20;
3334     }
3335     $bouncecount = 0;
3336     $sendcount = 0;
3337     if ($bounce = $DB->get_record('user_preferences', array ('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3338         $bouncecount = $bounce->value;
3339     }
3340     if ($send = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3341         $sendcount = $send->value;
3342     }
3343     return ($bouncecount >= $CFG->minbounces && $bouncecount/$sendcount >= $CFG->bounceratio);
3344 }
3345
3346 /**
3347  * Used to increment or reset email sent count
3348  *
3349  * @global object
3350  * @param user $user object containing an id
3351  * @param bool $reset will reset the count to 0
3352  * @return void
3353  */
3354 function set_send_count($user,$reset=false) {
3355     global $DB;
3356
3357     if (empty($user->id)) { /// No real (DB) user, nothing to do here.
3358         return;
3359     }
3360
3361     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_send_count'))) {
3362         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3363         $DB->update_record('user_preferences', $pref);
3364     }
3365     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3366         // make a new one
3367         $pref = new stdClass();
3368         $pref->name   = 'email_send_count';
3369         $pref->value  = 1;
3370         $pref->userid = $user->id;
3371         $DB->insert_record('user_preferences', $pref, false);
3372     }
3373 }
3374
3375 /**
3376  * Increment or reset user's email bounce count
3377  *
3378  * @global object
3379  * @param user $user object containing an id
3380  * @param bool $reset will reset the count to 0
3381  */
3382 function set_bounce_count($user,$reset=false) {
3383     global $DB;
3384
3385     if ($pref = $DB->get_record('user_preferences', array('userid'=>$user->id, 'name'=>'email_bounce_count'))) {
3386         $pref->value = (!empty($reset)) ? 0 : $pref->value+1;
3387         $DB->update_record('user_preferences', $pref);
3388     }
3389     else if (!empty($reset)) { // if it's not there and we're resetting, don't bother.
3390         // make a new one
3391         $pref = new stdClass();
3392         $pref->name   = 'email_bounce_count';
3393         $pref->value  = 1;
3394         $pref->userid = $user->id;
3395         $DB->insert_record('user_preferences', $pref, false);
3396     }
3397 }
3398
3399 /**
3400  * Keeps track of login attempts
3401  *
3402  * @global object
3403  */
3404 function update_login_count() {
3405     global $SESSION;
3406
3407     $max_logins = 10;
3408
3409     if (empty($SESSION->logincount)) {
3410         $SESSION->logincount = 1;
3411     } else {
3412         $SESSION->logincount++;
3413     }
3414
3415     if ($SESSION->logincount > $max_logins) {
3416         unset($SESSION->wantsurl);
3417         print_error('errortoomanylogins');
3418     }
3419 }
3420
3421 /**
3422  * Resets login attempts
3423  *
3424  * @global object
3425  */
3426 function reset_login_count() {
3427     global $SESSION;
3428
3429     $SESSION->logincount = 0;
3430 }
3431
3432 /**
3433  * Determines if the currently logged in user is in editing mode.
3434  * Note: originally this function had $userid parameter - it was not usable anyway
3435  *
3436  * @deprecated since Moodle 2.0 - use $PAGE->user_is_editing() instead.
3437  * @todo Deprecated function remove when ready
3438  *
3439  * @global object
3440  * @uses DEBUG_DEVELOPER
3441  * @return bool
3442  */
3443 function isediting() {
3444     global $PAGE;
3445     debugging('call to deprecated function isediting(). Please use $PAGE->user_is_editing() instead', DEBUG_DEVELOPER);
3446     return $PAGE->user_is_editing();
3447 }
3448
3449 /**
3450  * Determines if the logged in user is currently moving an activity
3451  *
3452  * @global object
3453  * @param int $courseid The id of the course being tested
3454  * @return bool
3455  */
3456 function ismoving($courseid) {
3457     global $USER;
3458
3459     if (!empty($USER->activitycopy)) {
3460         return ($USER->activitycopycourse == $courseid);
3461     }
3462     return false;
3463 }
3464
3465 /**
3466  * Returns a persons full name
3467  *
3468  * Given an object containing firstname and lastname
3469  * values, this function returns a string with the
3470  * full name of the person.
3471  * The result may depend on system settings
3472  * or language.  'override' will force both names
3473  * to be used even if system settings specify one.
3474  *
3475  * @global object
3476  * @global object
3477  * @param object $user A {@link $USER} object to get full name of
3478  * @param bool $override If true then the name will be first name followed by last name rather than adhering to fullnamedisplay setting.
3479  * @return string
3480  */
3481 function fullname($user, $override=false) {
3482     global $CFG, $SESSION;
3483
3484     if (!isset($user->firstname) and !isset($user->lastname)) {
3485         return '';
3486     }
3487
3488     if (!$override) {
3489         if (!empty($CFG->forcefirstname)) {
3490             $user->firstname = $CFG->forcefirstname;
3491         }
3492         if (!empty($CFG->forcelastname)) {
3493             $user->lastname = $CFG->forcelastname;
3494         }
3495     }
3496
3497     if (!empty($SESSION->fullnamedisplay)) {
3498         $CFG->fullnamedisplay = $SESSION->fullnamedisplay;
3499     }
3500
3501     if (!isset($CFG->fullnamedisplay) or $CFG->fullnamedisplay === 'firstname lastname') {
3502         return $user->firstname .' '. $user->lastname;
3503
3504     } else if ($CFG->fullnamedisplay == 'lastname firstname') {
3505         return $user->lastname .' '. $user->firstname;
3506
3507     } else if ($CFG->fullnamedisplay == 'firstname') {
3508         if ($override) {
3509             return get_string('fullnamedisplay', '', $user);
3510         } else {
3511             return $user->firstname;
3512         }
3513     }
3514
3515     return get_string('fullnamedisplay', '', $user);
3516 }
3517
3518 /**
3519  * Checks if current user is shown any extra fields when listing users.
3520  * @param object $context Context
3521  * @param array $already Array of fields that we're going to show anyway
3522  *   so don't bother listing them
3523  * @return array Array of field names from user table, not including anything
3524  *   listed in $already
3525  */
3526 function get_extra_user_fields($context, $already = array()) {
3527     global $CFG;
3528
3529     // Only users with permission get the extra fields
3530     if (!has_capability('moodle/site:viewuseridentity', $context)) {
3531         return array();
3532     }
3533
3534     // Split showuseridentity on comma
3535     if (empty($CFG->showuseridentity)) {
3536         // Explode gives wrong result with empty string
3537         $extra = array();
3538     } else {
3539         $extra =  explode(',', $CFG->showuseridentity);
3540     }
3541     $renumber = false;
3542     foreach ($extra as $key => $field) {
3543         if (in_array($field, $already)) {
3544             unset($extra[$key]);
3545             $renumber = true;
3546         }
3547     }
3548     if ($renumber) {
3549         // For consistency, if entries are removed from array, renumber it
3550         // so they are numbered as you would expect
3551         $extra = array_merge($extra);
3552     }
3553     return $extra;
3554 }
3555
3556 /**
3557  * If the current user is to be shown extra user fields when listing or
3558  * selecting users, returns a string suitable for including in an SQL select
3559  * clause to retrieve those fields.
3560  * @param object $context Context
3561  * @param string $alias Alias of user table, e.g. 'u' (default none)
3562  * @param string $prefix Prefix for field names using AS, e.g. 'u_' (default none)
3563  * @param array $already Array of fields that we're going to include anyway
3564  *   so don't list them (default none)
3565  * @return string Partial SQL select clause, beginning with comma, for example
3566  *   ',u.idnumber,u.department' unless it is blank
3567  */
3568 function get_extra_user_fields_sql($context, $alias='', $prefix='',
3569         $already = array()) {
3570     $fields = get_extra_user_fields($context, $already);
3571     $result = '';
3572     // Add punctuation for alias
3573     if ($alias !== '') {
3574         $alias .= '.';
3575     }
3576     foreach ($fields as $field) {
3577         $result .= ', ' . $alias . $field;
3578         if ($prefix) {
3579             $result .= ' AS ' . $prefix . $field;
3580         }
3581     }
3582     return $result;
3583 }
3584
3585 /**
3586  * Returns the display name of a field in the user table. Works for most fields
3587  * that are commonly displayed to users.
3588  * @param string $field Field name, e.g. 'phone1'
3589  * @return string Text description taken from language file, e.g. 'Phone number'
3590  */
3591 function get_user_field_name($field) {
3592     // Some fields have language strings which are not the same as field name
3593     switch ($field) {
3594         case 'phone1' : return get_string('phone');
3595     }
3596     // Otherwise just use the same lang string
3597     return get_string($field);
3598 }
3599
3600 /**
3601  * Returns whether a given authentication plugin exists.
3602  *
3603  * @global object
3604  * @param string $auth Form of authentication to check for. Defaults to the
3605  *        global setting in {@link $CFG}.
3606  * @return boolean Whether the plugin is available.
3607  */
3608 function exists_auth_plugin($auth) {
3609     global $CFG;
3610
3611     if (file_exists("{$CFG->dirroot}/auth/$auth/auth.php")) {
3612         return is_readable("{$CFG->dirroot}/auth/$auth/auth.php");
3613     }
3614     return false;
3615 }
3616
3617 /**
3618  * Checks if a given plugin is in the list of enabled authentication plugins.
3619  *
3620  * @param string $auth Authentication plugin.
3621  * @return boolean Whether the plugin is enabled.
3622  */
3623 function is_enabled_auth($auth) {
3624     if (empty($auth)) {
3625         return false;
3626     }
3627
3628     $enabled = get_enabled_auth_plugins();
3629
3630     return in_array($auth, $enabled);
3631 }
3632
3633 /**
3634  * Returns an authentication plugin instance.
3635  *
3636  * @global object
3637  * @param string $auth name of authentication plugin
3638  * @return auth_plugin_base An instance of the required authentication plugin.
3639  */
3640 function get_auth_plugin($auth) {
3641     global $CFG;
3642
3643     // check the plugin exists first
3644     if (! exists_auth_plugin($auth)) {
3645         print_error('authpluginnotfound', 'debug', '', $auth);
3646     }
3647
3648     // return auth plugin instance
3649     require_once "{$CFG->dirroot}/auth/$auth/auth.php";
3650     $class = "auth_plugin_$auth";
3651     return new $class;
3652 }
3653
3654 /**
3655  * Returns array of active auth plugins.
3656  *
3657  * @param bool $fix fix $CFG->auth if needed
3658  * @return array
3659  */
3660 function get_enabled_auth_plugins($fix=false) {
3661     global $CFG;
3662
3663     $default = array('manual', 'nologin');
3664
3665     if (empty($CFG->auth)) {
3666         $auths = array();
3667     } else {
3668         $auths = explode(',', $CFG->auth);
3669     }
3670
3671     if ($fix) {
3672         $auths = array_unique($auths);
3673         foreach($auths as $k=>$authname) {
3674             if (!exists_auth_plugin($authname) or in_array($authname, $default)) {
3675                 unset($auths[$k]);
3676             }
3677         }
3678         $newconfig = implode(',', $auths);
3679         if (!isset($CFG->auth) or $newconfig != $CFG->auth) {
3680             set_config('auth', $newconfig);
3681         }
3682     }
3683
3684     return (array_merge($default, $auths));
3685 }
3686
3687 /**
3688  * Returns true if an internal authentication method is being used.
3689  * if method not specified then, global default is assumed
3690  *
3691  * @param string $auth Form of authentication required
3692  * @return bool
3693  */
3694 function is_internal_auth($auth) {
3695     $authplugin = get_auth_plugin($auth); // throws error if bad $auth
3696     return $authplugin->is_internal();
3697 }
3698
3699 /**
3700  * Returns true if the user is a 'restored' one
3701  *
3702  * Used in the login process to inform the user
3703  * and allow him/her to reset the password
3704  *
3705  * @uses $CFG
3706  * @uses $DB
3707  * @param string $username username to be checked
3708  * @return bool
3709  */
3710 function is_restored_user($username) {
3711     global $CFG, $DB;
3712
3713     return $DB->record_exists('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id, 'password'=>'restored'));
3714 }
3715
3716 /**
3717  * Returns an array of user fields
3718  *
3719  * @return array User field/column names
3720  */
3721 function get_user_fieldnames() {
3722     global $DB;
3723
3724     $fieldarray = $DB->get_columns('user');
3725     unset($fieldarray['id']);
3726     $fieldarray = array_keys($fieldarray);
3727
3728     return $fieldarray;
3729 }
3730
3731 /**
3732  * Creates a bare-bones user record
3733  *
3734  * @todo Outline auth types and provide code example
3735  *
3736  * @param string $username New user's username to add to record
3737  * @param string $password New user's password to add to record
3738  * @param string $auth Form of authentication required
3739  * @return stdClass A complete user object
3740  */
3741 function create_user_record($username, $password, $auth = 'manual') {
3742     global $CFG, $DB;
3743
3744     //just in case check text case
3745     $username = trim(textlib::strtolower($username));
3746
3747     $authplugin = get_auth_plugin($auth);
3748
3749     $newuser = new stdClass();
3750
3751     if ($newinfo = $authplugin->get_userinfo($username)) {
3752         $newinfo = truncate_userinfo($newinfo);
3753         foreach ($newinfo as $key => $value){
3754             $newuser->$key = $value;
3755         }
3756     }
3757
3758     if (!empty($newuser->email)) {
3759         if (email_is_not_allowed($newuser->email)) {
3760             unset($newuser->email);
3761         }
3762     }
3763
3764     if (!isset($newuser->city)) {
3765         $newuser->city = '';
3766     }
3767
3768     $newuser->auth = $auth;
3769     $newuser->username = $username;
3770
3771     // fix for MDL-8480
3772     // user CFG lang for user if $newuser->lang is empty
3773     // or $user->lang is not an installed language
3774     if (empty($newuser->lang) || !get_string_manager()->translation_exists($newuser->lang)) {
3775         $newuser->lang = $CFG->lang;
3776     }
3777     $newuser->confirmed = 1;
3778     $newuser->lastip = getremoteaddr();
3779     $newuser->timecreated = time();
3780     $newuser->timemodified = $newuser->timecreated;
3781     $newuser->mnethostid = $CFG->mnet_localhost_id;
3782
3783     $newuser->id = $DB->insert_record('user', $newuser);
3784     $user = get_complete_user_data('id', $newuser->id);
3785     if (!empty($CFG->{'auth_'.$newuser->auth.'_forcechangepassword'})){
3786         set_user_preference('auth_forcepasswordchange', 1, $user);
3787     }
3788     update_internal_user_password($user, $password);
3789
3790     // fetch full user record for the event, the complete user data contains too much info
3791     // and we want to be consistent with other places that trigger this event
3792     events_trigger('user_created', $DB->get_record('user', array('id'=>$user->id)));
3793
3794     return $user;
3795 }
3796
3797 /**
3798  * Will update a local user record from an external source.
3799  * (MNET users can not be updated using this method!)
3800  *
3801  * @param string $username user's username to update the record
3802  * @return stdClass A complete user object
3803  */
3804 function update_user_record($username) {
3805     global $DB, $CFG;
3806
3807     $username = trim(textlib::strtolower($username)); /// just in case check text case
3808
3809     $oldinfo = $DB->get_record('user', array('username'=>$username, 'mnethostid'=>$CFG->mnet_localhost_id), '*', MUST_EXIST);
3810     $newuser = array();
3811     $userauth = get_auth_plugin($oldinfo->auth);
3812
3813     if ($newinfo = $userauth->get_userinfo($username)) {
3814         $newinfo = truncate_userinfo($newinfo);
3815         foreach ($newinfo as $key => $value){
3816             $key = strtolower($key);
3817             if (!property_exists($oldinfo, $key) or $key === 'username' or $key === 'id'
3818                     or $key === 'auth' or $key === 'mnethostid' or $key === 'deleted') {
3819                 // unknown or must not be changed
3820                 continue;
3821             }
3822             $confval = $userauth->config->{'field_updatelocal_' . $key};
3823             $lockval = $userauth->config->{'field_lock_' . $key};
3824             if (empty($confval) || empty($lockval)) {
3825                 continue;
3826             }
3827             if ($confval === 'onlogin') {
3828                 // MDL-4207 Don't overwrite modified user profile values with
3829                 // empty LDAP values when 'unlocked if empty' is set. The purpose
3830                 // of the setting 'unlocked if empty' is to allow the user to fill
3831                 // in a value for the selected field _if LDAP is giving
3832                 // nothing_ for this field. Thus it makes sense to let this value
3833                 // stand in until LDAP is giving a value for this field.
3834                 if (!(empty($value) && $lockval === 'unlockedifempty')) {
3835                     if ((string)$oldinfo->$key !== (string)$value) {
3836                         $newuser[$key] = (string)$value;
3837                     }
3838                 }
3839             }
3840         }
3841         if ($newuser) {
3842             $newuser['id'] = $oldinfo->id;
3843             $newuser['timemodified'] = time();
3844             $DB->update_record('user', $newuser);
3845             // fetch full user record for the event, the complete user data contains too much info
3846             // and we want to be consistent with other places that trigger this event
3847             events_trigger('user_updated', $DB->get_record('user', array('id'=>$oldinfo->id)));
3848         }
3849     }
3850
3851     return get_complete_user_data('id', $oldinfo->id);
3852 }
3853
3854 /**
3855  * Will truncate userinfo as it comes from auth_get_userinfo (from external auth)
3856  * which may have large fields
3857  *
3858  * @todo Add vartype handling to ensure $info is an array
3859  *
3860  * @param array $info Array of user properties to truncate if needed
3861  * @return array The now truncated information that was passed in
3862  */
3863 function truncate_userinfo($info) {
3864     // define the limits
3865     $limit = array(
3866                     'username'    => 100,
3867                     'idnumber'    => 255,
3868                     'firstname'   => 100,
3869                     'lastname'    => 100,
3870                     'email'       => 100,
3871                     'icq'         =>  15,
3872                     'phone1'      =>  20,
3873                     'phone2'      =>  20,
3874                     'institution' =>  40,
3875                     'department'  =>  30,
3876                     'address'     =>  70,
3877                     'city'        => 120,
3878                     'country'     =>   2,
3879                     'url'         => 255,
3880                     );
3881
3882     // apply where needed
3883     foreach (array_keys($info) as $key) {
3884         if (!empty($limit[$key])) {
3885             $info[$key] = trim(textlib::substr($info[$key],0, $limit[$key]));
3886         }
3887     }
3888
3889     return $info;
3890 }
3891
3892 /**
3893  * Marks user deleted in internal user database and notifies the auth plugin.
3894  * Also unenrols user from all roles and does other cleanup.
3895  *
3896  * Any plugin that needs to purge user data should register the 'user_deleted' event.
3897  *
3898  * @param stdClass $user full user object before delete
3899  * @return boolean always true
3900  */
3901 function delete_user($user) {
3902     global $CFG, $DB;
3903     require_once($CFG->libdir.'/grouplib.php');
3904     require_once($CFG->libdir.'/gradelib.php');
3905     require_once($CFG->dirroot.'/message/lib.php');
3906     require_once($CFG->dirroot.'/tag/lib.php');
3907
3908     // delete all grades - backup is kept in grade_grades_history table
3909     grade_user_delete($user->id);
3910
3911     //move unread messages from this user to read
3912     message_move_userfrom_unread2read($user->id);
3913
3914     // TODO: remove from cohorts using standard API here
3915
3916     // remove user tags
3917     tag_set('user', $user->id, array());
3918
3919     // unconditionally unenrol from all courses
3920     enrol_user_delete($user);
3921
3922     // unenrol from all roles in all contexts
3923     role_unassign_all(array('userid'=>$user->id)); // this might be slow but it is really needed - modules might do some extra cleanup!
3924
3925     //now do a brute force cleanup
3926
3927     // remove from all cohorts
3928     $DB->delete_records('cohort_members', array('userid'=>$user->id));
3929
3930     // remove from all groups
3931     $DB->delete_records('groups_members', array('userid'=>$user->id));
3932
3933     // brute force unenrol from all courses
3934     $DB->delete_records('user_enrolments', array('userid'=>$user->id));
3935
3936     // purge user preferences
3937     $DB->delete_records('user_preferences', array('userid'=>$user->id));
3938
3939     // purge user extra profile info
3940     $DB->delete_records('user_info_data', array('userid'=>$user->id));
3941
3942     // last course access not necessary either
3943     $DB->delete_records('user_lastaccess', array('userid'=>$user->id));
3944
3945     // remove all user tokens
3946     $DB->delete_records('external_tokens', array('userid'=>$user->id));
3947
3948     // unauthorise the user for all services
3949     $DB->delete_records('external_services_users', array('userid'=>$user->id));
3950
3951     // force logout - may fail if file based sessions used, sorry
3952     session_kill_user($user->id);
3953
3954     // now do a final accesslib cleanup - removes all role assignments in user context and context itself
3955     delete_context(CONTEXT_USER, $user->id);
3956
3957     // workaround for bulk deletes of users with the same email address
3958     $delname = "$user->email.".time();
3959     while ($DB->record_exists('user', array('username'=>$delname))) { // no need to use mnethostid here
3960         $delname++;
3961     }
3962
3963     // mark internal user record as "deleted"
3964     $updateuser = new stdClass();
3965     $updateuser->id           = $user->id;
3966     $updateuser->deleted      = 1;
3967     $updateuser->username     = $delname;            // Remember it just in case
3968     $updateuser->email        = md5($user->username);// Store hash of username, useful importing/restoring users
3969     $updateuser->idnumber     = '';                  // Clear this field to free it up
3970     $updateuser->picture      = 0;
3971     $updateuser->timemodified = time();
3972
3973     $DB->update_record('user', $updateuser);
3974     // Add this action to log
3975     add_to_log(SITEID, 'user', 'delete', "view.php?id=$user->id", $user->firstname.' '.$user->lastname);
3976
3977
3978     // We will update the user's timemodified, as it will be passed to the user_deleted event, which
3979     // should know about this updated property persisted to the user's table.
3980     $user->timemodified = $updateuser->timemodified;
3981
3982     // notify auth plugin - do not block the delete even when plugin fails
3983     $authplugin = get_auth_plugin($user->auth);
3984     $authplugin->user_delete($user);
3985
3986     // any plugin that needs to cleanup should register this event
3987     events_trigger('user_deleted', $user);
3988
3989     return true;
3990 }
3991
3992 /**
3993  * Retrieve the guest user object
3994  *
3995  * @global object
3996  * @global object
3997  * @return user A {@link $USER} object
3998  */
3999 function guest_user() {
4000     global $CFG, $DB;
4001
4002     if ($newuser = $DB->get_record('user', array('id'=>$CFG->siteguest))) {
4003         $newuser->confirmed = 1;
4004         $newuser->lang = $CFG->lang;
4005         $newuser->lastip = getremoteaddr();
4006     }
4007
4008     return $newuser;
4009 }
4010
4011 /**
4012  * Authenticates a user against the chosen authentication mechanism
4013  *
4014  * Given a username and password, this function looks them
4015  * up using the currently selected authentication mechanism,
4016  * and if the authentication is successful, it returns a
4017  * valid $user object from the 'user' table.
4018  *
4019  * Uses auth_ functions from the currently active auth module
4020  *
4021  * After authenticate_user_login() returns success, you will need to
4022  * log that the user has logged in, and call complete_user_login() to set
4023  * the session up.
4024  *
4025  * Note: this function works only with non-mnet accounts!
4026  *
4027  * @param string $username  User's username
4028  * @param string $password  User's password
4029  * @return user|flase A {@link $USER} object or false if error
4030  */
4031 function authenticate_user_login($username, $password) {
4032     global $CFG, $DB;
4033
4034     $authsenabled = get_enabled_auth_plugins();
4035
4036     if ($user = get_complete_user_data('username', $username, $CFG->mnet_localhost_id)) {
4037         $auth = empty($user->auth) ? 'manual' : $user->auth;  // use manual if auth not set
4038         if (!empty($user->suspended)) {
4039             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4040             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4041             return false;
4042         }
4043         if ($auth=='nologin' or !is_enabled_auth($auth)) {
4044             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4045             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Disabled Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4046             return false;
4047         }
4048         $auths = array($auth);
4049
4050     } else {
4051         // check if there's a deleted record (cheaply)
4052         if ($DB->get_field('user', 'id', array('username'=>$username, 'deleted'=>1))) {
4053             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Deleted Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4054             return false;
4055         }
4056
4057         // User does not exist
4058         $auths = $authsenabled;
4059         $user = new stdClass();
4060         $user->id = 0;
4061     }
4062
4063     foreach ($auths as $auth) {
4064         $authplugin = get_auth_plugin($auth);
4065
4066         // on auth fail fall through to the next plugin
4067         if (!$authplugin->user_login($username, $password)) {
4068             continue;
4069         }
4070
4071         // successful authentication
4072         if ($user->id) {                          // User already exists in database
4073             if (empty($user->auth)) {             // For some reason auth isn't set yet
4074                 $DB->set_field('user', 'auth', $auth, array('username'=>$username));
4075                 $user->auth = $auth;
4076             }
4077             if (empty($user->firstaccess)) { //prevent firstaccess from remaining 0 for manual account that never required confirmation
4078                 $DB->set_field('user','firstaccess', $user->timemodified, array('id' => $user->id));
4079                 $user->firstaccess = $user->timemodified;
4080             }
4081
4082             update_internal_user_password($user, $password); // just in case salt or encoding were changed (magic quotes too one day)
4083
4084             if ($authplugin->is_synchronised_with_external()) { // update user record from external DB
4085                 $user = update_user_record($username);
4086             }
4087         } else {
4088             // if user not found and user creation is not disabled, create it
4089             if (empty($CFG->authpreventaccountcreation)) {
4090                 $user = create_user_record($username, $password, $auth);
4091             } else {
4092                 continue;
4093             }
4094         }
4095
4096         $authplugin->sync_roles($user);
4097
4098         foreach ($authsenabled as $hau) {
4099             $hauth = get_auth_plugin($hau);
4100             $hauth->user_authenticated_hook($user, $username, $password);
4101         }
4102
4103         if (empty($user->id)) {
4104             return false;
4105         }
4106
4107         if (!empty($user->suspended)) {
4108             // just in case some auth plugin suspended account
4109             add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4110             error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Suspended Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4111             return false;
4112         }
4113
4114         return $user;
4115     }
4116
4117     // failed if all the plugins have failed
4118     add_to_log(SITEID, 'login', 'error', 'index.php', $username);
4119     if (debugging('', DEBUG_ALL)) {
4120         error_log('[client '.getremoteaddr()."]  $CFG->wwwroot  Failed Login:  $username  ".$_SERVER['HTTP_USER_AGENT']);
4121     }
4122     return false;
4123 }
4124
4125 /**
4126  * Call to complete the user login process after authenticate_user_login()
4127  * has succeeded. It will setup the $USER variable and other required bits
4128  * and pieces.
4129  *
4130  * NOTE:
4131  * - It will NOT log anything -- up to the caller to decide what to log.
4132  * - this function does not set any cookies any more!
4133  *
4134  * @param object $user
4135  * @return object A {@link $USER} object - BC only, do not use
4136  */
4137 function complete_user_login($user) {
4138     global $CFG, $USER;
4139
4140     // regenerate session id and delete old session,
4141     // this helps prevent session fixation attacks from the same domain
4142     session_regenerate_id(true);
4143
4144     // let enrol plugins deal with new enrolments if necessary
4145     enrol_check_plugins($user);
4146
4147     // check enrolments, load caps and setup $USER object
4148     session_set_user($user);
4149
4150     // reload preferences from DB
4151     unset($USER->preference);
4152     check_user_preferences_loaded($USER);
4153
4154     // update login times
4155     update_user_login_times();
4156
4157     // extra session prefs init
4158     set_login_session_preferences();
4159
4160     if (isguestuser()) {
4161         // no need to continue when user is THE guest
4162         return $USER;
4163     }
4164
4165     /// Select password change url
4166     $userauth = get_auth_plugin($USER->auth);
4167
4168     /// check whether the user should be changing password
4169     if (get_user_preferences('auth_forcepasswordchange', false)){
4170         if ($userauth->can_change_password()) {
4171             if ($changeurl = $userauth->change_password_url()) {
4172                 redirect($changeurl);
4173             } else {
4174                 redirect($CFG->httpswwwroot.'/login/change_password.php');
4175             }
4176         } else {
4177             print_error('nopasswordchangeforced', 'auth');
4178         }
4179     }
4180     return $USER;
4181 }
4182
4183 /**
4184  * Compare password against hash stored in internal user table.
4185  * If necessary it also updates the stored hash to new format.
4186  *
4187  * @param stdClass $user (password property may be updated)
4188  * @param string $password plain text password
4189  * @return bool is password valid?
4190  */
4191 function validate_internal_user_password($user, $password) {
4192     global $CFG;
4193
4194     if (!isset($CFG->passwordsaltmain)) {
4195         $CFG->passwordsaltmain = '';
4196     }
4197
4198     $validated = false;
4199
4200     if ($user->password === 'not cached') {
4201         // internal password is not used at all, it can not validate
4202
4203     } else if ($user->password === md5($password.$CFG->passwordsaltmain)
4204             or $user->password === md5($password)
4205             or $user->password === md5(addslashes($password).$CFG->passwordsaltmain)
4206             or $user->password === md5(addslashes($password))) {
4207         // note: we are intentionally using the addslashes() here because we
4208         //       need to accept old password hashes of passwords with magic quotes
4209         $validated = true;
4210
4211     } else {
4212         for ($i=1; $i<=20; $i++) { //20 alternative salts should be enough, right?
4213             $alt = 'passwordsaltalt'.$i;
4214             if (!empty($CFG->$alt)) {
4215                 if ($user->password === md5($password.$CFG->$alt) or $user->password === md5(addslashes($password).$CFG->$alt)) {
4216                     $validated = true;
4217                     break;
4218                 }
4219             }
4220         }
4221     }
4222
4223     if ($validated) {
4224         // force update of password hash using latest main password salt and encoding if needed
4225         update_internal_user_password($user, $password);
4226     }
4227
4228     return $validated;
4229 }
4230
4231 /**
4232  * Calculate hashed value from password using current hash mechanism.
4233  *
4234  * @param string $password
4235  * @return string password hash
4236  */
4237 function hash_internal_user_password($password) {
4238     global $CFG;
4239
4240     if (isset($CFG->passwordsaltmain)) {
4241         return md5($password.$CFG->passwordsaltmain);
4242     } else {
4243         return md5($password);
4244     }
4245 }
4246
4247 /**
4248  * Update password hash in user object.
4249  *
4250  * @param stdClass $user (password property may be updated)
4251  * @param string $password plain text password
4252  * @return bool always returns true
4253  */
4254 function update_internal_user_password($user, $password) {
4255     global $DB;
4256
4257     $authplugin = get_auth_plugin($user->auth);
4258     if ($authplugin->prevent_local_passwords()) {
4259         $hashedpassword = 'not cached';
4260     } else {
4261         $hashedpassword = hash_internal_user_password($password);
4262     }
4263
4264     if ($user->password !== $hashedpassword) {
4265         $DB->set_field('user', 'password',  $hashedpassword, array('id'=>$user->id));
4266         $user->password = $hashedpassword;
4267     }
4268
4269     return true;
4270 }
4271
4272 /**
4273  * Get a complete user record, which includes all the info
4274  * in the user record.
4275  *
4276  * Intended for setting as $USER session variable
4277  *
4278  * @param string $field The user field to be checked for a given value.
4279  * @param string $value The value to match for $field.
4280  * @param int $mnethostid
4281  * @return mixed False, or A {@link $USER} object.
4282  */
4283 function get_complete_user_data($field, $value, $mnethostid = null) {
4284     global $CFG, $DB;
4285
4286     if (!$field || !$value) {
4287         return false;
4288     }
4289
4290 /// Build the WHERE clause for an SQL query
4291     $params = array('fieldval'=>$value);
4292     $constraints = "$field = :fieldval AND deleted <> 1";
4293
4294     // If we are loading user data based on anything other than id,
4295     // we must also restrict our search based on mnet host.
4296     if ($field != 'id') {
4297         if (empty($mnethostid)) {
4298             // if empty, we restrict to local users
4299             $mnethostid = $CFG->mnet_localhost_id;
4300         }
4301     }
4302     if (!empty($mnethostid)) {
4303         $params['mnethostid'] = $mnethostid;
4304         $constraints .= " AND mnethostid = :mnethostid";
4305     }
4306
4307 /// Get all the basic user data
4308
4309     if (! $user = $DB->get_record_select('user', $constraints, $params)) {
4310         return false;
4311     }
4312
4313 /// Get various settings and preferences
4314
4315     // preload preference cache
4316     check_user_preferences_loaded($user);
4317
4318     // load course enrolment related stuff
4319     $user->lastcourseaccess    = array(); // during last session
4320     $user->currentcourseaccess = array(); // during current session
4321     if ($lastaccesses = $DB->get_records('user_lastaccess', array('userid'=>$user->id))) {
4322         foreach ($lastaccesses as $lastaccess) {
4323             $user->lastcourseaccess[$lastaccess->courseid] = $lastaccess->timeaccess;
4324         }
4325     }
4326
4327     $sql = "SELECT g.id, g.courseid
4328               FROM {groups} g, {groups_members} gm
4329              WHERE gm.groupid=g.id AND gm.userid=?";
4330
4331     // this is a special hack to speedup calendar display
4332     $user->groupmember = array();
4333     if (!isguestuser($user)) {
4334         if ($groups = $DB->get_records_sql($sql, array($user->id))) {
4335             foreach ($groups as $group) {
4336                 if (!array_key_exists($group->courseid, $user->groupmember)) {
4337                     $user->groupmember[$group->courseid] = array();
4338                 }
4339                 $user->groupmember[$group->courseid][$group->id] = $group->id;
4340             }
4341         }
4342     }
4343
4344 /// Add the custom profile fields to the user record
4345     $user->profile = array();
4346     if (!isguestuser($user)) {
4347         require_once($CFG->dirroot.'/user/profile/lib.php');
4348         profile_load_custom_fields($user);
4349     }
4350
4351 /// Rewrite some variables if necessary
4352     if (!empty($user->description)) {