feat: GH-999 let CMS admin change header logo

taccsite_cms/_settings/djangocms_plugins.py

@@ -39,6 +39,7 @@
 ]
 DJANGOCMS_PICTURE_TEMPLATES = [
     ('no_link_to_ext_image', _('Do not link to external image')),
+    ('header_logo', _('Header logo')),
 ]
 
 ########################

taccsite_cms/management/commands/util.py

@@ -30,6 +30,25 @@ def add_perm(group, app_label, model_name, perm_name):
     else:
         group.permissions.add( Permission.objects.get( name=perm_name ))
 
+def del_perm(group, app_label, model_name, perm_name):
+    """
+    Delete specific permission from a given group
+    """
+    logger.debug(f'Removing permission ({app_label}.{model_name}) "{perm_name}"')
+    if app_label and model_name:
+        model = model_name.lower().replace(' ', '')
+        content_type = ContentType.objects.get(
+            app_label=app_label,
+            model=model
+        )
+        group.permissions.remove(
+            Permission.objects.get(
+                name=perm_name,
+                content_type=content_type
+            )
+        )
+    else:
+        group.permissions.remove(Permission.objects.get(name=perm_name))
 
 
 # Page
@@ -44,9 +63,15 @@ def let_view_page_and_structure(group):
     add_perm(group, 'cms', 'page', 'Can change page')
 
     add_perm(group, 'cms', 'placeholder', 'Can use Structure mode')
-    # HELP: Not necessary on TACC (as of Core-CMS v4.17.1)
-    #       Is necessary on WTCS (as of Core-CMS v4.20.2)
-    add_perm(group, 'cms', 'static placeholder', 'Can change static placeholder')
+    # To delete undesired permission from sites that still have it:
+    # ```py
+    # add_perm(group, 'cms', 'static placeholder', 'Can change static placeholder')
+    # ```
+    # HELP: Should "Sitewide Content Manager" keep this perm?
+    # SEE: https://weteachcs.org/admin/auth/group/9/change/
+    # FAQ: Only superuser may edit static placeholders (footer, header-logo)
+    # TODO: After this is deployed on all sites once, delete this code
+    del_perm(group, 'cms', 'static placeholder', 'Can change static placeholder')
 
 
 

taccsite_cms/settings/settings.py

@@ -558,7 +558,14 @@ def get_subdirs_as_module_names(path):
 }
 
 CMS_PERMISSION = True
-CMS_PLACEHOLDER_CONF = {}
+CMS_PLACEHOLDER_CONF = {
+    'header-logo': {
+        'plugins': ['PicturePlugin'],
+        'limits': {
+            'global': 1
+        },
+    },
+}
 
 THUMBNAIL_HIGH_RESOLUTION = True
 THUMBNAIL_PROCESSORS = (

taccsite_cms/templates/djangocms_picture/header_logo/picture.html

@@ -0,0 +1,4 @@
+{# Header logo from Picture plugin: pass plugin_logo and use shared header_logo.html. #}
+{% load header_logo_tags %}
+{% header_logo_from_picture instance picture_link as plugin_logo %}
+{% include "header_logo.html" with plugin_logo=plugin_logo %}

taccsite_cms/templates/header.html

@@ -1,4 +1,5 @@
 {# @var settings #}
+{% load cms_tags %}
 
 {# WARNING: Some markup is duplicated in other repositories #}
 {# SEE: https://confluence.tacc.utexas.edu/x/LoCnCQ #}
@@ -22,7 +23,9 @@
   {% endif %}
 ">
   <!-- Portal Logo -->
+  {% static_placeholder "header-logo" or %}
   {% include "header_logo.html" %}
+  {% endstatic_placeholder %}
 
   <!-- Navbar Accordian Toggle on Small Screens  -->
   <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarsExpandTarget" aria-controls="navbarsExpandTarget" aria-expanded="false" aria-label="Toggle navigation">

taccsite_cms/templates/header_logo.html

@@ -1,7 +1,29 @@
-{# @var logo, className #}
+{# @var plugin_logo (optional), className #}
 {% load static custom_portal_settings %}
 
-{% if settings.LOGO %}
+{% if plugin_logo %}
+
+{% with plugin_logo as logo %}
+  <a
+    id="header-logo"
+    class="navbar-brand {{className}}"
+    href="{{ logo.link_href }}"
+    target="{{ logo.link_target }}"
+  >
+    <img
+      class="portal-logo {{ logo.img_class }}"
+      src="{% if logo.is_remote %}{{ logo.img_file_src }}{% else %}{% static logo.img_file_src %}{% endif %}"
+      {% if logo.img_crossorigin %}
+      crossorigin="{{ logo.img_crossorigin }}"
+      {% endif %}
+      {% if logo.img_alt_text %}
+      alt="{{ logo.img_alt_text }}"
+      {% endif %}
+    />
+  </a>
+{% endwith %}
+
+{% elif settings.LOGO %}
 
 {% with settings.LOGO as logo %}
   {% with filename=logo|index:1 selectors=logo|index:2 targeturl=logo|index:3 targettype=logo|index:4 accessibility=logo|index:5 corstype=logo|index:6 visibility=logo|index:7 %}

taccsite_cms/templatetags/header_logo_tags.py

@@ -0,0 +1,27 @@
+"""Template tags for header logo (e.g. building plugin_logo from Picture plugin)."""
+from django import template
+
+register = template.Library()
+
+
+@register.simple_tag
+def header_logo_from_picture(instance, picture_link):
+    """
+    Build a plugin_logo dict from a djangocms_picture instance for use in header_logo.html.
+
+    Usage: {% header_logo_from_picture instance picture_link as plugin_logo %}
+    Then:  {% include "header_logo.html" with plugin_logo=plugin_logo %}
+    """
+    attributes = getattr(instance, 'attributes', None) or {}
+    picture = getattr(instance, 'picture', None)
+    alt = attributes.get('alt') or (getattr(picture, 'default_alt_text', None) if picture else None) or ''
+    img_src = getattr(instance, 'img_src', None) or ''
+    return {
+        'link_href': picture_link or '#',
+        'link_target': getattr(instance, 'link_target', None) or '',
+        'img_class': '',
+        'img_file_src': img_src,
+        'is_remote': True,
+        'img_crossorigin': '',
+        'img_alt_text': alt,
+    }