-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
MWExceptionRenderer.php
418 lines (379 loc) 路 12.2 KB
/
MWExceptionRenderer.php
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
<?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
* @author Aaron Schulz
*/
/**
* Class to expose exceptions to the client (API bots, users, admins using CLI scripts)
* @since 1.28
*/
class MWExceptionRenderer {
const AS_RAW = 1; // show as text
const AS_PRETTY = 2; // show as HTML
/**
* @param Exception|Throwable $e Original exception
* @param integer $mode MWExceptionExposer::AS_* constant
* @param Exception|Throwable|null $eNew New exception from attempting to show the first
*/
public static function output( $e, $mode, $eNew = null ) {
global $wgMimeType;
if ( defined( 'MW_API' ) ) {
// Unhandled API exception, we can't be sure that format printer is alive
self::header( 'MediaWiki-API-Error: internal_api_error_' . get_class( $e ) );
wfHttpError( 500, 'Internal Server Error', self::getText( $e ) );
} elseif ( self::isCommandLine() ) {
self::printError( self::getText( $e ) );
} elseif ( $mode === self::AS_PRETTY ) {
if ( $e instanceof DBConnectionError ) {
self::reportOutageHTML( $e );
} else {
self::statusHeader( 500 );
self::header( "Content-Type: $wgMimeType; charset=utf-8" );
self::reportHTML( $e );
}
} else {
if ( $eNew ) {
$message = "MediaWiki internal error.\n\n";
if ( self::showBackTrace( $e ) ) {
$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 .= "Exception caught inside exception handler.\n\n" .
self::getShowBacktraceError( $e );
}
$message .= "\n";
} else {
if ( self::showBackTrace( $e ) ) {
$message = MWExceptionHandler::getLogMessage( $e ) .
"\nBacktrace:\n" .
MWExceptionHandler::getRedactedTraceAsString( $e ) . "\n";
} else {
$message = MWExceptionHandler::getPublicLogMessage( $e );
}
}
if ( self::isCommandLine() ) {
self::printError( $message );
} else {
echo nl2br( htmlspecialchars( $message ) ) . "\n";
}
}
}
/**
* Run hook to allow extensions to modify the text of the exception
*
* Called by MWException for b/c
*
* @param Exception|Throwable $e
* @param string $name Class name of the exception
* @param array $args Arguments to pass to the callback functions
* @return string|null String to output or null if any hook has been called
*/
public static function runHooks( $e, $name, $args = [] ) {
global $wgExceptionHooks;
if ( !isset( $wgExceptionHooks ) || !is_array( $wgExceptionHooks ) ) {
return null; // Just silently ignore
}
if ( !array_key_exists( $name, $wgExceptionHooks ) ||
!is_array( $wgExceptionHooks[$name] )
) {
return null;
}
$hooks = $wgExceptionHooks[$name];
$callargs = array_merge( [ $e ], $args );
foreach ( $hooks as $hook ) {
if (
is_string( $hook ) ||
( is_array( $hook ) && count( $hook ) >= 2 && is_string( $hook[0] ) )
) {
// 'function' or [ 'class', 'hook' ]
$result = call_user_func_array( $hook, $callargs );
} else {
$result = null;
}
if ( is_string( $result ) ) {
return $result;
}
}
return null;
}
/**
* @param Exception|Throwable $e
* @return bool Should the exception use $wgOut to output the error?
*/
private static function useOutputPage( $e ) {
// Can the extension use the Message class/wfMessage to get i18n-ed messages?
foreach ( $e->getTrace() as $frame ) {
if ( isset( $frame['class'] ) && $frame['class'] === 'LocalisationCache' ) {
return false;
}
}
return (
!empty( $GLOBALS['wgFullyInitialised'] ) &&
!empty( $GLOBALS['wgOut'] ) &&
!defined( 'MEDIAWIKI_INSTALL' )
);
}
/**
* Output the exception report using HTML
*
* @param Exception|Throwable $e
*/
private static function reportHTML( $e ) {
global $wgOut, $wgSitename;
if ( self::useOutputPage( $e ) ) {
if ( $e instanceof MWException ) {
$wgOut->prepareErrorPage( $e->getPageTitle() );
} elseif ( $e instanceof DBReadOnlyError ) {
$wgOut->prepareErrorPage( self::msg( 'readonly', 'Database is locked' ) );
} elseif ( $e instanceof DBExpectedError ) {
$wgOut->prepareErrorPage( self::msg( 'databaseerror', 'Database error' ) );
} else {
$wgOut->prepareErrorPage( self::msg( 'internalerror', 'Internal error' ) );
}
$hookResult = self::runHooks( $e, get_class( $e ) );
if ( $hookResult ) {
$wgOut->addHTML( $hookResult );
} else {
// Show any custom GUI message before the details
if ( $e instanceof MessageSpecifier ) {
$wgOut->addHTML( Message::newFromSpecifier( $e )->escaped() );
}
$wgOut->addHTML( self::getHTML( $e ) );
}
$wgOut->output();
} else {
self::header( 'Content-Type: text/html; charset=utf-8' );
$pageTitle = self::msg( 'internalerror', 'Internal error' );
echo "<!DOCTYPE html>\n" .
'<html><head>' .
// Mimick OutputPage::setPageTitle behaviour
'<title>' .
htmlspecialchars( self::msg( 'pagetitle', "$1 - $wgSitename", $pageTitle ) ) .
'</title>' .
'<style>body { font-family: sans-serif; margin: 0; padding: 0.5em 2em; }</style>' .
"</head><body>\n";
$hookResult = self::runHooks( $e, get_class( $e ) . 'Raw' );
if ( $hookResult ) {
echo $hookResult;
} else {
echo self::getHTML( $e );
}
echo "</body></html>\n";
}
}
/**
* If $wgShowExceptionDetails is true, return a HTML message with a
* backtrace to the error, otherwise show a message to ask to set it to true
* to show that information.
*
* @param Exception|Throwable $e
* @return string Html to output
*/
public static function getHTML( $e ) {
if ( self::showBackTrace( $e ) ) {
$html = "<div class=\"errorbox\"><p>" .
nl2br( htmlspecialchars( MWExceptionHandler::getLogMessage( $e ) ) ) .
'</p><p>Backtrace:</p><p>' .
nl2br( htmlspecialchars( MWExceptionHandler::getRedactedTraceAsString( $e ) ) ) .
"</p></div>\n";
} else {
$logId = WebRequest::getRequestId();
$html = "<div class=\"errorbox\">" .
'[' . $logId . '] ' .
gmdate( 'Y-m-d H:i:s' ) . ": " .
self::msg( "internalerror-fatal-exception",
"Fatal exception of type $1",
get_class( $e ),
$logId,
MWExceptionHandler::getURL()
) . "</div>\n" .
"<!-- " . wordwrap( self::getShowBacktraceError( $e ), 50 ) . " -->";
}
return $html;
}
/**
* Get a message from i18n
*
* @param string $key Message name
* @param string $fallback Default message if the message cache can't be
* called by the exception
* The function also has other parameters that are arguments for the message
* @return string Message with arguments replaced
*/
private static function msg( $key, $fallback /*[, params...] */ ) {
$args = array_slice( func_get_args(), 2 );
try {
return wfMessage( $key, $args )->text();
} catch ( Exception $e ) {
return wfMsgReplaceArgs( $fallback, $args );
}
}
/**
* @param Exception|Throwable $e
* @return string
*/
private static function getText( $e ) {
if ( self::showBackTrace( $e ) ) {
return MWExceptionHandler::getLogMessage( $e ) .
"\nBacktrace:\n" .
MWExceptionHandler::getRedactedTraceAsString( $e ) . "\n";
} else {
return self::getShowBacktraceError( $e );
}
}
/**
* @param Exception|Throwable $e
* @return bool
*/
private static function showBackTrace( $e ) {
global $wgShowExceptionDetails, $wgShowDBErrorBacktrace;
return (
$wgShowExceptionDetails &&
( !( $e instanceof DBError ) || $wgShowDBErrorBacktrace )
);
}
/**
* @param Exception|Throwable $e
* @return string
*/
private static function getShowBacktraceError( $e ) {
global $wgShowExceptionDetails, $wgShowDBErrorBacktrace;
$vars = [];
if ( !$wgShowExceptionDetails ) {
$vars[] = '$wgShowExceptionDetails = true;';
}
if ( $e instanceof DBError && !$wgShowDBErrorBacktrace ) {
$vars[] = '$wgShowDBErrorBacktrace = true;';
}
$vars = implode( ' and ', $vars );
return "Set $vars at the bottom of LocalSettings.php to show detailed debugging information";
}
/**
* @return bool
*/
private static function isCommandLine() {
return !empty( $GLOBALS['wgCommandLineMode'] );
}
/**
* @param string $header
*/
private static function header( $header ) {
if ( !headers_sent() ) {
header( $header );
}
}
/**
* @param integer $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)
*
* @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 (bug #15602). Try to produce meaningful output anyway. Using
// echo may corrupt output to STDOUT though.
if ( defined( 'STDERR' ) ) {
fwrite( STDERR, $message );
} else {
echo $message;
}
}
/**
* @param Exception|Throwable $e
*/
private static function reportOutageHTML( $e ) {
global $wgShowDBErrorBacktrace, $wgShowHostnames, $wgShowSQLErrors;
$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 ( $wgShowHostnames || $wgShowSQLErrors ) {
$info = str_replace(
'$1',
Html::element( 'span', [ 'dir' => 'ltr' ], htmlspecialchars( $e->getMessage() ) ),
htmlspecialchars( self::msg( 'dberr-info', '($1)' ) )
);
} else {
$info = htmlspecialchars( self::msg(
'dberr-info-hidden',
'(Cannot access the database)'
) );
}
MessageCache::singleton()->disable(); // no DB access
$html = "<h1>$sorry</h1><p>$again</p><p><small>$info</small></p>";
if ( $wgShowDBErrorBacktrace ) {
$html .= '<p>Backtrace:</p><pre>' .
htmlspecialchars( $e->getTraceAsString() ) . '</pre>';
}
$html .= '<hr />';
$html .= self::googleSearchForm();
echo $html;
}
/**
* @return string
*/
private static function googleSearchForm() {
global $wgSitename, $wgCanonicalServer, $wgRequest;
$usegoogle = htmlspecialchars( self::msg(
'dberr-usegoogle',
'You can try searching via Google in the meantime.'
) );
$outofdate = htmlspecialchars( self::msg(
'dberr-outofdate',
'Note that their indexes of our content may be out of date.'
) );
$googlesearch = htmlspecialchars( self::msg( 'searchbutton', 'Search' ) );
$search = htmlspecialchars( $wgRequest->getVal( 'search' ) );
$server = htmlspecialchars( $wgCanonicalServer );
$sitename = htmlspecialchars( $wgSitename );
$trygoogle = <<<EOT
<div style="margin: 1.5em">$usegoogle<br />
<small>$outofdate</small>
</div>
<form method="get" action="//www.google.com/search" id="googlesearch">
<input type="hidden" name="domains" value="$server" />
<input type="hidden" name="num" value="50" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="hidden" name="oe" value="UTF-8" />
<input type="text" name="q" size="31" maxlength="255" value="$search" />
<input type="submit" name="btnG" value="$googlesearch" />
<p>
<label><input type="radio" name="sitesearch" value="$server" checked="checked" />$sitename</label>
<label><input type="radio" name="sitesearch" value="" />WWW</label>
</p>
</form>
EOT;
return $trygoogle;
}
}