ContributionsPager.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Pager;
 
use InvalidArgumentException;
use MediaWiki\ChangeTags\ChangeTagsFormatter;
use MediaWiki\CommentFormatter\CommentFormatter;
use MediaWiki\Context\IContextSource;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Html\Html;
use MediaWiki\Html\TemplateParser;
use MediaWiki\Linker\Linker;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\LinkBatchFactory;
use MediaWiki\Parser\Sanitizer;
use MediaWiki\RecentChanges\ChangesList;
use MediaWiki\RecentChanges\ChangeTools\ChangeToolsFactory;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\RevisionStore;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Title\NamespaceInfo;
use MediaWiki\Title\Title;
use MediaWiki\User\UserFactory;
use MediaWiki\User\UserIdentity;
use MediaWiki\User\UserRigorOptions;
use stdClass;
use Wikimedia\HtmlArmor\HtmlArmor;
use Wikimedia\ObjectCache\MapCacheLRU;
use Wikimedia\Rdbms\FakeResultWrapper;
use Wikimedia\Rdbms\IResultWrapper;
 
abstract class ContributionsPager extends RangeChronologicalPager {
 
    public $mGroupByDate = true;
 
    protected $messages;
 
    protected $isArchive;
 
    protected $runHooks;
 
    protected $target;
 
    private $namespace;
 
    private $tagFilter;
 
    private bool $tagInvert;
 
    private bool $nsInvert;
 
    private bool $associated;
 
    private bool $deletedOnly;
 
    private bool $topOnly;
 
    private bool $newOnly;
 
    private bool $hideMinor;
 
    private bool $revisionsOnly;
 
    private $preventClickjacking = false;
 
    protected ?Title $currentPage;
    protected ?RevisionRecord $currentRevRecord;
 
    private $mParentLens;
 
    protected $targetUser;
 
    private $hasMultipleContributors;
 
    protected TemplateParser $templateParser;
 
    private CommentFormatter $commentFormatter;
    private HookRunner $hookRunner;
    private LinkBatchFactory $linkBatchFactory;
    protected NamespaceInfo $namespaceInfo;
    protected RevisionStore $revisionStore;
    protected readonly ChangeToolsFactory $changeToolsFactory;
    private readonly ChangeTagsFormatter $changeTagsFormatter;
 
    private $formattedComments = [];
 
    private $revisions = [];
 
    private $tagsCache;
 
    protected string $revisionIdField = 'rev_id';
    protected string $revisionParentIdField = 'rev_parent_id';
    protected string $revisionTimestampField = 'rev_timestamp';
    protected string $revisionLengthField = 'rev_len';
    protected string $revisionDeletedField = 'rev_deleted';
    protected string $revisionMinorField = 'rev_minor_edit';
    protected string $userNameField = 'rev_user_text';
    protected string $pageNamespaceField = 'page_namespace';
    protected string $pageTitleField = 'page_title';
 
