vendor/shopware/core/Framework/Adapter/Translation/Translator.php line 332

  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\Adapter\Translation;
  5. use Doctrine\DBAL\Exception\ConnectionException;
  6. use Shopware\Core\Defaults;
  7. use Shopware\Core\Framework\Context;
  8. use Shopware\Core\Framework\DataAbstractionLayer\EntityRepository;
  9. use Shopware\Core\Framework\DataAbstractionLayer\Search\Criteria;
  10. use Shopware\Core\Framework\DataAbstractionLayer\Search\Filter\EqualsFilter;
  11. use Shopware\Core\Framework\Feature;
  12. use Shopware\Core\Framework\Log\Package;
  13. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  14. use Shopware\Core\PlatformRequest;
  15. use Shopware\Core\SalesChannelRequest;
  16. use Shopware\Core\System\Locale\LanguageLocaleCodeProvider;
  17. use Shopware\Core\System\Snippet\SnippetService;
  18. use Symfony\Component\HttpFoundation\RequestStack;
  19. use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
  20. use Symfony\Component\Translation\Formatter\MessageFormatterInterface;
  21. use Symfony\Component\Translation\MessageCatalogueInterface;
  22. use Symfony\Component\Translation\Translator as SymfonyTranslator;
  23. use Symfony\Component\Translation\TranslatorBagInterface;
  24. use Symfony\Contracts\Cache\CacheInterface;
  25. use Symfony\Contracts\Cache\ItemInterface;
  26. use Symfony\Contracts\Translation\LocaleAwareInterface;
  27. use Symfony\Contracts\Translation\TranslatorInterface;
  28. use Symfony\Contracts\Translation\TranslatorTrait;
  30. #[Package('core')]
  31. class Translator extends AbstractTranslator
  32. {
  33.     use TranslatorTrait;
  35.     /**
  36.      * @var array<string, MessageCatalogueInterface>
  37.      */
  38.     private array $isCustomized = [];
  40.     private ?string $snippetSetId = null;
  42.     private ?string $salesChannelId = null;
  44.     private ?string $localeBeforeInject = null;
  46.     /**
  47.      * @var array<string, bool>
  48.      */
  49.     private array $keys = ['all' => true];
  51.     /**
  52.      * @var array<string, array<string, bool>>
  53.      */
  54.     private array $traces = [];
  56.     /**
  57.      * @var array<string, string>
  58.      */
  59.     private array $snippets = [];
  61.     /**
  62.      * @internal
  63.      */
  64.     public function __construct(
  65.         private readonly TranslatorInterface $translator,
  66.         private readonly RequestStack $requestStack,
  67.         private readonly CacheInterface $cache,
  68.         private readonly MessageFormatterInterface $formatter,
  69.         private readonly SnippetService $snippetService,
  70.         private readonly string $environment,
  71.         private readonly EntityRepository $snippetSetRepository,
  72.         private readonly LanguageLocaleCodeProvider $languageLocaleProvider
  73.     ) {
  74.     }
  76.     public static function buildName(string $id): string
  77.     {
  78.         if (\strpbrk($id, (string) ItemInterface::RESERVED_CHARACTERS) !== false) {
  79.             $id = \str_replace(\str_split((string) ItemInterface::RESERVED_CHARACTERS, 1), '_r_', $id);
  80.         }
  82.         return 'translator.' . $id;
  83.     }
  85.     public function getDecorated(): AbstractTranslator
  86.     {
  87.         throw new DecorationPatternException(self::class);
  88.     }
  90.     /**
  91.      * @return mixed|null All kind of data could be cached
  92.      */
  93.     public function trace(string $key, \Closure $param)
  94.     {
  95.         $this->traces[$key] = [];
  96.         $this->keys[$key] = true;
  98.         $result = $param();
  100.         unset($this->keys[$key]);
  102.         return $result;
  103.     }
  105.     /**
  106.      * @return array<int, string>
  107.      */
  108.     public function getTrace(string $key): array
  109.     {
  110.         $trace = isset($this->traces[$key]) ? array_keys($this->traces[$key]) : [];
  111.         unset($this->traces[$key]);
  113.         return $trace;
  114.     }
  116.     /**
  117.      * {@inheritdoc}
  118.      */
  119.     public function getCatalogue(?string $locale = null): MessageCatalogueInterface
  120.     {
  121.         \assert($this->translator instanceof TranslatorBagInterface);
  122.         $catalog = $this->translator->getCatalogue($locale);
  124.         $fallbackLocale = $this->getFallbackLocale();
  126.         $localization = mb_substr($fallbackLocale, 0, 2);
  127.         if ($this->isShopwareLocaleCatalogue($catalog) && !$this->isFallbackLocaleCatalogue($catalog, $localization)) {
  128.             $catalog->addFallbackCatalogue($this->translator->getCatalogue($localization));
  129.         } else {
  130.             //fallback locale and current locale has the same localization -> reset fallback
  131.             // or locale is symfony style locale so we shouldn't add shopware fallbacks as it may lead to circular references
  132.             $fallbackLocale = null;
  133.         }
  135.         // disable fallback logic to display symfony warnings
  136.         if ($this->environment !== 'prod') {
  137.             $fallbackLocale = null;
  138.         }
  140.         return $this->getCustomizedCatalog($catalog, $fallbackLocale, $locale);
  141.     }
  143.     /**
  144.      * @param array<string, string> $parameters
  145.      */
  146.     public function trans(string $id, array $parameters = [], ?string $domain = null, ?string $locale = null): string
  147.     {
  148.         if ($domain === null) {
  149.             $domain = 'messages';
  150.         }
  152.         foreach (array_keys($this->keys) as $trace) {
  153.             $this->traces[$trace][self::buildName($id)] = true;
  154.         }
  156.         return $this->formatter->format($this->getCatalogue($locale)->get($id, $domain), $locale ?? $this->getFallbackLocale(), $parameters);
  157.     }
  159.     /**
  160.      * {@inheritdoc}
  161.      */
  162.     public function setLocale(string $locale): void
  163.     {
  164.         \assert($this->translator instanceof LocaleAwareInterface);
  165.         $this->translator->setLocale($locale);
  166.     }
  168.     /**
  169.      * {@inheritdoc}
  170.      */
  171.     public function getLocale(): string
  172.     {
  173.         \assert($this->translator instanceof LocaleAwareInterface);
  175.         return $this->translator->getLocale();
  176.     }
  178.     public function warmUp($cacheDir): void
  179.     {
  180.         if ($this->translator instanceof WarmableInterface) {
  181.             $this->translator->warmUp($cacheDir);
  182.         }
  183.     }
  185.     /**
  186.      * @deprecated tag:v6.6.0 - Will be removed, use `reset` instead
  187.      */
  188.     public function resetInMemoryCache(): void
  189.     {
  190.         Feature::triggerDeprecationOrThrow(
  191.             'v6.6.0.0',
  192.             Feature::deprecatedMethodMessage(self::class, __METHOD__, 'v6.6.0.0', 'Use reset() instead')
  193.         );
  194.         $this->reset();
  195.     }
  197.     public function reset(): void
  198.     {
  199.         $this->isCustomized = [];
  200.         $this->snippetSetId = null;
  201.         if ($this->translator instanceof SymfonyTranslator) {
  202.             // Reset FallbackLocale in memory cache of symfony implementation
  203.             // set fallback values from Framework/Resources/config/translation.yaml
  204.             $this->translator->setFallbackLocales(['en_GB', 'en']);
  205.         }
  206.     }
  208.     /**
  209.      * Injects temporary settings for translation which differ from Context.
  210.      * Call resetInjection() when specific translation is done
  211.      */
  212.     public function injectSettings(string $salesChannelId, string $languageId, string $locale, Context $context): void
  213.     {
  214.         $this->localeBeforeInject = $this->getLocale();
  215.         $this->salesChannelId = $salesChannelId;
  216.         $this->setLocale($locale);
  217.         $this->resolveSnippetSetId($salesChannelId, $languageId, $locale, $context);
  218.         $this->getCatalogue($locale);
  219.     }
  221.     public function resetInjection(): void
  222.     {
  223.         if ($this->localeBeforeInject === null) {
  224.             // Nothing was injected, so no need to reset
  225.             return;
  226.         }
  228.         $this->setLocale($this->localeBeforeInject);
  229.         $this->snippetSetId = null;
  230.         $this->salesChannelId = null;
  231.     }
  233.     public function getSnippetSetId(?string $locale = null): ?string
  234.     {
  235.         if ($locale !== null) {
  236.             if (\array_key_exists($locale, $this->snippets)) {
  237.                 return $this->snippets[$locale];
  238.             }
  240.             $criteria = new Criteria();
  241.             $criteria->addFilter(new EqualsFilter('iso', $locale));
  243.             $snippetSetId = $this->snippetSetRepository->searchIds($criteria, Context::createDefaultContext())->firstId();
  244.             if ($snippetSetId !== null) {
  245.                 return $this->snippets[$locale] = $snippetSetId;
  246.             }
  247.         }
  249.         if ($this->snippetSetId !== null) {
  250.             return $this->snippetSetId;
  251.         }
  253.         $request = $this->requestStack->getCurrentRequest();
  254.         if (!$request) {
  255.             return null;
  256.         }
  258.         $this->snippetSetId = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_SNIPPET_SET_ID);
  260.         return $this->snippetSetId;
  261.     }
  263.     /**
  264.      * @return array<int, MessageCatalogueInterface>
  265.      */
  266.     public function getCatalogues(): array
  267.     {
  268.         return array_values($this->isCustomized);
  269.     }
  271.     private function isFallbackLocaleCatalogue(MessageCatalogueInterface $catalog, string $fallbackLocale): bool
  272.     {
  273.         return mb_strpos($catalog->getLocale(), $fallbackLocale) === 0;
  274.     }
  276.     /**
  277.      * Shopware uses dashes in all locales
  278.      * if the catalogue does not contain any dashes it means it is a symfony fallback catalogue
  279.      * in that case we should not add the shopware fallback catalogue as it would result in circular references
  280.      */
  281.     private function isShopwareLocaleCatalogue(MessageCatalogueInterface $catalog): bool
  282.     {
  283.         return mb_strpos($catalog->getLocale(), '-') !== false;
  284.     }
  286.     private function resolveSnippetSetId(string $salesChannelId, string $languageId, string $locale, Context $context): void
  287.     {
  288.         $snippetSet = $this->snippetService->getSnippetSet($salesChannelId, $languageId, $locale, $context);
  289.         if ($snippetSet === null) {
  290.             $this->snippetSetId = null;
  291.         } else {
  292.             $this->snippetSetId = $snippetSet->getId();
  293.         }
  294.     }
  296.     /**
  297.      * Add language specific snippets provided by the admin
  298.      */
  299.     private function getCustomizedCatalog(MessageCatalogueInterface $catalog, ?string $fallbackLocale, ?string $locale = null): MessageCatalogueInterface
  300.     {
  301.         $snippetSetId = $this->getSnippetSetId($locale);
  303.         if (!$snippetSetId) {
  304.             return $catalog;
  305.         }
  307.         if (\array_key_exists($snippetSetId, $this->isCustomized)) {
  308.             return $this->isCustomized[$snippetSetId];
  309.         }
  311.         $snippets = $this->loadSnippets($catalog, $snippetSetId, $fallbackLocale);
  313.         $newCatalog = clone $catalog;
  314.         $newCatalog->add($snippets);
  316.         return $this->isCustomized[$snippetSetId] = $newCatalog;
  317.     }
  319.     /**
  320.      * @return array<string, string>
  321.      */
  322.     private function loadSnippets(MessageCatalogueInterface $catalog, string $snippetSetId, ?string $fallbackLocale): array
  323.     {
  324.         $this->resolveSalesChannelId();
  326.         $key = sprintf('translation.catalog.%s.%s', $this->salesChannelId ?: 'DEFAULT', $snippetSetId);
  328.         return $this->cache->get($key, function (ItemInterface $item) use ($catalog, $snippetSetId, $fallbackLocale) {
  329.             $item->tag('translation.catalog.' . $snippetSetId);
  330.             $item->tag(sprintf('translation.catalog.%s', $this->salesChannelId ?: 'DEFAULT'));
  332.             return $this->snippetService->getStorefrontSnippets($catalog, $snippetSetId, $fallbackLocale, $this->salesChannelId);
  333.         });
  334.     }
  336.     private function getFallbackLocale(): string
  337.     {
  338.         try {
  339.             return $this->languageLocaleProvider->getLocaleForLanguageId(Defaults::LANGUAGE_SYSTEM);
  340.         } catch (ConnectionException) {
  341.             // this allows us to use the translator even if there's no db connection yet
  342.             return 'en-GB';
  343.         }
  344.     }
  346.     private function resolveSalesChannelId(): void
  347.     {
  348.         if ($this->salesChannelId !== null) {
  349.             return;
  350.         }
  352.         $request = $this->requestStack->getCurrentRequest();
  354.         if (!$request) {
  355.             return;
  356.         }
  358.         $this->salesChannelId = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  359.     }
  360. }