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;
324 * Note: these arguments are keys into wfMsg(), not text!
326 * @param $title A title
327 * @param $msg String|Message . In string form, should be a message key
328 * @param $params Array Array to wfMessage()
330 function __construct( $title, $msg, $params = null ) {
331 $this->title
= $title;
333 $this->params
= $params;
335 if( $msg instanceof Message
){
336 parent
::__construct( $msg );
338 parent
::__construct( wfMessage( $msg )->text() );
345 $wgOut->showErrorPage( $this->title
, $this->msg
, $this->params
);
351 * Show an error page on a badtitle.
352 * Similar to ErrorPage, but emit a 400 HTTP error code to let mobile
353 * browser it is not really a valid content.
358 class BadTitleError
extends ErrorPageError
{
361 * @param $msg string A message key (default: 'badtitletext')
362 * @param $params Array parameter to wfMessage()
364 function __construct( $msg = 'badtitletext', $params = null ) {
365 parent
::__construct( 'badtitle', $msg, $params );
369 * Just like ErrorPageError::report() but additionally set
370 * a 400 HTTP status code (bug 33646).
375 // bug 33646: a badtitle error page need to return an error code
376 // to let mobile browser now that it is not a normal page.
377 $wgOut->setStatusCode( 400 );
384 * Show an error when a user tries to do something they do not have the necessary
390 class PermissionsError
extends ErrorPageError
{
391 public $permission, $errors;
393 function __construct( $permission, $errors = array() ) {
396 $this->permission
= $permission;
398 if ( !count( $errors ) ) {
400 array( 'User', 'makeGroupLinkWiki' ),
401 User
::getGroupsWithPermission( $this->permission
)
405 $errors[] = array( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
407 $errors[] = array( 'badaccess-group0' );
411 $this->errors
= $errors;
417 $wgOut->showPermissionsErrorPage( $this->errors
, $this->permission
);
423 * Show an error when the wiki is locked/read-only and the user tries to do
424 * something that requires write access.
429 class ReadOnlyError
extends ErrorPageError
{
430 public function __construct(){
440 * Show an error when the user hits a rate limit.
445 class ThrottledError
extends ErrorPageError
{
446 public function __construct(){
449 'actionthrottledtext'
453 public function report(){
455 $wgOut->setStatusCode( 503 );
461 * Show an error when the user tries to do something whilst blocked.
466 class UserBlockedError
extends ErrorPageError
{
467 public function __construct( Block
$block ){
468 global $wgLang, $wgRequest;
470 $blocker = $block->getBlocker();
471 if ( $blocker instanceof User
) { // local user
472 $blockerUserpage = $block->getBlocker()->getUserPage();
473 $link = "[[{$blockerUserpage->getPrefixedText()}|{$blockerUserpage->getText()}]]";
474 } else { // foreign user
478 $reason = $block->mReason
;
479 if( $reason == '' ) {
480 $reason = wfMessage( 'blockednoreason' )->text();
483 /* $ip returns who *is* being blocked, $intended contains who was meant to be blocked.
484 * This could be a username, an IP range, or a single IP. */
485 $intended = $block->getTarget();
489 $block->mAuto ?
'autoblockedtext' : 'blockedtext',
496 $wgLang->formatExpiry( $block->mExpiry
),
498 $wgLang->timeanddate( wfTimestamp( TS_MW
, $block->mTimestamp
), true )
505 * Shows a generic "user is not logged in" error page.
507 * This is essentially an ErrorPageError exception which by default use the
508 * 'exception-nologin' as a title and 'exception-nologin-text' for the message.
514 * if( $user->isAnon ) {
515 * throw new UserNotLoggedIn();
519 * Please note the parameters are mixed up compared to ErrorPageError, this
520 * is done to be able to simply specify a reason whitout overriding the default
525 * if( $user->isAnon ) {
526 * throw new UserNotLoggedIn( 'action-require-loggedin' );
532 class UserNotLoggedIn
extends ErrorPageError
{
535 * @param $reasonMsg A message key containing the reason for the error.
536 * Optional, default: 'exception-nologin-text'
537 * @param $titleMsg A message key to set the page title.
538 * Optional, default: 'exception-nologin'
539 * @param $params Parameters to wfMessage().
540 * Optiona, default: null
542 public function __construct(
543 $reasonMsg = 'exception-nologin-text',
544 $titleMsg = 'exception-nologin',
547 parent
::__construct( $titleMsg, $reasonMsg, $params );
552 * Show an error that looks like an HTTP server error.
553 * Replacement for wfHttpError().
558 class HttpError
extends MWException
{
559 private $httpCode, $header, $content;
564 * @param $httpCode Integer: HTTP status code to send to the client
565 * @param $content String|Message: content of the message
566 * @param $header String|Message: content of the header (\<title\> and \<h1\>)
568 public function __construct( $httpCode, $content, $header = null ){
569 parent
::__construct( $content );
570 $this->httpCode
= (int)$httpCode;
571 $this->header
= $header;
572 $this->content
= $content;
575 public function report() {
576 $httpMessage = HttpStatus
::getMessage( $this->httpCode
);
578 header( "Status: {$this->httpCode} {$httpMessage}" );
579 header( 'Content-type: text/html; charset=utf-8' );
581 if ( $this->header
=== null ) {
582 $header = $httpMessage;
583 } elseif ( $this->header
instanceof Message
) {
584 $header = $this->header
->escaped();
586 $header = htmlspecialchars( $this->header
);
589 if ( $this->content
instanceof Message
) {
590 $content = $this->content
->escaped();
592 $content = htmlspecialchars( $this->content
);
595 print "<!DOCTYPE html>\n".
596 "<html><head><title>$header</title></head>\n" .
597 "<body><h1>$header</h1><p>$content</p></body></html>\n";
602 * Handler class for MWExceptions
605 class MWExceptionHandler
{
607 * Install an exception handler for MediaWiki exception types.
609 public static function installHandler() {
610 set_exception_handler( array( 'MWExceptionHandler', 'handle' ) );
614 * Report an exception to the user
616 protected static function report( Exception
$e ) {
617 global $wgShowExceptionDetails;
619 $cmdLine = MWException
::isCommandLine();
621 if ( $e instanceof MWException
) {
623 // Try and show the exception prettily, with the normal skin infrastructure
625 } catch ( Exception
$e2 ) {
626 // Exception occurred from within exception handler
627 // Show a simpler error message for the original exception,
628 // don't try to invoke report()
629 $message = "MediaWiki internal error.\n\n";
631 if ( $wgShowExceptionDetails ) {
632 $message .= 'Original exception: ' . $e->__toString() . "\n\n" .
633 'Exception caught inside exception handler: ' . $e2->__toString();
635 $message .= "Exception caught inside exception handler.\n\n" .
636 "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
637 "to show detailed debugging information.";
643 self
::printError( $message );
645 self
::escapeEchoAndDie( $message );
649 $message = "Unexpected non-MediaWiki exception encountered, of type \"" . get_class( $e ) . "\"\n" .
650 $e->__toString() . "\n";
652 if ( $wgShowExceptionDetails ) {
653 $message .= "\n" . $e->getTraceAsString() . "\n";
657 self
::printError( $message );
659 self
::escapeEchoAndDie( $message );
665 * Print a message, if possible to STDERR.
666 * Use this in command line mode only (see isCommandLine)
668 * @param $message string Failure text
670 public static function printError( $message ) {
671 # NOTE: STDERR may not be available, especially if php-cgi is used from the command line (bug #15602).
672 # Try to produce meaningful output anyway. Using echo may corrupt output to STDOUT though.
673 if ( defined( 'STDERR' ) ) {
674 fwrite( STDERR
, $message );
681 * Print a message after escaping it and converting newlines to <br>
682 * Use this for non-command line failures.
684 * @param $message string Failure text
686 private static function escapeEchoAndDie( $message ) {
687 echo nl2br( htmlspecialchars( $message ) ) . "\n";
692 * Exception handler which simulates the appropriate catch() handling:
696 * } catch ( MWException $e ) {
698 * } catch ( Exception $e ) {
699 * echo $e->__toString();
702 public static function handle( $e ) {
703 global $wgFullyInitialised;
708 if ( $wgFullyInitialised ) {
710 wfLogProfilingData(); // uses $wgRequest, hence the $wgFullyInitialised condition
711 } catch ( Exception
$e ) {}
714 // Exit value should be nonzero for the benefit of shell jobs