doc(dev): add xdebug informations

[bookstack] / app / Uploads / ImageService.php

diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php
index eb2fc57b802cf457fab9cee033185cdc7c7b1e33..e755be7e6e7c261adfd8e49ef1d344957983013f 100644 (file)
--- a/app/Uploads/ImageService.php
+++ b/app/Uploads/ImageService.php
@@ -6,16 +6,16 @@ use BookStack\Exceptions\ImageUploadException;
 use ErrorException;
 use Exception;
 use Illuminate\Contracts\Cache\Repository as Cache;
 use ErrorException;
 use Exception;
 use Illuminate\Contracts\Cache\Repository as Cache;

-use Illuminate\Contracts\Filesystem\Factory as FileSystem;

 use Illuminate\Contracts\Filesystem\FileNotFoundException;
 use Illuminate\Contracts\Filesystem\FileNotFoundException;

-use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance;

 use Illuminate\Contracts\Filesystem\Filesystem as Storage;
 use Illuminate\Contracts\Filesystem\Filesystem as Storage;

+use Illuminate\Filesystem\FilesystemAdapter;
+use Illuminate\Filesystem\FilesystemManager;

 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\DB;

+use Illuminate\Support\Facades\Log;

 use Illuminate\Support\Str;
 use Intervention\Image\Exception\NotSupportedException;
 use Intervention\Image\ImageManager;
 use League\Flysystem\Util;
 use Illuminate\Support\Str;
 use Intervention\Image\Exception\NotSupportedException;
 use Intervention\Image\ImageManager;
 use League\Flysystem\Util;

-use Log;

 use Psr\SimpleCache\InvalidArgumentException;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 use Symfony\Component\HttpFoundation\StreamedResponse;
 use Psr\SimpleCache\InvalidArgumentException;
 use Symfony\Component\HttpFoundation\File\UploadedFile;
 use Symfony\Component\HttpFoundation\StreamedResponse;


@@ -33,7 +33,7 @@ class ImageService
     /**
      * ImageService constructor.
      */
     /**
      * ImageService constructor.
      */

-    public function __construct(Image $image, ImageManager $imageTool, FileSystem $fileSystem, Cache $cache)
+    public function __construct(Image $image, ImageManager $imageTool, FilesystemManager $fileSystem, Cache $cache)

     {
         $this->image = $image;
         $this->imageTool = $imageTool;
     {
         $this->image = $image;
         $this->imageTool = $imageTool;


@@ -44,7 +44,7 @@ class ImageService
     /**
      * Get the storage that will be used for storing images.
      */
     /**
      * Get the storage that will be used for storing images.
      */

-    protected function getStorageDisk(string $imageType = ''): FileSystemInstance
+    protected function getStorageDisk(string $imageType = ''): Storage

     {
         return $this->fileSystem->disk($this->getStorageDiskName($imageType));
     }
     {
         return $this->fileSystem->disk($this->getStorageDiskName($imageType));
     }


@@ -228,15 +228,32 @@ class ImageService
         return strtolower(pathinfo($image->path, PATHINFO_EXTENSION)) === 'gif';
     }
 
         return strtolower(pathinfo($image->path, PATHINFO_EXTENSION)) === 'gif';
     }
 

+    /**
+     * Check if the given image and image data is apng.
+     */
+    protected function isApngData(Image $image, string &$imageData): bool
+    {
+        $isPng = strtolower(pathinfo($image->path, PATHINFO_EXTENSION)) === 'png';
+        if (!$isPng) {
+            return false;
+        }
+
+        $initialHeader = substr($imageData, 0, strpos($imageData, 'IDAT'));
+
+        return strpos($initialHeader, 'acTL') !== false;
+    }
+

     /**
      * 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.

+     *

      * @throws Exception
      * @throws InvalidArgumentException
      */
     public function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio = false): string
     {
      * @throws Exception
      * @throws InvalidArgumentException
      */
     public function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio = false): string
     {

+        // Do not resize GIF images where we're not cropping

         if ($keepRatio && $this->isGif($image)) {
             return $this->getPublicUrl($image->path);
         }
         if ($keepRatio && $this->isGif($image)) {
             return $this->getPublicUrl($image->path);
         }


@@ -245,19 +262,35 @@ class ImageService
         $imagePath = $image->path;
         $thumbFilePath = dirname($imagePath) . $thumbDirName . basename($imagePath);
 
         $imagePath = $image->path;
         $thumbFilePath = dirname($imagePath) . $thumbDirName . basename($imagePath);
 

-        if ($this->cache->has('images-' . $image->id . '-' . $thumbFilePath) && $this->cache->get('images-' . $thumbFilePath)) {
-            return $this->getPublicUrl($thumbFilePath);
+        $thumbCacheKey = 'images::' . $image->id . '::' . $thumbFilePath;
+
+        // Return path if in cache
+        $cachedThumbPath = $this->cache->get($thumbCacheKey);
+        if ($cachedThumbPath) {
+            return $this->getPublicUrl($cachedThumbPath);

         }
 
         }
 

+        // If thumbnail has already been generated, serve that and cache path

         $storage = $this->getStorageDisk($image->type);
         if ($storage->exists($this->adjustPathForStorageDisk($thumbFilePath, $image->type))) {
         $storage = $this->getStorageDisk($image->type);
         if ($storage->exists($this->adjustPathForStorageDisk($thumbFilePath, $image->type))) {

+            $this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72);
+

             return $this->getPublicUrl($thumbFilePath);
         }
 
             return $this->getPublicUrl($thumbFilePath);
         }
 

