2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * These functions are required very early in the Moodle
19 * setup process, before any of the main libraries are
24 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 defined('MOODLE_INTERNAL') ||
die();
30 // Debug levels - always keep the values in ascending order!
31 /** No warnings and errors at all */
32 define('DEBUG_NONE', 0);
33 /** Fatal errors only */
34 define('DEBUG_MINIMAL', E_ERROR | E_PARSE
);
35 /** Errors, warnings and notices */
36 define('DEBUG_NORMAL', E_ERROR | E_PARSE | E_WARNING | E_NOTICE
);
37 /** All problems except strict PHP warnings */
38 define('DEBUG_ALL', E_ALL
& ~E_STRICT
);
39 /** DEBUG_ALL with all debug messages and strict warnings */
40 define('DEBUG_DEVELOPER', E_ALL | E_STRICT
);
42 /** Remove any memory limits */
43 define('MEMORY_UNLIMITED', -1);
44 /** Standard memory limit for given platform */
45 define('MEMORY_STANDARD', -2);
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.
50 define('MEMORY_EXTRA', -3);
51 /** Extremely large memory limit - not recommended for standard scripts */
52 define('MEMORY_HUGE', -4);
55 * Base Moodle Exception class
57 * Although this class is defined here, you cannot throw a moodle_exception until
58 * after moodlelib.php has been included (which will happen very soon).
62 * @copyright 2008 Petr Skoda {@link http://skodak.org}
63 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
65 class moodle_exception
extends Exception
{
68 * @var string The name of the string from error.php to print
73 * @var string The name of module
78 * @var mixed Extra words and phrases that might be required in the error string
83 * @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.
88 * @var string Optional information to aid the debugging process
94 * @param string $errorcode The name of the string from error.php to print
95 * @param string $module name of module
96 * @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.
97 * @param mixed $a Extra words and phrases that might be required in the error string
98 * @param string $debuginfo optional debugging information
100 function __construct($errorcode, $module='', $link='', $a=NULL, $debuginfo=null) {
103 if (empty($module) ||
$module == 'moodle' ||
$module == 'core') {
107 $this->errorcode
= $errorcode;
108 $this->module
= $module;
111 $this->debuginfo
= is_null($debuginfo) ?
null : (string)$debuginfo;
113 if (get_string_manager()->string_exists($errorcode, $module)) {
114 $message = get_string($errorcode, $module, $a);
115 $haserrorstring = true;
117 $message = $module . '/' . $errorcode;
118 $haserrorstring = false;
121 $isinphpunittest = (defined('PHPUNIT_TEST') && PHPUNIT_TEST
);
122 $hasdebugdeveloper = (
123 isset($CFG->debugdisplay
) &&
124 isset($CFG->debug
) &&
125 $CFG->debugdisplay
&&
126 $CFG->debug
=== DEBUG_DEVELOPER
130 if ($isinphpunittest ||
$hasdebugdeveloper) {
131 $message = "$message ($debuginfo)";
135 if (!$haserrorstring and $isinphpunittest) {
136 // Append the contents of $a to $debuginfo so helpful information isn't lost.
137 // This emulates what {@link get_exception_info()} does. Unfortunately that
138 // function is not used by phpunit.
139 $message .= PHP_EOL
.'$a contents: '.print_r($a, true);
142 parent
::__construct($message, 0);
147 * Course/activity access exception.
149 * This exception is thrown from require_login()
151 * @package core_access
152 * @copyright 2010 Petr Skoda {@link http://skodak.org}
153 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
155 class require_login_exception
extends moodle_exception
{
158 * @param string $debuginfo Information to aid the debugging process
160 function __construct($debuginfo) {
161 parent
::__construct('requireloginerror', 'error', '', NULL, $debuginfo);
166 * Session timeout exception.
168 * This exception is thrown from require_login()
170 * @package core_access
171 * @copyright 2015 Andrew Nicols <andrew@nicols.co.uk>
172 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
174 class require_login_session_timeout_exception
extends require_login_exception
{
178 public function __construct() {
179 moodle_exception
::__construct('sessionerroruser', 'error');
184 * Web service parameter exception class
185 * @deprecated since Moodle 2.2 - use moodle exception instead
186 * This exception must be thrown to the web service client when a web service parameter is invalid
187 * The error string is gotten from webservice.php
189 class webservice_parameter_exception
extends moodle_exception
{
192 * @param string $errorcode The name of the string from webservice.php to print
193 * @param string $a The name of the parameter
194 * @param string $debuginfo Optional information to aid debugging
196 function __construct($errorcode=null, $a = '', $debuginfo = null) {
197 parent
::__construct($errorcode, 'webservice', '', $a, $debuginfo);
202 * Exceptions indicating user does not have permissions to do something
203 * and the execution can not continue.
205 * @package core_access
206 * @copyright 2009 Petr Skoda {@link http://skodak.org}
207 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
209 class required_capability_exception
extends moodle_exception
{
212 * @param context $context The context used for the capability check
213 * @param string $capability The required capability
214 * @param string $errormessage The error message to show the user
215 * @param string $stringfile
217 function __construct($context, $capability, $errormessage, $stringfile) {
218 $capabilityname = get_capability_string($capability);
219 if ($context->contextlevel
== CONTEXT_MODULE
and preg_match('/:view$/', $capability)) {
220 // 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
221 $parentcontext = $context->get_parent_context();
222 $link = $parentcontext->get_url();
224 $link = $context->get_url();
226 parent
::__construct($errormessage, $stringfile, $link, $capabilityname);
231 * Exception indicating programming error, must be fixed by a programer. For example
232 * a core API might throw this type of exception if a plugin calls it incorrectly.
236 * @copyright 2008 Petr Skoda {@link http://skodak.org}
237 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
239 class coding_exception
extends moodle_exception
{
242 * @param string $hint short description of problem
243 * @param string $debuginfo detailed information how to fix problem
245 function __construct($hint, $debuginfo=null) {
246 parent
::__construct('codingerror', 'debug', '', $hint, $debuginfo);
251 * Exception indicating malformed parameter problem.
252 * This exception is not supposed to be thrown when processing
253 * user submitted data in forms. It is more suitable
254 * for WS and other low level stuff.
258 * @copyright 2009 Petr Skoda {@link http://skodak.org}
259 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
261 class invalid_parameter_exception
extends moodle_exception
{
264 * @param string $debuginfo some detailed information
266 function __construct($debuginfo=null) {
267 parent
::__construct('invalidparameter', 'debug', '', null, $debuginfo);
272 * Exception indicating malformed response problem.
273 * This exception is not supposed to be thrown when processing
274 * user submitted data in forms. It is more suitable
275 * for WS and other low level stuff.
277 class invalid_response_exception
extends moodle_exception
{
280 * @param string $debuginfo some detailed information
282 function __construct($debuginfo=null) {
283 parent
::__construct('invalidresponse', 'debug', '', null, $debuginfo);
288 * An exception that indicates something really weird happened. For example,
289 * if you do switch ($context->contextlevel), and have one case for each
290 * CONTEXT_... constant. You might throw an invalid_state_exception in the
291 * default case, to just in case something really weird is going on, and
292 * $context->contextlevel is invalid - rather than ignoring this possibility.
296 * @copyright 2009 onwards Martin Dougiamas {@link http://moodle.com}
297 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
299 class invalid_state_exception
extends moodle_exception
{
302 * @param string $hint short description of problem
303 * @param string $debuginfo optional more detailed information
305 function __construct($hint, $debuginfo=null) {
306 parent
::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
311 * An exception that indicates incorrect permissions in $CFG->dataroot
315 * @copyright 2010 Petr Skoda {@link http://skodak.org}
316 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
318 class invalid_dataroot_permissions
extends moodle_exception
{
321 * @param string $debuginfo optional more detailed information
323 function __construct($debuginfo = NULL) {
324 parent
::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
329 * An exception that indicates that file can not be served
333 * @copyright 2010 Petr Skoda {@link http://skodak.org}
334 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
336 class file_serving_exception
extends moodle_exception
{
339 * @param string $debuginfo optional more detailed information
341 function __construct($debuginfo = NULL) {
342 parent
::__construct('cannotservefile', 'error', '', NULL, $debuginfo);
347 * Default exception handler.
349 * @param Exception $ex
350 * @return void -does not return. Terminates execution!
352 function default_exception_handler($ex) {
353 global $CFG, $DB, $OUTPUT, $USER, $FULLME, $SESSION, $PAGE;
355 // detect active db transactions, rollback and log as error
356 abort_all_db_transactions();
358 if (($ex instanceof required_capability_exception
) && !CLI_SCRIPT
&& !AJAX_SCRIPT
&& !empty($CFG->autologinguests
) && !empty($USER->autologinguest
)) {
359 $SESSION->wantsurl
= qualified_me();
360 redirect(get_login_url());
363 $info = get_exception_info($ex);
365 // If we already tried to send the header remove it, the content length
366 // should be either empty or the length of the error page.
367 @header_remove
('Content-Length');
369 if (is_early_init($info->backtrace
)) {
370 echo bootstrap_renderer
::early_error($info->message
, $info->moreinfourl
, $info->link
, $info->backtrace
, $info->debuginfo
, $info->errorcode
);
372 if (debugging('', DEBUG_MINIMAL
)) {
373 $logerrmsg = "Default exception handler: ".$info->message
.' Debug: '.$info->debuginfo
."\n".format_backtrace($info->backtrace
, true);
374 error_log($logerrmsg);
379 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
383 // If we are in an AJAX script we don't want to use PREFERRED_RENDERER_TARGET.
384 // Because we know we will want to use ajax format.
385 $renderer = new core_renderer_ajax($PAGE, 'ajax');
389 echo $renderer->fatal_error($info->message
, $info->moreinfourl
, $info->link
, $info->backtrace
, $info->debuginfo
,
391 } catch (Exception
$e) {
393 } catch (Throwable
$e) {
394 // Engine errors in PHP7 throw exceptions of type Throwable (this "catch" will be ignored in PHP5).
398 if (isset($out_ex)) {
399 // default exception handler MUST not throw any exceptions!!
400 // 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
401 // so we just print at least something instead of "Exception thrown without a stack frame in Unknown on line 0":-(
402 if (CLI_SCRIPT
or AJAX_SCRIPT
) {
403 // just ignore the error and send something back using the safest method
404 echo bootstrap_renderer
::early_error($info->message
, $info->moreinfourl
, $info->link
, $info->backtrace
, $info->debuginfo
, $info->errorcode
);
406 echo bootstrap_renderer
::early_error_content($info->message
, $info->moreinfourl
, $info->link
, $info->backtrace
, $info->debuginfo
);
407 $outinfo = get_exception_info($out_ex);
408 echo bootstrap_renderer
::early_error_content($outinfo->message
, $outinfo->moreinfourl
, $outinfo->link
, $outinfo->backtrace
, $outinfo->debuginfo
);
413 exit(1); // General error code
417 * Default error handler, prevents some white screens.
419 * @param string $errstr
420 * @param string $errfile
421 * @param int $errline
422 * @return bool false means use default error handler
424 function default_error_handler($errno, $errstr, $errfile, $errline) {
425 if ($errno == 4096) {
426 //fatal catchable error
427 throw new coding_exception('PHP catchable fatal error', $errstr);
433 * Unconditionally abort all database transactions, this function
434 * should be called from exception handlers only.
437 function abort_all_db_transactions() {
438 global $CFG, $DB, $SCRIPT;
440 // default exception handler MUST not throw any exceptions!!
442 if ($DB && $DB->is_transaction_started()) {
443 error_log('Database transaction aborted automatically in ' . $CFG->dirroot
. $SCRIPT);
444 // note: transaction blocks should never change current $_SESSION
445 $DB->force_transaction_rollback();
450 * This function encapsulates the tests for whether an exception was thrown in
451 * early init -- either during setup.php or during init of $OUTPUT.
453 * If another exception is thrown then, and if we do not take special measures,
454 * we would just get a very cryptic message "Exception thrown without a stack
455 * frame in Unknown on line 0". That makes debugging very hard, so we do take
456 * special measures in default_exception_handler, with the help of this function.
458 * @param array $backtrace the stack trace to analyse.
459 * @return boolean whether the stack trace is somewhere in output initialisation.
461 function is_early_init($backtrace) {
462 $dangerouscode = array(
463 array('function' => 'header', 'type' => '->'),
464 array('class' => 'bootstrap_renderer'),
465 array('file' => __DIR__
.'/setup.php'),
467 foreach ($backtrace as $stackframe) {
468 foreach ($dangerouscode as $pattern) {
470 foreach ($pattern as $property => $value) {
471 if (!isset($stackframe[$property]) ||
$stackframe[$property] != $value) {
484 * Abort execution by throwing of a general exception,
485 * default exception handler displays the error message in most cases.
487 * @param string $errorcode The name of the language string containing the error message.
488 * Normally this should be in the error.php lang file.
489 * @param string $module The language file to get the error message from.
490 * @param string $link The url where the user will be prompted to continue.
491 * If no url is provided the user will be directed to the site index page.
492 * @param object $a Extra words and phrases that might be required in the error string
493 * @param string $debuginfo optional debugging information
494 * @return void, always throws exception!
496 function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
497 throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
501 * Returns detailed information about specified exception.
502 * @param exception $ex
505 function get_exception_info($ex) {
506 global $CFG, $DB, $SESSION;
508 if ($ex instanceof moodle_exception
) {
509 $errorcode = $ex->errorcode
;
510 $module = $ex->module
;
513 $debuginfo = $ex->debuginfo
;
515 $errorcode = 'generalexceptionmessage';
517 $a = $ex->getMessage();
522 // Append the error code to the debug info to make grepping and googling easier
523 $debuginfo .= PHP_EOL
."Error code: $errorcode";
525 $backtrace = $ex->getTrace();
526 $place = array('file'=>$ex->getFile(), 'line'=>$ex->getLine(), 'exception'=>get_class($ex));
527 array_unshift($backtrace, $place);
529 // Be careful, no guarantee moodlelib.php is loaded.
530 if (empty($module) ||
$module == 'moodle' ||
$module == 'core') {
533 // Search for the $errorcode's associated string
534 // If not found, append the contents of $a to $debuginfo so helpful information isn't lost
535 if (function_exists('get_string_manager')) {
536 if (get_string_manager()->string_exists($errorcode, $module)) {
537 $message = get_string($errorcode, $module, $a);
538 } elseif ($module == 'error' && get_string_manager()->string_exists($errorcode, 'moodle')) {
539 // Search in moodle file if error specified - needed for backwards compatibility
540 $message = get_string($errorcode, 'moodle', $a);
542 $message = $module . '/' . $errorcode;
543 $debuginfo .= PHP_EOL
.'$a contents: '.print_r($a, true);
546 $message = $module . '/' . $errorcode;
547 $debuginfo .= PHP_EOL
.'$a contents: '.print_r($a, true);
550 // Remove some absolute paths from message and debugging info.
553 $cfgnames = array('backuptempdir', 'tempdir', 'cachedir', 'localcachedir', 'themedir', 'dataroot', 'dirroot');
554 foreach ($cfgnames as $cfgname) {
555 if (property_exists($CFG, $cfgname)) {
556 $searches[] = $CFG->$cfgname;
557 $replaces[] = "[$cfgname]";
560 if (!empty($searches)) {
561 $message = str_replace($searches, $replaces, $message);
562 $debuginfo = str_replace($searches, $replaces, $debuginfo);
565 // Be careful, no guarantee weblib.php is loaded.
566 if (function_exists('clean_text')) {
567 $message = clean_text($message);
569 $message = htmlspecialchars($message);
572 if (!empty($CFG->errordocroot
)) {
573 $errordoclink = $CFG->errordocroot
. '/en/';
575 // Only if the function is available. May be not for early errors.
576 if (function_exists('current_language')) {
577 $errordoclink = get_docs_url();
579 $errordoclink = 'https://docs.moodle.org/en/';
583 if ($module === 'error') {
584 $modulelink = 'moodle';
586 $modulelink = $module;
588 $moreinfourl = $errordoclink . 'error/' . $modulelink . '/' . $errorcode;
591 $link = get_local_referer(false) ?
: ($CFG->wwwroot
. '/');
594 // When printing an error the continue button should never link offsite.
595 // We cannot use clean_param() here as it is not guaranteed that it has been loaded yet.
596 if (stripos($link, $CFG->wwwroot
) === 0) {
597 // Internal HTTP, all good.
599 // External link spotted!
600 $link = $CFG->wwwroot
. '/';
603 $info = new stdClass();
604 $info->message
= $message;
605 $info->errorcode
= $errorcode;
606 $info->backtrace
= $backtrace;
608 $info->moreinfourl
= $moreinfourl;
610 $info->debuginfo
= $debuginfo;
616 * @deprecated since Moodle 3.8 MDL-61038 - please do not use this function any more.
617 * @see \core\uuid::generate()
619 function generate_uuid() {
620 throw new coding_exception('generate_uuid() cannot be used anymore. Please use ' .
621 '\core\uuid::generate() instead.');
625 * Returns the Moodle Docs URL in the users language for a given 'More help' link.
627 * There are three cases:
629 * 1. In the normal case, $path will be a short relative path 'component/thing',
630 * like 'mod/folder/view' 'group/import'. This gets turned into an link to
631 * MoodleDocs in the user's language, and for the appropriate Moodle version.
632 * E.g. 'group/import' may become 'http://docs.moodle.org/2x/en/group/import'.
633 * The 'http://docs.moodle.org' bit comes from $CFG->docroot.
635 * This is the only option that should be used in standard Moodle code. The other
636 * two options have been implemented because they are useful for third-party plugins.
638 * 2. $path may be an absolute URL, starting http:// or https://. In this case,
639 * the link is used as is.
641 * 3. $path may start %%WWWROOT%%, in which case that is replaced by
642 * $CFG->wwwroot to make the link.
644 * @param string $path the place to link to. See above for details.
645 * @return string The MoodleDocs URL in the user's language. for example @link http://docs.moodle.org/2x/en/$path}
647 function get_docs_url($path = null) {
650 // Absolute URLs are used unmodified.
651 if (substr($path, 0, 7) === 'http://' ||
substr($path, 0, 8) === 'https://') {
655 // Paths starting %%WWWROOT%% have that replaced by $CFG->wwwroot.
656 if (substr($path, 0, 11) === '%%WWWROOT%%') {
657 return $CFG->wwwroot
. substr($path, 11);
660 // Otherwise we do the normal case, and construct a MoodleDocs URL relative to $CFG->docroot.
662 // Check that $CFG->branch has been set up, during installation it won't be.
663 if (empty($CFG->branch
)) {
664 // It's not there yet so look at version.php.
665 include($CFG->dirroot
.'/version.php');
667 // We can use $CFG->branch and avoid having to include version.php.
668 $branch = $CFG->branch
;
670 // ensure branch is valid.
672 // We should never get here but in case we do lets set $branch to .
673 // the smart one's will know that this is the current directory
674 // and the smarter ones will know that there is some smart matching
675 // that will ensure people end up at the latest version of the docs.
678 if (empty($CFG->doclang
)) {
679 $lang = current_language();
681 $lang = $CFG->doclang
;
683 $end = '/' . $branch . '/' . $lang . '/' . $path;
684 if (empty($CFG->docroot
)) {
685 return 'http://docs.moodle.org'. $end;
687 return $CFG->docroot
. $end ;
692 * Formats a backtrace ready for output.
694 * This function does not include function arguments because they could contain sensitive information
695 * not suitable to be exposed in a response.
697 * @param array $callers backtrace array, as returned by debug_backtrace().
698 * @param boolean $plaintext if false, generates HTML, if true generates plain text.
699 * @return string formatted backtrace, ready for output.
701 function format_backtrace($callers, $plaintext = false) {
702 // do not use $CFG->dirroot because it might not be available in destructors
703 $dirroot = dirname(__DIR__
);
705 if (empty($callers)) {
709 $from = $plaintext ?
'' : '<ul style="text-align: left" data-rel="backtrace">';
710 foreach ($callers as $caller) {
711 if (!isset($caller['line'])) {
712 $caller['line'] = '?'; // probably call_user_func()
714 if (!isset($caller['file'])) {
715 $caller['file'] = 'unknownfile'; // probably call_user_func()
717 $from .= $plaintext ?
'* ' : '<li>';
718 $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
719 if (isset($caller['function'])) {
720 $from .= ': call to ';
721 if (isset($caller['class'])) {
722 $from .= $caller['class'] . $caller['type'];
724 $from .= $caller['function'] . '()';
725 } else if (isset($caller['exception'])) {
726 $from .= ': '.$caller['exception'].' thrown';
728 $from .= $plaintext ?
"\n" : '</li>';
730 $from .= $plaintext ?
'' : '</ul>';
736 * This function makes the return value of ini_get consistent if you are
737 * setting server directives through the .htaccess file in apache.
739 * Current behavior for value set from php.ini On = 1, Off = [blank]
740 * Current behavior for value set from .htaccess On = On, Off = Off
741 * Contributed by jdell @ unr.edu
743 * @param string $ini_get_arg The argument to get
744 * @return bool True for on false for not
746 function ini_get_bool($ini_get_arg) {
747 $temp = ini_get($ini_get_arg);
749 if ($temp == '1' or strtolower($temp) == 'on') {
756 * This function verifies the sanity of PHP configuration
757 * and stops execution if anything critical found.
759 function setup_validate_php_configuration() {
760 // this must be very fast - no slow checks here!!!
762 if (ini_get_bool('session.auto_start')) {
763 print_error('sessionautostartwarning', 'admin');
768 * Initialise global $CFG variable.
769 * @private to be used only from lib/setup.php
771 function initialise_cfg() {
775 // This should not happen.
780 $localcfg = get_config('core');
781 } catch (dml_exception
$e) {
782 // Most probably empty db, going to install soon.
786 foreach ($localcfg as $name => $value) {
787 // Note that get_config() keeps forced settings
788 // and normalises values to string if possible.
789 $CFG->{$name} = $value;
794 * Cache any immutable config locally to avoid constant DB lookups.
796 * Only to be used only from lib/setup.php
798 function initialise_local_config_cache() {
801 $bootstrapcachefile = $CFG->localcachedir
. '/bootstrap.php';
803 if (!empty($CFG->siteidentifier
) && !file_exists($bootstrapcachefile)) {
805 // ********** This file is generated DO NOT EDIT **********
806 \$CFG->siteidentifier = '" . addslashes($CFG->siteidentifier
) . "';
807 \$CFG->bootstraphash = '" . hash_local_config_cache() . "';
808 // Only if the file is not stale and has not been defined.
809 if (\$CFG->bootstraphash === hash_local_config_cache() && !defined('SYSCONTEXTID')) {
810 define('SYSCONTEXTID', ".SYSCONTEXTID
.");
814 $temp = $bootstrapcachefile . '.tmp' . uniqid();
815 file_put_contents($temp, $contents);
816 @chmod
($temp, $CFG->filepermissions
);
817 rename($temp, $bootstrapcachefile);
822 * Calculate a proper hash to be able to invalidate stale cached configs.
824 * Only to be used to verify bootstrap.php status.
826 * @return string md5 hash of all the sensible bits deciding if cached config is stale or no.
828 function hash_local_config_cache() {
831 // This is pretty much {@see moodle_database::get_settings_hash()} that is used
832 // as identifier for the database meta information MUC cache. Should be enough to
833 // react against any of the normal changes (new prefix, change of DB type) while
834 // *incorrectly* keeping the old dataroot directory unmodified with stale data.
835 // This may need more stuff to be considered if it's discovered that there are
836 // more variables making the file stale.
837 return md5($CFG->dbtype
. $CFG->dbhost
. $CFG->dbuser
. $CFG->dbname
. $CFG->prefix
);
841 * Initialises $FULLME and friends. Private function. Should only be called from
844 function initialise_fullme() {
845 global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
847 // Detect common config error.
848 if (substr($CFG->wwwroot
, -1) == '/') {
849 print_error('wwwrootslash', 'error');
853 initialise_fullme_cli();
856 if (!empty($CFG->overridetossl
)) {
857 if (strpos($CFG->wwwroot
, 'http://') === 0) {
858 $CFG->wwwroot
= str_replace('http:', 'https:', $CFG->wwwroot
);
860 unset_config('overridetossl');
864 $rurl = setup_get_remote_url();
865 $wwwroot = parse_url($CFG->wwwroot
.'/');
867 if (empty($rurl['host'])) {
868 // missing host in request header, probably not a real browser, let's ignore them
870 } else if (!empty($CFG->reverseproxy
)) {
871 // $CFG->reverseproxy specifies if reverse proxy server used
872 // Used in load balancing scenarios.
873 // Do not abuse this to try to solve lan/wan access problems!!!!!
876 if (($rurl['host'] !== $wwwroot['host']) or
877 (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port']) or
878 (strpos($rurl['path'], $wwwroot['path']) !== 0)) {
880 // Explain the problem and redirect them to the right URL
881 if (!defined('NO_MOODLE_COOKIES')) {
882 define('NO_MOODLE_COOKIES', true);
884 // The login/token.php script should call the correct url/port.
885 if (defined('REQUIRE_CORRECT_ACCESS') && REQUIRE_CORRECT_ACCESS
) {
886 $wwwrootport = empty($wwwroot['port'])?
'':$wwwroot['port'];
887 $calledurl = $rurl['host'];
888 if (!empty($rurl['port'])) {
889 $calledurl .= ':'. $rurl['port'];
891 $correcturl = $wwwroot['host'];
892 if (!empty($wwwrootport)) {
893 $correcturl .= ':'. $wwwrootport;
895 throw new moodle_exception('requirecorrectaccess', 'error', '', null,
896 'You called ' . $calledurl .', you should have called ' . $correcturl);
898 redirect($CFG->wwwroot
, get_string('wwwrootmismatch', 'error', $CFG->wwwroot
), 3);
902 // Check that URL is under $CFG->wwwroot.
903 if (strpos($rurl['path'], $wwwroot['path']) === 0) {
904 $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
906 // Probably some weird external script
907 $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
911 // $CFG->sslproxy specifies if external SSL appliance is used
912 // (That is, the Moodle server uses http, with an external box translating everything to https).
913 if (empty($CFG->sslproxy
)) {
914 if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
915 if (defined('REQUIRE_CORRECT_ACCESS') && REQUIRE_CORRECT_ACCESS
) {
916 print_error('sslonlyaccess', 'error');
918 redirect($CFG->wwwroot
, get_string('wwwrootmismatch', 'error', $CFG->wwwroot
), 3);
922 if ($wwwroot['scheme'] !== 'https') {
923 throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
925 $rurl['scheme'] = 'https'; // make moodle believe it runs on https, squid or something else it doing it
926 $_SERVER['HTTPS'] = 'on'; // Override $_SERVER to help external libraries with their HTTPS detection.
927 $_SERVER['SERVER_PORT'] = 443; // Assume default ssl port for the proxy.
930 // Hopefully this will stop all those "clever" admins trying to set up moodle
931 // with two different addresses in intranet and Internet.
932 // Port forwarding is still allowed!
933 if (!empty($CFG->reverseproxy
) && $rurl['host'] === $wwwroot['host'] && (empty($wwwroot['port']) ||
$rurl['port'] === $wwwroot['port'])) {
934 print_error('reverseproxyabused', 'error');
937 $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
938 if (!empty($wwwroot['port'])) {
939 $hostandport .= ':'.$wwwroot['port'];
942 $FULLSCRIPT = $hostandport . $rurl['path'];
943 $FULLME = $hostandport . $rurl['fullpath'];
944 $ME = $rurl['fullpath'];
948 * Initialises $FULLME and friends for command line scripts.
949 * This is a private method for use by initialise_fullme.
951 function initialise_fullme_cli() {
952 global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
954 // Urls do not make much sense in CLI scripts
955 $backtrace = debug_backtrace();
956 $topfile = array_pop($backtrace);
957 $topfile = realpath($topfile['file']);
958 $dirroot = realpath($CFG->dirroot
);
960 if (strpos($topfile, $dirroot) !== 0) {
961 // Probably some weird external script
962 $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
964 $relativefile = substr($topfile, strlen($dirroot));
965 $relativefile = str_replace('\\', '/', $relativefile); // Win fix
966 $SCRIPT = $FULLSCRIPT = $relativefile;
967 $FULLME = $ME = null;
972 * Get the URL that PHP/the web server thinks it is serving. Private function
973 * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
974 * @return array in the same format that parse_url returns, with the addition of
975 * a 'fullpath' element, which includes any slasharguments path.
977 function setup_get_remote_url() {
979 if (isset($_SERVER['HTTP_HOST'])) {
980 list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
982 $rurl['host'] = null;
984 $rurl['port'] = (int)$_SERVER['SERVER_PORT'];
985 $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
986 $rurl['scheme'] = (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] === 'off' or $_SERVER['HTTPS'] === 'Off' or $_SERVER['HTTPS'] === 'OFF') ?
'http' : 'https';
988 if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
990 $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
992 // Fixing a known issue with:
993 // - Apache versions lesser than 2.4.11
994 // - PHP deployed in Apache as PHP-FPM via mod_proxy_fcgi
995 // - PHP versions lesser than 5.6.3 and 5.5.18.
996 if (isset($_SERVER['PATH_INFO']) && (php_sapi_name() === 'fpm-fcgi') && isset($_SERVER['SCRIPT_NAME'])) {
997 $pathinfodec = rawurldecode($_SERVER['PATH_INFO']);
998 $lenneedle = strlen($pathinfodec);
999 // Checks whether SCRIPT_NAME ends with PATH_INFO, URL-decoded.
1000 if (substr($_SERVER['SCRIPT_NAME'], -$lenneedle) === $pathinfodec) {
1001 // This is the "Apache 2.4.10- running PHP-FPM via mod_proxy_fcgi" fingerprint,
1002 // at least on CentOS 7 (Apache/2.4.6 PHP/5.4.16) and Ubuntu 14.04 (Apache/2.4.7 PHP/5.5.9)
1003 // => SCRIPT_NAME contains 'slash arguments' data too, which is wrongly exposed via PATH_INFO as URL-encoded.
1004 // Fix both $_SERVER['PATH_INFO'] and $_SERVER['SCRIPT_NAME'].
1005 $lenhaystack = strlen($_SERVER['SCRIPT_NAME']);
1006 $pos = $lenhaystack - $lenneedle;
1007 // Here $pos is greater than 0 but let's double check it.
1009 $_SERVER['PATH_INFO'] = $pathinfodec;
1010 $_SERVER['SCRIPT_NAME'] = substr($_SERVER['SCRIPT_NAME'], 0, $pos);
1015 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
1016 //IIS - needs a lot of tweaking to make it work
1017 $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
1019 // NOTE: we should ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS.
1020 // Since 2.0, we rely on IIS rewrite extensions like Helicon ISAPI_rewrite
1021 // example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
1023 // we rely on a proper IIS 6.0+ configuration: the 'FastCGIUtf8ServerVariables' registry key.
1024 if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
1025 // Check that PATH_INFO works == must not contain the script name.
1026 if (strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === false) {
1027 $rurl['fullpath'] .= clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH
);
1031 if (isset($_SERVER['QUERY_STRING']) and $_SERVER['QUERY_STRING'] !== '') {
1032 $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
1034 $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
1036 /* NOTE: following servers are not fully tested! */
1038 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
1039 //lighttpd - not officially supported
1040 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1042 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
1043 //nginx - not officially supported
1044 if (!isset($_SERVER['SCRIPT_NAME'])) {
1045 die('Invalid server configuration detected, please try to add "fastcgi_param SCRIPT_NAME $fastcgi_script_name;" to the nginx server configuration.');
1047 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1049 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
1050 //cherokee - not officially supported
1051 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1053 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
1054 //zeus - not officially supported
1055 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1057 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
1058 //LiteSpeed - not officially supported
1059 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1061 } else if ($_SERVER['SERVER_SOFTWARE'] === 'HTTPD') {
1062 //obscure name found on some servers - this is definitely not supported
1063 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1065 } else if (strpos($_SERVER['SERVER_SOFTWARE'], 'PHP') === 0) {
1066 // built-in PHP Development Server
1067 $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
1070 throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
1073 // sanitize the url a bit more, the encoding style may be different in vars above
1074 $rurl['fullpath'] = str_replace('"', '%22', $rurl['fullpath']);
1075 $rurl['fullpath'] = str_replace('\'', '%27', $rurl['fullpath']);
1081 * Try to work around the 'max_input_vars' restriction if necessary.
1083 function workaround_max_input_vars() {
1084 // Make sure this gets executed only once from lib/setup.php!
1085 static $executed = false;
1087 debugging('workaround_max_input_vars() must be called only once!');
1092 if (!isset($_SERVER["CONTENT_TYPE"]) or strpos($_SERVER["CONTENT_TYPE"], 'multipart/form-data') !== false) {
1093 // Not a post or 'multipart/form-data' which is not compatible with "php://input" reading.
1097 if (!isloggedin() or isguestuser()) {
1098 // Only real users post huge forms.
1102 $max = (int)ini_get('max_input_vars');
1105 // Most probably PHP < 5.3.9 that does not implement this limit.
1109 if ($max >= 200000) {
1110 // This value should be ok for all our forms, by setting it in php.ini
1111 // admins may prevent any unexpected regressions caused by this hack.
1113 // Note there is no need to worry about DDoS caused by making this limit very high
1114 // because there are very many easier ways to DDoS any Moodle server.
1118 // Worst case is advanced checkboxes which use up to two max_input_vars
1119 // slots for each entry in $_POST, because of sending two fields with the
1120 // same name. So count everything twice just in case.
1121 if (count($_POST, COUNT_RECURSIVE
) * 2 < $max) {
1125 // Large POST request with enctype supported by php://input.
1126 // Parse php://input in chunks to bypass max_input_vars limit, which also applies to parse_str().
1127 $str = file_get_contents("php://input");
1128 if ($str === false or $str === '') {
1129 // Some weird error.
1134 $fun = function($p) use ($delim) {
1135 return implode($delim, $p);
1137 $chunks = array_map($fun, array_chunk(explode($delim, $str), $max));
1139 // Clear everything from existing $_POST array, otherwise it might be included
1140 // twice (this affects array params primarily).
1141 foreach ($_POST as $key => $value) {
1142 unset($_POST[$key]);
1143 // Also clear from request array - but only the things that are in $_POST,
1144 // that way it will leave the things from a get request if any.
1145 unset($_REQUEST[$key]);
1148 foreach ($chunks as $chunk) {
1150 parse_str($chunk, $values);
1152 merge_query_params($_POST, $values);
1153 merge_query_params($_REQUEST, $values);
1158 * Merge parsed POST chunks.
1160 * NOTE: this is not perfect, but it should work in most cases hopefully.
1162 * @param array $target
1163 * @param array $values
1165 function merge_query_params(array &$target, array $values) {
1166 if (isset($values[0]) and isset($target[0])) {
1167 // This looks like a split [] array, lets verify the keys are continuous starting with 0.
1168 $keys1 = array_keys($values);
1169 $keys2 = array_keys($target);
1170 if ($keys1 === array_keys($keys1) and $keys2 === array_keys($keys2)) {
1171 foreach ($values as $v) {
1177 foreach ($values as $k => $v) {
1178 if (!isset($target[$k])) {
1182 if (is_array($target[$k]) and is_array($v)) {
1183 merge_query_params($target[$k], $v);
1186 // We should not get here unless there are duplicates in params.
1192 * Initializes our performance info early.
1194 * Pairs up with get_performance_info() which is actually
1195 * in moodlelib.php. This function is here so that we can
1196 * call it before all the libs are pulled in.
1200 function init_performance_info() {
1202 global $PERF, $CFG, $USER;
1204 $PERF = new stdClass();
1205 $PERF->logwrites
= 0;
1206 if (function_exists('microtime')) {
1207 $PERF->starttime
= microtime();
1209 if (function_exists('memory_get_usage')) {
1210 $PERF->startmemory
= memory_get_usage();
1212 if (function_exists('posix_times')) {
1213 $PERF->startposixtimes
= posix_times();
1218 * Indicates whether we are in the middle of the initial Moodle install.
1220 * Very occasionally it is necessary avoid running certain bits of code before the
1221 * Moodle installation has completed. The installed flag is set in admin/index.php
1222 * after Moodle core and all the plugins have been installed, but just before
1223 * the person doing the initial install is asked to choose the admin password.
1225 * @return boolean true if the initial install is not complete.
1227 function during_initial_install() {
1229 return empty($CFG->rolesactive
);
1233 * Function to raise the memory limit to a new value.
1234 * Will respect the memory limit if it is higher, thus allowing
1235 * settings in php.ini, apache conf or command line switches
1238 * The memory limit should be expressed with a constant
1239 * MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE.
1240 * It is possible to use strings or integers too (eg:'128M').
1242 * @param mixed $newlimit the new memory limit
1243 * @return bool success
1245 function raise_memory_limit($newlimit) {
1248 if ($newlimit == MEMORY_UNLIMITED
) {
1249 ini_set('memory_limit', -1);
1252 } else if ($newlimit == MEMORY_STANDARD
) {
1253 if (PHP_INT_SIZE
> 4) {
1254 $newlimit = get_real_size('128M'); // 64bit needs more memory
1256 $newlimit = get_real_size('96M');
1259 } else if ($newlimit == MEMORY_EXTRA
) {
1260 if (PHP_INT_SIZE
> 4) {
1261 $newlimit = get_real_size('384M'); // 64bit needs more memory
1263 $newlimit = get_real_size('256M');
1265 if (!empty($CFG->extramemorylimit
)) {
1266 $extra = get_real_size($CFG->extramemorylimit
);
1267 if ($extra > $newlimit) {
1272 } else if ($newlimit == MEMORY_HUGE
) {
1273 // MEMORY_HUGE uses 2G or MEMORY_EXTRA, whichever is bigger.
1274 $newlimit = get_real_size('2G');
1275 if (!empty($CFG->extramemorylimit
)) {
1276 $extra = get_real_size($CFG->extramemorylimit
);
1277 if ($extra > $newlimit) {
1283 $newlimit = get_real_size($newlimit);
1286 if ($newlimit <= 0) {
1287 debugging('Invalid memory limit specified.');
1291 $cur = ini_get('memory_limit');
1293 // if php is compiled without --enable-memory-limits
1294 // apparently memory_limit is set to ''
1298 return true; // unlimited mem!
1300 $cur = get_real_size($cur);
1303 if ($newlimit > $cur) {
1304 ini_set('memory_limit', $newlimit);
1311 * Function to reduce the memory limit to a new value.
1312 * Will respect the memory limit if it is lower, thus allowing
1313 * settings in php.ini, apache conf or command line switches
1316 * The memory limit should be expressed with a string (eg:'64M')
1318 * @param string $newlimit the new memory limit
1321 function reduce_memory_limit($newlimit) {
1322 if (empty($newlimit)) {
1325 $cur = ini_get('memory_limit');
1327 // if php is compiled without --enable-memory-limits
1328 // apparently memory_limit is set to ''
1332 return true; // unlimited mem!
1334 $cur = get_real_size($cur);
1337 $new = get_real_size($newlimit);
1338 // -1 is smaller, but it means unlimited
1339 if ($new < $cur && $new != -1) {
1340 ini_set('memory_limit', $newlimit);
1347 * Converts numbers like 10M into bytes.
1349 * @param string $size The size to be converted
1352 function get_real_size($size = 0) {
1357 static $binaryprefixes = array(
1370 if (preg_match('/^([0-9]+)([KMGTP])/i', $size, $matches)) {
1371 return $matches[1] * $binaryprefixes[$matches[2]];
1378 * Try to disable all output buffering and purge
1381 * @access private to be called only from lib/setup.php !
1384 function disable_output_buffering() {
1385 $olddebug = error_reporting(0);
1387 // disable compression, it would prevent closing of buffers
1388 if (ini_get_bool('zlib.output_compression')) {
1389 ini_set('zlib.output_compression', 'Off');
1392 // try to flush everything all the time
1393 ob_implicit_flush(true);
1395 // close all buffers if possible and discard any existing output
1396 // this can actually work around some whitespace problems in config.php
1397 while(ob_get_level()) {
1398 if (!ob_end_clean()) {
1399 // prevent infinite loop when buffer can not be closed
1404 // disable any other output handlers
1405 ini_set('output_handler', '');
1407 error_reporting($olddebug);
1409 // Disable buffering in nginx.
1410 header('X-Accel-Buffering: no');
1415 * Check whether a major upgrade is needed.
1417 * That is defined as an upgrade that changes something really fundamental
1418 * in the database, so nothing can possibly work until the database has
1419 * been updated, and that is defined by the hard-coded version number in
1424 function is_major_upgrade_required() {
1426 $lastmajordbchanges = 2021101900.01;
1428 $required = empty($CFG->version
);
1429 $required = $required ||
(float)$CFG->version
< $lastmajordbchanges;
1430 $required = $required ||
during_initial_install();
1431 $required = $required ||
!empty($CFG->adminsetuppending
);
1437 * Redirect to the Notifications page if a major upgrade is required, and
1438 * terminate the current user session.
1440 function redirect_if_major_upgrade_required() {
1442 if (is_major_upgrade_required()) {
1444 @\core\session\manager
::terminate_current();
1445 } catch (Exception
$e) {
1446 // Ignore any errors, redirect to upgrade anyway.
1448 $url = $CFG->wwwroot
. '/' . $CFG->admin
. '/index.php';
1449 @header
($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
1450 @header
('Location: ' . $url);
1451 echo bootstrap_renderer
::plain_redirect_message(htmlspecialchars($url));
1457 * Makes sure that upgrade process is not running
1459 * To be inserted in the core functions that can not be called by pluigns during upgrade.
1460 * Core upgrade should not use any API functions at all.
1461 * See {@link http://docs.moodle.org/dev/Upgrade_API#Upgrade_code_restrictions}
1463 * @throws moodle_exception if executed from inside of upgrade script and $warningonly is false
1464 * @param bool $warningonly if true displays a warning instead of throwing an exception
1465 * @return bool true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only
1467 function upgrade_ensure_not_running($warningonly = false) {
1469 if (!empty($CFG->upgraderunning
)) {
1470 if (!$warningonly) {
1471 throw new moodle_exception('cannotexecduringupgrade');
1473 debugging(get_string('cannotexecduringupgrade', 'error'), DEBUG_DEVELOPER
);
1481 * Function to check if a directory exists and by default create it if not exists.
1483 * Previously this was accepting paths only from dataroot, but we now allow
1484 * files outside of dataroot if you supply custom paths for some settings in config.php.
1485 * This function does not verify that the directory is writable.
1487 * NOTE: this function uses current file stat cache,
1488 * please use clearstatcache() before this if you expect that the
1489 * directories may have been removed recently from a different request.
1491 * @param string $dir absolute directory path
1492 * @param boolean $create directory if does not exist
1493 * @param boolean $recursive create directory recursively
1494 * @return boolean true if directory exists or created, false otherwise
1496 function check_dir_exists($dir, $create = true, $recursive = true) {
1499 umask($CFG->umaskpermissions
);
1509 return mkdir($dir, $CFG->directorypermissions
, $recursive);
1513 * Create a new unique directory within the specified directory.
1515 * @param string $basedir The directory to create your new unique directory within.
1516 * @param bool $exceptiononerror throw exception if error encountered
1517 * @return string The created directory
1518 * @throws invalid_dataroot_permissions
1520 function make_unique_writable_directory($basedir, $exceptiononerror = true) {
1521 if (!is_dir($basedir) ||
!is_writable($basedir)) {
1522 // The basedir is not writable. We will not be able to create the child directory.
1523 if ($exceptiononerror) {
1524 throw new invalid_dataroot_permissions($basedir . ' is not writable. Unable to create a unique directory within it.');
1531 // Let's use uniqid() because it's "unique enough" (microtime based). The loop does handle repetitions.
1532 // Windows and old PHP don't like very long paths, so try to keep this shorter. See MDL-69975.
1533 $uniquedir = $basedir . DIRECTORY_SEPARATOR
. uniqid();
1535 // Ensure that basedir is still writable - if we do not check, we could get stuck in a loop here.
1536 is_writable($basedir) &&
1538 // Make the new unique directory. If the directory already exists, it will return false.
1539 !make_writable_directory($uniquedir, $exceptiononerror) &&
1541 // Ensure that the directory now exists
1542 file_exists($uniquedir) && is_dir($uniquedir)
1545 // Check that the directory was correctly created.
1546 if (!file_exists($uniquedir) ||
!is_dir($uniquedir) ||
!is_writable($uniquedir)) {
1547 if ($exceptiononerror) {
1548 throw new invalid_dataroot_permissions('Unique directory creation failed.');
1558 * Create a directory and make sure it is writable.
1561 * @param string $dir the full path of the directory to be created
1562 * @param bool $exceptiononerror throw exception if error encountered
1563 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1565 function make_writable_directory($dir, $exceptiononerror = true) {
1568 if (file_exists($dir) and !is_dir($dir)) {
1569 if ($exceptiononerror) {
1570 throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
1576 umask($CFG->umaskpermissions
);
1578 if (!file_exists($dir)) {
1579 if (!@mkdir
($dir, $CFG->directorypermissions
, true)) {
1581 // There might be a race condition when creating directory.
1582 if (!is_dir($dir)) {
1583 if ($exceptiononerror) {
1584 throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
1586 debugging('Can not create directory: '.$dir, DEBUG_DEVELOPER
);
1593 if (!is_writable($dir)) {
1594 if ($exceptiononerror) {
1595 throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
1605 * Protect a directory from web access.
1606 * Could be extended in the future to support other mechanisms (e.g. other webservers).
1609 * @param string $dir the full path of the directory to be protected
1611 function protect_directory($dir) {
1613 // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
1614 if (!file_exists("$dir/.htaccess")) {
1615 if ($handle = fopen("$dir/.htaccess", 'w')) { // For safety
1616 @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");
1618 @chmod
("$dir/.htaccess", $CFG->filepermissions
);
1624 * Create a directory under dataroot and make sure it is writable.
1625 * Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
1627 * @param string $directory the full path of the directory to be created under $CFG->dataroot
1628 * @param bool $exceptiononerror throw exception if error encountered
1629 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1631 function make_upload_directory($directory, $exceptiononerror = true) {
1634 if (strpos($directory, 'temp/') === 0 or $directory === 'temp') {
1635 debugging('Use make_temp_directory() for creation of temporary directory and $CFG->tempdir to get the location.');
1637 } else if (strpos($directory, 'cache/') === 0 or $directory === 'cache') {
1638 debugging('Use make_cache_directory() for creation of cache directory and $CFG->cachedir to get the location.');
1640 } else if (strpos($directory, 'localcache/') === 0 or $directory === 'localcache') {
1641 debugging('Use make_localcache_directory() for creation of local cache directory and $CFG->localcachedir to get the location.');
1644 protect_directory($CFG->dataroot
);
1645 return make_writable_directory("$CFG->dataroot/$directory", $exceptiononerror);
1649 * Get a per-request storage directory in the tempdir.
1651 * The directory is automatically cleaned up during the shutdown handler.
1653 * @param bool $exceptiononerror throw exception if error encountered
1654 * @param bool $forcecreate Force creation of a new parent directory
1655 * @return string Returns full path to directory if successful, false if not; may throw exception
1657 function get_request_storage_directory($exceptiononerror = true, bool $forcecreate = false) {
1660 static $requestdir = null;
1662 $writabledirectoryexists = (null !== $requestdir);
1663 $writabledirectoryexists = $writabledirectoryexists && file_exists($requestdir);
1664 $writabledirectoryexists = $writabledirectoryexists && is_dir($requestdir);
1665 $writabledirectoryexists = $writabledirectoryexists && is_writable($requestdir);
1666 $createnewdirectory = $forcecreate ||
!$writabledirectoryexists;
1668 if ($createnewdirectory) {
1670 // Let's add the first chars of siteidentifier only. This is to help separate
1671 // paths on systems which host multiple moodles. We don't use the full id
1672 // as Windows and old PHP don't like very long paths. See MDL-69975.
1673 $basedir = $CFG->localrequestdir
. '/' . substr($CFG->siteidentifier
, 0, 4);
1675 make_writable_directory($basedir);
1676 protect_directory($basedir);
1678 if ($dir = make_unique_writable_directory($basedir, $exceptiononerror)) {
1679 // Register a shutdown handler to remove the directory.
1680 \core_shutdown_manager
::register_function('remove_dir', [$dir]);
1690 * Create a per-request directory and make sure it is writable.
1691 * This can only be used during the current request and will be tidied away
1692 * automatically afterwards.
1694 * A new, unique directory is always created within a shared base request directory.
1696 * In some exceptional cases an alternative base directory may be required. This can be accomplished using the
1697 * $forcecreate parameter. Typically this will only be requried where the file may be required during a shutdown handler
1698 * which may or may not be registered after a previous request directory has been created.
1700 * @param bool $exceptiononerror throw exception if error encountered
1701 * @param bool $forcecreate Force creation of a new parent directory
1702 * @return string The full path to directory if successful, false if not; may throw exception
1704 function make_request_directory(bool $exceptiononerror = true, bool $forcecreate = false) {
1705 $basedir = get_request_storage_directory($exceptiononerror, $forcecreate);
1706 return make_unique_writable_directory($basedir, $exceptiononerror);
1710 * Get the full path of a directory under $CFG->backuptempdir.
1712 * @param string $directory the relative path of the directory under $CFG->backuptempdir
1713 * @return string|false Returns full path to directory given a valid string; otherwise, false.
1715 function get_backup_temp_directory($directory) {
1717 if (($directory === null) ||
($directory === false)) {
1720 return "$CFG->backuptempdir/$directory";
1724 * Create a directory under $CFG->backuptempdir and make sure it is writable.
1726 * Do not use for storing generic temp files - see make_temp_directory() instead for this purpose.
1728 * Backup temporary files must be on a shared storage.
1730 * @param string $directory the relative path of the directory to be created under $CFG->backuptempdir
1731 * @param bool $exceptiononerror throw exception if error encountered
1732 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1734 function make_backup_temp_directory($directory, $exceptiononerror = true) {
1736 if ($CFG->backuptempdir
!== "$CFG->tempdir/backup") {
1737 check_dir_exists($CFG->backuptempdir
, true, true);
1738 protect_directory($CFG->backuptempdir
);
1740 protect_directory($CFG->tempdir
);
1742 return make_writable_directory("$CFG->backuptempdir/$directory", $exceptiononerror);
1746 * Create a directory under tempdir and make sure it is writable.
1748 * Where possible, please use make_request_directory() and limit the scope
1749 * of your data to the current HTTP request.
1751 * Do not use for storing cache files - see make_cache_directory(), and
1752 * make_localcache_directory() instead for this purpose.
1754 * Temporary files must be on a shared storage, and heavy usage is
1755 * discouraged due to the performance impact upon clustered environments.
1757 * @param string $directory the full path of the directory to be created under $CFG->tempdir
1758 * @param bool $exceptiononerror throw exception if error encountered
1759 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1761 function make_temp_directory($directory, $exceptiononerror = true) {
1763 if ($CFG->tempdir
!== "$CFG->dataroot/temp") {
1764 check_dir_exists($CFG->tempdir
, true, true);
1765 protect_directory($CFG->tempdir
);
1767 protect_directory($CFG->dataroot
);
1769 return make_writable_directory("$CFG->tempdir/$directory", $exceptiononerror);
1773 * Create a directory under cachedir and make sure it is writable.
1775 * Note: this cache directory is shared by all cluster nodes.
1777 * @param string $directory the full path of the directory to be created under $CFG->cachedir
1778 * @param bool $exceptiononerror throw exception if error encountered
1779 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1781 function make_cache_directory($directory, $exceptiononerror = true) {
1783 if ($CFG->cachedir
!== "$CFG->dataroot/cache") {
1784 check_dir_exists($CFG->cachedir
, true, true);
1785 protect_directory($CFG->cachedir
);
1787 protect_directory($CFG->dataroot
);
1789 return make_writable_directory("$CFG->cachedir/$directory", $exceptiononerror);
1793 * Create a directory under localcachedir and make sure it is writable.
1794 * The files in this directory MUST NOT change, use revisions or content hashes to
1795 * work around this limitation - this means you can only add new files here.
1797 * The content of this directory gets purged automatically on all cluster nodes
1798 * after calling purge_all_caches() before new data is written to this directory.
1800 * Note: this local cache directory does not need to be shared by cluster nodes.
1802 * @param string $directory the relative path of the directory to be created under $CFG->localcachedir
1803 * @param bool $exceptiononerror throw exception if error encountered
1804 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1806 function make_localcache_directory($directory, $exceptiononerror = true) {
1809 make_writable_directory($CFG->localcachedir
, $exceptiononerror);
1811 if ($CFG->localcachedir
!== "$CFG->dataroot/localcache") {
1812 protect_directory($CFG->localcachedir
);
1814 protect_directory($CFG->dataroot
);
1817 if (!isset($CFG->localcachedirpurged
)) {
1818 $CFG->localcachedirpurged
= 0;
1820 $timestampfile = "$CFG->localcachedir/.lastpurged";
1822 if (!file_exists($timestampfile)) {
1823 touch($timestampfile);
1824 @chmod
($timestampfile, $CFG->filepermissions
);
1826 } else if (filemtime($timestampfile) < $CFG->localcachedirpurged
) {
1827 // This means our local cached dir was not purged yet.
1828 remove_dir($CFG->localcachedir
, true);
1829 if ($CFG->localcachedir
!== "$CFG->dataroot/localcache") {
1830 protect_directory($CFG->localcachedir
);
1832 touch($timestampfile);
1833 @chmod
($timestampfile, $CFG->filepermissions
);
1837 if ($directory === '') {
1838 return $CFG->localcachedir
;
1841 return make_writable_directory("$CFG->localcachedir/$directory", $exceptiononerror);
1845 * Webserver access user logging
1847 function set_access_log_user() {
1849 if ($USER && isset($USER->username
)) {
1852 if (!empty($CFG->apacheloguser
) && function_exists('apache_note')) {
1853 $logmethod = 'apache';
1854 $logvalue = $CFG->apacheloguser
;
1856 if (!empty($CFG->headerloguser
)) {
1857 $logmethod = 'header';
1858 $logvalue = $CFG->headerloguser
;
1860 if (!empty($logmethod)) {
1861 $loguserid = $USER->id
;
1862 $logusername = clean_filename($USER->username
);
1864 if (isset($USER->firstname
)) {
1865 // We can assume both will be set
1866 // - even if to empty.
1867 $logname = clean_filename($USER->firstname
. " " . $USER->lastname
);
1869 if (\core\session\manager
::is_loggedinas()) {
1870 $realuser = \core\session\manager
::get_realuser();
1871 $logusername = clean_filename($realuser->username
." as ".$logusername);
1872 $logname = clean_filename($realuser->firstname
." ".$realuser->lastname
." as ".$logname);
1873 $loguserid = clean_filename($realuser->id
." as ".$loguserid);
1875 switch ($logvalue) {
1877 $logname = $logusername;
1880 $logname = $logname;
1884 $logname = $loguserid;
1887 if ($logmethod == 'apache') {
1888 apache_note('MOODLEUSER', $logname);
1891 if ($logmethod == 'header') {
1892 header("X-MOODLEUSER: $logname");
1899 * This class solves the problem of how to initialise $OUTPUT.
1901 * The problem is caused be two factors
1903 * <li>On the one hand, we cannot be sure when output will start. In particular,
1904 * an error, which needs to be displayed, could be thrown at any time.</li>
1905 * <li>On the other hand, we cannot be sure when we will have all the information
1906 * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1907 * (potentially) depends on the current course, course categories, and logged in user.
1908 * It also depends on whether the current page requires HTTPS.</li>
1911 * So, it is hard to find a single natural place during Moodle script execution,
1912 * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1913 * adopt the following strategy
1915 * <li>We will initialise $OUTPUT the first time it is used.</li>
1916 * <li>If, after $OUTPUT has been initialised, the script tries to change something
1917 * that $OUTPUT depends on, we throw an exception making it clear that the script
1918 * did something wrong.
1921 * The only problem with that is, how do we initialise $OUTPUT on first use if,
1922 * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1923 * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1924 * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1926 * Note that this class is used before lib/outputlib.php has been loaded, so we
1927 * must be careful referring to classes/functions from there, they may not be
1928 * defined yet, and we must avoid fatal errors.
1930 * @copyright 2009 Tim Hunt
1931 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1934 class bootstrap_renderer
{
1936 * Handles re-entrancy. Without this, errors or debugging output that occur
1937 * during the initialisation of $OUTPUT, cause infinite recursion.
1940 protected $initialising = false;
1943 * Have we started output yet?
1944 * @return boolean true if the header has been printed.
1946 public function has_started() {
1951 * Constructor - to be used by core code only.
1952 * @param string $method The method to call
1953 * @param array $arguments Arguments to pass to the method being called
1956 public function __call($method, $arguments) {
1957 global $OUTPUT, $PAGE;
1960 if ($method == 'notification') {
1961 // Catch infinite recursion caused by debugging output during print_header.
1962 $backtrace = debug_backtrace();
1963 array_shift($backtrace);
1964 array_shift($backtrace);
1965 $recursing = is_early_init($backtrace);
1968 $earlymethods = array(
1969 'fatal_error' => 'early_error',
1970 'notification' => 'early_notification',
1973 // If lib/outputlib.php has been loaded, call it.
1974 if (!empty($PAGE) && !$recursing) {
1975 if (array_key_exists($method, $earlymethods)) {
1976 //prevent PAGE->context warnings - exceptions might appear before we set any context
1977 $PAGE->set_context(null);
1979 $PAGE->initialise_theme_and_output();
1980 return call_user_func_array(array($OUTPUT, $method), $arguments);
1983 $this->initialising
= true;
1985 // Too soon to initialise $OUTPUT, provide a couple of key methods.
1986 if (array_key_exists($method, $earlymethods)) {
1987 return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1990 throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1994 * Returns nicely formatted error message in a div box.
1996 * @param string $message error message
1997 * @param string $moreinfourl (ignored in early errors)
1998 * @param string $link (ignored in early errors)
1999 * @param array $backtrace
2000 * @param string $debuginfo
2003 public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
2006 $content = "<div class='alert-danger'>$message</div>";
2007 // Check whether debug is set.
2008 $debug = (!empty($CFG->debug
) && $CFG->debug
>= DEBUG_DEVELOPER
);
2009 // Also check we have it set in the config file. This occurs if the method to read the config table from the
2010 // database fails, reading from the config table is the first database interaction we have.
2011 $debug = $debug ||
(!empty($CFG->config_php_settings
['debug']) && $CFG->config_php_settings
['debug'] >= DEBUG_DEVELOPER
);
2013 if (!empty($debuginfo)) {
2014 // Remove all nasty JS.
2015 if (function_exists('s')) { // Function may be not available for some early errors.
2016 $debuginfo = s($debuginfo);
2018 // Because weblib is not available for these early errors, we
2019 // just duplicate s() code here to be safe.
2020 $debuginfo = preg_replace('/&#(\d+|x[0-9a-f]+);/i', '&#$1;',
2021 htmlspecialchars($debuginfo, ENT_QUOTES | ENT_HTML401 | ENT_SUBSTITUTE
));
2023 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
2024 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
2026 if (!empty($backtrace)) {
2027 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
2035 * This function should only be called by this class, or from exception handlers
2037 * @param string $message error message
2038 * @param string $moreinfourl (ignored in early errors)
2039 * @param string $link (ignored in early errors)
2040 * @param array $backtrace
2041 * @param string $debuginfo extra information for developers
2044 public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = null) {
2048 echo "!!! $message !!!\n";
2049 if (!empty($CFG->debug
) and $CFG->debug
>= DEBUG_DEVELOPER
) {
2050 if (!empty($debuginfo)) {
2051 echo "\nDebug info: $debuginfo";
2053 if (!empty($backtrace)) {
2054 echo "\nStack trace: " . format_backtrace($backtrace, true);
2059 } else if (AJAX_SCRIPT
) {
2060 $e = new stdClass();
2061 $e->error
= $message;
2062 $e->stacktrace
= NULL;
2063 $e->debuginfo
= NULL;
2064 if (!empty($CFG->debug
) and $CFG->debug
>= DEBUG_DEVELOPER
) {
2065 if (!empty($debuginfo)) {
2066 $e->debuginfo
= $debuginfo;
2068 if (!empty($backtrace)) {
2069 $e->stacktrace
= format_backtrace($backtrace, true);
2072 $e->errorcode
= $errorcode;
2073 @header
('Content-Type: application/json; charset=utf-8');
2074 echo json_encode($e);
2078 // In the name of protocol correctness, monitoring and performance
2079 // profiling, set the appropriate error headers for machine consumption.
2080 $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ?
$_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2081 @header
($protocol . ' 500 Internal Server Error');
2083 // better disable any caching
2084 @header
('Content-Type: text/html; charset=utf-8');
2085 @header
('X-UA-Compatible: IE=edge');
2086 @header
('Cache-Control: no-store, no-cache, must-revalidate');
2087 @header
('Cache-Control: post-check=0, pre-check=0', false);
2088 @header
('Pragma: no-cache');
2089 @header
('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2090 @header
('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2092 if (function_exists('get_string')) {
2093 $strerror = get_string('error');
2095 $strerror = 'Error';
2098 $content = self
::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
2100 return self
::plain_page($strerror, $content);
2104 * Early notification message
2106 * @param string $message
2107 * @param string $classes usually notifyproblem or notifysuccess
2110 public static function early_notification($message, $classes = 'notifyproblem') {
2111 return '<div class="' . $classes . '">' . $message . '</div>';
2115 * Page should redirect message.
2117 * @param string $encodedurl redirect url
2120 public static function plain_redirect_message($encodedurl) {
2121 $message = '<div style="margin-top: 3em; margin-left:auto; margin-right:auto; text-align:center;">' . get_string('pageshouldredirect') . '<br /><a href="'.
2122 $encodedurl .'">'. get_string('continue') .'</a></div>';
2123 return self
::plain_page(get_string('redirect'), $message);
2127 * Early redirection page, used before full init of $PAGE global
2129 * @param string $encodedurl redirect url
2130 * @param string $message redirect message
2131 * @param int $delay time in seconds
2132 * @return string redirect page
2134 public static function early_redirect_message($encodedurl, $message, $delay) {
2135 $meta = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />';
2136 $content = self
::early_error_content($message, null, null, null);
2137 $content .= self
::plain_redirect_message($encodedurl);
2139 return self
::plain_page(get_string('redirect'), $content, $meta);
2143 * Output basic html page.
2145 * @param string $title page title
2146 * @param string $content page content
2147 * @param string $meta meta tag
2148 * @return string html page
2150 public static function plain_page($title, $content, $meta = '') {
2153 if (function_exists('get_string') && function_exists('get_html_lang')) {
2154 $htmllang = get_html_lang();
2160 if (function_exists('get_performance_info')) { // Function may be not available for some early errors.
2161 if (MDL_PERF_TEST
) {
2162 $perfinfo = get_performance_info();
2163 $footer = '<footer>' . $perfinfo['html'] . '</footer>';
2168 include($CFG->dirroot
. '/error/plainpage.php');
2169 $html = ob_get_contents();