Page MenuHomeWickedGov Phorge
Files F5953859

ApiImageRotate.php
No OneTemporary
Actions

Size
6 KB
Referenced Files
None
Subscribers
None

ApiImageRotate.php
View Options

<?php
/**
* 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
*/
namespace MediaWiki\Api;
use ChangeTags;
use MediaWiki\FileBackend\FSFile\TempFSFileFactory;
use MediaWiki\Status\Status;
use MediaWiki\Title\TitleFactory;
use RepoGroup;
use Wikimedia\ParamValidator\ParamValidator;
/**
* @ingroup API
*/
class ApiImageRotate extends ApiBase {
/** @var ApiPageSet|null */
private $mPageSet = null;
private RepoGroup $repoGroup;
private TempFSFileFactory $tempFSFileFactory;
private TitleFactory $titleFactory;
public function __construct(
ApiMain $mainModule,
string $moduleName,
RepoGroup $repoGroup,
TempFSFileFactory $tempFSFileFactory,
TitleFactory $titleFactory
) {
parent::__construct( $mainModule, $moduleName );
$this->repoGroup = $repoGroup;
$this->tempFSFileFactory = $tempFSFileFactory;
$this->titleFactory = $titleFactory;
}
public function execute() {
$this->useTransactionalTimeLimit();
$params = $this->extractRequestParams();
$rotation = $params['rotation'];
$continuationManager = new ApiContinuationManager( $this, [], [] );
$this->setContinuationManager( $continuationManager );
$pageSet = $this->getPageSet();
$pageSet->execute();
$result = $pageSet->getInvalidTitlesAndRevisions( [
'invalidTitles', 'special', 'missingIds', 'missingRevIds', 'interwikiTitles',
] );
// Check if user can add tags
if ( $params['tags'] ) {
$ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $this->getAuthority() );
if ( !$ableToTag->isOK() ) {
$this->dieStatus( $ableToTag );
}
}
foreach ( $pageSet->getPages() as $page ) {
$title = $this->titleFactory->newFromPageIdentity( $page );
$r = [];
$r['id'] = $title->getArticleID();
ApiQueryBase::addTitleInfo( $r, $title );
if ( !$title->exists() ) {
$r['missing'] = true;
if ( $title->isKnown() ) {
$r['known'] = true;
}
}
$file = $this->repoGroup->findFile( $title, [ 'latest' => true ] );
if ( !$file ) {
$r['result'] = 'Failure';
$r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
Status::newFatal( 'apierror-filedoesnotexist' )
);
$result[] = $r;
continue;
}
$handler = $file->getHandler();
if ( !$handler || !$handler->canRotate() ) {
$r['result'] = 'Failure';
$r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
Status::newFatal( 'apierror-filetypecannotberotated' )
);
$result[] = $r;
continue;
}
// Check whether we're allowed to rotate this file
$this->checkTitleUserPermissions( $file->getTitle(), [ 'edit', 'upload' ] );
$srcPath = $file->getLocalRefPath();
if ( $srcPath === false ) {
$r['result'] = 'Failure';
$r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
Status::newFatal( 'apierror-filenopath' )
);
$result[] = $r;
continue;
}
$ext = strtolower( pathinfo( "$srcPath", PATHINFO_EXTENSION ) );
$tmpFile = $this->tempFSFileFactory->newTempFSFile( 'rotate_', $ext );
$dstPath = $tmpFile->getPath();
// @phan-suppress-next-line PhanUndeclaredMethod
$err = $handler->rotate( $file, [
'srcPath' => $srcPath,
'dstPath' => $dstPath,
'rotation' => $rotation
] );
if ( !$err ) {
$comment = $this->msg(
'rotate-comment'
)->numParams( $rotation )->inContentLanguage()->text();
// @phan-suppress-next-line PhanUndeclaredMethod
$status = $file->upload(
$dstPath,
$comment,
$comment,
0,
false,
false,
$this->getAuthority(),
$params['tags'] ?: []
);
if ( $status->isGood() ) {
$r['result'] = 'Success';
} else {
$r['result'] = 'Failure';
$r['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status );
}
} else {
$r['result'] = 'Failure';
$r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
Status::newFatal( ApiMessage::create( $err->getMsg() ) )
);
}
$result[] = $r;
}
$apiResult = $this->getResult();
ApiResult::setIndexedTagName( $result, 'page' );
$apiResult->addValue( null, $this->getModuleName(), $result );
$this->setContinuationManager( null );
$continuationManager->setContinuationIntoResult( $apiResult );
}
/**
* Get a cached instance of an ApiPageSet object
* @return ApiPageSet
*/
private function getPageSet() {
$this->mPageSet ??= new ApiPageSet( $this, 0, NS_FILE );
return $this->mPageSet;
}
public function mustBePosted() {
return true;
}
public function isWriteMode() {
return true;
}
public function getAllowedParams( $flags = 0 ) {
$result = [
'rotation' => [
ParamValidator::PARAM_TYPE => [ '90', '180', '270' ],
ParamValidator::PARAM_REQUIRED => true
],
'continue' => [
ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
],
'tags' => [
ParamValidator::PARAM_TYPE => 'tags',
ParamValidator::PARAM_ISMULTI => true,
],
];
if ( $flags ) {
$result += $this->getPageSet()->getFinalParams( $flags );
}
return $result;
}
public function needsToken() {
return 'csrf';
}
protected function getExamplesMessages() {
return [
'action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC'
=> 'apihelp-imagerotate-example-simple',
'action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&' .
'rotation=180&token=123ABC'
=> 'apihelp-imagerotate-example-generator',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Imagerotate';
}
}
/** @deprecated class alias since 1.43 */
class_alias( ApiImageRotate::class, 'ApiImageRotate' );

File Metadata

Mime Type
text/x-php
Expires
Oct 3 2026, 02:28 (4 w, 2 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
c7/9e/8cac6a254d8d816540ba35940aa8
Default Alt Text
ApiImageRotate.php (6 KB)

Event Timeline