Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
- Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.
Differences Between: [Versions 310 and 403] [Versions 311 and 403] [Versions 39 and 403] [Versions 400 and 403] [Versions 401 and 403] [Versions 402 and 403]
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 * setup.php - Sets up sessions, connects to databases and so on 20 * 21 * Normally this is only called by the main config.php file 22 * Normally this file does not need to be edited. 23 * 24 * @package core 25 * @subpackage lib 26 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com} 27 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 28 */ 29 30 /** 31 * Holds the core settings that affect how Moodle works. Some of its fields 32 * are set in config.php, and the rest are loaded from the config table. 33 * 34 * Some typical settings in the $CFG global: 35 * - $CFG->wwwroot - Path to moodle index directory in url format. 36 * - $CFG->dataroot - Path to moodle data files directory on server's filesystem. 37 * - $CFG->dirroot - Path to moodle's library folder on server's filesystem. 38 * - $CFG->libdir - Path to moodle's library folder on server's filesystem. 39 * - $CFG->backuptempdir - Path to moodle's backup temp file directory on server's filesystem. 40 * - $CFG->tempdir - Path to moodle's temp file directory on server's filesystem. 41 * - $CFG->cachedir - Path to moodle's cache directory on server's filesystem (shared by cluster nodes). 42 * - $CFG->localcachedir - Path to moodle's local cache directory (not shared by cluster nodes). 43 * - $CFG->localrequestdir - Path to moodle's local temp request directory (not shared by cluster nodes). 44 * 45 * @global object $CFG 46 * @name $CFG 47 */ 48 global $CFG; // this should be done much earlier in config.php before creating new $CFG instance 49 50 if (!isset($CFG)) { 51 if (defined('PHPUNIT_TEST') and PHPUNIT_TEST) { 52 echo('There is a missing "global $CFG;" at the beginning of the config.php file.'."\n"); 53 exit(1); 54 } else { 55 // this should never happen, maybe somebody is accessing this file directly... 56 exit(1); 57 } 58 } 59 60 // We can detect real dirroot path reliably since PHP 4.0.2, 61 // it can not be anything else, there is no point in having this in config.php 62 $CFG->dirroot = dirname(__DIR__); 63 64 // File permissions on created directories in the $CFG->dataroot 65 if (!isset($CFG->directorypermissions)) { 66 $CFG->directorypermissions = 02777; // Must be octal (that's why it's here) 67 } 68 if (!isset($CFG->filepermissions)) { 69 $CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags 70 } 71 // Better also set default umask because developers often forget to include directory 72 // permissions in mkdir() and chmod() after creating new files. 73 if (!isset($CFG->umaskpermissions)) { 74 $CFG->umaskpermissions = (($CFG->directorypermissions & 0777) ^ 0777); 75 } 76 umask($CFG->umaskpermissions); 77 78 if (defined('BEHAT_SITE_RUNNING')) { 79 // We already switched to behat test site previously. 80 81 } else if (!empty($CFG->behat_wwwroot) or !empty($CFG->behat_dataroot) or !empty($CFG->behat_prefix)) { 82 // The behat is configured on this server, we need to find out if this is the behat test 83 // site based on the URL used for access. 84 require_once (__DIR__ . '/../lib/behat/lib.php'); 85 86 // Update config variables for parallel behat runs. 87 behat_update_vars_for_process(); 88 89 // If behat is being installed for parallel run, then we modify params for parallel run only. 90 if (behat_is_test_site() && !(defined('BEHAT_PARALLEL_UTIL') && empty($CFG->behatrunprocess))) { 91 clearstatcache(); 92 93 // Checking the integrity of the provided $CFG->behat_* vars and the 94 // selected wwwroot to prevent conflicts with production and phpunit environments. 95 behat_check_config_vars(); 96 97 // Check that the directory does not contains other things. 98 if (!file_exists("$CFG->behat_dataroot/behattestdir.txt")) { 99 if ($dh = opendir($CFG->behat_dataroot)) { 100 while (($file = readdir($dh)) !== false) { 101 if ($file === 'behat' or $file === '.' or $file === '..' or $file === '.DS_Store' or is_numeric($file)) { 102 continue; 103 } 104 behat_error(BEHAT_EXITCODE_CONFIG, "$CFG->behat_dataroot directory is not empty, ensure this is the " . 105 "directory where you want to install behat test dataroot"); 106 } 107 closedir($dh); 108 unset($dh); 109 unset($file); 110 } 111 112 if (defined('BEHAT_UTIL')) { 113 // Now we create dataroot directory structure for behat tests. 114 testing_initdataroot($CFG->behat_dataroot, 'behat'); 115 } else { 116 behat_error(BEHAT_EXITCODE_INSTALL); 117 } 118 } 119 120 if (!defined('BEHAT_UTIL') and !defined('BEHAT_TEST')) { 121 // Somebody tries to access test site directly, tell them if not enabled. 122 $behatdir = preg_replace("#[/|\\\]" . BEHAT_PARALLEL_SITE_NAME . "\d{0,}$#", '', $CFG->behat_dataroot); 123 if (!file_exists($behatdir . '/test_environment_enabled.txt')) { 124 behat_error(BEHAT_EXITCODE_CONFIG, 'Behat is configured but not enabled on this test site.'); 125 } 126 } 127 128 // Constant used to inform that the behat test site is being used, 129 // this includes all the processes executed by the behat CLI command like 130 // the site reset, the steps executed by the browser drivers when simulating 131 // a user session and a real session when browsing manually to $CFG->behat_wwwroot 132 // like the browser driver does automatically. 133 // Different from BEHAT_TEST as only this last one can perform CLI 134 // actions like reset the site or use data generators. 135 define('BEHAT_SITE_RUNNING', true); 136 137 // Clean extra config.php settings. 138 behat_clean_init_config(); 139 140 // Now we can begin switching $CFG->X for $CFG->behat_X. 141 $CFG->wwwroot = $CFG->behat_wwwroot; 142 $CFG->prefix = $CFG->behat_prefix; 143 $CFG->dataroot = $CFG->behat_dataroot; 144 145 // And we do the same with the optional ones. 146 $allowedconfigoverride = ['dbname', 'dbuser', 'dbpass', 'dbhost']; 147 foreach ($allowedconfigoverride as $config) { 148 $behatconfig = 'behat_' . $config; 149 if (!isset($CFG->$behatconfig)) { 150 continue; 151 } 152 $CFG->$config = $CFG->$behatconfig; 153 } 154 } 155 } 156 157 // Set default warn runtime. 158 if (!isset($CFG->taskruntimewarn)) { 159 $CFG->taskruntimewarn = 12 * 60 * 60; 160 } 161 162 // Set default error runtime. 163 if (!isset($CFG->taskruntimeerror)) { 164 $CFG->taskruntimeerror = 24 * 60 * 60; 165 } 166 167 // Normalise dataroot - we do not want any symbolic links, trailing / or any other weirdness there 168 if (!isset($CFG->dataroot)) { 169 if (isset($_SERVER['REMOTE_ADDR'])) { 170 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error '); 171 } 172 echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n"); 173 exit(1); 174 } 175 $CFG->dataroot = realpath($CFG->dataroot); 176 if ($CFG->dataroot === false) { 177 if (isset($_SERVER['REMOTE_ADDR'])) { 178 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error '); 179 } 180 echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n"); 181 exit(1); 182 } else if (!is_writable($CFG->dataroot)) { 183 if (isset($_SERVER['REMOTE_ADDR'])) { 184 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error '); 185 } 186 echo('Fatal error: $CFG->dataroot is not writable, admin has to fix directory permissions! Exiting.'."\n"); 187 exit(1); 188 } 189 190 // wwwroot is mandatory 191 if (!isset($CFG->wwwroot) or $CFG->wwwroot === 'http://example.com/moodle') { 192 if (isset($_SERVER['REMOTE_ADDR'])) { 193 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error '); 194 } 195 echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n"); 196 exit(1); 197 } 198 199 // Make sure there is some database table prefix. 200 if (!isset($CFG->prefix)) { 201 $CFG->prefix = ''; 202 } 203 204 // Define admin directory 205 if (!isset($CFG->admin)) { // Just in case it isn't defined in config.php 206 $CFG->admin = 'admin'; // This is relative to the wwwroot and dirroot 207 } 208 209 // Set up some paths. 210 $CFG->libdir = $CFG->dirroot .'/lib'; 211 212 // Allow overriding of tempdir but be backwards compatible 213 if (!isset($CFG->tempdir)) { 214 $CFG->tempdir = $CFG->dataroot . DIRECTORY_SEPARATOR . "temp"; 215 } 216 217 // Allow overriding of backuptempdir but be backwards compatible 218 if (!isset($CFG->backuptempdir)) { 219 $CFG->backuptempdir = "$CFG->tempdir/backup"; 220 } 221 222 // Allow overriding of cachedir but be backwards compatible 223 if (!isset($CFG->cachedir)) { 224 $CFG->cachedir = "$CFG->dataroot/cache"; 225 } 226 227 // Allow overriding of localcachedir. 228 if (!isset($CFG->localcachedir)) { 229 $CFG->localcachedir = "$CFG->dataroot/localcache"; 230 } 231 232 // Allow overriding of localrequestdir. 233 if (!isset($CFG->localrequestdir)) { 234 $CFG->localrequestdir = sys_get_temp_dir() . '/requestdir'; 235 } 236 237 // Location of all languages except core English pack. 238 if (!isset($CFG->langotherroot)) { 239 $CFG->langotherroot = $CFG->dataroot.'/lang'; 240 } 241 242 // Location of local lang pack customisations (dirs with _local suffix). 243 if (!isset($CFG->langlocalroot)) { 244 $CFG->langlocalroot = $CFG->dataroot.'/lang'; 245 } 246 247 // The current directory in PHP version 4.3.0 and above isn't necessarily the 248 // directory of the script when run from the command line. The require_once() 249 // would fail, so we'll have to chdir() 250 if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) { 251 // do it only once - skip the second time when continuing after prevous abort 252 if (!defined('ABORT_AFTER_CONFIG') and !defined('ABORT_AFTER_CONFIG_CANCEL')) { 253 chdir(dirname($_SERVER['argv'][0])); 254 } 255 } 256 257 // sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that?? 258 ini_set('precision', 14); // needed for upgrades and gradebook 259 ini_set('serialize_precision', 17); // Make float serialization consistent on all systems. 260 261 // Scripts may request no debug and error messages in output 262 // please note it must be defined before including the config.php script 263 // and in some cases you also need to set custom default exception handler 264 if (!defined('NO_DEBUG_DISPLAY')) { 265 if (defined('AJAX_SCRIPT') and AJAX_SCRIPT) { 266 // Moodle AJAX scripts are expected to return json data, any PHP notices or errors break it badly, 267 // developers simply must learn to watch error log. 268 define('NO_DEBUG_DISPLAY', true); 269 } else { 270 define('NO_DEBUG_DISPLAY', false); 271 } 272 } 273 274 // Some scripts such as upgrade may want to prevent output buffering 275 if (!defined('NO_OUTPUT_BUFFERING')) { 276 define('NO_OUTPUT_BUFFERING', false); 277 } 278 279 // PHPUnit tests need custom init 280 if (!defined('PHPUNIT_TEST')) { 281 define('PHPUNIT_TEST', false); 282 } 283 284 // Performance tests needs to always display performance info, even in redirections; 285 // MDL_PERF_TEST is used in https://github.com/moodlehq/moodle-performance-comparison scripts. 286 if (!defined('MDL_PERF_TEST')) { 287 define('MDL_PERF_TEST', false); 288 } 289 // Make sure all MDL_PERF* constants are always defined. 290 if (!defined('MDL_PERF')) { 291 define('MDL_PERF', MDL_PERF_TEST); 292 } 293 if (!defined('MDL_PERFTOFOOT')) { 294 define('MDL_PERFTOFOOT', MDL_PERF_TEST); 295 } 296 if (!defined('MDL_PERFTOLOG')) { 297 define('MDL_PERFTOLOG', false); 298 } 299 if (!defined('MDL_PERFINC')) { 300 define('MDL_PERFINC', false); 301 } 302 // Note that PHPUnit and Behat tests should pass with both MDL_PERF true and false. 303 304 // When set to true MUC (Moodle caching) will be disabled as much as possible. 305 // A special cache factory will be used to handle this situation and will use special "disabled" equivalents objects. 306 // This ensure we don't attempt to read or create the config file, don't use stores, don't provide persistence or 307 // storage of any kind. 308 if (!defined('CACHE_DISABLE_ALL')) { 309 define('CACHE_DISABLE_ALL', false); 310 } 311 312 // When set to true MUC (Moodle caching) will not use any of the defined or default stores. 313 // The Cache API will continue to function however this will force the use of the cachestore_dummy so all requests 314 // will be interacting with a static property and will never go to the proper cache stores. 315 // Useful if you need to avoid the stores for one reason or another. 316 if (!defined('CACHE_DISABLE_STORES')) { 317 define('CACHE_DISABLE_STORES', false); 318 } 319 320 // Servers should define a default timezone in php.ini, but if they don't then make sure no errors are shown. 321 date_default_timezone_set(@date_default_timezone_get()); 322 323 // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output 324 // In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php. 325 // Please note that one script can not be accessed from both CLI and web interface. 326 if (!defined('CLI_SCRIPT')) { 327 define('CLI_SCRIPT', false); 328 } 329 if (defined('WEB_CRON_EMULATED_CLI')) { 330 if (!isset($_SERVER['REMOTE_ADDR'])) { 331 echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n"); 332 exit(1); 333 } 334 } else if (isset($_SERVER['REMOTE_ADDR'])) { 335 if (CLI_SCRIPT) { 336 echo('Command line scripts can not be executed from the web interface'); 337 exit(1); 338 } 339 } else { 340 if (!CLI_SCRIPT) { 341 echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n"); 342 exit(1); 343 } 344 } 345 346 // All web service requests have WS_SERVER == true. 347 if (!defined('WS_SERVER')) { 348 define('WS_SERVER', false); 349 } 350 351 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades 352 if (file_exists("$CFG->dataroot/climaintenance.html")) { 353 if (!CLI_SCRIPT) { 354 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Moodle under maintenance'); 355 header('Status: 503 Moodle under maintenance'); 356 header('Retry-After: 300'); 357 header('Content-type: text/html; charset=utf-8'); 358 header('X-UA-Compatible: IE=edge'); 359 /// Headers to make it not cacheable and json 360 header('Cache-Control: no-store, no-cache, must-revalidate'); 361 header('Cache-Control: post-check=0, pre-check=0', false); 362 header('Pragma: no-cache'); 363 header('Expires: Mon, 20 Aug 1969 09:23:00 GMT'); 364 header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT'); 365 header('Accept-Ranges: none'); 366 readfile("$CFG->dataroot/climaintenance.html"); 367 die; 368 } else { 369 if (!defined('CLI_MAINTENANCE')) { 370 define('CLI_MAINTENANCE', true); 371 } 372 } 373 } else { 374 if (!defined('CLI_MAINTENANCE')) { 375 define('CLI_MAINTENANCE', false); 376 } 377 } 378 379 // Sometimes people use different PHP binary for web and CLI, make 100% sure they have the supported PHP version. 380 if (version_compare(PHP_VERSION, '5.6.5') < 0) { 381 $phpversion = PHP_VERSION; 382 // Do NOT localise - lang strings would not work here and we CAN NOT move it to later place. 383 echo "Moodle 3.2 or later requires at least PHP 5.6.5 (currently using version $phpversion).\n"; 384 echo "Some servers may have multiple PHP versions installed, are you using the correct executable?\n"; 385 exit(1); 386 } 387 388 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc. 389 if (!defined('AJAX_SCRIPT')) { 390 define('AJAX_SCRIPT', false); 391 } 392 393 // Exact version of currently used yui2 and 3 library. 394 $CFG->yui2version = '2.9.0'; 395 $CFG->yui3version = '3.18.1'; 396 397 // Patching the upstream YUI release. 398 // If we need to patch a YUI modules between official YUI releases, the yuipatchlevel will need to be manually 399 // incremented here. The module will also need to be listed in the yuipatchedmodules. 400 // When upgrading to a subsequent version of YUI, these should be reset back to 0 and an empty array. 401 $CFG->yuipatchlevel = 0; 402 $CFG->yuipatchedmodules = array( 403 ); 404 405 if (!empty($CFG->disableonclickaddoninstall)) { 406 // This config.php flag has been merged into another one. 407 $CFG->disableupdateautodeploy = true; 408 } 409 410 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides. 411 if (!isset($CFG->config_php_settings)) { 412 $CFG->config_php_settings = (array)$CFG; 413 // Forced plugin settings override values from config_plugins table. 414 unset($CFG->config_php_settings['forced_plugin_settings']); 415 if (!isset($CFG->forced_plugin_settings)) { 416 $CFG->forced_plugin_settings = array(); 417 } 418 } 419 420 if (isset($CFG->debug)) { 421 $CFG->debug = (int)$CFG->debug; 422 } else { 423 $CFG->debug = 0; 424 } 425 $CFG->debugdeveloper = (($CFG->debug & (E_ALL | E_STRICT)) === (E_ALL | E_STRICT)); // DEBUG_DEVELOPER is not available yet. 426 427 if (!defined('MOODLE_INTERNAL')) { // Necessary because cli installer has to define it earlier. 428 /** Used by library scripts to check they are being called by Moodle. */ 429 define('MOODLE_INTERNAL', true); 430 } 431 432 // core_component can be used in any scripts, it does not need anything else. 433 require_once($CFG->libdir .'/classes/component.php'); 434 435 // special support for highly optimised scripts that do not need libraries and DB connection 436 if (defined('ABORT_AFTER_CONFIG')) { 437 if (!defined('ABORT_AFTER_CONFIG_CANCEL')) { 438 // hide debugging if not enabled in config.php - we do not want to disclose sensitive info 439 error_reporting($CFG->debug); 440 if (NO_DEBUG_DISPLAY) { 441 // Some parts of Moodle cannot display errors and debug at all. 442 ini_set('display_errors', '0'); 443 ini_set('log_errors', '1'); 444 } else if (empty($CFG->debugdisplay)) { 445 ini_set('display_errors', '0'); 446 ini_set('log_errors', '1'); 447 } else { 448 ini_set('display_errors', '1'); 449 } 450 require_once("$CFG->dirroot/lib/configonlylib.php"); 451 return; 452 } 453 } 454 455 // Early profiling start, based exclusively on config.php $CFG settings 456 if (!empty($CFG->earlyprofilingenabled)) { 457 require_once($CFG->libdir . '/xhprof/xhprof_moodle.php'); 458 profiling_start(); 459 } 460 461 /** 462 * Database connection. Used for all access to the database. 463 * @global moodle_database $DB 464 * @name $DB 465 */ 466 global $DB; 467 468 /** 469 * Moodle's wrapper round PHP's $_SESSION. 470 * 471 * @global object $SESSION 472 * @name $SESSION 473 */ 474 global $SESSION; 475 476 /** 477 * Holds the user table record for the current user. Will be the 'guest' 478 * user record for people who are not logged in. 479 * 480 * $USER is stored in the session. 481 * 482 * Items found in the user record: 483 * - $USER->email - The user's email address. 484 * - $USER->id - The unique integer identified of this user in the 'user' table. 485 * - $USER->email - The user's email address. 486 * - $USER->firstname - The user's first name. 487 * - $USER->lastname - The user's last name. 488 * - $USER->username - The user's login username. 489 * - $USER->secret - The user's ?. 490 * - $USER->lang - The user's language choice. 491 * 492 * @global object $USER 493 * @name $USER 494 */ 495 global $USER; 496 497 /** 498 * Frontpage course record 499 */ 500 global $SITE; 501 502 /** 503 * A central store of information about the current page we are 504 * generating in response to the user's request. 505 * 506 * @global moodle_page $PAGE 507 * @name $PAGE 508 */ 509 global $PAGE; 510 511 /** 512 * The current course. An alias for $PAGE->course. 513 * @global object $COURSE 514 * @name $COURSE 515 */ 516 global $COURSE; 517 518 /** 519 * $OUTPUT is an instance of core_renderer or one of its subclasses. Use 520 * it to generate HTML for output. 521 * 522 * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer} 523 * for the magic that does that. After $OUTPUT has been initialised, any attempt 524 * to change something that affects the current theme ($PAGE->course, logged in use, 525 * httpsrequried ... will result in an exception.) 526 * 527 * Please note the $OUTPUT is replacing the old global $THEME object. 528 * 529 * @global object $OUTPUT 530 * @name $OUTPUT 531 */ 532 global $OUTPUT; 533 534 /** 535 * Full script path including all params, slash arguments, scheme and host. 536 * 537 * Note: Do NOT use for getting of current page URL or detection of https, 538 * instead use $PAGE->url or is_https(). 539 * 540 * @global string $FULLME 541 * @name $FULLME 542 */ 543 global $FULLME; 544 545 /** 546 * Script path including query string and slash arguments without host. 547 * @global string $ME 548 * @name $ME 549 */ 550 global $ME; 551 552 /** 553 * $FULLME without slasharguments and query string. 554 * @global string $FULLSCRIPT 555 * @name $FULLSCRIPT 556 */ 557 global $FULLSCRIPT; 558 559 /** 560 * Relative moodle script path '/course/view.php' 561 * @global string $SCRIPT 562 * @name $SCRIPT 563 */ 564 global $SCRIPT; 565 566 // The httpswwwroot has been deprecated, we keep it as an alias for backwards compatibility with plugins only. 567 $CFG->httpswwwroot = $CFG->wwwroot; 568 569 require_once($CFG->libdir .'/setuplib.php'); // Functions that MUST be loaded first 570 571 if (NO_OUTPUT_BUFFERING) { 572 // we have to call this always before starting session because it discards headers! 573 disable_output_buffering(); 574 } 575 576 // Increase memory limits if possible 577 raise_memory_limit(MEMORY_STANDARD); 578 579 // Time to start counting 580 init_performance_info(); 581 582 // Put $OUTPUT in place, so errors can be displayed. 583 $OUTPUT = new bootstrap_renderer(); 584 585 // Set handler for uncaught exceptions - equivalent to throw new \moodle_exception() call. 586 if (!PHPUNIT_TEST or PHPUNIT_UTIL) { 587 set_exception_handler('default_exception_handler'); 588 set_error_handler('default_error_handler', E_ALL | E_STRICT); 589 } 590 591 // Acceptance tests needs special output to capture the errors, 592 // but not necessary for behat CLI command and init script. 593 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST') && !defined('BEHAT_UTIL')) { 594 require_once (__DIR__ . '/behat/lib.php'); 595 set_error_handler('behat_error_handler', E_ALL | E_STRICT); 596 } 597 598 if (defined('WS_SERVER') && WS_SERVER) { 599 require_once($CFG->dirroot . '/webservice/lib.php'); 600 set_exception_handler('early_ws_exception_handler'); 601 } 602 603 // If there are any errors in the standard libraries we want to know! 604 error_reporting(E_ALL | E_STRICT); 605 606 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others) 607 // http://www.google.com/webmasters/faq.html#prefetchblock 608 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){ 609 header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden'); 610 echo('Prefetch request forbidden.'); 611 exit(1); 612 } 613 614 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else 615 //the problem is that we need specific version of quickforms and hacked excel files :-( 616 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path')); 617 618 // Register our classloader, in theory somebody might want to replace it to load other hacked core classes. 619 if (defined('COMPONENT_CLASSLOADER')) { 620 spl_autoload_register(COMPONENT_CLASSLOADER); 621 } else { 622 spl_autoload_register('core_component::classloader'); 623 } 624 625 // Remember the default PHP timezone, we will need it later. 626 core_date::store_default_php_timezone(); 627 628 // Load up standard libraries 629 require_once($CFG->libdir .'/filterlib.php'); // Functions for filtering test as it is output 630 require_once($CFG->libdir .'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI 631 require_once($CFG->libdir .'/weblib.php'); // Functions relating to HTTP and content 632 require_once($CFG->libdir .'/outputlib.php'); // Functions for generating output 633 require_once($CFG->libdir .'/navigationlib.php'); // Class for generating Navigation structure 634 require_once($CFG->libdir .'/dmllib.php'); // Database access 635 require_once($CFG->libdir .'/datalib.php'); // Legacy lib with a big-mix of functions. 636 require_once($CFG->libdir .'/accesslib.php'); // Access control functions 637 require_once($CFG->libdir .'/deprecatedlib.php'); // Deprecated functions included for backward compatibility 638 require_once($CFG->libdir .'/moodlelib.php'); // Other general-purpose functions 639 require_once($CFG->libdir .'/enrollib.php'); // Enrolment related functions 640 require_once($CFG->libdir .'/pagelib.php'); // Library that defines the moodle_page class, used for $PAGE 641 require_once($CFG->libdir .'/blocklib.php'); // Library for controlling blocks 642 require_once($CFG->libdir .'/grouplib.php'); // Groups functions 643 require_once($CFG->libdir .'/sessionlib.php'); // All session and cookie related stuff 644 require_once($CFG->libdir .'/editorlib.php'); // All text editor related functions and classes 645 require_once($CFG->libdir .'/messagelib.php'); // Messagelib functions 646 require_once($CFG->libdir .'/modinfolib.php'); // Cached information on course-module instances 647 require_once($CFG->dirroot.'/cache/lib.php'); // Cache API 648 649 // make sure PHP is not severly misconfigured 650 setup_validate_php_configuration(); 651 652 // Connect to the database 653 setup_DB(); 654 655 if (PHPUNIT_TEST and !PHPUNIT_UTIL) { 656 // Make sure tests do not run in parallel. 657 $suffix = ''; 658 if (phpunit_util::is_in_isolated_process()) { 659 $suffix = '.isolated'; 660 } 661 test_lock::acquire('phpunit', $suffix); 662 $dbhash = null; 663 try { 664 if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) { 665 // reset DB tables 666 phpunit_util::reset_database(); 667 } 668 } catch (Exception $e) { 669 if ($dbhash) { 670 // we ned to reinit if reset fails 671 $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest')); 672 } 673 } 674 unset($dbhash); 675 } 676 677 // Load any immutable bootstrap config from local cache. 678 $bootstrapcachefile = $CFG->localcachedir . '/bootstrap.php'; 679 if (is_readable($bootstrapcachefile)) { 680 try { 681 require_once($bootstrapcachefile); 682 // Verify the file is not stale. 683 if (!isset($CFG->bootstraphash) || $CFG->bootstraphash !== hash_local_config_cache()) { 684 // Something has changed, the bootstrap.php file is stale. 685 unset($CFG->siteidentifier); 686 @unlink($bootstrapcachefile); 687 } 688 } catch (Throwable $e) { 689 // If it is corrupted then attempt to delete it and it will be rebuilt. 690 @unlink($bootstrapcachefile); 691 } 692 } 693 694 // Load up any configuration from the config table or MUC cache. 695 if (PHPUNIT_TEST) { 696 phpunit_util::initialise_cfg(); 697 } else { 698 initialise_cfg(); 699 } 700 701 if (isset($CFG->debug)) { 702 $CFG->debug = (int)$CFG->debug; 703 error_reporting($CFG->debug); 704 } else { 705 $CFG->debug = 0; 706 } 707 $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER); 708 709 // Find out if PHP configured to display warnings, 710 // this is a security problem because some moodle scripts may 711 // disclose sensitive information. 712 if (ini_get_bool('display_errors')) { 713 define('WARN_DISPLAY_ERRORS_ENABLED', true); 714 } 715 // If we want to display Moodle errors, then try and set PHP errors to match. 716 if (!isset($CFG->debugdisplay)) { 717 // Keep it "as is" during installation. 718 } else if (NO_DEBUG_DISPLAY) { 719 // Some parts of Moodle cannot display errors and debug at all. 720 ini_set('display_errors', '0'); 721 ini_set('log_errors', '1'); 722 } else if (empty($CFG->debugdisplay)) { 723 ini_set('display_errors', '0'); 724 ini_set('log_errors', '1'); 725 } else { 726 // This is very problematic in XHTML strict mode! 727 ini_set('display_errors', '1'); 728 } 729 730 // Register our shutdown manager, do NOT use register_shutdown_function(). 731 core_shutdown_manager::initialize(); 732 733 // Verify upgrade is not running unless we are in a script that needs to execute in any case 734 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) { 735 if ($CFG->upgraderunning < time()) { 736 unset_config('upgraderunning'); 737 } else { 738 throw new \moodle_exception('upgraderunning'); 739 } 740 } 741 742 // enable circular reference collector in PHP 5.3, 743 // it helps a lot when using large complex OOP structures such as in amos or gradebook 744 if (function_exists('gc_enable')) { 745 gc_enable(); 746 } 747 748 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions 749 if (!empty($CFG->version) and $CFG->version < 2007101509) { 750 throw new \moodle_exception('upgraderequires19', 'error'); 751 die; 752 } 753 754 // Calculate and set $CFG->ostype to be used everywhere. Possible values are: 755 // - WINDOWS: for any Windows flavour. 756 // - UNIX: for the rest 757 // Also, $CFG->os can continue being used if more specialization is required 758 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) { 759 $CFG->ostype = 'WINDOWS'; 760 } else { 761 $CFG->ostype = 'UNIX'; 762 } 763 $CFG->os = PHP_OS; 764 765 // Configure ampersands in URLs 766 ini_set('arg_separator.output', '&'); 767 768 // Work around for a PHP bug see MDL-11237 769 ini_set('pcre.backtrack_limit', 20971520); // 20 MB 770 771 // Set PHP default timezone to server timezone. 772 core_date::set_default_server_timezone(); 773 774 // Location of standard files 775 $CFG->wordlist = $CFG->libdir .'/wordlist.txt'; 776 $CFG->moddata = 'moddata'; 777 778 // neutralise nasty chars in PHP_SELF 779 if (isset($_SERVER['PHP_SELF'])) { 780 $phppos = strpos($_SERVER['PHP_SELF'], '.php'); 781 if ($phppos !== false) { 782 $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4); 783 } 784 unset($phppos); 785 } 786 787 // initialise ME's - this must be done BEFORE starting of session! 788 initialise_fullme(); 789 790 // SYSCONTEXTID is cached in local cache to eliminate 1 query per page. 791 if (!defined('SYSCONTEXTID')) { 792 context_system::instance(); 793 } 794 795 // Defining the site - aka frontpage course 796 try { 797 $SITE = get_site(); 798 } catch (moodle_exception $e) { 799 $SITE = null; 800 if (empty($CFG->version)) { 801 $SITE = new stdClass(); 802 $SITE->id = 1; 803 $SITE->shortname = null; 804 } else { 805 throw $e; 806 } 807 } 808 // And the 'default' course - this will usually get reset later in require_login() etc. 809 $COURSE = clone($SITE); 810 // Id of the frontpage course. 811 define('SITEID', $SITE->id); 812 813 // init session prevention flag - this is defined on pages that do not want session 814 if (CLI_SCRIPT) { 815 // no sessions in CLI scripts possible 816 define('NO_MOODLE_COOKIES', true); 817 818 } else if (WS_SERVER) { 819 // No sessions possible in web services. 820 define('NO_MOODLE_COOKIES', true); 821 822 } else if (!defined('NO_MOODLE_COOKIES')) { 823 if (empty($CFG->version) or $CFG->version < 2009011900) { 824 // no session before sessions table gets created 825 define('NO_MOODLE_COOKIES', true); 826 } else if (CLI_SCRIPT) { 827 // CLI scripts can not have session 828 define('NO_MOODLE_COOKIES', true); 829 } else { 830 define('NO_MOODLE_COOKIES', false); 831 } 832 } 833 834 // Start session and prepare global $SESSION, $USER. 835 if (empty($CFG->sessiontimeout)) { 836 $CFG->sessiontimeout = 8 * 60 * 60; 837 } 838 // Set sessiontimeoutwarning 20 minutes. 839 if (empty($CFG->sessiontimeoutwarning)) { 840 $CFG->sessiontimeoutwarning = 20 * 60; 841 } 842 843 // Allow plugins to callback just before the session is started. 844 $pluginswithfunction = get_plugins_with_function('before_session_start', 'lib.php'); 845 foreach ($pluginswithfunction as $plugins) { 846 foreach ($plugins as $function) { 847 try { 848 $function(); 849 } catch (Throwable $e) { 850 debugging("Exception calling '$function'", DEBUG_DEVELOPER, $e->getTrace()); 851 } 852 } 853 } 854 855 \core\session\manager::start(); 856 // Prevent ignoresesskey hack from getting carried over to a next page. 857 unset($USER->ignoresesskey); 858 859 if (!empty($CFG->proxylogunsafe) || !empty($CFG->proxyfixunsafe)) { 860 if (!empty($CFG->proxyfixunsafe)) { 861 require_once($CFG->libdir.'/filelib.php'); 862 863 $proxyurl = get_moodle_proxy_url(); 864 // This fixes stream handlers inside php. 865 $defaults = stream_context_set_default([ 866 'http' => [ 867 'user_agent' => \core_useragent::get_moodlebot_useragent(), 868 'proxy' => $proxyurl 869 ], 870 ]); 871 872 // Attempt to tell other web clients to use the proxy too. This only 873 // works for clients written in php in the same process, it will not 874 // work for with requests done in another process from an exec call. 875 putenv('http_proxy=' . $proxyurl); 876 putenv('https_proxy=' . $proxyurl); 877 putenv('HTTPS_PROXY=' . $proxyurl); 878 } else { 879 $defaults = stream_context_get_default(); 880 } 881 882 if (!empty($CFG->proxylogunsafe)) { 883 stream_context_set_params($defaults, ['notification' => 'proxy_log_callback']); 884 } 885 886 } 887 888 // Set default content type and encoding, developers are still required to use 889 // echo $OUTPUT->header() everywhere, anything that gets set later should override these headers. 890 // This is intended to mitigate some security problems. 891 if (AJAX_SCRIPT) { 892 if (!core_useragent::supports_json_contenttype()) { 893 // Some bloody old IE. 894 @header('Content-type: text/plain; charset=utf-8'); 895 @header('X-Content-Type-Options: nosniff'); 896 } else if (!empty($_FILES)) { 897 // Some ajax code may have problems with json and file uploads. 898 @header('Content-type: text/plain; charset=utf-8'); 899 } else { 900 @header('Content-type: application/json; charset=utf-8'); 901 } 902 } else if (!CLI_SCRIPT) { 903 @header('Content-type: text/html; charset=utf-8'); 904 } 905 906 // Initialise some variables that are supposed to be set in config.php only. 907 if (!isset($CFG->filelifetime)) { 908 $CFG->filelifetime = 60*60*6; 909 } 910 911 // Late profiling, only happening if early one wasn't started 912 if (!empty($CFG->profilingenabled)) { 913 require_once($CFG->libdir . '/xhprof/xhprof_moodle.php'); 914 profiling_start(); 915 } 916 917 // Hack to get around max_input_vars restrictions, 918 // we need to do this after session init to have some basic DDoS protection. 919 workaround_max_input_vars(); 920 921 // Process theme change in the URL. 922 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) { 923 // we have to use _GET directly because we do not want this to interfere with _POST 924 $urlthemename = optional_param('theme', '', PARAM_PLUGIN); 925 try { 926 $themeconfig = theme_config::load($urlthemename); 927 // Makes sure the theme can be loaded without errors. 928 if ($themeconfig->name === $urlthemename) { 929 $SESSION->theme = $urlthemename; 930 } else { 931 unset($SESSION->theme); 932 } 933 unset($themeconfig); 934 unset($urlthemename); 935 } catch (Exception $e) { 936 debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace()); 937 } 938 } 939 unset($urlthemename); 940 941 // Ensure a valid theme is set. 942 if (!isset($CFG->theme)) { 943 $CFG->theme = 'boost'; 944 } 945 946 // Set language/locale of printed times. If user has chosen a language that 947 // that is different from the site language, then use the locale specified 948 // in the language file. Otherwise, if the admin hasn't specified a locale 949 // then use the one from the default language. Otherwise (and this is the 950 // majority of cases), use the stored locale specified by admin. 951 // note: do not accept lang parameter from POST 952 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) { 953 if (get_string_manager()->translation_exists($lang, false)) { 954 $SESSION->lang = $lang; 955 \core_courseformat\base::session_cache_reset_all(); 956 } 957 } 958 unset($lang); 959 960 // PARAM_SAFEDIR used instead of PARAM_LANG because using PARAM_LANG results 961 // in an empty string being returned when a non-existant language is specified, 962 // which would make it necessary to log out to undo the forcelang setting. 963 // With PARAM_SAFEDIR, it's possible to specify ?forcelang=none to drop the forcelang effect. 964 if ($forcelang = optional_param('forcelang', '', PARAM_SAFEDIR)) { 965 if (isloggedin() 966 && get_string_manager()->translation_exists($forcelang, false) 967 && has_capability('moodle/site:forcelanguage', context_system::instance())) { 968 $SESSION->forcelang = $forcelang; 969 } else if (isset($SESSION->forcelang)) { 970 unset($SESSION->forcelang); 971 } 972 } 973 unset($forcelang); 974 975 setup_lang_from_browser(); 976 977 if (empty($CFG->lang)) { 978 if (empty($SESSION->lang)) { 979 $CFG->lang = 'en'; 980 } else { 981 $CFG->lang = $SESSION->lang; 982 } 983 } 984 985 // Set the default site locale, a lot of the stuff may depend on this 986 // it is definitely too late to call this first in require_login()! 987 moodle_setlocale(); 988 989 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup! 990 if (!empty($CFG->moodlepageclass)) { 991 if (!empty($CFG->moodlepageclassfile)) { 992 require_once($CFG->moodlepageclassfile); 993 } 994 $classname = $CFG->moodlepageclass; 995 } else { 996 $classname = 'moodle_page'; 997 } 998 $PAGE = new $classname(); 999 unset($classname); 1000 1001 1002 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) { 1003 if ($CFG->theme == 'standard') { // Temporary measure to help with XHTML validation 1004 if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) { // Allow W3CValidator in as user called w3cvalidator (or guest) 1005 if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or 1006 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) { 1007 if ($user = get_complete_user_data("username", "w3cvalidator")) { 1008 $user->ignoresesskey = true; 1009 } else { 1010 $user = guest_user(); 1011 } 1012 \core\session\manager::set_user($user); 1013 } 1014 } 1015 } 1016 } 1017 1018 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in 1019 // LogFormat to get the current logged in username in moodle. 1020 // Alternatvely for other web servers a header X-MOODLEUSER can be set which 1021 // can be using in the logfile and stripped out if needed. 1022 set_access_log_user(); 1023 1024 1025 // Ensure the urlrewriteclass is setup correctly (to avoid crippling site). 1026 if (isset($CFG->urlrewriteclass)) { 1027 if (!class_exists($CFG->urlrewriteclass)) { 1028 debugging("urlrewriteclass {$CFG->urlrewriteclass} was not found, disabling."); 1029 unset($CFG->urlrewriteclass); 1030 } else if (!in_array('core\output\url_rewriter', class_implements($CFG->urlrewriteclass))) { 1031 debugging("{$CFG->urlrewriteclass} does not implement core\output\url_rewriter, disabling.", DEBUG_DEVELOPER); 1032 unset($CFG->urlrewriteclass); 1033 } 1034 } 1035 1036 // Use a custom script replacement if one exists 1037 if (!empty($CFG->customscripts)) { 1038 if (($customscript = custom_script_path()) !== false) { 1039 require ($customscript); 1040 } 1041 } 1042 1043 if (PHPUNIT_TEST) { 1044 // no ip blocking, these are CLI only 1045 } else if (CLI_SCRIPT and !defined('WEB_CRON_EMULATED_CLI')) { 1046 // no ip blocking 1047 } else if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list? 1048 // in this case, ip in allowed list will be performed first 1049 // for example, client IP is 192.168.1.1 1050 // 192.168 subnet is an entry in allowed list 1051 // 192.168.1.1 is banned in blocked list 1052 // This ip will be banned finally 1053 if (!empty($CFG->allowedip)) { 1054 if (!remoteip_in_list($CFG->allowedip)) { 1055 die(get_string('ipblocked', 'admin')); 1056 } 1057 } 1058 // need further check, client ip may a part of 1059 // allowed subnet, but a IP address are listed 1060 // in blocked list. 1061 if (!empty($CFG->blockedip)) { 1062 if (remoteip_in_list($CFG->blockedip)) { 1063 die(get_string('ipblocked', 'admin')); 1064 } 1065 } 1066 1067 } else { 1068 // in this case, IPs in blocked list will be performed first 1069 // for example, client IP is 192.168.1.1 1070 // 192.168 subnet is an entry in blocked list 1071 // 192.168.1.1 is allowed in allowed list 1072 // This ip will be allowed finally 1073 if (!empty($CFG->blockedip)) { 1074 if (remoteip_in_list($CFG->blockedip)) { 1075 // if the allowed ip list is not empty 1076 // IPs are not included in the allowed list will be 1077 // blocked too 1078 if (!empty($CFG->allowedip)) { 1079 if (!remoteip_in_list($CFG->allowedip)) { 1080 die(get_string('ipblocked', 'admin')); 1081 } 1082 } else { 1083 die(get_string('ipblocked', 'admin')); 1084 } 1085 } 1086 } 1087 // if blocked list is null 1088 // allowed list should be tested 1089 if(!empty($CFG->allowedip)) { 1090 if (!remoteip_in_list($CFG->allowedip)) { 1091 die(get_string('ipblocked', 'admin')); 1092 } 1093 } 1094 1095 } 1096 1097 // // try to detect IE6 and prevent gzip because it is extremely buggy browser 1098 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) { 1099 ini_set('zlib.output_compression', 'Off'); 1100 if (function_exists('apache_setenv')) { 1101 apache_setenv('no-gzip', 1); 1102 } 1103 } 1104 1105 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised. 1106 if (isset($CFG->maintenance_later) and $CFG->maintenance_later <= time()) { 1107 if (!file_exists("$CFG->dataroot/climaintenance.html")) { 1108 require_once("$CFG->libdir/adminlib.php"); 1109 enable_cli_maintenance_mode(); 1110 } 1111 unset_config('maintenance_later'); 1112 if (AJAX_SCRIPT) { 1113 die; 1114 } else if (!CLI_SCRIPT) { 1115 redirect(new moodle_url('/')); 1116 } 1117 } 1118 1119 // Add behat_shutdown_function to shutdown manager, so we can capture php errors, 1120 // but not necessary for behat CLI command as it's being captured by behat process. 1121 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST')) { 1122 core_shutdown_manager::register_function('behat_shutdown_function'); 1123 } 1124 1125 // note: we can not block non utf-8 installations here, because empty mysql database 1126 // might be converted to utf-8 in admin/index.php during installation 1127 1128 1129 1130 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals 1131 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-) 1132 if (false) { 1133 $DB = new moodle_database(); 1134 $OUTPUT = new core_renderer(null, null); 1135 $PAGE = new moodle_page(); 1136 } 1137 1138 // Cache any immutable config locally to avoid constant DB lookups. 1139 initialise_local_config_cache(); 1140 1141 // Allow plugins to callback as soon possible after setup.php is loaded. 1142 $pluginswithfunction = get_plugins_with_function('after_config', 'lib.php'); 1143 foreach ($pluginswithfunction as $plugins) { 1144 foreach ($plugins as $function) { 1145 try { 1146 $function(); 1147 } catch (Throwable $e) { 1148 debugging("Exception calling '$function'", DEBUG_DEVELOPER, $e->getTrace()); 1149 } 1150 } 1151 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
