Search moodle.org's
Developer Documentation
Developer Documentation
- Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
- Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
- PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402] [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 if (!defined('MDL_PERF_TEST')) { 286 define('MDL_PERF_TEST', false); 287 } else { 288 // We force the ones we need. 289 if (!defined('MDL_PERF')) { 290 define('MDL_PERF', true); 291 } 292 if (!defined('MDL_PERFDB')) { 293 define('MDL_PERFDB', true); 294 } 295 if (!defined('MDL_PERFTOFOOT')) { 296 define('MDL_PERFTOFOOT', true); 297 } 298 } 299 300 // When set to true MUC (Moodle caching) will be disabled as much as possible. 301 // A special cache factory will be used to handle this situation and will use special "disabled" equivalents objects. 302 // This ensure we don't attempt to read or create the config file, don't use stores, don't provide persistence or 303 // storage of any kind. 304 if (!defined('CACHE_DISABLE_ALL')) { 305 define('CACHE_DISABLE_ALL', false); 306 } 307 308 // When set to true MUC (Moodle caching) will not use any of the defined or default stores. 309 // The Cache API will continue to function however this will force the use of the cachestore_dummy so all requests 310 // will be interacting with a static property and will never go to the proper cache stores. 311 // Useful if you need to avoid the stores for one reason or another. 312 if (!defined('CACHE_DISABLE_STORES')) { 313 define('CACHE_DISABLE_STORES', false); 314 } 315 316 // Servers should define a default timezone in php.ini, but if they don't then make sure no errors are shown. 317 date_default_timezone_set(@date_default_timezone_get()); 318 319 // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output 320 // In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php. 321 // Please note that one script can not be accessed from both CLI and web interface. 322 if (!defined('CLI_SCRIPT')) { 323 define('CLI_SCRIPT', false); 324 } 325 if (defined('WEB_CRON_EMULATED_CLI')) { 326 if (!isset($_SERVER['REMOTE_ADDR'])) { 327 echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n"); 328 exit(1); 329 } 330 } else if (isset($_SERVER['REMOTE_ADDR'])) { 331 if (CLI_SCRIPT) { 332 echo('Command line scripts can not be executed from the web interface'); 333 exit(1); 334 } 335 } else { 336 if (!CLI_SCRIPT) { 337 echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n"); 338 exit(1); 339 } 340 } 341 342 // All web service requests have WS_SERVER == true. 343 if (!defined('WS_SERVER')) { 344 define('WS_SERVER', false); 345 } 346 347 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades 348 if (file_exists("$CFG->dataroot/climaintenance.html")) { 349 if (!CLI_SCRIPT) { 350 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Moodle under maintenance'); 351 header('Status: 503 Moodle under maintenance'); 352 header('Retry-After: 300'); 353 header('Content-type: text/html; charset=utf-8'); 354 header('X-UA-Compatible: IE=edge'); 355 /// Headers to make it not cacheable and json 356 header('Cache-Control: no-store, no-cache, must-revalidate'); 357 header('Cache-Control: post-check=0, pre-check=0', false); 358 header('Pragma: no-cache'); 359 header('Expires: Mon, 20 Aug 1969 09:23:00 GMT'); 360 header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT'); 361 header('Accept-Ranges: none'); 362 readfile("$CFG->dataroot/climaintenance.html"); 363 die; 364 } else { 365 if (!defined('CLI_MAINTENANCE')) { 366 define('CLI_MAINTENANCE', true); 367 } 368 } 369 } else { 370 if (!defined('CLI_MAINTENANCE')) { 371 define('CLI_MAINTENANCE', false); 372 } 373 } 374 375 // Sometimes people use different PHP binary for web and CLI, make 100% sure they have the supported PHP version. 376 if (version_compare(PHP_VERSION, '5.6.5') < 0) { 377 $phpversion = PHP_VERSION; 378 // Do NOT localise - lang strings would not work here and we CAN NOT move it to later place. 379 echo "Moodle 3.2 or later requires at least PHP 5.6.5 (currently using version $phpversion).\n"; 380 echo "Some servers may have multiple PHP versions installed, are you using the correct executable?\n"; 381 exit(1); 382 } 383 384 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc. 385 if (!defined('AJAX_SCRIPT')) { 386 define('AJAX_SCRIPT', false); 387 } 388 389 // Exact version of currently used yui2 and 3 library. 390 $CFG->yui2version = '2.9.0'; 391 $CFG->yui3version = '3.18.1'; 392 393 // Patching the upstream YUI release. 394 // If we need to patch a YUI modules between official YUI releases, the yuipatchlevel will need to be manually 395 // incremented here. The module will also need to be listed in the yuipatchedmodules. 396 // When upgrading to a subsequent version of YUI, these should be reset back to 0 and an empty array. 397 $CFG->yuipatchlevel = 0; 398 $CFG->yuipatchedmodules = array( 399 ); 400 401 if (!empty($CFG->disableonclickaddoninstall)) { 402 // This config.php flag has been merged into another one. 403 $CFG->disableupdateautodeploy = true; 404 } 405 406 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides. 407 if (!isset($CFG->config_php_settings)) { 408 $CFG->config_php_settings = (array)$CFG; 409 // Forced plugin settings override values from config_plugins table. 410 unset($CFG->config_php_settings['forced_plugin_settings']); 411 if (!isset($CFG->forced_plugin_settings)) { 412 $CFG->forced_plugin_settings = array(); 413 } 414 } 415 416 if (isset($CFG->debug)) { 417 $CFG->debug = (int)$CFG->debug; 418 } else { 419 $CFG->debug = 0; 420 } 421 $CFG->debugdeveloper = (($CFG->debug & (E_ALL | E_STRICT)) === (E_ALL | E_STRICT)); // DEBUG_DEVELOPER is not available yet. 422 423 if (!defined('MOODLE_INTERNAL')) { // Necessary because cli installer has to define it earlier. 424 /** Used by library scripts to check they are being called by Moodle. */ 425 define('MOODLE_INTERNAL', true); 426 } 427 428 // core_component can be used in any scripts, it does not need anything else. 429 require_once($CFG->libdir .'/classes/component.php'); 430 431 // special support for highly optimised scripts that do not need libraries and DB connection 432 if (defined('ABORT_AFTER_CONFIG')) { 433 if (!defined('ABORT_AFTER_CONFIG_CANCEL')) { 434 // hide debugging if not enabled in config.php - we do not want to disclose sensitive info 435 error_reporting($CFG->debug); 436 if (NO_DEBUG_DISPLAY) { 437 // Some parts of Moodle cannot display errors and debug at all. 438 ini_set('display_errors', '0'); 439 ini_set('log_errors', '1'); 440 } else if (empty($CFG->debugdisplay)) { 441 ini_set('display_errors', '0'); 442 ini_set('log_errors', '1'); 443 } else { 444 ini_set('display_errors', '1'); 445 } 446 require_once("$CFG->dirroot/lib/configonlylib.php"); 447 return; 448 } 449 } 450 451 // Early profiling start, based exclusively on config.php $CFG settings 452 if (!empty($CFG->earlyprofilingenabled)) { 453 require_once($CFG->libdir . '/xhprof/xhprof_moodle.php'); 454 profiling_start(); 455 } 456 457 /** 458 * Database connection. Used for all access to the database. 459 * @global moodle_database $DB 460 * @name $DB 461 */ 462 global $DB; 463 464 /** 465 * Moodle's wrapper round PHP's $_SESSION. 466 * 467 * @global object $SESSION 468 * @name $SESSION 469 */ 470 global $SESSION; 471 472 /** 473 * Holds the user table record for the current user. Will be the 'guest' 474 * user record for people who are not logged in. 475 * 476 * $USER is stored in the session. 477 * 478 * Items found in the user record: 479 * - $USER->email - The user's email address. 480 * - $USER->id - The unique integer identified of this user in the 'user' table. 481 * - $USER->email - The user's email address. 482 * - $USER->firstname - The user's first name. 483 * - $USER->lastname - The user's last name. 484 * - $USER->username - The user's login username. 485 * - $USER->secret - The user's ?. 486 * - $USER->lang - The user's language choice. 487 * 488 * @global object $USER 489 * @name $USER 490 */ 491 global $USER; 492 493 /** 494 * Frontpage course record 495 */ 496 global $SITE; 497 498 /** 499 * A central store of information about the current page we are 500 * generating in response to the user's request. 501 * 502 * @global moodle_page $PAGE 503 * @name $PAGE 504 */ 505 global $PAGE; 506 507 /** 508 * The current course. An alias for $PAGE->course. 509 * @global object $COURSE 510 * @name $COURSE 511 */ 512 global $COURSE; 513 514 /** 515 * $OUTPUT is an instance of core_renderer or one of its subclasses. Use 516 * it to generate HTML for output. 517 * 518 * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer} 519 * for the magic that does that. After $OUTPUT has been initialised, any attempt 520 * to change something that affects the current theme ($PAGE->course, logged in use, 521 * httpsrequried ... will result in an exception.) 522 * 523 * Please note the $OUTPUT is replacing the old global $THEME object. 524 * 525 * @global object $OUTPUT 526 * @name $OUTPUT 527 */ 528 global $OUTPUT; 529 530 /** 531 * Full script path including all params, slash arguments, scheme and host. 532 * 533 * Note: Do NOT use for getting of current page URL or detection of https, 534 * instead use $PAGE->url or is_https(). 535 * 536 * @global string $FULLME 537 * @name $FULLME 538 */ 539 global $FULLME; 540 541 /** 542 * Script path including query string and slash arguments without host. 543 * @global string $ME 544 * @name $ME 545 */ 546 global $ME; 547 548 /** 549 * $FULLME without slasharguments and query string. 550 * @global string $FULLSCRIPT 551 * @name $FULLSCRIPT 552 */ 553 global $FULLSCRIPT; 554 555 /** 556 * Relative moodle script path '/course/view.php' 557 * @global string $SCRIPT 558 * @name $SCRIPT 559 */ 560 global $SCRIPT; 561 562 // The httpswwwroot has been deprecated, we keep it as an alias for backwards compatibility with plugins only. 563 $CFG->httpswwwroot = $CFG->wwwroot; 564 565 require_once($CFG->libdir .'/setuplib.php'); // Functions that MUST be loaded first 566 567 if (NO_OUTPUT_BUFFERING) { 568 // we have to call this always before starting session because it discards headers! 569 disable_output_buffering(); 570 } 571 572 // Increase memory limits if possible 573 raise_memory_limit(MEMORY_STANDARD); 574 575 // Time to start counting 576 init_performance_info(); 577 578 // Put $OUTPUT in place, so errors can be displayed. 579 $OUTPUT = new bootstrap_renderer(); 580 581 // Set handler for uncaught exceptions - equivalent to throw new \moodle_exception() call. 582 if (!PHPUNIT_TEST or PHPUNIT_UTIL) { 583 set_exception_handler('default_exception_handler'); 584 set_error_handler('default_error_handler', E_ALL | E_STRICT); 585 } 586 587 // Acceptance tests needs special output to capture the errors, 588 // but not necessary for behat CLI command and init script. 589 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST') && !defined('BEHAT_UTIL')) { 590 require_once (__DIR__ . '/behat/lib.php'); 591 set_error_handler('behat_error_handler', E_ALL | E_STRICT); 592 } 593 594 if (defined('WS_SERVER') && WS_SERVER) { 595 require_once($CFG->dirroot . '/webservice/lib.php'); 596 set_exception_handler('early_ws_exception_handler'); 597 } 598 599 // If there are any errors in the standard libraries we want to know! 600 error_reporting(E_ALL | E_STRICT); 601 602 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others) 603 // http://www.google.com/webmasters/faq.html#prefetchblock 604 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){ 605 header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden'); 606 echo('Prefetch request forbidden.'); 607 exit(1); 608 } 609 610 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else 611 //the problem is that we need specific version of quickforms and hacked excel files :-( 612 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path')); 613 614 // Register our classloader, in theory somebody might want to replace it to load other hacked core classes. 615 if (defined('COMPONENT_CLASSLOADER')) { 616 spl_autoload_register(COMPONENT_CLASSLOADER); 617 } else { 618 spl_autoload_register('core_component::classloader'); 619 } 620 621 // Remember the default PHP timezone, we will need it later. 622 core_date::store_default_php_timezone(); 623 624 // Load up standard libraries 625 require_once($CFG->libdir .'/filterlib.php'); // Functions for filtering test as it is output 626 require_once($CFG->libdir .'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI 627 require_once($CFG->libdir .'/weblib.php'); // Functions relating to HTTP and content 628 require_once($CFG->libdir .'/outputlib.php'); // Functions for generating output 629 require_once($CFG->libdir .'/navigationlib.php'); // Class for generating Navigation structure 630 require_once($CFG->libdir .'/dmllib.php'); // Database access 631 require_once($CFG->libdir .'/datalib.php'); // Legacy lib with a big-mix of functions. 632 require_once($CFG->libdir .'/accesslib.php'); // Access control functions 633 require_once($CFG->libdir .'/deprecatedlib.php'); // Deprecated functions included for backward compatibility 634 require_once($CFG->libdir .'/moodlelib.php'); // Other general-purpose functions 635 require_once($CFG->libdir .'/enrollib.php'); // Enrolment related functions 636 require_once($CFG->libdir .'/pagelib.php'); // Library that defines the moodle_page class, used for $PAGE 637 require_once($CFG->libdir .'/blocklib.php'); // Library for controlling blocks 638 require_once($CFG->libdir .'/grouplib.php'); // Groups functions 639 require_once($CFG->libdir .'/sessionlib.php'); // All session and cookie related stuff 640 require_once($CFG->libdir .'/editorlib.php'); // All text editor related functions and classes 641 require_once($CFG->libdir .'/messagelib.php'); // Messagelib functions 642 require_once($CFG->libdir .'/modinfolib.php'); // Cached information on course-module instances 643 require_once($CFG->dirroot.'/cache/lib.php'); // Cache API 644 645 // make sure PHP is not severly misconfigured 646 setup_validate_php_configuration(); 647 648 // Connect to the database 649 setup_DB(); 650 651 if (PHPUNIT_TEST and !PHPUNIT_UTIL) { 652 // Make sure tests do not run in parallel. 653 $suffix = ''; 654 if (phpunit_util::is_in_isolated_process()) { 655 $suffix = '.isolated'; 656 } 657 test_lock::acquire('phpunit', $suffix); 658 $dbhash = null; 659 try { 660 if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) { 661 // reset DB tables 662 phpunit_util::reset_database(); 663 } 664 } catch (Exception $e) { 665 if ($dbhash) { 666 // we ned to reinit if reset fails 667 $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest')); 668 } 669 } 670 unset($dbhash); 671 } 672 673 // Load any immutable bootstrap config from local cache. 674 $bootstrapcachefile = $CFG->localcachedir . '/bootstrap.php'; 675 if (is_readable($bootstrapcachefile)) { 676 try { 677 require_once($bootstrapcachefile); 678 // Verify the file is not stale. 679 if (!isset($CFG->bootstraphash) || $CFG->bootstraphash !== hash_local_config_cache()) { 680 // Something has changed, the bootstrap.php file is stale. 681 unset($CFG->siteidentifier); 682 @unlink($bootstrapcachefile); 683 } 684 } catch (Throwable $e) { 685 // If it is corrupted then attempt to delete it and it will be rebuilt. 686 @unlink($bootstrapcachefile); 687 } 688 } 689 690 // Load up any configuration from the config table or MUC cache. 691 if (PHPUNIT_TEST) { 692 phpunit_util::initialise_cfg(); 693 } else { 694 initialise_cfg(); 695 } 696 697 if (isset($CFG->debug)) { 698 $CFG->debug = (int)$CFG->debug; 699 error_reporting($CFG->debug); 700 } else { 701 $CFG->debug = 0; 702 } 703 $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER); 704 705 // Find out if PHP configured to display warnings, 706 // this is a security problem because some moodle scripts may 707 // disclose sensitive information. 708 if (ini_get_bool('display_errors')) { 709 define('WARN_DISPLAY_ERRORS_ENABLED', true); 710 } 711 // If we want to display Moodle errors, then try and set PHP errors to match. 712 if (!isset($CFG->debugdisplay)) { 713 // Keep it "as is" during installation. 714 } else if (NO_DEBUG_DISPLAY) { 715 // Some parts of Moodle cannot display errors and debug at all. 716 ini_set('display_errors', '0'); 717 ini_set('log_errors', '1'); 718 } else if (empty($CFG->debugdisplay)) { 719 ini_set('display_errors', '0'); 720 ini_set('log_errors', '1'); 721 } else { 722 // This is very problematic in XHTML strict mode! 723 ini_set('display_errors', '1'); 724 } 725 726 // Register our shutdown manager, do NOT use register_shutdown_function(). 727 core_shutdown_manager::initialize(); 728 729 // Verify upgrade is not running unless we are in a script that needs to execute in any case 730 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) { 731 if ($CFG->upgraderunning < time()) { 732 unset_config('upgraderunning'); 733 } else { 734 throw new \moodle_exception('upgraderunning'); 735 } 736 } 737 738 // enable circular reference collector in PHP 5.3, 739 // it helps a lot when using large complex OOP structures such as in amos or gradebook 740 if (function_exists('gc_enable')) { 741 gc_enable(); 742 } 743 744 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions 745 if (!empty($CFG->version) and $CFG->version < 2007101509) { 746 throw new \moodle_exception('upgraderequires19', 'error'); 747 die; 748 } 749 750 // Calculate and set $CFG->ostype to be used everywhere. Possible values are: 751 // - WINDOWS: for any Windows flavour. 752 // - UNIX: for the rest 753 // Also, $CFG->os can continue being used if more specialization is required 754 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) { 755 $CFG->ostype = 'WINDOWS'; 756 } else { 757 $CFG->ostype = 'UNIX'; 758 } 759 $CFG->os = PHP_OS; 760 761 // Configure ampersands in URLs 762 ini_set('arg_separator.output', '&'); 763 764 // Work around for a PHP bug see MDL-11237 765 ini_set('pcre.backtrack_limit', 20971520); // 20 MB 766 767 // Set PHP default timezone to server timezone. 768 core_date::set_default_server_timezone(); 769 770 // Location of standard files 771 $CFG->wordlist = $CFG->libdir .'/wordlist.txt'; 772 $CFG->moddata = 'moddata'; 773 774 // neutralise nasty chars in PHP_SELF 775 if (isset($_SERVER['PHP_SELF'])) { 776 $phppos = strpos($_SERVER['PHP_SELF'], '.php'); 777 if ($phppos !== false) { 778 $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4); 779 } 780 unset($phppos); 781 } 782 783 // initialise ME's - this must be done BEFORE starting of session! 784 initialise_fullme(); 785 786 // SYSCONTEXTID is cached in local cache to eliminate 1 query per page. 787 if (!defined('SYSCONTEXTID')) { 788 context_system::instance(); 789 } 790 791 // Defining the site - aka frontpage course 792 try { 793 $SITE = get_site(); 794 } catch (moodle_exception $e) { 795 $SITE = null; 796 if (empty($CFG->version)) { 797 $SITE = new stdClass(); 798 $SITE->id = 1; 799 $SITE->shortname = null; 800 } else { 801 throw $e; 802 } 803 } 804 // And the 'default' course - this will usually get reset later in require_login() etc. 805 $COURSE = clone($SITE); 806 // Id of the frontpage course. 807 define('SITEID', $SITE->id); 808 809 // init session prevention flag - this is defined on pages that do not want session 810 if (CLI_SCRIPT) { 811 // no sessions in CLI scripts possible 812 define('NO_MOODLE_COOKIES', true); 813 814 } else if (WS_SERVER) { 815 // No sessions possible in web services. 816 define('NO_MOODLE_COOKIES', true); 817 818 } else if (!defined('NO_MOODLE_COOKIES')) { 819 if (empty($CFG->version) or $CFG->version < 2009011900) { 820 // no session before sessions table gets created 821 define('NO_MOODLE_COOKIES', true); 822 } else if (CLI_SCRIPT) { 823 // CLI scripts can not have session 824 define('NO_MOODLE_COOKIES', true); 825 } else { 826 define('NO_MOODLE_COOKIES', false); 827 } 828 } 829 830 // Start session and prepare global $SESSION, $USER. 831 if (empty($CFG->sessiontimeout)) { 832 $CFG->sessiontimeout = 8 * 60 * 60; 833 } 834 // Set sessiontimeoutwarning 20 minutes. 835 if (empty($CFG->sessiontimeoutwarning)) { 836 $CFG->sessiontimeoutwarning = 20 * 60; 837 } 838 839 // Allow plugins to callback just before the session is started. 840 $pluginswithfunction = get_plugins_with_function('before_session_start', 'lib.php'); 841 foreach ($pluginswithfunction as $plugins) { 842 foreach ($plugins as $function) { 843 try { 844 $function(); 845 } catch (Throwable $e) { 846 debugging("Exception calling '$function'", DEBUG_DEVELOPER, $e->getTrace()); 847 } 848 } 849 } 850 851 \core\session\manager::start(); 852 // Prevent ignoresesskey hack from getting carried over to a next page. 853 unset($USER->ignoresesskey); 854 855 if (!empty($CFG->proxylogunsafe) || !empty($CFG->proxyfixunsafe)) { 856 if (!empty($CFG->proxyfixunsafe)) { 857 require_once($CFG->libdir.'/filelib.php'); 858 859 $proxyurl = get_moodle_proxy_url(); 860 // This fixes stream handlers inside php. 861 $defaults = stream_context_set_default([ 862 'http' => [ 863 'user_agent' => \core_useragent::get_moodlebot_useragent(), 864 'proxy' => $proxyurl 865 ], 866 ]); 867 868 // Attempt to tell other web clients to use the proxy too. This only 869 // works for clients written in php in the same process, it will not 870 // work for with requests done in another process from an exec call. 871 putenv('http_proxy=' . $proxyurl); 872 putenv('https_proxy=' . $proxyurl); 873 putenv('HTTPS_PROXY=' . $proxyurl); 874 } else { 875 $defaults = stream_context_get_default(); 876 } 877 878 if (!empty($CFG->proxylogunsafe)) { 879 stream_context_set_params($defaults, ['notification' => 'proxy_log_callback']); 880 } 881 882 } 883 884 // Set default content type and encoding, developers are still required to use 885 // echo $OUTPUT->header() everywhere, anything that gets set later should override these headers. 886 // This is intended to mitigate some security problems. 887 if (AJAX_SCRIPT) { 888 if (!core_useragent::supports_json_contenttype()) { 889 // Some bloody old IE. 890 @header('Content-type: text/plain; charset=utf-8'); 891 @header('X-Content-Type-Options: nosniff'); 892 } else if (!empty($_FILES)) { 893 // Some ajax code may have problems with json and file uploads. 894 @header('Content-type: text/plain; charset=utf-8'); 895 } else { 896 @header('Content-type: application/json; charset=utf-8'); 897 } 898 } else if (!CLI_SCRIPT) { 899 @header('Content-type: text/html; charset=utf-8'); 900 } 901 902 // Initialise some variables that are supposed to be set in config.php only. 903 if (!isset($CFG->filelifetime)) { 904 $CFG->filelifetime = 60*60*6; 905 } 906 907 // Late profiling, only happening if early one wasn't started 908 if (!empty($CFG->profilingenabled)) { 909 require_once($CFG->libdir . '/xhprof/xhprof_moodle.php'); 910 profiling_start(); 911 } 912 913 // Hack to get around max_input_vars restrictions, 914 // we need to do this after session init to have some basic DDoS protection. 915 workaround_max_input_vars(); 916 917 // Process theme change in the URL. 918 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) { 919 // we have to use _GET directly because we do not want this to interfere with _POST 920 $urlthemename = optional_param('theme', '', PARAM_PLUGIN); 921 try { 922 $themeconfig = theme_config::load($urlthemename); 923 // Makes sure the theme can be loaded without errors. 924 if ($themeconfig->name === $urlthemename) { 925 $SESSION->theme = $urlthemename; 926 } else { 927 unset($SESSION->theme); 928 } 929 unset($themeconfig); 930 unset($urlthemename); 931 } catch (Exception $e) { 932 debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace()); 933 } 934 } 935 unset($urlthemename); 936 937 // Ensure a valid theme is set. 938 if (!isset($CFG->theme)) { 939 $CFG->theme = 'boost'; 940 } 941 942 // Set language/locale of printed times. If user has chosen a language that 943 // that is different from the site language, then use the locale specified 944 // in the language file. Otherwise, if the admin hasn't specified a locale 945 // then use the one from the default language. Otherwise (and this is the 946 // majority of cases), use the stored locale specified by admin. 947 // note: do not accept lang parameter from POST 948 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) { 949 if (get_string_manager()->translation_exists($lang, false)) { 950 $SESSION->lang = $lang; 951 \core_courseformat\base::session_cache_reset_all(); 952 } 953 } 954 unset($lang); 955 956 // PARAM_SAFEDIR used instead of PARAM_LANG because using PARAM_LANG results 957 // in an empty string being returned when a non-existant language is specified, 958 // which would make it necessary to log out to undo the forcelang setting. 959 // With PARAM_SAFEDIR, it's possible to specify ?forcelang=none to drop the forcelang effect. 960 if ($forcelang = optional_param('forcelang', '', PARAM_SAFEDIR)) { 961 if (isloggedin() 962 && get_string_manager()->translation_exists($forcelang, false) 963 && has_capability('moodle/site:forcelanguage', context_system::instance())) { 964 $SESSION->forcelang = $forcelang; 965 } else if (isset($SESSION->forcelang)) { 966 unset($SESSION->forcelang); 967 } 968 } 969 unset($forcelang); 970 971 setup_lang_from_browser(); 972 973 if (empty($CFG->lang)) { 974 if (empty($SESSION->lang)) { 975 $CFG->lang = 'en'; 976 } else { 977 $CFG->lang = $SESSION->lang; 978 } 979 } 980 981 // Set the default site locale, a lot of the stuff may depend on this 982 // it is definitely too late to call this first in require_login()! 983 moodle_setlocale(); 984 985 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup! 986 if (!empty($CFG->moodlepageclass)) { 987 if (!empty($CFG->moodlepageclassfile)) { 988 require_once($CFG->moodlepageclassfile); 989 } 990 $classname = $CFG->moodlepageclass; 991 } else { 992 $classname = 'moodle_page'; 993 } 994 $PAGE = new $classname(); 995 unset($classname); 996 997 998 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) { 999 if ($CFG->theme == 'standard') { // Temporary measure to help with XHTML validation 1000 if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) { // Allow W3CValidator in as user called w3cvalidator (or guest) 1001 if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or 1002 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) { 1003 if ($user = get_complete_user_data("username", "w3cvalidator")) { 1004 $user->ignoresesskey = true; 1005 } else { 1006 $user = guest_user(); 1007 } 1008 \core\session\manager::set_user($user); 1009 } 1010 } 1011 } 1012 } 1013 1014 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in 1015 // LogFormat to get the current logged in username in moodle. 1016 // Alternatvely for other web servers a header X-MOODLEUSER can be set which 1017 // can be using in the logfile and stripped out if needed. 1018 set_access_log_user(); 1019 1020 1021 // Ensure the urlrewriteclass is setup correctly (to avoid crippling site). 1022 if (isset($CFG->urlrewriteclass)) { 1023 if (!class_exists($CFG->urlrewriteclass)) { 1024 debugging("urlrewriteclass {$CFG->urlrewriteclass} was not found, disabling."); 1025 unset($CFG->urlrewriteclass); 1026 } else if (!in_array('core\output\url_rewriter', class_implements($CFG->urlrewriteclass))) { 1027 debugging("{$CFG->urlrewriteclass} does not implement core\output\url_rewriter, disabling.", DEBUG_DEVELOPER); 1028 unset($CFG->urlrewriteclass); 1029 } 1030 } 1031 1032 // Use a custom script replacement if one exists 1033 if (!empty($CFG->customscripts)) { 1034 if (($customscript = custom_script_path()) !== false) { 1035 require ($customscript); 1036 } 1037 } 1038 1039 if (PHPUNIT_TEST) { 1040 // no ip blocking, these are CLI only 1041 } else if (CLI_SCRIPT and !defined('WEB_CRON_EMULATED_CLI')) { 1042 // no ip blocking 1043 } else if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list? 1044 // in this case, ip in allowed list will be performed first 1045 // for example, client IP is 192.168.1.1 1046 // 192.168 subnet is an entry in allowed list 1047 // 192.168.1.1 is banned in blocked list 1048 // This ip will be banned finally 1049 if (!empty($CFG->allowedip)) { 1050 if (!remoteip_in_list($CFG->allowedip)) { 1051 die(get_string('ipblocked', 'admin')); 1052 } 1053 } 1054 // need further check, client ip may a part of 1055 // allowed subnet, but a IP address are listed 1056 // in blocked list. 1057 if (!empty($CFG->blockedip)) { 1058 if (remoteip_in_list($CFG->blockedip)) { 1059 die(get_string('ipblocked', 'admin')); 1060 } 1061 } 1062 1063 } else { 1064 // in this case, IPs in blocked list will be performed first 1065 // for example, client IP is 192.168.1.1 1066 // 192.168 subnet is an entry in blocked list 1067 // 192.168.1.1 is allowed in allowed list 1068 // This ip will be allowed finally 1069 if (!empty($CFG->blockedip)) { 1070 if (remoteip_in_list($CFG->blockedip)) { 1071 // if the allowed ip list is not empty 1072 // IPs are not included in the allowed list will be 1073 // blocked too 1074 if (!empty($CFG->allowedip)) { 1075 if (!remoteip_in_list($CFG->allowedip)) { 1076 die(get_string('ipblocked', 'admin')); 1077 } 1078 } else { 1079 die(get_string('ipblocked', 'admin')); 1080 } 1081 } 1082 } 1083 // if blocked list is null 1084 // allowed list should be tested 1085 if(!empty($CFG->allowedip)) { 1086 if (!remoteip_in_list($CFG->allowedip)) { 1087 die(get_string('ipblocked', 'admin')); 1088 } 1089 } 1090 1091 } 1092 1093 // // try to detect IE6 and prevent gzip because it is extremely buggy browser 1094 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) { 1095 ini_set('zlib.output_compression', 'Off'); 1096 if (function_exists('apache_setenv')) { 1097 apache_setenv('no-gzip', 1); 1098 } 1099 } 1100 1101 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised. 1102 if (isset($CFG->maintenance_later) and $CFG->maintenance_later <= time()) { 1103 if (!file_exists("$CFG->dataroot/climaintenance.html")) { 1104 require_once("$CFG->libdir/adminlib.php"); 1105 enable_cli_maintenance_mode(); 1106 } 1107 unset_config('maintenance_later'); 1108 if (AJAX_SCRIPT) { 1109 die; 1110 } else if (!CLI_SCRIPT) { 1111 redirect(new moodle_url('/')); 1112 } 1113 } 1114 1115 // Add behat_shutdown_function to shutdown manager, so we can capture php errors, 1116 // but not necessary for behat CLI command as it's being captured by behat process. 1117 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST')) { 1118 core_shutdown_manager::register_function('behat_shutdown_function'); 1119 } 1120 1121 // note: we can not block non utf-8 installations here, because empty mysql database 1122 // might be converted to utf-8 in admin/index.php during installation 1123 1124 1125 1126 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals 1127 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-) 1128 if (false) { 1129 $DB = new moodle_database(); 1130 $OUTPUT = new core_renderer(null, null); 1131 $PAGE = new moodle_page(); 1132 } 1133 1134 // Cache any immutable config locally to avoid constant DB lookups. 1135 initialise_local_config_cache(); 1136 1137 // Allow plugins to callback as soon possible after setup.php is loaded. 1138 $pluginswithfunction = get_plugins_with_function('after_config', 'lib.php'); 1139 foreach ($pluginswithfunction as $plugins) { 1140 foreach ($plugins as $function) { 1141 try { 1142 $function(); 1143 } catch (Throwable $e) { 1144 debugging("Exception calling '$function'", DEBUG_DEVELOPER, $e->getTrace()); 1145 } 1146 } 1147 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
