X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/87219ebd28426c6d21cb545233ee52f5f7af7dfd..18a6620945d02687fbcfc4c27355d952fd748b41:/includes/api/ApiQueryFilearchive.php diff --git a/includes/api/ApiQueryFilearchive.php b/includes/api/ApiQueryFilearchive.php new file mode 100644 index 00000000..05ccb346 --- /dev/null +++ b/includes/api/ApiQueryFilearchive.php @@ -0,0 +1,264 @@ +isAllowed( 'deletedhistory' ) ) { + $this->dieUsage( 'You don\'t have permission to view deleted file information', 'permissiondenied' ); + } + + $db = $this->getDB(); + + $params = $this->extractRequestParams(); + + $prop = array_flip( $params['prop'] ); + $fld_sha1 = isset( $prop['sha1'] ); + $fld_timestamp = isset( $prop['timestamp'] ); + $fld_user = isset( $prop['user'] ); + $fld_size = isset( $prop['size'] ); + $fld_dimensions = isset( $prop['dimensions'] ); + $fld_description = isset( $prop['description'] ); + $fld_mime = isset( $prop['mime'] ); + $fld_metadata = isset( $prop['metadata'] ); + $fld_bitdepth = isset( $prop['bitdepth'] ); + + $this->addTables( 'filearchive' ); + + $this->addFields( array( 'fa_name', 'fa_deleted' ) ); + $this->addFieldsIf( 'fa_storage_key', $fld_sha1 ); + $this->addFieldsIf( 'fa_timestamp', $fld_timestamp ); + + if ( $fld_user ) { + $this->addFields( array( 'fa_user', 'fa_user_text' ) ); + } + $this->addFieldsIf( 'fa_size', $fld_size ); + + if ( $fld_dimensions ) { + $this->addFields( array( 'fa_height', 'fa_width' ) ); + } + + $this->addFieldsIf( 'fa_description', $fld_description ); + + if ( $fld_mime ) { + $this->addFields( array( 'fa_major_mime', 'fa_minor_mime' ) ); + } + + $this->addFieldsIf( 'fa_metadata', $fld_metadata ); + $this->addFieldsIf( 'fa_bits', $fld_bitdepth ); + + // Image filters + $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' ); + $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) ); + $this->addWhereRange( 'fa_name', $dir, $from, null ); + if ( isset( $params['prefix'] ) ) { + $this->addWhere( 'fa_name' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) ); + } + + if ( !$wgUser->isAllowed( 'suppressrevision' ) ) { + // Filter out revisions that the user is not allowed to see. There + // is no way to indicate that we have skipped stuff because the + // continuation parameter is fa_name + + // Note that this field is unindexed. This should however not be + // a big problem as files with fa_deleted are rare + $this->addWhereFld( 'fa_deleted', 0 ); + } + + + + $limit = $params['limit']; + $this->addOption( 'LIMIT', $limit + 1 ); + $this->addOption( 'ORDER BY', 'fa_name' . + ( $params['dir'] == 'descending' ? ' DESC' : '' ) ); + + $res = $this->select( __METHOD__ ); + + $count = 0; + $result = $this->getResult(); + foreach ( $res as $row ) { + if ( ++$count > $limit ) { + // We've reached the one extra which shows that there are additional pages to be had. Stop here... + // TODO: Security issue - if the user has no right to view next title, it will still be shown + $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->fa_name ) ); + break; + } + + $file = array(); + $file['name'] = $row->fa_name; + + if ( $fld_sha1 ) { + $file['sha1'] = wfBaseConvert( $row->fa_storage_key, 36, 16, 40 ); + } + if ( $fld_timestamp ) { + $file['timestamp'] = wfTimestamp( TS_ISO_8601, $row->fa_timestamp ); + } + if ( $fld_user ) { + $file['userid'] = $row->fa_user; + $file['user'] = $row->fa_user_text; + } + if ( $fld_size ) { + $file['size'] = $row->fa_size; + } + if ( $fld_dimensions ) { + $file['height'] = $row->fa_height; + $file['width'] = $row->fa_width; + } + if ( $fld_description ) { + $file['description'] = $row->fa_description; + } + if ( $fld_metadata ) { + $file['metadata'] = $row->fa_metadata ? ApiQueryImageInfo::processMetaData( unserialize( $row->fa_metadata ), $result ) : null; + } + if ( $fld_bitdepth ) { + $file['bitdepth'] = $row->fa_bits; + } + if ( $fld_mime ) { + $file['mime'] = "$row->fa_major_mime/$row->fa_minor_mime"; + } + + if ( $row->fa_deleted & File::DELETED_FILE ) { + $file['filehidden'] = ''; + } + if ( $row->fa_deleted & File::DELETED_COMMENT ) { + $file['commenthidden'] = ''; + } + if ( $row->fa_deleted & File::DELETED_USER ) { + $file['userhidden'] = ''; + } + if ( $row->fa_deleted & File::DELETED_RESTRICTED ) { + // This file is deleted for normal admins + $file['suppressed'] = ''; + } + + + $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $file ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->fa_name ) ); + break; + } + } + + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'fa' ); + } + + public function getAllowedParams() { + return array ( + 'from' => null, + 'prefix' => null, + 'limit' => array( + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 + ), + 'dir' => array( + ApiBase::PARAM_DFLT => 'ascending', + ApiBase::PARAM_TYPE => array( + 'ascending', + 'descending' + ) + ), + 'prop' => array( + ApiBase::PARAM_DFLT => 'timestamp', + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array( + 'sha1', + 'timestamp', + 'user', + 'size', + 'dimensions', + 'description', + 'mime', + 'metadata', + 'bitdepth' + ), + ), + ); + } + + public function getParamDescription() { + return array( + 'from' => 'The image title to start enumerating from', + 'prefix' => 'Search for all image titles that begin with this value', + 'dir' => 'The direction in which to list', + 'limit' => 'How many total images to return', + 'prop' => array( + 'What image information to get:', + ' sha1 - Adds sha1 hash for the image', + ' timestamp - Adds timestamp for the uploaded version', + ' user - Adds user who uploaded the image version', + ' size - Adds the size of the image in bytes', + ' dimensions - Adds the height and width of the image', + ' description - Adds description the image version', + ' mime - Adds MIME of the image', + ' metadata - Lists EXIF metadata for the version of the image', + ' bitdepth - Adds the bit depth of the version', + ), + ); + } + + public function getDescription() { + return 'Enumerate all deleted files sequentially'; + } + + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted file information' ), + ) ); + } + + protected function getExamples() { + return array( + 'Simple Use', + ' Show a list of all deleted files', + ' api.php?action=query&list=filearchive', + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id: ApiQueryFilearchive.php 85354 2011-04-04 18:25:31Z demon $'; + } +}