includes/logging/LogFormatter.php

   1 <?php
   2 /**
   3  * Contains classes for formatting log entries
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @author Niklas Laxström
  22  * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  23  * @since 1.19
  24  */
  25
  26 /**
  27  * Implements the default log formatting.
  28  * Can be overridden by subclassing and setting
  29  * $wgLogActionsHandlers['type/subtype'] = 'class'; or
  30  * $wgLogActionsHandlers['type/*'] = 'class';
  31  * @since 1.19
  32  */
  33 class LogFormatter {
  34         // Audience options for viewing usernames, comments, and actions
  35         const FOR_PUBLIC = 1;
  36         const FOR_THIS_USER = 2;
  37
  38         // Static->
  39
  40         /**
  41          * Constructs a new formatter suitable for given entry.
  42          * @param $entry LogEntry
  43          * @return LogFormatter
  44          */
  45         public static function newFromEntry( LogEntry $entry ) {
  46                 global $wgLogActionsHandlers;
  47                 $fulltype = $entry->getFullType();
  48                 $wildcard = $entry->getType() . '/*';
  49                 $handler = '';
  50
  51                 if ( isset( $wgLogActionsHandlers[$fulltype] ) ) {
  52                         $handler = $wgLogActionsHandlers[$fulltype];
  53                 } elseif ( isset( $wgLogActionsHandlers[$wildcard] ) ) {
  54                         $handler = $wgLogActionsHandlers[$wildcard];
  55                 }
  56
  57                 if ( $handler !== '' && is_string( $handler ) && class_exists( $handler ) ) {
  58                         return new $handler( $entry );
  59                 }
  60
  61                 return new LegacyLogFormatter( $entry );
  62         }
  63
  64         /**
  65          * Handy shortcut for constructing a formatter directly from
  66          * database row.
  67          * @param $row
  68          * @see DatabaseLogEntry::getSelectQueryData
  69          * @return LogFormatter
  70          */
  71         public static function newFromRow( $row ) {
  72                 return self::newFromEntry( DatabaseLogEntry::newFromRow( $row ) );
  73         }
  74
  75         // Nonstatic->
  76
  77         /// @var LogEntry
  78         protected $entry;
  79
  80         /// Integer constant for handling log_deleted
  81         protected $audience = self::FOR_PUBLIC;
  82
  83         /// Whether to output user tool links
  84         protected $linkFlood = false;
  85
  86         /**
  87          * Set to true if we are constructing a message text that is going to
  88          * be included in page history or send to IRC feed. Links are replaced
  89          * with plaintext or with [[pagename]] kind of syntax, that is parsed
  90          * by page histories and IRC feeds.
  91          * @var boolean
  92          */
  93         protected $plaintext = false;
  94
  95         protected $irctext = false;
  96
  97         protected function __construct( LogEntry $entry ) {
  98                 $this->entry = $entry;
  99                 $this->context = RequestContext::getMain();
 100         }
 101
 102         /**
 103          * Replace the default context
 104          * @param $context IContextSource
 105          */
 106         public function setContext( IContextSource $context ) {
 107                 $this->context = $context;
 108         }
 109
 110         /**
 111          * Set the visibility restrictions for displaying content.
 112          * If set to public, and an item is deleted, then it will be replaced
 113          * with a placeholder even if the context user is allowed to view it.
 114          * @param $audience integer self::FOR_THIS_USER or self::FOR_PUBLIC
 115          */
 116         public function setAudience( $audience ) {
 117                 $this->audience = ( $audience == self::FOR_THIS_USER )
 118                         ? self::FOR_THIS_USER
 119                         : self::FOR_PUBLIC;
 120         }
 121
 122         /**
 123          * Check if a log item can be displayed
 124          * @param $field integer LogPage::DELETED_* constant
 125          * @return bool
 126          */
 127         protected function canView( $field ) {
 128                 if ( $this->audience == self::FOR_THIS_USER ) {
 129                         return LogEventsList::userCanBitfield(
 130                                 $this->entry->getDeleted(), $field, $this->context->getUser() );
 131                 } else {
 132                         return !$this->entry->isDeleted( $field );
 133                 }
 134         }
 135
 136         /**
 137          * If set to true, will produce user tool links after
 138          * the user name. This should be replaced with generic
 139          * CSS/JS solution.
 140          * @param $value boolean
 141          */
 142         public function setShowUserToolLinks( $value ) {
 143                 $this->linkFlood = $value;
 144         }
 145
 146         /**
 147          * Ugly hack to produce plaintext version of the message.
 148          * Usually you also want to set extraneous request context
 149          * to avoid formatting for any particular user.
 150          * @see getActionText()
 151          * @return string text
 152          */
 153         public function getPlainActionText() {
 154                 $this->plaintext = true;
 155                 $text = $this->getActionText();
 156                 $this->plaintext = false;
 157                 return $text;
 158         }
 159
 160         /**
 161          * Even uglier hack to maintain backwards compatibilty with IRC bots
 162          * (bug 34508).
 163          * @see getActionText()
 164          * @return string text
 165          */
 166         public function getIRCActionComment() {
 167                 $actionComment = $this->getIRCActionText();
 168                 $comment = $this->entry->getComment();
 169
 170                 if ( $comment != '' ) {
 171                         if ( $actionComment == '' ) {
 172                                 $actionComment = $comment;
 173                         } else {
 174                                 $actionComment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $comment;
 175                         }
 176                 }
 177
 178                 return $actionComment;
 179         }
 180
 181         /**
 182          * Even uglier hack to maintain backwards compatibilty with IRC bots
 183          * (bug 34508).
 184          * @see getActionText()
 185          * @return string text
 186          */
 187         public function getIRCActionText() {
 188                 $this->plaintext = true;
 189                 $this->irctext = true;
 190
 191                 $entry = $this->entry;
 192                 $parameters = $entry->getParameters();
 193                 // @see LogPage::actionText()
 194                 // Text of title the action is aimed at.
 195                 $target = $entry->getTarget()->getPrefixedText() ;
 196                 $text = null;
 197                 switch( $entry->getType() ) {
 198                         case 'move':
 199                                 switch( $entry->getSubtype() ) {
 200                                         case 'move':
 201                                                 $movesource =  $parameters['4::target'];
 202                                                 $text = wfMessage( '1movedto2' )
 203                                                         ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
 204                                                 break;
 205                                         case 'move_redir':
 206                                                 $movesource =  $parameters['4::target'];
 207                                                 $text = wfMessage( '1movedto2_redir' )
 208                                                         ->rawParams( $target, $movesource )->inContentLanguage()->escaped();
 209                                                 break;
 210                                         case 'move-noredirect':
 211                                                 break;
 212                                         case 'move_redir-noredirect':
 213                                                 break;
 214                                 }
 215                                 break;
 216
 217                         case 'delete':
 218                                 switch( $entry->getSubtype() ) {
 219                                         case 'delete':
 220                                                 $text = wfMessage( 'deletedarticle' )
 221                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 222                                                 break;
 223                                         case 'restore':
 224                                                 $text = wfMessage( 'undeletedarticle' )
 225                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 226                                                 break;
 227                                         //case 'revision': // Revision deletion
 228                                         //case 'event': // Log deletion
 229                                                 // see https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/includes/LogPage.php?&pathrev=97044&r1=97043&r2=97044
 230                                         //default:
 231                                 }
 232                                 break;
 233
 234                         case 'patrol':
 235                                 // https://svn.wikimedia.org/viewvc/mediawiki/trunk/phase3/includes/PatrolLog.php?&pathrev=97495&r1=97494&r2=97495
 236                                 // Create a diff link to the patrolled revision
 237                                 if ( $entry->getSubtype() === 'patrol' ) {
 238                                         $diffLink = htmlspecialchars(
 239                                                 wfMessage( 'patrol-log-diff', $parameters['4::curid'] )
 240                                                         ->inContentLanguage()->text() );
 241                                         $text = wfMessage( 'patrol-log-line', $diffLink, "[[$target]]", "" )
 242                                                 ->inContentLanguage()->text();
 243                                 } else {
 244                                         // broken??
 245                                 }
 246                                 break;
 247
 248                         case 'protect':
 249                                 switch( $entry->getSubtype() ) {
 250                                 case 'protect':
 251                                         $text = wfMessage( 'protectedarticle' )
 252                                                 ->rawParams( $target . ' ' . $parameters[0] )->inContentLanguage()->escaped();
 253                                         break;
 254                                 case 'unprotect':
 255                                         $text = wfMessage( 'unprotectedarticle' )
 256                                                 ->rawParams( $target )->inContentLanguage()->escaped();
 257                                         break;
 258                                 case 'modify':
 259                                         $text = wfMessage( 'modifiedarticleprotection' )
 260                                                 ->rawParams( $target . ' ' . $parameters[0] )->inContentLanguage()->escaped();
 261                                         break;
 262                                 }
 263                                 break;
 264
 265                         case 'newusers':
 266                                 switch( $entry->getSubtype() ) {
 267                                         case 'newusers':
 268                                         case 'create':
 269                                                 $text = wfMessage( 'newuserlog-create-entry' )
 270                                                         ->inContentLanguage()->escaped();
 271                                                 break;
 272                                         case 'create2':
 273                                                 $text = wfMessage( 'newuserlog-create2-entry' )
 274                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 275                                                 break;
 276                                         case 'autocreate':
 277                                                 $text = wfMessage( 'newuserlog-autocreate-entry' )
 278                                                         ->inContentLanguage()->escaped();
 279                                                 break;
 280                                 }
 281                                 break;
 282
 283                         case 'upload':
 284                                 switch( $entry->getSubtype() ) {
 285                                         case 'upload':
 286                                                 $text = wfMessage( 'uploadedimage' )
 287                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 288                                                 break;
 289                                         case 'overwrite':
 290                                                 $text = wfMessage( 'overwroteimage' )
 291                                                         ->rawParams( $target )->inContentLanguage()->escaped();
 292                                                 break;
 293                                 }
 294                                 break;
 295
 296
 297                         // case 'suppress' --private log -- aaron  (sign your messages so we know who to blame in a few years :-D)
 298                         // default:
 299                 }
 300                 if( is_null( $text ) ) {
 301                         $text = $this->getPlainActionText();
 302                 }
 303
 304                 $this->plaintext = false;
 305                 $this->irctext = false;
 306                 return $text;
 307         }
 308
 309         /**
 310          * Gets the log action, including username.
 311          * @return string HTML
 312          */
 313         public function getActionText() {
 314                 if ( $this->canView( LogPage::DELETED_ACTION ) ) {
 315                         $element = $this->getActionMessage();
 316                         if ( $element instanceof Message ) {
 317                                 $element = $this->plaintext ? $element->text() : $element->escaped();
 318                         }
 319                         if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
 320                                 $element = $this->styleRestricedElement( $element );
 321                         }
 322                 } else {
 323                         $performer = $this->getPerformerElement() . $this->msg( 'word-separator' )->text();
 324                         $element = $performer . $this->getRestrictedElement( 'rev-deleted-event' );
 325                 }
 326
 327                 return $element;
 328         }
 329
 330         /**
 331          * Returns a sentence describing the log action. Usually
 332          * a Message object is returned, but old style log types
 333          * and entries might return pre-escaped html string.
 334          * @return Message|string pre-escaped html
 335          */
 336         protected function getActionMessage() {
 337                 $message = $this->msg( $this->getMessageKey() );
 338                 $message->params( $this->getMessageParameters() );
 339                 return $message;
 340         }
 341
 342         /**
 343          * Returns a key to be used for formatting the action sentence.
 344          * Default is logentry-TYPE-SUBTYPE for modern logs. Legacy log
 345          * types will use custom keys, and subclasses can also alter the
 346          * key depending on the entry itself.
 347          * @return string message key
 348          */
 349         protected function getMessageKey() {
 350                 $type = $this->entry->getType();
 351                 $subtype = $this->entry->getSubtype();
 352
 353                 return "logentry-$type-$subtype";
 354         }
 355
 356         /**
 357          * Returns extra links that comes after the action text, like "revert", etc.
 358          *
 359          * @return string
 360          */
 361         public function getActionLinks() {
 362                 return '';
 363         }
 364
 365         /**
 366          * Extracts the optional extra parameters for use in action messages.
 367          * The array indexes start from number 3.
 368          * @return array
 369          */
 370         protected function extractParameters() {
 371                 $entry = $this->entry;
 372                 $params = array();
 373
 374                 if ( $entry->isLegacy() ) {
 375                         foreach ( $entry->getParameters() as $index => $value ) {
 376                                 $params[$index + 3] = $value;
 377                         }
 378                 }
 379
 380                 // Filter out parameters which are not in format #:foo
 381                 foreach ( $entry->getParameters() as $key => $value ) {
 382                         if ( strpos( $key, ':' ) === false ) continue;
 383                         list( $index, $type, $name ) = explode( ':', $key, 3 );
 384                         $params[$index - 1] = $value;
 385                 }
 386
 387                 /* Message class doesn't like non consecutive numbering.
 388                  * Fill in missing indexes with empty strings to avoid
 389                  * incorrect renumbering.
 390                  */
 391                 if ( count( $params ) ) {
 392                         $max = max( array_keys( $params ) );
 393                         for ( $i = 4; $i < $max; $i++ ) {
 394                                 if ( !isset( $params[$i] ) ) {
 395                                         $params[$i] = '';
 396                                 }
 397                         }
 398                 }
 399                 return $params;
 400         }
 401
 402         /**
 403          * Formats parameters intented for action message from
 404          * array of all parameters. There are three hardcoded
 405          * parameters (array is zero-indexed, this list not):
 406          *  - 1: user name with premade link
 407          *  - 2: usable for gender magic function
 408          *  - 3: target page with premade link
 409          * @return array
 410          */
 411         protected function getMessageParameters() {
 412                 if ( isset( $this->parsedParameters ) ) {
 413                         return $this->parsedParameters;
 414                 }
 415
 416                 $entry = $this->entry;
 417                 $params = $this->extractParameters();
 418                 $params[0] = Message::rawParam( $this->getPerformerElement() );
 419                 $params[1] = $entry->getPerformer()->getName();
 420                 $params[2] = Message::rawParam( $this->makePageLink( $entry->getTarget() ) );
 421
 422                 // Bad things happens if the numbers are not in correct order
 423                 ksort( $params );
 424                 return $this->parsedParameters = $params;
 425         }
 426
 427         /**
 428          * Helper to make a link to the page, taking the plaintext
 429          * value in consideration.
 430          * @param $title Title the page
 431          * @param $parameters array query parameters
 432          * @throws MWException
 433          * @return String
 434          */
 435         protected function makePageLink( Title $title = null, $parameters = array() ) {
 436                 if ( !$this->plaintext ) {
 437                         $link = Linker::link( $title, null, array(), $parameters );
 438                 } else {
 439                         if ( !$title instanceof Title ) {
 440                                 throw new MWException( "Expected title, got null" );
 441                         }
 442                         $link = '[[' . $title->getPrefixedText() . ']]';
 443                 }
 444                 return $link;
 445         }
 446
 447         /**
 448          * Provides the name of the user who performed the log action.
 449          * Used as part of log action message or standalone, depending
 450          * which parts of the log entry has been hidden.
 451          * @return String
 452          */
 453         public function getPerformerElement() {
 454                 if ( $this->canView( LogPage::DELETED_USER ) ) {
 455                         $performer = $this->entry->getPerformer();
 456                         $element = $this->makeUserLink( $performer );
 457                         if ( $this->entry->isDeleted( LogPage::DELETED_USER ) ) {
 458                                 $element = $this->styleRestricedElement( $element );
 459                         }
 460                 } else {
 461                         $element = $this->getRestrictedElement( 'rev-deleted-user' );
 462                 }
 463
 464                 return $element;
 465         }
 466
 467         /**
 468          * Gets the luser provided comment
 469          * @return string HTML
 470          */
 471         public function getComment() {
 472                 if ( $this->canView( LogPage::DELETED_COMMENT ) ) {
 473                         $comment = Linker::commentBlock( $this->entry->getComment() );
 474                         // No hard coded spaces thanx
 475                         $element = ltrim( $comment );
 476                         if ( $this->entry->isDeleted( LogPage::DELETED_COMMENT ) ) {
 477                                 $element = $this->styleRestricedElement( $element );
 478                         }
 479                 } else {
 480                         $element = $this->getRestrictedElement( 'rev-deleted-comment' );
 481                 }
 482
 483                 return $element;
 484         }
 485
 486         /**
 487          * Helper method for displaying restricted element.
 488          * @param $message string
 489          * @return string HTML or wikitext
 490          */
 491         protected function getRestrictedElement( $message ) {
 492                 if ( $this->plaintext ) {
 493                         return $this->msg( $message )->text();
 494                 }
 495
 496                 $content =  $this->msg( $message )->escaped();
 497                 $attribs = array( 'class' => 'history-deleted' );
 498                 return Html::rawElement( 'span', $attribs, $content );
 499         }
 500
 501         /**
 502          * Helper method for styling restricted element.
 503          * @param $content string
 504          * @return string HTML or wikitext
 505          */
 506         protected function styleRestricedElement( $content ) {
 507                 if ( $this->plaintext ) {
 508                         return $content;
 509                 }
 510                 $attribs = array( 'class' => 'history-deleted' );
 511                 return Html::rawElement( 'span', $attribs, $content );
 512         }
 513
 514         /**
 515          * Shortcut for wfMessage which honors local context.
 516          * @todo Would it be better to require replacing the global context instead?
 517          * @param $key string
 518          * @return Message
 519          */
 520         protected function msg( $key ) {
 521                 return $this->context->msg( $key );
 522         }
 523
 524         protected function makeUserLink( User $user ) {
 525                 if ( $this->plaintext ) {
 526                         $element = $user->getName();
 527                 } else {
 528                         $element = Linker::userLink(
 529                                 $user->getId(),
 530                                 $user->getName()
 531                         );
 532
 533                         if ( $this->linkFlood ) {
 534                                 $element .= Linker::userToolLinksRedContribs(
 535                                         $user->getId(),
 536                                         $user->getName(),
 537                                         $user->getEditCount()
 538                                 );
 539                         }
 540                 }
 541                 return $element;
 542         }
 543
 544         /**
 545          * @return Array of titles that should be preloaded with LinkBatch.
 546          */
 547         public function getPreloadTitles() {
 548                 return array();
 549         }
 550
 551 }
 552
 553 /**
 554  * This class formats all log entries for log types
 555  * which have not been converted to the new system.
 556  * This is not about old log entries which store
 557  * parameters in a different format - the new
 558  * LogFormatter classes have code to support formatting
 559  * those too.
 560  * @since 1.19
 561  */
 562 class LegacyLogFormatter extends LogFormatter {
 563
 564         /**
 565          * Backward compatibility for extension changing the comment from
 566          * the LogLine hook. This will be set by the first call on getComment(),
 567          * then it might be modified by the hook when calling getActionLinks(),
 568          * so that the modified value will be returned when calling getComment()
 569          * a second time.
 570          *
 571          * @var string|null
 572          */
 573         private $comment = null;
 574
 575         /**
 576          * Cache for the result of getActionLinks() so that it does not need to
 577          * run multiple times depending on the order that getComment() and
 578          * getActionLinks() are called.
 579          *
 580          * @var string|null
 581          */
 582         private $revert = null;
 583
 584         public function getComment() {
 585                 if ( $this->comment === null ) {
 586                         $this->comment = parent::getComment();
 587                 }
 588
 589                 // Make sure we execute the LogLine hook so that we immediately return
 590                 // the correct value.
 591                 if ( $this->revert === null ) {
 592                         $this->getActionLinks();
 593                 }
 594
 595                 return $this->comment;
 596         }
 597
 598         protected function getActionMessage() {
 599                 $entry = $this->entry;
 600                 $action = LogPage::actionText(
 601                         $entry->getType(),
 602                         $entry->getSubtype(),
 603                         $entry->getTarget(),
 604                         $this->plaintext ? null : $this->context->getSkin(),
 605                         (array)$entry->getParameters(),
 606                         !$this->plaintext // whether to filter [[]] links
 607                 );
 608
 609                 $performer = $this->getPerformerElement();
 610                 if ( !$this->irctext ) {
 611                         $action = $performer .  $this->msg( 'word-separator' )->text() . $action;
 612                 }
 613
 614                 return $action;
 615         }
 616
 617         public function getActionLinks() {
 618                 if ( $this->revert !== null ) {
 619                         return $this->revert;
 620                 }
 621
 622                 if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
 623                         return $this->revert = '';
 624                 }
 625
 626                 $title = $this->entry->getTarget();
 627                 $type = $this->entry->getType();
 628                 $subtype = $this->entry->getSubtype();
 629
 630                 // Show unblock/change block link
 631                 if ( ( $type == 'block' || $type == 'suppress' ) && ( $subtype == 'block' || $subtype == 'reblock' ) ) {
 632                         if ( !$this->context->getUser()->isAllowed( 'block' ) ) {
 633                                 return '';
 634                         }
 635
 636                         $links = array(
 637                                 Linker::linkKnown(
 638                                         SpecialPage::getTitleFor( 'Unblock', $title->getDBkey() ),
 639                                         $this->msg( 'unblocklink' )->escaped()
 640                                 ),
 641                                 Linker::linkKnown(
 642                                         SpecialPage::getTitleFor( 'Block', $title->getDBkey() ),
 643                                         $this->msg( 'change-blocklink' )->escaped()
 644                                 )
 645                         );
 646                         return $this->msg( 'parentheses' )->rawParams(
 647                                 $this->context->getLanguage()->pipeList( $links ) )->escaped();
 648                 // Show change protection link
 649                 } elseif ( $type == 'protect' && ( $subtype == 'protect' || $subtype == 'modify' || $subtype == 'unprotect' ) ) {
 650                         $links = array(
 651                                 Linker::link( $title,
 652                                         $this->msg( 'hist' )->escaped(),
 653                                         array(),
 654                                         array(
 655                                                 'action' => 'history',
 656                                                 'offset' => $this->entry->getTimestamp()
 657                                         )
 658                                 )
 659                         );
 660                         if ( $this->context->getUser()->isAllowed( 'protect' ) ) {
 661                                 $links[] = Linker::linkKnown(
 662                                         $title,
 663                                         $this->msg( 'protect_change' )->escaped(),
 664                                         array(),
 665                                         array( 'action' => 'protect' )
 666                                 );
 667                         }
 668                         return $this->msg( 'parentheses' )->rawParams(
 669                                 $this->context->getLanguage()->pipeList( $links ) )->escaped();
 670                 // Show unmerge link
 671                 } elseif( $type == 'merge' && $subtype == 'merge' ) {
 672                         if ( !$this->context->getUser()->isAllowed( 'mergehistory' ) ) {
 673                                 return '';
 674                         }
 675
 676                         $params = $this->extractParameters();
 677                         $revert = Linker::linkKnown(
 678                                 SpecialPage::getTitleFor( 'MergeHistory' ),
 679                                 $this->msg( 'revertmerge' )->escaped(),
 680                                 array(),
 681                                 array(
 682                                         'target' => $params[3],
 683                                         'dest' => $title->getPrefixedDBkey(),
 684                                         'mergepoint' => $params[4]
 685                                 )
 686                         );
 687                         return $this->msg( 'parentheses' )->rawParams( $revert )->escaped();
 688                 }
 689
 690                 // Do nothing. The implementation is handled by the hook modifiying the
 691                 // passed-by-ref parameters. This also changes the default value so that
 692                 // getComment() and getActionLinks() do not call them indefinitely.
 693                 $this->revert = '';
 694
 695                 // This is to populate the $comment member of this instance so that it
 696                 // can be modified when calling the hook just below.
 697                 if ( $this->comment === null ) {
 698                         $this->getComment();
 699                 }
 700
 701                 $params = $this->entry->getParameters();
 702
 703                 wfRunHooks( 'LogLine', array( $type, $subtype, $title, $params,
 704                         &$this->comment, &$this->revert, $this->entry->getTimestamp() ) );
 705
 706                 return $this->revert;
 707         }
 708 }
 709
 710 /**
 711  * This class formats move log entries.
 712  * @since 1.19
 713  */
 714 class MoveLogFormatter extends LogFormatter {
 715         public function getPreloadTitles() {
 716                 $params = $this->extractParameters();
 717                 return array( Title::newFromText( $params[3] ) );
 718         }
 719
 720         protected function getMessageKey() {
 721                 $key = parent::getMessageKey();
 722                 $params = $this->getMessageParameters();
 723                 if ( isset( $params[4] ) && $params[4] === '1' ) {
 724                         $key .= '-noredirect';
 725                 }
 726                 return $key;
 727         }
 728
 729         protected function getMessageParameters() {
 730                 $params = parent::getMessageParameters();
 731                 $oldname = $this->makePageLink( $this->entry->getTarget(), array( 'redirect' => 'no' ) );
 732                 $newname = $this->makePageLink( Title::newFromText( $params[3] ) );
 733                 $params[2] = Message::rawParam( $oldname );
 734                 $params[3] = Message::rawParam( $newname );
 735                 return $params;
 736         }
 737
 738         public function getActionLinks() {
 739                 if ( $this->entry->isDeleted( LogPage::DELETED_ACTION ) // Action is hidden
 740                         || $this->entry->getSubtype() !== 'move'
 741                         || !$this->context->getUser()->isAllowed( 'move' ) )
 742                 {
 743                         return '';
 744                 }
 745
 746                 $params = $this->extractParameters();
 747                 $destTitle = Title::newFromText( $params[3] );
 748                 if ( !$destTitle ) {
 749                         return '';
 750                 }
 751
 752                 $revert = Linker::linkKnown(
 753                         SpecialPage::getTitleFor( 'Movepage' ),
 754                         $this->msg( 'revertmove' )->escaped(),
 755                         array(),
 756                         array(
 757                                 'wpOldTitle' => $destTitle->getPrefixedDBkey(),
 758                                 'wpNewTitle' => $this->entry->getTarget()->getPrefixedDBkey(),
 759                                 'wpReason'   => $this->msg( 'revertmove' )->inContentLanguage()->text(),
 760                                 'wpMovetalk' => 0
 761                         )
 762                 );
 763                 return $this->msg( 'parentheses' )->rawParams( $revert )->escaped();
 764         }
 765 }
 766
 767 /**
 768  * This class formats delete log entries.
 769  * @since 1.19
 770  */
 771 class DeleteLogFormatter extends LogFormatter {
 772         protected function getMessageKey() {
 773                 $key = parent::getMessageKey();
 774                 if ( in_array( $this->entry->getSubtype(), array( 'event', 'revision' ) ) ) {
 775                         if ( count( $this->getMessageParameters() ) < 5 ) {
 776                                 return "$key-legacy";
 777                         }
 778                 }
 779                 return $key;
 780         }
 781
 782         protected function getMessageParameters() {
 783                 if ( isset( $this->parsedParametersDeleteLog ) ) {
 784                         return $this->parsedParametersDeleteLog;
 785                 }
 786
 787                 $params = parent::getMessageParameters();
 788                 $subtype = $this->entry->getSubtype();
 789                 if ( in_array( $subtype, array( 'event', 'revision' ) ) ) {
 790                         if (
 791                                 ($subtype === 'event' && count( $params ) === 6 ) ||
 792                                 ($subtype === 'revision' && isset( $params[3] ) && $params[3] === 'revision' )
 793                         ) {
 794                                 $paramStart = $subtype === 'revision' ? 4 : 3;
 795
 796                                 $old = $this->parseBitField( $params[$paramStart+1] );
 797                                 $new = $this->parseBitField( $params[$paramStart+2] );
 798                                 list( $hid, $unhid, $extra ) = RevisionDeleter::getChanges( $new, $old );
 799                                 $changes = array();
 800                                 foreach ( $hid as $v ) {
 801                                         $changes[] = $this->msg( "$v-hid" )->plain();
 802                                 }
 803                                 foreach ( $unhid as $v ) {
 804                                         $changes[] = $this->msg( "$v-unhid" )->plain();
 805                                 }
 806                                 foreach ( $extra as $v ) {
 807                                         $changes[] = $this->msg( $v )->plain();
 808                                 }
 809                                 $changeText =  $this->context->getLanguage()->listToText( $changes );
 810
 811
 812                                 $newParams = array_slice( $params, 0, 3 );
 813                                 $newParams[3] = $changeText;
 814                                 $count = count( explode( ',', $params[$paramStart] ) );
 815                                 $newParams[4] = $this->context->getLanguage()->formatNum( $count );
 816                                 return $this->parsedParametersDeleteLog = $newParams;
 817                         } else {
 818                                 return $this->parsedParametersDeleteLog = array_slice( $params, 0, 3 );
 819                         }
 820                 }
 821
 822                 return $this->parsedParametersDeleteLog = $params;
 823         }
 824
 825         protected function parseBitField( $string ) {
 826                 // Input is like ofield=2134 or just the number
 827                 if ( strpos( $string, 'field=' ) === 1 ) {
 828                         list( , $field ) = explode( '=', $string );
 829                         return (int) $field;
 830                 } else {
 831                         return (int) $string;
 832                 }
 833         }
 834
 835         public function getActionLinks() {
 836                 $user = $this->context->getUser();
 837                 if ( !$user->isAllowed( 'deletedhistory' ) || $this->entry->isDeleted( LogPage::DELETED_ACTION ) ) {
 838                         return '';
 839                 }
 840
 841                 switch ( $this->entry->getSubtype() ) {
 842                 case 'delete': // Show undelete link
 843                         if( $user->isAllowed( 'undelete' ) ) {
 844                                 $message = 'undeletelink';
 845                         } else {
 846                                 $message = 'undeleteviewlink';
 847                         }
 848                         $revert = Linker::linkKnown(
 849                                 SpecialPage::getTitleFor( 'Undelete' ),
 850                                 $this->msg( $message )->escaped(),
 851                                 array(),
 852                                 array( 'target' => $this->entry->getTarget()->getPrefixedDBkey() )
 853                          );
 854                         return $this->msg( 'parentheses' )->rawParams( $revert )->escaped();
 855
 856                 case 'revision': // If an edit was hidden from a page give a review link to the history
 857                         $params = $this->extractParameters();
 858                         if ( !isset( $params[3] ) || !isset( $params[4] ) ) {
 859                                 return '';
 860                         }
 861
 862                         // Different revision types use different URL params...
 863                         $key = $params[3];
 864                         // This is a CSV of the IDs
 865                         $ids = explode( ',', $params[4] );
 866
 867                         $links = array();
 868
 869                         // If there's only one item, we can show a diff link
 870                         if ( count( $ids ) == 1 ) {
 871                                 // Live revision diffs...
 872                                 if ( $key == 'oldid' || $key == 'revision' ) {
 873                                         $links[] = Linker::linkKnown(
 874                                                 $this->entry->getTarget(),
 875                                                 $this->msg( 'diff' )->escaped(),
 876                                                 array(),
 877                                                 array(
 878                                                         'diff' => intval( $ids[0] ),
 879                                                         'unhide' => 1
 880                                                 )
 881                                         );
 882                                 // Deleted revision diffs...
 883                                 } elseif ( $key == 'artimestamp' || $key == 'archive' ) {
 884                                         $links[] = Linker::linkKnown(
 885                                                 SpecialPage::getTitleFor( 'Undelete' ),
 886                                                 $this->msg( 'diff' )->escaped(),
 887                                                 array(),
 888                                                 array(
 889                                                         'target'    => $this->entry->getTarget()->getPrefixedDBKey(),
 890                                                         'diff'      => 'prev',
 891                                                         'timestamp' => $ids[0]
 892                                                 )
 893                                         );
 894                                 }
 895                         }
 896
 897                         // View/modify link...
 898                         $links[] = Linker::linkKnown(
 899                                 SpecialPage::getTitleFor( 'Revisiondelete' ),
 900                                 $this->msg( 'revdel-restore' )->escaped(),
 901                                 array(),
 902                                 array(
 903                                         'target' => $this->entry->getTarget()->getPrefixedText(),
 904                                         'type' => $key,
 905                                         'ids' => implode( ',', $ids ),
 906                                 )
 907                         );
 908
 909                         return $this->msg( 'parentheses' )->rawParams(
 910                                 $this->context->getLanguage()->pipeList( $links ) )->escaped();
 911
 912                 case 'event': // Hidden log items, give review link
 913                         $params = $this->extractParameters();
 914                         if ( !isset( $params[3] ) ) {
 915                                 return '';
 916                         }
 917                         // This is a CSV of the IDs
 918                         $query = $params[3];
 919                         // Link to each hidden object ID, $params[1] is the url param
 920                         $revert = Linker::linkKnown(
 921                                 SpecialPage::getTitleFor( 'Revisiondelete' ),
 922                                 $this->msg( 'revdel-restore' )->escaped(),
 923                                 array(),
 924                                 array(
 925                                         'target' => $this->entry->getTarget()->getPrefixedText(),
 926                                         'type' => 'logging',
 927                                         'ids' => $query
 928                                 )
 929                         );
 930                         return $this->msg( 'parentheses' )->rawParams( $revert )->escaped();
 931                 default:
 932                         return '';
 933                 }
 934         }
 935 }
 936
 937 /**
 938  * This class formats patrol log entries.
 939  * @since 1.19
 940  */
 941 class PatrolLogFormatter extends LogFormatter {
 942         protected function getMessageKey() {
 943                 $key = parent::getMessageKey();
 944                 $params = $this->getMessageParameters();
 945                 if ( isset( $params[5] ) && $params[5] ) {
 946                         $key .= '-auto';
 947                 }
 948                 return $key;
 949         }
 950
 951         protected function getMessageParameters() {
 952                 $params = parent::getMessageParameters();
 953
 954                 $target = $this->entry->getTarget();
 955                 $oldid = $params[3];
 956                 $revision = $this->context->getLanguage()->formatNum( $oldid, true );
 957
 958                 if ( $this->plaintext ) {
 959                         $revlink = $revision;
 960                 } elseif ( $target->exists() ) {
 961                         $query = array(
 962                                 'oldid' => $oldid,
 963                                 'diff' => 'prev'
 964                         );
 965                         $revlink = Linker::link( $target, htmlspecialchars( $revision ), array(), $query );
 966                 } else {
 967                         $revlink = htmlspecialchars( $revision );
 968                 }
 969
 970                 $params[3] = Message::rawParam( $revlink );
 971                 return $params;
 972         }
 973 }
 974
 975 /**
 976  * This class formats new user log entries.
 977  * @since 1.19
 978  */
 979 class NewUsersLogFormatter extends LogFormatter {
 980         protected function getMessageParameters() {
 981                 $params = parent::getMessageParameters();
 982                 if ( $this->entry->getSubtype() === 'create2' ) {
 983                         if ( isset( $params[3] ) ) {
 984                                 $target = User::newFromId( $params[3] );
 985                         } else {
 986                                 $target = User::newFromName( $this->entry->getTarget()->getText(), false );
 987                         }
 988                         $params[2] = Message::rawParam( $this->makeUserLink( $target ) );
 989                         $params[3] = $target->getName();
 990                 }
 991                 return $params;
 992         }
 993
 994         public function getComment() {
 995                 $timestamp = wfTimestamp( TS_MW, $this->entry->getTimestamp() );
 996                 if ( $timestamp < '20080129000000' ) {
 997                         # Suppress $comment from old entries (before 2008-01-29),
 998                         # not needed and can contain incorrect links
 999                         return '';
1000                 }
1001                 return parent::getComment();
1002         }
1003
1004         public function getPreloadTitles() {
1005                 if ( $this->entry->getSubtype() === 'create2' ) {
1006                         //add the user talk to LinkBatch for the userLink
1007                         return array( Title::makeTitle( NS_USER_TALK, $this->entry->getTarget()->getText() ) );
1008                 }
1009                 return array();
1010         }
1011 }