Merge "Rewrite pref cleanup script"
[lhc/web/wiklou.git] / includes / exception / MWExceptionHandler.php
1 <?php
2 /**
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.
7 *
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.
12 *
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
17 *
18 * @file
19 */
20
21 use MediaWiki\Logger\LoggerFactory;
22 use MediaWiki\MediaWikiServices;
23 use Psr\Log\LogLevel;
24 use Wikimedia\Rdbms\DBError;
25
26 /**
27 * Handler class for MWExceptions
28 * @ingroup Exception
29 */
30 class MWExceptionHandler {
31 const CAUGHT_BY_HANDLER = 'mwe_handler'; // error reported by this exception handler
32 const CAUGHT_BY_OTHER = 'other'; // error reported by direct logException() call
33
34 /**
35 * @var string $reservedMemory
36 */
37 protected static $reservedMemory;
38 /**
39 * @var array $fatalErrorTypes
40 */
41 protected static $fatalErrorTypes = [
42 E_ERROR, E_PARSE, E_CORE_ERROR, E_COMPILE_ERROR, E_USER_ERROR,
43 /* HHVM's FATAL_ERROR level */ 16777217,
44 ];
45 /**
46 * @var bool $handledFatalCallback
47 */
48 protected static $handledFatalCallback = false;
49
50 /**
51 * Install handlers with PHP.
52 */
53 public static function installHandler() {
54 set_exception_handler( 'MWExceptionHandler::handleUncaughtException' );
55 set_error_handler( 'MWExceptionHandler::handleError' );
56
57 // Reserve 16k of memory so we can report OOM fatals
58 self::$reservedMemory = str_repeat( ' ', 16384 );
59 register_shutdown_function( 'MWExceptionHandler::handleFatalError' );
60 }
61
62 /**
63 * Report an exception to the user
64 * @param Exception|Throwable $e
65 */
66 protected static function report( $e ) {
67 try {
68 // Try and show the exception prettily, with the normal skin infrastructure
69 if ( $e instanceof MWException ) {
70 // Delegate to MWException until all subclasses are handled by
71 // MWExceptionRenderer and MWException::report() has been
72 // removed.
73 $e->report();
74 } else {
75 MWExceptionRenderer::output( $e, MWExceptionRenderer::AS_PRETTY );
76 }
77 } catch ( Exception $e2 ) {
78 // Exception occurred from within exception handler
79 // Show a simpler message for the original exception,
80 // don't try to invoke report()
81 MWExceptionRenderer::output( $e, MWExceptionRenderer::AS_RAW, $e2 );
82 }
83 }
84
85 /**
86 * Roll back any open database transactions and log the stack trace of the exception
87 *
88 * This method is used to attempt to recover from exceptions
89 *
90 * @since 1.23
91 * @param Exception|Throwable $e
92 */
93 public static function rollbackMasterChangesAndLog( $e ) {
94 $services = MediaWikiServices::getInstance();
95 if ( !$services->isServiceDisabled( 'DBLoadBalancerFactory' ) ) {
96 // Rollback DBs to avoid transaction notices. This might fail
97 // to rollback some databases due to connection issues or exceptions.
98 // However, any sane DB driver will rollback implicitly anyway.
99 try {
100 $services->getDBLoadBalancerFactory()->rollbackMasterChanges( __METHOD__ );
101 } catch ( DBError $e2 ) {
102 // If the DB is unreacheable, rollback() will throw an error
103 // and the error report() method might need messages from the DB,
104 // which would result in an exception loop. PHP may escalate such
105 // errors to "Exception thrown without a stack frame" fatals, but
106 // it's better to be explicit here.
107 self::logException( $e2, self::CAUGHT_BY_HANDLER );
108 }
109 }
110
111 self::logException( $e, self::CAUGHT_BY_HANDLER );
112 }
113
114 /**
115 * Callback to use with PHP's set_exception_handler.
116 *
117 * @since 1.31
118 * @param Exception|Throwable $e
119 */
120 public static function handleUncaughtException( $e ) {
121 self::handleException( $e );
122
123 // Make sure we don't claim success on exit for CLI scripts (T177414)
124 if ( wfIsCLI() ) {
125 register_shutdown_function(
126 function () {
127 exit( 255 );
128 }
129 );
130 }
131 }
132
133 /**
134 * Exception handler which simulates the appropriate catch() handling:
135 *
136 * try {
137 * ...
138 * } catch ( Exception $e ) {
139 * $e->report();
140 * } catch ( Exception $e ) {
141 * echo $e->__toString();
142 * }
143 *
144 * @since 1.25
145 * @param Exception|Throwable $e
146 */
147 public static function handleException( $e ) {
148 self::rollbackMasterChangesAndLog( $e );
149 self::report( $e );
150 }
151
152 /**
153 * Handler for set_error_handler() callback notifications.
154 *
155 * Receive a callback from the interpreter for a raised error, create an
156 * ErrorException, and log the exception to the 'error' logging
157 * channel(s). If the raised error is a fatal error type (only under HHVM)
158 * delegate to handleFatalError() instead.
159 *
160 * @since 1.25
161 *
162 * @param int $level Error level raised
163 * @param string $message
164 * @param string $file
165 * @param int $line
166 * @return bool
167 *
168 * @see logError()
169 */
170 public static function handleError(
171 $level, $message, $file = null, $line = null
172 ) {
173 if ( in_array( $level, self::$fatalErrorTypes ) ) {
174 return call_user_func_array(
175 'MWExceptionHandler::handleFatalError', func_get_args()
176 );
177 }
178
179 // Map error constant to error name (reverse-engineer PHP error
180 // reporting)
181 switch ( $level ) {
182 case E_RECOVERABLE_ERROR:
183 $levelName = 'Error';
184 $severity = LogLevel::ERROR;
185 break;
186 case E_WARNING:
187 case E_CORE_WARNING:
188 case E_COMPILE_WARNING:
189 case E_USER_WARNING:
190 $levelName = 'Warning';
191 $severity = LogLevel::WARNING;
192 break;
193 case E_NOTICE:
194 case E_USER_NOTICE:
195 $levelName = 'Notice';
196 $severity = LogLevel::INFO;
197 break;
198 case E_STRICT:
199 $levelName = 'Strict Standards';
200 $severity = LogLevel::DEBUG;
201 break;
202 case E_DEPRECATED:
203 case E_USER_DEPRECATED:
204 $levelName = 'Deprecated';
205 $severity = LogLevel::INFO;
206 break;
207 default:
208 $levelName = 'Unknown error';
209 $severity = LogLevel::ERROR;
210 break;
211 }
212
213 $e = new ErrorException( "PHP $levelName: $message", 0, $level, $file, $line );
214 self::logError( $e, 'error', $severity );
215
216 // This handler is for logging only. Return false will instruct PHP
217 // to continue regular handling.
218 return false;
219 }
220
221 /**
222 * Dual purpose callback used as both a set_error_handler() callback and
223 * a registered shutdown function. Receive a callback from the interpreter
224 * for a raised error or system shutdown, check for a fatal error, and log
225 * to the 'fatal' logging channel.
226 *
227 * Special handling is included for missing class errors as they may
228 * indicate that the user needs to install 3rd-party libraries via
229 * Composer or other means.
230 *
231 * @since 1.25
232 *
233 * @param int $level Error level raised
234 * @param string $message Error message
235 * @param string $file File that error was raised in
236 * @param int $line Line number error was raised at
237 * @param array $context Active symbol table point of error
238 * @param array $trace Backtrace at point of error (undocumented HHVM
239 * feature)
240 * @return bool Always returns false
241 */
242 public static function handleFatalError(
243 $level = null, $message = null, $file = null, $line = null,
244 $context = null, $trace = null
245 ) {
246 // Free reserved memory so that we have space to process OOM
247 // errors
248 self::$reservedMemory = null;
249
250 if ( $level === null ) {
251 // Called as a shutdown handler, get data from error_get_last()
252 if ( static::$handledFatalCallback ) {
253 // Already called once (probably as an error handler callback
254 // under HHVM) so don't log again.
255 return false;
256 }
257
258 $lastError = error_get_last();
259 if ( $lastError !== null ) {
260 $level = $lastError['type'];
261 $message = $lastError['message'];
262 $file = $lastError['file'];
263 $line = $lastError['line'];
264 } else {
265 $level = 0;
266 $message = '';
267 }
268 }
269
270 if ( !in_array( $level, self::$fatalErrorTypes ) ) {
271 // Only interested in fatal errors, others should have been
272 // handled by MWExceptionHandler::handleError
273 return false;
274 }
275
276 $msg = "[{exception_id}] PHP Fatal Error: {$message}";
277
278 // Look at message to see if this is a class not found failure
279 // HHVM: Class undefined: foo
280 // PHP5: Class 'foo' not found
281 if ( preg_match( "/Class (undefined: \w+|'\w+' not found)/", $msg ) ) {
282 // phpcs:disable Generic.Files.LineLength
283 $msg = <<<TXT
284 {$msg}
285
286 MediaWiki or an installed extension requires this class but it is not embedded directly in MediaWiki's git repository and must be installed separately by the end user.
287
288 Please see <a href="https://www.mediawiki.org/wiki/Download_from_Git#Fetch_external_libraries">mediawiki.org</a> for help on installing the required components.
289 TXT;
290 // phpcs:enable
291 }
292
293 // We can't just create an exception and log it as it is likely that
294 // the interpreter has unwound the stack already. If that is true the
295 // stacktrace we would get would be functionally empty. If however we
296 // have been called as an error handler callback *and* HHVM is in use
297 // we will have been provided with a useful stacktrace that we can
298 // log.
299 $trace = $trace ?: debug_backtrace();
300 $logger = LoggerFactory::getInstance( 'fatal' );
301 $logger->error( $msg, [
302 'fatal_exception' => [
303 'class' => ErrorException::class,
304 'message' => "PHP Fatal Error: {$message}",
305 'code' => $level,
306 'file' => $file,
307 'line' => $line,
308 'trace' => static::redactTrace( $trace ),
309 ],
310 'exception_id' => wfRandomString( 8 ),
311 'caught_by' => self::CAUGHT_BY_HANDLER
312 ] );
313
314 // Remember call so we don't double process via HHVM's fatal
315 // notifications and the shutdown hook behavior
316 static::$handledFatalCallback = true;
317 return false;
318 }
319
320 /**
321 * Generate a string representation of an exception's stack trace
322 *
323 * Like Exception::getTraceAsString, but replaces argument values with
324 * argument type or class name.
325 *
326 * @param Exception|Throwable $e
327 * @return string
328 * @see prettyPrintTrace()
329 */
330 public static function getRedactedTraceAsString( $e ) {
331 return self::prettyPrintTrace( self::getRedactedTrace( $e ) );
332 }
333
334 /**
335 * Generate a string representation of a stacktrace.
336 *
337 * @param array $trace
338 * @param string $pad Constant padding to add to each line of trace
339 * @return string
340 * @since 1.26
341 */
342 public static function prettyPrintTrace( array $trace, $pad = '' ) {
343 $text = '';
344
345 $level = 0;
346 foreach ( $trace as $level => $frame ) {
347 if ( isset( $frame['file'] ) && isset( $frame['line'] ) ) {
348 $text .= "{$pad}#{$level} {$frame['file']}({$frame['line']}): ";
349 } else {
350 // 'file' and 'line' are unset for calls via call_user_func
351 // (T57634) This matches behaviour of
352 // Exception::getTraceAsString to instead display "[internal
353 // function]".
354 $text .= "{$pad}#{$level} [internal function]: ";
355 }
356
357 if ( isset( $frame['class'] ) && isset( $frame['type'] ) && isset( $frame['function'] ) ) {
358 $text .= $frame['class'] . $frame['type'] . $frame['function'];
359 } elseif ( isset( $frame['function'] ) ) {
360 $text .= $frame['function'];
361 } else {
362 $text .= 'NO_FUNCTION_GIVEN';
363 }
364
365 if ( isset( $frame['args'] ) ) {
366 $text .= '(' . implode( ', ', $frame['args'] ) . ")\n";
367 } else {
368 $text .= "()\n";
369 }
370 }
371
372 $level = $level + 1;
373 $text .= "{$pad}#{$level} {main}";
374
375 return $text;
376 }
377
378 /**
379 * Return a copy of an exception's backtrace as an array.
380 *
381 * Like Exception::getTrace, but replaces each element in each frame's
382 * argument array with the name of its class (if the element is an object)
383 * or its type (if the element is a PHP primitive).
384 *
385 * @since 1.22
386 * @param Exception|Throwable $e
387 * @return array
388 */
389 public static function getRedactedTrace( $e ) {
390 return static::redactTrace( $e->getTrace() );
391 }
392
393 /**
394 * Redact a stacktrace generated by Exception::getTrace(),
395 * debug_backtrace() or similar means. Replaces each element in each
396 * frame's argument array with the name of its class (if the element is an
397 * object) or its type (if the element is a PHP primitive).
398 *
399 * @since 1.26
400 * @param array $trace Stacktrace
401 * @return array Stacktrace with arugment values converted to data types
402 */
403 public static function redactTrace( array $trace ) {
404 return array_map( function ( $frame ) {
405 if ( isset( $frame['args'] ) ) {
406 $frame['args'] = array_map( function ( $arg ) {
407 return is_object( $arg ) ? get_class( $arg ) : gettype( $arg );
408 }, $frame['args'] );
409 }
410 return $frame;
411 }, $trace );
412 }
413
414 /**
415 * Get the ID for this exception.
416 *
417 * The ID is saved so that one can match the one output to the user (when
418 * $wgShowExceptionDetails is set to false), to the entry in the debug log.
419 *
420 * @since 1.22
421 * @deprecated since 1.27: Exception IDs are synonymous with request IDs.
422 * @param Exception|Throwable $e
423 * @return string
424 */
425 public static function getLogId( $e ) {
426 wfDeprecated( __METHOD__, '1.27' );
427 return WebRequest::getRequestId();
428 }
429
430 /**
431 * If the exception occurred in the course of responding to a request,
432 * returns the requested URL. Otherwise, returns false.
433 *
434 * @since 1.23
435 * @return string|false
436 */
437 public static function getURL() {
438 global $wgRequest;
439 if ( !isset( $wgRequest ) || $wgRequest instanceof FauxRequest ) {
440 return false;
441 }
442 return $wgRequest->getRequestURL();
443 }
444
445 /**
446 * Get a message formatting the exception message and its origin.
447 *
448 * @since 1.22
449 * @param Exception|Throwable $e
450 * @return string
451 */
452 public static function getLogMessage( $e ) {
453 $id = WebRequest::getRequestId();
454 $type = get_class( $e );
455 $file = $e->getFile();
456 $line = $e->getLine();
457 $message = $e->getMessage();
458 $url = self::getURL() ?: '[no req]';
459
460 return "[$id] $url $type from line $line of $file: $message";
461 }
462
463 /**
464 * Get a normalised message for formatting with PSR-3 log event context.
465 *
466 * Must be used together with `getLogContext()` to be useful.
467 *
468 * @since 1.30
469 * @param Exception|Throwable $e
470 * @return string
471 */
472 public static function getLogNormalMessage( $e ) {
473 $type = get_class( $e );
474 $file = $e->getFile();
475 $line = $e->getLine();
476 $message = $e->getMessage();
477
478 return "[{exception_id}] {exception_url} $type from line $line of $file: $message";
479 }
480
481 /**
482 * @param Exception|Throwable $e
483 * @return string
484 */
485 public static function getPublicLogMessage( $e ) {
486 $reqId = WebRequest::getRequestId();
487 $type = get_class( $e );
488 return '[' . $reqId . '] '
489 . gmdate( 'Y-m-d H:i:s' ) . ': '
490 . 'Fatal exception of type "' . $type . '"';
491 }
492
493 /**
494 * Get a PSR-3 log event context from an Exception.
495 *
496 * Creates a structured array containing information about the provided
497 * exception that can be used to augment a log message sent to a PSR-3
498 * logger.
499 *
500 * @param Exception|Throwable $e
501 * @param string $catcher CAUGHT_BY_* class constant indicating what caught the error
502 * @return array
503 */
504 public static function getLogContext( $e, $catcher = self::CAUGHT_BY_OTHER ) {
505 return [
506 'exception' => $e,
507 'exception_id' => WebRequest::getRequestId(),
508 'exception_url' => self::getURL() ?: '[no req]',
509 'caught_by' => $catcher
510 ];
511 }
512
513 /**
514 * Get a structured representation of an Exception.
515 *
516 * Returns an array of structured data (class, message, code, file,
517 * backtrace) derived from the given exception. The backtrace information
518 * will be redacted as per getRedactedTraceAsArray().
519 *
520 * @param Exception|Throwable $e
521 * @param string $catcher CAUGHT_BY_* class constant indicating what caught the error
522 * @return array
523 * @since 1.26
524 */
525 public static function getStructuredExceptionData( $e, $catcher = self::CAUGHT_BY_OTHER ) {
526 global $wgLogExceptionBacktrace;
527
528 $data = [
529 'id' => WebRequest::getRequestId(),
530 'type' => get_class( $e ),
531 'file' => $e->getFile(),
532 'line' => $e->getLine(),
533 'message' => $e->getMessage(),
534 'code' => $e->getCode(),
535 'url' => self::getURL() ?: null,
536 'caught_by' => $catcher
537 ];
538
539 if ( $e instanceof ErrorException &&
540 ( error_reporting() & $e->getSeverity() ) === 0
541 ) {
542 // Flag surpressed errors
543 $data['suppressed'] = true;
544 }
545
546 if ( $wgLogExceptionBacktrace ) {
547 $data['backtrace'] = self::getRedactedTrace( $e );
548 }
549
550 $previous = $e->getPrevious();
551 if ( $previous !== null ) {
552 $data['previous'] = self::getStructuredExceptionData( $previous, $catcher );
553 }
554
555 return $data;
556 }
557
558 /**
559 * Serialize an Exception object to JSON.
560 *
561 * The JSON object will have keys 'id', 'file', 'line', 'message', and
562 * 'url'. These keys map to string values, with the exception of 'line',
563 * which is a number, and 'url', which may be either a string URL or or
564 * null if the exception did not occur in the context of serving a web
565 * request.
566 *
567 * If $wgLogExceptionBacktrace is true, it will also have a 'backtrace'
568 * key, mapped to the array return value of Exception::getTrace, but with
569 * each element in each frame's "args" array (if set) replaced with the
570 * argument's class name (if the argument is an object) or type name (if
571 * the argument is a PHP primitive).
572 *
573 * @par Sample JSON record ($wgLogExceptionBacktrace = false):
574 * @code
575 * {
576 * "id": "c41fb419",
577 * "type": "MWException",
578 * "file": "/var/www/mediawiki/includes/cache/MessageCache.php",
579 * "line": 704,
580 * "message": "Non-string key given",
581 * "url": "/wiki/Main_Page"
582 * }
583 * @endcode
584 *
585 * @par Sample JSON record ($wgLogExceptionBacktrace = true):
586 * @code
587 * {
588 * "id": "dc457938",
589 * "type": "MWException",
590 * "file": "/vagrant/mediawiki/includes/cache/MessageCache.php",
591 * "line": 704,
592 * "message": "Non-string key given",
593 * "url": "/wiki/Main_Page",
594 * "backtrace": [{
595 * "file": "/vagrant/mediawiki/extensions/VisualEditor/VisualEditor.hooks.php",
596 * "line": 80,
597 * "function": "get",
598 * "class": "MessageCache",
599 * "type": "->",
600 * "args": ["array"]
601 * }]
602 * }
603 * @endcode
604 *
605 * @since 1.23
606 * @param Exception|Throwable $e
607 * @param bool $pretty Add non-significant whitespace to improve readability (default: false).
608 * @param int $escaping Bitfield consisting of FormatJson::.*_OK class constants.
609 * @param string $catcher CAUGHT_BY_* class constant indicating what caught the error
610 * @return string|false JSON string if successful; false upon failure
611 */
612 public static function jsonSerializeException(
613 $e, $pretty = false, $escaping = 0, $catcher = self::CAUGHT_BY_OTHER
614 ) {
615 return FormatJson::encode(
616 self::getStructuredExceptionData( $e, $catcher ),
617 $pretty,
618 $escaping
619 );
620 }
621
622 /**
623 * Log an exception to the exception log (if enabled).
624 *
625 * This method must not assume the exception is an MWException,
626 * it is also used to handle PHP exceptions or exceptions from other libraries.
627 *
628 * @since 1.22
629 * @param Exception|Throwable $e
630 * @param string $catcher CAUGHT_BY_* class constant indicating what caught the error
631 */
632 public static function logException( $e, $catcher = self::CAUGHT_BY_OTHER ) {
633 if ( !( $e instanceof MWException ) || $e->isLoggable() ) {
634 $logger = LoggerFactory::getInstance( 'exception' );
635 $logger->error(
636 self::getLogNormalMessage( $e ),
637 self::getLogContext( $e, $catcher )
638 );
639
640 $json = self::jsonSerializeException( $e, false, FormatJson::ALL_OK, $catcher );
641 if ( $json !== false ) {
642 $logger = LoggerFactory::getInstance( 'exception-json' );
643 $logger->error( $json, [ 'private' => true ] );
644 }
645
646 Hooks::run( 'LogException', [ $e, false ] );
647 }
648 }
649
650 /**
651 * Log an exception that wasn't thrown but made to wrap an error.
652 *
653 * @since 1.25
654 * @param ErrorException $e
655 * @param string $channel
656 * @param string $level
657 */
658 protected static function logError(
659 ErrorException $e, $channel, $level = LogLevel::ERROR
660 ) {
661 $catcher = self::CAUGHT_BY_HANDLER;
662 // The set_error_handler callback is independent from error_reporting.
663 // Filter out unwanted errors manually (e.g. when
664 // MediaWiki\suppressWarnings is active).
665 $suppressed = ( error_reporting() & $e->getSeverity() ) === 0;
666 if ( !$suppressed ) {
667 $logger = LoggerFactory::getInstance( $channel );
668 $logger->log(
669 $level,
670 self::getLogNormalMessage( $e ),
671 self::getLogContext( $e, $catcher )
672 );
673 }
674
675 // Include all errors in the json log (surpressed errors will be flagged)
676 $json = self::jsonSerializeException( $e, false, FormatJson::ALL_OK, $catcher );
677 if ( $json !== false ) {
678 $logger = LoggerFactory::getInstance( "{$channel}-json" );
679 $logger->log( $level, $json, [ 'private' => true ] );
680 }
681
682 Hooks::run( 'LogException', [ $e, $suppressed ] );
683 }
684 }