12950840821

Committed 24 Jan 2025 01:44PM UTC coverage: 93.248% (-0.2%) from 93.413%

Build # 12950840821

Build Type

Pull #2221

github

Committed by

web-flow

Commit Message

Merge 2c7a7e910 into e91a963b7

Pull Request Pull Request #2221: [FEATURE] Apply preview modes to page previews

Coverage Stats

30 of 44 new or added lines in 5 files covered. (68.18%)

7071 of 7583 relevant lines covered (93.25%)

65.89 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

83.75

/Classes/Provider/PageProvider.php

<?php
declare(strict_types=1);
namespace FluidTYPO3\Flux\Provider;

/*
 * This file is part of the FluidTYPO3/Flux project under GPLv2 or later.
 *
 * For the full copyright and license information, please read the
 * LICENSE.md file that was distributed with this source code.
 */

use FluidTYPO3\Flux\Builder\ViewBuilder;
use FluidTYPO3\Flux\Enum\ExtensionOption;
use FluidTYPO3\Flux\Enum\FormOption;
use FluidTYPO3\Flux\Enum\PreviewOption;
use FluidTYPO3\Flux\Form;
use FluidTYPO3\Flux\Form\Transformation\FormDataTransformer;
use FluidTYPO3\Flux\Service\CacheService;
use FluidTYPO3\Flux\Service\PageService;
use FluidTYPO3\Flux\Service\TypoScriptService;
use FluidTYPO3\Flux\Service\WorkspacesAwareRecordService;
use FluidTYPO3\Flux\Utility\ExtensionConfigurationUtility;
use FluidTYPO3\Flux\Utility\ExtensionNamingUtility;
use FluidTYPO3\Flux\Utility\MiscellaneousUtility;
use FluidTYPO3\Flux\Utility\RecursiveArrayUtility;
use TYPO3\CMS\Core\DataHandling\DataHandler;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Core\Utility\RootlineUtility;
use TYPO3\CMS\Extbase\Reflection\ObjectAccess;

/**
 * Page Configuration Provider
 *
 * Main Provider - triggers only on
 * records which have a selected action.
 * All other page records will be associated
 * with the SubPageProvider instead.
 */
class PageProvider extends AbstractProvider implements ProviderInterface
{
    const FIELD_NAME_MAIN = 'tx_fed_page_flexform';
    const FIELD_NAME_SUB = 'tx_fed_page_flexform_sub';
    const FIELD_ACTION_MAIN = 'tx_fed_page_controller_action';
    const FIELD_ACTION_SUB = 'tx_fed_page_controller_action_sub';

    protected ?string $tableName = 'pages';
    protected ?string $parentFieldName = 'pid';
    protected ?string $fieldName = self::FIELD_NAME_MAIN;
    protected string $extensionKey = 'FluidTYPO3.Flux';
    protected ?string $controllerName = 'Page';
    protected ?string $configurationSectionName = 'Configuration';
    protected ?string $pluginName = 'Page';

    private static array $cache = [];

    protected PageService $pageService;

    public function __construct(
        FormDataTransformer $formDataTransformer,
        WorkspacesAwareRecordService $recordService,
        ViewBuilder $viewBuilder,
        CacheService $cacheService,
        TypoScriptService $typoScriptService,
        PageService $pageService
    ) {
        parent::__construct($formDataTransformer, $recordService, $viewBuilder, $cacheService, $typoScriptService);
        $this->pageService = $pageService;
    }

    /**
     * Returns TRUE that this Provider should trigger if:
     *
     * - table matches 'pages'
     * - field is NULL or matches self::FIELD_NAME
     * - a selection was made in the "template for this page" field
     */
    public function trigger(array $row, ?string $table, ?string $field, ?string $extensionKey = null): bool
    {
        $isRightTable = ($table === $this->tableName);
        $isRightField = in_array($field, [null, self::FIELD_NAME_MAIN, self::FIELD_NAME_SUB], true);
        return (true === $isRightTable && true === $isRightField);
    }

