includes/logging/LogFormatter.php

   1 <?php
   2 /**
   3  * Contains classes for formatting log entries
   4  *
   5  * @file
   6  * @author Niklas Laxström
   7  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
   8  * @since 1.19
   9  */
  10
  11 /**
  12  * Implements the default log formatting.
  13  * Can be overridden by subclassing and setting
  14  * $wgLogActionsHandlers['type/subtype'] = 'class'; or
  15  * $wgLogActionsHandlers['type/*'] = 'class';
  16  * @since 1.19
  17  */
  18 class LogFormatter {
  19
  20         // Static->
  21
  22         /**
  23          * Constructs a new formatter suitable for given entry.
  24          * @param $entry LogEntry
  25          * @return LogFormatter
  26          */
  27         public static function newFromEntry( LogEntry $entry ) {
  28                 global $wgLogActionsHandlers;
  29                 $fulltype = $entry->getFullType();
  30                 $wildcard = $entry->getType() . '/*';
  31                 $handler = '';
  32
  33                 if ( isset( $wgLogActionsHandlers[$fulltype] ) ) {
  34                         $handler = $wgLogActionsHandlers[$fulltype];
  35                 } elseif ( isset( $wgLogActionsHandlers[$wildcard] ) ) {
  36                         $handler = $wgLogActionsHandlers[$wildcard];
  37                 }
  38
  39                 if ( $handler !== '' && is_string( $handler ) && class_exists( $handler ) ) {
  40                         return new $handler( $entry );
  41                 }
  42
  43                 return new LegacyLogFormatter( $entry );
  44         }
  45
  46         /**
  47          * Handy shortcut for constructing a formatter directly from
  48          * database row.
  49          * @param $row
  50          * @see DatabaseLogEntry::getSelectQueryData
  51          * @return LogFormatter
  52          */
  53         public static function newFromRow( $row ) {
  54                 return self::newFromEntry( DatabaseLogEntry::newFromRow( $row ) );
  55         }
  56
  57         // Nonstatic->
  58
  59         /// @var LogEntry
  60         protected $entry;
  61
  62         /// Whether to output user tool links
  63         protected $linkFlood = false;
  64
  65         /**
  66          * Set to true if we are constructing a message text that is going to
  67          * be included in page history or send to IRC feed. Links are replaced
  68          * with plaintext or with [[pagename]] kind of syntax, that is parsed
  69          * by page histories and IRC feeds.
  70          * @var boolean
  71          */
  72         protected $plaintext = false;
  73
  74         protected function __construct( LogEntry $entry ) {
  75                 $this->entry = $entry;
  76                 $this->context = RequestContext::getMain();
  77         }
  78
  79         /**
  80          * Replace the default context
  81          * @param $context IContextSource
  82          */
  83         public function setContext( IContextSource $context ) {
  84                 $this->context = $context;
  85         }
  86
  87         /**
  88          * If set to true, will produce user tool links after
  89          * the user name. This should be replaced with generic
  90          * CSS/JS solution.
  91          * @param $value boolean
  92          */
  93         public function setShowUserToolLinks( $value ) {
  94                 $this->linkFlood = $value;
  95         }
  96
  97         /**
  98          * Ugly hack to produce plaintext version of the message.
  99          * Usually you also want to set extraneous request context
 100          * to avoid formatting for any particular user.
 101          * @see getActionText()
 102          * @return string text
 103          */
 104         public function getPlainActionText() {
 105                 $this->plaintext = true;
 106                 $text = $this->getActionText();
 107                 $this->plaintext = false;
 108                 return $text;
 109         }
 110
 111         /**
 112          * Gets the log action, including username.
 113          * @return string HTML
 114          */
 115         public function getActionText() {
 116                 $element = $this->getActionMessage();
 117                 if ( $element instanceof Message ) {
 118                         $element = $this->plaintext ? $element->text() : $element->escaped();
 119                 }
 120
 121                 if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
 122                         $performer = $this->getPerformerElement() . $this->msg( 'word-separator' )->text();
 123                         $element = $performer . self::getRestrictedElement( 'rev-deleted-event' );
 124                 }
 125
 126                 return $element;
 127         }
 128
 129         /**
 130          * Returns a sentence describing the log action. Usually
 131          * a Message object is returned, but old style log types
 132          * and entries might return pre-escaped html string.
 133          * @return Message|pre-escaped html
 134          */
 135         protected function getActionMessage() {
 136                 $message = $this->msg( $this->getMessageKey() );
 137                 $message->params( $this->getMessageParameters() );
 138                 return $message;
 139         }
 140
 141         /**
 142          * Returns a key to be used for formatting the action sentence.
 143          * Default is logentry-TYPE-SUBTYPE for modern logs. Legacy log
 144          * types will use custom keys, and subclasses can also alter the
 145          * key depending on the entry itself.
 146          * @return string message key
 147          */
 148         protected function getMessageKey() {
 149                 $type = $this->entry->getType();
 150                 $subtype = $this->entry->getSubtype();
 151                 $key = "logentry-$type-$subtype";
 152                 return $key;
 153         }
 154
 155         /**
 156          * Extract parameters intented for action message from
 157          * array of all parameters. There are three hardcoded
 158          * parameters (array zero-indexed, this list not):
 159          *  - 1: user name with premade link
 160          *  - 2: usable for gender magic function
 161          *  - 3: target page with premade link
 162          * @return array
 163          */
 164         protected function getMessageParameters() {
 165                 if ( isset( $this->parsedParameters ) ) {
 166                         return $this->parsedParameters;
 167                 }
 168
 169                 $entry = $this->entry;
 170
 171                 $params = array();
 172                 $params[0] = Message::rawParam( $this->getPerformerElement() );
 173                 $params[1] = $entry->getPerformer()->getName();
 174                 $params[2] = Message::rawParam( $this->makePageLink( $entry->getTarget() ) );
 175
 176                 if ( $entry->isLegacy() ) {
 177                         foreach ( $entry->getParameters() as $index => $value ) {
 178                                 $params[$index + 3] = $value;
 179                         }
 180                 }
 181
 182                 // Filter out parameters which are not in format #:foo
 183                 foreach ( $entry->getParameters() as $key => $value ) {
 184                         if ( strpos( $key, ':' ) === false ) continue;
 185                         list( $index, $type, $name ) = explode( ':', $key, 3 );
 186                         $params[$index - 1] = $value;
 187                 }
 188
 189                 /* Message class doesn't like non consecutive numbering.
 190                  * Fill in missing indexes with empty strings to avoid
 191                  * incorrect renumbering.
 192                  */
 193                 $max = max( array_keys( $params ) );
 194                 for ( $i = 4; $i < $max; $i++ ) {
 195                         if ( !isset( $params[$i] ) ) {
 196                                 $params[$i] = '';
 197                         }
 198                 }
 199
 200                 return $this->parsedParameters = $params;
 201         }
 202
 203         /**
 204          * Helper to make a link to the page, taking the plaintext
 205          * value in consideration.
 206          * @param $title Title the page
 207          * @param $parameters array query parameters
 208          * @return String
 209          */
 210         protected function makePageLink( Title $title = null, $parameters = array() ) {
 211                 if ( !$this->plaintext ) {
 212                         $link = Linker::link( $title, null, array(), $parameters );
 213                 } else {
 214                         if ( !$title instanceof Title ) {
 215                                 throw new MWException( "Expected title, got null" );
 216                         }
 217                         $link = '[[' . $title->getPrefixedText() . ']]';
 218                 }
 219                 return $link;
 220         }
 221
 222         /**
 223          * Provides the name of the user who performed the log action.
 224          * Used as part of log action message or standalone, depending
 225          * which parts of the log entry has been hidden.
 226          */
 227         public function getPerformerElement() {
 228                 $performer = $this->entry->getPerformer();
 229                 $element = $this->makeUserLink( $performer );
 230
 231                 if ( $this->entry->isDeleted( LogPage::DELETED_USER ) ) {
 232                         $element = self::getRestrictedElement( 'rev-deleted-user' );
 233                 }
 234
 235                 return $element;
 236         }
 237
 238         /**
 239          * Gets the luser provided comment
 240          * @return string HTML
 241          */
 242         public function getComment() {
 243                 $comment = Linker::commentBlock( $this->entry->getComment() );
 244                 // No hard coded spaces thanx
 245                 $element = ltrim( $comment );
 246
 247                 if ( $this->entry->isDeleted( LogPage::DELETED_COMMENT ) ) {
 248                         $element = self::getRestrictedElement( 'rev-deleted-comment' );
 249                 }
 250
 251                 return $element;
 252         }
 253
 254         /**
 255          * Helper method for displaying restricted element.
 256          * @param $message string
 257          * @return string HTML
 258          */
 259         protected function getRestrictedElement( $message ) {
 260                 if ( $this->plaintext ) {
 261                         return $this->msg( $message )->text();
 262                 }
 263
 264                 $content =  $this->msg( $message )->escaped();
 265                 $attribs = array( 'class' => 'history-deleted' );
 266                 return Html::rawElement( 'span', $attribs, $content );
 267         }
 268
 269         /**
 270          * Shortcut for wfMessage which honors local context.
 271          * @todo Would it be better to require replacing the global context instead?
 272          * @param $key string
 273          * @return Message
 274          */
 275         protected function msg( $key ) {
 276                 return wfMessage( $key )
 277                         ->inLanguage( $this->context->getLanguage() )
 278                         ->title( $this->context->getTitle() );
 279         }
 280
 281         protected function makeUserLink( User $user ) {
 282                 if ( $this->plaintext ) {
 283                         $element = $user->getName();
 284                 } else {
 285                         $element = Linker::userLink(
 286                                 $user->getId(),
 287                                 $user->getName()
 288                         );
 289
 290                         if ( $this->linkFlood ) {
 291                                 $element .= Linker::userToolLinks(
 292                                         $user->getId(),
 293                                         $user->getName(),
 294                                         true, // Red if no edits
 295                                         0, // Flags
 296                                         $user->getEditCount()
 297                                 );
 298                         }
 299                 }
 300                 return $element;
 301         }
 302
 303 }
 304
 305 /**
 306  * This class formats all log entries for log types
 307  * which have not been converted to the new system.
 308  * This is not about old log entries which store
 309  * parameters in a different format - the new
 310  * LogFormatter classes have code to support formatting
 311  * those too.
 312  * @since 1.19
 313  */
 314 class LegacyLogFormatter extends LogFormatter {
 315         protected function getActionMessage() {
 316                 $entry = $this->entry;
 317                 $action = LogPage::actionText(
 318                         $entry->getType(),
 319                         $entry->getSubtype(),
 320                         $entry->getTarget(),
 321                         $this->context->getSkin(),
 322                         (array)$entry->getParameters(),
 323                         true
 324                 );
 325
 326                 $performer = $this->getPerformerElement();
 327                 return $performer .  $this->msg( 'word-separator' )->text() . $action;
 328         }
 329
 330 }
 331
 332 /**
 333  * This class formats move log entries.
 334  * @since 1.19
 335  */
 336 class MoveLogFormatter extends LogFormatter {
 337         protected function getMessageKey() {
 338                 $key = parent::getMessageKey();
 339                 $params = $this->getMessageParameters();
 340                 if ( isset( $params[4] ) && $params[4] === '1' ) {
 341                         $key .= '-noredirect';
 342                 }
 343                 return $key;
 344         }
 345
 346         protected function getMessageParameters() {
 347                 $params = parent::getMessageParameters();
 348                 $oldname = $this->makePageLink( $this->entry->getTarget(), array( 'redirect' => 'no' ) );
 349                 $newname = $this->makePageLink( Title::newFromText( $params[3] ) );
 350                 $params[2] = Message::rawParam( $oldname );
 351                 $params[3] = Message::rawParam( $newname );
 352                 return $params;
 353         }
 354 }
 355
 356 /**
 357  * This class formats delete log entries.
 358  * @since 1.19
 359  */
 360 class DeleteLogFormatter extends LogFormatter {
 361         protected function getMessageKey() {
 362                 $key = parent::getMessageKey();
 363                 if ( in_array( $this->entry->getSubtype(), array( 'event', 'revision' ) ) ) {
 364                         if ( count( $this->getMessageParameters() ) < 5 ) {
 365                                 return "$key-legacy";
 366                         }
 367                 }
 368                 return $key;
 369         }
 370
 371         protected function getMessageParameters() {
 372                 if ( isset( $this->parsedParametersDeleteLog ) ) {
 373                         return $this->parsedParametersDeleteLog;
 374                 }
 375
 376                 $params = parent::getMessageParameters();
 377                 $subtype = $this->entry->getSubtype();
 378                 if ( in_array( $subtype, array( 'event', 'revision' ) ) ) {
 379                         if (
 380                                 ($subtype === 'event' && count( $params ) === 6 ) ||
 381                                 ($subtype === 'revision' && isset( $params[3] ) && $params[3] === 'revision' )
 382                         ) {
 383                                 $paramStart = $subtype === 'revision' ? 4 : 3;
 384
 385                                 $old = $this->parseBitField( $params[$paramStart+1] );
 386                                 $new = $this->parseBitField( $params[$paramStart+2] );
 387                                 list( $hid, $unhid, $extra ) = RevisionDeleter::getChanges( $new, $old );
 388                                 $changes = array();
 389                                 foreach ( $hid as $v ) {
 390                                         $changes[] = $this->msg( "$v-hid" )->plain();
 391                                 }
 392                                 foreach ( $unhid as $v ) {
 393                                         $changes[] = $this->msg( "$v-unhid" )->plain();
 394                                 }
 395                                 foreach ( $extra as $v ) {
 396                                         $changes[] = $this->msg( $v )->plain();
 397                                 }
 398                                 $changeText =  $this->context->getLanguage()->listToText( $changes );
 399
 400
 401                                 $newParams = array_slice( $params, 0, 3 );
 402                                 $newParams[3] = $changeText;
 403                                 $count = count( explode( ',', $params[$paramStart] ) );
 404                                 $newParams[4] = $this->context->getLanguage()->formatNum( $count );
 405                                 return $this->parsedParametersDeleteLog = $newParams;
 406                         } else {
 407                                 return $this->parsedParametersDeleteLog = array_slice( $params, 0, 3 );
 408                         }
 409                 }
 410
 411                 return $this->parsedParametersDeleteLog = $params;
 412         }
 413
 414         protected function parseBitField( $string ) {
 415                 // Input is like ofield=2134 or just the number
 416                 if ( strpos( $string, 'field=' ) === 1 ) {
 417                         list( , $field ) = explode( '=', $string );
 418                         return (int) $field;
 419                 } else {
 420                         return (int) $string;
 421                 }
 422         }
 423 }
 424
 425 /**
 426  * This class formats patrol log entries.
 427  * @since 1.19
 428  */
 429 class PatrolLogFormatter extends LogFormatter {
 430         protected function getMessageKey() {
 431                 $key = parent::getMessageKey();
 432                 $params = $this->getMessageParameters();
 433                 if ( isset( $params[5] ) && $params[5] ) {
 434                         $key .= '-auto';
 435                 }
 436                 return $key;
 437         }
 438
 439         protected function getMessageParameters() {
 440                 $params = parent::getMessageParameters();
 441                 $newParams = array_slice( $params, 0, 3 );
 442
 443                 $target = $this->entry->getTarget();
 444                 $oldid = $params[3];
 445                 $revision = $this->context->getLanguage()->formatNum( $oldid, true );
 446
 447                 if ( $this->plaintext ) {
 448                         $revlink = $revision;
 449                 } elseif ( $target->exists() ) {
 450                         $query = array(
 451                                 'oldid' => $oldid,
 452                                 'diff' => 'prev'
 453                         );
 454                         $revlink = Linker::link( $target, htmlspecialchars( $revision ), array(), $query );
 455                 } else {
 456                         $revlink = htmlspecialchars( $revision );
 457                 }
 458
 459                 $newParams[3] = Message::rawParam( $revlink );
 460                 return $newParams;
 461         }
 462 }
 463
 464 /**
 465  * This class formats new user log entries.
 466  * @since 1.19
 467  */
 468 class NewUsersLogFormatter extends LogFormatter {
 469         protected function getMessageParameters() {
 470                 $params = parent::getMessageParameters();
 471                 if ( $this->entry->getSubtype() === 'create2' ) {
 472                         if ( isset( $params[3] ) ) {
 473                                 $target = User::newFromId( $params[3] );
 474                         } else {
 475                                 $target = User::newFromName( $this->entry->getTarget()->getText(), false );
 476                         }
 477                         $params[2] = Message::rawParam( $this->makeUserLink( $target ) );
 478                         $params[3] = $target->getName();
 479                 }
 480                 return $params;
 481         }
 482
 483         public function getComment() {
 484                 $timestamp = wfTimestamp( TS_MW, $this->entry->getTimestamp() );
 485                 if ( $timestamp < '20080129000000' ) {
 486                         # Suppress $comment from old entries (before 2008-01-29),
 487                         # not needed and can contain incorrect links
 488                         return '';
 489                 }
 490                 return parent::getComment();
 491         }
 492 }