Do some html-escaping
[lhc/web/wiklou.git] / includes / ChangesList.php
1 <?php
2 /**
3 * @package MediaWiki
4 * Contain class to show various lists of change:
5 * - what's link here
6 * - related changes
7 * - recent changes
8 */
9
10 require_once("RecentChange.php");
11 /**
12 * @todo document
13 * @package MediaWiki
14 */
15 class RCCacheEntry extends RecentChange
16 {
17 var $secureName, $link;
18 var $curlink , $difflink, $lastlink , $usertalklink , $versionlink ;
19 var $userlink, $timestamp, $watched;
20
21 function newFromParent( $rc )
22 {
23 $rc2 = new RCCacheEntry;
24 $rc2->mAttribs = $rc->mAttribs;
25 $rc2->mExtra = $rc->mExtra;
26 return $rc2;
27 }
28 } ;
29
30 /**
31 * @package MediaWiki
32 */
33 class ChangesList {
34 # Called by history lists and recent changes
35 #
36
37 /** @todo document */
38 function ChangesList( &$skin ) {
39 $this->skin =& $skin;
40 $this->preCacheMessages();
41 }
42
43 function newFromUser( &$user ) {
44 $sk =& $user->getSkin();
45 if( $user->getOption('usenewrc') ) {
46 return new EnhancedChangesList( $sk );
47 } else {
48 return new OldChangesList( $sk );
49 }
50 }
51
52 /**
53 * As we use the same small set of messages in various methods and that
54 * they are called often, we call them once and save them in $this->message
55 */
56 function preCacheMessages() {
57 // Precache various messages
58 if( !isset( $this->message ) ) {
59 foreach( explode(' ', 'cur diff hist minoreditletter newpageletter last '.
60 'blocklink changes history' ) as $msg ) {
61 $this->message[$msg] = wfMsgExt( $msg, array( 'escape') );
62 }
63 }
64 }
65
66
67 /**
68 * Returns the appropiate flags for new page, minor change and patrolling
69 */
70 function recentChangesFlags( $new, $minor, $patrolled, $nothing = '&nbsp;' ) {
71 $f = $new ? '<span class="newpage">' . $this->message['newpageletter'] . '</span>'
72 : $nothing;
73 $f .= $minor ? '<span class="minor">' . $this->message['minoreditletter'] . '</span>'
74 : $nothing;
75 $f .= $patrolled ? '<span class="unpatrolled">!</span>' : $nothing;
76 return $f;
77 }
78
79 /**
80 * Returns text for the start of the tabular part of RC
81 */
82 function beginRecentChangesList() {
83 $this->rc_cache = array();
84 $this->rcMoveIndex = 0;
85 $this->rcCacheIndex = 0;
86 $this->lastdate = '';
87 $this->rclistOpen = false;
88 return '';
89 }
90
91 /**
92 * Returns text for the end of RC
93 */
94 function endRecentChangesList() {
95 if( $this->rclistOpen ) {
96 return "</ul>\n";
97 } else {
98 return '';
99 }
100 }
101
102
103 function insertMove( &$s, $rc ) {
104 # Diff
105 $s .= '(' . $this->message['diff'] . ') (';
106 # Hist
107 $s .= $this->skin->makeKnownLinkObj( $rc->getMovedToTitle(), $this->message['hist'], 'action=history' ) .
108 ') . . ';
109
110 # "[[x]] moved to [[y]]"
111 $msg = ( $rc->mAttribs['rc_type'] == RC_MOVE ) ? '1movedto2' : '1movedto2_redir';
112 $s .= wfMsg( $msg, $this->skin->makeKnownLinkObj( $rc->getTitle(), '', 'redirect=no' ),
113 $this->skin->makeKnownLinkObj( $rc->getMovedToTitle(), '' ) );
114 }
115
116 function insertDateHeader(&$s, $rc_timestamp) {
117 global $wgLang;
118
119 # Make date header if necessary
120 $date = $wgLang->date( $rc_timestamp, true, true );
121 $s = '';
122 if( $date != $this->lastdate ) {
123 if( '' != $this->lastdate ) {
124 $s .= "</ul>\n";
125 }
126 $s .= '<h4>'.$date."</h4>\n<ul class=\"special\">";
127 $this->lastdate = $date;
128 $this->rclistOpen = true;
129 }
130 }
131
132 function insertLog(&$s, $title, $logtype) {
133 $logname = LogPage::logName( $logtype );
134 $s .= '(' . $this->skin->makeKnownLinkObj($title, $logname ) . ')';
135 }
136
137
138 function insertDiffHist(&$s, &$rc, $unpatrolled) {
139 # Diff link
140 if( $rc->mAttribs['rc_type'] == RC_NEW || $rc->mAttribs['rc_type'] == RC_LOG ) {
141 $diffLink = $this->message['diff'];
142 } else {
143 $rcidparam = $unpatrolled
144 ? array( 'rcid' => $rc->mAttribs['rc_id'] )
145 : array();
146 $diffLink = $this->skin->makeKnownLinkObj( $rc->getTitle(), $this->message['diff'],
147 wfArrayToCGI( array(
148 'curid' => $rc->mAttribs['rc_cur_id'],
149 'diff' => $rc->mAttribs['rc_this_oldid'],
150 'oldid' => $rc->mAttribs['rc_last_oldid'] ),
151 $rcidparam ),
152 '', '', ' tabindex="'.$rc->counter.'"');
153 }
154 $s .= '('.$diffLink.') (';
155
156 # History link
157 $s .= $this->skin->makeKnownLinkObj( $rc->getTitle(), $this->message['hist'],
158 wfArrayToCGI( array(
159 'curid' => $rc->mAttribs['rc_cur_id'],
160 'action' => 'history' ) ) );
161 $s .= ') . . ';
162 }
163
164 function insertArticleLink(&$s, &$rc, $unpatrolled, $watched) {
165 # Article link
166 # If it's a new article, there is no diff link, but if it hasn't been
167 # patrolled yet, we need to give users a way to do so
168 $params = ( $unpatrolled && $rc->mAttribs['rc_type'] == RC_NEW )
169 ? 'rcid='.$rc->mAttribs['rc_id']
170 : '';
171 $articlelink = ' '. $this->skin->makeKnownLinkObj( $rc->getTitle(), '', $params );
172 if($watched) $articlelink = '<strong>'.$articlelink.'</strong>';
173
174 $s .= ' '.$articlelink;
175 }
176
177 function insertTimestamp(&$s, &$rc) {
178 global $wgLang;
179 # Timestamp
180 $s .= '; ' . $wgLang->time( $rc->mAttribs['rc_timestamp'], true, true ) . ' . . ';
181 }
182
183 /** Insert links to user page, user talk page and eventually a blocking link */
184 function insertUserRelatedLinks(&$s, &$rc) {
185 $s .= $this->skin->userLink( $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'] );
186 $s .= $this->skin->userToolLinks( $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'] );
187 }
188
189 /** insert a formatted comment */
190 function insertComment(&$s, &$rc) {
191 # Add comment
192 if( $rc->mAttribs['rc_type'] != RC_MOVE && $rc->mAttribs['rc_type'] != RC_MOVE_OVER_REDIRECT ) {
193 $s .= $this->skin->commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle() );
194 }
195 }
196
197 /**
198 * Check whether to enable recent changes patrol features
199 * @return bool
200 */
201 function usePatrol() {
202 global $wgUseRCPatrol, $wgUser;
203 return( $wgUseRCPatrol && $wgUser->isAllowed( 'patrol' ) );
204 }
205
206
207 }
208
209
210 /**
211 * Generate a list of changes using the good old system (no javascript)
212 */
213 class OldChangesList extends ChangesList {
214 /**
215 * Format a line using the old system (aka without any javascript).
216 */
217 function recentChangesLine( &$rc, $watched = false ) {
218 global $wgContLang;
219
220 $fname = 'ChangesList::recentChangesLineOld';
221 wfProfileIn( $fname );
222
223
224 # Extract DB fields into local scope
225 extract( $rc->mAttribs );
226 $curIdEq = 'curid=' . $rc_cur_id;
227
228 # Should patrol-related stuff be shown?
229 $unpatrolled = $this->usePatrol() && $rc_patrolled == 0;
230
231 $this->insertDateHeader($s,$rc_timestamp);
232
233 $s .= '<li>';
234
235 // moved pages
236 if( $rc_type == RC_MOVE || $rc_type == RC_MOVE_OVER_REDIRECT ) {
237 $this->insertMove( $s, $rc );
238 // log entries
239 } elseif( $rc_namespace == NS_SPECIAL && preg_match( '!^Log/(.*)$!', $rc_title, $matches ) ) {
240 $this->insertLog($s, $rc->getTitle(), $matches[1]);
241 // all other stuff
242 } else {
243 wfProfileIn($fname.'-page');
244
245 $this->insertDiffHist($s, $rc, $unpatrolled);
246
247 # M, N and ! (minor, new and unpatrolled)
248 $s .= ' ' . $this->recentChangesFlags( $rc_type == RC_NEW, $rc_minor, $unpatrolled, '' );
249 $this->insertArticleLink($s, $rc, $unpatrolled, $watched);
250
251 wfProfileOut($fname.'-page');
252 }
253
254 wfProfileIn( $fname.'-rest' );
255
256 $this->insertTimestamp($s,$rc);
257 $this->insertUserRelatedLinks($s,$rc);
258 $this->insertComment($s, $rc);
259
260 if($rc->numberofWatchingusers > 0) {
261 $s .= ' ' . wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($rc->numberofWatchingusers));
262 }
263
264 $s .= "</li>\n";
265
266 wfProfileOut( $fname.'-rest' );
267
268 wfProfileOut( $fname );
269 return $s;
270 }
271 }
272
273
274 /**
275 * Generate a list of changes using an Enhanced system (use javascript).
276 */
277 class EnhancedChangesList extends ChangesList {
278 /**
279 * Format a line for enhanced recentchange (aka with javascript and block of lines).
280 */
281 function recentChangesLine( &$baseRC, $watched = false ) {
282 global $wgLang, $wgContLang;
283
284 # Create a specialised object
285 $rc = RCCacheEntry::newFromParent( $baseRC );
286
287 # Extract fields from DB into the function scope (rc_xxxx variables)
288 extract( $rc->mAttribs );
289 $curIdEq = 'curid=' . $rc_cur_id;
290
291 # If it's a new day, add the headline and flush the cache
292 $date = $wgLang->date( $rc_timestamp, true);
293 $ret = '';
294 if( $date != $this->lastdate ) {
295 # Process current cache
296 $ret = $this->recentChangesBlock();
297 $this->rc_cache = array();
298 $ret .= "<h4>{$date}</h4>\n";
299 $this->lastdate = $date;
300 }
301
302 # Should patrol-related stuff be shown?
303 if( $this->usePatrol() ) {
304 $rc->unpatrolled = !$rc_patrolled;
305 } else {
306 $rc->unpatrolled = false;
307 }
308
309 # Make article link
310 if( $rc_type == RC_MOVE || $rc_type == RC_MOVE_OVER_REDIRECT ) {
311 $msg = ( $rc_type == RC_MOVE ) ? "1movedto2" : "1movedto2_redir";
312 $clink = wfMsg( $msg, $this->skin->makeKnownLinkObj( $rc->getTitle(), '', 'redirect=no' ),
313 $this->skin->makeKnownLinkObj( $rc->getMovedToTitle(), '' ) );
314 } elseif( $rc_namespace == NS_SPECIAL && preg_match( '!^Log/(.*)$!', $rc_title, $matches ) ) {
315 # Log updates, etc
316 $logtype = $matches[1];
317 $logname = LogPage::logName( $logtype );
318 $clink = '(' . $this->skin->makeKnownLinkObj( $rc->getTitle(), $logname ) . ')';
319 } elseif( $rc->unpatrolled && $rc_type == RC_NEW ) {
320 # Unpatrolled new page, give rc_id in query
321 $clink = $this->skin->makeKnownLinkObj( $rc->getTitle(), '', "rcid={$rc_id}" );
322 } else {
323 $clink = $this->skin->makeKnownLinkObj( $rc->getTitle(), '' );
324 }
325
326 $time = $wgContLang->time( $rc_timestamp, true, true );
327 $rc->watched = $watched;
328 $rc->link = $clink;
329 $rc->timestamp = $time;
330 $rc->numberofWatchingusers = $baseRC->numberofWatchingusers;
331
332 # Make "cur" and "diff" links
333 $titleObj = $rc->getTitle();
334 if( $rc->unpatrolled ) {
335 $rcIdQuery = "&rcid={$rc_id}";
336 } else {
337 $rcIdQuery = '';
338 }
339 $querycur = $curIdEq."&diff=0&oldid=$rc_this_oldid";
340 $querydiff = $curIdEq."&diff=$rc_this_oldid&oldid=$rc_last_oldid$rcIdQuery";
341 $aprops = ' tabindex="'.$baseRC->counter.'"';
342 $curLink = $this->skin->makeKnownLinkObj( $rc->getTitle(), $this->message['cur'], $querycur, '' ,'', $aprops );
343 if( $rc_type == RC_NEW || $rc_type == RC_LOG || $rc_type == RC_MOVE || $rc_type == RC_MOVE_OVER_REDIRECT ) {
344 if( $rc_type != RC_NEW ) {
345 $curLink = $this->message['cur'];
346 }
347 $diffLink = $this->message['diff'];
348 } else {
349 $diffLink = $this->skin->makeKnownLinkObj( $rc->getTitle(), $this->message['diff'], $querydiff, '' ,'', $aprops );
350 }
351
352 # Make "last" link
353 if( $rc_last_oldid == 0 || $rc_type == RC_LOG || $rc_type == RC_MOVE || $rc_type == RC_MOVE_OVER_REDIRECT ) {
354 $lastLink = $this->message['last'];
355 } else {
356 $lastLink = $this->skin->makeKnownLinkObj( $rc->getTitle(), $this->message['last'],
357 $curIdEq.'&diff='.$rc_this_oldid.'&oldid='.$rc_last_oldid . $rcIdQuery );
358 }
359
360 $rc->userlink = $this->skin->userLink( $rc_user, $rc_user_text );
361
362 $rc->lastlink = $lastLink;
363 $rc->curlink = $curLink;
364 $rc->difflink = $diffLink;
365
366 $rc->usertalklink = $this->skin->userToolLinks( $rc_user, $rc_user_text );
367
368 # Put accumulated information into the cache, for later display
369 # Page moves go on their own line
370 $title = $rc->getTitle();
371 $secureName = $title->getPrefixedDBkey();
372 if( $rc_type == RC_MOVE || $rc_type == RC_MOVE_OVER_REDIRECT ) {
373 # Use an @ character to prevent collision with page names
374 $this->rc_cache['@@' . ($this->rcMoveIndex++)] = array($rc);
375 } else {
376 if( !isset ( $this->rc_cache[$secureName] ) ) {
377 $this->rc_cache[$secureName] = array();
378 }
379 array_push( $this->rc_cache[$secureName], $rc );
380 }
381 return $ret;
382 }
383
384 /**
385 * Enhanced RC group
386 */
387 function recentChangesBlockGroup( $block ) {
388 $r = '';
389
390 # Collate list of users
391 $isnew = false;
392 $unpatrolled = false;
393 $userlinks = array();
394 foreach( $block as $rcObj ) {
395 $oldid = $rcObj->mAttribs['rc_last_oldid'];
396 $newid = $rcObj->mAttribs['rc_this_oldid'];
397 if( $rcObj->mAttribs['rc_new'] ) {
398 $isnew = true;
399 }
400 $u = $rcObj->userlink;
401 if( !isset( $userlinks[$u] ) ) {
402 $userlinks[$u] = 0;
403 }
404 if( $rcObj->unpatrolled ) {
405 $unpatrolled = true;
406 }
407 $userlinks[$u]++;
408 }
409
410 # Sort the list and convert to text
411 krsort( $userlinks );
412 asort( $userlinks );
413 $users = array();
414 foreach( $userlinks as $userlink => $count) {
415 $text = $userlink;
416 if( $count > 1 ) {
417 $text .= ' ('.$count.'&times;)';
418 }
419 array_push( $users, $text );
420 }
421
422 $users = ' <span class="changedby">['.implode('; ',$users).']</span>';
423
424 # Arrow
425 $rci = 'RCI'.$this->rcCacheIndex;
426 $rcl = 'RCL'.$this->rcCacheIndex;
427 $rcm = 'RCM'.$this->rcCacheIndex;
428 $toggleLink = "javascript:toggleVisibility('$rci','$rcm','$rcl')";
429 $tl = '<span id="'.$rcm.'"><a href="'.$toggleLink.'">' . $this->sideArrow() . '</a></span>';
430 $tl .= '<span id="'.$rcl.'" style="display:none"><a href="'.$toggleLink.'">' . $this->downArrow() . '</a></span>';
431 $r .= $tl;
432
433 # Main line
434 $r .= '<tt>';
435 $r .= $this->recentChangesFlags( $isnew, false, $unpatrolled );
436
437 # Timestamp
438 $r .= ' '.$block[0]->timestamp.' ';
439 $r .= '</tt>';
440
441 # Article link
442 $r .= $this->maybeWatchedLink( $block[0]->link, $block[0]->watched );
443
444 $curIdEq = 'curid=' . $block[0]->mAttribs['rc_cur_id'];
445 $currentRevision = $block[0]->mAttribs['rc_this_oldid'];
446 if( $block[0]->mAttribs['rc_type'] != RC_LOG ) {
447 # Changes
448 $r .= ' ('.count($block).' ';
449 if( $isnew ) {
450 $r .= $this->message['changes'];
451 } else {
452 $r .= $this->skin->makeKnownLinkObj( $block[0]->getTitle(),
453 $this->message['changes'], $curIdEq."&diff=$currentRevision&oldid=$oldid" );
454 }
455 $r .= '; ';
456
457 # History
458 $r .= $this->skin->makeKnownLinkObj( $block[0]->getTitle(),
459 $this->message['history'], $curIdEq.'&action=history' );
460 $r .= ')';
461 }
462
463 $r .= $users;
464
465 if($block[0]->numberofWatchingusers > 0) {
466 global $wgContLang;
467 $r .= wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($block[0]->numberofWatchingusers));
468 }
469 $r .= "<br />\n";
470
471 # Sub-entries
472 $r .= '<div id="'.$rci.'" style="display:none">';
473 foreach( $block as $rcObj ) {
474 # Get rc_xxxx variables
475 extract( $rcObj->mAttribs );
476
477 $r .= $this->spacerArrow();
478 $r .= '<tt>&nbsp; &nbsp; &nbsp; &nbsp;';
479 $r .= $this->recentChangesFlags( $rc_new, $rc_minor, $rcObj->unpatrolled );
480 $r .= '&nbsp;</tt>';
481
482 $o = '';
483 if( $rc_this_oldid != 0 ) {
484 $o = 'oldid='.$rc_this_oldid;
485 }
486 if( $rc_type == RC_LOG ) {
487 $link = $rcObj->timestamp;
488 } else {
489 $link = $this->skin->makeKnownLinkObj( $rcObj->getTitle(), $rcObj->timestamp, $curIdEq.'&'.$o );
490 }
491 $link = '<tt>'.$link.'</tt>';
492
493 $r .= $link;
494 $r .= ' (';
495 $r .= $rcObj->curlink;
496 $r .= '; ';
497 $r .= $rcObj->lastlink;
498 $r .= ') . . '.$rcObj->userlink;
499 $r .= $rcObj->usertalklink;
500 $r .= $this->skin->commentBlock( $rc_comment, $rcObj->getTitle() );
501 $r .= "<br />\n";
502 }
503 $r .= "</div>\n";
504
505 $this->rcCacheIndex++;
506 return $r;
507 }
508
509 function maybeWatchedLink( $link, $watched=false ) {
510 if( $watched ) {
511 // FIXME: css style might be more appropriate
512 return '<strong>' . $link . '</strong>';
513 } else {
514 return $link;
515 }
516 }
517
518 /**
519 * Generate HTML for an arrow or placeholder graphic
520 * @param string $dir one of '', 'd', 'l', 'r'
521 * @param string $alt text
522 * @return string HTML <img> tag
523 * @access private
524 */
525 function arrow( $dir, $alt='' ) {
526 global $wgStylePath;
527 $encUrl = htmlspecialchars( $wgStylePath . '/common/images/Arr_' . $dir . '.png' );
528 $encAlt = htmlspecialchars( $alt );
529 return "<img src=\"$encUrl\" width=\"12\" height=\"12\" alt=\"$encAlt\" />";
530 }
531
532 /**
533 * Generate HTML for a right- or left-facing arrow,
534 * depending on language direction.
535 * @return string HTML <img> tag
536 * @access private
537 */
538 function sideArrow() {
539 global $wgContLang;
540 $dir = $wgContLang->isRTL() ? 'l' : 'r';
541 return $this->arrow( $dir, '+' );
542 }
543
544 /**
545 * Generate HTML for a down-facing arrow
546 * depending on language direction.
547 * @return string HTML <img> tag
548 * @access private
549 */
550 function downArrow() {
551 return $this->arrow( 'd', '-' );
552 }
553
554 /**
555 * Generate HTML for a spacer image
556 * @return string HTML <img> tag
557 * @access private
558 */
559 function spacerArrow() {
560 return $this->arrow( '', ' ' );
561 }
562
563 /**
564 * Enhanced RC ungrouped line.
565 * @return string a HTML formated line (generated using $r)
566 */
567 function recentChangesBlockLine( $rcObj ) {
568 global $wgContLang;
569
570 # Get rc_xxxx variables
571 extract( $rcObj->mAttribs );
572 $curIdEq = 'curid='.$rc_cur_id;
573
574 $r = '';
575
576 # Spacer image
577 $r .= $this->spacerArrow();
578
579 # Flag and Timestamp
580 $r .= '<tt>';
581
582 if( $rc_type == RC_MOVE || $rc_type == RC_MOVE_OVER_REDIRECT ) {
583 $r .= '&nbsp;&nbsp;&nbsp;';
584 } else {
585 $r .= $this->recentChangesFlags( $rc_type == RC_NEW, $rc_minor, $rcObj->unpatrolled );
586 }
587 $r .= ' '.$rcObj->timestamp.' </tt>';
588
589 # Article link
590 $r .= $this->maybeWatchedLink( $rcObj->link, $rcObj->watched );
591
592 # Diff
593 $r .= ' ('. $rcObj->difflink .'; ';
594
595 # Hist
596 $r .= $this->skin->makeKnownLinkObj( $rcObj->getTitle(), wfMsg( 'hist' ), $curIdEq.'&action=history' );
597
598 # User/talk
599 $r .= ') . . '.$rcObj->userlink . $rcObj->usertalklink;
600
601 # Comment
602 if( $rc_type != RC_MOVE && $rc_type != RC_MOVE_OVER_REDIRECT ) {
603 $r .= $this->skin->commentBlock( $rc_comment, $rcObj->getTitle() );
604 }
605
606 if( $rcObj->numberofWatchingusers > 0 ) {
607 $r .= wfMsg('number_of_watching_users_RCview', $wgContLang->formatNum($rcObj->numberofWatchingusers));
608 }
609
610 $r .= "<br />\n";
611 return $r;
612 }
613
614 /**
615 * If enhanced RC is in use, this function takes the previously cached
616 * RC lines, arranges them, and outputs the HTML
617 */
618 function recentChangesBlock() {
619 if( count ( $this->rc_cache ) == 0 ) {
620 return '';
621 }
622 $blockOut = '';
623 foreach( $this->rc_cache as $secureName => $block ) {
624 if( count( $block ) < 2 ) {
625 $blockOut .= $this->recentChangesBlockLine( array_shift( $block ) );
626 } else {
627 $blockOut .= $this->recentChangesBlockGroup( $block );
628 }
629 }
630
631 return '<div>'.$blockOut.'</div>';
632 }
633
634 /**
635 * Returns text for the end of RC
636 * If enhanced RC is in use, returns pretty much all the text
637 */
638 function endRecentChangesList() {
639 return $this->recentChangesBlock() . parent::endRecentChangesList();
640 }
641
642 }
643 ?>