v2.18.0 - new permission system

Author: Taaku18

CHANGELOG.md

@@ -5,6 +5,39 @@ 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.18.0
+
+### What's new?
+
+- A brand new permission system! Replacing the old guild-based permissions (ie. manage channels, manage messages), the new system enables you to customize your desire permission level specific to a command or a group of commands for a role or user.
+- There are five permission groups/levels:
+  - Owner
+  - Administrator
+  - Moderator
+  - Supporter
+  - Regular
+
+You may add a role or user to a permission group through any of the following methods:
+- `?permissions add level owner @role`
+- `?permissions add level supporter member-name`
+- `?permissions add level moderator everyone`
+- `?permissions add level moderator @member#1234`
+- `?permissions add level administrator 78912384930291853`
+
+The same applies for individual commands permissions:
+- `?permissions add command-name @member#1234`
+- ... and the other methods listed above.
+
+To revoke a permission, use `remove` instead of `add`.
+
+To view all roles and users with permission for a permission group or command do:
+-  `?permissions get command command-name`
+-  `?permissions get level owner`
+
+### Note
+
+When updating to this version, all prior permission settings with guild-based permissions will be invalidated. You will need to convert to the above system.
+
 # v2.17.1
 
 ### Changed

bot.py

@@ -22,7 +22,7 @@
 SOFTWARE.
 """
 
-__version__ = '2.17.1'
+__version__ = '2.18.0'
 
 import asyncio
 import logging
@@ -48,7 +48,7 @@
 from core.clients import ModmailApiClient, SelfHostedClient, PluginDatabaseClient
 from core.config import ConfigManager
 from core.utils import info, error
-from core.models import Bot
+from core.models import Bot, PermissionLevel
 from core.thread import ThreadManager
 from core.time import human_timedelta
 
@@ -195,11 +195,6 @@ def _load_extensions(self):
             except Exception:
                 logger.exception(error(f'Failed to load {cog}'))
 
-    async def is_owner(self, user):
-        allowed = {int(x) for x in
-                   str(self.config.get('owners', '0')).split(',')}
-        return user.id in allowed
-
     def run(self, *args, **kwargs):
         try:
             self.loop.run_until_complete(self.start(self.token))
@@ -599,6 +594,25 @@ async def get_context(self, message, *, cls=commands.Context):
 
         return ctx
 
+    async def update_perms(self, name, value, add=True):
+        if isinstance(name, PermissionLevel):
+            permissions = self.config.level_permissions
+            name = name.name
+        else:
+            permissions = self.config.command_permissions
+        if name not in permissions:
+            if add:
+                permissions[name] = [value]
+        else:
+            if add:
+                if value not in permissions[name]:
+                    permissions[name].append(value)
+            else:
+                if value in permissions[name]:
+                    permissions[name].remove(value)
+        logger.info(info(f'Updating permissions for {name}, {value} (add={add}).'))
+        await self.config.update()
+
     async def on_message(self, message):
         if message.type == discord.MessageType.pins_add and \
                 message.author == self.user:
@@ -799,7 +813,7 @@ def overwrites(ctx):
         }
 
         for role in ctx.guild.roles:
-            if role.permissions.manage_guild:
+            if role.permissions.administrator:
                 overwrites[role] = discord.PermissionOverwrite(
                     read_messages=True
                 )

cogs/modmail.py

@@ -12,7 +12,7 @@
 
 from core import checks
 from core.decorators import trigger_typing
-from core.models import Bot
+from core.models import Bot, PermissionLevel
 from core.paginator import PaginatorSession
 from core.time import UserFriendlyTime, human_timedelta
 from core.utils import format_preview, User
@@ -26,7 +26,7 @@ def __init__(self, bot: Bot):
 
     @commands.command()
     @trigger_typing
-    @checks.has_permissions(administrator=True)
+    @checks.has_permissions(PermissionLevel.OWNER)
     async def setup(self, ctx):
         """Sets up a server for Modmail"""
         if self.bot.main_category:
@@ -62,15 +62,18 @@ async def setup(self, ctx):
         self.bot.config['log_channel_id'] = log_channel.id
 
         await self.bot.config.update()
-        await ctx.send('Successfully set up server.')
+        await ctx.send('Successfully set up server.\n'
+                       'Consider setting permission groups to give access '
+                       'to roles or users the ability to use Modmail.\n'
+                       f'Type `{self.bot.prefix}permissions` for more info.')
+        if not self.bot.config.permissions:
+            await self.bot.update_perms(PermissionLevel.REGULAR, -1)
+            await self.bot.update_perms(PermissionLevel.OWNER, ctx.author.id)
 
-    @commands.group()
-    @checks.has_permissions(manage_messages=True)
+    @commands.group(invoke_without_command=True)
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     async def snippets(self, ctx):
         """Returns a list of snippets that are currently set."""
-        if ctx.invoked_subcommand is not None:
-            return
-
         embeds = []
 
         if self.bot.snippets:
@@ -101,7 +104,7 @@ async def snippets(self, ctx):
         await session.run()
 
     @snippets.command(name='add')
-    @checks.has_permissions(manage_messages=True)
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     async def add_(self, ctx, name: str.lower, *, value):
         """Add a snippet to the bot config."""
         if 'snippets' not in self.bot.config.cache:
@@ -118,9 +121,9 @@ async def add_(self, ctx, name: str.lower, *, value):
 
         await ctx.send(embed=embed)
 
-    @snippets.command(name='del')
-    @checks.has_permissions(manage_messages=True)
-    async def del_(self, ctx, *, name: str.lower):
+    @snippets.command(name='remove', aliases=['del', 'delete', 'rm'])
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
+    async def remove_(self, ctx, *, name: str.lower):
         """Removes a snippet from bot config."""
 
         if self.bot.config.snippets.get(name):
@@ -142,7 +145,7 @@ async def del_(self, ctx, *, name: str.lower):
         await ctx.send(embed=embed)
 
     @commands.command()
-    @checks.has_permissions(manage_messages=True)
+    @checks.has_permissions(PermissionLevel.MODERATOR)
     async def move(self, ctx, *, category: discord.CategoryChannel):
         """Moves a thread to a specified category."""
         thread = ctx.thread
@@ -179,6 +182,7 @@ async def send_scheduled_close_message(ctx, after, silent=False):
         await ctx.send(embed=embed)
 
     @commands.command(usage='[after] [close message]')
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def close(self, ctx, *, after: UserFriendlyTime = None):
         """
