3 * Generates a list of changes using an Enhanced system (uses javascript).
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
23 class EnhancedChangesList
extends ChangesList
{
26 * @var RCCacheEntryFactory
28 protected $cacheEntryFactory;
31 * @var array Array of array of RCCacheEntry
38 protected $templateParser;
41 * @param IContextSource|Skin $obj
42 * @param array $filterGroups Array of ChangesListFilterGroup objects (currently optional)
45 public function __construct( $obj, array $filterGroups = [] ) {
46 if ( $obj instanceof Skin
) {
47 // @todo: deprecate constructing with Skin
48 $context = $obj->getContext();
50 if ( !$obj instanceof IContextSource
) {
51 throw new MWException( 'EnhancedChangesList must be constructed with a '
52 . 'context source or skin.' );
58 parent
::__construct( $context, $filterGroups );
60 // message is set by the parent ChangesList class
61 $this->cacheEntryFactory
= new RCCacheEntryFactory(
66 $this->templateParser
= new TemplateParser();
70 * Add the JavaScript file for enhanced changeslist
73 public function beginRecentChangesList() {
75 $this->rcMoveIndex
= 0;
76 $this->rcCacheIndex
= 0;
78 $this->rclistOpen
= false;
79 $this->getOutput()->addModuleStyles( [
80 'mediawiki.special.changeslist',
81 'mediawiki.special.changeslist.enhanced',
83 $this->getOutput()->addModules( [
84 'jquery.makeCollapsible',
88 return '<div class="mw-changeslist">';
92 * Format a line for enhanced recentchange (aka with javascript and block of lines).
94 * @param RecentChange $rc
95 * @param bool $watched
96 * @param int $linenumber (default null)
100 public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
101 $date = $this->getLanguage()->userDate(
102 $rc->mAttribs
['rc_timestamp'],
105 if ( $this->lastdate
=== '' ) {
106 $this->lastdate
= $date;
111 # If it's a new day, flush the cache and update $this->lastdate
112 if ( $date !== $this->lastdate
) {
113 # Process current cache (uses $this->lastdate to generate a heading)
114 $ret = $this->recentChangesBlock();
115 $this->rc_cache
= [];
116 $this->lastdate
= $date;
119 $cacheEntry = $this->cacheEntryFactory
->newFromRecentChange( $rc, $watched );
120 $this->addCacheEntry( $cacheEntry );
126 * Put accumulated information into the cache, for later display.
127 * Page moves go on their own line.
129 * @param RCCacheEntry $cacheEntry
131 protected function addCacheEntry( RCCacheEntry
$cacheEntry ) {
132 $cacheGroupingKey = $this->makeCacheGroupingKey( $cacheEntry );
134 if ( !isset( $this->rc_cache
[$cacheGroupingKey] ) ) {
135 $this->rc_cache
[$cacheGroupingKey] = [];
138 array_push( $this->rc_cache
[$cacheGroupingKey], $cacheEntry );
142 * @todo use rc_source to group, if set; fallback to rc_type
144 * @param RCCacheEntry $cacheEntry
148 protected function makeCacheGroupingKey( RCCacheEntry
$cacheEntry ) {
149 $title = $cacheEntry->getTitle();
150 $cacheGroupingKey = $title->getPrefixedDBkey();
152 $type = $cacheEntry->mAttribs
['rc_type'];
154 if ( $type == RC_LOG
) {
156 $cacheGroupingKey = SpecialPage
::getTitleFor(
158 $cacheEntry->mAttribs
['rc_log_type']
159 )->getPrefixedDBkey();
162 return $cacheGroupingKey;
167 * @param RCCacheEntry[] $block
169 * @throws DomainException
171 protected function recentChangesBlockGroup( $block ) {
172 $recentChangesFlags = $this->getConfig()->get( 'RecentChangesFlags' );
174 # Add the namespace and title of the block as part of the class
175 $tableClasses = [ 'mw-collapsible', 'mw-collapsed', 'mw-enhanced-rc' ];
176 if ( $block[0]->mAttribs
['rc_log_type'] ) {
178 $tableClasses[] = Sanitizer
::escapeClass( 'mw-changeslist-log-'
179 . $block[0]->mAttribs
['rc_log_type'] );
181 $tableClasses[] = Sanitizer
::escapeClass( 'mw-changeslist-ns'
182 . $block[0]->mAttribs
['rc_namespace'] . '-' . $block[0]->mAttribs
['rc_title'] );
184 if ( $block[0]->watched
185 && $block[0]->mAttribs
['rc_timestamp'] >= $block[0]->watched
187 $tableClasses[] = 'mw-changeslist-line-watched';
189 $tableClasses[] = 'mw-changeslist-line-not-watched';
192 # Collate list of users
196 # Some catalyst variables...
199 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
201 # Default values for RC flags
202 $collectedRcFlags = [];
203 foreach ( $recentChangesFlags as $key => $value ) {
204 $flagGrouping = ( isset( $recentChangesFlags[$key]['grouping'] ) ?
205 $recentChangesFlags[$key]['grouping'] : 'any' );
206 switch ( $flagGrouping ) {
208 $collectedRcFlags[$key] = true;
211 $collectedRcFlags[$key] = false;
214 throw new DomainException( "Unknown grouping type \"{$flagGrouping}\"" );
217 foreach ( $block as $rcObj ) {
218 // If all log actions to this page were hidden, then don't
219 // give the name of the affected page for this block!
220 if ( !$this->isDeleted( $rcObj, LogPage
::DELETED_ACTION
) ) {
223 $u = $rcObj->userlink
;
224 if ( !isset( $userlinks[$u] ) ) {
227 if ( $rcObj->mAttribs
['rc_type'] != RC_LOG
) {
230 # Get the latest entry with a page_id and oldid
231 # since logs may not have these.
232 if ( !$curId && $rcObj->mAttribs
['rc_cur_id'] ) {
233 $curId = $rcObj->mAttribs
['rc_cur_id'];
239 # Sort the list and convert to text
240 krsort( $userlinks );
243 foreach ( $userlinks as $userlink => $count ) {
245 $text .= $this->getLanguage()->getDirMark();
247 $formattedCount = $this->msg( 'ntimes' )->numParams( $count )->escaped();
248 $text .= ' ' . $this->msg( 'parentheses' )->rawParams( $formattedCount )->escaped();
250 array_push( $users, $text );
255 $revDeletedMsg = false;
257 $revDeletedMsg = $this->msg( 'rev-deleted-event' )->escaped();
258 } elseif ( $allLogs ) {
259 $articleLink = $this->maybeWatchedLink( $block[0]->link
, $block[0]->watched
);
261 $articleLink = $this->getArticleLink( $block[0], $block[0]->unpatrolled
, $block[0]->watched
);
264 $queryParams['curid'] = $curId;
268 foreach ( $block as $i => $rcObj ) {
269 $line = $this->getLineData( $block, $rcObj, $queryParams );
271 // completely ignore this RC entry if we don't want to render it
277 foreach ( $line['recentChangesFlagsRaw'] as $key => $value ) {
278 $flagGrouping = ( isset( $recentChangesFlags[$key]['grouping'] ) ?
279 $recentChangesFlags[$key]['grouping'] : 'any' );
280 switch ( $flagGrouping ) {
283 $collectedRcFlags[$key] = false;
288 $collectedRcFlags[$key] = true;
292 throw new DomainException( "Unknown grouping type \"{$flagGrouping}\"" );
299 // Further down are some assumptions that $block is a 0-indexed array
300 // with (count-1) as last key. Let's make sure it is.
301 $block = array_values( $block );
303 if ( empty( $block ) ||
!$lines ) {
304 // if we can't show anything, don't display this block altogether
308 $logText = $this->getLogText( $block, $queryParams, $allLogs,
309 $collectedRcFlags['newpage'], $namehidden
312 # Character difference (does not apply if only log items)
313 $charDifference = false;
314 if ( $RCShowChangedSize && !$allLogs ) {
316 $first = count( $block ) - 1;
317 # Some events (like logs and category changes) have an "empty" size, so we need to skip those...
318 while ( $last < $first && $block[$last]->mAttribs
['rc_new_len'] === null ) {
321 while ( $last < $first && $block[$first]->mAttribs
['rc_old_len'] === null ) {
325 $charDifference = $this->formatCharacterDifference( $block[$first], $block[$last] );
328 $numberofWatchingusers = $this->numberofWatchingusers( $block[0]->numberofWatchingusers
);
329 $usersList = $this->msg( 'brackets' )->rawParams(
330 implode( $this->message
['semicolon-separator'], $users )
334 'articleLink' => $articleLink,
335 'charDifference' => $charDifference,
336 'collectedRcFlags' => $this->recentChangesFlags( $collectedRcFlags ),
337 'languageDirMark' => $this->getLanguage()->getDirMark(),
339 'logText' => $logText,
340 'numberofWatchingusers' => $numberofWatchingusers,
341 'rev-deleted-event' => $revDeletedMsg,
342 'tableClasses' => $tableClasses,
343 'timestamp' => $block[0]->timestamp
,
344 'users' => $usersList,
347 $this->rcCacheIndex++
;
349 return $this->templateParser
->processTemplate(
350 'EnhancedChangesListGroup',
356 * @param RCCacheEntry[] $block
357 * @param RCCacheEntry $rcObj
358 * @param array $queryParams
362 * @throws MWException
364 protected function getLineData( array $block, RCCacheEntry
$rcObj, array $queryParams = [] ) {
365 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
367 $type = $rcObj->mAttribs
['rc_type'];
371 $classes = [ 'mw-enhanced-rc' ];
373 && $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
375 $classes[] = 'mw-enhanced-watched';
377 $classes = array_merge( $classes, $this->getHTMLClassesForFilters( $rcObj ) );
379 $separator = ' <span class="mw-changeslist-separator">. .</span> ';
381 $data['recentChangesFlags'] = [
382 'newpage' => $type == RC_NEW
,
383 'minor' => $rcObj->mAttribs
['rc_minor'],
384 'unpatrolled' => $rcObj->unpatrolled
,
385 'bot' => $rcObj->mAttribs
['rc_bot'],
388 $params = $queryParams;
390 if ( $rcObj->mAttribs
['rc_this_oldid'] != 0 ) {
391 $params['oldid'] = $rcObj->mAttribs
['rc_this_oldid'];
395 if ( $type == RC_LOG
) {
396 $link = $rcObj->timestamp
;
398 } elseif ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
399 $link = '<span class="history-deleted">' . $rcObj->timestamp
. '</span> ';
401 $link = $this->linkRenderer
->makeKnownLink(
403 new HtmlArmor( $rcObj->timestamp
),
407 if ( $this->isDeleted( $rcObj, Revision
::DELETED_TEXT
) ) {
408 $link = '<span class="history-deleted">' . $link . '</span> ';
411 $data['timestampLink'] = $link;
413 $currentAndLastLinks = '';
414 if ( !$type == RC_LOG ||
$type == RC_NEW
) {
415 $currentAndLastLinks .= ' ' . $this->msg( 'parentheses' )->rawParams(
417 $this->message
['pipe-separator'] .
421 $data['currentAndLastLinks'] = $currentAndLastLinks;
422 $data['separatorAfterCurrentAndLastLinks'] = $separator;
425 if ( $RCShowChangedSize ) {
426 $cd = $this->formatCharacterDifference( $rcObj );
428 $data['characterDiff'] = $cd;
429 $data['separatorAfterCharacterDiff'] = $separator;
433 if ( $rcObj->mAttribs
['rc_type'] == RC_LOG
) {
434 $data['logEntry'] = $this->insertLogEntry( $rcObj );
435 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
436 $data['comment'] = $this->insertComment( $rcObj );
439 $data['userLink'] = $rcObj->userlink
;
440 $data['userTalkLink'] = $rcObj->usertalklink
;
441 $data['comment'] = $this->insertComment( $rcObj );
445 $data['rollback'] = $this->getRollback( $rcObj );
448 $data['tags'] = $this->getTags( $rcObj, $classes );
450 $attribs = $this->getDataAttributes( $rcObj );
452 // give the hook a chance to modify the data
453 $success = Hooks
::run( 'EnhancedChangesListModifyLineData',
454 [ $this, &$data, $block, $rcObj, &$classes, &$attribs ] );
456 // skip entry if hook aborted it
459 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer
::class, 'isReservedDataAttribute' ] );
461 $lineParams['recentChangesFlagsRaw'] = [];
462 if ( isset( $data['recentChangesFlags'] ) ) {
463 $lineParams['recentChangesFlags'] = $this->recentChangesFlags( $data['recentChangesFlags'] );
464 # FIXME: This is used by logic, don't return it in the template params.
465 $lineParams['recentChangesFlagsRaw'] = $data['recentChangesFlags'];
466 unset( $data['recentChangesFlags'] );
469 if ( isset( $data['timestampLink'] ) ) {
470 $lineParams['timestampLink'] = $data['timestampLink'];
471 unset( $data['timestampLink'] );
474 $lineParams['classes'] = array_values( $classes );
475 $lineParams['attribs'] = Html
::expandAttributes( $attribs );
477 // everything else: makes it easier for extensions to add or remove data
478 $lineParams['data'] = array_values( $data );
484 * Generates amount of changes (linking to diff ) & link to history.
486 * @param array $block
487 * @param array $queryParams
488 * @param bool $allLogs
490 * @param bool $namehidden
493 protected function getLogText( $block, $queryParams, $allLogs, $isnew, $namehidden ) {
494 if ( empty( $block ) ) {
499 static $nchanges = [];
500 static $sinceLastVisitMsg = [];
502 $n = count( $block );
503 if ( !isset( $nchanges[$n] ) ) {
504 $nchanges[$n] = $this->msg( 'nchanges' )->numParams( $n )->escaped();
508 $unvisitedOldid = null;
509 /** @var $rcObj RCCacheEntry */
510 foreach ( $block as $rcObj ) {
511 // Same logic as below inside main foreach
512 if ( $rcObj->watched
&& $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
) {
514 $unvisitedOldid = $rcObj->mAttribs
['rc_last_oldid'];
517 if ( !isset( $sinceLastVisitMsg[$sinceLast] ) ) {
518 $sinceLastVisitMsg[$sinceLast] =
519 $this->msg( 'enhancedrc-since-last-visit' )->numParams( $sinceLast )->escaped();
522 $currentRevision = 0;
523 foreach ( $block as $rcObj ) {
524 if ( !$currentRevision ) {
525 $currentRevision = $rcObj->mAttribs
['rc_this_oldid'];
531 /** @var $block0 RecentChange */
533 $last = $block[count( $block ) - 1];
535 if ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ||
537 $rcObj->mAttribs
['rc_type'] == RC_CATEGORIZE
539 $links['total-changes'] = $nchanges[$n];
541 $links['total-changes'] = $this->linkRenderer
->makeKnownLink(
543 new HtmlArmor( $nchanges[$n] ),
544 [ 'class' => 'mw-changeslist-groupdiff' ],
546 'diff' => $currentRevision,
547 'oldid' => $last->mAttribs
['rc_last_oldid'],
550 if ( $sinceLast > 0 && $sinceLast < $n ) {
551 $links['total-changes-since-last'] = $this->linkRenderer
->makeKnownLink(
553 new HtmlArmor( $sinceLastVisitMsg[$sinceLast] ),
554 [ 'class' => 'mw-changeslist-groupdiff' ],
556 'diff' => $currentRevision,
557 'oldid' => $unvisitedOldid,
565 if ( $allLogs ||
$rcObj->mAttribs
['rc_type'] == RC_CATEGORIZE
) {
566 // don't show history link for logs
567 } elseif ( $namehidden ||
!$block0->getTitle()->exists() ) {
568 $links['history'] = $this->message
['enhancedrc-history'];
570 $params = $queryParams;
571 $params['action'] = 'history';
573 $links['history'] = $this->linkRenderer
->makeKnownLink(
575 new HtmlArmor( $this->message
['enhancedrc-history'] ),
576 [ 'class' => 'mw-changeslist-history' ],
581 # Allow others to alter, remove or add to these links
582 Hooks
::run( 'EnhancedChangesList::getLogText',
583 [ $this, &$links, $block ] );
589 $logtext = implode( $this->message
['pipe-separator'], $links );
590 $logtext = $this->msg( 'parentheses' )->rawParams( $logtext )->escaped();
591 return ' ' . $logtext;
595 * Enhanced RC ungrouped line.
597 * @param RecentChange|RCCacheEntry $rcObj
598 * @return string A HTML formatted line (generated using $r)
600 protected function recentChangesBlockLine( $rcObj ) {
603 $query['curid'] = $rcObj->mAttribs
['rc_cur_id'];
605 $type = $rcObj->mAttribs
['rc_type'];
606 $logType = $rcObj->mAttribs
['rc_log_type'];
607 $classes = $this->getHTMLClasses( $rcObj, $rcObj->watched
);
608 $classes[] = 'mw-enhanced-rc';
612 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-log-' . $logType );
614 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-ns' .
615 $rcObj->mAttribs
['rc_namespace'] . '-' . $rcObj->mAttribs
['rc_title'] );
619 $data['recentChangesFlags'] = [
620 'newpage' => $type == RC_NEW
,
621 'minor' => $rcObj->mAttribs
['rc_minor'],
622 'unpatrolled' => $rcObj->unpatrolled
,
623 'bot' => $rcObj->mAttribs
['rc_bot'],
625 // timestamp is not really a link here, but is called timestampLink
626 // for consistency with EnhancedChangesListModifyLineData
627 $data['timestampLink'] = $rcObj->timestamp
;
629 # Article or log link
631 $logPage = new LogPage( $logType );
632 $logTitle = SpecialPage
::getTitleFor( 'Log', $logType );
633 $logName = $logPage->getName()->text();
634 $data['logLink'] = $this->msg( 'parentheses' )
636 $this->linkRenderer
->makeKnownLink( $logTitle, $logName )
639 $data['articleLink'] = $this->getArticleLink( $rcObj, $rcObj->unpatrolled
, $rcObj->watched
);
642 # Diff and hist links
643 if ( $type != RC_LOG
&& $type != RC_CATEGORIZE
) {
644 $query['action'] = 'history';
645 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
647 $data['separatorAfterLinks'] = ' <span class="mw-changeslist-separator">. .</span> ';
650 if ( $this->getConfig()->get( 'RCShowChangedSize' ) ) {
651 $cd = $this->formatCharacterDifference( $rcObj );
653 $data['characterDiff'] = $cd;
654 $data['separatorAftercharacterDiff'] = ' <span class="mw-changeslist-separator">. .</span> ';
658 if ( $type == RC_LOG
) {
659 $data['logEntry'] = $this->insertLogEntry( $rcObj );
660 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
661 $data['comment'] = $this->insertComment( $rcObj );
663 $data['userLink'] = $rcObj->userlink
;
664 $data['userTalkLink'] = $rcObj->usertalklink
;
665 $data['comment'] = $this->insertComment( $rcObj );
666 if ( $type == RC_CATEGORIZE
) {
667 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
669 $data['rollback'] = $this->getRollback( $rcObj );
673 $data['tags'] = $this->getTags( $rcObj, $classes );
675 # Show how many people are watching this if enabled
676 $data['watchingUsers'] = $this->numberofWatchingusers( $rcObj->numberofWatchingusers
);
678 $data['attribs'] = array_merge( $this->getDataAttributes( $rcObj ), [ 'class' => $classes ] );
680 // give the hook a chance to modify the data
681 $success = Hooks
::run( 'EnhancedChangesListModifyBlockLineData',
682 [ $this, &$data, $rcObj ] );
684 // skip entry if hook aborted it
687 $attribs = $data['attribs'];
688 unset( $data['attribs'] );
689 $attribs = wfArrayFilterByKey( $attribs, function ( $key ) {
690 return $key === 'class' || Sanitizer
::isReservedDataAttribute( $key );
693 $line = Html
::openElement( 'table', $attribs ) . Html
::openElement( 'tr' );
694 $line .= '<td class="mw-enhanced-rc"><span class="mw-enhancedchanges-arrow-space"></span>';
696 if ( isset( $data['recentChangesFlags'] ) ) {
697 $line .= $this->recentChangesFlags( $data['recentChangesFlags'] );
698 unset( $data['recentChangesFlags'] );
701 if ( isset( $data['timestampLink'] ) ) {
702 $line .= ' ' . $data['timestampLink'];
703 unset( $data['timestampLink'] );
705 $line .= ' </td><td>';
707 // everything else: makes it easier for extensions to add or remove data
708 $line .= implode( '', $data );
710 $line .= "</td></tr></table>\n";
716 * Returns value to be used in 'historyLink' element of $data param in
717 * EnhancedChangesListModifyBlockLineData hook.
721 * @param RCCacheEntry $rc
722 * @param array $query array of key/value pairs to append as a query string
723 * @return string HTML
725 public function getDiffHistLinks( RCCacheEntry
$rc, array $query ) {
726 $pageTitle = $rc->getTitle();
727 if ( $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE
) {
728 // For categorizations we must swap the category title with the page title!
729 $pageTitle = Title
::newFromID( $rc->getAttribute( 'rc_cur_id' ) );
731 // The page has been deleted, but the RC entry
732 // deletion job has not run yet. Just skip.
737 $retVal = ' ' . $this->msg( 'parentheses' )
738 ->rawParams( $rc->difflink
. $this->message
['pipe-separator']
739 . $this->linkRenderer
->makeKnownLink(
741 new HtmlArmor( $this->message
['hist'] ),
742 [ 'class' => 'mw-changeslist-history' ],
749 * If enhanced RC is in use, this function takes the previously cached
750 * RC lines, arranges them, and outputs the HTML
754 protected function recentChangesBlock() {
755 if ( count( $this->rc_cache
) == 0 ) {
760 foreach ( $this->rc_cache
as $block ) {
761 if ( count( $block ) < 2 ) {
762 $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) );
764 $blockOut .= $this->recentChangesBlockGroup( $block );
768 if ( $blockOut === '' ) {
771 // $this->lastdate is kept up to date by recentChangesLine()
772 return Xml
::element( 'h4', null, $this->lastdate
) . "\n<div>" . $blockOut . '</div>';
776 * Returns text for the end of RC
777 * If enhanced RC is in use, returns pretty much all the text
780 public function endRecentChangesList() {
781 return $this->recentChangesBlock() . '</div>';