feature/strip encoder parameter (#1421)

Add config option and encoder parameter to strip meta data in the encoding process. --------- Co-authored-by: Thomas <[email protected]>
Intervention · Jan 18, 2025 · 6b9ce4f · 6b9ce4f
1 parent 49c7cd0
commit 6b9ce4f
Show file tree

Hide file tree

Showing 25 changed files with 186 additions and 11 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -14,13 +14,16 @@ class Config
      * @param bool $autoOrientation
      * @param bool $decodeAnimation
      * @param mixed $blendingColor
+     * @param bool $strip
      * @return void
      */
     public function __construct(
         public bool $autoOrientation = true,
         public bool $decodeAnimation = true,
         public mixed $blendingColor = 'ffffff',
+        public bool $strip = false,
     ) {
+        //
     }
 
     /**

diff --git a/src/Drivers/Imagick/Encoders/AvifEncoder.php b/src/Drivers/Imagick/Encoders/AvifEncoder.php
@@ -5,6 +5,7 @@
 namespace Intervention\Image\Drivers\Imagick\Encoders;
 
 use Imagick;
+use Intervention\Image\Drivers\Imagick\Modifiers\StripMetaModifier;
 use Intervention\Image\EncodedImage;
 use Intervention\Image\Encoders\AvifEncoder as GenericAvifEncoder;
 use Intervention\Image\Interfaces\EncodedImageInterface;
@@ -18,6 +19,11 @@ public function encode(ImageInterface $image): EncodedImageInterface
         $format = 'AVIF';
         $compression = Imagick::COMPRESSION_ZIP;
 
+        // strip meta data
+        if ($this->strip || (is_null($this->strip) && $this->driver()->config()->strip)) {
+            $image->modify(new StripMetaModifier());
+        }
+
         $imagick = $image->core()->native();
         $imagick->setFormat($format);
         $imagick->setImageFormat($format);

diff --git a/src/Drivers/Imagick/Encoders/HeicEncoder.php b/src/Drivers/Imagick/Encoders/HeicEncoder.php
@@ -4,6 +4,7 @@
 
 namespace Intervention\Image\Drivers\Imagick\Encoders;
 
+use Intervention\Image\Drivers\Imagick\Modifiers\StripMetaModifier;
 use Intervention\Image\EncodedImage;
 use Intervention\Image\Encoders\HeicEncoder as GenericHeicEncoder;
 use Intervention\Image\Interfaces\EncodedImageInterface;
@@ -16,6 +17,11 @@ public function encode(ImageInterface $image): EncodedImageInterface
     {
         $format = 'HEIC';
 
+        // strip meta data
+        if ($this->strip || (is_null($this->strip) && $this->driver()->config()->strip)) {
+            $image->modify(new StripMetaModifier());
+        }
+
         $imagick = $image->core()->native();
         $imagick->setFormat($format);
         $imagick->setImageFormat($format);

diff --git a/src/Drivers/Imagick/Encoders/Jpeg2000Encoder.php b/src/Drivers/Imagick/Encoders/Jpeg2000Encoder.php
@@ -5,6 +5,7 @@
 namespace Intervention\Image\Drivers\Imagick\Encoders;
 
 use Imagick;
+use Intervention\Image\Drivers\Imagick\Modifiers\StripMetaModifier;
 use Intervention\Image\EncodedImage;
 use Intervention\Image\Encoders\Jpeg2000Encoder as GenericJpeg2000Encoder;
 use Intervention\Image\Interfaces\ImageInterface;
@@ -18,6 +19,11 @@ public function encode(ImageInterface $image): EncodedImageInterface
         $format = 'JP2';
         $compression = Imagick::COMPRESSION_JPEG;
 
+        // strip meta data
+        if ($this->strip || (is_null($this->strip) && $this->driver()->config()->strip)) {
+            $image->modify(new StripMetaModifier());
+        }
+
         $imagick = $image->core()->native();
         $imagick->setImageBackgroundColor('white');
         $imagick->setBackgroundColor('white');

diff --git a/src/Drivers/Imagick/Encoders/JpegEncoder.php b/src/Drivers/Imagick/Encoders/JpegEncoder.php
@@ -5,6 +5,7 @@
 namespace Intervention\Image\Drivers\Imagick\Encoders;
 
 use Imagick;
+use Intervention\Image\Drivers\Imagick\Modifiers\StripMetaModifier;
 use Intervention\Image\EncodedImage;
 use Intervention\Image\Encoders\JpegEncoder as GenericJpegEncoder;
 use Intervention\Image\Interfaces\EncodedImageInterface;
@@ -30,6 +31,12 @@ public function encode(ImageInterface $image): EncodedImageInterface
         // possible full transparent colors as black
         $background->setColorValue(Imagick::COLOR_ALPHA, 1);
 
+        // strip meta data
+        if ($this->strip || (is_null($this->strip) && $this->driver()->config()->strip)) {
+            $image->modify(new StripMetaModifier());
+        }
+
+        /** @var Imagick $imagick */
         $imagick = $image->core()->native();
         $imagick->setImageBackgroundColor($background);
         $imagick->setBackgroundColor($background);

diff --git a/src/Drivers/Imagick/Encoders/TiffEncoder.php b/src/Drivers/Imagick/Encoders/TiffEncoder.php
@@ -4,6 +4,7 @@
 
 namespace Intervention\Image\Drivers\Imagick\Encoders;
 
+use Intervention\Image\Drivers\Imagick\Modifiers\StripMetaModifier;
 use Intervention\Image\EncodedImage;
 use Intervention\Image\Encoders\TiffEncoder as GenericTiffEncoder;
 use Intervention\Image\Interfaces\ImageInterface;
@@ -16,6 +17,11 @@ public function encode(ImageInterface $image): EncodedImageInterface
     {
         $format = 'TIFF';
 
+        // strip meta data
+        if ($this->strip || (is_null($this->strip) && $this->driver()->config()->strip)) {
+            $image->modify(new StripMetaModifier());
+        }
+
         $imagick = $image->core()->native();
         $imagick->setFormat($format);
         $imagick->setImageFormat($format);

diff --git a/src/Drivers/Imagick/Encoders/WebpEncoder.php b/src/Drivers/Imagick/Encoders/WebpEncoder.php
@@ -6,6 +6,7 @@
 
 use Imagick;
 use ImagickPixel;
+use Intervention\Image\Drivers\Imagick\Modifiers\StripMetaModifier;
 use Intervention\Image\EncodedImage;
 use Intervention\Image\Encoders\WebpEncoder as GenericWebpEncoder;
 use Intervention\Image\Interfaces\EncodedImageInterface;
@@ -19,6 +20,11 @@ public function encode(ImageInterface $image): EncodedImageInterface
         $format = 'WEBP';
         $compression = Imagick::COMPRESSION_ZIP;
 
+        // strip meta data
+        if ($this->strip || (is_null($this->strip) && $this->driver()->config()->strip)) {
+            $image->modify(new StripMetaModifier());
+        }
+
         $imagick = $image->core()->native();
         $imagick->setImageBackgroundColor(new ImagickPixel('transparent'));
 

diff --git a/src/Drivers/Imagick/Modifiers/StripMetaModifier.php b/src/Drivers/Imagick/Modifiers/StripMetaModifier.php
@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Intervention\Image\Drivers\Imagick\Modifiers;
+
+use Intervention\Image\Collection;
+use Intervention\Image\Interfaces\ImageInterface;
+use Intervention\Image\Interfaces\ModifierInterface;
+use Intervention\Image\Interfaces\SpecializedInterface;
+
+class StripMetaModifier implements ModifierInterface, SpecializedInterface
+{
+    /**
+     * {@inheritdoc}
+     *
+     * @see Intervention\Image\Interfaces\ModifierInterface::apply()
+     */
+    public function apply(ImageInterface $image): ImageInterface
+    {
+        // preserve icc profiles
+        $profiles = $image->core()->native()->getImageProfiles('icc');
+
+        // remove meta data
+        $image->core()->native()->stripImage();
+        $image->setExif(new Collection());
+
+        if ($profiles !== []) {
+            // re-apply icc profiles
+            $image->core()->native()->profileImage("icc", $profiles['icc']);
+        }
+        return $image;
+    }
+}
diff --git a/src/Encoders/AvifEncoder.php b/src/Encoders/AvifEncoder.php
@@ -12,9 +12,13 @@ class AvifEncoder extends SpecializableEncoder
      * Create new encoder object
      *
      * @param int $quality
+     * @param null|bool $strip Strip EXIF metadata
      * @return void
      */
-    public function __construct(public int $quality = self::DEFAULT_QUALITY)
-    {
+    public function __construct(
+        public int $quality = self::DEFAULT_QUALITY,
+        public ?bool $strip = null
+    ) {
+        //
     }
 }
diff --git a/src/Encoders/BmpEncoder.php b/src/Encoders/BmpEncoder.php
@@ -10,5 +10,6 @@ class BmpEncoder extends SpecializableEncoder
 {
     public function __construct()
     {
+        //
     }
 }
diff --git a/src/Encoders/GifEncoder.php b/src/Encoders/GifEncoder.php
@@ -16,5 +16,6 @@ class GifEncoder extends SpecializableEncoder
      */
     public function __construct(public bool $interlaced = false)
     {
+        //
     }
 }
diff --git a/src/Encoders/HeicEncoder.php b/src/Encoders/HeicEncoder.php
@@ -12,9 +12,13 @@ class HeicEncoder extends SpecializableEncoder
      * Create new encoder object
      *
      * @param int $quality
+     * @param null|bool $strip Strip EXIF metadata
      * @return void
      */
-    public function __construct(public int $quality = self::DEFAULT_QUALITY)
-    {
+    public function __construct(
+        public int $quality = self::DEFAULT_QUALITY,
+        public ?bool $strip = null
+    ) {
+        //
     }
 }
diff --git a/src/Encoders/Jpeg2000Encoder.php b/src/Encoders/Jpeg2000Encoder.php
@@ -12,9 +12,13 @@ class Jpeg2000Encoder extends SpecializableEncoder
      * Create new encoder object
      *
      * @param int $quality
+     * @param null|bool $strip Strip EXIF metadata
      * @return void
      */
-    public function __construct(public int $quality = self::DEFAULT_QUALITY)
-    {
+    public function __construct(
+        public int $quality = self::DEFAULT_QUALITY,
+        public ?bool $strip = null
+    ) {
+        //
     }
 }
diff --git a/src/Encoders/JpegEncoder.php b/src/Encoders/JpegEncoder.php
@@ -13,11 +13,14 @@ class JpegEncoder extends SpecializableEncoder
      *
      * @param int $quality
      * @param bool $progressive
+     * @param null|bool $strip Strip EXIF metadata
      * @return void
      */
     public function __construct(
         public int $quality = self::DEFAULT_QUALITY,
-        public bool $progressive = false
+        public bool $progressive = false,
+        public ?bool $strip = null
     ) {
+        //
     }
 }
