1 <?php namespace BookStack\Http\Controllers;
3 use BookStack\Entities\Repos\EntityRepo;
4 use BookStack\Exceptions\ImageUploadException;
5 use BookStack\Repos\PageRepo;
6 use BookStack\Uploads\Image;
7 use BookStack\Uploads\ImageRepo;
8 use Illuminate\Filesystem\Filesystem as File;
9 use Illuminate\Http\Request;
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 * Provide an image file from storage.
36 public function showImage(string $path)
38 $path = storage_path('uploads/images/' . $path);
39 if (!file_exists($path)) {
43 return response()->file($path);
47 * Get all images for a specific type, Paginated
50 * @return \Illuminate\Http\JsonResponse
52 public function getAllByType($type, $page = 0)
54 $imgData = $this->imageRepo->getPaginatedByType($type, $page);
55 return response()->json($imgData);
59 * Search through images within a particular type.
62 * @param Request $request
65 public function searchByType(Request $request, $type, $page = 0)
67 $this->validate($request, [
68 'term' => 'required|string'
71 $searchTerm = $request->get('term');
72 $imgData = $this->imageRepo->searchPaginatedByType($type, $searchTerm, $page, 24);
73 return response()->json($imgData);
77 * Get all images for a user.
79 * @return \Illuminate\Http\JsonResponse
81 public function getAllForUserType($page = 0)
83 $imgData = $this->imageRepo->getPaginatedByType('user', $page, 24, $this->currentUser->id);
84 return response()->json($imgData);
88 * Get gallery images with a specific filter such as book or page
91 * @param Request $request
92 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
94 public function getGalleryFiltered(Request $request, $filter, $page = 0)
96 $this->validate($request, [
97 'page_id' => 'required|integer'
100 $validFilters = collect(['page', 'book']);
101 if (!$validFilters->contains($filter)) {
102 return response('Invalid filter', 500);
105 $pageId = $request->get('page_id');
106 $imgData = $this->imageRepo->getGalleryFiltered(strtolower($filter), $pageId, $page, 24);
108 return response()->json($imgData);
112 * Handles image uploads for use on pages.
113 * @param string $type
114 * @param Request $request
115 * @return \Illuminate\Http\JsonResponse
118 public function uploadByType($type, Request $request)
120 $this->checkPermission('image-create-all');
121 $this->validate($request, [
122 'file' => 'image_extension|mimes:jpeg,png,gif,bmp,webp,tiff'
125 if (!$this->imageRepo->isValidType($type)) {
126 return $this->jsonError(trans('errors.image_upload_type_error'));
129 $imageUpload = $request->file('file');
132 $uploadedTo = $request->get('uploaded_to', 0);
133 $image = $this->imageRepo->saveNew($imageUpload, $type, $uploadedTo);
134 } catch (ImageUploadException $e) {
135 return response($e->getMessage(), 500);
138 return response()->json($image);
142 * Upload a drawing to the system.
143 * @param Request $request
144 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
146 public function uploadDrawing(Request $request)
148 $this->validate($request, [
149 'image' => 'required|string',
150 'uploaded_to' => 'required|integer'
152 $this->checkPermission('image-create-all');
153 $imageBase64Data = $request->get('image');
156 $uploadedTo = $request->get('uploaded_to', 0);
157 $image = $this->imageRepo->saveDrawing($imageBase64Data, $uploadedTo);
158 } catch (ImageUploadException $e) {
159 return response($e->getMessage(), 500);
162 return response()->json($image);
166 * Get the content of an image based64 encoded.
168 * @return \Illuminate\Http\JsonResponse|mixed
170 public function getBase64Image($id)
172 $image = $this->imageRepo->getById($id);
173 $imageData = $this->imageRepo->getImageData($image);
174 if ($imageData === null) {
175 return $this->jsonError("Image data could not be found");
177 return response()->json([
178 'content' => base64_encode($imageData)
183 * Generate a sized thumbnail for an image.
188 * @return \Illuminate\Http\JsonResponse
189 * @throws ImageUploadException
192 public function getThumbnail($id, $width, $height, $crop)
194 $this->checkPermission('image-create-all');
195 $image = $this->imageRepo->getById($id);
196 $thumbnailUrl = $this->imageRepo->getThumbnail($image, $width, $height, $crop == 'false');
197 return response()->json(['url' => $thumbnailUrl]);
201 * Update image details
202 * @param integer $imageId
203 * @param Request $request
204 * @return \Illuminate\Http\JsonResponse
205 * @throws ImageUploadException
208 public function update($imageId, Request $request)
210 $this->validate($request, [
211 'name' => 'required|min:2|string'
213 $image = $this->imageRepo->getById($imageId);
214 $this->checkOwnablePermission('image-update', $image);
215 $image = $this->imageRepo->updateImageDetails($image, $request->all());
216 return response()->json($image);
220 * Show the usage of an image on pages.
221 * @param \BookStack\Entities\Repos\EntityRepo $entityRepo
223 * @return \Illuminate\Http\JsonResponse
225 public function usage(EntityRepo $entityRepo, $id)
227 $image = $this->imageRepo->getById($id);
228 $pageSearch = $entityRepo->searchForImage($image->url);
229 return response()->json($pageSearch);
233 * Deletes an image and all thumbnail/image files
235 * @return \Illuminate\Http\JsonResponse
238 public function destroy($id)
240 $image = $this->imageRepo->getById($id);
241 $this->checkOwnablePermission('image-delete', $image);
243 $this->imageRepo->destroyImage($image);
244 return response()->json(trans('components.images_deleted'));