X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/c32b315cd7d2d302e7f55706f8e69c99d736c66b..refs/pull/3245/head:/app/Uploads/ImageService.php diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php index 13d17f697..e755be7e6 100644 --- a/app/Uploads/ImageService.php +++ b/app/Uploads/ImageService.php @@ -3,18 +3,22 @@ namespace BookStack\Uploads; use BookStack\Exceptions\ImageUploadException; -use Illuminate\Support\Facades\DB; 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\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\ImageManager; +use League\Flysystem\Util; +use Psr\SimpleCache\InvalidArgumentException; use Symfony\Component\HttpFoundation\File\UploadedFile; +use Symfony\Component\HttpFoundation\StreamedResponse; class ImageService { @@ -24,10 +28,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; @@ -38,16 +44,52 @@ class ImageService /** * Get the storage that will be used for storing images. */ - protected function getStorage(string $type = ''): FileSystemInstance + protected function getStorageDisk(string $imageType = ''): Storage + { + return $this->fileSystem->disk($this->getStorageDiskName($imageType)); + } + + /** + * Check if local secure image storage (Fetched behind authentication) + * is currently active in the instance. + */ + protected function usingSecureImages(): bool + { + return $this->getStorageDiskName('gallery') === 'local_secure_images'; + } + + /** + * Change the originally provided path to fit any disk-specific requirements. + * This also ensures the path is kept to the expected root folders. + */ + protected function adjustPathForStorageDisk(string $path, string $imageType = ''): string + { + $path = Util::normalizePath(str_replace('uploads/images/', '', $path)); + + if ($this->getStorageDiskName($imageType) === 'local_secure_images') { + return $path; + } + + return 'uploads/images/' . $path; + } + + /** + * Get the name of the storage disk to use. + */ + protected function getStorageDiskName(string $imageType): string { $storageType = config('filesystems.images'); // Ensure system images (App logo) are uploaded to a public space - if ($type === 'system' && $storageType === 'local_secure') { + if ($imageType === 'system' && $storageType === 'local_secure') { $storageType = 'local'; } - return $this->fileSystem->disk($storageType); + if ($storageType === 'local_secure') { + $storageType = 'local_secure_images'; + } + + return $storageType; } /** @@ -98,13 +140,13 @@ class ImageService */ public function saveNew(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image { - $storage = $this->getStorage($type); + $storage = $this->getStorageDisk($type); $secureUploads = setting('app-secure-images'); $fileName = $this->cleanImageFileName($imageName); $imagePath = '/uploads/images/' . $type . '/' . date('Y-m') . '/'; - while ($storage->exists($imagePath . $fileName)) { + while ($storage->exists($this->adjustPathForStorageDisk($imagePath . $fileName, $type))) { $fileName = Str::random(3) . $fileName; } @@ -114,9 +156,9 @@ class ImageService } try { - $this->saveImageDataInPublicSpace($storage, $fullPath, $imageData); + $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])); } @@ -186,23 +228,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); } @@ -211,45 +262,50 @@ 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); } - $storage = $this->getStorage($image->type); - if ($storage->exists($thumbFilePath)) { + // 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($imagePath), $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); + } - $this->saveImageDataInPublicSpace($storage, $thumbFilePath, $thumbData); - $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 60 * 72); + // 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($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')); } if ($keepRatio) { @@ -279,10 +335,9 @@ class ImageService */ public function getImageData(Image $image): string { - $imagePath = $image->path; - $storage = $this->getStorage(); + $storage = $this->getStorageDisk(); - return $storage->get($imagePath); + return $storage->get($this->adjustPathForStorageDisk($image->path, $image->type)); } /** @@ -292,7 +347,7 @@ class ImageService */ public function destroy(Image $image) { - $this->destroyImagesFromPath($image->path); + $this->destroyImagesFromPath($image->path, $image->type); $image->delete(); } @@ -300,9 +355,10 @@ class ImageService * Destroys an image at the given path. * Searches for image thumbnails in addition to main provided path. */ - protected function destroyImagesFromPath(string $path): bool + protected function destroyImagesFromPath(string $path, string $imageType): bool { - $storage = $this->getStorage(); + $path = $this->adjustPathForStorageDisk($path, $imageType); + $storage = $this->getStorageDisk($imageType); $imageFolder = dirname($path); $imageFileName = basename($path); @@ -326,9 +382,9 @@ class ImageService } /** - * Check whether or not 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); @@ -374,7 +430,7 @@ class ImageService } /** - * Convert a image URI to a Base64 encoded string. + * Convert an image URI to a Base64 encoded string. * Attempts to convert the URL to a system storage url then * fetch the data from the disk or storage location. * Returns null if the image data cannot be fetched from storage. @@ -388,7 +444,8 @@ class ImageService return null; } - $storage = $this->getStorage(); + $storagePath = $this->adjustPathForStorageDisk($storagePath); + $storage = $this->getStorageDisk(); $imageData = null; if ($storage->exists($storagePath)) { $imageData = $storage->get($storagePath); @@ -406,6 +463,44 @@ class ImageService return 'data:image/' . $extension . ';base64,' . base64_encode($imageData); } + /** + * Check if the given path exists in the local secure image system. + * Returns false if local_secure is not in use. + */ + 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 + && strpos($disk->getMimetype($imagePath), 'image/') === 0; + } + + /** + * For the given path, if existing, provide a response that will stream the image contents. + */ + 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". @@ -447,7 +542,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 @@ -461,6 +556,7 @@ class ImageService $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket']; } } + $this->storageUrl = $storageUrl; }