1 <?php namespace BookStack\Http\Controllers;
3 use BookStack\Exceptions\ImageUploadException;
4 use BookStack\Repos\EntityRepo;
5 use BookStack\Repos\ImageRepo;
6 use Illuminate\Filesystem\Filesystem as File;
7 use Illuminate\Http\Request;
9 use BookStack\Repos\PageRepo;
11 class ImageController extends Controller
18 * ImageController constructor.
21 * @param ImageRepo $imageRepo
23 public function __construct(Image $image, File $file, ImageRepo $imageRepo)
25 $this->image = $image;
27 $this->imageRepo = $imageRepo;
28 parent::__construct();
32 * Get all images for a specific type, Paginated
35 * @return \Illuminate\Http\JsonResponse
37 public function getAllByType($type, $page = 0)
39 $imgData = $this->imageRepo->getPaginatedByType($type, $page);
40 return response()->json($imgData);
44 * Search through images within a particular type.
47 * @param Request $request
50 public function searchByType($type, $page = 0, Request $request)
52 $this->validate($request, [
53 'term' => 'required|string'
56 $searchTerm = $request->get('term');
57 $imgData = $this->imageRepo->searchPaginatedByType($type, $page, 24, $searchTerm);
58 return response()->json($imgData);
62 * Get all images for a user.
64 * @return \Illuminate\Http\JsonResponse
66 public function getAllForUserType($page = 0)
68 $imgData = $this->imageRepo->getPaginatedByType('user', $page, 24, $this->currentUser->id);
69 return response()->json($imgData);
73 * Get gallery images with a specific filter such as book or page
76 * @param Request $request
77 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
79 public function getGalleryFiltered($filter, $page = 0, Request $request)
81 $this->validate($request, [
82 'page_id' => 'required|integer'
85 $validFilters = collect(['page', 'book']);
86 if (!$validFilters->contains($filter)) return response('Invalid filter', 500);
88 $pageId = $request->get('page_id');
89 $imgData = $this->imageRepo->getGalleryFiltered($page, 24, strtolower($filter), $pageId);
91 return response()->json($imgData);
95 * Handles image uploads for use on pages.
97 * @param Request $request
98 * @return \Illuminate\Http\JsonResponse
101 public function uploadByType($type, Request $request)
103 $this->checkPermission('image-create-all');
104 $this->validate($request, [
107 // TODO - Restrict & validate types
109 $imageUpload = $request->file('file');
112 $uploadedTo = $request->get('uploaded_to', 0);
113 $image = $this->imageRepo->saveNew($imageUpload, $type, $uploadedTo);
114 } catch (ImageUploadException $e) {
115 return response($e->getMessage(), 500);
118 return response()->json($image);
122 * Upload a drawing to the system.
123 * @param Request $request
124 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
126 public function uploadDrawing(Request $request)
128 $this->validate($request, [
129 'image' => 'required|string',
130 'uploaded_to' => 'required|integer'
132 $this->checkPermission('image-create-all');
133 $imageBase64Data = $request->get('image');
136 $uploadedTo = $request->get('uploaded_to', 0);
137 $image = $this->imageRepo->saveDrawing($imageBase64Data, $uploadedTo);
138 } catch (ImageUploadException $e) {
139 return response($e->getMessage(), 500);
142 return response()->json($image);
146 * Replace the data content of a drawing.
148 * @param Request $request
149 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
151 public function replaceDrawing(string $id, Request $request)
153 $this->validate($request, [
154 'image' => 'required|string'
156 $this->checkPermission('image-create-all');
158 $imageBase64Data = $request->get('image');
159 $image = $this->imageRepo->getById($id);
160 $this->checkOwnablePermission('image-update', $image);
163 $image = $this->imageRepo->replaceDrawingContent($image, $imageBase64Data);
164 } catch (ImageUploadException $e) {
165 return response($e->getMessage(), 500);
168 return response()->json($image);
172 * Get the content of an image based64 encoded.
174 * @return \Illuminate\Http\JsonResponse|mixed
176 public function getBase64Image($id)
178 $image = $this->imageRepo->getById($id);
179 $imageData = $this->imageRepo->getImageData($image);
180 if ($imageData === null) {
181 return $this->jsonError("Image data could not be found");
183 return response()->json([
184 'content' => base64_encode($imageData)
189 * Generate a sized thumbnail for an image.
194 * @return \Illuminate\Http\JsonResponse
195 * @throws ImageUploadException
198 public function getThumbnail($id, $width, $height, $crop)
200 $this->checkPermission('image-create-all');
201 $image = $this->imageRepo->getById($id);
202 $thumbnailUrl = $this->imageRepo->getThumbnail($image, $width, $height, $crop == 'false');
203 return response()->json(['url' => $thumbnailUrl]);
207 * Update image details
208 * @param integer $imageId
209 * @param Request $request
210 * @return \Illuminate\Http\JsonResponse
211 * @throws ImageUploadException
214 public function update($imageId, Request $request)
216 $this->validate($request, [
217 'name' => 'required|min:2|string'
219 $image = $this->imageRepo->getById($imageId);
220 $this->checkOwnablePermission('image-update', $image);
221 $image = $this->imageRepo->updateImageDetails($image, $request->all());
222 return response()->json($image);
226 * Deletes an image and all thumbnail/image files
227 * @param EntityRepo $entityRepo
228 * @param Request $request
230 * @return \Illuminate\Http\JsonResponse
232 public function destroy(EntityRepo $entityRepo, Request $request, $id)
234 $image = $this->imageRepo->getById($id);
235 $this->checkOwnablePermission('image-delete', $image);
237 // Check if this image is used on any pages
238 $isForced = in_array($request->get('force', ''), [true, 'true']);
240 $pageSearch = $entityRepo->searchForImage($image->url);
241 if ($pageSearch !== false) {
242 return response()->json($pageSearch, 400);
246 $this->imageRepo->destroyImage($image);
247 return response()->json(trans('components.images_deleted'));