MDL-49399 core: Allow creation of a new per-request basedir
[moodle.git] / lib / setuplib.php
1 <?php
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/>.
17 /**
18  * These functions are required very early in the Moodle
19  * setup process, before any of the main libraries are
20  * loaded.
21  *
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
26  */
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);
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  */
50 define('MEMORY_EXTRA', -3);
51 /** Extremely large memory limit - not recommended for standard scripts */
52 define('MEMORY_HUGE', -4);
54 /**
55  * Base Moodle Exception class
56  *
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).
59  *
60  * @package    core
61  * @subpackage lib
62  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
63  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
64  */
65 class moodle_exception extends Exception {
67     /**
68      * @var string The name of the string from error.php to print
69      */
70     public $errorcode;
72     /**
73      * @var string The name of module
74      */
75     public $module;
77     /**
78      * @var mixed Extra words and phrases that might be required in the error string
79      */
80     public $a;
82     /**
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.
84      */
85     public $link;
87     /**
88      * @var string Optional information to aid the debugging process
89      */
90     public $debuginfo;
92     /**
93      * Constructor
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
99      */
100     function __construct($errorcode, $module='', $link='', $a=NULL, $debuginfo=null) {
101         global $CFG;
103         if (empty($module) || $module == 'moodle' || $module == 'core') {
104             $module = 'error';
105         }
107         $this->errorcode = $errorcode;
108         $this->module    = $module;
109         $this->link      = $link;
110         $this->a         = $a;
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;
116         } else {
117             $message = $module . '/' . $errorcode;
118             $haserrorstring = false;
119         }
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
127         );
129         if ($debuginfo) {
130             if ($isinphpunittest || $hasdebugdeveloper) {
131                 $message = "$message ($debuginfo)";
132             }
133         }
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);
140         }
142         parent::__construct($message, 0);
143     }
146 /**
147  * Course/activity access exception.
148  *
149  * This exception is thrown from require_login()
150  *
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
154  */
155 class require_login_exception extends moodle_exception {
156     /**
157      * Constructor
158      * @param string $debuginfo Information to aid the debugging process
159      */
160     function __construct($debuginfo) {
161         parent::__construct('requireloginerror', 'error', '', NULL, $debuginfo);
162     }
165 /**
166  * Session timeout exception.
167  *
168  * This exception is thrown from require_login()
169  *
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
173  */
174 class require_login_session_timeout_exception extends require_login_exception {
175     /**
176      * Constructor
177      */
178     public function __construct() {
179         moodle_exception::__construct('sessionerroruser', 'error');
180     }
183 /**
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
188  */
189 class webservice_parameter_exception extends moodle_exception {
190     /**
191      * Constructor
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
195      */
196     function __construct($errorcode=null, $a = '', $debuginfo = null) {
197         parent::__construct($errorcode, 'webservice', '', $a, $debuginfo);
198     }
201 /**
202  * Exceptions indicating user does not have permissions to do something
203  * and the execution can not continue.
204  *
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
208  */
209 class required_capability_exception extends moodle_exception {
210     /**
211      * Constructor
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
216      */
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();
223         } else {
224             $link = $context->get_url();
225         }
226         parent::__construct($errormessage, $stringfile, $link, $capabilityname);
227     }
230 /**
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.
233  *
234  * @package    core
235  * @subpackage lib
236  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
237  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
238  */
239 class coding_exception extends moodle_exception {
240     /**
241      * Constructor
242      * @param string $hint short description of problem
243      * @param string $debuginfo detailed information how to fix problem
244      */
245     function __construct($hint, $debuginfo=null) {
246         parent::__construct('codingerror', 'debug', '', $hint, $debuginfo);
247     }
250 /**
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.
255  *
256  * @package    core
257  * @subpackage lib
258  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
259  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
260  */
261 class invalid_parameter_exception extends moodle_exception {
262     /**
263      * Constructor
264      * @param string $debuginfo some detailed information
265      */
266     function __construct($debuginfo=null) {
267         parent::__construct('invalidparameter', 'debug', '', null, $debuginfo);
268     }
271 /**
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.
276  */
277 class invalid_response_exception extends moodle_exception {
278     /**
279      * Constructor
280      * @param string $debuginfo some detailed information
281      */
282     function __construct($debuginfo=null) {
283         parent::__construct('invalidresponse', 'debug', '', null, $debuginfo);
284     }
287 /**
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.
293  *
294  * @package    core
295  * @subpackage lib
296  * @copyright  2009 onwards Martin Dougiamas  {@link http://moodle.com}
297  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
298  */
299 class invalid_state_exception extends moodle_exception {
300     /**
301      * Constructor
302      * @param string $hint short description of problem
303      * @param string $debuginfo optional more detailed information
304      */
305     function __construct($hint, $debuginfo=null) {
306         parent::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
307     }
310 /**
311  * An exception that indicates incorrect permissions in $CFG->dataroot
312  *
313  * @package    core
314  * @subpackage lib
315  * @copyright  2010 Petr Skoda {@link http://skodak.org}
316  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
317  */
318 class invalid_dataroot_permissions extends moodle_exception {
319     /**
320      * Constructor
321      * @param string $debuginfo optional more detailed information
322      */
323     function __construct($debuginfo = NULL) {
324         parent::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
325     }
328 /**
329  * An exception that indicates that file can not be served
330  *
331  * @package    core
332  * @subpackage lib
333  * @copyright  2010 Petr Skoda {@link http://skodak.org}
334  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
335  */
336 class file_serving_exception extends moodle_exception {
337     /**
338      * Constructor
339      * @param string $debuginfo optional more detailed information
340      */
341     function __construct($debuginfo = NULL) {
342         parent::__construct('cannotservefile', 'error', '', NULL, $debuginfo);
343     }
346 /**
347  * Default exception handler.
348  *
349  * @param Exception $ex
350  * @return void -does not return. Terminates execution!
351  */
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());
361     }
363     $info = get_exception_info($ex);
365     if (debugging('', DEBUG_MINIMAL)) {
366         $logerrmsg = "Default exception handler: ".$info->message.' Debug: '.$info->debuginfo."\n".format_backtrace($info->backtrace, true);
367         error_log($logerrmsg);
368     }
370     if (is_early_init($info->backtrace)) {
371         echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo, $info->errorcode);
372     } else {
373         try {
374             if ($DB) {
375                 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
376                 $DB->set_debug(0);
377             }
378             if (AJAX_SCRIPT) {
379                 // If we are in an AJAX script we don't want to use PREFERRED_RENDERER_TARGET.
380                 // Because we know we will want to use ajax format.
381                 $renderer = new core_renderer_ajax($PAGE, 'ajax');
382             } else {
383                 $renderer = $OUTPUT;
384             }
385             echo $renderer->fatal_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo,
386                 $info->errorcode);
387         } catch (Exception $e) {
388             $out_ex = $e;
389         } catch (Throwable $e) {
390             // Engine errors in PHP7 throw exceptions of type Throwable (this "catch" will be ignored in PHP5).
391             $out_ex = $e;
392         }
394         if (isset($out_ex)) {
395             // default exception handler MUST not throw any exceptions!!
396             // 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
397             // so we just print at least something instead of "Exception thrown without a stack frame in Unknown on line 0":-(
398             if (CLI_SCRIPT or AJAX_SCRIPT) {
399                 // just ignore the error and send something back using the safest method
400                 echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo, $info->errorcode);
401             } else {
402                 echo bootstrap_renderer::early_error_content($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
403                 $outinfo = get_exception_info($out_ex);
404                 echo bootstrap_renderer::early_error_content($outinfo->message, $outinfo->moreinfourl, $outinfo->link, $outinfo->backtrace, $outinfo->debuginfo);
405             }
406         }
407     }
409     exit(1); // General error code
412 /**
413  * Default error handler, prevents some white screens.
414  * @param int $errno
415  * @param string $errstr
416  * @param string $errfile
417  * @param int $errline
418  * @param array $errcontext
419  * @return bool false means use default error handler
420  */
421 function default_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
422     if ($errno == 4096) {
423         //fatal catchable error
424         throw new coding_exception('PHP catchable fatal error', $errstr);
425     }
426     return false;
429 /**
430  * Unconditionally abort all database transactions, this function
431  * should be called from exception handlers only.
432  * @return void
433  */
434 function abort_all_db_transactions() {
435     global $CFG, $DB, $SCRIPT;
437     // default exception handler MUST not throw any exceptions!!
439     if ($DB && $DB->is_transaction_started()) {
440         error_log('Database transaction aborted automatically in ' . $CFG->dirroot . $SCRIPT);
441         // note: transaction blocks should never change current $_SESSION
442         $DB->force_transaction_rollback();
443     }
446 /**
447  * This function encapsulates the tests for whether an exception was thrown in
448  * early init -- either during setup.php or during init of $OUTPUT.
449  *
450  * If another exception is thrown then, and if we do not take special measures,
451  * we would just get a very cryptic message "Exception thrown without a stack
452  * frame in Unknown on line 0". That makes debugging very hard, so we do take
453  * special measures in default_exception_handler, with the help of this function.
454  *
455  * @param array $backtrace the stack trace to analyse.
456  * @return boolean whether the stack trace is somewhere in output initialisation.
457  */
458 function is_early_init($backtrace) {
459     $dangerouscode = array(
460         array('function' => 'header', 'type' => '->'),
461         array('class' => 'bootstrap_renderer'),
462         array('file' => __DIR__.'/setup.php'),
463     );
464     foreach ($backtrace as $stackframe) {
465         foreach ($dangerouscode as $pattern) {
466             $matches = true;
467             foreach ($pattern as $property => $value) {
468                 if (!isset($stackframe[$property]) || $stackframe[$property] != $value) {
469                     $matches = false;
470                 }
471             }
472             if ($matches) {
473                 return true;
474             }
475         }
476     }
477     return false;
480 /**
481  * Abort execution by throwing of a general exception,
482  * default exception handler displays the error message in most cases.
483  *
484  * @param string $errorcode The name of the language string containing the error message.
485  *      Normally this should be in the error.php lang file.
486  * @param string $module The language file to get the error message from.
487  * @param string $link The url where the user will be prompted to continue.
488  *      If no url is provided the user will be directed to the site index page.
489  * @param object $a Extra words and phrases that might be required in the error string
490  * @param string $debuginfo optional debugging information
491  * @return void, always throws exception!
492  */
493 function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
494     throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
497 /**
498  * Returns detailed information about specified exception.
499  * @param exception $ex
500  * @return object
501  */
502 function get_exception_info($ex) {
503     global $CFG, $DB, $SESSION;
505     if ($ex instanceof moodle_exception) {
506         $errorcode = $ex->errorcode;
507         $module = $ex->module;
508         $a = $ex->a;
509         $link = $ex->link;
510         $debuginfo = $ex->debuginfo;
511     } else {
512         $errorcode = 'generalexceptionmessage';
513         $module = 'error';
514         $a = $ex->getMessage();
515         $link = '';
516         $debuginfo = '';
517     }
519     // Append the error code to the debug info to make grepping and googling easier
520     $debuginfo .= PHP_EOL."Error code: $errorcode";
522     $backtrace = $ex->getTrace();
523     $place = array('file'=>$ex->getFile(), 'line'=>$ex->getLine(), 'exception'=>get_class($ex));
524     array_unshift($backtrace, $place);
526     // Be careful, no guarantee moodlelib.php is loaded.
527     if (empty($module) || $module == 'moodle' || $module == 'core') {
528         $module = 'error';
529     }
530     // Search for the $errorcode's associated string
531     // If not found, append the contents of $a to $debuginfo so helpful information isn't lost
532     if (function_exists('get_string_manager')) {
533         if (get_string_manager()->string_exists($errorcode, $module)) {
534             $message = get_string($errorcode, $module, $a);
535         } elseif ($module == 'error' && get_string_manager()->string_exists($errorcode, 'moodle')) {
536             // Search in moodle file if error specified - needed for backwards compatibility
537             $message = get_string($errorcode, 'moodle', $a);
538         } else {
539             $message = $module . '/' . $errorcode;
540             $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
541         }
542     } else {
543         $message = $module . '/' . $errorcode;
544         $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
545     }
547     // Remove some absolute paths from message and debugging info.
548     $searches = array();
549     $replaces = array();
550     $cfgnames = array('tempdir', 'cachedir', 'localcachedir', 'themedir', 'dataroot', 'dirroot');
551     foreach ($cfgnames as $cfgname) {
552         if (property_exists($CFG, $cfgname)) {
553             $searches[] = $CFG->$cfgname;
554             $replaces[] = "[$cfgname]";
555         }
556     }
557     if (!empty($searches)) {
558         $message   = str_replace($searches, $replaces, $message);
559         $debuginfo = str_replace($searches, $replaces, $debuginfo);
560     }
562     // Be careful, no guarantee weblib.php is loaded.
563     if (function_exists('clean_text')) {
564         $message = clean_text($message);
565     } else {
566         $message = htmlspecialchars($message);
567     }
569     if (!empty($CFG->errordocroot)) {
570         $errordoclink = $CFG->errordocroot . '/en/';
571     } else {
572         $errordoclink = get_docs_url();
573     }
575     if ($module === 'error') {
576         $modulelink = 'moodle';
577     } else {
578         $modulelink = $module;
579     }
580     $moreinfourl = $errordoclink . 'error/' . $modulelink . '/' . $errorcode;
582     if (empty($link)) {
583         if (!empty($SESSION->fromurl)) {
584             $link = $SESSION->fromurl;
585             unset($SESSION->fromurl);
586         } else {
587             $link = $CFG->wwwroot .'/';
588         }
589     }
591     // When printing an error the continue button should never link offsite.
592     // We cannot use clean_param() here as it is not guaranteed that it has been loaded yet.
593     if (stripos($link, $CFG->wwwroot) === 0) {
594         // Internal HTTP, all good.
595     } else {
596         // External link spotted!
597         $link = $CFG->wwwroot . '/';
598     }
600     $info = new stdClass();
601     $info->message     = $message;
602     $info->errorcode   = $errorcode;
603     $info->backtrace   = $backtrace;
604     $info->link        = $link;
605     $info->moreinfourl = $moreinfourl;
606     $info->a           = $a;
607     $info->debuginfo   = $debuginfo;
609     return $info;
612 /**
613  * Generate a uuid.
614  *
615  * Unique is hard. Very hard. Attempt to use the PECL UUID functions if available, and if not then revert to
616  * constructing the uuid using mt_rand.
617  *
618  * It is important that this token is not solely based on time as this could lead
619  * to duplicates in a clustered environment (especially on VMs due to poor time precision).
620  *
621  * @return string The uuid.
622  */
623 function generate_uuid() {
624     $uuid = '';
626     if (function_exists("uuid_create")) {
627         $context = null;
628         uuid_create($context);
630         uuid_make($context, UUID_MAKE_V4);
631         uuid_export($context, UUID_FMT_STR, $uuid);
632     } else {
633         // Fallback uuid generation based on:
634         // "http://www.php.net/manual/en/function.uniqid.php#94959".
635         $uuid = sprintf('%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
637             // 32 bits for "time_low".
638             mt_rand(0, 0xffff), mt_rand(0, 0xffff),
640             // 16 bits for "time_mid".
641             mt_rand(0, 0xffff),
643             // 16 bits for "time_hi_and_version",
644             // four most significant bits holds version number 4.
645             mt_rand(0, 0x0fff) | 0x4000,
647             // 16 bits, 8 bits for "clk_seq_hi_res",
648             // 8 bits for "clk_seq_low",
649             // two most significant bits holds zero and one for variant DCE1.1.
650             mt_rand(0, 0x3fff) | 0x8000,
652             // 48 bits for "node".
653             mt_rand(0, 0xffff), mt_rand(0, 0xffff), mt_rand(0, 0xffff));
654     }
655     return trim($uuid);
658 /**
659  * Returns the Moodle Docs URL in the users language for a given 'More help' link.
660  *
661  * There are three cases:
662  *
663  * 1. In the normal case, $path will be a short relative path 'component/thing',
664  * like 'mod/folder/view' 'group/import'. This gets turned into an link to
665  * MoodleDocs in the user's language, and for the appropriate Moodle version.
666  * E.g. 'group/import' may become 'http://docs.moodle.org/2x/en/group/import'.
667  * The 'http://docs.moodle.org' bit comes from $CFG->docroot.
668  *
669  * This is the only option that should be used in standard Moodle code. The other
670  * two options have been implemented because they are useful for third-party plugins.
671  *
672  * 2. $path may be an absolute URL, starting http:// or https://. In this case,
673  * the link is used as is.
674  *
675  * 3. $path may start %%WWWROOT%%, in which case that is replaced by
676  * $CFG->wwwroot to make the link.
677  *
678  * @param string $path the place to link to. See above for details.
679  * @return string The MoodleDocs URL in the user's language. for example @link http://docs.moodle.org/2x/en/$path}
680  */
681 function get_docs_url($path = null) {
682     global $CFG;
684     // Absolute URLs are used unmodified.
685     if (substr($path, 0, 7) === 'http://' || substr($path, 0, 8) === 'https://') {
686         return $path;
687     }
689     // Paths starting %%WWWROOT%% have that replaced by $CFG->wwwroot.
690     if (substr($path, 0, 11) === '%%WWWROOT%%') {
691         return $CFG->wwwroot . substr($path, 11);
692     }
694     // Otherwise we do the normal case, and construct a MoodleDocs URL relative to $CFG->docroot.
696     // Check that $CFG->branch has been set up, during installation it won't be.
697     if (empty($CFG->branch)) {
698         // It's not there yet so look at version.php.
699         include($CFG->dirroot.'/version.php');
700     } else {
701         // We can use $CFG->branch and avoid having to include version.php.
702         $branch = $CFG->branch;
703     }
704     // ensure branch is valid.
705     if (!$branch) {
706         // We should never get here but in case we do lets set $branch to .
707         // the smart one's will know that this is the current directory
708         // and the smarter ones will know that there is some smart matching
709         // that will ensure people end up at the latest version of the docs.
710         $branch = '.';
711     }
712     if (empty($CFG->doclang)) {
713         $lang = current_language();
714     } else {
715         $lang = $CFG->doclang;
716     }
717     $end = '/' . $branch . '/' . $lang . '/' . $path;
718     if (empty($CFG->docroot)) {
719         return 'http://docs.moodle.org'. $end;
720     } else {
721         return $CFG->docroot . $end ;
722     }
725 /**
726  * Formats a backtrace ready for output.
727  *
728  * This function does not include function arguments because they could contain sensitive information
729  * not suitable to be exposed in a response.
730  *
731  * @param array $callers backtrace array, as returned by debug_backtrace().
732  * @param boolean $plaintext if false, generates HTML, if true generates plain text.
733  * @return string formatted backtrace, ready for output.
734  */
735 function format_backtrace($callers, $plaintext = false) {
736     // do not use $CFG->dirroot because it might not be available in destructors
737     $dirroot = dirname(__DIR__);
739     if (empty($callers)) {
740         return '';
741     }
743     $from = $plaintext ? '' : '<ul style="text-align: left" data-rel="backtrace">';
744     foreach ($callers as $caller) {
745         if (!isset($caller['line'])) {
746             $caller['line'] = '?'; // probably call_user_func()
747         }
748         if (!isset($caller['file'])) {
749             $caller['file'] = 'unknownfile'; // probably call_user_func()
750         }
751         $from .= $plaintext ? '* ' : '<li>';
752         $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
753         if (isset($caller['function'])) {
754             $from .= ': call to ';
755             if (isset($caller['class'])) {
756                 $from .= $caller['class'] . $caller['type'];
757             }
758             $from .= $caller['function'] . '()';
759         } else if (isset($caller['exception'])) {
760             $from .= ': '.$caller['exception'].' thrown';
761         }
762         $from .= $plaintext ? "\n" : '</li>';
763     }
764     $from .= $plaintext ? '' : '</ul>';
766     return $from;
769 /**
770  * This function makes the return value of ini_get consistent if you are
771  * setting server directives through the .htaccess file in apache.
772  *
773  * Current behavior for value set from php.ini On = 1, Off = [blank]
774  * Current behavior for value set from .htaccess On = On, Off = Off
775  * Contributed by jdell @ unr.edu
776  *
777  * @param string $ini_get_arg The argument to get
778  * @return bool True for on false for not
779  */
780 function ini_get_bool($ini_get_arg) {
781     $temp = ini_get($ini_get_arg);
783     if ($temp == '1' or strtolower($temp) == 'on') {
784         return true;
785     }
786     return false;
789 /**
790  * This function verifies the sanity of PHP configuration
791  * and stops execution if anything critical found.
792  */
793 function setup_validate_php_configuration() {
794    // this must be very fast - no slow checks here!!!
796    if (ini_get_bool('session.auto_start')) {
797        print_error('sessionautostartwarning', 'admin');
798    }
801 /**
802  * Initialise global $CFG variable.
803  * @private to be used only from lib/setup.php
804  */
805 function initialise_cfg() {
806     global $CFG, $DB;
808     if (!$DB) {
809         // This should not happen.
810         return;
811     }
813     try {
814         $localcfg = get_config('core');
815     } catch (dml_exception $e) {
816         // Most probably empty db, going to install soon.
817         return;
818     }
820     foreach ($localcfg as $name => $value) {
821         // Note that get_config() keeps forced settings
822         // and normalises values to string if possible.
823         $CFG->{$name} = $value;
824     }
827 /**
828  * Initialises $FULLME and friends. Private function. Should only be called from
829  * setup.php.
830  */
831 function initialise_fullme() {
832     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
834     // Detect common config error.
835     if (substr($CFG->wwwroot, -1) == '/') {
836         print_error('wwwrootslash', 'error');
837     }
839     if (CLI_SCRIPT) {
840         initialise_fullme_cli();
841         return;
842     }
843     if (!empty($CFG->overridetossl)) {
844         if (strpos($CFG->wwwroot, 'http://') === 0) {
845             $CFG->wwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
846         } else {
847             unset_config('overridetossl');
848         }
849     }
851     $rurl = setup_get_remote_url();
852     $wwwroot = parse_url($CFG->wwwroot.'/');
854     if (empty($rurl['host'])) {
855         // missing host in request header, probably not a real browser, let's ignore them
857     } else if (!empty($CFG->reverseproxy)) {
858         // $CFG->reverseproxy specifies if reverse proxy server used
859         // Used in load balancing scenarios.
860         // Do not abuse this to try to solve lan/wan access problems!!!!!
862     } else {
863         if (($rurl['host'] !== $wwwroot['host']) or
864                 (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port']) or
865                 (strpos($rurl['path'], $wwwroot['path']) !== 0)) {
867             // Explain the problem and redirect them to the right URL
868             if (!defined('NO_MOODLE_COOKIES')) {
869                 define('NO_MOODLE_COOKIES', true);
870             }
871             // The login/token.php script should call the correct url/port.
872             if (defined('REQUIRE_CORRECT_ACCESS') && REQUIRE_CORRECT_ACCESS) {
873                 $wwwrootport = empty($wwwroot['port'])?'':$wwwroot['port'];
874                 $calledurl = $rurl['host'];
875                 if (!empty($rurl['port'])) {
876                     $calledurl .=  ':'. $rurl['port'];
877                 }
878                 $correcturl = $wwwroot['host'];
879                 if (!empty($wwwrootport)) {
880                     $correcturl .=  ':'. $wwwrootport;
881                 }
882                 throw new moodle_exception('requirecorrectaccess', 'error', '', null,
883                     'You called ' . $calledurl .', you should have called ' . $correcturl);
884             }
885             redirect($CFG->wwwroot, get_string('wwwrootmismatch', 'error', $CFG->wwwroot), 3);
886         }
887     }
889     // Check that URL is under $CFG->wwwroot.
890     if (strpos($rurl['path'], $wwwroot['path']) === 0) {
891         $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
892     } else {
893         // Probably some weird external script
894         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
895         return;
896     }
898     // $CFG->sslproxy specifies if external SSL appliance is used
899     // (That is, the Moodle server uses http, with an external box translating everything to https).
900     if (empty($CFG->sslproxy)) {
901         if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
902             if (defined('REQUIRE_CORRECT_ACCESS') && REQUIRE_CORRECT_ACCESS) {
903                 print_error('sslonlyaccess', 'error');
904             } else {
905                 redirect($CFG->wwwroot, get_string('wwwrootmismatch', 'error', $CFG->wwwroot), 3);
906             }
907         }
908     } else {
909         if ($wwwroot['scheme'] !== 'https') {
910             throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
911         }
912         $rurl['scheme'] = 'https'; // make moodle believe it runs on https, squid or something else it doing it
913         $_SERVER['HTTPS'] = 'on'; // Override $_SERVER to help external libraries with their HTTPS detection.
914         $_SERVER['SERVER_PORT'] = 443; // Assume default ssl port for the proxy.
915     }
917     // hopefully this will stop all those "clever" admins trying to set up moodle
918     // with two different addresses in intranet and Internet
919     if (!empty($CFG->reverseproxy) && $rurl['host'] === $wwwroot['host']) {
920         print_error('reverseproxyabused', 'error');
921     }
923     $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
924     if (!empty($wwwroot['port'])) {
925         $hostandport .= ':'.$wwwroot['port'];
926     }
928     $FULLSCRIPT = $hostandport . $rurl['path'];
929     $FULLME = $hostandport . $rurl['fullpath'];
930     $ME = $rurl['fullpath'];
933 /**
934  * Initialises $FULLME and friends for command line scripts.
935  * This is a private method for use by initialise_fullme.
936  */
937 function initialise_fullme_cli() {
938     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
940     // Urls do not make much sense in CLI scripts
941     $backtrace = debug_backtrace();
942     $topfile = array_pop($backtrace);
943     $topfile = realpath($topfile['file']);
944     $dirroot = realpath($CFG->dirroot);
946     if (strpos($topfile, $dirroot) !== 0) {
947         // Probably some weird external script
948         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
949     } else {
950         $relativefile = substr($topfile, strlen($dirroot));
951         $relativefile = str_replace('\\', '/', $relativefile); // Win fix
952         $SCRIPT = $FULLSCRIPT = $relativefile;
953         $FULLME = $ME = null;
954     }
957 /**
958  * Get the URL that PHP/the web server thinks it is serving. Private function
959  * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
960  * @return array in the same format that parse_url returns, with the addition of
961  *      a 'fullpath' element, which includes any slasharguments path.
962  */
963 function setup_get_remote_url() {
964     $rurl = array();
965     if (isset($_SERVER['HTTP_HOST'])) {
966         list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
967     } else {
968         $rurl['host'] = null;
969     }
970     $rurl['port'] = $_SERVER['SERVER_PORT'];
971     $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
972     $rurl['scheme'] = (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] === 'off' or $_SERVER['HTTPS'] === 'Off' or $_SERVER['HTTPS'] === 'OFF') ? 'http' : 'https';
974     if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
975         //Apache server
976         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
978         // Fixing a known issue with:
979         // - Apache versions lesser than 2.4.11
980         // - PHP deployed in Apache as PHP-FPM via mod_proxy_fcgi
981         // - PHP versions lesser than 5.6.3 and 5.5.18.
982         if (isset($_SERVER['PATH_INFO']) && (php_sapi_name() === 'fpm-fcgi') && isset($_SERVER['SCRIPT_NAME'])) {
983             $pathinfodec = rawurldecode($_SERVER['PATH_INFO']);
984             $lenneedle = strlen($pathinfodec);
985             // Checks whether SCRIPT_NAME ends with PATH_INFO, URL-decoded.
986             if (substr($_SERVER['SCRIPT_NAME'], -$lenneedle) === $pathinfodec) {
987                 // This is the "Apache 2.4.10- running PHP-FPM via mod_proxy_fcgi" fingerprint,
988                 // 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)
989                 // => SCRIPT_NAME contains 'slash arguments' data too, which is wrongly exposed via PATH_INFO as URL-encoded.
990                 // Fix both $_SERVER['PATH_INFO'] and $_SERVER['SCRIPT_NAME'].
991                 $lenhaystack = strlen($_SERVER['SCRIPT_NAME']);
992                 $pos = $lenhaystack - $lenneedle;
993                 // Here $pos is greater than 0 but let's double check it.
994                 if ($pos > 0) {
995                     $_SERVER['PATH_INFO'] = $pathinfodec;
996                     $_SERVER['SCRIPT_NAME'] = substr($_SERVER['SCRIPT_NAME'], 0, $pos);
997                 }
998             }
999         }
1001     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
1002         //IIS - needs a lot of tweaking to make it work
1003         $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
1005         // NOTE: we should ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS.
1006         //       Since 2.0, we rely on IIS rewrite extensions like Helicon ISAPI_rewrite
1007         //         example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
1008         //       OR
1009         //       we rely on a proper IIS 6.0+ configuration: the 'FastCGIUtf8ServerVariables' registry key.
1010         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
1011             // Check that PATH_INFO works == must not contain the script name.
1012             if (strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === false) {
1013                 $rurl['fullpath'] .= clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
1014             }
1015         }
1017         if (isset($_SERVER['QUERY_STRING']) and $_SERVER['QUERY_STRING'] !== '') {
1018             $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
1019         }
1020         $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
1022 /* NOTE: following servers are not fully tested! */
1024     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
1025         //lighttpd - not officially supported
1026         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1028     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
1029         //nginx - not officially supported
1030         if (!isset($_SERVER['SCRIPT_NAME'])) {
1031             die('Invalid server configuration detected, please try to add "fastcgi_param SCRIPT_NAME $fastcgi_script_name;" to the nginx server configuration.');
1032         }
1033         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1035      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
1036          //cherokee - not officially supported
1037          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1039      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
1040          //zeus - not officially supported
1041          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1043     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
1044         //LiteSpeed - not officially supported
1045         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1047     } else if ($_SERVER['SERVER_SOFTWARE'] === 'HTTPD') {
1048         //obscure name found on some servers - this is definitely not supported
1049         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1051     } else if (strpos($_SERVER['SERVER_SOFTWARE'], 'PHP') === 0) {
1052         // built-in PHP Development Server
1053         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
1055     } else {
1056         throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
1057     }
1059     // sanitize the url a bit more, the encoding style may be different in vars above
1060     $rurl['fullpath'] = str_replace('"', '%22', $rurl['fullpath']);
1061     $rurl['fullpath'] = str_replace('\'', '%27', $rurl['fullpath']);
1063     return $rurl;
1066 /**
1067  * Try to work around the 'max_input_vars' restriction if necessary.
1068  */
1069 function workaround_max_input_vars() {
1070     // Make sure this gets executed only once from lib/setup.php!
1071     static $executed = false;
1072     if ($executed) {
1073         debugging('workaround_max_input_vars() must be called only once!');
1074         return;
1075     }
1076     $executed = true;
1078     if (!isset($_SERVER["CONTENT_TYPE"]) or strpos($_SERVER["CONTENT_TYPE"], 'multipart/form-data') !== false) {
1079         // Not a post or 'multipart/form-data' which is not compatible with "php://input" reading.
1080         return;
1081     }
1083     if (!isloggedin() or isguestuser()) {
1084         // Only real users post huge forms.
1085         return;
1086     }
1088     $max = (int)ini_get('max_input_vars');
1090     if ($max <= 0) {
1091         // Most probably PHP < 5.3.9 that does not implement this limit.
1092         return;
1093     }
1095     if ($max >= 200000) {
1096         // This value should be ok for all our forms, by setting it in php.ini
1097         // admins may prevent any unexpected regressions caused by this hack.
1099         // Note there is no need to worry about DDoS caused by making this limit very high
1100         // because there are very many easier ways to DDoS any Moodle server.
1101         return;
1102     }
1104     // Worst case is advanced checkboxes which use up to two max_input_vars
1105     // slots for each entry in $_POST, because of sending two fields with the
1106     // same name. So count everything twice just in case.
1107     if (count($_POST, COUNT_RECURSIVE) * 2 < $max) {
1108         return;
1109     }
1111     // Large POST request with enctype supported by php://input.
1112     // Parse php://input in chunks to bypass max_input_vars limit, which also applies to parse_str().
1113     $str = file_get_contents("php://input");
1114     if ($str === false or $str === '') {
1115         // Some weird error.
1116         return;
1117     }
1119     $delim = '&';
1120     $fun = function($p) use ($delim) {
1121         return implode($delim, $p);
1122     };
1123     $chunks = array_map($fun, array_chunk(explode($delim, $str), $max));
1125     // Clear everything from existing $_POST array, otherwise it might be included
1126     // twice (this affects array params primarily).
1127     foreach ($_POST as $key => $value) {
1128         unset($_POST[$key]);
1129         // Also clear from request array - but only the things that are in $_POST,
1130         // that way it will leave the things from a get request if any.
1131         unset($_REQUEST[$key]);
1132     }
1134     foreach ($chunks as $chunk) {
1135         $values = array();
1136         parse_str($chunk, $values);
1138         merge_query_params($_POST, $values);
1139         merge_query_params($_REQUEST, $values);
1140     }
1143 /**
1144  * Merge parsed POST chunks.
1145  *
1146  * NOTE: this is not perfect, but it should work in most cases hopefully.
1147  *
1148  * @param array $target
1149  * @param array $values
1150  */
1151 function merge_query_params(array &$target, array $values) {
1152     if (isset($values[0]) and isset($target[0])) {
1153         // This looks like a split [] array, lets verify the keys are continuous starting with 0.
1154         $keys1 = array_keys($values);
1155         $keys2 = array_keys($target);
1156         if ($keys1 === array_keys($keys1) and $keys2 === array_keys($keys2)) {
1157             foreach ($values as $v) {
1158                 $target[] = $v;
1159             }
1160             return;
1161         }
1162     }
1163     foreach ($values as $k => $v) {
1164         if (!isset($target[$k])) {
1165             $target[$k] = $v;
1166             continue;
1167         }
1168         if (is_array($target[$k]) and is_array($v)) {
1169             merge_query_params($target[$k], $v);
1170             continue;
1171         }
1172         // We should not get here unless there are duplicates in params.
1173         $target[$k] = $v;
1174     }
1177 /**
1178  * Initializes our performance info early.
1179  *
1180  * Pairs up with get_performance_info() which is actually
1181  * in moodlelib.php. This function is here so that we can
1182  * call it before all the libs are pulled in.
1183  *
1184  * @uses $PERF
1185  */
1186 function init_performance_info() {
1188     global $PERF, $CFG, $USER;
1190     $PERF = new stdClass();
1191     $PERF->logwrites = 0;
1192     if (function_exists('microtime')) {
1193         $PERF->starttime = microtime();
1194     }
1195     if (function_exists('memory_get_usage')) {
1196         $PERF->startmemory = memory_get_usage();
1197     }
1198     if (function_exists('posix_times')) {
1199         $PERF->startposixtimes = posix_times();
1200     }
1203 /**
1204  * Indicates whether we are in the middle of the initial Moodle install.
1205  *
1206  * Very occasionally it is necessary avoid running certain bits of code before the
1207  * Moodle installation has completed. The installed flag is set in admin/index.php
1208  * after Moodle core and all the plugins have been installed, but just before
1209  * the person doing the initial install is asked to choose the admin password.
1210  *
1211  * @return boolean true if the initial install is not complete.
1212  */
1213 function during_initial_install() {
1214     global $CFG;
1215     return empty($CFG->rolesactive);
1218 /**
1219  * Function to raise the memory limit to a new value.
1220  * Will respect the memory limit if it is higher, thus allowing
1221  * settings in php.ini, apache conf or command line switches
1222  * to override it.
1223  *
1224  * The memory limit should be expressed with a constant
1225  * MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE.
1226  * It is possible to use strings or integers too (eg:'128M').
1227  *
1228  * @param mixed $newlimit the new memory limit
1229  * @return bool success
1230  */
1231 function raise_memory_limit($newlimit) {
1232     global $CFG;
1234     if ($newlimit == MEMORY_UNLIMITED) {
1235         ini_set('memory_limit', -1);
1236         return true;
1238     } else if ($newlimit == MEMORY_STANDARD) {
1239         if (PHP_INT_SIZE > 4) {
1240             $newlimit = get_real_size('128M'); // 64bit needs more memory
1241         } else {
1242             $newlimit = get_real_size('96M');
1243         }
1245     } else if ($newlimit == MEMORY_EXTRA) {
1246         if (PHP_INT_SIZE > 4) {
1247             $newlimit = get_real_size('384M'); // 64bit needs more memory
1248         } else {
1249             $newlimit = get_real_size('256M');
1250         }
1251         if (!empty($CFG->extramemorylimit)) {
1252             $extra = get_real_size($CFG->extramemorylimit);
1253             if ($extra > $newlimit) {
1254                 $newlimit = $extra;
1255             }
1256         }
1258     } else if ($newlimit == MEMORY_HUGE) {
1259         // MEMORY_HUGE uses 2G or MEMORY_EXTRA, whichever is bigger.
1260         $newlimit = get_real_size('2G');
1261         if (!empty($CFG->extramemorylimit)) {
1262             $extra = get_real_size($CFG->extramemorylimit);
1263             if ($extra > $newlimit) {
1264                 $newlimit = $extra;
1265             }
1266         }
1268     } else {
1269         $newlimit = get_real_size($newlimit);
1270     }
1272     if ($newlimit <= 0) {
1273         debugging('Invalid memory limit specified.');
1274         return false;
1275     }
1277     $cur = ini_get('memory_limit');
1278     if (empty($cur)) {
1279         // if php is compiled without --enable-memory-limits
1280         // apparently memory_limit is set to ''
1281         $cur = 0;
1282     } else {
1283         if ($cur == -1){
1284             return true; // unlimited mem!
1285         }
1286         $cur = get_real_size($cur);
1287     }
1289     if ($newlimit > $cur) {
1290         ini_set('memory_limit', $newlimit);
1291         return true;
1292     }
1293     return false;
1296 /**
1297  * Function to reduce the memory limit to a new value.
1298  * Will respect the memory limit if it is lower, thus allowing
1299  * settings in php.ini, apache conf or command line switches
1300  * to override it
1301  *
1302  * The memory limit should be expressed with a string (eg:'64M')
1303  *
1304  * @param string $newlimit the new memory limit
1305  * @return bool
1306  */
1307 function reduce_memory_limit($newlimit) {
1308     if (empty($newlimit)) {
1309         return false;
1310     }
1311     $cur = ini_get('memory_limit');
1312     if (empty($cur)) {
1313         // if php is compiled without --enable-memory-limits
1314         // apparently memory_limit is set to ''
1315         $cur = 0;
1316     } else {
1317         if ($cur == -1){
1318             return true; // unlimited mem!
1319         }
1320         $cur = get_real_size($cur);
1321     }
1323     $new = get_real_size($newlimit);
1324     // -1 is smaller, but it means unlimited
1325     if ($new < $cur && $new != -1) {
1326         ini_set('memory_limit', $newlimit);
1327         return true;
1328     }
1329     return false;
1332 /**
1333  * Converts numbers like 10M into bytes.
1334  *
1335  * @param string $size The size to be converted
1336  * @return int
1337  */
1338 function get_real_size($size = 0) {
1339     if (!$size) {
1340         return 0;
1341     }
1343     static $binaryprefixes = array(
1344         'K' => 1024,
1345         'k' => 1024,
1346         'M' => 1048576,
1347         'm' => 1048576,
1348         'G' => 1073741824,
1349         'g' => 1073741824,
1350         'T' => 1099511627776,
1351         't' => 1099511627776,
1352     );
1354     if (preg_match('/^([0-9]+)([KMGT])/i', $size, $matches)) {
1355         return $matches[1] * $binaryprefixes[$matches[2]];
1356     }
1358     return (int) $size;
1361 /**
1362  * Try to disable all output buffering and purge
1363  * all headers.
1364  *
1365  * @access private to be called only from lib/setup.php !
1366  * @return void
1367  */
1368 function disable_output_buffering() {
1369     $olddebug = error_reporting(0);
1371     // disable compression, it would prevent closing of buffers
1372     if (ini_get_bool('zlib.output_compression')) {
1373         ini_set('zlib.output_compression', 'Off');
1374     }
1376     // try to flush everything all the time
1377     ob_implicit_flush(true);
1379     // close all buffers if possible and discard any existing output
1380     // this can actually work around some whitespace problems in config.php
1381     while(ob_get_level()) {
1382         if (!ob_end_clean()) {
1383             // prevent infinite loop when buffer can not be closed
1384             break;
1385         }
1386     }
1388     // disable any other output handlers
1389     ini_set('output_handler', '');
1391     error_reporting($olddebug);
1393     // Disable buffering in nginx.
1394     header('X-Accel-Buffering: no');
1398 /**
1399  * Check whether a major upgrade is needed.
1400  *
1401  * That is defined as an upgrade that changes something really fundamental
1402  * in the database, so nothing can possibly work until the database has
1403  * been updated, and that is defined by the hard-coded version number in
1404  * this function.
1405  *
1406  * @return bool
1407  */
1408 function is_major_upgrade_required() {
1409     global $CFG;
1410     $lastmajordbchanges = 2018111301.00;
1412     $required = empty($CFG->version);
1413     $required = $required || (float)$CFG->version < $lastmajordbchanges;
1414     $required = $required || during_initial_install();
1415     $required = $required || !empty($CFG->adminsetuppending);
1417     return $required;
1420 /**
1421  * Redirect to the Notifications page if a major upgrade is required, and
1422  * terminate the current user session.
1423  */
1424 function redirect_if_major_upgrade_required() {
1425     global $CFG;
1426     if (is_major_upgrade_required()) {
1427         try {
1428             @\core\session\manager::terminate_current();
1429         } catch (Exception $e) {
1430             // Ignore any errors, redirect to upgrade anyway.
1431         }
1432         $url = $CFG->wwwroot . '/' . $CFG->admin . '/index.php';
1433         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
1434         @header('Location: ' . $url);
1435         echo bootstrap_renderer::plain_redirect_message(htmlspecialchars($url));
1436         exit;
1437     }
1440 /**
1441  * Makes sure that upgrade process is not running
1442  *
1443  * To be inserted in the core functions that can not be called by pluigns during upgrade.
1444  * Core upgrade should not use any API functions at all.
1445  * See {@link http://docs.moodle.org/dev/Upgrade_API#Upgrade_code_restrictions}
1446  *
1447  * @throws moodle_exception if executed from inside of upgrade script and $warningonly is false
1448  * @param bool $warningonly if true displays a warning instead of throwing an exception
1449  * @return bool true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only
1450  */
1451 function upgrade_ensure_not_running($warningonly = false) {
1452     global $CFG;
1453     if (!empty($CFG->upgraderunning)) {
1454         if (!$warningonly) {
1455             throw new moodle_exception('cannotexecduringupgrade');
1456         } else {
1457             debugging(get_string('cannotexecduringupgrade', 'error'), DEBUG_DEVELOPER);
1458             return false;
1459         }
1460     }
1461     return true;
1464 /**
1465  * Function to check if a directory exists and by default create it if not exists.
1466  *
1467  * Previously this was accepting paths only from dataroot, but we now allow
1468  * files outside of dataroot if you supply custom paths for some settings in config.php.
1469  * This function does not verify that the directory is writable.
1470  *
1471  * NOTE: this function uses current file stat cache,
1472  *       please use clearstatcache() before this if you expect that the
1473  *       directories may have been removed recently from a different request.
1474  *
1475  * @param string $dir absolute directory path
1476  * @param boolean $create directory if does not exist
1477  * @param boolean $recursive create directory recursively
1478  * @return boolean true if directory exists or created, false otherwise
1479  */
1480 function check_dir_exists($dir, $create = true, $recursive = true) {
1481     global $CFG;
1483     umask($CFG->umaskpermissions);
1485     if (is_dir($dir)) {
1486         return true;
1487     }
1489     if (!$create) {
1490         return false;
1491     }
1493     return mkdir($dir, $CFG->directorypermissions, $recursive);
1496 /**
1497  * Create a new unique directory within the specified directory.
1498  *
1499  * @param string $basedir The directory to create your new unique directory within.
1500  * @param bool $exceptiononerror throw exception if error encountered
1501  * @return string The created directory
1502  * @throws invalid_dataroot_permissions
1503  */
1504 function make_unique_writable_directory($basedir, $exceptiononerror = true) {
1505     if (!is_dir($basedir) || !is_writable($basedir)) {
1506         // The basedir is not writable. We will not be able to create the child directory.
1507         if ($exceptiononerror) {
1508             throw new invalid_dataroot_permissions($basedir . ' is not writable. Unable to create a unique directory within it.');
1509         } else {
1510             return false;
1511         }
1512     }
1514     do {
1515         // Generate a new (hopefully unique) directory name.
1516         $uniquedir = $basedir . DIRECTORY_SEPARATOR . generate_uuid();
1517     } while (
1518             // Ensure that basedir is still writable - if we do not check, we could get stuck in a loop here.
1519             is_writable($basedir) &&
1521             // Make the new unique directory. If the directory already exists, it will return false.
1522             !make_writable_directory($uniquedir, $exceptiononerror) &&
1524             // Ensure that the directory now exists
1525             file_exists($uniquedir) && is_dir($uniquedir)
1526         );
1528     // Check that the directory was correctly created.
1529     if (!file_exists($uniquedir) || !is_dir($uniquedir) || !is_writable($uniquedir)) {
1530         if ($exceptiononerror) {
1531             throw new invalid_dataroot_permissions('Unique directory creation failed.');
1532         } else {
1533             return false;
1534         }
1535     }
1537     return $uniquedir;
1540 /**
1541  * Create a directory and make sure it is writable.
1542  *
1543  * @private
1544  * @param string $dir  the full path of the directory to be created
1545  * @param bool $exceptiononerror throw exception if error encountered
1546  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1547  */
1548 function make_writable_directory($dir, $exceptiononerror = true) {
1549     global $CFG;
1551     if (file_exists($dir) and !is_dir($dir)) {
1552         if ($exceptiononerror) {
1553             throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
1554         } else {
1555             return false;
1556         }
1557     }
1559     umask($CFG->umaskpermissions);
1561     if (!file_exists($dir)) {
1562         if (!@mkdir($dir, $CFG->directorypermissions, true)) {
1563             clearstatcache();
1564             // There might be a race condition when creating directory.
1565             if (!is_dir($dir)) {
1566                 if ($exceptiononerror) {
1567                     throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
1568                 } else {
1569                     debugging('Can not create directory: '.$dir, DEBUG_DEVELOPER);
1570                     return false;
1571                 }
1572             }
1573         }
1574     }
1576     if (!is_writable($dir)) {
1577         if ($exceptiononerror) {
1578             throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
1579         } else {
1580             return false;
1581         }
1582     }
1584     return $dir;
1587 /**
1588  * Protect a directory from web access.
1589  * Could be extended in the future to support other mechanisms (e.g. other webservers).
1590  *
1591  * @private
1592  * @param string $dir  the full path of the directory to be protected
1593  */
1594 function protect_directory($dir) {
1595     global $CFG;
1596     // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
1597     if (!file_exists("$dir/.htaccess")) {
1598         if ($handle = fopen("$dir/.htaccess", 'w')) {   // For safety
1599             @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");
1600             @fclose($handle);
1601             @chmod("$dir/.htaccess", $CFG->filepermissions);
1602         }
1603     }
1606 /**
1607  * Create a directory under dataroot and make sure it is writable.
1608  * Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
1609  *
1610  * @param string $directory  the full path of the directory to be created under $CFG->dataroot
1611  * @param bool $exceptiononerror throw exception if error encountered
1612  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1613  */
1614 function make_upload_directory($directory, $exceptiononerror = true) {
1615     global $CFG;
1617     if (strpos($directory, 'temp/') === 0 or $directory === 'temp') {
1618         debugging('Use make_temp_directory() for creation of temporary directory and $CFG->tempdir to get the location.');
1620     } else if (strpos($directory, 'cache/') === 0 or $directory === 'cache') {
1621         debugging('Use make_cache_directory() for creation of cache directory and $CFG->cachedir to get the location.');
1623     } else if (strpos($directory, 'localcache/') === 0 or $directory === 'localcache') {
1624         debugging('Use make_localcache_directory() for creation of local cache directory and $CFG->localcachedir to get the location.');
1625     }
1627     protect_directory($CFG->dataroot);
1628     return make_writable_directory("$CFG->dataroot/$directory", $exceptiononerror);
1631 /**
1632  * Get a per-request storage directory in the tempdir.
1633  *
1634  * The directory is automatically cleaned up during the shutdown handler.
1635  *
1636  * @param   bool    $exceptiononerror throw exception if error encountered
1637  * @param   bool    $forcecreate Force creation of a new parent directory
1638  * @return  string  Returns full path to directory if successful, false if not; may throw exception
1639  */
1640 function get_request_storage_directory($exceptiononerror = true, bool $forcecreate = false) {
1641     global $CFG;
1643     static $requestdir = null;
1645     $writabledirectoryexists = (null !== $requestdir);
1646     $writabledirectoryexists = $writabledirectoryexists && file_exists($requestdir);
1647     $writabledirectoryexists = $writabledirectoryexists && is_dir($requestdir);
1648     $writabledirectoryexists = $writabledirectoryexists && is_writable($requestdir);
1649     $createnewdirectory = $forcecreate || !$writabledirectoryexists;
1651     if ($createnewdirectory) {
1652         if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1653             check_dir_exists($CFG->localcachedir, true, true);
1654             protect_directory($CFG->localcachedir);
1655         } else {
1656             protect_directory($CFG->dataroot);
1657         }
1659         if ($dir = make_unique_writable_directory($CFG->localcachedir, $exceptiononerror)) {
1660             // Register a shutdown handler to remove the directory.
1661             \core_shutdown_manager::register_function('remove_dir', [$dir]);
1662         }
1664         $requestdir = $dir;
1665     }
1667     return $requestdir;
1670 /**
1671  * Create a per-request directory and make sure it is writable.
1672  * This can only be used during the current request and will be tidied away
1673  * automatically afterwards.
1674  *
1675  * A new, unique directory is always created within a shared base request directory.
1676  *
1677  * In some exceptional cases an alternative base directory may be required. This can be accomplished using the
1678  * $forcecreate parameter. Typically this will only be requried where the file may be required during a shutdown handler
1679  * which may or may not be registered after a previous request directory has been created.
1680  *
1681  * @param   bool    $exceptiononerror throw exception if error encountered
1682  * @param   bool    $forcecreate Force creation of a new parent directory
1683  * @return  string  The full path to directory if successful, false if not; may throw exception
1684  */
1685 function make_request_directory($exceptiononerror = true, bool $forcecreate = false) {
1686     $basedir = get_request_storage_directory($exceptiononerror, $forcecreate);
1687     return make_unique_writable_directory($basedir, $exceptiononerror);
1690 /**
1691  * Get the full path of a directory under $CFG->backuptempdir.
1692  *
1693  * @param string $directory  the relative path of the directory under $CFG->backuptempdir
1694  * @return string|false Returns full path to directory given a valid string; otherwise, false.
1695  */
1696 function get_backup_temp_directory($directory) {
1697     global $CFG;
1698     if (($directory === null) || ($directory === false)) {
1699         return false;
1700     }
1701     return "$CFG->backuptempdir/$directory";
1704 /**
1705  * Create a directory under $CFG->backuptempdir and make sure it is writable.
1706  *
1707  * Do not use for storing generic temp files - see make_temp_directory() instead for this purpose.
1708  *
1709  * Backup temporary files must be on a shared storage.
1710  *
1711  * @param string $directory  the relative path of the directory to be created under $CFG->backuptempdir
1712  * @param bool $exceptiononerror throw exception if error encountered
1713  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1714  */
1715 function make_backup_temp_directory($directory, $exceptiononerror = true) {
1716     global $CFG;
1717     if ($CFG->backuptempdir !== "$CFG->tempdir/backup") {
1718         check_dir_exists($CFG->backuptempdir, true, true);
1719         protect_directory($CFG->backuptempdir);
1720     } else {
1721         protect_directory($CFG->tempdir);
1722     }
1723     return make_writable_directory("$CFG->backuptempdir/$directory", $exceptiononerror);
1726 /**
1727  * Create a directory under tempdir and make sure it is writable.
1728  *
1729  * Where possible, please use make_request_directory() and limit the scope
1730  * of your data to the current HTTP request.
1731  *
1732  * Do not use for storing cache files - see make_cache_directory(), and
1733  * make_localcache_directory() instead for this purpose.
1734  *
1735  * Temporary files must be on a shared storage, and heavy usage is
1736  * discouraged due to the performance impact upon clustered environments.
1737  *
1738  * @param string $directory  the full path of the directory to be created under $CFG->tempdir
1739  * @param bool $exceptiononerror throw exception if error encountered
1740  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1741  */
1742 function make_temp_directory($directory, $exceptiononerror = true) {
1743     global $CFG;
1744     if ($CFG->tempdir !== "$CFG->dataroot/temp") {
1745         check_dir_exists($CFG->tempdir, true, true);
1746         protect_directory($CFG->tempdir);
1747     } else {
1748         protect_directory($CFG->dataroot);
1749     }
1750     return make_writable_directory("$CFG->tempdir/$directory", $exceptiononerror);
1753 /**
1754  * Create a directory under cachedir and make sure it is writable.
1755  *
1756  * Note: this cache directory is shared by all cluster nodes.
1757  *
1758  * @param string $directory  the full path of the directory to be created under $CFG->cachedir
1759  * @param bool $exceptiononerror throw exception if error encountered
1760  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1761  */
1762 function make_cache_directory($directory, $exceptiononerror = true) {
1763     global $CFG;
1764     if ($CFG->cachedir !== "$CFG->dataroot/cache") {
1765         check_dir_exists($CFG->cachedir, true, true);
1766         protect_directory($CFG->cachedir);
1767     } else {
1768         protect_directory($CFG->dataroot);
1769     }
1770     return make_writable_directory("$CFG->cachedir/$directory", $exceptiononerror);
1773 /**
1774  * Create a directory under localcachedir and make sure it is writable.
1775  * The files in this directory MUST NOT change, use revisions or content hashes to
1776  * work around this limitation - this means you can only add new files here.
1777  *
1778  * The content of this directory gets purged automatically on all cluster nodes
1779  * after calling purge_all_caches() before new data is written to this directory.
1780  *
1781  * Note: this local cache directory does not need to be shared by cluster nodes.
1782  *
1783  * @param string $directory the relative path of the directory to be created under $CFG->localcachedir
1784  * @param bool $exceptiononerror throw exception if error encountered
1785  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1786  */
1787 function make_localcache_directory($directory, $exceptiononerror = true) {
1788     global $CFG;
1790     make_writable_directory($CFG->localcachedir, $exceptiononerror);
1792     if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1793         protect_directory($CFG->localcachedir);
1794     } else {
1795         protect_directory($CFG->dataroot);
1796     }
1798     if (!isset($CFG->localcachedirpurged)) {
1799         $CFG->localcachedirpurged = 0;
1800     }
1801     $timestampfile = "$CFG->localcachedir/.lastpurged";
1803     if (!file_exists($timestampfile)) {
1804         touch($timestampfile);
1805         @chmod($timestampfile, $CFG->filepermissions);
1807     } else if (filemtime($timestampfile) <  $CFG->localcachedirpurged) {
1808         // This means our local cached dir was not purged yet.
1809         remove_dir($CFG->localcachedir, true);
1810         if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1811             protect_directory($CFG->localcachedir);
1812         }
1813         touch($timestampfile);
1814         @chmod($timestampfile, $CFG->filepermissions);
1815         clearstatcache();
1816     }
1818     if ($directory === '') {
1819         return $CFG->localcachedir;
1820     }
1822     return make_writable_directory("$CFG->localcachedir/$directory", $exceptiononerror);
1825 /**
1826  * This class solves the problem of how to initialise $OUTPUT.
1827  *
1828  * The problem is caused be two factors
1829  * <ol>
1830  * <li>On the one hand, we cannot be sure when output will start. In particular,
1831  * an error, which needs to be displayed, could be thrown at any time.</li>
1832  * <li>On the other hand, we cannot be sure when we will have all the information
1833  * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1834  * (potentially) depends on the current course, course categories, and logged in user.
1835  * It also depends on whether the current page requires HTTPS.</li>
1836  * </ol>
1837  *
1838  * So, it is hard to find a single natural place during Moodle script execution,
1839  * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1840  * adopt the following strategy
1841  * <ol>
1842  * <li>We will initialise $OUTPUT the first time it is used.</li>
1843  * <li>If, after $OUTPUT has been initialised, the script tries to change something
1844  * that $OUTPUT depends on, we throw an exception making it clear that the script
1845  * did something wrong.
1846  * </ol>
1847  *
1848  * The only problem with that is, how do we initialise $OUTPUT on first use if,
1849  * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1850  * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1851  * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1852  *
1853  * Note that this class is used before lib/outputlib.php has been loaded, so we
1854  * must be careful referring to classes/functions from there, they may not be
1855  * defined yet, and we must avoid fatal errors.
1856  *
1857  * @copyright 2009 Tim Hunt
1858  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1859  * @since     Moodle 2.0
1860  */
1861 class bootstrap_renderer {
1862     /**
1863      * Handles re-entrancy. Without this, errors or debugging output that occur
1864      * during the initialisation of $OUTPUT, cause infinite recursion.
1865      * @var boolean
1866      */
1867     protected $initialising = false;
1869     /**
1870      * Have we started output yet?
1871      * @return boolean true if the header has been printed.
1872      */
1873     public function has_started() {
1874         return false;
1875     }
1877     /**
1878      * Constructor - to be used by core code only.
1879      * @param string $method The method to call
1880      * @param array $arguments Arguments to pass to the method being called
1881      * @return string
1882      */
1883     public function __call($method, $arguments) {
1884         global $OUTPUT, $PAGE;
1886         $recursing = false;
1887         if ($method == 'notification') {
1888             // Catch infinite recursion caused by debugging output during print_header.
1889             $backtrace = debug_backtrace();
1890             array_shift($backtrace);
1891             array_shift($backtrace);
1892             $recursing = is_early_init($backtrace);
1893         }
1895         $earlymethods = array(
1896             'fatal_error' => 'early_error',
1897             'notification' => 'early_notification',
1898         );
1900         // If lib/outputlib.php has been loaded, call it.
1901         if (!empty($PAGE) && !$recursing) {
1902             if (array_key_exists($method, $earlymethods)) {
1903                 //prevent PAGE->context warnings - exceptions might appear before we set any context
1904                 $PAGE->set_context(null);
1905             }
1906             $PAGE->initialise_theme_and_output();
1907             return call_user_func_array(array($OUTPUT, $method), $arguments);
1908         }
1910         $this->initialising = true;
1912         // Too soon to initialise $OUTPUT, provide a couple of key methods.
1913         if (array_key_exists($method, $earlymethods)) {
1914             return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1915         }
1917         throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1918     }
1920     /**
1921      * Returns nicely formatted error message in a div box.
1922      * @static
1923      * @param string $message error message
1924      * @param string $moreinfourl (ignored in early errors)
1925      * @param string $link (ignored in early errors)
1926      * @param array $backtrace
1927      * @param string $debuginfo
1928      * @return string
1929      */
1930     public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1931         global $CFG;
1933         $content = '<div style="margin-top: 6em; margin-left:auto; margin-right:auto; color:#990000; text-align:center; font-size:large; border-width:1px;
1934 border-color:black; background-color:#ffffee; border-style:solid; border-radius: 20px; border-collapse: collapse;
1935 width: 80%; -moz-border-radius: 20px; padding: 15px">
1936 ' . $message . '
1937 </div>';
1938         // Check whether debug is set.
1939         $debug = (!empty($CFG->debug) && $CFG->debug >= DEBUG_DEVELOPER);
1940         // Also check we have it set in the config file. This occurs if the method to read the config table from the
1941         // database fails, reading from the config table is the first database interaction we have.
1942         $debug = $debug || (!empty($CFG->config_php_settings['debug'])  && $CFG->config_php_settings['debug'] >= DEBUG_DEVELOPER );
1943         if ($debug) {
1944             if (!empty($debuginfo)) {
1945                 $debuginfo = s($debuginfo); // removes all nasty JS
1946                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1947                 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
1948             }
1949             if (!empty($backtrace)) {
1950                 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
1951             }
1952         }
1954         return $content;
1955     }
1957     /**
1958      * This function should only be called by this class, or from exception handlers
1959      * @static
1960      * @param string $message error message
1961      * @param string $moreinfourl (ignored in early errors)
1962      * @param string $link (ignored in early errors)
1963      * @param array $backtrace
1964      * @param string $debuginfo extra information for developers
1965      * @return string
1966      */
1967     public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = null) {
1968         global $CFG;
1970         if (CLI_SCRIPT) {
1971             echo "!!! $message !!!\n";
1972             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1973                 if (!empty($debuginfo)) {
1974                     echo "\nDebug info: $debuginfo";
1975                 }
1976                 if (!empty($backtrace)) {
1977                     echo "\nStack trace: " . format_backtrace($backtrace, true);
1978                 }
1979             }
1980             return;
1982         } else if (AJAX_SCRIPT) {
1983             $e = new stdClass();
1984             $e->error      = $message;
1985             $e->stacktrace = NULL;
1986             $e->debuginfo  = NULL;
1987             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1988                 if (!empty($debuginfo)) {
1989                     $e->debuginfo = $debuginfo;
1990                 }
1991                 if (!empty($backtrace)) {
1992                     $e->stacktrace = format_backtrace($backtrace, true);
1993                 }
1994             }
1995             $e->errorcode  = $errorcode;
1996             @header('Content-Type: application/json; charset=utf-8');
1997             echo json_encode($e);
1998             return;
1999         }
2001         // In the name of protocol correctness, monitoring and performance
2002         // profiling, set the appropriate error headers for machine consumption.
2003         $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
2004         @header($protocol . ' 503 Service Unavailable');
2006         // better disable any caching
2007         @header('Content-Type: text/html; charset=utf-8');
2008         @header('X-UA-Compatible: IE=edge');
2009         @header('Cache-Control: no-store, no-cache, must-revalidate');
2010         @header('Cache-Control: post-check=0, pre-check=0', false);
2011         @header('Pragma: no-cache');
2012         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
2013         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
2015         if (function_exists('get_string')) {
2016             $strerror = get_string('error');
2017         } else {
2018             $strerror = 'Error';
2019         }
2021         $content = self::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
2023         return self::plain_page($strerror, $content);
2024     }
2026     /**
2027      * Early notification message
2028      * @static
2029      * @param string $message
2030      * @param string $classes usually notifyproblem or notifysuccess
2031      * @return string
2032      */
2033     public static function early_notification($message, $classes = 'notifyproblem') {
2034         return '<div class="' . $classes . '">' . $message . '</div>';
2035     }
2037     /**
2038      * Page should redirect message.
2039      * @static
2040      * @param string $encodedurl redirect url
2041      * @return string
2042      */
2043     public static function plain_redirect_message($encodedurl) {
2044         $message = '<div style="margin-top: 3em; margin-left:auto; margin-right:auto; text-align:center;">' . get_string('pageshouldredirect') . '<br /><a href="'.
2045                 $encodedurl .'">'. get_string('continue') .'</a></div>';
2046         return self::plain_page(get_string('redirect'), $message);
2047     }
2049     /**
2050      * Early redirection page, used before full init of $PAGE global
2051      * @static
2052      * @param string $encodedurl redirect url
2053      * @param string $message redirect message
2054      * @param int $delay time in seconds
2055      * @return string redirect page
2056      */
2057     public static function early_redirect_message($encodedurl, $message, $delay) {
2058         $meta = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />';
2059         $content = self::early_error_content($message, null, null, null);
2060         $content .= self::plain_redirect_message($encodedurl);
2062         return self::plain_page(get_string('redirect'), $content, $meta);
2063     }
2065     /**
2066      * Output basic html page.
2067      * @static
2068      * @param string $title page title
2069      * @param string $content page content
2070      * @param string $meta meta tag
2071      * @return string html page
2072      */
2073     public static function plain_page($title, $content, $meta = '') {
2074         if (function_exists('get_string') && function_exists('get_html_lang')) {
2075             $htmllang = get_html_lang();
2076         } else {
2077             $htmllang = '';
2078         }
2080         $footer = '';
2081         if (MDL_PERF_TEST) {
2082             $perfinfo = get_performance_info();
2083             $footer = '<footer>' . $perfinfo['html'] . '</footer>';
2084         }
2086         return '<!DOCTYPE html>
2087 <html ' . $htmllang . '>
2088 <head>
2089 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
2090 '.$meta.'
2091 <title>' . $title . '</title>
2092 </head><body>' . $content . $footer . '</body></html>';
2093     }