includes/api/ApiQueryAllimages.php

   1 <?php
   2
   3 /*
   4  * Created on Mar 16, 2008
   5  *
   6  * API for MediaWiki 1.12+
   7  *
   8  * Copyright (C) 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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ('ApiQueryBase.php');
  30 }
  31
  32 /**
  33  * Query module to enumerate all available pages.
  34  *
  35  * @ingroup API
  36  */
  37 class ApiQueryAllimages extends ApiQueryGeneratorBase {
  38
  39         public function __construct($query, $moduleName) {
  40                 parent :: __construct($query, $moduleName, 'ai');
  41         }
  42
  43         public function execute() {
  44                 $this->run();
  45         }
  46
  47         public function executeGenerator($resultPageSet) {
  48                 if ($resultPageSet->isResolvingRedirects())
  49                         $this->dieUsage('Use "gaifilterredir=nonredirects" option instead of "redirects" when using allimages as a generator', 'params');
  50
  51                 $this->run($resultPageSet);
  52         }
  53
  54         private function run($resultPageSet = null) {
  55                 $repo = RepoGroup::singleton()->getLocalRepo();
  56                 if ( !$repo instanceof LocalRepo )
  57                         $this->dieUsage('Local file repository does not support querying all images', 'unsupportedrepo');
  58
  59                 $db = $this->getDB();
  60
  61                 $params = $this->extractRequestParams();
  62
  63                 // Image filters
  64                 if (!is_null($params['from']))
  65                         $this->addWhere('img_name>=' . $db->addQuotes(ApiQueryBase :: titleToKey($params['from'])));
  66                 if (isset ($params['prefix']))
  67                         $this->addWhere("img_name LIKE '" . $db->escapeLike(ApiQueryBase :: titleToKey($params['prefix'])) . "%'");
  68
  69                 if (isset ($params['minsize'])) {
  70                         $this->addWhere('img_size>=' . intval($params['minsize']));
  71                 }
  72
  73                 if (isset ($params['maxsize'])) {
  74                         $this->addWhere('img_size<=' . intval($params['maxsize']));
  75                 }
  76
  77                 $sha1 = false;
  78                 if( isset( $params['sha1'] ) ) {
  79                         $sha1 = wfBaseConvert( $params['sha1'], 16, 36, 31 );
  80                 } elseif( isset( $params['sha1base36'] ) ) {
  81                         $sha1 = $params['sha1base36'];
  82                 }
  83                 if( $sha1 ) {
  84                         $this->addWhere( 'img_sha1=' . $db->addQuotes( $sha1 ) );
  85                 }
  86
  87                 $this->addTables('image');
  88
  89                 $prop = array_flip($params['prop']);
  90                 $this->addFields( LocalFile::selectFields() );
  91
  92                 $limit = $params['limit'];
  93                 $this->addOption('LIMIT', $limit+1);
  94                 $this->addOption('ORDER BY', 'img_name' .
  95                                                 ($params['dir'] == 'descending' ? ' DESC' : ''));
  96
  97                 $res = $this->select(__METHOD__);
  98
  99                 $data = array ();
 100                 $count = 0;
 101                 $result = $this->getResult();
 102                 while ($row = $db->fetchObject($res)) {
 103                         if (++ $count > $limit) {
 104                                 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
 105                                 // TODO: Security issue - if the user has no right to view next title, it will still be shown
 106                                 $this->setContinueEnumParameter('from', ApiQueryBase :: keyToTitle($row->img_name));
 107                                 break;
 108                         }
 109
 110                         if (is_null($resultPageSet)) {
 111                                 $file = $repo->newFileFromRow( $row );
 112
 113                                 $data[] = ApiQueryImageInfo::getInfo( $file, $prop, $result );
 114                         } else {
 115                                 $data[] = Title::makeTitle( NS_IMAGE, $row->img_name );
 116                         }
 117                 }
 118                 $db->freeResult($res);
 119
 120                 if (is_null($resultPageSet)) {
 121                         $result = $this->getResult();
 122                         $result->setIndexedTagName($data, 'img');
 123                         $result->addValue('query', $this->getModuleName(), $data);
 124                 } else {
 125                         $resultPageSet->populateFromTitles( $data );
 126                 }
 127         }
 128
 129         public function getAllowedParams() {
 130                 return array (
 131                         'from' => null,
 132                         'prefix' => null,
 133                         'minsize' => array (
 134                                 ApiBase :: PARAM_TYPE => 'integer',
 135                         ),
 136                         'maxsize' => array (
 137                                 ApiBase :: PARAM_TYPE => 'integer',
 138                         ),
 139                         'limit' => array (
 140                                 ApiBase :: PARAM_DFLT => 10,
 141                                 ApiBase :: PARAM_TYPE => 'limit',
 142                                 ApiBase :: PARAM_MIN => 1,
 143                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 144                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 145                         ),
 146                         'dir' => array (
 147                                 ApiBase :: PARAM_DFLT => 'ascending',
 148                                 ApiBase :: PARAM_TYPE => array (
 149                                         'ascending',
 150                                         'descending'
 151                                 )
 152                         ),
 153                         'sha1' => null,
 154                         'sha1base36' => null,
 155                         'prop' => array (
 156                                 ApiBase :: PARAM_TYPE => array(
 157                                         'timestamp',
 158                                         'user',
 159                                         'comment',
 160                                         'url',
 161                                         'size',
 162                                         'dimensions', // Obsolete
 163                                         'mime',
 164                                         'sha1',
 165                                         'metadata'
 166                                 ),
 167                                 ApiBase :: PARAM_DFLT => 'timestamp|url',
 168                                 ApiBase :: PARAM_ISMULTI => true
 169                         )
 170                 );
 171         }
 172
 173         public function getParamDescription() {
 174                 return array (
 175                         'from' => 'The image title to start enumerating from.',
 176                         'prefix' => 'Search for all image titles that begin with this value.',
 177                         'dir' => 'The direction in which to list',
 178                         'minsize' => 'Limit to images with at least this many bytes',
 179                         'maxsize' => 'Limit to images with at most this many bytes',
 180                         'limit' => 'How many total pages to return.',
 181                         'sha1' => 'SHA1 hash of image',
 182                         'sha1base36' => 'SHA1 hash of image in base 36 (used in MediaWiki)',
 183                         'prop' => 'Which properties to get',
 184                 );
 185         }
 186
 187         public function getDescription() {
 188                 return 'Enumerate all images sequentially';
 189         }
 190
 191         protected function getExamples() {
 192                 return array (
 193                         'Simple Use',
 194                         ' Show a list of images starting at the letter "B"',
 195                         '  api.php?action=query&list=allimages&aifrom=B',
 196                         'Using as Generator',
 197                         ' Show info about 4 images starting at the letter "T"',
 198                         '  api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo',
 199                 );
 200         }
 201
 202         public function getVersion() {
 203                 return __CLASS__ . ': $Id$';
 204         }
 205 }