2015-07-12 19:01:42 +00:00
|
|
|
<?php
|
|
|
|
|
2015-09-10 18:31:09 +00:00
|
|
|
namespace BookStack\Exceptions;
|
2015-07-12 19:01:42 +00:00
|
|
|
|
|
|
|
use Exception;
|
2017-01-25 19:35:40 +00:00
|
|
|
use Illuminate\Auth\AuthenticationException;
|
2021-11-30 00:06:17 +00:00
|
|
|
use Illuminate\Database\Eloquent\ModelNotFoundException;
|
2015-07-12 19:01:42 +00:00
|
|
|
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
|
2020-01-18 15:03:28 +00:00
|
|
|
use Illuminate\Http\JsonResponse;
|
|
|
|
use Illuminate\Http\Request;
|
2018-09-25 15:58:03 +00:00
|
|
|
use Illuminate\Validation\ValidationException;
|
|
|
|
use Symfony\Component\HttpKernel\Exception\HttpException;
|
2021-10-26 21:04:18 +00:00
|
|
|
use Throwable;
|
2015-07-12 19:01:42 +00:00
|
|
|
|
|
|
|
class Handler extends ExceptionHandler
|
|
|
|
{
|
|
|
|
/**
|
2021-03-02 21:59:12 +00:00
|
|
|
* A list of the exception types that are not reported.
|
2015-07-12 19:01:42 +00:00
|
|
|
*
|
2023-02-06 16:58:29 +00:00
|
|
|
* @var array<int, class-string<\Throwable>>
|
2015-07-12 19:01:42 +00:00
|
|
|
*/
|
|
|
|
protected $dontReport = [
|
2020-05-23 10:26:48 +00:00
|
|
|
NotFoundException::class,
|
2022-05-30 17:31:08 +00:00
|
|
|
StoppedAuthenticationException::class,
|
2015-07-12 19:01:42 +00:00
|
|
|
];
|
|
|
|
|
2021-03-02 21:59:12 +00:00
|
|
|
/**
|
2023-02-06 16:58:29 +00:00
|
|
|
* A list of the inputs that are never flashed to the session on validation exceptions.
|
2021-03-02 21:59:12 +00:00
|
|
|
*
|
2023-02-06 16:58:29 +00:00
|
|
|
* @var array<int, string>
|
2021-03-02 21:59:12 +00:00
|
|
|
*/
|
|
|
|
protected $dontFlash = [
|
2021-10-30 20:29:59 +00:00
|
|
|
'current_password',
|
2021-03-02 21:59:12 +00:00
|
|
|
'password',
|
|
|
|
'password_confirmation',
|
|
|
|
];
|
|
|
|
|
2015-07-12 19:01:42 +00:00
|
|
|
/**
|
|
|
|
* Report or log an exception.
|
|
|
|
*
|
2021-10-26 21:04:18 +00:00
|
|
|
* @param \Throwable $exception
|
2021-03-02 21:59:12 +00:00
|
|
|
*
|
2021-10-26 21:04:18 +00:00
|
|
|
* @throws \Throwable
|
2021-06-26 15:23:15 +00:00
|
|
|
*
|
|
|
|
* @return void
|
2015-07-12 19:01:42 +00:00
|
|
|
*/
|
2021-10-26 21:04:18 +00:00
|
|
|
public function report(Throwable $exception)
|
2015-07-12 19:01:42 +00:00
|
|
|
{
|
2021-03-02 21:59:12 +00:00
|
|
|
parent::report($exception);
|
2015-07-12 19:01:42 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Render an exception into an HTTP response.
|
|
|
|
*
|
2021-06-26 15:23:15 +00:00
|
|
|
* @param \Illuminate\Http\Request $request
|
|
|
|
* @param Exception $e
|
|
|
|
*
|
2015-07-12 19:01:42 +00:00
|
|
|
* @return \Illuminate\Http\Response
|
|
|
|
*/
|
2021-10-26 21:04:18 +00:00
|
|
|
public function render($request, Throwable $e)
|
2015-07-12 19:01:42 +00:00
|
|
|
{
|
2020-01-18 15:03:28 +00:00
|
|
|
if ($this->isApiRequest($request)) {
|
|
|
|
return $this->renderApiException($e);
|
|
|
|
}
|
|
|
|
|
2015-07-12 19:01:42 +00:00
|
|
|
return parent::render($request, $e);
|
|
|
|
}
|
2016-09-03 11:08:58 +00:00
|
|
|
|
2020-01-18 15:03:28 +00:00
|
|
|
/**
|
|
|
|
* 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.
|
|
|
|
*/
|
2021-11-30 00:06:17 +00:00
|
|
|
protected function renderApiException(Throwable $e): JsonResponse
|
2020-01-18 15:03:28 +00:00
|
|
|
{
|
2021-11-30 00:06:17 +00:00
|
|
|
$code = 500;
|
2020-01-18 15:03:28 +00:00
|
|
|
$headers = [];
|
2021-11-30 00:06:17 +00:00
|
|
|
|
2020-01-18 15:03:28 +00:00
|
|
|
if ($e instanceof HttpException) {
|
|
|
|
$code = $e->getStatusCode();
|
|
|
|
$headers = $e->getHeaders();
|
|
|
|
}
|
|
|
|
|
2021-11-30 00:06:17 +00:00
|
|
|
if ($e instanceof ModelNotFoundException) {
|
|
|
|
$code = 404;
|
|
|
|
}
|
|
|
|
|
2020-01-18 15:03:28 +00:00
|
|
|
$responseData = [
|
|
|
|
'error' => [
|
|
|
|
'message' => $e->getMessage(),
|
2021-06-26 15:23:15 +00:00
|
|
|
],
|
2020-01-18 15:03:28 +00:00
|
|
|
];
|
|
|
|
|
|
|
|
if ($e instanceof ValidationException) {
|
2023-02-06 20:41:33 +00:00
|
|
|
$responseData['error']['message'] = 'The given data was invalid.';
|
2020-01-18 15:03:28 +00:00
|
|
|
$responseData['error']['validation'] = $e->errors();
|
|
|
|
$code = $e->status;
|
|
|
|
}
|
|
|
|
|
2022-02-04 00:26:19 +00:00
|
|
|
if (method_exists($e, 'getStatus')) {
|
|
|
|
$code = $e->getStatus();
|
|
|
|
}
|
|
|
|
|
2020-01-18 15:03:28 +00:00
|
|
|
$responseData['error']['code'] = $code;
|
2021-06-26 15:23:15 +00:00
|
|
|
|
2020-01-18 15:03:28 +00:00
|
|
|
return new JsonResponse($responseData, $code, $headers);
|
|
|
|
}
|
|
|
|
|
2016-09-17 17:22:04 +00:00
|
|
|
/**
|
|
|
|
* Convert an authentication exception into an unauthenticated response.
|
|
|
|
*
|
2021-06-26 15:23:15 +00:00
|
|
|
* @param \Illuminate\Http\Request $request
|
|
|
|
* @param \Illuminate\Auth\AuthenticationException $exception
|
|
|
|
*
|
2016-09-17 17:22:04 +00:00
|
|
|
* @return \Illuminate\Http\Response
|
|
|
|
*/
|
|
|
|
protected function unauthenticated($request, AuthenticationException $exception)
|
|
|
|
{
|
|
|
|
if ($request->expectsJson()) {
|
|
|
|
return response()->json(['error' => 'Unauthenticated.'], 401);
|
|
|
|
}
|
|
|
|
|
|
|
|
return redirect()->guest('login');
|
|
|
|
}
|
2017-11-19 15:56:06 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Convert a validation exception into a JSON response.
|
|
|
|
*
|
2021-06-26 15:23:15 +00:00
|
|
|
* @param \Illuminate\Http\Request $request
|
|
|
|
* @param \Illuminate\Validation\ValidationException $exception
|
|
|
|
*
|
2017-11-19 15:56:06 +00:00
|
|
|
* @return \Illuminate\Http\JsonResponse
|
|
|
|
*/
|
|
|
|
protected function invalidJson($request, ValidationException $exception)
|
|
|
|
{
|
|
|
|
return response()->json($exception->errors(), $exception->status);
|
|
|
|
}
|
2015-07-12 19:01:42 +00:00
|
|
|
}
|