includes/api/ApiQueryImageInfo.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on July 6, 2007
   6  *
   7  * Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
   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  * A query action to get image information and upload history.
  29  *
  30  * @ingroup API
  31  */
  32 class ApiQueryImageInfo extends ApiQueryBase {
  33
  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 ) ) {
  38                         $prefix = 'ii';
  39                 }
  40                 parent::__construct( $query, $moduleName, $prefix );
  41         }
  42
  43         public function execute() {
  44                 $params = $this->extractRequestParams();
  45
  46                 $prop = array_flip( $params['prop'] );
  47
  48                 $scale = $this->getScale( $params );
  49
  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
  54
  55                         $skip = false;
  56                         if ( !is_null( $params['continue'] ) ) {
  57                                 $skip = true;
  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' );
  62                                 }
  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] );
  69                                         } else {
  70                                                 break;
  71                                         }
  72                                 }
  73                         }
  74
  75                         $result = $this->getResult();
  76                         //search only inside the local repo
  77                         if( $params['localonly'] ) {
  78                                 $images = RepoGroup::singleton()->getLocalRepo()->findFiles( $titles );
  79                         } else {
  80                                 $images = RepoGroup::singleton()->findFiles( $titles );
  81                         }
  82                         foreach ( $images as $img ) {
  83                                 // Skip redirects
  84                                 if ( $img->getOriginalTitle()->isRedirect() ) {
  85                                         continue;
  86                                 }
  87
  88                                 $start = $skip ? $fromTimestamp : $params['start'];
  89                                 $pageId = $pageIds[NS_FILE][ $img->getOriginalTitle()->getDBkey() ];
  90
  91                                 $fit = $result->addValue(
  92                                         array( 'query', 'pages', intval( $pageId ) ),
  93                                         'imagerepository', $img->getRepoName()
  94                                 );
  95                                 if ( !$fit ) {
  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() ) );
 104                                         } else {
 105                                                 $this->setContinueEnumParameter( 'continue',
 106                                                         $this->getContinueStr( $img ) );
 107                                         }
 108                                         break;
 109                                 }
 110
 111                                 // Check if we can make the requested thumbnail, and get transform parameters.
 112                                 $finalThumbParams = $this->mergeThumbParams( $img, $scale, $params['urlparam'] );
 113
 114                                 // Get information about the current version first
 115                                 // Check that the current version is within the start-end boundaries
 116                                 $gotOne = false;
 117                                 if (
 118                                         ( is_null( $start ) || $img->getTimestamp() <= $start ) &&
 119                                         ( is_null( $params['end'] ) || $img->getTimestamp() >= $params['end'] )
 120                                 ) {
 121                                         $gotOne = true;
 122
 123                                         $fit = $this->addPageSubItem( $pageId,
 124                                                 self::getInfo( $img, $prop, $result,
 125                                                         $finalThumbParams, $params['metadataversion'] ) );
 126                                         if ( !$fit ) {
 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() ) );
 131                                                 } else {
 132                                                         $this->setContinueEnumParameter( 'continue',
 133                                                                 $this->getContinueStr( $img ) );
 134                                                 }
 135                                                 break;
 136                                         }
 137                                 }
 138
 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() ) );
 150                                                 }
 151                                                 break;
 152                                         }
 153                                         $fit = $this->addPageSubItem( $pageId,
 154                                                 self::getInfo( $oldie, $prop, $result,
 155                                                         $finalThumbParams, $params['metadataversion'] ) );
 156                                         if ( !$fit ) {
 157                                                 if ( count( $pageIds[NS_FILE] ) == 1 ) {
 158                                                         $this->setContinueEnumParameter( 'start',
 159                                                                 wfTimestamp( TS_ISO_8601, $oldie->getTimestamp() ) );
 160                                                 } else {
 161                                                         $this->setContinueEnumParameter( 'continue',
 162                                                                 $this->getContinueStr( $oldie ) );
 163                                                 }
 164                                                 break;
 165                                         }
 166                                 }
 167                                 if ( !$fit ) {
 168                                         break;
 169                                 }
 170                                 $skip = false;
 171                         }
 172
 173                         $data = $this->getResultData();
 174                         foreach ( $data['query']['pages'] as $pageid => $arr ) {
 175                                 if ( !isset( $arr['imagerepository'] ) ) {
 176                                         $result->addValue(
 177                                                 array( 'query', 'pages', $pageid ),
 178                                                 'imagerepository', ''
 179                                         );
 180                                 }
 181                                 // The above can't fail because it doesn't increase the result size
 182                         }
 183                 }
 184         }
 185
 186         /**
 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
 190          */
 191         public function getScale( $params ) {
 192                 $p = $this->getModulePrefix();
 193
 194                 // Height and width.
 195                 if ( $params['urlheight'] != -1 && $params['urlwidth'] == -1 ) {
 196                         $this->dieUsage( "{$p}urlheight cannot be used without {$p}urlwidth", "{$p}urlwidth" );
 197                 }
 198
 199                 if ( $params['urlwidth'] != -1 ) {
 200                         $scale = array();
 201                         $scale['width'] = $params['urlwidth'];
 202                         $scale['height'] = $params['urlheight'];
 203                 } else {
 204                         $scale = null;
 205                         if ( $params['urlparam'] ) {
 206                                 $this->dieUsage( "{$p}urlparam requires {$p}urlwidth", "urlparam_no_width" );
 207                         }
 208                         return $scale;
 209                 }
 210
 211                 return $scale;
 212         }
 213
 214         /** Validate and merge scale parameters with handler thumb parameters, give error if invalid.
 215          *
 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.
 222          */
 223         protected function mergeThumbParams ( $image, $thumbParams, $otherParams ) {
 224                 if ( !$otherParams ) {
 225                         return $thumbParams;
 226                 }
 227                 $p = $this->getModulePrefix();
 228
 229                 $h = $image->getHandler();
 230                 if ( !$h ) {
 231                         $this->setWarning( 'Could not create thumbnail because ' .
 232                                 $image->getName() . ' does not have an associated image handler' );
 233                         return $thumbParams;
 234                 }
 235
 236                 $paramList = $h->parseParamString( $otherParams );
 237                 if ( !$paramList ) {
 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
 241                         // handlers.
 242                         $this->setWarning( "Could not parse {$p}urlparam for " . $image->getName()
 243                                 . '. Using only width and height' );
 244                         return $thumbParams;
 245                 }
 246
 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" );
 251                         }
 252                 }
 253
 254                 foreach ( $paramList as $name => $value ) {
 255                         if ( !$h->validateParam( $name, $value ) ) {
 256                                 $this->dieUsage( "Invalid value for {$p}urlparam ($name=$value)", "urlparam" );
 257                         }
 258                 }
 259
 260                 return $thumbParams + $paramList;
 261         }
 262
 263         /**
 264          * Get result information for an image revision
 265          *
 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
 272          */
 273         static function getInfo( $file, $prop, $result, $thumbParams = null, $version = 'latest' ) {
 274                 $vals = array();
 275                 // Timestamp is shown even if the file is revdelete'd in interface
 276                 // so do same here.
 277                 if ( isset( $prop['timestamp'] ) ) {
 278                         $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $file->getTimestamp() );
 279                 }
 280
 281                 $user = isset( $prop['user'] );
 282                 $userid = isset( $prop['userid'] );
 283
 284                 if ( $user || $userid ) {
 285                         if ( $file->isDeleted( File::DELETED_USER ) ) {
 286                                 $vals['userhidden'] = '';
 287                         } else {
 288                                 if ( $user ) {
 289                                         $vals['user'] = $file->getUser();
 290                                 }
 291                                 if ( $userid ) {
 292                                         $vals['userid'] = $file->getUser( 'id' );
 293                                 }
 294                                 if ( !$file->getUser( 'id' ) ) {
 295                                         $vals['anon'] = '';
 296                                 }
 297                         }
 298                 }
 299
 300                 // This is shown even if the file is revdelete'd in interface
 301                 // so do same here.
 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() );
 306
 307                         $pageCount = $file->pageCount();
 308                         if ( $pageCount !== false ) {
 309                                 $vals['pagecount'] = $pageCount;
 310                         }
 311                 }
 312
 313                 $pcomment = isset( $prop['parsedcomment'] );
 314                 $comment = isset( $prop['comment'] );
 315
 316                 if ( $pcomment || $comment ) {
 317                         if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
 318                                 $vals['commenthidden'] = '';
 319                         } else {
 320                                 if ( $pcomment ) {
 321                                         $vals['parsedcomment'] = Linker::formatComment(
 322                                                 $file->getDescription(), $file->getTitle() );
 323                                 }
 324                                 if ( $comment ) {
 325                                         $vals['comment'] = $file->getDescription();
 326                                 }
 327                         }
 328                 }
 329
 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'] );
 337
 338                 if ( ( $url || $sha1 || $meta || $mime || $mediatype || $archive || $bitdepth )
 339                                 && $file->isDeleted( File::DELETED_FILE ) ) {
 340                         $vals['filehidden'] = '';
 341
 342                         //Early return, tidier than indenting all following things one level
 343                         return $vals;
 344                 }
 345
 346                 if ( $url ) {
 347                         if ( !is_null( $thumbParams ) ) {
 348                                 $mto = $file->transform( $thumbParams );
 349                                 if ( $mto && !$mto->isError() ) {
 350                                         $vals['thumburl'] = wfExpandUrl( $mto->getUrl(), PROTO_CURRENT );
 351
 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() );
 357                                         } else {
 358                                                 $vals['thumbwidth'] = intval( $file->getWidth() );
 359                                                 $vals['thumbheight'] = intval( $file->getHeight() );
 360                                         }
 361
 362                                         if ( isset( $prop['thumbmime'] ) && $file->getHandler() ) {
 363                                                 list( $ext, $mime ) = $file->getHandler()->getThumbType(
 364                                                         $mto->getExtension(), $file->getMimeType(), $thumbParams );
 365                                                 $vals['thumbmime'] = $mime;
 366                                         }
 367                                 } elseif ( $mto && $mto->isError() ) {
 368                                         $vals['thumberror'] = $mto->toText();
 369                                 }
 370                         }
 371                         $vals['url'] = wfExpandUrl( $file->getFullURL(), PROTO_CURRENT );
 372                         $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT );
 373                 }
 374
 375                 if ( $sha1 ) {
 376                         $vals['sha1'] = wfBaseConvert( $file->getSha1(), 36, 16, 40 );
 377                 }
 378
 379                 if ( $meta ) {
 380                         $metadata = unserialize( $file->getMetadata() );
 381                         if ( $version !== 'latest' ) {
 382                                 $metadata = $file->convertMetadataVersion( $metadata, $version );
 383                         }
 384                         $vals['metadata'] = $metadata ? self::processMetaData( $metadata, $result ) : null;
 385                 }
 386
 387                 if ( $mime ) {
 388                         $vals['mime'] = $file->getMimeType();
 389                 }
 390
 391                 if ( $mediatype ) {
 392                         $vals['mediatype'] = $file->getMediaType();
 393                 }
 394
 395                 if ( $archive && $file->isOld() ) {
 396                         $vals['archivename'] = $file->getArchiveName();
 397                 }
 398
 399                 if ( $bitdepth ) {
 400                         $vals['bitdepth'] = $file->getBitDepth();
 401                 }
 402
 403                 return $vals;
 404         }
 405
 406         /**
 407          *
 408          * @param $metadata Array
 409          * @param $result ApiResult
 410          * @return Array
 411          */
 412         public static function processMetaData( $metadata, $result ) {
 413                 $retval = array();
 414                 if ( is_array( $metadata ) ) {
 415                         foreach ( $metadata as $key => $value ) {
 416                                 $r = array( 'name' => $key );
 417                                 if ( is_array( $value ) ) {
 418                                         $r['value'] = self::processMetaData( $value, $result );
 419                                 } else {
 420                                         $r['value'] = $value;
 421                                 }
 422                                 $retval[] = $r;
 423                         }
 424                 }
 425                 $result->setIndexedTagName( $retval, 'metadata' );
 426                 return $retval;
 427         }
 428
 429         public function getCacheMode( $params ) {
 430                 return 'public';
 431         }
 432
 433         /**
 434          * @param $img File
 435          * @return string
 436          */
 437         protected function getContinueStr( $img ) {
 438                 return $img->getOriginalTitle()->getText() .
 439                         '|' .  $img->getTimestamp();
 440         }
 441
 442         public function getAllowedParams() {
 443                 return array(
 444                         'prop' => array(
 445                                 ApiBase::PARAM_ISMULTI => true,
 446                                 ApiBase::PARAM_DFLT => 'timestamp|user',
 447                                 ApiBase::PARAM_TYPE => self::getPropertyNames()
 448                         ),
 449                         'limit' => array(
 450                                 ApiBase::PARAM_TYPE => 'limit',
 451                                 ApiBase::PARAM_DFLT => 1,
 452                                 ApiBase::PARAM_MIN => 1,
 453                                 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
 454                                 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
 455                         ),
 456                         'start' => array(
 457                                 ApiBase::PARAM_TYPE => 'timestamp'
 458                         ),
 459                         'end' => array(
 460                                 ApiBase::PARAM_TYPE => 'timestamp'
 461                         ),
 462                         'urlwidth' => array(
 463                                 ApiBase::PARAM_TYPE => 'integer',
 464                                 ApiBase::PARAM_DFLT => -1
 465                         ),
 466                         'urlheight' => array(
 467                                 ApiBase::PARAM_TYPE => 'integer',
 468                                 ApiBase::PARAM_DFLT => -1
 469                         ),
 470                         'metadataversion' => array(
 471                                 ApiBase::PARAM_TYPE => 'string',
 472                                 ApiBase::PARAM_DFLT => '1',
 473                         ),
 474                         'urlparam' => array(
 475                                 ApiBase::PARAM_DFLT => '',
 476                                 ApiBase::PARAM_TYPE => 'string',
 477                         ),
 478                         'continue' => null,
 479                         'localonly' => false,
 480                 );
 481         }
 482
 483         /**
 484          * Returns all possible parameters to iiprop
 485          *
 486          * @param array $filter List of properties to filter out
 487          *
 488          * @return Array
 489          */
 490         public static function getPropertyNames( $filter = array() ) {
 491                 return array_diff( array_keys( self::getProperties() ), $filter );
 492         }
 493
 494         /**
 495          * Returns array key value pairs of properties and their descriptions
 496          *
 497          * @return array
 498          */
 499         private static function getProperties( $modulePrefix = '' ) {
 500                 return array(
 501                         'timestamp' =>      ' timestamp     - Adds timestamp for the uploaded version',
 502                         'user' =>           ' user          - Adds the user who uploaded the image version',
 503                         'userid' =>         ' userid        - Add the user ID that uploaded the image version',
 504                         'comment' =>        ' comment       - Comment on the version',
 505                         'parsedcomment' =>  ' parsedcomment - Parse the comment on the version',
 506                         'url' =>            ' url           - Gives URL to the image and the description page',
 507                         'size' =>           ' size          - Adds the size of the image in bytes and the height, width and page count (if applicable)',
 508                         'dimensions' =>     ' dimensions    - Alias for size', // For backwards compatibility with Allimages
 509                         'sha1' =>           ' sha1          - Adds SHA-1 hash for the image',
 510                         'mime' =>           ' mime          - Adds MIME type of the image',
 511                         'thumbmime' =>      ' thumbmime     - Adds MIME type of the image thumbnail' .
 512                                 ' (requires url and param ' . $modulePrefix . 'urlwidth)',
 513                         'mediatype' =>      ' mediatype     - Adds the media type of the image',
 514                         'metadata' =>       ' metadata      - Lists EXIF metadata for the version of the image',
 515                         'archivename' =>    ' archivename   - Adds the file name of the archive version for non-latest versions',
 516                         'bitdepth' =>       ' bitdepth      - Adds the bit depth of the version',
 517                 );
 518         }
 519
 520         /**
 521          * Returns the descriptions for the properties provided by getPropertyNames()
 522          *
 523          * @param array $filter List of properties to filter out
 524          *
 525          * @return array
 526          */
 527         public static function getPropertyDescriptions( $filter = array(), $modulePrefix = '' ) {
 528                 return array_merge(
 529                         array( 'What image information to get:' ),
 530                         array_values( array_diff_key( self::getProperties( $modulePrefix ), array_flip( $filter ) ) )
 531                 );
 532         }
 533
 534         /**
 535          * Return the API documentation for the parameters.
 536          * @return Array parameter documentation.
 537          */
 538         public function getParamDescription() {
 539                 $p = $this->getModulePrefix();
 540                 return array(
 541                         'prop' => self::getPropertyDescriptions( array(), $p ),
 542                         'urlwidth' => array( "If {$p}prop=url is set, a URL to an image scaled to this width will be returned.",
 543                                             'Only the current version of the image can be scaled' ),
 544                         'urlheight' => "Similar to {$p}urlwidth. Cannot be used without {$p}urlwidth",
 545                         'urlparam' => array( "A handler specific parameter string. For example, pdf's ",
 546                                 "might use 'page15-100px'. {$p}urlwidth must be used and be consistent with {$p}urlparam" ),
 547                         'limit' => 'How many image revisions to return',
 548                         'start' => 'Timestamp to start listing from',
 549                         'end' => 'Timestamp to stop listing at',
 550                         'metadataversion' => array( "Version of metadata to use. if 'latest' is specified, use latest version.",
 551                                                 "Defaults to '1' for backwards compatibility" ),
 552                         'continue' => 'If the query response includes a continue value, use it here to get another page of results',
 553                         'localonly' => 'Look only for files in the local repository',
 554                 );
 555         }
 556
 557         public static function getResultPropertiesFiltered( $filter = array() ) {
 558                 $props = array(
 559                         'timestamp' => array(
 560                                 'timestamp' => 'timestamp'
 561                         ),
 562                         'user' => array(
 563                                 'userhidden' => 'boolean',
 564                                 'user' => 'string',
 565                                 'anon' => 'boolean'
 566                         ),
 567                         'userid' => array(
 568                                 'userhidden' => 'boolean',
 569                                 'userid' => 'integer',
 570                                 'anon' => 'boolean'
 571                         ),
 572                         'size' => array(
 573                                 'size' => 'integer',
 574                                 'width' => 'integer',
 575                                 'height' => 'integer',
 576                                 'pagecount' => array(
 577                                         ApiBase::PROP_TYPE => 'integer',
 578                                         ApiBase::PROP_NULLABLE => true
 579                                 )
 580                         ),
 581                         'comment' => array(
 582                                 'commenthidden' => 'boolean',
 583                                 'comment' => array(
 584                                         ApiBase::PROP_TYPE => 'string',
 585                                         ApiBase::PROP_NULLABLE => true
 586                                 )
 587                         ),
 588                         'parsedcomment' => array(
 589                                 'commenthidden' => 'boolean',
 590                                 'parsedcomment' => array(
 591                                         ApiBase::PROP_TYPE => 'string',
 592                                         ApiBase::PROP_NULLABLE => true
 593                                 )
 594                         ),
 595                         'url' => array(
 596                                 'filehidden' => 'boolean',
 597                                 'thumburl' => array(
 598                                         ApiBase::PROP_TYPE => 'string',
 599                                         ApiBase::PROP_NULLABLE => true
 600                                 ),
 601                                 'thumbwidth' => array(
 602                                         ApiBase::PROP_TYPE => 'integer',
 603                                         ApiBase::PROP_NULLABLE => true
 604                                 ),
 605                                 'thumbheight' => array(
 606                                         ApiBase::PROP_TYPE => 'integer',
 607                                         ApiBase::PROP_NULLABLE => true
 608                                 ),
 609                                 'thumberror' => array(
 610                                         ApiBase::PROP_TYPE => 'string',
 611                                         ApiBase::PROP_NULLABLE => true
 612                                 ),
 613                                 'url' => array(
 614                                         ApiBase::PROP_TYPE => 'string',
 615                                         ApiBase::PROP_NULLABLE => true
 616                                 ),
 617                                 'descriptionurl' => array(
 618                                         ApiBase::PROP_TYPE => 'string',
 619                                         ApiBase::PROP_NULLABLE => true
 620                                 )
 621                         ),
 622                         'sha1' => array(
 623                                 'filehidden' => 'boolean',
 624                                 'sha1' => array(
 625                                         ApiBase::PROP_TYPE => 'string',
 626                                         ApiBase::PROP_NULLABLE => true
 627                                 )
 628                         ),
 629                         'mime' => array(
 630                                 'filehidden' => 'boolean',
 631                                 'mime' => array(
 632                                         ApiBase::PROP_TYPE => 'string',
 633                                         ApiBase::PROP_NULLABLE => true
 634                                 )
 635                         ),
 636                         'mediatype' => array(
 637                                 'filehidden' => 'boolean',
 638                                 'mediatype' => array(
 639                                         ApiBase::PROP_TYPE => 'string',
 640                                         ApiBase::PROP_NULLABLE => true
 641                                 )
 642                         ),
 643                         'archivename' => array(
 644                                 'filehidden' => 'boolean',
 645                                 'archivename' => array(
 646                                         ApiBase::PROP_TYPE => 'string',
 647                                         ApiBase::PROP_NULLABLE => true
 648                                 )
 649                         ),
 650                         'bitdepth' => array(
 651                                 'filehidden' => 'boolean',
 652                                 'bitdepth' => array(
 653                                         ApiBase::PROP_TYPE => 'integer',
 654                                         ApiBase::PROP_NULLABLE => true
 655                                 )
 656                         ),
 657                 );
 658                 return array_diff_key( $props, array_flip( $filter ) );
 659         }
 660
 661         public function getResultProperties() {
 662                 return self::getResultPropertiesFiltered();
 663         }
 664
 665         public function getDescription() {
 666                 return 'Returns image information and upload history';
 667         }
 668
 669         public function getPossibleErrors() {
 670                 $p = $this->getModulePrefix();
 671                 return array_merge( parent::getPossibleErrors(), array(
 672                         array( 'code' => "{$p}urlwidth", 'info' => "{$p}urlheight cannot be used without {$p}urlwidth" ),
 673                         array( 'code' => 'urlparam', 'info' => "Invalid value for {$p}urlparam" ),
 674                         array( 'code' => 'urlparam_no_width', 'info' => "{$p}urlparam requires {$p}urlwidth" ),
 675                         array( 'code' => 'urlparam_urlwidth_mismatch', 'info' => "The width set in {$p}urlparm doesnt't " .
 676                                 "match the one in {$p}urlwidth" ),
 677                 ) );
 678         }
 679
 680         public function getExamples() {
 681                 return array(
 682                         'api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo',
 683                         'api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url',
 684                 );
 685         }
 686
 687         public function getHelpUrls() {
 688                 return 'https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii';
 689         }
 690
 691         public function getVersion() {
 692                 return __CLASS__ . ': $Id$';
 693         }
 694 }