X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/919660678bec2b94eaa84ac60d0313f5ef07dfb7..refs/pull/2023/head:/app/Uploads/ImageRepo.php diff --git a/app/Uploads/ImageRepo.php b/app/Uploads/ImageRepo.php index 194a0d583..b7a21809f 100644 --- a/app/Uploads/ImageRepo.php +++ b/app/Uploads/ImageRepo.php @@ -1,9 +1,10 @@ image = $image; $this->imageService = $imageService; $this->restrictionService = $permissionService; @@ -32,10 +33,8 @@ class ImageRepo /** * Get an image with the given id. - * @param $id - * @return mixed */ - public function getById($id) + public function getById($id): Image { return $this->image->findOrFail($id); } @@ -43,126 +42,113 @@ class ImageRepo /** * Execute a paginated query, returning in a standard format. * Also runs the query through the restriction system. - * @param $query - * @param int $page - * @param int $pageSize - * @return array */ - private function returnPaginated($query, $page = 0, $pageSize = 24) + private function returnPaginated($query, $page = 1, $pageSize = 24): array { - $images = $this->restrictionService->filterRelatedPages($query, 'images', 'uploaded_to'); - $images = $images->orderBy('created_at', 'desc')->skip($pageSize * $page)->take($pageSize + 1)->get(); + $images = $query->orderBy('created_at', 'desc')->skip($pageSize * ($page - 1))->take($pageSize + 1)->get(); $hasMore = count($images) > $pageSize; - $returnImages = $images->take(24); + $returnImages = $images->take($pageSize); $returnImages->each(function ($image) { $this->loadThumbs($image); }); return [ 'images' => $returnImages, - 'hasMore' => $hasMore + 'has_more' => $hasMore ]; } /** - * Gets a load images paginated, filtered by image type. - * @param string $type - * @param int $page - * @param int $pageSize - * @param bool|int $userFilter - * @return array + * Fetch a list of images in a paginated format, filtered by image type. + * Can be filtered by uploaded to and also by name. */ - public function getPaginatedByType($type, $page = 0, $pageSize = 24, $userFilter = false) + public function getPaginatedByType( + string $type, + int $page = 0, + int $pageSize = 24, + int $uploadedTo = null, + string $search = null, + callable $whereClause = null + ): array { - $images = $this->image->where('type', '=', strtolower($type)); + $imageQuery = $this->image->newQuery()->where('type', '=', strtolower($type)); - if ($userFilter !== false) { - $images = $images->where('created_by', '=', $userFilter); + if ($uploadedTo !== null) { + $imageQuery = $imageQuery->where('uploaded_to', '=', $uploadedTo); } - return $this->returnPaginated($images, $page, $pageSize); - } + if ($search !== null) { + $imageQuery = $imageQuery->where('name', 'LIKE', '%' . $search . '%'); + } - /** - * Search for images by query, of a particular type. - * @param string $type - * @param int $page - * @param int $pageSize - * @param string $searchTerm - * @return array - */ - public function searchPaginatedByType($type, $searchTerm, $page = 0, $pageSize = 24) - { - $images = $this->image->where('type', '=', strtolower($type))->where('name', 'LIKE', '%' . $searchTerm . '%'); - return $this->returnPaginated($images, $page, $pageSize); + // Filter by page access + $imageQuery = $this->restrictionService->filterRelatedEntity('page', $imageQuery, 'images', 'uploaded_to'); + + if ($whereClause !== null) { + $imageQuery = $imageQuery->where($whereClause); + } + + return $this->returnPaginated($imageQuery, $page, $pageSize); } /** - * Get gallery images with a particular filter criteria such as - * being within the current book or page. - * @param $filter - * @param $pageId - * @param int $pageNum - * @param int $pageSize - * @return array + * Get paginated gallery images within a specific page or book. */ - public function getGalleryFiltered($filter, $pageId, $pageNum = 0, $pageSize = 24) + public function getEntityFiltered( + string $type, + string $filterType = null, + int $page = 0, + int $pageSize = 24, + int $uploadedTo = null, + string $search = null + ): array { - $images = $this->image->where('type', '=', 'gallery'); - - $page = $this->page->findOrFail($pageId); - - if ($filter === 'page') { - $images = $images->where('uploaded_to', '=', $page->id); - } elseif ($filter === 'book') { - $validPageIds = $page->book->pages->pluck('id')->toArray(); - $images = $images->whereIn('uploaded_to', $validPageIds); + $contextPage = $this->page->findOrFail($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()->get(['id'])->pluck('id')->toArray(); + $query->whereIn('uploaded_to', $validPageIds); + } + }; } - return $this->returnPaginated($images, $pageNum, $pageSize); + return $this->getPaginatedByType($type, $page, $pageSize, null, $search, $parentFilter); } /** * Save a new image into storage and return the new image. - * @param UploadedFile $uploadFile - * @param string $type - * @param int $uploadedTo - * @return Image - * @throws \BookStack\Exceptions\ImageUploadException - * @throws \Exception + * @throws ImageUploadException */ - public function saveNew(UploadedFile $uploadFile, $type, $uploadedTo = 0) + 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); + $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo, $resizeWidth, $resizeHeight, $keepRatio); $this->loadThumbs($image); return $image; } /** - * Save a drawing the the database; - * @param string $base64Uri - * @param int $uploadedTo - * @return Image - * @throws \BookStack\Exceptions\ImageUploadException + * Save a drawing the the database. + * @throws ImageUploadException */ - public function saveDrawing(string $base64Uri, int $uploadedTo) + public function saveDrawing(string $base64Uri, int $uploadedTo): Image { - $name = 'Drawing-' . user()->getShortName(40) . '-' . strval(time()) . '.png'; - $image = $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo); - return $image; + $name = 'Drawing-' . strval(user()->id) . '-' . strval(time()) . '.png'; + return $this->imageService->saveNewFromBase64Uri($base64Uri, $name, 'drawio', $uploadedTo); } /** * Update the details of an image via an array of properties. - * @param Image $image - * @param array $updateDetails - * @return Image - * @throws \BookStack\Exceptions\ImageUploadException - * @throws \Exception + * @throws ImageUploadException + * @throws Exception */ - public function updateImageDetails(Image $image, $updateDetails) + public function updateImageDetails(Image $image, $updateDetails): Image { $image->fill($updateDetails); $image->save(); @@ -170,31 +156,40 @@ class ImageRepo return $image; } - /** * Destroys an Image object along with its revisions, files and thumbnails. - * @param Image $image - * @return bool - * @throws \Exception + * @throws Exception */ - public function destroyImage(Image $image) + public function destroyImage(Image $image = null): bool { - $this->imageService->destroy($image); + if ($image) { + $this->imageService->destroy($image); + } return true; } + /** + * Destroy all images of a certain type. + * @throws Exception + */ + public function destroyByType(string $imageType) + { + $images = $this->image->where('type', '=', $imageType)->get(); + foreach ($images as $image) { + $this->destroyImage($image); + } + } + /** * Load thumbnails onto an image object. - * @param Image $image - * @throws \BookStack\Exceptions\ImageUploadException - * @throws \Exception + * @throws Exception */ protected function loadThumbs(Image $image) { $image->thumbs = [ - 'gallery' => $this->getThumbnail($image, 150, 150), - 'display' => $this->getThumbnail($image, 840, 0, true) + 'gallery' => $this->getThumbnail($image, 150, 150, false), + 'display' => $this->getThumbnail($image, 1680, null, true) ]; } @@ -202,45 +197,26 @@ class ImageRepo * 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 \BookStack\Exceptions\ImageUploadException - * @throws \Exception + * @throws Exception */ - public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false) + 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) { + } catch (Exception $exception) { return null; } } /** * Get the raw image data from an Image. - * @param Image $image - * @return null|string */ - public function getImageData(Image $image) + public function getImageData(Image $image): ?string { try { return $this->imageService->getImageData($image); - } catch (\Exception $exception) { + } catch (Exception $exception) { return null; } } - - /** - * Check if the provided image type is valid. - * @param $type - * @return bool - */ - public function isValidType($type) - { - $validTypes = ['gallery', 'cover', 'system', 'user']; - return in_array($type, $validTypes); - } }