Dynamic help and config resolves #84

Author: kyb3r

bot.py

@@ -51,20 +51,23 @@
 
 from core.paginator import PaginatorSession
 from core.api import Github, ModmailApiClient
-from core.thread import ThreadManager, Thread
+from core.thread import ThreadManager
+from core.config import ConfigManager
 
 line = Fore.BLACK + Style.BRIGHT + '-------------------------' + Style.RESET_ALL
 
 class ModmailBot(commands.Bot):
 
-    '''Commands directly related to Modmail functionality.'''
+    mutable_config_keys = ['prefix', 'status', 'guild_id', 'mention']
 
     def __init__(self):
         super().__init__(command_prefix=self.get_pre)
         self.start_time = datetime.datetime.utcnow()
         self.threads = ThreadManager(self) 
+        self.session = aiohttp.ClientSession(loop=self.loop)
+        self.config = ConfigManager(self)
+        self.modmail_api = ModmailApiClient(self)
         self.data_task = self.loop.create_task(self.data_loop())
-        
         self._add_commands()
 
     def _add_commands(self):
@@ -79,10 +82,6 @@ def _add_commands(self):
         print('Author: kyb3r' + Style.RESET_ALL)
         print(line + Fore.CYAN)
 
-        for attr in dir(self):
-            cmd = getattr(self, attr)
-            if isinstance(cmd, commands.Command):
-                self.add_command(cmd)
 
         for file in os.listdir('cogs'):
             if not file.endswith('.py'):
@@ -101,32 +100,18 @@ def run(self):
             super().run(self.token)
         finally:
             print(Fore.CYAN + ' Shutting down bot' + Style.RESET_ALL)
-
-    @property
-    def config(self):
-        try:
-            with open('config.json') as f:
-                config = json.load(f)
-        except FileNotFoundError:
-            config = {}
-        config.update(os.environ)
-        return config
 
     @property
     def snippets(self):
-        return {
-            key.split('_')[1].lower(): val
-            for key, val in self.config.items() 
-            if key.startswith('SNIPPET_')
-            }
+        return self.config.get('snippets', {})
 
     @property
     def token(self):
-        return self.config.get('TOKEN')
+        return self.config.token
 
     @property
     def guild_id(self):
-        return int(self.config.get('GUILD_ID'))
+        return int(self.config.guild_id)
 
     @property
     def guild(self):
@@ -146,16 +131,14 @@ def blocked_users(self):
     @staticmethod
     async def get_pre(bot, message):
         '''Returns the prefix.'''
-        p = bot.config.get('PREFIX') or 'm.'
+        p = bot.config.get('prefix') or 'm.'
         return [p, f'<@{bot.user.id}> ', f'<@!{bot.user.id}> ']
 
     async def on_connect(self):
         print(line)
         print(Fore.CYAN + 'Connected to gateway.')
-        
-        self.session = aiohttp.ClientSession()
-        self.modmail_api = ModmailApiClient(self) 
-        status = os.getenv('STATUS') or self.config.get('STATUS')
+
+        status = self.config.get('status')
         if status:
             await self.change_presence(activity=discord.Game(status))
 
@@ -201,7 +184,7 @@ async def on_message(self, message):
         if isinstance(message.channel, discord.DMChannel):
             return await self.process_modmail(message)
 
-        prefix = self.config.get('PREFIX', 'm.')
+        prefix = self.config.get('prefix', 'm.')
 
         if message.content.startswith(prefix):
             cmd = message.content[len(prefix):].strip()

cogs/utility.py

@@ -2,6 +2,7 @@
 from discord.ext import commands
 import traceback
 import inspect
+import json
 import io
 import textwrap
 from contextlib import redirect_stdout
@@ -10,6 +11,8 @@
 from core.paginator import PaginatorSession
 from core.decorators import auth_required, owner_only, trigger_typing
 
+from prettytable import PrettyTable
+
 class Utility:
     '''General commands that provide utility'''
 
@@ -19,7 +22,7 @@ def __init__(self, bot):
     def format_cog_help(self, ctx, cog):
         """Formats the text for a cog help"""
         sigs = []
-        prefix = self.bot.config.get('PREFIX', 'm.')
+        prefix = self.bot.config.get('prefix', 'm.')
 
         for cmd in self.bot.commands:
             if cmd.hidden:
@@ -72,7 +75,7 @@ def format_cog_help(self, ctx, cog):
 
     def format_command_help(self, ctx, cmd):
         '''Formats command help.'''
