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