Merge pull request #696 from code16/store-image-dimension

Allow to store image dimensions

Author: aguingand

src/Form/Eloquent/Uploads/SharpUploadModel.php

@@ -7,6 +7,11 @@
 use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Support\Facades\Storage;
 
+/**
+ * @property array{crop:array{x:float,y:float,width:float,height:float},rotate:array{angle:int}} $filters
+ * @property ?int $width
+ * @property ?int $height
+ */
 class SharpUploadModel extends Model
 {
     use FillsWithFileAttribute;

src/Form/Fields/Formatters/UploadFormatter.php

@@ -6,6 +6,7 @@
 use Code16\Sharp\Form\Fields\SharpFormUploadField;
 use Code16\Sharp\Utils\FileUtil;
 use Code16\Sharp\Utils\Uploads\SharpUploadManager;
+use Illuminate\Filesystem\LocalFilesystemAdapter;
 use Illuminate\Support\Facades\Storage;
 
 class UploadFormatter extends SharpFieldFormatter implements FormatsAfterUpdate
@@ -50,7 +51,7 @@ public function fromFront(SharpFormField $field, string $attribute, $value): ?ar
                 'filters' => $field->isImageTransformOriginal()
                     ? null
                     : $value['filters'] ?? null,
-            ]), function ($formatted) use ($field, $value) {
+            ]), function (&$formatted) use ($field, $value, $uploadedFieldRelativePath) {
                 if ($field->storageDisk()) {
                     app(SharpUploadManager::class)->queueHandleUploadedFile(
                         uploadedFileName: $value['name'],
@@ -63,6 +64,11 @@ public function fromFront(SharpFormField $field, string $attribute, $value): ?ar
                             : null,
                     );
                 }
+
+                if ($dimensions = $this->getImageDimensions($uploadedFieldRelativePath, $formatted['mime_type'])) {
+                    $formatted['width'] = $dimensions['width'];
+                    $formatted['height'] = $dimensions['height'];
+                }
             });
         }
 
@@ -108,4 +114,27 @@ protected function normalizeFromFront(?array $value, ?array $formatted = null):
             'filters' => $formatted['filters'] ?? $value['filters'] ?? null,
         ])->whereNotNull()->toArray();
     }
+
+    protected function getImageDimensions(string $tmpFilePath, string $mimeType): ?array
+    {
+        // image size only available if tmp is stored locally
+        if (! Storage::disk(sharp()->config()->get('uploads.tmp_disk')) instanceof LocalFilesystemAdapter) {
+            return null;
+        }
+
+        if (! str_starts_with($mimeType, 'image/')) {
+            return null;
+        }
+
+        $realPath = Storage::disk(sharp()->config()->get('uploads.tmp_disk'))->path($tmpFilePath);
+
+        if ($size = @getimagesize($realPath)) {
+            return [
+                'width' => $size[0],
+                'height' => $size[1],
+            ];
+        }
+
+        return null;
+    }
 }

tests/Http/Form/FormEditorUploadsTest.php

@@ -98,6 +98,8 @@ public function update($id, array $data)
                 'size' => 1367,
                 'mime_type' => 'image/jpeg',
                 'disk' => 'local',
+                'width' => 200,
+                'height' => 200,
             ]))
         )
     );
@@ -187,6 +189,8 @@ public function update($id, array $data)
                 'size' => 1367,
                 'mime_type' => 'image/jpeg',
                 'disk' => 'local',
+                'width' => 200,
+                'height' => 200,
             ]))
         )
     );

tests/Unit/Form/Eloquent/Uploads/SharpUploadModelTest.php

@@ -15,6 +15,34 @@
     Storage::fake('public');
 });
 
+it('get correct attributes including custom properties', function () {
+    $upload = SharpUploadModel::create([
+        'file_name' => 'test/test.png',
+        'size' => 120,
+        'mime_type' => 'image/png',
+        'disk' => 'local',
+        'model_type' => Person::class,
+        'model_id' => 1,
+        'model_key' => 'test',
+        'custom_properties' => [
+            'filters' => ['rotate' => ['angle' => 10]],
+            'width' => 100,
+            'height' => 100,
+        ],
+    ]);
+    expect($upload->file_name)->toBe('test/test.png')
+        ->and($upload->mime_type)->toBe('image/png')
+        ->and($upload->size)->toBe(120)
+        ->and($upload->disk)->toBe('local')
+        ->and($upload->model_type)->toBe(Person::class)
+        ->and($upload->model_id)->toBe(1)
+        ->and($upload->model_key)->toBe('test')
+        ->and($upload->custom_properties)->toEqual(['filters' => ['rotate' => ['angle' => 10]], 'width' => 100, 'height' => 100])
+        ->and($upload->filters)->toBe(['rotate' => ['angle' => 10]])
+        ->and($upload->width)->toBe(100)
+        ->and($upload->height)->toBe(100);
+});
+
 it('fills several attributes at once at save with the magic "file" attribute', function () {
     $file = createImage();
     $upload = createSharpUploadModel($file);

tests/Unit/Form/Fields/Formatters/EditorFormatterTest.php

@@ -236,6 +236,8 @@
             'size' => 6467,
             'mime_type' => 'image/jpeg',
             'disk' => 'local',
+            'width' => 600,
+            'height' => 600,
         ])),
         e(json_encode([
             'file_name' => 'data/Posts/1/transformed.jpg',

tests/Unit/Form/Fields/Formatters/UploadFormatterTest.php

@@ -127,7 +127,7 @@
     $formatter = app(UploadFormatter::class);
 
     UploadedFile::fake()
-        ->image('image.jpg')
+        ->image('image.jpg', width: 100, height: 100)
         ->storeAs('/tmp', 'image.jpg', ['disk' => 'local']);
 
     $field = SharpFormUploadField::make('upload')->setStorageTemporary();
@@ -143,6 +143,34 @@
             'file_name' => 'tmp/image.jpg',
             'disk' => 'local',
             'mime_type' => 'image/jpeg',
-            'size' => 695,
+            'size' => 887,
+            'width' => 100,
+            'height' => 100,
+        ]);
+});
+
+it('format image from front with width and height', function () {
+    $formatter = app(UploadFormatter::class);
+
+    UploadedFile::fake()
+        ->image('image.jpg', width: 100, height: 100)
+        ->storeAs('/tmp', 'image.jpg', ['disk' => 'local']);
+
+    $field = SharpFormUploadField::make('upload');
+
+    expect(
+        $formatter
+            ->fromFront($field, 'attr', [
+                'name' => 'image.jpg',
+                'uploaded' => true,
+            ])
+    )
+        ->toEqual([
+            'file_name' => 'data/image.jpg',
+            'disk' => 'local',
+            'mime_type' => 'image/jpeg',
+            'size' => 887,
+            'width' => 100,
+            'height' => 100,
         ]);
 });