MDL-24751 simplified use of raise_memory_limit() by introduction of memory use consta...
[moodle.git] / lib / setup.php
CommitLineData
da8759cb 1<?php
b37eac91 2
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/>.
17
da8759cb 18/**
19 * setup.php - Sets up sessions, connects to databases and so on
20 *
75249234 21 * Normally this is only called by the main config.php file
22 * Normally this file does not need to be edited.
b37eac91 23 *
78bfb562
PS
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
da8759cb 28 */
29
da8759cb 30/**
e1d1b796 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:
3b5ff37f
PS
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.
e1d1b796 39 *
40 * @global object $CFG
b37eac91 41 * @name $CFG
e1d1b796 42 */
b30fa335 43global $CFG; // this should be done much earlier in config.php before creating new $CFG instance
e1d1b796 44
fe79c400
PS
45if (!isset($CFG)) {
46 if (defined('PHPUNIT_SCRIPT') and PHPUNIT_SCRIPT) {
47 echo('There is a missing "global $CFG;" at the beginning of the config.php file.'."\n");
48 exit(1);
49 } else {
50 // this should never happen, maybe somebody is accessing this file directly...
51 exit(1);
52 }
53}
54
3b5ff37f
PS
55// We can detect real dirroot path reliably since PHP 4.0.2,
56// it can not be anything else, there is no point in having this in config.php
57$CFG->dirroot = dirname(dirname(__FILE__));
58
59// Normalise dataroot - we do not want any symbolic links, trailing / or any other weirdness there
60if (!isset($CFG->dataroot)) {
56953adc
PS
61 if (isset($_SERVER['REMOTE_ADDR'])) {
62 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
63 }
fe79c400 64 echo('Fatal error: $CFG->dataroot is not specified in config.php! Exiting.'."\n");
3b5ff37f
PS
65 exit(1);
66}
67$CFG->dataroot = realpath($CFG->dataroot);
68if ($CFG->dataroot === false) {
56953adc
PS
69 if (isset($_SERVER['REMOTE_ADDR'])) {
70 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
71 }
fe79c400 72 echo('Fatal error: $CFG->dataroot is not configured properly, directory does not exist or is not accessible! Exiting.'."\n");
3b5ff37f 73 exit(1);
8b2ebe7f
PS
74} else if (!is_writable($CFG->dataroot)) {
75 if (isset($_SERVER['REMOTE_ADDR'])) {
76 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
77 }
78 echo('Fatal error: $CFG->dataroot is not writable, admin has to fix directory permissions! Exiting.'."\n");
79 exit(1);
3b5ff37f
PS
80}
81
82// wwwroot is mandatory
83if (!isset($CFG->wwwroot) or $CFG->wwwroot === 'http://example.com/moodle') {
56953adc
PS
84 if (isset($_SERVER['REMOTE_ADDR'])) {
85 header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
86 }
fe79c400 87 echo('Fatal error: $CFG->wwwroot is not configured! Exiting.'."\n");
3b5ff37f
PS
88 exit(1);
89}
90
91// Define admin directory
92if (!isset($CFG->admin)) { // Just in case it isn't defined in config.php
93 $CFG->admin = 'admin'; // This is relative to the wwwroot and dirroot
94}
95
60f2c866
PS
96// Set up some paths.
97$CFG->libdir = $CFG->dirroot .'/lib';
98
3b5ff37f
PS
99// The current directory in PHP version 4.3.0 and above isn't necessarily the
100// directory of the script when run from the command line. The require_once()
101// would fail, so we'll have to chdir()
102if (!isset($_SERVER['REMOTE_ADDR']) && isset($_SERVER['argv'][0])) {
103 chdir(dirname($_SERVER['argv'][0]));
104}
105
106// sometimes default PHP settings are borked on shared hosting servers, I wonder why they have to do that??
107@ini_set('precision', 14); // needed for upgrades and gradebook
108
109// Scripts may request no debug and error messages in output
110// please note it must be defined before including the config.php script
111// and in some cases you also need to set custom default exception handler
112if (!defined('NO_DEBUG_DISPLAY')) {
113 define('NO_DEBUG_DISPLAY', false);
114}
115
62c5e654
MD
116// Servers should define a default timezone in php.ini, but if they don't then make sure something is defined.
117// This is a quick hack. Ideally we should ask the admin for a value. See MDL-22625 for more on this.
177b5480
PS
118if (function_exists('date_default_timezone_set') and function_exists('date_default_timezone_get')) {
119 @date_default_timezone_set(@date_default_timezone_get());
62c5e654
MD
120}
121
1e36599b
PS
122// PHPUnit scripts are a special case, for now we treat them as normal CLI scripts,
123// please note you must install PHPUnit library separately via PEAR
124if (!defined('PHPUNIT_SCRIPT')) {
125 define('PHPUNIT_SCRIPT', false);
126}
127if (PHPUNIT_SCRIPT) {
128 define('CLI_SCRIPT', true);
129}
130
3b5ff37f 131// Detect CLI scripts - CLI scripts are executed from command line, do not have session and we do not want HTML in output
28bd3d9a
PS
132// In your new CLI scripts just add "define('CLI_SCRIPT', true);" before requiring config.php.
133// Please note that one script can not be accessed from both CLI and web interface.
3b5ff37f 134if (!defined('CLI_SCRIPT')) {
28bd3d9a
PS
135 define('CLI_SCRIPT', false);
136}
137if (defined('WEB_CRON_EMULATED_CLI')) {
138 if (!isset($_SERVER['REMOTE_ADDR'])) {
139 echo('Web cron can not be executed as CLI script any more, please use admin/cli/cron.php instead'."\n");
140 exit(1);
141 }
142} else if (isset($_SERVER['REMOTE_ADDR'])) {
143 if (CLI_SCRIPT) {
144 echo('Command line scripts can not be executed from the web interface');
145 exit(1);
146 }
147} else {
148 if (!CLI_SCRIPT) {
149 echo('Command line scripts must define CLI_SCRIPT before requiring config.php'."\n");
150 exit(1);
3b5ff37f
PS
151 }
152}
153
8820f4e7
PS
154// Detect CLI maintenance mode - this is useful when you need to mess with database, such as during upgrades
155if (file_exists("$CFG->dataroot/climaintenance.html")) {
156 if (!CLI_SCRIPT) {
157 @header('Content-type: text/html');
158 /// Headers to make it not cacheable and json
159 @header('Cache-Control: no-store, no-cache, must-revalidate');
160 @header('Cache-Control: post-check=0, pre-check=0', false);
161 @header('Pragma: no-cache');
162 @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
163 @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
164 @header('Accept-Ranges: none');
165 readfile("$CFG->dataroot/climaintenance.html");
166 die;
167 } else {
e4c05ec7
PS
168 if (!defined('CLI_MAINTENANCE')) {
169 define('CLI_MAINTENANCE', true);
170 }
8820f4e7
PS
171 }
172} else {
e4c05ec7
PS
173 if (!defined('CLI_MAINTENANCE')) {
174 define('CLI_MAINTENANCE', false);
175 }
8820f4e7
PS
176}
177
3b5ff37f
PS
178// Detect ajax scripts - they are similar to CLI because we can not redirect, output html, etc.
179if (!defined('AJAX_SCRIPT')) {
180 define('AJAX_SCRIPT', false);
181}
182
4cee2155
PS
183// File permissions on created directories in the $CFG->dataroot
184if (empty($CFG->directorypermissions)) {
185 $CFG->directorypermissions = 02777; // Must be octal (that's why it's here)
186}
187if (empty($CFG->filepermissions)) {
188 $CFG->filepermissions = ($CFG->directorypermissions & 0666); // strip execute flags
189}
190// better also set default umask because recursive mkdir() does not apply permissions recursively otherwise
191umask(0000);
192
60f2c866 193// exact version of currently used yui2 and 3 library
c595847d 194$CFG->yui2version = '2.8.1';
d543cc3c 195$CFG->yui3version = '3.2.0';
60f2c866 196
3b5ff37f 197
60f2c866
PS
198// special support for highly optimised scripts that do not need libraries and DB connection
199if (defined('ABORT_AFTER_CONFIG')) {
200 if (!defined('ABORT_AFTER_CONFIG_CANCEL')) {
0037dcc9
PS
201 // hide debugging if not enabled in config.php - we do not want to disclose sensitive info
202 if (isset($CFG->debug)) {
203 error_reporting($CFG->debug);
204 } else {
205 error_reporting(0);
206 }
207 if (empty($CFG->debugdisplay)) {
208 @ini_set('display_errors', '0');
209 @ini_set('log_errors', '1');
210 } else {
211 @ini_set('display_errors', '1');
212 }
60f2c866
PS
213 require_once("$CFG->dirroot/lib/configonlylib.php");
214 return;
215 }
216}
217
460ebd6c 218/** Used by library scripts to check they are being called by Moodle */
26f073ff
PS
219if (!defined('MOODLE_INTERNAL')) { // necessary because cli installer has to define it earlier
220 define('MOODLE_INTERNAL', true);
221}
1a3993c1 222
e1d1b796 223/**
224 * Database connection. Used for all access to the database.
225 * @global moodle_database $DB
b37eac91 226 * @name $DB
e1d1b796 227 */
228global $DB;
229
230/**
231 * Moodle's wrapper round PHP's $_SESSION.
232 *
233 * @global object $SESSION
b37eac91 234 * @name $SESSION
e1d1b796 235 */
236global $SESSION;
237
238/**
239 * Holds the user table record for the current user. Will be the 'guest'
240 * user record for people who are not logged in.
241 *
242 * $USER is stored in the session.
da8759cb 243 *
735b8567 244 * Items found in the user record:
da8759cb 245 * - $USER->emailstop - Does the user want email sent to them?
246 * - $USER->email - The user's email address.
247 * - $USER->id - The unique integer identified of this user in the 'user' table.
248 * - $USER->email - The user's email address.
249 * - $USER->firstname - The user's first name.
250 * - $USER->lastname - The user's last name.
251 * - $USER->username - The user's login username.
252 * - $USER->secret - The user's ?.
253 * - $USER->lang - The user's language choice.
254 *
e1d1b796 255 * @global object $USER
b37eac91 256 * @name $USER
da8759cb 257 */
674fb525 258global $USER;
e1d1b796 259
c13a5e71 260/**
261 * A central store of information about the current page we are
262 * generating in response to the user's request.
263 *
264 * @global moodle_page $PAGE
b37eac91 265 * @name $PAGE
c13a5e71 266 */
267global $PAGE;
268
da8759cb 269/**
e1d1b796 270 * The current course. An alias for $PAGE->course.
271 * @global object $COURSE
b37eac91 272 * @name $COURSE
da8759cb 273 */
274global $COURSE;
e1d1b796 275
da8759cb 276/**
78946b9b 277 * $OUTPUT is an instance of core_renderer or one of its subclasses. Use
34a2777c 278 * it to generate HTML for output.
da8759cb 279 *
c84a2dbe 280 * $OUTPUT is initialised the first time it is used. See {@link bootstrap_renderer}
281 * for the magic that does that. After $OUTPUT has been initialised, any attempt
282 * to change something that affects the current theme ($PAGE->course, logged in use,
283 * httpsrequried ... will result in an exception.)
34a2777c 284 *
cbcc9852
PS
285 * Please note the $OUTPUT is replacing the old global $THEME object.
286 *
34a2777c 287 * @global object $OUTPUT
288 * @name $OUTPUT
289 */
290global $OUTPUT;
291
9d0dd812 292/**
e1d1b796 293 * Shared memory cache.
294 * @global object $MCACHE
b37eac91 295 * @name $MCACHE
e1d1b796 296 */
297global $MCACHE;
298
b37eac91 299/**
300 * Full script path including all params, slash arguments, scheme and host.
301 * @global string $FULLME
302 * @name $FULLME
303 */
11e7b506 304global $FULLME;
e1d1b796 305
b37eac91 306/**
307 * Script path including query string and slash arguments without host.
308 * @global string $ME
309 * @name $ME
310 */
11e7b506 311global $ME;
e1d1b796 312
b37eac91 313/**
314 * $FULLME without slasharguments and query string.
315 * @global string $FULLSCRIPT
316 * @name $FULLSCRIPT
317 */
11e7b506 318global $FULLSCRIPT;
e1d1b796 319
b37eac91 320/**
321 * Relative moodle script path '/course/view.php'
322 * @global string $SCRIPT
323 * @name $SCRIPT
324 */
11e7b506 325global $SCRIPT;
9d0dd812 326
4dffc775
PS
327// Store settings from config.php in array in $CFG - we can use it later to detect problems and overrides
328$CFG->config_php_settings = (array)$CFG;
12bb0c3e
PS
329// Forced plugin settings override values from config_plugins table
330unset($CFG->config_php_settings['forced_plugin_settings']);
331if (!isset($CFG->forced_plugin_settings)) {
332 $CFG->forced_plugin_settings = array();
333}
4dffc775
PS
334// Set httpswwwroot default value (this variable will replace $CFG->wwwroot
335// inside some URLs used in HTTPSPAGEREQUIRED pages.
336$CFG->httpswwwroot = $CFG->wwwroot;
d3f9f1f8 337
4dffc775 338require_once($CFG->libdir .'/setuplib.php'); // Functions that MUST be loaded first
17da2e6f 339
0f0f0768
PS
340// Increase memory limits if possible
341raise_memory_limit(MEMORY_STANDARD);
342
4dffc775
PS
343// Time to start counting
344init_performance_info();
b7009474 345
4dffc775
PS
346// Put $OUTPUT in place, so errors can be displayed.
347$OUTPUT = new bootstrap_renderer();
9d0dd812 348
4c1c9175 349// set handler for uncaught exceptions - equivalent to print_error() call
4dffc775 350set_exception_handler('default_exception_handler');
85ba1e78 351set_error_handler('default_error_handler', E_ALL | E_STRICT);
6800d78e 352
4dffc775
PS
353// If there are any errors in the standard libraries we want to know!
354error_reporting(E_ALL);
c84a2dbe 355
4dffc775
PS
356// Just say no to link prefetching (Moz prefetching, Google Web Accelerator, others)
357// http://www.google.com/webmasters/faq.html#prefetchblock
358if (!empty($_SERVER['HTTP_X_moz']) && $_SERVER['HTTP_X_moz'] === 'prefetch'){
359 header($_SERVER['SERVER_PROTOCOL'] . ' 404 Prefetch Forbidden');
360 echo('Prefetch request forbidden.');
361 exit(1);
362}
b8cea9b2 363
4dffc775
PS
364if (!isset($CFG->prefix)) { // Just in case it isn't defined in config.php
365 $CFG->prefix = '';
366}
d7196099 367
38c253f9
PS
368// location of all languages except core English pack
369if (!isset($CFG->langotherroot)) {
370 $CFG->langotherroot = $CFG->dataroot.'/lang';
371}
372
373// location of local lang pack customisations (dirs with _local suffix)
374if (!isset($CFG->langlocalroot)) {
375 $CFG->langlocalroot = $CFG->dataroot.'/lang';
376}
377
3d732d84
EL
378//point pear include path to moodles lib/pear so that includes and requires will search there for files before anywhere else
379//the problem is that we need specific version of quickforms and hacked excel files :-(
380ini_set('include_path', $CFG->libdir.'/pear' . PATH_SEPARATOR . ini_get('include_path'));
381//point zend include path to moodles lib/zend so that includes and requires will search there for files before anywhere else
382//please note zend library is supposed to be used only from web service protocol classes, it may be removed in future
383ini_set('include_path', $CFG->libdir.'/zend' . PATH_SEPARATOR . ini_get('include_path'));
384
4dffc775
PS
385// Load up standard libraries
386require_once($CFG->libdir .'/textlib.class.php'); // Functions to handle multibyte strings
387require_once($CFG->libdir .'/filterlib.php'); // Functions for filtering test as it is output
388require_once($CFG->libdir .'/ajax/ajaxlib.php'); // Functions for managing our use of JavaScript and YUI
389require_once($CFG->libdir .'/weblib.php'); // Functions relating to HTTP and content
390require_once($CFG->libdir .'/outputlib.php'); // Functions for generating output
391require_once($CFG->libdir .'/navigationlib.php'); // Class for generating Navigation structure
392require_once($CFG->libdir .'/dmllib.php'); // Database access
393require_once($CFG->libdir .'/datalib.php'); // Legacy lib with a big-mix of functions.
394require_once($CFG->libdir .'/accesslib.php'); // Access control functions
395require_once($CFG->libdir .'/deprecatedlib.php'); // Deprecated functions included for backward compatibility
396require_once($CFG->libdir .'/moodlelib.php'); // Other general-purpose functions
df997f84 397require_once($CFG->libdir .'/enrollib.php'); // Enrolment related functions
4dffc775
PS
398require_once($CFG->libdir .'/pagelib.php'); // Library that defines the moodle_page class, used for $PAGE
399require_once($CFG->libdir .'/blocklib.php'); // Library for controlling blocks
400require_once($CFG->libdir .'/eventslib.php'); // Events functions
401require_once($CFG->libdir .'/grouplib.php'); // Groups functions
402require_once($CFG->libdir .'/sessionlib.php'); // All session and cookie related stuff
403require_once($CFG->libdir .'/editorlib.php'); // All text editor related functions and classes
7c7d3afa 404require_once($CFG->libdir .'/messagelib.php'); // Messagelib functions
4dffc775 405
4dffc775
PS
406// make sure PHP is not severly misconfigured
407setup_validate_php_configuration();
408
4dffc775
PS
409// Connect to the database
410setup_DB();
411
412// Disable errors for now - needed for installation when debug enabled in config.php
413if (isset($CFG->debug)) {
414 $originalconfigdebug = $CFG->debug;
415 unset($CFG->debug);
416} else {
417 $originalconfigdebug = -1;
418}
dae73c05 419
4dffc775 420// Load up any configuration from the config table
12bb0c3e 421initialise_cfg();
a8a71844 422
4dffc775
PS
423// Verify upgrade is not running unless we are in a script that needs to execute in any case
424if (!defined('NO_UPGRADE_CHECK') and isset($CFG->upgraderunning)) {
425 if ($CFG->upgraderunning < time()) {
426 unset_config('upgraderunning');
aa893d6b 427 } else {
4dffc775 428 print_error('upgraderunning');
aa893d6b 429 }
4dffc775 430}
aa893d6b 431
4dffc775
PS
432// Turn on SQL logging if required
433if (!empty($CFG->logsql)) {
434 $DB->set_logging(true);
435}
f9903ed0 436
4dffc775
PS
437// Prevent warnings from roles when upgrading with debug on
438if (isset($CFG->debug)) {
439 $originaldatabasedebug = $CFG->debug;
440 unset($CFG->debug);
441} else {
442 $originaldatabasedebug = -1;
443}
775f811a 444
c7b0e5e1
PS
445// enable circular reference collector in PHP 5.3,
446// it helps a lot when using large complex OOP structures such as in amos or gradebook
447if (function_exists('gc_enable')) {
448 gc_enable();
449}
1e3e716f 450
4dffc775
PS
451// For now, only needed under apache (and probably unstable in other contexts)
452if (function_exists('register_shutdown_function')) {
453 register_shutdown_function('moodle_request_shutdown');
454}
4fd7ccc0 455
4dffc775
PS
456// Defining the site
457try {
458 $SITE = get_site();
4dffc775
PS
459 /**
460 * If $SITE global from {@link get_site()} is set then SITEID to $SITE->id, otherwise set to 1.
461 */
462 define('SITEID', $SITE->id);
7b51fb61
PS
463 // And the 'default' course - this will usually get reset later in require_login() etc.
464 $COURSE = clone($SITE);
465} catch (dml_read_exception $e) {
466 $SITE = null;
467 if (empty($CFG->version)) {
468 // we are just installing
469 /**
470 * @ignore
471 */
472 define('SITEID', 1);
473 // And the 'default' course
365a5941 474 $COURSE = new stdClass(); // no site created yet
7b51fb61
PS
475 $COURSE->id = 1;
476 } else {
477 throw $e;
478 }
4dffc775 479}
cf8133c4 480
4dffc775
PS
481// define SYSCONTEXTID in config.php if you want to save some queries (after install or upgrade!)
482if (!defined('SYSCONTEXTID')) {
483 get_system_context();
484}
c23b0ea1 485
4dffc775
PS
486// Set error reporting back to normal
487if ($originaldatabasedebug == -1) {
488 $CFG->debug = DEBUG_MINIMAL;
489} else {
490 $CFG->debug = $originaldatabasedebug;
491}
492if ($originalconfigdebug !== -1) {
493 $CFG->debug = $originalconfigdebug;
494}
495unset($originalconfigdebug);
496unset($originaldatabasedebug);
497error_reporting($CFG->debug);
498
12bb0c3e 499// find out if PHP configured to display warnings,
4dffc775
PS
500// this is a security problem because some moodle scripts may
501// disclose sensitive information
502if (ini_get_bool('display_errors')) {
503 define('WARN_DISPLAY_ERRORS_ENABLED', true);
504}
505// If we want to display Moodle errors, then try and set PHP errors to match
506if (!isset($CFG->debugdisplay)) {
507 // keep it "as is" during installation
508} else if (NO_DEBUG_DISPLAY) {
509 // some parts of Moodle cannot display errors and debug at all.
510 @ini_set('display_errors', '0');
511 @ini_set('log_errors', '1');
512} else if (empty($CFG->debugdisplay)) {
513 @ini_set('display_errors', '0');
514 @ini_set('log_errors', '1');
515} else {
516 // This is very problematic in XHTML strict mode!
517 @ini_set('display_errors', '1');
518}
475e9de8 519
4dffc775
PS
520// detect unsupported upgrade jump as soon as possible - do not change anything, do not use system functions
521if (!empty($CFG->version) and $CFG->version < 2007101509) {
522 print_error('upgraderequires19', 'error');
523 die;
524}
475e9de8 525
4dffc775
PS
526// Shared-Memory cache init -- will set $MCACHE
527// $MCACHE is a global object that offers at least add(), set() and delete()
528// with similar semantics to the memcached PHP API http://php.net/memcache
529// Ensure we define rcache - so we can later check for it
530// with a really fast and unambiguous $CFG->rcache === false
531if (!empty($CFG->cachetype)) {
532 if (empty($CFG->rcache)) {
533 $CFG->rcache = false;
25338300 534 } else {
4dffc775 535 $CFG->rcache = true;
25338300 536 }
537
4dffc775
PS
538 // do not try to initialize if cache disabled
539 if (!$CFG->rcache) {
540 $CFG->cachetype = '';
f9955801 541 }
542
4dffc775
PS
543 if ($CFG->cachetype === 'memcached' && !empty($CFG->memcachedhosts)) {
544 if (!init_memcached()) {
545 debugging("Error initialising memcached");
546 $CFG->cachetype = '';
392e7363 547 $CFG->rcache = false;
392e7363 548 }
4dffc775
PS
549 } else if ($CFG->cachetype === 'eaccelerator') {
550 if (!init_eaccelerator()) {
551 debugging("Error initialising eaccelerator cache");
392e7363 552 $CFG->cachetype = '';
4dffc775 553 $CFG->rcache = false;
392e7363 554 }
2142d492 555 }
aa893d6b 556
4dffc775
PS
557} else { // just make sure it is defined
558 $CFG->cachetype = '';
559 $CFG->rcache = false;
560}
0182c65c 561
4dffc775
PS
562// Calculate and set $CFG->ostype to be used everywhere. Possible values are:
563// - WINDOWS: for any Windows flavour.
564// - UNIX: for the rest
565// Also, $CFG->os can continue being used if more specialization is required
566if (stristr(PHP_OS, 'win') && !stristr(PHP_OS, 'darwin')) {
567 $CFG->ostype = 'WINDOWS';
568} else {
569 $CFG->ostype = 'UNIX';
570}
571$CFG->os = PHP_OS;
820743c5 572
4dffc775
PS
573// Configure ampersands in URLs
574@ini_set('arg_separator.output', '&amp;');
de7e4ac9 575
4dffc775
PS
576// Work around for a PHP bug see MDL-11237
577@ini_set('pcre.backtrack_limit', 20971520); // 20 MB
e7aa5a88 578
4dffc775 579// Location of standard files
4c1c9175
PS
580$CFG->wordlist = $CFG->libdir .'/wordlist.txt';
581$CFG->moddata = 'moddata';
f9903ed0 582
4dffc775
PS
583// Create the $PAGE global.
584if (!empty($CFG->moodlepageclass)) {
585 $classname = $CFG->moodlepageclass;
586} else {
587 $classname = 'moodle_page';
588}
589$PAGE = new $classname();
590unset($classname);
591
592// A hack to get around magic_quotes_gpc being turned on
593// It is strongly recommended to disable "magic_quotes_gpc"!
594if (ini_get_bool('magic_quotes_gpc')) {
595 function stripslashes_deep($value) {
596 $value = is_array($value) ?
597 array_map('stripslashes_deep', $value) :
598 stripslashes($value);
599 return $value;
c84a2dbe 600 }
4dffc775
PS
601 $_POST = array_map('stripslashes_deep', $_POST);
602 $_GET = array_map('stripslashes_deep', $_GET);
603 $_COOKIE = array_map('stripslashes_deep', $_COOKIE);
604 $_REQUEST = array_map('stripslashes_deep', $_REQUEST);
605 if (!empty($_SERVER['REQUEST_URI'])) {
606 $_SERVER['REQUEST_URI'] = stripslashes($_SERVER['REQUEST_URI']);
f98cfb53 607 }
4dffc775
PS
608 if (!empty($_SERVER['QUERY_STRING'])) {
609 $_SERVER['QUERY_STRING'] = stripslashes($_SERVER['QUERY_STRING']);
610 }
611 if (!empty($_SERVER['HTTP_REFERER'])) {
612 $_SERVER['HTTP_REFERER'] = stripslashes($_SERVER['HTTP_REFERER']);
aa6af0f8 613 }
4dffc775
PS
614 if (!empty($_SERVER['PATH_INFO'])) {
615 $_SERVER['PATH_INFO'] = stripslashes($_SERVER['PATH_INFO']);
616 }
617 if (!empty($_SERVER['PHP_SELF'])) {
618 $_SERVER['PHP_SELF'] = stripslashes($_SERVER['PHP_SELF']);
619 }
620 if (!empty($_SERVER['PATH_TRANSLATED'])) {
621 $_SERVER['PATH_TRANSLATED'] = stripslashes($_SERVER['PATH_TRANSLATED']);
622 }
623}
7a302afc 624
4dffc775
PS
625// neutralise nasty chars in PHP_SELF
626if (isset($_SERVER['PHP_SELF'])) {
627 $phppos = strpos($_SERVER['PHP_SELF'], '.php');
628 if ($phppos !== false) {
629 $_SERVER['PHP_SELF'] = substr($_SERVER['PHP_SELF'], 0, $phppos+4);
18b9d664 630 }
4dffc775
PS
631 unset($phppos);
632}
633
634// initialise ME's
635initialise_fullme();
636
df92ba9a
PS
637
638// init session prevention flag - this is defined on pages that do not want session
28bd3d9a
PS
639if (CLI_SCRIPT) {
640 // no sessions in CLI scripts possible
641 define('NO_MOODLE_COOKIES', true);
642
643} else if (!defined('NO_MOODLE_COOKIES')) {
df92ba9a
PS
644 if (empty($CFG->version) or $CFG->version < 2009011900) {
645 // no session before sessions table gets created
646 define('NO_MOODLE_COOKIES', true);
647 } else if (CLI_SCRIPT) {
648 // CLI scripts can not have session
649 define('NO_MOODLE_COOKIES', true);
650 } else {
651 define('NO_MOODLE_COOKIES', false);
652 }
653}
654
4dffc775
PS
655// start session and prepare global $SESSION, $USER
656session_get_instance();
657$SESSION = &$_SESSION['SESSION'];
658$USER = &$_SESSION['USER'];
18b9d664 659
4dffc775 660// Process theme change in the URL.
998999e7
PS
661if (!empty($CFG->allowthemechangeonurl) and !empty($_GET['theme'])) {
662 // we have to use _GET directly because we do not want this to interfere with _POST
663 $urlthemename = optional_param('theme', '', PARAM_SAFEDIR);
4dffc775 664 try {
998999e7
PS
665 $themeconfig = theme_config::load($urlthemename);
666 // Makes sure the theme can be loaded without errors.
667 if ($themeconfig->name === $urlthemename) {
668 $SESSION->theme = $urlthemename;
669 } else {
670 unset($SESSION->theme);
671 }
672 unset($themeconfig);
673 unset($urlthemename);
4dffc775
PS
674 } catch (Exception $e) {
675 debugging('Failed to set the theme from the URL.', DEBUG_DEVELOPER, $e->getTrace());
18b9d664 676 }
4dffc775
PS
677}
678unset($urlthemename);
18b9d664 679
4dffc775
PS
680// Ensure a valid theme is set.
681if (!isset($CFG->theme)) {
682 $CFG->theme = 'standardwhite';
683}
684
685// Set language/locale of printed times. If user has chosen a language that
686// that is different from the site language, then use the locale specified
687// in the language file. Otherwise, if the admin hasn't specified a locale
688// then use the one from the default language. Otherwise (and this is the
689// majority of cases), use the stored locale specified by admin.
4000129f
PS
690// note: do not accept lang parameter from POST
691if (isset($_GET['lang']) and ($lang = optional_param('lang', '', PARAM_SAFEDIR))) {
ecd7978c 692 if (get_string_manager()->translation_exists($lang, false)) {
4dffc775 693 $SESSION->lang = $lang;
3e9b5d5a 694 }
4dffc775
PS
695}
696unset($lang);
ab036ed9 697
4dffc775 698setup_lang_from_browser();
ab036ed9 699
4dffc775
PS
700if (empty($CFG->lang)) {
701 if (empty($SESSION->lang)) {
3a915b06 702 $CFG->lang = 'en';
4dffc775
PS
703 } else {
704 $CFG->lang = $SESSION->lang;
16ba7351 705 }
4dffc775 706}
6800d78e 707
00dadbe1
PS
708// Set the default site locale, a lot of the stuff may depend on this
709// it is definitely too late to call this first in require_login()!
710moodle_setlocale();
4dffc775
PS
711
712if (!empty($CFG->debugvalidators) and !empty($CFG->guestloginbutton)) {
713 if ($CFG->theme == 'standard' or $CFG->theme == 'standardwhite') { // Temporary measure to help with XHTML validation
714 if (isset($_SERVER['HTTP_USER_AGENT']) and empty($USER->id)) { // Allow W3CValidator in as user called w3cvalidator (or guest)
715 if ((strpos($_SERVER['HTTP_USER_AGENT'], 'W3C_Validator') !== false) or
716 (strpos($_SERVER['HTTP_USER_AGENT'], 'Cynthia') !== false )) {
717 if ($user = get_complete_user_data("username", "w3cvalidator")) {
718 $user->ignoresesskey = true;
719 } else {
720 $user = guest_user();
9610a66e 721 }
4dffc775 722 session_set_user($user);
9610a66e 723 }
724 }
725 }
4dffc775 726}
9610a66e 727
4c1c9175 728// Apache log integration. In apache conf file one can use ${MOODULEUSER}n in
4dffc775
PS
729// LogFormat to get the current logged in username in moodle.
730if ($USER && function_exists('apache_note')
731 && !empty($CFG->apacheloguser) && isset($USER->username)) {
732 $apachelog_userid = $USER->id;
733 $apachelog_username = clean_filename($USER->username);
734 $apachelog_name = '';
735 if (isset($USER->firstname)) {
736 // We can assume both will be set
737 // - even if to empty.
738 $apachelog_name = clean_filename($USER->firstname . " " .
739 $USER->lastname);
740 }
741 if (session_is_loggedinas()) {
742 $realuser = session_get_realuser();
743 $apachelog_username = clean_filename($realuser->username." as ".$apachelog_username);
744 $apachelog_name = clean_filename($realuser->firstname." ".$realuser->lastname ." as ".$apachelog_name);
745 $apachelog_userid = clean_filename($realuser->id." as ".$apachelog_userid);
746 }
747 switch ($CFG->apacheloguser) {
748 case 3:
749 $logname = $apachelog_username;
750 break;
751 case 2:
752 $logname = $apachelog_name;
753 break;
754 case 1:
755 default:
756 $logname = $apachelog_userid;
757 break;
758 }
759 apache_note('MOODLEUSER', $logname);
760}
a559eee6 761
4dffc775
PS
762// Adjust ALLOWED_TAGS
763adjust_allowed_tags();
5982740d 764
4dffc775
PS
765// Use a custom script replacement if one exists
766if (!empty($CFG->customscripts)) {
767 if (($customscript = custom_script_path()) !== false) {
768 require ($customscript);
18259d4f 769 }
4dffc775 770}
18259d4f 771
4dffc775
PS
772// in the first case, ip in allowed list will be performed first
773// for example, client IP is 192.168.1.1
774// 192.168 subnet is an entry in allowed list
775// 192.168.1.1 is banned in blocked list
776// This ip will be banned finally
777if (!empty($CFG->allowbeforeblock)) { // allowed list processed before blocked list?
778 if (!empty($CFG->allowedip)) {
779 if (!remoteip_in_list($CFG->allowedip)) {
780 die(get_string('ipblocked', 'admin'));
ab99c8f0 781 }
4dffc775
PS
782 }
783 // need further check, client ip may a part of
784 // allowed subnet, but a IP address are listed
785 // in blocked list.
786 if (!empty($CFG->blockedip)) {
787 if (remoteip_in_list($CFG->blockedip)) {
788 die(get_string('ipblocked', 'admin'));
5035228f 789 }
4dffc775 790 }
d255c6e9 791
4dffc775
PS
792} else {
793 // in this case, IPs in blocked list will be performed first
794 // for example, client IP is 192.168.1.1
795 // 192.168 subnet is an entry in blocked list
796 // 192.168.1.1 is allowed in allowed list
797 // This ip will be allowed finally
798 if (!empty($CFG->blockedip)) {
799 if (remoteip_in_list($CFG->blockedip)) {
800 // if the allowed ip list is not empty
801 // IPs are not included in the allowed list will be
802 // blocked too
803 if (!empty($CFG->allowedip)) {
804 if (!remoteip_in_list($CFG->allowedip)) {
d255c6e9 805 die(get_string('ipblocked', 'admin'));
806 }
4dffc775 807 } else {
d255c6e9 808 die(get_string('ipblocked', 'admin'));
809 }
5035228f 810 }
4dffc775
PS
811 }
812 // if blocked list is null
813 // allowed list should be tested
814 if(!empty($CFG->allowedip)) {
815 if (!remoteip_in_list($CFG->allowedip)) {
816 die(get_string('ipblocked', 'admin'));
817 }
ab99c8f0 818 }
819
4dffc775 820}
092bfaf1 821
4dffc775
PS
822// note: we can not block non utf-8 installations here, because empty mysql database
823// might be converted to utf-8 in admin/index.php during installation
d5fac1cf
PS
824
825
826
827// this is a funny trick to make Eclipse believe that $OUTPUT and other globals
828// contains an instance of core_renderer, etc. which in turn fixes autocompletion ;-)
829if (false) {
830 $DB = new moodle_database();
831 $OUTPUT = new core_renderer(null, null);
832 $PAGE = new moodle_page();
833}