add database model for maintenance mode info (#192)

Co-authored-by: akochari <[email protected]>

common/admin.py

@@ -2,7 +2,7 @@
 from django.contrib.auth.admin import UserAdmin as DefaultUserAdmin
 from django.contrib.auth.models import User
 
-from .models import EmailVerificationTable, UserProfile
+from .models import EmailVerificationTable, MaintenanceMode, UserProfile
 
 
 class UserProfileInline(admin.StackedInline):
@@ -32,5 +32,6 @@ def get_affiliation(self, instance):
 
 admin.site.unregister(User)
 admin.site.register(User, UserAdmin)
+admin.site.register(MaintenanceMode)
 
 # Register your models here.

common/context_processors.py

@@ -0,0 +1,6 @@
+from .models import MaintenanceMode
+
+
+def maintenance_mode(request):
+    data = MaintenanceMode.objects.all()
+    return {"maintenance_mode": data}

common/migrations/0005_maintenancemode.py

@@ -0,0 +1,21 @@
+# Generated by Django 4.2.7 on 2024-04-15 07:48
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("common", "0004_userprofile_deleted_on"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="MaintenanceMode",
+            fields=[
+                ("id", models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name="ID")),
+                ("login_and_signup_disabled", models.BooleanField(default=False)),
+                ("message_in_header", models.TextField(blank=True, max_length=1000)),
+                ("message_in_footer", models.TextField(blank=True, max_length=1000)),
+            ],
+        ),
+    ]

common/models.py

@@ -39,3 +39,9 @@ class FixtureVersion(models.Model):
 
     def __str__(self):
         return f"{self.filename} - {self.hash}"
+
+
+class MaintenanceMode(models.Model):
+    login_and_signup_disabled = models.BooleanField(default=False)
+    message_in_header = models.TextField(max_length=1000, blank=True)
+    message_in_footer = models.TextField(max_length=1000, blank=True)

customtags/templatetags/is_login_signup_disabled.py

@@ -0,0 +1,8 @@
+from django import template
+
+register = template.Library()
+
+
+@register.filter(name="is_login_signup_disabled")
+def is_login_signup_disabled(queryset):
+    return queryset.filter(login_and_signup_disabled=True).exists()

portal/tests.py

@@ -44,6 +44,7 @@ def test_home_view_class():
     assert "<title>Home | SciLifeLab Serve (beta)</title>" in response.content.decode()
 
 
+@pytest.mark.django_db
 def test_about_view():
     # Get correct request
     request = RequestFactory().get(reverse("portal:about"))
@@ -54,6 +55,7 @@ def test_about_view():
     assert "<title>About | SciLifeLab Serve (beta)</title>" in response.content.decode()
 
 
+@pytest.mark.django_db
 def test_teaching_view():
     # Get correct request
     request = RequestFactory().get(reverse("portal:teaching"))
@@ -64,6 +66,7 @@ def test_teaching_view():
     assert "<title>Teaching | SciLifeLab Serve (beta)</title>" in response.content.decode()
 
 
+@pytest.mark.django_db
 def test_privacy_view():
     # Get correct request
     request = RequestFactory().get(reverse("portal:privacy"))

studio/settings.py

@@ -136,6 +136,7 @@
                 "django.template.context_processors.request",
                 "django.contrib.auth.context_processors.auth",
                 "django.contrib.messages.context_processors.messages",