diff --git a/src/Encoders/PngEncoder.php b/src/Encoders/PngEncoder.php
@@ -17,5 +17,6 @@ class PngEncoder extends SpecializableEncoder
      */
     public function __construct(public bool $interlaced = false, public bool $indexed = false)
     {
+        //
     }
 }
diff --git a/src/Encoders/TiffEncoder.php b/src/Encoders/TiffEncoder.php
@@ -12,9 +12,13 @@ class TiffEncoder extends SpecializableEncoder
      * Create new encoder object
      *
      * @param int $quality
+     * @param null|bool $strip Strip EXIF metadata
      * @return void
      */
-    public function __construct(public int $quality = self::DEFAULT_QUALITY)
-    {
+    public function __construct(
+        public int $quality = self::DEFAULT_QUALITY,
+        public ?bool $strip = null
+    ) {
+        //
     }
 }
diff --git a/src/Encoders/WebpEncoder.php b/src/Encoders/WebpEncoder.php
@@ -12,9 +12,12 @@ class WebpEncoder extends SpecializableEncoder
      * Create new encoder object
      *
      * @param int $quality
+     * @param null|bool $strip Strip EXIF metadata
      * @return void
      */
-    public function __construct(public int $quality = self::DEFAULT_QUALITY)
-    {
+    public function __construct(
+        public int $quality = self::DEFAULT_QUALITY,
+        public ?bool $strip = null
+    ) {
     }
 }
