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
36 * @param IContextSource|Skin $obj
39 public function __construct( $obj ) {
40 if ( $obj instanceof Skin
) {
41 // @todo: deprecate constructing with Skin
42 $context = $obj->getContext();
44 if ( !$obj instanceof IContextSource
) {
45 throw new MWException( 'EnhancedChangesList must be constructed with a '
46 . 'context source or skin.' );
52 parent
::__construct( $context );
54 // message is set by the parent ChangesList class
55 $this->cacheEntryFactory
= new RCCacheEntryFactory(
62 * Add the JavaScript file for enhanced changeslist
65 public function beginRecentChangesList() {
67 $this->rcMoveIndex
= 0;
68 $this->rcCacheIndex
= 0;
70 $this->rclistOpen
= false;
71 $this->getOutput()->addModuleStyles( [
72 'mediawiki.special.changeslist',
73 'mediawiki.special.changeslist.enhanced',
75 $this->getOutput()->addModules( [
76 'jquery.makeCollapsible',
80 return '<div class="mw-changeslist">';
84 * Format a line for enhanced recentchange (aka with javascript and block of lines).
86 * @param RecentChange $rc
87 * @param bool $watched
88 * @param int $linenumber (default null)
92 public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
94 $date = $this->getLanguage()->userDate(
95 $rc->mAttribs
['rc_timestamp'],
101 # If it's a new day, add the headline and flush the cache
102 if ( $date != $this->lastdate
) {
103 # Process current cache
104 $ret = $this->recentChangesBlock();
105 $this->rc_cache
= [];
106 $ret .= Xml
::element( 'h4', null, $date ) . "\n";
107 $this->lastdate
= $date;
110 $cacheEntry = $this->cacheEntryFactory
->newFromRecentChange( $rc, $watched );
111 $this->addCacheEntry( $cacheEntry );
117 * Put accumulated information into the cache, for later display.
118 * Page moves go on their own line.
120 * @param RCCacheEntry $cacheEntry
122 protected function addCacheEntry( RCCacheEntry
$cacheEntry ) {
123 $cacheGroupingKey = $this->makeCacheGroupingKey( $cacheEntry );
125 if ( !isset( $this->rc_cache
[$cacheGroupingKey] ) ) {
126 $this->rc_cache
[$cacheGroupingKey] = [];
129 array_push( $this->rc_cache
[$cacheGroupingKey], $cacheEntry );
133 * @todo use rc_source to group, if set; fallback to rc_type
135 * @param RCCacheEntry $cacheEntry
139 protected function makeCacheGroupingKey( RCCacheEntry
$cacheEntry ) {
140 $title = $cacheEntry->getTitle();
141 $cacheGroupingKey = $title->getPrefixedDBkey();
143 $type = $cacheEntry->mAttribs
['rc_type'];
145 if ( $type == RC_LOG
) {
147 $cacheGroupingKey = SpecialPage
::getTitleFor(
149 $cacheEntry->mAttribs
['rc_log_type']
150 )->getPrefixedDBkey();
153 return $cacheGroupingKey;
158 * @param RCCacheEntry[] $block
160 * @throws DomainException
162 protected function recentChangesBlockGroup( $block ) {
163 $recentChangesFlags = $this->getConfig()->get( 'RecentChangesFlags' );
165 # Add the namespace and title of the block as part of the class
166 $tableClasses = [ 'mw-collapsible', 'mw-collapsed', 'mw-enhanced-rc' ];
167 if ( $block[0]->mAttribs
['rc_log_type'] ) {
169 $tableClasses[] = Sanitizer
::escapeClass( 'mw-changeslist-log-'
170 . $block[0]->mAttribs
['rc_log_type'] );
172 $tableClasses[] = Sanitizer
::escapeClass( 'mw-changeslist-ns'
173 . $block[0]->mAttribs
['rc_namespace'] . '-' . $block[0]->mAttribs
['rc_title'] );
175 if ( $block[0]->watched
176 && $block[0]->mAttribs
['rc_timestamp'] >= $block[0]->watched
178 $tableClasses[] = 'mw-changeslist-line-watched';
180 $tableClasses[] = 'mw-changeslist-line-not-watched';
183 # Collate list of users
187 # Some catalyst variables...
190 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
192 # Default values for RC flags
193 $collectedRcFlags = [];
194 foreach ( $recentChangesFlags as $key => $value ) {
195 $flagGrouping = ( isset( $recentChangesFlags[$key]['grouping'] ) ?
196 $recentChangesFlags[$key]['grouping'] : 'any' );
197 switch ( $flagGrouping ) {
199 $collectedRcFlags[$key] = true;
202 $collectedRcFlags[$key] = false;
205 throw new DomainException( "Unknown grouping type \"{$flagGrouping}\"" );
208 foreach ( $block as $rcObj ) {
209 // If all log actions to this page were hidden, then don't
210 // give the name of the affected page for this block!
211 if ( !$this->isDeleted( $rcObj, LogPage
::DELETED_ACTION
) ) {
214 $u = $rcObj->userlink
;
215 if ( !isset( $userlinks[$u] ) ) {
218 if ( $rcObj->mAttribs
['rc_type'] != RC_LOG
) {
221 # Get the latest entry with a page_id and oldid
222 # since logs may not have these.
223 if ( !$curId && $rcObj->mAttribs
['rc_cur_id'] ) {
224 $curId = $rcObj->mAttribs
['rc_cur_id'];
230 # Sort the list and convert to text
231 krsort( $userlinks );
234 foreach ( $userlinks as $userlink => $count ) {
236 $text .= $this->getLanguage()->getDirMark();
238 // @todo FIXME: Hardcoded '×'. Should be a message.
239 $formattedCount = $this->getLanguage()->formatNum( $count ) . '×';
240 $text .= ' ' . $this->msg( 'parentheses' )->rawParams( $formattedCount )->escaped();
242 array_push( $users, $text );
247 $revDeletedMsg = false;
249 $revDeletedMsg = $this->msg( 'rev-deleted-event' )->escaped();
250 } elseif ( $allLogs ) {
251 $articleLink = $this->maybeWatchedLink( $block[0]->link
, $block[0]->watched
);
253 $articleLink = $this->getArticleLink( $block[0], $block[0]->unpatrolled
, $block[0]->watched
);
256 $queryParams['curid'] = $curId;
260 foreach ( $block as $i => $rcObj ) {
261 $line = $this->getLineData( $block, $rcObj, $queryParams );
263 // completely ignore this RC entry if we don't want to render it
268 foreach ( $line['recentChangesFlagsRaw'] as $key => $value ) {
269 $flagGrouping = ( isset( $recentChangesFlags[$key]['grouping'] ) ?
270 $recentChangesFlags[$key]['grouping'] : 'any' );
271 switch ( $flagGrouping ) {
274 $collectedRcFlags[$key] = false;
279 $collectedRcFlags[$key] = true;
283 throw new DomainException( "Unknown grouping type \"{$flagGrouping}\"" );
289 // Further down are some assumptions that $block is a 0-indexed array
290 // with (count-1) as last key. Let's make sure it is.
291 $block = array_values( $block );
293 if ( empty( $block ) ||
!$lines ) {
294 // if we can't show anything, don't display this block altogether
298 $logText = $this->getLogText( $block, $queryParams, $allLogs,
299 $collectedRcFlags['newpage'], $namehidden
302 # Character difference (does not apply if only log items)
303 $charDifference = false;
304 if ( $RCShowChangedSize && !$allLogs ) {
306 $first = count( $block ) - 1;
307 # Some events (like logs and category changes) have an "empty" size, so we need to skip those...
308 while ( $last < $first && (
309 $block[$last]->mAttribs
['rc_new_len'] === null ||
310 # TODO kill the below check after March 2016 - https://phabricator.wikimedia.org/T126428
311 $block[$last]->mAttribs
['rc_type'] == RC_CATEGORIZE
315 while ( $last < $first && (
316 $block[$first]->mAttribs
['rc_old_len'] === null ||
317 # TODO kill the below check after March 2016 - https://phabricator.wikimedia.org/T126428
318 $block[$first]->mAttribs
['rc_type'] == RC_CATEGORIZE
323 $charDifference = $this->formatCharacterDifference( $block[$first], $block[$last] );
326 $numberofWatchingusers = $this->numberofWatchingusers( $block[0]->numberofWatchingusers
);
327 $usersList = $this->msg( 'brackets' )->rawParams(
328 implode( $this->message
['semicolon-separator'], $users )
332 'articleLink' => $articleLink,
333 'charDifference' => $charDifference,
334 'collectedRcFlags' => $this->recentChangesFlags( $collectedRcFlags ),
335 'languageDirMark' => $this->getLanguage()->getDirMark(),
337 'logText' => $logText,
338 'numberofWatchingusers' => $numberofWatchingusers,
339 'rev-deleted-event' => $revDeletedMsg,
340 'tableClasses' => $tableClasses,
341 'timestamp' => $block[0]->timestamp
,
342 'users' => $usersList,
345 $this->rcCacheIndex++
;
347 $templateParser = new TemplateParser();
348 return $templateParser->processTemplate(
349 'EnhancedChangesListGroup',
355 * @param RCCacheEntry[] $block
356 * @param RCCacheEntry $rcObj
357 * @param array $queryParams
361 * @throws MWException
363 protected function getLineData( array $block, RCCacheEntry
$rcObj, array $queryParams = [] ) {
364 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
366 # Classes to apply -- TODO implement
368 $type = $rcObj->mAttribs
['rc_type'];
373 && $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
375 $lineParams['classes'] = [ 'mw-enhanced-watched' ];
377 $separator = ' <span class="mw-changeslist-separator">. .</span> ';
379 $data['recentChangesFlags'] = [
380 'newpage' => $type == RC_NEW
,
381 'minor' => $rcObj->mAttribs
['rc_minor'],
382 'unpatrolled' => $rcObj->unpatrolled
,
383 'bot' => $rcObj->mAttribs
['rc_bot'],
386 $params = $queryParams;
388 if ( $rcObj->mAttribs
['rc_this_oldid'] != 0 ) {
389 $params['oldid'] = $rcObj->mAttribs
['rc_this_oldid'];
393 if ( $type == RC_LOG
) {
394 $link = $rcObj->timestamp
;
396 } elseif ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
397 $link = '<span class="history-deleted">' . $rcObj->timestamp
. '</span> ';
399 $link = Linker
::linkKnown(
405 if ( $this->isDeleted( $rcObj, Revision
::DELETED_TEXT
) ) {
406 $link = '<span class="history-deleted">' . $link . '</span> ';
409 $data['timestampLink'] = $link;
411 $currentAndLastLinks = '';
412 if ( !$type == RC_LOG ||
$type == RC_NEW
) {
413 $currentAndLastLinks .= ' ' . $this->msg( 'parentheses' )->rawParams(
415 $this->message
['pipe-separator'] .
419 $data['currentAndLastLinks'] = $currentAndLastLinks;
420 $data['separatorAfterCurrentAndLastLinks'] = $separator;
423 if ( $RCShowChangedSize ) {
424 $cd = $this->formatCharacterDifference( $rcObj );
426 $data['characterDiff'] = $cd;
427 $data['separatorAfterCharacterDiff'] = $separator;
431 if ( $rcObj->mAttribs
['rc_type'] == RC_LOG
) {
432 $data['logEntry'] = $this->insertLogEntry( $rcObj );
433 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
434 $data['comment'] = $this->insertComment( $rcObj );
437 $data['userLink'] = $rcObj->userlink
;
438 $data['userTalkLink'] = $rcObj->usertalklink
;
439 $data['comment'] = $this->insertComment( $rcObj );
443 $data['rollback'] = $this->getRollback( $rcObj );
446 $data['tags'] = $this->getTags( $rcObj, $classes );
448 // give the hook a chance to modify the data
449 $success = Hooks
::run( 'EnhancedChangesListModifyLineData',
450 [ $this, &$data, $block, $rcObj ] );
452 // skip entry if hook aborted it
456 $lineParams['recentChangesFlagsRaw'] = [];
457 if ( isset( $data['recentChangesFlags'] ) ) {
458 $lineParams['recentChangesFlags'] = $this->recentChangesFlags( $data['recentChangesFlags'] );
459 # FIXME: This is used by logic, don't return it in the template params.
460 $lineParams['recentChangesFlagsRaw'] = $data['recentChangesFlags'];
461 unset( $data['recentChangesFlags'] );
464 if ( isset( $data['timestampLink'] ) ) {
465 $lineParams['timestampLink'] = $data['timestampLink'];
466 unset( $data['timestampLink'] );
469 // everything else: makes it easier for extensions to add or remove data
470 $lineParams['data'] = array_values( $data );
476 * Generates amount of changes (linking to diff ) & link to history.
478 * @param array $block
479 * @param array $queryParams
480 * @param bool $allLogs
482 * @param bool $namehidden
485 protected function getLogText( $block, $queryParams, $allLogs, $isnew, $namehidden ) {
486 if ( empty( $block ) ) {
491 static $nchanges = [];
492 static $sinceLastVisitMsg = [];
494 $n = count( $block );
495 if ( !isset( $nchanges[$n] ) ) {
496 $nchanges[$n] = $this->msg( 'nchanges' )->numParams( $n )->escaped();
500 $unvisitedOldid = null;
501 /** @var $rcObj RCCacheEntry */
502 foreach ( $block as $rcObj ) {
503 // Same logic as below inside main foreach
504 if ( $rcObj->watched
&& $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
) {
506 $unvisitedOldid = $rcObj->mAttribs
['rc_last_oldid'];
509 if ( !isset( $sinceLastVisitMsg[$sinceLast] ) ) {
510 $sinceLastVisitMsg[$sinceLast] =
511 $this->msg( 'enhancedrc-since-last-visit' )->numParams( $sinceLast )->escaped();
514 $currentRevision = 0;
515 foreach ( $block as $rcObj ) {
516 if ( !$currentRevision ) {
517 $currentRevision = $rcObj->mAttribs
['rc_this_oldid'];
523 /** @var $block0 RecentChange */
525 $last = $block[count( $block ) - 1];
527 if ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ||
529 $rcObj->mAttribs
['rc_type'] == RC_CATEGORIZE
531 $links['total-changes'] = $nchanges[$n];
533 $links['total-changes'] = Linker
::link(
538 'diff' => $currentRevision,
539 'oldid' => $last->mAttribs
['rc_last_oldid'],
541 [ 'known', 'noclasses' ]
543 if ( $sinceLast > 0 && $sinceLast < $n ) {
544 $links['total-changes-since-last'] = Linker
::link(
546 $sinceLastVisitMsg[$sinceLast],
549 'diff' => $currentRevision,
550 'oldid' => $unvisitedOldid,
552 [ 'known', 'noclasses' ]
559 if ( $allLogs ||
$rcObj->mAttribs
['rc_type'] == RC_CATEGORIZE
) {
560 // don't show history link for logs
561 } elseif ( $namehidden ||
!$block0->getTitle()->exists() ) {
562 $links['history'] = $this->message
['enhancedrc-history'];
564 $params = $queryParams;
565 $params['action'] = 'history';
567 $links['history'] = Linker
::linkKnown(
569 $this->message
['enhancedrc-history'],
575 # Allow others to alter, remove or add to these links
576 Hooks
::run( 'EnhancedChangesList::getLogText',
577 [ $this, &$links, $block ] );
583 $logtext = implode( $this->message
['pipe-separator'], $links );
584 $logtext = $this->msg( 'parentheses' )->rawParams( $logtext )->escaped();
585 return ' ' . $logtext;
589 * Enhanced RC ungrouped line.
591 * @param RecentChange|RCCacheEntry $rcObj
592 * @return string A HTML formatted line (generated using $r)
594 protected function recentChangesBlockLine( $rcObj ) {
597 $query['curid'] = $rcObj->mAttribs
['rc_cur_id'];
599 $type = $rcObj->mAttribs
['rc_type'];
600 $logType = $rcObj->mAttribs
['rc_log_type'];
601 $classes = $this->getHTMLClasses( $rcObj, $rcObj->watched
);
602 $classes[] = 'mw-enhanced-rc';
606 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-log-' . $logType );
608 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-ns' .
609 $rcObj->mAttribs
['rc_namespace'] . '-' . $rcObj->mAttribs
['rc_title'] );
613 $data['recentChangesFlags'] = [
614 'newpage' => $type == RC_NEW
,
615 'minor' => $rcObj->mAttribs
['rc_minor'],
616 'unpatrolled' => $rcObj->unpatrolled
,
617 'bot' => $rcObj->mAttribs
['rc_bot'],
619 // timestamp is not really a link here, but is called timestampLink
620 // for consistency with EnhancedChangesListModifyLineData
621 $data['timestampLink'] = $rcObj->timestamp
;
623 # Article or log link
625 $logPage = new LogPage( $logType );
626 $logTitle = SpecialPage
::getTitleFor( 'Log', $logType );
627 $logName = $logPage->getName()->escaped();
628 $data['logLink'] = $this->msg( 'parentheses' )
629 ->rawParams( Linker
::linkKnown( $logTitle, $logName ) )->escaped();
631 $data['articleLink'] = $this->getArticleLink( $rcObj, $rcObj->unpatrolled
, $rcObj->watched
);
634 # Diff and hist links
635 if ( $type != RC_LOG
&& $type != RC_CATEGORIZE
) {
636 $query['action'] = 'history';
637 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
639 $data['separatorAfterLinks'] = ' <span class="mw-changeslist-separator">. .</span> ';
642 if ( $this->getConfig()->get( 'RCShowChangedSize' ) ) {
643 $cd = $this->formatCharacterDifference( $rcObj );
645 $data['characterDiff'] = $cd;
646 $data['separatorAftercharacterDiff'] = ' <span class="mw-changeslist-separator">. .</span> ';
650 if ( $type == RC_LOG
) {
651 $data['logEntry'] = $this->insertLogEntry( $rcObj );
652 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
653 $data['comment'] = $this->insertComment( $rcObj );
655 $data['userLink'] = $rcObj->userlink
;
656 $data['userTalkLink'] = $rcObj->usertalklink
;
657 $data['comment'] = $this->insertComment( $rcObj );
658 if ( $type == RC_CATEGORIZE
) {
659 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
661 $data['rollback'] = $this->getRollback( $rcObj );
665 $data['tags'] = $this->getTags( $rcObj, $classes );
667 # Show how many people are watching this if enabled
668 $data['watchingUsers'] = $this->numberofWatchingusers( $rcObj->numberofWatchingusers
);
670 // give the hook a chance to modify the data
671 $success = Hooks
::run( 'EnhancedChangesListModifyBlockLineData',
672 [ $this, &$data, $rcObj ] );
674 // skip entry if hook aborted it
678 $line = Html
::openElement( 'table', [ 'class' => $classes ] ) .
679 Html
::openElement( 'tr' );
680 $line .= '<td class="mw-enhanced-rc"><span class="mw-enhancedchanges-arrow-space"></span>';
682 if ( isset( $data['recentChangesFlags'] ) ) {
683 $line .= $this->recentChangesFlags( $data['recentChangesFlags'] );
684 unset( $data['recentChangesFlags'] );
687 if ( isset( $data['timestampLink'] ) ) {
688 $line .= ' ' . $data['timestampLink'];
689 unset( $data['timestampLink'] );
691 $line .= ' </td><td>';
693 // everything else: makes it easier for extensions to add or remove data
694 $line .= implode( '', $data );
696 $line .= "</td></tr></table>\n";
702 * Returns value to be used in 'historyLink' element of $data param in
703 * EnhancedChangesListModifyBlockLineData hook.
707 * @param RCCacheEntry $rc
708 * @param array $query array of key/value pairs to append as a query string
709 * @return string HTML
711 public function getDiffHistLinks( RCCacheEntry
$rc, array $query ) {
712 $pageTitle = $rc->getTitle();
713 if ( $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE
) {
714 // For categorizations we must swap the category title with the page title!
715 $pageTitle = Title
::newFromID( $rc->getAttribute( 'rc_cur_id' ) );
718 $retVal = ' ' . $this->msg( 'parentheses' )
719 ->rawParams( $rc->difflink
. $this->message
['pipe-separator'] . Linker
::linkKnown(
721 $this->message
['hist'],
729 * If enhanced RC is in use, this function takes the previously cached
730 * RC lines, arranges them, and outputs the HTML
734 protected function recentChangesBlock() {
735 if ( count( $this->rc_cache
) == 0 ) {
740 foreach ( $this->rc_cache
as $block ) {
741 if ( count( $block ) < 2 ) {
742 $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) );
744 $blockOut .= $this->recentChangesBlockGroup( $block );
748 return '<div>' . $blockOut . '</div>';
752 * Returns text for the end of RC
753 * If enhanced RC is in use, returns pretty much all the text
756 public function endRecentChangesList() {
757 return $this->recentChangesBlock() . '</div>';