Merge branch 'main' into tests/test-error-handler

docs/changelog.md

@@ -7,8 +7,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-### Added
+### Breaking
+- Bot now requires a `RELAY_CHANNEL_ID` configuration variable. (#53)
+    - This is where tickets with users will be relayed.
+    - At a later point in time, this will be additionally included in a configuration command.
 
+### Added
+- Threads system (#53)
+    - Messages can now be relayed between a user and a server.
+    - NOTE: There is not a database yet, so none of these messages are stored.
 - Added Dispatcher system, although it is not hooked into important features like thread creation yet. (#71)
 - Officially support python 3.10 (#119)
 - Officially support windows and macos (#121)

modmail/bot.py

@@ -16,6 +16,7 @@
 from modmail.log import ModmailLogger
 from modmail.utils.extensions import EXTENSIONS, NO_UNLOAD, walk_extensions
 from modmail.utils.plugins import PLUGINS, walk_plugins
+from modmail.utils.threads import Ticket
 
 
 REQUIRED_INTENTS = Intents(
@@ -38,9 +39,11 @@ class ModmailBot(commands.Bot):
     logger: ModmailLogger = logging.getLogger(__name__)
     dispatcher: Dispatcher
 
+    _tickets: t.Dict[int, Ticket] = dict()
+
     def __init__(self, **kwargs):
         self.config = config()
-        self.start_time: t.Optional[arrow.Arrow] = None  # arrow.utcnow()
+        self.start_time: arrow.Arrow = arrow.utcnow()
         self.http_session: t.Optional[aiohttp.ClientSession] = None
         self.dispatcher = Dispatcher()
 

modmail/config.py

@@ -6,6 +6,7 @@
 import types
 import typing
 from collections import defaultdict
+from typing import Optional
 
 import attr
 import desert
@@ -383,6 +384,26 @@ class EmojiConfig:
     )
 
 
+@attr.mutable(slots=True)
+class ThreadConfig:
+    """Thread configuration."""
+
+    thread_mention_role_id: Optional[int] = attr.ib(
+        default=0,
+        metadata={
+            METADATA_TABLE: ConfigMetadata(
+                description="Role to mention on ticket creation.",
+            )
+        },
+        converter=int,
+    )
+    relay_channel_id: Optional[int] = attr.ib(
+        default=0,
+        metadata={METADATA_TABLE: ConfigMetadata(description="Channel to use for creating tickets.")},
+        converter=int,
+    )
+
+
 @attr.s(auto_attribs=True, slots=True)
 class BaseConfig:
     """
@@ -406,6 +427,7 @@ class BaseConfig:
         },
     )
     emojis: EmojiConfig = EmojiConfig()
+    threads: ThreadConfig = ThreadConfig()
 
 
 # build configuration

modmail/default_config.toml

@@ -19,3 +19,7 @@ production = true
 [emojis]
 failure = ":x:"
 success = ":thumbsup:"
+
+[threads]
+relay_channel_id = 0
+thread_mention_role_id = 0

modmail/default_config.yaml

@@ -14,3 +14,6 @@ dev:
 emojis:
     failure: ':x:'
     success: ':thumbsup:'
+threads:
+    relay_channel_id: 0
+    thread_mention_role_id: 0