X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/60ffe6a993b6ef3c241966a94d1d23b5324f3e8b..refs/pull/3598/head:/app/Uploads/ImageService.php diff --git a/app/Uploads/ImageService.php b/app/Uploads/ImageService.php index 010b531f1..ca0db997b 100644 --- a/app/Uploads/ImageService.php +++ b/app/Uploads/ImageService.php @@ -1,17 +1,26 @@ -image = $image; $this->imageTool = $imageTool; @@ -35,22 +46,60 @@ 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; } /** * Saves a new image from an upload. - * @return mixed + * * @throws ImageUploadException + * + * @return mixed */ public function saveNewFromUpload( UploadedFile $uploadedFile, @@ -72,31 +121,34 @@ class ImageService /** * Save a new image from a uri-encoded base64 string of data. + * * @throws ImageUploadException */ public function saveNewFromBase64Uri(string $base64Uri, string $name, string $type, int $uploadedTo = 0): Image { $splitData = explode(';base64,', $base64Uri); if (count($splitData) < 2) { - throw new ImageUploadException("Invalid base64 image data provided"); + throw new ImageUploadException('Invalid base64 image data provided'); } $data = base64_decode($splitData[1]); + return $this->saveNew($name, $data, $type, $uploadedTo); } /** * Save a new image into storage. + * * @throws ImageUploadException */ 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') . '/'; + $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; } @@ -106,19 +158,19 @@ class ImageService } try { - $storage->put($fullPath, $imageData); - $storage->setVisibility($fullPath, 'public'); + $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])); } $imageDetails = [ - 'name' => $imageName, - 'path' => $fullPath, - 'url' => $this->getPublicUrl($fullPath), - 'type' => $type, - 'uploaded_to' => $uploadedTo + 'name' => $imageName, + 'path' => $fullPath, + 'url' => $this->getPublicUrl($fullPath), + 'type' => $type, + 'uploaded_to' => $uploadedTo, ]; if (user()->id !== 0) { @@ -129,9 +181,29 @@ class ImageService $image = $this->image->newInstance(); $image->forceFill($imageDetails)->save(); + return $image; } + /** + * Save image data for the given path in the public space, if possible, + * for the provided storage mechanism. + */ + protected function saveImageDataInPublicSpace(Storage $storage, string $path, string $data) + { + $storage->put($path, $data); + + // Set visibility when a non-AWS-s3, s3-like storage option is in use. + // Done since this call can break s3-like services but desired for other image stores. + // Attempting to set ACL during above put request requires different permissions + // hence would technically be a breaking change for actual s3 usage. + $usingS3 = strtolower(config('filesystems.images')) === 's3'; + $usingS3Like = $usingS3 && !is_null(config('filesystems.disks.s3.endpoint')); + if (!$usingS3Like) { + $storage->setVisibility($path, 'public'); + } + } + /** * Clean up an image file name to be both URL and storage safe. */ @@ -158,20 +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 - * @return string + * * @throws Exception - * @throws ImageUploadException + * @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); } @@ -180,45 +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); } - $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); - $storage->put($thumbFilePath, $thumbData); - $storage->setVisibility($thumbFilePath, 'public'); - $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 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($thumbCacheKey, $thumbFilePath, 60 * 60 * 72); return $this->getPublicUrl($thumbFilePath); } /** - * Resize image data. - * @param string $imageData - * @param int $width - * @param int $height - * @param bool $keepRatio - * @return string + * Resize the image of given data to the specified size, and return the new image data. + * * @throws ImageUploadException */ - 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(); @@ -228,7 +321,7 @@ class ImageService $thumb->fit($width, $height); } - $thumbData = (string)$thumb->encode(); + $thumbData = (string) $thumb->encode(); // Use original image data if we're keeping the ratio // and the resizing does not save any space. @@ -239,24 +332,69 @@ 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. + * * @throws FileNotFoundException */ public function getImageData(Image $image): string { - $imagePath = $image->path; - $storage = $this->getStorage(); - return $storage->get($imagePath); + $storage = $this->getStorageDisk(); + + return $storage->get($this->adjustPathForStorageDisk($image->path, $image->type)); } /** * Destroy an image along with its revisions, thumbnails and remaining folders. + * * @throws Exception */ public function destroy(Image $image) { - $this->destroyImagesFromPath($image->path); + $this->destroyImagesFromPath($image->path, $image->type); $image->delete(); } @@ -264,9 +402,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); @@ -290,13 +429,14 @@ 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); - return (count($files) === 0 && count($folders) === 0); + + return count($files) === 0 && count($folders) === 0; } /** @@ -332,14 +472,16 @@ class ImageService } } }); + return $deletedPaths; } /** - * 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. + * * @throws FileNotFoundException */ public function imageUriToBase64(string $uri): ?string @@ -349,7 +491,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); @@ -367,6 +510,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". @@ -382,6 +563,7 @@ class ImageService if (strpos(strtolower($url), 'uploads/images') === 0) { return trim($url, '/'); } + return null; } @@ -407,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 @@ -421,10 +603,12 @@ class ImageService $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket']; } } + $this->storageUrl = $storageUrl; } $basePath = ($this->storageUrl == false) ? url('/') : $this->storageUrl; + return rtrim($basePath, '/') . $filePath; } }