Use static file as logo (if sets)

admin_interface/admin.py

@@ -58,6 +58,7 @@ class ThemeAdmin(admin.ModelAdmin):
                     "logo_max_height",
                     "logo_color",
                     "logo_visible",
+                    "static_logo_path",
                 ),
             },
         ),

admin_interface/apps.py

@@ -11,3 +11,6 @@ def ready(self):
         from admin_interface import settings
 
         settings.check_installed_apps()
+
+        # must check if LOCAL_FILE_DIR is set in settings
+        settings.check_settings("LOCAL_FILE_DIR")

admin_interface/locale/de/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -114,6 +114,10 @@ msgstr "Farbe"
 msgid "visible"
 msgstr "sichtbar"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "statisches Logo"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Dieses Feld leer lassen um das Django Standard Logo zu benutzen"

admin_interface/locale/es/LC_MESSAGES/django.po

@@ -10,7 +10,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: django-admin-interface\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: 2023-08-04 11:52-0300\n"
 "Last-Translator: Santiago Muñoz <[email protected]>\n"
 "Language-Team: Spanish <[email protected]>\n"
@@ -116,6 +116,10 @@ msgstr "color"
 msgid "visible"
 msgstr "visible"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "logo estático"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Dejar en blanco para usar el logo por defecto de Django"
@@ -236,7 +240,8 @@ msgstr "anclar posición"
 
 #: admin_interface/models.py
 msgid "quick remove links for active filters at top of sidebar"
-msgstr "remover enlaces para filtros activos en la parte superior de la barra lateral"
+msgstr ""
+"remover enlaces para filtros activos en la parte superior de la barra lateral"
 
 #: admin_interface/models.py
 msgid "foldable apps"

admin_interface/locale/fa/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: django-admin-interface\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: Amir Ajorloo <[email protected]>\n"
 "Language-Team: Farsi <[email protected]>\n"
@@ -113,6 +113,10 @@ msgstr "رنگ"
 msgid "visible"
 msgstr "نمایان"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "لوگوی استاتیک"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "برای نمایش لوگوی پیش فرض، خالی بگذارید."

admin_interface/locale/fr/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -114,6 +114,10 @@ msgstr "couleur"
 msgid "visible"
 msgstr "visible"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "logo statique"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Laisser vide pour utiliser le logo Django par défaut"

admin_interface/locale/it/LC_MESSAGES/django.po

@@ -9,7 +9,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: django-admin-interface\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: 2018-12-30 19:13-0500\n"
 "Last-Translator: Fabio Caccamo <[email protected]>\n"
 "Language-Team: Italian <[email protected]>\n"
@@ -115,6 +115,10 @@ msgstr "colore"
 msgid "visible"
 msgstr "visibile"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "logo statico"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Lasciare vuoto per usare il logo Django di default"

admin_interface/locale/pl/LC_MESSAGES/django.po

@@ -9,7 +9,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: django-admin-interface\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: 2022-02-04 19:13-0500\n"
 "Last-Translator: Kamil Paduszyński <[email protected]>\n"
 "Language-Team: Polish <[email protected]>\n"
@@ -115,6 +115,10 @@ msgstr "kolor"
 msgid "visible"
 msgstr "widoczny"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "statyczne logo"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Puste ustawia domyślne logo Django"

admin_interface/locale/pt_BR/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -114,6 +114,10 @@ msgstr "cor"
 msgid "visible"
 msgstr "visível"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "logo estático"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Deixe em branco para usar o logotipo padrão do Django"

admin_interface/locale/ru/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-06-23 16:28-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[email protected]>\n"
@@ -116,6 +116,10 @@ msgstr "цвет"
 msgid "visible"
 msgstr "видимый"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "статический логотип"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Оставьте пустым, чтобы по умолчанию использовать логотип Django"

admin_interface/locale/tr/LC_MESSAGES/django.po

@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: django-admin-interface\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2023-05-10 18:20-0500\n"
+"POT-Creation-Date: 2024-03-19 18:27-0500\n"
 "PO-Revision-Date: 2020-01-29 04:53+0300\n"
 "Last-Translator: Ishak Okutan <[email protected]>\n"
 "Language-Team: \n"
@@ -115,6 +115,10 @@ msgstr "renk"
 msgid "visible"
 msgstr "göster"
 
+#: admin_interface/models.py
+msgid "static logo"
+msgstr "sabit logo"
+
 #: admin_interface/models.py
 msgid "Leave blank to use the default Django logo"
 msgstr "Varsayılan Django logosunu kullanmak için boş bırakın"

admin_interface/migrations/0031_theme_static_logo_path.py

@@ -0,0 +1,24 @@
+# Generated by Django 5.0.3 on 2024-03-19 22:29
+
+import admin_interface.models
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("admin_interface", "0030_theme_collapsible_stacked_inlines_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="theme",
+            name="static_logo_path",
+            field=models.FilePathField(
+                blank=True,
+                match="^.*\\.(jpg|jpeg|png|svg)$",
+                max_length=255,
+                path=admin_interface.models.static_logo_directory_path,
+                verbose_name="static logo",
+            ),
+        ),
+    ]

