Add i18n support for Android App Restrictions.

components/policy/tools/generate_policy_source.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 '''python %prog [options] platform chromium_os_flag template
 
 platform specifies which platform source is being generated for
   and can be one of (win, mac, linux)
 chromium_os_flag should be 1 if this is a Chromium OS build
@@ skipping 10 matching lines @@
 from xml.sax.saxutils import escape as xml_escape
 
 
 CHROME_POLICY_KEY = 'SOFTWARE\\\\Policies\\\\Google\\\\Chrome'
 CHROMIUM_POLICY_KEY = 'SOFTWARE\\\\Policies\\\\Chromium'
 
 
 class PolicyDetails:
   """Parses a policy template and caches all its details."""
 
-  # Maps policy types to a tuple with 5 other types:
+  # Maps policy types to a tuple with 4 other types:
   # - the equivalent base::Value::Type or 'TYPE_EXTERNAL' if the policy
   #   references external data
   # - the equivalent Protobuf field type
   # - the name of one of the protobufs for shared policy types
   # - the equivalent type in Android's App Restriction Schema
-  # - whether the equivalent app restriction type needs supporting resources
   # TODO(joaodasilva): refactor the 'dict' type into a more generic 'json' type
   # that can also be used to represent lists of other JSON objects.
   TYPE_MAP = {
     'dict':             ('TYPE_DICTIONARY',   'string',       'String',
-                        'string',             False),
+                        'string'),
     'external':         ('TYPE_EXTERNAL',     'string',       'String',
-                        'invalid',            False),
+                        'invalid'),
     'int':              ('TYPE_INTEGER',      'int64',        'Integer',
-                        'integer',            False),
+                        'integer'),
     'int-enum':         ('TYPE_INTEGER',      'int64',        'Integer',
-                        'choice',             True),
+                        'choice'),
     'list':             ('TYPE_LIST',         'StringList',   'StringList',
-                        'string',             False),
+                        'string'),
     'main':             ('TYPE_BOOLEAN',      'bool',         'Boolean',
-                        'bool',               False),
+                        'bool'),
     'string':           ('TYPE_STRING',       'string',       'String',
-                        'string',             False),
+                        'string'),
     'string-enum':      ('TYPE_STRING',       'string',       'String',
-                        'choice',             True),
+                        'choice'),
     'string-enum-list': ('TYPE_LIST',         'StringList',   'StringList',
-                        'multi-select',       True),
+                        'multi-select'),
   }
 
   class EnumItem:
     def __init__(self, item):
       self.caption = PolicyDetails._RemovePlaceholders(item['caption'])
       self.value = item['value']
 
   def __init__(self, policy, os, is_chromium_os):
     self.id = policy['id']
     self.name = policy['name']
@@ skipping 22 matching lines @@
       else:
         self.platforms.append(platform)
 
     self.platforms.sort()
     self.is_supported = expected_platform in self.platforms
 
     if not PolicyDetails.TYPE_MAP.has_key(policy['type']):
       raise NotImplementedError('Unknown policy type for %s: %s' %
                                 (policy['name'], policy['type']))
     self.policy_type, self.protobuf_type, self.policy_protobuf_type, \
-        self.restriction_type, self.has_restriction_resources = \
-            PolicyDetails.TYPE_MAP[policy['type']]
+        self.restriction_type = PolicyDetails.TYPE_MAP[policy['type']]
     self.schema = policy['schema']
 
     self.desc = '\n'.join(
         map(str.strip,
             PolicyDetails._RemovePlaceholders(policy['desc']).splitlines()))
     self.caption = PolicyDetails._RemovePlaceholders(policy['caption'])
     self.max_size = policy.get('max_size', 0)
 
     items = policy.get('items')
     if items is None:
@@ skipping 34 matching lines @@
                     metavar='FILE')
   parser.add_option('--cpd', '--cloud-policy-decoder',
                     dest='cloud_policy_decoder_path',
                     help='generate C++ code decoding the cloud policy protobuf',
                     metavar='FILE')
   parser.add_option('--ard', '--app-restrictions-definition',
                     dest='app_restrictions_path',
                     help='generate an XML file as specified by '
                     'Android\'s App Restriction Schema',
                     metavar='FILE')
-  parser.add_option('--arr', '--app-restrictions-resources',
-                    dest='app_resources_path',
-                    help='generate an XML file with resources supporting the '
-                    'restrictions defined in --app-restrictions-definition '
-                    'parameter',
-                    metavar='FILE')
 
   (opts, args) = parser.parse_args()
 
   if len(args) != 3:
     print 'exactly platform, chromium_os flag and input file must be specified.'
     parser.print_help()
     return 2
 
   os = args[0]
   is_chromium_os = args[1] == '1'
@@ skipping 11 matching lines @@
         writer(sorted and sorted_policy_details or policy_details, os, f)
 
   GenerateFile(opts.header_path, _WritePolicyConstantHeader, sorted=True)
   GenerateFile(opts.source_path, _WritePolicyConstantSource, sorted=True)
   GenerateFile(opts.cloud_policy_proto_path, _WriteCloudPolicyProtobuf)
   GenerateFile(opts.chrome_settings_proto_path, _WriteChromeSettingsProtobuf)
   GenerateFile(opts.cloud_policy_decoder_path, _WriteCloudPolicyDecoder)
 
   if os == 'android':
     GenerateFile(opts.app_restrictions_path, _WriteAppRestrictions, xml=True)
-    GenerateFile(opts.app_resources_path, _WriteResourcesForPolicies, xml=True)
 
   return 0
 
 
 #------------------ shared helpers ---------------------------------#
 
 def _OutputGeneratedWarningHeader(f, template_file_path, xml_style):
   left_margin = '//'
   if xml_style:
     left_margin = '    '
@@ skipping 795 matching lines @@
 
 
 def _WriteCloudPolicyDecoder(policies, os, f):
   f.write(CPP_HEAD)
   for policy in policies:
     if policy.is_supported and not policy.is_device_only:
       _WritePolicyCode(f, policy)
   f.write(CPP_FOOT)
 
 
-def _EscapeResourceString(raw_resource):
-  if type(raw_resource) == int:
-    return raw_resource
-  return xml_escape(raw_resource)\
-      .replace('\\', '\\\\')\
-      .replace('\"','\\\"')\
-      .replace('\'','\\\'')
-
 def _WriteAppRestrictions(policies, os, f):
 
   def WriteRestrictionCommon(key):
     f.write('    <restriction\n'
             '        android:key="%s"\n' % key)
     f.write('        android:title="@string/%sTitle"\n' % key)
     f.write('        android:description="@string/%sDesc"\n' % key)
 
   def WriteItemsDefinition(key):
     f.write('        android:entries="@array/%sEntries"\n' % key)
     f.write('        android:entryValues="@array/%sValues"\n' % key)
 
   def WriteAppRestriction(policy):
     policy_name = policy.name
     WriteRestrictionCommon(policy_name)
 
-    if policy.has_restriction_resources:
+    if policy.items is not None:
       WriteItemsDefinition(policy_name)
 
     f.write('        android:restrictionType="%s"/>' % policy.restriction_type)
     f.write('\n\n')
 
   # _WriteAppRestrictions body
   f.write('<restrictions xmlns:android="'
           'http://schemas.android.com/apk/res/android">\n\n')
   for policy in policies:
     if policy.is_supported and policy.restriction_type != 'invalid':
       WriteAppRestriction(policy)
   f.write('</restrictions>')
 
-
-def _WriteResourcesForPolicies(policies, os, f):
-
-  # TODO(knn): Update this to support i18n.
-  def WriteString(key, value):
-    f.write('    <string name="%s">%s</string>\n'
-            % (key, _EscapeResourceString(value)))
-
-  def WriteItems(key, items):
-    if items:
-      f.write('    <string-array name="%sEntries">\n' % key)
-      for item in items:
-        f.write('        <item>%s</item>\n' %
-                _EscapeResourceString(item.caption))
-      f.write('    </string-array>\n')
-      f.write('    <string-array name="%sValues">\n' % key)
-      for item in items:
-        f.write('        <item>%s</item>\n' % _EscapeResourceString(item.value))
-      f.write('    </string-array>\n')
-
-  def WriteResourceForPolicy(policy):
-    policy_name = policy.name
-    WriteString(policy_name + 'Title', policy.caption)
-
-    # Get the first line of the policy description.
-    description = policy.desc.split('\n', 1)[0]
-    WriteString(policy_name + 'Desc', description)
-
-    if policy.has_restriction_resources:
-      WriteItems(policy_name, policy.items)
-
-  # _WriteResourcesForPolicies body
-  f.write('<resources>\n\n')
-  for policy in policies:
-    if policy.is_supported and policy.restriction_type != 'invalid':
-      WriteResourceForPolicy(policy)
-  f.write('</resources>')
-
-
 if __name__ == '__main__':
   sys.exit(main())