-        prefix = self.bot.config.get('PREFIX', 'm.')
+        prefix = self.bot.config.get('prefix', 'm.')
         em = discord.Embed(
             color=discord.Color.green(),
             description=cmd.help
@@ -138,7 +141,7 @@ async def help(self, ctx, *, command: str=None):
 
         pages = []
 
-        prefix = self.bot.config.get('PREFIX', 'm.')
+        prefix = self.bot.config.get('prefix', 'm.')
 
         for _, cog in sorted(self.bot.cogs.items()):
             em = self.format_cog_help(ctx, cog)
@@ -205,7 +208,7 @@ async def github(self, ctx):
         data = await self.bot.modmail_api.get_user_info()
         print(data)
 
-        prefix = self.bot.config.get('PREFIX', 'm.')
+        prefix = self.bot.config.get('prefix', 'm.')
 
         em = discord.Embed(title='Github')
 
@@ -282,6 +285,87 @@ async def ping(self, ctx):
         em.color = 0x00FF00
         await ctx.send(embed=em)
 
+    @commands.group()
+    @owner_only()
+    async def config(self, ctx):
+        '''Change configuration for the bot.'''
+        if ctx.invoked_subcommand is None:
+            cmd = self.bot.get_command('help')
+            await ctx.invoke(cmd, command='config')
+     
+    @config.command(name='set')
+    async def _set(self, ctx, key: str.lower, *, value):
+        '''Sets a configuration variable and its value'''
+
+        em = discord.Embed(
+            title='Success',
+            color=discord.Color.green(),
+            description=f'Set `{key}` to `{value}`'
+        )
+
+        if key not in self.bot.mutable_config_keys:
+            em.title='Error'
+            em.color=discord.Color.green()
+            em.description=f'{key} is an invalid key.'
+            valid_keys = [f'`{k}`' for k in self.bot.mutable_config_keys]
+            em.add_field(name='Valid keys', value=', '.join(valid_keys))
+        else:
+            await self.bot.config.update({key: value})
+
+        await ctx.send(embed=em)
+
+    @config.command(name='del')
+    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(),
+            description=f'Set `{key}` to nothing.'
+        )
+
+        if key not in self.bot.mutable_config_keys:
+            em.title='Error'
+            em.color=discord.Color.green()
+            em.description=f'{key} is an invalid key.'
+            valid_keys = [f'`{k}`' for k in self.bot.mutable_config_keys]
+            em.add_field(name='Valid keys', value=', '.join(valid_keys))
+        else:
+            self.bot.config.cache[key] = None
+            await self.bot.config.update()
+
+        await ctx.send(embed=em)
+    
+    @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.set_author(name='Current config', icon_url=self.bot.user.avatar_url)
+
+        if key and key not in self.bot.mutable_config_keys:
+            em.title='Error'
+            em.color=discord.Color.green()
+            em.description=f'`{key}` is an invalid key.'
+            valid_keys = [f'`{k}`' for k in self.bot.mutable_config_keys]
+            em.add_field(name='Valid keys', value=', '.join(valid_keys))
+        elif key:
+            em.set_author(name='Config variable', icon_url=self.bot.user.avatar_url)
+            em.description = f'`{key}` is set to `{self.bot.config.get(key)}`'
+        else:
+            em.description = 'Here is a list of currently set configuration variables.'
+
+            config = { 
+                k: v for k, v in self.bot.config.cache.items() 
+                if v and k in self.bot.mutable_config_keys
+                }
+
+            for k, v in reversed(list(config.items())):
+                em.add_field(name=k, value=f'`{v}`')
+
+        await ctx.send(embed=em)
+        
+        
+
+
     @commands.command(hidden=True, name='eval')
     @owner_only()
     async def _eval(self, ctx, *, body):

core/api.py

@@ -30,10 +30,11 @@ class ModmailApiClient(ApiClient):
     base = 'https://api.modmail.tk'
     github = base + '/github'
     logs = base + '/logs'
+    config = base + '/config'
 
     def __init__(self, bot):
         super().__init__(bot)
-        self.token = bot.config.get('MODMAIL_API_TOKEN')
+        self.token = bot.config.get('modmail_api_token')
         if self.token:
             self.headers = {
                 'Authorization': 'Bearer ' + self.token
@@ -53,6 +54,15 @@ def get_user_logs(self, user_id):
 
     def get_log(self, channel_id):
         return self.request(self.logs + '/' + str(channel_id))
+    
+    def get_config(self):
+        return self.request(self.config)
+    
+    def update_config(self, data):
+        valid_keys = ['prefix', 'status', 'owners', 'guild_id', 'mention', 'snippets']
+        
+        data = {k: v for k, v in data.items() if k in valid_keys}
+        return self.request(self.config, method='PATCH', payload=data)
 
     def get_log_url(self, recipient, channel, creator):
         return self.request(self.logs + '/key', payload={

core/config.py

@@ -0,0 +1,57 @@
+import asyncio
+import os
+import json 
+import box
+
+class ConfigManager:
+
+    def __init__(self, bot):
+        self.bot = bot 
+        self.cache = box.Box()
+        self._modified = True
+        self.populate_cache()
+
+    @property
+    def api(self):
+        return self.bot.modmail_api
+    
+    def populate_cache(self):
+        try:
+            data = json.load(open('config.json'))
+        except FileNotFoundError:
+            data = {}
+        finally:
+            data.update(os.environ)
+            data = {k.lower(): v for k, v in data.items()}
+            self.cache = data
+
+        self.bot.loop.create_task(self.refresh())
+    
+    async def update(self, data=None):
+        '''Updates the config with data from the cache'''
+        self._modified = False
+        if data is not None:
+            self.cache.update(data)
+        await self.api.update_config(self.cache)
+
+    async def refresh(self):
+        '''Refreshes internal cache with data from database'''
+        data = await self.api.get_config()
+        self.cache.update(data)
+    
+    def __getattr__(self, value):
+        return self.cache[value]
+
+    def get(self, value, default=None):
+        return self.cache.get(value) or default
+    
+    @property
+    def modified(self):
+        return self._modified
+    
+    @modified.setter
+    def modified(self, flag):
+        '''If set to true, update() will be called'''
+        if flag is True:
+            asyncio.create_task(self.update())
+            self._modified = True

core/decorators.py

@@ -24,6 +24,7 @@ async def wrapper(self, ctx, *args, **kwargs):
 
 def owner_only():
     async def predicate(ctx):
-        allowed = [int(x) for x in ctx.bot.config.get('OWNERS', '0').split(',')]
+        allowed = [int(x) for x in str(ctx.bot.config.get('owners', '0')).split(',')]
+        print(allowed)
         return ctx.author.id in allowed
     return commands.check(predicate)