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
  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 === 'wfErrorLog' ) {
 149                         // All messages on the wfErrorLog channel should be emitted.
 150                         $shouldEmit = true;
 151
 152                 } elseif ( $channel === 'wfDebug' ) {
 153                         // wfDebug messages are emitted if a catch all logging file has
 154                         // been specified. Checked explicitly so that 'private' flagged
 155                         // messages are not discarded by unset $wgDebugLogGroups channel
 156                         // handling below.
 157                         $shouldEmit = $wgDebugLogFile != '';
 158
 159                 } elseif ( isset( $wgDebugLogGroups[$channel] ) ) {
 160                         $logConfig = $wgDebugLogGroups[$channel];
 161
 162                         if ( is_array( $logConfig ) ) {
 163                                 $shouldEmit = true;
 164                                 if ( isset( $logConfig['sample'] ) ) {
 165                                         // Emit randomly with a 1 in 'sample' chance for each message.
 166                                         $shouldEmit = mt_rand( 1, $logConfig['sample'] ) === 1;
 167                                 }
 168
 169                                 if ( isset( $logConfig['level'] ) ) {
 170                                         $shouldEmit = $level >= self::$levelMapping[$logConfig['level']];
 171                                 }
 172                         } else {
 173                                 // Emit unless the config value is explictly false.
 174                                 $shouldEmit = $logConfig !== false;
 175                         }
 176
 177                 } elseif ( isset( $context['private'] ) && $context['private'] ) {
 178                         // Don't emit if the message didn't match previous checks based on
 179                         // the channel and the event is marked as private. This check
 180                         // discards messages sent via wfDebugLog() with dest == 'private'
 181                         // and no explicit wgDebugLogGroups configuration.
 182                         $shouldEmit = false;
 183                 } else {
 184                         // Default return value is the same as the historic wfDebug
 185                         // method: emit if $wgDebugLogFile has been set.
 186                         $shouldEmit = $wgDebugLogFile != '';
 187                 }
 188
 189                 return $shouldEmit;
 190         }
 191
 192         /**
 193          * Format a message.
 194          *
 195          * Messages to the 'wfDebug', 'wfLogDBError' and 'wfErrorLog' channels
 196          * receive special fomatting to mimic the historic output of the functions
 197          * of the same name. All other channel values are formatted based on the
 198          * historic output of the `wfDebugLog()` global function.
 199          *
 200          * @param string $channel
 201          * @param string $message
 202          * @param array $context
 203          * @return string
 204          */
 205         public static function format( $channel, $message, $context ) {
 206                 global $wgDebugLogGroups, $wgLogExceptionBacktrace;
 207
 208                 if ( $channel === 'wfDebug' ) {
 209                         $text = self::formatAsWfDebug( $channel, $message, $context );
 210
 211                 } elseif ( $channel === 'wfLogDBError' ) {
 212                         $text = self::formatAsWfLogDBError( $channel, $message, $context );
 213
 214                 } elseif ( $channel === 'wfErrorLog' ) {
 215                         $text = "{$message}\n";
 216
 217                 } elseif ( $channel === 'profileoutput' ) {
 218                         // Legacy wfLogProfilingData formatitng
 219                         $forward = '';
 220                         if ( isset( $context['forwarded_for'] ) ) {
 221                                 $forward = " forwarded for {$context['forwarded_for']}";
 222                         }
 223                         if ( isset( $context['client_ip'] ) ) {
 224                                 $forward .= " client IP {$context['client_ip']}";
 225                         }
 226                         if ( isset( $context['from'] ) ) {
 227                                 $forward .= " from {$context['from']}";
 228                         }
 229                         if ( $forward ) {
 230                                 $forward = "\t(proxied via {$context['proxy']}{$forward})";
 231                         }
 232                         if ( $context['anon'] ) {
 233                                 $forward .= ' anon';
 234                         }
 235                         if ( !isset( $context['url'] ) ) {
 236                                 $context['url'] = 'n/a';
 237                         }
 238
 239                         $log = sprintf( "%s\t%04.3f\t%s%s\n",
 240                                 gmdate( 'YmdHis' ), $context['elapsed'], $context['url'], $forward );
 241
 242                         $text = self::formatAsWfDebugLog(
 243                                 $channel, $log . $context['output'], $context );
 244
 245                 } elseif ( !isset( $wgDebugLogGroups[$channel] ) ) {
 246                         $text = self::formatAsWfDebug(
 247                                 $channel, "[{$channel}] {$message}", $context );
 248
 249                 } else {
 250                         // Default formatting is wfDebugLog's historic style
 251                         $text = self::formatAsWfDebugLog( $channel, $message, $context );
 252                 }
 253
 254                 // Append stacktrace of exception if available
 255                 if ( $wgLogExceptionBacktrace && isset( $context['exception'] ) ) {
 256                         $e = $context['exception'];
 257                         $backtrace = false;
 258
 259                         if ( $e instanceof Exception ) {
 260                                 $backtrace = MWExceptionHandler::getRedactedTrace( $e );
 261
 262                         } elseif ( is_array( $e ) && isset( $e['trace'] ) ) {
 263                                 // Exception has already been unpacked as structured data
 264                                 $backtrace = $e['trace'];
 265                         }
 266
 267                         if ( $backtrace ) {
 268                                 $text .= MWExceptionHandler::prettyPrintTrace( $backtrace ) .
 269                                         "\n";
 270                         }
 271                 }
 272
 273                 return self::interpolate( $text, $context );
 274         }
 275
 276         /**
 277          * Format a message as `wfDebug()` would have formatted it.
 278          *
 279          * @param string $channel
 280          * @param string $message
 281          * @param array $context
 282          * @return string
 283          */
 284         protected static function formatAsWfDebug( $channel, $message, $context ) {
 285                 $text = preg_replace( '![\x00-\x08\x0b\x0c\x0e-\x1f]!', ' ', $message );
 286                 if ( isset( $context['seconds_elapsed'] ) ) {
 287                         // Prepend elapsed request time and real memory usage with two
 288                         // trailing spaces.
 289                         $text = "{$context['seconds_elapsed']} {$context['memory_used']}  {$text}";
 290                 }
 291                 if ( isset( $context['prefix'] ) ) {
 292                         $text = "{$context['prefix']}{$text}";
 293                 }
 294                 return "{$text}\n";
 295         }
 296
 297         /**
 298          * Format a message as `wfLogDBError()` would have formatted it.
 299          *
 300          * @param string $channel
 301          * @param string $message
 302          * @param array $context
 303          * @return string
 304          */
 305         protected static function formatAsWfLogDBError( $channel, $message, $context ) {
 306                 global $wgDBerrorLogTZ;
 307                 static $cachedTimezone = null;
 308
 309                 if ( !$cachedTimezone ) {
 310                         $cachedTimezone = new DateTimeZone( $wgDBerrorLogTZ );
 311                 }
 312
 313                 $d = date_create( 'now', $cachedTimezone );
 314                 $date = $d->format( 'D M j G:i:s T Y' );
 315
 316                 $host = wfHostname();
 317                 $wiki = wfWikiID();
 318
 319                 $text = "{$date}\t{$host}\t{$wiki}\t{$message}\n";
 320                 return $text;
 321         }
 322
 323         /**
 324          * Format a message as `wfDebugLog() would have formatted it.
 325          *
 326          * @param string $channel
 327          * @param string $message
 328          * @param array $context
 329          * @return string
 330          */
 331         protected static function formatAsWfDebugLog( $channel, $message, $context ) {
 332                 $time = wfTimestamp( TS_DB );
 333                 $wiki = wfWikiID();
 334                 $host = wfHostname();
 335                 $text = "{$time} {$host} {$wiki}: {$message}\n";
 336                 return $text;
 337         }
 338
 339         /**
 340          * Interpolate placeholders in logging message.
 341          *
 342          * @param string $message
 343          * @param array $context
 344          * @return string Interpolated message
 345          */
 346         public static function interpolate( $message, array $context ) {
 347                 if ( strpos( $message, '{' ) !== false ) {
 348                         $replace = [];
 349                         foreach ( $context as $key => $val ) {
 350                                 $replace['{' . $key . '}'] = self::flatten( $val );
 351                         }
 352                         $message = strtr( $message, $replace );
 353                 }
 354                 return $message;
 355         }
 356
 357         /**
 358          * Convert a logging context element to a string suitable for
 359          * interpolation.
 360          *
 361          * @param mixed $item
 362          * @return string
 363          */
 364         protected static function flatten( $item ) {
 365                 if ( null === $item ) {
 366                         return '[Null]';
 367                 }
 368
 369                 if ( is_bool( $item ) ) {
 370                         return $item ? 'true' : 'false';
 371                 }
 372
 373                 if ( is_float( $item ) ) {
 374                         if ( is_infinite( $item ) ) {
 375                                 return ( $item > 0 ? '' : '-' ) . 'INF';
 376                         }
 377                         if ( is_nan( $item ) ) {
 378                                 return 'NaN';
 379                         }
 380                         return (string)$item;
 381                 }
 382
 383                 if ( is_scalar( $item ) ) {
 384                         return (string)$item;
 385                 }
 386
 387                 if ( is_array( $item ) ) {
 388                         return '[Array(' . count( $item ) . ')]';
 389                 }
 390
 391                 if ( $item instanceof \DateTime ) {
 392                         return $item->format( 'c' );
 393                 }
 394
 395                 if ( $item instanceof Exception ) {
 396                         return '[Exception ' . get_class( $item ) . '( ' .
 397                                 $item->getFile() . ':' . $item->getLine() . ') ' .
 398                                 $item->getMessage() . ']';
 399                 }
 400
 401                 if ( is_object( $item ) ) {
 402                         if ( method_exists( $item, '__toString' ) ) {
 403                                 return (string)$item;
 404                         }
 405
 406                         return '[Object ' . get_class( $item ) . ']';
 407                 }
 408
 409                 if ( is_resource( $item ) ) {
 410                         return '[Resource ' . get_resource_type( $item ) . ']';
 411                 }
 412
 413                 return '[Unknown ' . gettype( $item ) . ']';
 414         }
 415
 416         /**
 417          * Select the appropriate log output destination for the given log event.
 418          *
 419          * If the event context contains 'destination'
 420          *
 421          * @param string $channel
 422          * @param string $message
 423          * @param array $context
 424          * @return string
 425          */
 426         protected static function destination( $channel, $message, $context ) {
 427                 global $wgDebugLogFile, $wgDBerrorLog, $wgDebugLogGroups;
 428
 429                 // Default destination is the debug log file as historically used by
 430                 // the wfDebug function.
 431                 $destination = $wgDebugLogFile;
 432
 433                 if ( isset( $context['destination'] ) ) {
 434                         // Use destination explicitly provided in context
 435                         $destination = $context['destination'];
 436
 437                 } elseif ( $channel === 'wfDebug' ) {
 438                         $destination = $wgDebugLogFile;
 439
 440                 } elseif ( $channel === 'wfLogDBError' ) {
 441                         $destination = $wgDBerrorLog;
 442
 443                 } elseif ( isset( $wgDebugLogGroups[$channel] ) ) {
 444                         $logConfig = $wgDebugLogGroups[$channel];
 445
 446                         if ( is_array( $logConfig ) ) {
 447                                 $destination = $logConfig['destination'];
 448                         } else {
 449                                 $destination = strval( $logConfig );
 450                         }
 451                 }
 452
 453                 return $destination;
 454         }
 455
 456         /**
 457         * Log to a file without getting "file size exceeded" signals.
 458         *
 459         * Can also log to UDP with the syntax udp://host:port/prefix. This will send
 460         * lines to the specified port, prefixed by the specified prefix and a space.
 461         *
 462         * @param string $text
 463         * @param string $file Filename
 464         */
 465         public static function emit( $text, $file ) {
 466                 if ( substr( $file, 0, 4 ) == 'udp:' ) {
 467                         $transport = UDPTransport::newFromString( $file );
 468                         $transport->emit( $text );
 469                 } else {
 470                         \MediaWiki\suppressWarnings();
 471                         $exists = file_exists( $file );
 472                         $size = $exists ? filesize( $file ) : false;
 473                         if ( !$exists ||
 474                                 ( $size !== false && $size + strlen( $text ) < 0x7fffffff )
 475                         ) {
 476                                 file_put_contents( $file, $text, FILE_APPEND );
 477                         }
 478                         \MediaWiki\restoreWarnings();
 479                 }
 480         }
 481
 482 }