Remove never used stuff. There is some $rand = wfRandom calls that might
[lhc/web/wiklou.git] / includes / Exif.php
index 1bd4687..9c3965a 100644 (file)
@@ -30,7 +30,7 @@ if ( !defined( 'MEDIAWIKI' ) ) die();
 /**#@+
  * Exif tag type definition
  */
-define('MW_EXIF_BYTE', 1);             # An 8-bit unsigned integer.
+define('MW_EXIF_BYTE', 1);             # An 8-bit (1-byte) unsigned integer.
 define('MW_EXIF_ASCII', 2);            # An 8-bit byte containing one 7-bit ASCII code. The final byte is terminated with NULL.
 define('MW_EXIF_SHORT', 3);            # A 16-bit (2-byte) unsigned integer.
 define('MW_EXIF_LONG', 4);             # A 32-bit (4-byte) unsigned integer.
@@ -80,10 +80,34 @@ class Exif {
         */
        var $mFormattedExifData;
        
+       /**#@-*/
+       
+       /**#@+
+        * @var string
+        * @access private
+        */
+       
+       /**
+        * The file being processed
+        */
+       var $file;
+
+       /**
+        * The basename of the file being processed
+        */
+       var $basename;
+       
+       /**
+        * The private log to log to
+        */
+       var $log = 'exif';
+       
        /**#@-*/
 
        /**
         * Constructor
+        *
+        * @param string $file
         */
        function Exif( $file ) {
                /**
@@ -271,12 +295,26 @@ class Exif {
                        ),
                );
 
+               $this->file = $file;
+               $this->basename = basename( $this->file );
+               
                $this->makeFlatExifTags();
+               
+               $this->debugFile( $this->basename, __FUNCTION__, true );
                wfSuppressWarnings();
-               $this->mRawExifData = exif_read_data( $file );
+               $data = exif_read_data( $this->file );
                wfRestoreWarnings();
+               /**
+                * exif_read_data() will return false on invalid input, such as
+                * when somebody uploads a file called something.jpeg
+                * containing random gibberish.
+                */
+               $this->mRawExifData = $data ? $data : array();
+               
                $this->makeFilteredData();
                $this->makeFormattedData();
+               
+               $this->debugFile( __FUNCTION__, false );
        }
        
        /**#@+
@@ -305,8 +343,6 @@ class Exif {
                }
        }
        
-       /**#@-*/
-       
        /**
         * Make $this->mFilteredExifData
         */
@@ -377,7 +413,9 @@ class Exif {
 
        /**#@+
         * Validates if a tag value is of the type it should be according to the Exif spec
-        * 
+        *
+        * @access private
+        *
         * @param mixed $in The input value to check
         * @return bool
         */
@@ -402,11 +440,6 @@ class Exif {
                        return false;
                }
                
-               if ( strlen($in) > 1024 ) { // TODO: This might not be according to the spec
-                       $this->debug( $in, __FUNCTION__, 'input was too long' );
-                       return false;
-               }
-               
                return true;
        }
 
@@ -472,6 +505,8 @@ class Exif {
        /**
         * Validates if a tag has a legal value according to the Exif spec
         *
+        * @access private
+        *
         * @param string $tag The tag to check
         * @param mixed  $val The value of the tag
         * @return bool
@@ -516,6 +551,8 @@ class Exif {
        /**
         * Conviniance function for debugging output
         *
+        * @access private
+        *
         * @param mixed $in 
         * @param string $fname
         * @param mixed $action
@@ -527,13 +564,30 @@ class Exif {
                        $in = print_r( $in, true ); 
         
                if ( $action === true )
-                       wfDebug( "$class::$fname: accepted: '$in' (type: $type)\n");
+                       wfDebugLog( $this->log, "$class::$fname: accepted: '$in' (type: $type)\n");
                elseif ( $action === false ) 
-                       wfDebug( "$class::$fname: rejected: '$in' (type: $type)\n");
+                       wfDebugLog( $this->log, "$class::$fname: rejected: '$in' (type: $type)\n");
                elseif ( $action === null )
-                       wfDebug( "$class::$fname: input was: '$in' (type: $type)\n");
+                       wfDebugLog( $this->log, "$class::$fname: input was: '$in' (type: $type)\n");
+               else
+                       wfDebugLog( $this->log, "$class::$fname: $action (type: $type; content: '$in')\n");
+       }
+
+       /**
+        * Conviniance function for debugging output
+        *
+        * @access private
+        *
+        * @param string $basename The name of the file being processed
+        * @paran string $fname The name of the function calling this function
+        * @param bool $bool $io Specify whether we're beginning or ending
+        */
+       function debugFile( $fname, $io ) {
+               $class = ucfirst( __CLASS__ );
+               if ( $io )
+                       wfDebugLog( $this->log, "$class::$fname: begin processing: '{$this->basename}'\n" );
                else
-                       wfDebug( "$class::$fname: $action (type: $type; content: '$in')\n");
+                       wfDebugLog( $this->log, "$class::$fname: end processing: '{$this->basename}'\n" );
        }
 
 }
@@ -573,6 +627,9 @@ class FormatExif {
                global $wgLang;
                
                $tags =& $this->mExif;
+
+               $resolutionunit = !isset( $tags['ResolutionUnit'] ) || $tags['ResolutionUnit'] == 2 ? 2 : 3;
+               unset( $tags['ResolutionUnit'] );
                
                foreach( $tags as $tag => $val ) {
                        switch( $tag ) {
@@ -622,18 +679,22 @@ class FormatExif {
                        
                        // TODO: YCbCrSubSampling
                        // TODO: YCbCrPositioning
-                       // TODO: If this field does not exists use 2
-                       case 'ResolutionUnit': #p26
-                               switch( $val ) {
-                               case 2: case 3:
-                                       $tags[$tag] = $this->msg( $tag, $val );
-                                       break;
-                               default:
-                                       $tags[$tag] = $val;
-                                       break;
+                       
+                       case 'XResolution':
+                       case 'YResolution':
+                               switch( $resolutionunit ) {
+                                       case 2:
+                                               $tags[$tag] = $this->msg( 'XYResolution', 'i', $this->formatNum( $val ) );
+                                               break;
+                                       case 3:
+                                               $this->msg( 'XYResolution', 'c', $this->formatNum( $val ) );
+                                               break;
+                                       default:
+                                               $tags[$tag] = $val;
+                                               break;
                                }
                                break;
-                       
+                               
                        // TODO: YCbCrCoefficients  #p27 (see annex E)
                        case 'ExifVersion': case 'FlashpixVersion':
                                $tags[$tag] = "$val"/100;
@@ -933,6 +994,23 @@ class FormatExif {
                        case 'Software':
                                $tags[$tag] = $this->msg( $tag, '', $val );
                                break;
+                       
+                       case 'ExposureTime':
+                               // Show the pretty fraction as well as decimal version
+                               $tags[$tag] = wfMsg( 'exif-exposuretime-format',
+                                       $this->formatFraction( $val ), $this->formatNum( $val ) );
+                               break;
+                       
+                       case 'FNumber':
+                               $tags[$tag] = wfMsg( 'exif-fnumber-format',
+                                       $this->formatNum( $val ) );
+                               break;
+                       
+                       case 'FocalLength':
+                               $tags[$tag] = wfMsg( 'exif-focallength-format',
+                                       $this->formatNum( $val ) );
+                               break;
+                       
                        default:
                                $tags[$tag] = $this->formatNum( $val );
                                break;
@@ -945,18 +1023,27 @@ class FormatExif {
        /**
         * Conviniance function for getFormattedData()
         *
+        * @access private
+        *
         * @param string $tag The tag name to pass on
         * @param string $val The value of the tag
         * @param string $arg An argument to pass ($1)
         * @return string A wfMsg of "exif-$tag-$val" in lower case
         */
        function msg( $tag, $val, $arg = null ) {
-               if ($val == '')
+               global $wgContLang;
+               
+               if ($val === '')
                        $val = 'value';
-               return wfMsg( strtolower( "exif-$tag-$val" ), $arg );
+               return wfMsg( $wgContLang->lc( "exif-$tag-$val" ), $arg );
        }
 
        /**
+        * Format a number, convert numbers from fractions into floating point
+        * numbers
+        *
+        * @access private
+        *
         * @param mixed $num The value to format
         * @return mixed A floating point number or whatever we were fed
         */
@@ -966,4 +1053,52 @@ class FormatExif {
                else
                        return $num;
        }
+       
+       /**
+        * Format a rational number, reducing fractions
+        *
+        * @access private
+        *
+        * @param mixed $num The value to format
+        * @return mixed A floating point number or whatever we were fed
+        */
+       function formatFraction( $num ) {
+               if ( preg_match( '/^(\d+)\/(\d+)$/', $num, $m ) ) {
+                       $numerator = intval( $m[1] );
+                       $denominator = intval( $m[2] );
+                       $gcd = $this->gcd( $numerator, $denominator );
+                       if( $gcd != 0 ) {
+                               // 0 shouldn't happen! ;)
+                               return $numerator / $gcd . '/' . $denominator / $gcd;
+                       }
+               }
+               return $this->formatNum( $num );
+       }
+
+       /**
+        * Calculate the greatest common divisor of two integers.
+        *
+        * @param int $a
+        * @param int $b
+        * @return int
+        * @access private
+        */
+       function gcd( $a, $b ) {
+               /*
+                       // http://en.wikipedia.org/wiki/Euclidean_algorithm
+                       // Recursive form would be:
+                       if( $b == 0 )
+                               return $a;
+                       else
+                               return gcd( $b, $a % $b );
+               */
+               while( $b != 0 ) {
+                       $remainder = $a % $b;
+                       
+                       // tail recursion...
+                       $a = $b;
+                       $b = $remainder;
+               }
+               return $a;
+       }
 }