MDL-25973 add missing charset
[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 // Some scripts such as upgrade may want to prevent output buffering
117 if (!defined('NO_OUTPUT_BUFFERING')) {
118     define('NO_OUTPUT_BUFFERING', false);
121 // Servers should define a default timezone in php.ini, but if they don't then make sure something is defined.
122 // This is a quick hack.  Ideally we should ask the admin for a value.  See MDL-22625 for more on this.
123 if (function_exists('date_default_timezone_set') and function_exists('date_default_timezone_get')) {
124     $olddebug = error_reporting(0);
125     date_default_timezone_set(date_default_timezone_get());
126     error_reporting($olddebug);
127     unset($olddebug);
130 // PHPUnit scripts are a special case, for now we treat them as normal CLI scripts,
131 // please note you must install PHPUnit library separately via PEAR
132 if (!defined('PHPUNIT_SCRIPT')) {
133     define('PHPUNIT_SCRIPT', false);
135 if (PHPUNIT_SCRIPT) {
136     define('CLI_SCRIPT', true);
139 // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output
140 // In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php.
141 // Please note that one script can not be accessed from both CLI and web interface.
142 if (!defined('CLI_SCRIPT')) {
143     define('CLI_SCRIPT', false);
145 if (defined('WEB_CRON_EMULATED_CLI')) {
146     if (!isset($_SERVER['REMOTE_ADDR'])) {
147         echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n");
148         exit(1);
149     }
150 } else if (isset($_SERVER['REMOTE_ADDR'])) {
151     if (CLI_SCRIPT) {
152         echo('Command line scripts can not be executed from the web interface');
153         exit(1);
154     }
155 } else {
156     if (!CLI_SCRIPT) {
157         echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
158         exit(1);
159     }
162 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades
163 if (file_exists("$CFG->dataroot/climaintenance.html")) {
164     if (!CLI_SCRIPT) {
165         header('Content-type: text/html; charset=utf-8');
166         /// Headers to make it not cacheable and json
167         header('Cache-Control: no-store, no-cache, must-revalidate');
168         header('Cache-Control: post-check=0, pre-check=0', false);
169         header('Pragma: no-cache');
170         header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
171         header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
172         header('Accept-Ranges: none');
173         readfile("$CFG->dataroot/climaintenance.html");
174         die;
175     } else {
176         if (!defined('CLI_MAINTENANCE')) {
177             define('CLI_MAINTENANCE', true);
178         }
179     }
180 } else {
181     if (!defined('CLI_MAINTENANCE')) {
182         define('CLI_MAINTENANCE', false);
183     }
186 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
187 if (!defined('AJAX_SCRIPT')) {
188     define('AJAX_SCRIPT', false);
191 // File permissions on created directories in the $CFG->dataroot
192 if (empty($CFG->directorypermissions)) {
193     $CFG->directorypermissions = 02777;      // Must be octal (that's why it's here)
195 if (empty($CFG->filepermissions)) {
196     $CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags
198 // better also set default umask because recursive mkdir() does not apply permissions recursively otherwise
199 umask(0000);
201 // exact version of currently used yui2 and 3 library
202 $CFG->yui2version = '2.8.2';
203 $CFG->yui3version = '3.2.0';
206 // special support for highly optimised scripts that do not need libraries and DB connection
207 if (defined('ABORT_AFTER_CONFIG')) {
208     if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
209         // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
210         if (isset($CFG->debug)) {
211             error_reporting($CFG->debug);
212         } else {
213             error_reporting(0);
214         }
215         if (empty($CFG->debugdisplay)) {
216             ini_set('display_errors', '0');
217             ini_set('log_errors', '1');
218         } else {
219             ini_set('display_errors', '1');
220         }
221         require_once("$CFG->dirroot/lib/configonlylib.php");
222         return;
223     }
226 /** Used by library scripts to check they are being called by Moodle */
227 if (!defined('MOODLE_INTERNAL')) { // necessary because cli installer has to define it earlier
228     define('MOODLE_INTERNAL', true);
231 /**
232  * Database connection. Used for all access to the database.
233  * @global moodle_database $DB
234  * @name $DB
235  */
236 global $DB;
238 /**
239  * Moodle's wrapper round PHP's $_SESSION.
240  *
241  * @global object $SESSION
242  * @name $SESSION
243  */
244 global $SESSION;
246 /**
247  * Holds the user table record for the current user. Will be the 'guest'
248  * user record for people who are not logged in.
249  *
250  * $USER is stored in the session.
251  *
252  * Items found in the user record:
253  *  - $USER->email - The user's email address.
254  *  - $USER->id - The unique integer identified of this user in the 'user' table.
255  *  - $USER->email - The user's email address.
256  *  - $USER->firstname - The user's first name.
257  *  - $USER->lastname - The user's last name.
258  *  - $USER->username - The user's login username.
259  *  - $USER->secret - The user's ?.
260  *  - $USER->lang - The user's language choice.
261  *
262  * @global object $USER
263  * @name $USER
264  */
265 global $USER;
267 /**
268  * A central store of information about the current page we are
269  * generating in response to the user's request.
270  *
271  * @global moodle_page $PAGE
272  * @name $PAGE
273  */
274 global $PAGE;
276 /**
277  * The current course. An alias for $PAGE->course.
278  * @global object $COURSE
279  * @name $COURSE
280  */
281 global $COURSE;
283 /**
284  * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
285  * it to generate HTML for output.
286  *
287  * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
288  * for the magic that does that. After $OUTPUT has been initialised, any attempt
289  * to change something that affects the current theme ($PAGE->course, logged in use,
290  * httpsrequried ... will result in an exception.)
291  *
292  * Please note the $OUTPUT is replacing the old global $THEME object.
293  *
294  * @global object $OUTPUT
295  * @name $OUTPUT
296  */
297 global $OUTPUT;
299 /**
300  * Shared memory cache.
301  * @global object $MCACHE
302  * @name $MCACHE
303  */
304 global $MCACHE;
306 /**
307  * Full script path including all params, slash arguments, scheme and host.
308  * @global string $FULLME
309  * @name $FULLME
310  */
311 global $FULLME;
313 /**
314  * Script path including query string and slash arguments without host.
315  * @global string $ME
316  * @name $ME
317  */
318 global $ME;
320 /**
321  * $FULLME without slasharguments and query string.
322  * @global string $FULLSCRIPT
323  * @name $FULLSCRIPT
324  */
325 global $FULLSCRIPT;
327 /**
328  * Relative moodle script path '/course/view.php'
329  * @global string $SCRIPT
330  * @name $SCRIPT
331  */
332 global $SCRIPT;
334 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides
335 $CFG->config_php_settings = (array)$CFG;
336 // Forced plugin settings override values from config_plugins table
337 unset($CFG->config_php_settings['forced_plugin_settings']);
338 if (!isset($CFG->forced_plugin_settings)) {
339     $CFG->forced_plugin_settings = array();
341 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
342 // inside some URLs used in HTTPSPAGEREQUIRED pages.
343 $CFG->httpswwwroot = $CFG->wwwroot;
345 require_once($CFG->libdir .'/setuplib.php');        // Functions that MUST be loaded first
347 if (NO_OUTPUT_BUFFERING) {
348     // we have to call this always before starting session because it discards headers!
349     disable_output_buffering();
352 // Increase memory limits if possible
353 raise_memory_limit(MEMORY_STANDARD);
355 // Time to start counting
356 init_performance_info();
358 // Put $OUTPUT in place, so errors can be displayed.
359 $OUTPUT = new bootstrap_renderer();
361 // set handler for uncaught exceptions - equivalent to print_error() call
362 set_exception_handler('default_exception_handler');
363 set_error_handler('default_error_handler', E_ALL | E_STRICT);
365 // If there are any errors in the standard libraries we want to know!
366 error_reporting(E_ALL);
368 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
369 // http://www.google.com/webmasters/faq.html#prefetchblock
370 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
371     header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
372     echo('Prefetch request forbidden.');
373     exit(1);
376 if (!isset($CFG->prefix)) {   // Just in case it isn't defined in config.php
377     $CFG->prefix = '';
380 // location of all languages except core English pack
381 if (!isset($CFG->langotherroot)) {
382     $CFG->langotherroot = $CFG->dataroot.'/lang';
385 // location of local lang pack customisations (dirs with _local suffix)
386 if (!isset($CFG->langlocalroot)) {
387     $CFG->langlocalroot = $CFG->dataroot.'/lang';
390 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
391 //the problem is that we need specific version of quickforms and hacked excel files :-(
392 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
393 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
394 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
395 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
397 // Load up standard libraries
398 require_once($CFG->libdir .'/textlib.class.php');   // Functions to handle multibyte strings
399 require_once($CFG->libdir .'/filterlib.php');       // Functions for filtering test as it is output
400 require_once($CFG->libdir .'/ajax/ajaxlib.php');    // Functions for managing our use of JavaScript and YUI
401 require_once($CFG->libdir .'/weblib.php');          // Functions relating to HTTP and content
402 require_once($CFG->libdir .'/outputlib.php');       // Functions for generating output
403 require_once($CFG->libdir .'/navigationlib.php');   // Class for generating Navigation structure
404 require_once($CFG->libdir .'/dmllib.php');          // Database access
405 require_once($CFG->libdir .'/datalib.php');         // Legacy lib with a big-mix of functions.
406 require_once($CFG->libdir .'/accesslib.php');       // Access control functions
407 require_once($CFG->libdir .'/deprecatedlib.php');   // Deprecated functions included for backward compatibility
408 require_once($CFG->libdir .'/moodlelib.php');       // Other general-purpose functions
409 require_once($CFG->libdir .'/enrollib.php');        // Enrolment related functions
410 require_once($CFG->libdir .'/pagelib.php');         // Library that defines the moodle_page class, used for $PAGE
411 require_once($CFG->libdir .'/blocklib.php');        // Library for controlling blocks
412 require_once($CFG->libdir .'/eventslib.php');       // Events functions
413 require_once($CFG->libdir .'/grouplib.php');        // Groups functions
414 require_once($CFG->libdir .'/sessionlib.php');      // All session and cookie related stuff
415 require_once($CFG->libdir .'/editorlib.php');       // All text editor related functions and classes
416 require_once($CFG->libdir .'/messagelib.php');      // Messagelib functions
418 // make sure PHP is not severly misconfigured
419 setup_validate_php_configuration();
421 // Connect to the database
422 setup_DB();
424 // Disable errors for now - needed for installation when debug enabled in config.php
425 if (isset($CFG->debug)) {
426     $originalconfigdebug = $CFG->debug;
427     unset($CFG->debug);
428 } else {
429     $originalconfigdebug = -1;
432 // Load up any configuration from the config table
433 initialise_cfg();
435 // Verify upgrade is not running unless we are in a script that needs to execute in any case
436 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
437     if ($CFG->upgraderunning < time()) {
438         unset_config('upgraderunning');
439     } else {
440         print_error('upgraderunning');
441     }
444 // Turn on SQL logging if required
445 if (!empty($CFG->logsql)) {
446     $DB->set_logging(true);
449 // Prevent warnings from roles when upgrading with debug on
450 if (isset($CFG->debug)) {
451     $originaldatabasedebug = $CFG->debug;
452     unset($CFG->debug);
453 } else {
454     $originaldatabasedebug = -1;
457 // enable circular reference collector in PHP 5.3,
458 // it helps a lot when using large complex OOP structures such as in amos or gradebook
459 if (function_exists('gc_enable')) {
460     gc_enable();
463 // Register default shutdown tasks - such as Apache memory release helper, perf logging, etc.
464 if (function_exists('register_shutdown_function')) {
465     register_shutdown_function('moodle_request_shutdown');
468 // Defining the site
469 try {
470     $SITE = get_site();
471     /**
472      * If $SITE global from {@link get_site()} is set then SITEID to $SITE->id, otherwise set to 1.
473      */
474     define('SITEID', $SITE->id);
475     // And the 'default' course - this will usually get reset later in require_login() etc.
476     $COURSE = clone($SITE);
477 } catch (dml_exception $e) {
478     $SITE = null;
479     if (empty($CFG->version)) {
480         // we are just installing
481         /**
482          * @ignore
483          */
484         define('SITEID', 1);
485         // And the 'default' course
486         $COURSE = new stdClass();  // no site created yet
487         $COURSE->id = 1;
488     } else {
489         throw $e;
490     }
493 // define SYSCONTEXTID in config.php if you want to save some queries (after install or upgrade!)
494 if (!defined('SYSCONTEXTID')) {
495     get_system_context();
498 // Set error reporting back to normal
499 if ($originaldatabasedebug == -1) {
500     $CFG->debug = DEBUG_MINIMAL;
501 } else {
502     $CFG->debug = $originaldatabasedebug;
504 if ($originalconfigdebug !== -1) {
505     $CFG->debug = $originalconfigdebug;
507 unset($originalconfigdebug);
508 unset($originaldatabasedebug);
509 error_reporting($CFG->debug);
511 // find out if PHP configured to display warnings,
512 // this is a security problem because some moodle scripts may
513 // disclose sensitive information
514 if (ini_get_bool('display_errors')) {
515     define('WARN_DISPLAY_ERRORS_ENABLED', true);
517 // If we want to display Moodle errors, then try and set PHP errors to match
518 if (!isset($CFG->debugdisplay)) {
519     // keep it "as is" during installation
520 } else if (NO_DEBUG_DISPLAY) {
521     // some parts of Moodle cannot display errors and debug at all.
522     ini_set('display_errors', '0');
523     ini_set('log_errors', '1');
524 } else if (empty($CFG->debugdisplay)) {
525     ini_set('display_errors', '0');
526     ini_set('log_errors', '1');
527 } else {
528     // This is very problematic in XHTML strict mode!
529     ini_set('display_errors', '1');
532 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
533 if (!empty($CFG->version) and $CFG->version < 2007101509) {
534     print_error('upgraderequires19', 'error');
535     die;
538 // Shared-Memory cache init -- will set $MCACHE
539 // $MCACHE is a global object that offers at least add(), set() and delete()
540 // with similar semantics to the memcached PHP API http://php.net/memcache
541 // Ensure we define rcache - so we can later check for it
542 // with a really fast and unambiguous $CFG->rcache === false
543 if (!empty($CFG->cachetype)) {
544     if (empty($CFG->rcache)) {
545         $CFG->rcache = false;
546     } else {
547         $CFG->rcache = true;
548     }
550     // do not try to initialize if cache disabled
551     if (!$CFG->rcache) {
552         $CFG->cachetype = '';
553     }
555     if ($CFG->cachetype === 'memcached' && !empty($CFG->memcachedhosts)) {
556         if (!init_memcached()) {
557             debugging("Error initialising memcached");
558             $CFG->cachetype = '';
559             $CFG->rcache = false;
560         }
561     } else if ($CFG->cachetype === 'eaccelerator') {
562         if (!init_eaccelerator()) {
563             debugging("Error initialising eaccelerator cache");
564             $CFG->cachetype = '';
565             $CFG->rcache = false;
566         }
567     }
569 } else { // just make sure it is defined
570     $CFG->cachetype = '';
571     $CFG->rcache    = false;
574 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
575 // - WINDOWS: for any Windows flavour.
576 // - UNIX: for the rest
577 // Also, $CFG->os can continue being used if more specialization is required
578 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
579     $CFG->ostype = 'WINDOWS';
580 } else {
581     $CFG->ostype = 'UNIX';
583 $CFG->os = PHP_OS;
585 // Configure ampersands in URLs
586 ini_set('arg_separator.output', '&amp;');
588 // Work around for a PHP bug   see MDL-11237
589 ini_set('pcre.backtrack_limit', 20971520);  // 20 MB
591 // Location of standard files
592 $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
593 $CFG->moddata  = 'moddata';
595 // Create the $PAGE global.
596 if (!empty($CFG->moodlepageclass)) {
597     $classname = $CFG->moodlepageclass;
598 } else {
599     $classname = 'moodle_page';
601 $PAGE = new $classname();
602 unset($classname);
604 // A hack to get around magic_quotes_gpc being turned on
605 // It is strongly recommended to disable "magic_quotes_gpc"!
606 if (ini_get_bool('magic_quotes_gpc')) {
607     function stripslashes_deep($value) {
608         $value = is_array($value) ?
609                 array_map('stripslashes_deep', $value) :
610                 stripslashes($value);
611         return $value;
612     }
613     $_POST = array_map('stripslashes_deep', $_POST);
614     $_GET = array_map('stripslashes_deep', $_GET);
615     $_COOKIE = array_map('stripslashes_deep', $_COOKIE);
616     $_REQUEST = array_map('stripslashes_deep', $_REQUEST);
617     if (!empty($_SERVER['REQUEST_URI'])) {
618         $_SERVER['REQUEST_URI'] = stripslashes($_SERVER['REQUEST_URI']);
619     }
620     if (!empty($_SERVER['QUERY_STRING'])) {
621         $_SERVER['QUERY_STRING'] = stripslashes($_SERVER['QUERY_STRING']);
622     }
623     if (!empty($_SERVER['HTTP_REFERER'])) {
624         $_SERVER['HTTP_REFERER'] = stripslashes($_SERVER['HTTP_REFERER']);
625     }
626    if (!empty($_SERVER['PATH_INFO'])) {
627         $_SERVER['PATH_INFO'] = stripslashes($_SERVER['PATH_INFO']);
628     }
629     if (!empty($_SERVER['PHP_SELF'])) {
630         $_SERVER['PHP_SELF'] = stripslashes($_SERVER['PHP_SELF']);
631     }
632     if (!empty($_SERVER['PATH_TRANSLATED'])) {
633         $_SERVER['PATH_TRANSLATED'] = stripslashes($_SERVER['PATH_TRANSLATED']);
634     }
637 // neutralise nasty chars in PHP_SELF
638 if (isset($_SERVER['PHP_SELF'])) {
639     $phppos = strpos($_SERVER['PHP_SELF'], '.php');
640     if ($phppos !== false) {
641         $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
642     }
643     unset($phppos);
646 // initialise ME's
647 initialise_fullme();
649 // init session prevention flag - this is defined on pages that do not want session
650 if (CLI_SCRIPT) {
651     // no sessions in CLI scripts possible
652     define('NO_MOODLE_COOKIES', true);
654 } else if (!defined('NO_MOODLE_COOKIES')) {
655     if (empty($CFG->version) or $CFG->version < 2009011900) {
656         // no session before sessions table gets created
657         define('NO_MOODLE_COOKIES', true);
658     } else if (CLI_SCRIPT) {
659         // CLI scripts can not have session
660         define('NO_MOODLE_COOKIES', true);
661     } else {
662         define('NO_MOODLE_COOKIES', false);
663     }
666 // start session and prepare global $SESSION, $USER
667 session_get_instance();
668 $SESSION = &$_SESSION['SESSION'];
669 $USER    = &$_SESSION['USER'];
671 // include and start profiling if needed, and register profiling_stop as shutdown function
672 if (!empty($CFG->profilingenabled)) {
673     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
674     profiling_start();
675     register_shutdown_function('profiling_stop');
678 // Process theme change in the URL.
679 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
680     // we have to use _GET directly because we do not want this to interfere with _POST
681     $urlthemename = optional_param('theme', '', PARAM_SAFEDIR);
682     try {
683         $themeconfig = theme_config::load($urlthemename);
684         // Makes sure the theme can be loaded without errors.
685         if ($themeconfig->name === $urlthemename) {
686             $SESSION->theme = $urlthemename;
687         } else {
688             unset($SESSION->theme);
689         }
690         unset($themeconfig);
691         unset($urlthemename);
692     } catch (Exception $e) {
693         debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
694     }
696 unset($urlthemename);
698 // Ensure a valid theme is set.
699 if (!isset($CFG->theme)) {
700     $CFG->theme = 'standardwhite';
703 // Set language/locale of printed times.  If user has chosen a language that
704 // that is different from the site language, then use the locale specified
705 // in the language file.  Otherwise, if the admin hasn't specified a locale
706 // then use the one from the default language.  Otherwise (and this is the
707 // majority of cases), use the stored locale specified by admin.
708 // note: do not accept lang parameter from POST
709 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
710     if (get_string_manager()->translation_exists($lang, false)) {
711         $SESSION->lang = $lang;
712     }
714 unset($lang);
716 setup_lang_from_browser();
718 if (empty($CFG->lang)) {
719     if (empty($SESSION->lang)) {
720         $CFG->lang = 'en';
721     } else {
722         $CFG->lang = $SESSION->lang;
723     }
726 // Set the default site locale, a lot of the stuff may depend on this
727 // it is definitely too late to call this first in require_login()!
728 moodle_setlocale();
730 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
731     if ($CFG->theme == 'standard' or $CFG->theme == 'standardwhite') {    // Temporary measure to help with XHTML validation
732         if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) {      // Allow W3CValidator in as user called w3cvalidator (or guest)
733             if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
734                 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
735                 if ($user = get_complete_user_data("username", "w3cvalidator")) {
736                     $user->ignoresesskey = true;
737                 } else {
738                     $user = guest_user();
739                 }
740                 session_set_user($user);
741             }
742         }
743     }
746 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
747 // LogFormat to get the current logged in username in moodle.
748 if ($USER && function_exists('apache_note')
749     && !empty($CFG->apacheloguser) && isset($USER->username)) {
750     $apachelog_userid = $USER->id;
751     $apachelog_username = clean_filename($USER->username);
752     $apachelog_name = '';
753     if (isset($USER->firstname)) {
754         // We can assume both will be set
755         // - even if to empty.
756         $apachelog_name = clean_filename($USER->firstname . " " .
757                                          $USER->lastname);
758     }
759     if (session_is_loggedinas()) {
760         $realuser = session_get_realuser();
761         $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
762         $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
763         $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
764     }
765     switch ($CFG->apacheloguser) {
766         case 3:
767             $logname = $apachelog_username;
768             break;
769         case 2:
770             $logname = $apachelog_name;
771             break;
772         case 1:
773         default:
774             $logname = $apachelog_userid;
775             break;
776     }
777     apache_note('MOODLEUSER', $logname);
780 // Adjust ALLOWED_TAGS
781 adjust_allowed_tags();
783 // Use a custom script replacement if one exists
784 if (!empty($CFG->customscripts)) {
785     if (($customscript = custom_script_path()) !== false) {
786         require ($customscript);
787     }
790 // in the first case, ip in allowed list will be performed first
791 // for example, client IP is 192.168.1.1
792 // 192.168 subnet is an entry in allowed list
793 // 192.168.1.1 is banned in blocked list
794 // This ip will be banned finally
795 if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
796     if (!empty($CFG->allowedip)) {
797         if (!remoteip_in_list($CFG->allowedip)) {
798             die(get_string('ipblocked', 'admin'));
799         }
800     }
801     // need further check, client ip may a part of
802     // allowed subnet, but a IP address are listed
803     // in blocked list.
804     if (!empty($CFG->blockedip)) {
805         if (remoteip_in_list($CFG->blockedip)) {
806             die(get_string('ipblocked', 'admin'));
807         }
808     }
810 } else {
811     // in this case, IPs in blocked list will be performed first
812     // for example, client IP is 192.168.1.1
813     // 192.168 subnet is an entry in blocked list
814     // 192.168.1.1 is allowed in allowed list
815     // This ip will be allowed finally
816     if (!empty($CFG->blockedip)) {
817         if (remoteip_in_list($CFG->blockedip)) {
818             // if the allowed ip list is not empty
819             // IPs are not included in the allowed list will be
820             // blocked too
821             if (!empty($CFG->allowedip)) {
822                 if (!remoteip_in_list($CFG->allowedip)) {
823                     die(get_string('ipblocked', 'admin'));
824                 }
825             } else {
826                 die(get_string('ipblocked', 'admin'));
827             }
828         }
829     }
830     // if blocked list is null
831     // allowed list should be tested
832     if(!empty($CFG->allowedip)) {
833         if (!remoteip_in_list($CFG->allowedip)) {
834             die(get_string('ipblocked', 'admin'));
835         }
836     }
840 // note: we can not block non utf-8 installations here, because empty mysql database
841 // might be converted to utf-8 in admin/index.php during installation
845 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
846 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
847 if (false) {
848     $DB = new moodle_database();
849     $OUTPUT = new core_renderer(null, null);
850     $PAGE = new moodle_page();