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