Delete notes, "?logs delete", linked alias (#402)

* Add ability to delete notes
* Add wipe command
* Add option to add existing aliases in new aliases
* Fix typo in presence docstring
* Update changelog and bump dev version

Author: robinmahieu

.lint.py

@@ -1,4 +1,4 @@
-if __name__ == '__main__':
+if __name__ == "__main__":
     import sys
     from os import listdir
     from os.path import join

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.0-dev5
+# v3.3.0-dev6
 
 
 ### Important
@@ -39,6 +39,8 @@ however, insignificant breaking changes does not guarantee a major version bump,
   - `disabled_current_thread_title`
   - `disabled_current_thread_response`
   - `disabled_current_thread_footer`
+- Ability to delete notes when providing their ID. (Thanks to papiersnipper PR#402)
+- Ability to delete log entries. (Thanks to papiersnipper PR#402)
 
 ### Changed
 
@@ -62,6 +64,7 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - Eval commands are logged in debug logs.
 - Presence updates 30 minutes instead of 45 now.
 - Fixed an assortment of problems to do with block.
+- Existing aliases can be used when creating new aliases. (Thanks to papiersnipper PR#402)
 
 ### Internal
 

bot.py

@@ -1,4 +1,4 @@
-__version__ = "3.3.0-dev5"
+__version__ = "3.3.0-dev6"
 
 import asyncio
 import logging

cogs/modmail.py

@@ -722,6 +722,31 @@ async def logs_closed_by(self, ctx, *, user: User = None):
         session = EmbedPaginatorSession(ctx, *embeds)
         await session.run()
 
+    @logs.command(name="delete", aliases=["wipe"])
+    @checks.has_permissions(PermissionLevel.OWNER)
+    async def logs_delete(self, ctx, key_or_link: str):
+        """
+        Wipe a log entry from the database.
+        """
+        key = key_or_link.split("/")[-1]
+
+        success = await self.bot.api.delete_log_entry(key)
+
+        if not success:
+            embed = discord.Embed(
+                title="Error",
+                description=f"Log entry `{key}` not found.",
+                color=self.bot.error_color,
+            )
+        else:
+            embed = discord.Embed(
+                title="Success",
+                description=f"Log entry `{key}` successfully deleted.",
+                color=self.bot.main_color,
+            )
+
+        await ctx.send(embed=embed)
+
     @logs.command(name="responded")
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     async def logs_responded(self, ctx, *, user: User = None):
@@ -1167,10 +1192,12 @@ async def unblock(self, ctx, *, user: User = None):
     @checks.thread_only()
     async def delete(self, ctx, message_id: Optional[int] = None):
         """
-        Delete a message that was sent using the reply command.
+        Delete a message that was sent using the reply command or a note.
 
         Deletes the previous message, unless a message ID is provided,
         which in that case, deletes the message with that message ID.
+
+        Notes can only be deleted when a note ID is provided.
         """
         thread = ctx.thread
 

cogs/plugins.py

@@ -226,7 +226,7 @@ async def load_plugin(self, plugin):
 
         try:
             self.bot.load_extension(plugin.ext_string)
-            logger.info("Loaded plugin: %s", plugin.ext_string.split('.')[-1])
+            logger.info("Loaded plugin: %s", plugin.ext_string.split(".")[-1])
             self.loaded_plugins.add(plugin)
 
         except commands.ExtensionError as exc:

cogs/utility.py

@@ -305,7 +305,12 @@ async def about(self, ctx):
         latest = changelog.latest_version
 
         if self.bot.version.is_prerelease:
-            stable = next(filter(lambda v: not parse_version(v.version).is_prerelease, changelog.versions))
+            stable = next(
+                filter(
+                    lambda v: not parse_version(v.version).is_prerelease,
+                    changelog.versions,
+                )
+            )
             footer = f"You are on the prerelease version • the latest version is v{stable.version}."
         elif self.bot.version < parse_version(latest.version):
             footer = f"A newer version is available v{latest.version}."
@@ -509,7 +514,9 @@ async def activity(self, ctx, activity_type: str.lower, *, message: str = ""):
         except KeyError:
             raise commands.MissingRequiredArgument(SimpleNamespace(name="activity"))
 
-        activity, _ = await self.set_presence(activity_type=activity_type, activity_message=message)
+        activity, _ = await self.set_presence(
+            activity_type=activity_type, activity_message=message
+        )
 
         self.bot.config["activity_type"] = activity.type.value
         self.bot.config["activity_message"] = activity.name
@@ -565,7 +572,9 @@ async def status(self, ctx, *, status_type: str.lower):
         )
         return await ctx.send(embed=embed)
 
-    async def set_presence(self, *, status=None, activity_type=None, activity_message=None):
+    async def set_presence(
+        self, *, status=None, activity_type=None, activity_message=None
+    ):
 
         if status is None:
             status = self.bot.config.get("status")
@@ -574,9 +583,13 @@ async def set_presence(self, *, status=None, activity_type=None, activity_messag
             activity_type = self.bot.config.get("activity_type")
 
         url = None
-        activity_message = (activity_message or self.bot.config["activity_message"]).strip()
+        activity_message = (
+            activity_message or self.bot.config["activity_message"]
+        ).strip()
         if activity_type is not None and not activity_message:
-            logger.warning("No activity message found whilst activity is provided, defaults to \"Modmail\".")
+            logger.warning(
+                'No activity message found whilst activity is provided, defaults to "Modmail".'
+            )
             activity_message = "Modmail"
 
         if activity_type == ActivityType.listening:
@@ -599,14 +612,14 @@ async def set_presence(self, *, status=None, activity_type=None, activity_messag
 
     @tasks.loop(minutes=30)
     async def loop_presence(self):
-        """Set presence to the configured value every 45 minutes."""
+        """Set presence to the configured value every 30 minutes."""
         logger.debug("Resetting presence.")
         await self.set_presence()
 
     @loop_presence.before_loop
     async def before_loop_presence(self):
         await self.bot.wait_for_connected()
-        logger.line('debug')
+        logger.line("debug")
         activity, status = await self.set_presence()
 
         if activity is not None:
@@ -1044,13 +1057,16 @@ async def alias_add(self, ctx, name: str.lower, *, value):
         if len(values) == 1:
             linked_command = values[0].split()[0].lower()
             if not self.bot.get_command(linked_command):
-                embed = discord.Embed(
-                    title="Error",
-                    color=self.bot.error_color,
-                    description="The command you are attempting to point "
-                    f"to does not exist: `{linked_command}`.",
-                )
-                return await ctx.send(embed=embed)
+                if linked_command in self.bot.aliases:
+                    values = [self.bot.aliases.get(linked_command)]
+                else:
+                    embed = discord.Embed(
+                        title="Error",
+                        color=self.bot.error_color,
+                        description="The command you are attempting to point "
+                        f"to does not exist: `{linked_command}`.",
+                    )
+                    return await ctx.send(embed=embed)
 
             embed = discord.Embed(
                 title="Added alias",
@@ -1068,13 +1084,17 @@ async def alias_add(self, ctx, name: str.lower, *, value):
             for i, val in enumerate(values, start=1):
                 linked_command = val.split()[0]
                 if not self.bot.get_command(linked_command):
-                    embed = discord.Embed(
-                        title="Error",
-                        color=self.bot.error_color,
-                        description="The command you are attempting to point "
-                        f"to on step {i} does not exist: `{linked_command}`.",
-                    )
-                    return await ctx.send(embed=embed)
+                    if linked_command in self.bot.aliases:
+                        index = values.index(linked_command)
+                        values[index] = self.bot.aliases.get(linked_command)
+                    else:
+                        embed = discord.Embed(
+                            title="Error",
+                            color=self.bot.error_color,
+                            description="The command you are attempting to point "
+                            f"to on step {i} does not exist: `{linked_command}`.",
+                        )
+                        return await ctx.send(embed=embed)
                 embed.description += f"\n{i}: {val}"
 
         self.bot.aliases[name] = " && ".join(values)

core/clients.py

@@ -106,9 +106,7 @@ async def get_responded_logs(self, user_id: Union[str, int]) -> list:
         return await self.logs.find(query).to_list(None)
 
     async def get_open_logs(self) -> list:
-        query = {
-            "open": True
-        }
+        query = {"open": True}
         return await self.logs.find(query).to_list(None)
 
     async def get_log(self, channel_id: Union[str, int]) -> dict:
@@ -162,6 +160,10 @@ async def create_log_entry(
             prefix = ""
         return f"{self.bot.config['log_url'].strip('/')}{'/' + prefix if prefix else ''}/{key}"
 
+    async def delete_log_entry(self, key: str) -> bool:
+        result = await self.logs.delete_one({"key": key})
+        return result.deleted_count == 1
+
     async def get_config(self) -> dict:
         conf = await self.db.config.find_one({"bot_id": self.bot.user.id})
         if conf is None:

core/thread.py

@@ -439,7 +439,6 @@ async def _fetch_timeout(
         """
         This grabs the timeout value for closing threads automatically
         from the ConfigManager and parses it for use internally.
-
         :returns: None if no timeout is set.
         """
         timeout = self.bot.config.get("thread_auto_close")