6e6d8b7c9c924eafa6e342e1ddb36ff8ce8ca523
[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         if ($context->contextlevel == CONTEXT_MODULE and preg_match('/:view$/', $capability)) {
150             // 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
151             $paranetcontext = get_context_instance_by_id(get_parent_contextid($context));
152             $link = get_context_url($paranetcontext);
153         } else {
154             $link = get_context_url($context);
155         }
156         parent::__construct($errormessage, $stringfile, $link, $capabilityname);
157     }
160 /**
161  * Exception indicating programming error, must be fixed by a programer. For example
162  * a core API might throw this type of exception if a plugin calls it incorrectly.
163  *
164  * @package    core
165  * @subpackage lib
166  * @copyright  2008 Petr Skoda  {@link http://skodak.org}
167  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
168  */
169 class coding_exception extends moodle_exception {
170     /**
171      * Constructor
172      * @param string $hint short description of problem
173      * @param string $debuginfo detailed information how to fix problem
174      */
175     function __construct($hint, $debuginfo=null) {
176         parent::__construct('codingerror', 'debug', '', $hint, $debuginfo);
177     }
180 /**
181  * Exception indicating malformed parameter problem.
182  * This exception is not supposed to be thrown when processing
183  * user submitted data in forms. It is more suitable
184  * for WS and other low level stuff.
185  *
186  * @package    core
187  * @subpackage lib
188  * @copyright  2009 Petr Skoda  {@link http://skodak.org}
189  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
190  */
191 class invalid_parameter_exception extends moodle_exception {
192     /**
193      * Constructor
194      * @param string $debuginfo some detailed information
195      */
196     function __construct($debuginfo=null) {
197         parent::__construct('invalidparameter', 'debug', '', null, $debuginfo);
198     }
201 /**
202  * Exception indicating malformed response problem.
203  * This exception is not supposed to be thrown when processing
204  * user submitted data in forms. It is more suitable
205  * for WS and other low level stuff.
206  */
207 class invalid_response_exception extends moodle_exception {
208     /**
209      * Constructor
210      * @param string $debuginfo some detailed information
211      */
212     function __construct($debuginfo=null) {
213         parent::__construct('invalidresponse', 'debug', '', null, $debuginfo);
214     }
217 /**
218  * An exception that indicates something really weird happened. For example,
219  * if you do switch ($context->contextlevel), and have one case for each
220  * CONTEXT_... constant. You might throw an invalid_state_exception in the
221  * default case, to just in case something really weird is going on, and
222  * $context->contextlevel is invalid - rather than ignoring this possibility.
223  *
224  * @package    core
225  * @subpackage lib
226  * @copyright  2009 onwards Martin Dougiamas  {@link http://moodle.com}
227  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
228  */
229 class invalid_state_exception extends moodle_exception {
230     /**
231      * Constructor
232      * @param string $hint short description of problem
233      * @param string $debuginfo optional more detailed information
234      */
235     function __construct($hint, $debuginfo=null) {
236         parent::__construct('invalidstatedetected', 'debug', '', $hint, $debuginfo);
237     }
240 /**
241  * An exception that indicates incorrect permissions in $CFG->dataroot
242  *
243  * @package    core
244  * @subpackage lib
245  * @copyright  2010 Petr Skoda {@link http://skodak.org}
246  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
247  */
248 class invalid_dataroot_permissions extends moodle_exception {
249     /**
250      * Constructor
251      * @param string $debuginfo optional more detailed information
252      */
253     function __construct($debuginfo = NULL) {
254         parent::__construct('invaliddatarootpermissions', 'error', '', NULL, $debuginfo);
255     }
258 /**
259  * Default exception handler, uncaught exceptions are equivalent to error() in 1.9 and earlier
260  *
261  * @param Exception $ex
262  * @return void -does not return. Terminates execution!
263  */
264 function default_exception_handler($ex) {
265     global $DB, $OUTPUT;
267     // detect active db transactions, rollback and log as error
268     abort_all_db_transactions();
270     $info = get_exception_info($ex);
272     if (debugging('', DEBUG_MINIMAL)) {
273         $logerrmsg = "Default exception handler: ".$info->message.' Debug: '.$info->debuginfo."\n".format_backtrace($info->backtrace, true);
274         error_log($logerrmsg);
275     }
277     if (is_early_init($info->backtrace)) {
278         echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
279     } else {
280         try {
281             if ($DB) {
282                 // If you enable db debugging and exception is thrown, the print footer prints a lot of rubbish
283                 $DB->set_debug(0);
284             }
285             echo $OUTPUT->fatal_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
286         } catch (Exception $out_ex) {
287             // default exception handler MUST not throw any exceptions!!
288             // 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
289             // so we just print at least something instead of "Exception thrown without a stack frame in Unknown on line 0":-(
290             if (CLI_SCRIPT or AJAX_SCRIPT) {
291                 // just ignore the error and send something back using the safest method
292                 echo bootstrap_renderer::early_error($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
293             } else {
294                 echo bootstrap_renderer::early_error_content($info->message, $info->moreinfourl, $info->link, $info->backtrace, $info->debuginfo);
295                 $outinfo = get_exception_info($out_ex);
296                 echo bootstrap_renderer::early_error_content($outinfo->message, $outinfo->moreinfourl, $outinfo->link, $outinfo->backtrace, $outinfo->debuginfo);
297             }
298         }
299     }
301     exit(1); // General error code
304 /**
305  * Default error handler, prevents some white screens.
306  * @param int $errno
307  * @param string $errstr
308  * @param string $errfile
309  * @param int $errline
310  * @param array $errcontext
311  * @return bool false means use default error handler
312  */
313 function default_error_handler($errno, $errstr, $errfile, $errline, $errcontext) {
314     if ($errno == 4096) {
315         //fatal catchable error
316         throw new coding_exception('PHP catchable fatal error', $errstr);
317     }
318     return false;
321 /**
322  * Unconditionally abort all database transactions, this function
323  * should be called from exception handlers only.
324  * @return void
325  */
326 function abort_all_db_transactions() {
327     global $CFG, $DB, $SCRIPT;
329     // default exception handler MUST not throw any exceptions!!
331     if ($DB && $DB->is_transaction_started()) {
332         error_log('Database transaction aborted automatically in ' . $CFG->dirroot . $SCRIPT);
333         // note: transaction blocks should never change current $_SESSION
334         $DB->force_transaction_rollback();
335     }
338 /**
339  * This function encapsulates the tests for whether an exception was thrown in
340  * early init -- either during setup.php or during init of $OUTPUT.
341  *
342  * If another exception is thrown then, and if we do not take special measures,
343  * we would just get a very cryptic message "Exception thrown without a stack
344  * frame in Unknown on line 0". That makes debugging very hard, so we do take
345  * special measures in default_exception_handler, with the help of this function.
346  *
347  * @param array $backtrace the stack trace to analyse.
348  * @return boolean whether the stack trace is somewhere in output initialisation.
349  */
350 function is_early_init($backtrace) {
351     $dangerouscode = array(
352         array('function' => 'header', 'type' => '->'),
353         array('class' => 'bootstrap_renderer'),
354         array('file' => dirname(__FILE__).'/setup.php'),
355     );
356     foreach ($backtrace as $stackframe) {
357         foreach ($dangerouscode as $pattern) {
358             $matches = true;
359             foreach ($pattern as $property => $value) {
360                 if (!isset($stackframe[$property]) || $stackframe[$property] != $value) {
361                     $matches = false;
362                 }
363             }
364             if ($matches) {
365                 return true;
366             }
367         }
368     }
369     return false;
372 /**
373  * Abort execution by throwing of a general exception,
374  * default exception handler displays the error message in most cases.
375  *
376  * @param string $errorcode The name of the language string containing the error message.
377  *      Normally this should be in the error.php lang file.
378  * @param string $module The language file to get the error message from.
379  * @param string $link The url where the user will be prompted to continue.
380  *      If no url is provided the user will be directed to the site index page.
381  * @param object $a Extra words and phrases that might be required in the error string
382  * @param string $debuginfo optional debugging information
383  * @return void, always throws exception!
384  */
385 function print_error($errorcode, $module = 'error', $link = '', $a = null, $debuginfo = null) {
386     throw new moodle_exception($errorcode, $module, $link, $a, $debuginfo);
389 /**
390  * Returns detailed information about specified exception.
391  * @param exception $ex
392  * @return object
393  */
394 function get_exception_info($ex) {
395     global $CFG, $DB, $SESSION;
397     if ($ex instanceof moodle_exception) {
398         $errorcode = $ex->errorcode;
399         $module = $ex->module;
400         $a = $ex->a;
401         $link = $ex->link;
402         $debuginfo = $ex->debuginfo;
403     } else {
404         $errorcode = 'generalexceptionmessage';
405         $module = 'error';
406         $a = $ex->getMessage();
407         $link = '';
408         $debuginfo = null;
409     }
411     $backtrace = $ex->getTrace();
412     $place = array('file'=>$ex->getFile(), 'line'=>$ex->getLine(), 'exception'=>get_class($ex));
413     array_unshift($backtrace, $place);
415     // Be careful, no guarantee moodlelib.php is loaded.
416     if (empty($module) || $module == 'moodle' || $module == 'core') {
417         $module = 'error';
418     }
419     if (function_exists('get_string_manager')) {
420         if (get_string_manager()->string_exists($errorcode, $module)) {
421             $message = get_string($errorcode, $module, $a);
422         } elseif ($module == 'error' && get_string_manager()->string_exists($errorcode, 'moodle')) {
423             // Search in moodle file if error specified - needed for backwards compatibility
424             $message = get_string($errorcode, 'moodle', $a);
425         } else {
426             $message = $module . '/' . $errorcode;
427         }
428     } else {
429         $message = $module . '/' . $errorcode;
430     }
432     // Be careful, no guarantee weblib.php is loaded.
433     if (function_exists('clean_text')) {
434         $message = clean_text($message);
435     } else {
436         $message = htmlspecialchars($message);
437     }
439     if (!empty($CFG->errordocroot)) {
440         $errordocroot = $CFG->errordocroot;
441     } else if (!empty($CFG->docroot)) {
442         $errordocroot = $CFG->docroot;
443     } else {
444         $errordocroot = 'http://docs.moodle.org';
445     }
446     if ($module === 'error') {
447         $modulelink = 'moodle';
448     } else {
449         $modulelink = $module;
450     }
451     $moreinfourl = $errordocroot . '/en/error/' . $modulelink . '/' . $errorcode;
453     if (empty($link)) {
454         if (!empty($SESSION->fromurl)) {
455             $link = $SESSION->fromurl;
456             unset($SESSION->fromurl);
457         } else {
458             $link = $CFG->wwwroot .'/';
459         }
460     }
462     $info = new stdClass();
463     $info->message     = $message;
464     $info->errorcode   = $errorcode;
465     $info->backtrace   = $backtrace;
466     $info->link        = $link;
467     $info->moreinfourl = $moreinfourl;
468     $info->a           = $a;
469     $info->debuginfo   = $debuginfo;
471     return $info;
474 /**
475  * Formats a backtrace ready for output.
476  *
477  * @param array $callers backtrace array, as returned by debug_backtrace().
478  * @param boolean $plaintext if false, generates HTML, if true generates plain text.
479  * @return string formatted backtrace, ready for output.
480  */
481 function format_backtrace($callers, $plaintext = false) {
482     // do not use $CFG->dirroot because it might not be available in destructors
483     $dirroot = dirname(dirname(__FILE__));
485     if (empty($callers)) {
486         return '';
487     }
489     $from = $plaintext ? '' : '<ul style="text-align: left">';
490     foreach ($callers as $caller) {
491         if (!isset($caller['line'])) {
492             $caller['line'] = '?'; // probably call_user_func()
493         }
494         if (!isset($caller['file'])) {
495             $caller['file'] = 'unknownfile'; // probably call_user_func()
496         }
497         $from .= $plaintext ? '* ' : '<li>';
498         $from .= 'line ' . $caller['line'] . ' of ' . str_replace($dirroot, '', $caller['file']);
499         if (isset($caller['function'])) {
500             $from .= ': call to ';
501             if (isset($caller['class'])) {
502                 $from .= $caller['class'] . $caller['type'];
503             }
504             $from .= $caller['function'] . '()';
505         } else if (isset($caller['exception'])) {
506             $from .= ': '.$caller['exception'].' thrown';
507         }
508         $from .= $plaintext ? "\n" : '</li>';
509     }
510     $from .= $plaintext ? '' : '</ul>';
512     return $from;
515 /**
516  * This function verifies the sanity of PHP configuration
517  * and stops execution if anything critical found.
518  */
519 function setup_validate_php_configuration() {
520    // this must be very fast - no slow checks here!!!
522    if (ini_get_bool('register_globals')) {
523        print_error('globalswarning', 'admin');
524    }
525    if (ini_get_bool('session.auto_start')) {
526        print_error('sessionautostartwarning', 'admin');
527    }
528    if (ini_get_bool('magic_quotes_runtime')) {
529        print_error('fatalmagicquotesruntime', 'admin');
530    }
533 /**
534  * Initialise global $CFG variable
535  * @return void
536  */
537 function initialise_cfg() {
538     global $CFG, $DB;
540     try {
541         if ($DB) {
542             $localcfg = $DB->get_records_menu('config', array(), '', 'name,value');
543             foreach ($localcfg as $name=>$value) {
544                 if (property_exists($CFG, $name)) {
545                     // config.php settings always take precedence
546                     continue;
547                 }
548                 $CFG->{$name} = $value;
549             }
550         }
551     } catch (dml_read_exception $e) {
552         // most probably empty db, going to install soon
553     }
556 /**
557  * Initialises $FULLME and friends. Private function. Should only be called from
558  * setup.php.
559  */
560 function initialise_fullme() {
561     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
563     // Detect common config error.
564     if (substr($CFG->wwwroot, -1) == '/') {
565         print_error('wwwrootslash', 'error');
566     }
568     if (CLI_SCRIPT) {
569         initialise_fullme_cli();
570         return;
571     }
573     $wwwroot = parse_url($CFG->wwwroot);
574     if (!isset($wwwroot['path'])) {
575         $wwwroot['path'] = '';
576     }
577     $wwwroot['path'] .= '/';
579     $rurl = setup_get_remote_url();
581     // Check that URL is under $CFG->wwwroot.
582     if (strpos($rurl['path'], $wwwroot['path']) === 0) {
583         $SCRIPT = substr($rurl['path'], strlen($wwwroot['path'])-1);
584     } else {
585         // Probably some weird external script
586         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
587         return;
588     }
590     // $CFG->sslproxy specifies if external SSL appliance is used
591     // (That is, the Moodle server uses http, with an external box translating everything to https).
592     if (empty($CFG->sslproxy)) {
593         if ($rurl['scheme'] === 'http' and $wwwroot['scheme'] === 'https') {
594             print_error('sslonlyaccess', 'error');
595         }
596     } else {
597         if ($wwwroot['scheme'] !== 'https') {
598             throw new coding_exception('Must use https address in wwwroot when ssl proxy enabled!');
599         }
600         $rurl['scheme'] = 'https'; // make moodle believe it runs on https, squid or something else it doing it
601     }
603     // $CFG->reverseproxy specifies if reverse proxy server used.
604     // Used in load balancing scenarios.
605     // Do not abuse this to try to solve lan/wan access problems!!!!!
606     if (empty($CFG->reverseproxy)) {
607         if (($rurl['host'] != $wwwroot['host']) or
608                 (!empty($wwwroot['port']) and $rurl['port'] != $wwwroot['port'])) {
609             // Explain the problem and redirect them to the right URL
610             if (!defined('NO_MOODLE_COOKIES')) {
611                 define('NO_MOODLE_COOKIES', true);
612             }
613             redirect($CFG->wwwroot, get_string('wwwrootmismatch', 'error', $CFG->wwwroot), 3);
614         }
615     }
617     // hopefully this will stop all those "clever" admins trying to set up moodle
618     // with two different addresses in intranet and Internet
619     if (!empty($CFG->reverseproxy) && $rurl['host'] == $wwwroot['host']) {
620         print_error('reverseproxyabused', 'error');
621     }
623     $hostandport = $rurl['scheme'] . '://' . $wwwroot['host'];
624     if (!empty($wwwroot['port'])) {
625         $hostandport .= ':'.$wwwroot['port'];
626     }
628     $FULLSCRIPT = $hostandport . $rurl['path'];
629     $FULLME = $hostandport . $rurl['fullpath'];
630     $ME = $rurl['fullpath'];
631     $rurl['path'] = $rurl['fullpath'];
634 /**
635  * Initialises $FULLME and friends for command line scripts.
636  * This is a private method for use by initialise_fullme.
637  */
638 function initialise_fullme_cli() {
639     global $CFG, $FULLME, $ME, $SCRIPT, $FULLSCRIPT;
641     // Urls do not make much sense in CLI scripts
642     $backtrace = debug_backtrace();
643     $topfile = array_pop($backtrace);
644     $topfile = realpath($topfile['file']);
645     $dirroot = realpath($CFG->dirroot);
647     if (strpos($topfile, $dirroot) !== 0) {
648         // Probably some weird external script
649         $SCRIPT = $FULLSCRIPT = $FULLME = $ME = null;
650     } else {
651         $relativefile = substr($topfile, strlen($dirroot));
652         $relativefile = str_replace('\\', '/', $relativefile); // Win fix
653         $SCRIPT = $FULLSCRIPT = $relativefile;
654         $FULLME = $ME = null;
655     }
658 /**
659  * Get the URL that PHP/the web server thinks it is serving. Private function
660  * used by initialise_fullme. In your code, use $PAGE->url, $SCRIPT, etc.
661  * @return array in the same format that parse_url returns, with the addition of
662  *      a 'fullpath' element, which includes any slasharguments path.
663  */
664 function setup_get_remote_url() {
665     $rurl = array();
666     list($rurl['host']) = explode(':', $_SERVER['HTTP_HOST']);
667     $rurl['port'] = $_SERVER['SERVER_PORT'];
668     $rurl['path'] = $_SERVER['SCRIPT_NAME']; // Script path without slash arguments
670     if (stripos($_SERVER['SERVER_SOFTWARE'], 'apache') !== false) {
671         //Apache server
672         $rurl['scheme']   = empty($_SERVER['HTTPS']) ? 'http' : 'https';
673         $rurl['fullpath'] = $_SERVER['REQUEST_URI'];
675     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'iis') !== false) {
676         //IIS - needs a lot of tweaking to make it work
677         $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
678         $rurl['fullpath'] = $_SERVER['SCRIPT_NAME'];
680         // NOTE: ignore PATH_INFO because it is incorrectly encoded using 8bit filesystem legacy encoding in IIS
681         //       since 2.0 we rely on iis rewrite extenssion like Helicon ISAPI_rewrite
682         //       example rule: RewriteRule ^([^\?]+?\.php)(\/.+)$ $1\?file=$2 [QSA]
684         if ($_SERVER['QUERY_STRING'] != '') {
685             $rurl['fullpath'] .= '?'.$_SERVER['QUERY_STRING'];
686         }
687         $_SERVER['REQUEST_URI'] = $rurl['fullpath']; // extra IIS compatibility
689 /* NOTE: following servers are not fully tested! */
691     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'lighttpd') !== false) {
692         //lighttpd - not officially supported
693         $rurl['scheme']   = empty($_SERVER['HTTPS']) ? 'http' : 'https';
694         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
696     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'nginx') !== false) {
697         //nginx - not officially supported
698         $rurl['scheme']   = empty($_SERVER['HTTPS']) ? 'http' : 'https';
699         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
701      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'cherokee') !== false) {
702          //cherokee - not officially supported
703          $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
704          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
706      } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'zeus') !== false) {
707          //zeus - not officially supported
708          $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
709          $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
711     } else if (stripos($_SERVER['SERVER_SOFTWARE'], 'LiteSpeed') !== false) {
712         //LiteSpeed - not officially supported
713         $rurl['scheme']   = ($_SERVER['HTTPS'] == 'off') ? 'http' : 'https';
714         $rurl['fullpath'] = $_SERVER['REQUEST_URI']; // TODO: verify this is always properly encoded
716      } else {
717         throw new moodle_exception('unsupportedwebserver', 'error', '', $_SERVER['SERVER_SOFTWARE']);
718     }
719     return $rurl;
722 /**
723  * Initializes our performance info early.
724  *
725  * Pairs up with get_performance_info() which is actually
726  * in moodlelib.php. This function is here so that we can
727  * call it before all the libs are pulled in.
728  *
729  * @uses $PERF
730  */
731 function init_performance_info() {
733     global $PERF, $CFG, $USER;
735     $PERF = new stdClass();
736     $PERF->logwrites = 0;
737     if (function_exists('microtime')) {
738         $PERF->starttime = microtime();
739     }
740     if (function_exists('memory_get_usage')) {
741         $PERF->startmemory = memory_get_usage();
742     }
743     if (function_exists('posix_times')) {
744         $PERF->startposixtimes = posix_times();
745     }
746     if (function_exists('apd_set_pprof_trace')) {
747         // APD profiling
748         if ($USER->id > 0 && $CFG->perfdebug >= 15) {
749             $tempdir = $CFG->dataroot . '/temp/profile/' . $USER->id;
750             mkdir($tempdir);
751             apd_set_pprof_trace($tempdir);
752             $PERF->profiling = true;
753         }
754     }
757 /**
758  * Indicates whether we are in the middle of the initial Moodle install.
759  *
760  * Very occasionally it is necessary avoid running certain bits of code before the
761  * Moodle installation has completed. The installed flag is set in admin/index.php
762  * after Moodle core and all the plugins have been installed, but just before
763  * the person doing the initial install is asked to choose the admin password.
764  *
765  * @return boolean true if the initial install is not complete.
766  */
767 function during_initial_install() {
768     global $CFG;
769     return empty($CFG->rolesactive);
772 /**
773  * Function to raise the memory limit to a new value.
774  * Will respect the memory limit if it is higher, thus allowing
775  * settings in php.ini, apache conf or command line switches
776  * to override it
777  *
778  * The memory limit should be expressed with a string (eg:'64M')
779  *
780  * @param string $newlimit the new memory limit
781  * @return bool
782  */
783 function raise_memory_limit($newlimit) {
785     if (empty($newlimit)) {
786         return false;
787     }
789     $cur = @ini_get('memory_limit');
790     if (empty($cur)) {
791         // if php is compiled without --enable-memory-limits
792         // apparently memory_limit is set to ''
793         $cur=0;
794     } else {
795         if ($cur == -1){
796             return true; // unlimited mem!
797         }
798       $cur = get_real_size($cur);
799     }
801     $new = get_real_size($newlimit);
802     if ($new > $cur) {
803         ini_set('memory_limit', $newlimit);
804         return true;
805     }
806     return false;
809 /**
810  * Function to reduce the memory limit to a new value.
811  * Will respect the memory limit if it is lower, thus allowing
812  * settings in php.ini, apache conf or command line switches
813  * to override it
814  *
815  * The memory limit should be expressed with a string (eg:'64M')
816  *
817  * @param string $newlimit the new memory limit
818  * @return bool
819  */
820 function reduce_memory_limit($newlimit) {
821     if (empty($newlimit)) {
822         return false;
823     }
824     $cur = @ini_get('memory_limit');
825     if (empty($cur)) {
826         // if php is compiled without --enable-memory-limits
827         // apparently memory_limit is set to ''
828         $cur=0;
829     } else {
830         if ($cur == -1){
831             return true; // unlimited mem!
832         }
833         $cur = get_real_size($cur);
834     }
836     $new = get_real_size($newlimit);
837     // -1 is smaller, but it means unlimited
838     if ($new < $cur && $new != -1) {
839         ini_set('memory_limit', $newlimit);
840         return true;
841     }
842     return false;
845 /**
846  * Converts numbers like 10M into bytes.
847  *
848  * @param mixed $size The size to be converted
849  * @return mixed
850  */
851 function get_real_size($size=0) {
852     if (!$size) {
853         return 0;
854     }
855     $scan = array();
856     $scan['MB'] = 1048576;
857     $scan['Mb'] = 1048576;
858     $scan['M'] = 1048576;
859     $scan['m'] = 1048576;
860     $scan['KB'] = 1024;
861     $scan['Kb'] = 1024;
862     $scan['K'] = 1024;
863     $scan['k'] = 1024;
865     while (list($key) = each($scan)) {
866         if ((strlen($size)>strlen($key))&&(substr($size, strlen($size) - strlen($key))==$key)) {
867             $size = substr($size, 0, strlen($size) - strlen($key)) * $scan[$key];
868             break;
869         }
870     }
871     return $size;
874 /**
875  * Check whether a major upgrade is needed. That is defined as an upgrade that
876  * changes something really fundamental in the database, so nothing can possibly
877  * work until the database has been updated, and that is defined by the hard-coded
878  * version number in this function.
879  */
880 function redirect_if_major_upgrade_required() {
881     global $CFG;
882     $lastmajordbchanges = 2010070300;
883     if (empty($CFG->version) or (int)$CFG->version < $lastmajordbchanges or
884             during_initial_install() or !empty($CFG->adminsetuppending)) {
885         try {
886             @session_get_instance()->terminate_current();
887         } catch (Exception $e) {
888             // Ignore any errors, redirect to upgrade anyway.
889         }
890         $url = $CFG->wwwroot . '/' . $CFG->admin . '/index.php';
891         @header($_SERVER['SERVER_PROTOCOL'] . ' 303 See Other');
892         @header('Location: ' . $url);
893         echo bootstrap_renderer::plain_redirect_message(htmlspecialchars($url));
894         exit;
895     }
898 /**
899  * Function to check if a directory exists and by default create it if not exists.
900  *
901  * Previously this was accepting paths only from dataroot, but we now allow
902  * files outside of dataroot if you supply custom paths for some settings in config.php.
903  * This function does not verify that the directory is writable.
904  *
905  * @param string $dir absolute directory path
906  * @param boolean $create directory if does not exist
907  * @param boolean $recursive create directory recursively
908  * @return boolean true if directory exists or created, false otherwise
909  */
910 function check_dir_exists($dir, $create = true, $recursive = true) {
911     global $CFG;
913     umask(0000); // just in case some evil code changed it
915     if (is_dir($dir)) {
916         return true;
917     }
919     if (!$create) {
920         return false;
921     }
923     return mkdir($dir, $CFG->directorypermissions, $recursive);
926 /**
927  * Create a directory in dataroot and make sure it is writable.
928  *
929  * @param string $directory  a string of directory names under $CFG->dataroot eg  temp/something
930  * @param bool $exceptiononerror throw exception if error encountered
931  * @return string|false Returns full path to directory if successful, false if not; may throw exception
932  */
933 function make_upload_directory($directory, $exceptiononerror = true) {
934     global $CFG;
936     // Make sure a .htaccess file is here, JUST IN CASE the files area is in the open and .htaccess is supported
937     if (!file_exists("$CFG->dataroot/.htaccess")) {
938         if ($handle = fopen("$CFG->dataroot/.htaccess", 'w')) {   // For safety
939             @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");
940             @fclose($handle);
941         }
942     }
944     $dir = "$CFG->dataroot/$directory";
946     if (file_exists($dir) and !is_dir($dir)) {
947         if ($exceptiononerror) {
948             throw new coding_exception($dir.' directory can not be created, file with the same name already exists.');
949         } else {
950             return false;
951         }
952     }
954     umask(0000); // just in case some evil code changed it
956     if (!file_exists($dir)) {
957         if (!mkdir($dir, $CFG->directorypermissions, true)) {
958             if ($exceptiononerror) {
959                 throw new invalid_dataroot_permissions($dir.' can not be created, check permissions.');
960             } else {
961                 return false;
962             }
963         }
964     }
966     if (!is_writable($dir)) {
967         if ($exceptiononerror) {
968             throw new invalid_dataroot_permissions($dir.' is not writable, check permissions.');
969         } else {
970             return false;
971         }
972     }
974     return $dir;
977 function init_memcached() {
978     global $CFG, $MCACHE;
980     include_once($CFG->libdir . '/memcached.class.php');
981     $MCACHE = new memcached;
982     if ($MCACHE->status()) {
983         return true;
984     }
985     unset($MCACHE);
986     return false;
989 function init_eaccelerator() {
990     global $CFG, $MCACHE;
992     include_once($CFG->libdir . '/eaccelerator.class.php');
993     $MCACHE = new eaccelerator;
994     if ($MCACHE->status()) {
995         return true;
996     }
997     unset($MCACHE);
998     return false;
1002 /**
1003  * This class solves the problem of how to initialise $OUTPUT.
1004  *
1005  * The problem is caused be two factors
1006  * <ol>
1007  * <li>On the one hand, we cannot be sure when output will start. In particular,
1008  * an error, which needs to be displayed, could be thrown at any time.</li>
1009  * <li>On the other hand, we cannot be sure when we will have all the information
1010  * necessary to correctly initialise $OUTPUT. $OUTPUT depends on the theme, which
1011  * (potentially) depends on the current course, course categories, and logged in user.
1012  * It also depends on whether the current page requires HTTPS.</li>
1013  * </ol>
1014  *
1015  * So, it is hard to find a single natural place during Moodle script execution,
1016  * which we can guarantee is the right time to initialise $OUTPUT. Instead we
1017  * adopt the following strategy
1018  * <ol>
1019  * <li>We will initialise $OUTPUT the first time it is used.</li>
1020  * <li>If, after $OUTPUT has been initialised, the script tries to change something
1021  * that $OUTPUT depends on, we throw an exception making it clear that the script
1022  * did something wrong.
1023  * </ol>
1024  *
1025  * The only problem with that is, how do we initialise $OUTPUT on first use if,
1026  * it is going to be used like $OUTPUT->somthing(...)? Well that is where this
1027  * class comes in. Initially, we set up $OUTPUT = new bootstrap_renderer(). Then,
1028  * when any method is called on that object, we initialise $OUTPUT, and pass the call on.
1029  *
1030  * Note that this class is used before lib/outputlib.php has been loaded, so we
1031  * must be careful referring to classes/functions from there, they may not be
1032  * defined yet, and we must avoid fatal errors.
1033  *
1034  * @copyright 2009 Tim Hunt
1035  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
1036  * @since     Moodle 2.0
1037  */
1038 class bootstrap_renderer {
1039     /**
1040      * Handles re-entrancy. Without this, errors or debugging output that occur
1041      * during the initialisation of $OUTPUT, cause infinite recursion.
1042      * @var boolean
1043      */
1044     protected $initialising = false;
1046     /**
1047      * Have we started output yet?
1048      * @return boolean true if the header has been printed.
1049      */
1050     public function has_started() {
1051         return false;
1052     }
1054     public function __call($method, $arguments) {
1055         global $OUTPUT, $PAGE;
1057         $recursing = false;
1058         if ($method == 'notification') {
1059             // Catch infinite recursion caused by debugging output during print_header.
1060             $backtrace = debug_backtrace();
1061             array_shift($backtrace);
1062             array_shift($backtrace);
1063             $recursing = is_early_init($backtrace);
1064         }
1066         $earlymethods = array(
1067             'fatal_error' => 'early_error',
1068             'notification' => 'early_notification',
1069         );
1071         // If lib/outputlib.php has been loaded, call it.
1072         if (!empty($PAGE) && !$recursing) {
1073             if (array_key_exists($method, $earlymethods)) {
1074                 //prevent PAGE->context warnings - exceptions might appear before we set any context
1075                 $PAGE->set_context(null);
1076             }
1077             $PAGE->initialise_theme_and_output();
1078             return call_user_func_array(array($OUTPUT, $method), $arguments);
1079         }
1081         $this->initialising = true;
1083         // Too soon to initialise $OUTPUT, provide a couple of key methods.
1084         if (array_key_exists($method, $earlymethods)) {
1085             return call_user_func_array(array('bootstrap_renderer', $earlymethods[$method]), $arguments);
1086         }
1088         throw new coding_exception('Attempt to start output before enough information is known to initialise the theme.');
1089     }
1091     /**
1092      * Returns nicely formatted error message in a div box.
1093      * @return string
1094      */
1095     public static function early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1096         global $CFG;
1098         $content = '<div style="margin-top: 6em; margin-left:auto; margin-right:auto; color:#990000; text-align:center; font-size:large; border-width:1px;
1099 border-color:black; background-color:#ffffee; border-style:solid; border-radius: 20px; border-collapse: collapse;
1100 width: 80%; -moz-border-radius: 20px; padding: 15px">
1101 ' . $message . '
1102 </div>';
1103         if (!empty($CFG->debug) && $CFG->debug >= DEBUG_DEVELOPER) {
1104             if (!empty($debuginfo)) {
1105                 $debuginfo = s($debuginfo); // removes all nasty JS
1106                 $debuginfo = str_replace("\n", '<br />', $debuginfo); // keep newlines
1107                 $content .= '<div class="notifytiny">Debug info: ' . $debuginfo . '</div>';
1108             }
1109             if (!empty($backtrace)) {
1110                 $content .= '<div class="notifytiny">Stack trace: ' . format_backtrace($backtrace, false) . '</div>';
1111             }
1112         }
1114         return $content;
1115     }
1117     /**
1118      * This function should only be called by this class, or from exception handlers
1119      * @return string
1120      */
1121     public static function early_error($message, $moreinfourl, $link, $backtrace, $debuginfo = null) {
1122         global $CFG;
1124         if (CLI_SCRIPT) {
1125             echo "!!! $message !!!\n";
1126             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1127                 if (!empty($debuginfo)) {
1128                     echo "\nDebug info: $debuginfo";
1129                 }
1130                 if (!empty($backtrace)) {
1131                     echo "\nStack trace: " . format_backtrace($backtrace, true);
1132                 }
1133             }
1134             return;
1136         } else if (AJAX_SCRIPT) {
1137             $e = new stdClass();
1138             $e->error      = $message;
1139             $e->stacktrace = NULL;
1140             $e->debuginfo  = NULL;
1141             if (!empty($CFG->debug) and $CFG->debug >= DEBUG_DEVELOPER) {
1142                 if (!empty($debuginfo)) {
1143                     $e->debuginfo = $debuginfo;
1144                 }
1145                 if (!empty($backtrace)) {
1146                     $e->stacktrace = format_backtrace($backtrace, true);
1147                 }
1148             }
1149             @header('Content-Type: application/json');
1150             echo json_encode($e);
1151             return;
1152         }
1154         // In the name of protocol correctness, monitoring and performance
1155         // profiling, set the appropriate error headers for machine consumption
1156         if (isset($_SERVER['SERVER_PROTOCOL'])) {
1157             // Avoid it with cron.php. Note that we assume it's HTTP/1.x
1158             // The 503 ode here means our Moodle does not work at all, the error happened too early
1159             @header($_SERVER['SERVER_PROTOCOL'] . ' 503 Service Unavailable');
1160         }
1162         // better disable any caching
1163         @header('Content-Type: text/html; charset=utf-8');
1164         @header('Cache-Control: no-store, no-cache, must-revalidate');
1165         @header('Cache-Control: post-check=0, pre-check=0', false);
1166         @header('Pragma: no-cache');
1167         @header('Expires: Mon, 20 Aug 1969 09:23:00 GMT');
1168         @header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
1170         if (function_exists('get_string')) {
1171             $strerror = get_string('error');
1172         } else {
1173             $strerror = 'Error';
1174         }
1176         $content = self::early_error_content($message, $moreinfourl, $link, $backtrace, $debuginfo);
1178         return self::plain_page($strerror, $content);
1179     }
1181     public static function early_notification($message, $classes = 'notifyproblem') {
1182         return '<div class="' . $classes . '">' . $message . '</div>';
1183     }
1185     public static function plain_redirect_message($encodedurl) {
1186         $message = '<p>' . get_string('pageshouldredirect') . '</p><p><a href="'.
1187                 $encodedurl .'">'. get_string('continue') .'</a></p>';
1188         return self::plain_page(get_string('redirect'), $message);
1189     }
1191     protected static function plain_page($title, $content) {
1192         if (function_exists('get_string') && function_exists('get_html_lang')) {
1193             $htmllang = get_html_lang();
1194         } else {
1195             $htmllang = '';
1196         }
1198         return '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
1199 <html xmlns="http://www.w3.org/1999/xhtml" ' . $htmllang . '>
1200 <head>
1201 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
1202 <title>' . $title . '</title>
1203 </head><body>' . $content . '</body></html>';
1204     }