Merge pull request #56 from SELab-2/45-backend-fixes-refactors

Backend changes

Author: PJDeSmijter

README.md

@@ -1,11 +1,13 @@
 # UGent-1
 
 ## Samenstelling
-- Alexander Van Oyen
 - Axel Lorreyne: Projectleider
-- Gilles Arnout
 - Pieter-Jan De Smijter: Technical lead
 - Reinhard De Paepe: Backend lead
-- Robin Paret: Systeembeheerder
-- Rune Dyselinck
 - Thibaud Collyn : Customer relations officer, Frontend lead
+- Gilles Arnout: Frontend dev
+- Alexander Van Oyen: Testing
+- Robin Paret: Systeembeheerder
+- Rune Dyselinck: Secretary
+
+## Bekijk de [wiki](https://github.com/SELab-2/UGent-1/wiki) om alles over de applicatie te weten te komen.

backend/pigeonhole/apps/courses/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.0.3 on 2024-03-12 22:52
+# Generated by Django 4.2.11 on 2024-04-01 15:13
 
 from django.db import migrations, models
 
@@ -17,6 +17,8 @@ class Migration(migrations.Migration):
                 ('course_id', models.BigAutoField(primary_key=True, serialize=False)),
                 ('name', models.CharField(max_length=256)),
                 ('description', models.TextField()),
+                ('open_course', models.BooleanField(default=False)),
+                ('invite_token', models.CharField(blank=True, max_length=20, null=True)),
             ],
         ),
     ]

backend/pigeonhole/apps/courses/models.py

@@ -1,4 +1,5 @@
 from django.db import models
+from django.utils.crypto import get_random_string
 from rest_framework import serializers
 
 
@@ -7,11 +8,37 @@ class Course(models.Model):
     course_id = models.BigAutoField(primary_key=True)
     name = models.CharField(max_length=256)
     description = models.TextField()
+    open_course = models.BooleanField(default=False)
+    invite_token = models.CharField(max_length=20, blank=True, null=True)
 
     objects = models.Manager()
 
+    def generate_new_token(self):
+        # generate a new token (could be useful if you want to use a different invite token)
+        token = get_random_string(length=20)
+        self.invitation_token = token
+        self.save()
+        return token
+
+    def save(self, *args, **kwargs):
+        # generate new code on initialization of a new course
+        if not self.invite_token:
+            self.invite_token = get_random_string(length=20)
+        return super().save(*args, **kwargs)
+
 
 class CourseSerializer(serializers.ModelSerializer):
+    invite_token = serializers.ReadOnlyField()
+
     class Meta:
         model = Course
-        fields = ['course_id', 'name', 'description']
+        fields = ['course_id', 'name', 'open_course', 'description', 'invite_token']
+
+    def to_representation(self, instance):
+        data = super().to_representation(instance)
+        request = self.context.get('request')
+
+        if request and request.user.is_student:
+            if 'invite_token' in data:
+                del data['invite_token']
+        return data

backend/pigeonhole/apps/courses/permissions.py

@@ -9,7 +9,7 @@ def has_permission(self, request, view):
         if request.user.is_admin or request.user.is_superuser:
             return True
 
-        if view.action in ['join_course', 'get_selected_courses']:
+        if view.action in ['join_course', 'get_selected_courses', 'join_course_with_token', 'leave_course']:
             return True
 
         if request.user.is_teacher:
@@ -20,7 +20,7 @@ def has_permission(self, request, view):
                     course=view.kwargs[
                         'pk']).exists():
                 return True
-            return
+            return False
 
         if request.user.is_student:
             if view.action == 'get_projects':

backend/pigeonhole/apps/courses/views.py

@@ -4,6 +4,7 @@
 from rest_framework.response import Response
 
 from backend.pigeonhole.apps.courses.models import CourseSerializer
+from backend.pigeonhole.apps.groups.models import Group
 from backend.pigeonhole.apps.projects.models import Project
 from backend.pigeonhole.apps.projects.models import ProjectSerializer
 from .models import Course
@@ -25,16 +26,45 @@ def join_course(self, request, *args, **kwargs):
         course = self.get_object()
         user = request.user
 
-        user.course.add(course)
-        return Response(status=status.HTTP_200_OK)
+        if request.user.is_student:
+            if course.open_course:
+                user.course.add(course)
+                return Response(status=status.HTTP_200_OK)
+            else:
+                return Response({'message': 'Invite token required.'}, status=status.HTTP_403_FORBIDDEN)
+        else:
+            user.course.add(course)
+            return Response(status=status.HTTP_200_OK)
+
+    @action(detail=True, methods=['post'], url_path='join_course_with_token/(?P<invite_token>[^/.]+)')
+    def join_course_with_token(self, request, *args, **kwargs):
+        course = self.get_object()
+        user = request.user
+        invite_token = kwargs.get('invite_token')
 
