vendor/friendsofsymfony/rest-bundle/DependencyInjection/Configuration.php line 321

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the FOSRestBundle package.
  5.  *
  6.  * (c) FriendsOfSymfony <http://friendsofsymfony.github.com/>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace FOS\RestBundle\DependencyInjection;
  14. use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
  15. use Symfony\Component\Config\Definition\Builder\TreeBuilder;
  16. use Symfony\Component\Config\Definition\ConfigurationInterface;
  17. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\OptionsResolver\OptionsResolver;
  20. use Symfony\Component\Serializer\Encoder\XmlEncoder;
  22. /**
  23.  * This class contains the configuration information for the bundle.
  24.  *
  25.  * This information is solely responsible for how the different configuration
  26.  * sections are normalized, and merged.
  27.  *
  28.  * @author Lukas Kahwe Smith <smith@pooteeweet.org>
  29.  *
  30.  * @internal
  31.  */
  32. final class Configuration implements ConfigurationInterface
  33. {
  34.     /**
  35.      * Default debug mode value.
  36.      *
  37.      * @var bool
  38.      */
  39.     private $debug;
  41.     public function __construct(bool $debug)
  42.     {
  43.         $this->debug = $debug;
  44.     }
  46.     public function getConfigTreeBuilder(): TreeBuilder
  47.     {
  48.         $treeBuilder = new TreeBuilder('fos_rest');
  50.         if (method_exists($treeBuilder, 'getRootNode')) {
  51.             $rootNode = $treeBuilder->getRootNode();
  52.         } else {
  53.             $rootNode = $treeBuilder->root('fos_rest');
  54.         }
  56.         $rootNode
  57.             ->children()
  58.                 ->scalarNode('disable_csrf_role')->defaultNull()->end()
  59.                 ->arrayNode('access_denied_listener')
  60.                     ->canBeEnabled()
  61.                     ->setDeprecated('The "%path%.%node%" option is deprecated since FOSRestBundle 2.8.')
  62.                     ->beforeNormalization()
  63.                         ->ifArray()->then(function ($v) {
  64.                             if (!empty($v) && empty($v['formats'])) {
  65.                                 unset($v['enabled']);
  66.                                 $v = ['enabled' => true, 'formats' => $v];
  67.                             }
  69.                             return $v;
  70.                         })
  71.                     ->end()
  72.                     ->fixXmlConfig('format', 'formats')
  73.                     ->children()
  74.                         ->scalarNode('service')->defaultNull()->end()
  75.                         ->arrayNode('formats')
  76.                             ->useAttributeAsKey('name')
  77.                             ->prototype('boolean')->end()
  78.                         ->end()
  79.                     ->end()
  80.                 ->end()
  81.                 ->scalarNode('unauthorized_challenge')->defaultNull()->end()
  82.                 ->arrayNode('param_fetcher_listener')
  83.                     ->beforeNormalization()
  84.                         ->ifString()
  85.                         ->then(function ($v) {
  86.                             return ['enabled' => in_array($v, ['force', 'true']), 'force' => 'force' === $v];
  87.                         })
  88.                     ->end()
  89.                     ->canBeEnabled()
  90.                     ->children()
  91.                         ->booleanNode('force')->defaultFalse()->end()
  92.                         ->scalarNode('service')->defaultNull()->end()
  93.                     ->end()
  94.                 ->end()
  95.                 ->scalarNode('cache_dir')->cannotBeEmpty()->defaultValue('%kernel.cache_dir%/fos_rest')->end()
  96.                 ->arrayNode('allowed_methods_listener')
  97.                     ->canBeEnabled()
  98.                     ->children()
  99.                         ->scalarNode('service')->defaultNull()->end()
  100.                     ->end()
  101.                 ->end()
  102.                 ->arrayNode('routing_loader')
  103.                     ->addDefaultsIfNotSet()
  104.                     ->beforeNormalization()
  105.                         ->ifTrue(function ($v) { return isset($v['enabled']) && false !== $v['enabled']; })
  106.                         ->then(function ($v) {
  107.                             @trigger_error('Enabling the route generation feature is deprecated since FOSRestBundle 2.8.', E_USER_DEPRECATED);
  109.                             return $v;
  110.                         })
  111.                     ->end()
  112.                     ->beforeNormalization()
  113.                         ->ifTrue(function ($v) { return is_bool($v); })
  114.                         ->then(function ($v) {
  115.                             return [
  116.                                 'enabled' => $v,
  117.                             ];
  118.                         })
  119.                     ->end()
  120.                     ->children()
  121.                         ->booleanNode('enabled')
  122.                             ->defaultValue(function () {
  123.                                 @trigger_error('Enabling the route generation feature is deprecated since FOSRestBundle 2.8.', E_USER_DEPRECATED);
  125.                                 return true;
  126.                             })
  127.                         ->end()
  128.                         ->scalarNode('default_format')->defaultNull()->end()
  129.                         ->scalarNode('prefix_methods')->defaultTrue()->end()
  130.                         ->scalarNode('include_format')->defaultTrue()->end()
  131.                     ->end()
  132.                 ->end()
  133.                 ->arrayNode('body_converter')
  134.                     ->canBeEnabled()
  135.                     ->children()
  136.                         ->scalarNode('validate')
  137.                             ->defaultFalse()
  138.                             ->beforeNormalization()
  139.                                 ->ifTrue()
  140.                                 ->then(function ($value) {
  141.                                     if (!class_exists(OptionsResolver::class)) {
  142.                                         throw new InvalidConfigurationException("'body_converter.validate: true' requires OptionsResolver component installation ( composer require symfony/options-resolver )");
  143.                                     }
  145.                                     return $value;
  146.                                 })
  147.                             ->end()
  148.                         ->end()
  149.                         ->scalarNode('validation_errors_argument')->defaultValue('validationErrors')->end()
  150.                     ->end()
  151.                 ->end()
  152.                 ->arrayNode('service')
  153.                     ->addDefaultsIfNotSet()
  154.                     ->children()
  155.                         ->scalarNode('router')->defaultValue('router')->setDeprecated('The "%path%.%node%" configuration key has been deprecated in FOSRestBundle 2.8.')->end()
  156.                         ->scalarNode('templating')
  157.                             ->defaultValue('templating')
  158.                             ->setDeprecated('The "%path%.%node%" option is deprecated since FOSRestBundle 2.8.')
  159.                         ->end()
  160.                         ->scalarNode('serializer')->defaultNull()->end()
  161.                         ->scalarNode('view_handler')->defaultValue('fos_rest.view_handler.default')->end()
  162.                         ->scalarNode('inflector')
  163.                             ->defaultValue('fos_rest.inflector.doctrine')
  164.                             ->setDeprecated('The "%path%.%node%" option is deprecated since FOSRestBundle 2.8.')
  165.                         ->end()
  166.                         ->scalarNode('validator')->defaultValue('validator')->end()
  167.                     ->end()
  168.                 ->end()
  169.                 ->arrayNode('serializer')
  170.                     ->addDefaultsIfNotSet()
  171.                     ->children()
  172.                         ->scalarNode('version')->defaultNull()->end()
  173.                         ->arrayNode('groups')
  174.                             ->prototype('scalar')->end()
  175.                         ->end()
  176.                         ->booleanNode('serialize_null')->defaultFalse()->end()
  177.                     ->end()
  178.                 ->end()
  179.                 ->arrayNode('zone')
  180.                     ->cannotBeOverwritten()
  181.                     ->prototype('array')
  182.                     ->fixXmlConfig('ip')
  183.                     ->children()
  184.                         ->scalarNode('path')
  185.                             ->defaultNull()
  186.                             ->info('use the urldecoded format')
  187.                             ->example('^/path to resource/')
  188.                         ->end()
  189.                         ->scalarNode('host')->defaultNull()->end()
  190.                         ->arrayNode('methods')
  191.                             ->beforeNormalization()->ifString()->then(function ($v) {
  192.                                 return preg_split('/\s*,\s*/', $v);
  193.                             })->end()
  194.                             ->prototype('scalar')->end()
  195.                         ->end()
  196.                         ->arrayNode('ips')
  197.                             ->beforeNormalization()->ifString()->then(function ($v) {
  198.                                 return [$v];
  199.                             })->end()
  200.                             ->prototype('scalar')->end()
  201.                         ->end()
  202.                     ->end()
  203.                 ->end()
  204.             ->end()
  205.         ->end();
  207.         $this->addViewSection($rootNode);
  208.         $this->addExceptionSection($rootNode);
  209.         $this->addBodyListenerSection($rootNode);
  210.         $this->addFormatListenerSection($rootNode);
  211.         $this->addVersioningSection($rootNode);
  213.         return $treeBuilder;
  214.     }
  216.     private function addViewSection(ArrayNodeDefinition $rootNode)
  217.     {
  218.         $rootNode
  219.             ->children()
  220.                 ->arrayNode('view')
  221.                     ->fixXmlConfig('format', 'formats')
  222.                     ->fixXmlConfig('mime_type', 'mime_types')
  223.                     ->fixXmlConfig('templating_format', 'templating_formats')
  224.                     ->fixXmlConfig('force_redirect', 'force_redirects')
  225.                     ->addDefaultsIfNotSet()
  226.                     ->children()
  227.                         ->scalarNode('default_engine')
  228.                             ->setDeprecated('The "%path%.%node%" option has been deprecated in FOSRestBundle 2.8.')
  229.                             ->defaultValue('twig')
  230.                         ->end()
  231.                         ->arrayNode('force_redirects')
  232.                             ->setDeprecated('The "%path%.%node%" option has been deprecated in FOSRestBundle 2.8.')
  233.                             ->useAttributeAsKey('name')
  234.                             ->defaultValue(['html' => true])
  235.                             ->prototype('boolean')->end()
  236.                         ->end()
  237.                         ->arrayNode('mime_types')
  238.                             ->canBeEnabled()
  239.                             ->beforeNormalization()
  240.                                 ->ifArray()->then(function ($v) {
  241.                                     if (!empty($v) && empty($v['formats'])) {
  242.                                         unset($v['enabled']);
  243.                                         $v = ['enabled' => true, 'formats' => $v];
  244.                                     }
  246.                                     return $v;
  247.                                 })
  248.                             ->end()
  249.                             ->fixXmlConfig('format', 'formats')
  250.                             ->children()
  251.                                 ->scalarNode('service')->defaultNull()->end()
  252.                                 ->arrayNode('formats')
  253.                                     ->useAttributeAsKey('name')
  254.                                     ->prototype('array')
  255.                                         ->beforeNormalization()
  256.                                             ->ifString()
  257.                                             ->then(function ($v) { return [$v]; })
  258.                                         ->end()
  259.                                         ->prototype('scalar')->end()
  260.                                     ->end()
  261.                                 ->end()
  262.                             ->end()
  263.                         ->end()
  264.                         ->arrayNode('formats')
  265.                             ->useAttributeAsKey('name')
  266.                             ->defaultValue(['json' => true, 'xml' => true])
  267.                             ->prototype('boolean')->end()
  268.                         ->end()
  269.                         ->arrayNode('templating_formats')
  270.                             ->setDeprecated('The "%path%.%node%" configuration key has been deprecated in FOSRestBundle 2.8.')
  271.                             ->useAttributeAsKey('name')
  272.                             ->defaultValue(['html' => true])
  273.                             ->prototype('boolean')->end()
  274.                         ->end()
  275.                         ->arrayNode('view_response_listener')
  276.                             ->beforeNormalization()
  277.                                 ->ifString()
  278.                                 ->then(function ($v) {
  279.                                     return ['enabled' => in_array($v, ['force', 'true']), 'force' => 'force' === $v];
  280.                                 })
  281.                             ->end()
  282.                             ->canBeEnabled()
  283.                             ->children()
  284.                                 ->booleanNode('force')->defaultFalse()->end()
  285.                                 ->scalarNode('service')->defaultNull()->end()
  286.                             ->end()
  287.                         ->end()
  288.                         ->scalarNode('failed_validation')->defaultValue(Response::HTTP_BAD_REQUEST)->end()
  289.                         ->scalarNode('empty_content')->defaultValue(Response::HTTP_NO_CONTENT)->end()
  290.                         ->booleanNode('serialize_null')->defaultFalse()->end()
  291.                         ->arrayNode('jsonp_handler')
  292.                             ->canBeUnset()
  293.                             ->children()
  294.                                 ->scalarNode('callback_param')->defaultValue('callback')->end()
  295.                                 ->scalarNode('mime_type')->defaultValue('application/javascript+jsonp')->end()
  296.                             ->end()
  297.                         ->end()
  298.                     ->end()
  299.                 ->end()
  300.             ->end();
  301.     }
  303.     private function addBodyListenerSection(ArrayNodeDefinition $rootNode)
  304.     {
  305.         $decodersDefaultValue = ['json' => 'fos_rest.decoder.json'];
  306.         if (class_exists(XmlEncoder::class)) {
  307.             $decodersDefaultValue['xml'] = 'fos_rest.decoder.xml';
  308.         }
  309.         $rootNode
  310.             ->children()
  311.                 ->arrayNode('body_listener')
  312.                     ->fixXmlConfig('decoder', 'decoders')
  313.                     ->addDefaultsIfNotSet()
  314.                     ->canBeUnset()
  315.                     ->treatFalseLike(['enabled' => false])
  316.                     ->treatTrueLike(['enabled' => true])
  317.                     ->treatNullLike(['enabled' => true])
  318.                     ->children()
  319.                         ->booleanNode('enabled')
  320.                             ->defaultValue(function () {
  321.                                 @trigger_error('The body_listener config has been enabled by default and will be disabled by default in FOSRestBundle 3.0. Please enable or disable it explicitly.', E_USER_DEPRECATED);
  323.                                 return true;
  324.                             })
  325.                         ->end()
  326.                         ->scalarNode('service')->defaultNull()->end()
  327.                         ->scalarNode('default_format')->defaultNull()->end()
  328.                         ->booleanNode('throw_exception_on_unsupported_content_type')
  329.                             ->defaultFalse()
  330.                         ->end()
  331.                         ->arrayNode('decoders')
  332.                             ->useAttributeAsKey('name')
  333.                             ->defaultValue($decodersDefaultValue)
  334.                             ->prototype('scalar')->end()
  335.                         ->end()
  336.                         ->arrayNode('array_normalizer')
  337.                             ->addDefaultsIfNotSet()
  338.                             ->beforeNormalization()
  339.                                 ->ifString()->then(function ($v) {
  340.                                     return ['service' => $v];
  341.                                 })
  342.                             ->end()
  343.                             ->children()
  344.                                 ->scalarNode('service')->defaultNull()->end()
  345.                                 ->booleanNode('forms')->defaultFalse()->end()
  346.                             ->end()
  347.                         ->end()
  348.                     ->end()
  349.                 ->end()
  350.             ->end();
  351.     }
  353.     private function addFormatListenerSection(ArrayNodeDefinition $rootNode)
  354.     {
  355.         $rootNode
  356.             ->children()
  357.                 ->arrayNode('format_listener')
  358.                     ->fixXmlConfig('rule', 'rules')
  359.                     ->addDefaultsIfNotSet()
  360.                     ->canBeUnset()
  361.                     ->beforeNormalization()
  362.                         ->ifTrue(function ($v) {
  363.                             // check if we got an assoc array in rules
  364.                             return isset($v['rules'])
  365.                                 && is_array($v['rules'])
  366.                                 && array_keys($v['rules']) !== range(0, count($v['rules']) - 1);
  367.                         })
  368.                         ->then(function ($v) {
  369.                             $v['rules'] = [$v['rules']];
  371.                             return $v;
  372.                         })
  373.                     ->end()
  374.                     ->canBeEnabled()
  375.                     ->children()
  376.                         ->scalarNode('service')->defaultNull()->end()
  377.                         ->arrayNode('rules')
  378.                             ->performNoDeepMerging()
  379.                             ->prototype('array')
  380.                                 ->fixXmlConfig('priority', 'priorities')
  381.                                 ->fixXmlConfig('attribute', 'attributes')
  382.                                 ->children()
  383.                                     ->scalarNode('path')->defaultNull()->info('URL path info')->end()
  384.                                     ->scalarNode('host')->defaultNull()->info('URL host name')->end()
  385.                                     ->variableNode('methods')->defaultNull()->info('Method for URL')->end()
  386.                                     ->arrayNode('attributes')
  387.                                         ->useAttributeAsKey('name')
  388.                                         ->prototype('variable')->end()
  389.                                     ->end()
  390.                                     ->booleanNode('stop')->defaultFalse()->end()
  391.                                     ->booleanNode('prefer_extension')->defaultTrue()->end()
  392.                                     ->scalarNode('fallback_format')->defaultValue('html')->end()
  393.                                     ->arrayNode('priorities')
  394.                                         ->beforeNormalization()->ifString()->then(function ($v) {
  395.                                             return preg_split('/\s*,\s*/', $v);
  396.                                         })->end()
  397.                                         ->prototype('scalar')->end()
  398.                                     ->end()
  399.                                 ->end()
  400.                             ->end()
  401.                         ->end()
  402.                     ->end()
  403.                 ->end()
  404.             ->end();
  405.     }
  407.     private function addVersioningSection(ArrayNodeDefinition $rootNode)
  408.     {
  409.         $rootNode
  410.         ->children()
  411.             ->arrayNode('versioning')
  412.                 ->canBeEnabled()
  413.                 ->children()
  414.                     ->scalarNode('default_version')->defaultNull()->end()
  415.                     ->arrayNode('resolvers')
  416.                         ->addDefaultsIfNotSet()
  417.                         ->children()
  418.                             ->arrayNode('query')
  419.                                 ->canBeDisabled()
  420.                                 ->children()
  421.                                     ->scalarNode('parameter_name')->defaultValue('version')->end()
  422.                                 ->end()
  423.                             ->end()
  424.                             ->arrayNode('custom_header')
  425.                                 ->canBeDisabled()
  426.                                 ->children()
  427.                                     ->scalarNode('header_name')->defaultValue('X-Accept-Version')->end()
  428.                                 ->end()
  429.                             ->end()
  430.                             ->arrayNode('media_type')
  431.                                 ->canBeDisabled()
  432.                                 ->children()
  433.                                     ->scalarNode('regex')->defaultValue('/(v|version)=(?P<version>[0-9\.]+)/')->end()
  434.                                 ->end()
  435.                             ->end()
  436.                         ->end()
  437.                     ->end()
  438.                     ->arrayNode('guessing_order')
  439.                         ->defaultValue(['query', 'custom_header', 'media_type'])
  440.                         ->validate()
  441.                             ->ifTrue(function ($v) {
  442.                                 foreach ($v as $resolver) {
  443.                                     if (!in_array($resolver, ['query', 'custom_header', 'media_type'])) {
  444.                                         return true;
  445.                                     }
  446.                                 }
  447.                             })
  448.                             ->thenInvalid('Versioning guessing order can only contain "query", "custom_header", "media_type".')
  449.                         ->end()
  450.                         ->prototype('scalar')->end()
  451.                     ->end()
  452.                 ->end()
  453.             ->end()
  454.         ->end();
  455.     }
  457.     private function addExceptionSection(ArrayNodeDefinition $rootNode)
  458.     {
  459.         $rootNode
  460.             ->children()
  461.                 ->arrayNode('exception')
  462.                     ->fixXmlConfig('code', 'codes')
  463.                     ->fixXmlConfig('message', 'messages')
  464.                     ->addDefaultsIfNotSet()
  465.                     ->canBeEnabled()
  466.                     ->validate()
  467.                       ->always()
  468.                       ->then(function ($v) {
  469.                           if (!$v['enabled']) {
  470.                               return $v;
  471.                           }
  473.                           if ($v['exception_listener']) {
  474.                               @trigger_error('Enabling the "fos_rest.exception.exception_listener" option is deprecated since FOSRestBundle 2.8.', E_USER_DEPRECATED);
  475.                           }
  476.                           if ($v['serialize_exceptions']) {
  477.                               @trigger_error('Enabling the "fos_rest.exception.serialize_exceptions" option is deprecated since FOSRestBundle 2.8.', E_USER_DEPRECATED);
  478.                           }
  480.                           return $v;
  481.                       })
  482.                     ->end()
  483.                     ->children()
  484.                         ->booleanNode('map_exception_codes')
  485.                             ->defaultFalse()
  486.                             ->info('Enables an event listener that maps exception codes to response status codes based on the map configured with the "fos_rest.exception.codes" option.')
  487.                         ->end()
  488.                         ->booleanNode('exception_listener')
  489.                             ->defaultTrue()
  490.                         ->end()
  491.                         ->scalarNode('exception_controller')
  492.                             ->defaultNull()
  493.                             ->setDeprecated('The "%path%.%node%" option is deprecated since FOSRestBundle 2.8.')
  494.                         ->end()
  495.                         ->booleanNode('serialize_exceptions')
  496.                             ->defaultTrue()
  497.                         ->end()
  498.                         ->enumNode('flatten_exception_format')
  499.                             ->defaultValue('legacy')
  500.                             ->values(['legacy', 'rfc7807'])
  501.                         ->end()
  502.                         ->scalarNode('service')
  503.                             ->defaultNull()
  504.                             ->setDeprecated('The "%path%.%node%" option is deprecated since FOSRestBundle 2.8.')
  505.                         ->end()
  506.                         ->booleanNode('serializer_error_renderer')->defaultValue(false)->end()
  507.                         ->arrayNode('codes')
  508.                             ->useAttributeAsKey('name')
  509.                             ->beforeNormalization()
  510.                                 ->ifArray()
  511.                                 ->then(function (array $items) {
  512.                                     foreach ($items as &$item) {
  513.                                         if (is_int($item)) {
  514.                                             continue;
  515.                                         }
  517.                                         if (!defined(sprintf('%s::%s', Response::class, $item))) {
  518.                                             throw new InvalidConfigurationException(sprintf('Invalid HTTP code in fos_rest.exception.codes, see %s for all valid codes.', Response::class));
  519.                                         }
  521.                                         $item = constant(sprintf('%s::%s', Response::class, $item));
  522.                                     }
  524.                                     return $items;
  525.                                 })
  526.                             ->end()
  527.                             ->prototype('integer')->end()
  529.                             ->validate()
  530.                             ->ifArray()
  531.                                 ->then(function (array $items) {
  532.                                     foreach ($items as $class => $code) {
  533.                                         $this->testExceptionExists($class);
  534.                                     }
  536.                                     return $items;
  537.                                 })
  538.                             ->end()
  539.                         ->end()
  540.                         ->arrayNode('messages')
  541.                             ->useAttributeAsKey('name')
  542.                             ->prototype('boolean')->end()
  543.                             ->validate()
  544.                                 ->ifArray()
  545.                                 ->then(function (array $items) {
  546.                                     foreach ($items as $class => $nomatter) {
  547.                                         $this->testExceptionExists($class);
  548.                                     }
  550.                                     return $items;
  551.                                 })
  552.                             ->end()
  553.                         ->end()
  554.                         ->booleanNode('debug')
  555.                             ->defaultValue($this->debug)
  556.                         ->end()
  557.                     ->end()
  558.                 ->end()
  559.             ->end();
  560.     }
  562.     private function testExceptionExists(string $throwable)
  563.     {
  564.         if (!is_a($throwable, \Throwable::class, true)) {
  565.             throw new InvalidConfigurationException(sprintf('FOSRestBundle exception mapper: Could not load class "%s" or the class does not extend from "%s". Most probably this is a configuration problem.', $throwable, \Throwable::class));
  566.         }
  567.     }
  568. }