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 ?
39 function useOutputPage() {
40 return $this->useMessageCache() &&
41 !empty( $GLOBALS['wgFullyInitialised'] ) &&
42 !empty( $GLOBALS['wgOut'] ) &&
43 !empty( $GLOBALS['wgTitle'] );
47 * Can the extension use wfMsg() to get i18n messages ?
50 function useMessageCache() {
53 foreach ( $this->getTrace() as $frame ) {
54 if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
59 return $wgLang instanceof Language
;
63 * Run hook to allow extensions to modify the text of the exception
65 * @param $name String: class name of the exception
66 * @param $args Array: arguments to pass to the callback functions
67 * @return Mixed: string to output or null if any hook has been called
69 function runHooks( $name, $args = array() ) {
70 global $wgExceptionHooks;
72 if ( !isset( $wgExceptionHooks ) ||
!is_array( $wgExceptionHooks ) ) {
73 return null; // Just silently ignore
76 if ( !array_key_exists( $name, $wgExceptionHooks ) ||
!is_array( $wgExceptionHooks[ $name ] ) ) {
80 $hooks = $wgExceptionHooks[ $name ];
81 $callargs = array_merge( array( $this ), $args );
83 foreach ( $hooks as $hook ) {
84 if ( is_string( $hook ) ||
( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) ) ) { // 'function' or array( 'class', hook' )
85 $result = call_user_func_array( $hook, $callargs );
90 if ( is_string( $result ) ) {
98 * Get a message from i18n
100 * @param $key String: message name
101 * @param $fallback String: default message if the message cache can't be
102 * called by the exception
103 * The function also has other parameters that are arguments for the message
104 * @return String message with arguments replaced
106 function msg( $key, $fallback /*[, params...] */ ) {
107 $args = array_slice( func_get_args(), 2 );
109 if ( $this->useMessageCache() ) {
110 return wfMsgNoTrans( $key, $args );
112 return wfMsgReplaceArgs( $fallback, $args );
117 * If $wgShowExceptionDetails is true, return a HTML message with a
118 * backtrace to the error, otherwise show a message to ask to set it to true
119 * to show that information.
121 * @return String html to output
124 global $wgShowExceptionDetails;
126 if ( $wgShowExceptionDetails ) {
127 return '<p>' . nl2br( htmlspecialchars( $this->getMessage() ) ) .
128 '</p><p>Backtrace:</p><p>' . nl2br( htmlspecialchars( $this->getTraceAsString() ) ) .
132 "<div class=\"errorbox\">" .
133 '[' . $this->getLogId() . '] ' .
134 gmdate( 'Y-m-d H:i:s' ) .
135 ": Fatal exception of type " . get_class( $this ) . "</div>\n" .
136 "<!-- Set \$wgShowExceptionDetails = true; " .
137 "at the bottom of LocalSettings.php to show detailed " .
138 "debugging information. -->";
143 * If $wgShowExceptionDetails is true, return a text message with a
144 * backtrace to the error.
148 global $wgShowExceptionDetails;
150 if ( $wgShowExceptionDetails ) {
151 return $this->getMessage() .
152 "\nBacktrace:\n" . $this->getTraceAsString() . "\n";
154 return "Set \$wgShowExceptionDetails = true; " .
155 "in LocalSettings.php to show detailed debugging information.\n";
160 * Return titles of this error page
163 function getPageTitle() {
164 return $this->msg( 'internalerror', "Internal error" );
167 function getLogId() {
168 if ( $this->logId
=== null ) {
169 $this->logId
= wfRandomString( 8 );
175 * Return the requested URL and point to file and line number from which the
180 function getLogMessage() {
183 $id = $this->getLogId();
184 $file = $this->getFile();
185 $line = $this->getLine();
186 $message = $this->getMessage();
188 if ( isset( $wgRequest ) && !$wgRequest instanceof FauxRequest
) {
189 $url = $wgRequest->getRequestURL();
197 return "[$id] $url Exception from line $line of $file: $message";
200 /** Output the exception report using HTML */
201 function reportHTML() {
203 if ( $this->useOutputPage() ) {
204 $wgOut->prepareErrorPage( $this->getPageTitle() );
206 $hookResult = $this->runHooks( get_class( $this ) );
208 $wgOut->addHTML( $hookResult );
210 $wgOut->addHTML( $this->getHTML() );
215 header( "Content-Type: text/html; charset=utf-8" );
216 echo "<!doctype html>\n" .
218 '<title>' . htmlspecialchars( $this->getPageTitle() ) . '</title>' .
221 $hookResult = $this->runHooks( get_class( $this ) . "Raw" );
225 echo $this->getHTML();
228 echo "</body></html>\n";
234 * Output a report about the exception and takes care of formatting.
235 * It will be either HTML or plain text based on isCommandLine().
238 global $wgLogExceptionBacktrace;
239 $log = $this->getLogMessage();
242 if ( $wgLogExceptionBacktrace ) {
243 wfDebugLog( 'exception', $log . "\n" . $this->getTraceAsString() . "\n" );
245 wfDebugLog( 'exception', $log );
249 if ( defined( 'MW_API' ) ) {
250 // Unhandled API exception, we can't be sure that format printer is alive
251 header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $this ) );
252 wfHttpError(500, 'Internal Server Error', $this->getText() );
253 } elseif ( self
::isCommandLine() ) {
254 MWExceptionHandler
::printError( $this->getText() );
256 header( "HTTP/1.1 500 MediaWiki exception" );
257 header( "Status: 500 MediaWiki exception", true );
267 static function isCommandLine() {
268 return !empty( $GLOBALS['wgCommandLineMode'] );
273 * Exception class which takes an HTML error message, and does not
274 * produce a backtrace. Replacement for OutputPage::fatalError().
277 class FatalError
extends MWException
{
283 return $this->getMessage();
290 return $this->getMessage();
295 * An error page which can definitely be safely rendered using the OutputPage
298 class ErrorPageError
extends MWException
{
299 public $title, $msg, $params;
304 * Note: these arguments are keys into wfMsg(), not text!
306 * @param $title A title
307 * @param $msg String|Message . In string form, should be a message key
308 * @param $params Array Array to wfMsg()
310 function __construct( $title, $msg, $params = null ) {
311 $this->title
= $title;
313 $this->params
= $params;
315 if( $msg instanceof Message
){
316 parent
::__construct( $msg );
318 parent
::__construct( wfMsg( $msg ) );
325 $wgOut->showErrorPage( $this->title
, $this->msg
, $this->params
);
331 * Show an error page on a badtitle.
332 * Similar to ErrorPage, but emit a 400 HTTP error code to let mobile
333 * browser it is not really a valid content.
335 class BadTitleError
extends ErrorPageError
{
338 * @param $msg string A message key (default: 'badtitletext')
339 * @param $params Array parameter to wfMsg()
341 function __construct( $msg = 'badtitletext', $params = null ) {
342 parent
::__construct( 'badtitle', $msg, $params );
346 * Just like ErrorPageError::report() but additionally set
347 * a 400 HTTP status code (bug 33646).
352 // bug 33646: a badtitle error page need to return an error code
353 // to let mobile browser now that it is not a normal page.
354 $wgOut->setStatusCode( 400 );
361 * Show an error when a user tries to do something they do not have the necessary
365 class PermissionsError
extends ErrorPageError
{
366 public $permission, $errors;
368 function __construct( $permission, $errors = array() ) {
371 $this->permission
= $permission;
373 if ( !count( $errors ) ) {
375 array( 'User', 'makeGroupLinkWiki' ),
376 User
::getGroupsWithPermission( $this->permission
)
380 $errors[] = array( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
382 $errors[] = array( 'badaccess-group0' );
386 $this->errors
= $errors;
392 $wgOut->showPermissionsErrorPage( $this->errors
, $this->permission
);
398 * Show an error when the wiki is locked/read-only and the user tries to do
399 * something that requires write access
402 class ReadOnlyError
extends ErrorPageError
{
403 public function __construct(){
413 * Show an error when the user hits a rate limit
416 class ThrottledError
extends ErrorPageError
{
417 public function __construct(){
420 'actionthrottledtext'
424 public function report(){
426 $wgOut->setStatusCode( 503 );
432 * Show an error when the user tries to do something whilst blocked
435 class UserBlockedError
extends ErrorPageError
{
436 public function __construct( Block
$block ){
437 global $wgLang, $wgRequest;
439 $blocker = $block->getBlocker();
440 if ( $blocker instanceof User
) { // local user
441 $blockerUserpage = $block->getBlocker()->getUserPage();
442 $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
443 } else { // foreign user
447 $reason = $block->mReason
;
448 if( $reason == '' ) {
449 $reason = wfMsg( 'blockednoreason' );
452 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
453 * This could be a username, an IP range, or a single IP. */
454 $intended = $block->getTarget();
458 $block->mAuto ?
'autoblockedtext' : 'blockedtext',
465 $wgLang->formatExpiry( $block->mExpiry
),
467 $wgLang->timeanddate( wfTimestamp( TS_MW
, $block->mTimestamp
), true )
474 * Shows a generic "user is not logged in" error page.
476 * This is essentially an ErrorPageError exception which by default use the
477 * 'exception-nologin' as a title and 'exception-nologin-text' for the message.
482 * if( $user->isAnon ) {
483 * throw new UserNotLoggedIn();
487 * Please note the parameters are mixed up compared to ErrorPageError, this
488 * is done to be able to simply specify a reason whitout overriding the default
493 * if( $user->isAnon ) {
494 * throw new UserNotLoggedIn( 'action-require-loggedin' );
498 * @param $reasonMsg A message key containing the reason for the error.
499 * Optional, default: 'exception-nologin-text'
500 * @param $titleMsg A message key to set the page title.
501 * Optional, default: 'exception-nologin'
502 * @param $params Parameters to wfMsg().
503 * Optiona, default: null
505 class UserNotLoggedIn
extends ErrorPageError
{
507 public function __construct(
508 $reasonMsg = 'exception-nologin-text',
509 $titleMsg = 'exception-nologin',
512 parent
::__construct( $titleMsg, $reasonMsg, $params );
517 * Show an error that looks like an HTTP server error.
518 * Replacement for wfHttpError().
522 class HttpError
extends MWException
{
523 private $httpCode, $header, $content;
528 * @param $httpCode Integer: HTTP status code to send to the client
529 * @param $content String|Message: content of the message
530 * @param $header String|Message: content of the header (\<title\> and \<h1\>)
532 public function __construct( $httpCode, $content, $header = null ){
533 parent
::__construct( $content );
534 $this->httpCode
= (int)$httpCode;
535 $this->header
= $header;
536 $this->content
= $content;
539 public function report() {
540 $httpMessage = HttpStatus
::getMessage( $this->httpCode
);
542 header( "Status: {$this->httpCode} {$httpMessage}" );
543 header( 'Content-type: text/html; charset=utf-8' );
545 if ( $this->header
=== null ) {
546 $header = $httpMessage;
547 } elseif ( $this->header
instanceof Message
) {
548 $header = $this->header
->escaped();
550 $header = htmlspecialchars( $this->header
);
553 if ( $this->content
instanceof Message
) {
554 $content = $this->content
->escaped();
556 $content = htmlspecialchars( $this->content
);
559 print "<!DOCTYPE html>\n".
560 "<html><head><title>$header</title></head>\n" .
561 "<body><h1>$header</h1><p>$content</p></body></html>\n";
566 * Handler class for MWExceptions
569 class MWExceptionHandler
{
571 * Install an exception handler for MediaWiki exception types.
573 public static function installHandler() {
574 set_exception_handler( array( 'MWExceptionHandler', 'handle' ) );
578 * Report an exception to the user
580 protected static function report( Exception
$e ) {
581 global $wgShowExceptionDetails;
583 $cmdLine = MWException
::isCommandLine();
585 if ( $e instanceof MWException
) {
587 // Try and show the exception prettily, with the normal skin infrastructure
589 } catch ( Exception
$e2 ) {
590 // Exception occurred from within exception handler
591 // Show a simpler error message for the original exception,
592 // don't try to invoke report()
593 $message = "MediaWiki internal error.\n\n";
595 if ( $wgShowExceptionDetails ) {
596 $message .= 'Original exception: ' . $e->__toString() . "\n\n" .
597 'Exception caught inside exception handler: ' . $e2->__toString();
599 $message .= "Exception caught inside exception handler.\n\n" .
600 "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
601 "to show detailed debugging information.";
607 self
::printError( $message );
609 self
::escapeEchoAndDie( $message );
613 $message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"\n" .
614 $e->__toString() . "\n";
616 if ( $wgShowExceptionDetails ) {
617 $message .= "\n" . $e->getTraceAsString() . "\n";
621 self
::printError( $message );
623 self
::escapeEchoAndDie( $message );
629 * Print a message, if possible to STDERR.
630 * Use this in command line mode only (see isCommandLine)
631 * @param $message String Failure text
633 public static function printError( $message ) {
634 # NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
635 # Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
636 if ( defined( 'STDERR' ) ) {
637 fwrite( STDERR
, $message );
644 * Print a message after escaping it and converting newlines to <br>
645 * Use this for non-command line failures
646 * @param $message String Failure text
648 private static function escapeEchoAndDie( $message ) {
649 echo nl2br( htmlspecialchars( $message ) ) . "\n";
654 * Exception handler which simulates the appropriate catch() handling:
658 * } catch ( MWException $e ) {
660 * } catch ( Exception $e ) {
661 * echo $e->__toString();
664 public static function handle( $e ) {
665 global $wgFullyInitialised;
670 if ( $wgFullyInitialised ) {
672 wfLogProfilingData(); // uses $wgRequest, hence the $wgFullyInitialised condition
673 } catch ( Exception
$e ) {}
676 // Exit value should be nonzero for the benefit of shell jobs