feat: Add icon upload and icon_url support for achievements

Author: awindsr

api/dashboard/achievement/achievement_serializer.py

@@ -1,19 +1,38 @@
 from rest_framework import serializers
+from django.conf import settings
 from db.achievement import Achievement, UserAchievementsLog
 # from db.user import User
 
 class AchievementSerializer(serializers.ModelSerializer):
+    icon_url = serializers.SerializerMethodField()
 
     class Meta:
         model = Achievement
         fields = '__all__'
+    
+    def get_icon_url(self, obj):
+        if obj.icon:
+            # Check if it's already a full URL
+            if obj.icon.startswith('http://') or obj.icon.startswith('https://'):
+                return obj.icon
+            # Return full media URL for uploaded files
+            return f"{settings.MEDIA_URL}{obj.icon}"
+        return None
 
 class AchievementBasicSerializer(serializers.ModelSerializer):
     achievement_name = serializers.CharField(source='name')
+    icon_url = serializers.SerializerMethodField()
 
     class Meta:
         model = Achievement
-        fields = ['id', 'achievement_name', 'description', 'icon', 'level_id', 'tags', 'template_id']
+        fields = ['id', 'achievement_name', 'description', 'icon', 'icon_url', 'level_id', 'tags', 'template_id']
+    
+    def get_icon_url(self, obj):
+        if obj.icon:
+            if obj.icon.startswith('http://') or obj.icon.startswith('https://'):
+                return obj.icon
+            return f"{settings.MEDIA_URL}{obj.icon}"
+        return None
 
 class UserAchievementsSerializer(serializers.ModelSerializer):
     achievement = AchievementBasicSerializer(source='achievement_id', read_only=True)

api/dashboard/achievement/achievement_views.py

@@ -47,6 +47,9 @@ def get(self, request):
 
 
 class AchievementCreateAPIView(APIView):
+    from rest_framework.parsers import MultiPartParser, FormParser
+    parser_classes = [MultiPartParser, FormParser]
+    
     def post(self, request):
         user_id = JWTUtils.fetch_user_id(request)
 
@@ -62,14 +65,31 @@ def post(self, request):
             ).get_failure_response()
 
         data = request.data
-        required_fields = ["name", "description", "icon", "tags", "type", "has_vc"]
-
+        # Icon can be either a file upload or a text URL
+        icon_file = request.FILES.get("icon")
+        icon_url = data.get("icon", "") if not icon_file else ""
+        
+        required_fields = ["name", "description", "tags", "type", "has_vc"]
         missing_fields = [field for field in required_fields if field not in data]
         if missing_fields:
             return CustomResponse(
                 general_message=f"Missing required fields: {', '.join(missing_fields)}"
             ).get_failure_response()
 
+        # Parse has_vc from string to boolean (FormData sends strings)
+        has_vc_value = data.get("has_vc")
+        if isinstance(has_vc_value, str):
+            has_vc_value = has_vc_value.lower() in ("true", "1", "yes")
+        
+        # Parse tags from JSON string to list (FormData sends strings)
+        tags_value = data.get("tags", [])
+        if isinstance(tags_value, str):
+            import json
+            try:
+                tags_value = json.loads(tags_value)
+            except json.JSONDecodeError:
+                tags_value = []
+
         if Achievement.objects.filter(name=data["name"]).exists():
             return CustomResponse(
                 general_message="Name already exists"
@@ -84,15 +104,51 @@ def post(self, request):
                     general_message="Invalid level_id"
                 ).get_failure_response()
 
