ldc-boutique-cnc/app/Providers/RouteServiceProvider.php

<?php

namespace App\Providers;

use App\Enums\Order\DeliveryModeEnum;
use App\Enums\GeneralConfigType;
use App\Enums\Order\PaymentModeEnum;
use App\Enums\StaticPageType;
use App\Models\Shop\DeliveryMode;
use App\Models\Shop\Discount;
use App\Models\Site\GeneralConfig;
use App\Models\Shop\Order;
use App\Models\Shop\PaymentMode;
use App\Models\Merchandise\Product;
use App\Models\Merchandise\Range;
use App\Models\Site\StaticPage;
use App\Models\Merchandise\Tag;
use App\Models\Payment\Transaction;
use BadMethodCallException;
use Illuminate\Cache\RateLimiting\Limit;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Foundation\Support\Providers\RouteServiceProvider as ServiceProvider;
use Illuminate\Http\Request;
use Illuminate\Routing\Route as RoutingRoute;
use Illuminate\Support\Facades\RateLimiter;
use Illuminate\Support\Facades\Route;
use Kwaadpepper\Enum\Exceptions\EnumNotRoutableException;

class RouteServiceProvider extends ServiceProvider
{
    /**
     * The path to the "home" route for your application.
     *
     * This is used by Laravel authentication to redirect users after login.
     *
     * @var string
     */
    public const HOME = '/';

    /**
     * Define your route model bindings, pattern filters, etc.
     *
     * @return void
     */
    public function boot()
    {
        $this->configureRateLimiting();

        $this->cspReportRoute();

        $this->routes(function () {
            Route::middleware('web')
            ->namespace($this->namespace)
            ->group(base_path('routes/web-bo.php'));

            Route::middleware('web')
            ->namespace($this->namespace)
            ->group(base_path('routes/web-shop.php'));

            Route::middleware('web')
            ->namespace($this->namespace)
                ->group(base_path('routes/web-fo.php'));
        });

        // * BINDERS
        Route::model('discount', Discount::class);
        Route::model('product', Product::class);
        Route::model('range', Range::class);
        Route::model('tag', Tag::class);

        Route::bind('productSlug', function ($value) {
            return Product::query()->where('status', true)
            ->where('slug', $value)->firstOrFail();
        });
        Route::bind('rangeSlug', function ($value) {
            return Range::query()->where('status', true)
            ->where('slug', $value)->firstOrFail();
        });
        Route::bind('tagSlug', function ($value) {
            return Tag::query()->where('status', true)
            ->where('slug', $value)->firstOrFail();
        });

        Route::bind('reference', function ($value) {
            return Order::query()->where('reference', $value)->firstOrFail();
        });
        Route::bind('transactionReference', function ($value, RoutingRoute $previousRoute) {
            $previousOrder = $previousRoute->parameter('reference');
            if (
                !$previousRoute->hasParameter('reference') or
                !\is_object($previousOrder) or
                !($previousOrder instanceof Order)
            ) {
                \abort(404);
            }
            return Transaction::query()->where('reference', $value)
                ->whereHas('order', function (Builder $q) use ($previousOrder) {
                    return $q->where('id', $previousOrder->id);
                })->firstOrFail();
        });

        Route::bind('static_page_front', function ($value) {
            return StaticPage::where('slug', $value)->firstOrFail();
        });
        Route::bind('static_page', function ($value) {
            $page = null;
            try {
                if (\ctype_digit($value) and in_array(intval($value), StaticPageType::toValues())) {
                    $page = StaticPage::getPageOfType(StaticPageType::make(\intval($value)));
                }
            } finally {
                return $page ?? StaticPage::where('id', $value)->first() ?? abort(404);
            }
        });
        /** General config type enum to route */
        Route::bind('general_config', function ($value) {
            try {
                $value = \ctype_digit($value) ? \intval($value) : $value;
                if (in_array($value, GeneralConfigType::toValues())) {
                    return GeneralConfig::where('type', $value)->firstOrFail();
                }
                abort(404);
            } catch (BadMethodCallException | EnumNotRoutableException $e) {
                abort(404);
            }
        });

        $this->bindEnumsModels();
    }

