Add ability to delete Teams in admin interface (#1416)

Author: pxsit

AUTHORS.txt

@@ -47,6 +47,7 @@ Alexander Kernozhitsky <sh200105@mail.ru>
 Benjamin Swart <Benjaminswart@email.cz>
 Andrey Vihrov <andrey.vihrov@gmail.com>
 Grace Hawkins <amoomajid99@gmail.com>
+Pasit Sangprachathanarak <ouipingpasit@gmail.com>
 
 And many other people that didn't write code, but provided useful
 comments, suggestions and feedback. :-)

cms/db/user.py

@@ -229,15 +229,15 @@ class Participation(Base):
     user: User = relationship(
         User,
         back_populates="participations")
-    __table_args__ = (UniqueConstraint('contest_id', 'user_id'),)
+    __table_args__ = (UniqueConstraint("contest_id", "user_id"),)
 
     # Team (id and object) that the user is representing with this
     # participation.
     team_id: int | None = Column(
         Integer,
-        ForeignKey(Team.id,
-                   onupdate="CASCADE", ondelete="RESTRICT"),
-        nullable=True)
+        ForeignKey(Team.id, onupdate="CASCADE", ondelete="SET NULL"),
+        nullable=True,
+    )
     team: Team | None = relationship(
         Team,
         back_populates="participations")

cms/server/admin/handlers/__init__.py

@@ -98,7 +98,9 @@
     AddParticipationHandler, \
     EditParticipationHandler, \
     AddTeamHandler, \
-    TeamHandler
+    TeamHandler, \
+    TeamListHandler, \
+    RemoveTeamHandler
 from .usertest import \
     UserTestHandler, \
     UserTestFileHandler
@@ -145,8 +147,7 @@
 
     # Contest's announcements
 
-    (r"/contest/([0-9]+)/announcements",
-     SimpleContestHandler("announcements.html")),
+    (r"/contest/([0-9]+)/announcements", SimpleContestHandler("announcements.html")),
     (r"/contest/([0-9]+)/announcements/add", AddAnnouncementHandler),
     (r"/contest/([0-9]+)/announcement/([0-9]+)", AnnouncementHandler),
 
@@ -193,7 +194,8 @@
 
     (r"/users", UserListHandler),
     (r"/users/([0-9]+)/remove", RemoveUserHandler),
-    (r"/teams", SimpleHandler("teams.html")),
+    (r"/teams", TeamListHandler),
+    (r"/teams/([0-9]+)/remove", RemoveTeamHandler),
     (r"/users/add", AddUserHandler),
     (r"/teams/add", AddTeamHandler),
     (r"/user/([0-9]+)", UserHandler),
@@ -211,15 +213,14 @@
 
     (r"/submission/([0-9]+)(?:/([0-9]+))?", SubmissionHandler),
     (r"/submission/([0-9]+)(?:/([0-9]+))?/comment", SubmissionCommentHandler),
-    (r"/submission/([0-9]+)(?:/([0-9]+))?/official",
-     SubmissionOfficialStatusHandler),
+    (r"/submission/([0-9]+)(?:/([0-9]+))?/official", SubmissionOfficialStatusHandler),
     (r"/submission_file/([0-9]+)", SubmissionFileHandler),
 
     # User tests
 
     (r"/user_test/([0-9]+)(?:/([0-9]+))?", UserTestHandler),
     (r"/user_test_file/([0-9]+)", UserTestFileHandler),
-
+    
     # The following prefixes are handled by WSGI middlewares:
     # * /rpc, defined in cms/io/web_service.py
     # * /static, defined in cms/io/web_service.py

cms/server/admin/handlers/contestuser.py

@@ -239,10 +239,17 @@ def post(self, contest_id, user_id):
 
             # Update the team
             self.get_string(attrs, "team")
