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
|
<?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( ApiQuery $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'sii' );
}
public function execute() {
if ( !$this->getUser()->isLoggedIn() ) {
$this->dieUsage( 'You must be logged-in to have an upload stash', 'notloggedin' );
}
$params = $this->extractRequestParams();
$modulePrefix = $this->getModulePrefix();
$prop = array_flip( $params['prop'] );
$scale = $this->getScale( $params );
$result = $this->getResult();
if ( !$params['filekey'] && !$params['sessionkey'] ) {
$this->dieUsage( 'One of filekey or sessionkey must be supplied', 'nofilekey' );
}
// Alias sessionkey to filekey, but give an existing filekey precedence.
if ( !$params['filekey'] && $params['sessionkey'] ) {
$params['filekey'] = $params['sessionkey'];
}
try {
$stash = RepoGroup::singleton()->getLocalRepo()->getUploadStash( $this->getUser() );
foreach ( $params['filekey'] as $filekey ) {
$file = $stash->getFile( $filekey );
$finalThumbParam = $this->mergeThumbParams( $file, $scale, $params['urlparam'] );
$imageInfo = ApiQueryImageInfo::getInfo( $file, $prop, $result, $finalThumbParam );
$result->addValue( [ 'query', $this->getModuleName() ], null, $imageInfo );
$result->addIndexedTagName( [ 'query', $this->getModuleName() ], $modulePrefix );
}
// @todo Update exception handling here to understand current getFile exceptions
} catch ( UploadStashFileNotFoundException $e ) {
$this->dieUsage( 'File not found: ' . $e->getMessage(), 'invalidsessiondata' );
} catch ( UploadStashBadPathException $e ) {
$this->dieUsage( 'Bad path: ' . $e->getMessage(), 'invalidsessiondata' );
}
}
private $propertyFilter = [
'user', 'userid', 'comment', 'parsedcomment',
'mediatype', 'archivename', 'uploadwarning',
];
public function getAllowedParams() {
return [
'filekey' => [
ApiBase::PARAM_ISMULTI => true,
],
'sessionkey' => [
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_DEPRECATED => true,
],
'prop' => [
ApiBase::PARAM_ISMULTI => true,
ApiBase::PARAM_DFLT => 'timestamp|url',
ApiBase::PARAM_TYPE => self::getPropertyNames( $this->propertyFilter ),
ApiBase::PARAM_HELP_MSG => 'apihelp-query+imageinfo-param-prop',
ApiBase::PARAM_HELP_MSG_PER_VALUE => self::getPropertyMessages( $this->propertyFilter )
],
'urlwidth' => [
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => -1,
ApiBase::PARAM_HELP_MSG => [
'apihelp-query+imageinfo-param-urlwidth',
ApiQueryImageInfo::TRANSFORM_LIMIT,
],
],
'urlheight' => [
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => -1,
ApiBase::PARAM_HELP_MSG => 'apihelp-query+imageinfo-param-urlheight',
],
'urlparam' => [
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_HELP_MSG => 'apihelp-query+imageinfo-param-urlparam',
],
];
}
protected function getExamplesMessages() {
return [
'action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567'
=> 'apihelp-query+stashimageinfo-example-simple',
'action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&' .
'siiurlwidth=120&siiprop=url'
=> 'apihelp-query+stashimageinfo-example-params',
];
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Stashimageinfo';
}
}
|
