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