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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
|
<?php
/**
* API for MediaWiki 1.12+
*
* Created on Mar 16, 2008
*
* Copyright © 2008 Vasiliev Victor vasilvv@gmail.com,
* based on ApiQueryAllpages.php
*
* 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
*/
if ( !defined( 'MEDIAWIKI' ) ) {
// Eclipse helper - will be ignored in production
require_once( 'ApiQueryBase.php' );
}
/**
* Query module to enumerate all available pages.
*
* @ingroup API
*/
class ApiQueryAllimages extends ApiQueryGeneratorBase {
protected $mRepo;
public function __construct( $query, $moduleName ) {
parent::__construct( $query, $moduleName, 'ai' );
$this->mRepo = RepoGroup::singleton()->getLocalRepo();
}
/**
* Override parent method to make sure to make sure the repo's DB is used
* which may not necesarilly be the same as the local DB.
*
* TODO: allow querying non-local repos.
* @return DatabaseBase
*/
protected function getDB() {
return $this->mRepo->getSlaveDB();
}
public function execute() {
$this->run();
}
public function getCacheMode( $params ) {
return 'public';
}
/**
* @param $resultPageSet ApiPageSet
* @return void
*/
public function executeGenerator( $resultPageSet ) {
if ( $resultPageSet->isResolvingRedirects() ) {
$this->dieUsage( 'Use "gaifilterredir=nonredirects" option instead of "redirects" when using allimages as a generator', 'params' );
}
$this->run( $resultPageSet );
}
/**
* @param $resultPageSet ApiPageSet
* @return void
*/
private function run( $resultPageSet = null ) {
$repo = $this->mRepo;
if ( !$repo instanceof LocalRepo ) {
$this->dieUsage( 'Local file repository does not support querying all images', 'unsupportedrepo' );
}
$db = $this->getDB();
$params = $this->extractRequestParams();
// Image filters
$dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
$from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) );
$to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) );
$this->addWhereRange( 'img_name', $dir, $from, $to );
if ( isset( $params['prefix'] ) )
$this->addWhere( 'img_name' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
if ( isset( $params['minsize'] ) ) {
$this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
}
if ( isset( $params['maxsize'] ) ) {
$this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
}
$sha1 = false;
if ( isset( $params['sha1'] ) ) {
if ( !$this->validateSha1Hash( $params['sha1'] ) ) {
$this->dieUsage( 'The SHA1 hash provided is not valid', 'invalidsha1hash' );
}
$sha1 = wfBaseConvert( $params['sha1'], 16, 36, 31 );
} elseif ( isset( $params['sha1base36'] ) ) {
$sha1 = $params['sha1base36'];
if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
$this->dieUsage( 'The SHA1Base36 hash provided is not valid', 'invalidsha1base36hash' );
}
}
if ( $sha1 ) {
$this->addWhereFld( 'img_sha1', $sha1 );
}
if ( !is_null( $params['mime'] ) ) {
global $wgMiserMode;
if ( $wgMiserMode ) {
$this->dieUsage( 'MIME search disabled in Miser Mode', 'mimesearchdisabled' );
}
list( $major, $minor ) = File::splitMime( $params['mime'] );
$this->addWhereFld( 'img_major_mime', $major );
$this->addWhereFld( 'img_minor_mime', $minor );
}
$this->addTables( 'image' );
$prop = array_flip( $params['prop'] );
$this->addFields( LocalFile::selectFields() );
$limit = $params['limit'];
$this->addOption( 'LIMIT', $limit + 1 );
$this->addOption( 'ORDER BY', 'img_name' .
( $params['dir'] == 'descending' ? ' DESC' : '' ) );
$res = $this->select( __METHOD__ );
$titles = array();
$count = 0;
$result = $this->getResult();
foreach ( $res as $row ) {
if ( ++ $count > $limit ) {
// We've reached the one extra which shows that there are additional pages to be had. Stop here...
// TODO: Security issue - if the user has no right to view next title, it will still be shown
$this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->img_name ) );
break;
}
if ( is_null( $resultPageSet ) ) {
$file = $repo->newFileFromRow( $row );
$info = array_merge( array( 'name' => $row->img_name ),
ApiQueryImageInfo::getInfo( $file, $prop, $result ) );
self::addTitleInfo( $info, $file->getTitle() );
$fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $info );
if ( !$fit ) {
$this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->img_name ) );
break;
}
} else {
$titles[] = Title::makeTitle( NS_IMAGE, $row->img_name );
}
}
if ( is_null( $resultPageSet ) ) {
$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'img' );
} else {
$resultPageSet->populateFromTitles( $titles );
}
}
public function getAllowedParams() {
return array (
'from' => null,
'to' => null,
'prefix' => null,
'minsize' => array(
ApiBase::PARAM_TYPE => 'integer',
),
'maxsize' => array(
ApiBase::PARAM_TYPE => 'integer',
),
'limit' => array(
ApiBase::PARAM_DFLT => 10,
ApiBase::PARAM_TYPE => 'limit',
ApiBase::PARAM_MIN => 1,
ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
),
'dir' => array(
ApiBase::PARAM_DFLT => 'ascending',
ApiBase::PARAM_TYPE => array(
'ascending',
'descending'
)
),
'sha1' => null,
'sha1base36' => null,
'prop' => array(
ApiBase::PARAM_TYPE => ApiQueryImageInfo::getPropertyNames( $this->propertyFilter ),
ApiBase::PARAM_DFLT => 'timestamp|url',
ApiBase::PARAM_ISMULTI => true
),
'mime' => null,
);
}
public function getParamDescription() {
return array(
'from' => 'The image title to start enumerating from',
'to' => 'The image title to stop enumerating at',
'prefix' => 'Search for all image titles that begin with this value',
'dir' => 'The direction in which to list',
'minsize' => 'Limit to images with at least this many bytes',
'maxsize' => 'Limit to images with at most this many bytes',
'limit' => 'How many images in total to return',
'sha1' => "SHA1 hash of image. Overrides {$this->getModulePrefix()}sha1base36",
'sha1base36' => 'SHA1 hash of image in base 36 (used in MediaWiki)',
'prop' => ApiQueryImageInfo::getPropertyDescriptions( $this->propertyFilter ),
'mime' => 'What MIME type to search for. e.g. image/jpeg. Disabled in Miser Mode',
);
}
private $propertyFilter = array( 'archivename' );
public function getDescription() {
return 'Enumerate all images sequentially';
}
public function getPossibleErrors() {
return array_merge( parent::getPossibleErrors(), array(
array( 'code' => 'params', 'info' => 'Use "gaifilterredir=nonredirects" option instead of "redirects" when using allimages as a generator' ),
array( 'code' => 'unsupportedrepo', 'info' => 'Local file repository does not support querying all images' ),
array( 'code' => 'mimesearchdisabled', 'info' => 'MIME search disabled in Miser Mode' ),
array( 'code' => 'invalidsha1hash', 'info' => 'The SHA1 hash provided is not valid' ),
array( 'code' => 'invalidsha1base36hash', 'info' => 'The SHA1Base36 hash provided is not valid' ),
) );
}
protected function getExamples() {
return array(
'Simple Use',
' Show a list of images starting at the letter "B"',
' api.php?action=query&list=allimages&aifrom=B',
'Using as Generator',
' Show info about 4 images starting at the letter "T"',
' api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo',
);
}
public function getHelpUrls() {
return 'https://www.mediawiki.org/wiki/API:Allimages';
}
public function getVersion() {
return __CLASS__ . ': $Id$';
}
}
|
