Merge from "master"

Author: Taaku18

.gitignore

@@ -105,9 +105,9 @@ ENV/
 #Pycharm
 .idea/
 
-#MacOs
+#MacOS
 .DS_Store
 
-# custom
+# Modmail
 config.json
 plugins/

bot.py

@@ -25,13 +25,12 @@
 __version__ = '2.12.2'
 
 import asyncio
+import os
 from datetime import datetime
-from os import listdir
 from textwrap import dedent
 from types import SimpleNamespace
 
 import discord
-import uvloop
 from aiohttp import ClientSession
 from colorama import init, Fore, Style
 from discord.enums import ActivityType
@@ -59,7 +58,6 @@ def __init__(self):
         self._threads = None
         self._session = None
         self._config = None
-        self._connected = asyncio.Event()
         self._db = None
 
         if self.self_hosted:
@@ -120,9 +118,9 @@ def _load_extensions(self):
               '┴ ┴└─┘─┴┘┴ ┴┴ ┴┴┴─┘', sep='\n')
         print(f'v{__version__}')
         print('Authors: kyb3r, fourjr, Taaku18' + Style.RESET_ALL)
-        print(LINE + Fore.CYAN)
+        print(LINE)
 
-        for file in listdir('cogs'):
+        for file in os.listdir('cogs'):
             if not file.endswith('.py'):
                 continue
             cog = f'cogs.{file[:-3]}'
@@ -631,13 +629,13 @@ async def autoupdate_loop(self):
         await self.wait_until_ready()
 
         if self.config.get('disable_autoupdates'):
-            print('Autoupdates disabled.')
+            print(Fore.CYAN + 'Autoupdates disabled.' + Style.RESET_ALL)
             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(Fore.CYAN + 'Autoupdates disabled.' + Style.RESET_ALL)
             print(LINE)
             return
 
@@ -678,6 +676,8 @@ async def autoupdate_loop(self):
 
 
 if __name__ == '__main__':
-    uvloop.install()
+    if os.name != 'nt':
+        import uvloop
+        uvloop.install()
     bot = ModmailBot()  # pylint: disable=invalid-name
     bot.run()

cogs/plugins.py

@@ -2,10 +2,11 @@
 import subprocess
 import shutil
 
-from discord.ext import commands
 from colorama import Fore, Style
+from discord.ext import commands
 
 from core.decorators import owner_only
+from core.models import Bot
 
 
 class DownloadError(Exception):
@@ -15,15 +16,16 @@ class DownloadError(Exception):
 class Plugins:
     """Plugins expand Mod Mail functionality by allowing third-party addons.
 
-    These addons could have a range of features from moderation to simply making
-    your life as a moderator easier!
+    These addons could have a range of features from moderation to simply
+    making your life as a moderator easier!
     Learn how to create a plugin yourself here: https://link.com
     """
-    def __init__(self, bot):
+    def __init__(self, bot: Bot):
         self.bot = bot
-        self.bot.loop.create_task(self.download_initital_plugins())
+        self.bot.loop.create_task(self.download_initial_plugins())
 
-    def parse_plugin(self, name):
+    @staticmethod
+    def parse_plugin(name):
         # returns: (username, repo, plugin_name)
         try:
             result = name.split('/')
@@ -32,35 +34,43 @@ def parse_plugin(self, name):
             return None
         return tuple(result)
 
-    async def download_initital_plugins(self):
+    async def download_initial_plugins(self):
         await self.bot._connected.wait()
         for i in self.bot.config.plugins:
             parsed_plugin = self.parse_plugin(i)
 
             try:
                 await self.download_plugin_repo(*parsed_plugin[:-1])
-            except DownloadError as e:
-                print(Fore.RED + f'Unable to download plugin ({parsed_plugin[0]}/{parsed_plugin[1]} - {e}' + Style.RESET_ALL)
+            except DownloadError as exc:
+                msg = 'Unable to download plugin '
+                msg += f'({parsed_plugin[0]}/{parsed_plugin[1]} - {exc}'
+                print(Fore.RED + msg + Style.RESET_ALL)
 
             await self.load_plugin(*parsed_plugin)
 
-    async def download_plugin_repo(self, username, repo):
+    @staticmethod
+    async def download_plugin_repo(username, repo):
         try:
-            subprocess.run(f'git clone https://github.com/{username}/{repo} plugins/{username}-{repo} -q', check=True, capture_output=True)
-            # -q for quiet so there's no terminal output unless there's an error
-        except subprocess.CalledProcessError as e:
-            error = e.stderr.decode('utf8').strip()
-            if not error.endswith('already exists and is not an empty directory.'):
+            cmd = f'git clone https://github.com/{username}/{repo} '
+            cmd += 'plugins/{username}-{repo} -q'
+            subprocess.run(cmd, check=True, capture_output=True)
+            # -q (quiet) so there's no terminal output unless there's an error
+        except subprocess.CalledProcessError as exc:
+            error = exc.stderr.decode('utf-8').strip()
+            if not error.endswith('already exists and is '
+                                  'not an empty directory.'):
                 # don't raise error if the plugin folder exists
