ApiUndelete.php

Go to the documentation of this file.

<?php
class ApiUndelete extends ApiBase {

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

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

        if ( $this->getUser()->isBlocked() ) {
            $this->dieUsageMsg( 'blockedtext' );
        }

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

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

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

        if ( $retval[1] ) {
            wfRunHooks( 'FileUndeleteComplete',
                array( $titleObj, array(), $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 array(
            'title' => array(
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true
            ),
            'token' => array(
                ApiBase::PARAM_TYPE => 'string',
                ApiBase::PARAM_REQUIRED => true
            ),
            'reason' => '',
            'timestamps' => array(
                ApiBase::PARAM_TYPE => 'timestamp',
                ApiBase::PARAM_ISMULTI => true,
            ),
            'watchlist' => array(
                ApiBase::PARAM_DFLT => 'preferences',
                ApiBase::PARAM_TYPE => array(
                    'watch',
                    'unwatch',
                    'preferences',
                    'nochange'
                ),
            ),
        );
    }

    public function getParamDescription() {
        return array(
            'title' => 'Title of the page you want to restore',
            'token' => 'An undelete token previously retrieved through list=deletedrevs',
            'reason' => 'Reason for restoring',
            'timestamps' => 'Timestamps of the revisions to restore. If not set, all ' .
                'revisions will be restored.',
            'watchlist' => 'Unconditionally add or remove the page from your ' .
                'watchlist, use preferences or do not change watch',
        );
    }

    public function getResultProperties() {
        return array(
            '' => array(
                'title' => 'string',
                'revisions' => 'integer',
                'filerevisions' => 'integer',
                'reason' => 'string'
            )
        );
    }

    public function getDescription() {
        return array(
            'Restore certain revisions of a deleted page. A list of deleted revisions ',
            '(including timestamps) can be retrieved through list=deletedrevs.'
        );
    }

    public function getPossibleErrors() {
        return array_merge( parent::getPossibleErrors(), array(
            array( 'permdenied-undelete' ),
            array( 'blockedtext' ),
            array( 'invalidtitle', 'title' ),
            array( 'cannotundelete' ),
        ) );
    }

    public function needsToken() {
        return true;
    }

    public function getTokenSalt() {
        return '';
    }

    public function getExamples() {
        return array(
            'api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page',
            'api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=20070703220045|20070702194856'
        );
    }

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