MediaWiki  1.23.8
ApiImageRotate.php
Go to the documentation of this file.
1 <?php
24 class ApiImageRotate extends ApiBase {
25  private $mPageSet = null;
26 
34  private static function addValues( array &$result, $values, $flag = null, $name = null ) {
35  foreach ( $values as $val ) {
36  if ( $val instanceof Title ) {
37  $v = array();
38  ApiQueryBase::addTitleInfo( $v, $val );
39  } elseif ( $name !== null ) {
40  $v = array( $name => $val );
41  } else {
42  $v = $val;
43  }
44  if ( $flag !== null ) {
45  $v[$flag] = '';
46  }
47  $result[] = $v;
48  }
49  }
50 
51  public function execute() {
52  $params = $this->extractRequestParams();
53  $rotation = $params['rotation'];
54 
55  $pageSet = $this->getPageSet();
56  $pageSet->execute();
57 
58  $result = array();
59 
60  self::addValues( $result, $pageSet->getInvalidTitles(), 'invalid', 'title' );
61  self::addValues( $result, $pageSet->getSpecialTitles(), 'special', 'title' );
62  self::addValues( $result, $pageSet->getMissingPageIDs(), 'missing', 'pageid' );
63  self::addValues( $result, $pageSet->getMissingRevisionIDs(), 'missing', 'revid' );
64  self::addValues( $result, $pageSet->getInterwikiTitlesAsResult() );
65 
66  foreach ( $pageSet->getTitles() as $title ) {
67  $r = array();
68  $r['id'] = $title->getArticleID();
70  if ( !$title->exists() ) {
71  $r['missing'] = '';
72  }
73 
74  $file = wfFindFile( $title );
75  if ( !$file ) {
76  $r['result'] = 'Failure';
77  $r['errormessage'] = 'File does not exist';
78  $result[] = $r;
79  continue;
80  }
81  $handler = $file->getHandler();
82  if ( !$handler || !$handler->canRotate() ) {
83  $r['result'] = 'Failure';
84  $r['errormessage'] = 'File type cannot be rotated';
85  $result[] = $r;
86  continue;
87  }
88 
89  // Check whether we're allowed to rotate this file
90  $permError = $this->checkPermissions( $this->getUser(), $file->getTitle() );
91  if ( $permError !== null ) {
92  $r['result'] = 'Failure';
93  $r['errormessage'] = $permError;
94  $result[] = $r;
95  continue;
96  }
97 
98  $srcPath = $file->getLocalRefPath();
99  if ( $srcPath === false ) {
100  $r['result'] = 'Failure';
101  $r['errormessage'] = 'Cannot get local file path';
102  $result[] = $r;
103  continue;
104  }
105  $ext = strtolower( pathinfo( "$srcPath", PATHINFO_EXTENSION ) );
106  $tmpFile = TempFSFile::factory( 'rotate_', $ext );
107  $dstPath = $tmpFile->getPath();
108  $err = $handler->rotate( $file, array(
109  "srcPath" => $srcPath,
110  "dstPath" => $dstPath,
111  "rotation" => $rotation
112  ) );
113  if ( !$err ) {
115  'rotate-comment'
116  )->numParams( $rotation )->inContentLanguage()->text();
117  $status = $file->upload( $dstPath,
118  $comment, $comment, 0, false, false, $this->getUser() );
119  if ( $status->isGood() ) {
120  $r['result'] = 'Success';
121  } else {
122  $r['result'] = 'Failure';
123  $r['errormessage'] = $this->getResult()->convertStatusToArray( $status );
124  }
125  } else {
126  $r['result'] = 'Failure';
127  $r['errormessage'] = $err->toText();
128  }
129  $result[] = $r;
130  }
131  $apiResult = $this->getResult();
132  $apiResult->setIndexedTagName( $result, 'page' );
133  $apiResult->addValue( null, $this->getModuleName(), $result );
134  }
135 
140  private function getPageSet() {
141  if ( $this->mPageSet === null ) {
142  $this->mPageSet = new ApiPageSet( $this, 0, NS_FILE );
143  }
144 
145  return $this->mPageSet;
146  }
147 
154  protected function checkPermissions( $user, $title ) {
155  $permissionErrors = array_merge(
156  $title->getUserPermissionsErrors( 'edit', $user ),
157  $title->getUserPermissionsErrors( 'upload', $user )
158  );
159 
160  if ( $permissionErrors ) {
161  // Just return the first error
162  $msg = $this->parseMsg( $permissionErrors[0] );
163 
164  return $msg['info'];
165  }
166 
167  return null;
168  }
169 
170  public function mustBePosted() {
171  return true;
172  }
173 
174  public function isWriteMode() {
175  return true;
176  }
177 
178  public function getAllowedParams( $flags = 0 ) {
179  $result = array(
180  'rotation' => array(
181  ApiBase::PARAM_TYPE => array( '90', '180', '270' ),
183  ),
184  'token' => array(
185  ApiBase::PARAM_TYPE => 'string',
187  ),
188  );
189  if ( $flags ) {
190  $result += $this->getPageSet()->getFinalParams( $flags );
191  }
192 
193  return $result;
194  }
195 
196  public function getParamDescription() {
197  $pageSet = $this->getPageSet();
198 
199  return $pageSet->getFinalParamDescription() + array(
200  'rotation' => 'Degrees to rotate image clockwise',
201  'token' => 'Edit token. You can get one of these through action=tokens',
202  );
203  }
204 
205  public function getDescription() {
206  return 'Rotate one or more images.';
207  }
208 
209  public function needsToken() {
210  return true;
211  }
212 
213  public function getTokenSalt() {
214  return '';
215  }
216 
217  public function getPossibleErrors() {
218  $pageSet = $this->getPageSet();
219 
220  return array_merge(
221  parent::getPossibleErrors(),
222  $pageSet->getFinalPossibleErrors()
223  );
224  }
225 
226  public function getExamples() {
227  return array(
228  'api.php?action=imagerotate&titles=Example.jpg&rotation=90&token=123ABC',
229  );
230  }
231 }
$result
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. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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. '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 '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) '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. 'LinkBegin':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:1528
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
ApiBase\PARAM_REQUIRED
const PARAM_REQUIRED
Definition: ApiBase.php:62
ApiImageRotate\mustBePosted
mustBePosted()
Indicates whether this module must be called with a POST request.
Definition: ApiImageRotate.php:170
ApiBase\parseMsg
parseMsg( $error)
Return the error message related to a certain array.
Definition: ApiBase.php:1982
ApiImageRotate\getTokenSalt
getTokenSalt()
Returns the token salt if there is one, '' if the module doesn't require a salt, else false if the mo...
Definition: ApiImageRotate.php:213
ApiBase\PARAM_TYPE
const PARAM_TYPE
Definition: ApiBase.php:50
ApiImageRotate\getPageSet
getPageSet()
Get a cached instance of an ApiPageSet object.
Definition: ApiImageRotate.php:140
ApiBase\getResult
getResult()
Get the result object.
Definition: ApiBase.php:205
NS_FILE
const NS_FILE
Definition: Defines.php:85
$params
$params
Definition: styleTest.css.php:40
$flags
it s the revision text itself In either if gzip is the revision text is gzipped $flags
Definition: hooks.txt:2113
ContextSource\getUser
getUser()
Get the User object.
Definition: ContextSource.php:132
ApiPageSet
This class contains a list of pages that the client has requested.
Definition: ApiPageSet.php:41
ApiBase
This abstract class implements many basic API functions, and is the base of all API classes.
Definition: ApiBase.php:42
ApiImageRotate\addValues
static addValues(array &$result, $values, $flag=null, $name=null)
Add all items from $values into the result.
Definition: ApiImageRotate.php:34
ApiImageRotate\needsToken
needsToken()
Returns whether this module requires a token to execute It is used to show possible errors in action=...
Definition: ApiImageRotate.php:209
ApiImageRotate
Definition: ApiImageRotate.php:24
ApiImageRotate\getAllowedParams
getAllowedParams( $flags=0)
Definition: ApiImageRotate.php:178
ApiImageRotate\checkPermissions
checkPermissions( $user, $title)
Checks that the user has permissions to perform rotations.
Definition: ApiImageRotate.php:154
wfMessage
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 an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form externallinks including delete and has completed for all link tables 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
ApiImageRotate\getExamples
getExamples()
Returns usage examples for this module.
Definition: ApiImageRotate.php:226
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
$comment
$comment
Definition: importImages.php:107
ApiImageRotate\getDescription
getDescription()
Returns the description string for this module.
Definition: ApiImageRotate.php:205
ApiBase\extractRequestParams
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
TempFSFile\factory
static factory( $prefix, $extension='')
Make a new temporary file on the file system.
Definition: TempFSFile.php:44
ApiImageRotate\getPossibleErrors
getPossibleErrors()
Returns a list of all possible errors returned by the module.
Definition: ApiImageRotate.php:217
$user
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 account $user
Definition: hooks.txt:237
$file
if(PHP_SAPI !='cli') $file
Definition: UtfNormalTest2.php:30
Title
Represents a title within MediaWiki.
Definition: Title.php:35
ApiImageRotate\execute
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiImageRotate.php:51
$ext
$ext
Definition: NoLocalSettings.php:34
as
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
wfFindFile
wfFindFile( $title, $options=array())
Find a file.
Definition: GlobalFunctions.php:3702
ApiBase\getModuleName
getModuleName()
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
ApiImageRotate\getParamDescription
getParamDescription()
Returns an array of parameter descriptions.
Definition: ApiImageRotate.php:196
ApiImageRotate\isWriteMode
isWriteMode()
Indicates whether this module requires write mode.
Definition: ApiImageRotate.php:174
ApiQueryBase\addTitleInfo
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
Definition: ApiQueryBase.php:339
ApiImageRotate\$mPageSet
$mPageSet
Definition: ApiImageRotate.php:25