Generate ADMX template for Chrome OS policies

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 165 matching lines @@
     example_value = policy['example_value']
     self.AddElement(parent, 'dt', {}, 'Mac:')
     mac = self._AddStyledElement(parent, 'dd', ['.monospace', '.pre'])
 
     mac_text = ['<array>']
     for item in example_value:
       mac_text.append('  <string>%s</string>' % item)
     mac_text.append('</array>')
     self.AddText(mac, '\n'.join(mac_text))
 
-  def _AddListExampleWindows(self, parent, policy):
-    '''Adds an example value for Windows of a 'list' policy to a DOM node.
+  def _AddListExampleWindowsChromeOS(self, parent, policy, is_win):
+    '''Adds an example value for Windows or Chromium/Google Chrome OS 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 Windows example value
         is generated.
+      is_win: True for Windows, False for Chromium/Google Chrome OS.
     '''
     example_value = policy['example_value']
-    self.AddElement(parent, 'dt', {}, 'Windows:')
-    win = self._AddStyledElement(parent, 'dd', ['.monospace', '.pre'])
-    win_text = []
+    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'])
+    element_text = []
     cnt = 1
-    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']
+    key_name = self._GetRegistryKeyName(policy, is_win)
     for item in example_value:
-      win_text.append(
+      element_text.append(
           '%s\\%s\\%d = "%s"' %
           (key_name, policy['name'], cnt, item))
       cnt = cnt + 1
-    self.AddText(win, '\n'.join(win_text))
+    self.AddText(element, '\n'.join(element_text))
+
+  def _GetRegistryKeyName(self, policy, is_win):
+    use_recommended_key = self.CanBeRecommended(policy) and not \
+                          self.CanBeMandatory(policy)
+    platform = 'win' if is_win else 'chrome_os';
+    key = 'reg_recommended_key_name' if use_recommended_key else \
+          'reg_mandatory_key_name'
+    return self.config['win_config'][platform][key];
 
   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 Android/Linux example value
         is generated.
     '''
     example_value = policy['example_value']
     self.AddElement(parent, 'dt', {}, 'Android/Linux:')
     element = self._AddStyledElement(parent, 'dd', ['.monospace'])
     text = []
     for item in example_value:
       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>
+      <dt>Windows (Windows clients):</dt>
       <dd>
         Software\Policies\Chromium\DisabledPlugins\0 = "Java"
         Software\Policies\Chromium\DisabledPlugins\1 = "Shockwave Flash"
       </dd>
+      <dt>Windows (Chromium OS clients):</dt>
+      <dd>
+        Software\Policies\ChromiumOS\DisabledPlugins\0 = "Java"
+        Software\Policies\ChromiumOS\DisabledPlugins\1 = "Shockwave Flash"
+      </dd>
       <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)
+      self._AddListExampleWindowsChromeOS(examples, policy, True)
+    if self.IsPolicySupportedOnPlatform(policy, 'chrome_os'):
+      self._AddListExampleWindowsChromeOS(examples, policy, False)
     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.'''
@@ skipping 28 matching lines @@
       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 _AddDictionaryExampleWindows(self, parent, policy):
+  def _AddDictionaryExampleWindowsChromeOS(self, parent, policy, is_win):
     '''Adds an example value for Windows 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 Windows example value
         is generated.
     '''
-    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']
+    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(win, '%s\\%s = %s' % (key_name, policy['name'], example))
+    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.
 
     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:
     <dl>
-      <dt>Windows:</dt>
+      <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>
       <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)
+      self._AddDictionaryExampleWindowsChromeOS(examples, policy, True)
+    if self.IsPolicySupportedOnPlatform(policy, 'chrome_os'):
+      self._AddDictionaryExampleWindowsChromeOS(examples, policy, False)
     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 (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'):
+      if self.IsPolicySupportedOnPlatform(policy, 'win') or \
+         self.IsPolicySupportedOnPlatform(policy, 'chrome_os'):
         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'):
+      if self.IsPolicySupportedOnPlatform(policy, 'win') or \
+         self.IsPolicySupportedOnPlatform(policy, 'chrome_os'):
         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))
@@ skipping 70 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'):
         is_complex_policy = True
-    if (self.IsPolicySupportedOnPlatform(policy, 'win') and
+    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':
         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']
+        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,
@@ skipping 224 matching lines @@
       '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()