Add support for thread titles, resolve #2838

Author: fourjr

CHANGELOG.md

@@ -6,7 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 This project mostly adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html);
 however, insignificant breaking changes do not guarantee a major version bump, see the reasoning [here](https://github.com/kyb3r/modmail/issues/319). If you're a plugins developer, note the "BREAKING" section.
 
-# v3.7.0-dev7
+# v3.7.0-dev8
 
 ### Added
 
@@ -24,6 +24,7 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - Added `cooldown_thread_title`, `cooldown_thread_response` to customise message sent when user is on a creating thread cooldown. ([GH #2865](https://github.com/kyb3r/modmail/issues/2865))
 - Added `?selfcontact` to allow users to open a thread. ([GH #2762](https://github.com/kyb3r/modmail/issues/2762))
 - Support stickers and reject non-messages (i.e. pin_add)
+- Add support for thread titles, `?title` ([GH #2838](https://github.com/kyb3r/modmail/issues/2838))
 
 ### Fixed
 

bot.py

@@ -1,4 +1,4 @@
-__version__ = "3.7.0-dev7"
+__version__ = "3.7.0-dev8"
 
 
 import asyncio
@@ -32,7 +32,7 @@
 from core import checks
 from core.clients import ApiClient, PluginDatabaseClient, MongoDBClient
 from core.config import ConfigManager
-from core.utils import human_join, normalize_alias
+from core.utils import human_join, match_title, normalize_alias
 from core.models import PermissionLevel, SafeFormatter, getLogger, configure_logging
 from core.thread import ThreadManager
 from core.time import human_timedelta
@@ -458,6 +458,7 @@ async def on_ready(self):
                     log["channel_id"],
                     {
                         "open": False,
+                        "title": match_title(thread.channel.topic),
                         "closed_at": str(datetime.utcnow()),
                         "close_message": "Channel has been deleted, no closer found.",
                         "closer": {

cogs/modmail.py

@@ -646,6 +646,15 @@ def format_log_embeds(self, logs, avatar_url):
             embeds.append(embed)
         return embeds
 
+
+    @commands.command()
+    @checks.thread_only()
+    async def title(self, ctx, *, name: str):
+        await ctx.thread.set_title(name)
+        sent_emoji, _ = await self.bot.retrieve_emoji()
+        await self.bot.add_reaction(ctx.message, sent_emoji)
+
+
     @commands.group(invoke_without_command=True)
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     async def logs(self, ctx, *, user: User = None):

core/thread.py

@@ -12,7 +12,7 @@
 
 from core.models import getLogger
 from core.time import human_timedelta
-from core.utils import is_image_url, days, match_user_id, truncate, format_channel_name
+from core.utils import is_image_url, days, match_title, match_user_id, truncate, format_channel_name
 
 logger = getLogger(__name__)
 
@@ -334,6 +334,7 @@ async def _close(
                 self.channel.id,
                 {
                     "open": False,
+                    "title": match_title(self.channel.topic),
                     "closed_at": str(datetime.utcnow()),
                     "nsfw": self.channel.nsfw,
                     "close_message": message if not silent else None,
@@ -346,14 +347,18 @@ async def _close(
                     },
                 },
             )
+        else:
+            log_data = None
 
         if isinstance(log_data, dict):
             prefix = self.bot.config["log_url_prefix"].strip("/")
             if prefix == "NONE":
                 prefix = ""
             log_url = f"{self.bot.config['log_url'].strip('/')}{'/' + prefix if prefix else ''}/{log_data['key']}"
 
-            if log_data["messages"]:
+            if log_data["title"]:
+                sneak_peak = log_data["title"]
+            elif log_data["messages"]:
                 content = str(log_data["messages"][0]["content"])
                 sneak_peak = content.replace("\n", "")
             else:
@@ -931,6 +936,9 @@ def get_notifications(self) -> str:
 
         return " ".join(mentions)
 
+    async def set_title(self, title) -> None:
+        user_id = match_user_id(self.channel.topic)
+        await self.channel.edit(topic=f'Title: {title}\nUser ID: {user_id}')
 
 class ThreadManager:
     """Class that handles storing, finding and creating Modmail threads."""

core/utils.py

@@ -216,9 +216,28 @@ def cleanup_code(content: str) -> str:
     return content.strip("` \n")
 
 
-TOPIC_REGEX = re.compile(r"\bUser ID:\s*(\d{17,21})\b", flags=re.IGNORECASE)
+TOPIC_TITLE_REGEX = re.compile(r"\bTitle: (.*)\n(?:User ID: )\b", flags=re.IGNORECASE | re.DOTALL)
+TOPIC_UID_REGEX = re.compile(r"\bUser ID:\s*(\d{17,21})\b", flags=re.IGNORECASE)
 
 
+def match_title(text: str) -> int:
+    """
+    Matches a title in the foramt of "Title: XXXX"
+
+    Parameters
+    ----------
+    text : str
+        The text of the user ID.
+
+    Returns
+    -------
+    Optional[str]
+        The title if found
+    """
+    match = TOPIC_TITLE_REGEX.search(text)
+    if match is not None:
+        return match.group(1)
+
 def match_user_id(text: str) -> int:
     """
     Matches a user ID in the format of "User ID: 12345".
@@ -233,7 +252,7 @@ def match_user_id(text: str) -> int:
     int
         The user ID if found. Otherwise, -1.
     """
-    match = TOPIC_REGEX.search(text)
+    match = TOPIC_UID_REGEX.search(text)
     if match is not None:
         return int(match.group(1))
     return -1