- Start work on reusable file upload view

- Add user_id to file upload model
- Some documentation
- Stole the file extension getter from the map upload
- Add todos for tomorrow. Going to need `BannableObject` sooner rather than later due to circular imports.

Author: alexlambson

kirovy/constants/api_codes.py

@@ -21,3 +21,7 @@ class LegacyUploadApiCodes(enum.StrEnum):
     INVALID_FILE_TYPE = "invalid-file-type-in-zip"
     GAME_NOT_SUPPORTED = "game-not-supported"
     MAP_FAILED_TO_PARSE = "map-failed-to-parse"
+
+
+class FileUploadApiCodes(enum.StrEnum):
+    MISSING_FOREIGN_ID = "missing-foreign-id"

kirovy/exceptions/view_exceptions.py

@@ -19,7 +19,19 @@ class KirovyValidationError(_DRFAPIException):
     default_code = "invalid"
     additional: _t.DictStrAny | None = None
     code: str | None
+    """attr: Some kind of string that the UI will recognize. e.g. ``file-too-large``.
+
+    Maps to the UI object attr :attr:`kirovy.objects.ui_objects.ErrorResponseData.code`.
+
+    .. warning::
+
+        This is **not** the HTTP code. The HTTP code will always be ``400`` for validation errors.
+    """
     detail: str | None
+    """attr: Extra detail in plain language. Think of this as a message for the user.
+
+    Maps to the UI object attr :attr:`kirovy.objects.ui_objects.ErrorResponseData.message`.
+    """
 
     def __init__(self, detail: str | None = None, code: str | None = None, additional: _t.DictStrAny | None = None):
         super().__init__(detail=detail, code=code)

kirovy/models/cnc_game.py

@@ -1,13 +1,18 @@
+import pathlib
 from functools import cached_property
 
 from django.conf import settings
+from django.core.files.uploadedfile import UploadedFile
 from django.db import models
+from structlog import BoundLogger
 
 from kirovy import exceptions, typing as t
 
 from kirovy.models.cnc_base_model import CncNetBaseModel
 
-__all__ = ["CncFileExtension", "CncGame"]
+__all__ = ["CncFileExtension", "CncGame", "GameScopedUserOwnedModel"]
+
+from kirovy.models.cnc_user import CncNetUserOwnedModel
 
 
 def is_valid_extension(extension: str) -> None:
@@ -73,6 +78,40 @@ def extension_for_path(self) -> str:
         """
         return f".{self.extension}"
 
+    @classmethod
+    def get_extension_id_for_upload(
+        cls,
+        uploaded_file: UploadedFile,
+        allowed_types: t.Set[str],
+        *,
+        logger: BoundLogger,
+        error_detail_upload_type: str,
+        extra_log_attrs: t.Dict[str, t.Any] | None = None,
+    ) -> str:
+        # TODO: Get rid of relative import after model import is removed from ui_objects.py
+        from kirovy.constants.api_codes import UploadApiCodes
+        from kirovy.exceptions.view_exceptions import KirovyValidationError
+
+        uploaded_extension = pathlib.Path(uploaded_file.name).suffix.lstrip(".").lower()
+        # iexact is case insensitive
+        kirovy_extension = cls.objects.filter(
+            extension__iexact=uploaded_extension,
+            extension_type__in=allowed_types,
+        ).first()
+
+        if kirovy_extension:
+            return str(kirovy_extension.id)
+
+        logger.warning(
+            "User attempted uploading unknown filetype",
+            uploaded_extension=uploaded_extension,
+            **(extra_log_attrs or {}),  # todo: the userattrs should be a context tag for structlog.
+        )
+        raise KirovyValidationError(
+            detail=f"'{uploaded_extension}' is not a valid {error_detail_upload_type.strip()} file extension.",
+            code=UploadApiCodes.FILE_EXTENSION_NOT_SUPPORTED,
+        )
+
 
 class CncGame(CncNetBaseModel):
     """Represents C&C games and large total-conversion mods like Mental Omega."""
@@ -140,3 +179,10 @@ def logo_url(self) -> str:
 
     def __repr__(self) -> str:
         return f"<{type(self).__name__} Object: ({self.slug}) '{self.full_name}' [{self.id}]>"
+
+
+class GameScopedUserOwnedModel(CncNetUserOwnedModel):
+    cnc_game = models.ForeignKey(CncGame, models.PROTECT, null=False, blank=False)
+
+    class Meta:
+        abstract = True

kirovy/models/cnc_map.py

@@ -9,6 +9,7 @@
 from kirovy.models import cnc_game as game_models, cnc_user
 from kirovy.models.cnc_base_model import CncNetBaseModel
 from kirovy import typing as t, exceptions
+from kirovy.models.cnc_game import GameScopedUserOwnedModel
 
 
 class MapCategory(CncNetBaseModel):
@@ -46,7 +47,7 @@ def save(
         super().save(force_insert, force_update, using, update_fields)
 
 
-class CncMap(cnc_user.CncNetUserOwnedModel):
+class CncMap(GameScopedUserOwnedModel):
     """The Logical representation of a map for a Command & Conquer game.
 
     We have this as a separate model from the file model because later C&C's allow for various files
@@ -108,7 +109,6 @@ class CncMap(cnc_user.CncNetUserOwnedModel):
         help_text="If true, then the map file has been uploaded, but the map info has not been set yet.",
     )
 
-    cnc_game = models.ForeignKey(game_models.CncGame, models.PROTECT, null=False)
     categories = models.ManyToManyField(MapCategory)
     parent = models.ForeignKey(
         "CncMap",

kirovy/models/file_base.py

@@ -3,8 +3,8 @@
 from django.db import models
 
 from kirovy import typing as t
-from kirovy.models.cnc_base_model import CncNetBaseModel
 from kirovy.models import cnc_game as game_models
+from kirovy.models.cnc_game import GameScopedUserOwnedModel
 from kirovy.utils import file_utils
 from kirovy.zip_storage import ZipFileStorage
 
@@ -24,7 +24,7 @@ def _generate_upload_to(instance: "CncNetFileBaseModel", filename: t.Union[str,
     return instance.generate_upload_to(instance, filename)
 
 
-class CncNetFileBaseModel(CncNetBaseModel):
+class CncNetFileBaseModel(GameScopedUserOwnedModel):
     class Meta:
         abstract = True
 
@@ -51,9 +51,6 @@ class Meta:
     These are checked against :attr:`kirovy.models.cnc_game.CncFileExtension.extension_type`.
     """
 
-    cnc_game = models.ForeignKey(game_models.CncGame, models.PROTECT, null=False, blank=False)
-    """Which game does this file belong to. Needed for file validation."""
-
     hash_md5 = models.CharField(max_length=32, null=False, blank=False)
     """Used for checking exact file duplicates."""
 

kirovy/objects/ui_objects.py

@@ -22,6 +22,8 @@ class BanData(BaseModel):
 
     - View: :class:`kirovy.views.admin_views.BanView`
     - URL: ``/admin/ban``
+
+    # TODO: Make a "bannable object" model and "get_model" to the same file to help with circular imports
     """
 
     class Meta:

kirovy/views/base_views.py

@@ -2,21 +2,35 @@
 Base views with common functionality for all API views in Kirovy
 """
 
+from abc import ABCMeta
+
+import magic, mimetypes
+from django.core.files.uploadedfile import UploadedFile
 from rest_framework import (
     exceptions as _e,
     generics as _g,
     permissions as _p,
     pagination as _pagination,
     status,
 )
+from rest_framework.generics import get_object_or_404
+from rest_framework.parsers import MultiPartParser
 from rest_framework.response import Response
+from rest_framework.views import APIView
 
 import kirovy.objects.ui_objects
-from kirovy import permissions, typing as t
+from kirovy import permissions, typing as t, logging
+from kirovy.constants import api_codes
+from kirovy.exceptions.view_exceptions import KirovyValidationError
+from kirovy.models import CncNetFileBaseModel
+from kirovy.models.cnc_game import GameScopedUserOwnedModel, CncFileExtension
 from kirovy.objects import ui_objects
+from kirovy.permissions import CanUpload, CanEdit
 from kirovy.request import KirovyRequest
 from kirovy.response import KirovyResponse
-from kirovy.serializers import KirovySerializer
+from kirovy.serializers import KirovySerializer, CncNetUserOwnedModelSerializer
+from kirovy.serializers.cnc_map_serializers import CncMapImageFileSerializer
+from kirovy.utils import file_utils
 
 
 class KirovyDefaultPagination(_pagination.LimitOffsetPagination):
@@ -136,3 +150,73 @@ class KirovyDestroyView(_g.DestroyAPIView):
 
     request: KirovyRequest  # Added for type hinting. Populated by DRF ``.setup()``
     permission_classes = [permissions.CanDelete | _p.IsAdminUser]
+
+
+class FileUploadBaseView(APIView, metaclass=ABCMeta):
+    parser_classes = [MultiPartParser]
+    permission_classes: [CanUpload, CanEdit]
+    request: KirovyRequest
+    file_class: t.ClassVar[t.Type[CncNetFileBaseModel]]
+    """attr: The class for the file."""
+    file_parent_class: t.ClassVar[t.Type[GameScopedUserOwnedModel]]
+    """attr: The class that the file will be linked to."""
+
+    file_parent_attr_name: t.ClassVar[str]
+    """attr: The name of the foreign key to the parent object.
+
+    e.g. ``cnc_game_id``.
+    """
+
+    serializer_class = t.ClassVar[t.Type[CncNetUserOwnedModelSerializer]]
+
+    def get_parent_object(self, request: KirovyRequest) -> GameScopedUserOwnedModel:
+
+        parent_object_id = request.data.get(self.file_parent_attr_name)
+        if not parent_object_id:
+            raise KirovyValidationError(
+                detail="Must specify foreign key to parent object",
+                code=api_codes.FileUploadApiCodes.MISSING_FOREIGN_ID,
+                additional={"expected_field": self.file_parent_attr_name},
+            )
+
+        parent_object: GameScopedUserOwnedModel = get_object_or_404(self.file_parent_class.objects, id=parent_object_id)
+        self.check_object_permissions(request, parent_object)
+
+        return parent_object
+
+    def post(self, request: KirovyRequest, format=None) -> KirovyResponse:
+        uploaded_file: UploadedFile = request.data["file"]
+        parent_object = self.get_parent_object(request)
+
+        # TODO BEFORE MEGE: Move to helper and 400 instead of 500
+        # TODO: maybe DRY mr mime.
+        magic_parser = magic.Magic(mime=True)
+        uploaded_file.seek(0)
+        mr_mime = magic_parser.from_buffer(uploaded_file.read())
+        uploaded_file.seek(0)
+        extension_id = file_utils.get_extension_id_for_upload(
+            uploaded_file,
+            self.file_class.ALLOWED_EXTENSION_TYPES,
+            logger=logging.get_logger(),
+            error_detail_upload_type="image",
+        )
+        serializer = self.serializer_class(
+            data={
+                "cnc_game_id": parent_object.cnc_game_id,
+                self.file_parent_attr_name: parent_object.id,
+                "name": request.get("name"),
+                "file": uploaded_file,
+                "file_extension_id": extension_id,
+                **self.extra_serializer_data(request),
+            }
+        )
+
+    def extra_serializer_data(self, request: KirovyRequest) -> t.Dict[str, t.Any]:
+        raise NotImplementedError()
+
+
+class MapImageFileUploadView(FileUploadBaseView):
+    permission_classes = [permissions.CanEdit]
+    serializer = CncMapImageFileSerializer
+
+    # TODO: Finish writing the subclass

kirovy/views/map_upload_views.py

@@ -52,13 +52,13 @@ def __init__(self, **kwargs):
             raise NotImplementedError("Must define what this endpoint sets for ``map_file.is_temporary``.")
 
     def post(self, request: KirovyRequest, format=None) -> KirovyResponse:
-        # todo: add file version support.
-        # todo: make validation less trash
+        # todo: add support for uploading new version of maps.
+        # todo: make validation less trash. This should probably all be in serializers.
         uploaded_file: UploadedFile = request.data["file"]
 
         game = self.get_game_from_request(request)
         if not game:
-            raise KirovyValidationError(detail="Game doesnot exist", code=UploadApiCodes.GAME_DOES_NOT_EXIST)
+            raise KirovyValidationError(detail="Game does not exist", code=UploadApiCodes.GAME_DOES_NOT_EXIST)
         extension_id = self.get_extension_id_for_upload(uploaded_file)
         self.verify_file_size_is_allowed(uploaded_file)
 
@@ -236,24 +236,12 @@ def get_game_from_request(self, request: KirovyRequest) -> CncGame | None:
         raise NotImplementedError()
 
     def get_extension_id_for_upload(self, uploaded_file: UploadedFile) -> str:
-        uploaded_extension = pathlib.Path(uploaded_file.name).suffix.lstrip(".").lower()
-        # iexact is case insensitive
-        kirovy_extension = CncFileExtension.objects.filter(
-            extension__iexact=uploaded_extension,
-            extension_type__in=cnc_map.CncMapFile.ALLOWED_EXTENSION_TYPES,
-        ).first()
-
-        if kirovy_extension:
-            return str(kirovy_extension.id)
-
-        _LOGGER.warning(
-            "User attempted uploading unknown filetype",
-            uploaded_extension=uploaded_extension,
-            **self.user_log_attrs,  # todo: the userattrs should be a context tag for structlog.
-        )
-        raise serializers.ValidationError(
-            detail=f"'{uploaded_extension}' is not a valid map file extension.",
-            code=UploadApiCodes.FILE_EXTENSION_NOT_SUPPORTED,
+        return CncFileExtension.get_extension_id_for_upload(
+            uploaded_file,
+            cnc_map.CncMapFile.ALLOWED_EXTENSION_TYPES,
+            logger=_LOGGER,
+            error_detail_upload_type="map",
+            extra_log_attrs=self.user_log_attrs,
         )
 
     def verify_file_does_not_exist(self, hashes: MapHashes) -> None: