includes/media/GIF.php

   1 <?php
   2 /**
   3  * Handler for GIF images.
   4  *
   5  * @file
   6  * @ingroup Media
   7  */
   8
   9 /**
  10  * Handler for GIF images.
  11  *
  12  * @ingroup Media
  13  */
  14 class GIFHandler extends BitmapHandler {
  15
  16         const BROKEN_FILE = '0'; // value to store in img_metadata if error extracting metadata.
  17
  18         function getMetadata( $image, $filename ) {
  19                 try {
  20                         $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
  21                 } catch( Exception $e ) {
  22                         // Broken file?
  23                         wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
  24                         return self::BROKEN_FILE;
  25                 }
  26
  27                 return serialize($parsedGIFMetadata);
  28         }
  29
  30         /**
  31          * @param $image File
  32          * @return array|bool
  33          */
  34         function formatMetadata( $image ) {
  35                 $meta = $image->getMetadata();
  36
  37                 if ( !$meta ) {
  38                         return false;
  39                 }
  40                 $meta = unserialize( $meta );
  41                  if ( !isset( $meta['metadata'] ) || count( $meta['metadata'] ) <= 1 ) {
  42                         return false;
  43                 }
  44
  45                 if ( isset( $meta['metadata']['_MW_GIF_VERSION'] ) ) {
  46                         unset( $meta['metadata']['_MW_GIF_VERSION'] );
  47                 }
  48                 return $this->formatMetadataHelper( $meta['metadata'] );
  49         }
  50
  51         /**
  52          * @param $image File
  53          * @param  $width
  54          * @param  $height
  55          * @return
  56          */
  57         function getImageArea( $image, $width, $height ) {
  58                 $ser = $image->getMetadata();
  59                 if ( $ser ) {
  60                         $metadata = unserialize( $ser );
  61                         return $width * $height * $metadata['frameCount'];
  62                 } else {
  63                         return $width * $height;
  64                 }
  65         }
  66
  67         /**
  68          * @param $image File
  69          * @return bool
  70          */
  71         function isAnimatedImage( $image ) {
  72                 $ser = $image->getMetadata();
  73                 if ( $ser ) {
  74                         $metadata = unserialize($ser);
  75                         if( $metadata['frameCount'] > 1 ) {
  76                                 return true;
  77                         }
  78                 }
  79                 return false;
  80         }
  81
  82         function getMetadataType( $image ) {
  83                 return 'parsed-gif';
  84         }
  85
  86         function isMetadataValid( $image, $metadata ) {
  87                 if ( $metadata === self::BROKEN_FILE ) {
  88                         // Do not repetitivly regenerate metadata on broken file.
  89                         return self::METADATA_GOOD;
  90                 }
  91
  92                 wfSuppressWarnings();
  93                 $data = unserialize( $metadata );
  94                 wfRestoreWarnings();
  95
  96                 if ( !$data || !is_array( $data ) ) {
  97                         wfDebug(__METHOD__ . ' invalid GIF metadata' );
  98                         return self::METADATA_BAD;
  99                 }
 100
 101                 if ( !isset( $data['metadata']['_MW_GIF_VERSION'] )
 102                         || $data['metadata']['_MW_GIF_VERSION'] != GIFMetadataExtractor::VERSION ) {
 103                         wfDebug(__METHOD__ . ' old but compatible GIF metadata' );
 104                         return self::METADATA_COMPATIBLE;
 105                 }
 106                 return self::METADATA_GOOD;
 107         }
 108
 109         /**
 110          * @param $image File
 111          * @return string
 112          */
 113         function getLongDesc( $image ) {
 114                 global $wgLang;
 115
 116                 $original = parent::getLongDesc( $image );
 117
 118                 wfSuppressWarnings();
 119                 $metadata = unserialize($image->getMetadata());
 120                 wfRestoreWarnings();
 121
 122                 if (!$metadata || $metadata['frameCount'] <=  1) {
 123                         return $original;
 124                 }
 125
 126                 /* Preserve original image info string, but strip the last char ')' so we can add even more */
 127                 $info = array();
 128                 $info[] = $original;
 129
 130                 if ( $metadata['looped'] ) {
 131                         $info[] = wfMsgExt( 'file-info-gif-looped', 'parseinline' );
 132                 }
 133
 134                 if ( $metadata['frameCount'] > 1 ) {
 135                         $info[] = wfMsgExt( 'file-info-gif-frames', 'parseinline', $metadata['frameCount'] );
 136                 }
 137
 138                 if ( $metadata['duration'] ) {
 139                         $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
 140                 }
 141
 142                 return $wgLang->commaList( $info );
 143         }
 144 }