Merge branch 'MDL-23514-master' of https://github.com/danielneis/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  * Web service parameter exception class
169  * @deprecated since Moodle 2.2 - use moodle exception instead
170  * This exception must be thrown to the web service client when a web service parameter is invalid
171  * The error string is gotten from webservice.php
172  */
173 class webservice_parameter_exception extends moodle_exception {
174     /**
175      * Constructor
176      * @param string $errorcode The name of the string from webservice.php to print
177      * @param string $a The name of the parameter
178      * @param string $debuginfo Optional information to aid debugging
179      */
180     function __construct($errorcode=null, $a = '', $debuginfo = null) {
181         parent::__construct($errorcode, 'webservice', '', $a, $debuginfo);
182     }
185 /**
186  * Exceptions indicating user does not have permissions to do something
187  * and the execution can not continue.
188  *
189  * @package    core_access
190  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
191  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
192  */
193 class required_capability_exception extends moodle_exception {
194     /**
195      * Constructor
196      * @param context $context The context used for the capability check
197      * @param string $capability The required capability
198      * @param string $errormessage The error message to show the user
199      * @param string $stringfile
200      */
201     function __construct($context, $capability, $errormessage, $stringfile) {
202         $capabilityname = get_capability_string($capability);
203         if ($context->contextlevel == CONTEXT_MODULE and preg_match('/:view$/', $capability)) {
204             // 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
205             $parentcontext = $context->get_parent_context();
206             $link = $parentcontext->get_url();
207         } else {
208             $link = $context->get_url();
209         }
210         parent::__construct($errormessage, $stringfile, $link, $capabilityname);
211     }
214 /**
215  * Exception indicating programming error, must be fixed by a programer. For example
216  * a core API might throw this type of exception if a plugin calls it incorrectly.
217  *
218  * @package    core
219  * @subpackage lib
220  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
221  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
222  */
223 class coding_exception extends moodle_exception {
224     /**
225      * Constructor
226      * @param string $hint short description of problem
227      * @param string $debuginfo detailed information how to fix problem
228      */
229     function __construct($hint, $debuginfo=null) {
230         parent::__construct('codingerror', 'debug', '', $hint, $debuginfo);
231     }
234 /**
235  * Exception indicating malformed parameter problem.
236  * This exception is not supposed to be thrown when processing
237  * user submitted data in forms. It is more suitable
238  * for WS and other low level stuff.
239  *
240  * @package    core
241  * @subpackage lib
242  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
243  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
244  */
245 class invalid_parameter_exception extends moodle_exception {
246     /**
247      * Constructor
248      * @param string $debuginfo some detailed information
249      */
250     function __construct($debuginfo=null) {
251         parent::__construct('invalidparameter', 'debug', '', null, $debuginfo);
252     }
255 /**
256  * Exception indicating malformed response problem.
257  * This exception is not supposed to be thrown when processing
258  * user submitted data in forms. It is more suitable
259  * for WS and other low level stuff.
260  */
261 class invalid_response_exception extends moodle_exception {
262     /**
263      * Constructor
264      * @param string $debuginfo some detailed information
265      */
266     function __construct($debuginfo=null) {
267         parent::__construct('invalidresponse', 'debug', '', null, $debuginfo);
268     }
271 /**
272  * An exception that indicates something really weird happened. For example,
273  * if you do switch ($context->contextlevel), and have one case for each
274  * CONTEXT_... constant. You might throw an invalid_state_exception in the
275  * default case, to just in case something really weird is going on, and
276  * $context->contextlevel is invalid - rather than ignoring this possibility.
277  *
278  * @package    core
279  * @subpackage lib
280  * @copyright  2009 onwards Martin Dougiamas  {@link http://moodle.com}
281  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
282  */
283 class invalid_state_exception extends moodle_exception {
284     /**
285      * Constructor
286      * @param string $hint short description of problem
287      * @param string $debuginfo optional more detailed information
288      */
289     function __construct($hint, $debuginfo=null) {
290         parent::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
291     }
294 /**
295  * An exception that indicates incorrect permissions in $CFG->dataroot
296  *
297  * @package    core
298  * @subpackage lib
299  * @copyright  2010 Petr Skoda {@link http://skodak.org}
300  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
301  */
302 class invalid_dataroot_permissions extends moodle_exception {
303     /**
304      * Constructor
305      * @param string $debuginfo optional more detailed information
306      */
307     function __construct($debuginfo = NULL) {
308         parent::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
309     }
312 /**
313  * An exception that indicates that file can not be served
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 file_serving_exception extends moodle_exception {
321     /**
322      * Constructor
323      * @param string $debuginfo optional more detailed information
324      */
325     function __construct($debuginfo = NULL) {
326         parent::__construct('cannotservefile', 'error', '', NULL, $debuginfo);
327     }
330 /**
331  * Default exception handler, uncaught exceptions are equivalent to error() in 1.9 and earlier
332  *
333  * @param Exception $ex
334  * @return void -does not return. Terminates execution!
335  */
336 function default_exception_handler($ex) {
337     global $CFG, $DB, $OUTPUT, $USER, $FULLME, $SESSION, $PAGE;
339     // detect active db transactions, rollback and log as error
340     abort_all_db_transactions();
342     if (($ex instanceof required_capability_exception) && !CLI_SCRIPT && !AJAX_SCRIPT && !empty($CFG->autologinguests) && !empty($USER->autologinguest)) {
343         $SESSION->wantsurl = qualified_me();
344         redirect(get_login_url());
345     }
347     $info = get_exception_info($ex);
349     if (debugging('', DEBUG_MINIMAL)) {
350         $logerrmsg = "Default exception handler: ".$info->message.' Debug: '.$info->debuginfo."\n".format_backtrace($info->backtrace, true);
351         error_log($logerrmsg);
352     }
354     if (is_early_init($info->backtrace)) {
355         echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo, $info->errorcode);
356     } else {
357         try {
358             if ($DB) {
359                 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
360                 $DB->set_debug(0);
361             }
362             echo $OUTPUT->fatal_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
363         } catch (Exception $out_ex) {
364             // default exception handler MUST not throw any exceptions!!
365             // 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
366             // so we just print at least something instead of "Exception thrown without a stack frame in Unknown on line 0":-(
367             if (CLI_SCRIPT or AJAX_SCRIPT) {
368                 // just ignore the error and send something back using the safest method
369                 echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo, $info->errorcode);
370             } else {
371                 echo bootstrap_renderer::early_error_content($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
372                 $outinfo = get_exception_info($out_ex);
373                 echo bootstrap_renderer::early_error_content($outinfo->message, $outinfo->moreinfourl, $outinfo->link, $outinfo->backtrace, $outinfo->debuginfo);
374             }
375         }
376     }
378     exit(1); // General error code
381 /**
382  * Default error handler, prevents some white screens.
383  * @param int $errno
384  * @param string $errstr
385  * @param string $errfile
386  * @param int $errline
387  * @param array $errcontext
388  * @return bool false means use default error handler
389  */
390 function default_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
391     if ($errno == 4096) {
392         //fatal catchable error
393         throw new coding_exception('PHP catchable fatal error', $errstr);
394     }
395     return false;
398 /**
399  * Unconditionally abort all database transactions, this function
400  * should be called from exception handlers only.
401  * @return void
402  */
403 function abort_all_db_transactions() {
404     global $CFG, $DB, $SCRIPT;
406     // default exception handler MUST not throw any exceptions!!
408     if ($DB && $DB->is_transaction_started()) {
409         error_log('Database transaction aborted automatically in ' . $CFG->dirroot . $SCRIPT);
410         // note: transaction blocks should never change current $_SESSION
411         $DB->force_transaction_rollback();
412     }
415 /**
416  * This function encapsulates the tests for whether an exception was thrown in
417  * early init -- either during setup.php or during init of $OUTPUT.
418  *
419  * If another exception is thrown then, and if we do not take special measures,
420  * we would just get a very cryptic message "Exception thrown without a stack
421  * frame in Unknown on line 0". That makes debugging very hard, so we do take
422  * special measures in default_exception_handler, with the help of this function.
423  *
424  * @param array $backtrace the stack trace to analyse.
425  * @return boolean whether the stack trace is somewhere in output initialisation.
426  */
427 function is_early_init($backtrace) {
428     $dangerouscode = array(
429         array('function' => 'header', 'type' => '->'),
430         array('class' => 'bootstrap_renderer'),
431         array('file' => dirname(__FILE__).'/setup.php'),
432     );
433     foreach ($backtrace as $stackframe) {
434         foreach ($dangerouscode as $pattern) {
435             $matches = true;
436             foreach ($pattern as $property => $value) {
437                 if (!isset($stackframe[$property]) || $stackframe[$property] != $value) {
438                     $matches = false;
439                 }
440             }
441             if ($matches) {
442                 return true;
443             }
444         }
445     }
446     return false;
449 /**
450  * Abort execution by throwing of a general exception,
451  * default exception handler displays the error message in most cases.
452  *
453  * @param string $errorcode The name of the language string containing the error message.
454  *      Normally this should be in the error.php lang file.
455  * @param string $module The language file to get the error message from.
456  * @param string $link The url where the user will be prompted to continue.
457  *      If no url is provided the user will be directed to the site index page.
458  * @param object $a Extra words and phrases that might be required in the error string
459  * @param string $debuginfo optional debugging information
460  * @return void, always throws exception!
461  */
462 function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
463     throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
466 /**
467  * Returns detailed information about specified exception.
468  * @param exception $ex
469  * @return object
470  */
471 function get_exception_info($ex) {
472     global $CFG, $DB, $SESSION;
474     if ($ex instanceof moodle_exception) {
475         $errorcode = $ex->errorcode;
476         $module = $ex->module;
477         $a = $ex->a;
478         $link = $ex->link;
479         $debuginfo = $ex->debuginfo;
480     } else {
481         $errorcode = 'generalexceptionmessage';
482         $module = 'error';
483         $a = $ex->getMessage();
484         $link = '';
485         $debuginfo = '';
486     }
488     // Append the error code to the debug info to make grepping and googling easier
489     $debuginfo .= PHP_EOL."Error code: $errorcode";
491     $backtrace = $ex->getTrace();
492     $place = array('file'=>$ex->getFile(), 'line'=>$ex->getLine(), 'exception'=>get_class($ex));
493     array_unshift($backtrace, $place);
495     // Be careful, no guarantee moodlelib.php is loaded.
496     if (empty($module) || $module == 'moodle' || $module == 'core') {
497         $module = 'error';
498     }
499     // Search for the $errorcode's associated string
500     // If not found, append the contents of $a to $debuginfo so helpful information isn't lost
501     if (function_exists('get_string_manager')) {
502         if (get_string_manager()->string_exists($errorcode, $module)) {
503             $message = get_string($errorcode, $module, $a);
504         } elseif ($module == 'error' && get_string_manager()->string_exists($errorcode, 'moodle')) {
505             // Search in moodle file if error specified - needed for backwards compatibility
506             $message = get_string($errorcode, 'moodle', $a);
507         } else {
508             $message = $module . '/' . $errorcode;
509             $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
510         }
511     } else {
512         $message = $module . '/' . $errorcode;
513         $debuginfo .= PHP_EOL.'$a contents: '.print_r($a, true);
514     }
516     // Remove some absolute paths from message and debugging info.
517     $searches = array();
518     $replaces = array();
519     $cfgnames = array('tempdir', 'cachedir', 'localcachedir', 'themedir', 'dataroot', 'dirroot');
520     foreach ($cfgnames as $cfgname) {
521         if (property_exists($CFG, $cfgname)) {
522             $searches[] = $CFG->$cfgname;
523             $replaces[] = "[$cfgname]";
524         }
525     }
526     if (!empty($searches)) {
527         $message   = str_replace($searches, $replaces, $message);
528         $debuginfo = str_replace($searches, $replaces, $debuginfo);
529     }
531     // Be careful, no guarantee weblib.php is loaded.
532     if (function_exists('clean_text')) {
533         $message = clean_text($message);
534     } else {
535         $message = htmlspecialchars($message);
536     }
538     if (!empty($CFG->errordocroot)) {
539         $errordoclink = $CFG->errordocroot . '/en/';
540     } else {
541         $errordoclink = get_docs_url();
542     }
544     if ($module === 'error') {
545         $modulelink = 'moodle';
546     } else {
547         $modulelink = $module;
548     }
549     $moreinfourl = $errordoclink . 'error/' . $modulelink . '/' . $errorcode;
551     if (empty($link)) {
552         if (!empty($SESSION->fromurl)) {
553             $link = $SESSION->fromurl;
554             unset($SESSION->fromurl);
555         } else {
556             $link = $CFG->wwwroot .'/';
557         }
558     }
560     // when printing an error the continue button should never link offsite
561     if (stripos($link, $CFG->wwwroot) === false &&
562         stripos($link, $CFG->httpswwwroot) === false) {
563         $link = $CFG->wwwroot.'/';
564     }
566     $info = new stdClass();
567     $info->message     = $message;
568     $info->errorcode   = $errorcode;
569     $info->backtrace   = $backtrace;
570     $info->link        = $link;
571     $info->moreinfourl = $moreinfourl;
572     $info->a           = $a;
573     $info->debuginfo   = $debuginfo;
575     return $info;
578 /**
579  * Returns the Moodle Docs URL in the users language for a given 'More help' link.
580  *
581  * There are three cases:
582  *
583  * 1. In the normal case, $path will be a short relative path 'component/thing',
584  * like 'mod/folder/view' 'group/import'. This gets turned into an link to
585  * MoodleDocs in the user's language, and for the appropriate Moodle version.
586  * E.g. 'group/import' may become 'http://docs.moodle.org/2x/en/group/import'.
587  * The 'http://docs.moodle.org' bit comes from $CFG->docroot.
588  *
589  * This is the only option that should be used in standard Moodle code. The other
590  * two options have been implemented because they are useful for third-party plugins.
591  *
592  * 2. $path may be an absolute URL, starting http:// or https://. In this case,
593  * the link is used as is.
594  *
595  * 3. $path may start %%WWWROOT%%, in which case that is replaced by
596  * $CFG->wwwroot to make the link.
597  *
598  * @param string $path the place to link to. See above for details.
599  * @return string The MoodleDocs URL in the user's language. for example @link http://docs.moodle.org/2x/en/$path}
600  */
601 function get_docs_url($path = null) {
602     global $CFG;
604     // Absolute URLs are used unmodified.
605     if (substr($path, 0, 7) === 'http://' || substr($path, 0, 8) === 'https://') {
606         return $path;
607     }
609     // Paths starting %%WWWROOT%% have that replaced by $CFG->wwwroot.
610     if (substr($path, 0, 11) === '%%WWWROOT%%') {
611         return $CFG->wwwroot . substr($path, 11);
612     }
614     // Otherwise we do the normal case, and construct a MoodleDocs URL relative to $CFG->docroot.
616     // Check that $CFG->branch has been set up, during installation it won't be.
617     if (empty($CFG->branch)) {
618         // It's not there yet so look at version.php.
619         include($CFG->dirroot.'/version.php');
620     } else {
621         // We can use $CFG->branch and avoid having to include version.php.
622         $branch = $CFG->branch;
623     }
624     // ensure branch is valid.
625     if (!$branch) {
626         // We should never get here but in case we do lets set $branch to .
627         // the smart one's will know that this is the current directory
628         // and the smarter ones will know that there is some smart matching
629         // that will ensure people end up at the latest version of the docs.
630         $branch = '.';
631     }
632     if (empty($CFG->doclang)) {
633         $lang = current_language();
634     } else {
635         $lang = $CFG->doclang;
636     }
637     $end = '/' . $branch . '/' . $lang . '/' . $path;
638     if (empty($CFG->docroot)) {
639         return 'http://docs.moodle.org'. $end;
640     } else {
641         return $CFG->docroot . $end ;
642     }
645 /**
646  * Formats a backtrace ready for output.
647  *
648  * @param array $callers backtrace array, as returned by debug_backtrace().
649  * @param boolean $plaintext if false, generates HTML, if true generates plain text.
650  * @return string formatted backtrace, ready for output.
651  */
652 function format_backtrace($callers, $plaintext = false) {
653     // do not use $CFG->dirroot because it might not be available in destructors
654     $dirroot = dirname(dirname(__FILE__));
656     if (empty($callers)) {
657         return '';
658     }
660     $from = $plaintext ? '' : '<ul style="text-align: left" data-rel="backtrace">';
661     foreach ($callers as $caller) {
662         if (!isset($caller['line'])) {
663             $caller['line'] = '?'; // probably call_user_func()
664         }
665         if (!isset($caller['file'])) {
666             $caller['file'] = 'unknownfile'; // probably call_user_func()
667         }
668         $from .= $plaintext ? '* ' : '<li>';
669         $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
670         if (isset($caller['function'])) {
671             $from .= ': call to ';
672             if (isset($caller['class'])) {
673                 $from .= $caller['class'] . $caller['type'];
674             }
675             $from .= $caller['function'] . '()';
676         } else if (isset($caller['exception'])) {
677             $from .= ': '.$caller['exception'].' thrown';
678         }
679         $from .= $plaintext ? "\n" : '</li>';
680     }
681     $from .= $plaintext ? '' : '</ul>';
683     return $from;
686 /**
687  * This function makes the return value of ini_get consistent if you are
688  * setting server directives through the .htaccess file in apache.
689  *
690  * Current behavior for value set from php.ini On = 1, Off = [blank]
691  * Current behavior for value set from .htaccess On = On, Off = Off
692  * Contributed by jdell @ unr.edu
693  *
694  * @param string $ini_get_arg The argument to get
695  * @return bool True for on false for not
696  */
697 function ini_get_bool($ini_get_arg) {
698     $temp = ini_get($ini_get_arg);
700     if ($temp == '1' or strtolower($temp) == 'on') {
701         return true;
702     }
703     return false;
706 /**
707  * This function verifies the sanity of PHP configuration
708  * and stops execution if anything critical found.
709  */
710 function setup_validate_php_configuration() {
711    // this must be very fast - no slow checks here!!!
713    if (ini_get_bool('session.auto_start')) {
714        print_error('sessionautostartwarning', 'admin');
715    }
718 /**
719  * Initialise global $CFG variable.
720  * @private to be used only from lib/setup.php
721  */
722 function initialise_cfg() {
723     global $CFG, $DB;
725     if (!$DB) {
726         // This should not happen.
727         return;
728     }
730     try {
731         $localcfg = get_config('core');
732     } catch (dml_exception $e) {
733         // Most probably empty db, going to install soon.
734         return;
735     }
737     foreach ($localcfg as $name => $value) {
738         // Note that get_config() keeps forced settings
739         // and normalises values to string if possible.
740         $CFG->{$name} = $value;
741     }
744 /**
745  * Initialises $FULLME and friends. Private function. Should only be called from
746  * setup.php.
747  */
748 function initialise_fullme() {
749     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
751     // Detect common config error.
752     if (substr($CFG->wwwroot, -1) == '/') {
753         print_error('wwwrootslash', 'error');
754     }
756     if (CLI_SCRIPT) {
757         initialise_fullme_cli();
758         return;
759     }
761     $rurl = setup_get_remote_url();
762     $wwwroot = parse_url($CFG->wwwroot.'/');
764     if (empty($rurl['host'])) {
765         // missing host in request header, probably not a real browser, let's ignore them
767     } else if (!empty($CFG->reverseproxy)) {
768         // $CFG->reverseproxy specifies if reverse proxy server used
769         // Used in load balancing scenarios.
770         // Do not abuse this to try to solve lan/wan access problems!!!!!
772     } else {
773         if (($rurl['host'] !== $wwwroot['host']) or
774                 (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port']) or
775                 (strpos($rurl['path'], $wwwroot['path']) !== 0)) {
777             // Explain the problem and redirect them to the right URL
778             if (!defined('NO_MOODLE_COOKIES')) {
779                 define('NO_MOODLE_COOKIES', true);
780             }
781             // The login/token.php script should call the correct url/port.
782             if (defined('REQUIRE_CORRECT_ACCESS') && REQUIRE_CORRECT_ACCESS) {
783                 $wwwrootport = empty($wwwroot['port'])?'':$wwwroot['port'];
784                 $calledurl = $rurl['host'];
785                 if (!empty($rurl['port'])) {
786                     $calledurl .=  ':'. $rurl['port'];
787                 }
788                 $correcturl = $wwwroot['host'];
789                 if (!empty($wwwrootport)) {
790                     $correcturl .=  ':'. $wwwrootport;
791                 }
792                 throw new moodle_exception('requirecorrectaccess', 'error', '', null,
793                     'You called ' . $calledurl .', you should have called ' . $correcturl);
794             }
795             redirect($CFG->wwwroot, get_string('wwwrootmismatch', 'error', $CFG->wwwroot), 3);
796         }
797     }
799     // Check that URL is under $CFG->wwwroot.
800     if (strpos($rurl['path'], $wwwroot['path']) === 0) {
801         $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
802     } else {
803         // Probably some weird external script
804         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
805         return;
806     }
808     // $CFG->sslproxy specifies if external SSL appliance is used
809     // (That is, the Moodle server uses http, with an external box translating everything to https).
810     if (empty($CFG->sslproxy)) {
811         if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
812             print_error('sslonlyaccess', 'error');
813         }
814     } else {
815         if ($wwwroot['scheme'] !== 'https') {
816             throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
817         }
818         $rurl['scheme'] = 'https'; // make moodle believe it runs on https, squid or something else it doing it
819     }
821     // hopefully this will stop all those "clever" admins trying to set up moodle
822     // with two different addresses in intranet and Internet
823     if (!empty($CFG->reverseproxy) && $rurl['host'] === $wwwroot['host']) {
824         print_error('reverseproxyabused', 'error');
825     }
827     $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
828     if (!empty($wwwroot['port'])) {
829         $hostandport .= ':'.$wwwroot['port'];
830     }
832     $FULLSCRIPT = $hostandport . $rurl['path'];
833     $FULLME = $hostandport . $rurl['fullpath'];
834     $ME = $rurl['fullpath'];
837 /**
838  * Initialises $FULLME and friends for command line scripts.
839  * This is a private method for use by initialise_fullme.
840  */
841 function initialise_fullme_cli() {
842     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
844     // Urls do not make much sense in CLI scripts
845     $backtrace = debug_backtrace();
846     $topfile = array_pop($backtrace);
847     $topfile = realpath($topfile['file']);
848     $dirroot = realpath($CFG->dirroot);
850     if (strpos($topfile, $dirroot) !== 0) {
851         // Probably some weird external script
852         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
853     } else {
854         $relativefile = substr($topfile, strlen($dirroot));
855         $relativefile = str_replace('\\', '/', $relativefile); // Win fix
856         $SCRIPT = $FULLSCRIPT = $relativefile;
857         $FULLME = $ME = null;
858     }
861 /**
862  * Get the URL that PHP/the web server thinks it is serving. Private function
863  * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
864  * @return array in the same format that parse_url returns, with the addition of
865  *      a 'fullpath' element, which includes any slasharguments path.
866  */
867 function setup_get_remote_url() {
868     $rurl = array();
869     if (isset($_SERVER['HTTP_HOST'])) {
870         list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
871     } else {
872         $rurl['host'] = null;
873     }
874     $rurl['port'] = $_SERVER['SERVER_PORT'];
875     $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
876     $rurl['scheme'] = (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] === 'off' or $_SERVER['HTTPS'] === 'Off' or $_SERVER['HTTPS'] === 'OFF') ? 'http' : 'https';
878     if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
879         //Apache server
880         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
882     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
883         //IIS - needs a lot of tweaking to make it work
884         $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
886         // NOTE: ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS
887         //       since 2.0 we rely on iis rewrite extenssion like Helicon ISAPI_rewrite
888         //       example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
890         if ($_SERVER['QUERY_STRING'] != '') {
891             $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
892         }
893         $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
895 /* NOTE: following servers are not fully tested! */
897     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
898         //lighttpd - not officially supported
899         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
901     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
902         //nginx - not officially supported
903         if (!isset($_SERVER['SCRIPT_NAME'])) {
904             die('Invalid server configuration detected, please try to add "fastcgi_param SCRIPT_NAME $fastcgi_script_name;" to the nginx server configuration.');
905         }
906         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
908      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
909          //cherokee - not officially supported
910          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
912      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
913          //zeus - not officially supported
914          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
916     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
917         //LiteSpeed - not officially supported
918         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
920     } else if ($_SERVER['SERVER_SOFTWARE'] === 'HTTPD') {
921         //obscure name found on some servers - this is definitely not supported
922         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
924     } else if (strpos($_SERVER['SERVER_SOFTWARE'], 'PHP') === 0) {
925         // built-in PHP Development Server
926         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
928     } else {
929         throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
930     }
932     // sanitize the url a bit more, the encoding style may be different in vars above
933     $rurl['fullpath'] = str_replace('"', '%22', $rurl['fullpath']);
934     $rurl['fullpath'] = str_replace('\'', '%27', $rurl['fullpath']);
936     return $rurl;
939 /**
940  * Try to work around the 'max_input_vars' restriction if necessary.
941  */
942 function workaround_max_input_vars() {
943     // Make sure this gets executed only once from lib/setup.php!
944     static $executed = false;
945     if ($executed) {
946         debugging('workaround_max_input_vars() must be called only once!');
947         return;
948     }
949     $executed = true;
951     if (!isset($_SERVER["CONTENT_TYPE"]) or strpos($_SERVER["CONTENT_TYPE"], 'multipart/form-data') !== false) {
952         // Not a post or 'multipart/form-data' which is not compatible with "php://input" reading.
953         return;
954     }
956     if (!isloggedin() or isguestuser()) {
957         // Only real users post huge forms.
958         return;
959     }
961     $max = (int)ini_get('max_input_vars');
963     if ($max <= 0) {
964         // Most probably PHP < 5.3.9 that does not implement this limit.
965         return;
966     }
968     if ($max >= 200000) {
969         // This value should be ok for all our forms, by setting it in php.ini
970         // admins may prevent any unexpected regressions caused by this hack.
972         // Note there is no need to worry about DDoS caused by making this limit very high
973         // because there are very many easier ways to DDoS any Moodle server.
974         return;
975     }
977     if (count($_POST, COUNT_RECURSIVE) < $max) {
978         return;
979     }
981     // Large POST request with enctype supported by php://input.
982     // Parse php://input in chunks to bypass max_input_vars limit, which also applies to parse_str().
983     $str = file_get_contents("php://input");
984     if ($str === false or $str === '') {
985         // Some weird error.
986         return;
987     }
989     $delim = '&';
990     $fun = create_function('$p', 'return implode("'.$delim.'", $p);');
991     $chunks = array_map($fun, array_chunk(explode($delim, $str), $max));
993     foreach ($chunks as $chunk) {
994         $values = array();
995         parse_str($chunk, $values);
997         merge_query_params($_POST, $values);
998         merge_query_params($_REQUEST, $values);
999     }
1002 /**
1003  * Merge parsed POST chunks.
1004  *
1005  * NOTE: this is not perfect, but it should work in most cases hopefully.
1006  *
1007  * @param array $target
1008  * @param array $values
1009  */
1010 function merge_query_params(array &$target, array $values) {
1011     if (isset($values[0]) and isset($target[0])) {
1012         // This looks like a split [] array, lets verify the keys are continuous starting with 0.
1013         $keys1 = array_keys($values);
1014         $keys2 = array_keys($target);
1015         if ($keys1 === array_keys($keys1) and $keys2 === array_keys($keys2)) {
1016             foreach ($values as $v) {
1017                 $target[] = $v;
1018             }
1019             return;
1020         }
1021     }
1022     foreach ($values as $k => $v) {
1023         if (!isset($target[$k])) {
1024             $target[$k] = $v;
1025             continue;
1026         }
1027         if (is_array($target[$k]) and is_array($v)) {
1028             merge_query_params($target[$k], $v);
1029             continue;
1030         }
1031         // We should not get here unless there are duplicates in params.
1032         $target[$k] = $v;
1033     }
1036 /**
1037  * Initializes our performance info early.
1038  *
1039  * Pairs up with get_performance_info() which is actually
1040  * in moodlelib.php. This function is here so that we can
1041  * call it before all the libs are pulled in.
1042  *
1043  * @uses $PERF
1044  */
1045 function init_performance_info() {
1047     global $PERF, $CFG, $USER;
1049     $PERF = new stdClass();
1050     $PERF->logwrites = 0;
1051     if (function_exists('microtime')) {
1052         $PERF->starttime = microtime();
1053     }
1054     if (function_exists('memory_get_usage')) {
1055         $PERF->startmemory = memory_get_usage();
1056     }
1057     if (function_exists('posix_times')) {
1058         $PERF->startposixtimes = posix_times();
1059     }
1062 /**
1063  * Indicates whether we are in the middle of the initial Moodle install.
1064  *
1065  * Very occasionally it is necessary avoid running certain bits of code before the
1066  * Moodle installation has completed. The installed flag is set in admin/index.php
1067  * after Moodle core and all the plugins have been installed, but just before
1068  * the person doing the initial install is asked to choose the admin password.
1069  *
1070  * @return boolean true if the initial install is not complete.
1071  */
1072 function during_initial_install() {
1073     global $CFG;
1074     return empty($CFG->rolesactive);
1077 /**
1078  * Function to raise the memory limit to a new value.
1079  * Will respect the memory limit if it is higher, thus allowing
1080  * settings in php.ini, apache conf or command line switches
1081  * to override it.
1082  *
1083  * The memory limit should be expressed with a constant
1084  * MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE.
1085  * It is possible to use strings or integers too (eg:'128M').
1086  *
1087  * @param mixed $newlimit the new memory limit
1088  * @return bool success
1089  */
1090 function raise_memory_limit($newlimit) {
1091     global $CFG;
1093     if ($newlimit == MEMORY_UNLIMITED) {
1094         ini_set('memory_limit', -1);
1095         return true;
1097     } else if ($newlimit == MEMORY_STANDARD) {
1098         if (PHP_INT_SIZE > 4) {
1099             $newlimit = get_real_size('128M'); // 64bit needs more memory
1100         } else {
1101             $newlimit = get_real_size('96M');
1102         }
1104     } else if ($newlimit == MEMORY_EXTRA) {
1105         if (PHP_INT_SIZE > 4) {
1106             $newlimit = get_real_size('384M'); // 64bit needs more memory
1107         } else {
1108             $newlimit = get_real_size('256M');
1109         }
1110         if (!empty($CFG->extramemorylimit)) {
1111             $extra = get_real_size($CFG->extramemorylimit);
1112             if ($extra > $newlimit) {
1113                 $newlimit = $extra;
1114             }
1115         }
1117     } else if ($newlimit == MEMORY_HUGE) {
1118         // MEMORY_HUGE uses 2G or MEMORY_EXTRA, whichever is bigger.
1119         $newlimit = get_real_size('2G');
1120         if (!empty($CFG->extramemorylimit)) {
1121             $extra = get_real_size($CFG->extramemorylimit);
1122             if ($extra > $newlimit) {
1123                 $newlimit = $extra;
1124             }
1125         }
1127     } else {
1128         $newlimit = get_real_size($newlimit);
1129     }
1131     if ($newlimit <= 0) {
1132         debugging('Invalid memory limit specified.');
1133         return false;
1134     }
1136     $cur = ini_get('memory_limit');
1137     if (empty($cur)) {
1138         // if php is compiled without --enable-memory-limits
1139         // apparently memory_limit is set to ''
1140         $cur = 0;
1141     } else {
1142         if ($cur == -1){
1143             return true; // unlimited mem!
1144         }
1145         $cur = get_real_size($cur);
1146     }
1148     if ($newlimit > $cur) {
1149         ini_set('memory_limit', $newlimit);
1150         return true;
1151     }
1152     return false;
1155 /**
1156  * Function to reduce the memory limit to a new value.
1157  * Will respect the memory limit if it is lower, thus allowing
1158  * settings in php.ini, apache conf or command line switches
1159  * to override it
1160  *
1161  * The memory limit should be expressed with a string (eg:'64M')
1162  *
1163  * @param string $newlimit the new memory limit
1164  * @return bool
1165  */
1166 function reduce_memory_limit($newlimit) {
1167     if (empty($newlimit)) {
1168         return false;
1169     }
1170     $cur = ini_get('memory_limit');
1171     if (empty($cur)) {
1172         // if php is compiled without --enable-memory-limits
1173         // apparently memory_limit is set to ''
1174         $cur = 0;
1175     } else {
1176         if ($cur == -1){
1177             return true; // unlimited mem!
1178         }
1179         $cur = get_real_size($cur);
1180     }
1182     $new = get_real_size($newlimit);
1183     // -1 is smaller, but it means unlimited
1184     if ($new < $cur && $new != -1) {
1185         ini_set('memory_limit', $newlimit);
1186         return true;
1187     }
1188     return false;
1191 /**
1192  * Converts numbers like 10M into bytes.
1193  *
1194  * @param string $size The size to be converted
1195  * @return int
1196  */
1197 function get_real_size($size = 0) {
1198     if (!$size) {
1199         return 0;
1200     }
1201     $scan = array();
1202     $scan['GB'] = 1073741824;
1203     $scan['Gb'] = 1073741824;
1204     $scan['G'] = 1073741824;
1205     $scan['MB'] = 1048576;
1206     $scan['Mb'] = 1048576;
1207     $scan['M'] = 1048576;
1208     $scan['m'] = 1048576;
1209     $scan['KB'] = 1024;
1210     $scan['Kb'] = 1024;
1211     $scan['K'] = 1024;
1212     $scan['k'] = 1024;
1214     while (list($key) = each($scan)) {
1215         if ((strlen($size)>strlen($key))&&(substr($size, strlen($size) - strlen($key))==$key)) {
1216             $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
1217             break;
1218         }
1219     }
1220     return $size;
1223 /**
1224  * Try to disable all output buffering and purge
1225  * all headers.
1226  *
1227  * @access private to be called only from lib/setup.php !
1228  * @return void
1229  */
1230 function disable_output_buffering() {
1231     $olddebug = error_reporting(0);
1233     // disable compression, it would prevent closing of buffers
1234     if (ini_get_bool('zlib.output_compression')) {
1235         ini_set('zlib.output_compression', 'Off');
1236     }
1238     // try to flush everything all the time
1239     ob_implicit_flush(true);
1241     // close all buffers if possible and discard any existing output
1242     // this can actually work around some whitespace problems in config.php
1243     while(ob_get_level()) {
1244         if (!ob_end_clean()) {
1245             // prevent infinite loop when buffer can not be closed
1246             break;
1247         }
1248     }
1250     // disable any other output handlers
1251     ini_set('output_handler', '');
1253     error_reporting($olddebug);
1256 /**
1257  * Check whether a major upgrade is needed. That is defined as an upgrade that
1258  * changes something really fundamental in the database, so nothing can possibly
1259  * work until the database has been updated, and that is defined by the hard-coded
1260  * version number in this function.
1261  */
1262 function redirect_if_major_upgrade_required() {
1263     global $CFG;
1264     $lastmajordbchanges = 2014012400.00;
1265     if (empty($CFG->version) or (float)$CFG->version < $lastmajordbchanges or
1266             during_initial_install() or !empty($CFG->adminsetuppending)) {
1267         try {
1268             @\core\session\manager::terminate_current();
1269         } catch (Exception $e) {
1270             // Ignore any errors, redirect to upgrade anyway.
1271         }
1272         $url = $CFG->wwwroot . '/' . $CFG->admin . '/index.php';
1273         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
1274         @header('Location: ' . $url);
1275         echo bootstrap_renderer::plain_redirect_message(htmlspecialchars($url));
1276         exit;
1277     }
1280 /**
1281  * Makes sure that upgrade process is not running
1282  *
1283  * To be inserted in the core functions that can not be called by pluigns during upgrade.
1284  * Core upgrade should not use any API functions at all.
1285  * See {@link http://docs.moodle.org/dev/Upgrade_API#Upgrade_code_restrictions}
1286  *
1287  * @throws moodle_exception if executed from inside of upgrade script and $warningonly is false
1288  * @param bool $warningonly if true displays a warning instead of throwing an exception
1289  * @return bool true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only
1290  */
1291 function upgrade_ensure_not_running($warningonly = false) {
1292     global $CFG;
1293     if (!empty($CFG->upgraderunning)) {
1294         if (!$warningonly) {
1295             throw new moodle_exception('cannotexecduringupgrade');
1296         } else {
1297             debugging(get_string('cannotexecduringupgrade', 'error'), DEBUG_DEVELOPER);
1298             return false;
1299         }
1300     }
1301     return true;
1304 /**
1305  * Function to check if a directory exists and by default create it if not exists.
1306  *
1307  * Previously this was accepting paths only from dataroot, but we now allow
1308  * files outside of dataroot if you supply custom paths for some settings in config.php.
1309  * This function does not verify that the directory is writable.
1310  *
1311  * NOTE: this function uses current file stat cache,
1312  *       please use clearstatcache() before this if you expect that the
1313  *       directories may have been removed recently from a different request.
1314  *
1315  * @param string $dir absolute directory path
1316  * @param boolean $create directory if does not exist
1317  * @param boolean $recursive create directory recursively
1318  * @return boolean true if directory exists or created, false otherwise
1319  */
1320 function check_dir_exists($dir, $create = true, $recursive = true) {
1321     global $CFG;
1323     umask($CFG->umaskpermissions);
1325     if (is_dir($dir)) {
1326         return true;
1327     }
1329     if (!$create) {
1330         return false;
1331     }
1333     return mkdir($dir, $CFG->directorypermissions, $recursive);
1336 /**
1337  * Create a directory and make sure it is writable.
1338  *
1339  * @private
1340  * @param string $dir  the full path of the directory to be created
1341  * @param bool $exceptiononerror throw exception if error encountered
1342  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1343  */
1344 function make_writable_directory($dir, $exceptiononerror = true) {
1345     global $CFG;
1347     if (file_exists($dir) and !is_dir($dir)) {
1348         if ($exceptiononerror) {
1349             throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
1350         } else {
1351             return false;
1352         }
1353     }
1355     umask($CFG->umaskpermissions);
1357     if (!file_exists($dir)) {
1358         if (!mkdir($dir, $CFG->directorypermissions, true)) {
1359             clearstatcache();
1360             // There might be a race condition when creating directory.
1361             if (!is_dir($dir)) {
1362                 if ($exceptiononerror) {
1363                     throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
1364                 } else {
1365                     debugging('Can not create directory: '.$dir, DEBUG_DEVELOPER);
1366                     return false;
1367                 }
1368             }
1369         }
1370     }
1372     if (!is_writable($dir)) {
1373         if ($exceptiononerror) {
1374             throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
1375         } else {
1376             return false;
1377         }
1378     }
1380     return $dir;
1383 /**
1384  * Protect a directory from web access.
1385  * Could be extended in the future to support other mechanisms (e.g. other webservers).
1386  *
1387  * @private
1388  * @param string $dir  the full path of the directory to be protected
1389  */
1390 function protect_directory($dir) {
1391     global $CFG;
1392     // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
1393     if (!file_exists("$dir/.htaccess")) {
1394         if ($handle = fopen("$dir/.htaccess", 'w')) {   // For safety
1395             @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");
1396             @fclose($handle);
1397             @chmod("$dir/.htaccess", $CFG->filepermissions);
1398         }
1399     }
1402 /**
1403  * Create a directory under dataroot and make sure it is writable.
1404  * Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
1405  *
1406  * @param string $directory  the full path of the directory to be created under $CFG->dataroot
1407  * @param bool $exceptiononerror throw exception if error encountered
1408  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1409  */
1410 function make_upload_directory($directory, $exceptiononerror = true) {
1411     global $CFG;
1413     if (strpos($directory, 'temp/') === 0 or $directory === 'temp') {
1414         debugging('Use make_temp_directory() for creation of temporary directory and $CFG->tempdir to get the location.');
1416     } else if (strpos($directory, 'cache/') === 0 or $directory === 'cache') {
1417         debugging('Use make_cache_directory() for creation of cache directory and $CFG->cachedir to get the location.');
1419     } else if (strpos($directory, 'localcache/') === 0 or $directory === 'localcache') {
1420         debugging('Use make_localcache_directory() for creation of local cache directory and $CFG->localcachedir to get the location.');
1421     }
1423     protect_directory($CFG->dataroot);
1424     return make_writable_directory("$CFG->dataroot/$directory", $exceptiononerror);
1427 /**
1428  * Create a directory under tempdir and make sure it is writable.
1429  * Temporary files should be used during the current request only!
1430  *
1431  * @param string $directory  the full path of the directory to be created under $CFG->tempdir
1432  * @param bool $exceptiononerror throw exception if error encountered
1433  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1434  */
1435 function make_temp_directory($directory, $exceptiononerror = true) {
1436     global $CFG;
1437     if ($CFG->tempdir !== "$CFG->dataroot/temp") {
1438         check_dir_exists($CFG->tempdir, true, true);
1439         protect_directory($CFG->tempdir);
1440     } else {
1441         protect_directory($CFG->dataroot);
1442     }
1443     return make_writable_directory("$CFG->tempdir/$directory", $exceptiononerror);
1446 /**
1447  * Create a directory under cachedir and make sure it is writable.
1448  *
1449  * Note: this cache directory is shared by all cluster nodes.
1450  *
1451  * @param string $directory  the full path of the directory to be created under $CFG->cachedir
1452  * @param bool $exceptiononerror throw exception if error encountered
1453  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1454  */
1455 function make_cache_directory($directory, $exceptiononerror = true) {
1456     global $CFG;
1457     if ($CFG->cachedir !== "$CFG->dataroot/cache") {
1458         check_dir_exists($CFG->cachedir, true, true);
1459         protect_directory($CFG->cachedir);
1460     } else {
1461         protect_directory($CFG->dataroot);
1462     }
1463     return make_writable_directory("$CFG->cachedir/$directory", $exceptiononerror);
1466 /**
1467  * Create a directory under localcachedir and make sure it is writable.
1468  * The files in this directory MUST NOT change, use revisions or content hashes to
1469  * work around this limitation - this means you can only add new files here.
1470  *
1471  * The content of this directory gets purged automatically on all cluster nodes
1472  * after calling purge_all_caches() before new data is written to this directory.
1473  *
1474  * Note: this local cache directory does not need to be shared by cluster nodes.
1475  *
1476  * @param string $directory the relative path of the directory to be created under $CFG->localcachedir
1477  * @param bool $exceptiononerror throw exception if error encountered
1478  * @return string|false Returns full path to directory if successful, false if not; may throw exception
1479  */
1480 function make_localcache_directory($directory, $exceptiononerror = true) {
1481     global $CFG;
1483     make_writable_directory($CFG->localcachedir, $exceptiononerror);
1485     if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1486         protect_directory($CFG->localcachedir);
1487     } else {
1488         protect_directory($CFG->dataroot);
1489     }
1491     if (!isset($CFG->localcachedirpurged)) {
1492         $CFG->localcachedirpurged = 0;
1493     }
1494     $timestampfile = "$CFG->localcachedir/.lastpurged";
1496     if (!file_exists($timestampfile)) {
1497         touch($timestampfile);
1498         @chmod($timestampfile, $CFG->filepermissions);
1500     } else if (filemtime($timestampfile) <  $CFG->localcachedirpurged) {
1501         // This means our local cached dir was not purged yet.
1502         remove_dir($CFG->localcachedir, true);
1503         if ($CFG->localcachedir !== "$CFG->dataroot/localcache") {
1504             protect_directory($CFG->localcachedir);
1505         }
1506         touch($timestampfile);
1507         @chmod($timestampfile, $CFG->filepermissions);
1508         clearstatcache();
1509     }
1511     if ($directory === '') {
1512         return $CFG->localcachedir;
1513     }
1515     return make_writable_directory("$CFG->localcachedir/$directory", $exceptiononerror);
1518 /**
1519  * Checks if current user is a web crawler.
1520  *
1521  * This list can not be made complete, this is not a security
1522  * restriction, we make the list only to help these sites
1523  * especially when automatic guest login is disabled.
1524  *
1525  * If admin needs security they should enable forcelogin
1526  * and disable guest access!!
1527  *
1528  * @return bool
1529  */
1530 function is_web_crawler() {
1531     if (!empty($_SERVER['HTTP_USER_AGENT'])) {
1532         if (strpos($_SERVER['HTTP_USER_AGENT'], 'Googlebot') !== false ) {
1533             return true;
1534         } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'google.com') !== false ) { // Google
1535             return true;
1536         } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Yahoo! Slurp') !== false ) {  // Yahoo
1537             return true;
1538         } else if (strpos($_SERVER['HTTP_USER_AGENT'], '[ZSEBOT]') !== false ) {  // Zoomspider
1539             return true;
1540         } else if (stripos($_SERVER['HTTP_USER_AGENT'], 'msnbot') !== false ) {  // MSN Search
1541             return true;
1542         } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'bingbot') !== false ) {  // Bing
1543             return true;
1544         } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Yandex') !== false ) {
1545             return true;
1546         } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'AltaVista') !== false ) {
1547             return true;
1548         } else if (stripos($_SERVER['HTTP_USER_AGENT'], 'baiduspider') !== false ) {  // Baidu
1549             return true;
1550         } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Teoma') !== false ) {  // Ask.com
1551             return true;
1552         }
1553     }
1554     return false;
1557 /**
1558  * This class solves the problem of how to initialise $OUTPUT.
1559  *
1560  * The problem is caused be two factors
1561  * <ol>
1562  * <li>On the one hand, we cannot be sure when output will start. In particular,
1563  * an error, which needs to be displayed, could be thrown at any time.</li>
1564  * <li>On the other hand, we cannot be sure when we will have all the information
1565  * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1566  * (potentially) depends on the current course, course categories, and logged in user.
1567  * It also depends on whether the current page requires HTTPS.</li>
1568  * </ol>
1569  *
1570  * So, it is hard to find a single natural place during Moodle script execution,
1571  * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1572  * adopt the following strategy
1573  * <ol>
1574  * <li>We will initialise $OUTPUT the first time it is used.</li>
1575  * <li>If, after $OUTPUT has been initialised, the script tries to change something
1576  * that $OUTPUT depends on, we throw an exception making it clear that the script
1577  * did something wrong.
1578  * </ol>
1579  *
1580  * The only problem with that is, how do we initialise $OUTPUT on first use if,
1581  * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1582  * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1583  * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1584  *
1585  * Note that this class is used before lib/outputlib.php has been loaded, so we
1586  * must be careful referring to classes/functions from there, they may not be
1587  * defined yet, and we must avoid fatal errors.
1588  *
1589  * @copyright 2009 Tim Hunt
1590  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1591  * @since     Moodle 2.0
1592  */
1593 class bootstrap_renderer {
1594     /**
1595      * Handles re-entrancy. Without this, errors or debugging output that occur
1596      * during the initialisation of $OUTPUT, cause infinite recursion.
1597      * @var boolean
1598      */
1599     protected $initialising = false;
1601     /**
1602      * Have we started output yet?
1603      * @return boolean true if the header has been printed.
1604      */
1605     public function has_started() {
1606         return false;
1607     }
1609     /**
1610      * Constructor - to be used by core code only.
1611      * @param string $method The method to call
1612      * @param array $arguments Arguments to pass to the method being called
1613      * @return string
1614      */
1615     public function __call($method, $arguments) {
1616         global $OUTPUT, $PAGE;
1618         $recursing = false;
1619         if ($method == 'notification') {
1620             // Catch infinite recursion caused by debugging output during print_header.
1621             $backtrace = debug_backtrace();
1622             array_shift($backtrace);
1623             array_shift($backtrace);
1624             $recursing = is_early_init($backtrace);
1625         }
1627         $earlymethods = array(
1628             'fatal_error' => 'early_error',
1629             'notification' => 'early_notification',
1630         );
1632         // If lib/outputlib.php has been loaded, call it.
1633         if (!empty($PAGE) && !$recursing) {
1634             if (array_key_exists($method, $earlymethods)) {
1635                 //prevent PAGE->context warnings - exceptions might appear before we set any context
1636                 $PAGE->set_context(null);
1637             }
1638             $PAGE->initialise_theme_and_output();
1639             return call_user_func_array(array($OUTPUT, $method), $arguments);
1640         }
1642         $this->initialising = true;
1644         // Too soon to initialise $OUTPUT, provide a couple of key methods.
1645         if (array_key_exists($method, $earlymethods)) {
1646             return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1647         }
1649         throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1650     }
1652     /**
1653      * Returns nicely formatted error message in a div box.
1654      * @static
1655      * @param string $message error message
1656      * @param string $moreinfourl (ignored in early errors)
1657      * @param string $link (ignored in early errors)
1658      * @param array $backtrace
1659      * @param string $debuginfo
1660      * @return string
1661      */
1662     public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1663         global $CFG;
1665         $content = '<div style="margin-top: 6em; margin-left:auto; margin-right:auto; color:#990000; text-align:center; font-size:large; border-width:1px;
1666 border-color:black; background-color:#ffffee; border-style:solid; border-radius: 20px; border-collapse: collapse;
1667 width: 80%; -moz-border-radius: 20px; padding: 15px">
1668 ' . $message . '
1669 </div>';
1670         // Check whether debug is set.
1671         $debug = (!empty($CFG->debug) && $CFG->debug >= DEBUG_DEVELOPER);
1672         // Also check we have it set in the config file. This occurs if the method to read the config table from the
1673         // database fails, reading from the config table is the first database interaction we have.
1674         $debug = $debug || (!empty($CFG->config_php_settings['debug'])  && $CFG->config_php_settings['debug'] >= DEBUG_DEVELOPER );
1675         if ($debug) {
1676             if (!empty($debuginfo)) {
1677                 $debuginfo = s($debuginfo); // removes all nasty JS
1678                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1679                 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
1680             }
1681             if (!empty($backtrace)) {
1682                 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
1683             }
1684         }
1686         return $content;
1687     }
1689     /**
1690      * This function should only be called by this class, or from exception handlers
1691      * @static
1692      * @param string $message error message
1693      * @param string $moreinfourl (ignored in early errors)
1694      * @param string $link (ignored in early errors)
1695      * @param array $backtrace
1696      * @param string $debuginfo extra information for developers
1697      * @return string
1698      */
1699     public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = null) {
1700         global $CFG;
1702         if (CLI_SCRIPT) {
1703             echo "!!! $message !!!\n";
1704             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1705                 if (!empty($debuginfo)) {
1706                     echo "\nDebug info: $debuginfo";
1707                 }
1708                 if (!empty($backtrace)) {
1709                     echo "\nStack trace: " . format_backtrace($backtrace, true);
1710                 }
1711             }
1712             return;
1714         } else if (AJAX_SCRIPT) {
1715             $e = new stdClass();
1716             $e->error      = $message;
1717             $e->stacktrace = NULL;
1718             $e->debuginfo  = NULL;
1719             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1720                 if (!empty($debuginfo)) {
1721                     $e->debuginfo = $debuginfo;
1722                 }
1723                 if (!empty($backtrace)) {
1724                     $e->stacktrace = format_backtrace($backtrace, true);
1725                 }
1726             }
1727             $e->errorcode  = $errorcode;
1728             @header('Content-Type: application/json; charset=utf-8');
1729             echo json_encode($e);
1730             return;
1731         }
1733         // In the name of protocol correctness, monitoring and performance
1734         // profiling, set the appropriate error headers for machine consumption.
1735         $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ? $_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
1736         @header($protocol . ' 503 Service Unavailable');
1738         // better disable any caching
1739         @header('Content-Type: text/html; charset=utf-8');
1740         @header('X-UA-Compatible: IE=edge');
1741         @header('Cache-Control: no-store, no-cache, must-revalidate');
1742         @header('Cache-Control: post-check=0, pre-check=0', false);
1743         @header('Pragma: no-cache');
1744         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1745         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1747         if (function_exists('get_string')) {
1748             $strerror = get_string('error');
1749         } else {
1750             $strerror = 'Error';
1751         }
1753         $content = self::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
1755         return self::plain_page($strerror, $content);
1756     }
1758     /**
1759      * Early notification message
1760      * @static
1761      * @param string $message
1762      * @param string $classes usually notifyproblem or notifysuccess
1763      * @return string
1764      */
1765     public static function early_notification($message, $classes = 'notifyproblem') {
1766         return '<div class="' . $classes . '">' . $message . '</div>';
1767     }
1769     /**
1770      * Page should redirect message.
1771      * @static
1772      * @param string $encodedurl redirect url
1773      * @return string
1774      */
1775     public static function plain_redirect_message($encodedurl) {
1776         $message = '<div style="margin-top: 3em; margin-left:auto; margin-right:auto; text-align:center;">' . get_string('pageshouldredirect') . '<br /><a href="'.
1777                 $encodedurl .'">'. get_string('continue') .'</a></div>';
1778         return self::plain_page(get_string('redirect'), $message);
1779     }
1781     /**
1782      * Early redirection page, used before full init of $PAGE global
1783      * @static
1784      * @param string $encodedurl redirect url
1785      * @param string $message redirect message
1786      * @param int $delay time in seconds
1787      * @return string redirect page
1788      */
1789     public static function early_redirect_message($encodedurl, $message, $delay) {
1790         $meta = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />';
1791         $content = self::early_error_content($message, null, null, null);
1792         $content .= self::plain_redirect_message($encodedurl);
1794         return self::plain_page(get_string('redirect'), $content, $meta);
1795     }
1797     /**
1798      * Output basic html page.
1799      * @static
1800      * @param string $title page title
1801      * @param string $content page content
1802      * @param string $meta meta tag
1803      * @return string html page
1804      */
1805     public static function plain_page($title, $content, $meta = '') {
1806         if (function_exists('get_string') && function_exists('get_html_lang')) {
1807             $htmllang = get_html_lang();
1808         } else {
1809             $htmllang = '';
1810         }
1812         $footer = '';
1813         if (MDL_PERF_TEST) {
1814             $perfinfo = get_performance_info();
1815             $footer = '<footer>' . $perfinfo['html'] . '</footer>';
1816         }
1818         return '<!DOCTYPE html>
1819 <html ' . $htmllang . '>
1820 <head>
1821 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1822 '.$meta.'
1823 <title>' . $title . '</title>
1824 </head><body>' . $content . $footer . '</body></html>';
1825     }