* @file
*/
-if ( !defined( 'MEDIAWIKI' ) ) {
- // Eclipse helper - will be ignored in production
- require_once( 'ApiQueryBase.php' );
-}
-
/**
* A query action to get image information and upload history.
*
}
break;
}
-
+
// Check if we can make the requested thumbnail, and get transform parameters.
$finalThumbParams = $this->mergeThumbParams( $img, $scale, $params['urlparam'] );
( is_null( $params['end'] ) || $img->getTimestamp() >= $params['end'] )
) {
$gotOne = true;
-
+
$fit = $this->addPageSubItem( $pageId,
- self::getInfo( $img, $prop, $result, $finalThumbParams ) );
+ self::getInfo( $img, $prop, $result,
+ $finalThumbParams, $params['metadataversion'] ) );
if ( !$fit ) {
if ( count( $pageIds[NS_IMAGE] ) == 1 ) {
// See the 'the user is screwed' comment above
break;
}
$fit = $this->addPageSubItem( $pageId,
- self::getInfo( $oldie, $prop, $result, $finalThumbParams ) );
+ self::getInfo( $oldie, $prop, $result,
+ $finalThumbParams, $params['metadataversion'] ) );
if ( !$fit ) {
if ( count( $pageIds[NS_IMAGE] ) == 1 ) {
$this->setContinueEnumParameter( 'start',
* to know which handler, since handlers can make their own parameters.
* @param File $image Image that params are for.
* @param Array $thumbParams thumbnail parameters from getScale
- * @param String String of otherParams (iiurlparam).
+ * @param String $otherParams of otherParams (iiurlparam).
* @return Array of parameters for transform.
*/
protected function mergeThumbParams ( $image, $thumbParams, $otherParams ) {
$h = $image->getHandler();
if ( !$h ) {
- $this->setWarning( 'Could not create thumbnail because ' .
+ $this->setWarning( 'Could not create thumbnail because ' .
$image->getName() . ' does not have an associated image handler' );
return $thumbParams;
}
* @param $prop Array of properties to get (in the keys)
* @param $result ApiResult object
* @param $thumbParams Array containing 'width' and 'height' items, or null
+ * @param $version string Version of image metadata (for things like jpeg which have different versions).
* @return Array: result array
*/
- static function getInfo( $file, $prop, $result, $thumbParams = null ) {
+ static function getInfo( $file, $prop, $result, $thumbParams = null, $version = 'latest' ) {
$vals = array();
// Timestamp is shown even if the file is revdelete'd in interface
// so do same here.
$vals['commenthidden'] = '';
} else {
if ( $pcomment ) {
- global $wgUser;
- $vals['parsedcomment'] = $wgUser->getSkin()->formatComment(
+ $vals['parsedcomment'] = Linker::formatComment(
$file->getDescription(), $file->getTitle() );
}
if ( $comment ) {
if ( !is_null( $thumbParams ) ) {
$mto = $file->transform( $thumbParams );
if ( $mto && !$mto->isError() ) {
- $vals['thumburl'] = wfExpandUrl( $mto->getUrl() );
+ $vals['thumburl'] = wfExpandUrl( $mto->getUrl(), PROTO_CURRENT );
// bug 23834 - If the URL's are the same, we haven't resized it, so shouldn't give the wanted
// thumbnail sizes for the thumbnail actual size
$vals['thumbheight'] = intval( $file->getHeight() );
}
- if ( isset( $prop['thumbmime'] ) ) {
- $thumbFile = UnregisteredLocalFile::newFromPath( $mto->getPath(), false );
- $vals['thumbmime'] = $thumbFile->getMimeType();
+ if ( isset( $prop['thumbmime'] ) && $file->getHandler() ) {
+ list( $ext, $mime ) = $file->getHandler()->getThumbType(
+ substr( $mto->getPath(), strrpos( $mto->getPath(), '.' ) + 1 ),
+ $file->getMimeType(), $thumbParams );
+ $vals['thumbmime'] = $mime;
}
- } else if ( $mto && $mto->isError() ) {
+ } elseif ( $mto && $mto->isError() ) {
$vals['thumberror'] = $mto->toText();
}
}
- $vals['url'] = $file->getFullURL();
- $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl() );
+ $vals['url'] = wfExpandUrl( $file->getFullURL(), PROTO_CURRENT );
+ $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT );
}
if ( $sha1 ) {
}
if ( $meta ) {
- $metadata = $file->getMetadata();
- $vals['metadata'] = $metadata ? self::processMetaData( unserialize( $metadata ), $result ) : null;
+ $metadata = unserialize( $file->getMetadata() );
+ if ( $version !== 'latest' ) {
+ $metadata = $file->convertMetadataVersion( $metadata, $version );
+ }
+ $vals['metadata'] = $metadata ? self::processMetaData( $metadata, $result ) : null;
}
if ( $mime ) {
$vals['mime'] = $file->getMimeType();
}
-
+
if ( $mediatype ) {
$vals['mediatype'] = $file->getMediaType();
}
ApiBase::PARAM_TYPE => 'integer',
ApiBase::PARAM_DFLT => -1
),
+ 'metadataversion' => array(
+ ApiBase::PARAM_TYPE => 'string',
+ ApiBase::PARAM_DFLT => '1',
+ ),
'urlparam' => array(
ApiBase::PARAM_DFLT => '',
ApiBase::PARAM_TYPE => 'string',
/**
* Returns all possible parameters to iiprop
- * @static
+ *
+ * @param array $filter List of properties to filter out
+ *
* @return Array
*/
- public static function getPropertyNames() {
+ public static function getPropertyNames( $filter = array() ) {
+ return array_diff( array_keys( self::getProperties() ), $filter );
+ }
+
+ /**
+ * Returns array key value pairs of properties and their descriptions
+ *
+ * @return array
+ */
+ private static function getProperties() {
return array(
- 'timestamp',
- 'user',
- 'userid',
- 'comment',
- 'parsedcomment',
- 'url',
- 'size',
- 'dimensions', // For backwards compatibility with Allimages
- 'sha1',
- 'mime',
- 'thumbmime',
- 'mediatype',
- 'metadata',
- 'archivename',
- 'bitdepth',
+ 'timestamp' => ' timestamp - Adds timestamp for the uploaded version',
+ 'user' => ' user - Adds the user who uploaded the image version',
+ 'userid' => ' userid - Add the user ID that uploaded the image version',
+ 'comment' => ' comment - Comment on the version',
+ 'parsedcomment' => ' parsedcomment - Parse the comment on the version',
+ 'url' => ' url - Gives URL to the image and the description page',
+ 'size' => ' size - Adds the size of the image in bytes and the height, width and page count (if applicable)',
+ 'dimensions' => ' dimensions - Alias for size', // For backwards compatibility with Allimages
+ 'sha1' => ' sha1 - Adds SHA-1 hash for the image',
+ 'mime' => ' mime - Adds MIME type of the image',
+ 'thumbmime' => ' thumbmime - Adds MIME type of the image thumbnail (requires url)',
+ 'mediatype' => ' mediatype - Adds the media type of the image',
+ 'metadata' => ' metadata - Lists EXIF metadata for the version of the image',
+ 'archivename' => ' archivename - Adds the file name of the archive version for non-latest versions',
+ 'bitdepth' => ' bitdepth - Adds the bit depth of the version',
);
}
/**
* Returns the descriptions for the properties provided by getPropertyNames()
*
- * @static
+ * @param array $filter List of properties to filter out
+ *
* @return array
*/
- public static function getPropertyDescriptions() {
- return array(
- 'What image information to get:',
- ' timestamp - Adds timestamp for the uploaded version',
- ' user - Adds the user who uploaded the image version',
- ' userid - Add the user ID that uploaded the image version',
- ' comment - Comment on the version',
- ' parsedcomment - Parse the comment on the version',
- ' url - Gives URL to the image and the description page',
- ' size - Adds the size of the image in bytes and the height, width and page count (if applicable)',
- ' dimensions - Alias for size',
- ' sha1 - Adds SHA-1 hash for the image',
- ' mime - Adds MIME type of the image',
- ' thumbmime - Adds MIME type of the image thumbnail (requires url)',
- ' mediatype - Adds the media type of the image',
- ' metadata - Lists EXIF metadata for the version of the image',
- ' archivename - Adds the file name of the archive version for non-latest versions',
- ' bitdepth - Adds the bit depth of the version',
- );
+ public static function getPropertyDescriptions( $filter = array() ) {
+ return array_merge(
+ array( 'What image information to get:' ),
+ array_values( array_diff_key( self::getProperties(), array_flip( $filter ) ) )
+ );
}
/**
* Return the API documentation for the parameters.
- * @return {Array} parameter documentation.
+ * @return Array parameter documentation.
*/
public function getParamDescription() {
$p = $this->getModulePrefix();
'limit' => 'How many image revisions to return',
'start' => 'Timestamp to start listing from',
'end' => 'Timestamp to stop listing at',
+ 'metadataversion' => array( "Version of metadata to use. if 'latest' is specified, use latest version.",
+ "Defaults to '1' for backwards compatibility" ),
'continue' => 'If the query response includes a continue value, use it here to get another page of results'
);
}
array( 'code' => 'urlparam', 'info' => "Invalid value for {$p}urlparam" ),
array( 'code' => 'urlparam_no_width', 'info' => "{$p}urlparam requires {$p}urlwidth" ),
array( 'code' => 'urlparam_urlwidth_mismatch', 'info' => "The width set in {$p}urlparm doesnt't " .
- "match the one in {$p}urlwidth" ),
+ "match the one in {$p}urlwidth" ),
) );
}
- protected function getExamples() {
+ public function getExamples() {
return array(
'api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo',
'api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url',
);
}
+ public function getHelpUrls() {
+ return 'https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii';
+ }
+
public function getVersion() {
return __CLASS__ . ': $Id$';
}
dépôts / lhc / web / wiklou.git / blobdiff