feat: add APIs for uploading images and file

- Created endpoints to handle image and PDF uploads
- Added validation for file type and size in serializers
- Linked uploaded files to related chat messages

Signed-off-by: drona-gyawali <dronarajgyawali@gmail.com>

Author: drona-gyawali

management/chat/api/viewset.py

@@ -1,11 +1,26 @@
 from chat.models import ChatGroup, GroupMessage
-from chat.serializers import ChatSerializers, GroupSerializers
-from core.permissions import CanEditOwnOrAdmin
+from chat.serializers import (
+    ChatSerializers,
+    FileAttachmentSerializers,
+    GroupSerializers,
+    ImageAttachmentSerializer,
+)
 from rest_framework import authentication, generics, permissions, status
+from rest_framework.decorators import APIView
 from rest_framework.response import Response
 
 
 class ChatMessageView(generics.ListAPIView):
+    """
+    API endpoint to retrieve chat groups and their messages.
+
+    Request Method: GET /chat/messages/
+
+    Responses:
+    - 200 OK: Returns a list of chat groups and their messages.
+    - 401 Unauthorized: Authentication failed.
+    """
+
     queryset = ChatGroup.objects.all()
     permission_classes = [permissions.IsAuthenticated]
     authentication_classes = [authentication.SessionAuthentication]
@@ -28,6 +43,17 @@ def list(self, request, *args, **kwargs):
 
 
 class ChatCreateView(generics.CreateAPIView):
+    """
+    API endpoint to create a group message.
+
+    Request Method: POST /chat/messages/create
+
+    Responses:
+    - 201 Created: Message has been created.
+    - 400 Bad Request: Unable to create message.
+    - 401 Unauthorized: Authentication failed.
+    """
+
     permission_classes = [permissions.IsAuthenticated]
     serializer_class = GroupSerializers
     authentication_classes = [authentication.SessionAuthentication]
@@ -37,7 +63,19 @@ class ChatCreateView(generics.CreateAPIView):
 
 
 class ChatDeleteView(generics.DestroyAPIView):
-    permission_classes = [permissions.IsAdminUser | CanEditOwnOrAdmin]
+    """
+    API endpoint to delete a group message by its ID.
+
+    Request Method: DELETE /chat/messsages/int:id/delete/
+
+    Responses:
+    - 200 OK: Message has been deleted.
+    - 401 Unauthorized: Authentication failed.
+    - 403 Forbidden: User does not have permission to delete the message.
+    - 404 Not Found: Message with the specified ID does not exist.
+    """
+
+    permission_classes = [permissions.IsAdminUser]
     serializer_class = GroupSerializers
     queryset = GroupMessage.objects.all()
     lookup_field = "id"
@@ -53,28 +91,142 @@ def destroy(self, request, *args, **kwargs):
 
 
 class ChatUpdateView(generics.UpdateAPIView):
+    """
+    API endpoint to update a group message by its ID.
+
+    Request Method: PUT chat/messages/<int:id>/update/
+
+    Responses:
+    - 200 OK: Message has been updated.
+    - 400 Bad Request: Unable to update message.
+    - 401 Unauthorized: Authentication failed.
+    - 404 Not Found: Message with the specified ID does not exist.
+    """
+
     serializer_class = GroupSerializers
-    authentication_classes = [authentication.SessionAuthentication | CanEditOwnOrAdmin]
+    authentication_classes = [authentication.SessionAuthentication]
+    queryset = GroupMessage.objects.all()
     lookup_field = "id"
 
 
 msg_update = ChatUpdateView.as_view()
 
 
 class GroupNameCreate(generics.CreateAPIView):
+    """
+    API endpoint to create a new chat group.
+
+    Request Method: POST /chat/groups/create/
+
+    Responses:
+    - 201 Created: Chat group created successfully.
+    - 400 Bad Request: Invalid data provided.
+    - 401 Unauthorized: Authentication credentials were not provided or are invalid.
+    """
+
     serializer_class = ChatSerializers
     queryset = ChatGroup.objects.all()
-    permission_classes = [permissions.IsAuthenticatedOrReadOnly | CanEditOwnOrAdmin]
+    permission_classes = [permissions.IsAuthenticatedOrReadOnly]
 
 
 group_create = GroupNameCreate.as_view()
 
 
 class GroupNameUpdate(generics.UpdateAPIView):
