ApiQueryRevisions.php

Go to the documentation of this file.

<?php
class ApiQueryRevisions extends ApiQueryRevisionsBase {

    private $token = null;

    public function __construct( ApiQuery $query, $moduleName ) {
        parent::__construct( $query, $moduleName, 'rv' );
    }

    private $tokenFunctions;

    protected function getTokenFunctions() {
        // tokenname => function
        // function prototype is func($pageid, $title, $rev)
        // should return token or false

        // Don't call the hooks twice
        if ( isset( $this->tokenFunctions ) ) {
            return $this->tokenFunctions;
        }

        // If we're in a mode that breaks the same-origin policy, no tokens can
        // be obtained
        if ( $this->lacksSameOriginSecurity() ) {
            return [];
        }

        $this->tokenFunctions = [
            'rollback' => [ 'ApiQueryRevisions', 'getRollbackToken' ]
        ];
        Hooks::run( 'APIQueryRevisionsTokens', [ &$this->tokenFunctions ] );

        return $this->tokenFunctions;
    }

    public static function getRollbackToken( $pageid, $title, $rev ) {
        global $wgUser;
        if ( !$wgUser->isAllowed( 'rollback' ) ) {
            return false;
        }

        return $wgUser->getEditToken( 'rollback' );
    }

    protected function run( ApiPageSet $resultPageSet = null ) {
        $params = $this->extractRequestParams( false );

        // If any of those parameters are used, work in 'enumeration' mode.
        // Enum mode can only be used when exactly one page is provided.
        // Enumerating revisions on multiple pages make it extremely
        // difficult to manage continuations and require additional SQL indexes
        $enumRevMode = ( $params['user'] !== null || $params['excludeuser'] !== null ||
            $params['limit'] !== null || $params['startid'] !== null ||
            $params['endid'] !== null || $params['dir'] === 'newer' ||
            $params['start'] !== null || $params['end'] !== null );

        $pageSet = $this->getPageSet();
        $pageCount = $pageSet->getGoodTitleCount();
        $revCount = $pageSet->getRevisionCount();

        // Optimization -- nothing to do
        if ( $revCount === 0 && $pageCount === 0 ) {
            // Nothing to do
            return;
        }
        if ( $revCount > 0 && count( $pageSet->getLiveRevisionIDs() ) === 0 ) {
            // We're in revisions mode but all given revisions are deleted
            return;
        }

        if ( $revCount > 0 && $enumRevMode ) {
            $this->dieUsage(
                'The revids= parameter may not be used with the list options ' .
                    '(limit, startid, endid, dirNewer, start, end).',
                'revids'
            );
        }

        if ( $pageCount > 1 && $enumRevMode ) {
            $this->dieUsage(
                'titles, pageids or a generator was used to supply multiple pages, ' .
                    'but the limit, startid, endid, dirNewer, user, excludeuser, start ' .
                    'and end parameters may only be used on a single page.',
                'multpages'
            );
        }

        // In non-enum mode, rvlimit can't be directly used. Use the maximum
        // allowed value.
        if ( !$enumRevMode ) {
            $this->setParsedLimit = false;
            $params['limit'] = 'max';
        }

        $db = $this->getDB();
        $this->addTables( [ 'revision', 'page' ] );
        $this->addJoinConds(
            [ 'page' => [ 'INNER JOIN', [ 'page_id = rev_page' ] ] ]
        );

        if ( $resultPageSet === null ) {
            $this->parseParameters( $params );
            $this->token = $params['token'];
            $this->addFields( Revision::selectFields() );
            if ( $this->token !== null || $pageCount > 0 ) {
                $this->addFields( Revision::selectPageFields() );
            }
        } else {
            $this->limit = $this->getParameter( 'limit' ) ?: 10;
            $this->addFields( [ 'rev_id', 'rev_timestamp', 'rev_page' ] );
        }

        if ( $this->fld_tags ) {
            $this->addTables( 'tag_summary' );
            $this->addJoinConds(
                [ 'tag_summary' => [ 'LEFT JOIN', [ 'rev_id=ts_rev_id' ] ] ]
            );
            $this->addFields( 'ts_tags' );
        }

        if ( $params['tag'] !== null ) {
            $this->addTables( 'change_tag' );
            $this->addJoinConds(
                [ 'change_tag' => [ 'INNER JOIN', [ 'rev_id=ct_rev_id' ] ] ]
            );
            $this->addWhereFld( 'ct_tag', $params['tag'] );
        }

        if ( $this->fetchContent ) {
            // For each page we will request, the user must have read rights for that page
            $user = $this->getUser();
            foreach ( $pageSet->getGoodTitles() as $title ) {
                if ( !$title->userCan( 'read', $user ) ) {
                    $this->dieUsage(
                        'The current user is not allowed to read ' . $title->getPrefixedText(),
                        'accessdenied' );
                }
            }

            $this->addTables( 'text' );
            $this->addJoinConds(
                [ 'text' => [ 'INNER JOIN', [ 'rev_text_id=old_id' ] ] ]
            );
            $this->addFields( 'old_id' );
            $this->addFields( Revision::selectTextFields() );
        }

        // add user name, if needed
        if ( $this->fld_user ) {
            $this->addTables( 'user' );
            $this->addJoinConds( [ 'user' => Revision::userJoinCond() ] );
            $this->addFields( Revision::selectUserFields() );
        }

        if ( $enumRevMode ) {
            // Indexes targeted:
            //  page_timestamp if we don't have rvuser
            //  page_user_timestamp if we have a logged-in rvuser
            //  page_timestamp or usertext_timestamp if we have an IP rvuser

            // This is mostly to prevent parameter errors (and optimize SQL?)
            if ( $params['startid'] !== null && $params['start'] !== null ) {
                $this->dieUsage( 'start and startid cannot be used together', 'badparams' );
            }

            if ( $params['endid'] !== null && $params['end'] !== null ) {
                $this->dieUsage( 'end and endid cannot be used together', 'badparams' );
            }

            if ( $params['user'] !== null && $params['excludeuser'] !== null ) {
                $this->dieUsage( 'user and excludeuser cannot be used together', 'badparams' );
            }

            if ( $params['continue'] !== null ) {
                $cont = explode( '|', $params['continue'] );
                $this->dieContinueUsageIf( count( $cont ) != 2 );
                $op = ( $params['dir'] === 'newer' ? '>' : '<' );
                $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
                $continueId = (int)$cont[1];
                $this->dieContinueUsageIf( $continueId != $cont[1] );
                $this->addWhere( "rev_timestamp $op $continueTimestamp OR " .
                    "(rev_timestamp = $continueTimestamp AND " .
                    "rev_id $op= $continueId)"
                );
            }

            $this->addTimestampWhereRange( 'rev_timestamp', $params['dir'],
                $params['start'], $params['end'] );
            $this->addWhereRange( 'rev_id', $params['dir'],
                $params['startid'], $params['endid'] );

            // There is only one ID, use it
            $ids = array_keys( $pageSet->getGoodTitles() );
            $this->addWhereFld( 'rev_page', reset( $ids ) );

            if ( $params['user'] !== null ) {
                $user = User::newFromName( $params['user'] );
                if ( $user && $user->getId() > 0 ) {
                    $this->addWhereFld( 'rev_user', $user->getId() );
                } else {
                    $this->addWhereFld( 'rev_user_text', $params['user'] );
                }
            } elseif ( $params['excludeuser'] !== null ) {
                $user = User::newFromName( $params['excludeuser'] );
                if ( $user && $user->getId() > 0 ) {
                    $this->addWhere( 'rev_user != ' . $user->getId() );
                } else {
                    $this->addWhere( 'rev_user_text != ' .
                        $db->addQuotes( $params['excludeuser'] ) );
                }
            }
            if ( $params['user'] !== null || $params['excludeuser'] !== null ) {
                // Paranoia: avoid brute force searches (bug 17342)
                if ( !$this->getUser()->isAllowed( 'deletedhistory' ) ) {
                    $bitmask = Revision::DELETED_USER;
                } elseif ( !$this->getUser()->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
                    $bitmask = Revision::DELETED_USER | Revision::DELETED_RESTRICTED;
                } else {
                    $bitmask = 0;
                }
                if ( $bitmask ) {
                    $this->addWhere( $db->bitAnd( 'rev_deleted', $bitmask ) . " != $bitmask" );
                }
            }
        } elseif ( $revCount > 0 ) {
            // Always targets the PRIMARY index

            $revs = $pageSet->getLiveRevisionIDs();

            // Get all revision IDs
            $this->addWhereFld( 'rev_id', array_keys( $revs ) );

            if ( $params['continue'] !== null ) {
                $this->addWhere( 'rev_id >= ' . intval( $params['continue'] ) );
            }
            $this->addOption( 'ORDER BY', 'rev_id' );
        } elseif ( $pageCount > 0 ) {
            // Always targets the rev_page_id index

            $titles = $pageSet->getGoodTitles();

            // When working in multi-page non-enumeration mode,
            // limit to the latest revision only
            $this->addWhere( 'page_latest=rev_id' );

            // Get all page IDs
            $this->addWhereFld( 'page_id', array_keys( $titles ) );
            // Every time someone relies on equality propagation, god kills a kitten :)
            $this->addWhereFld( 'rev_page', array_keys( $titles ) );

            if ( $params['continue'] !== null ) {
                $cont = explode( '|', $params['continue'] );
                $this->dieContinueUsageIf( count( $cont ) != 2 );
                $pageid = intval( $cont[0] );
                $revid = intval( $cont[1] );
                $this->addWhere(
                    "rev_page > $pageid OR " .
                    "(rev_page = $pageid AND " .
                    "rev_id >= $revid)"
                );
            }
            $this->addOption( 'ORDER BY', [
                'rev_page',
                'rev_id'
            ] );
        } else {
            ApiBase::dieDebug( __METHOD__, 'param validation?' );
        }

        $this->addOption( 'LIMIT', $this->limit + 1 );

        $count = 0;
        $generated = [];
        $hookData = [];
        $res = $this->select( __METHOD__, [], $hookData );

        foreach ( $res as $row ) {
            if ( ++$count > $this->limit ) {
                // We've reached the one extra which shows that there are
                // additional pages to be had. Stop here...
                if ( $enumRevMode ) {
                    $this->setContinueEnumParameter( 'continue',
                        $row->rev_timestamp . '|' . intval( $row->rev_id ) );
                } elseif ( $revCount > 0 ) {
                    $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
                } else {
                    $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
                        '|' . intval( $row->rev_id ) );
                }
                break;
            }

            if ( $resultPageSet !== null ) {
                $generated[] = $row->rev_id;
            } else {
                $revision = new Revision( $row );
                $rev = $this->extractRevisionInfo( $revision, $row );

                if ( $this->token !== null ) {
                    $title = $revision->getTitle();
                    $tokenFunctions = $this->getTokenFunctions();
                    foreach ( $this->token as $t ) {
                        $val = call_user_func( $tokenFunctions[$t], $title->getArticleID(), $title, $revision );
                        if ( $val === false ) {
                            $this->setWarning( "Action '$t' is not allowed for the current user" );
                        } else {
                            $rev[$t . 'token'] = $val;
                        }
                    }
                }

                $fit = $this->processRow( $row, $rev, $hookData ) &&
                    $this->addPageSubItem( $row->rev_page, $rev, 'rev' );
                if ( !$fit ) {
                    if ( $enumRevMode ) {
                        $this->setContinueEnumParameter( 'continue',
                            $row->rev_timestamp . '|' . intval( $row->rev_id ) );
                    } elseif ( $revCount > 0 ) {
                        $this->setContinueEnumParameter( 'continue', intval( $row->rev_id ) );
                    } else {
                        $this->setContinueEnumParameter( 'continue', intval( $row->rev_page ) .
                            '|' . intval( $row->rev_id ) );
                    }
                    break;
                }
            }
        }

