MediaWiki  1.28.1
ApiImageRotate.php
Go to the documentation of this file.
1 <?php
24 class ApiImageRotate extends ApiBase {
25  private $mPageSet = null;
26 
27  public function execute() {
29 
30  $params = $this->extractRequestParams();
31  $rotation = $params['rotation'];
32 
33  $continuationManager = new ApiContinuationManager( $this, [], [] );
34  $this->setContinuationManager( $continuationManager );
35 
36  $pageSet = $this->getPageSet();
37  $pageSet->execute();
38 
39  $result = [];
40 
41  $result = $pageSet->getInvalidTitlesAndRevisions( [
42  'invalidTitles', 'special', 'missingIds', 'missingRevIds', 'interwikiTitles',
43  ] );
44 
45  foreach ( $pageSet->getTitles() as $title ) {
46  $r = [];
47  $r['id'] = $title->getArticleID();
49  if ( !$title->exists() ) {
50  $r['missing'] = true;
51  if ( $title->isKnown() ) {
52  $r['known'] = true;
53  }
54  }
55 
56  $file = wfFindFile( $title, [ 'latest' => true ] );
57  if ( !$file ) {
58  $r['result'] = 'Failure';
59  $r['errormessage'] = 'File does not exist';
60  $result[] = $r;
61  continue;
62  }
63  $handler = $file->getHandler();
64  if ( !$handler || !$handler->canRotate() ) {
65  $r['result'] = 'Failure';
66  $r['errormessage'] = 'File type cannot be rotated';
67  $result[] = $r;
68  continue;
69  }
70 
71  // Check whether we're allowed to rotate this file
72  $permError = $this->checkPermissions( $this->getUser(), $file->getTitle() );
73  if ( $permError !== null ) {
74  $r['result'] = 'Failure';
75  $r['errormessage'] = $permError;
76  $result[] = $r;
77  continue;
78  }
79 
80  $srcPath = $file->getLocalRefPath();
81  if ( $srcPath === false ) {
82  $r['result'] = 'Failure';
83  $r['errormessage'] = 'Cannot get local file path';
84  $result[] = $r;
85  continue;
86  }
87  $ext = strtolower( pathinfo( "$srcPath", PATHINFO_EXTENSION ) );
88  $tmpFile = TempFSFile::factory( 'rotate_', $ext, wfTempDir() );
89  $dstPath = $tmpFile->getPath();
90  $err = $handler->rotate( $file, [
91  'srcPath' => $srcPath,
92  'dstPath' => $dstPath,
93  'rotation' => $rotation
94  ] );
95  if ( !$err ) {
97  'rotate-comment'
98  )->numParams( $rotation )->inContentLanguage()->text();
99  $status = $file->upload( $dstPath,
100  $comment, $comment, 0, false, false, $this->getUser() );
101  if ( $status->isGood() ) {
102  $r['result'] = 'Success';
103  } else {
104  $r['result'] = 'Failure';
105  $r['errormessage'] = $this->getErrorFormatter()->arrayFromStatus( $status );
106  }
107  } else {
108  $r['result'] = 'Failure';
109  $r['errormessage'] = $err->toText();
110  }
111  $result[] = $r;
112  }
113  $apiResult = $this->getResult();
115  $apiResult->addValue( null, $this->getModuleName(), $result );
116 
117  $this->setContinuationManager( null );
118  $continuationManager->setContinuationIntoResult( $apiResult );
119  }
120 
125  private function getPageSet() {
126  if ( $this->mPageSet === null ) {
127  $this->mPageSet = new ApiPageSet( $this, 0, NS_FILE );
128  }
129 
130  return $this->mPageSet;
131  }
132 
139  protected function checkPermissions( $user, $title ) {
140  $permissionErrors = array_merge(
141  $title->getUserPermissionsErrors( 'edit', $user ),
142  $title->getUserPermissionsErrors( 'upload', $user )
143  );
144 
145  if ( $permissionErrors ) {
146  // Just return the first error
147  $msg = $this->parseMsg( $permissionErrors[0] );
148 
149  return $msg['info'];
150  }
151 
152  return null;
153  }
154 
155  public function mustBePosted() {
156  return true;
157  }
158 
159  public function isWriteMode() {
160  return true;
161  }
162 
163  public function getAllowedParams( $flags = 0 ) {
164  $result = [
165  'rotation' => [
166  ApiBase::PARAM_TYPE => [ '90', '180', '270' ],
168  ],
169  'continue' => [
170  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
171  ],
172  ];
173  if ( $flags ) {
174  $result += $this->getPageSet()->getFinalParams( $flags );
175  }
176 
177  return $result;
178  }
179 
180  public function needsToken() {
181  return 'csrf';
182  }
183 
184  protected function getExamplesMessages() {
185  return [
186  'action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC'
187  => 'apihelp-imagerotate-example-simple',
188  'action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&' .
189  'rotation=180&token=123ABC'
190  => 'apihelp-imagerotate-example-generator',
191  ];
192  }
193 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
getErrorFormatter()
Get the error formatter.
Definition: ApiBase.php:598
getResult()
Get the result object.
Definition: ApiBase.php:584
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
useTransactionalTimeLimit()
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: ApiBase.php:2764
const PARAM_REQUIRED
(boolean) Is the parameter required?
Definition: ApiBase.php:112
$comment
getPageSet()
Get a cached instance of an ApiPageSet object.
This manages continuation state.
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:685
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2703
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:618
static factory($prefix, $extension= '', $tmpDirectory=null)
Make a new temporary file on the file system.
Definition: TempFSFile.php:55
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:1936
wfTempDir()
Tries to get the system directory for temporary files.
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
getAllowedParams($flags=0)
$params
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:464
const NS_FILE
Definition: Defines.php:62
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
checkPermissions($user, $title)
Checks that the user has permissions to perform rotations.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
This abstract class implements many basic API functions, and is the base of all API classes...
Definition: ApiBase.php:39
parseMsg($error)
Return the error message related to a certain array.
Definition: ApiBase.php:2253
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:802
static addTitleInfo(&$arr, $title, $prefix= '')
Add information (title and namespace) about a Title object to a result array.
setContinuationManager($manager)
Set the continuation manager.
Definition: ApiBase.php:638
getUser()
Get the User object.
wfFindFile($title, $options=[])
Find a file.