mirror of
https://github.com/BookStackApp/BookStack.git
synced 2024-10-01 01:36:00 -04:00
7be7d7d1e7
Added test to cover. Started refactoring some of the app error handling in the process of this. Fixes #2696
161 lines
4.3 KiB
PHP
161 lines
4.3 KiB
PHP
<?php
|
|
|
|
namespace BookStack\Exceptions;
|
|
|
|
use Exception;
|
|
use Illuminate\Auth\AuthenticationException;
|
|
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
|
|
use Illuminate\Http\JsonResponse;
|
|
use Illuminate\Http\Request;
|
|
use Illuminate\Validation\ValidationException;
|
|
use Symfony\Component\HttpKernel\Exception\HttpException;
|
|
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
|
|
|
|
class Handler extends ExceptionHandler
|
|
{
|
|
/**
|
|
* A list of the exception types that are not reported.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $dontReport = [
|
|
NotFoundException::class,
|
|
];
|
|
|
|
/**
|
|
* A list of the inputs that are never flashed for validation exceptions.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $dontFlash = [
|
|
'password',
|
|
'password_confirmation',
|
|
];
|
|
|
|
/**
|
|
* Report or log an exception.
|
|
*
|
|
* @param Exception $exception
|
|
* @return void
|
|
*
|
|
* @throws Exception
|
|
*/
|
|
public function report(Exception $exception)
|
|
{
|
|
parent::report($exception);
|
|
}
|
|
|
|
/**
|
|
* Render an exception into an HTTP response.
|
|
*
|
|
* @param \Illuminate\Http\Request $request
|
|
* @param Exception $e
|
|
* @return \Illuminate\Http\Response
|
|
*/
|
|
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)) {
|
|
$message = $this->getOriginalMessage($e);
|
|
if (!empty($message)) {
|
|
session()->flash('error', $message);
|
|
}
|
|
return redirect($e->redirectLocation);
|
|
}
|
|
|
|
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(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);
|
|
}
|
|
|
|
/**
|
|
* Check the exception chain to compare against the original exception type.
|
|
*/
|
|
protected function isExceptionType(Exception $e, string $type): bool
|
|
{
|
|
do {
|
|
if (is_a($e, $type)) {
|
|
return true;
|
|
}
|
|
} while ($e = $e->getPrevious());
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Get original exception message.
|
|
*/
|
|
protected function getOriginalMessage(Exception $e): string
|
|
{
|
|
do {
|
|
$message = $e->getMessage();
|
|
} while ($e = $e->getPrevious());
|
|
return $message;
|
|
}
|
|
|
|
/**
|
|
* 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);
|
|
}
|
|
}
|