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() {
38 $this->preCacheMessages();
42 * Fetch an appropriate changes list class for the specified user
43 * Some users might want to use an enhanced list format, for instance
45 * @param $user User to fetch the list class for
46 * @return ChangesList derivative
48 function newFromUser( &$user ) {
50 if( wfRunHooks( 'FetchChangesList', array( &$user, &$list ) ) ) {
51 return $user->getOption( 'usenewrc' ) ?
new EnhancedChangesList() : new OldChangesList();
58 * As we use the same small set of messages in various methods and that
59 * they are called often, we call them once and save them in $this->message
61 function preCacheMessages() {
62 // Precache various messages
63 if( !isset( $this->message
) ) {
64 foreach( explode(' ', 'cur diff hist minoreditletter newpageletter last '.
65 'blocklink changes history boteditletter' ) as $msg ) {
66 $this->message
[$msg] = wfMsgExt( $msg, array( 'escape') );
73 * Returns the appropriate flags for new page, minor change and patrolling
75 function recentChangesFlags( $new, $minor, $patrolled, $nothing = ' ', $bot = false ) {
76 $f = $new ?
'<span class="newpage">' . $this->message
['newpageletter'] . '</span>'
78 $f .= $minor ?
'<span class="minor">' . $this->message
['minoreditletter'] . '</span>'
80 $f .= $bot ?
'<span class="bot">' . $this->message
['boteditletter'] . '</span>' : $nothing;
81 $f .= $patrolled ?
'<span class="unpatrolled">!</span>' : $nothing;
86 * Returns text for the start of the tabular part of RC
88 function beginRecentChangesList() {
89 $this->rc_cache
= array();
90 $this->rcMoveIndex
= 0;
91 $this->rcCacheIndex
= 0;
93 $this->rclistOpen
= false;
98 * Returns text for the end of RC
100 function endRecentChangesList() {
101 if( $this->rclistOpen
) {
109 function insertMove( &$s, $rc ) {
111 $s .= '(' . $this->message
['diff'] . ') (';
113 $s .= Linker
::makeKnownLinkObj( $rc->getMovedToTitle(), $this->message
['hist'], 'action=history' ) .
116 # "[[x]] moved to [[y]]"
117 $msg = ( $rc->mAttribs
['rc_type'] == RC_MOVE
) ?
'1movedto2' : '1movedto2_redir';
118 $s .= wfMsg( $msg, Linker
::makeKnownLinkObj( $rc->getTitle(), '', 'redirect=no' ),
119 Linker
::makeKnownLinkObj( $rc->getMovedToTitle(), '' ) );
122 function insertDateHeader(&$s, $rc_timestamp) {
125 # Make date header if necessary
126 $date = $wgLang->date( $rc_timestamp, true, true );
128 if( $date != $this->lastdate
) {
129 if( '' != $this->lastdate
) {
132 $s .= '<h4>'.$date."</h4>\n<ul class=\"special\">";
133 $this->lastdate
= $date;
134 $this->rclistOpen
= true;
138 function insertLog(&$s, $title, $logtype) {
139 $logname = LogPage
::logName( $logtype );
140 $s .= '(' . Linker
::makeKnownLinkObj($title, $logname ) . ')';
144 function insertDiffHist(&$s, &$rc, $unpatrolled) {
146 if( $rc->mAttribs
['rc_type'] == RC_NEW ||
$rc->mAttribs
['rc_type'] == RC_LOG
) {
147 $diffLink = $this->message
['diff'];
149 $rcidparam = $unpatrolled
150 ?
array( 'rcid' => $rc->mAttribs
['rc_id'] )
152 $diffLink = Linker
::makeKnownLinkObj( $rc->getTitle(), $this->message
['diff'],
154 'curid' => $rc->mAttribs
['rc_cur_id'],
155 'diff' => $rc->mAttribs
['rc_this_oldid'],
156 'oldid' => $rc->mAttribs
['rc_last_oldid'] ),
158 '', '', ' tabindex="'.$rc->counter
.'"');
160 $s .= '('.$diffLink.') (';
163 $s .= Linker
::makeKnownLinkObj( $rc->getTitle(), $this->message
['hist'],
165 'curid' => $rc->mAttribs
['rc_cur_id'],
166 'action' => 'history' ) ) );
170 function insertArticleLink(&$s, &$rc, $unpatrolled, $watched) {
172 # If it's a new article, there is no diff link, but if it hasn't been
173 # patrolled yet, we need to give users a way to do so
174 $params = ( $unpatrolled && $rc->mAttribs
['rc_type'] == RC_NEW
)
175 ?
'rcid='.$rc->mAttribs
['rc_id']
177 $articlelink = ' '. Linker
::makeKnownLinkObj( $rc->getTitle(), '', $params );
178 if($watched) $articlelink = '<strong>'.$articlelink.'</strong>';
180 $articlelink .= $wgContLang->getDirMark();
182 $s .= ' '.$articlelink;
185 function insertTimestamp(&$s, &$rc) {
188 $s .= '; ' . $wgLang->time( $rc->mAttribs
['rc_timestamp'], true, true ) . ' . . ';
191 /** Insert links to user page, user talk page and eventually a blocking link */
192 function insertUserRelatedLinks(&$s, &$rc) {
193 $s .= Linker
::userLink( $rc->mAttribs
['rc_user'], $rc->mAttribs
['rc_user_text'] );
194 $s .= Linker
::userToolLinks( $rc->mAttribs
['rc_user'], $rc->mAttribs
['rc_user_text'] );
197 /** insert a formatted comment */
198 function insertComment(&$s, &$rc) {
200 if( $rc->mAttribs
['rc_type'] != RC_MOVE
&& $rc->mAttribs
['rc_type'] != RC_MOVE_OVER_REDIRECT
) {
201 $s .= Linker
::commentBlock( $rc->mAttribs
['rc_comment'], $rc->getTitle() );
206 * Check whether to enable recent changes patrol features
209 function usePatrol() {
210 global $wgUseRCPatrol, $wgUser;
211 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 ) {
228 $fname = 'ChangesList::recentChangesLineOld';
229 wfProfileIn( $fname );
232 # Extract DB fields into local scope
233 extract( $rc->mAttribs
);
234 $curIdEq = 'curid=' . $rc_cur_id;
236 # Should patrol-related stuff be shown?
237 $unpatrolled = $this->usePatrol() && $rc_patrolled == 0;
239 $this->insertDateHeader($s,$rc_timestamp);
244 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
245 $this->insertMove( $s, $rc );
247 } elseif ( $rc_namespace == NS_SPECIAL
) {
248 list( $specialName, $specialSubpage ) = SpecialPage
::resolveAliasWithSubpage( $rc_title );
249 if ( $specialName == 'Log' ) {
250 $this->insertLog( $s, $rc->getTitle(), $specialSubpage );
252 wfDebug( "Unexpected special page in recentchanges\n" );
256 wfProfileIn($fname.'-page');
258 $this->insertDiffHist($s, $rc, $unpatrolled);
260 # M, N, b and ! (minor, new, bot and unpatrolled)
261 $s .= ' ' . $this->recentChangesFlags( $rc_type == RC_NEW
, $rc_minor, $unpatrolled, '', $rc_bot );
262 $this->insertArticleLink($s, $rc, $unpatrolled, $watched);
264 wfProfileOut($fname.'-page');
267 wfProfileIn( $fname.'-rest' );
269 $this->insertTimestamp($s,$rc);
270 $this->insertUserRelatedLinks($s,$rc);
271 $this->insertComment($s, $rc);
273 if($rc->numberofWatchingusers
> 0) {
274 $s .= ' ' . wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($rc->numberofWatchingusers
));
279 wfProfileOut( $fname.'-rest' );
281 wfProfileOut( $fname );
288 * Generate a list of changes using an Enhanced system (use javascript).
290 class EnhancedChangesList
extends ChangesList
{
292 * Format a line for enhanced recentchange (aka with javascript and block of lines).
294 function recentChangesLine( &$baseRC, $watched = false ) {
295 global $wgLang, $wgContLang;
297 # Create a specialised object
298 $rc = RCCacheEntry
::newFromParent( $baseRC );
300 # Extract fields from DB into the function scope (rc_xxxx variables)
301 extract( $rc->mAttribs
);
302 $curIdEq = 'curid=' . $rc_cur_id;
304 # If it's a new day, add the headline and flush the cache
305 $date = $wgLang->date( $rc_timestamp, true);
307 if( $date != $this->lastdate
) {
308 # Process current cache
309 $ret = $this->recentChangesBlock();
310 $this->rc_cache
= array();
311 $ret .= "<h4>{$date}</h4>\n";
312 $this->lastdate
= $date;
315 # Should patrol-related stuff be shown?
316 if( $this->usePatrol() ) {
317 $rc->unpatrolled
= !$rc_patrolled;
319 $rc->unpatrolled
= false;
323 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
324 $msg = ( $rc_type == RC_MOVE
) ?
"1movedto2" : "1movedto2_redir";
325 $clink = wfMsg( $msg, Linker
::makeKnownLinkObj( $rc->getTitle(), '', 'redirect=no' ),
326 Linker
::makeKnownLinkObj( $rc->getMovedToTitle(), '' ) );
327 } elseif( $rc_namespace == NS_SPECIAL
) {
328 list( $specialName, $logtype ) = SpecialPage
::resolveAliasWithSubpage( $rc_title );
329 if ( $specialName == 'Log' ) {
331 $logname = LogPage
::logName( $logtype );
332 $clink = '(' . Linker
::makeKnownLinkObj( $rc->getTitle(), $logname ) . ')';
334 wfDebug( "Unexpected special page in recentchanges\n" );
337 } elseif( $rc->unpatrolled
&& $rc_type == RC_NEW
) {
338 # Unpatrolled new page, give rc_id in query
339 $clink = Linker
::makeKnownLinkObj( $rc->getTitle(), '', "rcid={$rc_id}" );
341 $clink = Linker
::makeKnownLinkObj( $rc->getTitle(), '' );
344 $time = $wgContLang->time( $rc_timestamp, true, true );
345 $rc->watched
= $watched;
347 $rc->timestamp
= $time;
348 $rc->numberofWatchingusers
= $baseRC->numberofWatchingusers
;
350 # Make "cur" and "diff" links
351 if( $rc->unpatrolled
) {
352 $rcIdQuery = "&rcid={$rc_id}";
356 $querycur = $curIdEq."&diff=0&oldid=$rc_this_oldid";
357 $querydiff = $curIdEq."&diff=$rc_this_oldid&oldid=$rc_last_oldid$rcIdQuery";
358 $aprops = ' tabindex="'.$baseRC->counter
.'"';
359 $curLink = Linker
::makeKnownLinkObj( $rc->getTitle(), $this->message
['cur'], $querycur, '' ,'', $aprops );
360 if( $rc_type == RC_NEW ||
$rc_type == RC_LOG ||
$rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
361 if( $rc_type != RC_NEW
) {
362 $curLink = $this->message
['cur'];
364 $diffLink = $this->message
['diff'];
366 $diffLink = Linker
::makeKnownLinkObj( $rc->getTitle(), $this->message
['diff'], $querydiff, '' ,'', $aprops );
370 if( $rc_last_oldid == 0 ||
$rc_type == RC_LOG ||
$rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
371 $lastLink = $this->message
['last'];
373 $lastLink = Linker
::makeKnownLinkObj( $rc->getTitle(), $this->message
['last'],
374 $curIdEq.'&diff='.$rc_this_oldid.'&oldid='.$rc_last_oldid . $rcIdQuery );
377 $rc->userlink
= Linker
::userLink( $rc_user, $rc_user_text );
379 $rc->lastlink
= $lastLink;
380 $rc->curlink
= $curLink;
381 $rc->difflink
= $diffLink;
383 $rc->usertalklink
= Linker
::userToolLinks( $rc_user, $rc_user_text );
385 # Put accumulated information into the cache, for later display
386 # Page moves go on their own line
387 $title = $rc->getTitle();
388 $secureName = $title->getPrefixedDBkey();
389 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
390 # Use an @ character to prevent collision with page names
391 $this->rc_cache
['@@' . ($this->rcMoveIndex++
)] = array($rc);
393 if( !isset ( $this->rc_cache
[$secureName] ) ) {
394 $this->rc_cache
[$secureName] = array();
396 array_push( $this->rc_cache
[$secureName], $rc );
404 function recentChangesBlockGroup( $block ) {
408 # Collate list of users
410 $unpatrolled = false;
411 $userlinks = array();
412 foreach( $block as $rcObj ) {
413 $oldid = $rcObj->mAttribs
['rc_last_oldid'];
414 $newid = $rcObj->mAttribs
['rc_this_oldid'];
415 if( $rcObj->mAttribs
['rc_new'] ) {
418 $u = $rcObj->userlink
;
419 if( !isset( $userlinks[$u] ) ) {
422 if( $rcObj->unpatrolled
) {
425 $bot = $rcObj->mAttribs
['rc_bot'];
429 # Sort the list and convert to text
430 krsort( $userlinks );
433 foreach( $userlinks as $userlink => $count) {
435 $text .= $wgContLang->getDirMark();
437 $text .= ' ('.$count.'×)';
439 array_push( $users, $text );
442 $users = ' <span class="changedby">['.implode('; ',$users).']</span>';
445 $rci = 'RCI'.$this->rcCacheIndex
;
446 $rcl = 'RCL'.$this->rcCacheIndex
;
447 $rcm = 'RCM'.$this->rcCacheIndex
;
448 $toggleLink = "javascript:toggleVisibility('$rci','$rcm','$rcl')";
449 $tl = '<span id="'.$rcm.'"><a href="'.$toggleLink.'">' . $this->sideArrow() . '</a></span>';
450 $tl .= '<span id="'.$rcl.'" style="display:none"><a href="'.$toggleLink.'">' . $this->downArrow() . '</a></span>';
455 $r .= $this->recentChangesFlags( $isnew, false, $unpatrolled, ' ', $bot );
458 $r .= ' '.$block[0]->timestamp
.' ';
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).' ';
471 $r .= $this->message
['changes'];
473 $r .= Linker
::makeKnownLinkObj( $block[0]->getTitle(),
474 $this->message
['changes'], $curIdEq."&diff=$currentRevision&oldid=$oldid" );
479 $r .= Linker
::makeKnownLinkObj( $block[0]->getTitle(),
480 $this->message
['history'], $curIdEq.'&action=history' );
486 if($block[0]->numberofWatchingusers
> 0) {
488 $r .= wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($block[0]->numberofWatchingusers
));
493 $r .= '<div id="'.$rci.'" style="display:none">';
494 foreach( $block as $rcObj ) {
495 # Get rc_xxxx variables
496 extract( $rcObj->mAttribs
);
498 $r .= $this->spacerArrow();
499 $r .= '<tt> ';
500 $r .= $this->recentChangesFlags( $rc_new, $rc_minor, $rcObj->unpatrolled
, ' ', $rc_bot );
504 if( $rc_this_oldid != 0 ) {
505 $o = 'oldid='.$rc_this_oldid;
507 if( $rc_type == RC_LOG
) {
508 $link = $rcObj->timestamp
;
510 $link = Linker
::makeKnownLinkObj( $rcObj->getTitle(), $rcObj->timestamp
, $curIdEq.'&'.$o );
512 $link = '<tt>'.$link.'</tt>';
516 $r .= $rcObj->curlink
;
518 $r .= $rcObj->lastlink
;
519 $r .= ') . . '.$rcObj->userlink
;
520 $r .= $rcObj->usertalklink
;
521 $r .= Linker
::commentBlock( $rc_comment, $rcObj->getTitle() );
526 $this->rcCacheIndex++
;
530 function maybeWatchedLink( $link, $watched=false ) {
532 // FIXME: css style might be more appropriate
533 return '<strong>' . $link . '</strong>';
540 * Generate HTML for an arrow or placeholder graphic
541 * @param string $dir one of '', 'd', 'l', 'r'
542 * @param string $alt text
543 * @return string HTML <img> tag
546 function arrow( $dir, $alt='' ) {
548 $encUrl = htmlspecialchars( $wgStylePath . '/common/images/Arr_' . $dir . '.png' );
549 $encAlt = htmlspecialchars( $alt );
550 return "<img src=\"$encUrl\" width=\"12\" height=\"12\" alt=\"$encAlt\" />";
554 * Generate HTML for a right- or left-facing arrow,
555 * depending on language direction.
556 * @return string HTML <img> tag
559 function sideArrow() {
561 $dir = $wgContLang->isRTL() ?
'l' : 'r';
562 return $this->arrow( $dir, '+' );
566 * Generate HTML for a down-facing arrow
567 * depending on language direction.
568 * @return string HTML <img> tag
571 function downArrow() {
572 return $this->arrow( 'd', '-' );
576 * Generate HTML for a spacer image
577 * @return string HTML <img> tag
580 function spacerArrow() {
581 return $this->arrow( '', ' ' );
585 * Enhanced RC ungrouped line.
586 * @return string a HTML formated line (generated using $r)
588 function recentChangesBlockLine( $rcObj ) {
591 # Get rc_xxxx variables
592 extract( $rcObj->mAttribs
);
593 $curIdEq = 'curid='.$rc_cur_id;
598 $r .= $this->spacerArrow();
603 if( $rc_type == RC_MOVE ||
$rc_type == RC_MOVE_OVER_REDIRECT
) {
604 $r .= ' ';
606 $r .= $this->recentChangesFlags( $rc_type == RC_NEW
, $rc_minor, $rcObj->unpatrolled
, ' ', $rc_bot );
608 $r .= ' '.$rcObj->timestamp
.' </tt>';
611 $r .= $this->maybeWatchedLink( $rcObj->link
, $rcObj->watched
);
614 $r .= ' ('. $rcObj->difflink
.'; ';
617 $r .= Linker
::makeKnownLinkObj( $rcObj->getTitle(), wfMsg( 'hist' ), $curIdEq.'&action=history' );
620 $r .= ') . . '.$rcObj->userlink
. $rcObj->usertalklink
;
623 if( $rc_type != RC_MOVE
&& $rc_type != RC_MOVE_OVER_REDIRECT
) {
624 $r .= Linker
::commentBlock( $rc_comment, $rcObj->getTitle() );
627 if( $rcObj->numberofWatchingusers
> 0 ) {
628 $r .= wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($rcObj->numberofWatchingusers
));
636 * If enhanced RC is in use, this function takes the previously cached
637 * RC lines, arranges them, and outputs the HTML
639 function recentChangesBlock() {
640 if( count ( $this->rc_cache
) == 0 ) {
644 foreach( $this->rc_cache
as $secureName => $block ) {
645 if( count( $block ) < 2 ) {
646 $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) );
648 $blockOut .= $this->recentChangesBlockGroup( $block );
652 return '<div>'.$blockOut.'</div>';
656 * Returns text for the end of RC
657 * If enhanced RC is in use, returns pretty much all the text
659 function endRecentChangesList() {
660 return $this->recentChangesBlock() . parent
::endRecentChangesList();