9.5/_web_2_request_builder_8php_source.html

<?php

namespace ‪TYPO3\CMS\Extbase\Mvc\Web;


/*

 * This file is part of the TYPO3 CMS project.

 *

 * It is free software; you can redistribute it and/or modify it under

 * the terms of the GNU General Public License, either version 2

 * of the License, or any later version.

 *

 * For the full copyright and license information, please read the

 * LICENSE.txt file that was distributed with this source code.

 *

 * The TYPO3 project - inspiring people to share!

 */


use Psr\Http\Message\ServerRequestInterface;

use ‪TYPO3\CMS\Core\Routing\PageArguments;

use ‪TYPO3\CMS\Core\Utility\ArrayUtility;

use ‪TYPO3\CMS\Core\Utility\Exception\MissingArrayPathException;

use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;

use ‪TYPO3\CMS\Extbase\Mvc\Exception as ‪MvcException;


class ‪RequestBuilder implements ‪\TYPO3\CMS\Core\SingletonInterface

{

    protected ‪$objectManager;


    protected ‪$vendorName;


    protected ‪$pluginName = 'plugin';


    protected ‪$extensionName;


    protected ‪$defaultControllerName = '';


    protected ‪$defaultFormat = 'html';


    protected ‪$allowedControllerActions = [];


    protected ‪$configurationManager;


    protected ‪$extensionService;


    protected ‪$environmentService;


    public function ‪injectObjectManager(\‪TYPO3\CMS\‪Extbase\Object\ObjectManagerInterface ‪$objectManager)

    {

        $this->objectManager = ‪$objectManager;

    }


    public function ‪injectConfigurationManager(\‪TYPO3\CMS\‪Extbase\Configuration\‪ConfigurationManagerInterface ‪$configurationManager)

    {

        $this->configurationManager = ‪$configurationManager;

    }


    public function ‪injectExtensionService(\‪TYPO3\CMS\‪Extbase\Service\ExtensionService ‪$extensionService)

    {

        $this->extensionService = ‪$extensionService;

    }


    public function ‪injectEnvironmentService(\‪TYPO3\CMS\‪Extbase\Service\EnvironmentService ‪$environmentService)

    {

        $this->environmentService = ‪$environmentService;

    }


    protected function ‪loadDefaultValues()

    {

        $configuration = $this->configurationManager->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);

        if (empty($configuration['extensionName'])) {

            throw new ‪MvcException('"extensionName" is not properly configured. Request can\'t be dispatched!', 1289843275);

        }

        if (empty($configuration['pluginName'])) {

            throw new ‪MvcException('"pluginName" is not properly configured. Request can\'t be dispatched!', 1289843277);

        }

        if (!empty($configuration['vendorName'])) {

            $this->vendorName = $configuration['vendorName'];

        } else {

            $this->vendorName = null;

        }

        $this->extensionName = $configuration['extensionName'];

        $this->pluginName = $configuration['pluginName'];

        $this->defaultControllerName = (string)current(array_keys($configuration['controllerConfiguration']));

        $this->allowedControllerActions = [];

        foreach ($configuration['controllerConfiguration'] as $controllerName => $controllerActions) {

            $this->allowedControllerActions[$controllerName] = $controllerActions['actions'] ?? null;

        }

