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