Merge from "master"

Taaku18 · Taaku18 · commit 6ba1711d2480 · 2019-01-24T16:17:34.000-08:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,11 +5,24 @@ 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.10.0
+
+### Added
+- `anonreply` command to anonymously reply to the recipient. 
+The username of the anonymous user defaults to the `mod_tag` (the footer text of a mod reply). The avatar defaults the guild icon url. However you can change both of these via the `anon_username`, `anon_avatar_url` and `anon_tag` config variables. 
+
+### Changed
+- Your bot now logs all messages sent in a thread channel, including discussions that take place. You can now toggle to view them in the log viewer app.
+
 # v2.9.4
-Fixed a small bug due to a typo.
+
+### Fixed
+- Small bug due to a typo.
 
 # v2.9.3
-Forgot to enable custom embed colors.
+
+### Changed
+- Forgot to enable custom embed colors.
 
 ### Added
 - Ability to set a custom `mod_tag` (the text in the footer of the mod reply embed, which by default says "Moderator")
diff --git a/bot.py b/bot.py
@@ -22,15 +22,15 @@
 SOFTWARE.
 """
 
-__version__ = '2.9.4'
+__version__ = '2.10.0'
 
 import discord
 from discord.enums import ActivityType
 from discord.ext import commands
 from discord.ext.commands.view import StringView
 
 from os import listdir
-from asyncio import sleep
+from asyncio import sleep, Event
 from textwrap import dedent
 from datetime import datetime
 from types import SimpleNamespace
@@ -63,7 +63,8 @@ def __init__(self):
         self.threads = ThreadManager(self)
         self.session = ClientSession(loop=self.loop)
         self.config = ConfigManager(self)
-        self.self_hosted = self.config.get('mongo_uri') is not None
+        self.self_hosted = bool(self.config.get('mongo_uri', ''))
+        self._connected = Event()
 
         if self.self_hosted:
             self.db = AsyncIOMotorClient(self.config.mongo_uri).modmail_bot
@@ -213,6 +214,7 @@ async def on_connect(self):
             print(line)
         else:
             print('Mode: Self-hosting logs.')
+            await self.validate_database_connection()
             print(line)
         print(Fore.CYAN + 'Connected to gateway.')
         
@@ -232,18 +234,19 @@ async def on_connect(self):
             activity = discord.Activity(type=activity_type, name=message,
                                         url=url)
             await self.change_presence(activity=activity)
+        self._connected.set()
 
     async def on_ready(self):
         """Bot startup, sets uptime."""
+        await self._connected.wait()
         print(dedent(f"""
-        {line}
-        {Fore.CYAN}Client ready.
-        {line}
-        {Fore.CYAN}Logged in as: {self.user}
-        {Fore.CYAN}User ID: {self.user.id}
-        {Fore.CYAN}Guild ID: {self.guild.id if self.guild else 0}
-        {line}
-        """).strip())
+            {line}
+            {Fore.CYAN}Client ready.
+            {line}
+            {Fore.CYAN}Logged in as: {self.user}
+            {Fore.CYAN}User ID: {self.user.id}
+            {Fore.CYAN}Guild ID: {self.guild.id if self.guild else 0}
+            {line}""").strip())
 
         if not self.guild:
             print(f'{Fore.RED}{Style.BRIGHT}WARNING - The GUILD_ID '
@@ -388,7 +391,13 @@ async def on_message(self, message):
             if cmd in self.snippets:
                 message.content = f'{prefix}reply {self.snippets[cmd]}'
 
-        await self.process_commands(message)
+        ctx = await self.get_context(message)
+        if ctx.command:
+            return await self.invoke(ctx)
+
+        thread = await self.threads.find(channel=ctx.channel)
+        if thread is not None:
+            await self.modmail_api.append_log(message, type_='internal')
     
     async def on_guild_channel_delete(self, channel):
         if channel.guild != self.modmail_guild:
@@ -461,11 +470,9 @@ def overwrites(self, ctx):  # TODO: can this be static?
                 overwrites[role] = discord.PermissionOverwrite(
                     read_messages=True
                 )
-
         return overwrites
 
     async def validate_api_token(self):
-        valid = True
         try:
             self.config.modmail_api_token
         except KeyError:
@@ -477,21 +484,31 @@ async def validate_api_token(self):
                   'input a MONGO_URI config variable.')
             print('A modmail api token is not needed '
                   'if you are self-hosting logs.')
