ContributionsLookup.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Revision;
 
use ActorMigration;
use ChangeTags;
use ContribsPager;
use IContextSource;
use MediaWiki\Cache\LinkBatchFactory;
use MediaWiki\CommentFormatter\CommentFormatter;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\Linker\LinkRendererFactory;
use MediaWiki\Permissions\Authority;
use MediaWiki\Request\FauxRequest;
use MediaWiki\User\UserIdentity;
use Message;
use NamespaceInfo;
use RequestContext;
use Wikimedia\Rdbms\ILoadBalancer;
 
class ContributionsLookup {
 
    private $revisionStore;
 
    private $linkRendererFactory;
 
    private $linkBatchFactory;
 
    private $hookContainer;
 
    private $loadBalancer;
 
    private $actorMigration;
 
    private $namespaceInfo;
 
    private $commentFormatter;
 
    public function __construct(
        RevisionStore $revisionStore,
        LinkRendererFactory $linkRendererFactory,
        LinkBatchFactory $linkBatchFactory,
        HookContainer $hookContainer,
        ILoadBalancer $loadBalancer,
        ActorMigration $actorMigration,
        NamespaceInfo $namespaceInfo,
        CommentFormatter $commentFormatter
    ) {
        $this->revisionStore = $revisionStore;
        $this->linkRendererFactory = $linkRendererFactory;
        $this->linkBatchFactory = $linkBatchFactory;
        $this->hookContainer = $hookContainer;
        $this->loadBalancer = $loadBalancer;
        $this->actorMigration = $actorMigration;
        $this->namespaceInfo = $namespaceInfo;
        $this->commentFormatter = $commentFormatter;
    }
 
    private function getPagerParams( int $limit, string $segment ): array {
        $dir = 'next';
        $seg = explode( '|', $segment, 2 );
        if ( count( $seg ) > 1 ) {
            if ( $seg[0] === 'after' ) {
                $dir = 'prev';
                $segment = $seg[1];
            } elseif ( $seg[0] == 'before' ) {
                $segment = $seg[1];
            } else {
                $dir = null;
                $segment = null;
            }
        } else {
            $segment = null;
        }
        return [
            'limit' => $limit,
            'offset' => $segment,
            'dir' => $dir
        ];
    }
 
    public function getContributions(
        UserIdentity $target,
        int $limit,
        Authority $performer,
        string $segment = '',
        string $tag = null
    ): ContributionsSegment {
        $context = new RequestContext();
        $context->setAuthority( $performer );
 
        $paramArr = $this->getPagerParams( $limit, $segment );
        $context->setRequest( new FauxRequest( $paramArr ) );
 
        // TODO: explore moving this to factory method for testing
        $pager = $this->getContribsPager( $context, $target, [
            'tagfilter' => $tag,
            'revisionsOnly' => true
        ] );
        $revisions = [];
        $tags = [];
        $count = 0;
        if ( $pager->getNumRows() > 0 ) {
            foreach ( $pager->mResult as $row ) {
                // We retrieve and ignore one extra record to see if we are on the oldest segment.
                if ( ++$count > $limit ) {
                    break;
                }
 
                // TODO: pre-load title batch?
                $revision = $this->revisionStore->newRevisionFromRow( $row, 0 );
                $revisions[] = $revision;
                if ( $row->ts_tags ) {
                    $tagNames = explode( ',', $row->ts_tags );
                    $tags[ $row->rev_id ] = $this->getContributionTags( $tagNames );
                }
            }
        }
 
        $deltas = $this->getContributionDeltas( $revisions );
 
        $flags = [
            'newest' => $pager->mIsFirst,
            'oldest' => $pager->mIsLast,
        ];
 
        // TODO: Make me an option in IndexPager
        $pager->mIsFirst = false; // XXX: nasty...
        $pagingQueries = $pager->getPagingQueries();
 
        $prev = $pagingQueries['prev']['offset'] ?? null;
        $next = $pagingQueries['next']['offset'] ?? null;
 
        $after = $prev ? 'after|' . $prev : null; // later in time
        $before = $next ? 'before|' . $next : null; // earlier in time
 
        // TODO: Possibly return public $pager properties to segment for populating URLS ($mIsFirst, $mIsLast)
        // HACK: Force result set order to be descending. Sorting logic in ContribsPager::reallyDoQuery is confusing.
        if ( $paramArr['dir'] === 'prev' ) {
            $revisions = array_reverse( $revisions );
        }
        return new ContributionsSegment( $revisions, $tags, $before, $after, $deltas, $flags );
    }
 
    private function getContributionTags( array $tagNames ): array {
        $tagMetadata = [];
        foreach ( $tagNames as $name ) {
            $tagDisplay = ChangeTags::tagShortDescriptionMessage( $name, RequestContext::getMain() );
            if ( $tagDisplay ) {
                $tagMetadata[$name] = $tagDisplay;
            }
        }
        return $tagMetadata;
    }
 
    private function getContributionDeltas( $revisions ): array {
        // SpecialContributions uses the size of the revision if the parent revision is unknown. Cases include:
        // - revision has been deleted
        // - parent rev id has not been populated (this is the case for very old revisions)
        $parentIds = [];
        foreach ( $revisions as $revision ) {
            $revId = $revision->getId();
            $parentIds[$revId] = $revision->getParentId();
        }
        $parentSizes = $this->revisionStore->getRevisionSizes( $parentIds );
        $deltas = [];
        foreach ( $revisions as $revision ) {
            $parentId = $revision->getParentId();
            if ( $parentId === 0 ) { // first revision on a page
                $delta = $revision->getSize();
            } elseif ( !isset( $parentSizes[$parentId] ) ) { // parent revision is either deleted or untracked
                $delta = null;
            } else {
                $delta = $revision->getSize() - $parentSizes[$parentId];
            }
            $deltas[ $revision->getId() ] = $delta;
        }
        return $deltas;
    }
 
    public function getContributionCount( UserIdentity $user, Authority $performer, $tag = null ): int {
        $context = new RequestContext();
        $context->setAuthority( $performer );
        $context->setRequest( new FauxRequest( [] ) );
 
        // TODO: explore moving this to factory method for testing
        $pager = $this->getContribsPager( $context, $user, [
            'tagfilter' => $tag,
        ] );
 
        $query = $pager->getQueryInfo();
 
        $count = $pager->mDb->selectField(
            $query['tables'],
            'COUNT(*)',
            $query['conds'],
            __METHOD__,
            [],
            $query['join_conds']
        );
 
        return (int)$count;
    }
 
    private function getContribsPager(
        IContextSource $context,
        UserIdentity $targetUser,
        array $options
    ) {
        return new ContribsPager(
            $context,
            $options,
            $this->linkRendererFactory->create(),
            $this->linkBatchFactory,
            $this->hookContainer,
            $this->loadBalancer,
            $this->actorMigration,
            $this->revisionStore,
            $this->namespaceInfo,
            $targetUser,
            $this->commentFormatter
        );
    }
 
}