includes/changes/ChangesList.php

   1 <?php
   2 /**
   3  * Base class for all changes lists.
   4  *
   5  * The class is used for formatting recent changes, related changes and watchlist.
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  */
  24
  25 class ChangesList extends ContextSource {
  26         /**
  27          * @var Skin
  28          */
  29         public $skin;
  30
  31         protected $watchlist = false;
  32         protected $lastdate;
  33         protected $message;
  34         protected $rc_cache;
  35         protected $rcCacheIndex;
  36         protected $rclistOpen;
  37         protected $rcMoveIndex;
  38
  39         /**
  40          * Changeslist constructor
  41          *
  42          * @param Skin|IContextSource $obj
  43          */
  44         public function __construct( $obj ) {
  45                 if ( $obj instanceof IContextSource ) {
  46                         $this->setContext( $obj );
  47                         $this->skin = $obj->getSkin();
  48                 } else {
  49                         $this->setContext( $obj->getContext() );
  50                         $this->skin = $obj;
  51                 }
  52                 $this->preCacheMessages();
  53         }
  54
  55         /**
  56          * Fetch an appropriate changes list class for the specified context
  57          * Some users might want to use an enhanced list format, for instance
  58          *
  59          * @param IContextSource $context
  60          * @return ChangesList
  61          */
  62         public static function newFromContext( IContextSource $context ) {
  63                 $user = $context->getUser();
  64                 $sk = $context->getSkin();
  65                 $list = null;
  66                 if ( wfRunHooks( 'FetchChangesList', array( $user, &$sk, &$list ) ) ) {
  67                         $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) );
  68
  69                         return $new ? new EnhancedChangesList( $context ) : new OldChangesList( $context );
  70                 } else {
  71                         return $list;
  72                 }
  73         }
  74
  75         /**
  76          * Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag
  77          * @param bool $value
  78          */
  79         public function setWatchlistDivs( $value = true ) {
  80                 $this->watchlist = $value;
  81         }
  82
  83         /**
  84          * @return bool True when setWatchlistDivs has been called
  85          * @since 1.23
  86          */
  87         public function isWatchlist() {
  88                 return (bool)$this->watchlist;
  89         }
  90
  91         /**
  92          * As we use the same small set of messages in various methods and that
  93          * they are called often, we call them once and save them in $this->message
  94          */
  95         private function preCacheMessages() {
  96                 if ( !isset( $this->message ) ) {
  97                         foreach ( array(
  98                                 'cur', 'diff', 'hist', 'enhancedrc-history', 'last', 'blocklink', 'history',
  99                                 'semicolon-separator', 'pipe-separator' ) as $msg
 100                         ) {
 101                                 $this->message[$msg] = $this->msg( $msg )->escaped();
 102                         }
 103                 }
 104         }
 105
 106         /**
 107          * Returns the appropriate flags for new page, minor change and patrolling
 108          * @param array $flags Associative array of 'flag' => Bool
 109          * @param string $nothing To use for empty space
 110          * @return string
 111          */
 112         public function recentChangesFlags( $flags, $nothing = '&#160;' ) {
 113                 global $wgRecentChangesFlags;
 114                 $f = '';
 115                 foreach ( array_keys( $wgRecentChangesFlags ) as $flag ) {
 116                         $f .= isset( $flags[$flag] ) && $flags[$flag]
 117                                 ? self::flag( $flag )
 118                                 : $nothing;
 119                 }
 120
 121                 return $f;
 122         }
 123
 124         /**
 125          * Provide the "<abbr>" element appropriate to a given abbreviated flag,
 126          * namely the flag indicating a new page, a minor edit, a bot edit, or an
 127          * unpatrolled edit.  By default in English it will contain "N", "m", "b",
 128          * "!" respectively, plus it will have an appropriate title and class.
 129          *
 130          * @param string $flag One key of $wgRecentChangesFlags
 131          * @return string Raw HTML
 132          */
 133         public static function flag( $flag ) {
 134                 static $flagInfos = null;
 135                 if ( is_null( $flagInfos ) ) {
 136                         global $wgRecentChangesFlags;
 137                         $flagInfos = array();
 138                         foreach ( $wgRecentChangesFlags as $key => $value ) {
 139                                 $flagInfos[$key]['letter'] = wfMessage( $value['letter'] )->escaped();
 140                                 $flagInfos[$key]['title'] = wfMessage( $value['title'] )->escaped();
 141                                 // Allow customized class name, fall back to flag name
 142                                 $flagInfos[$key]['class'] = Sanitizer::escapeClass(
 143                                         isset( $value['class'] ) ? $value['class'] : $key );
 144                         }
 145                 }
 146
 147                 // Inconsistent naming, bleh, kepted for b/c
 148                 $map = array(
 149                         'minoredit' => 'minor',
 150                         'botedit' => 'bot',
 151                 );
 152                 if ( isset( $map[$flag] ) ) {
 153                         $flag = $map[$flag];
 154                 }
 155
 156                 return "<abbr class='" . $flagInfos[$flag]['class'] . "' title='" .
 157                         $flagInfos[$flag]['title'] . "'>" . $flagInfos[$flag]['letter'] .
 158                         '</abbr>';
 159         }
 160
 161         /**
 162          * Returns text for the start of the tabular part of RC
 163          * @return string
 164          */
 165         public function beginRecentChangesList() {
 166                 $this->rc_cache = array();
 167                 $this->rcMoveIndex = 0;
 168                 $this->rcCacheIndex = 0;
 169                 $this->lastdate = '';
 170                 $this->rclistOpen = false;
 171                 $this->getOutput()->addModuleStyles( 'mediawiki.special.changeslist' );
 172
 173                 return '<div class="mw-changeslist">';
 174         }
 175
 176         /**
 177          * @param ResultWrapper|array $rows
 178          */
 179         public function initChangesListRows( $rows ) {
 180                 wfRunHooks( 'ChangesListInitRows', array( $this, $rows ) );
 181         }
 182
 183         /**
 184          * Show formatted char difference
 185          * @param int $old Number of bytes
 186          * @param int $new Number of bytes
 187          * @param IContextSource $context
 188          * @return string
 189          */
 190         public static function showCharacterDifference( $old, $new, IContextSource $context = null ) {
 191                 global $wgRCChangedSizeThreshold, $wgMiserMode;
 192
 193                 if ( !$context ) {
 194                         $context = RequestContext::getMain();
 195                 }
 196
 197                 $new = (int)$new;
 198                 $old = (int)$old;
 199                 $szdiff = $new - $old;
 200
 201                 $lang = $context->getLanguage();
 202                 $code = $lang->getCode();
 203                 static $fastCharDiff = array();
 204                 if ( !isset( $fastCharDiff[$code] ) ) {
 205                         $fastCharDiff[$code] = $wgMiserMode || $context->msg( 'rc-change-size' )->plain() === '$1';
 206                 }
 207
 208                 $formattedSize = $lang->formatNum( $szdiff );
 209
 210                 if ( !$fastCharDiff[$code] ) {
 211                         $formattedSize = $context->msg( 'rc-change-size', $formattedSize )->text();
 212                 }
 213
 214                 if ( abs( $szdiff ) > abs( $wgRCChangedSizeThreshold ) ) {
 215                         $tag = 'strong';
 216                 } else {
 217                         $tag = 'span';
 218                 }
 219
 220                 if ( $szdiff === 0 ) {
 221                         $formattedSizeClass = 'mw-plusminus-null';
 222                 } elseif ( $szdiff > 0 ) {
 223                         $formattedSize = '+' . $formattedSize;
 224                         $formattedSizeClass = 'mw-plusminus-pos';
 225                 } else {
 226                         $formattedSizeClass = 'mw-plusminus-neg';
 227                 }
 228
 229                 $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text();
 230
 231                 return Html::element( $tag,
 232                         array( 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ),
 233                         $context->msg( 'parentheses', $formattedSize )->plain() ) . $lang->getDirMark();
 234         }
 235
 236         /**
 237          * Format the character difference of one or several changes.
 238          *
 239          * @param RecentChange $old
 240          * @param RecentChange $new Last change to use, if not provided, $old will be used
 241          * @return string HTML fragment
 242          */
 243         public function formatCharacterDifference( RecentChange $old, RecentChange $new = null ) {
 244                 $oldlen = $old->mAttribs['rc_old_len'];
 245
 246                 if ( $new ) {
 247                         $newlen = $new->mAttribs['rc_new_len'];
 248                 } else {
 249                         $newlen = $old->mAttribs['rc_new_len'];
 250                 }
 251
 252                 if ( $oldlen === null || $newlen === null ) {
 253                         return '';
 254                 }
 255
 256                 return self::showCharacterDifference( $oldlen, $newlen, $this->getContext() );
 257         }
 258
 259         /**
 260          * Returns text for the end of RC
 261          * @return string
 262          */
 263         public function endRecentChangesList() {
 264                 $out = $this->rclistOpen ? "</ul>\n" : '';
 265                 $out .= '</div>';
 266
 267                 return $out;
 268         }
 269
 270         /**
 271          * @param string $s HTML to update
 272          * @param mixed $rc_timestamp
 273          */
 274         public function insertDateHeader( &$s, $rc_timestamp ) {
 275                 # Make date header if necessary
 276                 $date = $this->getLanguage()->userDate( $rc_timestamp, $this->getUser() );
 277                 if ( $date != $this->lastdate ) {
 278                         if ( $this->lastdate != '' ) {
 279                                 $s .= "</ul>\n";
 280                         }
 281                         $s .= Xml::element( 'h4', null, $date ) . "\n<ul class=\"special\">";
 282                         $this->lastdate = $date;
 283                         $this->rclistOpen = true;
 284                 }
 285         }
 286
 287         /**
 288          * @param string $s HTML to update
 289          * @param Title $title
 290          * @param string $logtype
 291          */
 292         public function insertLog( &$s, $title, $logtype ) {
 293                 $page = new LogPage( $logtype );
 294                 $logname = $page->getName()->escaped();
 295                 $s .= $this->msg( 'parentheses' )->rawParams( Linker::linkKnown( $title, $logname ) )->escaped();
 296         }
 297
 298         /**
 299          * @param string $s HTML to update
 300          * @param RecentChange $rc
 301          * @param bool $unpatrolled
 302          */
 303         public function insertDiffHist( &$s, &$rc, $unpatrolled ) {
 304                 # Diff link
 305                 if ( $rc->mAttribs['rc_type'] == RC_NEW || $rc->mAttribs['rc_type'] == RC_LOG ) {
 306                         $diffLink = $this->message['diff'];
 307                 } elseif ( !self::userCan( $rc, Revision::DELETED_TEXT, $this->getUser() ) ) {
 308                         $diffLink = $this->message['diff'];
 309                 } else {
 310                         $query = array(
 311                                 'curid' => $rc->mAttribs['rc_cur_id'],
 312                                 'diff' => $rc->mAttribs['rc_this_oldid'],
 313                                 'oldid' => $rc->mAttribs['rc_last_oldid']
 314                         );
 315
 316                         $diffLink = Linker::linkKnown(
 317                                 $rc->getTitle(),
 318                                 $this->message['diff'],
 319                                 array( 'tabindex' => $rc->counter ),
 320                                 $query
 321                         );
 322                 }
 323                 $diffhist = $diffLink . $this->message['pipe-separator'];
 324                 # History link
 325                 $diffhist .= Linker::linkKnown(
 326                         $rc->getTitle(),
 327                         $this->message['hist'],
 328                         array(),
 329                         array(
 330                                 'curid' => $rc->mAttribs['rc_cur_id'],
 331                                 'action' => 'history'
 332                         )
 333                 );
 334                 // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
 335                 $s .= $this->msg( 'parentheses' )->rawParams( $diffhist )->escaped() .
 336                         ' <span class="mw-changeslist-separator">. .</span> ';
 337         }
 338
 339         /**
 340          * @param string $s HTML to update
 341          * @param RecentChange $rc
 342          * @param bool $unpatrolled
 343          * @param bool $watched
 344          */
 345         public function insertArticleLink( &$s, &$rc, $unpatrolled, $watched ) {
 346                 $params = array();
 347
 348                 $articlelink = Linker::linkKnown(
 349                         $rc->getTitle(),
 350                         null,
 351                         array( 'class' => 'mw-changeslist-title' ),
 352                         $params
 353                 );
 354                 if ( $this->isDeleted( $rc, Revision::DELETED_TEXT ) ) {
 355                         $articlelink = '<span class="history-deleted">' . $articlelink . '</span>';
 356                 }
 357                 # To allow for boldening pages watched by this user
 358                 $articlelink = "<span class=\"mw-title\">{$articlelink}</span>";
 359                 # RTL/LTR marker
 360                 $articlelink .= $this->getLanguage()->getDirMark();
 361
 362                 wfRunHooks( 'ChangesListInsertArticleLink',
 363                         array( &$this, &$articlelink, &$s, &$rc, $unpatrolled, $watched ) );
 364
 365                 $s .= " $articlelink";
 366         }
 367
 368         /**
 369          * Get the timestamp from $rc formatted with current user's settings
 370          * and a separator
 371          *
 372          * @param RecentChange $rc
 373          * @return string HTML fragment
 374          */
 375         public function getTimestamp( $rc ) {
 376                 // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
 377                 return $this->message['semicolon-separator'] . '<span class="mw-changeslist-date">' .
 378                         $this->getLanguage()->userTime(
 379                                 $rc->mAttribs['rc_timestamp'],
 380                                 $this->getUser()
 381                         ) . '</span> <span class="mw-changeslist-separator">. .</span> ';
 382         }
 383
 384         /**
 385          * Insert time timestamp string from $rc into $s
 386          *
 387          * @param string $s HTML to update
 388          * @param RecentChange $rc
 389          */
 390         public function insertTimestamp( &$s, $rc ) {
 391                 $s .= $this->getTimestamp( $rc );
 392         }
 393
 394         /**
 395          * Insert links to user page, user talk page and eventually a blocking link
 396          *
 397          * @param string &$s HTML to update
 398          * @param RecentChange &$rc
 399          */
 400         public function insertUserRelatedLinks( &$s, &$rc ) {
 401                 if ( $this->isDeleted( $rc, Revision::DELETED_USER ) ) {
 402                         $s .= ' <span class="history-deleted">' .
 403                                 $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
 404                 } else {
 405                         $s .= $this->getLanguage()->getDirMark() . Linker::userLink( $rc->mAttribs['rc_user'],
 406                                 $rc->mAttribs['rc_user_text'] );
 407                         $s .= Linker::userToolLinks( $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'] );
 408                 }
 409         }
 410
 411         /**
 412          * Insert a formatted action
 413          *
 414          * @param RecentChange $rc
 415          * @return string
 416          */
 417         public function insertLogEntry( $rc ) {
 418                 $formatter = LogFormatter::newFromRow( $rc->mAttribs );
 419                 $formatter->setContext( $this->getContext() );
 420                 $formatter->setShowUserToolLinks( true );
 421                 $mark = $this->getLanguage()->getDirMark();
 422
 423                 return $formatter->getActionText() . " $mark" . $formatter->getComment();
 424         }
 425
 426         /**
 427          * Insert a formatted comment
 428          * @param RecentChange $rc
 429          * @return string
 430          */
 431         public function insertComment( $rc ) {
 432                 if ( $rc->mAttribs['rc_type'] != RC_MOVE && $rc->mAttribs['rc_type'] != RC_MOVE_OVER_REDIRECT ) {
 433                         if ( $this->isDeleted( $rc, Revision::DELETED_COMMENT ) ) {
 434                                 return ' <span class="history-deleted">' .
 435                                         $this->msg( 'rev-deleted-comment' )->escaped() . '</span>';
 436                         } else {
 437                                 return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle() );
 438                         }
 439                 }
 440
 441                 return '';
 442         }
 443
 444         /**
 445          * Check whether to enable recent changes patrol features
 446          *
 447          * @deprecated since 1.22
 448          * @return bool
 449          */
 450         public static function usePatrol() {
 451                 global $wgUser;
 452
 453                 wfDeprecated( __METHOD__, '1.22' );
 454
 455                 return $wgUser->useRCPatrol();
 456         }
 457
 458         /**
 459          * Returns the string which indicates the number of watching users
 460          * @param int $count Number of user watching a page
 461          * @return string
 462          */
 463         protected function numberofWatchingusers( $count ) {
 464                 static $cache = array();
 465                 if ( $count > 0 ) {
 466                         if ( !isset( $cache[$count] ) ) {
 467                                 $cache[$count] = $this->msg( 'number_of_watching_users_RCview' )
 468                                         ->numParams( $count )->escaped();
 469                         }
 470
 471                         return $cache[$count];
 472                 } else {
 473                         return '';
 474                 }
 475         }
 476
 477         /**
 478          * Determine if said field of a revision is hidden
 479          * @param RCCacheEntry|RecentChange $rc
 480          * @param int $field One of DELETED_* bitfield constants
 481          * @return bool
 482          */
 483         public static function isDeleted( $rc, $field ) {
 484                 return ( $rc->mAttribs['rc_deleted'] & $field ) == $field;
 485         }
 486
 487         /**
 488          * Determine if the current user is allowed to view a particular
 489          * field of this revision, if it's marked as deleted.
 490          * @param RCCacheEntry|RecentChange $rc
 491          * @param int $field
 492          * @param User $user User object to check, or null to use $wgUser
 493          * @return bool
 494          */
 495         public static function userCan( $rc, $field, User $user = null ) {
 496                 if ( $rc->mAttribs['rc_type'] == RC_LOG ) {
 497                         return LogEventsList::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
 498                 } else {
 499                         return Revision::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
 500                 }
 501         }
 502
 503         /**
 504          * @param string $link
 505          * @param bool $watched
 506          * @return string
 507          */
 508         protected function maybeWatchedLink( $link, $watched = false ) {
 509                 if ( $watched ) {
 510                         return '<strong class="mw-watched">' . $link . '</strong>';
 511                 } else {
 512                         return '<span class="mw-rc-unwatched">' . $link . '</span>';
 513                 }
 514         }
 515
 516         /** Inserts a rollback link
 517          *
 518          * @param string $s
 519          * @param RecentChange $rc
 520          */
 521         public function insertRollback( &$s, &$rc ) {
 522                 if ( $rc->mAttribs['rc_type'] == RC_EDIT
 523                         && $rc->mAttribs['rc_this_oldid']
 524                         && $rc->mAttribs['rc_cur_id']
 525                 ) {
 526                         $page = $rc->getTitle();
 527                         /** Check for rollback and edit permissions, disallow special pages, and only
 528                          * show a link on the top-most revision */
 529                         if ( $this->getUser()->isAllowed( 'rollback' )
 530                                 && $rc->mAttribs['page_latest'] == $rc->mAttribs['rc_this_oldid']
 531                         ) {
 532                                 $rev = new Revision( array(
 533                                         'title' => $page,
 534                                         'id' => $rc->mAttribs['rc_this_oldid'],
 535                                         'user' => $rc->mAttribs['rc_user'],
 536                                         'user_text' => $rc->mAttribs['rc_user_text'],
 537                                         'deleted' => $rc->mAttribs['rc_deleted']
 538                                 ) );
 539                                 $s .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
 540                         }
 541                 }
 542         }
 543
 544         /**
 545          * @param string $s
 546          * @param RecentChange $rc
 547          * @param array $classes
 548          */
 549         public function insertTags( &$s, &$rc, &$classes ) {
 550                 if ( empty( $rc->mAttribs['ts_tags'] ) ) {
 551                         return;
 552                 }
 553
 554                 list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
 555                         $rc->mAttribs['ts_tags'],
 556                         'changeslist'
 557                 );
 558                 $classes = array_merge( $classes, $newClasses );
 559                 $s .= ' ' . $tagSummary;
 560         }
 561
 562         public function insertExtra( &$s, &$rc, &$classes ) {
 563                 // Empty, used for subclasses to add anything special.
 564         }
 565
 566         protected function showAsUnpatrolled( RecentChange $rc ) {
 567                 return self::isUnpatrolled( $rc, $this->getUser() );
 568         }
 569
 570         /**
 571          * @param object|RecentChange $rc Database row from recentchanges or a RecentChange object
 572          * @param User $user
 573          * @return bool
 574          */
 575         public static function isUnpatrolled( $rc, User $user ) {
 576                 if ( $rc instanceof RecentChange ) {
 577                         $isPatrolled = $rc->mAttribs['rc_patrolled'];
 578                         $rcType = $rc->mAttribs['rc_type'];
 579                 } else {
 580                         $isPatrolled = $rc->rc_patrolled;
 581                         $rcType = $rc->rc_type;
 582                 }
 583
 584                 if ( !$isPatrolled ) {
 585                         if ( $user->useRCPatrol() ) {
 586                                 return true;
 587                         }
 588                         if ( $user->useNPPatrol() && $rcType == RC_NEW ) {
 589                                 return true;
 590                         }
 591                 }
 592
 593                 return false;
 594         }
 595 }