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