merged master

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

diff --git a/includes/media/GIF.php b/includes/media/GIF.php
index 4e53d10..84b9b8c 100644 (file)
--- a/includes/media/GIF.php
+++ b/includes/media/GIF.php
@@ -2,6 +2,21 @@
 /**
  * Handler for GIF images.
  *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup Media
  */
@@ -12,56 +27,114 @@
  * @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 ) ) {
-                       try {
-                               $image->parsedGIFMetadata = GIFMetadataExtractor::getMetadata( $filename );
-                       } catch( Exception $e ) {
-                               // Broken file?
-                               wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
-                               return '0';
-                       }
+               try {
+                       $parsedGIFMetadata = BitmapMetadataHandler::GIF( $filename );
+               } catch( Exception $e ) {
+                       // Broken file?
+                       wfDebug( __METHOD__ . ': ' . $e->getMessage() . "\n" );
+                       return self::BROKEN_FILE;
                }
 
-               return serialize( $image->parsedGIFMetadata );
-
+               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 ) {
+
+       /**
+        * @param $image File
+        * @todo unittests
+        * @return bool
+        */
+       function getImageArea( $image ) {
                $ser = $image->getMetadata();
-               if ($ser) {
-                       $metadata = unserialize($ser);
-                       return $width * $height * $metadata['frameCount'];
+               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) {
+               if ( $ser ) {
                        $metadata = unserialize($ser);
-                       if( $metadata['frameCount'] > 1 ) return true;
+                       if( $metadata['frameCount'] > 1 ) {
+                               return true;
+                       }
                }
                return false;
        }
-       
+
+       /**
+        * We cannot animate thumbnails that are bigger than a particular size
+        * @param File $file
+        * @return bool
+        */
+       function canAnimateThumbnail( $file ) {
+               global $wgMaxAnimatedGifArea;
+               $answer = $this->getImageArea( $file ) <= $wgMaxAnimatedGifArea;
+               return $answer;
+       }
+
        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();
-               return (boolean) $data;
+
+               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 $wgLang;
 
@@ -71,21 +144,25 @@ class GIFHandler extends BitmapHandler {
                $metadata = unserialize($image->getMetadata());
                wfRestoreWarnings();
                
-               if (!$metadata || $metadata['frameCount'] <=  1)
+               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[] = $original;
                
-               if ($metadata['looped'])
-                       $info[] = wfMsgExt( 'file-info-gif-looped', 'parseinline' );
+               if ( $metadata['looped'] ) {
+                       $info[] = wfMessage( 'file-info-gif-looped' )->parse();
+               }
                
-               if ($metadata['frameCount'] > 1)
-                       $info[] = wfMsgExt( 'file-info-gif-frames', 'parseinline', $metadata['frameCount'] );
+               if ( $metadata['frameCount'] > 1 ) {
+                       $info[] = wfMessage( 'file-info-gif-frames' )->numParams( $metadata['frameCount'] )->parse();
+               }
                
-               if ($metadata['duration'])
+               if ( $metadata['duration'] ) {
                        $info[] = $wgLang->formatTimePeriod( $metadata['duration'] );
+               }
                
                return $wgLang->commaList( $info );
        }