ContribsPager.php

Go to the documentation of this file.

<?php
class ContribsPager extends ReverseChronologicalPager {

    public $mDefaultDirection = IndexPager::DIR_DESCENDING;
    public $messages;
    public $target;
    public $namespace = '';
    public $mDb;
    public $preventClickjacking = false;

    public $mDbSecondary;

    protected $mParentLens;

    function __construct( IContextSource $context, array $options ) {
        parent::__construct( $context );

        $msgs = [
            'diff',
            'hist',
            'pipe-separator',
            'uctop'
        ];

        foreach ( $msgs as $msg ) {
            $this->messages[$msg] = $this->msg( $msg )->escaped();
        }

        $this->target = isset( $options['target'] ) ? $options['target'] : '';
        $this->contribs = isset( $options['contribs'] ) ? $options['contribs'] : 'users';
        $this->namespace = isset( $options['namespace'] ) ? $options['namespace'] : '';
        $this->tagFilter = isset( $options['tagfilter'] ) ? $options['tagfilter'] : false;
        $this->nsInvert = isset( $options['nsInvert'] ) ? $options['nsInvert'] : false;
        $this->associated = isset( $options['associated'] ) ? $options['associated'] : false;

        $this->deletedOnly = !empty( $options['deletedOnly'] );
        $this->topOnly = !empty( $options['topOnly'] );
        $this->newOnly = !empty( $options['newOnly'] );
        $this->hideMinor = !empty( $options['hideMinor'] );

        $year = isset( $options['year'] ) ? $options['year'] : false;
        $month = isset( $options['month'] ) ? $options['month'] : false;
        $this->getDateCond( $year, $month );

        // Most of this code will use the 'contributions' group DB, which can map to replica DBs
        // with extra user based indexes or partioning by user. The additional metadata
        // queries should use a regular replica DB since the lookup pattern is not all by user.
        $this->mDbSecondary = wfGetDB( DB_REPLICA ); // any random replica DB
        $this->mDb = wfGetDB( DB_REPLICA, 'contributions' );
    }

    function getDefaultQuery() {
        $query = parent::getDefaultQuery();
        $query['target'] = $this->target;

        return $query;
    }

    function reallyDoQuery( $offset, $limit, $descending ) {
        list( $tables, $fields, $conds, $fname, $options, $join_conds ) = $this->buildQueryInfo(
            $offset,
            $limit,
            $descending
        );

        /*
         * 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
         */
        $data = [ $this->mDb->select(
            $tables, $fields, $conds, $fname, $options, $join_conds
        ) ];
        Hooks::run(
            'ContribsPager::reallyDoQuery',
            [ &$data, $this, $offset, $limit, $descending ]
        );

        $result = [];

        // loop all results and collect them in an array
        foreach ( $data as $query ) {
            foreach ( $query as $i => $row ) {
                // use index column as key, allowing us to easily sort in PHP
                $result[$row->{$this->getIndexField()} . "-$i"] = $row;
            }
        }

        // sort results
        if ( $descending ) {
            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 );
    }

