3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
21 use Wikimedia\Rdbms\DBConnectionError
;
22 use Wikimedia\Rdbms\DBReadOnlyError
;
23 use Wikimedia\Rdbms\DBExpectedError
;
26 * Class to expose exceptions to the client (API bots, users, admins using CLI scripts)
29 class MWExceptionRenderer
{
30 const AS_RAW
= 1; // show as text
31 const AS_PRETTY
= 2; // show as HTML
34 * @param Exception|Throwable $e Original exception
35 * @param int $mode MWExceptionExposer::AS_* constant
36 * @param Exception|Throwable|null $eNew New exception from attempting to show the first
38 public static function output( $e, $mode, $eNew = null ) {
39 global $wgMimeType, $wgShowExceptionDetails;
41 if ( defined( 'MW_API' ) ) {
42 // Unhandled API exception, we can't be sure that format printer is alive
43 self
::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $e ) );
44 wfHttpError( 500, 'Internal Server Error', self
::getText( $e ) );
45 } elseif ( self
::isCommandLine() ) {
46 self
::printError( self
::getText( $e ) );
47 } elseif ( $mode === self
::AS_PRETTY
) {
48 self
::statusHeader( 500 );
49 self
::header( "Content-Type: $wgMimeType; charset=utf-8" );
50 if ( $e instanceof DBConnectionError
) {
51 self
::reportOutageHTML( $e );
53 self
::reportHTML( $e );
56 self
::statusHeader( 500 );
57 self
::header( "Content-Type: $wgMimeType; charset=utf-8" );
59 $message = "MediaWiki internal error.\n\n";
60 if ( $wgShowExceptionDetails ) {
61 $message .= 'Original exception: ' .
62 MWExceptionHandler
::getLogMessage( $e ) .
63 "\nBacktrace:\n" . MWExceptionHandler
::getRedactedTraceAsString( $e ) .
64 "\n\nException caught inside exception handler: " .
65 MWExceptionHandler
::getLogMessage( $eNew ) .
66 "\nBacktrace:\n" . MWExceptionHandler
::getRedactedTraceAsString( $eNew );
68 $message .= 'Original exception: ' .
69 MWExceptionHandler
::getPublicLogMessage( $e );
70 $message .= "\n\nException caught inside exception handler.\n\n" .
71 self
::getShowBacktraceError( $e );
75 if ( $wgShowExceptionDetails ) {
76 $message = MWExceptionHandler
::getLogMessage( $e ) .
78 MWExceptionHandler
::getRedactedTraceAsString( $e ) . "\n";
80 $message = MWExceptionHandler
::getPublicLogMessage( $e );
83 echo nl2br( htmlspecialchars( $message ) ) . "\n";
88 * @param Exception|Throwable $e
89 * @return bool Should the exception use $wgOut to output the error?
91 private static function useOutputPage( $e ) {
92 // Can the extension use the Message class/wfMessage to get i18n-ed messages?
93 foreach ( $e->getTrace() as $frame ) {
94 if ( isset( $frame['class'] ) && $frame['class'] === LocalisationCache
::class ) {
99 // Don't even bother with OutputPage if there's no Title context set,
100 // (e.g. we're in RL code on load.php) - the Skin system (and probably
101 // most of MediaWiki) won't work.
104 !empty( $GLOBALS['wgFullyInitialised'] ) &&
105 !empty( $GLOBALS['wgOut'] ) &&
106 RequestContext
::getMain()->getTitle() &&
107 !defined( 'MEDIAWIKI_INSTALL' )
112 * Output the exception report using HTML
114 * @param Exception|Throwable $e
116 private static function reportHTML( $e ) {
117 global $wgOut, $wgSitename;
119 if ( self
::useOutputPage( $e ) ) {
120 if ( $e instanceof MWException
) {
121 $wgOut->prepareErrorPage( $e->getPageTitle() );
122 } elseif ( $e instanceof DBReadOnlyError
) {
123 $wgOut->prepareErrorPage( self
::msg( 'readonly', 'Database is locked' ) );
124 } elseif ( $e instanceof DBExpectedError
) {
125 $wgOut->prepareErrorPage( self
::msg( 'databaseerror', 'Database error' ) );
127 $wgOut->prepareErrorPage( self
::msg( 'internalerror', 'Internal error' ) );
130 // Show any custom GUI message before the details
131 if ( $e instanceof MessageSpecifier
) {
132 $wgOut->addHTML( Html
::element( 'p', [], Message
::newFromSpecifier( $e )->text() ) );
134 $wgOut->addHTML( self
::getHTML( $e ) );
138 self
::header( 'Content-Type: text/html; charset=utf-8' );
139 $pageTitle = self
::msg( 'internalerror', 'Internal error' );
140 echo "<!DOCTYPE html>\n" .
142 // Mimick OutputPage::setPageTitle behaviour
144 htmlspecialchars( self
::msg( 'pagetitle', "$1 - $wgSitename", $pageTitle ) ) .
146 '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
149 echo self
::getHTML( $e );
151 echo "</body></html>\n";
156 * If $wgShowExceptionDetails is true, return a HTML message with a
157 * backtrace to the error, otherwise show a message to ask to set it to true
158 * to show that information.
160 * @param Exception|Throwable $e
161 * @return string Html to output
163 public static function getHTML( $e ) {
164 global $wgShowExceptionDetails;
166 if ( $wgShowExceptionDetails ) {
167 $html = "<div class=\"errorbox mw-content-ltr\"><p>" .
168 nl2br( htmlspecialchars( MWExceptionHandler
::getLogMessage( $e ) ) ) .
169 '</p><p>Backtrace:</p><p>' .
170 nl2br( htmlspecialchars( MWExceptionHandler
::getRedactedTraceAsString( $e ) ) ) .
173 $logId = WebRequest
::getRequestId();
174 $html = "<div class=\"errorbox mw-content-ltr\">" .
176 '[' . $logId . '] ' .
177 gmdate( 'Y-m-d H:i:s' ) . ": " .
178 self
::msg( "internalerror-fatal-exception",
179 "Fatal exception of type $1",
182 MWExceptionHandler
::getURL()
184 "<!-- " . wordwrap( self
::getShowBacktraceError( $e ), 50 ) . " -->";
191 * Get a message from i18n
193 * @param string $key Message name
194 * @param string $fallback Default message if the message cache can't be
195 * called by the exception
196 * The function also has other parameters that are arguments for the message
197 * @return string Message with arguments replaced
199 private static function msg( $key, $fallback /*[, params...] */ ) {
201 $args = array_slice( func_get_args(), 2 );
203 // FIXME: Keep logic in sync with MWException::msg.
205 $res = wfMessage( $key, $args )->text();
206 } catch ( Exception
$e ) {
207 $res = wfMsgReplaceArgs( $fallback, $args );
208 // If an exception happens inside message rendering,
209 // {{SITENAME}} sometimes won't be replaced.
210 $res = strtr( $res, [
211 '{{SITENAME}}' => $wgSitename,
218 * @param Exception|Throwable $e
221 private static function getText( $e ) {
222 global $wgShowExceptionDetails;
224 if ( $wgShowExceptionDetails ) {
225 return MWExceptionHandler
::getLogMessage( $e ) .
227 MWExceptionHandler
::getRedactedTraceAsString( $e ) . "\n";
229 return self
::getShowBacktraceError( $e ) . "\n";
234 * @param Exception|Throwable $e
237 private static function getShowBacktraceError( $e ) {
238 $var = '$wgShowExceptionDetails = true;';
239 return "Set $var at the bottom of LocalSettings.php to show detailed debugging information.";
245 private static function isCommandLine() {
246 return !empty( $GLOBALS['wgCommandLineMode'] );
250 * @param string $header
252 private static function header( $header ) {
253 if ( !headers_sent() ) {
261 private static function statusHeader( $code ) {
262 if ( !headers_sent() ) {
263 HttpStatus
::header( $code );
268 * Print a message, if possible to STDERR.
269 * Use this in command line mode only (see isCommandLine)
271 * @param string $message Failure text
273 private static function printError( $message ) {
274 // NOTE: STDERR may not be available, especially if php-cgi is used from the
275 // command line (T17602). Try to produce meaningful output anyway. Using
276 // echo may corrupt output to STDOUT though.
277 if ( defined( 'STDERR' ) ) {
278 fwrite( STDERR
, $message );
285 * @param Exception|Throwable $e
287 private static function reportOutageHTML( $e ) {
288 global $wgShowExceptionDetails, $wgShowHostnames, $wgSitename;
290 $sorry = htmlspecialchars( self
::msg(
292 'Sorry! This site is experiencing technical difficulties.'
294 $again = htmlspecialchars( self
::msg(
296 'Try waiting a few minutes and reloading.'
299 if ( $wgShowHostnames ) {
302 Html
::element( 'span', [ 'dir' => 'ltr' ], $e->getMessage() ),
303 htmlspecialchars( self
::msg( 'dberr-info', '($1)' ) )
306 $info = htmlspecialchars( self
::msg(
308 '(Cannot access the database)'
312 MessageCache
::singleton()->disable(); // no DB access
313 $html = "<!DOCTYPE html>\n" .
316 htmlspecialchars( $wgSitename ) .
318 '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
319 "</head><body><h1>$sorry</h1><p>$again</p><p><small>$info</small></p>";
321 if ( $wgShowExceptionDetails ) {
322 $html .= '<p>Backtrace:</p><pre>' .
323 htmlspecialchars( $e->getTraceAsString() ) . '</pre>';
326 $html .= '</body></html>';