Merge pull request #7 from smmehdisharifi/feature/configurable-structure-for-flatten-images

configurable structure for flatten images

Author: imahmood

config/file-storage.php

@@ -19,6 +19,7 @@
                 'jfif' => 'jpg',
                 'heic' => 'jpg',
             ],
+            'flatten' => true,
         ],
         DownscaleModifier::class => [
             'width' => 2000,
@@ -28,6 +29,7 @@
             'width' => 150,
             'height' => 150,
             'format' => 'jpg',
+            'flatten' => true,
         ],
     ],
 ];

src/Modifiers/DownscaleModifier.php

@@ -31,6 +31,7 @@ public function handle(Media $media): Media
             targetFile: $media->original_relative_path,
             width: $this->options['width'],
             height: $this->options['height'],
+            flatten: false,
         );
 
         return $media;

src/Modifiers/FormatModifier.php

@@ -19,10 +19,13 @@ public function __construct(
 
     public function canHandle(Media $media): bool
     {
-        $formats = array_keys($this->options['formats']);
-        $ext = pathinfo($media->file_name, PATHINFO_EXTENSION);
+        if (! $media->is_image) {
+            return false;
+        }
+
+        [$sourceExt, $targetExt, $flatten] = $this->resolveOptions($media);
 
-        return $media->is_image && in_array($ext, $formats, true);
+        return $targetExt !== $sourceExt || $flatten;
     }
 
     /**
@@ -33,23 +36,35 @@ public function canHandle(Media $media): bool
      */
     public function handle(Media $media): Media
     {
+        [, $targetExt, $flatten] = $this->resolveOptions($media);
         $originalFile = $media->original_relative_path;
-        $ext = pathinfo($media->file_name, PATHINFO_EXTENSION);
-        $newName = pathinfo($originalFile, PATHINFO_FILENAME).'.'.$this->options['formats'][$ext];
+        $newName = pathinfo($originalFile, PATHINFO_FILENAME).'.'.$targetExt;
 
         $this->image->convert(
             disk: $media->disk,
             sourceFile: $originalFile,
             targetFile: $media->dir_relative_path.$newName,
+            flatten: $flatten,
         );
 
         $media->file_name = $newName;
         if (! $media->save()) {
             throw new PersistenceFailedException;
         }
 
-        $this->filesystem->deleteFile($media->disk, $originalFile);
+        if ($media->wasChanged('file_name')) {
+            $this->filesystem->deleteFile($media->disk, $originalFile);
+        }
 
         return $media;
     }
+
+    private function resolveOptions(Media $media): array
+    {
+        $sourceExt = pathinfo($media->file_name, PATHINFO_EXTENSION);
+        $targetExt = $this->options['formats'][$sourceExt] ?? $sourceExt;
+        $flatten = $this->options['flatten'] ?? false;
+
+        return [$sourceExt, $targetExt, $flatten];
+    }
 }

src/Modifiers/PreviewModifier.php

@@ -38,6 +38,7 @@ public function handle(Media $media): Media
             targetFile: $media->dir_relative_path.$media->preview,
             width: $this->options['width'],
             height: $this->options['height'],
+            flatten: $this->options['flatten'] ?? false,
         );
 
         if (! $media->save()) {

src/Utility/Image.php

@@ -10,60 +10,65 @@
 class Image
 {
     /**
+     * Resize the image and save it.
+     *
      * @throws \Imahmood\FileStorage\Exceptions\NotWritableException
      * @throws \Jcupitt\Vips\Exception
      */
-    public function resize(string $disk, string $sourceFile, string $targetFile, int $width, int $height): void
+    public function resize(string $disk, string $sourceFile, string $targetFile, int $width, int $height, bool $flatten): void
     {
-        $image = VipsImage::newFromBuffer(
-            Storage::disk($disk)->get($sourceFile)
-        );
-
-        if ($image->hasAlpha()) {
-            $image = $image->flatten(['background' => [255, 255, 255]]);
-        }
+        $image = $this->loadImage($disk, $sourceFile);
 
         $width = min($image->width, $width);
         $height = min($image->height, $height);
-        $ext = pathinfo($targetFile, PATHINFO_EXTENSION);
-
-        $saved = Storage::disk($disk)->put(
-            path: $targetFile,
-            contents: $image->thumbnail_image($width, ['height' => $height])->writeToBuffer('.'.$ext),
-        );
-
-        $image = null;
 
-        if ($saved === false) {
-            throw new NotWritableException("Can't write image data to path `$targetFile`");
+        if ($flatten && $image->hasAlpha()) {
+            $image = $image->flatten(['background' => [255, 255, 255]]);
         }
+
+        $image = $image->thumbnail_image($width, ['height' => $height]);
+        $this->saveImage($disk, $targetFile, $image);
     }
 
     /**
+     * Convert the image format and save it.
+     *
      * @throws \Imahmood\FileStorage\Exceptions\NotWritableException
      * @throws \Jcupitt\Vips\Exception
      */
-    public function convert(string $disk, string $sourceFile, string $targetFile): void
+    public function convert(string $disk, string $sourceFile, string $targetFile, bool $flatten): void
     {
-        $image = VipsImage::newFromBuffer(
-            Storage::disk($disk)->get($sourceFile)
-        );
+        $image = $this->loadImage($disk, $sourceFile);
 
-        if ($image->hasAlpha()) {
+        if ($flatten && $image->hasAlpha()) {
             $image = $image->flatten(['background' => [255, 255, 255]]);
         }
 
-        $ext = pathinfo($targetFile, PATHINFO_EXTENSION);
+        $this->saveImage($disk, $targetFile, $image);
+    }
 
-        $saved = Storage::disk($disk)->put(
-            path: $targetFile,
-            contents: $image->writeToBuffer('.'.$ext),
-        );
+    /**
+     * Load image from storage.
+     */
+    private function loadImage(string $disk, string $path): VipsImage
+    {
+        $content = Storage::disk($disk)->get($path);
+
+        return VipsImage::newFromBuffer($content);
+    }
 
-        $image = null;
+    /**
+     * Save image to storage.
+     *
+     * @throws \Imahmood\FileStorage\Exceptions\NotWritableException
+     */
+    private function saveImage(string $disk, string $path, VipsImage $image): void
+    {
+        $extension = '.'.pathinfo($path, PATHINFO_EXTENSION);
+        $buffer = $image->writeToBuffer($extension);
 
-        if ($saved === false) {
-            throw new NotWritableException("Can't write image data to path `$targetFile`");
+        if (! Storage::disk($disk)->put($path, $buffer)) {
+            throw new NotWritableException("Can't write image data to path `$path`");
         }
     }
 }