X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/a3188d349c36a93dae1bc6c3350a72ad8ef38b64..refs/pull/524/head:/app/Repos/ImageRepo.php diff --git a/app/Repos/ImageRepo.php b/app/Repos/ImageRepo.php index 0da243f7c..8ddde7b0f 100644 --- a/app/Repos/ImageRepo.php +++ b/app/Repos/ImageRepo.php @@ -2,10 +2,10 @@ use BookStack\Image; -use Illuminate\Contracts\Filesystem\Filesystem as FileSystemInstance; -use Intervention\Image\ImageManager as ImageTool; -use Illuminate\Contracts\Filesystem\Factory as FileSystem; -use Illuminate\Contracts\Cache\Repository as Cache; +use BookStack\Page; +use BookStack\Services\ImageService; +use BookStack\Services\PermissionService; +use Illuminate\Contracts\Filesystem\FileNotFoundException; use Setting; use Symfony\Component\HttpFoundation\File\UploadedFile; @@ -13,30 +13,23 @@ class ImageRepo { protected $image; - protected $imageTool; - protected $fileSystem; - protected $cache; - - /** - * @var FileSystemInstance - */ - protected $storageInstance; - protected $storageUrl; - + protected $imageService; + protected $restrictionService; + protected $page; /** * ImageRepo constructor. - * @param Image $image - * @param ImageTool $imageTool - * @param FileSystem $fileSystem - * @param Cache $cache + * @param Image $image + * @param ImageService $imageService + * @param PermissionService $permissionService + * @param Page $page */ - public function __construct(Image $image, ImageTool $imageTool, FileSystem $fileSystem, Cache $cache) + public function __construct(Image $image, ImageService $imageService, PermissionService $permissionService, Page $page) { $this->image = $image; - $this->imageTool = $imageTool; - $this->fileSystem = $fileSystem; - $this->cache = $cache; + $this->imageService = $imageService; + $this->restrictionService = $permissionService; + $this->page = $page; } @@ -50,18 +43,18 @@ class ImageRepo return $this->image->findOrFail($id); } - /** - * Gets a load images paginated, filtered by image type. - * @param string $type - * @param int $page - * @param int $pageSize + * 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 */ - public function getPaginatedByType($type, $page = 0, $pageSize = 24) + private function returnPaginated($query, $page = 0, $pageSize = 24) { - $images = $this->image->where('type', '=', strtolower($type)) - ->orderBy('created_at', 'desc')->skip($pageSize * $page)->take($pageSize + 1)->get(); + $images = $this->restrictionService->filterRelatedPages($query, 'images', 'uploaded_to'); + $images = $images->orderBy('created_at', 'desc')->skip($pageSize * $page)->take($pageSize + 1)->get(); $hasMore = count($images) > $pageSize; $returnImages = $images->take(24); @@ -70,43 +63,79 @@ class ImageRepo }); return [ - 'images' => $returnImages, + 'images' => $returnImages, 'hasMore' => $hasMore ]; } /** - * Save a new image into storage and return the new image. - * @param UploadedFile $uploadFile - * @param string $type - * @return Image + * Gets a load images paginated, filtered by image type. + * @param string $type + * @param int $page + * @param int $pageSize + * @param bool|int $userFilter + * @return array */ - public function saveNew(UploadedFile $uploadFile, $type) + public function getPaginatedByType($type, $page = 0, $pageSize = 24, $userFilter = false) { - $storage = $this->getStorage(); - $secureUploads = Setting::get('app-secure-images'); - $imageName = str_replace(' ', '-', $uploadFile->getClientOriginalName()); - - if ($secureUploads) $imageName = str_random(16) . '-' . $imageName; + $images = $this->image->where('type', '=', strtolower($type)); - $imagePath = '/uploads/images/' . $type . '/' . Date('Y-m-M') . '/'; - while ($storage->exists($imagePath . $imageName)) { - $imageName = str_random(3) . $imageName; + if ($userFilter !== false) { + $images = $images->where('created_by', '=', $userFilter); } - $fullPath = $imagePath . $imageName; - $storage->put($fullPath, file_get_contents($uploadFile->getRealPath())); + return $this->returnPaginated($images, $page, $pageSize); + } + + /** + * 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, $page = 0, $pageSize = 24, $searchTerm) + { + $images = $this->image->where('type', '=', strtolower($type))->where('name', 'LIKE', '%' . $searchTerm . '%'); + return $this->returnPaginated($images, $page, $pageSize); + } + + /** + * Get gallery images with a particular filter criteria such as + * being within the current book or page. + * @param int $pagination + * @param int $pageSize + * @param $filter + * @param $pageId + * @return array + */ + public function getGalleryFiltered($pagination = 0, $pageSize = 24, $filter, $pageId) + { + $images = $this->image->where('type', '=', 'gallery'); - $userId = auth()->user()->id; - $image = $this->image->forceCreate([ - 'name' => $imageName, - 'path' => $fullPath, - 'url' => $this->getPublicUrl($fullPath), - 'type' => $type, - 'created_by' => $userId, - 'updated_by' => $userId - ]); + $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); + } + + return $this->returnPaginated($images, $pagination, $pageSize); + } + + /** + * Save a new image into storage and return the new image. + * @param UploadedFile $uploadFile + * @param string $type + * @param int $uploadedTo + * @return Image + */ + public function saveNew(UploadedFile $uploadFile, $type, $uploadedTo = 0) + { + $image = $this->imageService->saveNewFromUpload($uploadFile, $type, $uploadedTo); $this->loadThumbs($image); return $image; } @@ -133,40 +162,10 @@ class ImageRepo */ public function destroyImage(Image $image) { - $storage = $this->getStorage(); - - $imageFolder = dirname($image->path); - $imageFileName = basename($image->path); - $allImages = collect($storage->allFiles($imageFolder)); - - $imagesToDelete = $allImages->filter(function ($imagePath) use ($imageFileName) { - $expectedIndex = strlen($imagePath) - strlen($imageFileName); - return strpos($imagePath, $imageFileName) === $expectedIndex; - }); - - $storage->delete($imagesToDelete->all()); - - // Cleanup of empty folders - foreach ($storage->directories($imageFolder) as $directory) { - if ($this->isFolderEmpty($directory)) $storage->deleteDirectory($directory); - } - if ($this->isFolderEmpty($imageFolder)) $storage->deleteDirectory($imageFolder); - - $image->delete(); + $this->imageService->destroyImage($image); return true; } - /** - * Check whether or not a folder is empty. - * @param $path - * @return int - */ - private function isFolderEmpty($path) - { - $files = $this->getStorage()->files($path); - $folders = $this->getStorage()->directories($path); - return count($files) === 0 && count($folders) === 0; - } /** * Load thumbnails onto an image object. @@ -186,79 +185,19 @@ class ImageRepo * 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 + * @param int $width + * @param int $height + * @param bool $keepRatio * @return string */ public function getThumbnail(Image $image, $width = 220, $height = 220, $keepRatio = false) { - $thumbDirName = '/' . ($keepRatio ? 'scaled-' : 'thumbs-') . $width . '-' . $height . '/'; - $thumbFilePath = dirname($image->path) . $thumbDirName . basename($image->path); - - if ($this->cache->has('images-' . $image->id . '-' . $thumbFilePath) && $this->cache->get('images-' . $thumbFilePath)) { - return $this->getPublicUrl($thumbFilePath); - } - - $storage = $this->getStorage(); - - if ($storage->exists($thumbFilePath)) { - return $this->getPublicUrl($thumbFilePath); + try { + return $this->imageService->getThumbnail($image, $width, $height, $keepRatio); + } catch (FileNotFoundException $exception) { + $image->delete(); + return []; } - - // Otherwise create the thumbnail - $thumb = $this->imageTool->make($storage->get($image->path)); - if ($keepRatio) { - $thumb->resize($width, null, function ($constraint) { - $constraint->aspectRatio(); - $constraint->upsize(); - }); - } else { - $thumb->fit($width, $height); - } - - $thumbData = (string)$thumb->encode(); - $storage->put($thumbFilePath, $thumbData); - $this->cache->put('images-' . $image->id . '-' . $thumbFilePath, $thumbFilePath, 60 * 72); - - return $this->getPublicUrl($thumbFilePath); - } - - /** - * Gets a public facing url for an image by checking relevant environment variables. - * @param $filePath - * @return string - */ - private function getPublicUrl($filePath) - { - if ($this->storageUrl === null) { - $storageUrl = env('STORAGE_URL'); - - // Get the standard public s3 url if s3 is set as storage type - if ($storageUrl == false && env('STORAGE_TYPE') === 's3') { - $storageDetails = config('filesystems.disks.s3'); - $storageUrl = 'https://s3-' . $storageDetails['region'] . '.amazonaws.com/' . $storageDetails['bucket']; - } - - $this->storageUrl = $storageUrl; - } - - return ($this->storageUrl == false ? '' : rtrim($this->storageUrl, '/')) . $filePath; - } - - - /** - * Get the storage that will be used for storing images. - * @return FileSystemInstance - */ - private function getStorage() - { - if ($this->storageInstance !== null) return $this->storageInstance; - - $storageType = env('STORAGE_TYPE'); - $this->storageInstance = $this->fileSystem->disk($storageType); - - return $this->storageInstance; }