MediaWiki  1.29.1
Go to the documentation of this file.
1 <?php
24 class ApiImageRotate extends ApiBase {
25  private $mPageSet = null;
27  public function execute() {
30  $params = $this->extractRequestParams();
31  $rotation = $params['rotation'];
33  $continuationManager = new ApiContinuationManager( $this, [], [] );
34  $this->setContinuationManager( $continuationManager );
36  $pageSet = $this->getPageSet();
37  $pageSet->execute();
39  $result = [];
41  $result = $pageSet->getInvalidTitlesAndRevisions( [
42  'invalidTitles', 'special', 'missingIds', 'missingRevIds', 'interwikiTitles',
43  ] );
45  // Check if user can add tags
46  if ( count( $params['tags'] ) ) {
47  $ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $this->getUser() );
48  if ( !$ableToTag->isOK() ) {
49  $this->dieStatus( $ableToTag );
50  }
51  }
53  foreach ( $pageSet->getTitles() as $title ) {
54  $r = [];
55  $r['id'] = $title->getArticleID();
57  if ( !$title->exists() ) {
58  $r['missing'] = true;
59  if ( $title->isKnown() ) {
60  $r['known'] = true;
61  }
62  }
64  $file = wfFindFile( $title, [ 'latest' => true ] );
65  if ( !$file ) {
66  $r['result'] = 'Failure';
67  $r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
68  Status::newFatal( 'apierror-filedoesnotexist' )
69  );
70  $result[] = $r;
71  continue;
72  }
73  $handler = $file->getHandler();
74  if ( !$handler || !$handler->canRotate() ) {
75  $r['result'] = 'Failure';
76  $r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
77  Status::newFatal( 'apierror-filetypecannotberotated' )
78  );
79  $result[] = $r;
80  continue;
81  }
83  // Check whether we're allowed to rotate this file
84  $permError = $this->checkTitleUserPermissions( $file->getTitle(), [ 'edit', 'upload' ] );
85  if ( $permError ) {
86  $r['result'] = 'Failure';
87  $r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
88  $this->errorArrayToStatus( $permError )
89  );
90  $result[] = $r;
91  continue;
92  }
94  $srcPath = $file->getLocalRefPath();
95  if ( $srcPath === false ) {
96  $r['result'] = 'Failure';
97  $r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
98  Status::newFatal( 'apierror-filenopath' )
99  );
100  $result[] = $r;
101  continue;
102  }
103  $ext = strtolower( pathinfo( "$srcPath", PATHINFO_EXTENSION ) );
104  $tmpFile = TempFSFile::factory( 'rotate_', $ext, wfTempDir() );
105  $dstPath = $tmpFile->getPath();
106  $err = $handler->rotate( $file, [
107  'srcPath' => $srcPath,
108  'dstPath' => $dstPath,
109  'rotation' => $rotation
110  ] );
111  if ( !$err ) {
112  $comment = wfMessage(
113  'rotate-comment'
114  )->numParams( $rotation )->inContentLanguage()->text();
115  $status = $file->upload(
116  $dstPath,
117  $comment,
118  $comment,
119  0,
120  false,
121  false,
122  $this->getUser(),
123  $params['tags'] ?: []
124  );
125  if ( $status->isGood() ) {
126  $r['result'] = 'Success';
127  } else {
128  $r['result'] = 'Failure';
129  $r['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status );
130  }
131  } else {
132  $r['result'] = 'Failure';
133  $r['errors'] = $this->getErrorFormatter()->arrayFromStatus(
134  Status::newFatal( ApiMessage::create( $err->getMsg() ) )
135  );
136  }
137  $result[] = $r;
138  }
139  $apiResult = $this->getResult();
141  $apiResult->addValue( null, $this->getModuleName(), $result );
143  $this->setContinuationManager( null );
144  $continuationManager->setContinuationIntoResult( $apiResult );
145  }
151  private function getPageSet() {
152  if ( $this->mPageSet === null ) {
153  $this->mPageSet = new ApiPageSet( $this, 0, NS_FILE );
154  }
156  return $this->mPageSet;
157  }
159  public function mustBePosted() {
160  return true;
161  }
163  public function isWriteMode() {
164  return true;
165  }
167  public function getAllowedParams( $flags = 0 ) {
168  $result = [
169  'rotation' => [
170  ApiBase::PARAM_TYPE => [ '90', '180', '270' ],
172  ],
173  'continue' => [
174  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
175  ],
176  'tags' => [
177  ApiBase::PARAM_TYPE => 'tags',
178  ApiBase::PARAM_ISMULTI => true,
179  ],
180  ];
181  if ( $flags ) {
182  $result += $this->getPageSet()->getFinalParams( $flags );
183  }
185  return $result;
186  }
188  public function needsToken() {
189  return 'csrf';
190  }
192  protected function getExamplesMessages() {
193  return [
194  'action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC'
195  => 'apihelp-imagerotate-example-simple',
196  'action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&' .
197  'rotation=180&token=123ABC'
198  => 'apihelp-imagerotate-example-generator',
199  ];
200  }
201 }
(boolean) Is the parameter required?
Definition: ApiBase.php:115
Indicates whether this module must be called with a POST request.
Definition: ApiImageRotate.php:159
This manages continuation state.
Definition: ApiContinuationManager.php:26
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition: ApiBase.php:128
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:Array with elements of the form "language:title" in the order that they will be output. & $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:1954
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition: ApiBase.php:91
Get a cached instance of an ApiPageSet object.
Definition: ApiImageRotate.php:151
Get the result object.
Definition: ApiBase.php:610
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist Do not use this to implement individual filters if they are compatible with the ChangesListFilter and ChangesListFilterGroup structure use sub classes of those in conjunction with the ChangesListSpecialPageStructuredFilters hook This hook can be used to implement filters that do not implement that or custom behavior that is not an individual filter e g Watchlist and Watchlist you will want to construct new ChangesListBooleanFilter or ChangesListStringOptionsFilter objects When constructing you specify which group they belong to You can reuse existing or create your you must register them with $special registerFilterGroup 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:1049
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:63
const NS_FILE
Definition: Defines.php:68
Definition: styleTest.css.php:40
Get the User object.
Definition: ContextSource.php:133
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:44
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
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:41
Returns the token type this module requires in order to execute.
Definition: ApiImageRotate.php:188
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:934
Definition: ApiImageRotate.php:24
getAllowedParams( $flags=0)
Definition: ApiImageRotate.php:167
static create( $msg, $code=null, array $data=null)
Create an IApiMessage for the message.
Definition: ApiMessage.php:212
static factory( $prefix, $extension='', $tmpDirectory=null)
Make a new temporary file on the file system.
Definition: TempFSFile.php:55
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:718
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
checkTitleUserPermissions(Title $title, $actions, $user=null)
Helper function for permission-denied errors.
Definition: ApiBase.php:1908
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition: ApiBase.php:2440
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:783
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:3101
static canAddTagsAccompanyingChange(array $tags, User $user=null)
Is it OK to allow the user to apply all the specified tags at the same time as they edit/make the cha...
Definition: ChangeTags.php:395
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiImageRotate.php:27
Returns usage examples for this module.
Definition: ApiImageRotate.php:192
Tries to get the system directory for temporary files.
Definition: GlobalFunctions.php:2061
setContinuationManager( $manager)
Set the continuation manager.
Definition: ApiBase.php:664
Definition: NoLocalSettings.php:25
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
dieStatus(StatusValue $status)
Throw an ApiUsageException based on the Status object.
Definition: ApiBase.php:1861
Get the name of the module being executed by this instance.
Definition: ApiBase.php:490
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:55
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:1956
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 unset offset - wrap String Wrap the message in html(usually something like "&lt
errorArrayToStatus(array $errors, User $user=null)
Turn an array of message keys or key+param arrays into a Status.
Definition: ApiBase.php:1667
Get the error formatter.
Definition: ApiBase.php:624
Indicates whether this module requires write mode.
Definition: ApiImageRotate.php:163
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2749
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:486
Definition: ApiImageRotate.php:25