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                 $commentStore = new CommentStore( 'fa_description' );
  47
  48                 $params = $this->extractRequestParams();
  49
  50                 $prop = array_flip( $params['prop'] );
  51                 $fld_sha1 = isset( $prop['sha1'] );
  52                 $fld_timestamp = isset( $prop['timestamp'] );
  53                 $fld_user = isset( $prop['user'] );
  54                 $fld_size = isset( $prop['size'] );
  55                 $fld_dimensions = isset( $prop['dimensions'] );
  56                 $fld_description = isset( $prop['description'] ) || isset( $prop['parseddescription'] );
  57                 $fld_mime = isset( $prop['mime'] );
  58                 $fld_mediatype = isset( $prop['mediatype'] );
  59                 $fld_metadata = isset( $prop['metadata'] );
  60                 $fld_bitdepth = isset( $prop['bitdepth'] );
  61                 $fld_archivename = isset( $prop['archivename'] );
  62
  63                 $this->addTables( 'filearchive' );
  64
  65                 $this->addFields( ArchivedFile::selectFields() );
  66                 $this->addFields( [ 'fa_id', 'fa_name', 'fa_timestamp', 'fa_deleted' ] );
  67                 $this->addFieldsIf( 'fa_sha1', $fld_sha1 );
  68                 $this->addFieldsIf( [ 'fa_user', 'fa_user_text' ], $fld_user );
  69                 $this->addFieldsIf( [ 'fa_height', 'fa_width', 'fa_size' ], $fld_dimensions || $fld_size );
  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 ( $fld_description ) {
  77                         $commentQuery = $commentStore->getJoin();
  78                         $this->addTables( $commentQuery['tables'] );
  79                         $this->addFields( $commentQuery['fields'] );
  80                         $this->addJoinConds( $commentQuery['joins'] );
  81                 }
  82
  83                 if ( !is_null( $params['continue'] ) ) {
  84                         $cont = explode( '|', $params['continue'] );
  85                         $this->dieContinueUsageIf( count( $cont ) != 3 );
  86                         $op = $params['dir'] == 'descending' ? '<' : '>';
  87                         $cont_from = $db->addQuotes( $cont[0] );
  88                         $cont_timestamp = $db->addQuotes( $db->timestamp( $cont[1] ) );
  89                         $cont_id = (int)$cont[2];
  90                         $this->dieContinueUsageIf( $cont[2] !== (string)$cont_id );
  91                         $this->addWhere( "fa_name $op $cont_from OR " .
  92                                 "(fa_name = $cont_from AND " .
  93                                 "(fa_timestamp $op $cont_timestamp OR " .
  94                                 "(fa_timestamp = $cont_timestamp AND " .
  95                                 "fa_id $op= $cont_id )))"
  96                         );
  97                 }
  98
  99                 // Image filters
 100                 $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' );
 101                 $from = ( $params['from'] === null ? null : $this->titlePartToKey( $params['from'], NS_FILE ) );
 102                 $to = ( $params['to'] === null ? null : $this->titlePartToKey( $params['to'], NS_FILE ) );
 103                 $this->addWhereRange( 'fa_name', $dir, $from, $to );
 104                 if ( isset( $params['prefix'] ) ) {
 105                         $this->addWhere( 'fa_name' . $db->buildLike(
 106                                 $this->titlePartToKey( $params['prefix'], NS_FILE ),
 107                                 $db->anyString() ) );
 108                 }
 109
 110                 $sha1Set = isset( $params['sha1'] );
 111                 $sha1base36Set = isset( $params['sha1base36'] );
 112                 if ( $sha1Set || $sha1base36Set ) {
 113                         $sha1 = false;
 114                         if ( $sha1Set ) {
 115                                 $sha1 = strtolower( $params['sha1'] );
 116                                 if ( !$this->validateSha1Hash( $sha1 ) ) {
 117                                         $this->dieWithError( 'apierror-invalidsha1hash' );
 118                                 }
 119                                 $sha1 = Wikimedia\base_convert( $sha1, 16, 36, 31 );
 120                         } elseif ( $sha1base36Set ) {
 121                                 $sha1 = strtolower( $params['sha1base36'] );
 122                                 if ( !$this->validateSha1Base36Hash( $sha1 ) ) {
 123                                         $this->dieWithError( 'apierror-invalidsha1base36hash' );
 124                                 }
 125                         }
 126                         if ( $sha1 ) {
 127                                 $this->addWhereFld( 'fa_sha1', $sha1 );
 128                         }
 129                 }
 130
 131                 // Exclude files this user can't view.
 132                 if ( !$user->isAllowed( 'deletedtext' ) ) {
 133                         $bitmask = File::DELETED_FILE;
 134                 } elseif ( !$user->isAllowedAny( 'suppressrevision', 'viewsuppressed' ) ) {
 135                         $bitmask = File::DELETED_FILE | File::DELETED_RESTRICTED;
 136                 } else {
 137                         $bitmask = 0;
 138                 }
 139                 if ( $bitmask ) {
 140                         $this->addWhere( $this->getDB()->bitAnd( 'fa_deleted', $bitmask ) . " != $bitmask" );
 141                 }
 142
 143                 $limit = $params['limit'];
 144                 $this->addOption( 'LIMIT', $limit + 1 );
 145                 $sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
 146                 $this->addOption( 'ORDER BY', [
 147                         'fa_name' . $sort,
 148                         'fa_timestamp' . $sort,
 149                         'fa_id' . $sort,
 150                 ] );
 151
 152                 $res = $this->select( __METHOD__ );
 153
 154                 $count = 0;
 155                 $result = $this->getResult();
 156                 foreach ( $res as $row ) {
 157                         if ( ++$count > $limit ) {
 158                                 // We've reached the one extra which shows that there are
 159                                 // additional pages to be had. Stop here...
 160                                 $this->setContinueEnumParameter(
 161                                         'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
 162                                 );
 163                                 break;
 164                         }
 165
 166                         $file = [];
 167                         $file['id'] = (int)$row->fa_id;
 168                         $file['name'] = $row->fa_name;
 169                         $title = Title::makeTitle( NS_FILE, $row->fa_name );
 170                         self::addTitleInfo( $file, $title );
 171
 172                         if ( $fld_description &&
 173                                 Revision::userCanBitfield( $row->fa_deleted, File::DELETED_COMMENT, $user )
 174                         ) {
 175                                 $file['description'] = $commentStore->getComment( $row )->text;
 176                                 if ( isset( $prop['parseddescription'] ) ) {
 177                                         $file['parseddescription'] = Linker::formatComment(
 178                                                 $file['description'], $title );
 179                                 }
 180                         }
 181                         if ( $fld_user &&
 182                                 Revision::userCanBitfield( $row->fa_deleted, File::DELETED_USER, $user )
 183                         ) {
 184                                 $file['userid'] = (int)$row->fa_user;
 185                                 $file['user'] = $row->fa_user_text;
 186                         }
 187                         if ( $fld_sha1 ) {
 188                                 $file['sha1'] = Wikimedia\base_convert( $row->fa_sha1, 36, 16, 40 );
 189                         }
 190                         if ( $fld_timestamp ) {
 191                                 $file['timestamp'] = wfTimestamp( TS_ISO_8601, $row->fa_timestamp );
 192                         }
 193                         if ( $fld_size || $fld_dimensions ) {
 194                                 $file['size'] = $row->fa_size;
 195
 196                                 $pageCount = ArchivedFile::newFromRow( $row )->pageCount();
 197                                 if ( $pageCount !== false ) {
 198                                         $file['pagecount'] = $pageCount;
 199                                 }
 200
 201                                 $file['height'] = $row->fa_height;
 202                                 $file['width'] = $row->fa_width;
 203                         }
 204                         if ( $fld_mediatype ) {
 205                                 $file['mediatype'] = $row->fa_media_type;
 206                         }
 207                         if ( $fld_metadata ) {
 208                                 $file['metadata'] = $row->fa_metadata
 209                                         ? ApiQueryImageInfo::processMetaData( unserialize( $row->fa_metadata ), $result )
 210                                         : null;
 211                         }
 212                         if ( $fld_bitdepth ) {
 213                                 $file['bitdepth'] = $row->fa_bits;
 214                         }
 215                         if ( $fld_mime ) {
 216                                 $file['mime'] = "$row->fa_major_mime/$row->fa_minor_mime";
 217                         }
 218                         if ( $fld_archivename && !is_null( $row->fa_archive_name ) ) {
 219                                 $file['archivename'] = $row->fa_archive_name;
 220                         }
 221
 222                         if ( $row->fa_deleted & File::DELETED_FILE ) {
 223                                 $file['filehidden'] = true;
 224                         }
 225                         if ( $row->fa_deleted & File::DELETED_COMMENT ) {
 226                                 $file['commenthidden'] = true;
 227                         }
 228                         if ( $row->fa_deleted & File::DELETED_USER ) {
 229                                 $file['userhidden'] = true;
 230                         }
 231                         if ( $row->fa_deleted & File::DELETED_RESTRICTED ) {
 232                                 // This file is deleted for normal admins
 233                                 $file['suppressed'] = true;
 234                         }
 235
 236                         $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $file );
 237                         if ( !$fit ) {
 238                                 $this->setContinueEnumParameter(
 239                                         'continue', "$row->fa_name|$row->fa_timestamp|$row->fa_id"
 240                                 );
 241                                 break;
 242                         }
 243                 }
 244
 245                 $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'fa' );
 246         }
 247
 248         public function getAllowedParams() {
 249                 return [
 250                         'from' => null,
 251                         'to' => null,
 252                         'prefix' => null,
 253                         'dir' => [
 254                                 ApiBase::PARAM_DFLT => 'ascending',
 255                                 ApiBase::PARAM_TYPE => [
 256                                         'ascending',
 257                                         'descending'
 258                                 ]
 259                         ],
 260                         'sha1' => null,
 261                         'sha1base36' => null,
 262                         'prop' => [
 263                                 ApiBase::PARAM_DFLT => 'timestamp',
 264                                 ApiBase::PARAM_ISMULTI => true,
 265                                 ApiBase::PARAM_TYPE => [
 266                                         'sha1',
 267                                         'timestamp',
 268                                         'user',
 269                                         'size',
 270                                         'dimensions',
 271                                         'description',
 272                                         'parseddescription',
 273                                         'mime',
 274                                         'mediatype',
 275                                         'metadata',
 276                                         'bitdepth',
 277                                         'archivename',
 278                                 ],
 279                                 ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
 280                         ],
 281                         'limit' => [
 282                                 ApiBase::PARAM_DFLT => 10,
 283                                 ApiBase::PARAM_TYPE => 'limit',
 284                                 ApiBase::PARAM_MIN => 1,
 285                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 286                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 287                         ],
 288                         'continue' => [
 289                                 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
 290                         ],
 291                 ];
 292         }
 293
 294         protected function getExamplesMessages() {
 295                 return [
 296                         'action=query&list=filearchive'
 297                                 => 'apihelp-query+filearchive-example-simple',
 298                 ];
 299         }
 300
 301         public function getHelpUrls() {
 302                 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Filearchive';
 303         }
 304 }