[dashboard/multilingual] Add multilingual config settings (#9994)

This adds the backend infrastructure to allow multilingual config
settings with different values per language, so that pages such as the
project description on the dashboard can be localized.

ConfigSetting now has a "Multilingual" boolean flag to determine if the
config setting should be localizable. If it is multilingual, a new
`getMultilingualSetting` method on the NDB_Config object can be used to
get the value for a particular language code.

Translated strings are stored in a new "ConfigI18n" table (the casing
follows the standard of the Config tables, not the language table for
internal consistency.) When a translated version does not exist, the
`getMultilingualSetting` function will fall back to the non-localized
getSetting value.

There is not currently a frontend infrastructure to populate ConfigI18n.
The values must be done on the backend.

Author: driusan

SQL/0000-00-03-ConfigTables.sql

@@ -12,10 +12,21 @@ CREATE TABLE `ConfigSettings` (
     `Parent` int(11) DEFAULT NULL,
     `Label` varchar(255) DEFAULT NULL,
     `OrderNumber` int(11) DEFAULT NULL,
+    `Multilingual` boolean DEFAULT false,
     PRIMARY KEY (`ID`),
     UNIQUE KEY `Name` (`Name`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 
+CREATE TABLE `ConfigI18n` (
+  `Value` text NOT NULL,
+  `ConfigID` int(11) DEFAULT NULL,
+  `LanguageID` int(10) unsigned DEFAULT NULL,
+  KEY `ConfigID` (`ConfigID`),
+  KEY `LanguageID` (`LanguageID`),
+  CONSTRAINT `ConfigI18n_ibfk_1` FOREIGN KEY (`ConfigID`) REFERENCES `ConfigSettings` (`ID`),
+  CONSTRAINT `ConfigI18n_ibfk_2` FOREIGN KEY (`LanguageID`) REFERENCES `language` (`language_id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
 
 CREATE TABLE `Config` (
   `ID` int(11) NOT NULL AUTO_INCREMENT,
@@ -88,7 +99,7 @@ INSERT INTO ConfigSettings (Name, Description, Visible, AllowMultiple, DataType,
 
 
 INSERT INTO ConfigSettings (Name, Description, Visible, AllowMultiple, Label, OrderNumber) VALUES ('dashboard', 'Settings that affect the appearance of the dashboard and its charts', 1, 0, 'Dashboard', 5);
-INSERT INTO ConfigSettings (Name, Description, Visible, AllowMultiple, DataType, Parent, Label, OrderNumber) SELECT 'projectDescription', 'Description of the study displayed in main dashboard panel', 1, 0, 'textarea', ID, 'Project Description', 1 FROM ConfigSettings WHERE Name="dashboard";
+INSERT INTO ConfigSettings (Name, Description, Visible, AllowMultiple, DataType, Parent, Label, OrderNumber, Multilingual) SELECT 'projectDescription', 'Description of the study displayed in main dashboard panel', 1, 0, 'textarea', ID, 'Project Description', 1, true FROM ConfigSettings WHERE Name="dashboard";
 INSERT INTO ConfigSettings (Name, Description, Visible, AllowMultiple, DataType, Parent, Label, OrderNumber) SELECT 'recruitmentTarget', 'Target number of participants for the study', 1, 0, 'text', ID, 'Target number of participants', 2 FROM ConfigSettings WHERE Name="dashboard";
 
 INSERT INTO ConfigSettings (Name, Description, Visible, AllowMultiple, Label, OrderNumber) VALUES ('imaging_modules', 'DICOM Archive and Imaging Browser settings', 1, 0, 'Imaging Modules', 6);

SQL/New_patches/2025-09-03-multilingualconfig.sql

@@ -0,0 +1,16 @@
+ALTER table ConfigSettings ADD COLUMN Multilingual boolean DEFAULT false;
+UPDATE ConfigSettings SET Multilingual=true WHERE Name='projectDescription';
+
+CREATE TABLE `ConfigI18n` (
+  `Value` text NOT NULL,
+  `ConfigID` int(11) DEFAULT NULL,
+  `LanguageID` int(10) unsigned DEFAULT NULL,
+  KEY `ConfigID` (`ConfigID`),
+  KEY `LanguageID` (`LanguageID`),
+  CONSTRAINT `ConfigI18n_ibfk_1` FOREIGN KEY (`ConfigID`) REFERENCES `ConfigSettings` (`ID`),
+  CONSTRAINT `ConfigI18n_ibfk_2` FOREIGN KEY (`LanguageID`) REFERENCES `language` (`language_id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;
+
+-- Sample translation of projectDescription for testing. We do not have a
+-- foreign key value in the 'language' table to add it to RB.
+-- INSERT INTO ConfigI18n VALUES ('このデータベースは、様々な場所で収集された画像データと行動データの両方をオンラインで保存するための仕組みを提供します。このフレームワークには、このプロセスを可能な限り効率的かつシンプルにするためのツールがいくつか用意されています。データベースに関する詳細な情報については、右上のヘルプアイコンをクリックしてください。それ以外の場合は、DCCまでお気軽にお問い合わせください。私たちは、データ収集を楽しいものにすることを目指しています。', 48, 2)

modules/dashboard/php/projectdescription.class.inc

@@ -21,7 +21,8 @@ class ProjectDescription extends \LORIS\Http\Endpoint
      */
     public function handle(ServerRequestInterface $request) : ResponseInterface
     {
-        $desc = $this->loris->getConfiguration()->getSetting('projectDescription');
+        $settings = \NDB_Factory::singleton()->settings();
+        $desc     = $settings->projectDescription($request->getAttribute("user"));
         return new \LORIS\Http\Response\JSON\OK(['Description' => $desc]);
     }
 

php/libraries/NDB_Config.class.inc

@@ -434,6 +434,69 @@ class NDB_Config
 
     }
 
+    /**
+     * Gets a config setting which may have variations in different languages.
+     *
+     * Translated strings have some restrictions that do not apply to
+     * getConfig()
+     *
+     * 1. The config name must be a direct setting and not a hierarchical one
+     * 2. The return type must be a string (otherwise what are you translating?)
+     * 3. The value must come from the database, and not config.xml
+     *
+     * If a config setting value does not exist in a localized format for
+     * $langcode, this function will fall back on the "default" (generally
+     * English) getSetting() value for $name.
+     *
+     * @param string $langcode The language of the setting to retrieve
+     * @param string $name     The config setting name
+     *
+     * @return string
+     */
+    function getMultilingualSetting(string $langcode, string $name): string
+    {
+        if (isset($this->settingCache[$name][$langcode])) {
+            return $this->settingCache[$name][$langcode];
+        }
+
+        $factory = NDB_Factory::singleton();
+
+        $db = $factory->database();
+        // Verify that it's really a multilingual setting.
+        $configSetting = $db->pselect(
+            "SELECT ID, AllowMultiple
+	     FROM ConfigSettings cs
+             WHERE cs.Name=:nm AND Multilingual=true",
+            ["nm" => $name]
+        );
+
+        if (count($configSetting) !== 1) {
+            throw new ConfigurationException(
+                "Config setting $name does not exist in database "
+                . "as a multilingual setting"
+            );
+        }
+
+        $localizedVal = $db->pselectOne(
+            "SELECT Value FROM ConfigI18n i18n
+                   JOIN language l ON (l.language_id=i18n.LanguageID)
+            WHERE l.language_code=:lc AND i18n.ConfigID=:cid",
+            [
+                'lc'  => $langcode,
+                'cid' => $configSetting->getFirstRow()['ID'],
+            ]
+        );
+
+        if ($localizedVal !== null) {
+            $this->settingCache[$name] = [$langcode => $localizedVal];
+            return $localizedVal;
+        }
+
+        // Fallback on the unlocalized setting value.
+        $this->settingCache[$name] = [$langcode => $this->getSetting($name)];
+        return $this->settingCache[$name][$langcode];
+    }
+
     /**
      * Helper function to determine whether a setting with a boolean value is
      * enabled, i.e. equal to "true".

php/libraries/Settings.class.inc

@@ -81,6 +81,22 @@ class Settings
         return $this->_getBooleanSetting('sandbox');
     }
 
+    /**
+     * Get the project description which is displayed on the dashboard
+     * for a user.
+     *
+     * @param \User $user The user seeing the description.
+     *
+     * @return string
+     */
+    public function projectDescription(\User $user): string
+    {
+        return $this->_config->getMultilingualSetting(
+            $user->getLanguageCode(),
+            "projectDescription"
+        );
+    }
+
     /**
      * Get database name from config
      *

raisinbread/RB_files/RB_Config.sql

@@ -1,3 +1,4 @@
+/*M!999999\- enable the sandbox mode */ 
 SET FOREIGN_KEY_CHECKS=0;
 TRUNCATE TABLE `Config`;
 LOCK TABLES `Config` WRITE;

raisinbread/RB_files/RB_ConfigI18n.sql

@@ -0,0 +1,6 @@
+/*M!999999\- enable the sandbox mode */ 
+SET FOREIGN_KEY_CHECKS=0;
+TRUNCATE TABLE `ConfigI18n`;
+LOCK TABLES `ConfigI18n` WRITE;
+UNLOCK TABLES;
+SET FOREIGN_KEY_CHECKS=1;