CHANGES:

- GameMaster: Campaigns can have an icon now.
- GameMaster: /campaign edit added

Author: karel26

core/utils/campaigns.py

@@ -46,7 +46,8 @@ async def get_campaign(self, campaign: str) -> dict:
     async with self.apool.connection() as conn:
         async with conn.cursor(row_factory=dict_row) as cursor:
             await cursor.execute("""
-                SELECT id, name, description, start AT TIME ZONE 'UTC' AS start, stop AT TIME ZONE 'UTC' AS stop 
+                SELECT id, name, description, image_url, 
+                       start AT TIME ZONE 'UTC' AS start, stop AT TIME ZONE 'UTC' AS stop 
                 FROM campaigns 
                 WHERE name = %s 
             """, (campaign, ))

core/utils/discord.py

@@ -273,13 +273,15 @@ def __init__(self):
         super().__init__(timeout=120)
         self.result = None
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label='Yes', style=ButtonStyle.green, custom_id='yn_yes')
     async def on_yes(self, interaction: Interaction, _: Button):
         # noinspection PyUnresolvedReferences
         await interaction.response.defer()
         self.result = True
         self.stop()
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label='No', style=ButtonStyle.red, custom_id='yn_no')
     async def on_no(self, interaction: Interaction, _: Button):
         # noinspection PyUnresolvedReferences
@@ -330,20 +332,23 @@ def __init__(self):
         super().__init__(timeout=120)
         self.result = None
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label='Yes', style=ButtonStyle.green, custom_id='pl_yes')
     async def on_yes(self, interaction: Interaction, _: Button):
         # noinspection PyUnresolvedReferences
         await interaction.response.defer()
         self.result = 'yes'
         self.stop()
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label='Later', style=ButtonStyle.primary, custom_id='pl_later', emoji='⏱')
     async def on_later(self, interaction: Interaction, _: Button):
         # noinspection PyUnresolvedReferences
         await interaction.response.defer()
         self.result = 'later'
         self.stop()
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label='Cancel', style=ButtonStyle.red, custom_id='pl_cancel')
     async def on_cancel(self, interaction: Interaction, _: Button):
         # noinspection PyUnresolvedReferences
@@ -1420,12 +1425,14 @@ async def on_select(self, interaction: discord.Interaction, select: Select):
         except Exception as ex:
             interaction.client.log.exception(ex)
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label="Upload", style=ButtonStyle.green, row=2)
     async def on_upload(self, interaction: discord.Interaction, button: Button):
         # noinspection PyUnresolvedReferences
         await interaction.response.defer()
         self.stop()
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label="Up", style=ButtonStyle.secondary)
     async def on_up(self, interaction: discord.Interaction, button: Button):
         # noinspection PyUnresolvedReferences
@@ -1434,6 +1441,7 @@ async def on_up(self, interaction: discord.Interaction, button: Button):
             self.dir = os.path.dirname(self.dir)
             await self.refresh(interaction)
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label="Create", style=ButtonStyle.primary)
     async def on_create(self, interaction: discord.Interaction, button: Button):
         class TextModal(Modal, title="Create Directory"):
@@ -1456,6 +1464,7 @@ async def on_submit(derived, interaction: discord.Interaction) -> None:
                 self.dir = modal.name.value
             await self.refresh(interaction)
 
+    # noinspection PyTypeChecker
     @discord.ui.button(label="Cancel", style=ButtonStyle.red, row=2)
     async def on_cancel(self, interaction: discord.Interaction, button: Button):
         # noinspection PyUnresolvedReferences

plugins/gamemaster/commands.py

@@ -306,17 +306,45 @@ async def info(self, interaction: discord.Interaction, campaign: str):
         # noinspection PyUnresolvedReferences
         await interaction.response.send_message(embed=env.embed, ephemeral=utils.get_ephemeral(interaction))
 
