From b4ef20f5f5d19601086ff4cf1a47d5de2a67dc8f Mon Sep 17 00:00:00 2001
From: Mauro Santos <mauro@scandit.com>
Date: Tue, 22 Feb 2022 14:32:48 +0100
Subject: [PATCH] Include removed templatetag, add new one (cache buster) +
 tests

---
 .../templates/admin/base_site.html            |  8 +++++--
 .../templates/admin_interface/favicon.html    |  2 +-
 .../admin_interface/foldable-apps.html        |  6 ++---
 .../admin_interface/related-modal.html        |  8 +++----
 .../templatetags/admin_interface_tags.py      | 19 +++++++++++++--
 tests/test_templatetags.py                    | 24 +++++++++++++++++++
 6 files changed, 55 insertions(+), 12 deletions(-)

diff --git a/admin_interface/templates/admin/base_site.html b/admin_interface/templates/admin/base_site.html
index 9dfb1bb..a4db116 100644
--- a/admin_interface/templates/admin/base_site.html
+++ b/admin_interface/templates/admin/base_site.html
@@ -8,6 +8,8 @@
 
 {% block extrastyle %}
 {% get_admin_interface_theme as theme %}
+{% get_admin_interface_version as version %}
+{% get_admin_interface_nocache as version_md5_cache %}
 {% get_current_language as current_lang %}
 <style type="text/css">
 {% include "admin_interface/css/admin-interface.css" %}
@@ -35,10 +37,12 @@
 {% block blockbots %}
 {{ block.super }}
 {% get_admin_interface_theme as theme %}
