Add a class responsible for loading language resources to the translator

classes/Context.php

@@ -25,12 +25,11 @@
  */
 use PrestaShop\PrestaShop\Adapter\SymfonyContainer;
 use PrestaShop\PrestaShop\Core\Localization\Locale;
-use PrestaShopBundle\Translation\Loader\SqlTranslationLoader;
 use PrestaShopBundle\Translation\TranslatorComponent as Translator;
+use PrestaShopBundle\Translation\TranslatorLanguageLoader;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\Filesystem\Filesystem;
 use Symfony\Component\Finder\Finder;
-use Symfony\Component\Translation\Loader\XliffFileLoader;
 
 /**
  * Class ContextCore.
@@ -422,49 +421,13 @@ public function getTranslatorFromLocale($locale)
             (new Filesystem())->remove($cache_file);
         }
 
-        $adminContext = defined('_PS_ADMIN_DIR_');
-        $translator->addLoader('xlf', new XliffFileLoader());
-
-        $sqlTranslationLoader = new SqlTranslationLoader();
-        if (null !== $this->shop) {
-            $sqlTranslationLoader->setTheme($this->shop->theme);
-        }
-
-        $translator->addLoader('db', $sqlTranslationLoader);
-        $notName = $adminContext ? '^Shop*' : '^Admin*';
-
-        $finder = Finder::create()
-            ->files()
-            ->name('*.' . $locale . '.xlf')
-            ->notName($notName)
-            ->in($this->getTranslationResourcesDirectories());
+        $translator->resetCatalogue($locale);
 
-        foreach ($finder as $file) {
-            list($domain, $locale, $format) = explode('.', $file->getBasename(), 3);
-
-            $translator->addResource($format, $file, $locale, $domain);
-            if (!$this->language instanceof PrestashopBundle\Install\Language) {
-                $translator->addResource('db', $domain . '.' . $locale . '.db', $locale, $domain);
-            }
-        }
+        $adminContext = defined('_PS_ADMIN_DIR_');
+        $withDB = !$this->language instanceof PrestashopBundle\Install\Language;
+        $theme = $this->shop !== null ? $this->shop->theme : null;
+        (new TranslatorLanguageLoader($adminContext))->loadLanguage($translator, $locale, $withDB, $theme);
 
         return $translator;
     }
-
-    /**
-     * @return array
-     */
-    protected function getTranslationResourcesDirectories()
-    {
-        $locations = array(_PS_ROOT_DIR_ . '/app/Resources/translations');
-
-        if (null !== $this->shop) {
-            $activeThemeLocation = _PS_ROOT_DIR_ . '/themes/' . $this->shop->theme_name . '/translations';
-            if (is_dir($activeThemeLocation)) {
-                $locations[] = $activeThemeLocation;
-            }
-        }
-
-        return $locations;
-    }
 }

classes/lang/DataLang.php

@@ -24,8 +24,7 @@
  * International Registered Trademark & Property of PrestaShop SA
  */
 use PrestaShopBundle\Translation\TranslatorComponent as Translator;
