tenancy/src/Concerns/UsableWithEarlyIdentification.php

<?php

declare(strict_types=1);

namespace Stancl\Tenancy\Concerns;

use Illuminate\Http\Request;
use Illuminate\Routing\Route;
use Stancl\Tenancy\Enums\Context;
use Stancl\Tenancy\Enums\RouteMode;
use Stancl\Tenancy\Middleware\IdentificationMiddleware;
use Stancl\Tenancy\Middleware\PreventAccessFromUnwantedDomains;
use Stancl\Tenancy\Tenancy;

/**
 * This trait provides methods that check if a middleware's execution should be skipped.
 * This is primarily used to ensure that kernel identification is skipped when the route has
 * identification middleware (= route-level identification is prioritized over kernel identification).
 *
 * When using kernel domain identification, you'll most likely also use the PreventAccessFromUnwantedDomains middleware in the global stack.
 * PreventAccessFromUnwantedDomains isn't an identification middleware, but we have to skip it too,
 * e.g. when using the MW in the global stack and at the same time, we're using route-level identification.
 *
 * You need to use this trait directly on each identification middleware — it can't be used in a base class that's extended.
 * The inGlobalStack() method checks for the specific middleware the trait is used on (`static::class`).
 */
trait UsableWithEarlyIdentification
{
    /**
     * Determine if the tenant is present in the incoming request.
     *
     * Because universal routes can be in any context (central/tenant),
     * we use this to determine the context. We can't just check for
     * the route's middleware to determine the route's context.
     *
     * For example, route '/foo' has the 'universal' and InitializeTenancyByRequestData middleware.
     * When visiting the route, we should determine the context by the presence of the tenant payload.
     * The context is tenant if the tenant parameter is present (e.g. '?tenant=foo'), otherwise the context is central.
     */
    abstract public function requestHasTenant(Request $request): bool;

    /**
     * Skip middleware if the route is universal and uses path identification or if the route is universal and the context should be central.
     * Universal routes using path identification should get cloned using CloneRoutesAsTenant.
     *
     * @see \Stancl\Tenancy\Actions\CloneRoutesAsTenant
     */
    protected function shouldBeSkipped(Route $route): bool
    {
        if (Tenancy::routeIsUniversal($route) && $this instanceof IdentificationMiddleware) {
            return $this->determineUniversalRouteContextFromRequest(request()) === Context::CENTRAL;
        }

        // If the middleware is not in the global stack (= it's used directly on the route)
        // And the route isn't universal, don't skip it
        if (! static::inGlobalStack()) {
            return false;
        }

        // Now that we're sure the MW isn't used in the global MW stack, we determine whether to skip it
        if ($this instanceof PreventAccessFromUnwantedDomains) {
            // Skip access prevention if the route directly uses a non-domain identification middleware
            return Tenancy::routeHasIdentificationMiddleware($route) &&
                ! Tenancy::routeHasMiddleware($route, config('tenancy.identification.domain_identification_middleware'));
        }

        return $this->shouldSkipIdentificationMiddleware($route);
    }

    protected function determineUniversalRouteContextFromRequest(Request $request): Context
    {
        $route = Tenancy::getRoute($request);

        // Check if this is the identification middleware the route should be using
        // Route-level identification middleware is prioritized
        $globalIdentificationUsed = ! tenancy()->routeHasIdentificationMiddleware($route) && static::inGlobalStack();
        $routeLevelIdentificationUsed = tenancy()->routeHasMiddleware($route, static::class);

        if (($globalIdentificationUsed || $routeLevelIdentificationUsed) && $this->requestHasTenant($request)) {
            return Context::TENANT;
        }

        return Context::CENTRAL;
    }

    protected function shouldSkipIdentificationMiddleware(Route $route): bool
    {
        if (! static::inGlobalStack()) {
            return false;
        }

        $request = app(Request::class);

        if (! $request->attributes->get('_tenancy_kernel_identification_skipped')) {
            if (
                // Skip identification if the current route is central
                // The route is central if it's flagged as central
                // Or if it isn't flagged and the default route mode is set to central
                Tenancy::getRouteMode($route) === RouteMode::CENTRAL
            ) {
                return true;
            }

            // Skip kernel identification if the route uses route-level identification
            if (Tenancy::routeHasIdentificationMiddleware($route)) {
                // Remember that it was attempted to identify a tenant using kernel identification
                // By making the $kernelIdentificationSkipped property of the current Tenancy instance true
                // So that the next identification middleware gets executed (= route-level identification MW doesn't get skipped)
                $request->attributes->set('_tenancy_kernel_identification_skipped', true);

                // Skip kernel identification so that route-level identification middleware can get used
                return true;
            }
        }

        return false;
    }

    public static function inGlobalStack(): bool
    {
        return Tenancy::globalStackHasMiddleware(static::class);
    }
}