Merge branch 'main' into SCRUM-31_change_pw

Author: MaxMB15

api/migrations/0006_alter_attendenceacknowledgement_attended_student_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.0.2 on 2024-03-17 14:53
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0005_remove_course_schedule'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='attendenceacknowledgement',
+            name='attended_student',
+            field=models.BooleanField(default=None, null=True),
+        ),
+        migrations.AlterField(
+            model_name='attendenceacknowledgement',
+            name='attended_teacher',
+            field=models.BooleanField(default=None, null=True),
+        ),
+    ]

api/models.py

@@ -74,7 +74,10 @@ def get_teachers(self):
         return [uc.user for uc in UserCourse.objects.filter(user__role=AccountRoles.TEACHER)]
 
     def get_lectures(self):
-        return [lecture for lecture in CourseLecture.objects.filter(course=self)]
+        return CourseLecture.objects.filter(course=self)
+
+    def get_lectures_week(self, year : int, week : int):
+        return CourseLecture.objects.filter(course=self, start_time__year=year, start_time__week=week)
 
     def is_user_enrolled(self, user : User):
         return bool(UserCourse.objects.filter(user=user, course=self))
@@ -99,13 +102,13 @@ class CourseLecture(models.Model):
         default=LectureTypes.LECTURE,
     )
 
-    def set_attendence_user(self, student : User, teacher=False):
+    def set_attendence_user(self, student : User, attended : bool, teacher=False):
         queryset = AttendenceAcknowledgement.objects.filter(lecture=self, student=student)
         if not queryset: ack = AttendenceAcknowledgement.objects.create(lecture=self, student=student)
         else: ack = queryset[0]
 
-        if teacher: ack.attended_teacher = True
-        else: ack.attended_student = True
+        if teacher: ack.attended_teacher = attended
+        else: ack.attended_student = attended
         ack.save()
 
     def get_attendence_user(self, student : User):
@@ -117,8 +120,8 @@ def get_attendence(self):
         return [] if not queryset else queryset[0]
 
 class AttendenceAcknowledgement(models.Model):
-    attended_student = models.BooleanField(default=False)
-    attended_teacher = models.BooleanField(default=False)
+    attended_student = models.BooleanField(default=None, null=True)
+    attended_teacher = models.BooleanField(default=None, null=True)
     student = models.ForeignKey(User, null=False, related_name='user_ack', on_delete=models.CASCADE)
     lecture = models.ForeignKey(CourseLecture, null=False, related_name='lecture_ack', on_delete=models.CASCADE)
 

api/serializers.py

@@ -123,19 +123,23 @@ def validate(self, attrs):
         return attrs
 
 class SetAttendenceTeacherSerializer(serializers.Serializer):
-    usernames = serializers.ListField(required=True, allow_empty=False, child=serializers.CharField(max_length=150))
+    usernames = serializers.DictField(required=True, allow_empty=False, child=
+                                        serializers.CharField(max_length=150)
+                                      )
 
-    def validate_attendence(self, username):
+    def validate_attendence(self, username, attended):
         user_query = User.objects.all().filter(username=username)
+        if (attended := attended.lower()) not in ["true", "false"]: raise serializers.ValidationError({"error": f"invalid attendence state: '{attended}'"})
         if not user_query: raise serializers.ValidationError({"error": f"user '{username}' does not exist"})
         if user_query[0].role != AccountRoles.STUDENT: raise serializers.ValidationError({"error": f"cannot set the attendence of a non-student: '{username}' is {user_query[0].role}"})
 
         course : Course = self.context.get("course")
         if not course.is_user_enrolled(user_query[0]): raise serializers.ValidationError({"error": f"user '{username}' is not enrolled in '{course.course_name}'"})
 
     def validate(self, attrs):
-        for username in attrs["usernames"]: self.validate_enroll(username)
+        for username, attended in attrs["usernames"].items(): self.validate_attendence(username, attended)
         return attrs
 
 class MailTestSerializer(serializers.Serializer):
-    email = serializers.CharField(required=True)
+    email = serializers.CharField(required=True)
+    

api/urls.py

@@ -27,6 +27,7 @@
                     SetTeacherAttView,
                     test,
                     MailTestView,
+                    UnsetStudentAttView,
                     genAdmin, 
 
                     GetTokenView, 
@@ -83,10 +84,11 @@
     # path('course/lecture/<pk>/delete', GetCourseByName.as_view(), name='lecture_add'),
 
     path('lecture/<pk>/get', GetLectureView.as_view(), name='lecture_get'),
