Bug 1065306 - Part 4: Write localized res/raw-*/browsersearch.json. r=mshal

mobile/android/base/Makefile.in

@@ -48,6 +48,7 @@ GARBAGE += \
   classes.dex  \
   gecko.ap_  \
   res/values/strings.xml \
+  res/raw/browsersearch.json \
   res/raw/suggestedsites.json \
   .aapt.deps \
   fennec_ids.txt \
@@ -259,11 +260,12 @@ $(ANDROID_GENERATED_RESFILES): $(call mkdir_deps,$(sort $(dir $(ANDROID_GENERATE
 
 
 # This .deps pattern saves an invocation of the sub-Make: the single
-# invocation generates both strings.xml and suggestedsites.json. The
-# trailing semi-colon defines an empty recipe: defining no recipe at
-# all causes Make to treat the target differently, in a way that
-# defeats our dependencies.
+# invocation generates strings.xml, browsersearch.json, and
+# suggestedsites.json. The trailing semi-colon defines an empty
+# recipe: defining no recipe at all causes Make to treat the target
+# differently, in a way that defeats our dependencies.
 res/values/strings.xml: .locales.deps ;
+res/raw/browsersearch.json: .locales.deps ;
 res/raw/suggestedsites.json: .locales.deps ;
 
 all_resources = \

mobile/android/base/locales/Makefile.in

@@ -30,6 +30,7 @@ GARBAGE += $(strings-xml)
 
 dir-res-raw := ../res/raw
 suggestedsites := $(dir-res-raw)/suggestedsites.json
+browsersearch := $(dir-res-raw)/browsersearch.json
 
 libs realchrome:: \
   $(strings-xml) \
@@ -40,6 +41,7 @@ chrome-%::
 	@$(MAKE) \
 	  $(dir-res-values)-$(AB_rCD)/strings.xml \
 	  $(dir-res-raw)-$(AB_rCD)/suggestedsites.json \
+	  $(dir-res-raw)-$(AB_rCD)/browsersearch.json \
 	  AB_CD=$*
 
 # setup the path to bookmarks.inc. copied and tweaked version of MERGE_FILE from config/config.mk
@@ -119,3 +121,12 @@ $(suggestedsites-dstdir-raw)/suggestedsites.json: FORCE
 		$(if $(filter en-US,$(AB_CD)),,--srcdir=$(l10n-srcdir)) \
 		--srcdir=$(topsrcdir)/mobile/locales/en-US/chrome \
 		$@)
+
+$(eval $(call generated_file_template,browsersearch,browsersearch.json))
+
+$(browsersearch-dstdir-raw)/browsersearch.json: FORCE
+	$(call py_action,generate_browsersearch, \
+		--verbose \
+		$(if $(filter en-US,$(AB_CD)),,--srcdir=$(l10n-srcdir)) \
+		--srcdir=$(topsrcdir)/mobile/locales/en-US/chrome \
+		$@)

python/mozbuild/mozbuild/action/generate_browsersearch.py

@@ -0,0 +1,98 @@
+# -*- Mode: python; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 40 -*-
+# 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/.
+
+'''
+Script to generate the browsersearch.json file for Fennec.
+
+This script follows these steps:
+
+1. Read the region.properties file in all the given source directories (see
+srcdir option). Merge all properties into a single dict accounting for the
+priority of source directories.
+
+2. Read the default search plugin from the 'browser.search.defaultenginename'.
+
+3. Read the list of search plugins from the 'browser.search.order.INDEX'
+properties with values identifying particular search plugins by name.
+
+4. Generate a JSON representation of 2. and 3., and write the result to
+browsersearch.json in the locale-specific raw resource directory
+e.g. raw/browsersearch.json, raw-pt-rBR/browsersearch.json.
+'''
+
+from __future__ import print_function
+
+import argparse
+import json
+import re
+import sys
+import os
+
+from mozbuild.dotproperties import (
+    DotProperties,
+)
+from mozbuild.util import (
+    FileAvoidWrite,
+)
+import mozpack.path as mozpath
+
+
+def merge_properties(filename, srcdirs):
+    """Merges properties from the given file in the given source directories."""
+    properties = DotProperties()
+    for srcdir in srcdirs:
+        path = mozpath.join(srcdir, filename)
+        try:
+            properties.update(path)
+        except IOError:
+            # Ignore non-existing files
+            continue
+    return properties
+
+
+def main(args):
+    parser = argparse.ArgumentParser()
+    parser.add_argument('--verbose', '-v', default=False, action='store_true',
+                        help='be verbose')
+    parser.add_argument('--silent', '-s', default=False, action='store_true',
+                        help='be silent')
+    parser.add_argument('--srcdir', metavar='SRCDIR',
+                        action='append', required=True,
+                        help='directories to read inputs from, in order of priority')
+    parser.add_argument('output', metavar='OUTPUT',
+                        help='output')
+    opts = parser.parse_args(args)
+
+    # Use reversed order so that the first srcdir has higher priority to override keys.
+    properties = merge_properties('region.properties', reversed(opts.srcdir))
+
+    default = properties.get('browser.search.defaultenginename')
+    engines = properties.get_list('browser.search.order')
+
+    if opts.verbose:
+        print('Read {len} engines: {engines}'.format(len=len(engines), engines=engines))
+        print("Default engine is '{default}'.".format(default=default))
+
+    browsersearch = {}
+    browsersearch['default'] = default
+    browsersearch['engines'] = engines
+
+    # FileAvoidWrite creates its parent directories.
+    output = os.path.abspath(opts.output)
+    fh = FileAvoidWrite(output)
+    json.dump(browsersearch, fh)
+    existed, updated = fh.close()
+
+    if not opts.silent:
+        if updated:
+            print('{output} updated'.format(output=output))
+        else:
+            print('{output} already up-to-date'.format(output=output))
+
+    return 0
+
+
+if __name__ == '__main__':
+    sys.exit(main(sys.argv[1:]))