X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/0155525945bb030ae2265279dca8014c8cdcb2af..refs/pull/5280/head:/app/Exceptions/Handler.php diff --git a/app/Exceptions/Handler.php b/app/Exceptions/Handler.php index 2d40f4476..61e126327 100644 --- a/app/Exceptions/Handler.php +++ b/app/Exceptions/Handler.php @@ -4,43 +4,59 @@ namespace BookStack\Exceptions; use Exception; use Illuminate\Auth\AuthenticationException; +use Illuminate\Database\Eloquent\ModelNotFoundException; use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler; +use Illuminate\Http\Exceptions\PostTooLargeException; use Illuminate\Http\JsonResponse; use Illuminate\Http\Request; +use Illuminate\Http\Response; use Illuminate\Validation\ValidationException; -use Symfony\Component\HttpKernel\Exception\HttpException; +use Symfony\Component\ErrorHandler\Error\FatalError; +use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface; +use Throwable; class Handler extends ExceptionHandler { /** * A list of the exception types that are not reported. * - * @var array + * @var array> */ protected $dontReport = [ NotFoundException::class, + StoppedAuthenticationException::class, ]; /** - * A list of the inputs that are never flashed for validation exceptions. + * A list of the inputs that are never flashed to the session on validation exceptions. * - * @var array + * @var array */ protected $dontFlash = [ + 'current_password', 'password', 'password_confirmation', ]; + /** + * A function to run upon out of memory. + * If it returns a response, that will be provided back to the request + * upon an out of memory event. + * + * @var ?callable(): ?Response + */ + protected $onOutOfMemory = null; + /** * Report or log an exception. * - * @param Exception $exception + * @param \Throwable $exception * - * @throws Exception + * @throws \Throwable * * @return void */ - public function report(Exception $exception) + public function report(Throwable $exception) { parent::report($exception); } @@ -53,8 +69,19 @@ class Handler extends ExceptionHandler * * @return \Illuminate\Http\Response */ - public function render($request, Exception $e) + public function render($request, Throwable $e) { + if ($e instanceof FatalError && str_contains($e->getMessage(), 'bytes exhausted (tried to allocate') && $this->onOutOfMemory) { + $response = call_user_func($this->onOutOfMemory); + if ($response) { + return $response; + } + } + + if ($e instanceof PostTooLargeException) { + $e = new NotifyException(trans('errors.server_post_limit'), '/', 413); + } + if ($this->isApiRequest($request)) { return $this->renderApiException($e); } @@ -62,26 +89,49 @@ class Handler extends ExceptionHandler return parent::render($request, $e); } + /** + * Provide a function to be called when an out of memory event occurs. + * If the callable returns a response, this response will be returned + * to the request upon error. + */ + public function prepareForOutOfMemory(callable $onOutOfMemory) + { + $this->onOutOfMemory = $onOutOfMemory; + } + + /** + * Forget the current out of memory handler, if existing. + */ + public function forgetOutOfMemoryHandler() + { + $this->onOutOfMemory = null; + } + /** * Check if the given request is an API request. */ protected function isApiRequest(Request $request): bool { - return strpos($request->path(), 'api/') === 0; + return str_starts_with($request->path(), 'api/'); } /** * Render an exception when the API is in use. */ - protected function renderApiException(Exception $e): JsonResponse + protected function renderApiException(Throwable $e): JsonResponse { - $code = $e->getCode() === 0 ? 500 : $e->getCode(); + $code = 500; $headers = []; - if ($e instanceof HttpException) { + + if ($e instanceof HttpExceptionInterface) { $code = $e->getStatusCode(); $headers = $e->getHeaders(); } + if ($e instanceof ModelNotFoundException) { + $code = 404; + } + $responseData = [ 'error' => [ 'message' => $e->getMessage(), @@ -89,6 +139,7 @@ class Handler extends ExceptionHandler ]; if ($e instanceof ValidationException) { + $responseData['error']['message'] = 'The given data was invalid.'; $responseData['error']['validation'] = $e->errors(); $code = $e->status; }