‪TYPO3CMS  ‪main
RequestBuilder.php
Go to the documentation of this file.
1 <?php
2 
3 declare(strict_types=1);
4 
5 /*
6  * This file is part of the TYPO3 CMS project.
7  *
8  * It is free software; you can redistribute it and/or modify it under
9  * the terms of the GNU General Public License, either version 2
10  * of the License, or any later version.
11  *
12  * For the full copyright and license information, please read the
13  * LICENSE.txt file that was distributed with this source code.
14  *
15  * The TYPO3 project - inspiring people to share!
16  */
17 
19 
20 use Psr\Http\Message\ServerRequestInterface;
33 
40 {
43 
45  {
46  $this->configurationManager = ‪$configurationManager;
47  $this->extensionService = ‪$extensionService;
48  }
49 
54  protected function ‪loadDefaultValues(array $configuration = []): ‪RequestBuilderDefaultValues
55  {
56  // todo: See comment in \TYPO3\CMS\Extbase\Core\Bootstrap::initializeConfiguration for further explanation
57  // todo: on why we shouldn't use the configuration manager here.
58  $configuration = array_replace_recursive($this->configurationManager->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK), $configuration);
59 
60  try {
62  } catch (\InvalidArgumentException $e) {
63  throw MvcException::fromPrevious($e);
64  }
65  }
66 
72  public function ‪build(ServerRequestInterface $mainRequest)
73  {
74  $configuration = [];
75  // Parameters, which are not part of the request URL (e.g. due to "useArgumentsWithoutNamespace"), which however
76  // need to be taken into account on building the extbase request. Usually those are "controller" and "action".
77  $fallbackParameters = [];
78  // To be used in TYPO3 Backend for Extbase modules that do not need the "namespaces" GET and POST parameters anymore.
79  $useArgumentsWithoutNamespace = false;
80  // Fetch requested module from the main request. This is only used for TYPO3 Backend Modules.
81  $module = $mainRequest->‪getAttribute('module');
82  if ($module instanceof ‪ExtbaseModule) {
83  $configuration = [
84  'controllerConfiguration' => $module->getControllerActions(),
85  ];
86  $useArgumentsWithoutNamespace = true;
87  // Ensure the "controller" and "action" information are added as fallback parameters.
88  if ($routeOptions = $mainRequest->getAttribute('route')?->getOptions()) {
89  $fallbackParameters['controller'] = $routeOptions['controller'] ?? null;
90  $fallbackParameters['action'] = $routeOptions['action'];
91  }
92  }
93  $defaultValues = $this->‪loadDefaultValues($configuration);
94  $pluginNamespace = $this->extensionService->getPluginNamespace(
95  $defaultValues->getExtensionName(),
96  $defaultValues->getPluginName()
97  );
98  $queryArguments = $mainRequest->getAttribute('routing');
99  if ($useArgumentsWithoutNamespace) {
100  $parameters = $mainRequest->getQueryParams();
101  } elseif ($queryArguments instanceof ‪PageArguments) {
102  $parameters = $queryArguments->get($pluginNamespace) ?? [];
103  } else {
104  $parameters = $mainRequest->getQueryParams()[$pluginNamespace] ?? [];
105  }
106  $parameters = is_array($parameters) ? $parameters : [];
107  if ($fallbackParameters !== []) {
108  // Enhance with fallback parameters, such as "controller" and "action"
109  $parameters = array_replace_recursive($fallbackParameters, $parameters);
110  }
111  if ($mainRequest->getMethod() === 'POST') {
112  if ($useArgumentsWithoutNamespace) {
113  $postParameters = $mainRequest->getParsedBody();
114  } else {
115  $postParameters = $mainRequest->getParsedBody()[$pluginNamespace] ?? [];
116  }
117  $postParameters = is_array($postParameters) ? $postParameters : [];
118  $parameters = array_replace_recursive($parameters, $postParameters);
119  }
120 
121  $files = $mainRequest->getUploadedFiles();
122  if (!$useArgumentsWithoutNamespace) {
123  $files = $files[$pluginNamespace] ?? [];
124  }
125  if ($files instanceof ‪UploadedFile) {
126  // ensure it's always an array
127  $files = [$files];
128  }
129 
130  $controllerClassName = $this->‪resolveControllerClassName($defaultValues, $parameters);
131  $actionName = $this->‪resolveActionName($defaultValues, $controllerClassName, $parameters);
132 
133  $extbaseAttribute = new ‪ExtbaseRequestParameters();
134  $extbaseAttribute->setPluginName($defaultValues->getPluginName());
135  $extbaseAttribute->setControllerExtensionName($defaultValues->getExtensionName());
136  $extbaseAttribute->setControllerAliasToClassNameMapping($defaultValues->getControllerAliasToClassMapping());
137  $extbaseAttribute->setControllerName($defaultValues->getControllerAliasForControllerClassName($controllerClassName));
138  $extbaseAttribute->setControllerActionName($actionName);
139  $extbaseAttribute->setUploadedFiles($files);
140 
141  if (isset($parameters['format']) && is_string($parameters['format']) && $parameters['format'] !== '') {
142  $extbaseAttribute->setFormat(preg_replace('/[^a-zA-Z0-9]+/', '', $parameters['format']));
143  } else {
144  $extbaseAttribute->setFormat($defaultValues->getDefaultFormat());
145  }
146  foreach ($parameters as $argumentName => $argumentValue) {
147  $extbaseAttribute->setArgument($argumentName, $argumentValue);
148  }
149  return new ‪Request($mainRequest->withAttribute('extbase', $extbaseAttribute));
150  }
151 
162  protected function ‪resolveControllerClassName(‪RequestBuilderDefaultValues $defaultValues, array $parameters): string
163  {
164  if (!isset($parameters['controller']) || $parameters['controller'] === '') {
165  return $defaultValues->‪getDefaultControllerClassName();
166  }
167  $controllerClassName = $defaultValues->‪getControllerClassNameForAlias($parameters['controller']) ?? '';
168  if ($defaultValues->‪getAllowedControllerActionsOfController($controllerClassName) === []) {
169  $configuration = $this->configurationManager->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
170  if (isset($configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) && (bool)$configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) {
171  throw new ‪PageNotFoundException('The requested resource was not found', 1313857897);
172  }
173  if (isset($configuration['mvc']['callDefaultActionIfActionCantBeResolved']) && (bool)$configuration['mvc']['callDefaultActionIfActionCantBeResolved']) {
174  return $defaultValues->‪getDefaultControllerClassName();
175  }
177  'The controller "' . $parameters['controller'] . '" is not allowed by plugin "' . $defaultValues->‪getPluginName() . '". Please check for TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php.',
178  1313855173
179  );
180  }
181  return preg_replace('/[^a-zA-Z0-9\\\\]+/', '', $controllerClassName);
182  }
183 
195  protected function ‪resolveActionName(‪RequestBuilderDefaultValues $defaultValues, string $controllerClassName, array $parameters): string
196  {
197  $defaultActionName = $defaultValues->‪getDefaultActionName($controllerClassName);
198  if (!isset($parameters['action']) || $parameters['action'] === '') {
199  if ($defaultActionName === '') {
200  throw new ‪MvcException('The default action can not be determined for controller "' . $controllerClassName . '". Please check TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php.', 1295479651);
201  }
202  return $defaultActionName;
203  }
204  $actionName = $parameters['action'];
205  $allowedActionNames = $defaultValues->‪getAllowedControllerActionsOfController($controllerClassName);
206  if (!in_array($actionName, $allowedActionNames)) {
207  $configuration = $this->configurationManager->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
208  if (isset($configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) && (bool)$configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) {
209  throw new ‪PageNotFoundException('The requested resource was not found', 1313857898);
210  }
211  if (isset($configuration['mvc']['callDefaultActionIfActionCantBeResolved']) && (bool)$configuration['mvc']['callDefaultActionIfActionCantBeResolved']) {
212  if ($defaultActionName === '') {
213  throw new ‪MvcException('The default action can not be determined for controller "' . $controllerClassName . '". Please check TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php.', 1679048627);
214  }
215  return $defaultActionName;
216  }
217  throw new ‪InvalidActionNameException('The action "' . $actionName . '" (controller "' . $controllerClassName . '") is not allowed by this plugin / module. Please check TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php / TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configureModule() in your ext_tables.php.', 1313855175);
218  }
219  return preg_replace('/[^a-zA-Z0-9]+/', '', $actionName);
220  }
221 }
‪TYPO3\CMS\Core\Routing\PageArguments
Definition: PageArguments.php:26
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\$extensionService
‪ExtensionService $extensionService
Definition: RequestBuilder.php:42
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\resolveActionName
‪non empty string resolveActionName(RequestBuilderDefaultValues $defaultValues, string $controllerClassName, array $parameters)
Definition: RequestBuilder.php:195
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\build
‪Request build(ServerRequestInterface $mainRequest)
Definition: RequestBuilder.php:72
‪TYPO3\CMS\Extbase\Mvc\Exception\InvalidControllerNameException
Definition: InvalidControllerNameException.php:25
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\loadDefaultValues
‪loadDefaultValues(array $configuration=[])
Definition: RequestBuilder.php:54
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilderDefaultValues
Definition: RequestBuilderDefaultValues.php:24
‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
Definition: ConfigurationManagerInterface.php:28
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\$configurationManager
‪ConfigurationManagerInterface $configurationManager
Definition: RequestBuilder.php:41
‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface\CONFIGURATION_TYPE_FRAMEWORK
‪const CONFIGURATION_TYPE_FRAMEWORK
Definition: ConfigurationManagerInterface.php:29
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilderDefaultValues\fromConfiguration
‪static fromConfiguration(array $configuration)
Definition: RequestBuilderDefaultValues.php:43
‪TYPO3\CMS\Backend\Module\ExtbaseModule
Definition: ExtbaseModule.php:30
‪TYPO3\CMS\Core\Error\Http\PageNotFoundException
Definition: PageNotFoundException.php:24
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\__construct
‪__construct(ConfigurationManagerInterface $configurationManager, ExtensionService $extensionService)
Definition: RequestBuilder.php:44
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder\resolveControllerClassName
‪class string resolveControllerClassName(RequestBuilderDefaultValues $defaultValues, array $parameters)
Definition: RequestBuilder.php:162
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilderDefaultValues\getDefaultControllerClassName
‪class string getDefaultControllerClassName()
Definition: RequestBuilderDefaultValues.php:171
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilderDefaultValues\getDefaultActionName
‪getDefaultActionName(string $controllerClassName)
Definition: RequestBuilderDefaultValues.php:242
‪TYPO3\CMS\Extbase\Mvc\Exception
Definition: InfiniteLoopException.php:18
‪TYPO3\CMS\Extbase\Mvc\Web
Definition: RequestBuilder.php:18
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilderDefaultValues\getAllowedControllerActionsOfController
‪list< string > getAllowedControllerActionsOfController(string $controllerClassName)
Definition: RequestBuilderDefaultValues.php:203
‪TYPO3\CMS\Core\SingletonInterface
Definition: SingletonInterface.php:22
‪TYPO3\CMS\Extbase\Service\ExtensionService
Definition: ExtensionService.php:34
‪TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException
Definition: InvalidActionNameException.php:25
‪TYPO3\CMS\Core\Http\UploadedFile
Definition: UploadedFile.php:34
‪TYPO3\CMS\Extbase\Mvc\Request\getAttribute
‪getAttribute($name, $default=null)
Definition: Request.php:271
‪TYPO3\CMS\Extbase\Mvc\ExtbaseRequestParameters
Definition: ExtbaseRequestParameters.php:35
‪TYPO3\CMS\Extbase\Mvc\Request
Definition: Request.php:35
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilderDefaultValues\getPluginName
‪non empty string getPluginName()
Definition: RequestBuilderDefaultValues.php:163
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilderDefaultValues\getControllerClassNameForAlias
‪class string null getControllerClassNameForAlias(string $controllerAlias)
Definition: RequestBuilderDefaultValues.php:228
‪TYPO3\CMS\Extbase\Mvc\Web\RequestBuilder
Definition: RequestBuilder.php:40