+        # Handle icon file upload
+        icon_path = icon_url  # Default to URL if provided
+        if icon_file:
+            import os
+            from django.conf import settings
+            
+            # Validate file type
+            allowed_extensions = ['jpg', 'jpeg', 'png', 'gif', 'webp', 'svg']
+            file_ext = icon_file.name.split('.')[-1].lower()
+            if file_ext not in allowed_extensions:
+                return CustomResponse(
+                    general_message=f"Invalid file type. Allowed: {', '.join(allowed_extensions)}"
+                ).get_failure_response()
+            
+            # Validate file size (max 5MB)
+            if icon_file.size > 5 * 1024 * 1024:
+                return CustomResponse(
+                    general_message="File size exceeds 5MB limit"
+                ).get_failure_response()
+            
+            # Create directory if it doesn't exist
+            upload_dir = os.path.join(settings.MEDIA_ROOT, 'achievements', 'icons')
+            os.makedirs(upload_dir, exist_ok=True)
+            
+            # Generate unique filename
+            unique_filename = f"{uuid.uuid4()}.{file_ext}"
+            file_path = os.path.join(upload_dir, unique_filename)
+            
+            # Save file
+            with open(file_path, 'wb+') as destination:
+                for chunk in icon_file.chunks():
+                    destination.write(chunk)
+            
+            # Store relative path for database
+            icon_path = f"achievements/icons/{unique_filename}"
+
         achievement = Achievement.objects.create(
             id=str(uuid.uuid4()),
             name=data["name"],
             description=data["description"],
-            icon=data["icon"],
-            tags=data["tags"],
+            icon=icon_path,
+            tags=tags_value,
             type=data["type"],
             level_id=level,
-            has_vc=data["has_vc"],
+            has_vc=has_vc_value,
             template_id=data.get("template_id"),
             created_by=user,
             updated_by=user,
@@ -106,6 +162,9 @@ def post(self, request):
 
 
 class AchievementUpdateAPIView(APIView):
+    from rest_framework.parsers import MultiPartParser, FormParser
+    parser_classes = [MultiPartParser, FormParser]
+    
     def put(self, request, achievement_id=None):
         user_id = JWTUtils.fetch_user_id(request)
 
@@ -135,6 +194,45 @@ def put(self, request, achievement_id=None):
         data = request.data.copy()
         data["updated_by"] = user_id
 
+        # Handle icon file upload
+        icon_file = request.FILES.get("icon")
+        if icon_file:
+            import os
+            from django.conf import settings
+            
+            # Validate file type
+            allowed_extensions = ['jpg', 'jpeg', 'png', 'gif', 'webp', 'svg']
+            file_ext = icon_file.name.split('.')[-1].lower()
+            if file_ext not in allowed_extensions:
+                return CustomResponse(
+                    general_message=f"Invalid file type. Allowed: {', '.join(allowed_extensions)}"
+                ).get_failure_response()
+            
+            # Validate file size (max 5MB)
+            if icon_file.size > 5 * 1024 * 1024:
+                return CustomResponse(
+                    general_message="File size exceeds 5MB limit"
+                ).get_failure_response()
+            
+            # Create directory if it doesn't exist
+            upload_dir = os.path.join(settings.MEDIA_ROOT, 'achievements', 'icons')
+            os.makedirs(upload_dir, exist_ok=True)
+            
+            # Generate unique filename
+            unique_filename = f"{uuid.uuid4()}.{file_ext}"
+            file_path = os.path.join(upload_dir, unique_filename)
+            
+            # Save file
+            with open(file_path, 'wb+') as destination:
+                for chunk in icon_file.chunks():
+                    destination.write(chunk)
+            
+            # Store relative path for database
+            data["icon"] = f"achievements/icons/{unique_filename}"
+        elif "icon" not in data or not data["icon"]:
+            # Keep existing icon if no new file or URL provided
+            data["icon"] = achievement.icon
+
         if "level_id" in data:
             if data["level_id"]:
                 try:
@@ -147,6 +245,22 @@ def put(self, request, achievement_id=None):
             else:
                 data["level_id"] = None
 
+        # Parse has_vc from string to boolean (FormData sends strings)
+        if "has_vc" in data:
+            has_vc_value = data.get("has_vc")
+            if isinstance(has_vc_value, str):
+                data["has_vc"] = has_vc_value.lower() in ("true", "1", "yes")
+        
+        # Parse tags from JSON string to list (FormData sends strings)
+        if "tags" in data:
+            tags_value = data.get("tags", [])
+            if isinstance(tags_value, str):
+                import json
+                try:
+                    data["tags"] = json.loads(tags_value)
+                except json.JSONDecodeError:
+                    data["tags"] = []
+
         serializer = achievement_serializer.AchievementSerializer(
             achievement, data=data, partial=True
         )