includes/api/ApiQueryFilearchive.php

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