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
48 * @param Request $request
51 * @return \Illuminate\Http\JsonResponse
53 public function getAllByType(Request $request, $type, $page = 0)
55 $uploadedToFilter = $request->get('uploaded_to', null);
57 // For user profile request, check access to user images
58 if ($type === 'user') {
59 $this->checkPermissionOrCurrentUser('users-manage', $uploadedToFilter ?? 0);
62 $imgData = $this->imageRepo->getPaginatedByType($type, $page, 24, $uploadedToFilter);
63 return response()->json($imgData);
67 * Search through images within a particular type.
70 * @param Request $request
73 public function searchByType(Request $request, $type, $page = 0)
75 $this->validate($request, [
76 'term' => 'required|string'
79 $searchTerm = $request->get('term');
80 $imgData = $this->imageRepo->searchPaginatedByType($type, $searchTerm, $page, 24);
81 return response()->json($imgData);
84 public function uploadUserImage(Request $request)
89 public function uploadSystemImage(Request $request)
94 public function uploadCoverImage(Request $request)
100 * Upload a draw.io image into the system.
101 * @param Request $request
102 * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\JsonResponse|\Symfony\Component\HttpFoundation\Response
104 public function uploadDrawioImage(Request $request)
106 $this->validate($request, [
107 'image' => 'required|string',
108 'uploaded_to' => 'required|integer'
110 $uploadedTo = $request->get('uploaded_to', 0);
112 $this->checkPermission('image-create-all');
113 $imageBase64Data = $request->get('image');
116 $image = $this->imageRepo->saveDrawing($imageBase64Data, $uploadedTo);
117 } catch (ImageUploadException $e) {
118 return response($e->getMessage(), 500);
121 return response()->json($image);
125 * Handles image uploads for use on pages.
126 * @param string $type
127 * @param Request $request
128 * @return \Illuminate\Http\JsonResponse
131 public function uploadByType($type, Request $request)
133 $this->checkPermission('image-create-all');
134 $this->validate($request, [
135 'file' => 'image_extension|no_double_extension|mimes:jpeg,png,gif,bmp,webp,tiff'
138 if (!$this->imageRepo->isValidType($type)) {
139 return $this->jsonError(trans('errors.image_upload_type_error'));
142 $imageUpload = $request->file('file');
145 $uploadedTo = $request->get('uploaded_to', 0);
147 // For user profile request, check access to user images
148 if ($type === 'user') {
149 $this->checkPermissionOrCurrentUser('users-manage', $uploadedTo ?? 0);
152 $image = $this->imageRepo->saveNew($imageUpload, $type, $uploadedTo);
153 } catch (ImageUploadException $e) {
154 return response($e->getMessage(), 500);
157 return response()->json($image);
160 * Get the content of an image based64 encoded.
162 * @return \Illuminate\Http\JsonResponse|mixed
164 public function getBase64Image($id)
166 $image = $this->imageRepo->getById($id);
167 $imageData = $this->imageRepo->getImageData($image);
168 if ($imageData === null) {
169 return $this->jsonError("Image data could not be found");
171 return response()->json([
172 'content' => base64_encode($imageData)
177 * Generate a sized thumbnail for an image.
182 * @return \Illuminate\Http\JsonResponse
183 * @throws ImageUploadException
186 public function getThumbnail($id, $width, $height, $crop)
188 $this->checkPermission('image-create-all');
189 $image = $this->imageRepo->getById($id);
190 $thumbnailUrl = $this->imageRepo->getThumbnail($image, $width, $height, $crop == 'false');
191 return response()->json(['url' => $thumbnailUrl]);
195 * Update image details
197 * @param Request $request
198 * @return \Illuminate\Http\JsonResponse
199 * @throws ImageUploadException
202 public function update($id, Request $request)
204 $this->validate($request, [
205 'name' => 'required|min:2|string'
208 $image = $this->imageRepo->getById($id);
209 $this->checkOwnablePermission('image-update', $image);
211 $image = $this->imageRepo->updateImageDetails($image, $request->all());
212 return response()->json($image);
216 * Show the usage of an image on pages.
217 * @param \BookStack\Entities\Repos\EntityRepo $entityRepo
219 * @return \Illuminate\Http\JsonResponse
221 public function usage(EntityRepo $entityRepo, $id)
223 $image = $this->imageRepo->getById($id);
224 $pageSearch = $entityRepo->searchForImage($image->url);
225 return response()->json($pageSearch);
229 * Deletes an image and all thumbnail/image files
231 * @return \Illuminate\Http\JsonResponse
234 public function destroy($id)
236 $image = $this->imageRepo->getById($id);
237 $this->checkOwnablePermission('image-delete', $image);
239 $this->imageRepo->destroyImage($image);
240 return response()->json(trans('components.images_deleted'));