3 * API for MediaWiki 1.16+
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * A query action to get image information from temporarily stashed files.
28 class ApiQueryStashImageInfo
extends ApiQueryImageInfo
{
30 public function __construct( $query, $moduleName ) {
31 parent
::__construct( $query, $moduleName, 'sii' );
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();
45 $stash = new UploadStash();
47 foreach ( $params['sessionkey'] as $sessionkey ) {
48 $file = $stash->getFile( $sessionkey );
49 $imageInfo = self
::getInfo( $file, $prop, $result, $scale );
50 $result->addValue( array( 'query', $this->getModuleName() ), null, $imageInfo );
51 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $modulePrefix );
54 } catch ( UploadStashNotAvailableException
$e ) {
55 $this->dieUsage( "Session not available: " . $e->getMessage(), "nosession" );
56 } catch ( UploadStashFileNotFoundException
$e ) {
57 $this->dieUsage( "File not found: " . $e->getMessage(), "invalidsessiondata" );
58 } catch ( UploadStashBadPathException
$e ) {
59 $this->dieUsage( "Bad path: " . $e->getMessage(), "invalidsessiondata" );
65 * Returns all valid parameters to siiprop
67 public static function getPropertyNames() {
72 'dimensions', // For backwards compatibility with Allimages
82 public function getAllowedParams() {
84 'sessionkey' => array(
85 ApiBase
::PARAM_ISMULTI
=> true,
86 ApiBase
::PARAM_REQUIRED
=> true,
87 ApiBase
::PARAM_DFLT
=> null
90 ApiBase
::PARAM_ISMULTI
=> true,
91 ApiBase
::PARAM_DFLT
=> 'timestamp|url',
92 ApiBase
::PARAM_TYPE
=> self
::getPropertyNames()
95 ApiBase
::PARAM_TYPE
=> 'integer',
96 ApiBase
::PARAM_DFLT
=> -1
99 ApiBase
::PARAM_TYPE
=> 'integer',
100 ApiBase
::PARAM_DFLT
=> -1
106 * Return the API documentation for the parameters.
107 * @return {Array} parameter documentation.
109 public function getParamDescription() {
110 $p = $this->getModulePrefix();
113 'What image information to get:',
114 ' timestamp - Adds timestamp for the uploaded version',
115 ' url - Gives URL to the image and the description page',
116 ' size - Adds the size of the image in bytes and the height and width',
117 ' dimensions - Alias for size',
118 ' sha1 - Adds sha1 hash for the image',
119 ' mime - Adds MIME of the image',
120 ' thumbmime - Adss MIME of the image thumbnail (requires url)',
121 ' metadata - Lists EXIF metadata for the version of the image',
122 ' bitdepth - Adds the bit depth of the version',
124 'sessionkey' => 'Session key that identifies a previous upload that was stashed temporarily.',
125 'urlwidth' => "If {$p}prop=url is set, a URL to an image scaled to this width will be returned.",
126 'urlheight' => "Similar to {$p}urlwidth. Cannot be used without {$p}urlwidth"
130 public function getDescription() {
131 return 'Returns image information for stashed images';
134 public function getPossibleErrors() {
135 return array_merge( parent
::getPossibleErrors(), array(
136 array( 'code' => 'siiurlwidth', 'info' => 'siiurlheight cannot be used without iiurlwidth' ),
140 protected function getExamples() {
142 'api.php?action=query&prop=stashimageinfo&siisessionkey=124sd34rsdf567',
143 'api.php?action=query&prop=stashimageinfo&siisessionkey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url',
147 public function getVersion() {
148 return __CLASS__
. ': $Id$';