4 * API for MediaWiki 1.12+
6 * Created on Mar 16, 2008
8 * Copyright © 2008 Vasiliev Victor vasilvv@gmail.com,
9 * based on ApiQueryAllPages.php
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License along
22 * with this program; if not, write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
24 * http://www.gnu.org/copyleft/gpl.html
29 use Wikimedia\Rdbms\IDatabase
;
32 * Query module to enumerate all available pages.
36 class ApiQueryAllImages
extends ApiQueryGeneratorBase
{
39 public function __construct( ApiQuery
$query, $moduleName ) {
40 parent
::__construct( $query, $moduleName, 'ai' );
41 $this->mRepo
= RepoGroup
::singleton()->getLocalRepo();
45 * Override parent method to make sure the repo's DB is used
46 * which may not necessarily be the same as the local DB.
48 * TODO: allow querying non-local repos.
51 protected function getDB() {
52 return $this->mRepo
->getReplicaDB();
55 public function execute() {
59 public function getCacheMode( $params ) {
64 * @param ApiPageSet $resultPageSet
67 public function executeGenerator( $resultPageSet ) {
68 if ( $resultPageSet->isResolvingRedirects() ) {
69 $this->dieWithError( 'apierror-allimages-redirect', 'invalidparammix' );
72 $this->run( $resultPageSet );
76 * @param ApiPageSet $resultPageSet
79 private function run( $resultPageSet = null ) {
81 if ( !$repo instanceof LocalRepo
) {
82 $this->dieWithError( 'apierror-unsupportedrepo' );
85 $prefix = $this->getModulePrefix();
89 $params = $this->extractRequestParams();
90 $userId = !is_null( $params['user'] ) ? User
::idFromName( $params['user'] ) : null;
92 // Table and return fields
93 $this->addTables( 'image' );
95 $prop = array_flip( $params['prop'] );
96 $this->addFields( LocalFile
::selectFields() );
98 $ascendingOrder = true;
99 if ( $params['dir'] == 'descending' ||
$params['dir'] == 'older' ) {
100 $ascendingOrder = false;
103 if ( $params['sort'] == 'name' ) {
104 // Check mutually exclusive params
105 $disallowed = [ 'start', 'end', 'user' ];
106 foreach ( $disallowed as $pname ) {
107 if ( isset( $params[$pname] ) ) {
110 'apierror-invalidparammix-mustusewith',
112 "{$prefix}sort=timestamp"
118 if ( $params['filterbots'] != 'all' ) {
121 'apierror-invalidparammix-mustusewith',
122 "{$prefix}filterbots",
123 "{$prefix}sort=timestamp"
130 if ( !is_null( $params['continue'] ) ) {
131 $cont = explode( '|', $params['continue'] );
132 $this->dieContinueUsageIf( count( $cont ) != 1 );
133 $op = ( $ascendingOrder ?
'>' : '<' );
134 $continueFrom = $db->addQuotes( $cont[0] );
135 $this->addWhere( "img_name $op= $continueFrom" );
139 $from = ( $params['from'] === null ?
null : $this->titlePartToKey( $params['from'], NS_FILE
) );
140 $to = ( $params['to'] === null ?
null : $this->titlePartToKey( $params['to'], NS_FILE
) );
141 $this->addWhereRange( 'img_name', ( $ascendingOrder ?
'newer' : 'older' ), $from, $to );
143 if ( isset( $params['prefix'] ) ) {
144 $this->addWhere( 'img_name' . $db->buildLike(
145 $this->titlePartToKey( $params['prefix'], NS_FILE
),
146 $db->anyString() ) );
149 // Check mutually exclusive params
150 $disallowed = [ 'from', 'to', 'prefix' ];
151 foreach ( $disallowed as $pname ) {
152 if ( isset( $params[$pname] ) ) {
155 'apierror-invalidparammix-mustusewith',
163 if ( !is_null( $params['user'] ) && $params['filterbots'] != 'all' ) {
164 // Since filterbots checks if each user has the bot right, it
165 // doesn't make sense to use it with user
167 [ 'apierror-invalidparammix-cannotusewith', "{$prefix}user", "{$prefix}filterbots" ]
172 $this->addTimestampWhereRange(
174 $ascendingOrder ?
'newer' : 'older',
178 // Include in ORDER BY for uniqueness
179 $this->addWhereRange( 'img_name', $ascendingOrder ?
'newer' : 'older', null, null );
181 if ( !is_null( $params['continue'] ) ) {
182 $cont = explode( '|', $params['continue'] );
183 $this->dieContinueUsageIf( count( $cont ) != 2 );
184 $op = ( $ascendingOrder ?
'>' : '<' );
185 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
186 $continueName = $db->addQuotes( $cont[1] );
187 $this->addWhere( "img_timestamp $op $continueTimestamp OR " .
188 "(img_timestamp = $continueTimestamp AND " .
189 "img_name $op= $continueName)"
194 if ( !is_null( $params['user'] ) ) {
196 $this->addWhereFld( 'img_user', $userId );
198 $this->addWhereFld( 'img_user_text', $params['user'] );
201 if ( $params['filterbots'] != 'all' ) {
202 $this->addTables( 'user_groups' );
203 $this->addJoinConds( [ 'user_groups' => [
206 'ug_group' => User
::getGroupsWithPermission( 'bot' ),
207 'ug_user = img_user',
208 'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
211 $groupCond = ( $params['filterbots'] == 'nobots' ?
'NULL' : 'NOT NULL' );
212 $this->addWhere( "ug_group IS $groupCond" );
216 // Filters not depending on sort
217 if ( isset( $params['minsize'] ) ) {
218 $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
221 if ( isset( $params['maxsize'] ) ) {
222 $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
226 if ( isset( $params['sha1'] ) ) {
227 $sha1 = strtolower( $params['sha1'] );
228 if ( !$this->validateSha1Hash( $sha1 ) ) {
229 $this->dieWithError( 'apierror-invalidsha1hash' );
231 $sha1 = Wikimedia\base_convert
( $sha1, 16, 36, 31 );
232 } elseif ( isset( $params['sha1base36'] ) ) {
233 $sha1 = strtolower( $params['sha1base36'] );
234 if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
235 $this->dieWithError( 'apierror-invalidsha1base36hash' );
239 $this->addWhereFld( 'img_sha1', $sha1 );
242 if ( !is_null( $params['mime'] ) ) {
243 if ( $this->getConfig()->get( 'MiserMode' ) ) {
244 $this->dieWithError( 'apierror-mimesearchdisabled' );
248 foreach ( $params['mime'] as $mime ) {
249 list( $major, $minor ) = File
::splitMime( $mime );
250 $mimeConds[] = $db->makeList(
252 'img_major_mime' => $major,
253 'img_minor_mime' => $minor,
258 // safeguard against internal_api_error_DBQueryError
259 if ( count( $mimeConds ) > 0 ) {
260 $this->addWhere( $db->makeList( $mimeConds, LIST_OR
) );
262 // no MIME types, no files
263 $this->getResult()->addValue( 'query', $this->getModuleName(), [] );
268 $limit = $params['limit'];
269 $this->addOption( 'LIMIT', $limit +
1 );
271 if ( !$ascendingOrder ) {
274 if ( $params['sort'] == 'timestamp' ) {
275 $this->addOption( 'ORDER BY', 'img_timestamp' . $sortFlag );
276 if ( !is_null( $params['user'] ) ) {
278 $this->addOption( 'USE INDEX', [ 'image' => 'img_user_timestamp' ] );
280 $this->addOption( 'USE INDEX', [ 'image' => 'img_usertext_timestamp' ] );
283 $this->addOption( 'USE INDEX', [ 'image' => 'img_timestamp' ] );
286 $this->addOption( 'ORDER BY', 'img_name' . $sortFlag );
289 $res = $this->select( __METHOD__
);
293 $result = $this->getResult();
294 foreach ( $res as $row ) {
295 if ( ++
$count > $limit ) {
296 // We've reached the one extra which shows that there are
297 // additional pages to be had. Stop here...
298 if ( $params['sort'] == 'name' ) {
299 $this->setContinueEnumParameter( 'continue', $row->img_name
);
301 $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
306 if ( is_null( $resultPageSet ) ) {
307 $file = $repo->newFileFromRow( $row );
308 $info = array_merge( [ 'name' => $row->img_name
],
309 ApiQueryImageInfo
::getInfo( $file, $prop, $result ) );
310 self
::addTitleInfo( $info, $file->getTitle() );
312 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $info );
314 if ( $params['sort'] == 'name' ) {
315 $this->setContinueEnumParameter( 'continue', $row->img_name
);
317 $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
322 $titles[] = Title
::makeTitle( NS_FILE
, $row->img_name
);
326 if ( is_null( $resultPageSet ) ) {
327 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'img' );
329 $resultPageSet->populateFromTitles( $titles );
333 public function getAllowedParams() {
336 ApiBase
::PARAM_DFLT
=> 'name',
337 ApiBase
::PARAM_TYPE
=> [
343 ApiBase
::PARAM_DFLT
=> 'ascending',
344 ApiBase
::PARAM_TYPE
=> [
356 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
359 ApiBase
::PARAM_TYPE
=> 'timestamp'
362 ApiBase
::PARAM_TYPE
=> 'timestamp'
365 ApiBase
::PARAM_TYPE
=> ApiQueryImageInfo
::getPropertyNames( $this->propertyFilter
),
366 ApiBase
::PARAM_DFLT
=> 'timestamp|url',
367 ApiBase
::PARAM_ISMULTI
=> true,
368 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-query+imageinfo-param-prop',
369 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=>
370 ApiQueryImageInfo
::getPropertyMessages( $this->propertyFilter
),
374 ApiBase
::PARAM_TYPE
=> 'integer',
377 ApiBase
::PARAM_TYPE
=> 'integer',
380 'sha1base36' => null,
382 ApiBase
::PARAM_TYPE
=> 'user'
385 ApiBase
::PARAM_DFLT
=> 'all',
386 ApiBase
::PARAM_TYPE
=> [
393 ApiBase
::PARAM_ISMULTI
=> true,
396 ApiBase
::PARAM_DFLT
=> 10,
397 ApiBase
::PARAM_TYPE
=> 'limit',
398 ApiBase
::PARAM_MIN
=> 1,
399 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
400 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
404 if ( $this->getConfig()->get( 'MiserMode' ) ) {
405 $ret['mime'][ApiBase
::PARAM_HELP_MSG
] = 'api-help-param-disabled-in-miser-mode';
411 private $propertyFilter = [ 'archivename', 'thumbmime', 'uploadwarning' ];
413 protected function getExamplesMessages() {
415 'action=query&list=allimages&aifrom=B'
416 => 'apihelp-query+allimages-example-B',
417 'action=query&list=allimages&aiprop=user|timestamp|url&' .
418 'aisort=timestamp&aidir=older'
419 => 'apihelp-query+allimages-example-recent',
420 'action=query&list=allimages&aimime=image/png|image/gif'
421 => 'apihelp-query+allimages-example-mimetypes',
422 'action=query&generator=allimages&gailimit=4&' .
423 'gaifrom=T&prop=imageinfo'
424 => 'apihelp-query+allimages-example-generator',
428 public function getHelpUrls() {
429 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allimages';