4 * Created on Mar 16, 2008
6 * API for MediaWiki 1.12+
8 * Copyright (C) 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 * http://www.gnu.org/copyleft/gpl.html
27 if (!defined('MEDIAWIKI')) {
28 // Eclipse helper - will be ignored in production
29 require_once ('ApiQueryBase.php');
33 * Query module to enumerate all available pages.
37 class ApiQueryAllimages
extends ApiQueryGeneratorBase
{
39 public function __construct($query, $moduleName) {
40 parent
:: __construct($query, $moduleName, 'ai');
43 public function execute() {
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');
51 $this->run($resultPageSet);
54 private function run($resultPageSet = null) {
58 $params = $this->extractRequestParams();
61 if (!is_null($params['from']))
62 $this->addWhere('img_name>=' . $db->addQuotes(ApiQueryBase
:: titleToKey($params['from'])));
63 if (isset ($params['prefix']))
64 $this->addWhere("img_name LIKE '" . $db->escapeLike(ApiQueryBase
:: titleToKey($params['prefix'])) . "%'");
66 if (isset ($params['minsize'])) {
67 $this->addWhere('img_size>=' . intval($params['minsize']));
70 if (isset ($params['maxsize'])) {
71 $this->addWhere('img_size<=' . intval($params['maxsize']));
75 if( isset( $params['sha1'] ) ) {
76 $sha1 = wfBaseConvert( $params['sha1'], 16, 36, 31 );
77 } elseif( isset( $params['sha1base36'] ) ) {
78 $sha1 = $params['sha1base36'];
81 $this->addWhere( 'img_sha1=' . $db->addQuotes( $sha1 ) );
84 $this->addTables('image');
86 $prop = array_flip($params['prop']);
87 $this->addFields('img_name');
88 $this->addFieldsIf('img_size', isset($prop['size']));
89 $this->addFieldsIf(array('img_width', 'img_height'), isset($prop['dimensions']));
90 $this->addFieldsIf(array('img_major_mime', 'img_minor_mime'), isset($prop['mime']));
91 $this->addFieldsIf('img_timestamp', isset($prop['timestamp']));
93 $limit = $params['limit'];
94 $this->addOption('LIMIT', $limit+
1);
95 $this->addOption('ORDER BY', 'img_name' .
96 ($params['dir'] == 'descending' ?
' DESC' : ''));
98 $res = $this->select(__METHOD__
);
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
));
110 if (is_null($resultPageSet)) {
111 $file = wfLocalFile( $row->img_name
);
112 $item['name'] = $row->img_name
;
113 if(isset($prop['size']))
114 $item['size'] = $file->getSize();
115 if(isset($prop['dimensions']))
117 $item['width'] = $file->getWidth();
118 $item['height'] = $file->getHeight();
120 if(isset($prop['mime']))
121 $item['mime'] = $row->img_major_mime
. '/' . $row->img_minor_mime
;
122 if(isset($prop['sha1']))
123 $item['sha1'] = wfBaseConvert($file->getSha1(), 36, 16, 31);
124 if(isset($prop['timestamp']))
125 $item['timestamp'] = wfTimestamp(TS_ISO_8601
, $file->getTimestamp());
126 if(isset($prop['url']))
127 $item['url'] = $file->getUrl();
130 $data[] = Title
::makeTitle( NS_IMAGE
, $row->img_name
);
133 $db->freeResult($res);
135 if (is_null($resultPageSet)) {
136 $result = $this->getResult();
137 $result->setIndexedTagName($data, 'img');
138 $result->addValue('query', $this->getModuleName(), $data);
140 $resultPageSet->populateFromTitles( $data );
144 public function getAllowedParams() {
149 ApiBase
:: PARAM_TYPE
=> 'integer',
152 ApiBase
:: PARAM_TYPE
=> 'integer',
155 ApiBase
:: PARAM_DFLT
=> 10,
156 ApiBase
:: PARAM_TYPE
=> 'limit',
157 ApiBase
:: PARAM_MIN
=> 1,
158 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
159 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
162 ApiBase
:: PARAM_DFLT
=> 'ascending',
163 ApiBase
:: PARAM_TYPE
=> array (
169 'sha1base36' => null,
171 ApiBase
:: PARAM_TYPE
=> array(
179 ApiBase
:: PARAM_DFLT
=> 'timestamp|url',
180 ApiBase
:: PARAM_ISMULTI
=> true
185 public function getParamDescription() {
187 'from' => 'The image title to start enumerating from.',
188 'prefix' => 'Search for all image titles that begin with this value.',
189 'dir' => 'The direction in which to list',
190 'minsize' => 'Limit to images with at least this many bytes',
191 'maxsize' => 'Limit to images with at most this many bytes',
192 'limit' => 'How many total pages to return.',
193 'sha1' => 'SHA1 hash of image',
194 'sha1base36' => 'SHA1 hash of image in base 36 (used in MediaWiki)',
195 'prop' => 'Which properties to get',
199 public function getDescription() {
200 return 'Enumerate all images sequentially';
203 protected function getExamples() {
206 ' Show a list of images starting at the letter "B"',
207 ' api.php?action=query&list=allimages&aifrom=B',
208 'Using as Generator',
209 ' Show info about 4 images starting at the letter "T"',
210 ' api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo',
214 public function getVersion() {
215 return __CLASS__
. ': $Id$';