lib/moodlelib.php

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