MediaWiki  master
ApiQueryImageInfo.php
Go to the documentation of this file.
1 <?php
24 
31  const TRANSFORM_LIMIT = 50;
32  private static $transformCount = 0;
33 
34  public function __construct( ApiQuery $query, $moduleName, $prefix = 'ii' ) {
35  // We allow a subclass to override the prefix, to create a related API
36  // module. Some other parts of MediaWiki construct this with a null
37  // $prefix, which used to be ignored when this only took two arguments
38  if ( is_null( $prefix ) ) {
39  $prefix = 'ii';
40  }
41  parent::__construct( $query, $moduleName, $prefix );
42  }
43 
44  public function execute() {
45  $params = $this->extractRequestParams();
46 
47  $prop = array_flip( $params['prop'] );
48 
49  $scale = $this->getScale( $params );
50 
51  $opts = [
52  'version' => $params['metadataversion'],
53  'language' => $params['extmetadatalanguage'],
54  'multilang' => $params['extmetadatamultilang'],
55  'extmetadatafilter' => $params['extmetadatafilter'],
56  'revdelUser' => $this->getUser(),
57  ];
58 
59  if ( isset( $params['badfilecontexttitle'] ) ) {
60  $badFileContextTitle = Title::newFromText( $params['badfilecontexttitle'] );
61  if ( !$badFileContextTitle ) {
62  $p = $this->getModulePrefix();
63  $this->dieWithError( [ 'apierror-bad-badfilecontexttitle', $p ], 'invalid-title' );
64  }
65  } else {
66  $badFileContextTitle = false;
67  }
68 
69  $pageIds = $this->getPageSet()->getGoodAndMissingTitlesByNamespace();
70  if ( !empty( $pageIds[NS_FILE] ) ) {
71  $titles = array_keys( $pageIds[NS_FILE] );
72  asort( $titles ); // Ensure the order is always the same
73 
74  $fromTitle = null;
75  if ( !is_null( $params['continue'] ) ) {
76  $cont = explode( '|', $params['continue'] );
77  $this->dieContinueUsageIf( count( $cont ) != 2 );
78  $fromTitle = strval( $cont[0] );
79  $fromTimestamp = $cont[1];
80  // Filter out any titles before $fromTitle
81  foreach ( $titles as $key => $title ) {
82  if ( $title < $fromTitle ) {
83  unset( $titles[$key] );
84  } else {
85  break;
86  }
87  }
88  }
89 
90  $user = $this->getUser();
91  $findTitles = array_map( function ( $title ) use ( $user ) {
92  return [
93  'title' => $title,
94  'private' => $user,
95  ];
96  }, $titles );
97 
98  if ( $params['localonly'] ) {
99  $images = RepoGroup::singleton()->getLocalRepo()->findFiles( $findTitles );
100  } else {
101  $images = RepoGroup::singleton()->findFiles( $findTitles );
102  }
103 
104  $result = $this->getResult();
105  foreach ( $titles as $title ) {
106  $info = [];
107  $pageId = $pageIds[NS_FILE][$title];
108  $start = $title === $fromTitle ? $fromTimestamp : $params['start'];
109 
110  if ( !isset( $images[$title] ) ) {
111  if ( isset( $prop['uploadwarning'] ) || isset( $prop['badfile'] ) ) {
112  // uploadwarning and badfile need info about non-existing files
113  $images[$title] = wfLocalFile( $title );
114  // Doesn't exist, so set an empty image repository
115  $info['imagerepository'] = '';
116  } else {
117  $result->addValue(
118  [ 'query', 'pages', (int)$pageId ],
119  'imagerepository', ''
120  );
121  // The above can't fail because it doesn't increase the result size
122  continue;
123  }
124  }
125 
127  $img = $images[$title];
128 
129  if ( self::getTransformCount() >= self::TRANSFORM_LIMIT ) {
130  if ( count( $pageIds[NS_FILE] ) == 1 ) {
131  // See the 'the user is screwed' comment below
132  $this->setContinueEnumParameter( 'start',
133  $start ?? wfTimestamp( TS_ISO_8601, $img->getTimestamp() )
134  );
135  } else {
136  $this->setContinueEnumParameter( 'continue',
137  $this->getContinueStr( $img, $start ) );
138  }
139  break;
140  }
141 
142  if ( !isset( $info['imagerepository'] ) ) {
143  $info['imagerepository'] = $img->getRepoName();
144  }
145  if ( isset( $prop['badfile'] ) ) {
146  $info['badfile'] = (bool)wfIsBadImage( $title, $badFileContextTitle );
147  }
148 
149  $fit = $result->addValue( [ 'query', 'pages' ], (int)$pageId, $info );
150  if ( !$fit ) {
151  if ( count( $pageIds[NS_FILE] ) == 1 ) {
152  // The user is screwed. imageinfo can't be solely
153  // responsible for exceeding the limit in this case,
154  // so set a query-continue that just returns the same
155  // thing again. When the violating queries have been
156  // out-continued, the result will get through
157  $this->setContinueEnumParameter( 'start',
158  $start ?? wfTimestamp( TS_ISO_8601, $img->getTimestamp() )
159  );
160  } else {
161  $this->setContinueEnumParameter( 'continue',
162  $this->getContinueStr( $img, $start ) );
163  }
164  break;
165  }
166 
167  // Check if we can make the requested thumbnail, and get transform parameters.
168  $finalThumbParams = $this->mergeThumbParams( $img, $scale, $params['urlparam'] );
169 
170  // Get information about the current version first
171  // Check that the current version is within the start-end boundaries
172  $gotOne = false;
173  if (
174  ( is_null( $start ) || $img->getTimestamp() <= $start ) &&
175  ( is_null( $params['end'] ) || $img->getTimestamp() >= $params['end'] )
176  ) {
177  $gotOne = true;
178 
179  $fit = $this->addPageSubItem( $pageId,
180  static::getInfo( $img, $prop, $result,
181  $finalThumbParams, $opts
182  )
183  );
184  if ( !$fit ) {
185  if ( count( $pageIds[NS_FILE] ) == 1 ) {
186  // See the 'the user is screwed' comment above
187  $this->setContinueEnumParameter( 'start',
188  wfTimestamp( TS_ISO_8601, $img->getTimestamp() ) );
189  } else {
190  $this->setContinueEnumParameter( 'continue',
191  $this->getContinueStr( $img ) );
192  }
193  break;
194  }
195  }
196 
197  // Now get the old revisions
198  // Get one more to facilitate query-continue functionality
199  $count = ( $gotOne ? 1 : 0 );
200  $oldies = $img->getHistory( $params['limit'] - $count + 1, $start, $params['end'] );
202  foreach ( $oldies as $oldie ) {
203  if ( ++$count > $params['limit'] ) {
204  // We've reached the extra one which shows that there are
205  // additional pages to be had. Stop here...
206  // Only set a query-continue if there was only one title
207  if ( count( $pageIds[NS_FILE] ) == 1 ) {
208  $this->setContinueEnumParameter( 'start',
209  wfTimestamp( TS_ISO_8601, $oldie->getTimestamp() ) );
210  }
211  break;
212  }
213  $fit = self::getTransformCount() < self::TRANSFORM_LIMIT &&
214  $this->addPageSubItem( $pageId,
215  static::getInfo( $oldie, $prop, $result,
216  $finalThumbParams, $opts
217  )
218  );
219  if ( !$fit ) {
220  if ( count( $pageIds[NS_FILE] ) == 1 ) {
221  $this->setContinueEnumParameter( 'start',
222  wfTimestamp( TS_ISO_8601, $oldie->getTimestamp() ) );
223  } else {
224  $this->setContinueEnumParameter( 'continue',
225  $this->getContinueStr( $oldie ) );
226  }
227  break;
228  }
229  }
230  if ( !$fit ) {
231  break;
232  }
233  }
234  }
235  }
236 
242  public function getScale( $params ) {
243  if ( $params['urlwidth'] != -1 ) {
244  $scale = [];
245  $scale['width'] = $params['urlwidth'];
246  $scale['height'] = $params['urlheight'];
247  } elseif ( $params['urlheight'] != -1 ) {
248  // Height is specified but width isn't
249  // Don't set $scale['width']; this signals mergeThumbParams() to fill it with the image's width
250  $scale = [];
251  $scale['height'] = $params['urlheight'];
252  } elseif ( $params['urlparam'] ) {
253  // Audio files might not have a width/height.
254  $scale = [];
255  } else {
256  $scale = null;
257  }
258 
259  return $scale;
260  }
261 
271  protected function mergeThumbParams( $image, $thumbParams, $otherParams ) {
272  if ( $thumbParams === null ) {
273  // No scaling requested
274  return null;
275  }
276  if ( !isset( $thumbParams['width'] ) && isset( $thumbParams['height'] ) ) {
277  // We want to limit only by height in this situation, so pass the
278  // image's full width as the limiting width. But some file types
279  // don't have a width of their own, so pick something arbitrary so
280  // thumbnailing the default icon works.
281  if ( $image->getWidth() <= 0 ) {
282  $thumbParams['width'] = max( $this->getConfig()->get( 'ThumbLimits' ) );
283  } else {
284  $thumbParams['width'] = $image->getWidth();
285  }
286  }
287 
288  if ( !$otherParams ) {
289  $this->checkParameterNormalise( $image, $thumbParams );
290  return $thumbParams;
291  }
292  $p = $this->getModulePrefix();
293 
294  $h = $image->getHandler();
295  if ( !$h ) {
296  $this->addWarning( [ 'apiwarn-nothumb-noimagehandler', wfEscapeWikiText( $image->getName() ) ] );
297 
298  return $thumbParams;
299  }
300 
301  $paramList = $h->parseParamString( $otherParams );
302  if ( !$paramList ) {
303  // Just set a warning (instead of dieWithError), as in many cases
304  // we could still render the image using width and height parameters,
305  // and this type of thing could happen between different versions of
306  // handlers.
307  $this->addWarning( [ 'apiwarn-badurlparam', $p, wfEscapeWikiText( $image->getName() ) ] );
308  $this->checkParameterNormalise( $image, $thumbParams );
309  return $thumbParams;
310  }
311 
312  if ( isset( $paramList['width'] ) && isset( $thumbParams['width'] ) ) {
313  if ( (int)$paramList['width'] != (int)$thumbParams['width'] ) {
314  $this->addWarning(
315  [ 'apiwarn-urlparamwidth', $p, $paramList['width'], $thumbParams['width'] ]
316  );
317  }
318  }
319 
320  foreach ( $paramList as $name => $value ) {
321  if ( !$h->validateParam( $name, $value ) ) {
322  $this->dieWithError(
323  [ 'apierror-invalidurlparam', $p, wfEscapeWikiText( $name ), wfEscapeWikiText( $value ) ]
324  );
325  }
326  }
327 
328  $finalParams = $thumbParams + $paramList;
329  $this->checkParameterNormalise( $image, $finalParams );
330  return $finalParams;
331  }
332 
344  protected function checkParameterNormalise( $image, $finalParams ) {
345  $h = $image->getHandler();
346  if ( !$h ) {
347  return;
348  }
349  // Note: normaliseParams modifies the array in place, but we aren't interested
350  // in the actual normalised version, only if we can actually normalise them,
351  // so we use the functions scope to throw away the normalisations.
352  if ( !$h->normaliseParams( $image, $finalParams ) ) {
353  $this->dieWithError( [ 'apierror-urlparamnormal', wfEscapeWikiText( $image->getName() ) ] );
354  }
355  }
356 
372  public static function getInfo( $file, $prop, $result, $thumbParams = null, $opts = false ) {
373  $anyHidden = false;
374 
375  if ( !$opts || is_string( $opts ) ) {
376  $opts = [
377  'version' => $opts ?: 'latest',
378  'language' => MediaWikiServices::getInstance()->getContentLanguage(),
379  'multilang' => false,
380  'extmetadatafilter' => [],
381  'revdelUser' => null,
382  ];
383  }
384  $version = $opts['version'];
385  $vals = [
386  ApiResult::META_TYPE => 'assoc',
387  ];
388  // Timestamp is shown even if the file is revdelete'd in interface
389  // so do same here.
390  if ( isset( $prop['timestamp'] ) ) {
391  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $file->getTimestamp() );
392  }
393 
394  // Handle external callers who don't pass revdelUser
395  if ( isset( $opts['revdelUser'] ) && $opts['revdelUser'] ) {
396  $revdelUser = $opts['revdelUser'];
397  $canShowField = function ( $field ) use ( $file, $revdelUser ) {
398  return $file->userCan( $field, $revdelUser );
399  };
400  } else {
401  $canShowField = function ( $field ) use ( $file ) {
402  return !$file->isDeleted( $field );
403  };
404  }
405 
406  $user = isset( $prop['user'] );
407  $userid = isset( $prop['userid'] );
408 
409  if ( $user || $userid ) {
410  if ( $file->isDeleted( File::DELETED_USER ) ) {
411  $vals['userhidden'] = true;
412  $anyHidden = true;
413  }
414  if ( $canShowField( File::DELETED_USER ) ) {
415  if ( $user ) {
416  $vals['user'] = $file->getUser();
417  }
418  if ( $userid ) {
419  $vals['userid'] = $file->getUser( 'id' );
420  }
421  if ( !$file->getUser( 'id' ) ) {
422  $vals['anon'] = true;
423  }
424  }
425  }
426 
427  // This is shown even if the file is revdelete'd in interface
428  // so do same here.
429  if ( isset( $prop['size'] ) || isset( $prop['dimensions'] ) ) {
430  $vals['size'] = (int)$file->getSize();
431  $vals['width'] = (int)$file->getWidth();
432  $vals['height'] = (int)$file->getHeight();
433 
434  $pageCount = $file->pageCount();
435  if ( $pageCount !== false ) {
436  $vals['pagecount'] = $pageCount;
437  }
438 
439  // length as in how many seconds long a video is.
440  $length = $file->getLength();
441  if ( $length ) {
442  // Call it duration, because "length" can be ambiguous.
443  $vals['duration'] = (float)$length;
444  }
445  }
446 
447  $pcomment = isset( $prop['parsedcomment'] );
448  $comment = isset( $prop['comment'] );
449 
450  if ( $pcomment || $comment ) {
451  if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
452  $vals['commenthidden'] = true;
453  $anyHidden = true;
454  }
455  if ( $canShowField( File::DELETED_COMMENT ) ) {
456  if ( $pcomment ) {
457  $vals['parsedcomment'] = Linker::formatComment(
458  $file->getDescription( File::RAW ), $file->getTitle() );
459  }
460  if ( $comment ) {
461  $vals['comment'] = $file->getDescription( File::RAW );
462  }
463  }
464  }
465 
466  $canonicaltitle = isset( $prop['canonicaltitle'] );
467  $url = isset( $prop['url'] );
468  $sha1 = isset( $prop['sha1'] );
469  $meta = isset( $prop['metadata'] );
470  $extmetadata = isset( $prop['extmetadata'] );
471  $commonmeta = isset( $prop['commonmetadata'] );
472  $mime = isset( $prop['mime'] );
473  $mediatype = isset( $prop['mediatype'] );
474  $archive = isset( $prop['archivename'] );
475  $bitdepth = isset( $prop['bitdepth'] );
476  $uploadwarning = isset( $prop['uploadwarning'] );
477 
478  if ( $uploadwarning ) {
480  }
481 
482  if ( $file->isDeleted( File::DELETED_FILE ) ) {
483  $vals['filehidden'] = true;
484  $anyHidden = true;
485  }
486 
487  if ( $anyHidden && $file->isDeleted( File::DELETED_RESTRICTED ) ) {
488  $vals['suppressed'] = true;
489  }
490 
491  if ( !$canShowField( File::DELETED_FILE ) ) {
492  // Early return, tidier than indenting all following things one level
493  return $vals;
494  }
495 
496  if ( $canonicaltitle ) {
497  $vals['canonicaltitle'] = $file->getTitle()->getPrefixedText();
498  }
499 
500  if ( $url ) {
501  if ( $file->exists() ) {
502  if ( !is_null( $thumbParams ) ) {
503  $mto = $file->transform( $thumbParams );
504  self::$transformCount++;
505  if ( $mto && !$mto->isError() ) {
506  $vals['thumburl'] = wfExpandUrl( $mto->getUrl(), PROTO_CURRENT );
507 
508  // T25834 - If the URLs are the same, we haven't resized it, so shouldn't give the wanted
509  // thumbnail sizes for the thumbnail actual size
510  if ( $mto->getUrl() !== $file->getUrl() ) {
511  $vals['thumbwidth'] = (int)$mto->getWidth();
512  $vals['thumbheight'] = (int)$mto->getHeight();
513  } else {
514  $vals['thumbwidth'] = (int)$file->getWidth();
515  $vals['thumbheight'] = (int)$file->getHeight();
516  }
517 
518  if ( isset( $prop['thumbmime'] ) && $file->getHandler() ) {
519  list( , $mime ) = $file->getHandler()->getThumbType(
520  $mto->getExtension(), $file->getMimeType(), $thumbParams );
521  $vals['thumbmime'] = $mime;
522  }
523  } elseif ( $mto && $mto->isError() ) {
524  $vals['thumberror'] = $mto->toText();
525  }
526  }
527  $vals['url'] = wfExpandUrl( $file->getFullUrl(), PROTO_CURRENT );
528  } else {
529  $vals['filemissing'] = true;
530  }
531  $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT );
532 
533  $shortDescriptionUrl = $file->getDescriptionShortUrl();
534  if ( $shortDescriptionUrl !== null ) {
535  $vals['descriptionshorturl'] = wfExpandUrl( $shortDescriptionUrl, PROTO_CURRENT );
536  }
537  }
538 
539  if ( $sha1 ) {
540  $vals['sha1'] = Wikimedia\base_convert( $file->getSha1(), 36, 16, 40 );
541  }
542 
543  if ( $meta ) {
544  Wikimedia\suppressWarnings();
545  $metadata = unserialize( $file->getMetadata() );
546  Wikimedia\restoreWarnings();
547  if ( $metadata && $version !== 'latest' ) {
548  $metadata = $file->convertMetadataVersion( $metadata, $version );
549  }
550  $vals['metadata'] = $metadata ? static::processMetaData( $metadata, $result ) : null;
551  }
552  if ( $commonmeta ) {
553  $metaArray = $file->getCommonMetaArray();
554  $vals['commonmetadata'] = $metaArray ? static::processMetaData( $metaArray, $result ) : [];
555  }
556 
557  if ( $extmetadata ) {
558  // Note, this should return an array where all the keys
559  // start with a letter, and all the values are strings.
560  // Thus there should be no issue with format=xml.
561  $format = new FormatMetadata;
562  $format->setSingleLanguage( !$opts['multilang'] );
563  $format->getContext()->setLanguage( $opts['language'] );
564  $extmetaArray = $format->fetchExtendedMetadata( $file );
565  if ( $opts['extmetadatafilter'] ) {
566  $extmetaArray = array_intersect_key(
567  $extmetaArray, array_flip( $opts['extmetadatafilter'] )
568  );
569  }
570  $vals['extmetadata'] = $extmetaArray;
571  }
572 
573  if ( $mime ) {
574  $vals['mime'] = $file->getMimeType();
575  }
576 
577  if ( $mediatype ) {
578  $vals['mediatype'] = $file->getMediaType();
579  }
580 
581  if ( $archive && $file->isOld() ) {
582  $vals['archivename'] = $file->getArchiveName();
583  }
584 
585  if ( $bitdepth ) {
586  $vals['bitdepth'] = $file->getBitDepth();
587  }
588 
589  return $vals;
590  }
591 
599  static function getTransformCount() {
600  return self::$transformCount;
601  }
602 
609  public static function processMetaData( $metadata, $result ) {
610  $retval = [];
611  if ( is_array( $metadata ) ) {
612  foreach ( $metadata as $key => $value ) {
613  $r = [
614  'name' => $key,
615  ApiResult::META_BC_BOOLS => [ 'value' ],
616  ];
617  if ( is_array( $value ) ) {
618  $r['value'] = static::processMetaData( $value, $result );
619  } else {
620  $r['value'] = $value;
621  }
622  $retval[] = $r;
623  }
624  }
625  ApiResult::setIndexedTagName( $retval, 'metadata' );
626 
627  return $retval;
628  }
629 
630  public function getCacheMode( $params ) {
631  if ( $this->userCanSeeRevDel() ) {
632  return 'private';
633  }
634 
635  return 'public';
636  }
637 
643  protected function getContinueStr( $img, $start = null ) {
644  if ( $start === null ) {
645  $start = $img->getTimestamp();
646  }
647 
648  return $img->getOriginalTitle()->getDBkey() . '|' . $start;
649  }
650 
651  public function getAllowedParams() {
652  return [
653  'prop' => [
654  ApiBase::PARAM_ISMULTI => true,
655  ApiBase::PARAM_DFLT => 'timestamp|user',
656  ApiBase::PARAM_TYPE => static::getPropertyNames(),
657  ApiBase::PARAM_HELP_MSG_PER_VALUE => static::getPropertyMessages(),
658  ],
659  'limit' => [
660  ApiBase::PARAM_TYPE => 'limit',
661  ApiBase::PARAM_DFLT => 1,
662  ApiBase::PARAM_MIN => 1,
665  ],
666  'start' => [
667  ApiBase::PARAM_TYPE => 'timestamp'
668  ],
669  'end' => [
670  ApiBase::PARAM_TYPE => 'timestamp'
671  ],
672  'urlwidth' => [
673  ApiBase::PARAM_TYPE => 'integer',
674  ApiBase::PARAM_DFLT => -1,
676  'apihelp-query+imageinfo-param-urlwidth',
677  self::TRANSFORM_LIMIT,
678  ],
679  ],
680  'urlheight' => [
681  ApiBase::PARAM_TYPE => 'integer',
682  ApiBase::PARAM_DFLT => -1
683  ],
684  'metadataversion' => [
685  ApiBase::PARAM_TYPE => 'string',
686  ApiBase::PARAM_DFLT => '1',
687  ],
688  'extmetadatalanguage' => [
689  ApiBase::PARAM_TYPE => 'string',
691  MediaWikiServices::getInstance()->getContentLanguage()->getCode(),
692  ],
693  'extmetadatamultilang' => [
694  ApiBase::PARAM_TYPE => 'boolean',
695  ApiBase::PARAM_DFLT => false,
696  ],
697  'extmetadatafilter' => [
698  ApiBase::PARAM_TYPE => 'string',
699  ApiBase::PARAM_ISMULTI => true,
700  ],
701  'urlparam' => [
702  ApiBase::PARAM_DFLT => '',
703  ApiBase::PARAM_TYPE => 'string',
704  ],
705  'badfilecontexttitle' => [
706  ApiBase::PARAM_TYPE => 'string',
707  ],
708  'continue' => [
709  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
710  ],
711  'localonly' => false,
712  ];
713  }
714 
721  public static function getPropertyNames( $filter = [] ) {
722  return array_keys( static::getPropertyMessages( $filter ) );
723  }
724 
731  public static function getPropertyMessages( $filter = [] ) {
732  return array_diff_key(
733  [
734  'timestamp' => 'apihelp-query+imageinfo-paramvalue-prop-timestamp',
735  'user' => 'apihelp-query+imageinfo-paramvalue-prop-user',
736  'userid' => 'apihelp-query+imageinfo-paramvalue-prop-userid',
737  'comment' => 'apihelp-query+imageinfo-paramvalue-prop-comment',
738  'parsedcomment' => 'apihelp-query+imageinfo-paramvalue-prop-parsedcomment',
739  'canonicaltitle' => 'apihelp-query+imageinfo-paramvalue-prop-canonicaltitle',
740  'url' => 'apihelp-query+imageinfo-paramvalue-prop-url',
741  'size' => 'apihelp-query+imageinfo-paramvalue-prop-size',
742  'dimensions' => 'apihelp-query+imageinfo-paramvalue-prop-dimensions',
743  'sha1' => 'apihelp-query+imageinfo-paramvalue-prop-sha1',
744  'mime' => 'apihelp-query+imageinfo-paramvalue-prop-mime',
745  'thumbmime' => 'apihelp-query+imageinfo-paramvalue-prop-thumbmime',
746  'mediatype' => 'apihelp-query+imageinfo-paramvalue-prop-mediatype',
747  'metadata' => 'apihelp-query+imageinfo-paramvalue-prop-metadata',
748  'commonmetadata' => 'apihelp-query+imageinfo-paramvalue-prop-commonmetadata',
749  'extmetadata' => 'apihelp-query+imageinfo-paramvalue-prop-extmetadata',
750  'archivename' => 'apihelp-query+imageinfo-paramvalue-prop-archivename',
751  'bitdepth' => 'apihelp-query+imageinfo-paramvalue-prop-bitdepth',
752  'uploadwarning' => 'apihelp-query+imageinfo-paramvalue-prop-uploadwarning',
753  'badfile' => 'apihelp-query+imageinfo-paramvalue-prop-badfile',
754  ],
755  array_flip( $filter )
756  );
757  }
758 
766  private static function getProperties( $modulePrefix = '' ) {
767  return [
768  'timestamp' => ' timestamp - Adds timestamp for the uploaded version',
769  'user' => ' user - Adds the user who uploaded the image version',
770  'userid' => ' userid - Add the user ID that uploaded the image version',
771  'comment' => ' comment - Comment on the version',
772  'parsedcomment' => ' parsedcomment - Parse the comment on the version',
773  'canonicaltitle' => ' canonicaltitle - Adds the canonical title of the image file',
774  'url' => ' url - Gives URL to the image and the description page',
775  'size' => ' size - Adds the size of the image in bytes, ' .
776  'its height and its width. Page count and duration are added if applicable',
777  'dimensions' => ' dimensions - Alias for size', // B/C with Allimages
778  'sha1' => ' sha1 - Adds SHA-1 hash for the image',
779  'mime' => ' mime - Adds MIME type of the image',
780  'thumbmime' => ' thumbmime - Adds MIME type of the image thumbnail' .
781  ' (requires url and param ' . $modulePrefix . 'urlwidth)',
782  'mediatype' => ' mediatype - Adds the media type of the image',
783  'metadata' => ' metadata - Lists Exif metadata for the version of the image',
784  'commonmetadata' => ' commonmetadata - Lists file format generic metadata ' .
785  'for the version of the image',
786  'extmetadata' => ' extmetadata - Lists formatted metadata combined ' .
787  'from multiple sources. Results are HTML formatted.',
788  'archivename' => ' archivename - Adds the file name of the archive ' .
789  'version for non-latest versions',
790  'bitdepth' => ' bitdepth - Adds the bit depth of the version',
791  'uploadwarning' => ' uploadwarning - Used by the Special:Upload page to ' .
792  'get information about an existing file. Not intended for use outside MediaWiki core',
793  ];
794  }
795 
804  public static function getPropertyDescriptions( $filter = [], $modulePrefix = '' ) {
805  return array_merge(
806  [ 'What image information to get:' ],
807  array_values( array_diff_key( static::getProperties( $modulePrefix ), array_flip( $filter ) ) )
808  );
809  }
810 
811  protected function getExamplesMessages() {
812  return [
813  'action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo'
814  => 'apihelp-query+imageinfo-example-simple',
815  'action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&' .
816  'iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url'
817  => 'apihelp-query+imageinfo-example-dated',
818  ];
819  }
820 
821  public function getHelpUrls() {
822  return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Imageinfo';
823  }
824 }
const PARAM_TYPE
(string|string[]) Either an array of allowed value strings, or a string type as described below...
Definition: ApiBase.php:88
const LIMIT_BIG2
Fast query, apihighlimits limit.
Definition: ApiBase.php:255
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
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking, formatting, etc.
const DELETED_COMMENT
Definition: File.php:55
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:1585
getResult()
Get the result object.
Definition: ApiBase.php:633
static getPropertyNames( $filter=[])
Returns all possible parameters to iiprop.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition: router.php:42
Format Image metadata values into a human readable form.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:49
wfIsBadImage( $name, $contextTitle=false, $blacklist=null)
Determine if an image exists on the &#39;bad image list&#39;.
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:253
wfExpandUrl( $url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
mergeThumbParams( $image, $thumbParams, $otherParams)
Validate and merge scale parameters with handler thumb parameters, give error if invalid.
const PARAM_MAX
(integer) Max value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:91
This is a base class for all Query modules.
$value
dieWithError( $msg, $code=null, $data=null, $httpCode=null)
Abort execution with an error.
Definition: ApiBase.php:1991
const PROTO_CURRENT
Definition: Defines.php:222
extractRequestParams( $options=[])
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:744
const META_TYPE
Key for the &#39;type&#39; metadata item.
Definition: ApiResult.php:110
getPageSet()
Get the PageSet object to work on.
static getExistsWarning( $file)
Helper function that does various existence checks for a file.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
__construct(ApiQuery $query, $moduleName, $prefix='ii')
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:158
wfLocalFile( $title)
Get an object referring to a locally registered file.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Definition: ApiResult.php:616
const DELETED_FILE
Definition: File.php:54
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED since 1.28! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1980
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
wfTimestamp( $outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
checkParameterNormalise( $image, $finalParams)
Verify that the final image parameters can be normalised.
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:1123
static getProperties( $modulePrefix='')
Returns array key value pairs of properties and their descriptions.
static getInfo( $file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
static processMetaData( $metadata, $result)
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:61
dieContinueUsageIf( $condition)
Die with the &#39;badcontinue&#39; error.
Definition: ApiBase.php:2206
static getTransformCount()
Get the count of image transformations performed.
static getPropertyDescriptions( $filter=[], $modulePrefix='')
Returns the descriptions for the properties provided by getPropertyNames()
$params
unserialize( $serialized)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:780
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:925
$filter
A query action to get image information and upload history.
const NS_FILE
Definition: Defines.php:70
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE &#39;limit&#39;.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:36
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
setSingleLanguage( $val)
Trigger only outputting single language for multilanguage fields.
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
const DELETED_USER
Definition: File.php:56
const DELETED_RESTRICTED
Definition: File.php:57
static getExistsWarning( $exists)
Formats a result of UploadBase::getExistsWarning as HTML This check is static and can be done pre-upl...
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
getScale( $params)
From parameters, construct a &#39;scale&#39; array.
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
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
Definition: ApiBase.php:521
const RAW
Definition: File.php:72
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:780
addWarning( $msg, $code=null, $data=null)
Add a warning for this module.
Definition: ApiBase.php:1910
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:52
const META_BC_BOOLS
Key for the &#39;BC bools&#39; metadata item.
Definition: ApiResult.php:136
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static getPropertyMessages( $filter=[])
Returns messages for all possible parameters to iiprop.
getContinueStr( $img, $start=null)
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE &#39;integer&#39; and &#39;limit&#39;.
Definition: ApiBase.php:100
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:319
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.