-            valid = False
+            return await self.logout()
         else:
             valid = await self.modmail_api.validate_token()
             if not valid:
-                print(Fore.RED + Style.BRIGHT, end='')
+                print(Fore.RED, end='')
                 print('Invalid MODMAIL_API_TOKEN - get one '
                       'from https://dashboard.modmail.tk')
-        finally:
-            if not valid:
-                await self.logout()
-            else:
-                user = await self.modmail_api.get_user_info()
-                username = user['user']['username']
-                print(Style.RESET_ALL + Fore.CYAN + 'Validated token.')
-                print('GitHub user: ' + username + Style.RESET_ALL)
+                return await self.logout()
+
+        user = await self.modmail_api.get_user_info()
+        username = user['user']['username']
+        print(Style.RESET_ALL + Fore.CYAN + 'Validated token.')
+        print('GitHub user: ' + username + Style.RESET_ALL)
+
+    async def validate_database_connection(self):
+        try:
+            await self.db.command('buildinfo')
+        except Exception as e:
+            print(Fore.RED, end='')
+            print('Something went wrong while connecting to the database.')
+            print(type(e).__name__, e, sep=': ')
+            return await self.logout()
+        else:
+            print(Style.RESET_ALL + Fore.CYAN +
+                  'Successfully connected to the database.')
 
     async def data_loop(self):
         await self.wait_until_ready()
@@ -524,11 +541,13 @@ async def autoupdate_loop(self):
 
         if self.config.get('disable_autoupdates'):
             print('Autoupdates disabled.')
+            print(line)
             return 
 
         if self.self_hosted and not self.config.get('github_access_token'):
             print('Github access token not found.')
             print('Autoupdates disabled.')
+            print(line)
             return 
 
         while True:
diff --git a/cogs/modmail.py b/cogs/modmail.py
@@ -412,7 +412,6 @@ async def logs(self, ctx, *, member: User = None):
         await session.run()
         
     @commands.command()
