Skip to content

A free open source IT asset/license management system

11.7 KB
Raw Blame
<?php

namespace App\Exceptions;

use App\Helpers\Helper;
use ArieTimmerman\Laravel\SCIMServer\Exceptions\SCIMException;
use Carbon\Exceptions\InvalidFormatException;
use Illuminate\Auth\Access\AuthorizationException;
use Illuminate\Auth\AuthenticationException;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
use Illuminate\Http\JsonResponse;
use Illuminate\Http\RedirectResponse;
use Illuminate\Http\Request;
use Illuminate\Http\Response;
use Illuminate\Session\TokenMismatchException;
use Illuminate\Support\Facades\Lang;
use Illuminate\Validation\ValidationException;
use Intervention\Image\Exception\NotSupportedException;
use JsonException;
use Laravel\Passport\Exceptions\OAuthServerException as PassportOAuthServerException;
use League\OAuth2\Server\Exception\OAuthServerException;
use Livewire\Exceptions\ComponentNotFoundException;
use Livewire\Exceptions\PublicPropertyNotFoundException;
use Symfony\Component\HttpKernel\Exception\HttpException;
use Throwable;

class Handler extends ExceptionHandler
{
    /**
     * A list of the exception types that are not reported.
     *
     * @var array<int, class-string<\Throwable>>
     */
    protected $dontReport = [
        AuthenticationException::class,
        AuthorizationException::class,
        HttpException::class,
        ModelNotFoundException::class,
        TokenMismatchException::class,
        ValidationException::class,
        NotSupportedException::class,
        OAuthServerException::class,
        PassportOAuthServerException::class,
        JsonException::class,
        SCIMException::class, // these generally don't need to be reported
        InvalidFormatException::class,
        PublicPropertyNotFoundException::class,
        ComponentNotFoundException::class,
    ];

    /**
     * Report or log an exception.
     *
     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
     *
     * @return void
     */
    public function report(Throwable $exception)
    {
        if ($this->shouldReport($exception)) {
            return parent::report($exception);
        }
    }

    /**
     * Report a caught exception, and rethrow in dev when the underlying
     * cause is a programmer-error \Error (TypeError, ArgumentCountError,
     * etc.) so it fails loud with a stack trace in dev instead of hiding behind
     * a friendly "something went wrong" flash. Plain \Exception (sub)types
     * (QueryException, ItemStillHasAssets, etc.) *always* report + return so
     * bulk operations can keep swallowing runtime-data failures per row.
     *
     * We should use this as a drop-in for `report($e)` inside the wide-net
     * catch (\Throwable $e) blocks in the bulk destroy / import paths.
     */
    public static function reportOrRethrow(Throwable $e): void
    {
        // Both APP_DEBUG must be on AND the environment must
        // not be production before the raw \Error is allowed to
        // escape past the friendly user-facing error.
        if (
            config('app.debug')
            && ! app()->environment('production')
            && $e instanceof \Error
        ) {
            throw $e;
        }
        report($e);
    }