+    @campaign.command(description=_("Edit Campaign"))
+    @app_commands.guild_only()
+    @utils.app_has_role('DCS Admin')
+    @app_commands.autocomplete(campaign=utils.campaign_autocomplete)
+    async def edit(self, interaction: discord.Interaction, campaign: str):
+        ephemeral = utils.get_ephemeral(interaction)
+        async with self.apool.connection() as conn:
+            async with conn.cursor(row_factory=dict_row) as cursor:
+                await cursor.execute("""
+                    SELECT * FROM campaigns WHERE name = %s
+                """, (campaign, ))
+                row = await cursor.fetchone()
+                if not row:
+                    # noinspection PyUnresolvedReferences
+                    await interaction.response.send_message(_('Campaign not found.'), ephemeral=True)
+                    return
+                modal = CampaignModal(name=campaign, start=row['start'], end=row['stop'], description=row['description'],
+                                      image_url=row['image_url'])
+                # noinspection PyUnresolvedReferences
+                await interaction.response.send_modal(modal)
+                if await modal.wait():
+                    return
+                async with conn.transaction():
+                    await conn.execute("""
+                        UPDATE campaigns SET start=%s, stop=%s, description=%s, image_url=%s 
+                        WHERE name=%s
+                    """, (modal.start, modal.end, modal.description.value, modal.image_url.value, campaign))
+                await interaction.followup.send(_('Campaign {} updated.').format(campaign),
+                                                        ephemeral=ephemeral)
+
     @campaign.command(description=_("Add a campaign"))
     @app_commands.guild_only()
     @utils.app_has_role('DCS Admin')
     async def add(self, interaction: discord.Interaction):
         ephemeral = utils.get_ephemeral(interaction)
-        modal = CampaignModal(self.eventlistener)
+        modal = CampaignModal()
         # noinspection PyUnresolvedReferences
         await interaction.response.send_modal(modal)
         if await modal.wait():
