3 * API for MediaWiki 1.12+
5 * Copyright © 2010 Sam Reed
6 * Copyright © 2008 Vasiliev Victor vasilvv@gmail.com,
7 * based on ApiQueryAllPages.php
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 use MediaWiki\Revision\RevisionRecord
;
30 * Query module to enumerate all deleted files.
34 class ApiQueryFilearchive
extends ApiQueryBase
{
36 public function __construct( ApiQuery
$query, $moduleName ) {
37 parent
::__construct( $query, $moduleName, 'fa' );
40 public function execute() {
41 $user = $this->getUser();
43 $commentStore = CommentStore
::getStore();
45 $params = $this->extractRequestParams();
47 $prop = array_flip( $params['prop'] );
48 $fld_sha1 = isset( $prop['sha1'] );
49 $fld_timestamp = isset( $prop['timestamp'] );
50 $fld_user = isset( $prop['user'] );
51 $fld_size = isset( $prop['size'] );
52 $fld_dimensions = isset( $prop['dimensions'] );
53 $fld_description = isset( $prop['description'] ) ||
isset( $prop['parseddescription'] );
54 $fld_mime = isset( $prop['mime'] );
55 $fld_mediatype = isset( $prop['mediatype'] );
56 $fld_metadata = isset( $prop['metadata'] );
57 $fld_bitdepth = isset( $prop['bitdepth'] );
58 $fld_archivename = isset( $prop['archivename'] );
60 if ( $fld_description &&
61 !$this->getPermissionManager()->userHasRight( $user, 'deletedhistory' )
63 $this->dieWithError( 'apierror-cantview-deleted-description', 'permissiondenied' );
66 !$this->getPermissionManager()->userHasAnyRight( $user, 'deletedtext', 'undelete' )
68 $this->dieWithError( 'apierror-cantview-deleted-metadata', 'permissiondenied' );
71 $fileQuery = ArchivedFile
::getQueryInfo();
72 $this->addTables( $fileQuery['tables'] );
73 $this->addFields( $fileQuery['fields'] );
74 $this->addJoinConds( $fileQuery['joins'] );
76 if ( !is_null( $params['continue'] ) ) {
77 $cont = explode( '|', $params['continue'] );
78 $this->dieContinueUsageIf( count( $cont ) != 3 );
79 $op = $params['dir'] == 'descending' ?
'<' : '>';
80 $cont_from = $db->addQuotes( $cont[0] );
81 $cont_timestamp = $db->addQuotes( $db->timestamp( $cont[1] ) );
82 $cont_id = (int)$cont[2];
83 $this->dieContinueUsageIf( $cont[2] !== (string)$cont_id );
84 $this->addWhere( "fa_name $op $cont_from OR " .
85 "(fa_name = $cont_from AND " .
86 "(fa_timestamp $op $cont_timestamp OR " .
87 "(fa_timestamp = $cont_timestamp AND " .
88 "fa_id $op= $cont_id )))"
93 $dir = ( $params['dir'] == 'descending' ?
'older' : 'newer' );
94 $from = ( $params['from'] === null ?
null : $this->titlePartToKey( $params['from'], NS_FILE
) );
95 $to = ( $params['to'] === null ?
null : $this->titlePartToKey( $params['to'], NS_FILE
) );
96 $this->addWhereRange( 'fa_name', $dir, $from, $to );
97 if ( isset( $params['prefix'] ) ) {
98 $this->addWhere( 'fa_name' . $db->buildLike(
99 $this->titlePartToKey( $params['prefix'], NS_FILE
),
100 $db->anyString() ) );
103 $sha1Set = isset( $params['sha1'] );
104 $sha1base36Set = isset( $params['sha1base36'] );
105 if ( $sha1Set ||
$sha1base36Set ) {
108 $sha1 = strtolower( $params['sha1'] );
109 if ( !$this->validateSha1Hash( $sha1 ) ) {
110 $this->dieWithError( 'apierror-invalidsha1hash' );
112 $sha1 = Wikimedia\base_convert
( $sha1, 16, 36, 31 );
113 } elseif ( $sha1base36Set ) {
114 $sha1 = strtolower( $params['sha1base36'] );
115 if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
116 $this->dieWithError( 'apierror-invalidsha1base36hash' );
120 $this->addWhereFld( 'fa_sha1', $sha1 );
121 // Paranoia: avoid brute force searches (T19342)
122 if ( !$this->getPermissionManager()->userHasRight( $user, 'deletedtext' ) ) {
123 $bitmask = File
::DELETED_FILE
;
124 } elseif ( !$this->getPermissionManager()
125 ->userHasAnyRight( $user, 'suppressrevision', 'viewsuppressed' )
127 $bitmask = File
::DELETED_FILE | File
::DELETED_RESTRICTED
;
132 $this->addWhere( $this->getDB()->bitAnd( 'fa_deleted', $bitmask ) . " != $bitmask" );
137 $limit = $params['limit'];
138 $this->addOption( 'LIMIT', $limit +
1 );
139 $sort = ( $params['dir'] == 'descending' ?
' DESC' : '' );
140 $this->addOption( 'ORDER BY', [
142 'fa_timestamp' . $sort,
146 $res = $this->select( __METHOD__
);
149 $result = $this->getResult();
150 foreach ( $res as $row ) {
151 if ( ++
$count > $limit ) {
152 // We've reached the one extra which shows that there are
153 // additional pages to be had. Stop here...
154 $this->setContinueEnumParameter(
155 'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
160 $canViewFile = RevisionRecord
::userCanBitfield( $row->fa_deleted
, File
::DELETED_FILE
, $user );
163 $file['id'] = (int)$row->fa_id
;
164 $file['name'] = $row->fa_name
;
165 $title = Title
::makeTitle( NS_FILE
, $row->fa_name
);
166 self
::addTitleInfo( $file, $title );
168 if ( $fld_description &&
169 RevisionRecord
::userCanBitfield( $row->fa_deleted
, File
::DELETED_COMMENT
, $user )
171 $file['description'] = $commentStore->getComment( 'fa_description', $row )->text
;
172 if ( isset( $prop['parseddescription'] ) ) {
173 $file['parseddescription'] = Linker
::formatComment(
174 $file['description'], $title );
178 RevisionRecord
::userCanBitfield( $row->fa_deleted
, File
::DELETED_USER
, $user )
180 $file['userid'] = (int)$row->fa_user
;
181 $file['user'] = $row->fa_user_text
;
183 if ( $fld_sha1 && $canViewFile ) {
184 $file['sha1'] = Wikimedia\base_convert
( $row->fa_sha1
, 36, 16, 40 );
186 if ( $fld_timestamp ) {
187 $file['timestamp'] = wfTimestamp( TS_ISO_8601
, $row->fa_timestamp
);
189 if ( ( $fld_size ||
$fld_dimensions ) && $canViewFile ) {
190 $file['size'] = $row->fa_size
;
192 $pageCount = ArchivedFile
::newFromRow( $row )->pageCount();
193 if ( $pageCount !== false ) {
194 $file['pagecount'] = $pageCount;
197 $file['height'] = $row->fa_height
;
198 $file['width'] = $row->fa_width
;
200 if ( $fld_mediatype && $canViewFile ) {
201 $file['mediatype'] = $row->fa_media_type
;
203 if ( $fld_metadata && $canViewFile ) {
204 $file['metadata'] = $row->fa_metadata
205 ? ApiQueryImageInfo
::processMetaData( unserialize( $row->fa_metadata
), $result )
208 if ( $fld_bitdepth && $canViewFile ) {
209 $file['bitdepth'] = $row->fa_bits
;
211 if ( $fld_mime && $canViewFile ) {
212 $file['mime'] = "$row->fa_major_mime/$row->fa_minor_mime";
214 if ( $fld_archivename && !is_null( $row->fa_archive_name
) ) {
215 $file['archivename'] = $row->fa_archive_name
;
218 if ( $row->fa_deleted
& File
::DELETED_FILE
) {
219 $file['filehidden'] = true;
221 if ( $row->fa_deleted
& File
::DELETED_COMMENT
) {
222 $file['commenthidden'] = true;
224 if ( $row->fa_deleted
& File
::DELETED_USER
) {
225 $file['userhidden'] = true;
227 if ( $row->fa_deleted
& File
::DELETED_RESTRICTED
) {
228 // This file is deleted for normal admins
229 $file['suppressed'] = true;
232 $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $file );
234 $this->setContinueEnumParameter(
235 'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
241 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'fa' );
244 public function getAllowedParams() {
250 ApiBase
::PARAM_DFLT
=> 'ascending',
251 ApiBase
::PARAM_TYPE
=> [
257 'sha1base36' => null,
259 ApiBase
::PARAM_DFLT
=> 'timestamp',
260 ApiBase
::PARAM_ISMULTI
=> true,
261 ApiBase
::PARAM_TYPE
=> [
275 ApiBase
::PARAM_HELP_MSG_PER_VALUE
=> [],
278 ApiBase
::PARAM_DFLT
=> 10,
279 ApiBase
::PARAM_TYPE
=> 'limit',
280 ApiBase
::PARAM_MIN
=> 1,
281 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
282 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
285 ApiBase
::PARAM_HELP_MSG
=> 'api-help-param-continue',
290 protected function getExamplesMessages() {
292 'action=query&list=filearchive'
293 => 'apihelp-query+filearchive-example-simple',
297 public function getHelpUrls() {
298 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Filearchive';