Merge branch 'banners' into develop

Author: pinwheeeel

core/admin.py

@@ -781,6 +781,13 @@ def content_object(self, obj):
     content_object.short_description = "Associated Post"
 
 
+class BannerAdmin(admin.ModelAdmin):
+    list_display = ["name", "start_date", "end_date"]
+    search_fields = ["name"]
+
+    list_filter = ["start_date", "end_date"]
+
+
 admin.site.register(User, UserAdmin)
 admin.site.register(models.Timetable, TimetableAdmin)
 admin.site.register(models.Term, TermAdmin)
@@ -795,6 +802,7 @@ def content_object(self, obj):
 admin.site.register(models.Event, EventAdmin)
 admin.site.register(models.Raffle, RaffleAdmin)
 admin.site.register(models.StaffMember)
+admin.site.register(models.Banner, BannerAdmin)
 
 admin.site.unregister(FlatPage)
 admin.site.register(FlatPage, CustomFlatPageAdmin)

core/api/views/meta.py

@@ -7,6 +7,8 @@
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
+from ...models import Banner
+
 
 @extend_schema(
     description="Returns the current API version.",
@@ -57,28 +59,6 @@ def get(request) -> Dict[str, str]:
     ],
 )
 class Banners(APIView):
-    uncensored_keys = (
-        "start",
-        "end",
-        "content",
-        "icon_url",
-        "cta_link",
-        "cta_label",
-    )
-    allowed_blank = ("icon_url", "cta_link", "cta_label")
-
-    @classmethod
-    def censor(cls, banner: Dict) -> Dict:
-        res = {}
-        for key in cls.uncensored_keys:
-            if key in banner:
-                res[key] = banner[key]
-            elif key not in banner and key in cls.allowed_blank:
-                pass
-            else:
-                raise KeyError(f"Required Key {key} not found in banner {banner}")
-        return res
-
     @staticmethod
     def get(request):
         """Returns the current banners and upcoming banners for the home page. note: upcoming banners only return the banners for the next day"""
@@ -87,11 +67,14 @@ def get(request):
     @classmethod
     def calculate_banners(cls):
         now = timezone.now()
-        current = filter(lambda b: b["start"] <= now < b["end"], settings.BANNER3)
-        current = list(map(Banners.censor, current))
-        upcoming = filter(
-            lambda b: now < b["start"] > now + timedelta(days=1),
-            settings.BANNER3,
+
+        fields = [f.name for f in Banner._meta.fields if f.name != "name"]
+
+        current = Banner.objects.filter(start_date__lte=now, end_date__gt=now).values(
+            *fields
         )
-        upcoming = list(map(Banners.censor, upcoming))
-        return dict(current=current, upcoming=upcoming)
+        upcoming = Banner.objects.filter(
+            start_date__gt=now, start_date__lt=now + timedelta(days=1)
+        ).values(*fields)
+
+        return dict(current=list(current), upcoming=list(upcoming))

core/migrations/0081_banner.py

@@ -0,0 +1,29 @@
+# Generated by Django 5.1.14 on 2025-11-08 02:00
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0080_alter_announcement_options_and_more'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='Banner',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('name', models.CharField(help_text='Give the banner a name! Only used for admin purposes to differentiate banners, not displayed elsewhere', max_length=100)),
+                ('content', models.CharField(max_length=200)),
+                ('icon_url', models.CharField(blank=True, max_length=150)),
+                ('cta_link', models.CharField(blank=True, max_length=150)),
+                ('cta_label', models.CharField(blank=True, help_text='Required only if cta_link is present', max_length=100)),
+                ('start_date', models.DateTimeField()),
+                ('end_date', models.DateTimeField()),
+            ],
+            options={
+                'constraints': [models.CheckConstraint(condition=models.Q(('cta_link', ''), models.Q(models.Q(('cta_link', ''), _negated=True), models.Q(('cta_label', ''), _negated=True)), _connector='OR'), name='cta_label_requirement'), models.CheckConstraint(condition=models.Q(('end_date__gte', models.F('start_date'))), name='end_date_gte_to_start_date')],
+            },
+        ),
+    ]

core/models/__init__.py

@@ -7,3 +7,4 @@
 from .tag import *
 from .timetable import *
 from .user import *
+from .banner import *

core/models/banner.py