        if (!empty($configuration['format'])) {

            $this->defaultFormat = $configuration['format'];

        }

    }

    public function ‪build()

    {

        $this->‪loadDefaultValues();

        $pluginNamespace = $this->extensionService->getPluginNamespace($this->extensionName, $this->pluginName);

        $typo3Request = ‪$GLOBALS['TYPO3_REQUEST'] ?? null;

        if ($typo3Request instanceof ServerRequestInterface) {

            $queryArguments = $typo3Request->getAttribute('routing');

            if ($queryArguments instanceof PageArguments) {

                $getParameters = $queryArguments->get($pluginNamespace) ?? [];

            } else {

                $getParameters = $typo3Request->getQueryParams()[$pluginNamespace] ?? [];

            }

            $bodyParameters = $typo3Request->getParsedBody()[$pluginNamespace] ?? [];

            $bodyParameters = is_array($bodyParameters) ? $bodyParameters : [];

            $parameters = is_array($getParameters) ? $getParameters : [];

            ‪ArrayUtility::mergeRecursiveWithOverrule($parameters, $bodyParameters);

        } else {

            $parameters = \TYPO3\CMS\Core\Utility\GeneralUtility::_GPmerged($pluginNamespace);

        }


        $files = $this->‪untangleFilesArray($_FILES);

        if (is_array($files[$pluginNamespace] ?? null)) {

            $parameters = array_replace_recursive($parameters, $files[$pluginNamespace]);

        }


        $controllerName = $this->‪resolveControllerName($parameters);

        $actionName = $this->‪resolveActionName($controllerName, $parameters);

        $request = $this->objectManager->get(\‪TYPO3\CMS\‪Extbase\Mvc\Web\Request::class);

        if ($this->vendorName !== null) {

            $request->setControllerVendorName($this->vendorName);

        }

        $request->setPluginName($this->pluginName);

        $request->setControllerExtensionName($this->extensionName);

        $request->setControllerName($controllerName);

        $request->setControllerActionName($actionName);

        // @todo Use Environment

        $request->setRequestUri(\‪TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_REQUEST_URL'));

        $request->setBaseUri(\‪TYPO3\CMS\Core\Utility\GeneralUtility::getIndpEnv('TYPO3_SITE_URL'));

        $request->setMethod($this->environmentService->getServerRequestMethod());

        if (isset($parameters['format']) && is_string($parameters['format']) && $parameters['format'] !== '') {

            $request->setFormat(filter_var($parameters['format'], FILTER_SANITIZE_STRING));

        } else {

            $request->setFormat($this->defaultFormat);

        }

        foreach ($parameters as $argumentName => $argumentValue) {

            $request->setArgument($argumentName, $argumentValue);

        }

        return $request;

    }


    protected function ‪resolveControllerName(array $parameters)

    {

        if (!isset($parameters['controller']) || $parameters['controller'] === '') {

            if (empty($this->defaultControllerName)) {

                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);

            }

            return ‪$this->defaultControllerName;

        }

        $allowedControllerNames = array_keys($this->allowedControllerActions);

        if (!in_array($parameters['controller'], $allowedControllerNames)) {

            $configuration = $this->configurationManager->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);

            if (isset($configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) && (bool)$configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) {

                throw new \TYPO3\CMS\Core\Error\Http\PageNotFoundException('The requested resource was not found', 1313857897);

            }

            if (isset($configuration['mvc']['callDefaultActionIfActionCantBeResolved']) && (bool)$configuration['mvc']['callDefaultActionIfActionCantBeResolved']) {

                return ‪$this->defaultControllerName;

            }

            throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidControllerNameException(

                '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.',

                1313855173

            );

        }

        return filter_var($parameters['controller'], FILTER_SANITIZE_STRING);

    }


    protected function ‪resolveActionName($controllerName, array $parameters)

    {

        $defaultActionName = is_array($this->allowedControllerActions[$controllerName]) ? current($this->allowedControllerActions[$controllerName]) : '';

        if (!isset($parameters['action']) || $parameters['action'] === '') {

            if ($defaultActionName === '') {

                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);

            }

            return $defaultActionName;

        }

        $actionName = $parameters['action'];

        $allowedActionNames = $this->allowedControllerActions[$controllerName];

        if (!in_array($actionName, $allowedActionNames)) {

            $configuration = $this->configurationManager->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK);

            if (isset($configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) && (bool)$configuration['mvc']['throwPageNotFoundExceptionIfActionCantBeResolved']) {

                throw new \TYPO3\CMS\Core\Error\Http\PageNotFoundException('The requested resource was not found', 1313857898);

            }

            if (isset($configuration['mvc']['callDefaultActionIfActionCantBeResolved']) && (bool)$configuration['mvc']['callDefaultActionIfActionCantBeResolved']) {

                return $defaultActionName;

            }

            throw new \TYPO3\CMS\Extbase\Mvc\Exception\InvalidActionNameException('The action "' . $actionName . '" (controller "' . $controllerName . '") 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);

        }

        return filter_var($actionName, FILTER_SANITIZE_STRING);

    }


    protected function ‪untangleFilesArray(array $convolutedFiles)

    {

        $untangledFiles = [];

        $fieldPaths = [];

        foreach ($convolutedFiles as $firstLevelFieldName => $fieldInformation) {

            if (!is_array($fieldInformation['error'])) {

                $fieldPaths[] = [$firstLevelFieldName];

            } else {

                $newFieldPaths = $this->‪calculateFieldPaths($fieldInformation['error'], $firstLevelFieldName);

                array_walk($newFieldPaths, function (&$value, $key) {

                    $value = explode('/', $value);

                });

                $fieldPaths = array_merge($fieldPaths, $newFieldPaths);

            }

        }

        foreach ($fieldPaths as $fieldPath) {

            if (count($fieldPath) === 1) {

                $fileInformation = $convolutedFiles[$fieldPath[0]];

            } else {

                $fileInformation = [];

                foreach ($convolutedFiles[$fieldPath[0]] as $key => $subStructure) {

                    try {

                        $fileInformation[$key] = ‪ArrayUtility::getValueByPath($subStructure, array_slice($fieldPath, 1));

                    } catch (MissingArrayPathException $e) {

                        // do nothing if the path is invalid

                    }

                }

            }

            $untangledFiles = ‪ArrayUtility::setValueByPath($untangledFiles, $fieldPath, $fileInformation);

        }

        return $untangledFiles;

    }


    protected function ‪calculateFieldPaths(array $structure, $firstLevelFieldName = null)

    {

        $fieldPaths = [];

        if (is_array($structure)) {

            foreach ($structure as $key => $subStructure) {

                $fieldPath = ($firstLevelFieldName !== null ? $firstLevelFieldName . '/' : '') . $key;

                if (is_array($subStructure)) {

                    foreach ($this->‪calculateFieldPaths($subStructure) as $subFieldPath) {

                        $fieldPaths[] = $fieldPath . '/' . $subFieldPath;

                    }

                } else {

                    $fieldPaths[] = $fieldPath;

                }

            }

        }

        return $fieldPaths;

    }

}