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
161 protected function recentChangesBlockGroup( $block ) {
163 # Add the namespace and title of the block as part of the class
164 $tableClasses = [ 'mw-collapsible', 'mw-collapsed', 'mw-enhanced-rc' ];
165 if ( $block[0]->mAttribs
['rc_log_type'] ) {
167 $tableClasses[] = Sanitizer
::escapeClass( 'mw-changeslist-log-'
168 . $block[0]->mAttribs
['rc_log_type'] );
170 $tableClasses[] = Sanitizer
::escapeClass( 'mw-changeslist-ns'
171 . $block[0]->mAttribs
['rc_namespace'] . '-' . $block[0]->mAttribs
['rc_title'] );
173 if ( $block[0]->watched
174 && $block[0]->mAttribs
['rc_timestamp'] >= $block[0]->watched
176 $tableClasses[] = 'mw-changeslist-line-watched';
178 $tableClasses[] = 'mw-changeslist-line-not-watched';
181 # Collate list of users
185 # Some catalyst variables...
188 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
189 $collectedRcFlags = [
192 // Includes a new page?
194 // All are minor edits?
196 // Contains an unpatrolled edit?
197 'unpatrolled' => false,
199 foreach ( $block as $rcObj ) {
200 if ( $rcObj->mAttribs
['rc_type'] == RC_NEW
) {
201 $collectedRcFlags['newpage'] = true;
203 // If all log actions to this page were hidden, then don't
204 // give the name of the affected page for this block!
205 if ( !$this->isDeleted( $rcObj, LogPage
::DELETED_ACTION
) ) {
208 $u = $rcObj->userlink
;
209 if ( !isset( $userlinks[$u] ) ) {
212 if ( $rcObj->unpatrolled
) {
213 $collectedRcFlags['unpatrolled'] = true;
215 if ( $rcObj->mAttribs
['rc_type'] != RC_LOG
) {
218 # Get the latest entry with a page_id and oldid
219 # since logs may not have these.
220 if ( !$curId && $rcObj->mAttribs
['rc_cur_id'] ) {
221 $curId = $rcObj->mAttribs
['rc_cur_id'];
224 if ( !$rcObj->mAttribs
['rc_bot'] ) {
225 $collectedRcFlags['bot'] = false;
227 if ( !$rcObj->mAttribs
['rc_minor'] ) {
228 $collectedRcFlags['minor'] = false;
234 # Sort the list and convert to text
235 krsort( $userlinks );
238 foreach ( $userlinks as $userlink => $count ) {
240 $text .= $this->getLanguage()->getDirMark();
242 // @todo FIXME: Hardcoded '×'. Should be a message.
243 $formattedCount = $this->getLanguage()->formatNum( $count ) . '×';
244 $text .= ' ' . $this->msg( 'parentheses' )->rawParams( $formattedCount )->escaped();
246 array_push( $users, $text );
251 $revDeletedMsg = false;
253 $revDeletedMsg = $this->msg( 'rev-deleted-event' )->escaped();
254 } elseif ( $allLogs ) {
255 $articleLink = $this->maybeWatchedLink( $block[0]->link
, $block[0]->watched
);
257 $articleLink = $this->getArticleLink( $block[0], $block[0]->unpatrolled
, $block[0]->watched
);
260 $queryParams['curid'] = $curId;
264 foreach ( $block as $i => $rcObj ) {
265 $line = $this->getLineData( $block, $rcObj, $queryParams );
267 // completely ignore this RC entry if we don't want to render it
272 // Further down are some assumptions that $block is a 0-indexed array
273 // with (count-1) as last key. Let's make sure it is.
274 $block = array_values( $block );
276 if ( empty( $block ) ||
!$lines ) {
277 // if we can't show anything, don't display this block altogether
281 $logText = $this->getLogText( $block, $queryParams, $allLogs,
282 $collectedRcFlags['newpage'], $namehidden
285 # Character difference (does not apply if only log items)
286 $charDifference = false;
287 if ( $RCShowChangedSize && !$allLogs ) {
289 $first = count( $block ) - 1;
290 # Some events (like logs and category changes) have an "empty" size, so we need to skip those...
291 while ( $last < $first && (
292 $block[$last]->mAttribs
['rc_new_len'] === null ||
293 # TODO kill the below check after March 2016 - https://phabricator.wikimedia.org/T126428
294 $block[$last]->mAttribs
['rc_type'] == RC_CATEGORIZE
298 while ( $last < $first && (
299 $block[$first]->mAttribs
['rc_old_len'] === null ||
300 # TODO kill the below check after March 2016 - https://phabricator.wikimedia.org/T126428
301 $block[$first]->mAttribs
['rc_type'] == RC_CATEGORIZE
306 $charDifference = $this->formatCharacterDifference( $block[$first], $block[$last] );
309 $numberofWatchingusers = $this->numberofWatchingusers( $block[0]->numberofWatchingusers
);
310 $usersList = $this->msg( 'brackets' )->rawParams(
311 implode( $this->message
['semicolon-separator'], $users )
315 'articleLink' => $articleLink,
316 'charDifference' => $charDifference,
317 'collectedRcFlags' => $this->recentChangesFlags( $collectedRcFlags ),
318 'languageDirMark' => $this->getLanguage()->getDirMark(),
320 'logText' => $logText,
321 'numberofWatchingusers' => $numberofWatchingusers,
322 'rev-deleted-event' => $revDeletedMsg,
323 'tableClasses' => $tableClasses,
324 'timestamp' => $block[0]->timestamp
,
325 'users' => $usersList,
328 $this->rcCacheIndex++
;
330 $templateParser = new TemplateParser();
331 return $templateParser->processTemplate(
332 'EnhancedChangesListGroup',
338 * @param RCCacheEntry[] $block
339 * @param RCCacheEntry $rcObj
340 * @param array $queryParams
344 * @throws MWException
346 protected function getLineData( array $block, RCCacheEntry
$rcObj, array $queryParams = [] ) {
347 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
349 # Classes to apply -- TODO implement
351 $type = $rcObj->mAttribs
['rc_type'];
356 && $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
358 $lineParams['classes'] = [ 'mw-enhanced-watched' ];
360 $separator = ' <span class="mw-changeslist-separator">. .</span> ';
362 $data['recentChangesFlags'] = [
363 'newpage' => $type == RC_NEW
,
364 'minor' => $rcObj->mAttribs
['rc_minor'],
365 'unpatrolled' => $rcObj->unpatrolled
,
366 'bot' => $rcObj->mAttribs
['rc_bot'],
369 $params = $queryParams;
371 if ( $rcObj->mAttribs
['rc_this_oldid'] != 0 ) {
372 $params['oldid'] = $rcObj->mAttribs
['rc_this_oldid'];
376 if ( $type == RC_LOG
) {
377 $link = $rcObj->timestamp
;
379 } elseif ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
380 $link = '<span class="history-deleted">' . $rcObj->timestamp
. '</span> ';
382 $link = Linker
::linkKnown(
388 if ( $this->isDeleted( $rcObj, Revision
::DELETED_TEXT
) ) {
389 $link = '<span class="history-deleted">' . $link . '</span> ';
392 $data['timestampLink'] = $link;
394 $currentAndLastLinks = '';
395 if ( !$type == RC_LOG ||
$type == RC_NEW
) {
396 $currentAndLastLinks .= ' ' . $this->msg( 'parentheses' )->rawParams(
398 $this->message
['pipe-separator'] .
402 $data['currentAndLastLinks'] = $currentAndLastLinks;
403 $data['separatorAfterCurrentAndLastLinks'] = $separator;
406 if ( $RCShowChangedSize ) {
407 $cd = $this->formatCharacterDifference( $rcObj );
409 $data['characterDiff'] = $cd;
410 $data['separatorAfterCharacterDiff'] = $separator;
414 if ( $rcObj->mAttribs
['rc_type'] == RC_LOG
) {
415 $data['logEntry'] = $this->insertLogEntry( $rcObj );
416 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
417 $data['comment'] = $this->insertComment( $rcObj );
420 $data['userLink'] = $rcObj->userlink
;
421 $data['userTalkLink'] = $rcObj->usertalklink
;
422 $data['comment'] = $this->insertComment( $rcObj );
426 $data['rollback'] = $this->getRollback( $rcObj );
429 $data['tags'] = $this->getTags( $rcObj, $classes );
431 // give the hook a chance to modify the data
432 $success = Hooks
::run( 'EnhancedChangesListModifyLineData',
433 [ $this, &$data, $block, $rcObj ] );
435 // skip entry if hook aborted it
439 if ( isset( $data['recentChangesFlags'] ) ) {
440 $lineParams['recentChangesFlags'] = $this->recentChangesFlags( $data['recentChangesFlags'] );
441 unset( $data['recentChangesFlags'] );
444 if ( isset( $data['timestampLink'] ) ) {
445 $lineParams['timestampLink'] = $data['timestampLink'];
446 unset( $data['timestampLink'] );
449 // everything else: makes it easier for extensions to add or remove data
450 $lineParams['data'] = array_values( $data );
456 * Generates amount of changes (linking to diff ) & link to history.
458 * @param array $block
459 * @param array $queryParams
460 * @param bool $allLogs
462 * @param bool $namehidden
465 protected function getLogText( $block, $queryParams, $allLogs, $isnew, $namehidden ) {
466 if ( empty( $block ) ) {
471 static $nchanges = [];
472 static $sinceLastVisitMsg = [];
474 $n = count( $block );
475 if ( !isset( $nchanges[$n] ) ) {
476 $nchanges[$n] = $this->msg( 'nchanges' )->numParams( $n )->escaped();
480 $unvisitedOldid = null;
481 /** @var $rcObj RCCacheEntry */
482 foreach ( $block as $rcObj ) {
483 // Same logic as below inside main foreach
484 if ( $rcObj->watched
&& $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
) {
486 $unvisitedOldid = $rcObj->mAttribs
['rc_last_oldid'];
489 if ( !isset( $sinceLastVisitMsg[$sinceLast] ) ) {
490 $sinceLastVisitMsg[$sinceLast] =
491 $this->msg( 'enhancedrc-since-last-visit' )->numParams( $sinceLast )->escaped();
494 $currentRevision = 0;
495 foreach ( $block as $rcObj ) {
496 if ( !$currentRevision ) {
497 $currentRevision = $rcObj->mAttribs
['rc_this_oldid'];
503 /** @var $block0 RecentChange */
505 $last = $block[count( $block ) - 1];
506 if ( !$allLogs && $rcObj->mAttribs
['rc_type'] != RC_CATEGORIZE
) {
507 if ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
508 $links['total-changes'] = $nchanges[$n];
509 } elseif ( $isnew ) {
510 $links['total-changes'] = $nchanges[$n];
512 $links['total-changes'] = Linker
::link(
517 'diff' => $currentRevision,
518 'oldid' => $last->mAttribs
['rc_last_oldid'],
520 [ 'known', 'noclasses' ]
522 if ( $sinceLast > 0 && $sinceLast < $n ) {
523 $links['total-changes-since-last'] = Linker
::link(
525 $sinceLastVisitMsg[$sinceLast],
528 'diff' => $currentRevision,
529 'oldid' => $unvisitedOldid,
531 [ 'known', 'noclasses' ]
538 if ( $allLogs ||
$rcObj->mAttribs
['rc_type'] == RC_CATEGORIZE
) {
539 // don't show history link for logs
540 } elseif ( $namehidden ||
!$block0->getTitle()->exists() ) {
541 $links['history'] = $this->message
['enhancedrc-history'];
543 $params = $queryParams;
544 $params['action'] = 'history';
546 $links['history'] = Linker
::linkKnown(
548 $this->message
['enhancedrc-history'],
554 # Allow others to alter, remove or add to these links
555 Hooks
::run( 'EnhancedChangesList::getLogText',
556 [ $this, &$links, $block ] );
562 $logtext = implode( $this->message
['pipe-separator'], $links );
563 $logtext = $this->msg( 'parentheses' )->rawParams( $logtext )->escaped();
564 return ' ' . $logtext;
568 * Enhanced RC ungrouped line.
570 * @param RecentChange|RCCacheEntry $rcObj
571 * @return string A HTML formatted line (generated using $r)
573 protected function recentChangesBlockLine( $rcObj ) {
576 $query['curid'] = $rcObj->mAttribs
['rc_cur_id'];
578 $type = $rcObj->mAttribs
['rc_type'];
579 $logType = $rcObj->mAttribs
['rc_log_type'];
580 $classes = $this->getHTMLClasses( $rcObj, $rcObj->watched
);
581 $classes[] = 'mw-enhanced-rc';
585 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-log-' . $logType );
587 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-ns' .
588 $rcObj->mAttribs
['rc_namespace'] . '-' . $rcObj->mAttribs
['rc_title'] );
592 $data['recentChangesFlags'] = [
593 'newpage' => $type == RC_NEW
,
594 'minor' => $rcObj->mAttribs
['rc_minor'],
595 'unpatrolled' => $rcObj->unpatrolled
,
596 'bot' => $rcObj->mAttribs
['rc_bot'],
598 // timestamp is not really a link here, but is called timestampLink
599 // for consistency with EnhancedChangesListModifyLineData
600 $data['timestampLink'] = $rcObj->timestamp
;
602 # Article or log link
604 $logPage = new LogPage( $logType );
605 $logTitle = SpecialPage
::getTitleFor( 'Log', $logType );
606 $logName = $logPage->getName()->escaped();
607 $data['logLink'] = $this->msg( 'parentheses' )
608 ->rawParams( Linker
::linkKnown( $logTitle, $logName ) )->escaped();
610 $data['articleLink'] = $this->getArticleLink( $rcObj, $rcObj->unpatrolled
, $rcObj->watched
);
613 # Diff and hist links
614 if ( $type != RC_LOG
&& $type != RC_CATEGORIZE
) {
615 $query['action'] = 'history';
616 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
618 $data['separatorAfterLinks'] = ' <span class="mw-changeslist-separator">. .</span> ';
621 if ( $this->getConfig()->get( 'RCShowChangedSize' ) ) {
622 $cd = $this->formatCharacterDifference( $rcObj );
624 $data['characterDiff'] = $cd;
625 $data['separatorAftercharacterDiff'] = ' <span class="mw-changeslist-separator">. .</span> ';
629 if ( $type == RC_LOG
) {
630 $data['logEntry'] = $this->insertLogEntry( $rcObj );
631 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
632 $data['comment'] = $this->insertComment( $rcObj );
634 $data['userLink'] = $rcObj->userlink
;
635 $data['userTalkLink'] = $rcObj->usertalklink
;
636 $data['comment'] = $this->insertComment( $rcObj );
637 if ( $type == RC_CATEGORIZE
) {
638 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
640 $data['rollback'] = $this->getRollback( $rcObj );
644 $data['tags'] = $this->getTags( $rcObj, $classes );
646 # Show how many people are watching this if enabled
647 $data['watchingUsers'] = $this->numberofWatchingusers( $rcObj->numberofWatchingusers
);
649 // give the hook a chance to modify the data
650 $success = Hooks
::run( 'EnhancedChangesListModifyBlockLineData',
651 [ $this, &$data, $rcObj ] );
653 // skip entry if hook aborted it
657 $line = Html
::openElement( 'table', [ 'class' => $classes ] ) .
658 Html
::openElement( 'tr' );
659 $line .= '<td class="mw-enhanced-rc"><span class="mw-enhancedchanges-arrow-space"></span>';
661 if ( isset( $data['recentChangesFlags'] ) ) {
662 $line .= $this->recentChangesFlags( $data['recentChangesFlags'] );
663 unset( $data['recentChangesFlags'] );
666 if ( isset( $data['timestampLink'] ) ) {
667 $line .= ' ' . $data['timestampLink'];
668 unset( $data['timestampLink'] );
670 $line .= ' </td><td>';
672 // everything else: makes it easier for extensions to add or remove data
673 $line .= implode( '', $data );
675 $line .= "</td></tr></table>\n";
681 * Returns value to be used in 'historyLink' element of $data param in
682 * EnhancedChangesListModifyBlockLineData hook.
686 * @param RCCacheEntry $rc
687 * @param array $query array of key/value pairs to append as a query string
688 * @return string HTML
690 public function getDiffHistLinks( RCCacheEntry
$rc, array $query ) {
691 $pageTitle = $rc->getTitle();
692 if ( $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE
) {
693 // For categorizations we must swap the category title with the page title!
694 $pageTitle = Title
::newFromID( $rc->getAttribute( 'rc_cur_id' ) );
697 $retVal = ' ' . $this->msg( 'parentheses' )
698 ->rawParams( $rc->difflink
. $this->message
['pipe-separator'] . Linker
::linkKnown(
700 $this->message
['hist'],
708 * If enhanced RC is in use, this function takes the previously cached
709 * RC lines, arranges them, and outputs the HTML
713 protected function recentChangesBlock() {
714 if ( count( $this->rc_cache
) == 0 ) {
719 foreach ( $this->rc_cache
as $block ) {
720 if ( count( $block ) < 2 ) {
721 $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) );
723 $blockOut .= $this->recentChangesBlockGroup( $block );
727 return '<div>' . $blockOut . '</div>';
731 * Returns text for the end of RC
732 * If enhanced RC is in use, returns pretty much all the text
735 public function endRecentChangesList() {
736 return $this->recentChangesBlock() . '</div>';