includes/api/ApiQueryFilearchive.php

   1 <?php
   2 /**
   3  * API for MediaWiki 1.12+
   4  *
   5  * Created on May 10, 2010
   6  *
   7  * Copyright © 2010 Sam Reed
   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 deleted files.
  31  *
  32  * @ingroup API
  33  */
  34 class ApiQueryFilearchive extends ApiQueryBase {
  35
  36         public function __construct( ApiQuery $query, $moduleName ) {
  37                 parent::__construct( $query, $moduleName, 'fa' );
  38         }
  39
  40         public function execute() {
  41                 // Before doing anything at all, let's check permissions
  42                 $this->checkUserRightsAny( 'deletedhistory' );
  43
  44                 $user = $this->getUser();
  45                 $db = $this->getDB();
  46
  47                 $params = $this->extractRequestParams();
  48
  49                 $prop = array_flip( $params['prop'] );
  50                 $fld_sha1 = isset( $prop['sha1'] );
  51                 $fld_timestamp = isset( $prop['timestamp'] );
  52                 $fld_user = isset( $prop['user'] );
  53                 $fld_size = isset( $prop['size'] );
  54                 $fld_dimensions = isset( $prop['dimensions'] );
  55                 $fld_description = isset( $prop['description'] ) || isset( $prop['parseddescription'] );
  56                 $fld_mime = isset( $prop['mime'] );
  57                 $fld_mediatype = isset( $prop['mediatype'] );
  58                 $fld_metadata = isset( $prop['metadata'] );
  59                 $fld_bitdepth = isset( $prop['bitdepth'] );
  60                 $fld_archivename = isset( $prop['archivename'] );
  61
  62                 $this->addTables( 'filearchive' );
  63
  64                 $this->addFields( ArchivedFile::selectFields() );
  65                 $this->addFields( [ 'fa_id', 'fa_name', 'fa_timestamp', 'fa_deleted' ] );
  66                 $this->addFieldsIf( 'fa_sha1', $fld_sha1 );
  67                 $this->addFieldsIf( [ 'fa_user', 'fa_user_text' ], $fld_user );
  68                 $this->addFieldsIf( [ 'fa_height', 'fa_width', 'fa_size' ], $fld_dimensions || $fld_size );
  69                 $this->addFieldsIf( 'fa_description', $fld_description );
  70                 $this->addFieldsIf( [ 'fa_major_mime', 'fa_minor_mime' ], $fld_mime );
  71                 $this->addFieldsIf( 'fa_media_type', $fld_mediatype );
  72                 $this->addFieldsIf( 'fa_metadata', $fld_metadata );
  73                 $this->addFieldsIf( 'fa_bits', $fld_bitdepth );
  74                 $this->addFieldsIf( 'fa_archive_name', $fld_archivename );
  75
  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 )))"
  89                         );
  90                 }
  91
  92                 // Image filters
  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() ) );
 101                 }
 102
 103                 $sha1Set = isset( $params['sha1'] );
 104                 $sha1base36Set = isset( $params['sha1base36'] );
 105                 if ( $sha1Set || $sha1base36Set ) {
 106                         $sha1 = false;
 107                         if ( $sha1Set ) {
 108                                 $sha1 = strtolower( $params['sha1'] );
 109                                 if ( !$this->validateSha1Hash( $sha1 ) ) {
 110                                         $this->dieWithError( 'apierror-invalidsha1hash' );
 111                                 }
 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' );
 117                                 }
 118                         }
 119                         if ( $sha1 ) {
 120                                 $this->addWhereFld( 'fa_sha1', $sha1 );
 121                         }
 122                 }
 123
 124                 // Exclude files this user can't view.
 125                 if ( !$user->isAllowed( 'deletedtext' ) ) {
 126                         $bitmask = File::DELETED_FILE;
 127                 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 128                         $bitmask = File::DELETED_FILE | File::DELETED_RESTRICTED;
 129                 } else {
 130                         $bitmask = 0;
 131                 }
 132                 if ( $bitmask ) {
 133                         $this->addWhere( $this->getDB()->bitAnd( 'fa_deleted', $bitmask ) . " != $bitmask" );
 134                 }
 135
 136                 $limit = $params['limit'];
 137                 $this->addOption( 'LIMIT', $limit + 1 );
 138                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
 139                 $this->addOption( 'ORDER BY', [
 140                         'fa_name' . $sort,
 141                         'fa_timestamp' . $sort,
 142                         'fa_id' . $sort,
 143                 ] );
 144
 145                 $res = $this->select( __METHOD__ );
 146
 147                 $count = 0;
 148                 $result = $this->getResult();
 149                 foreach ( $res as $row ) {
 150                         if ( ++$count > $limit ) {
 151                                 // We've reached the one extra which shows that there are
 152                                 // additional pages to be had. Stop here...
 153                                 $this->setContinueEnumParameter(
 154                                         'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
 155                                 );
 156                                 break;
 157                         }
 158
 159                         $file = [];
 160                         $file['id'] = (int)$row->fa_id;
 161                         $file['name'] = $row->fa_name;
 162                         $title = Title::makeTitle( NS_FILE, $row->fa_name );
 163                         self::addTitleInfo( $file, $title );
 164
 165                         if ( $fld_description &&
 166                                 Revision::userCanBitfield( $row->fa_deleted, File::DELETED_COMMENT, $user )
 167                         ) {
 168                                 $file['description'] = $row->fa_description;
 169                                 if ( isset( $prop['parseddescription'] ) ) {
 170                                         $file['parseddescription'] = Linker::formatComment(
 171                                                 $row->fa_description, $title );
 172                                 }
 173                         }
 174                         if ( $fld_user &&
 175                                 Revision::userCanBitfield( $row->fa_deleted, File::DELETED_USER, $user )
 176                         ) {
 177                                 $file['userid'] = (int)$row->fa_user;
 178                                 $file['user'] = $row->fa_user_text;
 179                         }
 180                         if ( $fld_sha1 ) {
 181                                 $file['sha1'] = Wikimedia\base_convert( $row->fa_sha1, 36, 16, 40 );
 182                         }
 183                         if ( $fld_timestamp ) {
 184                                 $file['timestamp'] = wfTimestamp( TS_ISO_8601, $row->fa_timestamp );
 185                         }
 186                         if ( $fld_size || $fld_dimensions ) {
 187                                 $file['size'] = $row->fa_size;
 188
 189                                 $pageCount = ArchivedFile::newFromRow( $row )->pageCount();
 190                                 if ( $pageCount !== false ) {
 191                                         $file['pagecount'] = $pageCount;
 192                                 }
 193
 194                                 $file['height'] = $row->fa_height;
 195                                 $file['width'] = $row->fa_width;
 196                         }
 197                         if ( $fld_mediatype ) {
 198                                 $file['mediatype'] = $row->fa_media_type;
 199                         }
 200                         if ( $fld_metadata ) {
 201                                 $file['metadata'] = $row->fa_metadata
 202                                         ? ApiQueryImageInfo::processMetaData( unserialize( $row->fa_metadata ), $result )
 203                                         : null;
 204                         }
 205                         if ( $fld_bitdepth ) {
 206                                 $file['bitdepth'] = $row->fa_bits;
 207                         }
 208                         if ( $fld_mime ) {
 209                                 $file['mime'] = "$row->fa_major_mime/$row->fa_minor_mime";
 210                         }
 211                         if ( $fld_archivename && !is_null( $row->fa_archive_name ) ) {
 212                                 $file['archivename'] = $row->fa_archive_name;
 213                         }
 214
 215                         if ( $row->fa_deleted & File::DELETED_FILE ) {
 216                                 $file['filehidden'] = true;
 217                         }
 218                         if ( $row->fa_deleted & File::DELETED_COMMENT ) {
 219                                 $file['commenthidden'] = true;
 220                         }
 221                         if ( $row->fa_deleted & File::DELETED_USER ) {
 222                                 $file['userhidden'] = true;
 223                         }
 224                         if ( $row->fa_deleted & File::DELETED_RESTRICTED ) {
 225                                 // This file is deleted for normal admins
 226                                 $file['suppressed'] = true;
 227                         }
 228
 229                         $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $file );
 230                         if ( !$fit ) {
 231                                 $this->setContinueEnumParameter(
 232                                         'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
 233                                 );
 234                                 break;
 235                         }
 236                 }
 237
 238                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'fa' );
 239         }
 240
 241         public function getAllowedParams() {
 242                 return [
 243                         'from' => null,
 244                         'to' => null,
 245                         'prefix' => null,
 246                         'dir' => [
 247                                 ApiBase::PARAM_DFLT => 'ascending',
 248                                 ApiBase::PARAM_TYPE => [
 249                                         'ascending',
 250                                         'descending'
 251                                 ]
 252                         ],
 253                         'sha1' => null,
 254                         'sha1base36' => null,
 255                         'prop' => [
 256                                 ApiBase::PARAM_DFLT => 'timestamp',
 257                                 ApiBase::PARAM_ISMULTI => true,
 258                                 ApiBase::PARAM_TYPE => [
 259                                         'sha1',
 260                                         'timestamp',
 261                                         'user',
 262                                         'size',
 263                                         'dimensions',
 264                                         'description',
 265                                         'parseddescription',
 266                                         'mime',
 267                                         'mediatype',
 268                                         'metadata',
 269                                         'bitdepth',
 270                                         'archivename',
 271                                 ],
 272                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 273                         ],
 274                         'limit' => [
 275                                 ApiBase::PARAM_DFLT => 10,
 276                                 ApiBase::PARAM_TYPE => 'limit',
 277                                 ApiBase::PARAM_MIN => 1,
 278                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 279                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 280                         ],
 281                         'continue' => [
 282                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 283                         ],
 284                 ];
 285         }
 286
 287         protected function getExamplesMessages() {
 288                 return [
 289                         'action=query&list=filearchive'
 290                                 => 'apihelp-query+filearchive-example-simple',
 291                 ];
 292         }
 293
 294         public function getHelpUrls() {
 295                 return 'https://www.mediawiki.org/wiki/API:Filearchive';
 296         }
 297 }