-use Symfony\Component\Finder\Finder;
-use Symfony\Component\Translation\Loader\XliffFileLoader;
+use PrestaShopBundle\Translation\TranslatorLanguageLoader;
 
 class DataLangCore
 {
@@ -49,20 +48,10 @@ public function __construct($locale)
         $this->locale = $locale;
 
         $this->translator = Context::getContext()->getTranslator();
-        $translatorLocale = $this->translator->getLocale();
+        $isAdminContext = defined('_PS_ADMIN_DIR_');
 
-        if ($translatorLocale !== $this->locale) {
-            $this->translator->addLoader('xlf', new XliffFileLoader());
-
-            $finder = Finder::create()
-                ->files()
-                ->name('*.' . $this->locale . '.xlf')
-                ->in((_PS_ROOT_DIR_ . '/app/Resources/translations'));
-
-            foreach ($finder as $file) {
-                list($domain, $locale, $format) = explode('.', $file->getBasename(), 3);
-                $this->translator->addResource($format, $file, $locale, $domain);
-            }
+        if ($this->locale !== $this->translator->getLocale()) {
+            (new TranslatorLanguageLoader($isAdminContext))->loadLanguage($this->translator, $this->locale);
         }
     }
 

src/Core/Domain/MailTemplate/CommandHandler/GenerateThemeMailTemplatesCommandHandler.php

@@ -33,7 +33,6 @@
 use PrestaShop\PrestaShop\Core\MailTemplate\MailTemplateGenerator;
 use PrestaShop\PrestaShop\Core\MailTemplate\ThemeCatalogInterface;
 use PrestaShop\PrestaShop\Core\MailTemplate\ThemeInterface;
-use Symfony\Component\Translation\Loader\ArrayLoader;
 use Symfony\Component\Translation\TranslatorInterface;
 
 /**
@@ -99,34 +98,9 @@ public function handle(GenerateThemeMailTemplatesCommand $command)
         /** @var ThemeInterface $theme */
         $theme = $this->themeCatalog->getByName($command->getThemeName());
 
-        $this->cleanTranslatorLocaleCache($command->getLanguage());
-
         $coreMailsFolder = $command->getCoreMailsFolder() ?: $this->defaultCoreMailsFolder;
         $modulesMailFolder = $command->getModulesMailFolder() ?: $this->defaultModulesMailFolder;
 
         $this->generator->generateTemplates($theme, $language, $coreMailsFolder, $modulesMailFolder, $command->overwriteTemplates());
     }
-
-    /**
-     * When installing a new Language, if it's a new one the Translator component can't manage it because its cache is
-     * already filled with the default one as fallback. We force the component to update its cache by adding a fake
-     * resource for this locale (this is the only way clean its local cache)
-     *
-     * @param string $locale
-     */
-    private function cleanTranslatorLocaleCache($locale)
-    {
-        if (!method_exists($this->translator, 'addLoader')
-            || !method_exists($this->translator, 'addResource')
-        ) {
-            return;
-        }
-
-        $this->translator->addLoader('array', new ArrayLoader());
-        $this->translator->addResource(
-            'array',
-            ['Fake clean cache message' => 'Fake clean cache message'],
-            $locale
-        );
-    }
 }

src/PrestaShopBundle/Translation/DataCollectorTranslator.php

@@ -29,7 +29,7 @@
 
 use Symfony\Component\Translation\DataCollectorTranslator as BaseTranslator;
 
-class DataCollectorTranslator extends BaseTranslator
+class DataCollectorTranslator extends BaseTranslator implements PrestaShopTranslatorInterface
 {
     use PrestaShopTranslatorTrait;
 }

src/PrestaShopBundle/Translation/PrestaShopTranslatorInterface.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * 2007-2019 PrestaShop SA and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://www.prestashop.com for more information.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2019 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShopBundle\Translation;
+
+use Symfony\Component\Translation\TranslatorInterface;
+
+/**
+ * Interface PrestaShopTranslatorInterface used by PrestaShop translators
+ */
+interface PrestaShopTranslatorInterface extends TranslatorInterface
+{
+    /**
+     * @param string $locale
+     *
+     * @return bool
+     */
+    public function isCatalogLoaded($locale);
+
+    /**
+     * @param string $locale
+     */
+    public function resetCatalogue($locale);
+}

src/PrestaShopBundle/Translation/PrestaShopTranslatorTrait.php

@@ -130,6 +130,24 @@ public function transChoice($id, $number, array $parameters = array(), $domain =
         return vsprintf(parent::transChoice($id, $number, array(), $domain, $locale), $parameters);
     }
 
