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() {
66 $this->rc_cache
= array();
67 $this->rcMoveIndex
= 0;
68 $this->rcCacheIndex
= 0;
70 $this->rclistOpen
= false;
71 $this->getOutput()->addModuleStyles( array(
72 'mediawiki.special.changeslist',
73 'mediawiki.special.changeslist.enhanced',
75 $this->getOutput()->addModules( array(
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 $baseRC
87 * @param bool $watched
91 public function recentChangesLine( &$baseRC, $watched = false ) {
93 $date = $this->getLanguage()->userDate(
94 $baseRC->mAttribs
['rc_timestamp'],
100 # If it's a new day, add the headline and flush the cache
101 if ( $date != $this->lastdate
) {
102 # Process current cache
103 $ret = $this->recentChangesBlock();
104 $this->rc_cache
= array();
105 $ret .= Xml
::element( 'h4', null, $date ) . "\n";
106 $this->lastdate
= $date;
109 $cacheEntry = $this->cacheEntryFactory
->newFromRecentChange( $baseRC, $watched );
110 $this->addCacheEntry( $cacheEntry );
116 * Put accumulated information into the cache, for later display.
117 * Page moves go on their own line.
119 * @param RCCacheEntry $cacheEntry
121 protected function addCacheEntry( RCCacheEntry
$cacheEntry ) {
122 $cacheGroupingKey = $this->makeCacheGroupingKey( $cacheEntry );
124 if ( !isset( $this->rc_cache
[$cacheGroupingKey] ) ) {
125 $this->rc_cache
[$cacheGroupingKey] = array();
128 array_push( $this->rc_cache
[$cacheGroupingKey], $cacheEntry );
132 * @todo use rc_source to group, if set; fallback to rc_type
134 * @param RCCacheEntry $cacheEntry
138 protected function makeCacheGroupingKey( RCCacheEntry
$cacheEntry ) {
139 $title = $cacheEntry->getTitle();
140 $cacheGroupingKey = $title->getPrefixedDBkey();
142 $type = $cacheEntry->mAttribs
['rc_type'];
144 if ( $type == RC_LOG
) {
146 $cacheGroupingKey = SpecialPage
::getTitleFor(
148 $cacheEntry->mAttribs
['rc_log_type']
149 )->getPrefixedDBkey();
152 return $cacheGroupingKey;
157 * @param RCCacheEntry[] $block
160 protected function recentChangesBlockGroup( $block ) {
162 # Add the namespace and title of the block as part of the class
163 $classes = array( 'mw-collapsible', 'mw-collapsed', 'mw-enhanced-rc' );
164 if ( $block[0]->mAttribs
['rc_log_type'] ) {
166 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-log-'
167 . $block[0]->mAttribs
['rc_log_type'] );
169 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-ns'
170 . $block[0]->mAttribs
['rc_namespace'] . '-' . $block[0]->mAttribs
['rc_title'] );
172 $classes[] = $block[0]->watched
&& $block[0]->mAttribs
['rc_timestamp'] >= $block[0]->watched
173 ?
'mw-changeslist-line-watched' : 'mw-changeslist-line-not-watched';
174 $r = Html
::openElement( 'table', array( 'class' => $classes ) ) .
175 Html
::openElement( 'tr' );
177 # Collate list of users
178 $userlinks = array();
180 $unpatrolled = false;
185 # Some catalyst variables...
188 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
189 foreach ( $block as $rcObj ) {
190 if ( $rcObj->mAttribs
['rc_type'] == RC_NEW
) {
193 // If all log actions to this page were hidden, then don't
194 // give the name of the affected page for this block!
195 if ( !$this->isDeleted( $rcObj, LogPage
::DELETED_ACTION
) ) {
198 $u = $rcObj->userlink
;
199 if ( !isset( $userlinks[$u] ) ) {
202 if ( $rcObj->unpatrolled
) {
205 if ( $rcObj->mAttribs
['rc_type'] != RC_LOG
) {
208 # Get the latest entry with a page_id and oldid
209 # since logs may not have these.
210 if ( !$curId && $rcObj->mAttribs
['rc_cur_id'] ) {
211 $curId = $rcObj->mAttribs
['rc_cur_id'];
214 if ( !$rcObj->mAttribs
['rc_bot'] ) {
217 if ( !$rcObj->mAttribs
['rc_minor'] ) {
224 # Sort the list and convert to text
225 krsort( $userlinks );
228 foreach ( $userlinks as $userlink => $count ) {
230 $text .= $this->getLanguage()->getDirMark();
232 // @todo FIXME: Hardcoded '×'. Should be a message.
233 $formattedCount = $this->getLanguage()->formatNum( $count ) . '×';
234 $text .= ' ' . $this->msg( 'parentheses' )->rawParams( $formattedCount )->escaped();
236 array_push( $users, $text );
239 $users = ' <span class="changedby">'
240 . $this->msg( 'brackets' )->rawParams(
241 implode( $this->message
['semicolon-separator'], $users )
242 )->escaped() . '</span>';
244 $tl = '<span class="mw-collapsible-toggle mw-collapsible-arrow ' .
245 'mw-enhancedchanges-arrow mw-enhancedchanges-arrow-space"></span>';
246 $r .= "<td>$tl</td>";
249 $r .= '<td class="mw-enhanced-rc">' . $this->recentChangesFlags( array(
250 'newpage' => $isnew, # show, when one have this flag
251 'minor' => $allMinors, # show only, when all have this flag
252 'unpatrolled' => $unpatrolled, # show, when one have this flag
253 'bot' => $allBots, # show only, when all have this flag
257 $r .= ' ' . $block[0]->timestamp
. ' </td><td>';
261 $r .= ' <span class="history-deleted">' .
262 $this->msg( 'rev-deleted-event' )->escaped() . '</span>';
263 } elseif ( $allLogs ) {
264 $r .= $this->maybeWatchedLink( $block[0]->link
, $block[0]->watched
);
266 $this->insertArticleLink( $r, $block[0], $block[0]->unpatrolled
, $block[0]->watched
);
269 $r .= $this->getLanguage()->getDirMark();
271 $queryParams['curid'] = $curId;
275 foreach ( $block as $i => $rcObj ) {
276 $line = $this->getLineData( $block, $rcObj, $queryParams );
279 // completely ignore this RC entry if we don't want to render it
283 // Further down are some assumptions that $block is a 0-indexed array
284 // with (count-1) as last key. Let's make sure it is.
285 $block = array_values( $block );
286 if ( empty( $block ) ) {
287 // if we can't show anything, don't display this block altogether
291 $r .= $this->getLogText( $block, $queryParams, $allLogs, $isnew, $namehidden );
293 $r .= ' <span class="mw-changeslist-separator">. .</span> ';
295 # Character difference (does not apply if only log items)
296 if ( $RCShowChangedSize && !$allLogs ) {
298 $first = count( $block ) - 1;
299 # Some events (like logs) have an "empty" size, so we need to skip those...
300 while ( $last < $first && $block[$last]->mAttribs
['rc_new_len'] === null ) {
303 while ( $first > $last && $block[$first]->mAttribs
['rc_old_len'] === null ) {
307 $chardiff = $this->formatCharacterDifference( $block[$first], $block[$last] );
309 if ( $chardiff == '' ) {
312 $r .= ' ' . $chardiff . ' <span class="mw-changeslist-separator">. .</span> ';
317 $r .= $this->numberofWatchingusers( $block[0]->numberofWatchingusers
);
321 // if there are no lines to be rendered (all aborted by hook), don't render the block
328 $this->rcCacheIndex++
;
334 * @param RCCacheEntry[] $block
335 * @param RCCacheEntry $rcObj
336 * @param array $queryParams
340 * @throws MWException
342 protected function getLineData( array $block, RCCacheEntry
$rcObj, array $queryParams = array() ) {
343 $RCShowChangedSize = $this->getConfig()->get( 'RCShowChangedSize' );
345 # Classes to apply -- TODO implement
347 $type = $rcObj->mAttribs
['rc_type'];
350 $trClass = $rcObj->watched
&& $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
351 ?
' class="mw-enhanced-watched"' : '';
352 $separator = ' <span class="mw-changeslist-separator">. .</span> ';
354 $data['recentChangesFlags'] = array(
355 'newpage' => $type == RC_NEW
,
356 'minor' => $rcObj->mAttribs
['rc_minor'],
357 'unpatrolled' => $rcObj->unpatrolled
,
358 'bot' => $rcObj->mAttribs
['rc_bot'],
361 $params = $queryParams;
363 if ( $rcObj->mAttribs
['rc_this_oldid'] != 0 ) {
364 $params['oldid'] = $rcObj->mAttribs
['rc_this_oldid'];
368 if ( $type == RC_LOG
) {
369 $link = $rcObj->timestamp
;
371 } elseif ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
372 $link = '<span class="history-deleted">' . $rcObj->timestamp
. '</span> ';
374 $link = Linker
::linkKnown(
380 if ( $this->isDeleted( $rcObj, Revision
::DELETED_TEXT
) ) {
381 $link = '<span class="history-deleted">' . $link . '</span> ';
384 $data['timestampLink'] = $link;
386 $currentAndLastLinks = '';
387 if ( !$type == RC_LOG ||
$type == RC_NEW
) {
388 $currentAndLastLinks .= ' ' . $this->msg( 'parentheses' )->rawParams(
390 $this->message
['pipe-separator'] .
394 $data['currentAndLastLinks'] = $currentAndLastLinks;
395 $data['separatorAfterCurrentAndLastLinks'] = $separator;
398 if ( $RCShowChangedSize ) {
399 $cd = $this->formatCharacterDifference( $rcObj );
401 $data['characterDiff'] = $cd;
402 $data['separatorAfterCharacterDiff'] = $separator;
406 if ( $rcObj->mAttribs
['rc_type'] == RC_LOG
) {
407 $data['logEntry'] = $this->insertLogEntry( $rcObj );
408 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
409 $data['comment'] = $this->insertComment( $rcObj );
412 $data['userLink'] = $rcObj->userlink
;
413 $data['userTalkLink'] = $rcObj->usertalklink
;
414 $data['comment'] = $this->insertComment( $rcObj );
418 $data['rollback'] = $this->getRollback( $rcObj );
421 $data['tags'] = $this->getTags( $rcObj, $classes );
423 // give the hook a chance to modify the data
424 $success = Hooks
::run( 'EnhancedChangesListModifyLineData',
425 array( $this, &$data, $block, $rcObj ) );
427 // skip entry if hook aborted it
431 $line = '<tr' . $trClass . '><td></td><td class="mw-enhanced-rc">';
432 if ( isset( $data['recentChangesFlags'] ) ) {
433 $line .= $this->recentChangesFlags( $data['recentChangesFlags'] );
434 unset( $data['recentChangesFlags'] );
436 $line .= ' </td><td class="mw-enhanced-rc-nested">';
438 if ( isset( $data['timestampLink'] ) ) {
439 $line .= '<span class="mw-enhanced-rc-time">' . $data['timestampLink'] . '</span>';
440 unset( $data['timestampLink'] );
443 // everything else: makes it easier for extensions to add or remove data
444 $line .= implode( '', $data );
446 $line .= "</td></tr>\n";
452 * Generates amount of changes (linking to diff ) & link to history.
454 * @param array $block
455 * @param array $queryParams
456 * @param bool $allLogs
458 * @param bool $namehidden
461 protected function getLogText( $block, $queryParams, $allLogs, $isnew, $namehidden ) {
462 if ( empty( $block ) ) {
467 static $nchanges = array();
468 static $sinceLastVisitMsg = array();
470 $n = count( $block );
471 if ( !isset( $nchanges[$n] ) ) {
472 $nchanges[$n] = $this->msg( 'nchanges' )->numParams( $n )->escaped();
476 $unvisitedOldid = null;
477 /** @var $rcObj RCCacheEntry */
478 foreach ( $block as $rcObj ) {
479 // Same logic as below inside main foreach
480 if ( $rcObj->watched
&& $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
) {
482 $unvisitedOldid = $rcObj->mAttribs
['rc_last_oldid'];
485 if ( !isset( $sinceLastVisitMsg[$sinceLast] ) ) {
486 $sinceLastVisitMsg[$sinceLast] =
487 $this->msg( 'enhancedrc-since-last-visit' )->numParams( $sinceLast )->escaped();
490 $currentRevision = 0;
491 foreach ( $block as $rcObj ) {
492 if ( !$currentRevision ) {
493 $currentRevision = $rcObj->mAttribs
['rc_this_oldid'];
499 /** @var $block0 RecentChange */
501 $last = $block[count( $block ) - 1];
502 if ( !$allLogs && $rcObj->mAttribs
['rc_type'] != RC_CATEGORIZE
) {
503 if ( !ChangesList
::userCan( $rcObj, Revision
::DELETED_TEXT
, $this->getUser() ) ) {
504 $links['total-changes'] = $nchanges[$n];
505 } elseif ( $isnew ) {
506 $links['total-changes'] = $nchanges[$n];
508 $links['total-changes'] = Linker
::link(
512 $queryParams +
array(
513 'diff' => $currentRevision,
514 'oldid' => $last->mAttribs
['rc_last_oldid'],
516 array( 'known', 'noclasses' )
518 if ( $sinceLast > 0 && $sinceLast < $n ) {
519 $links['total-changes-since-last'] = Linker
::link(
521 $sinceLastVisitMsg[$sinceLast],
523 $queryParams +
array(
524 'diff' => $currentRevision,
525 'oldid' => $unvisitedOldid,
527 array( 'known', 'noclasses' )
534 if ( $allLogs ||
$rcObj->mAttribs
['rc_type'] == RC_CATEGORIZE
) {
535 // don't show history link for logs
536 } elseif ( $namehidden ||
!$block0->getTitle()->exists() ) {
537 $links['history'] = $this->message
['enhancedrc-history'];
539 $params = $queryParams;
540 $params['action'] = 'history';
542 $links['history'] = Linker
::linkKnown(
544 $this->message
['enhancedrc-history'],
550 # Allow others to alter, remove or add to these links
551 Hooks
::run( 'EnhancedChangesList::getLogText',
552 array( $this, &$links, $block ) );
558 $logtext = implode( $this->message
['pipe-separator'], $links );
559 $logtext = $this->msg( 'parentheses' )->rawParams( $logtext )->escaped();
560 return ' ' . $logtext;
564 * Enhanced RC ungrouped line.
566 * @param RecentChange|RCCacheEntry $rcObj
567 * @return string A HTML formatted line (generated using $r)
569 protected function recentChangesBlockLine( $rcObj ) {
572 $query['curid'] = $rcObj->mAttribs
['rc_cur_id'];
574 $type = $rcObj->mAttribs
['rc_type'];
575 $logType = $rcObj->mAttribs
['rc_log_type'];
576 $classes = array( 'mw-enhanced-rc' );
579 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-log-' . $logType );
581 $classes[] = Sanitizer
::escapeClass( 'mw-changeslist-ns' .
582 $rcObj->mAttribs
['rc_namespace'] . '-' . $rcObj->mAttribs
['rc_title'] );
584 $classes[] = $rcObj->watched
&& $rcObj->mAttribs
['rc_timestamp'] >= $rcObj->watched
585 ?
'mw-changeslist-line-watched' : 'mw-changeslist-line-not-watched';
588 $data['recentChangesFlags'] = array(
589 'newpage' => $type == RC_NEW
,
590 'minor' => $rcObj->mAttribs
['rc_minor'],
591 'unpatrolled' => $rcObj->unpatrolled
,
592 'bot' => $rcObj->mAttribs
['rc_bot'],
594 // timestamp is not really a link here, but is called timestampLink
595 // for consistency with EnhancedChangesListModifyLineData
596 $data['timestampLink'] = $rcObj->timestamp
;
598 # Article or log link
600 $logPage = new LogPage( $logType );
601 $logTitle = SpecialPage
::getTitleFor( 'Log', $logType );
602 $logName = $logPage->getName()->escaped();
603 $data['logLink'] = $this->msg( 'parentheses' )
604 ->rawParams( Linker
::linkKnown( $logTitle, $logName ) )->escaped();
606 $data['articleLink'] = $this->getArticleLink( $rcObj, $rcObj->unpatrolled
, $rcObj->watched
);
609 # Diff and hist links
610 if ( $type == RC_LOG
&& $type != RC_CATEGORIZE
) {
611 $query['action'] = 'history';
612 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
614 $data['separatorAfterLinks'] = ' <span class="mw-changeslist-separator">. .</span> ';
617 if ( $this->getConfig()->get( 'RCShowChangedSize' ) ) {
618 $cd = $this->formatCharacterDifference( $rcObj );
620 $data['characterDiff'] = $cd;
621 $data['separatorAftercharacterDiff'] = ' <span class="mw-changeslist-separator">. .</span> ';
625 if ( $type == RC_LOG
) {
626 $data['logEntry'] = $this->insertLogEntry( $rcObj );
627 } elseif ( $this->isCategorizationWithoutRevision( $rcObj ) ) {
628 $data['comment'] = $this->insertComment( $rcObj );
630 $data['userLink'] = $rcObj->userlink
;
631 $data['userTalkLink'] = $rcObj->usertalklink
;
632 $data['comment'] = $this->insertComment( $rcObj );
633 if ( $type == RC_CATEGORIZE
) {
634 $data['historyLink'] = $this->getDiffHistLinks( $rcObj, $query );
636 $data['rollback'] = $this->getRollback( $rcObj );
640 $data['tags'] = $this->getTags( $rcObj, $classes );
642 # Show how many people are watching this if enabled
643 $data['watchingUsers'] = $this->numberofWatchingusers( $rcObj->numberofWatchingusers
);
645 // give the hook a chance to modify the data
646 $success = Hooks
::run( 'EnhancedChangesListModifyBlockLineData',
647 array( $this, &$data, $rcObj ) );
649 // skip entry if hook aborted it
653 $line = Html
::openElement( 'table', array( 'class' => $classes ) ) .
654 Html
::openElement( 'tr' );
655 $line .= '<td class="mw-enhanced-rc"><span class="mw-enhancedchanges-arrow-space"></span>';
657 if ( isset( $data['recentChangesFlags'] ) ) {
658 $line .= $this->recentChangesFlags( $data['recentChangesFlags'] );
659 unset( $data['recentChangesFlags'] );
662 if ( isset( $data['timestampLink'] ) ) {
663 $line .= ' ' . $data['timestampLink'];
664 unset( $data['timestampLink'] );
666 $line .= ' </td><td>';
668 // everything else: makes it easier for extensions to add or remove data
669 $line .= implode( '', $data );
671 $line .= "</td></tr></table>\n";
677 * Returns value to be used in 'historyLink' element of $data param in
678 * EnhancedChangesListModifyBlockLineData hook.
682 * @param RCCacheEntry $rc
683 * @param array $query array of key/value pairs to append as a query string
684 * @return string HTML
686 public function getDiffHistLinks( RCCacheEntry
$rc, array $query ) {
687 $pageTitle = $rc->getTitle();
688 if ( $rc->getAttribute( 'rc_type' ) == RC_CATEGORIZE
) {
689 // For categorizations we must swap the category title with the page title!
690 $pageTitle = Title
::newFromID( $rc->getAttribute( 'rc_cur_id' ) );
693 $retVal = ' ' . $this->msg( 'parentheses' )
694 ->rawParams( $rc->difflink
. $this->message
['pipe-separator'] . Linker
::linkKnown(
696 $this->message
['hist'],
704 * If enhanced RC is in use, this function takes the previously cached
705 * RC lines, arranges them, and outputs the HTML
709 protected function recentChangesBlock() {
710 if ( count( $this->rc_cache
) == 0 ) {
715 foreach ( $this->rc_cache
as $block ) {
716 if ( count( $block ) < 2 ) {
717 $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) );
719 $blockOut .= $this->recentChangesBlockGroup( $block );
723 return '<div>' . $blockOut . '</div>';
727 * Returns text for the end of RC
728 * If enhanced RC is in use, returns pretty much all the text
731 public function endRecentChangesList() {
732 return $this->recentChangesBlock() . '</div>';