CreatableFormElementPropertiesValidator.php

Go to the documentation of this file.

<?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\Form\Domain\Configuration\FormDefinition\Validators;
 
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Form\Domain\Configuration\Exception\PropertyException;
 
class ‪CreatableFormElementPropertiesValidator extends ‪ElementBasedValidator
{
    public function ‪__invoke(string $key, $value)
    {
        $dto = $this->validationDto->withPropertyPath($key);
 
        if ($this->‪getConfigurationService()->isFormElementPropertyDefinedInFormEditorSetup($dto)) {
            if ($this->‪getConfigurationService()->formElementPropertyHasLimitedAllowedValuesDefinedWithinFormEditorSetup($dto)) {
                $this->‪validateFormElementValue($value, $dto);
            }
        } elseif (
            $this->‪getConfigurationService()->isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup($dto)
            && !‪ArrayUtility::isValidPath($this->currentElement, $this->‪buildHmacDataPath($dto->getPropertyPath()), '.')
        ) {
            $this->‪validateFormElementPredefinedDefaultValue($value, $dto);
        } else {
            $this->‪validateFormElementPropertyValueByHmacData(
                $this->currentElement,
                $value,
                $this->sessionToken,
                $dto
            );
        }
    }
 
    protected function ‪validateFormElementPredefinedDefaultValue(
        $value,
        ‪ValidationDto $dto
    ): void {
        // If the form element is newly created, we have to compare the $value (form definition) with $predefinedDefaultValue (form setup)
        // to check the integrity (at this time we don't have a hmac for the $value to check the integrity)
        $predefinedDefaultValue = $this->‪getConfigurationService()->getFormElementPredefinedDefaultValueFromFormEditorSetup($dto);
        if ($value !== $predefinedDefaultValue) {
            $throwException = true;
 
            if (is_string($predefinedDefaultValue)) {
                // Last chance:
                // Get all translations (from all backend languages) for the untranslated! $predefinedDefaultValue and
                // compare the (already translated) $value (from the form definition) against the possible
                // translations from $predefinedDefaultValue.
                // Usecase:
                //   * backend language is EN
                //   * open the form editor and add a ContentElement form element
                //   * switch to another browser tab and change the backend language to DE
                //   * clear the cache
                //   * go back to the form editor and click the save button
                // Out of scope:
                //   * the same scenario as above + delete the previous chosen backend language within the maintenance tool
                $untranslatedPredefinedDefaultValue = $this->‪getConfigurationService()->getFormElementPredefinedDefaultValueFromFormEditorSetup($dto, false);
                $translations = $this->‪getConfigurationService()->getAllBackendTranslationsForTranslationKey(
                    $untranslatedPredefinedDefaultValue,
                    $dto->‪getPrototypeName()
                );
 
                if (in_array($value, $translations, true)) {
                    $throwException = false;
                }
            }
 
            if ($throwException) {
                $message = 'The value "%s" of property "%s" (form element "%s") is not equal to the default value "%s" #1528588035';
                throw new ‪PropertyException(
                    sprintf(
                        $message,
                        $value,
                        $dto->‪getPropertyPath(),
                        $dto->‪getFormElementIdentifier(),
                        $predefinedDefaultValue
                    ),
                    1528588035
                );
            }
        }
    }
 
    protected function ‪validateFormElementValue(
        $value,
        ‪ValidationDto $dto
    ): void {
        $allowedValues = $this->‪getConfigurationService()->getAllowedValuesForFormElementPropertyFromFormEditorSetup($dto);
 
        if (!in_array($value, $allowedValues, true)) {
            $untranslatedAllowedValues = $this->‪getConfigurationService()->getAllowedValuesForFormElementPropertyFromFormEditorSetup($dto, false);
            // Compare the $value against the untranslated set of allowed values
            if (in_array($value, $untranslatedAllowedValues, true)) {
                // All good, $value is within the untranslated set of allowed values
                return;
            }
            // Get all translations (from all backend languages) for the untranslated! $allowedValues and
            // compare the (already translated) $value (from the form definition) against all possible
            // translations for $untranslatedAllowedValues.
            $allPossibleAllowedValuesTranslations = $this->‪getConfigurationService()->getAllBackendTranslationsForTranslationKeys(
                $untranslatedAllowedValues,
                $dto->‪getPrototypeName()
            );
 
            foreach ($allPossibleAllowedValuesTranslations as $translations) {
                if (in_array($value, $translations, true)) {
                    // All good, $value is within the set of translated allowed values
                    return;
                }
            }
 
            // Last chance:
            // If $value is not configured within the form setup as an allowed value
            // but was written within the form definition by hand (and therefore contains a hmac),
            // check if $value is manipulated.
            // If $value has no hmac or if the hmac exists but is not valid,
            // then $this->validatePropertyCollectionElementPropertyValueByHmacData() will
            // throw an exception.
            $this->‪validateFormElementPropertyValueByHmacData(
                $this->currentElement,
                $value,
                $this->sessionToken,
                $dto
            );
        }
    }
}