vendor/shopware/core/Kernel.php line 403

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core;
  5. use Doctrine\DBAL\Connection;
  6. use Doctrine\DBAL\FetchMode;
  7. use Shopware\Core\DevOps\Environment\EnvironmentHelper;
  8. use Shopware\Core\Framework\Adapter\Database\MySQLFactory;
  9. use Shopware\Core\Framework\Api\Controller\FallbackController;
  10. use Shopware\Core\Framework\Migration\MigrationStep;
  11. use Shopware\Core\Framework\Plugin\KernelPluginLoader\KernelPluginLoader;
  12. use Shopware\Core\Maintenance\Maintenance;
  13. use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
  14. use Symfony\Component\Config\ConfigCache;
  15. use Symfony\Component\Config\Loader\LoaderInterface;
  16. use Symfony\Component\DependencyInjection\ContainerBuilder;
  17. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  18. use Symfony\Component\HttpKernel\Kernel as HttpKernel;
  19. use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
  20. use Symfony\Component\Routing\Route;
  22. class Kernel extends HttpKernel
  23. {
  24.     use MicroKernelTrait;
  26.     /**
  27.      * @internal
  28.      *
  29.      * @deprecated tag:v6.5.0 The connection requirements should be fixed
  30.      */
  31.     public const PLACEHOLDER_DATABASE_URL = 'mysql://_placeholder.test';
  33.     public const CONFIG_EXTS = '.{php,xml,yaml,yml}';
  35.     /**
  36.      * @var string Fallback version if nothing is provided via kernel constructor
  37.      */
  38.     public const SHOPWARE_FALLBACK_VERSION = '6.4.9999999.9999999-dev';
  40.     /**
  41.      * @var string Regex pattern for validating Shopware versions
  42.      */
  43.     private const VALID_VERSION_PATTERN = '#^\d\.\d+\.\d+\.(\d+|x)(-\w+)?#';
  45.     /**
  46.      * @var Connection|null
  47.      */
  48.     protected static $connection;
  50.     /**
  51.      * @var KernelPluginLoader
  52.      */
  53.     protected $pluginLoader;
  55.     /**
  56.      * @var string
  57.      */
  58.     protected $shopwareVersion;
  60.     /**
  61.      * @var string|null
  62.      */
  63.     protected $shopwareVersionRevision;
  65.     /**
  66.      * @var string|null
  67.      */
  68.     protected $projectDir;
  70.     private bool $rebooting = false;
  72.     private string $cacheId;
  74.     /**
  75.      * {@inheritdoc}
  76.      */
  77.     public function __construct(
  78.         string $environment,
  79.         bool $debug,
  80.         KernelPluginLoader $pluginLoader,
  81.         string $cacheId,
  82.         ?string $version = self::SHOPWARE_FALLBACK_VERSION,
  83.         ?Connection $connection = null,
  84.         ?string $projectDir = null
  85.     ) {
  86.         date_default_timezone_set('UTC');
  88.         parent::__construct($environment, $debug);
  89.         self::$connection = $connection;
  91.         $this->pluginLoader = $pluginLoader;
  93.         $this->parseShopwareVersion($version);
  94.         $this->cacheId = $cacheId;
  95.         $this->projectDir = $projectDir;
  96.     }
  98.     /**
  99.      * @return \Generator<BundleInterface>
  100.      *
  101.      * @deprecated tag:v6.5.0 - reason:return-type-change -  The return type will be native
  102.      */
  103.     public function registerBundles()/*: \Generator*/
  104.     {
  105.         /** @var array $bundles */
  106.         $bundles = require $this->getProjectDir() . '/config/bundles.php';
  107.         $instanciatedBundleNames = [];
  109.         /** @var class-string<\Symfony\Component\HttpKernel\Bundle\Bundle> $class */
  110.         foreach ($bundles as $class => $envs) {
  111.             if (isset($envs['all']) || isset($envs[$this->environment])) {
  112.                 $bundle = new $class();
  113.                 $instanciatedBundleNames[] = $bundle->getName();
  115.                 yield $bundle;
  116.             }
  117.         }
  119.         /* @deprecated tag:v6.5.0 Maintenance bundle need to be added to config/bundles.php file */
  120.         if (!\in_array('Maintenance', $instanciatedBundleNames, true)) {
  121.             yield new Maintenance();
  122.         }
  124.         yield from $this->pluginLoader->getBundles($this->getKernelParameters(), $instanciatedBundleNames);
  125.     }
  127.     /**
  128.      * @return string
  129.      *
  130.      * @deprecated tag:v6.5.0 - reason:return-type-change - The return type will be native
  131.      */
  132.     public function getProjectDir()/*: string*/
  133.     {
  134.         if ($this->projectDir === null) {
  135.             if ($dir = $_ENV['PROJECT_ROOT'] ?? $_SERVER['PROJECT_ROOT'] ?? false) {
  136.                 return $this->projectDir = $dir;
  137.             }
  139.             $r = new \ReflectionObject($this);
  141.             $dir = (string) $r->getFileName();
  142.             if (!file_exists($dir)) {
  143.                 throw new \LogicException(sprintf('Cannot auto-detect project dir for kernel of class "%s".', $r->name));
  144.             }
  146.             $dir = $rootDir = \dirname($dir);
  147.             while (!file_exists($dir . '/vendor')) {
  148.                 if ($dir === \dirname($dir)) {
  149.                     return $this->projectDir = $rootDir;
  150.                 }
  151.                 $dir = \dirname($dir);
  152.             }
  153.             $this->projectDir = $dir;
  154.         }
  156.         return $this->projectDir;
  157.     }
  159.     public function boot(): void
  160.     {
  161.         if ($this->booted === true) {
  162.             if ($this->debug) {
  163.                 $this->startTime = microtime(true);
  164.             }
  166.             return;
  167.         }
  169.         if ($this->debug) {
  170.             $this->startTime = microtime(true);
  171.         }
  173.         if ($this->debug && !EnvironmentHelper::hasVariable('SHELL_VERBOSITY')) {
  174.             putenv('SHELL_VERBOSITY=3');
  175.             $_ENV['SHELL_VERBOSITY'] = 3;
  176.             $_SERVER['SHELL_VERBOSITY'] = 3;
  177.         }
  179.         try {
  180.             $this->pluginLoader->initializePlugins($this->getProjectDir());
  181.         } catch (\Throwable $e) {
  182.             if (\defined('\STDERR')) {
  183.                 fwrite(\STDERR, 'Warning: Failed to load plugins. Message: ' . $e->getMessage() . \PHP_EOL);
  184.             }
  185.         }
  187.         // init bundles
  188.         $this->initializeBundles();
  190.         // init container
  191.         $this->initializeContainer();
  193.         foreach ($this->getBundles() as $bundle) {
  194.             $bundle->setContainer($this->container);
  195.             $bundle->boot();
  196.         }
  198.         $this->initializeDatabaseConnectionVariables();
  200.         $this->booted = true;
  201.     }
  203.     public static function getConnection(): Connection
  204.     {
  205.         if (self::$connection) {
  206.             return self::$connection;
  207.         }
  209.         self::$connection = MySQLFactory::create();
  211.         return self::$connection;
  212.     }
  214.     public function getCacheDir(): string
  215.     {
  216.         return sprintf(
  217.             '%s/var/cache/%s_h%s%s',
  218.             $this->getProjectDir(),
  219.             $this->getEnvironment(),
  220.             $this->getCacheHash(),
  221.             EnvironmentHelper::getVariable('TEST_TOKEN') ?? ''
  222.         );
  223.     }
  225.     public function getPluginLoader(): KernelPluginLoader
  226.     {
  227.         return $this->pluginLoader;
  228.     }
  230.     public function shutdown(): void
  231.     {
  232.         if (!$this->booted) {
  233.             return;
  234.         }
  236.         // keep connection when rebooting
  237.         if (!$this->rebooting) {
  238.             self::$connection = null;
  239.         }
  241.         parent::shutdown();
  242.     }
  244.     public function reboot($warmupDir, ?KernelPluginLoader $pluginLoader = null, ?string $cacheId = null): void
  245.     {
  246.         $this->rebooting = true;
  248.         try {
  249.             if ($pluginLoader) {
  250.                 $this->pluginLoader = $pluginLoader;
  251.             }
  252.             if ($cacheId) {
  253.                 $this->cacheId = $cacheId;
  254.             }
  255.             parent::reboot($warmupDir);
  256.         } finally {
  257.             $this->rebooting = false;
  258.         }
  259.     }
  261.     protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader): void
  262.     {
  263.         $container->setParameter('container.dumper.inline_class_loader', true);
  264.         $container->setParameter('container.dumper.inline_factories', true);
  266.         $confDir = $this->getProjectDir() . '/config';
  268.         $loader->load($confDir . '/{packages}/*' . self::CONFIG_EXTS, 'glob');
  269.         $loader->load($confDir . '/{packages}/' . $this->environment . '/**/*' . self::CONFIG_EXTS, 'glob');
  270.         $loader->load($confDir . '/{services}' . self::CONFIG_EXTS, 'glob');
  271.         $loader->load($confDir . '/{services}_' . $this->environment . self::CONFIG_EXTS, 'glob');
  272.     }
  274.     protected function configureRoutes(RoutingConfigurator $routes): void
  275.     {
  276.         $confDir = $this->getProjectDir() . '/config';
  278.         $routes->import($confDir . '/{routes}/*' . self::CONFIG_EXTS, 'glob');
  279.         $routes->import($confDir . '/{routes}/' . $this->environment . '/**/*' . self::CONFIG_EXTS, 'glob');
  280.         $routes->import($confDir . '/{routes}' . self::CONFIG_EXTS, 'glob');
  282.         $this->addBundleRoutes($routes);
  283.         $this->addApiRoutes($routes);
  284.         $this->addBundleOverwrites($routes);
  285.         $this->addFallbackRoute($routes);
  286.     }
  288.     /**
  289.      * {@inheritdoc}
  290.      */
  291.     protected function getKernelParameters(): array
  292.     {
  293.         $parameters = parent::getKernelParameters();
  295.         $activePluginMeta = [];
  297.         foreach ($this->pluginLoader->getPluginInstances()->getActives() as $plugin) {
  298.             $class = \get_class($plugin);
  299.             $activePluginMeta[$class] = [
  300.                 'name' => $plugin->getName(),
  301.                 'path' => $plugin->getPath(),
  302.                 'class' => $class,
  303.             ];
  304.         }
  306.         $pluginDir = $this->pluginLoader->getPluginDir($this->getProjectDir());
  308.         $coreDir = \dirname((string) (new \ReflectionClass(self::class))->getFileName());
  310.         return array_merge(
  311.             $parameters,
  312.             [
  313.                 'kernel.cache.hash' => $this->getCacheHash(),
  314.                 'kernel.shopware_version' => $this->shopwareVersion,
  315.                 'kernel.shopware_version_revision' => $this->shopwareVersionRevision,
  316.                 'kernel.shopware_core_dir' => $coreDir,
  317.                 'kernel.plugin_dir' => $pluginDir,
  318.                 'kernel.app_dir' => rtrim($this->getProjectDir(), '/') . '/custom/apps',
  319.                 'kernel.active_plugins' => $activePluginMeta,
  320.                 'kernel.plugin_infos' => $this->pluginLoader->getPluginInfos(),
  321.                 'kernel.supported_api_versions' => [2, 3, 4],
  322.                 'defaults_bool_true' => true,
  323.                 'defaults_bool_false' => false,
  324.                 'default_whitespace' => ' ',
  325.             ]
  326.         );
  327.     }
  329.     protected function getCacheHash(): string
  330.     {
  331.         $plugins = [];
  332.         foreach ($this->pluginLoader->getPluginInfos() as $plugin) {
  333.             if ($plugin['active'] === false) {
  334.                 continue;
  335.             }
  336.             $plugins[$plugin['name']] = $plugin['version'];
  337.         }
  339.         $pluginHash = md5((string) json_encode($plugins, \JSON_THROW_ON_ERROR));
  341.         return md5((string) \json_encode([
  342.             $this->cacheId,
  343.             substr((string) $this->shopwareVersionRevision, 0, 8),
  344.             substr($pluginHash, 0, 8),
  345.             EnvironmentHelper::getVariable('DATABASE_URL', ''),
  346.         ], \JSON_THROW_ON_ERROR));
  347.     }
  349.     protected function initializeDatabaseConnectionVariables(): void
  350.     {
  351.         $shopwareSkipConnectionVariables = EnvironmentHelper::getVariable('SHOPWARE_SKIP_CONNECTION_VARIABLES', false);
  353.         if ($shopwareSkipConnectionVariables) {
  354.             return;
  355.         }
  357.         $connection = self::getConnection();
  359.         try {
  360.             $nonDestructiveMigrations = $connection->executeQuery('
  361.             SELECT `creation_timestamp`
  362.             FROM `migration`
  363.             WHERE `update` IS NOT NULL AND `update_destructive` IS NULL
  364.         ')->fetchAll(FetchMode::COLUMN);
  366.             $activeMigrations = $this->container->getParameter('migration.active');
  368.             $activeNonDestructiveMigrations = array_intersect($activeMigrations, $nonDestructiveMigrations);
  370.             $setSessionVariables = (bool) EnvironmentHelper::getVariable('SQL_SET_DEFAULT_SESSION_VARIABLES', true);
  371.             $connectionVariables = [];
  373.             $timeZoneSupportEnabled = (bool) EnvironmentHelper::getVariable('SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED', false);
  374.             if ($timeZoneSupportEnabled) {
  375.                 $connectionVariables[] = 'SET @@session.time_zone = "UTC"';
  376.             }
  378.             if ($setSessionVariables) {
  379.                 $connectionVariables[] = 'SET @@group_concat_max_len = CAST(IF(@@group_concat_max_len > 320000, @@group_concat_max_len, 320000) AS UNSIGNED)';
  380.                 $connectionVariables[] = "SET sql_mode=(SELECT REPLACE(@@sql_mode,'ONLY_FULL_GROUP_BY',''))";
  381.             }
  383.             foreach ($activeNonDestructiveMigrations as $migration) {
  384.                 $connectionVariables[] = sprintf(
  385.                     'SET %s = TRUE',
  386.                     sprintf(MigrationStep::MIGRATION_VARIABLE_FORMAT, $migration)
  387.                 );
  388.             }
  390.             if (empty($connectionVariables)) {
  391.                 return;
  392.             }
  393.             $connection->executeQuery(implode(';', $connectionVariables));
  394.         } catch (\Throwable $_) {
  395.         }
  396.     }
  398.     /**
  399.      * Dumps the preload file to an always known location outside the generated cache folder name
  400.      */
  401.     protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, string $class, string $baseClass): void
  402.     {
  403.         parent::dumpContainer($cache, $container, $class, $baseClass);
  404.         $cacheDir = $this->getCacheDir();
  405.         $cacheName = basename($cacheDir);
  406.         $fileName = substr(basename($cache->getPath()), 0, -3) . 'preload.php';
  408.         $preloadFile = \dirname($cacheDir) . '/opcache-preload.php';
  410.         $loader = <<<PHP
  411. <?php
  413. require_once __DIR__ . '/#CACHE_PATH#';
  414. PHP;
  416.         file_put_contents($preloadFile, str_replace(
  417.             ['#CACHE_PATH#'],
  418.             [$cacheName . '/' . $fileName],
  419.             $loader
  420.         ));
  421.     }
  423.     private function addApiRoutes(RoutingConfigurator $routes): void
  424.     {
  425.         $routes->import('.', 'api');
  426.     }
  428.     private function addBundleRoutes(RoutingConfigurator $routes): void
  429.     {
  430.         foreach ($this->getBundles() as $bundle) {
  431.             if ($bundle instanceof Framework\Bundle) {
  432.                 $bundle->configureRoutes($routes, $this->environment);
  433.             }
  434.         }
  435.     }
  437.     private function addBundleOverwrites(RoutingConfigurator $routes): void
  438.     {
  439.         foreach ($this->getBundles() as $bundle) {
  440.             if ($bundle instanceof Framework\Bundle) {
  441.                 $bundle->configureRouteOverwrites($routes, $this->environment);
  442.             }
  443.         }
  444.     }
  446.     private function addFallbackRoute(RoutingConfigurator $routes): void
  447.     {
  448.         // detail routes
  449.         $route = new Route('/');
  450.         $route->setMethods(['GET']);
  451.         $route->setDefault('_controller', FallbackController::class . '::rootFallback');
  452.         $route->setDefault(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE, ['storefront']);
  454.         $routes->add('root.fallback', $route->getPath());
  455.     }
  457.     private function parseShopwareVersion(?string $version): void
  458.     {
  459.         // does not come from composer, was set manually
  460.         if ($version === null || mb_strpos($version, '@') === false) {
  461.             $this->shopwareVersion = self::SHOPWARE_FALLBACK_VERSION;
  462.             $this->shopwareVersionRevision = str_repeat('0', 32);
  464.             return;
  465.         }
  467.         [$version, $hash] = explode('@', $version);
  468.         $version = ltrim($version, 'v');
  469.         $version = str_replace('+', '-', $version);
  471.         /*
  472.          * checks if the version is a valid version pattern
  473.          * Shopware\Core\Framework\Test\KernelTest::testItCreatesShopwareVersion()
  474.          */
  475.         if (!preg_match(self::VALID_VERSION_PATTERN, $version)) {
  476.             $version = self::SHOPWARE_FALLBACK_VERSION;
  477.         }
  479.         $this->shopwareVersion = $version;
  480.         $this->shopwareVersionRevision = $hash;
  481.     }
  482. }