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