Implement log channel

Author: Taaku18

README.md

@@ -8,6 +8,16 @@
 Please note that the database structure may change at any time, and database migrations between development versions are not available.
 You will need to drop the database when the structure changes.
 
+### Short-Term TODOs
+
+- [x] Forum implementation, alternative to category/channel structure
+- [x] Implement log channel message
+- [ ] Convert certain embeds to use component v2
+- [ ] "Custom locale" to allow overriding specific locale strings without editing language files
+- [ ] Proper pytest unit tests (see how other projects do it)
+- [ ] pyinstaller or nuitka compiled build, also with an installer
+- [ ] Message attachment support (linked attachment to storage channel)
+
 ## Acknowledgements
 
 The current release of Modmail (v5) is a complete rewrite of the original Modmail bot.

modmail/backends/common/client_base.py

@@ -198,9 +198,22 @@ async def create_ticket(self, ticket: TicketModel) -> None:
             ticket: The ticket object to create.
 
         Raises:
+            TicketCreationError: If a ticket with a duplicate key or channel.
             TicketRecipientOccupiedError: If the recipient is already in another open ticket.
         """
 
+    @abstractmethod
+    async def set_ticket_log_channel_message_id(self, ticket_key: str, message_id: int | None) -> None:
+        """Sets the log channel message ID for a ticket.
+
+        Args:
+            ticket_key: The key of the ticket.
+            message_id: The message ID to set, or None to clear it.
+
+        Raises:
+            TicketNotFoundError: If the ticket is not found.
+        """
+
     @abstractmethod
     async def save_message(self, ticket_message: TicketMessageModel) -> None:
         """Saves a message to the database.

modmail/backends/common/models/ticket_model.py

@@ -35,6 +35,7 @@ class TicketModel(BaseModel):
         status: The current status of the ticket (open, closed, etc.).
         closed_by: The user who closed the ticket (if applicable).
         closed_at: The timestamp when the ticket was closed (if applicable).
+        log_channel_message_id: The ID of the thread info message when sent to log channel.
         title: An optional title for the ticket.
         nsfw: A boolean indicating if the ticket is NSFW (not safe for work).
     """
@@ -53,6 +54,8 @@ class TicketModel(BaseModel):
     closed_at: datetime | None = None
     closed_by: TicketUserModel | None = None
 
+    log_channel_message_id: int | None = None
+
     status: TicketStatus
     title: str | None = None
     nsfw: bool = False

modmail/backends/mongodb/client.py

@@ -465,6 +465,32 @@ async def create_ticket(self, ticket: TicketModel) -> None:
             )
         logger.info("Created ticket %s for %s.", ticket.key, ticket.recipients)
 
+    async def set_ticket_log_channel_message_id(self, ticket_key: str, message_id: int | None) -> None:
+        """Sets the log channel message ID for a ticket.
+
+        Args:
+            ticket_key: The key of the ticket.
+            message_id: The message ID to set, or None to clear it.
+
+        Raises:
+            TicketNotFoundError: If the ticket is not found.
+        """
+        ticket_document = await MongoDBTicketDocument.find_one(
+            MongoDBTicketDocument.bot_id == self._config.bot.bot_id and MongoDBTicketDocument.key == ticket_key
+        )
+        if ticket_document is None:
+            raise TicketNotFoundError(f"Ticket with key {ticket_key} not found.")
+
+        ticket_document.log_channel_message_id = message_id
+        await ticket_document.replace()
+
+        # Update the cache if exists
+        cached_ticket = self.__open_tickets_cache.get(key=ticket_key)
+        if cached_ticket is not None:
+            cached_ticket.log_channel_message_id = message_id
+
+        logger.debug("Set log channel message ID for ticket %s to %s.", ticket_key, message_id)
+
     async def get_ticket_by_channel(self, channel_id: int, *, only_open: bool = True) -> TicketModel | None:
         """Get a ticket by channel ID.
 

modmail/backends/mongodb/convert.py

@@ -111,6 +111,7 @@ async def ticket_model_to_document(ticket: TicketModel) -> MongoDBTicketDocument
         created_by=created_by,
         closed_at=ticket.closed_at,
         closed_by=closed_by,
+        log_channel_message_id=ticket.log_channel_message_id,
         status=ticket.status,
         title=ticket.title,
         nsfw=ticket.nsfw,

modmail/backends/mongodb/models/ticket_model.py

@@ -36,6 +36,7 @@ class MongoDBTicketDocument(Document):
         status: The current status of the ticket (open, closed, etc.).
         closed_by: The user who closed the ticket (if applicable).
         closed_at: The timestamp when the ticket was closed (if applicable).
