mirror of
https://github.com/BookStackApp/BookStack.git
synced 2025-08-09 10:22:51 +03:00
Added the ability to replace existing image files
- Updated UI with image form dropdown containing delete and replace image actions. - Adds new endpoint and service/repo handling for replacing existing image. - Includes tests to cover.
This commit is contained in:
@@ -14,13 +14,10 @@ use Illuminate\Validation\ValidationException;
|
||||
|
||||
class ImageController extends Controller
|
||||
{
|
||||
protected ImageRepo $imageRepo;
|
||||
protected ImageService $imageService;
|
||||
|
||||
public function __construct(ImageRepo $imageRepo, ImageService $imageService)
|
||||
{
|
||||
$this->imageRepo = $imageRepo;
|
||||
$this->imageService = $imageService;
|
||||
public function __construct(
|
||||
protected ImageRepo $imageRepo,
|
||||
protected ImageService $imageService
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -65,6 +62,29 @@ class ImageController extends Controller
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the file for an existing image.
|
||||
*/
|
||||
public function updateFile(Request $request, string $id)
|
||||
{
|
||||
$this->validate($request, [
|
||||
'file' => ['required', 'file', ...$this->getImageValidationRules()],
|
||||
]);
|
||||
|
||||
$image = $this->imageRepo->getById($id);
|
||||
$this->checkImagePermission($image);
|
||||
$this->checkOwnablePermission('image-update', $image);
|
||||
$file = $request->file('file');
|
||||
|
||||
try {
|
||||
$this->imageRepo->updateImageFile($image, $file);
|
||||
} catch (ImageUploadException $exception) {
|
||||
return $this->jsonError($exception->getMessage());
|
||||
}
|
||||
|
||||
return response('');
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the form for editing the given image.
|
||||
*
|
||||
|
@@ -11,16 +11,10 @@ use Symfony\Component\HttpFoundation\File\UploadedFile;
|
||||
|
||||
class ImageRepo
|
||||
{
|
||||
protected ImageService $imageService;
|
||||
protected PermissionApplicator $permissions;
|
||||
|
||||
/**
|
||||
* ImageRepo constructor.
|
||||
*/
|
||||
public function __construct(ImageService $imageService, PermissionApplicator $permissions)
|
||||
{
|
||||
$this->imageService = $imageService;
|
||||
$this->permissions = $permissions;
|
||||
public function __construct(
|
||||
protected ImageService $imageService,
|
||||
protected PermissionApplicator $permissions
|
||||
) {
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -164,12 +158,29 @@ class ImageRepo
|
||||
public function updateImageDetails(Image $image, $updateDetails): Image
|
||||
{
|
||||
$image->fill($updateDetails);
|
||||
$image->updated_by = user()->id;
|
||||
$image->save();
|
||||
$this->loadThumbs($image);
|
||||
|
||||
return $image;
|
||||
}
|
||||
|
||||
/**
|
||||
* Update the image file of an existing image in the system.
|
||||
* @throws ImageUploadException
|
||||
*/
|
||||
public function updateImageFile(Image $image, UploadedFile $file): void
|
||||
{
|
||||
if ($file->getClientOriginalExtension() !== pathinfo($image->path, PATHINFO_EXTENSION)) {
|
||||
throw new ImageUploadException(trans('errors.image_upload_replace_type'));
|
||||
}
|
||||
|
||||
$image->updated_by = user()->id;
|
||||
$image->save();
|
||||
$this->imageService->replaceExistingFromUpload($image->path, $image->type, $file);
|
||||
$this->loadThumbs($image, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroys an Image object along with its revisions, files and thumbnails.
|
||||
*
|
||||
@@ -202,11 +213,11 @@ class ImageRepo
|
||||
/**
|
||||
* Load thumbnails onto an image object.
|
||||
*/
|
||||
public function loadThumbs(Image $image): void
|
||||
public function loadThumbs(Image $image, bool $forceCreate = false): void
|
||||
{
|
||||
$image->setAttribute('thumbs', [
|
||||
'gallery' => $this->getThumbnail($image, 150, 150, false),
|
||||
'display' => $this->getThumbnail($image, 1680, null, true),
|
||||
'gallery' => $this->getThumbnail($image, 150, 150, false, $forceCreate),
|
||||
'display' => $this->getThumbnail($image, 1680, null, true, $forceCreate),
|
||||
]);
|
||||
}
|
||||
|
||||
@@ -215,10 +226,10 @@ class ImageRepo
|
||||
* If $keepRatio is true only the width will be used.
|
||||
* Checks the cache then storage to avoid creating / accessing the filesystem on every check.
|
||||
*/
|
||||
protected function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio): ?string
|
||||
protected function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio, bool $forceCreate): ?string
|
||||
{
|
||||
try {
|
||||
return $this->imageService->getThumbnail($image, $width, $height, $keepRatio);
|
||||
return $this->imageService->getThumbnail($image, $width, $height, $keepRatio, $forceCreate);
|
||||
} catch (Exception $exception) {
|
||||
return null;
|
||||
}
|
||||
|
@@ -194,6 +194,14 @@ class ImageService
|
||||
return $image;
|
||||
}
|
||||
|
||||
public function replaceExistingFromUpload(string $path, string $type, UploadedFile $file): void
|
||||
{
|
||||
$imageData = file_get_contents($file->getRealPath());
|
||||
$storage = $this->getStorageDisk($type);
|
||||
$adjustedPath = $this->adjustPathForStorageDisk($path, $type);
|
||||
$storage->put($adjustedPath, $imageData);
|
||||
}
|
||||
|
||||
/**
|
||||
* Save image data for the given path in the public space, if possible,
|
||||
* for the provided storage mechanism.
|
||||
@@ -262,7 +270,7 @@ class ImageService
|
||||
* @throws Exception
|
||||
* @throws InvalidArgumentException
|
||||
*/
|
||||
public function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio = false): string
|
||||
public function getThumbnail(Image $image, ?int $width, ?int $height, bool $keepRatio = false, bool $forceCreate = false): string
|
||||
{
|
||||
// Do not resize GIF images where we're not cropping
|
||||
if ($keepRatio && $this->isGif($image)) {
|
||||
@@ -277,13 +285,13 @@ class ImageService
|
||||
|
||||
// Return path if in cache
|
||||
$cachedThumbPath = $this->cache->get($thumbCacheKey);
|
||||
if ($cachedThumbPath) {
|
||||
if ($cachedThumbPath && !$forceCreate) {
|
||||
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))) {
|
||||
if (!$forceCreate && $storage->exists($this->adjustPathForStorageDisk($thumbFilePath, $image->type))) {
|
||||
$this->cache->put($thumbCacheKey, $thumbFilePath, 60 * 60 * 72);
|
||||
|
||||
return $this->getPublicUrl($thumbFilePath);
|
||||
|
Reference in New Issue
Block a user