Generate code for encoding cloud policy protobufs

components/policy/tools/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 189 matching lines @@
                     metavar='FILE')
   parser.add_option('--ard', '--app-restrictions-definition',
                     dest='app_restrictions_path',
                     help='generate an XML file as specified by '
                     'Android\'s App Restriction Schema',
                     metavar='FILE')
   parser.add_option('--rth', '--risk-tag-header',
                     dest='risk_header_path',
                     help='generate header file for policy risk tags',
                     metavar='FILE')
+  parser.add_option('--crospch', '--cros-policy-constants-header',
+                    dest='cros_constants_header_path',
+                    help='generate header file of policy constants for use in '
+                         'Chrome OS',
+                    metavar='FILE')
+  parser.add_option('--crospcc', '--cros-policy-constants-source',
+                    dest='cros_constants_source_path',
+                    help='generate source file of policy constants for use in '
+                         'Chrome OS',
+                    metavar='FILE')
   (opts, args) = parser.parse_args()
 
   if len(args) != 4:
     print('Please specify path to src/chrome/VERSION, platform, '
           'chromium_os flag and input file as positional parameters.')
     parser.print_help()
     return 2
 
   version_path = args[0]
   os = args[1]
   is_chromium_os = args[2] == '1'
   template_file_name = args[3]
 
   major_version = ParseVersionFile(version_path)
   template_file_contents = _LoadJSONFile(template_file_name)
-  riskTags = RiskTags(template_file_contents)
+  risk_tags = RiskTags(template_file_contents)
   policy_details = [ PolicyDetails(policy, major_version, os, is_chromium_os,
-                                   riskTags.GetValidTags())
+                                   risk_tags.GetValidTags())
                      for policy in _Flatten(template_file_contents) ]
-  riskTags.ComputeMaxTags(policy_details)
+  risk_tags.ComputeMaxTags(policy_details)
   sorted_policy_details = sorted(policy_details, key=lambda policy: policy.name)
 
   def GenerateFile(path, writer, sorted=False, xml=False):
     if path:
       with open(path, 'w') as f:
         _OutputGeneratedWarningHeader(f, template_file_name, xml)
         writer(sorted and sorted_policy_details or policy_details,
-               os, f, riskTags)
+               os, f, risk_tags)
 
   if opts.header_path:
     GenerateFile(opts.header_path, _WritePolicyConstantHeader, sorted=True)
   if opts.source_path:
     GenerateFile(opts.source_path, _WritePolicyConstantSource, sorted=True)
   if opts.risk_header_path:
     GenerateFile(opts.risk_header_path, _WritePolicyRiskTagHeader)
   if opts.cloud_policy_proto_path:
     GenerateFile(opts.cloud_policy_proto_path, _WriteCloudPolicyProtobuf)
   if opts.cloud_policy_full_runtime_proto_path:
     GenerateFile(opts.cloud_policy_full_runtime_proto_path,
         _WriteCloudPolicyFullRuntimeProtobuf)
   if opts.chrome_settings_proto_path:
     GenerateFile(opts.chrome_settings_proto_path, _WriteChromeSettingsProtobuf)
   if opts.chrome_settings_full_runtime_proto_path:
     GenerateFile(opts.chrome_settings_full_runtime_proto_path,
         _WriteChromeSettingsFullRuntimeProtobuf)
   if opts.cloud_policy_decoder_path:
     GenerateFile(opts.cloud_policy_decoder_path, _WriteCloudPolicyDecoder)
 
   if os == 'android' and opts.app_restrictions_path:
     GenerateFile(opts.app_restrictions_path, _WriteAppRestrictions, xml=True)
 
