src/Core/Kernel.php line 155

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core;
  5. use Doctrine\DBAL\Connection;
  6. use Shopware\Core\DevOps\Environment\EnvironmentHelper;
  7. use Shopware\Core\Framework\Adapter\Database\MySQLFactory;
  8. use Shopware\Core\Framework\Api\Controller\FallbackController;
  9. use Shopware\Core\Framework\Log\Package;
  10. use Shopware\Core\Framework\Plugin\KernelPluginLoader\KernelPluginLoader;
  11. use Shopware\Core\Framework\Util\VersionParser;
  12. use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
  13. use Symfony\Component\Config\ConfigCache;
  14. use Symfony\Component\Config\Loader\LoaderInterface;
  15. use Symfony\Component\DependencyInjection\ContainerBuilder;
  16. use Symfony\Component\HttpKernel\Bundle\Bundle;
  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. #[Package('core')]
  23. class Kernel extends HttpKernel
  24. {
  25.     use MicroKernelTrait;
  27.     final public const CONFIG_EXTS = '.{php,xml,yaml,yml}';
  29.     /**
  30.      * @var string Fallback version if nothing is provided via kernel constructor
  31.      */
  32.     final public const SHOPWARE_FALLBACK_VERSION = '6.5.9999999.9999999-dev';
  34.     /**
  35.      * @var Connection|null
  36.      */
  37.     protected static $connection;
  39.     /**
  40.      * @var KernelPluginLoader
  41.      */
  42.     protected $pluginLoader;
  44.     /**
  45.      * @var string
  46.      */
  47.     protected $shopwareVersion;
  49.     /**
  50.      * @var string|null
  51.      */
  52.     protected $shopwareVersionRevision;
  54.     /**
  55.      * @var string|null
  56.      */
  57.     protected $projectDir;
  59.     private bool $rebooting = false;
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function __construct(
  65.         string $environment,
  66.         bool $debug,
  67.         KernelPluginLoader $pluginLoader,
  68.         private string $cacheId,
  69.         ?string $version = self::SHOPWARE_FALLBACK_VERSION,
  70.         ?Connection $connection = null,
  71.         ?string $projectDir = null
  72.     ) {
  73.         date_default_timezone_set('UTC');
  75.         parent::__construct($environment, $debug);
  76.         self::$connection = $connection;
  78.         $this->pluginLoader = $pluginLoader;
  80.         $version = VersionParser::parseShopwareVersion($version);
  81.         $this->shopwareVersion = $version['version'];
  82.         $this->shopwareVersionRevision = $version['revision'];
  83.         $this->projectDir = $projectDir;
  84.     }
  86.     /**
  87.      * @return iterable<BundleInterface>
  88.      */
  89.     public function registerBundles(): iterable
  90.     {
  91.         /** @var array<class-string<Bundle>, array<string, bool>> $bundles */
  92.         $bundles = require $this->getProjectDir() . '/config/bundles.php';
  93.         $instanciatedBundleNames = [];
  95.         foreach ($bundles as $class => $envs) {
  96.             if (isset($envs['all']) || isset($envs[$this->environment])) {
  97.                 $bundle = new $class();
  98.                 $instanciatedBundleNames[] = $bundle->getName();
  100.                 yield $bundle;
  101.             }
  102.         }
  104.         yield from $this->pluginLoader->getBundles($this->getKernelParameters(), $instanciatedBundleNames);
  105.     }
  107.     public function getProjectDir(): string
  108.     {
  109.         if ($this->projectDir === null) {
  110.             if ($dir = $_ENV['PROJECT_ROOT'] ?? $_SERVER['PROJECT_ROOT'] ?? false) {
  111.                 return $this->projectDir = $dir;
  112.             }
  114.             $r = new \ReflectionObject($this);
  116.             $dir = (string) $r->getFileName();
  117.             if (!file_exists($dir)) {
  118.                 throw new \LogicException(sprintf('Cannot auto-detect project dir for kernel of class "%s".', $r->name));
  119.             }
  121.             $dir = $rootDir = \dirname($dir);
  122.             while (!file_exists($dir . '/vendor')) {
  123.                 if ($dir === \dirname($dir)) {
  124.                     return $this->projectDir = $rootDir;
  125.                 }
  126.                 $dir = \dirname($dir);
  127.             }
  128.             $this->projectDir = $dir;
  129.         }
  131.         return $this->projectDir;
  132.     }
  134.     public function boot(): void
  135.     {
  136.         if ($this->booted === true) {
  137.             if ($this->debug) {
  138.                 $this->startTime = microtime(true);
  139.             }
  141.             return;
  142.         }
  144.         if ($this->debug) {
  145.             $this->startTime = microtime(true);
  146.         }
  148.         if ($this->debug && !EnvironmentHelper::hasVariable('SHELL_VERBOSITY')) {
  149.             putenv('SHELL_VERBOSITY=3');
  150.             $_ENV['SHELL_VERBOSITY'] = 3;
  151.             $_SERVER['SHELL_VERBOSITY'] = 3;
  152.         }
  154.         try {
  155.             $this->pluginLoader->initializePlugins($this->getProjectDir());
  156.         } catch (\Throwable $e) {
  157.             if (\defined('\STDERR')) {
  158.                 fwrite(\STDERR, 'Warning: Failed to load plugins. Message: ' . $e->getMessage() . \PHP_EOL);
  159.             }
  160.         }
  162.         // init bundles
  163.         $this->initializeBundles();
  165.         // init container
  166.         $this->initializeContainer();
  168.         foreach ($this->getBundles() as $bundle) {
  169.             $bundle->setContainer($this->container);
  170.             $bundle->boot();
  171.         }
  173.         $this->initializeDatabaseConnectionVariables();
  175.         $this->booted = true;
  176.     }
  178.     public static function getConnection(): Connection
  179.     {
  180.         if (self::$connection) {
  181.             return self::$connection;
  182.         }
  184.         self::$connection = MySQLFactory::create();
  186.         return self::$connection;
  187.     }
  189.     public function getCacheDir(): string
  190.     {
  191.         return sprintf(
  192.             '%s/var/cache/%s_h%s%s',
  193.             $this->getProjectDir(),
  194.             $this->getEnvironment(),
  195.             $this->getCacheHash(),
  196.             EnvironmentHelper::getVariable('TEST_TOKEN') ?? ''
  197.         );
  198.     }
  200.     public function getPluginLoader(): KernelPluginLoader
  201.     {
  202.         return $this->pluginLoader;
  203.     }
  205.     public function shutdown(): void
  206.     {
  207.         if (!$this->booted) {
  208.             return;
  209.         }
  211.         // keep connection when rebooting
  212.         if (!$this->rebooting) {
  213.             self::$connection = null;
  214.         }
  216.         parent::shutdown();
  217.     }
  219.     public function reboot($warmupDir, ?KernelPluginLoader $pluginLoader = null, ?string $cacheId = null): void
  220.     {
  221.         $this->rebooting = true;
  223.         try {
  224.             if ($pluginLoader) {
  225.                 $this->pluginLoader = $pluginLoader;
  226.             }
  227.             if ($cacheId) {
  228.                 $this->cacheId = $cacheId;
  229.             }
  230.             parent::reboot($warmupDir);
  231.         } finally {
  232.             $this->rebooting = false;
  233.         }
  234.     }
  236.     protected function configureContainer(ContainerBuilder $container, LoaderInterface $loader): void
  237.     {
  238.         $container->setParameter('container.dumper.inline_class_loader', true);
  239.         $container->setParameter('container.dumper.inline_factories', true);
  241.         $confDir = $this->getProjectDir() . '/config';
  243.         $loader->load($confDir . '/{packages}/*' . self::CONFIG_EXTS, 'glob');
  244.         $loader->load($confDir . '/{packages}/' . $this->environment . '/**/*' . self::CONFIG_EXTS, 'glob');
  245.         $loader->load($confDir . '/{services}' . self::CONFIG_EXTS, 'glob');
  246.         $loader->load($confDir . '/{services}_' . $this->environment . self::CONFIG_EXTS, 'glob');
  247.     }
  249.     protected function configureRoutes(RoutingConfigurator $routes): void
  250.     {
  251.         $confDir = $this->getProjectDir() . '/config';
  253.         $routes->import($confDir . '/{routes}/*' . self::CONFIG_EXTS, 'glob');
  254.         $routes->import($confDir . '/{routes}/' . $this->environment . '/**/*' . self::CONFIG_EXTS, 'glob');
  255.         $routes->import($confDir . '/{routes}' . self::CONFIG_EXTS, 'glob');
  257.         $this->addBundleRoutes($routes);
  258.         $this->addApiRoutes($routes);
  259.         $this->addBundleOverwrites($routes);
  260.         $this->addFallbackRoute($routes);
  261.     }
  263.     /**
  264.      * {@inheritdoc}
  265.      *
  266.      * @return array<string, mixed>
  267.      */
  268.     protected function getKernelParameters(): array
  269.     {
  270.         $parameters = parent::getKernelParameters();
  272.         $activePluginMeta = [];
  274.         foreach ($this->pluginLoader->getPluginInstances()->getActives() as $plugin) {
  275.             $class = $plugin::class;
  276.             $activePluginMeta[$class] = [
  277.                 'name' => $plugin->getName(),
  278.                 'path' => $plugin->getPath(),
  279.                 'class' => $class,
  280.             ];
  281.         }
  283.         $pluginDir = $this->pluginLoader->getPluginDir($this->getProjectDir());
  285.         $coreDir = \dirname((string) (new \ReflectionClass(self::class))->getFileName());
  287.         return array_merge(
  288.             $parameters,
  289.             [
  290.                 'kernel.cache.hash' => $this->getCacheHash(),
  291.                 'kernel.shopware_version' => $this->shopwareVersion,
  292.                 'kernel.shopware_version_revision' => $this->shopwareVersionRevision,
  293.                 'kernel.shopware_core_dir' => $coreDir,
  294.                 'kernel.plugin_dir' => $pluginDir,
  295.                 'kernel.app_dir' => rtrim($this->getProjectDir(), '/') . '/custom/apps',
  296.                 'kernel.active_plugins' => $activePluginMeta,
  297.                 'kernel.plugin_infos' => $this->pluginLoader->getPluginInfos(),
  298.                 'kernel.supported_api_versions' => [2, 3, 4],
  299.                 'defaults_bool_true' => true,
  300.                 'defaults_bool_false' => false,
  301.                 'default_whitespace' => ' ',
  302.             ]
  303.         );
  304.     }
  306.     protected function getCacheHash(): string
  307.     {
  308.         $plugins = [];
  309.         foreach ($this->pluginLoader->getPluginInfos() as $plugin) {
  310.             if ($plugin['active'] === false) {
  311.                 continue;
  312.             }
  313.             $plugins[$plugin['name']] = $plugin['version'];
  314.         }
  316.         $pluginHash = md5((string) json_encode($plugins, \JSON_THROW_ON_ERROR));
  318.         return md5((string) \json_encode([
  319.             $this->cacheId,
  320.             substr((string) $this->shopwareVersionRevision, 0, 8),
  321.             substr($pluginHash, 0, 8),
  322.             EnvironmentHelper::getVariable('DATABASE_URL', ''),
  323.         ], \JSON_THROW_ON_ERROR));
  324.     }
  326.     protected function initializeDatabaseConnectionVariables(): void
  327.     {
  328.         $shopwareSkipConnectionVariables = EnvironmentHelper::getVariable('SHOPWARE_SKIP_CONNECTION_VARIABLES', false);
  330.         if ($shopwareSkipConnectionVariables) {
  331.             return;
  332.         }
  334.         $connection = self::getConnection();
  336.         try {
  337.             $setSessionVariables = (bool) EnvironmentHelper::getVariable('SQL_SET_DEFAULT_SESSION_VARIABLES', true);
  338.             $connectionVariables = [];
  340.             $timeZoneSupportEnabled = (bool) EnvironmentHelper::getVariable('SHOPWARE_DBAL_TIMEZONE_SUPPORT_ENABLED', false);
  341.             if ($timeZoneSupportEnabled) {
  342.                 $connectionVariables[] = 'SET @@session.time_zone = "UTC"';
  343.             }
  345.             if ($setSessionVariables) {
  346.                 $connectionVariables[] = 'SET @@group_concat_max_len = CAST(IF(@@group_concat_max_len > 320000, @@group_concat_max_len, 320000) AS UNSIGNED)';
  347.                 $connectionVariables[] = 'SET sql_mode=(SELECT REPLACE(@@sql_mode,\'ONLY_FULL_GROUP_BY\',\'\'))';
  348.             }
  350.             if (empty($connectionVariables)) {
  351.                 return;
  352.             }
  353.             $connection->executeQuery(implode(';', $connectionVariables));
  354.         } catch (\Throwable) {
  355.         }
  356.     }
  358.     /**
  359.      * Dumps the preload file to an always known location outside the generated cache folder name
  360.      */
  361.     protected function dumpContainer(ConfigCache $cache, ContainerBuilder $container, string $class, string $baseClass): void
  362.     {
  363.         parent::dumpContainer($cache, $container, $class, $baseClass);
  364.         $cacheDir = $this->getCacheDir();
  365.         $cacheName = basename($cacheDir);
  366.         $fileName = substr(basename($cache->getPath()), 0, -3) . 'preload.php';
  368.         $preloadFile = \dirname($cacheDir) . '/opcache-preload.php';
  370.         $loader = <<<PHP
  371. <?php
  373. require_once __DIR__ . '/#CACHE_PATH#';
  374. PHP;
  376.         file_put_contents($preloadFile, str_replace(
  377.             ['#CACHE_PATH#'],
  378.             [$cacheName . '/' . $fileName],
  379.             $loader
  380.         ));
  381.     }
  383.     private function addApiRoutes(RoutingConfigurator $routes): void
  384.     {
  385.         $routes->import('.', 'api');
  386.     }
  388.     private function addBundleRoutes(RoutingConfigurator $routes): void
  389.     {
  390.         foreach ($this->getBundles() as $bundle) {
  391.             if ($bundle instanceof Framework\Bundle) {
  392.                 $bundle->configureRoutes($routes, $this->environment);
  393.             }
  394.         }
  395.     }
  397.     private function addBundleOverwrites(RoutingConfigurator $routes): void
  398.     {
  399.         foreach ($this->getBundles() as $bundle) {
  400.             if ($bundle instanceof Framework\Bundle) {
  401.                 $bundle->configureRouteOverwrites($routes, $this->environment);
  402.             }
  403.         }
  404.     }
  406.     private function addFallbackRoute(RoutingConfigurator $routes): void
  407.     {
  408.         // detail routes
  409.         $route = new Route('/');
  410.         $route->setMethods(['GET']);
  411.         $route->setDefault('_controller', FallbackController::class . '::rootFallback');
  412.         $route->setDefault(PlatformRequest::ATTRIBUTE_ROUTE_SCOPE, ['storefront']);
  414.         $routes->add('root.fallback', $route->getPath());
  415.     }
  416. }