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();
91 // Table and return fields
92 $this->addTables( 'image' );
94 $prop = array_flip( $params['prop'] );
95 $this->addFields( LocalFile
::selectFields() );
97 $ascendingOrder = true;
98 if ( $params['dir'] == 'descending' ||
$params['dir'] == 'older' ) {
99 $ascendingOrder = false;
102 if ( $params['sort'] == 'name' ) {
103 // Check mutually exclusive params
104 $disallowed = [ 'start', 'end', 'user' ];
105 foreach ( $disallowed as $pname ) {
106 if ( isset( $params[$pname] ) ) {
109 'apierror-invalidparammix-mustusewith',
111 "{$prefix}sort=timestamp"
117 if ( $params['filterbots'] != 'all' ) {
120 'apierror-invalidparammix-mustusewith',
121 "{$prefix}filterbots",
122 "{$prefix}sort=timestamp"
129 if ( !is_null( $params['continue'] ) ) {
130 $cont = explode( '|', $params['continue'] );
131 $this->dieContinueUsageIf( count( $cont ) != 1 );
132 $op = ( $ascendingOrder ?
'>' : '<' );
133 $continueFrom = $db->addQuotes( $cont[0] );
134 $this->addWhere( "img_name $op= $continueFrom" );
138 $from = ( $params['from'] === null ?
null : $this->titlePartToKey( $params['from'], NS_FILE
) );
139 $to = ( $params['to'] === null ?
null : $this->titlePartToKey( $params['to'], NS_FILE
) );
140 $this->addWhereRange( 'img_name', ( $ascendingOrder ?
'newer' : 'older' ), $from, $to );
142 if ( isset( $params['prefix'] ) ) {
143 $this->addWhere( 'img_name' . $db->buildLike(
144 $this->titlePartToKey( $params['prefix'], NS_FILE
),
145 $db->anyString() ) );
148 // Check mutually exclusive params
149 $disallowed = [ 'from', 'to', 'prefix' ];
150 foreach ( $disallowed as $pname ) {
151 if ( isset( $params[$pname] ) ) {
154 'apierror-invalidparammix-mustusewith',
162 if ( !is_null( $params['user'] ) && $params['filterbots'] != 'all' ) {
163 // Since filterbots checks if each user has the bot right, it
164 // doesn't make sense to use it with user
166 [ 'apierror-invalidparammix-cannotusewith', "{$prefix}user", "{$prefix}filterbots" ]
171 $this->addTimestampWhereRange(
173 $ascendingOrder ?
'newer' : 'older',
177 // Include in ORDER BY for uniqueness
178 $this->addWhereRange( 'img_name', $ascendingOrder ?
'newer' : 'older', null, null );
180 if ( !is_null( $params['continue'] ) ) {
181 $cont = explode( '|', $params['continue'] );
182 $this->dieContinueUsageIf( count( $cont ) != 2 );
183 $op = ( $ascendingOrder ?
'>' : '<' );
184 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
185 $continueName = $db->addQuotes( $cont[1] );
186 $this->addWhere( "img_timestamp $op $continueTimestamp OR " .
187 "(img_timestamp = $continueTimestamp AND " .
188 "img_name $op= $continueName)"
193 if ( !is_null( $params['user'] ) ) {
194 $this->addWhereFld( 'img_user_text', $params['user'] );
196 if ( $params['filterbots'] != 'all' ) {
197 $this->addTables( 'user_groups' );
198 $this->addJoinConds( [ 'user_groups' => [
201 'ug_group' => User
::getGroupsWithPermission( 'bot' ),
202 'ug_user = img_user',
203 $this->getConfig()->get( 'DisableUserGroupExpiry' ) ?
205 'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
208 $groupCond = ( $params['filterbots'] == 'nobots' ?
'NULL' : 'NOT NULL' );
209 $this->addWhere( "ug_group IS $groupCond" );
213 // Filters not depending on sort
214 if ( isset( $params['minsize'] ) ) {
215 $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
218 if ( isset( $params['maxsize'] ) ) {
219 $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
223 if ( isset( $params['sha1'] ) ) {
224 $sha1 = strtolower( $params['sha1'] );
225 if ( !$this->validateSha1Hash( $sha1 ) ) {
226 $this->dieWithError( 'apierror-invalidsha1hash' );
228 $sha1 = Wikimedia\base_convert
( $sha1, 16, 36, 31 );
229 } elseif ( isset( $params['sha1base36'] ) ) {
230 $sha1 = strtolower( $params['sha1base36'] );
231 if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
232 $this->dieWithError( 'apierror-invalidsha1base36hash' );
236 $this->addWhereFld( 'img_sha1', $sha1 );
239 if ( !is_null( $params['mime'] ) ) {
240 if ( $this->getConfig()->get( 'MiserMode' ) ) {
241 $this->dieWithError( 'apierror-mimesearchdisabled' );
245 foreach ( $params['mime'] as $mime ) {
246 list( $major, $minor ) = File
::splitMime( $mime );
247 $mimeConds[] = $db->makeList(
249 'img_major_mime' => $major,
250 'img_minor_mime' => $minor,
255 // safeguard against internal_api_error_DBQueryError
256 if ( count( $mimeConds ) > 0 ) {
257 $this->addWhere( $db->makeList( $mimeConds, LIST_OR
) );
259 // no MIME types, no files
260 $this->getResult()->addValue( 'query', $this->getModuleName(), [] );
265 $limit = $params['limit'];
266 $this->addOption( 'LIMIT', $limit +
1 );
268 if ( !$ascendingOrder ) {
271 if ( $params['sort'] == 'timestamp' ) {
272 $this->addOption( 'ORDER BY', 'img_timestamp' . $sortFlag );
273 if ( !is_null( $params['user'] ) ) {
274 $this->addOption( 'USE INDEX', [ 'image' => 'img_usertext_timestamp' ] );
276 $this->addOption( 'USE INDEX', [ 'image' => 'img_timestamp' ] );
279 $this->addOption( 'ORDER BY', 'img_name' . $sortFlag );
282 $res = $this->select( __METHOD__
);
286 $result = $this->getResult();
287 foreach ( $res as $row ) {
288 if ( ++
$count > $limit ) {
289 // We've reached the one extra which shows that there are
290 // additional pages to be had. Stop here...
291 if ( $params['sort'] == 'name' ) {
292 $this->setContinueEnumParameter( 'continue', $row->img_name
);
294 $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
299 if ( is_null( $resultPageSet ) ) {
300 $file = $repo->newFileFromRow( $row );
301 $info = array_merge( [ 'name' => $row->img_name
],
302 ApiQueryImageInfo
::getInfo( $file, $prop, $result ) );
303 self
::addTitleInfo( $info, $file->getTitle() );
305 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $info );
307 if ( $params['sort'] == 'name' ) {
308 $this->setContinueEnumParameter( 'continue', $row->img_name
);
310 $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
315 $titles[] = Title
::makeTitle( NS_FILE
, $row->img_name
);
319 if ( is_null( $resultPageSet ) ) {
320 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'img' );
322 $resultPageSet->populateFromTitles( $titles );
326 public function getAllowedParams() {
329 ApiBase
::PARAM_DFLT
=> 'name',
330 ApiBase
::PARAM_TYPE
=> [
336 ApiBase
::PARAM_DFLT
=> 'ascending',
337 ApiBase
::PARAM_TYPE
=> [
349 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
352 ApiBase
::PARAM_TYPE
=> 'timestamp'
355 ApiBase
::PARAM_TYPE
=> 'timestamp'
358 ApiBase
::PARAM_TYPE
=> ApiQueryImageInfo
::getPropertyNames( $this->propertyFilter
),
359 ApiBase
::PARAM_DFLT
=> 'timestamp|url',
360 ApiBase
::PARAM_ISMULTI
=> true,
361 ApiBase
::PARAM_HELP_MSG
=> 'apihelp-query+imageinfo-param-prop',
362 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=>
363 ApiQueryImageInfo
::getPropertyMessages( $this->propertyFilter
),
367 ApiBase
::PARAM_TYPE
=> 'integer',
370 ApiBase
::PARAM_TYPE
=> 'integer',
373 'sha1base36' => null,
375 ApiBase
::PARAM_TYPE
=> 'user'
378 ApiBase
::PARAM_DFLT
=> 'all',
379 ApiBase
::PARAM_TYPE
=> [
386 ApiBase
::PARAM_ISMULTI
=> true,
389 ApiBase
::PARAM_DFLT
=> 10,
390 ApiBase
::PARAM_TYPE
=> 'limit',
391 ApiBase
::PARAM_MIN
=> 1,
392 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
393 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
397 if ( $this->getConfig()->get( 'MiserMode' ) ) {
398 $ret['mime'][ApiBase
::PARAM_HELP_MSG
] = 'api-help-param-disabled-in-miser-mode';
404 private $propertyFilter = [ 'archivename', 'thumbmime', 'uploadwarning' ];
406 protected function getExamplesMessages() {
408 'action=query&list=allimages&aifrom=B'
409 => 'apihelp-query+allimages-example-B',
410 'action=query&list=allimages&aiprop=user|timestamp|url&' .
411 'aisort=timestamp&aidir=older'
412 => 'apihelp-query+allimages-example-recent',
413 'action=query&list=allimages&aimime=image/png|image/gif'
414 => 'apihelp-query+allimages-example-mimetypes',
415 'action=query&generator=allimages&gailimit=4&' .
416 'gaifrom=T&prop=imageinfo'
417 => 'apihelp-query+allimages-example-generator',
421 public function getHelpUrls() {
422 return 'https://www.mediawiki.org/wiki/API:Allimages';