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 /**
  30  * Query module to enumerate all available pages.
  31  *
  32  * @ingroup API
  33  */
  34 class ApiQueryAllImages extends ApiQueryGeneratorBase {
  35         protected $mRepo;
  36
  37         public function __construct( ApiQuery $query, $moduleName ) {
  38                 parent::__construct( $query, $moduleName, 'ai' );
  39                 $this->mRepo = RepoGroup::singleton()->getLocalRepo();
  40         }
  41
  42         /**
  43          * Override parent method to make sure the repo's DB is used
  44          * which may not necessarily be the same as the local DB.
  45          *
  46          * TODO: allow querying non-local repos.
  47          * @return DatabaseBase
  48          */
  49         protected function getDB() {
  50                 return $this->mRepo->getSlaveDB();
  51         }
  52
  53         public function execute() {
  54                 $this->run();
  55         }
  56
  57         public function getCacheMode( $params ) {
  58                 return 'public';
  59         }
  60
  61         /**
  62          * @param ApiPageSet $resultPageSet
  63          * @return void
  64          */
  65         public function executeGenerator( $resultPageSet ) {
  66                 if ( $resultPageSet->isResolvingRedirects() ) {
  67                         $this->dieUsage(
  68                                 'Use "gaifilterredir=nonredirects" option instead of "redirects" ' .
  69                                         'when using allimages as a generator',
  70                                 'params'
  71                         );
  72                 }
  73
  74                 $this->run( $resultPageSet );
  75         }
  76
  77         /**
  78          * @param ApiPageSet $resultPageSet
  79          * @return void
  80          */
  81         private function run( $resultPageSet = null ) {
  82                 $repo = $this->mRepo;
  83                 if ( !$repo instanceof LocalRepo ) {
  84                         $this->dieUsage(
  85                                 'Local file repository does not support querying all images',
  86                                 'unsupportedrepo'
  87                         );
  88                 }
  89
  90                 $prefix = $this->getModulePrefix();
  91
  92                 $db = $this->getDB();
  93
  94                 $params = $this->extractRequestParams();
  95
  96                 // Table and return fields
  97                 $this->addTables( 'image' );
  98
  99                 $prop = array_flip( $params['prop'] );
 100                 $this->addFields( LocalFile::selectFields() );
 101
 102                 $ascendingOrder = true;
 103                 if ( $params['dir'] == 'descending' || $params['dir'] == 'older' ) {
 104                         $ascendingOrder = false;
 105                 }
 106
 107                 if ( $params['sort'] == 'name' ) {
 108                         // Check mutually exclusive params
 109                         $disallowed = array( 'start', 'end', 'user' );
 110                         foreach ( $disallowed as $pname ) {
 111                                 if ( isset( $params[$pname] ) ) {
 112                                         $this->dieUsage(
 113                                                 "Parameter '{$prefix}{$pname}' can only be used with {$prefix}sort=timestamp",
 114                                                 'badparams'
 115                                         );
 116                                 }
 117                         }
 118                         if ( $params['filterbots'] != 'all' ) {
 119                                 $this->dieUsage(
 120                                         "Parameter '{$prefix}filterbots' can only be used with {$prefix}sort=timestamp",
 121                                         'badparams'
 122                                 );
 123                         }
 124
 125                         // Pagination
 126                         if ( !is_null( $params['continue'] ) ) {
 127                                 $cont = explode( '|', $params['continue'] );
 128                                 $this->dieContinueUsageIf( count( $cont ) != 1 );
 129                                 $op = ( $ascendingOrder ? '>' : '<' );
 130                                 $continueFrom = $db->addQuotes( $cont[0] );
 131                                 $this->addWhere( "img_name $op= $continueFrom" );
 132                         }
 133
 134                         // Image filters
 135                         $from = ( $params['from'] === null ? null : $this->titlePartToKey( $params['from'], NS_FILE ) );
 136                         $to = ( $params['to'] === null ? null : $this->titlePartToKey( $params['to'], NS_FILE ) );
 137                         $this->addWhereRange( 'img_name', ( $ascendingOrder ? 'newer' : 'older' ), $from, $to );
 138
 139                         if ( isset( $params['prefix'] ) ) {
 140                                 $this->addWhere( 'img_name' . $db->buildLike(
 141                                         $this->titlePartToKey( $params['prefix'], NS_FILE ),
 142                                         $db->anyString() ) );
 143                         }
 144                 } else {
 145                         // Check mutually exclusive params
 146                         $disallowed = array( 'from', 'to', 'prefix' );
 147                         foreach ( $disallowed as $pname ) {
 148                                 if ( isset( $params[$pname] ) ) {
 149                                         $this->dieUsage(
 150                                                 "Parameter '{$prefix}{$pname}' can only be used with {$prefix}sort=name",
 151                                                 'badparams'
 152                                         );
 153                                 }
 154                         }
 155                         if ( !is_null( $params['user'] ) && $params['filterbots'] != 'all' ) {
 156                                 // Since filterbots checks if each user has the bot right, it
 157                                 // doesn't make sense to use it with user
 158                                 $this->dieUsage(
 159                                         "Parameters '{$prefix}user' and '{$prefix}filterbots' cannot be used together",
 160                                         'badparams'
 161                                 );
 162                         }
 163
 164                         // Pagination
 165                         $this->addTimestampWhereRange(
 166                                 'img_timestamp',
 167                                 $ascendingOrder ? 'newer' : 'older',
 168                                 $params['start'],
 169                                 $params['end']
 170                         );
 171                         // Include in ORDER BY for uniqueness
 172                         $this->addWhereRange( 'img_name', $ascendingOrder ? 'newer' : 'older', null, null );
 173
 174                         if ( !is_null( $params['continue'] ) ) {
 175                                 $cont = explode( '|', $params['continue'] );
 176                                 $this->dieContinueUsageIf( count( $cont ) != 2 );
 177                                 $op = ( $ascendingOrder ? '>' : '<' );
 178                                 $continueTimestamp = $db->addQuotes( $db->timestamp( $cont[0] ) );
 179                                 $continueName = $db->addQuotes( $cont[1] );
 180                                 $this->addWhere( "img_timestamp $op $continueTimestamp OR " .
 181                                         "(img_timestamp = $continueTimestamp AND " .
 182                                         "img_name $op= $continueName)"
 183                                 );
 184                         }
 185
 186                         // Image filters
 187                         if ( !is_null( $params['user'] ) ) {
 188                                 $this->addWhereFld( 'img_user_text', $params['user'] );
 189                         }
 190                         if ( $params['filterbots'] != 'all' ) {
 191                                 $this->addTables( 'user_groups' );
 192                                 $this->addJoinConds( array( 'user_groups' => array(
 193                                         'LEFT JOIN',
 194                                         array(
 195                                                 'ug_group' => User::getGroupsWithPermission( 'bot' ),
 196                                                 'ug_user = img_user'
 197                                         )
 198                                 ) ) );
 199                                 $groupCond = ( $params['filterbots'] == 'nobots' ? 'NULL' : 'NOT NULL' );
 200                                 $this->addWhere( "ug_group IS $groupCond" );
 201                         }
 202                 }
 203
 204                 // Filters not depending on sort
 205                 if ( isset( $params['minsize'] ) ) {
 206                         $this->addWhere( 'img_size>=' . intval( $params['minsize'] ) );
 207                 }
 208
 209                 if ( isset( $params['maxsize'] ) ) {
 210                         $this->addWhere( 'img_size<=' . intval( $params['maxsize'] ) );
 211                 }
 212
 213                 $sha1 = false;
 214                 if ( isset( $params['sha1'] ) ) {
 215                         $sha1 = strtolower( $params['sha1'] );
 216                         if ( !$this->validateSha1Hash( $sha1 ) ) {
 217                                 $this->dieUsage( 'The SHA1 hash provided is not valid', 'invalidsha1hash' );
 218                         }
 219                         $sha1 = wfBaseConvert( $sha1, 16, 36, 31 );
 220                 } elseif ( isset( $params['sha1base36'] ) ) {
 221                         $sha1 = strtolower( $params['sha1base36'] );
 222                         if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
 223                                 $this->dieUsage( 'The SHA1Base36 hash provided is not valid', 'invalidsha1base36hash' );
 224                         }
 225                 }
 226                 if ( $sha1 ) {
 227                         $this->addWhereFld( 'img_sha1', $sha1 );
 228                 }
 229
 230                 if ( !is_null( $params['mime'] ) ) {
 231                         global $wgMiserMode;
 232                         if ( $wgMiserMode ) {
 233                                 $this->dieUsage( 'MIME search disabled in Miser Mode', 'mimesearchdisabled' );
 234                         }
 235
 236                         list( $major, $minor ) = File::splitMime( $params['mime'] );
 237
 238                         $this->addWhereFld( 'img_major_mime', $major );
 239                         $this->addWhereFld( 'img_minor_mime', $minor );
 240                 }
 241
 242                 $limit = $params['limit'];
 243                 $this->addOption( 'LIMIT', $limit + 1 );
 244                 $sortFlag = '';
 245                 if ( !$ascendingOrder ) {
 246                         $sortFlag = ' DESC';
 247                 }
 248                 if ( $params['sort'] == 'timestamp' ) {
 249                         $this->addOption( 'ORDER BY', 'img_timestamp' . $sortFlag );
 250                         if ( !is_null( $params['user'] ) ) {
 251                                 $this->addOption( 'USE INDEX', array( 'image' => 'img_usertext_timestamp' ) );
 252                         } else {
 253                                 $this->addOption( 'USE INDEX', array( 'image' => 'img_timestamp' ) );
 254                         }
 255                 } else {
 256                         $this->addOption( 'ORDER BY', 'img_name' . $sortFlag );
 257                 }
 258
 259                 $res = $this->select( __METHOD__ );
 260
 261                 $titles = array();
 262                 $count = 0;
 263                 $result = $this->getResult();
 264                 foreach ( $res as $row ) {
 265                         if ( ++$count > $limit ) {
 266                                 // We've reached the one extra which shows that there are
 267                                 // additional pages to be had. Stop here...
 268                                 if ( $params['sort'] == 'name' ) {
 269                                         $this->setContinueEnumParameter( 'continue', $row->img_name );
 270                                 } else {
 271                                         $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
 272                                 }
 273                                 break;
 274                         }
 275
 276                         if ( is_null( $resultPageSet ) ) {
 277                                 $file = $repo->newFileFromRow( $row );
 278                                 $info = array_merge( array( 'name' => $row->img_name ),
 279                                         ApiQueryImageInfo::getInfo( $file, $prop, $result ) );
 280                                 self::addTitleInfo( $info, $file->getTitle() );
 281
 282                                 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $info );
 283                                 if ( !$fit ) {
 284                                         if ( $params['sort'] == 'name' ) {
 285                                                 $this->setContinueEnumParameter( 'continue', $row->img_name );
 286                                         } else {
 287                                                 $this->setContinueEnumParameter( 'continue', "$row->img_timestamp|$row->img_name" );
 288                                         }
 289                                         break;
 290                                 }
 291                         } else {
 292                                 $titles[] = Title::makeTitle( NS_FILE, $row->img_name );
 293                         }
 294                 }
 295
 296                 if ( is_null( $resultPageSet ) ) {
 297                         $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'img' );
 298                 } else {
 299                         $resultPageSet->populateFromTitles( $titles );
 300                 }
 301         }
 302
 303         public function getAllowedParams() {
 304                 return array(
 305                         'sort' => array(
 306                                 ApiBase::PARAM_DFLT => 'name',
 307                                 ApiBase::PARAM_TYPE => array(
 308                                         'name',
 309                                         'timestamp'
 310                                 )
 311                         ),
 312                         'dir' => array(
 313                                 ApiBase::PARAM_DFLT => 'ascending',
 314                                 ApiBase::PARAM_TYPE => array(
 315                                         // sort=name
 316                                         'ascending',
 317                                         'descending',
 318                                         // sort=timestamp
 319                                         'newer',
 320                                         'older'
 321                                 )
 322                         ),
 323                         'from' => null,
 324                         'to' => null,
 325                         'continue' => null,
 326                         'start' => array(
 327                                 ApiBase::PARAM_TYPE => 'timestamp'
 328                         ),
 329                         'end' => array(
 330                                 ApiBase::PARAM_TYPE => 'timestamp'
 331                         ),
 332                         'prop' => array(
 333                                 ApiBase::PARAM_TYPE => ApiQueryImageInfo::getPropertyNames( $this->propertyFilter ),
 334                                 ApiBase::PARAM_DFLT => 'timestamp|url',
 335                                 ApiBase::PARAM_ISMULTI => true
 336                         ),
 337                         'prefix' => null,
 338                         'minsize' => array(
 339                                 ApiBase::PARAM_TYPE => 'integer',
 340                         ),
 341                         'maxsize' => array(
 342                                 ApiBase::PARAM_TYPE => 'integer',
 343                         ),
 344                         'sha1' => null,
 345                         'sha1base36' => null,
 346                         'user' => array(
 347                                 ApiBase::PARAM_TYPE => 'user'
 348                         ),
 349                         'filterbots' => array(
 350                                 ApiBase::PARAM_DFLT => 'all',
 351                                 ApiBase::PARAM_TYPE => array(
 352                                         'all',
 353                                         'bots',
 354                                         'nobots'
 355                                 )
 356                         ),
 357                         'mime' => null,
 358                         'limit' => array(
 359                                 ApiBase::PARAM_DFLT => 10,
 360                                 ApiBase::PARAM_TYPE => 'limit',
 361                                 ApiBase::PARAM_MIN => 1,
 362                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 363                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 364                         ),
 365                 );
 366         }
 367
 368         public function getParamDescription() {
 369                 $p = $this->getModulePrefix();
 370
 371                 return array(
 372                         'sort' => 'Property to sort by',
 373                         'dir' => 'The direction in which to list',
 374                         'from' => "The image title to start enumerating from. Can only be used with {$p}sort=name",
 375                         'to' => "The image title to stop enumerating at. Can only be used with {$p}sort=name",
 376                         'continue' => 'When more results are available, use this to continue',
 377                         'start' => "The timestamp to start enumerating from. Can only be used with {$p}sort=timestamp",
 378                         'end' => "The timestamp to end enumerating. Can only be used with {$p}sort=timestamp",
 379                         'prop' => ApiQueryImageInfo::getPropertyDescriptions( $this->propertyFilter ),
 380                         'prefix' => "Search for all image titles that begin with this " .
 381                                 "value. Can only be used with {$p}sort=name",
 382                         'minsize' => 'Limit to images with at least this many bytes',
 383                         'maxsize' => 'Limit to images with at most this many bytes',
 384                         'sha1' => "SHA1 hash of image. Overrides {$p}sha1base36",
 385                         'sha1base36' => 'SHA1 hash of image in base 36 (used in MediaWiki)',
 386                         'user' => "Only return files uploaded by this user. Can only be used " .
 387                                 "with {$p}sort=timestamp. Cannot be used together with {$p}filterbots",
 388                         'filterbots' => "How to filter files uploaded by bots. Can only be " .
 389                                 "used with {$p}sort=timestamp. Cannot be used together with {$p}user",
 390                         'mime' => 'What MIME type to search for. e.g. image/jpeg. Disabled in Miser Mode',
 391                         'limit' => 'How many images in total to return',
 392                 );
 393         }
 394
 395         private $propertyFilter = array( 'archivename', 'thumbmime', 'uploadwarning' );
 396
 397         public function getResultProperties() {
 398                 return array_merge(
 399                         array(
 400                                 '' => array(
 401                                         'name' => 'string',
 402                                         'ns' => 'namespace',
 403                                         'title' => 'string'
 404                                 )
 405                         ),
 406                         ApiQueryImageInfo::getResultPropertiesFiltered( $this->propertyFilter )
 407                 );
 408         }
 409
 410         public function getDescription() {
 411                 return 'Enumerate all images sequentially.';
 412         }
 413
 414         public function getPossibleErrors() {
 415                 $p = $this->getModulePrefix();
 416
 417                 return array_merge( parent::getPossibleErrors(), array(
 418                         array(
 419                                 'code' => 'params',
 420                                 'info' => 'Use "gaifilterredir=nonredirects" option instead ' .
 421                                         'of "redirects" when using allimages as a generator'
 422                         ),
 423                         array(
 424                                 'code' => 'badparams',
 425                                 'info' => "Parameter'{$p}start' can only be used with {$p}sort=timestamp"
 426                         ),
 427                         array(
 428                                 'code' => 'badparams',
 429                                 'info' => "Parameter'{$p}end' can only be used with {$p}sort=timestamp"
 430                         ),
 431                         array(
 432                                 'code' => 'badparams',
 433                                 'info' => "Parameter'{$p}user' can only be used with {$p}sort=timestamp"
 434                         ),
 435                         array(
 436                                 'code' => 'badparams',
 437                                 'info' => "Parameter'{$p}filterbots' can only be used with {$p}sort=timestamp"
 438                         ),
 439                         array(
 440                                 'code' => 'badparams',
 441                                 'info' => "Parameter'{$p}from' can only be used with {$p}sort=name"
 442                         ),
 443                         array(
 444                                 'code' => 'badparams',
 445                                 'info' => "Parameter'{$p}to' can only be used with {$p}sort=name"
 446                         ),
 447                         array(
 448                                 'code' => 'badparams',
 449                                 'info' => "Parameter'{$p}prefix' can only be used with {$p}sort=name"
 450                         ),
 451                         array(
 452                                 'code' => 'badparams',
 453                                 'info' => "Parameters '{$p}user' and '{$p}filterbots' cannot be used together"
 454                         ),
 455                         array(
 456                                 'code' => 'unsupportedrepo',
 457                                 'info' => 'Local file repository does not support querying all images' ),
 458                         array( 'code' => 'mimesearchdisabled', 'info' => 'MIME search disabled in Miser Mode' ),
 459                         array( 'code' => 'invalidsha1hash', 'info' => 'The SHA1 hash provided is not valid' ),
 460                         array(
 461                                 'code' => 'invalidsha1base36hash',
 462                                 'info' => 'The SHA1Base36 hash provided is not valid'
 463                         ),
 464                 ) );
 465         }
 466
 467         public function getExamples() {
 468                 return array(
 469                         'api.php?action=query&list=allimages&aifrom=B' => array(
 470                                 'Simple Use',
 471                                 'Show a list of files starting at the letter "B"',
 472                         ),
 473                         'api.php?action=query&list=allimages&aiprop=user|timestamp|url&' .
 474                                 'aisort=timestamp&aidir=older' => array(
 475                                 'Simple Use',
 476                                 'Show a list of recently uploaded files similar to Special:NewFiles',
 477                         ),
 478                         'api.php?action=query&generator=allimages&gailimit=4&' .
 479                                 'gaifrom=T&prop=imageinfo' => array(
 480                                 'Using as Generator',
 481                                 'Show info about 4 files starting at the letter "T"',
 482                         ),
 483                 );
 484         }
 485
 486         public function getHelpUrls() {
 487                 return 'https://www.mediawiki.org/wiki/API:Allimages';
 488         }
 489 }