Added cache busting ability to CssAbsoluteFilter filter which appends a hash to each image URL (except data: images).

Author: jezdez

compressor/filters/css_default.py

@@ -4,6 +4,7 @@
 
 from compressor.filters import FilterBase, FilterError
 from compressor.conf import settings
+from compressor import get_hexdigest
 
 class CssAbsoluteFilter(FilterBase):
     def input(self, filename=None, **kwargs):
@@ -15,6 +16,11 @@ def input(self, filename=None, **kwargs):
         self.media_path = filename[len(media_root):]
         self.media_path = self.media_path.lstrip('/')
         self.media_url = settings.MEDIA_URL.rstrip('/')
+        try:
+            mtime = os.path.getmtime(filename)
+            self.mtime = get_hexdigest(str(int(mtime)))[:12]
+        except OSError:
+            self.mtime = None
         self.has_http = False
         if self.media_url.startswith('http://') or self.media_url.startswith('https://'):
             self.has_http = True
@@ -26,16 +32,27 @@ def input(self, filename=None, **kwargs):
         output = url_pattern.sub(self.url_converter, self.content)
         return output
 
+    def add_mtime(self, url):
+        if self.mtime is None:
+            return url
+        if (url.startswith('http://') or
+            url.startswith('https://') or
+            url.startswith('/')):
+            if "?" in url:
+                return "%s&%s" % (url, self.mtime)
+            return "%s?%s" % (url, self.mtime)
+        return url
+
     def url_converter(self, matchobj):
         url = matchobj.group(1)
         url = url.strip(' \'"')
