Move django-scheduler package into our codebase as ohq_schedule

- Currently, may still contain excess files that are never used
- Migrate existing data from schedule tables to ohq_schedule tables

Author: dkwncho

backend/officehoursqueue/settings/base.py

@@ -50,7 +50,8 @@
     "email_tools.apps.EmailToolsConfig",
     "accounts.apps.AccountsConfig",
     "ohq.apps.OhqConfig",
-    "schedule",
+    "ohq_schedule.apps.OHQScheduleConfig",
+    "schedule"
 ]
 
 MIDDLEWARE = [

backend/ohq/migrations/0022_booking.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.0.3 on 2025-03-30 19:21
+# Generated by Django 5.0.3 on 2025-04-12 03:39
 
 import django.db.models.deletion
 from django.conf import settings
@@ -9,8 +9,7 @@ class Migration(migrations.Migration):
 
     dependencies = [
         ("ohq", "0021_queue_question_timer_enabled_and_more"),
-        ("schedule", "0031_occurrence_location"),
-        ("schedule", "0037_occurrence_interval"),
+        ("ohq_schedule", "0015_event_bookable_event_interval_event_location_and_more"),
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
@@ -21,10 +20,7 @@ class Migration(migrations.Migration):
                 (
                     "id",
                     models.AutoField(
-                        auto_created=True,
-                        primary_key=True,
-                        serialize=False,
-                        verbose_name="ID",
+                        auto_created=True, primary_key=True, serialize=False, verbose_name="ID"
                     ),
                 ),
                 ("start", models.DateTimeField(db_index=True, verbose_name="start")),
@@ -34,7 +30,7 @@ class Migration(migrations.Migration):
                     models.ForeignKey(
                         on_delete=django.db.models.deletion.CASCADE,
                         related_name="bookings",
-                        to="schedule.occurrence",
+                        to="ohq_schedule.occurrence",
                     ),
                 ),
                 (

backend/ohq/migrations/0023_migrate_schedule_data.py

@@ -0,0 +1,108 @@
+# Generated by Django 5.0.3 on 2025-04-13 15:24
+
+from django.db import migrations
+
+def migrate_schedule_data(apps, schema_editor):
+    OldCalendarRelation = apps.get_model('schedule', 'CalendarRelation')
+    OldCalendar = apps.get_model('schedule', 'Calendar')
+    OldEvent = apps.get_model('schedule', 'Event')
+    OldOccurrence = apps.get_model('schedule', 'Occurrence') 
+    OldRule = apps.get_model('schedule', 'Rule')
+    OldEventRelation = apps.get_model('schedule', 'EventRelation')
+
+    NewCalendarRelation = apps.get_model('ohq_schedule', 'CalendarRelation')
+    NewCalendar = apps.get_model('ohq_schedule', 'Calendar')
+    NewEvent = apps.get_model('ohq_schedule', 'Event')
+    NewOccurrence = apps.get_model('ohq_schedule', 'Occurrence')
+    NewRule = apps.get_model('ohq_schedule', 'Rule')
+    NewEventRelation = apps.get_model('ohq_schedule', 'EventRelation')
+
+    for old_calendar_relation in OldCalendarRelation.objects.all():
+        NewCalendarRelation.objects.create(
+            id=old_calendar_relation.id,
+            calendar_id=old_calendar_relation.calendar_id,
+            content_type_id=old_calendar_relation.content_type_id,
+            object_id=old_calendar_relation.object_id, 
+            distinction=old_calendar_relation.distinction,
+            inheritable=old_calendar_relation.inheritable
+        )
+
+    for old_calendar in OldCalendar.objects.all():
+        NewCalendar.objects.create(
+            id=old_calendar.id,
+            name=old_calendar.name,
+            slug=old_calendar.slug
+        )
+
+    for old_rule in OldRule.objects.all():
+        NewRule.objects.create(
+            id=old_rule.id,
+            name=old_rule.name,
+            description=old_rule.description,
+            frequency=old_rule.frequency,
+            params=old_rule.params
+        )
+
+    for old_event in OldEvent.objects.all():
+        NewEvent.objects.create(
+            id=old_event.id,
+            start=old_event.start,
+            end=old_event.end,
+            title=old_event.title,
+            description=old_event.description,
+            calendar_id=old_event.calendar_id,
+            rule_id=old_event.rule_id,
+            end_recurring_period=old_event.end_recurring_period,
+            location=old_event.location if hasattr(old_event, 'location') else '',
+            bookable=old_event.bookable if hasattr(old_event, 'bookable') else False,
+            interval=old_event.interval if hasattr(old_event, 'interval') else None
+        )
+
+    for old_occurrence in OldOccurrence.objects.all():
+        NewOccurrence.objects.create(
+            id=old_occurrence.id,
+            event_id=old_occurrence.event_id,
+            title=old_occurrence.title,
+            description=old_occurrence.description,
+            start=old_occurrence.start,
+            end=old_occurrence.end,
+            cancelled=old_occurrence.cancelled,
+            original_start=old_occurrence.original_start,
+            original_end=old_occurrence.original_end,
+            location=old_occurrence.location if hasattr(old_occurrence, 'location') else '',
+            interval=old_occurrence.interval if hasattr(old_occurrence, 'interval') else None
+        )
+
+    for old_relation in OldEventRelation.objects.all():
+        NewEventRelation.objects.create(
+            id=old_relation.id,
+            event_id=old_relation.event_id,
+            content_type_id=old_relation.content_type_id,
+            object_id=old_relation.object_id,
+            distinction=old_relation.distinction
+        )
+
+def reverse_migrate_schedule_data(apps, schema_editor):
+    NewCalendarRelation = apps.get_model('ohq_schedule', 'CalendarRelation')
+    NewCalendar = apps.get_model('ohq_schedule', 'Calendar')
+    NewEvent = apps.get_model('ohq_schedule', 'Event')
+    NewOccurrence = apps.get_model('ohq_schedule', 'Occurrence')
+    NewRule = apps.get_model('ohq_schedule', 'Rule')
+    NewEventRelation = apps.get_model('ohq_schedule', 'EventRelation')
+
+    NewCalendarRelation.objects.all().delete()
+    NewCalendar.objects.all().delete()
+    NewEvent.objects.all().delete()
+    NewOccurrence.objects.all().delete()
+    NewRule.objects.all().delete()
+    NewEventRelation.objects.all().delete()
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ('ohq', '0022_booking'),
+        ('schedule', '0001_initial'),
+        ('ohq_schedule', '0015_event_bookable_event_interval_event_location_and_more'), 
+    ]
+    operations = [
+        migrations.RunPython(migrate_schedule_data, reverse_migrate_schedule_data),
+    ]

backend/ohq/models.py

@@ -5,7 +5,9 @@
 from django.dispatch import receiver
 from email_tools.emails import send_email
 from phonenumber_field.modelfields import PhoneNumberField
-from schedule.models import Event, Occurrence
+from ohq_schedule.models import Event, Occurrence
+from schedule.models import Event as OldEvent
+from schedule.models import Occurrence as OldOccurrence
 
 User = settings.AUTH_USER_MODEL
 
@@ -501,18 +503,6 @@ def __str__(self):
         end_str = self.end.strftime("%Y-%m-%d %H:%M:%S")
         return f"{start_str} to {end_str}"
 
-Event.add_to_class('location', models.CharField(max_length=255, blank=True))
-Occurrence.add_to_class('location', models.CharField(max_length=255, blank=True))
-Occurrence.add_to_class('interval', models.IntegerField(blank=True, null=True))
-
-def new_occurrence_init(self, *args, **kwargs):
-    super(Occurrence, self).__init__(*args, **kwargs)
-    event = kwargs.get("event", None)
-    if not self.title and event:
-        self.title = event.title
-    if not self.description and event:
-        self.description = event.description
-    if not self.location and event:
-        self.location = event.location
-
-Occurrence.__init__ = new_occurrence_init
+OldEvent.add_to_class('location', models.CharField(max_length=255, blank=True))
+OldOccurrence.add_to_class('location', models.CharField(max_length=255, blank=True))
+OldOccurrence.add_to_class('interval', models.IntegerField(blank=True, null=True))

backend/ohq/permissions.py

@@ -1,6 +1,6 @@
 from django.db.models import Q
 from rest_framework import permissions
-from schedule.models import Event, EventRelation, Occurrence
+from ohq_schedule.models import Event, EventRelation, Occurrence
 from ohq.models import (
     Course, 
     Membership, 

backend/ohq/serializers.py

@@ -7,7 +7,7 @@
 from phonenumber_field.serializerfields import PhoneNumberField
 from rest_framework import serializers
 from rest_live.signals import save_handler
-from schedule.models import Calendar, Event, Occurrence, EventRelation, EventRelationManager, Rule
+from ohq_schedule.models import Calendar, Event, Occurrence, EventRelation, EventRelationManager, Rule
 
 from ohq.models import (
     Announcement,

backend/ohq/views.py

@@ -32,7 +32,7 @@
 from rest_framework.settings import api_settings
 from rest_framework.views import APIView
 from rest_live.mixins import RealtimeMixin
-from schedule.models import Event, EventRelationManager, Occurrence
+from ohq_schedule.models import Event, EventRelationManager, Occurrence
 from http import HTTPStatus
 
 from ohq.filters import CourseStatisticFilter, QuestionSearchFilter, QueueStatisticFilter

backend/ohq_schedule/__init__.py

@@ -0,0 +1,4 @@
+import django
+
+if django.VERSION < (3, 2):
+    default_app_config = "ohq_schedule.apps.OHQScheduleConfig"

backend/ohq_schedule/admin.py

@@ -0,0 +1,80 @@
+from django.contrib import admin
+
+from ohq_schedule.forms import EventAdminForm
+from ohq_schedule.models import (
+    Calendar,
+    CalendarRelation,
+    Event,
+    EventRelation,
+    Occurrence,
+    Rule,
+)
+
+@admin.register(Calendar)
+class CalendarAdmin(admin.ModelAdmin):
+    list_display = ("name", "slug")
+    prepopulated_fields = {"slug": ("name",)}
+    search_fields = ["name"]
+    fieldsets = ((None, {"fields": [("name", "slug")]}),)
+
+
+@admin.register(CalendarRelation)
+class CalendarRelationAdmin(admin.ModelAdmin):
+    list_display = ("calendar", "content_object")
+    list_filter = ("inheritable",)
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": [
+                    "calendar",
+                    ("content_type", "object_id", "distinction"),
+                    "inheritable",
+                ]
+            },
+        ),
+    )
+
+
+@admin.register(EventRelation)
+class EventRelationAdmin(admin.ModelAdmin):
+    list_display = ("event", "content_object", "distinction")
+    fieldsets = (
+        (None, {"fields": ["event", ("content_type", "object_id", "distinction")]}),
+    )
+
+
+@admin.register(Event)
+class EventAdmin(admin.ModelAdmin):
+    list_display = ("title", "start", "end")
+    list_filter = ("start",)
+    ordering = ("-start",)
+    date_hierarchy = "start"
+    search_fields = ("title", "description")
+    fieldsets = (
+        (
+            None,
+            {
+                "fields": [
+                    ("title", "color_event"),
+                    ("description",),
+                    ("start", "end"),
+                    ("creator", "calendar"),
+                    ("rule", "end_recurring_period"),
+                    "location", 
+                    ("interval", "bookable"),
+                ]
+            },
+        ),
+    )
+    form = EventAdminForm
+
+
+admin.site.register(Occurrence, admin.ModelAdmin)
+
+
+@admin.register(Rule)
+class RuleAdmin(admin.ModelAdmin):
+    list_display = ("name",)
+    list_filter = ("frequency",)
+    search_fields = ("name", "description")

backend/ohq_schedule/apps.py

@@ -0,0 +1,8 @@
+from django.apps import AppConfig
+from django.utils.translation import gettext_lazy as _
+
+
+class OHQScheduleConfig(AppConfig):
+    name = "ohq_schedule"
+    verbose_name = _("ohq_schedules")
+    default_auto_field = "django.db.models.AutoField"