vendor/sulu/sulu/src/Sulu/Bundle/CoreBundle/DependencyInjection/SuluCoreExtension.php line 40

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\CoreBundle\DependencyInjection;
  14. use Gedmo\Exception;
  15. use Oro\ORM\Query\AST\Functions\Cast;
  16. use Oro\ORM\Query\AST\Functions\String\GroupConcat;
  17. use Sulu\Component\Content\Types\Block\BlockVisitorInterface;
  18. use Sulu\Component\Rest\Csv\ObjectNotSupportedException;
  19. use Sulu\Component\Rest\Exception\InsufficientDescendantPermissionsException;
  20. use Sulu\Component\Rest\Exception\InvalidHashException;
  21. use Sulu\Component\Rest\Exception\MissingParameterException;
  22. use Sulu\Component\Rest\Exception\ReferencingResourcesFoundExceptionInterface;
  23. use Sulu\Component\Rest\Exception\RemoveDependantResourcesFoundExceptionInterface;
  24. use Sulu\Component\Rest\ListBuilder\Filter\InvalidFilterTypeOptionsException;
  25. use Symfony\Bundle\TwigBundle\Controller\ExceptionController;
  26. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  27. use Symfony\Component\Config\FileLocator;
  28. use Symfony\Component\DependencyInjection\ContainerBuilder;
  29. use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
  30. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  31. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  33. /**
  34.  * This is the class that loads and manages your bundle configuration.
  35.  *
  36.  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/extension.html}
  37.  */
  38. class SuluCoreExtension extends Extension implements PrependExtensionInterface
  39. {
  40.     public function prepend(ContainerBuilder $container)
  41.     {
  42.         // process the configuration of SuluCoreExtension
  43.         $configs = $container->getExtensionConfig($this->getAlias());
  44.         $parameterBag = $container->getParameterBag();
  45.         $configs = $parameterBag->resolveValue($configs);
  46.         $config = $this->processConfiguration(new Configuration(), $configs);
  48.         if (isset($config['phpcr']) && $container->hasExtension('doctrine_phpcr')) {
  49.             $phpcrConfig = $config['phpcr'];
  51.             // TODO: Workaround for issue: https://github.com/doctrine/DoctrinePHPCRBundle/issues/178
  52.             if (!isset($phpcrConfig['backend']['check_login_on_server'])) {
  53.                 $phpcrConfig['backend']['check_login_on_server'] = false;
  54.             }
  56.             $container->prependExtensionConfig(
  57.                 'doctrine_phpcr',
  58.                 [
  59.                     'session' => $phpcrConfig,
  60.                 ]
  61.             );
  62.         }
  64.         $templatesPath = __DIR__ . '/../Content/templates';
  65.         $container->prependExtensionConfig(
  66.             'sulu_core',
  67.             [
  68.                 'content' => [
  69.                     'structure' => [
  70.                         'paths' => [
  71.                             'sulu' => [
  72.                                 'path' => $templatesPath,
  73.                                 'type' => 'page',
  74.                             ],
  75.                         ],
  76.                     ],
  77.                 ],
  78.             ]
  79.         );
  81.         if ($container->hasExtension('massive_build')) {
  82.             $container->prependExtensionConfig('massive_build', [
  83.                 'command_class' => 'Sulu\Bundle\CoreBundle\CommandOptional\SuluBuildCommand',
  84.             ]);
  85.         }
  87.         if ($container->hasExtension('fos_rest')) {
  88.             $container->prependExtensionConfig(
  89.                 'fos_rest',
  90.                 [
  91.                     'exception' => [
  92.                         'enabled' => true,
  93.                         'map_exception_codes' => true,
  94.                         'codes' => [
  95.                             MissingParameterException::class => 400,
  96.                             InvalidHashException::class => 409,
  97.                             ObjectNotSupportedException::class => 406,
  98.                             InvalidFilterTypeOptionsException::class => 400,
  99.                             RemoveDependantResourcesFoundExceptionInterface::class => 409,
  100.                             InsufficientDescendantPermissionsException::class => 403,
  101.                             ReferencingResourcesFoundExceptionInterface::class => 409,
  102.                         ],
  103.                         'exception_listener' => false,
  104.                         'serialize_exceptions' => false,
  105.                         'flatten_exception_format' => 'legacy',
  106.                     ],
  107.                     'serializer' => [
  108.                         'serialize_null' => true,
  109.                     ],
  110.                     'body_listener' => [
  111.                         'enabled' => true,
  112.                     ],
  113.                     'routing_loader' => false,
  114.                     'view' => [
  115.                         'formats' => [
  116.                             'json' => true,
  117.                             'csv' => true,
  118.                         ],
  119.                     ],
  120.                 ]
  121.             );
  122.         }
  124.         if ($container->hasExtension('twig') && \class_exists(ExceptionController::class)) {
  125.             // Disable the deprecated exception_controller to support the newer fos_rest bundle
  126.             $container->prependExtensionConfig('twig', [
  127.                 'exception_controller' => null,
  128.             ]);
  129.         }
  131.         if ($container->hasExtension('handcraftedinthealps_rest_routing')) {
  132.             $container->prependExtensionConfig(
  133.                 'handcraftedinthealps_rest_routing',
  134.                 [
  135.                     'routing_loader' => [
  136.                         'default_format' => 'json',
  137.                         'formats' => [
  138.                             'json' => true,
  139.                             'csv' => true,
  140.                         ],
  141.                     ],
  142.                 ]
  143.             );
  144.         }
  146.         if ($container->hasExtension('jms_serializer')) {
  147.             $container->prependExtensionConfig(
  148.                 'jms_serializer',
  149.                 [
  150.                     'property_naming' => [
  151.                         'id' => 'jms_serializer.identical_property_naming_strategy',
  152.                     ],
  153.                 ]
  154.             );
  155.         }
  157.         if ($container->hasExtension('doctrine')) {
  158.             // depending on the gedmo version it is in gedmo lib or src folder
  159.             // we use the autoloader to detect the correct directory
  160.             // see also: https://github.com/sulu/sulu/pull/5753
  161.             $reflection = new \ReflectionClass(Exception::class);
  162.             $gedmoDirectory = \dirname($reflection->getFileName());
  164.             $container->prependExtensionConfig(
  165.                 'doctrine',
  166.                 [
  167.                     'orm' => [
  168.                         'mappings' => [
  169.                             'gedmo_tree' => [
  170.                                 'type' => 'xml',
  171.                                 'prefix' => 'Gedmo\\Tree\\Entity',
  172.                                 'dir' => $gedmoDirectory . '/Tree/Entity',
  173.                                 'alias' => 'GedmoTree',
  174.                                 'is_bundle' => false,
  175.                             ],
  176.                         ],
  177.                         'dql' => [
  178.                             'string_functions' => [
  179.                                 'group_concat' => GroupConcat::class,
  180.                                 'CAST' => Cast::class,
  181.                             ],
  182.                         ],
  183.                     ],
  184.                 ]
  185.             );
  186.         }
  188.         if ($container->hasExtension('stof_doctrine_extensions')) {
  189.             $container->prependExtensionConfig('stof_doctrine_extensions', ['orm' => ['default' => ['tree' => true]]]);
  190.         }
  192.         if ($container->hasExtension('jms_serializer')) {
  193.             $container->prependExtensionConfig(
  194.                 'jms_serializer',
  195.                 [
  196.                     'metadata' => [
  197.                         'debug' => '%kernel.debug%',
  198.                     ],
  199.                     'handlers' => [
  200.                         'datetime' => [
  201.                             'default_format' => 'Y-m-d\\TH:i:s',
  202.                         ],
  203.                     ],
  204.                 ]
  205.             );
  206.         }
  208.         if ($container->hasExtension('massive_build')) {
  209.             $container->prependExtensionConfig(
  210.                 'massive_build',
  211.                 [
  212.                     'targets' => [
  213.                         'prod' => [
  214.                             'dependencies' => [
  215.                                 'database' => [],
  216.                                 'phpcr' => [],
  217.                                 'fixtures' => [],
  218.                                 'phpcr_migrations' => [],
  219.                                 'system_collections' => [],
  220.                                 'security' => [],
  221.                             ],
  222.                         ],
  223.                         'dev' => [
  224.                             'dependencies' => [
  225.                                 'database' => [],
  226.                                 'fixtures' => [],
  227.                                 'phpcr' => [],
  228.                                 'user' => [],
  229.                                 'phpcr_migrations' => [],
  230.                                 'system_collections' => [],
  231.                                 'security' => [],
  232.                             ],
  233.                         ],
  234.                         'maintain' => [
  235.                             'dependencies' => [
  236.                                 'node_order' => [],
  237.                                 'search_index' => [],
  238.                                 'phpcr_migrations' => [],
  239.                             ],
  240.                         ],
  241.                     ],
  242.                 ]
  243.             );
  244.         }
  246.         if ($container->hasExtension('framework')) {
  247.             $container->prependExtensionConfig(
  248.                 'framework',
  249.                 [
  250.                     'cache' => [
  251.                         'directory' => '%sulu.common_cache_dir%/pools',
  252.                     ],
  253.                 ]
  254.             );
  255.         }
  256.     }
  258.     public function load(array $configs, ContainerBuilder $container)
  259.     {
  260.         $configuration = new Configuration();
  261.         $config = $this->processConfiguration($configuration, $configs);
  262.         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
  264.         foreach ($config['locales'] as $locale => $localeName) {
  265.             if (\strtolower($locale) !== $locale) {
  266.                 throw new InvalidConfigurationException('Invalid locale in configuration: ' . $locale);
  267.             }
  268.         }
  270.         foreach ($config['translations'] as $translation) {
  271.             if (\strtolower($translation) !== $translation) {
  272.                 throw new InvalidConfigurationException('Invalid translation in configuration: ' . $translation);
  273.             }
  274.         }
  276.         if (\strtolower($config['fallback_locale']) !== $config['fallback_locale']) {
  277.             throw new InvalidConfigurationException(
  278.                 'Invalid fallback_locale in configuration: ' . $config['fallback_locale']
  279.             );
  280.         }
  282.         $container->setParameter('sulu_core.locales', \array_unique(\array_keys($config['locales'])));
  283.         $container->setParameter('sulu_core.translated_locales', $config['locales']);
  284.         $container->setParameter('sulu_core.translations', \array_unique($config['translations']));
  285.         $container->setParameter('sulu_core.fallback_locale', $config['fallback_locale']);
  287.         $container->setParameter('sulu.cache_dir', $config['cache_dir']);
  289.         $proxyCacheDirectory = $container->getParameterBag()->resolveValue(
  290.             $container->getParameter('sulu.cache_dir') . '/proxies'
  291.         );
  293.         if (!\is_dir($proxyCacheDirectory)) {
  294.             \mkdir($proxyCacheDirectory, 0777, true);
  295.         }
  297.         $container->setParameter('sulu_core.proxy_cache_dir', $proxyCacheDirectory);
  299.         // Content
  300.         if (isset($config['content'])) {
  301.             $this->initContent($config['content'], $container, $loader);
  302.         }
  304.         // Webspace
  305.         if (isset($config['webspace'])) {
  306.             $this->initWebspace($config['webspace'], $container, $loader);
  307.         }
  309.         // Cache
  310.         if (isset($config['cache'])) {
  311.             $this->initCache($config['cache'], $container, $loader);
  312.         }
  314.         // Default Fields
  315.         if (isset($config['fields_defaults'])) {
  316.             $this->initFields($config['fields_defaults'], $container);
  317.         }
  319.         $this->initListBuilder($container, $loader);
  321.         $loader->load('expression_language.xml');
  322.         $loader->load('phpcr.xml');
  323.         $loader->load('rest.xml');
  324.         $loader->load('build.xml');
  325.         $loader->load('localization.xml');
  326.         $loader->load('serializer.xml');
  327.         $loader->load('request_analyzer.xml');
  328.         $loader->load('doctrine.xml');
  330.         $container->registerForAutoconfiguration(BlockVisitorInterface::class)
  331.             ->addTag('sulu_content.block_visitor');
  332.     }
  334.     private function initWebspace(array $webspaceConfig, ContainerBuilder $container, XmlFileLoader $loader)
  335.     {
  336.         $container->setParameter('sulu_core.webspace.config_dir', $webspaceConfig['config_dir']);
  338.         $loader->load('webspace.xml');
  339.     }
  341.     private function initFields(array $fieldsConfig, ContainerBuilder $container)
  342.     {
  343.         $container->setParameter('sulu.fields_defaults.translations', $fieldsConfig['translations']);
  344.         $container->setParameter('sulu.fields_defaults.widths', $fieldsConfig['widths']);
  345.     }
  347.     private function initContent(array $contentConfig, ContainerBuilder $container, XmlFileLoader $loader)
  348.     {
  349.         // Default Language
  350.         $container->setParameter('sulu.content.language.namespace', $contentConfig['language']['namespace']);
  351.         $container->setParameter('sulu.content.language.default', $contentConfig['language']['default']);
  353.         // Node names
  354.         $container->setParameter('sulu.content.node_names.base', $contentConfig['node_names']['base']);
  355.         $container->setParameter('sulu.content.node_names.content', $contentConfig['node_names']['content']);
  356.         $container->setParameter('sulu.content.node_names.route', $contentConfig['node_names']['route']);
  357.         $container->setParameter('sulu.content.node_names.snippet', $contentConfig['node_names']['snippet']);
  359.         // Default template
  360.         $container->setParameter(
  361.             'sulu.content.structure.default_types',
  362.             $contentConfig['structure']['default_type']
  363.         );
  365.         foreach ($contentConfig['structure']['default_type'] as $type => $default) {
  366.             $container->setParameter(
  367.                 'sulu.content.structure.default_type.' . $type,
  368.                 $default
  369.             );
  370.         }
  372.         $container->setParameter(
  373.             'sulu.content.structure.required_properties',
  374.             $contentConfig['structure']['required_properties']
  375.         );
  376.         $container->setParameter(
  377.             'sulu.content.structure.required_tags',
  378.             $contentConfig['structure']['required_tags']
  379.         );
  380.         $container->setParameter(
  381.             'sulu.content.internal_prefix',
  382.             $contentConfig['internal_prefix']
  383.         );
  384.         $container->setParameter(
  385.             'sulu.content.structure.type_map',
  386.             $contentConfig['structure']['type_map']
  387.         );
  389.         // Template
  390.         $paths = [];
  391.         foreach ($contentConfig['structure']['paths'] as $pathConfig) {
  392.             $pathType = $pathConfig['type'];
  393.             if (!isset($paths[$pathType])) {
  394.                 $paths[$pathType] = [];
  395.             }
  396.             $paths[$pathType][] = $pathConfig;
  397.         }
  399.         $container->setParameter('sulu.content.structure.paths', $paths);
  401.         $loader->load('content.xml');
  402.     }
  404.     private function initCache(array $cache, ContainerBuilder $container, XmlFileLoader $loader)
  405.     {
  406.         $container->setParameter('sulu_core.cache.memoize.default_lifetime', $cache['memoize']['default_lifetime']);
  408.         $loader->load('cache.xml');
  409.     }
  411.     /**
  412.      * Initializes list builder.
  413.      */
  414.     private function initListBuilder(ContainerBuilder $container, XmlFileLoader $loader)
  415.     {
  416.         $bundles = $container->getParameter('kernel.bundles');
  417.         if (\array_key_exists('SuluAdminBundle', $bundles)) {
  418.             $loader->load('list_builder.xml');
  419.         }
  420.     }
  421. }