Add a Policy template writer that generates Android resources which can be exposed through Android'…

grit/format/policy_templates/writers/doc_writer.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.
 
 
 import json
 from xml.dom import minidom
 from grit import lazy_re
 from grit.format.policy_templates.writers import xml_formatted_writer
@@ skipping 189 matching lines @@
       key_name = self.config['win_reg_recommended_key_name']
     else:
       key_name = self.config['win_reg_mandatory_key_name']
     for item in example_value:
       win_text.append(
           '%s\\%s\\%d = "%s"' %
           (key_name, policy['name'], cnt, item))
       cnt = cnt + 1
     self.AddText(win, '\n'.join(win_text))
 
-  def _AddListExampleLinux(self, parent, policy):
-    '''Adds an example value for Linux of a 'list' policy to a DOM node.
+  def _AddListExampleAndroidLinux(self, parent, policy):
+    '''Adds an example value for Android/Linux of a 'list' policy to a DOM node.
 
     Args:
       parent: The DOM node for which the example will be added.
-      policy: A policy of type 'list', for which the Linux example value
+      policy: A policy of type 'list', for which the Android/Linux example value
         is generated.
     '''
     example_value = policy['example_value']
-    self.AddElement(parent, 'dt', {}, 'Linux:')
-    linux = self._AddStyledElement(parent, 'dd', ['.monospace'])
-    linux_text = []
+    self.AddElement(parent, 'dt', {}, 'Android/Linux:')
+    element = self._AddStyledElement(parent, 'dd', ['.monospace'])
+    text = []
     for item in example_value:
-      linux_text.append('"%s"' % item)
-    self.AddText(linux, '[%s]' % ', '.join(linux_text))
+      text.append('"%s"' % item)
+    self.AddText(element, '[%s]' % ', '.join(text))
 
   def _AddListExample(self, parent, policy):
     '''Adds the example value of a 'list' policy to a DOM node. Example output:
     <dl>
       <dt>Windows:</dt>
       <dd>
         Software\Policies\Chromium\DisabledPlugins\0 = "Java"
         Software\Policies\Chromium\DisabledPlugins\1 = "Shockwave Flash"
       </dd>
-      <dt>Linux:</dt>
+      <dt>Android/Linux:</dt>
       <dd>["Java", "Shockwave Flash"]</dd>
       <dt>Mac:</dt>
       <dd>
         <array>
           <string>Java</string>
           <string>Shockwave Flash</string>
         </array>
       </dd>
     </dl>
 
     Args:
       parent: The DOM node for which the example will be added.
       policy: The data structure of a policy.
     '''
     examples = self._AddStyledElement(parent, 'dl', ['dd dl'])
     if self.IsPolicySupportedOnPlatform(policy, 'win'):
       self._AddListExampleWindows(examples, policy)
-    if self.IsPolicySupportedOnPlatform(policy, 'linux'):
-      self._AddListExampleLinux(examples, policy)
+    if (self.IsPolicySupportedOnPlatform(policy, 'android') or
+        self.IsPolicySupportedOnPlatform(policy, 'linux')):
+      self._AddListExampleAndroidLinux(examples, policy)
     if self.IsPolicySupportedOnPlatform(policy, 'mac'):
       self._AddListExampleMac(examples, policy)
 
   def _PythonObjectToPlist(self, obj, indent=''):
     '''Converts a python object to an equivalent XML plist.
 
     Returns a list of lines.'''
     obj_type = type(obj)
     if obj_type == bool:
       return [ '%s<%s/>' % (indent, 'true' if obj else 'false') ]
@@ skipping 42 matching lines @@
     '''
     self.AddElement(parent, 'dt', {}, 'Windows:')
     win = self._AddStyledElement(parent, 'dd', ['.monospace', '.pre'])
     if self.CanBeRecommended(policy) and not self.CanBeMandatory(policy):
       key_name = self.config['win_reg_recommended_key_name']
     else:
       key_name = self.config['win_reg_mandatory_key_name']
     example = json.dumps(policy['example_value'])
     self.AddText(win, '%s\\%s = %s' % (key_name, policy['name'], example))
 
-  def _AddDictionaryExampleLinux(self, parent, policy):
-    '''Adds an example value for Linux of a 'dict' policy to a DOM node.
+  def _AddDictionaryExampleAndroidLinux(self, parent, policy):
+    '''Adds an example value for Android/Linux of a 'dict' policy to a DOM node.
 
     Args:
       parent: The DOM node for which the example will be added.
-      policy: A policy of type 'dict', for which the Linux example value
+      policy: A policy of type 'dict', for which the Android/Linux example value
         is generated.
     '''
-    self.AddElement(parent, 'dt', {}, 'Linux:')
-    linux = self._AddStyledElement(parent, 'dd', ['.monospace'])
+    self.AddElement(parent, 'dt', {}, 'Android/Linux:')
+    element = self._AddStyledElement(parent, 'dd', ['.monospace'])
     example = json.dumps(policy['example_value'])
-    self.AddText(linux, '%s: %s' % (policy['name'], example))
+    self.AddText(element, '%s: %s' % (policy['name'], example))
 
   def _AddDictionaryExample(self, parent, policy):
     '''Adds the example value of a 'dict' policy to a DOM node. Example output:
     <dl>
       <dt>Windows:</dt>
       <dd>
         Software\Policies\Chromium\ProxySettings = "{ 'ProxyMode': 'direct' }"
       </dd>
