2 // This file is part of Moodle - http://moodle.org/
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle. If not, see <http://www.gnu.org/licenses/>.
18 * These functions are required very early in the Moodle
19 * setup process, before any of the main libraries are
24 * @copyright 1999 onwards Martin Dougiamas {@link http://moodle.com}
25 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28 defined('MOODLE_INTERNAL') ||
die();
30 // Debug levels - always keep the values in ascending order!
31 /** No warnings and errors at all */
32 define('DEBUG_NONE', 0);
33 /** Fatal errors only */
34 define('DEBUG_MINIMAL', E_ERROR | E_PARSE
);
35 /** Errors, warnings and notices */
36 define('DEBUG_NORMAL', E_ERROR | E_PARSE | E_WARNING | E_NOTICE
);
37 /** All problems except strict PHP warnings */
38 define('DEBUG_ALL', E_ALL
& ~E_STRICT
);
39 /** DEBUG_ALL with all debug messages and strict warnings */
40 define('DEBUG_DEVELOPER', E_ALL | E_STRICT
);
42 /** Remove any memory limits */
43 define('MEMORY_UNLIMITED', -1);
44 /** Standard memory limit for given platform */
45 define('MEMORY_STANDARD', -2);
47 * Large memory limit for given platform - used in cron, upgrade, and other places that need a lot of memory.
48 * Can be overridden with $CFG->extramemorylimit setting.
50 define('MEMORY_EXTRA', -3);
51 /** Extremely large memory limit - not recommended for standard scripts */
52 define('MEMORY_HUGE', -4);
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.
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
66 class object extends stdClass
{};
69 * Base Moodle Exception class
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).
76 * @copyright 2008 Petr Skoda {@link http://skodak.org}
77 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
79 class moodle_exception
extends Exception
{
82 * @var string The name of the string from error.php to print
87 * @var string The name of module
92 * @var mixed Extra words and phrases that might be required in the error string
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.
102 * @var string Optional information to aid the debugging process
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
114 function __construct($errorcode, $module='', $link='', $a=NULL, $debuginfo=null) {
115 if (empty($module) ||
$module == 'moodle' ||
$module == 'core') {
119 $this->errorcode
= $errorcode;
120 $this->module
= $module;
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;
129 $message = $module . '/' . $errorcode;
130 $haserrorstring = false;
133 if (defined('PHPUNIT_TEST') and PHPUNIT_TEST
and $debuginfo) {
134 $message = "$message ($debuginfo)";
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);
144 parent
::__construct($message, 0);
149 * Course/activity access exception.
151 * This exception is thrown from require_login()
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
157 class require_login_exception
extends moodle_exception
{
160 * @param string $debuginfo Information to aid the debugging process
162 function __construct($debuginfo) {
163 parent
::__construct('requireloginerror', 'error', '', NULL, $debuginfo);
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
173 class webservice_parameter_exception
extends moodle_exception
{
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
180 function __construct($errorcode=null, $a = '', $debuginfo = null) {
181 parent
::__construct($errorcode, 'webservice', '', $a, $debuginfo);
186 * Exceptions indicating user does not have permissions to do something
187 * and the execution can not continue.
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
193 class required_capability_exception
extends moodle_exception
{
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
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();
208 $link = $context->get_url();
210 parent
::__construct($errormessage, $stringfile, $link, $capabilityname);
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.
220 * @copyright 2008 Petr Skoda {@link http://skodak.org}
221 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
223 class coding_exception
extends moodle_exception
{
226 * @param string $hint short description of problem
227 * @param string $debuginfo detailed information how to fix problem
229 function __construct($hint, $debuginfo=null) {
230 parent
::__construct('codingerror', 'debug', '', $hint, $debuginfo);
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.
242 * @copyright 2009 Petr Skoda {@link http://skodak.org}
243 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
245 class invalid_parameter_exception
extends moodle_exception
{
248 * @param string $debuginfo some detailed information
250 function __construct($debuginfo=null) {
251 parent
::__construct('invalidparameter', 'debug', '', null, $debuginfo);
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.
261 class invalid_response_exception
extends moodle_exception
{
264 * @param string $debuginfo some detailed information
266 function __construct($debuginfo=null) {
267 parent
::__construct('invalidresponse', 'debug', '', null, $debuginfo);
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.
280 * @copyright 2009 onwards Martin Dougiamas {@link http://moodle.com}
281 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
283 class invalid_state_exception
extends moodle_exception
{
286 * @param string $hint short description of problem
287 * @param string $debuginfo optional more detailed information
289 function __construct($hint, $debuginfo=null) {
290 parent
::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
295 * An exception that indicates incorrect permissions in $CFG->dataroot
299 * @copyright 2010 Petr Skoda {@link http://skodak.org}
300 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
302 class invalid_dataroot_permissions
extends moodle_exception
{
305 * @param string $debuginfo optional more detailed information
307 function __construct($debuginfo = NULL) {
308 parent
::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
313 * An exception that indicates that file can not be served
317 * @copyright 2010 Petr Skoda {@link http://skodak.org}
318 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
320 class file_serving_exception
extends moodle_exception
{
323 * @param string $debuginfo optional more detailed information
325 function __construct($debuginfo = NULL) {
326 parent
::__construct('cannotservefile', 'error', '', NULL, $debuginfo);
331 * Default exception handler, uncaught exceptions are equivalent to error() in 1.9 and earlier
333 * @param Exception $ex
334 * @return void -does not return. Terminates execution!
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());
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);
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
);
359 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
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
);
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
);
378 exit(1); // General error code
382 * Default error handler, prevents some white screens.
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
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);
399 * Unconditionally abort all database transactions, this function
400 * should be called from exception handlers only.
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();
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.
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.
424 * @param array $backtrace the stack trace to analyse.
425 * @return boolean whether the stack trace is somewhere in output initialisation.
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'),
433 foreach ($backtrace as $stackframe) {
434 foreach ($dangerouscode as $pattern) {
436 foreach ($pattern as $property => $value) {
437 if (!isset($stackframe[$property]) ||
$stackframe[$property] != $value) {
450 * Abort execution by throwing of a general exception,
451 * default exception handler displays the error message in most cases.
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!
462 function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
463 throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
467 * Returns detailed information about specified exception.
468 * @param exception $ex
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
;
479 $debuginfo = $ex->debuginfo
;
481 $errorcode = 'generalexceptionmessage';
483 $a = $ex->getMessage();
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') {
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);
508 $message = $module . '/' . $errorcode;
509 $debuginfo .= PHP_EOL
.'$a contents: '.print_r($a, true);
512 $message = $module . '/' . $errorcode;
513 $debuginfo .= PHP_EOL
.'$a contents: '.print_r($a, true);
516 // Remove some absolute paths from message and debugging info.
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]";
526 if (!empty($searches)) {
527 $message = str_replace($searches, $replaces, $message);
528 $debuginfo = str_replace($searches, $replaces, $debuginfo);
531 // Be careful, no guarantee weblib.php is loaded.
532 if (function_exists('clean_text')) {
533 $message = clean_text($message);
535 $message = htmlspecialchars($message);
538 if (!empty($CFG->errordocroot
)) {
539 $errordoclink = $CFG->errordocroot
. '/en/';
541 $errordoclink = get_docs_url();
544 if ($module === 'error') {
545 $modulelink = 'moodle';
547 $modulelink = $module;
549 $moreinfourl = $errordoclink . 'error/' . $modulelink . '/' . $errorcode;
552 if (!empty($SESSION->fromurl
)) {
553 $link = $SESSION->fromurl
;
554 unset($SESSION->fromurl
);
556 $link = $CFG->wwwroot
.'/';
560 // When printing an error the continue button should never link offsite.
561 // We cannot use clean_param() here as it is not guaranteed that it has been loaded yet.
562 $httpswwwroot = str_replace('http:', 'https:', $CFG->wwwroot
);
563 if (stripos($link, $CFG->wwwroot
) === 0) {
564 // Internal HTTP, all good.
565 } else if (!empty($CFG->loginhttps
) && stripos($link, $httpswwwroot) === 0) {
566 // Internal HTTPS, all good.
568 // External link spotted!
569 $link = $CFG->wwwroot
. '/';
572 $info = new stdClass();
573 $info->message
= $message;
574 $info->errorcode
= $errorcode;
575 $info->backtrace
= $backtrace;
577 $info->moreinfourl
= $moreinfourl;
579 $info->debuginfo
= $debuginfo;
585 * Returns the Moodle Docs URL in the users language for a given 'More help' link.
587 * There are three cases:
589 * 1. In the normal case, $path will be a short relative path 'component/thing',
590 * like 'mod/folder/view' 'group/import'. This gets turned into an link to
591 * MoodleDocs in the user's language, and for the appropriate Moodle version.
592 * E.g. 'group/import' may become 'http://docs.moodle.org/2x/en/group/import'.
593 * The 'http://docs.moodle.org' bit comes from $CFG->docroot.
595 * This is the only option that should be used in standard Moodle code. The other
596 * two options have been implemented because they are useful for third-party plugins.
598 * 2. $path may be an absolute URL, starting http:// or https://. In this case,
599 * the link is used as is.
601 * 3. $path may start %%WWWROOT%%, in which case that is replaced by
602 * $CFG->wwwroot to make the link.
604 * @param string $path the place to link to. See above for details.
605 * @return string The MoodleDocs URL in the user's language. for example @link http://docs.moodle.org/2x/en/$path}
607 function get_docs_url($path = null) {
610 // Absolute URLs are used unmodified.
611 if (substr($path, 0, 7) === 'http://' ||
substr($path, 0, 8) === 'https://') {
615 // Paths starting %%WWWROOT%% have that replaced by $CFG->wwwroot.
616 if (substr($path, 0, 11) === '%%WWWROOT%%') {
617 return $CFG->wwwroot
. substr($path, 11);
620 // Otherwise we do the normal case, and construct a MoodleDocs URL relative to $CFG->docroot.
622 // Check that $CFG->branch has been set up, during installation it won't be.
623 if (empty($CFG->branch
)) {
624 // It's not there yet so look at version.php.
625 include($CFG->dirroot
.'/version.php');
627 // We can use $CFG->branch and avoid having to include version.php.
628 $branch = $CFG->branch
;
630 // ensure branch is valid.
632 // We should never get here but in case we do lets set $branch to .
633 // the smart one's will know that this is the current directory
634 // and the smarter ones will know that there is some smart matching
635 // that will ensure people end up at the latest version of the docs.
638 if (empty($CFG->doclang
)) {
639 $lang = current_language();
641 $lang = $CFG->doclang
;
643 $end = '/' . $branch . '/' . $lang . '/' . $path;
644 if (empty($CFG->docroot
)) {
645 return 'http://docs.moodle.org'. $end;
647 return $CFG->docroot
. $end ;
652 * Formats a backtrace ready for output.
654 * @param array $callers backtrace array, as returned by debug_backtrace().
655 * @param boolean $plaintext if false, generates HTML, if true generates plain text.
656 * @return string formatted backtrace, ready for output.
658 function format_backtrace($callers, $plaintext = false) {
659 // do not use $CFG->dirroot because it might not be available in destructors
660 $dirroot = dirname(dirname(__FILE__
));
662 if (empty($callers)) {
666 $from = $plaintext ?
'' : '<ul style="text-align: left" data-rel="backtrace">';
667 foreach ($callers as $caller) {
668 if (!isset($caller['line'])) {
669 $caller['line'] = '?'; // probably call_user_func()
671 if (!isset($caller['file'])) {
672 $caller['file'] = 'unknownfile'; // probably call_user_func()
674 $from .= $plaintext ?
'* ' : '<li>';
675 $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
676 if (isset($caller['function'])) {
677 $from .= ': call to ';
678 if (isset($caller['class'])) {
679 $from .= $caller['class'] . $caller['type'];
681 $from .= $caller['function'] . '()';
682 } else if (isset($caller['exception'])) {
683 $from .= ': '.$caller['exception'].' thrown';
685 $from .= $plaintext ?
"\n" : '</li>';
687 $from .= $plaintext ?
'' : '</ul>';
693 * This function makes the return value of ini_get consistent if you are
694 * setting server directives through the .htaccess file in apache.
696 * Current behavior for value set from php.ini On = 1, Off = [blank]
697 * Current behavior for value set from .htaccess On = On, Off = Off
698 * Contributed by jdell @ unr.edu
700 * @param string $ini_get_arg The argument to get
701 * @return bool True for on false for not
703 function ini_get_bool($ini_get_arg) {
704 $temp = ini_get($ini_get_arg);
706 if ($temp == '1' or strtolower($temp) == 'on') {
713 * This function verifies the sanity of PHP configuration
714 * and stops execution if anything critical found.
716 function setup_validate_php_configuration() {
717 // this must be very fast - no slow checks here!!!
719 if (ini_get_bool('session.auto_start')) {
720 print_error('sessionautostartwarning', 'admin');
725 * Initialise global $CFG variable.
726 * @private to be used only from lib/setup.php
728 function initialise_cfg() {
732 // This should not happen.
737 $localcfg = get_config('core');
738 } catch (dml_exception
$e) {
739 // Most probably empty db, going to install soon.
743 foreach ($localcfg as $name => $value) {
744 // Note that get_config() keeps forced settings
745 // and normalises values to string if possible.
746 $CFG->{$name} = $value;
751 * Initialises $FULLME and friends. Private function. Should only be called from
754 function initialise_fullme() {
755 global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
757 // Detect common config error.
758 if (substr($CFG->wwwroot
, -1) == '/') {
759 print_error('wwwrootslash', 'error');
763 initialise_fullme_cli();
767 $rurl = setup_get_remote_url();
768 $wwwroot = parse_url($CFG->wwwroot
.'/');
770 if (empty($rurl['host'])) {
771 // missing host in request header, probably not a real browser, let's ignore them
773 } else if (!empty($CFG->reverseproxy
)) {
774 // $CFG->reverseproxy specifies if reverse proxy server used
775 // Used in load balancing scenarios.
776 // Do not abuse this to try to solve lan/wan access problems!!!!!
779 if (($rurl['host'] !== $wwwroot['host']) or
780 (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port']) or
781 (strpos($rurl['path'], $wwwroot['path']) !== 0)) {
783 // Explain the problem and redirect them to the right URL
784 if (!defined('NO_MOODLE_COOKIES')) {
785 define('NO_MOODLE_COOKIES', true);
787 // The login/token.php script should call the correct url/port.
788 if (defined('REQUIRE_CORRECT_ACCESS') && REQUIRE_CORRECT_ACCESS
) {
789 $wwwrootport = empty($wwwroot['port'])?
'':$wwwroot['port'];
790 $calledurl = $rurl['host'];
791 if (!empty($rurl['port'])) {
792 $calledurl .= ':'. $rurl['port'];
794 $correcturl = $wwwroot['host'];
795 if (!empty($wwwrootport)) {
796 $correcturl .= ':'. $wwwrootport;
798 throw new moodle_exception('requirecorrectaccess', 'error', '', null,
799 'You called ' . $calledurl .', you should have called ' . $correcturl);
801 redirect($CFG->wwwroot
, get_string('wwwrootmismatch', 'error', $CFG->wwwroot
), 3);
805 // Check that URL is under $CFG->wwwroot.
806 if (strpos($rurl['path'], $wwwroot['path']) === 0) {
807 $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
809 // Probably some weird external script
810 $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
814 // $CFG->sslproxy specifies if external SSL appliance is used
815 // (That is, the Moodle server uses http, with an external box translating everything to https).
816 if (empty($CFG->sslproxy
)) {
817 if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
818 print_error('sslonlyaccess', 'error');
821 if ($wwwroot['scheme'] !== 'https') {
822 throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
824 $rurl['scheme'] = 'https'; // make moodle believe it runs on https, squid or something else it doing it
825 $_SERVER['HTTPS'] = 'on'; // Override $_SERVER to help external libraries with their HTTPS detection.
826 $_SERVER['SERVER_PORT'] = 443; // Assume default ssl port for the proxy.
829 // hopefully this will stop all those "clever" admins trying to set up moodle
830 // with two different addresses in intranet and Internet
831 if (!empty($CFG->reverseproxy
) && $rurl['host'] === $wwwroot['host']) {
832 print_error('reverseproxyabused', 'error');
835 $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
836 if (!empty($wwwroot['port'])) {
837 $hostandport .= ':'.$wwwroot['port'];
840 $FULLSCRIPT = $hostandport . $rurl['path'];
841 $FULLME = $hostandport . $rurl['fullpath'];
842 $ME = $rurl['fullpath'];
846 * Initialises $FULLME and friends for command line scripts.
847 * This is a private method for use by initialise_fullme.
849 function initialise_fullme_cli() {
850 global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
852 // Urls do not make much sense in CLI scripts
853 $backtrace = debug_backtrace();
854 $topfile = array_pop($backtrace);
855 $topfile = realpath($topfile['file']);
856 $dirroot = realpath($CFG->dirroot
);
858 if (strpos($topfile, $dirroot) !== 0) {
859 // Probably some weird external script
860 $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
862 $relativefile = substr($topfile, strlen($dirroot));
863 $relativefile = str_replace('\\', '/', $relativefile); // Win fix
864 $SCRIPT = $FULLSCRIPT = $relativefile;
865 $FULLME = $ME = null;
870 * Get the URL that PHP/the web server thinks it is serving. Private function
871 * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
872 * @return array in the same format that parse_url returns, with the addition of
873 * a 'fullpath' element, which includes any slasharguments path.
875 function setup_get_remote_url() {
877 if (isset($_SERVER['HTTP_HOST'])) {
878 list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
880 $rurl['host'] = null;
882 $rurl['port'] = $_SERVER['SERVER_PORT'];
883 $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
884 $rurl['scheme'] = (empty($_SERVER['HTTPS']) or $_SERVER['HTTPS'] === 'off' or $_SERVER['HTTPS'] === 'Off' or $_SERVER['HTTPS'] === 'OFF') ?
'http' : 'https';
886 if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
888 $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
890 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
891 //IIS - needs a lot of tweaking to make it work
892 $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
894 // NOTE: we should ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS.
895 // Since 2.0, we rely on IIS rewrite extensions like Helicon ISAPI_rewrite
896 // example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
898 // we rely on a proper IIS 6.0+ configuration: the 'FastCGIUtf8ServerVariables' registry key.
899 if (isset($_SERVER['PATH_INFO']) and $_SERVER['PATH_INFO'] !== '') {
900 // Check that PATH_INFO works == must not contain the script name.
901 if (strpos($_SERVER['PATH_INFO'], $_SERVER['SCRIPT_NAME']) === false) {
902 $rurl['fullpath'] .= clean_param(urldecode($_SERVER['PATH_INFO']), PARAM_PATH
);
906 if (isset($_SERVER['QUERY_STRING']) and $_SERVER['QUERY_STRING'] !== '') {
907 $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
909 $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
911 /* NOTE: following servers are not fully tested! */
913 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
914 //lighttpd - not officially supported
915 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
917 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
918 //nginx - not officially supported
919 if (!isset($_SERVER['SCRIPT_NAME'])) {
920 die('Invalid server configuration detected, please try to add "fastcgi_param SCRIPT_NAME $fastcgi_script_name;" to the nginx server configuration.');
922 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
924 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
925 //cherokee - not officially supported
926 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
928 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
929 //zeus - not officially supported
930 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
932 } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
933 //LiteSpeed - not officially supported
934 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
936 } else if ($_SERVER['SERVER_SOFTWARE'] === 'HTTPD') {
937 //obscure name found on some servers - this is definitely not supported
938 $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
940 } else if (strpos($_SERVER['SERVER_SOFTWARE'], 'PHP') === 0) {
941 // built-in PHP Development Server
942 $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
945 throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
948 // sanitize the url a bit more, the encoding style may be different in vars above
949 $rurl['fullpath'] = str_replace('"', '%22', $rurl['fullpath']);
950 $rurl['fullpath'] = str_replace('\'', '%27', $rurl['fullpath']);
956 * Try to work around the 'max_input_vars' restriction if necessary.
958 function workaround_max_input_vars() {
959 // Make sure this gets executed only once from lib/setup.php!
960 static $executed = false;
962 debugging('workaround_max_input_vars() must be called only once!');
967 if (!isset($_SERVER["CONTENT_TYPE"]) or strpos($_SERVER["CONTENT_TYPE"], 'multipart/form-data') !== false) {
968 // Not a post or 'multipart/form-data' which is not compatible with "php://input" reading.
972 if (!isloggedin() or isguestuser()) {
973 // Only real users post huge forms.
977 $max = (int)ini_get('max_input_vars');
980 // Most probably PHP < 5.3.9 that does not implement this limit.
984 if ($max >= 200000) {
985 // This value should be ok for all our forms, by setting it in php.ini
986 // admins may prevent any unexpected regressions caused by this hack.
988 // Note there is no need to worry about DDoS caused by making this limit very high
989 // because there are very many easier ways to DDoS any Moodle server.
993 if (count($_POST, COUNT_RECURSIVE
) < $max) {
997 // Large POST request with enctype supported by php://input.
998 // Parse php://input in chunks to bypass max_input_vars limit, which also applies to parse_str().
999 $str = file_get_contents("php://input");
1000 if ($str === false or $str === '') {
1001 // Some weird error.
1006 $fun = create_function('$p', 'return implode("'.$delim.'", $p);');
1007 $chunks = array_map($fun, array_chunk(explode($delim, $str), $max));
1009 foreach ($chunks as $chunk) {
1011 parse_str($chunk, $values);
1013 merge_query_params($_POST, $values);
1014 merge_query_params($_REQUEST, $values);
1019 * Merge parsed POST chunks.
1021 * NOTE: this is not perfect, but it should work in most cases hopefully.
1023 * @param array $target
1024 * @param array $values
1026 function merge_query_params(array &$target, array $values) {
1027 if (isset($values[0]) and isset($target[0])) {
1028 // This looks like a split [] array, lets verify the keys are continuous starting with 0.
1029 $keys1 = array_keys($values);
1030 $keys2 = array_keys($target);
1031 if ($keys1 === array_keys($keys1) and $keys2 === array_keys($keys2)) {
1032 foreach ($values as $v) {
1038 foreach ($values as $k => $v) {
1039 if (!isset($target[$k])) {
1043 if (is_array($target[$k]) and is_array($v)) {
1044 merge_query_params($target[$k], $v);
1047 // We should not get here unless there are duplicates in params.
1053 * Initializes our performance info early.
1055 * Pairs up with get_performance_info() which is actually
1056 * in moodlelib.php. This function is here so that we can
1057 * call it before all the libs are pulled in.
1061 function init_performance_info() {
1063 global $PERF, $CFG, $USER;
1065 $PERF = new stdClass();
1066 $PERF->logwrites
= 0;
1067 if (function_exists('microtime')) {
1068 $PERF->starttime
= microtime();
1070 if (function_exists('memory_get_usage')) {
1071 $PERF->startmemory
= memory_get_usage();
1073 if (function_exists('posix_times')) {
1074 $PERF->startposixtimes
= posix_times();
1079 * Indicates whether we are in the middle of the initial Moodle install.
1081 * Very occasionally it is necessary avoid running certain bits of code before the
1082 * Moodle installation has completed. The installed flag is set in admin/index.php
1083 * after Moodle core and all the plugins have been installed, but just before
1084 * the person doing the initial install is asked to choose the admin password.
1086 * @return boolean true if the initial install is not complete.
1088 function during_initial_install() {
1090 return empty($CFG->rolesactive
);
1094 * Function to raise the memory limit to a new value.
1095 * Will respect the memory limit if it is higher, thus allowing
1096 * settings in php.ini, apache conf or command line switches
1099 * The memory limit should be expressed with a constant
1100 * MEMORY_STANDARD, MEMORY_EXTRA or MEMORY_HUGE.
1101 * It is possible to use strings or integers too (eg:'128M').
1103 * @param mixed $newlimit the new memory limit
1104 * @return bool success
1106 function raise_memory_limit($newlimit) {
1109 if ($newlimit == MEMORY_UNLIMITED
) {
1110 ini_set('memory_limit', -1);
1113 } else if ($newlimit == MEMORY_STANDARD
) {
1114 if (PHP_INT_SIZE
> 4) {
1115 $newlimit = get_real_size('128M'); // 64bit needs more memory
1117 $newlimit = get_real_size('96M');
1120 } else if ($newlimit == MEMORY_EXTRA
) {
1121 if (PHP_INT_SIZE
> 4) {
1122 $newlimit = get_real_size('384M'); // 64bit needs more memory
1124 $newlimit = get_real_size('256M');
1126 if (!empty($CFG->extramemorylimit
)) {
1127 $extra = get_real_size($CFG->extramemorylimit
);
1128 if ($extra > $newlimit) {
1133 } else if ($newlimit == MEMORY_HUGE
) {
1134 // MEMORY_HUGE uses 2G or MEMORY_EXTRA, whichever is bigger.
1135 $newlimit = get_real_size('2G');
1136 if (!empty($CFG->extramemorylimit
)) {
1137 $extra = get_real_size($CFG->extramemorylimit
);
1138 if ($extra > $newlimit) {
1144 $newlimit = get_real_size($newlimit);
1147 if ($newlimit <= 0) {
1148 debugging('Invalid memory limit specified.');
1152 $cur = ini_get('memory_limit');
1154 // if php is compiled without --enable-memory-limits
1155 // apparently memory_limit is set to ''
1159 return true; // unlimited mem!
1161 $cur = get_real_size($cur);
1164 if ($newlimit > $cur) {
1165 ini_set('memory_limit', $newlimit);
1172 * Function to reduce the memory limit to a new value.
1173 * Will respect the memory limit if it is lower, thus allowing
1174 * settings in php.ini, apache conf or command line switches
1177 * The memory limit should be expressed with a string (eg:'64M')
1179 * @param string $newlimit the new memory limit
1182 function reduce_memory_limit($newlimit) {
1183 if (empty($newlimit)) {
1186 $cur = ini_get('memory_limit');
1188 // if php is compiled without --enable-memory-limits
1189 // apparently memory_limit is set to ''
1193 return true; // unlimited mem!
1195 $cur = get_real_size($cur);
1198 $new = get_real_size($newlimit);
1199 // -1 is smaller, but it means unlimited
1200 if ($new < $cur && $new != -1) {
1201 ini_set('memory_limit', $newlimit);
1208 * Converts numbers like 10M into bytes.
1210 * @param string $size The size to be converted
1213 function get_real_size($size = 0) {
1218 $scan['GB'] = 1073741824;
1219 $scan['Gb'] = 1073741824;
1220 $scan['G'] = 1073741824;
1221 $scan['MB'] = 1048576;
1222 $scan['Mb'] = 1048576;
1223 $scan['M'] = 1048576;
1224 $scan['m'] = 1048576;
1230 while (list($key) = each($scan)) {
1231 if ((strlen($size)>strlen($key))&&(substr($size, strlen($size) - strlen($key))==$key)) {
1232 $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
1240 * Try to disable all output buffering and purge
1243 * @access private to be called only from lib/setup.php !
1246 function disable_output_buffering() {
1247 $olddebug = error_reporting(0);
1249 // disable compression, it would prevent closing of buffers
1250 if (ini_get_bool('zlib.output_compression')) {
1251 ini_set('zlib.output_compression', 'Off');
1254 // try to flush everything all the time
1255 ob_implicit_flush(true);
1257 // close all buffers if possible and discard any existing output
1258 // this can actually work around some whitespace problems in config.php
1259 while(ob_get_level()) {
1260 if (!ob_end_clean()) {
1261 // prevent infinite loop when buffer can not be closed
1266 // disable any other output handlers
1267 ini_set('output_handler', '');
1269 error_reporting($olddebug);
1273 * Check whether a major upgrade is needed. That is defined as an upgrade that
1274 * changes something really fundamental in the database, so nothing can possibly
1275 * work until the database has been updated, and that is defined by the hard-coded
1276 * version number in this function.
1278 function redirect_if_major_upgrade_required() {
1280 $lastmajordbchanges = 2014093001.00;
1281 if (empty($CFG->version
) or (float)$CFG->version
< $lastmajordbchanges or
1282 during_initial_install() or !empty($CFG->adminsetuppending
)) {
1284 @\core\session\manager
::terminate_current();
1285 } catch (Exception
$e) {
1286 // Ignore any errors, redirect to upgrade anyway.
1288 $url = $CFG->wwwroot
. '/' . $CFG->admin
. '/index.php';
1289 @header
($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
1290 @header
('Location: ' . $url);
1291 echo bootstrap_renderer
::plain_redirect_message(htmlspecialchars($url));
1297 * Makes sure that upgrade process is not running
1299 * To be inserted in the core functions that can not be called by pluigns during upgrade.
1300 * Core upgrade should not use any API functions at all.
1301 * See {@link http://docs.moodle.org/dev/Upgrade_API#Upgrade_code_restrictions}
1303 * @throws moodle_exception if executed from inside of upgrade script and $warningonly is false
1304 * @param bool $warningonly if true displays a warning instead of throwing an exception
1305 * @return bool true if executed from outside of upgrade process, false if from inside upgrade process and function is used for warning only
1307 function upgrade_ensure_not_running($warningonly = false) {
1309 if (!empty($CFG->upgraderunning
)) {
1310 if (!$warningonly) {
1311 throw new moodle_exception('cannotexecduringupgrade');
1313 debugging(get_string('cannotexecduringupgrade', 'error'), DEBUG_DEVELOPER
);
1321 * Function to check if a directory exists and by default create it if not exists.
1323 * Previously this was accepting paths only from dataroot, but we now allow
1324 * files outside of dataroot if you supply custom paths for some settings in config.php.
1325 * This function does not verify that the directory is writable.
1327 * NOTE: this function uses current file stat cache,
1328 * please use clearstatcache() before this if you expect that the
1329 * directories may have been removed recently from a different request.
1331 * @param string $dir absolute directory path
1332 * @param boolean $create directory if does not exist
1333 * @param boolean $recursive create directory recursively
1334 * @return boolean true if directory exists or created, false otherwise
1336 function check_dir_exists($dir, $create = true, $recursive = true) {
1339 umask($CFG->umaskpermissions
);
1349 return mkdir($dir, $CFG->directorypermissions
, $recursive);
1353 * Create a directory and make sure it is writable.
1356 * @param string $dir the full path of the directory to be created
1357 * @param bool $exceptiononerror throw exception if error encountered
1358 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1360 function make_writable_directory($dir, $exceptiononerror = true) {
1363 if (file_exists($dir) and !is_dir($dir)) {
1364 if ($exceptiononerror) {
1365 throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
1371 umask($CFG->umaskpermissions
);
1373 if (!file_exists($dir)) {
1374 if (!mkdir($dir, $CFG->directorypermissions
, true)) {
1376 // There might be a race condition when creating directory.
1377 if (!is_dir($dir)) {
1378 if ($exceptiononerror) {
1379 throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
1381 debugging('Can not create directory: '.$dir, DEBUG_DEVELOPER
);
1388 if (!is_writable($dir)) {
1389 if ($exceptiononerror) {
1390 throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
1400 * Protect a directory from web access.
1401 * Could be extended in the future to support other mechanisms (e.g. other webservers).
1404 * @param string $dir the full path of the directory to be protected
1406 function protect_directory($dir) {
1408 // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
1409 if (!file_exists("$dir/.htaccess")) {
1410 if ($handle = fopen("$dir/.htaccess", 'w')) { // For safety
1411 @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");
1413 @chmod
("$dir/.htaccess", $CFG->filepermissions
);
1419 * Create a directory under dataroot and make sure it is writable.
1420 * Do not use for temporary and cache files - see make_temp_directory() and make_cache_directory().
1422 * @param string $directory the full path of the directory to be created under $CFG->dataroot
1423 * @param bool $exceptiononerror throw exception if error encountered
1424 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1426 function make_upload_directory($directory, $exceptiononerror = true) {
1429 if (strpos($directory, 'temp/') === 0 or $directory === 'temp') {
1430 debugging('Use make_temp_directory() for creation of temporary directory and $CFG->tempdir to get the location.');
1432 } else if (strpos($directory, 'cache/') === 0 or $directory === 'cache') {
1433 debugging('Use make_cache_directory() for creation of cache directory and $CFG->cachedir to get the location.');
1435 } else if (strpos($directory, 'localcache/') === 0 or $directory === 'localcache') {
1436 debugging('Use make_localcache_directory() for creation of local cache directory and $CFG->localcachedir to get the location.');
1439 protect_directory($CFG->dataroot
);
1440 return make_writable_directory("$CFG->dataroot/$directory", $exceptiononerror);
1444 * Create a directory under tempdir and make sure it is writable.
1445 * Temporary files should be used during the current request only!
1447 * @param string $directory the full path of the directory to be created under $CFG->tempdir
1448 * @param bool $exceptiononerror throw exception if error encountered
1449 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1451 function make_temp_directory($directory, $exceptiononerror = true) {
1453 if ($CFG->tempdir
!== "$CFG->dataroot/temp") {
1454 check_dir_exists($CFG->tempdir
, true, true);
1455 protect_directory($CFG->tempdir
);
1457 protect_directory($CFG->dataroot
);
1459 return make_writable_directory("$CFG->tempdir/$directory", $exceptiononerror);
1463 * Create a directory under cachedir and make sure it is writable.
1465 * Note: this cache directory is shared by all cluster nodes.
1467 * @param string $directory the full path of the directory to be created under $CFG->cachedir
1468 * @param bool $exceptiononerror throw exception if error encountered
1469 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1471 function make_cache_directory($directory, $exceptiononerror = true) {
1473 if ($CFG->cachedir
!== "$CFG->dataroot/cache") {
1474 check_dir_exists($CFG->cachedir
, true, true);
1475 protect_directory($CFG->cachedir
);
1477 protect_directory($CFG->dataroot
);
1479 return make_writable_directory("$CFG->cachedir/$directory", $exceptiononerror);
1483 * Create a directory under localcachedir and make sure it is writable.
1484 * The files in this directory MUST NOT change, use revisions or content hashes to
1485 * work around this limitation - this means you can only add new files here.
1487 * The content of this directory gets purged automatically on all cluster nodes
1488 * after calling purge_all_caches() before new data is written to this directory.
1490 * Note: this local cache directory does not need to be shared by cluster nodes.
1492 * @param string $directory the relative path of the directory to be created under $CFG->localcachedir
1493 * @param bool $exceptiononerror throw exception if error encountered
1494 * @return string|false Returns full path to directory if successful, false if not; may throw exception
1496 function make_localcache_directory($directory, $exceptiononerror = true) {
1499 make_writable_directory($CFG->localcachedir
, $exceptiononerror);
1501 if ($CFG->localcachedir
!== "$CFG->dataroot/localcache") {
1502 protect_directory($CFG->localcachedir
);
1504 protect_directory($CFG->dataroot
);
1507 if (!isset($CFG->localcachedirpurged
)) {
1508 $CFG->localcachedirpurged
= 0;
1510 $timestampfile = "$CFG->localcachedir/.lastpurged";
1512 if (!file_exists($timestampfile)) {
1513 touch($timestampfile);
1514 @chmod
($timestampfile, $CFG->filepermissions
);
1516 } else if (filemtime($timestampfile) < $CFG->localcachedirpurged
) {
1517 // This means our local cached dir was not purged yet.
1518 remove_dir($CFG->localcachedir
, true);
1519 if ($CFG->localcachedir
!== "$CFG->dataroot/localcache") {
1520 protect_directory($CFG->localcachedir
);
1522 touch($timestampfile);
1523 @chmod
($timestampfile, $CFG->filepermissions
);
1527 if ($directory === '') {
1528 return $CFG->localcachedir
;
1531 return make_writable_directory("$CFG->localcachedir/$directory", $exceptiononerror);
1535 * Checks if current user is a web crawler.
1537 * This list can not be made complete, this is not a security
1538 * restriction, we make the list only to help these sites
1539 * especially when automatic guest login is disabled.
1541 * If admin needs security they should enable forcelogin
1542 * and disable guest access!!
1546 function is_web_crawler() {
1547 if (!empty($_SERVER['HTTP_USER_AGENT'])) {
1548 if (strpos($_SERVER['HTTP_USER_AGENT'], 'Googlebot') !== false ) {
1550 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'google.com') !== false ) { // Google
1552 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Yahoo! Slurp') !== false ) { // Yahoo
1554 } else if (strpos($_SERVER['HTTP_USER_AGENT'], '[ZSEBOT]') !== false ) { // Zoomspider
1556 } else if (stripos($_SERVER['HTTP_USER_AGENT'], 'msnbot') !== false ) { // MSN Search
1558 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'bingbot') !== false ) { // Bing
1560 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Yandex') !== false ) {
1562 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'AltaVista') !== false ) {
1564 } else if (stripos($_SERVER['HTTP_USER_AGENT'], 'baiduspider') !== false ) { // Baidu
1566 } else if (strpos($_SERVER['HTTP_USER_AGENT'], 'Teoma') !== false ) { // Ask.com
1574 * This class solves the problem of how to initialise $OUTPUT.
1576 * The problem is caused be two factors
1578 * <li>On the one hand, we cannot be sure when output will start. In particular,
1579 * an error, which needs to be displayed, could be thrown at any time.</li>
1580 * <li>On the other hand, we cannot be sure when we will have all the information
1581 * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1582 * (potentially) depends on the current course, course categories, and logged in user.
1583 * It also depends on whether the current page requires HTTPS.</li>
1586 * So, it is hard to find a single natural place during Moodle script execution,
1587 * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1588 * adopt the following strategy
1590 * <li>We will initialise $OUTPUT the first time it is used.</li>
1591 * <li>If, after $OUTPUT has been initialised, the script tries to change something
1592 * that $OUTPUT depends on, we throw an exception making it clear that the script
1593 * did something wrong.
1596 * The only problem with that is, how do we initialise $OUTPUT on first use if,
1597 * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1598 * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1599 * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1601 * Note that this class is used before lib/outputlib.php has been loaded, so we
1602 * must be careful referring to classes/functions from there, they may not be
1603 * defined yet, and we must avoid fatal errors.
1605 * @copyright 2009 Tim Hunt
1606 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1609 class bootstrap_renderer
{
1611 * Handles re-entrancy. Without this, errors or debugging output that occur
1612 * during the initialisation of $OUTPUT, cause infinite recursion.
1615 protected $initialising = false;
1618 * Have we started output yet?
1619 * @return boolean true if the header has been printed.
1621 public function has_started() {
1626 * Constructor - to be used by core code only.
1627 * @param string $method The method to call
1628 * @param array $arguments Arguments to pass to the method being called
1631 public function __call($method, $arguments) {
1632 global $OUTPUT, $PAGE;
1635 if ($method == 'notification') {
1636 // Catch infinite recursion caused by debugging output during print_header.
1637 $backtrace = debug_backtrace();
1638 array_shift($backtrace);
1639 array_shift($backtrace);
1640 $recursing = is_early_init($backtrace);
1643 $earlymethods = array(
1644 'fatal_error' => 'early_error',
1645 'notification' => 'early_notification',
1648 // If lib/outputlib.php has been loaded, call it.
1649 if (!empty($PAGE) && !$recursing) {
1650 if (array_key_exists($method, $earlymethods)) {
1651 //prevent PAGE->context warnings - exceptions might appear before we set any context
1652 $PAGE->set_context(null);
1654 $PAGE->initialise_theme_and_output();
1655 return call_user_func_array(array($OUTPUT, $method), $arguments);
1658 $this->initialising
= true;
1660 // Too soon to initialise $OUTPUT, provide a couple of key methods.
1661 if (array_key_exists($method, $earlymethods)) {
1662 return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1665 throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1669 * Returns nicely formatted error message in a div box.
1671 * @param string $message error message
1672 * @param string $moreinfourl (ignored in early errors)
1673 * @param string $link (ignored in early errors)
1674 * @param array $backtrace
1675 * @param string $debuginfo
1678 public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1681 $content = '<div style="margin-top: 6em; margin-left:auto; margin-right:auto; color:#990000; text-align:center; font-size:large; border-width:1px;
1682 border-color:black; background-color:#ffffee; border-style:solid; border-radius: 20px; border-collapse: collapse;
1683 width: 80%; -moz-border-radius: 20px; padding: 15px">
1686 // Check whether debug is set.
1687 $debug = (!empty($CFG->debug
) && $CFG->debug
>= DEBUG_DEVELOPER
);
1688 // Also check we have it set in the config file. This occurs if the method to read the config table from the
1689 // database fails, reading from the config table is the first database interaction we have.
1690 $debug = $debug ||
(!empty($CFG->config_php_settings
['debug']) && $CFG->config_php_settings
['debug'] >= DEBUG_DEVELOPER
);
1692 if (!empty($debuginfo)) {
1693 $debuginfo = s($debuginfo); // removes all nasty JS
1694 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1695 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
1697 if (!empty($backtrace)) {
1698 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
1706 * This function should only be called by this class, or from exception handlers
1708 * @param string $message error message
1709 * @param string $moreinfourl (ignored in early errors)
1710 * @param string $link (ignored in early errors)
1711 * @param array $backtrace
1712 * @param string $debuginfo extra information for developers
1715 public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null, $errorcode = null) {
1719 echo "!!! $message !!!\n";
1720 if (!empty($CFG->debug
) and $CFG->debug
>= DEBUG_DEVELOPER
) {
1721 if (!empty($debuginfo)) {
1722 echo "\nDebug info: $debuginfo";
1724 if (!empty($backtrace)) {
1725 echo "\nStack trace: " . format_backtrace($backtrace, true);
1730 } else if (AJAX_SCRIPT
) {
1731 $e = new stdClass();
1732 $e->error
= $message;
1733 $e->stacktrace
= NULL;
1734 $e->debuginfo
= NULL;
1735 if (!empty($CFG->debug
) and $CFG->debug
>= DEBUG_DEVELOPER
) {
1736 if (!empty($debuginfo)) {
1737 $e->debuginfo
= $debuginfo;
1739 if (!empty($backtrace)) {
1740 $e->stacktrace
= format_backtrace($backtrace, true);
1743 $e->errorcode
= $errorcode;
1744 @header
('Content-Type: application/json; charset=utf-8');
1745 echo json_encode($e);
1749 // In the name of protocol correctness, monitoring and performance
1750 // profiling, set the appropriate error headers for machine consumption.
1751 $protocol = (isset($_SERVER['SERVER_PROTOCOL']) ?
$_SERVER['SERVER_PROTOCOL'] : 'HTTP/1.0');
1752 @header
($protocol . ' 503 Service Unavailable');
1754 // better disable any caching
1755 @header
('Content-Type: text/html; charset=utf-8');
1756 @header
('X-UA-Compatible: IE=edge');
1757 @header
('Cache-Control: no-store, no-cache, must-revalidate');
1758 @header
('Cache-Control: post-check=0, pre-check=0', false);
1759 @header
('Pragma: no-cache');
1760 @header
('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1761 @header
('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1763 if (function_exists('get_string')) {
1764 $strerror = get_string('error');
1766 $strerror = 'Error';
1769 $content = self
::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
1771 return self
::plain_page($strerror, $content);
1775 * Early notification message
1777 * @param string $message
1778 * @param string $classes usually notifyproblem or notifysuccess
1781 public static function early_notification($message, $classes = 'notifyproblem') {
1782 return '<div class="' . $classes . '">' . $message . '</div>';
1786 * Page should redirect message.
1788 * @param string $encodedurl redirect url
1791 public static function plain_redirect_message($encodedurl) {
1792 $message = '<div style="margin-top: 3em; margin-left:auto; margin-right:auto; text-align:center;">' . get_string('pageshouldredirect') . '<br /><a href="'.
1793 $encodedurl .'">'. get_string('continue') .'</a></div>';
1794 return self
::plain_page(get_string('redirect'), $message);
1798 * Early redirection page, used before full init of $PAGE global
1800 * @param string $encodedurl redirect url
1801 * @param string $message redirect message
1802 * @param int $delay time in seconds
1803 * @return string redirect page
1805 public static function early_redirect_message($encodedurl, $message, $delay) {
1806 $meta = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />';
1807 $content = self
::early_error_content($message, null, null, null);
1808 $content .= self
::plain_redirect_message($encodedurl);
1810 return self
::plain_page(get_string('redirect'), $content, $meta);
1814 * Output basic html page.
1816 * @param string $title page title
1817 * @param string $content page content
1818 * @param string $meta meta tag
1819 * @return string html page
1821 public static function plain_page($title, $content, $meta = '') {
1822 if (function_exists('get_string') && function_exists('get_html_lang')) {
1823 $htmllang = get_html_lang();
1829 if (MDL_PERF_TEST
) {
1830 $perfinfo = get_performance_info();
1831 $footer = '<footer>' . $perfinfo['html'] . '</footer>';
1834 return '<!DOCTYPE html>
1835 <html ' . $htmllang . '>
1837 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1839 <title>' . $title . '</title>
1840 </head><body>' . $content . $footer . '</body></html>';