+    """
+    API endpoint to update the group name of a chat group.
+
+        Request Method: PUT/PATCH /chat/groups/str:<group_name>/update/
+
+        Path Parameters:
+        - group_name (str): The current name of the chat group to be updated.
+
+        Request Body:
+        - group_name (str): The new name for the chat group.
+
+        Responses:
+        - 200 OK: Group name updated successfully.
+        - 400 Bad Request: Invalid data provided.
+        - 401 Unauthorized: Authentication credentials were not provided or are invalid.
+        - 404 Not Found: Chat group with the specified group_name does not exist.
+    """
+
     serializer_class = ChatSerializers
     queryset = ChatGroup.objects.all()
-    permission_classes = [permissions.IsAuthenticatedOrReadOnly | CanEditOwnOrAdmin]
+    permission_classes = [permissions.IsAuthenticatedOrReadOnly]
     lookup_field = "group_name"
 
 
 group_update = GroupNameUpdate.as_view()
+
+
+class FileAttachment(APIView):
+    """
+    API endpoint to upload the file such as `.pdf`.
+
+        Request Method: POST /chat/upload_file/
+
+        Responses:
+        - 200 OK: File uploaded
+        - 400 Bad Request: Unable to upload file.
+        - 401 Unauthorized: Authentication failed.
+    """
+
+    permission_classes = [permissions.IsAuthenticated]
+
+    def post(self, request, format=None):
+        client = request.user
+        if not client:
+            return Response(
+                {"error": "Unauthorized to upload file "},
+                status=status.HTTP_401_UNAUTHORIZED,
+            )
+
+        serializer = FileAttachmentSerializers(data=request.data)
+        if serializer.is_valid():
+            serializer.save()
+            return Response({"success": "File uploaded"}, status=status.HTTP_200_OK)
+        print("Serializer errors:", serializer.errors)
+        return Response(
+            {"failed": "Unable to upload file", "detail_error": serializer.errors},
+            status=status.HTTP_400_BAD_REQUEST,
+        )
+
+
+upload_file = FileAttachment.as_view()
+
+
+class ImageAttachment(APIView):
+    """
+    API endpoint to upload the image file.
+
+        Request Method: POST /chat/upload_image/
+
+        Responses:
+        - 200 OK:Image uploaded
+        - 400 Bad Request: Unable to upload image.
+        - 401 Unauthorized: Authentication failed.
+    """
+
+    permission_classes = [permissions.IsAuthenticated]
+
+    def post(self, request, format=None):
+        client = request.user
+        if not client:
+            return Response(
+                {"error": "Unauthorized to upload images"},
+                status=status.HTTP_401_UNAUTHORIZED,
+            )
+
+        serializer = ImageAttachmentSerializer(data=request.data)
+        if serializer.is_valid():
+            serializer.save()
+            return Response({"success": "Image uploaded"}, status=status.HTTP_200_OK)
+        print("Serializer errors:", serializer.errors)
+        return Response(
+            {"failed": "Unable to upload image", "detail_error": serializer.errors},
+            status=status.HTTP_400_BAD_REQUEST,
+        )
+
+
+upload_image = ImageAttachment.as_view()

management/chat/migrations/0004_fileattachment_imageattachement_delete_attachement.py

@@ -0,0 +1,68 @@
+# Generated by Django 5.2.1 on 2025-05-26 17:08
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("chat", "0003_groupmessage_tag_groupmessage_updated_at_and_more"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="FileAttachment",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("file_image", models.FileField(upload_to="file/")),
+                ("file_name", models.CharField(blank=True, max_length=30)),
+                ("uploaded_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "message_file",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="file_attachment",
+                        to="chat.groupmessage",
+                    ),
+                ),
+            ],
+        ),
+        migrations.CreateModel(
+            name="ImageAttachement",
+            fields=[
+                (
+                    "id",
+                    models.BigAutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("chat_image", models.ImageField(upload_to="image/")),
+                ("uploaded_at", models.DateTimeField(auto_now_add=True)),
+                ("updated_at", models.DateTimeField(auto_now=True)),
+                (
+                    "messages_chat_file",
+                    models.ForeignKey(
+                        on_delete=django.db.models.deletion.CASCADE,
+                        related_name="chat_attachment",
+                        to="chat.groupmessage",
+                    ),
+                ),
+            ],
+        ),
+        migrations.DeleteModel(
+            name="Attachement",
+        ),
+    ]

