]> BookStack Code Mirror - bookstack/blobdiff - app/Exceptions/Handler.php
Added tests and translations for dark-mode components
[bookstack] / app / Exceptions / Handler.php
index 4f6e690bc3b10bf9f42b28b79aa803a2a3b2fa4a..a3bc1e8b9e222e102fe7a8c93b1d2161362a0e8b 100644 (file)
@@ -3,14 +3,15 @@
 namespace BookStack\Exceptions;
 
 use Exception;
+use Illuminate\Auth\Access\AuthorizationException;
 use Illuminate\Auth\AuthenticationException;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
-use Illuminate\Pipeline\Pipeline;
+use Illuminate\Http\Response;
 use Illuminate\Validation\ValidationException;
-use Illuminate\Database\Eloquent\ModelNotFoundException;
 use Symfony\Component\HttpKernel\Exception\HttpException;
-use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
-use Illuminate\Auth\Access\AuthorizationException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
 
 class Handler extends ExceptionHandler
@@ -33,6 +34,7 @@ class Handler extends ExceptionHandler
      *
      * @param  \Exception $e
      * @return mixed
+     * @throws Exception
      */
     public function report(Exception $e)
     {
@@ -48,10 +50,17 @@ class Handler extends ExceptionHandler
      */
     public function render($request, Exception $e)
     {
+        if ($this->isApiRequest($request)) {
+            return $this->renderApiException($e);
+        }
+
         // Handle notify exceptions which will redirect to the
         // specified location then show a notification message.
         if ($this->isExceptionType($e, NotifyException::class)) {
-            session()->flash('error', $this->getOriginalMessage($e));
+            $message = $this->getOriginalMessage($e);
+            if (!empty($message)) {
+                session()->flash('error', $message);
+            }
             return redirect($e->redirectLocation);
         }
 
@@ -65,28 +74,45 @@ class Handler extends ExceptionHandler
 
         // Handle 404 errors with a loaded session to enable showing user-specific information
         if ($this->isExceptionType($e, NotFoundHttpException::class)) {
-            return $this->loadErrorMiddleware($request, function ($request) use ($e) {
-                $message = $e->getMessage() ?: trans('errors.404_page_not_found');
-                return response()->view('errors/404', ['message' => $message], 404);
-            });
+            return \Route::respondWithRoute('fallback');
         }
 
         return parent::render($request, $e);
     }
 
     /**
-     * Load the middleware required to show state/session-enabled error pages.
-     * @param Request $request
-     * @param $callback
-     * @return mixed
+     * Check if the given request is an API request.
      */
-    protected function loadErrorMiddleware(Request $request, $callback)
+    protected function isApiRequest(Request $request): bool
     {
-        $middleware = (\Route::getMiddlewareGroups()['web_errors']);
-        return (new Pipeline($this->container))
-            ->send($request)
-            ->through($middleware)
-            ->then($callback);
+        return strpos($request->path(), 'api/') === 0;
+    }
+
+    /**
+     * Render an exception when the API is in use.
+     */
+    protected function renderApiException(Exception $e): JsonResponse
+    {
+        $code = $e->getCode() === 0 ? 500 : $e->getCode();
+        $headers = [];
+        if ($e instanceof HttpException) {
+            $code = $e->getStatusCode();
+            $headers = $e->getHeaders();
+        }
+
+        $responseData = [
+            'error' => [
+                'message' => $e->getMessage(),
+            ]
+        ];
+
+        if ($e instanceof ValidationException) {
+            $responseData['error']['validation'] = $e->errors();
+            $code = $e->status;
+        }
+
+        $responseData['error']['code'] = $code;
+        return new JsonResponse($responseData, $code, $headers);
     }
 
     /**