Merge pull request #602 from 508312/master

Bitbyte model. Bitbyte tree fix.

Author: 508312

hknweb/candidate/admin/__init__.py

@@ -1,4 +1,5 @@
 from hknweb.candidate.admin.announcement import AnnouncementAdmin
 from hknweb.candidate.admin.bitbyteactivity import BitByteActivityAdmin
+from hknweb.candidate.admin.bit_byte_group import BitByteGroupAdmin
 from hknweb.candidate.admin.officer_challenge import OffChallengeAdmin
 from hknweb.candidate.admin.logistics import LogisticsAdmin

hknweb/candidate/admin/bit_byte_group.py

@@ -0,0 +1,101 @@
+from django.contrib import admin, messages
+from django.shortcuts import render, redirect
+from django.urls import path
+from django.db import transaction
+from django.contrib.auth.models import User
+
+import io
+import csv
+from hknweb.coursesemester.models import Semester
+from hknweb.candidate.models import BitByteGroup
+from hknweb.forms import CsvImportForm
+
+
+@admin.register(BitByteGroup)
+class BitByteGroupAdmin(admin.ModelAdmin):
+    change_list_template = "admin/candidate/bitbyte_group_change_list.html"
+
+    fields = ["semester", "bytes", "bits"]
+    list_display = (
+        "semester",
+        "bytes_usernames",
+        "bits_usernames",
+    )
+    list_filter = ["semester"]
+    search_fields = [
+        "bytes__username",
+        "bytes__first_name",
+        "bytes__last_name",
+        "bits__username",
+        "bits__first_name",
+        "bits__last_name",
+    ]
+    autocomplete_fields = ["bytes", "bits"]
+
+    def bytes_usernames(self, obj):
+        return ", ".join([user.username for user in obj.bytes.all()])
+
+    def bits_usernames(self, obj):
+        return ", ".join([user.username for user in obj.bits.all()])
+
+    def get_urls(self):
+        urls = super().get_urls()
+        custom_urls = [
+            path("import-csv/", self.import_csv, name="import_csv"),
+        ]
+        return custom_urls + urls
+
+    # Refactor and move this outside of admin panel if this becomes front facing feature(i.e. you
+    # want evp creating bitbyte groups)
+    def import_csv(self, request):
+        # Helper function.
+        def _get_user_or_error(username):
+            user = User.objects.filter(username__iexact=username).first()
+            if not user:
+                raise ValueError(
+                    f"Error on trying to add '{username}'."
+                    f" Check if the username is correct."
+                )
+            return user
+
+        if request.method == "POST":
+            form = CsvImportForm(request.POST, request.FILES)
+            if form.is_valid():
+                csv_file = request.FILES["csv_file"]
+                data_set = csv_file.read().decode("UTF-8")
+                io_string = io.StringIO(data_set)
+                next(io_string)  # Skip header
+
+                try:
+                    # If an error happens we just don't do anything
+                    with transaction.atomic():
+                        count = 0
+                        for row in csv.reader(io_string, delimiter=";"):
+                            if not row or len(row) != 4:
+                                continue
+
+                            byte_usernames, bit_usernames, year, sem = [
+                                s.strip() for s in row
+                            ]
+
+                            semester_obj = Semester.objects.get(year=year, semester=sem)
+                            group = BitByteGroup.objects.create(semester=semester_obj)
+                            for byte in byte_usernames.split(","):
+                                byte_user = _get_user_or_error(byte)
+                                group.bytes.add(byte_user)
+
+                            for bit in bit_usernames.split(","):
+                                bit_user = _get_user_or_error(bit)
+                                group.bits.add(bit_user)
+
+                            count += 1
+                        self.message_user(
+                            request, f"Successfully imported {count} relationships."
+                        )
+                        return redirect("..")
+                except Exception as e:
+                    self.message_user(request, f"Error: {e}", level=messages.ERROR)
+
+        form = CsvImportForm()
+        payload = {"form": form}
+        return render(request, "admin/candidate/bitbyte_group_csv_upload.html", payload)

hknweb/candidate/migrations/0016_bitbytegroup.py

