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
{
31 const BROKEN_FILE
= '0'; // value to store in img_metadata if error extracting metadata.
33 function getMetadata( $image, $filename ) {
35 $parsedGIFMetadata = BitmapMetadataHandler
::GIF( $filename );
36 } catch ( Exception
$e ) {
38 wfDebug( __METHOD__
. ': ' . $e->getMessage() . "\n" );
39 return self
::BROKEN_FILE
;
42 return serialize( $parsedGIFMetadata );
49 function formatMetadata( $image ) {
50 $meta = $this->getCommonMetaArray( $image );
51 if ( count( $meta ) === 0 ) {
55 return $this->formatMetadataHelper( $meta );
59 * Return the standard metadata elements for #filemetadata parser func.
63 public function getCommonMetaArray( File
$image ) {
64 $meta = $image->getMetadata();
69 $meta = unserialize( $meta );
70 if ( !isset( $meta['metadata'] ) ) {
73 unset( $meta['metadata']['_MW_GIF_VERSION'] );
74 return $meta['metadata'];
82 function getImageArea( $image ) {
83 $ser = $image->getMetadata();
85 $metadata = unserialize( $ser );
86 return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
88 return $image->getWidth() * $image->getHeight();
96 function isAnimatedImage( $image ) {
97 $ser = $image->getMetadata();
99 $metadata = unserialize( $ser );
100 if ( $metadata['frameCount'] > 1 ) {
108 * We cannot animate thumbnails that are bigger than a particular size
112 function canAnimateThumbnail( $file ) {
113 global $wgMaxAnimatedGifArea;
114 $answer = $this->getImageArea( $file ) <= $wgMaxAnimatedGifArea;
118 function getMetadataType( $image ) {
122 function isMetadataValid( $image, $metadata ) {
123 if ( $metadata === self
::BROKEN_FILE
) {
124 // Do not repetitivly regenerate metadata on broken file.
125 return self
::METADATA_GOOD
;
128 wfSuppressWarnings();
129 $data = unserialize( $metadata );
132 if ( !$data ||
!is_array( $data ) ) {
133 wfDebug( __METHOD__
. " invalid GIF metadata\n" );
134 return self
::METADATA_BAD
;
137 if ( !isset( $data['metadata']['_MW_GIF_VERSION'] )
138 ||
$data['metadata']['_MW_GIF_VERSION'] != GIFMetadataExtractor
::VERSION
) {
139 wfDebug( __METHOD__
. " old but compatible GIF metadata\n" );
140 return self
::METADATA_COMPATIBLE
;
142 return self
::METADATA_GOOD
;
149 function getLongDesc( $image ) {
152 $original = parent
::getLongDesc( $image );
154 wfSuppressWarnings();
155 $metadata = unserialize( $image->getMetadata() );
158 if ( !$metadata ||
$metadata['frameCount'] <= 1 ) {
162 /* Preserve original image info string, but strip the last char ')' so we can add even more */
166 if ( $metadata['looped'] ) {
167 $info[] = wfMessage( 'file-info-gif-looped' )->parse();
170 if ( $metadata['frameCount'] > 1 ) {
171 $info[] = wfMessage( 'file-info-gif-frames' )->numParams( $metadata['frameCount'] )->parse();
174 if ( $metadata['duration'] ) {
175 $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
178 return $wgLang->commaList( $info );