-    path('lecture/<pk>/student_att', SetStudentAttView.as_view(), name='lecture_att_student'),
+    path('lecture/<pk>/student_set_att', SetStudentAttView.as_view(), name='lecture_set_att_student'),
+    path('lecture/<pk>/student_unset_att', UnsetStudentAttView.as_view(), name='lecture_unset_att_student'),
     path('lecture/<pk>/teacher_att', SetTeacherAttView.as_view(), name='lecture_att_teacher'),
 
-    path('schedule/get', GetScheduleView.as_view(), name='schedule_get'),
+    path('schedule/get/<year>/<week>', GetScheduleView.as_view(), name='schedule_get'),
 
     # Documentation
     path('schema/', SpectacularAPIView.as_view(), name='schema'),

api/views.py

@@ -1,5 +1,6 @@
 import datetime
 import os
+from typing import List
 from django.http import JsonResponse
 from django.contrib.auth import get_user_model
 
@@ -332,6 +333,15 @@ def get(self, _, pk):
         serializer = self.serializer_class(queryset[0])
         return Response(serializer.data, status=status.HTTP_200_OK)
 
+def setAttendence(self, request, attended):
+    if request.user.role != AccountRoles.STUDENT:
+        return Response({"error": f"cannot set the attendence of a non-student"}, status=status.HTTP_200_OK)
+        
+    lecture : CourseLecture = self.get_object()
+    lecture.set_attendence_user(request.user, attended=attended, teacher=False)
+    
+    return Response({"ok": f"successfully set attendence"}, status=status.HTTP_200_OK)
+    
 class SetStudentAttView(generics.GenericAPIView):
     authentication_classes = [JWTAuthentication]
     permission_classes = [IsStudent]
@@ -341,13 +351,19 @@ class SetStudentAttView(generics.GenericAPIView):
     serializer_class = CourseLecture
 
     def post(self, request, *args, **kwargs):
-        if request.user.role != AccountRoles.STUDENT:
-            return Response({"error": f"cannot set the attendence of a non-student"}, status=status.HTTP_200_OK)
-            
-        lecture : CourseLecture = self.get_object()
-        lecture.set_attendence_user(request.user, teacher=False)
+        return setAttendence(self, request, True)
 
-        return Response({"ok": f"successfully set attendence"}, status=status.HTTP_200_OK)
+class UnsetStudentAttView(generics.GenericAPIView):
+    authentication_classes = [JWTAuthentication]
+    permission_classes = [IsStudent]
+    lookup_field = 'pk'
+    
+    queryset = CourseLecture.objects.all()
+    serializer_class = CourseLecture
+    
+    def post(self, request, *args, **kwargs):
+        print(request.user)
+        return setAttendence(self, request, False)
 
 class SetTeacherAttView(generics.GenericAPIView):
     authentication_classes = [JWTAuthentication]
@@ -364,27 +380,34 @@ def post(self, request, *args, **kwargs):
 
         queryset = User.objects.all()
         usernames = result.data["usernames"]
-        for username in usernames:
+        for username, attended in usernames.items():
             user = queryset.filter(username=username)[0]
-            lecture.set_attendence_user(user, teacher=True)
+            lecture.set_attendence_user(user, attended=(attended=="true"), teacher=True)
 
         return Response({"ok": f"succesfully set attendence for {len(usernames)} students"}, status=status.HTTP_200_OK)
 
+    
 class GetScheduleView(generics.GenericAPIView):
     authentication_classes = [JWTAuthentication]
     permission_classes = [IsStudent]
 
-    def get(self, request, *args, **kwargs):
+    def get(self, request, year, week):
+        if not year.isdigit() or int(year) < 1970:
+            return Response({"error": f"invalid year parameter"}, status=status.HTTP_400_BAD_REQUEST)
+        if not week.isdigit() or int(week) < 0 or int(week) > 52:
+            return Response({"error": f"invalid week parameter"}, status=status.HTTP_400_BAD_REQUEST)
+            
         user = User.objects.all().filter(username=request.user.username)[0]
-        courses = user.get_enrolled_courses()
+        courses : List[Course] = user.get_enrolled_courses()
         all_lectures = []
-        for course in courses:
-            lectures_obj = course.get_lectures()
+        for course in courses: 
+            lectures_obj = course.get_lectures_week(int(year), int(week))
             lectures = LectureSerializer(lectures_obj, many=True)
             for i, lecture_obj in enumerate(lectures_obj):
                 att = lecture_obj.get_attendence_user(user)
-                lectures.data[i]["attended_student"] = att.attended_student if att is not None else False
-                lectures.data[i]["attended_teacher"] = att.attended_teacher if att is not None else False
+                lectures.data[i]["course_name"] = lecture_obj.course.course_name
+                lectures.data[i]["attended_student"] = att.attended_student if att is not None else None
+                lectures.data[i]["attended_teacher"] = att.attended_teacher if att is not None else None
             all_lectures += lectures.data
 
         # Sort chronological order