-            # noinspection PyUnresolvedReferences
-            await interaction.response.send_message(_('Aborted.'), ephemeral=True)
             return
         try:
             servers = await utils.server_selection(self.bus, interaction,
@@ -328,8 +356,15 @@ async def add(self, interaction: discord.Interaction):
             if not isinstance(servers, list):
                 servers = [servers]
             try:
-                await self.eventlistener.campaign('add', servers=servers, name=modal.name.value,
-                                                  description=modal.description.value, start=modal.start, end=modal.end)
+                await self.eventlistener.campaign(
+                    'add',
+                    servers=servers,
+                    name=modal.name.value,
+                    description=modal.description.value,
+                    image_url=modal.image_url.value,
+                    start=modal.start,
+                    end=modal.end
+                )
                 await interaction.followup.send(_("Campaign {} added.").format(modal.name.value), ephemeral=ephemeral)
             except psycopg.errors.ExclusionViolation:
                 await interaction.followup.send(_("A campaign is already configured for this timeframe!"),

plugins/gamemaster/db/tables.sql

@@ -1,5 +1,5 @@
 CREATE EXTENSION IF NOT EXISTS btree_gist;
-CREATE TABLE IF NOT EXISTS campaigns (id SERIAL PRIMARY KEY, name TEXT NOT NULL, description TEXT, start TIMESTAMP NOT NULL DEFAULT (now() AT TIME ZONE 'utc'), stop TIMESTAMP);
+CREATE TABLE IF NOT EXISTS campaigns (id SERIAL PRIMARY KEY, name TEXT NOT NULL, description TEXT, image_url TEXT, start TIMESTAMP NOT NULL DEFAULT (now() AT TIME ZONE 'utc'), stop TIMESTAMP);
 CREATE TABLE IF NOT EXISTS campaigns_servers (campaign_id INTEGER NOT NULL, server_name TEXT NOT NULL, PRIMARY KEY (campaign_id, server_name));
 ALTER TABLE campaigns ADD CONSTRAINT campaigns_prevent_double EXCLUDE USING gist(tsrange(start, stop, '[)') WITH &&);
 ALTER TABLE campaigns ADD CONSTRAINT campaigns_check_start_before_stop CHECK (start < stop);

plugins/gamemaster/db/update_v3.4.sql

@@ -0,0 +1 @@
+ALTER TABLE campaigns ADD image_url TEXT;

plugins/gamemaster/listener.py

@@ -175,20 +175,25 @@ async def onMissionEvent(self, server: Server, data: dict) -> None:
             asyncio.create_task(self.send_player_message(player))
 
     async def campaign(self, command: str, *, servers: Optional[list[Server]] = None, name: Optional[str] = None,
-                       description: Optional[str] = None, start: Optional[datetime] = None,
-                       end: Optional[datetime] = None):
+                       description: Optional[str] = None, image_url: Optional[str] = None,
+                       start: Optional[datetime] = None, end: Optional[datetime] = None):
         async with self.apool.connection() as conn:
             async with conn.transaction():
                 if command == 'add':
-                    await conn.execute('INSERT INTO campaigns (name, description, start, stop) VALUES (%s, %s, %s, %s)',
-                                       (name, description, start, end))
+                    await conn.execute("""
+                        INSERT INTO campaigns (name, description, image_url, start, stop) 
+                        VALUES (%s, %s, %s, %s, %s)
+                    """, (name, description, image_url, start, end))
                     if servers:
                         cursor = await conn.execute('SELECT id FROM campaigns WHERE name ILIKE %s', (name,))
                         campaign_id = (await cursor.fetchone())[0]
                         for server in servers:
                             # add this server to the server list
-                            await conn.execute('INSERT INTO campaigns_servers VALUES (%s, %s) ON CONFLICT DO NOTHING',
-                                               (campaign_id, server.name))
+                            await conn.execute("""
+                                INSERT INTO campaigns_servers 
+                                VALUES (%s, %s) 
+                                ON CONFLICT DO NOTHING
+                            """, (campaign_id, server.name))
                 elif command == 'start':
                     cursor = await conn.execute("""
                         SELECT id FROM campaigns WHERE name ILIKE %s 

plugins/gamemaster/reports/campaign.json

@@ -1,6 +1,7 @@
 {
   "color": "blue",
   "title": "{title}",
+  "img": "{campaign[image_url]}",
   "elements":
   [
     {
@@ -24,7 +25,12 @@
         "inline": false
       }
     },
-    "Ruler",
+    {
+      "type": "Ruler",
+      "params": {
+        "ruler_length": 28
+      }
+    },
     {
       "type": "SQLTable",
       "params": {

plugins/gamemaster/version.py

@@ -1 +1 @@
-__version__ = "3.4"
+__version__ = "3.5"

plugins/gamemaster/views.py

@@ -3,7 +3,7 @@
 from core import Server, get_translation, utils
 from datetime import datetime, timezone
 from discord import TextStyle, ButtonStyle
-from discord.ui import Modal, TextInput, View
+from discord.ui import Modal, TextInput, View, TextDisplay, Label
 from typing import Union, Optional
 
 from .listener import GameMasterEventListener
@@ -20,26 +20,38 @@ class CampaignModal(Modal):
     end = TextInput(label=_("End (UTC)"), placeholder="yyyy-mm-dd hh24:mi", required=False)
     # noinspection PyTypeChecker
     description = TextInput(label=_("Description"), required=False, style=TextStyle.long)
+    # noinspection PyTypeChecker
+    image_url = TextInput(label=_("Image URL"), required=False, style=TextStyle.short)
 
-    def __init__(self, eventlistener: GameMasterEventListener):
+    def __init__(self, name: Optional[str] = None, start: Optional[datetime] = None, end: Optional[datetime] = None,
+                 description: Optional[str] = None, image_url: Optional[str] = None):
         super().__init__(title=_("Campaign Info"))
-        self.eventlistener = eventlistener
-        self.start.default = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M")
+        if name:
+            self.remove_item(self.name)
+            self.title = _("Edit Campaign {}".format(name))
+        if start:
+            self.start.default = start.strftime("%Y-%m-%d %H:%M")
+        else:
+            self.start.default = datetime.now(timezone.utc).strftime("%Y-%m-%d %H:%M")
+        if end:
+            self.end.default = end.strftime("%Y-%m-%d %H:%M")
+        self.description.default = description
+        self.image_url.default = image_url
 
     async def on_submit(self, interaction: discord.Interaction) -> None:
         try:
             self.start = datetime.strptime(self.start.value, '%Y-%m-%d %H:%M')
         except ValueError:
             # noinspection PyUnresolvedReferences
             await interaction.response.send_message(
-                _("Format for {} needs to be yyyy-mm-dd hh24:mi!").format(self.start.label), ephemeral=True)
+                _("Format for {} needs to be yyyy-mm-dd hh24:mi!").format(self.start.value), ephemeral=True)
             raise
         try:
             self.end = datetime.strptime(self.end.value, '%Y-%m-%d %H:%M') if self.end.value else None
         except ValueError:
             # noinspection PyUnresolvedReferences
             await interaction.response.send_message(
-                _("Format for {} needs to be yyyy-mm-dd hh24:mi!").format(self.end.label), ephemeral=True)
+                _("Format for {} needs to be yyyy-mm-dd hh24:mi!").format(self.end.value), ephemeral=True)
             raise
         # noinspection PyUnresolvedReferences
         await interaction.response.defer()