Log purged messages, Fix macro usage in DMs & Fix reading empty files (#88)

* Log purged messages

* Fix CommandInvokeError for macros in DMs

* Fix decoding empty files and simplify read json logic

* Apply black formatting

robocop_ng/cogs/invites.py

@@ -6,12 +6,12 @@ from discord.ext import commands
 from discord.ext.commands import Cog
 
 from robocop_ng.helpers.checks import check_if_collaborator
+from robocop_ng.helpers.invites import add_invite
 
 
 class Invites(Cog):
     def __init__(self, bot):
         self.bot = bot
-        self.invites_json_path = os.path.join(self.bot.state_dir, "data/invites.json")
 
     @commands.command()
     @commands.guild_only()
@@ -24,18 +24,7 @@ class Invites(Cog):
             max_age=0, max_uses=1, temporary=True, unique=True, reason=reason
         )
 
-        with open(self.invites_json_path, "r") as f:
-            invites = json.load(f)
-
-        invites[invite.id] = {
-            "uses": 0,
-            "url": invite.url,
-            "max_uses": 1,
-            "code": invite.code,
-        }
-
-        with open(self.invites_json_path, "w") as f:
-            f.write(json.dumps(invites))
+        add_invite(self.bot, invite.id, invite.url, 1, invite.code)
 
         await ctx.message.add_reaction("🆗")
         try:

robocop_ng/cogs/logs.py

@@ -6,6 +6,7 @@ import discord
 from discord.ext.commands import Cog
 
 from robocop_ng.helpers.checks import check_if_staff
+from robocop_ng.helpers.invites import get_invites, set_invites
 from robocop_ng.helpers.restrictions import get_user_restrictions
 from robocop_ng.helpers.userlogs import get_userlog
 
@@ -17,7 +18,6 @@ class Logs(Cog):
 
     def __init__(self, bot):
         self.bot = bot
-        self.invites_json_path = os.path.join(self.bot.state_dir, "data/invites.json")
         self.invite_re = re.compile(
             r"((discord\.gg|discordapp\.com/" r"+invite)/+[a-zA-Z0-9-]+)", re.IGNORECASE
         )
@@ -41,8 +41,7 @@ class Logs(Cog):
         escaped_name = self.bot.escape_message(member)
 
         # Attempt to correlate the user joining with an invite
-        with open(self.invites_json_path, "r") as f:
-            invites = json.load(f)
+        invites = get_invites(self.bot)
 
         real_invites = await member.guild.invites()
 
@@ -76,8 +75,7 @@ class Logs(Cog):
             del invites[id]
 
         # Save invites data.
-        with open(self.invites_json_path, "w") as f:
-            f.write(json.dumps(invites))
+        set_invites(self.bot, invites)
 
         # Prepare the invite correlation message
         if len(probable_invites_used) == 1:

robocop_ng/cogs/macro.py

@@ -22,7 +22,8 @@ class Macro(Cog):
     @commands.cooldown(3, 30, BucketType.user)
     @commands.command(aliases=["m"])
     async def macro(self, ctx: Context, key: str, targets: Greedy[discord.User] = None):
-        await ctx.message.delete()
+        if ctx.guild:
+            await ctx.message.delete()
         if len(key) > 0:
             text = get_macro(self.bot, key)
             if text is not None:

robocop_ng/cogs/mod.py

@@ -612,15 +612,30 @@ class Mod(Cog):
     @commands.command(aliases=["clear"])
     async def purge(self, ctx, limit: int, channel: discord.TextChannel = None):
         """Clears a given number of messages, staff only."""
-        log_channel = self.bot.get_channel(self.bot.config.modlog_channel)
+        modlog_channel = self.bot.get_channel(self.bot.config.modlog_channel)
+        log_channel = self.bot.get_channel(self.bot.config.log_channel)
         if not channel:
             channel = ctx.channel
-        await channel.purge(limit=limit)
+
+        purged_log_jump_url = ""
+        for deleted_message in await channel.purge(limit=limit):
+            msg = (
+                "🗑️ **Message purged**: \n"
+                f"from {self.bot.escape_message(deleted_message.author.name)} "
+                f"({deleted_message.author.id}), in {deleted_message.channel.mention}:\n"
+                f"`{deleted_message.clean_content}`"
+            )
+            if len(purged_log_jump_url) == 0:
+                purged_log_jump_url = (await log_channel.send(msg)).jump_url
+            else:
+                await log_channel.send(msg)
+
         msg = (
             f"🗑 **Purged**: {str(ctx.author)} purged {limit} "
             f"messages in {channel.mention}."
+            f"\n🔗 __Jump__: <{purged_log_jump_url}>"
         )
