Formatting and changelog change

Author: Taaku18

CHANGELOG.md

@@ -43,6 +43,9 @@ however, insignificant breaking changes does not guarantee a major version bump,
 - The placeholder channel for the streaming status changed to https://www.twitch.tv/discordmodmail/.
 - Removed unclear `rm` alias for some `remove` commands.
 - Paginate `?config options`.
+- All users configured with a permission level greater than REGULAR has access to the main Modmail category.
+  - Category overrides also changes when a level is removed or added to a user or role.
+- `@everyone` is now accepted for `?perms add`.
 
 ### Fixes
 

bot.py

@@ -22,6 +22,7 @@
 from pymongo.errors import ConfigurationError
 
 try:
+    # noinspection PyUnresolvedReferences
     from colorama import init
 
     init()
@@ -94,7 +95,17 @@ def __init__(self):
             sys.exit(0)
 
         self.plugin_db = PluginDatabaseClient(self)
+
+        logger.line()
+        logger.info("┌┬┐┌─┐┌┬┐┌┬┐┌─┐┬┬")
+        logger.info("││││ │ │││││├─┤││")
+        logger.info("┴ ┴└─┘─┴┘┴ ┴┴ ┴┴┴─┘")
+        logger.info("v%s", __version__)
+        logger.info("Authors: kyb3r, fourjr, Taaku18")
+        logger.line()
+
         self._load_extensions()
+        logger.line()
 
     @property
     def uptime(self) -> str:
@@ -168,14 +179,6 @@ async def get_prefix(self, message=None):
 
     def _load_extensions(self):
         """Adds commands automatically"""
-        logger.line()
-        logger.info("┌┬┐┌─┐┌┬┐┌┬┐┌─┐┬┬")
-        logger.info("││││ │ │││││├─┤││")
-        logger.info("┴ ┴└─┘─┴┘┴ ┴┴ ┴┴┴─┘")
-        logger.info("v%s", __version__)
-        logger.info("Authors: kyb3r, fourjr, Taaku18")
-        logger.line()
-
         for file in os.listdir("cogs"):
             if not file.endswith(".py"):
                 continue
@@ -232,9 +235,12 @@ async def is_owner(self, user: discord.User) -> bool:
     def log_channel(self) -> typing.Optional[discord.TextChannel]:
         channel_id = self.config["log_channel_id"]
         if channel_id is not None:
-            channel = self.get_channel(int(channel_id))
-            if channel is not None:
-                return channel
+            try:
+                channel = self.get_channel(int(channel_id))
+                if channel is not None:
+                    return channel
+            except ValueError:
+                pass
             logger.debug("LOG_CHANNEL_ID was invalid, removed.")
             self.config.remove("log_channel_id")
         if self.main_category is not None:
@@ -255,10 +261,6 @@ def log_channel(self) -> typing.Optional[discord.TextChannel]:
         )
         return None
 
-    @property
-    def is_connected(self) -> bool:
-        return self._connected.is_set()
-
     async def wait_for_connected(self) -> None:
         await self.wait_until_ready()
         await self._connected.wait()
@@ -277,7 +279,7 @@ def token(self) -> str:
         token = self.config["token"]
         if token is None:
             logger.critical(
-                "TOKEN must be set, set this as bot token found on the Discord Dev Portal."
+                "TOKEN must be set, set this as bot token found on the Discord Developer Portal."
             )
             sys.exit(0)
         return token
@@ -289,6 +291,7 @@ def guild_id(self) -> typing.Optional[int]:
             try:
                 return int(str(guild_id))
             except ValueError:
+                self.config.remove("guild_id")
                 logger.critical("Invalid GUILD_ID set.")
         return None
 
@@ -309,9 +312,12 @@ def modmail_guild(self) -> typing.Optional[discord.Guild]:
         modmail_guild_id = self.config["modmail_guild_id"]
         if modmail_guild_id is None:
             return self.guild
-        guild = discord.utils.get(self.guilds, id=int(modmail_guild_id))
-        if guild is not None:
-            return guild
+        try:
+            guild = discord.utils.get(self.guilds, id=int(modmail_guild_id))
+            if guild is not None:
+                return guild
+        except ValueError:
+            pass
         self.config.remove("modmail_guild_id")
         logger.critical("Invalid MODMAIL_GUILD_ID set.")
         return self.guild
@@ -325,11 +331,14 @@ def main_category(self) -> typing.Optional[discord.CategoryChannel]:
         if self.modmail_guild is not None:
             category_id = self.config["main_category_id"]
             if category_id is not None:
