Merge branch 'development' into patch-6

modmail-dev · Nov 19, 2023 · 8d7d5b9 · 8d7d5b9
2 parents ae6aa1d + a8d7c26
commit 8d7d5b9
Show file tree

Hide file tree

Showing 6 changed files with 180 additions and 111 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,12 +16,14 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 - Fixed a syntactic error in the close message when a thread is closed after a certain duration. ([PR #3233](https://github.com/modmail-dev/Modmail/pull/3233))
 - Removed an extra space in the help command title when the command has no parameters. ([PR #3271](https://github.com/modmail-dev/Modmail/pull/3271))
 - Corrected some incorrect config help descriptions. ([PR #3277](https://github.com/modmail-dev/Modmail/pull/3277))
+- Rate limit issue when fetch the messages due to reaction linking. ([PR #3306](https://github.com/modmail-dev/Modmail/pull/3306))
 
 ### Added
 - `?log key <key>` to retrieve the log link and view a preview using a log key. ([PR #3196](https://github.com/modmail-dev/Modmail/pull/3196))
 - `REGISTRY_PLUGINS_ONLY`, environment variable, when set, restricts to only allow adding registry plugins. ([PR #3247](https://github.com/modmail-dev/modmail/pull/3247))
 - `DISCORD_LOG_LEVEL` environment variable to set the log level of discord.py. ([PR #3216](https://github.com/modmail-dev/Modmail/pull/3216))
 - New registry plugin: [`autoreact`](https://github.com/martinbndr/kyb3r-modmail-plugins/tree/master/autoreact).
+- `STREAM_LOG_FORMAT` and `FILE_LOG_FORMAT` for settings the log format of the stream and file handlers respectively. Possible options are `json` and `plain` (default). ([PR #3305](https://github.com/modmail-dev/Modmail/pull/3305))
 
 ### Changed
 - Repo moved to https://github.com/modmail-dev/modmail.

diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@
   </a>
 
   <a href="https://www.python.org/downloads/">
-    <img src="https://img.shields.io/badge/Made%20With-Python%203.8-blue.svg?style=for-the-badge&logo=Python" alt="Made with Python 3.8">
+    <img src="https://img.shields.io/badge/Made%20With-Python%203.10-blue.svg?style=for-the-badge&logo=Python" alt="Made with Python 3.10">
   </a>
 
   <a href="https://github.com/ambv/black">
@@ -50,11 +50,13 @@ Modmail is similar to Reddit's Modmail, both in functionality and purpose. It se
 
 This bot is free for everyone and always will be. If you like this project and would like to show your appreciation, you can support us on **[Patreon](https://www.patreon.com/kyber)**, cool benefits included! 
 
+For up-to-date setup instructions, please visit our [**documentation**](https://docs.modmail.dev/installation) page.
+
 ## How does it work?
 
 When a member sends a direct message to the bot, Modmail will create a channel or "thread" into a designated category. All further DM messages will automatically relay to that channel; any available staff can respond within the channel.
 
-Our Logviewer will save the threads so you can view previous threads through their corresponding log link. Here is an [**example**](https://logs.modmail.dev/example).
+Our Logviewer will save the threads so you can view previous threads through their corresponding log link. ~~Here is an [**example**](https://logs.modmail.dev/example)~~ (demo not available at the moment).
 
 ## Features
 
@@ -67,7 +69,7 @@ Our Logviewer will save the threads so you can view previous threads through the
   * Minimum length for members to be in the guild before allowed to contact Modmail (`guild_age`). 
 
 * **Advanced Logging Functionality:**
-  * When you close a thread, Modmail will generate a [log link](https://logs.modmail.dev/example) and post it to your log channel.
+  * When you close a thread, Modmail will generate a log link and post it to your log channel.
   * Native Discord dark-mode feel.
   * Markdown/formatting support.
   * Login via Discord to protect your logs ([premium Patreon feature](https://patreon.com/kyber)).
@@ -84,88 +86,34 @@ This list is ever-growing thanks to active development and our exceptional contr
 
 ## Installation
 
-Q: Where can I find the Modmail bot invite link?
+There are a number of options for hosting your very own dedicated Modmail bot.
+
+Visit our [**documentation**](https://docs.modmail.dev/installation) page for detailed guidance on how to deploy your Modmail bot.
 
-A: Unfortunately, due to how this bot functions, it cannot be invited. The lack of an invite link is to ensure an individuality to your server and grant you full control over your bot and data. Nonetheless, you can quickly obtain a free copy of Modmail for your server by following one of the methods listed below (roughly takes 15 minutes of your time).
+### Patreon Hosting
 
-There are a few options for hosting your very own dedicated Modmail bot.
+If you don't want the trouble of renting and configuring your server to host Modmail, we got a solution for you! We offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber).
 
-1. Patreon hosting
-2. Local hosting (VPS, Dedicated Server, RPi, your computer, etc.)
-3. PaaS (we provide a guide for Heroku)
+## FAQ
 
-### Patreon Hosting
+**Q: Where can I find the Modmail bot invite link?**
+
+**A:** Unfortunately, due to how this bot functions, it cannot be invited. The lack of an invite link is to ensure an individuality to your server and grant you full control over your bot and data. Nonetheless, you can quickly obtain a free copy of Modmail for your server by following our [**documentation**](https://docs.modmail.dev/installation) steps or subscribe to [**Patreon**](https://patreon.com/kyber).
+
+**Q: Where can I find out more info about Modmail?**
+
+**A:** You can find more info about Modmail on our [**documentation**](https://docs.modmail.dev) page. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for help and support.
+
+## Plugins
+
+Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
+Plugins allow niche features as well as anything else outside of the scope of the core functionality of Modmail. 
+
+You can find a list of third-party plugins using the `?plugins registry`  command or visit the [Unofficial List of Plugins](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
 
-If you don't want the trouble of renting and configuring your server to host Modmail, we got a solution for you! We offer hosting and maintenance of your own, private Modmail bot (including a Logviewer) through [**Patreon**](https://patreon.com/kyber). Join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for more info! 
-
-### Local hosting (General Guide)
-
-Modmail can be hosted on any modern hardware, including your PC. For stability and reliability, we suggest purchasing a cloud server (VPS) for under $10/mo. If you need recommendations on choosing a VPS, join our [Discord server](https://discord.gg/cnUpwrnpYb), and we'll send you a list of non-affiliated hosting providers. Alternatively, we can host Modmail for you when you're subscribed to our [Patreon](https://patreon.com/kyber).
-
-This guide assumes you've downloaded [`Python 3.10`](https://www.python.org/downloads/release/python-376/) and added python and pip to PATH.
-
-1. Clone this repo
-    ```console
-    $ git clone https://github.com/modmail-dev/modmail
-    $ cd modmail
-    ```
-2. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/modmail-dev/modmail/wiki/Installation#2-discord-bot-account))
-3. Create a free MongoDB database ([guide](https://github.com/modmail-dev/modmail/wiki/Installation-(cont.)#3-create-a-database), follow it carefully!)
-4. Rename the file `.env.example` to `.env` and fill it with appropriate values
-   - If you can't find `.env.example` because it's hidden, create a new text file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/.env.example) and replace the placeholders with their values
-   - If you're on Windows and cannot save the file as `.env`, save it as `.env.` instead (this only applies to Windows!)
-   - If you do not have a Logviewer yet, leave the `LOG_URL` field as-is
-5. Update pip, install pipenv, and install dependencies using pipenv
-    ```console
-    $ pip install -U pip
-    $ pip install pipenv
-    $ pipenv install
-    ```
-6. Start the bot
-    ```console
-    $ pipenv run bot
-    ```
-7. Set up the Logviewer, see the [Logviewer installation guide](https://github.com/modmail-dev/logviewer)
-
-### Local Hosting (Docker)
-
-We provide support for Docker to simplify the deployment of Modmail and Logviewer. 
-We assume you already have Docker and Docker Compose Plugin installed, if not, see [here](https://docs.docker.com/get-docker/).
-
-1. Create a Discord bot account, grant the necessary intents, and invite the bot ([guide](https://github.com/modmail-dev/modmail/wiki/Installation#2-discord-bot-account))
-2. Create a file named `.env`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/.env.example) and replace the placeholders with their values
-3. Create a file named `docker-compose.yml`, then copy the contents of [this file](https://raw.githubusercontent.com/modmail-dev/modmail/master/docker-compose.yml), do not change anything!
-4. Start the bot
-    ```console
-    $ docker compose up -d
-    ```
-   - For older Docker versions, you may need to run `docker-compose up -d` instead
-5. View the status of your bot, using `docker ps` and `docker logs [container-id]`
-
-Our Docker images are hosted on [GitHub Container Registry](ghcr.io), you can build your own image if you wish:
-```console
-$ docker build --tag=modmail:master .
-```
-
-Then simply remove `ghcr.io/modmail-dev/` from the `docker-compose.yml` file.
-
-### Local Hosting (OS-Specific)
-
-This guide is a WIP. Join our [Discord server](https://discord.gg/cnUpwrnpYb) for more info.
-
-### Platform as a Service (PaaS)
-
-You can host this bot on Heroku (no longer free).
-
-Installation via Heroku is possible with your web browser alone. 
-The [**installation guide**](https://github.com/modmail-dev/modmail/wiki/Installation) (which includes a video tutorial!) will guide you through the entire installation process. If you run into any problems, join our [Modmail Discord Server](https://discord.gg/cnUpwrnpYb) for help and support.
-
-When using Heroku, you can configure automatic updates:
- - Login to [GitHub](https://github.com/) and verify your account.
- - [Fork the repo](https://github.com/modmail-dev/modmail/fork).
- - Install the [Pull app](https://github.com/apps/pull) for your fork. 
- - Then go to the Deploy tab in your [Heroku account](https://dashboard.heroku.com/apps) of your bot app, select GitHub and connect your fork (usually by typing "Modmail"). 
- - Turn on auto-deploy for the `master` branch.
+To develop your own, check out the [plugins documentation](https://github.com/modmail-dev/modmail/wiki/Plugins).
+
+Plugins requests and support are available in our [Modmail Support Server](https://discord.gg/cnUpwrnpYb).
 
 ## Sponsors
 
@@ -208,17 +156,6 @@ Discord Advice Center:
 
 Become a sponsor on [Patreon](https://patreon.com/kyber).
 
-## Plugins
-
-Modmail supports the use of third-party plugins to extend or add functionalities to the bot.
-Plugins allow niche features as well as anything else outside of the scope of the core functionality of Modmail. 
-
-You can find a list of third-party plugins using the `?plugins registry`  command or visit the [Unofficial List of Plugins](https://github.com/modmail-dev/modmail/wiki/Unofficial-List-of-Plugins) for a list of plugins contributed by the community.
-
-To develop your own, check out the [plugins documentation](https://github.com/modmail-dev/modmail/wiki/Plugins).
-
-Plugins requests and support are available in our [Modmail Support Server](https://discord.gg/cnUpwrnpYb).
-
 ## Contributing
 
 Contributions to Modmail are always welcome, whether it be improvements to the documentation or new functionality, please feel free to make the change. Check out our [contributing guidelines](https://github.com/modmail-dev/modmail/blob/master/.github/CONTRIBUTING.md) before you get started.

diff --git a/bot.py b/bot.py
@@ -1220,33 +1220,44 @@ async def handle_reaction_events(self, payload):
             return
 
         channel = self.get_channel(payload.channel_id)
-        if not channel:  # dm channel not in internal cache
-            _thread = await self.threads.find(recipient=user)
-            if not _thread:
+        thread = None
+        # dm channel not in internal cache
+        if not channel:
+            thread = await self.threads.find(recipient=user)
+            if not thread:
+                return
+            channel = await thread.recipient.create_dm()
+            if channel.id != payload.channel_id:
+                return
+
+        from_dm = isinstance(channel, discord.DMChannel)
+        from_txt = isinstance(channel, discord.TextChannel)
+        if not from_dm and not from_txt:
+            return
+
+        if not thread:
+            params = {"recipient": user} if from_dm else {"channel": channel}
+            thread = await self.threads.find(**params)
+            if not thread:
                 return
-            channel = await _thread.recipient.create_dm()
 
+        # thread must exist before doing this API call
         try:
             message = await channel.fetch_message(payload.message_id)
         except (discord.NotFound, discord.Forbidden):
             return
 
         reaction = payload.emoji
-
         close_emoji = await self.convert_emoji(self.config["close_emoji"])
-
-        if isinstance(channel, discord.DMChannel):
-            thread = await self.threads.find(recipient=user)
-            if not thread:
-                return
+        if from_dm:
             if (
                 payload.event_type == "REACTION_ADD"
                 and message.embeds
                 and str(reaction) == str(close_emoji)
                 and self.config.get("recipient_thread_close")
             ):
                 ts = message.embeds[0].timestamp
-                if thread and ts == thread.channel.created_at:
+                if ts == thread.channel.created_at:
                     # the reacted message is the corresponding thread creation embed
                     # closing thread
                     return await thread.close(closer=user)
@@ -1266,11 +1277,10 @@ async def handle_reaction_events(self, payload):
                 logger.warning("Failed to find linked message for reactions: %s", e)
                 return
         else:
-            thread = await self.threads.find(channel=channel)
-            if not thread:
-                return
             try:
-                _, *linked_messages = await thread.find_linked_messages(message.id, either_direction=True)
+                _, *linked_messages = await thread.find_linked_messages(
+                    message1=message, either_direction=True
+                )
             except ValueError as e:
                 logger.warning("Failed to find linked message for reactions: %s", e)
                 return

diff --git a/core/config.py b/core/config.py
@@ -178,6 +178,8 @@ class ConfigManager:
         "disable_updates": False,
         # Logging
         "log_level": "INFO",
+        "stream_log_format": "plain",
+        "file_log_format": "plain",
         "discord_log_level": "INFO",
         # data collection
         "data_collection": True,

diff --git a/core/config_help.json b/core/config_help.json
@@ -1140,6 +1140,24 @@
       "This configuration can only to be set through `.env` file or environment (config) variables."
     ]
   },
+  "stream_log_format": {
+    "default": "plain",
+    "description": "The logging format when through a stream, can be 'plain' or 'json'",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
+  "file_log_format": {
+    "default": "plain",
+    "description": "The logging format when logging to a file, can be 'plain' or 'json'",
+    "examples": [
+    ],
+    "notes": [
+      "This configuration can only to be set through `.env` file or environment (config) variables."
+    ]
+  },
   "discord_log_level": {
     "default": "INFO",
     "description": "The `discord.py` library logging level for logging to stdout.",