Improve formatting slightly

Author: kyb3r

CHANGELOG.md

@@ -4,6 +4,15 @@ 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).
 
+# [Unreleased]
+
+### Changed
+- Improve format of thread message embeds. Slightly cleaner and simpler now.
+- All commands are now blurple instead of green.
+
+### Added
+- Ability to set your own custom `mod_color` and `recipient_color` for the thread message embeds.
+
 # v2.9.1
 Changed order of arguments for the contact command. This is so that you can use aliases to their full potential. 
 For example: 

cogs/modmail.py

@@ -57,7 +57,7 @@ async def snippets(self, ctx):
 
         embeds = []
 
-        em = discord.Embed(color=discord.Color.green())
+        em = discord.Embed(color=discord.Color.blurple())
         em.set_author(name='Snippets', icon_url=ctx.guild.icon_url)
 
         embeds.append(em)
@@ -71,7 +71,7 @@ async def snippets(self, ctx):
 
         for name, value in self.bot.snippets.items():
             if len(em.fields) == 5:
-                em = discord.Embed(color=discord.Color.green(), description=em.description)
+                em = discord.Embed(color=discord.Color.blurple(), description=em.description)
                 em.set_author(name='Snippets', icon_url=ctx.guild.icon_url)
                 embeds.append(em)
             em.add_field(name=name, value=value, inline=False)
@@ -90,7 +90,7 @@ async def _add(self, ctx, name: str.lower, *, value):
 
         em = discord.Embed(
             title='Added snippet',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'`{name}` points to: {value}'
         )
 
@@ -102,7 +102,7 @@ async def __del(self, ctx, *, name: str.lower):
 
         em = discord.Embed(
             title='Removed snippet',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'`{name}` no longer exists.'
         )
 
@@ -224,7 +224,7 @@ async def notify(self, ctx, *, role=None):
         mentions.append(mention)
         await self.bot.config.update()
 
-        em = discord.Embed(color=discord.Color.green())
+        em = discord.Embed(color=discord.Color.blurple())
         em.description = f'{mention} will be mentioned on the next message received.'
         await ctx.send(embed=em)
 
@@ -257,7 +257,7 @@ async def subscribe(self, ctx, *, role=None):
         mentions.append(mention)
         await self.bot.config.update()
 
-        em = discord.Embed(color=discord.Color.green())
+        em = discord.Embed(color=discord.Color.blurple())
         em.description = f'{mention} is now subscribed to be notified of all messages received.'
         await ctx.send(embed=em)
 
@@ -288,7 +288,7 @@ async def unsubscribe(self, ctx, *, role=None):
         mentions.remove(mention)
         await self.bot.config.update()
 
-        em = discord.Embed(color=discord.Color.green())
+        em = discord.Embed(color=discord.Color.blurple())
         em.description = f'{mention} is now unsubscribed to this thread.'
         await ctx.send(embed=em)
 
