Add inbox actions, including dumping config to local file and force reloading config

Author: kdknigga

example_rules.yaml

@@ -12,6 +12,9 @@ general_settings:
   # Create posterity comments on new posts
   enable_create_posterity_comments: true
 
+  # Watch the private message inbox for commands from moderators
+  enable_inbox_actions: true
+
 posterity_comment_settings:
   # When these users post, don't create a posterity comment
   ignore_users:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rflying_tower_bot"
-version = "0.4.0"
+version = "0.5.0"
 description = ""
 authors = ["Kris Knigga <kris@knigga.com>"]
 

rflying_tower_bot/__init__.py

@@ -1,3 +1,3 @@
 """rflying_tower_bot package."""
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"

rflying_tower_bot/__main__.py

@@ -6,6 +6,7 @@
 import asyncpraw
 
 from rflying_tower_bot.config import BotConfig, PRAWConfig
+from rflying_tower_bot.inbox import Inbox
 from rflying_tower_bot.modlog import ModLog
 from rflying_tower_bot.post_stream import PostStream
 
@@ -34,8 +35,11 @@ async def main() -> None:
 
         modlog = ModLog(bot_config)
         post_stream = PostStream(bot_config)
+        inbox = Inbox(bot_config)
 
-        await asyncio.gather(modlog.watch_modlog(), post_stream.watch_poststream())
+        await asyncio.gather(
+            modlog.watch_modlog(), post_stream.watch_poststream(), inbox.watch_inbox()
+        )
 
 
 try:

rflying_tower_bot/inbox.py

@@ -0,0 +1,101 @@
+"""A module to react to private messages."""
+
+import logging
+from os import PathLike
+
+from asyncpraw.models import Subreddit
+
+from rflying_tower_bot.config import BotConfig, dump_current_settings
+from rflying_tower_bot.utilities import Utilities
+
+
+class Inbox:
+    """A class to react to new posts."""
+
+    def __init__(self, config: BotConfig) -> None:
+        """
+        Create an instance of Inbox.
+
+        Args:
+        ----
+            config (BotConfig): See config.BotConfig
+
+        """
+        self.log: logging.Logger = logging.getLogger(
+            f"{__name__}.{self.__class__.__name__}"
+        )
+        self.config = config
+        self.utilities = Utilities(config)
+
+    @staticmethod
+    async def do_dump_current_config(subreddit: Subreddit, path: PathLike) -> None:
+        """
+        Dump the current settings of the subreddit to a file.
+
+        Args:
+        ----
+            subreddit (Subreddit): The subreddit object.
+            path (PathLike): The path to the file where the settings will be dumped.
+
+        Returns:
+        -------
+            None
+
+        """
+        await dump_current_settings(subreddit, str(path))
+
+    async def watch_inbox(self) -> None:
+        """Watch the private message inbox and react to new messages."""
+        self.log.info("Watching the inbox for new messages")
+        subreddit = await self.config.reddit.subreddit(self.config.subreddit_name)
+        moderators = [moderator async for moderator in subreddit.moderator]
+        while True:
+            try:
+                # Skip existing messages to avoid processing the same message multiple times
+                # This is different from other streams, which do not skip existing items
+                # The idea is that commands are more timely than other events, so commands sent
+                # while the bot is offline probably shouldn't be done when the bot comes back online
+                async for message in self.config.reddit.inbox.stream(
+                    skip_existing=True
+                ):
+                    if (
+                        not self.config.rules
+                        or not self.config.rules.general_settings.enable_inbox_actions
+                    ):
+                        self.log.debug("Inbox actions disabled, skipping message")
+                        continue
+
+                    if message.author not in moderators:
+                        self.log.info(
+                            "Message from non-moderator %s: %s", message.author, message
+                        )
+                        continue
+
+                    self.log.info(
+                        "Message from moderator %s: %s", message.author, message
+                    )
+
+                    match message.subject:
+                        case "dump_current_config":
+                            self.log.info("Dumping config to file: %s", message.body)
+                            try:
+                                await self.do_dump_current_config(
+                                    subreddit, message.body
+                                )
+                            except Exception as e:
+                                self.log.error("Error dumping config: %s", e)
+                            await message.mark_read()
+
+                        case "reload_config":
+                            self.log.info("Reloading config")
+                            await self.config.update_rules()
+                            await message.mark_read()
+
+                        case _:
+                            self.log.warning("Unknown command: %s", message.subject)
+
+            except KeyboardInterrupt:
+                self.log.info("Caught keyboard interrupt, exiting inbox watcher")
+                break
+            except Exception as e:
+                self.log.error("Error in inbox watcher: %s", e)

rflying_tower_bot/ruleset_schemas.py

@@ -15,6 +15,7 @@ class GeneralSettings(BaseModel):
     enable_sync_post_flair: bool = True
     enable_flair_actions: bool = True
     enable_create_posterity_comments: bool = True
+    enable_inbox_actions: bool = True
 
 
 class PosterityCommentSettings(BaseModel):

tests/test_rflying_tower_bot.py

@@ -5,4 +5,4 @@
 
 def test_version():
     """Test the version of the rflying_tower_bot package."""
-    assert __version__ == "0.4.0"
+    assert __version__ == "0.5.0"