vendor/friendsofsymfony/rest-bundle/DependencyInjection/FOSRestExtension.php line 387

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 FOS\RestBundle\ErrorRenderer\SerializerErrorRenderer;
  15. use FOS\RestBundle\EventListener\ResponseStatusCodeListener;
  16. use FOS\RestBundle\View\ViewHandler;
  17. use Symfony\Component\Config\FileLocator;
  18. use Symfony\Component\DependencyInjection\Alias;
  19. use Symfony\Component\DependencyInjection\ChildDefinition;
  20. use Symfony\Component\DependencyInjection\Compiler\ServiceLocatorTagPass;
  21. use Symfony\Component\DependencyInjection\ContainerBuilder;
  22. use Symfony\Component\DependencyInjection\ContainerInterface;
  23. use Symfony\Component\DependencyInjection\Definition;
  24. use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
  25. use Symfony\Component\DependencyInjection\Reference;
  26. use Symfony\Component\Form\Extension\Core\Type\FormType;
  27. use Symfony\Component\HttpFoundation\Response;
  28. use Symfony\Component\HttpKernel\DependencyInjection\Extension;
  29. use Symfony\Component\Validator\Constraint;
  31. /**
  32. * @internal
  33. */
  34. class FOSRestExtension extends Extension
  35. {
  36. /**
  37. * {@inheritdoc}
  38. */
  39. public function getConfiguration(array $config, ContainerBuilder $container): Configuration
  40. {
  41. return new Configuration($container->getParameter('kernel.debug'));
  42. }
  44. public function load(array $configs, ContainerBuilder $container): void
  45. {
  46. $configuration = new Configuration($container->getParameter('kernel.debug'));
  47. $config = $this->processConfiguration($configuration, $configs);
  49. $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
  50. $loader->load('view.xml');
  51. $loader->load('request.xml');
  52. $loader->load('serializer.xml');
  54. foreach ($config['service'] as $key => $service) {
  55. if ('validator' === $service && empty($config['body_converter']['validate'])) {
  56. continue;
  57. }
  59. if (null !== $service) {
  60. if ('view_handler' === $key) {
  61. $container->setAlias('fos_rest.'.$key, new Alias($service, true));
  62. } else {
  63. $container->setAlias('fos_rest.'.$key, $service);
  64. }
  65. }
  66. }
  68. $this->loadForm($config, $loader, $container);
  69. $this->loadException($config, $loader, $container);
  70. $this->loadBodyConverter($config, $loader, $container);
  71. $this->loadView($config, $loader, $container);
  73. $this->loadBodyListener($config, $loader, $container);
  74. $this->loadFormatListener($config, $loader, $container);
  75. $this->loadVersioning($config, $loader, $container);
  76. $this->loadParamFetcherListener($config, $loader, $container);
  77. $this->loadAllowedMethodsListener($config, $loader, $container);
  78. $this->loadZoneMatcherListener($config, $loader, $container);
  80. // Needs RequestBodyParamConverter and View Handler loaded.
  81. $this->loadSerializer($config, $container);
  82. }
  84. private function loadForm(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  85. {
  86. if (!empty($config['disable_csrf_role'])) {
  87. $loader->load('forms.xml');
  89. $definition = $container->getDefinition('fos_rest.form.extension.csrf_disable');
  90. $definition->replaceArgument(1, $config['disable_csrf_role']);
  91. $definition->addTag('form.type_extension', ['extended_type' => FormType::class]);
  92. }
  93. }
  95. private function loadAllowedMethodsListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  96. {
  97. if ($config['allowed_methods_listener']['enabled']) {
  98. if (!empty($config['allowed_methods_listener']['service'])) {
  99. $service = $container->getDefinition('fos_rest.allowed_methods_listener');
  100. $service->clearTag('kernel.event_listener');
  101. }
  103. $loader->load('allowed_methods_listener.xml');
  105. $container->getDefinition('fos_rest.allowed_methods_loader')->replaceArgument(1, $config['cache_dir']);
  106. }
  107. }
  109. private function loadBodyListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  110. {
  111. if ($config['body_listener']['enabled']) {
  112. $loader->load('body_listener.xml');
  114. $service = $container->getDefinition('fos_rest.body_listener');
  116. if (!empty($config['body_listener']['service'])) {
  117. $service->clearTag('kernel.event_listener');
  118. }
  120. $service->replaceArgument(1, $config['body_listener']['throw_exception_on_unsupported_content_type']);
  121. $service->addMethodCall('setDefaultFormat', [$config['body_listener']['default_format']]);
  123. $container->getDefinition('fos_rest.decoder_provider')->replaceArgument(1, $config['body_listener']['decoders']);
  125. $decoderServicesMap = [];
  127. foreach ($config['body_listener']['decoders'] as $id) {
  128. $decoderServicesMap[$id] = new Reference($id);
  129. }
  131. $decodersServiceLocator = ServiceLocatorTagPass::register($container, $decoderServicesMap);
  132. $container->getDefinition('fos_rest.decoder_provider')->replaceArgument(0, $decodersServiceLocator);
  134. $arrayNormalizer = $config['body_listener']['array_normalizer'];
  136. if (null !== $arrayNormalizer['service']) {
  137. $bodyListener = $container->getDefinition('fos_rest.body_listener');
  138. $bodyListener->addArgument(new Reference($arrayNormalizer['service']));
  139. $bodyListener->addArgument($arrayNormalizer['forms']);
  140. }
  141. }
  142. }
  144. private function loadFormatListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  145. {
  146. if ($config['format_listener']['enabled'] && !empty($config['format_listener']['rules'])) {
  147. $loader->load('format_listener.xml');
  149. if (!empty($config['format_listener']['service'])) {
  150. $service = $container->getDefinition('fos_rest.format_listener');
  151. $service->clearTag('kernel.event_listener');
  152. }
  154. $container->setParameter(
  155. 'fos_rest.format_listener.rules',
  156. $config['format_listener']['rules']
  157. );
  158. }
  159. }
  161. private function loadVersioning(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  162. {
  163. if (!empty($config['versioning']['enabled'])) {
  164. $loader->load('versioning.xml');
  166. $versionListener = $container->getDefinition('fos_rest.versioning.listener');
  167. $versionListener->replaceArgument(1, $config['versioning']['default_version']);
  169. $resolvers = [];
  170. if ($config['versioning']['resolvers']['query']['enabled']) {
  171. $resolvers['query'] = $container->getDefinition('fos_rest.versioning.query_parameter_resolver');
  172. $resolvers['query']->replaceArgument(0, $config['versioning']['resolvers']['query']['parameter_name']);
  173. }
  174. if ($config['versioning']['resolvers']['custom_header']['enabled']) {
  175. $resolvers['custom_header'] = $container->getDefinition('fos_rest.versioning.header_resolver');
  176. $resolvers['custom_header']->replaceArgument(0, $config['versioning']['resolvers']['custom_header']['header_name']);
  177. }
  178. if ($config['versioning']['resolvers']['media_type']['enabled']) {
  179. $resolvers['media_type'] = $container->getDefinition('fos_rest.versioning.media_type_resolver');
  180. $resolvers['media_type']->replaceArgument(0, $config['versioning']['resolvers']['media_type']['regex']);
  181. }
  183. $chainResolver = $container->getDefinition('fos_rest.versioning.chain_resolver');
  184. foreach ($config['versioning']['guessing_order'] as $resolver) {
  185. if (isset($resolvers[$resolver])) {
  186. $chainResolver->addMethodCall('addResolver', [$resolvers[$resolver]]);
  187. }
  188. }
  189. }
  190. }
  192. private function loadParamFetcherListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  193. {
  194. if ($config['param_fetcher_listener']['enabled']) {
  195. if (!class_exists(Constraint::class)) {
  196. throw new \LogicException('Enabling the fos_rest.param_fetcher_listener option when the Symfony Validator component is not installed is not supported. Try installing the symfony/validator package.');
  197. }
  199. $loader->load('param_fetcher_listener.xml');
  201. if (!empty($config['param_fetcher_listener']['service'])) {
  202. $service = $container->getDefinition('fos_rest.param_fetcher_listener');
  203. $service->clearTag('kernel.event_listener');
  204. }
  206. if ($config['param_fetcher_listener']['force']) {
  207. $container->getDefinition('fos_rest.param_fetcher_listener')->replaceArgument(1, true);
  208. }
  209. }
  210. }
  212. private function loadBodyConverter(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  213. {
  214. if (!$this->isConfigEnabled($container, $config['body_converter'])) {
  215. return;
  216. }
  218. $loader->load('request_body_param_converter.xml');
  220. if (!empty($config['body_converter']['validation_errors_argument'])) {
  221. $container->getDefinition('fos_rest.converter.request_body')->replaceArgument(4, $config['body_converter']['validation_errors_argument']);
  222. }
  223. }
  225. private function loadView(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  226. {
  227. if (!empty($config['view']['jsonp_handler'])) {
  228. $handler = new ChildDefinition($config['service']['view_handler']);
  229. $handler->setPublic(true);
  231. $jsonpHandler = new Reference('fos_rest.view_handler.jsonp');
  232. $handler->addMethodCall('registerHandler', ['jsonp', [$jsonpHandler, 'createResponse']]);
  233. $container->setDefinition('fos_rest.view_handler', $handler);
  235. $container->getDefinition('fos_rest.view_handler.jsonp')->replaceArgument(0, $config['view']['jsonp_handler']['callback_param']);
  237. if (empty($config['view']['mime_types']['jsonp'])) {
  238. $config['view']['mime_types']['jsonp'] = $config['view']['jsonp_handler']['mime_type'];
  239. }
  240. }
  242. if ($config['view']['mime_types']['enabled']) {
  243. $loader->load('mime_type_listener.xml');
  245. if (!empty($config['mime_type_listener']['service'])) {
  246. $service = $container->getDefinition('fos_rest.mime_type_listener');
  247. $service->clearTag('kernel.event_listener');
  248. }
  250. $container->getDefinition('fos_rest.mime_type_listener')->replaceArgument(0, $config['view']['mime_types']['formats']);
  251. }
  253. if ($config['view']['view_response_listener']['enabled']) {
  254. $loader->load('view_response_listener.xml');
  255. $service = $container->getDefinition('fos_rest.view_response_listener');
  257. if (!empty($config['view_response_listener']['service'])) {
  258. $service->clearTag('kernel.event_listener');
  259. }
  261. $service->replaceArgument(1, $config['view']['view_response_listener']['force']);
  262. }
  264. $formats = [];
  265. foreach ($config['view']['formats'] as $format => $enabled) {
  266. if ($enabled) {
  267. $formats[$format] = false;
  268. }
  269. }
  271. if (!is_numeric($config['view']['failed_validation'])) {
  272. $config['view']['failed_validation'] = constant(sprintf('%s::%s', Response::class, $config['view']['failed_validation']));
  273. }
  275. if (!is_numeric($config['view']['empty_content'])) {
  276. $config['view']['empty_content'] = constant(sprintf('%s::%s', Response::class, $config['view']['empty_content']));
  277. }
  279. $defaultViewHandler = $container->getDefinition('fos_rest.view_handler.default');
  280. $defaultViewHandler->setFactory([ViewHandler::class, 'create']);
  281. $defaultViewHandler->setArguments([
  282. new Reference('router'),
  283. new Reference('fos_rest.serializer'),
  284. new Reference('request_stack'),
  285. $formats,
  286. $config['view']['failed_validation'],
  287. $config['view']['empty_content'],
  288. $config['view']['serialize_null'],
  289. ]);
  290. }
  292. private function loadException(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  293. {
  294. if ($config['exception']['enabled']) {
  295. $loader->load('exception.xml');
  297. if ($config['exception']['map_exception_codes']) {
  298. $container->register('fos_rest.exception.response_status_code_listener', ResponseStatusCodeListener::class)
  299. ->setArguments([
  300. new Reference('fos_rest.exception.codes_map'),
  301. ])
  302. ->addTag('kernel.event_subscriber');
  303. }
  305. $container->getDefinition('fos_rest.exception.codes_map')
  306. ->replaceArgument(0, $config['exception']['codes']);
  307. $container->getDefinition('fos_rest.exception.messages_map')
  308. ->replaceArgument(0, $config['exception']['messages']);
  310. $container->getDefinition('fos_rest.serializer.flatten_exception_handler')
  311. ->replaceArgument(2, $config['exception']['debug']);
  312. $container->getDefinition('fos_rest.serializer.flatten_exception_handler')
  313. ->replaceArgument(3, 'rfc7807' === $config['exception']['flatten_exception_format']);
  314. $container->getDefinition('fos_rest.serializer.flatten_exception_normalizer')
  315. ->replaceArgument(2, $config['exception']['debug']);
  316. $container->getDefinition('fos_rest.serializer.flatten_exception_normalizer')
  317. ->replaceArgument(3, 'rfc7807' === $config['exception']['flatten_exception_format']);
  319. if ($config['exception']['serializer_error_renderer']) {
  320. $format = new Definition();
  321. $format->setFactory([SerializerErrorRenderer::class, 'getPreferredFormat']);
  322. $format->setArguments([
  323. new Reference('request_stack'),
  324. ]);
  325. $debug = new Definition();
  326. $debug->setFactory([SerializerErrorRenderer::class, 'isDebug']);
  327. $debug->setArguments([
  328. new Reference('request_stack'),
  329. '%kernel.debug%',
  330. ]);
  331. $container->register('fos_rest.error_renderer.serializer', SerializerErrorRenderer::class)
  332. ->setArguments([
  333. new Reference('fos_rest.serializer'),
  334. $format,
  335. new Reference('error_renderer.html', ContainerInterface::NULL_ON_INVALID_REFERENCE),
  336. $debug,
  337. ]);
  338. $container->setAlias('error_renderer', 'fos_rest.error_renderer.serializer');
  339. }
  340. }
  341. }
  343. private function loadSerializer(array $config, ContainerBuilder $container): void
  344. {
  345. $bodyConverter = $container->hasDefinition('fos_rest.converter.request_body') ? $container->getDefinition('fos_rest.converter.request_body') : null;
  346. $viewHandler = $container->getDefinition('fos_rest.view_handler.default');
  347. $options = [];
  349. if (!empty($config['serializer']['version'])) {
  350. if ($bodyConverter) {
  351. $bodyConverter->replaceArgument(2, $config['serializer']['version']);
  352. }
  353. $options['exclusionStrategyVersion'] = $config['serializer']['version'];
  354. }
  356. if (!empty($config['serializer']['groups'])) {
  357. if ($bodyConverter) {
  358. $bodyConverter->replaceArgument(1, $config['serializer']['groups']);
  359. }
  360. $options['exclusionStrategyGroups'] = $config['serializer']['groups'];
  361. }
  363. $options['serializeNullStrategy'] = $config['serializer']['serialize_null'];
  364. $viewHandler->addArgument($options);
  365. }
  367. private function loadZoneMatcherListener(array $config, XmlFileLoader $loader, ContainerBuilder $container): void
  368. {
  369. if (!empty($config['zone'])) {
  370. $loader->load('zone_matcher_listener.xml');
  371. $zoneMatcherListener = $container->getDefinition('fos_rest.zone_matcher_listener');
  373. foreach ($config['zone'] as $zone) {
  374. $matcher = $this->createZoneRequestMatcher(
  375. $container,
  376. $zone['path'],
  377. $zone['host'],
  378. $zone['methods'],
  379. $zone['ips']
  380. );
  382. $zoneMatcherListener->addMethodCall('addRequestMatcher', [$matcher]);
  383. }
  384. }
  385. }
  387. private function createZoneRequestMatcher(ContainerBuilder $container, ?string $path = null, ?string $host = null, array $methods = [], array $ips = null): Reference
  388. {
  389. if ($methods) {
  390. $methods = array_map('strtoupper', (array) $methods);
  391. }
  393. $serialized = serialize([$path, $host, $methods, $ips]);
  394. $id = 'fos_rest.zone_request_matcher.'.md5($serialized).sha1($serialized);
  396. // only add arguments that are necessary
  397. $arguments = [$path, $host, $methods, $ips];
  398. while (count($arguments) > 0 && !end($arguments)) {
  399. array_pop($arguments);
  400. }
  402. $container
  403. ->setDefinition($id, new ChildDefinition('fos_rest.zone_request_matcher'))
  404. ->setArguments($arguments)
  405. ;
  407. return new Reference($id);
  408. }
  409. }