Added ability to secure images behind auth

[bookstack] / app / Services / ImageService.php

diff --git a/app/Services/ImageService.php b/app/Services/ImageService.php
index aa1375487cd943f26afee06a8500c90cc4cb52d1..43375ee094355dd214e7cb9e77af1d328438de8b 100644 (file)
--- a/app/Services/ImageService.php
+++ b/app/Services/ImageService.php
@@ -9,20 +9,13 @@ use Intervention\Image\ImageManager;
 use Illuminate\Contracts\Filesystem\Factory as FileSystem;
 use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance;
 use Illuminate\Contracts\Cache\Repository as Cache;
 use Illuminate\Contracts\Filesystem\Factory as FileSystem;
 use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance;
 use Illuminate\Contracts\Cache\Repository as Cache;

-use Setting;

 use Symfony\Component\HttpFoundation\File\UploadedFile;
 
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 

-class ImageService
+class ImageService extends UploadService

 {
 
     protected $imageTool;
 {
 
     protected $imageTool;

-    protected $fileSystem;

     protected $cache;
     protected $cache;

-
-    /**
-     * @var FileSystemInstance
-     */
-    protected $storageInstance;

     protected $storageUrl;
 
     /**
     protected $storageUrl;
 
     /**


@@ -34,8 +27,8 @@ class ImageService
     public function __construct(ImageManager $imageTool, FileSystem $fileSystem, Cache $cache)
     {
         $this->imageTool = $imageTool;
     public function __construct(ImageManager $imageTool, FileSystem $fileSystem, Cache $cache)
     {
         $this->imageTool = $imageTool;

-        $this->fileSystem = $fileSystem;

         $this->cache = $cache;
         $this->cache = $cache;

+        parent::__construct($fileSystem);

     }
 
     /**
     }
 
     /**


@@ -53,7 +46,6 @@ class ImageService
         return $this->saveNew($imageName, $imageData, $type, $uploadedTo);
     }
 
         return $this->saveNew($imageName, $imageData, $type, $uploadedTo);
     }
 

-

     /**
      * Gets an image from url and saves it to the database.
      * @param             $url
     /**
      * Gets an image from url and saves it to the database.
      * @param             $url


@@ -66,7 +58,7 @@ class ImageService
     {
         $imageName = $imageName ? $imageName : basename($url);
         $imageData = file_get_contents($url);
     {
         $imageName = $imageName ? $imageName : basename($url);
         $imageData = file_get_contents($url);

-        if($imageData === false) throw new \Exception('Cannot get image from ' . $url);
+        if($imageData === false) throw new \Exception(trans('errors.cannot_get_image_from_url', ['url' => $url]));

         return $this->saveNew($imageName, $imageData, $type);
     }
 
         return $this->saveNew($imageName, $imageData, $type);
     }
 


@@ -88,6 +80,7 @@ class ImageService
         if ($secureUploads) $imageName = str_random(16) . '-' . $imageName;
 
         $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/';
         if ($secureUploads) $imageName = str_random(16) . '-' . $imageName;
 
         $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/';

+

         while ($storage->exists($imagePath . $imageName)) {
             $imageName = str_random(3) . $imageName;
         }
         while ($storage->exists($imagePath . $imageName)) {
             $imageName = str_random(3) . $imageName;
         }


@@ -97,7 +90,7 @@ class ImageService
             $storage->put($fullPath, $imageData);
             $storage->setVisibility($fullPath, 'public');
         } catch (Exception $e) {
             $storage->put($fullPath, $imageData);
             $storage->setVisibility($fullPath, 'public');
         } catch (Exception $e) {

-            throw new ImageUploadException('Image Path ' . $fullPath . ' is not writable by the server.');
+            throw new ImageUploadException(trans('errors.path_not_writable', ['filePath' => $fullPath]));

         }
 
         $imageDetails = [
         }
 
         $imageDetails = [


@@ -108,22 +101,31 @@ class ImageService
             'uploaded_to' => $uploadedTo
         ];
 
             'uploaded_to' => $uploadedTo
         ];
 

-        if (auth()->user() && auth()->user()->id !== 0) {
-            $userId = auth()->user()->id;
+        if (user()->id !== 0) {
+            $userId = user()->id;

             $imageDetails['created_by'] = $userId;
             $imageDetails['updated_by'] = $userId;
         }
 
             $imageDetails['created_by'] = $userId;
             $imageDetails['updated_by'] = $userId;
         }
 

-        $image = Image::forceCreate($imageDetails);
-
+        $image = (new Image());
+        $image->forceFill($imageDetails)->save();

         return $image;
     }
 
         return $image;
     }
 

+    /**
+     * Get the storage path, Dependant of storage type.
+     * @param Image $image
+     * @return mixed|string
+     */
+    protected function getPath(Image $image)
+    {
+        return $image->path;
+    }
+

     /**
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.
     /**
      * Get the thumbnail for an image.
      * If $keepRatio is true only the width will be used.
      * Checks the cache then storage to avoid creating / accessing the filesystem on every check.

-     *

      * @param Image $image
      * @param int $width
      * @param int $height
      * @param Image $image
      * @param int $width
      * @param int $height


@@ -135,26 +137,25 @@ class ImageService
     public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
     {
         $thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/';
     public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false)
     {
         $thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/';

-        $thumbFilePath = dirname($image->path) . $thumbDirName . basename($image->path);
+        $imagePath = $this->getPath($image);
+        $thumbFilePath = dirname($imagePath) . $thumbDirName . basename($imagePath);

 
         if ($this->cache->has('images-' . $image->id . '-' . $thumbFilePath) && $this->cache->get('images-' . $thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }
 
         $storage = $this->getStorage();
 
         if ($this->cache->has('images-' . $image->id . '-' . $thumbFilePath) && $this->cache->get('images-' . $thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }
 
         $storage = $this->getStorage();

-

         if ($storage->exists($thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }
 
         try {
         if ($storage->exists($thumbFilePath)) {
             return $this->getPublicUrl($thumbFilePath);
         }
 
         try {

-            $thumb = $this->imageTool->make($storage->get($image->path));
+            $thumb = $this->imageTool->make($storage->get($imagePath));

         } catch (Exception $e) {
             if ($e instanceof \ErrorException || $e instanceof NotSupportedException) {
         } catch (Exception $e) {
             if ($e instanceof \ErrorException || $e instanceof NotSupportedException) {

-                throw new ImageUploadException('The server cannot create thumbnails. Please check you have the GD PHP extension installed.');
-            } else {
-                throw $e;
+                throw new ImageUploadException(trans('errors.cannot_create_thumbs'));

             }
             }

+            throw $e;

         }
 
         if ($keepRatio) {
         }
 
         if ($keepRatio) {


@@ -183,8 +184,8 @@ class ImageService
     {
         $storage = $this->getStorage();
 
     {
         $storage = $this->getStorage();
 

-        $imageFolder = dirname($image->path);
-        $imageFileName = basename($image->path);
+        $imageFolder = dirname($this->getPath($image));
+        $imageFileName = basename($this->getPath($image));

         $allImages = collect($storage->allFiles($imageFolder));
 
         $imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) {
         $allImages = collect($storage->allFiles($imageFolder));
 
         $imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) {


@@ -222,35 +223,9 @@ class ImageService
         return $image;
     }
 
         return $image;
     }
 

-    /**
-     * Get the storage that will be used for storing images.
-     * @return FileSystemInstance
-     */
-    private function getStorage()
-    {
-        if ($this->storageInstance !== null) return $this->storageInstance;
-
-        $storageType = config('filesystems.default');
-        $this->storageInstance = $this->fileSystem->disk($storageType);
-
-        return $this->storageInstance;
-    }
-
-    /**
-     * Check whether or not a folder is empty.
-     * @param $path
-     * @return int
-     */
-    private function isFolderEmpty($path)
-    {
-        $files = $this->getStorage()->files($path);
-        $folders = $this->getStorage()->directories($path);
-        return count($files) === 0 && count($folders) === 0;
-    }
-

     /**
      * Gets a public facing url for an image by checking relevant environment variables.
     /**
      * Gets a public facing url for an image by checking relevant environment variables.

-     * @param $filePath
+     * @param string $filePath

      * @return string
      */
     private function getPublicUrl($filePath)
      * @return string
      */
     private function getPublicUrl($filePath)


@@ -269,11 +244,11 @@ class ImageService
                     $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
                 }
             }
                     $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
                 }
             }

-

             $this->storageUrl = $storageUrl;
         }
 
             $this->storageUrl = $storageUrl;
         }
 

-        return ($this->storageUrl == false ? rtrim(baseUrl(''), '/') : rtrim($this->storageUrl, '/')) . $filePath;
+        $basePath = ($this->storageUrl == false) ? baseUrl('/') : $this->storageUrl;
+        return rtrim($basePath, '/') . $filePath;

     }
 
 
     }