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