+  # Generated code for Chrome OS (unused in Chromium).
+  if opts.cros_constants_header_path:
+    GenerateFile(opts.cros_constants_header_path,
+        _WriteChromeOSPolicyConstantsHeader, sorted=True)
+  if opts.cros_constants_source_path:
+    GenerateFile(opts.cros_constants_source_path,
+        _WriteChromeOSPolicyConstantsSource, sorted=True)
+
   return 0
 
 
 #------------------ shared helpers ---------------------------------#
 
 def _OutputGeneratedWarningHeader(f, template_file_path, xml_style):
   left_margin = '//'
   if xml_style:
     left_margin = '    '
     f.write('<?xml version="1.0" encoding="utf-8"?>\n'
@@ skipping 39 matching lines @@
 
 
 def _LoadJSONFile(json_file):
   with open(json_file, 'r') as f:
     text = f.read()
   return eval(text)
 
 
 #------------------ policy constants header ------------------------#
 
-def _WritePolicyConstantHeader(policies, os, f, riskTags):
+def _WritePolicyConstantHeader(policies, os, f, risk_tags):
   f.write('#ifndef CHROME_COMMON_POLICY_CONSTANTS_H_\n'
           '#define CHROME_COMMON_POLICY_CONSTANTS_H_\n'
           '\n'
           '#include <string>\n'
           '\n'
           '#include "base/values.h"\n'
           '#include "components/policy/core/common/policy_details.h"\n'
           '#include "components/policy/core/common/policy_map.h"\n'
           '\n'
           'namespace policy {\n'
@@ skipping 368 matching lines @@
     setup = ['auto default_value = base::MakeUnique<base::ListValue>();']
     for entry in value:
       decl, fetch = _GenerateDefaultValue(entry)
       # Nested lists are not supported.
       if decl:
         return [], None
       setup.append('default_value->Append(%s);' % fetch)
     return setup, 'std::move(default_value)'
   return [], None
 
-def _WritePolicyConstantSource(policies, os, f, riskTags):
+def _WritePolicyConstantSource(policies, os, f, risk_tags):
   f.write('#include "components/policy/policy_constants.h"\n'
           '\n'
           '#include <algorithm>\n'
           '#include <climits>\n'
           '\n'
           '#include "base/logging.h"\n'
           '#include "base/memory/ptr_util.h"\n'
           '#include "components/policy/core/common/policy_types.h"\n'
           '#include "components/policy/core/common/schema_internal.h"\n'
           '#include "components/policy/risk_tag.h"\n'
@@ skipping 20 matching lines @@
           '//  is_deprecated  is_device_policy  id    max_external_data_size\n')
   for policy in policies:
     if policy.is_supported:
       f.write('  // %s\n' % policy.name)
       f.write('  { %-14s %-16s %3s, %24s,\n'
               '    %s },\n' % (
                   'true,' if policy.is_deprecated else 'false,',
                   'true,' if policy.is_device_only else 'false,',
                   policy.id,
                   policy.max_size,
-                  riskTags.ToInitString(policy.tags)))
+                  risk_tags.ToInitString(policy.tags)))
   f.write('};\n\n')
 
   schema_generator = SchemaNodesGenerator(shared_strings)
   schema_generator.GenerateAndCollectID(chrome_schema, 'root node')
   schema_generator.ResolveReferences()
   schema_generator.Write(f)
 
   f.write('\n'
           'namespace {\n')
 
@@ skipping 83 matching lines @@
   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')
 
 
-#------------------ policy risk tag header ------------------------#
+#------------------ policy risk tag header -------------------------#
 
 class RiskTags(object):
   '''Generates files and strings to translate the parsed risk tags.'''
   # TODO(fhorschig|tnagel): Add, Check & Generate translation descriptions.
 
   def __init__(self, template_file_contents):
     self.max_tags = None
     self.enum_for_tag = OrderedDict()  # Ordered by severity as stated in JSON.
     self._ReadRiskTagMetaData(template_file_contents)
 
@@ skipping 36 matching lines @@
       if tag.get('name', None) == None:
         raise RuntimeError('Tag in \'risk_tag_definitions\' without '
                            'description found!')
       if tag.get('description', None) == None:
         raise RuntimeError('Tag ' + tag['name'] + ' has no description!')
       if tag.get('user-description', None) == None:
         raise RuntimeError('Tag ' + tag['name'] + ' has no user-description!')
       self.enum_for_tag[tag['name']] = "RISK_TAG_" + \
                                        tag['name'].replace("-","_").upper()
 
-def _WritePolicyRiskTagHeader(policies, os, f, riskTags):
+def _WritePolicyRiskTagHeader(policies, os, f, risk_tags):
   f.write('#ifndef CHROME_COMMON_POLICY_RISK_TAG_H_\n'
           '#define CHROME_COMMON_POLICY_RISK_TAG_H_\n'
           '\n'
           '#include <stddef.h>\n'
           '\n'
           'namespace policy {\n'
           '\n' + \
           '// The tag of a policy indicates which impact a policy can have on\n'
           '// a user\'s privacy and/or security. Ordered descending by \n'
           '// impact.\n'
           '// The explanation of the single tags is stated in\n'
           '// policy_templates.json within the \'risk_tag_definitions\' tag.'
-          '\n' + riskTags.GenerateEnum() + '\n'
+          '\n' + risk_tags.GenerateEnum() + '\n'
           '// This constant describes how many risk tags were used by the\n'
           '// policy which uses the most risk tags. \n'
           'const size_t kMaxRiskTagCount = ' + \
-                riskTags.GetMaxTags() + ';\n'
+                risk_tags.GetMaxTags() + ';\n'
           '\n'
           '}  // namespace policy\n'
           '\n'
           '#endif  // CHROME_COMMON_POLICY_RISK_TAG_H_'
           '\n')
 