-      <dt>Linux:</dt>
+      <dt>Android/Linux:</dt>
       <dd>"ProxySettings": {
         "ProxyMode": "direct"
       }
       </dd>
       <dt>Mac:</dt>
       <dd>
         <key>ProxySettings</key>
         <dict>
           <key>ProxyMode</key>
           <string>direct</string>
         </dict>
       </dd>
     </dl>
 
     Args:
       parent: The DOM node for which the example will be added.
       policy: The data structure of a policy.
     '''
     examples = self._AddStyledElement(parent, 'dl', ['dd dl'])
     if self.IsPolicySupportedOnPlatform(policy, 'win'):
       self._AddDictionaryExampleWindows(examples, policy)
-    if self.IsPolicySupportedOnPlatform(policy, 'linux'):
-      self._AddDictionaryExampleLinux(examples, policy)
+    if (self.IsPolicySupportedOnPlatform(policy, 'android') or
+        self.IsPolicySupportedOnPlatform(policy, 'linux')):
+      self._AddDictionaryExampleAndroidLinux(examples, policy)
     if self.IsPolicySupportedOnPlatform(policy, 'mac'):
       self._AddDictionaryExampleMac(examples, policy)
 
   def _AddExample(self, parent, policy):
     '''Adds the HTML DOM representation of the example value of a policy to
     a DOM node. It is simple text for boolean policies, like
-    '0x00000001 (Windows), true (Linux), <true /> (Mac)' in case of boolean
-    policies, but it may also contain other HTML elements. (See method
-    _AddListExample.)
+    '0x00000001 (Windows), true (Linux), true (Android), <true /> (Mac)'
+    in case of boolean policies, but it may also contain other HTML elements.
+    (See method _AddListExample.)
 
     Args:
       parent: The DOM node for which the example will be added.
       policy: The data structure of a policy.
 
     Raises:
       Exception: If the type of the policy is unknown or the example value
         of the policy is out of its expected range.
     '''
     example_value = policy['example_value']
     policy_type = policy['type']
     if policy_type == 'main':
       pieces = []
       if self.IsPolicySupportedOnPlatform(policy, 'win'):
         value = '0x00000001' if example_value else '0x00000000'
         pieces.append(value + ' (Windows)')
       if self.IsPolicySupportedOnPlatform(policy, 'linux'):
         value = 'true' if example_value else 'false'
         pieces.append(value + ' (Linux)')
+      if self.IsPolicySupportedOnPlatform(policy, 'android'):
+        value = 'true' if example_value else 'false'
+        pieces.append(value + ' (Android)')
       if self.IsPolicySupportedOnPlatform(policy, 'mac'):
         value = '<true />' if example_value else '<false />'
         pieces.append(value + ' (Mac)')
       self.AddText(parent, ', '.join(pieces))
     elif policy_type == 'string':
       self.AddText(parent, '"%s"' % example_value)
     elif policy_type in ('int', 'int-enum'):
       pieces = []
       if self.IsPolicySupportedOnPlatform(policy, 'win'):
         pieces.append('0x%08x (Windows)' % example_value)
       if self.IsPolicySupportedOnPlatform(policy, 'linux'):
         pieces.append('%d (Linux)' % example_value)
+      if self.IsPolicySupportedOnPlatform(policy, 'android'):
+        pieces.append('%d (Android)' % example_value)
       if self.IsPolicySupportedOnPlatform(policy, 'mac'):
         pieces.append('%d (Mac)' % example_value)
       self.AddText(parent, ', '.join(pieces))
     elif policy_type == 'string-enum':
       self.AddText(parent, '"%s"' % (example_value))
     elif policy_type in ('list', 'string-enum-list'):
       self._AddListExample(parent, policy)
     elif policy_type == 'dict':
       self._AddDictionaryExample(parent, policy)
     else:
@@ skipping 56 matching lines @@
       <dt>Attribute:</dt><dd>Description</dd>
       ...
     </dl>
 
     Args:
       parent: A DOM element for which the list will be added.
       policy: The data structure of the policy.
     '''
 
     dl = self.AddElement(parent, 'dl')
-    data_type = self._TYPE_MAP[policy['type']]
+    data_type = [self._TYPE_MAP[policy['type']]]
+    qualified_types = []
+    is_complex_policy = False
+    if (self.IsPolicySupportedOnPlatform(policy, 'android') and
+        self._RESTRICTION_TYPE_MAP.get(policy['type'], None)):
+      qualified_types.append('Android:%s' %
+                            self._RESTRICTION_TYPE_MAP[policy['type']])
+      if policy['type'] in ('dict', 'list'):
+        is_complex_policy = True
     if (self.IsPolicySupportedOnPlatform(policy, 'win') and
         self._REG_TYPE_MAP.get(policy['type'], None)):