    public function __construct(
        LinkRenderer $linkRenderer,
        LinkBatchFactory $linkBatchFactory,
        HookContainer $hookContainer,
        RevisionStore $revisionStore,
        NamespaceInfo $namespaceInfo,
        CommentFormatter $commentFormatter,
        UserFactory $userFactory,
        IContextSource $context,
        array $options,
        ?UserIdentity $targetUser,
        ?ChangeToolsFactory $changeToolsFactory = null,
        ?ChangeTagsFormatter $changeTagsFormatter = null,
    ) {
        $this->isArchive = $options['isArchive'] ?? false;
        $this->runHooks = $options['runHooks'] ?? true;
 
        // Set ->target before calling parent::__construct() so
        // parent can call $this->getIndexField() and get the right result. Set
        // the rest too just to keep things simple.
        if ( $targetUser ) {
            $this->target = $options['target'] ?? $targetUser->getName();
            $this->targetUser = $targetUser;
        } else {
            // Use target option
            // It's possible for the target to be empty. This is used by
            // ContribsPagerTest and does not cause newFromName() to return
            // false. It's probably not used by any production code.
            $this->target = $options['target'] ?? '';
            // @phan-suppress-next-line PhanPossiblyNullTypeMismatchProperty RIGOR_NONE never returns null
            $this->targetUser = $userFactory->newFromName(
                $this->target, UserRigorOptions::RIGOR_NONE
            );
            if ( !$this->targetUser ) {
                // This can happen if the target contained "#". Callers
                // typically pass user input through title normalization to
                // avoid it.
                throw new InvalidArgumentException( __METHOD__ . ': the user name is too ' .
                    'broken to use even with validation disabled.' );
            }
        }
 
        $this->namespace = $options['namespace'] ?? '';
        $this->tagFilter = $options['tagfilter'] ?? false;
        $this->tagInvert = $options['tagInvert'] ?? false;
        $this->nsInvert = $options['nsInvert'] ?? false;
        $this->associated = $options['associated'] ?? false;
 
        $this->deletedOnly = !empty( $options['deletedOnly'] );
        $this->topOnly = !empty( $options['topOnly'] );
        $this->newOnly = !empty( $options['newOnly'] );
        $this->hideMinor = !empty( $options['hideMinor'] );
        $this->revisionsOnly = !empty( $options['revisionsOnly'] );
 
        parent::__construct( $context, $linkRenderer );
 
        $msgs = [
            'diff',
            'hist',
            'pipe-separator',
            'uctop',
            'changeslist-nocomment',
            'undeleteviewlink',
            'undeleteviewlink',
            'deletionlog',
        ];
 
        foreach ( $msgs as $msg ) {
            $this->messages[$msg] = $this->msg( $msg )->escaped();
        }
 
        // Date filtering: use timestamp if available
        $startTimestamp = '';
        $endTimestamp = '';
        if ( isset( $options['start'] ) && $options['start'] ) {
            $startTimestamp = $options['start'] . ' 00:00:00';
        }
        if ( isset( $options['end'] ) && $options['end'] ) {
            $endTimestamp = $options['end'] . ' 23:59:59';
        }
        $this->getDateRangeCond( $startTimestamp, $endTimestamp );
 
        $this->templateParser = new TemplateParser();
        $this->linkBatchFactory = $linkBatchFactory;
        $this->hookRunner = new HookRunner( $hookContainer );
        $this->revisionStore = $revisionStore;
        $this->changeToolsFactory = $changeToolsFactory ?? MediaWikiServices::getInstance()->getChangeToolsFactory();
        $this->changeTagsFormatter = $changeTagsFormatter ?? MediaWikiServices::getInstance()->getChangeTagsFormatter();
        $this->namespaceInfo = $namespaceInfo;
        $this->commentFormatter = $commentFormatter;
        $this->tagsCache = new MapCacheLRU( 50 );
    }
 
    public function getDefaultQuery() {
        $query = parent::getDefaultQuery();
        $query['target'] = $this->target;
 
        return $query;
    }
 
