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