    public function getForm(array $row, ?string $forField = null): ?Form
    {
        if ($row['deleted'] ?? false) {
            return null;
        }

        // If field is main field and "this page" has no selection or field is sub field and "subpages" has no selection
        if (($forField === self::FIELD_NAME_MAIN && empty($row[self::FIELD_ACTION_MAIN]))
            || ($forField === self::FIELD_NAME_SUB && empty($row[self::FIELD_ACTION_SUB]))
        ) {
            // The page inherits page layout from parent(s). Read the root line for the first page that defines a value
            // in the sub-action field, then use that record and resolve the Form used in the sub-configuration field.
            // If the row is a new page, use the inherited form from the parent page.
            $pageUid = $row['uid'] ?? 0;
            $pageUidIsParent = false;
            if (is_string($pageUid) && substr($pageUid, 0, 3) === 'NEW') {
                $pageUid = $row['pid'] ?? 0;
                $pageUidIsParent = true;
            }

            $pageTemplateConfiguration = $this->pageService->getPageTemplateConfiguration(
                (integer) $pageUid,
                $pageUidIsParent
            );

            $form = parent::getForm($pageTemplateConfiguration['record_sub'] ?? $row, self::FIELD_NAME_SUB);
        } else {
            $form = parent::getForm($row, $forField);
        }

        return $form;
    }

    public function getExtensionKey(array $row, ?string $forField = null): string
    {
        $controllerExtensionKey = $this->getControllerExtensionKeyFromRecord($row, $forField);
        if (!empty($controllerExtensionKey)) {
            return ExtensionNamingUtility::getExtensionKey($controllerExtensionKey);
        }
        return $this->extensionKey;
    }

    public function getTemplatePathAndFilename(array $row, ?string $forField = null): ?string
    {
        $templatePathAndFilename = $this->templatePathAndFilename;
        $action = $this->getControllerActionFromRecord($row, $forField);
        if (!empty($action)) {
            $pathsOrExtensionKey = $this->templatePaths
                ?? ExtensionNamingUtility::getExtensionKey($this->getControllerExtensionKeyFromRecord($row, $forField));
            $templatePaths = $this->createTemplatePaths($pathsOrExtensionKey);
            $action = ucfirst($action);
            $templatePathAndFilename = $templatePaths->resolveTemplateFileForControllerAndActionAndFormat(
                $this->getControllerNameFromRecord($row),
                $action
            );
        }
        return $templatePathAndFilename;
    }

    public function getControllerExtensionKeyFromRecord(array $row, ?string $forField = null): string
    {
        $action = $this->getControllerActionReferenceFromRecord($row, $forField);
        $offset = strpos($action, '->');
        if ($offset !== false) {
            return substr($action, 0, $offset);
        }
        return $this->extensionKey;
    }

    public function getControllerActionFromRecord(array $row, ?string $forField = null): string
    {
        $action = $this->getControllerActionReferenceFromRecord($row, $forField);
        $parts = explode('->', $action);
        $controllerActionName = end($parts);
        if (empty($controllerActionName)) {
            return 'default';
        }
        $controllerActionName[0] = strtolower($controllerActionName[0]);
        return $controllerActionName;
    }

    public function getControllerActionReferenceFromRecord(array $row, ?string $forField = null): string
    {
        if (($forField === self::FIELD_NAME_MAIN || $forField === null) && !empty($row[self::FIELD_ACTION_MAIN])) {
            return is_array($row[self::FIELD_ACTION_MAIN])
                ? $row[self::FIELD_ACTION_MAIN][0]
                : $row[self::FIELD_ACTION_MAIN];
        } elseif ($forField === self::FIELD_NAME_SUB && !empty($row[self::FIELD_ACTION_SUB])) {
            return is_array($row[self::FIELD_ACTION_SUB])
                ? $row[self::FIELD_ACTION_SUB][0]
                : $row[self::FIELD_ACTION_SUB];
        }
        if (isset($row['uid'])) {
            $configuration = $this->pageService->getPageTemplateConfiguration((integer) $row['uid']);
            $fieldName = self::FIELD_ACTION_SUB;
            if ($forField === self::FIELD_NAME_MAIN) {
                $fieldName = self::FIELD_ACTION_MAIN;
            }
            return ($configuration[$fieldName] ?? 'flux->default') ?: 'flux->default';
        }
        return 'flux->default';
    }

    public function getFlexFormValues(array $row, ?string $forField = null): array
    {
        $immediateConfiguration = $this->getFlexFormValuesSingle($row);
        $inheritedConfiguration = $this->getInheritedConfiguration($row);
        return RecursiveArrayUtility::merge($inheritedConfiguration, $immediateConfiguration);
    }

    public function getFlexFormValuesSingle(array $row, ?string $forField = null): array
    {
        $fieldName = $forField ?? $this->getFieldName($row);
        $form = $this->getForm($row, $forField);
        $immediateConfiguration = $this->formDataTransformer->convertFlexFormContentToArray(
            $row[$fieldName] ?? '',
            $form,
            null,
            null
        );
        return $immediateConfiguration;
    }

