ENHANCEMENTS:

- servers.yaml: new setting "managed_by" to set specific roles that can manage a server exclusively.
- servers.yaml: dedicated audit channel added for servers (optional)

Author: karel26

README.md

@@ -456,12 +456,15 @@ My Fancy Server:                # Your server name, as displayed in the server l
   force_voice: false            # Optional: enforce the usage of a voice channel (users need to be linked!) - default: false
   discord:                      # Optional: specify discord roles that are allowed to use this server
     - '@everyone'               # Attention: people cannot self-link on these servers and have to be liked properly already!
+  managed_by:
+    - Special Admin             # Optional: a list of Discord roles that can manage this server (default: DCS Admin)
   channels:
     status: 1122334455667788    # The Discord channel to display the server status embed and players embed into. Right-click on your channel and select "Copy Channel ID". You can disable it with -1
     chat: 8877665544332211      # The Discord channel for the in-game chat replication. You can disable it by setting it to -1.
     events: 1928374619283746    # Optional: if you want to split game events from chat messages, you can enable an optional events channel.
-    admin: 1188227733664455     # The channel where you can fire admin commands to this server. You can decide if you want to have a central admin channel or server-specific ones. See bot.yaml for more.
-    voice: 1827364518273645     # The voice channel, where people need to connect to (if force_voice is true). 
+    admin: 1188227733664455     # Optional: The channel where you can fire admin commands to this server. You can decide if you want to have a central admin channel or server-specific ones. See bot.yaml for more.
+    voice: 1827364518273645     # Optional: The voice channel, where people need to connect to (mandatory if force_voice is true). 
+    audit: 9182736459182736     # Optional: a server-specific audit channel (for those of you who like channels, all others can use the global one)
   chat_log:
     count: 10                   # A log file that holds the in-game chat to check for abuse. Tells how many files will be kept, default is 10.
     size: 1048576               # Max logfile size, default is 1 MB. 

core/data/const.py

@@ -39,6 +39,7 @@ class Channel(Enum):
     CHAT = 'chat'
     EVENTS = 'events'
     VOICE = 'voice'
+    AUDIT = 'audit'
     COALITION_BLUE_CHAT = 'blue'
     COALITION_BLUE_EVENTS = 'blue_events'
     COALITION_RED_CHAT = 'red'

core/data/server.py

@@ -396,6 +396,8 @@ def channels(self) -> dict[Channel, int]:
                 self._channels[Channel.EVENTS] = self._channels[Channel.CHAT]
             if Channel.VOICE not in self._channels:
                 self._channels[Channel.VOICE] = -1
+            if Channel.AUDIT not in self._channels:
+                self._channels[Channel.AUDIT] = -1
             if Channel.COALITION_BLUE_EVENTS not in self._channels and Channel.COALITION_BLUE_CHAT in self._channels:
                 self._channels[Channel.COALITION_BLUE_EVENTS] = self._channels[Channel.COALITION_BLUE_CHAT]
             if Channel.COALITION_RED_EVENTS not in self._channels and Channel.COALITION_RED_CHAT in self._channels:

core/utils/discord.py

