SiteInlineAjaxController::newInlineChildAction() - Code Metrics - Inspection of "[BUGFIX] Set typo3Language for new site languages..." - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0fc833...457bfb )

unknown

created 2020-09-26 11:07 UTC

SiteInlineAjaxController::newInlineChildAction() F

↳ Parent: SiteInlineAjaxController

Complexity

Conditions	16
Paths	324

Size

Total Lines	107
Code Lines	77

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	16
eloc	77
c	1
b	0
f	0
nc	324
nop	1
dl	0
loc	107
rs	3.1833

How to fix Long Method Complexity

<?php

declare(strict_types=1);

/*
 * 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!
 */

namespace TYPO3\CMS\Backend\Controller;

use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use TYPO3\CMS\Backend\Configuration\SiteTcaConfiguration;
use TYPO3\CMS\Backend\Form\FormDataCompiler;
use TYPO3\CMS\Backend\Form\FormDataGroup\SiteConfigurationDataGroup;
use TYPO3\CMS\Backend\Form\InlineStackProcessor;
use TYPO3\CMS\Backend\Form\NodeFactory;
use TYPO3\CMS\Core\Database\ConnectionPool;
use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
use TYPO3\CMS\Core\Http\JsonResponse;
use TYPO3\CMS\Core\Localization\Locales;
use TYPO3\CMS\Core\Utility\ArrayUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\MathUtility;

/**
 * Site configuration FormEngine controller class. Receives inline "edit" and "new"
 * commands to expand / create site configuration inline records
 * @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
 */
class SiteInlineAjaxController extends AbstractFormEngineAjaxController
{
    /**
     * Default constructor
     */
    public function __construct()
    {
        // Bring site TCA into global scope.
        // @todo: We might be able to get rid of that later
        $GLOBALS['TCA'] = array_merge($GLOBALS['TCA'], GeneralUtility::makeInstance(SiteTcaConfiguration::class)->getTca());
    }

    /**
     * Inline "create" new child of site configuration child records
     *
     * @param ServerRequestInterface $request
     * @return ResponseInterface
     * @throws \RuntimeException
     */
    public function newInlineChildAction(ServerRequestInterface $request): ResponseInterface
    {
        $ajaxArguments = $request->getParsedBody()['ajax'] ?? $request->getQueryParams()['ajax'];
        $parentConfig = $this->extractSignedParentConfigFromRequest((string)$ajaxArguments['context']);
        $domObjectId = $ajaxArguments[0];
        $inlineFirstPid = $this->getInlineFirstPidFromDomObjectId($domObjectId);
        $childChildUid = null;
        if (isset($ajaxArguments[1]) && MathUtility::canBeInterpretedAsInteger($ajaxArguments[1])) {
            $childChildUid = (int)$ajaxArguments[1];
        }
        // Parse the DOM identifier, add the levels to the structure stack
        $inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
        $inlineStackProcessor->initializeByParsingDomObjectIdString($domObjectId);
        $inlineStackProcessor->injectAjaxConfiguration($parentConfig);
        $inlineTopMostParent = $inlineStackProcessor->getStructureLevel(0);
        // Parent, this table embeds the child table
        $parent = $inlineStackProcessor->getStructureLevel(-1);
        // Child, a record from this table should be rendered
        $child = $inlineStackProcessor->getUnstableStructure();
        if (MathUtility::canBeInterpretedAsInteger($child['uid'])) {
            // If uid comes in, it is the id of the record neighbor record "create after"
            $childVanillaUid = -1 * abs((int)$child['uid']);
        } else {
            // Else inline first Pid is the storage pid of new inline records
            $childVanillaUid = (int)$inlineFirstPid;
        }
        $childTableName = $parentConfig['foreign_table'];

        $defaultDatabaseRow = [];
        if ($childTableName === 'site_language') {
            // Feed new site_language row with data from sys_language record if possible
            if ($childChildUid > 0) {
                $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_language');
                $queryBuilder->getRestrictions()->removeByType(HiddenRestriction::class);
                $row = $queryBuilder->select('*')->from('sys_language')
                    ->where($queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($childChildUid, \PDO::PARAM_INT)))
                    ->execute()->fetch();
                if (empty($row)) {
                    throw new \RuntimeException('Referenced sys_language row not found', 1521783937);
                }
                if (!empty($row['language_isocode'])) {
                    $defaultDatabaseRow['iso-639-1'] = $row['language_isocode'];
                    $defaultDatabaseRow['base'] = '/' . $row['language_isocode'] . '/';

                    $locales = GeneralUtility::makeInstance(Locales::class);
                    $allLanguages = $locales->getLanguages();
                    if (isset($allLanguages[$row['language_isocode']])) {
                        $defaultDatabaseRow['typo3Language'] = $row['language_isocode'];
                    }
                }
                if (!empty($row['flag']) && $row['flag'] === 'multiple') {
                    $defaultDatabaseRow['flag'] = 'global';
                } elseif (!empty($row)) {
                    $defaultDatabaseRow['flag'] = $row['flag'];
                }
                if (!empty($row['title'])) {
                    $defaultDatabaseRow['title'] = $row['title'];
                }
            }
        }