-      data_type += ' (%s)' % self._REG_TYPE_MAP[policy['type']]
-    self._AddPolicyAttribute(dl, 'data_type', data_type)
+      qualified_types.append('Windows:%s' % self._REG_TYPE_MAP[policy['type']])
+      if policy['type'] == 'dict':
+        is_complex_policy = True
+    if qualified_types:
+      data_type.append('[%s]' % ', '.join(qualified_types))
+      if is_complex_policy:
+        data_type.append('(%s)' %
+            self._GetLocalizedMessage('complex_policies_on_windows'))
+    self._AddPolicyAttribute(dl, 'data_type', ' '.join(data_type))
     if policy['type'] != 'external':
       # All types except 'external' can be set through platform policy.
       if self.IsPolicySupportedOnPlatform(policy, 'win'):
         if self.CanBeRecommended(policy) and not self.CanBeMandatory(policy):
           key_name = self.config['win_reg_recommended_key_name']
         else:
           key_name = self.config['win_reg_mandatory_key_name']
         self._AddPolicyAttribute(
             dl,
             'win_reg_loc',
             key_name + '\\' + policy['name'],
             ['.monospace'])
       if (self.IsPolicySupportedOnPlatform(policy, 'linux') or
           self.IsPolicySupportedOnPlatform(policy, 'mac')):
         self._AddPolicyAttribute(
             dl,
             'mac_linux_pref_name',
             policy['name'],
             ['.monospace'])
+      if self.IsPolicySupportedOnPlatform(policy, 'android'):
+        self._AddPolicyAttribute(
+            dl,
+            'android_restriction_name',
+            policy['name'],
+            ['.monospace'])
     dd = self._AddPolicyAttribute(dl, 'supported_on')
     self._AddSupportedOnList(dd, policy['supported_on'])
     dd = self._AddPolicyAttribute(dl, 'supported_features')
     self._AddFeatures(dd, policy)
     dd = self._AddPolicyAttribute(dl, 'description')
     self._AddDescription(dd, policy)
     if (self.IsPolicySupportedOnPlatform(policy, 'win') or
         self.IsPolicySupportedOnPlatform(policy, 'linux') or
+        self.IsPolicySupportedOnPlatform(policy, 'android') or
         self.IsPolicySupportedOnPlatform(policy, 'mac')):
       # Don't add an example for ChromeOS-only policies.
       if policy['type'] != 'external':
         # All types except 'external' can be set through platform policy.
         dd = self._AddPolicyAttribute(dl, 'example_value')
         self._AddExample(dd, policy)
 
   def _AddPolicyNote(self, parent, policy):
     '''If a policy has an additional web page assigned with it, then add
     a link for that page.
@@ skipping 150 matching lines @@
       'string': 'String',
       'int': 'Integer',
       'main': 'Boolean',
       'int-enum': 'Integer',
       'string-enum': 'String',
       'list': 'List of strings',
       'string-enum-list': 'List of strings',
       'dict': 'Dictionary',
       'external': 'External data reference',
     }
-    reg_dict = 'REG_SZ; %s' % self._GetLocalizedMessage(
-        'complex_policies_on_windows')
     self._REG_TYPE_MAP = {
       'string': 'REG_SZ',
       'int': 'REG_DWORD',
       'main': 'REG_DWORD',
       'int-enum': 'REG_DWORD',
       'string-enum': 'REG_SZ',
-      'dict': reg_dict,
+      'dict': 'REG_SZ',
+    }
+    self._RESTRICTION_TYPE_MAP = {
+      'int-enum': 'choice',
+      'string-enum': 'choice',
+      'list': 'string',
+      'string-enum-list': 'multi-select',
+      'dict': 'string',
     }
     # The CSS style-sheet used for the document. It will be used in Google
     # Sites, which strips class attributes from HTML tags. To work around this,
     # the style-sheet is a dictionary and the style attributes will be added
     # "by hand" for each element.
     self._STYLE = {
       'table': 'border-style: none; border-collapse: collapse;',
       'tr': 'height: 0px;',
       'td': 'border: 1px dotted rgb(170, 170, 170); padding: 7px; '
           'vertical-align: top; width: 236px; height: 15px;',
       'thead td': 'font-weight: bold;',
       'td.left': 'width: 200px;',
       'td.right': 'width: 100%;',
       'dt': 'font-weight: bold;',
       'dd dl': 'margin-top: 0px; margin-bottom: 0px;',
       '.monospace': 'font-family: monospace;',
       '.pre': 'white-space: pre;',
       'div.note': 'border: 2px solid black; padding: 5px; margin: 5px;',
       'div.group_desc': 'margin-top: 20px; margin-bottom: 20px;',
       'ul': 'padding-left: 0px; margin-left: 0px;'
     }
 
 
   def GetTemplateText(self):
     # Return the text representation of the main <div> tag.
     return self._main_div.toxml()
     # To get a complete HTML file, use the following.
     # return self._doc.toxml()