Call Linker methods statically
[lhc/web/wiklou.git] / 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 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( 'ApiQueryBase.php' );
30 }
31
32 /**
33 * A query action to get image information and upload history.
34 *
35 * @ingroup API
36 */
37 class ApiQueryImageInfo extends ApiQueryBase {
38
39 public function __construct( $query, $moduleName, $prefix = 'ii' ) {
40 // We allow a subclass to override the prefix, to create a related API module.
41 // Some other parts of MediaWiki construct this with a null $prefix, which used to be ignored when this only took two arguments
42 if ( is_null( $prefix ) ) {
43 $prefix = 'ii';
44 }
45 parent::__construct( $query, $moduleName, $prefix );
46 }
47
48 public function execute() {
49 $params = $this->extractRequestParams();
50
51 $prop = array_flip( $params['prop'] );
52
53 $scale = $this->getScale( $params );
54
55 $pageIds = $this->getPageSet()->getAllTitlesByNamespace();
56 if ( !empty( $pageIds[NS_FILE] ) ) {
57 $titles = array_keys( $pageIds[NS_FILE] );
58 asort( $titles ); // Ensure the order is always the same
59
60 $skip = false;
61 if ( !is_null( $params['continue'] ) ) {
62 $skip = true;
63 $cont = explode( '|', $params['continue'] );
64 if ( count( $cont ) != 2 ) {
65 $this->dieUsage( 'Invalid continue param. You should pass the original ' .
66 'value returned by the previous query', '_badcontinue' );
67 }
68 $fromTitle = strval( $cont[0] );
69 $fromTimestamp = $cont[1];
70 // Filter out any titles before $fromTitle
71 foreach ( $titles as $key => $title ) {
72 if ( $title < $fromTitle ) {
73 unset( $titles[$key] );
74 } else {
75 break;
76 }
77 }
78 }
79
80 $result = $this->getResult();
81 $images = RepoGroup::singleton()->findFiles( $titles );
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_IMAGE][ $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_IMAGE] ) == 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_IMAGE] ) == 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_IMAGE] ) == 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 substr( $mto->getPath(), strrpos( $mto->getPath(), '.' ) + 1 ),
365 $file->getMimeType(), $thumbParams );
366 $vals['thumbmime'] = $mime;
367 }
368 } elseif ( $mto && $mto->isError() ) {
369 $vals['thumberror'] = $mto->toText();
370 }
371 }
372 $vals['url'] = wfExpandUrl( $file->getFullURL(), PROTO_CURRENT );
373 $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT );
374 }
375
376 if ( $sha1 ) {
377 $vals['sha1'] = wfBaseConvert( $file->getSha1(), 36, 16, 40 );
378 }
379
380 if ( $meta ) {
381 $metadata = unserialize( $file->getMetadata() );
382 if ( $version !== 'latest' ) {
383 $metadata = $file->convertMetadataVersion( $metadata, $version );
384 }
385 $vals['metadata'] = $metadata ? self::processMetaData( $metadata, $result ) : null;
386 }
387
388 if ( $mime ) {
389 $vals['mime'] = $file->getMimeType();
390 }
391
392 if ( $mediatype ) {
393 $vals['mediatype'] = $file->getMediaType();
394 }
395
396 if ( $archive && $file->isOld() ) {
397 $vals['archivename'] = $file->getArchiveName();
398 }
399
400 if ( $bitdepth ) {
401 $vals['bitdepth'] = $file->getBitDepth();
402 }
403
404 return $vals;
405 }
406
407 /**
408 *
409 * @param $metadata Array
410 * @param $result ApiResult
411 * @return Array
412 */
413 public static function processMetaData( $metadata, $result ) {
414 $retval = array();
415 if ( is_array( $metadata ) ) {
416 foreach ( $metadata as $key => $value ) {
417 $r = array( 'name' => $key );
418 if ( is_array( $value ) ) {
419 $r['value'] = self::processMetaData( $value, $result );
420 } else {
421 $r['value'] = $value;
422 }
423 $retval[] = $r;
424 }
425 }
426 $result->setIndexedTagName( $retval, 'metadata' );
427 return $retval;
428 }
429
430 public function getCacheMode( $params ) {
431 return 'public';
432 }
433
434 /**
435 * @param $img File
436 * @return string
437 */
438 private function getContinueStr( $img ) {
439 return $img->getOriginalTitle()->getText() .
440 '|' . $img->getTimestamp();
441 }
442
443 public function getAllowedParams() {
444 return array(
445 'prop' => array(
446 ApiBase::PARAM_ISMULTI => true,
447 ApiBase::PARAM_DFLT => 'timestamp|user',
448 ApiBase::PARAM_TYPE => self::getPropertyNames()
449 ),
450 'limit' => array(
451 ApiBase::PARAM_TYPE => 'limit',
452 ApiBase::PARAM_DFLT => 1,
453 ApiBase::PARAM_MIN => 1,
454 ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
455 ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
456 ),
457 'start' => array(
458 ApiBase::PARAM_TYPE => 'timestamp'
459 ),
460 'end' => array(
461 ApiBase::PARAM_TYPE => 'timestamp'
462 ),
463 'urlwidth' => array(
464 ApiBase::PARAM_TYPE => 'integer',
465 ApiBase::PARAM_DFLT => -1
466 ),
467 'urlheight' => array(
468 ApiBase::PARAM_TYPE => 'integer',
469 ApiBase::PARAM_DFLT => -1
470 ),
471 'metadataversion' => array(
472 ApiBase::PARAM_TYPE => 'string',
473 ApiBase::PARAM_DFLT => '1',
474 ),
475 'urlparam' => array(
476 ApiBase::PARAM_DFLT => '',
477 ApiBase::PARAM_TYPE => 'string',
478 ),
479 'continue' => null,
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() {
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 (requires url)',
512 'mediatype' => ' mediatype - Adds the media type of the image',
513 'metadata' => ' metadata - Lists EXIF metadata for the version of the image',
514 'archivename' => ' archivename - Adds the file name of the archive version for non-latest versions',
515 'bitdepth' => ' bitdepth - Adds the bit depth of the version',
516 );
517 }
518
519 /**
520 * Returns the descriptions for the properties provided by getPropertyNames()
521 *
522 * @param array $filter List of properties to filter out
523 *
524 * @return array
525 */
526 public static function getPropertyDescriptions( $filter = array() ) {
527 return array_merge(
528 array( 'What image information to get:' ),
529 array_values( array_diff_key( self::getProperties(), array_flip( $filter ) ) )
530 );
531 }
532
533 /**
534 * Return the API documentation for the parameters.
535 * @return Array parameter documentation.
536 */
537 public function getParamDescription() {
538 $p = $this->getModulePrefix();
539 return array(
540 'prop' => self::getPropertyDescriptions(),
541 'urlwidth' => array( "If {$p}prop=url is set, a URL to an image scaled to this width will be returned.",
542 'Only the current version of the image can be scaled' ),
543 'urlheight' => "Similar to {$p}urlwidth. Cannot be used without {$p}urlwidth",
544 'urlparam' => array( "A handler specific parameter string. For example, pdf's ",
545 "might use 'page15-100px'. {$p}urlwidth must be used and be consistent with {$p}urlparam" ),
546 'limit' => 'How many image revisions to return',
547 'start' => 'Timestamp to start listing from',
548 'end' => 'Timestamp to stop listing at',
549 'metadataversion' => array( "Version of metadata to use. if 'latest' is specified, use latest version.",
550 "Defaults to '1' for backwards compatibility" ),
551 'continue' => 'If the query response includes a continue value, use it here to get another page of results'
552 );
553 }
554
555 public function getDescription() {
556 return 'Returns image information and upload history';
557 }
558
559 public function getPossibleErrors() {
560 $p = $this->getModulePrefix();
561 return array_merge( parent::getPossibleErrors(), array(
562 array( 'code' => "{$p}urlwidth", 'info' => "{$p}urlheight cannot be used without {$p}urlwidth" ),
563 array( 'code' => 'urlparam', 'info' => "Invalid value for {$p}urlparam" ),
564 array( 'code' => 'urlparam_no_width', 'info' => "{$p}urlparam requires {$p}urlwidth" ),
565 array( 'code' => 'urlparam_urlwidth_mismatch', 'info' => "The width set in {$p}urlparm doesnt't " .
566 "match the one in {$p}urlwidth" ),
567 ) );
568 }
569
570 public function getExamples() {
571 return array(
572 'api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo',
573 'api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url',
574 );
575 }
576
577 public function getHelpUrls() {
578 return 'http://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii';
579 }
580
581 public function getVersion() {
582 return __CLASS__ . ': $Id$';
583 }
584 }