3 * Exception class and handler.
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.
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.
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
24 * @defgroup Exception Exception
32 class MWException
extends Exception
{
36 * Should the exception use $wgOut to output the error?
40 function useOutputPage() {
41 return $this->useMessageCache() &&
42 !empty( $GLOBALS['wgFullyInitialised'] ) &&
43 !empty( $GLOBALS['wgOut'] ) &&
44 !empty( $GLOBALS['wgTitle'] );
48 * Can the extension use the Message class/wfMessage to get i18n-ed messages?
52 function useMessageCache() {
55 foreach ( $this->getTrace() as $frame ) {
56 if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
61 return $wgLang instanceof Language
;
65 * Run hook to allow extensions to modify the text of the exception
67 * @param $name string: class name of the exception
68 * @param $args array: arguments to pass to the callback functions
69 * @return string|null string to output or null if any hook has been called
71 function runHooks( $name, $args = array() ) {
72 global $wgExceptionHooks;
74 if ( !isset( $wgExceptionHooks ) ||
!is_array( $wgExceptionHooks ) ) {
75 return null; // Just silently ignore
78 if ( !array_key_exists( $name, $wgExceptionHooks ) ||
!is_array( $wgExceptionHooks[ $name ] ) ) {
82 $hooks = $wgExceptionHooks[ $name ];
83 $callargs = array_merge( array( $this ), $args );
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 );
92 if ( is_string( $result ) ) {
100 * Get a message from i18n
102 * @param $key string: message name
103 * @param $fallback string: 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
108 function msg( $key, $fallback /*[, params...] */ ) {
109 $args = array_slice( func_get_args(), 2 );
111 if ( $this->useMessageCache() ) {
112 return wfMessage( $key, $args )->plain();
114 return wfMsgReplaceArgs( $fallback, $args );
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.
123 * @return string html to output
126 global $wgShowExceptionDetails;
128 if ( $wgShowExceptionDetails ) {
129 return '<p>' . nl2br( htmlspecialchars( $this->getMessage() ) ) .
130 '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) ) .
134 "<div class=\"errorbox\">" .
135 '[' . $this->getLogId() . '] ' .
136 gmdate( 'Y-m-d H:i:s' ) .
137 ": Fatal exception of type " . get_class( $this ) . "</div>\n" .
138 "<!-- Set \$wgShowExceptionDetails = true; " .
139 "at the bottom of LocalSettings.php to show detailed " .
140 "debugging information. -->";
145 * Get the text to display when reporting the error on the command line.
146 * If $wgShowExceptionDetails is true, return a text message with a
147 * backtrace to the error.
152 global $wgShowExceptionDetails;
154 if ( $wgShowExceptionDetails ) {
155 return $this->getMessage() .
156 "\nBacktrace:\n" . $this->getTraceAsString() . "\n";
158 return "Set \$wgShowExceptionDetails = true; " .
159 "in LocalSettings.php to show detailed debugging information.\n";
164 * Return the title of the page when reporting this error in a HTTP response.
168 function getPageTitle() {
169 return $this->msg( 'internalerror', "Internal error" );
173 * Get a random ID for this error.
174 * This allows to link the exception to its correspoding log entry when
175 * $wgShowExceptionDetails is set to false.
179 function getLogId() {
180 if ( $this->logId
=== null ) {
181 $this->logId
= wfRandomString( 8 );
187 * Return the requested URL and point to file and line number from which the
192 function getLogMessage() {
195 $id = $this->getLogId();
196 $file = $this->getFile();
197 $line = $this->getLine();
198 $message = $this->getMessage();
200 if ( isset( $wgRequest ) && !$wgRequest instanceof FauxRequest
) {
201 $url = $wgRequest->getRequestURL();
209 return "[$id] $url Exception from line $line of $file: $message";
213 * Output the exception report using HTML.
215 function reportHTML() {
217 if ( $this->useOutputPage() ) {
218 $wgOut->prepareErrorPage( $this->getPageTitle() );
220 $hookResult = $this->runHooks( get_class( $this ) );
222 $wgOut->addHTML( $hookResult );
224 $wgOut->addHTML( $this->getHTML() );
229 header( "Content-Type: text/html; charset=utf-8" );
230 echo "<!doctype html>\n" .
232 '<title>' . htmlspecialchars( $this->getPageTitle() ) . '</title>' .
235 $hookResult = $this->runHooks( get_class( $this ) . "Raw" );
239 echo $this->getHTML();
242 echo "</body></html>\n";
248 * Output a report about the exception and takes care of formatting.
249 * It will be either HTML or plain text based on isCommandLine().
252 global $wgLogExceptionBacktrace;
253 $log = $this->getLogMessage();
256 if ( $wgLogExceptionBacktrace ) {
257 wfDebugLog( 'exception', $log . "\n" . $this->getTraceAsString() . "\n" );
259 wfDebugLog( 'exception', $log );
263 if ( defined( 'MW_API' ) ) {
264 // Unhandled API exception, we can't be sure that format printer is alive
265 header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
266 wfHttpError(500, 'Internal Server Error', $this->getText() );
267 } elseif ( self
::isCommandLine() ) {
268 MWExceptionHandler
::printError( $this->getText() );
270 header( "HTTP/1.1 500 MediaWiki exception" );
271 header( "Status: 500 MediaWiki exception", true );
278 * Check whether we are in command line mode or not to report the exception
279 * in the correct format.
283 static function isCommandLine() {
284 return !empty( $GLOBALS['wgCommandLineMode'] );
289 * Exception class which takes an HTML error message, and does not
290 * produce a backtrace. Replacement for OutputPage::fatalError().
295 class FatalError
extends MWException
{
301 return $this->getMessage();
308 return $this->getMessage();
313 * An error page which can definitely be safely rendered using the OutputPage.
318 class ErrorPageError
extends MWException
{
319 public $title, $msg, $params;
322 * Note: these arguments are keys into wfMessage(), not text!
324 * @param $title string|Message Message key (string) for page title, or a Message object
325 * @param $msg string|Message Message key (string) for error text, or a Message object
326 * @param $params array with parameters to wfMessage()
328 function __construct( $title, $msg, $params = null ) {
329 $this->title
= $title;
331 $this->params
= $params;
333 if( $msg instanceof Message
){
334 parent
::__construct( $msg );
336 parent
::__construct( wfMessage( $msg )->text() );
343 $wgOut->showErrorPage( $this->title
, $this->msg
, $this->params
);
349 * Show an error page on a badtitle.
350 * Similar to ErrorPage, but emit a 400 HTTP error code to let mobile
351 * browser it is not really a valid content.
356 class BadTitleError
extends ErrorPageError
{
358 * @param $msg string|Message A message key (default: 'badtitletext')
359 * @param $params Array parameter to wfMessage()
361 function __construct( $msg = 'badtitletext', $params = null ) {
362 parent
::__construct( 'badtitle', $msg, $params );
366 * Just like ErrorPageError::report() but additionally set
367 * a 400 HTTP status code (bug 33646).
372 // bug 33646: a badtitle error page need to return an error code
373 // to let mobile browser now that it is not a normal page.
374 $wgOut->setStatusCode( 400 );
381 * Show an error when a user tries to do something they do not have the necessary
387 class PermissionsError
extends ErrorPageError
{
388 public $permission, $errors;
390 function __construct( $permission, $errors = array() ) {
393 $this->permission
= $permission;
395 if ( !count( $errors ) ) {
397 array( 'User', 'makeGroupLinkWiki' ),
398 User
::getGroupsWithPermission( $this->permission
)
402 $errors[] = array( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
404 $errors[] = array( 'badaccess-group0' );
408 $this->errors
= $errors;
414 $wgOut->showPermissionsErrorPage( $this->errors
, $this->permission
);
420 * Show an error when the wiki is locked/read-only and the user tries to do
421 * something that requires write access.
426 class ReadOnlyError
extends ErrorPageError
{
427 public function __construct(){
437 * Show an error when the user hits a rate limit.
442 class ThrottledError
extends ErrorPageError
{
443 public function __construct(){
446 'actionthrottledtext'
450 public function report(){
452 $wgOut->setStatusCode( 503 );
458 * Show an error when the user tries to do something whilst blocked.
463 class UserBlockedError
extends ErrorPageError
{
464 public function __construct( Block
$block ){
465 global $wgLang, $wgRequest;
467 $blocker = $block->getBlocker();
468 if ( $blocker instanceof User
) { // local user
469 $blockerUserpage = $block->getBlocker()->getUserPage();
470 $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
471 } else { // foreign user
475 $reason = $block->mReason
;
476 if( $reason == '' ) {
477 $reason = wfMessage( 'blockednoreason' )->text();
480 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
481 * This could be a username, an IP range, or a single IP. */
482 $intended = $block->getTarget();
486 $block->mAuto ?
'autoblockedtext' : 'blockedtext',
493 $wgLang->formatExpiry( $block->mExpiry
),
495 $wgLang->timeanddate( wfTimestamp( TS_MW
, $block->mTimestamp
), true )
502 * Shows a generic "user is not logged in" error page.
504 * This is essentially an ErrorPageError exception which by default use the
505 * 'exception-nologin' as a title and 'exception-nologin-text' for the message.
511 * if( $user->isAnon ) {
512 * throw new UserNotLoggedIn();
516 * Please note the parameters are mixed up compared to ErrorPageError, this
517 * is done to be able to simply specify a reason whitout overriding the default
522 * if( $user->isAnon ) {
523 * throw new UserNotLoggedIn( 'action-require-loggedin' );
529 class UserNotLoggedIn
extends ErrorPageError
{
532 * @param $reasonMsg A message key containing the reason for the error.
533 * Optional, default: 'exception-nologin-text'
534 * @param $titleMsg A message key to set the page title.
535 * Optional, default: 'exception-nologin'
536 * @param $params Parameters to wfMessage().
537 * Optiona, default: null
539 public function __construct(
540 $reasonMsg = 'exception-nologin-text',
541 $titleMsg = 'exception-nologin',
544 parent
::__construct( $titleMsg, $reasonMsg, $params );
549 * Show an error that looks like an HTTP server error.
550 * Replacement for wfHttpError().
555 class HttpError
extends MWException
{
556 private $httpCode, $header, $content;
561 * @param $httpCode Integer: HTTP status code to send to the client
562 * @param $content String|Message: content of the message
563 * @param $header String|Message: content of the header (\<title\> and \<h1\>)
565 public function __construct( $httpCode, $content, $header = null ){
566 parent
::__construct( $content );
567 $this->httpCode
= (int)$httpCode;
568 $this->header
= $header;
569 $this->content
= $content;
572 public function report() {
573 $httpMessage = HttpStatus
::getMessage( $this->httpCode
);
575 header( "Status: {$this->httpCode} {$httpMessage}" );
576 header( 'Content-type: text/html; charset=utf-8' );
578 if ( $this->header
=== null ) {
579 $header = $httpMessage;
580 } elseif ( $this->header
instanceof Message
) {
581 $header = $this->header
->escaped();
583 $header = htmlspecialchars( $this->header
);
586 if ( $this->content
instanceof Message
) {
587 $content = $this->content
->escaped();
589 $content = htmlspecialchars( $this->content
);
592 print "<!DOCTYPE html>\n".
593 "<html><head><title>$header</title></head>\n" .
594 "<body><h1>$header</h1><p>$content</p></body></html>\n";
599 * Handler class for MWExceptions
602 class MWExceptionHandler
{
604 * Install an exception handler for MediaWiki exception types.
606 public static function installHandler() {
607 set_exception_handler( array( 'MWExceptionHandler', 'handle' ) );
611 * Report an exception to the user
613 protected static function report( Exception
$e ) {
614 global $wgShowExceptionDetails;
616 $cmdLine = MWException
::isCommandLine();
618 if ( $e instanceof MWException
) {
620 // Try and show the exception prettily, with the normal skin infrastructure
622 } catch ( Exception
$e2 ) {
623 // Exception occurred from within exception handler
624 // Show a simpler error message for the original exception,
625 // don't try to invoke report()
626 $message = "MediaWiki internal error.\n\n";
628 if ( $wgShowExceptionDetails ) {
629 $message .= 'Original exception: ' . $e->__toString() . "\n\n" .
630 'Exception caught inside exception handler: ' . $e2->__toString();
632 $message .= "Exception caught inside exception handler.\n\n" .
633 "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
634 "to show detailed debugging information.";
640 self
::printError( $message );
642 self
::escapeEchoAndDie( $message );
646 $message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"\n" .
647 $e->__toString() . "\n";
649 if ( $wgShowExceptionDetails ) {
650 $message .= "\n" . $e->getTraceAsString() . "\n";
654 self
::printError( $message );
656 self
::escapeEchoAndDie( $message );
662 * Print a message, if possible to STDERR.
663 * Use this in command line mode only (see isCommandLine)
665 * @param $message string Failure text
667 public static function printError( $message ) {
668 # NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
669 # Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
670 if ( defined( 'STDERR' ) ) {
671 fwrite( STDERR
, $message );
678 * Print a message after escaping it and converting newlines to <br>
679 * Use this for non-command line failures.
681 * @param $message string Failure text
683 private static function escapeEchoAndDie( $message ) {
684 echo nl2br( htmlspecialchars( $message ) ) . "\n";
689 * Exception handler which simulates the appropriate catch() handling:
693 * } catch ( MWException $e ) {
695 * } catch ( Exception $e ) {
696 * echo $e->__toString();
699 public static function handle( $e ) {
700 global $wgFullyInitialised;
705 if ( $wgFullyInitialised ) {
707 wfLogProfilingData(); // uses $wgRequest, hence the $wgFullyInitialised condition
708 } catch ( Exception
$e ) {}
711 // Exit value should be nonzero for the benefit of shell jobs