Merge "Action::checkCanExecute doesn't return anything on success, but WatchAction...

[lhc/web/wiklou.git] / includes / media / GIF.php

diff --git a/includes/media/GIF.php b/includes/media/GIF.php
index fba54ae..32618e9 100644 (file)
--- a/includes/media/GIF.php
+++ b/includes/media/GIF.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * Handler for GIF images.
+ *
  * @file
  * @ingroup Media
  */
@@ -10,55 +12,132 @@
  * @ingroup Media
  */
 class GIFHandler extends BitmapHandler {
+
+       const BROKEN_FILE = '0'; // value to store in img_metadata if error extracting metadata.
        
        function getMetadata( $image, $filename ) {
-               if ( !isset($image->parsedGIFMetadata) )
-                       $image->parsedGIFMetadata = GIFMetadataExtractor::getMetadata( $filename );
-
-               return serialize($image->parsedGIFMetadata);
+               try {
+                       $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
+               } catch( Exception $e ) {
+                       // Broken file?
+                       wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
+                       return self::BROKEN_FILE;
+               }
 
+               return serialize($parsedGIFMetadata);
        }
-       
+
+       /**
+        * @param $image File
+        * @return array|bool
+        */
        function formatMetadata( $image ) {
-               return false;
+               $meta = $image->getMetadata();
+
+               if ( !$meta ) {
+                       return false;
+               }
+               $meta = unserialize( $meta );
+                if ( !isset( $meta['metadata'] ) || count( $meta['metadata'] ) <= 1 ) {
+                       return false;
+               }
+
+               if ( isset( $meta['metadata']['_MW_GIF_VERSION'] ) ) {
+                       unset( $meta['metadata']['_MW_GIF_VERSION'] );
+               }
+               return $this->formatMetadataHelper( $meta['metadata'] );
        }
-       
-       function getImageArea( $image, $width, $height ) {
-               if ($metadata) {
-                       $metadata = unserialize($image->getMetadata());
-                       return $width * $height * $metadata['frameCount'];
+
+       /**
+        * @param $image File
+        * @todo unittests
+        * @return bool
+        */
+       function getImageArea( $image ) {
+               $ser = $image->getMetadata();
+               if ( $ser ) {
+                       $metadata = unserialize( $ser );
+                       return $image->getWidth() * $image->getHeight() * $metadata['frameCount'];
                } else {
-                       return $width * $height;
+                       return $image->getWidth() * $image->getHeight();
                }
        }
-       
+
+       /**
+        * @param $image File
+        * @return bool
+        */
+       function isAnimatedImage( $image ) {
+               $ser = $image->getMetadata();
+               if ( $ser ) {
+                       $metadata = unserialize($ser);
+                       if( $metadata['frameCount'] > 1 ) {
+                               return true;
+                       }
+               }
+               return false;
+       }
+
        function getMetadataType( $image ) {
                return 'parsed-gif';
        }
-       
+
+       function isMetadataValid( $image, $metadata ) {
+               if ( $metadata === self::BROKEN_FILE ) {
+                       // Do not repetitivly regenerate metadata on broken file.
+                       return self::METADATA_GOOD;
+               }
+
+               wfSuppressWarnings();
+               $data = unserialize( $metadata );
+               wfRestoreWarnings();
+
+               if ( !$data || !is_array( $data ) ) {
+                       wfDebug(__METHOD__ . ' invalid GIF metadata' );
+                       return self::METADATA_BAD;
+               }
+
+               if ( !isset( $data['metadata']['_MW_GIF_VERSION'] )
+                       || $data['metadata']['_MW_GIF_VERSION'] != GIFMetadataExtractor::VERSION ) {
+                       wfDebug(__METHOD__ . ' old but compatible GIF metadata' );
+                       return self::METADATA_COMPATIBLE;
+               }
+               return self::METADATA_GOOD;
+       }
+
+       /**
+        * @param $image File
+        * @return string
+        */
        function getLongDesc( $image ) {
-               global $wgUser, $wgLang;
-               $sk = $wgUser->getSkin();
-               
-               $metadata = @unserialize($image->getMetadata());
-               
-               if (!$metadata) return parent::getLongDesc( $image );
+               global $wgLang;
+
+               $original = parent::getLongDesc( $image );
+
+               wfSuppressWarnings();
+               $metadata = unserialize($image->getMetadata());
+               wfRestoreWarnings();
                
+               if (!$metadata || $metadata['frameCount'] <=  1) {
+                       return $original;
+               }
+
+               /* Preserve original image info string, but strip the last char ')' so we can add even more */
                $info = array();
-               $info[] = $image->getMimeType();
-               $info[] = $sk->formatSize( $image->getSize() );
+               $info[] = $original;
                
-               if ($metadata['looped'])
+               if ( $metadata['looped'] ) {
                        $info[] = wfMsgExt( 'file-info-gif-looped', 'parseinline' );
+               }
                
-               if ($metadata['frameCount'] > 1)
+               if ( $metadata['frameCount'] > 1 ) {
                        $info[] = wfMsgExt( 'file-info-gif-frames', 'parseinline', $metadata['frameCount'] );
+               }
                
-               if ($metadata['duration'])
+               if ( $metadata['duration'] ) {
                        $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
+               }
                
-               $infoString = $wgLang->commaList( $info );
-               
-               return "($infoString)";
+               return $wgLang->commaList( $info );
        }
 }