diff --git a/tests/Unit/ConfigTest.php b/tests/Unit/ConfigTest.php
@@ -24,11 +24,13 @@ public function testConstructor(): void
             autoOrientation: false,
             decodeAnimation: false,
             blendingColor: 'f00',
+            strip: true,
         );
         $this->assertInstanceOf(Config::class, $config);
 
         $this->assertFalse($config->autoOrientation);
         $this->assertFalse($config->decodeAnimation);
+        $this->assertTrue($config->strip);
         $this->assertEquals('f00', $config->blendingColor);
     }
 
@@ -37,12 +39,14 @@ public function testGetSetOptions(): void
         $config = new Config();
         $this->assertTrue($config->autoOrientation);
         $this->assertTrue($config->decodeAnimation);
+        $this->assertFalse($config->strip);
         $this->assertEquals('ffffff', $config->blendingColor);
 
         $result = $config->setOptions(
             autoOrientation: false,
             decodeAnimation: false,
             blendingColor: 'f00',
+            strip: true,
         );
 
         $this->assertFalse($config->autoOrientation);
@@ -51,16 +55,19 @@ public function testGetSetOptions(): void
 
         $this->assertFalse($result->autoOrientation);
         $this->assertFalse($result->decodeAnimation);
+        $this->assertTrue($result->strip);
         $this->assertEquals('f00', $result->blendingColor);
 
         $result = $config->setOptions(blendingColor: '000');
 
         $this->assertFalse($config->autoOrientation);
         $this->assertFalse($config->decodeAnimation);
