From e71a98499f272f7ff9f614fdee1e2a43ff94525b Mon Sep 17 00:00:00 2001
From: Abhimanyu Saharan <desk.abhimanyu@gmail.com>
Date: Fri, 12 May 2023 19:24:59 +0530
Subject: [PATCH] Adds BANNER_MAINTENANCE config (#12555)

* adds BANNER_MAINTENANCE config #12554

* changes as per review

* lint fix

* Fix admin form field widget

---------

Co-authored-by: jeremystretch <jstretch@netboxlabs.com>
---
 docs/configuration/miscellaneous.md | 11 +++++++++++
 netbox/extras/admin.py              |  2 +-
 netbox/netbox/config/parameters.py  | 11 +++++++++++
 netbox/templates/base/layout.html   |  4 ++--
 4 files changed, 25 insertions(+), 3 deletions(-)

diff --git a/docs/configuration/miscellaneous.md b/docs/configuration/miscellaneous.md
index c3fbb40aa..e3728acab 100644
--- a/docs/configuration/miscellaneous.md
+++ b/docs/configuration/miscellaneous.md
@@ -29,6 +29,17 @@ This defines custom content to be displayed on the login page above the login fo
 
 ---
 
+## BANNER_MAINTENANCE
+
+!!! tip "Dynamic Configuration Parameter"
+
+!!! note
+    This parameter was added in NetBox v3.5.
+
+This adds a banner to the top of every page when maintenance mode is enabled. HTML is allowed.
+
+---
+
 ## BANNER_TOP
 
 !!! tip "Dynamic Configuration Parameter"
diff --git a/netbox/extras/admin.py b/netbox/extras/admin.py
index 04a67b521..6d1b14370 100644
--- a/netbox/extras/admin.py
+++ b/netbox/extras/admin.py
@@ -25,7 +25,7 @@ class ConfigRevisionAdmin(admin.ModelAdmin):
             'fields': ('ALLOWED_URL_SCHEMES',),
         }),
         ('Banners', {
-            'fields': ('BANNER_LOGIN', 'BANNER_TOP', 'BANNER_BOTTOM'),
+            'fields': ('BANNER_LOGIN', 'BANNER_MAINTENANCE', 'BANNER_TOP', 'BANNER_BOTTOM'),
             'classes': ('monospace',),
         }),
         ('Pagination', {
diff --git a/netbox/netbox/config/parameters.py b/netbox/netbox/config/parameters.py
index 2bfa234f0..9c613217c 100644
--- a/netbox/netbox/config/parameters.py
+++ b/netbox/netbox/config/parameters.py
@@ -28,6 +28,17 @@ PARAMS = (
             ),
         },
     ),
+    ConfigParam(
+        name='BANNER_MAINTENANCE',
+        label=_('Maintenance banner'),
+        default='NetBox is currently in maintenance mode. Functionality may be limited.',
+        description=_('Additional content to display when in maintenance mode'),
+        field_kwargs={
+            'widget': forms.Textarea(
+                attrs={'class': 'vLargeTextField'}
+            ),
+        },
+    ),
     ConfigParam(
         name='BANNER_TOP',
         label=_('Top banner'),
diff --git a/netbox/templates/base/layout.html b/netbox/templates/base/layout.html
index 6b247d81a..9e8b7d7bf 100644
--- a/netbox/templates/base/layout.html
+++ b/netbox/templates/base/layout.html
@@ -77,10 +77,10 @@ Blocks:
           </div>
         {% endif %}
 
-        {% if config.MAINTENANCE_MODE %}
+        {% if config.MAINTENANCE_MODE and config.BANNER_MAINTENANCE %}
           <div class="alert alert-warning text-center mx-3" role="alert">
             <h5><i class="mdi mdi-alert"></i> Maintenance Mode</h5>
-            NetBox is currently in maintenance mode. Functionality may be limited.
+            {{ config.BANNER_MAINTENANCE|escape }}
           </div>
         {% endif %}