@@ -0,0 +1,56 @@
+# Generated by Django 4.2.17 on 2026-02-10 18:16
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ("coursesemester", "0002_auto_20210202_0225"),
+        ("candidate", "0015_logistics_mandatory_events"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="BitByteGroup",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                (
+                    "bits",
+                    models.ManyToManyField(
+                        related_name="bitbyte_groups_as_bit",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "bytes",
+                    models.ManyToManyField(
+                        related_name="bitbyte_groups_as_byte",
+                        to=settings.AUTH_USER_MODEL,
+                    ),
+                ),
+                (
+                    "semester",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="bit_byte_groups",
+                        to="coursesemester.semester",
+                    ),
+                ),
+            ],
+            options={
+                "verbose_name": "Bit Byte Group",
+                "verbose_name_plural": "Bit Byte Groups",
+            },
+        ),
+    ]

hknweb/candidate/models/__init__.py

@@ -1,4 +1,5 @@
 from hknweb.candidate.models.bit_byte_activity import BitByteActivity
+from hknweb.candidate.models.bit_byte_group import BitByteGroup
 from hknweb.candidate.models.officer_challenge import OffChallenge
 from hknweb.candidate.models.announcement import Announcement
 from hknweb.candidate.models.logistics import Logistics, EventReq, MiscReq, FormReq

hknweb/candidate/models/bit_byte_activity.py

@@ -1,5 +1,5 @@
 from django.db import models
-
+from django.conf import settings
 from hknweb.candidate.models.constants import MAX_STRLEN
 
 
@@ -13,7 +13,8 @@ class BitByteActivity(models.Model):
     class Meta:
         verbose_name_plural = "Bit Byte Activities"
 
-    participants = models.ManyToManyField("auth.User")
+    # TODO: Switch to use BitByteGroup model if more/proper bitbyte group backend is added.
+    participants = models.ManyToManyField(settings.AUTH_USER_MODEL)
     # whether VP/Csec confirmed this request, null when unreviewed
     confirmed = models.BooleanField(null=True)
     proof = models.CharField(

hknweb/candidate/models/bit_byte_group.py

@@ -0,0 +1,34 @@
+from django.db import models
+from django.conf import settings
+from hknweb.coursesemester.models import Semester
+
+
+class BitByteGroup(models.Model):
+    """
+    Model for bit byte group.
+    Each bit byte group has a semester associated with it, if it is unknown the field is none.
+    """
+
+    class Meta:
+        verbose_name = "Bit Byte Group"
+        verbose_name_plural = "Bit Byte Groups"
+
+    semester = models.ForeignKey(
+        Semester,
+        on_delete=models.CASCADE,
+        related_name="bit_byte_groups",
+    )
+
+    bytes = models.ManyToManyField(
+        settings.AUTH_USER_MODEL, related_name="bitbyte_groups_as_byte"
+    )
+    bits = models.ManyToManyField(
+        settings.AUTH_USER_MODEL, related_name="bitbyte_groups_as_bit"
+    )
+
+    def __str__(self):
+        return (
+            f"Bit byte group {self.semester}; "
+            + f"Bytes: {', '.join([c.username for c in self.bytes.all()])}; "
+            + f"Bits: {', '.join([c.username for c in self.bits.all()])}"
+        )

hknweb/candidate/models/officer_challenge.py

@@ -1,6 +1,6 @@
-from django.conf import settings
 from django.db import models
 
+from django.conf import settings
 from hknweb.candidate.models.constants import MAX_STRLEN
 
 
@@ -22,15 +22,15 @@ class Meta:
     # the requester needs permission to add officer challenges. This limits the choices in a dropdown,
     # but the view CandRequestView is still able to set requesters regardless of their permissions
     requester = models.ForeignKey(
-        "auth.User",
+        settings.AUTH_USER_MODEL,
         # NOTE: for some reason this causes an error when you try to save on the admin, so I'll just comment it out for now
         # limit_choices_to=Q(groups__permissions__codename='add_offchallenge'),
         on_delete=models.CASCADE,
         default=None,
         related_name="received_challenges",
     )
     officer = models.ForeignKey(
-        "auth.User",
+        settings.AUTH_USER_MODEL,
         limit_choices_to={"groups__name": settings.OFFICER_GROUP},
         on_delete=models.CASCADE,
         default=None,

hknweb/forms.py

@@ -267,3 +267,7 @@ def generate_password() -> str:
 
         # Save information for adding messages
         self.invalid_emails = invalid_emails
+
+
+class CsvImportForm(forms.Form):
+    csv_file = forms.FileField(label="Select .csv file")