admin_interface/models.py

@@ -5,10 +5,16 @@
 from django.dispatch import receiver
 from django.utils.encoding import force_str
 from django.utils.translation import gettext_lazy as _
+from django.conf import settings
+import os
 
 from .cache import del_cached_active_theme
 
 
+def static_logo_directory_path():
+    return settings.LOCAL_FILE_DIR
+
+
 class ThemeQuerySet(models.QuerySet):
     def get_active(self):
         objs_active_qs = self.filter(active=True)
@@ -62,6 +68,14 @@ class Theme(models.Model):
         verbose_name=_("visible"),
     )
 
+    static_logo_path = models.FilePathField(
+        path=static_logo_directory_path,
+        blank=True,
+        verbose_name=_("static logo"),
+        match=r"^.*\.(jpg|jpeg|png|svg)$",
+        max_length=255,
+    )
+
     logo = models.FileField(
         upload_to="admin-interface/logo/",
         blank=True,
@@ -401,10 +415,26 @@ class Theme(models.Model):
 
     objects = ThemeQuerySet.as_manager()
 
+    @property
+    def static_logo_relative_url(self):
+        return os.path.relpath(self.static_logo_path, settings.STATIC_ROOT)
+
     def set_active(self):
         self.active = True
         self.save()
 
+    def save(self, *args, **kwargs):
+        if self.static_logo_path:
+            # clear cache if static logo path has changed
+            try:
+                obj = Theme.objects.get(pk=self.pk)
+                if obj.static_logo_path != self.static_logo_path:
+                    del_cached_active_theme()
+            except Theme.DoesNotExist:
+                pass
+
+        super().save(*args, **kwargs)
+
     class Meta:
         app_label = "admin_interface"
         verbose_name = _("Theme")

admin_interface/settings.py

@@ -25,5 +25,18 @@
             )
 
 
+def check_settings(setting_attribute):
+    """
+    Check if the setting_attribute is set in the settings module.
+    """
+
+    if not hasattr(settings, setting_attribute):
+        raise ImproperlyConfigured(
+            "You must set the {} setting in your settings module.".format(
+                setting_attribute
+            )
+        )
+
+
 def check_installed_apps():
     check_installed_app("colorfield")

admin_interface/templates/admin/base_site.html

@@ -169,6 +169,8 @@ <h1 id="site-name">
         {% if theme.logo_visible %}
             {% if theme.logo %}
             <img class="logo" style="display:none;" src="{{ theme.logo.url }}" {% if theme.logo.width %}width="{{ theme.logo.width }}"{% endif %} {% if theme.logo.height %}height="{{ theme.logo.height }}"{% endif %}>
+            {% elif theme.static_logo_path %}
+            <img class="logo" style="display:none;" src="{%static theme.static_logo_relative_url %}" width="104" height="36">
             {% else %}
             <img class="logo default" style="display:none;" src="data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7" width="104" height="36">
             {% endif %}

tests/settings.py

@@ -120,3 +120,4 @@
 
 STATIC_ROOT = os.path.join(BASE_DIR, "admin_interface/public/static/")
 STATIC_URL = "/static/"
+LOCAL_FILE_DIR = os.path.join(BASE_DIR, "admin_interface/public/")

tests/test_models.py

@@ -4,7 +4,7 @@
 from django.conf import settings
 from django.test import TestCase
 
-from admin_interface.models import Theme
+from admin_interface.models import Theme, static_logo_directory_path
 
 
 class AdminInterfaceModelsTestCase(TestCase):
@@ -90,6 +90,40 @@ def test_str(self):
         theme = Theme.objects.get_active()
         self.assertEqual(str(theme), "Django")
 
+    def test_save_clear_cache(self):
+        theme = Theme.objects.get_active()
+        theme.static_logo_path = "test"
+        theme.save()
+
+        self.assertEqual(str(theme), "Django")
+
+        fake_dir = settings.LOCAL_FILE_DIR + "/fake"
+        theme.static_logo_path = fake_dir
+        theme.save()
+
+        assert theme.static_logo_path == fake_dir
+
+    def test_save_clear_cache_no_matched_theme(self):
+        theme = Theme(
+            name="Custom 1",
+            active=True,
+            static_logo_path=settings.LOCAL_FILE_DIR + "/fake",
+        )
+        theme.pk = 999
+        theme.save()
+
+    def test_static_path(self):
+        # the `static_logo_directory_path` function is used as the callable
+        # in the `path` argument of the `static_logo_path` field
+        assert static_logo_directory_path() == settings.LOCAL_FILE_DIR
+
+    def test_property_static_logo(self):
+        theme = Theme.objects.get_active()
+        theme.static_logo_path = settings.LOCAL_FILE_DIR + "/fake"
+        theme.save()
+
+        assert theme.static_logo_relative_url == "../fake"
+
 
 # class AdminInterfaceModelsMultiDBTestCase(TestCase):
 #     databases = ["default", "replica"]