TranslationService.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\Service;
 
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Core\Cache\Frontend\FrontendInterface;
use ‪TYPO3\CMS\Core\Http\ApplicationType;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Localization\LanguageServiceFactory;
use ‪TYPO3\CMS\Core\Localization\Locales;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\Exception\MissingArrayPathException;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
use ‪TYPO3\CMS\Form\Domain\Model\FormElements\FormElementInterface;
use ‪TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface;
use ‪TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
 
class ‪TranslationService implements ‪SingletonInterface
{
    protected string ‪$languageKey = '';
 
    public function ‪__construct(
        protected readonly ‪ConfigurationManagerInterface $configurationManager,
        protected readonly ‪LanguageServiceFactory $languageServiceFactory,
        protected readonly ‪FrontendInterface $runtimeCache,
        protected readonly ‪Locales $locales
    ) {}
 
    public function ‪translate(
        $key,
        array $arguments = null,
        string $locallangPathAndFilename = null,
        string $language = null,
        $defaultValue = ''
    ) {
        $key = (string)$key;
 
        if ($locallangPathAndFilename) {
            $key = $locallangPathAndFilename . ':' . $key;
        }
 
        $keyParts = explode(':', $key);
        if (str_starts_with($key, 'LLL:')) {
            $locallangPathAndFilename = $keyParts[1] . ':' . $keyParts[2];
            $key = $keyParts[3];
        } elseif (‪PathUtility::isExtensionPath($key)) {
            $locallangPathAndFilename = $keyParts[0] . ':' . $keyParts[1];
            $key = $keyParts[2];
        } elseif (count($keyParts) === 2) {
            $locallangPathAndFilename = $keyParts[0];
            $key = $keyParts[1];
        }
 
        if ($language) {
            $this->languageKey = $language;
        }
 
        if ($this->languageKey === '' || $language !== null) {
            $this->‪setLanguageKeys($language);
        }
        $languageService = $this->‪initializeLocalization($locallangPathAndFilename ?? '');
        $resolvedLabel = $languageService->sL('LLL:' . $locallangPathAndFilename . ':' . $key);
        $value = $resolvedLabel !== '' ? $resolvedLabel : null;
 
        // Check if a value was explicitly set to ""
        $overrideLabels = static::loadTypoScriptLabels();
        if ($value === null && isset($overrideLabels[$this->languageKey])) {
            $value = '';
        }
 
        if (is_array($arguments) && !empty($arguments) && $value !== null) {
            $value = vsprintf($value, $arguments);
        } elseif ($value === null) {
            $value = $defaultValue;
        }
 
        return $value;
    }
 
    public function ‪translateValuesRecursive(array $array, array $translationFiles = []): array
    {
        $result = $array;
        foreach ($result as $key => $value) {
            if (is_array($value)) {
                $result[$key] = $this->‪translateValuesRecursive($value, $translationFiles);
            } else {
                $this->‪sortArrayWithIntegerKeysDescending($translationFiles);
 
                if (!empty($translationFiles)) {
                    foreach ($translationFiles as $translationFile) {
                        $translatedValue = $this->‪translate($value, null, $translationFile, null);
                        if (!empty($translatedValue)) {
                            $result[$key] = $translatedValue;
                            break;
                        }
                    }
                } else {
                    $result[$key] = $this->‪translate($value, null, null, null, $value);
                }
            }
        }
        return $result;
    }
 
    public function ‪translateToAllBackendLanguages(
        string $key,
        array $arguments = null,
        array $translationFiles = []
    ): array {
        $result = [];
        $translationFiles = $this->‪sortArrayWithIntegerKeysDescending($translationFiles);
 
        foreach ($this->locales->getActiveLanguages() as $language) {
            $result[$language] = $key;
            foreach ($translationFiles as $translationFile) {
                $translatedValue = $this->‪translate($key, $arguments, $translationFile, $language, $key);
                if ($translatedValue !== $key) {
                    $result[$language] = $translatedValue;
                    break;
                }
            }
        }
 
        return $result;
    }
 
