Add support for VPN Client

Author: flodolo

app/classes/Transvision/AnalyseStrings.php

@@ -60,6 +60,8 @@ public static function differences($tmx_source, $tmx_target, $repo, $ignored_str
             'properties'  => '/(?<!%[0-9]|\{\s|\{)(\$[A-Za-z0-9\.]+)\b/',
             // %1$s or %s. %d
             'xml_android' => '/(%(?:[0-9]+\$){0,1}([sd]))/',
+            // %1, %2, etc.
+            'xliff-qt'    => '/(%[0-9])/',
         ];
         $repo_patterns = Project::$repos_info[$repo]['variable_patterns'];
 

app/classes/Transvision/Project.php

@@ -82,6 +82,16 @@ class Project
             'source_type'       => 'xml',
             'variable_patterns' => ['xml_android'],
         ],
+        'vpn_client' => [
+            'files'             => [
+                'mozillavpn.xliff',
+            ],
+            'git_repository'    => 'mozilla-vpn-client-l10n',
+            'pontoon_project'   => 'mozilla-vpn-client',
+            'reference_locale'  => 'en',
+            'source_type'       => 'xliff',
+            'variable_patterns' => ['xliff-qt'],
+        ],
     ];
 
     /*
@@ -95,7 +105,7 @@ class Project
         ],
         // Products using Git
         'git' => [
-            'android_l10n', 'firefox_ios', 'mozilla_org',
+            'android_l10n', 'firefox_ios', 'mozilla_org', 'vpn_client',
         ],
         // Products using free text search on Pontoon
         'text_search' => [

app/classes/Transvision/Xliff.php

@@ -14,12 +14,13 @@ class Xliff
      *
      * Loads strings from a .xliff file
      *
-     * @param string $xliff_path   Path to the .xliff to load
-     * @param string $project_name The project this string belongs to
+     * @param string  $xliff_path       Path to the .xliff to load
+     * @param string  $project_name     The project this string belongs to
+     * @param boolean $reference_locale If the current file belongs to the reference locale
      *
      * @return array Array of strings as [string_id => translation]
      */
-    public static function getStrings($xliff_path, $project_name)
+    public static function getStrings($xliff_path, $project_name, $reference_locale = false)
     {
         $strings = [];
         if ($xml = simplexml_load_file($xliff_path)) {
@@ -36,7 +37,10 @@ public static function getStrings($xliff_path, $project_name)
                 $file_orig = $file_node[0]['original'];
 
                 $string_id = self::generateStringID($project_name, $file_name, $file_orig, $trans_unit['id']);
-                $translation = str_replace("'", "\\'", $trans_unit->target);
+                // If it's the reference locale, we use the source instead of the target
+                $translation = $reference_locale
+                    ? str_replace("'", "\\'", $trans_unit->source)
+                    : str_replace("'", "\\'", $trans_unit->target);
 
                 $strings[$string_id] = $translation;
             }

app/scripts/bash_variables.sh

@@ -16,7 +16,8 @@ folders+=( $gecko_strings_path $sources_path )
 mozilla_org=$local_git/mozilla_org/
 folders+=( $mozilla_org )
 
-# Firefox for iOS, Android-l10n
-firefox_ios=$local_git/firefox_ios/
+# Firefox for iOS, Android-l10n, VPN Client
 android_l10n=$local_git/android_l10n/
-folders+=( $firefox_ios $android_l10n)
+firefox_ios=$local_git/firefox_ios/
+vpn_client=$local_git/vpn_client/
+folders+=( $firefox_ios $android_l10n $vpn_client)

app/scripts/glossaire.sh

@@ -311,6 +311,7 @@ source $install/python-venv/bin/activate || exit 1
 updateGeckoStringsChannelRepo
 updateMozOrg
 updateOtherProduct firefox_ios "Firefox for iOS" tmx_xliff
+updateOtherProduct vpn_client "Mozilla VPN Client" tmx_xliff
 updateAndroidl10n
 
 # Create a file to get the timestamp of the last string extraction for caching

app/scripts/setup.sh

@@ -165,10 +165,17 @@ fi
 cd $android_l10n
 if [ ! -d $android_l10n/.git ]
 then
-    echogreen "Checking out Focus for android-l10n repo"
+    echogreen "Checking out android-l10n repo"
     git clone https://github.com/mozilla-l10n/android-l10n .
 fi
 
+cd $vpn_client
+if [ ! -d $vpn_client/.git ]
+then
+    echogreen "Checking out VPN Client repo"
+    git clone https://github.com/mozilla-l10n/mozilla-vpn-client-l10n .
+fi
+
 # Add .htaccess to download folder. Folder should already exists, but check in
 # advance to be sure. I overwrite an existing .htaccess if already present.
 echogreen "Add .htaccess to download folder"

app/scripts/tmx/tmx_xliff

@@ -43,7 +43,12 @@ foreach (Files::getFoldersInPath($base_path, ['templates']) as $locale) {
     foreach ($repo_data['files'] as $file_name) {
         $xliff_path = "{$base_path}/{$locale}/{$file_name}";
         if (file_exists($xliff_path)) {
-            $strings = Xliff::getStrings($xliff_path, $project_name);
+            // Make sure there is a reference locale defined
+            $reference_locale = isset($repo_data['reference_locale'])
+                ? $repo_data['reference_locale']
+                : 'en-US';
+            $is_reference_locale = $locale == $reference_locale;
+            $strings = Xliff::getStrings($xliff_path, $project_name, $is_reference_locale);
             $total_strings = count($strings);
             foreach ($strings as $string_id => $translation) {
                 $out_translation .= "'{$string_id}' => '{$translation}', \n";

tests/units/Transvision/Xliff.php

@@ -28,6 +28,26 @@ public function testGetStrings()
                 ->isEqualTo('Segnalibri pc desktop');
     }
 
+    public function testGetStringsReference()
+    {
+        $obj = new _Xliff();
+        $strings = $obj->getStrings(TEST_FILES . 'xliff/firefox-ios.xliff', 'firefox_ios', true);
+
+        // Check total number of strings
+        $this
+            ->integer(count($strings))
+                ->isEqualTo(14);
+
+        // Check strings
+        $this
+            ->string($strings['firefox_ios/firefox-ios.xliff:4c8cc9416b11b77e88809ff17e7f180e'])
+                ->isEqualTo('Browsing History');
+
+        $this
+            ->string($strings['firefox_ios/firefox-ios.xliff:f6b6d1aff4ade5b867d563d74b01a429'])
+                ->isEqualTo('Desktop Bookmarks');
+    }
+
     public function generateStringID_DP()
     {
         return [