|
| 1 | +from rest_framework import serializers |
| 2 | + |
| 3 | +from django.contrib.auth.models import AnonymousUser |
| 4 | + |
| 5 | +from annotation.models import Label, Labeling |
| 6 | +from problem.models import Problem |
| 7 | +from user.models import User |
| 8 | + |
| 9 | + |
| 10 | +class LabelSerializer(serializers.ModelSerializer): |
| 11 | + """ |
| 12 | + Serializer for Label model. |
| 13 | + """ |
| 14 | + |
| 15 | + class Meta: |
| 16 | + model = Label |
| 17 | + fields = ["id", "text", "description"] |
| 18 | + |
| 19 | + |
| 20 | +class ActiveLabelSerializer(serializers.Serializer): |
| 21 | + """ |
| 22 | + Serializer for active labels attached to a problem. |
| 23 | + Includes attachedInfo and removable status based on current user. |
| 24 | + """ |
| 25 | + |
| 26 | + id = serializers.IntegerField(source="label.id") |
| 27 | + text = serializers.CharField(source="label.text") |
| 28 | + description = serializers.CharField(source="label.description") |
| 29 | + attachedInfo = serializers.SerializerMethodField() |
| 30 | + removable = serializers.SerializerMethodField() |
| 31 | + |
| 32 | + def get_attachedInfo(self, labeling: Labeling) -> dict: |
| 33 | + """Get attachment information for the label.""" |
| 34 | + request = self.context.get("request") |
| 35 | + user: User | AnonymousUser | None = request.user if request else None |
| 36 | + |
| 37 | + if user and user.is_anonymous is False: |
| 38 | + attached_by_current_user = labeling.attached_by.pk == user.pk |
| 39 | + else: |
| 40 | + attached_by_current_user = False |
| 41 | + |
| 42 | + return { |
| 43 | + "userName": labeling.attached_by.username, |
| 44 | + "date": labeling.attached_at.isoformat(), |
| 45 | + "attachedByCurrentUser": attached_by_current_user, |
| 46 | + } |
| 47 | + |
| 48 | + def get_removable(self, labeling: Labeling) -> bool: |
| 49 | + """Determine if the label is removable by the current user.""" |
| 50 | + request = self.context.get("request") |
| 51 | + user: User | AnonymousUser | None = request.user if request else None |
| 52 | + |
| 53 | + if user is None or user.is_anonymous: |
| 54 | + return False |
| 55 | + |
| 56 | + if user.is_superuser or user.has_perm("annotation.delete_any_labeling"): |
| 57 | + return True |
| 58 | + |
| 59 | + if user.has_perm("annotation.delete_own_labeling"): |
| 60 | + return labeling.attached_by.pk == user.pk |
| 61 | + |
| 62 | + return False |
| 63 | + |
| 64 | + |
| 65 | +class LabelingSerializer(serializers.ModelSerializer): |
| 66 | + """ |
| 67 | + Serializer for Labeling model, including the full label details. |
| 68 | + """ |
| 69 | + |
| 70 | + label = LabelSerializer(read_only=True) |
| 71 | + attachedAt = serializers.DateTimeField(source="attached_at") |
| 72 | + attachedBy = serializers.PrimaryKeyRelatedField( |
| 73 | + source="attached_by", read_only=True |
| 74 | + ) |
| 75 | + removedAt = serializers.DateTimeField(source="removed_at", allow_null=True) |
| 76 | + removedBy = serializers.PrimaryKeyRelatedField( |
| 77 | + source="removed_by", allow_null=True, read_only=True |
| 78 | + ) |
| 79 | + |
| 80 | + class Meta: |
| 81 | + model = Labeling |
| 82 | + fields = [ |
| 83 | + "id", |
| 84 | + "label", |
| 85 | + "attached_at", |
| 86 | + "attached_by", |
| 87 | + "removed_at", |
| 88 | + "removed_by", |
| 89 | + "notes", |
| 90 | + ] |
| 91 | + |
| 92 | + |
| 93 | +class SelectedLabelSerializer(serializers.Serializer): |
| 94 | + """Serializer for a selected label in the save labels input.""" |
| 95 | + |
| 96 | + id = serializers.IntegerField() |
| 97 | + |
| 98 | + def validate_id(self, value): |
| 99 | + """Validate that the label exists.""" |
| 100 | + if not Label.objects.filter(id=value).exists(): |
| 101 | + raise serializers.ValidationError(f"Label with ID {value} does not exist.") |
| 102 | + return value |
| 103 | + |
| 104 | + |
| 105 | +class SaveLabelsInputSerializer(serializers.Serializer): |
| 106 | + """ |
| 107 | + Serializer for validating save labels input data. |
| 108 | + Used when saving/updating labels for a problem. |
| 109 | + """ |
| 110 | + |
| 111 | + problemId = serializers.IntegerField() |
| 112 | + selectedLabels = SelectedLabelSerializer(many=True, allow_empty=True) |
| 113 | + remarks = serializers.CharField(required=False, allow_blank=True, default="") |
| 114 | + |
| 115 | + def validate_problemId(self, value): |
| 116 | + """Validate that the problem exists.""" |
| 117 | + if not Problem.objects.filter(id=value).exists(): |
| 118 | + raise serializers.ValidationError( |
| 119 | + f"Problem with ID {value} does not exist." |
| 120 | + ) |
| 121 | + return value |
0 commit comments