Add ability to take notes resolves #128

Author: kyb3r

CHANGELOG.md

@@ -4,6 +4,10 @@ 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.9.0
+
+### Added
+- New command `note` will add a system message to your thread logs. This is useful for noting the context of a conversation.
 
 # v2.8.1
 ### Fixed

bot.py

@@ -22,7 +22,7 @@
 SOFTWARE.
 """
 
-__version__ = '2.8.1'
+__version__ = '2.9.0'
 
 import asyncio
 import textwrap

cogs/modmail.py

@@ -377,6 +377,15 @@ async def reply(self, ctx, *, msg=''):
         thread = await self.bot.threads.find(channel=ctx.channel)
         if thread:
             await thread.reply(ctx.message)
+    
+    @commands.command()
+    @trigger_typing
+    async def note(self, ctx, *, msg=''):
+        """Take a note about the current thread, useful for noting context."""
+        ctx.message.content = msg 
+        thread = await self.bot.threads.find(channel=ctx.channel)
+        if thread:
+            await thread.note(ctx.message)
 
     @commands.command()
     async def edit(self, ctx, message_id: Optional[int]=None, *, new_message):

core/clients.py

@@ -151,7 +151,7 @@ def get_log_url(self, recipient, channel, creator):
             }
         })
 
-    def append_log(self, message, channel_id=''):
+    def append_log(self, message, channel_id='', type='thread_message'):
         channel_id = str(channel_id) or str(message.channel.id)
         payload = {
             'payload': {
@@ -167,7 +167,8 @@ def append_log(self, message, channel_id=''):
                 },
                 # message properties
                 'content': message.content,
-                'attachments': [i.url for i in message.attachments]
+                'attachments': [i.url for i in message.attachments],
+                'type': type
             }
         }
         return self.request(self.logs + f'/{channel_id}', method='PATCH', payload=payload)
@@ -247,7 +248,7 @@ async def update_config(self, data):
         data = {k: v for k, v in data.items() if k in valid_keys}
         return await self.db.config.update_one({'bot_id': self.app.user.id}, {'$set': data})
 
-    async def append_log(self, message, channel_id=''):
+    async def append_log(self, message, channel_id='', type='thread_message'):
         channel_id = str(channel_id) or str(message.channel.id)
         payload = {
                 'timestamp': str(message.created_at),
@@ -262,7 +263,8 @@ async def append_log(self, message, channel_id=''):
                 },
                 # message properties
                 'content': message.content,
-                'attachments': [i.url for i in message.attachments]
+                'attachments': [i.url for i in message.attachments],
+                'type': type
             }
 
         return await self.logs.find_one_and_update(

core/thread.py

@@ -89,6 +89,7 @@ async def _close(self, closer, silent=False, delete_channel=True,
         log_data = await self.bot.modmail_api.post_log(self.channel.id, {
             'open': False,
             'closed_at': str(datetime.datetime.utcnow()),
+            'close_message': message,
             'closer': {
                 'id': str(closer.id),
                 'name': closer.name,
@@ -98,24 +99,23 @@ async def _close(self, closer, silent=False, delete_channel=True,
             }
         })
 
-        if isinstance(log_data, str):
-            print(log_data)  # errored somehow on server
-            return
-
-        if self.bot.selfhosted:
-            log_url = f"{self.bot.config.log_url.strip('/')}/logs/{log_data['key']}"
-        else:
-            log_url = f"https://logs.modmail.tk/{log_data['key']}"
+        if not isinstance(log_data, str) or log_data is not None:
+            if self.bot.selfhosted:
+                log_url = f"{self.bot.config.log_url.strip('/')}/logs/{log_data['key']}"
+            else:
+                log_url = f"https://logs.modmail.tk/{log_data['key']}"
 
-        user = self.recipient.mention if self.recipient else f'`{self.id}`'
+            user = self.recipient.mention if self.recipient else f'`{self.id}`'
 
-        if log_data['messages']:
-            msg = str(log_data['messages'][0]['content'])
-            sneak_peak = msg if len(msg) < 50 else msg[:48] + '...'
+            if log_data['messages']:
+                msg = str(log_data['messages'][0]['content'])
+                sneak_peak = msg if len(msg) < 50 else msg[:48] + '...'
+            else:
+                sneak_peak = 'No content'
+            
+            desc = f"{user} [`{log_data['key']}`]({log_url}): {sneak_peak}"
         else:
-            sneak_peak = 'No content'
-
-        desc = f"{user} [`{log_data['key']}`]({log_url}): {sneak_peak}"
+            desc = "Could not resolve log url."
 
         em = discord.Embed(description=desc, color=discord.Color.red())
 
@@ -172,6 +172,16 @@ def edit_message(self, message_id, message):
             self._edit_thread_message(self.recipient, message_id, message),
             self._edit_thread_message(self.channel, message_id, message)
         )
+    
+    async def note(self, message):
+        if not message.content and not message.attachments:
+            raise commands.UserInputError
+            
+        await asyncio.gather(
+            self.bot.modmail_api.append_log(message, self.channel.id, type='system'),
+            self.send(message, self.channel, note=True)
+        )
+        
 
     async def reply(self, message):
         if not message.content and not message.attachments:
@@ -204,15 +214,15 @@ async def reply(self, message):
 
         await asyncio.gather(*tasks)
 
-    async def send(self, message, destination=None, from_mod=False):
+    async def send(self, message, destination=None, from_mod=False, note=False):
         if self.close_task is not None:
             # cancel closing if a thread message is sent.
             await self.cancel_closure()
             await self.channel.send(embed=discord.Embed(
                 color=discord.Color.red(),
                 description='Scheduled close has been cancelled.'))
 
-        if not from_mod:
+        if not from_mod and not note:
             self.bot.loop.create_task(
                 self.bot.modmail_api.append_log(message, self.channel.id)
                 )
@@ -229,9 +239,11 @@ async def send(self, message, destination=None, from_mod=False):
             timestamp=message.created_at
         )
 
+        system_avatar_url = 'https://discordapp.com/assets/f78426a064bc9dd24847519259bc42af.png'
+
         # store message id in hidden url
-        em.set_author(name=str(author),
-                      icon_url=author.avatar_url,
+        em.set_author(name=str(author) if not note else 'Note',
+                      icon_url=author.avatar_url if not note else system_avatar_url,
                       url=message.jump_url)
 
         image_types = ['.png', '.jpg', '.gif', '.jpeg', '.webp']
@@ -282,6 +294,9 @@ def is_image_url(u, _):
         if from_mod:
             em.color = discord.Color.green()
             em.set_footer(text=f'Moderator')
+        elif note:
+            em.color = discord.Color.blurple()
+            em.set_footer(text=f'System ({author.name})')
         else:
             em.color = discord.Color.gold()
             em.set_footer(text=f'User')