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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
|
<?php
/*
* Created on July 6, 2007
*
* API for MediaWiki 1.8+
*
* Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
*
* 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.,
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
* http://www.gnu.org/copyleft/gpl.html
*/
if (!defined('MEDIAWIKI')) {
// Eclipse helper - will be ignored in production
require_once ('ApiQueryBase.php');
}
/**
* A query action to get image information and upload history.
*
* @ingroup API
*/
class ApiQueryImageInfo extends ApiQueryBase {
public function __construct($query, $moduleName) {
parent :: __construct($query, $moduleName, 'ii');
}
public function execute() {
$params = $this->extractRequestParams();
$prop = array_flip($params['prop']);
if($params['urlheight'] != -1 && $params['urlwidth'] == -1)
$this->dieUsage("iiurlheight cannot be used without iiurlwidth", 'iiurlwidth');
if ( $params['urlwidth'] != -1 ) {
$scale = array();
$scale['width'] = $params['urlwidth'];
$scale['height'] = $params['urlheight'];
} else {
$scale = null;
}
$pageIds = $this->getPageSet()->getAllTitlesByNamespace();
if (!empty($pageIds[NS_FILE])) {
$result = $this->getResult();
$images = RepoGroup::singleton()->findFiles( array_keys( $pageIds[NS_FILE] ) );
foreach ( $images as $img ) {
$data = array();
// Get information about the current version first
// Check that the current version is within the start-end boundaries
if((is_null($params['start']) || $img->getTimestamp() <= $params['start']) &&
(is_null($params['end']) || $img->getTimestamp() >= $params['end'])) {
$data[] = self::getInfo( $img, $prop, $result, $scale );
}
// Now get the old revisions
// Get one more to facilitate query-continue functionality
$count = count($data);
$oldies = $img->getHistory($params['limit'] - $count + 1, $params['start'], $params['end']);
foreach($oldies as $oldie) {
if(++$count > $params['limit']) {
// We've reached the extra one which shows that there are additional pages to be had. Stop here...
// Only set a query-continue if there was only one title
if(count($pageIds[NS_FILE]) == 1)
$this->setContinueEnumParameter('start', $oldie->getTimestamp());
break;
}
$data[] = self::getInfo( $oldie, $prop, $result );
}
$pageId = $pageIds[NS_FILE][ $img->getOriginalTitle()->getDBkey() ];
$result->addValue(
array( 'query', 'pages', intval( $pageId ) ),
'imagerepository', $img->getRepoName()
);
$this->addPageSubItems($pageId, $data);
}
$missing = array_diff( array_keys( $pageIds[NS_FILE] ), array_keys( $images ) );
foreach ( $missing as $title )
$result->addValue(
array( 'query', 'pages', intval( $pageIds[NS_FILE][$title] ) ),
'imagerepository', ''
);
}
}
/**
* Get result information for an image revision
* @param File f The image
* @return array Result array
*/
static function getInfo($file, $prop, $result, $scale = null) {
$vals = array();
if( isset( $prop['timestamp'] ) )
$vals['timestamp'] = wfTimestamp(TS_ISO_8601, $file->getTimestamp());
if( isset( $prop['user'] ) ) {
$vals['user'] = $file->getUser();
if( !$file->getUser( 'id' ) )
$vals['anon'] = '';
}
if( isset( $prop['size'] ) || isset( $prop['dimensions'] ) ) {
$vals['size'] = intval( $file->getSize() );
$vals['width'] = intval( $file->getWidth() );
$vals['height'] = intval( $file->getHeight() );
}
if( isset( $prop['url'] ) ) {
if( !is_null( $scale ) && !$file->isOld() ) {
$mto = $file->transform( array( 'width' => $scale['width'], 'height' => $scale['height'] ) );
if( $mto && !$mto->isError() )
{
$vals['thumburl'] = $mto->getUrl();
$vals['thumbwidth'] = $mto->getWidth();
$vals['thumbheight'] = $mto->getHeight();
}
}
$vals['url'] = $file->getFullURL();
$vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl() );
}
if( isset( $prop['comment'] ) )
$vals['comment'] = $file->getDescription();
if( isset( $prop['sha1'] ) )
$vals['sha1'] = wfBaseConvert( $file->getSha1(), 36, 16, 40 );
if( isset( $prop['metadata'] ) ) {
$metadata = $file->getMetadata();
$vals['metadata'] = $metadata ? unserialize( $metadata ) : null;
$result->setIndexedTagName_recursive( $vals['metadata'], 'meta' );
}
if( isset( $prop['mime'] ) )
$vals['mime'] = $file->getMimeType();
if( isset( $prop['archivename'] ) && $file->isOld() )
$vals['archivename'] = $file->getArchiveName();
if( isset( $prop['bitdepth'] ) )
$vals['bitdepth'] = $file->getBitDepth();
return $vals;
}
public function getAllowedParams() {
return array (
'prop' => array (
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_DFLT => 'timestamp|user',
ApiBase :: PARAM_TYPE => array (
'timestamp',
'user',
'comment',
'url',
'size',
'sha1',
'mime',
'metadata',
'archivename',
'bitdepth',
)
),
'limit' => array(
ApiBase :: PARAM_TYPE => 'limit',
ApiBase :: PARAM_DFLT => 1,
ApiBase :: PARAM_MIN => 1,
ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
),
'start' => array(
ApiBase :: PARAM_TYPE => 'timestamp'
),
'end' => array(
ApiBase :: PARAM_TYPE => 'timestamp'
),
'urlwidth' => array(
ApiBase :: PARAM_TYPE => 'integer',
ApiBase :: PARAM_DFLT => -1
),
'urlheight' => array(
ApiBase :: PARAM_TYPE => 'integer',
ApiBase :: PARAM_DFLT => -1
)
);
}
public function getParamDescription() {
return array (
'prop' => 'What image information to get.',
'limit' => 'How many image revisions to return',
'start' => 'Timestamp to start listing from',
'end' => 'Timestamp to stop listing at',
'urlwidth' => array('If iiprop=url is set, a URL to an image scaled to this width will be returned.',
'Only the current version of the image can be scaled.'),
'urlheight' => 'Similar to iiurlwidth. Cannot be used without iiurlwidth',
);
}
public function getDescription() {
return array (
'Returns image information and upload history'
);
}
protected function getExamples() {
return array (
'api.php?action=query&titles=Image:Albert%20Einstein%20Head.jpg&prop=imageinfo',
'api.php?action=query&titles=Image:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url',
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiQueryImageInfo.php 44121 2008-12-01 17:14:30Z vyznev $';
}
}
|
