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
117 public function uploadByType($type, Request $request)
119 $this->checkPermission('image-create-all');
120 $this->validate($request, [
124 if (!$this->imageRepo->isValidType($type)) {
125 return $this->jsonError(trans('errors.image_upload_type_error'));
128 $imageUpload = $request->file('file');
131 $uploadedTo = $request->get('uploaded_to', 0);
132 $image = $this->imageRepo->saveNew($imageUpload, $type, $uploadedTo);
133 } catch (ImageUploadException $e) {
134 return response($e->getMessage(), 500);
137 return response()->json($image);
141 * Upload a drawing to the system.
142 * @param Request $request
143 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
145 public function uploadDrawing(Request $request)
147 $this->validate($request, [
148 'image' => 'required|string',
149 'uploaded_to' => 'required|integer'
151 $this->checkPermission('image-create-all');
152 $imageBase64Data = $request->get('image');
155 $uploadedTo = $request->get('uploaded_to', 0);
156 $image = $this->imageRepo->saveDrawing($imageBase64Data, $uploadedTo);
157 } catch (ImageUploadException $e) {
158 return response($e->getMessage(), 500);
161 return response()->json($image);
165 * Replace the data content of a drawing.
167 * @param Request $request
168 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
170 public function replaceDrawing(string $id, Request $request)
172 $this->validate($request, [
173 'image' => 'required|string'
175 $this->checkPermission('image-create-all');
177 $imageBase64Data = $request->get('image');
178 $image = $this->imageRepo->getById($id);
179 $this->checkOwnablePermission('image-update', $image);
182 $image = $this->imageRepo->replaceDrawingContent($image, $imageBase64Data);
183 } catch (ImageUploadException $e) {
184 return response($e->getMessage(), 500);
187 return response()->json($image);
191 * Get the content of an image based64 encoded.
193 * @return \Illuminate\Http\JsonResponse|mixed
195 public function getBase64Image($id)
197 $image = $this->imageRepo->getById($id);
198 $imageData = $this->imageRepo->getImageData($image);
199 if ($imageData === null) {
200 return $this->jsonError("Image data could not be found");
202 return response()->json([
203 'content' => base64_encode($imageData)
208 * Generate a sized thumbnail for an image.
213 * @return \Illuminate\Http\JsonResponse
214 * @throws ImageUploadException
217 public function getThumbnail($id, $width, $height, $crop)
219 $this->checkPermission('image-create-all');
220 $image = $this->imageRepo->getById($id);
221 $thumbnailUrl = $this->imageRepo->getThumbnail($image, $width, $height, $crop == 'false');
222 return response()->json(['url' => $thumbnailUrl]);
226 * Update image details
227 * @param integer $imageId
228 * @param Request $request
229 * @return \Illuminate\Http\JsonResponse
230 * @throws ImageUploadException
233 public function update($imageId, Request $request)
235 $this->validate($request, [
236 'name' => 'required|min:2|string'
238 $image = $this->imageRepo->getById($imageId);
239 $this->checkOwnablePermission('image-update', $image);
240 $image = $this->imageRepo->updateImageDetails($image, $request->all());
241 return response()->json($image);
245 * Deletes an image and all thumbnail/image files
246 * @param EntityRepo $entityRepo
247 * @param Request $request
249 * @return \Illuminate\Http\JsonResponse
251 public function destroy(EntityRepo $entityRepo, Request $request, $id)
253 $image = $this->imageRepo->getById($id);
254 $this->checkOwnablePermission('image-delete', $image);
256 // Check if this image is used on any pages
257 $isForced = in_array($request->get('force', ''), [true, 'true']);
259 $pageSearch = $entityRepo->searchForImage($image->url);
260 if ($pageSearch !== false) {
261 return response()->json($pageSearch, 400);
265 $this->imageRepo->destroyImage($image);
266 return response()->json(trans('components.images_deleted'));