Generate about:credits page automatically at build time.

tools/licenses.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.
 
 """Utility for checking and processing licensing information in third_party
 directories.
 
 Usage: licenses.py <command>
 
@@ skipping 383 matching lines @@
         except LicenseError, e:
             errors.append((path, e.args[0]))
             continue
 
     for path, error in sorted(errors):
         print path + ": " + error
 
     return len(errors) == 0
 
 
-def GenerateCredits(root=None):
-    """Generate about:credits, dumping the result to stdout."""
+def GenerateCredits():
+    """Generate about:credits."""
+
+    if len(sys.argv) not in (2, 3):
+      print 'usage: licenses.py credits [output_file]'
+      return False
 
     def EvaluateTemplate(template, env, escape=True):
         """Expand a template with variables like {{foo}} using a
         dictionary of expansions."""
         for key, val in env.items():
             if escape and not key.endswith("_unescaped"):
                 val = cgi.escape(val)
             template = template.replace('{{%s}}' % key, val)
         return template
 
-    if root is None:
-      root = os.getcwd()
+    root = os.path.join(os.path.dirname(__file__), '..')
     third_party_dirs = FindThirdPartyDirs(PRUNE_PATHS, root)
 
     entry_template = open(os.path.join(root, 'chrome', 'browser', 'resources',
                                        'about_credits_entry.tmpl'), 'rb').read()
     entries = []
     for path in sorted(third_party_dirs):
         try:
             metadata = ParseDir(path, root)
         except LicenseError:
             print >>sys.stderr, ("WARNING: licensing info for " + path +
                                  " is incomplete, skipping.")
             continue
         if metadata['License File'] == NOT_SHIPPED:
             print >>sys.stderr, ("Path " + path + " marked as " + NOT_SHIPPED +
                                  ", skipping.")
             continue
         env = {
             'name': metadata['Name'],
             'url': metadata['URL'],
             'license': open(metadata['License File'], 'rb').read(),
             'license_unescaped': '',
         }
         if 'Required Text' in metadata:
             required_text = open(metadata['Required Text'], 'rb').read()
             env["license_unescaped"] = required_text
         entries.append(EvaluateTemplate(entry_template, env))
 
     file_template = open(os.path.join(root, 'chrome', 'browser', 'resources',
                                       'about_credits.tmpl'), 'rb').read()
-    print "<!-- Generated by licenses.py; do not edit. -->"
-    print EvaluateTemplate(file_template, {'entries': '\n'.join(entries)},
-                           escape=False)
+    template_contents = "<!-- Generated by licenses.py; do not edit. -->"
+    template_contents += EvaluateTemplate(file_template,
+                                          {'entries': '\n'.join(entries)},
+                                          escape=False)
+
+    if len(sys.argv) == 3:
+      with open(sys.argv[2], 'w') as output_file:
+        output_file.write(template_contents)
+    elif len(sys.argv) == 2:
+      print template_contents
+
+    return True
 
 
 def main():
     command = 'help'
     if len(sys.argv) > 1:
         command = sys.argv[1]
 
     if command == 'scan':
         if not ScanThirdPartyDirs():
             return 1
     elif command == 'credits':
         if not GenerateCredits():
             return 1
     else:
         print __doc__
         return 1
 
 
 if __name__ == '__main__':
   sys.exit(main())