protected $params;
public function execute() {
+ $this->useTransactionalTimeLimit();
+
$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() );
+ $this->checkTitleUserPermissions( $this->file->getTitle(), [ 'edit', 'upload' ] );
$sourceUrl = $this->file->getArchiveVirtualUrl( $this->archiveName );
$status = $this->file->upload(
);
if ( $status->isGood() ) {
- $result = array( 'result' => 'Success' );
+ $result = [ 'result' => 'Success' ];
} else {
- $result = array(
+ $result = [
'result' => 'Failure',
- 'errors' => $this->getResult()->convertStatusToArray( $status ),
- );
+ 'errors' => $this->getErrorFormatter()->arrayFromStatus( $status ),
+ ];
}
$this->getResult()->addValue( null, $this->getModuleName(), $result );
}
- /**
- * Checks that the user has permissions to perform this revert.
- * Dies with usage message on inadequate permissions.
- * @param User $user The user to check.
- */
- 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] );
- }
- }
-
/**
* Validate the user parameters and set $this->archiveName and $this->file.
* Throws an error if validation fails
// Validate the input title
$title = Title::makeTitleSafe( NS_FILE, $this->params['filename'] );
if ( is_null( $title ) ) {
- $this->dieUsageMsg( array( 'invalidtitle', $this->params['filename'] ) );
+ $this->dieWithError(
+ [ 'apierror-invalidtitle', wfEscapeWikiText( $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' );
+ $this->dieWithError( 'apierror-missingtitle' );
}
// 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' );
+ $this->dieWithError( 'filerevert-badversion' );
}
}
}
public function getAllowedParams() {
- return array(
- 'filename' => array(
+ return [
+ 'filename' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
- ),
- 'comment' => array(
+ ],
+ 'comment' => [
ApiBase::PARAM_DFLT => '',
- ),
- 'archivename' => array(
+ ],
+ 'archivename' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true,
- ),
- );
- }
-
- public function getParamDescription() {
- return array(
- 'filename' => 'Target filename without the File: prefix',
- 'comment' => 'Upload comment',
- 'archivename' => 'Archive name of the revision to revert to',
- );
- }
-
- public function getDescription() {
- return array(
- 'Revert a file to an old version.'
- );
+ ],
+ ];
}
public function needsToken() {
return 'csrf';
}
- public function getExamples() {
- return array(
- 'api.php?action=filerevert&filename=Wiki.png&comment=Revert&' .
+ protected function getExamplesMessages() {
+ return [
+ 'action=filerevert&filename=Wiki.png&comment=Revert&' .
'archivename=20110305152740!Wiki.png&token=123ABC'
- => 'Revert Wiki.png to the version of 20110305152740',
- );
+ => 'apihelp-filerevert-example-revert',
+ ];
}
}