    public function reallyDoQuery( $offset, $limit, $order ) {
        [ $tables, $fields, $conds, $fname, $options, $join_conds ] = $this->buildQueryInfo(
            $offset,
            $limit,
            $order
        );
 
        $options['MAX_EXECUTION_TIME'] =
            $this->getConfig()->get( MainConfigNames::MaxExecutionTimeForExpensiveQueries );
        /*
         * This hook will allow extensions to add in additional queries, so they can get their data
         * in My Contributions as well. Extensions should append their results to the $data array.
         *
         * Extension queries have to implement the navbar requirement as well. They should
         * - have a column aliased as $pager->getIndexField()
         * - have LIMIT set
         * - have a WHERE-clause that compares the $pager->getIndexField()-equivalent column to the offset
         * - have the ORDER BY specified based upon the details provided by the navbar
         *
         * See includes/Pager.php buildQueryInfo() method on how to build LIMIT, WHERE & ORDER BY
         *
         * &$data: an array of results of all contribs queries
         * $pager: the ContribsPager object hooked into
         * $offset: see phpdoc above
         * $limit: see phpdoc above
         * $descending: see phpdoc above
         */
        $dbr = $this->getDatabase();
        $data = [ $dbr->newSelectQueryBuilder()
            ->tables( is_array( $tables ) ? $tables : [ $tables ] )
            ->fields( $fields )
            ->conds( $conds )
            ->caller( $fname )
            ->options( $options )
            ->joinConds( $join_conds )
            ->setMaxExecutionTime( $this->getConfig()->get( MainConfigNames::MaxExecutionTimeForExpensiveQueries ) )
            ->fetchResultSet() ];
        if ( !$this->revisionsOnly && $this->runHooks ) {
            // These hooks were moved from ContribsPager and DeletedContribsPager. For backwards
            // compatibility, they keep the same names. But they should be run for any contributions
            // pager, otherwise the entries from extensions would be missing.
            $reallyDoQueryHook = $this->isArchive ?
                'onDeletedContribsPager__reallyDoQuery' :
                'onContribsPager__reallyDoQuery';
            // TODO: Range offsets are fairly important and all handlers should take care of it.
            // If this hook will be replaced (e.g. unified with the DeletedContribsPager one),
            // please consider passing [ $this->endOffset, $this->startOffset ] to it (T167577).
            $this->hookRunner->$reallyDoQueryHook( $data, $this, $offset, $limit, $order );
        }
 
        $result = [];
 
        // Keep track of contributors, to check for multiple contributors
        $previousContributor = null;
 
        // loop all results and collect them in an array
        foreach ( $data as $query ) {
            foreach ( $query as $i => $row ) {
                // If the query results are in descending order, the indexes must also be in descending order
                $index = $order === self::QUERY_ASCENDING ? $i : $limit - 1 - $i;
                // Left-pad with zeroes, because these values will be sorted as strings
                $index = str_pad( (string)$index, strlen( (string)$limit ), '0', STR_PAD_LEFT );
                // use index column as key, allowing us to easily sort in PHP
                $indexFieldValues = array_map(
                    static fn ( $fieldName ) => $row->$fieldName,
                    (array)$this->mIndexField
                );
                $result[implode( '-', $indexFieldValues ) . "-$index"] = $row;
                // Check for multiple contributors
                if ( !$this->hasMultipleContributors && isset( $row->rev_user_text ) ) {
                    $previousContributor ??= $row->rev_user_text;
                    $this->hasMultipleContributors = $previousContributor !== $row->rev_user_text;
                }
            }
        }
 
        // sort results
        if ( $order === self::QUERY_ASCENDING ) {
            ksort( $result );
        } else {
            krsort( $result );
        }
 
        // enforce limit
        $result = array_slice( $result, 0, $limit );
 
        // get rid of array keys
        $result = array_values( $result );
 
        return new FakeResultWrapper( $result );
    }
 
    abstract protected function getRevisionQuery();
 
    public function getQueryInfo() {
        $queryInfo = $this->getRevisionQuery();
 
        if ( $this->deletedOnly ) {
            $queryInfo['conds'][] = $this->revisionDeletedField . ' != 0';
        }
 
        if ( !$this->isArchive && $this->topOnly ) {
            $queryInfo['conds'][] = $this->revisionIdField . ' = page_latest';
        }
 
        if ( $this->newOnly ) {
            $queryInfo['conds'][] = $this->revisionParentIdField . ' = 0';
        }
 
        if ( $this->hideMinor ) {
            $queryInfo['conds'][] = $this->revisionMinorField . ' = 0';
        }
 
        $queryInfo['conds'] = array_merge( $queryInfo['conds'], $this->getNamespaceCond() );
 
        // Paranoia: avoid brute force searches (T19342)
        $dbr = $this->getDatabase();
        if ( !$this->getAuthority()->isAllowed( 'deletedhistory' ) ) {
            $queryInfo['conds'][] = $dbr->bitAnd(
                $this->revisionDeletedField, RevisionRecord::DELETED_USER
                ) . ' = 0';
        } elseif ( !$this->getAuthority()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
            $queryInfo['conds'][] = $dbr->bitAnd(
                $this->revisionDeletedField, RevisionRecord::SUPPRESSED_USER
                ) . ' != ' . RevisionRecord::SUPPRESSED_USER;
        }
 
        // Index fields must be present in the result rows, as reallyDoQuery() tries to access them.
        $indexFields = array_diff(
            (array)$this->mIndexField,
            $queryInfo['fields']
        );
 
        foreach ( $indexFields as $indexField ) {
            // Skip if already added as an alias
            if ( !array_key_exists( $indexField, $queryInfo['fields'] ) ) {
                $queryInfo['fields'][] = $indexField;
            }
        }
 
        $this->modifyQueryInfoWithTagFilter( $queryInfo );
 
        if ( !$this->isArchive && $this->runHooks ) {
            $this->hookRunner->onContribsPager__getQueryInfo( $this, $queryInfo );
        }
 
        return $queryInfo;
    }
 
