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;
47 /** @var MapCacheLRU */
48 protected $watchMsgCache;
53 protected $linkRenderer;
58 protected $filterGroups;
61 * @param Skin|IContextSource $obj
62 * @param array $filterGroups Array of ChangesListFilterGroup objects (currently optional)
64 public function __construct( $obj, array $filterGroups = [] ) {
65 if ( $obj instanceof IContextSource
) {
66 $this->setContext( $obj );
67 $this->skin
= $obj->getSkin();
69 $this->setContext( $obj->getContext() );
72 $this->preCacheMessages();
73 $this->watchMsgCache
= new MapCacheLRU( 50 );
74 $this->linkRenderer
= MediaWikiServices
::getInstance()->getLinkRenderer();
75 $this->filterGroups
= $filterGroups;
79 * Fetch an appropriate changes list class for the specified context
80 * Some users might want to use an enhanced list format, for instance
82 * @param IContextSource $context
83 * @param array $groups Array of ChangesListFilterGroup objects (currently optional)
86 public static function newFromContext( IContextSource
$context, array $groups = [] ) {
87 $user = $context->getUser();
88 $sk = $context->getSkin();
90 if ( Hooks
::run( 'FetchChangesList', [ $user, &$sk, &$list ] ) ) {
91 $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) );
94 new EnhancedChangesList( $context, $groups ) :
95 new OldChangesList( $context, $groups );
106 * @param RecentChange &$rc Passed by reference
107 * @param bool $watched (default false)
108 * @param int|null $linenumber (default null)
110 * @return string|bool
112 public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
113 throw new RuntimeException( 'recentChangesLine should be implemented' );
117 * Get the container for highlights that are used in the new StructuredFilters
120 * @return string HTML structure of the highlight container div
122 protected function getHighlightsContainerDiv() {
123 $highlightColorDivs = '';
124 foreach ( [ 'none', 'c1', 'c2', 'c3', 'c4', 'c5' ] as $color ) {
125 $highlightColorDivs .= Html
::rawElement(
128 'class' => 'mw-rcfilters-ui-highlights-color-' . $color,
129 'data-color' => $color
134 return Html
::rawElement(
136 [ 'class' => 'mw-rcfilters-ui-highlights' ],
142 * Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag
145 public function setWatchlistDivs( $value = true ) {
146 $this->watchlist
= $value;
150 * @return bool True when setWatchlistDivs has been called
153 public function isWatchlist() {
154 return (bool)$this->watchlist
;
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
161 private function preCacheMessages() {
162 if ( !isset( $this->message
) ) {
164 'cur', 'diff', 'hist', 'enhancedrc-history', 'last', 'blocklink', 'history',
165 'semicolon-separator', 'pipe-separator' ] as $msg
167 $this->message
[$msg] = $this->msg( $msg )->escaped();
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
178 public function recentChangesFlags( $flags, $nothing = "\u{00A0}" ) {
180 foreach ( array_keys( $this->getConfig()->get( 'RecentChangesFlags' ) ) as $flag ) {
181 $f .= isset( $flags[$flag] ) && $flags[$flag]
182 ? self
::flag( $flag, $this->getContext() )
190 * Get an array of default HTML class attributes for the change.
192 * @param RecentChange|RCCacheEntry $rc
193 * @param string|bool $watched Optionally timestamp for adding watched class
195 * @return string[] List of CSS class names
197 protected function getHTMLClasses( $rc, $watched ) {
198 $classes = [ self
::CSS_CLASS_PREFIX
. 'line' ];
199 $logType = $rc->mAttribs
['rc_log_type'];
202 $classes[] = self
::CSS_CLASS_PREFIX
. 'log';
203 $classes[] = Sanitizer
::escapeClass( self
::CSS_CLASS_PREFIX
. 'log-' . $logType );
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'] );
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';
216 $classes = array_merge( $classes, $this->getHTMLClassesForFilters( $rc ) );
222 * Get an array of CSS classes attributed to filters for this row. Used for highlighting
225 * @param RecentChange $rc
226 * @return array Array of CSS classes
228 protected function getHTMLClassesForFilters( $rc ) {
231 $classes[] = Sanitizer
::escapeClass( self
::CSS_CLASS_PREFIX
. 'ns-' .
232 $rc->mAttribs
['rc_namespace'] );
234 if ( $this->filterGroups
!== null ) {
235 foreach ( $this->filterGroups
as $filterGroup ) {
236 foreach ( $filterGroup->getFilters() as $filter ) {
237 $filter->applyCssClassIfNeeded( $this, $rc, $classes );
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 "!".
249 * @param string $flag One key of $wgRecentChangesFlags
250 * @param IContextSource|null $context
251 * @return string HTML
253 public static function flag( $flag, IContextSource
$context = null ) {
254 static $map = [ 'minoredit' => 'minor', 'botedit' => 'bot' ];
255 static $flagInfos = null;
257 if ( is_null( $flagInfos ) ) {
258 global $wgRecentChangesFlags;
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;
268 $context = $context ?
: RequestContext
::getMain();
270 // Inconsistent naming, kepted for b/c
271 if ( isset( $map[$flag] ) ) {
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() );
283 * Returns text for the start of the tabular part of RC
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'
297 return '<div class="mw-changeslist">';
301 * @param ResultWrapper|array $rows
303 public function initChangesListRows( $rows ) {
304 Hooks
::run( 'ChangesListInitRows', [ $this, $rows ] );
308 * Show formatted char difference
310 * Needs the css module 'mediawiki.special.changeslist' to style output
312 * @param int $old Number of bytes
313 * @param int $new Number of bytes
314 * @param IContextSource|null $context
317 public static function showCharacterDifference( $old, $new, IContextSource
$context = null ) {
319 $context = RequestContext
::getMain();
324 $szdiff = $new - $old;
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';
335 $formattedSize = $lang->formatNum( $szdiff );
337 if ( !$fastCharDiff[$code] ) {
338 $formattedSize = $context->msg( 'rc-change-size', $formattedSize )->text();
341 if ( abs( $szdiff ) > abs( $config->get( 'RCChangedSizeThreshold' ) ) ) {
347 if ( $szdiff === 0 ) {
348 $formattedSizeClass = 'mw-plusminus-null';
349 } elseif ( $szdiff > 0 ) {
350 $formattedSize = '+' . $formattedSize;
351 $formattedSizeClass = 'mw-plusminus-pos';
353 $formattedSizeClass = 'mw-plusminus-neg';
355 $formattedSizeClass .= ' mw-diff-bytes';
357 $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text();
359 return Html
::element( $tag,
360 [ 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ],
361 $formattedSize ) . $lang->getDirMark();
365 * Format the character difference of one or several changes.
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
371 public function formatCharacterDifference( RecentChange
$old, RecentChange
$new = null ) {
372 $oldlen = $old->mAttribs
['rc_old_len'];
375 $newlen = $new->mAttribs
['rc_new_len'];
377 $newlen = $old->mAttribs
['rc_new_len'];
380 if ( $oldlen === null ||
$newlen === null ) {
384 return self
::showCharacterDifference( $oldlen, $newlen, $this->getContext() );
388 * Returns text for the end of RC
391 public function endRecentChangesList() {
392 $out = $this->rclistOpen ?
"</ul>\n" : '';
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
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
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 ??
$rev->getTitle(),
416 [ 'class' => 'mw-changeslist-date' ],
417 [ 'oldid' => $rev->getId() ]
420 $link = htmlspecialchars( $date );
422 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
423 $link = "<span class=\"history-deleted mw-changeslist-date\">$link</span>";
429 * @param string &$s HTML to update
430 * @param mixed $rc_timestamp
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
!= '' ) {
439 $s .= Xml
::element( 'h4', null, $date ) . "\n<ul class=\"special\">";
440 $this->lastdate
= $date;
441 $this->rclistOpen
= true;
446 * @param string &$s HTML to update
447 * @param Title $title
448 * @param string $logtype
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 )
459 * @param string &$s HTML to update
460 * @param RecentChange &$rc
461 * @param bool|null $unpatrolled Unused variable, since 1.27.
463 public function insertDiffHist( &$s, &$rc, $unpatrolled = null ) {
466 $rc->mAttribs
['rc_type'] == RC_NEW ||
467 $rc->mAttribs
['rc_type'] == RC_LOG ||
468 $rc->mAttribs
['rc_type'] == RC_CATEGORIZE
470 $diffLink = $this->message
['diff'];
471 } elseif ( !self
::userCan( $rc, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
472 $diffLink = $this->message
['diff'];
475 'curid' => $rc->mAttribs
['rc_cur_id'],
476 'diff' => $rc->mAttribs
['rc_this_oldid'],
477 'oldid' => $rc->mAttribs
['rc_last_oldid']
480 $diffLink = $this->linkRenderer
->makeKnownLink(
482 new HtmlArmor( $this->message
['diff'] ),
483 [ 'class' => 'mw-changeslist-diff' ],
487 if ( $rc->mAttribs
['rc_type'] == RC_CATEGORIZE
) {
488 $histLink = $this->message
['hist'];
490 $histLink = $this->linkRenderer
->makeKnownLink(
492 new HtmlArmor( $this->message
['hist'] ),
493 [ 'class' => 'mw-changeslist-history' ],
495 'curid' => $rc->mAttribs
['rc_cur_id'],
496 'action' => 'history'
501 $s .= Html
::rawElement( 'div', [ 'class' => 'mw-changeslist-links' ],
502 Html
::rawElement( 'span', [], $diffLink ) .
503 Html
::rawElement( 'span', [], $histLink )
505 ' <span class="mw-changeslist-separator"></span> ';
509 * @param RecentChange &$rc
510 * @param bool $unpatrolled
511 * @param bool $watched
512 * @return string HTML
515 public function getArticleLink( &$rc, $unpatrolled, $watched ) {
517 if ( $rc->getTitle()->isRedirect() ) {
518 $params = [ 'redirect' => 'no' ];
521 $articlelink = $this->linkRenderer
->makeLink(
524 [ 'class' => 'mw-changeslist-title' ],
527 if ( $this->isDeleted( $rc, Revision
::DELETED_TEXT
) ) {
528 $articlelink = '<span class="history-deleted">' . $articlelink . '</span>';
530 # To allow for boldening pages watched by this user
531 $articlelink = "<span class=\"mw-title\">{$articlelink}</span>";
533 $articlelink .= $this->getLanguage()->getDirMark();
535 # TODO: Deprecate the $s argument, it seems happily unused.
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 ] );
542 return "{$s} {$articlelink}";
546 * Get the timestamp from $rc formatted with current user's settings
549 * @param RecentChange $rc
550 * @deprecated use revDateLink instead.
551 * @return string HTML fragment
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'],
559 ) ) . '</span> <span class="mw-changeslist-separator"></span> ';
563 * Insert time timestamp string from $rc into $s
565 * @param string &$s HTML to update
566 * @param RecentChange $rc
568 public function insertTimestamp( &$s, $rc ) {
569 $s .= $this->getTimestamp( $rc );
573 * Insert links to user page, user talk page and eventually a blocking link
575 * @param string &$s HTML to update
576 * @param RecentChange &$rc
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>';
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'],
588 // The text content of tools is not wrapped with parenthesises or "piped".
589 // This will be handled in CSS (T205581).
596 * Insert a formatted action
598 * @param RecentChange $rc
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();
607 return $formatter->getActionText() . " $mark" . $formatter->getComment();
611 * Insert a formatted comment
612 * @param RecentChange $rc
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>';
620 return Linker
::commentBlock( $rc->mAttribs
['rc_comment'], $rc->getTitle(),
621 // Whether section links should refer to local page (using default false)
623 // wikid to generate links for (using default null) */
625 // whether parentheses should be rendered as part of the message
631 * Returns the string which indicates the number of watching users
632 * @param int $count Number of user watching a page
635 protected function numberofWatchingusers( $count ) {
640 return $this->watchMsgCache
->getWithSetCallback(
641 "watching-users-msg:$count",
642 function () use ( $count ) {
643 return $this->msg( 'number-of-watching-users-for-recent-changes' )
644 ->numParams( $count )->escaped();
650 * Determine if said field of a revision is hidden
651 * @param RCCacheEntry|RecentChange $rc
652 * @param int $field One of DELETED_* bitfield constants
655 public static function isDeleted( $rc, $field ) {
656 return ( $rc->mAttribs
['rc_deleted'] & $field ) == $field;
660 * Determine if the current user is allowed to view a particular
661 * field of this revision, if it's marked as deleted.
662 * @param RCCacheEntry|RecentChange $rc
664 * @param User|null $user User object to check, or null to use $wgUser
667 public static function userCan( $rc, $field, User
$user = null ) {
668 if ( $rc->mAttribs
['rc_type'] == RC_LOG
) {
669 return LogEventsList
::userCanBitfield( $rc->mAttribs
['rc_deleted'], $field, $user );
671 return Revision
::userCanBitfield( $rc->mAttribs
['rc_deleted'], $field, $user );
676 * @param string $link
677 * @param bool $watched
680 protected function maybeWatchedLink( $link, $watched = false ) {
682 return '<strong class="mw-watched">' . $link . '</strong>';
684 return '<span class="mw-rc-unwatched">' . $link . '</span>';
689 * Insert a rollback link
692 * @param RecentChange &$rc
694 public function insertRollback( &$s, &$rc ) {
695 if ( $rc->mAttribs
['rc_type'] == RC_EDIT
696 && $rc->mAttribs
['rc_this_oldid']
697 && $rc->mAttribs
['rc_cur_id']
698 && $rc->getAttribute( 'page_latest' ) == $rc->mAttribs
['rc_this_oldid']
700 $title = $rc->getTitle();
701 /** Check for rollback permissions, disallow special pages, and only
702 * show a link on the top-most revision */
703 if ( $title->quickUserCan( 'rollback', $this->getUser() ) ) {
704 $rev = new Revision( [
706 'id' => $rc->mAttribs
['rc_this_oldid'],
707 'user' => $rc->mAttribs
['rc_user'],
708 'user_text' => $rc->mAttribs
['rc_user_text'],
709 'actor' => $rc->mAttribs
['rc_actor'] ??
null,
710 'deleted' => $rc->mAttribs
['rc_deleted']
712 $s .= ' ' . Linker
::generateRollback( $rev, $this->getContext() );
718 * @param RecentChange $rc
722 public function getRollback( RecentChange
$rc ) {
724 $this->insertRollback( $s, $rc );
730 * @param RecentChange &$rc
731 * @param array &$classes
733 public function insertTags( &$s, &$rc, &$classes ) {
734 if ( empty( $rc->mAttribs
['ts_tags'] ) ) {
738 list( $tagSummary, $newClasses ) = ChangeTags
::formatSummaryRow(
739 $rc->mAttribs
['ts_tags'],
743 $classes = array_merge( $classes, $newClasses );
744 $s .= ' ' . $tagSummary;
748 * @param RecentChange $rc
749 * @param array &$classes
753 public function getTags( RecentChange
$rc, array &$classes ) {
755 $this->insertTags( $s, $rc, $classes );
759 public function insertExtra( &$s, &$rc, &$classes ) {
760 // Empty, used for subclasses to add anything special.
763 protected function showAsUnpatrolled( RecentChange
$rc ) {
764 return self
::isUnpatrolled( $rc, $this->getUser() );
768 * @param object|RecentChange $rc Database row from recentchanges or a RecentChange object
772 public static function isUnpatrolled( $rc, User
$user ) {
773 if ( $rc instanceof RecentChange
) {
774 $isPatrolled = $rc->mAttribs
['rc_patrolled'];
775 $rcType = $rc->mAttribs
['rc_type'];
776 $rcLogType = $rc->mAttribs
['rc_log_type'];
778 $isPatrolled = $rc->rc_patrolled
;
779 $rcType = $rc->rc_type
;
780 $rcLogType = $rc->rc_log_type
;
783 if ( !$isPatrolled ) {
784 if ( $user->useRCPatrol() ) {
787 if ( $user->useNPPatrol() && $rcType == RC_NEW
) {
790 if ( $user->useFilePatrol() && $rcLogType == 'upload' ) {
799 * Determines whether a revision is linked to this change; this may not be the case
800 * when the categorization wasn't done by an edit but a conditional parser function
804 * @param RecentChange|RCCacheEntry $rcObj
807 protected function isCategorizationWithoutRevision( $rcObj ) {
808 return intval( $rcObj->getAttribute( 'rc_type' ) ) === RC_CATEGORIZE
809 && intval( $rcObj->getAttribute( 'rc_this_oldid' ) ) === 0;
813 * Get recommended data attributes for a change line.
814 * @param RecentChange $rc
815 * @return string[] attribute name => value
817 protected function getDataAttributes( RecentChange
$rc ) {
820 $type = $rc->getAttribute( 'rc_source' );
822 case RecentChange
::SRC_EDIT
:
823 case RecentChange
::SRC_NEW
:
824 $attrs['data-mw-revid'] = $rc->mAttribs
['rc_this_oldid'];
826 case RecentChange
::SRC_LOG
:
827 $attrs['data-mw-logid'] = $rc->mAttribs
['rc_logid'];
828 $attrs['data-mw-logaction'] =
829 $rc->mAttribs
['rc_log_type'] . '/' . $rc->mAttribs
['rc_log_action'];
833 $attrs[ 'data-mw-ts' ] = $rc->getAttribute( 'rc_timestamp' );
839 * Sets the callable that generates a change line prefix added to the beginning of each line.
841 * @param callable $prefixer Callable to run that generates the change line prefix.
842 * Takes three parameters: a RecentChange object, a ChangesList object,
843 * and whether the current entry is a grouped entry.
845 public function setChangeLinePrefixer( callable
$prefixer ) {
846 $this->changeLinePrefixer
= $prefixer;