MediaWiki  1.23.8
Go to the documentation of this file.
1 <?php
30  public function __construct( $query, $moduleName ) {
31  parent::__construct( $query, $moduleName, 'sii' );
32  }
34  public function execute() {
35  $params = $this->extractRequestParams();
36  $modulePrefix = $this->getModulePrefix();
38  $prop = array_flip( $params['prop'] );
40  $scale = $this->getScale( $params );
42  $result = $this->getResult();
44  if ( !$params['filekey'] && !$params['sessionkey'] ) {
45  $this->dieUsage( "One of filekey or sessionkey must be supplied", 'nofilekey' );
46  }
48  // Alias sessionkey to filekey, but give an existing filekey precedence.
49  if ( !$params['filekey'] && $params['sessionkey'] ) {
50  $params['filekey'] = $params['sessionkey'];
51  }
53  try {
54  $stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash();
56  foreach ( $params['filekey'] as $filekey ) {
57  $file = $stash->getFile( $filekey );
58  $finalThumbParam = $this->mergeThumbParams( $file, $scale, $params['urlparam'] );
59  $imageInfo = ApiQueryImageInfo::getInfo( $file, $prop, $result, $finalThumbParam );
60  $result->addValue( array( 'query', $this->getModuleName() ), null, $imageInfo );
61  $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $modulePrefix );
62  }
63  // @todo Update exception handling here to understand current getFile exceptions
65  $this->dieUsage( "Session not available: " . $e->getMessage(), "nosession" );
67  $this->dieUsage( "File not found: " . $e->getMessage(), "invalidsessiondata" );
68  } catch ( UploadStashBadPathException $e ) {
69  $this->dieUsage( "Bad path: " . $e->getMessage(), "invalidsessiondata" );
70  }
71  }
74  'user', 'userid', 'comment', 'parsedcomment',
75  'mediatype', 'archivename', 'uploadwarning',
76  );
78  public function getAllowedParams() {
79  return array(
80  'filekey' => array(
81  ApiBase::PARAM_ISMULTI => true,
82  ApiBase::PARAM_DFLT => null
83  ),
84  'sessionkey' => array(
85  ApiBase::PARAM_ISMULTI => true,
87  ApiBase::PARAM_DFLT => null
88  ),
89  'prop' => array(
90  ApiBase::PARAM_ISMULTI => true,
91  ApiBase::PARAM_DFLT => 'timestamp|url',
92  ApiBase::PARAM_TYPE => self::getPropertyNames( $this->propertyFilter )
93  ),
94  'urlwidth' => array(
95  ApiBase::PARAM_TYPE => 'integer',
97  ),
98  'urlheight' => array(
99  ApiBase::PARAM_TYPE => 'integer',
100  ApiBase::PARAM_DFLT => -1
101  ),
102  'urlparam' => array(
103  ApiBase::PARAM_TYPE => 'string',
104  ApiBase::PARAM_DFLT => '',
105  ),
106  );
107  }
113  public function getParamDescription() {
114  $p = $this->getModulePrefix();
116  return array(
117  'prop' => self::getPropertyDescriptions( $this->propertyFilter, $p ),
118  'filekey' => 'Key that identifies a previous upload that was stashed temporarily.',
119  'sessionkey' => 'Alias for filekey, for backward compatibility.',
120  'urlwidth' => "If {$p}prop=url is set, a URL to an image scaled to this width will be returned.",
121  'urlheight' => "Similar to {$p}urlwidth. Cannot be used without {$p}urlwidth",
122  'urlparam' => array( "A handler specific parameter string. For example, pdf's ",
123  "might use 'page15-100px'. {$p}urlwidth must be used and be consistent with {$p}urlparam" ),
124  );
125  }
127  public function getResultProperties() {
128  return ApiQueryImageInfo::getResultPropertiesFiltered( $this->propertyFilter );
129  }
131  public function getDescription() {
132  return 'Returns image information for stashed images.';
133  }
135  public function getExamples() {
136  return array(
137  'api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567',
138  'api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&' .
139  'siiurlwidth=120&siiprop=url',
140  );
141  }
142 }
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
A query action to get image information from temporarily stashed files.
Definition: ApiQueryStashImageInfo.php:28
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:53
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
Definition: UploadStash.php:682
mergeThumbParams( $image, $thumbParams, $otherParams)
Validate and merge scale parameters with handler thumb parameters, give error if invalid.
Definition: ApiQueryImageInfo.php:258
Definition: ApiBase.php:50
Get the result object.
Definition: ApiBase.php:205
Definition: styleTest.css.php:40
A query action to get image information and upload history.
Definition: ApiQueryImageInfo.php:32
static getInfo( $file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
Definition: ApiQueryImageInfo.php:330
Returns the description string for this module.
Definition: ApiQueryStashImageInfo.php:131
static getResultPropertiesFiltered( $filter=array())
Definition: ApiQueryImageInfo.php:744
Definition: ApiBase.php:60
Definition: UploadStash.php:680
__construct( $query, $moduleName)
Definition: ApiQueryStashImageInfo.php:30
Definition: ApiQueryStashImageInfo.php:73
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:165
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition: ApiBase.php:687
Evaluates the parameters, performs the requested query, and sets up the result.
Definition: ApiQueryStashImageInfo.php:34
Return the API documentation for the parameters.
Definition: ApiQueryStashImageInfo.php:113
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1363
Definition: UploadStash.php:681
if(PHP_SAPI !='cli') $file
Definition: UtfNormalTest2.php:30
Definition: ApiBase.php:46
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
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
Definition: ApiQueryStashImageInfo.php:78
Get the name of the module being executed by this instance.
Definition: ApiBase.php:148
Definition: ApiBase.php:48
getScale( $params)
From parameters, construct a 'scale' array.
Definition: ApiQueryImageInfo.php:227
if( $useReadline) $e
Definition: eval.php:66
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
Returns possible properties in the result, grouped by the value of the prop parameter that shows them...
Definition: ApiQueryStashImageInfo.php:127
Returns usage examples for this module.
Definition: ApiQueryStashImageInfo.php:135