-                raise DownloadError(error) from e
+                raise DownloadError(error) from exc
 
     async def load_plugin(self, username, repo, plugin_name):
         try:
-            self.bot.load_extension(f'plugins.{username}-{repo}.{plugin_name}.{plugin_name}')
-        except ModuleNotFoundError as e:
-            raise DownloadError('Invalid plugin structure') from e
+            ext = f'plugins.{username}-{repo}.{plugin_name}.{plugin_name}'
+            self.bot.load_extension(ext)
+        except ModuleNotFoundError as exc:
+            raise DownloadError('Invalid plugin structure') from exc
         else:
-            print(Fore.LIGHTCYAN_EX + f'Loading plugins.{username}-{repo}.{plugin_name}' + Style.RESET_ALL)
+            msg = f'Loading plugins.{username}-{repo}.{plugin_name}'
+            print(Fore.LIGHTCYAN_EX + msg + Style.RESET_ALL)
 
     @commands.group(aliases=['plugins'])
     @owner_only()
@@ -80,44 +90,54 @@ async def add(self, ctx, *, plugin_name):
 
                 try:
                     await self.download_plugin_repo(*parsed_plugin[:-1])
-                except DownloadError as e:
-                    return await ctx.send(f'Unable to fetch plugin from Github: {e}')
+                except DownloadError as exc:
+                    return await ctx.send(
+                        f'Unable to fetch plugin from Github: {exc}'
+                    )
 
                 try:
                     await self.load_plugin(*parsed_plugin)
-                except DownloadError as e:
-                    return await ctx.send(f'Unable to start plugin: {e}')
+                except DownloadError as exc:
+                    return await ctx.send(f'Unable to start plugin: {exc}')
 
                 # if it makes it here, it has passed all checks and should
                 # be entered into the config
 
                 self.bot.config.plugins.append(plugin_name)
                 await self.bot.config.update()
-                await ctx.send('Plugin installed. Any plugin that you install is of your OWN RISK.')
+
+                await ctx.send('Plugin installed. Any plugin that '
+                               'you install is of your OWN RISK.')
             else:
-                await ctx.send('Invalid plugin name format. Use username/repo/plugin.')
+                await ctx.send('Invalid plugin name format. '
+                               'Use username/repo/plugin.')
 
     @plugin.command()
     async def remove(self, ctx, *, plugin_name):
         """Removes a certain plugin"""
         if plugin_name in self.bot.config.plugins:
             username, repo, name = self.parse_plugin(plugin_name)
-            self.bot.unload_extension(f'plugins.{username}-{repo}.{name}.{name}')
+            self.bot.unload_extension(
+                f'plugins.{username}-{repo}.{name}.{name}'
+            )
 
             self.bot.config.plugins.remove(plugin_name)
 
             try:
-                if not any(i.startswith(f'{username}/{repo}') for i in self.bot.config.plugins):
+                if not any(i.startswith(f'{username}/{repo}')
+                           for i in self.bot.config.plugins):
                     # if there are no more of such repos, delete the folder
-                    shutil.rmtree(f'plugins/{username}-{repo}', ignore_errors=True)
+                    shutil.rmtree(f'plugins/{username}-{repo}',
+                                  ignore_errors=True)
                     await ctx.send('')
-            except Exception as e:
-                print(e)
+            except Exception as exc:
+                print(exc)
                 self.bot.config.plugins.append(plugin_name)
-                raise e
+                raise exc
 
             await self.bot.config.update()
-            await ctx.send('Plugin uninstalled and all related data is erased.')
+            await ctx.send('Plugin uninstalled and '
+                           'all related data is erased.')
         else:
             await ctx.send('Plugin not installed.')
 
@@ -126,9 +146,11 @@ async def update(self, ctx, *, plugin_name):
         async with ctx.typing():
             username, repo, name = self.parse_plugin(plugin_name)
             try:
-                cmd = subprocess.run(f'cd plugins/{username}-{repo} && git pull', shell=True, check=True, capture_output=True)
-            except subprocess.CalledProcessError as e:
-                error = e.stdout.decode('utf8').strip()
+                cmd = f'cd plugins/{username}-{repo} && git pull'
+                cmd = subprocess.run(cmd, shell=True, check=True,
+                                     capture_output=True)
+            except subprocess.CalledProcessError as exc:
+                error = exc.stdout.decode('utf8').strip()
                 await ctx.send(f'Error when updating: {error}')
             else:
                 output = cmd.stdout.decode('utf8').strip()

core/config.py

@@ -26,7 +26,8 @@ class ConfigManager(ConfigManagerABC):
     internal_keys = {
         'snippets', 'aliases', 'blocked',
         'notification_squad', 'subscriptions',
-        'closures', 'activity_message', 'activity_type'
+        'closures', 'activity_message', 'activity_type',
+        'plugins'
     }
 
     protected_keys = {

core/models.py

@@ -14,6 +14,7 @@ class Bot(abc.ABC, commands.Bot):
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
         self.start_time = datetime.utcnow()
+        self._connected = asyncio.Event()
 
     @property
     def uptime(self) -> str: