vendor/pimcore/pimcore/lib/Kernel.php line 260

Open in your IDE?
  1. <?php
  2. /**
  3.  * Pimcore
  4.  *
  5.  * This source file is available under two different licenses:
  6.  * - GNU General Public License version 3 (GPLv3)
  7.  * - Pimcore Commercial License (PCL)
  8.  * Full copyright and license information is available in
  9.  * LICENSE.md which is distributed with this source code.
  10.  *
  11.  *  @copyright  Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  12.  *  @license    http://www.pimcore.org/license     GPLv3 and PCL
  13.  */
  14. namespace Pimcore;
  15. use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
  16. use Doctrine\Bundle\MigrationsBundle\DoctrineMigrationsBundle;
  17. use FOS\JsRoutingBundle\FOSJsRoutingBundle;
  18. use League\FlysystemBundle\FlysystemBundle;
  19. use Pimcore\Bundle\AdminBundle\PimcoreAdminBundle;
  20. use Pimcore\Bundle\CoreBundle\PimcoreCoreBundle;
  21. use Pimcore\Cache\Runtime;
  22. use Pimcore\Config\BundleConfigLocator;
  23. use Pimcore\Event\SystemEvents;
  24. use Pimcore\Extension\Bundle\Config\StateConfig;
  25. use Pimcore\HttpKernel\BundleCollection\BundleCollection;
  26. use Pimcore\HttpKernel\BundleCollection\ItemInterface;
  27. use Pimcore\HttpKernel\BundleCollection\LazyLoadedItem;
  28. use Presta\SitemapBundle\PrestaSitemapBundle;
  29. use Scheb\TwoFactorBundle\SchebTwoFactorBundle;
  30. use Sensio\Bundle\FrameworkExtraBundle\SensioFrameworkExtraBundle;
  31. use Symfony\Bundle\DebugBundle\DebugBundle;
  32. use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
  33. use Symfony\Bundle\FrameworkBundle\Kernel\MicroKernelTrait;
  34. use Symfony\Bundle\MonologBundle\MonologBundle;
  35. use Symfony\Bundle\SecurityBundle\SecurityBundle;
  36. use Symfony\Bundle\TwigBundle\TwigBundle;
  37. use Symfony\Bundle\WebProfilerBundle\WebProfilerBundle;
  38. use Symfony\Cmf\Bundle\RoutingBundle\CmfRoutingBundle;
  39. use Symfony\Component\Config\Loader\LoaderInterface;
  40. use Symfony\Component\Config\Resource\FileExistenceResource;
  41. use Symfony\Component\Config\Resource\FileResource;
  42. use Symfony\Component\DependencyInjection\ContainerBuilder;
  43. use Symfony\Component\DependencyInjection\ContainerInterface;
  44. use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
  45. use Symfony\Component\EventDispatcher\GenericEvent;
  46. use Symfony\Component\HttpKernel\Bundle\BundleInterface;
  47. use Symfony\Component\HttpKernel\Kernel as SymfonyKernel;
  48. use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
  49. abstract class Kernel extends SymfonyKernel
  50. {
  51.     use MicroKernelTrait {
  52.         registerContainerConfiguration as microKernelRegisterContainerConfiguration;
  53.         registerBundles as microKernelRegisterBundles;
  54.     }
  55.     /**
  56.      * @var Extension\Config
  57.      */
  58.     protected $extensionConfig;
  59.     /**
  60.      * @var BundleCollection
  61.      */
  62.     private $bundleCollection;
  63.     /**
  64.      * @deprecated
  65.      */
  66.     public function getRootDir()
  67.     {
  68.         trigger_deprecation(
  69.             'pimcore/pimcore',
  70.             '10.3',
  71.             'Kernel::getRootDir() is deprecated and will be removed in Pimcore 11. Use Kernel::getProjectDir() instead.',
  72.         );
  73.         return PIMCORE_PROJECT_ROOT;
  74.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      *
  78.      * @return string
  79.      */
  80.     #[\ReturnTypeWillChange]
  81.     public function getProjectDir()// : string
  82.     {
  83.         return PIMCORE_PROJECT_ROOT;
  84.     }
  85.     /**
  86.      * {@inheritdoc}
  87.      *
  88.      * @return string
  89.      */
  90.     #[\ReturnTypeWillChange]
  91.     public function getCacheDir()// : string
  92.     {
  93.         if (isset($_SERVER['APP_CACHE_DIR'])) {
  94.             return $_SERVER['APP_CACHE_DIR'].'/'.$this->environment;
  95.         }
  96.         return PIMCORE_SYMFONY_CACHE_DIRECTORY '/' $this->environment;
  97.     }
  98.     /**
  99.      * {@inheritdoc}
  100.      *
  101.      * @return string
  102.      */
  103.     #[\ReturnTypeWillChange]
  104.     public function getLogDir()// : string
  105.     {
  106.         return PIMCORE_LOG_DIRECTORY;
  107.     }
  108.     /**
  109.      * {@inheritdoc}
  110.      */
  111.     protected function configureContainer(ContainerConfigurator $container): void
  112.     {
  113.         $projectDir realpath($this->getProjectDir());
  114.         $container->import($projectDir '/config/{packages}/*.yaml');
  115.         $container->import($projectDir '/config/{packages}/'.$this->environment.'/*.yaml');
  116.         if (is_file($projectDir '/config/services.yaml')) {
  117.             $container->import($projectDir '/config/services.yaml');
  118.             $container->import($projectDir '/config/{services}_'.$this->environment.'.yaml');
  119.         } elseif (is_file($path $projectDir '/config/services.php')) {
  120.             (require $path)($container->withPath($path), $this);
  121.         }
  122.     }
  123.     /**
  124.      * {@inheritdoc}
  125.      */
  126.     protected function configureRoutes(RoutingConfigurator $routes): void
  127.     {
  128.         $projectDir realpath($this->getProjectDir());
  129.         $routes->import($projectDir '/config/{routes}/'.$this->environment.'/*.yaml');
  130.         $routes->import($projectDir '/config/{routes}/*.yaml');
  131.         if (is_file($projectDir '/config/routes.yaml')) {
  132.             $routes->import($projectDir '/config/routes.yaml');
  133.         } elseif (is_file($path $projectDir '/config/routes.php')) {
  134.             (require $path)($routes->withPath($path), $this);
  135.         }
  136.     }
  137.     /**
  138.      * {@inheritdoc}
  139.      */
  140.     public function registerContainerConfiguration(LoaderInterface $loader)
  141.     {
  142.         $loader->load(function (ContainerBuilder $container) {
  143.             $this->registerExtensionConfigFileResources($container);
  144.         });
  145.         $bundleConfigLocator = new BundleConfigLocator($this);
  146.         foreach ($bundleConfigLocator->locate('config') as $bundleConfig) {
  147.             $loader->load($bundleConfig);
  148.         }
  149.         $this->microKernelRegisterContainerConfiguration($loader);
  150.         //load system configuration
  151.         $systemConfigFile Config::locateConfigFile('system.yml');
  152.         if (file_exists($systemConfigFile)) {
  153.             $loader->load($systemConfigFile);
  154.         }
  155.         $configArray = [
  156.             [
  157.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_IMAGE_THUMBNAILS',
  158.                 'defaultStorageDirectoryName' => 'image-thumbnails',
  159.             ],
  160.             [
  161.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_VIDEO_THUMBNAILS',
  162.                 'defaultStorageDirectoryName' => 'video-thumbnails',
  163.             ],
  164.             [
  165.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_CUSTOM_REPORTS',
  166.                 'defaultStorageDirectoryName' => 'custom-reports',
  167.             ],
  168.             [
  169.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_DOCUMENT_TYPES',
  170.                 'defaultStorageDirectoryName' => 'document-types',
  171.             ],
  172.             [
  173.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_WEB_TO_PRINT',
  174.                 'defaultStorageDirectoryName' => 'web-to-print',
  175.             ],
  176.             [
  177.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_PREDEFINED_PROPERTIES',
  178.                 'defaultStorageDirectoryName' => 'predefined-properties',
  179.             ],
  180.             [
  181.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_PREDEFINED_ASSET_METADATA',
  182.                 'defaultStorageDirectoryName' => 'predefined-asset-metadata',
  183.             ],
  184.             [
  185.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_STATICROUTES',
  186.                 'defaultStorageDirectoryName' => 'staticroutes',
  187.             ],
  188.             [
  189.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_PERSPECTIVES',
  190.                 'defaultStorageDirectoryName' => 'perspectives',
  191.             ],
  192.             [
  193.                 'storageDirectoryEnvVariableName' => 'PIMCORE_CONFIG_STORAGE_DIR_CUSTOM_VIEWS',
  194.                 'defaultStorageDirectoryName' => 'custom-views',
  195.             ],
  196.         ];
  197.         foreach ($configArray as $config) {
  198.             $configDir rtrim($_SERVER[$config['storageDirectoryEnvVariableName']] ?? PIMCORE_CONFIGURATION_DIRECTORY '/' $config['defaultStorageDirectoryName'], '/\\');
  199.             $configDir "$configDir/";
  200.             if (is_dir($configDir)) {
  201.                 // @phpstan-ignore-next-line
  202.                 $loader->import($configDir);
  203.             }
  204.         }
  205.     }
  206.     private function registerExtensionConfigFileResources(ContainerBuilder $container)
  207.     {
  208.         $filenames = [
  209.             'extensions.php',
  210.             sprintf('extensions_%s.php'$this->getEnvironment()),
  211.         ];
  212.         $directories = [
  213.             PIMCORE_CUSTOM_CONFIGURATION_DIRECTORY,
  214.             PIMCORE_CONFIGURATION_DIRECTORY,
  215.         ];
  216.         // add possible extensions.php files as file existence resources (only for the current env)
  217.         foreach ($directories as $directory) {
  218.             foreach ($filenames as $filename) {
  219.                 $container->addResource(new FileExistenceResource($directory '/' $filename));
  220.             }
  221.         }
  222.         // add extensions.php as container resource
  223.         if ($this->extensionConfig->configFileExists()) {
  224.             $container->addResource(new FileResource($this->extensionConfig->locateConfigFile()));
  225.         }
  226.     }
  227.     /**
  228.      * {@inheritdoc}
  229.      */
  230.     public function boot()
  231.     {
  232.         if (true === $this->booted) {
  233.             // make sure container reset is handled properly
  234.             parent::boot();
  235.             return;
  236.         }
  237.         // handle system requirements
  238.         $this->setSystemRequirements();
  239.         // initialize extension manager config
  240.         $this->extensionConfig = new Extension\Config();
  241.         parent::boot();
  242.     }
  243.     /**
  244.      * {@inheritdoc}
  245.      */
  246.     public function shutdown()
  247.     {
  248.         if (true === $this->booted) {
  249.             // cleanup runtime cache, doctrine, monolog ... to free some memory and avoid locking issues
  250.             $this->container->get(\Pimcore\Helper\LongRunningHelper::class)->cleanUp();
  251.         }
  252.         parent::shutdown();
  253.     }
  254.     /**
  255.      * {@inheritdoc}
  256.      */
  257.     protected function initializeContainer()
  258.     {
  259.         parent::initializeContainer();
  260.         // initialize runtime cache (defined as synthetic service)
  261.         Runtime::getInstance();
  262.         // set the extension config on the container
  263.         $this->getContainer()->set(Extension\Config::class, $this->extensionConfig);
  264.         \Pimcore::initLogger();
  265.         \Pimcore\Cache::init();
  266.         // on pimcore shutdown
  267.         register_shutdown_function(function () {
  268.             // check if container still exists at this point as it could already
  269.             // be cleared (e.g. when running tests which boot multiple containers)
  270.             try {
  271.                 $container $this->getContainer();
  272.             } catch (\LogicException) {
  273.                 // Container is cleared. Allow tests to finish.
  274.             }
  275.             if (isset($container) && $container instanceof ContainerInterface) {
  276.                 $container->get('event_dispatcher')->dispatch(new GenericEvent(), SystemEvents::SHUTDOWN);
  277.             }
  278.             \Pimcore::shutdown();
  279.         });
  280.     }
  281.     /**
  282.      * Returns an array of bundles to register.
  283.      *
  284.      * @return BundleInterface[] An array of bundle instances
  285.      */
  286.     public function registerBundles(): array
  287.     {
  288.         $collection $this->createBundleCollection();
  289.         if (is_file($this->getProjectDir().'/config/bundles.php')) {
  290.             $flexBundles = [];
  291.             array_push($flexBundles, ...$this->microKernelRegisterBundles());
  292.             $collection->addBundles($flexBundles);
  293.         }
  294.         // core bundles (Symfony, Pimcore)
  295.         $this->registerCoreBundlesToCollection($collection);
  296.         // custom bundles
  297.         $this->registerBundlesToCollection($collection);
  298.         // bundles registered in extensions.php
  299.         $this->registerExtensionManagerBundles($collection);
  300.         $bundles $collection->getBundles($this->getEnvironment());
  301.         $this->bundleCollection $collection;
  302.         return $bundles;
  303.     }
  304.     /**
  305.      * Creates bundle collection. Use this method to set bundles on the collection
  306.      * early.
  307.      *
  308.      * @return BundleCollection
  309.      */
  310.     protected function createBundleCollection(): BundleCollection
  311.     {
  312.         return new BundleCollection();
  313.     }
  314.     /**
  315.      * Returns the bundle collection which was used to build the set of used bundles
  316.      *
  317.      * @return BundleCollection
  318.      */
  319.     public function getBundleCollection(): BundleCollection
  320.     {
  321.         return $this->bundleCollection;
  322.     }
  323.     /**
  324.      * Registers "core" bundles
  325.      *
  326.      * @param BundleCollection $collection
  327.      */
  328.     protected function registerCoreBundlesToCollection(BundleCollection $collection)
  329.     {
  330.         $collection->addBundles([
  331.             // symfony "core"/standard
  332.             new FrameworkBundle(),
  333.             new SecurityBundle(),
  334.             new TwigBundle(),
  335.             new MonologBundle(),
  336.             new DoctrineBundle(),
  337.             new DoctrineMigrationsBundle(),
  338.             new SensioFrameworkExtraBundle(),
  339.             new CmfRoutingBundle(),
  340.             new PrestaSitemapBundle(),
  341.             new SchebTwoFactorBundle(),
  342.             new FOSJsRoutingBundle(),
  343.             new FlysystemBundle(),
  344.         ], 100);
  345.         // pimcore bundles
  346.         $collection->addBundles([
  347.             new PimcoreCoreBundle(),
  348.             new PimcoreAdminBundle(),
  349.         ], 60);
  350.         // load development bundles only in matching environments
  351.         if (in_array($this->getEnvironment(), $this->getEnvironmentsForDevBundles(), true)) {
  352.             $collection->addBundles([
  353.                 new DebugBundle(),
  354.                 new WebProfilerBundle(),
  355.             ], 80);
  356.         }
  357.     }
  358.     protected function getEnvironmentsForDevBundles(): array
  359.     {
  360.         return ['dev''test'];
  361.     }
  362.     /**
  363.      * Registers bundles enabled via extension manager
  364.      *
  365.      * @param BundleCollection $collection
  366.      */
  367.     protected function registerExtensionManagerBundles(BundleCollection $collection)
  368.     {
  369.         $stateConfig = new StateConfig($this->extensionConfig);
  370.         foreach ($stateConfig->getEnabledBundles() as $className => $options) {
  371.             if (!class_exists($className)) {
  372.                 continue;
  373.             }
  374.             // do not register bundles twice - skip if it was already loaded manually
  375.             if ($collection->hasItem($className)) {
  376.                 continue;
  377.             }
  378.             // use lazy loaded item to instantiate the bundle only if environment matches
  379.             $collection->add(new LazyLoadedItem(
  380.                 $className,
  381.                 $options['priority'],
  382.                 $options['environments'],
  383.                 ItemInterface::SOURCE_EXTENSION_MANAGER_CONFIG
  384.             ));
  385.         }
  386.     }
  387.     /**
  388.      * Adds bundles to register to the bundle collection. The collection is able
  389.      * to handle priorities and environment specific bundles.
  390.      *
  391.      * To be implemented in child classes
  392.      *
  393.      * @param BundleCollection $collection
  394.      */
  395.     public function registerBundlesToCollection(BundleCollection $collection)
  396.     {
  397.     }
  398.     /**
  399.      * Handle system settings and requirements
  400.      */
  401.     protected function setSystemRequirements()
  402.     {
  403.         // try to set system-internal variables
  404.         $maxExecutionTime 240;
  405.         if (php_sapi_name() === 'cli') {
  406.             $maxExecutionTime 0;
  407.         }
  408.         //@ini_set("memory_limit", "1024M");
  409.         @ini_set('max_execution_time', (string) $maxExecutionTime);
  410.         @set_time_limit($maxExecutionTime);
  411.         ini_set('default_charset''UTF-8');
  412.         // set internal character encoding to UTF-8
  413.         mb_internal_encoding('UTF-8');
  414.         // zlib.output_compression conflicts with while (@ob_end_flush()) ;
  415.         // see also: https://github.com/pimcore/pimcore/issues/291
  416.         if (ini_get('zlib.output_compression')) {
  417.             @ini_set('zlib.output_compression''Off');
  418.         }
  419.         // set dummy timezone if no tz is specified / required for example by the logger, ...
  420.         $defaultTimezone = @date_default_timezone_get();
  421.         if (!$defaultTimezone) {
  422.             date_default_timezone_set('UTC'); // UTC -> default timezone
  423.         }
  424.     }
  425. }