mirror of
https://github.com/BookStackApp/BookStack.git
synced 2025-04-05 21:35:24 +00:00
Images: Started refactor of image service
To break it up. Also added better memory handling to other parts of the app.
This commit is contained in:
parent
40721433f7
commit
7247e31936
8 changed files with 340 additions and 261 deletions
app
Entities/Tools
Uploads
lang/en
|
@ -222,7 +222,7 @@ class ExportFormatter
|
||||||
foreach ($imageTagsOutput[0] as $index => $imgMatch) {
|
foreach ($imageTagsOutput[0] as $index => $imgMatch) {
|
||||||
$oldImgTagString = $imgMatch;
|
$oldImgTagString = $imgMatch;
|
||||||
$srcString = $imageTagsOutput[2][$index];
|
$srcString = $imageTagsOutput[2][$index];
|
||||||
$imageEncoded = $this->imageService->imageUriToBase64($srcString);
|
$imageEncoded = $this->imageService->imageUrlToBase64($srcString);
|
||||||
if ($imageEncoded === null) {
|
if ($imageEncoded === null) {
|
||||||
$imageEncoded = $srcString;
|
$imageEncoded = $srcString;
|
||||||
}
|
}
|
||||||
|
|
|
@ -10,11 +10,9 @@ use Illuminate\Http\Request;
|
||||||
|
|
||||||
class DrawioImageController extends Controller
|
class DrawioImageController extends Controller
|
||||||
{
|
{
|
||||||
protected $imageRepo;
|
public function __construct(
|
||||||
|
protected ImageRepo $imageRepo
|
||||||
public function __construct(ImageRepo $imageRepo)
|
) {
|
||||||
{
|
|
||||||
$this->imageRepo = $imageRepo;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -5,6 +5,7 @@ namespace BookStack\Uploads\Controllers;
|
||||||
use BookStack\Exceptions\ImageUploadException;
|
use BookStack\Exceptions\ImageUploadException;
|
||||||
use BookStack\Http\Controller;
|
use BookStack\Http\Controller;
|
||||||
use BookStack\Uploads\ImageRepo;
|
use BookStack\Uploads\ImageRepo;
|
||||||
|
use BookStack\Util\OutOfMemoryHandler;
|
||||||
use Illuminate\Http\Request;
|
use Illuminate\Http\Request;
|
||||||
use Illuminate\Support\Facades\App;
|
use Illuminate\Support\Facades\App;
|
||||||
use Illuminate\Support\Facades\Log;
|
use Illuminate\Support\Facades\Log;
|
||||||
|
@ -53,6 +54,10 @@ class GalleryImageController extends Controller
|
||||||
return $this->jsonError(implode("\n", $exception->errors()['file']));
|
return $this->jsonError(implode("\n", $exception->errors()['file']));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
new OutOfMemoryHandler(function () {
|
||||||
|
return $this->jsonError(trans('errors.image_upload_memory_limit'));
|
||||||
|
});
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$imageUpload = $request->file('file');
|
$imageUpload = $request->file('file');
|
||||||
$uploadedTo = $request->get('uploaded_to', 0);
|
$uploadedTo = $request->get('uploaded_to', 0);
|
||||||
|
|
|
@ -11,7 +11,6 @@ use BookStack\Uploads\ImageService;
|
||||||
use BookStack\Util\OutOfMemoryHandler;
|
use BookStack\Util\OutOfMemoryHandler;
|
||||||
use Exception;
|
use Exception;
|
||||||
use Illuminate\Http\Request;
|
use Illuminate\Http\Request;
|
||||||
use Illuminate\Validation\ValidationException;
|
|
||||||
|
|
||||||
class ImageController extends Controller
|
class ImageController extends Controller
|
||||||
{
|
{
|
||||||
|
@ -39,9 +38,6 @@ class ImageController extends Controller
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Update image details.
|
* Update image details.
|
||||||
*
|
|
||||||
* @throws ImageUploadException
|
|
||||||
* @throws ValidationException
|
|
||||||
*/
|
*/
|
||||||
public function update(Request $request, string $id)
|
public function update(Request $request, string $id)
|
||||||
{
|
{
|
||||||
|
@ -75,6 +71,10 @@ class ImageController extends Controller
|
||||||
$this->checkOwnablePermission('image-update', $image);
|
$this->checkOwnablePermission('image-update', $image);
|
||||||
$file = $request->file('file');
|
$file = $request->file('file');
|
||||||
|
|
||||||
|
new OutOfMemoryHandler(function () {
|
||||||
|
return $this->jsonError(trans('errors.image_upload_memory_limit'));
|
||||||
|
});
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$this->imageRepo->updateImageFile($image, $file);
|
$this->imageRepo->updateImageFile($image, $file);
|
||||||
} catch (ImageUploadException $exception) {
|
} catch (ImageUploadException $exception) {
|
||||||
|
|
95
app/Uploads/ImageResizer.php
Normal file
95
app/Uploads/ImageResizer.php
Normal file
|
@ -0,0 +1,95 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BookStack\Uploads;
|
||||||
|
|
||||||
|
use BookStack\Exceptions\ImageUploadException;
|
||||||
|
use GuzzleHttp\Psr7\Utils;
|
||||||
|
use Intervention\Image\Exception\NotSupportedException;
|
||||||
|
use Intervention\Image\Image as InterventionImage;
|
||||||
|
use Intervention\Image\ImageManager;
|
||||||
|
|
||||||
|
class ImageResizer
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
protected ImageManager $intervention
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resize the image of given data to the specified size, and return the new image data.
|
||||||
|
*
|
||||||
|
* @throws ImageUploadException
|
||||||
|
*/
|
||||||
|
protected function resizeImageData(string $imageData, ?int $width, ?int $height, bool $keepRatio): string
|
||||||
|
{
|
||||||
|
try {
|
||||||
|
$thumb = $this->intervention->make($imageData);
|
||||||
|
} catch (NotSupportedException $e) {
|
||||||
|
throw new ImageUploadException(trans('errors.cannot_create_thumbs'));
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->orientImageToOriginalExif($thumb, $imageData);
|
||||||
|
|
||||||
|
if ($keepRatio) {
|
||||||
|
$thumb->resize($width, $height, function ($constraint) {
|
||||||
|
$constraint->aspectRatio();
|
||||||
|
$constraint->upsize();
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
$thumb->fit($width, $height);
|
||||||
|
}
|
||||||
|
|
||||||
|
$thumbData = (string) $thumb->encode();
|
||||||
|
|
||||||
|
// Use original image data if we're keeping the ratio
|
||||||
|
// and the resizing does not save any space.
|
||||||
|
if ($keepRatio && strlen($thumbData) > strlen($imageData)) {
|
||||||
|
return $imageData;
|
||||||
|
}
|
||||||
|
|
||||||
|
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;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -8,19 +8,16 @@ use BookStack\Entities\Models\Page;
|
||||||
use BookStack\Exceptions\ImageUploadException;
|
use BookStack\Exceptions\ImageUploadException;
|
||||||
use ErrorException;
|
use ErrorException;
|
||||||
use Exception;
|
use Exception;
|
||||||
use GuzzleHttp\Psr7\Utils;
|
|
||||||
use Illuminate\Contracts\Cache\Repository as Cache;
|
use Illuminate\Contracts\Cache\Repository as Cache;
|
||||||
use Illuminate\Contracts\Filesystem\FileNotFoundException;
|
use Illuminate\Contracts\Filesystem\FileNotFoundException;
|
||||||
use Illuminate\Contracts\Filesystem\Filesystem as Storage;
|
use Illuminate\Contracts\Filesystem\Filesystem as StorageDisk;
|
||||||
use Illuminate\Filesystem\FilesystemAdapter;
|
use Illuminate\Filesystem\FilesystemAdapter;
|
||||||
use Illuminate\Filesystem\FilesystemManager;
|
use Illuminate\Filesystem\FilesystemManager;
|
||||||
use Illuminate\Support\Facades\DB;
|
use Illuminate\Support\Facades\DB;
|
||||||
use Illuminate\Support\Facades\Log;
|
use Illuminate\Support\Facades\Log;
|
||||||
use Illuminate\Support\Str;
|
use Illuminate\Support\Str;
|
||||||
use Intervention\Image\Exception\NotSupportedException;
|
use Intervention\Image\Exception\NotSupportedException;
|
||||||
use Intervention\Image\Image as InterventionImage;
|
|
||||||
use Intervention\Image\ImageManager;
|
use Intervention\Image\ImageManager;
|
||||||
use League\Flysystem\WhitespacePathNormalizer;
|
|
||||||
use Symfony\Component\HttpFoundation\File\UploadedFile;
|
use Symfony\Component\HttpFoundation\File\UploadedFile;
|
||||||
use Symfony\Component\HttpFoundation\StreamedResponse;
|
use Symfony\Component\HttpFoundation\StreamedResponse;
|
||||||
|
|
||||||
|
@ -31,79 +28,15 @@ class ImageService
|
||||||
public function __construct(
|
public function __construct(
|
||||||
protected ImageManager $imageTool,
|
protected ImageManager $imageTool,
|
||||||
protected FilesystemManager $fileSystem,
|
protected FilesystemManager $fileSystem,
|
||||||
protected Cache $cache
|
protected Cache $cache,
|
||||||
|
protected ImageStorage $storage,
|
||||||
) {
|
) {
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get the storage that will be used for storing images.
|
|
||||||
*/
|
|
||||||
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(string $imageType = 'gallery'): bool
|
|
||||||
{
|
|
||||||
return $this->getStorageDiskName($imageType) === 'local_secure_images';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Check if "local secure restricted" (Fetched behind auth, with permissions enforced)
|
|
||||||
* is currently active in the instance.
|
|
||||||
*/
|
|
||||||
protected function usingSecureRestrictedImages()
|
|
||||||
{
|
|
||||||
return config('filesystems.images') === 'local_secure_restricted';
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* 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 = (new WhitespacePathNormalizer())->normalizePath(str_replace('uploads/images/', '', $path));
|
|
||||||
|
|
||||||
if ($this->usingSecureImages($imageType)) {
|
|
||||||
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');
|
|
||||||
$localSecureInUse = ($storageType === 'local_secure' || $storageType === 'local_secure_restricted');
|
|
||||||
|
|
||||||
// Ensure system images (App logo) are uploaded to a public space
|
|
||||||
if ($imageType === 'system' && $localSecureInUse) {
|
|
||||||
return 'local';
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rename local_secure options to get our image specific storage driver which
|
|
||||||
// is scoped to the relevant image directories.
|
|
||||||
if ($localSecureInUse) {
|
|
||||||
return 'local_secure_images';
|
|
||||||
}
|
|
||||||
|
|
||||||
return $storageType;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Saves a new image from an upload.
|
* Saves a new image from an upload.
|
||||||
*
|
*
|
||||||
* @throws ImageUploadException
|
* @throws ImageUploadException
|
||||||
*
|
|
||||||
* @return mixed
|
|
||||||
*/
|
*/
|
||||||
public function saveNewFromUpload(
|
public function saveNewFromUpload(
|
||||||
UploadedFile $uploadedFile,
|
UploadedFile $uploadedFile,
|
||||||
|
@ -112,7 +45,7 @@ class ImageService
|
||||||
int $resizeWidth = null,
|
int $resizeWidth = null,
|
||||||
int $resizeHeight = null,
|
int $resizeHeight = null,
|
||||||
bool $keepRatio = true
|
bool $keepRatio = true
|
||||||
) {
|
): Image {
|
||||||
$imageName = $uploadedFile->getClientOriginalName();
|
$imageName = $uploadedFile->getClientOriginalName();
|
||||||
$imageData = file_get_contents($uploadedFile->getRealPath());
|
$imageData = file_get_contents($uploadedFile->getRealPath());
|
||||||
|
|
||||||
|
@ -146,13 +79,13 @@ class ImageService
|
||||||
*/
|
*/
|
||||||
public function saveNew(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image
|
public function saveNew(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image
|
||||||
{
|
{
|
||||||
$storage = $this->getStorageDisk($type);
|
$disk = $this->storage->getDisk($type);
|
||||||
$secureUploads = setting('app-secure-images');
|
$secureUploads = setting('app-secure-images');
|
||||||
$fileName = $this->cleanImageFileName($imageName);
|
$fileName = $this->storage->cleanImageFileName($imageName);
|
||||||
|
|
||||||
$imagePath = '/uploads/images/' . $type . '/' . date('Y-m') . '/';
|
$imagePath = '/uploads/images/' . $type . '/' . date('Y-m') . '/';
|
||||||
|
|
||||||
while ($storage->exists($this->adjustPathForStorageDisk($imagePath . $fileName, $type))) {
|
while ($disk->exists($this->storage->adjustPathForDisk($imagePath . $fileName, $type))) {
|
||||||
$fileName = Str::random(3) . $fileName;
|
$fileName = Str::random(3) . $fileName;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -162,7 +95,7 @@ class ImageService
|
||||||
}
|
}
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$this->saveImageDataInPublicSpace($storage, $this->adjustPathForStorageDisk($fullPath, $type), $imageData);
|
$this->storage->storeInPublicSpace($disk, $this->storage->adjustPathForDisk($fullPath, $type), $imageData);
|
||||||
} catch (Exception $e) {
|
} catch (Exception $e) {
|
||||||
Log::error('Error when attempting image upload:' . $e->getMessage());
|
Log::error('Error when attempting image upload:' . $e->getMessage());
|
||||||
|
|
||||||
|
@ -172,7 +105,7 @@ class ImageService
|
||||||
$imageDetails = [
|
$imageDetails = [
|
||||||
'name' => $imageName,
|
'name' => $imageName,
|
||||||
'path' => $fullPath,
|
'path' => $fullPath,
|
||||||
'url' => $this->getPublicUrl($fullPath),
|
'url' => $this->storage->getPublicUrl($fullPath),
|
||||||
'type' => $type,
|
'type' => $type,
|
||||||
'uploaded_to' => $uploadedTo,
|
'uploaded_to' => $uploadedTo,
|
||||||
];
|
];
|
||||||
|
@ -189,50 +122,17 @@ class ImageService
|
||||||
return $image;
|
return $image;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Replace an existing image file in the system using the given file.
|
||||||
|
*/
|
||||||
public function replaceExistingFromUpload(string $path, string $type, UploadedFile $file): void
|
public function replaceExistingFromUpload(string $path, string $type, UploadedFile $file): void
|
||||||
{
|
{
|
||||||
$imageData = file_get_contents($file->getRealPath());
|
$imageData = file_get_contents($file->getRealPath());
|
||||||
$storage = $this->getStorageDisk($type);
|
$disk = $this->storage->getDisk($type);
|
||||||
$adjustedPath = $this->adjustPathForStorageDisk($path, $type);
|
$adjustedPath = $this->storage->adjustPathForDisk($path, $type);
|
||||||
$storage->put($adjustedPath, $imageData);
|
$disk->put($adjustedPath, $imageData);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* 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): void
|
|
||||||
{
|
|
||||||
$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.
|
|
||||||
*/
|
|
||||||
protected function cleanImageFileName(string $name): string
|
|
||||||
{
|
|
||||||
$name = str_replace(' ', '-', $name);
|
|
||||||
$nameParts = explode('.', $name);
|
|
||||||
$extension = array_pop($nameParts);
|
|
||||||
$name = implode('-', $nameParts);
|
|
||||||
$name = Str::slug($name);
|
|
||||||
|
|
||||||
if (strlen($name) === 0) {
|
|
||||||
$name = Str::random(10);
|
|
||||||
}
|
|
||||||
|
|
||||||
return $name . '.' . $extension;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Checks if the image is a gif. Returns true if it is, else false.
|
* Checks if the image is a gif. Returns true if it is, else false.
|
||||||
|
@ -274,7 +174,7 @@ class ImageService
|
||||||
): ?string {
|
): ?string {
|
||||||
// Do not resize GIF images where we're not cropping
|
// Do not resize GIF images where we're not cropping
|
||||||
if ($keepRatio && $this->isGif($image)) {
|
if ($keepRatio && $this->isGif($image)) {
|
||||||
return $this->getPublicUrl($image->path);
|
return $this->storage->getPublicUrl($image->path);
|
||||||
}
|
}
|
||||||
|
|
||||||
$thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/';
|
$thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/';
|
||||||
|
@ -286,24 +186,24 @@ class ImageService
|
||||||
// Return path if in cache
|
// Return path if in cache
|
||||||
$cachedThumbPath = $this->cache->get($thumbCacheKey);
|
$cachedThumbPath = $this->cache->get($thumbCacheKey);
|
||||||
if ($cachedThumbPath && !$shouldCreate) {
|
if ($cachedThumbPath && !$shouldCreate) {
|
||||||
return $this->getPublicUrl($cachedThumbPath);
|
return $this->storage->getPublicUrl($cachedThumbPath);
|
||||||
}
|
}
|
||||||
|
|
||||||
// If thumbnail has already been generated, serve that and cache path
|
// If thumbnail has already been generated, serve that and cache path
|
||||||
$storage = $this->getStorageDisk($image->type);
|
$disk = $this->storage->getDisk($image->type);
|
||||||
if (!$shouldCreate && $storage->exists($this->adjustPathForStorageDisk($thumbFilePath, $image->type))) {
|
if (!$shouldCreate && $disk->exists($this->storage->adjustPathForDisk($thumbFilePath, $image->type))) {
|
||||||
$this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72);
|
$this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72);
|
||||||
|
|
||||||
return $this->getPublicUrl($thumbFilePath);
|
return $this->storage->getPublicUrl($thumbFilePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
$imageData = $storage->get($this->adjustPathForStorageDisk($imagePath, $image->type));
|
$imageData = $disk->get($this->storage->adjustPathForDisk($imagePath, $image->type));
|
||||||
|
|
||||||
// Do not resize apng images where we're not cropping
|
// Do not resize apng images where we're not cropping
|
||||||
if ($keepRatio && $this->isApngData($image, $imageData)) {
|
if ($keepRatio && $this->isApngData($image, $imageData)) {
|
||||||
$this->cache->put($thumbCacheKey, $image->path, 60 * 60 * 72);
|
$this->cache->put($thumbCacheKey, $image->path, 60 * 60 * 72);
|
||||||
|
|
||||||
return $this->getPublicUrl($image->path);
|
return $this->storage->getPublicUrl($image->path);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!$shouldCreate && !$canCreate) {
|
if (!$shouldCreate && !$canCreate) {
|
||||||
|
@ -312,10 +212,10 @@ class ImageService
|
||||||
|
|
||||||
// If not in cache and thumbnail does not exist, generate thumb and cache path
|
// If not in cache and thumbnail does not exist, generate thumb and cache path
|
||||||
$thumbData = $this->resizeImage($imageData, $width, $height, $keepRatio);
|
$thumbData = $this->resizeImage($imageData, $width, $height, $keepRatio);
|
||||||
$this->saveImageDataInPublicSpace($storage, $this->adjustPathForStorageDisk($thumbFilePath, $image->type), $thumbData);
|
$this->storage->storeInPublicSpace($disk, $this->storage->adjustPathForDisk($thumbFilePath, $image->type), $thumbData);
|
||||||
$this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72);
|
$this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72);
|
||||||
|
|
||||||
return $this->getPublicUrl($thumbFilePath);
|
return $this->storage->getPublicUrl($thumbFilePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -353,59 +253,17 @@ class ImageService
|
||||||
return $thumbData;
|
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.
|
* Get the raw data content from an image.
|
||||||
*
|
*
|
||||||
* @throws FileNotFoundException
|
* @throws Exception
|
||||||
*/
|
*/
|
||||||
public function getImageData(Image $image): string
|
public function getImageData(Image $image): string
|
||||||
{
|
{
|
||||||
$storage = $this->getStorageDisk();
|
$disk = $this->storage->getDisk();
|
||||||
|
|
||||||
return $storage->get($this->adjustPathForStorageDisk($image->path, $image->type));
|
return $disk->get($this->storage->adjustPathForDisk($image->path, $image->type));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -425,24 +283,24 @@ class ImageService
|
||||||
*/
|
*/
|
||||||
protected function destroyImagesFromPath(string $path, string $imageType): bool
|
protected function destroyImagesFromPath(string $path, string $imageType): bool
|
||||||
{
|
{
|
||||||
$path = $this->adjustPathForStorageDisk($path, $imageType);
|
$path = $this->storage->adjustPathForDisk($path, $imageType);
|
||||||
$storage = $this->getStorageDisk($imageType);
|
$disk = $this->storage->getDisk($imageType);
|
||||||
|
|
||||||
$imageFolder = dirname($path);
|
$imageFolder = dirname($path);
|
||||||
$imageFileName = basename($path);
|
$imageFileName = basename($path);
|
||||||
$allImages = collect($storage->allFiles($imageFolder));
|
$allImages = collect($disk->allFiles($imageFolder));
|
||||||
|
|
||||||
// Delete image files
|
// Delete image files
|
||||||
$imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) {
|
$imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) {
|
||||||
return basename($imagePath) === $imageFileName;
|
return basename($imagePath) === $imageFileName;
|
||||||
});
|
});
|
||||||
$storage->delete($imagesToDelete->all());
|
$disk->delete($imagesToDelete->all());
|
||||||
|
|
||||||
// Cleanup of empty folders
|
// Cleanup of empty folders
|
||||||
$foldersInvolved = array_merge([$imageFolder], $storage->directories($imageFolder));
|
$foldersInvolved = array_merge([$imageFolder], $disk->directories($imageFolder));
|
||||||
foreach ($foldersInvolved as $directory) {
|
foreach ($foldersInvolved as $directory) {
|
||||||
if ($this->isFolderEmpty($storage, $directory)) {
|
if ($this->isFolderEmpty($disk, $directory)) {
|
||||||
$storage->deleteDirectory($directory);
|
$disk->deleteDirectory($directory);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -452,7 +310,7 @@ class ImageService
|
||||||
/**
|
/**
|
||||||
* Check whether a folder is empty.
|
* Check whether a folder is empty.
|
||||||
*/
|
*/
|
||||||
protected function isFolderEmpty(Storage $storage, string $path): bool
|
protected function isFolderEmpty(StorageDisk $storage, string $path): bool
|
||||||
{
|
{
|
||||||
$files = $storage->files($path);
|
$files = $storage->files($path);
|
||||||
$folders = $storage->directories($path);
|
$folders = $storage->directories($path);
|
||||||
|
@ -506,33 +364,33 @@ class ImageService
|
||||||
*
|
*
|
||||||
* @throws FileNotFoundException
|
* @throws FileNotFoundException
|
||||||
*/
|
*/
|
||||||
public function imageUriToBase64(string $uri): ?string
|
public function imageUrlToBase64(string $url): ?string
|
||||||
{
|
{
|
||||||
$storagePath = $this->imageUrlToStoragePath($uri);
|
$storagePath = $this->storage->urlToPath($url);
|
||||||
if (empty($uri) || is_null($storagePath)) {
|
if (empty($url) || is_null($storagePath)) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
$storagePath = $this->adjustPathForStorageDisk($storagePath);
|
$storagePath = $this->storage->adjustPathForDisk($storagePath);
|
||||||
|
|
||||||
// Apply access control when local_secure_restricted images are active
|
// Apply access control when local_secure_restricted images are active
|
||||||
if ($this->usingSecureRestrictedImages()) {
|
if ($this->storage->usingSecureRestrictedImages()) {
|
||||||
if (!$this->checkUserHasAccessToRelationOfImageAtPath($storagePath)) {
|
if (!$this->checkUserHasAccessToRelationOfImageAtPath($storagePath)) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
$storage = $this->getStorageDisk();
|
$disk = $this->storage->getDisk();
|
||||||
$imageData = null;
|
$imageData = null;
|
||||||
if ($storage->exists($storagePath)) {
|
if ($disk->exists($storagePath)) {
|
||||||
$imageData = $storage->get($storagePath);
|
$imageData = $disk->get($storagePath);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (is_null($imageData)) {
|
if (is_null($imageData)) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
$extension = pathinfo($uri, PATHINFO_EXTENSION);
|
$extension = pathinfo($url, PATHINFO_EXTENSION);
|
||||||
if ($extension === 'svg') {
|
if ($extension === 'svg') {
|
||||||
$extension = 'svg+xml';
|
$extension = 'svg+xml';
|
||||||
}
|
}
|
||||||
|
@ -547,15 +405,14 @@ class ImageService
|
||||||
*/
|
*/
|
||||||
public function pathAccessibleInLocalSecure(string $imagePath): bool
|
public function pathAccessibleInLocalSecure(string $imagePath): bool
|
||||||
{
|
{
|
||||||
/** @var FilesystemAdapter $disk */
|
$disk = $this->storage->getDisk('gallery');
|
||||||
$disk = $this->getStorageDisk('gallery');
|
|
||||||
|
|
||||||
if ($this->usingSecureRestrictedImages() && !$this->checkUserHasAccessToRelationOfImageAtPath($imagePath)) {
|
if ($this->storage->usingSecureRestrictedImages() && !$this->checkUserHasAccessToRelationOfImageAtPath($imagePath)) {
|
||||||
return false;
|
return false;
|
||||||
}
|
}
|
||||||
|
|
||||||
// Check local_secure is active
|
// Check local_secure is active
|
||||||
return $this->usingSecureImages()
|
return $this->storage->usingSecureImages()
|
||||||
&& $disk instanceof FilesystemAdapter
|
&& $disk instanceof FilesystemAdapter
|
||||||
// Check the image file exists
|
// Check the image file exists
|
||||||
&& $disk->exists($imagePath)
|
&& $disk->exists($imagePath)
|
||||||
|
@ -617,7 +474,7 @@ class ImageService
|
||||||
*/
|
*/
|
||||||
public function streamImageFromStorageResponse(string $imageType, string $path): StreamedResponse
|
public function streamImageFromStorageResponse(string $imageType, string $path): StreamedResponse
|
||||||
{
|
{
|
||||||
$disk = $this->getStorageDisk($imageType);
|
$disk = $this->storage->getDisk($imageType);
|
||||||
|
|
||||||
return $disk->response($path);
|
return $disk->response($path);
|
||||||
}
|
}
|
||||||
|
@ -631,64 +488,4 @@ class ImageService
|
||||||
{
|
{
|
||||||
return in_array($extension, static::$supportedExtensions);
|
return in_array($extension, static::$supportedExtensions);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Get a storage path for the given image URL.
|
|
||||||
* Ensures the path will start with "uploads/images".
|
|
||||||
* Returns null if the url cannot be resolved to a local URL.
|
|
||||||
*/
|
|
||||||
private function imageUrlToStoragePath(string $url): ?string
|
|
||||||
{
|
|
||||||
$url = ltrim(trim($url), '/');
|
|
||||||
|
|
||||||
// Handle potential relative paths
|
|
||||||
$isRelative = !str_starts_with($url, 'http');
|
|
||||||
if ($isRelative) {
|
|
||||||
if (str_starts_with(strtolower($url), 'uploads/images')) {
|
|
||||||
return trim($url, '/');
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Handle local images based on paths on the same domain
|
|
||||||
$potentialHostPaths = [
|
|
||||||
url('uploads/images/'),
|
|
||||||
$this->getPublicUrl('/uploads/images/'),
|
|
||||||
];
|
|
||||||
|
|
||||||
foreach ($potentialHostPaths as $potentialBasePath) {
|
|
||||||
$potentialBasePath = strtolower($potentialBasePath);
|
|
||||||
if (str_starts_with(strtolower($url), $potentialBasePath)) {
|
|
||||||
return 'uploads/images/' . trim(substr($url, strlen($potentialBasePath)), '/');
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return null;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Gets a public facing url for an image by checking relevant environment variables.
|
|
||||||
* If s3-style store is in use it will default to guessing a public bucket URL.
|
|
||||||
*/
|
|
||||||
private function getPublicUrl(string $filePath): string
|
|
||||||
{
|
|
||||||
$storageUrl = config('filesystems.url');
|
|
||||||
|
|
||||||
// Get the standard public s3 url if s3 is set as storage type
|
|
||||||
// Uses the nice, short URL if bucket name has no periods in otherwise the longer
|
|
||||||
// region-based url will be used to prevent http issues.
|
|
||||||
if (!$storageUrl && config('filesystems.images') === 's3') {
|
|
||||||
$storageDetails = config('filesystems.disks.s3');
|
|
||||||
if (!str_contains($storageDetails['bucket'], '.')) {
|
|
||||||
$storageUrl = 'https://' . $storageDetails['bucket'] . '.s3.amazonaws.com';
|
|
||||||
} else {
|
|
||||||
$storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$basePath = $storageUrl ?: url('/');
|
|
||||||
|
|
||||||
return rtrim($basePath, '/') . $filePath;
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
183
app/Uploads/ImageStorage.php
Normal file
183
app/Uploads/ImageStorage.php
Normal file
|
@ -0,0 +1,183 @@
|
||||||
|
<?php
|
||||||
|
|
||||||
|
namespace BookStack\Uploads;
|
||||||
|
|
||||||
|
use Illuminate\Contracts\Filesystem\Filesystem as StorageDisk;
|
||||||
|
use Illuminate\Filesystem\FilesystemManager;
|
||||||
|
use Illuminate\Support\Str;
|
||||||
|
use League\Flysystem\WhitespacePathNormalizer;
|
||||||
|
|
||||||
|
class ImageStorage
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
protected FilesystemManager $fileSystem,
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the storage disk for the given image type.
|
||||||
|
*/
|
||||||
|
public function getDisk(string $imageType = ''): StorageDisk
|
||||||
|
{
|
||||||
|
return $this->fileSystem->disk($this->getDiskName($imageType));
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if local secure image storage (Fetched behind authentication)
|
||||||
|
* is currently active in the instance.
|
||||||
|
*/
|
||||||
|
public function usingSecureImages(string $imageType = 'gallery'): bool
|
||||||
|
{
|
||||||
|
return $this->getDiskName($imageType) === 'local_secure_images';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if "local secure restricted" (Fetched behind auth, with permissions enforced)
|
||||||
|
* is currently active in the instance.
|
||||||
|
*/
|
||||||
|
public function usingSecureRestrictedImages()
|
||||||
|
{
|
||||||
|
return config('filesystems.images') === 'local_secure_restricted';
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Change the originally provided path to fit any disk-specific requirements.
|
||||||
|
* This also ensures the path is kept to the expected root folders.
|
||||||
|
*/
|
||||||
|
public function adjustPathForDisk(string $path, string $imageType = ''): string
|
||||||
|
{
|
||||||
|
$path = (new WhitespacePathNormalizer())->normalizePath(str_replace('uploads/images/', '', $path));
|
||||||
|
|
||||||
|
if ($this->usingSecureImages($imageType)) {
|
||||||
|
return $path;
|
||||||
|
}
|
||||||
|
|
||||||
|
return 'uploads/images/' . $path;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clean up an image file name to be both URL and storage safe.
|
||||||
|
*/
|
||||||
|
public function cleanImageFileName(string $name): string
|
||||||
|
{
|
||||||
|
$name = str_replace(' ', '-', $name);
|
||||||
|
$nameParts = explode('.', $name);
|
||||||
|
$extension = array_pop($nameParts);
|
||||||
|
$name = implode('-', $nameParts);
|
||||||
|
$name = Str::slug($name);
|
||||||
|
|
||||||
|
if (strlen($name) === 0) {
|
||||||
|
$name = Str::random(10);
|
||||||
|
}
|
||||||
|
|
||||||
|
return $name . '.' . $extension;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get the name of the storage disk to use.
|
||||||
|
*/
|
||||||
|
protected function getDiskName(string $imageType): string
|
||||||
|
{
|
||||||
|
$storageType = config('filesystems.images');
|
||||||
|
$localSecureInUse = ($storageType === 'local_secure' || $storageType === 'local_secure_restricted');
|
||||||
|
|
||||||
|
// Ensure system images (App logo) are uploaded to a public space
|
||||||
|
if ($imageType === 'system' && $localSecureInUse) {
|
||||||
|
return 'local';
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rename local_secure options to get our image specific storage driver which
|
||||||
|
// is scoped to the relevant image directories.
|
||||||
|
if ($localSecureInUse) {
|
||||||
|
return 'local_secure_images';
|
||||||
|
}
|
||||||
|
|
||||||
|
return $storageType;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Get a storage path for the given image URL.
|
||||||
|
* Ensures the path will start with "uploads/images".
|
||||||
|
* Returns null if the url cannot be resolved to a local URL.
|
||||||
|
*/
|
||||||
|
public function urlToPath(string $url): ?string
|
||||||
|
{
|
||||||
|
$url = ltrim(trim($url), '/');
|
||||||
|
|
||||||
|
// Handle potential relative paths
|
||||||
|
$isRelative = !str_starts_with($url, 'http');
|
||||||
|
if ($isRelative) {
|
||||||
|
if (str_starts_with(strtolower($url), 'uploads/images')) {
|
||||||
|
return trim($url, '/');
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Handle local images based on paths on the same domain
|
||||||
|
$potentialHostPaths = [
|
||||||
|
url('uploads/images/'),
|
||||||
|
$this->getPublicUrl('/uploads/images/'),
|
||||||
|
];
|
||||||
|
|
||||||
|
foreach ($potentialHostPaths as $potentialBasePath) {
|
||||||
|
$potentialBasePath = strtolower($potentialBasePath);
|
||||||
|
if (str_starts_with(strtolower($url), $potentialBasePath)) {
|
||||||
|
return 'uploads/images/' . trim(substr($url, strlen($potentialBasePath)), '/');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets a public facing url for an image by checking relevant environment variables.
|
||||||
|
* If s3-style store is in use it will default to guessing a public bucket URL.
|
||||||
|
*/
|
||||||
|
public function getPublicUrl(string $filePath): string
|
||||||
|
{
|
||||||
|
$storageUrl = config('filesystems.url');
|
||||||
|
|
||||||
|
// Get the standard public s3 url if s3 is set as storage type
|
||||||
|
// Uses the nice, short URL if bucket name has no periods in otherwise the longer
|
||||||
|
// region-based url will be used to prevent http issues.
|
||||||
|
if (!$storageUrl && config('filesystems.images') === 's3') {
|
||||||
|
$storageDetails = config('filesystems.disks.s3');
|
||||||
|
if (!str_contains($storageDetails['bucket'], '.')) {
|
||||||
|
$storageUrl = 'https://' . $storageDetails['bucket'] . '.s3.amazonaws.com';
|
||||||
|
} else {
|
||||||
|
$storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket'];
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
$basePath = $storageUrl ?: url('/');
|
||||||
|
|
||||||
|
return rtrim($basePath, '/') . $filePath;
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Save image data for the given path in the public space, if possible,
|
||||||
|
* for the provided storage mechanism.
|
||||||
|
*/
|
||||||
|
public function storeInPublicSpace(StorageDisk $storage, string $path, string $data): void
|
||||||
|
{
|
||||||
|
$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.
|
||||||
|
if (!$this->isS3Like()) {
|
||||||
|
$storage->setVisibility($path, 'public');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Check if the image storage in use is an S3-like (but not likely S3) external system.
|
||||||
|
*/
|
||||||
|
protected function isS3Like(): bool
|
||||||
|
{
|
||||||
|
$usingS3 = strtolower(config('filesystems.images')) === 's3';
|
||||||
|
return $usingS3 && !is_null(config('filesystems.disks.s3.endpoint'));
|
||||||
|
}
|
||||||
|
}
|
|
@ -51,6 +51,7 @@ return [
|
||||||
'image_upload_error' => 'An error occurred uploading the image',
|
'image_upload_error' => 'An error occurred uploading the image',
|
||||||
'image_upload_type_error' => 'The image type being uploaded is invalid',
|
'image_upload_type_error' => 'The image type being uploaded is invalid',
|
||||||
'image_upload_replace_type' => 'Image file replacements must be of the same type',
|
'image_upload_replace_type' => 'Image file replacements must be of the same type',
|
||||||
|
'image_upload_memory_limit' => 'Failed to handle image upload and/or create thumbnails due to system resource limits',
|
||||||
'image_thumbnail_memory_limit' => 'Failed to create image size variations due to system resource limits',
|
'image_thumbnail_memory_limit' => 'Failed to create image size variations due to system resource limits',
|
||||||
'drawing_data_not_found' => 'Drawing data could not be loaded. The drawing file might no longer exist or you may not have permission to access it.',
|
'drawing_data_not_found' => 'Drawing data could not be loaded. The drawing file might no longer exist or you may not have permission to access it.',
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue