MediaWiki  1.28.0
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() {
47  $params = $this->extractRequestParams();
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  $pageIds = $this->getPageSet()->getGoodAndMissingTitlesByNamespace();
62  if ( !empty( $pageIds[NS_FILE] ) ) {
63  $titles = array_keys( $pageIds[NS_FILE] );
64  asort( $titles ); // Ensure the order is always the same
65 
66  $fromTitle = null;
67  if ( !is_null( $params['continue'] ) ) {
68  $cont = explode( '|', $params['continue'] );
69  $this->dieContinueUsageIf( count( $cont ) != 2 );
70  $fromTitle = strval( $cont[0] );
71  $fromTimestamp = $cont[1];
72  // Filter out any titles before $fromTitle
73  foreach ( $titles as $key => $title ) {
74  if ( $title < $fromTitle ) {
75  unset( $titles[$key] );
76  } else {
77  break;
78  }
79  }
80  }
81 
82  $user = $this->getUser();
83  $findTitles = array_map( function ( $title ) use ( $user ) {
84  return [
85  'title' => $title,
86  'private' => $user,
87  ];
88  }, $titles );
89 
90  if ( $params['localonly'] ) {
91  $images = RepoGroup::singleton()->getLocalRepo()->findFiles( $findTitles );
92  } else {
93  $images = RepoGroup::singleton()->findFiles( $findTitles );
94  }
95 
96  $result = $this->getResult();
97  foreach ( $titles as $title ) {
98  $pageId = $pageIds[NS_FILE][$title];
99  $start = $title === $fromTitle ? $fromTimestamp : $params['start'];
100 
101  if ( !isset( $images[$title] ) ) {
102  if ( isset( $prop['uploadwarning'] ) ) {
103  // Uploadwarning needs info about non-existing files
104  $images[$title] = wfLocalFile( $title );
105  } else {
106  $result->addValue(
107  [ 'query', 'pages', intval( $pageId ) ],
108  'imagerepository', ''
109  );
110  // The above can't fail because it doesn't increase the result size
111  continue;
112  }
113  }
114 
116  $img = $images[$title];
117 
118  if ( self::getTransformCount() >= self::TRANSFORM_LIMIT ) {
119  if ( count( $pageIds[NS_FILE] ) == 1 ) {
120  // See the 'the user is screwed' comment below
121  $this->setContinueEnumParameter( 'start',
122  $start !== null ? $start : wfTimestamp( TS_ISO_8601, $img->getTimestamp() )
123  );
124  } else {
125  $this->setContinueEnumParameter( 'continue',
126  $this->getContinueStr( $img, $start ) );
127  }
128  break;
129  }
130 
131  $fit = $result->addValue(
132  [ 'query', 'pages', intval( $pageId ) ],
133  'imagerepository', $img->getRepoName()
134  );
135  if ( !$fit ) {
136  if ( count( $pageIds[NS_FILE] ) == 1 ) {
137  // The user is screwed. imageinfo can't be solely
138  // responsible for exceeding the limit in this case,
139  // so set a query-continue that just returns the same
140  // thing again. When the violating queries have been
141  // out-continued, the result will get through
142  $this->setContinueEnumParameter( 'start',
143  $start !== null ? $start : wfTimestamp( TS_ISO_8601, $img->getTimestamp() )
144  );
145  } else {
146  $this->setContinueEnumParameter( 'continue',
147  $this->getContinueStr( $img, $start ) );
148  }
149  break;
150  }
151 
152  // Check if we can make the requested thumbnail, and get transform parameters.
153  $finalThumbParams = $this->mergeThumbParams( $img, $scale, $params['urlparam'] );
154 
155  // Get information about the current version first
156  // Check that the current version is within the start-end boundaries
157  $gotOne = false;
158  if (
159  ( is_null( $start ) || $img->getTimestamp() <= $start ) &&
160  ( is_null( $params['end'] ) || $img->getTimestamp() >= $params['end'] )
161  ) {
162  $gotOne = true;
163 
164  $fit = $this->addPageSubItem( $pageId,
165  static::getInfo( $img, $prop, $result,
166  $finalThumbParams, $opts
167  )
168  );
169  if ( !$fit ) {
170  if ( count( $pageIds[NS_FILE] ) == 1 ) {
171  // See the 'the user is screwed' comment above
172  $this->setContinueEnumParameter( 'start',
173  wfTimestamp( TS_ISO_8601, $img->getTimestamp() ) );
174  } else {
175  $this->setContinueEnumParameter( 'continue',
176  $this->getContinueStr( $img ) );
177  }
178  break;
179  }
180  }
181 
182  // Now get the old revisions
183  // Get one more to facilitate query-continue functionality
184  $count = ( $gotOne ? 1 : 0 );
185  $oldies = $img->getHistory( $params['limit'] - $count + 1, $start, $params['end'] );
187  foreach ( $oldies as $oldie ) {
188  if ( ++$count > $params['limit'] ) {
189  // We've reached the extra one which shows that there are
190  // additional pages to be had. Stop here...
191  // Only set a query-continue if there was only one title
192  if ( count( $pageIds[NS_FILE] ) == 1 ) {
193  $this->setContinueEnumParameter( 'start',
194  wfTimestamp( TS_ISO_8601, $oldie->getTimestamp() ) );
195  }
196  break;
197  }
198  $fit = self::getTransformCount() < self::TRANSFORM_LIMIT &&
199  $this->addPageSubItem( $pageId,
200  static::getInfo( $oldie, $prop, $result,
201  $finalThumbParams, $opts
202  )
203  );
204  if ( !$fit ) {
205  if ( count( $pageIds[NS_FILE] ) == 1 ) {
206  $this->setContinueEnumParameter( 'start',
207  wfTimestamp( TS_ISO_8601, $oldie->getTimestamp() ) );
208  } else {
209  $this->setContinueEnumParameter( 'continue',
210  $this->getContinueStr( $oldie ) );
211  }
212  break;
213  }
214  }
215  if ( !$fit ) {
216  break;
217  }
218  }
219  }
220  }
221 
227  public function getScale( $params ) {
228  if ( $params['urlwidth'] != -1 ) {
229  $scale = [];
230  $scale['width'] = $params['urlwidth'];
231  $scale['height'] = $params['urlheight'];
232  } elseif ( $params['urlheight'] != -1 ) {
233  // Height is specified but width isn't
234  // Don't set $scale['width']; this signals mergeThumbParams() to fill it with the image's width
235  $scale = [];
236  $scale['height'] = $params['urlheight'];
237  } else {
238  if ( $params['urlparam'] ) {
239  // Audio files might not have a width/height.
240  $scale = [];
241  } else {
242  $scale = null;
243  }
244  }
245 
246  return $scale;
247  }
248 
258  protected function mergeThumbParams( $image, $thumbParams, $otherParams ) {
259  if ( $thumbParams === null ) {
260  // No scaling requested
261  return null;
262  }
263  if ( !isset( $thumbParams['width'] ) && isset( $thumbParams['height'] ) ) {
264  // We want to limit only by height in this situation, so pass the
265  // image's full width as the limiting width. But some file types
266  // don't have a width of their own, so pick something arbitrary so
267  // thumbnailing the default icon works.
268  if ( $image->getWidth() <= 0 ) {
269  $thumbParams['width'] = max( $this->getConfig()->get( 'ThumbLimits' ) );
270  } else {
271  $thumbParams['width'] = $image->getWidth();
272  }
273  }
274 
275  if ( !$otherParams ) {
276  $this->checkParameterNormalise( $image, $thumbParams );
277  return $thumbParams;
278  }
279  $p = $this->getModulePrefix();
280 
281  $h = $image->getHandler();
282  if ( !$h ) {
283  $this->setWarning( 'Could not create thumbnail because ' .
284  $image->getName() . ' does not have an associated image handler' );
285 
286  return $thumbParams;
287  }
288 
289  $paramList = $h->parseParamString( $otherParams );
290  if ( !$paramList ) {
291  // Just set a warning (instead of dieUsage), as in many cases
292  // we could still render the image using width and height parameters,
293  // and this type of thing could happen between different versions of
294  // handlers.
295  $this->setWarning( "Could not parse {$p}urlparam for " . $image->getName()
296  . '. Using only width and height' );
297  $this->checkParameterNormalise( $image, $thumbParams );
298  return $thumbParams;
299  }
300 
301  if ( isset( $paramList['width'] ) && isset( $thumbParams['width'] ) ) {
302  if ( intval( $paramList['width'] ) != intval( $thumbParams['width'] ) ) {
303  $this->setWarning( "Ignoring width value set in {$p}urlparam ({$paramList['width']}) "
304  . "in favor of width value derived from {$p}urlwidth/{$p}urlheight "
305  . "({$thumbParams['width']})" );
306  }
307  }
308 
309  foreach ( $paramList as $name => $value ) {
310  if ( !$h->validateParam( $name, $value ) ) {
311  $this->dieUsage( "Invalid value for {$p}urlparam ($name=$value)", 'urlparam' );
312  }
313  }
314 
315  $finalParams = $thumbParams + $paramList;
316  $this->checkParameterNormalise( $image, $finalParams );
317  return $finalParams;
318  }
319 
331  protected function checkParameterNormalise( $image, $finalParams ) {
332  $h = $image->getHandler();
333  if ( !$h ) {
334  return;
335  }
336  // Note: normaliseParams modifies the array in place, but we aren't interested
337  // in the actual normalised version, only if we can actually normalise them,
338  // so we use the functions scope to throw away the normalisations.
339  if ( !$h->normaliseParams( $image, $finalParams ) ) {
340  $this->dieUsage( 'Could not normalise image parameters for ' .
341  $image->getName(), 'urlparamnormal' );
342  }
343  }
344 
360  public static function getInfo( $file, $prop, $result, $thumbParams = null, $opts = false ) {
362 
363  $anyHidden = false;
364 
365  if ( !$opts || is_string( $opts ) ) {
366  $opts = [
367  'version' => $opts ?: 'latest',
368  'language' => $wgContLang,
369  'multilang' => false,
370  'extmetadatafilter' => [],
371  'revdelUser' => null,
372  ];
373  }
374  $version = $opts['version'];
375  $vals = [
376  ApiResult::META_TYPE => 'assoc',
377  ];
378  // Timestamp is shown even if the file is revdelete'd in interface
379  // so do same here.
380  if ( isset( $prop['timestamp'] ) ) {
381  $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $file->getTimestamp() );
382  }
383 
384  // Handle external callers who don't pass revdelUser
385  if ( isset( $opts['revdelUser'] ) && $opts['revdelUser'] ) {
386  $revdelUser = $opts['revdelUser'];
387  $canShowField = function ( $field ) use ( $file, $revdelUser ) {
388  return $file->userCan( $field, $revdelUser );
389  };
390  } else {
391  $canShowField = function ( $field ) use ( $file ) {
392  return !$file->isDeleted( $field );
393  };
394  }
395 
396  $user = isset( $prop['user'] );
397  $userid = isset( $prop['userid'] );
398 
399  if ( $user || $userid ) {
400  if ( $file->isDeleted( File::DELETED_USER ) ) {
401  $vals['userhidden'] = true;
402  $anyHidden = true;
403  }
404  if ( $canShowField( File::DELETED_USER ) ) {
405  if ( $user ) {
406  $vals['user'] = $file->getUser();
407  }
408  if ( $userid ) {
409  $vals['userid'] = $file->getUser( 'id' );
410  }
411  if ( !$file->getUser( 'id' ) ) {
412  $vals['anon'] = true;
413  }
414  }
415  }
416 
417  // This is shown even if the file is revdelete'd in interface
418  // so do same here.
419  if ( isset( $prop['size'] ) || isset( $prop['dimensions'] ) ) {
420  $vals['size'] = intval( $file->getSize() );
421  $vals['width'] = intval( $file->getWidth() );
422  $vals['height'] = intval( $file->getHeight() );
423 
424  $pageCount = $file->pageCount();
425  if ( $pageCount !== false ) {
426  $vals['pagecount'] = $pageCount;
427  }
428 
429  // length as in how many seconds long a video is.
430  $length = $file->getLength();
431  if ( $length ) {
432  // Call it duration, because "length" can be ambiguous.
433  $vals['duration'] = (float)$length;
434  }
435  }
436 
437  $pcomment = isset( $prop['parsedcomment'] );
438  $comment = isset( $prop['comment'] );
439 
440  if ( $pcomment || $comment ) {
441  if ( $file->isDeleted( File::DELETED_COMMENT ) ) {
442  $vals['commenthidden'] = true;
443  $anyHidden = true;
444  }
445  if ( $canShowField( File::DELETED_COMMENT ) ) {
446  if ( $pcomment ) {
447  $vals['parsedcomment'] = Linker::formatComment(
448  $file->getDescription( File::RAW ), $file->getTitle() );
449  }
450  if ( $comment ) {
451  $vals['comment'] = $file->getDescription( File::RAW );
452  }
453  }
454  }
455 
456  $canonicaltitle = isset( $prop['canonicaltitle'] );
457  $url = isset( $prop['url'] );
458  $sha1 = isset( $prop['sha1'] );
459  $meta = isset( $prop['metadata'] );
460  $extmetadata = isset( $prop['extmetadata'] );
461  $commonmeta = isset( $prop['commonmetadata'] );
462  $mime = isset( $prop['mime'] );
463  $mediatype = isset( $prop['mediatype'] );
464  $archive = isset( $prop['archivename'] );
465  $bitdepth = isset( $prop['bitdepth'] );
466  $uploadwarning = isset( $prop['uploadwarning'] );
467 
468  if ( $uploadwarning ) {
470  }
471 
472  if ( $file->isDeleted( File::DELETED_FILE ) ) {
473  $vals['filehidden'] = true;
474  $anyHidden = true;
475  }
476 
477  if ( $anyHidden && $file->isDeleted( File::DELETED_RESTRICTED ) ) {
478  $vals['suppressed'] = true;
479  }
480 
481  if ( !$canShowField( File::DELETED_FILE ) ) {
482  // Early return, tidier than indenting all following things one level
483  return $vals;
484  }
485 
486  if ( $canonicaltitle ) {
487  $vals['canonicaltitle'] = $file->getTitle()->getPrefixedText();
488  }
489 
490  if ( $url ) {
491  if ( !is_null( $thumbParams ) ) {
492  $mto = $file->transform( $thumbParams );
493  self::$transformCount++;
494  if ( $mto && !$mto->isError() ) {
495  $vals['thumburl'] = wfExpandUrl( $mto->getUrl(), PROTO_CURRENT );
496 
497  // bug 23834 - If the URL's are the same, we haven't resized it, so shouldn't give the wanted
498  // thumbnail sizes for the thumbnail actual size
499  if ( $mto->getUrl() !== $file->getUrl() ) {
500  $vals['thumbwidth'] = intval( $mto->getWidth() );
501  $vals['thumbheight'] = intval( $mto->getHeight() );
502  } else {
503  $vals['thumbwidth'] = intval( $file->getWidth() );
504  $vals['thumbheight'] = intval( $file->getHeight() );
505  }
506 
507  if ( isset( $prop['thumbmime'] ) && $file->getHandler() ) {
508  list( , $mime ) = $file->getHandler()->getThumbType(
509  $mto->getExtension(), $file->getMimeType(), $thumbParams );
510  $vals['thumbmime'] = $mime;
511  }
512  } elseif ( $mto && $mto->isError() ) {
513  $vals['thumberror'] = $mto->toText();
514  }
515  }
516  $vals['url'] = wfExpandUrl( $file->getFullUrl(), PROTO_CURRENT );
517  $vals['descriptionurl'] = wfExpandUrl( $file->getDescriptionUrl(), PROTO_CURRENT );
518 
519  $shortDescriptionUrl = $file->getDescriptionShortUrl();
520  if ( $shortDescriptionUrl !== null ) {
521  $vals['descriptionshorturl'] = wfExpandUrl( $shortDescriptionUrl, PROTO_CURRENT );
522  }
523  }
524 
525  if ( $sha1 ) {
526  $vals['sha1'] = Wikimedia\base_convert( $file->getSha1(), 36, 16, 40 );
527  }
528 
529  if ( $meta ) {
530  MediaWiki\suppressWarnings();
531  $metadata = unserialize( $file->getMetadata() );
532  MediaWiki\restoreWarnings();
533  if ( $metadata && $version !== 'latest' ) {
534  $metadata = $file->convertMetadataVersion( $metadata, $version );
535  }
536  $vals['metadata'] = $metadata ? static::processMetaData( $metadata, $result ) : null;
537  }
538  if ( $commonmeta ) {
539  $metaArray = $file->getCommonMetaArray();
540  $vals['commonmetadata'] = $metaArray ? static::processMetaData( $metaArray, $result ) : [];
541  }
542 
543  if ( $extmetadata ) {
544  // Note, this should return an array where all the keys
545  // start with a letter, and all the values are strings.
546  // Thus there should be no issue with format=xml.
547  $format = new FormatMetadata;
548  $format->setSingleLanguage( !$opts['multilang'] );
549  $format->getContext()->setLanguage( $opts['language'] );
550  $extmetaArray = $format->fetchExtendedMetadata( $file );
551  if ( $opts['extmetadatafilter'] ) {
552  $extmetaArray = array_intersect_key(
553  $extmetaArray, array_flip( $opts['extmetadatafilter'] )
554  );
555  }
556  $vals['extmetadata'] = $extmetaArray;
557  }
558 
559  if ( $mime ) {
560  $vals['mime'] = $file->getMimeType();
561  }
562 
563  if ( $mediatype ) {
564  $vals['mediatype'] = $file->getMediaType();
565  }
566 
567  if ( $archive && $file->isOld() ) {
568  $vals['archivename'] = $file->getArchiveName();
569  }
570 
571  if ( $bitdepth ) {
572  $vals['bitdepth'] = $file->getBitDepth();
573  }
574 
575  return $vals;
576  }
577 
585  static function getTransformCount() {
586  return self::$transformCount;
587  }
588 
595  public static function processMetaData( $metadata, $result ) {
596  $retval = [];
597  if ( is_array( $metadata ) ) {
598  foreach ( $metadata as $key => $value ) {
599  $r = [
600  'name' => $key,
601  ApiResult::META_BC_BOOLS => [ 'value' ],
602  ];
603  if ( is_array( $value ) ) {
604  $r['value'] = static::processMetaData( $value, $result );
605  } else {
606  $r['value'] = $value;
607  }
608  $retval[] = $r;
609  }
610  }
611  ApiResult::setIndexedTagName( $retval, 'metadata' );
612 
613  return $retval;
614  }
615 
616  public function getCacheMode( $params ) {
617  if ( $this->userCanSeeRevDel() ) {
618  return 'private';
619  }
620 
621  return 'public';
622  }
623 
629  protected function getContinueStr( $img, $start = null ) {
630  if ( $start === null ) {
631  $start = $img->getTimestamp();
632  }
633 
634  return $img->getOriginalTitle()->getDBkey() . '|' . $start;
635  }
636 
637  public function getAllowedParams() {
639 
640  return [
641  'prop' => [
642  ApiBase::PARAM_ISMULTI => true,
643  ApiBase::PARAM_DFLT => 'timestamp|user',
644  ApiBase::PARAM_TYPE => static::getPropertyNames(),
645  ApiBase::PARAM_HELP_MSG_PER_VALUE => static::getPropertyMessages(),
646  ],
647  'limit' => [
648  ApiBase::PARAM_TYPE => 'limit',
649  ApiBase::PARAM_DFLT => 1,
650  ApiBase::PARAM_MIN => 1,
653  ],
654  'start' => [
655  ApiBase::PARAM_TYPE => 'timestamp'
656  ],
657  'end' => [
658  ApiBase::PARAM_TYPE => 'timestamp'
659  ],
660  'urlwidth' => [
661  ApiBase::PARAM_TYPE => 'integer',
662  ApiBase::PARAM_DFLT => -1,
664  'apihelp-query+imageinfo-param-urlwidth',
666  ],
667  ],
668  'urlheight' => [
669  ApiBase::PARAM_TYPE => 'integer',
670  ApiBase::PARAM_DFLT => -1
671  ],
672  'metadataversion' => [
673  ApiBase::PARAM_TYPE => 'string',
674  ApiBase::PARAM_DFLT => '1',
675  ],
676  'extmetadatalanguage' => [
677  ApiBase::PARAM_TYPE => 'string',
678  ApiBase::PARAM_DFLT => $wgContLang->getCode(),
679  ],
680  'extmetadatamultilang' => [
681  ApiBase::PARAM_TYPE => 'boolean',
682  ApiBase::PARAM_DFLT => false,
683  ],
684  'extmetadatafilter' => [
685  ApiBase::PARAM_TYPE => 'string',
686  ApiBase::PARAM_ISMULTI => true,
687  ],
688  'urlparam' => [
689  ApiBase::PARAM_DFLT => '',
690  ApiBase::PARAM_TYPE => 'string',
691  ],
692  'continue' => [
693  ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
694  ],
695  'localonly' => false,
696  ];
697  }
698 
705  public static function getPropertyNames( $filter = [] ) {
706  return array_keys( static::getPropertyMessages( $filter ) );
707  }
708 
715  public static function getPropertyMessages( $filter = [] ) {
716  return array_diff_key(
717  [
718  'timestamp' => 'apihelp-query+imageinfo-paramvalue-prop-timestamp',
719  'user' => 'apihelp-query+imageinfo-paramvalue-prop-user',
720  'userid' => 'apihelp-query+imageinfo-paramvalue-prop-userid',
721  'comment' => 'apihelp-query+imageinfo-paramvalue-prop-comment',
722  'parsedcomment' => 'apihelp-query+imageinfo-paramvalue-prop-parsedcomment',
723  'canonicaltitle' => 'apihelp-query+imageinfo-paramvalue-prop-canonicaltitle',
724  'url' => 'apihelp-query+imageinfo-paramvalue-prop-url',
725  'size' => 'apihelp-query+imageinfo-paramvalue-prop-size',
726  'dimensions' => 'apihelp-query+imageinfo-paramvalue-prop-dimensions',
727  'sha1' => 'apihelp-query+imageinfo-paramvalue-prop-sha1',
728  'mime' => 'apihelp-query+imageinfo-paramvalue-prop-mime',
729  'thumbmime' => 'apihelp-query+imageinfo-paramvalue-prop-thumbmime',
730  'mediatype' => 'apihelp-query+imageinfo-paramvalue-prop-mediatype',
731  'metadata' => 'apihelp-query+imageinfo-paramvalue-prop-metadata',
732  'commonmetadata' => 'apihelp-query+imageinfo-paramvalue-prop-commonmetadata',
733  'extmetadata' => 'apihelp-query+imageinfo-paramvalue-prop-extmetadata',
734  'archivename' => 'apihelp-query+imageinfo-paramvalue-prop-archivename',
735  'bitdepth' => 'apihelp-query+imageinfo-paramvalue-prop-bitdepth',
736  'uploadwarning' => 'apihelp-query+imageinfo-paramvalue-prop-uploadwarning',
737  ],
738  array_flip( $filter )
739  );
740  }
741 
749  private static function getProperties( $modulePrefix = '' ) {
750  return [
751  'timestamp' => ' timestamp - Adds timestamp for the uploaded version',
752  'user' => ' user - Adds the user who uploaded the image version',
753  'userid' => ' userid - Add the user ID that uploaded the image version',
754  'comment' => ' comment - Comment on the version',
755  'parsedcomment' => ' parsedcomment - Parse the comment on the version',
756  'canonicaltitle' => ' canonicaltitle - Adds the canonical title of the image file',
757  'url' => ' url - Gives URL to the image and the description page',
758  'size' => ' size - Adds the size of the image in bytes, ' .
759  'its height and its width. Page count and duration are added if applicable',
760  'dimensions' => ' dimensions - Alias for size', // B/C with Allimages
761  'sha1' => ' sha1 - Adds SHA-1 hash for the image',
762  'mime' => ' mime - Adds MIME type of the image',
763  'thumbmime' => ' thumbmime - Adds MIME type of the image thumbnail' .
764  ' (requires url and param ' . $modulePrefix . 'urlwidth)',
765  'mediatype' => ' mediatype - Adds the media type of the image',
766  'metadata' => ' metadata - Lists Exif metadata for the version of the image',
767  'commonmetadata' => ' commonmetadata - Lists file format generic metadata ' .
768  'for the version of the image',
769  'extmetadata' => ' extmetadata - Lists formatted metadata combined ' .
770  'from multiple sources. Results are HTML formatted.',
771  'archivename' => ' archivename - Adds the file name of the archive ' .
772  'version for non-latest versions',
773  'bitdepth' => ' bitdepth - Adds the bit depth of the version',
774  'uploadwarning' => ' uploadwarning - Used by the Special:Upload page to ' .
775  'get information about an existing file. Not intended for use outside MediaWiki core',
776  ];
777  }
778 
787  public static function getPropertyDescriptions( $filter = [], $modulePrefix = '' ) {
788  return array_merge(
789  [ 'What image information to get:' ],
790  array_values( array_diff_key( static::getProperties( $modulePrefix ), array_flip( $filter ) ) )
791  );
792  }
793 
794  protected function getExamplesMessages() {
795  return [
796  'action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo'
797  => 'apihelp-query+imageinfo-example-simple',
798  'action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&' .
799  'iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url'
800  => 'apihelp-query+imageinfo-example-dated',
801  ];
802  }
803 
804  public function getHelpUrls() {
805  return 'https://www.mediawiki.org/wiki/API:Imageinfo';
806  }
807 }
static getExistsWarning($exists)
Formats a result of UploadBase::getExistsWarning as HTML This check is static and can be done pre-upl...
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:179
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
const DELETED_COMMENT
Definition: File.php:53
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:1555
getResult()
Get the result object.
Definition: ApiBase.php:577
addPageSubItem($pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Format Image metadata values into a human readable form.
const PARAM_DFLT
(null|boolean|integer|string) Default value of the parameter.
Definition: ApiBase.php:50
const LIMIT_BIG1
Fast query, standard limit.
Definition: ApiBase.php:177
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 'integer' and 'limit'.
Definition: ApiBase.php:91
This is a base class for all Query modules.
$comment
extractRequestParams($parseLimit=true)
Using getAllowedParams(), this function makes an array of the values provided by the user...
Definition: ApiBase.php:678
$value
const PROTO_CURRENT
Definition: Defines.php:226
const META_TYPE
Key for the 'type' metadata item.
Definition: ApiResult.php:108
getPageSet()
Get the PageSet object to work on.
if($ext== 'php'||$ext== 'php5') $mime
Definition: router.php:65
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:157
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
wfExpandUrl($url, $defaultProto=PROTO_CURRENT)
Expand a potentially local URL to a fully-qualified URL.
const TS_ISO_8601
ISO 8601 format with no timezone: 1986-02-09T20:00:00Z.
Definition: defines.php:28
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:618
static processMetaData($metadata, $result)
const DELETED_FILE
Definition: File.php:52
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 '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. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) '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 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) '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:Associative array mapping language codes to prefixed links of the form"language:title".&$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!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:1934
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
static getProperties($modulePrefix= '')
Returns array key value pairs of properties and their descriptions.
unserialize($serialized)
Definition: ApiMessage.php:102
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
static getPropertyDescriptions($filter=[], $modulePrefix= '')
Returns the descriptions for the properties provided by getPropertyNames()
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
static getPropertyMessages($filter=[])
Returns messages for all possible parameters to iiprop.
static getTransformCount()
Get the count of image transformations performed.
getConfig()
Get the Config object.
static getPropertyNames($filter=[])
Returns all possible parameters to iiprop.
$params
checkParameterNormalise($image, $finalParams)
Verify that the final image parameters can be normalised.
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:953
A query action to get image information and upload history.
const NS_FILE
Definition: Defines.php:62
const PARAM_MAX2
(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.
Definition: ApiBase.php:97
This is the main query class.
Definition: ApiQuery.php:38
setWarning($warning)
Set warning section for this module.
Definition: ApiBase.php:1543
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
getContinueStr($img, $start=null)
dieContinueUsageIf($condition)
Die with the $prefix.
Definition: ApiBase.php:2229
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:1180
const PARAM_HELP_MSG
(string|array|Message) Specify an alternative i18n documentation message for this parameter...
Definition: ApiBase.php:125
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:242
const DELETED_USER
Definition: File.php:54
const DELETED_RESTRICTED
Definition: File.php:55
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
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:465
const RAW
Definition: File.php:70
const PARAM_ISMULTI
(boolean) Accept multiple pipe-separated values for this parameter (e.g.
Definition: ApiBase.php:53
setContinueEnumParameter($paramName, $paramValue)
Set a query-continue value.
const META_BC_BOOLS
Key for the 'BC bools' metadata item.
Definition: ApiResult.php:134
dieUsage($description, $errorCode, $httpRespCode=0, $extradata=null)
Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an...
Definition: ApiBase.php:1574
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:56
setSingleLanguage($val)
Trigger only outputting single language for multilanguage fields.
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:802
__construct(ApiQuery $query, $moduleName, $prefix= 'ii')
$count
static getExistsWarning($file)
Helper function that does various existence checks for a file.
const PARAM_MIN
(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.
Definition: ApiBase.php:100
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:242
static getInfo($file, $prop, $result, $thumbParams=null, $opts=false)
Get result information for an image revision.
getUser()
Get the User object.
getScale($params)
From parameters, construct a 'scale' array.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300