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