CWS: API requests are now marked as such

Author: gollux

cms/server/contest/handlers/api.py

@@ -39,7 +39,17 @@
 logger = logging.getLogger(__name__)
 
 
-class ApiLoginHandler(ContestHandler):
+class ApiContestHandler(ContestHandler):
+    """An extension of ContestHandler marking the request as a part of the API.
+
+    """
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self.api_request = True
+
+
+class ApiLoginHandler(ApiContestHandler):
     """Login handler.
 
     """
@@ -87,7 +97,7 @@ def check_xsrf_cookie(self):
         pass
 
 
-class ApiTaskListHandler(ContestHandler):
+class ApiTaskListHandler(ApiContestHandler):
     """Handler to list all tasks and their statements.
 
     """
@@ -107,7 +117,7 @@ def get(self):
         self.json({"tasks": tasks})
 
 
-class ApiSubmitHandler(ContestHandler):
+class ApiSubmitHandler(ApiContestHandler):
     """Handles the received submissions.
 
     """
@@ -142,7 +152,7 @@ def post(self, task_name: str):
             self.json({'id': str(submission.opaque_id)})
 
 
-class ApiSubmissionListHandler(ContestHandler):
+class ApiSubmissionListHandler(ApiContestHandler):
     """Retrieves the list of submissions on a task.
 
     """

cms/server/contest/handlers/base.py

@@ -70,6 +70,7 @@ class BaseHandler(CommonRequestHandler):
     """
     current_user: Participation | None
     service: "ContestWebServer"
+    api_request: bool
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
@@ -85,6 +86,8 @@ def __init__(self, *args, **kwargs):
         self.translation = DEFAULT_TRANSLATION
         self._ = self.translation.gettext
         self.n_ = self.translation.ngettext
+        # Is this a request on an API endpoint?
+        self.api_request = False
 
     def render(self, template_name, **params):
         t = self.service.jinja2_environment.get_template(template_name)
@@ -176,6 +179,10 @@ def is_multi_contest(self):
         """Return whether CWS serves all contests."""
         return self.service.contest_id is None
 
+    def is_api(self):
+        """Return whether it's an API request."""
+        return self.api_request
+
 
 class ContestListHandler(BaseHandler):
     def get(self):