Configuration.php

<?php

declare(strict_types=1);

/*
 * This file is part of the Sonata Project package.
 *
 * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sonata\PageBundle\DependencyInjection;

use Sonata\PageBundle\Model\Template;
use Sonata\PageBundle\Template\Matrix\Parser;
use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;

/**
 * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
 */
final class Configuration implements ConfigurationInterface
{
    /**
     * @return TreeBuilder<'array'>
     */
    public function getConfigTreeBuilder(): TreeBuilder
    {
        $treeBuilder = new TreeBuilder('sonata_page');
        $rootNode = $treeBuilder->getRootNode();

        $routerAutoRegisterInfo = <<<'EOF'
            Automatically add 'sonata.page.router' service to the index of 'cmf_routing.router' chain router

            Examples:
            enabled:  true      Enable auto-registration
            priority: 150       The priority
            EOF;

        $ignoreRoutePatternsInfo = <<<'EOF'
            (.*)admin(.*)       ignore admin route, i.e. route containing 'admin'
            ^_(.*)              ignore Symfony routes
            EOF;

        $ignoreUriPatternsInfo = <<<'EOF'
            admin(.*)           ignore admin route, i.e. route containing 'admin'
            EOF;

        $pageDefaultsInfo = <<<'EOF'
            Example:
            homepage: { decorate: false }       disable decoration for 'homepage', key is a page route
            EOF;

        $catchExceptionsInfo = <<<'EOF'
            Manage the HTTP errors

            Examples:
            not_found: [404]    render 404 page with "not_found" key (name generated: _page_internal_error_not_found)
            fatal:     [500]    render 500 page with "fatal" key (name generated: _page_internal_error_fatal)
            EOF;

        $directPublicationInfo = <<<'EOF'
            Generates a snapshot when a page is saved from the admin.

            You can use %kernel.debug%, if you want to publish in dev mode, but not in prod.
            EOF;

        $rootNode
            ->children()
                ->scalarNode('skip_redirection')
                    ->info('To skip asking Editor to redirect')
                    ->defaultFalse()
                ->end()
                ->scalarNode('hide_disabled_blocks')
                    ->defaultFalse()
                ->end()
                ->scalarNode('use_streamed_response')
                    ->info('Set the value to false in debug mode or if the reverse proxy does not handle streamed response')
                    ->defaultFalse()
                ->end()
                ->scalarNode('multisite')
                    ->info('For more information, see https://docs.sonata-project.org/projects/SonataPageBundle/en/4.x/reference/multisite/')
                    ->isRequired()
                    ->validate()
                        ->ifNotInArray(['host', 'host_by_locale', 'host_with_path', 'host_with_path_by_locale'])
                        ->thenInvalid('Invalid multisite configuration %s. For more information, see https://docs.sonata-project.org/projects/SonataPageBundle/en/4.x/reference/multisite/')
                    ->end()
                ->end()
                ->arrayNode('router_auto_register')
                    ->info($routerAutoRegisterInfo)
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->booleanNode('enabled')
                            ->defaultValue(false)
                        ->end()
                        ->integerNode('priority')
                            ->defaultValue(150)
                        ->end()
                    ->end()
                ->end()
                ->arrayNode('ignore_route_patterns')
                    ->info($ignoreRoutePatternsInfo)
                    ->defaultValue([
                        '(.*)admin(.*)',
                        '^_(.*)',
                    ])
                    ->prototype('scalar')->end()
                ->end()
                ->arrayNode('ignore_routes')
                    ->defaultValue([])
                    ->prototype('scalar')->end()
                ->end()

                ->arrayNode('ignore_uri_patterns')
                    ->info($ignoreUriPatternsInfo)
                    ->defaultValue([
                        'admin(.*)',
                    ])
                    ->prototype('scalar')->end()
                ->end()

                ->scalarNode('default_page_service')
                    ->defaultValue('sonata.page.service.default')
                ->end()
                ->scalarNode('default_template')
                    ->info('Template key from templates section, used as default for pages')
                    ->isRequired()
                ->end()

                ->arrayNode('templates')
                    ->isRequired()
                    ->useAttributeAsKey('id')
                    ->prototype('array')
                        ->children()
                            ->scalarNode('name')->end()
                            ->scalarNode('path')->end()
                            ->scalarNode('inherits_containers')->end()
                            ->arrayNode('containers')
                                ->requiresAtLeastOneElement()
                                ->useAttributeAsKey('id')
                                ->prototype('array')
                                    ->children()
                                        ->scalarNode('name')->end()
                                        ->booleanNode('shared')
                                            ->defaultValue(false)
                                        ->end()
                                        ->scalarNode('type')
                                            ->defaultValue(Template::TYPE_STATIC)
                                        ->end()
                                        ->arrayNode('blocks')
                                            ->prototype('scalar')->end()
                                        ->end()
                                    ->end()
                                ->end()
                            ->end()
                            ->arrayNode('matrix')
                                ->children()
                                    ->scalarNode('layout')
                                        ->isRequired()
                                    ->end()
                                    ->arrayNode('mapping')
                                        ->isRequired()
                                        ->requiresAtLeastOneElement()
                                        ->prototype('scalar')->isRequired()->end()
                                    ->end()
                                ->end()
                                ->validate()
                                ->always()
                                    ->then(static fn (array $matrix) => Parser::parse($matrix['layout'], $matrix['mapping']))
                                ->end()
                            ->end()
                        ->end()
                    ->end()
                    ->validate()
                    ->always()
                        ->then(static function (array $templates): array {
                            foreach ($templates as $id => &$template) {
                                if (0 === \count($template['containers'])) {
                                    continue;
                                }

                                if (isset($template['inherits_containers'])) {
                                    $inherits = $template['inherits_containers'];
                                    if (!isset($templates[$inherits])) {
                                        throw new InvalidConfigurationException(
                                            \sprintf('Template "%s" cannot inherit containers from undefined template "%s"', $id, $inherits)
                                        );
                                    }
                                    $template['containers'] = array_merge($templates[$inherits]['containers'], $template['containers']);
                                }

                                foreach ($template['containers'] as $containerKey => $container) {
                                    if (!isset($template['matrix'][$containerKey])) {
                                        throw new InvalidConfigurationException(
                                            \sprintf('No area defined in matrix for template container "%s"', $containerKey)
                                        );
                                    }
                                }

                                foreach ($template['matrix'] as $containerKey => $config) {
                                    if (!isset($template['containers'][$containerKey])) {
                                        throw new InvalidConfigurationException(
                                            \sprintf('No container defined for matrix area "%s"', $containerKey)
                                        );
                                    }
                                    $template['containers'][$containerKey]['placement'] = $config;
                                }
                                unset($template['inherits_containers'], $template['matrix']);
                            }

                            return $templates;
                        })
                    ->end()
                ->end()

                ->arrayNode('templates_admin')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('list')
                            ->defaultValue('@SonataPage/PageAdmin/list.html.twig')
                            ->cannotBeEmpty()
                        ->end()
                        ->scalarNode('tree')
                            ->defaultValue('@SonataPage/PageAdmin/tree.html.twig')
                            ->cannotBeEmpty()
                        ->end()
                        ->scalarNode('compose')
                            ->defaultValue('@SonataPage/PageAdmin/compose.html.twig')
                            ->cannotBeEmpty()
                        ->end()
                        ->scalarNode('compose_container_show')
                            ->defaultValue('@SonataPage/PageAdmin/compose_container_show.html.twig')
                            ->cannotBeEmpty()
                        ->end()
                        ->scalarNode('select_site')
                            ->defaultValue('@SonataPage/PageAdmin/select_site.html.twig')
                            ->cannotBeEmpty()
                        ->end()
                    ->end()
                ->end()

                ->arrayNode('page_defaults')
                    ->info($pageDefaultsInfo)
                    ->useAttributeAsKey('id')
                    ->prototype('array')
                        ->children()
                            ->booleanNode('decorate')
                                ->defaultValue(true)
                        ->end()
                            ->booleanNode('enabled')
                                ->defaultValue(true)
                            ->end()
                        ->end()
                    ->end()
                ->end()

                ->arrayNode('catch_exceptions')
                    ->info($catchExceptionsInfo)
                    ->useAttributeAsKey('id')
                    ->prototype('variable')->isRequired()->end()
                ->end()

                ->arrayNode('class')
                    ->addDefaultsIfNotSet()
                    ->children()
                        ->scalarNode('page')
                            ->defaultValue('App\\Entity\\SonataPagePage')
                        ->end()
                        ->scalarNode('snapshot')
                            ->defaultValue('App\\Entity\\SonataPageSnapshot')
                        ->end()
                        ->scalarNode('block')
                            ->defaultValue('App\\Entity\\SonataPageBlock')
                        ->end()
                        ->scalarNode('site')
                            ->defaultValue('App\\Entity\\SonataPageSite')
                        ->end()
                    ->end()
                ->end()
                ->booleanNode('direct_publication')
                    ->info($directPublicationInfo)
                    ->defaultValue(false)
                ->end();

        return $treeBuilder;
    }
}