@@ -236,6 +240,7 @@ async def close(self, ctx, *, after: UserFriendlyTime = None):
         )
 
     @commands.command(aliases=['alert'])
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def notify(self, ctx, *, role=None):
         """
@@ -272,6 +277,7 @@ async def notify(self, ctx, *, role=None):
         return await ctx.send(embed=embed)
 
     @commands.command(aliases=['sub'])
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def subscribe(self, ctx, *, role=None):
         """
@@ -311,6 +317,7 @@ async def subscribe(self, ctx, *, role=None):
         return await ctx.send(embed=embed)
 
     @commands.command(aliases=['unsub'])
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def unsubscribe(self, ctx, *, role=None):
         """Unsubscribe yourself or a given role from a thread."""
@@ -343,13 +350,15 @@ async def unsubscribe(self, ctx, *, role=None):
         return await ctx.send(embed=embed)
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def nsfw(self, ctx):
         """Flags a Modmail thread as nsfw."""
         await ctx.channel.edit(nsfw=True)
         await ctx.message.add_reaction('✅')
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def loglink(self, ctx):
         """Return the link to the current thread's logs."""
@@ -407,7 +416,7 @@ def format_log_embeds(self, logs, avatar_url):
         return embeds
 
     @commands.group(invoke_without_command=True)
-    @checks.has_permissions(manage_messages=True)
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     async def logs(self, ctx, *, member: User = None):
         """Shows a list of previous Modmail thread logs of a member."""
 
@@ -440,7 +449,7 @@ async def logs(self, ctx, *, member: User = None):
         await session.run()
 
     @logs.command(name='closed-by')
-    @checks.has_permissions(manage_messages=True)
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     async def closed_by(self, ctx, *, user: User = None):
         """Returns all logs closed by a user."""
         if not self.bot.self_hosted:
@@ -478,8 +487,8 @@ async def closed_by(self, ctx, *, user: User = None):
         session = PaginatorSession(ctx, *embeds)
         await session.run()
 
-    @logs.command(name='search')
-    @checks.has_permissions(manage_messages=True)
+    @logs.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     async def search(self, ctx, limit: Optional[int] = None, *, query):
         """Searches all logs for a message that contains your query."""
 
