Merge pull request #109 from kyb3r/v2.0.8-dev

Improvements in block command and new config options available. (v2.0.8)

Author: kyb3r

CHANGELOG.md

@@ -4,6 +4,22 @@ All notable changes to this project will be documented in this file.
 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.0.8
+
+Improvements in commands and new config options available.
+
+### Added 
+- Added the ability to use your own log channel 
+    - You can do this via the `config set log_channel_id <id>` command.
+- Added the ability to use your own main inbox category.
+    - You can do this via the `config set main_category_id <id>` command.
+
+### Changed
+- You now have the ability to supply a reason when blocking a user. 
+- Blocked users are now stored in the database instead of in the channel topic.
+    - This means you can delete the top channel in the modmail category now. (Migrate first though.)
+
 # v2.0.7
 
 New command and improvements in bot update message interfaces. 

bot.py

@@ -22,7 +22,7 @@
 SOFTWARE.
 """
 
-__version__ = '2.0.7'
+__version__ = '2.0.8'
 
 import asyncio
 import textwrap
@@ -91,6 +91,14 @@ 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')
+        if channel_id is not None:
+            return self.get_channel(int(channel_id))
+        else:
+            return self.main_category.channels[0]
 
     @property
     def snippets(self):
@@ -128,14 +136,15 @@ def using_multiple_server_setup(self):
 
     @property
     def main_category(self):
+        category_id = self.config.get('main_category_id')
+        if category_id is not None:
+            return discord.utils.get(self.modmail_guild.categories, id=int(category_id))
         if self.modmail_guild:
             return discord.utils.get(self.modmail_guild.categories, name='Mod Mail')
 
     @property
     def blocked_users(self):
-        if self.modmail_guild:
-            top_chan = self.main_category.channels[0]
-            return [int(i) for i in re.findall(r'\d+', top_chan.topic)]
+        return self.config.get('blocked', {})
 
     @property
     def prefix(self):
@@ -167,7 +176,7 @@ async def on_ready(self):
         {Fore.CYAN}Guild ID: {self.guild.id if self.guild else 0}
         {line}
         """).strip())
-        
+
         if not self.guild:
             print(Fore.RED + Style.BRIGHT + 'WARNING - The GUILD_ID provided does not exist!' + Style.RESET_ALL)
         else:
@@ -292,7 +301,7 @@ async def on_guild_channel_delete(self, channel):
             desc = f"[`{log_data['key']}`]({log_url}) {mod.mention} closed a thread with {user}"
             em = discord.Embed(description=desc, color=em.color)
             em.set_author(name='Thread closed', url=log_url)
-            await self.main_category.channels[0].send(embed=em)
+            await self.log_channel.send(embed=em)
 
     async def on_message_delete(self, message):
         """Support for deleting linked messages"""
@@ -414,7 +423,7 @@ async def autoupdate_loop(self):
                     short_sha = commit_data['sha'][:6]
                     em.add_field(name='Merge Commit', value=f"[`{short_sha}`]({html_url}) {message} - {user['username']}")
                     print('Updating bot.')
-                    channel = self.main_category.channels[0]
+                    channel = self.log_channel
                     await channel.send(embed=em)
 
             await asyncio.sleep(3600)

cogs/modmail.py

@@ -30,8 +30,8 @@ async def setup(self, ctx):
         await categ.edit(position=0)
 
         c = await self.bot.modmail_guild.create_text_channel(name='bot-logs', category=categ)
-        await c.edit(topic='Manually add user id\'s to block users.\n\n'
-                           'Blocked\n-------\n\n')
+        await c.edit(topic='You can delete this channel if you set up your own log channel.')
+        await c.send('Use the `config set log_channel_id` command to set up a custom log channel.')
 
         await ctx.send('Successfully set up server.')
 
@@ -87,9 +87,6 @@ async def _add(self, ctx, name: str.lower, *, value):
     async def __del(self, ctx, *, name: str.lower):
         """Removes a snippet from bot config."""
 
