Feature---send a message on connect (remind rules, announce event, give Discord url, etc)

rcon/api_commands.py

@@ -45,6 +45,7 @@
 from rcon.user_config.gtx_server_name import GtxServerNameChangeUserConfig
 from rcon.user_config.log_line_webhooks import LogLineWebhookUserConfig
 from rcon.user_config.log_stream import LogStreamUserConfig
+from rcon.user_config.message_on_connect import MessageOnConnectUserConfig
 from rcon.user_config.name_kicks import NameKickUserConfig
 from rcon.user_config.rcon_connection_settings import RconConnectionSettingsUserConfig
 from rcon.user_config.rcon_server_settings import RconServerSettingsUserConfig
@@ -81,20 +82,23 @@
 def parameter_aliases(alias_to_param: Dict[str, str]):
     """Specify parameter aliases of a function. This might be useful to preserve backwards
     compatibility or to handle parameters named after a Python reserved keyword.
-    
+
     Takes a mapping of aliases to their parameter name."""
+
     def decorator(func):
         @functools.wraps(func)
         def wrapper(*args, **kwargs):
             for alias, param in alias_to_param.items():
                 if alias in kwargs:
                     kwargs[param] = kwargs.pop(alias)
             return func(*args, **kwargs)
-        
+
         wrapper._parameter_aliases = alias_to_param
         return wrapper
+
     return decorator
 
