From: Reedy <reedy@wikimedia.org>
Date: Fri, 8 Mar 2013 02:09:01 +0000 (+0000)
Subject: Cleanup for ApiImageRotate
X-Git-Tag: 1.31.0-rc.0~20299^2
X-Git-Url: http://git.cyclocoop.org/%40spipnet%40?a=commitdiff_plain;h=0f475b4b3e98a1162ee69c87010f8add0a76e253;p=lhc%2Fweb%2Fwiklou.git

Cleanup for ApiImageRotate

Follows up Id15a92d19cda8256917e7e1e5ee4241012214102

Minor tweak to filerevert too

Change-Id: I742c854ebb97a5a1f954388be4b15f992fa93bd8
---

diff --git a/includes/api/ApiFileRevert.php b/includes/api/ApiFileRevert.php
index 9520dc7b16..cbb2ba6a35 100644
--- a/includes/api/ApiFileRevert.php
+++ b/includes/api/ApiFileRevert.php
@@ -187,7 +187,7 @@ class ApiFileRevert extends ApiBase {
 
 	public function getExamples() {
 		return array(
-			'api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=+\\'
+			'api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC'
 				=> 'Revert Wiki.png to the version of 20110305152740',
 		);
 	}
diff --git a/includes/api/ApiImageRotate.php b/includes/api/ApiImageRotate.php
index 3815d41070..0ba8b049c7 100644
--- a/includes/api/ApiImageRotate.php
+++ b/includes/api/ApiImageRotate.php
@@ -59,10 +59,6 @@ class ApiImageRotate extends ApiBase {
 		$rotation = $params[ 'rotation' ];
 		$user = $this->getUser();
 
-		if( is_null( $rotation ) || $rotation % 90 ) {
-			$this->dieUsage( "Rotation: {$rotation}", 'rotation must be multiple of 90 degrees' );
-		}
-
 		$pageSet = $this->getPageSet();
 		$pageSet->execute();
 
@@ -73,32 +69,47 @@ class ApiImageRotate extends ApiBase {
 		self::addValues( $result, $pageSet->getSpecialTitles(), 'special', 'title' );
 		self::addValues( $result, $pageSet->getMissingPageIDs(), 'missing', 'pageid' );
 		self::addValues( $result, $pageSet->getMissingRevisionIDs(), 'missing', 'revid' );
-		self::addValues( $result, $pageSet->getMissingTitles(), 'missing' );
 		self::addValues( $result, $pageSet->getInterwikiTitlesAsResult() );
 
 		foreach ( $pageSet->getTitles() as $title ) {
-			$file = wfFindFile( $title );
-
 			$r = array();
-			$r[ 'title' ] = $title->getFullText();
-			if ( !$file ) {
+			$r['id'] = $title->getArticleID();
+			ApiQueryBase::addTitleInfo( $r, $title );
+			if ( !$title->exists() ) {
 				$r['missing'] = '';
+			}
+
+			$file = wfFindFile( $title );
+			if ( !$file ) {
 				$r['result'] = 'Failure';
+				$r['errormessage'] = 'File does not exist';
 				$result[] = $r;
 				continue;
 			}
 			$handler = $file->getHandler();
 			if ( !$handler || !$handler->canRotate() ) {
-				$r['invalid'] = '';
 				$r['result'] = 'Failure';
+				$r['errormessage'] = 'File type cannot be rotated';
 				$result[] = $r;
 				continue;
 			}
 
 			// Check whether we're allowed to rotate this file
-			$this->checkPermissions( $this->getUser(), $file->getTitle() );
+			$permError = $this->checkPermissions( $this->getUser(), $file->getTitle() );
+			if ( $permError !== null ) {
+				$r['result'] = 'Failure';
+				$r['errormessage'] = $permError;
+				$result[] = $r;
+				continue;
+			}
 
 			$srcPath = $file->getLocalRefPath();
+			if ( $srcPath === false ) {
+				$r['result'] = 'Failure';
+				$r['errormessage'] = 'Cannot get local file path';
+				$result[] = $r;
+				continue;
+			}
 			$ext = strtolower( pathinfo( "$srcPath", PATHINFO_EXTENSION ) );
 			$tmpFile = TempFSFile::factory( 'rotate_', $ext);
 			$dstPath = $tmpFile->getPath();
@@ -134,15 +145,15 @@ class ApiImageRotate extends ApiBase {
 	 */
 	private function getPageSet() {
 		if ( $this->mPageSet === null ) {
-			$this->mPageSet = new ApiPageSet( $this, 0, NS_FILE);
+			$this->mPageSet = new ApiPageSet( $this, 0, NS_FILE );
 		}
 		return $this->mPageSet;
 	}
 
 	/**
 	 * Checks that the user has permissions to perform rotations.
-	 * Dies with usage message on inadequate permissions.
 	 * @param $user User The user to check.
+	 * @return string|null Permission error message, or null if there is no error
 	 */
 	protected function checkPermissions( $user, $title ) {
 		$permissionErrors = array_merge(
@@ -151,8 +162,12 @@ class ApiImageRotate extends ApiBase {
 		);
 
 		if ( $permissionErrors ) {
-			$this->dieUsageMsg( $permissionErrors[0] );
+			// Just return the first error
+			$msg = $this->parseMsg( $permissionErrors[0] );
+			return $msg['info'];
 		}
+
+		return null;
 	}
 
 	public function mustBePosted() {
@@ -167,7 +182,8 @@ class ApiImageRotate extends ApiBase {
 		$pageSet = $this->getPageSet();
 		$result = array(
 			'rotation' => array(
-				ApiBase::PARAM_DFLT => 0,
+				ApiBase::PARAM_TYPE => array( '90', '180', '270' ),
+				ApiBase::PARAM_REQUIRED => true
 			),
 			'token' => array(
 				ApiBase::PARAM_TYPE => 'string',
@@ -183,8 +199,8 @@ class ApiImageRotate extends ApiBase {
 	public function getParamDescription() {
 		$pageSet = $this->getPageSet();
 		return $pageSet->getParamDescription() + array(
-			'rotation' => 'Degrees to rotate image, values can be 0, 90, 180 or 270',
-			'token' => 'Edit token. You can get one of these through prop=info',
+			'rotation' => 'Degrees to rotate image clockwise',
+			'token' => 'Edit token. You can get one of these through action=tokens',
 		);
 	}
 
@@ -210,7 +226,7 @@ class ApiImageRotate extends ApiBase {
 
 	public function getExamples() {
 		return array(
-			'api.php?action=imagerotate&titles=Example.jpg&rotation=90&token=+\\',
+			'api.php?action=imagerotate&titles=Example.jpg&rotation=90&token=123ABC',
 		);
 	}
 }