-    @trigger_typing
     async def reply(self, ctx, *, msg=''):
         """Reply to users using this command.
 
@@ -422,15 +421,24 @@ async def reply(self, ctx, *, msg=''):
         ctx.message.content = msg
         thread = await self.bot.threads.find(channel=ctx.channel)
         if thread:
+            await ctx.trigger_typing()
             await thread.reply(ctx.message)
     
     @commands.command()
-    @trigger_typing
+    async def anonreply(self, ctx, *, msg=''):
+        ctx.message.content = msg
+        thread = await self.bot.threads.find(channel=ctx.channel)
+        if thread:
+            await ctx.trigger_typing()
+            await thread.reply(ctx.message, anonymous=True)
+    
+    @commands.command()
     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 ctx.trigger_typing()
             await thread.note(ctx.message)
 
     @commands.command()
diff --git a/core/clients.py b/core/clients.py
@@ -195,8 +195,15 @@ def append_log(self, message: Message, channel_id: Union[str, int] = '',
                 },
                 # message properties
                 'content': message.content,
-                'attachments': [i.url for i in message.attachments],
-                'type': type_
+                '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 self.request(self.LOGS + f'/{channel_id}',
@@ -287,18 +294,23 @@ async def append_log(self, message: Message,
         payload = {
                 'timestamp': str(message.created_at),
                 'message_id': str(message.id),
-                # author
                 '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),
                 },
-                # message properties
                 'content': message.content,
-                'attachments': [i.url for i in message.attachments],
-                'type': type_
+                '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(
diff --git a/core/config.py b/core/config.py
@@ -10,11 +10,18 @@ class ConfigManager:
     """Class that manages a cached configuration"""
 
     allowed_to_change_in_command = {
-        'activity_message', 'activity_type', 'log_channel_id',
-        'mention', 'disable_autoupdates', 'prefix',
-        'main_category_id', 'sent_emoji', 'blocked_emoji',
-        'thread_creation_response', 'twitch_url', 'mod_color', 
-        'recipient_color', 'mod_tag'
+        # activity
+        'activity_message', 'activity_type', 'twitch_url',
+        # bot settings
+        'main_category_id', 'disable_autoupdates', 'prefix', 'mention',
+        # logging
+        'log_channel_id',
+        # threads
+        'sent_emoji', 'blocked_emoji', 'thread_creation_response',
+        # moderation
+        'recipient_color', 'mod_tag', 'mod_color',
+        # anonymous message
+        'anon_username', 'anon_avatar_url', 'anon_tag'
         }
     
     internal_keys = {
diff --git a/core/thread.py b/core/thread.py
@@ -196,7 +196,7 @@ async def note(self, message):
             self.send(message, self.channel, note=True)
         )
 
-    async def reply(self, message):
+    async def reply(self, message, anonymous=False):
         if not message.content and not message.attachments:
             raise UserInputError
         if all(not g.get_member(self.id) for g in self.bot.guilds):
@@ -210,12 +210,22 @@ async def reply(self, message):
 
         tasks = [
             # in thread channel
-            self.send(message, self.channel, from_mod=True),
+            self.send(message,
+                      destination=self.channel,
+                      from_mod=True,
+                      anonymous=anonymous),
             # to user
-            self.send(message, self.recipient, from_mod=True),
+            self.send(message,
+                      destination=self.recipient,
+                      from_mod=True,
+                      anonymous=anonymous)
             ]
 
-        await self.bot.modmail_api.append_log(message, self.channel.id)
+        await self.bot.modmail_api.append_log(
+            message,
+            self.channel.id,
+            type_='anonymous' if anonymous else 'thread_message'
+        )
 
         if self.close_task is not None:
             # cancel closing if a thread message is sent.
@@ -232,7 +242,7 @@ async def reply(self, message):
         await asyncio.gather(*tasks)
 
     async def send(self, message, destination=None,
-                   from_mod=False, note=False):
+                   from_mod=False, note=False, anonymous=False):
         if self.close_task is not None:
             # cancel closing if a thread message is sent.
             await self.cancel_closure()
@@ -260,17 +270,31 @@ async def send(self, message, destination=None,
         system_avatar_url = 'https://discordapp.com/assets/' \
                             'f78426a064bc9dd24847519259bc42af.png'
 
-        # store message id in hidden url
         if not note:
-            embed.set_author(name=author,
-                             icon_url=author.avatar_url,
+            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
+                )
+            else:
+                # Normal message
+                name = str(author)
+                avatar_url = author.avatar_url
+
+            embed.set_author(name=name,
+                             icon_url=avatar_url,
                              url=message.jump_url)
         else:
-            embed.set_author(
-                name=f'Note ({author.name})',
-                icon_url=system_avatar_url,
-                url=message.jump_url
-            )
+            # Special note messages
+            embed.set_author(name=f'Note ({author.name})',
+                             icon_url=system_avatar_url,
+                             url=message.jump_url)
 
         delete_message = not bool(message.attachments)
 
@@ -318,7 +342,19 @@ async def send(self, message, destination=None,
 
         if from_mod:
             embed.color = self.bot.mod_color
-            embed.set_footer(text=self.bot.config.get('mod_tag', 'Moderator'))
+            # Anonymous reply sent in thread channel
+            if anonymous and isinstance(destination, discord.TextChannel):
+                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
+            else:
+                embed.set_footer(
+                    text=self.bot.config.get('anon_tag', 'Response')
+                )
         elif note:
             embed.color = discord.Color.blurple()
         else:
