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