Store blocked users in the database now.

Author: kyb3r

CHANGELOG.md

@@ -5,19 +5,20 @@ 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).
 
 
-# [ unreleased ]
+# v2.0.8
 
-Improvements in commands and new config option available.
+Improvements in commands and new config options available.
 
 ### Added 
 - Added the ability to use your own log channel 
-    - You can do this by using the `config set log_channel_id <id>` command.
+    - 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.
-
+    - This means you can delete the top channel in the modmail category now. (Migrate first though.)
 
 # v2.0.7
 

bot.py

@@ -22,7 +22,7 @@
 SOFTWARE.
 """
 
-__version__ = '2.0.7'
+__version__ = '2.0.8'
 
 import asyncio
 import textwrap
@@ -94,7 +94,7 @@ def run(self):
 
     @property
     def log_channel(self):
-        channel_id = self.config.get('bot_log_channel_id')
+        channel_id = self.config.get('log_channel_id')
         if channel_id is not None:
             return self.get_channel(int(channel_id))
         else:
@@ -136,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):
@@ -422,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.')
 
@@ -150,6 +150,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}`'
@@ -299,19 +302,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'
@@ -321,7 +324,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:
@@ -331,21 +334,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:
@@ -368,18 +368,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'

core/config.py

@@ -7,7 +7,8 @@ class ConfigManager:
     """Class that manages a cached configuration"""
 
     allowed_to_change_in_command = {
-        'status', 'bot_log_channel_id', 'mention', 'disable_autoupdates', 'prefix'
+        'status', 'log_channel_id', 'mention', 'disable_autoupdates', 'prefix',
+        'main_category_id'
         }
 
     internal_keys = {
@@ -28,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}