From d8a665db390e8aff13383452dc8791931b12c8e2 Mon Sep 17 00:00:00 2001
From: Jeremy Stretch <jstretch@netboxlabs.com>
Date: Thu, 11 Jan 2024 15:31:23 -0500
Subject: [PATCH] Refactor base templates to ensure consistent display of
 header content

---
 netbox/dcim/views.py                          |  1 +
 netbox/templates/account/base.html            |  2 +-
 netbox/templates/base/layout.html             | 54 ++++---------
 .../core/configrevision_restore.html          | 18 +----
 .../templates/dcim/virtualchassis_edit.html   |  2 +-
 netbox/templates/extras/report_list.html      |  2 +-
 netbox/templates/extras/script_list.html      |  2 +-
 netbox/templates/extras/script_result.html    |  2 +-
 netbox/templates/generic/_base.html           | 32 ++++++++
 .../templates/generic/bulk_add_component.html |  2 +-
 netbox/templates/generic/bulk_delete.html     |  2 +-
 netbox/templates/generic/bulk_edit.html       |  2 +-
 netbox/templates/generic/bulk_import.html     |  2 +-
 netbox/templates/generic/bulk_remove.html     | 78 +++++++++++--------
 netbox/templates/generic/bulk_rename.html     | 12 ++-
 .../templates/generic/confirmation_form.html  |  2 +-
 netbox/templates/generic/object.html          |  6 +-
 netbox/templates/generic/object_delete.html   |  4 +-
 netbox/templates/generic/object_edit.html     |  2 +-
 netbox/templates/generic/object_list.html     |  2 +-
 netbox/templates/home.html                    |  1 +
 netbox/templates/inc/alerts/danger.html       |  2 +-
 netbox/templates/inc/alerts/info.html         |  2 +-
 netbox/templates/inc/alerts/success.html      |  2 +-
 netbox/templates/inc/alerts/warning.html      |  2 +-
 netbox/templates/inc/banner.html              |  4 +
 26 files changed, 130 insertions(+), 112 deletions(-)
 create mode 100644 netbox/templates/generic/_base.html
 create mode 100644 netbox/templates/inc/banner.html

