1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438
|
<?php
/**
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
use MediaWiki\Context\RequestContext;
use MediaWiki\Html\Html;
use MediaWiki\Language\RawMessage;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Message\Message;
use MediaWiki\Request\WebRequest;
use Wikimedia\AtEase;
use Wikimedia\Message\MessageSpecifier;
use Wikimedia\Rdbms\DBConnectionError;
use Wikimedia\Rdbms\DBExpectedError;
use Wikimedia\Rdbms\DBReadOnlyError;
use Wikimedia\RequestTimeout\RequestTimeoutException;
/**
* Class to expose exceptions to the client (API bots, users, admins using CLI scripts)
* @since 1.28
*/
class MWExceptionRenderer {
public const AS_RAW = 1; // show as text
public const AS_PRETTY = 2; // show as HTML
/**
* Whether to print exception details.
*
* The default is configured by $wgShowExceptionDetails.
* May be changed at runtime via MWExceptionRenderer::setShowExceptionDetails().
*
* @see MainConfigNames::ShowExceptionDetails
* @var bool
*/
private static $showExceptionDetails = false;
/**
* @internal For use within core wiring only.
* @return bool
*/
public static function shouldShowExceptionDetails(): bool {
return self::$showExceptionDetails;
}
/**
* @param bool $showDetails
* @internal For use by Setup.php and other internal use cases.
*/
public static function setShowExceptionDetails( bool $showDetails ): void {
self::$showExceptionDetails = $showDetails;
}
/**
* @param Throwable $e Original exception
* @param int $mode MWExceptionExposer::AS_* constant
* @param Throwable|null $eNew New throwable from attempting to show the first
*/
public static function output( Throwable $e, $mode, ?Throwable $eNew = null ) {
$showExceptionDetails = self::shouldShowExceptionDetails();
if ( $e instanceof RequestTimeoutException && headers_sent() ) {
// Excimer's flag check happens on function return, so, a timeout
// can be thrown after exiting, say, `doPostOutputShutdown`, where
// headers are sent. In which case, it's probably fine not to
// report this in any user visible way. The general question of
// what to do about reporting an exception when headers have been
// sent is still unclear, but you probably don't want to
// `useOutputPage`.
return;
}
if ( function_exists( 'apache_setenv' ) ) {
// The client should not be blocked on "post-send" updates. If apache decides that
// a response should be gzipped, it will wait for PHP to finish since it cannot gzip
// anything until it has the full response (even with "Transfer-Encoding: chunked").
AtEase\AtEase::suppressWarnings();
apache_setenv( 'no-gzip', '1' );
AtEase\AtEase::restoreWarnings();
}
if ( defined( 'MW_API' ) ) {
self::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $e ) );
}
if ( self::isCommandLine() ) {
self::printError( self::getText( $e ) );
} elseif ( $mode === self::AS_PRETTY ) {
self::statusHeader( 500 );
ob_start();
if ( $e instanceof DBConnectionError ) {
self::reportOutageHTML( $e );
} else {
self::reportHTML( $e );
}
self::header( "Content-Length: " . ob_get_length() );
ob_end_flush();
} else {
ob_start();
self::statusHeader( 500 );
self::header( 'Content-Type: text/html; charset=UTF-8' );
if ( $eNew ) {
$message = "MediaWiki internal error.\n\n";
if ( $showExceptionDetails ) {
$message .= 'Original exception: ' .
MWExceptionHandler::getLogMessage( $e ) .
"\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $e ) .
"\n\nException caught inside exception handler: " .
MWExceptionHandler::getLogMessage( $eNew ) .
"\nBacktrace:\n" . MWExceptionHandler::getRedactedTraceAsString( $eNew );
} else {
$message .= 'Original exception: ' .
MWExceptionHandler::getPublicLogMessage( $e );
$message .= "\n\nException caught inside exception handler.\n\n" .
self::getShowBacktraceError();
}
$message .= "\n";
} elseif ( $showExceptionDetails ) {
$message = MWExceptionHandler::getLogMessage( $e ) .
"\nBacktrace:\n" .
MWExceptionHandler::getRedactedTraceAsString( $e ) . "\n";
} else {
$message = MWExceptionHandler::getPublicLogMessage( $e );
}
print nl2br( htmlspecialchars( $message ) ) . "\n";
self::header( "Content-Length: " . ob_get_length() );
ob_end_flush();
}
}
/**
* @param Throwable $e
* @return bool Should the throwable use $wgOut to output the error?
*/
private static function useOutputPage( Throwable $e ) {
// Can the exception use the Message class/wfMessage to get i18n-ed messages?
foreach ( $e->getTrace() as $frame ) {
if ( isset( $frame['class'] ) && $frame['class'] === LocalisationCache::class ) {
return false;
}
}
// Don't even bother with OutputPage if there's no Title context set,
// (e.g. we're in RL code on load.php) - the Skin system (and probably
// most of MediaWiki) won't work.
return (
!empty( $GLOBALS['wgFullyInitialised'] ) &&
!empty( $GLOBALS['wgOut'] ) &&
RequestContext::getMain()->getTitle() &&
!defined( 'MEDIAWIKI_INSTALL' ) &&
// Don't send a skinned HTTP 500 page to API clients.
!defined( 'MW_API' ) &&
!defined( 'MW_REST_API' )
);
}
/**
* Output the throwable report using HTML
*
* @param Throwable $e
*/
private static function reportHTML( Throwable $e ) {
if ( self::useOutputPage( $e ) ) {
$out = RequestContext::getMain()->getOutput();
$out->prepareErrorPage();
$out->setPageTitleMsg( self::getExceptionTitle( $e ) );
// Show any custom GUI message before the details
$customMessage = self::getCustomMessage( $e );
if ( $customMessage !== null ) {
$out->addHTML( Html::element( 'p', [], $customMessage ) );
}
$out->addHTML( self::getHTML( $e ) );
// Content-Type is set by OutputPage::output
$out->output();
} else {
self::header( 'Content-Type: text/html; charset=UTF-8' );
$pageTitle = self::msg( 'internalerror', 'Internal error' );
echo "<!DOCTYPE html>\n" .
'<html><head>' .
// Mimic OutputPage::setPageTitle behaviour
'<title>' .
htmlspecialchars( self::msg( 'pagetitle', '$1 - MediaWiki', $pageTitle ) ) .
'</title>' .
'<meta name="color-scheme" content="light dark" />' .
'<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
"</head><body>\n";
echo self::getHTML( $e );
echo "</body></html>\n";
}
}
/**
* Format an HTML message for the given exception object.
*
* @param Throwable $e
* @return string Html to output
*/
public static function getHTML( Throwable $e ) {
if ( self::shouldShowExceptionDetails() ) {
$html = '<div dir=ltr>' . Html::errorBox( "<p>" .
nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $e ) ) ) .
'</p><p>Backtrace:</p><p>' .
nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $e ) ) ) .
"</p>\n"
) . '</div>';
} else {
$logId = WebRequest::getRequestId();
$html = Html::errorBox(
htmlspecialchars(
'[' . $logId . '] ' .
gmdate( 'Y-m-d H:i:s' ) . ": " .
self::msg( "internalerror-fatal-exception",
"Fatal exception of type $1",
get_class( $e ),
$logId,
MWExceptionHandler::getURL()
) )
) . "<!-- " . wordwrap( self::getShowBacktraceError(), 50 ) . " -->";
}
return $html;
}
/**
* Get a message string from i18n
*
* @param string $key Message name
* @param string $fallback Default message if the message cache can't be
* called by the exception
* @param mixed ...$params To pass to wfMessage()
* @return string Message with arguments replaced
*/
public static function msg( $key, $fallback, ...$params ) {
// NOTE: Keep logic in sync with MWException::msg
$res = self::msgObj( $key, $fallback, ...$params )->text();
return strtr( $res, [
'{{SITENAME}}' => 'MediaWiki',
] );
}
/** Get a Message object from i18n.
*
* @param string $key Message name
* @param string $fallback Default message if the message cache can't be
* called by the exception
* @param mixed ...$params To pass to wfMessage()
* @return Message|RawMessage
*/
private static function msgObj( string $key, string $fallback, ...$params ): Message {
// NOTE: Keep logic in sync with MWException::msg.
try {
$res = wfMessage( $key, ...$params );
} catch ( Exception $e ) {
// Fallback to static message text and generic sitename.
// Avoid live config as this must work before Setup/MediaWikiServices finish.
$res = new RawMessage( $fallback, $params );
}
// We are in an error state, best to minimize how much work we do.
$res->useDatabase( false );
$isSafeToLoad = RequestContext::getMain()->getUser()->isSafeToLoad();
if ( !$isSafeToLoad ) {
$res->inContentLanguage();
}
return $res;
}
/**
* @param Throwable $e
* @return string
*/
private static function getText( Throwable $e ) {
// XXX: do we need a parameter to control inclusion of exception details?
if ( self::shouldShowExceptionDetails() ) {
return MWExceptionHandler::getLogMessage( $e ) .
"\nBacktrace:\n" .
MWExceptionHandler::getRedactedTraceAsString( $e ) . "\n";
} else {
return self::getShowBacktraceError() . "\n";
}
}
/**
* @return string
*/
private static function getShowBacktraceError() {
$var = '$wgShowExceptionDetails = true;';
return "Set $var at the bottom of LocalSettings.php to show detailed debugging information.";
}
/**
* Get the page title to be used for a given exception.
*
* @param Throwable $e
* @return Message
*/
private static function getExceptionTitle( Throwable $e ): Message {
if ( $e instanceof DBReadOnlyError ) {
return self::msgObj( 'readonly', 'Database is locked' );
} elseif ( $e instanceof DBExpectedError ) {
return self::msgObj( 'databaseerror', 'Database error' );
} elseif ( $e instanceof RequestTimeoutException ) {
return self::msgObj( 'timeouterror', 'Request timeout' );
} else {
return self::msgObj( 'internalerror', 'Internal error' );
}
}
/**
* Extract an additional user-visible message from an exception, or null if
* it has none.
*
* @param Throwable $e
* @return string|null
*/
private static function getCustomMessage( Throwable $e ) {
try {
if ( $e instanceof MessageSpecifier ) {
$msg = Message::newFromSpecifier( $e );
} elseif ( $e instanceof RequestTimeoutException ) {
$msg = wfMessage( 'timeouterror-text', $e->getLimit() );
} else {
return null;
}
$text = $msg->text();
} catch ( Exception $e2 ) {
return null;
}
return $text;
}
/**
* @return bool
*/
private static function isCommandLine() {
return MW_ENTRY_POINT === 'cli';
}
/**
* @param string $header
*/
private static function header( $header ) {
if ( !headers_sent() ) {
header( $header );
}
}
/**
* @param int $code
*/
private static function statusHeader( $code ) {
if ( !headers_sent() ) {
HttpStatus::header( $code );
}
}
/**
* Print a message, if possible to STDERR.
* Use this in command line mode only (see isCommandLine)
*
* @suppress SecurityCheck-XSS
* @param string $message Failure text
*/
private static function printError( $message ) {
// NOTE: STDERR may not be available, especially if php-cgi is used from the
// command line (T17602). Try to produce meaningful output anyway. Using
// echo may corrupt output to STDOUT though.
if ( !defined( 'MW_PHPUNIT_TEST' ) && defined( 'STDERR' ) ) {
fwrite( STDERR, $message );
} else {
echo $message;
}
}
/**
* @param Throwable $e
*/
private static function reportOutageHTML( Throwable $e ) {
$mainConfig = MediaWikiServices::getInstance()->getMainConfig();
$showExceptionDetails = $mainConfig->get( MainConfigNames::ShowExceptionDetails );
$showHostnames = $mainConfig->get( MainConfigNames::ShowHostnames );
$sorry = htmlspecialchars( self::msg(
'dberr-problems',
'Sorry! This site is experiencing technical difficulties.'
) );
$again = htmlspecialchars( self::msg(
'dberr-again',
'Try waiting a few minutes and reloading.'
) );
if ( $showHostnames ) {
$info = str_replace(
'$1',
Html::element( 'span', [ 'dir' => 'ltr' ], $e->getMessage() ),
htmlspecialchars( self::msg( 'dberr-info', '($1)' ) )
);
} else {
$info = htmlspecialchars( self::msg(
'dberr-info-hidden',
'(Cannot access the database)'
) );
}
MediaWikiServices::getInstance()->getMessageCache()->disable(); // no DB access
$html = "<!DOCTYPE html>\n" .
'<html><head>' .
'<title>MediaWiki</title>' .
'<meta name="color-scheme" content="light dark" />' .
'<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
"</head><body><h1>$sorry</h1><p>$again</p><p><small>$info</small></p>";
if ( $showExceptionDetails ) {
$html .= '<p>Backtrace:</p><pre>' .
htmlspecialchars( $e->getTraceAsString() ) . '</pre>';
}
$html .= '</body></html>';
self::header( 'Content-Type: text/html; charset=UTF-8' );
echo $html;
}
}
|