MDL-23948 improved detection of config.php problems
[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  *
40  * @global object $CFG
41  * @name $CFG
42  */
43 global $CFG; // this should be done much earlier in config.php before creating new $CFG instance
45 if (!isset($CFG)) {
46     if (defined('PHPUNIT_SCRIPT') and PHPUNIT_SCRIPT) {
47         echo('There is a missing "global $CFG;" at the beginning of the config.php file.'."\n");
48         exit(1);
49     } else {
50         // this should never happen, maybe somebody is accessing this file directly...
51         exit(1);
52     }
53 }
55 // We can detect real dirroot path reliably since PHP 4.0.2,
56 // it can not be anything else, there is no point in having this in config.php
57 $CFG->dirroot = dirname(dirname(__FILE__));
59 // Normalise dataroot - we do not want any symbolic links, trailing / or any other weirdness there
60 if (!isset($CFG->dataroot)) {
61     if (isset($_SERVER['REMOTE_ADDR'])) {
62         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
63     }
64     echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n");
65     exit(1);
66 }
67 $CFG->dataroot = realpath($CFG->dataroot);
68 if ($CFG->dataroot === false) {
69     if (isset($_SERVER['REMOTE_ADDR'])) {
70         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
71     }
72     echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n");
73     exit(1);
74 }
76 // wwwroot is mandatory
77 if (!isset($CFG->wwwroot) or $CFG->wwwroot === 'http://example.com/moodle') {
78     if (isset($_SERVER['REMOTE_ADDR'])) {
79         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
80     }
81     echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n");
82     exit(1);
83 }
85 // Define admin directory
86 if (!isset($CFG->admin)) {   // Just in case it isn't defined in config.php
87     $CFG->admin = 'admin';   // This is relative to the wwwroot and dirroot
88 }
90 // Set up some paths.
91 $CFG->libdir = $CFG->dirroot .'/lib';
93 // The current directory in PHP version 4.3.0 and above isn't necessarily the
94 // directory of the script when run from the command line. The require_once()
95 // would fail, so we'll have to chdir()
96 if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
97     chdir(dirname($_SERVER['argv'][0]));
98 }
100 // sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that??
101 @ini_set('precision', 14); // needed for upgrades and gradebook
103 // Scripts may request no debug and error messages in output
104 // please note it must be defined before including the config.php script
105 // and in some cases you also need to set custom default exception handler
106 if (!defined('NO_DEBUG_DISPLAY')) {
107     define('NO_DEBUG_DISPLAY', false);
110 // Servers should define a default timezone in php.ini, but if they don't then make sure something is defined.
111 // This is a quick hack.  Ideally we should ask the admin for a value.  See MDL-22625 for more on this.
112 if (function_exists('date_default_timezone_set') and function_exists('date_default_timezone_get')) {
113     @date_default_timezone_set(@date_default_timezone_get());
116 // PHPUnit scripts are a special case, for now we treat them as normal CLI scripts,
117 // please note you must install PHPUnit library separately via PEAR
118 if (!defined('PHPUNIT_SCRIPT')) {
119     define('PHPUNIT_SCRIPT', false);
121 if (PHPUNIT_SCRIPT) {
122     define('CLI_SCRIPT', true);
125 // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output
126 // In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php.
127 // Please note that one script can not be accessed from both CLI and web interface.
128 if (!defined('CLI_SCRIPT')) {
129     define('CLI_SCRIPT', false);
131 if (defined('WEB_CRON_EMULATED_CLI')) {
132     if (!isset($_SERVER['REMOTE_ADDR'])) {
133         echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n");
134         exit(1);
135     }
136 } else if (isset($_SERVER['REMOTE_ADDR'])) {
137     if (CLI_SCRIPT) {
138         echo('Command line scripts can not be executed from the web interface');
139         exit(1);
140     }
141 } else {
142     if (!CLI_SCRIPT) {
143         echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
144         exit(1);
145     }
148 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
149 if (!defined('AJAX_SCRIPT')) {
150     define('AJAX_SCRIPT', false);
153 // File permissions on created directories in the $CFG->dataroot
154 if (empty($CFG->directorypermissions)) {
155     $CFG->directorypermissions = 02777;      // Must be octal (that's why it's here)
157 if (empty($CFG->filepermissions)) {
158     $CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags
160 // better also set default umask because recursive mkdir() does not apply permissions recursively otherwise
161 umask(0000);
163 // exact version of currently used yui2 and 3 library
164 $CFG->yui2version = '2.8.1';
165 $CFG->yui3version = '3.1.1';
168 // special support for highly optimised scripts that do not need libraries and DB connection
169 if (defined('ABORT_AFTER_CONFIG')) {
170     if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
171         // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
172         if (isset($CFG->debug)) {
173             error_reporting($CFG->debug);
174         } else {
175             error_reporting(0);
176         }
177         if (empty($CFG->debugdisplay)) {
178             @ini_set('display_errors', '0');
179             @ini_set('log_errors', '1');
180         } else {
181             @ini_set('display_errors', '1');
182         }
183         require_once("$CFG->dirroot/lib/configonlylib.php");
184         return;
185     }
188 /** Used by library scripts to check they are being called by Moodle */
189 if (!defined('MOODLE_INTERNAL')) { // necessary because cli installer has to define it earlier
190     define('MOODLE_INTERNAL', true);
193 /**
194  * Database connection. Used for all access to the database.
195  * @global moodle_database $DB
196  * @name $DB
197  */
198 global $DB;
200 /**
201  * Moodle's wrapper round PHP's $_SESSION.
202  *
203  * @global object $SESSION
204  * @name $SESSION
205  */
206 global $SESSION;
208 /**
209  * Holds the user table record for the current user. Will be the 'guest'
210  * user record for people who are not logged in.
211  *
212  * $USER is stored in the session.
213  *
214  * Items found in the user record:
215  *  - $USER->emailstop - Does the user want email sent to them?
216  *  - $USER->email - The user's email address.
217  *  - $USER->id - The unique integer identified of this user in the 'user' table.
218  *  - $USER->email - The user's email address.
219  *  - $USER->firstname - The user's first name.
220  *  - $USER->lastname - The user's last name.
221  *  - $USER->username - The user's login username.
222  *  - $USER->secret - The user's ?.
223  *  - $USER->lang - The user's language choice.
224  *
225  * @global object $USER
226  * @name $USER
227  */
228 global $USER;
230 /**
231  * A central store of information about the current page we are
232  * generating in response to the user's request.
233  *
234  * @global moodle_page $PAGE
235  * @name $PAGE
236  */
237 global $PAGE;
239 /**
240  * The current course. An alias for $PAGE->course.
241  * @global object $COURSE
242  * @name $COURSE
243  */
244 global $COURSE;
246 /**
247  * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
248  * it to generate HTML for output.
249  *
250  * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
251  * for the magic that does that. After $OUTPUT has been initialised, any attempt
252  * to change something that affects the current theme ($PAGE->course, logged in use,
253  * httpsrequried ... will result in an exception.)
254  *
255  * Please note the $OUTPUT is replacing the old global $THEME object.
256  *
257  * @global object $OUTPUT
258  * @name $OUTPUT
259  */
260 global $OUTPUT;
262 /**
263  * Shared memory cache.
264  * @global object $MCACHE
265  * @name $MCACHE
266  */
267 global $MCACHE;
269 /**
270  * A global to define if the page being displayed must run under HTTPS.
271  *
272  * Its primary goal is to allow 100% HTTPS pages when $CFG->loginhttps is enabled. Default to false.
273  * Its enabled only by the $PAGE->https_required() function and used in some pages to update some URLs
274  *
275  * @global bool $HTTPSPAGEREQUIRED
276  * @name $HTTPSPAGEREQUIRED
277  */
278 global $HTTPSPAGEREQUIRED;
280 /**
281  * Full script path including all params, slash arguments, scheme and host.
282  * @global string $FULLME
283  * @name $FULLME
284  */
285 global $FULLME;
287 /**
288  * Script path including query string and slash arguments without host.
289  * @global string $ME
290  * @name $ME
291  */
292 global $ME;
294 /**
295  * $FULLME without slasharguments and query string.
296  * @global string $FULLSCRIPT
297  * @name $FULLSCRIPT
298  */
299 global $FULLSCRIPT;
301 /**
302  * Relative moodle script path '/course/view.php'
303  * @global string $SCRIPT
304  * @name $SCRIPT
305  */
306 global $SCRIPT;
308 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides
309 $CFG->config_php_settings = (array)$CFG;
310 // Forced plugin settings override values from config_plugins table
311 unset($CFG->config_php_settings['forced_plugin_settings']);
312 if (!isset($CFG->forced_plugin_settings)) {
313     $CFG->forced_plugin_settings = array();
315 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
316 // inside some URLs used in HTTPSPAGEREQUIRED pages.
317 $CFG->httpswwwroot = $CFG->wwwroot;
319 require_once($CFG->libdir .'/setuplib.php');        // Functions that MUST be loaded first
321 // Time to start counting
322 init_performance_info();
324 // Put $OUTPUT in place, so errors can be displayed.
325 $OUTPUT = new bootstrap_renderer();
327 // set handler for uncaught exceptions - equivalent to print_error() call
328 set_exception_handler('default_exception_handler');
329 set_error_handler('default_error_handler', E_ALL | E_STRICT);
331 // If there are any errors in the standard libraries we want to know!
332 error_reporting(E_ALL);
334 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
335 // http://www.google.com/webmasters/faq.html#prefetchblock
336 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
337     header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
338     echo('Prefetch request forbidden.');
339     exit(1);
342 if (!isset($CFG->prefix)) {   // Just in case it isn't defined in config.php
343     $CFG->prefix = '';
346 // location of all languages except core English pack
347 if (!isset($CFG->langotherroot)) {
348     $CFG->langotherroot = $CFG->dataroot.'/lang';
351 // location of local lang pack customisations (dirs with _local suffix)
352 if (!isset($CFG->langlocalroot)) {
353     $CFG->langlocalroot = $CFG->dataroot.'/lang';
356 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
357 //the problem is that we need specific version of quickforms and hacked excel files :-(
358 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
359 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
360 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
361 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
363 // Load up standard libraries
364 require_once($CFG->libdir .'/textlib.class.php');   // Functions to handle multibyte strings
365 require_once($CFG->libdir .'/filterlib.php');       // Functions for filtering test as it is output
366 require_once($CFG->libdir .'/ajax/ajaxlib.php');    // Functions for managing our use of JavaScript and YUI
367 require_once($CFG->libdir .'/weblib.php');          // Functions relating to HTTP and content
368 require_once($CFG->libdir .'/outputlib.php');       // Functions for generating output
369 require_once($CFG->libdir .'/navigationlib.php');   // Class for generating Navigation structure
370 require_once($CFG->libdir .'/dmllib.php');          // Database access
371 require_once($CFG->libdir .'/datalib.php');         // Legacy lib with a big-mix of functions.
372 require_once($CFG->libdir .'/accesslib.php');       // Access control functions
373 require_once($CFG->libdir .'/deprecatedlib.php');   // Deprecated functions included for backward compatibility
374 require_once($CFG->libdir .'/moodlelib.php');       // Other general-purpose functions
375 require_once($CFG->libdir .'/enrollib.php');        // Enrolment related functions
376 require_once($CFG->libdir .'/pagelib.php');         // Library that defines the moodle_page class, used for $PAGE
377 require_once($CFG->libdir .'/blocklib.php');        // Library for controlling blocks
378 require_once($CFG->libdir .'/eventslib.php');       // Events functions
379 require_once($CFG->libdir .'/grouplib.php');        // Groups functions
380 require_once($CFG->libdir .'/sessionlib.php');      // All session and cookie related stuff
381 require_once($CFG->libdir .'/editorlib.php');       // All text editor related functions and classes
382 require_once($CFG->libdir .'/messagelib.php');      // Messagelib functions
384 // make sure PHP is not severly misconfigured
385 setup_validate_php_configuration();
387 // Increase memory limits if possible
388 raise_memory_limit('96M');    // We should never NEED this much but just in case...
390 // Connect to the database
391 setup_DB();
393 // Disable errors for now - needed for installation when debug enabled in config.php
394 if (isset($CFG->debug)) {
395     $originalconfigdebug = $CFG->debug;
396     unset($CFG->debug);
397 } else {
398     $originalconfigdebug = -1;
401 // Load up any configuration from the config table
402 initialise_cfg();
404 // Verify upgrade is not running unless we are in a script that needs to execute in any case
405 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
406     if ($CFG->upgraderunning < time()) {
407         unset_config('upgraderunning');
408     } else {
409         print_error('upgraderunning');
410     }
413 // Turn on SQL logging if required
414 if (!empty($CFG->logsql)) {
415     $DB->set_logging(true);
418 // Prevent warnings from roles when upgrading with debug on
419 if (isset($CFG->debug)) {
420     $originaldatabasedebug = $CFG->debug;
421     unset($CFG->debug);
422 } else {
423     $originaldatabasedebug = -1;
426 // enable circular reference collector in PHP 5.3,
427 // it helps a lot when using large complex OOP structures such as in amos or gradebook
428 if (function_exists('gc_enable')) {
429     gc_enable();
432 // For now, only needed under apache (and probably unstable in other contexts)
433 if (function_exists('register_shutdown_function')) {
434     register_shutdown_function('moodle_request_shutdown');
437 // Defining the site
438 try {
439     $SITE = get_site();
440     /**
441      * If $SITE global from {@link get_site()} is set then SITEID to $SITE->id, otherwise set to 1.
442      */
443     define('SITEID', $SITE->id);
444     // And the 'default' course - this will usually get reset later in require_login() etc.
445     $COURSE = clone($SITE);
446 } catch (dml_read_exception $e) {
447     $SITE = null;
448     if (empty($CFG->version)) {
449         // we are just installing
450         /**
451          * @ignore
452          */
453         define('SITEID', 1);
454         // And the 'default' course
455         $COURSE = new object();  // no site created yet
456         $COURSE->id = 1;
457     } else {
458         throw $e;
459     }
462 // define SYSCONTEXTID in config.php if you want to save some queries (after install or upgrade!)
463 if (!defined('SYSCONTEXTID')) {
464     get_system_context();
467 // Set error reporting back to normal
468 if ($originaldatabasedebug == -1) {
469     $CFG->debug = DEBUG_MINIMAL;
470 } else {
471     $CFG->debug = $originaldatabasedebug;
473 if ($originalconfigdebug !== -1) {
474     $CFG->debug = $originalconfigdebug;
476 unset($originalconfigdebug);
477 unset($originaldatabasedebug);
478 error_reporting($CFG->debug);
480 // find out if PHP configured to display warnings,
481 // this is a security problem because some moodle scripts may
482 // disclose sensitive information
483 if (ini_get_bool('display_errors')) {
484     define('WARN_DISPLAY_ERRORS_ENABLED', true);
486 // If we want to display Moodle errors, then try and set PHP errors to match
487 if (!isset($CFG->debugdisplay)) {
488     // keep it "as is" during installation
489 } else if (NO_DEBUG_DISPLAY) {
490     // some parts of Moodle cannot display errors and debug at all.
491     @ini_set('display_errors', '0');
492     @ini_set('log_errors', '1');
493 } else if (empty($CFG->debugdisplay)) {
494     @ini_set('display_errors', '0');
495     @ini_set('log_errors', '1');
496 } else {
497     // This is very problematic in XHTML strict mode!
498     @ini_set('display_errors', '1');
501 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
502 if (!empty($CFG->version) and $CFG->version < 2007101509) {
503     print_error('upgraderequires19', 'error');
504     die;
507 // Shared-Memory cache init -- will set $MCACHE
508 // $MCACHE is a global object that offers at least add(), set() and delete()
509 // with similar semantics to the memcached PHP API http://php.net/memcache
510 // Ensure we define rcache - so we can later check for it
511 // with a really fast and unambiguous $CFG->rcache === false
512 if (!empty($CFG->cachetype)) {
513     if (empty($CFG->rcache)) {
514         $CFG->rcache = false;
515     } else {
516         $CFG->rcache = true;
517     }
519     // do not try to initialize if cache disabled
520     if (!$CFG->rcache) {
521         $CFG->cachetype = '';
522     }
524     if ($CFG->cachetype === 'memcached' && !empty($CFG->memcachedhosts)) {
525         if (!init_memcached()) {
526             debugging("Error initialising memcached");
527             $CFG->cachetype = '';
528             $CFG->rcache = false;
529         }
530     } else if ($CFG->cachetype === 'eaccelerator') {
531         if (!init_eaccelerator()) {
532             debugging("Error initialising eaccelerator cache");
533             $CFG->cachetype = '';
534             $CFG->rcache = false;
535         }
536     }
538 } else { // just make sure it is defined
539     $CFG->cachetype = '';
540     $CFG->rcache    = false;
543 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
544 // - WINDOWS: for any Windows flavour.
545 // - UNIX: for the rest
546 // Also, $CFG->os can continue being used if more specialization is required
547 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
548     $CFG->ostype = 'WINDOWS';
549 } else {
550     $CFG->ostype = 'UNIX';
552 $CFG->os = PHP_OS;
554 // Setup cache dir for Smarty and others
555 if (!file_exists($CFG->dataroot .'/cache')) {
556     make_upload_directory('cache');
559 // Configure ampersands in URLs
560 @ini_set('arg_separator.output', '&amp;');
562 // Work around for a PHP bug   see MDL-11237
563 @ini_set('pcre.backtrack_limit', 20971520);  // 20 MB
565 // Location of standard files
566 $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
567 $CFG->moddata  = 'moddata';
569 // Create the $PAGE global.
570 if (!empty($CFG->moodlepageclass)) {
571     $classname = $CFG->moodlepageclass;
572 } else {
573     $classname = 'moodle_page';
575 $PAGE = new $classname();
576 unset($classname);
578 // A hack to get around magic_quotes_gpc being turned on
579 // It is strongly recommended to disable "magic_quotes_gpc"!
580 if (ini_get_bool('magic_quotes_gpc')) {
581     function stripslashes_deep($value) {
582         $value = is_array($value) ?
583                 array_map('stripslashes_deep', $value) :
584                 stripslashes($value);
585         return $value;
586     }
587     $_POST = array_map('stripslashes_deep', $_POST);
588     $_GET = array_map('stripslashes_deep', $_GET);
589     $_COOKIE = array_map('stripslashes_deep', $_COOKIE);
590     $_REQUEST = array_map('stripslashes_deep', $_REQUEST);
591     if (!empty($_SERVER['REQUEST_URI'])) {
592         $_SERVER['REQUEST_URI'] = stripslashes($_SERVER['REQUEST_URI']);
593     }
594     if (!empty($_SERVER['QUERY_STRING'])) {
595         $_SERVER['QUERY_STRING'] = stripslashes($_SERVER['QUERY_STRING']);
596     }
597     if (!empty($_SERVER['HTTP_REFERER'])) {
598         $_SERVER['HTTP_REFERER'] = stripslashes($_SERVER['HTTP_REFERER']);
599     }
600    if (!empty($_SERVER['PATH_INFO'])) {
601         $_SERVER['PATH_INFO'] = stripslashes($_SERVER['PATH_INFO']);
602     }
603     if (!empty($_SERVER['PHP_SELF'])) {
604         $_SERVER['PHP_SELF'] = stripslashes($_SERVER['PHP_SELF']);
605     }
606     if (!empty($_SERVER['PATH_TRANSLATED'])) {
607         $_SERVER['PATH_TRANSLATED'] = stripslashes($_SERVER['PATH_TRANSLATED']);
608     }
611 // neutralise nasty chars in PHP_SELF
612 if (isset($_SERVER['PHP_SELF'])) {
613     $phppos = strpos($_SERVER['PHP_SELF'], '.php');
614     if ($phppos !== false) {
615         $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
616     }
617     unset($phppos);
620 // initialise ME's
621 initialise_fullme();
624 // init session prevention flag - this is defined on pages that do not want session
625 if (CLI_SCRIPT) {
626     // no sessions in CLI scripts possible
627     define('NO_MOODLE_COOKIES', true);
629 } else if (!defined('NO_MOODLE_COOKIES')) {
630     if (empty($CFG->version) or $CFG->version < 2009011900) {
631         // no session before sessions table gets created
632         define('NO_MOODLE_COOKIES', true);
633     } else if (CLI_SCRIPT) {
634         // CLI scripts can not have session
635         define('NO_MOODLE_COOKIES', true);
636     } else {
637         define('NO_MOODLE_COOKIES', false);
638     }
641 // start session and prepare global $SESSION, $USER
642 session_get_instance();
643 $SESSION = &$_SESSION['SESSION'];
644 $USER    = &$_SESSION['USER'];
646 // Process theme change in the URL.
647 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
648     // we have to use _GET directly because we do not want this to interfere with _POST
649     $urlthemename = optional_param('theme', '', PARAM_SAFEDIR);
650     try {
651         $themeconfig = theme_config::load($urlthemename);
652         // Makes sure the theme can be loaded without errors.
653         if ($themeconfig->name === $urlthemename) {
654             $SESSION->theme = $urlthemename;
655         } else {
656             unset($SESSION->theme);
657         }
658         unset($themeconfig);
659         unset($urlthemename);
660     } catch (Exception $e) {
661         debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
662     }
664 unset($urlthemename);
666 // Ensure a valid theme is set.
667 if (!isset($CFG->theme)) {
668     $CFG->theme = 'standardwhite';
671 // Set language/locale of printed times.  If user has chosen a language that
672 // that is different from the site language, then use the locale specified
673 // in the language file.  Otherwise, if the admin hasn't specified a locale
674 // then use the one from the default language.  Otherwise (and this is the
675 // majority of cases), use the stored locale specified by admin.
676 // note: do not accept lang parameter from POST
677 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
678     if (get_string_manager()->translation_exists($lang, false)) {
679         $SESSION->lang = $lang;
680     }
682 unset($lang);
684 setup_lang_from_browser();
686 if (empty($CFG->lang)) {
687     if (empty($SESSION->lang)) {
688         $CFG->lang = 'en';
689     } else {
690         $CFG->lang = $SESSION->lang;
691     }
694 // Set the default site locale, a lot of the stuff may depend on this
695 // it is definitely too late to call this first in require_login()!
696 moodle_setlocale();
698 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
699     if ($CFG->theme == 'standard' or $CFG->theme == 'standardwhite') {    // Temporary measure to help with XHTML validation
700         if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) {      // Allow W3CValidator in as user called w3cvalidator (or guest)
701             if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
702                 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
703                 if ($user = get_complete_user_data("username", "w3cvalidator")) {
704                     $user->ignoresesskey = true;
705                 } else {
706                     $user = guest_user();
707                 }
708                 session_set_user($user);
709             }
710         }
711     }
714 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
715 // LogFormat to get the current logged in username in moodle.
716 if ($USER && function_exists('apache_note')
717     && !empty($CFG->apacheloguser) && isset($USER->username)) {
718     $apachelog_userid = $USER->id;
719     $apachelog_username = clean_filename($USER->username);
720     $apachelog_name = '';
721     if (isset($USER->firstname)) {
722         // We can assume both will be set
723         // - even if to empty.
724         $apachelog_name = clean_filename($USER->firstname . " " .
725                                          $USER->lastname);
726     }
727     if (session_is_loggedinas()) {
728         $realuser = session_get_realuser();
729         $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
730         $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
731         $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
732     }
733     switch ($CFG->apacheloguser) {
734         case 3:
735             $logname = $apachelog_username;
736             break;
737         case 2:
738             $logname = $apachelog_name;
739             break;
740         case 1:
741         default:
742             $logname = $apachelog_userid;
743             break;
744     }
745     apache_note('MOODLEUSER', $logname);
748 // Adjust ALLOWED_TAGS
749 adjust_allowed_tags();
751 // Use a custom script replacement if one exists
752 if (!empty($CFG->customscripts)) {
753     if (($customscript = custom_script_path()) !== false) {
754         require ($customscript);
755     }
758 // in the first case, ip in allowed list will be performed first
759 // for example, client IP is 192.168.1.1
760 // 192.168 subnet is an entry in allowed list
761 // 192.168.1.1 is banned in blocked list
762 // This ip will be banned finally
763 if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
764     if (!empty($CFG->allowedip)) {
765         if (!remoteip_in_list($CFG->allowedip)) {
766             die(get_string('ipblocked', 'admin'));
767         }
768     }
769     // need further check, client ip may a part of
770     // allowed subnet, but a IP address are listed
771     // in blocked list.
772     if (!empty($CFG->blockedip)) {
773         if (remoteip_in_list($CFG->blockedip)) {
774             die(get_string('ipblocked', 'admin'));
775         }
776     }
778 } else {
779     // in this case, IPs in blocked list will be performed first
780     // for example, client IP is 192.168.1.1
781     // 192.168 subnet is an entry in blocked list
782     // 192.168.1.1 is allowed in allowed list
783     // This ip will be allowed finally
784     if (!empty($CFG->blockedip)) {
785         if (remoteip_in_list($CFG->blockedip)) {
786             // if the allowed ip list is not empty
787             // IPs are not included in the allowed list will be
788             // blocked too
789             if (!empty($CFG->allowedip)) {
790                 if (!remoteip_in_list($CFG->allowedip)) {
791                     die(get_string('ipblocked', 'admin'));
792                 }
793             } else {
794                 die(get_string('ipblocked', 'admin'));
795             }
796         }
797     }
798     // if blocked list is null
799     // allowed list should be tested
800     if(!empty($CFG->allowedip)) {
801         if (!remoteip_in_list($CFG->allowedip)) {
802             die(get_string('ipblocked', 'admin'));
803         }
804     }
808 // note: we can not block non utf-8 installations here, because empty mysql database
809 // might be converted to utf-8 in admin/index.php during installation
813 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
814 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
815 if (false) {
816     $DB = new moodle_database();
817     $OUTPUT = new core_renderer(null, null);
818     $PAGE = new moodle_page();