Plain replies (#2872)

Author: fourjr

Diff for: CHANGELOG.md

@@ -6,7 +6,10 @@ 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.6.3-dev0
+# v3.6.3-dev1
+
+### Added
+- Plain replies: added commands `preply`, `pareply`, added config `plain_reply_without_command`. Only works from mod to users.
 
 ### Improved
 

Diff for: bot.py

@@ -1,4 +1,4 @@
-__version__ = "3.6.3-dev0"
+__version__ = "3.6.3-dev1"
 
 
 import asyncio
@@ -896,10 +896,19 @@ async def process_commands(self, message):
 
             thread = await self.threads.find(channel=ctx.channel)
             if thread is not None:
+                anonymous = False
+                plain = False
                 if self.config.get("anon_reply_without_command"):
-                    await thread.reply(message, anonymous=True)
-                elif self.config.get("reply_without_command"):
-                    await thread.reply(message)
+                    anonymous = True
+                if self.config.get("plain_reply_without_command"):
+                    plain = True
+
+                if (
+                    self.config.get("reply_without_command")
+                    or self.config.get("anon_reply_without_command")
+                    or self.config.get("plain_reply_without_command")
+                ):
+                    await thread.reply(message, anonymous=anonymous, plain=plain)
                 else:
                     await self.api.append_log(message, type_="internal")
             elif ctx.invoked_with:

Diff for: cogs/modmail.py

@@ -831,6 +831,34 @@ async def areply(self, ctx, *, msg: str = ""):
         async with ctx.typing():
             await ctx.thread.reply(ctx.message, anonymous=True)
 
+    @commands.command(aliases=["plainreply"])
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
+    @checks.thread_only()
+    async def preply(self, ctx, *, msg: str = ""):
+        """
+        Reply to a Modmail thread with a plain message.
+
+        Supports attachments and images as well as
+        automatically embedding image URLs.
+        """
+        ctx.message.content = msg
+        async with ctx.typing():
+            await ctx.thread.reply(ctx.message, plain=True)
+
+    @commands.command(aliases=["plainanonreply", "plainanonymousreply"])
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
+    @checks.thread_only()
+    async def pareply(self, ctx, *, msg: str = ""):
+        """
+        Reply to a Modmail thread with a plain message and anonmymously.
+
+        Supports attachments and images as well as
+        automatically embedding image URLs.
+        """
+        ctx.message.content = msg
+        async with ctx.typing():
+            await ctx.thread.reply(ctx.message, anonymous=True, plain=True)
+
     @commands.command()
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()

Diff for: cogs/plugins.py

@@ -172,10 +172,10 @@ async def download_plugin(self, plugin, force=False):
                 except UnicodeDecodeError:
                     pass
                 else:
-                    if raw == 'Not Found':
-                        raise InvalidPluginError('Plugin not found')
+                    if raw == "Not Found":
+                        raise InvalidPluginError("Plugin not found")
                     else:
-                        raise InvalidPluginError('Invalid download recieved, non-bytes object')
+                        raise InvalidPluginError("Invalid download recieved, non-bytes object")
 
                 plugin_io = io.BytesIO(raw)
                 if not plugin.cache_path.parent.exists():

Diff for: core/config.py

@@ -39,6 +39,7 @@ class ConfigManager:
         "thread_cooldown": isodate.Duration(),
         "reply_without_command": False,
         "anon_reply_without_command": False,
+        "plain_reply_without_command": False,
         # logging
         "log_channel_id": None,
         # threads
@@ -130,6 +131,7 @@ class ConfigManager:
         "mod_typing",
         "reply_without_command",
         "anon_reply_without_command",
+        "plain_reply_without_command",
         "recipient_thread_close",
         "thread_auto_close_silently",
         "thread_move_notify",

Diff for: core/config_help.json

@@ -139,7 +139,7 @@
       "`{prefix}config set reply_without_command no`"
     ],
     "notes": [
-      "See also: `anon_reply_without_command`."
+      "See also: `anon_reply_without_command`, `plain_reply_without_command`."
     ]
   },
   "anon_reply_without_command": {
@@ -150,7 +150,18 @@
       "`{prefix}config set anon_reply_without_command no`"
     ],
     "notes": [
-      "See also: `reply_without_command`."
+      "See also: `reply_without_command`, `plain_reply_without_command`."
+    ]
+  },
+  "plain_reply_without_command": {
+    "default": "Disabled",
+    "description": "Setting this configuration will make all non-command messages sent in the thread channel to be forwarded to the recipient in a plain form without the need of `{prefix}reply`.",
+    "examples": [
+      "`{prefix}config set plain_reply_without_command yes`",
+      "`{prefix}config set plain_reply_without_command no`"
+    ],
+    "notes": [
+      "See also: `reply_without_command`, `anon_reply_without_command`."
     ]
   },
   "log_channel_id": {

Diff for: core/thread.py

@@ -1,4 +1,5 @@
 import asyncio
+import io
 import re
 import typing
 from datetime import datetime, timedelta
@@ -619,7 +620,9 @@ async def note(self, message: discord.Message) -> None:
 
         return msg
 
-    async def reply(self, message: discord.Message, anonymous: bool = False) -> None:
+    async def reply(
+        self, message: discord.Message, anonymous: bool = False, plain: bool = False
+    ) -> None:
         if not message.content and not message.attachments:
             raise MissingRequiredArgument(SimpleNamespace(name="msg"))
         if not any(g.get_member(self.id) for g in self.bot.guilds):
@@ -635,7 +638,11 @@ async def reply(self, message: discord.Message, anonymous: bool = False) -> None
 
         try:
             await self.send(
-                message, destination=self.recipient, from_mod=True, anonymous=anonymous
+                message,
+                destination=self.recipient,
+                from_mod=True,
+                anonymous=anonymous,
+                plain=plain,
             )
         except Exception:
             logger.error("Message delivery failed:", exc_info=True)
@@ -653,7 +660,7 @@ async def reply(self, message: discord.Message, anonymous: bool = False) -> None
         else:
             # Send the same thing in the thread channel.
             msg = await self.send(
-                message, destination=self.channel, from_mod=True, anonymous=anonymous
+                message, destination=self.channel, from_mod=True, anonymous=anonymous, plain=plain
             )
 
             tasks.append(
@@ -688,6 +695,7 @@ async def send(
         from_mod: bool = False,
         note: bool = False,
         anonymous: bool = False,
+        plain: bool = False,
     ) -> None:
 
         self.bot.loop.create_task(
@@ -851,7 +859,31 @@ async def send(
         else:
             mentions = None
 
-        msg = await destination.send(mentions, embed=embed)
+        if plain:
+            if from_mod and not isinstance(destination, discord.TextChannel):
+                # Plain to user
+                if embed.footer.text:
+                    plain_message = f"**({embed.footer.text}) "
+                else:
+                    plain_message = "**"
+                plain_message += f"{embed.author.name}:** {embed.description}"
+                files = []
+                for i in embed.fields:
+                    if "Image" in i.name:
+                        async with self.bot.session.get(
+                            i.field[i.field.find("http") : -1]
+                        ) as resp:
+                            stream = io.BytesIO(await resp.read())
+                            files.append(discord.File(stream))
+
+                msg = await destination.send(plain_message, files=files)
+            else:
+                # Plain to mods
+                embed.set_footer(text="[PLAIN] " + embed.footer.text)
+                msg = await destination.send(mentions, embed=embed)
+
+        else:
+            msg = await destination.send(mentions, embed=embed)
 
         if additional_images:
             self.ready = False