Issue 2120 - Add support for animations.

filters/inline_file.py

Index: filters/inline_file.py
diff --git a/filters/inline_file.py b/filters/inline_file.py
new file mode 100644
index 0000000000000000000000000000000000000000..23a67f7450748b5536d4580b212de664292bc7d9
--- /dev/null
+++ b/filters/inline_file.py
@@ -0,0 +1,38 @@
+# This file is part of the Adblock Plus website,
+# Copyright (C) 2006-2015 Eyeo GmbH
+#
+# Adblock Plus is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3 as
+# published by the Free Software Foundation.
+#
+# Adblock Plus is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
+
+import base64
+import mimetypes
+import urllib
+
+from jinja2 import contextfilter
+
+@contextfilter
+def inline_file(context, path, mime_type=None):
+  if mime_type is None:
+    mime_type = mimetypes.guess_type(path)[0] or "application/octet-stream"

[Sebastian Noack, 2015/04/11 14:15:32]

I wonder whether we should make the mime_type argument mandatory for files the
mimetype can not be guessed for, raising an exception?

[kzar, 2015/04/12 17:01:45]

I think defaulting to application/oclet-stream is enough, I don't mind throwing
a ValueError exception instead though if you guys feel strongly about it.

[Sebastian Noack, 2015/04/13 08:12:58]

Well, if the path doesn't contain a distinct file extension the developer must
specify the mime type in the template. Otherwise the browser might not recognize
the data correctly. By throwing an exception the developer gets remembered to do
so.

[kzar, 2015/04/13 09:05:35]

Done.

+
+  source = context["source"]
+  for locale in (context["locale"], "en"):
+    if source.has_localizable_file(locale, path):

[Sebastian Noack, 2015/04/11 14:15:32]

Do we actually need this branch? Assuming we need this filter only for static
files (like images), how about renaming it to inline_static_file, calling
source.read_static(path) unconditionally?

[kzar, 2015/04/12 17:01:45]

We do need this branch, the images used in the animations might be locale files
like `locales/de/images/anim_example.png`, static files like
`static/images/anim_example.png` or a locale file that hasn't been created for
the user's locale meaning we should default to the English version like
`locales/en/images/anim_example.png`.

+      file_contents = source.read_localizable_file(locale, path)
+      break
+  else:
+    file_contents = source.read_static(path)
+
+  return "data:%s;base64,%s" % (
+    mime_type,
+    urllib.quote(base64.b64encode(file_contents))
+  )