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