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

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\Routing\Annotation\RouteScope;
  9. use Shopware\Core\Framework\Routing\ApiRouteScope;
  10. use Shopware\Core\Framework\Routing\KernelListenerPriorities;
  11. use Shopware\Core\PlatformRequest;
  12. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  13. use Symfony\Component\HttpFoundation\Request;
  14. use Symfony\Component\HttpKernel\Event\ControllerEvent;
  15. use Symfony\Component\HttpKernel\KernelEvents;
  17. /**
  18.  * @deprecated tag:v6.5.0 - reason:becomes-internal - EventSubscribers will become internal in v6.5.0
  19.  *
  20.  * @phpstan-type PluginData array{'composerName': string, 'active': bool, 'version': string}
  21.  */
  22. class ExpectationSubscriber implements EventSubscriberInterface
  23. {
  24.     private const SHOPWARE_CORE_PACKAGES = [
  25.         'shopware/platform',
  26.         'shopware/core',
  27.         'shopware/administration',
  28.         'shopware/elasticsearch',
  29.         'shopware/storefront',
  30.     ];
  32.     private string $shopwareVersion;
  34.     /**
  35.      * @var list<PluginData>
  36.      */
  37.     private array $plugins;
  39.     /**
  40.      * @internal
  41.      *
  42.      * @param list<PluginData> $plugins
  43.      */
  44.     public function __construct(string $shopwareVersion, array $plugins)
  45.     {
  46.         $this->shopwareVersion = $shopwareVersion;
  47.         $this->plugins = $plugins;
  48.     }
  50.     public static function getSubscribedEvents(): array
  51.     {
  52.         return [
  53.             KernelEvents::CONTROLLER => ['checkExpectations', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE_POST],
  54.         ];
  55.     }
  57.     public function checkExpectations(ControllerEvent $event): void
  58.     {
  59.         $request = $event->getRequest();
  61.         if (!$request->attributes->has(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE)) {
  62.             return;
  63.         }
  65.         /** @var RouteScope|list<string> $scope */
  66.         $scope = $request->attributes->get(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE, []);
  68.         if ($scope instanceof RouteScope) {
  69.             $scope = $scope->getScopes();
  70.         }
  72.         if (!\in_array(ApiRouteScope::ID, $scope, true)) {
  73.             return;
  74.         }
  76.         $expectations = $this->checkPackages($request);
  78.         if (\count($expectations)) {
  79.             throw new ExceptionFailedException($expectations);
  80.         }
  81.     }
  83.     /**
  84.      * @return list<string>
  85.      */
  86.     private function checkPackages(Request $request): array
  87.     {
  88.         // swag/plugin1:~6.1,swag/plugin2:~6.1
  89.         $extensionConstraints = array_filter(explode(',', (string) $request->headers->get(PlatformRequest::HEADER_EXPECT_PACKAGES)));
  90.         if ($extensionConstraints === []) {
  91.             return [];
  92.         }
  94.         $plugins = $this->getIndexedPackages();
  96.         $fails = [];
  98.         foreach ($extensionConstraints as $extension) {
  99.             $explode = explode(':', $extension);
  100.             if (\count($explode) !== 2) {
  101.                 $fails[] = sprintf('Got invalid string: "%s"', $extension);
  103.                 continue;
  104.             }
  106.             $name = $explode[0];
  107.             $constraint = $explode[1];
  109.             if (isset($plugins[$name])) {
  110.                 $installedVersion = $plugins[$name];
  111.             } else {
  112.                 try {
  113.                     $installedVersion = InstalledVersions::getPrettyVersion($name);
  114.                 } catch (\OutOfBoundsException $e) {
  115.                     $fails[] = sprintf('Requested package: %s is not available', $name);
  117.                     continue;
  118.                 }
  120.                 if (\in_array($name, self::SHOPWARE_CORE_PACKAGES, true)) {
  121.                     $installedVersion = $this->shopwareVersion;
  122.                 }
  123.             }
  125.             if ($installedVersion === null) {
  126.                 // should never happen, but phpstan would complain otherwise
  127.                 continue;
  128.             }
  130.             if (Semver::satisfies($installedVersion, $constraint)) {
  131.                 continue;
  132.             }
  134.             $fails[] = sprintf('Version constraint for %s is failed. Installed is: %s', $name, $installedVersion);
  135.         }
  137.         return $fails;
  138.     }
  140.     /**
  141.      * Plugins are not in the InstalledPackages file until now
  142.      *
  143.      * @return array<string, string>
  144.      */
  145.     private function getIndexedPackages(): array
  146.     {
  147.         $versions = [];
  149.         foreach ($this->plugins as $plugin) {
  150.             if (!$plugin['active']) {
  151.                 continue;
  152.             }
  154.             $versions[$plugin['composerName']] = $plugin['version'];
  155.         }
  157.         return $versions;
  158.     }
  159. }