BookStack/app/Exceptions/Handler.php

144 lines
3.6 KiB
PHP
Raw Normal View History

2015-07-13 03:01:42 +08:00
<?php
namespace BookStack\Exceptions;
2015-07-13 03:01:42 +08:00
use Exception;
2017-01-26 03:35:40 +08:00
use Illuminate\Auth\AuthenticationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
2015-07-13 03:01:42 +08:00
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 Throwable;
2015-07-13 03:01:42 +08:00
class Handler extends ExceptionHandler
{
/**
* A list of the exception types that are not reported.
2015-07-13 03:01:42 +08:00
*
* @var array
*/
protected $dontReport = [
NotFoundException::class,
StoppedAuthenticationException::class,
2015-07-13 03:01:42 +08:00
];
/**
* A list of the inputs that are never flashed for validation exceptions.
*
* @var array
*/
protected $dontFlash = [
'current_password',
'password',
'password_confirmation',
];
2015-07-13 03:01:42 +08:00
/**
* Report or log an exception.
*
* @param \Throwable $exception
*
* @throws \Throwable
2021-06-26 23:23:15 +08:00
*
* @return void
2015-07-13 03:01:42 +08:00
*/
public function report(Throwable $exception)
2015-07-13 03:01:42 +08:00
{
parent::report($exception);
2015-07-13 03:01:42 +08:00
}
/**
* Render an exception into an HTTP response.
*
2021-06-26 23:23:15 +08:00
* @param \Illuminate\Http\Request $request
* @param Exception $e
*
2015-07-13 03:01:42 +08:00
* @return \Illuminate\Http\Response
*/
public function render($request, Throwable $e)
2015-07-13 03:01:42 +08:00
{
if ($this->isApiRequest($request)) {
return $this->renderApiException($e);
}
2015-07-13 03:01:42 +08:00
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();
}
if ($e instanceof ModelNotFoundException) {
$code = 404;
}
$responseData = [
'error' => [
'message' => $e->getMessage(),
2021-06-26 23:23:15 +08:00
],
];
if ($e instanceof ValidationException) {
$responseData['error']['validation'] = $e->errors();
$code = $e->status;
}
if (method_exists($e, 'getStatus')) {
$code = $e->getStatus();
}
$responseData['error']['code'] = $code;
2021-06-26 23:23:15 +08:00
return new JsonResponse($responseData, $code, $headers);
}
/**
* Convert an authentication exception into an unauthenticated response.
*
2021-06-26 23:23:15 +08:00
* @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');
}
2017-11-19 23:56:06 +08:00
/**
* Convert a validation exception into a JSON response.
*
2021-06-26 23:23:15 +08:00
* @param \Illuminate\Http\Request $request
* @param \Illuminate\Validation\ValidationException $exception
*
2017-11-19 23:56:06 +08:00
* @return \Illuminate\Http\JsonResponse
*/
protected function invalidJson($request, ValidationException $exception)
{
return response()->json($exception->errors(), $exception->status);
}
2015-07-13 03:01:42 +08:00
}