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