Include 'external' policies in grit output (admx, adm, doc etc.)

components/policy/tools/template_writers/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
 import re
 from xml.dom import minidom
 from writers import xml_formatted_writer
@@ skipping 281 matching lines @@
       result = [ '%s<dict>' % indent ]
       for key in sorted(obj.keys()):
         result.append('%s<key>%s</key>' % (indent + '  ', key))
         result += self._PythonObjectToPlist(obj[key], indent + '  ')
       result.append('%s</dict>' % indent)
       return result
     else:
       raise Exception('Invalid object to convert: %s' % obj)
 
   def _AddDictionaryExampleMac(self, parent, policy):
-    '''Adds an example value for Mac of a 'dict' policy to a DOM node.
+    '''Adds an example value for Mac of a 'dict' or 'external' 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 Mac example value
         is generated.
     '''
     example_value = policy['example_value']
     self.AddElement(parent, 'dt', {}, 'Mac:')
     mac = self._AddStyledElement(parent, 'dd', ['.monospace', '.pre'])
     mac_text = ['<key>%s</key>' % (policy['name'])]
     mac_text += self._PythonObjectToPlist(example_value)
     self.AddText(mac, '\n'.join(mac_text))
 
   def _AddDictionaryExampleWindowsChromeOS(self, parent, policy, is_win):
-    '''Adds an example value for Windows of a 'dict' policy to a DOM node.
+    '''Adds an example value for Windows of a 'dict' or 'external' 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 Windows example value
         is generated.
     '''
     os_header = self._GetLocalizedMessage('win_example_value') if is_win else \
                 self._GetLocalizedMessage('chrome_os_example_value')
     self.AddElement(parent, 'dt', {}, os_header)
     element = self._AddStyledElement(parent, 'dd', ['.monospace', '.pre'])
     key_name = self._GetRegistryKeyName(policy, is_win)
     example = json.dumps(policy['example_value'])
     self.AddText(element, '%s\\%s = %s' % (key_name, policy['name'], example))
 
   def _AddDictionaryExampleAndroidLinux(self, parent, policy):
-    '''Adds an example value for Android/Linux of a 'dict' policy to a DOM node.
+    '''Adds an example value for Android/Linux of a 'dict' or 'external' 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 Android/Linux example value
         is generated.
     '''
     self.AddElement(parent, 'dt', {}, 'Android/Linux:')
     element = self._AddStyledElement(parent, 'dd', ['.monospace'])
     example = json.dumps(policy['example_value'])
     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:
+    '''Adds the example value of a 'dict' or 'external' policy to a DOM node.
+
+    Example output:
     <dl>
       <dt>Windows (Windows clients):</dt>
       <dd>
         Software\Policies\Chromium\ProxySettings = "{ 'ProxyMode': 'direct' }"
       </dd>
       <dt>Windows (Chromium OS clients):</dt>
       <dd>
         Software\Policies\ChromiumOS\ProxySettings = "{ 'ProxyMode': 'direct' }"
       </dd>
       <dt>Android/Linux:</dt>
@@ skipping 70 matching lines @@
         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':
+    elif policy_type in ('dict', 'external'):
       self._AddDictionaryExample(parent, policy)
     else:
       raise Exception('Unknown policy type: ' + policy_type)
 
   def _AddPolicyAttribute(self, dl, term_id,
                           definition=None, definition_style=None):
     '''Adds a term-definition pair to a HTML DOM <dl> node. This method is
     used by _AddPolicyDetails. Its result will have the form of:
       <dt style="...">...</dt>
       <dd style="...">...</dd>
@@ skipping 55 matching lines @@
     '''
 
     dl = self.AddElement(parent, 'dl')
     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'):
+      if policy['type'] in ('dict', 'external', 'list'):
         is_complex_policy = True
     if ((self.IsPolicySupportedOnPlatform(policy, 'win') or
          self.IsPolicySupportedOnPlatform(policy, 'chrome_os')) and
         self._REG_TYPE_MAP.get(policy['type'], None)):
       qualified_types.append('Windows:%s' % self._REG_TYPE_MAP[policy['type']])
-      if policy['type'] == 'dict':
+      if policy['type'] in ('dict', 'external'):
         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'):
-        key_name = self._GetRegistryKeyName(policy, True)
-        self._AddPolicyAttribute(
-            dl,
-            'win_reg_loc',
-            key_name + '\\' + policy['name'],
-            ['.monospace'])
-      if self.IsPolicySupportedOnPlatform(policy, 'chrome_os'):
-        key_name = self._GetRegistryKeyName(policy, False)
-        self._AddPolicyAttribute(
-            dl,
-            'chrome_os_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', 'chrome'):
-        self._AddPolicyAttribute(
-            dl,
-            'android_restriction_name',
-            policy['name'],
-            ['.monospace'])
-      if self.IsPolicySupportedOnPlatform(policy, 'android', 'webview'):
-        restriction_prefix = self.config['android_webview_restriction_prefix']
-        self._AddPolicyAttribute(
-            dl,
-            'android_webview_restriction_name',
-            restriction_prefix + policy['name'],
-            ['.monospace'])
+    if self.IsPolicySupportedOnPlatform(policy, 'win'):
+      key_name = self._GetRegistryKeyName(policy, True)
+      self._AddPolicyAttribute(
+          dl,
+          'win_reg_loc',
+          key_name + '\\' + policy['name'],
+          ['.monospace'])
+    if self.IsPolicySupportedOnPlatform(policy, 'chrome_os'):
+      key_name = self._GetRegistryKeyName(policy, False)
+      self._AddPolicyAttribute(
+          dl,
+          'chrome_os_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', 'chrome'):
+      self._AddPolicyAttribute(
+          dl,
+          'android_restriction_name',
+          policy['name'],
+          ['.monospace'])
+    if self.IsPolicySupportedOnPlatform(policy, 'android', 'webview'):
+      restriction_prefix = self.config['android_webview_restriction_prefix']
+      self._AddPolicyAttribute(
+          dl,
+          'android_webview_restriction_name',
+          restriction_prefix + 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 'arc_support' in policy:
       dd = self._AddPolicyAttribute(dl, 'arc_support')
       self._AddParagraphs(dd, policy['arc_support'])
     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)
+      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.
 
     Args:
       policy: The data structure of the policy.
     '''
     if 'problem_href' not in policy:
       return
@@ skipping 151 matching lines @@
       'dict': 'Dictionary',
       'external': 'External data reference',
     }
     self._REG_TYPE_MAP = {
       'string': 'REG_SZ',
       'int': 'REG_DWORD',
       'main': 'REG_DWORD',
       'int-enum': 'REG_DWORD',
       'string-enum': 'REG_SZ',
       'dict': 'REG_SZ',
+      'external': 'REG_SZ',
     }
     self._RESTRICTION_TYPE_MAP = {
       'int-enum': 'choice',
       'string-enum': 'choice',
       'list': 'string',
       'string-enum-list': 'multi-select',
       'dict': 'string',
+      'external': '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()