X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/43830a372fc51a8793199d04a34c3f4ebdfccc7b..refs/pull/3598/head:/app/Uploads/ImageService.php diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php index dc18783c5..ca0db997b 100644 --- a/app/Uploads/ImageService.php +++ b/app/Uploads/ImageService.php @@ -5,16 +5,20 @@ namespace BookStack\Uploads; use BookStack\Exceptions\ImageUploadException; use ErrorException; use Exception; +use GuzzleHttp\Psr7\Utils; use Illuminate\Contracts\Cache\Repository as Cache; -use Illuminate\Contracts\Filesystem\Factory as FileSystem; use Illuminate\Contracts\Filesystem\FileNotFoundException; -use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance; use Illuminate\Contracts\Filesystem\Filesystem as Storage; +use Illuminate\Filesystem\FilesystemAdapter; +use Illuminate\Filesystem\FilesystemManager; use Illuminate\Support\Facades\DB; +use Illuminate\Support\Facades\Log; use Illuminate\Support\Str; use Intervention\Image\Exception\NotSupportedException; +use Intervention\Image\Image as InterventionImage; use Intervention\Image\ImageManager; use League\Flysystem\Util; +use Psr\SimpleCache\InvalidArgumentException; use Symfony\Component\HttpFoundation\File\UploadedFile; use Symfony\Component\HttpFoundation\StreamedResponse; @@ -26,10 +30,12 @@ class ImageService protected $image; protected $fileSystem; + protected static $supportedExtensions = ['jpg', 'jpeg', 'png', 'gif', 'webp']; + /** * 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; @@ -40,7 +46,7 @@ class ImageService /** * 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)); } @@ -154,7 +160,7 @@ class ImageService try { $this->saveImageDataInPublicSpace($storage, $this->adjustPathForStorageDisk($fullPath, $type), $imageData); } catch (Exception $e) { - \Log::error('Error when attempting image upload:' . $e->getMessage()); + Log::error('Error when attempting image upload:' . $e->getMessage()); throw new ImageUploadException(trans('errors.path_not_writable', ['filePath' => $fullPath])); } @@ -224,23 +230,32 @@ class ImageService 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. * - * @param Image $image - * @param int $width - * @param int $height - * @param bool $keepRatio - * * @throws Exception - * @throws ImageUploadException - * - * @return string + * @throws InvalidArgumentException */ - public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false) + 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); } @@ -249,47 +264,54 @@ class ImageService $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))) { + $this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72); + 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->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 60 * 72); + $this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72); return $this->getPublicUrl($thumbFilePath); } /** - * Resize image data. - * - * @param string $imageData - * @param int $width - * @param int $height - * @param bool $keepRatio + * Resize the image of given data to the specified size, and return the new image data. * * @throws ImageUploadException - * - * @return string */ - protected function resizeImage(string $imageData, $width = 220, $height = null, bool $keepRatio = true) + protected function resizeImage(string $imageData, ?int $width, ?int $height, bool $keepRatio): string { try { $thumb = $this->imageTool->make($imageData); - } catch (Exception $e) { - if ($e instanceof ErrorException || $e instanceof NotSupportedException) { - throw new ImageUploadException(trans('errors.cannot_create_thumbs')); - } - - throw $e; + } catch (ErrorException|NotSupportedException $e) { + throw new ImageUploadException(trans('errors.cannot_create_thumbs')); } + $this->orientImageToOriginalExif($thumb, $imageData); + if ($keepRatio) { $thumb->resize($width, $height, function ($constraint) { $constraint->aspectRatio(); @@ -310,6 +332,49 @@ class ImageService return $thumbData; } + /** + * Orientate the given intervention image based upon the given original image data. + * Intervention does have an `orientate` method but the exif data it needs is lost before it + * can be used (At least when created using binary string data) so we need to do some + * implementation on our side to use the original image data. + * Bulk of logic taken from: https://github.com/Intervention/image/blob/b734a4988b2148e7d10364b0609978a88d277536/src/Intervention/Image/Commands/OrientateCommand.php + * Copyright (c) Oliver Vogel, MIT License. + */ + protected function orientImageToOriginalExif(InterventionImage $image, string $originalData): void + { + if (!extension_loaded('exif')) { + return; + } + + $stream = Utils::streamFor($originalData)->detach(); + $exif = @exif_read_data($stream); + $orientation = $exif ? ($exif['Orientation'] ?? null) : null; + + switch ($orientation) { + case 2: + $image->flip(); + break; + case 3: + $image->rotate(180); + break; + case 4: + $image->rotate(180)->flip(); + break; + case 5: + $image->rotate(270)->flip(); + break; + case 6: + $image->rotate(270); + break; + case 7: + $image->rotate(90)->flip(); + break; + case 8: + $image->rotate(90); + break; + } + } + /** * Get the raw data content from an image. * @@ -366,7 +431,7 @@ class ImageService /** * 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); @@ -451,10 +516,12 @@ class ImageService */ public function pathExistsInLocalSecure(string $imagePath): bool { + /** @var FilesystemAdapter $disk */ $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 @@ -467,9 +534,20 @@ class ImageService public function streamImageFromStorageResponse(string $imageType, string $path): StreamedResponse { $disk = $this->getStorageDisk($imageType); + return $disk->response($path); } + /** + * Check if the given image extension is supported by BookStack. + * The extension must not be altered in this function. This check should provide a guarantee + * that the provided extension is safe to use for the image to be saved. + */ + public static function isExtensionSupported(string $extension): bool + { + return in_array($extension, static::$supportedExtensions); + } + /** * Get a storage path for the given image URL. * Ensures the path will start with "uploads/images". @@ -511,7 +589,7 @@ class ImageService */ private function getPublicUrl(string $filePath): string { - if ($this->storageUrl === null) { + if (is_null($this->storageUrl)) { $storageUrl = config('filesystems.url'); // Get the standard public s3 url if s3 is set as storage type @@ -525,6 +603,7 @@ class ImageService $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket']; } } + $this->storageUrl = $storageUrl; }