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 ( isset( $conds['orconds']['actor'] ) ) {
225 // @todo: This will need changing when revision_comment_temp goes away
226 $queryInfo['options']['USE INDEX']['temp_rev_user'] = 'actor_timestamp';
227 // Alias 'rev_timestamp' => 'revactor_timestamp' so "ORDER BY rev_timestamp" is interpreted to
228 // use revactor_timestamp instead.
229 $queryInfo['fields'] = array_merge(
230 array_diff( $queryInfo['fields'], [ 'rev_timestamp' ] ),
231 [ 'rev_timestamp' => 'revactor_timestamp' ]
234 $queryInfo['options']['USE INDEX']['revision'] =
235 isset( $conds['orconds']['userid'] ) ?
'user_timestamp' : 'usertext_timestamp';
240 if ( $this->deletedOnly
) {
241 $queryInfo['conds'][] = 'rev_deleted != 0';
244 if ( $this->topOnly
) {
245 $queryInfo['conds'][] = 'rev_id = page_latest';
248 if ( $this->newOnly
) {
249 $queryInfo['conds'][] = 'rev_parent_id = 0';
252 if ( $this->hideMinor
) {
253 $queryInfo['conds'][] = 'rev_minor_edit = 0';
256 $user = $this->getUser();
257 $queryInfo['conds'] = array_merge( $queryInfo['conds'], $this->getNamespaceCond() );
259 // Paranoia: avoid brute force searches (T19342)
260 if ( !$user->isAllowed( 'deletedhistory' ) ) {
261 $queryInfo['conds'][] = $this->mDb
->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0';
262 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
263 $queryInfo['conds'][] = $this->mDb
->bitAnd( 'rev_deleted', Revision
::SUPPRESSED_USER
) .
264 ' != ' . Revision
::SUPPRESSED_USER
;
267 // For IPv6, we use ipc_rev_timestamp on ip_changes as the index field,
268 // which will be referenced when parsing the results of a query.
269 if ( self
::isQueryableRange( $this->target
) ) {
270 $queryInfo['fields'][] = 'ipc_rev_timestamp';
273 ChangeTags
::modifyDisplayQuery(
274 $queryInfo['tables'],
275 $queryInfo['fields'],
277 $queryInfo['join_conds'],
278 $queryInfo['options'],
282 // Avoid PHP 7.1 warning from passing $this by reference
284 Hooks
::run( 'ContribsPager::getQueryInfo', [ &$pager, &$queryInfo ] );
289 function getNamespaceCond() {
290 if ( $this->namespace !== '' ) {
291 $selectedNS = $this->mDb
->addQuotes( $this->namespace );
292 $eq_op = $this->nsInvert ?
'!=' : '=';
293 $bool_op = $this->nsInvert ?
'AND' : 'OR';
295 if ( !$this->associated
) {
296 return [ "page_namespace $eq_op $selectedNS" ];
299 $associatedNS = $this->mDb
->addQuotes(
300 MWNamespace
::getAssociated( $this->namespace )
304 "page_namespace $eq_op $selectedNS " .
306 " page_namespace $eq_op $associatedNS"
314 * Get SQL conditions for an IP range, if applicable
315 * @param IDatabase $db
316 * @param string $ip The IP address or CIDR
317 * @return string|false SQL for valid IP ranges, false if invalid
319 private function getIpRangeConds( $db, $ip ) {
320 // First make sure it is a valid range and they are not outside the CIDR limit
321 if ( !$this->isQueryableRange( $ip ) ) {
325 list( $start, $end ) = IP
::parseRange( $ip );
327 return 'ipc_hex BETWEEN ' . $db->addQuotes( $start ) . ' AND ' . $db->addQuotes( $end );
331 * Is the given IP a range and within the CIDR limit?
333 * @param string $ipRange
334 * @return bool True if it is valid
337 public function isQueryableRange( $ipRange ) {
338 $limits = $this->getConfig()->get( 'RangeContributionsCIDRLimit' );
340 $bits = IP
::parseCIDR( $ipRange )[1];
342 ( $bits === false ) ||
343 ( IP
::isIPv4( $ipRange ) && $bits < $limits['IPv4'] ) ||
344 ( IP
::isIPv6( $ipRange ) && $bits < $limits['IPv6'] )
353 * Override of getIndexField() in IndexPager.
354 * For IP ranges, it's faster to use the replicated ipc_rev_timestamp
355 * on the `ip_changes` table than the rev_timestamp on the `revision` table.
356 * @return string Name of field
358 public function getIndexField() {
359 if ( $this->isQueryableRange( $this->target
) ) {
360 return 'ipc_rev_timestamp';
362 return 'rev_timestamp';
366 function doBatchLookups() {
367 # Do a link batch query
368 $this->mResult
->seek( 0 );
370 $this->mParentLens
= [];
371 $batch = new LinkBatch();
372 $isIpRange = $this->isQueryableRange( $this->target
);
373 # Give some pointers to make (last) links
374 foreach ( $this->mResult
as $row ) {
375 if ( isset( $row->rev_parent_id
) && $row->rev_parent_id
) {
376 $parentRevIds[] = $row->rev_parent_id
;
378 if ( isset( $row->rev_id
) ) {
379 $this->mParentLens
[$row->rev_id
] = $row->rev_len
;
380 if ( $this->contribs
=== 'newbie' ) { // multiple users
381 $batch->add( NS_USER
, $row->user_name
);
382 $batch->add( NS_USER_TALK
, $row->user_name
);
383 } elseif ( $isIpRange ) {
384 // If this is an IP range, batch the IP's talk page
385 $batch->add( NS_USER_TALK
, $row->rev_user_text
);
387 $batch->add( $row->page_namespace
, $row->page_title
);
390 # Fetch rev_len for revisions not already scanned above
391 $this->mParentLens +
= Revision
::getParentLengths(
393 array_diff( $parentRevIds, array_keys( $this->mParentLens
) )
396 $this->mResult
->seek( 0 );
402 function getStartBody() {
403 return "<ul class=\"mw-contributions-list\">\n";
409 function getEndBody() {
414 * Check whether the revision associated is valid for formatting. If has no associated revision
415 * id then null is returned.
418 * @return Revision|null
420 public function tryToCreateValidRevision( $row ) {
422 * There may be more than just revision rows. To make sure that we'll only be processing
423 * revisions here, let's _try_ to build a revision out of our row (without displaying
424 * notices though) and then trying to grab data from the built object. If we succeed,
425 * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
426 * to extensions to subscribe to the hook to parse the row.
428 Wikimedia\
suppressWarnings();
430 $rev = new Revision( $row );
431 $validRevision = (bool)$rev->getId();
432 } catch ( Exception
$e ) {
433 $validRevision = false;
435 Wikimedia\restoreWarnings
();
436 return $validRevision ?
$rev : null;
440 * Generates each row in the contributions list.
442 * Contributions which are marked "top" are currently on top of the history.
443 * For these contributions, a [rollback] link is shown for users with roll-
444 * back privileges. The rollback link restores the most recent version that
445 * was not written by the target user.
447 * @todo This would probably look a lot nicer in a table.
451 function formatRow( $row ) {
456 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
458 $rev = $this->tryToCreateValidRevision( $row );
460 $attribs['data-mw-revid'] = $rev->getId();
462 $page = Title
::newFromRow( $row );
463 $link = $linkRenderer->makeLink(
465 $page->getPrefixedText(),
466 [ 'class' => 'mw-contributions-title' ],
467 $page->isRedirect() ?
[ 'redirect' => 'no' ] : []
469 # Mark current revisions
471 $user = $this->getUser();
473 if ( $row->rev_id
=== $row->page_latest
) {
474 $topmarktext .= '<span class="mw-uctop">' . $this->messages
['uctop'] . '</span>';
475 $classes[] = 'mw-contributions-current';
477 if ( !$row->page_is_new
&& $page->quickUserCan( 'rollback', $user )
478 && $page->quickUserCan( 'edit', $user )
480 $this->preventClickjacking();
481 $topmarktext .= ' ' . Linker
::generateRollback( $rev, $this->getContext() );
484 # Is there a visible previous revision?
485 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) && $rev->getParentId() !== 0 ) {
486 $difftext = $linkRenderer->makeKnownLink(
488 new HtmlArmor( $this->messages
['diff'] ),
489 [ 'class' => 'mw-changeslist-diff' ],
492 'oldid' => $row->rev_id
496 $difftext = $this->messages
['diff'];
498 $histlink = $linkRenderer->makeKnownLink(
500 new HtmlArmor( $this->messages
['hist'] ),
501 [ 'class' => 'mw-changeslist-history' ],
502 [ 'action' => 'history' ]
505 if ( $row->rev_parent_id
=== null ) {
506 // For some reason rev_parent_id isn't populated for this row.
507 // Its rumoured this is true on wikipedia for some revisions (T36922).
508 // Next best thing is to have the total number of bytes.
509 $chardiff = ' <span class="mw-changeslist-separator"></span> ';
510 $chardiff .= Linker
::formatRevisionSize( $row->rev_len
);
511 $chardiff .= ' <span class="mw-changeslist-separator"></span> ';
514 if ( isset( $this->mParentLens
[$row->rev_parent_id
] ) ) {
515 $parentLen = $this->mParentLens
[$row->rev_parent_id
];
518 $chardiff = ' <span class="mw-changeslist-separator"></span> ';
519 $chardiff .= ChangesList
::showCharacterDifference(
524 $chardiff .= ' <span class="mw-changeslist-separator"></span> ';
527 $lang = $this->getLanguage();
528 $comment = $lang->getDirMark() . Linker
::revComment( $rev, false, true, false );
529 $date = $lang->userTimeAndDate( $row->rev_timestamp
, $user );
530 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
531 $d = $linkRenderer->makeKnownLink(
534 [ 'class' => 'mw-changeslist-date' ],
535 [ 'oldid' => intval( $row->rev_id
) ]
538 $d = htmlspecialchars( $date );
540 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
541 $d = '<span class="history-deleted">' . $d . '</span>';
544 # Show user names for /newbies as there may be different users.
545 # Note that only unprivileged users have rows with hidden user names excluded.
546 # When querying for an IP range, we want to always show user and user talk links.
548 if ( ( $this->contribs
== 'newbie' && !$rev->isDeleted( Revision
::DELETED_USER
) )
549 ||
$this->isQueryableRange( $this->target
) ) {
550 $userlink = ' <span class="mw-changeslist-separator"></span> '
551 . $lang->getDirMark()
552 . Linker
::userLink( $rev->getUser(), $rev->getUserText() );
553 $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
554 Linker
::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
558 if ( $rev->getParentId() === 0 ) {
559 $flags[] = ChangesList
::flag( 'newpage' );
562 if ( $rev->isMinor() ) {
563 $flags[] = ChangesList
::flag( 'minor' );
566 $del = Linker
::getRevDeleteLink( $user, $rev, $page );
571 // While it might be tempting to use a list here
572 // this would result in clutter and slows down navigating the content
573 // in assistive technology.
574 // See https://phabricator.wikimedia.org/T205581#4734812
575 $diffHistLinks = Html
::rawElement( 'span',
576 [ 'class' => 'mw-changeslist-links' ],
577 // The spans are needed to ensure the dividing '|' elements are not
578 // themselves styled as links.
579 Html
::rawElement( 'span', [], $difftext ) .
580 ' ' . // Space needed for separating two words.
581 Html
::rawElement( 'span', [], $histlink )
585 list( $tagSummary, $newClasses ) = ChangeTags
::formatSummaryRow(
590 $classes = array_merge( $classes, $newClasses );
592 Hooks
::run( 'SpecialContributions::formatRow::flags', [ $this->getContext(), $row, &$flags ] );
597 'diffHistLinks' => $diffHistLinks,
598 'charDifference' => $chardiff,
600 'articleLink' => $link,
601 'userlink' => $userlink,
602 'logText' => $comment,
603 'topmarktext' => $topmarktext,
604 'tagSummary' => $tagSummary,
607 # Denote if username is redacted for this edit
608 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
609 $templateParams['rev-deleted-user-contribs'] =
610 $this->msg( 'rev-deleted-user-contribs' )->escaped();
613 $ret = $this->templateParser
->processTemplate(
614 'SpecialContributionsLine',
619 // Let extensions add data
620 Hooks
::run( 'ContributionsLineEnding', [ $this, &$ret, $row, &$classes, &$attribs ] );
621 $attribs = array_filter( $attribs,
622 [ Sanitizer
::class, 'isReservedDataAttribute' ],
626 // TODO: Handle exceptions in the catch block above. Do any extensions rely on
627 // receiving empty rows?
629 if ( $classes === [] && $attribs === [] && $ret === '' ) {
630 wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
631 return "<!-- Could not format Special:Contribution row. -->\n";
633 $attribs['class'] = $classes;
635 // FIXME: The signature of the ContributionsLineEnding hook makes it
636 // very awkward to move this LI wrapper into the template.
637 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
641 * Overwrite Pager function and return a helpful comment
644 function getSqlComment() {
645 if ( $this->namespace ||
$this->deletedOnly
) {
646 // potentially slow, see CR r58153
647 return 'contributions page filtered for namespace or RevisionDeleted edits';
649 return 'contributions page unfiltered';
653 protected function preventClickjacking() {
654 $this->preventClickjacking
= true;
660 public function getPreventClickjacking() {
661 return $this->preventClickjacking
;
665 * Set up date filter options, given request data.
667 * @param array $opts Options array
668 * @return array Options array with processed start and end date filter options
670 public static function processDateFilter( array $opts ) {
671 $start = $opts['start'] ??
'';
672 $end = $opts['end'] ??
'';
673 $year = $opts['year'] ??
'';
674 $month = $opts['month'] ??
'';
676 if ( $start !== '' && $end !== '' && $start > $end ) {
682 // If year/month legacy filtering options are set, convert them to display the new stamp
683 if ( $year !== '' ||
$month !== '' ) {
684 // Reuse getDateCond logic, but subtract a day because
685 // the endpoints of our date range appear inclusive
686 // but the internal end offsets are always exclusive
687 $legacyTimestamp = ReverseChronologicalPager
::getOffsetDate( $year, $month );
688 $legacyDateTime = new DateTime( $legacyTimestamp->getTimestamp( TS_ISO_8601
) );
689 $legacyDateTime = $legacyDateTime->modify( '-1 day' );
691 // Clear the new timestamp range options if used and
692 // replace with the converted legacy timestamp
694 $end = $legacyDateTime->format( 'Y-m-d' );
697 $opts['start'] = $start;