src/Core/Framework/Adapter/Translation/Translator.php line 147

  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\Log\Package;
  12. use Shopware\Core\Framework\Plugin\Exception\DecorationPatternException;
  13. use Shopware\Core\PlatformRequest;
  14. use Shopware\Core\SalesChannelRequest;
  15. use Shopware\Core\System\Locale\LanguageLocaleCodeProvider;
  16. use Shopware\Core\System\Snippet\SnippetService;
  17. use Symfony\Component\HttpFoundation\RequestStack;
  18. use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
  19. use Symfony\Component\Translation\Formatter\MessageFormatterInterface;
  20. use Symfony\Component\Translation\MessageCatalogueInterface;
  21. use Symfony\Component\Translation\Translator as SymfonyTranslator;
  22. use Symfony\Component\Translation\TranslatorBagInterface;
  23. use Symfony\Contracts\Cache\CacheInterface;
  24. use Symfony\Contracts\Cache\ItemInterface;
  25. use Symfony\Contracts\Translation\LocaleAwareInterface;
  26. use Symfony\Contracts\Translation\TranslatorInterface;
  27. use Symfony\Contracts\Translation\TranslatorTrait;
  29. #[Package('core')]
  30. class Translator extends AbstractTranslator
  31. {
  32.     use TranslatorTrait;
  34.     /**
  35.      * @var array<string, MessageCatalogueInterface>
  36.      */
  37.     private array $isCustomized = [];
  39.     private ?string $snippetSetId = null;
  41.     private ?string $salesChannelId = null;
  43.     private ?string $localeBeforeInject = null;
  45.     /**
  46.      * @var array<string, bool>
  47.      */
  48.     private array $keys = ['all' => true];
  50.     /**
  51.      * @var array<string, array<string, bool>>
  52.      */
  53.     private array $traces = [];
  55.     /**
  56.      * @var array<string, string>
  57.      */
  58.     private array $snippets = [];
  60.     /**
  61.      * @internal
  62.      */
  63.     public function __construct(private readonly TranslatorInterface $translator, private readonly RequestStack $requestStack, private readonly CacheInterface $cache, private readonly MessageFormatterInterface $formatter, private readonly SnippetService $snippetService, private readonly string $environment, private readonly EntityRepository $snippetSetRepository, private readonly LanguageLocaleCodeProvider $languageLocaleProvider)
  64.     {
  65.     }
  67.     public static function buildName(string $id): string
  68.     {
  69.         if (\strpbrk($id, (string) ItemInterface::RESERVED_CHARACTERS) !== false) {
  70.             $id = \str_replace(\str_split((string) ItemInterface::RESERVED_CHARACTERS, 1), '_r_', $id);
  71.         }
  73.         return 'translator.' . $id;
  74.     }
  76.     public function getDecorated(): AbstractTranslator
  77.     {
  78.         throw new DecorationPatternException(self::class);
  79.     }
  81.     /**
  82.      * @return mixed|null All kind of data could be cached
  83.      */
  84.     public function trace(string $key, \Closure $param)
  85.     {
  86.         $this->traces[$key] = [];
  87.         $this->keys[$key] = true;
  89.         $result = $param();
  91.         unset($this->keys[$key]);
  93.         return $result;
  94.     }
  96.     /**
  97.      * @return array<int, string>
  98.      */
  99.     public function getTrace(string $key): array
  100.     {
  101.         $trace = isset($this->traces[$key]) ? array_keys($this->traces[$key]) : [];
  102.         unset($this->traces[$key]);
  104.         return $trace;
  105.     }
  107.     /**
  108.      * {@inheritdoc}
  109.      */
  110.     public function getCatalogue(?string $locale = null): MessageCatalogueInterface
  111.     {
  112.         \assert($this->translator instanceof TranslatorBagInterface);
  113.         $catalog = $this->translator->getCatalogue($locale);
  115.         $fallbackLocale = $this->getFallbackLocale();
  117.         $localization = mb_substr($fallbackLocale, 0, 2);
  118.         if ($this->isShopwareLocaleCatalogue($catalog) && !$this->isFallbackLocaleCatalogue($catalog, $localization)) {
  119.             $catalog->addFallbackCatalogue($this->translator->getCatalogue($localization));
  120.         } else {
  121.             //fallback locale and current locale has the same localization -> reset fallback
  122.             // or locale is symfony style locale so we shouldn't add shopware fallbacks as it may lead to circular references
  123.             $fallbackLocale = null;
  124.         }
  126.         // disable fallback logic to display symfony warnings
  127.         if ($this->environment !== 'prod') {
  128.             $fallbackLocale = null;
  129.         }
  131.         return $this->getCustomizedCatalog($catalog, $fallbackLocale, $locale);
  132.     }
  134.     /**
  135.      * @param array<string, string> $parameters
  136.      */
  137.     public function trans(string $id, array $parameters = [], ?string $domain = null, ?string $locale = null): string
  138.     {
  139.         if ($domain === null) {
  140.             $domain = 'messages';
  141.         }
  143.         foreach (array_keys($this->keys) as $trace) {
  144.             $this->traces[$trace][self::buildName($id)] = true;
  145.         }
  147.         return $this->formatter->format($this->getCatalogue($locale)->get($id, $domain), $locale ?? $this->getFallbackLocale(), $parameters);
  148.     }
  150.     /**
  151.      * {@inheritdoc}
  152.      */
  153.     public function setLocale(string $locale): void
  154.     {
  155.         \assert($this->translator instanceof LocaleAwareInterface);
  156.         $this->translator->setLocale($locale);
  157.     }
  159.     /**
  160.      * {@inheritdoc}
  161.      */
  162.     public function getLocale(): string
  163.     {
  164.         \assert($this->translator instanceof LocaleAwareInterface);
  166.         return $this->translator->getLocale();
  167.     }
  169.     /**
  170.      * @param string $cacheDir
  171.      */
  172.     public function warmUp($cacheDir): void
  173.     {
  174.         if ($this->translator instanceof WarmableInterface) {
  175.             $this->translator->warmUp($cacheDir);
  176.         }
  177.     }
  179.     public function resetInMemoryCache(): void
  180.     {
  181.         $this->isCustomized = [];
  182.         $this->snippetSetId = null;
  183.         if ($this->translator instanceof SymfonyTranslator) {
  184.             // Reset FallbackLocale in memory cache of symfony implementation
  185.             // set fallback values from Framework/Resources/config/translation.yaml
  186.             $this->translator->setFallbackLocales(['en_GB', 'en']);
  187.         }
  188.     }
  190.     /**
  191.      * Injects temporary settings for translation which differ from Context.
  192.      * Call resetInjection() when specific translation is done
  193.      */
  194.     public function injectSettings(string $salesChannelId, string $languageId, string $locale, Context $context): void
  195.     {
  196.         $this->localeBeforeInject = $this->getLocale();
  197.         $this->salesChannelId = $salesChannelId;
  198.         $this->setLocale($locale);
  199.         $this->resolveSnippetSetId($salesChannelId, $languageId, $locale, $context);
  200.         $this->getCatalogue($locale);
  201.     }
  203.     public function resetInjection(): void
  204.     {
  205.         \assert($this->localeBeforeInject !== null);
  206.         $this->setLocale($this->localeBeforeInject);
  207.         $this->snippetSetId = null;
  208.         $this->salesChannelId = null;
  209.     }
  211.     public function getSnippetSetId(?string $locale = null): ?string
  212.     {
  213.         if ($locale !== null) {
  214.             if (\array_key_exists($locale, $this->snippets)) {
  215.                 return $this->snippets[$locale];
  216.             }
  218.             $criteria = new Criteria();
  219.             $criteria->addFilter(new EqualsFilter('iso', $locale));
  221.             $snippetSetId = $this->snippetSetRepository->searchIds($criteria, Context::createDefaultContext())->firstId();
  222.             if ($snippetSetId !== null) {
  223.                 return $this->snippets[$locale] = $snippetSetId;
  224.             }
  225.         }
  227.         if ($this->snippetSetId !== null) {
  228.             return $this->snippetSetId;
  229.         }
  231.         $request = $this->requestStack->getCurrentRequest();
  232.         if (!$request) {
  233.             return null;
  234.         }
  236.         $this->snippetSetId = $request->attributes->get(SalesChannelRequest::ATTRIBUTE_DOMAIN_SNIPPET_SET_ID);
  238.         return $this->snippetSetId;
  239.     }
  241.     /**
  242.      * @return array<int, MessageCatalogueInterface>
  243.      */
  244.     public function getCatalogues(): array
  245.     {
  246.         return array_values($this->isCustomized);
  247.     }
  249.     private function isFallbackLocaleCatalogue(MessageCatalogueInterface $catalog, string $fallbackLocale): bool
  250.     {
  251.         return mb_strpos($catalog->getLocale(), $fallbackLocale) === 0;
  252.     }
  254.     /**
  255.      * Shopware uses dashes in all locales
  256.      * if the catalogue does not contain any dashes it means it is a symfony fallback catalogue
  257.      * in that case we should not add the shopware fallback catalogue as it would result in circular references
  258.      */
  259.     private function isShopwareLocaleCatalogue(MessageCatalogueInterface $catalog): bool
  260.     {
  261.         return mb_strpos($catalog->getLocale(), '-') !== false;
  262.     }
  264.     private function resolveSnippetSetId(string $salesChannelId, string $languageId, string $locale, Context $context): void
  265.     {
  266.         $snippetSet = $this->snippetService->getSnippetSet($salesChannelId, $languageId, $locale, $context);
  267.         if ($snippetSet === null) {
  268.             $this->snippetSetId = null;
  269.         } else {
  270.             $this->snippetSetId = $snippetSet->getId();
  271.         }
  272.     }
  274.     /**
  275.      * Add language specific snippets provided by the admin
  276.      */
  277.     private function getCustomizedCatalog(MessageCatalogueInterface $catalog, ?string $fallbackLocale, ?string $locale = null): MessageCatalogueInterface
  278.     {
  279.         $snippetSetId = $this->getSnippetSetId($locale);
  281.         if (!$snippetSetId) {
  282.             return $catalog;
  283.         }
  285.         if (\array_key_exists($snippetSetId, $this->isCustomized)) {
  286.             return $this->isCustomized[$snippetSetId];
  287.         }
  289.         $snippets = $this->loadSnippets($catalog, $snippetSetId, $fallbackLocale);
  291.         $newCatalog = clone $catalog;
  292.         $newCatalog->add($snippets);
  294.         return $this->isCustomized[$snippetSetId] = $newCatalog;
  295.     }
  297.     /**
  298.      * @return array<string, string>
  299.      */
  300.     private function loadSnippets(MessageCatalogueInterface $catalog, string $snippetSetId, ?string $fallbackLocale): array
  301.     {
  302.         $this->resolveSalesChannelId();
  304.         $key = sprintf('translation.catalog.%s.%s', $this->salesChannelId ?: 'DEFAULT', $snippetSetId);
  306.         return $this->cache->get($key, function (ItemInterface $item) use ($catalog, $snippetSetId, $fallbackLocale) {
  307.             $item->tag('translation.catalog.' . $snippetSetId);
  308.             $item->tag(sprintf('translation.catalog.%s', $this->salesChannelId ?: 'DEFAULT'));
  310.             return $this->snippetService->getStorefrontSnippets($catalog, $snippetSetId, $fallbackLocale, $this->salesChannelId);
  311.         });
  312.     }
  314.     private function getFallbackLocale(): string
  315.     {
  316.         try {
  317.             return $this->languageLocaleProvider->getLocaleForLanguageId(Defaults::LANGUAGE_SYSTEM);
  318.         } catch (ConnectionException) {
  319.             // this allows us to use the translator even if there's no db connection yet
  320.             return 'en-GB';
  321.         }
  322.     }
  324.     private function resolveSalesChannelId(): void
  325.     {
  326.         if ($this->salesChannelId !== null) {
  327.             return;
  328.         }
  330.         $request = $this->requestStack->getCurrentRequest();
  332.         if (!$request) {
  333.             return;
  334.         }
  336.         $this->salesChannelId = $request->attributes->get(PlatformRequest::ATTRIBUTE_SALES_CHANNEL_ID);
  337.     }
  338. }