Merge from "master" & fix some errors from previous commit

Author: Taaku18

CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# v2.11.0 
+
+### Added 
+- `loglink` command, returns the log link for the current thread.
+
+# v2.10.2
+
+### Changed
+- Your logs now track and show edited messages.
+
+# v2.10.1
+
+### Changed
+- Use reply author's top role for the mod tag by default.
 
 # v2.10.0
 

bot.py

@@ -22,7 +22,7 @@
 SOFTWARE.
 """
 
-__version__ = '2.10.0'
+__version__ = '2.11.0'
 
 import discord
 from discord.enums import ActivityType
@@ -477,6 +477,8 @@ async def on_message_edit(self, before, after):
                     if matches and matches[-1] == str(before.id):
                         embed.description = after.content
                         await msg.edit(embed=embed)
+                        await self.api.edit_message(str(after.id),
+                                                    after.content)
                         break
 
     async def on_command_error(self, ctx, error):

cogs/modmail.py

@@ -338,6 +338,16 @@ async def nsfw(self, ctx):
             return
         await ctx.channel.edit(nsfw=True)
         await ctx.message.add_reaction('✅')
+    
+    @commands.command()
+    async def loglink(self, ctx):
+        thread = await self.bot.threads.find(channel=ctx.channel)
+        if thread:
+            log_link = await self.bot.api.get_log_link(ctx.channel.id)
+            await ctx.send(embed=discord.Embed(
+                    color=discord.Color.blurple(), 
+                    description=log_link)
+                    )
 
     @commands.command(aliases=['threads'])
     @commands.has_permissions(manage_messages=True)
@@ -480,7 +490,9 @@ async def edit(self, ctx, message_id: Optional[int] = None,
         if not linked_message_id:
             raise commands.UserInputError
 
-        await thread.edit_message(linked_message_id, new_message)
+        await thread.edit_message(linked_message_id, new_message),
+        await self.bot.api.edit_message(linked_message_id, new_message)
+
         await ctx.message.add_reaction('✅')
 
     @commands.command()

core/clients.py

@@ -83,14 +83,14 @@ async def update_repository(self, sha: str = None) -> Optional[dict]:
 
     async def fork_repository(self) -> None:
         await self.request(self.FORK_URL, method='POST')
-    
+
     async def has_starred(self) -> bool:
         resp = await self.request(self.STAR_URL, return_response=True)
         return resp.status == 204
 
     async def star_repository(self) -> None:
         await self.request(self.STAR_URL, method='PUT',
-                           headers={'Content-Length':  '0'})
+                           headers={'Content-Length': '0'})
 
     # TODO: Broken.
     async def get_latest_commits(self, limit: int = 3) -> None:
@@ -153,14 +153,18 @@ async def get_user_logs(self, user_id):
     async def get_log(self, channel_id):
         return await self.request(self.LOGS + '/' + str(channel_id))
 
+    async def get_log_link(self, channel_id):
+        doc = await self.get_log(channel_id)
+        return f'https://logs.modmail.tk/{doc["key"]}'
+
     async def get_config(self):
         return await self.request(self.CONFIG)
 
     async def update_config(self, data):
         data = self.filter_valid(data)
         return await self.request(self.CONFIG, method='PATCH', payload=data)
 
-    async def get_log_url(self, recipient, channel, creator):
+    async def create_log_entry(self, recipient, channel, creator):
         return await self.request(self.LOGS + '/key', payload={
             'channel_id': str(channel.id),
             'guild_id': str(self.bot.guild_id),
@@ -180,8 +184,14 @@ async def get_log_url(self, recipient, channel, creator):
             }
         })
 
-    async def append_log(self, message, channel_id='', type_='thread_message'):
+    async def edit_message(self, message_id, new_content):
+        await self.request(self.LOGS + '/edit', method='PATCH',
+                           payload={
+                               'message_id': str(message_id),
+                               'new_content': new_content
+                           })
 
+    async def append_log(self, message, channel_id='', type_='thread_message'):
         channel_id = str(channel_id) or str(message.channel.id)
         data = {
             'payload': {
@@ -199,12 +209,12 @@ async def append_log(self, message, channel_id='', type_='thread_message'):
                 'content': message.content,
                 'type': type_,
                 'attachments': [
-                    {   
+                    {
                         'id': a.id,
                         'filename': a.filename,
                         'is_image': a.width is not None,
                         'size': a.size,
-                        'url': a.url 
+                        'url': a.url
                     } for a in message.attachments]
             }
         }
@@ -261,7 +271,11 @@ async def get_user_logs(self, user_id):
     async def get_log(self, channel_id):
         return await self.logs.find_one({'channel_id': str(channel_id)})
 
-    async def get_log_url(self, recipient, channel, creator):
+    async def get_log_link(self, channel_id):
+        doc = await self.get_log(channel_id)
+        return f"{self.bot.config.log_url.strip('/')}/logs/{doc['key']}"
+
+    async def create_log_entry(self, recipient, channel, creator):
         key = secrets.token_hex(6)
 
         await self.logs.insert_one({
@@ -287,7 +301,7 @@ async def get_log_url(self, recipient, channel, creator):
             },
             'closer': None,
             'messages': []
-            })
+        })
 
         return f"{self.bot.config.log_url.strip('/')}/logs/{key}"
 
@@ -303,31 +317,41 @@ async def update_config(self, data):
         return await self.db.config.update_one({'bot_id': self.bot.user.id},
                                                {'$set': data})
 
-    async def append_log(self, message, channel_id='', type_='thread_message'):
+    async def edit_message(self, message_id, new_content):
+        await self.logs.update_one({
+            'messages.message_id': str(message_id)
+        }, {
+            '$set': {
+                'messages.$.content': new_content,
+                'messages.$.edited': True
+            }
+        })
 
+    async def append_log(self, message, channel_id='', type_='thread_message'):
         channel_id = str(channel_id) or str(message.channel.id)
         data = {
-                'timestamp': str(message.created_at),
-                'message_id': str(message.id),
-                'author': {
-                    'id': str(message.author.id),
-                    'name': message.author.name,
-                    'discriminator': message.author.discriminator,
-                    'avatar_url': message.author.avatar_url,
-                    'mod': not isinstance(message.channel, DMChannel),
-                },
-                'content': message.content,
-                'type': type_,
-                'attachments': [
-                    {   
-                        'id': a.id,
-                        'filename': a.filename,
-                        'is_image': a.width is not None,
-                        'size': a.size,
-                        'url': a.url 
-                    } for a in message.attachments]
-            }
-        
+            'timestamp': str(message.created_at),
+            'message_id': str(message.id),
+            'author': {
+                'id': str(message.author.id),
+                'name': message.author.name,
+                'discriminator': message.author.discriminator,
+                'avatar_url': message.author.avatar_url,
+                'mod': not isinstance(message.channel, DMChannel),
+            },
+            'content': message.content,
+            'type': type_,
+            'attachments': [
+                {
+                    'id': a.id,
+                    'filename': a.filename,
+                    'is_image': a.width is not None,
+                    'size': a.size,
+                    'url': a.url
+                } for a in message.attachments
+            ]
+        }
+
         return await self.logs.find_one_and_update(
             {'channel_id': channel_id},
             {'$push': {f'messages': data}},

core/config.py

@@ -10,7 +10,7 @@ class ConfigManager(ConfigManagerABC):
 
     allowed_to_change_in_command = {
         # activity
-        'activity_message', 'activity_type', 'twitch_url',
+        'twitch_url',
         # bot settings
         'main_category_id', 'disable_autoupdates', 'prefix', 'mention',
         # logging
@@ -26,7 +26,7 @@ class ConfigManager(ConfigManagerABC):
     internal_keys = {
         'snippets', 'aliases', 'blocked',
         'notification_squad', 'subscriptions',
-        'closures'
+        'closures', 'activity_message', 'activity_type'
         }
 
     protected_keys = {

core/objects.py

@@ -171,6 +171,10 @@ async def validate_token(self) -> bool:
     async def get_log(self, channel_id: Union[str, int]) -> dict:
         raise NotImplementedError
 
+    @abc.abstractmethod
+    async def get_log_link(self, channel_id: Union[str, int]) -> str:
+        raise NotImplementedError
+
     @abc.abstractmethod
     async def get_config(self) -> dict:
         raise NotImplementedError
@@ -180,10 +184,10 @@ async def update_config(self, data: dict):
         raise NotImplementedError
 
     @abc.abstractmethod
-    async def get_log_url(self,
-                          recipient: Member,
-                          channel: TextChannel,
-                          creator: Member) -> str:
+    async def create_log_entry(self,
+                               recipient: Member,
+                               channel: TextChannel,
+                               creator: Member) -> str:
         raise NotImplementedError
 
     @abc.abstractmethod
@@ -207,6 +211,11 @@ async def get_metadata(self) -> dict:
     async def post_metadata(self, data: dict) -> dict:
         raise NotImplementedError
 
+    @abc.abstractmethod
+    async def edit_message(self, message_id: Union[int, str],
+                           new_content: str) -> None:
+        raise NotImplementedError
+
 
 class ConfigManagerABC(abc.ABC):
     @property
@@ -314,7 +323,8 @@ async def cancel_closure(self) -> None:
         raise NotImplementedError
 
     @abc.abstractmethod
-    def edit_message(self, message_id: Union[int, str], message: str) -> None:
+    async def edit_message(self, message_id: Union[int, str],
+                           message: str) -> None:
         raise NotImplementedError
 
     @abc.abstractmethod

core/paginator.py

@@ -107,13 +107,13 @@ async def run(self) -> typing.Optional[Message]:
             except (HTTPException, InvalidArgument):
                 pass
 
-    def previous_page(self) -> None:
+    async def previous_page(self) -> None:
         """Go to the previous page."""
-        self.show_page(self.current - 1)
+        await self.show_page(self.current - 1)
 
-    def next_page(self) -> None:
+    async def next_page(self) -> None:
         """Go to the next page"""
-        self.show_page(self.current + 1)
+        await self.show_page(self.current + 1)
 
     async def close(self, delete: bool = True) -> typing.Optional[Message]:
         """Delete this embed."""
@@ -132,10 +132,10 @@ async def close(self, delete: bool = True) -> typing.Optional[Message]:
         except HTTPException:
             pass
 
-    def first_page(self) -> None:
+    async def first_page(self) -> None:
         """Go to immediately to the first page"""
-        self.show_page(0)
+        await self.show_page(0)
 
-    def last_page(self) -> None:
+    async def last_page(self) -> None:
         """Go to immediately to the last page"""
-        self.show_page(len(self.embeds) - 1)
+        await self.show_page(len(self.embeds) - 1)

core/thread.py

@@ -202,8 +202,8 @@ async def _edit_thread_message(channel, message_id, message):
                     await msg.edit(embed=embed)
                     break
 
-    def edit_message(self, message_id, message):
-        asyncio.gather(
+    async def edit_message(self, message_id, message):
+        await asyncio.gather(
             self._edit_thread_message(self.recipient, message_id, message),
             self._edit_thread_message(self.channel, message_id, message)
         )
@@ -298,14 +298,11 @@ async def send(self, message, destination=None,
             if anonymous and from_mod and \
                not isinstance(destination, discord.TextChannel):
                 # Anonymously sending to the user.
-                name = self.bot.config.get(
-                    'anon_username',
-                    self.bot.config.get('mod_tag', 'Moderator')
-                )
-                avatar_url = self.bot.config.get(
-                    'anon_avatar_url',
-                    self.bot.guild.icon_url
-                )
+                tag = self.bot.config.get('mod_tag',
+                                          str(message.author.top_role))
+                name = self.bot.config.get('anon_username', tag)
+                avatar_url = self.bot.config.get('anon_avatar_url',
+                                                 self.bot.guild.icon_url)
             else:
                 # Normal message
                 name = str(author)
@@ -372,10 +369,9 @@ async def send(self, message, destination=None,
                 embed.set_footer(text='Anonymous Reply')
             # Normal messages
             elif not anonymous:
-                embed.set_footer(
-                    text=self.bot.config.get('mod_tag', 'Moderator')
-                )
-            # Anonymous reply sent to user
+                tag = self.bot.config.get('mod_tag',
+                                          str(message.author.top_role))
+                embed.set_footer(text=tag)  # Normal messages
             else:
                 embed.set_footer(
                     text=self.bot.config.get('anon_tag', 'Response')
@@ -539,13 +535,11 @@ async def create(self, recipient, *, creator=None, category=None):
         thread = Thread(self, recipient, channel)
         self.cache[recipient.id] = thread
 
-        log_url, log_data = await asyncio.gather(
-            self.bot.api.get_log_url(recipient,
-                                     channel,
-                                     creator or recipient),
-            self.bot.api.get_user_logs(recipient.id),
-            # self.get_dominant_color(recipient.avatar_url),
-        )
+        log_url = await self.bot.api.create_log_entry(recipient, channel,
+                                                      creator or recipient),
+
+        log_data = await self.bot.api.get_user_logs(recipient.id)
+        # await self.get_dominant_color(recipient.avatar_url)
 
         log_count = sum(1 for log in log_data if not log['open'])
         info_embed = self._format_info_embed(recipient, creator,