GPS (#29)

* wip

* Refactoring

app/Actions/Photos/ExtractLocationFromPhotoAction.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace App\Actions\Photos;
+
+use Illuminate\Http\UploadedFile;
+use Intervention\Image\Drivers\Gd\Driver;
+use Intervention\Image\ImageManager;
+
+class ExtractLocationFromPhotoAction implements ExtractsLocationFromPhoto
+{
+    public function run(UploadedFile $photo): array
+    {
+        $manager = new ImageManager(new Driver());
+        $image = $manager->read($photo);
+        $exif = $image->exif('GPS');
+
+        if ($this->isExifInvalid($exif)) {
+            return [];
+        }
+
+        $result = $this->convertArrayToLatLng((array) $exif);
+
+        if ($result['latitude'] === 0.0 && $result['longitude'] === 0.0) {
+            return [];
+        }
+
+        return $result;
+    }
+
+    private function convertArrayToLatLng(array $exif): array
+    {
+        $GPSLatitudeRef = $exif['GPSLatitudeRef'];
+        $GPSLatitude = $exif['GPSLatitude'];
+        $GPSLongitudeRef = $exif['GPSLongitudeRef'];
+        $GPSLongitude = $exif['GPSLongitude'];
+
+        $latDegrees = $this->gpsToNumeric($GPSLatitude[0] ?? null);
+        $latMinutes = $this->gpsToNumeric($GPSLatitude[1] ?? null);
+        $latSeconds = $this->gpsToNumeric($GPSLatitude[2] ?? null);
+
+        $lonDegrees = $this->gpsToNumeric($GPSLongitude[0] ?? null);
+        $lonMinutes = $this->gpsToNumeric($GPSLongitude[1] ?? null);
+        $lonSeconds = $this->gpsToNumeric($GPSLongitude[2] ?? null);
+
+        $latDirection = ($GPSLatitudeRef === 'W' || $GPSLatitudeRef === 'S') ? -1 : 1;
+        $lonDirection = ($GPSLongitudeRef === 'W' || $GPSLongitudeRef === 'S') ? -1 : 1;
+
+        $latitude = $latDirection * ($latDegrees + ($latMinutes / 60) + ($latSeconds / (60 * 60)));
+        $longitude = $lonDirection * ($lonDegrees + ($lonMinutes / 60) + ($lonSeconds / (60 * 60)));
+
+        return ['latitude' => $latitude, 'longitude' => $longitude];
+    }
+
+    private function gpsToNumeric(?string $coordinates): float
+    {
+        if (! $coordinates) {
+            return 0.0;
+        }
+
+        $parts = explode('/', $coordinates);
+
+        if ($parts === []) {
+            return 0.0;
+        }
+
+        if (count($parts) === 1) {
+            return (float) $parts[0];
+        }
+
+        if ((float) $parts[1] === 0.0) {
+            return 0.0;
+        }
+
+        return (float) $parts[0] / (float) $parts[1];
+    }
+
+    private function isExifInvalid(mixed $exif): bool
+    {
+        return ! $exif ||
+            ! isset($exif['GPSLatitudeRef']) ||
+            ! isset($exif['GPSLatitude']) ||
+            ! isset($exif['GPSLongitudeRef']) ||
+            ! isset($exif['GPSLongitude']);
+    }
+}

app/Actions/Photos/ExtractsLocationFromPhoto.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace App\Actions\Photos;
+
+use Illuminate\Http\UploadedFile;
+
+interface ExtractsLocationFromPhoto
+{
+    public function run(UploadedFile $photo): array;
+}

app/Http/Controllers/UploadPhotosController.php

@@ -2,22 +2,29 @@
 
 namespace App\Http\Controllers;
 
+use App\Actions\Photos\ExtractsLocationFromPhoto;
 use App\Http\Requests\StorePhotosRequest;
 use App\Models\Photo;
 
 class UploadPhotosController extends Controller
 {
-    public function store(StorePhotosRequest $request)
-    {
+    public function store(
+        StorePhotosRequest $request,
+        ExtractsLocationFromPhoto $extractLocation,
+    ): array {
         $user = auth()->user();
 
         $photo = $request->file('photo');
 
+        $location = $extractLocation->run($photo);
+
         $originalFileName = $photo->getClientOriginalName();
 
         Photo::create([
-            'path' => $photo->storeAs('photos', $originalFileName, 'public'),
             'user_id' => $user->id,
+            'path' => $photo->storeAs('photos', $originalFileName, 'public'),
+            'latitude' => $location['latitude'] ?? null,
+            'longitude' => $location['longitude'] ?? null,
         ]);
 
         return [];

app/Providers/AppServiceProvider.php

@@ -2,6 +2,8 @@
 
 namespace App\Providers;
 
+use App\Actions\Photos\ExtractLocationFromPhotoAction;
+use App\Actions\Photos\ExtractsLocationFromPhoto;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\ServiceProvider;
@@ -24,5 +26,9 @@ public function boot(): void
         Schema::defaultStringLength(191);
 
         Model::unguard();
+
+        Model::shouldBeStrict();
+
+        $this->app->bind(ExtractsLocationFromPhoto::class, ExtractLocationFromPhotoAction::class);
     }
 }

composer.json

@@ -12,6 +12,7 @@
         "filament/filament": "^3.1",
         "guzzlehttp/guzzle": "^7.2",
         "inertiajs/inertia-laravel": "^0.6.8",
+        "intervention/image": "^3.2",
         "laravel/framework": "^10.10",
         "laravel/jetstream": "^3.2",
         "laravel/sanctum": "^3.2",

database/migrations/2024_01_10_143605_add_location_info_to_photos.php

@@ -0,0 +1,16 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::table('photos', function (Blueprint $table) {
+            $table->decimal('latitude', 10, 8)->after('path')->nullable();
+            $table->decimal('longitude', 11, 8)->after('latitude')->nullable();
+        });
+    }
+};

