5 * Created on July 6, 2007
7 * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
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.
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.
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
28 * A query action to get image information and upload history.
32 class ApiQueryImageInfo
extends ApiQueryBase
{
34 public function __construct( $query, $moduleName, $prefix = 'ii' ) {
35 // We allow a subclass to override the prefix, to create a related API module.
36 // Some other parts of MediaWiki construct this with a null $prefix, which used to be ignored when this only took two arguments
37 if ( is_null( $prefix ) ) {
40 parent
::__construct( $query, $moduleName, $prefix );
43 public function execute() {
44 $params = $this->extractRequestParams();
46 $prop = array_flip( $params['prop'] );
48 $scale = $this->getScale( $params );
50 $pageIds = $this->getPageSet()->getAllTitlesByNamespace();
51 if ( !empty( $pageIds[NS_FILE
] ) ) {
52 $titles = array_keys( $pageIds[NS_FILE
] );
53 asort( $titles ); // Ensure the order is always the same
56 if ( !is_null( $params['continue'] ) ) {
58 $cont = explode( '|', $params['continue'] );
59 if ( count( $cont ) != 2 ) {
60 $this->dieUsage( 'Invalid continue param. You should pass the original ' .
61 'value returned by the previous query', '_badcontinue' );
63 $fromTitle = strval( $cont[0] );
64 $fromTimestamp = $cont[1];
65 // Filter out any titles before $fromTitle
66 foreach ( $titles as $key => $title ) {
67 if ( $title < $fromTitle ) {
68 unset( $titles[$key] );
75 $result = $this->getResult();
76 //search only inside the local repo
77 if( $params['localonly'] ) {
78 $images = RepoGroup
::singleton()->getLocalRepo()->findFiles( $titles );
80 $images = RepoGroup
::singleton()->findFiles( $titles );
82 foreach ( $images as $img ) {
84 if ( $img->getOriginalTitle()->isRedirect() ) {
88 $start = $skip ?
$fromTimestamp : $params['start'];
89 $pageId = $pageIds[NS_FILE
][ $img->getOriginalTitle()->getDBkey() ];
91 $fit = $result->addValue(
92 array( 'query', 'pages', intval( $pageId ) ),
93 'imagerepository', $img->getRepoName()
96 if ( count( $pageIds[NS_FILE
] ) == 1 ) {
97 // The user is screwed. imageinfo can't be solely
98 // responsible for exceeding the limit in this case,
99 // so set a query-continue that just returns the same
100 // thing again. When the violating queries have been
101 // out-continued, the result will get through
102 $this->setContinueEnumParameter( 'start',
103 wfTimestamp( TS_ISO_8601
, $img->getTimestamp() ) );
105 $this->setContinueEnumParameter( 'continue',
106 $this->getContinueStr( $img ) );
111 // Check if we can make the requested thumbnail, and get transform parameters.
112 $finalThumbParams = $this->mergeThumbParams( $img, $scale, $params['urlparam'] );
114 // Get information about the current version first
115 // Check that the current version is within the start-end boundaries
118 ( is_null( $start ) ||
$img->getTimestamp() <= $start ) &&
119 ( is_null( $params['end'] ) ||
$img->getTimestamp() >= $params['end'] )
123 $fit = $this->addPageSubItem( $pageId,
124 self
::getInfo( $img, $prop, $result,
125 $finalThumbParams, $params['metadataversion'] ) );
127 if ( count( $pageIds[NS_FILE
] ) == 1 ) {
128 // See the 'the user is screwed' comment above
129 $this->setContinueEnumParameter( 'start',
130 wfTimestamp( TS_ISO_8601
, $img->getTimestamp() ) );
132 $this->setContinueEnumParameter( 'continue',
133 $this->getContinueStr( $img ) );
139 // Now get the old revisions
140 // Get one more to facilitate query-continue functionality
141 $count = ( $gotOne ?
1 : 0 );
142 $oldies = $img->getHistory( $params['limit'] - $count +
1, $start, $params['end'] );
143 foreach ( $oldies as $oldie ) {
144 if ( ++
$count > $params['limit'] ) {
145 // We've reached the extra one which shows that there are additional pages to be had. Stop here...
146 // Only set a query-continue if there was only one title
147 if ( count( $pageIds[NS_FILE
] ) == 1 ) {
148 $this->setContinueEnumParameter( 'start',
149 wfTimestamp( TS_ISO_8601
, $oldie->getTimestamp() ) );
153 $fit = $this->addPageSubItem( $pageId,
154 self
::getInfo( $oldie, $prop, $result,
155 $finalThumbParams, $params['metadataversion'] ) );
157 if ( count( $pageIds[NS_FILE
] ) == 1 ) {
158 $this->setContinueEnumParameter( 'start',
159 wfTimestamp( TS_ISO_8601
, $oldie->getTimestamp() ) );
161 $this->setContinueEnumParameter( 'continue',
162 $this->getContinueStr( $oldie ) );
173 $data = $this->getResultData();
174 foreach ( $data['query']['pages'] as $pageid => $arr ) {
175 if ( is_array( $arr ) && !isset( $arr['imagerepository'] ) ) {
177 array( 'query', 'pages', $pageid ),
178 'imagerepository', ''
181 // The above can't fail because it doesn't increase the result size
187 * From parameters, construct a 'scale' array
188 * @param $params Array: Parameters passed to api.
189 * @return Array or Null: key-val array of 'width' and 'height', or null
191 public function getScale( $params ) {
192 $p = $this->getModulePrefix();
195 if ( $params['urlheight'] != -1 && $params['urlwidth'] == -1 ) {
196 $this->dieUsage( "{$p}urlheight cannot be used without {$p}urlwidth", "{$p}urlwidth" );
199 if ( $params['urlwidth'] != -1 ) {
201 $scale['width'] = $params['urlwidth'];
202 $scale['height'] = $params['urlheight'];
205 if ( $params['urlparam'] ) {
206 $this->dieUsage( "{$p}urlparam requires {$p}urlwidth", "urlparam_no_width" );
214 /** Validate and merge scale parameters with handler thumb parameters, give error if invalid.
216 * We do this later than getScale, since we need the image
217 * to know which handler, since handlers can make their own parameters.
218 * @param File $image Image that params are for.
219 * @param Array $thumbParams thumbnail parameters from getScale
220 * @param String $otherParams of otherParams (iiurlparam).
221 * @return Array of parameters for transform.
223 protected function mergeThumbParams ( $image, $thumbParams, $otherParams ) {
224 if ( !$otherParams ) {
227 $p = $this->getModulePrefix();
229 $h = $image->getHandler();
231 $this->setWarning( 'Could not create thumbnail because ' .
232 $image->getName() . ' does not have an associated image handler' );
236 $paramList = $h->parseParamString( $otherParams );
238 // Just set a warning (instead of dieUsage), as in many cases
239 // we could still render the image using width and height parameters,
240 // and this type of thing could happen between different versions of
242 $this->setWarning( "Could not parse {$p}urlparam for " . $image->getName()
243 . '. Using only width and height' );
247 if ( isset( $paramList['width'] ) ) {
248 if ( intval( $paramList['width'] ) != intval( $thumbParams['width'] ) ) {
249 $this->dieUsage( "{$p}urlparam had width of {$paramList['width']} but "
250 . "{$p}urlwidth was {$thumbParams['width']}", "urlparam_urlwidth_mismatch" );
254 foreach ( $paramList as $name => $value ) {
255 if ( !$h->validateParam( $name, $value ) ) {
256 $this->dieUsage( "Invalid value for {$p}urlparam ($name=$value)", "urlparam" );
260 return $thumbParams +
$paramList;
264 * Get result information for an image revision
266 * @param $file File object
267 * @param $prop Array of properties to get (in the keys)
268 * @param $result ApiResult object
269 * @param $thumbParams Array containing 'width' and 'height' items, or null
270 * @param $version string Version of image metadata (for things like jpeg which have different versions).
271 * @return Array: result array
273 static function getInfo( $file, $prop, $result, $thumbParams = null, $version = 'latest' ) {
275 // Timestamp is shown even if the file is revdelete'd in interface
277 if ( isset( $prop['timestamp'] ) ) {
278 $vals['timestamp'] = wfTimestamp( TS_ISO_8601
, $file->getTimestamp() );
281 $user = isset( $prop['user'] );
282 $userid = isset( $prop['userid'] );
284 if ( $user ||
$userid ) {
285 if ( $file->isDeleted( File
::DELETED_USER
) ) {
286 $vals['userhidden'] = '';
289 $vals['user'] = $file->getUser();
292 $vals['userid'] = $file->getUser( 'id' );
294 if ( !$file->getUser( 'id' ) ) {
300 // This is shown even if the file is revdelete'd in interface
302 if ( isset( $prop['size'] ) ||
isset( $prop['dimensions'] ) ) {
303 $vals['size'] = intval( $file->getSize() );
304 $vals['width'] = intval( $file->getWidth() );
305 $vals['height'] = intval( $file->getHeight() );
307 $pageCount = $file->pageCount();
308 if ( $pageCount !== false ) {
309 $vals['pagecount'] = $pageCount;
313 $pcomment = isset( $prop['parsedcomment'] );
314 $comment = isset( $prop['comment'] );
316 if ( $pcomment ||
$comment ) {
317 if ( $file->isDeleted( File
::DELETED_COMMENT
) ) {
318 $vals['commenthidden'] = '';
321 $vals['parsedcomment'] = Linker
::formatComment(
322 $file->getDescription(), $file->getTitle() );
325 $vals['comment'] = $file->getDescription();
330 $url = isset( $prop['url'] );
331 $sha1 = isset( $prop['sha1'] );
332 $meta = isset( $prop['metadata'] );
333 $mime = isset( $prop['mime'] );
334 $mediatype = isset( $prop['mediatype'] );
335 $archive = isset( $prop['archivename'] );
336 $bitdepth = isset( $prop['bitdepth'] );
338 if ( ( $url ||
$sha1 ||
$meta ||
$mime ||
$mediatype ||
$archive ||
$bitdepth )
339 && $file->isDeleted( File
::DELETED_FILE
) ) {
340 $vals['filehidden'] = '';
342 //Early return, tidier than indenting all following things one level
347 if ( !is_null( $thumbParams ) ) {
348 $mto = $file->transform( $thumbParams );
349 if ( $mto && !$mto->isError() ) {
350 $vals['thumburl'] = wfExpandUrl( $mto->getUrl(), PROTO_CURRENT
);
352 // bug 23834 - If the URL's are the same, we haven't resized it, so shouldn't give the wanted
353 // thumbnail sizes for the thumbnail actual size
354 if ( $mto->getUrl() !== $file->getUrl() ) {
355 $vals['thumbwidth'] = intval( $mto->getWidth() );
356 $vals['thumbheight'] = intval( $mto->getHeight() );
358 $vals['thumbwidth'] = intval( $file->getWidth() );
359 $vals['thumbheight'] = intval( $file->getHeight() );
362 if ( isset( $prop['thumbmime'] ) && $file->getHandler() ) {
363 list( $ext, $mime ) = $file->getHandler()->getThumbType(
364 $mto->getExtension(), $file->getMimeType(), $thumbParams );
365 $vals['thumbmime'] = $mime;
367 } elseif ( $mto && $mto->isError() ) {
368 $vals['thumberror'] = $mto->toText();
371 $vals['url'] = wfExpandUrl( $file->getFullURL(), PROTO_CURRENT
);
372 $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT
);
376 $vals['sha1'] = wfBaseConvert( $file->getSha1(), 36, 16, 40 );
380 wfSuppressWarnings();
381 $metadata = unserialize( $file->getMetadata() );
383 if ( $metadata && $version !== 'latest' ) {
384 $metadata = $file->convertMetadataVersion( $metadata, $version );
386 $vals['metadata'] = $metadata ? self
::processMetaData( $metadata, $result ) : null;
390 $vals['mime'] = $file->getMimeType();
394 $vals['mediatype'] = $file->getMediaType();
397 if ( $archive && $file->isOld() ) {
398 $vals['archivename'] = $file->getArchiveName();
402 $vals['bitdepth'] = $file->getBitDepth();
410 * @param $metadata Array
411 * @param $result ApiResult
414 public static function processMetaData( $metadata, $result ) {
416 if ( is_array( $metadata ) ) {
417 foreach ( $metadata as $key => $value ) {
418 $r = array( 'name' => $key );
419 if ( is_array( $value ) ) {
420 $r['value'] = self
::processMetaData( $value, $result );
422 $r['value'] = $value;
427 $result->setIndexedTagName( $retval, 'metadata' );
431 public function getCacheMode( $params ) {
439 protected function getContinueStr( $img ) {
440 return $img->getOriginalTitle()->getText() .
441 '|' . $img->getTimestamp();
444 public function getAllowedParams() {
447 ApiBase
::PARAM_ISMULTI
=> true,
448 ApiBase
::PARAM_DFLT
=> 'timestamp|user',
449 ApiBase
::PARAM_TYPE
=> self
::getPropertyNames()
452 ApiBase
::PARAM_TYPE
=> 'limit',
453 ApiBase
::PARAM_DFLT
=> 1,
454 ApiBase
::PARAM_MIN
=> 1,
455 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
456 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
459 ApiBase
::PARAM_TYPE
=> 'timestamp'
462 ApiBase
::PARAM_TYPE
=> 'timestamp'
465 ApiBase
::PARAM_TYPE
=> 'integer',
466 ApiBase
::PARAM_DFLT
=> -1
468 'urlheight' => array(
469 ApiBase
::PARAM_TYPE
=> 'integer',
470 ApiBase
::PARAM_DFLT
=> -1
472 'metadataversion' => array(
473 ApiBase
::PARAM_TYPE
=> 'string',
474 ApiBase
::PARAM_DFLT
=> '1',
477 ApiBase
::PARAM_DFLT
=> '',
478 ApiBase
::PARAM_TYPE
=> 'string',
481 'localonly' => false,
486 * Returns all possible parameters to iiprop
488 * @param array $filter List of properties to filter out
492 public static function getPropertyNames( $filter = array() ) {
493 return array_diff( array_keys( self
::getProperties() ), $filter );
497 * Returns array key value pairs of properties and their descriptions
501 private static function getProperties( $modulePrefix = '' ) {
503 'timestamp' => ' timestamp - Adds timestamp for the uploaded version',
504 'user' => ' user - Adds the user who uploaded the image version',
505 'userid' => ' userid - Add the user ID that uploaded the image version',
506 'comment' => ' comment - Comment on the version',
507 'parsedcomment' => ' parsedcomment - Parse the comment on the version',
508 'url' => ' url - Gives URL to the image and the description page',
509 'size' => ' size - Adds the size of the image in bytes and the height, width and page count (if applicable)',
510 'dimensions' => ' dimensions - Alias for size', // For backwards compatibility with Allimages
511 'sha1' => ' sha1 - Adds SHA-1 hash for the image',
512 'mime' => ' mime - Adds MIME type of the image',
513 'thumbmime' => ' thumbmime - Adds MIME type of the image thumbnail' .
514 ' (requires url and param ' . $modulePrefix . 'urlwidth)',
515 'mediatype' => ' mediatype - Adds the media type of the image',
516 'metadata' => ' metadata - Lists EXIF metadata for the version of the image',
517 'archivename' => ' archivename - Adds the file name of the archive version for non-latest versions',
518 'bitdepth' => ' bitdepth - Adds the bit depth of the version',
523 * Returns the descriptions for the properties provided by getPropertyNames()
525 * @param array $filter List of properties to filter out
529 public static function getPropertyDescriptions( $filter = array(), $modulePrefix = '' ) {
531 array( 'What image information to get:' ),
532 array_values( array_diff_key( self
::getProperties( $modulePrefix ), array_flip( $filter ) ) )
537 * Return the API documentation for the parameters.
538 * @return Array parameter documentation.
540 public function getParamDescription() {
541 $p = $this->getModulePrefix();
543 'prop' => self
::getPropertyDescriptions( array(), $p ),
544 'urlwidth' => array( "If {$p}prop=url is set, a URL to an image scaled to this width will be returned.",
545 'Only the current version of the image can be scaled' ),
546 'urlheight' => "Similar to {$p}urlwidth. Cannot be used without {$p}urlwidth",
547 'urlparam' => array( "A handler specific parameter string. For example, pdf's ",
548 "might use 'page15-100px'. {$p}urlwidth must be used and be consistent with {$p}urlparam" ),
549 'limit' => 'How many image revisions to return',
550 'start' => 'Timestamp to start listing from',
551 'end' => 'Timestamp to stop listing at',
552 'metadataversion' => array( "Version of metadata to use. if 'latest' is specified, use latest version.",
553 "Defaults to '1' for backwards compatibility" ),
554 'continue' => 'If the query response includes a continue value, use it here to get another page of results',
555 'localonly' => 'Look only for files in the local repository',
559 public static function getResultPropertiesFiltered( $filter = array() ) {
561 'timestamp' => array(
562 'timestamp' => 'timestamp'
565 'userhidden' => 'boolean',
570 'userhidden' => 'boolean',
571 'userid' => 'integer',
576 'width' => 'integer',
577 'height' => 'integer',
578 'pagecount' => array(
579 ApiBase
::PROP_TYPE
=> 'integer',
580 ApiBase
::PROP_NULLABLE
=> true
583 'dimensions' => array(
585 'width' => 'integer',
586 'height' => 'integer',
587 'pagecount' => array(
588 ApiBase
::PROP_TYPE
=> 'integer',
589 ApiBase
::PROP_NULLABLE
=> true
593 'commenthidden' => 'boolean',
595 ApiBase
::PROP_TYPE
=> 'string',
596 ApiBase
::PROP_NULLABLE
=> true
599 'parsedcomment' => array(
600 'commenthidden' => 'boolean',
601 'parsedcomment' => array(
602 ApiBase
::PROP_TYPE
=> 'string',
603 ApiBase
::PROP_NULLABLE
=> true
607 'filehidden' => 'boolean',
609 ApiBase
::PROP_TYPE
=> 'string',
610 ApiBase
::PROP_NULLABLE
=> true
612 'thumbwidth' => array(
613 ApiBase
::PROP_TYPE
=> 'integer',
614 ApiBase
::PROP_NULLABLE
=> true
616 'thumbheight' => array(
617 ApiBase
::PROP_TYPE
=> 'integer',
618 ApiBase
::PROP_NULLABLE
=> true
620 'thumberror' => array(
621 ApiBase
::PROP_TYPE
=> 'string',
622 ApiBase
::PROP_NULLABLE
=> true
625 ApiBase
::PROP_TYPE
=> 'string',
626 ApiBase
::PROP_NULLABLE
=> true
628 'descriptionurl' => array(
629 ApiBase
::PROP_TYPE
=> 'string',
630 ApiBase
::PROP_NULLABLE
=> true
634 'filehidden' => 'boolean',
636 ApiBase
::PROP_TYPE
=> 'string',
637 ApiBase
::PROP_NULLABLE
=> true
641 'filehidden' => 'boolean',
643 ApiBase
::PROP_TYPE
=> 'string',
644 ApiBase
::PROP_NULLABLE
=> true
647 'thumbmime' => array(
648 'filehidden' => 'boolean',
649 'thumbmime' => array(
650 ApiBase
::PROP_TYPE
=> 'string',
651 ApiBase
::PROP_NULLABLE
=> true
654 'mediatype' => array(
655 'filehidden' => 'boolean',
656 'mediatype' => array(
657 ApiBase
::PROP_TYPE
=> 'string',
658 ApiBase
::PROP_NULLABLE
=> true
661 'archivename' => array(
662 'filehidden' => 'boolean',
663 'archivename' => array(
664 ApiBase
::PROP_TYPE
=> 'string',
665 ApiBase
::PROP_NULLABLE
=> true
669 'filehidden' => 'boolean',
671 ApiBase
::PROP_TYPE
=> 'integer',
672 ApiBase
::PROP_NULLABLE
=> true
676 return array_diff_key( $props, array_flip( $filter ) );
679 public function getResultProperties() {
680 return self
::getResultPropertiesFiltered();
683 public function getDescription() {
684 return 'Returns image information and upload history';
687 public function getPossibleErrors() {
688 $p = $this->getModulePrefix();
689 return array_merge( parent
::getPossibleErrors(), array(
690 array( 'code' => "{$p}urlwidth", 'info' => "{$p}urlheight cannot be used without {$p}urlwidth" ),
691 array( 'code' => 'urlparam', 'info' => "Invalid value for {$p}urlparam" ),
692 array( 'code' => 'urlparam_no_width', 'info' => "{$p}urlparam requires {$p}urlwidth" ),
693 array( 'code' => 'urlparam_urlwidth_mismatch', 'info' => "The width set in {$p}urlparm doesnt't " .
694 "match the one in {$p}urlwidth" ),
698 public function getExamples() {
700 'api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo',
701 'api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url',
705 public function getHelpUrls() {
706 return 'https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii';
709 public function getVersion() {
710 return __CLASS__
. ': $Id$';