-        if 'snippets' not in self.bot.config.cache:
-            self.bot.config['snippets'] = {}
-
         em = discord.Embed(
             title='Removed snippet',
             color=discord.Color.green(),
@@ -101,7 +98,7 @@ async def __del(self, ctx, *, name: str.lower):
             em.color = discord.Color.red()
             em.description = f'Snippet `{name}` does not exist.'
         else:
-            self.bot.config['snippets'][name] = None
+            del self.bot.config['snippets'][name]
             await self.bot.config.update()
 
         await ctx.send(embed=em)
@@ -138,8 +135,7 @@ async def _close(self, ctx):
             pass
 
         # Logging
-        categ = self.bot.main_category
-        log_channel = categ.channels[0]
+        log_channel = self.bot.log_channel
 
         log_data = await self.bot.modmail_api.post_log(ctx.channel.id, {
             'open': False, 'closed_at': str(datetime.datetime.utcnow()), 'closer': {
@@ -151,6 +147,9 @@ async def _close(self, ctx):
             }
         })
 
+        if isinstance(log_data, str):
+            print(log_data) # error
+
         log_url = f"https://logs.modmail.tk/{log_data['user_id']}/{log_data['key']}"
 
         user = thread.recipient.mention if thread.recipient else f'`{thread.id}`'
@@ -300,19 +299,19 @@ async def blocked(self, ctx):
         users = []
         not_reachable = []
 
-        for id in self.bot.blocked_users:
-            user = self.bot.get_user(id)
+        for id, reason in self.bot.blocked_users.items():
+            user = self.bot.get_user(int(id))
             if user:
-                users.append(user)
+                users.append((user, reason))
             else:
-                not_reachable.append(id)
+                not_reachable.append((id, reason))
 
         em.description = 'Here is a list of blocked users.'
 
         if users:
-            em.add_field(name='Currently Known', value=' '.join(u.mention for u in users))
+            em.add_field(name='Currently Known', value='\n'.join(u.mention + (f' - `{r}`' if r else '') for u, r in users))
         if not_reachable:
-            em.add_field(name='Unknown', value='\n'.join(f'`{i}`' for i in not_reachable), inline=False)
+            em.add_field(name='Unknown', value='\n'.join(f'`{i}`' + (f' - `{r}`' if r else '') for i, r in not_reachable), inline=False)
 
         if not users and not not_reachable:
             em.description = 'Currently there are no blocked users'
@@ -322,7 +321,7 @@ async def blocked(self, ctx):
     @commands.command()
     @trigger_typing
     @commands.has_permissions(manage_channels=True)
-    async def block(self, ctx, *, user: Union[discord.Member, discord.User, obj]=None):
+    async def block(self, ctx, user: Union[discord.Member, discord.User, obj]=None, *, reason=None):
         """Block a user from using modmail."""
 
         if user is None:
@@ -332,21 +331,18 @@ async def block(self, ctx, *, user: Union[discord.Member, discord.User, obj]=Non
             else:
                 raise commands.UserInputError
 
-        categ = self.bot.main_category
-        top_chan = categ.channels[0]  # bot-info
-        topic = str(top_chan.topic)
-        topic += '\n' + str(user.id)
-
+        
         mention = user.mention if hasattr(user, 'mention') else f'`{user.id}`'
 
         em = discord.Embed()
         em.color = discord.Color.green()
 
-        if str(user.id) not in top_chan.topic:
-            await top_chan.edit(topic=topic)
+        if str(user.id) not in self.bot.blocked_users:
+            self.bot.config.blocked[str(user.id)] = reason
+            await self.bot.config.update()
 
             em.title = 'Success'
-            em.description = f'{mention} is now blocked'
+            em.description = f'{mention} is now blocked ' + f'for `{reason}`' if reason else ''
 
             await ctx.send(embed=em)
         else:
@@ -369,18 +365,14 @@ async def unblock(self, ctx, *, user: Union[discord.Member, discord.User, obj]=N
             else:
                 raise commands.UserInputError
 
-        categ = self.bot.main_category
-        top_chan = categ.channels[0]  # thread-logs
-        topic = str(top_chan.topic)
-        topic = topic.replace('\n' + str(user.id), '')
-
         mention = user.mention if hasattr(user, 'mention') else f'`{user.id}`'
 
         em = discord.Embed()
         em.color = discord.Color.green()
 
-        if str(user.id) in top_chan.topic:
-            await top_chan.edit(topic=topic)
+        if str(user.id) in self.bot.blocked_users:
+            del self.bot.config.blocked[str(user.id)]
+            await self.bot.config.update()
 
             em.title = 'Success'
             em.description = f'{mention} is no longer blocked'

cogs/utility.py

@@ -392,7 +392,7 @@ async def _del(self, ctx, key: str.lower):
             valid_keys = [f'`{k}`' for k in self.bot.config.allowed_to_change_in_command]
             em.add_field(name='Valid keys', value=', '.join(valid_keys))
         else:
-            self.bot.config.cache[key] = None
+            del self.bot.config.cache[key]
             await self.bot.config.update()
 
         await ctx.send(embed=em)
@@ -498,7 +498,7 @@ async def __del(self, ctx, *, name: str.lower):
             em.color = discord.Color.red()
             em.description = f'Alias `{name}` does not exist.'
         else:
-            self.bot.config['aliases'][name] = None
+            del self.bot.config['aliases'][name]
             await self.bot.config.update()
 
         await ctx.send(embed=em)

core/config.py

@@ -6,14 +6,17 @@
 class ConfigManager:
     """Class that manages a cached configuration"""
 
-    valid_keys = {
-        'prefix', 'status', 'guild_id',
-        'mention', 'disable_autoupdates',
-        'modmail_guild_id', 'token', 'snippets',
-        'aliases', 'owners', 'modmail_api_token'
-    }
+    allowed_to_change_in_command = {
+        'status', 'log_channel_id', 'mention', 'disable_autoupdates', 'prefix',
+        'main_category_id'
+        }
+    
+    internal_keys = {
+        'token', 'snippets', 'aliases', 'owners', 'modmail_api_token',
+        'guild_id', 'modmail_guild_id', 'blocked'
+        }
 
-    allowed_to_change_in_command = valid_keys - {'token', 'snippets', 'aliases', 'owners', 'modmail_api_token'}
+    valid_keys = allowed_to_change_in_command.union(internal_keys)
 
     def __init__(self, bot):
         self.bot = bot
@@ -26,10 +29,15 @@ def api(self):
         return self.bot.modmail_api
 
     def populate_cache(self):
+        data = {
+            'snippets': {},
+            'aliases': {},
+            'blocked': {}
+        }
         try:
-            data = json.load(open('config.json'))
+            data.update(json.load(open('config.json')))
         except FileNotFoundError:
-            data = {}
+            pass
         finally:
             data.update(os.environ)
             data = {k.lower(): v for k, v in data.items() if k.lower() in self.valid_keys}