MDL-24419: redirect_if_major_upgrade_required version update
[moodle.git] / lib / setuplib.php
CommitLineData
b37eac91 1<?php
b37eac91 2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
b37eac91 17/**
18 * These functions are required very early in the Moodle
19 * setup process, before any of the main libraries are
20 * loaded.
30fa50d0 21 *
78bfb562
PS
22 * @package core
23 * @subpackage lib
24 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
b37eac91 26 */
d3f9f1f8 27
78bfb562
PS
28defined('MOODLE_INTERNAL') || die();
29
e63f95d7
PS
30// Debug levels - always keep the values in ascending order!
31/** No warnings and errors at all */
0f0f0768 32define('DEBUG_NONE', 0);
e63f95d7
PS
33/** Fatal errors only */
34define('DEBUG_MINIMAL', E_ERROR | E_PARSE);
35/** Errors, warnings and notices */
36define('DEBUG_NORMAL', E_ERROR | E_PARSE | E_WARNING | E_NOTICE);
37/** All problems except strict PHP warnings */
38define('DEBUG_ALL', E_ALL & ~E_STRICT);
39/** DEBUG_ALL with all debug messages and strict warnings */
40define('DEBUG_DEVELOPER', E_ALL | E_STRICT);
0f0f0768
PS
41
42/** Remove any memory limits */
43define('MEMORY_UNLIMITED', -1);
44/** Standard memory limit for given platform */
45define('MEMORY_STANDARD', -2);
46/**
47 * Large memory limit for given platform - used in cron, upgrade, and other places that need a lot of memory.
48 * Can be overridden with $CFG->extramemorylimit setting.
49 */
50define('MEMORY_EXTRA', -3);
51/** Extremely large memory limit - not recommended for standard scripts */
52define('MEMORY_HUGE', -4);
c84a2dbe 53
3d673fc4
DM
54/**
55 * Software maturity levels used by the core and plugins
56 */
57define('MATURITY_ALPHA', 50); // internals can be tested using white box techniques
58define('MATURITY_BETA', 100); // feature complete, ready for preview and testing
59define('MATURITY_RC', 150); // tested, will be released unless there are fatal bugs
60define('MATURITY_STABLE', 200); // ready for production deployment
61
0242bdc7
TH
62/**
63 * Special value that can be used in $plugin->dependencies in version.php files.
64 */
65define('ANY_VERSION', 'any');
66
67
6a525ce2 68/**
b08b3569 69 * Simple class. It is usually used instead of stdClass because it looks
1387fcdd 70 * more familiar to Java developers ;-) Do not use for type checking of
4f92410f 71 * function parameters. Please use stdClass instead.
b37eac91 72 *
47d2216e
PS
73 * @package core
74 * @subpackage lib
75 * @copyright 2009 Petr Skoda {@link http://skodak.org}
76 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
4f92410f 77 * @deprecated since 2.0
6a525ce2 78 */
b08b3569 79class object extends stdClass {};
6a525ce2 80
251387d0 81/**
82 * Base Moodle Exception class
b37eac91 83 *
c84a2dbe 84 * Although this class is defined here, you cannot throw a moodle_exception until
85 * after moodlelib.php has been included (which will happen very soon).
86 *
47d2216e
PS
87 * @package core
88 * @subpackage lib
89 * @copyright 2008 Petr Skoda {@link http://skodak.org}
90 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
251387d0 91 */
92class moodle_exception extends Exception {
34223e03
SH
93
94 /**
95 * @var string The name of the string from error.php to print
96 */
251387d0 97 public $errorcode;
34223e03
SH
98
99 /**
100 * @var string The name of module
101 */
251387d0 102 public $module;
34223e03
SH
103
104 /**
105 * @var mixed Extra words and phrases that might be required in the error string
106 */
251387d0 107 public $a;
34223e03
SH
108
109 /**
110 * @var string The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
111 */
251387d0 112 public $link;
34223e03
SH
113
114 /**
115 * @var string Optional information to aid the debugging process
116 */
eee5d9bb 117 public $debuginfo;
251387d0 118
119 /**
120 * Constructor
121 * @param string $errorcode The name of the string from error.php to print
122 * @param string $module name of module
123 * @param string $link The url where the user will be prompted to continue. If no url is provided the user will be directed to the site index page.
34223e03 124 * @param mixed $a Extra words and phrases that might be required in the error string
eee5d9bb 125 * @param string $debuginfo optional debugging information
251387d0 126 */
5ca18631 127 function __construct($errorcode, $module='', $link='', $a=NULL, $debuginfo=null) {
128 if (empty($module) || $module == 'moodle' || $module == 'core') {
251387d0 129 $module = 'error';
130 }
131
5ca18631 132 $this->errorcode = $errorcode;
133 $this->module = $module;
134 $this->link = $link;
135 $this->a = $a;
136 $this->debuginfo = $debuginfo;
251387d0 137
4f6be42c
DM
138 if (get_string_manager()->string_exists($errorcode, $module)) {
139 $message = get_string($errorcode, $module, $a);
140 } else {
141 $message = $module . '/' . $errorcode;
142 }
251387d0 143
94a994b4 144 if (defined('PHPUNIT_TEST') and PHPUNIT_TEST and $debuginfo) {
a3d5830a
PS
145 $message = "$message ($debuginfo)";
146 }
147
251387d0 148 parent::__construct($message, 0);
149 }
150}
151
df997f84
PS
152/**
153 * Course/activity access exception.
154 *
155 * This exception is thrown from require_login()
47d2216e 156 *
f76249cc 157 * @package core_access
47d2216e
PS
158 * @copyright 2010 Petr Skoda {@link http://skodak.org}
159 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
df997f84
PS
160 */
161class require_login_exception extends moodle_exception {
34223e03
SH
162 /**
163 * Constructor
164 * @param string $debuginfo Information to aid the debugging process
165 */
df997f84
PS
166 function __construct($debuginfo) {
167 parent::__construct('requireloginerror', 'error', '', NULL, $debuginfo);
168 }
169}
170
559a5dbd 171/**
172 * Web service parameter exception class
92fe97f9 173 * @deprecated since Moodle 2.2 - use moodle exception instead
559a5dbd 174 * This exception must be thrown to the web service client when a web service parameter is invalid
175 * The error string is gotten from webservice.php
176 */
177class webservice_parameter_exception extends moodle_exception {
178 /**
179 * Constructor
180 * @param string $errorcode The name of the string from webservice.php to print
181 * @param string $a The name of the parameter
34223e03 182 * @param string $debuginfo Optional information to aid debugging
559a5dbd 183 */
93602569
JM
184 function __construct($errorcode=null, $a = '', $debuginfo = null) {
185 parent::__construct($errorcode, 'webservice', '', $a, $debuginfo);
559a5dbd 186 }
187}
188
9a0df45a 189/**
190 * Exceptions indicating user does not have permissions to do something
191 * and the execution can not continue.
47d2216e 192 *
f76249cc 193 * @package core_access
47d2216e
PS
194 * @copyright 2009 Petr Skoda {@link http://skodak.org}
195 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
9a0df45a 196 */
197class required_capability_exception extends moodle_exception {
34223e03
SH
198 /**
199 * Constructor
200 * @param context $context The context used for the capability check
201 * @param string $capability The required capability
202 * @param string $errormessage The error message to show the user
203 * @param string $stringfile
204 */
9a0df45a 205 function __construct($context, $capability, $errormessage, $stringfile) {
206 $capabilityname = get_capability_string($capability);
848fe203
PS
207 if ($context->contextlevel == CONTEXT_MODULE and preg_match('/:view$/', $capability)) {
208 // we can not go to mod/xx/view.php because we most probably do not have cap to view it, let's go to course instead
209 $paranetcontext = get_context_instance_by_id(get_parent_contextid($context));
210 $link = get_context_url($paranetcontext);
211 } else {
212 $link = get_context_url($context);
213 }
214 parent::__construct($errormessage, $stringfile, $link, $capabilityname);
9a0df45a 215 }
216}
217
655bbf51 218/**
cce1b0b9 219 * Exception indicating programming error, must be fixed by a programer. For example
220 * a core API might throw this type of exception if a plugin calls it incorrectly.
b37eac91 221 *
47d2216e
PS
222 * @package core
223 * @subpackage lib
224 * @copyright 2008 Petr Skoda {@link http://skodak.org}
225 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
655bbf51 226 */
227class coding_exception extends moodle_exception {
655bbf51 228 /**
229 * Constructor
230 * @param string $hint short description of problem
231 * @param string $debuginfo detailed information how to fix problem
232 */
233 function __construct($hint, $debuginfo=null) {
234 parent::__construct('codingerror', 'debug', '', $hint, $debuginfo);
a3f7cbf6 235 }
236}
237
238/**
239 * Exception indicating malformed parameter problem.
240 * This exception is not supposed to be thrown when processing
241 * user submitted data in forms. It is more suitable
242 * for WS and other low level stuff.
47d2216e
PS
243 *
244 * @package core
245 * @subpackage lib
246 * @copyright 2009 Petr Skoda {@link http://skodak.org}
247 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
a3f7cbf6 248 */
249class invalid_parameter_exception extends moodle_exception {
250 /**
251 * Constructor
252 * @param string $debuginfo some detailed information
253 */
254 function __construct($debuginfo=null) {
255 parent::__construct('invalidparameter', 'debug', '', null, $debuginfo);
655bbf51 256 }
257}
258
d07ff72d 259/**
260 * Exception indicating malformed response problem.
261 * This exception is not supposed to be thrown when processing
262 * user submitted data in forms. It is more suitable
263 * for WS and other low level stuff.
264 */
265class invalid_response_exception extends moodle_exception {
266 /**
267 * Constructor
268 * @param string $debuginfo some detailed information
269 */
270 function __construct($debuginfo=null) {
271 parent::__construct('invalidresponse', 'debug', '', null, $debuginfo);
272 }
273}
274
cce1b0b9 275/**
1387fcdd 276 * An exception that indicates something really weird happened. For example,
cce1b0b9 277 * if you do switch ($context->contextlevel), and have one case for each
278 * CONTEXT_... constant. You might throw an invalid_state_exception in the
f630a546 279 * default case, to just in case something really weird is going on, and
8dc0ae8f 280 * $context->contextlevel is invalid - rather than ignoring this possibility.
b37eac91 281 *
47d2216e
PS
282 * @package core
283 * @subpackage lib
284 * @copyright 2009 onwards Martin Dougiamas {@link http://moodle.com}
285 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
cce1b0b9 286 */
287class invalid_state_exception extends moodle_exception {
288 /**
289 * Constructor
290 * @param string $hint short description of problem
291 * @param string $debuginfo optional more detailed information
292 */
293 function __construct($hint, $debuginfo=null) {
294 parent::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
295 }
296}
297
4031f6a2
PS
298/**
299 * An exception that indicates incorrect permissions in $CFG->dataroot
300 *
301 * @package core
302 * @subpackage lib
303 * @copyright 2010 Petr Skoda {@link http://skodak.org}
304 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
305 */
306class invalid_dataroot_permissions extends moodle_exception {
307 /**
308 * Constructor
309 * @param string $debuginfo optional more detailed information
310 */
311 function __construct($debuginfo = NULL) {
312 parent::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
313 }
314}
315
cbad562e
PS
316/**
317 * An exception that indicates that file can not be served
318 *
319 * @package core
320 * @subpackage lib
321 * @copyright 2010 Petr Skoda {@link http://skodak.org}
322 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
323 */
324class file_serving_exception extends moodle_exception {
325 /**
326 * Constructor
327 * @param string $debuginfo optional more detailed information
328 */
329 function __construct($debuginfo = NULL) {
330 parent::__construct('cannotservefile', 'error', '', NULL, $debuginfo);
331 }
332}
333
251387d0 334/**
1387fcdd 335 * Default exception handler, uncaught exceptions are equivalent to error() in 1.9 and earlier
fd1a792e 336 *
30fa50d0 337 * @param Exception $ex
c19bc39c 338 * @return void -does not return. Terminates execution!
251387d0 339 */
c19bc39c 340function default_exception_handler($ex) {
f0202ae9 341 global $CFG, $DB, $OUTPUT, $USER, $FULLME, $SESSION, $PAGE;
1fbdf76d 342
343 // detect active db transactions, rollback and log as error
695c5ec4 344 abort_all_db_transactions();
1fe1d104 345
d9e07264 346 if (($ex instanceof required_capability_exception) && !CLI_SCRIPT && !AJAX_SCRIPT && !empty($CFG->autologinguests) && !empty($USER->autologinguest)) {
f0202ae9 347 $SESSION->wantsurl = qualified_me();
d9e07264
SH
348 redirect(get_login_url());
349 }
350
c19bc39c 351 $info = get_exception_info($ex);
34a2777c 352
c19bc39c 353 if (debugging('', DEBUG_MINIMAL)) {
2e9b772f 354 $logerrmsg = "Default exception handler: ".$info->message.' Debug: '.$info->debuginfo."\n".format_backtrace($info->backtrace, true);
695c5ec4 355 error_log($logerrmsg);
fd1a792e 356 }
357
c19bc39c
PS
358 if (is_early_init($info->backtrace)) {
359 echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
b7009474 360 } else {
3c1ea58b 361 try {
a56c457e
PS
362 if ($DB) {
363 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
364 $DB->set_debug(0);
365 }
3c1ea58b
PS
366 echo $OUTPUT->fatal_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
367 } catch (Exception $out_ex) {
368 // default exception handler MUST not throw any exceptions!!
2e9b772f 369 // the problem here is we do not know if page already started or not, we only know that somebody messed up in outputlib or theme
3c1ea58b 370 // so we just print at least something instead of "Exception thrown without a stack frame in Unknown on line 0":-(
1adaa404
PS
371 if (CLI_SCRIPT or AJAX_SCRIPT) {
372 // just ignore the error and send something back using the safest method
373 echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
374 } else {
375 echo bootstrap_renderer::early_error_content($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
376 $outinfo = get_exception_info($out_ex);
377 echo bootstrap_renderer::early_error_content($outinfo->message, $outinfo->moreinfourl, $outinfo->link, $outinfo->backtrace, $outinfo->debuginfo);
378 }
3c1ea58b 379 }
7544d13c 380 }
381
34a2777c 382 exit(1); // General error code
383}
384
85ba1e78
PS
385/**
386 * Default error handler, prevents some white screens.
387 * @param int $errno
388 * @param string $errstr
389 * @param string $errfile
390 * @param int $errline
391 * @param array $errcontext
392 * @return bool false means use default error handler
393 */
394function default_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
395 if ($errno == 4096) {
396 //fatal catchable error
397 throw new coding_exception('PHP catchable fatal error', $errstr);
398 }
399 return false;
400}
401
695c5ec4
PS
402/**
403 * Unconditionally abort all database transactions, this function
404 * should be called from exception handlers only.
405 * @return void
406 */
407function abort_all_db_transactions() {
408 global $CFG, $DB, $SCRIPT;
409
d5a8d9aa 410 // default exception handler MUST not throw any exceptions!!
03221650 411
695c5ec4
PS
412 if ($DB && $DB->is_transaction_started()) {
413 error_log('Database transaction aborted automatically in ' . $CFG->dirroot . $SCRIPT);
d5a8d9aa
PS
414 // note: transaction blocks should never change current $_SESSION
415 $DB->force_transaction_rollback();
695c5ec4
PS
416 }
417}
418
b7009474 419/**
50764d37
PS
420 * This function encapsulates the tests for whether an exception was thrown in
421 * early init -- either during setup.php or during init of $OUTPUT.
b7009474 422 *
423 * If another exception is thrown then, and if we do not take special measures,
424 * we would just get a very cryptic message "Exception thrown without a stack
425 * frame in Unknown on line 0". That makes debugging very hard, so we do take
426 * special measures in default_exception_handler, with the help of this function.
427 *
428 * @param array $backtrace the stack trace to analyse.
429 * @return boolean whether the stack trace is somewhere in output initialisation.
430 */
50764d37 431function is_early_init($backtrace) {
b7009474 432 $dangerouscode = array(
433 array('function' => 'header', 'type' => '->'),
434 array('class' => 'bootstrap_renderer'),
50764d37 435 array('file' => dirname(__FILE__).'/setup.php'),
b7009474 436 );
437 foreach ($backtrace as $stackframe) {
438 foreach ($dangerouscode as $pattern) {
439 $matches = true;
440 foreach ($pattern as $property => $value) {
441 if (!isset($stackframe[$property]) || $stackframe[$property] != $value) {
442 $matches = false;
443 }
444 }
445 if ($matches) {
446 return true;
447 }
448 }
449 }
450 return false;
451}
452
34a2777c 453/**
cbf05caa
PS
454 * Abort execution by throwing of a general exception,
455 * default exception handler displays the error message in most cases.
34a2777c 456 *
457 * @param string $errorcode The name of the language string containing the error message.
458 * Normally this should be in the error.php lang file.
459 * @param string $module The language file to get the error message from.
460 * @param string $link The url where the user will be prompted to continue.
461 * If no url is provided the user will be directed to the site index page.
462 * @param object $a Extra words and phrases that might be required in the error string
cbf05caa
PS
463 * @param string $debuginfo optional debugging information
464 * @return void, always throws exception!
34a2777c 465 */
cbf05caa
PS
466function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
467 throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
34a2777c 468}
469
470/**
c19bc39c
PS
471 * Returns detailed information about specified exception.
472 * @param exception $ex
473 * @return object
34a2777c 474 */
c19bc39c 475function get_exception_info($ex) {
34a2777c 476 global $CFG, $DB, $SESSION;
477
c19bc39c
PS
478 if ($ex instanceof moodle_exception) {
479 $errorcode = $ex->errorcode;
480 $module = $ex->module;
481 $a = $ex->a;
482 $link = $ex->link;
483 $debuginfo = $ex->debuginfo;
484 } else {
485 $errorcode = 'generalexceptionmessage';
486 $module = 'error';
487 $a = $ex->getMessage();
488 $link = '';
489 $debuginfo = null;
34a2777c 490 }
491
fb71453d
AD
492 // Append the error code to the debug info to make grepping and googling easier
493 $debuginfo .= PHP_EOL."Error code: $errorcode";
494
c19bc39c
PS
495 $backtrace = $ex->getTrace();
496 $place = array('file'=>$ex->getFile(), 'line'=>$ex->getLine(), 'exception'=>get_class($ex));
497 array_unshift($backtrace, $place);
498
c84a2dbe 499 // Be careful, no guarantee moodlelib.php is loaded.
34a2777c 500 if (empty($module) || $module == 'moodle' || $module == 'core') {
501 $module = 'error';
502 }
fb71453d
AD
503 // Search for the $errorcode's associated string
504 // If not found, append the contents of $a to $debuginfo so helpful information isn't lost
4f6be42c
DM
505 if (function_exists('get_string_manager')) {
506 if (get_string_manager()->string_exists($errorcode, $module)) {
507 $message = get_string($errorcode, $module, $a);
508 } elseif ($module == 'error' && get_string_manager()->string_exists($errorcode, 'moodle')) {
c84a2dbe 509 // Search in moodle file if error specified - needed for backwards compatibility
510 $message = get_string($errorcode, 'moodle', $a);
4f6be42c
DM
511 } else {
512 $message = $module . '/' . $errorcode;
fb71453d 513 $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
c84a2dbe 514 }
515 } else {
516 $message = $module . '/' . $errorcode;
fb71453d 517 $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
c84a2dbe 518 }
519
520 // Be careful, no guarantee weblib.php is loaded.
521 if (function_exists('clean_text')) {
522 $message = clean_text($message);
523 } else {
524 $message = htmlspecialchars($message);
34a2777c 525 }
34a2777c 526
527 if (!empty($CFG->errordocroot)) {
eea3341d 528 $errordoclink = $CFG->errordocroot . '/en/';
34a2777c 529 } else {
eea3341d 530 $errordoclink = get_docs_url();
34a2777c 531 }
eea3341d 532
34a2777c 533 if ($module === 'error') {
534 $modulelink = 'moodle';
0ae8f5fc 535 } else {
34a2777c 536 $modulelink = $module;
251387d0 537 }
eea3341d 538 $moreinfourl = $errordoclink . 'error/' . $modulelink . '/' . $errorcode;
34a2777c 539
d4a03c00 540 if (empty($link)) {
34a2777c 541 if (!empty($SESSION->fromurl)) {
542 $link = $SESSION->fromurl;
543 unset($SESSION->fromurl);
544 } else {
545 $link = $CFG->wwwroot .'/';
546 }
547 }
548
c8d3345c
PS
549 // when printing an error the continue button should never link offsite
550 if (stripos($link, $CFG->wwwroot) === false &&
551 stripos($link, $CFG->httpswwwroot) === false) {
552 $link = $CFG->wwwroot.'/';
553 }
554
365a5941 555 $info = new stdClass();
c19bc39c
PS
556 $info->message = $message;
557 $info->errorcode = $errorcode;
558 $info->backtrace = $backtrace;
559 $info->link = $link;
560 $info->moreinfourl = $moreinfourl;
561 $info->a = $a;
562 $info->debuginfo = $debuginfo;
30fa50d0 563
c19bc39c 564 return $info;
34a2777c 565}
566
eea3341d
AB
567/**
568 * Returns the Moodle Docs URL in the users language
569 *
570 * @global object
571 * @param string $path the end of the URL.
572 * @return string The MoodleDocs URL in the user's language. for example {@link http://docs.moodle.org/en/ http://docs.moodle.org/en/$path}
573 */
574function get_docs_url($path=null) {
575 global $CFG;
ed01233a
AB
576 // Check that $CFG->branch has been set up, during installation it won't be.
577 if (empty($CFG->branch)) {
eea3341d
AB
578 // It's not there yet so look at version.php
579 include($CFG->dirroot.'/version.php');
580 } else {
ed01233a
AB
581 // We can use $CFG->branch and avoid having to include version.php
582 $branch = $CFG->branch;
eea3341d 583 }
ed01233a
AB
584 // ensure branch is valid.
585 if (!$branch) {
eea3341d
AB
586 // We should never get here but in case we do lets set $branch to .
587 // the smart one's will know that this is the current directory
588 // and the smarter ones will know that there is some smart matching
589 // that will ensure people end up at the latest version of the docs.
590 $branch = '.';
591 }
592 if (!empty($CFG->docroot)) {
593 return $CFG->docroot . '/' . $branch . '/' . current_language() . '/' . $path;
594 } else {
595 return 'http://docs.moodle.org/'. $branch . '/en/' . $path;
596 }
597}
598
34a2777c 599/**
600 * Formats a backtrace ready for output.
601 *
602 * @param array $callers backtrace array, as returned by debug_backtrace().
603 * @param boolean $plaintext if false, generates HTML, if true generates plain text.
604 * @return string formatted backtrace, ready for output.
605 */
606function format_backtrace($callers, $plaintext = false) {
a0394be4 607 // do not use $CFG->dirroot because it might not be available in destructors
34a2777c 608 $dirroot = dirname(dirname(__FILE__));
30fa50d0 609
34a2777c 610 if (empty($callers)) {
611 return '';
612 }
613
614 $from = $plaintext ? '' : '<ul style="text-align: left">';
615 foreach ($callers as $caller) {
616 if (!isset($caller['line'])) {
617 $caller['line'] = '?'; // probably call_user_func()
618 }
619 if (!isset($caller['file'])) {
620 $caller['file'] = 'unknownfile'; // probably call_user_func()
621 }
622 $from .= $plaintext ? '* ' : '<li>';
623 $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
624 if (isset($caller['function'])) {
625 $from .= ': call to ';
626 if (isset($caller['class'])) {
627 $from .= $caller['class'] . $caller['type'];
628 }
629 $from .= $caller['function'] . '()';
630 } else if (isset($caller['exception'])) {
631 $from .= ': '.$caller['exception'].' thrown';
632 }
633 $from .= $plaintext ? "\n" : '</li>';
634 }
635 $from .= $plaintext ? '' : '</ul>';
636
637 return $from;
251387d0 638}
6a525ce2 639
cbad562e
PS
640/**
641 * This function makes the return value of ini_get consistent if you are
642 * setting server directives through the .htaccess file in apache.
643 *
644 * Current behavior for value set from php.ini On = 1, Off = [blank]
645 * Current behavior for value set from .htaccess On = On, Off = Off
646 * Contributed by jdell @ unr.edu
647 *
648 * @param string $ini_get_arg The argument to get
649 * @return bool True for on false for not
650 */
651function ini_get_bool($ini_get_arg) {
652 $temp = ini_get($ini_get_arg);
653
654 if ($temp == '1' or strtolower($temp) == 'on') {
655 return true;
656 }
657 return false;
658}
659
fbf2c91e 660/**
661 * This function verifies the sanity of PHP configuration
662 * and stops execution if anything critical found.
663 */
664function setup_validate_php_configuration() {
665 // this must be very fast - no slow checks here!!!
666
667 if (ini_get_bool('register_globals')) {
668 print_error('globalswarning', 'admin');
669 }
670 if (ini_get_bool('session.auto_start')) {
671 print_error('sessionautostartwarning', 'admin');
672 }
673 if (ini_get_bool('magic_quotes_runtime')) {
674 print_error('fatalmagicquotesruntime', 'admin');
675 }
676}
677
12bb0c3e
PS
678/**
679 * Initialise global $CFG variable
680 * @return void
681 */
682function initialise_cfg() {
683 global $CFG, $DB;
8b8aa060 684
12bb0c3e
PS
685 try {
686 if ($DB) {
687 $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
688 foreach ($localcfg as $name=>$value) {
689 if (property_exists($CFG, $name)) {
690 // config.php settings always take precedence
691 continue;
692 }
693 $CFG->{$name} = $value;
694 }
695 }
69ac5d47 696 } catch (dml_exception $e) {
12bb0c3e
PS
697 // most probably empty db, going to install soon
698 }
699}
700
11e7b506 701/**
75781f87 702 * Initialises $FULLME and friends. Private function. Should only be called from
703 * setup.php.
11e7b506 704 */
705function initialise_fullme() {
f0f8f9a7 706 global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
11e7b506 707
75781f87 708 // Detect common config error.
84b88cfd 709 if (substr($CFG->wwwroot, -1) == '/') {
710 print_error('wwwrootslash', 'error');
711 }
712
75781f87 713 if (CLI_SCRIPT) {
714 initialise_fullme_cli();
715 return;
37ccf1fe 716 }
11e7b506 717
75781f87 718 $rurl = setup_get_remote_url();
f0f8f9a7
PS
719 $wwwroot = parse_url($CFG->wwwroot.'/');
720
721 if (empty($rurl['host'])) {
722 // missing host in request header, probably not a real browser, let's ignore them
723
724 } else if (!empty($CFG->reverseproxy)) {
725 // $CFG->reverseproxy specifies if reverse proxy server used
726 // Used in load balancing scenarios.
727 // Do not abuse this to try to solve lan/wan access problems!!!!!
728
729 } else {
730 if (($rurl['host'] !== $wwwroot['host']) or (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port'])) {
731 // Explain the problem and redirect them to the right URL
732 if (!defined('NO_MOODLE_COOKIES')) {
733 define('NO_MOODLE_COOKIES', true);
734 }
735 redirect($CFG->wwwroot, get_string('wwwrootmismatch', 'error', $CFG->wwwroot), 3);
736 }
737 }
11e7b506 738
75781f87 739 // Check that URL is under $CFG->wwwroot.
740 if (strpos($rurl['path'], $wwwroot['path']) === 0) {
741 $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
742 } else {
743 // Probably some weird external script
744 $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
11e7b506 745 return;
746 }
747
75781f87 748 // $CFG->sslproxy specifies if external SSL appliance is used
749 // (That is, the Moodle server uses http, with an external box translating everything to https).
750 if (empty($CFG->sslproxy)) {
56048f83 751 if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
75781f87 752 print_error('sslonlyaccess', 'error');
753 }
56048f83
PS
754 } else {
755 if ($wwwroot['scheme'] !== 'https') {
756 throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
757 }
74162134 758 $rurl['scheme'] = 'https'; // make moodle believe it runs on https, squid or something else it doing it
75781f87 759 }
760
75781f87 761 // hopefully this will stop all those "clever" admins trying to set up moodle
762 // with two different addresses in intranet and Internet
e0f2718f 763 if (!empty($CFG->reverseproxy) && $rurl['host'] === $wwwroot['host']) {
75781f87 764 print_error('reverseproxyabused', 'error');
765 }
766
767 $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
768 if (!empty($wwwroot['port'])) {
769 $hostandport .= ':'.$wwwroot['port'];
770 }
771
772 $FULLSCRIPT = $hostandport . $rurl['path'];
773 $FULLME = $hostandport . $rurl['fullpath'];
774 $ME = $rurl['fullpath'];
75781f87 775}
776
777/**
778 * Initialises $FULLME and friends for command line scripts.
779 * This is a private method for use by initialise_fullme.
780 */
781function initialise_fullme_cli() {
80e30f25 782 global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
783
75781f87 784 // Urls do not make much sense in CLI scripts
785 $backtrace = debug_backtrace();
786 $topfile = array_pop($backtrace);
787 $topfile = realpath($topfile['file']);
788 $dirroot = realpath($CFG->dirroot);
789
790 if (strpos($topfile, $dirroot) !== 0) {
791 // Probably some weird external script
792 $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
793 } else {
794 $relativefile = substr($topfile, strlen($dirroot));
795 $relativefile = str_replace('\\', '/', $relativefile); // Win fix
796 $SCRIPT = $FULLSCRIPT = $relativefile;
797 $FULLME = $ME = null;
798 }
799}
800
801/**
802 * Get the URL that PHP/the web server thinks it is serving. Private function
803 * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
804 * @return array in the same format that parse_url returns, with the addition of
805 * a 'fullpath' element, which includes any slasharguments path.
806 */
807function setup_get_remote_url() {
11e7b506 808 $rurl = array();
e0f2718f
PS
809 if (isset($_SERVER['HTTP_HOST'])) {
810 list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
811 } else {
812 $rurl['host'] = null;
813 }
11e7b506 814 $rurl['port'] = $_SERVER['SERVER_PORT'];
75781f87 815 $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
2a9c0d05 816 $rurl['scheme'] = (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] === 'off' or $_SERVER['HTTPS'] === 'Off' or $_SERVER['HTTPS'] === 'OFF') ? 'http' : 'https';
11e7b506 817
818 if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
819 //Apache server
f49b359b 820 $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
7e13a265 821
11e7b506 822 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
199c1981 823 //IIS - needs a lot of tweaking to make it work
11e7b506 824 $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
825
826 // NOTE: ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS
827 // since 2.0 we rely on iis rewrite extenssion like Helicon ISAPI_rewrite
21517960 828 // example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
11e7b506 829
830 if ($_SERVER['QUERY_STRING'] != '') {
991ec2ee 831 $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
11e7b506 832 }
833 $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
834
f49b359b
PS
835/* NOTE: following servers are not fully tested! */
836
837 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
838 //lighttpd - not officially supported
f49b359b
PS
839 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
840
841 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
842 //nginx - not officially supported
28ec73dc
PS
843 if (!isset($_SERVER['SCRIPT_NAME'])) {
844 die('Invalid server configuration detected, please try to add "fastcgi_param SCRIPT_NAME $fastcgi_script_name;" to the nginx server configuration.');
845 }
f49b359b
PS
846 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
847
199c1981
PS
848 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
849 //cherokee - not officially supported
199c1981
PS
850 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
851
8b8aa060
PS
852 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
853 //zeus - not officially supported
8b8aa060
PS
854 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
855
f49b359b
PS
856 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
857 //LiteSpeed - not officially supported
f49b359b
PS
858 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
859
4e3e8464
PS
860 } else if ($_SERVER['SERVER_SOFTWARE'] === 'HTTPD') {
861 //obscure name found on some servers - this is definitely not supported
862 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
863
d860f1ad
PS
864 } else if (strpos($_SERVER['SERVER_SOFTWARE'], 'PHP') === 0) {
865 // built-in PHP Development Server
866 $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
867
868 } else {
75781f87 869 throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
11e7b506 870 }
0ae36f66
PS
871
872 // sanitize the url a bit more, the encoding style may be different in vars above
873 $rurl['fullpath'] = str_replace('"', '%22', $rurl['fullpath']);
874 $rurl['fullpath'] = str_replace('\'', '%27', $rurl['fullpath']);
875
75781f87 876 return $rurl;
11e7b506 877}
878
d3f9f1f8 879/**
880 * Initializes our performance info early.
881 *
882 * Pairs up with get_performance_info() which is actually
251387d0 883 * in moodlelib.php. This function is here so that we can
884 * call it before all the libs are pulled in.
d3f9f1f8 885 *
886 * @uses $PERF
887 */
888function init_performance_info() {
889
6fc4ad72 890 global $PERF, $CFG, $USER;
251387d0 891
365a5941 892 $PERF = new stdClass();
d3f9f1f8 893 $PERF->logwrites = 0;
894 if (function_exists('microtime')) {
895 $PERF->starttime = microtime();
c84a2dbe 896 }
d3f9f1f8 897 if (function_exists('memory_get_usage')) {
898 $PERF->startmemory = memory_get_usage();
899 }
900 if (function_exists('posix_times')) {
251387d0 901 $PERF->startposixtimes = posix_times();
d3f9f1f8 902 }
903}
904
31a99877 905/**
906 * Indicates whether we are in the middle of the initial Moodle install.
907 *
908 * Very occasionally it is necessary avoid running certain bits of code before the
909 * Moodle installation has completed. The installed flag is set in admin/index.php
910 * after Moodle core and all the plugins have been installed, but just before
911 * the person doing the initial install is asked to choose the admin password.
912 *
913 * @return boolean true if the initial install is not complete.
914 */
915function during_initial_install() {
916 global $CFG;
917 return empty($CFG->rolesactive);
918}
919
76f3815b 920/**
921 * Function to raise the memory limit to a new value.
922 * Will respect the memory limit if it is higher, thus allowing
923 * settings in php.ini, apache conf or command line switches
0f0f0768 924 * to override it.
76f3815b 925 *
0f0f0768
PS
926 * The memory limit should be expressed with a constant
927 * MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE.
928 * It is possible to use strings or integers too (eg:'128M').
76f3815b 929 *
0f0f0768
PS
930 * @param mixed $newlimit the new memory limit
931 * @return bool success
76f3815b 932 */
11e7b506 933function raise_memory_limit($newlimit) {
0f0f0768 934 global $CFG;
76f3815b 935
0f0f0768
PS
936 if ($newlimit == MEMORY_UNLIMITED) {
937 ini_set('memory_limit', -1);
938 return true;
939
940 } else if ($newlimit == MEMORY_STANDARD) {
cd3059b1
PS
941 if (PHP_INT_SIZE > 4) {
942 $newlimit = get_real_size('128M'); // 64bit needs more memory
943 } else {
944 $newlimit = get_real_size('96M');
945 }
0f0f0768
PS
946
947 } else if ($newlimit == MEMORY_EXTRA) {
cd3059b1
PS
948 if (PHP_INT_SIZE > 4) {
949 $newlimit = get_real_size('384M'); // 64bit needs more memory
950 } else {
951 $newlimit = get_real_size('256M');
952 }
d827f7b8 953 if (!empty($CFG->extramemorylimit)) {
0f0f0768
PS
954 $extra = get_real_size($CFG->extramemorylimit);
955 if ($extra > $newlimit) {
956 $newlimit = $extra;
957 }
958 }
959
960 } else if ($newlimit == MEMORY_HUGE) {
961 $newlimit = get_real_size('2G');
962
963 } else {
964 $newlimit = get_real_size($newlimit);
965 }
966
967 if ($newlimit <= 0) {
968 debugging('Invalid memory limit specified.');
76f3815b 969 return false;
970 }
971
cbad562e 972 $cur = ini_get('memory_limit');
76f3815b 973 if (empty($cur)) {
974 // if php is compiled without --enable-memory-limits
975 // apparently memory_limit is set to ''
0f0f0768 976 $cur = 0;
76f3815b 977 } else {
978 if ($cur == -1){
979 return true; // unlimited mem!
980 }
0f0f0768 981 $cur = get_real_size($cur);
76f3815b 982 }
983
0f0f0768 984 if ($newlimit > $cur) {
76f3815b 985 ini_set('memory_limit', $newlimit);
7022dd39 986 return true;
987 }
988 return false;
989}
990
991/**
992 * Function to reduce the memory limit to a new value.
993 * Will respect the memory limit if it is lower, thus allowing
994 * settings in php.ini, apache conf or command line switches
995 * to override it
996 *
997 * The memory limit should be expressed with a string (eg:'64M')
998 *
999 * @param string $newlimit the new memory limit
1000 * @return bool
1001 */
f630a546 1002function reduce_memory_limit($newlimit) {
7022dd39 1003 if (empty($newlimit)) {
1004 return false;
1005 }
cbad562e 1006 $cur = ini_get('memory_limit');
7022dd39 1007 if (empty($cur)) {
1008 // if php is compiled without --enable-memory-limits
1009 // apparently memory_limit is set to ''
0f0f0768 1010 $cur = 0;
7022dd39 1011 } else {
1012 if ($cur == -1){
1013 return true; // unlimited mem!
1014 }
1015 $cur = get_real_size($cur);
1016 }
1017
1018 $new = get_real_size($newlimit);
1019 // -1 is smaller, but it means unlimited
1020 if ($new < $cur && $new != -1) {
1021 ini_set('memory_limit', $newlimit);
76f3815b 1022 return true;
1023 }
1024 return false;
1025}
1026
1027/**
1028 * Converts numbers like 10M into bytes.
1029 *
0f0f0768
PS
1030 * @param string $size The size to be converted
1031 * @return int
76f3815b 1032 */
0f0f0768 1033function get_real_size($size = 0) {
76f3815b 1034 if (!$size) {
1035 return 0;
1036 }
11e7b506 1037 $scan = array();
0f0f0768
PS
1038 $scan['GB'] = 1073741824;
1039 $scan['Gb'] = 1073741824;
1040 $scan['G'] = 1073741824;
76f3815b 1041 $scan['MB'] = 1048576;
1042 $scan['Mb'] = 1048576;
1043 $scan['M'] = 1048576;
1044 $scan['m'] = 1048576;
1045 $scan['KB'] = 1024;
1046 $scan['Kb'] = 1024;
1047 $scan['K'] = 1024;
1048 $scan['k'] = 1024;
1049
1050 while (list($key) = each($scan)) {
1051 if ((strlen($size)>strlen($key))&&(substr($size, strlen($size) - strlen($key))==$key)) {
1052 $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
1053 break;
1054 }
1055 }
1056 return $size;
1057}
1058
cbad562e 1059/**
871ed458
PS
1060 * Try to disable all output buffering and purge
1061 * all headers.
1062 *
34223e03 1063 * @access private to be called only from lib/setup.php !
cbad562e
PS
1064 * @return void
1065 */
1066function disable_output_buffering() {
1067 $olddebug = error_reporting(0);
1068
1069 // disable compression, it would prevent closing of buffers
1070 if (ini_get_bool('zlib.output_compression')) {
1071 ini_set('zlib.output_compression', 'Off');
1072 }
1073
1074 // try to flush everything all the time
1075 ob_implicit_flush(true);
1076
1077 // close all buffers if possible and discard any existing output
1078 // this can actually work around some whitespace problems in config.php
1079 while(ob_get_level()) {
1080 if (!ob_end_clean()) {
1081 // prevent infinite loop when buffer can not be closed
1082 break;
1083 }
1084 }
1085
99302c5e
PS
1086 // disable any other output handlers
1087 ini_set('output_handler', '');
1088
cbad562e
PS
1089 error_reporting($olddebug);
1090}
1091
5e39d7aa 1092/**
1093 * Check whether a major upgrade is needed. That is defined as an upgrade that
1094 * changes something really fundamental in the database, so nothing can possibly
1095 * work until the database has been updated, and that is defined by the hard-coded
1096 * version number in this function.
1097 */
1098function redirect_if_major_upgrade_required() {
1099 global $CFG;
b24d1dbb 1100 $lastmajordbchanges = 2012051700;
5e39d7aa 1101 if (empty($CFG->version) or (int)$CFG->version < $lastmajordbchanges or
1102 during_initial_install() or !empty($CFG->adminsetuppending)) {
1103 try {
1104 @session_get_instance()->terminate_current();
1105 } catch (Exception $e) {
1106 // Ignore any errors, redirect to upgrade anyway.
1107 }
a38c7a10 1108 $url = $CFG->wwwroot . '/' . $CFG->admin . '/index.php';
5e39d7aa 1109 @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
a38c7a10
PS
1110 @header('Location: ' . $url);
1111 echo bootstrap_renderer::plain_redirect_message(htmlspecialchars($url));
5e39d7aa 1112 exit;
1113 }
1114}
1115
d3f9f1f8 1116/**
4031f6a2
PS
1117 * Function to check if a directory exists and by default create it if not exists.
1118 *
1119 * Previously this was accepting paths only from dataroot, but we now allow
1120 * files outside of dataroot if you supply custom paths for some settings in config.php.
1121 * This function does not verify that the directory is writable.
d3f9f1f8 1122 *
0b9f2a02
PS
1123 * NOTE: this function uses current file stat cache,
1124 * please use clearstatcache() before this if you expect that the
1125 * directories may have been removed recently from a different request.
1126 *
4031f6a2
PS
1127 * @param string $dir absolute directory path
1128 * @param boolean $create directory if does not exist
1129 * @param boolean $recursive create directory recursively
1130 * @return boolean true if directory exists or created, false otherwise
d3f9f1f8 1131 */
4031f6a2 1132function check_dir_exists($dir, $create = true, $recursive = true) {
d3f9f1f8 1133 global $CFG;
1134
4031f6a2 1135 umask(0000); // just in case some evil code changed it
d3f9f1f8 1136
4031f6a2
PS
1137 if (is_dir($dir)) {
1138 return true;
1139 }
d3f9f1f8 1140
4031f6a2
PS
1141 if (!$create) {
1142 return false;
d100b8a0 1143 }
1144
4031f6a2
PS
1145 return mkdir($dir, $CFG->directorypermissions, $recursive);
1146}
1147
1148/**
e6958907 1149 * Create a directory and make sure it is writable.
4031f6a2 1150 *
32db0f0d 1151 * @private
e6958907 1152 * @param string $dir the full path of the directory to be created
4031f6a2
PS
1153 * @param bool $exceptiononerror throw exception if error encountered
1154 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1155 */
e6958907 1156function make_writable_directory($dir, $exceptiononerror = true) {
4031f6a2
PS
1157 global $CFG;
1158
4031f6a2
PS
1159 if (file_exists($dir) and !is_dir($dir)) {
1160 if ($exceptiononerror) {
1161 throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
1162 } else {
1163 return false;
1164 }
1165 }
1166
1167 umask(0000); // just in case some evil code changed it
1168
1169 if (!file_exists($dir)) {
1170 if (!mkdir($dir, $CFG->directorypermissions, true)) {
1171 if ($exceptiononerror) {
1172 throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
1173 } else {
d3f9f1f8 1174 return false;
1175 }
d3f9f1f8 1176 }
1177 }
1178
4031f6a2
PS
1179 if (!is_writable($dir)) {
1180 if ($exceptiononerror) {
1181 throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
1182 } else {
1183 return false;
1184 }
1185 }
1186
1187 return $dir;
d3f9f1f8 1188}
1189
e6958907
TL
1190/**
1191 * Protect a directory from web access.
1192 * Could be extended in the future to support other mechanisms (e.g. other webservers).
1193 *
32db0f0d 1194 * @private
e6958907
TL
1195 * @param string $dir the full path of the directory to be protected
1196 */
1197function protect_directory($dir) {
1198 // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
1199 if (!file_exists("$dir/.htaccess")) {
1200 if ($handle = fopen("$dir/.htaccess", 'w')) { // For safety
1201 @fwrite($handle, "deny from all\r\nAllowOverride None\r\nNote: this file is broken intentionally, we do not want anybody to undo it in subdirectory!\r\n");
1202 @fclose($handle);
1203 }
1204 }
1205}
1206
1207/**
1208 * Create a directory under dataroot and make sure it is writable.
32db0f0d 1209 * Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
e6958907
TL
1210 *
1211 * @param string $directory the full path of the directory to be created under $CFG->dataroot
1212 * @param bool $exceptiononerror throw exception if error encountered
1213 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1214 */
1215function make_upload_directory($directory, $exceptiononerror = true) {
1216 global $CFG;
32db0f0d
PS
1217
1218 if (strpos($directory, 'temp/') === 0 or $directory === 'temp') {
1219 debugging('Use make_temp_directory() for creation of temporary directory and $CFG->tempdir to get the location.');
1220
1221 } else if (strpos($directory, 'cache/') === 0 or $directory === 'cache') {
1222 debugging('Use make_cache_directory() for creation of chache directory and $CFG->cachedir to get the location.');
1223 }
1224
e6958907
TL
1225 protect_directory($CFG->dataroot);
1226 return make_writable_directory("$CFG->dataroot/$directory", $exceptiononerror);
1227}
1228
1229/**
1230 * Create a directory under tempdir and make sure it is writable.
32db0f0d 1231 * Temporary files should be used during the current request only!
e6958907
TL
1232 *
1233 * @param string $directory the full path of the directory to be created under $CFG->tempdir
1234 * @param bool $exceptiononerror throw exception if error encountered
1235 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1236 */
1237function make_temp_directory($directory, $exceptiononerror = true) {
1238 global $CFG;
adf0fc0e
PS
1239 if ($CFG->tempdir !== "$CFG->dataroot/temp") {
1240 check_dir_exists($CFG->tempdir, true, true);
1241 protect_directory($CFG->tempdir);
7a7edd21
PS
1242 } else {
1243 protect_directory($CFG->dataroot);
adf0fc0e 1244 }
e6958907
TL
1245 return make_writable_directory("$CFG->tempdir/$directory", $exceptiononerror);
1246}
1247
1248/**
1249 * Create a directory under cachedir and make sure it is writable.
1250 *
1251 * @param string $directory the full path of the directory to be created under $CFG->cachedir
1252 * @param bool $exceptiononerror throw exception if error encountered
1253 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1254 */
1255function make_cache_directory($directory, $exceptiononerror = true) {
1256 global $CFG;
adf0fc0e
PS
1257 if ($CFG->cachedir !== "$CFG->dataroot/cache") {
1258 check_dir_exists($CFG->cachedir, true, true);
1259 protect_directory($CFG->cachedir);
7a7edd21
PS
1260 } else {
1261 protect_directory($CFG->dataroot);
adf0fc0e 1262 }
e6958907
TL
1263 return make_writable_directory("$CFG->cachedir/$directory", $exceptiononerror);
1264}
1265
1266
34223e03
SH
1267/**
1268 * Initialises an Memcached instance
1269 * @global memcached $MCACHE
1270 * @return boolean Returns true if an mcached instance could be successfully initialised
1271 */
419e1d93 1272function init_memcached() {
1273 global $CFG, $MCACHE;
1274
f917d0ea 1275 include_once($CFG->libdir . '/memcached.class.php');
1276 $MCACHE = new memcached;
1277 if ($MCACHE->status()) {
1278 return true;
251387d0 1279 }
f917d0ea 1280 unset($MCACHE);
251387d0 1281 return false;
419e1d93 1282}
1283
34223e03
SH
1284/**
1285 * Initialises an eAccelerator instance
1286 * @global eaccelerator $MCACHE
1287 * @return boolean Returns true if an eAccelerator instance could be successfully initialised
1288 */
2142d492 1289function init_eaccelerator() {
1290 global $CFG, $MCACHE;
1291
1292 include_once($CFG->libdir . '/eaccelerator.class.php');
1293 $MCACHE = new eaccelerator;
f917d0ea 1294 if ($MCACHE->status()) {
2142d492 1295 return true;
251387d0 1296 }
2142d492 1297 unset($MCACHE);
1298 return false;
1299}
1300
81b58cc2
PS
1301/**
1302 * Checks if current user is a web crawler.
1303 *
1304 * This list can not be made complete, this is not a security
1305 * restriction, we make the list only to help these sites
1306 * especially when automatic guest login is disabled.
1307 *
1308 * If admin needs security they should enable forcelogin
1309 * and disable guest access!!
1310 *
1311 * @return bool
1312 */
1313function is_web_crawler() {
1314 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
1315 if (strpos($_SERVER['HTTP_USER_AGENT'], 'Googlebot') !== false ) {
1316 return true;
1317 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'google.com') !== false ) { // Google
1318 return true;
1319 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Yahoo! Slurp') !== false ) { // Yahoo
1320 return true;
1321 } else if (strpos($_SERVER['HTTP_USER_AGENT'], '[ZSEBOT]') !== false ) { // Zoomspider
1322 return true;
1323 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'MSNBOT') !== false ) { // MSN Search
1324 return true;
1325 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Yandex') !== false ) {
1326 return true;
1327 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'AltaVista') !== false ) {
1328 return true;
1329 }
1330 }
1331 return false;
1332}
2142d492 1333
c84a2dbe 1334/**
1335 * This class solves the problem of how to initialise $OUTPUT.
1336 *
1337 * The problem is caused be two factors
1338 * <ol>
1339 * <li>On the one hand, we cannot be sure when output will start. In particular,
30fa50d0 1340 * an error, which needs to be displayed, could be thrown at any time.</li>
c84a2dbe 1341 * <li>On the other hand, we cannot be sure when we will have all the information
1342 * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1343 * (potentially) depends on the current course, course categories, and logged in user.
1344 * It also depends on whether the current page requires HTTPS.</li>
1345 * </ol>
1346 *
1347 * So, it is hard to find a single natural place during Moodle script execution,
1348 * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1349 * adopt the following strategy
1350 * <ol>
1351 * <li>We will initialise $OUTPUT the first time it is used.</li>
1352 * <li>If, after $OUTPUT has been initialised, the script tries to change something
7e0d6675 1353 * that $OUTPUT depends on, we throw an exception making it clear that the script
c84a2dbe 1354 * did something wrong.
1355 * </ol>
1356 *
1357 * The only problem with that is, how do we initialise $OUTPUT on first use if,
1358 * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1359 * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1360 * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1361 *
1362 * Note that this class is used before lib/outputlib.php has been loaded, so we
1387fcdd 1363 * must be careful referring to classes/functions from there, they may not be
c84a2dbe 1364 * defined yet, and we must avoid fatal errors.
1365 *
1366 * @copyright 2009 Tim Hunt
1367 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1368 * @since Moodle 2.0
1369 */
1370class bootstrap_renderer {
1371 /**
1372 * Handles re-entrancy. Without this, errors or debugging output that occur
1373 * during the initialisation of $OUTPUT, cause infinite recursion.
1374 * @var boolean
1375 */
1376 protected $initialising = false;
1377
b7009474 1378 /**
1379 * Have we started output yet?
1380 * @return boolean true if the header has been printed.
1381 */
1382 public function has_started() {
1383 return false;
1384 }
1385
41701ffd
PS
1386 /**
1387 * Constructor - to be used by core code only.
34223e03
SH
1388 * @param string $method The method to call
1389 * @param array $arguments Arguments to pass to the method being called
41701ffd
PS
1390 * @return string
1391 */
c84a2dbe 1392 public function __call($method, $arguments) {
b7009474 1393 global $OUTPUT, $PAGE;
c84a2dbe 1394
87b6851c 1395 $recursing = false;
1396 if ($method == 'notification') {
1387fcdd 1397 // Catch infinite recursion caused by debugging output during print_header.
87b6851c 1398 $backtrace = debug_backtrace();
1399 array_shift($backtrace);
1400 array_shift($backtrace);
50764d37 1401 $recursing = is_early_init($backtrace);
87b6851c 1402 }
1403
eb5bdb35
PS
1404 $earlymethods = array(
1405 'fatal_error' => 'early_error',
1406 'notification' => 'early_notification',
1407 );
1408
c84a2dbe 1409 // If lib/outputlib.php has been loaded, call it.
87b6851c 1410 if (!empty($PAGE) && !$recursing) {
eb5bdb35
PS
1411 if (array_key_exists($method, $earlymethods)) {
1412 //prevent PAGE->context warnings - exceptions might appear before we set any context
1413 $PAGE->set_context(null);
1414 }
b7009474 1415 $PAGE->initialise_theme_and_output();
1416 return call_user_func_array(array($OUTPUT, $method), $arguments);
c84a2dbe 1417 }
2142d492 1418
c84a2dbe 1419 $this->initialising = true;
eb5bdb35 1420
c84a2dbe 1421 // Too soon to initialise $OUTPUT, provide a couple of key methods.
c84a2dbe 1422 if (array_key_exists($method, $earlymethods)) {
1423 return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1424 }
1425
1426 throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1427 }
1428
1429 /**
1387fcdd 1430 * Returns nicely formatted error message in a div box.
f0f8f9a7
PS
1431 * @static
1432 * @param string $message error message
41701ffd
PS
1433 * @param string $moreinfourl (ignored in early errors)
1434 * @param string $link (ignored in early errors)
f0f8f9a7
PS
1435 * @param array $backtrace
1436 * @param string $debuginfo
30fa50d0 1437 * @return string
c84a2dbe 1438 */
3c1ea58b 1439 public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
b7009474 1440 global $CFG;
1441
3c1ea58b
PS
1442 $content = '<div style="margin-top: 6em; margin-left:auto; margin-right:auto; color:#990000; text-align:center; font-size:large; border-width:1px;
1443border-color:black; background-color:#ffffee; border-style:solid; border-radius: 20px; border-collapse: collapse;
1444width: 80%; -moz-border-radius: 20px; padding: 15px">
1445' . $message . '
1446</div>';
1447 if (!empty($CFG->debug) && $CFG->debug >= DEBUG_DEVELOPER) {
1448 if (!empty($debuginfo)) {
c5d18164
PS
1449 $debuginfo = s($debuginfo); // removes all nasty JS
1450 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1451 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
3c1ea58b
PS
1452 }
1453 if (!empty($backtrace)) {
1454 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
1455 }
1456 }
1457
1458 return $content;
1459 }
1460
1461 /**
1462 * This function should only be called by this class, or from exception handlers
f0f8f9a7
PS
1463 * @static
1464 * @param string $message error message
41701ffd
PS
1465 * @param string $moreinfourl (ignored in early errors)
1466 * @param string $link (ignored in early errors)
f0f8f9a7 1467 * @param array $backtrace
41701ffd 1468 * @param string $debuginfo extra information for developers
3c1ea58b
PS
1469 * @return string
1470 */
1471 public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1adaa404
PS
1472 global $CFG;
1473
1474 if (CLI_SCRIPT) {
1475 echo "!!! $message !!!\n";
1476 if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1477 if (!empty($debuginfo)) {
1478 echo "\nDebug info: $debuginfo";
1479 }
1480 if (!empty($backtrace)) {
1481 echo "\nStack trace: " . format_backtrace($backtrace, true);
1482 }
1483 }
1484 return;
1485
1486 } else if (AJAX_SCRIPT) {
1487 $e = new stdClass();
1488 $e->error = $message;
1489 $e->stacktrace = NULL;
1490 $e->debuginfo = NULL;
1491 if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1492 if (!empty($debuginfo)) {
1493 $e->debuginfo = $debuginfo;
1494 }
1495 if (!empty($backtrace)) {
1496 $e->stacktrace = format_backtrace($backtrace, true);
1497 }
1498 }
8a7703ce 1499 @header('Content-Type: application/json; charset=utf-8');
1adaa404
PS
1500 echo json_encode($e);
1501 return;
1502 }
1503
c84a2dbe 1504 // In the name of protocol correctness, monitoring and performance
1387fcdd 1505 // profiling, set the appropriate error headers for machine consumption
c84a2dbe 1506 if (isset($_SERVER['SERVER_PROTOCOL'])) {
1507 // Avoid it with cron.php. Note that we assume it's HTTP/1.x
1387fcdd 1508 // The 503 ode here means our Moodle does not work at all, the error happened too early
c84a2dbe 1509 @header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
1510 }
1511
1512 // better disable any caching
1513 @header('Content-Type: text/html; charset=utf-8');
1514 @header('Cache-Control: no-store, no-cache, must-revalidate');
1515 @header('Cache-Control: post-check=0, pre-check=0', false);
1516 @header('Pragma: no-cache');
1517 @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1518 @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1519
5e39d7aa 1520 if (function_exists('get_string')) {
c84a2dbe 1521 $strerror = get_string('error');
1522 } else {
c84a2dbe 1523 $strerror = 'Error';
1524 }
1525
3c1ea58b 1526 $content = self::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
5e39d7aa 1527
1528 return self::plain_page($strerror, $content);
c84a2dbe 1529 }
1530
f0f8f9a7
PS
1531 /**
1532 * Early notification message
1533 * @static
34223e03 1534 * @param string $message
41701ffd 1535 * @param string $classes usually notifyproblem or notifysuccess
f0f8f9a7
PS
1536 * @return string
1537 */
c84a2dbe 1538 public static function early_notification($message, $classes = 'notifyproblem') {
1539 return '<div class="' . $classes . '">' . $message . '</div>';
1540 }
5e39d7aa 1541
f0f8f9a7
PS
1542 /**
1543 * Page should redirect message.
1544 * @static
34223e03 1545 * @param string $encodedurl redirect url
f0f8f9a7
PS
1546 * @return string
1547 */
5e39d7aa 1548 public static function plain_redirect_message($encodedurl) {
41701ffd 1549 $message = '<div style="margin-top: 3em; margin-left:auto; margin-right:auto; text-align:center;">' . get_string('pageshouldredirect') . '<br /><a href="'.
f0f8f9a7 1550 $encodedurl .'">'. get_string('continue') .'</a></div>';
a0a268d5 1551 return self::plain_page(get_string('redirect'), $message);
5e39d7aa 1552 }
1553
f0f8f9a7
PS
1554 /**
1555 * Early redirection page, used before full init of $PAGE global
1556 * @static
34223e03
SH
1557 * @param string $encodedurl redirect url
1558 * @param string $message redirect message
1559 * @param int $delay time in seconds
41701ffd 1560 * @return string redirect page
f0f8f9a7
PS
1561 */
1562 public static function early_redirect_message($encodedurl, $message, $delay) {
1563 $meta = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />';
1564 $content = self::early_error_content($message, null, null, null);
1565 $content .= self::plain_redirect_message($encodedurl);
1566
1567 return self::plain_page(get_string('redirect'), $content, $meta);
1568 }
1569
1570 /**
1571 * Output basic html page.
1572 * @static
34223e03
SH
1573 * @param string $title page title
1574 * @param string $content page content
41701ffd
PS
1575 * @param string $meta meta tag
1576 * @return string html page
f0f8f9a7
PS
1577 */
1578 protected static function plain_page($title, $content, $meta = '') {
5e39d7aa 1579 if (function_exists('get_string') && function_exists('get_html_lang')) {
1580 $htmllang = get_html_lang();
1581 } else {
1582 $htmllang = '';
1583 }
1584
1585 return '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1586<html xmlns="http://www.w3.org/1999/xhtml" ' . $htmllang . '>
1587<head>
1588<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
f0f8f9a7 1589'.$meta.'
5e39d7aa 1590<title>' . $title . '</title>
1591</head><body>' . $content . '</body></html>';
1592 }
c84a2dbe 1593}