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