lib/setup.php

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