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
19 * @author Aaron Schulz
23 * Class to expose exceptions to the client (API bots, users, admins using CLI scripts)
26 class MWExceptionRenderer
{
27 const AS_RAW
= 1; // show as text
28 const AS_PRETTY
= 2; // show as HTML
31 * @param Exception|Throwable $e Original exception
32 * @param integer $mode MWExceptionExposer::AS_* constant
33 * @param Exception|Throwable|null $eNew New exception from attempting to show the first
35 public static function output( $e, $mode, $eNew = null ) {
38 if ( $e instanceof DBConnectionError
) {
39 self
::reportOutageHTML( $e );
43 if ( defined( 'MW_API' ) ) {
44 // Unhandled API exception, we can't be sure that format printer is alive
45 self
::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $e ) );
46 wfHttpError( 500, 'Internal Server Error', self
::getText( $e ) );
47 } elseif ( self
::isCommandLine() ) {
48 self
::printError( self
::getText( $e ) );
49 } elseif ( $mode === self
::AS_PRETTY
) {
50 self
::statusHeader( 500 );
51 self
::header( "Content-Type: $wgMimeType; charset=utf-8" );
52 self
::reportHTML( $e );
55 $message = "MediaWiki internal error.\n\n";
56 if ( self
::showBackTrace( $e ) ) {
57 $message .= 'Original exception: ' .
58 MWExceptionHandler
::getLogMessage( $e ) .
59 "\nBacktrace:\n" . MWExceptionHandler
::getRedactedTraceAsString( $e ) .
60 "\n\nException caught inside exception handler: " .
61 MWExceptionHandler
::getLogMessage( $eNew ) .
62 "\nBacktrace:\n" . MWExceptionHandler
::getRedactedTraceAsString( $eNew );
64 $message .= "Exception caught inside exception handler.\n\n" .
65 "Set \$wgShowExceptionDetails = true; at the bottom of LocalSettings.php " .
66 "to show detailed debugging information.";
70 if ( self
::showBackTrace( $e ) ) {
71 $message = MWExceptionHandler
::getLogMessage( $e ) .
73 MWExceptionHandler
::getRedactedTraceAsString( $e ) . "\n";
75 $message = MWExceptionHandler
::getPublicLogMessage( $e );
78 if ( self
::isCommandLine() ) {
79 self
::printError( $message );
81 echo nl2br( htmlspecialchars( $message ) ) . "\n";
87 * Run hook to allow extensions to modify the text of the exception
89 * Called by MWException for b/c
91 * @param Exception|Throwable $e
92 * @param string $name Class name of the exception
93 * @param array $args Arguments to pass to the callback functions
94 * @return string|null String to output or null if any hook has been called
96 public static function runHooks( $e, $name, $args = [] ) {
97 global $wgExceptionHooks;
99 if ( !isset( $wgExceptionHooks ) ||
!is_array( $wgExceptionHooks ) ) {
100 return null; // Just silently ignore
103 if ( !array_key_exists( $name, $wgExceptionHooks ) ||
104 !is_array( $wgExceptionHooks[$name] )
109 $hooks = $wgExceptionHooks[$name];
110 $callargs = array_merge( [ $e ], $args );
112 foreach ( $hooks as $hook ) {
114 is_string( $hook ) ||
115 ( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) )
117 // 'function' or [ 'class', 'hook' ]
118 $result = call_user_func_array( $hook, $callargs );
123 if ( is_string( $result ) ) {
132 * @param Exception|Throwable $e
133 * @return bool Should the exception use $wgOut to output the error?
135 private static function useOutputPage( $e ) {
136 // Can the extension use the Message class/wfMessage to get i18n-ed messages?
137 foreach ( $e->getTrace() as $frame ) {
138 if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
144 !empty( $GLOBALS['wgFullyInitialised'] ) &&
145 !empty( $GLOBALS['wgOut'] ) &&
146 !defined( 'MEDIAWIKI_INSTALL' )
151 * Output the exception report using HTML
153 * @param Exception|Throwable $e
155 private static function reportHTML( $e ) {
156 global $wgOut, $wgSitename;
158 if ( self
::useOutputPage( $e ) ) {
159 if ( $e instanceof MWException
) {
160 $wgOut->prepareErrorPage( $e->getPageTitle() );
161 } elseif ( $e instanceof DBReadOnlyError
) {
162 $wgOut->prepareErrorPage( self
::msg( 'readonly', 'Database is locked' ) );
163 } elseif ( $e instanceof DBExpectedError
) {
164 $wgOut->prepareErrorPage( self
::msg( 'databaseerror', 'Database error' ) );
166 $wgOut->prepareErrorPage( self
::msg( 'internalerror', 'Internal error' ) );
169 $hookResult = self
::runHooks( $e, get_class( $e ) );
171 $wgOut->addHTML( $hookResult );
173 // Show any custom GUI message before the details
174 if ( $e instanceof MessageSpecifier
) {
175 $wgOut->addHtml( Message
::newFromSpecifier( $e )->escaped() );
177 $wgOut->addHTML( self
::getHTML( $e ) );
182 self
::header( 'Content-Type: text/html; charset=utf-8' );
183 $pageTitle = self
::msg( 'internalerror', 'Internal error' );
184 echo "<!DOCTYPE html>\n" .
186 // Mimick OutputPage::setPageTitle behaviour
188 htmlspecialchars( self
::msg( 'pagetitle', "$1 - $wgSitename", $pageTitle ) ) .
190 '<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
193 $hookResult = self
::runHooks( $e, get_class( $e ) . 'Raw' );
197 echo self
::getHTML( $e );
200 echo "</body></html>\n";
205 * If $wgShowExceptionDetails is true, return a HTML message with a
206 * backtrace to the error, otherwise show a message to ask to set it to true
207 * to show that information.
209 * @param Exception|Throwable $e
210 * @return string Html to output
212 public static function getHTML( $e ) {
213 if ( self
::showBackTrace( $e ) ) {
214 $html = "<div class=\"errorbox\"><p>" .
215 nl2br( htmlspecialchars( MWExceptionHandler
::getLogMessage( $e ) ) ) .
216 '</p><p>Backtrace:</p><p>' .
217 nl2br( htmlspecialchars( MWExceptionHandler
::getRedactedTraceAsString( $e ) ) ) .
220 $logId = WebRequest
::getRequestId();
221 $html = "<div class=\"errorbox\">" .
222 '[' . $logId . '] ' .
223 gmdate( 'Y-m-d H:i:s' ) . ": " .
224 self
::msg( "internalerror-fatal-exception",
225 "Fatal exception of type $1",
228 MWExceptionHandler
::getURL()
230 "<!-- Set \$wgShowExceptionDetails = true; " .
231 "at the bottom of LocalSettings.php to show detailed " .
232 "debugging information. -->";
239 * Get a message from i18n
241 * @param string $key Message name
242 * @param string $fallback Default message if the message cache can't be
243 * called by the exception
244 * The function also has other parameters that are arguments for the message
245 * @return string Message with arguments replaced
247 private static function msg( $key, $fallback /*[, params...] */ ) {
248 $args = array_slice( func_get_args(), 2 );
250 return wfMessage( $key, $args )->text();
251 } catch ( Exception
$e ) {
252 return wfMsgReplaceArgs( $fallback, $args );
257 * @param Exception|Throwable $e
260 private static function getText( $e ) {
261 if ( self
::showBackTrace( $e ) ) {
262 return MWExceptionHandler
::getLogMessage( $e ) .
264 MWExceptionHandler
::getRedactedTraceAsString( $e ) . "\n";
266 return "Set \$wgShowExceptionDetails = true; " .
267 "in LocalSettings.php to show detailed debugging information.\n";
272 * @param Exception|Throwable $e
275 private static function showBackTrace( $e ) {
276 global $wgShowExceptionDetails, $wgShowDBErrorBacktrace;
279 $wgShowExceptionDetails &&
280 ( !( $e instanceof DBError
) ||
$wgShowDBErrorBacktrace )
287 private static function isCommandLine() {
288 return !empty( $GLOBALS['wgCommandLineMode'] );
292 * @param string $header
294 private static function header( $header ) {
295 if ( !headers_sent() ) {
301 * @param integer $code
303 private static function statusHeader( $code ) {
304 if ( !headers_sent() ) {
305 HttpStatus
::header( $code );
310 * Print a message, if possible to STDERR.
311 * Use this in command line mode only (see isCommandLine)
313 * @param string $message Failure text
315 private static function printError( $message ) {
316 // NOTE: STDERR may not be available, especially if php-cgi is used from the
317 // command line (bug #15602). Try to produce meaningful output anyway. Using
318 // echo may corrupt output to STDOUT though.
319 if ( defined( 'STDERR' ) ) {
320 fwrite( STDERR
, $message );
327 * @param Exception|Throwable $e
329 private static function reportOutageHTML( $e ) {
330 global $wgShowDBErrorBacktrace, $wgShowHostnames, $wgShowSQLErrors;
332 $sorry = htmlspecialchars( self
::msg(
334 'Sorry! This site is experiencing technical difficulties.'
336 $again = htmlspecialchars( self
::msg(
338 'Try waiting a few minutes and reloading.'
341 if ( $wgShowHostnames ||
$wgShowSQLErrors ) {
344 Html
::element( 'span', [ 'dir' => 'ltr' ], htmlspecialchars( $e->getMessage() ) ),
345 htmlspecialchars( self
::msg( 'dberr-info', '($1)' ) )
348 $info = htmlspecialchars( self
::msg(
350 '(Cannot access the database)'
354 MessageCache
::singleton()->disable(); // no DB access
356 $html = "<h1>$sorry</h1><p>$again</p><p><small>$info</small></p>";
358 if ( $wgShowDBErrorBacktrace ) {
359 $html .= '<p>Backtrace:</p><pre>' .
360 htmlspecialchars( $e->getTraceAsString() ) . '</pre>';
364 $html .= self
::googleSearchForm();
372 private static function googleSearchForm() {
373 global $wgSitename, $wgCanonicalServer, $wgRequest;
375 $usegoogle = htmlspecialchars( self
::msg(
377 'You can try searching via Google in the meantime.'
379 $outofdate = htmlspecialchars( self
::msg(
381 'Note that their indexes of our content may be out of date.'
383 $googlesearch = htmlspecialchars( self
::msg( 'searchbutton', 'Search' ) );
384 $search = htmlspecialchars( $wgRequest->getVal( 'search' ) );
385 $server = htmlspecialchars( $wgCanonicalServer );
386 $sitename = htmlspecialchars( $wgSitename );
388 <div style="margin: 1.5em">$usegoogle<br />
389 <small>$outofdate</small>
391 <form method="get" action="//www.google.com/search" id="googlesearch">
392 <input type="hidden" name="domains" value="$server" />
393 <input type="hidden" name="num" value="50" />
394 <input type="hidden" name="ie" value="UTF-8" />
395 <input type="hidden" name="oe" value="UTF-8" />
396 <input type="text" name="q" size="31" maxlength="255" value="$search" />
397 <input type="submit" name="btnG" value="$googlesearch" />
399 <label><input type="radio" name="sitesearch" value="$server" checked="checked" />$sitename</label>
400 <label><input type="radio" name="sitesearch" value="" />WWW</label>