Feat/aut 3675/add support to solar UI locales

actions/form/class.Instance.php

@@ -27,6 +27,7 @@
 use oat\oatbox\service\ServiceManager;
 use oat\tao\helpers\form\ElementMapFactory;
 use oat\tao\helpers\form\elements\ElementValue;
+use oat\tao\helpers\LocaleFilesHelper;
 use oat\tao\model\form\DataProvider\FormDataProviderInterface;
 use oat\tao\model\form\DataProvider\ProxyFormDataProvider;
 use Zend\ServiceManager\ServiceLocatorInterface;
@@ -44,7 +45,6 @@ class tao_actions_form_Instance extends tao_actions_form_Generis
     use OntologyAwareTrait;
 
     public const EXCLUDED_PROPERTIES = 'excludedProperties';
-
     /**
      * Initialize the form
      *
@@ -91,6 +91,7 @@ protected function initElements()
         } catch (common_exception_Error $exception) {
             $language = DEFAULT_LANG;
         }
+        $language = LocaleFilesHelper::checkPostfixDirectory($language);
 
         $topClass = $this->getTopClazz();
 

helpers/LayoutHelper.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA;
+ */
+
+namespace oat\tao\helpers;
+
+class LayoutHelper
+{
+    public function isSolarDesignEnabled(): bool
+    {
+        return Layout::isSolarDesignEnabled();
+    }
+}

helpers/LocaleFilesHelper.php

@@ -0,0 +1,78 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA ;
+ */
+
+namespace oat\tao\helpers;
+
+class LocaleFilesHelper
+{
+    public const LANG_POSTFIX = '-S';
+
+    /**
+     * Check if the Solar design is enabled and the postfix has not yet been added
+     */
+    public static function isContainPostfix(string $language): bool
+    {
+        $pattern = sprintf('/%s$/', self::LANG_POSTFIX);
+
+        return !Layout::isSolarDesignEnabled() || preg_match($pattern, $language) === 1;
+    }
+
+    /**
+     * Concatenate postfix for Solar design translations
+     */
+    protected static function addPostfix(string $language): string
+    {
+        return $language . self::LANG_POSTFIX;
+    }
+
+    /**
+     * Check and add postfix for Solar design translations
+     */
+    public static function checkPostfix(string $language): string
+    {
+        if (!self::isContainPostfix($language)) {
+            $language = self::addPostfix($language);
+        }
+
+        return $language;
+    }
+
+    /**
+     * Check and add postfix for Solar design translations
+     */
+    public static function checkPostfixDirectory(string $language): string
+    {
+        if (self::isContainPostfix($language)) {
+            return $language;
+        }
+        $localesDir = 'views/locales';
+        $dir = sprintf('%s/../%s/%s', dirname(__FILE__), $localesDir, self::addPostfix($language));
+        if (is_dir($dir)) {
+            return self::addPostfix($language);
+        }
+
+        return $language;
+    }
+
+    public static function isPostfixApplied($localeDir, $pattern = null): bool
+    {
+        return null !== $pattern && preg_match($pattern, $localeDir) === 1;
+    }
+}

helpers/ServiceProvider/HelperServiceProvider.php

@@ -15,7 +15,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2023 (original work) Open Assessment Technologies SA.
+ * Copyright (c) 2023-2024 (original work) Open Assessment Technologies SA.
  *
  * @author Andrei Shapiro <andrei.shapiro@taotesting.com>
  */
@@ -26,9 +26,12 @@
 
 use oat\generis\model\DependencyInjection\ContainerServiceProviderInterface;
 use oat\tao\helpers\dateFormatter\DateFormatterFactory;
+use oat\tao\helpers\translation\SolarThemeFileHelper;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
 use tao_helpers_Mode;
 
+use function Symfony\Component\DependencyInjection\Loader\Configurator\service;
+
 class HelperServiceProvider implements ContainerServiceProviderInterface
 {
     public function __invoke(ContainerConfigurator $configurator): void
@@ -38,5 +41,7 @@ public function __invoke(ContainerConfigurator $configurator): void
         $services->set(DateFormatterFactory::class, DateFormatterFactory::class);
 
         $services->set(tao_helpers_Mode::class, tao_helpers_Mode::class);
+
+        $services->set(SolarThemeFileHelper::class, SolarThemeFileHelper::class);
     }
 }

helpers/class.I18n.php

@@ -24,6 +24,7 @@
  */
 
 use oat\generis\model\OntologyRdf;
+use oat\tao\helpers\LocaleFilesHelper;
 
 /**
  * Internationalization helper.
@@ -60,6 +61,7 @@ public static function init(common_ext_Extension $extension, ?string $langCode):
         if (empty($langCode)) {
             throw new Exception("Language is not defined");
         }
+        $langCode = LocaleFilesHelper::checkPostfixDirectory($langCode);
 
         //init the ClearFw l10n tools
         $translations = tao_models_classes_LanguageService::singleton()->getServerBundle($langCode);
@@ -78,7 +80,9 @@ public static function init(common_ext_Extension $extension, ?string $langCode):
      */
     public static function getLangCode()
     {
-        return common_session_SessionManager::getSession()->getInterfaceLanguage();
+        return LocaleFilesHelper::checkPostfixDirectory(
+            common_session_SessionManager::getSession()->getInterfaceLanguage()
+        );
     }
 
     /**

helpers/translation/SolarThemeFileHelper.php

@@ -0,0 +1,35 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA ;
+ */
+
+namespace oat\tao\helpers\translation;
+
+use oat\tao\helpers\LocaleFilesHelper;
+
+class SolarThemeFileHelper implements SolarThemeHelperInterface
+{
+    /**
+     * Check and add postfix for Solar design translations
+     *
+     */
+    public function checkPostfix(string $language): string
+    {
+        return LocaleFilesHelper::checkPostfixDirectory($language);
+    }
+}

