ApiFileRevert.php

Go to the documentation of this file.

<?php
class ApiFileRevert extends ApiBase {

        protected $file;
        protected $archiveName;

        protected $params;

        public function execute() {
                $this->params = $this->extractRequestParams();
                // Extract the file and archiveName from the request parameters
                $this->validateParameters();

                // Check whether we're allowed to revert this file
                $this->checkPermissions( $this->getUser() );

                $sourceUrl = $this->file->getArchiveVirtualUrl( $this->archiveName );
                $status = $this->file->upload( $sourceUrl, $this->params['comment'], $this->params['comment'], 0, false, false, $this->getUser() );

                if ( $status->isGood() ) {
                        $result = array( 'result' => 'Success' );
                } else {
                        $result = array(
                                'result' => 'Failure',
                                'errors' => $this->getResult()->convertStatusToArray( $status ),
                        );
                }

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

        }

        protected function checkPermissions( $user ) {
                $title = $this->file->getTitle();
                $permissionErrors = array_merge(
                        $title->getUserPermissionsErrors( 'edit', $user ),
                        $title->getUserPermissionsErrors( 'upload', $user )
                );

                if ( $permissionErrors ) {
                        $this->dieUsageMsg( $permissionErrors[0] );
                }
        }

        protected function validateParameters() {
                // Validate the input title
                $title = Title::makeTitleSafe( NS_FILE, $this->params['filename'] );
                if ( is_null( $title ) ) {
                        $this->dieUsageMsg( array( 'invalidtitle', $this->params['filename'] ) );
                }
                $localRepo = RepoGroup::singleton()->getLocalRepo();

                // Check if the file really exists
                $this->file = $localRepo->newFile( $title );
                if ( !$this->file->exists() ) {
                        $this->dieUsageMsg( 'notanarticle' );
                }

                // Check if the archivename is valid for this file
                $this->archiveName = $this->params['archivename'];
                $oldFile = $localRepo->newFromArchiveName( $title, $this->archiveName );
                if ( !$oldFile->exists() ) {
                        $this->dieUsageMsg( 'filerevert-badversion' );
                }
        }

        public function mustBePosted() {
                return true;
        }

        public function isWriteMode() {
                return true;
        }

        public function getAllowedParams() {
                return array(
                        'filename' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true,
                        ),
                        'comment' => array(
                                ApiBase::PARAM_DFLT => '',
                        ),
                        'archivename' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true,
                        ),
                        'token' => array(
                                ApiBase::PARAM_TYPE => 'string',
                                ApiBase::PARAM_REQUIRED => true
                        ),
                );

        }

        public function getParamDescription() {
                return array(
                        'filename' => 'Target filename without the File: prefix',
                        'token' => 'Edit token. You can get one of these through prop=info',
                        'comment' => 'Upload comment',
                        'archivename' => 'Archive name of the revision to revert to',
                );
        }

        public function getResultProperties() {
                return array(
                        '' => array(
                                'result' => array(
                                        ApiBase::PROP_TYPE => array(
                                                'Success',
                                                'Failure'
                                        )
                                ),
                                'errors' => array(
                                        ApiBase::PROP_TYPE => 'string',
                                        ApiBase::PROP_NULLABLE => true
                                )
                        )
                );
        }

        public function getDescription() {
                return array(
                        'Revert a file to an old version'
                );
        }

        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(),
                        array(
                                array( 'mustbeloggedin', 'upload' ),
                                array( 'badaccess-groups' ),
                                array( 'invalidtitle', 'title' ),
                                array( 'notanarticle' ),
                                array( 'filerevert-badversion' ),
                        )
                );
        }

        public function needsToken() {
                return true;
        }

        public function getTokenSalt() {
                return '';
        }

        public function getExamples() {
                return array(
                        'api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC'
                                => 'Revert Wiki.png to the version of 20110305152740',
                );
        }
}