Implement automod extension (#40)

* WIP

* Revise errors

* More adjustments and fixes

* Update dependencies

* Update changelog

* Remove debugging code for #39

* Implement message_delete event

* Fix AutomodEventBase.format_content

* Rename message_pinged -> message_mentioned

* More renaming and abstractions

* Consolidate data encoding and make string templates safe

* Implement the ability to enable/disable rules

* Implement configurable logging with error reporting

* Implement new triggers, conditions, and actions

* Remove useless MemberBanned event/trigger

* Implement generic reaction trigger

* Fix incorrect use of member field access

* Seriously

* Extend and improve existing conditions

* Add missing docs to SendMessage action

* Implement more actions

* Run rules in parallel

* Adjust exception sub-classing

* Implement `any_of` and `all_of` conditions

* Reorganize utils

* Implement more conditions

* Extend and improve ExtendedJsonEncoder

* Fix TargetRolesBase deserialization

* Fix TargetIsNotBotBase check

* Adjust docs for AutomodRule

* Extend and improve error logging

Author: Arcensoth

.gitignore

@@ -1,6 +1,7 @@
 .pytest_cache/**
 **/__pycache__
 venv/**
+bot/**
 dist/**
 *.egg-info/**
 

CHANGELOG.md

@@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ## [Unreleased]
 
+### Added
+
+- Added `automod` extension
+
 ### Fixed
 
 - Fixed a race condition with `JsonFileDatabaseAdapter` (#39)

commanderbot_ext/ext/automod/__init__.py

@@ -0,0 +1,8 @@
+from discord.ext.commands import Bot
+
+from commanderbot_ext.ext.automod.automod_cog import AutomodCog
+from commanderbot_ext.lib.utils import add_configured_cog
+
+
+def setup(bot: Bot):
+    add_configured_cog(bot, __name__, AutomodCog)

commanderbot_ext/ext/automod/actions/__init__.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from typing import Optional, Tuple
+
+from discord import Guild, Member
+
+from commanderbot_ext.ext.automod.automod_action import AutomodActionBase
+from commanderbot_ext.ext.automod.automod_event import AutomodEvent
+from commanderbot_ext.lib import RoleID
+
+
+@dataclass
+class AddRolesToTargetBase(AutomodActionBase):
+    roles: Tuple[RoleID]
+
+    def get_target(self, event: AutomodEvent) -> Optional[Member]:
+        raise NotImplementedError()
+
+    async def apply(self, event: AutomodEvent):
+        if member := self.get_target(event):
+            guild: Guild = member.guild
+            roles = [guild.get_role(role_id) for role_id in self.roles]
+            await member.add_roles(roles)

commanderbot_ext/ext/automod/actions/abc/__init__.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from typing import Optional, Tuple
+
+from discord import Guild, Member
+
+from commanderbot_ext.ext.automod.automod_action import AutomodActionBase
+from commanderbot_ext.ext.automod.automod_event import AutomodEvent
+from commanderbot_ext.lib import RoleID
+
+
+@dataclass
+class RemoveRolesFromTargetBase(AutomodActionBase):
+    roles: Tuple[RoleID]
+
+    def get_target(self, event: AutomodEvent) -> Optional[Member]:
+        raise NotImplementedError()
+
+    async def apply(self, event: AutomodEvent):
+        if member := self.get_target(event):
+            guild: Guild = member.guild
+            roles = [guild.get_role(role_id) for role_id in self.roles]
+            await member.remove_roles(roles)

commanderbot_ext/ext/automod/actions/abc/add_roles_to_target_base.py

@@ -0,0 +1,29 @@
+from dataclasses import dataclass
+from typing import Tuple
+
+from commanderbot_ext.ext.automod.automod_action import AutomodAction, AutomodActionBase
+from commanderbot_ext.ext.automod.automod_event import AutomodEvent
+from commanderbot_ext.lib import JsonObject
+
+
+@dataclass
+class AddReactions(AutomodActionBase):
+    """
+    Add reactions to the message in context.
+
+    Attributes
+    ----------
+    reactions
+        The reactions to add.
+    """
+
+    reactions: Tuple[str]
+
+    async def apply(self, event: AutomodEvent):
+        if message := event.message:
+            for reaction in self.reactions:
+                await message.add_reaction(reaction)
+
+
+def create_action(data: JsonObject) -> AutomodAction:
+    return AddReactions.from_data(data)

commanderbot_ext/ext/automod/actions/abc/remove_roles_from_target_base.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+from typing import Optional
+
+from discord import Member
+
+from commanderbot_ext.ext.automod.actions.abc.add_roles_to_target_base import (
+    AddRolesToTargetBase,
+)
+from commanderbot_ext.ext.automod.automod_action import AutomodAction
+from commanderbot_ext.ext.automod.automod_event import AutomodEvent
+from commanderbot_ext.lib import JsonObject
+
+
+@dataclass
+class AddRolesToActor(AddRolesToTargetBase):
+    """
+    Add roles to the actor in context.
+
+    Attributes
+    ----------
+    roles
+        The roles to add.
+    """
+
+    def get_target(self, event: AutomodEvent) -> Optional[Member]:
+        return event.actor
+
+
+def create_action(data: JsonObject) -> AutomodAction:
+    return AddRolesToActor.from_data(data)

commanderbot_ext/ext/automod/actions/add_reactions.py

@@ -0,0 +1,30 @@
+from dataclasses import dataclass
+from typing import Optional
+
+from discord import Member
+
+from commanderbot_ext.ext.automod.actions.abc.add_roles_to_target_base import (
+    AddRolesToTargetBase,
+)
+from commanderbot_ext.ext.automod.automod_action import AutomodAction
+from commanderbot_ext.ext.automod.automod_event import AutomodEvent
+from commanderbot_ext.lib import JsonObject
+
+
+@dataclass
+class AddRolesToAuthor(AddRolesToTargetBase):
+    """
+    Add roles to the author in context.
+
+    Attributes
+    ----------
+    roles
+        The roles to add.
+    """
+
+    def get_target(self, event: AutomodEvent) -> Optional[Member]:
+        return event.author
+
+
+def create_action(data: JsonObject) -> AutomodAction:
+    return AddRolesToAuthor.from_data(data)