        $formDataGroup = GeneralUtility::makeInstance(SiteConfigurationDataGroup::class);
        $formDataCompiler = GeneralUtility::makeInstance(FormDataCompiler::class, $formDataGroup);
        $formDataCompilerInput = [
            'command' => 'new',
            'tableName' => $childTableName,
            'vanillaUid' => $childVanillaUid,
            'databaseRow' => $defaultDatabaseRow,
            'isInlineChild' => true,
            'inlineStructure' => $inlineStackProcessor->getStructure(),
            'inlineFirstPid' => $inlineFirstPid,
            'inlineParentUid' => $parent['uid'],
            'inlineParentTableName' => $parent['table'],
            'inlineParentFieldName' => $parent['field'],
            'inlineParentConfig' => $parentConfig,
            'inlineTopMostParentUid' => $inlineTopMostParent['uid'],
            'inlineTopMostParentTableName' => $inlineTopMostParent['table'],
            'inlineTopMostParentFieldName' => $inlineTopMostParent['field'],
        ];
        if ($childChildUid) {
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
            $formDataCompilerInput['inlineChildChildUid'] = $childChildUid;
        }
        $childData = $formDataCompiler->compile($formDataCompilerInput);

        if ($parentConfig['foreign_selector'] && $parentConfig['appearance']['useCombination']) {
            throw new \RuntimeException('useCombination not implemented in sites module', 1522493094);
        }

        $childData['inlineParentUid'] = (int)$parent['uid'];
        $childData['renderType'] = 'inlineRecordContainer';
        $nodeFactory = GeneralUtility::makeInstance(NodeFactory::class);
        $childResult = $nodeFactory->create($childData)->render();

        $jsonArray = [
            'data' => '',
            'stylesheetFiles' => [],
            'scriptCall' => [],
            'compilerInput' => [
                'uid' => $childData['databaseRow']['uid'],
                'childChildUid' => $childChildUid,
                'parentConfig' => $parentConfig,
            ],
        ];

        $jsonArray = $this->mergeChildResultIntoJsonResult($jsonArray, $childResult);

