MDL-24332 fixed https handling when using sslproxy - thanks djeeg
[moodle.git] / lib / setuplib.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
19 /**
20  * These functions are required very early in the Moodle
21  * setup process, before any of the main libraries are
22  * loaded.
23  *
24  * @package    core
25  * @subpackage lib
26  * @copyright  1999 onwards Martin Dougiamas  {@link http://moodle.com}
27  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
28  */
30 defined('MOODLE_INTERNAL') || die();
32 /// Debug levels ///
33 /** no warnings at all */
34 define ('DEBUG_NONE', 0);
35 /** E_ERROR | E_PARSE */
36 define ('DEBUG_MINIMAL', 5);
37 /** E_ERROR | E_PARSE | E_WARNING | E_NOTICE */
38 define ('DEBUG_NORMAL', 15);
39 /** E_ALL without E_STRICT for now, do show recoverable fatal errors */
40 define ('DEBUG_ALL', 6143);
41 /** DEBUG_ALL with extra Moodle debug messages - (DEBUG_ALL | 32768) */
42 define ('DEBUG_DEVELOPER', 38911);
44 /**
45  * Simple class. It is usually used instead of stdClass because it looks
46  * more familiar to Java developers ;-) Do not use for type checking of
47  * function parameters. Please use stdClass instead.
48  *
49  * @package    core
50  * @subpackage lib
51  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
52  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
53  * @deprecated since 2.0
54  */
55 class object extends stdClass {};
57 /**
58  * Base Moodle Exception class
59  *
60  * Although this class is defined here, you cannot throw a moodle_exception until
61  * after moodlelib.php has been included (which will happen very soon).
62  *
63  * @package    core
64  * @subpackage lib
65  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
66  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
67  */
68 class moodle_exception extends Exception {
69     public $errorcode;
70     public $module;
71     public $a;
72     public $link;
73     public $debuginfo;
75     /**
76      * Constructor
77      * @param string $errorcode The name of the string from error.php to print
78      * @param string $module name of module
79      * @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.
80      * @param object $a Extra words and phrases that might be required in the error string
81      * @param string $debuginfo optional debugging information
82      */
83     function __construct($errorcode, $module='', $link='', $a=NULL, $debuginfo=null) {
84         if (empty($module) || $module == 'moodle' || $module == 'core') {
85             $module = 'error';
86         }
88         $this->errorcode = $errorcode;
89         $this->module    = $module;
90         $this->link      = $link;
91         $this->a         = $a;
92         $this->debuginfo = $debuginfo;
94         if (get_string_manager()->string_exists($errorcode, $module)) {
95             $message = get_string($errorcode, $module, $a);
96         } else {
97             $message = $module . '/' . $errorcode;
98         }
100         parent::__construct($message, 0);
101     }
104 /**
105  * Course/activity access exception.
106  *
107  * This exception is thrown from require_login()
108  *
109  * @package    core
110  * @subpackage lib
111  * @copyright  2010 Petr Skoda  {@link http://skodak.org}
112  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
113  */
114 class require_login_exception extends moodle_exception {
115     function __construct($debuginfo) {
116         parent::__construct('requireloginerror', 'error', '', NULL, $debuginfo);
117     }
120 /**
121  * Web service parameter exception class
122  *
123  * This exception must be thrown to the web service client when a web service parameter is invalid
124  * The error string is gotten from webservice.php
125  */
126 class webservice_parameter_exception extends moodle_exception {
127     /**
128      * Constructor
129      * @param string $errorcode The name of the string from webservice.php to print
130      * @param string $a The name of the parameter
131      */
132     function __construct($errorcode=null, $a = '') {
133         parent::__construct($errorcode, 'webservice', '', $a, null);
134     }
137 /**
138  * Exceptions indicating user does not have permissions to do something
139  * and the execution can not continue.
140  *
141  * @package    core
142  * @subpackage lib
143  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
144  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
145  */
146 class required_capability_exception extends moodle_exception {
147     function __construct($context, $capability, $errormessage, $stringfile) {
148         $capabilityname = get_capability_string($capability);
149         parent::__construct($errormessage, $stringfile, get_context_url($context), $capabilityname);
150     }
153 /**
154  * Exception indicating programming error, must be fixed by a programer. For example
155  * a core API might throw this type of exception if a plugin calls it incorrectly.
156  *
157  * @package    core
158  * @subpackage lib
159  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
160  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
161  */
162 class coding_exception extends moodle_exception {
163     /**
164      * Constructor
165      * @param string $hint short description of problem
166      * @param string $debuginfo detailed information how to fix problem
167      */
168     function __construct($hint, $debuginfo=null) {
169         parent::__construct('codingerror', 'debug', '', $hint, $debuginfo);
170     }
173 /**
174  * Exception indicating malformed parameter problem.
175  * This exception is not supposed to be thrown when processing
176  * user submitted data in forms. It is more suitable
177  * for WS and other low level stuff.
178  *
179  * @package    core
180  * @subpackage lib
181  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
182  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
183  */
184 class invalid_parameter_exception extends moodle_exception {
185     /**
186      * Constructor
187      * @param string $debuginfo some detailed information
188      */
189     function __construct($debuginfo=null) {
190         parent::__construct('invalidparameter', 'debug', '', null, $debuginfo);
191     }
194 /**
195  * Exception indicating malformed response problem.
196  * This exception is not supposed to be thrown when processing
197  * user submitted data in forms. It is more suitable
198  * for WS and other low level stuff.
199  */
200 class invalid_response_exception extends moodle_exception {
201     /**
202      * Constructor
203      * @param string $debuginfo some detailed information
204      */
205     function __construct($debuginfo=null) {
206         parent::__construct('invalidresponse', 'debug', '', null, $debuginfo);
207     }
210 /**
211  * An exception that indicates something really weird happened. For example,
212  * if you do switch ($context->contextlevel), and have one case for each
213  * CONTEXT_... constant. You might throw an invalid_state_exception in the
214  * default case, to just in case something really weird is going on, and
215  * $context->contextlevel is invalid - rather than ignoring this possibility.
216  *
217  * @package    core
218  * @subpackage lib
219  * @copyright  2009 onwards Martin Dougiamas  {@link http://moodle.com}
220  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
221  */
222 class invalid_state_exception extends moodle_exception {
223     /**
224      * Constructor
225      * @param string $hint short description of problem
226      * @param string $debuginfo optional more detailed information
227      */
228     function __construct($hint, $debuginfo=null) {
229         parent::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
230     }
233 /**
234  * An exception that indicates incorrect permissions in $CFG->dataroot
235  *
236  * @package    core
237  * @subpackage lib
238  * @copyright  2010 Petr Skoda {@link http://skodak.org}
239  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
240  */
241 class invalid_dataroot_permissions extends moodle_exception {
242     /**
243      * Constructor
244      * @param string $debuginfo optional more detailed information
245      */
246     function __construct($debuginfo = NULL) {
247         parent::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
248     }
251 /**
252  * Default exception handler, uncaught exceptions are equivalent to error() in 1.9 and earlier
253  *
254  * @param Exception $ex
255  * @return void -does not return. Terminates execution!
256  */
257 function default_exception_handler($ex) {
258     global $DB, $OUTPUT;
260     // detect active db transactions, rollback and log as error
261     abort_all_db_transactions();
263     $info = get_exception_info($ex);
265     if (debugging('', DEBUG_MINIMAL)) {
266         $logerrmsg = "Default exception handler: ".$info->message.' Debug: '.$info->debuginfo."\n".format_backtrace($info->backtrace, true);
267         error_log($logerrmsg);
268     }
270     if (is_early_init($info->backtrace)) {
271         echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
272     } else {
273         try {
274             if ($DB) {
275                 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
276                 $DB->set_debug(0);
277             }
278             echo $OUTPUT->fatal_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
279         } catch (Exception $out_ex) {
280             // default exception handler MUST not throw any exceptions!!
281             // 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
282             // so we just print at least something instead of "Exception thrown without a stack frame in Unknown on line 0":-(
283             if (CLI_SCRIPT or AJAX_SCRIPT) {
284                 // just ignore the error and send something back using the safest method
285                 echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
286             } else {
287                 echo bootstrap_renderer::early_error_content($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
288                 $outinfo = get_exception_info($out_ex);
289                 echo bootstrap_renderer::early_error_content($outinfo->message, $outinfo->moreinfourl, $outinfo->link, $outinfo->backtrace, $outinfo->debuginfo);
290             }
291         }
292     }
294     exit(1); // General error code
297 /**
298  * Default error handler, prevents some white screens.
299  * @param int $errno
300  * @param string $errstr
301  * @param string $errfile
302  * @param int $errline
303  * @param array $errcontext
304  * @return bool false means use default error handler
305  */
306 function default_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
307     if ($errno == 4096) {
308         //fatal catchable error
309         throw new coding_exception('PHP catchable fatal error', $errstr);
310     }
311     return false;
314 /**
315  * Unconditionally abort all database transactions, this function
316  * should be called from exception handlers only.
317  * @return void
318  */
319 function abort_all_db_transactions() {
320     global $CFG, $DB, $SCRIPT;
322     // default exception handler MUST not throw any exceptions!!
324     if ($DB && $DB->is_transaction_started()) {
325         error_log('Database transaction aborted automatically in ' . $CFG->dirroot . $SCRIPT);
326         // note: transaction blocks should never change current $_SESSION
327         $DB->force_transaction_rollback();
328     }
331 /**
332  * This function encapsulates the tests for whether an exception was thrown in
333  * early init -- either during setup.php or during init of $OUTPUT.
334  *
335  * If another exception is thrown then, and if we do not take special measures,
336  * we would just get a very cryptic message "Exception thrown without a stack
337  * frame in Unknown on line 0". That makes debugging very hard, so we do take
338  * special measures in default_exception_handler, with the help of this function.
339  *
340  * @param array $backtrace the stack trace to analyse.
341  * @return boolean whether the stack trace is somewhere in output initialisation.
342  */
343 function is_early_init($backtrace) {
344     $dangerouscode = array(
345         array('function' => 'header', 'type' => '->'),
346         array('class' => 'bootstrap_renderer'),
347         array('file' => dirname(__FILE__).'/setup.php'),
348     );
349     foreach ($backtrace as $stackframe) {
350         foreach ($dangerouscode as $pattern) {
351             $matches = true;
352             foreach ($pattern as $property => $value) {
353                 if (!isset($stackframe[$property]) || $stackframe[$property] != $value) {
354                     $matches = false;
355                 }
356             }
357             if ($matches) {
358                 return true;
359             }
360         }
361     }
362     return false;
365 /**
366  * Abort execution by throwing of a general exception,
367  * default exception handler displays the error message in most cases.
368  *
369  * @param string $errorcode The name of the language string containing the error message.
370  *      Normally this should be in the error.php lang file.
371  * @param string $module The language file to get the error message from.
372  * @param string $link The url where the user will be prompted to continue.
373  *      If no url is provided the user will be directed to the site index page.
374  * @param object $a Extra words and phrases that might be required in the error string
375  * @param string $debuginfo optional debugging information
376  * @return void, always throws exception!
377  */
378 function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
379     throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
382 /**
383  * Returns detailed information about specified exception.
384  * @param exception $ex
385  * @return object
386  */
387 function get_exception_info($ex) {
388     global $CFG, $DB, $SESSION;
390     if ($ex instanceof moodle_exception) {
391         $errorcode = $ex->errorcode;
392         $module = $ex->module;
393         $a = $ex->a;
394         $link = $ex->link;
395         $debuginfo = $ex->debuginfo;
396     } else {
397         $errorcode = 'generalexceptionmessage';
398         $module = 'error';
399         $a = $ex->getMessage();
400         $link = '';
401         $debuginfo = null;
402     }
404     $backtrace = $ex->getTrace();
405     $place = array('file'=>$ex->getFile(), 'line'=>$ex->getLine(), 'exception'=>get_class($ex));
406     array_unshift($backtrace, $place);
408     // Be careful, no guarantee moodlelib.php is loaded.
409     if (empty($module) || $module == 'moodle' || $module == 'core') {
410         $module = 'error';
411     }
412     if (function_exists('get_string_manager')) {
413         if (get_string_manager()->string_exists($errorcode, $module)) {
414             $message = get_string($errorcode, $module, $a);
415         } elseif ($module == 'error' && get_string_manager()->string_exists($errorcode, 'moodle')) {
416             // Search in moodle file if error specified - needed for backwards compatibility
417             $message = get_string($errorcode, 'moodle', $a);
418         } else {
419             $message = $module . '/' . $errorcode;
420         }
421     } else {
422         $message = $module . '/' . $errorcode;
423     }
425     // Be careful, no guarantee weblib.php is loaded.
426     if (function_exists('clean_text')) {
427         $message = clean_text($message);
428     } else {
429         $message = htmlspecialchars($message);
430     }
432     if (!empty($CFG->errordocroot)) {
433         $errordocroot = $CFG->errordocroot;
434     } else if (!empty($CFG->docroot)) {
435         $errordocroot = $CFG->docroot;
436     } else {
437         $errordocroot = 'http://docs.moodle.org';
438     }
439     if ($module === 'error') {
440         $modulelink = 'moodle';
441     } else {
442         $modulelink = $module;
443     }
444     $moreinfourl = $errordocroot . '/en/error/' . $modulelink . '/' . $errorcode;
446     if (empty($link)) {
447         if (!empty($SESSION->fromurl)) {
448             $link = $SESSION->fromurl;
449             unset($SESSION->fromurl);
450         } else {
451             $link = $CFG->wwwroot .'/';
452         }
453     }
455     $info = new stdClass();
456     $info->message     = $message;
457     $info->errorcode   = $errorcode;
458     $info->backtrace   = $backtrace;
459     $info->link        = $link;
460     $info->moreinfourl = $moreinfourl;
461     $info->a           = $a;
462     $info->debuginfo   = $debuginfo;
464     return $info;
467 /**
468  * Formats a backtrace ready for output.
469  *
470  * @param array $callers backtrace array, as returned by debug_backtrace().
471  * @param boolean $plaintext if false, generates HTML, if true generates plain text.
472  * @return string formatted backtrace, ready for output.
473  */
474 function format_backtrace($callers, $plaintext = false) {
475     // do not use $CFG->dirroot because it might not be available in destructors
476     $dirroot = dirname(dirname(__FILE__));
478     if (empty($callers)) {
479         return '';
480     }
482     $from = $plaintext ? '' : '<ul style="text-align: left">';
483     foreach ($callers as $caller) {
484         if (!isset($caller['line'])) {
485             $caller['line'] = '?'; // probably call_user_func()
486         }
487         if (!isset($caller['file'])) {
488             $caller['file'] = 'unknownfile'; // probably call_user_func()
489         }
490         $from .= $plaintext ? '* ' : '<li>';
491         $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
492         if (isset($caller['function'])) {
493             $from .= ': call to ';
494             if (isset($caller['class'])) {
495                 $from .= $caller['class'] . $caller['type'];
496             }
497             $from .= $caller['function'] . '()';
498         } else if (isset($caller['exception'])) {
499             $from .= ': '.$caller['exception'].' thrown';
500         }
501         $from .= $plaintext ? "\n" : '</li>';
502     }
503     $from .= $plaintext ? '' : '</ul>';
505     return $from;
508 /**
509  * This function verifies the sanity of PHP configuration
510  * and stops execution if anything critical found.
511  */
512 function setup_validate_php_configuration() {
513    // this must be very fast - no slow checks here!!!
515    if (ini_get_bool('register_globals')) {
516        print_error('globalswarning', 'admin');
517    }
518    if (ini_get_bool('session.auto_start')) {
519        print_error('sessionautostartwarning', 'admin');
520    }
521    if (ini_get_bool('magic_quotes_runtime')) {
522        print_error('fatalmagicquotesruntime', 'admin');
523    }
526 /**
527  * Initialise global $CFG variable
528  * @return void
529  */
530 function initialise_cfg() {
531     global $CFG, $DB;
533     try {
534         if ($DB) {
535             $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
536             foreach ($localcfg as $name=>$value) {
537                 if (property_exists($CFG, $name)) {
538                     // config.php settings always take precedence
539                     continue;
540                 }
541                 $CFG->{$name} = $value;
542             }
543         }
544     } catch (dml_read_exception $e) {
545         // most probably empty db, going to install soon
546     }
549 /**
550  * Initialises $FULLME and friends. Private function. Should only be called from
551  * setup.php.
552  */
553 function initialise_fullme() {
554     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
556     // Detect common config error.
557     if (substr($CFG->wwwroot, -1) == '/') {
558         print_error('wwwrootslash', 'error');
559     }
561     if (CLI_SCRIPT) {
562         initialise_fullme_cli();
563         return;
564     }
566     $wwwroot = parse_url($CFG->wwwroot);
567     if (!isset($wwwroot['path'])) {
568         $wwwroot['path'] = '';
569     }
570     $wwwroot['path'] .= '/';
572     $rurl = setup_get_remote_url();
574     // Check that URL is under $CFG->wwwroot.
575     if (strpos($rurl['path'], $wwwroot['path']) === 0) {
576         $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
577     } else {
578         // Probably some weird external script
579         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
580         return;
581     }
583     // $CFG->sslproxy specifies if external SSL appliance is used
584     // (That is, the Moodle server uses http, with an external box translating everything to https).
585     if (empty($CFG->sslproxy)) {
586         if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
587             print_error('sslonlyaccess', 'error');
588         }
589     } else {
590         if ($wwwroot['scheme'] !== 'https') {
591             throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
592         }
593         $rurl['scheme'] === 'https'; // make moodle believe it runs on https, squid or something else it doing it
594     }
596     // $CFG->reverseproxy specifies if reverse proxy server used.
597     // Used in load balancing scenarios.
598     // Do not abuse this to try to solve lan/wan access problems!!!!!
599     if (empty($CFG->reverseproxy)) {
600         if (($rurl['host'] != $wwwroot['host']) or
601                 (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port'])) {
602             // Explain the problem and redirect them to the right URL
603             if (!defined('NO_MOODLE_COOKIES')) {
604                 define('NO_MOODLE_COOKIES', true);
605             }
606             redirect($CFG->wwwroot, get_string('wwwrootmismatch', 'error', $CFG->wwwroot), 3);
607         }
608     }
610     // hopefully this will stop all those "clever" admins trying to set up moodle
611     // with two different addresses in intranet and Internet
612     if (!empty($CFG->reverseproxy) && $rurl['host'] == $wwwroot['host']) {
613         print_error('reverseproxyabused', 'error');
614     }
616     $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
617     if (!empty($wwwroot['port'])) {
618         $hostandport .= ':'.$wwwroot['port'];
619     }
621     $FULLSCRIPT = $hostandport . $rurl['path'];
622     $FULLME = $hostandport . $rurl['fullpath'];
623     $ME = $rurl['fullpath'];
624     $rurl['path'] = $rurl['fullpath'];
627 /**
628  * Initialises $FULLME and friends for command line scripts.
629  * This is a private method for use by initialise_fullme.
630  */
631 function initialise_fullme_cli() {
632     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
634     // Urls do not make much sense in CLI scripts
635     $backtrace = debug_backtrace();
636     $topfile = array_pop($backtrace);
637     $topfile = realpath($topfile['file']);
638     $dirroot = realpath($CFG->dirroot);
640     if (strpos($topfile, $dirroot) !== 0) {
641         // Probably some weird external script
642         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
643     } else {
644         $relativefile = substr($topfile, strlen($dirroot));
645         $relativefile = str_replace('\\', '/', $relativefile); // Win fix
646         $SCRIPT = $FULLSCRIPT = $relativefile;
647         $FULLME = $ME = null;
648     }
651 /**
652  * Get the URL that PHP/the web server thinks it is serving. Private function
653  * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
654  * @return array in the same format that parse_url returns, with the addition of
655  *      a 'fullpath' element, which includes any slasharguments path.
656  */
657 function setup_get_remote_url() {
658     $rurl = array();
659     list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
660     $rurl['port'] = $_SERVER['SERVER_PORT'];
661     $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
663     if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
664         //Apache server
665         $rurl['scheme']   = empty($_SERVER['HTTPS']) ? 'http' : 'https';
666         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
668     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
669         //IIS - needs a lot of tweaking to make it work
670         $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
671         $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
673         // NOTE: ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS
674         //       since 2.0 we rely on iis rewrite extenssion like Helicon ISAPI_rewrite
675         //       example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
677         if ($_SERVER['QUERY_STRING'] != '') {
678             $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
679         }
680         $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
682 /* NOTE: following servers are not fully tested! */
684     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
685         //lighttpd - not officially supported
686         $rurl['scheme']   = empty($_SERVER['HTTPS']) ? 'http' : 'https';
687         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
689     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
690         //nginx - not officially supported
691         $rurl['scheme']   = empty($_SERVER['HTTPS']) ? 'http' : 'https';
692         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
694      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
695          //cherokee - not officially supported
696          $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
697          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
699      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
700          //zeus - not officially supported
701          $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
702          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
704     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
705         //LiteSpeed - not officially supported
706         $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
707         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
709      } else {
710         throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
711     }
712     return $rurl;
715 /**
716  * Initializes our performance info early.
717  *
718  * Pairs up with get_performance_info() which is actually
719  * in moodlelib.php. This function is here so that we can
720  * call it before all the libs are pulled in.
721  *
722  * @uses $PERF
723  */
724 function init_performance_info() {
726     global $PERF, $CFG, $USER;
728     $PERF = new stdClass();
729     $PERF->logwrites = 0;
730     if (function_exists('microtime')) {
731         $PERF->starttime = microtime();
732     }
733     if (function_exists('memory_get_usage')) {
734         $PERF->startmemory = memory_get_usage();
735     }
736     if (function_exists('posix_times')) {
737         $PERF->startposixtimes = posix_times();
738     }
739     if (function_exists('apd_set_pprof_trace')) {
740         // APD profiling
741         if ($USER->id > 0 && $CFG->perfdebug >= 15) {
742             $tempdir = $CFG->dataroot . '/temp/profile/' . $USER->id;
743             mkdir($tempdir);
744             apd_set_pprof_trace($tempdir);
745             $PERF->profiling = true;
746         }
747     }
750 /**
751  * Indicates whether we are in the middle of the initial Moodle install.
752  *
753  * Very occasionally it is necessary avoid running certain bits of code before the
754  * Moodle installation has completed. The installed flag is set in admin/index.php
755  * after Moodle core and all the plugins have been installed, but just before
756  * the person doing the initial install is asked to choose the admin password.
757  *
758  * @return boolean true if the initial install is not complete.
759  */
760 function during_initial_install() {
761     global $CFG;
762     return empty($CFG->rolesactive);
765 /**
766  * Function to raise the memory limit to a new value.
767  * Will respect the memory limit if it is higher, thus allowing
768  * settings in php.ini, apache conf or command line switches
769  * to override it
770  *
771  * The memory limit should be expressed with a string (eg:'64M')
772  *
773  * @param string $newlimit the new memory limit
774  * @return bool
775  */
776 function raise_memory_limit($newlimit) {
778     if (empty($newlimit)) {
779         return false;
780     }
782     $cur = @ini_get('memory_limit');
783     if (empty($cur)) {
784         // if php is compiled without --enable-memory-limits
785         // apparently memory_limit is set to ''
786         $cur=0;
787     } else {
788         if ($cur == -1){
789             return true; // unlimited mem!
790         }
791       $cur = get_real_size($cur);
792     }
794     $new = get_real_size($newlimit);
795     if ($new > $cur) {
796         ini_set('memory_limit', $newlimit);
797         return true;
798     }
799     return false;
802 /**
803  * Function to reduce the memory limit to a new value.
804  * Will respect the memory limit if it is lower, thus allowing
805  * settings in php.ini, apache conf or command line switches
806  * to override it
807  *
808  * The memory limit should be expressed with a string (eg:'64M')
809  *
810  * @param string $newlimit the new memory limit
811  * @return bool
812  */
813 function reduce_memory_limit($newlimit) {
814     if (empty($newlimit)) {
815         return false;
816     }
817     $cur = @ini_get('memory_limit');
818     if (empty($cur)) {
819         // if php is compiled without --enable-memory-limits
820         // apparently memory_limit is set to ''
821         $cur=0;
822     } else {
823         if ($cur == -1){
824             return true; // unlimited mem!
825         }
826         $cur = get_real_size($cur);
827     }
829     $new = get_real_size($newlimit);
830     // -1 is smaller, but it means unlimited
831     if ($new < $cur && $new != -1) {
832         ini_set('memory_limit', $newlimit);
833         return true;
834     }
835     return false;
838 /**
839  * Converts numbers like 10M into bytes.
840  *
841  * @param mixed $size The size to be converted
842  * @return mixed
843  */
844 function get_real_size($size=0) {
845     if (!$size) {
846         return 0;
847     }
848     $scan = array();
849     $scan['MB'] = 1048576;
850     $scan['Mb'] = 1048576;
851     $scan['M'] = 1048576;
852     $scan['m'] = 1048576;
853     $scan['KB'] = 1024;
854     $scan['Kb'] = 1024;
855     $scan['K'] = 1024;
856     $scan['k'] = 1024;
858     while (list($key) = each($scan)) {
859         if ((strlen($size)>strlen($key))&&(substr($size, strlen($size) - strlen($key))==$key)) {
860             $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
861             break;
862         }
863     }
864     return $size;
867 /**
868  * Check whether a major upgrade is needed. That is defined as an upgrade that
869  * changes something really fundamental in the database, so nothing can possibly
870  * work until the database has been updated, and that is defined by the hard-coded
871  * version number in this function.
872  */
873 function redirect_if_major_upgrade_required() {
874     global $CFG;
875     $lastmajordbchanges = 2010070300;
876     if (empty($CFG->version) or (int)$CFG->version < $lastmajordbchanges or
877             during_initial_install() or !empty($CFG->adminsetuppending)) {
878         try {
879             @session_get_instance()->terminate_current();
880         } catch (Exception $e) {
881             // Ignore any errors, redirect to upgrade anyway.
882         }
883         $url = $CFG->wwwroot . '/' . $CFG->admin . '/index.php';
884         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
885         @header('Location: ' . $url);
886         echo bootstrap_renderer::plain_redirect_message(htmlspecialchars($url));
887         exit;
888     }
891 /**
892  * Function to check if a directory exists and by default create it if not exists.
893  *
894  * Previously this was accepting paths only from dataroot, but we now allow
895  * files outside of dataroot if you supply custom paths for some settings in config.php.
896  * This function does not verify that the directory is writable.
897  *
898  * @param string $dir absolute directory path
899  * @param boolean $create directory if does not exist
900  * @param boolean $recursive create directory recursively
901  * @return boolean true if directory exists or created, false otherwise
902  */
903 function check_dir_exists($dir, $create = true, $recursive = true) {
904     global $CFG;
906     umask(0000); // just in case some evil code changed it
908     if (is_dir($dir)) {
909         return true;
910     }
912     if (!$create) {
913         return false;
914     }
916     return mkdir($dir, $CFG->directorypermissions, $recursive);
919 /**
920  * Create a directory in dataroot and make sure it is writable.
921  *
922  * @param string $directory  a string of directory names under $CFG->dataroot eg  temp/something
923  * @param bool $exceptiononerror throw exception if error encountered
924  * @return string|false Returns full path to directory if successful, false if not; may throw exception
925  */
926 function make_upload_directory($directory, $exceptiononerror = true) {
927     global $CFG;
929     // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
930     if (!file_exists("$CFG->dataroot/.htaccess")) {
931         if ($handle = fopen("$CFG->dataroot/.htaccess", 'w')) {   // For safety
932             @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");
933             @fclose($handle);
934         }
935     }
937     $dir = "$CFG->dataroot/$directory";
939     if (file_exists($dir) and !is_dir($dir)) {
940         if ($exceptiononerror) {
941             throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
942         } else {
943             return false;
944         }
945     }
947     umask(0000); // just in case some evil code changed it
949     if (!file_exists($dir)) {
950         if (!mkdir($dir, $CFG->directorypermissions, true)) {
951             if ($exceptiononerror) {
952                 throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
953             } else {
954                 return false;
955             }
956         }
957     }
959     if (!is_writable($dir)) {
960         if ($exceptiononerror) {
961             throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
962         } else {
963             return false;
964         }
965     }
967     return $dir;
970 function init_memcached() {
971     global $CFG, $MCACHE;
973     include_once($CFG->libdir . '/memcached.class.php');
974     $MCACHE = new memcached;
975     if ($MCACHE->status()) {
976         return true;
977     }
978     unset($MCACHE);
979     return false;
982 function init_eaccelerator() {
983     global $CFG, $MCACHE;
985     include_once($CFG->libdir . '/eaccelerator.class.php');
986     $MCACHE = new eaccelerator;
987     if ($MCACHE->status()) {
988         return true;
989     }
990     unset($MCACHE);
991     return false;
995 /**
996  * This class solves the problem of how to initialise $OUTPUT.
997  *
998  * The problem is caused be two factors
999  * <ol>
1000  * <li>On the one hand, we cannot be sure when output will start. In particular,
1001  * an error, which needs to be displayed, could be thrown at any time.</li>
1002  * <li>On the other hand, we cannot be sure when we will have all the information
1003  * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1004  * (potentially) depends on the current course, course categories, and logged in user.
1005  * It also depends on whether the current page requires HTTPS.</li>
1006  * </ol>
1007  *
1008  * So, it is hard to find a single natural place during Moodle script execution,
1009  * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1010  * adopt the following strategy
1011  * <ol>
1012  * <li>We will initialise $OUTPUT the first time it is used.</li>
1013  * <li>If, after $OUTPUT has been initialised, the script tries to change something
1014  * that $OUTPUT depends on, we throw an exception making it clear that the script
1015  * did something wrong.
1016  * </ol>
1017  *
1018  * The only problem with that is, how do we initialise $OUTPUT on first use if,
1019  * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1020  * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1021  * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1022  *
1023  * Note that this class is used before lib/outputlib.php has been loaded, so we
1024  * must be careful referring to classes/functions from there, they may not be
1025  * defined yet, and we must avoid fatal errors.
1026  *
1027  * @copyright 2009 Tim Hunt
1028  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1029  * @since     Moodle 2.0
1030  */
1031 class bootstrap_renderer {
1032     /**
1033      * Handles re-entrancy. Without this, errors or debugging output that occur
1034      * during the initialisation of $OUTPUT, cause infinite recursion.
1035      * @var boolean
1036      */
1037     protected $initialising = false;
1039     /**
1040      * Have we started output yet?
1041      * @return boolean true if the header has been printed.
1042      */
1043     public function has_started() {
1044         return false;
1045     }
1047     public function __call($method, $arguments) {
1048         global $OUTPUT, $PAGE;
1050         $recursing = false;
1051         if ($method == 'notification') {
1052             // Catch infinite recursion caused by debugging output during print_header.
1053             $backtrace = debug_backtrace();
1054             array_shift($backtrace);
1055             array_shift($backtrace);
1056             $recursing = is_early_init($backtrace);
1057         }
1059         $earlymethods = array(
1060             'fatal_error' => 'early_error',
1061             'notification' => 'early_notification',
1062         );
1064         // If lib/outputlib.php has been loaded, call it.
1065         if (!empty($PAGE) && !$recursing) {
1066             if (array_key_exists($method, $earlymethods)) {
1067                 //prevent PAGE->context warnings - exceptions might appear before we set any context
1068                 $PAGE->set_context(null);
1069             }
1070             $PAGE->initialise_theme_and_output();
1071             return call_user_func_array(array($OUTPUT, $method), $arguments);
1072         }
1074         $this->initialising = true;
1076         // Too soon to initialise $OUTPUT, provide a couple of key methods.
1077         if (array_key_exists($method, $earlymethods)) {
1078             return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1079         }
1081         throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1082     }
1084     /**
1085      * Returns nicely formatted error message in a div box.
1086      * @return string
1087      */
1088     public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1089         global $CFG;
1091         $content = '<div style="margin-top: 6em; margin-left:auto; margin-right:auto; color:#990000; text-align:center; font-size:large; border-width:1px;
1092 border-color:black; background-color:#ffffee; border-style:solid; border-radius: 20px; border-collapse: collapse;
1093 width: 80%; -moz-border-radius: 20px; padding: 15px">
1094 ' . $message . '
1095 </div>';
1096         if (!empty($CFG->debug) && $CFG->debug >= DEBUG_DEVELOPER) {
1097             if (!empty($debuginfo)) {
1098                 $debuginfo = s($debuginfo); // removes all nasty JS
1099                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1100                 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
1101             }
1102             if (!empty($backtrace)) {
1103                 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
1104             }
1105         }
1107         return $content;
1108     }
1110     /**
1111      * This function should only be called by this class, or from exception handlers
1112      * @return string
1113      */
1114     public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1115         global $CFG;
1117         if (CLI_SCRIPT) {
1118             echo "!!! $message !!!\n";
1119             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1120                 if (!empty($debuginfo)) {
1121                     echo "\nDebug info: $debuginfo";
1122                 }
1123                 if (!empty($backtrace)) {
1124                     echo "\nStack trace: " . format_backtrace($backtrace, true);
1125                 }
1126             }
1127             return;
1129         } else if (AJAX_SCRIPT) {
1130             $e = new stdClass();
1131             $e->error      = $message;
1132             $e->stacktrace = NULL;
1133             $e->debuginfo  = NULL;
1134             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1135                 if (!empty($debuginfo)) {
1136                     $e->debuginfo = $debuginfo;
1137                 }
1138                 if (!empty($backtrace)) {
1139                     $e->stacktrace = format_backtrace($backtrace, true);
1140                 }
1141             }
1142             @header('Content-Type: application/json');
1143             echo json_encode($e);
1144             return;
1145         }
1147         // In the name of protocol correctness, monitoring and performance
1148         // profiling, set the appropriate error headers for machine consumption
1149         if (isset($_SERVER['SERVER_PROTOCOL'])) {
1150             // Avoid it with cron.php. Note that we assume it's HTTP/1.x
1151             // The 503 ode here means our Moodle does not work at all, the error happened too early
1152             @header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
1153         }
1155         // better disable any caching
1156         @header('Content-Type: text/html; charset=utf-8');
1157         @header('Cache-Control: no-store, no-cache, must-revalidate');
1158         @header('Cache-Control: post-check=0, pre-check=0', false);
1159         @header('Pragma: no-cache');
1160         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1161         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1163         if (function_exists('get_string')) {
1164             $strerror = get_string('error');
1165         } else {
1166             $strerror = 'Error';
1167         }
1169         $content = self::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
1171         return self::plain_page($strerror, $content);
1172     }
1174     public static function early_notification($message, $classes = 'notifyproblem') {
1175         return '<div class="' . $classes . '">' . $message . '</div>';
1176     }
1178     public static function plain_redirect_message($encodedurl) {
1179         $message = '<p>' . get_string('pageshouldredirect') . '</p><p><a href="'.
1180                 $encodedurl .'">'. get_string('continue') .'</a></p>';
1181         return self::plain_page(get_string('redirect'), $message);
1182     }
1184     protected static function plain_page($title, $content) {
1185         if (function_exists('get_string') && function_exists('get_html_lang')) {
1186             $htmllang = get_html_lang();
1187         } else {
1188             $htmllang = '';
1189         }
1191         return '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1192 <html xmlns="http://www.w3.org/1999/xhtml" ' . $htmllang . '>
1193 <head>
1194 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1195 <title>' . $title . '</title>
1196 </head><body>' . $content . '</body></html>';
1197     }