MediaWiki  1.28.0
GIF.php
Go to the documentation of this file.
1 <?php
29 class GIFHandler extends BitmapHandler {
30  const BROKEN_FILE = '0'; // value to store in img_metadata if error extracting metadata.
31 
32  function getMetadata( $image, $filename ) {
33  try {
34  $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
35  } catch ( Exception $e ) {
36  // Broken file?
37  wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
38 
39  return self::BROKEN_FILE;
40  }
41 
42  return serialize( $parsedGIFMetadata );
43  }
44 
50  function formatMetadata( $image, $context = false ) {
51  $meta = $this->getCommonMetaArray( $image );
52  if ( count( $meta ) === 0 ) {
53  return false;
54  }
55 
56  return $this->formatMetadataHelper( $meta, $context );
57  }
58 
64  public function getCommonMetaArray( File $image ) {
65  $meta = $image->getMetadata();
66 
67  if ( !$meta ) {
68  return [];
69  }
70  $meta = unserialize( $meta );
71  if ( !isset( $meta['metadata'] ) ) {
72  return [];
73  }
74  unset( $meta['metadata']['_MW_GIF_VERSION'] );
75 
76  return $meta['metadata'];
77  }
78 
85  function getImageArea( $image ) {
86  $ser = $image->getMetadata();
87  if ( $ser ) {
88  $metadata = unserialize( $ser );
89 
90  return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
91  } else {
92  return $image->getWidth() * $image->getHeight();
93  }
94  }
95 
100  function isAnimatedImage( $image ) {
101  $ser = $image->getMetadata();
102  if ( $ser ) {
103  $metadata = unserialize( $ser );
104  if ( $metadata['frameCount'] > 1 ) {
105  return true;
106  }
107  }
108 
109  return false;
110  }
111 
117  function canAnimateThumbnail( $file ) {
119  $answer = $this->getImageArea( $file ) <= $wgMaxAnimatedGifArea;
120 
121  return $answer;
122  }
123 
124  function getMetadataType( $image ) {
125  return 'parsed-gif';
126  }
127 
128  function isMetadataValid( $image, $metadata ) {
129  if ( $metadata === self::BROKEN_FILE ) {
130  // Do not repetitivly regenerate metadata on broken file.
131  return self::METADATA_GOOD;
132  }
133 
134  MediaWiki\suppressWarnings();
135  $data = unserialize( $metadata );
136  MediaWiki\restoreWarnings();
137 
138  if ( !$data || !is_array( $data ) ) {
139  wfDebug( __METHOD__ . " invalid GIF metadata\n" );
140 
141  return self::METADATA_BAD;
142  }
143 
144  if ( !isset( $data['metadata']['_MW_GIF_VERSION'] )
145  || $data['metadata']['_MW_GIF_VERSION'] != GIFMetadataExtractor::VERSION
146  ) {
147  wfDebug( __METHOD__ . " old but compatible GIF metadata\n" );
148 
149  return self::METADATA_COMPATIBLE;
150  }
151 
152  return self::METADATA_GOOD;
153  }
154 
159  function getLongDesc( $image ) {
160  global $wgLang;
161 
162  $original = parent::getLongDesc( $image );
163 
164  MediaWiki\suppressWarnings();
165  $metadata = unserialize( $image->getMetadata() );
166  MediaWiki\restoreWarnings();
167 
168  if ( !$metadata || $metadata['frameCount'] <= 1 ) {
169  return $original;
170  }
171 
172  /* Preserve original image info string, but strip the last char ')' so we can add even more */
173  $info = [];
174  $info[] = $original;
175 
176  if ( $metadata['looped'] ) {
177  $info[] = wfMessage( 'file-info-gif-looped' )->parse();
178  }
179 
180  if ( $metadata['frameCount'] > 1 ) {
181  $info[] = wfMessage( 'file-info-gif-frames' )->numParams( $metadata['frameCount'] )->parse();
182  }
183 
184  if ( $metadata['duration'] ) {
185  $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
186  }
187 
188  return $wgLang->commaList( $info );
189  }
190 
199  public function getLength( $file ) {
200  $serMeta = $file->getMetadata();
201  MediaWiki\suppressWarnings();
202  $metadata = unserialize( $serMeta );
203  MediaWiki\restoreWarnings();
204 
205  if ( !$metadata || !isset( $metadata['duration'] ) || !$metadata['duration'] ) {
206  return 0.0;
207  } else {
208  return (float)$metadata['duration'];
209  }
210  }
211 }
isMetadataValid($image, $metadata)
Definition: GIF.php:128
$context
Definition: load.php:50
getLength($file)
Return the duration of the GIF file.
Definition: GIF.php:199
div flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException'returning false will NOT prevent logging $e
Definition: hooks.txt:2102
getLongDesc($image)
Definition: GIF.php:159
formatMetadata($image, $context=false)
Definition: GIF.php:50
getCommonMetaArray(File $image)
Return the standard metadata elements for #filemetadata parser func.
Definition: GIF.php:64
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
formatMetadataHelper($metadataArray, $context=false)
sorts the visible/invisible field.
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
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 $wgLang
Definition: design.txt:56
getMetadata($image, $filename)
Definition: GIF.php:32
static GIF($filename)
function for gif images.
isAnimatedImage($image)
Definition: GIF.php:100
unserialize($serialized)
Definition: ApiMessage.php:102
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
getMetadata()
Get handler-specific metadata Overridden by LocalFile, UnregisteredLocalFile STUB.
Definition: File.php:638
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
const BROKEN_FILE
Definition: GIF.php:30
getImageArea($image)
Definition: GIF.php:85
$wgMaxAnimatedGifArea
Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnai...
Handler for GIF images.
Definition: GIF.php:29
Generic handler for bitmap images.
Definition: Bitmap.php:29
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
getMetadataType($image)
Definition: GIF.php:124
serialize()
Definition: ApiMessage.php:94
canAnimateThumbnail($file)
We cannot animate thumbnails that are bigger than a particular size.
Definition: GIF.php:117
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:50