vendor/shopware/core/Framework/Api/EventListener/ExpectationSubscriber.php line 59

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Api\EventListener;
  5. use Composer\InstalledVersions;
  6. use Composer\Semver\Semver;
  7. use Shopware\Core\Framework\Api\Exception\ExceptionFailedException;
  8. use Shopware\Core\Framework\Log\Package;
  9. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  10. use Shopware\Core\Framework\Routing\ApiRouteScope;
  11. use Shopware\Core\Framework\Routing\KernelListenerPriorities;
  12. use Shopware\Core\PlatformRequest;
  13. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  16. use Symfony\Component\HttpKernel\KernelEvents;
  18. /**
  19.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  20.  *
  21.  * @phpstan-type PluginData array{'composerName': string, 'active': bool, 'version': string}
  22.  */
  23. #[Package('core')]
  24. class ExpectationSubscriber implements EventSubscriberInterface
  25. {
  26.     private const SHOPWARE_CORE_PACKAGES = [
  27.         'shopware/platform',
  28.         'shopware/core',
  29.         'shopware/administration',
  30.         'shopware/elasticsearch',
  31.         'shopware/storefront',
  32.     ];
  34.     private string $shopwareVersion;
  36.     /**
  37.      * @var list<PluginData>
  38.      */
  39.     private array $plugins;
  41.     /**
  42.      * @internal
  43.      *
  44.      * @param list<PluginData> $plugins
  45.      */
  46.     public function __construct(string $shopwareVersion, array $plugins)
  47.     {
  48.         $this->shopwareVersion = $shopwareVersion;
  49.         $this->plugins = $plugins;
  50.     }
  52.     public static function getSubscribedEvents(): array
  53.     {
  54.         return [
  55.             KernelEvents::CONTROLLER => ['checkExpectations', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE_POST],
  56.         ];
  57.     }
  59.     public function checkExpectations(ControllerEvent $event): void
  60.     {
  61.         $request = $event->getRequest();
  63.         if (!$request->attributes->has(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE)) {
  64.             return;
  65.         }
  67.         /** @var RouteScope|list<string> $scope */
  68.         $scope = $request->attributes->get(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE, []);
  70.         if ($scope instanceof RouteScope) {
  71.             $scope = $scope->getScopes();
  72.         }
  74.         if (!\in_array(ApiRouteScope::ID, $scope, true)) {
  75.             return;
  76.         }
  78.         $expectations = $this->checkPackages($request);
  80.         if (\count($expectations)) {
  81.             throw new ExceptionFailedException($expectations);
  82.         }
  83.     }
  85.     /**
  86.      * @return list<string>
  87.      */
  88.     private function checkPackages(Request $request): array
  89.     {
  90.         // swag/plugin1:~6.1,swag/plugin2:~6.1
  91.         $extensionConstraints = array_filter(explode(',', (string) $request->headers->get(PlatformRequest::HEADER_EXPECT_PACKAGES)));
  92.         if ($extensionConstraints === []) {
  93.             return [];
  94.         }
  96.         $plugins = $this->getIndexedPackages();
  98.         $fails = [];
  100.         foreach ($extensionConstraints as $extension) {
  101.             $explode = explode(':', $extension);
  102.             if (\count($explode) !== 2) {
  103.                 $fails[] = sprintf('Got invalid string: "%s"', $extension);
  105.                 continue;
  106.             }
  108.             $name = $explode[0];
  109.             $constraint = $explode[1];
  111.             if (isset($plugins[$name])) {
  112.                 $installedVersion = $plugins[$name];
  113.             } else {
  114.                 try {
  115.                     $installedVersion = InstalledVersions::getPrettyVersion($name);
  116.                 } catch (\OutOfBoundsException $e) {
  117.                     $fails[] = sprintf('Requested package: %s is not available', $name);
  119.                     continue;
  120.                 }
  122.                 if (\in_array($name, self::SHOPWARE_CORE_PACKAGES, true)) {
  123.                     $installedVersion = $this->shopwareVersion;
  124.                 }
  125.             }
  127.             if ($installedVersion === null) {
  128.                 // should never happen, but phpstan would complain otherwise
  129.                 continue;
  130.             }
  132.             if (Semver::satisfies($installedVersion, $constraint)) {
  133.                 continue;
  134.             }
  136.             $fails[] = sprintf('Version constraint for %s is failed. Installed is: %s', $name, $installedVersion);
  137.         }
  139.         return $fails;
  140.     }
  142.     /**
  143.      * Plugins are not in the InstalledPackages file until now
  144.      *
  145.      * @return array<string, string>
  146.      */
  147.     private function getIndexedPackages(): array
  148.     {
  149.         $versions = [];
  151.         foreach ($this->plugins as $plugin) {
  152.             if (!$plugin['active']) {
  153.                 continue;
  154.             }
  156.             $versions[$plugin['composerName']] = $plugin['version'];
  157.         }
  159.         return $versions;
  160.     }
  161. }