@@ -336,7 +336,7 @@ async def logs(self, ctx, *, member: Union[discord.Member, discord.User, obj]=No
 
         for index, entry in enumerate(closed_logs):
             if len(embeds[-1].fields) == 3:
-                em = discord.Embed(color=discord.Color.green())
+                em = discord.Embed(color=discord.Color.blurple())
                 em.set_author(name='Previous Logs', icon_url=icon_url)
                 embeds.append(em)
 
@@ -406,7 +406,7 @@ async def edit(self, ctx, message_id: Optional[int]=None, *, new_message):
         async for msg in ctx.channel.history():
             if message_id is None and msg.embeds:
                 em = msg.embeds[0]
-                if 'Moderator' not in str(em.footer.text):
+                if em.color != discord.Color.green() or not em.author.url:
                     continue
                 linked_message_id = str(em.author.url).split('/')[-1]
                 break
@@ -417,7 +417,7 @@ async def edit(self, ctx, message_id: Optional[int]=None, *, new_message):
 
         if not linked_message_id:
             raise commands.UserInputError
-
+        
         await thread.edit_message(linked_message_id, new_message)
         await ctx.message.add_reaction('✅')
 
@@ -436,7 +436,7 @@ async def contact(self, ctx, category: Optional[discord.CategoryChannel]=None, *
         em = discord.Embed(
             title='Created thread',
             description=f'Thread started in {thread.channel.mention} for {user.mention}',
-            color=discord.Color.green()
+            color=discord.Color.blurple()
         )
 
         await ctx.send(embed=em)
@@ -446,7 +446,7 @@ async def contact(self, ctx, category: Optional[discord.CategoryChannel]=None, *
     @commands.has_permissions(manage_channels=True)
     async def blocked(self, ctx):
         """Returns a list of blocked users"""
-        em = discord.Embed(title='Blocked Users', color=discord.Color.green(), description='')
+        em = discord.Embed(title='Blocked Users', color=discord.Color.blurple(), description='')
 
         users = []
         not_reachable = []
@@ -487,7 +487,7 @@ async def block(self, ctx, user: Union[discord.Member, discord.User, obj]=None,
         mention = user.mention if hasattr(user, 'mention') else f'`{user.id}`'
 
         em = discord.Embed()
-        em.color = discord.Color.green()
+        em.color = discord.Color.blurple()
 
         if str(user.id) not in self.bot.blocked_users:
             self.bot.config.blocked[str(user.id)] = reason
@@ -520,7 +520,7 @@ async def unblock(self, ctx, *, user: Union[discord.Member, discord.User, obj]=N
         mention = user.mention if hasattr(user, 'mention') else f'`{user.id}`'
 
         em = discord.Embed()
-        em.color = discord.Color.green()
+        em.color = discord.Color.blurple()
 
         if str(user.id) in self.bot.blocked_users:
             del self.bot.config.blocked[str(user.id)]

cogs/utility.py

@@ -65,7 +65,7 @@ def format_cog_help(self, ctx, cog):
 
         em = discord.Embed(
             description='*' + inspect.getdoc(cog) + '*',
-            color=discord.Colour.green()
+            color=discord.Colour.blurple()
         )
         em.set_author(name=cog.__class__.__name__ + ' - Help', icon_url=ctx.bot.user.avatar_url)
 
@@ -82,7 +82,7 @@ def format_command_help(self, ctx, cmd):
         """Formats command help."""
         prefix = self.bot.prefix
         em = discord.Embed(
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=cmd.help
         )
 
@@ -218,7 +218,7 @@ async def github(self, ctx):
         em = discord.Embed(
             title='Github',
             description='Current User',
-            color=discord.Color.green()
+            color=discord.Color.blurple()
         )
         user = data['user']
         em.set_author(name=user['username'], icon_url=user['avatar_url'], url=user['url'])
@@ -236,7 +236,7 @@ async def update(self, ctx):
         em = discord.Embed(
             title='Already up to date',
             description=f'The latest version is [`{self.bot.version}`](https://github.com/kyb3r/modmail/blob/master/bot.py#L25)',
-            color=discord.Color.green()
+            color=discord.Color.blurple()
         )
 
         if metadata['latest_version'] == self.bot.version:
@@ -286,7 +286,7 @@ async def activity(self, ctx, activity_type: str, *, message: str = ''):
             await self.bot.config.update()
             em = discord.Embed(
                 title='Activity Removed',
-                color=discord.Color.green()
+                color=discord.Color.blurple()
             )
             return await ctx.send(embed=em)
 
@@ -308,7 +308,7 @@ async def activity(self, ctx, activity_type: str, *, message: str = ''):
         em = discord.Embed(
             title='Activity Changed',
             description=f'Current activity is: {activity_type.name} {message}.',
-            color=discord.Color.green()
+            color=discord.Color.blurple()
         )
         return await ctx.send(embed=em)
 
@@ -330,7 +330,7 @@ async def mention(self, ctx, *, mention=None):
         current = self.bot.config.get('mention', '@here')
         em = discord.Embed(
             title='Current text',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'{current}'
         )
 
@@ -351,7 +351,7 @@ async def prefix(self, ctx, *, prefix=None):
         current = self.bot.prefix
         em = discord.Embed(
             title='Current prefix',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'{current}'
         )
 
@@ -376,7 +376,7 @@ async def config(self, ctx):
     async def options(self, ctx):
         """Return a list of valid config keys you can change."""
         valid = ', '.join(f'`{k}`' for k in self.bot.config.allowed_to_change_in_command)
-        em = discord.Embed(title='Valid Keys', description=valid, color=discord.Color.green())
+        em = discord.Embed(title='Valid Keys', description=valid, color=discord.Color.blurple())
         await ctx.send(embed=em)
 
     @config.command(name='set')
@@ -387,13 +387,13 @@ async def _set(self, ctx, key: str.lower, *, value):
 
         em = discord.Embed(
             title='Success',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'Set `{key}` to `{value}`'
         )
 
         if key not in self.bot.config.allowed_to_change_in_command:
             em.title = 'Error'
-            em.color = discord.Color.green()
+            em.color = discord.Color.blurple()
             em.description = f'{key} is an invalid key.'
             valid_keys = [f'`{k}`' for k in self.bot.config.allowed_to_change_in_command]
             em.add_field(name='Valid keys', value=', '.join(valid_keys))
@@ -407,13 +407,13 @@ async def _del(self, ctx, key: str.lower):
         """Sets a specified key from the config to nothing."""
         em = discord.Embed(
             title='Success',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'Set `{key}` to nothing.'
         )
 
         if key not in self.bot.config.allowed_to_change_in_command:
             em.title = 'Error'
-            em.color = discord.Color.green()
+            em.color = discord.Color.blurple()
             em.description = f'{key} is an invalid key.'
             valid_keys = [f'`{k}`' for k in self.bot.config.allowed_to_change_in_command]
             em.add_field(name='Valid keys', value=', '.join(valid_keys))
@@ -426,12 +426,12 @@ async def _del(self, ctx, key: str.lower):
     @config.command(name='get')
     async def get(self, ctx, key=None):
         """Shows the config variables that are currently set."""
-        em = discord.Embed(color=discord.Color.green())
+        em = discord.Embed(color=discord.Color.blurple())
         em.set_author(name='Current config', icon_url=self.bot.user.avatar_url)
 
         if key and key not in self.bot.config.allowed_to_change_in_command:
             em.title = 'Error'
-            em.color = discord.Color.green()
+            em.color = discord.Color.blurple()
             em.description = f'`{key}` is an invalid key.'
             valid_keys = [f'`{k}`' for k in self.bot.config.allowed_to_change_in_command]
             em.add_field(name='Valid keys', value=', '.join(valid_keys))
@@ -460,7 +460,7 @@ async def aliases(self, ctx):
 
         embeds = []
 
-        em = discord.Embed(color=discord.Color.green())
+        em = discord.Embed(color=discord.Color.blurple())
         em.set_author(name='Command aliases', icon_url=ctx.guild.icon_url)
 
         embeds.append(em)
@@ -474,7 +474,7 @@ async def aliases(self, ctx):
 
         for name, value in self.bot.aliases.items():
             if len(em.fields) == 5:
-                em = discord.Embed(color=discord.Color.green(), description=em.description)
+                em = discord.Embed(color=discord.Color.blurple(), description=em.description)
                 em.set_author(name='Command aliases', icon_url=ctx.guild.icon_url)
                 em.set_footer(text=f'Do {self.bot.prefix}help aliases for more commands.')
                 embeds.append(em)
@@ -500,7 +500,7 @@ async def _add(self, ctx, name: str.lower, *, value):
 
         em = discord.Embed(
             title='Added alias',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'`{name}` points to: {value}'
         )
 
@@ -515,7 +515,7 @@ async def __del(self, ctx, *, name: str.lower):
 
         em = discord.Embed(
             title='Removed alias',
-            color=discord.Color.green(),
+            color=discord.Color.blurple(),
             description=f'`{name}` no longer exists.'
         )
 

core/thread.py

@@ -99,7 +99,7 @@ async def _close(self, closer, silent=False, delete_channel=True,
             }
         })
 
-        if not isinstance(log_data, str) or log_data is not None:
+        if log_data is not None and isinstance(log_data, dict):
             if self.bot.selfhosted:
                 log_url = f"{self.bot.config.log_url.strip('/')}/logs/{log_data['key']}"
             else:
@@ -160,9 +160,6 @@ async def _edit_thread_message(channel, message_id, message):
             embed = msg.embeds[0]
             if embed and embed.author and embed.author.url:
                 if str(message_id) == str(embed.author.url).split('/')[-1]:
-                    if ' - (Edited)' not in embed.footer.text:
-                        embed.set_footer(
-                            text=embed.footer.text + ' - (Edited)')
                     embed.description = message
                     await msg.edit(embed=embed)
                     break
@@ -236,15 +233,22 @@ async def send(self, message, destination=None, from_mod=False, note=False):
 
         em = discord.Embed(
             description=message.content,
-            timestamp=message.created_at
+            # 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) if not note else 'Note',
-                      icon_url=author.avatar_url if not note else system_avatar_url,
+        if not note:
+            em.set_author(name=author.name,
+                      icon_url=author.avatar_url,
                       url=message.jump_url)
+        else:
+            em.set_author(
+                name=f'Note ({author.name})',
+                icon_url=system_avatar_url,
+                url=message.jump_url
+            )
 
         image_types = ['.png', '.jpg', '.gif', '.jpeg', '.webp']
 
@@ -292,14 +296,11 @@ def is_image_url(u, _):
             file_upload_count += 1
 
         if from_mod:
-            em.color = discord.Color.green()
-            em.set_footer(text=f'Moderator')
+            em.color = self.bot.mod_color
         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')
+            em.color = self.bot.recipient_color
 
         await destination.trigger_typing()