diff --git a/netbox/dcim/views.py b/netbox/dcim/views.py
index 497935b15..bbb399dd3 100644
--- a/netbox/dcim/views.py
+++ b/netbox/dcim/views.py
@@ -3353,6 +3353,7 @@ class VirtualChassisEditView(ObjectPermissionRequiredMixin, GetReturnURLMixin, V
         formset = VCMemberFormSet(queryset=members_queryset)
 
         return render(request, 'dcim/virtualchassis_edit.html', {
+            'object': virtual_chassis,
             'vc_form': vc_form,
             'formset': formset,
             'return_url': self.get_return_url(request, virtual_chassis),
diff --git a/netbox/templates/account/base.html b/netbox/templates/account/base.html
index 124b70414..1c0e458fc 100644
--- a/netbox/templates/account/base.html
+++ b/netbox/templates/account/base.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load i18n %}
 
 {% block tabs %}
diff --git a/netbox/templates/base/layout.html b/netbox/templates/base/layout.html
index 36caa0039..ff5a57cd1 100644
--- a/netbox/templates/base/layout.html
+++ b/netbox/templates/base/layout.html
@@ -116,15 +116,15 @@ Blocks:
     <div class="page-wrapper">
 
       {# Page header #}
-      <div class="page-header m-0">
+      {% block header %}
 
-        {# Banners #}
+        {# Top banner #}
         {% if config.BANNER_TOP %}
-          <div class="text-center mx-3 mb-2">
-            {{ config.BANNER_TOP|safe }}
-          </div>
+          {% include 'inc/banner.html' with content=config.BANNER_TOP %}
         {% endif %}
+        {# /Top banner #}
 
+        {# Alerts #}
         {% if settings.DEBUG and not settings.DEVELOPER %}
           {% include 'inc/alerts/warning.html' with title="Debug mode is enabled" message="Performance may be limited. Debugging should never be enabled on a production system." %}
         {% endif %}
@@ -132,57 +132,31 @@ Blocks:
         {% if config.MAINTENANCE_MODE and config.BANNER_MAINTENANCE %}
           {% include 'inc/alerts/warning.html' with title="Maintenance Mode" message=config.BANNER_MAINTENANCE|escape %}
         {% endif %}
-        {# /Banners #}
+        {# /Alerts #}
 
-        {% block header %}
-          <div class="container-xl mt-2 d-print-none">
-            <div class="row align-items-center">
-
-              {# Title #}
-              <div class="col">
-                <h2 class="page-title mb-1">{% block title %}{% endblock title %}</h2>
-                {% block subtitle %}{% endblock %}
-              </div>
-
-              {# Controls #}
-              <div class="col-auto d-print-none">
-                {% block controls %}{% endblock controls %}
-              </div>
-
-            </div>
-          </div>
-
-          {# Tabs #}
-          <div class="page-tabs mt-3">
-            {% block tabs %}{% endblock %}
-          </div>
-
-        {% endblock header %}
-      </div>
+      {% endblock header %}
       {# /Page header #}
 
       {# Page body #}
       {% block page %}
-        <div class="page-body">
+        <div class="page-body my-1">
           <div class="container-xl tab-content py-3">
 
             {# Page content #}
             {% block content %}{% endblock %}
             {# /Page content #}
 
-            {# Bottom banner #}
-            {% if config.BANNER_BOTTOM %}
-              <div class="text-center mx-3 mt-2">
-                {{ config.BANNER_BOTTOM|safe }}
-              </div>
-            {% endif %}
-            {# /Bottom banner #}
-
           </div>
         </div>
       {% endblock page %}
       {# /Page body #}
 
+      {# Bottom banner #}
+      {% if config.BANNER_BOTTOM %}
+        {% include 'inc/banner.html' with content=config.BANNER_BOTTOM %}
+      {% endif %}
+      {# /Bottom banner #}
+
       {# Page footer #}
       <footer class="footer footer-transparent d-print-none py-2">
         <div class="container-xl d-flex justify-content-between align-items-center">
diff --git a/netbox/templates/core/configrevision_restore.html b/netbox/templates/core/configrevision_restore.html
index 2b3803d84..c26f2fbf1 100644
--- a/netbox/templates/core/configrevision_restore.html
+++ b/netbox/templates/core/configrevision_restore.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/object.html' %}
 {% load helpers %}
 {% load buttons %}
 {% load perms %}
@@ -13,20 +13,6 @@
   </div>
 {% endblock %}
 
-{% block header %}
-  <div class="row noprint">
-    <div class="col col-md-12">
-      <nav class="breadcrumb-container px-3" aria-label="breadcrumb">
-        <ol class="breadcrumb">
-          <li class="breadcrumb-item"><a href="{% url 'core:configrevision_list' %}">{% trans "Config revisions" %}</a></li>
-          <li class="breadcrumb-item"><a href="{% url 'core:configrevision' pk=object.pk %}">{{ object }}</a></li>
-        </ol>
-      </nav>
-    </div>
-  </div>
-  {{ block.super }}
-{% endblock header %}
-
 {% block controls %}
   <div class="controls">
     <div class="control-group">
@@ -76,8 +62,8 @@
     <div class="submit-row" style="margin-top: 20px">
       <div class="controls">
         <div class="control-group">
-          <button type="submit" name="restore" class="btn btn-primary">{% trans "Restore" %}</button>
           <a href="{% url 'core:configrevision_list' %}" id="cancel" name="cancel" class="btn btn-outline-secondary">{% trans "Cancel" %}</a>
+          <button type="submit" name="restore" class="btn btn-primary">{% trans "Restore" %}</button>
         </div>
       </div>
     </div>
diff --git a/netbox/templates/dcim/virtualchassis_edit.html b/netbox/templates/dcim/virtualchassis_edit.html
index d9a698591..3de269d7a 100644
--- a/netbox/templates/dcim/virtualchassis_edit.html
+++ b/netbox/templates/dcim/virtualchassis_edit.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/object_edit.html' %}
 {% load helpers %}
 {% load form_helpers %}
 {% load i18n %}
diff --git a/netbox/templates/extras/report_list.html b/netbox/templates/extras/report_list.html
index 062d044e1..ff6e9a971 100644
--- a/netbox/templates/extras/report_list.html
+++ b/netbox/templates/extras/report_list.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load buttons %}
 {% load helpers %}
 {% load perms %}
diff --git a/netbox/templates/extras/script_list.html b/netbox/templates/extras/script_list.html
index ca113327d..d2404af17 100644
--- a/netbox/templates/extras/script_list.html
+++ b/netbox/templates/extras/script_list.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load buttons %}
 {% load helpers %}
 {% load i18n %}
diff --git a/netbox/templates/extras/script_result.html b/netbox/templates/extras/script_result.html
index 5773b7b15..544146aa9 100644
--- a/netbox/templates/extras/script_result.html
+++ b/netbox/templates/extras/script_result.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load buttons %}
 {% load perms %}
diff --git a/netbox/templates/generic/_base.html b/netbox/templates/generic/_base.html
new file mode 100644
index 000000000..7f2cac5a1
--- /dev/null
+++ b/netbox/templates/generic/_base.html
@@ -0,0 +1,32 @@
+{% extends 'base/layout.html' %}
+
+{% block header %}
+  <div class="page-header m-0">
+    {{ block.super }}
+
+    {% block page-header %}
+      <div class="container-xl mt-2 d-print-none">
+        <div class="row align-items-center">
+
+          {# Title #}
+          <div class="col">
+            <h2 class="page-title mb-1">{% block title %}{% endblock title %}</h2>
+            {% block subtitle %}{% endblock %}
+          </div>
+
+          {# Controls #}
+          <div class="col-auto d-print-none">
+            {% block controls %}{% endblock controls %}
+          </div>
+
+        </div>
+      </div>
+    {% endblock %}
+
+    {# Tabs #}
+    <div class="page-tabs mt-3">
+      {% block tabs %}{% endblock %}
+    </div>
+
+  </div>
+{% endblock header %}
diff --git a/netbox/templates/generic/bulk_add_component.html b/netbox/templates/generic/bulk_add_component.html
index 5bd1d4a75..799fd1606 100644
--- a/netbox/templates/generic/bulk_add_component.html
+++ b/netbox/templates/generic/bulk_add_component.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load form_helpers %}
 {% load render_table from django_tables2 %}
diff --git a/netbox/templates/generic/bulk_delete.html b/netbox/templates/generic/bulk_delete.html
index 120ad53ae..2cae404cb 100644
--- a/netbox/templates/generic/bulk_delete.html
+++ b/netbox/templates/generic/bulk_delete.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load render_table from django_tables2 %}
 {% load i18n %}
diff --git a/netbox/templates/generic/bulk_edit.html b/netbox/templates/generic/bulk_edit.html
index b762f33dd..6dd35617a 100644
--- a/netbox/templates/generic/bulk_edit.html
+++ b/netbox/templates/generic/bulk_edit.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load form_helpers %}
 {% load render_table from django_tables2 %}
diff --git a/netbox/templates/generic/bulk_import.html b/netbox/templates/generic/bulk_import.html
index 6ec135d82..b23c2cebb 100644
--- a/netbox/templates/generic/bulk_import.html
+++ b/netbox/templates/generic/bulk_import.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load form_helpers %}
 {% load i18n %}
diff --git a/netbox/templates/generic/bulk_remove.html b/netbox/templates/generic/bulk_remove.html
index 1403bfddc..65871a55a 100644
--- a/netbox/templates/generic/bulk_remove.html
+++ b/netbox/templates/generic/bulk_remove.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load render_table from django_tables2 %}
 {% load i18n %}
@@ -7,38 +7,50 @@
   {% trans "Remove" %} {{ table.rows|length }} {{ obj_type_plural|bettertitle }}?
 {% endblock %}
 
-{% block content %}
-<div class="alert alert-danger bg-danger-subtle" role="alert">
-  <div class="d-flex">
-    <div>
-      <i class="mdi mdi-alert-octagon p-2"></i>
-    </div>
-    <div>
-      <h4 class="alert-title">{% trans "Confirm Bulk Removal" %}</h4>
-      {% blocktrans trimmed with count=table.rows|length %}
-        The following operation will remove {{ count }} {{ obj_type_plural }} from {{ parent_obj }}. Please
-        carefully review the {{ obj_type_plural }} to be removed and confirm below.
-      {% endblocktrans %}
-    </div>
-  </div>
-</div>
-<div class="container-xl px-0">
-  <div class="table-responsive">
-    {% render_table table 'inc/table.html' %}
-  </div>
-  <form action="." method="post" class="form">
-    {% csrf_token %}
-    {% for field in form.hidden_fields %}
-      {{ field }}
-    {% endfor %}
-    <div class="text-end">
-      <a href="{{ return_url }}" class="btn btn-outline-secondary">{% trans "Cancel" %}</a>
-      <button type="submit" name="_confirm" class="btn btn-danger">
-        {% blocktrans trimmed with count=table.rows|length %}
-          Delete these {{ count }} {{ obj_type_plural }}
-        {% endblocktrans %}
+{% block tabs %}
+  <ul class="nav nav-tabs px-3">
+    <li class="nav-item" role="presentation">
+      <button class="nav-link active" type="button" role="tab" aria-controls="edit-form" aria-selected="true">
+        {% trans "Bulk Remove" %}
       </button>
+    </li>
+  </ul>
+{% endblock tabs %}
+
+{% block content %}
+  <div class="tab-pane show active" role="tabpanel">
+    <div class="alert alert-danger bg-danger-subtle" role="alert">
+      <div class="d-flex">
+        <div>
+          <i class="mdi mdi-alert-octagon p-2"></i>
+        </div>
+        <div>
+          <h4 class="alert-title">{% trans "Confirm Bulk Removal" %}</h4>
+          {% blocktrans trimmed with count=table.rows|length %}
+            The following operation will remove {{ count }} {{ obj_type_plural }} from {{ parent_obj }}. Please
+            carefully review the {{ obj_type_plural }} to be removed and confirm below.
+          {% endblocktrans %}
+        </div>
+      </div>
     </div>
-  </form>
-</div>
+    <div class="container-xl px-0">
+      <div class="table-responsive">
+        {% render_table table 'inc/table.html' %}
+      </div>
+      <form action="." method="post" class="form">
+        {% csrf_token %}
+        {% for field in form.hidden_fields %}
+          {{ field }}
+        {% endfor %}
+        <div class="text-end">
+          <a href="{{ return_url }}" class="btn btn-outline-secondary">{% trans "Cancel" %}</a>
+          <button type="submit" name="_confirm" class="btn btn-danger">
+            {% blocktrans trimmed with count=table.rows|length %}
+              Remove these {{ count }} {{ obj_type_plural }}
+            {% endblocktrans %}
+          </button>
+        </div>
+      </form>
+    </div>
+  </div>
 {% endblock content %}
diff --git a/netbox/templates/generic/bulk_rename.html b/netbox/templates/generic/bulk_rename.html
index 751039e52..4ba39c254 100644
--- a/netbox/templates/generic/bulk_rename.html
+++ b/netbox/templates/generic/bulk_rename.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load form_helpers %}
 {% load i18n %}
@@ -7,6 +7,16 @@
   {% trans "Renaming" %} {{ selected_objects|length }} {{ obj_type_plural|bettertitle }}
 {% endblock %}
 
+{% block tabs %}
+  <ul class="nav nav-tabs px-3">
+    <li class="nav-item" role="presentation">
+      <button class="nav-link active" type="button" role="tab" aria-controls="edit-form" aria-selected="true">
+        {% trans "Bulk Rename" %}
+      </button>
+    </li>
+  </ul>
+{% endblock tabs %}
+
 {% block content %}
 <div class="row mb-3">
     <div class="col col-md-7">
diff --git a/netbox/templates/generic/confirmation_form.html b/netbox/templates/generic/confirmation_form.html
index 88c37867b..36706edce 100644
--- a/netbox/templates/generic/confirmation_form.html
+++ b/netbox/templates/generic/confirmation_form.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load form_helpers %}
 {% load i18n %}
 
diff --git a/netbox/templates/generic/object.html b/netbox/templates/generic/object.html
index b677e2393..431373aba 100644
--- a/netbox/templates/generic/object.html
+++ b/netbox/templates/generic/object.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load buttons %}
 {% load custom_links %}
 {% load helpers %}
@@ -18,7 +18,7 @@ Context:
   object: The object instance being viewed
 {% endcomment %}
 
-{% block header %}
+{% block page-header %}
   <div class="d-flex justify-content-between align-items-center mx-3 my-2">
 
     {# Breadcrumbs #}
@@ -40,7 +40,7 @@ Context:
 
   </div>
   {{ block.super }}
-{% endblock header %}
+{% endblock page-header %}
 
 {% block title %}{{ object }}{% endblock %}
 
diff --git a/netbox/templates/generic/object_delete.html b/netbox/templates/generic/object_delete.html
index e5a152076..e45370212 100644
--- a/netbox/templates/generic/object_delete.html
+++ b/netbox/templates/generic/object_delete.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load helpers %}
 {% load form_helpers %}
 {% load i18n %}
@@ -15,8 +15,6 @@ Context:
   {% trans "Delete" %} {{ object|meta:"verbose_name" }}?
 {% endblock %}
 
-{% block header %}{% endblock %}
-
 {% block content %}
   <div class="modal" tabindex="-1" style="display: block; position: static">
     <div class="modal-dialog">
diff --git a/netbox/templates/generic/object_edit.html b/netbox/templates/generic/object_edit.html
index e1d04c4ff..d9071e015 100644
--- a/netbox/templates/generic/object_edit.html
+++ b/netbox/templates/generic/object_edit.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load i18n %}
 
 {% comment %}
diff --git a/netbox/templates/generic/object_list.html b/netbox/templates/generic/object_list.html
index e492fefc6..3a9443c8d 100644
--- a/netbox/templates/generic/object_list.html
+++ b/netbox/templates/generic/object_list.html
@@ -1,4 +1,4 @@
-{% extends 'base/layout.html' %}
+{% extends 'generic/_base.html' %}
 {% load buttons %}
 {% load helpers %}
 {% load plugins %}
diff --git a/netbox/templates/home.html b/netbox/templates/home.html
index 2ee054a59..121f84faf 100644
--- a/netbox/templates/home.html
+++ b/netbox/templates/home.html
@@ -4,6 +4,7 @@
 {% load i18n %}
 
 {% block header %}
+  {{ block.super }}
   {% if new_release %}
     <div class="alert alert-info bg-info-subtle mx-3" role="alert">
       <div class="d-flex">
diff --git a/netbox/templates/inc/alerts/danger.html b/netbox/templates/inc/alerts/danger.html
index 44a8ca704..cb6936ac1 100644
--- a/netbox/templates/inc/alerts/danger.html
+++ b/netbox/templates/inc/alerts/danger.html
@@ -1,6 +1,6 @@
 {% load i18n %}
 
-<div class="alert alert-danger bg-danger-subtle mx-3" role="alert">
+<div class="alert alert-danger bg-danger-subtle mx-3 my-2" role="alert">
   <div class="d-flex">
     <div>
       <i class="mdi mdi-alert-octagon p-2"></i>
diff --git a/netbox/templates/inc/alerts/info.html b/netbox/templates/inc/alerts/info.html
index 94ace3bd6..bcbfd03ec 100644
--- a/netbox/templates/inc/alerts/info.html
+++ b/netbox/templates/inc/alerts/info.html
@@ -1,6 +1,6 @@
 {% load i18n %}
 
-<div class="alert alert-info bg-info-subtle mx-3" role="alert">
+<div class="alert alert-info bg-info-subtle mx-3 my-2" role="alert">
   <div class="d-flex">
     <div>
       <i class="mdi mdi-information-outline p-2"></i>
diff --git a/netbox/templates/inc/alerts/success.html b/netbox/templates/inc/alerts/success.html
index 5fcb23dba..bb3405401 100644
--- a/netbox/templates/inc/alerts/success.html
+++ b/netbox/templates/inc/alerts/success.html
@@ -1,6 +1,6 @@
 {% load i18n %}
 
-<div class="alert alert-success bg-success-subtle mx-3" role="alert">
+<div class="alert alert-success bg-success-subtle mx-3 my-2" role="alert">
   <div class="d-flex">
     <div>
       <i class="mdi mdi-check-bold p-2"></i>
diff --git a/netbox/templates/inc/alerts/warning.html b/netbox/templates/inc/alerts/warning.html
index 73eefd2d0..8099daf3c 100644
--- a/netbox/templates/inc/alerts/warning.html
+++ b/netbox/templates/inc/alerts/warning.html
@@ -1,6 +1,6 @@
 {% load i18n %}
 
-<div class="alert alert-warning bg-warning-subtle mx-3" role="alert">
+<div class="alert alert-warning bg-warning-subtle mx-3 my-2" role="alert">
   <div class="d-flex">
     <div>
       <i class="mdi mdi-alert p-2"></i>
diff --git a/netbox/templates/inc/banner.html b/netbox/templates/inc/banner.html
new file mode 100644
index 000000000..b15d9d427
--- /dev/null
+++ b/netbox/templates/inc/banner.html
@@ -0,0 +1,4 @@
+{# Display top or bottom banner content #}
+<div class="text-center mx-3 m-2">
+  {{ content|safe }}
+</div>