    protected function modifyQueryInfoWithTagFilter( array &$queryInfo ): void {
        $queryBuilder = $this->getDatabase()->newSelectQueryBuilder()->queryInfo( $queryInfo );
        MediaWikiServices::getInstance()->getChangeTagsStore()->addTagsToDisplayQuery(
            $queryBuilder,
            $this->isArchive ? 'archive' : 'revision',
            $this->getAuthority(),
            $this->tagFilter === false ? '' : $this->tagFilter,
            $this->tagInvert
        );
        $queryInfo = $queryBuilder->getQueryInfo( 'join_conds' );
    }
 
    protected function getNamespaceCond(): array {
        if ( $this->namespace !== '' ) {
            $dbr = $this->getDatabase();
            $namespaces = [ $this->namespace ];
            $eq_op = $this->nsInvert ? '!=' : '=';
            if ( $this->associated ) {
                $namespaces[] = $this->namespaceInfo->getAssociated( $this->namespace );
            }
            return [ $dbr->expr( $this->pageNamespaceField, $eq_op, $namespaces ) ];
        }
 
        return [];
    }
 
    public function getTagFilter() {
        return $this->tagFilter;
    }
 
    public function getTagInvert() {
        return $this->tagInvert;
    }
 
    public function getTarget() {
        return $this->target;
    }
 
    public function isNewOnly() {
        return $this->newOnly;
    }
 
    public function getNamespace() {
        return $this->namespace;
    }
 
    public function hasAppliedFilters(): bool {
        return $this->startOffset || $this->endOffset || $this->namespace !== '' || $this->tagFilter ||
            $this->deletedOnly || $this->newOnly || $this->hideMinor || $this->topOnly;
    }
 
    protected function doBatchLookups() {
        # Do a link batch query
        $this->mResult->seek( 0 );
        $parentRevIds = [];
        $this->mParentLens = [];
        $revisions = [];
        $linkBatch = $this->linkBatchFactory->newLinkBatch();
        # Give some pointers to make (last) links
        foreach ( $this->mResult as $row ) {
            $revisionRecord = $this->tryCreatingRevisionRecord( $row );
            if ( !$revisionRecord ) {
                continue;
            }
            if ( isset( $row->{$this->revisionParentIdField} ) && $row->{$this->revisionParentIdField} ) {
                $parentRevIds[] = (int)$row->{$this->revisionParentIdField};
            }
            $this->mParentLens[(int)$row->{$this->revisionIdField}] = $row->{$this->revisionLengthField};
            if ( $this->target !== $row->{$this->userNameField} ) {
                // If the target does not match the author, batch the author's talk page
                $linkBatch->add( NS_USER_TALK, $row->{$this->userNameField} );
            }
            $linkBatch->add( $row->{$this->pageNamespaceField}, $row->{$this->pageTitleField} );
            $revisions[$row->{$this->revisionIdField}] = $this->createRevisionRecord( $row );
        }
        // Fetch rev_len/ar_len for revisions not already scanned above
        // TODO: is it possible to make this fully abstract?
        if ( $this->isArchive ) {
            $parentRevIds = array_diff( $parentRevIds, array_keys( $this->mParentLens ) );
            if ( $parentRevIds ) {
                $result = $this->revisionStore
                    ->newArchiveSelectQueryBuilder( $this->getDatabase() )
                    ->clearFields()
                    ->fields( [ $this->revisionIdField, $this->revisionLengthField ] )
                    ->where( [ $this->revisionIdField => $parentRevIds ] )
                    ->caller( __METHOD__ )
                    ->fetchResultSet();
                foreach ( $result as $row ) {
                    $this->mParentLens[(int)$row->{$this->revisionIdField}] = $row->{$this->revisionLengthField};
                }
            }
        }
        $this->mParentLens += $this->revisionStore->getRevisionSizes(
            array_diff( $parentRevIds, array_keys( $this->mParentLens ) )
        );
        $linkBatch->execute();
 
        $revisionBatch = $this->commentFormatter->createRevisionBatch()
            ->authority( $this->getAuthority() )
            ->revisions( $revisions );
 
        if ( !$this->isArchive ) {
            // Only show public comments, because this page might be public
            $revisionBatch = $revisionBatch->hideIfDeleted();
        }
 
        $this->formattedComments = $revisionBatch->execute();
 
        # For performance, save the revision objects for later.
        # The array is indexed by rev_id. doBatchLookups() may be called
        # multiple times with different results, so merge the revisions array,
        # ignoring any duplicates.
        $this->revisions += $revisions;
    }
 