    public function ‪translateFinisherOption(
        ‪FormRuntime $formRuntime,
        string $finisherIdentifier,
        string $optionKey,
        string $optionValue,
        array $renderingOptions = []
    ): string {
        if (empty($finisherIdentifier)) {
            throw new \InvalidArgumentException('The argument "finisherIdentifier" is empty', 1476216059);
        }
        if (empty($optionKey)) {
            throw new \InvalidArgumentException('The argument "optionKey" is empty', 1476216060);
        }
 
        if (in_array($optionKey, $renderingOptions['propertiesExcludedFromTranslation'] ?? [], true)) {
            return $optionValue;
        }
 
        $finisherIdentifier = preg_replace('/Finisher$/', '', $finisherIdentifier);
        $translationFiles = $renderingOptions['translationFiles'] ?? [];
        if (empty($translationFiles)) {
            $translationFiles = $formRuntime->‪getRenderingOptions()['translation']['translationFiles'];
        }
 
        $translationFiles = $this->‪sortArrayWithIntegerKeysDescending($translationFiles);
 
        if (isset($renderingOptions['translatePropertyValueIfEmpty'])) {
            $translatePropertyValueIfEmpty = (bool)$renderingOptions['translatePropertyValueIfEmpty'];
        } else {
            $translatePropertyValueIfEmpty = true;
        }
 
        if (empty($optionValue) && !$translatePropertyValueIfEmpty) {
            return $optionValue;
        }
 
        $language = null;
        if (isset($renderingOptions['language'])) {
            $language = $renderingOptions['language'];
        }
 
        try {
            $arguments = ‪ArrayUtility::getValueByPath($renderingOptions['arguments'] ?? [], $optionKey, '.');
        } catch (‪MissingArrayPathException $e) {
            $arguments = [];
        }
 
        $originalFormIdentifier = null;
        if (isset($formRuntime->‪getRenderingOptions()['_originalIdentifier'])) {
            $originalFormIdentifier = $formRuntime->‪getRenderingOptions()['_originalIdentifier'];
        }
 
        $translationKeyChain = [];
        foreach ($translationFiles as $translationFile) {
            if (!empty($originalFormIdentifier)) {
                $translationKeyChain[] = sprintf('%s:%s.finisher.%s.%s', $translationFile, $originalFormIdentifier, $finisherIdentifier, $optionKey);
            }
            $translationKeyChain[] = sprintf('%s:%s.finisher.%s.%s', $translationFile, $formRuntime->‪getIdentifier(), $finisherIdentifier, $optionKey);
            $translationKeyChain[] = sprintf('%s:finisher.%s.%s', $translationFile, $finisherIdentifier, $optionKey);
        }
 
        $translatedValue = $this->‪processTranslationChain($translationKeyChain, $language, $arguments);
        $translatedValue = $this->‪isEmptyTranslatedValue($translatedValue) ? $optionValue : $translatedValue;
 
        return $translatedValue;
    }
 
