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