MDL-45536 atto_html: Update the textarea size when switching to HTML view
[moodle.git] / lib / setup.php
blobe82d7775aef055a0670d021dec7a6d1455486b66
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.
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
21 * Normally this is only called by the main config.php file
22 * Normally this file does not need to be edited.
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
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.
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).
43 * @global object $CFG
44 * @name $CFG
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);
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') {
93 continue;
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');
97 closedir($dh);
98 unset($dh);
99 unset($file);
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);
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");
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');
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');
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');
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]));
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);
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);
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);
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);
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);
300 } else {
301 if (!CLI_SCRIPT) {
302 echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
303 exit(1);
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")) {
314 if (!CLI_SCRIPT) {
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");
325 die;
326 } else {
327 if (!defined('CLI_MAINTENANCE')) {
328 define('CLI_MAINTENANCE', true);
331 } else {
332 if (!defined('CLI_MAINTENANCE')) {
333 define('CLI_MAINTENANCE', false);
337 if (CLI_SCRIPT) {
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";
344 exit(1);
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.15.0';
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 = 1;
363 $CFG->yuipatchedmodules = array(
364 'dd-drag',
365 'dd-gestures',
368 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides.
369 if (!isset($CFG->config_php_settings)) {
370 $CFG->config_php_settings = (array)$CFG;
371 // Forced plugin settings override values from config_plugins table.
372 unset($CFG->config_php_settings['forced_plugin_settings']);
373 if (!isset($CFG->forced_plugin_settings)) {
374 $CFG->forced_plugin_settings = array();
378 if (isset($CFG->debug)) {
379 $CFG->debug = (int)$CFG->debug;
380 } else {
381 $CFG->debug = 0;
383 $CFG->debugdeveloper = (($CFG->debug & (E_ALL | E_STRICT)) === (E_ALL | E_STRICT)); // DEBUG_DEVELOPER is not available yet.
385 if (!defined('MOODLE_INTERNAL')) { // Necessary because cli installer has to define it earlier.
386 /** Used by library scripts to check they are being called by Moodle. */
387 define('MOODLE_INTERNAL', true);
390 // core_component can be used in any scripts, it does not need anything else.
391 require_once($CFG->libdir .'/classes/component.php');
393 // special support for highly optimised scripts that do not need libraries and DB connection
394 if (defined('ABORT_AFTER_CONFIG')) {
395 if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
396 // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
397 error_reporting($CFG->debug);
398 if (NO_DEBUG_DISPLAY) {
399 // Some parts of Moodle cannot display errors and debug at all.
400 ini_set('display_errors', '0');
401 ini_set('log_errors', '1');
402 } else if (empty($CFG->debugdisplay)) {
403 ini_set('display_errors', '0');
404 ini_set('log_errors', '1');
405 } else {
406 ini_set('display_errors', '1');
408 require_once("$CFG->dirroot/lib/configonlylib.php");
409 return;
413 // Early profiling start, based exclusively on config.php $CFG settings
414 if (!empty($CFG->earlyprofilingenabled)) {
415 require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
416 profiling_start();
420 * Database connection. Used for all access to the database.
421 * @global moodle_database $DB
422 * @name $DB
424 global $DB;
427 * Moodle's wrapper round PHP's $_SESSION.
429 * @global object $SESSION
430 * @name $SESSION
432 global $SESSION;
435 * Holds the user table record for the current user. Will be the 'guest'
436 * user record for people who are not logged in.
438 * $USER is stored in the session.
440 * Items found in the user record:
441 * - $USER->email - The user's email address.
442 * - $USER->id - The unique integer identified of this user in the 'user' table.
443 * - $USER->email - The user's email address.
444 * - $USER->firstname - The user's first name.
445 * - $USER->lastname - The user's last name.
446 * - $USER->username - The user's login username.
447 * - $USER->secret - The user's ?.
448 * - $USER->lang - The user's language choice.
450 * @global object $USER
451 * @name $USER
453 global $USER;
456 * Frontpage course record
458 global $SITE;
461 * A central store of information about the current page we are
462 * generating in response to the user's request.
464 * @global moodle_page $PAGE
465 * @name $PAGE
467 global $PAGE;
470 * The current course. An alias for $PAGE->course.
471 * @global object $COURSE
472 * @name $COURSE
474 global $COURSE;
477 * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
478 * it to generate HTML for output.
480 * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
481 * for the magic that does that. After $OUTPUT has been initialised, any attempt
482 * to change something that affects the current theme ($PAGE->course, logged in use,
483 * httpsrequried ... will result in an exception.)
485 * Please note the $OUTPUT is replacing the old global $THEME object.
487 * @global object $OUTPUT
488 * @name $OUTPUT
490 global $OUTPUT;
493 * Full script path including all params, slash arguments, scheme and host.
495 * Note: Do NOT use for getting of current page URL or detection of https,
496 * instead use $PAGE->url or strpos($CFG->httpswwwroot, 'https:') === 0
498 * @global string $FULLME
499 * @name $FULLME
501 global $FULLME;
504 * Script path including query string and slash arguments without host.
505 * @global string $ME
506 * @name $ME
508 global $ME;
511 * $FULLME without slasharguments and query string.
512 * @global string $FULLSCRIPT
513 * @name $FULLSCRIPT
515 global $FULLSCRIPT;
518 * Relative moodle script path '/course/view.php'
519 * @global string $SCRIPT
520 * @name $SCRIPT
522 global $SCRIPT;
524 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
525 // inside some URLs used in HTTPSPAGEREQUIRED pages.
526 $CFG->httpswwwroot = $CFG->wwwroot;
528 require_once($CFG->libdir .'/setuplib.php'); // Functions that MUST be loaded first
530 if (NO_OUTPUT_BUFFERING) {
531 // we have to call this always before starting session because it discards headers!
532 disable_output_buffering();
535 // Increase memory limits if possible
536 raise_memory_limit(MEMORY_STANDARD);
538 // Time to start counting
539 init_performance_info();
541 // Put $OUTPUT in place, so errors can be displayed.
542 $OUTPUT = new bootstrap_renderer();
544 // set handler for uncaught exceptions - equivalent to print_error() call
545 if (!PHPUNIT_TEST or PHPUNIT_UTIL) {
546 set_exception_handler('default_exception_handler');
547 set_error_handler('default_error_handler', E_ALL | E_STRICT);
550 // Acceptance tests needs special output to capture the errors,
551 // but not necessary for behat CLI command.
552 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST')) {
553 require_once(__DIR__ . '/behat/lib.php');
554 set_error_handler('behat_error_handler', E_ALL | E_STRICT);
557 // If there are any errors in the standard libraries we want to know!
558 error_reporting(E_ALL | E_STRICT);
560 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
561 // http://www.google.com/webmasters/faq.html#prefetchblock
562 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
563 header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
564 echo('Prefetch request forbidden.');
565 exit(1);
568 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
569 //the problem is that we need specific version of quickforms and hacked excel files :-(
570 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
571 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
572 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
573 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
575 // Register our classloader, in theory somebody might want to replace it to load other hacked core classes.
576 if (defined('COMPONENT_CLASSLOADER')) {
577 spl_autoload_register(COMPONENT_CLASSLOADER);
578 } else {
579 spl_autoload_register('core_component::classloader');
582 // Load up standard libraries
583 require_once($CFG->libdir .'/filterlib.php'); // Functions for filtering test as it is output
584 require_once($CFG->libdir .'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI
585 require_once($CFG->libdir .'/weblib.php'); // Functions relating to HTTP and content
586 require_once($CFG->libdir .'/outputlib.php'); // Functions for generating output
587 require_once($CFG->libdir .'/navigationlib.php'); // Class for generating Navigation structure
588 require_once($CFG->libdir .'/dmllib.php'); // Database access
589 require_once($CFG->libdir .'/datalib.php'); // Legacy lib with a big-mix of functions.
590 require_once($CFG->libdir .'/accesslib.php'); // Access control functions
591 require_once($CFG->libdir .'/deprecatedlib.php'); // Deprecated functions included for backward compatibility
592 require_once($CFG->libdir .'/moodlelib.php'); // Other general-purpose functions
593 require_once($CFG->libdir .'/enrollib.php'); // Enrolment related functions
594 require_once($CFG->libdir .'/pagelib.php'); // Library that defines the moodle_page class, used for $PAGE
595 require_once($CFG->libdir .'/blocklib.php'); // Library for controlling blocks
596 require_once($CFG->libdir .'/eventslib.php'); // Events functions
597 require_once($CFG->libdir .'/grouplib.php'); // Groups functions
598 require_once($CFG->libdir .'/sessionlib.php'); // All session and cookie related stuff
599 require_once($CFG->libdir .'/editorlib.php'); // All text editor related functions and classes
600 require_once($CFG->libdir .'/messagelib.php'); // Messagelib functions
601 require_once($CFG->libdir .'/modinfolib.php'); // Cached information on course-module instances
602 require_once($CFG->dirroot.'/cache/lib.php'); // Cache API
604 // make sure PHP is not severly misconfigured
605 setup_validate_php_configuration();
607 // Connect to the database
608 setup_DB();
610 if (PHPUNIT_TEST and !PHPUNIT_UTIL) {
611 // make sure tests do not run in parallel
612 test_lock::acquire('phpunit');
613 $dbhash = null;
614 try {
615 if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) {
616 // reset DB tables
617 phpunit_util::reset_database();
619 } catch (Exception $e) {
620 if ($dbhash) {
621 // we ned to reinit if reset fails
622 $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest'));
625 unset($dbhash);
628 // Load up any configuration from the config table or MUC cache.
629 if (PHPUNIT_TEST) {
630 phpunit_util::initialise_cfg();
631 } else {
632 initialise_cfg();
635 if (isset($CFG->debug)) {
636 $CFG->debug = (int)$CFG->debug;
637 error_reporting($CFG->debug);
638 } else {
639 $CFG->debug = 0;
641 $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER);
643 // Find out if PHP configured to display warnings,
644 // this is a security problem because some moodle scripts may
645 // disclose sensitive information.
646 if (ini_get_bool('display_errors')) {
647 define('WARN_DISPLAY_ERRORS_ENABLED', true);
649 // If we want to display Moodle errors, then try and set PHP errors to match.
650 if (!isset($CFG->debugdisplay)) {
651 // Keep it "as is" during installation.
652 } else if (NO_DEBUG_DISPLAY) {
653 // Some parts of Moodle cannot display errors and debug at all.
654 ini_set('display_errors', '0');
655 ini_set('log_errors', '1');
656 } else if (empty($CFG->debugdisplay)) {
657 ini_set('display_errors', '0');
658 ini_set('log_errors', '1');
659 } else {
660 // This is very problematic in XHTML strict mode!
661 ini_set('display_errors', '1');
664 // Register our shutdown manager, do NOT use register_shutdown_function().
665 core_shutdown_manager::initialize();
667 // Verify upgrade is not running unless we are in a script that needs to execute in any case
668 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
669 if ($CFG->upgraderunning < time()) {
670 unset_config('upgraderunning');
671 } else {
672 print_error('upgraderunning');
676 // Turn on SQL logging if required
677 if (!empty($CFG->logsql)) {
678 $DB->set_logging(true);
681 // enable circular reference collector in PHP 5.3,
682 // it helps a lot when using large complex OOP structures such as in amos or gradebook
683 if (function_exists('gc_enable')) {
684 gc_enable();
687 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
688 if (!empty($CFG->version) and $CFG->version < 2007101509) {
689 print_error('upgraderequires19', 'error');
690 die;
693 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
694 // - WINDOWS: for any Windows flavour.
695 // - UNIX: for the rest
696 // Also, $CFG->os can continue being used if more specialization is required
697 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
698 $CFG->ostype = 'WINDOWS';
699 } else {
700 $CFG->ostype = 'UNIX';
702 $CFG->os = PHP_OS;
704 // Configure ampersands in URLs
705 ini_set('arg_separator.output', '&amp;');
707 // Work around for a PHP bug see MDL-11237
708 ini_set('pcre.backtrack_limit', 20971520); // 20 MB
710 // Location of standard files
711 $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
712 $CFG->moddata = 'moddata';
714 // neutralise nasty chars in PHP_SELF
715 if (isset($_SERVER['PHP_SELF'])) {
716 $phppos = strpos($_SERVER['PHP_SELF'], '.php');
717 if ($phppos !== false) {
718 $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
720 unset($phppos);
723 // initialise ME's - this must be done BEFORE starting of session!
724 initialise_fullme();
726 // define SYSCONTEXTID in config.php if you want to save some queries,
727 // after install it must match the system context record id.
728 if (!defined('SYSCONTEXTID')) {
729 context_system::instance();
732 // Defining the site - aka frontpage course
733 try {
734 $SITE = get_site();
735 } catch (moodle_exception $e) {
736 $SITE = null;
737 if (empty($CFG->version)) {
738 $SITE = new stdClass();
739 $SITE->id = 1;
740 $SITE->shortname = null;
741 } else {
742 throw $e;
745 // And the 'default' course - this will usually get reset later in require_login() etc.
746 $COURSE = clone($SITE);
747 // Id of the frontpage course.
748 define('SITEID', $SITE->id);
750 // init session prevention flag - this is defined on pages that do not want session
751 if (CLI_SCRIPT) {
752 // no sessions in CLI scripts possible
753 define('NO_MOODLE_COOKIES', true);
755 } else if (WS_SERVER) {
756 // No sessions possible in web services.
757 define('NO_MOODLE_COOKIES', true);
759 } else if (!defined('NO_MOODLE_COOKIES')) {
760 if (empty($CFG->version) or $CFG->version < 2009011900) {
761 // no session before sessions table gets created
762 define('NO_MOODLE_COOKIES', true);
763 } else if (CLI_SCRIPT) {
764 // CLI scripts can not have session
765 define('NO_MOODLE_COOKIES', true);
766 } else {
767 define('NO_MOODLE_COOKIES', false);
771 // Start session and prepare global $SESSION, $USER.
772 if (empty($CFG->sessiontimeout)) {
773 $CFG->sessiontimeout = 7200;
775 \core\session\manager::start();
776 if (!PHPUNIT_TEST and !defined('BEHAT_TEST')) {
777 $SESSION =& $_SESSION['SESSION'];
778 $USER =& $_SESSION['USER'];
781 // Initialise some variables that are supposed to be set in config.php only.
782 if (!isset($CFG->filelifetime)) {
783 $CFG->filelifetime = 60*60*6;
786 // Late profiling, only happening if early one wasn't started
787 if (!empty($CFG->profilingenabled)) {
788 require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
789 profiling_start();
792 // Hack to get around max_input_vars restrictions,
793 // we need to do this after session init to have some basic DDoS protection.
794 workaround_max_input_vars();
796 // Process theme change in the URL.
797 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
798 // we have to use _GET directly because we do not want this to interfere with _POST
799 $urlthemename = optional_param('theme', '', PARAM_PLUGIN);
800 try {
801 $themeconfig = theme_config::load($urlthemename);
802 // Makes sure the theme can be loaded without errors.
803 if ($themeconfig->name === $urlthemename) {
804 $SESSION->theme = $urlthemename;
805 } else {
806 unset($SESSION->theme);
808 unset($themeconfig);
809 unset($urlthemename);
810 } catch (Exception $e) {
811 debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
814 unset($urlthemename);
816 // Ensure a valid theme is set.
817 if (!isset($CFG->theme)) {
818 $CFG->theme = 'clean';
821 // Set language/locale of printed times. If user has chosen a language that
822 // that is different from the site language, then use the locale specified
823 // in the language file. Otherwise, if the admin hasn't specified a locale
824 // then use the one from the default language. Otherwise (and this is the
825 // majority of cases), use the stored locale specified by admin.
826 // note: do not accept lang parameter from POST
827 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
828 if (get_string_manager()->translation_exists($lang, false)) {
829 $SESSION->lang = $lang;
832 unset($lang);
834 // PARAM_SAFEDIR used instead of PARAM_LANG because using PARAM_LANG results
835 // in an empty string being returned when a non-existant language is specified,
836 // which would make it necessary to log out to undo the forcelang setting.
837 // With PARAM_SAFEDIR, it's possible to specify ?forcelang=none to drop the forcelang effect.
838 if ($forcelang = optional_param('forcelang', '', PARAM_SAFEDIR)) {
839 if (isloggedin()
840 && get_string_manager()->translation_exists($forcelang, false)
841 && has_capability('moodle/site:forcelanguage', context_system::instance())) {
842 $SESSION->forcelang = $forcelang;
843 } else if (isset($SESSION->forcelang)) {
844 unset($SESSION->forcelang);
847 unset($forcelang);
849 setup_lang_from_browser();
851 if (empty($CFG->lang)) {
852 if (empty($SESSION->lang)) {
853 $CFG->lang = 'en';
854 } else {
855 $CFG->lang = $SESSION->lang;
859 // Set the default site locale, a lot of the stuff may depend on this
860 // it is definitely too late to call this first in require_login()!
861 moodle_setlocale();
863 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup!
864 if (!empty($CFG->moodlepageclass)) {
865 if (!empty($CFG->moodlepageclassfile)) {
866 require_once($CFG->moodlepageclassfile);
868 $classname = $CFG->moodlepageclass;
869 } else {
870 $classname = 'moodle_page';
872 $PAGE = new $classname();
873 unset($classname);
876 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
877 if ($CFG->theme == 'standard') { // Temporary measure to help with XHTML validation
878 if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) { // Allow W3CValidator in as user called w3cvalidator (or guest)
879 if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
880 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
881 if ($user = get_complete_user_data("username", "w3cvalidator")) {
882 $user->ignoresesskey = true;
883 } else {
884 $user = guest_user();
886 \core\session\manager::set_user($user);
892 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
893 // LogFormat to get the current logged in username in moodle.
894 if ($USER && function_exists('apache_note')
895 && !empty($CFG->apacheloguser) && isset($USER->username)) {
896 $apachelog_userid = $USER->id;
897 $apachelog_username = clean_filename($USER->username);
898 $apachelog_name = '';
899 if (isset($USER->firstname)) {
900 // We can assume both will be set
901 // - even if to empty.
902 $apachelog_name = clean_filename($USER->firstname . " " .
903 $USER->lastname);
905 if (\core\session\manager::is_loggedinas()) {
906 $realuser = \core\session\manager::get_realuser();
907 $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
908 $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
909 $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
911 switch ($CFG->apacheloguser) {
912 case 3:
913 $logname = $apachelog_username;
914 break;
915 case 2:
916 $logname = $apachelog_name;
917 break;
918 case 1:
919 default:
920 $logname = $apachelog_userid;
921 break;
923 apache_note('MOODLEUSER', $logname);
926 // Use a custom script replacement if one exists
927 if (!empty($CFG->customscripts)) {
928 if (($customscript = custom_script_path()) !== false) {
929 require ($customscript);
933 if (PHPUNIT_TEST) {
934 // no ip blocking, these are CLI only
935 } else if (CLI_SCRIPT and !defined('WEB_CRON_EMULATED_CLI')) {
936 // no ip blocking
937 } else if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
938 // in this case, ip in allowed list will be performed first
939 // for example, client IP is 192.168.1.1
940 // 192.168 subnet is an entry in allowed list
941 // 192.168.1.1 is banned in blocked list
942 // This ip will be banned finally
943 if (!empty($CFG->allowedip)) {
944 if (!remoteip_in_list($CFG->allowedip)) {
945 die(get_string('ipblocked', 'admin'));
948 // need further check, client ip may a part of
949 // allowed subnet, but a IP address are listed
950 // in blocked list.
951 if (!empty($CFG->blockedip)) {
952 if (remoteip_in_list($CFG->blockedip)) {
953 die(get_string('ipblocked', 'admin'));
957 } else {
958 // in this case, IPs in blocked list will be performed first
959 // for example, client IP is 192.168.1.1
960 // 192.168 subnet is an entry in blocked list
961 // 192.168.1.1 is allowed in allowed list
962 // This ip will be allowed finally
963 if (!empty($CFG->blockedip)) {
964 if (remoteip_in_list($CFG->blockedip)) {
965 // if the allowed ip list is not empty
966 // IPs are not included in the allowed list will be
967 // blocked too
968 if (!empty($CFG->allowedip)) {
969 if (!remoteip_in_list($CFG->allowedip)) {
970 die(get_string('ipblocked', 'admin'));
972 } else {
973 die(get_string('ipblocked', 'admin'));
977 // if blocked list is null
978 // allowed list should be tested
979 if(!empty($CFG->allowedip)) {
980 if (!remoteip_in_list($CFG->allowedip)) {
981 die(get_string('ipblocked', 'admin'));
987 // // try to detect IE6 and prevent gzip because it is extremely buggy browser
988 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) {
989 ini_set('zlib.output_compression', 'Off');
990 if (function_exists('apache_setenv')) {
991 apache_setenv('no-gzip', 1);
995 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised.
996 if (isset($CFG->maintenance_later) and $CFG->maintenance_later <= time()) {
997 if (!file_exists("$CFG->dataroot/climaintenance.html")) {
998 require_once("$CFG->libdir/adminlib.php");
999 enable_cli_maintenance_mode();
1001 unset_config('maintenance_later');
1002 if (AJAX_SCRIPT) {
1003 die;
1004 } else if (!CLI_SCRIPT) {
1005 redirect(new moodle_url('/'));
1009 // note: we can not block non utf-8 installations here, because empty mysql database
1010 // might be converted to utf-8 in admin/index.php during installation
1014 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
1015 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
1016 if (false) {
1017 $DB = new moodle_database();
1018 $OUTPUT = new core_renderer(null, null);
1019 $PAGE = new moodle_page();