Finalized backend for bookable office hours

Author: dkwncho

backend/ohq/migrations/0026_merge_20250126_1914.py

@@ -0,0 +1,13 @@
+# Generated by Django 5.0.3 on 2025-01-26 19:14
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("ohq", "0021_queue_question_timer_enabled_and_more"),
+        ("ohq", "0025_alter_booking_unique_together"),
+    ]
+
+    operations = []

backend/ohq/models.py

@@ -4,7 +4,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 schedule.models import Event
+from django.urls import reverse
+from datetime import timedelta
 
 User = settings.AUTH_USER_MODEL
 
@@ -447,13 +449,168 @@ class Meta:
 
     def __str__(self):
         return f"{self.user}: {self.metric}"
+    
+class Occurrence(models.Model):
+    event = models.ForeignKey(Event, on_delete=models.CASCADE, verbose_name=("event"), related_name="occurrences")
+    title = models.CharField(("title"), max_length=255, blank=True)
+    location = models.CharField(("location"), max_length=255, blank=True)
+    description = models.TextField(("description"), blank=True)
+    start = models.DateTimeField(("start"), db_index=True)
+    end = models.DateTimeField(("end"), db_index=True)
+    cancelled = models.BooleanField(("cancelled"), default=False)
+    original_start = models.DateTimeField(("original start"))
+    original_end = models.DateTimeField(("original end"))
+    created_on = models.DateTimeField(("created on"), auto_now_add=True)
+    updated_on = models.DateTimeField(("updated on"), auto_now=True)
+    interval = models.IntegerField(("interval"), blank=True, validators=[MinValueValidator(5), MaxValueValidator(60)])
+
+    class Meta:
+        verbose_name = ("occurrence")
+        verbose_name_plural = ("occurrences")
+        index_together = (("start", "end"),)
+
+    def __init__(self, *args, **kwargs):
+        super().__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
+
+    def save(self, *args, **kwargs):
+        super().save(*args, **kwargs)
+
+        if self.pk: # If save is called on object update, not creation
+            self.bookings.all().delete()
+
+        delta = self.end - self.start
+        delta_minutes = delta.total_seconds() / 60
+        booking_count = int(delta_minutes // self.interval)
+        for i in range(booking_count):
+            booking_start = self.start + timedelta(minutes=i * self.interval)
+            booking_end = booking_start + timedelta(minutes=self.interval)
+            Booking.objects.create(
+                occurrence=self,
+                user=None,
+                start=booking_start,
+                end = booking_end,
+            )
+
+    def moved(self):
+        return self.original_start != self.start or self.original_end != self.end
+
+    moved = property(moved)
+
+    def move(self, new_start, new_end):
+        self.start = new_start
+        self.end = new_end
+        self.save()
+
+    def cancel(self):
+        self.cancelled = True
+        self.save()
+
+    def uncancel(self):
+        self.cancelled = False
+        self.save()
+
+    @property
+    def seconds(self):
+        return (self.end - self.start).total_seconds()
+
+    @property
+    def minutes(self):
+        return float(self.seconds) / 60
+
+    @property
+    def hours(self):
+        return float(self.seconds) / 3600
+
+    def get_absolute_url(self):
+        if self.pk is not None:
+            return reverse(
+                "occurrence",
+                kwargs={"occurrence_id": self.pk, "event_id": self.event_id},
+            )
+        return reverse(
+            "occurrence_by_date",
+            kwargs={
+                "event_id": self.event_id,
+                "year": self.start.year,
+                "month": self.start.month,
+                "day": self.start.day,
+                "hour": self.start.hour,
+                "minute": self.start.minute,
+                "second": self.start.second,
+            },
+        )
+
+    def get_cancel_url(self):
+        if self.pk is not None:
+            return reverse(
+                "cancel_occurrence",
+                kwargs={"occurrence_id": self.pk, "event_id": self.event_id},
+            )
+        return reverse(
+            "cancel_occurrence_by_date",
+            kwargs={
+                "event_id": self.event_id,
+                "year": self.start.year,
+                "month": self.start.month,
+                "day": self.start.day,
+                "hour": self.start.hour,
+                "minute": self.start.minute,
+                "second": self.start.second,
+            },
+        )
+
+    def get_edit_url(self):
+        if self.pk is not None:
+            return reverse(
+                "edit_occurrence",
+                kwargs={"occurrence_id": self.pk, "event_id": self.event_id},
+            )
+        return reverse(
+            "edit_occurrence_by_date",
+            kwargs={
+                "event_id": self.event_id,
+                "year": self.start.year,
+                "month": self.start.month,
+                "day": self.start.day,
+                "hour": self.start.hour,
+                "minute": self.start.minute,
+                "second": self.start.second,
+            },
+        )
+
+    def __str__(self):
+        start_str = self.start.strftime("%Y-%m-%d %H:%M:%S")
+        end_str = self.end.strftime("%Y-%m-%d %H:%M:%S")
+        return f"{start_str} to {end_str}"
+
+    def __lt__(self, other):
+        return self.end < other.end
+
+    def __hash__(self):
+        if not self.pk:
+            raise TypeError("Model instances without primary key value are unhashable")
+        return hash(self.pk)
+
+    def __eq__(self, other):
+        return (
+            isinstance(other, Occurrence)
+            and self.original_start == other.original_start
+            and self.original_end == other.original_end
+        )
 
 class Booking(models.Model):
     """
     Booking within an occurrence
     """
 
-    occurrence = models.ForeignKey(Occurrence, on_delete=models.CASCADE)
+    occurrence = models.ForeignKey(Occurrence, on_delete=models.CASCADE, related_name="bookings")
     user = models.ForeignKey(User, on_delete=models.CASCADE, blank=True, null=True)
     start = models.DateTimeField("start", db_index=True)
     end = models.DateTimeField("end", db_index=True)

backend/ohq/permissions.py

@@ -1,9 +1,13 @@
 from django.db.models import Q
 from rest_framework import permissions
-from schedule.models import Event, EventRelation, Occurrence
-
-from ohq.models import Course, Membership, Question, Booking
-
+from schedule.models import Event, EventRelation
+from ohq.models import (
+    Course, 
+    Membership, 
+    Question, 
+    Occurrence, 
+    Booking,
+)
 
 # Hierarchy of permissions is usually:
 # Professor > Head TA > TA > Student > User
@@ -543,27 +547,11 @@ def has_object_permission(self, request, view, obj):
     def has_permission(self, request, view):
         if not request.user.is_authenticated:
             return False
-
-        # Anonymous users can't do anything
-        if view.action in ["create"]:
-            course_pk = request.data.get("course_id", None)
-            if course_pk is None:
-                return False
-
-            course = Course.objects.get(pk=course_pk)
-            membership = Membership.objects.filter(course=course, user=request.user).first()
-
-            if membership is None:
-                return False
-            return membership.is_ta
-
+    
         if view.action in ["list"]:
-            # if any member of the course in the list is not accessible, return false
-            course_ids = request.GET.getlist("course")
-            for course in course_ids:
-                membership = Membership.objects.filter(course=course, user=request.user).first()
-                if membership is None:
-                    return False
-            return True
+            occurrence_id = request.GET.get("occurrence")
+            occurrence = Occurrence.objects.filter(id=occurrence_id).first()
+            membership = self.get_membership_from_event(request, occurrence.event)
+            return membership is not None
 
         return True

backend/ohq/serializers.py

@@ -8,7 +8,6 @@
 from rest_framework import serializers
 from rest_live.signals import save_handler
 from schedule.models import Calendar, Event, EventRelation, EventRelationManager, Rule
-from schedule.models.events import Occurrence
 
 from ohq.models import (
     Announcement,
@@ -22,6 +21,7 @@
     QueueStatistic,
     Semester,
     Tag,
+    Occurrence,
     Booking,
 )
 from ohq.sms import sendSMSVerification

backend/ohq/views.py

@@ -775,38 +775,13 @@ def list(self, request, *args, **kwargs):
 
         serializer = OccurrenceSerializer(occurrences, many=True)
         return JsonResponse(serializer.data, safe=False)
-    
-    def update(self, request, *args, **kwargs):
-        occurrence = self.get_object()
-        old_start = occurrence.start
-        old_end = occurrence.end
-        occurrence.start = datetime.strptime(request.data.get("start"), "%Y-%m-%dT%H:%M:%SZ").replace(
-            tzinfo=utc
-        )
-        occurrence.end = datetime.strptime(request.data.get("end"), "%Y-%m-%dT%H:%M:%SZ").replace(
-            tzinfo=utc
-        )
-        start_delta = occurrence.start - old_start
-        end_delta = occurrence.end - old_end
-        occurrence.save()
-
-        bookings = Booking.objects.filter(occurrence=occurrence).order_by("start")
-
-        for booking in bookings:
-            booking.start += start_delta
-            booking.end += end_delta
-            booking.save()
-
-        serializer = OccurrenceSerializer(occurrence)
-        return JsonResponse(serializer.data, safe=False)
 
     def get_queryset(self):
         return Occurrence.objects.filter(pk=self.kwargs["pk"])
 
 class BookingViewSet(
     mixins.ListModelMixin,
     mixins.RetrieveModelMixin,
-    mixins.CreateModelMixin,
     mixins.UpdateModelMixin,
     viewsets.GenericViewSet,
 ):
@@ -818,10 +793,6 @@ class BookingViewSet(
     You should pass in an occurrence id, and all the bookings related to that occurrence will be returned to you.
     Return a list of bookings.
 
-    create:
-    Create a booking.
-    occurrenceId is required in body.
-
     update:
     Update all fields in a Booking.
     You must specify all of the fields or use a patch request.
@@ -832,46 +803,36 @@ class BookingViewSet(
 
     serializer_class = BookingSerializer
     permission_classes = [BookingPermission | IsSuperuser]
-
-    def create(self, request, *args, **kwargs):        
-        occurrence_id = request.data.get("occurrence")
-        occurrence = Occurrence.objects.get(id=occurrence_id) 
-        user = request.user
-        existing_bookings = Booking.objects.filter(occurrence=occurrence).order_by("start")
-
-        if existing_bookings.exists():
-            last_booking = existing_bookings.last()
-            start = last_booking.end
-        else:
-            start = occurrence.start
-        
-        end = start + occurrence.interval
-
-        if start < occurrence.start or end > occurrence.end:
-            raise ValidationError(_("Booking times must be within the occurrence's time range."))
-
-        booking = Booking(
-            occurrence=occurrence,
-            user=user,
-            start=start,
-            end=end,
-        )
-
-        booking.save()
-
-        serializer = BookingSerializer(booking)
-        return JsonResponse(serializer.data, safe=False)
 
     def list(self,request, *args, **kwargs):
         occurrence_id = request.GET.get("occurrence")
         if occurrence_id is None:
-            raise ValidationError(_(f"Occurrence id is required."))
-        
-        occurrence = Occurrence.objects.get(id=occurrence_id) 
+            raise ValidationError((f"Occurrence id is required."))
+    
+        try:
+            occurrence = Occurrence.objects.filter(id=occurrence_id).first()
+        except Occurrence.DoesNotExist:
+            return JsonResponse({"detail": "Occurrence not found."}, status=404)
+
         existing_bookings = Booking.objects.filter(occurrence=occurrence).order_by("start")
 
         serializer = BookingSerializer(existing_bookings, many=True)
         return JsonResponse(serializer.data, safe=False)
 
+    def update(self, request, *args, **kwargs):
+        partial = kwargs.pop('partial', False)
+        instance = self.get_object()
+        serializer = self.get_serializer(instance, data=request.data, partial=partial)
+        serializer.is_valid(raise_exception=True)
+        self.perform_update(serializer)
+
+        # Only the user field should be able to update
+        user = self.request.user
+        # Based on BookingPermission, you technically shouldn't be allowed to override another student if you're a student
+        self.user = user 
+
+        return JsonResponse(serializer.data, safe=False)
+        
+
     def get_queryset(self):
         return Booking.objects.filter(pk=self.kwargs["pk"])