+    /**
+     * @param string $locale
+     *
+     * @return bool
+     */
+    public function isCatalogLoaded($locale)
+    {
+        return !empty($this->catalogues[$locale]);
+    }
+
+    /**
+     * @param string $locale
+     */
+    public function resetCatalogue($locale)
+    {
+        unset($this->catalogues[$locale]);
+    }
+
     /**
      * @param string $string
      *

src/PrestaShopBundle/Translation/Translator.php

@@ -32,7 +32,7 @@
 /**
  * Replacement for the original Symfony FrameworkBundle translator
  */
-class Translator extends BaseTranslator
+class Translator extends BaseTranslator implements PrestaShopTranslatorInterface
 {
     use PrestaShopTranslatorTrait;
 

src/PrestaShopBundle/Translation/TranslatorComponent.php

@@ -32,7 +32,7 @@
 /**
  * Translator used by Context
  */
-class TranslatorComponent extends BaseTranslatorComponent
+class TranslatorComponent extends BaseTranslatorComponent implements PrestaShopTranslatorInterface
 {
     use PrestaShopTranslatorTrait;
 }

src/PrestaShopBundle/Translation/TranslatorLanguageLoader.php

@@ -0,0 +1,107 @@
+<?php
+
+/**
+ * 2007-2019 PrestaShop SA and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.txt.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://www.prestashop.com for more information.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2019 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
+
+namespace PrestaShopBundle\Translation;
+
+use PrestaShop\PrestaShop\Core\Addon\Theme\Theme;
+use PrestaShopBundle\Translation\Loader\SqlTranslationLoader;
+use Symfony\Component\Finder\Finder;
+use Symfony\Component\Translation\Loader\XliffFileLoader;
+
+class TranslatorLanguageLoader
+{
+    /**
+     * @var bool
+     */
+    private $isAdminContext;
+
+    /**
+     * TranslatorLanguageLoader constructor.
+     *
+     * @param $isAdminContext
+     */
+    public function __construct($isAdminContext)
+    {
+        $this->isAdminContext = $isAdminContext;
+    }
+
+    /**
+     * Loads a language into a translator
+     *
+     * @param PrestaShopTranslatorInterface $translator
+     * @param string $locale
+     * @param bool $withDB
+     * @param Theme|null $theme
+     */
+    public function loadLanguage(PrestaShopTranslatorInterface $translator, $locale, $withDB = true, Theme $theme = null)
+    {
+        if (!$translator->isCatalogLoaded($locale)) {
+            $translator->addLoader('xlf', new XliffFileLoader());
+
+            if ($withDB) {
+                $sqlTranslationLoader = new SqlTranslationLoader();
+                if (null !== $theme) {
+                    $sqlTranslationLoader->setTheme($theme);
+                }
+                $translator->addLoader('db', $sqlTranslationLoader);
+            }
+
+            $finder = Finder::create()
+                ->files()
+                ->name('*.' . $locale . '.xlf')
+                ->notName($this->isAdminContext ? '^Shop*' : '^Admin*')
+                ->in($this->getTranslationResourcesDirectories($theme));
+
+            foreach ($finder as $file) {
+                list($domain, $locale, $format) = explode('.', $file->getBasename(), 3);
+                $translator->addResource($format, $file, $locale, $domain);
+                if ($withDB) {
+                    $translator->addResource('db', $domain . '.' . $locale . '.db', $locale, $domain);
+                }
+            }
+        }
+    }
+
+    /**
+     * @param Theme|null $theme
+     *
+     * @return array
+     */
+    protected function getTranslationResourcesDirectories(Theme $theme = null)
+    {
+        $locations = [_PS_ROOT_DIR_ . '/app/Resources/translations'];
+
+        if (null !== $theme) {
+            $activeThemeLocation = $theme->getDirectory() . '/translations';
+            if (is_dir($activeThemeLocation)) {
+                $locations[] = $activeThemeLocation;
+            }
+        }
+
+        return $locations;
+    }
+}