Merge branch 'MDL-52333_master' of git://github.com/dmonllao/moodle
[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);
55 /**
56  * Simple class. It is usually used instead of stdClass because it looks
57  * more familiar to Java developers ;-) Do not use for type checking of
58  * function parameters. Please use stdClass instead.
59  *
60  * @package    core
61  * @subpackage lib
62  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
63  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
64  * @deprecated since 2.0
65  */
66 class object extends stdClass {};
68 /**
69  * Base Moodle Exception class
70  *
71  * Although this class is defined here, you cannot throw a moodle_exception until
72  * after moodlelib.php has been included (which will happen very soon).
73  *
74  * @package    core
75  * @subpackage lib
76  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
77  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
78  */
79 class moodle_exception extends Exception {
81     /**
82      * @var string The name of the string from error.php to print
83      */
84     public $errorcode;
86     /**
87      * @var string The name of module
88      */
89     public $module;
91     /**
92      * @var mixed Extra words and phrases that might be required in the error string
93      */
94     public $a;
96     /**
97      * @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.
98      */
99     public $link;
101     /**
102      * @var string Optional information to aid the debugging process
103      */
104     public $debuginfo;
106     /**
107      * Constructor
108      * @param string $errorcode The name of the string from error.php to print
109      * @param string $module name of module
110      * @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.
111      * @param mixed $a Extra words and phrases that might be required in the error string
112      * @param string $debuginfo optional debugging information
113      */
114     function __construct($errorcode, $module='', $link='', $a=NULL, $debuginfo=null) {
115         if (empty($module) || $module == 'moodle' || $module == 'core') {
116             $module = 'error';
117         }
119         $this->errorcode = $errorcode;
120         $this->module    = $module;
121         $this->link      = $link;
122         $this->a         = $a;
123         $this->debuginfo = is_null($debuginfo) ? null : (string)$debuginfo;
125         if (get_string_manager()->string_exists($errorcode, $module)) {
126             $message = get_string($errorcode, $module, $a);
127             $haserrorstring = true;
128         } else {
129             $message = $module . '/' . $errorcode;
130             $haserrorstring = false;
131         }
133         if (defined('PHPUNIT_TEST') and PHPUNIT_TEST and $debuginfo) {
134             $message = "$message ($debuginfo)";
135         }
137         if (!$haserrorstring and defined('PHPUNIT_TEST') and PHPUNIT_TEST) {
138             // Append the contents of $a to $debuginfo so helpful information isn't lost.
139             // This emulates what {@link get_exception_info()} does. Unfortunately that
140             // function is not used by phpunit.
141             $message .= PHP_EOL.'$a contents: '.print_r($a, true);
142         }
144         parent::__construct($message, 0);
145     }
148 /**
149  * Course/activity access exception.
150  *
151  * This exception is thrown from require_login()
152  *
153  * @package    core_access
154  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
155  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
156  */
157 class require_login_exception extends moodle_exception {
158     /**
159      * Constructor
160      * @param string $debuginfo Information to aid the debugging process
161      */
162     function __construct($debuginfo) {
163         parent::__construct('requireloginerror', 'error', '', NULL, $debuginfo);
164     }
167 /**
168  * Session timeout exception.
169  *
170  * This exception is thrown from require_login()
171  *
172  * @package    core_access
173  * @copyright  2015 Andrew Nicols <andrew@nicols.co.uk>
174  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
175  */
176 class require_login_session_timeout_exception extends require_login_exception {
177     /**
178      * Constructor
179      */
180     public function __construct() {
181         moodle_exception::__construct('sessionerroruser', 'error');
182     }
185 /**
186  * Web service parameter exception class
187  * @deprecated since Moodle 2.2 - use moodle exception instead
188  * This exception must be thrown to the web service client when a web service parameter is invalid
189  * The error string is gotten from webservice.php
190  */
191 class webservice_parameter_exception extends moodle_exception {
192     /**
193      * Constructor
194      * @param string $errorcode The name of the string from webservice.php to print
195      * @param string $a The name of the parameter
196      * @param string $debuginfo Optional information to aid debugging
197      */
198     function __construct($errorcode=null, $a = '', $debuginfo = null) {
199         parent::__construct($errorcode, 'webservice', '', $a, $debuginfo);
200     }
203 /**
204  * Exceptions indicating user does not have permissions to do something
205  * and the execution can not continue.
206  *
207  * @package    core_access
208  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
209  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
210  */
211 class required_capability_exception extends moodle_exception {
212     /**
213      * Constructor
214      * @param context $context The context used for the capability check
215      * @param string $capability The required capability
216      * @param string $errormessage The error message to show the user
217      * @param string $stringfile
218      */
219     function __construct($context, $capability, $errormessage, $stringfile) {
220         $capabilityname = get_capability_string($capability);
221         if ($context->contextlevel == CONTEXT_MODULE and preg_match('/:view$/', $capability)) {
222             // 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
223             $parentcontext = $context->get_parent_context();
224             $link = $parentcontext->get_url();
225         } else {
226             $link = $context->get_url();
227         }
228         parent::__construct($errormessage, $stringfile, $link, $capabilityname);
229     }
232 /**
233  * Exception indicating programming error, must be fixed by a programer. For example
234  * a core API might throw this type of exception if a plugin calls it incorrectly.
235  *
236  * @package    core
237  * @subpackage lib
238  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
239  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
240  */
241 class coding_exception extends moodle_exception {
242     /**
243      * Constructor
244      * @param string $hint short description of problem
245      * @param string $debuginfo detailed information how to fix problem
246      */
247     function __construct($hint, $debuginfo=null) {
248         parent::__construct('codingerror', 'debug', '', $hint, $debuginfo);
249     }
252 /**
253  * Exception indicating malformed parameter problem.
254  * This exception is not supposed to be thrown when processing
255  * user submitted data in forms. It is more suitable
256  * for WS and other low level stuff.
257  *
258  * @package    core
259  * @subpackage lib
260  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
261  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
262  */
263 class invalid_parameter_exception extends moodle_exception {
264     /**
265      * Constructor
266      * @param string $debuginfo some detailed information
267      */
268     function __construct($debuginfo=null) {
269         parent::__construct('invalidparameter', 'debug', '', null, $debuginfo);
270     }
273 /**
274  * Exception indicating malformed response problem.
275  * This exception is not supposed to be thrown when processing
276  * user submitted data in forms. It is more suitable
277  * for WS and other low level stuff.
278  */
279 class invalid_response_exception extends moodle_exception {
280     /**
281      * Constructor
282      * @param string $debuginfo some detailed information
283      */
284     function __construct($debuginfo=null) {
285         parent::__construct('invalidresponse', 'debug', '', null, $debuginfo);
286     }
289 /**
290  * An exception that indicates something really weird happened. For example,
291  * if you do switch ($context->contextlevel), and have one case for each
292  * CONTEXT_... constant. You might throw an invalid_state_exception in the
293  * default case, to just in case something really weird is going on, and
294  * $context->contextlevel is invalid - rather than ignoring this possibility.
295  *
296  * @package    core
297  * @subpackage lib
298  * @copyright  2009 onwards Martin Dougiamas  {@link http://moodle.com}
299  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
300  */
301 class invalid_state_exception extends moodle_exception {
302     /**
303      * Constructor
304      * @param string $hint short description of problem
305      * @param string $debuginfo optional more detailed information
306      */
307     function __construct($hint, $debuginfo=null) {
308         parent::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
309     }
312 /**
313  * An exception that indicates incorrect permissions in $CFG->dataroot
314  *
315  * @package    core
316  * @subpackage lib
317  * @copyright  2010 Petr Skoda {@link http://skodak.org}
318  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
319  */
320 class invalid_dataroot_permissions extends moodle_exception {
321     /**
322      * Constructor
323      * @param string $debuginfo optional more detailed information
324      */
325     function __construct($debuginfo = NULL) {
326         parent::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
327     }
330 /**
331  * An exception that indicates that file can not be served
332  *
333  * @package    core
334  * @subpackage lib
335  * @copyright  2010 Petr Skoda {@link http://skodak.org}
336  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
337  */
338 class file_serving_exception extends moodle_exception {
339     /**
340      * Constructor
341      * @param string $debuginfo optional more detailed information
342      */
343     function __construct($debuginfo = NULL) {
344         parent::__construct('cannotservefile', 'error', '', NULL, $debuginfo);
345     }
348 /**
349  * Default exception handler.
350  *
351  * @param Exception $ex
352  * @return void -does not return. Terminates execution!
353  */
354 function default_exception_handler($ex) {
355     global $CFG, $DB, $OUTPUT, $USER, $FULLME, $SESSION, $PAGE;
357     // detect active db transactions, rollback and log as error
358     abort_all_db_transactions();
360     if (($ex instanceof required_capability_exception) && !CLI_SCRIPT && !AJAX_SCRIPT && !empty($CFG->autologinguests) && !empty($USER->autologinguest)) {
361         $SESSION->wantsurl = qualified_me();
362         redirect(get_login_url());
363     }
365     $info = get_exception_info($ex);
367     if (debugging('', DEBUG_MINIMAL)) {
368         $logerrmsg = "Default exception handler: ".$info->message.' Debug: '.$info->debuginfo."\n".format_backtrace($info->backtrace, true);
369         error_log($logerrmsg);
370     }
372     if (is_early_init($info->backtrace)) {
373         echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo, $info->errorcode);
374     } else {
375         try {
376             if ($DB) {
377                 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
378                 $DB->set_debug(0);
379             }
380             echo $OUTPUT->fatal_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
381         } catch (Exception $out_ex) {
382             // default exception handler MUST not throw any exceptions!!
383             // 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
384             // so we just print at least something instead of "Exception thrown without a stack frame in Unknown on line 0":-(
385             if (CLI_SCRIPT or AJAX_SCRIPT) {
386                 // just ignore the error and send something back using the safest method
387                 echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo, $info->errorcode);
388             } else {
389                 echo bootstrap_renderer::early_error_content($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
390                 $outinfo = get_exception_info($out_ex);
391                 echo bootstrap_renderer::early_error_content($outinfo->message, $outinfo->moreinfourl, $outinfo->link, $outinfo->backtrace, $outinfo->debuginfo);
392             }
393         }
394     }
396     exit(1); // General error code
399 /**
400  * Default error handler, prevents some white screens.
401  * @param int $errno
402  * @param string $errstr
403  * @param string $errfile
404  * @param int $errline
405  * @param array $errcontext
406  * @return bool false means use default error handler
407  */
408 function default_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
409     if ($errno == 4096) {
410         //fatal catchable error
411         throw new coding_exception('PHP catchable fatal error', $errstr);
412     }
413     return false;
416 /**
417  * Unconditionally abort all database transactions, this function
418  * should be called from exception handlers only.
419  * @return void
420  */
421 function abort_all_db_transactions() {
422     global $CFG, $DB, $SCRIPT;
424     // default exception handler MUST not throw any exceptions!!
426     if ($DB && $DB->is_transaction_started()) {
427         error_log('Database transaction aborted automatically in ' . $CFG->dirroot . $SCRIPT);
428         // note: transaction blocks should never change current $_SESSION
429         $DB->force_transaction_rollback();
430     }
433 /**
434  * This function encapsulates the tests for whether an exception was thrown in
435  * early init -- either during setup.php or during init of $OUTPUT.
436  *
437  * If another exception is thrown then, and if we do not take special measures,
438  * we would just get a very cryptic message "Exception thrown without a stack
439  * frame in Unknown on line 0". That makes debugging very hard, so we do take
440  * special measures in default_exception_handler, with the help of this function.
441  *
442  * @param array $backtrace the stack trace to analyse.
443  * @return boolean whether the stack trace is somewhere in output initialisation.
444  */
445 function is_early_init($backtrace) {
446     $dangerouscode = array(
447         array('function' => 'header', 'type' => '->'),
448         array('class' => 'bootstrap_renderer'),
449         array('file' => dirname(__FILE__).'/setup.php'),
450     );
451     foreach ($backtrace as $stackframe) {
452         foreach ($dangerouscode as $pattern) {
453             $matches = true;
454             foreach ($pattern as $property => $value) {
455                 if (!isset($stackframe[$property]) || $stackframe[$property] != $value) {
456                     $matches = false;
457                 }
458             }
459             if ($matches) {
460                 return true;
461             }
462         }
463     }
464     return false;
467 /**
468  * Abort execution by throwing of a general exception,
469  * default exception handler displays the error message in most cases.
470  *
471  * @param string $errorcode The name of the language string containing the error message.
472  *      Normally this should be in the error.php lang file.
473  * @param string $module The language file to get the error message from.
474  * @param string $link The url where the user will be prompted to continue.
475  *      If no url is provided the user will be directed to the site index page.
476  * @param object $a Extra words and phrases that might be required in the error string
477  * @param string $debuginfo optional debugging information
478  * @return void, always throws exception!
479  */
480 function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
481     throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
484 /**
485  * Returns detailed information about specified exception.
486  * @param exception $ex
487  * @return object
488  */
489 function get_exception_info($ex) {
490     global $CFG, $DB, $SESSION;
492     if ($ex instanceof moodle_exception) {
493         $errorcode = $ex->errorcode;
494         $module = $ex->module;
495         $a = $ex->a;
496         $link = $ex->link;
497         $debuginfo = $ex->debuginfo;
498     } else {
499         $errorcode = 'generalexceptionmessage';
500         $module = 'error';
501         $a = $ex->getMessage();
502         $link = '';
503         $debuginfo = '';
504     }
506     // Append the error code to the debug info to make grepping and googling easier
507     $debuginfo .= PHP_EOL."Error code: $errorcode";
509     $backtrace = $ex->getTrace();
510     $place = array('file'=>$ex->getFile(), 'line'=>$ex->getLine(), 'exception'=>get_class($ex));
511     array_unshift($backtrace, $place);
513     // Be careful, no guarantee moodlelib.php is loaded.
514     if (empty($module) || $module == 'moodle' || $module == 'core') {
515         $module = 'error';
516     }
517     // Search for the $errorcode's associated string
518     // If not found, append the contents of $a to $debuginfo so helpful information isn't lost
519     if (function_exists('get_string_manager')) {
520         if (get_string_manager()->string_exists($errorcode, $module)) {
521             $message = get_string($errorcode, $module, $a);
522         } elseif ($module == 'error' && get_string_manager()->string_exists($errorcode, 'moodle')) {
523             // Search in moodle file if error specified - needed for backwards compatibility
524             $message = get_string($errorcode, 'moodle', $a);
525         } else {
526             $message = $module . '/' . $errorcode;
527             $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
528         }
529     } else {
530         $message = $module . '/' . $errorcode;
531         $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
532     }
534     // Remove some absolute paths from message and debugging info.
535     $searches = array();
536     $replaces = array();
537     $cfgnames = array('tempdir', 'cachedir', 'localcachedir', 'themedir', 'dataroot', 'dirroot');
538     foreach ($cfgnames as $cfgname) {
539         if (property_exists($CFG, $cfgname)) {
540             $searches[] = $CFG->$cfgname;
541             $replaces[] = "[$cfgname]";
542         }
543     }
544     if (!empty($searches)) {
545         $message   = str_replace($searches, $replaces, $message);
546         $debuginfo = str_replace($searches, $replaces, $debuginfo);
547     }
549     // Be careful, no guarantee weblib.php is loaded.
550     if (function_exists('clean_text')) {
551         $message = clean_text($message);
552     } else {
553         $message = htmlspecialchars($message);
554     }
556     if (!empty($CFG->errordocroot)) {
557         $errordoclink = $CFG->errordocroot . '/en/';
558     } else {
559         $errordoclink = get_docs_url();
560     }
562     if ($module === 'error') {
563         $modulelink = 'moodle';
564     } else {
565         $modulelink = $module;
566     }
567     $moreinfourl = $errordoclink . 'error/' . $modulelink . '/' . $errorcode;
569     if (empty($link)) {
570         if (!empty($SESSION->fromurl)) {
571             $link = $SESSION->fromurl;
572             unset($SESSION->fromurl);
573         } else {
574             $link = $CFG->wwwroot .'/';
575         }
576     }
578     // When printing an error the continue button should never link offsite.
579     // We cannot use clean_param() here as it is not guaranteed that it has been loaded yet.
580     $httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot);
581     if (stripos($link, $CFG->wwwroot) === 0) {
582         // Internal HTTP, all good.
583     } else if (!empty($CFG->loginhttps) && stripos($link, $httpswwwroot) === 0) {
584         // Internal HTTPS, all good.
585     } else {
586         // External link spotted!
587         $link = $CFG->wwwroot . '/';
588     }
590     $info = new stdClass();
591     $info->message     = $message;
592     $info->errorcode   = $errorcode;
593     $info->backtrace   = $backtrace;
594     $info->link        = $link;
595     $info->moreinfourl = $moreinfourl;
596     $info->a           = $a;
597     $info->debuginfo   = $debuginfo;
599     return $info;
602 /**
603  * Generate a uuid.
604  *
605  * Unique is hard. Very hard. Attempt to use the PECL UUID functions if available, and if not then revert to
606  * constructing the uuid using mt_rand.
607  *
608  * It is important that this token is not solely based on time as this could lead
609  * to duplicates in a clustered environment (especially on VMs due to poor time precision).
610  *
611  * @return string The uuid.
612  */
613 function generate_uuid() {
614     $uuid = '';
616     if (function_exists("uuid_create")) {
617         $context = null;
618         uuid_create($context);
620         uuid_make($context, UUID_MAKE_V4);
621         uuid_export($context, UUID_FMT_STR, $uuid);
622     } else {
623         // Fallback uuid generation based on:
624         // "http://www.php.net/manual/en/function.uniqid.php#94959".
625         $uuid = sprintf('%04x%04x-%04x-%04x-%04x-%04x%04x%04x',
627             // 32 bits for "time_low".
628             mt_rand(0, 0xffff), mt_rand(0, 0xffff),
630             // 16 bits for "time_mid".
631             mt_rand(0, 0xffff),
633             // 16 bits for "time_hi_and_version",
634             // four most significant bits holds version number 4.
635             mt_rand(0, 0x0fff) | 0x4000,
637             // 16 bits, 8 bits for "clk_seq_hi_res",
638             // 8 bits for "clk_seq_low",
639             // two most significant bits holds zero and one for variant DCE1.1.
640             mt_rand(0, 0x3fff) | 0x8000,
642             // 48 bits for "node".
643             mt_rand(0, 0xffff), mt_rand(0, 0xffff), mt_rand(0, 0xffff));
644     }
645     return trim($uuid);
648 /**
649  * Returns the Moodle Docs URL in the users language for a given 'More help' link.
650  *
651  * There are three cases:
652  *
653  * 1. In the normal case, $path will be a short relative path 'component/thing',
654  * like 'mod/folder/view' 'group/import'. This gets turned into an link to
655  * MoodleDocs in the user's language, and for the appropriate Moodle version.
656  * E.g. 'group/import' may become 'http://docs.moodle.org/2x/en/group/import'.
657  * The 'http://docs.moodle.org' bit comes from $CFG->docroot.
658  *
659  * This is the only option that should be used in standard Moodle code. The other
660  * two options have been implemented because they are useful for third-party plugins.
661  *
662  * 2. $path may be an absolute URL, starting http:// or https://. In this case,
663  * the link is used as is.
664  *
665  * 3. $path may start %%WWWROOT%%, in which case that is replaced by
666  * $CFG->wwwroot to make the link.
667  *
668  * @param string $path the place to link to. See above for details.
669  * @return string The MoodleDocs URL in the user's language. for example @link http://docs.moodle.org/2x/en/$path}
670  */
671 function get_docs_url($path = null) {
672     global $CFG;
674     // Absolute URLs are used unmodified.
675     if (substr($path, 0, 7) === 'http://' || substr($path, 0, 8) === 'https://') {
676         return $path;
677     }
679     // Paths starting %%WWWROOT%% have that replaced by $CFG->wwwroot.
680     if (substr($path, 0, 11) === '%%WWWROOT%%') {
681         return $CFG->wwwroot . substr($path, 11);
682     }
684     // Otherwise we do the normal case, and construct a MoodleDocs URL relative to $CFG->docroot.
686     // Check that $CFG->branch has been set up, during installation it won't be.
687     if (empty($CFG->branch)) {
688         // It's not there yet so look at version.php.
689         include($CFG->dirroot.'/version.php');
690     } else {
691         // We can use $CFG->branch and avoid having to include version.php.
692         $branch = $CFG->branch;
693     }
694     // ensure branch is valid.
695     if (!$branch) {
696         // We should never get here but in case we do lets set $branch to .
697         // the smart one's will know that this is the current directory
698         // and the smarter ones will know that there is some smart matching
699         // that will ensure people end up at the latest version of the docs.
700         $branch = '.';
701     }
702     if (empty($CFG->doclang)) {
703         $lang = current_language();
704     } else {
705         $lang = $CFG->doclang;
706     }
707     $end = '/' . $branch . '/' . $lang . '/' . $path;
708     if (empty($CFG->docroot)) {
709         return 'http://docs.moodle.org'. $end;
710     } else {
711         return $CFG->docroot . $end ;
712     }
715 /**
716  * Formats a backtrace ready for output.
717  *
718  * @param array $callers backtrace array, as returned by debug_backtrace().
719  * @param boolean $plaintext if false, generates HTML, if true generates plain text.
720  * @return string formatted backtrace, ready for output.
721  */
722 function format_backtrace($callers, $plaintext = false) {
723     // do not use $CFG->dirroot because it might not be available in destructors
724     $dirroot = dirname(dirname(__FILE__));
726     if (empty($callers)) {
727         return '';
728     }
730     $from = $plaintext ? '' : '<ul style="text-align: left" data-rel="backtrace">';
731     foreach ($callers as $caller) {
732         if (!isset($caller['line'])) {
733             $caller['line'] = '?'; // probably call_user_func()
734         }
735         if (!isset($caller['file'])) {
736             $caller['file'] = 'unknownfile'; // probably call_user_func()
737         }
738         $from .= $plaintext ? '* ' : '<li>';
739         $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
740         if (isset($caller['function'])) {
741             $from .= ': call to ';
742             if (isset($caller['class'])) {
743                 $from .= $caller['class'] . $caller['type'];
744             }
745             $from .= $caller['function'] . '()';
746         } else if (isset($caller['exception'])) {
747             $from .= ': '.$caller['exception'].' thrown';
748         }
749         $from .= $plaintext ? "\n" : '</li>';
750     }
751     $from .= $plaintext ? '' : '</ul>';
753     return $from;
756 /**
757  * This function makes the return value of ini_get consistent if you are
758  * setting server directives through the .htaccess file in apache.
759  *
760  * Current behavior for value set from php.ini On = 1, Off = [blank]
761  * Current behavior for value set from .htaccess On = On, Off = Off
762  * Contributed by jdell @ unr.edu
763  *
764  * @param string $ini_get_arg The argument to get
765  * @return bool True for on false for not
766  */
767 function ini_get_bool($ini_get_arg) {
768     $temp = ini_get($ini_get_arg);
770     if ($temp == '1' or strtolower($temp) == 'on') {
771         return true;
772     }
773     return false;
776 /**
777  * This function verifies the sanity of PHP configuration
778  * and stops execution if anything critical found.
779  */
780 function setup_validate_php_configuration() {
781    // this must be very fast - no slow checks here!!!
783    if (ini_get_bool('session.auto_start')) {
784        print_error('sessionautostartwarning', 'admin');
785    }
788 /**
789  * Initialise global $CFG variable.
790  * @private to be used only from lib/setup.php
791  */
792 function initialise_cfg() {
793     global $CFG, $DB;
795     if (!$DB) {
796         // This should not happen.
797         return;
798     }
800     try {
801         $localcfg = get_config('core');
802     } catch (dml_exception $e) {
803         // Most probably empty db, going to install soon.
804         return;
805     }
807     foreach ($localcfg as $name => $value) {
808         // Note that get_config() keeps forced settings
809         // and normalises values to string if possible.
810         $CFG->{$name} = $value;
811     }
814 /**
815  * Initialises $FULLME and friends. Private function. Should only be called from
816  * setup.php.
817  */
818 function initialise_fullme() {
819     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
821     // Detect common config error.
822     if (substr($CFG->wwwroot, -1) == '/') {
823         print_error('wwwrootslash', 'error');
824     }
826     if (CLI_SCRIPT) {
827         initialise_fullme_cli();
828         return;
829     }
831     $rurl = setup_get_remote_url();
832     $wwwroot = parse_url($CFG->wwwroot.'/');
834     if (empty($rurl['host'])) {
835         // missing host in request header, probably not a real browser, let's ignore them
837     } else if (!empty($CFG->reverseproxy)) {
838         // $CFG->reverseproxy specifies if reverse proxy server used
839         // Used in load balancing scenarios.
840         // Do not abuse this to try to solve lan/wan access problems!!!!!
842     } else {
843         if (($rurl['host'] !== $wwwroot['host']) or
844                 (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port']) or
845                 (strpos($rurl['path'], $wwwroot['path']) !== 0)) {
847             // Explain the problem and redirect them to the right URL
848             if (!defined('NO_MOODLE_COOKIES')) {
849                 define('NO_MOODLE_COOKIES', true);
850             }
851             // The login/token.php script should call the correct url/port.
852             if (defined('REQUIRE_CORRECT_ACCESS') && REQUIRE_CORRECT_ACCESS) {
853                 $wwwrootport = empty($wwwroot['port'])?'':$wwwroot['port'];
854                 $calledurl = $rurl['host'];
855                 if (!empty($rurl['port'])) {
856                     $calledurl .=  ':'. $rurl['port'];
857                 }
858                 $correcturl = $wwwroot['host'];
859                 if (!empty($wwwrootport)) {
860                     $correcturl .=  ':'. $wwwrootport;
861                 }
862                 throw new moodle_exception('requirecorrectaccess', 'error', '', null,
863                     'You called ' . $calledurl .', you should have called ' . $correcturl);
864             }
865             redirect($CFG->wwwroot, get_string('wwwrootmismatch', 'error', $CFG->wwwroot), 3);
866         }
867     }
869     // Check that URL is under $CFG->wwwroot.
870     if (strpos($rurl['path'], $wwwroot['path']) === 0) {
871         $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
872     } else {
873         // Probably some weird external script
874         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
875         return;
876     }
878     // $CFG->sslproxy specifies if external SSL appliance is used
879     // (That is, the Moodle server uses http, with an external box translating everything to https).
880     if (empty($CFG->sslproxy)) {
881         if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
882             print_error('sslonlyaccess', 'error');
883         }
884     } else {
885         if ($wwwroot['scheme'] !== 'https') {
886             throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
887         }
888         $rurl['scheme'] = 'https'; // make moodle believe it runs on https, squid or something else it doing it
889         $_SERVER['HTTPS'] = 'on'; // Override $_SERVER to help external libraries with their HTTPS detection.
890         $_SERVER['SERVER_PORT'] = 443; // Assume default ssl port for the proxy.
891     }
893     // hopefully this will stop all those "clever" admins trying to set up moodle
894     // with two different addresses in intranet and Internet
895     if (!empty($CFG->reverseproxy) && $rurl['host'] === $wwwroot['host']) {
896         print_error('reverseproxyabused', 'error');
897     }
899     $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
900     if (!empty($wwwroot['port'])) {
901         $hostandport .= ':'.$wwwroot['port'];
902     }
904     $FULLSCRIPT = $hostandport . $rurl['path'];
905     $FULLME = $hostandport . $rurl['fullpath'];
906     $ME = $rurl['fullpath'];
909 /**
910  * Initialises $FULLME and friends for command line scripts.
911  * This is a private method for use by initialise_fullme.
912  */
913 function initialise_fullme_cli() {
914     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
916     // Urls do not make much sense in CLI scripts
917     $backtrace = debug_backtrace();
918     $topfile = array_pop($backtrace);
919     $topfile = realpath($topfile['file']);
920     $dirroot = realpath($CFG->dirroot);
922     if (strpos($topfile, $dirroot) !== 0) {
923         // Probably some weird external script
924         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
925     } else {
926         $relativefile = substr($topfile, strlen($dirroot));
927         $relativefile = str_replace('\\', '/', $relativefile); // Win fix
928         $SCRIPT = $FULLSCRIPT = $relativefile;
929         $FULLME = $ME = null;
930     }
933 /**
934  * Get the URL that PHP/the web server thinks it is serving. Private function
935  * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
936  * @return array in the same format that parse_url returns, with the addition of
937  *      a 'fullpath' element, which includes any slasharguments path.
938  */
939 function setup_get_remote_url() {
940     $rurl = array();
941     if (isset($_SERVER['HTTP_HOST'])) {
942         list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
943     } else {
944         $rurl['host'] = null;
945     }
946     $rurl['port'] = $_SERVER['SERVER_PORT'];
947     $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
948     $rurl['scheme'] = (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] === 'off' or $_SERVER['HTTPS'] === 'Off' or $_SERVER['HTTPS'] === 'OFF') ? 'http' : 'https';
950     if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
951         //Apache server
952         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
954         // Fixing a known issue with:
955         // - Apache versions lesser than 2.4.11
956         // - PHP deployed in Apache as PHP-FPM via mod_proxy_fcgi
957         // - PHP versions lesser than 5.6.3 and 5.5.18.
958         if (isset($_SERVER['PATH_INFO']) && (php_sapi_name() === 'fpm-fcgi') && isset($_SERVER['SCRIPT_NAME'])) {
959             $pathinfodec = rawurldecode($_SERVER['PATH_INFO']);
960             $lenneedle = strlen($pathinfodec);
961             // Checks whether SCRIPT_NAME ends with PATH_INFO, URL-decoded.
962             if (substr($_SERVER['SCRIPT_NAME'], -$lenneedle) === $pathinfodec) {
963                 // This is the "Apache 2.4.10- running PHP-FPM via mod_proxy_fcgi" fingerprint,
964                 // 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)
965                 // => SCRIPT_NAME contains 'slash arguments' data too, which is wrongly exposed via PATH_INFO as URL-encoded.
966                 // Fix both $_SERVER['PATH_INFO'] and $_SERVER['SCRIPT_NAME'].
967                 $lenhaystack = strlen($_SERVER['SCRIPT_NAME']);
968                 $pos = $lenhaystack - $lenneedle;
969                 // Here $pos is greater than 0 but let's double check it.
970                 if ($pos > 0) {
971                     $_SERVER['PATH_INFO'] = $pathinfodec;
972                     $_SERVER['SCRIPT_NAME'] = substr($_SERVER['SCRIPT_NAME'], 0, $pos);
973                 }
974             }
975         }
977     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
978         //IIS - needs a lot of tweaking to make it work
979         $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
981         // NOTE: we should ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS.
982         //       Since 2.0, we rely on IIS rewrite extensions like Helicon ISAPI_rewrite
983         //         example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
984         //       OR
985         //       we rely on a proper IIS 6.0+ configuration: the 'FastCGIUtf8ServerVariables' registry key.
986         if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
987             // Check that PATH_INFO works == must not contain the script name.
988             if (strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === false) {
989                 $rurl['fullpath'] .= clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH);
990             }
991         }
993         if (isset($_SERVER['QUERY_STRING']) and $_SERVER['QUERY_STRING'] !== '') {
994             $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
995         }
996         $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
998 /* NOTE: following servers are not fully tested! */
1000     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
1001         //lighttpd - not officially supported
1002         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1004     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
1005         //nginx - not officially supported
1006         if (!isset($_SERVER['SCRIPT_NAME'])) {
1007             die('Invalid server configuration detected, please try to add "fastcgi_param SCRIPT_NAME $fastcgi_script_name;" to the nginx server configuration.');
1008         }
1009         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1011      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
1012          //cherokee - not officially supported
1013          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1015      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
1016          //zeus - not officially supported
1017          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1019     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
1020         //LiteSpeed - not officially supported
1021         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1023     } else if ($_SERVER['SERVER_SOFTWARE'] === 'HTTPD') {
1024         //obscure name found on some servers - this is definitely not supported
1025         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
1027     } else if (strpos($_SERVER['SERVER_SOFTWARE'], 'PHP') === 0) {
1028         // built-in PHP Development Server
1029         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
1031     } else {
1032         throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
1033     }
1035     // sanitize the url a bit more, the encoding style may be different in vars above
1036     $rurl['fullpath'] = str_replace('"', '%22', $rurl['fullpath']);
1037     $rurl['fullpath'] = str_replace('\'', '%27', $rurl['fullpath']);
1039     return $rurl;
1042 /**
1043  * Try to work around the 'max_input_vars' restriction if necessary.
1044  */
1045 function workaround_max_input_vars() {
1046     // Make sure this gets executed only once from lib/setup.php!
1047     static $executed = false;
1048     if ($executed) {
1049         debugging('workaround_max_input_vars() must be called only once!');
1050         return;
1051     }
1052     $executed = true;
1054     if (!isset($_SERVER["CONTENT_TYPE"]) or strpos($_SERVER["CONTENT_TYPE"], 'multipart/form-data') !== false) {
1055         // Not a post or 'multipart/form-data' which is not compatible with "php://input" reading.
1056         return;
1057     }
1059     if (!isloggedin() or isguestuser()) {
1060         // Only real users post huge forms.
1061         return;
1062     }
1064     $max = (int)ini_get('max_input_vars');
1066     if ($max <= 0) {
1067         // Most probably PHP < 5.3.9 that does not implement this limit.
1068         return;
1069     }
1071     if ($max >= 200000) {
1072         // This value should be ok for all our forms, by setting it in php.ini
1073         // admins may prevent any unexpected regressions caused by this hack.
1075         // Note there is no need to worry about DDoS caused by making this limit very high
1076         // because there are very many easier ways to DDoS any Moodle server.
1077         return;
1078     }
1080     if (count($_POST, COUNT_RECURSIVE) < $max) {
1081         return;
1082     }
1084     // Large POST request with enctype supported by php://input.
1085     // Parse php://input in chunks to bypass max_input_vars limit, which also applies to parse_str().
1086     $str = file_get_contents("php://input");
1087     if ($str === false or $str === '') {
1088         // Some weird error.
1089         return;
1090     }
1092     $delim = '&';
1093     $fun = create_function('$p', 'return implode("'.$delim.'", $p);');
1094     $chunks = array_map($fun, array_chunk(explode($delim, $str), $max));
1096     foreach ($chunks as $chunk) {
1097         $values = array();
1098         parse_str($chunk, $values);
1100         merge_query_params($_POST, $values);
1101         merge_query_params($_REQUEST, $values);
1102     }
1105 /**
1106  * Merge parsed POST chunks.
1107  *
1108  * NOTE: this is not perfect, but it should work in most cases hopefully.
1109  *
1110  * @param array $target
1111  * @param array $values
1112  */
1113 function merge_query_params(array &$target, array $values) {
1114     if (isset($values[0]) and isset($target[0])) {
1115         // This looks like a split [] array, lets verify the keys are continuous starting with 0.
1116         $keys1 = array_keys($values);
1117         $keys2 = array_keys($target);
1118         if ($keys1 === array_keys($keys1) and $keys2 === array_keys($keys2)) {
1119             foreach ($values as $v) {
1120                 $target[] = $v;
1121             }
1122             return;
1123         }
1124     }
1125     foreach ($values as $k => $v) {
1126         if (!isset($target[$k])) {
1127             $target[$k] = $v;
1128             continue;
1129         }
1130         if (is_array($target[$k]) and is_array($v)) {
1131             merge_query_params($target[$k], $v);
1132             continue;
1133         }
1134         // We should not get here unless there are duplicates in params.
1135         $target[$k] = $v;
1136     }
1139 /**
1140  * Initializes our performance info early.
1141  *
1142  * Pairs up with get_performance_info() which is actually
1143  * in moodlelib.php. This function is here so that we can
1144  * call it before all the libs are pulled in.
1145  *
1146  * @uses $PERF
1147  */
1148 function init_performance_info() {
1150     global $PERF, $CFG, $USER;
1152     $PERF = new stdClass();
1153     $PERF->logwrites = 0;
1154     if (function_exists('microtime')) {
1155         $PERF->starttime = microtime();
1156     }
1157     if (function_exists('memory_get_usage')) {
1158         $PERF->startmemory = memory_get_usage();
1159     }
1160     if (function_exists('posix_times')) {
1161         $PERF->startposixtimes = posix_times();
1162     }
1165 /**
1166  * Indicates whether we are in the middle of the initial Moodle install.
1167  *
1168  * Very occasionally it is necessary avoid running certain bits of code before the
1169  * Moodle installation has completed. The installed flag is set in admin/index.php
1170  * after Moodle core and all the plugins have been installed, but just before
1171  * the person doing the initial install is asked to choose the admin password.
1172  *
1173  * @return boolean true if the initial install is not complete.
1174  */
1175 function during_initial_install() {
1176     global $CFG;
1177     return empty($CFG->rolesactive);
1180 /**
1181  * Function to raise the memory limit to a new value.
1182  * Will respect the memory limit if it is higher, thus allowing
1183  * settings in php.ini, apache conf or command line switches
1184  * to override it.
1185  *
1186  * The memory limit should be expressed with a constant
1187  * MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE.
1188  * It is possible to use strings or integers too (eg:'128M').
1189  *
1190  * @param mixed $newlimit the new memory limit
1191  * @return bool success
1192  */
1193 function raise_memory_limit($newlimit) {
1194     global $CFG;
1196     if ($newlimit == MEMORY_UNLIMITED) {
1197         ini_set('memory_limit', -1);
1198         return true;
1200     } else if ($newlimit == MEMORY_STANDARD) {
1201         if (PHP_INT_SIZE > 4) {
1202             $newlimit = get_real_size('128M'); // 64bit needs more memory
1203         } else {
1204             $newlimit = get_real_size('96M');
1205         }
1207     } else if ($newlimit == MEMORY_EXTRA) {
1208         if (PHP_INT_SIZE > 4) {
1209             $newlimit = get_real_size('384M'); // 64bit needs more memory
1210         } else {
1211             $newlimit = get_real_size('256M');
1212         }
1213         if (!empty($CFG->extramemorylimit)) {
1214             $extra = get_real_size($CFG->extramemorylimit);
1215             if ($extra > $newlimit) {
1216                 $newlimit = $extra;
1217             }
1218         }
1220     } else if ($newlimit == MEMORY_HUGE) {
1221         // MEMORY_HUGE uses 2G or MEMORY_EXTRA, whichever is bigger.
1222         $newlimit = get_real_size('2G');
1223         if (!empty($CFG->extramemorylimit)) {
1224             $extra = get_real_size($CFG->extramemorylimit);
1225             if ($extra > $newlimit) {
1226                 $newlimit = $extra;
1227             }
1228         }
1230     } else {
1231         $newlimit = get_real_size($newlimit);
1232     }
1234     if ($newlimit <= 0) {
1235         debugging('Invalid memory limit specified.');
1236         return false;
1237     }
1239     $cur = ini_get('memory_limit');
1240     if (empty($cur)) {
1241         // if php is compiled without --enable-memory-limits
1242         // apparently memory_limit is set to ''
1243         $cur = 0;
1244     } else {
1245         if ($cur == -1){
1246             return true; // unlimited mem!
1247         }
1248         $cur = get_real_size($cur);
1249     }
1251     if ($newlimit > $cur) {
1252         ini_set('memory_limit', $newlimit);
1253         return true;
1254     }
1255     return false;
1258 /**
1259  * Function to reduce the memory limit to a new value.
1260  * Will respect the memory limit if it is lower, thus allowing
1261  * settings in php.ini, apache conf or command line switches
1262  * to override it
1263  *
1264  * The memory limit should be expressed with a string (eg:'64M')
1265  *
1266  * @param string $newlimit the new memory limit
1267  * @return bool
1268  */
1269 function reduce_memory_limit($newlimit) {
1270     if (empty($newlimit)) {
1271         return false;
1272     }
1273     $cur = ini_get('memory_limit');
1274     if (empty($cur)) {
1275         // if php is compiled without --enable-memory-limits
1276         // apparently memory_limit is set to ''
1277         $cur = 0;
1278     } else {
1279         if ($cur == -1){
1280             return true; // unlimited mem!
1281         }
1282         $cur = get_real_size($cur);
1283     }
1285     $new = get_real_size($newlimit);
1286     // -1 is smaller, but it means unlimited
1287     if ($new < $cur && $new != -1) {
1288         ini_set('memory_limit', $newlimit);
1289         return true;
1290     }
1291     return false;
1294 /**
1295  * Converts numbers like 10M into bytes.
1296  *
1297  * @param string $size The size to be converted
1298  * @return int
1299  */
1300 function get_real_size($size = 0) {
1301     if (!$size) {
1302         return 0;
1303     }
1304     $scan = array();
1305     $scan['GB'] = 1073741824;
1306     $scan['Gb'] = 1073741824;
1307     $scan['G'] = 1073741824;
1308     $scan['MB'] = 1048576;
1309     $scan['Mb'] = 1048576;
1310     $scan['M'] = 1048576;
1311     $scan['m'] = 1048576;
1312     $scan['KB'] = 1024;
1313     $scan['Kb'] = 1024;
1314     $scan['K'] = 1024;
1315     $scan['k'] = 1024;
1317     while (list($key) = each($scan)) {
1318         if ((strlen($size)>strlen($key))&&(substr($size, strlen($size) - strlen($key))==$key)) {
1319             $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
1320             break;
1321         }
1322     }
1323     return $size;
1326 /**
1327  * Try to disable all output buffering and purge
1328  * all headers.
1329  *
1330  * @access private to be called only from lib/setup.php !
1331  * @return void
1332  */
1333 function disable_output_buffering() {
1334     $olddebug = error_reporting(0);
1336     // disable compression, it would prevent closing of buffers
1337     if (ini_get_bool('zlib.output_compression')) {
1338         ini_set('zlib.output_compression', 'Off');
1339     }
1341     // try to flush everything all the time
1342     ob_implicit_flush(true);
1344     // close all buffers if possible and discard any existing output
1345     // this can actually work around some whitespace problems in config.php
1346     while(ob_get_level()) {
1347         if (!ob_end_clean()) {
1348             // prevent infinite loop when buffer can not be closed
1349             break;
1350         }
1351     }
1353     // disable any other output handlers
1354     ini_set('output_handler', '');
1356     error_reporting($olddebug);
1359 /**
1360  * Check whether a major upgrade is needed. That is defined as an upgrade that
1361  * changes something really fundamental in the database, so nothing can possibly
1362  * work until the database has been updated, and that is defined by the hard-coded
1363  * version number in this function.
1364  */
1365 function redirect_if_major_upgrade_required() {
1366     global $CFG;
1367     $lastmajordbchanges = 2014093001.00;
1368     if (empty($CFG->version) or (float)$CFG->version < $lastmajordbchanges or
1369             during_initial_install() or !empty($CFG->adminsetuppending)) {
1370         try {
1371             @\core\session\manager::terminate_current();
1372         } catch (Exception $e) {
1373             // Ignore any errors, redirect to upgrade anyway.
1374         }
1375         $url = $CFG->wwwroot . '/' . $CFG->admin . '/index.php';
1376         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
1377         @header('Location: ' . $url);
1378         echo bootstrap_renderer::plain_redirect_message(htmlspecialchars($url));
1379         exit;
1380     }
1383 /**
1384  * Makes sure that upgrade process is not running
1385  *
1386  * To be inserted in the core functions that can not be called by pluigns during upgrade.
1387  * Core upgrade should not use any API functions at all.
1388  * See {@link http://docs.moodle.org/dev/Upgrade_API#Upgrade_code_restrictions}
1389  *
1390  * @throws moodle_exception if executed from inside of upgrade script and $warningonly is false
1391  * @param bool $warningonly if true displays a warning instead of throwing an exception
1392  * @return bool true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only
1393  */
1394 function upgrade_ensure_not_running($warningonly = false) {
1395     global $CFG;
1396     if (!empty($CFG->upgraderunning)) {
1397         if (!$warningonly) {
1398             throw new moodle_exception('cannotexecduringupgrade');
1399         } else {
1400             debugging(get_string('cannotexecduringupgrade', 'error'), DEBUG_DEVELOPER);
1401             return false;
1402         }
1403     }
1404     return true;
1407 /**
1408  * Function to check if a directory exists and by default create it if not exists.
1409  *
1410  * Previously this was accepting paths only from dataroot, but we now allow
1411  * files outside of dataroot if you supply custom paths for some settings in config.php.
1412  * This function does not verify that the directory is writable.
1413  *
1414  * NOTE: this function uses current file stat cache,
1415  *       please use clearstatcache() before this if you expect that the
1416  *       directories may have been removed recently from a different request.
1417  *
1418  * @param string $dir absolute directory path
1419  * @param boolean $create directory if does not exist
1420  * @param boolean $recursive create directory recursively
1421  * @return boolean true if directory exists or created, false otherwise
1422  */
1423 function check_dir_exists($dir, $create = true, $recursive = true) {
1424     global $CFG;
1426     umask($CFG->umaskpermissions);
1428     if (is_dir($dir)) {
1429         return true;
1430     }
1432     if (!$create) {
1433         return false;
1434     }
1436     return mkdir($dir, $CFG->directorypermissions, $recursive);
1439 /**
1440  * Create a new unique directory within the specified directory.
1441  *
1442  * @param string $basedir The directory to create your new unique directory within.
1443  * @param bool $exceptiononerror throw exception if error encountered
1444  * @return string The created directory
1445  * @throws invalid_dataroot_permissions
1446  */
1447 function make_unique_writable_directory($basedir, $exceptiononerror = true) {
1448     if (!is_dir($basedir) || !is_writable($basedir)) {
1449         // The basedir is not writable. We will not be able to create the child directory.
1450         if ($exceptiononerror) {
1451             throw new invalid_dataroot_permissions($basedir . ' is not writable. Unable to create a unique directory within it.');
1452         } else {
1453             return false;
1454         }
1455     }
1457     do {
1458         // Generate a new (hopefully unique) directory name.
1459         $uniquedir = $basedir . DIRECTORY_SEPARATOR . generate_uuid();
1460     } while (
1461             // Ensure that basedir is still writable - if we do not check, we could get stuck in a loop here.
1462             is_writable($basedir) &&
1464             // Make the new unique directory. If the directory already exists, it will return false.
1465             !make_writable_directory($uniquedir, $exceptiononerror) &&
1467             // Ensure that the directory now exists
1468             file_exists($uniquedir) && is_dir($uniquedir)
1469         );
1471     // Check that the directory was correctly created.
1472     if (!file_exists($uniquedir) || !is_dir($uniquedir) || !is_writable($uniquedir)) {
1473         if ($exceptiononerror) {
1474             throw new invalid_dataroot_permissions('Unique directory creation failed.');
1475         } else {
1476             return false;
1477         }
1478     }
1480     return $uniquedir;
1483 /**
1484  * Create a directory and make sure it is writable.
1485  *
1486  * @private
1487  * @param string $dir  the full path of the directory to be created
1488  * @param bool $exceptiononerror throw exception if error encountered
1489  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1490  */
1491 function make_writable_directory($dir, $exceptiononerror = true) {
1492     global $CFG;
1494     if (file_exists($dir) and !is_dir($dir)) {
1495         if ($exceptiononerror) {
1496             throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
1497         } else {
1498             return false;
1499         }
1500     }
1502     umask($CFG->umaskpermissions);
1504     if (!file_exists($dir)) {
1505         if (!@mkdir($dir, $CFG->directorypermissions, true)) {
1506             clearstatcache();
1507             // There might be a race condition when creating directory.
1508             if (!is_dir($dir)) {
1509                 if ($exceptiononerror) {
1510                     throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
1511                 } else {
1512                     debugging('Can not create directory: '.$dir, DEBUG_DEVELOPER);
1513                     return false;
1514                 }
1515             }
1516         }
1517     }
1519     if (!is_writable($dir)) {
1520         if ($exceptiononerror) {
1521             throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
1522         } else {
1523             return false;
1524         }
1525     }
1527     return $dir;
1530 /**
1531  * Protect a directory from web access.
1532  * Could be extended in the future to support other mechanisms (e.g. other webservers).
1533  *
1534  * @private
1535  * @param string $dir  the full path of the directory to be protected
1536  */
1537 function protect_directory($dir) {
1538     global $CFG;
1539     // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
1540     if (!file_exists("$dir/.htaccess")) {
1541         if ($handle = fopen("$dir/.htaccess", 'w')) {   // For safety
1542             @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");
1543             @fclose($handle);
1544             @chmod("$dir/.htaccess", $CFG->filepermissions);
1545         }
1546     }
1549 /**
1550  * Create a directory under dataroot and make sure it is writable.
1551  * Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
1552  *
1553  * @param string $directory  the full path of the directory to be created under $CFG->dataroot
1554  * @param bool $exceptiononerror throw exception if error encountered
1555  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1556  */
1557 function make_upload_directory($directory, $exceptiononerror = true) {
1558     global $CFG;
1560     if (strpos($directory, 'temp/') === 0 or $directory === 'temp') {
1561         debugging('Use make_temp_directory() for creation of temporary directory and $CFG->tempdir to get the location.');
1563     } else if (strpos($directory, 'cache/') === 0 or $directory === 'cache') {
1564         debugging('Use make_cache_directory() for creation of cache directory and $CFG->cachedir to get the location.');
1566     } else if (strpos($directory, 'localcache/') === 0 or $directory === 'localcache') {
1567         debugging('Use make_localcache_directory() for creation of local cache directory and $CFG->localcachedir to get the location.');
1568     }
1570     protect_directory($CFG->dataroot);
1571     return make_writable_directory("$CFG->dataroot/$directory", $exceptiononerror);
1574 /**
1575  * Get a per-request storage directory in the tempdir.
1576  *
1577  * The directory is automatically cleaned up during the shutdown handler.
1578  *
1579  * @param bool $exceptiononerror throw exception if error encountered
1580  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1581  */
1582 function get_request_storage_directory($exceptiononerror = true) {
1583     global $CFG;
1585     static $requestdir = null;
1587     if (!$requestdir || !file_exists($requestdir) || !is_dir($requestdir) || !is_writable($requestdir)) {
1588         if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1589             check_dir_exists($CFG->localcachedir, true, true);
1590             protect_directory($CFG->localcachedir);
1591         } else {
1592             protect_directory($CFG->dataroot);
1593         }
1595         if ($requestdir = make_unique_writable_directory($CFG->localcachedir, $exceptiononerror)) {
1596             // Register a shutdown handler to remove the directory.
1597             \core_shutdown_manager::register_function('remove_dir', array($requestdir));
1598         }
1599     }
1601     return $requestdir;
1604 /**
1605  * Create a per-request directory and make sure it is writable.
1606  * This can only be used during the current request and will be tidied away
1607  * automatically afterwards.
1608  *
1609  * A new, unique directory is always created within the current request directory.
1610  *
1611  * @param bool $exceptiononerror throw exception if error encountered
1612  * @return string full path to directory if successful, false if not; may throw exception
1613  */
1614 function make_request_directory($exceptiononerror = true) {
1615     $basedir = get_request_storage_directory($exceptiononerror);
1616     return make_unique_writable_directory($basedir, $exceptiononerror);
1619 /**
1620  * Create a directory under tempdir and make sure it is writable.
1621  *
1622  * Where possible, please use make_request_directory() and limit the scope
1623  * of your data to the current HTTP request.
1624  *
1625  * Do not use for storing cache files - see make_cache_directory(), and
1626  * make_localcache_directory() instead for this purpose.
1627  *
1628  * Temporary files must be on a shared storage, and heavy usage is
1629  * discouraged due to the performance impact upon clustered environments.
1630  *
1631  * @param string $directory  the full path of the directory to be created under $CFG->tempdir
1632  * @param bool $exceptiononerror throw exception if error encountered
1633  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1634  */
1635 function make_temp_directory($directory, $exceptiononerror = true) {
1636     global $CFG;
1637     if ($CFG->tempdir !== "$CFG->dataroot/temp") {
1638         check_dir_exists($CFG->tempdir, true, true);
1639         protect_directory($CFG->tempdir);
1640     } else {
1641         protect_directory($CFG->dataroot);
1642     }
1643     return make_writable_directory("$CFG->tempdir/$directory", $exceptiononerror);
1646 /**
1647  * Create a directory under cachedir and make sure it is writable.
1648  *
1649  * Note: this cache directory is shared by all cluster nodes.
1650  *
1651  * @param string $directory  the full path of the directory to be created under $CFG->cachedir
1652  * @param bool $exceptiononerror throw exception if error encountered
1653  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1654  */
1655 function make_cache_directory($directory, $exceptiononerror = true) {
1656     global $CFG;
1657     if ($CFG->cachedir !== "$CFG->dataroot/cache") {
1658         check_dir_exists($CFG->cachedir, true, true);
1659         protect_directory($CFG->cachedir);
1660     } else {
1661         protect_directory($CFG->dataroot);
1662     }
1663     return make_writable_directory("$CFG->cachedir/$directory", $exceptiononerror);
1666 /**
1667  * Create a directory under localcachedir and make sure it is writable.
1668  * The files in this directory MUST NOT change, use revisions or content hashes to
1669  * work around this limitation - this means you can only add new files here.
1670  *
1671  * The content of this directory gets purged automatically on all cluster nodes
1672  * after calling purge_all_caches() before new data is written to this directory.
1673  *
1674  * Note: this local cache directory does not need to be shared by cluster nodes.
1675  *
1676  * @param string $directory the relative path of the directory to be created under $CFG->localcachedir
1677  * @param bool $exceptiononerror throw exception if error encountered
1678  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1679  */
1680 function make_localcache_directory($directory, $exceptiononerror = true) {
1681     global $CFG;
1683     make_writable_directory($CFG->localcachedir, $exceptiononerror);
1685     if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1686         protect_directory($CFG->localcachedir);
1687     } else {
1688         protect_directory($CFG->dataroot);
1689     }
1691     if (!isset($CFG->localcachedirpurged)) {
1692         $CFG->localcachedirpurged = 0;
1693     }
1694     $timestampfile = "$CFG->localcachedir/.lastpurged";
1696     if (!file_exists($timestampfile)) {
1697         touch($timestampfile);
1698         @chmod($timestampfile, $CFG->filepermissions);
1700     } else if (filemtime($timestampfile) <  $CFG->localcachedirpurged) {
1701         // This means our local cached dir was not purged yet.
1702         remove_dir($CFG->localcachedir, true);
1703         if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1704             protect_directory($CFG->localcachedir);
1705         }
1706         touch($timestampfile);
1707         @chmod($timestampfile, $CFG->filepermissions);
1708         clearstatcache();
1709     }
1711     if ($directory === '') {
1712         return $CFG->localcachedir;
1713     }
1715     return make_writable_directory("$CFG->localcachedir/$directory", $exceptiononerror);
1718 /**
1719  * This class solves the problem of how to initialise $OUTPUT.
1720  *
1721  * The problem is caused be two factors
1722  * <ol>
1723  * <li>On the one hand, we cannot be sure when output will start. In particular,
1724  * an error, which needs to be displayed, could be thrown at any time.</li>
1725  * <li>On the other hand, we cannot be sure when we will have all the information
1726  * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1727  * (potentially) depends on the current course, course categories, and logged in user.
1728  * It also depends on whether the current page requires HTTPS.</li>
1729  * </ol>
1730  *
1731  * So, it is hard to find a single natural place during Moodle script execution,
1732  * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1733  * adopt the following strategy
1734  * <ol>
1735  * <li>We will initialise $OUTPUT the first time it is used.</li>
1736  * <li>If, after $OUTPUT has been initialised, the script tries to change something
1737  * that $OUTPUT depends on, we throw an exception making it clear that the script
1738  * did something wrong.
1739  * </ol>
1740  *
1741  * The only problem with that is, how do we initialise $OUTPUT on first use if,
1742  * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1743  * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1744  * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1745  *
1746  * Note that this class is used before lib/outputlib.php has been loaded, so we
1747  * must be careful referring to classes/functions from there, they may not be
1748  * defined yet, and we must avoid fatal errors.
1749  *
1750  * @copyright 2009 Tim Hunt
1751  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1752  * @since     Moodle 2.0
1753  */
1754 class bootstrap_renderer {
1755     /**
1756      * Handles re-entrancy. Without this, errors or debugging output that occur
1757      * during the initialisation of $OUTPUT, cause infinite recursion.
1758      * @var boolean
1759      */
1760     protected $initialising = false;
1762     /**
1763      * Have we started output yet?
1764      * @return boolean true if the header has been printed.
1765      */
1766     public function has_started() {
1767         return false;
1768     }
1770     /**
1771      * Constructor - to be used by core code only.
1772      * @param string $method The method to call
1773      * @param array $arguments Arguments to pass to the method being called
1774      * @return string
1775      */
1776     public function __call($method, $arguments) {
1777         global $OUTPUT, $PAGE;
1779         $recursing = false;
1780         if ($method == 'notification') {
1781             // Catch infinite recursion caused by debugging output during print_header.
1782             $backtrace = debug_backtrace();
1783             array_shift($backtrace);
1784             array_shift($backtrace);
1785             $recursing = is_early_init($backtrace);
1786         }
1788         $earlymethods = array(
1789             'fatal_error' => 'early_error',
1790             'notification' => 'early_notification',
1791         );
1793         // If lib/outputlib.php has been loaded, call it.
1794         if (!empty($PAGE) && !$recursing) {
1795             if (array_key_exists($method, $earlymethods)) {
1796                 //prevent PAGE->context warnings - exceptions might appear before we set any context
1797                 $PAGE->set_context(null);
1798             }
1799             $PAGE->initialise_theme_and_output();
1800             return call_user_func_array(array($OUTPUT, $method), $arguments);
1801         }
1803         $this->initialising = true;
1805         // Too soon to initialise $OUTPUT, provide a couple of key methods.
1806         if (array_key_exists($method, $earlymethods)) {
1807             return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1808         }
1810         throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1811     }
1813     /**
1814      * Returns nicely formatted error message in a div box.
1815      * @static
1816      * @param string $message error message
1817      * @param string $moreinfourl (ignored in early errors)
1818      * @param string $link (ignored in early errors)
1819      * @param array $backtrace
1820      * @param string $debuginfo
1821      * @return string
1822      */
1823     public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1824         global $CFG;
1826         $content = '<div style="margin-top: 6em; margin-left:auto; margin-right:auto; color:#990000; text-align:center; font-size:large; border-width:1px;
1827 border-color:black; background-color:#ffffee; border-style:solid; border-radius: 20px; border-collapse: collapse;
1828 width: 80%; -moz-border-radius: 20px; padding: 15px">
1829 ' . $message . '
1830 </div>';
1831         // Check whether debug is set.
1832         $debug = (!empty($CFG->debug) && $CFG->debug >= DEBUG_DEVELOPER);
1833         // Also check we have it set in the config file. This occurs if the method to read the config table from the
1834         // database fails, reading from the config table is the first database interaction we have.
1835         $debug = $debug || (!empty($CFG->config_php_settings['debug'])  && $CFG->config_php_settings['debug'] >= DEBUG_DEVELOPER );
1836         if ($debug) {
1837             if (!empty($debuginfo)) {
1838                 $debuginfo = s($debuginfo); // removes all nasty JS
1839                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1840                 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
1841             }
1842             if (!empty($backtrace)) {
1843                 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
1844             }
1845         }
1847         return $content;
1848     }
1850     /**
1851      * This function should only be called by this class, or from exception handlers
1852      * @static
1853      * @param string $message error message
1854      * @param string $moreinfourl (ignored in early errors)
1855      * @param string $link (ignored in early errors)
1856      * @param array $backtrace
1857      * @param string $debuginfo extra information for developers
1858      * @return string
1859      */
1860     public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = null) {
1861         global $CFG;
1863         if (CLI_SCRIPT) {
1864             echo "!!! $message !!!\n";
1865             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1866                 if (!empty($debuginfo)) {
1867                     echo "\nDebug info: $debuginfo";
1868                 }
1869                 if (!empty($backtrace)) {
1870                     echo "\nStack trace: " . format_backtrace($backtrace, true);
1871                 }
1872             }
1873             return;
1875         } else if (AJAX_SCRIPT) {
1876             $e = new stdClass();
1877             $e->error      = $message;
1878             $e->stacktrace = NULL;
1879             $e->debuginfo  = NULL;
1880             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1881                 if (!empty($debuginfo)) {
1882                     $e->debuginfo = $debuginfo;
1883                 }
1884                 if (!empty($backtrace)) {
1885                     $e->stacktrace = format_backtrace($backtrace, true);
1886                 }
1887             }
1888             $e->errorcode  = $errorcode;
1889             @header('Content-Type: application/json; charset=utf-8');
1890             echo json_encode($e);
1891             return;
1892         }
1894         // In the name of protocol correctness, monitoring and performance
1895         // profiling, set the appropriate error headers for machine consumption.
1896         $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
1897         @header($protocol . ' 503 Service Unavailable');
1899         // better disable any caching
1900         @header('Content-Type: text/html; charset=utf-8');
1901         @header('X-UA-Compatible: IE=edge');
1902         @header('Cache-Control: no-store, no-cache, must-revalidate');
1903         @header('Cache-Control: post-check=0, pre-check=0', false);
1904         @header('Pragma: no-cache');
1905         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1906         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1908         if (function_exists('get_string')) {
1909             $strerror = get_string('error');
1910         } else {
1911             $strerror = 'Error';
1912         }
1914         $content = self::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
1916         return self::plain_page($strerror, $content);
1917     }
1919     /**
1920      * Early notification message
1921      * @static
1922      * @param string $message
1923      * @param string $classes usually notifyproblem or notifysuccess
1924      * @return string
1925      */
1926     public static function early_notification($message, $classes = 'notifyproblem') {
1927         return '<div class="' . $classes . '">' . $message . '</div>';
1928     }
1930     /**
1931      * Page should redirect message.
1932      * @static
1933      * @param string $encodedurl redirect url
1934      * @return string
1935      */
1936     public static function plain_redirect_message($encodedurl) {
1937         $message = '<div style="margin-top: 3em; margin-left:auto; margin-right:auto; text-align:center;">' . get_string('pageshouldredirect') . '<br /><a href="'.
1938                 $encodedurl .'">'. get_string('continue') .'</a></div>';
1939         return self::plain_page(get_string('redirect'), $message);
1940     }
1942     /**
1943      * Early redirection page, used before full init of $PAGE global
1944      * @static
1945      * @param string $encodedurl redirect url
1946      * @param string $message redirect message
1947      * @param int $delay time in seconds
1948      * @return string redirect page
1949      */
1950     public static function early_redirect_message($encodedurl, $message, $delay) {
1951         $meta = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />';
1952         $content = self::early_error_content($message, null, null, null);
1953         $content .= self::plain_redirect_message($encodedurl);
1955         return self::plain_page(get_string('redirect'), $content, $meta);
1956     }
1958     /**
1959      * Output basic html page.
1960      * @static
1961      * @param string $title page title
1962      * @param string $content page content
1963      * @param string $meta meta tag
1964      * @return string html page
1965      */
1966     public static function plain_page($title, $content, $meta = '') {
1967         if (function_exists('get_string') && function_exists('get_html_lang')) {
1968             $htmllang = get_html_lang();
1969         } else {
1970             $htmllang = '';
1971         }
1973         $footer = '';
1974         if (MDL_PERF_TEST) {
1975             $perfinfo = get_performance_info();
1976             $footer = '<footer>' . $perfinfo['html'] . '</footer>';
1977         }
1979         return '<!DOCTYPE html>
1980 <html ' . $htmllang . '>
1981 <head>
1982 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1983 '.$meta.'
1984 <title>' . $title . '</title>
1985 </head><body>' . $content . $footer . '</body></html>';
1986     }