fix: qr code display and mechanics

Author: TigerCodeHub

intranet/apps/dashboard/views.py

@@ -93,6 +93,18 @@ def gen_schedule(user, num_blocks: int = 6, surrounding_blocks: Iterable[EighthB
             # don't duplicate this info; already caught
             current_signup = current_signup.replace(" (Cancelled)", "")
 
+        # check if attendance open, if so, will display attendance button
+        attendance_open = False
+        if current_sched_act:
+            from ..eighth.views.attendance import (
+                check_attendance_open,  # avoid circular import, since attendance imports gen_sponsor_schedule from here
+            )
+
+            attendance_open = check_attendance_open(current_sched_act) is None
+        sch_act_id = None
+        if attendance_open:
+            sch_act_id = current_sched_act.id
+
         info = {
             "id": b.id,
             "block": b,
@@ -107,6 +119,8 @@ def gen_schedule(user, num_blocks: int = 6, surrounding_blocks: Iterable[EighthB
             "signup_time": b.signup_time,
             "signup_time_future": b.signup_time_future(),
             "rooms": rooms,
+            "attendance_open": attendance_open,
+            "sch_act_id": sch_act_id,
         }
         schedule.append(info)
 

intranet/apps/eighth/migrations/0072_auto_20250429_1128.py renamed to intranet/apps/eighth/migrations/0072_eighth_attendance_code.py

@@ -1843,7 +1843,7 @@ def accept_pass(self):
         self.was_absent = False
         self.pass_accepted = True
         self.attendance_marked = True
-        self.save(update_fields=["was_absent", "pass_accepted"])
+        self.save(update_fields=["was_absent", "pass_accepted", "attendance_marked"])
 
     def reject_pass(self):
         """Rejects an eighth period pass for the EighthSignup object."""

intranet/apps/eighth/models.py

@@ -10,6 +10,7 @@
 from rest_framework.reverse import reverse
 
 from .models import EighthActivity, EighthBlock, EighthScheduledActivity, EighthSignup, EighthSponsor
+from .views.attendance import check_attendance_open
 
 logger = logging.getLogger(__name__)
 
@@ -139,6 +140,8 @@ def process_scheduled_activity(
             "name_with_flags_for_user": name_with_flags_for_user,
             "description": activity.description,
             "cancelled": scheduled_activity.cancelled,
+            "attendance_open": check_attendance_open(scheduled_activity) is None,
+            "attendance_url": reverse("student_attendance", args=[scheduled_activity.id]),
             "favorited": activity.id in favorited_activities,
             "subscribed_to": activity.id in subscribed_activities,
             "subscriptions_enabled": subscriptions_enabled,

intranet/apps/eighth/serializers.py

@@ -20,8 +20,7 @@
     re_path(r"^/absences$", attendance.eighth_absences_view, name="eighth_absences"),
     re_path(r"^/absences/(?P<user_id>\d+)$", attendance.eighth_absences_view, name="eighth_absences"),
     re_path(r"^/glance$", signup.eighth_location, name="eighth_location"),
-    re_path(r"^/student_attendance$", attendance.student_attendance_view, name="student_attendance"),
-    re_path(r"^/qr/(?P<act_id>\w+)/(?P<code>\w+)$", attendance.qr_attendance_view, name="qr_attendance"),
+    re_path(r"^/student_attendance/(?P<sch_act_id>\d+)(?:/(?P<code>[A-Za-z0-9]+))?$", attendance.student_attendance_view, name="student_attendance"),
     # Teachers
     re_path(r"^/attendance$", attendance.teacher_choose_scheduled_activity_view, name="eighth_attendance_choose_scheduled_activity"),
     re_path(r"^/attendance/(?P<scheduled_activity_id>\d+)$", attendance.take_attendance_view, name="eighth_take_attendance"),

intranet/apps/eighth/urls.py

@@ -23,17 +23,17 @@
 from reportlab.lib.units import inch
 from reportlab.platypus import PageBreak, Paragraph, SimpleDocTemplate, Spacer, Table, TableStyle
 
+from ....settings.__init__ import ATTENDANCE_CODE_BUFFER
 from ....utils.date import get_date_range_this_year
 from ...auth.decorators import attendance_taker_required, deny_restricted, eighth_admin_required
 from ...dashboard.views import gen_sponsor_schedule
-from ...schedule.models import Day
+from ...schedule.models import Block, Day, shift_time
 from ...schedule.views import decode_date
 from ..forms.admin.activities import ActivitySelectionForm
 from ..forms.admin.blocks import BlockSelectionForm
 from ..models import EighthActivity, EighthBlock, EighthScheduledActivity, EighthSignup, EighthSponsor, EighthWaitlist
 from ..tasks import email_scheduled_activity_students_task
 from ..utils import get_start_date
-from .signup import shift_time
 
 logger = logging.getLogger(__name__)
 
@@ -290,6 +290,11 @@ def take_attendance_view(request, scheduled_activity_id):
             scheduled_activity.save()
             invalidate_obj(scheduled_activity)
 
+            for signup in EighthSignup.objects.filter(scheduled_activity=scheduled_activity):
+                signup.attendance_marked = False
+                signup.save()
+                invalidate_obj(signup)
+
             messages.success(request, f"Attendance bit cleared for {scheduled_activity}")
 
             redirect_url = reverse(url_name, args=[scheduled_activity.id])
@@ -420,6 +425,21 @@ def take_attendance_view(request, scheduled_activity_id):
 
         members.sort(key=lambda m: m["name"])
 
+        auto_time_string = ""
+        try:
+            day_block = (
+                Day.objects.select_related("day_type")
+                .get(date=scheduled_activity.block.date)
+                .day_type.blocks.get(name="8" + scheduled_activity.block.block_letter)
+            )
+            start_time = shift_time(tm(hour=day_block.start.hour, minute=day_block.start.minute), -ATTENDANCE_CODE_BUFFER)
+            end_time = shift_time(tm(hour=day_block.end.hour, minute=day_block.end.minute), ATTENDANCE_CODE_BUFFER)
+            auto_time_string = f"({start_time.strftime('%-I:%M')} - {end_time.strftime('%-I:%M %p')})"
+        except Day.DoesNotExist:
+            auto_time_string = ""
+        except Block.DoesNotExist:
+            auto_time_string = ""
+        print(auto_time_string)
         context = {
             "scheduled_activity": scheduled_activity,
             "passes": passes,
@@ -430,7 +450,8 @@ def take_attendance_view(request, scheduled_activity_id):
             "show_checkboxes": (scheduled_activity.block.locked or request.user.is_eighth_admin),
             "show_icons": (scheduled_activity.block.locked and scheduled_activity.block.attendance_locked() and not request.user.is_eighth_admin),
             "bbcu_script": settings.BBCU_SCRIPT,
-            "qr_url": request.build_absolute_uri(reverse("qr_attendance", args=[scheduled_activity.id, scheduled_activity.attendance_code])),
+            "qr_url": request.build_absolute_uri(reverse("student_attendance", args=[scheduled_activity.id, scheduled_activity.attendance_code])),
+            "auto_time_string": auto_time_string,
         }
 
         if request.user.is_eighth_admin:
@@ -776,143 +797,123 @@ def email_students_view(request, scheduled_activity_id):
 
 @login_required
 @deny_restricted
-def student_attendance_view(request):
-    blocks = EighthBlock.objects.get_blocks_today()
-    mark_block = None
-    mark_result = None
-    if request.method == "POST":
-        now = timezone.localtime()
-        try:
-            day_blocks = Day.objects.select_related("day_type").get(date=now).day_type.blocks
-        except Day.DoesNotExist:
-            messages.error(request, "Error. Attendance is only available on school days.")
-            return redirect("index")
-        for block in blocks:
-            block_letter = block.block_letter
-            code = request.POST.get(block_letter)
-            if code is None:
-                continue
-            act = request.user.eighthscheduledactivity_set.get(block=block)
-            if act.get_code_mode_display() == "Auto":
-                try:
-                    day_block = day_blocks.get(name="8" + block_letter)
-                except Exception:
-                    mark_result = "invalid_time"
-                    mark_block = block
-                    break
-                start_time = shift_time(tm(hour=day_block.start.hour, minute=day_block.start.minute), -20)
-                end_time = shift_time(tm(hour=day_block.end.hour, minute=day_block.end.minute), 20)
-                if not start_time <= now.time() <= end_time:
-                    mark_result = "invalid_time"
-                    mark_block = block
-                    break
-            elif act.get_code_mode_display() == "Closed":
-                mark_result = "code_closed"
-                mark_block = block
-                break
-            code = code.upper()
-            if code == act.attendance_code:
-                try:
-                    present = EighthSignup.objects.get(scheduled_activity=act, user__in=[request.user.id])
-                    present.was_absent = False
-                    present.attendance_marked = True
-                    present.save()
-                    invalidate_obj(present)
-                    act.attendance_taken = True
-                    act.save()
-                    invalidate_obj(act)
-                    mark_result = "code_correct"
-                    mark_block = block
-                except Exception:
-                    mark_result = "code_fail"
-                    mark_block = block
-                break
-            else:
-                mark_result = "code_fail"
-                mark_block = block
-                break
-    return student_frontend(request, mark_block, mark_result)
-
+def student_attendance_view(request, sch_act_id, code=None):
+    """Handles the initial steps for code or QR code student-based attendance
+    Args:
+        request: the user's request
+        sch_act_id: the id of the EighthScheduledActivity for which the user attempts to take attendance. It is from url, required.
+        code: the code which the user is attempting to take attendance. From url, optional (if the user just wants to access the page)
+    Returns:
+        An HttpResponse rendering the student attendance page for the specified EighthScheduledActivity (if it exists).
+        Otherwise, redirects to index / dashboard.
+    """
+    result = None  # could end as None (no attendance attempt), no_signup, no_school, invalid_time, code_closed, code_fail, or marked
+    try:
+        sch_act = EighthScheduledActivity.objects.get(id=sch_act_id)
+    except EighthScheduledActivity.DoesNotExist:
+        messages.error(request, "Error marking attendance.")
+        return redirect("index")
 
-@login_required
-@deny_restricted
-def student_frontend(request, mark_block: EighthBlock = None, mark_result: str = None):
-    blocks = EighthBlock.objects.get_blocks_today()
-    if blocks:
-        sch_acts = []
-        att_marked = []
-        for block in blocks:
-            try:
-                act = request.user.eighthscheduledactivity_set.get(block=block)
-                if act.activity.name != "z - Hybrid Sticky":
-                    sch_acts.append(
-                        [block, act, ", ".join([r.name for r in act.get_true_rooms()]), ", ".join([s.name for s in act.get_true_sponsors()])]
-                    )
-                signup = EighthSignup.objects.get(user=request.user, scheduled_activity=act)
-                if (not signup.was_absent) and signup.attendance_marked and act.attendance_taken:
-                    att_marked.append(block)
-            except EighthScheduledActivity.DoesNotExist:
-                sch_acts.append([block, None])
-        results = {
-            "code_correct": "",
-            "code_closed": '<p style="color: red;">Error. Ask your teacher to open the attendance code.</p>',
-            "code_fail": '<p style="color: red;">Invalid Code.</p>',
-            "invalid_time": f'<p style="color: red;">Invalid time. Please fill this out during {block.block_letter} block.</p>',
-        }
-        response = render(
-            request,
-            "eighth/student_submit_attendance.html",
-            context={"sch_acts": sch_acts, "att_marked": att_marked, "mark_block": mark_block, "attendance_result": results.get(mark_result)},
-        )
+    try:
+        user_signup = EighthSignup.objects.get(user=request.user, scheduled_activity=sch_act)
+        if user_signup.attendance_marked and not user_signup.was_absent:
+            return student_frontend(request, sch_act_id, result="marked")
+    except EighthSignup.DoesNotExist:
+        result = "no_signup"
+        return student_frontend(request, sch_act_id, result)
+
+    is_open = check_attendance_open(sch_act)  # returns None if attendance is open, error string if closed
+    if is_open is None:
+        if code is not None:
+            result = mark_attendance(request, sch_act, code)
     else:
-        messages.error(request, "There are no eighth period blocks scheduled today.")
-        response = redirect("index")
-    return response
+        result = is_open
+
+    return student_frontend(request, sch_act_id, result)
 
 
 @login_required
 @deny_restricted
-def qr_attendance_view(request, act_id, code):
-    act = get_object_or_404(EighthScheduledActivity, id=act_id)
-    error = False
+def student_frontend(request, sch_act_id, result):
+    """Handles the process of rendering the frontend UI for student-based attendance.
+    It is only called by the student_attendance_view function
+    Args:
+        request: the user's request
+        sch_act_id: the EighthScheduledActivity for which the user attempts to take attendance
+        result: The result of the student's attempt to take attendance (if there was an attempt)
+    Returns:
+        An HttpResponse which renders the UI with a corresponding message. Returns this to student_attendance_view.
+    """
+
+    result_to_html = {
+        None: "",
+        "no_signup": '<p style="color: red;">Error: You are not signed up for this activity.</p>',
+        "no_school": '<p style="color: red;">Error: Attendance is only available on school days.</p>',
+        "invalid_time": '<p style="color: red;">Error: Please fill out attendance during the timeframe of this activity.</p>',
+        "code_closed": '<p style="color: red;">Error: Your activity sponsor has closed the attendance code.</p>',
+        "code_fail": '<p style="color: red;">Error: Invalid Code.</p>',
+        "marked": '<p style="color: green;">Attendance marked.</p>',
+    }
+    html_text = result_to_html[result]
+    sch_act = EighthScheduledActivity.objects.get(id=sch_act_id)
+    date_string = sch_act.block.date.strftime("%b %d")
+    show_form = result in (None, "code_fail")
+    return render(
+        request,
+        "eighth/student_submit_attendance.html",
+        context={"result": result, "result_html": html_text, "show_form": show_form, "sch_act": sch_act, "date_string": date_string},
+    )
+
+
+def mark_attendance(request, act, code):
+    """Handles the process of checking the code and marking attendance for the user.
+    Args:
+        request: the user's request
+        act: the EighthScheduledActivity for which the user attempts to take attendance
+        code: the code which the user is attempting to take attendance
+    Returns:
+        A string reporting the result of the attempt. Either "code_correct" or "code_fail"
+    """
+    if code.upper() == act.attendance_code:
+        try:
+            present = EighthSignup.objects.get(scheduled_activity=act, user__in=[request.user.id])
+            present.was_absent = False
+            present.attendance_marked = True
+            present.save()
+            invalidate_obj(present)
+            act.attendance_taken = True
+            act.save()
+            invalidate_obj(act)
+            return "marked"
+        except EighthSignup.DoesNotExist:
+            return "code_fail"
+    return "code_fail"
+
+
+def check_attendance_open(act: EighthScheduledActivity):
+    """Checks whether attendance is open for an EighthScheduledActivity.
+    Args:
+        act: the EighthScheduledActivity in question
+        day_blocks: the set of Block objects in the current day's day_type (defined in student_attendance_view)
+    Returns:
+        mark_result: a string, either "no_school", "invalid_time" or "code_closed", or None if attendance is open.
+    """
     block = act.block
     mark_result = None
     if act.get_code_mode_display() == "Auto":
         now = timezone.localtime()
-        day_blocks = Day.objects.select_related("day_type").get(date=now).day_type.blocks
+        try:
+            day_blocks = Day.objects.select_related("day_type").get(date=now).day_type.blocks
+        except Day.DoesNotExist:
+            return "no_school"
         try:
             day_block = day_blocks.get(name="8" + block.block_letter)
-            start_time = shift_time(tm(hour=day_block.start.hour, minute=day_block.start.minute), -20)
-            end_time = shift_time(tm(hour=day_block.end.hour, minute=day_block.end.minute), 20)
-            if not start_time <= now.time() <= end_time:
-                mark_result = "invalid_time"
-                error = True
-        except Exception:
+        except Block.DoesNotExist:
+            mark_result = "invalid_time"
+        start_time = shift_time(tm(hour=day_block.start.hour, minute=day_block.start.minute), -ATTENDANCE_CODE_BUFFER)
+        end_time = shift_time(tm(hour=day_block.end.hour, minute=day_block.end.minute), ATTENDANCE_CODE_BUFFER)
+        if not start_time <= timezone.localtime().time() <= end_time:
             mark_result = "invalid_time"
-            error = True
     elif act.get_code_mode_display() == "Closed":
         mark_result = "code_closed"
-        error = True
-    if not error:
-        code = code.upper()
-        if code == act.attendance_code:
-            try:
-                present = EighthSignup.objects.get(scheduled_activity=act, user__in=[request.user.id])
-                present.was_absent = False
-                present.attendance_marked = True
-                present.save()
-                invalidate_obj(present)
-                act.attendance_taken = True
-                act.save()
-                invalidate_obj(act)
-                mark_result = "code_correct"
-                messages.success(request, "Attendance marked.")
-            except Exception:
-                mark_result = "code_fail"
-                messages.error(request, "Failed to mark attendance.")
-        else:
-            mark_result = "code_fail"
-            messages.error(request, "Failed to mark attendance.")
-    else:
-        messages.error(request, "Failed to mark attendance.")
-    return student_frontend(request, block, mark_result)
+    return mark_result