@@ -521,6 +530,7 @@ async def search(self, ctx, limit: Optional[int] = None, *, query):
         await session.run()
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def reply(self, ctx, *, msg=''):
         """Reply to users using this command.
@@ -533,6 +543,7 @@ async def reply(self, ctx, *, msg=''):
             await ctx.thread.reply(ctx.message)
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def anonreply(self, ctx, *, msg=''):
         """Reply to a thread anonymously.
@@ -548,6 +559,7 @@ async def anonreply(self, ctx, *, msg=''):
             await ctx.thread.reply(ctx.message, anonymous=True)
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def note(self, ctx, *, msg=''):
         """Take a note about the current thread, useful for noting context."""
@@ -556,6 +568,7 @@ async def note(self, ctx, *, msg=''):
             await ctx.thread.note(ctx.message)
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @checks.thread_only()
     async def edit(self, ctx, message_id: Optional[int] = None,
                    *, new_message):
@@ -599,8 +612,8 @@ async def edit(self, ctx, message_id: Optional[int] = None,
         await ctx.message.add_reaction('✅')
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.SUPPORTER)
     @trigger_typing
-    @checks.has_permissions(manage_messages=True)
     async def contact(self, ctx,
                       category: Optional[discord.CategoryChannel] = None, *,
                       user: Union[discord.Member, discord.User]):
@@ -639,8 +652,8 @@ async def contact(self, ctx,
         await ctx.send(embed=embed)
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.MODERATOR)
     @trigger_typing
-    @checks.has_permissions(manage_channels=True)
     async def blocked(self, ctx):
         """Returns a list of blocked users"""
         embed = discord.Embed(title='Blocked Users',
@@ -672,8 +685,8 @@ async def blocked(self, ctx):
         await ctx.send(embed=embed)
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.MODERATOR)
     @trigger_typing
-    @checks.has_permissions(manage_channels=True)
     async def block(self, ctx, user: Optional[User] = None, *,
                     after: UserFriendlyTime = None):
         """
@@ -738,8 +751,8 @@ async def block(self, ctx, user: Optional[User] = None, *,
         return await ctx.send(embed=embed)
 
     @commands.command()
+    @checks.has_permissions(PermissionLevel.MODERATOR)
     @trigger_typing
-    @checks.has_permissions(manage_channels=True)
     async def unblock(self, ctx, *, user: User = None):
         """
         Unblocks a user from using Modmail.

cogs/plugins.py

@@ -9,7 +9,8 @@
 
 from discord.ext import commands
 
-from core.models import Bot
+from core import checks
+from core.models import Bot, PermissionLevel
 from core.utils import info, error
 
 logger = logging.getLogger('Modmail')
@@ -113,15 +114,15 @@ async def load_plugin(self, username, repo, plugin_name):
             msg = f'Loaded plugins.{username}-{repo}.{plugin_name}'
             logger.info(info(msg))
 
-    @commands.group(aliases=['plugins'])
-    @commands.is_owner()
+    @commands.group(aliases=['plugins'], invoke_without_command=True)
+    @checks.has_permissions(PermissionLevel.OWNER)
     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')
+        cmd = self.bot.get_command('help')
+        await ctx.invoke(cmd, command='plugin')
 
     @plugin.command()
+    @checks.has_permissions(PermissionLevel.OWNER)
     async def add(self, ctx, *, plugin_name):
         """Adds a plugin"""
         if plugin_name in self.bot.config.plugins:
@@ -161,6 +162,7 @@ async def add(self, ctx, *, plugin_name):
                                    'Use username/repo/plugin.')
 
     @plugin.command()
+    @checks.has_permissions(PermissionLevel.OWNER)
     async def remove(self, ctx, *, plugin_name):
         """Removes a certain plugin"""
         if plugin_name in self.bot.config.plugins:
@@ -195,6 +197,7 @@ def onerror(func, path, exc_info):
             await ctx.send('Plugin not installed.')
 
     @plugin.command()
+    @checks.has_permissions(PermissionLevel.OWNER)
     async def update(self, ctx, *, plugin_name):
         """Updates a certain plugin"""
         if plugin_name not in self.bot.config.plugins:
@@ -227,6 +230,7 @@ async def update(self, ctx, *, plugin_name):
                         await ctx.send(f'Unable to start plugin: `{exc}`')
 
     @plugin.command(name='list')
+    @checks.has_permissions(PermissionLevel.OWNER)
     async def list_(self, ctx):
         """Shows a list of currently enabled plugins"""
         if self.bot.config.plugins: