Plugin

Author: fourjr

bot.py

@@ -25,7 +25,6 @@
 __version__ = '2.11.0'
 
 import asyncio
-import uvloop
 import textwrap
 import datetime
 import os
@@ -46,6 +45,8 @@
 from core.config import ConfigManager
 from core.changelog import ChangeLog
 
+if os.name != 'nt':
+    import uvloop
 
 init()
 
@@ -80,13 +81,13 @@ def _add_commands(self):
               '┴ ┴└─┘─┴┘┴ ┴┴ ┴┴┴─┘', sep='\n')
         print(f'v{__version__}')
         print('Authors: kyb3r, fourjr' + Style.RESET_ALL)
-        print(line + Fore.CYAN)
+        print(line)
 
         for file in os.listdir('cogs'):
             if not file.endswith('.py'):
                 continue
             cog = f'cogs.{file[:-3]}'
-            print(f'Loading {cog}')
+            print(Fore.CYAN + f'Loading {cog}' + Style.RESET_ALL)
             self.load_extension(cog)
 
     async def logout(self):
@@ -100,7 +101,7 @@ def run(self):
             super().run(self.token)
         finally:
             print(Fore.RED + ' - Shutting down bot' + Style.RESET_ALL)
-        
+
     @property
     def log_channel(self):
         channel_id = self.config.get('log_channel_id')
@@ -203,7 +204,7 @@ async def on_connect(self):
             print('Mode: Selfhosting logs.')
             print(line)
         print(Fore.CYAN + 'Connected to gateway.')
-        
+
         await self.config.refresh()
 
         activity_type = self.config.get('activity_type')
@@ -214,7 +215,7 @@ 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):
@@ -507,15 +508,15 @@ 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 
+            return
 
         if self.selfhosted 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 
+            return
 
         while True:
             metadata = await self.modmail_api.get_metadata()
@@ -577,6 +578,7 @@ def uptime(self):
 
 
 if __name__ == '__main__':
-    uvloop.install()
+    if os.name != 'nt':
+        uvloop.install()
     bot = ModmailBot()
     bot.run()

cogs/modmail.py

@@ -293,7 +293,6 @@ async def unsubscribe(self, ctx, *, role=None):
         em.description = f'{mention} is now unsubscribed to this thread.'
         await ctx.send(embed=em)
 
-
     @commands.command()
     async def nsfw(self, ctx):
         """Flags a Modmail thread as nsfw."""
@@ -302,16 +301,19 @@ async def nsfw(self, ctx):
             return
         await ctx.channel.edit(nsfw=True)
         await ctx.message.add_reaction('✅')
-    
+
     @commands.command()
     async def loglink(self, ctx):
+        """Returns the log lnk of the current thread"""
         thread = await self.bot.threads.find(channel=ctx.channel)
         if thread:
             log_link = await self.bot.modmail_api.get_log_link(ctx.channel.id)
-            await ctx.send(embed=discord.Embed(
+            await ctx.send(
+                embed=discord.Embed(
                     color=discord.Color.blurple(), 
-                    description=log_link)
-                    )
+                    description=log_link
+                )
+            )
 
     @commands.command(aliases=['threads'])
     @commands.has_permissions(manage_messages=True)
@@ -388,19 +390,20 @@ async def reply(self, ctx, *, msg=''):
         if thread:
             await ctx.trigger_typing()
             await thread.reply(ctx.message)
-    
+
     @commands.command()
     async def anonreply(self, ctx, *, msg=''):
+        """Anonymously reply to threads"""
         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 
+        ctx.message.content = msg
         thread = await self.bot.threads.find(channel=ctx.channel)
 
         if thread:

cogs/plugins.py

@@ -0,0 +1,152 @@
+import importlib
+import subprocess
+import shutil
+
+from discord.ext import commands
+from colorama import Fore, Style
+
+from core.decorators import owner_only
+
+
+class DownloadError(Exception):
+    pass
+
+
+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!
+    Learn how to create a plugin yourself here: https://link.com
+    """
+    def __init__(self, bot):
+        self.bot = bot
+        self.bot.loop.create_task(self.download_initital_plugins())
+
+    def parse_plugin(self, name):
+        # returns: (username, repo, plugin_name)
+        try:
+            result = name.split('/')
+            result[2] = '/'.join(result[2:])
+        except IndexError:
+            return None
+        return tuple(result)
+
+    async def download_initital_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)
+
+            await self.load_plugin(*parsed_plugin)
+
+    async def download_plugin_repo(self, 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.'):
+                # don't raise error if the plugin folder exists
+                raise DownloadError(error) from e
+
+    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
+        else:
+            print(Fore.LIGHTCYAN_EX + f'Loading plugins.{username}-{repo}.{plugin_name}' + Style.RESET_ALL)
+
+    @commands.group(aliases=['plugins'])
+    @owner_only()
+    async def plugin(self, ctx):
+        """Plugin handler. Controls the plugins in the bot."""
+        if ctx.invoked_subcommand is None:
+            cmd = self.bot.get_command('help')
+            await ctx.invoke(cmd, command='plugin')
+
+    @plugin.command()
+    async def add(self, ctx, *, plugin_name):
+        """Adds a plugin"""
+        # parsing plugin_name
+        async with ctx.typing():
+            if len(plugin_name.split('/')) >= 3:
+                parsed_plugin = self.parse_plugin(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}')
+
+                try:
+                    await self.load_plugin(*parsed_plugin)
+                except DownloadError as e:
+                    return await ctx.send(f'Unable to start plugin: {e}')
+
+                # 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.')
+            else:
+                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.config.plugins.remove(plugin_name)
+
+            try:
+                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)
+                    await ctx.send('')
+            except Exception as e:
+                print(e)
+                self.bot.config.plugins.append(plugin_name)
+                raise e
+
+            await self.bot.config.update()
+            await ctx.send('Plugin uninstalled and all related data is erased.')
+        else:
+            await ctx.send('Plugin not installed.')
+
+    @plugin.command()
+    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()
+                await ctx.send(f'Error when updating: {error}')
+            else:
+                output = cmd.stdout.decode('utf8').strip()
+
+                if output != 'Already up to date.':
+                    # repo was updated locally, now perform the cog reload
+                    ext = f'plugins.{username}-{repo}.{name}.{name}'
+                    importlib.reload(importlib.import_module(ext))
+                    self.bot.unload_extension(ext)
+                    self.bot.load_extension(ext)
+
+                await ctx.send(f'```\n{output}\n```')
+
+    @plugin.command(name='list')
+    async def list_(self, ctx):
+        """Shows a list of currently enabled plugins"""
+        await ctx.send('```\n' + '\n'.join(self.bot.config.plugins) + '\n```')
+
+
+def setup(bot):
+    bot.add_cog(Plugins(bot))

cogs/utility.py

@@ -42,14 +42,14 @@ def format_cog_help(self, ctx, cog):
             if cmd.instance is cog:
                 if cmd.hidden:
                     continue
-                if len(fmt[index] + f'`{prefix+cmd.qualified_name:<{maxlen}}` - ' + f'{cmd.short_doc:<{maxlen}}\n') > 1024:
+                if len(fmt[index] + f'`{prefix+cmd.qualified_name:<{maxlen}}` - ' + f'{cmd.short_doc or "No description":<{maxlen}}\n') > 1024:
                     index += 1
                     fmt.append('')
                 fmt[index] += f'`{prefix+cmd.qualified_name:<{maxlen}}` - '
-                fmt[index] += f'{cmd.short_doc:<{maxlen}}\n'
+                fmt[index] += f'{cmd.short_doc or "No description":<{maxlen}}\n'
 
         em = discord.Embed(
-            description='*' + inspect.getdoc(cog) + '*',
+            description=f"*{inspect.getdoc(cog) or 'No description'}*",
             color=discord.Colour.blurple()
         )
         em.set_author(name=cog.__class__.__name__ + ' - Help', icon_url=ctx.bot.user.avatar_url)
@@ -88,7 +88,7 @@ def format_command_help(self, ctx, cmd):
             else:
                 branch = '├─ ' + c.name
             fmt += f"`{branch:<{maxlen+1}}` - "
-            fmt += f"{c.short_doc:<{maxlen}}\n"
+            fmt += f"{c.short_doc or 'No description':<{maxlen}}\n"
 
         em.add_field(name='Subcommands', value=fmt)
         em.set_footer(text=f'Type "{prefix}help {cmd} command" for more info on a command.')

core/config.py

@@ -3,6 +3,7 @@
 import json
 import box
 
+
 class ConfigManager:
     """Class that manages a cached configuration"""
 
@@ -12,18 +13,21 @@ class ConfigManager:
         'thread_creation_response', 'twitch_url', 'mod_color', 
         'recipient_color', 'mod_tag', 'anon_username', 'anon_avatar_url',
         'anon_tag'
-        }
-    
+    }
+
     internal_keys = {
         'snippets', 'aliases', 'blocked',
         'notification_squad', 'subscriptions',
-        'closures', 'activity_message', 'activity_type'
-        }
-    
+        'closures', 'activity_message', 'activity_type',
+        'plugins'
+    }
+
     protected_keys = {
         'token', 'owners', 'modmail_api_token', 'guild_id', 'modmail_guild_id', 
         'mongo_uri', 'github_access_token', 'log_url'
-        }
+    }
+
+    # plugins is internal as its a list and i dont want weird issues
 
     valid_keys = allowed_to_change_in_command | internal_keys | protected_keys
 
@@ -43,6 +47,7 @@ def api(self):
     def populate_cache(self):
         data = {
             'snippets': {},
+            'plugins': [],
             'aliases': {},
             'blocked': {},
             'notification_squad': {},
@@ -59,7 +64,7 @@ def populate_cache(self):
             self.cache = {
                 k.lower(): v for k, v in data.items()
                 if k.lower() in self.valid_keys
-                }
+            }
 
     async def update(self, data=None):
         """Updates the config with data from the cache"""
@@ -72,7 +77,7 @@ async def refresh(self):
         data = await self.api.get_config()
         self.cache.update(data)
         self.ready_event.set()
-    
+
     async def wait_until_ready(self):
         await self.ready_event.wait()
 

plugins/fourjr-modmail-plugins

@@ -0,0 +1 @@
+Subproject commit ef4b6240e323ad97c6ffbc4d62fc145adfddbcf6