feat: GH-999 let CMS admin change header logo

docs/gh-999-editable-header-plan.md

@@ -0,0 +1,66 @@
+# GH-999: Editable header (`header-content`)
+
+Plan for [#999 Let CMS Admin Edit Header](https://github.com/TACC/Core-CMS/issues/999) and stacked work on [`feat/GH-999-let-cms-admin-edit-header`](https://github.com/TACC/Core-CMS/pull/1083).
+
+## Goals
+
+| Priority | Item | This stack |
+| --- | --- | --- |
+| 1 | CMS-editable logo | [#1083](https://github.com/TACC/Core-CMS/pull/1083) (current) |
+| 2 | Nav collapse breakpoint | Follow-up issue (not this stack) |
+| 3 | Custom branding | PR 3 (TACC Header Branding plugin) |
+| 4–6 | Portal nav, search, branding order | Later thin plugins / options |
+
+**Backwards compatibility:** If `header-content` has no plugins, render the header exactly as today (settings-driven branding + logo + nav).
+
+**Precedence:** CMS plugin wins when present; otherwise settings (`LOGO` / `PORTAL_LOGO`, `BRANDING` / `PORTAL_BRANDING`).
+
+## Portal logo (HeaderLogoPlugin)
+
+- **One plugin:** [`HeaderLogoPlugin`](taccsite_cms/contrib/taccsite_header_logo/cms_plugins.py) extends Picture (same model, no migration). Toolbar: **TACC Header → Header logo** — full Picture fields/templates; default `id="header-logo"` when Attributes omit `id`.
+- **Render:** Standard Picture template at `{% static_placeholder "header-content" %}`.
+- **Empty placeholder:** `or` fallback [`header_logo_via_settings.html`](taccsite_cms/templates/header_logo_via_settings.html) (`LOGO` / `PORTAL_LOGO`).
+- **Branding images (PR 3):** nested Pictures under TACC Header Branding — not top-level.
+
+## PR stack
+
+1. **#1083 → `main`:** `header-content` static placeholder, superuser-only edit, settings fallback.
+2. **PR 1.75** (base: feature branch): `HeaderLogoPlugin` — correct markup + CMS edit UX (targets #1083 branch).
+3. **PR 2** (base: feature branch): Full-header orchestrator (`header_nav.html`, etc.).
+4. **PR 3** (base: after PR 2): TACC Header Branding plugin; add to `CMS_PLACEHOLDER_CONF`.
+
+After #1083 merges, rebase the feature branch onto `main` before the stack lands on `main`.
+
+## Template files
+
+Portal/Guide repos duplicate header markup ([Confluence](https://confluence.tacc.utexas.edu/x/LoCnCQ)). **`base.html` keeps `{% include "header.html" %}` only.**
+
+| File | Role |
+| --- | --- |
+| [`header.html`](../taccsite_cms/templates/header.html) | Branding + nav; full `{% static_placeholder "header-content" or %}` + settings fallback. |
+| [`header_logo.html`](../taccsite_cms/templates/header_logo.html) | Core-Portal `/cms/header/logo/markup/` — logo-only via [`render_header_logo`](../taccsite_cms/templatetags/header_tags.py) or settings. |
+| [`header_logo_via_settings.html`](../taccsite_cms/templates/header_logo_via_settings.html) | Settings-only logo (`or` fallback). |
+| [`render.py`](../taccsite_cms/contrib/taccsite_header_logo/render.py) | `render` — published logo plugin only (reuse in PR 2). |
+| `header_nav.html` | **PR 2** — extract `<nav>…</nav>`. |
+
+## Testing
+
+### #1083 + PR 1.75
+
+1. **Backwards compatibility:** Empty `header-content` → settings logo; branding/nav unchanged.
+2. **Superuser — logo:** Add **Header logo** plugin (image + optional link). Publish. Nav shows custom logo; placeholder still editable in `?edit`.
+3. **Superuser — footer:** `footer-content` unchanged.
+4. **Non-superuser:** Cannot edit static placeholders.
+5. **Limits:** One `HeaderLogoPlugin` in `header-content` (`global` 2 reserved for PR 3).
+6. **Core-Portal markup URL:** `/cms/header/logo/markup/` uses published `header-content` logo plugin or settings (not draft/edit toolbar).
+7. **Permissions after deploy:** Group perms; re-check step 4.
+
+### PR 2 (orchestrator)
+
+1. Empty placeholder → same as today.
+2. Header logo plugin → full nav + settings branding.
+3. Edit UX for `header-content` at header level.
+
+### PR 3 (branding plugin)
+
+1. Branding plugin + header logo → both slots; settings branding hidden when plugin present.

taccsite_cms/contrib/taccsite_header_logo/cms_plugins.py

@@ -0,0 +1,26 @@
+from cms.plugin_pool import plugin_pool
+from django.utils.translation import gettext_lazy as _
+
+from djangocms_picture.cms_plugins import PicturePlugin
+from djangocms_picture.models import Picture
+
+HEADER_LOGO_ELEMENT_ID = 'header-logo'
+
+
+@plugin_pool.register_plugin
+class HeaderLogoPlugin(PicturePlugin):
+    """
+    Header > "Header logo" plugin
+
+    Full Picture plugin; default id="header-logo" when not set in Attributes.
+    """
+    model = Picture
+    module = _('TACC Header')
+    name = _('Header logo')
+
+    def render(self, context, instance, placeholder):
+        if not instance.attributes:
+            instance.attributes = {}
+        if 'id' not in instance.attributes:
+            instance.attributes['id'] = HEADER_LOGO_ELEMENT_ID
+        return super().render(context, instance, placeholder)

taccsite_cms/contrib/taccsite_header_logo/render.py

@@ -0,0 +1,29 @@
+from cms.models import StaticPlaceholder
+from cms.plugin_rendering import ContentRenderer
+
+from taccsite_cms.contrib.taccsite_header_logo.cms_plugins import HeaderLogoPlugin
+
+
+def render(request, context):
+    """
+    Render published HeaderLogoPlugin from header-content (logo-only fragment).
+    """
+    static_ph = StaticPlaceholder.objects.filter(code='header-content').first()
+    if not static_ph:
+        return ''
+
+    placeholder = static_ph.public
+    placeholder.is_static = True
+
+    renderer = ContentRenderer(request)
+    language = renderer.request_language
+
+    for plugin in renderer.get_plugins_to_render(placeholder, language, template=None):
+        if plugin.plugin_type == HeaderLogoPlugin.__name__:
+            return renderer.render_plugin(
+                plugin,
+                context,
+                placeholder,
+                editable=False,
+            )
+    return ''

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-content)
+    # 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

@@ -499,7 +499,8 @@ def gettext(s): return s
     'taccsite_cms.contrib.taccsite_sample',
     'taccsite_cms.contrib.taccsite_offset',
     'taccsite_cms.contrib.taccsite_system_specs',
-    'taccsite_cms.contrib.taccsite_data_list'
+    'taccsite_cms.contrib.taccsite_data_list',
+    'taccsite_cms.contrib.taccsite_header_logo',
 ]
 
 # Convert list of paths to list of dotted module names
@@ -564,7 +565,16 @@ def get_subdirs_as_module_names(path):
 }
 
 CMS_PERMISSION = True
-CMS_PLACEHOLDER_CONF = {}
+CMS_PLACEHOLDER_CONF = {
+    'header-content': {
+        # HeaderLogoPlugin (PR 1.75); room for TaccHeaderBrandingPlugin (PR 3)
+        'plugins': ['HeaderLogoPlugin'],
+        'limits': {
+            'global': 2,
+            'HeaderLogoPlugin': 1,
+        },
+    },
+}
 
 THUMBNAIL_HIGH_RESOLUTION = True
 THUMBNAIL_PROCESSORS = (
@@ -673,7 +683,7 @@ def get_subdirs_as_module_names(path):
 if 'BRANDING' not in locals():
     BRANDING = False
 
-# For header_logo.html
+# For header_logo_via_settings.html (logo slot fallback)
 deprecated_SETTINGS_EXPORT += ['LOGO']
 if 'LOGO' not in locals():
     LOGO = False

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 -->
-  {% include "header_logo.html" %}
+  {% static_placeholder "header-content" or %}
+    {% include "header_logo_via_settings.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">
@@ -44,7 +47,6 @@
     {% endif %}
   </div>
 </nav>
-
 {% endwith %}
 {% endwith %}
 {% endwith %}

taccsite_cms/templates/header_logo.html

@@ -1,41 +1,7 @@
-{# @var logo, className #}
-{% load static custom_portal_settings %}
-
-{% if 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 %}
-    {% if visibility == "True" %}
-    <a id="header-logo" class="navbar-brand {{className}}" href="{{ targeturl }}" target="{{ targettype }}">
-      <img class="portal-logo {{ selectors }}" src="{% static filename %}" crossorigin="{{ corstype }}" alt="{{ accessibility }}" />
-    </a>
-    {% endif %}
-  {% endwith %}
-{% endwith %}
-
+{% load header_tags %}
+{% render_header_logo as header_logo %}
+{% if header_logo %}
+  {{ header_logo }}
 {% else %}
-
-{% with settings.PORTAL_LOGO as logo %}
-  <a
-    id="header-logo"
-    class="navbar-brand {{className}}"
-    href="{{ logo.link_href }}"
-    target="{{ logo.link_target }}"
-    {% if logo.link_name %}
-    aria-label="{{ logo.link_name }}"
-    {% endif %}
-  >
-    <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 %}
-
+  {% include "header_logo_via_settings.html" %}
 {% endif %}

taccsite_cms/templates/header_logo_via_settings.html

@@ -0,0 +1,45 @@
+{# @var className #}
+{% load static custom_portal_settings %}
+
+{% if settings.LOGO %}
+
+{# via deprecated CMS setting (e.g. CMS developer sets logo image) #}
+{% 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 %}
+    {% if visibility == "True" %}
+    <a id="header-logo" class="navbar-brand {{className}}" href="{{ targeturl }}" target="{{ targettype }}">
+      <img class="portal-logo {{ selectors }}" src="{% static filename %}" crossorigin="{{ corstype }}" alt="{{ accessibility }}" />
+    </a>
+    {% endif %}
+  {% endwith %}
+{% endwith %}
+
+{% elif settings.PORTAL_LOGO %}
+
+{# via CMS setting (e.g. CMS developer sets logo image) #}
+{% with settings.PORTAL_LOGO as logo %}
+  <a
+    id="header-logo"
+    class="navbar-brand {{className}}"
+    href="{{ logo.link_href }}"
+    {% if logo.link_target %}
+    target="{{ logo.link_target }}"
+    {% endif %}
+    {% if logo.link_name %}
+    aria-label="{{ logo.link_name }}"
+    {% endif %}
+  >
+    <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 %}
+
+{% endif %}

taccsite_cms/templatetags/header_tags.py

@@ -0,0 +1,12 @@
+from django import template
+from django.utils.safestring import mark_safe
+
+from taccsite_cms.contrib.taccsite_header_logo.render import render as render_header
+
+register = template.Library()
+
+
+@register.simple_tag(takes_context=True)
+def render_header_logo(context):
+    html = render_header(context['request'], context)
+    return mark_safe(html) if html else ''