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

  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\ExpectationFailedException;
  8. use Shopware\Core\Framework\Log\Package;
  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.  * @internal
  19.  *
  20.  * @phpstan-type PluginData array{'composerName': string, 'active': bool, 'version': string}
  21.  */
  22. #[Package('core')]
  23. class ExpectationSubscriber implements EventSubscriberInterface
  24. {
  25.     private const SHOPWARE_CORE_PACKAGES = [
  26.         'shopware/platform',
  27.         'shopware/core',
  28.         'shopware/administration',
  29.         'shopware/elasticsearch',
  30.         'shopware/storefront',
  31.     ];
  33.     /**
  34.      * @internal
  35.      *
  36.      * @param list<PluginData> $plugins
  37.      */
  38.     public function __construct(private readonly string $shopwareVersion, private readonly array $plugins)
  39.     {
  40.     }
  42.     public static function getSubscribedEvents(): array
  43.     {
  44.         return [
  45.             KernelEvents::CONTROLLER => ['checkExpectations', KernelListenerPriorities::KERNEL_CONTROLLER_EVENT_SCOPE_VALIDATE_POST],
  46.         ];
  47.     }
  49.     public function checkExpectations(ControllerEvent $event): void
  50.     {
  51.         $request = $event->getRequest();
  53.         if (!$request->attributes->has(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE)) {
  54.             return;
  55.         }
  57.         /** @var list<string> $scope */
  58.         $scope = $request->attributes->get(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE, []);
  60.         if (!\in_array(ApiRouteScope::ID, $scope, true)) {
  61.             return;
  62.         }
  64.         $expectations = $this->checkPackages($request);
  66.         if (\count($expectations)) {
  67.             throw new ExpectationFailedException($expectations);
  68.         }
  69.     }
  71.     /**
  72.      * @return list<string>
  73.      */
  74.     private function checkPackages(Request $request): array
  75.     {
  76.         // swag/plugin1:~6.1,swag/plugin2:~6.1
  77.         $extensionConstraints = array_filter(explode(',', (string) $request->headers->get(PlatformRequest::HEADER_EXPECT_PACKAGES)));
  78.         if ($extensionConstraints === []) {
  79.             return [];
  80.         }
  82.         $plugins = $this->getIndexedPackages();
  84.         $fails = [];
  86.         foreach ($extensionConstraints as $extension) {
  87.             $explode = explode(':', $extension);
  88.             if (\count($explode) !== 2) {
  89.                 $fails[] = sprintf('Got invalid string: "%s"', $extension);
  91.                 continue;
  92.             }
  94.             $name = $explode[0];
  95.             $constraint = $explode[1];
  97.             if (isset($plugins[$name])) {
  98.                 $installedVersion = $plugins[$name];
  99.             } else {
  100.                 try {
  101.                     $installedVersion = InstalledVersions::getPrettyVersion($name);
  102.                 } catch (\OutOfBoundsException) {
  103.                     $fails[] = sprintf('Requested package: %s is not available', $name);
  105.                     continue;
  106.                 }
  108.                 if (\in_array($name, self::SHOPWARE_CORE_PACKAGES, true)) {
  109.                     $installedVersion = $this->shopwareVersion;
  110.                 }
  111.             }
  113.             if ($installedVersion === null) {
  114.                 // should never happen, but phpstan would complain otherwise
  115.                 continue;
  116.             }
  118.             if (Semver::satisfies($installedVersion, $constraint)) {
  119.                 continue;
  120.             }
  122.             $fails[] = sprintf('Version constraint for %s is failed. Installed is: %s', $name, $installedVersion);
  123.         }
  125.         return $fails;
  126.     }
  128.     /**
  129.      * Plugins are not in the InstalledPackages file until now
  130.      *
  131.      * @return array<string, string>
  132.      */
  133.     private function getIndexedPackages(): array
  134.     {
  135.         $versions = [];
  137.         foreach ($this->plugins as $plugin) {
  138.             if (!$plugin['active']) {
  139.                 continue;
  140.             }
  142.             $versions[$plugin['composerName']] = $plugin['version'];
  143.         }
  145.         return $versions;
  146.     }
  147. }