    public function ‪translateFormElementValue(
        ‪RootRenderableInterface $element,
        array $propertyParts,
        ‪FormRuntime $formRuntime
    ) {
        if (empty($propertyParts)) {
            throw new \InvalidArgumentException('The argument "propertyParts" is empty', 1476216007);
        }
 
        $propertyType = 'properties';
        $property = implode('.', $propertyParts);
        $renderingOptions = $element->‪getRenderingOptions();
 
        if ($property === 'label') {
            $defaultValue = $element->‪getLabel();
        } else {
            if ($element instanceof ‪FormElementInterface) {
                try {
                    $defaultValue = ‪ArrayUtility::getValueByPath($element->getProperties(), $propertyParts, '.');
                } catch (‪MissingArrayPathException $exception) {
                    $defaultValue = null;
                }
            } else {
                $propertyType = 'renderingOptions';
                try {
                    $defaultValue = ‪ArrayUtility::getValueByPath($renderingOptions, $propertyParts, '.');
                } catch (‪MissingArrayPathException $exception) {
                    $defaultValue = null;
                }
            }
        }
 
        if (isset($renderingOptions['translation']['translatePropertyValueIfEmpty'])) {
            $translatePropertyValueIfEmpty = $renderingOptions['translation']['translatePropertyValueIfEmpty'];
        } else {
            $translatePropertyValueIfEmpty = true;
        }
 
        if ($this->‪isEmptyTranslatedValue($defaultValue) && !$translatePropertyValueIfEmpty) {
            return $defaultValue;
        }
 
        $defaultValue = $this->‪isEmptyTranslatedValue($defaultValue) ? '' : $defaultValue;
        $translationFiles = $renderingOptions['translation']['translationFiles'] ?? [];
        if (empty($translationFiles)) {
            $translationFiles = $formRuntime->‪getRenderingOptions()['translation']['translationFiles'];
        }
 
        $translationFiles = $this->‪sortArrayWithIntegerKeysDescending($translationFiles);
 
        $language = null;
        if (isset($renderingOptions['translation']['language'])) {
            $language = $renderingOptions['translation']['language'];
        }
 
        try {
            $arguments = ‪ArrayUtility::getValueByPath($renderingOptions['translation']['arguments'] ?? [], $propertyParts, '.');
        } catch (‪MissingArrayPathException $e) {
            $arguments = [];
        }
 
        $originalFormIdentifier = null;
        if (isset($formRuntime->‪getRenderingOptions()['_originalIdentifier'])) {
            $originalFormIdentifier = $formRuntime->‪getRenderingOptions()['_originalIdentifier'];
        }
 
        if ($property === 'options' && is_array($defaultValue)) {
            foreach ($defaultValue as $optionValue => &$optionLabel) {
                $translationKeyChain = [];
                foreach ($translationFiles as $translationFile) {
                    if (!empty($originalFormIdentifier)) {
                        if ($element instanceof ‪FormRuntime) {
                            $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s.%s', $translationFile, $originalFormIdentifier, $originalFormIdentifier, $propertyType, $property, $optionValue);
                            $translationKeyChain[] = sprintf('%s:element.%s.%s.%s.%s', $translationFile, $originalFormIdentifier, $propertyType, $property, $optionValue);
                        } else {
                            $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s.%s', $translationFile, $originalFormIdentifier, $element->‪getIdentifier(), $propertyType, $property, $optionValue);
                        }
                    }
                    $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s.%s', $translationFile, $formRuntime->‪getIdentifier(), $element->‪getIdentifier(), $propertyType, $property, $optionValue);
                    $translationKeyChain[] = sprintf('%s:element.%s.%s.%s.%s', $translationFile, $element->‪getIdentifier(), $propertyType, $property, $optionValue);
                    $translationKeyChain[] = sprintf('%s:element.%s.%s.%s.%s', $translationFile, $element->‪getType(), $propertyType, $property, $optionValue);
                }
 
                $translatedValue = $this->‪processTranslationChain($translationKeyChain, $language, $arguments);
                $optionLabel = $this->‪isEmptyTranslatedValue($translatedValue) ? $optionLabel : $translatedValue;
            }
            $translatedValue = $defaultValue;
        } elseif ($property === 'fluidAdditionalAttributes' && is_array($defaultValue)) {
            foreach ($defaultValue as $propertyName => &$propertyValue) {
                $translationKeyChain = [];
                foreach ($translationFiles as $translationFile) {
                    if (!empty($originalFormIdentifier)) {
                        if ($element instanceof ‪FormRuntime) {
                            $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s', $translationFile, $originalFormIdentifier, $originalFormIdentifier, $propertyType, $propertyName);
                            $translationKeyChain[] = sprintf('%s:element.%s.%s.%s', $translationFile, $originalFormIdentifier, $propertyType, $propertyName);
                        } else {
                            $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s', $translationFile, $originalFormIdentifier, $element->‪getIdentifier(), $propertyType, $propertyName);
                        }
                    }
                    $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s', $translationFile, $formRuntime->‪getIdentifier(), $element->‪getIdentifier(), $propertyType, $propertyName);
                    $translationKeyChain[] = sprintf('%s:element.%s.%s.%s', $translationFile, $element->‪getIdentifier(), $propertyType, $propertyName);
                    $translationKeyChain[] = sprintf('%s:element.%s.%s.%s', $translationFile, $element->‪getType(), $propertyType, $propertyName);
                }
 
                $translatedValue = $this->‪processTranslationChain($translationKeyChain, $language, $arguments);
                $propertyValue = $this->‪isEmptyTranslatedValue($translatedValue) ? $propertyValue : $translatedValue;
            }
            $translatedValue = $defaultValue;
        } else {
            $translationKeyChain = [];
            foreach ($translationFiles as $translationFile) {
                if (!empty($originalFormIdentifier)) {
                    if ($element instanceof ‪FormRuntime) {
                        $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s', $translationFile, $originalFormIdentifier, $originalFormIdentifier, $propertyType, $property);
                        $translationKeyChain[] = sprintf('%s:element.%s.%s.%s', $translationFile, $originalFormIdentifier, $propertyType, $property);
                    } else {
                        $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s', $translationFile, $originalFormIdentifier, $element->‪getIdentifier(), $propertyType, $property);
                    }
                }
                $translationKeyChain[] = sprintf('%s:%s.element.%s.%s.%s', $translationFile, $formRuntime->‪getIdentifier(), $element->‪getIdentifier(), $propertyType, $property);
                $translationKeyChain[] = sprintf('%s:element.%s.%s.%s', $translationFile, $element->‪getIdentifier(), $propertyType, $property);
                $translationKeyChain[] = sprintf('%s:element.%s.%s.%s', $translationFile, $element->‪getType(), $propertyType, $property);
            }
 
            $translatedValue = $this->‪processTranslationChain($translationKeyChain, $language, $arguments);
            $translatedValue = $this->‪isEmptyTranslatedValue($translatedValue) ? $defaultValue : $translatedValue;
        }
 
        return $translatedValue;
    }
 