-#------------------ policy protobufs --------------------------------#
+#------------------ policy protobufs -------------------------------#
 
 CHROME_SETTINGS_PROTO_HEAD = '''
 syntax = "proto2";
 
 option optimize_for = LITE_RUNTIME;
 
 package enterprise_management;
 
 // For StringList and PolicyOptions.
 import "cloud_policy.proto";
@@ skipping 66 matching lines @@
     _OutputComment(f, '\nNote: this policy must have a RECOMMENDED ' +\
                       'PolicyMode set in PolicyOptions.')
   f.write('message %sProto {\n' % policy.name)
   f.write('  optional PolicyOptions policy_options = 1;\n')
   f.write('  optional %s %s = 2;\n' % (policy.protobuf_type, policy.name))
   f.write('}\n\n')
   fields += [ '  optional %sProto %s = %s;\n' %
               (policy.name, policy.name, policy.id + RESERVED_IDS) ]
 
 
-def _WriteChromeSettingsProtobuf(policies, os, f, riskTags):
+def _WriteChromeSettingsProtobuf(policies, os, f, risk_tags):
   f.write(CHROME_SETTINGS_PROTO_HEAD)
   fields = []
   f.write('// PBs for individual settings.\n\n')
   for policy in policies:
     # Note: This protobuf also gets the unsupported policies, since it's an
     # exhaustive list of all the supported user policies on any platform.
     if not policy.is_device_only:
       _WritePolicyProto(f, policy, fields)
 
   f.write('// --------------------------------------------------\n'
           '// Big wrapper PB containing the above groups.\n\n'
           'message ChromeSettingsProto {\n')
   f.write(''.join(fields))
   f.write('}\n\n')
 
 
-def _WriteChromeSettingsFullRuntimeProtobuf(policies, os, f, riskTags):
+def _WriteChromeSettingsFullRuntimeProtobuf(policies, os, f, risk_tags):
   # For full runtime, disable LITE_RUNTIME switch and import full runtime
   # version of cloud_policy.proto.
   f.write(CHROME_SETTINGS_PROTO_HEAD.replace(
       "option optimize_for = LITE_RUNTIME;",
       "//option optimize_for = LITE_RUNTIME;").replace(
           "import \"cloud_policy.proto\";",
           "import \"cloud_policy_full_runtime.proto\";"
       ))
   fields = []
   f.write('// PBs for individual settings.\n\n')
   for policy in policies:
     # Note: This protobuf also gets the unsupported policies, since it's an
     # exhaustive list of all the supported user policies on any platform.
     if not policy.is_device_only:
       _WritePolicyProto(f, policy, fields)
 
   f.write('// --------------------------------------------------\n'
           '// Big wrapper PB containing the above groups.\n\n'
           'message ChromeSettingsProto {\n')
   f.write(''.join(fields))
   f.write('}\n\n')
 
 
-def _WriteCloudPolicyProtobuf(policies, os, f, riskTags):
+def _WriteCloudPolicyProtobuf(policies, os, f, risk_tags):
   f.write(CLOUD_POLICY_PROTO_HEAD)
   f.write('message CloudPolicySettings {\n')
   for policy in policies:
     if policy.is_supported and not policy.is_device_only:
       f.write('  optional %sPolicyProto %s = %s;\n' %
               (policy.policy_protobuf_type, policy.name,
                policy.id + RESERVED_IDS))
   f.write('}\n\n')
 
 
-def _WriteCloudPolicyFullRuntimeProtobuf(policies, os, f, riskTags):
+def _WriteCloudPolicyFullRuntimeProtobuf(policies, os, f, risk_tags):
   # For full runtime, disable LITE_RUNTIME switch
   f.write(CLOUD_POLICY_PROTO_HEAD.replace(
       "option optimize_for = LITE_RUNTIME;",
       "//option optimize_for = LITE_RUNTIME;"))
   f.write('message CloudPolicySettings {\n')
   for policy in policies:
     if policy.is_supported and not policy.is_device_only:
       f.write('  optional %sPolicyProto %s = %s;\n' %
               (policy.policy_protobuf_type, policy.name,
                policy.id + RESERVED_IDS))
   f.write('}\n\n')
 
 
 #------------------ protobuf decoder -------------------------------#
 
-CPP_HEAD = '''
+CLOUD_POLICY_DECODER_CPP_HEAD = '''
 #include <limits>
 #include <memory>
 #include <utility>
 #include <string>
 
 #include "base/callback.h"
 #include "base/json/json_reader.h"
 #include "base/logging.h"
 #include "base/memory/ptr_util.h"
 #include "base/memory/weak_ptr.h"
@@ skipping 43 matching lines @@
   // convert and check the concrete type.
   return root;
 }
 
 void DecodePolicy(const em::CloudPolicySettings& policy,
                   base::WeakPtr<CloudExternalDataManager> external_data_manager,
                   PolicyMap* map) {
 '''
 
 
