lib/setup.php

   1 <?php
   2
   3 // This file is part of Moodle - http://moodle.org/
   4 //
   5 // Moodle is free software: you can redistribute it and/or modify
   6 // it under the terms of the GNU General Public License as published by
   7 // the Free Software Foundation, either version 3 of the License, or
   8 // (at your option) any later version.
   9 //
  10 // Moodle is distributed in the hope that it will be useful,
  11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 // GNU General Public License for more details.
  14 //
  15 // You should have received a copy of the GNU General Public License
  16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  17
  18 /**
  19  * 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->tempdir  - Path to moodle's temp file directory on server's filesystem.
  40  *  - $CFG->cachedir - Path to moodle's cache directory on server's filesystem.
  41  *
  42  * @global object $CFG
  43  * @name $CFG
  44  */
  45 global $CFG; // this should be done much earlier in config.php before creating new $CFG instance
  46
  47 if (!isset($CFG)) {
  48     if (defined('PHPUNIT_TEST') and PHPUNIT_TEST) {
  49         echo('There is a missing "global $CFG;" at the beginning of the config.php file.'."\n");
  50         exit(1);
  51     } else {
  52         // this should never happen, maybe somebody is accessing this file directly...
  53         exit(1);
  54     }
  55 }
  56
  57 // We can detect real dirroot path reliably since PHP 4.0.2,
  58 // it can not be anything else, there is no point in having this in config.php
  59 $CFG->dirroot = dirname(dirname(__FILE__));
  60
  61 // Normalise dataroot - we do not want any symbolic links, trailing / or any other weirdness there
  62 if (!isset($CFG->dataroot)) {
  63     if (isset($_SERVER['REMOTE_ADDR'])) {
  64         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
  65     }
  66     echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n");
  67     exit(1);
  68 }
  69 $CFG->dataroot = realpath($CFG->dataroot);
  70 if ($CFG->dataroot === false) {
  71     if (isset($_SERVER['REMOTE_ADDR'])) {
  72         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
  73     }
  74     echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n");
  75     exit(1);
  76 } else if (!is_writable($CFG->dataroot)) {
  77     if (isset($_SERVER['REMOTE_ADDR'])) {
  78         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
  79     }
  80     echo('Fatal error: $CFG->dataroot is not writable, admin has to fix directory permissions! Exiting.'."\n");
  81     exit(1);
  82 }
  83
  84 // wwwroot is mandatory
  85 if (!isset($CFG->wwwroot) or $CFG->wwwroot === 'http://example.com/moodle') {
  86     if (isset($_SERVER['REMOTE_ADDR'])) {
  87         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
  88     }
  89     echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n");
  90     exit(1);
  91 }
  92
  93 // Ignore $CFG->behat_wwwroot and use the same wwwroot.
  94 if (!empty($CFG->behat_switchcompletely)) {
  95     $CFG->behat_wwwroot = $CFG->wwwroot;
  96
  97 } else if (empty($CFG->behat_wwwroot)) {
  98     // Default URL for acceptance testing, only accessible from localhost.
  99     $CFG->behat_wwwroot = 'http://localhost:8000';
 100 }
 101
 102
 103 // Test environment is requested if:
 104 // * Behat is running (constant set hooking the behat init process before requiring config.php).
 105 // * If we are accessing though the built-in web server (cli-server).
 106 // * If $CFG->behat_switchcompletely has been set (maintains CLI scripts behaviour, which ATM is only preventive).
 107 // Test environment is enabled if:
 108 // * User has previously enabled through admin/tool/behat/cli/util.php --enable.
 109 // Both are required to switch to test mode
 110 if (!empty($CFG->behat_dataroot) && !empty($CFG->behat_prefix) && file_exists($CFG->behat_dataroot)) {
 111
 112     $CFG->behat_dataroot = realpath($CFG->behat_dataroot);
 113
 114     $switchcompletely = !empty($CFG->behat_switchcompletely) && php_sapi_name() !== 'cli';
 115     $builtinserver = php_sapi_name() === 'cli-server';
 116     $behatrunning = defined('BEHAT_RUNNING');
 117     $testenvironmentrequested = $switchcompletely || $builtinserver || $behatrunning;
 118
 119     // Only switch to test environment if it has been enabled.
 120     $testenvironmentenabled = file_exists($CFG->behat_dataroot . '/behat/test_environment_enabled.txt');
 121
 122     if ($testenvironmentenabled && $testenvironmentrequested) {
 123         $CFG->wwwroot = $CFG->behat_wwwroot;
 124         $CFG->passwordsaltmain = 'moodle';
 125         $CFG->originaldataroot = $CFG->dataroot;
 126         $CFG->prefix = $CFG->behat_prefix;
 127         $CFG->dataroot = $CFG->behat_dataroot;
 128     }
 129 }
 130
 131 // Define admin directory
 132 if (!isset($CFG->admin)) {   // Just in case it isn't defined in config.php
 133     $CFG->admin = 'admin';   // This is relative to the wwwroot and dirroot
 134 }
 135
 136 // Set up some paths.
 137 $CFG->libdir = $CFG->dirroot .'/lib';
 138
 139 // Allow overriding of tempdir but be backwards compatible
 140 if (!isset($CFG->tempdir)) {
 141     $CFG->tempdir = "$CFG->dataroot/temp";
 142 }
 143
 144 // Allow overriding of cachedir but be backwards compatible
 145 if (!isset($CFG->cachedir)) {
 146     $CFG->cachedir = "$CFG->dataroot/cache";
 147 }
 148
 149 // The current directory in PHP version 4.3.0 and above isn't necessarily the
 150 // directory of the script when run from the command line. The require_once()
 151 // would fail, so we'll have to chdir()
 152 if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
 153     // do it only once - skip the second time when continuing after prevous abort
 154     if (!defined('ABORT_AFTER_CONFIG') and !defined('ABORT_AFTER_CONFIG_CANCEL')) {
 155         chdir(dirname($_SERVER['argv'][0]));
 156     }
 157 }
 158
 159 // sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that??
 160 ini_set('precision', 14); // needed for upgrades and gradebook
 161
 162 // Scripts may request no debug and error messages in output
 163 // please note it must be defined before including the config.php script
 164 // and in some cases you also need to set custom default exception handler
 165 if (!defined('NO_DEBUG_DISPLAY')) {
 166     define('NO_DEBUG_DISPLAY', false);
 167 }
 168
 169 // Some scripts such as upgrade may want to prevent output buffering
 170 if (!defined('NO_OUTPUT_BUFFERING')) {
 171     define('NO_OUTPUT_BUFFERING', false);
 172 }
 173
 174 // PHPUnit tests need custom init
 175 if (!defined('PHPUNIT_TEST')) {
 176     define('PHPUNIT_TEST', false);
 177 }
 178
 179 // When set to true MUC (Moodle caching) will be disabled as much as possible.
 180 // A special cache factory will be used to handle this situation and will use special "disabled" equivalents objects.
 181 // This ensure we don't attempt to read or create the config file, don't use stores, don't provide persistence or
 182 // storage of any kind.
 183 if (!defined('CACHE_DISABLE_ALL')) {
 184     define('CACHE_DISABLE_ALL', false);
 185 }
 186
 187 // When set to true MUC (Moodle caching) will not use any of the defined or default stores.
 188 // The Cache API will continue to function however this will force the use of the cachestore_dummy so all requests
 189 // will be interacting with a static property and will never go to the proper cache stores.
 190 // Useful if you need to avoid the stores for one reason or another.
 191 if (!defined('CACHE_DISABLE_STORES')) {
 192     define('CACHE_DISABLE_STORES', false);
 193 }
 194
 195 // Servers should define a default timezone in php.ini, but if they don't then make sure something is defined.
 196 // This is a quick hack.  Ideally we should ask the admin for a value.  See MDL-22625 for more on this.
 197 if (function_exists('date_default_timezone_set') and function_exists('date_default_timezone_get')) {
 198     $olddebug = error_reporting(0);
 199     date_default_timezone_set(date_default_timezone_get());
 200     error_reporting($olddebug);
 201     unset($olddebug);
 202 }
 203
 204 // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output
 205 // In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php.
 206 // Please note that one script can not be accessed from both CLI and web interface.
 207 if (!defined('CLI_SCRIPT')) {
 208     define('CLI_SCRIPT', false);
 209 }
 210 if (defined('WEB_CRON_EMULATED_CLI')) {
 211     if (!isset($_SERVER['REMOTE_ADDR'])) {
 212         echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n");
 213         exit(1);
 214     }
 215 } else if (isset($_SERVER['REMOTE_ADDR'])) {
 216     if (CLI_SCRIPT) {
 217         echo('Command line scripts can not be executed from the web interface');
 218         exit(1);
 219     }
 220 } else {
 221     if (!CLI_SCRIPT) {
 222         echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
 223         exit(1);
 224     }
 225 }
 226
 227 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades
 228 if (file_exists("$CFG->dataroot/climaintenance.html")) {
 229     if (!CLI_SCRIPT) {
 230         header('Content-type: text/html; charset=utf-8');
 231         header('X-UA-Compatible: IE=edge');
 232         /// Headers to make it not cacheable and json
 233         header('Cache-Control: no-store, no-cache, must-revalidate');
 234         header('Cache-Control: post-check=0, pre-check=0', false);
 235         header('Pragma: no-cache');
 236         header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
 237         header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
 238         header('Accept-Ranges: none');
 239         readfile("$CFG->dataroot/climaintenance.html");
 240         die;
 241     } else {
 242         if (!defined('CLI_MAINTENANCE')) {
 243             define('CLI_MAINTENANCE', true);
 244         }
 245     }
 246 } else {
 247     if (!defined('CLI_MAINTENANCE')) {
 248         define('CLI_MAINTENANCE', false);
 249     }
 250 }
 251
 252 if (CLI_SCRIPT) {
 253     // sometimes people use different PHP binary for web and CLI, make 100% sure they have the supported PHP version
 254     if (version_compare(phpversion(), '5.3.2') < 0) {
 255         $phpversion = phpversion();
 256         // do NOT localise - lang strings would not work here and we CAN NOT move it to later place
 257         echo "Moodle 2.1 or later requires at least PHP 5.3.2 (currently using version $phpversion).\n";
 258         echo "Some servers may have multiple PHP versions installed, are you using the correct executable?\n";
 259         exit(1);
 260     }
 261 }
 262
 263 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
 264 if (!defined('AJAX_SCRIPT')) {
 265     define('AJAX_SCRIPT', false);
 266 }
 267
 268 // File permissions on created directories in the $CFG->dataroot
 269 if (empty($CFG->directorypermissions)) {
 270     $CFG->directorypermissions = 02777;      // Must be octal (that's why it's here)
 271 }
 272 if (empty($CFG->filepermissions)) {
 273     $CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags
 274 }
 275 // better also set default umask because recursive mkdir() does not apply permissions recursively otherwise
 276 umask(0000);
 277
 278 // exact version of currently used yui2 and 3 library
 279 $CFG->yui2version = '2.9.0';
 280 $CFG->yui3version = '3.9.0';
 281
 282
 283 // special support for highly optimised scripts that do not need libraries and DB connection
 284 if (defined('ABORT_AFTER_CONFIG')) {
 285     if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
 286         // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
 287         if (isset($CFG->debug)) {
 288             error_reporting($CFG->debug);
 289         } else {
 290             error_reporting(0);
 291         }
 292         if (NO_DEBUG_DISPLAY) {
 293             // Some parts of Moodle cannot display errors and debug at all.
 294             ini_set('display_errors', '0');
 295             ini_set('log_errors', '1');
 296         } else if (empty($CFG->debugdisplay)) {
 297             ini_set('display_errors', '0');
 298             ini_set('log_errors', '1');
 299         } else {
 300             ini_set('display_errors', '1');
 301         }
 302         require_once("$CFG->dirroot/lib/configonlylib.php");
 303         return;
 304     }
 305 }
 306
 307 /** Used by library scripts to check they are being called by Moodle */
 308 if (!defined('MOODLE_INTERNAL')) { // necessary because cli installer has to define it earlier
 309     define('MOODLE_INTERNAL', true);
 310 }
 311
 312 // Early profiling start, based exclusively on config.php $CFG settings
 313 if (!empty($CFG->earlyprofilingenabled)) {
 314     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
 315     if (profiling_start()) {
 316         register_shutdown_function('profiling_stop');
 317     }
 318 }
 319
 320 /**
 321  * Database connection. Used for all access to the database.
 322  * @global moodle_database $DB
 323  * @name $DB
 324  */
 325 global $DB;
 326
 327 /**
 328  * Moodle's wrapper round PHP's $_SESSION.
 329  *
 330  * @global object $SESSION
 331  * @name $SESSION
 332  */
 333 global $SESSION;
 334
 335 /**
 336  * Holds the user table record for the current user. Will be the 'guest'
 337  * user record for people who are not logged in.
 338  *
 339  * $USER is stored in the session.
 340  *
 341  * Items found in the user record:
 342  *  - $USER->email - The user's email address.
 343  *  - $USER->id - The unique integer identified of this user in the 'user' table.
 344  *  - $USER->email - The user's email address.
 345  *  - $USER->firstname - The user's first name.
 346  *  - $USER->lastname - The user's last name.
 347  *  - $USER->username - The user's login username.
 348  *  - $USER->secret - The user's ?.
 349  *  - $USER->lang - The user's language choice.
 350  *
 351  * @global object $USER
 352  * @name $USER
 353  */
 354 global $USER;
 355
 356 /**
 357  * Frontpage course record
 358  */
 359 global $SITE;
 360
 361 /**
 362  * A central store of information about the current page we are
 363  * generating in response to the user's request.
 364  *
 365  * @global moodle_page $PAGE
 366  * @name $PAGE
 367  */
 368 global $PAGE;
 369
 370 /**
 371  * The current course. An alias for $PAGE->course.
 372  * @global object $COURSE
 373  * @name $COURSE
 374  */
 375 global $COURSE;
 376
 377 /**
 378  * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
 379  * it to generate HTML for output.
 380  *
 381  * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
 382  * for the magic that does that. After $OUTPUT has been initialised, any attempt
 383  * to change something that affects the current theme ($PAGE->course, logged in use,
 384  * httpsrequried ... will result in an exception.)
 385  *
 386  * Please note the $OUTPUT is replacing the old global $THEME object.
 387  *
 388  * @global object $OUTPUT
 389  * @name $OUTPUT
 390  */
 391 global $OUTPUT;
 392
 393 /**
 394  * Full script path including all params, slash arguments, scheme and host.
 395  *
 396  * Note: Do NOT use for getting of current page URL or detection of https,
 397  * instead use $PAGE->url or strpos($CFG->httpswwwroot, 'https:') === 0
 398  *
 399  * @global string $FULLME
 400  * @name $FULLME
 401  */
 402 global $FULLME;
 403
 404 /**
 405  * Script path including query string and slash arguments without host.
 406  * @global string $ME
 407  * @name $ME
 408  */
 409 global $ME;
 410
 411 /**
 412  * $FULLME without slasharguments and query string.
 413  * @global string $FULLSCRIPT
 414  * @name $FULLSCRIPT
 415  */
 416 global $FULLSCRIPT;
 417
 418 /**
 419  * Relative moodle script path '/course/view.php'
 420  * @global string $SCRIPT
 421  * @name $SCRIPT
 422  */
 423 global $SCRIPT;
 424
 425 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides
 426 $CFG->config_php_settings = (array)$CFG;
 427 // Forced plugin settings override values from config_plugins table
 428 unset($CFG->config_php_settings['forced_plugin_settings']);
 429 if (!isset($CFG->forced_plugin_settings)) {
 430     $CFG->forced_plugin_settings = array();
 431 }
 432 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
 433 // inside some URLs used in HTTPSPAGEREQUIRED pages.
 434 $CFG->httpswwwroot = $CFG->wwwroot;
 435
 436 require_once($CFG->libdir .'/setuplib.php');        // Functions that MUST be loaded first
 437
 438 if (NO_OUTPUT_BUFFERING) {
 439     // we have to call this always before starting session because it discards headers!
 440     disable_output_buffering();
 441 }
 442
 443 // Increase memory limits if possible
 444 raise_memory_limit(MEMORY_STANDARD);
 445
 446 // Time to start counting
 447 init_performance_info();
 448
 449 // Put $OUTPUT in place, so errors can be displayed.
 450 $OUTPUT = new bootstrap_renderer();
 451
 452 // set handler for uncaught exceptions - equivalent to print_error() call
 453 if (!PHPUNIT_TEST or PHPUNIT_UTIL) {
 454     set_exception_handler('default_exception_handler');
 455     set_error_handler('default_error_handler', E_ALL | E_STRICT);
 456 }
 457
 458 // If there are any errors in the standard libraries we want to know!
 459 error_reporting(E_ALL | E_STRICT);
 460
 461 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
 462 // http://www.google.com/webmasters/faq.html#prefetchblock
 463 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
 464     header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
 465     echo('Prefetch request forbidden.');
 466     exit(1);
 467 }
 468
 469 if (!isset($CFG->prefix)) {   // Just in case it isn't defined in config.php
 470     $CFG->prefix = '';
 471 }
 472
 473 // location of all languages except core English pack
 474 if (!isset($CFG->langotherroot)) {
 475     $CFG->langotherroot = $CFG->dataroot.'/lang';
 476 }
 477
 478 // location of local lang pack customisations (dirs with _local suffix)
 479 if (!isset($CFG->langlocalroot)) {
 480     $CFG->langlocalroot = $CFG->dataroot.'/lang';
 481 }
 482
 483 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
 484 //the problem is that we need specific version of quickforms and hacked excel files :-(
 485 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
 486 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
 487 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
 488 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
 489
 490 // Load up standard libraries
 491 require_once($CFG->libdir .'/textlib.class.php');   // Functions to handle multibyte strings
 492 require_once($CFG->libdir .'/filterlib.php');       // Functions for filtering test as it is output
 493 require_once($CFG->libdir .'/ajax/ajaxlib.php');    // Functions for managing our use of JavaScript and YUI
 494 require_once($CFG->libdir .'/weblib.php');          // Functions relating to HTTP and content
 495 require_once($CFG->libdir .'/outputlib.php');       // Functions for generating output
 496 require_once($CFG->libdir .'/navigationlib.php');   // Class for generating Navigation structure
 497 require_once($CFG->libdir .'/dmllib.php');          // Database access
 498 require_once($CFG->libdir .'/datalib.php');         // Legacy lib with a big-mix of functions.
 499 require_once($CFG->libdir .'/accesslib.php');       // Access control functions
 500 require_once($CFG->libdir .'/deprecatedlib.php');   // Deprecated functions included for backward compatibility
 501 require_once($CFG->libdir .'/moodlelib.php');       // Other general-purpose functions
 502 require_once($CFG->libdir .'/enrollib.php');        // Enrolment related functions
 503 require_once($CFG->libdir .'/pagelib.php');         // Library that defines the moodle_page class, used for $PAGE
 504 require_once($CFG->libdir .'/blocklib.php');        // Library for controlling blocks
 505 require_once($CFG->libdir .'/eventslib.php');       // Events functions
 506 require_once($CFG->libdir .'/grouplib.php');        // Groups functions
 507 require_once($CFG->libdir .'/sessionlib.php');      // All session and cookie related stuff
 508 require_once($CFG->libdir .'/editorlib.php');       // All text editor related functions and classes
 509 require_once($CFG->libdir .'/messagelib.php');      // Messagelib functions
 510 require_once($CFG->libdir .'/modinfolib.php');      // Cached information on course-module instances
 511 require_once($CFG->dirroot.'/cache/lib.php');       // Cache API
 512
 513 // make sure PHP is not severly misconfigured
 514 setup_validate_php_configuration();
 515
 516 // Connect to the database
 517 setup_DB();
 518
 519 if (PHPUNIT_TEST and !PHPUNIT_UTIL) {
 520     // make sure tests do not run in parallel
 521     test_lock::acquire('phpunit');
 522     $dbhash = null;
 523     try {
 524         if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) {
 525             // reset DB tables
 526             phpunit_util::reset_database();
 527         }
 528     } catch (Exception $e) {
 529         if ($dbhash) {
 530             // we ned to reinit if reset fails
 531             $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest'));
 532         }
 533     }
 534     unset($dbhash);
 535 }
 536
 537 // Disable errors for now - needed for installation when debug enabled in config.php
 538 if (isset($CFG->debug)) {
 539     $originalconfigdebug = $CFG->debug;
 540     unset($CFG->debug);
 541 } else {
 542     $originalconfigdebug = null;
 543 }
 544
 545 // Load up any configuration from the config table
 546
 547 if (PHPUNIT_TEST) {
 548     phpunit_util::initialise_cfg();
 549 } else {
 550     initialise_cfg();
 551 }
 552
 553 // Verify upgrade is not running unless we are in a script that needs to execute in any case
 554 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
 555     if ($CFG->upgraderunning < time()) {
 556         unset_config('upgraderunning');
 557     } else {
 558         print_error('upgraderunning');
 559     }
 560 }
 561
 562 // Turn on SQL logging if required
 563 if (!empty($CFG->logsql)) {
 564     $DB->set_logging(true);
 565 }
 566
 567 // Prevent warnings from roles when upgrading with debug on
 568 if (isset($CFG->debug)) {
 569     $originaldatabasedebug = $CFG->debug;
 570     unset($CFG->debug);
 571 } else {
 572     $originaldatabasedebug = null;
 573 }
 574
 575 // enable circular reference collector in PHP 5.3,
 576 // it helps a lot when using large complex OOP structures such as in amos or gradebook
 577 if (function_exists('gc_enable')) {
 578     gc_enable();
 579 }
 580
 581 // Register default shutdown tasks - such as Apache memory release helper, perf logging, etc.
 582 if (function_exists('register_shutdown_function')) {
 583     register_shutdown_function('moodle_request_shutdown');
 584 }
 585
 586 // Set error reporting back to normal
 587 if ($originaldatabasedebug === null) {
 588     $CFG->debug = DEBUG_MINIMAL;
 589 } else {
 590     $CFG->debug = $originaldatabasedebug;
 591 }
 592 if ($originalconfigdebug !== null) {
 593     $CFG->debug = $originalconfigdebug;
 594 }
 595 unset($originalconfigdebug);
 596 unset($originaldatabasedebug);
 597 error_reporting($CFG->debug);
 598
 599 // find out if PHP configured to display warnings,
 600 // this is a security problem because some moodle scripts may
 601 // disclose sensitive information
 602 if (ini_get_bool('display_errors')) {
 603     define('WARN_DISPLAY_ERRORS_ENABLED', true);
 604 }
 605 // If we want to display Moodle errors, then try and set PHP errors to match
 606 if (!isset($CFG->debugdisplay)) {
 607     // keep it "as is" during installation
 608 } else if (NO_DEBUG_DISPLAY) {
 609     // some parts of Moodle cannot display errors and debug at all.
 610     ini_set('display_errors', '0');
 611     ini_set('log_errors', '1');
 612 } else if (empty($CFG->debugdisplay)) {
 613     ini_set('display_errors', '0');
 614     ini_set('log_errors', '1');
 615 } else {
 616     // This is very problematic in XHTML strict mode!
 617     ini_set('display_errors', '1');
 618 }
 619
 620 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
 621 if (!empty($CFG->version) and $CFG->version < 2007101509) {
 622     print_error('upgraderequires19', 'error');
 623     die;
 624 }
 625
 626 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
 627 // - WINDOWS: for any Windows flavour.
 628 // - UNIX: for the rest
 629 // Also, $CFG->os can continue being used if more specialization is required
 630 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
 631     $CFG->ostype = 'WINDOWS';
 632 } else {
 633     $CFG->ostype = 'UNIX';
 634 }
 635 $CFG->os = PHP_OS;
 636
 637 // Configure ampersands in URLs
 638 ini_set('arg_separator.output', '&amp;');
 639
 640 // Work around for a PHP bug   see MDL-11237
 641 ini_set('pcre.backtrack_limit', 20971520);  // 20 MB
 642
 643 // Location of standard files
 644 $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
 645 $CFG->moddata  = 'moddata';
 646
 647 // A hack to get around magic_quotes_gpc being turned on
 648 // It is strongly recommended to disable "magic_quotes_gpc"!
 649 if (ini_get_bool('magic_quotes_gpc')) {
 650     function stripslashes_deep($value) {
 651         $value = is_array($value) ?
 652                 array_map('stripslashes_deep', $value) :
 653                 stripslashes($value);
 654         return $value;
 655     }
 656     $_POST = array_map('stripslashes_deep', $_POST);
 657     $_GET = array_map('stripslashes_deep', $_GET);
 658     $_COOKIE = array_map('stripslashes_deep', $_COOKIE);
 659     $_REQUEST = array_map('stripslashes_deep', $_REQUEST);
 660     if (!empty($_SERVER['REQUEST_URI'])) {
 661         $_SERVER['REQUEST_URI'] = stripslashes($_SERVER['REQUEST_URI']);
 662     }
 663     if (!empty($_SERVER['QUERY_STRING'])) {
 664         $_SERVER['QUERY_STRING'] = stripslashes($_SERVER['QUERY_STRING']);
 665     }
 666     if (!empty($_SERVER['HTTP_REFERER'])) {
 667         $_SERVER['HTTP_REFERER'] = stripslashes($_SERVER['HTTP_REFERER']);
 668     }
 669    if (!empty($_SERVER['PATH_INFO'])) {
 670         $_SERVER['PATH_INFO'] = stripslashes($_SERVER['PATH_INFO']);
 671     }
 672     if (!empty($_SERVER['PHP_SELF'])) {
 673         $_SERVER['PHP_SELF'] = stripslashes($_SERVER['PHP_SELF']);
 674     }
 675     if (!empty($_SERVER['PATH_TRANSLATED'])) {
 676         $_SERVER['PATH_TRANSLATED'] = stripslashes($_SERVER['PATH_TRANSLATED']);
 677     }
 678 }
 679
 680 // neutralise nasty chars in PHP_SELF
 681 if (isset($_SERVER['PHP_SELF'])) {
 682     $phppos = strpos($_SERVER['PHP_SELF'], '.php');
 683     if ($phppos !== false) {
 684         $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
 685     }
 686     unset($phppos);
 687 }
 688
 689 // initialise ME's - this must be done BEFORE starting of session!
 690 initialise_fullme();
 691
 692 // define SYSCONTEXTID in config.php if you want to save some queries,
 693 // after install it must match the system context record id.
 694 if (!defined('SYSCONTEXTID')) {
 695     get_system_context();
 696 }
 697
 698 // Defining the site - aka frontpage course
 699 try {
 700     $SITE = get_site();
 701 } catch (dml_exception $e) {
 702     $SITE = null;
 703     if (empty($CFG->version)) {
 704         $SITE = new stdClass();
 705         $SITE->id = 1;
 706     } else {
 707         throw $e;
 708     }
 709 }
 710 // And the 'default' course - this will usually get reset later in require_login() etc.
 711 $COURSE = clone($SITE);
 712 /** @deprecated Id of the frontpage course, use $SITE->id instead */
 713 define('SITEID', $SITE->id);
 714
 715 // init session prevention flag - this is defined on pages that do not want session
 716 if (CLI_SCRIPT) {
 717     // no sessions in CLI scripts possible
 718     define('NO_MOODLE_COOKIES', true);
 719
 720 } else if (!defined('NO_MOODLE_COOKIES')) {
 721     if (empty($CFG->version) or $CFG->version < 2009011900) {
 722         // no session before sessions table gets created
 723         define('NO_MOODLE_COOKIES', true);
 724     } else if (CLI_SCRIPT) {
 725         // CLI scripts can not have session
 726         define('NO_MOODLE_COOKIES', true);
 727     } else {
 728         define('NO_MOODLE_COOKIES', false);
 729     }
 730 }
 731
 732 // start session and prepare global $SESSION, $USER
 733 session_get_instance();
 734 $SESSION = &$_SESSION['SESSION'];
 735 $USER    = &$_SESSION['USER'];
 736
 737 // Late profiling, only happening if early one wasn't started
 738 if (!empty($CFG->profilingenabled)) {
 739     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
 740     if (profiling_start()) {
 741         register_shutdown_function('profiling_stop');
 742     }
 743 }
 744
 745 // Process theme change in the URL.
 746 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
 747     // we have to use _GET directly because we do not want this to interfere with _POST
 748     $urlthemename = optional_param('theme', '', PARAM_PLUGIN);
 749     try {
 750         $themeconfig = theme_config::load($urlthemename);
 751         // Makes sure the theme can be loaded without errors.
 752         if ($themeconfig->name === $urlthemename) {
 753             $SESSION->theme = $urlthemename;
 754         } else {
 755             unset($SESSION->theme);
 756         }
 757         unset($themeconfig);
 758         unset($urlthemename);
 759     } catch (Exception $e) {
 760         debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
 761     }
 762 }
 763 unset($urlthemename);
 764
 765 // Ensure a valid theme is set.
 766 if (!isset($CFG->theme)) {
 767     $CFG->theme = 'standardwhite';
 768 }
 769
 770 // Set language/locale of printed times.  If user has chosen a language that
 771 // that is different from the site language, then use the locale specified
 772 // in the language file.  Otherwise, if the admin hasn't specified a locale
 773 // then use the one from the default language.  Otherwise (and this is the
 774 // majority of cases), use the stored locale specified by admin.
 775 // note: do not accept lang parameter from POST
 776 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
 777     if (get_string_manager()->translation_exists($lang, false)) {
 778         $SESSION->lang = $lang;
 779     }
 780 }
 781 unset($lang);
 782
 783 setup_lang_from_browser();
 784
 785 if (empty($CFG->lang)) {
 786     if (empty($SESSION->lang)) {
 787         $CFG->lang = 'en';
 788     } else {
 789         $CFG->lang = $SESSION->lang;
 790     }
 791 }
 792
 793 // Set the default site locale, a lot of the stuff may depend on this
 794 // it is definitely too late to call this first in require_login()!
 795 moodle_setlocale();
 796
 797 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup!
 798 if (!empty($CFG->moodlepageclass)) {
 799     if (!empty($CFG->moodlepageclassfile)) {
 800         require_once($CFG->moodlepageclassfile);
 801     }
 802     $classname = $CFG->moodlepageclass;
 803 } else {
 804     $classname = 'moodle_page';
 805 }
 806 $PAGE = new $classname();
 807 unset($classname);
 808
 809
 810 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
 811     if ($CFG->theme == 'standard' or $CFG->theme == 'standardwhite') {    // Temporary measure to help with XHTML validation
 812         if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) {      // Allow W3CValidator in as user called w3cvalidator (or guest)
 813             if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
 814                 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
 815                 if ($user = get_complete_user_data("username", "w3cvalidator")) {
 816                     $user->ignoresesskey = true;
 817                 } else {
 818                     $user = guest_user();
 819                 }
 820                 session_set_user($user);
 821             }
 822         }
 823     }
 824 }
 825
 826 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
 827 // LogFormat to get the current logged in username in moodle.
 828 if ($USER && function_exists('apache_note')
 829     && !empty($CFG->apacheloguser) && isset($USER->username)) {
 830     $apachelog_userid = $USER->id;
 831     $apachelog_username = clean_filename($USER->username);
 832     $apachelog_name = '';
 833     if (isset($USER->firstname)) {
 834         // We can assume both will be set
 835         // - even if to empty.
 836         $apachelog_name = clean_filename($USER->firstname . " " .
 837                                          $USER->lastname);
 838     }
 839     if (session_is_loggedinas()) {
 840         $realuser = session_get_realuser();
 841         $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
 842         $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
 843         $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
 844     }
 845     switch ($CFG->apacheloguser) {
 846         case 3:
 847             $logname = $apachelog_username;
 848             break;
 849         case 2:
 850             $logname = $apachelog_name;
 851             break;
 852         case 1:
 853         default:
 854             $logname = $apachelog_userid;
 855             break;
 856     }
 857     apache_note('MOODLEUSER', $logname);
 858 }
 859
 860 // Use a custom script replacement if one exists
 861 if (!empty($CFG->customscripts)) {
 862     if (($customscript = custom_script_path()) !== false) {
 863         require ($customscript);
 864     }
 865 }
 866
 867 if (PHPUNIT_TEST) {
 868     // no ip blocking, these are CLI only
 869 } else if (CLI_SCRIPT and !defined('WEB_CRON_EMULATED_CLI')) {
 870     // no ip blocking
 871 } else if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
 872     // in this case, ip in allowed list will be performed first
 873     // for example, client IP is 192.168.1.1
 874     // 192.168 subnet is an entry in allowed list
 875     // 192.168.1.1 is banned in blocked list
 876     // This ip will be banned finally
 877     if (!empty($CFG->allowedip)) {
 878         if (!remoteip_in_list($CFG->allowedip)) {
 879             die(get_string('ipblocked', 'admin'));
 880         }
 881     }
 882     // need further check, client ip may a part of
 883     // allowed subnet, but a IP address are listed
 884     // in blocked list.
 885     if (!empty($CFG->blockedip)) {
 886         if (remoteip_in_list($CFG->blockedip)) {
 887             die(get_string('ipblocked', 'admin'));
 888         }
 889     }
 890
 891 } else {
 892     // in this case, IPs in blocked list will be performed first
 893     // for example, client IP is 192.168.1.1
 894     // 192.168 subnet is an entry in blocked list
 895     // 192.168.1.1 is allowed in allowed list
 896     // This ip will be allowed finally
 897     if (!empty($CFG->blockedip)) {
 898         if (remoteip_in_list($CFG->blockedip)) {
 899             // if the allowed ip list is not empty
 900             // IPs are not included in the allowed list will be
 901             // blocked too
 902             if (!empty($CFG->allowedip)) {
 903                 if (!remoteip_in_list($CFG->allowedip)) {
 904                     die(get_string('ipblocked', 'admin'));
 905                 }
 906             } else {
 907                 die(get_string('ipblocked', 'admin'));
 908             }
 909         }
 910     }
 911     // if blocked list is null
 912     // allowed list should be tested
 913     if(!empty($CFG->allowedip)) {
 914         if (!remoteip_in_list($CFG->allowedip)) {
 915             die(get_string('ipblocked', 'admin'));
 916         }
 917     }
 918
 919 }
 920
 921 // // try to detect IE6 and prevent gzip because it is extremely buggy browser
 922 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) {
 923     @ini_set('zlib.output_compression', 'Off');
 924     if (function_exists('apache_setenv')) {
 925         @apache_setenv('no-gzip', 1);
 926     }
 927 }
 928
 929 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised.
 930 if (isset($CFG->maintenance_later) and $CFG->maintenance_later <= time()) {
 931     if (!file_exists("$CFG->dataroot/climaintenance.html")) {
 932         require_once("$CFG->libdir/adminlib.php");
 933         enable_cli_maintenance_mode();
 934     }
 935     unset_config('maintenance_later');
 936     if (AJAX_SCRIPT) {
 937         die;
 938     } else if (!CLI_SCRIPT) {
 939         redirect(new moodle_url('/'));
 940     }
 941 }
 942
 943 // note: we can not block non utf-8 installations here, because empty mysql database
 944 // might be converted to utf-8 in admin/index.php during installation
 945
 946
 947
 948 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
 949 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
 950 if (false) {
 951     $DB = new moodle_database();
 952     $OUTPUT = new core_renderer(null, null);
 953     $PAGE = new moodle_page();
 954 }