Generate the Chrome policy schema at compile time.

chrome/tools/build/generate_policy_source.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.
 
 '''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)
 chromium_os_flag should be 1 if this is a Chromium OS build
@@ skipping 35 matching lines @@
   class EnumItem:
     def __init__(self, item):
       self.caption = PolicyDetails._RemovePlaceholders(item['caption'])
       self.value = item['value']
 
   def __init__(self, policy, os, is_chromium_os):
     self.id = policy['id']
     self.name = policy['name']
     self.is_deprecated = policy.get('deprecated', False)
     self.is_device_only = policy.get('device_only', False)
+    self.schema = policy.get('schema', {})
 
     if is_chromium_os:
       expected_platform = 'chrome_os'
     else:
       expected_platform = os.lower()
 
     self.platforms = []
     for platform, version in [ p.split(':') for p in policy['supported_on'] ]:
       if not version.endswith('-'):
         continue
@@ skipping 143 matching lines @@
 
 def _WritePolicyConstantHeader(policies, os, f):
   f.write('#ifndef CHROME_COMMON_POLICY_CONSTANTS_H_\n'
           '#define CHROME_COMMON_POLICY_CONSTANTS_H_\n'
           '\n'
           '#include <string>\n'
           '\n'
           '#include "base/basictypes.h"\n'
           '#include "base/values.h"\n'
           '\n'
-          'namespace policy {\n\n')
+          'namespace policy {\n'
+          '\n'
+          'namespace internal {\n'
+          'struct SchemaData;\n'
+          '}\n\n')
 
   if os == 'win':
     f.write('// The windows registry path where Chrome policy '
             'configuration resides.\n'
             'extern const wchar_t kRegistryChromePolicyKey[];\n')
 
   f.write('// Lists metadata such as name, expected type and id for all\n'
           '// policies. Used to initialize ConfigurationPolicyProviders and\n'
           '// CloudExternalDataManagers.\n'
           'struct PolicyDefinitionList {\n'
           '  struct Entry {\n'
           '    const char* name;\n'
           '    base::Value::Type value_type;\n'
           '    bool device_policy;\n'
           '    int id;\n'
           '    size_t max_external_data_size;\n'
           '  };\n'
           '\n'
           '  const Entry* begin;\n'
           '  const Entry* end;\n'
           '};\n'
           '\n'
           '// Returns true if the given policy is deprecated.\n'
           'bool IsDeprecatedPolicy(const std::string& policy);\n'
           '\n'
           '// Returns the default policy definition list for Chrome.\n'
-          'const PolicyDefinitionList* GetChromePolicyDefinitionList();\n\n')
+          'const PolicyDefinitionList* GetChromePolicyDefinitionList();\n'
+          '\n'
+          '// Returns the schema data of the Chrome policy schema.\n'
+          'const internal::SchemaData* GetChromeSchemaData();\n'
+          '\n')
   f.write('// Key names for the policy settings.\n'
           'namespace key {\n\n')
   for policy in policies:
     # TODO(joaodasilva): Include only supported policies in
     # configuration_policy_handler.cc and configuration_policy_handler_list.cc
     # so that these names can be conditional on 'policy.is_supported'.
     # http://crbug.com/223616
     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 _GetValueType(policy_type):
   return policy_type if policy_type != 'TYPE_EXTERNAL' else 'TYPE_DICTIONARY'
 
 
+# A mapping of the simple schema types to base::Value::Types.
+SIMPLE_SCHEMA_NAME_MAP = {
+  'boolean': 'TYPE_BOOLEAN',
+  'integer': 'TYPE_INTEGER',
+  'null'   : 'TYPE_NULL',
+  'number' : 'TYPE_DOUBLE',
+  'string' : 'TYPE_STRING',
+}
+
+
+class SchemaNodesGenerator:
+  """Builds the internal structs to represent a JSON schema."""
+
+  def __init__(self, shared_strings):
+    """Creates a new generator.
+
+    |shared_strings| is a map of strings to a C expression that evaluates to
+    that string at runtime. This mapping can be used to reuse existing string
+    constants."""
+    self.shared_strings = shared_strings
+    self.schema_nodes = []
+    self.property_nodes = []
+    self.properties_nodes = []
+    self.simple_types = {
+      'boolean': -1,
+      'integer': -1,

[dconnelly, 2013/10/22 11:55:52]

use None instead of -1

[Joao da Silva, 2013/10/22 12:53:27]

Done.

+      'null': -1,
+      'number': -1,
+      'string': -1,
+    }
+    self.stringlist_type = -1
+
+  def GetString(self, s):
+    if s in self.shared_strings:
+      return self.shared_strings[s]
+    else:
+      return '"%s"' % s
+
+  def AppendSchema(self, type, extra, comment=''):
+    index = len(self.schema_nodes)
+    self.schema_nodes.append((type, extra, comment))
+    return index
+
+  def GetSimpleType(self, name):
+    assert name in self.simple_types
+    assert name in SIMPLE_SCHEMA_NAME_MAP
+    if self.simple_types[name] == -1:
+      self.simple_types[name] = self.AppendSchema(
+          SIMPLE_SCHEMA_NAME_MAP[name],
+          -1,
+          'simple type: ' + name)
+    return self.simple_types[name]
+
+  def GetStringList(self):
+    if self.stringlist_type == -1:
+      self.stringlist_type = self.AppendSchema(
+          'TYPE_LIST',
+          self.GetSimpleType('string'),
+          'simple type: stringlist')
+    return self.stringlist_type
+
+  def Generate(self, schema, name):
+    """Generates the structs for the given schema.
+
+    |schema|: a valid JSON schema in a dictionary.
+    |name|: the name of the current node, for the generated comments."""
+    # Simple types use shared nodes.
+    if schema['type'] in self.simple_types:
+      return self.GetSimpleType(schema['type'])
+
+    if schema['type'] == 'array':
+      # Special case for lists of strings, which is a common policy type.
+      if schema['items']['type'] == 'string':
+        return self.GetStringList()
+      return self.AppendSchema(
+          'TYPE_LIST',
+          self.Generate(schema['items'], 'items of ' + name))
+    elif schema['type'] == 'object':
+      # Reserve an index first, so that dictionaries come before their
+      # properties. This makes sure that the root node is the first in the
+      # SchemaNodes array.
+      index = self.AppendSchema('TYPE_DICTIONARY', -1)
+
+      if 'additionalProperties' in schema:
+        additionalProperties = self.Generate(
+            schema['additionalProperties'],
+            'additionalProperties of ' + name)
+      else:
+        additionalProperties = -1
+
+      # Properties must be sorted by name, for the binary search lookup.
+      sorted_properties = sorted(schema.get('properties', {}).items())
+      properties = [ (self.GetString(key), self.Generate(schema, key))

[dconnelly, 2013/10/22 11:55:52]

This can be a generator expression

[Joao da Silva, 2013/10/22 12:53:27]

Done.

[Joao da Silva, 2013/11/03 20:55:00]

Actually it can't :-)

Turning this into a generator means that the recursive call to self.Generate()
will be performed while inserting the parent node's properties, so that child
nodes get in between; this breaks the binary search lookups.

A very subtle bug, and an indicator that this code is not very obvious. I've
added a new test that catches this problem in another CL, and I'll revert this
change in this CL.

[dconnelly, 2013/11/04 09:18:51]

yuck, good catch

On 2013/11/03 20:55:00, Joao da Silva wrote:

+                     for key, schema in sorted_properties ]
+      begin = len(self.property_nodes)
+      self.property_nodes += properties
+      end = len(self.property_nodes)
+
+      extra = len(self.properties_nodes)
+      self.properties_nodes.append((begin, end, additionalProperties, name))
+
+      # Set the right data at |index| now.
+      self.schema_nodes[index] = ('TYPE_DICTIONARY', extra, name)
+      return index
+    else:
+      assert False
+
+  def Write(self, f):
+    """Writes the generated structs to the given file.
+
+    |f| an open file to write to."""
+    f.write('const internal::SchemaNode kSchemas[] = {\n'
+            '//  Type                          Extra\n')
+    for type, extra, comment in self.schema_nodes:
+      type += ','
+      f.write('  { base::Value::%-18s %3d },  // %s\n' % (type, extra, comment))
+    f.write('};\n\n')
+
+    f.write('const internal::PropertyNode kPropertyNodes[] = {\n'
+            '//  Property                                           #Schema\n')
+    for key, schema in self.property_nodes:
+      key += ','
+      f.write('  { %-50s %7d },\n' % (key, schema))
+    f.write('};\n\n')
+
+    f.write('const internal::PropertiesNode kProperties[] = {\n'
+            '//  Begin    End  Additional Properties\n')
+    for node in self.properties_nodes:
+      f.write('  { %5d, %5d, %5d },  // %s\n' % node)
+    f.write('};\n\n')
+
+    f.write('const internal::SchemaData kChromeSchemaData = {\n'
+            '  kSchemas,\n'
+            '  kPropertyNodes,\n'
+            '  kProperties,\n'
+            '};\n\n')
+
+
 def _WritePolicyConstantSource(policies, os, f):
   f.write('#include "base/basictypes.h"\n'
           '#include "base/logging.h"\n'
+          '#include "components/policy/core/common/schema_internal.h"\n'
           '#include "policy/policy_constants.h"\n'
           '\n'
-          'namespace policy {\n\n')
+          'namespace policy {\n'
+          '\n'
+          'namespace {\n'
+          '\n')
 
-  f.write('namespace {\n\n')
+  # Generate the Chrome schema.
+  chrome_schema = {
+    'type': 'object',
+    'properties': {},
+  }
+  shared_strings = {}
+  for policy in policies:
+    shared_strings[policy.name] = "key::k%s" % policy.name
+    if policy.is_supported:
+      chrome_schema['properties'][policy.name] = policy.schema
 
   f.write('const PolicyDefinitionList::Entry kEntries[] = {\n')
   for policy in policies:
     if policy.is_supported:
       f.write('  { key::k%s, base::Value::%s, %s, %s, %s },\n' %
           (policy.name, _GetValueType(policy.policy_type),
               'true' if policy.is_device_only else 'false', policy.id,
               policy.max_size))
   f.write('};\n\n')
 
   f.write('const PolicyDefinitionList kChromePolicyList = {\n'
           '  kEntries,\n'
           '  kEntries + arraysize(kEntries),\n'
           '};\n\n')
 
   has_deprecated_policies = any(
       [p.is_supported and p.is_deprecated for p in policies])
 
   if has_deprecated_policies:
     f.write('// List of deprecated policies.\n'
             'const char* kDeprecatedPolicyList[] = {\n')
     for policy in policies:
       if policy.is_supported and policy.is_deprecated:
         f.write('  key::k%s,\n' % policy.name)
     f.write('};\n\n')
 
+  schema_generator = SchemaNodesGenerator(shared_strings)
+  schema_generator.Generate(chrome_schema, 'root node')
+  schema_generator.Write(f)
+
   f.write('}  // namespace\n\n')
 
   if os == 'win':
     f.write('#if defined(GOOGLE_CHROME_BUILD)\n'
             'const wchar_t kRegistryChromePolicyKey[] = '
             'L"' + CHROME_POLICY_KEY + '";\n'
             '#else\n'
             'const wchar_t kRegistryChromePolicyKey[] = '
             'L"' + CHROMIUM_POLICY_KEY + '";\n'
             '#endif\n\n')
 
   f.write('bool IsDeprecatedPolicy(const std::string& policy) {\n')
   if has_deprecated_policies:
     # arraysize() doesn't work with empty arrays.
     f.write('  for (size_t i = 0; i < arraysize(kDeprecatedPolicyList);'
                 ' ++i) {\n'
             '    if (policy == kDeprecatedPolicyList[i])\n'
             '      return true;\n'
             '  }\n')
   f.write('  return false;\n'
           '}\n\n')
 
   f.write('const PolicyDefinitionList* GetChromePolicyDefinitionList() {\n'
           '  return &kChromePolicyList;\n'
           '}\n\n')
 
+  f.write('const internal::SchemaData* GetChromeSchemaData() {\n'
+          '  return &kChromeSchemaData;\n'
+          '}\n\n')
+
   f.write('namespace key {\n\n')
   for policy in policies:
     # TODO(joaodasilva): Include only supported policies in
     # configuration_policy_handler.cc and configuration_policy_handler_list.cc
     # so that these names can be conditional on 'policy.is_supported'.
     # http://crbug.com/223616
     f.write('const char k{name}[] = "{name}";\n'.format(name=policy.name))
   f.write('\n}  // namespace key\n\n'
           '}  // namespace policy\n')
 
@@ skipping 242 matching lines @@
 def _WriteCloudPolicyDecoder(policies, os, f):
   f.write(CPP_HEAD)
   for policy in policies:
     if policy.is_supported and not policy.is_device_only:
       _WritePolicyCode(f, policy)
   f.write(CPP_FOOT)
 
 
 if __name__ == '__main__':
   sys.exit(main())