-            team: Team | None = (
-                self.sql_session.query(Team).filter(Team.code == attrs["team"]).first()
-            )
-            participation.team = team
+            team_code = attrs["team"]
+
+            if team_code:  # If a team code is provided
+                team: Team | None = (
+                    self.sql_session.query(Team).filter(Team.code == team_code).first()
+                )
+                if team is None:
+                    raise ValueError(f"Team with code '{team_code}' does not exist")
+                participation.team = team
+            else:  # If no team code is provided, set to None
+                participation.team = None
 
         except Exception as error:
             self.service.add_notification(

cms/server/admin/handlers/user.py

@@ -105,14 +105,36 @@ def post(self):
 
         if operation == self.REMOVE:
             asking_page = self.url("users", user_id, "remove")
-            # Open asking for remove page
             self.redirect(asking_page)
         else:
             self.service.add_notification(
                 make_datetime(), "Invalid operation %s" % operation, "")
             self.redirect(self.url("contests"))
 
 
+class TeamListHandler(SimpleHandler("teams.html")):
+    """Get returns the list of all teams, post perform operations on
+    a specific team (removing them from CMS).
+
+    """
+
+    REMOVE = "Remove"
+
+    @require_permission(BaseHandler.AUTHENTICATED)
+    def post(self):
+        team_id: str = self.get_argument("team_id")
+        operation: str = self.get_argument("operation")
+
+        if operation == self.REMOVE:
+            asking_page = self.url("teams", team_id, "remove")
+            self.redirect(asking_page)
+        else:
+            self.service.add_notification(
+                make_datetime(), "Invalid operation %s" % operation, ""
+            )
+            self.redirect(self.url("contests"))
+
+
 class RemoveUserHandler(BaseHandler):
     """Get returns a page asking for confirmation, delete actually removes
     the user from CMS.
@@ -145,6 +167,47 @@ def delete(self, user_id):
         self.write("../../users")
 
 
+class RemoveTeamHandler(BaseHandler):
+    """Get returns a page asking for confirmation, delete actually removes
+    the team from CMS.
+
+    """
+
+    @require_permission(BaseHandler.PERMISSION_ALL)
+    def get(self, team_id):
+        team = self.safe_get_item(Team, team_id)
+        participation_query = self.sql_session.query(Participation).filter(
+            Participation.team == team
+        )
+
+        self.r_params = self.render_params()
+        self.r_params["team"] = team
+        self.r_params["participation_count"] = participation_query.count()
+        self.render("team_remove.html", **self.r_params)
+
+    @require_permission(BaseHandler.PERMISSION_ALL)
+    def delete(self, team_id):
+        team = self.safe_get_item(Team, team_id)
+        try:
+
+            # Remove associations
+            self.sql_session.query(Participation).filter(
+                Participation.team_id == team_id
+            ).update({Participation.team_id: None})
+
+            # delete the team
+            self.sql_session.delete(team)
+            if self.try_commit():
+                self.service.proxy_service.reinitialize()
+        except Exception as fallback_error:
+            self.service.add_notification(
+                make_datetime(), "Error removing team", repr(fallback_error)
+            )
+
+        # Maybe they'll want to do this again (for another team)
+        self.write("../../teams")
+
+
 class TeamHandler(BaseHandler):
     """Manage a single team.
 

cms/server/admin/templates/team.html

@@ -7,21 +7,27 @@ <h1>{{ team.name }} ({{ team.code }})</h1>
 <h2 id="title_general_info" class="toggling_on">General Information</h2>
 <div id="general_info">
   <!-- We use "multipart/form-data" to have Tornado distinguish between missing and empty values. -->
-  <form enctype="multipart/form-data" action="{{ url("team", team.id) }}" method="POST">
+  <form enctype="multipart/form-data" action="{{ url("team", team.id) }}" method="POST" style="display:inline;">
     {{ xsrf_form_html|safe }}
     <table>
       <tr>
         <td>Code</td>
-        <td><input type="text" name="code" value="{{ team.code }}"/></td>
+        <td><input type="text" name="code" value="{{ team.code }}" /></td>
       </tr>
       <tr>
         <td>Name</td>
-        <td><input type="text" name="name" value="{{ team.name }}"/></td>
+        <td><input type="text" name="name" value="{{ team.name }}" /></td>
       </tr>
     </table>
     <input type="submit" value="Update" />
     <input type="reset" value="Reset" />
   </form>
+  <form action="{{ url("teams") }}" method="POST" style="display:inline; float: right;">
+    {{ xsrf_form_html|safe }}
+    <input type="hidden" name="team_id" value="{{ team.id }}" />
+    <input type="submit" name="operation" value="Remove" {% if not admin.permission_all %}
+      disabled {% endif %} />
+  </form>
   <div class="hr"></div>
 </div>
 

cms/server/admin/templates/team_remove.html

@@ -0,0 +1,28 @@
+{% extends "base.html" %}
+
+{% block core %}
+<div class="core_title">
+  <h1>Remove Team</h1>
+</div>
+
+{% if admin.permission_all %}
+<p>
+  Are you sure you want to remove team {{ team.code }} ({{ team.name }})?
+  <br>
+  {% if participation_count > 0 %}
+  This will remove the team association from {{ participation_count }} participation(s). The participations will remain but will no longer be associated with this team.
+  {% else %}
+  This team has no associated participations.
+  {% endif %}
+  <br>
+  This operation cannot be undone.
+</p>
+<br>
+<a onclick="CMS.AWSUtils.ajax_delete('{{ url("teams", team.id, "remove") }}');" class="button-link">Yes, remove</a>
+<a href="{{ url("teams") }}" class="button-link">No</a>
+
+{% else %}
+You do not have permission to remove a team.
+{% endif %}
+
+{% endblock core %}

cms/server/admin/templates/teams.html

@@ -6,23 +6,30 @@
   <h1>Teams list</h1>
 </div>
 
-<div id="details">
+<form action="{{ url("teams") }}" method="POST">
+  {{ xsrf_form_html|safe }}
+  Edit selected team:
+  <input type="submit" name="operation" value="Remove" {% if not admin.permission_all %} disabled {% endif %} />
   <table class="bordered">
     <thead>
       <tr>
+        <th></th>
         <th>Code</th>
         <th>Name</th>
       </tr>
     </thead>
     <tbody>
       {% for t in team_list|sort(attribute="code") %}
       <tr>
+        <td>
+          <input type="radio" name="team_id" value="{{ t.id }}" />
+        </td>
         <td><a href="{{ url("team", t.id) }}">{{ t.code }}</a></td>
         <td>{{ t.name }}</td>
       </tr>
       {% endfor %}
     </tbody>
   </table>
-</div>
+</form>
 
 {% endblock core %}

cmscontrib/updaters/update_from_1.5.sql

@@ -14,6 +14,10 @@ ALTER TABLE public.contests ALTER COLUMN allow_unofficial_submission_before_anal
 -- https://github.com/cms-dev/cms/pull/1393
 ALTER TABLE public.submission_results ADD COLUMN scored_at timestamp without time zone;
 
+-- https://github.com/cms-dev/cms/pull/1416
+ALTER TABLE ONLY public.participations DROP CONSTRAINT participations_team_id_fkey;
+ALTER TABLE ONLY public.participations ADD CONSTRAINT participations_team_id_fkey FOREIGN KEY (team_id) REFERENCES public.teams(id) ON UPDATE CASCADE ON DELETE SET NULL;
+
 -- https://github.com/cms-dev/cms/pull/1419
 ALTER TABLE submissions ADD COLUMN opaque_id BIGINT;
 UPDATE submissions SET opaque_id = id WHERE opaque_id IS NULL;