        if ( $resultPageSet !== null ) {
            $resultPageSet->populateFromRevisionIDs( $generated );
        }
    }

    public function getCacheMode( $params ) {
        if ( isset( $params['token'] ) ) {
            return 'private';
        }
        return parent::getCacheMode( $params );
    }

    public function getAllowedParams() {
        $ret = parent::getAllowedParams() + [
            'startid' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
            ],
            'endid' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
            ],
            'start' => [
                ApiBase::PARAM_TYPE => 'timestamp',
                ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
            ],
            'end' => [
                ApiBase::PARAM_TYPE => 'timestamp',
                ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
            ],
            'dir' => [
                ApiBase::PARAM_DFLT => 'older',
                ApiBase::PARAM_TYPE => [
                    'newer',
                    'older'
                ],
                ApiBase::PARAM_HELP_MSG => 'api-help-param-direction',
                ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
            ],
            'user' => [
                ApiBase::PARAM_TYPE => 'user',
                ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
            ],
            'excludeuser' => [
                ApiBase::PARAM_TYPE => 'user',
                ApiBase::PARAM_HELP_MSG_INFO => [ [ 'singlepageonly' ] ],
            ],
            'tag' => null,
            'token' => [
                ApiBase::PARAM_DEPRECATED => true,
                ApiBase::PARAM_TYPE => array_keys( $this->getTokenFunctions() ),
                ApiBase::PARAM_ISMULTI => true
            ],
            'continue' => [
                ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
            ],
        ];

        $ret['limit'][ApiBase::PARAM_HELP_MSG_INFO] = [ [ 'singlepageonly' ] ];

        return $ret;
    }

    protected function getExamplesMessages() {
        return [
            'action=query&prop=revisions&titles=API|Main%20Page&' .
                'rvprop=timestamp|user|comment|content'
                => 'apihelp-query+revisions-example-content',
            'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
                'rvprop=timestamp|user|comment'
                => 'apihelp-query+revisions-example-last5',
            'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
                'rvprop=timestamp|user|comment&rvdir=newer'
                => 'apihelp-query+revisions-example-first5',
            'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
                'rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z'
                => 'apihelp-query+revisions-example-first5-after',
            'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
                'rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1'
                => 'apihelp-query+revisions-example-first5-not-localhost',
            'action=query&prop=revisions&titles=Main%20Page&rvlimit=5&' .
                'rvprop=timestamp|user|comment&rvuser=MediaWiki%20default'
                => 'apihelp-query+revisions-example-first5-user',
        ];
    }

    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/API:Revisions';
    }
}