X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/1c43602f4bed60a84f47735ca8bc4a399018e013..refs/pull/5721/head:/app/Uploads/ImageRepo.php diff --git a/app/Uploads/ImageRepo.php b/app/Uploads/ImageRepo.php index 115078561..a16b87bd7 100644 --- a/app/Uploads/ImageRepo.php +++ b/app/Uploads/ImageRepo.php @@ -2,33 +2,21 @@ namespace BookStack\Uploads; -use BookStack\Auth\Permissions\PermissionService; -use BookStack\Entities\Models\Page; +use BookStack\Entities\Queries\PageQueries; use BookStack\Exceptions\ImageUploadException; +use BookStack\Permissions\PermissionApplicator; use Exception; use Illuminate\Database\Eloquent\Builder; use Symfony\Component\HttpFoundation\File\UploadedFile; class ImageRepo { - protected $image; - protected $imageService; - protected $restrictionService; - protected $page; - - /** - * ImageRepo constructor. - */ public function __construct( - Image $image, - ImageService $imageService, - PermissionService $permissionService, - Page $page + protected ImageService $imageService, + protected PermissionApplicator $permissions, + protected ImageResizer $imageResizer, + protected PageQueries $pageQueries, ) { - $this->image = $image; - $this->imageService = $imageService; - $this->restrictionService = $permissionService; - $this->page = $page; } /** @@ -36,26 +24,20 @@ class ImageRepo */ public function getById($id): Image { - return $this->image->findOrFail($id); + return Image::query()->findOrFail($id); } /** * Execute a paginated query, returning in a standard format. * Also runs the query through the restriction system. */ - private function returnPaginated($query, $page = 1, $pageSize = 24): array + protected function returnPaginated(Builder $query, int $page = 1, int $pageSize = 24): array { $images = $query->orderBy('created_at', 'desc')->skip($pageSize * ($page - 1))->take($pageSize + 1)->get(); - $hasMore = count($images) > $pageSize; - - $returnImages = $images->take($pageSize); - $returnImages->each(function ($image) { - $this->loadThumbs($image); - }); return [ - 'images' => $returnImages, - 'has_more' => $hasMore, + 'images' => $images->take($pageSize), + 'has_more' => count($images) > $pageSize, ]; } @@ -67,11 +49,11 @@ class ImageRepo string $type, int $page = 0, int $pageSize = 24, - int $uploadedTo = null, - string $search = null, - callable $whereClause = null + ?int $uploadedTo = null, + ?string $search = null, + ?callable $whereClause = null ): array { - $imageQuery = $this->image->newQuery()->where('type', '=', strtolower($type)); + $imageQuery = Image::query()->where('type', '=', strtolower($type)); if ($uploadedTo !== null) { $imageQuery = $imageQuery->where('uploaded_to', '=', $uploadedTo); @@ -82,7 +64,7 @@ class ImageRepo } // Filter by page access - $imageQuery = $this->restrictionService->filterRelatedEntity(Page::class, $imageQuery, 'images', 'uploaded_to'); + $imageQuery = $this->permissions->restrictPageRelationQuery($imageQuery, 'images', 'uploaded_to'); if ($whereClause !== null) { $imageQuery = $imageQuery->where($whereClause); @@ -96,21 +78,24 @@ class ImageRepo */ public function getEntityFiltered( string $type, - string $filterType = null, - int $page = 0, - int $pageSize = 24, - int $uploadedTo = null, - string $search = null + ?string $filterType, + int $page, + int $pageSize, + int $uploadedTo, + ?string $search ): array { - $contextPage = $this->page->findOrFail($uploadedTo); + $contextPage = $this->pageQueries->findVisibleByIdOrFail($uploadedTo); $parentFilter = null; if ($filterType === 'book' || $filterType === 'page') { $parentFilter = function (Builder $query) use ($filterType, $contextPage) { if ($filterType === 'page') { $query->where('uploaded_to', '=', $contextPage->id); - } elseif ($filterType === 'book') { - $validPageIds = $contextPage->book->pages()->visible()->get(['id'])->pluck('id')->toArray(); + } else if ($filterType === 'book') { + $validPageIds = $contextPage->book->pages() + ->scopes('visible') + ->pluck('id') + ->toArray(); $query->whereIn('uploaded_to', $validPageIds); } }; @@ -124,10 +109,19 @@ class ImageRepo * * @throws ImageUploadException */ - public function saveNew(UploadedFile $uploadFile, string $type, int $uploadedTo = 0, int $resizeWidth = null, int $resizeHeight = null, bool $keepRatio = true): Image - { + public function saveNew( + UploadedFile $uploadFile, + string $type, + int $uploadedTo = 0, + ?int $resizeWidth = null, + ?int $resizeHeight = null, + bool $keepRatio = true + ): Image { $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo, $resizeWidth, $resizeHeight, $keepRatio); - $this->loadThumbs($image); + + if ($type !== 'system') { + $this->imageResizer->loadGalleryThumbnailsForImage($image, true); + } return $image; } @@ -137,22 +131,22 @@ class ImageRepo * * @throws ImageUploadException */ - public function saveNewFromData(string $imageName, string $imageData, string $type, int $uploadedTo = 0) + public function saveNewFromData(string $imageName, string $imageData, string $type, int $uploadedTo = 0): Image { $image = $this->imageService->saveNew($imageName, $imageData, $type, $uploadedTo); - $this->loadThumbs($image); + $this->imageResizer->loadGalleryThumbnailsForImage($image, true); return $image; } /** - * Save a drawing the the database. + * Save a drawing in the database. * * @throws ImageUploadException */ public function saveDrawing(string $base64Uri, int $uploadedTo): Image { - $name = 'Drawing-' . strval(user()->id) . '-' . strval(time()) . '.png'; + $name = 'Drawing-' . user()->id . '-' . time() . '.png'; return $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo); } @@ -160,71 +154,63 @@ class ImageRepo /** * Update the details of an image via an array of properties. * - * @throws ImageUploadException * @throws Exception */ public function updateImageDetails(Image $image, $updateDetails): Image { $image->fill($updateDetails); + $image->updated_by = user()->id; $image->save(); - $this->loadThumbs($image); + $this->imageResizer->loadGalleryThumbnailsForImage($image, false); return $image; } /** - * Destroys an Image object along with its revisions, files and thumbnails. - * - * @throws Exception + * Update the image file of an existing image in the system. + * @throws ImageUploadException */ - public function destroyImage(Image $image = null): bool + public function updateImageFile(Image $image, UploadedFile $file): void { - if ($image) { - $this->imageService->destroy($image); + if (strtolower($file->getClientOriginalExtension()) !== strtolower(pathinfo($image->path, PATHINFO_EXTENSION))) { + throw new ImageUploadException(trans('errors.image_upload_replace_type')); } - return true; + $image->refresh(); + $image->updated_by = user()->id; + $image->touch(); + $image->save(); + + $this->imageService->replaceExistingFromUpload($image->path, $image->type, $file); + $this->imageResizer->loadGalleryThumbnailsForImage($image, true); } /** - * Destroy all images of a certain type. + * Destroys an Image object along with its revisions, files and thumbnails. * * @throws Exception */ - public function destroyByType(string $imageType) + public function destroyImage(?Image $image = null): void { - $images = $this->image->where('type', '=', $imageType)->get(); - foreach ($images as $image) { - $this->destroyImage($image); + if ($image) { + $this->imageService->destroy($image); } } /** - * Load thumbnails onto an image object. + * Destroy images that have a specific URL and type combination. * * @throws Exception */ - public function loadThumbs(Image $image) + public function destroyByUrlAndType(string $url, string $imageType): void { - $image->thumbs = [ - 'gallery' => $this->getThumbnail($image, 150, 150, false), - 'display' => $this->getThumbnail($image, 1680, null, true), - ]; - } + $images = Image::query() + ->where('url', '=', $url) + ->where('type', '=', $imageType) + ->get(); - /** - * 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. - * - * @throws Exception - */ - protected function getThumbnail(Image $image, ?int $width = 220, ?int $height = 220, bool $keepRatio = false): ?string - { - try { - return $this->imageService->getThumbnail($image, $width, $height, $keepRatio); - } catch (Exception $exception) { - return null; + foreach ($images as $image) { + $this->destroyImage($image); } } @@ -245,12 +231,12 @@ class ImageRepo */ public function getPagesUsingImage(Image $image): array { - $pages = Page::visible() + $pages = $this->pageQueries->visibleForList() ->where('html', 'like', '%' . $image->url . '%') - ->get(['id', 'name', 'slug', 'book_id']); + ->get(); foreach ($pages as $page) { - $page->url = $page->getUrl(); + $page->setAttribute('url', $page->getUrl()); } return $pages->all();