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