Generate Chrome policy definition list from policy_templates.json.

chrome/tools/build/generate_policy_source.py

 #!/usr/bin/python
 # Copyright (c) 2011 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 template
 
 platform specifies which platform source is being generated for
   and can be one of (win, mac, linux).
 template is the path to a .json policy template file.'''
 
 from __future__ import with_statement
 from optparse import OptionParser
 import sys;
 
 
 CHROME_SUBKEY = 'SOFTWARE\\\\Policies\\\\Google\\\\Chrome';
 CHROMIUM_SUBKEY = 'SOFTWARE\\\\Policies\\\\Chromium';
 
+TYPE_MAP = {
+  'int': 'TYPE_INTEGER',
+  'int-enum': 'TYPE_INTEGER',
+  'list': 'TYPE_LIST',
+  'main': 'TYPE_BOOLEAN',
+  'string': 'TYPE_STRING',
+  'string-enum': 'TYPE_STRING',
+}
+
 
 def main():
   parser = OptionParser(usage=__doc__);
   parser.add_option("--pch", "--policy-constants-header", dest="header_path",
                     help="generate header file of policy constants",
                     metavar="FILE");
   parser.add_option("--pcc", "--policy-constants-source", dest="source_path",
                     help="generate source file of policy constants",
                     metavar="FILE");
   parser.add_option("--pth", "--policy-type-header", dest="type_path",
@@ skipping 27 matching lines @@
 
 #------------------ shared helpers ---------------------------------#
 def _OutputGeneratedWarningForC(f, template_file_path):
     f.write('//\n'
             '// DO NOT MODIFY THIS FILE DIRECTLY!\n'
             '// IT IS GENERATED BY generate_policy_source.py\n'
             '// FROM ' + template_file_path + '\n'
             '//\n\n')
 
 
-def _GetPolicyNameList(template_file_contents):
-  policy_names = [];
+# Returns a tuple with details about the given policy:
+# (name, type, list_of_platforms, is_device_policy)
+def _GetPolicyDetails(policy):
+  if not TYPE_MAP.has_key(policy['type']):
+    print "Unknown policy type for %s: %s" % (policy['name'], policy['type'])
+    sys.exit(3)
+  # platforms is a list of "chrome", "chrome_os" and/or "chrome_frame".
+  platforms = [ x.split('.')[0].split(':')[0] for x in policy['supported_on'] ]
+  is_device_policy = policy.get('device_only', False)
+  return (policy['name'], TYPE_MAP[policy['type']], platforms, is_device_policy)
+
+
+def _GetPolicyList(template_file_contents):
+  policies = [];
   for policy in template_file_contents['policy_definitions']:
     if policy['type'] == 'group':
       for sub_policy in policy['policies']:
-        policy_names.append(sub_policy['name'])
+        policies.append(_GetPolicyDetails(sub_policy))
     else:
-      policy_names.append(policy['name'])
-  policy_names.sort()
-  return policy_names
+      policies.append(_GetPolicyDetails(policy))
+  # Tuples are sorted in lexicographical order, which will sort by policy name
+  # in this case.
+  policies.sort()
+  return policies
+
+
+def _GetPolicyNameList(template_file_contents):
+  return [ x for (x,_,_,_) in _GetPolicyList(template_file_contents) ]

[Mattias Nissler (ping if slow), 2011/10/13 14:14:34]

space after comma?

[Joao da Silva, 2011/10/13 14:40:43]

Done.

+
+
+def _GetChromePolicyList(template_file_contents):
+  return [ (x,y) for (x,y,z,w) in _GetPolicyList(template_file_contents)

[Mattias Nissler (ping if slow), 2011/10/13 14:14:34]

space after comma?

[Joao da Silva, 2011/10/13 14:40:43]

Done.

+                 if "chrome" in z and not w ]
+
+
+def _GetChromeOSPolicyList(template_file_contents):
+  return [ (x,y) for (x,y,z,w) in _GetPolicyList(template_file_contents)

[Mattias Nissler (ping if slow), 2011/10/13 14:14:34]

space after comma?

[Joao da Silva, 2011/10/13 14:40:43]

Done.

+                 if "chrome_os" in z and not "chrome" in z and not w ]
 
 
 def _LoadJSONFile(json_file):
   with open(json_file, "r") as f:
     text = f.read()
   return eval(text)
 
 
 #------------------ policy constants header ------------------------#
 def _WritePolicyConstantHeader(template_file_contents, args, opts):
   platform = args[0];
   with open(opts.header_path, "w") as f:
     _OutputGeneratedWarningForC(f, args[1])
+
     f.write('#ifndef CHROME_COMMON_POLICY_CONSTANTS_H_\n'
             '#define CHROME_COMMON_POLICY_CONSTANTS_H_\n'
             '#pragma once\n'
             '\n'
+            '#include "base/values.h"\n'
+            '#include "policy/configuration_policy_type.h"\n'
+            '\n'
             'namespace policy {\n\n')
+
     if platform == "win":
       f.write('// The windows registry path where policy configuration '
-              'resides.\nextern const wchar_t kRegistrySubKey[];\n\n')
+              'resides.\n'
+              'extern const wchar_t kRegistrySubKey[];\n\n')
+
+    f.write('// Lists policy types mapped to their names and expected types.\n'
+            '// Used to initialize ConfigurationPolicyProviders.\n'
+            'struct PolicyDefinitionList {\n'
+            '  struct Entry {\n'
+            '    ConfigurationPolicyType policy_type;\n'
+            '    base::Value::Type value_type;\n'
+            '    const char* name;\n'
+            '  };\n'
+            '\n'
+            '  const Entry* begin;\n'
+            '  const Entry* end;\n'
+            '};\n'
+            '\n'
+            '// Gets the policy name indexed by the policy type.\n'

[Mattias Nissler (ping if slow), 2011/10/13 14:14:34]

s/indexed by the/for the given/g

[Joao da Silva, 2011/10/13 14:40:43]

Done.

+            'const char* GetPolicyName(ConfigurationPolicyType type);\n'
+            '\n'
+            '// Returns the default policy definition list for Chrome.\n'
+            'const PolicyDefinitionList* GetChromePolicyDefinitionList();\n\n')
     f.write('// Key names for the policy settings.\n'
             'namespace key {\n\n')
     for policy_name in _GetPolicyNameList(template_file_contents):
       f.write('extern const char k' + policy_name + '[];\n')
-    f.write('\n// Only used in testing.'
-            '\nextern const char* kMapPolicyString[];\n')
     f.write('\n}  // namespace key\n\n'
             '}  // namespace policy\n\n'
             '#endif  // CHROME_COMMON_POLICY_CONSTANTS_H_\n')
 
 
 #------------------ policy constants source ------------------------#
 def _WritePolicyConstantSource(template_file_contents, args, opts):
   platform = args[0];
   with open(opts.source_path, "w") as f:
     _OutputGeneratedWarningForC(f, args[1])
-    f.write('#include "policy/policy_constants.h"\n'
+
+    f.write('#include "base/basictypes.h"\n'
+            '#include "base/logging.h"\n'
+            '#include "policy/policy_constants.h"\n'
             '\n'
-            'namespace policy {\n'
-            '\n')
+            'namespace policy {\n\n')
+
+    f.write('namespace {\n\n')
+
+    f.write('PolicyDefinitionList::Entry entries[] = {\n')
+    for (name, vtype) in _GetChromePolicyList(template_file_contents):
+      f.write('  { kPolicy%s, Value::%s, key::k%s },\n' % (name, vtype, name))
+    f.write('\n#if defined(OS_CHROMEOS)\n')
+    for (name, vtype) in _GetChromeOSPolicyList(template_file_contents):
+      f.write('  { kPolicy%s, Value::%s, key::k%s },\n' % (name, vtype, name))
+    f.write('#endif\n'
+            '};\n\n')
+
+    f.write('PolicyDefinitionList policy_list = {\n'
+            '  entries,\n'
+            '  entries + arraysize(entries),\n'
+            '};\n\n')
+
+    f.write('}  // namespace\n\n')
+
     if platform == "win":
       f.write('#if defined(GOOGLE_CHROME_BUILD)\n'
               'const wchar_t kRegistrySubKey[] = '
               'L"' + CHROME_SUBKEY + '";\n'
               '#else\n'
               'const wchar_t kRegistrySubKey[] = '
               'L"' + CHROMIUM_SUBKEY + '";\n'
               '#endif\n\n')
+
+    f.write('const char* GetPolicyName(ConfigurationPolicyType type) {\n'
+            '  const PolicyDefinitionList::Entry* entry;\n'
+            '  for (entry = policy_list.begin; entry != policy_list.end;'
+            ' ++entry) {\n'

[Mattias Nissler (ping if slow), 2011/10/13 14:14:34]

Please indent this line by two spaces if python allows it.

[Joao da Silva, 2011/10/13 14:40:43]

Obsolete; this became an array lookup as discussed offline.

+            '    if (entry->policy_type == type)\n'
+            '      return entry->name;\n'
+            '  }\n'
+            '  NOTREACHED();\n'
+            '  return NULL;\n'
+            '}\n'
+            '\n'
+            'const PolicyDefinitionList* GetChromePolicyDefinitionList() {\n'
+            '  return &policy_list;\n'
+            '}\n\n')
+
     f.write('namespace key {\n\n')
     for policy_name in _GetPolicyNameList(template_file_contents):
       f.write('const char k%s[] = "%s";\n' % (policy_name, policy_name))
-    f.write('\n// Only used in testing.'
-            '\nconst char* kMapPolicyString[] = {\n    ')
-    for policy_name in _GetPolicyNameList(template_file_contents):
-      f.write('\n    "%s",' % policy_name)
-    f.write('\n};\n')
     f.write('\n}  // namespace key\n\n'
             '}  // namespace policy\n')
 
 
 #------------------ policy type enumeration header -----------------#
 def _WritePolicyTypeEnumerationHeader(template_file_contents, args, opts):
   with open(opts.type_path, "w") as f:
     _OutputGeneratedWarningForC(f, args[1])
     f.write('#ifndef CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_TYPE_H_\n'
             '#define CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_TYPE_H_\n'
@@ skipping 193 matching lines @@
         for sub_policy in policy['policies']:
           _WritePolicyCode(f, sub_policy)
       else:
         _WritePolicyCode(f, policy)
     f.write(CPP_FOOT)
 
 
 #------------------ main() -----------------------------------------#
 if __name__ == '__main__':
   main();