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(Request $request, $type, $page = 0)
68 $this->validate($request, [
69 'term' => 'required|string'
72 $searchTerm = $request->get('term');
73 $imgData = $this->imageRepo->searchPaginatedByType($type, $searchTerm, $page, 24);
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(Request $request, $filter, $page = 0)
97 $this->validate($request, [
98 'page_id' => 'required|integer'
101 $validFilters = collect(['page', 'book']);
102 if (!$validFilters->contains($filter)) {
103 return response('Invalid filter', 500);
106 $pageId = $request->get('page_id');
107 $imgData = $this->imageRepo->getGalleryFiltered(strtolower($filter), $pageId, $page, 24);
109 return response()->json($imgData);
113 * Handles image uploads for use on pages.
114 * @param string $type
115 * @param Request $request
116 * @return \Illuminate\Http\JsonResponse
119 public function uploadByType($type, Request $request)
121 $this->checkPermission('image-create-all');
122 $this->validate($request, [
126 if (!$this->imageRepo->isValidType($type)) {
127 return $this->jsonError(trans('errors.image_upload_type_error'));
130 $imageUpload = $request->file('file');
133 $uploadedTo = $request->get('uploaded_to', 0);
134 $image = $this->imageRepo->saveNew($imageUpload, $type, $uploadedTo);
135 } catch (ImageUploadException $e) {
136 return response($e->getMessage(), 500);
140 return response()->json($image);
144 * Upload a drawing to the system.
145 * @param Request $request
146 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
148 public function uploadDrawing(Request $request)
150 $this->validate($request, [
151 'image' => 'required|string',
152 'uploaded_to' => 'required|integer'
154 $this->checkPermission('image-create-all');
155 $imageBase64Data = $request->get('image');
158 $uploadedTo = $request->get('uploaded_to', 0);
159 $image = $this->imageRepo->saveDrawing($imageBase64Data, $uploadedTo);
160 } catch (ImageUploadException $e) {
161 return response($e->getMessage(), 500);
164 return response()->json($image);
168 * Replace the data content of a drawing.
170 * @param Request $request
171 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
173 public function replaceDrawing(string $id, Request $request)
175 $this->validate($request, [
176 'image' => 'required|string'
178 $this->checkPermission('image-create-all');
180 $imageBase64Data = $request->get('image');
181 $image = $this->imageRepo->getById($id);
182 $this->checkOwnablePermission('image-update', $image);
185 $image = $this->imageRepo->replaceDrawingContent($image, $imageBase64Data);
186 } catch (ImageUploadException $e) {
187 return response($e->getMessage(), 500);
190 return response()->json($image);
194 * Get the content of an image based64 encoded.
196 * @return \Illuminate\Http\JsonResponse|mixed
198 public function getBase64Image($id)
200 $image = $this->imageRepo->getById($id);
201 $imageData = $this->imageRepo->getImageData($image);
202 if ($imageData === null) {
203 return $this->jsonError("Image data could not be found");
205 return response()->json([
206 'content' => base64_encode($imageData)
211 * Generate a sized thumbnail for an image.
216 * @return \Illuminate\Http\JsonResponse
217 * @throws ImageUploadException
220 public function getThumbnail($id, $width, $height, $crop)
222 $this->checkPermission('image-create-all');
223 $image = $this->imageRepo->getById($id);
224 $thumbnailUrl = $this->imageRepo->getThumbnail($image, $width, $height, $crop == 'false');
225 return response()->json(['url' => $thumbnailUrl]);
229 * Update image details
230 * @param integer $imageId
231 * @param Request $request
232 * @return \Illuminate\Http\JsonResponse
233 * @throws ImageUploadException
236 public function update($imageId, Request $request)
238 $this->validate($request, [
239 'name' => 'required|min:2|string'
241 $image = $this->imageRepo->getById($imageId);
242 $this->checkOwnablePermission('image-update', $image);
243 $image = $this->imageRepo->updateImageDetails($image, $request->all());
244 return response()->json($image);
248 * Deletes an image and all thumbnail/image files
249 * @param EntityRepo $entityRepo
250 * @param Request $request
252 * @return \Illuminate\Http\JsonResponse
254 public function destroy(EntityRepo $entityRepo, Request $request, $id)
256 $image = $this->imageRepo->getById($id);
257 $this->checkOwnablePermission('image-delete', $image);
259 // Check if this image is used on any pages
260 $isForced = in_array($request->get('force', ''), [true, 'true']);
262 $pageSearch = $entityRepo->searchForImage($image->url);
263 if ($pageSearch !== false) {
264 return response()->json($pageSearch, 400);
268 $this->imageRepo->destroyImage($image);
269 return response()->json(trans('components.images_deleted'));