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