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->backuptempdir - Path to moodle's backup temp file directory on server's filesystem.
40 * - $CFG->tempdir - Path to moodle's temp file directory on server's filesystem.
41 * - $CFG->cachedir - Path to moodle's cache directory on server's filesystem (shared by cluster nodes).
42 * - $CFG->localcachedir - Path to moodle's local cache directory (not shared by cluster nodes).
43 * - $CFG->localrequestdir - Path to moodle's local temp request directory (not shared by cluster nodes).
48 global $CFG; // this should be done much earlier in config.php before creating new $CFG instance
51 if (defined('PHPUNIT_TEST') and PHPUNIT_TEST
) {
52 echo('There is a missing "global $CFG;" at the beginning of the config.php file.'."\n");
55 // this should never happen, maybe somebody is accessing this file directly...
60 // We can detect real dirroot path reliably since PHP 4.0.2,
61 // it can not be anything else, there is no point in having this in config.php
62 $CFG->dirroot
= dirname(__DIR__
);
64 // File permissions on created directories in the $CFG->dataroot
65 if (!isset($CFG->directorypermissions
)) {
66 $CFG->directorypermissions
= 02777; // Must be octal (that's why it's here)
68 if (!isset($CFG->filepermissions
)) {
69 $CFG->filepermissions
= ($CFG->directorypermissions
& 0666); // strip execute flags
71 // Better also set default umask because developers often forget to include directory
72 // permissions in mkdir() and chmod() after creating new files.
73 if (!isset($CFG->umaskpermissions
)) {
74 $CFG->umaskpermissions
= (($CFG->directorypermissions
& 0777) ^
0777);
76 umask($CFG->umaskpermissions
);
78 if (defined('BEHAT_SITE_RUNNING')) {
79 // We already switched to behat test site previously.
81 } else if (!empty($CFG->behat_wwwroot
) or !empty($CFG->behat_dataroot
) or !empty($CFG->behat_prefix
)) {
82 // The behat is configured on this server, we need to find out if this is the behat test
83 // site based on the URL used for access.
84 require_once(__DIR__
. '/../lib/behat/lib.php');
86 // Update config variables for parallel behat runs.
87 behat_update_vars_for_process();
89 // If behat is being installed for parallel run, then we modify params for parallel run only.
90 if (behat_is_test_site() && !(defined('BEHAT_PARALLEL_UTIL') && empty($CFG->behatrunprocess
))) {
93 // Checking the integrity of the provided $CFG->behat_* vars and the
94 // selected wwwroot to prevent conflicts with production and phpunit environments.
95 behat_check_config_vars();
97 // Check that the directory does not contains other things.
98 if (!file_exists("$CFG->behat_dataroot/behattestdir.txt")) {
99 if ($dh = opendir($CFG->behat_dataroot
)) {
100 while (($file = readdir($dh)) !== false) {
101 if ($file === 'behat' or $file === '.' or $file === '..' or $file === '.DS_Store' or is_numeric($file)) {
104 behat_error(BEHAT_EXITCODE_CONFIG
, "$CFG->behat_dataroot directory is not empty, ensure this is the " .
105 "directory where you want to install behat test dataroot");
112 if (defined('BEHAT_UTIL')) {
113 // Now we create dataroot directory structure for behat tests.
114 testing_initdataroot($CFG->behat_dataroot
, 'behat');
116 behat_error(BEHAT_EXITCODE_INSTALL
);
120 if (!defined('BEHAT_UTIL') and !defined('BEHAT_TEST')) {
121 // Somebody tries to access test site directly, tell them if not enabled.
122 $behatdir = preg_replace("#[/|\\\]" . BEHAT_PARALLEL_SITE_NAME
. "\d{0,}$#", '', $CFG->behat_dataroot
);
123 if (!file_exists($behatdir . '/test_environment_enabled.txt')) {
124 behat_error(BEHAT_EXITCODE_CONFIG
, 'Behat is configured but not enabled on this test site.');
128 // Constant used to inform that the behat test site is being used,
129 // this includes all the processes executed by the behat CLI command like
130 // the site reset, the steps executed by the browser drivers when simulating
131 // a user session and a real session when browsing manually to $CFG->behat_wwwroot
132 // like the browser driver does automatically.
133 // Different from BEHAT_TEST as only this last one can perform CLI
134 // actions like reset the site or use data generators.
135 define('BEHAT_SITE_RUNNING', true);
137 // Clean extra config.php settings.
138 behat_clean_init_config();
140 // Now we can begin switching $CFG->X for $CFG->behat_X.
141 $CFG->wwwroot
= $CFG->behat_wwwroot
;
142 $CFG->prefix
= $CFG->behat_prefix
;
143 $CFG->dataroot
= $CFG->behat_dataroot
;
145 // And we do the same with the optional ones.
146 $allowedconfigoverride = ['dbname', 'dbuser', 'dbpass', 'dbhost'];
147 foreach ($allowedconfigoverride as $config) {
148 $behatconfig = 'behat_' . $config;
149 if (!isset($CFG->$behatconfig)) {
152 $CFG->$config = $CFG->$behatconfig;
157 // Set default warn runtime.
158 if (!isset($CFG->taskruntimewarn
)) {
159 $CFG->taskruntimewarn
= 12 * 60 * 60;
162 // Set default error runtime.
163 if (!isset($CFG->taskruntimeerror
)) {
164 $CFG->taskruntimeerror
= 24 * 60 * 60;
167 // Normalise dataroot - we do not want any symbolic links, trailing / or any other weirdness there
168 if (!isset($CFG->dataroot
)) {
169 if (isset($_SERVER['REMOTE_ADDR'])) {
170 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error ');
172 echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n");
175 $CFG->dataroot
= realpath($CFG->dataroot
);
176 if ($CFG->dataroot
=== false) {
177 if (isset($_SERVER['REMOTE_ADDR'])) {
178 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error ');
180 echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n");
182 } else if (!is_writable($CFG->dataroot
)) {
183 if (isset($_SERVER['REMOTE_ADDR'])) {
184 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error ');
186 echo('Fatal error: $CFG->dataroot is not writable, admin has to fix directory permissions! Exiting.'."\n");
190 // wwwroot is mandatory
191 if (!isset($CFG->wwwroot
) or $CFG->wwwroot
=== 'http://example.com/moodle') {
192 if (isset($_SERVER['REMOTE_ADDR'])) {
193 header($_SERVER['SERVER_PROTOCOL'] . ' 500 Internal Server Error ');
195 echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n");
199 // Make sure there is some database table prefix.
200 if (!isset($CFG->prefix
)) {
204 // Define admin directory
205 if (!isset($CFG->admin
)) { // Just in case it isn't defined in config.php
206 $CFG->admin
= 'admin'; // This is relative to the wwwroot and dirroot
209 // Set up some paths.
210 $CFG->libdir
= $CFG->dirroot
.'/lib';
212 // Allow overriding of tempdir but be backwards compatible
213 if (!isset($CFG->tempdir
)) {
214 $CFG->tempdir
= $CFG->dataroot
. DIRECTORY_SEPARATOR
. "temp";
217 // Allow overriding of backuptempdir but be backwards compatible
218 if (!isset($CFG->backuptempdir
)) {
219 $CFG->backuptempdir
= "$CFG->tempdir/backup";
222 // Allow overriding of cachedir but be backwards compatible
223 if (!isset($CFG->cachedir
)) {
224 $CFG->cachedir
= "$CFG->dataroot/cache";
227 // Allow overriding of localcachedir.
228 if (!isset($CFG->localcachedir
)) {
229 $CFG->localcachedir
= "$CFG->dataroot/localcache";
232 // Allow overriding of localrequestdir.
233 if (!isset($CFG->localrequestdir
)) {
234 $CFG->localrequestdir
= sys_get_temp_dir() . '/requestdir';
237 // Location of all languages except core English pack.
238 if (!isset($CFG->langotherroot
)) {
239 $CFG->langotherroot
= $CFG->dataroot
.'/lang';
242 // Location of local lang pack customisations (dirs with _local suffix).
243 if (!isset($CFG->langlocalroot
)) {
244 $CFG->langlocalroot
= $CFG->dataroot
.'/lang';
247 // The current directory in PHP version 4.3.0 and above isn't necessarily the
248 // directory of the script when run from the command line. The require_once()
249 // would fail, so we'll have to chdir()
250 if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
251 // do it only once - skip the second time when continuing after prevous abort
252 if (!defined('ABORT_AFTER_CONFIG') and !defined('ABORT_AFTER_CONFIG_CANCEL')) {
253 chdir(dirname($_SERVER['argv'][0]));
257 // sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that??
258 ini_set('precision', 14); // needed for upgrades and gradebook
259 ini_set('serialize_precision', 17); // Make float serialization consistent on all systems.
261 // Scripts may request no debug and error messages in output
262 // please note it must be defined before including the config.php script
263 // and in some cases you also need to set custom default exception handler
264 if (!defined('NO_DEBUG_DISPLAY')) {
265 if (defined('AJAX_SCRIPT') and AJAX_SCRIPT
) {
266 // Moodle AJAX scripts are expected to return json data, any PHP notices or errors break it badly,
267 // developers simply must learn to watch error log.
268 define('NO_DEBUG_DISPLAY', true);
270 define('NO_DEBUG_DISPLAY', false);
274 // Some scripts such as upgrade may want to prevent output buffering
275 if (!defined('NO_OUTPUT_BUFFERING')) {
276 define('NO_OUTPUT_BUFFERING', false);
279 // PHPUnit tests need custom init
280 if (!defined('PHPUNIT_TEST')) {
281 define('PHPUNIT_TEST', false);
284 // Performance tests needs to always display performance info, even in redirections;
285 // MDL_PERF_TEST is used in https://github.com/moodlehq/moodle-performance-comparison scripts.
286 if (!defined('MDL_PERF_TEST')) {
287 define('MDL_PERF_TEST', false);
289 // Make sure all MDL_PERF* constants are always defined.
290 if (!defined('MDL_PERF')) {
291 define('MDL_PERF', MDL_PERF_TEST
);
293 if (!defined('MDL_PERFTOFOOT')) {
294 define('MDL_PERFTOFOOT', MDL_PERF_TEST
);
296 if (!defined('MDL_PERFTOLOG')) {
297 define('MDL_PERFTOLOG', false);
299 if (!defined('MDL_PERFINC')) {
300 define('MDL_PERFINC', false);
302 // Note that PHPUnit and Behat tests should pass with both MDL_PERF true and false.
304 // When set to true MUC (Moodle caching) will be disabled as much as possible.
305 // A special cache factory will be used to handle this situation and will use special "disabled" equivalents objects.
306 // This ensure we don't attempt to read or create the config file, don't use stores, don't provide persistence or
307 // storage of any kind.
308 if (!defined('CACHE_DISABLE_ALL')) {
309 define('CACHE_DISABLE_ALL', false);
312 // When set to true MUC (Moodle caching) will not use any of the defined or default stores.
313 // The Cache API will continue to function however this will force the use of the cachestore_dummy so all requests
314 // will be interacting with a static property and will never go to the proper cache stores.
315 // Useful if you need to avoid the stores for one reason or another.
316 if (!defined('CACHE_DISABLE_STORES')) {
317 define('CACHE_DISABLE_STORES', false);
320 // Servers should define a default timezone in php.ini, but if they don't then make sure no errors are shown.
321 date_default_timezone_set(@date_default_timezone_get
());
323 // Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output
324 // In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php.
325 // Please note that one script can not be accessed from both CLI and web interface.
326 if (!defined('CLI_SCRIPT')) {
327 define('CLI_SCRIPT', false);
329 if (defined('WEB_CRON_EMULATED_CLI')) {
330 if (!isset($_SERVER['REMOTE_ADDR'])) {
331 echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n");
334 } else if (isset($_SERVER['REMOTE_ADDR'])) {
336 echo('Command line scripts can not be executed from the web interface');
341 echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
346 // All web service requests have WS_SERVER == true.
347 if (!defined('WS_SERVER')) {
348 define('WS_SERVER', false);
351 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades
352 if (file_exists("$CFG->dataroot/climaintenance.html")) {
354 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Moodle under maintenance');
355 header('Status: 503 Moodle under maintenance');
356 header('Retry-After: 300');
357 header('Content-type: text/html; charset=utf-8');
358 header('X-UA-Compatible: IE=edge');
359 /// Headers to make it not cacheable and json
360 header('Cache-Control: no-store, no-cache, must-revalidate');
361 header('Cache-Control: post-check=0, pre-check=0', false);
362 header('Pragma: no-cache');
363 header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
364 header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
365 header('Accept-Ranges: none');
366 readfile("$CFG->dataroot/climaintenance.html");
369 if (!defined('CLI_MAINTENANCE')) {
370 define('CLI_MAINTENANCE', true);
374 if (!defined('CLI_MAINTENANCE')) {
375 define('CLI_MAINTENANCE', false);
379 // Sometimes people use different PHP binary for web and CLI, make 100% sure they have the supported PHP version.
380 if (version_compare(PHP_VERSION
, '5.6.5') < 0) {
381 $phpversion = PHP_VERSION
;
382 // Do NOT localise - lang strings would not work here and we CAN NOT move it to later place.
383 echo "Moodle 3.2 or later requires at least PHP 5.6.5 (currently using version $phpversion).\n";
384 echo "Some servers may have multiple PHP versions installed, are you using the correct executable?\n";
388 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
389 if (!defined('AJAX_SCRIPT')) {
390 define('AJAX_SCRIPT', false);
393 // Exact version of currently used yui2 and 3 library.
394 $CFG->yui2version
= '2.9.0';
395 $CFG->yui3version
= '3.18.1';
397 // Patching the upstream YUI release.
398 // For important information on patching YUI modules, please see http://docs.moodle.org/dev/YUI/Patching.
399 // If we need to patch a YUI modules between official YUI releases, the yuipatchlevel will need to be manually
400 // incremented here. The module will also need to be listed in the yuipatchedmodules.
401 // When upgrading to a subsequent version of YUI, these should be reset back to 0 and an empty array.
402 $CFG->yuipatchlevel
= 0;
403 $CFG->yuipatchedmodules
= array(
406 if (!empty($CFG->disableonclickaddoninstall
)) {
407 // This config.php flag has been merged into another one.
408 $CFG->disableupdateautodeploy
= true;
411 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides.
412 if (!isset($CFG->config_php_settings
)) {
413 $CFG->config_php_settings
= (array)$CFG;
414 // Forced plugin settings override values from config_plugins table.
415 unset($CFG->config_php_settings
['forced_plugin_settings']);
416 if (!isset($CFG->forced_plugin_settings
)) {
417 $CFG->forced_plugin_settings
= array();
421 if (isset($CFG->debug
)) {
422 $CFG->debug
= (int)$CFG->debug
;
426 $CFG->debugdeveloper
= (($CFG->debug
& (E_ALL | E_STRICT
)) === (E_ALL | E_STRICT
)); // DEBUG_DEVELOPER is not available yet.
428 if (!defined('MOODLE_INTERNAL')) { // Necessary because cli installer has to define it earlier.
429 /** Used by library scripts to check they are being called by Moodle. */
430 define('MOODLE_INTERNAL', true);
433 // core_component can be used in any scripts, it does not need anything else.
434 require_once($CFG->libdir
.'/classes/component.php');
436 // special support for highly optimised scripts that do not need libraries and DB connection
437 if (defined('ABORT_AFTER_CONFIG')) {
438 if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
439 // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
440 error_reporting($CFG->debug
);
441 if (NO_DEBUG_DISPLAY
) {
442 // Some parts of Moodle cannot display errors and debug at all.
443 ini_set('display_errors', '0');
444 ini_set('log_errors', '1');
445 } else if (empty($CFG->debugdisplay
)) {
446 ini_set('display_errors', '0');
447 ini_set('log_errors', '1');
449 ini_set('display_errors', '1');
451 require_once("$CFG->dirroot/lib/configonlylib.php");
456 // Early profiling start, based exclusively on config.php $CFG settings
457 if (!empty($CFG->earlyprofilingenabled
)) {
458 require_once($CFG->libdir
. '/xhprof/xhprof_moodle.php');
463 * Database connection. Used for all access to the database.
464 * @global moodle_database $DB
470 * Moodle's wrapper round PHP's $_SESSION.
472 * @global object $SESSION
478 * Holds the user table record for the current user. Will be the 'guest'
479 * user record for people who are not logged in.
481 * $USER is stored in the session.
483 * Items found in the user record:
484 * - $USER->email - The user's email address.
485 * - $USER->id - The unique integer identified of this user in the 'user' table.
486 * - $USER->email - The user's email address.
487 * - $USER->firstname - The user's first name.
488 * - $USER->lastname - The user's last name.
489 * - $USER->username - The user's login username.
490 * - $USER->secret - The user's ?.
491 * - $USER->lang - The user's language choice.
493 * @global object $USER
499 * Frontpage course record
504 * A central store of information about the current page we are
505 * generating in response to the user's request.
507 * @global moodle_page $PAGE
513 * The current course. An alias for $PAGE->course.
514 * @global object $COURSE
520 * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
521 * it to generate HTML for output.
523 * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
524 * for the magic that does that. After $OUTPUT has been initialised, any attempt
525 * to change something that affects the current theme ($PAGE->course, logged in use,
526 * httpsrequried ... will result in an exception.)
528 * Please note the $OUTPUT is replacing the old global $THEME object.
530 * @global object $OUTPUT
536 * Full script path including all params, slash arguments, scheme and host.
538 * Note: Do NOT use for getting of current page URL or detection of https,
539 * instead use $PAGE->url or is_https().
541 * @global string $FULLME
547 * Script path including query string and slash arguments without host.
554 * $FULLME without slasharguments and query string.
555 * @global string $FULLSCRIPT
561 * Relative moodle script path '/course/view.php'
562 * @global string $SCRIPT
567 // The httpswwwroot has been deprecated, we keep it as an alias for backwards compatibility with plugins only.
568 $CFG->httpswwwroot
= $CFG->wwwroot
;
570 require_once($CFG->libdir
.'/setuplib.php'); // Functions that MUST be loaded first
572 if (NO_OUTPUT_BUFFERING
) {
573 // we have to call this always before starting session because it discards headers!
574 disable_output_buffering();
577 // Increase memory limits if possible
578 raise_memory_limit(MEMORY_STANDARD
);
580 // Time to start counting
581 init_performance_info();
583 // Put $OUTPUT in place, so errors can be displayed.
584 $OUTPUT = new bootstrap_renderer();
586 // Set handler for uncaught exceptions - equivalent to throw new \moodle_exception() call.
587 if (!PHPUNIT_TEST
or PHPUNIT_UTIL
) {
588 set_exception_handler('default_exception_handler');
589 set_error_handler('default_error_handler', E_ALL | E_STRICT
);
592 // Acceptance tests needs special output to capture the errors,
593 // but not necessary for behat CLI command and init script.
594 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST') && !defined('BEHAT_UTIL')) {
595 require_once(__DIR__
. '/behat/lib.php');
596 set_error_handler('behat_error_handler', E_ALL | E_STRICT
);
599 if (defined('WS_SERVER') && WS_SERVER
) {
600 require_once($CFG->dirroot
. '/webservice/lib.php');
601 set_exception_handler('early_ws_exception_handler');
604 // If there are any errors in the standard libraries we want to know!
605 error_reporting(E_ALL | E_STRICT
);
607 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
608 // http://www.google.com/webmasters/faq.html#prefetchblock
609 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
610 header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
611 echo('Prefetch request forbidden.');
615 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
616 //the problem is that we need specific version of quickforms and hacked excel files :-(
617 ini_set('include_path', $CFG->libdir
.'/pear' . PATH_SEPARATOR
. ini_get('include_path'));
619 // Register our classloader, in theory somebody might want to replace it to load other hacked core classes.
620 if (defined('COMPONENT_CLASSLOADER')) {
621 spl_autoload_register(COMPONENT_CLASSLOADER
);
623 spl_autoload_register('core_component::classloader');
626 // Remember the default PHP timezone, we will need it later.
627 core_date
::store_default_php_timezone();
629 // Load up standard libraries
630 require_once($CFG->libdir
.'/filterlib.php'); // Functions for filtering test as it is output
631 require_once($CFG->libdir
.'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI
632 require_once($CFG->libdir
.'/weblib.php'); // Functions relating to HTTP and content
633 require_once($CFG->libdir
.'/outputlib.php'); // Functions for generating output
634 require_once($CFG->libdir
.'/navigationlib.php'); // Class for generating Navigation structure
635 require_once($CFG->libdir
.'/dmllib.php'); // Database access
636 require_once($CFG->libdir
.'/datalib.php'); // Legacy lib with a big-mix of functions.
637 require_once($CFG->libdir
.'/accesslib.php'); // Access control functions
638 require_once($CFG->libdir
.'/deprecatedlib.php'); // Deprecated functions included for backward compatibility
639 require_once($CFG->libdir
.'/moodlelib.php'); // Other general-purpose functions
640 require_once($CFG->libdir
.'/enrollib.php'); // Enrolment related functions
641 require_once($CFG->libdir
.'/pagelib.php'); // Library that defines the moodle_page class, used for $PAGE
642 require_once($CFG->libdir
.'/blocklib.php'); // Library for controlling blocks
643 require_once($CFG->libdir
.'/grouplib.php'); // Groups functions
644 require_once($CFG->libdir
.'/sessionlib.php'); // All session and cookie related stuff
645 require_once($CFG->libdir
.'/editorlib.php'); // All text editor related functions and classes
646 require_once($CFG->libdir
.'/messagelib.php'); // Messagelib functions
647 require_once($CFG->libdir
.'/modinfolib.php'); // Cached information on course-module instances
648 require_once($CFG->dirroot
.'/cache/lib.php'); // Cache API
650 // make sure PHP is not severly misconfigured
651 setup_validate_php_configuration();
653 // Connect to the database
656 if (PHPUNIT_TEST
and !PHPUNIT_UTIL
) {
657 // Make sure tests do not run in parallel.
659 if (phpunit_util
::is_in_isolated_process()) {
660 $suffix = '.isolated';
662 test_lock
::acquire('phpunit', $suffix);
665 if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) {
667 phpunit_util
::reset_database();
669 } catch (Exception
$e) {
671 // we ned to reinit if reset fails
672 $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest'));
678 // Load any immutable bootstrap config from local cache.
679 $bootstrapcachefile = $CFG->localcachedir
. '/bootstrap.php';
680 if (is_readable($bootstrapcachefile)) {
682 require_once($bootstrapcachefile);
683 // Verify the file is not stale.
684 if (!isset($CFG->bootstraphash
) ||
$CFG->bootstraphash
!== hash_local_config_cache()) {
685 // Something has changed, the bootstrap.php file is stale.
686 unset($CFG->siteidentifier
);
687 @unlink
($bootstrapcachefile);
689 } catch (Throwable
$e) {
690 // If it is corrupted then attempt to delete it and it will be rebuilt.
691 @unlink
($bootstrapcachefile);
695 // Load up any configuration from the config table or MUC cache.
697 phpunit_util
::initialise_cfg();
702 if (isset($CFG->debug
)) {
703 $CFG->debug
= (int)$CFG->debug
;
704 error_reporting($CFG->debug
);
708 $CFG->debugdeveloper
= (($CFG->debug
& DEBUG_DEVELOPER
) === DEBUG_DEVELOPER
);
710 // Find out if PHP configured to display warnings,
711 // this is a security problem because some moodle scripts may
712 // disclose sensitive information.
713 if (ini_get_bool('display_errors')) {
714 define('WARN_DISPLAY_ERRORS_ENABLED', true);
716 // If we want to display Moodle errors, then try and set PHP errors to match.
717 if (!isset($CFG->debugdisplay
)) {
718 // Keep it "as is" during installation.
719 } else if (NO_DEBUG_DISPLAY
) {
720 // Some parts of Moodle cannot display errors and debug at all.
721 ini_set('display_errors', '0');
722 ini_set('log_errors', '1');
723 } else if (empty($CFG->debugdisplay
)) {
724 ini_set('display_errors', '0');
725 ini_set('log_errors', '1');
727 // This is very problematic in XHTML strict mode!
728 ini_set('display_errors', '1');
731 // Register our shutdown manager, do NOT use register_shutdown_function().
732 core_shutdown_manager
::initialize();
734 // Verify upgrade is not running unless we are in a script that needs to execute in any case
735 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning
)) {
736 if ($CFG->upgraderunning
< time()) {
737 unset_config('upgraderunning');
739 throw new \
moodle_exception('upgraderunning');
743 // enable circular reference collector in PHP 5.3,
744 // it helps a lot when using large complex OOP structures such as in amos or gradebook
745 if (function_exists('gc_enable')) {
749 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
750 if (!empty($CFG->version
) and $CFG->version
< 2007101509) {
751 throw new \
moodle_exception('upgraderequires19', 'error');
755 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
756 // - WINDOWS: for any Windows flavour.
757 // - UNIX: for the rest
758 // Also, $CFG->os can continue being used if more specialization is required
759 if (stristr(PHP_OS
, 'win') && !stristr(PHP_OS
, 'darwin')) {
760 $CFG->ostype
= 'WINDOWS';
762 $CFG->ostype
= 'UNIX';
766 // Configure ampersands in URLs
767 ini_set('arg_separator.output', '&');
769 // Work around for a PHP bug see MDL-11237
770 ini_set('pcre.backtrack_limit', 20971520); // 20 MB
772 // Set PHP default timezone to server timezone.
773 core_date
::set_default_server_timezone();
775 // Location of standard files
776 $CFG->wordlist
= $CFG->libdir
.'/wordlist.txt';
777 $CFG->moddata
= 'moddata';
779 // neutralise nasty chars in PHP_SELF
780 if (isset($_SERVER['PHP_SELF'])) {
781 $phppos = strpos($_SERVER['PHP_SELF'], '.php');
782 if ($phppos !== false) {
783 $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+
4);
788 // initialise ME's - this must be done BEFORE starting of session!
791 // SYSCONTEXTID is cached in local cache to eliminate 1 query per page.
792 if (!defined('SYSCONTEXTID')) {
793 context_system
::instance();
796 // Defining the site - aka frontpage course
799 } catch (moodle_exception
$e) {
801 if (empty($CFG->version
)) {
802 $SITE = new stdClass();
804 $SITE->shortname
= null;
809 // And the 'default' course - this will usually get reset later in require_login() etc.
810 $COURSE = clone($SITE);
811 // Id of the frontpage course.
812 define('SITEID', $SITE->id
);
814 // init session prevention flag - this is defined on pages that do not want session
816 // no sessions in CLI scripts possible
817 define('NO_MOODLE_COOKIES', true);
819 } else if (WS_SERVER
) {
820 // No sessions possible in web services.
821 define('NO_MOODLE_COOKIES', true);
823 } else if (!defined('NO_MOODLE_COOKIES')) {
824 if (empty($CFG->version
) or $CFG->version
< 2009011900) {
825 // no session before sessions table gets created
826 define('NO_MOODLE_COOKIES', true);
827 } else if (CLI_SCRIPT
) {
828 // CLI scripts can not have session
829 define('NO_MOODLE_COOKIES', true);
831 define('NO_MOODLE_COOKIES', false);
835 // Start session and prepare global $SESSION, $USER.
836 if (empty($CFG->sessiontimeout
)) {
837 $CFG->sessiontimeout
= 8 * 60 * 60;
839 // Set sessiontimeoutwarning 20 minutes.
840 if (empty($CFG->sessiontimeoutwarning
)) {
841 $CFG->sessiontimeoutwarning
= 20 * 60;
844 // Allow plugins to callback just before the session is started.
845 $pluginswithfunction = get_plugins_with_function('before_session_start', 'lib.php');
846 foreach ($pluginswithfunction as $plugins) {
847 foreach ($plugins as $function) {
850 } catch (Throwable
$e) {
851 debugging("Exception calling '$function'", DEBUG_DEVELOPER
, $e->getTrace());
856 \core\session\manager
::start();
857 // Prevent ignoresesskey hack from getting carried over to a next page.
858 unset($USER->ignoresesskey
);
860 if (!empty($CFG->proxylogunsafe
) ||
!empty($CFG->proxyfixunsafe
)) {
861 if (!empty($CFG->proxyfixunsafe
)) {
862 require_once($CFG->libdir
.'/filelib.php');
864 $proxyurl = get_moodle_proxy_url();
865 // This fixes stream handlers inside php.
866 $defaults = stream_context_set_default([
868 'user_agent' => \core_useragent
::get_moodlebot_useragent(),
873 // Attempt to tell other web clients to use the proxy too. This only
874 // works for clients written in php in the same process, it will not
875 // work for with requests done in another process from an exec call.
876 putenv('http_proxy=' . $proxyurl);
877 putenv('https_proxy=' . $proxyurl);
878 putenv('HTTPS_PROXY=' . $proxyurl);
880 $defaults = stream_context_get_default();
883 if (!empty($CFG->proxylogunsafe
)) {
884 stream_context_set_params($defaults, ['notification' => 'proxy_log_callback']);
889 // Set default content type and encoding, developers are still required to use
890 // echo $OUTPUT->header() everywhere, anything that gets set later should override these headers.
891 // This is intended to mitigate some security problems.
893 if (!core_useragent
::supports_json_contenttype()) {
894 // Some bloody old IE.
895 @header
('Content-type: text/plain; charset=utf-8');
896 @header
('X-Content-Type-Options: nosniff');
897 } else if (!empty($_FILES)) {
898 // Some ajax code may have problems with json and file uploads.
899 @header
('Content-type: text/plain; charset=utf-8');
901 @header
('Content-type: application/json; charset=utf-8');
903 } else if (!CLI_SCRIPT
) {
904 @header
('Content-type: text/html; charset=utf-8');
907 // Initialise some variables that are supposed to be set in config.php only.
908 if (!isset($CFG->filelifetime
)) {
909 $CFG->filelifetime
= 60*60*6;
912 // Late profiling, only happening if early one wasn't started
913 if (!empty($CFG->profilingenabled
)) {
914 require_once($CFG->libdir
. '/xhprof/xhprof_moodle.php');
918 // Hack to get around max_input_vars restrictions,
919 // we need to do this after session init to have some basic DDoS protection.
920 workaround_max_input_vars();
922 // Process theme change in the URL.
923 if (!empty($CFG->allowthemechangeonurl
) and !empty($_GET['theme'])) {
924 // we have to use _GET directly because we do not want this to interfere with _POST
925 $urlthemename = optional_param('theme', '', PARAM_PLUGIN
);
927 $themeconfig = theme_config
::load($urlthemename);
928 // Makes sure the theme can be loaded without errors.
929 if ($themeconfig->name
=== $urlthemename) {
930 $SESSION->theme
= $urlthemename;
932 unset($SESSION->theme
);
935 unset($urlthemename);
936 } catch (Exception
$e) {
937 debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER
, $e->getTrace());
940 unset($urlthemename);
942 // Ensure a valid theme is set.
943 if (!isset($CFG->theme
)) {
944 $CFG->theme
= 'boost';
947 // Set language/locale of printed times. If user has chosen a language that
948 // that is different from the site language, then use the locale specified
949 // in the language file. Otherwise, if the admin hasn't specified a locale
950 // then use the one from the default language. Otherwise (and this is the
951 // majority of cases), use the stored locale specified by admin.
952 // note: do not accept lang parameter from POST
953 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR
))) {
954 if (get_string_manager()->translation_exists($lang, false)) {
955 $SESSION->lang
= $lang;
956 \core_courseformat\base
::session_cache_reset_all();
961 // PARAM_SAFEDIR used instead of PARAM_LANG because using PARAM_LANG results
962 // in an empty string being returned when a non-existant language is specified,
963 // which would make it necessary to log out to undo the forcelang setting.
964 // With PARAM_SAFEDIR, it's possible to specify ?forcelang=none to drop the forcelang effect.
965 if ($forcelang = optional_param('forcelang', '', PARAM_SAFEDIR
)) {
967 && get_string_manager()->translation_exists($forcelang, false)
968 && has_capability('moodle/site:forcelanguage', context_system
::instance())) {
969 $SESSION->forcelang
= $forcelang;
970 } else if (isset($SESSION->forcelang
)) {
971 unset($SESSION->forcelang
);
976 setup_lang_from_browser();
978 if (empty($CFG->lang
)) {
979 if (empty($SESSION->lang
)) {
982 $CFG->lang
= $SESSION->lang
;
986 // Set the default site locale, a lot of the stuff may depend on this
987 // it is definitely too late to call this first in require_login()!
990 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup!
991 if (!empty($CFG->moodlepageclass
)) {
992 if (!empty($CFG->moodlepageclassfile
)) {
993 require_once($CFG->moodlepageclassfile
);
995 $classname = $CFG->moodlepageclass
;
997 $classname = 'moodle_page';
999 $PAGE = new $classname();
1003 if (!empty($CFG->debugvalidators
) and !empty($CFG->guestloginbutton
)) {
1004 if ($CFG->theme
== 'standard') { // Temporary measure to help with XHTML validation
1005 if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id
)) { // Allow W3CValidator in as user called w3cvalidator (or guest)
1006 if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
1007 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
1008 if ($user = get_complete_user_data("username", "w3cvalidator")) {
1009 $user->ignoresesskey
= true;
1011 $user = guest_user();
1013 \core\session\manager
::set_user($user);
1019 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
1020 // LogFormat to get the current logged in username in moodle.
1021 // Alternatvely for other web servers a header X-MOODLEUSER can be set which
1022 // can be using in the logfile and stripped out if needed.
1023 set_access_log_user();
1026 // Ensure the urlrewriteclass is setup correctly (to avoid crippling site).
1027 if (isset($CFG->urlrewriteclass
)) {
1028 if (!class_exists($CFG->urlrewriteclass
)) {
1029 debugging("urlrewriteclass {$CFG->urlrewriteclass} was not found, disabling.");
1030 unset($CFG->urlrewriteclass
);
1031 } else if (!in_array('core\output\url_rewriter', class_implements($CFG->urlrewriteclass
))) {
1032 debugging("{$CFG->urlrewriteclass} does not implement core\output\url_rewriter, disabling.", DEBUG_DEVELOPER
);
1033 unset($CFG->urlrewriteclass
);
1037 // Use a custom script replacement if one exists
1038 if (!empty($CFG->customscripts
)) {
1039 if (($customscript = custom_script_path()) !== false) {
1040 require ($customscript);
1045 // no ip blocking, these are CLI only
1046 } else if (CLI_SCRIPT
and !defined('WEB_CRON_EMULATED_CLI')) {
1048 } else if (!empty($CFG->allowbeforeblock
)) { // allowed list processed before blocked list?
1049 // in this case, ip in allowed list will be performed first
1050 // for example, client IP is 192.168.1.1
1051 // 192.168 subnet is an entry in allowed list
1052 // 192.168.1.1 is banned in blocked list
1053 // This ip will be banned finally
1054 if (!empty($CFG->allowedip
)) {
1055 if (!remoteip_in_list($CFG->allowedip
)) {
1056 die(get_string('ipblocked', 'admin'));
1059 // need further check, client ip may a part of
1060 // allowed subnet, but a IP address are listed
1062 if (!empty($CFG->blockedip
)) {
1063 if (remoteip_in_list($CFG->blockedip
)) {
1064 die(get_string('ipblocked', 'admin'));
1069 // in this case, IPs in blocked list will be performed first
1070 // for example, client IP is 192.168.1.1
1071 // 192.168 subnet is an entry in blocked list
1072 // 192.168.1.1 is allowed in allowed list
1073 // This ip will be allowed finally
1074 if (!empty($CFG->blockedip
)) {
1075 if (remoteip_in_list($CFG->blockedip
)) {
1076 // if the allowed ip list is not empty
1077 // IPs are not included in the allowed list will be
1079 if (!empty($CFG->allowedip
)) {
1080 if (!remoteip_in_list($CFG->allowedip
)) {
1081 die(get_string('ipblocked', 'admin'));
1084 die(get_string('ipblocked', 'admin'));
1088 // if blocked list is null
1089 // allowed list should be tested
1090 if(!empty($CFG->allowedip
)) {
1091 if (!remoteip_in_list($CFG->allowedip
)) {
1092 die(get_string('ipblocked', 'admin'));
1098 // // try to detect IE6 and prevent gzip because it is extremely buggy browser
1099 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) {
1100 ini_set('zlib.output_compression', 'Off');
1101 if (function_exists('apache_setenv')) {
1102 apache_setenv('no-gzip', 1);
1106 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised.
1107 if (isset($CFG->maintenance_later
) and $CFG->maintenance_later
<= time()) {
1108 if (!file_exists("$CFG->dataroot/climaintenance.html")) {
1109 require_once("$CFG->libdir/adminlib.php");
1110 enable_cli_maintenance_mode();
1112 unset_config('maintenance_later');
1115 } else if (!CLI_SCRIPT
) {
1116 redirect(new moodle_url('/'));
1120 // Add behat_shutdown_function to shutdown manager, so we can capture php errors,
1121 // but not necessary for behat CLI command as it's being captured by behat process.
1122 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST')) {
1123 core_shutdown_manager
::register_function('behat_shutdown_function');
1126 // note: we can not block non utf-8 installations here, because empty mysql database
1127 // might be converted to utf-8 in admin/index.php during installation
1131 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
1132 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
1134 $DB = new moodle_database();
1135 $OUTPUT = new core_renderer(null, null);
1136 $PAGE = new moodle_page();
1139 // Cache any immutable config locally to avoid constant DB lookups.
1140 initialise_local_config_cache();
1142 // Allow plugins to callback as soon possible after setup.php is loaded.
1143 $pluginswithfunction = get_plugins_with_function('after_config', 'lib.php');
1144 foreach ($pluginswithfunction as $plugins) {
1145 foreach ($plugins as $function) {
1148 } catch (Throwable
$e) {
1149 debugging("Exception calling '$function'", DEBUG_DEVELOPER
, $e->getTrace());