4 * Contain class to show various lists of change:
14 class RCCacheEntry
extends RecentChange
16 var $secureName, $link;
17 var $curlink , $difflink, $lastlink , $usertalklink , $versionlink ;
18 var $userlink, $timestamp, $watched;
20 function newFromParent( $rc )
22 $rc2 = new RCCacheEntry
;
23 $rc2->mAttribs
= $rc->mAttribs
;
24 $rc2->mExtra
= $rc->mExtra
;
33 # Called by history lists and recent changes
37 function ChangesList( &$skin ) {
39 $this->preCacheMessages();
43 * Fetch an appropriate changes list class for the specified user
44 * Some users might want to use an enhanced list format, for instance
46 * @param $user User to fetch the list class for
47 * @return ChangesList derivative
49 public static function newFromUser( &$user ) {
50 $sk =& $user->getSkin();
52 if( wfRunHooks( 'FetchChangesList', array( &$user, &$sk, &$list ) ) ) {
53 return $user->getOption( 'usenewrc' ) ?
new EnhancedChangesList( $sk ) : new OldChangesList( $sk );
60 * As we use the same small set of messages in various methods and that
61 * they are called often, we call them once and save them in $this->message
63 function preCacheMessages() {
64 // Precache various messages
65 if( !isset( $this->message
) ) {
66 foreach( explode(' ', 'cur diff hist minoreditletter newpageletter last '.
67 'blocklink changes history boteditletter' ) as $msg ) {
68 $this->message
[$msg] = wfMsgExt( $msg, array( 'escape') );
75 * Returns the appropriate flags for new page, minor change and patrolling
77 function recentChangesFlags( $new, $minor, $patrolled, $nothing = ' ', $bot = false ) {
78 $f = $new ?
'<span class="newpage">' . $this->message
['newpageletter'] . '</span>'
80 $f .= $minor ?
'<span class="minor">' . $this->message
['minoreditletter'] . '</span>'
82 $f .= $bot ?
'<span class="bot">' . $this->message
['boteditletter'] . '</span>' : $nothing;
83 $f .= $patrolled ?
'<span class="unpatrolled">!</span>' : $nothing;
88 * Returns text for the start of the tabular part of RC
90 function beginRecentChangesList() {
91 $this->rc_cache
= array();
92 $this->rcMoveIndex
= 0;
93 $this->rcCacheIndex
= 0;
95 $this->rclistOpen
= false;
100 * Returns text for the end of RC
102 function endRecentChangesList() {
103 if( $this->rclistOpen
) {
111 function insertMove( &$s, $rc ) {
113 $s .= '(' . $this->message
['diff'] . ') (';
115 $s .= $this->skin
->makeKnownLinkObj( $rc->getMovedToTitle(), $this->message
['hist'], 'action=history' ) .
118 # "[[x]] moved to [[y]]"
119 $msg = ( $rc->mAttribs
['rc_type'] == RC_MOVE
) ?
'1movedto2' : '1movedto2_redir';
120 $s .= wfMsg( $msg, $this->skin
->makeKnownLinkObj( $rc->getTitle(), '', 'redirect=no' ),
121 $this->skin
->makeKnownLinkObj( $rc->getMovedToTitle(), '' ) );
124 function insertDateHeader(&$s, $rc_timestamp) {
127 # Make date header if necessary
128 $date = $wgLang->date( $rc_timestamp, true, true );
130 if( $date != $this->lastdate
) {
131 if( '' != $this->lastdate
) {
134 $s .= '<h4>'.$date."</h4>\n<ul class=\"special\">";
135 $this->lastdate
= $date;
136 $this->rclistOpen
= true;
140 function insertLog(&$s, $title, $logtype) {
141 $logname = LogPage
::logName( $logtype );
142 $s .= '(' . $this->skin
->makeKnownLinkObj($title, $logname ) . ')';
146 function insertDiffHist(&$s, &$rc, $unpatrolled) {
148 if( $rc->mAttribs
['rc_type'] == RC_NEW ||
$rc->mAttribs
['rc_type'] == RC_LOG
) {
149 $diffLink = $this->message
['diff'];
151 $rcidparam = $unpatrolled
152 ?
array( 'rcid' => $rc->mAttribs
['rc_id'] )
154 $diffLink = $this->skin
->makeKnownLinkObj( $rc->getTitle(), $this->message
['diff'],
156 'curid' => $rc->mAttribs
['rc_cur_id'],
157 'diff' => $rc->mAttribs
['rc_this_oldid'],
158 'oldid' => $rc->mAttribs
['rc_last_oldid'] ),
160 '', '', ' tabindex="'.$rc->counter
.'"');
162 $s .= '('.$diffLink.') (';
165 $s .= $this->skin
->makeKnownLinkObj( $rc->getTitle(), $this->message
['hist'],
167 'curid' => $rc->mAttribs
['rc_cur_id'],
168 'action' => 'history' ) ) );
172 function insertArticleLink(&$s, &$rc, $unpatrolled, $watched) {
174 # If it's a new article, there is no diff link, but if it hasn't been
175 # patrolled yet, we need to give users a way to do so
176 $params = ( $unpatrolled && $rc->mAttribs
['rc_type'] == RC_NEW
)
177 ?
'rcid='.$rc->mAttribs
['rc_id']
179 $articlelink = ' '. $this->skin
->makeKnownLinkObj( $rc->getTitle(), '', $params );
180 if($watched) $articlelink = '<strong>'.$articlelink.'</strong>';
182 $articlelink .= $wgContLang->getDirMark();
184 $s .= ' ' . $articlelink . ' . . ';
187 function insertTimestamp(&$s, $rc) {
190 $s .= $wgLang->time( $rc->mAttribs
['rc_timestamp'], true, true ) . ' . . ';
193 /** Insert links to user page, user talk page and eventually a blocking link */
194 function insertUserRelatedLinks(&$s, &$rc) {
195 $s .= $this->skin
->userLink( $rc->mAttribs
['rc_user'], $rc->mAttribs
['rc_user_text'] );
196 $s .= $this->skin
->userToolLinks( $rc->mAttribs
['rc_user'], $rc->mAttribs
['rc_user_text'] );
199 /** insert a formatted comment */
200 function insertComment(&$s, &$rc) {
202 if( $rc->mAttribs
['rc_type'] != RC_MOVE
&& $rc->mAttribs
['rc_type'] != RC_MOVE_OVER_REDIRECT
) {
203 $s .= $this->skin
->commentBlock( $rc->mAttribs
['rc_comment'], $rc->getTitle() );
208 * Check whether to enable recent changes patrol features
211 function usePatrol() {
212 global $wgUseRCPatrol, $wgUser;
213 return( $wgUseRCPatrol && $wgUser->isAllowed( 'patrol' ) );
219 * Generate a list of changes using the good old system (no javascript)
221 class OldChangesList
extends ChangesList
{
223 * Format a line using the old system (aka without any javascript).
225 function recentChangesLine( &$rc, $watched = false ) {
226 global $wgContLang, $wgRCShowChangedSize;
228 $fname = 'ChangesList::recentChangesLineOld';
229 wfProfileIn( $fname );
231 # Extract DB fields into local scope
232 extract( $rc->mAttribs
);
234 # Should patrol-related stuff be shown?
235 $unpatrolled = $this->usePatrol() && $rc_patrolled == 0;
237 $this->insertDateHeader($s,$rc_timestamp);
240 $this->insertTimestamp($s,$rc);
243 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
244 $this->insertMove( $s, $rc );
246 } elseif ( $rc_namespace == NS_SPECIAL
) {
247 list( $specialName, $specialSubpage ) = SpecialPage
::resolveAliasWithSubpage( $rc_title );
248 if ( $specialName == 'Log' ) {
249 $this->insertLog( $s, $rc->getTitle(), $specialSubpage );
251 wfDebug( "Unexpected special page in recentchanges\n" );
255 wfProfileIn($fname.'-page');
257 $this->insertDiffHist($s, $rc, $unpatrolled);
259 # M, N, b and ! (minor, new, bot and unpatrolled)
260 $s .= ' ' . $this->recentChangesFlags( $rc_type == RC_NEW
, $rc_minor, $unpatrolled, '', $rc_bot );
261 $this->insertArticleLink($s, $rc, $unpatrolled, $watched);
263 wfProfileOut($fname.'-page');
266 wfProfileIn( $fname.'-rest' );
268 if( $wgRCShowChangedSize ) {
269 $s .= ( $rc->getCharacterDifference() == '' ?
'' : $rc->getCharacterDifference() . ' . . ' );
272 $this->insertUserRelatedLinks($s,$rc);
273 $this->insertComment($s, $rc);
275 if($rc->numberofWatchingusers
> 0) {
276 $s .= ' ' . wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($rc->numberofWatchingusers
));
281 wfProfileOut( $fname.'-rest' );
283 wfProfileOut( $fname );
290 * Generate a list of changes using an Enhanced system (use javascript).
292 class EnhancedChangesList
extends ChangesList
{
294 * Format a line for enhanced recentchange (aka with javascript and block of lines).
296 function recentChangesLine( &$baseRC, $watched = false ) {
297 global $wgLang, $wgContLang;
299 # Create a specialised object
300 $rc = RCCacheEntry
::newFromParent( $baseRC );
302 # Extract fields from DB into the function scope (rc_xxxx variables)
303 extract( $rc->mAttribs
);
304 $curIdEq = 'curid=' . $rc_cur_id;
306 # If it's a new day, add the headline and flush the cache
307 $date = $wgLang->date( $rc_timestamp, true);
309 if( $date != $this->lastdate
) {
310 # Process current cache
311 $ret = $this->recentChangesBlock();
312 $this->rc_cache
= array();
313 $ret .= "<h4>{$date}</h4>\n";
314 $this->lastdate
= $date;
317 # Should patrol-related stuff be shown?
318 if( $this->usePatrol() ) {
319 $rc->unpatrolled
= !$rc_patrolled;
321 $rc->unpatrolled
= false;
325 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
326 $msg = ( $rc_type == RC_MOVE
) ?
"1movedto2" : "1movedto2_redir";
327 $clink = wfMsg( $msg, $this->skin
->makeKnownLinkObj( $rc->getTitle(), '', 'redirect=no' ),
328 $this->skin
->makeKnownLinkObj( $rc->getMovedToTitle(), '' ) );
329 } elseif( $rc_namespace == NS_SPECIAL
) {
330 list( $specialName, $logtype ) = SpecialPage
::resolveAliasWithSubpage( $rc_title );
331 if ( $specialName == 'Log' ) {
333 $logname = LogPage
::logName( $logtype );
334 $clink = '(' . $this->skin
->makeKnownLinkObj( $rc->getTitle(), $logname ) . ')';
336 wfDebug( "Unexpected special page in recentchanges\n" );
339 } elseif( $rc->unpatrolled
&& $rc_type == RC_NEW
) {
340 # Unpatrolled new page, give rc_id in query
341 $clink = $this->skin
->makeKnownLinkObj( $rc->getTitle(), '', "rcid={$rc_id}" );
343 $clink = $this->skin
->makeKnownLinkObj( $rc->getTitle(), '' );
346 $time = $wgContLang->time( $rc_timestamp, true, true );
347 $rc->watched
= $watched;
349 $rc->timestamp
= $time;
350 $rc->numberofWatchingusers
= $baseRC->numberofWatchingusers
;
352 # Make "cur" and "diff" links
353 if( $rc->unpatrolled
) {
354 $rcIdQuery = "&rcid={$rc_id}";
358 $querycur = $curIdEq."&diff=0&oldid=$rc_this_oldid";
359 $querydiff = $curIdEq."&diff=$rc_this_oldid&oldid=$rc_last_oldid$rcIdQuery";
360 $aprops = ' tabindex="'.$baseRC->counter
.'"';
361 $curLink = $this->skin
->makeKnownLinkObj( $rc->getTitle(), $this->message
['cur'], $querycur, '' ,'', $aprops );
362 if( $rc_type == RC_NEW ||
$rc_type == RC_LOG ||
$rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
363 if( $rc_type != RC_NEW
) {
364 $curLink = $this->message
['cur'];
366 $diffLink = $this->message
['diff'];
368 $diffLink = $this->skin
->makeKnownLinkObj( $rc->getTitle(), $this->message
['diff'], $querydiff, '' ,'', $aprops );
372 if( $rc_last_oldid == 0 ||
$rc_type == RC_LOG ||
$rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
373 $lastLink = $this->message
['last'];
375 $lastLink = $this->skin
->makeKnownLinkObj( $rc->getTitle(), $this->message
['last'],
376 $curIdEq.'&diff='.$rc_this_oldid.'&oldid='.$rc_last_oldid . $rcIdQuery );
379 $rc->userlink
= $this->skin
->userLink( $rc_user, $rc_user_text );
381 $rc->lastlink
= $lastLink;
382 $rc->curlink
= $curLink;
383 $rc->difflink
= $diffLink;
385 $rc->usertalklink
= $this->skin
->userToolLinks( $rc_user, $rc_user_text );
387 # Put accumulated information into the cache, for later display
388 # Page moves go on their own line
389 $title = $rc->getTitle();
390 $secureName = $title->getPrefixedDBkey();
391 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
392 # Use an @ character to prevent collision with page names
393 $this->rc_cache
['@@' . ($this->rcMoveIndex++
)] = array($rc);
395 if( !isset ( $this->rc_cache
[$secureName] ) ) {
396 $this->rc_cache
[$secureName] = array();
398 array_push( $this->rc_cache
[$secureName], $rc );
406 function recentChangesBlockGroup( $block ) {
407 global $wgContLang, $wgRCShowChangedSize;
410 # Collate list of users
412 $unpatrolled = false;
413 $userlinks = array();
414 foreach( $block as $rcObj ) {
415 $oldid = $rcObj->mAttribs
['rc_last_oldid'];
416 if( $rcObj->mAttribs
['rc_new'] ) {
419 $u = $rcObj->userlink
;
420 if( !isset( $userlinks[$u] ) ) {
423 if( $rcObj->unpatrolled
) {
426 $bot = $rcObj->mAttribs
['rc_bot'];
430 # Sort the list and convert to text
431 krsort( $userlinks );
434 foreach( $userlinks as $userlink => $count) {
436 $text .= $wgContLang->getDirMark();
438 $text .= ' ('.$count.'×)';
440 array_push( $users, $text );
443 $users = ' <span class="changedby">['.implode('; ',$users).']</span>';
446 $rci = 'RCI'.$this->rcCacheIndex
;
447 $rcl = 'RCL'.$this->rcCacheIndex
;
448 $rcm = 'RCM'.$this->rcCacheIndex
;
449 $toggleLink = "javascript:toggleVisibility('$rci','$rcm','$rcl')";
450 $tl = '<span id="'.$rcm.'"><a href="'.$toggleLink.'">' . $this->sideArrow() . '</a></span>';
451 $tl .= '<span id="'.$rcl.'" style="display:none"><a href="'.$toggleLink.'">' . $this->downArrow() . '</a></span>';
456 $r .= $this->recentChangesFlags( $isnew, false, $unpatrolled, ' ', $bot );
459 $r .= ' '.$block[0]->timestamp
.' </tt>';
462 $r .= $this->maybeWatchedLink( $block[0]->link
, $block[0]->watched
);
463 $r .= $wgContLang->getDirMark();
465 $curIdEq = 'curid=' . $block[0]->mAttribs
['rc_cur_id'];
466 $currentRevision = $block[0]->mAttribs
['rc_this_oldid'];
467 if( $block[0]->mAttribs
['rc_type'] != RC_LOG
) {
469 $r .= ' ('.count($block).' ';
472 $r .= $this->message
['changes'];
474 $r .= $this->skin
->makeKnownLinkObj( $block[0]->getTitle(),
475 $this->message
['changes'], $curIdEq."&diff=$currentRevision&oldid=$oldid" );
478 # Character difference
479 $chardiff = $rcObj->getCharacterDifference( $block[ count( $block ) - 1 ]->mAttribs
['rc_old_len'],
480 $block[0]->mAttribs
['rc_new_len'] );
481 if( $chardiff == '' ) {
484 $r .= '; ' . $chardiff . ' ';
489 $r .= $this->skin
->makeKnownLinkObj( $block[0]->getTitle(),
490 $this->message
['history'], $curIdEq.'&action=history' );
496 if($block[0]->numberofWatchingusers
> 0) {
498 $r .= wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($block[0]->numberofWatchingusers
));
503 $r .= '<div id="'.$rci.'" style="display:none">';
504 foreach( $block as $rcObj ) {
505 # Get rc_xxxx variables
506 extract( $rcObj->mAttribs
);
508 $r .= $this->spacerArrow();
509 $r .= '<tt> ';
510 $r .= $this->recentChangesFlags( $rc_new, $rc_minor, $rcObj->unpatrolled
, ' ', $rc_bot );
514 if( $rc_this_oldid != 0 ) {
515 $o = 'oldid='.$rc_this_oldid;
517 if( $rc_type == RC_LOG
) {
518 $link = $rcObj->timestamp
;
520 $link = $this->skin
->makeKnownLinkObj( $rcObj->getTitle(), $rcObj->timestamp
, $curIdEq.'&'.$o );
522 $link = '<tt>'.$link.'</tt>';
526 $r .= $rcObj->curlink
;
528 $r .= $rcObj->lastlink
;
532 if( $wgRCShowChangedSize ) {
533 $r .= ( $rcObj->getCharacterDifference() == '' ?
'' : $rcObj->getCharacterDifference() . ' . . ' ) ;
536 $r .= $rcObj->userlink
;
537 $r .= $rcObj->usertalklink
;
538 $r .= $this->skin
->commentBlock( $rc_comment, $rcObj->getTitle() );
543 $this->rcCacheIndex++
;
547 function maybeWatchedLink( $link, $watched=false ) {
549 // FIXME: css style might be more appropriate
550 return '<strong>' . $link . '</strong>';
557 * Generate HTML for an arrow or placeholder graphic
558 * @param string $dir one of '', 'd', 'l', 'r'
559 * @param string $alt text
560 * @return string HTML <img> tag
563 function arrow( $dir, $alt='' ) {
565 $encUrl = htmlspecialchars( $wgStylePath . '/common/images/Arr_' . $dir . '.png' );
566 $encAlt = htmlspecialchars( $alt );
567 return "<img src=\"$encUrl\" width=\"12\" height=\"12\" alt=\"$encAlt\" />";
571 * Generate HTML for a right- or left-facing arrow,
572 * depending on language direction.
573 * @return string HTML <img> tag
576 function sideArrow() {
578 $dir = $wgContLang->isRTL() ?
'l' : 'r';
579 return $this->arrow( $dir, '+' );
583 * Generate HTML for a down-facing arrow
584 * depending on language direction.
585 * @return string HTML <img> tag
588 function downArrow() {
589 return $this->arrow( 'd', '-' );
593 * Generate HTML for a spacer image
594 * @return string HTML <img> tag
597 function spacerArrow() {
598 return $this->arrow( '', ' ' );
602 * Enhanced RC ungrouped line.
603 * @return string a HTML formated line (generated using $r)
605 function recentChangesBlockLine( $rcObj ) {
606 global $wgContLang, $wgRCShowChangedSize;
608 # Get rc_xxxx variables
609 extract( $rcObj->mAttribs
);
610 $curIdEq = 'curid='.$rc_cur_id;
615 $r .= $this->spacerArrow();
620 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
621 $r .= ' ';
623 $r .= $this->recentChangesFlags( $rc_type == RC_NEW
, $rc_minor, $rcObj->unpatrolled
, ' ', $rc_bot );
625 $r .= ' '.$rcObj->timestamp
.' </tt>';
628 $r .= $this->maybeWatchedLink( $rcObj->link
, $rcObj->watched
);
631 $r .= ' ('. $rcObj->difflink
.'; ';
634 $r .= $this->skin
->makeKnownLinkObj( $rcObj->getTitle(), wfMsg( 'hist' ), $curIdEq.'&action=history' ) . ') . . ';
637 if( $wgRCShowChangedSize ) {
638 $r .= ( $rcObj->getCharacterDifference() == '' ?
'' : ' ' . $rcObj->getCharacterDifference() . ' . . ' ) ;
642 $r .= $rcObj->userlink
. $rcObj->usertalklink
;
645 if( $rc_type != RC_MOVE
&& $rc_type != RC_MOVE_OVER_REDIRECT
) {
646 $r .= $this->skin
->commentBlock( $rc_comment, $rcObj->getTitle() );
649 if( $rcObj->numberofWatchingusers
> 0 ) {
650 $r .= wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($rcObj->numberofWatchingusers
));
658 * If enhanced RC is in use, this function takes the previously cached
659 * RC lines, arranges them, and outputs the HTML
661 function recentChangesBlock() {
662 if( count ( $this->rc_cache
) == 0 ) {
666 foreach( $this->rc_cache
as $block ) {
667 if( count( $block ) < 2 ) {
668 $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) );
670 $blockOut .= $this->recentChangesBlockGroup( $block );
674 return '<div>'.$blockOut.'</div>';
678 * Returns text for the end of RC
679 * If enhanced RC is in use, returns pretty much all the text
681 function endRecentChangesList() {
682 return $this->recentChangesBlock() . parent
::endRecentChangesList();