typo3/sysext/extbase/Classes/Mvc/Web/RequestBuilder.php

   1 <?php
   2 namespace TYPO3\CMS\Extbase\Mvc\Web;
   3
   4 /*
   5  * This file is part of the TYPO3 CMS project.
   6  *
   7  * It is free software; you can redistribute it and/or modify it under
   8  * the terms of the GNU General Public License, either version 2
   9  * of the License, or any later version.
  10  *
  11  * For the full copyright and license information, please read the
  12  * LICENSE.txt file that was distributed with this source code.
  13  *
  14  * The TYPO3 project - inspiring people to share!
  15  */
  16
  17 use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
  18 use TYPO3\CMS\Extbase\Mvc\Exception as MvcException;
  19
  20 /**
  21  * Builds a web request.
  22  */
  23 class RequestBuilder implements \TYPO3\CMS\Core\SingletonInterface
  24 {
  25     /**
  26      * @var \TYPO3\CMS\Extbase\Object\ObjectManagerInterface
  27      */
  28     protected $objectManager;
  29
  30     /**
  31      * This is the vendor name of the extension
  32      *
  33      * @var string
  34      */
  35     protected $vendorName;
  36
  37     /**
  38      * This is a unique key for a plugin (not the extension key!)
  39      *
  40      * @var string
  41      */
  42     protected $pluginName = 'plugin';
  43
  44     /**
  45      * The name of the extension (in UpperCamelCase)
  46      *
  47      * @var string
  48      */
  49     protected $extensionName;
  50
  51     /**
  52      * The default controller name
  53      *
  54      * @var string
  55      */
  56     protected $defaultControllerName = '';
  57
  58     /**
  59      * The default format of the response object
  60      *
  61      * @var string
  62      */
  63     protected $defaultFormat = 'html';
  64
  65     /**
  66      * The allowed actions of the controller. This actions can be called via $_GET and $_POST.
  67      *
  68      * @var array
  69      */
  70     protected $allowedControllerActions = [];
  71
  72     /**
  73      * @var \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface
  74      */
  75     protected $configurationManager;
  76
  77     /**
  78      * @var \TYPO3\CMS\Extbase\Service\ExtensionService
  79      */
  80     protected $extensionService;
  81
  82     /**
  83      * @var \TYPO3\CMS\Extbase\Service\EnvironmentService
  84      */
  85     protected $environmentService;
  86
  87     /**
  88      * @param \TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager
  89      */
  90     public function injectObjectManager(\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
  91     {
  92         $this->objectManager = $objectManager;
  93     }
  94
  95     /**
  96      * @param \TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager
  97      */
  98     public function injectConfigurationManager(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface $configurationManager)
  99     {
 100         $this->configurationManager = $configurationManager;
 101     }
 102
 103     /**
 104      * @param \TYPO3\CMS\Extbase\Service\ExtensionService $extensionService
 105      */
 106     public function injectExtensionService(\TYPO3\CMS\Extbase\Service\ExtensionService $extensionService)
 107     {
 108         $this->extensionService = $extensionService;
 109     }
 110
 111     /**
 112      * @param \TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService
 113      */
 114     public function injectEnvironmentService(\TYPO3\CMS\Extbase\Service\EnvironmentService $environmentService)
 115     {
 116         $this->environmentService = $environmentService;
 117     }
 118
 119     /**
 120      * @throws MvcException
 121      * @return void
 122      */
 123     protected function loadDefaultValues()
 124     {
 125         $configuration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
 126         if (empty($configuration['extensionName'])) {
 127             throw new MvcException('"extensionName" is not properly configured. Request can\'t be dispatched!', 1289843275);
 128         }
 129         if (empty($configuration['pluginName'])) {
 130             throw new MvcException('"pluginName" is not properly configured. Request can\'t be dispatched!', 1289843277);
 131         }
 132         if (!empty($configuration['vendorName'])) {
 133             $this->vendorName = $configuration['vendorName'];
 134         } else {
 135             $this->vendorName = null;
 136         }
 137         $this->extensionName = $configuration['extensionName'];
 138         $this->pluginName = $configuration['pluginName'];
 139         $this->defaultControllerName = (string)current(array_keys($configuration['controllerConfiguration']));
 140         $this->allowedControllerActions = [];
 141         foreach ($configuration['controllerConfiguration'] as $controllerName => $controllerActions) {
 142             $this->allowedControllerActions[$controllerName] = $controllerActions['actions'];
 143         }
 144         if (!empty($configuration['format'])) {
 145             $this->defaultFormat = $configuration['format'];
 146         }
 147     }
 148
 149     /**
 150      * Builds a web request object from the raw HTTP information and the configuration
 151      *
 152      * @return \TYPO3\CMS\Extbase\Mvc\Web\Request The web request as an object
 153      */
 154     public function build()
 155     {
 156         $this->loadDefaultValues();
 157         $pluginNamespace = $this->extensionService->getPluginNamespace($this->extensionName, $this->pluginName);
 158         $parameters = \TYPO3\CMS\Core\Utility\GeneralUtility::_GPmerged($pluginNamespace);
 159         $files = $this->untangleFilesArray($_FILES);
 160         if (isset($files[$pluginNamespace]) && is_array($files[$pluginNamespace])) {
 161             $parameters = \TYPO3\CMS\Extbase\Utility\ArrayUtility::arrayMergeRecursiveOverrule($parameters, $files[$pluginNamespace]);
 162         }
 163         $controllerName = $this->resolveControllerName($parameters);
 164         $actionName = $this->resolveActionName($controllerName, $parameters);
 165         /** @var $request \TYPO3\CMS\Extbase\Mvc\Web\Request */
 166         $request = $this->objectManager->get(\TYPO3\CMS\Extbase\Mvc\Web\Request::class);
 167         if ($this->vendorName !== null) {
 168             $request->setControllerVendorName($this->vendorName);
 169         }
 170         $request->setPluginName($this->pluginName);
 171         $request->setControllerExtensionName($this->extensionName);
 172         $request->setControllerName($controllerName);
 173         $request->setControllerActionName($actionName);
 174         $request->setRequestUri(\TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'));
 175         $request->setBaseUri(\TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_SITE_URL'));
 176         $request->setMethod($this->environmentService->getServerRequestMethod());
 177         if (is_string($parameters['format']) && $parameters['format'] !== '') {
 178             $request->setFormat(filter_var($parameters['format'], FILTER_SANITIZE_STRING));
 179         } else {
 180             $request->setFormat($this->defaultFormat);
 181         }
 182         foreach ($parameters as $argumentName => $argumentValue) {
 183             $request->setArgument($argumentName, $argumentValue);
 184         }
 185         return $request;
 186     }
 187
 188     /**
 189      * Returns the current ControllerName extracted from given $parameters.
 190      * If no controller is specified, the defaultControllerName will be returned.
 191      * If that's not available, an exception is thrown.
 192      *
 193      * @param array $parameters
 194      * @throws \TYPO3\CMS\Extbase\Mvc\Exception\InvalidControllerNameException
 195      * @throws MvcException if the controller could not be resolved
 196      * @throws \TYPO3\CMS\Core\Error\Http\PageNotFoundException
 197      * @return string
 198      */
 199     protected function resolveControllerName(array $parameters)
 200     {
 201         if (!isset($parameters['controller']) || $parameters['controller'] === '') {
 202             if (empty($this->defaultControllerName)) {
 203                 throw new MvcException('The default controller for extension "' . $this->extensionName . '" and plugin "' . $this->pluginName . '" can not be determined. Please check for TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php.', 1316104317);
 204             }
 205             return $this->defaultControllerName;
 206         }
 207         $allowedControllerNames = array_keys($this->allowedControllerActions);
 208         if (!in_array($parameters['controller'], $allowedControllerNames)) {
 209             $configuration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
 210             if (isset($configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) && (bool)$configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) {
 211                 throw new \TYPO3\CMS\Core\Error\Http\PageNotFoundException('The requested resource was not found', 1313857897);
 212             } elseif (isset($configuration['mvc']['callDefaultActionIfActionCantBeResolved']) && (bool)$configuration['mvc']['callDefaultActionIfActionCantBeResolved']) {
 213                 return $this->defaultControllerName;
 214             }
 215             throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidControllerNameException(
 216                 'The controller "' . $parameters['controller'] . '" is not allowed by plugin "' . $this->pluginName . '". Please check for TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php.',
 217                 1313855173
 218             );
 219         }
 220         return filter_var($parameters['controller'], FILTER_SANITIZE_STRING);
 221     }
 222
 223     /**
 224      * Returns the current actionName extracted from given $parameters.
 225      * If no action is specified, the defaultActionName will be returned.
 226      * If that's not available or the specified action is not defined in the current plugin, an exception is thrown.
 227      *
 228      * @param string $controllerName
 229      * @param array $parameters
 230      * @throws \TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException
 231      * @throws MvcException
 232      * @throws \TYPO3\CMS\Core\Error\Http\PageNotFoundException
 233      * @return string
 234      */
 235     protected function resolveActionName($controllerName, array $parameters)
 236     {
 237         $defaultActionName = is_array($this->allowedControllerActions[$controllerName]) ? current($this->allowedControllerActions[$controllerName]) : '';
 238         if (!isset($parameters['action']) || $parameters['action'] === '') {
 239             if ($defaultActionName === '') {
 240                 throw new MvcException('The default action can not be determined for controller "' . $controllerName . '". Please check TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php.', 1295479651);
 241             }
 242             return $defaultActionName;
 243         }
 244         $actionName = $parameters['action'];
 245         $allowedActionNames = $this->allowedControllerActions[$controllerName];
 246         if (!in_array($actionName, $allowedActionNames)) {
 247             $configuration = $this->configurationManager->getConfiguration(ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);
 248             if (isset($configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) && (bool)$configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) {
 249                 throw new \TYPO3\CMS\Core\Error\Http\PageNotFoundException('The requested resource was not found', 1313857898);
 250             } elseif (isset($configuration['mvc']['callDefaultActionIfActionCantBeResolved']) && (bool)$configuration['mvc']['callDefaultActionIfActionCantBeResolved']) {
 251                 return $defaultActionName;
 252             }
 253             throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException('The action "' . $actionName . '" (controller "' . $controllerName . '") is not allowed by this plugin. Please check TYPO3\\CMS\\Extbase\\Utility\\ExtensionUtility::configurePlugin() in your ext_localconf.php.', 1313855175);
 254         }
 255         return filter_var($actionName, FILTER_SANITIZE_STRING);
 256     }
 257
 258     /**
 259      * Transforms the convoluted _FILES superglobal into a manageable form.
 260      *
 261      * @param array $convolutedFiles The _FILES superglobal
 262      * @return array Untangled files
 263      * @see TYPO3\Flow\Utility\Environment
 264      */
 265     protected function untangleFilesArray(array $convolutedFiles)
 266     {
 267         $untangledFiles = [];
 268         $fieldPaths = [];
 269         foreach ($convolutedFiles as $firstLevelFieldName => $fieldInformation) {
 270             if (!is_array($fieldInformation['error'])) {
 271                 $fieldPaths[] = [$firstLevelFieldName];
 272             } else {
 273                 $newFieldPaths = $this->calculateFieldPaths($fieldInformation['error'], $firstLevelFieldName);
 274                 array_walk($newFieldPaths, function (&$value, $key) {
 275                     $value = explode('/', $value);
 276                 });
 277                 $fieldPaths = array_merge($fieldPaths, $newFieldPaths);
 278             }
 279         }
 280         foreach ($fieldPaths as $fieldPath) {
 281             if (count($fieldPath) === 1) {
 282                 $fileInformation = $convolutedFiles[$fieldPath[0]];
 283             } else {
 284                 $fileInformation = [];
 285                 foreach ($convolutedFiles[$fieldPath[0]] as $key => $subStructure) {
 286                     $fileInformation[$key] = \TYPO3\CMS\Extbase\Utility\ArrayUtility::getValueByPath($subStructure, array_slice($fieldPath, 1));
 287                 }
 288             }
 289             $untangledFiles = \TYPO3\CMS\Extbase\Utility\ArrayUtility::setValueByPath($untangledFiles, $fieldPath, $fileInformation);
 290         }
 291         return $untangledFiles;
 292     }
 293
 294     /**
 295      * Returns an array of all possibles "field paths" for the given array.
 296      *
 297      * @param array $structure The array to walk through
 298      * @param string $firstLevelFieldName
 299      * @return array An array of paths (as strings) in the format "key1/key2/key3" ...
 300      */
 301     protected function calculateFieldPaths(array $structure, $firstLevelFieldName = null)
 302     {
 303         $fieldPaths = [];
 304         if (is_array($structure)) {
 305             foreach ($structure as $key => $subStructure) {
 306                 $fieldPath = ($firstLevelFieldName !== null ? $firstLevelFieldName . '/' : '') . $key;
 307                 if (is_array($subStructure)) {
 308                     foreach ($this->calculateFieldPaths($subStructure) as $subFieldPath) {
 309                         $fieldPaths[] = $fieldPath . '/' . $subFieldPath;
 310                     }
 311                 } else {
 312                     $fieldPaths[] = $fieldPath;
 313                 }
 314             }
 315         }
 316         return $fieldPaths;
 317     }
 318 }