-        if (url.startswith('http://') or 
-            url.startswith('https://') or 
-            url.startswith('/') or 
+        if (url.startswith('http://') or
+            url.startswith('https://') or
+            url.startswith('/') or
             url.startswith('data:')):
-            return "url('http://github.com/%s')" % url
+            return "url('http://github.com/%s')" % self.add_mtime(url)
         full_url = '/'.join([str(self.directory_name), url])
         full_url = posixpath.normpath(full_url)
         if self.has_http:
-            full_url = "%s%s" % (self.protocol,full_url)
-        return "url('http://github.com/%s')" % full_url
+            full_url = "%s%s" % (self.protocol, full_url)
+        return "url('http://github.com/%s')" % self.add_mtime(full_url)

compressor/filters/datauri.py

@@ -1,6 +1,7 @@
 import os
 import re
 import mimetypes
+import urlparse
 from base64 import b64encode
 from compressor.filters import FilterBase
 from compressor.conf import settings
@@ -25,6 +26,9 @@ def input(self, filename=None, **kwargs):
         return output
 
     def get_file_path(self, url):
+        # strip query string of file paths
+        if "?" in url:
+            url = url.split("?")[0]
         return os.path.join(settings.MEDIA_ROOT, url[len(settings.MEDIA_URL):])
 
     def data_uri_converter(self, matchobj):

tests/core/tests.py

@@ -122,41 +122,41 @@ def test_css_absolute_filter(self):
         from compressor.filters.css_default import CssAbsoluteFilter
         filename = os.path.join(settings.MEDIA_ROOT, 'css/url/test.css')
         content = "p { background: url(http://github.com/'../../images/image.gif') }"
-        output = "p { background: url('http://github.com/%simages/image.gif') }" % settings.MEDIA_URL
+        output = "p { background: url('http://github.com/%simages/image.gif%3Cspan%20class=%22x%20x-first%20x-last%22%3E?275088b9bcf0%3C/span%3E') }" % settings.MEDIA_URL
         filter = CssAbsoluteFilter(content)
         self.assertEqual(output, filter.input(filename=filename))
         settings.MEDIA_URL = 'http://media.example.com/'
         filename = os.path.join(settings.MEDIA_ROOT, 'css/url/test.css')
-        output = "p { background: url('http://github.com/%simages/image.gif') }" % settings.MEDIA_URL
+        output = "p { background: url('http://github.com/%simages/image.gif%3Cspan%20class=%22x%20x-first%20x-last%22%3E?275088b9bcf0%3C/span%3E') }" % settings.MEDIA_URL
         self.assertEqual(output, filter.input(filename=filename))
 
     def test_css_absolute_filter_https(self):
         from compressor.filters.css_default import CssAbsoluteFilter
         filename = os.path.join(settings.MEDIA_ROOT, 'css/url/test.css')
         content = "p { background: url(http://github.com/'../../images/image.gif') }"
-        output = "p { background: url('http://github.com/%simages/image.gif') }" % settings.MEDIA_URL
+        output = "p { background: url('http://github.com/%simages/image.gif%3Cspan%20class=%22x%20x-first%20x-last%22%3E?275088b9bcf0%3C/span%3E') }" % settings.MEDIA_URL
         filter = CssAbsoluteFilter(content)
         self.assertEqual(output, filter.input(filename=filename))
         settings.MEDIA_URL = 'https://media.example.com/'
         filename = os.path.join(settings.MEDIA_ROOT, 'css/url/test.css')
-        output = "p { background: url('http://github.com/%simages/image.gif') }" % settings.MEDIA_URL
+        output = "p { background: url('http://github.com/%simages/image.gif%3Cspan%20class=%22x%20x-first%20x-last%22%3E?275088b9bcf0%3C/span%3E') }" % settings.MEDIA_URL
         self.assertEqual(output, filter.input(filename=filename))
 
     def test_css_absolute_filter_relative_path(self):
         from compressor.filters.css_default import CssAbsoluteFilter
         filename = os.path.join(django_settings.TEST_DIR, 'whatever', '..', 'media', 'whatever/../css/url/test.css')
         content = "p { background: url(http://github.com/'../../images/image.gif') }"
-        output = "p { background: url('http://github.com/%simages/image.gif') }" % settings.MEDIA_URL
+        output = "p { background: url('http://github.com/%simages/image.gif%3Cspan%20class=%22x%20x-first%20x-last%22%3E?275088b9bcf0%3C/span%3E') }" % settings.MEDIA_URL
         filter = CssAbsoluteFilter(content)
         self.assertEqual(output, filter.input(filename=filename))
         settings.MEDIA_URL = 'https://media.example.com/'
-        output = "p { background: url('http://github.com/%simages/image.gif') }" % settings.MEDIA_URL
+        output = "p { background: url('http://github.com/%simages/image.gif%3Cspan%20class=%22x%20x-first%20x-last%22%3E?275088b9bcf0%3C/span%3E') }" % settings.MEDIA_URL
         self.assertEqual(output, filter.input(filename=filename))
 
 
     def test_css_hunks(self):
-        out = [u"p { background: url('http://github.com/media/images/test.png'); }\np { background: url('http://github.com/media/images/test.png'); }\np { background: url('http://github.com/media/images/test.png'); }\np { background: url('http://github.com/media/images/test.png'); }\n",
-               u"p { background: url('http://github.com/media/images/test.png'); }\np { background: url('http://github.com/media/images/test.png'); }\np { background: url('http://github.com/media/images/test.png'); }\np { background: url('http://github.com/media/images/test.png'); }\n",
+        out = [u"p { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\np { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\np { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\np { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\n",
+               u"p { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\np { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\np { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\np { background: url('http://github.com/media/images/test.png%3Cspan%20class=%22x%20x-first%20x-last%22%3E?86ea855a37ed%3C/span%3E'); }\n",
                ]
         self.assertEqual(out, self.cssNode.hunks)
 
@@ -172,7 +172,7 @@ def setUp(self):
         self.cssNode = CssCompressor(self.css)
 
     def test_data_uris(self):
-        out = [u'.add { background-image: url(http://github.com/"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAJvSURBVDjLpZPrS5NhGIf9W7YvBYOkhlkoqCklWChv2WyKik7blnNris72bi6dus0DLZ0TDxW1odtopDs4D8MDZuLU0kXq61CijSIIasOvv94VTUfLiB74fXngup7nvrnvJABJ/5PfLnTTdcwOj4RsdYmo5glBWP6iOtzwvIKSWstI0Wgx80SBblpKtE9KQs/We7EaWoT/8wbWP61gMmCH0lMDvokT4j25TiQU/ITFkek9Ow6+7WH2gwsmahCPdwyw75uw9HEO2gUZSkfyI9zBPCJOoJ2SMmg46N61YO/rNoa39Xi41oFuXysMfh36/Fp0b7bAfWAH6RGi0HglWNCbzYgJaFjRv6zGuy+b9It96N3SQvNKiV9HvSaDfFEIxXItnPs23BzJQd6DDEVM0OKsoVwBG/1VMzpXVWhbkUM2K4oJBDYuGmbKIJ0qxsAbHfRLzbjcnUbFBIpx/qH3vQv9b3U03IQ/HfFkERTzfFj8w8jSpR7GBE123uFEYAzaDRIqX/2JAtJbDat/COkd7CNBva2cMvq0MGxp0PRSCPF8BXjWG3FgNHc9XPT71Ojy3sMFdfJRCeKxEsVtKwFHwALZfCUk3tIfNR8XiJwc1LmL4dg141JPKtj3WUdNFJqLGFVPC4OkR4BxajTWsChY64wmCnMxsWPCHcutKBxMVp5mxA1S+aMComToaqTRUQknLTH62kHOVEE+VQnjahscNCy0cMBWsSI0TCQcZc5ALkEYckL5A5noWSBhfm2AecMAjbcRWV0pUTh0HE64TNf0mczcnnQyu/MilaFJCae1nw2fbz1DnVOxyGTlKeZft/Ff8x1BRssfACjTwQAAAABJRU5ErkJggg=="); }\n.python { background-image: url(http://github.com/"/media/img/python.png"); }\n.datauri { background-image: url(http://github.com/"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9YGARc5KB0XV+IAAAAddEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIFRoZSBHSU1Q72QlbgAAAF1JREFUGNO9zL0NglAAxPEfdLTs4BZM4DIO4C7OwQg2JoQ9LE1exdlYvBBeZ7jqch9//q1uH4TLzw4d6+ErXMMcXuHWxId3KOETnnXXV6MJpcq2MLaI97CER3N0%20vr4MkhoXe0rZigAAAABJRU5ErkJggg=="); }\n']
+        out = [u'.add { background-image: url(http://github.com/"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAAK/INwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAAJvSURBVDjLpZPrS5NhGIf9W7YvBYOkhlkoqCklWChv2WyKik7blnNris72bi6dus0DLZ0TDxW1odtopDs4D8MDZuLU0kXq61CijSIIasOvv94VTUfLiB74fXngup7nvrnvJABJ/5PfLnTTdcwOj4RsdYmo5glBWP6iOtzwvIKSWstI0Wgx80SBblpKtE9KQs/We7EaWoT/8wbWP61gMmCH0lMDvokT4j25TiQU/ITFkek9Ow6+7WH2gwsmahCPdwyw75uw9HEO2gUZSkfyI9zBPCJOoJ2SMmg46N61YO/rNoa39Xi41oFuXysMfh36/Fp0b7bAfWAH6RGi0HglWNCbzYgJaFjRv6zGuy+b9It96N3SQvNKiV9HvSaDfFEIxXItnPs23BzJQd6DDEVM0OKsoVwBG/1VMzpXVWhbkUM2K4oJBDYuGmbKIJ0qxsAbHfRLzbjcnUbFBIpx/qH3vQv9b3U03IQ/HfFkERTzfFj8w8jSpR7GBE123uFEYAzaDRIqX/2JAtJbDat/COkd7CNBva2cMvq0MGxp0PRSCPF8BXjWG3FgNHc9XPT71Ojy3sMFdfJRCeKxEsVtKwFHwALZfCUk3tIfNR8XiJwc1LmL4dg141JPKtj3WUdNFJqLGFVPC4OkR4BxajTWsChY64wmCnMxsWPCHcutKBxMVp5mxA1S+aMComToaqTRUQknLTH62kHOVEE+VQnjahscNCy0cMBWsSI0TCQcZc5ALkEYckL5A5noWSBhfm2AecMAjbcRWV0pUTh0HE64TNf0mczcnnQyu/MilaFJCae1nw2fbz1DnVOxyGTlKeZft/Ff8x1BRssfACjTwQAAAABJRU5ErkJggg=="); }\n.python { background-image: url(http://github.com/"/media/img/python.png?f59031cef54b"); }\n.datauri { background-image: url(http://github.com/"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB9YGARc5KB0XV+IAAAAddEVYdENvbW1lbnQAQ3JlYXRlZCB3aXRoIFRoZSBHSU1Q72QlbgAAAF1JREFUGNO9zL0NglAAxPEfdLTs4BZM4DIO4C7OwQg2JoQ9LE1exdlYvBBeZ7jqch9//q1uH4TLzw4d6+ErXMMcXuHWxId3KOETnnXXV6MJpcq2MLaI97CER3N0%20vr4MkhoXe0rZigAAAABJRU5ErkJggg=="); }\n']
         self.assertEqual(out, self.cssNode.hunks)