3175bb1cc3a3f90b7c534b477036b2fd38dbbf51
[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');
84     // Update config variables for parallel behat runs.
85     behat_update_vars_for_process();
87     if (behat_is_test_site()) {
88         clearstatcache();
90         // Checking the integrity of the provided $CFG->behat_* vars and the
91         // selected wwwroot to prevent conflicts with production and phpunit environments.
92         behat_check_config_vars();
94         // Check that the directory does not contains other things.
95         if (!file_exists("$CFG->behat_dataroot/behattestdir.txt")) {
96             if ($dh = opendir($CFG->behat_dataroot)) {
97                 while (($file = readdir($dh)) !== false) {
98                     if ($file === 'behat' or $file === '.' or $file === '..' or $file === '.DS_Store' or is_numeric($file)) {
99                         continue;
100                     }
101                     behat_error(BEHAT_EXITCODE_CONFIG, "$CFG->behat_dataroot directory is not empty, ensure this is the " .
102                         "directory where you want to install behat test dataroot");
103                 }
104                 closedir($dh);
105                 unset($dh);
106                 unset($file);
107             }
109             if (defined('BEHAT_UTIL')) {
110                 // Now we create dataroot directory structure for behat tests.
111                 testing_initdataroot($CFG->behat_dataroot, 'behat');
112             } else {
113                 behat_error(BEHAT_EXITCODE_INSTALL);
114             }
115         }
117         if (!defined('BEHAT_UTIL') and !defined('BEHAT_TEST')) {
118             // Somebody tries to access test site directly, tell them if not enabled.
119             if (!file_exists($CFG->behat_dataroot . '/behat/test_environment_enabled.txt')) {
120                 behat_error(BEHAT_EXITCODE_CONFIG, 'Behat is configured but not enabled on this test site.');
121             }
122         }
124         // Constant used to inform that the behat test site is being used,
125         // this includes all the processes executed by the behat CLI command like
126         // the site reset, the steps executed by the browser drivers when simulating
127         // a user session and a real session when browsing manually to $CFG->behat_wwwroot
128         // like the browser driver does automatically.
129         // Different from BEHAT_TEST as only this last one can perform CLI
130         // actions like reset the site or use data generators.
131         define('BEHAT_SITE_RUNNING', true);
133         // Clean extra config.php settings.
134         behat_clean_init_config();
136         // Now we can begin switching $CFG->X for $CFG->behat_X.
137         $CFG->wwwroot = $CFG->behat_wwwroot;
138         $CFG->prefix = $CFG->behat_prefix;
139         $CFG->dataroot = $CFG->behat_dataroot;
140     }
143 // Normalise dataroot - we do not want any symbolic links, trailing / or any other weirdness there
144 if (!isset($CFG->dataroot)) {
145     if (isset($_SERVER['REMOTE_ADDR'])) {
146         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
147     }
148     echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n");
149     exit(1);
151 $CFG->dataroot = realpath($CFG->dataroot);
152 if ($CFG->dataroot === false) {
153     if (isset($_SERVER['REMOTE_ADDR'])) {
154         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
155     }
156     echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n");
157     exit(1);
158 } else if (!is_writable($CFG->dataroot)) {
159     if (isset($_SERVER['REMOTE_ADDR'])) {
160         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
161     }
162     echo('Fatal error: $CFG->dataroot is not writable, admin has to fix directory permissions! Exiting.'."\n");
163     exit(1);
166 // wwwroot is mandatory
167 if (!isset($CFG->wwwroot) or $CFG->wwwroot === 'http://example.com/moodle') {
168     if (isset($_SERVER['REMOTE_ADDR'])) {
169         header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
170     }
171     echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n");
172     exit(1);
175 // Make sure there is some database table prefix.
176 if (!isset($CFG->prefix)) {
177     $CFG->prefix = '';
180 // Define admin directory
181 if (!isset($CFG->admin)) {   // Just in case it isn't defined in config.php
182     $CFG->admin = 'admin';   // This is relative to the wwwroot and dirroot
185 // Set up some paths.
186 $CFG->libdir = $CFG->dirroot .'/lib';
188 // Allow overriding of tempdir but be backwards compatible
189 if (!isset($CFG->tempdir)) {
190     $CFG->tempdir = "$CFG->dataroot/temp";
193 // Allow overriding of cachedir but be backwards compatible
194 if (!isset($CFG->cachedir)) {
195     $CFG->cachedir = "$CFG->dataroot/cache";
198 // Allow overriding of localcachedir.
199 if (!isset($CFG->localcachedir)) {
200     $CFG->localcachedir = "$CFG->dataroot/localcache";
203 // Location of all languages except core English pack.
204 if (!isset($CFG->langotherroot)) {
205     $CFG->langotherroot = $CFG->dataroot.'/lang';
208 // Location of local lang pack customisations (dirs with _local suffix).
209 if (!isset($CFG->langlocalroot)) {
210     $CFG->langlocalroot = $CFG->dataroot.'/lang';
213 // The current directory in PHP version 4.3.0 and above isn't necessarily the
214 // directory of the script when run from the command line. The require_once()
215 // would fail, so we'll have to chdir()
216 if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
217     // do it only once - skip the second time when continuing after prevous abort
218     if (!defined('ABORT_AFTER_CONFIG') and !defined('ABORT_AFTER_CONFIG_CANCEL')) {
219         chdir(dirname($_SERVER['argv'][0]));
220     }
223 // sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that??
224 ini_set('precision', 14); // needed for upgrades and gradebook
225 ini_set('serialize_precision', 17); // Make float serialization consistent on all systems.
227 // Scripts may request no debug and error messages in output
228 // please note it must be defined before including the config.php script
229 // and in some cases you also need to set custom default exception handler
230 if (!defined('NO_DEBUG_DISPLAY')) {
231     if (defined('AJAX_SCRIPT') and AJAX_SCRIPT) {
232         // Moodle AJAX scripts are expected to return json data, any PHP notices or errors break it badly,
233         // developers simply must learn to watch error log.
234         define('NO_DEBUG_DISPLAY', true);
235     } else {
236         define('NO_DEBUG_DISPLAY', false);
237     }
240 // Some scripts such as upgrade may want to prevent output buffering
241 if (!defined('NO_OUTPUT_BUFFERING')) {
242     define('NO_OUTPUT_BUFFERING', false);
245 // PHPUnit tests need custom init
246 if (!defined('PHPUNIT_TEST')) {
247     define('PHPUNIT_TEST', false);
250 // Performance tests needs to always display performance info, even in redirections.
251 if (!defined('MDL_PERF_TEST')) {
252     define('MDL_PERF_TEST', false);
253 } else {
254     // We force the ones we need.
255     if (!defined('MDL_PERF')) {
256         define('MDL_PERF', true);
257     }
258     if (!defined('MDL_PERFDB')) {
259         define('MDL_PERFDB', true);
260     }
261     if (!defined('MDL_PERFTOFOOT')) {
262         define('MDL_PERFTOFOOT', true);
263     }
266 // When set to true MUC (Moodle caching) will be disabled as much as possible.
267 // A special cache factory will be used to handle this situation and will use special "disabled" equivalents objects.
268 // This ensure we don't attempt to read or create the config file, don't use stores, don't provide persistence or
269 // storage of any kind.
270 if (!defined('CACHE_DISABLE_ALL')) {
271     define('CACHE_DISABLE_ALL', false);
274 // When set to true MUC (Moodle caching) will not use any of the defined or default stores.
275 // The Cache API will continue to function however this will force the use of the cachestore_dummy so all requests
276 // will be interacting with a static property and will never go to the proper cache stores.
277 // Useful if you need to avoid the stores for one reason or another.
278 if (!defined('CACHE_DISABLE_STORES')) {
279     define('CACHE_DISABLE_STORES', false);
282 // Servers should define a default timezone in php.ini, but if they don't then make sure no errors are shown.
283 date_default_timezone_set(@date_default_timezone_get());
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 // All web service requests have WS_SERVER == true.
309 if (!defined('WS_SERVER')) {
310     define('WS_SERVER', false);
313 // Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades
314 if (file_exists("$CFG->dataroot/climaintenance.html")) {
315     if (!CLI_SCRIPT) {
316         header('Content-type: text/html; charset=utf-8');
317         header('X-UA-Compatible: IE=edge');
318         /// Headers to make it not cacheable and json
319         header('Cache-Control: no-store, no-cache, must-revalidate');
320         header('Cache-Control: post-check=0, pre-check=0', false);
321         header('Pragma: no-cache');
322         header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
323         header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
324         header('Accept-Ranges: none');
325         readfile("$CFG->dataroot/climaintenance.html");
326         die;
327     } else {
328         if (!defined('CLI_MAINTENANCE')) {
329             define('CLI_MAINTENANCE', true);
330         }
331     }
332 } else {
333     if (!defined('CLI_MAINTENANCE')) {
334         define('CLI_MAINTENANCE', false);
335     }
338 if (CLI_SCRIPT) {
339     // sometimes people use different PHP binary for web and CLI, make 100% sure they have the supported PHP version
340     if (version_compare(phpversion(), '5.4.4') < 0) {
341         $phpversion = phpversion();
342         // do NOT localise - lang strings would not work here and we CAN NOT move it to later place
343         echo "Moodle 2.7 or later requires at least PHP 5.4.4 (currently using version $phpversion).\n";
344         echo "Some servers may have multiple PHP versions installed, are you using the correct executable?\n";
345         exit(1);
346     }
349 // Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
350 if (!defined('AJAX_SCRIPT')) {
351     define('AJAX_SCRIPT', false);
354 // Exact version of currently used yui2 and 3 library.
355 $CFG->yui2version = '2.9.0';
356 $CFG->yui3version = '3.17.2';
358 // Patching the upstream YUI release.
359 // For important information on patching YUI modules, please see http://docs.moodle.org/dev/YUI/Patching.
360 // If we need to patch a YUI modules between official YUI releases, the yuipatchlevel will need to be manually
361 // incremented here. The module will also need to be listed in the yuipatchedmodules.
362 // When upgrading to a subsequent version of YUI, these should be reset back to 0 and an empty array.
363 $CFG->yuipatchlevel = 0;
364 $CFG->yuipatchedmodules = array(
365 );
367 if (!empty($CFG->disableonclickaddoninstall)) {
368     // This config.php flag has been merged into another one.
369     $CFG->disableupdateautodeploy = true;
372 // Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides.
373 if (!isset($CFG->config_php_settings)) {
374     $CFG->config_php_settings = (array)$CFG;
375     // Forced plugin settings override values from config_plugins table.
376     unset($CFG->config_php_settings['forced_plugin_settings']);
377     if (!isset($CFG->forced_plugin_settings)) {
378         $CFG->forced_plugin_settings = array();
379     }
382 if (isset($CFG->debug)) {
383     $CFG->debug = (int)$CFG->debug;
384 } else {
385     $CFG->debug = 0;
387 $CFG->debugdeveloper = (($CFG->debug & (E_ALL | E_STRICT)) === (E_ALL | E_STRICT)); // DEBUG_DEVELOPER is not available yet.
389 if (!defined('MOODLE_INTERNAL')) { // Necessary because cli installer has to define it earlier.
390     /** Used by library scripts to check they are being called by Moodle. */
391     define('MOODLE_INTERNAL', true);
394 // core_component can be used in any scripts, it does not need anything else.
395 require_once($CFG->libdir .'/classes/component.php');
397 // special support for highly optimised scripts that do not need libraries and DB connection
398 if (defined('ABORT_AFTER_CONFIG')) {
399     if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
400         // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
401         error_reporting($CFG->debug);
402         if (NO_DEBUG_DISPLAY) {
403             // Some parts of Moodle cannot display errors and debug at all.
404             ini_set('display_errors', '0');
405             ini_set('log_errors', '1');
406         } else if (empty($CFG->debugdisplay)) {
407             ini_set('display_errors', '0');
408             ini_set('log_errors', '1');
409         } else {
410             ini_set('display_errors', '1');
411         }
412         require_once("$CFG->dirroot/lib/configonlylib.php");
413         return;
414     }
417 // Early profiling start, based exclusively on config.php $CFG settings
418 if (!empty($CFG->earlyprofilingenabled)) {
419     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
420     profiling_start();
423 /**
424  * Database connection. Used for all access to the database.
425  * @global moodle_database $DB
426  * @name $DB
427  */
428 global $DB;
430 /**
431  * Moodle's wrapper round PHP's $_SESSION.
432  *
433  * @global object $SESSION
434  * @name $SESSION
435  */
436 global $SESSION;
438 /**
439  * Holds the user table record for the current user. Will be the 'guest'
440  * user record for people who are not logged in.
441  *
442  * $USER is stored in the session.
443  *
444  * Items found in the user record:
445  *  - $USER->email - The user's email address.
446  *  - $USER->id - The unique integer identified of this user in the 'user' table.
447  *  - $USER->email - The user's email address.
448  *  - $USER->firstname - The user's first name.
449  *  - $USER->lastname - The user's last name.
450  *  - $USER->username - The user's login username.
451  *  - $USER->secret - The user's ?.
452  *  - $USER->lang - The user's language choice.
453  *
454  * @global object $USER
455  * @name $USER
456  */
457 global $USER;
459 /**
460  * Frontpage course record
461  */
462 global $SITE;
464 /**
465  * A central store of information about the current page we are
466  * generating in response to the user's request.
467  *
468  * @global moodle_page $PAGE
469  * @name $PAGE
470  */
471 global $PAGE;
473 /**
474  * The current course. An alias for $PAGE->course.
475  * @global object $COURSE
476  * @name $COURSE
477  */
478 global $COURSE;
480 /**
481  * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
482  * it to generate HTML for output.
483  *
484  * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
485  * for the magic that does that. After $OUTPUT has been initialised, any attempt
486  * to change something that affects the current theme ($PAGE->course, logged in use,
487  * httpsrequried ... will result in an exception.)
488  *
489  * Please note the $OUTPUT is replacing the old global $THEME object.
490  *
491  * @global object $OUTPUT
492  * @name $OUTPUT
493  */
494 global $OUTPUT;
496 /**
497  * Full script path including all params, slash arguments, scheme and host.
498  *
499  * Note: Do NOT use for getting of current page URL or detection of https,
500  * instead use $PAGE->url or is_https().
501  *
502  * @global string $FULLME
503  * @name $FULLME
504  */
505 global $FULLME;
507 /**
508  * Script path including query string and slash arguments without host.
509  * @global string $ME
510  * @name $ME
511  */
512 global $ME;
514 /**
515  * $FULLME without slasharguments and query string.
516  * @global string $FULLSCRIPT
517  * @name $FULLSCRIPT
518  */
519 global $FULLSCRIPT;
521 /**
522  * Relative moodle script path '/course/view.php'
523  * @global string $SCRIPT
524  * @name $SCRIPT
525  */
526 global $SCRIPT;
528 // Set httpswwwroot default value (this variable will replace $CFG->wwwroot
529 // inside some URLs used in HTTPSPAGEREQUIRED pages.
530 $CFG->httpswwwroot = $CFG->wwwroot;
532 require_once($CFG->libdir .'/setuplib.php');        // Functions that MUST be loaded first
534 if (NO_OUTPUT_BUFFERING) {
535     // we have to call this always before starting session because it discards headers!
536     disable_output_buffering();
539 // Increase memory limits if possible
540 raise_memory_limit(MEMORY_STANDARD);
542 // Time to start counting
543 init_performance_info();
545 // Put $OUTPUT in place, so errors can be displayed.
546 $OUTPUT = new bootstrap_renderer();
548 // set handler for uncaught exceptions - equivalent to print_error() call
549 if (!PHPUNIT_TEST or PHPUNIT_UTIL) {
550     set_exception_handler('default_exception_handler');
551     set_error_handler('default_error_handler', E_ALL | E_STRICT);
554 // Acceptance tests needs special output to capture the errors,
555 // but not necessary for behat CLI command.
556 if (defined('BEHAT_SITE_RUNNING') && !defined('BEHAT_TEST')) {
557     require_once(__DIR__ . '/behat/lib.php');
558     set_error_handler('behat_error_handler', E_ALL | E_STRICT);
561 // If there are any errors in the standard libraries we want to know!
562 error_reporting(E_ALL | E_STRICT);
564 // Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
565 // http://www.google.com/webmasters/faq.html#prefetchblock
566 if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
567     header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
568     echo('Prefetch request forbidden.');
569     exit(1);
572 //point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
573 //the problem is that we need specific version of quickforms and hacked excel files :-(
574 ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
575 //point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
576 //please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
577 ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
579 // Register our classloader, in theory somebody might want to replace it to load other hacked core classes.
580 if (defined('COMPONENT_CLASSLOADER')) {
581     spl_autoload_register(COMPONENT_CLASSLOADER);
582 } else {
583     spl_autoload_register('core_component::classloader');
586 // Remember the default PHP timezone, we will need it later.
587 core_date::store_default_php_timezone();
589 // Load up standard libraries
590 require_once($CFG->libdir .'/filterlib.php');       // Functions for filtering test as it is output
591 require_once($CFG->libdir .'/ajax/ajaxlib.php');    // Functions for managing our use of JavaScript and YUI
592 require_once($CFG->libdir .'/weblib.php');          // Functions relating to HTTP and content
593 require_once($CFG->libdir .'/outputlib.php');       // Functions for generating output
594 require_once($CFG->libdir .'/navigationlib.php');   // Class for generating Navigation structure
595 require_once($CFG->libdir .'/dmllib.php');          // Database access
596 require_once($CFG->libdir .'/datalib.php');         // Legacy lib with a big-mix of functions.
597 require_once($CFG->libdir .'/accesslib.php');       // Access control functions
598 require_once($CFG->libdir .'/deprecatedlib.php');   // Deprecated functions included for backward compatibility
599 require_once($CFG->libdir .'/moodlelib.php');       // Other general-purpose functions
600 require_once($CFG->libdir .'/enrollib.php');        // Enrolment related functions
601 require_once($CFG->libdir .'/pagelib.php');         // Library that defines the moodle_page class, used for $PAGE
602 require_once($CFG->libdir .'/blocklib.php');        // Library for controlling blocks
603 require_once($CFG->libdir .'/eventslib.php');       // Events functions
604 require_once($CFG->libdir .'/grouplib.php');        // Groups functions
605 require_once($CFG->libdir .'/sessionlib.php');      // All session and cookie related stuff
606 require_once($CFG->libdir .'/editorlib.php');       // All text editor related functions and classes
607 require_once($CFG->libdir .'/messagelib.php');      // Messagelib functions
608 require_once($CFG->libdir .'/modinfolib.php');      // Cached information on course-module instances
609 require_once($CFG->dirroot.'/cache/lib.php');       // Cache API
611 // make sure PHP is not severly misconfigured
612 setup_validate_php_configuration();
614 // Connect to the database
615 setup_DB();
617 if (PHPUNIT_TEST and !PHPUNIT_UTIL) {
618     // make sure tests do not run in parallel
619     test_lock::acquire('phpunit');
620     $dbhash = null;
621     try {
622         if ($dbhash = $DB->get_field('config', 'value', array('name'=>'phpunittest'))) {
623             // reset DB tables
624             phpunit_util::reset_database();
625         }
626     } catch (Exception $e) {
627         if ($dbhash) {
628             // we ned to reinit if reset fails
629             $DB->set_field('config', 'value', 'na', array('name'=>'phpunittest'));
630         }
631     }
632     unset($dbhash);
635 // Load up any configuration from the config table or MUC cache.
636 if (PHPUNIT_TEST) {
637     phpunit_util::initialise_cfg();
638 } else {
639     initialise_cfg();
642 if (isset($CFG->debug)) {
643     $CFG->debug = (int)$CFG->debug;
644     error_reporting($CFG->debug);
645 }  else {
646     $CFG->debug = 0;
648 $CFG->debugdeveloper = (($CFG->debug & DEBUG_DEVELOPER) === DEBUG_DEVELOPER);
650 // Find out if PHP configured to display warnings,
651 // this is a security problem because some moodle scripts may
652 // disclose sensitive information.
653 if (ini_get_bool('display_errors')) {
654     define('WARN_DISPLAY_ERRORS_ENABLED', true);
656 // If we want to display Moodle errors, then try and set PHP errors to match.
657 if (!isset($CFG->debugdisplay)) {
658     // Keep it "as is" during installation.
659 } else if (NO_DEBUG_DISPLAY) {
660     // Some parts of Moodle cannot display errors and debug at all.
661     ini_set('display_errors', '0');
662     ini_set('log_errors', '1');
663 } else if (empty($CFG->debugdisplay)) {
664     ini_set('display_errors', '0');
665     ini_set('log_errors', '1');
666 } else {
667     // This is very problematic in XHTML strict mode!
668     ini_set('display_errors', '1');
671 // Register our shutdown manager, do NOT use register_shutdown_function().
672 core_shutdown_manager::initialize();
674 // Verify upgrade is not running unless we are in a script that needs to execute in any case
675 if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
676     if ($CFG->upgraderunning < time()) {
677         unset_config('upgraderunning');
678     } else {
679         print_error('upgraderunning');
680     }
683 // enable circular reference collector in PHP 5.3,
684 // it helps a lot when using large complex OOP structures such as in amos or gradebook
685 if (function_exists('gc_enable')) {
686     gc_enable();
689 // detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
690 if (!empty($CFG->version) and $CFG->version < 2007101509) {
691     print_error('upgraderequires19', 'error');
692     die;
695 // Calculate and set $CFG->ostype to be used everywhere. Possible values are:
696 // - WINDOWS: for any Windows flavour.
697 // - UNIX: for the rest
698 // Also, $CFG->os can continue being used if more specialization is required
699 if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
700     $CFG->ostype = 'WINDOWS';
701 } else {
702     $CFG->ostype = 'UNIX';
704 $CFG->os = PHP_OS;
706 // Configure ampersands in URLs
707 ini_set('arg_separator.output', '&amp;');
709 // Work around for a PHP bug   see MDL-11237
710 ini_set('pcre.backtrack_limit', 20971520);  // 20 MB
712 // Set PHP default timezone to server timezone.
713 core_date::set_default_server_timezone();
715 // Location of standard files
716 $CFG->wordlist = $CFG->libdir .'/wordlist.txt';
717 $CFG->moddata  = 'moddata';
719 // neutralise nasty chars in PHP_SELF
720 if (isset($_SERVER['PHP_SELF'])) {
721     $phppos = strpos($_SERVER['PHP_SELF'], '.php');
722     if ($phppos !== false) {
723         $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
724     }
725     unset($phppos);
728 // initialise ME's - this must be done BEFORE starting of session!
729 initialise_fullme();
731 // define SYSCONTEXTID in config.php if you want to save some queries,
732 // after install it must match the system context record id.
733 if (!defined('SYSCONTEXTID')) {
734     context_system::instance();
737 // Defining the site - aka frontpage course
738 try {
739     $SITE = get_site();
740 } catch (moodle_exception $e) {
741     $SITE = null;
742     if (empty($CFG->version)) {
743         $SITE = new stdClass();
744         $SITE->id = 1;
745         $SITE->shortname = null;
746     } else {
747         throw $e;
748     }
750 // And the 'default' course - this will usually get reset later in require_login() etc.
751 $COURSE = clone($SITE);
752 // Id of the frontpage course.
753 define('SITEID', $SITE->id);
755 // init session prevention flag - this is defined on pages that do not want session
756 if (CLI_SCRIPT) {
757     // no sessions in CLI scripts possible
758     define('NO_MOODLE_COOKIES', true);
760 } else if (WS_SERVER) {
761     // No sessions possible in web services.
762     define('NO_MOODLE_COOKIES', true);
764 } else if (!defined('NO_MOODLE_COOKIES')) {
765     if (empty($CFG->version) or $CFG->version < 2009011900) {
766         // no session before sessions table gets created
767         define('NO_MOODLE_COOKIES', true);
768     } else if (CLI_SCRIPT) {
769         // CLI scripts can not have session
770         define('NO_MOODLE_COOKIES', true);
771     } else {
772         define('NO_MOODLE_COOKIES', false);
773     }
776 // Start session and prepare global $SESSION, $USER.
777 if (empty($CFG->sessiontimeout)) {
778     $CFG->sessiontimeout = 7200;
780 \core\session\manager::start();
782 // Set default content type and encoding, developers are still required to use
783 // echo $OUTPUT->header() everywhere, anything that gets set later should override these headers.
784 // This is intended to mitigate some security problems.
785 if (AJAX_SCRIPT) {
786     if (!core_useragent::supports_json_contenttype()) {
787         // Some bloody old IE.
788         @header('Content-type: text/plain; charset=utf-8');
789         @header('X-Content-Type-Options: nosniff');
790     } else if (!empty($_FILES)) {
791         // Some ajax code may have problems with json and file uploads.
792         @header('Content-type: text/plain; charset=utf-8');
793     } else {
794         @header('Content-type: application/json; charset=utf-8');
795     }
796 } else if (!CLI_SCRIPT) {
797     @header('Content-type: text/html; charset=utf-8');
800 // Initialise some variables that are supposed to be set in config.php only.
801 if (!isset($CFG->filelifetime)) {
802     $CFG->filelifetime = 60*60*6;
805 // Late profiling, only happening if early one wasn't started
806 if (!empty($CFG->profilingenabled)) {
807     require_once($CFG->libdir . '/xhprof/xhprof_moodle.php');
808     profiling_start();
811 // Hack to get around max_input_vars restrictions,
812 // we need to do this after session init to have some basic DDoS protection.
813 workaround_max_input_vars();
815 // Process theme change in the URL.
816 if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
817     // we have to use _GET directly because we do not want this to interfere with _POST
818     $urlthemename = optional_param('theme', '', PARAM_PLUGIN);
819     try {
820         $themeconfig = theme_config::load($urlthemename);
821         // Makes sure the theme can be loaded without errors.
822         if ($themeconfig->name === $urlthemename) {
823             $SESSION->theme = $urlthemename;
824         } else {
825             unset($SESSION->theme);
826         }
827         unset($themeconfig);
828         unset($urlthemename);
829     } catch (Exception $e) {
830         debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
831     }
833 unset($urlthemename);
835 // Ensure a valid theme is set.
836 if (!isset($CFG->theme)) {
837     $CFG->theme = 'clean';
840 // Set language/locale of printed times.  If user has chosen a language that
841 // that is different from the site language, then use the locale specified
842 // in the language file.  Otherwise, if the admin hasn't specified a locale
843 // then use the one from the default language.  Otherwise (and this is the
844 // majority of cases), use the stored locale specified by admin.
845 // note: do not accept lang parameter from POST
846 if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
847     if (get_string_manager()->translation_exists($lang, false)) {
848         $SESSION->lang = $lang;
849     }
851 unset($lang);
853 // PARAM_SAFEDIR used instead of PARAM_LANG because using PARAM_LANG results
854 // in an empty string being returned when a non-existant language is specified,
855 // which would make it necessary to log out to undo the forcelang setting.
856 // With PARAM_SAFEDIR, it's possible to specify ?forcelang=none to drop the forcelang effect.
857 if ($forcelang = optional_param('forcelang', '', PARAM_SAFEDIR)) {
858     if (isloggedin()
859         && get_string_manager()->translation_exists($forcelang, false)
860         && has_capability('moodle/site:forcelanguage', context_system::instance())) {
861         $SESSION->forcelang = $forcelang;
862     } else if (isset($SESSION->forcelang)) {
863         unset($SESSION->forcelang);
864     }
866 unset($forcelang);
868 setup_lang_from_browser();
870 if (empty($CFG->lang)) {
871     if (empty($SESSION->lang)) {
872         $CFG->lang = 'en';
873     } else {
874         $CFG->lang = $SESSION->lang;
875     }
878 // Set the default site locale, a lot of the stuff may depend on this
879 // it is definitely too late to call this first in require_login()!
880 moodle_setlocale();
882 // Create the $PAGE global - this marks the PAGE and OUTPUT fully initialised, this MUST be done at the end of setup!
883 if (!empty($CFG->moodlepageclass)) {
884     if (!empty($CFG->moodlepageclassfile)) {
885         require_once($CFG->moodlepageclassfile);
886     }
887     $classname = $CFG->moodlepageclass;
888 } else {
889     $classname = 'moodle_page';
891 $PAGE = new $classname();
892 unset($classname);
895 if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
896     if ($CFG->theme == 'standard') {    // Temporary measure to help with XHTML validation
897         if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) {      // Allow W3CValidator in as user called w3cvalidator (or guest)
898             if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
899                 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
900                 if ($user = get_complete_user_data("username", "w3cvalidator")) {
901                     $user->ignoresesskey = true;
902                 } else {
903                     $user = guest_user();
904                 }
905                 \core\session\manager::set_user($user);
906             }
907         }
908     }
911 // Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
912 // LogFormat to get the current logged in username in moodle.
913 if ($USER && function_exists('apache_note')
914     && !empty($CFG->apacheloguser) && isset($USER->username)) {
915     $apachelog_userid = $USER->id;
916     $apachelog_username = clean_filename($USER->username);
917     $apachelog_name = '';
918     if (isset($USER->firstname)) {
919         // We can assume both will be set
920         // - even if to empty.
921         $apachelog_name = clean_filename($USER->firstname . " " .
922                                          $USER->lastname);
923     }
924     if (\core\session\manager::is_loggedinas()) {
925         $realuser = \core\session\manager::get_realuser();
926         $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
927         $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
928         $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
929     }
930     switch ($CFG->apacheloguser) {
931         case 3:
932             $logname = $apachelog_username;
933             break;
934         case 2:
935             $logname = $apachelog_name;
936             break;
937         case 1:
938         default:
939             $logname = $apachelog_userid;
940             break;
941     }
942     apache_note('MOODLEUSER', $logname);
945 // Use a custom script replacement if one exists
946 if (!empty($CFG->customscripts)) {
947     if (($customscript = custom_script_path()) !== false) {
948         require ($customscript);
949     }
952 if (PHPUNIT_TEST) {
953     // no ip blocking, these are CLI only
954 } else if (CLI_SCRIPT and !defined('WEB_CRON_EMULATED_CLI')) {
955     // no ip blocking
956 } else if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
957     // in this case, ip in allowed list will be performed first
958     // for example, client IP is 192.168.1.1
959     // 192.168 subnet is an entry in allowed list
960     // 192.168.1.1 is banned in blocked list
961     // This ip will be banned finally
962     if (!empty($CFG->allowedip)) {
963         if (!remoteip_in_list($CFG->allowedip)) {
964             die(get_string('ipblocked', 'admin'));
965         }
966     }
967     // need further check, client ip may a part of
968     // allowed subnet, but a IP address are listed
969     // in blocked list.
970     if (!empty($CFG->blockedip)) {
971         if (remoteip_in_list($CFG->blockedip)) {
972             die(get_string('ipblocked', 'admin'));
973         }
974     }
976 } else {
977     // in this case, IPs in blocked list will be performed first
978     // for example, client IP is 192.168.1.1
979     // 192.168 subnet is an entry in blocked list
980     // 192.168.1.1 is allowed in allowed list
981     // This ip will be allowed finally
982     if (!empty($CFG->blockedip)) {
983         if (remoteip_in_list($CFG->blockedip)) {
984             // if the allowed ip list is not empty
985             // IPs are not included in the allowed list will be
986             // blocked too
987             if (!empty($CFG->allowedip)) {
988                 if (!remoteip_in_list($CFG->allowedip)) {
989                     die(get_string('ipblocked', 'admin'));
990                 }
991             } else {
992                 die(get_string('ipblocked', 'admin'));
993             }
994         }
995     }
996     // if blocked list is null
997     // allowed list should be tested
998     if(!empty($CFG->allowedip)) {
999         if (!remoteip_in_list($CFG->allowedip)) {
1000             die(get_string('ipblocked', 'admin'));
1001         }
1002     }
1006 // // try to detect IE6 and prevent gzip because it is extremely buggy browser
1007 if (!empty($_SERVER['HTTP_USER_AGENT']) and strpos($_SERVER['HTTP_USER_AGENT'], 'MSIE 6') !== false) {
1008     ini_set('zlib.output_compression', 'Off');
1009     if (function_exists('apache_setenv')) {
1010         apache_setenv('no-gzip', 1);
1011     }
1014 // Switch to CLI maintenance mode if required, we need to do it here after all the settings are initialised.
1015 if (isset($CFG->maintenance_later) and $CFG->maintenance_later <= time()) {
1016     if (!file_exists("$CFG->dataroot/climaintenance.html")) {
1017         require_once("$CFG->libdir/adminlib.php");
1018         enable_cli_maintenance_mode();
1019     }
1020     unset_config('maintenance_later');
1021     if (AJAX_SCRIPT) {
1022         die;
1023     } else if (!CLI_SCRIPT) {
1024         redirect(new moodle_url('/'));
1025     }
1028 // note: we can not block non utf-8 installations here, because empty mysql database
1029 // might be converted to utf-8 in admin/index.php during installation
1033 // this is a funny trick to make Eclipse believe that $OUTPUT and other globals
1034 // contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
1035 if (false) {
1036     $DB = new moodle_database();
1037     $OUTPUT = new core_renderer(null, null);
1038     $PAGE = new moodle_page();