3 * Base class for all changes lists.
5 * The class is used for formatting recent changes, related changes and watchlist.
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.
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.
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
24 use MediaWiki\Linker\LinkRenderer
;
25 use MediaWiki\MediaWikiServices
;
26 use Wikimedia\Rdbms\ResultWrapper
;
28 class ChangesList
extends ContextSource
{
29 const CSS_CLASS_PREFIX
= 'mw-changeslist-';
36 protected $watchlist = false;
40 protected $rcCacheIndex;
41 protected $rclistOpen;
42 protected $rcMoveIndex;
45 protected $changeLinePrefixer;
48 protected $watchMsgCache;
53 protected $linkRenderer;
58 protected $filterGroups;
61 * Changeslist constructor
63 * @param Skin|IContextSource $obj
64 * @param array $filterGroups Array of ChangesListFilterGroup objects (currently optional)
66 public function __construct( $obj, array $filterGroups = [] ) {
67 if ( $obj instanceof IContextSource
) {
68 $this->setContext( $obj );
69 $this->skin
= $obj->getSkin();
71 $this->setContext( $obj->getContext() );
74 $this->preCacheMessages();
75 $this->watchMsgCache
= new HashBagOStuff( [ 'maxKeys' => 50 ] );
76 $this->linkRenderer
= MediaWikiServices
::getInstance()->getLinkRenderer();
77 $this->filterGroups
= $filterGroups;
81 * Fetch an appropriate changes list class for the specified context
82 * Some users might want to use an enhanced list format, for instance
84 * @param IContextSource $context
85 * @param array $groups Array of ChangesListFilterGroup objects (currently optional)
88 public static function newFromContext( IContextSource
$context, array $groups = [] ) {
89 $user = $context->getUser();
90 $sk = $context->getSkin();
92 if ( Hooks
::run( 'FetchChangesList', [ $user, &$sk, &$list ] ) ) {
93 $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) );
96 new EnhancedChangesList( $context, $groups ) :
97 new OldChangesList( $context, $groups );
108 * @param RecentChange &$rc Passed by reference
109 * @param bool $watched (default false)
110 * @param int $linenumber (default null)
112 * @return string|bool
114 public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
115 throw new RuntimeException( 'recentChangesLine should be implemented' );
119 * Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag
122 public function setWatchlistDivs( $value = true ) {
123 $this->watchlist
= $value;
127 * @return bool True when setWatchlistDivs has been called
130 public function isWatchlist() {
131 return (bool)$this->watchlist
;
135 * As we use the same small set of messages in various methods and that
136 * they are called often, we call them once and save them in $this->message
138 private function preCacheMessages() {
139 if ( !isset( $this->message
) ) {
141 'cur', 'diff', 'hist', 'enhancedrc-history', 'last', 'blocklink', 'history',
142 'semicolon-separator', 'pipe-separator' ] as $msg
144 $this->message
[$msg] = $this->msg( $msg )->escaped();
150 * Returns the appropriate flags for new page, minor change and patrolling
151 * @param array $flags Associative array of 'flag' => Bool
152 * @param string $nothing To use for empty space
155 public function recentChangesFlags( $flags, $nothing = ' ' ) {
157 foreach ( array_keys( $this->getConfig()->get( 'RecentChangesFlags' ) ) as $flag ) {
158 $f .= isset( $flags[$flag] ) && $flags[$flag]
159 ? self
::flag( $flag, $this->getContext() )
167 * Get an array of default HTML class attributes for the change.
169 * @param RecentChange|RCCacheEntry $rc
170 * @param string|bool $watched Optionally timestamp for adding watched class
172 * @return array of classes
174 protected function getHTMLClasses( $rc, $watched ) {
175 $classes = [ self
::CSS_CLASS_PREFIX
. 'line' ];
176 $logType = $rc->mAttribs
['rc_log_type'];
179 $classes[] = self
::CSS_CLASS_PREFIX
. 'log';
180 $classes[] = Sanitizer
::escapeClass( self
::CSS_CLASS_PREFIX
. 'log-' . $logType );
182 $classes[] = self
::CSS_CLASS_PREFIX
. 'edit';
183 $classes[] = Sanitizer
::escapeClass( self
::CSS_CLASS_PREFIX
. 'ns' .
184 $rc->mAttribs
['rc_namespace'] . '-' . $rc->mAttribs
['rc_title'] );
186 $classes[] = Sanitizer
::escapeClass( self
::CSS_CLASS_PREFIX
. 'ns-' .
187 $rc->mAttribs
['rc_namespace'] );
189 // Indicate watched status on the line to allow for more
190 // comprehensive styling.
191 $classes[] = $watched && $rc->mAttribs
['rc_timestamp'] >= $watched
192 ? self
::CSS_CLASS_PREFIX
. 'line-watched'
193 : self
::CSS_CLASS_PREFIX
. 'line-not-watched';
195 $classes = array_merge( $classes, $this->getHTMLClassesForFilters( $rc ) );
201 * Get an array of CSS classes attributed to filters for this row
203 * @param RecentChange $rc
204 * @return array Array of CSS classes
206 protected function getHTMLClassesForFilters( $rc ) {
209 if ( $this->filterGroups
!== null ) {
210 foreach ( $this->filterGroups
as $filterGroup ) {
211 foreach ( $filterGroup->getFilters() as $filter ) {
212 $filter->applyCssClassIfNeeded( $this, $rc, $classes );
221 * Make an "<abbr>" element for a given change flag. The flag indicating a new page, minor edit,
222 * bot edit, or unpatrolled edit. In English it typically contains "N", "m", "b", or "!".
224 * @param string $flag One key of $wgRecentChangesFlags
225 * @param IContextSource $context
226 * @return string HTML
228 public static function flag( $flag, IContextSource
$context = null ) {
229 static $map = [ 'minoredit' => 'minor', 'botedit' => 'bot' ];
230 static $flagInfos = null;
232 if ( is_null( $flagInfos ) ) {
233 global $wgRecentChangesFlags;
235 foreach ( $wgRecentChangesFlags as $key => $value ) {
236 $flagInfos[$key]['letter'] = $value['letter'];
237 $flagInfos[$key]['title'] = $value['title'];
238 // Allow customized class name, fall back to flag name
239 $flagInfos[$key]['class'] = isset( $value['class'] ) ?
$value['class'] : $key;
243 $context = $context ?
: RequestContext
::getMain();
245 // Inconsistent naming, kepted for b/c
246 if ( isset( $map[$flag] ) ) {
250 $info = $flagInfos[$flag];
251 return Html
::element( 'abbr', [
252 'class' => $info['class'],
253 'title' => wfMessage( $info['title'] )->setContext( $context )->text(),
254 ], wfMessage( $info['letter'] )->setContext( $context )->text() );
258 * Returns text for the start of the tabular part of RC
261 public function beginRecentChangesList() {
262 $this->rc_cache
= [];
263 $this->rcMoveIndex
= 0;
264 $this->rcCacheIndex
= 0;
265 $this->lastdate
= '';
266 $this->rclistOpen
= false;
267 $this->getOutput()->addModuleStyles( 'mediawiki.special.changeslist' );
269 return '<div class="mw-changeslist">';
273 * @param ResultWrapper|array $rows
275 public function initChangesListRows( $rows ) {
276 Hooks
::run( 'ChangesListInitRows', [ $this, $rows ] );
280 * Show formatted char difference
282 * Needs the css module 'mediawiki.special.changeslist' to style output
284 * @param int $old Number of bytes
285 * @param int $new Number of bytes
286 * @param IContextSource $context
289 public static function showCharacterDifference( $old, $new, IContextSource
$context = null ) {
291 $context = RequestContext
::getMain();
296 $szdiff = $new - $old;
298 $lang = $context->getLanguage();
299 $config = $context->getConfig();
300 $code = $lang->getCode();
301 static $fastCharDiff = [];
302 if ( !isset( $fastCharDiff[$code] ) ) {
303 $fastCharDiff[$code] = $config->get( 'MiserMode' )
304 ||
$context->msg( 'rc-change-size' )->plain() === '$1';
307 $formattedSize = $lang->formatNum( $szdiff );
309 if ( !$fastCharDiff[$code] ) {
310 $formattedSize = $context->msg( 'rc-change-size', $formattedSize )->text();
313 if ( abs( $szdiff ) > abs( $config->get( 'RCChangedSizeThreshold' ) ) ) {
319 if ( $szdiff === 0 ) {
320 $formattedSizeClass = 'mw-plusminus-null';
321 } elseif ( $szdiff > 0 ) {
322 $formattedSize = '+' . $formattedSize;
323 $formattedSizeClass = 'mw-plusminus-pos';
325 $formattedSizeClass = 'mw-plusminus-neg';
328 $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text();
330 return Html
::element( $tag,
331 [ 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ],
332 $context->msg( 'parentheses', $formattedSize )->plain() ) . $lang->getDirMark();
336 * Format the character difference of one or several changes.
338 * @param RecentChange $old
339 * @param RecentChange $new Last change to use, if not provided, $old will be used
340 * @return string HTML fragment
342 public function formatCharacterDifference( RecentChange
$old, RecentChange
$new = null ) {
343 $oldlen = $old->mAttribs
['rc_old_len'];
346 $newlen = $new->mAttribs
['rc_new_len'];
348 $newlen = $old->mAttribs
['rc_new_len'];
351 if ( $oldlen === null ||
$newlen === null ) {
355 return self
::showCharacterDifference( $oldlen, $newlen, $this->getContext() );
359 * Returns text for the end of RC
362 public function endRecentChangesList() {
363 $out = $this->rclistOpen ?
"</ul>\n" : '';
370 * @param string &$s HTML to update
371 * @param mixed $rc_timestamp
373 public function insertDateHeader( &$s, $rc_timestamp ) {
374 # Make date header if necessary
375 $date = $this->getLanguage()->userDate( $rc_timestamp, $this->getUser() );
376 if ( $date != $this->lastdate
) {
377 if ( $this->lastdate
!= '' ) {
380 $s .= Xml
::element( 'h4', null, $date ) . "\n<ul class=\"special\">";
381 $this->lastdate
= $date;
382 $this->rclistOpen
= true;
387 * @param string &$s HTML to update
388 * @param Title $title
389 * @param string $logtype
391 public function insertLog( &$s, $title, $logtype ) {
392 $page = new LogPage( $logtype );
393 $logname = $page->getName()->setContext( $this->getContext() )->text();
394 $s .= $this->msg( 'parentheses' )->rawParams(
395 $this->linkRenderer
->makeKnownLink( $title, $logname )
400 * @param string &$s HTML to update
401 * @param RecentChange &$rc
402 * @param bool|null $unpatrolled Unused variable, since 1.27.
404 public function insertDiffHist( &$s, &$rc, $unpatrolled = null ) {
407 $rc->mAttribs
['rc_type'] == RC_NEW ||
408 $rc->mAttribs
['rc_type'] == RC_LOG ||
409 $rc->mAttribs
['rc_type'] == RC_CATEGORIZE
411 $diffLink = $this->message
['diff'];
412 } elseif ( !self
::userCan( $rc, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
413 $diffLink = $this->message
['diff'];
416 'curid' => $rc->mAttribs
['rc_cur_id'],
417 'diff' => $rc->mAttribs
['rc_this_oldid'],
418 'oldid' => $rc->mAttribs
['rc_last_oldid']
421 $diffLink = $this->linkRenderer
->makeKnownLink(
423 new HtmlArmor( $this->message
['diff'] ),
424 [ 'class' => 'mw-changeslist-diff' ],
428 if ( $rc->mAttribs
['rc_type'] == RC_CATEGORIZE
) {
429 $diffhist = $diffLink . $this->message
['pipe-separator'] . $this->message
['hist'];
431 $diffhist = $diffLink . $this->message
['pipe-separator'];
433 $diffhist .= $this->linkRenderer
->makeKnownLink(
435 new HtmlArmor( $this->message
['hist'] ),
436 [ 'class' => 'mw-changeslist-history' ],
438 'curid' => $rc->mAttribs
['rc_cur_id'],
439 'action' => 'history'
444 // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
445 $s .= $this->msg( 'parentheses' )->rawParams( $diffhist )->escaped() .
446 ' <span class="mw-changeslist-separator">. .</span> ';
450 * @param string &$s Article link will be appended to this string, in place.
451 * @param RecentChange $rc
452 * @param bool $unpatrolled
453 * @param bool $watched
454 * @deprecated since 1.27, use getArticleLink instead.
456 public function insertArticleLink( &$s, RecentChange
$rc, $unpatrolled, $watched ) {
457 $s .= $this->getArticleLink( $rc, $unpatrolled, $watched );
461 * @param RecentChange &$rc
462 * @param bool $unpatrolled
463 * @param bool $watched
464 * @return string HTML
467 public function getArticleLink( &$rc, $unpatrolled, $watched ) {
469 if ( $rc->getTitle()->isRedirect() ) {
470 $params = [ 'redirect' => 'no' ];
473 $articlelink = $this->linkRenderer
->makeLink(
476 [ 'class' => 'mw-changeslist-title' ],
479 if ( $this->isDeleted( $rc, Revision
::DELETED_TEXT
) ) {
480 $articlelink = '<span class="history-deleted">' . $articlelink . '</span>';
482 # To allow for boldening pages watched by this user
483 $articlelink = "<span class=\"mw-title\">{$articlelink}</span>";
485 $articlelink .= $this->getLanguage()->getDirMark();
487 # TODO: Deprecate the $s argument, it seems happily unused.
489 # Avoid PHP 7.1 warning from passing $this by reference
490 $changesList = $this;
491 Hooks
::run( 'ChangesListInsertArticleLink',
492 [ &$changesList, &$articlelink, &$s, &$rc, $unpatrolled, $watched ] );
494 return "{$s} {$articlelink}";
498 * Get the timestamp from $rc formatted with current user's settings
501 * @param RecentChange $rc
502 * @return string HTML fragment
504 public function getTimestamp( $rc ) {
505 // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
506 return $this->message
['semicolon-separator'] . '<span class="mw-changeslist-date">' .
507 $this->getLanguage()->userTime(
508 $rc->mAttribs
['rc_timestamp'],
510 ) . '</span> <span class="mw-changeslist-separator">. .</span> ';
514 * Insert time timestamp string from $rc into $s
516 * @param string &$s HTML to update
517 * @param RecentChange $rc
519 public function insertTimestamp( &$s, $rc ) {
520 $s .= $this->getTimestamp( $rc );
524 * Insert links to user page, user talk page and eventually a blocking link
526 * @param string &$s HTML to update
527 * @param RecentChange &$rc
529 public function insertUserRelatedLinks( &$s, &$rc ) {
530 if ( $this->isDeleted( $rc, Revision
::DELETED_USER
) ) {
531 $s .= ' <span class="history-deleted">' .
532 $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
534 $s .= $this->getLanguage()->getDirMark() . Linker
::userLink( $rc->mAttribs
['rc_user'],
535 $rc->mAttribs
['rc_user_text'] );
536 $s .= Linker
::userToolLinks( $rc->mAttribs
['rc_user'], $rc->mAttribs
['rc_user_text'] );
541 * Insert a formatted action
543 * @param RecentChange $rc
546 public function insertLogEntry( $rc ) {
547 $formatter = LogFormatter
::newFromRow( $rc->mAttribs
);
548 $formatter->setContext( $this->getContext() );
549 $formatter->setShowUserToolLinks( true );
550 $mark = $this->getLanguage()->getDirMark();
552 return $formatter->getActionText() . " $mark" . $formatter->getComment();
556 * Insert a formatted comment
557 * @param RecentChange $rc
560 public function insertComment( $rc ) {
561 if ( $this->isDeleted( $rc, Revision
::DELETED_COMMENT
) ) {
562 return ' <span class="history-deleted">' .
563 $this->msg( 'rev-deleted-comment' )->escaped() . '</span>';
565 return Linker
::commentBlock( $rc->mAttribs
['rc_comment'], $rc->getTitle() );
570 * Returns the string which indicates the number of watching users
571 * @param int $count Number of user watching a page
574 protected function numberofWatchingusers( $count ) {
578 $cache = $this->watchMsgCache
;
579 return $cache->getWithSetCallback( $count, $cache::TTL_INDEFINITE
,
580 function () use ( $count ) {
581 return $this->msg( 'number_of_watching_users_RCview' )
582 ->numParams( $count )->escaped();
588 * Determine if said field of a revision is hidden
589 * @param RCCacheEntry|RecentChange $rc
590 * @param int $field One of DELETED_* bitfield constants
593 public static function isDeleted( $rc, $field ) {
594 return ( $rc->mAttribs
['rc_deleted'] & $field ) == $field;
598 * Determine if the current user is allowed to view a particular
599 * field of this revision, if it's marked as deleted.
600 * @param RCCacheEntry|RecentChange $rc
602 * @param User $user User object to check, or null to use $wgUser
605 public static function userCan( $rc, $field, User
$user = null ) {
606 if ( $rc->mAttribs
['rc_type'] == RC_LOG
) {
607 return LogEventsList
::userCanBitfield( $rc->mAttribs
['rc_deleted'], $field, $user );
609 return Revision
::userCanBitfield( $rc->mAttribs
['rc_deleted'], $field, $user );
614 * @param string $link
615 * @param bool $watched
618 protected function maybeWatchedLink( $link, $watched = false ) {
620 return '<strong class="mw-watched">' . $link . '</strong>';
622 return '<span class="mw-rc-unwatched">' . $link . '</span>';
626 /** Inserts a rollback link
629 * @param RecentChange &$rc
631 public function insertRollback( &$s, &$rc ) {
632 if ( $rc->mAttribs
['rc_type'] == RC_EDIT
633 && $rc->mAttribs
['rc_this_oldid']
634 && $rc->mAttribs
['rc_cur_id']
636 $page = $rc->getTitle();
637 /** Check for rollback and edit permissions, disallow special pages, and only
638 * show a link on the top-most revision */
639 if ( $this->getUser()->isAllowed( 'rollback' )
640 && $rc->mAttribs
['page_latest'] == $rc->mAttribs
['rc_this_oldid']
642 $rev = new Revision( [
644 'id' => $rc->mAttribs
['rc_this_oldid'],
645 'user' => $rc->mAttribs
['rc_user'],
646 'user_text' => $rc->mAttribs
['rc_user_text'],
647 'deleted' => $rc->mAttribs
['rc_deleted']
649 $s .= ' ' . Linker
::generateRollback( $rev, $this->getContext() );
655 * @param RecentChange $rc
659 public function getRollback( RecentChange
$rc ) {
661 $this->insertRollback( $s, $rc );
667 * @param RecentChange &$rc
668 * @param array &$classes
670 public function insertTags( &$s, &$rc, &$classes ) {
671 if ( empty( $rc->mAttribs
['ts_tags'] ) ) {
675 list( $tagSummary, $newClasses ) = ChangeTags
::formatSummaryRow(
676 $rc->mAttribs
['ts_tags'],
680 $classes = array_merge( $classes, $newClasses );
681 $s .= ' ' . $tagSummary;
685 * @param RecentChange $rc
686 * @param array &$classes
690 public function getTags( RecentChange
$rc, array &$classes ) {
692 $this->insertTags( $s, $rc, $classes );
696 public function insertExtra( &$s, &$rc, &$classes ) {
697 // Empty, used for subclasses to add anything special.
700 protected function showAsUnpatrolled( RecentChange
$rc ) {
701 return self
::isUnpatrolled( $rc, $this->getUser() );
705 * @param object|RecentChange $rc Database row from recentchanges or a RecentChange object
709 public static function isUnpatrolled( $rc, User
$user ) {
710 if ( $rc instanceof RecentChange
) {
711 $isPatrolled = $rc->mAttribs
['rc_patrolled'];
712 $rcType = $rc->mAttribs
['rc_type'];
713 $rcLogType = $rc->mAttribs
['rc_log_type'];
715 $isPatrolled = $rc->rc_patrolled
;
716 $rcType = $rc->rc_type
;
717 $rcLogType = $rc->rc_log_type
;
720 if ( !$isPatrolled ) {
721 if ( $user->useRCPatrol() ) {
724 if ( $user->useNPPatrol() && $rcType == RC_NEW
) {
727 if ( $user->useFilePatrol() && $rcLogType == 'upload' ) {
736 * Determines whether a revision is linked to this change; this may not be the case
737 * when the categorization wasn't done by an edit but a conditional parser function
741 * @param RecentChange|RCCacheEntry $rcObj
744 protected function isCategorizationWithoutRevision( $rcObj ) {
745 return intval( $rcObj->getAttribute( 'rc_type' ) ) === RC_CATEGORIZE
746 && intval( $rcObj->getAttribute( 'rc_this_oldid' ) ) === 0;
750 * Get recommended data attributes for a change line.
751 * @param RecentChange $rc
752 * @return string[] attribute name => value
754 protected function getDataAttributes( RecentChange
$rc ) {
757 $type = $rc->getAttribute( 'rc_source' );
759 case RecentChange
::SRC_EDIT
:
760 case RecentChange
::SRC_NEW
:
761 $attrs['data-mw-revid'] = $rc->mAttribs
['rc_this_oldid'];
763 case RecentChange
::SRC_LOG
:
764 $attrs['data-mw-logid'] = $rc->mAttribs
['rc_logid'];
765 $attrs['data-mw-logaction'] =
766 $rc->mAttribs
['rc_log_type'] . '/' . $rc->mAttribs
['rc_log_action'];
770 $attrs[ 'data-mw-ts' ] = $rc->getAttribute( 'rc_timestamp' );
776 * Sets the callable that generates a change line prefix added to the beginning of each line.
778 * @param callable $prefixer Callable to run that generates the change line prefix.
779 * Takes three parameters: a RecentChange object, a ChangesList object,
780 * and whether the current entry is a grouped entry.
782 public function setChangeLinePrefixer( callable
$prefixer ) {
783 $this->changeLinePrefixer
= $prefixer;