[Android WebView] Generate the OSS licenses notice using jinja2

android_webview/tools/webview_licenses.py

 #!/usr/bin/python
 # Copyright 2014 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.
 
 """Checks third-party licenses for the purposes of the Android WebView build.
 
 The Android tree includes a snapshot of Chromium in order to power the system
 WebView.  This tool checks that all code uses open-source licenses compatible
 with Android, and that we meet the requirements of those licenses. It can also
@@ skipping 18 matching lines @@
 REPOSITORY_ROOT = os.path.abspath(os.path.join(
     os.path.dirname(__file__), '..', '..'))
 
 # Import third_party/PRESUBMIT.py via imp to avoid importing a random
 # PRESUBMIT.py from $PATH, also make sure we don't generate a .pyc file.
 sys.dont_write_bytecode = True
 third_party = \
   imp.load_source('PRESUBMIT', \
                   os.path.join(REPOSITORY_ROOT, 'third_party', 'PRESUBMIT.py'))
 
+sys.path.append(os.path.join(REPOSITORY_ROOT, 'third_party'))
+import jinja2
 sys.path.append(os.path.join(REPOSITORY_ROOT, 'tools'))
 import licenses
 
 import copyright_scanner
 import known_issues
 
 class InputApi(object):
   def __init__(self):
     self.os_path = os.path
     self.os_walk = os.walk
@@ skipping 196 matching lines @@
         print 'Got LicenseError "%s" while scanning %s' % (e, path)
         all_licenses_valid = False
 
   # Second, check for non-standard license text.
   whitelisted_files = copyright_scanner.LoadWhitelistedFilesList(InputApi())
   licenses_check = _CheckLicenseHeaders(third_party_dirs, whitelisted_files)
 
   return licenses_check if all_licenses_valid else ScanResult.Errors
 
 
+class TemplateEntryGenerator(object):
+  def __init__(self):
+    self.toc_index = 0
+
+  def _ReadFileGuessEncoding(self, name):
+    contents = ''
+    with open(name, 'rb') as input_file:
+      contents = input_file.read()
+    try:
+      return contents.decode('utf8')
+    except UnicodeDecodeError:
+      pass
+    # If it's not UTF-8, it must be CP-1252. Fail otherwise.
+    return contents.decode('cp1252')
+
+  def MetadataToTemplateEntry(self, metadata):
+    self.toc_index += 1
+    return {
+      'name': metadata['Name'],
+      'url': metadata['URL'],
+      'license': self._ReadFileGuessEncoding(metadata['License File']),
+      'toc_href': 'entry' + str(self.toc_index),
+    }
+
+
 def GenerateNoticeFile():
   """Generates the contents of an Android NOTICE file for the third-party code.
   This is used by the snapshot tool.
   Returns:
     The contents of the NOTICE file.
   """
 
+  generator = TemplateEntryGenerator()
+  # Start from Chromium's LICENSE file
+  entries = [generator.MetadataToTemplateEntry({
+    'Name': 'The Chromium Project',
+    'URL': 'http://www.chromium.org',
+    'License File': os.path.join(REPOSITORY_ROOT, 'LICENSE') })
+  ]
+
   third_party_dirs = _FindThirdPartyDirs()
-
-  # Don't forget Chromium's LICENSE file
-  content = [_ReadLocalFile('LICENSE')]
-
   # We provide attribution for all third-party directories.
-  # TODO(steveblock): Limit this to only code used by the WebView binary.
+  # TODO(mnaganov): Limit this to only code used by the WebView binary.
   for directory in sorted(third_party_dirs):
     metadata = licenses.ParseDir(directory, REPOSITORY_ROOT,
                                  require_license_file=False)
     license_file = metadata['License File']
     if license_file and license_file != licenses.NOT_SHIPPED:
-      content.append(_ReadLocalFile(license_file))
+      entries.append(generator.MetadataToTemplateEntry(metadata))
 
-  return '\n'.join(content)
+  env = jinja2.Environment(
+    loader=jinja2.FileSystemLoader(os.path.dirname(__file__)),
+    extensions=['jinja2.ext.autoescape'])
+  template = env.get_template('licenses_notice.tmpl')
+  return template.render({ 'entries': entries }).encode('utf8')
 
 
 def _ProcessIncompatibleResult(incompatible_directories):
   if incompatible_directories:
     print ("Incompatibly licensed directories found:\n" +
            "\n".join(sorted(incompatible_directories)))
     return ScanResult.Errors
   return ScanResult.Ok
 
 def main():
@@ skipping 37 matching lines @@
     files = sys.stdin.read().splitlines()
     for f, c in \
         zip(files, copyright_scanner.FindCopyrights(InputApi(), '.', files)):
       print f, '\t', ' / '.join(sorted(c))
     return ScanResult.Ok
   parser.print_help()
   return ScanResult.Errors
 
 if __name__ == '__main__':
   sys.exit(main())