v3.3.2-dev4 freply, fixed alias bugs, alias and snippet looks

Author: Taaku18

CHANGELOG.md

@@ -7,7 +7,7 @@ This project mostly adheres to [Semantic Versioning](https://semver.org/spec/v2.
 however, insignificant breaking changes does not guarantee a major version bump, see the reasoning [here](https://github.com/kyb3r/modmail/issues/319).
 
 
-# v3.3.2-dev3
+# v3.3.2-dev4
 
 ### Added
 
@@ -20,10 +20,16 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - "enable" and "disable" support for yes or no config vars.
 - Added "perhaps you meant" section to `?config help`.
 - Multi-command alias is now more stable. With support for a single quote escape `\"`.
+- New command `?freply`, which behaves exactly like `?reply` with the addition that you can substitute `{channel}`, `{recipient}`, and `{author}` to be their respective values. 
+
+### Changed
+
+- The look of alias and snippet when previewing.
 
 ### Fixed
 
 - Setting config vars using human time wasn't working.
+- Fixed some bugs with aliases.
 
 ### Internal
 

bot.py

@@ -1,4 +1,4 @@
-__version__ = "3.3.2-dev3"
+__version__ = "3.3.2-dev4"
 
 
 import asyncio
@@ -612,7 +612,7 @@ def check_manual_blocked(self, author: discord.Member) -> bool:
         return False
 
     async def _process_blocked(self, message):
-        sent_emoji, blocked_emoji = await self.retrieve_emoji()
+        _, blocked_emoji = await self.retrieve_emoji()
         if await self.is_blocked(message.author, channel=message.channel, send_message=True):
             await self.add_reaction(message, blocked_emoji)
             return True
@@ -770,7 +770,7 @@ async def get_contexts(self, message, *, cls=commands.Context):
 
         view = StringView(message.content)
         ctx = cls(prefix=self.prefix, view=view, bot=self, message=message)
-        ctx.thread = await self.threads.find(channel=ctx.channel)
+        thread = await self.threads.find(channel=ctx.channel)
 
         if self._skip_check(message.author.id, self.user.id):
             return [ctx]
@@ -791,16 +791,18 @@ async def get_contexts(self, message, *, cls=commands.Context):
             if not aliases:
                 logger.warning("Alias %s is invalid, removing.", invoker)
                 self.aliases.pop(invoker)
+
             for alias in aliases:
-                view = StringView(alias)
-                ctx = cls(prefix=self.prefix, view=view, bot=self, message=message)
-                ctx.thread = await self.threads.find(channel=ctx.channel)
-                ctx.view = view
-                ctx.invoked_with = view.get_word()
-                ctx.command = self.all_commands.get(ctx.invoked_with)
-                ctxs += [ctx]
+                view = StringView(invoked_prefix + alias)
+                ctx_ = cls(prefix=self.prefix, view=view, bot=self, message=message)
+                ctx_.thread = thread
+                discord.utils.find(view.skip_string, prefixes)
+                ctx_.invoked_with = view.get_word().lower()
+                ctx_.command = self.all_commands.get(ctx_.invoked_with)
+                ctxs += [ctx_]
             return ctxs
 
+        ctx.thread = thread
         ctx.invoked_with = invoker
         ctx.command = self.all_commands.get(invoker)
         return [ctx]
@@ -872,11 +874,8 @@ async def process_commands(self, message):
 
             # Process snippets
             if cmd in self.snippets:
-                thread = await self.threads.find(channel=message.channel)
                 snippet = self.snippets[cmd]
-                if thread:
-                    snippet = self.formatter.format(snippet, recipient=thread.recipient)
-                message.content = f"{self.prefix}reply {snippet}"
+                message.content = f"{self.prefix}freply {snippet}"
 
         ctxs = await self.get_contexts(message)
         for ctx in ctxs:

cogs/modmail.py

@@ -6,7 +6,7 @@
 
 import discord
 from discord.ext import commands
-from discord.utils import escape_markdown, escape_mentions
+from discord.utils import escape_markdown
 
 from dateutil import parser
 from natural.date import duration
@@ -21,6 +21,7 @@
     create_not_found_embed,
     format_description,
     trigger_typing,
+    escape_code_block,
 )
 
 logger = getLogger(__name__)
@@ -155,8 +156,10 @@ async def snippet(self, ctx, *, name: str.lower = None):
             val = self.bot.snippets.get(name)
             if val is None:
                 embed = create_not_found_embed(name, self.bot.snippets.keys(), "Snippet")
-                return await ctx.send(embed=embed)
-            return await ctx.send(escape_mentions(val))
+            else:
+                embed = discord.Embed(color=self.bot.main_color)
+                embed.add_field(name=f"`{name}` will send:", value=val)
+            return await ctx.send(embed=embed)
 
         if not self.bot.snippets:
             embed = discord.Embed(
@@ -186,8 +189,11 @@ async def snippet_raw(self, ctx, *, name: str.lower):
         val = self.bot.snippets.get(name)
         if val is None:
             embed = create_not_found_embed(name, self.bot.snippets.keys(), "Snippet")
-            return await ctx.send(embed=embed)
-        return await ctx.send(escape_markdown(escape_mentions(val)).replace("<", "\\<"))
+        else:
+            embed = discord.Embed(color=self.bot.main_color)
+            val = escape_code_block(val)
+            embed.add_field(name=f"`{name}` will send:", value=f"```\n{val}```")
+        return await ctx.send(embed=embed)
 
     @snippet.command(name="add")
     @checks.has_permissions(PermissionLevel.SUPPORTER)
@@ -782,10 +788,32 @@ async def reply(self, ctx, *, msg: str = ""):
         async with ctx.typing():
             await ctx.thread.reply(ctx.message)
 
-    @commands.command()
+    @commands.command(aliases=["formatreply"])
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
+    @checks.thread_only()
+    async def freply(self, ctx, *, msg: str = ""):
+        """
+        Reply to a Modmail thread with variables.
+
+        Works just like `{prefix}reply`, however with the addition of three variables:
+          - `{channel}` - the `discord.TextChannel` object
+          - `{recipient}` - the `discord.User` object of the recipient
+          - `{author}` - the `discord.User` object of the author
+
+        Supports attachments and images as well as
+        automatically embedding image URLs.
+        """
+        msg = self.bot.formatter.format(
+            msg, channel=ctx.channel, recipient=ctx.thread.recipient, author=ctx.message.author
+        )
+        ctx.message.content = msg
+        async with ctx.typing():
+            await ctx.thread.reply(ctx.message)
+
+    @commands.command(aliases=["anonreply", "anonymousreply"])
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
-    async def anonreply(self, ctx, *, msg: str = ""):
+    async def areply(self, ctx, *, msg: str = ""):
         """
         Reply to a thread anonymously.
 
@@ -823,11 +851,10 @@ async def find_linked_message(self, ctx, message_id):
                     continue
                 # TODO: use regex to find the linked message id
                 linked_message_id = str(embed.author.url).split("/")[-1]
-                break
+
             elif message_id and msg.id == message_id:
                 url = msg.embeds[0].author.url
                 linked_message_id = str(url).split("/")[-1]
-                break
 
         return linked_message_id
 

cogs/plugins.py

@@ -539,12 +539,12 @@ async def plugins_registry(self, ctx, *, plugin_name: typing.Union[int, str] = N
 
             return await ctx.send(embed=embed)
 
-        for plugin_name, details in registry:
-            details = self.registry[plugin_name]
+        for name, details in registry:
+            details = self.registry[name]
             user, repo = details["repository"].split("/", maxsplit=1)
             branch = details.get("branch")
 
-            plugin = Plugin(user, repo, plugin_name, branch)
+            plugin = Plugin(user, repo, name, branch)
 
             embed = discord.Embed(
                 color=self.bot.main_color,
@@ -554,7 +554,7 @@ async def plugins_registry(self, ctx, *, plugin_name: typing.Union[int, str] = N
             )
 
             embed.add_field(
-                name="Installation", value=f"```{self.bot.prefix}plugins add {plugin_name}```"
+                name="Installation", value=f"```{self.bot.prefix}plugins add {name}```"
             )
 
             embed.set_author(

cogs/utility.py

@@ -17,7 +17,6 @@
 from discord.enums import ActivityType, Status
 from discord.ext import commands, tasks
 from discord.ext.commands.view import StringView
-from discord.utils import escape_markdown, escape_mentions
 
 from aiohttp import ClientResponseError
 from pkg_resources import parse_version
@@ -161,28 +160,41 @@ async def send_error_message(self, error):
         command = self.context.kwargs.get("command")
         val = self.context.bot.snippets.get(command)
         if val is not None:
-            return await self.get_destination().send(
-                escape_mentions(f"**`{command}` is a snippet, content:**\n\n{val}")
+            embed = discord.Embed(
+                title=f"{command} is a snippet.", color=self.context.bot.main_color
             )
+            embed.add_field(name=f"`{command}` will send:", value=val)
+            return await self.get_destination().send(embed=embed)
 
         val = self.context.bot.aliases.get(command)
         if val is not None:
             values = utils.parse_alias(val)
 
-            if len(values) == 1:
+            if not values:
                 embed = discord.Embed(
-                    title=f"{command} is an alias.",
-                    color=self.context.bot.main_color,
-                    description=f"`{command}` points to `{escape_markdown(values[0])}`.",
+                    title="Error",
+                    color=self.context.bot.error_color,
+                    description=f"Alias `{command}` is invalid, this alias will now be deleted."
+                    "This alias will now be deleted.",
                 )
+                embed.add_field(name=f"{command}` used to be:", value=val)
+                self.context.bot.aliases.pop(command)
+                await self.context.bot.config.update()
             else:
-                embed = discord.Embed(
-                    title=f"{command} is an alias.",
-                    color=self.context.bot.main_color,
-                    description=f"**`{command}` points to the following steps:**",
-                )
-                for i, val in enumerate(values, start=1):
-                    embed.description += f"\n{i}: {escape_markdown(val)}"
+                if len(values) == 1:
+                    embed = discord.Embed(
+                        title=f"{command} is an alias.", color=self.context.bot.main_color
+                    )
+                    embed.add_field(name=f"`{command}` points to:", value=values[0])
+                else:
+                    embed = discord.Embed(
+                        title=f"{command} is an alias.",
+                        color=self.context.bot.main_color,
+                        description=f"**`{command}` points to the following steps:**",
+                    )
+                    for i, val in enumerate(values, start=1):
+                        embed.add_field(name=f"Step {i}:", value=val)
+
             embed.set_footer(
                 text=f'Type "{self.clean_prefix}{self.command_attrs["name"]} alias" '
                 "for more details on aliases."
@@ -901,33 +913,32 @@ async def alias(self, ctx, *, name: str.lower = None):
                 embed = discord.Embed(
                     title="Error",
                     color=self.bot.error_color,
-                    description=f"Alias `{name}` is invalid, it used to be `{escape_markdown(val)}`. "
+                    description=f"Alias `{name}` is invalid, this alias will now be deleted."
                     "This alias will now be deleted.",
                 )
+                embed.add_field(name=f"{name}` used to be:", value=val)
                 self.bot.aliases.pop(name)
                 await self.bot.config.update()
                 return await ctx.send(embed=embed)
 
             if len(values) == 1:
-                embed = discord.Embed(
-                    color=self.bot.main_color,
-                    description=f"`{name}` points to `{escape_markdown(values[0])}`.",
-                )
+                embed = discord.Embed(color=self.bot.main_color)
+                embed.add_field(name=f"`{name}` points to:", value=values[0])
             else:
                 embed = discord.Embed(
                     color=self.bot.main_color,
                     description=f"**`{name}` points to the following steps:**",
                 )
                 for i, val in enumerate(values, start=1):
-                    embed.description += f"\n{i}: {escape_markdown(val)}"
+                    embed.add_field(name=f"Step {i}:", value=val)
 
             return await ctx.send(embed=embed)
 
         if not self.bot.aliases:
             embed = discord.Embed(
                 color=self.bot.error_color, description="You dont have any aliases at the moment."
             )
-            embed.set_footer(text=f"Do {self.bot.prefix}help alias for more commands.")
+            embed.set_footer(text=f'Do "{self.bot.prefix}help alias" for more commands.')
             embed.set_author(name="Aliases", icon_url=ctx.guild.icon_url)
             return await ctx.send(embed=embed)
 
@@ -952,56 +963,13 @@ async def alias_raw(self, ctx, *, name: str.lower):
         if val is None:
             embed = utils.create_not_found_embed(name, self.bot.aliases.keys(), "Alias")
             return await ctx.send(embed=embed)
-        return await ctx.send(escape_markdown(escape_mentions(val)).replace("<", "\\<"))
-
-    @alias.command(name="add")
-    @checks.has_permissions(PermissionLevel.MODERATOR)
-    async def alias_add(self, ctx, name: str.lower, *, value):
-        """
-        Add an alias.
-
-        Alias also supports multi-step aliases, to create a multi-step alias use quotes
-        to wrap each step and separate each step with `&&`. For example:
-
-        - `{prefix}alias add movenreply "move admin-category" && "reply Thanks for reaching out to the admins"`
-
-        However, if you run into problems, try wrapping the command with quotes. For example:
-
-        - This will fail: `{prefix}alias add reply You'll need to type && to work`
-        - Correct method: `{prefix}alias add reply "You'll need to type && to work"`
-        """
-        embed = None
-        if self.bot.get_command(name):
-            embed = discord.Embed(
-                title="Error",
-                color=self.bot.error_color,
-                description=f"A command with the same name already exists: `{name}`.",
-            )
 
-        elif name in self.bot.aliases:
-            embed = discord.Embed(
-                title="Error",
-                color=self.bot.error_color,
-                description=f"Another alias with the same name already exists: `{name}`.",
-            )
-
-        elif name in self.bot.snippets:
-            embed = discord.Embed(
-                title="Error",
-                color=self.bot.error_color,
-                description=f"A snippet with the same name already exists: `{name}`.",
-            )
-
-        elif len(name) > 120:
-            embed = discord.Embed(
-                title="Error",
-                color=self.bot.error_color,
-                description="Alias names cannot be longer than 120 characters.",
-            )
-
-        if embed is not None:
-            return await ctx.send(embed=embed)
+        embed = discord.Embed(color=self.bot.main_color)
+        val = utils.escape_code_block(val)
+        embed.add_field(name=f"`{name}` points to:", value=f"```\n{val}```")
+        return await ctx.send(embed=embed)
 
+    async def make_alias(self, name, value, action):
         values = utils.parse_alias(value)
         save_aliases = []
 
@@ -1012,14 +980,14 @@ async def alias_add(self, ctx, name: str.lower, *, value):
                 description="Invalid multi-step alias, try wrapping each steps in quotes.",
             )
             embed.set_footer(text=f'See "{self.bot.prefix}alias add" for more details.')
-            return await ctx.send(embed=embed)
+            return embed
 
         multiple_alias = len(values) > 1
 
-        embed = discord.Embed(title="Added alias", color=self.bot.main_color)
+        embed = discord.Embed(title=f"{action} alias", color=self.bot.main_color)
 
         if not multiple_alias:
-            embed.description = f'`{name}` points to: "{values[0]}".'
+            embed.add_field(name=f"`{name}` points to:", value=values[0])
         else:
             embed.description = f"`{name}` now points to the following steps:"
 
@@ -1043,17 +1011,66 @@ async def alias_add(self, ctx, name: str.lower, *, value):
                     else:
                         embed.description = (
                             "The command you are attempting to point "
-                            f"to in step {i} does not exist: `{linked_command}`."
+                            f"to on step {i} does not exist: `{linked_command}`."
                         )
 
-                    return await ctx.send(embed=embed)
+                    return embed
             else:
                 save_aliases.append(val)
-
-            embed.description += f"\n{i}: {val}"
+            if multiple_alias:
+                embed.add_field(name=f"Step {i}:", value=val)
 
         self.bot.aliases[name] = " && ".join(f'"{a}"' for a in save_aliases)
         await self.bot.config.update()
+        return embed
+
+    @alias.command(name="add")
+    @checks.has_permissions(PermissionLevel.MODERATOR)
+    async def alias_add(self, ctx, name: str.lower, *, value):
+        """
+        Add an alias.
+
+        Alias also supports multi-step aliases, to create a multi-step alias use quotes
+        to wrap each step and separate each step with `&&`. For example:
+
+        - `{prefix}alias add movenreply "move admin-category" && "reply Thanks for reaching out to the admins"`
+
+        However, if you run into problems, try wrapping the command with quotes. For example:
+
+        - This will fail: `{prefix}alias add reply You'll need to type && to work`
+        - Correct method: `{prefix}alias add reply "You'll need to type && to work"`
+        """
+        embed = None
+        if self.bot.get_command(name):
+            embed = discord.Embed(
+                title="Error",
+                color=self.bot.error_color,
+                description=f"A command with the same name already exists: `{name}`.",
+            )
+
+        elif name in self.bot.aliases:
+            embed = discord.Embed(
+                title="Error",
+                color=self.bot.error_color,
+                description=f"Another alias with the same name already exists: `{name}`.",
+            )
+
+        elif name in self.bot.snippets:
+            embed = discord.Embed(
+                title="Error",
+                color=self.bot.error_color,
+                description=f"A snippet with the same name already exists: `{name}`.",
+            )
+
+        elif len(name) > 120:
+            embed = discord.Embed(
+                title="Error",
+                color=self.bot.error_color,
+                description="Alias names cannot be longer than 120 characters.",
+            )
+
+        if embed is None:
+            embed = await self.make_alias(name, value, "Added")
         return await ctx.send(embed=embed)
 
     @alias.command(name="remove", aliases=["del", "delete"])
@@ -1085,58 +1102,7 @@ async def alias_edit(self, ctx, name: str.lower, *, value):
             embed = utils.create_not_found_embed(name, self.bot.aliases.keys(), "Alias")
             return await ctx.send(embed=embed)
 
-        values = utils.parse_alias(value)
-        save_aliases = []
-
-        if not values:
-            embed = discord.Embed(
-                title="Error",
-                color=self.bot.error_color,
-                description="Invalid multi-step alias, try wrapping each steps in quotes.",
-            )
-            embed.set_footer(text=f'See "{self.bot.prefix}alias add" for more details.')
-            return await ctx.send(embed=embed)
-
-        multiple_alias = len(values) > 1
-
-        embed = discord.Embed(title="Edited alias", color=self.bot.main_color)
-
-        if not multiple_alias:
-            embed.description = f'`{name}` points to: "{values[0]}".'
-        else:
-            embed.description = f"`{name}` now points to the following steps:"
-
-        for i, val in enumerate(values, start=1):
-            view = StringView(val)
-            linked_command = view.get_word().lower()
-            message = view.read_rest()
-
-            if not self.bot.get_command(linked_command):
-                alias_command = self.bot.aliases.get(linked_command)
-                if alias_command is not None:
-                    save_aliases.extend(utils.normalize_alias(alias_command, message))
-                else:
-                    embed = discord.Embed(title="Error", color=self.bot.error_color)
-
-                    if multiple_alias:
-                        embed.description = (
-                            "The command you are attempting to point "
-                            f"to does not exist: `{linked_command}`."
-                        )
-                    else:
-                        embed.description = (
-                            "The command you are attempting to point "
-                            f"to n step {i} does not exist: `{linked_command}`."
-                        )
-
-                    return await ctx.send(embed=embed)
-            else:
-                save_aliases.append(val)
-
-            embed.description += f"\n{i}: {val}"
-
-        self.bot.aliases[name] = " && ".join(f'"{a}"' for a in save_aliases)
-        await self.bot.config.update()
+        embed = await self.make_alias(name, value, "Edited")
         return await ctx.send(embed=embed)
 
     @commands.group(aliases=["perms"], invoke_without_command=True)

core/clients.py

@@ -235,9 +235,7 @@ async def append_log(
 
     async def post_log(self, channel_id: Union[int, str], data: dict) -> dict:
         return await self.logs.find_one_and_update(
-            {"channel_id": str(channel_id)},
-            {"$set": {k: v for k, v in data.items()}},
-            return_document=True,
+            {"channel_id": str(channel_id)}, {"$set": data}, return_document=True
         )
 
 

core/utils.py

@@ -226,11 +226,17 @@ def decode_alias(m):
         r"(?:(?:\s*(?<!\\)(?:\")\s*)(?=&&)|(?:\s*(?<!\\)(?:\")\s*)(?=$))",
         encode_alias,
         alias,
-    )
+    ).strip()
 
     aliases = []
-    for alias in re.split(r"\s*&&\s*", alias):
-        aliases.append(re.sub("\x1AU(.+?)\x1AU", decode_alias, alias))
+    if not alias:
+        return aliases
+
+    for a in re.split(r"\s*&&\s*", alias):
+        a = re.sub("\x1AU(.+?)\x1AU", decode_alias, a)
+        if a[0] == a[-1] == '"':
+            a = a[1:-1]
+        aliases.append(a)
 
     return aliases
 
@@ -240,14 +246,14 @@ def normalize_alias(alias, message):
     contents = parse_alias(message)
 
     final_aliases = []
-    for alias, content in zip_longest(aliases, contents):
-        if alias is None:
+    for a, content in zip_longest(aliases, contents):
+        if a is None:
             break
 
         if content:
-            final_aliases.append(f"{alias} {content}")
+            final_aliases.append(f"{a} {content}")
         else:
-            final_aliases.append(alias)
+            final_aliases.append(a)
 
     return final_aliases
 
@@ -266,3 +272,7 @@ async def wrapper(self, ctx: commands.Context, *args, **kwargs):
         return await func(self, ctx, *args, **kwargs)
 
     return wrapper
+
+
+def escape_code_block(text):
+    return re.sub(r"```", "`\u200b``", text)