management/chat/models.py

@@ -1,5 +1,5 @@
-from django.db import models
 from core.models import User
+from django.db import models
 
 
 class ChatGroup(models.Model):
@@ -8,6 +8,7 @@ class ChatGroup(models.Model):
     def __str__(self):
         return self.group_name
 
+
 class GroupMessage(models.Model):
     group = models.ForeignKey(
         ChatGroup, related_name="chat_messages", on_delete=models.CASCADE
@@ -31,26 +32,27 @@ class Meta:
     def __str__(self):
         return f"{self.author.username}: {self.body}"
 
-class Attachement(models.Model):
-    discussion= models.ForeignKey(GroupMessage, on_delete=models.CASCADE, related_name = 'attachment')
-    chat_image = models.ImageField(upload_to="chat_image/")
-    file_image = models.ImageField(upload_to='attachment/')
+
+class ImageAttachement(models.Model):
+    messages_chat_file = models.ForeignKey(
+        GroupMessage, on_delete=models.CASCADE, related_name="chat_attachment"
+    )
+    chat_image = models.ImageField(upload_to="image/")
+    uploaded_at = models.DateTimeField(auto_now_add=True)
+    updated_at = models.DateTimeField(auto_now=True)
+
+    def __str__(self):
+        return f"{self.messages_chat_file.author.username} uploaded an image"
+
+
+class FileAttachment(models.Model):
+    message_file = models.ForeignKey(
+        GroupMessage, on_delete=models.CASCADE, related_name="file_attachment"
+    )
+    file_image = models.FileField(upload_to="file/")
     file_name = models.CharField(max_length=30, blank=True)
-    link = models.URLField(blank=True)
-    reaction = models.CharField(max_length=50,blank=True)
     uploaded_at = models.DateTimeField(auto_now_add=True)
     updated_at = models.DateTimeField(auto_now=True)
 
     def __str__(self):
-        return (
-            f'{{'
-            f'"discussion": "{self.discussion.author.username}", '
-            f'"chat_image": "{self.chat_image.url if self.chat_image else ""}", '
-            f'"file_image": "{self.file_image.url if self.file_image else ""}", '
-            f'"file_name": "{self.file_name}", '
-            f'"link": "{self.link}", '
-            f'"reaction": "{self.reaction}", '
-            f'"uploaded_at": "{self.uploaded_at}", '
-            f'"updated_at": "{self.updated_at}"'
-            f'}}'
-        )
+        return f"{self.message_file.author.username} uploaded {self.file_name}"

management/chat/serializers.py

@@ -1,4 +1,10 @@
-from chat.models import ChatGroup, GroupMessage
+from chat.models import ChatGroup, FileAttachment, GroupMessage, ImageAttachement
+from core.dumps import (
+    FileAttachemenSize,
+    FileAttachementExt,
+    ImageAttachemenSize,
+    ImageAttachementExt,
+)
 from rest_framework import serializers
 
 
@@ -29,3 +35,37 @@ class ChatSerializers(serializers.ModelSerializer):
     class Meta:
         model = ChatGroup
         fields = "__all__"
+
+
+class ImageAttachmentSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = ImageAttachement
+        fields = "__all__"
+
+    def validate_chat_image(self, value):
+        if not value.name.lower().endswith(tuple(ImageAttachementExt)):
+            raise serializers.ValidationError(
+                f"Your file has a {value.name} extension, please use one of {ImageAttachementExt}."
+            )
+        if value.size > ImageAttachemenSize:
+            raise serializers.ValidationError(
+                f"Your file size is {value.size} bytes, maximum allowed is 5MB."
+            )
+        return value
+
+
+class FileAttachmentSerializers(serializers.ModelSerializer):
+    class Meta:
+        model = FileAttachment
+        fields = "__all__"
+
+    def validate_file_image(self, value):
+        if not value.name.lower().endswith(tuple(FileAttachementExt)):
+            raise serializers.ValidationError(
+                f"Your file has a {value.name} extension, please use `.pdf` only."
+            )
+        if value.size > FileAttachemenSize:
+            raise serializers.ValidationError(
+                f"Your file size is {value.size} bytes, maximum allowed is 20MB."
+            )
+        return value