Surface error messages from ONC parsing in about:policy.

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
+'''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).
+  and can be one of (win, mac, linux)
+chromium_os_flag should be 1 if this is a Chromium OS build
 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';
 
@@ skipping 20 matching lines @@
                     metavar="FILE");
   parser.add_option("--ppb", "--policy-protobuf", dest="proto_path",
                     help="generate cloud policy protobuf file",
                     metavar="FILE");
   parser.add_option("--ppd", "--protobuf-decoder", dest="decoder_path",
                     help="generate C++ code decoding the policy protobuf",
                     metavar="FILE");
 
   (opts, args) = parser.parse_args();
 
-  if len(args) < 2 or len(args) > 2:
-    print "exactly one platform and input file must be specified."
+  if len(args) != 3:
+    print "exactly platform, chromium_os flag and input file must be specified."
     parser.print_help()
     sys.exit(2)
-  template_file_contents = _LoadJSONFile(args[1]);
+  template_file_contents = _LoadJSONFile(args[2]);
   if opts.header_path is not None:
     _WritePolicyConstantHeader(template_file_contents, args, opts);
   if opts.source_path is not None:
     _WritePolicyConstantSource(template_file_contents, args, opts);
   if opts.type_path is not None:
     _WritePolicyTypeEnumerationHeader(template_file_contents, args, opts);
   if opts.proto_path is not None:
     _WriteProtobuf(template_file_contents, args, opts.proto_path)
   if opts.decoder_path is not None:
     _WriteProtobufParser(template_file_contents, args, opts.decoder_path)
 
 
 #------------------ 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')
 
 
 # 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'] ]
+  platforms = [ x.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']:
         policies.append(_GetPolicyDetails(sub_policy))
     else:
       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 [name for (name, _, _, _) in _GetPolicyList(template_file_contents)]
 
 
 def _GetChromePolicyList(template_file_contents):
-  return [(name, vtype) for (name, vtype, platforms, is_device_only)
-                        in _GetPolicyList(template_file_contents)
-                        if 'chrome' in platforms and not is_device_only]
-
-
-def _GetChromeOSPolicyList(template_file_contents):
-  return [(name, vtype) for (name, vtype, platforms, is_device_only)
-                        in _GetPolicyList(template_file_contents)
-                        if 'chrome_os' in platforms
-                          and not 'chrome' in platforms
-                          and not is_device_only]
+  return [(name, platforms, vtype) for (name, vtype, platforms, is_device_only)

[Joao da Silva, 2011/11/04 17:44:24]

Since |is_device_only| is never used, it could be removed from the tuple
returned from _GetPolicyDetails.

[Mattias Nissler (ping if slow), 2011/11/07 10:48:45]

Done.

+                                   in _GetPolicyList(template_file_contents)]
 
 
 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];
+  os = args[0];
   with open(opts.header_path, "w") as f:
-    _OutputGeneratedWarningForC(f, args[1])
+    _OutputGeneratedWarningForC(f, args[2])
 
     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":
+    if os == "win":
       f.write('// The windows registry path where policy configuration '
               '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'
@@ skipping 13 matching lines @@
             'namespace key {\n\n')
     for policy_name in _GetPolicyNameList(template_file_contents):
       f.write('extern const char k' + policy_name + '[];\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];
+  os = args[0];
+  is_chromium_os = args[1] == "1"
+  platform = None
+  platform_wildcard = None
+  if is_chromium_os:
+    platform = 'chrome_os'
+  else:
+    platform = 'chrome.' + os.lower()
+    platform_wildcard = 'chrome.*'
   with open(opts.source_path, "w") as f:
-    _OutputGeneratedWarningForC(f, args[1])
+    _OutputGeneratedWarningForC(f, args[2])
 
     f.write('#include "base/basictypes.h"\n'
             '#include "base/logging.h"\n'
             '#include "policy/policy_constants.h"\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')
+    policy_list = _GetChromePolicyList(template_file_contents)
+    for (name, platforms, vtype) in policy_list:
+      if (platform in platforms) or (platform_wildcard in platforms):
+        f.write('  { kPolicy%s, Value::%s, key::k%s },\n' % (name, vtype, name))
+    f.write('};\n\n')
 
     f.write('PolicyDefinitionList chrome_policy_list = {\n'
             '  entries,\n'
             '  entries + arraysize(entries),\n'
             '};\n\n')
 
     f.write('// Maps a policy-type enum value to the policy name.\n'
             'const char* policy_name_map[] = {\n');
     for name in _GetPolicyNameList(template_file_contents):
       f.write('  key::k%s,\n' % name)
     f.write('};\n\n')
 
     f.write('}  // namespace\n\n')
 
-    if platform == "win":
+    if os == "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'
             '  CHECK(type >= 0 && '
               'static_cast<size_t>(type) < arraysize(policy_name_map));\n'
             '  return policy_name_map[type];\n'
             '}\n'
             '\n'
             'const PolicyDefinitionList* GetChromePolicyDefinitionList() {\n'
             '  return &chrome_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}  // 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])

[Joao da Silva, 2011/11/04 17:44:24]

args[2]?

[Mattias Nissler (ping if slow), 2011/11/07 10:48:45]

Done.

     f.write('#ifndef CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_TYPE_H_\n'
             '#define CHROME_BROWSER_POLICY_CONFIGURATION_POLICY_TYPE_H_\n'
             '#pragma once\n'
             '\n'
             'namespace policy {\n'
             '\n'
             'enum ConfigurationPolicyType {\n')
     for policy_name in _GetPolicyNameList(template_file_contents):
       f.write('  kPolicy' + policy_name + ",\n");
     f.write('};\n\n'
@@ skipping 49 matching lines @@
   file.write('  optional PolicyOptions policy_options = 1;\n')
   file.write('  optional %s %s = 2;\n' %
              (PROTOBUF_TYPE[policy['type']], policy['name']))
   file.write('}\n\n')
   fields += ['  optional %sProto %s = %s;\n' %
              (policy['name'], policy['name'], policy['id'] + RESERVED_IDS)]
 
 
 def _WriteProtobuf(template_file_contents, args, outfilepath):
   with open(outfilepath, 'w') as f:
     _OutputGeneratedWarningForC(f, args[1])

[Joao da Silva, 2011/11/04 17:44:24]

args[2]?

[Mattias Nissler (ping if slow), 2011/11/07 10:48:45]

Done.

     f.write(PROTO_HEAD)
 
     fields = []
     f.write('// PBs for individual settings.\n\n')
     for policy in template_file_contents['policy_definitions']:
       if policy['type'] == 'group':
         for sub_policy in policy['policies']:
           _WritePolicyProto(f, sub_policy, fields)
       else:
         _WritePolicyProto(f, policy, fields)
@@ skipping 101 matching lines @@
   file.write('        Value* value = %s(%s.%s());\n' %
              (_CreateValue(policy['type']), proto_name, membername))
   file.write('        destination->Set(kPolicy%s, value);\n' % policy['name'])
   file.write('      }\n'
              '    }\n'
              '  }\n')
 
 
 def _WriteProtobufParser(template_file_contents, args, outfilepath):
   with open(outfilepath, 'w') as f:
     _OutputGeneratedWarningForC(f, args[1])

[Joao da Silva, 2011/11/04 17:44:24]

args[2]?

[Mattias Nissler (ping if slow), 2011/11/07 10:48:45]

Done.

     f.write(CPP_HEAD)
     for policy in template_file_contents['policy_definitions']:
       if policy['type'] == 'group':
         for sub_policy in policy['policies']:
           _WritePolicyCode(f, sub_policy)
       else:
         _WritePolicyCode(f, policy)
     f.write(CPP_FOOT)
 
 
 #------------------ main() -----------------------------------------#
 if __name__ == '__main__':
   main();