X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/80865b30a5d6a82e86d21e272ae58977d4430a64..refs/pull/3693/head:/app/Exceptions/Handler.php diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php index 14d553ed0..187664f9e 100644 --- a/app/Exceptions/Handler.php +++ b/app/Exceptions/Handler.php @@ -3,63 +3,141 @@ namespace BookStack\Exceptions; use Exception; -use Illuminate\Contracts\Validation\ValidationException; +use Illuminate\Auth\AuthenticationException; use Illuminate\Database\Eloquent\ModelNotFoundException; -use PhpSpec\Exception\Example\ErrorException; -use Symfony\Component\HttpKernel\Exception\HttpException; use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; -use Illuminate\Auth\Access\AuthorizationException; +use Illuminate\Http\JsonResponse; +use Illuminate\Http\Request; +use Illuminate\Validation\ValidationException; +use Symfony\Component\HttpKernel\Exception\HttpException; +use Throwable; class Handler extends ExceptionHandler { /** - * A list of the exception types that should not be reported. + * A list of the exception types that are not reported. * * @var array */ protected $dontReport = [ - AuthorizationException::class, - HttpException::class, - ModelNotFoundException::class, - ValidationException::class, + NotFoundException::class, + StoppedAuthenticationException::class, + ]; + + /** + * A list of the inputs that are never flashed for validation exceptions. + * + * @var array + */ + protected $dontFlash = [ + 'current_password', + 'password', + 'password_confirmation', ]; /** * Report or log an exception. * - * This is a great spot to send exceptions to Sentry, Bugsnag, etc. + * @param \Throwable $exception + * + * @throws \Throwable * - * @param \Exception $e + * @return void */ - public function report(Exception $e) + public function report(Throwable $exception) { - return parent::report($e); + parent::report($exception); } /** * Render an exception into an HTTP response. * - * @param \Illuminate\Http\Request $request - * @param \Exception $e + * @param \Illuminate\Http\Request $request + * @param Exception $e + * * @return \Illuminate\Http\Response */ - public function render($request, Exception $e) + public function render($request, Throwable $e) { - // Handle notify exceptions which will redirect to the - // specified location then show a notification message. - if ($e instanceof NotifyException) { - \Session::flash('error', $e->message); - return response()->redirectTo($e->redirectLocation); + if ($this->isApiRequest($request)) { + return $this->renderApiException($e); } - // Handle pretty exceptions which will show a friendly application-fitting page - // Which will include the basic message to point the user roughly to the cause. - if (($e instanceof PrettyException || $e->getPrevious() instanceof PrettyException) && !config('app.debug')) { - $message = ($e instanceof PrettyException) ? $e->getMessage() : $e->getPrevious()->getMessage(); - $code = ($e->getCode() === 0) ? 500 : $e->getCode(); - return response()->view('errors/' . $code, ['message' => $message], $code); + return parent::render($request, $e); + } + + /** + * Check if the given request is an API request. + */ + protected function isApiRequest(Request $request): bool + { + return strpos($request->path(), 'api/') === 0; + } + + /** + * Render an exception when the API is in use. + */ + protected function renderApiException(Throwable $e): JsonResponse + { + $code = 500; + $headers = []; + + if ($e instanceof HttpException) { + $code = $e->getStatusCode(); + $headers = $e->getHeaders(); } - return parent::render($request, $e); + if ($e instanceof ModelNotFoundException) { + $code = 404; + } + + $responseData = [ + 'error' => [ + 'message' => $e->getMessage(), + ], + ]; + + if ($e instanceof ValidationException) { + $responseData['error']['validation'] = $e->errors(); + $code = $e->status; + } + + if (method_exists($e, 'getStatus')) { + $code = $e->getStatus(); + } + + $responseData['error']['code'] = $code; + + return new JsonResponse($responseData, $code, $headers); + } + + /** + * Convert an authentication exception into an unauthenticated response. + * + * @param \Illuminate\Http\Request $request + * @param \Illuminate\Auth\AuthenticationException $exception + * + * @return \Illuminate\Http\Response + */ + protected function unauthenticated($request, AuthenticationException $exception) + { + if ($request->expectsJson()) { + return response()->json(['error' => 'Unauthenticated.'], 401); + } + + return redirect()->guest('login'); + } + + /** + * Convert a validation exception into a JSON response. + * + * @param \Illuminate\Http\Request $request + * @param \Illuminate\Validation\ValidationException $exception + * + * @return \Illuminate\Http\JsonResponse + */ + protected function invalidJson($request, ValidationException $exception) + { + return response()->json($exception->errors(), $exception->status); } }