        return new JsonResponse($jsonArray);
    }

    /**
     * Show the details of site configuration child records.
     *
     * @param ServerRequestInterface $request
     * @return ResponseInterface
     * @throws \RuntimeException
     */
    public function openInlineChildAction(ServerRequestInterface $request): ResponseInterface
    {
        $ajaxArguments = $request->getParsedBody()['ajax'] ?? $request->getQueryParams()['ajax'];

        $domObjectId = $ajaxArguments[0];
        $inlineFirstPid = $this->getInlineFirstPidFromDomObjectId($domObjectId);
        $parentConfig = $this->extractSignedParentConfigFromRequest((string)$ajaxArguments['context']);

        // Parse the DOM identifier, add the levels to the structure stack
        $inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
        $inlineStackProcessor->initializeByParsingDomObjectIdString($domObjectId);
        $inlineStackProcessor->injectAjaxConfiguration($parentConfig);

        // Parent, this table embeds the child table
        $parent = $inlineStackProcessor->getStructureLevel(-1);
        $parentFieldName = $parent['field'];

        // Set flag in config so that only the fields are rendered
        // @todo: Solve differently / rename / whatever
        $parentConfig['renderFieldsOnly'] = true;

        $parentData = [
            'processedTca' => [
                'columns' => [
                    $parentFieldName => [
                        'config' => $parentConfig,
                    ],
                ],
            ],
            'tableName' => $parent['table'],
            'inlineFirstPid' => $inlineFirstPid,
            // Hand over given original return url to compile stack. Needed if inline children compile links to
            // another view (eg. edit metadata in a nested inline situation like news with inline content element image),
            // so the back link is still the link from the original request. See issue #82525. This is additionally
            // given down in TcaInline data provider to compiled children data.
            'returnUrl' => $parentConfig['originalReturnUrl'],
        ];

        // Child, a record from this table should be rendered
        $child = $inlineStackProcessor->getUnstableStructure();

        $childData = $this->compileChild($parentData, $parentFieldName, (int)$child['uid'], $inlineStackProcessor->getStructure());

        $childData['inlineParentUid'] = (int)$parent['uid'];
        $childData['renderType'] = 'inlineRecordContainer';
        $nodeFactory = GeneralUtility::makeInstance(NodeFactory::class);
        $childResult = $nodeFactory->create($childData)->render();

        $jsonArray = [
            'data' => '',
            'stylesheetFiles' => [],
            'scriptCall' => [],
        ];

        $jsonArray = $this->mergeChildResultIntoJsonResult($jsonArray, $childResult);

        return new JsonResponse($jsonArray);
    }

    /**
     * Compile a full child record
     *
     * @param array $parentData Result array of parent
     * @param string $parentFieldName Name of parent field
     * @param int $childUid Uid of child to compile
     * @param array $inlineStructure Current inline structure
     * @return array Full result array
     * @throws \RuntimeException
     *
     * @todo: This clones methods compileChild from TcaInline Provider. Find a better abstraction
     * @todo: to also encapsulate the more complex scenarios with combination child and friends.
     */
    protected function compileChild(array $parentData, string $parentFieldName, int $childUid, array $inlineStructure): array
    {
        $parentConfig = $parentData['processedTca']['columns'][$parentFieldName]['config'];

        $inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
        $inlineStackProcessor->initializeByGivenStructure($inlineStructure);
        $inlineTopMostParent = $inlineStackProcessor->getStructureLevel(0);

        // @todo: do not use stack processor here ...
        $child = $inlineStackProcessor->getUnstableStructure();
        $childTableName = $child['table'];

        $formDataGroup = GeneralUtility::makeInstance(SiteConfigurationDataGroup::class);
        $formDataCompiler = GeneralUtility::makeInstance(FormDataCompiler::class, $formDataGroup);
        $formDataCompilerInput = [
            'command' => 'edit',
            'tableName' => $childTableName,
            'vanillaUid' => (int)$childUid,
            'returnUrl' => $parentData['returnUrl'],
            'isInlineChild' => true,
            'inlineStructure' => $inlineStructure,
            'inlineFirstPid' => $parentData['inlineFirstPid'],
            'inlineParentConfig' => $parentConfig,
            'isInlineAjaxOpeningContext' => true,

            // values of the current parent element
            // it is always a string either an id or new...
            'inlineParentUid' => $parentData['databaseRow']['uid'],
            'inlineParentTableName' => $parentData['tableName'],
            'inlineParentFieldName' => $parentFieldName,

            // values of the top most parent element set on first level and not overridden on following levels
            'inlineTopMostParentUid' => $inlineTopMostParent['uid'],
            'inlineTopMostParentTableName' => $inlineTopMostParent['table'],
            'inlineTopMostParentFieldName' => $inlineTopMostParent['field'],
        ];
        if ($parentConfig['foreign_selector'] && $parentConfig['appearance']['useCombination']) {
            throw new \RuntimeException('useCombination not implemented in sites module', 1522493095);
        }
        return $formDataCompiler->compile($formDataCompilerInput);
    }

    /**
     * Merge stuff from child array into json array.
     * This method is needed since ajax handling methods currently need to put scriptCalls before and after child code.
     *
     * @param array $jsonResult Given json result
     * @param array $childResult Given child result
     * @return array Merged json array
     */
    protected function mergeChildResultIntoJsonResult(array $jsonResult, array $childResult): array
    {
        $jsonResult['data'] .= $childResult['html'];
        $jsonResult['stylesheetFiles'] = [];
        foreach ($childResult['stylesheetFiles'] as $stylesheetFile) {
            $jsonResult['stylesheetFiles'][] = $this->getRelativePathToStylesheetFile($stylesheetFile);
        }
        if (!empty($childResult['inlineData'])) {
            $jsonResult['inlineData'] = $childResult['inlineData'];
        }
        foreach ($childResult['additionalJavaScriptPost'] as $singleAdditionalJavaScriptPost) {
            $jsonResult['scriptCall'][] = $singleAdditionalJavaScriptPost;
        }
        if (!empty($childResult['additionalInlineLanguageLabelFiles'])) {
            $labels = [];
            foreach ($childResult['additionalInlineLanguageLabelFiles'] as $additionalInlineLanguageLabelFile) {
                ArrayUtility::mergeRecursiveWithOverrule(
                    $labels,
                    $this->getLabelsFromLocalizationFile($additionalInlineLanguageLabelFile)
                );
            }
            $javaScriptCode = [];
            $javaScriptCode[] = 'if (typeof TYPO3 === \'undefined\' || typeof TYPO3.lang === \'undefined\') {';
            $javaScriptCode[] = '   TYPO3.lang = {}';
            $javaScriptCode[] = '}';
            $javaScriptCode[] = 'var additionalInlineLanguageLabels = ' . json_encode($labels) . ';';
            $javaScriptCode[] = 'for (var attributeName in additionalInlineLanguageLabels) {';
            $javaScriptCode[] = '   if (typeof TYPO3.lang[attributeName] === \'undefined\') {';
            $javaScriptCode[] = '       TYPO3.lang[attributeName] = additionalInlineLanguageLabels[attributeName]';
            $javaScriptCode[] = '   }';
            $javaScriptCode[] = '}';

            $jsonResult['scriptCall'][] = implode(LF, $javaScriptCode);
        }
        $jsonResult['requireJsModules'] = $this->createExecutableStringRepresentationOfRegisteredRequireJsModules($childResult);

        return $jsonResult;
    }

    /**
     * Inline ajax helper method.
     *
     * Validates the config that is transferred over the wire to provide the
     * correct TCA config for the parent table
     *
     * @param string $contextString
     * @throws \RuntimeException
     * @return array
     */
    protected function extractSignedParentConfigFromRequest(string $contextString): array
    {
        if ($contextString === '') {
            throw new \RuntimeException('Empty context string given', 1522771624);
        }
        $context = json_decode($contextString, true);
        if (empty($context['config'])) {
            throw new \RuntimeException('Empty context config section given', 1522771632);
        }
        if (!hash_equals(GeneralUtility::hmac((string)$context['config'], 'InlineContext'), (string)$context['hmac'])) {
            throw new \RuntimeException('Hash does not validate', 1522771640);
        }
        return json_decode($context['config'], true);
    }

    /**
     * Get inlineFirstPid from a given objectId string
     *
     * @param string $domObjectId The id attribute of an element
     * @return int|null Pid or null
     */
    protected function getInlineFirstPidFromDomObjectId(string $domObjectId): ?int
    {
        // Substitute FlexForm addition and make parsing a bit easier
        $domObjectId = str_replace('---', ':', $domObjectId);
        // The starting pattern of an object identifier (e.g. "data-<firstPidValue>-<anything>)
        $pattern = '/^data-(.+?)-(.+)$/';
        if (preg_match($pattern, $domObjectId, $match)) {
            return (int)$match[1];
        }
        return null;
    }
}


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
18			namespace TYPO3\CMS\Backend\Controller;
19
20			use Psr\Http\Message\ResponseInterface;
21			use Psr\Http\Message\ServerRequestInterface;
22			use TYPO3\CMS\Backend\Configuration\SiteTcaConfiguration;
23			use TYPO3\CMS\Backend\Form\FormDataCompiler;
24			use TYPO3\CMS\Backend\Form\FormDataGroup\SiteConfigurationDataGroup;
25			use TYPO3\CMS\Backend\Form\InlineStackProcessor;
26			use TYPO3\CMS\Backend\Form\NodeFactory;
27			use TYPO3\CMS\Core\Database\ConnectionPool;
28			use TYPO3\CMS\Core\Database\Query\Restriction\HiddenRestriction;
29			use TYPO3\CMS\Core\Http\JsonResponse;
30			use TYPO3\CMS\Core\Localization\Locales;
31			use TYPO3\CMS\Core\Utility\ArrayUtility;
32			use TYPO3\CMS\Core\Utility\GeneralUtility;
33			use TYPO3\CMS\Core\Utility\MathUtility;
34
35			/**
36			* Site configuration FormEngine controller class. Receives inline "edit" and "new"
37			* commands to expand / create site configuration inline records
38			* @internal This class is a specific Backend controller implementation and is not considered part of the Public TYPO3 API.
39			*/
40			class SiteInlineAjaxController extends AbstractFormEngineAjaxController
41			{
42			/**
43			* Default constructor
44			*/
45			public function __construct()
46			{
47			// Bring site TCA into global scope.
48			// @todo: We might be able to get rid of that later
49			$GLOBALS['TCA'] = array_merge($GLOBALS['TCA'], GeneralUtility::makeInstance(SiteTcaConfiguration::class)->getTca());
50			}
51
52			/**
53			* Inline "create" new child of site configuration child records
54			*
55			* @param ServerRequestInterface $request
56			* @return ResponseInterface
57			* @throws \RuntimeException
58			*/
59			public function newInlineChildAction(ServerRequestInterface $request): ResponseInterface
60			{
61			$ajaxArguments = $request->getParsedBody()['ajax'] ?? $request->getQueryParams()['ajax'];
62			$parentConfig = $this->extractSignedParentConfigFromRequest((string)$ajaxArguments['context']);
63			$domObjectId = $ajaxArguments[0];
64			$inlineFirstPid = $this->getInlineFirstPidFromDomObjectId($domObjectId);
65			$childChildUid = null;
66			if (isset($ajaxArguments[1]) && MathUtility::canBeInterpretedAsInteger($ajaxArguments[1])) {
67			$childChildUid = (int)$ajaxArguments[1];
68			}
69			// Parse the DOM identifier, add the levels to the structure stack
70			$inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
71			$inlineStackProcessor->initializeByParsingDomObjectIdString($domObjectId);
72			$inlineStackProcessor->injectAjaxConfiguration($parentConfig);
73			$inlineTopMostParent = $inlineStackProcessor->getStructureLevel(0);
74			// Parent, this table embeds the child table
75			$parent = $inlineStackProcessor->getStructureLevel(-1);
76			// Child, a record from this table should be rendered
77			$child = $inlineStackProcessor->getUnstableStructure();
78			if (MathUtility::canBeInterpretedAsInteger($child['uid'])) {
79			// If uid comes in, it is the id of the record neighbor record "create after"
80			$childVanillaUid = -1 * abs((int)$child['uid']);
81			} else {
82			// Else inline first Pid is the storage pid of new inline records
83			$childVanillaUid = (int)$inlineFirstPid;
84			}
85			$childTableName = $parentConfig['foreign_table'];
86
87			$defaultDatabaseRow = [];
88			if ($childTableName === 'site_language') {
89			// Feed new site_language row with data from sys_language record if possible
90			if ($childChildUid > 0) {
91			$queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)->getQueryBuilderForTable('sys_language');
92			$queryBuilder->getRestrictions()->removeByType(HiddenRestriction::class);
93			$row = $queryBuilder->select('*')->from('sys_language')
94			->where($queryBuilder->expr()->eq('uid', $queryBuilder->createNamedParameter($childChildUid, \PDO::PARAM_INT)))
95			->execute()->fetch();
96			if (empty($row)) {
97			throw new \RuntimeException('Referenced sys_language row not found', 1521783937);
98			}
99			if (!empty($row['language_isocode'])) {
100			$defaultDatabaseRow['iso-639-1'] = $row['language_isocode'];
101			$defaultDatabaseRow['base'] = '/' . $row['language_isocode'] . '/';
102
103			$locales = GeneralUtility::makeInstance(Locales::class);
104			$allLanguages = $locales->getLanguages();
105			if (isset($allLanguages[$row['language_isocode']])) {
106			$defaultDatabaseRow['typo3Language'] = $row['language_isocode'];
107			}
108			}
109			if (!empty($row['flag']) && $row['flag'] === 'multiple') {
110			$defaultDatabaseRow['flag'] = 'global';
111			} elseif (!empty($row)) {
112			$defaultDatabaseRow['flag'] = $row['flag'];
113			}
114			if (!empty($row['title'])) {
115			$defaultDatabaseRow['title'] = $row['title'];
116			}
117			}
118			}
119
120			$formDataGroup = GeneralUtility::makeInstance(SiteConfigurationDataGroup::class);
121			$formDataCompiler = GeneralUtility::makeInstance(FormDataCompiler::class, $formDataGroup);
122			$formDataCompilerInput = [
123			'command' => 'new',
124			'tableName' => $childTableName,
125			'vanillaUid' => $childVanillaUid,
126			'databaseRow' => $defaultDatabaseRow,
127			'isInlineChild' => true,
128			'inlineStructure' => $inlineStackProcessor->getStructure(),
129			'inlineFirstPid' => $inlineFirstPid,
130			'inlineParentUid' => $parent['uid'],
131			'inlineParentTableName' => $parent['table'],
132			'inlineParentFieldName' => $parent['field'],
133			'inlineParentConfig' => $parentConfig,
134			'inlineTopMostParentUid' => $inlineTopMostParent['uid'],
135			'inlineTopMostParentTableName' => $inlineTopMostParent['table'],
136			'inlineTopMostParentFieldName' => $inlineTopMostParent['field'],
137			];
138			if ($childChildUid) {
			0 ignored issues – show Bug Best Practice introduced 2018-10-20 09:04 UTC by Report Bug Copy Issue Report The expression `$childChildUid` of type `integer\|null` is loosely compared to `true`; this is ambiguous if the integer can be 0. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `integer` values, zero is a special case, in particular the following results might be unexpected: 0 == false // true 0 == null // true 123 == false // false 123 == null // false // It is often better to use strict comparison 0 === false // false 0 === null // false Loading history...
139			$formDataCompilerInput['inlineChildChildUid'] = $childChildUid;
140			}
141			$childData = $formDataCompiler->compile($formDataCompilerInput);
142
143			if ($parentConfig['foreign_selector'] && $parentConfig['appearance']['useCombination']) {
144			throw new \RuntimeException('useCombination not implemented in sites module', 1522493094);
145			}
146
147			$childData['inlineParentUid'] = (int)$parent['uid'];
148			$childData['renderType'] = 'inlineRecordContainer';
149			$nodeFactory = GeneralUtility::makeInstance(NodeFactory::class);
150			$childResult = $nodeFactory->create($childData)->render();
151
152			$jsonArray = [
153			'data' => '',
154			'stylesheetFiles' => [],
155			'scriptCall' => [],
156			'compilerInput' => [
157			'uid' => $childData['databaseRow']['uid'],
158			'childChildUid' => $childChildUid,
159			'parentConfig' => $parentConfig,
160			],
161			];
162
163			$jsonArray = $this->mergeChildResultIntoJsonResult($jsonArray, $childResult);
164
165			return new JsonResponse($jsonArray);
166			}
167
168			/**
169			* Show the details of site configuration child records.
170			*
171			* @param ServerRequestInterface $request
172			* @return ResponseInterface
173			* @throws \RuntimeException
174			*/
175			public function openInlineChildAction(ServerRequestInterface $request): ResponseInterface
176			{
177			$ajaxArguments = $request->getParsedBody()['ajax'] ?? $request->getQueryParams()['ajax'];
178
179			$domObjectId = $ajaxArguments[0];
180			$inlineFirstPid = $this->getInlineFirstPidFromDomObjectId($domObjectId);
181			$parentConfig = $this->extractSignedParentConfigFromRequest((string)$ajaxArguments['context']);
182
183			// Parse the DOM identifier, add the levels to the structure stack
184			$inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
185			$inlineStackProcessor->initializeByParsingDomObjectIdString($domObjectId);
186			$inlineStackProcessor->injectAjaxConfiguration($parentConfig);
187
188			// Parent, this table embeds the child table
189			$parent = $inlineStackProcessor->getStructureLevel(-1);
190			$parentFieldName = $parent['field'];
191
192			// Set flag in config so that only the fields are rendered
193			// @todo: Solve differently / rename / whatever
194			$parentConfig['renderFieldsOnly'] = true;
195
196			$parentData = [
197			'processedTca' => [
198			'columns' => [
199			$parentFieldName => [
200			'config' => $parentConfig,
201			],
202			],
203			],
204			'tableName' => $parent['table'],
205			'inlineFirstPid' => $inlineFirstPid,
206			// Hand over given original return url to compile stack. Needed if inline children compile links to
207			// another view (eg. edit metadata in a nested inline situation like news with inline content element image),
208			// so the back link is still the link from the original request. See issue #82525. This is additionally
209			// given down in TcaInline data provider to compiled children data.
210			'returnUrl' => $parentConfig['originalReturnUrl'],
211			];
212
213			// Child, a record from this table should be rendered
214			$child = $inlineStackProcessor->getUnstableStructure();
215
216			$childData = $this->compileChild($parentData, $parentFieldName, (int)$child['uid'], $inlineStackProcessor->getStructure());
217
218			$childData['inlineParentUid'] = (int)$parent['uid'];
219			$childData['renderType'] = 'inlineRecordContainer';
220			$nodeFactory = GeneralUtility::makeInstance(NodeFactory::class);
221			$childResult = $nodeFactory->create($childData)->render();
222
223			$jsonArray = [
224			'data' => '',
225			'stylesheetFiles' => [],
226			'scriptCall' => [],
227			];
228
229			$jsonArray = $this->mergeChildResultIntoJsonResult($jsonArray, $childResult);
230
231			return new JsonResponse($jsonArray);
232			}
233
234			/**
235			* Compile a full child record
236			*
237			* @param array $parentData Result array of parent
238			* @param string $parentFieldName Name of parent field
239			* @param int $childUid Uid of child to compile
240			* @param array $inlineStructure Current inline structure
241			* @return array Full result array
242			* @throws \RuntimeException
243			*
244			* @todo: This clones methods compileChild from TcaInline Provider. Find a better abstraction
245			* @todo: to also encapsulate the more complex scenarios with combination child and friends.
246			*/
247			protected function compileChild(array $parentData, string $parentFieldName, int $childUid, array $inlineStructure): array
248			{
249			$parentConfig = $parentData['processedTca']['columns'][$parentFieldName]['config'];
250
251			$inlineStackProcessor = GeneralUtility::makeInstance(InlineStackProcessor::class);
252			$inlineStackProcessor->initializeByGivenStructure($inlineStructure);
253			$inlineTopMostParent = $inlineStackProcessor->getStructureLevel(0);
254
255			// @todo: do not use stack processor here ...
256			$child = $inlineStackProcessor->getUnstableStructure();
257			$childTableName = $child['table'];
258
259			$formDataGroup = GeneralUtility::makeInstance(SiteConfigurationDataGroup::class);
260			$formDataCompiler = GeneralUtility::makeInstance(FormDataCompiler::class, $formDataGroup);
261			$formDataCompilerInput = [
262			'command' => 'edit',
263			'tableName' => $childTableName,
264			'vanillaUid' => (int)$childUid,
265			'returnUrl' => $parentData['returnUrl'],
266			'isInlineChild' => true,
267			'inlineStructure' => $inlineStructure,
268			'inlineFirstPid' => $parentData['inlineFirstPid'],
269			'inlineParentConfig' => $parentConfig,
270			'isInlineAjaxOpeningContext' => true,
271
272			// values of the current parent element
273			// it is always a string either an id or new...
274			'inlineParentUid' => $parentData['databaseRow']['uid'],
275			'inlineParentTableName' => $parentData['tableName'],
276			'inlineParentFieldName' => $parentFieldName,
277
278			// values of the top most parent element set on first level and not overridden on following levels
279			'inlineTopMostParentUid' => $inlineTopMostParent['uid'],
280			'inlineTopMostParentTableName' => $inlineTopMostParent['table'],
281			'inlineTopMostParentFieldName' => $inlineTopMostParent['field'],
282			];
283			if ($parentConfig['foreign_selector'] && $parentConfig['appearance']['useCombination']) {
284			throw new \RuntimeException('useCombination not implemented in sites module', 1522493095);
285			}
286			return $formDataCompiler->compile($formDataCompilerInput);
287			}
288
289			/**
290			* Merge stuff from child array into json array.
291			* This method is needed since ajax handling methods currently need to put scriptCalls before and after child code.
292			*
293			* @param array $jsonResult Given json result
294			* @param array $childResult Given child result
295			* @return array Merged json array
296			*/
297			protected function mergeChildResultIntoJsonResult(array $jsonResult, array $childResult): array
298			{
299			$jsonResult['data'] .= $childResult['html'];
300			$jsonResult['stylesheetFiles'] = [];
301			foreach ($childResult['stylesheetFiles'] as $stylesheetFile) {
302			$jsonResult['stylesheetFiles'][] = $this->getRelativePathToStylesheetFile($stylesheetFile);
303			}
304			if (!empty($childResult['inlineData'])) {
305			$jsonResult['inlineData'] = $childResult['inlineData'];
306			}
307			foreach ($childResult['additionalJavaScriptPost'] as $singleAdditionalJavaScriptPost) {
308			$jsonResult['scriptCall'][] = $singleAdditionalJavaScriptPost;
309			}
310			if (!empty($childResult['additionalInlineLanguageLabelFiles'])) {
311			$labels = [];
312			foreach ($childResult['additionalInlineLanguageLabelFiles'] as $additionalInlineLanguageLabelFile) {
313			ArrayUtility::mergeRecursiveWithOverrule(
314			$labels,
315			$this->getLabelsFromLocalizationFile($additionalInlineLanguageLabelFile)
316			);
317			}
318			$javaScriptCode = [];
319			$javaScriptCode[] = 'if (typeof TYPO3 === \'undefined\' \|\| typeof TYPO3.lang === \'undefined\') {';
320			$javaScriptCode[] = ' TYPO3.lang = {}';
321			$javaScriptCode[] = '}';
322			$javaScriptCode[] = 'var additionalInlineLanguageLabels = ' . json_encode($labels) . ';';
323			$javaScriptCode[] = 'for (var attributeName in additionalInlineLanguageLabels) {';
324			$javaScriptCode[] = ' if (typeof TYPO3.lang[attributeName] === \'undefined\') {';
325			$javaScriptCode[] = ' TYPO3.lang[attributeName] = additionalInlineLanguageLabels[attributeName]';
326			$javaScriptCode[] = ' }';
327			$javaScriptCode[] = '}';
328
329			$jsonResult['scriptCall'][] = implode(LF, $javaScriptCode);
330			}
331			$jsonResult['requireJsModules'] = $this->createExecutableStringRepresentationOfRegisteredRequireJsModules($childResult);
332
333			return $jsonResult;
334			}
335
336			/**
337			* Inline ajax helper method.
338			*
339			* Validates the config that is transferred over the wire to provide the
340			* correct TCA config for the parent table
341			*
342			* @param string $contextString
343			* @throws \RuntimeException
344			* @return array
345			*/
346			protected function extractSignedParentConfigFromRequest(string $contextString): array
347			{
348			if ($contextString === '') {
349			throw new \RuntimeException('Empty context string given', 1522771624);
350			}
351			$context = json_decode($contextString, true);
352			if (empty($context['config'])) {
353			throw new \RuntimeException('Empty context config section given', 1522771632);
354			}
355			if (!hash_equals(GeneralUtility::hmac((string)$context['config'], 'InlineContext'), (string)$context['hmac'])) {
356			throw new \RuntimeException('Hash does not validate', 1522771640);
357			}
358			return json_decode($context['config'], true);
359			}
360
361			/**
362			* Get inlineFirstPid from a given objectId string
363			*
364			* @param string $domObjectId The id attribute of an element
365			* @return int\|null Pid or null
366			*/
367			protected function getInlineFirstPidFromDomObjectId(string $domObjectId): ?int
368			{
369			// Substitute FlexForm addition and make parsing a bit easier
370			$domObjectId = str_replace('---', ':', $domObjectId);
371			// The starting pattern of an object identifier (e.g. "data-<firstPidValue>-<anything>)
372			$pattern = '/^data-(.+?)-(.+)$/';
373			if (preg_match($pattern, $domObjectId, $match)) {
374			return (int)$match[1];
375			}
376			return null;
377			}
378			}
379

TYPO3 / TYPO3.CMS

Push — master ( 0fc833...457bfb )

SiteInlineAjaxController::newInlineChildAction() F

Complexity

Size

Duplication

Importance

How to fix Long Method Complexity

Long Method

Duplication Side-by-Side

Filter issues like