vendor/shopware/core/Framework/Routing/RouteScopeListener.php line 55

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Routing;
  5. use Shopware\Core\Framework\Routing\Annotation\RouteScope as RouteScopeAnnotation;
  6. use Shopware\Core\Framework\Routing\Exception\InvalidRouteScopeException;
  7. use Shopware\Core\PlatformRequest;
  8. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpFoundation\RequestStack;
  11. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  12. use Symfony\Component\HttpKernel\KernelEvents;
  14. /**
  15.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  16.  */
  17. class RouteScopeListener implements EventSubscriberInterface
  18. {
  19.     private RequestStack $requestStack;
  21.     private RouteScopeRegistry $routeScopeRegistry;
  23.     /**
  24.      * @var RouteScopeWhitelistInterface[]
  25.      */
  26.     private array $whitelists;
  28.     /**
  29.      * @internal
  30.      *
  31.      * @param iterable<RouteScopeWhitelistInterface> $whitelists
  32.      */
  33.     public function __construct(
  34.         RouteScopeRegistry $routeScopeRegistry,
  35.         RequestStack $requestStack,
  36.         iterable $whitelists
  37.     ) {
  38.         $this->routeScopeRegistry = $routeScopeRegistry;
  39.         $this->requestStack = $requestStack;
  40.         $this->whitelists = \is_array($whitelists) ? $whitelists : iterator_to_array($whitelists);
  41.     }
  43.     public static function getSubscribedEvents(): array
  44.     {
  45.         return [
  46.             KernelEvents::CONTROLLER => [
  47.                 ['checkScope', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE],
  48.             ],
  49.         ];
  50.     }
  52.     /**
  53.      * Validate that any given controller invocation creates a valid scope with the original master request
  54.      */
  55.     public function checkScope(ControllerEvent $event): void
  56.     {
  57.         if ($this->isWhitelistedController($event)) {
  58.             return;
  59.         }
  61.         $scopes = $this->extractCurrentScopeAnnotation($event);
  62.         $masterRequest = $this->getMainRequest();
  64.         foreach ($scopes as $routeScopeName) {
  65.             $routeScope = $this->routeScopeRegistry->getRouteScope($routeScopeName);
  67.             $pathAllowed = $routeScope->isAllowedPath($masterRequest->getPathInfo());
  68.             $requestAllowed = $routeScope->isAllowed($masterRequest);
  70.             if ($pathAllowed && $requestAllowed) {
  71.                 return;
  72.             }
  73.         }
  75.         throw new InvalidRouteScopeException($masterRequest->attributes->get('_route'));
  76.     }
  78.     private function extractControllerClass(ControllerEvent $event): ?string
  79.     {
  80.         $controllerCallable = \Closure::fromCallable($event->getController());
  81.         $controllerCallable = new \ReflectionFunction($controllerCallable);
  83.         $controller = $controllerCallable->getClosureThis();
  85.         if (!$controller) {
  86.             return null;
  87.         }
  89.         return \get_class($controller);
  90.     }
  92.     private function isWhitelistedController(ControllerEvent $event): bool
  93.     {
  94.         $controllerClass = $this->extractControllerClass($event);
  96.         if (!$controllerClass) {
  97.             return false;
  98.         }
  100.         foreach ($this->whitelists as $whitelist) {
  101.             if ($whitelist->applies($controllerClass)) {
  102.                 return true;
  103.             }
  104.         }
  106.         return false;
  107.     }
  109.     /**
  110.      * @return list<string>
  111.      */
  112.     private function extractCurrentScopeAnnotation(ControllerEvent $event): array
  113.     {
  114.         $currentRequest = $event->getRequest();
  116.         /** @var RouteScopeAnnotation|list<string> $scopes */
  117.         $scopes = $currentRequest->get(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE, []);
  119.         if ($scopes instanceof RouteScopeAnnotation) {
  120.             return $scopes->getScopes();
  121.         }
  123.         if ($scopes !== []) {
  124.             return $scopes;
  125.         }
  127.         throw new InvalidRouteScopeException($currentRequest->attributes->get('_route'));
  128.     }
  130.     private function getMainRequest(): Request
  131.     {
  132.         $masterRequest = $this->requestStack->getMainRequest();
  134.         if (!$masterRequest) {
  135.             throw new \InvalidArgumentException('Unable to check the request scope without master request');
  136.         }
  138.         return $masterRequest;
  139.     }
  140. }