    function getQueryInfo() {
        list( $tables, $index, $userCond, $join_cond ) = $this->getUserCond();

        $user = $this->getUser();
        $conds = array_merge( $userCond, $this->getNamespaceCond() );

        // Paranoia: avoid brute force searches (bug 17342)
        if ( !$user->isAllowed( 'deletedhistory' ) ) {
            $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::DELETED_USER ) . ' = 0';
        } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
            $conds[] = $this->mDb->bitAnd( 'rev_deleted', Revision::SUPPRESSED_USER ) .
                ' != ' . Revision::SUPPRESSED_USER;
        }

        # Don't include orphaned revisions
        $join_cond['page'] = Revision::pageJoinCond();
        # Get the current user name for accounts
        $join_cond['user'] = Revision::userJoinCond();

        $options = [];
        if ( $index ) {
            $options['USE INDEX'] = [ 'revision' => $index ];
        }

        $queryInfo = [
            'tables' => $tables,
            'fields' => array_merge(
                Revision::selectFields(),
                Revision::selectUserFields(),
                [ 'page_namespace', 'page_title', 'page_is_new',
                    'page_latest', 'page_is_redirect', 'page_len' ]
            ),
            'conds' => $conds,
            'options' => $options,
            'join_conds' => $join_cond
        ];

        ChangeTags::modifyDisplayQuery(
            $queryInfo['tables'],
            $queryInfo['fields'],
            $queryInfo['conds'],
            $queryInfo['join_conds'],
            $queryInfo['options'],
            $this->tagFilter
        );

        Hooks::run( 'ContribsPager::getQueryInfo', [ &$this, &$queryInfo ] );

        return $queryInfo;
    }

    function getUserCond() {
        $condition = [];
        $join_conds = [];
        $tables = [ 'revision', 'page', 'user' ];
        $index = false;
        if ( $this->contribs == 'newbie' ) {
            $max = $this->mDb->selectField( 'user', 'max(user_id)', false, __METHOD__ );
            $condition[] = 'rev_user >' . (int)( $max - $max / 100 );
            # ignore local groups with the bot right
            # @todo FIXME: Global groups may have 'bot' rights
            $groupsWithBotPermission = User::getGroupsWithPermission( 'bot' );
            if ( count( $groupsWithBotPermission ) ) {
                $tables[] = 'user_groups';
                $condition[] = 'ug_group IS NULL';
                $join_conds['user_groups'] = [
                    'LEFT JOIN', [
                        'ug_user = rev_user',
                        'ug_group' => $groupsWithBotPermission
                    ]
                ];
            }
            // (T140537) Disallow looking too far in the past for 'newbies' queries. If the user requested
            // a timestamp offset far in the past such that there are no edits by users with user_ids in
            // the range, we would end up scanning all revisions from that offset until start of time.
            $condition[] = 'rev_timestamp > ' .
                $this->mDb->addQuotes( $this->mDb->timestamp( wfTimestamp() - 30 * 24 * 60 * 60 ) );
        } else {
            $uid = User::idFromName( $this->target );
            if ( $uid ) {
                $condition['rev_user'] = $uid;
                $index = 'user_timestamp';
            } else {
                $condition['rev_user_text'] = $this->target;
                $index = 'usertext_timestamp';
            }
        }

        if ( $this->deletedOnly ) {
            $condition[] = 'rev_deleted != 0';
        }

        if ( $this->topOnly ) {
            $condition[] = 'rev_id = page_latest';
        }

        if ( $this->newOnly ) {
            $condition[] = 'rev_parent_id = 0';
        }

        if ( $this->hideMinor ) {
            $condition[] = 'rev_minor_edit = 0';
        }

        return [ $tables, $index, $condition, $join_conds ];
    }

    function getNamespaceCond() {
        if ( $this->namespace !== '' ) {
            $selectedNS = $this->mDb->addQuotes( $this->namespace );
            $eq_op = $this->nsInvert ? '!=' : '=';
            $bool_op = $this->nsInvert ? 'AND' : 'OR';

            if ( !$this->associated ) {
                return [ "page_namespace $eq_op $selectedNS" ];
            }

            $associatedNS = $this->mDb->addQuotes(
                MWNamespace::getAssociated( $this->namespace )
            );

            return [
                "page_namespace $eq_op $selectedNS " .
                $bool_op .
                " page_namespace $eq_op $associatedNS"
            ];
        }

        return [];
    }

    function getIndexField() {
        return 'rev_timestamp';
    }

    function doBatchLookups() {
        # Do a link batch query
        $this->mResult->seek( 0 );
        $parentRevIds = [];
        $this->mParentLens = [];
        $batch = new LinkBatch();
        # Give some pointers to make (last) links
        foreach ( $this->mResult as $row ) {
            if ( isset( $row->rev_parent_id ) && $row->rev_parent_id ) {
                $parentRevIds[] = $row->rev_parent_id;
            }
            if ( isset( $row->rev_id ) ) {
                $this->mParentLens[$row->rev_id] = $row->rev_len;
                if ( $this->contribs === 'newbie' ) { // multiple users
                    $batch->add( NS_USER, $row->user_name );
                    $batch->add( NS_USER_TALK, $row->user_name );
                }
                $batch->add( $row->page_namespace, $row->page_title );
            }
        }
        # Fetch rev_len for revisions not already scanned above
        $this->mParentLens += Revision::getParentLengths(
            $this->mDbSecondary,
            array_diff( $parentRevIds, array_keys( $this->mParentLens ) )
        );
        $batch->execute();
        $this->mResult->seek( 0 );
    }

    function getStartBody() {
        return "<ul class=\"mw-contributions-list\">\n";
    }

    function getEndBody() {
        return "</ul>\n";
    }

    function formatRow( $row ) {

        $ret = '';
        $classes = [];

        /*
         * There may be more than just revision rows. To make sure that we'll only be processing
         * revisions here, let's _try_ to build a revision out of our row (without displaying
         * notices though) and then trying to grab data from the built object. If we succeed,
         * we're definitely dealing with revision data and we may proceed, if not, we'll leave it
         * to extensions to subscribe to the hook to parse the row.
         */
        MediaWiki\suppressWarnings();
        try {
            $rev = new Revision( $row );
            $validRevision = (bool)$rev->getId();
        } catch ( Exception $e ) {
            $validRevision = false;
        }
        MediaWiki\restoreWarnings();

        if ( $validRevision ) {
            $classes = [];

            $page = Title::newFromRow( $row );
            $link = Linker::link(
                $page,
                htmlspecialchars( $page->getPrefixedText() ),
                [ 'class' => 'mw-contributions-title' ],
                $page->isRedirect() ? [ 'redirect' => 'no' ] : []
            );
            # Mark current revisions
            $topmarktext = '';
            $user = $this->getUser();
            if ( $row->rev_id === $row->page_latest ) {
                $topmarktext .= '<span class="mw-uctop">' . $this->messages['uctop'] . '</span>';
                $classes[] = 'mw-contributions-current';
                # Add rollback link
                if ( !$row->page_is_new && $page->quickUserCan( 'rollback', $user )
                    && $page->quickUserCan( 'edit', $user )
                ) {
                    $this->preventClickjacking();
                    $topmarktext .= ' ' . Linker::generateRollback( $rev, $this->getContext() );
                }
            }
            # Is there a visible previous revision?
            if ( $rev->userCan( Revision::DELETED_TEXT, $user ) && $rev->getParentId() !== 0 ) {
                $difftext = Linker::linkKnown(
                    $page,
                    $this->messages['diff'],
                    [],
                    [
                        'diff' => 'prev',
                        'oldid' => $row->rev_id
                    ]
                );
            } else {
                $difftext = $this->messages['diff'];
            }
            $histlink = Linker::linkKnown(
                $page,
                $this->messages['hist'],
                [],
                [ 'action' => 'history' ]
            );

            if ( $row->rev_parent_id === null ) {
                // For some reason rev_parent_id isn't populated for this row.
                // Its rumoured this is true on wikipedia for some revisions (bug 34922).
                // Next best thing is to have the total number of bytes.
                $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
                $chardiff .= Linker::formatRevisionSize( $row->rev_len );
                $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
            } else {
                $parentLen = 0;
                if ( isset( $this->mParentLens[$row->rev_parent_id] ) ) {
                    $parentLen = $this->mParentLens[$row->rev_parent_id];
                }

                $chardiff = ' <span class="mw-changeslist-separator">. .</span> ';
                $chardiff .= ChangesList::showCharacterDifference(
                    $parentLen,
                    $row->rev_len,
                    $this->getContext()
                );
                $chardiff .= ' <span class="mw-changeslist-separator">. .</span> ';
            }

            $lang = $this->getLanguage();
            $comment = $lang->getDirMark() . Linker::revComment( $rev, false, true );
            $date = $lang->userTimeAndDate( $row->rev_timestamp, $user );
            if ( $rev->userCan( Revision::DELETED_TEXT, $user ) ) {
                $d = Linker::linkKnown(
                    $page,
                    htmlspecialchars( $date ),
                    [ 'class' => 'mw-changeslist-date' ],
                    [ 'oldid' => intval( $row->rev_id ) ]
                );
            } else {
                $d = htmlspecialchars( $date );
            }
            if ( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
                $d = '<span class="history-deleted">' . $d . '</span>';
            }

            # Show user names for /newbies as there may be different users.
            # Note that we already excluded rows with hidden user names.
            if ( $this->contribs == 'newbie' ) {
                $userlink = ' . . ' . $lang->getDirMark()
                    . Linker::userLink( $rev->getUser(), $rev->getUserText() );
                $userlink .= ' ' . $this->msg( 'parentheses' )->rawParams(
                        Linker::userTalkLink( $rev->getUser(), $rev->getUserText() ) )->escaped() . ' ';
            } else {
                $userlink = '';
            }

            $flags = [];
            if ( $rev->getParentId() === 0 ) {
                $flags[] = ChangesList::flag( 'newpage' );
            }

            if ( $rev->isMinor() ) {
                $flags[] = ChangesList::flag( 'minor' );
            }

            $del = Linker::getRevDeleteLink( $user, $rev, $page );
            if ( $del !== '' ) {
                $del .= ' ';
            }

            $diffHistLinks = $this->msg( 'parentheses' )
                ->rawParams( $difftext . $this->messages['pipe-separator'] . $histlink )
                ->escaped();

            # Tags, if any.
            list( $tagSummary, $newClasses ) = ChangeTags::formatSummaryRow(
                $row->ts_tags,
                'contributions',
                $this->getContext()
            );
            $classes = array_merge( $classes, $newClasses );

            Hooks::run( 'SpecialContributions::formatRow::flags', [ $this->getContext(), $row, &$flags ] );

            $templateParams = [
                'del' => $del,
                'timestamp' => $d,
                '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 ( $rev->isDeleted( Revision::DELETED_USER ) ) {
                $templateParams['rev-deleted-user-contribs'] =
                    $this->msg( 'rev-deleted-user-contribs' )->escaped();
            }

            $templateParser = new TemplateParser();
            $ret = $templateParser->processTemplate(
                'SpecialContributionsLine',
                $templateParams
            );
        }

        // Let extensions add data
        Hooks::run( 'ContributionsLineEnding', [ $this, &$ret, $row, &$classes ] );

        // TODO: Handle exceptions in the catch block above.  Do any extensions rely on
        // receiving empty rows?

        if ( $classes === [] && $ret === '' ) {
            wfDebug( "Dropping Special:Contribution row that could not be formatted\n" );
            return "<!-- Could not format Special:Contribution row. -->\n";
        }

        // FIXME: The signature of the ContributionsLineEnding hook makes it
        // very awkward to move this LI wrapper into the template.
        return Html::rawElement( 'li', [ 'class' => $classes ], $ret ) . "\n";
    }

    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->preventClickjacking = true;
    }

    public function getPreventClickjacking() {
        return $this->preventClickjacking;
    }
}