src/Core/HttpKernel.php line 112

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core;
  5. use Composer\Autoload\ClassLoader;
  6. use Composer\InstalledVersions;
  7. use Doctrine\DBAL\Connection;
  8. use Doctrine\DBAL\Driver\Middleware;
  9. use Doctrine\DBAL\DriverManager;
  10. use Doctrine\DBAL\Exception;
  11. use Shopware\Core\Framework\Adapter\Cache\CacheIdLoader;
  12. use Shopware\Core\Framework\Adapter\Database\MySQLFactory;
  13. use Shopware\Core\Framework\Event\BeforeSendRedirectResponseEvent;
  14. use Shopware\Core\Framework\Event\BeforeSendResponseEvent;
  15. use Shopware\Core\Framework\Log\Package;
  16. use Shopware\Core\Framework\Plugin\KernelPluginLoader\DbalKernelPluginLoader;
  17. use Shopware\Core\Framework\Plugin\KernelPluginLoader\KernelPluginLoader;
  18. use Shopware\Core\Framework\Routing\CanonicalRedirectService;
  19. use Shopware\Core\Framework\Routing\RequestTransformerInterface;
  20. use Shopware\Core\Profiling\Doctrine\ProfilingMiddleware;
  21. use Shopware\Storefront\Framework\Cache\CacheStore;
  22. use Symfony\Component\HttpFoundation\RedirectResponse;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\HttpKernel\HttpCache\HttpCache;
  26. use Symfony\Component\HttpKernel\HttpKernelInterface;
  27. use Symfony\Component\HttpKernel\KernelInterface;
  28. use Symfony\Component\HttpKernel\TerminableInterface;
  30. /**
  31.  * @psalm-import-type Params from DriverManager
  32.  */
  33. #[Package('core')]
  34. class HttpKernel
  35. {
  36.     protected static ?Connection $connection = null;
  38.     /**
  39.      * @var class-string<Kernel>
  40.      */
  41.     protected static string $kernelClass = Kernel::class;
  43.     /**
  44.      * @var class-string<HttpCache>
  45.      */
  46.     protected static string $httpCacheClass = HttpCache::class;
  48.     protected ?string $projectDir = null;
  50.     protected ?KernelPluginLoader $pluginLoader = null;
  52.     protected ?KernelInterface $kernel = null;
  54.     public function __construct(protected string $environment, protected bool $debug, protected ?ClassLoader $classLoader = null)
  55.     {
  56.     }
  58.     public function handle(Request $request, int $type = HttpKernelInterface::MAIN_REQUEST, bool $catch = true): HttpKernelResult
  59.     {
  60.         try {
  61.             return $this->doHandle($request, $type, $catch);
  62.         } catch (Exception $e) {
  63.             /** @var Params|array{url?: string} $connectionParams */
  64.             $connectionParams = self::getConnection()->getParams();
  66.             $message = str_replace([$connectionParams['url'] ?? null, $connectionParams['password'] ?? null, $connectionParams['user'] ?? null], '******', $e->getMessage());
  68.             throw new \RuntimeException(sprintf('Could not connect to database. Message from SQL Server: %s', $message));
  69.         }
  70.     }
  72.     public function getKernel(): KernelInterface
  73.     {
  74.         return $this->createKernel();
  75.     }
  77.     /**
  78.      * Allows to switch the plugin loading.
  79.      */
  80.     public function setPluginLoader(KernelPluginLoader $pluginLoader): void
  81.     {
  82.         $this->pluginLoader = $pluginLoader;
  83.     }
  85.     /**
  86.      * @param array<Middleware> $middlewares
  87.      */
  88.     public static function getConnection(array $middlewares = []): Connection
  89.     {
  90.         if (self::$connection) {
  91.             return self::$connection;
  92.         }
  94.         self::$connection = MySQLFactory::create($middlewares);
  96.         return self::$connection;
  97.     }
  99.     public function terminate(Request $request, Response $response): void
  100.     {
  101.         if (!$this->kernel instanceof TerminableInterface) {
  102.             return;
  103.         }
  105.         $this->kernel->terminate($request, $response);
  106.     }
  108.     private function doHandle(Request $request, int $type, bool $catch): HttpKernelResult
  109.     {
  110.         // create core kernel which contains bootstrapping for plugins etc.
  111.         $kernel = $this->createKernel();
  112.         $kernel->boot();
  114.         $container = $kernel->getContainer();
  116.         // transform request to resolve seo urls and detect sales channel
  117.         $transformed = $container
  118.             ->get(RequestTransformerInterface::class)
  119.             ->transform($request);
  121.         $redirect = $container
  122.             ->get(CanonicalRedirectService::class)
  123.             ->getRedirect($transformed);
  125.         if ($redirect instanceof RedirectResponse) {
  126.             $event = new BeforeSendRedirectResponseEvent($transformed, $redirect);
  127.             $container->get('event_dispatcher')->dispatch($event);
  129.             return new HttpKernelResult($transformed, $event->getResponse());
  130.         }
  132.         // check for http caching
  133.         $enabled = $container->hasParameter('shopware.http.cache.enabled')
  134.             && $container->getParameter('shopware.http.cache.enabled');
  135.         if ($enabled && $container->has(CacheStore::class)) {
  136.             $kernel = new static::$httpCacheClass($kernel, $container->get(CacheStore::class), null, ['debug' => $this->debug]);
  137.         }
  139.         $response = $kernel->handle($transformed, $type, $catch);
  141.         // fire event to trigger runtime events like seo url headers
  142.         $event = new BeforeSendResponseEvent($transformed, $response);
  143.         $container->get('event_dispatcher')->dispatch($event);
  145.         return new HttpKernelResult($transformed, $event->getResponse());
  146.     }
  148.     private function createKernel(): KernelInterface
  149.     {
  150.         if ($this->kernel !== null) {
  151.             return $this->kernel;
  152.         }
  154.         if (InstalledVersions::isInstalled('shopware/platform')) {
  155.             $shopwareVersion = InstalledVersions::getVersion('shopware/platform')
  156.                 . '@' . InstalledVersions::getReference('shopware/platform');
  157.         } else {
  158.             $shopwareVersion = InstalledVersions::getVersion('shopware/core')
  159.                 . '@' . InstalledVersions::getReference('shopware/core');
  160.         }
  162.         $middlewares = [];
  163.         if (InstalledVersions::isInstalled('symfony/doctrine-bridge')) {
  164.             $middlewares = [new ProfilingMiddleware()];
  165.         }
  167.         $connection = self::getConnection($middlewares);
  169.         $pluginLoader = $this->createPluginLoader($connection);
  171.         $cacheId = (new CacheIdLoader($connection))->load();
  173.         return $this->kernel = new static::$kernelClass(
  174.             $this->environment,
  175.             $this->debug,
  176.             $pluginLoader,
  177.             $cacheId,
  178.             $shopwareVersion,
  179.             $connection,
  180.             $this->getProjectDir()
  181.         );
  182.     }
  184.     private function getProjectDir(): string
  185.     {
  186.         if ($this->projectDir === null) {
  187.             if ($dir = $_ENV['PROJECT_ROOT'] ?? $_SERVER['PROJECT_ROOT'] ?? false) {
  188.                 return $this->projectDir = $dir;
  189.             }
  191.             $r = new \ReflectionObject($this);
  193.             /** @var string $dir */
  194.             $dir = $r->getFileName();
  195.             if (!file_exists($dir)) {
  196.                 throw new \LogicException(sprintf('Cannot auto-detect project dir for kernel of class "%s".', $r->name));
  197.             }
  199.             $dir = $rootDir = \dirname($dir);
  200.             while (!file_exists($dir . '/vendor')) {
  201.                 if ($dir === \dirname($dir)) {
  202.                     return $this->projectDir = $rootDir;
  203.                 }
  204.                 $dir = \dirname($dir);
  205.             }
  206.             $this->projectDir = $dir;
  207.         }
  209.         return $this->projectDir;
  210.     }
  212.     private function createPluginLoader(Connection $connection): KernelPluginLoader
  213.     {
  214.         if ($this->pluginLoader) {
  215.             return $this->pluginLoader;
  216.         }
  218.         if (!$this->classLoader) {
  219.             throw new \RuntimeException('No plugin loader and no class loader provided');
  220.         }
  222.         $this->pluginLoader = new DbalKernelPluginLoader($this->classLoader, null, $connection);
  224.         return $this->pluginLoader;
  225.     }
  226. }