-        await log_channel.send(msg)
+        await modlog_channel.send(msg)
 
     @commands.guild_only()
     @commands.check(check_if_staff)

robocop_ng/helpers/data_loader.py

@@ -0,0 +1,21 @@
+import json
+import os
+
+from robocop_ng.helpers.notifications import report_critical_error
+
+
+def read_json(bot, filepath: str) -> dict:
+    if os.path.isfile(filepath) and os.path.getsize(filepath) > 0:
+        with open(filepath, "r") as f:
+            try:
+                return json.load(f)
+            except json.JSONDecodeError as e:
+                content = f.read()
+                report_critical_error(
+                    bot,
+                    e,
+                    additional_info={
+                        "file": {"length": len(content), "content": content}
+                    },
+                )
+    return {}

robocop_ng/helpers/disabled_ids.py

@@ -2,7 +2,7 @@ import json
 import os
 from typing import Union
 
-from robocop_ng.helpers.notifications import report_critical_error
+from robocop_ng.helpers.data_loader import read_json
 
 
 def get_disabled_ids_path(bot) -> str:
@@ -22,21 +22,8 @@ def is_ro_section_valid(ro_section: dict[str, str]) -> bool:
 
 
 def get_disabled_ids(bot) -> dict[str, dict[str, Union[str, dict[str, str]]]]:
-    if os.path.isfile(get_disabled_ids_path(bot)):
-        with open(get_disabled_ids_path(bot), "r") as f:
-            try:
-                disabled_ids = json.load(f)
-            except json.JSONDecodeError as e:
-                content = f.read()
-                report_critical_error(
-                    bot,
-                    e,
-                    additional_info={
-                        "file": {"length": len(content), "content": content}
-                    },
-                )
-                return {}
-
+    disabled_ids = read_json(bot, get_disabled_ids_path(bot))
+    if len(disabled_ids) > 0:
         # Migration code
         if "app_id" in disabled_ids.keys():
             old_disabled_ids = disabled_ids.copy()
@@ -54,9 +41,7 @@ def get_disabled_ids(bot) -> dict[str, dict[str, Union[str, dict[str, str]]]]:
                 disabled_ids[key.lower()]["ro_section"] = value
             set_disabled_ids(bot, disabled_ids)
 
-        return disabled_ids
-
-    return {}
+    return disabled_ids
 
 
 def set_disabled_ids(bot, contents: dict[str, dict[str, Union[str, dict[str, str]]]]):

robocop_ng/helpers/invites.py

@@ -0,0 +1,29 @@
+import json
+import os
+from typing import Union
+
+from robocop_ng.helpers.data_loader import read_json
+
+
+def get_invites_path(bot):
+    return os.path.join(bot.state_dir, "data/invites.json")
+
+
+def get_invites(bot) -> dict[str, dict[str, Union[str, int]]]:
+    return read_json(bot, get_invites_path(bot))
+
+
+def add_invite(bot, invite_id: str, url: str, max_uses: int, code: str):
+    invites = get_invites(bot)
+    invites[invite_id] = {
+        "uses": 0,
+        "url": url,
+        "max_uses": max_uses,
+        code: code,
+    }
+    set_invites(bot, invites)
+
+
+def set_invites(bot, contents: dict[str, dict[str, Union[str, int]]]):
+    with open(get_invites_path(bot), "w") as f:
+        json.dump(contents, f)

robocop_ng/helpers/macros.py

@@ -2,7 +2,7 @@ import json
 import os
 from typing import Optional, Union
 
-from robocop_ng.helpers.notifications import report_critical_error
+from robocop_ng.helpers.data_loader import read_json
 
 
 def get_macros_path(bot):
@@ -10,21 +10,8 @@ def get_macros_path(bot):
 
 
 def get_macros_dict(bot) -> dict[str, dict[str, Union[list[str], str]]]:
-    if os.path.isfile(get_macros_path(bot)):
-        with open(get_macros_path(bot), "r") as f:
-            try:
-                macros = json.load(f)
-            except json.JSONDecodeError as e:
-                content = f.read()
-                report_critical_error(
-                    bot,
-                    e,
-                    additional_info={
-                        "file": {"length": len(content), "content": content}
-                    },
-                )
-                return {}
-
+    macros = read_json(bot, get_macros_path(bot))
+    if len(macros) > 0:
         # Migration code
         if "aliases" not in macros.keys():
             new_macros = {"macros": macros, "aliases": {}}

robocop_ng/helpers/restrictions.py

@@ -1,7 +1,7 @@
 import json
 import os
 
