introduce user groups (#1621, #1666)

---------

Co-authored-by: Tobias Lenz <t_lenz94@web.de>
Co-authored-by: Jonathan Baumann <jonathan.baumann@mpi-sp.org>

Author: 3 people

cms/db/__init__.py

@@ -10,6 +10,7 @@
 # Copyright © 2016 Masaki Hara <ackie.h.gmai@gmail.com>
 # Copyright © 2016 Amir Keivan Mohtashami <akmohtashami97@gmail.com>
 # Copyright © 2018 William Di Luigi <williamdiluigi@gmail.com>
+# Copyright © 2026 Tobias Lenz <t_lenz94@web.de>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as
@@ -55,7 +56,7 @@
     # contest
     "Contest", "Announcement",
     # user
-    "User", "Team", "Participation", "Message", "Question",
+    "Group", "User", "Team", "Participation", "Message", "Question",
     # admin
     "Admin",
     # task
@@ -79,7 +80,7 @@
 
 # Instantiate or import these objects.
 
-version = 47
+version = 48
 
 engine = create_engine(config.database.url, echo=config.database.debug,
                        pool_timeout=60, pool_recycle=120)
@@ -95,7 +96,7 @@
 from .fsobject import FSObject, LargeObject
 from .admin import Admin
 from .contest import Contest, Announcement
-from .user import User, Team, Participation, Message, Question
+from .user import Group, User, Team, Participation, Message, Question
 from .task import Task, Statement, Attachment, Dataset, Manager, Testcase
 from .submission import Submission, File, Token, SubmissionResult, \
     Executable, Evaluation

cms/db/contest.py

@@ -6,8 +6,10 @@
 # Copyright © 2010-2012 Matteo Boscariol <boscarim@hotmail.com>
 # Copyright © 2012-2018 Luca Wehrstedt <luca.wehrstedt@gmail.com>
 # Copyright © 2013 Bernard Blackham <bernard@largestprime.net>
+# Copyright © 2015 Fabian Gundlach <320pointsguy@gmail.com>
 # Copyright © 2016 Myungwoo Chun <mc.tamaki@gmail.com>
 # Copyright © 2016 Amir Keivan Mohtashami <akmohtashami97@gmail.com>
+# Copyright © 2017-2026 Tobias Lenz <t_lenz94@web.de>
 # Copyright © 2018 William Di Luigi <williamdiluigi@gmail.com>
 #
 # This program is free software: you can redistribute it and/or modify
@@ -40,7 +42,7 @@
 from . import Codename, Base, Admin
 import typing
 if typing.TYPE_CHECKING:
-    from . import Task, Participation
+    from . import Task, Participation, Group
 
 
 class Contest(Base):
@@ -50,9 +52,6 @@ class Contest(Base):
     """
     __tablename__ = 'contests'
     __table_args__ = (
-        CheckConstraint("start <= stop"),
-        CheckConstraint("stop <= analysis_start"),
-        CheckConstraint("analysis_start <= analysis_stop"),
         CheckConstraint("token_gen_initial <= token_gen_max"),
     )
 
@@ -197,30 +196,6 @@ class Contest(Base):
         CheckConstraint("token_gen_max > 0"),
         nullable=True)
 
-    # Beginning and ending of the contest.
-    start: datetime = Column(
-        DateTime,
-        nullable=False,
-        default=datetime(2000, 1, 1))
-    stop: datetime = Column(
-        DateTime,
-        nullable=False,
-        default=datetime(2030, 1, 1))
-
-    # Beginning and ending of the contest anaylsis mode.
-    analysis_enabled: bool = Column(
-        Boolean,
-        nullable=False,
-        default=False)
-    analysis_start: datetime = Column(
-        DateTime,
-        nullable=False,
-        default=datetime(2030, 1, 1))
-    analysis_stop: datetime = Column(
-        DateTime,
-        nullable=False,
-        default=datetime(2030, 1, 1))
-
     # Timezone for the contest. All timestamps in CWS will be shown
     # using the timezone associated to the logged-in user or (if it's
     # None or an invalid string) the timezone associated to the
@@ -271,8 +246,26 @@ class Contest(Base):
         nullable=False,
         default=0)
 
+    # Main group (id and Group object) of this contest
+    main_group_id: int | None = Column(
+        Integer,
+        ForeignKey("groups.id", use_alter=True, name="fk_contest_main_group_id",
+                   onupdate="CASCADE", ondelete="SET NULL"),
+        nullable=True,
+        index=True)
+    main_group: "Group | None" = relationship(
+        "Group",
+        primaryjoin="Group.id==Contest.main_group_id",
+        post_update=True)
+
     # These one-to-many relationships are the reversed directions of
     # the ones defined in the "child" classes using foreign keys.
+    groups : list["Group"] = relationship(
+        "Group",
+        foreign_keys="[Group.contest_id]",
+        cascade="all, delete-orphan",
+        passive_deletes=True,
+        back_populates="contest")
 
     tasks: list["Task"] = relationship(
         "Task",
@@ -295,29 +288,6 @@ class Contest(Base):
         passive_deletes=True,
         back_populates="contest")
 
-    def phase(self, timestamp: datetime) -> int:
-        """Return: -1 if contest isn't started yet at time timestamp,
-                    0 if the contest is active at time timestamp,
-                    1 if the contest has ended but analysis mode
-                      hasn't started yet
-                    2 if the contest has ended and analysis mode is active
-                    3 if the contest has ended and analysis mode is disabled or
-                      has ended
-
-        timestamp: the time we are iterested in.
-        """
-        # NOTE: this logic is duplicated in aws_utils.js.
-        if timestamp < self.start:
-            return -1
-        if timestamp <= self.stop:
-            return 0
-        if self.analysis_enabled:
-            if timestamp < self.analysis_start:
-                return 1
-            elif timestamp <= self.analysis_stop:
-                return 2
-        return 3
-
 
 class Announcement(Base):
     """Class to store a messages sent by the contest managers to all

cms/db/user.py

@@ -6,7 +6,10 @@
 # Copyright © 2010-2012 Matteo Boscariol <boscarim@hotmail.com>
 # Copyright © 2012-2018 Luca Wehrstedt <luca.wehrstedt@gmail.com>
 # Copyright © 2015 William Di Luigi <williamdiluigi@gmail.com>
+# Copyright © 2015 Fabian Gundlach <320pointsguy@gmail.com>
 # Copyright © 2016 Myungwoo Chun <mc.tamaki@gmail.com>
+# Copyright © 2017-2026 Tobias Lenz <t_lenz94@web.de>
+# Copyright © 2021 Manuel Gundlach <manuel.gundlach@gmail.com>
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as
@@ -31,7 +34,7 @@
 from sqlalchemy.dialects.postgresql import ARRAY, CIDR
 from sqlalchemy.orm import relationship
 from sqlalchemy.schema import Column, ForeignKey, CheckConstraint, \
-    UniqueConstraint
+    UniqueConstraint, ForeignKeyConstraint
 from sqlalchemy.types import Boolean, Integer, String, Unicode, DateTime, \
     Interval
 
@@ -41,6 +44,102 @@
 if typing.TYPE_CHECKING:
     from . import Submission, UserTest
 
+
+class Group(Base):
+    """Class to store a group of users (for timing, etc.).
+
+    """
+    __tablename__ = 'groups'
+    __table_args__ = (
+        UniqueConstraint('contest_id', 'name'),
+        UniqueConstraint('id', 'contest_id'),
+        CheckConstraint("start <= stop"),
+        CheckConstraint("stop <= analysis_start"),
+        CheckConstraint("analysis_start <= analysis_stop"),
+    )
+
+    # Auto increment primary key.
+    id: int = Column(
+        Integer,
+        primary_key=True)
+
+    name: str = Column(
+        Unicode,
+        nullable=False)
+
+    # Beginning and ending of the contest.
+    start: datetime = Column(
+        DateTime,
+        nullable=False,
+        default=datetime(2000, 1, 1))
+    stop: datetime = Column(
+        DateTime,
+        nullable=False,
+        default=datetime(2100, 1, 1))
+
+    # Beginning and ending of the analysis mode for this group.
+    analysis_enabled: bool = Column(
+        Boolean,
+        nullable=False,
+        default=False)
+    analysis_start: datetime = Column(
+        DateTime,
+        nullable=False,
+        default=datetime(2100, 1, 1))
+    analysis_stop: datetime = Column(
+        DateTime,
+        nullable=False,
+        default=datetime(2100, 1, 1))
+
+    # Max contest time for each user in seconds.
+    per_user_time: timedelta | None = Column(
+        Interval,
+        CheckConstraint("per_user_time >= '0 seconds'"),
+        nullable=True)
+
+    # Contest (id and object) to which this user group belongs.
+    contest_id: int = Column(
+        Integer,
+        ForeignKey(Contest.id,
+                   onupdate="CASCADE", ondelete="CASCADE"),
+        nullable=False,
+        index=True)
+    contest: Contest = relationship(
+        Contest,
+        foreign_keys=[contest_id],
+        back_populates="groups")
+
+    def phase(self, timestamp: datetime) -> int:
+        """Return: -1 if contest isn't started yet at time timestamp,
+                    0 if the contest is active at time timestamp,
+                    1 if the contest has ended but analysis mode
+                      hasn't started yet
+                    2 if the contest has ended and analysis mode is active
+                    3 if the contest has ended and analysis mode is disabled or
+                      has ended
+
+        timestamp: the time we are iterested in.
+        """
+        # NOTE: this logic is duplicated in aws_utils.js.
+        if timestamp < self.start:
+            return -1
+        if timestamp <= self.stop:
+            return 0
+        if self.analysis_enabled:
+            if timestamp < self.analysis_start:
+                return 1
+            elif timestamp <= self.analysis_stop:
+                return 2
+        return 3
+
+    participations: list["Participation"] = relationship(
+        "Participation",
+        cascade="all, delete-orphan",
+        passive_deletes=True,
+        foreign_keys="[Participation.group_id]",
+        back_populates="group")
+
+
 class User(Base):
     """Class to store a user.
 
@@ -149,6 +248,12 @@ class Participation(Base):
 
     """
     __tablename__ = 'participations'
+    __table_args__ = (
+        ForeignKeyConstraint(
+            ("group_id", "contest_id"),
+            (Group.id, Group.contest_id)),
+        UniqueConstraint("contest_id", "user_id"),
+    )
 
     # Auto increment primary key.
     id: int = Column(
@@ -229,7 +334,18 @@ class Participation(Base):
     user: User = relationship(
         User,
         back_populates="participations")
-    __table_args__ = (UniqueConstraint("contest_id", "user_id"),)
+
+    # Group this user belongs to
+    group_id: int = Column(
+        Integer,
+        ForeignKey(Group.id,
+                   onupdate="CASCADE", ondelete="CASCADE"),
+        nullable=False,
+        index=True)
+    group: Group = relationship(
+        Group,
+        foreign_keys=[group_id],
+        back_populates="participations")
 
     # Team (id and object) that the user is representing with this
     # participation.

cms/server/admin/handlers/__init__.py

@@ -101,7 +101,10 @@
     AddTeamHandler, \
     TeamHandler, \
     TeamListHandler, \
-    RemoveTeamHandler
+    RemoveTeamHandler, \
+    GroupListHandler, \
+    AddGroupHandler, \
+    GroupHandler 
 from .usertest import \
     UserTestHandler, \
     UserTestFileHandler
@@ -136,6 +139,12 @@
     (r"/contest/([0-9]+)/user/([0-9]+)/edit", ParticipationHandler),
     (r"/contest/([0-9]+)/user/([0-9]+)/message", MessageHandler),
 
+    # Contest's groups
+
+    (r"/contest/([0-9]+)/groups", GroupListHandler),
+    (r"/contest/([0-9]+)/groups/add", AddGroupHandler),
+    (r"/contest/([0-9]+)/group/([0-9]+)/edit", GroupHandler),
+
     # Contest's tasks
 
     (r"/contest/([0-9]+)/tasks", ContestTasksHandler),

cms/server/admin/handlers/base.py

@@ -52,7 +52,7 @@
 
 from cms import __version__, config
 from cms.db import Admin, Contest, Participation, Question, Submission, \
-    SubmissionResult, Task, Team, User, UserTest
+    SubmissionResult, Task, Team, User, UserTest, Group
 import cms.db
 from cms.grading.scoretypes import get_score_type_class
 from cms.grading.tasktypes import get_task_type_class
@@ -659,6 +659,18 @@ def get_login_url(self) -> str:
         """
         return self.url("login")
 
+    def get_group_settings(self, g: Group):
+        attrs = dict()
+        self.get_datetime(attrs, "start")
+        assert attrs.get("start") is not None, "No main group start time specified."
+        self.get_datetime(attrs, "stop")
+        assert attrs.get("stop") is not None, "No main group stop time specified."
+        self.get_timedelta_sec(attrs, "per_user_time")
+
+        self.get_bool(attrs, "analysis_enabled")
+        self.get_datetime(attrs, "analysis_start")
+        self.get_datetime(attrs, "analysis_stop")
+        g.set_attrs(attrs)
 
 class FileHandler(BaseHandler, FileHandlerMixin):
     pass