+        log_channel_message_id: The ID of the thread info message when sent to log channel.
         title: An optional title for the ticket.
         nsfw: A boolean indicating if the ticket is NSFW (not safe for work).
     """
@@ -52,6 +53,8 @@ class MongoDBTicketDocument(Document):
     closed_at: datetime | None = None
     closed_by: Link[MongoDBTicketUserDocument] | None = None
 
+    log_channel_message_id: int | None = None
+
     status: TicketStatus
     title: str | None = None
     nsfw: bool = False
@@ -98,6 +101,7 @@ async def get_model(self) -> TicketModel:
             status=self.status,
             closed_by=closed_by,
             closed_at=self.closed_at,
+            log_channel_message_id=self.log_channel_message_id,
             title=self.title,
             nsfw=self.nsfw,
         )

modmail/backends/sql/client.py

@@ -537,6 +537,7 @@ async def create_ticket(self, ticket: TicketModel) -> None:
                 created_by_id=ticket.created_by.user_id,
                 closed_at=ticket.closed_at,
                 closed_by_id=ticket.closed_by.user_id if ticket.closed_by else None,
+                log_channel_message_id=ticket.log_channel_message_id,
                 status=ticket.status,
                 title=ticket.title,
                 nsfw=ticket.nsfw,
@@ -563,6 +564,39 @@ async def create_ticket(self, ticket: TicketModel) -> None:
                 self.__open_tickets_cache.add(ticket_row, key=ticket_row.key, channel_id=ticket_row.channel_id)
         logger.info("Created ticket %s for %s.", ticket.key, ticket.recipients)
 
+    async def set_ticket_log_channel_message_id(self, ticket_key: str, message_id: int | None) -> None:
+        """Sets the log channel message ID for a ticket.
+
+        Args:
+            ticket_key: The key of the ticket.
+            message_id: The message ID to set, or None to clear it.
+
+        Raises:
+            TicketNotFoundError: If the ticket is not found.
+        """
+        assert self._async_session is not None, "Session is not initialized."
+        async with self._async_session() as session:
+            query = select(SQLTicketTable).where(
+                and_(
+                    SQLTicketTable.bot_id == self._config.bot.bot_id,
+                    SQLTicketTable.key == ticket_key,
+                )
+            )
+            result = await session.execute(query)
+            ticket_row = result.scalar_one_or_none()
+            if ticket_row is None:
+                raise TicketNotFoundError(f"Ticket with key {ticket_key} not found.")
+
+            ticket_row.log_channel_message_id = message_id
+            await session.commit()
+
+            # Update the cache if exists
+            cached_ticket = self.__open_tickets_cache.get(key=ticket_key)
+            if cached_ticket is not None:
+                cached_ticket.log_channel_message_id = message_id
+
+        logger.debug("Set log channel message ID for ticket %s to %s.", ticket_key, message_id)
+
     async def get_ticket_by_channel(self, channel_id: int, *, only_open: bool = True) -> TicketModel | None:
         """Get a ticket by channel ID.
 

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

@@ -94,6 +94,7 @@ def upgrade() -> None:
             sa.Enum("open", "closed_by_command", "closed_by_deletion", name="ticketstatus"),
             nullable=False,
         ),
+        sa.Column("log_channel_message_id", sa.Integer(), nullable=True),
         sa.Column("title", sa.String(), nullable=True),
         sa.Column("nsfw", sa.Boolean(), nullable=False),
         sa.ForeignKeyConstraint(

modmail/backends/sql/models/ticket_model.py

@@ -38,6 +38,7 @@ class SQLTicketTable(SQLBase):
         status: The current status of the ticket (open, closed, etc.).
         closed_by: The user who closed the ticket (if applicable).
         closed_at: The timestamp when the ticket was closed (if applicable).
+        log_channel_message_id: The ID of the thread info message when sent to log channel.
         title: An optional title for the ticket.
         nsfw: A boolean indicating if the ticket is NSFW (not safe for work).
     """
@@ -64,6 +65,8 @@ class SQLTicketTable(SQLBase):
     )
     closed_by: Mapped[SQLTicketUserTable | None] = relationship(foreign_keys=[closed_by_id], lazy="joined")
 
+    log_channel_message_id: Mapped[int | None]
+
     status: Mapped[TicketStatus]
     title: Mapped[str | None]
     nsfw: Mapped[bool] = mapped_column(default=False)
@@ -90,6 +93,7 @@ async def get_model(self) -> TicketModel:
             status=self.status,
             closed_by=closed_by,
             closed_at=self.closed_at,
+            log_channel_message_id=self.log_channel_message_id,
             title=self.title,
             nsfw=self.nsfw,
         )

modmail/cogs/modmail/commands/close.py

@@ -90,5 +90,6 @@ async def close_command(
                 logger.info("Failed to delete the message after closing in %s: %s", ctx.channel, e)
     finally:
         # Close the ticket
-        await ticket.close(ctx.author, TicketStatus.closed_by_command)
-    # TODO: delete channel, create auto delete after close config
+        await cog.bot.staff_guild.close_ticket(
+            ticket.model, closer=ctx.author, close_status=TicketStatus.closed_by_command
+        )