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