    public function postProcessRecord(
        string $operation,
        int $id,
        array $row,
        DataHandler $reference,
        array $removals = []
    ): bool {
        if ($operation === 'update') {
            $stored = $this->recordService->getSingle((string) $this->getTableName($row), '*', $id);
            if (!$stored) {
                return false;
            }
            $before = $stored;
            $tableName = $this->getTableName($stored);

            $record = RecursiveArrayUtility::mergeRecursiveOverrule(
                $stored,
                $reference->datamap[$this->tableName][$id] ?? []
            );

            foreach ([self::FIELD_NAME_MAIN, self::FIELD_NAME_SUB] as $tableFieldName) {
                $form = $this->getForm($record, $tableFieldName);
                if (!$form) {
                    continue;
                }

                $removeForField = [];
                $protected = array_flip($this->extractFieldNamesToProtect($record, $tableFieldName));
                foreach ($form->getFields() as $field) {
                    /** @var Form\Container\Sheet $parent */
                    $parent = $field->getParent();
                    $fieldName = (string) $field->getName();
                    $sheetName = (string) $parent->getName();
                    $inherit = (boolean) $field->getInherit();
                    $inheritEmpty = (boolean) $field->getInheritEmpty();
                    if (is_array($record[$tableFieldName]['data'] ?? null)) {
                        $value = $record[$tableFieldName]['data'][$sheetName]['lDEF'][$fieldName]['vDEF'] ?? null;
                        $inheritedConfiguration = $this->getInheritedConfiguration($record);
                        if (!isset($inheritedConfiguration[$fieldName])) {
                            continue;
                        }
                        $inheritedValue = $this->getInheritedPropertyValueByDottedPath(
                            $inheritedConfiguration,
                            $fieldName
                        );
                        $empty = (true === empty($value) && $value !== '0' && $value !== 0);
                        $same = ($inheritedValue === $value);
                        $protected = (bool) ($protected[$fieldName] ?? false);
                        if (!$protected && ($same && $inherit || ($inheritEmpty && $empty))) {
                            $removeForField[] = $fieldName;
                        }
                    }
                }
                $removeForField = array_merge(
                    $removeForField,
                    $this->extractFieldNamesToClear($record, $tableFieldName)
                );
                $removeForField = array_unique($removeForField);

                if (!empty($stored[$tableFieldName])) {
                    $stored[$tableFieldName] = MiscellaneousUtility::cleanFlexFormXml(
                        $stored[$tableFieldName],
                        $removeForField
                    );
                }
            }

            if ($before !== $stored) {
                $this->recordService->update((string) $tableName, $stored);
            }
        }

        return false;
    }

    public function processTableConfiguration(array $row, array $configuration): array
    {
        $currentPageRecord = $this->recordService->getSingle(
            (string) $this->getTableName($row),
            'uid,' . self::FIELD_NAME_MAIN . ',' . self::FIELD_NAME_SUB,
            $configuration['vanillaUid']
        );
        if (!$currentPageRecord) {
            return $configuration;
        }

        $tree = array_reverse($this->getInheritanceTree($currentPageRecord), true);

        $inheritedConfiguration = [];

        if (!empty($currentPageRecord[self::FIELD_NAME_SUB])) {
            $currentPageRecord[self::FIELD_NAME_SUB] = $this->convertXmlToArray(
                $currentPageRecord[self::FIELD_NAME_SUB]
            ) ?? [];
        }
        /** @var Form&Form $form */
        $form = $this->getForm($row, self::FIELD_NAME_SUB);
        foreach ($tree as $branch) {
            if (!empty($branch[self::FIELD_NAME_SUB])) {
                $branchData = $this->convertXmlToArray($branch[self::FIELD_NAME_SUB] ?? '') ?? [];
                $inheritedConfiguration = RecursiveArrayUtility::mergeRecursiveOverrule(
                    $inheritedConfiguration,
                    $branchData
                );
            }
        }

        $inheritedConfigurationForFields = [];
        foreach ([self::FIELD_NAME_MAIN, self::FIELD_NAME_SUB] as $field) {
            $inheritedConfigurationForFields[$field] = $inheritedConfiguration;
            $dataMirror = ['data' => []];
            $this->extractDataStorageMirrorWithInheritableFields($form, $dataMirror['data']);
            $this->unsetUninheritableFieldsInInheritedConfiguration(
                $inheritedConfigurationForFields[$field],
                $currentPageRecord[self::FIELD_NAME_MAIN],
                $dataMirror
            );
        }

        if (!empty($configuration['databaseRow'][self::FIELD_NAME_MAIN])) {
            if (is_array($configuration['databaseRow'][self::FIELD_NAME_MAIN])) {
                $currentData = $configuration['databaseRow'][self::FIELD_NAME_MAIN];
            } else {
                $currentData = $this->convertXmlToArray($configuration['databaseRow'][self::FIELD_NAME_MAIN]) ?? [];
            }
            $configuration['databaseRow'][self::FIELD_NAME_MAIN] = RecursiveArrayUtility::mergeRecursiveOverrule(
                $inheritedConfigurationForFields[self::FIELD_NAME_MAIN],
                $currentData,
                false,
                true
            );
        }

        if (is_array($configuration['databaseRow'][self::FIELD_NAME_SUB])) {
            $subData = $configuration['databaseRow'][self::FIELD_NAME_SUB];
        } else {
            $subData = $this->convertXmlToArray($configuration['databaseRow'][self::FIELD_NAME_SUB]) ?? [];
        }

        $configuration['databaseRow'][self::FIELD_NAME_SUB] = RecursiveArrayUtility::mergeRecursiveOverrule(
            $inheritedConfigurationForFields[self::FIELD_NAME_SUB],
            $subData
        );

        return parent::processTableConfiguration($row, $configuration);
    }