-                cat = discord.utils.get(
-                    self.modmail_guild.categories, id=int(category_id)
-                )
-                if cat is not None:
-                    return cat
+                try:
+                    cat = discord.utils.get(
+                        self.modmail_guild.categories, id=int(category_id)
+                    )
+                    if cat is not None:
+                        return cat
+                except ValueError:
+                    pass
                 self.config.remove("main_category_id")
                 logger.debug("MAIN_CATEGORY_ID was invalid, removed.")
             cat = discord.utils.get(self.modmail_guild.categories, name="Modmail")
@@ -353,41 +362,34 @@ def blocked_whitelisted_users(self) -> typing.List[str]:
     def prefix(self) -> str:
         return str(self.config["prefix"])
 
-    @property
-    def mod_color(self) -> int:
-        color = self.config["mod_color"]
+    def _parse_color(self, conf_name):
+        color = self.config[conf_name]
         try:
             return int(color.lstrip("#"), base=16)
         except ValueError:
-            logger.error("Invalid mod_color provided.")
-        return int(self.config.remove("mod_color").lstrip("#"), base=16)
+            logger.error("Invalid %s provided.", conf_name)
+        return int(self.config.remove(conf_name).lstrip("#"), base=16)
+
+    @property
+    def mod_color(self) -> int:
+        return self._parse_color("mod_color")
 
     @property
     def recipient_color(self) -> int:
-        color = self.config["recipient_color"]
-        try:
-            return int(color.lstrip("#"), base=16)
-        except ValueError:
-            logger.error("Invalid recipient_color provided.")
-        return int(self.config.remove("recipient_color").lstrip("#"), base=16)
+        return self._parse_color("recipient_color")
 
     @property
     def main_color(self) -> int:
-        color = self.config["main_color"]
-        try:
-            return int(color.lstrip("#"), base=16)
-        except ValueError:
-            logger.error("Invalid main_color provided.")
-        return int(self.config.remove("main_color").lstrip("#"), base=16)
+        return self._parse_color("main_color")
 
     async def on_connect(self):
         logger.line()
         try:
             await self.validate_database_connection()
         except Exception:
+            logger.debug("Logging out due to failed database connection.")
             return await self.logout()
 
-        logger.line()
         logger.info("Connected to gateway.")
         await self.config.refresh()
         await self.setup_indexes()
@@ -436,6 +438,8 @@ async def on_ready(self):
         logger.info("Prefix: %s", self.prefix)
         logger.info("Guild Name: %s", self.guild.name)
         logger.info("Guild ID: %s", self.guild.id)
+        if self.using_multiple_server_setup:
+            logger.info("Receiving guild ID: %s", self.modmail_guild.id)
         logger.line()
 
         await self.threads.populate_cache()
@@ -508,15 +512,16 @@ async def retrieve_emoji(self) -> typing.Tuple[str, str]:
             except commands.BadArgument:
                 logger.warning("Removed sent emoji (%s).", sent_emoji)
                 sent_emoji = self.config.remove("sent_emoji")
+                await self.config.update()
 
         if blocked_emoji != "disable":
             try:
                 blocked_emoji = await self.convert_emoji(blocked_emoji)
             except commands.BadArgument:
                 logger.warning("Removed blocked emoji (%s).", blocked_emoji)
                 blocked_emoji = self.config.remove("blocked_emoji")
+                await self.config.update()
 
-        await self.config.update()
         return sent_emoji, blocked_emoji
 
     async def _process_blocked(self, message: discord.Message) -> bool:
@@ -531,7 +536,7 @@ async def _process_blocked(self, message: discord.Message) -> bool:
                 try:
                     await message.add_reaction(sent_emoji)
                 except (discord.HTTPException, discord.InvalidArgument):
-                    pass
+                    logger.warning("Failed to add sent_emoji.", exc_info=True)
 
             return False
 
@@ -761,6 +766,7 @@ async def get_context(self, message, *, cls=commands.Context):
     async def update_perms(
         self, name: typing.Union[PermissionLevel, str], value: int, add: bool = True
     ) -> None:
+        value = int(value)
         if isinstance(name, PermissionLevel):
             permissions = self.config["level_permissions"]
             name = name.name
@@ -1043,19 +1049,6 @@ async def on_command_error(self, context, exception):
         else:
             logger.error("Unexpected exception:", exc_info=exception)
 
-    @staticmethod
-    def overwrites(ctx: commands.Context) -> dict:
-        """Permission overwrites for the guild."""
-        overwrites = {
-            ctx.guild.default_role: discord.PermissionOverwrite(read_messages=False),
-            ctx.guild.me: discord.PermissionOverwrite(read_messages=True),
-        }
-
-        for role in ctx.guild.roles:
-            if role.permissions.administrator:
-                overwrites[role] = discord.PermissionOverwrite(read_messages=True)
-        return overwrites
-
     async def validate_database_connection(self):
         try:
             await self.db.command("buildinfo")
@@ -1113,12 +1106,14 @@ async def before_post_metadata(self):
         if not self.guild:
             self.metadata_loop.cancel()
 
