add .acl show_pretty command

Author: rattus-ratgirl

bot/acl.py

@@ -104,6 +104,36 @@ def parse_data(data: ACLData) -> ACLExpr:
             return NestedACL(data["acl"])
         raise ValueError("Invalid ACL data: {!r}".format(data))
 
+    @staticmethod
+    def format_markdown(data: ACLData, indent: int = 0) -> str:
+        """
+        Return a markdown-formatted string representation of the ACL's data,
+        converting IDs into Discord mentions where possible.
+        """
+        pad = "  " * indent + "- "
+
+        if "role" in data:
+            return f"{pad}role: <@&{data['role']}>"
+        elif "user" in data:
+            return f"{pad}user: <@{data['user']}>"
+        elif "channel" in data:
+            return f"{pad}channel: <#{data['channel']}>"
+        elif "category" in data:
+            cat = data["category"]
+            return f"{pad}category: {f'<#{cat}>' if cat else '*(none)*'}"
+        elif "not" in data:
+            inner = ACL.format_markdown(data["not"], indent + 1)
+            return f"{pad}not:\n{inner}"
+        elif "and" in data:
+            parts = [ACL.format_markdown(d, indent + 1) for d in data["and"]]
+            return f"{pad}and:\n" + "\n".join(parts)
+        elif "or" in data:
+            parts = [ACL.format_markdown(d, indent + 1) for d in data["or"]]
+            return f"{pad}or:\n" + "\n".join(parts)
+        elif "acl" in data:
+            return f"{pad}acl: `{data['acl']}`"
+        raise ValueError(f"Invalid ACL data: {data!r}")
+
     def parse(self) -> ACLExpr:
         return ACL.parse_data(self.data)
 

plugins/db_manager.py

@@ -2,6 +2,7 @@
 from typing import Dict, List, Optional, Set, Union, cast
 
 import asyncpg
+import discord
 from discord.ext.commands import Greedy, command, group
 from sqlalchemy import select
 from sqlalchemy.ext.asyncio import AsyncSession
@@ -158,6 +159,17 @@ async def acl_show(ctx: Context, acl: str) -> None:
     await ctx.send(format("{!b:yaml}", yaml.dump(data.data)))
 
 
+@acl_command.command("show_pretty")
+@privileged
+async def acl_show_pretty(ctx: Context, acl: str) -> None:
+    """Show the formula for the given ACL, formatted as markdown."""
+    async with AsyncSession(util.db.engine) as session:
+        if (acl_obj := await session.get(bot.acl.ACL, acl)) is None:
+            raise UserError(format("No such ACL: {!i}", acl))
+
+    await ctx.send(ACL.format_markdown(acl_obj.data), allowed_mentions=discord.AllowedMentions.none())
+
+
 acl_override = register_action("acl_override")