+                "common.context_processors.maintenance_mode",
             ]
             + DJANGO_WIKI_CONTEXT_PROCESSOR,
             "libraries": {

templates/common/footer.html

@@ -6,7 +6,18 @@
 {% get_setting "DEBUG" as debug_mode %}
 
 <div class="footer border-top bg-light text-muted small pt-4 mt-auto">
+
     <div class="container">
+
+    {# In case we want to display a maintenance message or similar#}
+    {% for obj in maintenance_mode %}
+    {% if obj.message_in_footer %}
+        <div class="alert alert-warning small" role="alert">
+            {{ obj.message_in_footer }}
+          </div>
+    {% endif %}
+    {% endfor %}
+
     <div class="row pb-2">
             <div class="col-lg-2">
                 <ul class="list-unstyled">

templates/common/navbar.html

@@ -1,5 +1,5 @@
 {% load static %}
-
+{% load is_login_signup_disabled %}
 <nav class="bg-light shadow-sm mb-3 py-2">
     <div class="container">
         <div class="row">
@@ -53,10 +53,10 @@
                     {% else %}
 
                     <li class="nav-item flex-wrap">
-                        <a class="btn btn-profile order-lg-2 order-1 mx-2" href="{% url 'common:signup' %}">
+                        <a class="btn btn-profile order-lg-2 order-1 mx-2 {% if maintenance_mode|is_login_signup_disabled %}disabled{% endif %}" href="{% url 'common:signup' %}">
                             <i class="bi bi-person-plus"></i> Register
                         </a>
-                        <a class="btn btn-profile order-lg-1 order-2 mx-2" href="{% url 'login' %}">
+                        <a class="btn btn-profile order-lg-1 order-2 mx-2 {% if maintenance_mode|is_login_signup_disabled %}disabled{% endif %}" href="{% url 'login' %}">
                             <i class="bi bi-box-arrow-in-right"></i> Log in
                         </a>
                     </li>
@@ -67,3 +67,18 @@
         </div>
     </div>
 </nav>
+
+{% for obj in maintenance_mode %}
+{% if obj.message_in_header %}
+<div class="container">
+    <div class="row d-flex justify-content-center">
+        <div class="col-12 col-md-8 text-center">
+            <div class="alert alert-warning border" role="alert">
+                <p class="mb-0 fs-5"><i class="bi-exclamation-triangle"></i></p>
+                <p>{{ obj.message_in_header | safe }}</p>
+            </div>
+        </div>
+    </div>
+</div>
+{% endif %}
+{% endfor %}

templates/portal/home.html

@@ -143,6 +143,7 @@ <h5 class="">{{ model.name|truncatechars:30 }}</h5>
         </div>
     </div>
 
+    {% if news_objects %}
     <div class="row text-center mt-5">
         <div class="col-12 text-center">
             <h3>News
@@ -175,6 +176,7 @@ <h5 class="text-grape">{{ news.title }}</h5>
             </div>
             {% endif %}
     </div>
+    {% endif %}
 
     {% if collection_objects %}
     <div class="row text-center mt-5 align-items-center" id="collections">

templates/registration/login.html

@@ -1,19 +1,21 @@
 {% extends 'base.html' %}
 {% load static %}
-
+{% load is_login_signup_disabled %}
 {% block title %}Login{% endblock %}
 
 {% block content %}
 
 <div class="container">
   <!-- Outer Row -->
+{% if not maintenance_mode|is_login_signup_disabled %}
   <div class="row justify-content-center">
     <div class="col-12 col-md-9">
       {% include 'common/flash_messages.html' %}
       <div class="card border-0 shadow-lg my-5 py-5">
         <div class="card-body">
           <!-- Nested Row within Card Body -->
           <div class="col-lg-6 offset-lg-3">
+
             <div class="col text-center">
               <h2 class="text-dark mb-4">Log in</h2>
             </div>
@@ -36,6 +38,8 @@ <h2 class="text-dark mb-4">Log in</h2>
               </div>
             {% endif %}
 
+
+
             <div class="py-4 d-flex justify-content-center">
 
               <div class="w-100">
@@ -61,11 +65,13 @@ <h2 class="text-dark mb-4">Log in</h2>
             <div class="text-center">
               <a href="{% url 'common:signup' %}">Don't have an account? Sign up here</a>
             </div>
+
           </div>
         </div>
       </div>
     </div>
   </div>
+{% endif %}
 </div>
 
 

templates/registration/signup.html

@@ -3,14 +3,15 @@
 {% block title %}Register{% endblock %}
 
 {% load static %}
-
+{% load is_login_signup_disabled %}
 {% block extra_scripts %}
 	<script src="{% static 'js/form-helpers.js' %}"></script>
 {% endblock %}
 
 
 {% block content %}
 <div class="container">
+    {% if not maintenance_mode|is_login_signup_disabled %}
     <div class="card border-0 shadow-lg my-5">
         <div class="card-body p-0">
             <!-- Nested Row within Card Body -->
@@ -180,6 +181,6 @@ <h2 class="text-dark mb-4 text-center">Register</h2>
             </div>
         </div>
     </div>
-</div>
+    {% endif %}
 </div>
 {% endblock %}