MediaWiki REL1_30
ApiQueryImageInfo.php
Go to the documentation of this file.
1<?php
33 const TRANSFORM_LIMIT = 50;
34 private static $transformCount = 0;
35
36 public function __construct( ApiQuery $query, $moduleName, $prefix = 'ii' ) {
37 // We allow a subclass to override the prefix, to create a related API
38 // module. Some other parts of MediaWiki construct this with a null
39 // $prefix, which used to be ignored when this only took two arguments
40 if ( is_null( $prefix ) ) {
41 $prefix = 'ii';
42 }
43 parent::__construct( $query, $moduleName, $prefix );
44 }
45
46 public function execute() {
48
49 $prop = array_flip( $params['prop'] );
50
51 $scale = $this->getScale( $params );
52
53 $opts = [
54 'version' => $params['metadataversion'],
55 'language' => $params['extmetadatalanguage'],
56 'multilang' => $params['extmetadatamultilang'],
57 'extmetadatafilter' => $params['extmetadatafilter'],
58 'revdelUser' => $this->getUser(),
59 ];
60
61 if ( isset( $params['badfilecontexttitle'] ) ) {
62 $badFileContextTitle = Title::newFromText( $params['badfilecontexttitle'] );
63 if ( !$badFileContextTitle ) {
64 $this->dieUsage( 'Invalid title in badfilecontexttitle parameter', 'invalid-title' );
65 }
66 } else {
67 $badFileContextTitle = false;
68 }
69
70 $pageIds = $this->getPageSet()->getGoodAndMissingTitlesByNamespace();
71 if ( !empty( $pageIds[NS_FILE] ) ) {
72 $titles = array_keys( $pageIds[NS_FILE] );
73 asort( $titles ); // Ensure the order is always the same
74
75 $fromTitle = null;
76 if ( !is_null( $params['continue'] ) ) {
77 $cont = explode( '|', $params['continue'] );
78 $this->dieContinueUsageIf( count( $cont ) != 2 );
79 $fromTitle = strval( $cont[0] );
80 $fromTimestamp = $cont[1];
81 // Filter out any titles before $fromTitle
82 foreach ( $titles as $key => $title ) {
83 if ( $title < $fromTitle ) {
84 unset( $titles[$key] );
85 } else {
86 break;
87 }
88 }
89 }
90
91 $user = $this->getUser();
92 $findTitles = array_map( function ( $title ) use ( $user ) {
93 return [
94 'title' => $title,
95 'private' => $user,
96 ];
97 }, $titles );
98
99 if ( $params['localonly'] ) {
100 $images = RepoGroup::singleton()->getLocalRepo()->findFiles( $findTitles );
101 } else {
102 $images = RepoGroup::singleton()->findFiles( $findTitles );
103 }
104
105 $result = $this->getResult();
106 foreach ( $titles as $title ) {
107 $info = [];
108 $pageId = $pageIds[NS_FILE][$title];
109 $start = $title === $fromTitle ? $fromTimestamp : $params['start'];
110
111 if ( !isset( $images[$title] ) ) {
112 if ( isset( $prop['uploadwarning'] ) || isset( $prop['badfile'] ) ) {
113 // uploadwarning and badfile need info about non-existing files
114 $images[$title] = wfLocalFile( $title );
115 // Doesn't exist, so set an empty image repository
116 $info['imagerepository'] = '';
117 } else {
118 $result->addValue(
119 [ 'query', 'pages', intval( $pageId ) ],
120 'imagerepository', ''
121 );
122 // The above can't fail because it doesn't increase the result size
123 continue;
124 }
125 }
126
128 $img = $images[$title];
129
130 if ( self::getTransformCount() >= self::TRANSFORM_LIMIT ) {
131 if ( count( $pageIds[NS_FILE] ) == 1 ) {
132 // See the 'the user is screwed' comment below
133 $this->setContinueEnumParameter( 'start',
134 $start !== null ? $start : wfTimestamp( TS_ISO_8601, $img->getTimestamp() )
135 );
136 } else {
137 $this->setContinueEnumParameter( 'continue',
138 $this->getContinueStr( $img, $start ) );
139 }
140 break;
141 }
142
143 if ( !isset( $info['imagerepository'] ) ) {
144 $info['imagerepository'] = $img->getRepoName();
145 }
146 if ( isset( $prop['badfile'] ) ) {
147 $info['badfile'] = (bool)wfIsBadImage( $title, $badFileContextTitle );
148 }
149
150 $fit = $result->addValue( [ 'query', 'pages' ], intval( $pageId ), $info );
151 if ( !$fit ) {
152 if ( count( $pageIds[NS_FILE] ) == 1 ) {
153 // The user is screwed. imageinfo can't be solely
154 // responsible for exceeding the limit in this case,
155 // so set a query-continue that just returns the same
156 // thing again. When the violating queries have been
157 // out-continued, the result will get through
158 $this->setContinueEnumParameter( 'start',
159 $start !== null ? $start : wfTimestamp( TS_ISO_8601, $img->getTimestamp() )
160 );
161 } else {
162 $this->setContinueEnumParameter( 'continue',
163 $this->getContinueStr( $img, $start ) );
164 }
165 break;
166 }
167
168 // Check if we can make the requested thumbnail, and get transform parameters.
169 $finalThumbParams = $this->mergeThumbParams( $img, $scale, $params['urlparam'] );
170
171 // Get information about the current version first
172 // Check that the current version is within the start-end boundaries
173 $gotOne = false;
174 if (
175 ( is_null( $start ) || $img->getTimestamp() <= $start ) &&
176 ( is_null( $params['end'] ) || $img->getTimestamp() >= $params['end'] )
177 ) {
178 $gotOne = true;
179
180 $fit = $this->addPageSubItem( $pageId,
181 static::getInfo( $img, $prop, $result,
182 $finalThumbParams, $opts
183 )
184 );
185 if ( !$fit ) {
186 if ( count( $pageIds[NS_FILE] ) == 1 ) {
187 // See the 'the user is screwed' comment above
188 $this->setContinueEnumParameter( 'start',
189 wfTimestamp( TS_ISO_8601, $img->getTimestamp() ) );
190 } else {
191 $this->setContinueEnumParameter( 'continue',
192 $this->getContinueStr( $img ) );
193 }
194 break;
195 }
196 }
197
198 // Now get the old revisions
199 // Get one more to facilitate query-continue functionality
200 $count = ( $gotOne ? 1 : 0 );
201 $oldies = $img->getHistory( $params['limit'] - $count + 1, $start, $params['end'] );
203 foreach ( $oldies as $oldie ) {
204 if ( ++$count > $params['limit'] ) {
205 // We've reached the extra one which shows that there are
206 // additional pages to be had. Stop here...
207 // Only set a query-continue if there was only one title
208 if ( count( $pageIds[NS_FILE] ) == 1 ) {
209 $this->setContinueEnumParameter( 'start',
210 wfTimestamp( TS_ISO_8601, $oldie->getTimestamp() ) );
211 }
212 break;
213 }
214 $fit = self::getTransformCount() < self::TRANSFORM_LIMIT &&
215 $this->addPageSubItem( $pageId,
216 static::getInfo( $oldie, $prop, $result,
217 $finalThumbParams, $opts
218 )
219 );
220 if ( !$fit ) {
221 if ( count( $pageIds[NS_FILE] ) == 1 ) {
222 $this->setContinueEnumParameter( 'start',
223 wfTimestamp( TS_ISO_8601, $oldie->getTimestamp() ) );
224 } else {
225 $this->setContinueEnumParameter( 'continue',
226 $this->getContinueStr( $oldie ) );
227 }
228 break;
229 }
230 }
231 if ( !$fit ) {
232 break;
233 }
234 }
235 }
236 }
237
243 public function getScale( $params ) {
244 if ( $params['urlwidth'] != -1 ) {
245 $scale = [];
246 $scale['width'] = $params['urlwidth'];
247 $scale['height'] = $params['urlheight'];
248 } elseif ( $params['urlheight'] != -1 ) {
249 // Height is specified but width isn't
250 // Don't set $scale['width']; this signals mergeThumbParams() to fill it with the image's width
251 $scale = [];
252 $scale['height'] = $params['urlheight'];
253 } else {
254 if ( $params['urlparam'] ) {
255 // Audio files might not have a width/height.
256 $scale = [];
257 } else {
258 $scale = null;
259 }
260 }
261
262 return $scale;
263 }
264
274 protected function mergeThumbParams( $image, $thumbParams, $otherParams ) {
275 if ( $thumbParams === null ) {
276 // No scaling requested
277 return null;
278 }
279 if ( !isset( $thumbParams['width'] ) && isset( $thumbParams['height'] ) ) {
280 // We want to limit only by height in this situation, so pass the
281 // image's full width as the limiting width. But some file types
282 // don't have a width of their own, so pick something arbitrary so
283 // thumbnailing the default icon works.
284 if ( $image->getWidth() <= 0 ) {
285 $thumbParams['width'] = max( $this->getConfig()->get( 'ThumbLimits' ) );
286 } else {
287 $thumbParams['width'] = $image->getWidth();
288 }
289 }
290
291 if ( !$otherParams ) {
292 $this->checkParameterNormalise( $image, $thumbParams );
293 return $thumbParams;
294 }
295 $p = $this->getModulePrefix();
296
297 $h = $image->getHandler();
298 if ( !$h ) {
299 $this->addWarning( [ 'apiwarn-nothumb-noimagehandler', wfEscapeWikiText( $image->getName() ) ] );
300
301 return $thumbParams;
302 }
303
304 $paramList = $h->parseParamString( $otherParams );
305 if ( !$paramList ) {
306 // Just set a warning (instead of dieUsage), as in many cases
307 // we could still render the image using width and height parameters,
308 // and this type of thing could happen between different versions of
309 // handlers.
310 $this->addWarning( [ 'apiwarn-badurlparam', $p, wfEscapeWikiText( $image->getName() ) ] );
311 $this->checkParameterNormalise( $image, $thumbParams );
312 return $thumbParams;
313 }
314
315 if ( isset( $paramList['width'] ) && isset( $thumbParams['width'] ) ) {
316 if ( intval( $paramList['width'] ) != intval( $thumbParams['width'] ) ) {
317 $this->addWarning(
318 [ 'apiwarn-urlparamwidth', $p, $paramList['width'], $thumbParams['width'] ]
319 );
320 }
321 }
322
323 foreach ( $paramList as $name => $value ) {
324 if ( !$h->validateParam( $name, $value ) ) {
325 $this->dieWithError(
326 [ 'apierror-invalidurlparam', $p, wfEscapeWikiText( $name ), wfEscapeWikiText( $value ) ]
327 );
328 }
329 }
330
331 $finalParams = $thumbParams + $paramList;
332 $this->checkParameterNormalise( $image, $finalParams );
333 return $finalParams;
334 }
335
347 protected function checkParameterNormalise( $image, $finalParams ) {
348 $h = $image->getHandler();
349 if ( !$h ) {
350 return;
351 }
352 // Note: normaliseParams modifies the array in place, but we aren't interested
353 // in the actual normalised version, only if we can actually normalise them,
354 // so we use the functions scope to throw away the normalisations.
355 if ( !$h->normaliseParams( $image, $finalParams ) ) {
356 $this->dieWithError( [ 'apierror-urlparamnormal', wfEscapeWikiText( $image->getName() ) ] );
357 }
358 }
359
375 public static function getInfo( $file, $prop, $result, $thumbParams = null, $opts = false ) {
376 global $wgContLang;
377
378 $anyHidden = false;
379
380 if ( !$opts || is_string( $opts ) ) {
381 $opts = [
382 'version' => $opts ?: 'latest',
383 'language' => $wgContLang,
384 'multilang' => false,
385 'extmetadatafilter' => [],
386 'revdelUser' => null,
387 ];
388 }
389 $version = $opts['version'];
390 $vals = [
391 ApiResult::META_TYPE => 'assoc',
392 ];
393 // Timestamp is shown even if the file is revdelete'd in interface
394 // so do same here.
395 if ( isset( $prop['timestamp'] ) ) {
396 $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $file->getTimestamp() );
397 }
398
399 // Handle external callers who don't pass revdelUser
400 if ( isset( $opts['revdelUser'] ) && $opts['revdelUser'] ) {
401 $revdelUser = $opts['revdelUser'];
402 $canShowField = function ( $field ) use ( $file, $revdelUser ) {
403 return $file->userCan( $field, $revdelUser );
404 };
405 } else {
406 $canShowField = function ( $field ) use ( $file ) {
407 return !$file->isDeleted( $field );
408 };
409 }
410
411 $user = isset( $prop['user'] );
412 $userid = isset( $prop['userid'] );
413
414 if ( $user || $userid ) {
415 if ( $file->isDeleted( File::DELETED_USER ) ) {
416 $vals['userhidden'] = true;
417 $anyHidden = true;
418 }
419 if ( $canShowField( File::DELETED_USER ) ) {
420 if ( $user ) {
421 $vals['user'] = $file->getUser();
422 }
423 if ( $userid ) {
424 $vals['userid'] = $file->getUser( 'id' );
425 }
426 if ( !$file->getUser( 'id' ) ) {
427 $vals['anon'] = true;
428 }
429 }
430 }
431
432 // This is shown even if the file is revdelete'd in interface
433 // so do same here.
434 if ( isset( $prop['size'] ) || isset( $prop['dimensions'] ) ) {
435 $vals['size'] = intval( $file->getSize() );
436 $vals['width'] = intval( $file->getWidth() );
437 $vals['height'] = intval( $file->getHeight() );
438
439 $pageCount = $file->pageCount();
440 if ( $pageCount !== false ) {
441 $vals['pagecount'] = $pageCount;
442 }
443
444 // length as in how many seconds long a video is.
445 $length = $file->getLength();
446 if ( $length ) {
447 // Call it duration, because "length" can be ambiguous.
448 $vals['duration'] = (float)$length;
449 }
450 }
451
452 $pcomment = isset( $prop['parsedcomment'] );
453 $comment = isset( $prop['comment'] );
454
455 if ( $pcomment || $comment ) {
456 if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
457 $vals['commenthidden'] = true;
458 $anyHidden = true;
459 }
460 if ( $canShowField( File::DELETED_COMMENT ) ) {
461 if ( $pcomment ) {
462 $vals['parsedcomment'] = Linker::formatComment(
463 $file->getDescription( File::RAW ), $file->getTitle() );
464 }
465 if ( $comment ) {
466 $vals['comment'] = $file->getDescription( File::RAW );
467 }
468 }
469 }
470
471 $canonicaltitle = isset( $prop['canonicaltitle'] );
472 $url = isset( $prop['url'] );
473 $sha1 = isset( $prop['sha1'] );
474 $meta = isset( $prop['metadata'] );
475 $extmetadata = isset( $prop['extmetadata'] );
476 $commonmeta = isset( $prop['commonmetadata'] );
477 $mime = isset( $prop['mime'] );
478 $mediatype = isset( $prop['mediatype'] );
479 $archive = isset( $prop['archivename'] );
480 $bitdepth = isset( $prop['bitdepth'] );
481 $uploadwarning = isset( $prop['uploadwarning'] );
482
483 if ( $uploadwarning ) {
485 }
486
487 if ( $file->isDeleted( File::DELETED_FILE ) ) {
488 $vals['filehidden'] = true;
489 $anyHidden = true;
490 }
491
492 if ( $anyHidden && $file->isDeleted( File::DELETED_RESTRICTED ) ) {
493 $vals['suppressed'] = true;
494 }
495
496 if ( !$canShowField( File::DELETED_FILE ) ) {
497 // Early return, tidier than indenting all following things one level
498 return $vals;
499 }
500
501 if ( $canonicaltitle ) {
502 $vals['canonicaltitle'] = $file->getTitle()->getPrefixedText();
503 }
504
505 if ( $url ) {
506 if ( !is_null( $thumbParams ) ) {
507 $mto = $file->transform( $thumbParams );
508 self::$transformCount++;
509 if ( $mto && !$mto->isError() ) {
510 $vals['thumburl'] = wfExpandUrl( $mto->getUrl(), PROTO_CURRENT );
511
512 // T25834 - If the URLs are the same, we haven't resized it, so shouldn't give the wanted
513 // thumbnail sizes for the thumbnail actual size
514 if ( $mto->getUrl() !== $file->getUrl() ) {
515 $vals['thumbwidth'] = intval( $mto->getWidth() );
516 $vals['thumbheight'] = intval( $mto->getHeight() );
517 } else {
518 $vals['thumbwidth'] = intval( $file->getWidth() );
519 $vals['thumbheight'] = intval( $file->getHeight() );
520 }
521
522 if ( isset( $prop['thumbmime'] ) && $file->getHandler() ) {
523 list( , $mime ) = $file->getHandler()->getThumbType(
524 $mto->getExtension(), $file->getMimeType(), $thumbParams );
525 $vals['thumbmime'] = $mime;
526 }
527 } elseif ( $mto && $mto->isError() ) {
528 $vals['thumberror'] = $mto->toText();
529 }
530 }
531 $vals['url'] = wfExpandUrl( $file->getFullUrl(), PROTO_CURRENT );
532 $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT );
533
534 $shortDescriptionUrl = $file->getDescriptionShortUrl();
535 if ( $shortDescriptionUrl !== null ) {
536 $vals['descriptionshorturl'] = wfExpandUrl( $shortDescriptionUrl, PROTO_CURRENT );
537 }
538 }
539
540 if ( $sha1 ) {
541 $vals['sha1'] = Wikimedia\base_convert( $file->getSha1(), 36, 16, 40 );
542 }
543
544 if ( $meta ) {
545 MediaWiki\suppressWarnings();
546 $metadata = unserialize( $file->getMetadata() );
547 MediaWiki\restoreWarnings();
548 if ( $metadata && $version !== 'latest' ) {
549 $metadata = $file->convertMetadataVersion( $metadata, $version );
550 }
551 $vals['metadata'] = $metadata ? static::processMetaData( $metadata, $result ) : null;
552 }
553 if ( $commonmeta ) {
554 $metaArray = $file->getCommonMetaArray();
555 $vals['commonmetadata'] = $metaArray ? static::processMetaData( $metaArray, $result ) : [];
556 }
557
558 if ( $extmetadata ) {
559 // Note, this should return an array where all the keys
560 // start with a letter, and all the values are strings.
561 // Thus there should be no issue with format=xml.
562 $format = new FormatMetadata;
563 $format->setSingleLanguage( !$opts['multilang'] );
564 $format->getContext()->setLanguage( $opts['language'] );
565 $extmetaArray = $format->fetchExtendedMetadata( $file );
566 if ( $opts['extmetadatafilter'] ) {
567 $extmetaArray = array_intersect_key(
568 $extmetaArray, array_flip( $opts['extmetadatafilter'] )
569 );
570 }
571 $vals['extmetadata'] = $extmetaArray;
572 }
573
574 if ( $mime ) {
575 $vals['mime'] = $file->getMimeType();
576 }
577
578 if ( $mediatype ) {
579 $vals['mediatype'] = $file->getMediaType();
580 }
581
582 if ( $archive && $file->isOld() ) {
583 $vals['archivename'] = $file->getArchiveName();
584 }
585
586 if ( $bitdepth ) {
587 $vals['bitdepth'] = $file->getBitDepth();
588 }
589
590 return $vals;
591 }
592
600 static function getTransformCount() {
602 }
603
610 public static function processMetaData( $metadata, $result ) {
611 $retval = [];
612 if ( is_array( $metadata ) ) {
613 foreach ( $metadata as $key => $value ) {
614 $r = [
615 'name' => $key,
616 ApiResult::META_BC_BOOLS => [ 'value' ],
617 ];
618 if ( is_array( $value ) ) {
619 $r['value'] = static::processMetaData( $value, $result );
620 } else {
621 $r['value'] = $value;
622 }
623 $retval[] = $r;
624 }
625 }
627
628 return $retval;
629 }
630
631 public function getCacheMode( $params ) {
632 if ( $this->userCanSeeRevDel() ) {
633 return 'private';
634 }
635
636 return 'public';
637 }
638
644 protected function getContinueStr( $img, $start = null ) {
645 if ( $start === null ) {
646 $start = $img->getTimestamp();
647 }
648
649 return $img->getOriginalTitle()->getDBkey() . '|' . $start;
650 }
651
652 public function getAllowedParams() {
653 global $wgContLang;
654
655 return [
656 'prop' => [
658 ApiBase::PARAM_DFLT => 'timestamp|user',
659 ApiBase::PARAM_TYPE => static::getPropertyNames(),
660 ApiBase::PARAM_HELP_MSG_PER_VALUE => static::getPropertyMessages(),
661 ],
662 'limit' => [
663 ApiBase::PARAM_TYPE => 'limit',
668 ],
669 'start' => [
670 ApiBase::PARAM_TYPE => 'timestamp'
671 ],
672 'end' => [
673 ApiBase::PARAM_TYPE => 'timestamp'
674 ],
675 'urlwidth' => [
676 ApiBase::PARAM_TYPE => 'integer',
679 'apihelp-query+imageinfo-param-urlwidth',
681 ],
682 ],
683 'urlheight' => [
684 ApiBase::PARAM_TYPE => 'integer',
686 ],
687 'metadataversion' => [
688 ApiBase::PARAM_TYPE => 'string',
689 ApiBase::PARAM_DFLT => '1',
690 ],
691 'extmetadatalanguage' => [
692 ApiBase::PARAM_TYPE => 'string',
693 ApiBase::PARAM_DFLT => $wgContLang->getCode(),
694 ],
695 'extmetadatamultilang' => [
696 ApiBase::PARAM_TYPE => 'boolean',
697 ApiBase::PARAM_DFLT => false,
698 ],
699 'extmetadatafilter' => [
700 ApiBase::PARAM_TYPE => 'string',
702 ],
703 'urlparam' => [
705 ApiBase::PARAM_TYPE => 'string',
706 ],
707 'badfilecontexttitle' => [
708 ApiBase::PARAM_TYPE => 'string',
709 ],
710 'continue' => [
711 ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
712 ],
713 'localonly' => false,
714 ];
715 }
716
723 public static function getPropertyNames( $filter = [] ) {
724 return array_keys( static::getPropertyMessages( $filter ) );
725 }
726
733 public static function getPropertyMessages( $filter = [] ) {
734 return array_diff_key(
735 [
736 'timestamp' => 'apihelp-query+imageinfo-paramvalue-prop-timestamp',
737 'user' => 'apihelp-query+imageinfo-paramvalue-prop-user',
738 'userid' => 'apihelp-query+imageinfo-paramvalue-prop-userid',
739 'comment' => 'apihelp-query+imageinfo-paramvalue-prop-comment',
740 'parsedcomment' => 'apihelp-query+imageinfo-paramvalue-prop-parsedcomment',
741 'canonicaltitle' => 'apihelp-query+imageinfo-paramvalue-prop-canonicaltitle',
742 'url' => 'apihelp-query+imageinfo-paramvalue-prop-url',
743 'size' => 'apihelp-query+imageinfo-paramvalue-prop-size',
744 'dimensions' => 'apihelp-query+imageinfo-paramvalue-prop-dimensions',
745 'sha1' => 'apihelp-query+imageinfo-paramvalue-prop-sha1',
746 'mime' => 'apihelp-query+imageinfo-paramvalue-prop-mime',
747 'thumbmime' => 'apihelp-query+imageinfo-paramvalue-prop-thumbmime',
748 'mediatype' => 'apihelp-query+imageinfo-paramvalue-prop-mediatype',
749 'metadata' => 'apihelp-query+imageinfo-paramvalue-prop-metadata',
750 'commonmetadata' => 'apihelp-query+imageinfo-paramvalue-prop-commonmetadata',
751 'extmetadata' => 'apihelp-query+imageinfo-paramvalue-prop-extmetadata',
752 'archivename' => 'apihelp-query+imageinfo-paramvalue-prop-archivename',
753 'bitdepth' => 'apihelp-query+imageinfo-paramvalue-prop-bitdepth',
754 'uploadwarning' => 'apihelp-query+imageinfo-paramvalue-prop-uploadwarning',
755 'badfile' => 'apihelp-query+imageinfo-paramvalue-prop-badfile',
756 ],
757 array_flip( $filter )
758 );
759 }
760
768 private static function getProperties( $modulePrefix = '' ) {
769 return [
770 'timestamp' => ' timestamp - Adds timestamp for the uploaded version',
771 'user' => ' user - Adds the user who uploaded the image version',
772 'userid' => ' userid - Add the user ID that uploaded the image version',
773 'comment' => ' comment - Comment on the version',
774 'parsedcomment' => ' parsedcomment - Parse the comment on the version',
775 'canonicaltitle' => ' canonicaltitle - Adds the canonical title of the image file',
776 'url' => ' url - Gives URL to the image and the description page',
777 'size' => ' size - Adds the size of the image in bytes, ' .
778 'its height and its width. Page count and duration are added if applicable',
779 'dimensions' => ' dimensions - Alias for size', // B/C with Allimages
780 'sha1' => ' sha1 - Adds SHA-1 hash for the image',
781 'mime' => ' mime - Adds MIME type of the image',
782 'thumbmime' => ' thumbmime - Adds MIME type of the image thumbnail' .
783 ' (requires url and param ' . $modulePrefix . 'urlwidth)',
784 'mediatype' => ' mediatype - Adds the media type of the image',
785 'metadata' => ' metadata - Lists Exif metadata for the version of the image',
786 'commonmetadata' => ' commonmetadata - Lists file format generic metadata ' .
787 'for the version of the image',
788 'extmetadata' => ' extmetadata - Lists formatted metadata combined ' .
789 'from multiple sources. Results are HTML formatted.',
790 'archivename' => ' archivename - Adds the file name of the archive ' .
791 'version for non-latest versions',
792 'bitdepth' => ' bitdepth - Adds the bit depth of the version',
793 'uploadwarning' => ' uploadwarning - Used by the Special:Upload page to ' .
794 'get information about an existing file. Not intended for use outside MediaWiki core',
795 ];
796 }
797
806 public static function getPropertyDescriptions( $filter = [], $modulePrefix = '' ) {
807 return array_merge(
808 [ 'What image information to get:' ],
809 array_values( array_diff_key( static::getProperties( $modulePrefix ), array_flip( $filter ) ) )
810 );
811 }
812
813 protected function getExamplesMessages() {
814 return [
815 'action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo'
816 => 'apihelp-query+imageinfo-example-simple',
817 'action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&' .
818 'iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url'
819 => 'apihelp-query+imageinfo-example-dated',
820 ];
821 }
822
823 public function getHelpUrls() {
824 return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Imageinfo';
825 }
826}
unserialize( $serialized)
wfLocalFile( $title)
Get an object referring to a locally registered file.
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the 'bad image list'.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition ApiBase.php:520
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right,...
Definition ApiBase.php:100
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:94
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition ApiBase.php:1855
dieContinueUsageIf( $condition)
Die with the 'badcontinue' error.
Definition ApiBase.php:2026
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below.
Definition ApiBase.php:91
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition ApiBase.php:52
extractRequestParams( $parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user,...
Definition ApiBase.php:740
const PARAM_HELP_MSG_PER_VALUE
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg...
Definition ApiBase.php:160
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition ApiBase.php:103
const LIMIT_BIG1
Fast query, standard limit.
Definition ApiBase.php:225
getResult()
Get the result object.
Definition ApiBase.php:632
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Definition ApiBase.php:128
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition ApiBase.php:1779
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition ApiBase.php:227
dieUsage( $description, $errorCode, $httpRespCode=0, $extradata=null)
Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die wit...
Definition ApiBase.php:2660
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition ApiBase.php:55
This is a base class for all Query modules.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
getPageSet()
Get the PageSet object to work on.
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
A query action to get image information and upload history.
checkParameterNormalise( $image, $finalParams)
Verify that the final image parameters can be normalised.
mergeThumbParams( $image, $thumbParams, $otherParams)
Validate and merge scale parameters with handler thumb parameters, give error if invalid.
__construct(ApiQuery $query, $moduleName, $prefix='ii')
getCacheMode( $params)
Get the cache mode for the data generated by this module.
getScale( $params)
From parameters, construct a 'scale' array.
getAllowedParams()
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (ar...
getHelpUrls()
Return links to more detailed help pages about the module.
static getProperties( $modulePrefix='')
Returns array key value pairs of properties and their descriptions.
static getPropertyNames( $filter=[])
Returns all possible parameters to iiprop.
static getPropertyDescriptions( $filter=[], $modulePrefix='')
Returns the descriptions for the properties provided by getPropertyNames()
execute()
Evaluates the parameters, performs the requested query, and sets up the result.
getContinueStr( $img, $start=null)
static getInfo( $file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
static getTransformCount()
Get the count of image transformations performed.
static getPropertyMessages( $filter=[])
Returns messages for all possible parameters to iiprop.
static processMetaData( $metadata, $result)
getExamplesMessages()
Returns usage examples for this module.
This is the main query class.
Definition ApiQuery.php:40
const META_TYPE
Key for the 'type' metadata item.
const META_BC_BOOLS
Key for the 'BC bools' metadata item.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
getUser()
Get the User object.
getConfig()
Get the Config object.
const DELETED_COMMENT
Definition File.php:54
const DELETED_RESTRICTED
Definition File.php:56
const RAW
Definition File.php:71
const DELETED_FILE
Definition File.php:53
const DELETED_USER
Definition File.php:55
Format Image metadata values into a human readable form.
setSingleLanguage( $val)
Trigger only outputting single language for multilanguage fields.
static formatComment( $comment, $title=null, $local=false, $wikiId=null)
This function is called by all recent changes variants, by the page history, and by the user contribu...
Definition Linker.php:1099
static singleton()
Get a RepoGroup instance.
Definition RepoGroup.php:59
static getExistsWarning( $exists)
Formats a result of UploadBase::getExistsWarning as HTML This check is static and can be done pre-upl...
static getExistsWarning( $file)
Helper function that does various existence checks for a file.
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition deferred.txt:11
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the local content language as $wgContLang
Definition design.txt:57
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account incomplete not yet checked for validity & $retval
Definition hooks.txt:266
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check $image
Definition hooks.txt:893
namespace and then decline to actually register it file or subcat img or subcat $title
Definition hooks.txt:962
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition hooks.txt:1610
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition hooks.txt:247
const NS_FILE
Definition Defines.php:71
const PROTO_CURRENT
Definition Defines.php:223
linkcache txt The LinkCache class maintains a list of article titles and the information about whether or not the article exists in the database This is used to mark up links when displaying a page If the same link appears more than once on any page then it only has to be looked up once In most cases link lookups are done in batches with the LinkBatch class or the equivalent in so the link cache is mostly useful for short snippets of parsed and for links in the navigation areas of the skin The link cache was formerly used to track links used in a document for the purposes of updating the link tables This application is now deprecated To create a you can use the following $titles
Definition linkcache.txt:17
if( $ext=='php'|| $ext=='php5') $mime
Definition router.php:59
$params