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