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