-    # def leave_course(self, request, *args, **kwargs):
-    #     course = self.get_object()
-    #     user = request.user
-    #
-    #     user.course.remove(course)
-    #     return Response(status=status.HTTP_200_OK)
-    # TODO implement leave_course (dont forget to leave all groups as well)
+        if invite_token == course.invite_token:
+            user.course.add(course)
+            return Response({'message': 'Successfully joined the course with invite token.'},
+                            status=status.HTTP_200_OK)
+        else:
+            return Response({'error': 'Invalid invite token.'}, status=status.HTTP_400_BAD_REQUEST)
+
+    @action(detail=True, methods=['post'])
+    def leave_course(self, request, *args, **kwargs):
+        course = self.get_object()
+        user = request.user
+        if course in user.course.all():
+            projects = Project.objects.filter(course_id=course.course_id)
+            for project in projects:
+                groups = Group.objects.filter(project_id=project.project_id)
+                for group in groups:
+                    if user in group.user.all():
+                        group.user.remove(user)
+                        group.save()
+            user.course.remove(course)
+        else:
+            return Response({'message': 'User is not in course'}, status=status.HTTP_400_BAD_REQUEST)
+        return Response(status=status.HTTP_200_OK)
 
     @action(detail=False, methods=['GET'])
     def get_selected_courses(self, request, *args, **kwargs):

backend/pigeonhole/apps/groups/migrations/0001_initial.py

@@ -1,7 +1,7 @@
-# Generated by Django 5.0.3 on 2024-03-12 22:52
+# Generated by Django 4.2.11 on 2024-04-01 15:13
 
-import django.db.models.deletion
 from django.db import migrations, models
+import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
@@ -20,7 +20,7 @@ class Migration(migrations.Migration):
                 ('group_nr', models.IntegerField(blank=True, null=True)),
                 ('feedback', models.TextField(null=True)),
                 ('final_score', models.IntegerField(blank=True, null=True)),
-                ('visible', models.BooleanField(default=True)),
+                ('visible', models.BooleanField(default=False)),
                 ('project_id', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='projects.project')),
             ],
         ),

backend/pigeonhole/apps/groups/migrations/0002_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 5.0.3 on 2024-03-12 22:52
+# Generated by Django 4.2.11 on 2024-04-01 15:13
 
 from django.conf import settings
 from django.db import migrations, models
@@ -9,14 +9,14 @@ class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        ('groups', '0001_initial'),
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+        ('groups', '0001_initial'),
     ]
 
     operations = [
         migrations.AddField(
             model_name='group',
             name='user',
-            field=models.ManyToManyField(to=settings.AUTH_USER_MODEL),
+            field=models.ManyToManyField(blank=True, to=settings.AUTH_USER_MODEL),
         ),
     ]

backend/pigeonhole/apps/groups/migrations/0003_alter_group_visible.py

@@ -1,10 +1,11 @@
-# Generated by Django 5.0.3 on 2024-03-12 22:52
+# Generated by Django 4.2.11 on 2024-04-01 15:13
 
-import django.db.models.deletion
 from django.db import migrations, models
+import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
+
     initial = True
 
     dependencies = [
@@ -15,29 +16,35 @@ class Migration(migrations.Migration):
         migrations.CreateModel(
             name='Project',
             fields=[
-                ('project_id', models.BigAutoField(primary_key=True, serialize=False)),
+                ('project_id', models.BigAutoField(primary_key=True,
+                                                   serialize=False)),
                 ('name', models.CharField(max_length=256)),
                 ('description', models.TextField()),
-                ('deadline', models.DateTimeField(blank=True, null=True)),
+                ('deadline', models.DateTimeField()),
                 ('visible', models.BooleanField(default=False)),
+                ('max_score', models.IntegerField(default=10)),
                 ('number_of_groups', models.IntegerField(default=5)),
                 ('group_size', models.IntegerField(default=1)),
                 ('file_structure', models.CharField(max_length=1024, null=True)),
-                ('max_score', models.IntegerField(blank=True, null=True)),
-                ('course_id', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='courses.course')),
+                ('course_id', models.ForeignKey(
+                    on_delete=django.db.models.deletion.CASCADE,
+                    to='courses.course')),
             ],
         ),
         migrations.CreateModel(
             name='Test',
             fields=[
-                ('project_id', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, primary_key=True,
-                                                 serialize=False, to='projects.project')),
+                ('project_id',
+                 models.ForeignKey(on_delete=django.db.models.deletion.CASCADE,
+                                   primary_key=True, serialize=False,
+                                   to='projects.project')),
                 ('test_nr', models.IntegerField()),
-                ('test_file_type', models.FileField(max_length=255, null=True, upload_to='uploads/projects/<django.db.'
-                                                                                         'models.fields.related.'
-                                                                                         'ForeignKey>/<django.db.'
-                                                                                         'models.fields.'
-                                                                                         'IntegerField>')),
+                ('test_file_type',
+                 models.FileField(max_length=255,
+                                  null=True,
+                                  upload_to='uploads/projects/<django.db.'
+                                  'models.fields.related.ForeignKey>/'
+                                  '<django.db.models.fields.IntegerField>')),
             ],
         ),
     ]

