Merge "Improve serialization of Message, Title"

[lhc/web/wiklou.git] / includes / debug / logger / LegacyLogger.php

diff --git a/includes/debug/logger/LegacyLogger.php b/includes/debug/logger/LegacyLogger.php
index 6027375..8010790 100644 (file)
--- a/includes/debug/logger/LegacyLogger.php
+++ b/includes/debug/logger/LegacyLogger.php
@@ -22,6 +22,7 @@ namespace MediaWiki\Logger;
 
 use DateTimeZone;
 use MWDebug;
+use MWExceptionHandler;
 use Psr\Log\AbstractLogger;
 use Psr\Log\LogLevel;
 use UDPTransport;
@@ -167,7 +168,7 @@ class LegacyLogger extends AbstractLogger {
         * @return string
         */
        public static function format( $channel, $message, $context ) {
-               global $wgDebugLogGroups;
+               global $wgDebugLogGroups, $wgLogExceptionBacktrace;
 
                if ( $channel === 'wfDebug' ) {
                        $text = self::formatAsWfDebug( $channel, $message, $context );
@@ -181,7 +182,7 @@ class LegacyLogger extends AbstractLogger {
                } elseif ( $channel === 'profileoutput' ) {
                        // Legacy wfLogProfilingData formatitng
                        $forward = '';
-                       if ( isset( $context['forwarded_for'] )) {
+                       if ( isset( $context['forwarded_for'] ) ) {
                                $forward = " forwarded for {$context['forwarded_for']}";
                        }
                        if ( isset( $context['client_ip'] ) ) {
@@ -215,6 +216,16 @@ class LegacyLogger extends AbstractLogger {
                        $text = self::formatAsWfDebugLog( $channel, $message, $context );
                }
 
+               // Append stacktrace of exception if available
+               if ( $wgLogExceptionBacktrace &&
+                       isset( $context['exception'] ) &&
+                       $context['exception'] instanceof Exception
+               ) {
+                       $text .= MWExceptionHandler::getRedactedTraceAsString(
+                               $context['exception']->getTraceAsString()
+                       ) . "\n";
+               }
+
                return self::interpolate( $text, $context );
        }
 
@@ -301,7 +312,7 @@ class LegacyLogger extends AbstractLogger {
                if ( strpos( $message, '{' ) !== false ) {
                        $replace = array();
                        foreach ( $context as $key => $val ) {
-                               $replace['{' . $key . '}'] = $val;
+                               $replace['{' . $key . '}'] = self::flatten( $val );
                        }
                        $message = strtr( $message, $replace );
                }
@@ -309,6 +320,66 @@ class LegacyLogger extends AbstractLogger {
        }
 
 
+       /**
+        * Convert a logging context element to a string suitable for
+        * interpolation.
+        *
+        * @param mixed $item
+        * @return string
+        */
+       protected static function flatten( $item ) {
+               if ( null === $item ) {
+                       return '[Null]';
+               }
+
+               if ( is_bool( $item ) ) {
+                       return $item ? 'true' : 'false';
+               }
+
+               if ( is_float( $item ) ) {
+                       if ( is_infinite( $item ) ) {
+                               return ( $item > 0 ? '' : '-' ) . 'INF';
+                       }
+                       if ( is_nan( $item ) ) {
+                               return 'NaN';
+                       }
+                       return $data;
+               }
+
+               if ( is_scalar( $item ) ) {
+                       return (string) $item;
+               }
+
+               if ( is_array( $item ) ) {
+                       return '[Array(' . count( $item ) . ')]';
+               }
+
+               if ( $item instanceof \DateTime ) {
+                       return $item->format( 'c' );
+               }
+
+               if ( $item instanceof \Exception ) {
+                       return '[Exception ' . get_class( $item ) . '( ' .
+                               $item->getFile() . ':' . $item->getLine() . ') ' .
+                               $item->getMessage() . ']';
+               }
+
+               if ( is_object( $item ) ) {
+                       if ( method_exists( $item, '__toString' ) ) {
+                               return (string) $item;
+                       }
+
+                       return '[Object ' . get_class( $item ) . ']';
+               }
+
+               if ( is_resource( $item ) ) {
+                       return '[Resource ' . get_resource_type( $item ) . ']';
+               }
+
+               return '[Unknown ' . gettype( $item ) . ']';
+       }
+
+
        /**
         * Select the appropriate log output destination for the given log event.
         *
@@ -365,7 +436,7 @@ class LegacyLogger extends AbstractLogger {
                        $transport = UDPTransport::newFromString( $file );
                        $transport->emit( $text );
                } else {
-                       wfSuppressWarnings();
+                       \MediaWiki\suppressWarnings();
                        $exists = file_exists( $file );
                        $size = $exists ? filesize( $file ) : false;
                        if ( !$exists ||
@@ -373,7 +444,7 @@ class LegacyLogger extends AbstractLogger {
                        ) {
                                file_put_contents( $file, $text, FILE_APPEND );
                        }
-                       wfRestoreWarnings();
+                       \MediaWiki\restoreWarnings();
                }
        }