1 <?php namespace BookStack\Http\Controllers;
3 use BookStack\Exceptions\ImageUploadException;
4 use BookStack\Exceptions\NotFoundException;
5 use BookStack\Repos\EntityRepo;
6 use BookStack\Repos\ImageRepo;
7 use Illuminate\Filesystem\Filesystem as File;
8 use Illuminate\Http\Request;
10 use BookStack\Repos\PageRepo;
12 class ImageController extends Controller
19 * ImageController constructor.
22 * @param ImageRepo $imageRepo
24 public function __construct(Image $image, File $file, ImageRepo $imageRepo)
26 $this->image = $image;
28 $this->imageRepo = $imageRepo;
29 parent::__construct();
33 * Provide an image file from storage.
37 public function showImage(string $path)
39 $path = storage_path('uploads/images/' . $path);
40 if (!file_exists($path)) {
44 return response()->file($path);
48 * Get all images for a specific type, Paginated
51 * @return \Illuminate\Http\JsonResponse
53 public function getAllByType($type, $page = 0)
55 $imgData = $this->imageRepo->getPaginatedByType($type, $page);
56 return response()->json($imgData);
60 * Search through images within a particular type.
63 * @param Request $request
66 public function searchByType($type, $page = 0, Request $request)
68 $this->validate($request, [
69 'term' => 'required|string'
72 $searchTerm = $request->get('term');
73 $imgData = $this->imageRepo->searchPaginatedByType($type, $page, 24, $searchTerm);
74 return response()->json($imgData);
78 * Get all images for a user.
80 * @return \Illuminate\Http\JsonResponse
82 public function getAllForUserType($page = 0)
84 $imgData = $this->imageRepo->getPaginatedByType('user', $page, 24, $this->currentUser->id);
85 return response()->json($imgData);
89 * Get gallery images with a specific filter such as book or page
92 * @param Request $request
93 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
95 public function getGalleryFiltered($filter, $page = 0, Request $request)
97 $this->validate($request, [
98 'page_id' => 'required|integer'
101 $validFilters = collect(['page', 'book']);
102 if (!$validFilters->contains($filter)) return response('Invalid filter', 500);
104 $pageId = $request->get('page_id');
105 $imgData = $this->imageRepo->getGalleryFiltered($page, 24, strtolower($filter), $pageId);
107 return response()->json($imgData);
111 * Handles image uploads for use on pages.
112 * @param string $type
113 * @param Request $request
114 * @return \Illuminate\Http\JsonResponse
116 public function uploadByType($type, Request $request)
118 $this->checkPermission('image-create-all');
119 $this->validate($request, [
123 $imageUpload = $request->file('file');
126 $uploadedTo = $request->filled('uploaded_to') ? $request->get('uploaded_to') : 0;
127 $image = $this->imageRepo->saveNew($imageUpload, $type, $uploadedTo);
128 } catch (ImageUploadException $e) {
129 return response($e->getMessage(), 500);
132 return response()->json($image);
136 * Generate a sized thumbnail for an image.
141 * @return \Illuminate\Http\JsonResponse
143 public function getThumbnail($id, $width, $height, $crop)
145 $this->checkPermission('image-create-all');
146 $image = $this->imageRepo->getById($id);
147 $thumbnailUrl = $this->imageRepo->getThumbnail($image, $width, $height, $crop == 'false');
148 return response()->json(['url' => $thumbnailUrl]);
152 * Update image details
153 * @param integer $imageId
154 * @param Request $request
155 * @return \Illuminate\Http\JsonResponse
157 public function update($imageId, Request $request)
159 $this->validate($request, [
160 'name' => 'required|min:2|string'
162 $image = $this->imageRepo->getById($imageId);
163 $this->checkOwnablePermission('image-update', $image);
164 $image = $this->imageRepo->updateImageDetails($image, $request->all());
165 return response()->json($image);
169 * Deletes an image and all thumbnail/image files
170 * @param EntityRepo $entityRepo
171 * @param Request $request
173 * @return \Illuminate\Http\JsonResponse
175 public function destroy(EntityRepo $entityRepo, Request $request, $id)
177 $image = $this->imageRepo->getById($id);
178 $this->checkOwnablePermission('image-delete', $image);
180 // Check if this image is used on any pages
181 $isForced = in_array($request->get('force', ''), [true, 'true']);
183 $pageSearch = $entityRepo->searchForImage($image->url);
184 if ($pageSearch !== false) {
185 return response()->json($pageSearch, 400);
189 $this->imageRepo->destroyImage($image);
190 return response()->json(trans('components.images_deleted'));