tests/Doubles/FakeExtractLocationFromPhotoAction.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Tests\Doubles;
+
+use App\Actions\Photos\ExtractsLocationFromPhoto;
+use Illuminate\Http\UploadedFile;
+
+class FakeExtractLocationFromPhotoAction implements ExtractsLocationFromPhoto
+{
+    public function run(UploadedFile $photo): array
+    {
+        return [];
+    }
+}

tests/Feature/Photos/UploadPhotosTest.php

@@ -1,5 +1,7 @@
 <?php
 
+use App\Actions\Photos\ExtractLocationFromPhotoAction;
+use App\Actions\Photos\ExtractsLocationFromPhoto;
 use App\Models\User;
 use Illuminate\Http\UploadedFile;
 use Illuminate\Support\Facades\Storage;
@@ -22,6 +24,27 @@
     Storage::disk('public')->assertExists('photos/photo.jpg');
 });
 
+test('a user can upload photos with location data', function () {
+    Storage::fake('public');
+    $this->swap(ExtractsLocationFromPhoto::class, new ExtractLocationFromPhotoAction());
+    $this->actingAs($user = User::factory()->create());
+
+    $file = UploadedFile::fake()->createWithContent(
+        'photo.jpg',
+        file_get_contents(storage_path('app/photo-with-gps.jpg')),
+    );
+
+    $response = $this->post('/upload', ['photo' => $file]);
+
+    $response->assertOk();
+
+    expect($user->photos()->count())->toBe(1);
+
+    $photo = $user->photos()->first();
+    expect($photo->latitude)->toBe(40.053030045789)
+        ->and($photo->longitude)->toBe(-77.15449870066);
+});
+
 test('a photo can not be larger than 20MB', function () {
     Storage::fake('public');
     $this->actingAs($user = User::factory()->create());

tests/TestCase.php

@@ -2,7 +2,9 @@
 
 namespace Tests;
 
+use App\Actions\Photos\ExtractsLocationFromPhoto;
 use Illuminate\Foundation\Testing\TestCase as BaseTestCase;
+use Tests\Doubles\FakeExtractLocationFromPhotoAction;
 
 abstract class TestCase extends BaseTestCase
 {
@@ -13,5 +15,7 @@ protected function setUp(): void
         parent::setUp();
 
         $this->withoutVite();
+
+        $this->swap(ExtractsLocationFromPhoto::class, new FakeExtractLocationFromPhotoAction());
     }
 }