    protected function getStartBody() {
        return "<section class='mw-pager-body'>\n";
    }
 
    protected function getEndBody() {
        return "</section>\n";
    }
 
    protected function getEmptyBody() {
        return $this->msg( 'nocontribs' )->parse();
    }
 
    public function tryCreatingRevisionRecord( $row, $title = null ) {
        if ( $row instanceof stdClass && isset( $row->{$this->revisionIdField} )
            && isset( $this->revisions[$row->{$this->revisionIdField}] )
        ) {
            return $this->revisions[$row->{$this->revisionIdField}];
        }
 
        if (
            $this->isArchive &&
            $this->revisionStore->isRevisionRow( $row, 'archive' )
        ) {
            return $this->revisionStore->newRevisionFromArchiveRow( $row, 0, $title );
        }
 
        if (
            !$this->isArchive &&
            $this->revisionStore->isRevisionRow( $row )
        ) {
            return $this->revisionStore->newRevisionFromRow( $row, 0, $title );
        }
 
        return null;
    }
 
    public function createRevisionRecord( $row, $title = null ) {
        if ( $this->isArchive ) {
            return $this->revisionStore->newRevisionFromArchiveRow( $row, 0, $title );
        }
 
        return $this->revisionStore->newRevisionFromRow( $row, 0, $title );
    }
 
    protected function populateAttributes( $row, &$attributes ) {
        $attributes['data-mw-revid'] = $this->currentRevRecord->getId();
        $timestamp = $this->currentRevRecord?->getTimestamp();
        if ( $timestamp ) {
            $attributes['data-mw-ts'] = $timestamp;
        }
    }
 
    protected function formatArticleLink( $row ) {
        if ( !$this->currentPage ) {
            return '';
        }
        $dir = $this->getLanguage()->getDir();
        return Html::rawElement( 'bdi', [ 'dir' => $dir ], $this->getLinkRenderer()->makeLink(
            $this->currentPage,
            $this->currentPage->getPrefixedText(),
            [ 'class' => 'mw-contributions-title' ],
            $this->currentPage->isRedirect() ? [ 'redirect' => 'no' ] : []
        ) );
    }
 
