feat: GH-999 let CMS admin change header logo

djangocms_tacc_header_logo/apps.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class TaccsiteHeaderLogoConfig(AppConfig):
+    name = 'djangocms_tacc_header_logo'
+    verbose_name = 'Header logo'

djangocms_tacc_header_logo/cms_plugins.py

@@ -0,0 +1,29 @@
+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
+
+from .forms import TaccsiteHeaderLogoForm
+
+HEADER_LOGO_LINK_CLASS = 'navbar-brand'
+
+
+@plugin_pool.register_plugin
+class TaccsiteHeaderLogoPlugin(PicturePlugin):
+    """
+    Components > "Header logo" Plugin
+    """
+    model = Picture
+    form = TaccsiteHeaderLogoForm
+    module = 'TACC Site'
+    name = _('Header logo')
+
+    def render(self, context, instance, placeholder):
+        if not instance.attributes:
+            instance.attributes = {}
+
+        existing_class = instance.attributes.get('class', '')
+        instance.attributes['class'] = f'{HEADER_LOGO_LINK_CLASS} {existing_class}'.strip()
+
+        return super().render(context, instance, placeholder)

djangocms_tacc_header_logo/constants.py

@@ -0,0 +1 @@
+HEADER_LOGO_PLACEHOLDER_NAME = 'header-logo'

djangocms_tacc_header_logo/forms.py

