MDL-44599 undeprecate SITEID
[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  *  - $CFG->tempdir  - Path to moodle's temp file directory on server's filesystem.
40  *  - $CFG->cachedir - Path to moodle's cache directory on server's filesystem (shared by cluster nodes).
41  *  - $CFG->localcachedir - Path to moodle's local cache directory (not shared by cluster nodes).
42  *
43  * @global object $CFG
44  * @name $CFG
45  */
46 global $CFG; // this should be done much earlier in config.php before creating new $CFG instance
48 if (!isset($CFG)) {
49     if (defined('PHPUNIT_TEST') and PHPUNIT_TEST) {
50         echo('There is a missing "global $CFG;" at the beginning of the config.php file.'."\n");
51         exit(1);
52     } else {
53         // this should never happen, maybe somebody is accessing this file directly...
54         exit(1);
55     }
56 }
58 // We can detect real dirroot path reliably since PHP 4.0.2,
59 // it can not be anything else, there is no point in having this in config.php
60 $CFG->dirroot = dirname(dirname(__FILE__));
62 // File permissions on created directories in the $CFG->dataroot
63 if (!isset($CFG->directorypermissions)) {
64     $CFG->directorypermissions = 02777;      // Must be octal (that's why it's here)
65 }
66 if (!isset($CFG->filepermissions)) {
67     $CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags
68 }
69 // Better also set default umask because developers often forget to include directory
70 // permissions in mkdir() and chmod() after creating new files.
71 if (!isset($CFG->umaskpermissions)) {
72     $CFG->umaskpermissions = (($CFG->directorypermissions & 0777) ^ 0777);
73 }
74 umask($CFG->umaskpermissions);
76 if (defined('BEHAT_SITE_RUNNING')) {
77     // We already switched to behat test site previously.
79 } else if (!empty($CFG->behat_wwwroot) or !empty($CFG->behat_dataroot) or !empty($CFG->behat_prefix)) {
80     // The behat is configured on this server, we need to find out if this is the behat test
81     // site based on the URL used for access.
82     require_once(__DIR__ . '/../lib/behat/lib.php');
83     if (behat_is_test_site()) {
84         // Checking the integrity of the provided $CFG->behat_* vars and the
85         // selected wwwroot to prevent conflicts with production and phpunit environments.
86         behat_check_config_vars();
88         // Check that the directory does not contains other things.
89         if (!file_exists("$CFG->behat_dataroot/behattestdir.txt")) {
90             if ($dh = opendir($CFG->behat_dataroot)) {
91                 while (($file = readdir($dh)) !== false) {
92                     if ($file === 'behat' or $file === '.' or $file === '..' or $file === '.DS_Store') {
93                         continue;
94                     }
95                     behat_error(BEHAT_EXITCODE_CONFIG, '$CFG->behat_dataroot directory is not empty, ensure this is the directory where you want to install behat test dataroot');
96                 }
97                 closedir($dh);
98                 unset($dh);
99                 unset($file);
100             }
102             if (defined('BEHAT_UTIL')) {
103                 // Now we create dataroot directory structure for behat tests.
104                 testing_initdataroot($CFG->behat_dataroot, 'behat');
105             } else {
106                 behat_error(BEHAT_EXITCODE_INSTALL);
107             }
108         }
110         if (!defined('BEHAT_UTIL') and !defined('BEHAT_TEST')) {
111             // Somebody tries to access test site directly, tell them if not enabled.
112             if (!file_exists($CFG->behat_dataroot . '/behat/test_environment_enabled.txt')) {
113                 behat_error(BEHAT_EXITCODE_CONFIG, 'Behat is configured but not enabled on this test site.');
114             }
115         }
117         // Constant used to inform that the behat test site is being used,
118         // this includes all the processes executed by the behat CLI command like
119         // the site reset, the steps executed by the browser drivers when simulating
120         // a user session and a real session when browsing manually to $CFG->behat_wwwroot
121         // like the browser driver does automatically.
122         // Different from BEHAT_TEST as only this last one can perform CLI
123         // actions like reset the site or use data generators.
124         define('BEHAT_SITE_RUNNING', true);
126         // Clean extra config.php settings.
127         behat_clean_init_config();
129         // Now we can begin switching $CFG->X for $CFG->behat_X.
130         $CFG->wwwroot = $CFG->behat_wwwroot;
131         $CFG->prefix = $CFG->behat_prefix;
132         $CFG->dataroot = $CFG->behat_dataroot;
133     }
136 // Normalise dataroot - we do not want any symbolic links, trailing / or any other weirdness there
137 if (!isset($CFG->dataroot)) {
138     if (isset($_SERVER['REMOTE_ADDR'])) {
139         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
140     }
141     echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n");
142     exit(1);
144 $CFG->dataroot = realpath($CFG->dataroot);
145 if ($CFG->dataroot === false) {
146     if (isset($_SERVER['REMOTE_ADDR'])) {
147         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
148     }
149     echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n");
150     exit(1);
151 } else if (!is_writable($CFG->dataroot)) {
152     if (isset($_SERVER['REMOTE_ADDR'])) {
153         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
154     }
155     echo('Fatal error: $CFG->dataroot is not writable, admin has to fix directory permissions! Exiting.'."\n");
156     exit(1);
159 // wwwroot is mandatory
160 if (!isset($CFG->wwwroot) or $CFG->wwwroot === 'http://example.com/moodle') {
161     if (isset($_SERVER['REMOTE_ADDR'])) {
162         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
163     }
164     echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n");
165     exit(1);
168 // Make sure there is some database table prefix.
169 if (!isset($CFG->prefix)) {
170     $CFG->prefix = '';
173 // Define admin directory
174 if (!isset($CFG->admin)) {   // Just in case it isn't defined in config.php
175     $CFG->admin = 'admin';   // This is relative to the wwwroot and dirroot
178 // Set up some paths.
179 $CFG->libdir = $CFG->dirroot .'/lib';
181 // Allow overriding of tempdir but be backwards compatible
182 if (!isset($CFG->tempdir)) {
183     $CFG->tempdir = "$CFG->dataroot/temp";
186 // Allow overriding of cachedir but be backwards compatible
187 if (!isset($CFG->cachedir)) {
188     $CFG->cachedir = "$CFG->dataroot/cache";
191 // Allow overriding of localcachedir.
192 if (!isset($CFG->localcachedir)) {
193     $CFG->localcachedir = "$CFG->dataroot/localcache";
196 // Location of all languages except core English pack.
197 if (!isset($CFG->langotherroot)) {
198     $CFG->langotherroot = $CFG->dataroot.'/lang';
201 // Location of local lang pack customisations (dirs with _local suffix).
202 if (!isset($CFG->langlocalroot)) {
203     $CFG->langlocalroot = $CFG->dataroot.'/lang';
206 // The current directory in PHP version 4.3.0 and above isn't necessarily the
207 // directory of the script when run from the command line. The require_once()
208 // would fail, so we'll have to chdir()
209 if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
210     // do it only once - skip the second time when continuing after prevous abort
211     if (!defined('ABORT_AFTER_CONFIG') and !defined('ABORT_AFTER_CONFIG_CANCEL')) {
212         chdir(dirname($_SERVER['argv'][0]));
213     }
216 // sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that??
217 ini_set('precision', 14); // needed for upgrades and gradebook
218 ini_set('serialize_precision', 17); // Make float serialization consistent on all systems.
220 // Scripts may request no debug and error messages in output
221 // please note it must be defined before including the config.php script
222 // and in some cases you also need to set custom default exception handler
223 if (!defined('NO_DEBUG_DISPLAY')) {
224     if (defined('AJAX_SCRIPT') and AJAX_SCRIPT) {
225         // Moodle AJAX scripts are expected to return json data, any PHP notices or errors break it badly,
226         // developers simply must learn to watch error log.
227         define('NO_DEBUG_DISPLAY', true);
228     } else {
229         define('NO_DEBUG_DISPLAY', false);
230     }
233 // Some scripts such as upgrade may want to prevent output buffering
234 if (!defined('NO_OUTPUT_BUFFERING')) {
235     define('NO_OUTPUT_BUFFERING', false);
238 // PHPUnit tests need custom init
239 if (!defined('PHPUNIT_TEST')) {
240     define('PHPUNIT_TEST', false);
243 // Performance tests needs to always display performance info, even in redirections.
244 if (!defined('MDL_PERF_TEST')) {
245     define('MDL_PERF_TEST', false);
246 } else {
247     // We force the ones we need.
248     if (!defined('MDL_PERF')) {
249         define('MDL_PERF', true);
250     }
251     if (!defined('MDL_PERFDB')) {
252         define('MDL_PERFDB', true);
253     }
254     if (!defined('MDL_PERFTOFOOT')) {
255         define('MDL_PERFTOFOOT', true);
256     }
259 // When set to true MUC (Moodle caching) will be disabled as much as possible.
260 // A special cache factory will be used to handle this situation and will use special "disabled" equivalents objects.
261 // This ensure we don't attempt to read or create the config file, don't use stores, don't provide persistence or
262 // storage of any kind.
263 if (!defined('CACHE_DISABLE_ALL')) {
264     define('CACHE_DISABLE_ALL', false);
267 // When set to true MUC (Moodle caching) will not use any of the defined or default stores.
268 // The Cache API will continue to function however this will force the use of the cachestore_dummy so all requests
269 // will be interacting with a static property and will never go to the proper cache stores.
270 // Useful if you need to avoid the stores for one reason or another.
271 if (!defined('CACHE_DISABLE_STORES')) {
272     define('CACHE_DISABLE_STORES', false);
275 // Servers should define a default timezone in php.ini, but if they don't then make sure something is defined.
276 // This is a quick hack.  Ideally we should ask the admin for a value.  See MDL-22625 for more on this.
277 if (function_exists('date_default_timezone_set') and function_exists('date_default_timezone_get')) {
278     $olddebug = error_reporting(0);
279     date_default_timezone_set(date_default_timezone_get());
280     error_reporting($olddebug);
281     unset($olddebug);
284 // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output
285 // In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php.
286 // Please note that one script can not be accessed from both CLI and web interface.
287 if (!defined('CLI_SCRIPT')) {
288     define('CLI_SCRIPT', false);
290 if (defined('WEB_CRON_EMULATED_CLI')) {
291     if (!isset($_SERVER['REMOTE_ADDR'])) {
292         echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n");
293         exit(1);
294     }
295 } else if (isset($_SERVER['REMOTE_ADDR'])) {
296     if (CLI_SCRIPT) {
297         echo('Command line scripts can not be executed from the web interface');
298         exit(1);
299     }
300 } else {
301     if (!CLI_SCRIPT) {
302         echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
303         exit(1);
304     }
307 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades
308 if (file_exists("$CFG->dataroot/climaintenance.html")) {
309     if (!CLI_SCRIPT) {
310         header('Content-type: text/html; charset=utf-8');
311         header('X-UA-Compatible: IE=edge');
312         /// Headers to make it not cacheable and json
313         header('Cache-Control: no-store, no-cache, must-revalidate');
314         header('Cache-Control: post-check=0, pre-check=0', false);
315         header('Pragma: no-cache');
316         header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
317         header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
318         header('Accept-Ranges: none');
319         readfile("$CFG->dataroot/climaintenance.html");
320         die;
321     } else {
322         if (!defined('CLI_MAINTENANCE')) {
323             define('CLI_MAINTENANCE', true);
324         }
325     }
326 } else {
327     if (!defined('CLI_MAINTENANCE')) {
328         define('CLI_MAINTENANCE', false);
329     }
332 if (CLI_SCRIPT) {
333     // sometimes people use different PHP binary for web and CLI, make 100% sure they have the supported PHP version
334     if (version_compare(phpversion(), '5.4.4') < 0) {
335         $phpversion = phpversion();
336         // do NOT localise - lang strings would not work here and we CAN NOT move it to later place
337         echo "Moodle 2.7 or later requires at least PHP 5.4.4 (currently using version $phpversion).\n";
338         echo "Some servers may have multiple PHP versions installed, are you using the correct executable?\n";
339         exit(1);
340     }
343 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
344 if (!defined('AJAX_SCRIPT')) {
345     define('AJAX_SCRIPT', false);
348 // Exact version of currently used yui2 and 3 library.
349 $CFG->yui2version = '2.9.0';
350 $CFG->yui3version = '3.15.0';
352 // Patching the upstream YUI release.
353 // For important information on patching YUI modules, please see http://docs.moodle.org/dev/YUI/Patching.
354 // If we need to patch a YUI modules between official YUI releases, the yuipatchlevel will need to be manually
355 // incremented here. The module will also need to be listed in the yuipatchedmodules.
356 // When upgrading to a subsequent version of YUI, these should be reset back to 0 and an empty array.
357 $CFG->yuipatchlevel = 0;
358 $CFG->yuipatchedmodules = array(
359 );
361 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides.
362 if (!isset($CFG->config_php_settings)) {
363     $CFG->config_php_settings = (array)$CFG;
364     // Forced plugin settings override values from config_plugins table.
365     unset($CFG->config_php_settings['forced_plugin_settings']);
366     if (!isset($CFG->forced_plugin_settings)) {
367         $CFG->forced_plugin_settings = array();
368     }
371 if (isset($CFG->debug)) {
372     $CFG->debug = (int)$CFG->debug;
373 } else {
374     $CFG->debug = 0;
376 $CFG->debugdeveloper = (($CFG->debug & (E_ALL | E_STRICT)) === (E_ALL | E_STRICT)); // DEBUG_DEVELOPER is not available yet.
378 if (!defined('MOODLE_INTERNAL')) { // Necessary because cli installer has to define it earlier.
379     /** Used by library scripts to check they are being called by Moodle. */
380     define('MOODLE_INTERNAL', true);
383 // core_component can be used in any scripts, it does not need anything else.
384 require_once($CFG->libdir .'/classes/component.php');
386 // special support for highly optimised scripts that do not need libraries and DB connection
387 if (defined('ABORT_AFTER_CONFIG')) {
388     if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
389         // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
390         error_reporting($CFG->debug);
391         if (NO_DEBUG_DISPLAY) {
392             // Some parts of Moodle cannot display errors and debug at all.
393             ini_set('display_errors', '0');
394             ini_set('log_errors', '1');
395         } else if (empty($CFG->debugdisplay)) {
396             ini_set('display_errors', '0');
397             ini_set('log_errors', '1');
398         } else {
399             ini_set('display_errors', '1');
400         }
401         require_once("$CFG->dirroot/lib/configonlylib.php");
402         return;
403     }
406 // Early profiling start, based exclusively on config.php $CFG settings
407 if (!empty($CFG->earlyprofilingenabled)) {
408     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
409     profiling_start();
412 /**
413  * Database connection. Used for all access to the database.
414  * @global moodle_database $DB
415  * @name $DB
416  */
417 global $DB;
419 /**
420  * Moodle's wrapper round PHP's $_SESSION.
421  *
422  * @global object $SESSION
423  * @name $SESSION
424  */
425 global $SESSION;
427 /**
428  * Holds the user table record for the current user. Will be the 'guest'
429  * user record for people who are not logged in.
430  *
431  * $USER is stored in the session.
432  *
433  * Items found in the user record:
434  *  - $USER->email - The user's email address.
435  *  - $USER->id - The unique integer identified of this user in the 'user' table.
436  *  - $USER->email - The user's email address.
437  *  - $USER->firstname - The user's first name.
438  *  - $USER->lastname - The user's last name.
439  *  - $USER->username - The user's login username.
440  *  - $USER->secret - The user's ?.
441  *  - $USER->lang - The user's language choice.
442  *
443  * @global object $USER
444  * @name $USER
445  */
446 global $USER;
448 /**
449  * Frontpage course record
450  */
451 global $SITE;
453 /**
454  * A central store of information about the current page we are
455  * generating in response to the user's request.
456  *
457  * @global moodle_page $PAGE
458  * @name $PAGE
459  */
460 global $PAGE;
462 /**
463  * The current course. An alias for $PAGE->course.
464  * @global object $COURSE
465  * @name $COURSE
466  */
467 global $COURSE;
469 /**
470  * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
471  * it to generate HTML for output.
472  *
473  * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
474  * for the magic that does that. After $OUTPUT has been initialised, any attempt
475  * to change something that affects the current theme ($PAGE->course, logged in use,
476  * httpsrequried ... will result in an exception.)
477  *
478  * Please note the $OUTPUT is replacing the old global $THEME object.
479  *
480  * @global object $OUTPUT
481  * @name $OUTPUT
482  */
483 global $OUTPUT;
485 /**
486  * Full script path including all params, slash arguments, scheme and host.
487  *
488  * Note: Do NOT use for getting of current page URL or detection of https,
489  * instead use $PAGE->url or strpos($CFG->httpswwwroot, 'https:') === 0
490  *
491  * @global string $FULLME
492  * @name $FULLME
493  */
494 global $FULLME;
496 /**
497  * Script path including query string and slash arguments without host.
498  * @global string $ME
499  * @name $ME
500  */
501 global $ME;
503 /**
504  * $FULLME without slasharguments and query string.
505  * @global string $FULLSCRIPT
506  * @name $FULLSCRIPT
507  */
508 global $FULLSCRIPT;
510 /**
511  * Relative moodle script path '/course/view.php'
512  * @global string $SCRIPT
513  * @name $SCRIPT
514  */
515 global $SCRIPT;
517 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
518 // inside some URLs used in HTTPSPAGEREQUIRED pages.
519 $CFG->httpswwwroot = $CFG->wwwroot;
521 require_once($CFG->libdir .'/setuplib.php');        // Functions that MUST be loaded first
523 if (NO_OUTPUT_BUFFERING) {
524     // we have to call this always before starting session because it discards headers!
525     disable_output_buffering();
528 // Increase memory limits if possible
529 raise_memory_limit(MEMORY_STANDARD);
531 // Time to start counting
532 init_performance_info();
534 // Put $OUTPUT in place, so errors can be displayed.
535 $OUTPUT = new bootstrap_renderer();
537 // set handler for uncaught exceptions - equivalent to print_error() call
538 if (!PHPUNIT_TEST or PHPUNIT_UTIL) {
539     set_exception_handler('default_exception_handler');
540     set_error_handler('default_error_handler', E_ALL | E_STRICT);
543 // Acceptance tests needs special output to capture the errors,
544 // but not necessary for behat CLI command.
545 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST')) {
546     require_once(__DIR__ . '/behat/lib.php');
547     set_error_handler('behat_error_handler', E_ALL | E_STRICT);
550 // If there are any errors in the standard libraries we want to know!
551 error_reporting(E_ALL | E_STRICT);
553 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
554 // http://www.google.com/webmasters/faq.html#prefetchblock
555 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
556     header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
557     echo('Prefetch request forbidden.');
558     exit(1);
561 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
562 //the problem is that we need specific version of quickforms and hacked excel files :-(
563 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
564 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
565 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
566 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
568 // Register our classloader, in theory somebody might want to replace it to load other hacked core classes.
569 if (defined('COMPONENT_CLASSLOADER')) {
570     spl_autoload_register(COMPONENT_CLASSLOADER);
571 } else {
572     spl_autoload_register('core_component::classloader');
575 // Load up standard libraries
576 require_once($CFG->libdir .'/filterlib.php');       // Functions for filtering test as it is output
577 require_once($CFG->libdir .'/ajax/ajaxlib.php');    // Functions for managing our use of JavaScript and YUI
578 require_once($CFG->libdir .'/weblib.php');          // Functions relating to HTTP and content
579 require_once($CFG->libdir .'/outputlib.php');       // Functions for generating output
580 require_once($CFG->libdir .'/navigationlib.php');   // Class for generating Navigation structure
581 require_once($CFG->libdir .'/dmllib.php');          // Database access
582 require_once($CFG->libdir .'/datalib.php');         // Legacy lib with a big-mix of functions.
583 require_once($CFG->libdir .'/accesslib.php');       // Access control functions
584 require_once($CFG->libdir .'/deprecatedlib.php');   // Deprecated functions included for backward compatibility
585 require_once($CFG->libdir .'/moodlelib.php');       // Other general-purpose functions
586 require_once($CFG->libdir .'/enrollib.php');        // Enrolment related functions
587 require_once($CFG->libdir .'/pagelib.php');         // Library that defines the moodle_page class, used for $PAGE
588 require_once($CFG->libdir .'/blocklib.php');        // Library for controlling blocks
589 require_once($CFG->libdir .'/eventslib.php');       // Events functions
590 require_once($CFG->libdir .'/grouplib.php');        // Groups functions
591 require_once($CFG->libdir .'/sessionlib.php');      // All session and cookie related stuff
592 require_once($CFG->libdir .'/editorlib.php');       // All text editor related functions and classes
593 require_once($CFG->libdir .'/messagelib.php');      // Messagelib functions
594 require_once($CFG->libdir .'/modinfolib.php');      // Cached information on course-module instances
595 require_once($CFG->dirroot.'/cache/lib.php');       // Cache API
597 // make sure PHP is not severly misconfigured
598 setup_validate_php_configuration();
600 // Connect to the database
601 setup_DB();
603 if (PHPUNIT_TEST and !PHPUNIT_UTIL) {
604     // make sure tests do not run in parallel
605     test_lock::acquire('phpunit');
606     $dbhash = null;
607     try {
608         if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) {
609             // reset DB tables
610             phpunit_util::reset_database();
611         }
612     } catch (Exception $e) {
613         if ($dbhash) {
614             // we ned to reinit if reset fails
615             $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest'));
616         }
617     }
618     unset($dbhash);
621 // Load up any configuration from the config table or MUC cache.
622 if (PHPUNIT_TEST) {
623     phpunit_util::initialise_cfg();
624 } else {
625     initialise_cfg();
628 if (isset($CFG->debug)) {
629     $CFG->debug = (int)$CFG->debug;
630     error_reporting($CFG->debug);
631 }  else {
632     $CFG->debug = 0;
634 $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER);
636 // Find out if PHP configured to display warnings,
637 // this is a security problem because some moodle scripts may
638 // disclose sensitive information.
639 if (ini_get_bool('display_errors')) {
640     define('WARN_DISPLAY_ERRORS_ENABLED', true);
642 // If we want to display Moodle errors, then try and set PHP errors to match.
643 if (!isset($CFG->debugdisplay)) {
644     // Keep it "as is" during installation.
645 } else if (NO_DEBUG_DISPLAY) {
646     // Some parts of Moodle cannot display errors and debug at all.
647     ini_set('display_errors', '0');
648     ini_set('log_errors', '1');
649 } else if (empty($CFG->debugdisplay)) {
650     ini_set('display_errors', '0');
651     ini_set('log_errors', '1');
652 } else {
653     // This is very problematic in XHTML strict mode!
654     ini_set('display_errors', '1');
657 // Register our shutdown manager, do NOT use register_shutdown_function().
658 core_shutdown_manager::initialize();
660 // Verify upgrade is not running unless we are in a script that needs to execute in any case
661 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
662     if ($CFG->upgraderunning < time()) {
663         unset_config('upgraderunning');
664     } else {
665         print_error('upgraderunning');
666     }
669 // Turn on SQL logging if required
670 if (!empty($CFG->logsql)) {
671     $DB->set_logging(true);
674 // enable circular reference collector in PHP 5.3,
675 // it helps a lot when using large complex OOP structures such as in amos or gradebook
676 if (function_exists('gc_enable')) {
677     gc_enable();
680 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
681 if (!empty($CFG->version) and $CFG->version < 2007101509) {
682     print_error('upgraderequires19', 'error');
683     die;
686 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
687 // - WINDOWS: for any Windows flavour.
688 // - UNIX: for the rest
689 // Also, $CFG->os can continue being used if more specialization is required
690 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
691     $CFG->ostype = 'WINDOWS';
692 } else {
693     $CFG->ostype = 'UNIX';
695 $CFG->os = PHP_OS;
697 // Configure ampersands in URLs
698 ini_set('arg_separator.output', '&amp;');
700 // Work around for a PHP bug   see MDL-11237
701 ini_set('pcre.backtrack_limit', 20971520);  // 20 MB
703 // Location of standard files
704 $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
705 $CFG->moddata  = 'moddata';
707 // neutralise nasty chars in PHP_SELF
708 if (isset($_SERVER['PHP_SELF'])) {
709     $phppos = strpos($_SERVER['PHP_SELF'], '.php');
710     if ($phppos !== false) {
711         $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
712     }
713     unset($phppos);
716 // initialise ME's - this must be done BEFORE starting of session!
717 initialise_fullme();
719 // define SYSCONTEXTID in config.php if you want to save some queries,
720 // after install it must match the system context record id.
721 if (!defined('SYSCONTEXTID')) {
722     context_system::instance();
725 // Defining the site - aka frontpage course
726 try {
727     $SITE = get_site();
728 } catch (moodle_exception $e) {
729     $SITE = null;
730     if (empty($CFG->version)) {
731         $SITE = new stdClass();
732         $SITE->id = 1;
733         $SITE->shortname = null;
734     } else {
735         throw $e;
736     }
738 // And the 'default' course - this will usually get reset later in require_login() etc.
739 $COURSE = clone($SITE);
740 // Id of the frontpage course.
741 define('SITEID', $SITE->id);
743 // init session prevention flag - this is defined on pages that do not want session
744 if (CLI_SCRIPT) {
745     // no sessions in CLI scripts possible
746     define('NO_MOODLE_COOKIES', true);
748 } else if (!defined('NO_MOODLE_COOKIES')) {
749     if (empty($CFG->version) or $CFG->version < 2009011900) {
750         // no session before sessions table gets created
751         define('NO_MOODLE_COOKIES', true);
752     } else if (CLI_SCRIPT) {
753         // CLI scripts can not have session
754         define('NO_MOODLE_COOKIES', true);
755     } else {
756         define('NO_MOODLE_COOKIES', false);
757     }
760 // Start session and prepare global $SESSION, $USER.
761 if (empty($CFG->sessiontimeout)) {
762     $CFG->sessiontimeout = 7200;
764 \core\session\manager::start();
765 if (!PHPUNIT_TEST and !defined('BEHAT_TEST')) {
766     $SESSION =& $_SESSION['SESSION'];
767     $USER    =& $_SESSION['USER'];
770 // Initialise some variables that are supposed to be set in config.php only.
771 if (!isset($CFG->filelifetime)) {
772     $CFG->filelifetime = 60*60*6;
775 // Late profiling, only happening if early one wasn't started
776 if (!empty($CFG->profilingenabled)) {
777     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
778     profiling_start();
781 // Hack to get around max_input_vars restrictions,
782 // we need to do this after session init to have some basic DDoS protection.
783 workaround_max_input_vars();
785 // Process theme change in the URL.
786 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
787     // we have to use _GET directly because we do not want this to interfere with _POST
788     $urlthemename = optional_param('theme', '', PARAM_PLUGIN);
789     try {
790         $themeconfig = theme_config::load($urlthemename);
791         // Makes sure the theme can be loaded without errors.
792         if ($themeconfig->name === $urlthemename) {
793             $SESSION->theme = $urlthemename;
794         } else {
795             unset($SESSION->theme);
796         }
797         unset($themeconfig);
798         unset($urlthemename);
799     } catch (Exception $e) {
800         debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
801     }
803 unset($urlthemename);
805 // Ensure a valid theme is set.
806 if (!isset($CFG->theme)) {
807     $CFG->theme = 'standard';
810 // Set language/locale of printed times.  If user has chosen a language that
811 // that is different from the site language, then use the locale specified
812 // in the language file.  Otherwise, if the admin hasn't specified a locale
813 // then use the one from the default language.  Otherwise (and this is the
814 // majority of cases), use the stored locale specified by admin.
815 // note: do not accept lang parameter from POST
816 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
817     if (get_string_manager()->translation_exists($lang, false)) {
818         $SESSION->lang = $lang;
819     }
821 unset($lang);
823 // PARAM_SAFEDIR used instead of PARAM_LANG because using PARAM_LANG results
824 // in an empty string being returned when a non-existant language is specified,
825 // which would make it necessary to log out to undo the forcelang setting.
826 // With PARAM_SAFEDIR, it's possible to specify ?forcelang=none to drop the forcelang effect.
827 if ($forcelang = optional_param('forcelang', '', PARAM_SAFEDIR)) {
828     if (isloggedin()
829         && get_string_manager()->translation_exists($forcelang, false)
830         && has_capability('moodle/site:forcelanguage', context_system::instance())) {
831         $SESSION->forcelang = $forcelang;
832     } else if (isset($SESSION->forcelang)) {
833         unset($SESSION->forcelang);
834     }
836 unset($forcelang);
838 setup_lang_from_browser();
840 if (empty($CFG->lang)) {
841     if (empty($SESSION->lang)) {
842         $CFG->lang = 'en';
843     } else {
844         $CFG->lang = $SESSION->lang;
845     }
848 // Set the default site locale, a lot of the stuff may depend on this
849 // it is definitely too late to call this first in require_login()!
850 moodle_setlocale();
852 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup!
853 if (!empty($CFG->moodlepageclass)) {
854     if (!empty($CFG->moodlepageclassfile)) {
855         require_once($CFG->moodlepageclassfile);
856     }
857     $classname = $CFG->moodlepageclass;
858 } else {
859     $classname = 'moodle_page';
861 $PAGE = new $classname();
862 unset($classname);
865 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
866     if ($CFG->theme == 'standard') {    // Temporary measure to help with XHTML validation
867         if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) {      // Allow W3CValidator in as user called w3cvalidator (or guest)
868             if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
869                 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
870                 if ($user = get_complete_user_data("username", "w3cvalidator")) {
871                     $user->ignoresesskey = true;
872                 } else {
873                     $user = guest_user();
874                 }
875                 \core\session\manager::set_user($user);
876             }
877         }
878     }
881 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
882 // LogFormat to get the current logged in username in moodle.
883 if ($USER && function_exists('apache_note')
884     && !empty($CFG->apacheloguser) && isset($USER->username)) {
885     $apachelog_userid = $USER->id;
886     $apachelog_username = clean_filename($USER->username);
887     $apachelog_name = '';
888     if (isset($USER->firstname)) {
889         // We can assume both will be set
890         // - even if to empty.
891         $apachelog_name = clean_filename($USER->firstname . " " .
892                                          $USER->lastname);
893     }
894     if (\core\session\manager::is_loggedinas()) {
895         $realuser = \core\session\manager::get_realuser();
896         $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
897         $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
898         $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
899     }
900     switch ($CFG->apacheloguser) {
901         case 3:
902             $logname = $apachelog_username;
903             break;
904         case 2:
905             $logname = $apachelog_name;
906             break;
907         case 1:
908         default:
909             $logname = $apachelog_userid;
910             break;
911     }
912     apache_note('MOODLEUSER', $logname);
915 // Use a custom script replacement if one exists
916 if (!empty($CFG->customscripts)) {
917     if (($customscript = custom_script_path()) !== false) {
918         require ($customscript);
919     }
922 if (PHPUNIT_TEST) {
923     // no ip blocking, these are CLI only
924 } else if (CLI_SCRIPT and !defined('WEB_CRON_EMULATED_CLI')) {
925     // no ip blocking
926 } else if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
927     // in this case, ip in allowed list will be performed first
928     // for example, client IP is 192.168.1.1
929     // 192.168 subnet is an entry in allowed list
930     // 192.168.1.1 is banned in blocked list
931     // This ip will be banned finally
932     if (!empty($CFG->allowedip)) {
933         if (!remoteip_in_list($CFG->allowedip)) {
934             die(get_string('ipblocked', 'admin'));
935         }
936     }
937     // need further check, client ip may a part of
938     // allowed subnet, but a IP address are listed
939     // in blocked list.
940     if (!empty($CFG->blockedip)) {
941         if (remoteip_in_list($CFG->blockedip)) {
942             die(get_string('ipblocked', 'admin'));
943         }
944     }
946 } else {
947     // in this case, IPs in blocked list will be performed first
948     // for example, client IP is 192.168.1.1
949     // 192.168 subnet is an entry in blocked list
950     // 192.168.1.1 is allowed in allowed list
951     // This ip will be allowed finally
952     if (!empty($CFG->blockedip)) {
953         if (remoteip_in_list($CFG->blockedip)) {
954             // if the allowed ip list is not empty
955             // IPs are not included in the allowed list will be
956             // blocked too
957             if (!empty($CFG->allowedip)) {
958                 if (!remoteip_in_list($CFG->allowedip)) {
959                     die(get_string('ipblocked', 'admin'));
960                 }
961             } else {
962                 die(get_string('ipblocked', 'admin'));
963             }
964         }
965     }
966     // if blocked list is null
967     // allowed list should be tested
968     if(!empty($CFG->allowedip)) {
969         if (!remoteip_in_list($CFG->allowedip)) {
970             die(get_string('ipblocked', 'admin'));
971         }
972     }
976 // // try to detect IE6 and prevent gzip because it is extremely buggy browser
977 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) {
978     ini_set('zlib.output_compression', 'Off');
979     if (function_exists('apache_setenv')) {
980         apache_setenv('no-gzip', 1);
981     }
984 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised.
985 if (isset($CFG->maintenance_later) and $CFG->maintenance_later <= time()) {
986     if (!file_exists("$CFG->dataroot/climaintenance.html")) {
987         require_once("$CFG->libdir/adminlib.php");
988         enable_cli_maintenance_mode();
989     }
990     unset_config('maintenance_later');
991     if (AJAX_SCRIPT) {
992         die;
993     } else if (!CLI_SCRIPT) {
994         redirect(new moodle_url('/'));
995     }
998 // note: we can not block non utf-8 installations here, because empty mysql database
999 // might be converted to utf-8 in admin/index.php during installation
1003 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
1004 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
1005 if (false) {
1006     $DB = new moodle_database();
1007     $OUTPUT = new core_renderer(null, null);
1008     $PAGE = new moodle_page();