From 6e04389e0779f6cc8f858f7128a4b1393e994d9d Mon Sep 17 00:00:00 2001
From: Andy Heathershaw <andy@andys.eu>
Date: Fri, 2 Sep 2016 22:00:42 +0100
Subject: [PATCH] Created my own file-system abstraction layer for album
 storage

---
 .idea/webServers.xml                          |  2 +-
 app/Album.php                                 | 11 +++--
 app/AlbumSources/IAlbumSource.php             | 20 +++++++++
 app/AlbumSources/LocalFilesystemSource.php    | 42 +++++++++++++++++++
 app/Console/Commands/ProcessUploadCommand.php |  6 ++-
 app/Helpers/MiscHelper.php                    | 19 +++++++++
 .../Controllers/Admin/PhotoController.php     | 18 +++-----
 7 files changed, 100 insertions(+), 18 deletions(-)
 create mode 100644 app/AlbumSources/IAlbumSource.php
 create mode 100644 app/AlbumSources/LocalFilesystemSource.php
 create mode 100644 app/Helpers/MiscHelper.php

diff --git a/.idea/webServers.xml b/.idea/webServers.xml
index 6e91a8b..855a61e 100644
--- a/.idea/webServers.xml
+++ b/.idea/webServers.xml
@@ -3,7 +3,7 @@
   <component name="WebServers">
     <option name="servers">
       <webServer id="b14a34b0-0127-4886-964a-7be75a2281ac" name="Development" url="http://blue-twilight-dev.andys.eu">
-        <fileTransfer host="andyhaa1.miniserver.com" port="22" privateKey="C:\Users\andyheathershaw\.ssh\id_rsa" rootFolder="/srv/www/blue-twilight-dev" accessType="SFTP" keyPair="true">
+        <fileTransfer host="andyhaa1.miniserver.com" port="22" rootFolder="/srv/www/blue-twilight-dev" accessType="SFTP">
           <advancedOptions>
             <advancedOptions dataProtectionLevel="Private" />
           </advancedOptions>
diff --git a/app/Album.php b/app/Album.php
index fde9739..e93c21f 100644
--- a/app/Album.php
+++ b/app/Album.php
@@ -2,6 +2,8 @@
 
 namespace App;
 
+use App\AlbumSources\IAlbumSource;
+use App\AlbumSources\LocalFilesystemSource;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Request;
 use Illuminate\Notifications\Notifiable;
@@ -41,9 +43,12 @@ class Album extends Model
         $this->url_alias = ucfirst(preg_replace('/[^a-z0-9\-]/', '-', strtolower($this->name)));
     }
 
-    public function getUploadDisk()
+    /**
+     * @return IAlbumSource
+     */
+    public function getAlbumSource()
     {
-        // TODO allow albums to specify a storage location
-        return 'local';
+        // TODO allow albums to specify different storage locations - e.g. Amazon S3, SFTP/FTP, OpenStack
+        return new LocalFilesystemSource(dirname(__DIR__) . '/storage/app');
     }
 }
\ No newline at end of file
diff --git a/app/AlbumSources/IAlbumSource.php b/app/AlbumSources/IAlbumSource.php
new file mode 100644
index 0000000..645d36f
--- /dev/null
+++ b/app/AlbumSources/IAlbumSource.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace App\AlbumSources;
+
+use App\Album;
+use App\Photo;
+use Symfony\Component\HttpFoundation\File\File;
+
+interface IAlbumSource
+{
+    function getPathToPhoto(Album $album, Photo $photo);
+
+    /**
+     * Saves an uploaded file to the container and returns the filename.
+     * @param Album $album The album containing the photo
+     * @param File $uploadedFile The photo uploaded
+     * @return File
+     */
+    function saveUploadedPhoto(Album $album, File $uploadedFile);
+}
\ No newline at end of file
diff --git a/app/AlbumSources/LocalFilesystemSource.php b/app/AlbumSources/LocalFilesystemSource.php
new file mode 100644
index 0000000..2f994c0
--- /dev/null
+++ b/app/AlbumSources/LocalFilesystemSource.php
@@ -0,0 +1,42 @@
+<?php
+
+namespace App\AlbumSources;
+
+use App\Album;
+use App\Helpers\MiscHelper;
+use App\Photo;
+use Symfony\Component\HttpFoundation\File\File;
+
+class LocalFilesystemSource implements IAlbumSource
+{
+    private $parentFolder;
+
+    public function __construct($parentFolder)
+    {
+        $this->parentFolder = $parentFolder;
+    }
+
+    public function getPathToPhoto(Album $album, Photo $photo)
+    {
+        return sprintf('%s/%s', $this->getPathToAlbum($album), $photo->file_name);
+    }
+
+    public function saveUploadedPhoto(Album $album, File $uploadedFile)
+    {
+        $tempFilename = sprintf('%s/photo_%s', $this->getPathToAlbum($album), MiscHelper::randomString(20));
+
+        $extension = $uploadedFile->guessExtension();
+        if (!is_null($extension))
+        {
+            $tempFilename .= '.' . $extension;
+        }
+
+        $uploadedFile->move(dirname($tempFilename), basename($tempFilename));
+        return new File($tempFilename);
+    }
+
+    private function getPathToAlbum(Album $album)
+    {
+        return sprintf('%s/albums/%s', $this->parentFolder, $album->url_alias);
+    }
+}
\ No newline at end of file
diff --git a/app/Console/Commands/ProcessUploadCommand.php b/app/Console/Commands/ProcessUploadCommand.php
index 8bfbd84..a00a3fa 100644
--- a/app/Console/Commands/ProcessUploadCommand.php
+++ b/app/Console/Commands/ProcessUploadCommand.php
@@ -3,6 +3,7 @@
 namespace App\Console\Commands;
 
 use App\Album;
