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\ResultWrapper
;
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
= isset( $options['target'] ) ?
$options['target'] : '';
68 $this->contribs
= isset( $options['contribs'] ) ?
$options['contribs'] : 'users';
69 $this->namespace = isset( $options['namespace'] ) ?
$options['namespace'] : '';
70 $this->tagFilter
= isset( $options['tagfilter'] ) ?
$options['tagfilter'] : false;
71 $this->nsInvert
= isset( $options['nsInvert'] ) ?
$options['nsInvert'] : false;
72 $this->associated
= isset( $options['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 ResultWrapper
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 $queryInfo['conds'][] = ActorMigration
::newMigration()
222 ->getWhere( $this->mDb
, 'rev_user', $user )['conds'];
226 if ( $this->deletedOnly
) {
227 $queryInfo['conds'][] = 'rev_deleted != 0';
230 if ( $this->topOnly
) {
231 $queryInfo['conds'][] = 'rev_id = page_latest';
234 if ( $this->newOnly
) {
235 $queryInfo['conds'][] = 'rev_parent_id = 0';
238 if ( $this->hideMinor
) {
239 $queryInfo['conds'][] = 'rev_minor_edit = 0';
242 $user = $this->getUser();
243 $queryInfo['conds'] = array_merge( $queryInfo['conds'], $this->getNamespaceCond() );
245 // Paranoia: avoid brute force searches (T19342)
246 if ( !$user->isAllowed( 'deletedhistory' ) ) {
247 $queryInfo['conds'][] = $this->mDb
->bitAnd( 'rev_deleted', Revision
::DELETED_USER
) . ' = 0';
248 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
249 $queryInfo['conds'][] = $this->mDb
->bitAnd( 'rev_deleted', Revision
::SUPPRESSED_USER
) .
250 ' != ' . Revision
::SUPPRESSED_USER
;
253 // For IPv6, we use ipc_rev_timestamp on ip_changes as the index field,
254 // which will be referenced when parsing the results of a query.
255 if ( self
::isQueryableRange( $this->target
) ) {
256 $queryInfo['fields'][] = 'ipc_rev_timestamp';
259 ChangeTags
::modifyDisplayQuery(
260 $queryInfo['tables'],
261 $queryInfo['fields'],
263 $queryInfo['join_conds'],
264 $queryInfo['options'],
268 // Avoid PHP 7.1 warning from passing $this by reference
270 Hooks
::run( 'ContribsPager::getQueryInfo', [ &$pager, &$queryInfo ] );
275 function getNamespaceCond() {
276 if ( $this->namespace !== '' ) {
277 $selectedNS = $this->mDb
->addQuotes( $this->namespace );
278 $eq_op = $this->nsInvert ?
'!=' : '=';
279 $bool_op = $this->nsInvert ?
'AND' : 'OR';
281 if ( !$this->associated
) {
282 return [ "page_namespace $eq_op $selectedNS" ];
285 $associatedNS = $this->mDb
->addQuotes(
286 MWNamespace
::getAssociated( $this->namespace )
290 "page_namespace $eq_op $selectedNS " .
292 " page_namespace $eq_op $associatedNS"
300 * Get SQL conditions for an IP range, if applicable
301 * @param IDatabase $db
302 * @param string $ip The IP address or CIDR
303 * @return string|false SQL for valid IP ranges, false if invalid
305 private function getIpRangeConds( $db, $ip ) {
306 // First make sure it is a valid range and they are not outside the CIDR limit
307 if ( !$this->isQueryableRange( $ip ) ) {
311 list( $start, $end ) = IP
::parseRange( $ip );
313 return 'ipc_hex BETWEEN ' . $db->addQuotes( $start ) . ' AND ' . $db->addQuotes( $end );
317 * Is the given IP a range and within the CIDR limit?
319 * @param string $ipRange
320 * @return bool True if it is valid
323 public function isQueryableRange( $ipRange ) {
324 $limits = $this->getConfig()->get( 'RangeContributionsCIDRLimit' );
326 $bits = IP
::parseCIDR( $ipRange )[1];
328 ( $bits === false ) ||
329 ( IP
::isIPv4( $ipRange ) && $bits < $limits['IPv4'] ) ||
330 ( IP
::isIPv6( $ipRange ) && $bits < $limits['IPv6'] )
339 * Override of getIndexField() in IndexPager.
340 * For IP ranges, it's faster to use the replicated ipc_rev_timestamp
341 * on the `ip_changes` table than the rev_timestamp on the `revision` table.
342 * @return string Name of field
344 public function getIndexField() {
345 if ( $this->isQueryableRange( $this->target
) ) {
346 return 'ipc_rev_timestamp';
348 return 'rev_timestamp';
352 function doBatchLookups() {
353 # Do a link batch query
354 $this->mResult
->seek( 0 );
356 $this->mParentLens
= [];
357 $batch = new LinkBatch();
358 $isIpRange = $this->isQueryableRange( $this->target
);
359 # Give some pointers to make (last) links
360 foreach ( $this->mResult
as $row ) {
361 if ( isset( $row->rev_parent_id
) && $row->rev_parent_id
) {
362 $parentRevIds[] = $row->rev_parent_id
;
364 if ( isset( $row->rev_id
) ) {
365 $this->mParentLens
[$row->rev_id
] = $row->rev_len
;
366 if ( $this->contribs
=== 'newbie' ) { // multiple users
367 $batch->add( NS_USER
, $row->user_name
);
368 $batch->add( NS_USER_TALK
, $row->user_name
);
369 } elseif ( $isIpRange ) {
370 // If this is an IP range, batch the IP's talk page
371 $batch->add( NS_USER_TALK
, $row->rev_user_text
);
373 $batch->add( $row->page_namespace
, $row->page_title
);
376 # Fetch rev_len for revisions not already scanned above
377 $this->mParentLens +
= Revision
::getParentLengths(
379 array_diff( $parentRevIds, array_keys( $this->mParentLens
) )
382 $this->mResult
->seek( 0 );
388 function getStartBody() {
389 return "<ul class=\"mw-contributions-list\">\n";
395 function getEndBody() {
400 * Generates each row in the contributions list.
402 * Contributions which are marked "top" are currently on top of the history.
403 * For these contributions, a [rollback] link is shown for users with roll-
404 * back privileges. The rollback link restores the most recent version that
405 * was not written by the target user.
407 * @todo This would probably look a lot nicer in a table.
411 function formatRow( $row ) {
416 $linkRenderer = MediaWikiServices
::getInstance()->getLinkRenderer();
419 * There may be more than just revision rows. To make sure that we'll only be processing
420 * revisions here, let's _try_ to build a revision out of our row (without displaying
421 * notices though) and then trying to grab data from the built object. If we succeed,
422 * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
423 * to extensions to subscribe to the hook to parse the row.
425 Wikimedia\
suppressWarnings();
427 $rev = new Revision( $row );
428 $validRevision = (bool)$rev->getId();
429 } catch ( Exception
$e ) {
430 $validRevision = false;
432 Wikimedia\restoreWarnings
();
434 if ( $validRevision ) {
435 $attribs['data-mw-revid'] = $rev->getId();
437 $page = Title
::newFromRow( $row );
438 $link = $linkRenderer->makeLink(
440 $page->getPrefixedText(),
441 [ 'class' => 'mw-contributions-title' ],
442 $page->isRedirect() ?
[ 'redirect' => 'no' ] : []
444 # Mark current revisions
446 $user = $this->getUser();
448 if ( $row->rev_id
=== $row->page_latest
) {
449 $topmarktext .= '<span class="mw-uctop">' . $this->messages
['uctop'] . '</span>';
450 $classes[] = 'mw-contributions-current';
452 if ( !$row->page_is_new
&& $page->quickUserCan( 'rollback', $user )
453 && $page->quickUserCan( 'edit', $user )
455 $this->preventClickjacking();
456 $topmarktext .= ' ' . Linker
::generateRollback( $rev, $this->getContext() );
459 # Is there a visible previous revision?
460 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) && $rev->getParentId() !== 0 ) {
461 $difftext = $linkRenderer->makeKnownLink(
463 new HtmlArmor( $this->messages
['diff'] ),
464 [ 'class' => 'mw-changeslist-diff' ],
467 'oldid' => $row->rev_id
471 $difftext = $this->messages
['diff'];
473 $histlink = $linkRenderer->makeKnownLink(
475 new HtmlArmor( $this->messages
['hist'] ),
476 [ 'class' => 'mw-changeslist-history' ],
477 [ 'action' => 'history' ]
480 if ( $row->rev_parent_id
=== null ) {
481 // For some reason rev_parent_id isn't populated for this row.
482 // Its rumoured this is true on wikipedia for some revisions (T36922).
483 // Next best thing is to have the total number of bytes.
484 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
485 $chardiff .= Linker
::formatRevisionSize( $row->rev_len
);
486 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
489 if ( isset( $this->mParentLens
[$row->rev_parent_id
] ) ) {
490 $parentLen = $this->mParentLens
[$row->rev_parent_id
];
493 $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
494 $chardiff .= ChangesList
::showCharacterDifference(
499 $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
502 $lang = $this->getLanguage();
503 $comment = $lang->getDirMark() . Linker
::revComment( $rev, false, true );
504 $date = $lang->userTimeAndDate( $row->rev_timestamp
, $user );
505 if ( $rev->userCan( Revision
::DELETED_TEXT
, $user ) ) {
506 $d = $linkRenderer->makeKnownLink(
509 [ 'class' => 'mw-changeslist-date' ],
510 [ 'oldid' => intval( $row->rev_id
) ]
513 $d = htmlspecialchars( $date );
515 if ( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
516 $d = '<span class="history-deleted">' . $d . '</span>';
519 # Show user names for /newbies as there may be different users.
520 # Note that only unprivileged users have rows with hidden user names excluded.
521 # When querying for an IP range, we want to always show user and user talk links.
523 if ( ( $this->contribs
== 'newbie' && !$rev->isDeleted( Revision
::DELETED_USER
) )
524 ||
$this->isQueryableRange( $this->target
) ) {
525 $userlink = ' . . ' . $lang->getDirMark()
526 . Linker
::userLink( $rev->getUser(), $rev->getUserText() );
527 $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
528 Linker
::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
532 if ( $rev->getParentId() === 0 ) {
533 $flags[] = ChangesList
::flag( 'newpage' );
536 if ( $rev->isMinor() ) {
537 $flags[] = ChangesList
::flag( 'minor' );
540 $del = Linker
::getRevDeleteLink( $user, $rev, $page );
545 $diffHistLinks = $this->msg( 'parentheses' )
546 ->rawParams( $difftext . $this->messages
['pipe-separator'] . $histlink )
550 list( $tagSummary, $newClasses ) = ChangeTags
::formatSummaryRow(
555 $classes = array_merge( $classes, $newClasses );
557 Hooks
::run( 'SpecialContributions::formatRow::flags', [ $this->getContext(), $row, &$flags ] );
562 'diffHistLinks' => $diffHistLinks,
563 'charDifference' => $chardiff,
565 'articleLink' => $link,
566 'userlink' => $userlink,
567 'logText' => $comment,
568 'topmarktext' => $topmarktext,
569 'tagSummary' => $tagSummary,
572 # Denote if username is redacted for this edit
573 if ( $rev->isDeleted( Revision
::DELETED_USER
) ) {
574 $templateParams['rev-deleted-user-contribs'] =
575 $this->msg( 'rev-deleted-user-contribs' )->escaped();
578 $ret = $this->templateParser
->processTemplate(
579 'SpecialContributionsLine',
584 // Let extensions add data
585 Hooks
::run( 'ContributionsLineEnding', [ $this, &$ret, $row, &$classes, &$attribs ] );
586 $attribs = wfArrayFilterByKey( $attribs, [ Sanitizer
::class, 'isReservedDataAttribute' ] );
588 // TODO: Handle exceptions in the catch block above. Do any extensions rely on
589 // receiving empty rows?
591 if ( $classes === [] && $attribs === [] && $ret === '' ) {
592 wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
593 return "<!-- Could not format Special:Contribution row. -->\n";
595 $attribs['class'] = $classes;
597 // FIXME: The signature of the ContributionsLineEnding hook makes it
598 // very awkward to move this LI wrapper into the template.
599 return Html
::rawElement( 'li', $attribs, $ret ) . "\n";
603 * Overwrite Pager function and return a helpful comment
606 function getSqlComment() {
607 if ( $this->namespace ||
$this->deletedOnly
) {
608 // potentially slow, see CR r58153
609 return 'contributions page filtered for namespace or RevisionDeleted edits';
611 return 'contributions page unfiltered';
615 protected function preventClickjacking() {
616 $this->preventClickjacking
= true;
622 public function getPreventClickjacking() {
623 return $this->preventClickjacking
;
627 * Set up date filter options, given request data.
629 * @param array $opts Options array
630 * @return array Options array with processed start and end date filter options
632 public static function processDateFilter( array $opts ) {
633 $start = isset( $opts['start'] ) ?
$opts['start'] : '';
634 $end = isset( $opts['end'] ) ?
$opts['end'] : '';
635 $year = isset( $opts['year'] ) ?
$opts['year'] : '';
636 $month = isset( $opts['month'] ) ?
$opts['month'] : '';
638 if ( $start !== '' && $end !== '' && $start > $end ) {
644 // If year/month legacy filtering options are set, convert them to display the new stamp
645 if ( $year !== '' ||
$month !== '' ) {
646 // Reuse getDateCond logic, but subtract a day because
647 // the endpoints of our date range appear inclusive
648 // but the internal end offsets are always exclusive
649 $legacyTimestamp = ReverseChronologicalPager
::getOffsetDate( $year, $month );
650 $legacyDateTime = new DateTime( $legacyTimestamp->getTimestamp( TS_ISO_8601
) );
651 $legacyDateTime = $legacyDateTime->modify( '-1 day' );
653 // Clear the new timestamp range options if used and
654 // replace with the converted legacy timestamp
656 $end = $legacyDateTime->format( 'Y-m-d' );
659 $opts['start'] = $start;