Record policy usage statistics every 24 hours.

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
 template is the path to a .json policy template file.'''
 
 from __future__ import with_statement
+from collections import namedtuple
 from optparse import OptionParser
 import re
 import sys
 import textwrap
 
 
 CHROME_MANDATORY_SUBKEY = 'SOFTWARE\\\\Policies\\\\Google\\\\Chrome'
 CHROME_RECOMMENDED_SUBKEY = CHROME_MANDATORY_SUBKEY + '\\\\Recommended'
 CHROMIUM_MANDATORY_SUBKEY = 'SOFTWARE\\\\Policies\\\\Chromium'
 CHROMIUM_RECOMMENDED_SUBKEY = CHROMIUM_MANDATORY_SUBKEY + '\\\\Recommended'
 
 TYPE_MAP = {
   'dict': 'TYPE_DICTIONARY',
   'int': 'TYPE_INTEGER',
   'int-enum': 'TYPE_INTEGER',
   'list': 'TYPE_LIST',
   'main': 'TYPE_BOOLEAN',
   'string': 'TYPE_STRING',
   'string-enum': 'TYPE_STRING',
 }
 
+PolicyDetails = namedtuple(
+    'PolicyDetails',
+    'id name vtype platforms is_deprecated is_device_policy')

[Mattias Nissler (ping if slow), 2012/09/12 13:06:27]

this is nice!

+
 
 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('--ppb', '--policy-protobuf', dest='proto_path',
@@ skipping 55 matching lines @@
   result = ''
   pos = 0
   for m in PH_PATTERN.finditer(text):
     result += text[pos:m.start(0)]
     result += m.group(2) or m.group(1)
     pos = m.end(0)
   result += text[pos:]
   return result;
 
 
-# Returns a tuple with details about the given policy:
-# (name, type, list_of_platforms, is_deprecated, is_device_policy)
+# Returns a PolicyDetails named tuple with details about the given policy.
 def _GetPolicyDetails(policy):
   name = policy['name']
   if not TYPE_MAP.has_key(policy['type']):
     print 'Unknown policy type for %s: %s' % (name, policy['type'])
     sys.exit(3)
   vtype = TYPE_MAP[policy['type']]
   # platforms is a list of 'chrome', 'chrome_os' and/or 'chrome_frame'.
   platforms = [ x.split(':')[0] for x in policy['supported_on'] ]
   is_deprecated = policy.get('deprecated', False)
   is_device_policy = policy.get('device_only', False)
-  return (name, vtype, platforms, is_deprecated, is_device_policy)
+  return PolicyDetails(name=name, vtype=vtype, platforms=platforms,
+                       is_deprecated=is_deprecated, id=policy['id'],
+                       is_device_policy=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, platforms, vtype, is_device_policy)
-      for (name, vtype, platforms, _, is_device_policy)
-      in _GetPolicyList(template_file_contents)]
-
-
-def _GetDeprecatedPolicyList(template_file_contents):
-  return [name for (name, _, _, is_deprecated, _)
-               in _GetPolicyList(template_file_contents)
-               if is_deprecated]
-
-
 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):
   os = args[0]
   with open(opts.header_path, 'w') as f:
@@ skipping 16 matching lines @@
               'configuration resides.\n'
               'extern const wchar_t kRegistryRecommendedSubKey[];\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'
             '    const char* name;\n'
             '    base::Value::Type value_type;\n'
             '    bool device_policy;\n'
+            '    int id;\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')
     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')
+    for policy in _GetPolicyList(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):
   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[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('const PolicyDefinitionList::Entry kEntries[] = {\n')
-    policy_list = _GetChromePolicyList(template_file_contents)
-    for (name, platforms, vtype, device_policy) in policy_list:
-      if (platform in platforms) or (platform_wildcard in platforms):
-        f.write('  { key::k%s, Value::%s, %s },\n' %
-            (name, vtype, 'true' if device_policy else 'false'))
+    for policy in _GetPolicyList(template_file_contents):
+      if (platform in policy.platforms) or \
+         (platform_wildcard in policy.platforms):
+        f.write(
+            '  {{ key::k{name}, Value::{vtype}, {is_device_policy}, {id} }},\n'.

[Mattias Nissler (ping if slow), 2012/09/12 13:06:27]

I think the previous code was easier to read.

[qfel, 2012/09/18 11:30:56]

Done.

+            format(name=policy.name, vtype=policy.vtype, id=policy.id,
+                   is_device_policy='true' if policy.is_device_policy
+                                           else 'false'))
     f.write('};\n\n')
 
     f.write('const PolicyDefinitionList kChromePolicyList = {\n'
             '  kEntries,\n'
             '  kEntries + arraysize(kEntries),\n'
             '};\n\n')
 
     f.write('// List of deprecated policies.\n'
             'const char* kDeprecatedPolicyList[] = {\n')
-    for name in _GetDeprecatedPolicyList(template_file_contents):
-      f.write('  key::k%s,\n' % name)
+    for policy in _GetPolicyList(template_file_contents):
+      if policy.is_deprecated:
+        f.write('  key::k%s,\n' % policy.name)
     f.write('};\n\n')
 
     f.write('}  // namespace\n\n')
 
     if os == 'win':
       f.write('#if defined(GOOGLE_CHROME_BUILD)\n'
               'const wchar_t kRegistryMandatorySubKey[] = '
               'L"' + CHROME_MANDATORY_SUBKEY + '";\n'
               'const wchar_t kRegistryRecommendedSubKey[] = '
               'L"' + CHROME_RECOMMENDED_SUBKEY + '";\n'
@@ skipping 11 matching lines @@
             '      return true;\n'
             '  }\n'
             '  return false;\n'
             '}\n'
             '\n'
             'const PolicyDefinitionList* GetChromePolicyDefinitionList() {\n'
             '  return &kChromePolicyList;\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))
+    for policy in _GetPolicyList(template_file_contents):
+      f.write('const char k{name}[] = "{name}";\n'.format(name=policy.name))
     f.write('\n}  // namespace key\n\n'
             '}  // namespace policy\n')
 
 
 #------------------ policy protobuf --------------------------------#
 PROTO_HEAD = '''
 syntax = "proto2";
 
 option optimize_for = LITE_RUNTIME;
 
@@ skipping 182 matching lines @@
       if policy['type'] == 'group':
         for sub_policy in policy['policies']:
           _WritePolicyCode(f, sub_policy)
       else:
         _WritePolicyCode(f, policy)
     f.write(CPP_FOOT)
 
 
 if __name__ == '__main__':
   sys.exit(main())