Merge pull request #654 from Sharinglabs/AutoRotateFilterLoader_flip

- Task: correctly handles all rotations, even those involving flippin…

Imagine/Filter/Loader/AutoRotateFilterLoader.php

@@ -22,11 +22,16 @@ class AutoRotateFilterLoader implements LoaderInterface
     public function load(ImageInterface $image, array $options = array())
     {
         if ($orientation = $this->getOrientation($image)) {
-            $degree = $this->calculateRotation((int) $orientation);
-
+            // Rotates if necessary.
+            $degree = $this->calculateRotation($orientation);
             if ($degree !== 0) {
                 $image->rotate($degree);
             }
+
+            // Flips if necessary.
+            if ($this->isFlipped($orientation)) {
+                $image->flipHorizontally();
+            }
         }
 
         return $image;
@@ -42,21 +47,21 @@ public function load(ImageInterface $image, array $options = array())
     private function calculateRotation($orientation)
     {
         switch ($orientation) {
-            case 8:
-                $degree = -90;
-                break;
+            case 1:
+            case 2:
+                return 0;
             case 3:
-                $degree = 180;
-                break;
+            case 4:
+                return 180;
+            case 5:
             case 6:
-                $degree = 90;
-                break;
+                return 90;
+            case 7:
+            case 8:
+                return -90;
             default:
-                $degree = 0;
-                break;
+                throw new Exception('Unhandled orientation');
         }
-
-        return $degree;
     }
 
     /**
@@ -72,15 +77,44 @@ private function getOrientation(ImageInterface $image)
                 $orientation = $image->metadata()->offsetGet($orientationKey);
 
                 if ($orientation) {
-                    return $orientation;
+                    $image->metadata()->offsetSet($orientationKey, '1');
+
+                    return intval($orientation);
                 }
             }
-
-            return;
         } else {
             $data = exif_read_data('data://image/jpeg;base64,'.base64_encode($image->get('jpg')));
 
             return isset($data['Orientation']) ? $data['Orientation'] : null;
         }
+
+        return;
+    }
+
+    /**
+     * Returns true if the image is flipped, false otherwise.
+     *
+     * @param int $orientation
+     *
+     * @return bool
+     */
+    private function isFlipped($orientation)
+    {
+        switch ($orientation) {
+            case 1:
+            case 3:
+            case 6:
+            case 8:
+                return false;
+
+            case 2:
+            case 4:
+            case 5:
+            case 7:
+                return true;
+
+            default:
+                throw new Exception('Unhandled orientation');
+        }
     }
 }

Tests/AbstractTest.php

@@ -91,6 +91,11 @@ protected function getMockImage()
         return $this->getMock('Imagine\Image\ImageInterface');
     }
 
+    protected function getMockMetaData()
+    {
+        return $this->getMock('Imagine\Image\Metadata\MetadataBag');
+    }
+
     protected function createImagineMock()
     {
         return $this->getMock('Imagine\Image\ImagineInterface');

Tests/Imagine/Filter/Loader/AutoRotateFilterLoaderTest.php

@@ -0,0 +1,151 @@
+<?php
+
+namespace Liip\ImagineBundle\Tests\Filter;
+
+use Liip\ImagineBundle\Imagine\Filter\Loader\AutoRotateFilterLoader;
+use Liip\ImagineBundle\Tests\AbstractTest;
+
+/**
+ * Test cases for RotateFilterLoader class.
+ * Depending on the EXIF value checks whether rotate and flip are called.
+ *
+ * @covers Liip\ImagineBundle\Imagine\Filter\Loader\AutoRotateFilterLoader
+ */
+class AutoRotateFilterLoaderTest extends AbstractTest
+{
+    private $orientationKey = 'exif.Orientation';
+
+    /**
+     * Starts a test with expected results.
+     *
+     * @param $exifValue {String} The exif value to be returned by the metadata mock.
+     * @param $expectCallRotateValue {null|number} The expected rotation value, null if no rotation is expected.
+     * @param $expectCallFlip {Boolean} True if a horizontal flip is expected, false otherwise.
+     */
+    private function loadExif($exifValue, $expectCallRotateValue, $expectCallFlip)
+    {
+        $loader = new AutoRotateFilterLoader();
+
+        // Mocks the metadata and makes it return the expected exif value for the rotation.
+        // If $exifValue is null, it means the image doesn't contain any metadata.
+        $metaData = $this->getMockMetaData();
+
+        $metaData
+            ->expects($this->atLeastOnce())
+            ->method('offsetGet')
+            ->willReturn($exifValue);
+
+        if ($exifValue && $exifValue !== '1') {
+            $metaData
+                ->expects($this->once())
+                ->method('offsetSet')
+                ->with($this->orientationKey, '1');
+        }
+
+        // Mocks the image and makes it use the fake meta data.
+        $image = $this->getMockImage();
+
+        $image
+            ->expects($this->atLeastOnce())
+            ->method('metadata')
+            ->willReturn($metaData);
+
+        // Checks that rotate is called with $expectCallRotateValue, or not called at all if $expectCallRotateValue is null.
+        $image
+            ->expects($expectCallRotateValue !== null ? $this->once() : $this->never())
+            ->method('rotate')
+            ->with($expectCallRotateValue);
+
+        // Checks that rotate is called if $expectCallFlip is true, not called if $expectCallFlip is false.
+        $image
+            ->expects($expectCallFlip ? $this->once() : $this->never())
+            ->method('flipHorizontally');
+
+        $loader->load($image);
+    }
+
+    /*
+     * Possible rotation values
+     * 1: 0°
+     * 2: 0° flipped horizontally
+     * 3: 180°
+     * 4: 180° flipped horizontally
+     * 5: 90° flipped horizontally
+     * 6: 90°
+     * 7: -90° flipped horizontally
+     * 8: -90°
+     * No metadata means no rotation nor flip.
+     */
+
+    /**
+     * 1: no rotation.
+     */
+    public function testLoadExif1()
+    {
+        $this->loadExif('1', null, false);
+    }
+
+    /**
+     * 2: no rotation flipped horizontally.
+     */
+    public function testLoadExif2()
+    {
+        $this->loadExif('2', null, true);
+    }
+
+    /**
+     * 3: 180°.
+     */
+    public function testLoadExif3()
+    {
+        $this->loadExif('3', 180, false);
+    }
+
+    /**
+     * 4: 180° flipped horizontally.
+     */
+    public function testLoadExif4()
+    {
+        $this->loadExif('4', 180, true);
+    }
+
+    /**
+     * 5: 90° flipped horizontally.
+     */
+    public function testLoadExif5()
+    {
+        $this->loadExif('5', 90, true);
+    }
+
+    /**
+     * 6: 90°.
+     */
+    public function testLoadExif6()
+    {
+        $this->loadExif('6', 90, false);
+    }
+
+    /**
+     * 7: -90° flipped horizontally.
+     */
+    public function testLoadExif7()
+    {
+        $this->loadExif('7', -90, true);
+    }
+
+    /**
+     * 8: -90°.
+     */
+    public function testLoadExif8()
+    {
+        $this->loadExif('8', null - 90, false);
+    }
+
+    /**
+     * No rotation info: no rotation nor flip.
+     */
+    public function testLoadExifNull()
+    {
+        $this->loadExif(null, null, false);
+    }
+}