Merge pull request #217 from kyb3r/perms

v2.18.0 - new permission system

Author: kyb3r

CHANGELOG.md

@@ -4,6 +4,52 @@ 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.18.0
+
+### New Permissions System
+
+- A brand new permission system! Replacing the old guild-based permissions (ie. manage channels, manage messages), the new system enables you to customize your desired permission level specific to a command or a group of commands for a role or user.
+- There are five permission groups/levels:
+  - Owner [5]
+  - Administrator [4]
+  - Moderator [3]
+  - Supporter [2]
+  - Regular [1]
+
+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 to individual commands permissions:
+- `?permissions add command-name @member#1234`
+- ... and the other methods listed above.
+
+To revoke 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`
+
+By default, all newly set up Modmail will have `OWNER` set to the owner of the bot, and `EGULAR` set to @everyone.
+
+### Breaking
+
+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.
+`OWNERS` will also get removed, you will need to set owners through `?permissions add level owner 212931293123129` or any way listed above.
+
+### New Command
+
+- A `?delete` command, which is an alternative to manually deleting a message. This command is created to no longer require manage messages permission to recall thread messages.
+
+### Changed
+
+- The help message no longer conceals inaccessible commands due to check failures.
+
+
 # v2.17.2
 
 ### Changed

bot.py

@@ -22,7 +22,7 @@
 SOFTWARE.
 """
 
-__version__ = '2.17.2'
+__version__ = '2.18.0'
 
 import asyncio
 import logging
@@ -49,11 +49,10 @@
 from core.clients import 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
 
-
 init()
 
 logger = logging.getLogger('Modmail')
@@ -189,11 +188,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))
@@ -478,7 +472,8 @@ async def process_modmail(self, message):
             except isodate.ISO8601Error:
                 logger.warning('The account age limit needs to be a '
                                'ISO-8601 duration formatted duration string '
-                               f'greater than 0 days, not "%s".', str(account_age))
+                               f'greater than 0 days, not "%s".',
+                               str(account_age))
                 del self.config.cache['account_age']
                 await self.config.update()
                 account_age = isodate.duration.Duration()
@@ -533,7 +528,7 @@ async def process_modmail(self, message):
                         await self.config.update()
         else:
             reaction = sent_emoji
-        
+
         if reaction != 'disable':
             try:
                 await message.add_reaction(reaction)
@@ -586,6 +581,27 @@ 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:
@@ -622,7 +638,7 @@ async def on_message(self, message):
 
     async def on_typing(self, channel, user, _):
         if user.bot:
-            return 
+            return
         if isinstance(channel, discord.DMChannel):
             if not self.config.get('user_typing'):
                 return
@@ -635,7 +651,7 @@ async def on_typing(self, channel, user, _):
             thread = await self.threads.find(channel=channel)
             if thread and thread.recipient:
                 await thread.recipient.trigger_typing()
-    
+
     async def on_raw_reaction_add(self, payload):
 
         user = self.get_user(payload.user_id)
@@ -655,12 +671,14 @@ async def on_raw_reaction_add(self, payload):
         message = await channel.get_message(payload.message_id)
         reaction = payload.emoji
 
-        close_emoji = await self.convert_emoji(self.config.get('close_emoji', '🔒'))
+        close_emoji = await self.convert_emoji(
+            self.config.get('close_emoji', '🔒')
+        )
 
         if isinstance(channel, discord.DMChannel) and str(reaction) == str(close_emoji):  # closing thread
             thread = await self.threads.find(recipient=user)
             ts = message.embeds[0].timestamp if message.embeds else None
-            if thread and ts == thread.channel.created_at: 
+            if thread and ts == thread.channel.created_at:
                 # the reacted message is the corresponding thread creation embed
                 if not self.config.get('disable_recipient_thread_close'):
                     await thread.close(closer=user)
@@ -706,24 +724,24 @@ async def on_guild_channel_delete(self, channel):
             return
 
         await thread.close(closer=mod, silent=True, delete_channel=False)
-    
+
     async def on_member_remove(self, member):
         thread = await self.threads.find(recipient=member)
         if thread:
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='The recipient has left the server.',
                 color=discord.Color.red()
-                )
-            await thread.channel.send(embed=em)
-    
+            )
+            await thread.channel.send(embed=embed)
+
     async def on_member_join(self, member):
         thread = await self.threads.find(recipient=member)
         if thread:
-            em = discord.Embed(
+            embed = discord.Embed(
                 description='The recipient has joined the server.',
                 color=self.mod_color
-                )
-            await thread.channel.send(embed=em)
+            )
+            await thread.channel.send(embed=embed)
 
     async def on_message_delete(self, message):
         """Support for deleting linked messages"""
@@ -786,7 +804,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
                 )
@@ -833,8 +851,9 @@ async def autoupdate_loop(self):
                 embed.set_author(name=user['username'] + ' - Updating Bot',
                                  icon_url=user['avatar_url'],
                                  url=user['url'])
-                embed.set_footer(text=f"Updating Modmail v{self.version} "
-                                      f"-> v{latest.version}")
+
+                embed.set_footer(text=f'Updating Modmail v{self.version} '
+                                      f'-> v{latest.version}')
 
                 embed.description = latest.description
                 for name, value in latest.fields.items():
@@ -888,6 +907,7 @@ async def metadata_loop(self):
 if __name__ == '__main__':
     if os.name != 'nt':
         import uvloop
+
         uvloop.install()
     bot = ModmailBot()
     bot.run()