MediaWiki  master
GIFHandler.php
Go to the documentation of this file.
1 <?php
26 use Wikimedia\RequestTimeout\TimeoutException;
27 
33 class GIFHandler extends BitmapHandler {
37  private const BROKEN_FILE = '0';
38 
39  public function getSizeAndMetadata( $state, $filename ) {
40  try {
41  $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
42  } catch ( TimeoutException $e ) {
43  throw $e;
44  } catch ( Exception $e ) {
45  // Broken file?
46  wfDebug( __METHOD__ . ': ' . $e->getMessage() );
47 
48  return [ 'metadata' => [ '_error' => self::BROKEN_FILE ] ];
49  }
50 
51  return [
52  'width' => $parsedGIFMetadata['width'],
53  'height' => $parsedGIFMetadata['height'],
54  'bits' => $parsedGIFMetadata['bits'],
55  'metadata' => array_diff_key(
56  $parsedGIFMetadata,
57  [ 'width' => true, 'height' => true, 'bits' => true ]
58  )
59  ];
60  }
61 
67  public function formatMetadata( $image, $context = false ) {
68  $meta = $this->getCommonMetaArray( $image );
69  if ( !$meta ) {
70  return false;
71  }
72 
73  return $this->formatMetadataHelper( $meta, $context );
74  }
75 
81  public function getCommonMetaArray( File $image ) {
82  $meta = $image->getMetadataArray();
83  if ( !isset( $meta['metadata'] ) ) {
84  return [];
85  }
86  unset( $meta['metadata']['_MW_GIF_VERSION'] );
87 
88  return $meta['metadata'];
89  }
90 
97  public function getImageArea( $image ) {
98  $metadata = $image->getMetadataArray();
99  if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 0 ) {
100  return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
101  }
102  return $image->getWidth() * $image->getHeight();
103  }
104 
109  public function isAnimatedImage( $image ) {
110  $metadata = $image->getMetadataArray();
111  if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 1 ) {
112  return true;
113  }
114 
115  return false;
116  }
117 
123  public function canAnimateThumbnail( $file ) {
124  $maxAnimatedGifArea = MediaWikiServices::getInstance()->getMainConfig()
125  ->get( MainConfigNames::MaxAnimatedGifArea );
126 
127  return $this->getImageArea( $file ) <= $maxAnimatedGifArea;
128  }
129 
130  public function getMetadataType( $image ) {
131  return 'parsed-gif';
132  }
133 
134  public function isFileMetadataValid( $image ) {
135  $data = $image->getMetadataArray();
136  if ( $data === [ '_error' => self::BROKEN_FILE ] ) {
137  // Do not repetitively regenerate metadata on broken file.
138  return self::METADATA_GOOD;
139  }
140 
141  if ( !$data || isset( $data['_error'] ) ) {
142  wfDebug( __METHOD__ . " invalid GIF metadata" );
143 
144  return self::METADATA_BAD;
145  }
146 
147  if ( !isset( $data['metadata']['_MW_GIF_VERSION'] )
148  || $data['metadata']['_MW_GIF_VERSION'] !== GIFMetadataExtractor::VERSION
149  ) {
150  wfDebug( __METHOD__ . " old but compatible GIF metadata" );
151 
153  }
154 
155  return self::METADATA_GOOD;
156  }
157 
162  public function getLongDesc( $image ) {
163  global $wgLang;
164 
165  $original = parent::getLongDesc( $image );
166 
167  $metadata = $image->getMetadataArray();
168 
169  if ( !$metadata || isset( $metadata['_error'] ) || $metadata['frameCount'] <= 0 ) {
170  return $original;
171  }
172 
173  /* Preserve original image info string, but strip the last char ')' so we can add even more */
174  $info = [];
175  $info[] = $original;
176 
177  if ( $metadata['looped'] ) {
178  $info[] = wfMessage( 'file-info-gif-looped' )->parse();
179  }
180 
181  if ( $metadata['frameCount'] > 1 ) {
182  $info[] = wfMessage( 'file-info-gif-frames' )->numParams( $metadata['frameCount'] )->parse();
183  }
184 
185  if ( $metadata['duration'] ) {
186  $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
187  }
188 
189  return $wgLang->commaList( $info );
190  }
191 
200  public function getLength( $file ) {
201  $metadata = $file->getMetadataArray();
202 
203  if ( !$metadata || !isset( $metadata['duration'] ) || !$metadata['duration'] ) {
204  return 0.0;
205  }
206  return (float)$metadata['duration'];
207  }
208 }
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
wfMessage( $key,... $params)
This is the function for getting translated interface messages.
if(!defined( 'MW_NO_SESSION') &&! $wgCommandLineMode) $wgLang
Definition: Setup.php:535
Generic handler for bitmap images.
static GIF( $filename)
function for gif images.
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:70
getMetadataArray()
Get the unserialized handler-specific metadata STUB.
Definition: File.php:752
Handler for GIF images.
Definition: GIFHandler.php:33
isFileMetadataValid( $image)
Check if the metadata is valid for this handler.
Definition: GIFHandler.php:134
getImageArea( $image)
Definition: GIFHandler.php:97
getLength( $file)
Return the duration of the GIF file.
Definition: GIFHandler.php:200
getLongDesc( $image)
Definition: GIFHandler.php:162
isAnimatedImage( $image)
Definition: GIFHandler.php:109
canAnimateThumbnail( $file)
We cannot animate thumbnails that are bigger than a particular size.
Definition: GIFHandler.php:123
formatMetadata( $image, $context=false)
Definition: GIFHandler.php:67
getSizeAndMetadata( $state, $filename)
Get image size information and metadata array.
Definition: GIFHandler.php:39
getMetadataType( $image)
Get a string describing the type of metadata, for display purposes.
Definition: GIFHandler.php:130
getCommonMetaArray(File $image)
Return the standard metadata elements for #filemetadata parser func.
Definition: GIFHandler.php:81
const METADATA_COMPATIBLE
const METADATA_BAD
formatMetadataHelper( $metadataArray, $context=false)
sorts the visible/invisible field.
const METADATA_GOOD
A class containing constants representing the names of configuration variables.
Service locator for MediaWiki core services.
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Item class for a filearchive table row.
Definition: router.php:42