@@ -0,0 +1,38 @@
+from cms.models import Page
+from django.conf import settings
+from django.contrib.sites.models import Site
+from djangocms_picture.forms import PictureForm
+
+HEADER_LOGO_PICTURE_TEMPLATE = 'portal_logo'
+
+
+def default_home_page():
+    site = Site.objects.get_current()
+    return Page.objects.filter(is_home=True, node__site=site).first()
+
+
+class TaccsiteHeaderLogoForm(PictureForm):
+    """
+    Defaults for new Header logo plugins only (admin add form).
+
+    On a TACC/Core-Portal instance, defaults to Portal logo picture template.
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        if self.instance.pk:
+            return
+
+        if settings.PORTAL_IS_TACC_CORE_PORTAL:
+            self.initial.setdefault('template', HEADER_LOGO_PICTURE_TEMPLATE)
+
+        home = default_home_page()
+        if home is not None:
+            self.initial.setdefault('link_page', home.pk)
+
+        self.initial.setdefault('use_no_cropping', True)
+        self.initial.setdefault('use_automatic_scaling', False)
+
+        attributes = dict(self.initial.get('attributes') or {})
+        attributes.setdefault('alt', 'Project logo')
+        self.initial['attributes'] = attributes

djangocms_tacc_header_logo/render.py

@@ -0,0 +1,30 @@
+from cms.models import StaticPlaceholder
+from cms.plugin_rendering import ContentRenderer
+
+from djangocms_tacc_header_logo.cms_plugins import TaccsiteHeaderLogoPlugin
+from djangocms_tacc_header_logo.constants import HEADER_LOGO_PLACEHOLDER_NAME
+
+
+def render(request, context):
+    """
+    Render published TaccsiteHeaderLogoPlugin from header-logo (logo-only fragment).
+    """
+    static_ph = StaticPlaceholder.objects.filter(code=HEADER_LOGO_PLACEHOLDER_NAME).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 == TaccsiteHeaderLogoPlugin.__name__:
+            return renderer.render_plugin(
+                plugin,
+                context,
+                placeholder,
+                editable=False,
+            )
+    return ''

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

@@ -0,0 +1,67 @@
+# GH-999: Editable header
+
+Related:
+
+- [#999](https://github.com/TACC/Core-CMS/issues/999)
+- [#1083](https://github.com/TACC/Core-CMS/pull/1083)
+
+## Status as of 2026-06
+
+| State               | Description                       |
+| ------------------- | --------------------------------- |
+| one placeholder     | `header-logo` static placeholder  |
+| if plugin is added  | `TaccsiteHeaderLogoPlugin` is only option |
+| if plugin not added | renders settings-based logo       |
+
+The branding and navs and search are still settings-based.
+
+## Known Limitations
+
+| Issue | Summary | Why Allow This? |
+| --- | --- | --- |
+| [#1185](https://github.com/TACC/Core-CMS/issues/1185) | Header logo without a link is **missing** `class="portal-logo"` on `<img>`. | Default form links logo to home, so typical sites are unaffected. |
+
+## How to Add Other Header Plugins
+
+Requirements:
+
+- (for [CMS editor UX](#cms-editor-ux)) plugins render where `{% static_placeholder %}` sits
+- (to skip [Failed Ideas](#failed-ideas)) pick one option from below
+
+### A. Wrapper Plugin
+
+| Pros                           | Cons                                           |
+| ------------------------------ | ---------------------------------------------- |
+| One placeholder                | Extra container plugin                         |
+| Layout management consolidated | Build/Maintain wrapper                         |
+|                                | Must deprecate or migrate legacy `header-logo` |
+
+### B. Multiple Placeholders
+
+| Pros                               | Cons                               |
+| ---------------------------------- | ---------------------------------- |
+| Typical CMS usage                  | Several placeholders to configure  |
+|                                    | Layout management not consolidated |
+| Can keep using `header-logo` as is |                                    |
+
+## CMS Editor UX
+
+Requirements:
+
+- Static placeholder always visible in Structure mode.
+- Edit plugin: auto-refreshes page preview.
+- Add/Delete plugin: auto-refreshes page preview.
+- Structure mode button toggles render of Structure sidebar.
+
+## Failed Ideas
+
+| Idea                                         | Problem                                             |
+| -------------------------------------------- | --------------------------------------------------- |
+| One slot + custom `render_`* in many regions | Preview/Structure break; Picture edits need refresh |
+| Nest plugins under logo but render elsewhere | Preview/Structure break; Picture edits need refresh |
+| `static_placeholder` away from visible logo  | Bad WYSIWYG; toolbar/Structure bugs                 |
+| Per-region render registry without A or B    | Publish-only; bad edit UX                           |
+| Prematurely code Option A                    | Two plugins for one logo                            |
+| `cache = False` only                         | Doesn’t fix render vs placeholder split             |
+| Draft in `render_`*, placeholder elsewhere   | Image swap lag; duplicate surfaces                  |
+| Edit-only placeholder at top of header       | Structure JS errors; no real preview                |

package.json

@@ -21,6 +21,6 @@
   },
   "homepage": "https://github.com/TACC/Core-CMS",
   "devDependencies": {
-    "@tacc/core-styles": "^2.57.0"
+    "@tacc/core-styles": "^2.57.2"
   }
 }

taccsite_cms/_settings/djangocms_plugins.py

@@ -47,6 +47,7 @@
 ]
 DJANGOCMS_PICTURE_TEMPLATES = [
     ('no_link_to_ext_image', _('Do not link to external image')),
+    ('portal_logo', _('Portal 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 (e.g. footer-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

@@ -492,6 +492,7 @@ def gettext(s): return s
     # TACC CMS Plugins
     'djangocms_tacc_image_gallery',
     'djangocms_tacc_system_monitor',
+    'djangocms_tacc_header_logo',
 
     # TACC CMS Plugins - DECPRECATED
     'taccsite_cms.contrib.taccsite_blockquote',
@@ -563,8 +564,26 @@ def get_subdirs_as_module_names(path):
     },
 }
 
+from djangocms_tacc_header_logo.constants import HEADER_LOGO_PLACEHOLDER_NAME
+
 CMS_PERMISSION = True
-CMS_PLACEHOLDER_CONF = {}
+CMS_PLACEHOLDER_CONF = {
+    None: {
+        'excluded_plugins': ['TaccsiteHeaderLogoPlugin'],
+    },
+    HEADER_LOGO_PLACEHOLDER_NAME: {
+        'name': _('Header logo'),
+        'plugins': ['TaccsiteHeaderLogoPlugin'],
+        'excluded_plugins': [],
+        'limits': {
+            'global': 1,
+            'TaccsiteHeaderLogoPlugin': 1,
+        },
+    },
+    'footer-content': {
+        'name': _('Footer content'),
+    },
+}
 
 THUMBNAIL_HIGH_RESOLUTION = True
 THUMBNAIL_PROCESSORS = (
@@ -673,7 +692,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
 deprecated_SETTINGS_EXPORT += ['LOGO']
 if 'LOGO' not in locals():
     LOGO = False
@@ -726,6 +745,7 @@ def get_subdirs_as_module_names(path):
     'DEBUG',
     'GOOGLE_ANALYTICS_PROPERTY_ID',
     'GOOGLE_ANALYTICS_PRELOAD',
+    'HEADER_LOGO_PLACEHOLDER_NAME',
     'TACC_CORE_STYLES_VERSION',
     'PORTAL_BRANDING',
     'PORTAL_LOGO',

taccsite_cms/templates/djangocms_picture/default/picture.html

@@ -72,6 +72,9 @@
     {# /TACC #}
     {% endblock %}
     {# /TACC #}
+    {# TACC (allow attributes to be force-added to <img>): #}
+    {% block picture_attributes_img %}{% if picture_img_class %}class="{{ picture_img_class }}"{% endif %}{% endblock %}
+    {# /TACC #}
 >
 {% endlocalize %}
 

taccsite_cms/templates/djangocms_picture/portal_logo/picture.html

@@ -0,0 +1,2 @@
+{% extends "djangocms_picture/default/picture.html" %}
+{% block picture_attributes_img %}class="portal-logo"{% endblock %}

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 settings.HEADER_LOGO_PLACEHOLDER_NAME 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 %}