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