-        $thumbData = $this->resizeImage($storage->get($this->adjustPathForStorageDisk($imagePath, $image->type)), $width, $height, $keepRatio);
+        $imageData = $storage->get($this->adjustPathForStorageDisk($imagePath, $image->type));
+
+        // Do not resize apng images where we're not cropping
+        if ($keepRatio && $this->isApngData($image, $imageData)) {
+            $this->cache->put($thumbCacheKey, $image->path, 60 * 60 * 72);

 
 

+            return $this->getPublicUrl($image->path);
+        }
+
+        // If not in cache and thumbnail does not exist, generate thumb and cache path
+        $thumbData = $this->resizeImage($imageData, $width, $height, $keepRatio);

         $this->saveImageDataInPublicSpace($storage, $this->adjustPathForStorageDisk($thumbFilePath, $image->type), $thumbData);
         $this->saveImageDataInPublicSpace($storage, $this->adjustPathForStorageDisk($thumbFilePath, $image->type), $thumbData);

-        $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 60 * 72);
+        $this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72);

 
         return $this->getPublicUrl($thumbFilePath);
     }
 
         return $this->getPublicUrl($thumbFilePath);
     }


@@ -271,7 +304,7 @@ class ImageService
     {
         try {
             $thumb = $this->imageTool->make($imageData);
     {
         try {
             $thumb = $this->imageTool->make($imageData);

-        } catch (ErrorException | NotSupportedException $e) {
+        } catch (ErrorException|NotSupportedException $e) {

             throw new ImageUploadException(trans('errors.cannot_create_thumbs'));
         }
 
             throw new ImageUploadException(trans('errors.cannot_create_thumbs'));
         }
 


@@ -351,7 +384,7 @@ class ImageService
     /**
      * Check whether a folder is empty.
      */
     /**
      * Check whether a folder is empty.
      */

-    protected function isFolderEmpty(FileSystemInstance $storage, string $path): bool
+    protected function isFolderEmpty(Storage $storage, string $path): bool

     {
         $files = $storage->files($path);
         $folders = $storage->directories($path);
     {
         $files = $storage->files($path);
         $folders = $storage->directories($path);


@@ -436,10 +469,12 @@ class ImageService
      */
     public function pathExistsInLocalSecure(string $imagePath): bool
     {
      */
     public function pathExistsInLocalSecure(string $imagePath): bool
     {

+        /** @var FilesystemAdapter $disk */

         $disk = $this->getStorageDisk('gallery');
 
         // Check local_secure is active
         return $this->usingSecureImages()
         $disk = $this->getStorageDisk('gallery');
 
         // Check local_secure is active
         return $this->usingSecureImages()

+            && $disk instanceof FilesystemAdapter

             // Check the image file exists
             && $disk->exists($imagePath)
             // Check the file is likely an image file
             // Check the image file exists
             && $disk->exists($imagePath)
             // Check the file is likely an image file


@@ -452,6 +487,7 @@ class ImageService
     public function streamImageFromStorageResponse(string $imageType, string $path): StreamedResponse
     {
         $disk = $this->getStorageDisk($imageType);
     public function streamImageFromStorageResponse(string $imageType, string $path): StreamedResponse
     {
         $disk = $this->getStorageDisk($imageType);

+

         return $disk->response($path);
     }
 
         return $disk->response($path);
     }