+        $this->assertTrue($config->strip);
         $this->assertEquals('000', $config->blendingColor);
 
         $this->assertFalse($result->autoOrientation);
         $this->assertFalse($result->decodeAnimation);
+        $this->assertTrue($result->strip);
         $this->assertEquals('000', $result->blendingColor);
     }
 
@@ -71,13 +78,16 @@ public function testSetOptionsWithArray(): void
             'autoOrientation' => false,
             'decodeAnimation' => false,
             'blendingColor' => 'f00',
+            'strip' => true,
         ]);
 
         $this->assertFalse($config->autoOrientation);
         $this->assertFalse($config->decodeAnimation);
+        $this->assertTrue($config->strip);
         $this->assertEquals('f00', $config->blendingColor);
         $this->assertFalse($result->autoOrientation);
         $this->assertFalse($result->decodeAnimation);
+        $this->assertTrue($result->strip);
         $this->assertEquals('f00', $result->blendingColor);
     }
 }
diff --git a/tests/Unit/Drivers/Imagick/Encoders/AvifEncoderTest.php b/tests/Unit/Drivers/Imagick/Encoders/AvifEncoderTest.php
@@ -4,6 +4,7 @@
 
 namespace Intervention\Image\Tests\Unit\Drivers\Imagick\Encoders;
 
+use Intervention\Image\Drivers\Imagick\Driver;
 use Intervention\Image\Drivers\Imagick\Encoders\AvifEncoder;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\RequiresPhpExtension;
@@ -17,6 +18,7 @@ public function testEncode(): void
     {
         $image = $this->createTestImage(3, 2);
         $encoder = new AvifEncoder(10);
+        $encoder->setDriver(new Driver());
         $result = $encoder->encode($image);
         $this->assertMediaType('image/avif', $result);
         $this->assertEquals('image/avif', $result->mimetype());

diff --git a/tests/Unit/Drivers/Imagick/Encoders/HeicEncoderTest.php b/tests/Unit/Drivers/Imagick/Encoders/HeicEncoderTest.php
@@ -4,6 +4,7 @@
 
 namespace Intervention\Image\Tests\Unit\Drivers\Imagick\Encoders;
 
+use Intervention\Image\Drivers\Imagick\Driver;
 use Intervention\Image\Drivers\Imagick\Encoders\HeicEncoder;
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\RequiresPhpExtension;
@@ -17,6 +18,7 @@ public function testEncode(): void
     {
         $image = $this->createTestImage(3, 2);
         $encoder = new HeicEncoder(75);
+        $encoder->setDriver(new Driver());
         $result = $encoder->encode($image);
         $this->assertMediaType('image/heic', $result);
         $this->assertEquals('image/heic', $result->mimetype());
-Original file line number
+Diff line change
@@ Expand Up / @@ -10,5 +10,6 @@ class BmpEncoder extends SpecializableEncoder @@
     {
         public function __construct()
         {
+            //
         }
     }