    public function ‪translateFormElementError(
        ‪RootRenderableInterface $element,
        int $code,
        array $arguments,
        string $defaultValue,
        ‪FormRuntime $formRuntime
    ): string {
        if (empty($code)) {
            throw new \InvalidArgumentException('The argument "code" is empty', 1489272978);
        }
 
        $validationErrors = $element->getProperties()['validationErrorMessages'] ?? null;
        if (is_array($validationErrors)) {
            foreach ($validationErrors as $validationError) {
                if ((int)$validationError['code'] === $code) {
                    return sprintf($validationError['message'], ...$arguments);
                }
            }
        }
 
        $renderingOptions = $element->‪getRenderingOptions();
        $translationFiles = $renderingOptions['translation']['translationFiles'] ?? [];
        if (empty($translationFiles)) {
            $translationFiles = $formRuntime->‪getRenderingOptions()['translation']['translationFiles'];
        }
 
        $translationFiles = $this->‪sortArrayWithIntegerKeysDescending($translationFiles);
 
        $language = null;
        if (isset($renderingOptions['language'])) {
            $language = $renderingOptions['language'];
        }
 
        $originalFormIdentifier = null;
        if (isset($formRuntime->‪getRenderingOptions()['_originalIdentifier'])) {
            $originalFormIdentifier = $formRuntime->‪getRenderingOptions()['_originalIdentifier'];
        }
 
        $translationKeyChain = [];
        foreach ($translationFiles as $translationFile) {
            if (!empty($originalFormIdentifier)) {
                if ($element instanceof ‪FormRuntime) {
                    $translationKeyChain[] = sprintf('%s:%s.validation.error.%s.%s', $translationFile, $originalFormIdentifier, $originalFormIdentifier, $code);
                    $translationKeyChain[] = sprintf('%s:validation.error.%s.%s', $translationFile, $originalFormIdentifier, $code);
                } else {
                    $translationKeyChain[] = sprintf('%s:%s.validation.error.%s.%s', $translationFile, $originalFormIdentifier, $element->‪getIdentifier(), $code);
                }
                $translationKeyChain[] = sprintf('%s:%s.validation.error.%s', $translationFile, $originalFormIdentifier, $code);
            }
            $translationKeyChain[] = sprintf('%s:%s.validation.error.%s.%s', $translationFile, $formRuntime->‪getIdentifier(), $element->‪getIdentifier(), $code);
            $translationKeyChain[] = sprintf('%s:%s.validation.error.%s', $translationFile, $formRuntime->‪getIdentifier(), $code);
            $translationKeyChain[] = sprintf('%s:validation.error.%s.%s', $translationFile, $element->‪getIdentifier(), $code);
            $translationKeyChain[] = sprintf('%s:validation.error.%s', $translationFile, $code);
        }
 
        $translatedValue = $this->‪processTranslationChain($translationKeyChain, $language, $arguments);
        $translatedValue = $this->‪isEmptyTranslatedValue($translatedValue) ? $defaultValue : $translatedValue;
        return $translatedValue;
    }
 
    public function ‪setLanguage(string ‪$languageKey)
    {
        $this->languageKey = ‪$languageKey;
    }
 
    public function ‪getLanguage(): string
    {
        return ‪$this->languageKey;
    }
 
    protected function ‪processTranslationChain(
        array $translationKeyChain,
        string $language = null,
        array $arguments = null
    ) {
        $translatedValue = null;
        foreach ($translationKeyChain as $translationKey) {
            $translatedValue = $this->‪translate($translationKey, $arguments, null, $language);
            if (!$this->‪isEmptyTranslatedValue($translatedValue)) {
                break;
            }
        }
        return $translatedValue;
    }
 