+
 def get_rcon_api(credentials: ServerInfoType | None = None) -> "RconAPI":
     """Return a initialized Rcon connection to the game server
 
@@ -578,9 +582,11 @@ def get_online_mods(self) -> list[AdminUserType]:
     def get_ingame_mods(self) -> list[AdminUserType]:
         return ingame_mods()
 
-    @parameter_aliases({
-        "from": "from_",
-    })
+    @parameter_aliases(
+        {
+            "from": "from_",
+        }
+    )
     def get_historical_logs(
         self,
         player_name: str | None = None,
@@ -1745,6 +1751,41 @@ def validate_log_stream_config(
             reset_to_default=reset_to_default,
         )
 
+    def get_message_on_connect_config(self):
+        return MessageOnConnectUserConfig.load_from_db()
+
+    def set_message_on_connect_config(
+        self,
+        by: str,
+        config: dict[str, Any] | BaseUserConfig | None = None,
+        reset_to_default: bool = False,
+        **kwargs,
+    ) -> bool:
+        return self._validate_user_config(
+            command_name=inspect.currentframe().f_code.co_name,  # type: ignore
+            by=by,
+            model=MessageOnConnectUserConfig,
+            data=config or kwargs,
+            dry_run=False,
+            reset_to_default=reset_to_default,
+        )
+
+    def validate_message_on_connect_config(
+        self,
+        by: str,
+        config: dict[str, Any] | BaseUserConfig | None = None,
+        reset_to_default: bool = False,
+        **kwargs,
+    ) -> bool:
+        return self._validate_user_config(
+            command_name=inspect.currentframe().f_code.co_name,  # type: ignore
+            by=by,
+            model=MessageOnConnectUserConfig,
+            data=config or kwargs,
+            dry_run=True,
+            reset_to_default=reset_to_default,
+        )
+
     def get_date_scoreboard(self, start: int, end: int):
         try:
             start_date = datetime.fromtimestamp(int(start))

rcon/hooks.py

@@ -60,6 +60,7 @@
     is_description_word,
     is_help_word,
 )
+from rcon.user_config.message_on_connect import MessageOnConnectUserConfig
 from rcon.user_config.rcon_server_settings import RconServerSettingsUserConfig
 from rcon.user_config.real_vip import RealVipUserConfig
 from rcon.user_config.vac_game_bans import VacGameBansUserConfig
@@ -94,7 +95,7 @@ def initialise_vote_map(rcon: Rcon, struct_log):
         vote_map.gen_selection()
         vote_map.reset_last_reminder_time()
         vote_map.apply_results()
-    except:
+    except Exception:
         logger.exception("Something went wrong in vote map init")
 
 
@@ -221,7 +222,9 @@ def handle_new_match_start(rcon: Rcon, struct_log):
         # Check that the log is less than 5min old
         if (datetime.utcnow() - log_time).total_seconds() < 5 * 60:
             # then we use the current map to be more accurate
-            if current_map.map.name.lower() == log_map_name.lower().removesuffix(" night"):
+            if current_map.map.name.lower() == log_map_name.lower().removesuffix(
+                " night"
+            ):
                 map_name_to_save = current_map
                 guessed = False
             else:
@@ -248,7 +251,7 @@ def handle_new_match_start(rcon: Rcon, struct_log):
             guessed=guessed,
             start_timestamp=int(struct_log["timestamp_ms"] / 1000),
         )
-    except:
+    except Exception:
         raise
     finally:
         initialise_vote_map(rcon, struct_log)
@@ -388,7 +391,7 @@ def ban_if_has_vac_bans(rcon: Rcon, player_id: str, name: str):
                 admin_name="VAC BOT",
             )
             logger.info(
-                "Player %s was banned due VAC history, last ban: %s days ago",
+                "Player '%s' was banned due VAC history, " "last ban: %s days ago",
                 str(player),
                 bans.get("DaysSinceLastBan"),
             )
@@ -730,7 +733,7 @@ def _set_real_vips(rcon: Rcon, struct_log):
     min_vip_slot = config.minimum_number_vip_slots
     vip_count = rcon.get_vips_count()
 
-    remaining_vip_slots = max(desired_nb_vips - vip_count, max(min_vip_slot, 0))
+    remaining_vip_slots = max(desired_nb_vips - vip_count, min_vip_slot, 0)
     rcon.set_vip_slots_num(remaining_vip_slots)
     logger.info("Real VIP set slots to %s", remaining_vip_slots)
 
@@ -771,3 +774,46 @@ def notify_camera(rcon: Rcon, struct_log):
 
     if config.welcome:
         temporary_welcome(rcon, struct_log["message"], 60)
+
+
+def _message_on_connect(rcon: Rcon, struct_log, player_name, player_id):
+    config = MessageOnConnectUserConfig.load_from_db()
+    if not config.enabled:
+        return  # Feature is disabled
+
+    message_on_connect_txt = config.non_seed_time_text
+
+    players_count_request = rcon.get_gamestate()
+    players_count = (
+        players_count_request["num_allied_players"]
+        + players_count_request["num_axis_players"]
+    )
+    if players_count < config.seed_limit:
+        message_on_connect_txt = config.seed_time_text
+
+    def send_message_on_connect():
+        try:
+            rcon.message_player(
+                player_id=player_id,
+                message=message_on_connect_txt,
+                by="Message_on_connect",
+                save_message=False,
+            )
+        except Exception as e:
+            logger.error(
+                "Could not send MessageOnConnect to player '%s' (%s) : %s",
+                player_name,
+                player_id,
+                e,
+            )
+
+    # The player might not yet have finished connecting in order to send messages.
+    t = Timer(10, send_message_on_connect)
+    pendingTimers[player_id].append((RconInvalidNameActionType.warn, t))
+    t.start()
+
+
+@on_connected()
+@inject_player_ids
+def message_on_connect(rcon: Rcon, struct_log, player_name, player_id):
+    _message_on_connect(rcon, struct_log, player_name, player_id)

rcon/user_config/__init__.py

@@ -20,6 +20,7 @@
         gtx_server_name,
         log_line_webhooks,
         log_stream,
+        message_on_connect,
         name_kicks,
         rcon_connection_settings,
         rcon_server_settings,

rcon/user_config/message_on_connect.py

@@ -0,0 +1,64 @@
+from typing import TypedDict
+
+from pydantic import Field
+
+from rcon.user_config.utils import BaseUserConfig, key_check, set_user_config
+
+SEED_TIME_TEXT = (
+    "Welcome !\n"
+    "The server is seeding\n\n"
+    "[ All time rules ]\n"
+    "Stay fun, be polite, communicate.\n"
+    "No teamkill, follow officers orders.\n\n"
+    "[ + Seed time rules ]\n"
+    "Do not capture the 4th point\n"
+    "Do not destroy garries in red zone\n\n"
+    "Have a good game !"
+)
+NON_SEED_TIME_TEXT = (
+    "Welcome !\n\n"
+    "[ All time rules ]\n"
+    "Stay fun, be polite, communicate.\n"
+    "No teamkill, follow officers orders.\n\n"
+    "Have a good game !"
+)
+
+
+class MessageOnConnectType(TypedDict):
+    enabled: bool
+    seed_limit: int
+    seed_time_text: str
+    non_seed_time_text: str
+
+
+class MessageOnConnectUserConfig(BaseUserConfig):
+    """
+    Args:
+        enabled bool:
+            Enable message at player's connection
+        seed_limit int:
+            The number of players in game to stop the seeding time
+        seed_time_text str:
+            A message that will be sent to any entering player in seed time
+        non_seed_time_text str:
+            A message that will be sent to any entering player in non-seed time
+    """
+
+    enabled: bool = Field(default=False, strict=True)
+    seed_limit: int = Field(ge=0, le=100, default=40)
+    seed_time_text: str = Field(default=SEED_TIME_TEXT)
+    non_seed_time_text: str = Field(default=NON_SEED_TIME_TEXT)
+
+    @staticmethod
+    def save_to_db(values: MessageOnConnectType, dry_run=False):
+        key_check(MessageOnConnectType.__required_keys__, values.keys())
+
+        validated_conf = MessageOnConnectUserConfig(
+            enabled=values.get("enabled"),
+            seed_limit=values.get("seed_limit"),
+            seed_time_text=values.get("seed_time_text"),
+            non_seed_time_text=values.get("non_seed_time_text"),
+        )
+
+        if not dry_run:
+            set_user_config(MessageOnConnectUserConfig.KEY(), validated_conf.model_dump())

rcon/user_config/seed_db.py

@@ -15,6 +15,7 @@
 from rcon.user_config.gtx_server_name import GtxServerNameChangeUserConfig
 from rcon.user_config.log_line_webhooks import LogLineWebhookUserConfig
 from rcon.user_config.log_stream import LogStreamUserConfig
+from rcon.user_config.message_on_connect import MessageOnConnectUserConfig
 from rcon.user_config.name_kicks import NameKickUserConfig
 from rcon.user_config.rcon_connection_settings import RconConnectionSettingsUserConfig
 from rcon.user_config.rcon_server_settings import RconServerSettingsUserConfig
@@ -63,6 +64,7 @@ def seed_default_config():
             KillsWebhooksUserConfig.seed_db(sess)
             LogLineWebhookUserConfig.seed_db(sess)
             LogStreamUserConfig.seed_db(sess)
+            MessageOnConnectUserConfig.seed_db(sess)
             NameKickUserConfig.seed_db(sess)
             RconConnectionSettingsUserConfig.seed_db(sess)
             RconServerSettingsUserConfig.seed_db(sess)

rcongui/src/App.js

@@ -50,6 +50,7 @@ import {
   VacGameBans,
   TeamKillBanOnConnect,
   NameKicks,
+  MessageOnConnect,
   ExpiredVIP,
   GTXNameChange,
   ChatCommands,
@@ -432,7 +433,9 @@ function App() {
                 <LiveSessionScore classes={classes} />
               </Route>
               <Route
-                path={process.env.REACT_APP_PUBLIC_BUILD ? "/" : "/livegamescore"}
+                path={
+                  process.env.REACT_APP_PUBLIC_BUILD ? "/" : "/livegamescore"
+                }
                 default={process.env.REACT_APP_PUBLIC_BUILD}
                 exact
               >
@@ -687,6 +690,17 @@ function App() {
                         />
                       </Grid>
                     </Route>
+                    <Route path="/settings/message-on-connect">
+                      <Grid container spacing={2}>
+                        <MessageOnConnect
+                          description="Message on connect"
+                          getEndpoint="get_message_on_connect_config"
+                          setEndpoint="set_message_on_connect_config"
+                          validateEndpoint="validate_message_on_connect_config"
+                          describeEndpoint="describe_message_on_connect_config"
+                        />
+                      </Grid>
+                    </Route>
                     <Route path="/settings/expired-vip">
                       <Grid container spacing={2}>
                         <ExpiredVIP