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