1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
<?php
/**
* API for MediaWiki 1.16+
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
*/
/**
* A query action to get image information from temporarily stashed files.
*
* @ingroup API
*/
class ApiQueryStashImageInfo extends ApiQueryImageInfo {
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'sii' );
}
public function execute() {
$params = $this->extractRequestParams();
$modulePrefix = $this->getModulePrefix();
$prop = array_flip( $params['prop'] );
$scale = $this->getScale( $params );
$result = $this->getResult();
try {
$stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash();
foreach ( $params['sessionkey'] as $sessionkey ) {
$file = $stash->getFile( $sessionkey );
$imageInfo = self::getInfo( $file, $prop, $result, $scale );
$result->addValue( array( 'query', $this->getModuleName() ), null, $imageInfo );
$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), $modulePrefix );
}
} catch ( UploadStashNotAvailableException $e ) {
$this->dieUsage( "Session not available: " . $e->getMessage(), "nosession" );
} catch ( UploadStashFileNotFoundException $e ) {
$this->dieUsage( "File not found: " . $e->getMessage(), "invalidsessiondata" );
} catch ( UploadStashBadPathException $e ) {
$this->dieUsage( "Bad path: " . $e->getMessage(), "invalidsessiondata" );
}
}
/**
* Returns all valid parameters to siiprop
*/
public static function getPropertyNames() {
return array(
'timestamp',
'url',
'size',
'dimensions', // For backwards compatibility with Allimages
'sha1',
'mime',
'thumbmime',
'metadata',
'bitdepth',
);
}
public function getAllowedParams() {
return array(
'sessionkey' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_REQUIRED => true,
ApiBase::PARAM_DFLT => null
),
'prop' => array(
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_DFLT => 'timestamp|url',
ApiBase::PARAM_TYPE => self::getPropertyNames()
),
'urlwidth' => array(
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => -1
),
'urlheight' => array(
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => -1
)
);
}
/**
* Return the API documentation for the parameters.
* @return {Array} parameter documentation.
*/
public function getParamDescription() {
$p = $this->getModulePrefix();
return array(
'prop' => array(
'What image information to get:',
' timestamp - Adds timestamp for the uploaded version',
' url - Gives URL to the image and the description page',
' size - Adds the size of the image in bytes and the height and width',
' dimensions - Alias for size',
' sha1 - Adds sha1 hash for the image',
' mime - Adds MIME of the image',
' thumbmime - Adss MIME of the image thumbnail (requires url)',
' metadata - Lists EXIF metadata for the version of the image',
' bitdepth - Adds the bit depth of the version',
),
'sessionkey' => 'Session key that identifies a previous upload that was stashed temporarily.',
'urlwidth' => "If {$p}prop=url is set, a URL to an image scaled to this width will be returned.",
'urlheight' => "Similar to {$p}urlwidth. Cannot be used without {$p}urlwidth"
);
}
public function getDescription() {
return 'Returns image information for stashed images';
}
public function getPossibleErrors() {
return array_merge( parent::getPossibleErrors(), array(
array( 'code' => 'siiurlwidth', 'info' => 'siiurlheight cannot be used without iiurlwidth' ),
) );
}
protected function getExamples() {
return array(
'api.php?action=query&prop=stashimageinfo&siisessionkey=124sd34rsdf567',
'api.php?action=query&prop=stashimageinfo&siisessionkey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url',
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryStashImageInfo.php 81000 2011-01-25 22:49:34Z catrope $';
}
}
|
