Implement 'forum' style modmail

Author: Taaku18

modmail/backends/common/models/settings_model.py

@@ -18,15 +18,15 @@ class SettingsModel(BaseModel):
     """Settings model for bot configuration.
 
     Attributes:
-        bot_id: Bot identifier.
+        bot_id: Bot ID.
         last_ran_version: Last version that the bot was run on; None indicates first run.
         last_ran_locale: Last locale used when running the bot.
         last_slash_synced_version: Last version in which slash commands were synced.
         last_slash_minimum_permission_int: Last minimum permission integer for slash commands.
-        main_category_id: Main category identifier.
-        fallback_category_id: Fallback category identifier.
-        log_channel_id: Log channel identifier.
-        storage_channel_id: Storage channel identifier.
+        main_category_or_forum_id: Main category or forum ID.
+        fallback_category_id: Fallback category ID.
+        log_channel_id: Log channel ID.
+        storage_channel_id: Storage channel ID.
         status: The bot's status.
         activity: The bot's activity.
     """
@@ -38,7 +38,7 @@ class SettingsModel(BaseModel):
     last_ran_locale: str | None = None  # The last locale the bot was run on
     last_slash_synced_version: str | None = None  # The last version the slash commands were synced on
     last_slash_minimum_permission_int: int | None = None  # The last minimum permission int for slash commands
-    main_category_id: int | None = None
+    main_category_or_forum_id: int | None = None
     fallback_category_id: int | None = None
     log_channel_id: int | None = None
     storage_channel_id: int | None = None

modmail/backends/mongodb/models/settings_model.py

@@ -47,7 +47,7 @@ class MongoDBSettingsDocument(Document):
         last_ran_locale: The locale setting used during the last run.
         last_slash_synced_version: The version when slash commands were last synchronized.
         last_slash_minimum_permission_int: The minimum permission integer required for using slash commands.
-        main_category_id: The ID of the main category for organizing channels.
+        main_category_or_forum_id: The ID of the main category or forum for organizing channels.
         fallback_category_id: The ID of the fallback category used when main is unavailable.
         log_channel_id: The ID of the log channel.
         storage_channel_id: The ID of the storage channel.
@@ -60,7 +60,7 @@ class MongoDBSettingsDocument(Document):
     last_ran_locale: str | None = None  # the last locale the bot was run on
     last_slash_synced_version: str | None = None  # the last version the slash commands were synced on
     last_slash_minimum_permission_int: int | None = None  # the last minimum permission int for slash commands
-    main_category_id: int | None = None
+    main_category_or_forum_id: int | None = None
     fallback_category_id: int | None = None
     log_channel_id: int | None = None
     storage_channel_id: int | None = None

modmail/backends/sql/migrations/versions/ec2d46746dcd_init.py

@@ -29,7 +29,7 @@ def upgrade() -> None:
         sa.Column("last_ran_locale", sa.String(length=8), nullable=True),
         sa.Column("last_slash_synced_version", sa.String(length=32), nullable=True),
         sa.Column("last_slash_minimum_permission_int", sa.Integer(), nullable=True),
-        sa.Column("main_category_id", sa.Integer(), nullable=True),
+        sa.Column("main_category_or_forum_id", sa.Integer(), nullable=True),
         sa.Column("fallback_category_id", sa.Integer(), nullable=True),
         sa.Column("log_channel_id", sa.Integer(), nullable=True),
         sa.Column("storage_channel_id", sa.Integer(), nullable=True),

modmail/backends/sql/models/settings_model.py

@@ -33,7 +33,7 @@ class SQLSettingsTable(SQLBase):
         last_ran_locale: The locale setting when the bot was last run (max 8 characters).
         last_slash_synced_version: The version when slash commands were last synchronized (max 32 characters).
         last_slash_minimum_permission_int: The minimum permission level required for slash commands.
-        main_category_id: The Discord category ID where new tickets are created.
+        main_category_or_forum_id: The Discord category or forum ID where new tickets are created.
         fallback_category_id: The backup Discord category ID for when the main category is full.
         log_channel_id: The Discord channel ID for the log channel.
         storage_channel_id: The Discord channel ID for the storage channel.
@@ -48,7 +48,7 @@ class SQLSettingsTable(SQLBase):
     last_ran_locale: Mapped[str | None] = mapped_column(String(8))
     last_slash_synced_version: Mapped[str | None] = mapped_column(String(32))
     last_slash_minimum_permission_int: Mapped[int | None]
-    main_category_id: Mapped[int | None]
+    main_category_or_forum_id: Mapped[int | None]
     fallback_category_id: Mapped[int | None]
     log_channel_id: Mapped[int | None]
     storage_channel_id: Mapped[int | None]

modmail/cogs/modmail/commands/close.py

@@ -61,7 +61,7 @@ async def close_command(
     if ctx.interaction is not None:
         await cog.reply(ctx, _("ftl-cmd-close-message-sending"), delete_after=3, ephemeral=True, auto_embed=False)
 
-    assert isinstance(ctx.channel, discord.abc.GuildChannel)
+    assert isinstance(ctx.channel, discord.TextChannel | discord.Thread)
     ticket = await cog.bot.staff_guild.get_ticket(ctx.channel)
     if ticket is None:
         raise ModmailError("Ticket should not be None here.")

modmail/cogs/modmail/commands/reply.py

@@ -71,7 +71,7 @@ async def reply_command(
     if ctx.interaction is not None:
         await cog.reply(ctx, _("flt-cmd-reply-message-sending"), delete_after=3, ephemeral=True, auto_embed=False)
 
-    assert isinstance(ctx.channel, discord.abc.GuildChannel)
+    assert isinstance(ctx.channel, discord.TextChannel | discord.Thread)
     ticket = await cog.bot.staff_guild.get_ticket(ctx.channel)
     if ticket is None:
         raise ModmailError("Ticket should not be None here.")

modmail/cogs/modmail/commands/sclose.py

@@ -60,7 +60,7 @@ async def sclose_command(
     if ctx.interaction is not None:
         await cog.reply(ctx, _("ftl-cmd-sclose-message-sending"), delete_after=3, ephemeral=True, auto_embed=False)
 
-    assert isinstance(ctx.channel, discord.abc.GuildChannel)
+    assert isinstance(ctx.channel, discord.TextChannel | discord.Thread)
     ticket = await cog.bot.staff_guild.get_ticket(ctx.channel)
     if ticket is None:
         raise ModmailError("Ticket should not be None here.")