backend/pigeonhole/apps/groups/migrations/0004_alter_group_user.py

@@ -10,13 +10,12 @@ class Project(models.Model):
     course_id = models.ForeignKey(Course, on_delete=models.CASCADE)
     name = models.CharField(max_length=256)
     description = models.TextField()
-    deadline = models.DateTimeField(null=True, blank=True)
+    deadline = models.DateTimeField()
     visible = models.BooleanField(default=False)
-    max_score = models.IntegerField(null=True, blank=True)
+    max_score = models.IntegerField(default=10)
     number_of_groups = models.IntegerField(default=5)
     group_size = models.IntegerField(default=1)
     file_structure = models.CharField(max_length=1024, null=True)
-    max_score = models.IntegerField(null=True, blank=True)
 
 
 class ProjectSerializer(serializers.ModelSerializer):

backend/pigeonhole/apps/projects/migrations/0001_initial.py

@@ -1,41 +1,56 @@
-# Generated by Django 5.0.3 on 2024-03-12 22:52
+# Generated by Django 4.2.11 on 2024-04-01 15:13
 
 import backend.pigeonhole.apps.submissions.models
-import django.db.models.deletion
 from django.db import migrations, models
+import django.db.models.deletion
 
 
 class Migration(migrations.Migration):
     initial = True
 
     dependencies = [
-        ('groups', '0001_initial'),
+        ("groups", "0001_initial"),
     ]
 
     operations = [
         migrations.CreateModel(
-            name='Submissions',
+            name="Submissions",
             fields=[
-                ('submission_id',
-                 models.BigAutoField(primary_key=True, serialize=False)),
-                ('submission_nr', models.IntegerField(blank=True)),
-                ('file',
-                 models.FileField(max_length=255, null=True,
-                                  upload_to=backend.pigeonhole.apps.
-                                  submissions.models.get_upload_to)),
-                ('timestamp', models.DateTimeField(auto_now_add=True)),
-                ('output_test',
-                 models.FileField(blank=True,
-                                  max_length=255,
-                                  null=True,
-                                  upload_to='uploads/submissions/outputs/'
-                                            '<django.db.models.fields.related.Foreign'
-                                            'Key>/<django.db.models.fields.In'
-                                            'tegerField>/output_test/')),
-                ('group_id',
-                 models.ForeignKey(blank=True,
-                                   on_delete=django.db.models.deletion.CASCADE,
-                                   to='groups.group')),
+                (
+                    "submission_id",
+                    models.BigAutoField(primary_key=True, serialize=False),
+                ),
+                ("submission_nr", models.IntegerField(blank=True)),
+                (
+                    "file",
+                    models.FileField(
+                        max_length=255,
+                        null=True,
+                        upload_to=backend.
+                        pigeonhole.apps.submissions.models.get_upload_to,
+                    ),
+                ),
+                ("timestamp", models.DateTimeField(auto_now_add=True)),
+                (
+                    "output_test",
+                    models.FileField(
+                        blank=True,
+                        max_length=255,
+                        null=True,
+                        upload_to="uploads/submissions/outputs/"
+                        "<django.db.models.fields.related.Foreign"
+                        "Key>/<django.db.models.fields.Integer"
+                        "Field>/output_test/",
+                    ),
+                ),
+                (
+                    "group_id",
+                    models.ForeignKey(
+                        blank=True,
+                        on_delete=django.db.models.deletion.CASCADE,
+                        to="groups.group",
+                    ),
+                ),
             ],
         ),
     ]