-    async def after_post_metadata(self):
+    @staticmethod
+    async def after_post_metadata():
         logger.info("Metadata loop has been cancelled.")
 
 
 if __name__ == "__main__":
     try:
+        # noinspection PyUnresolvedReferences
         import uvloop
 
         logger.debug("Setting up with uvloop.")

cogs/modmail.py

@@ -3,7 +3,7 @@
 from datetime import datetime
 from itertools import zip_longest
 from typing import Optional, Union
-from types import SimpleNamespace as param
+from types import SimpleNamespace
 
 import discord
 from discord.ext import commands
@@ -39,6 +39,11 @@ async def setup(self, ctx):
         once after configuring Modmail.
         """
 
+        if ctx.guild != self.bot.modmail_guild:
+            return await ctx.send(
+                f"You can only setup in the Modmail guild: {self.bot.modmail_guild}."
+            )
+
         if self.bot.main_category is not None:
             logger.debug("Can't re-setup server, main_category is found.")
             return await ctx.send(f"{self.bot.modmail_guild} is already set up.")
@@ -51,8 +56,31 @@ async def setup(self, ctx):
             )
             return await ctx.send(embed=embed)
 
+        overwrites = {
+            self.bot.modmail_guild.default_role: discord.PermissionOverwrite(
+                read_messages=False
+            ),
+            self.bot.modmail_guild.me: discord.PermissionOverwrite(read_messages=True),
+        }
+
+        for level in PermissionLevel:
+            if level <= PermissionLevel.REGULAR:
+                continue
+            permissions = self.bot.config["level_permissions"].get(level.name, [])
+            for perm in permissions:
+                perm = int(perm)
+                if perm == -1:
+                    key = self.bot.modmail_guild.default_role
+                else:
+                    key = self.bot.modmail_guild.get_member(perm)
+                    if key is None:
+                        key = self.bot.modmail_guild.get_role(perm)
+                if key is not None:
+                    logger.info("Granting %s access to Modmail category.", key.name)
+                    overwrites[key] = discord.PermissionOverwrite(read_messages=True)
+
         category = await self.bot.modmail_guild.create_category(
-            name="Modmail", overwrites=self.bot.overwrites(ctx)
+            name="Modmail", overwrites=overwrites
         )
 
         await category.edit(position=0)
@@ -86,10 +114,12 @@ async def setup(self, ctx):
 
         await self.bot.config.update()
         await ctx.send(
-            "Successfully set up server.\n"
-            "Consider setting permission levels to give access "
-            "to roles or users the ability to use Modmail.\n"
-            f"Type `{self.bot.prefix}permissions` for more info."
+            "**Successfully set up server.**\n"
+            "Consider setting permission levels "
+            "to give access to roles or users the ability to use Modmail.\n\n"
+            f"Type:\n- `{self.bot.prefix}permissions` and `{self.bot.prefix}permissions add` "
+            "for more info on setting permissions.\n"
+            f"- `{self.bot.prefix}config help` for a list of available customizations."
         )
 
         if (
@@ -612,7 +642,7 @@ async def logs(self, ctx, *, user: User = None):
         if not user:
             thread = ctx.thread
             if not thread:
-                raise commands.MissingRequiredArgument(param(name="member"))
+                raise commands.MissingRequiredArgument(SimpleNamespace(name="member"))
             user = thread.recipient
 
         default_avatar = "https://cdn.discordapp.com/embed/avatars/0.png"
@@ -977,7 +1007,7 @@ async def block(
             if thread:
                 user = thread.recipient
             elif after is None:
-                raise commands.MissingRequiredArgument(param(name="user"))
+                raise commands.MissingRequiredArgument(SimpleNamespace(name="user"))
             else:
                 raise commands.BadArgument(f'User "{after.arg}" not found')
 
@@ -1058,7 +1088,7 @@ async def unblock(self, ctx, *, user: User = None):
             if thread:
                 user = thread.recipient
             else:
-                raise commands.MissingRequiredArgument(param(name="user"))
+                raise commands.MissingRequiredArgument(SimpleNamespace(name="user"))
 
         mention = getattr(user, "mention", f"`{user.id}`")
         name = getattr(user, "name", f"`{user.id}`")

cogs/plugins.py

@@ -62,9 +62,9 @@ def parse_plugin(name):
             if "@" in result[2]:
                 # branch is specified
                 # for example, fourjr/modmail-plugins/welcomer@develop is a valid name
-                branchsplit_result = result[2].split("@")
-                result.append(branchsplit_result[-1])
-                result[2] = "@".join(branchsplit_result[:-1])
+                branch_split_result = result[2].split("@")
+                result.append(branch_split_result[-1])
+                result[2] = "@".join(branch_split_result[:-1])
             else:
                 result.append("master")