@@ -966,7 +966,9 @@ async def transform(self, interaction: discord.Interaction, value: str | None) -
         """
         if value:
             server = interaction.client.servers.get(value)
-            if not server:
+            if not server or (
+                    server.locals.get('managed_by') and not utils.check_roles(server.locals.get('managed_by'), interaction.user)
+            ):
                 raise app_commands.TransformerError(value, self.type, self)
         else:
             server = interaction.client.get_server(interaction)
@@ -999,7 +1001,9 @@ async def autocomplete(self, interaction: discord.Interaction, current: str) ->
                 if (value.status != Status.UNREGISTERED and
                     (not self.status or value.status in self.status) and
                     (not self.maintenance or value.maintenance == self.maintenance) and
-                    (not current or current.casefold() in name.casefold()))
+                    (not value.locals.get('managed_by') or utils.check_roles(value.locals.get('managed_by'), interaction.user)) and
+                    (not current or current.casefold() in name.casefold())
+                )
             ]
             return choices[:25]
         except Exception as ex:
@@ -1258,40 +1262,40 @@ def _server_filter(server: Server) -> bool:
     return True
 
 
-async def server_selection(bus: ServiceBus,
-                           interaction: discord.Interaction | commands.Context, *, title: str,
-                           multi_select: bool | None = False,
-                           ephemeral: bool | None = True,
-                           filter_func: Callable[[Server], bool] = _server_filter
-                           ) -> Server | list[Server] | None:
-    """
-
-    """
-    all_servers = list(bus.servers.values())
-    if len(all_servers) == 0:
+async def server_selection(
+        bot: DCSServerBot,
+        interaction: discord.Interaction | commands.Context,
+        *,
+        title: str,
+        multi_select: bool | None = False,
+        ephemeral: bool | None = True,
+        filter_func: Callable[[Server], bool] = _server_filter
+) -> Server | list[Server] | None:
+    all_servers = bot.get_servers(manager=interaction.user if isinstance(interaction, discord.Interaction) else interaction.author)
+    if not all_servers:
         return []
     elif len(all_servers) == 1:
-        return [all_servers[0]]
+        return [next(iter(all_servers.values()))]
     if multi_select:
         max_values = len(all_servers)
     else:
         max_values = 1
     server: Server | None = None
     if isinstance(interaction, discord.Interaction):
-        server = interaction.client.get_server(interaction)
+        server = bot.get_server(interaction)
     s = await selection(interaction, title=title,
                         options=[
-                            SelectOption(label=x.name, value=str(idx), default=(
+                            SelectOption(label=x.name, value=x.name, default=(
                                 True if server and server == x else
                                 True if not server and idx == 0 else
                                 False
-                            )) for idx, x in enumerate(all_servers) if filter_func(x)
+                            )) for idx, x in enumerate(all_servers.values()) if filter_func(x)
                         ],
                         max_values=max_values, ephemeral=ephemeral)
     if isinstance(s, list):
-        return [all_servers[int(x)] for x in s]
+        return [all_servers[x] for x in s]
     elif s:
-        return all_servers[int(s)]
+        return all_servers[s]
     return None
 
 
@@ -1667,9 +1671,8 @@ async def get_server(message: discord.Message, channel_id: int | None = None) ->
             channel_id = bot.locals.get('channels', {}).get('admin')
 
         if not server and message.channel.id == channel_id:
-            bus = ServiceRegistry.get(ServiceBus)
             ctx = await bot.get_context(message)
-            server = await utils.server_selection(bus, ctx, title=_("To which server do you want to upload?"))
+            server = await utils.server_selection(bot, ctx, title=_("To which server do you want to upload?"))
             if not server:
                 await ctx.send(_('Upload aborted.'))
                 return None

plugins/admin/commands.py

@@ -765,17 +765,18 @@ async def _list(self, interaction: discord.Interaction):
         # noinspection PyUnresolvedReferences
         await interaction.response.defer(ephemeral=ephemeral)
         embed = discord.Embed(title=_("DCSServerBot Cluster Overview"), color=discord.Color.blue())
-        for name in self.node.all_nodes.keys():
+        for name, node in self.node.all_nodes.items():
             names = []
             instances = []
             status = []
-            for server in [server for server in self.bus.servers.values() if server.node.name == name]:
+            for server in [x for x in self.bot.servers.values() if x.node.name == node.name]:
                 instances.append(server.instance.name)
                 names.append(server.name)
                 status.append(server.status.name)
             if names:
+                # print the master in bold
                 title = f"**[{name}]**" if name == self.node.name else f"[{name}]"
-                if await server.node.upgrade_pending():
+                if await node.upgrade_pending():
                     embed.set_footer(text=_("🆕 Update available"))
                     title += " 🆕"
 
@@ -856,7 +857,7 @@ async def _node_offline(node_name: str):
             tasks = []
             if shutdown:
                 msg = await interaction.followup.send(_("Shutting down all servers on node {} ...").format(node_name))
-            for server in self.bus.servers.values():
+            for server in self.bot.servers.values():
                 if server.node.name == node_name:
                     server.maintenance = True
                     if shutdown:
@@ -909,7 +910,7 @@ async def _startup(server: Server):
 
         async def _node_online(node_name: str):
             next_startup = 0
-            for server in [x for x in self.bus.servers.values() if x.node.name == node_name]:
+            for server in [x for x in self.bot.servers.values() if x.node.name == node_name]:
                 if startup:
                     self.loop.call_later(delay=next_startup,
                                          callback=partial(asyncio.create_task, _startup(server)))
@@ -1189,7 +1190,7 @@ async def reload(self, interaction: discord.Interaction, plugin: str | None):
             else:
                 await interaction.followup.send(
                     _('One or more plugins could not be reloaded, check the log for details.'), ephemeral=ephemeral)
-        # for server in self.bus.servers.values():
+        # for server in self.bot.servers.values():
         #    if server.status == Status.STOPPED:
         #        await server.send_to_dcs({"command": "reloadScripts"})
 
@@ -1314,7 +1315,7 @@ async def on_message(self, message: discord.Message):
                 return
             try:
                 server = await utils.server_selection(
-                    self.bus, ctx, title=_("To which server do you want to upload this configuration to?"))
+                    self.bot, ctx, title=_("To which server do you want to upload this configuration to?"))
                 if not server:
                     await ctx.send(_('Aborted.'))
                     return

plugins/commands/commands.py

@@ -230,7 +230,7 @@ async def do_send(server: Server):
                     if rc:
                         ret.append(rc)
         else:
-            for server in self.bot.servers.values():
+            for server in self.bot.get_servers(manager=interaction.user).values():
                 rc = await do_send(server)
                 if rc:
                     ret.append(rc)

plugins/gamemaster/commands.py

@@ -156,7 +156,7 @@ async def broadcast(self, interaction: discord.Interaction, to: Literal['all', '
         ephemeral = utils.get_ephemeral(interaction)
         # noinspection PyUnresolvedReferences
         await interaction.response.defer(ephemeral=ephemeral)
-        for server in self.bot.servers.values():
+        for server in self.bot.get_servers(manager=interaction.user).values():
             if server.status != Status.RUNNING:
                 await interaction.followup.send(_('Message NOT sent to server {server} because it is {status}.'
                                                   ).format(server=server.display_name, status=server.status.name),
@@ -275,7 +275,7 @@ async def reset_coalitions(self, interaction: discord.Interaction):
             await interaction.followup.send('Aborted.', ephemeral=ephemeral)
             return
         try:
-            for server in self.bot.servers.values():
+            for server in self.bot.get_servers(manager=interaction.user).values():
                 if not server.locals.get('coalitions'):
                     continue
                 await self.eventlistener.reset_coalitions(server, True)
@@ -348,7 +348,7 @@ async def add(self, interaction: discord.Interaction):
         if await modal.wait():
             return
         try:
-            servers = await utils.server_selection(self.bus, interaction,
+            servers = await utils.server_selection(self.bot, interaction,
                                                    title=_("Select all servers for this campaign"),
                                                    multi_select=True, ephemeral=ephemeral)
             if not servers:
@@ -442,7 +442,7 @@ async def start(self, interaction: discord.Interaction, campaign: str):
         try:
             # noinspection PyUnresolvedReferences
             await interaction.response.defer(ephemeral=True)
-            servers = await utils.server_selection(self.bus, interaction,
+            servers = await utils.server_selection(self.bot, interaction,
                                                    title=_("Select all servers for this campaign"),
                                                    multi_select=True, ephemeral=ephemeral)
             if not isinstance(servers, list):

plugins/help/commands.py

@@ -219,18 +219,20 @@ async def help(self, interaction: discord.Interaction, cmd: str | None):
                                                         ephemeral=True)
         else:
             try:
-                # shall we display a custom report as greeting page?
+                # shall we display a custom report as a greeting page?
                 if os.path.exists(f'reports/{self.plugin_name}/{self.plugin_name}.json'):
                     report = Report(self.bot, self.plugin_name, filename=f'{self.plugin_name}.json')
-                    env: ReportEnv = await report.render(guild=self.bot.guilds[0],
-                                                         servers=[
-                                                             {
-                                                                 "display_name": x.display_name,
-                                                                 "password": x.settings['password'],
-                                                                 "status": x.status.name.title(),
-                                                                 "num_players": len(x.get_active_players())
-                                                             } for x in self.bot.servers.values()
-                                                         ])
+                    env: ReportEnv = await report.render(
+                        guild=self.bot.guilds[0],
+                        servers=[
+                            {
+                                "display_name": x.display_name,
+                                "password": x.settings['password'],
+                                "status": x.status.name.title(),
+                                "num_players": len(x.get_active_players())
+                            } for x in self.bot.servers.values()
+                        ]
+                    )
                     embed = env.embed
                     if env.filename:
                         # noinspection PyUnresolvedReferences
@@ -378,7 +380,7 @@ async def server_info_to_df(self) -> pd.DataFrame:
         columns = ['Node', 'Instance', 'Name', 'Password', 'Max Players', 'DCS Port', 'Bot Port']
         df = pd.DataFrame(columns=columns)
 
-        for server in self.bus.servers.values():
+        for server in self.bot.servers.values():
             server_dict = {
                 'Node': server.node.name,
                 'Instance': server.instance.name,

plugins/lotatc/commands.py

@@ -57,7 +57,7 @@ async def get_server(self, message: discord.Message) -> Server | None:
             return None
         try:
             return await utils.server_selection(
-                self.bus, ctx, title=_("To which server do you want to upload this transponder file to?"),
+                self.bot, ctx, title=_("To which server do you want to upload this transponder file to?"),
                 filter_func=self.lotatc_server_filter)
         except Exception as ex:
             self.log.exception(ex)

plugins/mission/commands.py

@@ -2089,6 +2089,8 @@ async def afk_check(self):
                     exemptions = config.get('exemptions', {})
                     if 'discord' in exemptions:
                         exemptions['discord'] = list(set(exemptions['discord']) | {"DCS Admin", "GameMaster"})
+                        if server.locals.get('managed_by'):
+                            exemptions['discord'].extend(server.locals.get('managed_by'))
                     if not player or player.check_exemptions(exemptions):
                         continue
                     if (datetime.now(timezone.utc) - dt).total_seconds() > max_time:
@@ -2163,7 +2165,7 @@ async def on_message(self, message: discord.Message):
                 channel = node.get('uploads', {}).get('channel')
                 if message.channel.id == channel:
                     server = next((
-                        server for server in self.bus.servers.values()
+                        server for server in self.bot.servers.values()
                         if server.instance.name == node_name
                     ), None)
                     break
@@ -2172,7 +2174,7 @@ async def on_message(self, message: discord.Message):
                     channel = instance.get('uploads', {}).get('channel')
                     if message.channel.id == channel:
                         server = next((
-                            server for server in self.bus.servers.values()
+                            server for server in self.bot.servers.values()
                             if server.instance.name == instance_name
                         ), None)
                         break