MDL-24419 (2): Moved groupings cache to get_all_groupings function
[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  * Cache used within grouplib to cache data within current request only.
347  *
348  * @global object $GROUPLLIB_CACHE
349  * @name $GROUPLIB_CACHE
350  */
351 global $GROUPLIB_CACHE;
353 /**
354  * Full script path including all params, slash arguments, scheme and host.
355  *
356  * Note: Do NOT use for getting of current page URL or detection of https,
357  * instead use $PAGE->url or strpos($CFG->httpswwwroot, 'https:') === 0
358  *
359  * @global string $FULLME
360  * @name $FULLME
361  */
362 global $FULLME;
364 /**
365  * Script path including query string and slash arguments without host.
366  * @global string $ME
367  * @name $ME
368  */
369 global $ME;
371 /**
372  * $FULLME without slasharguments and query string.
373  * @global string $FULLSCRIPT
374  * @name $FULLSCRIPT
375  */
376 global $FULLSCRIPT;
378 /**
379  * Relative moodle script path '/course/view.php'
380  * @global string $SCRIPT
381  * @name $SCRIPT
382  */
383 global $SCRIPT;
385 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides
386 $CFG->config_php_settings = (array)$CFG;
387 // Forced plugin settings override values from config_plugins table
388 unset($CFG->config_php_settings['forced_plugin_settings']);
389 if (!isset($CFG->forced_plugin_settings)) {
390     $CFG->forced_plugin_settings = array();
392 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
393 // inside some URLs used in HTTPSPAGEREQUIRED pages.
394 $CFG->httpswwwroot = $CFG->wwwroot;
396 require_once($CFG->libdir .'/setuplib.php');        // Functions that MUST be loaded first
398 if (NO_OUTPUT_BUFFERING) {
399     // we have to call this always before starting session because it discards headers!
400     disable_output_buffering();
403 // Increase memory limits if possible
404 raise_memory_limit(MEMORY_STANDARD);
406 // Time to start counting
407 init_performance_info();
409 // Put $OUTPUT in place, so errors can be displayed.
410 $OUTPUT = new bootstrap_renderer();
412 // set handler for uncaught exceptions - equivalent to print_error() call
413 if (!PHPUNIT_TEST or PHPUNIT_UTIL) {
414     set_exception_handler('default_exception_handler');
415     set_error_handler('default_error_handler', E_ALL | E_STRICT);
418 // If there are any errors in the standard libraries we want to know!
419 error_reporting(E_ALL | E_STRICT);
421 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
422 // http://www.google.com/webmasters/faq.html#prefetchblock
423 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
424     header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
425     echo('Prefetch request forbidden.');
426     exit(1);
429 if (!isset($CFG->prefix)) {   // Just in case it isn't defined in config.php
430     $CFG->prefix = '';
433 // location of all languages except core English pack
434 if (!isset($CFG->langotherroot)) {
435     $CFG->langotherroot = $CFG->dataroot.'/lang';
438 // location of local lang pack customisations (dirs with _local suffix)
439 if (!isset($CFG->langlocalroot)) {
440     $CFG->langlocalroot = $CFG->dataroot.'/lang';
443 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
444 //the problem is that we need specific version of quickforms and hacked excel files :-(
445 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
446 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
447 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
448 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
450 // Load up standard libraries
451 require_once($CFG->libdir .'/textlib.class.php');   // Functions to handle multibyte strings
452 require_once($CFG->libdir .'/filterlib.php');       // Functions for filtering test as it is output
453 require_once($CFG->libdir .'/ajax/ajaxlib.php');    // Functions for managing our use of JavaScript and YUI
454 require_once($CFG->libdir .'/weblib.php');          // Functions relating to HTTP and content
455 require_once($CFG->libdir .'/outputlib.php');       // Functions for generating output
456 require_once($CFG->libdir .'/navigationlib.php');   // Class for generating Navigation structure
457 require_once($CFG->libdir .'/dmllib.php');          // Database access
458 require_once($CFG->libdir .'/datalib.php');         // Legacy lib with a big-mix of functions.
459 require_once($CFG->libdir .'/accesslib.php');       // Access control functions
460 require_once($CFG->libdir .'/deprecatedlib.php');   // Deprecated functions included for backward compatibility
461 require_once($CFG->libdir .'/moodlelib.php');       // Other general-purpose functions
462 require_once($CFG->libdir .'/enrollib.php');        // Enrolment related functions
463 require_once($CFG->libdir .'/pagelib.php');         // Library that defines the moodle_page class, used for $PAGE
464 require_once($CFG->libdir .'/blocklib.php');        // Library for controlling blocks
465 require_once($CFG->libdir .'/eventslib.php');       // Events functions
466 require_once($CFG->libdir .'/grouplib.php');        // Groups functions
467 require_once($CFG->libdir .'/sessionlib.php');      // All session and cookie related stuff
468 require_once($CFG->libdir .'/editorlib.php');       // All text editor related functions and classes
469 require_once($CFG->libdir .'/messagelib.php');      // Messagelib functions
470 require_once($CFG->libdir .'/modinfolib.php');      // Cached information on course-module instances
472 // make sure PHP is not severly misconfigured
473 setup_validate_php_configuration();
475 // Connect to the database
476 setup_DB();
478 if (PHPUNIT_TEST and !PHPUNIT_UTIL) {
479     // make sure tests do not run in parallel
480     phpunit_util::acquire_test_lock();
481     // reset DB tables
482     phpunit_util::reset_database();
485 // Disable errors for now - needed for installation when debug enabled in config.php
486 if (isset($CFG->debug)) {
487     $originalconfigdebug = $CFG->debug;
488     unset($CFG->debug);
489 } else {
490     $originalconfigdebug = null;
493 // Load up any configuration from the config table
495 if (PHPUNIT_TEST) {
496     phpunit_util::initialise_cfg();
497 } else {
498     initialise_cfg();
501 // Verify upgrade is not running unless we are in a script that needs to execute in any case
502 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
503     if ($CFG->upgraderunning < time()) {
504         unset_config('upgraderunning');
505     } else {
506         print_error('upgraderunning');
507     }
510 // Turn on SQL logging if required
511 if (!empty($CFG->logsql)) {
512     $DB->set_logging(true);
515 // Prevent warnings from roles when upgrading with debug on
516 if (isset($CFG->debug)) {
517     $originaldatabasedebug = $CFG->debug;
518     unset($CFG->debug);
519 } else {
520     $originaldatabasedebug = null;
523 // enable circular reference collector in PHP 5.3,
524 // it helps a lot when using large complex OOP structures such as in amos or gradebook
525 if (function_exists('gc_enable')) {
526     gc_enable();
529 // Register default shutdown tasks - such as Apache memory release helper, perf logging, etc.
530 if (function_exists('register_shutdown_function')) {
531     register_shutdown_function('moodle_request_shutdown');
534 // Set error reporting back to normal
535 if ($originaldatabasedebug === null) {
536     $CFG->debug = DEBUG_MINIMAL;
537 } else {
538     $CFG->debug = $originaldatabasedebug;
540 if ($originalconfigdebug !== null) {
541     $CFG->debug = $originalconfigdebug;
543 unset($originalconfigdebug);
544 unset($originaldatabasedebug);
545 error_reporting($CFG->debug);
547 // find out if PHP configured to display warnings,
548 // this is a security problem because some moodle scripts may
549 // disclose sensitive information
550 if (ini_get_bool('display_errors')) {
551     define('WARN_DISPLAY_ERRORS_ENABLED', true);
553 // If we want to display Moodle errors, then try and set PHP errors to match
554 if (!isset($CFG->debugdisplay)) {
555     // keep it "as is" during installation
556 } else if (NO_DEBUG_DISPLAY) {
557     // some parts of Moodle cannot display errors and debug at all.
558     ini_set('display_errors', '0');
559     ini_set('log_errors', '1');
560 } else if (empty($CFG->debugdisplay)) {
561     ini_set('display_errors', '0');
562     ini_set('log_errors', '1');
563 } else {
564     // This is very problematic in XHTML strict mode!
565     ini_set('display_errors', '1');
568 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
569 if (!empty($CFG->version) and $CFG->version < 2007101509) {
570     print_error('upgraderequires19', 'error');
571     die;
574 // Shared-Memory cache init -- will set $MCACHE
575 // $MCACHE is a global object that offers at least add(), set() and delete()
576 // with similar semantics to the memcached PHP API http://php.net/memcache
577 // Ensure we define rcache - so we can later check for it
578 // with a really fast and unambiguous $CFG->rcache === false
579 if (!empty($CFG->cachetype)) {
580     if (empty($CFG->rcache)) {
581         $CFG->rcache = false;
582     } else {
583         $CFG->rcache = true;
584     }
586     // do not try to initialize if cache disabled
587     if (!$CFG->rcache) {
588         $CFG->cachetype = '';
589     }
591     if ($CFG->cachetype === 'memcached' && !empty($CFG->memcachedhosts)) {
592         if (!init_memcached()) {
593             debugging("Error initialising memcached");
594             $CFG->cachetype = '';
595             $CFG->rcache = false;
596         }
597     } else if ($CFG->cachetype === 'eaccelerator') {
598         if (!init_eaccelerator()) {
599             debugging("Error initialising eaccelerator cache");
600             $CFG->cachetype = '';
601             $CFG->rcache = false;
602         }
603     }
605 } else { // just make sure it is defined
606     $CFG->cachetype = '';
607     $CFG->rcache    = false;
610 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
611 // - WINDOWS: for any Windows flavour.
612 // - UNIX: for the rest
613 // Also, $CFG->os can continue being used if more specialization is required
614 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
615     $CFG->ostype = 'WINDOWS';
616 } else {
617     $CFG->ostype = 'UNIX';
619 $CFG->os = PHP_OS;
621 // Configure ampersands in URLs
622 ini_set('arg_separator.output', '&amp;');
624 // Work around for a PHP bug   see MDL-11237
625 ini_set('pcre.backtrack_limit', 20971520);  // 20 MB
627 // Location of standard files
628 $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
629 $CFG->moddata  = 'moddata';
631 // A hack to get around magic_quotes_gpc being turned on
632 // It is strongly recommended to disable "magic_quotes_gpc"!
633 if (ini_get_bool('magic_quotes_gpc')) {
634     function stripslashes_deep($value) {
635         $value = is_array($value) ?
636                 array_map('stripslashes_deep', $value) :
637                 stripslashes($value);
638         return $value;
639     }
640     $_POST = array_map('stripslashes_deep', $_POST);
641     $_GET = array_map('stripslashes_deep', $_GET);
642     $_COOKIE = array_map('stripslashes_deep', $_COOKIE);
643     $_REQUEST = array_map('stripslashes_deep', $_REQUEST);
644     if (!empty($_SERVER['REQUEST_URI'])) {
645         $_SERVER['REQUEST_URI'] = stripslashes($_SERVER['REQUEST_URI']);
646     }
647     if (!empty($_SERVER['QUERY_STRING'])) {
648         $_SERVER['QUERY_STRING'] = stripslashes($_SERVER['QUERY_STRING']);
649     }
650     if (!empty($_SERVER['HTTP_REFERER'])) {
651         $_SERVER['HTTP_REFERER'] = stripslashes($_SERVER['HTTP_REFERER']);
652     }
653    if (!empty($_SERVER['PATH_INFO'])) {
654         $_SERVER['PATH_INFO'] = stripslashes($_SERVER['PATH_INFO']);
655     }
656     if (!empty($_SERVER['PHP_SELF'])) {
657         $_SERVER['PHP_SELF'] = stripslashes($_SERVER['PHP_SELF']);
658     }
659     if (!empty($_SERVER['PATH_TRANSLATED'])) {
660         $_SERVER['PATH_TRANSLATED'] = stripslashes($_SERVER['PATH_TRANSLATED']);
661     }
664 // neutralise nasty chars in PHP_SELF
665 if (isset($_SERVER['PHP_SELF'])) {
666     $phppos = strpos($_SERVER['PHP_SELF'], '.php');
667     if ($phppos !== false) {
668         $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
669     }
670     unset($phppos);
673 // initialise ME's - this must be done BEFORE starting of session!
674 initialise_fullme();
676 // define SYSCONTEXTID in config.php if you want to save some queries,
677 // after install it must match the system context record id.
678 if (!defined('SYSCONTEXTID')) {
679     get_system_context();
682 // Defining the site - aka frontpage course
683 try {
684     $SITE = get_site();
685 } catch (dml_exception $e) {
686     $SITE = null;
687     if (empty($CFG->version)) {
688         $SITE = new stdClass();
689         $SITE->id = 1;
690     } else {
691         throw $e;
692     }
694 // And the 'default' course - this will usually get reset later in require_login() etc.
695 $COURSE = clone($SITE);
696 /** @deprecated Id of the frontpage course, use $SITE->id instead */
697 define('SITEID', $SITE->id);
699 // init session prevention flag - this is defined on pages that do not want session
700 if (CLI_SCRIPT) {
701     // no sessions in CLI scripts possible
702     define('NO_MOODLE_COOKIES', true);
704 } else if (!defined('NO_MOODLE_COOKIES')) {
705     if (empty($CFG->version) or $CFG->version < 2009011900) {
706         // no session before sessions table gets created
707         define('NO_MOODLE_COOKIES', true);
708     } else if (CLI_SCRIPT) {
709         // CLI scripts can not have session
710         define('NO_MOODLE_COOKIES', true);
711     } else {
712         define('NO_MOODLE_COOKIES', false);
713     }
716 // start session and prepare global $SESSION, $USER
717 session_get_instance();
718 $SESSION = &$_SESSION['SESSION'];
719 $USER    = &$_SESSION['USER'];
721 // Late profiling, only happening if early one wasn't started
722 if (!empty($CFG->profilingenabled)) {
723     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
724     if (profiling_start()) {
725         register_shutdown_function('profiling_stop');
726     }
729 // Process theme change in the URL.
730 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
731     // we have to use _GET directly because we do not want this to interfere with _POST
732     $urlthemename = optional_param('theme', '', PARAM_PLUGIN);
733     try {
734         $themeconfig = theme_config::load($urlthemename);
735         // Makes sure the theme can be loaded without errors.
736         if ($themeconfig->name === $urlthemename) {
737             $SESSION->theme = $urlthemename;
738         } else {
739             unset($SESSION->theme);
740         }
741         unset($themeconfig);
742         unset($urlthemename);
743     } catch (Exception $e) {
744         debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
745     }
747 unset($urlthemename);
749 // Ensure a valid theme is set.
750 if (!isset($CFG->theme)) {
751     $CFG->theme = 'standardwhite';
754 // Set language/locale of printed times.  If user has chosen a language that
755 // that is different from the site language, then use the locale specified
756 // in the language file.  Otherwise, if the admin hasn't specified a locale
757 // then use the one from the default language.  Otherwise (and this is the
758 // majority of cases), use the stored locale specified by admin.
759 // note: do not accept lang parameter from POST
760 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
761     if (get_string_manager()->translation_exists($lang, false)) {
762         $SESSION->lang = $lang;
763     }
765 unset($lang);
767 setup_lang_from_browser();
769 if (empty($CFG->lang)) {
770     if (empty($SESSION->lang)) {
771         $CFG->lang = 'en';
772     } else {
773         $CFG->lang = $SESSION->lang;
774     }
777 // Set the default site locale, a lot of the stuff may depend on this
778 // it is definitely too late to call this first in require_login()!
779 moodle_setlocale();
781 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup!
782 if (!empty($CFG->moodlepageclass)) {
783     $classname = $CFG->moodlepageclass;
784 } else {
785     $classname = 'moodle_page';
787 $PAGE = new $classname();
788 unset($classname);
791 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
792     if ($CFG->theme == 'standard' or $CFG->theme == 'standardwhite') {    // Temporary measure to help with XHTML validation
793         if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) {      // Allow W3CValidator in as user called w3cvalidator (or guest)
794             if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
795                 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
796                 if ($user = get_complete_user_data("username", "w3cvalidator")) {
797                     $user->ignoresesskey = true;
798                 } else {
799                     $user = guest_user();
800                 }
801                 session_set_user($user);
802             }
803         }
804     }
807 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
808 // LogFormat to get the current logged in username in moodle.
809 if ($USER && function_exists('apache_note')
810     && !empty($CFG->apacheloguser) && isset($USER->username)) {
811     $apachelog_userid = $USER->id;
812     $apachelog_username = clean_filename($USER->username);
813     $apachelog_name = '';
814     if (isset($USER->firstname)) {
815         // We can assume both will be set
816         // - even if to empty.
817         $apachelog_name = clean_filename($USER->firstname . " " .
818                                          $USER->lastname);
819     }
820     if (session_is_loggedinas()) {
821         $realuser = session_get_realuser();
822         $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
823         $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
824         $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
825     }
826     switch ($CFG->apacheloguser) {
827         case 3:
828             $logname = $apachelog_username;
829             break;
830         case 2:
831             $logname = $apachelog_name;
832             break;
833         case 1:
834         default:
835             $logname = $apachelog_userid;
836             break;
837     }
838     apache_note('MOODLEUSER', $logname);
841 // Use a custom script replacement if one exists
842 if (!empty($CFG->customscripts)) {
843     if (($customscript = custom_script_path()) !== false) {
844         require ($customscript);
845     }
848 if (PHPUNIT_TEST) {
849     // no ip blocking, these are CLI only
850 } else if (CLI_SCRIPT and !defined('WEB_CRON_EMULATED_CLI')) {
851     // no ip blocking
852 } else if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
853     // in this case, ip in allowed list will be performed first
854     // for example, client IP is 192.168.1.1
855     // 192.168 subnet is an entry in allowed list
856     // 192.168.1.1 is banned in blocked list
857     // This ip will be banned finally
858     if (!empty($CFG->allowedip)) {
859         if (!remoteip_in_list($CFG->allowedip)) {
860             die(get_string('ipblocked', 'admin'));
861         }
862     }
863     // need further check, client ip may a part of
864     // allowed subnet, but a IP address are listed
865     // in blocked list.
866     if (!empty($CFG->blockedip)) {
867         if (remoteip_in_list($CFG->blockedip)) {
868             die(get_string('ipblocked', 'admin'));
869         }
870     }
872 } else {
873     // in this case, IPs in blocked list will be performed first
874     // for example, client IP is 192.168.1.1
875     // 192.168 subnet is an entry in blocked list
876     // 192.168.1.1 is allowed in allowed list
877     // This ip will be allowed finally
878     if (!empty($CFG->blockedip)) {
879         if (remoteip_in_list($CFG->blockedip)) {
880             // if the allowed ip list is not empty
881             // IPs are not included in the allowed list will be
882             // blocked too
883             if (!empty($CFG->allowedip)) {
884                 if (!remoteip_in_list($CFG->allowedip)) {
885                     die(get_string('ipblocked', 'admin'));
886                 }
887             } else {
888                 die(get_string('ipblocked', 'admin'));
889             }
890         }
891     }
892     // if blocked list is null
893     // allowed list should be tested
894     if(!empty($CFG->allowedip)) {
895         if (!remoteip_in_list($CFG->allowedip)) {
896             die(get_string('ipblocked', 'admin'));
897         }
898     }
902 // // try to detect IE6 and prevent gzip because it is extremely buggy browser
903 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) {
904     @ini_set('zlib.output_compression', 'Off');
905     if (function_exists('apache_setenv')) {
906         @apache_setenv('no-gzip', 1);
907     }
911 // note: we can not block non utf-8 installations here, because empty mysql database
912 // might be converted to utf-8 in admin/index.php during installation
916 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
917 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
918 if (false) {
919     $DB = new moodle_database();
920     $OUTPUT = new core_renderer(null, null);
921     $PAGE = new moodle_page();