    public function getPreview(array $row): array
    {
        $previewContent = $this->viewBuilder->buildPreviewView(
            $this->getControllerExtensionKeyFromRecord($row),
            $this->getControllerNameFromRecord($row),
            $this->getControllerActionFromRecord($row),
            $this->getPluginName() ?? $this->getControllerNameFromRecord($row),
            $this->getTemplatePathAndFilename($row)
        )->getPreview($this, $row, true);
        return [null, $previewContent, empty($previewContent)];
    }

    /**
     * @param array|string|null $immediateConfiguration
     */
    private function unsetUninheritableFieldsInInheritedConfiguration(
        array &$inheritedConfiguration,
        &$immediateConfiguration,
        array &$dataMirror
    ): void {
        foreach ($inheritedConfiguration as $key => &$value) {
            if (!is_array($value)) {
                continue;
            }

            $inheritedValueIsSection = $this->checkIsSection($inheritedConfiguration[$key] ?? []);
            if (!isset($dataMirror[$key]) && !$inheritedValueIsSection) {
                unset($inheritedConfiguration[$key]);
                continue;
            }
            $dataMirrorItem = &$dataMirror[$key];
            if ($dataMirrorItem instanceof Form\FieldInterface && !$dataMirrorItem->getInherit()) {
                unset($inheritedConfiguration[$key]);
                continue;
            }
            $immediateConfigurationIsArray = is_array($immediateConfiguration);
            $immediateSubConfiguration = $immediateConfigurationIsArray ? $immediateConfiguration[$key] ?? null : null;
            if ($immediateConfigurationIsArray
                && is_array($immediateSubConfiguration)
                && $inheritedValueIsSection
                && $this->checkIsSection($immediateConfiguration[$key])
            ) {
                // Immediate configuration is a section, and it has items. Do not allow inheritance.
                unset($inheritedConfiguration[$key]);
                continue;
            } elseif ($inheritedValueIsSection) {
                // Do not further process an inherited section - inheritance is desired.
                continue;
            }
            $this->unsetUninheritableFieldsInInheritedConfiguration(
                $inheritedConfiguration[$key],
                $immediateSubConfiguration,
                $dataMirrorItem,
            );
        }
    }

    private function checkIsSection(array $data): bool
    {
        // Determine if we are working on a section object. If so, the inherited configuration will contain an extra
        // dimension; an alpha-numeric unique key 22 chars in length. We can identify if that is the case by
        // checking that every array key is exactly 22 chars and every element contains a "_TOGGLE" key.
        $numberOfValues = count($data);
        return $numberOfValues > 0
            && strlen(implode('', array_keys($data))) === ($numberOfValues * 22)
            && count(array_column($data, '_TOGGLE')) === $numberOfValues;
    }