-from robocop_ng.helpers.notifications import report_critical_error
+from robocop_ng.helpers.data_loader import read_json
 
 
 def get_restrictions_path(bot):
@@ -9,20 +9,7 @@ def get_restrictions_path(bot):
 
 
 def get_restrictions(bot):
-    if os.path.isfile(get_restrictions_path(bot)):
-        with open(get_restrictions_path(bot), "r") as f:
-            try:
-                return json.load(f)
-            except json.JSONDecodeError as e:
-                content = f.read()
-                report_critical_error(
-                    bot,
-                    e,
-                    additional_info={
-                        "file": {"length": len(content), "content": content}
-                    },
-                )
-    return {}
+    return read_json(bot, get_restrictions_path(bot))
 
 
 def set_restrictions(bot, contents):

robocop_ng/helpers/robocronp.py

@@ -2,7 +2,7 @@ import json
 import math
 import os
 
-from robocop_ng.helpers.notifications import report_critical_error
+from robocop_ng.helpers.data_loader import read_json
 
 
 def get_crontab_path(bot):
@@ -10,20 +10,7 @@ def get_crontab_path(bot):
 
 
 def get_crontab(bot):
-    if os.path.isfile(get_crontab_path(bot)):
-        with open(get_crontab_path(bot), "r") as f:
-            try:
-                return json.load(f)
-            except json.JSONDecodeError as e:
-                content = f.read()
-                report_critical_error(
-                    bot,
-                    e,
-                    additional_info={
-                        "file": {"length": len(content), "content": content}
-                    },
-                )
-    return {}
+    return read_json(bot, get_crontab_path(bot))
 
 
 def set_crontab(bot, contents):

robocop_ng/helpers/roles.py

@@ -2,7 +2,7 @@ import json
 import os.path
 import os
 
-from robocop_ng.helpers.notifications import report_critical_error
+from robocop_ng.helpers.data_loader import read_json
 
 
 def get_persistent_roles_path(bot):
@@ -10,20 +10,7 @@ def get_persistent_roles_path(bot):
 
 
 def get_persistent_roles(bot) -> dict[str, list[str]]:
-    if os.path.isfile(get_persistent_roles_path(bot)):
-        with open(get_persistent_roles_path(bot), "r") as f:
-            try:
-                return json.load(f)
-            except json.JSONDecodeError as e:
-                content = f.read()
-                report_critical_error(
-                    bot,
-                    e,
-                    additional_info={
-                        "file": {"length": len(content), "content": content}
-                    },
-                )
-    return {}
+    return read_json(bot, get_persistent_roles_path(bot))
 
 
 def set_persistent_roles(bot, contents: dict[str, list[str]]):
@@ -42,8 +29,5 @@ def add_user_roles(bot, uid: int, roles: list[int]):
 
 def get_user_roles(bot, uid: int) -> list[str]:
     uid = str(uid)
-    with open(get_persistent_roles_path(bot), "r") as f:
-        roles = json.load(f)
-        if uid in roles:
-            return roles[uid]
-        return []
+    persistent_roles = get_persistent_roles(bot)
+    return persistent_roles[uid] if uid in persistent_roles else []

robocop_ng/helpers/ryujinx_log_analyser.py

@@ -230,9 +230,9 @@ class LogAnalyser:
                                 ram_total, dest_unit
                             )
 
-                            self._hardware_info[
-                                setting
-                            ] = f"{ram_available:.0f}/{ram_total:.0f} {dest_unit.name}"
+                            self._hardware_info[setting] = (
+                                f"{ram_available:.0f}/{ram_total:.0f} {dest_unit.name}"
+                            )
                         except ValueError:
                             # ram_match.group(1) or ram_match.group(3) couldn't be parsed as a float.
                             self._hardware_info[setting] = "Error"

robocop_ng/helpers/userlogs.py

@@ -2,7 +2,7 @@ import json
 import os
 import time
 
-from robocop_ng.helpers.notifications import report_critical_error
+from robocop_ng.helpers.data_loader import read_json
 
 userlog_event_types = {
     "warns": "Warn",
@@ -18,20 +18,7 @@ def get_userlog_path(bot):
 
 
 def get_userlog(bot):
-    if os.path.isfile(get_userlog_path(bot)):
-        with open(get_userlog_path(bot), "r") as f:
-            try:
-                return json.load(f)
-            except json.JSONDecodeError as e:
-                content = f.read()
-                report_critical_error(
-                    bot,
-                    e,
-                    additional_info={
-                        "file": {"length": len(content), "content": content}
-                    },
-                )
-    return {}
+    return read_json(bot, get_userlog_path(bot))
 
 
 def set_userlog(bot, contents):