move format_channel_name to Bot, resolve #2982

Author: fourjr

CHANGELOG.md

@@ -6,14 +6,14 @@ 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 plugin developer, note the "BREAKING" section.
 
-# v3.10.0-dev6
+# v3.10.0-dev7
 
 v3.10 adds group conversations while resolving other bugs and QOL changes. It is potentially breaking to some plugins that adds functionality to threads.
 
 ### Breaking
 
 - `Thread.recipient` (`str`) is now `Thread.recipients` (`List[str]`).
-- `thread.reply` now returns mod_message, user_message1, user_message2... It is no longer limited at a size 2 tuple.
+- `Thread.reply` now returns mod_message, user_message1, user_message2... It is no longer limited at a size 2 tuple.
 
 ### Added
 
@@ -41,6 +41,7 @@ v3.10 adds group conversations while resolving other bugs and QOL changes. It is
 
 - Fix return types, type hints and unresolved references ([PR #3009](https://github.com/kyb3r/modmail/pull/3009))
 - Reload thread cache only when it's the first on_ready trigger. ([GH #3037](https://github.com/kyb3r/modmail/issues/3037))
+- `format_channel_name` is now extendable to plugins. Modify `Bot.format_channel_name(bot, author, exclude_channel=None, force_null=False):`. ([GH #2982](https://github.com/kyb3r/modmail/issues/2982))
 
 # v3.9.5
 

bot.py

@@ -1,4 +1,4 @@
-__version__ = "v3.10.0-dev6"
+__version__ = "3.10.0-dev7"
 
 
 import asyncio
@@ -1645,6 +1645,36 @@ async def before_autoupdate(self):
             logger.warning("Autoupdates disabled.")
             self.autoupdate_loop.cancel()
 
+    def format_channel_name(self, author, exclude_channel=None, force_null=False):
+        """Sanitises a username for use with text channel names
+
+        Placed in main bot class to be extendable to plugins"""
+        guild = self.modmail_guild
+
+        if force_null:
+            name = new_name = "null"
+        else:
+            if self.config["use_user_id_channel_name"]:
+                name = new_name = str(author.id)
+            elif self.config["use_timestamp_channel_name"]:
+                name = new_name = author.created_at.isoformat(sep="-", timespec="minutes")
+            else:
+                name = author.name.lower()
+                if force_null:
+                    name = "null"
+
+                name = new_name = (
+                    "".join(l for l in name if l not in string.punctuation and l.isprintable()) or "null"
+                ) + f"-{author.discriminator}"
+
+        counter = 1
+        existed = set(c.name for c in guild.text_channels if c != exclude_channel)
+        while new_name in existed:
+            new_name = f"{name}_{counter}"  # multiple channels with same name
+            counter += 1
+
+        return new_name
+
 
 def main():
     try:

cogs/modmail.py

@@ -1829,7 +1829,7 @@ async def repair(self, ctx):
             )
             if len(users) == 1:
                 user = users.pop()
-                name = format_channel_name(self.bot, user, exclude_channel=ctx.channel)
+                name = self.bot.format_channel_name(user, exclude_channel=ctx.channel)
                 recipient = self.bot.get_user(user.id)
                 if user.id in self.bot.threads.cache:
                     thread = self.bot.threads.cache[user.id]

core/utils.py

@@ -30,7 +30,6 @@
     "format_description",
     "trigger_typing",
     "escape_code_block",
-    "format_channel_name",
     "tryint",
     "get_top_hoisted_role",
     "get_joint_id",
@@ -364,35 +363,6 @@ def escape_code_block(text):
     return re.sub(r"```", "`\u200b``", text)
 
 
-def format_channel_name(bot, author, exclude_channel=None, force_null=False):
-    """Sanitises a username for use with text channel names"""
-    guild = bot.modmail_guild
-
-    if force_null:
-        name = new_name = "null"
-    else:
-        if bot.config["use_user_id_channel_name"]:
-            name = new_name = str(author.id)
-        elif bot.config["use_timestamp_channel_name"]:
-            name = new_name = author.created_at.isoformat(sep="-", timespec="minutes")
-        else:
-            name = author.name.lower()
-            if force_null:
-                name = "null"
-
-            name = new_name = (
-                "".join(l for l in name if l not in string.punctuation and l.isprintable()) or "null"
-            ) + f"-{author.discriminator}"
-
-    counter = 1
-    existed = set(c.name for c in guild.text_channels if c != exclude_channel)
-    while new_name in existed:
-        new_name = f"{name}_{counter}"  # multiple channels with same name
-        counter += 1
-
-    return new_name
-
-
 def tryint(x):
     try:
         return int(x)
@@ -408,7 +378,7 @@ def get_top_hoisted_role(member: discord.Member):
 
 
 async def create_thread_channel(bot, recipient, category, overwrites, *, name=None, errors_raised=[]):
-    name = name or format_channel_name(bot, recipient)
+    name = name or bot.format_channel_name(recipient)
     try:
         channel = await bot.modmail_guild.create_text_channel(
             name=name,
@@ -446,7 +416,7 @@ async def create_thread_channel(bot, recipient, category, overwrites, *, name=No
                 recipient,
                 category,
                 overwrites,
-                name=format_channel_name(bot, recipient, force_null=True),
+                name=bot.format_channel_name(recipient, force_null=True),
                 errors_raised=errors_raised,
             )