Merge "Added Id to the input box"
[lhc/web/wiklou.git] / includes / changes / ChangesList.php
1 <?php
2 /**
3 * Base class for all changes lists.
4 *
5 * The class is used for formatting recent changes, related changes and watchlist.
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
21 *
22 * @file
23 */
24 use MediaWiki\Linker\LinkRenderer;
25 use MediaWiki\MediaWikiServices;
26 use Wikimedia\Rdbms\ResultWrapper;
27
28 class ChangesList extends ContextSource {
29 const CSS_CLASS_PREFIX = 'mw-changeslist-';
30
31 /**
32 * @var Skin
33 */
34 public $skin;
35
36 protected $watchlist = false;
37 protected $lastdate;
38 protected $message;
39 protected $rc_cache;
40 protected $rcCacheIndex;
41 protected $rclistOpen;
42 protected $rcMoveIndex;
43
44 /** @var callable */
45 protected $changeLinePrefixer;
46
47 /** @var MapCacheLRU */
48 protected $watchMsgCache;
49
50 /**
51 * @var LinkRenderer
52 */
53 protected $linkRenderer;
54
55 /**
56 * @var array
57 */
58 protected $filterGroups;
59
60 /**
61 * @param Skin|IContextSource $obj
62 * @param array $filterGroups Array of ChangesListFilterGroup objects (currently optional)
63 */
64 public function __construct( $obj, array $filterGroups = [] ) {
65 if ( $obj instanceof IContextSource ) {
66 $this->setContext( $obj );
67 $this->skin = $obj->getSkin();
68 } else {
69 $this->setContext( $obj->getContext() );
70 $this->skin = $obj;
71 }
72 $this->preCacheMessages();
73 $this->watchMsgCache = new MapCacheLRU( 50 );
74 $this->linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
75 $this->filterGroups = $filterGroups;
76 }
77
78 /**
79 * Fetch an appropriate changes list class for the specified context
80 * Some users might want to use an enhanced list format, for instance
81 *
82 * @param IContextSource $context
83 * @param array $groups Array of ChangesListFilterGroup objects (currently optional)
84 * @return ChangesList
85 */
86 public static function newFromContext( IContextSource $context, array $groups = [] ) {
87 $user = $context->getUser();
88 $sk = $context->getSkin();
89 $list = null;
90 if ( Hooks::run( 'FetchChangesList', [ $user, &$sk, &$list ] ) ) {
91 $new = $context->getRequest()->getBool( 'enhanced', $user->getOption( 'usenewrc' ) );
92
93 return $new ?
94 new EnhancedChangesList( $context, $groups ) :
95 new OldChangesList( $context, $groups );
96 } else {
97 return $list;
98 }
99 }
100
101 /**
102 * Format a line
103 *
104 * @since 1.27
105 *
106 * @param RecentChange &$rc Passed by reference
107 * @param bool $watched (default false)
108 * @param int|null $linenumber (default null)
109 *
110 * @return string|bool
111 */
112 public function recentChangesLine( &$rc, $watched = false, $linenumber = null ) {
113 throw new RuntimeException( 'recentChangesLine should be implemented' );
114 }
115
116 /**
117 * Get the container for highlights that are used in the new StructuredFilters
118 * system
119 *
120 * @return string HTML structure of the highlight container div
121 */
122 protected function getHighlightsContainerDiv() {
123 $highlightColorDivs = '';
124 foreach ( [ 'none', 'c1', 'c2', 'c3', 'c4', 'c5' ] as $color ) {
125 $highlightColorDivs .= Html::rawElement(
126 'div',
127 [
128 'class' => 'mw-rcfilters-ui-highlights-color-' . $color,
129 'data-color' => $color
130 ]
131 );
132 }
133
134 return Html::rawElement(
135 'div',
136 [ 'class' => 'mw-rcfilters-ui-highlights' ],
137 $highlightColorDivs
138 );
139 }
140
141 /**
142 * Sets the list to use a "<li class='watchlist-(namespace)-(page)'>" tag
143 * @param bool $value
144 */
145 public function setWatchlistDivs( $value = true ) {
146 $this->watchlist = $value;
147 }
148
149 /**
150 * @return bool True when setWatchlistDivs has been called
151 * @since 1.23
152 */
153 public function isWatchlist() {
154 return (bool)$this->watchlist;
155 }
156
157 /**
158 * As we use the same small set of messages in various methods and that
159 * they are called often, we call them once and save them in $this->message
160 */
161 private function preCacheMessages() {
162 if ( !isset( $this->message ) ) {
163 foreach ( [
164 'cur', 'diff', 'hist', 'enhancedrc-history', 'last', 'blocklink', 'history',
165 'semicolon-separator', 'pipe-separator' ] as $msg
166 ) {
167 $this->message[$msg] = $this->msg( $msg )->escaped();
168 }
169 }
170 }
171
172 /**
173 * Returns the appropriate flags for new page, minor change and patrolling
174 * @param array $flags Associative array of 'flag' => Bool
175 * @param string $nothing To use for empty space
176 * @return string
177 */
178 public function recentChangesFlags( $flags, $nothing = "\u{00A0}" ) {
179 $f = '';
180 foreach ( array_keys( $this->getConfig()->get( 'RecentChangesFlags' ) ) as $flag ) {
181 $f .= isset( $flags[$flag] ) && $flags[$flag]
182 ? self::flag( $flag, $this->getContext() )
183 : $nothing;
184 }
185
186 return $f;
187 }
188
189 /**
190 * Get an array of default HTML class attributes for the change.
191 *
192 * @param RecentChange|RCCacheEntry $rc
193 * @param string|bool $watched Optionally timestamp for adding watched class
194 *
195 * @return array of classes
196 */
197 protected function getHTMLClasses( $rc, $watched ) {
198 $classes = [ self::CSS_CLASS_PREFIX . 'line' ];
199 $logType = $rc->mAttribs['rc_log_type'];
200
201 if ( $logType ) {
202 $classes[] = self::CSS_CLASS_PREFIX . 'log';
203 $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'log-' . $logType );
204 } else {
205 $classes[] = self::CSS_CLASS_PREFIX . 'edit';
206 $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'ns' .
207 $rc->mAttribs['rc_namespace'] . '-' . $rc->mAttribs['rc_title'] );
208 }
209
210 // Indicate watched status on the line to allow for more
211 // comprehensive styling.
212 $classes[] = $watched && $rc->mAttribs['rc_timestamp'] >= $watched
213 ? self::CSS_CLASS_PREFIX . 'line-watched'
214 : self::CSS_CLASS_PREFIX . 'line-not-watched';
215
216 $classes = array_merge( $classes, $this->getHTMLClassesForFilters( $rc ) );
217
218 return $classes;
219 }
220
221 /**
222 * Get an array of CSS classes attributed to filters for this row. Used for highlighting
223 * in the front-end.
224 *
225 * @param RecentChange $rc
226 * @return array Array of CSS classes
227 */
228 protected function getHTMLClassesForFilters( $rc ) {
229 $classes = [];
230
231 $classes[] = Sanitizer::escapeClass( self::CSS_CLASS_PREFIX . 'ns-' .
232 $rc->mAttribs['rc_namespace'] );
233
234 if ( $this->filterGroups !== null ) {
235 foreach ( $this->filterGroups as $filterGroup ) {
236 foreach ( $filterGroup->getFilters() as $filter ) {
237 $filter->applyCssClassIfNeeded( $this, $rc, $classes );
238 }
239 }
240 }
241
242 return $classes;
243 }
244
245 /**
246 * Make an "<abbr>" element for a given change flag. The flag indicating a new page, minor edit,
247 * bot edit, or unpatrolled edit. In English it typically contains "N", "m", "b", or "!".
248 *
249 * @param string $flag One key of $wgRecentChangesFlags
250 * @param IContextSource|null $context
251 * @return string HTML
252 */
253 public static function flag( $flag, IContextSource $context = null ) {
254 static $map = [ 'minoredit' => 'minor', 'botedit' => 'bot' ];
255 static $flagInfos = null;
256
257 if ( is_null( $flagInfos ) ) {
258 global $wgRecentChangesFlags;
259 $flagInfos = [];
260 foreach ( $wgRecentChangesFlags as $key => $value ) {
261 $flagInfos[$key]['letter'] = $value['letter'];
262 $flagInfos[$key]['title'] = $value['title'];
263 // Allow customized class name, fall back to flag name
264 $flagInfos[$key]['class'] = $value['class'] ?? $key;
265 }
266 }
267
268 $context = $context ?: RequestContext::getMain();
269
270 // Inconsistent naming, kepted for b/c
271 if ( isset( $map[$flag] ) ) {
272 $flag = $map[$flag];
273 }
274
275 $info = $flagInfos[$flag];
276 return Html::element( 'abbr', [
277 'class' => $info['class'],
278 'title' => wfMessage( $info['title'] )->setContext( $context )->text(),
279 ], wfMessage( $info['letter'] )->setContext( $context )->text() );
280 }
281
282 /**
283 * Returns text for the start of the tabular part of RC
284 * @return string
285 */
286 public function beginRecentChangesList() {
287 $this->rc_cache = [];
288 $this->rcMoveIndex = 0;
289 $this->rcCacheIndex = 0;
290 $this->lastdate = '';
291 $this->rclistOpen = false;
292 $this->getOutput()->addModuleStyles( [
293 'mediawiki.interface.helpers.styles',
294 'mediawiki.special.changeslist'
295 ] );
296
297 return '<div class="mw-changeslist">';
298 }
299
300 /**
301 * @param ResultWrapper|array $rows
302 */
303 public function initChangesListRows( $rows ) {
304 Hooks::run( 'ChangesListInitRows', [ $this, $rows ] );
305 }
306
307 /**
308 * Show formatted char difference
309 *
310 * Needs the css module 'mediawiki.special.changeslist' to style output
311 *
312 * @param int $old Number of bytes
313 * @param int $new Number of bytes
314 * @param IContextSource|null $context
315 * @return string
316 */
317 public static function showCharacterDifference( $old, $new, IContextSource $context = null ) {
318 if ( !$context ) {
319 $context = RequestContext::getMain();
320 }
321
322 $new = (int)$new;
323 $old = (int)$old;
324 $szdiff = $new - $old;
325
326 $lang = $context->getLanguage();
327 $config = $context->getConfig();
328 $code = $lang->getCode();
329 static $fastCharDiff = [];
330 if ( !isset( $fastCharDiff[$code] ) ) {
331 $fastCharDiff[$code] = $config->get( 'MiserMode' )
332 || $context->msg( 'rc-change-size' )->plain() === '$1';
333 }
334
335 $formattedSize = $lang->formatNum( $szdiff );
336
337 if ( !$fastCharDiff[$code] ) {
338 $formattedSize = $context->msg( 'rc-change-size', $formattedSize )->text();
339 }
340
341 if ( abs( $szdiff ) > abs( $config->get( 'RCChangedSizeThreshold' ) ) ) {
342 $tag = 'strong';
343 } else {
344 $tag = 'span';
345 }
346
347 if ( $szdiff === 0 ) {
348 $formattedSizeClass = 'mw-plusminus-null';
349 } elseif ( $szdiff > 0 ) {
350 $formattedSize = '+' . $formattedSize;
351 $formattedSizeClass = 'mw-plusminus-pos';
352 } else {
353 $formattedSizeClass = 'mw-plusminus-neg';
354 }
355 $formattedSizeClass .= ' mw-diff-bytes';
356
357 $formattedTotalSize = $context->msg( 'rc-change-size-new' )->numParams( $new )->text();
358
359 return Html::element( $tag,
360 [ 'dir' => 'ltr', 'class' => $formattedSizeClass, 'title' => $formattedTotalSize ],
361 $formattedSize ) . $lang->getDirMark();
362 }
363
364 /**
365 * Format the character difference of one or several changes.
366 *
367 * @param RecentChange $old
368 * @param RecentChange|null $new Last change to use, if not provided, $old will be used
369 * @return string HTML fragment
370 */
371 public function formatCharacterDifference( RecentChange $old, RecentChange $new = null ) {
372 $oldlen = $old->mAttribs['rc_old_len'];
373
374 if ( $new ) {
375 $newlen = $new->mAttribs['rc_new_len'];
376 } else {
377 $newlen = $old->mAttribs['rc_new_len'];
378 }
379
380 if ( $oldlen === null || $newlen === null ) {
381 return '';
382 }
383
384 return self::showCharacterDifference( $oldlen, $newlen, $this->getContext() );
385 }
386
387 /**
388 * Returns text for the end of RC
389 * @return string
390 */
391 public function endRecentChangesList() {
392 $out = $this->rclistOpen ? "</ul>\n" : '';
393 $out .= '</div>';
394
395 return $out;
396 }
397
398 /**
399 * @param string &$s HTML to update
400 * @param mixed $rc_timestamp
401 */
402 public function insertDateHeader( &$s, $rc_timestamp ) {
403 # Make date header if necessary
404 $date = $this->getLanguage()->userDate( $rc_timestamp, $this->getUser() );
405 if ( $date != $this->lastdate ) {
406 if ( $this->lastdate != '' ) {
407 $s .= "</ul>\n";
408 }
409 $s .= Xml::element( 'h4', null, $date ) . "\n<ul class=\"special\">";
410 $this->lastdate = $date;
411 $this->rclistOpen = true;
412 }
413 }
414
415 /**
416 * @param string &$s HTML to update
417 * @param Title $title
418 * @param string $logtype
419 */
420 public function insertLog( &$s, $title, $logtype ) {
421 $page = new LogPage( $logtype );
422 $logname = $page->getName()->setContext( $this->getContext() )->text();
423 $s .= $this->msg( 'parentheses' )->rawParams(
424 $this->linkRenderer->makeKnownLink( $title, $logname )
425 )->escaped();
426 }
427
428 /**
429 * @param string &$s HTML to update
430 * @param RecentChange &$rc
431 * @param bool|null $unpatrolled Unused variable, since 1.27.
432 */
433 public function insertDiffHist( &$s, &$rc, $unpatrolled = null ) {
434 # Diff link
435 if (
436 $rc->mAttribs['rc_type'] == RC_NEW ||
437 $rc->mAttribs['rc_type'] == RC_LOG ||
438 $rc->mAttribs['rc_type'] == RC_CATEGORIZE
439 ) {
440 $diffLink = $this->message['diff'];
441 } elseif ( !self::userCan( $rc, Revision::DELETED_TEXT, $this->getUser() ) ) {
442 $diffLink = $this->message['diff'];
443 } else {
444 $query = [
445 'curid' => $rc->mAttribs['rc_cur_id'],
446 'diff' => $rc->mAttribs['rc_this_oldid'],
447 'oldid' => $rc->mAttribs['rc_last_oldid']
448 ];
449
450 $diffLink = $this->linkRenderer->makeKnownLink(
451 $rc->getTitle(),
452 new HtmlArmor( $this->message['diff'] ),
453 [ 'class' => 'mw-changeslist-diff' ],
454 $query
455 );
456 }
457 if ( $rc->mAttribs['rc_type'] == RC_CATEGORIZE ) {
458 $histLink = $this->message['hist'];
459 } else {
460 $histLink = $this->linkRenderer->makeKnownLink(
461 $rc->getTitle(),
462 new HtmlArmor( $this->message['hist'] ),
463 [ 'class' => 'mw-changeslist-history' ],
464 [
465 'curid' => $rc->mAttribs['rc_cur_id'],
466 'action' => 'history'
467 ]
468 );
469 }
470
471 $s .= Html::rawElement( 'div', [ 'class' => 'mw-changeslist-links' ],
472 Html::rawElement( 'span', [], $diffLink ) .
473 Html::rawElement( 'span', [], $histLink )
474 ) .
475 ' <span class="mw-changeslist-separator"></span> ';
476 }
477
478 /**
479 * @param RecentChange &$rc
480 * @param bool $unpatrolled
481 * @param bool $watched
482 * @return string HTML
483 * @since 1.26
484 */
485 public function getArticleLink( &$rc, $unpatrolled, $watched ) {
486 $params = [];
487 if ( $rc->getTitle()->isRedirect() ) {
488 $params = [ 'redirect' => 'no' ];
489 }
490
491 $articlelink = $this->linkRenderer->makeLink(
492 $rc->getTitle(),
493 null,
494 [ 'class' => 'mw-changeslist-title' ],
495 $params
496 );
497 if ( $this->isDeleted( $rc, Revision::DELETED_TEXT ) ) {
498 $articlelink = '<span class="history-deleted">' . $articlelink . '</span>';
499 }
500 # To allow for boldening pages watched by this user
501 $articlelink = "<span class=\"mw-title\">{$articlelink}</span>";
502 # RTL/LTR marker
503 $articlelink .= $this->getLanguage()->getDirMark();
504
505 # TODO: Deprecate the $s argument, it seems happily unused.
506 $s = '';
507 # Avoid PHP 7.1 warning from passing $this by reference
508 $changesList = $this;
509 Hooks::run( 'ChangesListInsertArticleLink',
510 [ &$changesList, &$articlelink, &$s, &$rc, $unpatrolled, $watched ] );
511
512 return "{$s} {$articlelink}";
513 }
514
515 /**
516 * Get the timestamp from $rc formatted with current user's settings
517 * and a separator
518 *
519 * @param RecentChange $rc
520 * @return string HTML fragment
521 */
522 public function getTimestamp( $rc ) {
523 // @todo FIXME: Hard coded ". .". Is there a message for this? Should there be?
524 return $this->message['semicolon-separator'] . '<span class="mw-changeslist-date">' .
525 htmlspecialchars( $this->getLanguage()->userTime(
526 $rc->mAttribs['rc_timestamp'],
527 $this->getUser()
528 ) ) . '</span> <span class="mw-changeslist-separator"></span> ';
529 }
530
531 /**
532 * Insert time timestamp string from $rc into $s
533 *
534 * @param string &$s HTML to update
535 * @param RecentChange $rc
536 */
537 public function insertTimestamp( &$s, $rc ) {
538 $s .= $this->getTimestamp( $rc );
539 }
540
541 /**
542 * Insert links to user page, user talk page and eventually a blocking link
543 *
544 * @param string &$s HTML to update
545 * @param RecentChange &$rc
546 */
547 public function insertUserRelatedLinks( &$s, &$rc ) {
548 if ( $this->isDeleted( $rc, Revision::DELETED_USER ) ) {
549 $s .= ' <span class="history-deleted">' .
550 $this->msg( 'rev-deleted-user' )->escaped() . '</span>';
551 } else {
552 $s .= $this->getLanguage()->getDirMark() . Linker::userLink( $rc->mAttribs['rc_user'],
553 $rc->mAttribs['rc_user_text'] );
554 $s .= Linker::userToolLinks(
555 $rc->mAttribs['rc_user'], $rc->mAttribs['rc_user_text'],
556 false, 0, null,
557 // The text content of tools is not wrapped with parenthesises or "piped".
558 // This will be handled in CSS (T205581).
559 false
560 );
561 }
562 }
563
564 /**
565 * Insert a formatted action
566 *
567 * @param RecentChange $rc
568 * @return string
569 */
570 public function insertLogEntry( $rc ) {
571 $formatter = LogFormatter::newFromRow( $rc->mAttribs );
572 $formatter->setContext( $this->getContext() );
573 $formatter->setShowUserToolLinks( true );
574 $mark = $this->getLanguage()->getDirMark();
575
576 return $formatter->getActionText() . " $mark" . $formatter->getComment();
577 }
578
579 /**
580 * Insert a formatted comment
581 * @param RecentChange $rc
582 * @return string
583 */
584 public function insertComment( $rc ) {
585 if ( $this->isDeleted( $rc, Revision::DELETED_COMMENT ) ) {
586 return ' <span class="history-deleted">' .
587 $this->msg( 'rev-deleted-comment' )->escaped() . '</span>';
588 } else {
589 return Linker::commentBlock( $rc->mAttribs['rc_comment'], $rc->getTitle() );
590 }
591 }
592
593 /**
594 * Returns the string which indicates the number of watching users
595 * @param int $count Number of user watching a page
596 * @return string
597 */
598 protected function numberofWatchingusers( $count ) {
599 if ( $count <= 0 ) {
600 return '';
601 }
602
603 return $this->watchMsgCache->getWithSetCallback(
604 "watching-users-msg:$count",
605 function () use ( $count ) {
606 return $this->msg( 'number_of_watching_users_RCview' )
607 ->numParams( $count )->escaped();
608 }
609 );
610 }
611
612 /**
613 * Determine if said field of a revision is hidden
614 * @param RCCacheEntry|RecentChange $rc
615 * @param int $field One of DELETED_* bitfield constants
616 * @return bool
617 */
618 public static function isDeleted( $rc, $field ) {
619 return ( $rc->mAttribs['rc_deleted'] & $field ) == $field;
620 }
621
622 /**
623 * Determine if the current user is allowed to view a particular
624 * field of this revision, if it's marked as deleted.
625 * @param RCCacheEntry|RecentChange $rc
626 * @param int $field
627 * @param User|null $user User object to check, or null to use $wgUser
628 * @return bool
629 */
630 public static function userCan( $rc, $field, User $user = null ) {
631 if ( $rc->mAttribs['rc_type'] == RC_LOG ) {
632 return LogEventsList::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
633 } else {
634 return Revision::userCanBitfield( $rc->mAttribs['rc_deleted'], $field, $user );
635 }
636 }
637
638 /**
639 * @param string $link
640 * @param bool $watched
641 * @return string
642 */
643 protected function maybeWatchedLink( $link, $watched = false ) {
644 if ( $watched ) {
645 return '<strong class="mw-watched">' . $link . '</strong>';
646 } else {
647 return '<span class="mw-rc-unwatched">' . $link . '</span>';
648 }
649 }
650
651 /**
652 * Insert a rollback link
653 *
654 * @param string &$s
655 * @param RecentChange &$rc
656 */
657 public function insertRollback( &$s, &$rc ) {
658 if ( $rc->mAttribs['rc_type'] == RC_EDIT
659 && $rc->mAttribs['rc_this_oldid']
660 && $rc->mAttribs['rc_cur_id']
661 && $rc->getAttribute( 'page_latest' ) == $rc->mAttribs['rc_this_oldid']
662 ) {
663 $title = $rc->getTitle();
664 /** Check for rollback permissions, disallow special pages, and only
665 * show a link on the top-most revision */
666 if ( $title->quickUserCan( 'rollback', $this->getUser() ) ) {
667 $rev = new Revision( [
668 'title' => $title,
669 'id' => $rc->mAttribs['rc_this_oldid'],
670 'user' => $rc->mAttribs['rc_user'],
671 'user_text' => $rc->mAttribs['rc_user_text'],
672 'actor' => $rc->mAttribs['rc_actor'] ?? null,
673 'deleted' => $rc->mAttribs['rc_deleted']
674 ] );
675 $s .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
676 }
677 }
678 }
679
680 /**
681 * @param RecentChange $rc
682 * @return string
683 * @since 1.26
684 */
685 public function getRollback( RecentChange $rc ) {
686 $s = '';
687 $this->insertRollback( $s, $rc );
688 return $s;
689 }
690
691 /**
692 * @param string &$s
693 * @param RecentChange &$rc
694 * @param array &$classes
695 */
696 public function insertTags( &$s, &$rc, &$classes ) {
697 if ( empty( $rc->mAttribs['ts_tags'] ) ) {
698 return;
699 }
700
701 list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
702 $rc->mAttribs['ts_tags'],
703 'changeslist',
704 $this->getContext()
705 );
706 $classes = array_merge( $classes, $newClasses );
707 $s .= ' ' . $tagSummary;
708 }
709
710 /**
711 * @param RecentChange $rc
712 * @param array &$classes
713 * @return string
714 * @since 1.26
715 */
716 public function getTags( RecentChange $rc, array &$classes ) {
717 $s = '';
718 $this->insertTags( $s, $rc, $classes );
719 return $s;
720 }
721
722 public function insertExtra( &$s, &$rc, &$classes ) {
723 // Empty, used for subclasses to add anything special.
724 }
725
726 protected function showAsUnpatrolled( RecentChange $rc ) {
727 return self::isUnpatrolled( $rc, $this->getUser() );
728 }
729
730 /**
731 * @param object|RecentChange $rc Database row from recentchanges or a RecentChange object
732 * @param User $user
733 * @return bool
734 */
735 public static function isUnpatrolled( $rc, User $user ) {
736 if ( $rc instanceof RecentChange ) {
737 $isPatrolled = $rc->mAttribs['rc_patrolled'];
738 $rcType = $rc->mAttribs['rc_type'];
739 $rcLogType = $rc->mAttribs['rc_log_type'];
740 } else {
741 $isPatrolled = $rc->rc_patrolled;
742 $rcType = $rc->rc_type;
743 $rcLogType = $rc->rc_log_type;
744 }
745
746 if ( !$isPatrolled ) {
747 if ( $user->useRCPatrol() ) {
748 return true;
749 }
750 if ( $user->useNPPatrol() && $rcType == RC_NEW ) {
751 return true;
752 }
753 if ( $user->useFilePatrol() && $rcLogType == 'upload' ) {
754 return true;
755 }
756 }
757
758 return false;
759 }
760
761 /**
762 * Determines whether a revision is linked to this change; this may not be the case
763 * when the categorization wasn't done by an edit but a conditional parser function
764 *
765 * @since 1.27
766 *
767 * @param RecentChange|RCCacheEntry $rcObj
768 * @return bool
769 */
770 protected function isCategorizationWithoutRevision( $rcObj ) {
771 return intval( $rcObj->getAttribute( 'rc_type' ) ) === RC_CATEGORIZE
772 && intval( $rcObj->getAttribute( 'rc_this_oldid' ) ) === 0;
773 }
774
775 /**
776 * Get recommended data attributes for a change line.
777 * @param RecentChange $rc
778 * @return string[] attribute name => value
779 */
780 protected function getDataAttributes( RecentChange $rc ) {
781 $attrs = [];
782
783 $type = $rc->getAttribute( 'rc_source' );
784 switch ( $type ) {
785 case RecentChange::SRC_EDIT:
786 case RecentChange::SRC_NEW:
787 $attrs['data-mw-revid'] = $rc->mAttribs['rc_this_oldid'];
788 break;
789 case RecentChange::SRC_LOG:
790 $attrs['data-mw-logid'] = $rc->mAttribs['rc_logid'];
791 $attrs['data-mw-logaction'] =
792 $rc->mAttribs['rc_log_type'] . '/' . $rc->mAttribs['rc_log_action'];
793 break;
794 }
795
796 $attrs[ 'data-mw-ts' ] = $rc->getAttribute( 'rc_timestamp' );
797
798 return $attrs;
799 }
800
801 /**
802 * Sets the callable that generates a change line prefix added to the beginning of each line.
803 *
804 * @param callable $prefixer Callable to run that generates the change line prefix.
805 * Takes three parameters: a RecentChange object, a ChangesList object,
806 * and whether the current entry is a grouped entry.
807 */
808 public function setChangeLinePrefixer( callable $prefixer ) {
809 $this->changeLinePrefixer = $prefixer;
810 }
811 }