ApiUndelete.php

Go to the documentation of this file.

<?php
class ApiUndelete extends ApiBase {

    public function execute() {
        $this->useTransactionalTimeLimit();

        $params = $this->extractRequestParams();
        $user = $this->getUser();
        if ( !$user->isAllowed( 'undelete' ) ) {
            $this->dieUsageMsg( 'permdenied-undelete' );
        }

        if ( $user->isBlocked() ) {
            $this->dieBlocked( $user->getBlock() );
        }

        $titleObj = Title::newFromText( $params['title'] );
        if ( !$titleObj || $titleObj->isExternal() ) {
            $this->dieUsageMsg( [ 'invalidtitle', $params['title'] ] );
        }

        // Check if user can add tags
        if ( !is_null( $params['tags'] ) ) {
            $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
            if ( !$ableToTag->isOK() ) {
                $this->dieStatus( $ableToTag );
            }
        }

        // Convert timestamps
        if ( !isset( $params['timestamps'] ) ) {
            $params['timestamps'] = [];
        }
        if ( !is_array( $params['timestamps'] ) ) {
            $params['timestamps'] = [ $params['timestamps'] ];
        }
        foreach ( $params['timestamps'] as $i => $ts ) {
            $params['timestamps'][$i] = wfTimestamp( TS_MW, $ts );
        }

        $pa = new PageArchive( $titleObj, $this->getConfig() );
        $retval = $pa->undelete(
            ( isset( $params['timestamps'] ) ? $params['timestamps'] : [] ),
            $params['reason'],
            $params['fileids'],
            false,
            $user,
            $params['tags']
        );
        if ( !is_array( $retval ) ) {
            $this->dieUsageMsg( 'cannotundelete' );
        }

        if ( $retval[1] ) {
            Hooks::run( 'FileUndeleteComplete',
                [ $titleObj, $params['fileids'], $this->getUser(), $params['reason'] ] );
        }

        $this->setWatch( $params['watchlist'], $titleObj );

        $info['title'] = $titleObj->getPrefixedText();
        $info['revisions'] = intval( $retval[0] );
        $info['fileversions'] = intval( $retval[1] );
        $info['reason'] = $retval[2];
        $this->getResult()->addValue( null, $this->getModuleName(), $info );
    }

    public function mustBePosted() {
        return true;
    }

    public function isWriteMode() {
        return true;
    }

    public function getAllowedParams() {
        return [
            'title' => [
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true
            ],
            'reason' => '',
            'tags' => [
                ApiBase::PARAM_TYPE => 'tags',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'timestamps' => [
                ApiBase::PARAM_TYPE => 'timestamp',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'fileids' => [
                ApiBase::PARAM_TYPE => 'integer',
                ApiBase::PARAM_ISMULTI => true,
            ],
            'watchlist' => [
                ApiBase::PARAM_DFLT => 'preferences',
                ApiBase::PARAM_TYPE => [
                    'watch',
                    'unwatch',
                    'preferences',
                    'nochange'
                ],
            ],
        ];
    }

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

    protected function getExamplesMessages() {
        return [
            'action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page'
                => 'apihelp-undelete-example-page',
            'action=undelete&title=Main%20Page&token=123ABC' .
                '&timestamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z'
                => 'apihelp-undelete-example-revisions',
        ];
    }

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