includes/debug/logger/LegacyLogger.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 namespace MediaWiki\Logger;
  22
  23 use DateTimeZone;
  24 use Exception;
  25 use MWDebug;
  26 use MWExceptionHandler;
  27 use Psr\Log\AbstractLogger;
  28 use Psr\Log\LogLevel;
  29 use UDPTransport;
  30
  31 /**
  32  * PSR-3 logger that mimics the historic implementation of MediaWiki's former
  33  * wfErrorLog logging implementation.
  34  *
  35  * This logger is configured by the following global configuration variables:
  36  * - `$wgDebugLogFile`
  37  * - `$wgDebugLogGroups`
  38  * - `$wgDBerrorLog`
  39  * - `$wgDBerrorLogTZ`
  40  *
  41  * See documentation in DefaultSettings.php for detailed explanations of each
  42  * variable.
  43  *
  44  * @see \MediaWiki\Logger\LoggerFactory
  45  * @since 1.25
  46  * @copyright © 2014 Wikimedia Foundation and contributors
  47  */
  48 class LegacyLogger extends AbstractLogger {
  49
  50         /**
  51          * @var string $channel
  52          */
  53         protected $channel;
  54
  55         /**
  56          * Convert \Psr\Log\LogLevel constants into int for sane comparisons
  57          * These are the same values that Monlog uses
  58          *
  59          * @var array $levelMapping
  60          */
  61         protected static $levelMapping = [
  62                 LogLevel::DEBUG => 100,
  63                 LogLevel::INFO => 200,
  64                 LogLevel::NOTICE => 250,
  65                 LogLevel::WARNING => 300,
  66                 LogLevel::ERROR => 400,
  67                 LogLevel::CRITICAL => 500,
  68                 LogLevel::ALERT => 550,
  69                 LogLevel::EMERGENCY => 600,
  70         ];
  71
  72         /**
  73          * @var array
  74          */
  75         protected static $dbChannels = [
  76                 'DBQuery' => true,
  77                 'DBConnection' => true
  78         ];
  79
  80         /**
  81          * @param string $channel
  82          */
  83         public function __construct( $channel ) {
  84                 $this->channel = $channel;
  85         }
  86
  87         /**
  88          * Logs with an arbitrary level.
  89          *
  90          * @param string|int $level
  91          * @param string $message
  92          * @param array $context
  93          * @return null
  94          */
  95         public function log( $level, $message, array $context = [] ) {
  96                 if ( is_string( $level ) ) {
  97                         $level = self::$levelMapping[$level];
  98                 }
  99                 if ( $this->channel === 'DBQuery' && isset( $context['method'] )
 100                         && isset( $context['master'] ) && isset( $context['runtime'] )
 101                 ) {
 102                         MWDebug::query( $message, $context['method'], $context['master'], $context['runtime'] );
 103                         return; // only send profiling data to MWDebug profiling
 104                 }
 105
 106                 if ( isset( self::$dbChannels[$this->channel] )
 107                         && $level >= self::$levelMapping[LogLevel::ERROR]
 108                 ) {
 109                         // Format and write DB errors to the legacy locations
 110                         $effectiveChannel = 'wfLogDBError';
 111                 } else {
 112                         $effectiveChannel = $this->channel;
 113                 }
 114
 115                 if ( self::shouldEmit( $effectiveChannel, $message, $level, $context ) ) {
 116                         $text = self::format( $effectiveChannel, $message, $context );
 117                         $destination = self::destination( $effectiveChannel, $message, $context );
 118                         self::emit( $text, $destination );
 119                 }
 120                 if ( !isset( $context['private'] ) || !$context['private'] ) {
 121                         // Add to debug toolbar if not marked as "private"
 122                         MWDebug::debugMsg( $message, [ 'channel' => $this->channel ] + $context );
 123                 }
 124         }
 125
 126         /**
 127          * Determine if the given message should be emitted or not.
 128          *
 129          * @param string $channel
 130          * @param string $message
 131          * @param string|int $level \Psr\Log\LogEvent constant or Monolog level int
 132          * @param array $context
 133          * @return bool True if message should be sent to disk/network, false
 134          * otherwise
 135          */
 136         public static function shouldEmit( $channel, $message, $level, $context ) {
 137                 global $wgDebugLogFile, $wgDBerrorLog, $wgDebugLogGroups;
 138
 139                 if ( is_string( $level ) ) {
 140                         $level = self::$levelMapping[$level];
 141                 }
 142
 143                 if ( $channel === 'wfLogDBError' ) {
 144                         // wfLogDBError messages are emitted if a database log location is
 145                         // specfied.
 146                         $shouldEmit = (bool)$wgDBerrorLog;
 147
 148                 } elseif ( $channel === 'wfDebug' ) {
 149                         // wfDebug messages are emitted if a catch all logging file has
 150                         // been specified. Checked explicitly so that 'private' flagged
 151                         // messages are not discarded by unset $wgDebugLogGroups channel
 152                         // handling below.
 153                         $shouldEmit = $wgDebugLogFile != '';
 154
 155                 } elseif ( isset( $wgDebugLogGroups[$channel] ) ) {
 156                         $logConfig = $wgDebugLogGroups[$channel];
 157
 158                         if ( is_array( $logConfig ) ) {
 159                                 $shouldEmit = true;
 160                                 if ( isset( $logConfig['sample'] ) ) {
 161                                         // Emit randomly with a 1 in 'sample' chance for each message.
 162                                         $shouldEmit = mt_rand( 1, $logConfig['sample'] ) === 1;
 163                                 }
 164
 165                                 if ( isset( $logConfig['level'] ) ) {
 166                                         $shouldEmit = $level >= self::$levelMapping[$logConfig['level']];
 167                                 }
 168                         } else {
 169                                 // Emit unless the config value is explictly false.
 170                                 $shouldEmit = $logConfig !== false;
 171                         }
 172
 173                 } elseif ( isset( $context['private'] ) && $context['private'] ) {
 174                         // Don't emit if the message didn't match previous checks based on
 175                         // the channel and the event is marked as private. This check
 176                         // discards messages sent via wfDebugLog() with dest == 'private'
 177                         // and no explicit wgDebugLogGroups configuration.
 178                         $shouldEmit = false;
 179                 } else {
 180                         // Default return value is the same as the historic wfDebug
 181                         // method: emit if $wgDebugLogFile has been set.
 182                         $shouldEmit = $wgDebugLogFile != '';
 183                 }
 184
 185                 return $shouldEmit;
 186         }
 187
 188         /**
 189          * Format a message.
 190          *
 191          * Messages to the 'wfDebug' and 'wfLogDBError' channels receive special formatting to mimic the
 192          * historic output of the functions of the same name. All other channel values are formatted
 193          * based on the historic output of the `wfDebugLog()` global function.
 194          *
 195          * @param string $channel
 196          * @param string $message
 197          * @param array $context
 198          * @return string
 199          */
 200         public static function format( $channel, $message, $context ) {
 201                 global $wgDebugLogGroups, $wgLogExceptionBacktrace;
 202
 203                 if ( $channel === 'wfDebug' ) {
 204                         $text = self::formatAsWfDebug( $channel, $message, $context );
 205
 206                 } elseif ( $channel === 'wfLogDBError' ) {
 207                         $text = self::formatAsWfLogDBError( $channel, $message, $context );
 208
 209                 } elseif ( $channel === 'profileoutput' ) {
 210                         // Legacy wfLogProfilingData formatitng
 211                         $forward = '';
 212                         if ( isset( $context['forwarded_for'] ) ) {
 213                                 $forward = " forwarded for {$context['forwarded_for']}";
 214                         }
 215                         if ( isset( $context['client_ip'] ) ) {
 216                                 $forward .= " client IP {$context['client_ip']}";
 217                         }
 218                         if ( isset( $context['from'] ) ) {
 219                                 $forward .= " from {$context['from']}";
 220                         }
 221                         if ( $forward ) {
 222                                 $forward = "\t(proxied via {$context['proxy']}{$forward})";
 223                         }
 224                         if ( $context['anon'] ) {
 225                                 $forward .= ' anon';
 226                         }
 227                         if ( !isset( $context['url'] ) ) {
 228                                 $context['url'] = 'n/a';
 229                         }
 230
 231                         $log = sprintf( "%s\t%04.3f\t%s%s\n",
 232                                 gmdate( 'YmdHis' ), $context['elapsed'], $context['url'], $forward );
 233
 234                         $text = self::formatAsWfDebugLog(
 235                                 $channel, $log . $context['output'], $context );
 236
 237                 } elseif ( !isset( $wgDebugLogGroups[$channel] ) ) {
 238                         $text = self::formatAsWfDebug(
 239                                 $channel, "[{$channel}] {$message}", $context );
 240
 241                 } else {
 242                         // Default formatting is wfDebugLog's historic style
 243                         $text = self::formatAsWfDebugLog( $channel, $message, $context );
 244                 }
 245
 246                 // Append stacktrace of exception if available
 247                 if ( $wgLogExceptionBacktrace && isset( $context['exception'] ) ) {
 248                         $e = $context['exception'];
 249                         $backtrace = false;
 250
 251                         if ( $e instanceof Exception ) {
 252                                 $backtrace = MWExceptionHandler::getRedactedTrace( $e );
 253
 254                         } elseif ( is_array( $e ) && isset( $e['trace'] ) ) {
 255                                 // Exception has already been unpacked as structured data
 256                                 $backtrace = $e['trace'];
 257                         }
 258
 259                         if ( $backtrace ) {
 260                                 $text .= MWExceptionHandler::prettyPrintTrace( $backtrace ) .
 261                                         "\n";
 262                         }
 263                 }
 264
 265                 return self::interpolate( $text, $context );
 266         }
 267
 268         /**
 269          * Format a message as `wfDebug()` would have formatted it.
 270          *
 271          * @param string $channel
 272          * @param string $message
 273          * @param array $context
 274          * @return string
 275          */
 276         protected static function formatAsWfDebug( $channel, $message, $context ) {
 277                 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $message );
 278                 if ( isset( $context['seconds_elapsed'] ) ) {
 279                         // Prepend elapsed request time and real memory usage with two
 280                         // trailing spaces.
 281                         $text = "{$context['seconds_elapsed']} {$context['memory_used']}  {$text}";
 282                 }
 283                 if ( isset( $context['prefix'] ) ) {
 284                         $text = "{$context['prefix']}{$text}";
 285                 }
 286                 return "{$text}\n";
 287         }
 288
 289         /**
 290          * Format a message as `wfLogDBError()` would have formatted it.
 291          *
 292          * @param string $channel
 293          * @param string $message
 294          * @param array $context
 295          * @return string
 296          */
 297         protected static function formatAsWfLogDBError( $channel, $message, $context ) {
 298                 global $wgDBerrorLogTZ;
 299                 static $cachedTimezone = null;
 300
 301                 if ( !$cachedTimezone ) {
 302                         $cachedTimezone = new DateTimeZone( $wgDBerrorLogTZ );
 303                 }
 304
 305                 $d = date_create( 'now', $cachedTimezone );
 306                 $date = $d->format( 'D M j G:i:s T Y' );
 307
 308                 $host = wfHostname();
 309                 $wiki = wfWikiID();
 310
 311                 $text = "{$date}\t{$host}\t{$wiki}\t{$message}\n";
 312                 return $text;
 313         }
 314
 315         /**
 316          * Format a message as `wfDebugLog() would have formatted it.
 317          *
 318          * @param string $channel
 319          * @param string $message
 320          * @param array $context
 321          * @return string
 322          */
 323         protected static function formatAsWfDebugLog( $channel, $message, $context ) {
 324                 $time = wfTimestamp( TS_DB );
 325                 $wiki = wfWikiID();
 326                 $host = wfHostname();
 327                 $text = "{$time} {$host} {$wiki}: {$message}\n";
 328                 return $text;
 329         }
 330
 331         /**
 332          * Interpolate placeholders in logging message.
 333          *
 334          * @param string $message
 335          * @param array $context
 336          * @return string Interpolated message
 337          */
 338         public static function interpolate( $message, array $context ) {
 339                 if ( strpos( $message, '{' ) !== false ) {
 340                         $replace = [];
 341                         foreach ( $context as $key => $val ) {
 342                                 $replace['{' . $key . '}'] = self::flatten( $val );
 343                         }
 344                         $message = strtr( $message, $replace );
 345                 }
 346                 return $message;
 347         }
 348
 349         /**
 350          * Convert a logging context element to a string suitable for
 351          * interpolation.
 352          *
 353          * @param mixed $item
 354          * @return string
 355          */
 356         protected static function flatten( $item ) {
 357                 if ( null === $item ) {
 358                         return '[Null]';
 359                 }
 360
 361                 if ( is_bool( $item ) ) {
 362                         return $item ? 'true' : 'false';
 363                 }
 364
 365                 if ( is_float( $item ) ) {
 366                         if ( is_infinite( $item ) ) {
 367                                 return ( $item > 0 ? '' : '-' ) . 'INF';
 368                         }
 369                         if ( is_nan( $item ) ) {
 370                                 return 'NaN';
 371                         }
 372                         return (string)$item;
 373                 }
 374
 375                 if ( is_scalar( $item ) ) {
 376                         return (string)$item;
 377                 }
 378
 379                 if ( is_array( $item ) ) {
 380                         return '[Array(' . count( $item ) . ')]';
 381                 }
 382
 383                 if ( $item instanceof \DateTime ) {
 384                         return $item->format( 'c' );
 385                 }
 386
 387                 if ( $item instanceof Exception ) {
 388                         return '[Exception ' . get_class( $item ) . '( ' .
 389                                 $item->getFile() . ':' . $item->getLine() . ') ' .
 390                                 $item->getMessage() . ']';
 391                 }
 392
 393                 if ( is_object( $item ) ) {
 394                         if ( method_exists( $item, '__toString' ) ) {
 395                                 return (string)$item;
 396                         }
 397
 398                         return '[Object ' . get_class( $item ) . ']';
 399                 }
 400
 401                 if ( is_resource( $item ) ) {
 402                         return '[Resource ' . get_resource_type( $item ) . ']';
 403                 }
 404
 405                 return '[Unknown ' . gettype( $item ) . ']';
 406         }
 407
 408         /**
 409          * Select the appropriate log output destination for the given log event.
 410          *
 411          * If the event context contains 'destination'
 412          *
 413          * @param string $channel
 414          * @param string $message
 415          * @param array $context
 416          * @return string
 417          */
 418         protected static function destination( $channel, $message, $context ) {
 419                 global $wgDebugLogFile, $wgDBerrorLog, $wgDebugLogGroups;
 420
 421                 // Default destination is the debug log file as historically used by
 422                 // the wfDebug function.
 423                 $destination = $wgDebugLogFile;
 424
 425                 if ( isset( $context['destination'] ) ) {
 426                         // Use destination explicitly provided in context
 427                         $destination = $context['destination'];
 428
 429                 } elseif ( $channel === 'wfDebug' ) {
 430                         $destination = $wgDebugLogFile;
 431
 432                 } elseif ( $channel === 'wfLogDBError' ) {
 433                         $destination = $wgDBerrorLog;
 434
 435                 } elseif ( isset( $wgDebugLogGroups[$channel] ) ) {
 436                         $logConfig = $wgDebugLogGroups[$channel];
 437
 438                         if ( is_array( $logConfig ) ) {
 439                                 $destination = $logConfig['destination'];
 440                         } else {
 441                                 $destination = strval( $logConfig );
 442                         }
 443                 }
 444
 445                 return $destination;
 446         }
 447
 448         /**
 449          * Log to a file without getting "file size exceeded" signals.
 450          *
 451          * Can also log to UDP with the syntax udp://host:port/prefix. This will send
 452          * lines to the specified port, prefixed by the specified prefix and a space.
 453          *
 454          * @param string $text
 455          * @param string $file Filename
 456          */
 457         public static function emit( $text, $file ) {
 458                 if ( substr( $file, 0, 4 ) == 'udp:' ) {
 459                         $transport = UDPTransport::newFromString( $file );
 460                         $transport->emit( $text );
 461                 } else {
 462                         \Wikimedia\suppressWarnings();
 463                         $exists = file_exists( $file );
 464                         $size = $exists ? filesize( $file ) : false;
 465                         if ( !$exists ||
 466                                 ( $size !== false && $size + strlen( $text ) < 0x7fffffff )
 467                         ) {
 468                                 file_put_contents( $file, $text, FILE_APPEND );
 469                         }
 470                         \Wikimedia\restoreWarnings();
 471                 }
 472         }
 473
 474 }