3 * API for MediaWiki 1.12+
5 * Created on May 10, 2010
7 * Copyright © 2010 Sam Reed
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 if ( !defined( 'MEDIAWIKI' ) ) {
30 // Eclipse helper - will be ignored in production
31 require_once( 'ApiQueryBase.php' );
35 * Query module to enumerate all deleted files.
39 class ApiQueryFilearchive
extends ApiQueryBase
{
41 public function __construct( $query, $moduleName ) {
42 parent
::__construct( $query, $moduleName, 'fa' );
45 public function execute() {
47 // Before doing anything at all, let's check permissions
48 if ( !$wgUser->isAllowed( 'deletedhistory' ) ) {
49 $this->dieUsage( 'You don\'t have permission to view deleted file information', 'permissiondenied' );
54 $params = $this->extractRequestParams();
56 $prop = array_flip( $params['prop'] );
57 $fld_sha1 = isset( $prop['sha1'] );
58 $fld_timestamp = isset( $prop['timestamp'] );
59 $fld_user = isset( $prop['user'] );
60 $fld_size = isset( $prop['size'] );
61 $fld_dimensions = isset( $prop['dimensions'] );
62 $fld_description = isset( $prop['description'] );
63 $fld_mime = isset( $prop['mime'] );
64 $fld_metadata = isset( $prop['metadata'] );
65 $fld_bitdepth = isset( $prop['bitdepth'] );
67 $this->addTables( 'filearchive' );
69 $this->addFields( 'fa_name' );
70 $this->addFieldsIf( 'fa_storage_key', $fld_sha1 );
71 $this->addFieldsIf( 'fa_timestamp', $fld_timestamp );
72 $this->addFieldsIf( 'fa_user', $fld_user );
73 $this->addFieldsIf( 'fa_size', $fld_size );
75 if ( $fld_dimensions ) {
76 $this->addFields( array( 'fa_height', 'fa_width' ) );
79 $this->addFieldsIf( 'fa_description', $fld_description );
82 $this->addFields( array( 'fa_major_mime', 'fa_minor_mime' ) );
85 $this->addFieldsIf( 'fa_metadata', $fld_metadata );
86 $this->addFieldsIf( 'fa_bits', $fld_bitdepth );
89 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
90 $from = ( is_null( $params['from'] ) ?
null : $this->titlePartToKey( $params['from'] ) );
91 $this->addWhereRange( 'fa_name', $dir, $from, null );
92 if ( isset( $params['prefix'] ) )
93 $this->addWhere( 'fa_name' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
95 if ( isset( $params['minsize'] ) ) {
96 $this->addWhere( 'fa_size>=' . intval( $params['minsize'] ) );
99 if ( isset( $params['maxsize'] ) ) {
100 $this->addWhere( 'fa_size<=' . intval( $params['maxsize'] ) );
104 if ( isset( $params['sha1'] ) ) {
105 $sha1 = wfBaseConvert( $params['sha1'], 16, 36, 31 );
106 } elseif ( isset( $params['sha1base36'] ) ) {
107 $sha1 = $params['sha1base36'];
110 $this->addWhere( 'fa_storage_key=' . $db->addQuotes( $sha1 ) );
113 $limit = $params['limit'];
114 $this->addOption( 'LIMIT', $limit +
1 );
115 $this->addOption( 'ORDER BY', 'fa_name' .
116 ( $params['dir'] == 'descending' ?
' DESC' : '' ) );
118 $res = $this->select( __METHOD__
);
121 $result = $this->getResult();
122 foreach ( $res as $row ) {
123 if ( ++
$count > $limit ) {
124 // We've reached the one extra which shows that there are additional pages to be had. Stop here...
125 // TODO: Security issue - if the user has no right to view next title, it will still be shown
126 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->fa_name
) );
131 $file['name'] = $row->fa_name
;
134 $file['sha1'] = wfBaseConvert( $row->fa_storage_key
, 36, 16, 40 );
136 if ( $fld_timestamp ) {
137 $file['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->fa_timestamp
);
140 $file['user'] = $row->fa_user
;
143 $file['size'] = $row->fa_size
;
145 if ( $fld_dimensions ) {
146 $file['height'] = $row->fa_height
;
147 $file['width'] = $row->fa_width
;
149 if ( $fld_description ) {
150 $file['description'] = $row->fa_description
;
152 if ( $fld_metadata ) {
153 $file['metadata'] = $row->fa_metadata ? ApiQueryImageInfo
::processMetaData( unserialize( $row->fa_metadata
), $result ) : null;
155 if ( $fld_bitdepth ) {
156 $file['bitdepth'] = $row->fa_bits
;
159 $file['mime'] = "$row->fa_major_mime/$row->fa_minor_mime";
162 $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $file );
164 $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->fa_name
) );
169 $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'fa' );
172 public function getAllowedParams() {
177 ApiBase
::PARAM_TYPE
=> 'integer',
180 ApiBase
::PARAM_TYPE
=> 'integer',
183 ApiBase
::PARAM_DFLT
=> 10,
184 ApiBase
::PARAM_TYPE
=> 'limit',
185 ApiBase
::PARAM_MIN
=> 1,
186 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
187 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
190 ApiBase
::PARAM_DFLT
=> 'ascending',
191 ApiBase
::PARAM_TYPE
=> array(
197 'sha1base36' => null,
199 ApiBase
::PARAM_DFLT
=> 'timestamp',
200 ApiBase
::PARAM_ISMULTI
=> true,
201 ApiBase
::PARAM_TYPE
=> array(
216 public function getParamDescription() {
218 'from' => 'The image title to start enumerating from',
219 'prefix' => 'Search for all image titles that begin with this value',
220 'dir' => 'The direction in which to list',
221 'minsize' => 'Limit to images with at least this many bytes',
222 'maxsize' => 'Limit to images with at most this many bytes',
223 'limit' => 'How many total images to return',
224 'sha1' => "SHA1 hash of image. Overrides {$this->getModulePrefix()}sha1base36",
225 'sha1base36' => 'SHA1 hash of image in base 36 (used in MediaWiki)',
227 'What image information to get:',
228 ' sha1 - Adds sha1 hash for the image',
229 ' timestamp - Adds timestamp for the uploaded version',
230 ' user - Adds user for uploaded the image version',
231 ' size - Adds the size of the image in bytes',
232 ' dimensions - Adds the height and width of the image',
233 ' description - Adds description the image version',
234 ' mime - Adds MIME of the image',
235 ' metadata - Lists EXIF metadata for the version of the image',
236 ' bitdepth - Adds the bit depth of the version',
241 public function getDescription() {
242 return 'Enumerate all deleted files sequentially';
245 public function getPossibleErrors() {
246 return array_merge( parent
::getPossibleErrors(), array(
247 array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted file information' ),
251 protected function getExamples() {
254 ' Show a list of all deleted files',
255 ' api.php?action=query&list=filearchive',
259 public function getVersion() {
260 return __CLASS__
. ': $Id$';