Merge from "master"

Author: Taaku18

README.md

@@ -44,28 +44,15 @@ When a user sends a direct message to the bot, a channel is created within an is
 
 ## Installation
 
-You have two options for using this bot, host on Heroku or self-host the bot. If you choose to install the bot using Heroku, you will not need to download anything. Read the **[installation guide](https://github.com/kyb3r/modmail/wiki/Installation)** or watch the **[video tutorial](https://youtu.be/TH_1QfKUl_k)**. If you ran into any problems, join our [discord server](https://discord.gg/etJNHCQ) for help and support. Even if you don't have any issues, you should come and check out our awesome Discord community! :wink:
+You have two options for using this bot, host on Heroku or self-host the bot. If you choose to install the bot using Heroku, you will not need to download anything. Read the **[installation guide](https://github.com/kyb3r/modmail/wiki/Installation)**. If you ran into any problems, join our [discord server](https://discord.gg/etJNHCQ) for help and support. Even if you don't have any issues, you should come and check out our awesome Discord community! :wink:
 
 ## What is Heroku?
 
-Heroku is a container based cloud platform that currently offers a free plan to host web apps. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Modmail be accessible to anyone while still being feature-rich; it's a community run project that lets anyone get it up and running 24/7 for free. So how does our bot store data? Configs and logs are stored in a [centralized web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast.
-
-## Self-hosted logs
-
-If you want complete control over your data and do not want to use the centralized API service, you can self-host your logs. We recommend this if you want stability and security for your bot. You can do this by adding two config variables: 
-
-* `MONGO_URI` - MongoDB connection URI, you can get a free 500 MB cluster from [MongoDB Atlas](https://www.mongodb.com/cloud/atlas).
-* `LOG_URL` - The URL of your log viewer Heroku app (`https://yourlogviewerappname.herokuapp.com`)
-
-Optionally if you want autoupdates (bot syncs your fork with origin) you can add another config var:
-* `GITHUB_ACCESS_TOKEN` - Personal access token you can get from your GitHub developer settings.
-
-You also need to create a separate Heroku app for the log viewer that you can deploy from [here](https://github.com/kyb3r/logviewer).
+Heroku is a container based cloud platform that currently offers a free plan to host web apps. However, these apps have an ephemeral file system and thus cannot store any data on site. We have made Modmail be accessible to anyone while still being feature-rich; it's a community run project that lets anyone get it up and running 24/7 for free. So how does our bot store data? Configs and logs are stored in a [centralized web service](https://modmail.tk) hosted by us. This enables you to get started easily and fast. However, you do also have the option to self-host your data, check the installation guide for more info.
 
 ## Features and Commands
 The bot comes with a plethora of useful functionality. Take a look at the [list of commands](https://github.com/kyb3r/modmail/wiki/Features-and-commands).
 
-
 ### Automatic Updates
 The bot checks for new updates every hour and automatically updates to a newer version if found. This bot is under active development so you can always look forward to new, useful features! If you do not want this functionality, for example, if you want to make changes to your fork, you can do so by adding a `disable_autoupdates` config variable. 
 

app.json

@@ -12,12 +12,20 @@
         "required": true
     },
     "OWNERS": {
-        "description": "Comma separated user IDs of people that are allowed to use owner only commands. (eval and update)",
+        "description": "Comma separated user IDs of people that are allowed to use owner only commands. (eval and update).",
         "required": true
     },
     "MODMAIL_API_TOKEN": {
-        "description": "API token from https://modmail.tk",
-        "required": true
+        "description": "API token from https://modmail.tk.",
+        "required": false
+    },
+    "MONGO_URI": {
+        "description": "Mongo DB connection URI for self-hosting your data.",
+        "required": false
+    },
+    "LOG_URL": {
+        "description": "The url of the log viewer app for viewing self-hosted logs.",
+        "required": false
     }
   }
 }

bot.py

@@ -35,9 +35,11 @@
 from datetime import datetime
 from types import SimpleNamespace
 
+import uvloop
 from aiohttp import ClientSession
 from motor.motor_asyncio import AsyncIOMotorClient
-from colorama import init, Fore, Style
+import colorama
+from colorama import Fore, Style
 from emoji import UNICODE_EMOJI
 
 from core.clients import Github, ModmailApiClient, SelfHostedClient
@@ -46,7 +48,7 @@
 from core.changelog import ChangeLog
 
 
-init()
+colorama.init()
 
 line = Fore.BLACK + Style.BRIGHT + '-------------------------' + \
        Style.RESET_ALL
@@ -594,5 +596,6 @@ def uptime(self):
 
 
 if __name__ == '__main__':
+    uvloop.install()
     bot = ModmailBot()
     bot.run()

cogs/utility.py

@@ -180,7 +180,7 @@ async def changelog(self, ctx):
     @trigger_typing
     async def about(self, ctx):
         """Shows information about the bot."""
-        em = Embed(color=0x36393F,
+        em = Embed(color=Color.blurple(),
                    timestamp=datetime.utcnow())
         em.set_author(name='Modmail - About',
                       icon_url=self.bot.user.avatar_url)
@@ -295,7 +295,7 @@ async def update(self, ctx):
                 for name, value in latest.fields.items():
                     em.add_field(name=name, value=value)
                 # TODO: message unused?
-                message = commit_data['commit']['message']
+                # message = commit_data['commit']['message']
                 html_url = commit_data["html_url"]
                 short_sha = commit_data['sha'][:6]
                 em.add_field(name='Merge Commit',
@@ -367,7 +367,7 @@ async def ping(self, ctx):
         em = Embed(
             title='Pong! Websocket Latency:',
             description=f'{self.bot.ws.latency * 1000:.4f} ms',
-            color=0x00FF00
+            color=Color.blurple()
         )
         return await ctx.send(embed=em)
 

core/thread.py

@@ -250,15 +250,15 @@ async def send(self, message, destination=None,
 
         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
         if not note:
-            em.set_author(name=author.name,
+            em.set_author(name=author,
                           icon_url=author.avatar_url,
                           url=message.jump_url)
         else:
@@ -322,9 +322,11 @@ def is_image_url(u, _):
 
         if from_mod:
             em.color = self.bot.mod_color
+            em.set_footer(text=f'Moderator')
         elif note:
             em.color = discord.Color.blurple()
         else:
+            em.set_footer(text=f'Recipient')
             em.color = self.bot.recipient_color
 
         await destination.trigger_typing()
@@ -450,11 +452,11 @@ async def create(self, recipient, *, creator=None, category=None):
         em = discord.Embed(
             color=self.bot.mod_color,
             description=thread_creation_response,
-            title='Thread Created',
             timestamp=datetime.utcnow(),
         )
         em.set_footer(text='Your message has been sent',
                       icon_url=self.bot.guild.icon_url)
+        em.set_author(name='Thread Created')
 
         if creator is None:
             self.bot.loop.create_task(recipient.send(embed=em))
@@ -566,14 +568,8 @@ def _format_info_embed(self, user, creator, log_url, log_count, dc):
         member = self.bot.guild.get_member(user.id)
         avi = user.avatar_url
         time = datetime.utcnow()
-        if creator:
-            desc = f'{creator.mention} has created ' \
-                   f'a thread with {user.mention}'
-        else:
-            desc = f'{user.mention} has started a thread'
 
-        key = log_url.split('/')[-1]
-        desc = f'{desc} [`{key}`]({log_url})'
+        # key = log_url.split('/')[-1]
 
         role_names = ''
         if member:
@@ -586,30 +582,42 @@ def _format_info_embed(self, user, creator, log_url, log_count, dc):
                 role_names = ' '.join(r.mention for r in roles
                                       if r.name != "@everyone")
 
-        em = discord.Embed(colour=dc, description=desc, timestamp=time)
+        em = discord.Embed(colour=dc, description=user.mention, timestamp=time)
 
         def days(d):
-            return ' day ago.' if d == '1' else ' days ago.'
+            if d == '0':
+                return '**today**'
+            return f'{d} day ago' if d == '1' else f'{d} days ago'
 
         created = str((time - user.created_at).days)
-        # em.add_field(name='Mention', value=user.mention)
-        em.add_field(name='Registered', value=created + days(created))
+        # if not role_names:
+        #     em.add_field(name='Mention', value=user.mention)
+        # em.add_field(name='Registered', value=created + days(created))
+        em.description += f' was created {days(created)}'
+
         footer = 'User ID: ' + str(user.id)
         em.set_footer(text=footer)
-        em.set_author(name=str(user), icon_url=avi)
-        em.set_thumbnail(url=avi)
+        em.set_author(name=str(user), icon_url=avi, url=log_url)
+        # em.set_thumbnail(url=avi)
 
         if member:
-            if log_count:
-                em.add_field(name='Past logs', value=f'{log_count}')
             joined = str((time - member.joined_at).days)
-            em.add_field(name='Joined', value=joined + days(joined))
+            # em.add_field(name='Joined', value=joined + days(joined))
+            em.description += f', joined {days(joined)}'
+
             if member.nick:
                 em.add_field(name='Nickname', value=member.nick, inline=True)
             if role_names:
-                em.add_field(name='Roles', value=role_names, inline=False)
+                em.add_field(name='Roles', value=role_names, inline=True)
         else:
             em.set_footer(text=f'{footer} | Note: this member'
                                ' is not part of this server.')
 
+        if log_count:
+            # em.add_field(name='Past logs', value=f'{log_count}')
+            t = 'thread' if log_count == 1 else 'threads'
+            em.description += f" with **{log_count}** past {t}."
+        else:
+            em.description += '.'
+
         return em

requirements.txt

@@ -12,4 +12,5 @@ motor==2.0.0
 sanic==18.12.0
 dnspython==1.16.0
 aiohttp==3.4.4
-pymongo==3.7.2
+pymongo==3.7.2
+uvloop==0.12.0