3 * This program is free software; you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation; either version 2 of the License, or
6 * (at your option) any later version.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 * http://www.gnu.org/copyleft/gpl.html
23 * Pager for Special:Contributions
26 use MediaWiki\MediaWikiServices
;
27 use Wikimedia\Rdbms\IResultWrapper
;
28 use Wikimedia\Rdbms\FakeResultWrapper
;
29 use Wikimedia\Rdbms\IDatabase
;
31 class ContribsPager
extends RangeChronologicalPager
{
33 public $mDefaultDirection = IndexPager
::DIR_DESCENDING
;
36 public $namespace = '';
38 public $preventClickjacking = false;
46 protected $mParentLens;
51 protected $templateParser;
53 function __construct( IContextSource
$context, array $options ) {
54 parent
::__construct( $context );
63 foreach ( $msgs as $msg ) {
64 $this->messages
[$msg] = $this->msg( $msg )->escaped();
67 $this->target
= $options['target'] ??
'';
68 $this->contribs
= $options['contribs'] ??
'users';
69 $this->namespace = $options['namespace'] ??
'';
70 $this->tagFilter
= $options['tagfilter'] ??
false;
71 $this->nsInvert
= $options['nsInvert'] ??
false;
72 $this->associated
= $options['associated'] ??
false;
74 $this->deletedOnly
= !empty( $options['deletedOnly'] );
75 $this->topOnly
= !empty( $options['topOnly'] );
76 $this->newOnly
= !empty( $options['newOnly'] );
77 $this->hideMinor
= !empty( $options['hideMinor'] );
79 // Date filtering: use timestamp if available
82 if ( $options['start'] ) {
83 $startTimestamp = $options['start'] . ' 00:00:00';
85 if ( $options['end'] ) {
86 $endTimestamp = $options['end'] . ' 23:59:59';
88 $this->getDateRangeCond( $startTimestamp, $endTimestamp );
90 // This property on IndexPager is set by $this->getIndexField() in parent::__construct().
91 // We need to reassign it here so that it is used when the actual query is ran.
92 $this->mIndexField
= $this->getIndexField();
94 // Most of this code will use the 'contributions' group DB, which can map to replica DBs
95 // with extra user based indexes or partioning by user. The additional metadata
96 // queries should use a regular replica DB since the lookup pattern is not all by user.
97 $this->mDbSecondary
= wfGetDB( DB_REPLICA
); // any random replica DB
98 $this->mDb
= wfGetDB( DB_REPLICA
, 'contributions' );
99 $this->templateParser
= new TemplateParser();
102 function getDefaultQuery() {
103 $query = parent
::getDefaultQuery();
104 $query['target'] = $this->target
;
110 * This method basically executes the exact same code as the parent class, though with
111 * a hook added, to allow extensions to add additional queries.
113 * @param string $offset Index offset, inclusive
114 * @param int $limit Exact query limit
115 * @param bool $descending Query direction, false for ascending, true for descending
116 * @return IResultWrapper
118 function reallyDoQuery( $offset, $limit, $descending ) {
119 list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo(
126 * This hook will allow extensions to add in additional queries, so they can get their data
127 * in My Contributions as well. Extensions should append their results to the $data array.
129 * Extension queries have to implement the navbar requirement as well. They should
130 * - have a column aliased as $pager->getIndexField()
132 * - have a WHERE-clause that compares the $pager->getIndexField()-equivalent column to the offset
133 * - have the ORDER BY specified based upon the details provided by the navbar
135 * See includes/Pager.php buildQueryInfo() method on how to build LIMIT, WHERE & ORDER BY
137 * &$data: an array of results of all contribs queries
138 * $pager: the ContribsPager object hooked into
139 * $offset: see phpdoc above
140 * $limit: see phpdoc above
141 * $descending: see phpdoc above
143 $data = [ $this->mDb
->select(
144 $tables, $fields, $conds, $fname, $options, $join_conds
147 'ContribsPager::reallyDoQuery',
148 [ &$data, $this, $offset, $limit, $descending ]
153 // loop all results and collect them in an array
154 foreach ( $data as $query ) {
155 foreach ( $query as $i => $row ) {
156 // use index column as key, allowing us to easily sort in PHP
157 $result[$row->{$this->getIndexField()} . "-$i"] = $row;
169 $result = array_slice( $result, 0, $limit );
171 // get rid of array keys
172 $result = array_values( $result );
174 return new FakeResultWrapper( $result );
177 function getQueryInfo() {
178 $revQuery = Revision
::getQueryInfo( [ 'page', 'user' ] );
180 'tables' => $revQuery['tables'],
181 'fields' => array_merge( $revQuery['fields'], [ 'page_is_new' ] ),
184 'join_conds' => $revQuery['joins'],
187 if ( $this->contribs
== 'newbie' ) {
188 $max = $this->mDb
->selectField( 'user', 'max(user_id)', '', __METHOD__
);
189 $queryInfo['conds'][] = $revQuery['fields']['rev_user'] . ' >' . (int)( $max - $max / 100 );
190 # ignore local groups with the bot right
191 # @todo FIXME: Global groups may have 'bot' rights
192 $groupsWithBotPermission = User
::getGroupsWithPermission( 'bot' );
193 if ( count( $groupsWithBotPermission ) ) {
194 $queryInfo['tables'][] = 'user_groups';
195 $queryInfo['conds'][] = 'ug_group IS NULL';
196 $queryInfo['join_conds']['user_groups'] = [
198 'ug_user = ' . $revQuery['fields']['rev_user'],
199 'ug_group' => $groupsWithBotPermission,
200 'ug_expiry IS NULL OR ug_expiry >= ' .
201 $this->mDb
->addQuotes( $this->mDb
->timestamp() )
205 // (T140537) Disallow looking too far in the past for 'newbies' queries. If the user requested
206 // a timestamp offset far in the past such that there are no edits by users with user_ids in
207 // the range, we would end up scanning all revisions from that offset until start of time.
208 $queryInfo['conds'][] = 'rev_timestamp > ' .
209 $this->mDb
->addQuotes( $this->mDb
->timestamp( wfTimestamp() - 30 * 24 * 60 * 60 ) );
211 $user = User
::newFromName( $this->target
, false );
212 $ipRangeConds = $user->isAnon() ?
$this->getIpRangeConds( $this->mDb
, $this->target
) : null;
213 if ( $ipRangeConds ) {
214 $queryInfo['tables'][] = 'ip_changes';
215 $queryInfo['join_conds']['ip_changes'] = [
216 'LEFT JOIN', [ 'ipc_rev_id = rev_id' ]
218 $queryInfo['conds'][] = $ipRangeConds;
220 // tables and joins are already handled by Revision::getQueryInfo()
221 $conds = ActorMigration
::newMigration()->getWhere( $this->mDb
, 'rev_user', $user );
222 $queryInfo['conds'][] = $conds['conds'];
223 // Force the appropriate index to avoid bad query plans (T189026)
224 if ( count( $conds['orconds'] ) === 1 ) {
225 if ( isset( $conds['orconds']['actor'] ) ) {
226 // @todo: This will need changing when revision_comment_temp goes away
227 $queryInfo['options']['USE INDEX']['temp_rev_user'] = 'actor_timestamp';
229 $queryInfo['options']['USE INDEX']['revision'] =
230 isset( $conds['orconds']['userid'] ) ?
'user_timestamp' : 'usertext_timestamp';
236 if ( $this->deletedOnly
) {
237 $queryInfo['conds'][] = 'rev_deleted != 0';
240 if ( $this->topOnly
) {
241 $queryInfo['conds'][] = 'rev_id = page_latest';
244 if ( $this->newOnly
) {
245 $queryInfo['conds'][] = 'rev_parent_id = 0';
248 if ( $this->hideMinor
) {
249 $queryInfo['conds'][] = 'rev_minor_edit = 0';
252 $user = $this->getUser();
253 $queryInfo['conds'] = array_merge( $queryInfo['conds'], $this->getNamespaceCond() );
255 // Paranoia: avoid brute force searches (T19342)
256 if ( !$user->isAllowed( 'deletedhistory' ) ) {
257 $queryInfo['conds'][] = $this->mDb
->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0';
258 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
259 $queryInfo['conds'][] = $this->mDb
->bitAnd( 'rev_deleted', Revision
::SUPPRESSED_USER
) .
260 ' != ' . Revision
::SUPPRESSED_USER
;
263 // For IPv6, we use ipc_rev_timestamp on ip_changes as the index field,
264 // which will be referenced when parsing the results of a query.
265 if ( self
::isQueryableRange( $this->target
) ) {
266 $queryInfo['fields'][] = 'ipc_rev_timestamp';
269 ChangeTags
::modifyDisplayQuery(
270 $queryInfo['tables'],
271 $queryInfo['fields'],
273 $queryInfo['join_conds'],
274 $queryInfo['options'],
278 // Avoid PHP 7.1 warning from passing $this by reference
280 Hooks
::run( 'ContribsPager::getQueryInfo', [ &$pager, &$queryInfo ] );
285 function getNamespaceCond() {
286 if ( $this->namespace !== '' ) {
287 $selectedNS = $this->mDb
->addQuotes( $this->namespace );
288 $eq_op = $this->nsInvert ?
'!=' : '=';
289 $bool_op = $this->nsInvert ?
'AND' : 'OR';
291 if ( !$this->associated
) {
292 return [ "page_namespace $eq_op $selectedNS" ];
295 $associatedNS = $this->mDb
->addQuotes(
296 MWNamespace
::getAssociated( $this->namespace )
300 "page_namespace $eq_op $selectedNS " .
302 " page_namespace $eq_op $associatedNS"
310 * Get SQL conditions for an IP range, if applicable
311 * @param IDatabase $db
312 * @param string $ip The IP address or CIDR
313 * @return string|false SQL for valid IP ranges, false if invalid
315 private function getIpRangeConds( $db, $ip ) {
316 // First make sure it is a valid range and they are not outside the CIDR limit
317 if ( !$this->isQueryableRange( $ip ) ) {
321 list( $start, $end ) = IP
::parseRange( $ip );
323 return 'ipc_hex BETWEEN ' . $db->addQuotes( $start ) . ' AND ' . $db->addQuotes( $end );
327 * Is the given IP a range and within the CIDR limit?
329 * @param string $ipRange
330 * @return bool True if it is valid
333 public function isQueryableRange( $ipRange ) {
334 $limits = $this->getConfig()->get( 'RangeContributionsCIDRLimit' );
336 $bits = IP
::parseCIDR( $ipRange )[1];
338 ( $bits === false ) ||
339 ( IP
::isIPv4( $ipRange ) && $bits < $limits['IPv4'] ) ||
340 ( IP
::isIPv6( $ipRange ) && $bits < $limits['IPv6'] )
349 * Override of getIndexField() in IndexPager.
350 * For IP ranges, it's faster to use the replicated ipc_rev_timestamp
351 * on the `ip_changes` table than the rev_timestamp on the `revision` table.
352 * @return string Name of field
354 public function getIndexField() {
355 if ( $this->isQueryableRange( $this->target
) ) {
356 return 'ipc_rev_timestamp';
358 return 'rev_timestamp';
362 function doBatchLookups() {
363 # Do a link batch query
364 $this->mResult
->seek( 0 );
366 $this->mParentLens
= [];
367 $batch = new LinkBatch();
368 $isIpRange = $this->isQueryableRange( $this->target
);
369 # Give some pointers to make (last) links
370 foreach ( $this->mResult
as $row ) {
371 if ( isset( $row->rev_parent_id
) && $row->rev_parent_id
) {
372 $parentRevIds[] = $row->rev_parent_id
;
374 if ( isset( $row->rev_id
) ) {
375 $this->mParentLens
[$row->rev_id
] = $row->rev_len
;
376 if ( $this->contribs
=== 'newbie' ) { // multiple users
377 $batch->add( NS_USER
, $row->user_name
);
378 $batch->add( NS_USER_TALK
, $row->user_name
);
379 } elseif ( $isIpRange ) {
380 // If this is an IP range, batch the IP's talk page
381 $batch->add( NS_USER_TALK
, $row->rev_user_text
);
383 $batch->add( $row->page_namespace
, $row->page_title
);
386 # Fetch rev_len for revisions not already scanned above
387 $this->mParentLens +
= Revision
::getParentLengths(
389 array_diff( $parentRevIds, array_keys( $this->mParentLens
) )
392 $this->mResult
->seek( 0 );
398 function getStartBody() {
399 return "<ul class=\"mw-contributions-list\">\n";
405 function getEndBody() {
410 * Generates each row in the contributions list.
412 * Contributions which are marked "top" are currently on top of the history.
413 * For these contributions, a [rollback] link is shown for users with roll-
414 * back privileges. The rollback link restores the most recent version that
415 * was not written by the target user.
417 * @todo This would probably look a lot nicer in a table.
421 function formatRow( $row ) {
426 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
429 * There may be more than just revision rows. To make sure that we'll only be processing
430 * revisions here, let's _try_ to build a revision out of our row (without displaying
431 * notices though) and then trying to grab data from the built object. If we succeed,
432 * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
433 * to extensions to subscribe to the hook to parse the row.
435 Wikimedia\
suppressWarnings();
437 $rev = new Revision( $row );
438 $validRevision = (bool)$rev->getId();
439 } catch ( Exception
$e ) {
440 $validRevision = false;
442 Wikimedia\restoreWarnings
();
444 if ( $validRevision ) {
445 $attribs['data-mw-revid'] = $rev->getId();
447 $page = Title
::newFromRow( $row );
448 $link = $linkRenderer->makeLink(
450 $page->getPrefixedText(),
451 [ 'class' => 'mw-contributions-title' ],
452 $page->isRedirect() ?
[ 'redirect' => 'no' ] : []
454 # Mark current revisions
456 $user = $this->getUser();
458 if ( $row->rev_id
=== $row->page_latest
) {
459 $topmarktext .= '<span class="mw-uctop">' . $this->messages
['uctop'] . '</span>';
460 $classes[] = 'mw-contributions-current';
462 if ( !$row->page_is_new
&& $page->quickUserCan( 'rollback', $user )
463 && $page->quickUserCan( 'edit', $user )
465 $this->preventClickjacking();
466 $topmarktext .= ' ' . Linker
::generateRollback( $rev, $this->getContext() );
469 # Is there a visible previous revision?
470 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) && $rev->getParentId() !== 0 ) {
471 $difftext = $linkRenderer->makeKnownLink(
473 new HtmlArmor( $this->messages
['diff'] ),
474 [ 'class' => 'mw-changeslist-diff' ],
477 'oldid' => $row->rev_id
481 $difftext = $this->messages
['diff'];
483 $histlink = $linkRenderer->makeKnownLink(
485 new HtmlArmor( $this->messages
['hist'] ),
486 [ 'class' => 'mw-changeslist-history' ],
487 [ 'action' => 'history' ]
490 if ( $row->rev_parent_id
=== null ) {
491 // For some reason rev_parent_id isn't populated for this row.
492 // Its rumoured this is true on wikipedia for some revisions (T36922).
493 // Next best thing is to have the total number of bytes.
494 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
495 $chardiff .= Linker
::formatRevisionSize( $row->rev_len
);
496 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
499 if ( isset( $this->mParentLens
[$row->rev_parent_id
] ) ) {
500 $parentLen = $this->mParentLens
[$row->rev_parent_id
];
503 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
504 $chardiff .= ChangesList
::showCharacterDifference(
509 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
512 $lang = $this->getLanguage();
513 $comment = $lang->getDirMark() . Linker
::revComment( $rev, false, true );
514 $date = $lang->userTimeAndDate( $row->rev_timestamp
, $user );
515 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
516 $d = $linkRenderer->makeKnownLink(
519 [ 'class' => 'mw-changeslist-date' ],
520 [ 'oldid' => intval( $row->rev_id
) ]
523 $d = htmlspecialchars( $date );
525 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
526 $d = '<span class="history-deleted">' . $d . '</span>';
529 # Show user names for /newbies as there may be different users.
530 # Note that only unprivileged users have rows with hidden user names excluded.
531 # When querying for an IP range, we want to always show user and user talk links.
533 if ( ( $this->contribs
== 'newbie' && !$rev->isDeleted( Revision
::DELETED_USER
) )
534 ||
$this->isQueryableRange( $this->target
) ) {
535 $userlink = ' . . ' . $lang->getDirMark()
536 . Linker
::userLink( $rev->getUser(), $rev->getUserText() );
537 $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
538 Linker
::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
542 if ( $rev->getParentId() === 0 ) {
543 $flags[] = ChangesList
::flag( 'newpage' );
546 if ( $rev->isMinor() ) {
547 $flags[] = ChangesList
::flag( 'minor' );
550 $del = Linker
::getRevDeleteLink( $user, $rev, $page );
555 $diffHistLinks = $this->msg( 'parentheses' )
556 ->rawParams( $difftext . $this->messages
['pipe-separator'] . $histlink )
560 list( $tagSummary, $newClasses ) = ChangeTags
::formatSummaryRow(
565 $classes = array_merge( $classes, $newClasses );
567 Hooks
::run( 'SpecialContributions::formatRow::flags', [ $this->getContext(), $row, &$flags ] );
572 'diffHistLinks' => $diffHistLinks,
573 'charDifference' => $chardiff,
575 'articleLink' => $link,
576 'userlink' => $userlink,
577 'logText' => $comment,
578 'topmarktext' => $topmarktext,
579 'tagSummary' => $tagSummary,
582 # Denote if username is redacted for this edit
583 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
584 $templateParams['rev-deleted-user-contribs'] =
585 $this->msg( 'rev-deleted-user-contribs' )->escaped();
588 $ret = $this->templateParser
->processTemplate(
589 'SpecialContributionsLine',
594 // Let extensions add data
595 Hooks
::run( 'ContributionsLineEnding', [ $this, &$ret, $row, &$classes, &$attribs ] );
596 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer
::class, 'isReservedDataAttribute' ] );
598 // TODO: Handle exceptions in the catch block above. Do any extensions rely on
599 // receiving empty rows?
601 if ( $classes === [] && $attribs === [] && $ret === '' ) {
602 wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
603 return "<!-- Could not format Special:Contribution row. -->\n";
605 $attribs['class'] = $classes;
607 // FIXME: The signature of the ContributionsLineEnding hook makes it
608 // very awkward to move this LI wrapper into the template.
609 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
613 * Overwrite Pager function and return a helpful comment
616 function getSqlComment() {
617 if ( $this->namespace ||
$this->deletedOnly
) {
618 // potentially slow, see CR r58153
619 return 'contributions page filtered for namespace or RevisionDeleted edits';
621 return 'contributions page unfiltered';
625 protected function preventClickjacking() {
626 $this->preventClickjacking
= true;
632 public function getPreventClickjacking() {
633 return $this->preventClickjacking
;
637 * Set up date filter options, given request data.
639 * @param array $opts Options array
640 * @return array Options array with processed start and end date filter options
642 public static function processDateFilter( array $opts ) {
643 $start = $opts['start'] ??
'';
644 $end = $opts['end'] ??
'';
645 $year = $opts['year'] ??
'';
646 $month = $opts['month'] ??
'';
648 if ( $start !== '' && $end !== '' && $start > $end ) {
654 // If year/month legacy filtering options are set, convert them to display the new stamp
655 if ( $year !== '' ||
$month !== '' ) {
656 // Reuse getDateCond logic, but subtract a day because
657 // the endpoints of our date range appear inclusive
658 // but the internal end offsets are always exclusive
659 $legacyTimestamp = ReverseChronologicalPager
::getOffsetDate( $year, $month );
660 $legacyDateTime = new DateTime( $legacyTimestamp->getTimestamp( TS_ISO_8601
) );
661 $legacyDateTime = $legacyDateTime->modify( '-1 day' );
663 // Clear the new timestamp range options if used and
664 // replace with the converted legacy timestamp
666 $end = $legacyDateTime->format( 'Y-m-d' );
669 $opts['start'] = $start;