includes/api/ApiQueryAllImages.php

   1 <?php
   2
   3 /**
   4  * API for MediaWiki 1.12+
   5  *
   6  * Created on Mar 16, 2008
   7  *
   8  * Copyright © 2008 Vasiliev Victor vasilvv@gmail.com,
   9  * based on ApiQueryAllPages.php
  10  *
  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.
  15  *
  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.
  20  *
  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
  25  *
  26  * @file
  27  */
  28
  29 use Wikimedia\Rdbms\IDatabase;
  30
  31 /**
  32  * Query module to enumerate all available pages.
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryAllImages extends ApiQueryGeneratorBase {
  37         protected $mRepo;
  38
  39         public function __construct( ApiQuery $query, $moduleName ) {
  40                 parent::__construct( $query, $moduleName, 'ai' );
  41                 $this->mRepo = RepoGroup::singleton()->getLocalRepo();
  42         }
  43
  44         /**
  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.
  47          *
  48          * TODO: allow querying non-local repos.
  49          * @return IDatabase
  50          */
  51         protected function getDB() {
  52                 return $this->mRepo->getReplicaDB();
  53         }
  54
  55         public function execute() {
  56                 $this->run();
  57         }
  58
  59         public function getCacheMode( $params ) {
  60                 return 'public';
  61         }
  62
  63         /**
  64          * @param ApiPageSet $resultPageSet
  65          * @return void
  66          */
  67         public function executeGenerator( $resultPageSet ) {
  68                 if ( $resultPageSet->isResolvingRedirects() ) {
  69                         $this->dieWithError( 'apierror-allimages-redirect', 'invalidparammix' );
  70                 }
  71
  72                 $this->run( $resultPageSet );
  73         }
  74
  75         /**
  76          * @param ApiPageSet $resultPageSet
  77          * @return void
  78          */
  79         private function run( $resultPageSet = null ) {
  80                 $repo = $this->mRepo;
  81                 if ( !$repo instanceof LocalRepo ) {
  82                         $this->dieWithError( 'apierror-unsupportedrepo' );
  83                 }
  84
  85                 $prefix = $this->getModulePrefix();
  86
  87                 $db = $this->getDB();
  88
  89                 $params = $this->extractRequestParams();
  90
  91                 // Table and return fields
  92                 $this->addTables( 'image' );
  93
  94                 $prop = array_flip( $params['prop'] );
  95                 $this->addFields( LocalFile::selectFields() );
  96
  97                 $ascendingOrder = true;
  98                 if ( $params['dir'] == 'descending' || $params['dir'] == 'older' ) {
  99                         $ascendingOrder = false;
 100                 }
 101
 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] ) ) {
 107                                         $this->dieWithError(
 108                                                 [
 109                                                         'apierror-invalidparammix-mustusewith',
 110                                                         "{$prefix}{$pname}",
 111                                                         "{$prefix}sort=timestamp"
 112                                                 ],
 113                                                 'invalidparammix'
 114                                         );
 115                                 }
 116                         }
 117                         if ( $params['filterbots'] != 'all' ) {
 118                                 $this->dieWithError(
 119                                         [
 120                                                 'apierror-invalidparammix-mustusewith',
 121                                                 "{$prefix}filterbots",
 122                                                 "{$prefix}sort=timestamp"
 123                                         ],
 124                                         'invalidparammix'
 125                                 );
 126                         }
 127
 128                         // Pagination
 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" );
 135                         }
 136
 137                         // Image filters
 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 );
 141
 142                         if ( isset( $params['prefix'] ) ) {
 143                                 $this->addWhere( 'img_name' . $db->buildLike(
 144                                         $this->titlePartToKey( $params['prefix'], NS_FILE ),
 145                                         $db->anyString() ) );
 146                         }
 147                 } else {
 148                         // Check mutually exclusive params
 149                         $disallowed = [ 'from', 'to', 'prefix' ];
 150                         foreach ( $disallowed as $pname ) {
 151                                 if ( isset( $params[$pname] ) ) {
 152                                         $this->dieWithError(
 153                                                 [
 154                                                         'apierror-invalidparammix-mustusewith',
 155                                                         "{$prefix}{$pname}",
 156                                                         "{$prefix}sort=name"
 157                                                 ],
 158                                                 'invalidparammix'
 159                                         );
 160                                 }
 161                         }
 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
 165                                 $this->dieWithError(
 166                                         [ 'apierror-invalidparammix-cannotusewith', "{$prefix}user", "{$prefix}filterbots" ]
 167                                 );
 168                         }
 169
 170                         // Pagination
 171                         $this->addTimestampWhereRange(
 172                                 'img_timestamp',
 173                                 $ascendingOrder ? 'newer' : 'older',
 174                                 $params['start'],
 175                                 $params['end']
 176                         );
 177                         // Include in ORDER BY for uniqueness
 178                         $this->addWhereRange( 'img_name', $ascendingOrder ? 'newer' : 'older', null, null );
 179
 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)"
 189                                 );
 190                         }
 191
 192                         // Image filters
 193                         if ( !is_null( $params['user'] ) ) {
 194                                 $this->addWhereFld( 'img_user_text', $params['user'] );
 195                         }
 196                         if ( $params['filterbots'] != 'all' ) {
 197                                 $this->addTables( 'user_groups' );
 198                                 $this->addJoinConds( [ 'user_groups' => [
 199                                         'LEFT JOIN',
 200                                         [
 201                                                 'ug_group' => User::getGroupsWithPermission( 'bot' ),
 202                                                 'ug_user = img_user',
 203                                                 $this->getConfig()->get( 'DisableUserGroupExpiry' ) ?
 204                                                         '1' :
 205                                                         'ug_expiry IS NULL OR ug_expiry >= ' . $db->addQuotes( $db->timestamp() )
 206                                         ]
 207                                 ] ] );
 208                                 $groupCond = ( $params['filterbots'] == 'nobots' ? 'NULL' : 'NOT NULL' );
 209                                 $this->addWhere( "ug_group IS $groupCond" );
 210                         }
 211                 }
 212
 213                 // Filters not depending on sort
 214                 if ( isset( $params['minsize'] ) ) {
 215                         $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
 216                 }
 217
 218                 if ( isset( $params['maxsize'] ) ) {
 219                         $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
 220                 }
 221
 222                 $sha1 = false;
 223                 if ( isset( $params['sha1'] ) ) {
 224                         $sha1 = strtolower( $params['sha1'] );
 225                         if ( !$this->validateSha1Hash( $sha1 ) ) {
 226                                 $this->dieWithError( 'apierror-invalidsha1hash' );
 227                         }
 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' );
 233                         }
 234                 }
 235                 if ( $sha1 ) {
 236                         $this->addWhereFld( 'img_sha1', $sha1 );
 237                 }
 238
 239                 if ( !is_null( $params['mime'] ) ) {
 240                         if ( $this->getConfig()->get( 'MiserMode' ) ) {
 241                                 $this->dieWithError( 'apierror-mimesearchdisabled' );
 242                         }
 243
 244                         $mimeConds = [];
 245                         foreach ( $params['mime'] as $mime ) {
 246                                 list( $major, $minor ) = File::splitMime( $mime );
 247                                 $mimeConds[] = $db->makeList(
 248                                         [
 249                                                 'img_major_mime' => $major,
 250                                                 'img_minor_mime' => $minor,
 251                                         ],
 252                                         LIST_AND
 253                                 );
 254                         }
 255                         // safeguard against internal_api_error_DBQueryError
 256                         if ( count( $mimeConds ) > 0 ) {
 257                                 $this->addWhere( $db->makeList( $mimeConds, LIST_OR ) );
 258                         } else {
 259                                 // no MIME types, no files
 260                                 $this->getResult()->addValue( 'query', $this->getModuleName(), [] );
 261                                 return;
 262                         }
 263                 }
 264
 265                 $limit = $params['limit'];
 266                 $this->addOption( 'LIMIT', $limit + 1 );
 267                 $sortFlag = '';
 268                 if ( !$ascendingOrder ) {
 269                         $sortFlag = ' DESC';
 270                 }
 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' ] );
 275                         } else {
 276                                 $this->addOption( 'USE INDEX', [ 'image' => 'img_timestamp' ] );
 277                         }
 278                 } else {
 279                         $this->addOption( 'ORDER BY', 'img_name' . $sortFlag );
 280                 }
 281
 282                 $res = $this->select( __METHOD__ );
 283
 284                 $titles = [];
 285                 $count = 0;
 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 );
 293                                 } else {
 294                                         $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
 295                                 }
 296                                 break;
 297                         }
 298
 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() );
 304
 305                                 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $info );
 306                                 if ( !$fit ) {
 307                                         if ( $params['sort'] == 'name' ) {
 308                                                 $this->setContinueEnumParameter( 'continue', $row->img_name );
 309                                         } else {
 310                                                 $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
 311                                         }
 312                                         break;
 313                                 }
 314                         } else {
 315                                 $titles[] = Title::makeTitle( NS_FILE, $row->img_name );
 316                         }
 317                 }
 318
 319                 if ( is_null( $resultPageSet ) ) {
 320                         $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'img' );
 321                 } else {
 322                         $resultPageSet->populateFromTitles( $titles );
 323                 }
 324         }
 325
 326         public function getAllowedParams() {
 327                 $ret = [
 328                         'sort' => [
 329                                 ApiBase::PARAM_DFLT => 'name',
 330                                 ApiBase::PARAM_TYPE => [
 331                                         'name',
 332                                         'timestamp'
 333                                 ]
 334                         ],
 335                         'dir' => [
 336                                 ApiBase::PARAM_DFLT => 'ascending',
 337                                 ApiBase::PARAM_TYPE => [
 338                                         // sort=name
 339                                         'ascending',
 340                                         'descending',
 341                                         // sort=timestamp
 342                                         'newer',
 343                                         'older'
 344                                 ]
 345                         ],
 346                         'from' => null,
 347                         'to' => null,
 348                         'continue' => [
 349                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 350                         ],
 351                         'start' => [
 352                                 ApiBase::PARAM_TYPE => 'timestamp'
 353                         ],
 354                         'end' => [
 355                                 ApiBase::PARAM_TYPE => 'timestamp'
 356                         ],
 357                         'prop' => [
 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 ),
 364                         ],
 365                         'prefix' => null,
 366                         'minsize' => [
 367                                 ApiBase::PARAM_TYPE => 'integer',
 368                         ],
 369                         'maxsize' => [
 370                                 ApiBase::PARAM_TYPE => 'integer',
 371                         ],
 372                         'sha1' => null,
 373                         'sha1base36' => null,
 374                         'user' => [
 375                                 ApiBase::PARAM_TYPE => 'user'
 376                         ],
 377                         'filterbots' => [
 378                                 ApiBase::PARAM_DFLT => 'all',
 379                                 ApiBase::PARAM_TYPE => [
 380                                         'all',
 381                                         'bots',
 382                                         'nobots'
 383                                 ]
 384                         ],
 385                         'mime' => [
 386                                 ApiBase::PARAM_ISMULTI => true,
 387                         ],
 388                         'limit' => [
 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
 394                         ],
 395                 ];
 396
 397                 if ( $this->getConfig()->get( 'MiserMode' ) ) {
 398                         $ret['mime'][ApiBase::PARAM_HELP_MSG] = 'api-help-param-disabled-in-miser-mode';
 399                 }
 400
 401                 return $ret;
 402         }
 403
 404         private $propertyFilter = [ 'archivename', 'thumbmime', 'uploadwarning' ];
 405
 406         protected function getExamplesMessages() {
 407                 return [
 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',
 418                 ];
 419         }
 420
 421         public function getHelpUrls() {
 422                 return 'https://www.mediawiki.org/wiki/API:Allimages';
 423         }
 424 }