    private function extractDataStorageMirrorWithInheritableFields(
        Form\FieldContainerInterface $container,
        array &$parentArrayPosition
    ): void {
        if (!$container->getInherit()) {
            return;
        }
        foreach ($container->getChildren() as $child) {
            if (!$child->getInherit()) {
                continue;
            }
            $childName = $child->getName();
            if ($child instanceof Form\Container\Section) {
                foreach ($child->getChildren() as $sectionObject) {
                    /** @var Form\Container\SectionObject $sectionObject */
                    $sectionObjectName = $sectionObject->getName();
                    $parentArrayPosition['lDEF'][$childName]['el'][$sectionObjectName]['el'] = [];
                    $position = &$parentArrayPosition['lDEF'][$childName]['el'][$sectionObjectName]['el'];
                    foreach ($sectionObject->getChildren() as $field) {
                        $position[$field->getName()] = $field;
                    }
                }
            } elseif (!$child instanceof Form\FieldContainerInterface) {
                $parentArrayPosition['lDEF'][$childName]['vDEF'] = $child;
            } else {
                $parentArrayPosition[$childName] = [];
                $this->extractDataStorageMirrorWithInheritableFields($child, $parentArrayPosition[$childName]);
            }
        }
    }

    /**
     * @codeCoverageIgnore
     */
    protected function convertXmlToArray(string $xml): ?array
    {
        /** @var string|array $converted */
        $converted = GeneralUtility::xml2array($xml);
        return is_string($converted) ? null : $converted;
    }

    /**
     * Gets an inheritance tree (ordered first parent -> ... -> root record)
     * of record arrays containing raw values, stopping at the first parent
     * record that defines a page layout to use in "page layout - subpages".
     */
    protected function getInheritanceTree(array $row): array
    {
        $previousTemplate = $row[self::FIELD_ACTION_MAIN] ?? null;
        $configuredInheritance = ExtensionConfigurationUtility::getOption(ExtensionOption::OPTION_INHERITANCE_MODE);

        $form = $this->getForm($row);

        $defaultInheritanceMode = ($form ? $form->getOption(FormOption::INHERITANCE_MODE) : $configuredInheritance)
            ?? $configuredInheritance;

        $records = $this->loadRecordTreeFromDatabase($row);
        foreach ($records as $index => $record) {
            $childForm = $this->getForm($record);
            $subAction = $record[self::FIELD_ACTION_SUB] ?? null;
            $hasSubAction = !empty($subAction);

            if ($childForm) {
                $inheritanceMode = $childForm->getOption(FormOption::INHERITANCE_MODE) ?? $defaultInheritanceMode;
            } else {
                $inheritanceMode = $defaultInheritanceMode;
            }

            if ($inheritanceMode === 'restricted'
                && $hasSubAction
                && ($subAction ?? $previousTemplate) !== $previousTemplate
            ) {
                return array_slice($records, 0, $index + 1);
            }
            $previousTemplate = $subAction ?? $previousTemplate;
        }
        return $records;
    }

    protected function getInheritedConfiguration(array $row): array
    {
        $tableName = $this->getTableName($row);
        $tableFieldName = $this->getFieldName($row);
        $uid = $row['uid'] ?? '';
        $cacheKey = $tableName . $tableFieldName . $uid;
        if (false === isset(self::$cache[$cacheKey])) {
            $tree = array_reverse($this->getInheritanceTree($row), true);
            $data = [];
            foreach ($tree as $branch) {
                $values = $this->getFlexFormValuesSingle($branch, self::FIELD_NAME_SUB);
                $data = RecursiveArrayUtility::mergeRecursiveOverrule($data, $values, false, true);
            }
            self::$cache[$cacheKey] = $data;
        }
        return self::$cache[$cacheKey];
    }

    /**
     * @return mixed
     */
    protected function getInheritedPropertyValueByDottedPath(array $inheritedConfiguration, string $propertyPath)
    {
        if (true === empty($propertyPath)) {
            return null;
        } elseif (false === strpos($propertyPath, '.')) {
            if (isset($inheritedConfiguration[$propertyPath])) {
                return ObjectAccess::getProperty($inheritedConfiguration, $propertyPath);
            }
            return null;
        }
        return ObjectAccess::getPropertyPath($inheritedConfiguration, $propertyPath);
    }

    protected function unsetInheritedValues(Form\FormInterface $field, array $values): array
    {
        $name = $field->getName();
        $inherit = $field->getInherit();
        $inheritEmpty = $field->getInheritEmpty();
        $value = $values[$name] ?? null;
        $empty = empty($value) && !in_array($value, [0, '0'], true);
        if (!$inherit || ($inheritEmpty && $empty)) {
            unset($values[$name]);
        }
        return $values;
    }

    protected function loadRecordTreeFromDatabase(array $record): array
    {
        if (empty($record)) {
            return [];
        }
        /** @var RootlineUtility $rootLineUtility */
        $rootLineUtility = GeneralUtility::makeInstance(RootlineUtility::class, (integer) ($record['uid'] ?? 0));
        return array_slice($rootLineUtility->get(), 1);
    }
}

FluidTYPO3 / flux / 12950840821

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous