Merge pull request #58 from crackhex/zip

zip files implementation + refactor

Author: kierio04

adapters/discord/commands/host/set_file_command.py

@@ -26,20 +26,19 @@
 from discord.ext import commands
 
 from adapters.discord.checks import host_only
+from application.parsers.registry import EXTENSION_STRATEGIES
 from application.parsers.rkg_parser_strategy   import RkgParserStrategy
 from application.parsers.rksys_parser_strategy import RksysParserStrategy
 from application.parsers.null_parser_strategy  import NullParserStrategy
 from application.parsers.parser_strategy import ParserStrategy
+from application.parsers.zip_parser_strategy import ZipParserStrategy
 from application.services.config_service import ConfigService
 
 # --------------------------------------------------------------------------- #
 # Map extensions → concrete strategy classes.                                 #
 # This is to be extended by third party comps (sm64, nsmbw, etc)              #
 # --------------------------------------------------------------------------- #
-EXTENSION_STRATEGIES: Dict[str, Type[ParserStrategy]] = {
-    "rkg":   RkgParserStrategy,
-    "dat": RksysParserStrategy, # rksys.dat
-}
+
 
 ALLOWED_CHOICES = [
     app_commands.Choice(name=f".{ext}", value=ext) for ext in EXTENSION_STRATEGIES

application/parsers/registry.py

@@ -0,0 +1,35 @@
+"""
+Registry
+===========
+
+Module path:
+    src/application/parsers/registry.py
+
+Summary:
+    Maps file extension to parsing strategies and provides helper methods
+"""
+
+from typing import Dict, Type, Optional
+
+from application.parsers.parser_strategy import ParserStrategy
+from application.parsers.rkg_parser_strategy import RkgParserStrategy
+from application.parsers.rksys_parser_strategy import RksysParserStrategy
+from application.parsers.zip_parser_strategy import ZipParserStrategy
+
+EXTENSION_STRATEGIES: Dict[str, Type[ParserStrategy]] = {
+    "rkg":   RkgParserStrategy,
+    "dat":   RksysParserStrategy,
+    "zip":   ZipParserStrategy,
+}
+
+def get_strategy_cls(ext: str) -> Optional[Type[ParserStrategy]]:
+    return EXTENSION_STRATEGIES.get(ext.lower())
+
+def new_strategy(ext: str) -> Optional[ParserStrategy]:
+    cls = get_strategy_cls(ext)
+    return cls() if cls else None
+
+def candidates_excluding(current: ParserStrategy) -> list[ParserStrategy]:
+    """Helper for fallback loop in parse_file()."""
+    current_cls = type(current)
+    return [cls() for cls in EXTENSION_STRATEGIES.values() if cls is not current_cls]

application/parsers/zip_parser_strategy.py

@@ -0,0 +1,53 @@
+"""
+Zip File Parser Strategy
+=============================
+
+Module path:
+    src/application/parsers/zip_parser_strategy.py
+
+Summary:
+    ParserStrategy implementation for Zip files, used for special types of tasks that require more than a type of file.
+
+Responsibilities:
+    - Check if the file bytes are indeed a zip by verifying its magic headers
+    - Produce a ZipFile object with default run_time=0
+"""
+
+from domain.entities import ZipFile
+from io import BytesIO
+import zipfile
+from .parser_strategy import ParserStrategy
+
+
+class ZipParserStrategy(ParserStrategy):
+    """
+    Concrete ParserStrategy for .zip files.
+
+    supports(): accepts any zip
+    parse(): returns a ZipFile
+    """
+
+    def supports(self, file_bytes: bytes) -> bool:
+        """
+        Under the hood, this checks for the magic headers
+        """
+        try:
+            return zipfile.is_zipfile(BytesIO(file_bytes))
+        except Exception:
+            return False
+
+    def parse(self, file_bytes: bytes, uploaded_at: int) -> ZipFile:
+        """
+        Parse the Zip file into a ZipFile domain object.
+
+        Args:
+            file_bytes (bytes): raw file content
+            uploaded_at (int): UNIX timestamp when file was received
+
+        Returns:
+            ZipFile: with run_time=0.0
+        """
+        return ZipFile(
+            path="",
+            uploaded_at=uploaded_at,
+        )

application/services/submission_services/mkw_submission_service.py

@@ -1,34 +1,36 @@
 """
-MKW Wii Submission Service
+MKW Submission Service
 ==========================
 
 Module path:
-    src/application/services/mkw_submission_service.py
+    src/application/services/submission_services/mkw_submission_service.py
 
-Summary
--------
-Domain-specific implementation of ``AbstractSubmissionService`` for the
-**Mario Kart Wii TAS Competition**.
-It understands two file formats:
+Summary:
 
-* ``.rkg``  – single-track ghost file (Time Trials).
-* ``.rksys`` – multi-track system save dump (Grand Prix / TT batch).
+Game-specific implementation of the base submission service for the
+Mario Kart Wii TAS Competition.
+It understands the following file formats:
+
+* .rkg  – single-track ghost file (Time Trials).
+* .rksys – game file, used for ghosts across multiple tracks.
+* .zip - sending multiple files, of different type.
 
 The service chooses the proper parser **at run-time**, based on the single
-“accepted file extension” stored in the guild/competition configuration.
+accepted file extension stored in the guild/competition configuration.
 
-If a user submits multiple times, previous runs are automatically replaced
-according to the base‐class algorithm.
 """
 
 from __future__ import annotations
 
-from typing import Optional
+from typing import Optional, Dict, Type
 
+from application.parsers.parser_strategy import ParserStrategy
+from application.parsers.registry import candidates_excluding
 from application.parsers.rkg_parser_strategy   import RkgParserStrategy
 from application.parsers.rksys_parser_strategy import RksysParserStrategy
 from application.parsers.file_parser  import FileParser
 from application.parsers.null_parser_strategy  import NullParserStrategy   # safety
+from application.parsers.zip_parser_strategy import ZipParserStrategy
 
 from application.services.submission_services.base_submission_service import BaseSubmissionService
 
@@ -43,6 +45,7 @@
 from domain.entities import SubmissionFile, Submission
 
 
+
 class MKWSubmissionService(BaseSubmissionService):
     """
     Concrete submission service for Mario Kart Wii competitions.
@@ -74,7 +77,7 @@ def __init__(
             speed_repo=speed_repo
         )
 
-    # ────────────────────────── required hooks ────────────────────────────
+    # ────────────────────────── required methods ────────────────────────────
     # Pick the correct parser & return the parsed value object
     def parse_file(
         self,
@@ -88,9 +91,9 @@ def parse_file(
         Raises
         ------
         ValueError
-            If the bytes do not match either .rkg nor .rksys.
+            If the bytes do not match any of the accepted formats.
         """
-        # ``FileParser`` should already have the right strategy
+        # FileParser should already have the right strategy
         # (because /set-file set it), but we double-check.
         strat = self._parser.strategy
         if isinstance(strat, NullParserStrategy):
@@ -102,12 +105,16 @@ def parse_file(
         if strat.supports(file_bytes):
             return strat.parse(file_bytes, uploaded_at_epoch)
 
-        # Otherwise, fall back to the other parser
-        alt_strat = RkgParserStrategy() if isinstance(strat, RksysParserStrategy) else RksysParserStrategy()
-        if alt_strat.supports(file_bytes):
-            # Swap strategy for the rest of the runtime
-            self._parser.set_strategy(alt_strat)
-            return alt_strat.parse(file_bytes, uploaded_at_epoch)
+
+        # Otherwise, try all other known strategies
+        strat = self._parser.strategy
+        if strat.supports(file_bytes):
+            return strat.parse(file_bytes, uploaded_at_epoch)
+
+        for alt in candidates_excluding(strat):
+            if alt.supports(file_bytes):
+                self._parser.set_strategy(alt)
+                return alt.parse(file_bytes, uploaded_at_epoch)
 
         raise ValueError("Unsupported MKW submission file format")
 
@@ -118,12 +125,12 @@ def populate_metadata(
         file_obj: SubmissionFile,
     ) -> None:
         """
-        Extract MKW-specific metadata and copy it onto ``submission``.
+        Extract MKW-specific metadata and copy it onto submission.
 
         * run_time → submission.time
         * character / vehicle if available (only on RKG), else None
         """
-        # If rkg, retrieve run_time, else set to 0 if rksys (or time isn't found)
+        # If rkg, retrieve run_time, else set to 0 if not an rkg (or time isn't found)
         if hasattr(file_obj, "run_time"):
             submission.time = file_obj.run_time or 0.0
         else:

application/services/submission_services/service_factory.py

@@ -12,7 +12,7 @@
 
     Adding support for a new game requires:
 
-    1. Implementing a concrete XXXSubmissionService that derives fromBaseSubmissionService`.
+    1. Implementing a concrete XXXSubmissionService that derives from BaseSubmissionService.
     2. Importing it here and registering a new key in
         SubmissionServiceFactory – the rest of the bot remains unchanged.
     3. Register the file extension in main, and in entities.

domain/entities.py

@@ -12,7 +12,7 @@
 Responsibilities:
     - Task: competition with lifecycle methods (open, publish, close)
     - SpeedTaskSession: individual user session for a speed-task
-    - SubmissionFile, RKGFile, RKSysFile: file metadata value objects
+    - SubmissionFile, RKGFile, RKSysFile, ZipFile: file metadata value objects
     - User: Discord user
     - Team: group of users who collaborate in a task
     - Submission: run submission tied to a task, user/team, and file
@@ -206,6 +206,14 @@ def __init__(self, path: str, uploaded_at: int):
         super().__init__(path, uploaded_at)
         self.run_time = 0.0  # no run time available
 
+class ZipFile(SubmissionFile):
+    """
+    Represents a .zip file.
+    """
+    def __init__(self, path: str, uploaded_at: int):
+        super().__init__(path, uploaded_at)
+        self.run_time = 0.0  # no run time available
+
 
 class User:
     """

main.py

@@ -11,8 +11,10 @@
 from dotenv import load_dotenv
 
 from application.parsers.null_parser_strategy import NullParserStrategy
+from application.parsers.registry import new_strategy
 from application.parsers.rkg_parser_strategy import RkgParserStrategy
 from application.parsers.rksys_parser_strategy import RksysParserStrategy
+from application.parsers.zip_parser_strategy import ZipParserStrategy
 from application.services.submission_services.service_factory import build_submission_service
 from infrastructure.db import init_db
 from infrastructure.repositories.sqlalchemy_task_repo import SqlAlchemyTaskRepository
@@ -153,19 +155,17 @@ async def _bootstrap() -> None:
     guild_mappings = await config_service.list_guild_configs()
     if guild_mappings:
         comp_key = guild_mappings[0].comp  # 'mkw', 'sm64', ...
-        ext_cfg = await config_service.get_submission_file_extension(comp_key)
-
-        if ext_cfg and ext_cfg.ext == "rkg":
-            file_parser.set_strategy(RkgParserStrategy())
-        elif ext_cfg and ext_cfg.ext == "rksys":
-            file_parser.set_strategy(RksysParserStrategy())
 
-        # insert other comps here... (sm64, nsmbw)
+        # Get the parser strategy by getting the current file extension (if set)
+        ext_cfg = await config_service.get_submission_file_extension(comp_key)
+        if ext_cfg and ext_cfg.ext:
+            if strat := new_strategy(ext_cfg.ext):
+                file_parser.set_strategy(strat)
 
-        # else: keep NullParser until /set-file is run
+        # implicit else: keep NullParser until /set-file is run
 
     submission_service = build_submission_service(
-        comp=comp_key,                      # None ⇒ generic/Null service
+        comp=comp_key,
         user_svc=user_service,
         submission_repo=submission_repo,
         task_repo=task_repo,