lib/setuplib.php

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