GRIT: Enable variable expansion in filenames during HTML inlining.

grit/gather/chrome_html.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.
 
 """Prepares a Chrome HTML file by inlining resources and adding references to
 high DPI resources and removing references to unsupported scale factors.
 
 This is a small gatherer that takes a HTML file, looks for src attributes
 and inlines the specified file, producing one HTML file with no external
@@ skipping 60 matching lines @@
   if _THEME_SOURCE.match(filename):
     images = [('1x', filename)]
     for scale_factor in scale_factors:
       images.append((scale_factor, "%s@%s" % (filename, scale_factor)))
     return images
 
   if filename.find(':') != -1:
     # filename is probably a URL, only return filename itself.
     return [('1x', filename)]
 
   filename = filename.replace(DIST_SUBSTR, distribution)

[flackr, 2013/06/06 14:10:26]

Should do filename substitution here as well so that it works in conjunction
with multiple scale factors.

[dconnelly, 2013/06/07 09:10:38]

Done.

[flackr, 2013/06/07 14:50:40]

Can you add a test case to chrome_html_unittest.py?

[dconnelly, 2013/06/07 16:00:40]

Done, and found two more cases.

   filepath = os.path.join(base_path, filename)
   images = [('1x', filename)]
 
   for scale_factor in scale_factors:
     # Check for existence of file and add to image set.
     scale_path = os.path.split(os.path.join(base_path, filename))
     scale_image_path = os.path.join(scale_path[0], scale_factor, scale_path[1])
     if os.path.isfile(scale_image_path):
       # HTML/CSS always uses forward slashed paths.
       scale_image_name = re.sub('(?P<path>(.*/)?)(?P<file>[^/]*)',
@@ skipping 139 matching lines @@
   translateable messages and instead generates a single DataPack resource.
   """
 
   def __init__(self, *args, **kwargs):
     super(ChromeHtml, self).__init__(*args, **kwargs)
     self.allow_external_script_ = False
     self.flatten_html_ = False
     # 1x resources are implicitly already in the source and do not need to be
     # added.
     self.scale_factors_ = []
+    self.filename_expansion_function = None
 
   def SetAttributes(self, attrs):
     self.allow_external_script_ = ('allowexternalscript' in attrs and
                                    attrs['allowexternalscript'] == 'true')
     self.flatten_html_ = ('flattenhtml' in attrs and
                           attrs['flattenhtml'] == 'true')
 
   def SetDefines(self, defines):
     if 'scale_factors' in defines:
       self.scale_factors_ = defines['scale_factors'].split(',')
 
   def GetText(self):
     """Returns inlined text of the HTML document."""
     return self.inlined_text_
 
   def GetTextualIds(self):
     return [self.extkey]
 
   def GetData(self, lang, encoding):
     """Returns inlined text of the HTML document."""
     return self.inlined_text_
 
   def GetHtmlResourceFilenames(self):
     """Returns a set of all filenames inlined by this file."""
     if self.flatten_html_:
       return html_inline.GetResourceFilenames(
           self.grd_node.ToRealPath(self.GetInputPath()),
           allow_external_script=self.allow_external_script_,
           rewrite_function=lambda fp, t, d: ProcessImageSets(
-              fp, t, self.scale_factors_, d))
+              fp, t, self.scale_factors_, d),
+          filename_expansion_function=self.filename_expansion_function)
     return []
 
   def Translate(self, lang, pseudo_if_not_available=True,
                 skeleton_gatherer=None, fallback_to_english=False):
     """Returns this document translated."""
     return self.inlined_text_
 
+  def SetFilenameExpansionFunction(self, fn):
+    self.filename_expansion_function = fn
+
   def Parse(self):
     """Parses and inlines the represented file."""
 
     filename = self.GetInputPath()
+    if self.filename_expansion_function:
+      filename = self.filename_expansion_function(filename)
     # Hack: some unit tests supply an absolute path and no root node.
     if not os.path.isabs(filename):
       filename = self.grd_node.ToRealPath(filename)
     if self.flatten_html_:
       self.inlined_text_ = html_inline.InlineToString(
           filename,
           self.grd_node,
           allow_external_script = self.allow_external_script_,
           rewrite_function=lambda fp, t, d: ProcessImageSets(
-              fp, t, self.scale_factors_, d))
+              fp, t, self.scale_factors_, d),
+          filename_expansion_function=self.filename_expansion_function)
     else:
       distribution = html_inline.GetDistribution()
       self.inlined_text_ = ProcessImageSets(
           os.path.dirname(filename),
           util.ReadFile(filename, 'utf-8'),
           self.scale_factors_,
           distribution)