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