    /**
     * Render an exception into an HTTP response.
     *
     * @param  Request  $request
     * @param  \Exception  $e
     * @return JsonResponse|RedirectResponse|Response
     */
    public function render($request, Throwable $e)
    {

        // Livewire tried to set a property that doesn't exist (e.g. stale browser state sending a bare "0" as a property name)
        if ($e instanceof PublicPropertyNotFoundException) {
            return response()->json(['message' => $e->getMessage()], 422);
        }

        // A request named a Livewire component that doesn't exist in this app (e.g. bots probing
        // for Filament endpoints). Return 404 so it doesn't surface as a 500.
        if ($e instanceof ComponentNotFoundException) {
            return response()->json(['message' => 'Component not found.'], 404);
        }

        // CSRF token mismatch error
        if ($e instanceof TokenMismatchException) {
            // Any form POST can hit this branch, including pre-auth
            // forms (login, password reset, setup wizard). Routing the
            // fallback through sameOriginUrl prevents a crafted link
            // that pairs an off-origin Referer with an expired token
            // from steering the response Location off-site.
            return redirect()->to(Helper::sameOriginUrl(url()->previous()) ?? route('home'))
                ->with('error', trans('general.token_expired'));
        }

        // Invalid JSON exception
        // TODO: don't understand why we have to do this when we have the invalidJson() method, below, but, well, whatever
        if ($e instanceof JsonException) {
            return response()->json(Helper::formatStandardApiResponse('error', null, 'Invalid JSON'), 422);
        }

        // Handle SCIM exceptions
        if ($e instanceof SCIMException) {
            try {
                $e->report(); // logs as 'debug', so shouldn't get too noisy
            } catch (\Exception $reportException) {
                // do nothing
            }

            return $e->render($request); // ALL SCIMExceptions have the 'render()' method
        }

        // Handle standard requests that fail because Carbon cannot parse the date on validation (when a submitted date value is definitely not a date)
        if ($e instanceof InvalidFormatException) {
            // Same open-redirect guard as the TokenMismatch branch above.
            return redirect()->to(Helper::sameOriginUrl(url()->previous()) ?? route('home'))
                ->withInput()->with('error', trans('validation.date', ['attribute' => 'date']));
        }

        // Handle API requests that fail
        if ($request->ajax() || $request->wantsJson()) {

            // Handle API requests that fail because Carbon cannot parse the date on validation (when a submitted date value is definitely not a date)
            if ($e instanceof InvalidFormatException) {
                return response()->json(Helper::formatStandardApiResponse('error', null, trans('validation.date', ['attribute' => 'date'])), 200);
            }

            // Handle API requests that fail because the model doesn't exist
            if ($e instanceof ModelNotFoundException) {
                $className = last(explode('\\', $e->getModel()));

                return response()->json(Helper::formatStandardApiResponse('error', null, $className.' not found'), 200);
            }

            // Handle API requests that fail because of an HTTP status code and return a useful error message
            if ($this->isHttpException($e)) {

                $statusCode = $e->getStatusCode();

                // API throttle requests are handled in the RouteServiceProvider configureRateLimiting() method, so we don't need to handle them here
                switch ($e->getStatusCode()) {
                    case '404':
                        return response()->json(Helper::formatStandardApiResponse('error', null, $statusCode.' endpoint not found'), 404);
                    case '405':
                        return response()->json(Helper::formatStandardApiResponse('error', null, 'Method not allowed'), 405);
                    default:
                        return response()->json(Helper::formatStandardApiResponse('error', null, $statusCode), $statusCode);
                }

            }

            // This handles API validation exceptions that happen at the Form Request level, so they
            // never even get to the controller where we normally  nicely format JSON responses
            if ($e instanceof ValidationException) {
                $response = $this->invalidJson($request, $e);

                return response()->json(Helper::formatStandardApiResponse('error', null, $e->errors()), 200);
            }

        }

        // This is traaaaash but it handles models that are not found while using route model binding :(
        // The only alternative is to set that at *each* route, which is crazypants
        if ($e instanceof ModelNotFoundException) {
            $ids = $e->getIds();

            if (in_array('bulkedit', $ids, true)) {
                $error_array = session()->get('bulk_asset_errors');

                return redirect()
                    ->route('hardware.index')
                    ->withErrors($error_array, 'bulk_asset_errors')
                    ->withInput();
            }

            // This gets the MVC model name from the exception and formats in a way that's less fugly
            $model_name = trim(strtolower(implode(' ', preg_split('/(?=[A-Z])/', last(explode('\\', $e->getModel()))))));
            $route = str_plural(strtolower(last(explode('\\', $e->getModel())))).'.index';

            // Sigh.
            if ($route == 'assets.index') {
                $route = 'hardware.index';
            } elseif ($route == 'reporttemplates.index') {
                $route = 'reports/custom';
            } elseif ($route == 'assetmodels.index') {
                $route = 'models.index';
            } elseif ($route == 'predefinedkits.index') {
                $route = 'kits.index';
            } elseif ($route == 'assetmaintenances.index') {
                $route = 'maintenances.index';
            } elseif ($route === 'licenseseats.index') {
                $route = 'licenses.index';
            } elseif (($route === 'customfieldsets.index') || ($route === 'customfields.index')) {
                $route = 'fields.index';
            } elseif ($route == 'actionlogs.index') {
                $route = 'home';
            } elseif ($route === 'customuserlabels.index') {
                $route = 'settings.labels.index';
            } elseif ($route === 'maintenancetypes.index') {
                $route = 'maintenance-types.index';
            }

            // Normalize the space-separated derived name to underscore
            // so compound class names (AssetModel -> "asset model" -> "asset_model")
            // resolve to keys that actually exist in general.php.
            $translationKey = 'general.'.str_replace(' ', '_', $model_name);
            $translatedName = Lang::has($translationKey) ? trans($translationKey) : $model_name;

            return redirect()
                ->route($route)
                ->withError(trans('general.generic_model_not_found', ['model' => $translatedName]));
        }

        if ($this->isHttpException($e) && (isset($statusCode)) && ($statusCode == '404')) {
            return response()->view('layouts/basic', [
                'content' => view('errors/404'),
            ], $statusCode);
        }

        return parent::render($request, $e);

    }

    /**
     * Convert an authentication exception into an unauthenticated response.
     *
     * @param  Request  $request
     * @return JsonResponse|RedirectResponse
     */
    protected function unauthenticated($request, AuthenticationException $exception)
    {
        if ($request->expectsJson()) {
            return response()->json(['error' => trans('general.unauthorized')], 401);
        }

        return redirect()->guest('login');
    }

    protected function invalidJson($request, ValidationException $exception)
    {
        return response()->json(Helper::formatStandardApiResponse('error', null, $exception->errors()), 200);
    }

    /**
     * A list of the inputs that are never flashed for validation exceptions.
     *
     * @var array<int, string>
     */
    protected $dontFlash = [
        'current_password',
        'password',
        'password_confirmation',
    ];

    /**
     * Register the exception handling callbacks for the application.
     *
     * @return void
     */
    public function register()
    {

        $this->reportable(function (Throwable $e) {
            //
        });
    }
}