ApiRollback.php

Go to the documentation of this file.

<?php
class ApiRollback extends ApiBase {

    private $mTitleObj = null;

    private $mUser = null;

    public function execute() {
        $user = $this->getUser();
        $params = $this->extractRequestParams();

        // WikiPage::doRollback needs a Web UI token, so get one of those if we
        // validated based on an API rollback token.
        $token = $params['token'];
        if ( $user->matchEditToken( $token, 'rollback', $this->getRequest() ) ) {
            $token = $this->getUser()->getEditToken(
                $this->getWebUITokenSalt( $params ),
                $this->getRequest()
            );
        }

        $titleObj = $this->getRbTitle( $params );
        $pageObj = WikiPage::factory( $titleObj );
        $summary = $params['summary'];
        $details = array();
        $retval = $pageObj->doRollback(
            $this->getRbUser( $params ),
            $summary,
            $token,
            $params['markbot'],
            $details,
            $user
        );

        if ( $retval ) {
            // We don't care about multiple errors, just report one of them
            $this->dieUsageMsg( reset( $retval ) );
        }

        $watch = 'preferences';
        if ( isset( $params['watchlist'] ) ) {
            $watch = $params['watchlist'];
        }

        // Watch pages
        $this->setWatch( $watch, $titleObj, 'watchrollback' );

        $info = array(
            'title' => $titleObj->getPrefixedText(),
            'pageid' => intval( $details['current']->getPage() ),
            'summary' => $details['summary'],
            'revid' => intval( $details['newid'] ),
            'old_revid' => intval( $details['current']->getID() ),
            'last_revid' => intval( $details['target']->getID() )
        );

        $this->getResult()->addValue( null, $this->getModuleName(), $info );
    }

    public function mustBePosted() {
        return true;
    }

    public function isWriteMode() {
        return true;
    }

    public function getAllowedParams() {
        return array(
            'title' => null,
            'pageid' => array(
                ApiBase::PARAM_TYPE => 'integer'
            ),
            'user' => array(
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true
            ),
            'summary' => '',
            'markbot' => false,
            'watchlist' => array(
                ApiBase::PARAM_DFLT => 'preferences',
                ApiBase::PARAM_TYPE => array(
                    'watch',
                    'unwatch',
                    'preferences',
                    'nochange'
                ),
            ),
        );
    }

    public function getParamDescription() {
        $p = $this->getModulePrefix();

        return array(
            'title' => "Title of the page you want to roll back. Cannot be used together with {$p}pageid",
            'pageid' => "Page ID of the page you want to roll back. Cannot be used together with {$p}title",
            'user' => 'Name of the user whose edits are to be rolled back.',
            'token' => array(
                /* Standard description automatically prepended */
                'For compatibility, the token used in the web UI is also accepted.'
            ),
            'summary' => 'Custom edit summary. If empty, default summary will be used',
            'markbot' => 'Mark the reverted edits and the revert as bot edits',
            'watchlist' => 'Unconditionally add or remove the page from your watchlist, ' .
                'use preferences or do not change watch',
        );
    }

    public function getDescription() {
        return array(
            'Undo the last edit to the page. If the last user who edited the page made',
            'multiple edits in a row, they will all be rolled back.'
        );
    }

    public function needsToken() {
        return 'rollback';
    }

    protected function getWebUITokenSalt( array $params ) {
        return array(
            $this->getRbTitle( $params )->getPrefixedText(),
            $this->getRbUser( $params )
        );
    }

    private function getRbUser( array $params ) {
        if ( $this->mUser !== null ) {
            return $this->mUser;
        }

        // We need to be able to revert IPs, but getCanonicalName rejects them
        $this->mUser = User::isIP( $params['user'] )
            ? $params['user']
            : User::getCanonicalName( $params['user'] );
        if ( !$this->mUser ) {
            $this->dieUsageMsg( array( 'invaliduser', $params['user'] ) );
        }

        return $this->mUser;
    }

    private function getRbTitle( array $params ) {
        if ( $this->mTitleObj !== null ) {
            return $this->mTitleObj;
        }

        $this->requireOnlyOneParameter( $params, 'title', 'pageid' );

        if ( isset( $params['title'] ) ) {
            $this->mTitleObj = Title::newFromText( $params['title'] );
            if ( !$this->mTitleObj || $this->mTitleObj->isExternal() ) {
                $this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
            }
        } elseif ( isset( $params['pageid'] ) ) {
            $this->mTitleObj = Title::newFromID( $params['pageid'] );
            if ( !$this->mTitleObj ) {
                $this->dieUsageMsg( array( 'nosuchpageid', $params['pageid'] ) );
            }
        }

        if ( !$this->mTitleObj->exists() ) {
            $this->dieUsageMsg( 'notanarticle' );
        }

        return $this->mTitleObj;
    }

    public function getExamples() {
        return array(
            'api.php?action=rollback&title=Main%20Page&user=Catrope&token=123ABC',
            'api.php?action=rollback&pageid=122&user=Catrope&token=123ABC',
            'api.php?action=rollback&title=Main%20Page&user=217.121.114.116&' .
                'token=123ABC&summary=Reverting%20vandalism&markbot=1'
        );
    }

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