Your IP : 172.69.214.233
<?php
/**
*
* Created on January 3rd, 2013
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
class ApiImageRotate extends ApiBase {
private $mPageSet = null;
public function __construct( $main, $action ) {
parent::__construct( $main, $action );
}
/**
* Add all items from $values into the result
* @param array $result output
* @param array $values values to add
* @param string $flag the name of the boolean flag to mark this element
* @param string $name if given, name of the value
*/
private static function addValues( array &$result, $values, $flag = null, $name = null ) {
foreach ( $values as $val ) {
if( $val instanceof Title ) {
$v = array();
ApiQueryBase::addTitleInfo( $v, $val );
} elseif( $name !== null ) {
$v = array( $name => $val );
} else {
$v = $val;
}
if( $flag !== null ) {
$v[$flag] = '';
}
$result[] = $v;
}
}
public function execute() {
$params = $this->extractRequestParams();
$rotation = $params[ 'rotation' ];
$user = $this->getUser();
$pageSet = $this->getPageSet();
$pageSet->execute();
$result = array();
$result = array();
self::addValues( $result, $pageSet->getInvalidTitles(), 'invalid', 'title' );
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->getInterwikiTitlesAsResult() );
foreach ( $pageSet->getTitles() as $title ) {
$r = array();
$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['result'] = 'Failure';
$r['errormessage'] = 'File type cannot be rotated';
$result[] = $r;
continue;
}
// Check whether we're allowed to rotate this file
$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();
$err = $handler->rotate( $file, array(
"srcPath" => $srcPath,
"dstPath" => $dstPath,
"rotation"=> $rotation
) );
if ( !$err ) {
$comment = wfMessage( 'rotate-comment' )->numParams( $rotation )->text();
$status = $file->upload( $dstPath,
$comment, $comment, 0, false, false, $this->getUser() );
if ( $status->isGood() ) {
$r['result'] = 'Success';
} else {
$r['result'] = 'Failure';
$r['errormessage'] = $this->getResult()->convertStatusToArray( $status );
}
} else {
$r['result'] = 'Failure';
$r['errormessage'] = $err->toText();
}
$result[] = $r;
}
$apiResult = $this->getResult();
$apiResult->setIndexedTagName( $result, 'page' );
$apiResult->addValue( null, $this->getModuleName(), $result );
}
/**
* Get a cached instance of an ApiPageSet object
* @return ApiPageSet
*/
private function getPageSet() {
if ( $this->mPageSet === null ) {
$this->mPageSet = new ApiPageSet( $this, 0, NS_FILE );
}
return $this->mPageSet;
}
/**
* Checks that the user has permissions to perform rotations.
* @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(
$title->getUserPermissionsErrors( 'edit' , $user ),
$title->getUserPermissionsErrors( 'upload' , $user )
);
if ( $permissionErrors ) {
// Just return the first error
$msg = $this->parseMsg( $permissionErrors[0] );
return $msg['info'];
}
return null;
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams( $flags = 0 ) {
$pageSet = $this->getPageSet();
$result = array(
'rotation' => array(
ApiBase::PARAM_TYPE => array( '90', '180', '270' ),
ApiBase::PARAM_REQUIRED => true
),
'token' => array(
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true
),
);
if ( $flags ) {
$result += $this->getPageSet()->getFinalParams( $flags );
}
return $result;
}
public function getParamDescription() {
$pageSet = $this->getPageSet();
return $pageSet->getParamDescription() + array(
'rotation' => 'Degrees to rotate image clockwise',
'token' => 'Edit token. You can get one of these through action=tokens',
);
}
public function getDescription() {
return 'Rotate one or more images';
}
public function needsToken() {
return true;
}
public function getTokenSalt() {
return '';
}
public function getPossibleErrors() {
$pageSet = $this->getPageSet();
return array_merge(
parent::getPossibleErrors(),
$pageSet->getPossibleErrors()
);
}
public function getExamples() {
return array(
'api.php?action=imagerotate&titles=Example.jpg&rotation=90&token=123ABC',
);
}
}