+{% get_admin_interface_version as version %}
+{% get_admin_interface_nocache as version_md5_cache %}
 {# https://github.com/elky/django-flat-responsive#important-note #}
 <meta name="viewport" content="user-scalable=no, width=device-width, initial-scale=1.0, maximum-scale=1.0">
-<link rel="stylesheet" type="text/css" href="{% static 'admin/css/responsive.css' %}">
-<link rel="stylesheet" type="text/css" href="{% static 'admin/css/responsive_rtl.css' %}">
+<link rel="stylesheet" type="text/css" href="{% static 'admin/css/responsive.css' %}?nocache={{ version_md5_cache }}">
+<link rel="stylesheet" type="text/css" href="{% static 'admin/css/responsive_rtl.css' %}?nocache={{ version_md5_cache }}">
 {% include "admin_interface/favicon.html" %}
 {% include "admin_interface/foldable-apps.html" %}
 {% include "admin_interface/related-modal.html" %}
diff --git a/admin_interface/templates/admin_interface/favicon.html b/admin_interface/templates/admin_interface/favicon.html
index c015359..4463052 100644
--- a/admin_interface/templates/admin_interface/favicon.html
+++ b/admin_interface/templates/admin_interface/favicon.html
@@ -3,7 +3,7 @@
 {% if theme.favicon %}
 <link rel="icon" href="{{ theme.favicon.url }}">
 {% if theme.env_visible_in_favicon %}
-<script type="text/javascript" src="{% static 'admin_interface/favico/favico-0.3.10-patched.min.js' %}"></script>
+<script type="text/javascript" src="{% static 'admin_interface/favico/favico-0.3.10-patched.min.js' %}?nocache={{ version_md5_cache }}"></script>
 <script type="text/javascript">
 var favicon = new Favico({
     type: 'circle',
diff --git a/admin_interface/templates/admin_interface/foldable-apps.html b/admin_interface/templates/admin_interface/foldable-apps.html
index aa57e74..7d12a52 100644
--- a/admin_interface/templates/admin_interface/foldable-apps.html
+++ b/admin_interface/templates/admin_interface/foldable-apps.html
@@ -1,6 +1,6 @@
 {% load static %}
 
 {% if theme.foldable_apps %}
-<link rel="stylesheet" type="text/css" href="{% static 'admin_interface/foldable-apps/foldable-apps.css' %}">
-<script type="text/javascript" src="{% static 'admin_interface/foldable-apps/foldable-apps.js' %}"></script>
-{% endif %}
\ No newline at end of file
+<link rel="stylesheet" type="text/css" href="{% static 'admin_interface/foldable-apps/foldable-apps.css' %}?nocache={{ version_md5_cache }}">
+<script type="text/javascript" src="{% static 'admin_interface/foldable-apps/foldable-apps.js' %}?nocache={{ version_md5_cache }}"></script>
+{% endif %}
diff --git a/admin_interface/templates/admin_interface/related-modal.html b/admin_interface/templates/admin_interface/related-modal.html
index 0c7de89..4cc488f 100644
--- a/admin_interface/templates/admin_interface/related-modal.html
+++ b/admin_interface/templates/admin_interface/related-modal.html
@@ -1,7 +1,7 @@
 {% load static %}
 
 {% if theme.related_modal_active %}
-<link rel="stylesheet" type="text/css" href="{% static 'admin_interface/magnific-popup/magnific-popup.css' %}">
-<script type="text/javascript" src="{% static 'admin_interface/magnific-popup/jquery.magnific-popup.js' %}"></script>
-<script type="text/javascript" src="{% static 'admin_interface/related-modal/related-modal.js' %}"></script>
-{% endif %}
\ No newline at end of file
+<link rel="stylesheet" type="text/css" href="{% static 'admin_interface/magnific-popup/magnific-popup.css' %}?nocache={{ version_md5_cache }}">
+<script type="text/javascript" src="{% static 'admin_interface/magnific-popup/jquery.magnific-popup.js' %}?nocache={{ version_md5_cache }}"></script>
+<script type="text/javascript" src="{% static 'admin_interface/related-modal/related-modal.js' %}?nocache={{ version_md5_cache }}"></script>
+{% endif %}
diff --git a/admin_interface/templatetags/admin_interface_tags.py b/admin_interface/templatetags/admin_interface_tags.py
index f28234f..1293d5c 100644
--- a/admin_interface/templatetags/admin_interface_tags.py
+++ b/admin_interface/templatetags/admin_interface_tags.py
@@ -1,5 +1,6 @@
 # -*- coding: utf-8 -*-
-
+import re
+import hashlib
 import django
 
 from django import template
@@ -9,8 +10,8 @@ from django.utils import translation
 from admin_interface.cache import get_cached_active_theme, set_cached_active_theme
 from admin_interface.compat import NoReverseMatch, reverse
 from admin_interface.models import Theme
+from admin_interface.version import __version__
 
-import re
 
 
 register = template.Library()
@@ -73,3 +74,17 @@ def get_admin_interface_theme(context):
     return theme
 
 
+@simple_tag(takes_context=False)
+def get_admin_interface_version():
+    return __version__
+
+
+def hash_string(text):
+    hash_object = hashlib.md5(text.encode())
+    md5_hash = hash_object.hexdigest()
+    return md5_hash
+
+
+@simple_tag(takes_context=False)
+def get_admin_interface_nocache():
+    return hash_string(__version__)
diff --git a/tests/test_templatetags.py b/tests/test_templatetags.py
index 728cc78..71165fa 100644
--- a/tests/test_templatetags.py
+++ b/tests/test_templatetags.py
@@ -8,6 +8,8 @@ from django.template import Context, Template
 
 from admin_interface.models import Theme
 from admin_interface.templatetags import admin_interface_tags as templatetags
+from admin_interface.templatetags.admin_interface_tags import hash_string
+from admin_interface.version import __version__
 
 
 class AdminInterfaceTemplateTagsTestCase(TestCase):
@@ -122,3 +124,25 @@ class AdminInterfaceTemplateTagsTestCase(TestCase):
             context,
         )
         self.assertEqual(rendered, "Django")
+
+    def test_get_version(self):
+        version = templatetags.get_admin_interface_version()
+        self.assertEqual(version, __version__)
+        rendered = self.__render_template(
+            "{% load admin_interface_tags %}"
+            "{% get_admin_interface_version as version %}"
+            "{{ version }}"
+        )
+        self.assertEqual(rendered, __version__)
+
+    def test_get_version_nocache(self):
+        hash_from_tag = templatetags.get_admin_interface_nocache()
+        hash_manual = hash_string(__version__)
+        self.assertEqual(hash_from_tag, hash_manual)
+
+        rendered = self.__render_template(
+            "{% load admin_interface_tags %}"
+            "{% get_admin_interface_nocache as version_md5_hash %}"
+            "{{ version_md5_hash }}"
+        )
+        self.assertEqual(rendered, hash_manual)