Issue 2109 - Allow for translation of app independent repositories

build.py

 # coding: utf-8
 
 # This Source Code Form is subject to the terms of the Mozilla Public
 # License, v. 2.0. If a copy of the MPL was not distributed with this
 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
 import os, sys, re, subprocess, shutil, buildtools
 from getopt import getopt, GetoptError
 from StringIO import StringIO
 from zipfile import ZipFile
@@ skipping 218 matching lines @@
   from buildtools.packager import getDevEnvPath
   devenv_dir = getDevEnvPath(baseDir, type)
 
   shutil.rmtree(devenv_dir, ignore_errors=True)
 
   file.seek(0)
   with ZipFile(file, 'r') as zip_file:
     zip_file.extractall(devenv_dir)
 
 
-def readLocaleConfig(baseDir, type, metadata, includeIncomplete=False):
+def readLocaleConfig(baseDir, type, metadata):
   if type == 'gecko':
     import buildtools.packagerGecko as packager
-    basePath = packager.getLocalesDir(baseDir)
-    return {
-      'base_path': basePath,
+    localeDir = packager.getLocalesDir(baseDir)
+    localeConfig = {
       'name_format': 'BCP-47',
       'file_format': 'gecko-dtd',
       'target_platforms': {'gecko'},
-      'default_locale': packager.defaultLocale,
-      'locales': {locale: os.path.join(basePath, locale)
-                  for locale in packager.getLocales(baseDir, includeIncomplete)}
+      'default_locale': packager.defaultLocale
     }

[Wladimir Palant, 2016/02/12 19:05:43]

Gecko is still being treated as a special case here, for no good reason IMHO. I
think that it should be something like this:

  if type == 'gecko':
    localeDir = packager.getLocalesDir(baseDir)
    ...
  elif type == 'chrome' or type == 'opera':
    localeDir = os.path.join(baseDir, '_locales')
    ...
  else:
    localeDir = os.path.join(baseDir, *metadata.get('locales',
'base_path').split('/'))
    ...

  localeConfig['base_path'] = localeDir
  locales = packager.getLocales(baseDir, includeIncomplete) if type == 'gecko'
else os.listdir(localeDir)
  ...

Note that localeDir is always absolute, not relative. Also, I think that
explicitly splitting base_path setting from metadata by forward slash is a good
idea - the paths specified there aren't supposed to be OS-dependent. I presume
that os.path.join(baseDir, 'foo/bar') will still do the right thing on Windows
but I'd rather not rely on this unnecessarily. Sebastian has the last word here
of course but so far we've been using this approach consistently throughout
buildtools.

Note for future: we should seriously consider implementing the same kind of
locale validation that packager.getLocales() performs for other platforms as
well.

[kzar, 2016/02/12 19:40:26]

Done.

-
-  if type == 'chrome' or type == 'opera':
+  elif type == 'chrome' or type == 'opera':
     import buildtools.packagerChrome as packager
-    localeDir = '_locales'
+    localeDir = os.path.join(baseDir, '_locales')
     localeConfig = {
       'name_format': 'ISO-15897',
       'file_format': 'chrome-json',
       'target_platforms': {'chrome'},
       'default_locale': packager.defaultLocale,
     }
   else:
-    localeDir = metadata.get('locales', 'base_path')
+    localeDir = os.path.join(baseDir,
+                             *metadata.get('locales', 'base_path').split('/'))
     localeConfig = {
       'name_format': metadata.get('locales', 'name_format'),
       'file_format': metadata.get('locales', 'file_format'),
       'target_platforms': set(metadata.get('locales',
                                            'target_platforms').split()),
       'default_locale': metadata.get('locales', 'default_locale')
     }
 
-  localeConfig['base_path'] = fullBasePath = os.path.join(baseDir, localeDir)
-
-  locales = [(locale, os.path.join(fullBasePath, locale))
-             for locale in os.listdir(fullBasePath)]
+  localeConfig['base_path'] = localeDir
+
+  locales = [(locale, os.path.join(localeDir, locale))
+             for locale in os.listdir(localeDir)]
   if localeConfig['name_format'] == 'ISO-15897':
     locales = [(locale.replace('_', '-'), localePath)
                for locale, localePath in locales]
   localeConfig['locales'] = dict(locales)
 
   return localeConfig
 
 def setupTranslations(baseDir, scriptName, opts, args, type):
   if len(args) < 1:
     print 'Project key is required to update translation master files.'
     usage(scriptName, type, 'setuptrans')
     return
 
   key = args[0]
 
   from buildtools.packager import readMetadata
   metadata = readMetadata(baseDir, type)
 
   basename = metadata.get('general', 'basename')
-  localeConfig = readLocaleConfig(baseDir, type, metadata, True)
+  localeConfig = readLocaleConfig(baseDir, type, metadata)
 
   import buildtools.localeTools as localeTools
   localeTools.setupTranslations(localeConfig, basename, key)
 
 
 def updateTranslationMaster(baseDir, scriptName, opts, args, type):
   if len(args) < 1:
     print 'Project key is required to update translation master files.'
     usage(scriptName, type, 'translate')
     return
@@ skipping 19 matching lines @@
     print 'Project key is required to upload existing translations.'
     usage(scriptName, type, 'uploadtrans')
     return
 
   key = args[0]
 
   from buildtools.packager import readMetadata
   metadata = readMetadata(baseDir, type)
 
   basename = metadata.get('general', 'basename')
-  localeConfig = readLocaleConfig(baseDir, type, metadata, True)
+  localeConfig = readLocaleConfig(baseDir, type, metadata)
 
   import buildtools.localeTools as localeTools
   for locale, localeDir in localeConfig['locales'].iteritems():
     if locale != localeConfig['default_locale']:
       localeTools.uploadTranslations(localeConfig, metadata, localeDir, locale,
                                      basename, key)
 
 
 def getTranslations(baseDir, scriptName, opts, args, type):
   if len(args) < 1:
@@ skipping 252 matching lines @@
         if option in ('-h', '--help'):
           usage(scriptName, type, command)
           sys.exit()
       commands[command](baseDir, scriptName, opts, args, type)
     else:
       print 'Command %s is not supported for this application type' % command
       usage(scriptName, type)
   else:
     print 'Command %s is unrecognized' % command
     usage(scriptName, type)