Merge "libxml_disable_entity_loader() just in case..."
[lhc/web/wiklou.git] / includes / Exception.php
1 <?php
2 /**
3 * Exception class and handler.
4 *
5 * This program 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 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program 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 along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 /**
24 * @defgroup Exception Exception
25 */
26
27 /**
28 * MediaWiki exception
29 *
30 * @ingroup Exception
31 */
32 class MWException extends Exception {
33 var $logId;
34
35 /**
36 * Should the exception use $wgOut to output the error?
37 *
38 * @return bool
39 */
40 function useOutputPage() {
41 return $this->useMessageCache() &&
42 !empty( $GLOBALS['wgFullyInitialised'] ) &&
43 !empty( $GLOBALS['wgOut'] ) &&
44 !empty( $GLOBALS['wgTitle'] );
45 }
46
47 /**
48 * Can the extension use the Message class/wfMessage to get i18n-ed messages?
49 *
50 * @return bool
51 */
52 function useMessageCache() {
53 global $wgLang;
54
55 foreach ( $this->getTrace() as $frame ) {
56 if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
57 return false;
58 }
59 }
60
61 return $wgLang instanceof Language;
62 }
63
64 /**
65 * Run hook to allow extensions to modify the text of the exception
66 *
67 * @param string $name class name of the exception
68 * @param array $args arguments to pass to the callback functions
69 * @return string|null string to output or null if any hook has been called
70 */
71 function runHooks( $name, $args = array() ) {
72 global $wgExceptionHooks;
73
74 if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
75 return null; // Just silently ignore
76 }
77
78 if ( !array_key_exists( $name, $wgExceptionHooks ) || !is_array( $wgExceptionHooks[$name] ) ) {
79 return null;
80 }
81
82 $hooks = $wgExceptionHooks[$name];
83 $callargs = array_merge( array( $this ), $args );
84
85 foreach ( $hooks as $hook ) {
86 if ( is_string( $hook ) || ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) ) ) { // 'function' or array( 'class', hook' )
87 $result = call_user_func_array( $hook, $callargs );
88 } else {
89 $result = null;
90 }
91
92 if ( is_string( $result ) ) {
93 return $result;
94 }
95 }
96 return null;
97 }
98
99 /**
100 * Get a message from i18n
101 *
102 * @param string $key message name
103 * @param string $fallback default message if the message cache can't be
104 * called by the exception
105 * The function also has other parameters that are arguments for the message
106 * @return string message with arguments replaced
107 */
108 function msg( $key, $fallback /*[, params...] */ ) {
109 $args = array_slice( func_get_args(), 2 );
110
111 if ( $this->useMessageCache() ) {
112 return wfMessage( $key, $args )->plain();
113 } else {
114 return wfMsgReplaceArgs( $fallback, $args );
115 }
116 }
117
118 /**
119 * If $wgShowExceptionDetails is true, return a HTML message with a
120 * backtrace to the error, otherwise show a message to ask to set it to true
121 * to show that information.
122 *
123 * @return string html to output
124 */
125 function getHTML() {
126 global $wgShowExceptionDetails;
127
128 if ( $wgShowExceptionDetails ) {
129 return '<p>' . nl2br( htmlspecialchars( $this->getMessage() ) ) .
130 '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( MWExceptionHandler::formatRedactedTrace( $this ) ) ) .
131 "</p>\n";
132 } else {
133 return "<div class=\"errorbox\">" .
134 '[' . $this->getLogId() . '] ' .
135 gmdate( 'Y-m-d H:i:s' ) .
136 ": Fatal exception of type " . get_class( $this ) . "</div>\n" .
137 "<!-- Set \$wgShowExceptionDetails = true; " .
138 "at the bottom of LocalSettings.php to show detailed " .
139 "debugging information. -->";
140 }
141 }
142
143 /**
144 * Get the text to display when reporting the error on the command line.
145 * If $wgShowExceptionDetails is true, return a text message with a
146 * backtrace to the error.
147 *
148 * @return string
149 */
150 function getText() {
151 global $wgShowExceptionDetails;
152
153 if ( $wgShowExceptionDetails ) {
154 return $this->getMessage() .
155 "\nBacktrace:\n" . MWExceptionHandler::formatRedactedTrace( $this ) . "\n";
156 } else {
157 return "Set \$wgShowExceptionDetails = true; " .
158 "in LocalSettings.php to show detailed debugging information.\n";
159 }
160 }
161
162 /**
163 * Return the title of the page when reporting this error in a HTTP response.
164 *
165 * @return string
166 */
167 function getPageTitle() {
168 return $this->msg( 'internalerror', "Internal error" );
169 }
170
171 /**
172 * Get a random ID for this error.
173 * This allows to link the exception to its corresponding log entry when
174 * $wgShowExceptionDetails is set to false.
175 *
176 * @return string
177 */
178 function getLogId() {
179 if ( $this->logId === null ) {
180 $this->logId = wfRandomString( 8 );
181 }
182 return $this->logId;
183 }
184
185 /**
186 * Return the requested URL and point to file and line number from which the
187 * exception occurred
188 *
189 * @return string
190 */
191 function getLogMessage() {
192 global $wgRequest;
193
194 $id = $this->getLogId();
195 $file = $this->getFile();
196 $line = $this->getLine();
197 $message = $this->getMessage();
198
199 if ( isset( $wgRequest ) && !$wgRequest instanceof FauxRequest ) {
200 $url = $wgRequest->getRequestURL();
201 if ( !$url ) {
202 $url = '[no URL]';
203 }
204 } else {
205 $url = '[no req]';
206 }
207
208 return "[$id] $url Exception from line $line of $file: $message";
209 }
210
211 /**
212 * Output the exception report using HTML.
213 */
214 function reportHTML() {
215 global $wgOut;
216 if ( $this->useOutputPage() ) {
217 $wgOut->prepareErrorPage( $this->getPageTitle() );
218
219 $hookResult = $this->runHooks( get_class( $this ) );
220 if ( $hookResult ) {
221 $wgOut->addHTML( $hookResult );
222 } else {
223 $wgOut->addHTML( $this->getHTML() );
224 }
225
226 $wgOut->output();
227 } else {
228 header( "Content-Type: text/html; charset=utf-8" );
229 echo "<!doctype html>\n" .
230 '<html><head>' .
231 '<title>' . htmlspecialchars( $this->getPageTitle() ) . '</title>' .
232 "</head><body>\n";
233
234 $hookResult = $this->runHooks( get_class( $this ) . "Raw" );
235 if ( $hookResult ) {
236 echo $hookResult;
237 } else {
238 echo $this->getHTML();
239 }
240
241 echo "</body></html>\n";
242 }
243 }
244
245 /**
246 * Output a report about the exception and takes care of formatting.
247 * It will be either HTML or plain text based on isCommandLine().
248 */
249 function report() {
250 global $wgMimeType;
251
252 $this->logException();
253
254 if ( defined( 'MW_API' ) ) {
255 // Unhandled API exception, we can't be sure that format printer is alive
256 header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
257 wfHttpError( 500, 'Internal Server Error', $this->getText() );
258 } elseif ( self::isCommandLine() ) {
259 MWExceptionHandler::printError( $this->getText() );
260 } else {
261 header( "HTTP/1.1 500 MediaWiki exception" );
262 header( "Status: 500 MediaWiki exception", true );
263 header( "Content-Type: $wgMimeType; charset=utf-8", true );
264
265 $this->reportHTML();
266 }
267 }
268
269 /**
270 * Log the error message to the exception log (if enabled)
271 */
272 function logException() {
273 global $wgLogExceptionBacktrace;
274
275 $log = $this->getLogMessage();
276 if ( $log ) {
277 if ( $wgLogExceptionBacktrace ) {
278 wfDebugLog( 'exception', $log . "\n" . MWExceptionHandler::formatRedactedTrace( $this ) . "\n" );
279 } else {
280 wfDebugLog( 'exception', $log );
281 }
282 }
283 }
284
285 /**
286 * Check whether we are in command line mode or not to report the exception
287 * in the correct format.
288 *
289 * @return bool
290 */
291 static function isCommandLine() {
292 return !empty( $GLOBALS['wgCommandLineMode'] );
293 }
294 }
295
296 /**
297 * Exception class which takes an HTML error message, and does not
298 * produce a backtrace. Replacement for OutputPage::fatalError().
299 *
300 * @since 1.7
301 * @ingroup Exception
302 */
303 class FatalError extends MWException {
304
305 /**
306 * @return string
307 */
308 function getHTML() {
309 return $this->getMessage();
310 }
311
312 /**
313 * @return string
314 */
315 function getText() {
316 return $this->getMessage();
317 }
318 }
319
320 /**
321 * An error page which can definitely be safely rendered using the OutputPage.
322 *
323 * @since 1.7
324 * @ingroup Exception
325 */
326 class ErrorPageError extends MWException {
327 public $title, $msg, $params;
328
329 /**
330 * Note: these arguments are keys into wfMessage(), not text!
331 *
332 * @param string|Message $title Message key (string) for page title, or a Message object
333 * @param string|Message $msg Message key (string) for error text, or a Message object
334 * @param array $params with parameters to wfMessage()
335 */
336 function __construct( $title, $msg, $params = null ) {
337 $this->title = $title;
338 $this->msg = $msg;
339 $this->params = $params;
340
341 // Bug 44111: Messages in the log files should be in English and not
342 // customized by the local wiki. So get the default English version for
343 // passing to the parent constructor. Our overridden report() below
344 // makes sure that the page shown to the user is not forced to English.
345 if ( $msg instanceof Message ) {
346 $enMsg = clone( $msg );
347 } else {
348 $enMsg = wfMessage( $msg, $params );
349 }
350 $enMsg->inLanguage( 'en' )->useDatabase( false );
351 parent::__construct( $enMsg->text() );
352 }
353
354 function report() {
355 global $wgOut;
356
357 $wgOut->showErrorPage( $this->title, $this->msg, $this->params );
358 $wgOut->output();
359 }
360 }
361
362 /**
363 * Show an error page on a badtitle.
364 * Similar to ErrorPage, but emit a 400 HTTP error code to let mobile
365 * browser it is not really a valid content.
366 *
367 * @since 1.19
368 * @ingroup Exception
369 */
370 class BadTitleError extends ErrorPageError {
371 /**
372 * @param string|Message $msg A message key (default: 'badtitletext')
373 * @param array $params parameter to wfMessage()
374 */
375 function __construct( $msg = 'badtitletext', $params = null ) {
376 parent::__construct( 'badtitle', $msg, $params );
377 }
378
379 /**
380 * Just like ErrorPageError::report() but additionally set
381 * a 400 HTTP status code (bug 33646).
382 */
383 function report() {
384 global $wgOut;
385
386 // bug 33646: a badtitle error page need to return an error code
387 // to let mobile browser now that it is not a normal page.
388 $wgOut->setStatusCode( 400 );
389 parent::report();
390 }
391
392 }
393
394 /**
395 * Show an error when a user tries to do something they do not have the necessary
396 * permissions for.
397 *
398 * @since 1.18
399 * @ingroup Exception
400 */
401 class PermissionsError extends ErrorPageError {
402 public $permission, $errors;
403
404 function __construct( $permission, $errors = array() ) {
405 global $wgLang;
406
407 $this->permission = $permission;
408
409 if ( !count( $errors ) ) {
410 $groups = array_map(
411 array( 'User', 'makeGroupLinkWiki' ),
412 User::getGroupsWithPermission( $this->permission )
413 );
414
415 if ( $groups ) {
416 $errors[] = array( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
417 } else {
418 $errors[] = array( 'badaccess-group0' );
419 }
420 }
421
422 $this->errors = $errors;
423 }
424
425 function report() {
426 global $wgOut;
427
428 $wgOut->showPermissionsErrorPage( $this->errors, $this->permission );
429 $wgOut->output();
430 }
431 }
432
433 /**
434 * Show an error when the wiki is locked/read-only and the user tries to do
435 * something that requires write access.
436 *
437 * @since 1.18
438 * @ingroup Exception
439 */
440 class ReadOnlyError extends ErrorPageError {
441 public function __construct() {
442 parent::__construct(
443 'readonly',
444 'readonlytext',
445 wfReadOnlyReason()
446 );
447 }
448 }
449
450 /**
451 * Show an error when the user hits a rate limit.
452 *
453 * @since 1.18
454 * @ingroup Exception
455 */
456 class ThrottledError extends ErrorPageError {
457 public function __construct() {
458 parent::__construct(
459 'actionthrottled',
460 'actionthrottledtext'
461 );
462 }
463
464 public function report() {
465 global $wgOut;
466 $wgOut->setStatusCode( 503 );
467 parent::report();
468 }
469 }
470
471 /**
472 * Show an error when the user tries to do something whilst blocked.
473 *
474 * @since 1.18
475 * @ingroup Exception
476 */
477 class UserBlockedError extends ErrorPageError {
478 public function __construct( Block $block ) {
479 // @todo FIXME: Implement a more proper way to get context here.
480 $params = $block->getPermissionsError( RequestContext::getMain() );
481 parent::__construct( 'blockedtitle', array_shift( $params ), $params );
482 }
483 }
484
485 /**
486 * Shows a generic "user is not logged in" error page.
487 *
488 * This is essentially an ErrorPageError exception which by default uses the
489 * 'exception-nologin' as a title and 'exception-nologin-text' for the message.
490 * @see bug 37627
491 * @since 1.20
492 *
493 * @par Example:
494 * @code
495 * if( $user->isAnon() ) {
496 * throw new UserNotLoggedIn();
497 * }
498 * @endcode
499 *
500 * Note the parameter order differs from ErrorPageError, this allows you to
501 * simply specify a reason without overriding the default title.
502 *
503 * @par Example:
504 * @code
505 * if( $user->isAnon() ) {
506 * throw new UserNotLoggedIn( 'action-require-loggedin' );
507 * }
508 * @endcode
509 *
510 * @ingroup Exception
511 */
512 class UserNotLoggedIn extends ErrorPageError {
513
514 /**
515 * @param $reasonMsg A message key containing the reason for the error.
516 * Optional, default: 'exception-nologin-text'
517 * @param $titleMsg A message key to set the page title.
518 * Optional, default: 'exception-nologin'
519 * @param $params Parameters to wfMessage().
520 * Optional, default: null
521 */
522 public function __construct(
523 $reasonMsg = 'exception-nologin-text',
524 $titleMsg = 'exception-nologin',
525 $params = null
526 ) {
527 parent::__construct( $titleMsg, $reasonMsg, $params );
528 }
529 }
530
531 /**
532 * Show an error that looks like an HTTP server error.
533 * Replacement for wfHttpError().
534 *
535 * @since 1.19
536 * @ingroup Exception
537 */
538 class HttpError extends MWException {
539 private $httpCode, $header, $content;
540
541 /**
542 * Constructor
543 *
544 * @param $httpCode Integer: HTTP status code to send to the client
545 * @param string|Message $content content of the message
546 * @param string|Message $header content of the header (\<title\> and \<h1\>)
547 */
548 public function __construct( $httpCode, $content, $header = null ) {
549 parent::__construct( $content );
550 $this->httpCode = (int)$httpCode;
551 $this->header = $header;
552 $this->content = $content;
553 }
554
555 /**
556 * Returns the HTTP status code supplied to the constructor.
557 *
558 * @return int
559 */
560 public function getStatusCode() {
561 return $this->httpCode;
562 }
563
564 /**
565 * Report the HTTP error.
566 * Sends the appropriate HTTP status code and outputs an
567 * HTML page with an error message.
568 */
569 public function report() {
570 $httpMessage = HttpStatus::getMessage( $this->httpCode );
571
572 header( "Status: {$this->httpCode} {$httpMessage}", true, $this->httpCode );
573 header( 'Content-type: text/html; charset=utf-8' );
574
575 print $this->getHTML();
576 }
577
578 /**
579 * Returns HTML for reporting the HTTP error.
580 * This will be a minimal but complete HTML document.
581 *
582 * @return string HTML
583 */
584 public function getHTML() {
585 if ( $this->header === null ) {
586 $header = HttpStatus::getMessage( $this->httpCode );
587 } elseif ( $this->header instanceof Message ) {
588 $header = $this->header->escaped();
589 } else {
590 $header = htmlspecialchars( $this->header );
591 }
592
593 if ( $this->content instanceof Message ) {
594 $content = $this->content->escaped();
595 } else {
596 $content = htmlspecialchars( $this->content );
597 }
598
599 return "<!DOCTYPE html>\n" .
600 "<html><head><title>$header</title></head>\n" .
601 "<body><h1>$header</h1><p>$content</p></body></html>\n";
602 }
603 }
604
605 /**
606 * Handler class for MWExceptions
607 * @ingroup Exception
608 */
609 class MWExceptionHandler {
610 /**
611 * Install an exception handler for MediaWiki exception types.
612 */
613 public static function installHandler() {
614 set_exception_handler( array( 'MWExceptionHandler', 'handle' ) );
615 }
616
617 /**
618 * Report an exception to the user
619 */
620 protected static function report( Exception $e ) {
621 global $wgShowExceptionDetails;
622
623 $cmdLine = MWException::isCommandLine();
624
625 if ( $e instanceof MWException ) {
626 try {
627 // Try and show the exception prettily, with the normal skin infrastructure
628 $e->report();
629 } catch ( Exception $e2 ) {
630 // Exception occurred from within exception handler
631 // Show a simpler error message for the original exception,
632 // don't try to invoke report()
633 $message = "MediaWiki internal error.\n\n";
634
635 if ( $wgShowExceptionDetails ) {
636 $message .= 'Original exception: ' . self::formatRedactedTrace( $e ) . "\n\n" .
637 'Exception caught inside exception handler: ' . $e2->__toString();
638 } else {
639 $message .= "Exception caught inside exception handler.\n\n" .
640 "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
641 "to show detailed debugging information.";
642 }
643
644 $message .= "\n";
645
646 if ( $cmdLine ) {
647 self::printError( $message );
648 } else {
649 echo nl2br( htmlspecialchars( $message ) ) . "\n";
650 }
651 }
652 } else {
653 $message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"";
654
655 if ( $wgShowExceptionDetails ) {
656 $message .= "\nexception '" . get_class( $e ) . "' in " . $e->getFile() . ":" . $e->getLine() . "\nStack trace:\n" . self::formatRedactedTrace( $e ) . "\n";
657 }
658
659 if ( $cmdLine ) {
660 self::printError( $message );
661 } else {
662 echo nl2br( htmlspecialchars( $message ) ) . "\n";
663 }
664 }
665 }
666
667 /**
668 * Print a message, if possible to STDERR.
669 * Use this in command line mode only (see isCommandLine)
670 *
671 * @param string $message Failure text
672 */
673 public static function printError( $message ) {
674 # NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
675 # Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
676 if ( defined( 'STDERR' ) ) {
677 fwrite( STDERR, $message );
678 } else {
679 echo $message;
680 }
681 }
682
683 /**
684 * Exception handler which simulates the appropriate catch() handling:
685 *
686 * try {
687 * ...
688 * } catch ( MWException $e ) {
689 * $e->report();
690 * } catch ( Exception $e ) {
691 * echo $e->__toString();
692 * }
693 */
694 public static function handle( $e ) {
695 global $wgFullyInitialised;
696
697 self::report( $e );
698
699 // Final cleanup
700 if ( $wgFullyInitialised ) {
701 try {
702 // uses $wgRequest, hence the $wgFullyInitialised condition
703 wfLogProfilingData();
704 } catch ( Exception $e ) {
705 }
706 }
707
708 // Exit value should be nonzero for the benefit of shell jobs
709 exit( 1 );
710 }
711
712 /**
713 * Get the stack trace from the exception as a string, redacting certain function arguments in the process
714 * @param Exception $e The exception
715 * @return string The stack trace as a string
716 */
717 public static function formatRedactedTrace( Exception $e ) {
718 global $wgRedactedFunctionArguments;
719 $finalExceptionText = '';
720
721 foreach ( $e->getTrace() as $i => $call ) {
722 $checkFor = array();
723 if ( isset( $call['class'] ) ) {
724 $checkFor[] = $call['class'] . '::' . $call['function'];
725 foreach ( class_parents( $call['class'] ) as $parent ) {
726 $checkFor[] = $parent . '::' . $call['function'];
727 }
728 } else {
729 $checkFor[] = $call['function'];
730 }
731
732 foreach ( $checkFor as $check ) {
733 if ( isset( $wgRedactedFunctionArguments[$check] ) ) {
734 foreach ( (array)$wgRedactedFunctionArguments[$check] as $argNo ) {
735 $call['args'][$argNo] = 'REDACTED';
736 }
737 }
738 }
739
740 $finalExceptionText .= "#{$i} {$call['file']}({$call['line']}): ";
741 if ( isset( $call['class'] ) ) {
742 $finalExceptionText .= $call['class'] . $call['type'] . $call['function'];
743 } else {
744 $finalExceptionText .= $call['function'];
745 }
746 $args = array();
747 foreach ( $call['args'] as $arg ) {
748 if ( is_object( $arg ) ) {
749 $args[] = 'Object(' . get_class( $arg ) . ')';
750 } elseif( is_array( $arg ) ) {
751 $args[] = 'Array';
752 } else {
753 $args[] = var_export( $arg, true );
754 }
755 }
756 $finalExceptionText .= '(' . implode( ', ', $args ) . ")\n";
757 }
758 return $finalExceptionText . '#' . ( $i + 1 ) . ' {main}';
759 }
760 }