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 use MediaWiki\Linker\LinkRenderer;
  25 use MediaWiki\MediaWikiServices;
  26 use Wikimedia\Rdbms\ResultWrapper;
  27
  28 class ChangesList extends ContextSource {
  29         const CSS_CLASS_PREFIX = 'mw-changeslist-';
  30
  31         /**
  32          * @var Skin
  33          */
  34         public $skin;
  35
  36         protected $watchlist = false;
  37         protected $lastdate;
  38         protected $message;
  39         protected $rc_cache;
  40         protected $rcCacheIndex;
  41         protected $rclistOpen;
  42         protected $rcMoveIndex;
  43
  44         /** @var callable */
  45         protected $changeLinePrefixer;
  46
  47         /** @var MapCacheLRU */
  48         protected $watchMsgCache;
  49
  50         /**
  51          * @var LinkRenderer
  52          */
  53         protected $linkRenderer;
  54
  55         /**
  56          * @var array
  57          */
  58         protected $filterGroups;
  59
  60         /**
  61          * @param Skin|IContextSource $obj
  62          * @param array $filterGroups Array of ChangesListFilterGroup objects (currently optional)
  63          */
  64         public function __construct( $obj, array $filterGroups = [] ) {
  65                 if ( $obj instanceof IContextSource ) {
  66                         $this->setContext( $obj );
  67                         $this->skin = $obj->getSkin();
  68                 } else {
  69                         $this->setContext( $obj->getContext() );
  70                         $this->skin = $obj;
  71                 }
  72                 $this->preCacheMessages();
  73                 $this->watchMsgCache = new MapCacheLRU( 50 );
  74                 $this->linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
  75                 $this->filterGroups = $filterGroups;
  76         }
  77
  78         /**
  79          * Fetch an appropriate changes list class for the specified context
  80          * Some users might want to use an enhanced list format, for instance
  81          *
  82          * @param IContextSource $context
  83          * @param array $groups Array of ChangesListFilterGroup objects (currently optional)
  84          * @return ChangesList
  85          */
  86         public static function newFromContext( IContextSource $context, array $groups = [] ) {
  87                 $user = $context->getUser();
  88                 $sk = $context->getSkin();
  89                 $list = null;
  90                 if ( Hooks::run( 'FetchChangesList', [ $user, &$sk, &$list ] ) ) {
  91                         $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) );
  92
  93                         return $new ?
  94                                 new EnhancedChangesList( $context, $groups ) :
  95                                 new OldChangesList( $context, $groups );
  96                 } else {
  97                         return $list;
  98                 }
  99         }
 100
 101         /**
 102          * Format a line
 103          *
 104          * @since 1.27
 105          *
 106          * @param RecentChange &$rc Passed by reference
 107          * @param bool $watched (default false)
 108          * @param int|null $linenumber (default null)
 109          *
 110          * @return string|bool
 111          */
 112         public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
 113                 throw new RuntimeException( 'recentChangesLine should be implemented' );
 114         }
 115
 116         /**
 117          * Get the container for highlights that are used in the new StructuredFilters
 118          * system
 119          *
 120          * @return string HTML structure of the highlight container div
 121          */
 122         protected function getHighlightsContainerDiv() {
 123                 $highlightColorDivs = '';
 124                 foreach ( [ 'none', 'c1', 'c2', 'c3', 'c4', 'c5' ] as $color ) {
 125                         $highlightColorDivs .= Html::rawElement(
 126                                 'div',
 127                                 [
 128                                         'class' => 'mw-rcfilters-ui-highlights-color-' . $color,
 129                                         'data-color' => $color
 130                                 ]
 131                         );
 132                 }
 133
 134                 return Html::rawElement(
 135                         'div',
 136                         [ 'class' => 'mw-rcfilters-ui-highlights' ],
 137                         $highlightColorDivs
 138                 );
 139         }
 140
 141         /**
 142          * Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag
 143          * @param bool $value
 144          */
 145         public function setWatchlistDivs( $value = true ) {
 146                 $this->watchlist = $value;
 147         }
 148
 149         /**
 150          * @return bool True when setWatchlistDivs has been called
 151          * @since 1.23
 152          */
 153         public function isWatchlist() {
 154                 return (bool)$this->watchlist;
 155         }
 156
 157         /**
 158          * As we use the same small set of messages in various methods and that
 159          * they are called often, we call them once and save them in $this->message
 160          */
 161         private function preCacheMessages() {
 162                 if ( !isset( $this->message ) ) {
 163                         foreach ( [
 164                                 'cur', 'diff', 'hist', 'enhancedrc-history', 'last', 'blocklink', 'history',
 165                                 'semicolon-separator', 'pipe-separator' ] as $msg
 166                         ) {
 167                                 $this->message[$msg] = $this->msg( $msg )->escaped();
 168                         }
 169                 }
 170         }
 171
 172         /**
 173          * Returns the appropriate flags for new page, minor change and patrolling
 174          * @param array $flags Associative array of 'flag' => Bool
 175          * @param string $nothing To use for empty space
 176          * @return string
 177          */
 178         public function recentChangesFlags( $flags, $nothing = "\u{00A0}" ) {
 179                 $f = '';
 180                 foreach ( array_keys( $this->getConfig()->get( 'RecentChangesFlags' ) ) as $flag ) {
 181                         $f .= isset( $flags[$flag] ) && $flags[$flag]
 182                                 ? self::flag( $flag, $this->getContext() )
 183                                 : $nothing;
 184                 }
 185
 186                 return $f;
 187         }
 188
 189         /**
 190          * Get an array of default HTML class attributes for the change.
 191          *
 192          * @param RecentChange|RCCacheEntry $rc
 193          * @param string|bool $watched Optionally timestamp for adding watched class
 194          *
 195          * @return array of classes
 196          */
 197         protected function getHTMLClasses( $rc, $watched ) {
 198                 $classes = [ self::CSS_CLASS_PREFIX . 'line' ];
 199                 $logType = $rc->mAttribs['rc_log_type'];
 200
 201                 if ( $logType ) {
 202                         $classes[] = self::CSS_CLASS_PREFIX . 'log';
 203                         $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'log-' . $logType );
 204                 } else {
 205                         $classes[] = self::CSS_CLASS_PREFIX . 'edit';
 206                         $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'ns' .
 207                                 $rc->mAttribs['rc_namespace'] . '-' . $rc->mAttribs['rc_title'] );
 208                 }
 209
 210                 // Indicate watched status on the line to allow for more
 211                 // comprehensive styling.
 212                 $classes[] = $watched && $rc->mAttribs['rc_timestamp'] >= $watched
 213                         ? self::CSS_CLASS_PREFIX . 'line-watched'
 214                         : self::CSS_CLASS_PREFIX . 'line-not-watched';
 215
 216                 $classes = array_merge( $classes, $this->getHTMLClassesForFilters( $rc ) );
 217
 218                 return $classes;
 219         }
 220
 221         /**
 222          * Get an array of CSS classes attributed to filters for this row. Used for highlighting
 223          * in the front-end.
 224          *
 225          * @param RecentChange $rc
 226          * @return array Array of CSS classes
 227          */
 228         protected function getHTMLClassesForFilters( $rc ) {
 229                 $classes = [];
 230
 231                 $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'ns-' .
 232                         $rc->mAttribs['rc_namespace'] );
 233
 234                 if ( $this->filterGroups !== null ) {
 235                         foreach ( $this->filterGroups as $filterGroup ) {
 236                                 foreach ( $filterGroup->getFilters() as $filter ) {
 237                                         $filter->applyCssClassIfNeeded( $this, $rc, $classes );
 238                                 }
 239                         }
 240                 }
 241
 242                 return $classes;
 243         }
 244
 245         /**
 246          * Make an "<abbr>" element for a given change flag. The flag indicating a new page, minor edit,
 247          * bot edit, or unpatrolled edit. In English it typically contains "N", "m", "b", or "!".
 248          *
 249          * @param string $flag One key of $wgRecentChangesFlags
 250          * @param IContextSource|null $context
 251          * @return string HTML
 252          */
 253         public static function flag( $flag, IContextSource $context = null ) {
 254                 static $map = [ 'minoredit' => 'minor', 'botedit' => 'bot' ];
 255                 static $flagInfos = null;
 256
 257                 if ( is_null( $flagInfos ) ) {
 258                         global $wgRecentChangesFlags;
 259                         $flagInfos = [];
 260                         foreach ( $wgRecentChangesFlags as $key => $value ) {
 261                                 $flagInfos[$key]['letter'] = $value['letter'];
 262                                 $flagInfos[$key]['title'] = $value['title'];
 263                                 // Allow customized class name, fall back to flag name
 264                                 $flagInfos[$key]['class'] = $value['class'] ?? $key;
 265                         }
 266                 }
 267
 268                 $context = $context ?: RequestContext::getMain();
 269
 270                 // Inconsistent naming, kepted for b/c
 271                 if ( isset( $map[$flag] ) ) {
 272                         $flag = $map[$flag];
 273                 }
 274
 275                 $info = $flagInfos[$flag];
 276                 return Html::element( 'abbr', [
 277                         'class' => $info['class'],
 278                         'title' => wfMessage( $info['title'] )->setContext( $context )->text(),
 279                 ], wfMessage( $info['letter'] )->setContext( $context )->text() );
 280         }
 281
 282         /**
 283          * Returns text for the start of the tabular part of RC
 284          * @return string
 285          */
 286         public function beginRecentChangesList() {
 287                 $this->rc_cache = [];
 288                 $this->rcMoveIndex = 0;
 289                 $this->rcCacheIndex = 0;
 290                 $this->lastdate = '';
 291                 $this->rclistOpen = false;
 292                 $this->getOutput()->addModuleStyles( [
 293                         'mediawiki.interface.helpers.styles',
 294                         'mediawiki.special.changeslist'
 295                 ] );
 296
 297                 return '<div class="mw-changeslist">';
 298         }
 299
 300         /**
 301          * @param ResultWrapper|array $rows
 302          */
 303         public function initChangesListRows( $rows ) {
 304                 Hooks::run( 'ChangesListInitRows', [ $this, $rows ] );
 305         }
 306
 307         /**
 308          * Show formatted char difference
 309          *
 310          * Needs the css module 'mediawiki.special.changeslist' to style output
 311          *
 312          * @param int $old Number of bytes
 313          * @param int $new Number of bytes
 314          * @param IContextSource|null $context
 315          * @return string
 316          */
 317         public static function showCharacterDifference( $old, $new, IContextSource $context = null ) {
 318                 if ( !$context ) {
 319                         $context = RequestContext::getMain();
 320                 }
 321
 322                 $new = (int)$new;
 323                 $old = (int)$old;
 324                 $szdiff = $new - $old;
 325
 326                 $lang = $context->getLanguage();
 327                 $config = $context->getConfig();
 328                 $code = $lang->getCode();
 329                 static $fastCharDiff = [];
 330                 if ( !isset( $fastCharDiff[$code] ) ) {
 331                         $fastCharDiff[$code] = $config->get( 'MiserMode' )
 332                                 || $context->msg( 'rc-change-size' )->plain() === '$1';
 333                 }
 334
 335                 $formattedSize = $lang->formatNum( $szdiff );
 336
 337                 if ( !$fastCharDiff[$code] ) {
 338                         $formattedSize = $context->msg( 'rc-change-size', $formattedSize )->text();
 339                 }
 340
 341                 if ( abs( $szdiff ) > abs( $config->get( 'RCChangedSizeThreshold' ) ) ) {
 342                         $tag = 'strong';
 343                 } else {
 344                         $tag = 'span';
 345                 }
 346
 347                 if ( $szdiff === 0 ) {
 348                         $formattedSizeClass = 'mw-plusminus-null';
 349                 } elseif ( $szdiff > 0 ) {
 350                         $formattedSize = '+' . $formattedSize;
 351                         $formattedSizeClass = 'mw-plusminus-pos';
 352                 } else {
 353                         $formattedSizeClass = 'mw-plusminus-neg';
 354                 }
 355                 $formattedSizeClass .= ' mw-diff-bytes';
 356
 357                 $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text();
 358
 359                 return Html::element( $tag,
 360                         [ 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ],
 361                         $formattedSize ) . $lang->getDirMark();
 362         }
 363
 364         /**
 365          * Format the character difference of one or several changes.
 366          *
 367          * @param RecentChange $old
 368          * @param RecentChange|null $new Last change to use, if not provided, $old will be used
 369          * @return string HTML fragment
 370          */
 371         public function formatCharacterDifference( RecentChange $old, RecentChange $new = null ) {
 372                 $oldlen = $old->mAttribs['rc_old_len'];
 373
 374                 if ( $new ) {
 375                         $newlen = $new->mAttribs['rc_new_len'];
 376                 } else {
 377                         $newlen = $old->mAttribs['rc_new_len'];
 378                 }
 379
 380                 if ( $oldlen === null || $newlen === null ) {
 381                         return '';
 382                 }
 383
 384                 return self::showCharacterDifference( $oldlen, $newlen, $this->getContext() );
 385         }
 386
 387         /**
 388          * Returns text for the end of RC
 389          * @return string
 390          */
 391         public function endRecentChangesList() {
 392                 $out = $this->rclistOpen ? "</ul>\n" : '';
 393                 $out .= '</div>';
 394
 395                 return $out;
 396         }
 397
 398         /**
 399          * Render the date and time of a revision in the current user language
 400          * based on whether the user is able to view this information or not.
 401          * @param Revision $rev
 402          * @param User $user
 403          * @param Language $lang
 404          * @param Title|null $title (optional) where Title does not match
 405          *   the Title associated with the Revision
 406          * @internal For usage by Pager classes only (e.g. HistoryPager and ContribsPager).
 407          * @return string HTML
 408          */
 409         public static function revDateLink( Revision $rev, User $user, Language $lang, $title = null ) {
 410                 $ts = $rev->getTimestamp();
 411                 $date = $lang->userTimeAndDate( $ts, $user );
 412                 if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
 413                         $link = MediaWikiServices::getInstance()->getLinkRenderer()->makeKnownLink(
 414                                 $title !== null ? $title : $rev->getTitle(),
 415                                 $date,
 416                                 [ 'class' => 'mw-changeslist-date' ],
 417                                 [ 'oldid' => $rev->getId() ]
 418                         );
 419                 } else {
 420                         $link = htmlspecialchars( $date );
 421                 }
 422                 if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
 423                         $link = "<span class=\"history-deleted mw-changeslist-date\">$link</span>";
 424                 }
 425                 return $link;
 426         }
 427
 428         /**
 429          * @param string &$s HTML to update
 430          * @param mixed $rc_timestamp
 431          */
 432         public function insertDateHeader( &$s, $rc_timestamp ) {
 433                 # Make date header if necessary
 434                 $date = $this->getLanguage()->userDate( $rc_timestamp, $this->getUser() );
 435                 if ( $date != $this->lastdate ) {
 436                         if ( $this->lastdate != '' ) {
 437                                 $s .= "</ul>\n";
 438                         }
 439                         $s .= Xml::element( 'h4', null, $date ) . "\n<ul class=\"special\">";
 440                         $this->lastdate = $date;
 441                         $this->rclistOpen = true;
 442                 }
 443         }
 444
 445         /**
 446          * @param string &$s HTML to update
 447          * @param Title $title
 448          * @param string $logtype
 449          */
 450         public function insertLog( &$s, $title, $logtype ) {
 451                 $page = new LogPage( $logtype );
 452                 $logname = $page->getName()->setContext( $this->getContext() )->text();
 453                 $s .= $this->msg( 'parentheses' )->rawParams(
 454                         $this->linkRenderer->makeKnownLink( $title, $logname )
 455                 )->escaped();
 456         }
 457
 458         /**
 459          * @param string &$s HTML to update
 460          * @param RecentChange &$rc
 461          * @param bool|null $unpatrolled Unused variable, since 1.27.
 462          */
 463         public function insertDiffHist( &$s, &$rc, $unpatrolled = null ) {
 464                 # Diff link
 465                 if (
 466                         $rc->mAttribs['rc_type'] == RC_NEW ||
 467                         $rc->mAttribs['rc_type'] == RC_LOG ||
 468                         $rc->mAttribs['rc_type'] == RC_CATEGORIZE
 469                 ) {
 470                         $diffLink = $this->message['diff'];
 471                 } elseif ( !self::userCan( $rc, Revision::DELETED_TEXT, $this->getUser() ) ) {
 472                         $diffLink = $this->message['diff'];
 473                 } else {
 474                         $query = [
 475                                 'curid' => $rc->mAttribs['rc_cur_id'],
 476                                 'diff' => $rc->mAttribs['rc_this_oldid'],
 477                                 'oldid' => $rc->mAttribs['rc_last_oldid']
 478                         ];
 479
 480                         $diffLink = $this->linkRenderer->makeKnownLink(
 481                                 $rc->getTitle(),
 482                                 new HtmlArmor( $this->message['diff'] ),
 483                                 [ 'class' => 'mw-changeslist-diff' ],
 484                                 $query
 485                         );
 486                 }
 487                 if ( $rc->mAttribs['rc_type'] == RC_CATEGORIZE ) {
 488                         $histLink = $this->message['hist'];
 489                 } else {
 490                         $histLink = $this->linkRenderer->makeKnownLink(
 491                                 $rc->getTitle(),
 492                                 new HtmlArmor( $this->message['hist'] ),
 493                                 [ 'class' => 'mw-changeslist-history' ],
 494                                 [
 495                                         'curid' => $rc->mAttribs['rc_cur_id'],
 496                                         'action' => 'history'
 497                                 ]
 498                         );
 499                 }
 500
 501                 $s .= Html::rawElement( 'div', [ 'class' => 'mw-changeslist-links' ],
 502                                 Html::rawElement( 'span', [], $diffLink ) .
 503                                 Html::rawElement( 'span', [], $histLink )
 504                         ) .
 505                         ' <span class="mw-changeslist-separator"></span> ';
 506         }
 507
 508         /**
 509          * @param RecentChange &$rc
 510          * @param bool $unpatrolled
 511          * @param bool $watched
 512          * @return string HTML
 513          * @since 1.26
 514          */
 515         public function getArticleLink( &$rc, $unpatrolled, $watched ) {
 516                 $params = [];
 517                 if ( $rc->getTitle()->isRedirect() ) {
 518                         $params = [ 'redirect' => 'no' ];
 519                 }
 520
 521                 $articlelink = $this->linkRenderer->makeLink(
 522                         $rc->getTitle(),
 523                         null,
 524                         [ 'class' => 'mw-changeslist-title' ],
 525                         $params
 526                 );
 527                 if ( $this->isDeleted( $rc, Revision::DELETED_TEXT ) ) {
 528                         $articlelink = '<span class="history-deleted">' . $articlelink . '</span>';
 529                 }
 530                 # To allow for boldening pages watched by this user
 531                 $articlelink = "<span class=\"mw-title\">{$articlelink}</span>";
 532                 # RTL/LTR marker
 533                 $articlelink .= $this->getLanguage()->getDirMark();
 534
 535                 # TODO: Deprecate the $s argument, it seems happily unused.
 536                 $s = '';
 537                 # Avoid PHP 7.1 warning from passing $this by reference
 538                 $changesList = $this;
 539                 Hooks::run( 'ChangesListInsertArticleLink',
 540                         [ &$changesList, &$articlelink, &$s, &$rc, $unpatrolled, $watched ] );
 541
 542                 return "{$s} {$articlelink}";
 543         }
 544
 545         /**
 546          * Get the timestamp from $rc formatted with current user's settings
 547          * and a separator
 548          *
 549          * @param RecentChange $rc
 550          * @deprecated use revDateLink instead.
 551          * @return string HTML fragment
 552          */
 553         public function getTimestamp( $rc ) {
 554                 // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
 555                 return $this->message['semicolon-separator'] . '<span class="mw-changeslist-date">' .
 556                         htmlspecialchars( $this->getLanguage()->userTime(
 557                                 $rc->mAttribs['rc_timestamp'],
 558                                 $this->getUser()
 559                         ) ) . '</span> <span class="mw-changeslist-separator"></span> ';
 560         }
 561
 562         /**
 563          * Insert time timestamp string from $rc into $s
 564          *
 565          * @param string &$s HTML to update
 566          * @param RecentChange $rc
 567          */
 568         public function insertTimestamp( &$s, $rc ) {
 569                 $s .= $this->getTimestamp( $rc );
 570         }
 571
 572         /**
 573          * Insert links to user page, user talk page and eventually a blocking link
 574          *
 575          * @param string &$s HTML to update
 576          * @param RecentChange &$rc
 577          */
 578         public function insertUserRelatedLinks( &$s, &$rc ) {
 579                 if ( $this->isDeleted( $rc, Revision::DELETED_USER ) ) {
 580                         $s .= ' <span class="history-deleted">' .
 581                                 $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
 582                 } else {
 583                         $s .= $this->getLanguage()->getDirMark() . Linker::userLink( $rc->mAttribs['rc_user'],
 584                                 $rc->mAttribs['rc_user_text'] );
 585                         $s .= Linker::userToolLinks(
 586                                 $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'],
 587                                 false, 0, null,
 588                                 // The text content of tools is not wrapped with parenthesises or "piped".
 589                                 // This will be handled in CSS (T205581).
 590                                 false
 591                         );
 592                 }
 593         }
 594
 595         /**
 596          * Insert a formatted action
 597          *
 598          * @param RecentChange $rc
 599          * @return string
 600          */
 601         public function insertLogEntry( $rc ) {
 602                 $formatter = LogFormatter::newFromRow( $rc->mAttribs );
 603                 $formatter->setContext( $this->getContext() );
 604                 $formatter->setShowUserToolLinks( true );
 605                 $mark = $this->getLanguage()->getDirMark();
 606
 607                 return $formatter->getActionText() . " $mark" . $formatter->getComment();
 608         }
 609
 610         /**
 611          * Insert a formatted comment
 612          * @param RecentChange $rc
 613          * @return string
 614          */
 615         public function insertComment( $rc ) {
 616                 if ( $this->isDeleted( $rc, Revision::DELETED_COMMENT ) ) {
 617                         return ' <span class="history-deleted">' .
 618                                 $this->msg( 'rev-deleted-comment' )->escaped() . '</span>';
 619                 } else {
 620                         return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle() );
 621                 }
 622         }
 623
 624         /**
 625          * Returns the string which indicates the number of watching users
 626          * @param int $count Number of user watching a page
 627          * @return string
 628          */
 629         protected function numberofWatchingusers( $count ) {
 630                 if ( $count <= 0 ) {
 631                         return '';
 632                 }
 633
 634                 return $this->watchMsgCache->getWithSetCallback(
 635                         "watching-users-msg:$count",
 636                         function () use ( $count ) {
 637                                 return $this->msg( 'number_of_watching_users_RCview' )
 638                                         ->numParams( $count )->escaped();
 639                         }
 640                 );
 641         }
 642
 643         /**
 644          * Determine if said field of a revision is hidden
 645          * @param RCCacheEntry|RecentChange $rc
 646          * @param int $field One of DELETED_* bitfield constants
 647          * @return bool
 648          */
 649         public static function isDeleted( $rc, $field ) {
 650                 return ( $rc->mAttribs['rc_deleted'] & $field ) == $field;
 651         }
 652
 653         /**
 654          * Determine if the current user is allowed to view a particular
 655          * field of this revision, if it's marked as deleted.
 656          * @param RCCacheEntry|RecentChange $rc
 657          * @param int $field
 658          * @param User|null $user User object to check, or null to use $wgUser
 659          * @return bool
 660          */
 661         public static function userCan( $rc, $field, User $user = null ) {
 662                 if ( $rc->mAttribs['rc_type'] == RC_LOG ) {
 663                         return LogEventsList::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
 664                 } else {
 665                         return Revision::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
 666                 }
 667         }
 668
 669         /**
 670          * @param string $link
 671          * @param bool $watched
 672          * @return string
 673          */
 674         protected function maybeWatchedLink( $link, $watched = false ) {
 675                 if ( $watched ) {
 676                         return '<strong class="mw-watched">' . $link . '</strong>';
 677                 } else {
 678                         return '<span class="mw-rc-unwatched">' . $link . '</span>';
 679                 }
 680         }
 681
 682         /**
 683          * Insert a rollback link
 684          *
 685          * @param string &$s
 686          * @param RecentChange &$rc
 687          */
 688         public function insertRollback( &$s, &$rc ) {
 689                 if ( $rc->mAttribs['rc_type'] == RC_EDIT
 690                         && $rc->mAttribs['rc_this_oldid']
 691                         && $rc->mAttribs['rc_cur_id']
 692                         && $rc->getAttribute( 'page_latest' ) == $rc->mAttribs['rc_this_oldid']
 693                 ) {
 694                         $title = $rc->getTitle();
 695                         /** Check for rollback permissions, disallow special pages, and only
 696                          * show a link on the top-most revision */
 697                         if ( $title->quickUserCan( 'rollback', $this->getUser() ) ) {
 698                                 $rev = new Revision( [
 699                                         'title' => $title,
 700                                         'id' => $rc->mAttribs['rc_this_oldid'],
 701                                         'user' => $rc->mAttribs['rc_user'],
 702                                         'user_text' => $rc->mAttribs['rc_user_text'],
 703                                         'actor' => $rc->mAttribs['rc_actor'] ?? null,
 704                                         'deleted' => $rc->mAttribs['rc_deleted']
 705                                 ] );
 706                                 $s .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
 707                         }
 708                 }
 709         }
 710
 711         /**
 712          * @param RecentChange $rc
 713          * @return string
 714          * @since 1.26
 715          */
 716         public function getRollback( RecentChange $rc ) {
 717                 $s = '';
 718                 $this->insertRollback( $s, $rc );
 719                 return $s;
 720         }
 721
 722         /**
 723          * @param string &$s
 724          * @param RecentChange &$rc
 725          * @param array &$classes
 726          */
 727         public function insertTags( &$s, &$rc, &$classes ) {
 728                 if ( empty( $rc->mAttribs['ts_tags'] ) ) {
 729                         return;
 730                 }
 731
 732                 list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
 733                         $rc->mAttribs['ts_tags'],
 734                         'changeslist',
 735                         $this->getContext()
 736                 );
 737                 $classes = array_merge( $classes, $newClasses );
 738                 $s .= ' ' . $tagSummary;
 739         }
 740
 741         /**
 742          * @param RecentChange $rc
 743          * @param array &$classes
 744          * @return string
 745          * @since 1.26
 746          */
 747         public function getTags( RecentChange $rc, array &$classes ) {
 748                 $s = '';
 749                 $this->insertTags( $s, $rc, $classes );
 750                 return $s;
 751         }
 752
 753         public function insertExtra( &$s, &$rc, &$classes ) {
 754                 // Empty, used for subclasses to add anything special.
 755         }
 756
 757         protected function showAsUnpatrolled( RecentChange $rc ) {
 758                 return self::isUnpatrolled( $rc, $this->getUser() );
 759         }
 760
 761         /**
 762          * @param object|RecentChange $rc Database row from recentchanges or a RecentChange object
 763          * @param User $user
 764          * @return bool
 765          */
 766         public static function isUnpatrolled( $rc, User $user ) {
 767                 if ( $rc instanceof RecentChange ) {
 768                         $isPatrolled = $rc->mAttribs['rc_patrolled'];
 769                         $rcType = $rc->mAttribs['rc_type'];
 770                         $rcLogType = $rc->mAttribs['rc_log_type'];
 771                 } else {
 772                         $isPatrolled = $rc->rc_patrolled;
 773                         $rcType = $rc->rc_type;
 774                         $rcLogType = $rc->rc_log_type;
 775                 }
 776
 777                 if ( !$isPatrolled ) {
 778                         if ( $user->useRCPatrol() ) {
 779                                 return true;
 780                         }
 781                         if ( $user->useNPPatrol() && $rcType == RC_NEW ) {
 782                                 return true;
 783                         }
 784                         if ( $user->useFilePatrol() && $rcLogType == 'upload' ) {
 785                                 return true;
 786                         }
 787                 }
 788
 789                 return false;
 790         }
 791
 792         /**
 793          * Determines whether a revision is linked to this change; this may not be the case
 794          * when the categorization wasn't done by an edit but a conditional parser function
 795          *
 796          * @since 1.27
 797          *
 798          * @param RecentChange|RCCacheEntry $rcObj
 799          * @return bool
 800          */
 801         protected function isCategorizationWithoutRevision( $rcObj ) {
 802                 return intval( $rcObj->getAttribute( 'rc_type' ) ) === RC_CATEGORIZE
 803                         && intval( $rcObj->getAttribute( 'rc_this_oldid' ) ) === 0;
 804         }
 805
 806         /**
 807          * Get recommended data attributes for a change line.
 808          * @param RecentChange $rc
 809          * @return string[] attribute name => value
 810          */
 811         protected function getDataAttributes( RecentChange $rc ) {
 812                 $attrs = [];
 813
 814                 $type = $rc->getAttribute( 'rc_source' );
 815                 switch ( $type ) {
 816                         case RecentChange::SRC_EDIT:
 817                         case RecentChange::SRC_NEW:
 818                                 $attrs['data-mw-revid'] = $rc->mAttribs['rc_this_oldid'];
 819                                 break;
 820                         case RecentChange::SRC_LOG:
 821                                 $attrs['data-mw-logid'] = $rc->mAttribs['rc_logid'];
 822                                 $attrs['data-mw-logaction'] =
 823                                         $rc->mAttribs['rc_log_type'] . '/' . $rc->mAttribs['rc_log_action'];
 824                                 break;
 825                 }
 826
 827                 $attrs[ 'data-mw-ts' ] = $rc->getAttribute( 'rc_timestamp' );
 828
 829                 return $attrs;
 830         }
 831
 832         /**
 833          * Sets the callable that generates a change line prefix added to the beginning of each line.
 834          *
 835          * @param callable $prefixer Callable to run that generates the change line prefix.
 836          *     Takes three parameters: a RecentChange object, a ChangesList object,
 837          *     and whether the current entry is a grouped entry.
 838          */
 839         public function setChangeLinePrefixer( callable $prefixer ) {
 840                 $this->changeLinePrefixer = $prefixer;
 841         }
 842 }