    protected function formatDiffHistLinks( $row ) {
        if ( !$this->currentPage || !$this->currentRevRecord ) {
            return '';
        }
        if ( $this->isArchive ) {
            // Add the same links as DeletedContribsPager::formatRevisionRow
            $undelete = SpecialPage::getTitleFor( 'Undelete' );
            if ( $this->getAuthority()->isAllowed( 'deletedtext' ) ) {
                $last = $this->getLinkRenderer()->makeKnownLink(
                    $undelete,
                    new HtmlArmor( $this->messages['diff'] ),
                    [],
                    [
                        'target' => $this->currentPage->getPrefixedText(),
                        'timestamp' => $this->currentRevRecord->getTimestamp(),
                        'diff' => 'prev'
                    ]
                );
            } else {
                $last = $this->messages['diff'];
            }
 
            $logs = SpecialPage::getTitleFor( 'Log' );
            $dellog = $this->getLinkRenderer()->makeKnownLink(
                $logs,
                new HtmlArmor( $this->messages['deletionlog'] ),
                [],
                [
                    'type' => 'delete',
                    'page' => $this->currentPage->getPrefixedText()
                ]
            );
 
            $reviewlink = $this->getLinkRenderer()->makeKnownLink(
                SpecialPage::getTitleFor( 'Undelete', $this->currentPage->getPrefixedDBkey() ),
                new HtmlArmor( $this->messages['undeleteviewlink'] )
            );
 
            return Html::rawElement(
                'span',
                [ 'class' => 'mw-deletedcontribs-tools' ],
                $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList(
                    [ $last, $dellog, $reviewlink ] ) )->escaped()
            );
        } else {
            # Is there a visible previous revision?
            if ( $this->currentRevRecord->getParentId() !== 0 &&
                $this->currentRevRecord->userCan( RevisionRecord::DELETED_TEXT, $this->getAuthority() )
            ) {
                $difftext = $this->getLinkRenderer()->makeKnownLink(
                    $this->currentPage,
                    new HtmlArmor( $this->messages['diff'] ),
                    [ 'class' => 'mw-changeslist-diff' ],
                    [
                        'diff' => 'prev',
                        'oldid' => $row->{$this->revisionIdField},
                    ]
                );
            } else {
                $difftext = $this->messages['diff'];
            }
            $histlink = $this->getLinkRenderer()->makeKnownLink(
                $this->currentPage,
                new HtmlArmor( $this->messages['hist'] ),
                [ 'class' => 'mw-changeslist-history' ],
                [ 'action' => 'history' ]
            );
 
            // While it might be tempting to use a list here
            // this would result in clutter and slows down navigating the content
            // in assistive technology.
            // See https://phabricator.wikimedia.org/T205581#4734812
            return Html::rawElement( 'span',
                [ 'class' => 'mw-changeslist-links' ],
                // The spans are needed to ensure the dividing '|' elements are not
                // themselves styled as links.
                Html::rawElement( 'span', [], $difftext ) .
                ' ' . // Space needed for separating two words.
                Html::rawElement( 'span', [], $histlink )
            );
        }
    }
 
    protected function formatDateLink( $row ) {
        if ( !$this->currentPage || !$this->currentRevRecord ) {
            return '';
        }
        if ( $this->isArchive ) {
            $date = $this->getLanguage()->userTimeAndDate(
                $this->currentRevRecord->getTimestamp(),
                $this->getUser()
            );
 
            if ( $this->getAuthority()->isAllowed( 'undelete' ) &&
                $this->currentRevRecord->userCan( RevisionRecord::DELETED_TEXT, $this->getAuthority() )
            ) {
                $dateLink = $this->getLinkRenderer()->makeKnownLink(
                    SpecialPage::getTitleFor( 'Undelete' ),
                    $date,
                    [ 'class' => 'mw-changeslist-date' ],
                    [
                        'target' => $this->currentPage->getPrefixedText(),
                        'timestamp' => $this->currentRevRecord->getTimestamp()
                    ]
                );
            } else {
                $dateLink = htmlspecialchars( $date );
            }
            if ( $this->currentRevRecord->isDeleted( RevisionRecord::DELETED_TEXT ) ) {
                $class = Linker::getRevisionDeletedClass( $this->currentRevRecord );
                $dateLink = Html::rawElement(
                    'span',
                    [ 'class' => $class ],
                    $dateLink
                );
            }
        } else {
            $dateLink = ChangesList::revDateLink(
                $this->currentRevRecord,
                $this->getAuthority(),
                $this->getLanguage(),
                $this->currentPage
            );
        }
        return $dateLink;
    }
 
    protected function formatTopMarkText( $row, &$classes ) {
        if ( !$this->currentPage || !$this->currentRevRecord ) {
            return '';
        }
        $topmarktext = '';
        if ( !$this->isArchive ) {
            $changeTools = $this->changeToolsFactory->buildChangeTools(
                $this->currentRevRecord,
                null,
                $row->{$this->revisionIdField} === $row->page_latest && !$row->page_is_new,
                $this->getContext(),
            );
            if ( $row->{$this->revisionIdField} === $row->page_latest ) {
                $topmarktext .= '<span class="mw-uctop">' . $this->messages['uctop'] . '</span>';
                $classes[] = 'mw-contributions-current';
            }
            if ( $changeTools->shouldPreventClickjacking() ) {
                $this->setPreventClickjacking( true );
            }
            $topmarktext .= $changeTools->toHTML();
        }
        return $topmarktext;
    }
 
    protected function formatCharDiff( $row ) {
        if ( $row->{$this->revisionParentIdField} === null ) {
            // For some reason rev_parent_id isn't populated for this row.
            // Its rumoured this is true on wikipedia for some revisions (T36922).
            // Next best thing is to have the total number of bytes.
            $chardiff = ' <span class="mw-changeslist-separator"></span> ';
            $chardiff .= Linker::formatRevisionSize( $row->{$this->revisionLengthField} );
            $chardiff .= ' <span class="mw-changeslist-separator"></span> ';
        } else {
            $parentLen = $this->getParentRevisionSize( $row );
 
            $chardiff = ' <span class="mw-changeslist-separator"></span> ';
            $chardiff .= ChangesList::showCharacterDifference(
                $parentLen,
                $row->{$this->revisionLengthField},
                $this->getContext()
            );
            $chardiff .= ' <span class="mw-changeslist-separator"></span> ';
        }
        return $chardiff;
    }
 
    protected function getParentRevisionSize( $row ): int {
        return $this->mParentLens[$row->{$this->revisionParentIdField}] ?? 0;
    }
 
    protected function formatComment( $row ) {
        $comment = $this->formattedComments[$row->{$this->revisionIdField}];
 
        if ( $comment === '' ) {
            $defaultComment = $this->messages['changeslist-nocomment'];
            $comment = "<span class=\"comment mw-comment-none\">$defaultComment</span>";
        }
 
        // Don't wrap result of this with <bdi> or any other element, see T377555
        return $comment;
    }
 
    protected function formatUserLink( $row ) {
        if ( !$this->currentRevRecord ) {
            return '';
        }
        $dir = $this->getLanguage()->getDir();
 
        // When the author is different from the target, or there are multiple contributors,
        // always show user and user talk links
        $userlink = '';
        $revUser = $this->currentRevRecord->getUser();
        $revUserId = $revUser ? $revUser->getId() : 0;
        $revUserText = $revUser ? $revUser->getName() : '';
        if ( $this->hasMultipleContributors || $this->target !== $revUserText ) {
            $userPageLink = Linker::userLink( $revUserId, $revUserText );
            $userTalkLink = Linker::userTalkLink( $revUserId, $revUserText );
 
            $userlink = ' <span class="mw-changeslist-separator"></span> ' .
                Html::rawElement( 'bdi', [ 'dir' => $dir ], $userPageLink ) .
                Linker::renderUserToolLinksArray( [ $userTalkLink ], false );
        }
 
        return $userlink;
    }
 
    protected function formatFlags( $row ) {
        if ( !$this->currentRevRecord ) {
            return [];
        }
        $flags = [];
        if ( $this->currentRevRecord->getParentId() === 0 ) {
            $flags[] = ChangesList::flag( 'newpage', $this->getContext() );
        }
 
        if ( $this->currentRevRecord->isMinor() ) {
            $flags[] = ChangesList::flag( 'minor', $this->getContext() );
        }
        return $flags;
    }
 
    protected function formatVisibilityLink( $row ) {
        if ( !$this->currentPage || !$this->currentRevRecord ) {
            return '';
        }
        $del = Linker::getRevDeleteLink(
            $this->getAuthority(),
            $this->currentRevRecord,
            $this->currentPage
        );
        if ( $del !== '' ) {
            $del .= ' ';
        }
        return $del;
    }
 
    protected function formatTags( $row, &$classes ) {
        # Tags, if any. Save some time using a cache.
        [ $tagSummary, $newClasses ] = $this->tagsCache->getWithSetCallback(
            $this->tagsCache->makeKey(
                $row->ts_tags ?? '',
                $this->getUser()->getName(),
                $this->getLanguage()->getCode()
            ),
            fn () => $this->changeTagsFormatter->formatTagsAsSummaryList(
                $row->ts_tags,
                $this->getContext(),
                $this->getAuthority()
            )
        );
        $classes = array_merge( $classes, $newClasses );
        return $tagSummary;
    }
 
    public function revisionUserIsDeleted( $row ) {
        return $this->currentRevRecord->isDeleted( RevisionRecord::DELETED_USER );
    }
 
    public function formatRow( $row ) {
        $ret = '';
        $classes = [];
        $attribs = [];
 
        $this->currentPage = null;
        $this->currentRevRecord = null;
 
        // Create a title for the revision if possible
        // Rows from the hook may not include title information
        if ( isset( $row->{$this->pageNamespaceField} ) && isset( $row->{$this->pageTitleField} ) ) {
            $this->currentPage = Title::makeTitle( $row->{$this->pageNamespaceField}, $row->{$this->pageTitleField} );
        }
 
        // Flow overrides the ContribsPager::reallyDoQuery hook, causing this
        // function to be called with a special object for $row. It expects us
        // skip formatting so that the row can be formatted by the
        // ContributionsLineEnding hook below.
        // FIXME: have some better way for extensions to provide formatted rows.
        $this->currentRevRecord = $this->tryCreatingRevisionRecord( $row, $this->currentPage );
        if ( $this->revisionsOnly || ( $this->currentRevRecord && $this->currentPage ) ) {
            $this->populateAttributes( $row, $attribs );
 
            $templateParams = $this->getTemplateParams( $row, $classes );
            $ret = $this->getProcessedTemplate( $templateParams );
        }
 
        if ( $this->runHooks ) {
            // Let extensions add data
            $lineEndingsHook = $this->isArchive ?
                'onDeletedContributionsLineEnding' :
                'onContributionsLineEnding';
            $this->hookRunner->$lineEndingsHook( $this, $ret, $row, $classes, $attribs );
        }
 
        $attribs = array_filter( $attribs,
            Sanitizer::isReservedDataAttribute( ... ),
            ARRAY_FILTER_USE_KEY
        );
 
        // TODO: Handle exceptions in the catch block above.  Do any extensions rely on
        // receiving empty rows?
 
        if ( $classes === [] && $attribs === [] && $ret === '' ) {
            wfDebug( "Dropping ContributionsSpecialPage row that could not be formatted" );
            return "<!-- Could not format ContributionsSpecialPage row. -->\n";
        }
        $attribs['class'] = $classes;
 
        // FIXME: The signature of the ContributionsLineEnding hook makes it
        // very awkward to move this LI wrapper into the template.
        return Html::rawElement( 'li', $attribs, $ret ) . "\n";
    }
 
    public function getTemplateParams( $row, &$classes ) {
        $link = $this->formatArticleLink( $row );
        $topmarktext = $this->formatTopMarkText( $row, $classes );
        $diffHistLinks = $this->formatDiffHistLinks( $row );
        $dateLink = $this->formatDateLink( $row );
        $chardiff = $this->formatCharDiff( $row );
        $comment = $this->formatComment( $row );
        $userlink = $this->formatUserLink( $row );
        $flags = $this->formatFlags( $row );
        $del = $this->formatVisibilityLink( $row );
        $tagSummary = $this->formatTags( $row, $classes );
 
        if ( !$this->isArchive && $this->runHooks ) {
            $this->hookRunner->onSpecialContributions__formatRow__flags(
                $this->getContext(), $row, $flags );
        }
 
        $templateParams = [
            'del' => $del,
            'timestamp' => $dateLink,
            'diffHistLinks' => $diffHistLinks,
            'charDifference' => $chardiff,
            'flags' => $flags,
            'articleLink' => $link,
            'userlink' => $userlink,
            'logText' => $comment,
            'topmarktext' => $topmarktext,
            'tagSummary' => $tagSummary,
        ];
 
        # Denote if username is redacted for this edit
        if ( $this->revisionUserIsDeleted( $row ) ) {
            $templateParams['rev-deleted-user-contribs'] =
                $this->msg( 'rev-deleted-user-contribs' )->escaped();
        }
 
        return $templateParams;
    }
 
    public function getProcessedTemplate( $templateParams ) {
        return $this->templateParser->processTemplate(
            'SpecialContributionsLine',
            $templateParams
        );
    }
 
    protected function getSqlComment() {
        if ( $this->namespace || $this->deletedOnly ) {
            // potentially slow, see CR r58153
            return 'contributions page filtered for namespace or RevisionDeleted edits';
        } else {
            return 'contributions page unfiltered';
        }
    }
 
    protected function preventClickjacking() {
        $this->setPreventClickjacking( true );
    }
 
    protected function setPreventClickjacking( bool $enable ) {
        $this->preventClickjacking = $enable;
    }
 
    public function getPreventClickjacking() {
        return $this->preventClickjacking;
    }
 
}