@@ -0,0 +1,47 @@
+from django.db import models
+from django.core.exceptions import ValidationError
+
+
+class Banner(models.Model):
+    name = models.CharField(
+        max_length=100,
+        help_text="Give the banner a name! Only used for admin purposes to differentiate banners, not displayed elsewhere",
+    )
+
+    content = models.CharField(max_length=200)
+    icon_url = models.CharField(max_length=150, blank=True)
+
+    cta_link = models.CharField(max_length=150, blank=True)
+    cta_label = models.CharField(
+        max_length=100, help_text="Required only if cta_link is present", blank=True
+    )
+
+    start_date = models.DateTimeField()
+    end_date = models.DateTimeField()
+
+    def clean(self):
+        errors = {}
+
+        if self.cta_link and not self.cta_label:
+            errors["cta_label"] = "cta label must be present if cta link is present"
+
+        if self.end_date and self.start_date and self.end_date < self.start_date:
+            errors["end_date"] = "End date must be after start date"
+
+        if errors:
+            raise ValidationError(errors)
+
+        return super().clean()
+
+    class Meta:
+        constraints = [
+            models.CheckConstraint(
+                name="cta_label_requirement",
+                check=models.Q(cta_link="")
+                | (~models.Q(cta_link="") & ~models.Q(cta_label="")),
+            ),
+            models.CheckConstraint(
+                name="end_date_gte_to_start_date",
+                check=models.Q(end_date__gte=models.F("start_date")),
+            ),
+        ]

core/models/post.py

@@ -330,7 +330,7 @@ class Meta:
         constraints = [
             models.CheckConstraint(
                 name="organization_or_organization_string_required",
-                check=models.Q(organization__isnull=False)
+                condition=models.Q(organization__isnull=False)
                 | models.Q(organization_string__isnull=False),
             )
         ]

metropolis/local_settings_sample.py

@@ -35,24 +35,6 @@
         "application/javascript", ".js", True
     )  # fix some browser issues.
 
-# Banner config
-now = datetime.now(TZ)
-# BANNER_REFERENCE_TIME =  datetime.strptime("2023-11-14", "%Y-%m-%d").replace(tzinfo=timezone.utc)  # use instead of $now for non-relative banners.
-
-BANNER3 += [
-    dict(
-        start=now,  # when to start displaying the banner
-        end=now + timedelta(days=5),
-        # when to stop displaying the banner (e.g. 5 days after start)
-        content="Hello Hey!",  # banner text
-        icon_url="/static/core/img/logo/logo-maskable-192.png",
-        # optionally, displays an icon on the left of the banner
-        cta_link="https://jasoncameron.dev",  # optional
-        cta_label="wow! go visit this cool site!",  # optional (but required if cta_link is present)
-    )
-]
-
-
 if not DEBUG:
     """
     Only used on production

metropolis/settings.py

@@ -1,6 +1,6 @@
 import logging
 import os
-from datetime import datetime, timedelta
+from datetime import timedelta
 from typing import Dict, Final, List, Literal
 
 import pytz
@@ -531,16 +531,6 @@
 
 MAINTENANCE_MODE: Literal["", False, "pre", "post", "in"] = ""
 PRE = ""
-BANNER3: List = [
-    #   dict(
-    #       start=BANNER_REFERENCE_TIME,
-    #       end=BANNER_REFERENCE_TIME + timedelta(days=5),
-    #       content="This is some banner :)",
-    #       icon_url="...", # optional
-    #       cta_link="https://nyiyui.ca", # optional
-    #       cta_label="some shameless plug to nowhere amirite", # optional (but required if cta_link is present)
-    #   ),
-]
 
 CELERY_TIMEZONE = "America/Toronto"
 
@@ -553,22 +543,6 @@
 NOTIF_DRY_RUN = True
 NOTIFICATIONS_ENABLED = False
 
-
-def is_aware(d: datetime) -> bool:
-    return d.tzinfo is not None and d.tzinfo.utcoffset(d) is not None
-
-
-def check_banner3(banner: Dict) -> None:
-    assert is_aware(banner["start"])
-    assert is_aware(banner["end"])
-    assert bool(banner.get("cta_link")) == bool(
-        banner.get("cta_label")
-    )  # both or neither, not one or the other
-
-
-for banner in BANNER3:
-    check_banner3(banner)
-
 try:
     with open(os.path.join(os.path.dirname(__file__), "./local_settings.py")) as f:
         exec(f.read(), globals())