MediaWiki REL1_33
GIFHandler.php
Go to the documentation of this file.
1<?php
30 const BROKEN_FILE = '0'; // value to store in img_metadata if error extracting metadata.
31
32 public 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 public 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 if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 0 ) {
90 return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
91 } else {
92 return $image->getWidth() * $image->getHeight();
93 }
94 } else {
95 return $image->getWidth() * $image->getHeight();
96 }
97 }
98
104 $ser = $image->getMetadata();
105 if ( $ser ) {
106 $metadata = unserialize( $ser );
107 if ( isset( $metadata['frameCount'] ) && $metadata['frameCount'] > 1 ) {
108 return true;
109 }
110 }
111
112 return false;
113 }
114
120 function canAnimateThumbnail( $file ) {
122 $answer = $this->getImageArea( $file ) <= $wgMaxAnimatedGifArea;
123
124 return $answer;
125 }
126
128 return 'parsed-gif';
129 }
130
131 public function isMetadataValid( $image, $metadata ) {
132 if ( $metadata === self::BROKEN_FILE ) {
133 // Do not repetitivly regenerate metadata on broken file.
134 return self::METADATA_GOOD;
135 }
136
137 Wikimedia\suppressWarnings();
138 $data = unserialize( $metadata );
139 Wikimedia\restoreWarnings();
140
141 if ( !$data || !is_array( $data ) ) {
142 wfDebug( __METHOD__ . " invalid GIF metadata\n" );
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\n" );
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 Wikimedia\suppressWarnings();
168 $metadata = unserialize( $image->getMetadata() );
169 Wikimedia\restoreWarnings();
170
171 if ( !$metadata || $metadata['frameCount'] <= 1 ) {
172 return $original;
173 }
174
175 /* Preserve original image info string, but strip the last char ')' so we can add even more */
176 $info = [];
177 $info[] = $original;
178
179 if ( $metadata['looped'] ) {
180 $info[] = wfMessage( 'file-info-gif-looped' )->parse();
181 }
182
183 if ( $metadata['frameCount'] > 1 ) {
184 $info[] = wfMessage( 'file-info-gif-frames' )->numParams( $metadata['frameCount'] )->parse();
185 }
186
187 if ( $metadata['duration'] ) {
188 $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
189 }
190
191 return $wgLang->commaList( $info );
192 }
193
202 public function getLength( $file ) {
203 $serMeta = $file->getMetadata();
204 Wikimedia\suppressWarnings();
205 $metadata = unserialize( $serMeta );
206 Wikimedia\restoreWarnings();
207
208 if ( !$metadata || !isset( $metadata['duration'] ) || !$metadata['duration'] ) {
209 return 0.0;
210 } else {
211 return (float)$metadata['duration'];
212 }
213 }
214}
serialize()
unserialize( $serialized)
$wgMaxAnimatedGifArea
Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnai...
wfDebug( $text, $dest='all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
$wgLang
Definition Setup.php:875
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:52
Handler for GIF images.
getImageArea( $image)
isMetadataValid( $image, $metadata)
Check if the metadata string is valid for this handler.
getLength( $file)
Return the duration of the GIF file.
getLongDesc( $image)
getMetadata( $image, $filename)
Get handler-specific metadata which will be saved in the img_metadata field.
isAnimatedImage( $image)
canAnimateThumbnail( $file)
We cannot animate thumbnails that are bigger than a particular size.
formatMetadata( $image, $context=false)
const BROKEN_FILE
getMetadataType( $image)
Get a string describing the type of metadata, for display purposes.
getCommonMetaArray(File $image)
Return the standard metadata elements for #filemetadata parser func.
const METADATA_COMPATIBLE
formatMetadataHelper( $metadataArray, $context=false)
sorts the visible/invisible field.
const METADATA_GOOD
$data
Utility to generate mapping file used in mw.Title (phpCharToUpper.json)
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:886
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition hooks.txt:2848
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 use $formDescriptor instead 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 unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
returning false will NOT prevent logging $e
Definition hooks.txt:2175
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:37
if(PHP_SAPI !='cli-server') if(!isset( $_SERVER['SCRIPT_FILENAME'])) $file
Definition router.php:42