3 * Handler for GIF images.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
25 * Handler for GIF images.
29 class GIFHandler extends BitmapHandler {
30 const BROKEN_FILE = '0'; // value to store in img_metadata if error extracting metadata.
32 function getMetadata( $image, $filename ) {
34 $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
35 } catch ( Exception $e ) {
37 wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
39 return self::BROKEN_FILE;
42 return serialize( $parsedGIFMetadata );
47 * @param bool|IContextSource $context Context to use (optional)
50 function formatMetadata( $image, $context = false ) {
51 $meta = $this->getCommonMetaArray( $image );
52 if ( count( $meta ) === 0 ) {
56 return $this->formatMetadataHelper( $meta, $context );
60 * Return the standard metadata elements for #filemetadata parser func.
64 public function getCommonMetaArray( File $image ) {
65 $meta = $image->getMetadata();
70 $meta = unserialize( $meta );
71 if ( !isset( $meta['metadata'] ) ) {
74 unset( $meta['metadata']['_MW_GIF_VERSION'] );
76 return $meta['metadata'];
80 * @todo Add unit tests
85 function getImageArea( $image ) {
86 $ser = $image->getMetadata();
88 $metadata = unserialize( $ser );
90 return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
92 return $image->getWidth() * $image->getHeight();
100 function isAnimatedImage( $image ) {
101 $ser = $image->getMetadata();
103 $metadata = unserialize( $ser );
104 if ( $metadata['frameCount'] > 1 ) {
113 * We cannot animate thumbnails that are bigger than a particular size
117 function canAnimateThumbnail( $file ) {
118 global $wgMaxAnimatedGifArea;
119 $answer = $this->getImageArea( $file ) <= $wgMaxAnimatedGifArea;
124 function getMetadataType( $image ) {
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;
134 MediaWiki\suppressWarnings();
135 $data = unserialize( $metadata );
136 MediaWiki\restoreWarnings();
138 if ( !$data || !is_array( $data ) ) {
139 wfDebug( __METHOD__ . " invalid GIF metadata\n" );
141 return self::METADATA_BAD;
144 if ( !isset( $data['metadata']['_MW_GIF_VERSION'] )
145 || $data['metadata']['_MW_GIF_VERSION'] != GIFMetadataExtractor::VERSION
147 wfDebug( __METHOD__ . " old but compatible GIF metadata\n" );
149 return self::METADATA_COMPATIBLE;
152 return self::METADATA_GOOD;
159 function getLongDesc( $image ) {
162 $original = parent::getLongDesc( $image );
164 MediaWiki\suppressWarnings();
165 $metadata = unserialize( $image->getMetadata() );
166 MediaWiki\restoreWarnings();
168 if ( !$metadata || $metadata['frameCount'] <= 1 ) {
172 /* Preserve original image info string, but strip the last char ')' so we can add even more */
176 if ( $metadata['looped'] ) {
177 $info[] = wfMessage( 'file-info-gif-looped' )->parse();
180 if ( $metadata['frameCount'] > 1 ) {
181 $info[] = wfMessage( 'file-info-gif-frames' )->numParams( $metadata['frameCount'] )->parse();
184 if ( $metadata['duration'] ) {
185 $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
188 return $wgLang->commaList( $info );
192 * Return the duration of the GIF file.
194 * Shown in the &query=imageinfo&iiprop=size api query.
197 * @return float The duration of the file.
199 public function getLength( $file ) {
200 $serMeta = $file->getMetadata();
201 MediaWiki\suppressWarnings();
202 $metadata = unserialize( $serMeta );
203 MediaWiki\restoreWarnings();
205 if ( !$metadata || !isset( $metadata['duration'] ) || !$metadata['duration'] ) {
208 return (float)$metadata['duration'];