helpers/translation/SolarThemeHelper.php

@@ -0,0 +1,34 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA ;
+ */
+
+namespace oat\tao\helpers\translation;
+
+use oat\tao\helpers\LocaleFilesHelper;
+
+class SolarThemeHelper implements SolarThemeHelperInterface
+{
+    /**
+     * Check and add postfix for Solar design translations
+     */
+    public function checkPostfix(string $language): string
+    {
+        return LocaleFilesHelper::checkPostfix($language);
+    }
+}

helpers/translation/SolarThemeHelperInterface.php

@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; under version 2
+ * of the License (non-upgradable).
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ *
+ * Copyright (c) 2024 (original work) Open Assessment Technologies SA ;
+ */
+
+namespace oat\tao\helpers\translation;
+
+interface SolarThemeHelperInterface
+{
+    /**
+     * Check and add postfix for Solar design translations
+     *
+     */
+    public function checkPostfix(string $language): string;
+}

models/classes/class.LanguageService.php

@@ -25,6 +25,7 @@
  */
 
 use oat\generis\model\OntologyRdf;
+use oat\tao\helpers\LocaleFilesHelper;
 use oat\tao\helpers\translation\TranslationBundle;
 use oat\generis\model\data\ModelManager;
 use oat\tao\helpers\translation\rdf\RdfPack;
@@ -52,6 +53,7 @@ class tao_models_classes_LanguageService extends tao_models_classes_GenerisServi
     public const INSTANCE_ORIENTATION_LTR = 'http://www.tao.lu/Ontologies/TAO.rdf#OrientationLeftToRight';
     public const INSTANCE_ORIENTATION_RTL = 'http://www.tao.lu/Ontologies/TAO.rdf#OrientationRightToLeft';
     // --- OPERATIONS ---
+    public const LANG_POSTFIX = '-S';
 
     /**
      * Short description of method createLanguage
@@ -351,7 +353,7 @@ public static function getExistingLanguageUri($value)
      *
      * @return array of ns => files
      */
-    private function getLanguageFiles()
+    private function getLanguageFiles($pattern = null)
     {
         $extManager = $this->getServiceLocator()->get(common_ext_ExtensionsManager::SERVICE_ID);
         $localesPath = $extManager->getExtensionById('tao')->getDir() . 'locales';
@@ -363,7 +365,7 @@ private function getLanguageFiles()
         $localeDirectories = scandir($localesPath);
         foreach ($localeDirectories as $localeDir) {
             $path = $localesPath . '/' . $localeDir;
-            if ($localeDir[0] != '.' && @is_dir($path)) {
+            if ($this->isValidDirectory($path, $localeDir, $pattern)) {
                 // Look if the lang.rdf can be read.
                 $languageModelFile = $path . '/lang.rdf';
                 if (@file_exists($languageModelFile) && @is_readable($languageModelFile)) {
@@ -374,14 +376,32 @@ private function getLanguageFiles()
         return $files;
     }
 
+
+    /**
+     * Check the path is directory
+     */
+    private function isDirectory(string $path, array $localeDir): bool
+    {
+        return $localeDir[0] != '.' && @is_dir($path);
+    }
+
+    /**
+     * Check the directory is valid
+     */
+    private function isValidDirectory(string $path, array $localeDir, string $pattern): bool
+    {
+        return $this->isDirectory($path, $localeDir) && !LocaleFilesHelper::isPostfixApplied($localeDir, $pattern);
+    }
+
     /**
      * Return the definition of the languages as an RDF iterator
      * @return AppendIterator
      */
     public function getLanguageDefinition()
     {
         $model = new AppendIterator();
-        foreach ($this->getLanguageFiles() as $rdfPath) {
+        $pattern = sprintf('/%s$/', self::LANG_POSTFIX);
+        foreach ($this->getLanguageFiles($pattern) as $rdfPath) {
             $iterator = new FileIterator($rdfPath);
             $model->append($iterator->getIterator());
         }

models/classes/clientConfig/ClientConfigServiceProvider.php

@@ -15,7 +15,7 @@
  * along with this program; if not, write to the Free Software
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  *
- * Copyright (c) 2023 (original work) Open Assessment Technologies SA.
+ * Copyright (c) 2023-2024 (original work) Open Assessment Technologies SA.
  *
  * @author Andrei Shapiro <andrei.shapiro@taotesting.com>
  */
@@ -30,6 +30,7 @@
 use oat\oatbox\session\SessionService;
 use oat\oatbox\user\UserLanguageServiceInterface;
 use oat\tao\helpers\dateFormatter\DateFormatterFactory;
+use oat\tao\helpers\translation\SolarThemeFileHelper;
 use oat\tao\model\asset\AssetService;
 use oat\tao\model\ClientLibRegistry;
 use oat\tao\model\featureFlag\FeatureFlagConfigSwitcher;
@@ -67,6 +68,7 @@ public function __invoke(ContainerConfigurator $configurator): void
                     service(tao_helpers_Mode::class),
                     service(DateFormatterFactory::class),
                     service(MenuService::class),
+                    service(SolarThemeFileHelper::class),
                 ]
             );
     }