Removeuser (resolve #3065), silent adding/removing (#3054)

Author: fourjr

Diff for: CHANGELOG.md

@@ -8,6 +8,12 @@ however, insignificant breaking changes do not guarantee a major version bump, s
 
 # v3.10.0-dev4
 
+v3.10 adds group conversations while resolving othre bugs and QOL changes. It is potentially breaking to some plugins that adds functionality to threads.
+
+## Breaking
+
+- `Thread.recipient` (`str`) is now `Thread.recipients` (`List[str]`).
+
 ## Added
 
 - Ability to have group conversations. ([GH #143](https://github.com/kyb3r/modmail/issues/143))

Diff for: cogs/modmail.py

@@ -675,8 +675,11 @@ async def title(self, ctx, *, name: str):
     @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     @commands.cooldown(1, 600, BucketType.channel)
-    async def adduser(self, ctx, *, user: discord.Member):
-        """Adds a user to a modmail thread"""
+    async def adduser(self, ctx, user: discord.Member, *, options: str.lower = ""):
+        """Adds a user to a modmail thread
+
+        `options` can be `silent` or `silently`.
+        """
 
         curr_thread = await self.bot.threads.find(recipient=user)
         if curr_thread:
@@ -686,30 +689,88 @@ async def adduser(self, ctx, *, user: discord.Member):
                 color=self.bot.error_color,
             )
             await ctx.send(embed=em)
+            ctx.command.reset_cooldown(ctx)
         else:
+            if 'silent' not in options and 'silently' not in options:
+                em = discord.Embed(
+                    title="New Thread (Group)",
+                    description=f"{ctx.author.name} has added you to a Modmail thread.",
+                    color=self.bot.main_color,
+                )
+                if self.bot.config["show_timestamp"]:
+                    em.timestamp = datetime.utcnow()
+                em.set_footer(text=f"{ctx.author}", icon_url=ctx.author.avatar_url)
+                await user.send(embed=em)
+
+                em = discord.Embed(
+                    title="New User",
+                    description=f"{ctx.author.name} has added {user.name} to the Modmail thread.",
+                    color=self.bot.main_color,
+                )
+                if self.bot.config["show_timestamp"]:
+                    em.timestamp = datetime.utcnow()
+                em.set_footer(text=f"{user}", icon_url=user.avatar_url)
+
+                for i in ctx.thread.recipients:
+                    if i != user:
+                        await i.send(embed=em)
+
+            await ctx.thread.add_user(user)
+            sent_emoji, _ = await self.bot.retrieve_emoji()
+            await self.bot.add_reaction(ctx.message, sent_emoji)
+
+    @commands.command(cooldown_after_parsing=True)
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
+    @checks.thread_only()
+    @commands.cooldown(1, 600, BucketType.channel)
+    async def removeuser(self, ctx, user: discord.Member, *, options: str.lower = ""):
+        """Removes a user from a modmail thread
+
+        `options` can be `silent` or `silently`.
+        """
+
+        curr_thread = await self.bot.threads.find(recipient=user)
+        if ctx.thread != curr_thread:
             em = discord.Embed(
-                title="New Thread (Group)",
-                description=f"{ctx.author.name} has added you to a Modmail thread.",
-                color=self.bot.main_color,
+                title="Error",
+                description="User is not in this thread.",
+                color=self.bot.error_color,
             )
-            if self.bot.config["show_timestamp"]:
-                em.timestamp = datetime.utcnow()
-            em.set_footer(text=f"{ctx.author}", icon_url=ctx.author.avatar_url)
-            await user.send(embed=em)
-
+            await ctx.send(embed=em)
+            ctx.command.reset_cooldown(ctx)
+        elif ctx.thread.recipient == user:
             em = discord.Embed(
-                title="New User",
-                description=f"{ctx.author.name} has added {user.name} to the Modmail thread.",
-                color=self.bot.main_color,
+                title="Error",
+                description="User is the main recipient of the thread and cannot be removed.",
+                color=self.bot.error_color,
             )
-            if self.bot.config["show_timestamp"]:
-                em.timestamp = datetime.utcnow()
-            em.set_footer(text=f"{user}", icon_url=user.avatar_url)
+            await ctx.send(embed=em)
+            ctx.command.reset_cooldown(ctx)
+        else:
+            if 'silent' not in options and 'silently' not in options:
+                em = discord.Embed(
+                    title="Removed From Thread (Group)",
+                    description=f"{ctx.author.name} has been removed from the Modmail thread.",
+                    color=self.bot.main_color,
+                )
+                if self.bot.config["show_timestamp"]:
+                    em.timestamp = datetime.utcnow()
+                em.set_footer(text=f"{ctx.author}", icon_url=ctx.author.avatar_url)
+                await user.send(embed=em)
 
-            for i in ctx.thread.recipients:
-                await i.send(embed=em)
+                em = discord.Embed(
+                    title="User Removed",
+                    description=f"{ctx.author.name} has removed {user.name} from the Modmail thread.",
+                    color=self.bot.main_color,
+                )
+                if self.bot.config["show_timestamp"]:
+                    em.timestamp = datetime.utcnow()
+                em.set_footer(text=f"{user}", icon_url=user.avatar_url)
 
-            await ctx.thread.add_user(user)
+                for i in ctx.thread.recipients:
+                    await i.send(embed=em)
+
+            await ctx.thread.remove_user(user)
             sent_emoji, _ = await self.bot.retrieve_emoji()
             await self.bot.add_reaction(ctx.message, sent_emoji)
 

Diff for: core/thread.py

@@ -57,7 +57,10 @@ def __init__(
         self._cancelled = False
 
     def __repr__(self):
-        return f'Thread(recipient="{self.recipient or self.id}", channel={self.channel.id}, other_recipienets={len(self._other_recipients)})'
+        return f'Thread(recipient="{self.recipient or self.id}", channel={self.channel.id}, other_recipients={len(self._other_recipients)})'
+
+    def __eq__(self, other):
+        return self.id == other.id
 
     async def wait_until_ready(self) -> None:
         """Blocks execution until the thread is fully set up."""
@@ -115,13 +118,19 @@ async def from_channel(cls, manager: "ThreadManager", channel: discord.TextChann
         recipient_id = match_user_id(
             channel.topic
         )  # there is a chance it grabs from another recipient's main thread
-        recipient = manager.bot.get_user(recipient_id) or await manager.bot.fetch_user(recipient_id)
 
-        other_recipients = match_other_recipients(channel.topic)
-        for n, uid in enumerate(other_recipients):
-            other_recipients[n] = manager.bot.get_user(uid) or await manager.bot.fetch_user(uid)
+        if recipient_id in manager.cache:
+            thread = manager.cache[recipient_id]
+        else:
+            recipient = manager.bot.get_user(recipient_id) or await manager.bot.fetch_user(recipient_id)
 
-        return cls(manager, recipient or recipient_id, channel, other_recipients)
+            other_recipients = match_other_recipients(channel.topic)
+            for n, uid in enumerate(other_recipients):
+                other_recipients[n] = manager.bot.get_user(uid) or await manager.bot.fetch_user(uid)
+
+            thread = cls(manager, recipient or recipient_id, channel, other_recipients)
+
+        return thread
 
     async def setup(self, *, creator=None, category=None, initial_message=None):
         """Create the thread channel and other io related initialisation tasks"""
@@ -1088,6 +1097,16 @@ async def add_user(self, user: typing.Union[discord.Member, discord.User]) -> No
         ids = ",".join(str(i.id) for i in self._other_recipients)
         await self.channel.edit(topic=f"Title: {title}\nUser ID: {user_id}\nOther Recipients: {ids}")
 
+    async def remove_user(self, user: typing.Union[discord.Member, discord.User]) -> None:
+        title = match_title(self.channel.topic)
+        user_id = match_user_id(self.channel.topic)
+        self._other_recipients.remove(user)
+
+        ids = ",".join(str(i.id) for i in self._other_recipients)
+        await self.channel.edit(topic=f"Title: {title}\nUser ID: {user_id}\nOther Recipients: {ids}")
+        # if user.id in self.manager.cache:
+        #     self.manager.cache.pop(self.id)
+
 
 class ThreadManager:
     """Class that handles storing, finding and creating Modmail threads."""
@@ -1146,6 +1165,7 @@ async def find(
                     await thread.close(closer=self.bot.user, silent=True, delete_channel=False)
                     thread = None
         else:
+            print('in here')
             channel = discord.utils.find(
                 lambda x: str(recipient_id) in x.topic if x.topic else False,
                 self.bot.modmail_guild.text_channels,
@@ -1157,6 +1177,11 @@ async def find(
                     # only save if data is valid
                     self.cache[recipient_id] = thread
                 thread.ready = True
+
+        if thread and recipient_id not in [x.id for x in thread.recipients]:
+            self.cache.pop(recipient_id)
+            thread = None
+
         return thread
 
     async def _find_from_channel(self, channel):