3 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
19 * setup.php - Sets up sessions, connects to databases and so on
21 * Normally this is only called by the main config.php file
22 * Normally this file does not need to be edited.
26 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
27 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
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.
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).
46 global $CFG; // this should be done much earlier in config.php before creating new $CFG instance
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");
53 // this should never happen, maybe somebody is accessing this file directly...
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)
66 if (!isset($CFG->filepermissions
)) {
67 $CFG->filepermissions
= ($CFG->directorypermissions
& 0666); // strip execute flags
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);
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') {
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');
102 if (defined('BEHAT_UTIL')) {
103 // Now we create dataroot directory structure for behat tests.
104 testing_initdataroot($CFG->behat_dataroot
, 'behat');
106 behat_error(BEHAT_EXITCODE_INSTALL
);
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.');
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
;
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');
141 echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n");
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');
149 echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n");
151 } else if (!is_writable($CFG->dataroot
)) {
152 if (isset($_SERVER['REMOTE_ADDR'])) {
153 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
155 echo('Fatal error: $CFG->dataroot is not writable, admin has to fix directory permissions! Exiting.'."\n");
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');
164 echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n");
168 // Make sure there is some database table prefix.
169 if (!isset($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]));
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);
229 define('NO_DEBUG_DISPLAY', false);
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);
247 // We force the ones we need.
248 if (!defined('MDL_PERF')) {
249 define('MDL_PERF', true);
251 if (!defined('MDL_PERFDB')) {
252 define('MDL_PERFDB', true);
254 if (!defined('MDL_PERFTOFOOT')) {
255 define('MDL_PERFTOFOOT', true);
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);
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");
295 } else if (isset($_SERVER['REMOTE_ADDR'])) {
297 echo('Command line scripts can not be executed from the web interface');
302 echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
307 // All web service requests have WS_SERVER == true.
308 if (!defined('WS_SERVER')) {
309 define('WS_SERVER', false);
312 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades
313 if (file_exists("$CFG->dataroot/climaintenance.html")) {
315 header('Content-type: text/html; charset=utf-8');
316 header('X-UA-Compatible: IE=edge');
317 /// Headers to make it not cacheable and json
318 header('Cache-Control: no-store, no-cache, must-revalidate');
319 header('Cache-Control: post-check=0, pre-check=0', false);
320 header('Pragma: no-cache');
321 header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
322 header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
323 header('Accept-Ranges: none');
324 readfile("$CFG->dataroot/climaintenance.html");
327 if (!defined('CLI_MAINTENANCE')) {
328 define('CLI_MAINTENANCE', true);
332 if (!defined('CLI_MAINTENANCE')) {
333 define('CLI_MAINTENANCE', false);
338 // sometimes people use different PHP binary for web and CLI, make 100% sure they have the supported PHP version
339 if (version_compare(phpversion(), '5.4.4') < 0) {
340 $phpversion = phpversion();
341 // do NOT localise - lang strings would not work here and we CAN NOT move it to later place
342 echo "Moodle 2.7 or later requires at least PHP 5.4.4 (currently using version $phpversion).\n";
343 echo "Some servers may have multiple PHP versions installed, are you using the correct executable?\n";
348 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
349 if (!defined('AJAX_SCRIPT')) {
350 define('AJAX_SCRIPT', false);
353 // Exact version of currently used yui2 and 3 library.
354 $CFG->yui2version
= '2.9.0';
355 $CFG->yui3version
= '3.17.2';
357 // Patching the upstream YUI release.
358 // For important information on patching YUI modules, please see http://docs.moodle.org/dev/YUI/Patching.
359 // If we need to patch a YUI modules between official YUI releases, the yuipatchlevel will need to be manually
360 // incremented here. The module will also need to be listed in the yuipatchedmodules.
361 // When upgrading to a subsequent version of YUI, these should be reset back to 0 and an empty array.
362 $CFG->yuipatchlevel
= 0;
363 $CFG->yuipatchedmodules
= array(
366 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides.
367 if (!isset($CFG->config_php_settings
)) {
368 $CFG->config_php_settings
= (array)$CFG;
369 // Forced plugin settings override values from config_plugins table.
370 unset($CFG->config_php_settings
['forced_plugin_settings']);
371 if (!isset($CFG->forced_plugin_settings
)) {
372 $CFG->forced_plugin_settings
= array();
376 if (isset($CFG->debug
)) {
377 $CFG->debug
= (int)$CFG->debug
;
381 $CFG->debugdeveloper
= (($CFG->debug
& (E_ALL | E_STRICT
)) === (E_ALL | E_STRICT
)); // DEBUG_DEVELOPER is not available yet.
383 if (!defined('MOODLE_INTERNAL')) { // Necessary because cli installer has to define it earlier.
384 /** Used by library scripts to check they are being called by Moodle. */
385 define('MOODLE_INTERNAL', true);
388 // core_component can be used in any scripts, it does not need anything else.
389 require_once($CFG->libdir
.'/classes/component.php');
391 // special support for highly optimised scripts that do not need libraries and DB connection
392 if (defined('ABORT_AFTER_CONFIG')) {
393 if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
394 // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
395 error_reporting($CFG->debug
);
396 if (NO_DEBUG_DISPLAY
) {
397 // Some parts of Moodle cannot display errors and debug at all.
398 ini_set('display_errors', '0');
399 ini_set('log_errors', '1');
400 } else if (empty($CFG->debugdisplay
)) {
401 ini_set('display_errors', '0');
402 ini_set('log_errors', '1');
404 ini_set('display_errors', '1');
406 require_once("$CFG->dirroot/lib/configonlylib.php");
411 // Early profiling start, based exclusively on config.php $CFG settings
412 if (!empty($CFG->earlyprofilingenabled
)) {
413 require_once($CFG->libdir
. '/xhprof/xhprof_moodle.php');
418 * Database connection. Used for all access to the database.
419 * @global moodle_database $DB
425 * Moodle's wrapper round PHP's $_SESSION.
427 * @global object $SESSION
433 * Holds the user table record for the current user. Will be the 'guest'
434 * user record for people who are not logged in.
436 * $USER is stored in the session.
438 * Items found in the user record:
439 * - $USER->email - The user's email address.
440 * - $USER->id - The unique integer identified of this user in the 'user' table.
441 * - $USER->email - The user's email address.
442 * - $USER->firstname - The user's first name.
443 * - $USER->lastname - The user's last name.
444 * - $USER->username - The user's login username.
445 * - $USER->secret - The user's ?.
446 * - $USER->lang - The user's language choice.
448 * @global object $USER
454 * Frontpage course record
459 * A central store of information about the current page we are
460 * generating in response to the user's request.
462 * @global moodle_page $PAGE
468 * The current course. An alias for $PAGE->course.
469 * @global object $COURSE
475 * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
476 * it to generate HTML for output.
478 * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
479 * for the magic that does that. After $OUTPUT has been initialised, any attempt
480 * to change something that affects the current theme ($PAGE->course, logged in use,
481 * httpsrequried ... will result in an exception.)
483 * Please note the $OUTPUT is replacing the old global $THEME object.
485 * @global object $OUTPUT
491 * Full script path including all params, slash arguments, scheme and host.
493 * Note: Do NOT use for getting of current page URL or detection of https,
494 * instead use $PAGE->url or is_https().
496 * @global string $FULLME
502 * Script path including query string and slash arguments without host.
509 * $FULLME without slasharguments and query string.
510 * @global string $FULLSCRIPT
516 * Relative moodle script path '/course/view.php'
517 * @global string $SCRIPT
522 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
523 // inside some URLs used in HTTPSPAGEREQUIRED pages.
524 $CFG->httpswwwroot
= $CFG->wwwroot
;
526 require_once($CFG->libdir
.'/setuplib.php'); // Functions that MUST be loaded first
528 if (NO_OUTPUT_BUFFERING
) {
529 // we have to call this always before starting session because it discards headers!
530 disable_output_buffering();
533 // Increase memory limits if possible
534 raise_memory_limit(MEMORY_STANDARD
);
536 // Time to start counting
537 init_performance_info();
539 // Put $OUTPUT in place, so errors can be displayed.
540 $OUTPUT = new bootstrap_renderer();
542 // set handler for uncaught exceptions - equivalent to print_error() call
543 if (!PHPUNIT_TEST
or PHPUNIT_UTIL
) {
544 set_exception_handler('default_exception_handler');
545 set_error_handler('default_error_handler', E_ALL | E_STRICT
);
548 // Acceptance tests needs special output to capture the errors,
549 // but not necessary for behat CLI command.
550 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST')) {
551 require_once(__DIR__
. '/behat/lib.php');
552 set_error_handler('behat_error_handler', E_ALL | E_STRICT
);
555 // If there are any errors in the standard libraries we want to know!
556 error_reporting(E_ALL | E_STRICT
);
558 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
559 // http://www.google.com/webmasters/faq.html#prefetchblock
560 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
561 header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
562 echo('Prefetch request forbidden.');
566 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
567 //the problem is that we need specific version of quickforms and hacked excel files :-(
568 ini_set('include_path', $CFG->libdir
.'/pear' . PATH_SEPARATOR
. ini_get('include_path'));
569 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
570 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
571 ini_set('include_path', $CFG->libdir
.'/zend' . PATH_SEPARATOR
. ini_get('include_path'));
573 // Register our classloader, in theory somebody might want to replace it to load other hacked core classes.
574 if (defined('COMPONENT_CLASSLOADER')) {
575 spl_autoload_register(COMPONENT_CLASSLOADER
);
577 spl_autoload_register('core_component::classloader');
580 // Load up standard libraries
581 require_once($CFG->libdir
.'/filterlib.php'); // Functions for filtering test as it is output
582 require_once($CFG->libdir
.'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI
583 require_once($CFG->libdir
.'/weblib.php'); // Functions relating to HTTP and content
584 require_once($CFG->libdir
.'/outputlib.php'); // Functions for generating output
585 require_once($CFG->libdir
.'/navigationlib.php'); // Class for generating Navigation structure
586 require_once($CFG->libdir
.'/dmllib.php'); // Database access
587 require_once($CFG->libdir
.'/datalib.php'); // Legacy lib with a big-mix of functions.
588 require_once($CFG->libdir
.'/accesslib.php'); // Access control functions
589 require_once($CFG->libdir
.'/deprecatedlib.php'); // Deprecated functions included for backward compatibility
590 require_once($CFG->libdir
.'/moodlelib.php'); // Other general-purpose functions
591 require_once($CFG->libdir
.'/enrollib.php'); // Enrolment related functions
592 require_once($CFG->libdir
.'/pagelib.php'); // Library that defines the moodle_page class, used for $PAGE
593 require_once($CFG->libdir
.'/blocklib.php'); // Library for controlling blocks
594 require_once($CFG->libdir
.'/eventslib.php'); // Events functions
595 require_once($CFG->libdir
.'/grouplib.php'); // Groups functions
596 require_once($CFG->libdir
.'/sessionlib.php'); // All session and cookie related stuff
597 require_once($CFG->libdir
.'/editorlib.php'); // All text editor related functions and classes
598 require_once($CFG->libdir
.'/messagelib.php'); // Messagelib functions
599 require_once($CFG->libdir
.'/modinfolib.php'); // Cached information on course-module instances
600 require_once($CFG->dirroot
.'/cache/lib.php'); // Cache API
602 // make sure PHP is not severly misconfigured
603 setup_validate_php_configuration();
605 // Connect to the database
608 if (PHPUNIT_TEST
and !PHPUNIT_UTIL
) {
609 // make sure tests do not run in parallel
610 test_lock
::acquire('phpunit');
613 if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) {
615 phpunit_util
::reset_database();
617 } catch (Exception
$e) {
619 // we ned to reinit if reset fails
620 $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest'));
626 // Load up any configuration from the config table or MUC cache.
628 phpunit_util
::initialise_cfg();
633 if (isset($CFG->debug
)) {
634 $CFG->debug
= (int)$CFG->debug
;
635 error_reporting($CFG->debug
);
639 $CFG->debugdeveloper
= (($CFG->debug
& DEBUG_DEVELOPER
) === DEBUG_DEVELOPER
);
641 // Find out if PHP configured to display warnings,
642 // this is a security problem because some moodle scripts may
643 // disclose sensitive information.
644 if (ini_get_bool('display_errors')) {
645 define('WARN_DISPLAY_ERRORS_ENABLED', true);
647 // If we want to display Moodle errors, then try and set PHP errors to match.
648 if (!isset($CFG->debugdisplay
)) {
649 // Keep it "as is" during installation.
650 } else if (NO_DEBUG_DISPLAY
) {
651 // Some parts of Moodle cannot display errors and debug at all.
652 ini_set('display_errors', '0');
653 ini_set('log_errors', '1');
654 } else if (empty($CFG->debugdisplay
)) {
655 ini_set('display_errors', '0');
656 ini_set('log_errors', '1');
658 // This is very problematic in XHTML strict mode!
659 ini_set('display_errors', '1');
662 // Register our shutdown manager, do NOT use register_shutdown_function().
663 core_shutdown_manager
::initialize();
665 // Verify upgrade is not running unless we are in a script that needs to execute in any case
666 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning
)) {
667 if ($CFG->upgraderunning
< time()) {
668 unset_config('upgraderunning');
670 print_error('upgraderunning');
674 // Turn on SQL logging if required
675 if (!empty($CFG->logsql
)) {
676 $DB->set_logging(true);
679 // enable circular reference collector in PHP 5.3,
680 // it helps a lot when using large complex OOP structures such as in amos or gradebook
681 if (function_exists('gc_enable')) {
685 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
686 if (!empty($CFG->version
) and $CFG->version
< 2007101509) {
687 print_error('upgraderequires19', 'error');
691 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
692 // - WINDOWS: for any Windows flavour.
693 // - UNIX: for the rest
694 // Also, $CFG->os can continue being used if more specialization is required
695 if (stristr(PHP_OS
, 'win') && !stristr(PHP_OS
, 'darwin')) {
696 $CFG->ostype
= 'WINDOWS';
698 $CFG->ostype
= 'UNIX';
702 // Configure ampersands in URLs
703 ini_set('arg_separator.output', '&');
705 // Work around for a PHP bug see MDL-11237
706 ini_set('pcre.backtrack_limit', 20971520); // 20 MB
708 // Location of standard files
709 $CFG->wordlist
= $CFG->libdir
.'/wordlist.txt';
710 $CFG->moddata
= 'moddata';
712 // neutralise nasty chars in PHP_SELF
713 if (isset($_SERVER['PHP_SELF'])) {
714 $phppos = strpos($_SERVER['PHP_SELF'], '.php');
715 if ($phppos !== false) {
716 $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+
4);
721 // initialise ME's - this must be done BEFORE starting of session!
724 // define SYSCONTEXTID in config.php if you want to save some queries,
725 // after install it must match the system context record id.
726 if (!defined('SYSCONTEXTID')) {
727 context_system
::instance();
730 // Defining the site - aka frontpage course
733 } catch (moodle_exception
$e) {
735 if (empty($CFG->version
)) {
736 $SITE = new stdClass();
738 $SITE->shortname
= null;
743 // And the 'default' course - this will usually get reset later in require_login() etc.
744 $COURSE = clone($SITE);
745 // Id of the frontpage course.
746 define('SITEID', $SITE->id
);
748 // init session prevention flag - this is defined on pages that do not want session
750 // no sessions in CLI scripts possible
751 define('NO_MOODLE_COOKIES', true);
753 } else if (WS_SERVER
) {
754 // No sessions possible in web services.
755 define('NO_MOODLE_COOKIES', true);
757 } else if (!defined('NO_MOODLE_COOKIES')) {
758 if (empty($CFG->version
) or $CFG->version
< 2009011900) {
759 // no session before sessions table gets created
760 define('NO_MOODLE_COOKIES', true);
761 } else if (CLI_SCRIPT
) {
762 // CLI scripts can not have session
763 define('NO_MOODLE_COOKIES', true);
765 define('NO_MOODLE_COOKIES', false);
769 // Start session and prepare global $SESSION, $USER.
770 if (empty($CFG->sessiontimeout
)) {
771 $CFG->sessiontimeout
= 7200;
773 \core\session\manager
::start();
775 // Set default content type and encoding, developers are still required to use
776 // echo $OUTPUT->header() everywhere, anything that gets set later should override these headers.
777 // This is intended to mitigate some security problems.
779 if (!core_useragent
::supports_json_contenttype()) {
780 // Some bloody old IE.
781 @header
('Content-type: text/plain; charset=utf-8');
782 @header
('X-Content-Type-Options: nosniff');
783 } else if (!empty($_FILES)) {
784 // Some ajax code may have problems with json and file uploads.
785 @header
('Content-type: text/plain; charset=utf-8');
787 @header
('Content-type: application/json; charset=utf-8');
789 } else if (!CLI_SCRIPT
) {
790 @header
('Content-type: text/html; charset=utf-8');
793 // Initialise some variables that are supposed to be set in config.php only.
794 if (!isset($CFG->filelifetime
)) {
795 $CFG->filelifetime
= 60*60*6;
798 // Late profiling, only happening if early one wasn't started
799 if (!empty($CFG->profilingenabled
)) {
800 require_once($CFG->libdir
. '/xhprof/xhprof_moodle.php');
804 // Hack to get around max_input_vars restrictions,
805 // we need to do this after session init to have some basic DDoS protection.
806 workaround_max_input_vars();
808 // Process theme change in the URL.
809 if (!empty($CFG->allowthemechangeonurl
) and !empty($_GET['theme'])) {
810 // we have to use _GET directly because we do not want this to interfere with _POST
811 $urlthemename = optional_param('theme', '', PARAM_PLUGIN
);
813 $themeconfig = theme_config
::load($urlthemename);
814 // Makes sure the theme can be loaded without errors.
815 if ($themeconfig->name
=== $urlthemename) {
816 $SESSION->theme
= $urlthemename;
818 unset($SESSION->theme
);
821 unset($urlthemename);
822 } catch (Exception
$e) {
823 debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER
, $e->getTrace());
826 unset($urlthemename);
828 // Ensure a valid theme is set.
829 if (!isset($CFG->theme
)) {
830 $CFG->theme
= 'clean';
833 // Set language/locale of printed times. If user has chosen a language that
834 // that is different from the site language, then use the locale specified
835 // in the language file. Otherwise, if the admin hasn't specified a locale
836 // then use the one from the default language. Otherwise (and this is the
837 // majority of cases), use the stored locale specified by admin.
838 // note: do not accept lang parameter from POST
839 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR
))) {
840 if (get_string_manager()->translation_exists($lang, false)) {
841 $SESSION->lang
= $lang;
846 // PARAM_SAFEDIR used instead of PARAM_LANG because using PARAM_LANG results
847 // in an empty string being returned when a non-existant language is specified,
848 // which would make it necessary to log out to undo the forcelang setting.
849 // With PARAM_SAFEDIR, it's possible to specify ?forcelang=none to drop the forcelang effect.
850 if ($forcelang = optional_param('forcelang', '', PARAM_SAFEDIR
)) {
852 && get_string_manager()->translation_exists($forcelang, false)
853 && has_capability('moodle/site:forcelanguage', context_system
::instance())) {
854 $SESSION->forcelang
= $forcelang;
855 } else if (isset($SESSION->forcelang
)) {
856 unset($SESSION->forcelang
);
861 setup_lang_from_browser();
863 if (empty($CFG->lang
)) {
864 if (empty($SESSION->lang
)) {
867 $CFG->lang
= $SESSION->lang
;
871 // Set the default site locale, a lot of the stuff may depend on this
872 // it is definitely too late to call this first in require_login()!
875 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup!
876 if (!empty($CFG->moodlepageclass
)) {
877 if (!empty($CFG->moodlepageclassfile
)) {
878 require_once($CFG->moodlepageclassfile
);
880 $classname = $CFG->moodlepageclass
;
882 $classname = 'moodle_page';
884 $PAGE = new $classname();
888 if (!empty($CFG->debugvalidators
) and !empty($CFG->guestloginbutton
)) {
889 if ($CFG->theme
== 'standard') { // Temporary measure to help with XHTML validation
890 if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id
)) { // Allow W3CValidator in as user called w3cvalidator (or guest)
891 if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
892 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
893 if ($user = get_complete_user_data("username", "w3cvalidator")) {
894 $user->ignoresesskey
= true;
896 $user = guest_user();
898 \core\session\manager
::set_user($user);
904 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
905 // LogFormat to get the current logged in username in moodle.
906 if ($USER && function_exists('apache_note')
907 && !empty($CFG->apacheloguser
) && isset($USER->username
)) {
908 $apachelog_userid = $USER->id
;
909 $apachelog_username = clean_filename($USER->username
);
910 $apachelog_name = '';
911 if (isset($USER->firstname
)) {
912 // We can assume both will be set
913 // - even if to empty.
914 $apachelog_name = clean_filename($USER->firstname
. " " .
917 if (\core\session\manager
::is_loggedinas()) {
918 $realuser = \core\session\manager
::get_realuser();
919 $apachelog_username = clean_filename($realuser->username
." as ".$apachelog_username);
920 $apachelog_name = clean_filename($realuser->firstname
." ".$realuser->lastname
." as ".$apachelog_name);
921 $apachelog_userid = clean_filename($realuser->id
." as ".$apachelog_userid);
923 switch ($CFG->apacheloguser
) {
925 $logname = $apachelog_username;
928 $logname = $apachelog_name;
932 $logname = $apachelog_userid;
935 apache_note('MOODLEUSER', $logname);
938 // Use a custom script replacement if one exists
939 if (!empty($CFG->customscripts
)) {
940 if (($customscript = custom_script_path()) !== false) {
941 require ($customscript);
946 // no ip blocking, these are CLI only
947 } else if (CLI_SCRIPT
and !defined('WEB_CRON_EMULATED_CLI')) {
949 } else if (!empty($CFG->allowbeforeblock
)) { // allowed list processed before blocked list?
950 // in this case, ip in allowed list will be performed first
951 // for example, client IP is 192.168.1.1
952 // 192.168 subnet is an entry in allowed list
953 // 192.168.1.1 is banned in blocked list
954 // This ip will be banned finally
955 if (!empty($CFG->allowedip
)) {
956 if (!remoteip_in_list($CFG->allowedip
)) {
957 die(get_string('ipblocked', 'admin'));
960 // need further check, client ip may a part of
961 // allowed subnet, but a IP address are listed
963 if (!empty($CFG->blockedip
)) {
964 if (remoteip_in_list($CFG->blockedip
)) {
965 die(get_string('ipblocked', 'admin'));
970 // in this case, IPs in blocked list will be performed first
971 // for example, client IP is 192.168.1.1
972 // 192.168 subnet is an entry in blocked list
973 // 192.168.1.1 is allowed in allowed list
974 // This ip will be allowed finally
975 if (!empty($CFG->blockedip
)) {
976 if (remoteip_in_list($CFG->blockedip
)) {
977 // if the allowed ip list is not empty
978 // IPs are not included in the allowed list will be
980 if (!empty($CFG->allowedip
)) {
981 if (!remoteip_in_list($CFG->allowedip
)) {
982 die(get_string('ipblocked', 'admin'));
985 die(get_string('ipblocked', 'admin'));
989 // if blocked list is null
990 // allowed list should be tested
991 if(!empty($CFG->allowedip
)) {
992 if (!remoteip_in_list($CFG->allowedip
)) {
993 die(get_string('ipblocked', 'admin'));
999 // // try to detect IE6 and prevent gzip because it is extremely buggy browser
1000 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) {
1001 ini_set('zlib.output_compression', 'Off');
1002 if (function_exists('apache_setenv')) {
1003 apache_setenv('no-gzip', 1);
1007 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised.
1008 if (isset($CFG->maintenance_later
) and $CFG->maintenance_later
<= time()) {
1009 if (!file_exists("$CFG->dataroot/climaintenance.html")) {
1010 require_once("$CFG->libdir/adminlib.php");
1011 enable_cli_maintenance_mode();
1013 unset_config('maintenance_later');
1016 } else if (!CLI_SCRIPT
) {
1017 redirect(new moodle_url('/'));
1021 // note: we can not block non utf-8 installations here, because empty mysql database
1022 // might be converted to utf-8 in admin/index.php during installation
1026 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
1027 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
1029 $DB = new moodle_database();
1030 $OUTPUT = new core_renderer(null, null);
1031 $PAGE = new moodle_page();