feat minimum character requirement for thread creation. (#3380)

Author: lorenzo132

cogs/modmail.py

@@ -1637,6 +1637,7 @@ async def contact(
             creator=creator,
             category=category,
             manual_trigger=manual_trigger,
+            # The minimum character check is enforced in ThreadManager.create
         )
 
         if thread.cancelled:

core/_color_data.py

@@ -3,7 +3,6 @@
 Slightly modified to conform with usage.
 """
 
-
 BASE_COLORS = {
     "b": "0000ff",
     "g": "007f00",

core/config.py

@@ -129,6 +129,11 @@ class ConfigManager:
         # regex
         "use_regex_autotrigger": False,
         "use_hoisted_top_role": True,
+        # Minimum characters for thread creation
+        "thread_min_characters": 0,
+        "thread_min_characters_title": "Message too short",
+        "thread_min_characters_response": "Your message is too short to create a thread. Please provide more details.",
+        "thread_min_characters_footer": "Minimum {min_characters} characters required.",
     }
 
     private_keys = {

core/config_help.json

@@ -1222,5 +1222,48 @@
       "If this configuration is enabled, only roles that are hoisted (displayed seperately in member list) will be used. If a user has no hoisted roles, it will return 'None'.",
       "If you would like to display the top role of a user regardless of if it's hoisted or not, disable `use_hoisted_top_role`."
     ]
+  },
+  "thread_min_characters": {
+    "default": "0",
+    "description": "The minimum number of characters required in the initial message to create a thread. Set to 0 to disable.",
+    "examples": [
+      "`{prefix}config set thread_min_characters 20`"
+    ],
+    "notes": [
+      "If a user tries to create a thread with a message shorter than this, an error will be shown.",
+      "See also: `thread_min_characters_title`, `thread_min_characters_response`, `thread_min_characters_footer`."
+    ]
+  },
+  "thread_min_characters_title": {
+    "default": "Message too short",
+    "description": "The title of the error embed when a user tries to create a thread with too few characters.",
+    "examples": [
+      "`{prefix}config set thread_min_characters_title Too short!`"
+    ],
+    "notes": [
+      "See also: `thread_min_characters`, `thread_min_characters_response`, `thread_min_characters_footer`."
+    ]
+  },
+  "thread_min_characters_response": {
+    "default": "Your message is too short to create a thread. Please provide more details.",
+    "description": "The description of the error embed when a user tries to create a thread with too few characters.",
+    "examples": [
+      "`{prefix}config set thread_min_characters_response Please write a longer message.`"
+    ],
+    "notes": [
+      "You can use `{min_characters}` as a placeholder for the minimum required characters.",
+      "See also: `thread_min_characters`, `thread_min_characters_title`, `thread_min_characters_footer`."
+    ]
+  },
+  "thread_min_characters_footer": {
+    "default": "Minimum {min_characters} characters required.",
+    "description": "The footer of the error embed when a user tries to create a thread with too few characters.",
+    "examples": [
+      "`{prefix}config set thread_min_characters_footer At least {min_characters} characters needed.`"
+    ],
+    "notes": [
+      "You can use `{min_characters}` as a placeholder for the minimum required characters.",
+      "See also: `thread_min_characters`, `thread_min_characters_title`, `thread_min_characters_response`."
+    ]
   }
-}
+}

core/thread.py

@@ -1406,6 +1406,33 @@ async def create(
     ) -> Thread:
         """Creates a Modmail thread"""
 
+        # Minimum character check
+        min_chars = self.bot.config.get("thread_min_characters")
+        if min_chars is None:
+            min_chars = 0
+        try:
+            min_chars = int(min_chars)
+        except ValueError:
+            min_chars = 0
+        if min_chars > 0 and message is not None and message.content is not None:
+            if len(message.content.strip()) < min_chars:
+                embed = discord.Embed(
+                    title=self.bot.config["thread_min_characters_title"],
+                    description=self.bot.config["thread_min_characters_response"].replace(
+                        "{min_characters}", str(min_chars)
+                    ),
+                    color=self.bot.error_color,
+                )
+                embed.set_footer(
+                    text=self.bot.config["thread_min_characters_footer"].replace(
+                        "{min_characters}", str(min_chars)
+                    )
+                )
+                await message.channel.send(embed=embed)
+                thread = Thread(self, recipient)
+                thread.cancelled = True
+                return thread
+
         # checks for existing thread in cache
         thread = self.cache.get(recipient.id)
         if thread:

core/time.py

@@ -3,6 +3,7 @@
 Source:
 https://github.com/Rapptz/RoboDanny/blob/rewrite/cogs/utils/time.py
 """
+
 from __future__ import annotations
 
 import datetime

core/utils.py

@@ -370,7 +370,7 @@ def create_not_found_embed(word, possibilities, name, n=2, cutoff=0.6) -> discor
 
 def parse_alias(alias, *, split=True):
     def encode_alias(m):
-        return "\x1AU" + base64.b64encode(m.group(1).encode()).decode() + "\x1AU"
+        return "\x1aU" + base64.b64encode(m.group(1).encode()).decode() + "\x1aU"
 
     def decode_alias(m):
         return base64.b64decode(m.group(1).encode()).decode()
@@ -392,7 +392,7 @@ def decode_alias(m):
         iterate = [alias]
 
     for a in iterate:
-        a = re.sub("\x1AU(.+?)\x1AU", decode_alias, a)
+        a = re.sub("\x1aU(.+?)\x1aU", decode_alias, a)
         if a[0] == a[-1] == '"':
             a = a[1:-1]
         aliases.append(a)