    protected function ‪initializeLocalization(string $locallangPathAndFilename): ‪LanguageService
    {
        $languageService = $this->‪buildLanguageService($this->languageKey, $locallangPathAndFilename);
 
        if (!empty($locallangPathAndFilename)) {
            $overrideLabels = $this->‪loadTypoScriptLabels();
            if ($overrideLabels !== []) {
                $languageService->overrideLabels($locallangPathAndFilename, $overrideLabels);
            }
        }
        return $languageService;
    }
 
    protected function ‪buildLanguageService(string ‪$languageKey, $languageFilePath): ‪LanguageService
    {
        $languageKeyHash = sha1(‪$languageKey . '_' . $languageFilePath);
        if (!$this->runtimeCache->get($languageKeyHash)) {
            $languageService = $this->languageServiceFactory->create(‪$languageKey);
            if ($languageFilePath) {
                $languageService->includeLLFile($languageFilePath);
            }
            $this->runtimeCache->set($languageKeyHash, $languageService);
        }
        return $this->runtimeCache->get($languageKeyHash);
    }
 
    protected function ‪setLanguageKeys(?string $language): void
    {
        if ($language) {
            $this->languageKey = $language;
        } else {
            $this->languageKey = 'default';
            if ((‪$GLOBALS['TYPO3_REQUEST'] ?? null) instanceof ServerRequestInterface
                && ‪ApplicationType::fromRequest(‪$GLOBALS['TYPO3_REQUEST'])->isFrontend()
            ) {
                $this->languageKey = $this->‪getCurrentSiteLanguage()->getTypo3Language();
            } elseif (!empty(‪$GLOBALS['BE_USER']->user['lang'])) {
                $this->languageKey = ‪$GLOBALS['BE_USER']->user['lang'];
            }
        }
    }
 
    protected function ‪loadTypoScriptLabels(): array
    {
        $frameworkConfiguration = $this->configurationManager->getConfiguration(‪ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK, 'form');
        if (!is_array($frameworkConfiguration['_LOCAL_LANG'] ?? false)) {
            return [];
        }
        $finalLabels = [];
        foreach ($frameworkConfiguration['_LOCAL_LANG'] as ‪$languageKey => $labels) {
            if (!is_array($labels)) {
                continue;
            }
            foreach ($labels as $labelKey => $labelValue) {
                if (is_string($labelValue)) {
                    $finalLabels[‪$languageKey][$labelKey] = $labelValue;
                } elseif (is_array($labelValue)) {
                    $labelValue = $this->‪flattenTypoScriptLabelArray($labelValue, $labelKey);
                    foreach ($labelValue as $key => $value) {
                        $finalLabels[‪$languageKey][$key] = $value;
                    }
                }
            }
        }
        return $finalLabels;
    }
 
    protected function ‪flattenTypoScriptLabelArray(array $labelValues, string $parentKey = ''): array
    {
        $result = [];
        foreach ($labelValues as $key => $labelValue) {
            if (!empty($parentKey)) {
                $key = $parentKey . '.' . $key;
            }
            if (is_array($labelValue)) {
                $labelValue = $this->‪flattenTypoScriptLabelArray($labelValue, $key);
                $result = array_merge($result, $labelValue);
            } else {
                $result[$key] = $labelValue;
            }
        }
        return $result;
    }
 
    protected function ‪sortArrayWithIntegerKeysDescending(array $array): array
    {
        if (count(array_filter(array_keys($array), 'is_string')) === 0) {
            krsort($array);
        }
        return $array;
    }
 
    protected function ‪isEmptyTranslatedValue(mixed $translatedValue): bool
    {
        if ($translatedValue === null) {
            return true;
        }
 
        if (is_string($translatedValue)) {
            return trim($translatedValue) === '';
        }
 
        if (is_bool($translatedValue)) {
            return !$translatedValue;
        }
 
        if (is_array($translatedValue)) {
            return $translatedValue === [];
        }
 
        return false;
    }
 
    protected function ‪getCurrentSiteLanguage(): ?‪SiteLanguage
    {
        if (‪$GLOBALS['TYPO3_REQUEST'] instanceof ServerRequestInterface) {
            return ‪$GLOBALS['TYPO3_REQUEST']->getAttribute('language', null);
        }
        return null;
    }
}