+use App\AlbumSources\IAlbumSource;
 use App\Photo;
 use App\Upload;
 use App\UploadPhoto;
@@ -70,10 +71,11 @@ class ProcessUploadCommand extends Command
         $photo = $uploadPhoto->photo;
         $this->output->writeln(sprintf('Analysing photo #%d: %s', $photo->id, $photo->name));
 
+        /** @var Album $album */
         $album = $photo->album;
+        $albumSource = $album->getAlbumSource();
 
-        $photoFile = Storage::path(sprintf('albums/%s/%s', $album->url_alias, $photo->file_name), $album->getUploadDisk());
-        dump($photoFile);
+        $photoFile = $albumSource->getPathToPhoto($album, $photo);
 
         dump(@exif_read_data($photoFile));
     }
diff --git a/app/Helpers/MiscHelper.php b/app/Helpers/MiscHelper.php
new file mode 100644
index 0000000..23857b1
--- /dev/null
+++ b/app/Helpers/MiscHelper.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace App\Helpers;
+
+class MiscHelper
+{
+    public static function randomString($length = 10)
+    {
+        $seed = 'abcdefghijklmnopqrstuvwxyz01234567890';
+        $string = '';
+
+        while (strlen($string) < $length)
+        {
+            $string .= substr($seed, rand(0, strlen($seed) - 1), 1);
+        }
+
+        return $string;
+    }
+}
\ No newline at end of file
diff --git a/app/Http/Controllers/Admin/PhotoController.php b/app/Http/Controllers/Admin/PhotoController.php
index cc52d67..d9a0311 100644
--- a/app/Http/Controllers/Admin/PhotoController.php
+++ b/app/Http/Controllers/Admin/PhotoController.php
@@ -2,17 +2,13 @@
 
 namespace App\Http\Controllers\Admin;
 
-use App\Album;
 use App\Photo;
 use App\Upload;
 use App\UploadPhoto;
-use Illuminate\Http\File;
 use Illuminate\Http\Request;
-
-use App\Http\Requests;
 use App\Http\Controllers\Controller;
 use Illuminate\Http\UploadedFile;
-use Illuminate\Support\Facades\Storage;
+use Symfony\Component\HttpFoundation\File\File;
 
 class PhotoController extends Controller
 {
@@ -52,17 +48,15 @@ class PhotoController extends Controller
         // Load the linked album
         $album = AlbumController::loadAlbum($request->get('album_id'));
 
-        $storageLocation = sprintf('albums/%s', $album->url_alias);
-
-        /** @var \SplFileInfo $savedFile */
-        $savedFilePath = $photoFile->store($storageLocation, $album->getUploadDisk());
+        /** @var File $savedFile */
+        $savedFile = $album->getAlbumSource()->saveUploadedPhoto($album, $photoFile);
 
         $photo = new Photo();
         $photo->album_id = $album->id;
         $photo->name = $photoFile->getClientOriginalName();
-        $photo->file_name = basename($savedFilePath);
-        $photo->mime_type = $photoFile->getClientMimeType();
-        $photo->file_size = $photoFile->getSize();
+        $photo->file_name = $savedFile->getFilename();
+        $photo->mime_type = $savedFile->getMimeType();
+        $photo->file_size = $savedFile->getSize();
         $photo->save();
 
         $upload = new Upload();