ContribsPager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Pager;
 
use DateTime;
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\CommentFormatter\CommentFormatter;
use MediaWiki\Config\Config;
use MediaWiki\Context\IContextSource;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionStore;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\User\UserIdentity;
use Wikimedia\IPUtils;
use Wikimedia\Rdbms\IConnectionProvider;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\IReadableDatabase;
 
class ContribsPager extends ContributionsPager {
 
    public function __construct(
        IContextSource $context,
        array $options,
        LinkRenderer $linkRenderer = null,
        LinkBatchFactory $linkBatchFactory = null,
        HookContainer $hookContainer = null,
        IConnectionProvider $dbProvider = null,
        RevisionStore $revisionStore = null,
        NamespaceInfo $namespaceInfo = null,
        UserIdentity $targetUser = null,
        CommentFormatter $commentFormatter = null
    ) {
        // Class is used directly in extensions - T266484
        $services = MediaWikiServices::getInstance();
        $dbProvider ??= $services->getConnectionProvider();
 
        parent::__construct(
            $linkRenderer ?? $services->getLinkRenderer(),
            $linkBatchFactory ?? $services->getLinkBatchFactory(),
            $hookContainer ?? $services->getHookContainer(),
            $revisionStore ?? $services->getRevisionStore(),
            $namespaceInfo ?? $services->getNamespaceInfo(),
            $commentFormatter ?? $services->getCommentFormatter(),
            $services->getUserFactory(),
            $context,
            $options,
            $targetUser
        );
    }
 
    private function getTargetTable() {
        $dbr = $this->getDatabase();
        $ipRangeConds = $this->targetUser->isRegistered()
            ? null : $this->getIpRangeConds( $dbr, $this->target );
        if ( $ipRangeConds ) {
            return 'ip_changes';
        }
 
        return 'revision';
    }
 
    protected function getRevisionQuery() {
        $revQuery = $this->revisionStore->getQueryInfo( [ 'page', 'user' ] );
        $queryInfo = [
            'tables' => $revQuery['tables'],
            'fields' => array_merge( $revQuery['fields'], [ 'page_is_new' ] ),
            'conds' => [],
            'options' => [],
            'join_conds' => $revQuery['joins'],
        ];
 
        // WARNING: Keep this in sync with getTargetTable()!
        $ipRangeConds = !$this->targetUser->isRegistered() ?
            $this->getIpRangeConds( $this->getDatabase(), $this->target ) :
            null;
        if ( $ipRangeConds ) {
            // Put ip_changes first (T284419)
            array_unshift( $queryInfo['tables'], 'ip_changes' );
            $queryInfo['join_conds']['revision'] = [
                'JOIN', [ 'rev_id = ipc_rev_id' ]
            ];
            $queryInfo['conds'][] = $ipRangeConds;
        } else {
            $queryInfo['conds']['actor_name'] = $this->targetUser->getName();
            // Force the appropriate index to avoid bad query plans (T307295)
            $queryInfo['options']['USE INDEX']['revision'] = 'rev_actor_timestamp';
        }
 
        return $queryInfo;
    }
 
    private function getIpRangeConds( $db, $ip ) {
        // First make sure it is a valid range and they are not outside the CIDR limit
        if ( !self::isQueryableRange( $ip, $this->getConfig() ) ) {
            return false;
        }
 
        [ $start, $end ] = IPUtils::parseRange( $ip );
 
        return $db->expr( 'ipc_hex', '>=', $start )->and( 'ipc_hex', '<=', $end );
    }
 
    public static function isQueryableRange( $ipRange, $config ) {
        $limits = $config->get( MainConfigNames::RangeContributionsCIDRLimit );
 
        $bits = IPUtils::parseCIDR( $ipRange )[1];
        if (
            ( $bits === false ) ||
            ( IPUtils::isIPv4( $ipRange ) && $bits < $limits['IPv4'] ) ||
            ( IPUtils::isIPv6( $ipRange ) && $bits < $limits['IPv6'] )
        ) {
            return false;
        }
 
        return true;
    }
 
    public function getIndexField() {
        // The returned column is used for sorting and continuation, so we need to
        // make sure to use the right denormalized column depending on which table is
        // being targeted by the query to avoid bad query plans.
        // See T200259, T204669, T220991, and T221380.
        $target = $this->getTargetTable();
        switch ( $target ) {
            case 'revision':
                return 'rev_timestamp';
            case 'ip_changes':
                return 'ipc_rev_timestamp';
            default:
                wfWarn(
                    __METHOD__ . ": Unknown value '$target' from " . static::class . '::getTargetTable()', 0
                );
                return 'rev_timestamp';
        }
    }
 
    protected function getExtraSortFields() {
        // The returned columns are used for sorting, so we need to make sure
        // to use the right denormalized column depending on which table is
        // being targeted by the query to avoid bad query plans.
        // See T200259, T204669, T220991, and T221380.
        $target = $this->getTargetTable();
        switch ( $target ) {
            case 'revision':
                return [ 'rev_id' ];
            case 'ip_changes':
                return [ 'ipc_rev_id' ];
            default:
                wfWarn(
                    __METHOD__ . ": Unknown value '$target' from " . static::class . '::getTargetTable()', 0
                );
                return [ 'rev_id' ];
        }
    }
 
    public static function processDateFilter( array $opts ) {
        $start = $opts['start'] ?? '';
        $end = $opts['end'] ?? '';
        $year = $opts['year'] ?? '';
        $month = $opts['month'] ?? '';
 
        if ( $start !== '' && $end !== '' && $start > $end ) {
            $temp = $start;
            $start = $end;
            $end = $temp;
        }
 
        // If year/month legacy filtering options are set, convert them to display the new stamp
        if ( $year !== '' || $month !== '' ) {
            // Reuse getDateCond logic, but subtract a day because
            // the endpoints of our date range appear inclusive
            // but the internal end offsets are always exclusive
            $legacyTimestamp = ReverseChronologicalPager::getOffsetDate( $year, $month );
            $legacyDateTime = new DateTime( $legacyTimestamp->getTimestamp( TS_ISO_8601 ) );
            $legacyDateTime = $legacyDateTime->modify( '-1 day' );
 
            // Clear the new timestamp range options if used and
            // replace with the converted legacy timestamp
            $start = '';
            $end = $legacyDateTime->format( 'Y-m-d' );
        }
 
        $opts['start'] = $start;
        $opts['end'] = $end;
 
        return $opts;
    }
}
 
class_alias( ContribsPager::class, 'ContribsPager' );