    /**
     * Bind enum models to route params
     *
     * @return void
     */
    private function bindEnumsModels()
    {
        /** Delivery mode enum to route */
        Route::bind('delivery_mode', function ($value) {
            try {
                $value = \ctype_digit($value) ? \intval($value) : $value;
                /** @var \Illuminate\Database\Eloquent\Collection<\App\Models\Shop\DeliveryMode> */
                $deliveryModes = app('DeliveryModesGlobal');
                if (in_array($value, DeliveryModeEnum::toValues())) {
                    return $deliveryModes->first(function (DeliveryMode $deliveryMode) use ($value) {
                        return $deliveryMode->mode->value === $value;
                    });
                }
                abort(404);
            } catch (BadMethodCallException | EnumNotRoutableException $e) {
                abort(404);
            }
        });
        /** Payment mode enum to route */
        Route::bind('payment_mode', function ($value) {
            try {
                $value = \ctype_digit($value) ? \intval($value) : $value;
                /** @var \Illuminate\Database\Eloquent\Collection<\App\Models\Shop\PaymentMode> */
                $paymentModes = app('PaymentModesGlobal');
                if (in_array($value, PaymentModeEnum::toValues())) {
                    return $paymentModes->first(function (PaymentMode $paymentMode) use ($value) {
                        return $paymentMode->mode->value === $value;
                    });
                }
                abort(404);
            } catch (BadMethodCallException | EnumNotRoutableException $e) {
                abort(404);
            }
        });
    }

    /**
     * Configure the rate limiters for the application.
     *
     * @return void
     */
    protected function configureRateLimiting()
    {
        RateLimiter::for('api', function (Request $request) {
            return Limit::perMinute(150)->by(optional($request->user())->id ?: app('clientIp'));
        });
        RateLimiter::for('web', function (Request $request) {
            return Limit::perMinute(150)->by(optional($request->user())->id ?: app('clientIp'));
        });
        RateLimiter::for('credentials', function (Request $request) {
            return Limit::perMinute(30)->by(optional($request->user())->id ?: $request->ip());
        });
    }

    /**
     * * Register CSP report URI
     *
     * Put this function inside RouteServiceProvider,
     * and call it in RouteServiceProvider::boot
     *
     * ! Use this in conjonction with kwaadpepper/exception-handler
     *
     * @return void
     */
    private function cspReportRoute()
    {
        // * CSP REPORT URI, Please add /csp-report to VerifyCsrfToken $except middleware
        \Illuminate\Support\Facades\Route::post('/csp-report', function () {
            $isCspRequest = request()->header('Content-Type') === 'application/csp-report';
            if (!$isCspRequest or !request()->json('csp-report') or !is_array(request()->json('csp-report'))) {
                abort(401);
            }
            // * Flatten if needed
            $cspReport = collect(request()->json('csp-report'))
            ->flatMap(function ($v, $k) {
                return [$k => is_array($v) ? collect($v)->flatten()->implode(', ') : $v];
            })->all();
            // * Filter array keys
            $cspReport = collect(array_intersect_key($cspReport, [
                'blocked-uri' => '', 'document-uri' => '', 'original-policy' => '',
                'referrer' => '', 'violated-directive' => ''
            ]));
            \Illuminate\Support\Facades\Log::warning(sprintf(
                "CSP REPORT for %s : \n %s",
                $cspReport->get('document-uri'),
                $cspReport->implode("\n")
            ));
        })->middleware('throttle:5,2')
        ->withoutMiddleware(\App\Http\Middleware\VerifyCsrfToken::class)
            ->name('cspReportUri');
    }
}