-CPP_FOOT = '''}
+CLOUD_POLICY_DECODER_CPP_FOOT = '''}
 
 }  // namespace policy
 '''
 
 
 def _CreateValue(type, arg):
   if type == 'Type::BOOLEAN':
     return 'new base::Value(%s)' % arg
   elif type == 'Type::INTEGER':
     return 'DecodeIntegerValue(%s)' % arg
   elif type == 'Type::STRING':
     return 'new base::Value(%s)' % arg
   elif type == 'Type::LIST':
     return 'DecodeStringList(%s)' % arg
   elif type == 'Type::DICTIONARY' or type == 'TYPE_EXTERNAL':
     return 'DecodeJson(%s)' % arg
   else:
     raise NotImplementedError('Unknown type %s' % type)
 
 
 def _CreateExternalDataFetcher(type, name):
   if type == 'TYPE_EXTERNAL':
     return 'new ExternalDataFetcher(external_data_manager, key::k%s)' % name
   return 'nullptr'
 
 
-def _WritePolicyCode(f, policy):
+def _WriteCloudPolicyDecoderCode(f, policy):
   membername = policy.name.lower()
   proto_type = '%sPolicyProto' % policy.policy_protobuf_type
   f.write('  if (policy.has_%s()) {\n' % membername)
   f.write('    const em::%s& policy_proto = policy.%s();\n' %
           (proto_type, membername))
   f.write('    if (policy_proto.has_value()) {\n')
   f.write('      PolicyLevel level = POLICY_LEVEL_MANDATORY;\n'
           '      bool do_set = true;\n'
           '      if (policy_proto.has_policy_options()) {\n'
           '        do_set = false;\n'
@@ skipping 24 matching lines @@
           '                   POLICY_SCOPE_USER, \n'
           '                   POLICY_SOURCE_CLOUD, \n'
           '                   std::move(value), \n'
           '                   std::move(external_data_fetcher));\n'
           '        }\n'
           '      }\n'
           '    }\n'
           '  }\n')
 
 
-def _WriteCloudPolicyDecoder(policies, os, f, riskTags):
-  f.write(CPP_HEAD)
+def _WriteCloudPolicyDecoder(policies, os, f, risk_tags):
+  f.write(CLOUD_POLICY_DECODER_CPP_HEAD)
   for policy in policies:
     if policy.is_supported and not policy.is_device_only:
-      _WritePolicyCode(f, policy)
-  f.write(CPP_FOOT)
+      _WriteCloudPolicyDecoderCode(f, policy)
+  f.write(CLOUD_POLICY_DECODER_CPP_FOOT)
 
 
-def _WriteAppRestrictions(policies, os, f, riskTags):
+#------------------ Chrome OS policy constants header --------------#
+
+# Returns a list of supported user policies by filtering |policies|.
+def _GetSupportedUserPolicies(policies):
+  return filter(lambda policy: policy.is_supported and
+                               not policy.is_device_only, policies)
+
+
+# Returns the set of all policy.policy_protobuf_type strings from |policies|.
+def _GetProtobufTypes(policies):
+  return set(policy.policy_protobuf_type for policy in policies)
+
+
+# Writes the definition of an array that contains the pointers to the mutable
+# proto field for each policy in |policies| of the given |protobuf_type|.
+def _WriteChromeOSPolicyAccessHeader(f, protobuf_type):
+  f.write('// Access to the mutable protobuf function of all supported '
+          '%s user\n// policies.\n' % protobuf_type.lower())
+  f.write('struct %sPolicyAccess {\n'
+          '  const char* policy_key;\n'
+          '  enterprise_management::%sPolicyProto*\n'
+          '      (enterprise_management::CloudPolicySettings::'
+          '*mutable_proto_ptr)();\n'
+          '};\n' % (protobuf_type, protobuf_type))
+  f.write('extern const %sPolicyAccess k%sPolicyAccess[];\n\n'
+          % (protobuf_type, protobuf_type))
+
+
+# Writes policy_constants.h for use in Chrome OS.
+def _WriteChromeOSPolicyConstantsHeader(policies, os, f, risk_tags):
+  f.write('#ifndef __BINDINGS_POLICY_CONSTANTS_H_\n'
+          '#define __BINDINGS_POLICY_CONSTANTS_H_\n\n')
+
+  # Forward declarations.
+  supported_user_policies = _GetSupportedUserPolicies(policies)
+  protobuf_types = _GetProtobufTypes(supported_user_policies)
+  f.write('namespace enterprise_management {\n'
+          'class CloudPolicySettings;\n')
+  for protobuf_type in protobuf_types:
+    f.write('class %sPolicyProto;\n' % protobuf_type)
+  f.write('}  // namespace enterprise_management\n\n')
+
+  f.write('namespace policy {\n\n')
+
+  # Policy keys.
+  f.write('// Registry key names for user and device policies.\n'
+          'namespace key {\n\n')
+  for policy in policies:
+    f.write('extern const char k' + policy.name + '[];\n')
+  f.write('\n}  // namespace key\n\n')
+
+  # User policy proto pointers, one struct for each protobuf type.
+  for protobuf_type in protobuf_types:
+    _WriteChromeOSPolicyAccessHeader(f, protobuf_type)
+
+  f.write('}  // namespace policy\n\n'
+          '#endif  // __BINDINGS_POLICY_CONSTANTS_H_\n')
+
+
+#------------------ Chrome OS policy constants source --------------#
+
+# Writes an array that contains the pointers to the mutable proto field for each
+# policy in |policies| of the given |protobuf_type|.
+def _WriteChromeOSPolicyAccessSource(policies, f, protobuf_type):
+  f.write('constexpr %sPolicyAccess k%sPolicyAccess[] = {\n'
+          % (protobuf_type, protobuf_type))
+  for policy in policies:
+    if policy.policy_protobuf_type == protobuf_type:
+      f.write('  {key::k%s,\n'
+              '   &em::CloudPolicySettings::mutable_%s},\n'
+              % (policy.name, policy.name.lower()))
+  # The list is nullptr-terminated.
+  f.write('  {nullptr, nullptr},\n'
+          '};\n\n')
+
+
+# Writes policy_constants.cc for use in Chrome OS.
+def _WriteChromeOSPolicyConstantsSource(policies, os, f, risk_tags):
+  f.write('#include "bindings/cloud_policy.pb.h"\n'
+          '#include "bindings/policy_constants.h"\n\n'
+          'namespace em = enterprise_management;\n\n'
+          'namespace policy {\n\n')
+
+  # Policy keys.
+  f.write('namespace key {\n\n')
+  for policy in policies:
+    f.write('const char k{name}[] = "{name}";\n'.format(name=policy.name))
+  f.write('\n}  // namespace key\n\n')
+
+  # User policy proto pointers, one struct for each protobuf type.
+  supported_user_policies = _GetSupportedUserPolicies(policies)
+  protobuf_types = _GetProtobufTypes(supported_user_policies)
+  for protobuf_type in protobuf_types:
+    _WriteChromeOSPolicyAccessSource(supported_user_policies, f, protobuf_type)
+
+  f.write('}  // namespace policy\n')
+
+
+#------------------ app restrictions -------------------------------#
+
+def _WriteAppRestrictions(policies, os, f, risk_tags):
 
   def WriteRestrictionCommon(key):
     f.write('    <restriction\n'
             '        android:key="%s"\n' % key)
     f.write('        android:title="@string/%sTitle"\n' % key)
     f.write('        android:description="@string/%sDesc"\n' % key)
 
   def WriteItemsDefinition(key):
     f.write('        android:entries="@array/%sEntries"\n' % key)
     f.write('        android:entryValues="@array/%sValues"\n' % key)
@@ skipping 12 matching lines @@
   f.write('<restrictions xmlns:android="'
           'http://schemas.android.com/apk/res/android">\n\n')
   for policy in policies:
     if (policy.is_supported and policy.restriction_type != 'invalid' and
          not policy.is_deprecated and not policy.is_future):
       WriteAppRestriction(policy)
   f.write('</restrictions>')
 
 if __name__ == '__main__':
   sys.exit(main())