Fix help cmd (check checks, blank cogs)

Author: fourjr

cogs/plugins.py

@@ -20,7 +20,7 @@ class Plugins:
 
     These addons could have a range of features from moderation to simply
     making your life as a moderator easier!
-    Learn how to create a plugin yourself here: https://link.com
+    Learn how to create a plugin yourself here: https://github.com/kyb3r/modmail/wiki/Plugins
     """
     def __init__(self, bot: Bot):
         self.bot = bot
@@ -110,6 +110,9 @@ async def add(self, ctx, *, plugin_name):
         """Adds a plugin"""
         if plugin_name in self.bot.config.plugins:
             return await ctx.send('Plugin already installed')
+        if plugin_name in self.bot.cogs.keys():
+            # another class with the same name
+            return await ctx.send('Another cog exists with the same name')
 
         message = await ctx.send('Downloading plugin...')
         async with ctx.typing():

cogs/utility.py

@@ -7,6 +7,7 @@
 from json import JSONDecodeError
 from textwrap import indent
 
+import discord
 from aiohttp import ClientResponseError
 from discord import Embed, Color, Activity
 from discord.enums import ActivityType
@@ -26,15 +27,25 @@ class Utility:
     def __init__(self, bot: Bot):
         self.bot = bot
 
-    def format_cog_help(self, ctx, cog):
+    async def check_checks(self, ctx, cmd):
+        predicates = cmd.checks
+        if not predicates:
+            return True
+
+        try:
+            return await discord.utils.async_all(predicate(ctx) for predicate in predicates)
+        except commands.CheckFailure:
+            return False
+
+    async def format_cog_help(self, ctx, cog):
         """Formats the text for a cog help"""
 
         prefix = self.bot.prefix
 
         fmts = ['']
         for cmd in sorted(self.bot.commands,
                           key=lambda cmd: cmd.qualified_name):
-            if cmd.instance is cog and not cmd.hidden:
+            if cmd.instance is cog and not cmd.hidden and await self.check_checks(ctx, cmd):
                 new_fmt = f'`{prefix + cmd.qualified_name}` - '
                 new_fmt += f'{cmd.short_doc}\n'
                 if len(new_fmt) + len(fmts[-1]) >= 1024:
@@ -44,6 +55,8 @@ def format_cog_help(self, ctx, cog):
 
         embeds = []
         for fmt in fmts:
+            if fmt == '':
+                continue
             embed = Embed(
                 description='*' + inspect.getdoc(cog) + '*',
                 color=self.bot.main_color
@@ -58,8 +71,11 @@ def format_cog_help(self, ctx, cog):
             embeds.append(embed)
         return embeds
 
-    def format_command_help(self, cmd):
+    async def format_command_help(self, ctx, cmd):
         """Formats command help."""
+        if cmd.hidden or not await self.check_checks(ctx, cmd):
+            return None
+
         prefix = self.bot.prefix
         embed = Embed(
             color=self.bot.main_color,
@@ -88,7 +104,7 @@ def format_command_help(self, cmd):
         )
         return embed
 
-    def format_not_found(self, ctx, command):
+    async def format_not_found(self, ctx, command):
         prefix = ctx.prefix
         embed = Embed(
             title='Unable to Find Command or Category',
@@ -97,7 +113,19 @@ def format_not_found(self, ctx, command):
         embed.set_footer(text=f'Type "{prefix}help" to get '
                               'a full list of commands.')
 
-        choices = set(self.bot.cogs.keys()) | set(self.bot.all_commands.keys())
+        choices = set()
+        # filter out hidden commands & blank cogs
+        for i in self.bot.cogs:
+            for cmd in self.bot.commands:
+                if cmd.cog_name == i and not cmd.hidden and await self.check_checks(ctx, cmd):
+                    # as long as there's one valid cmd, add cog
+                    choices.add(i)
+                    break
+
+        for i in self.bot.commands:
+            if not i.hidden and await self.check_checks(ctx, i):
+                choices.add(i.name)
+
         closest = get_close_matches(command, choices, n=1, cutoff=0.45)
         if closest:
             # Perhaps you meant:
@@ -106,27 +134,35 @@ def format_not_found(self, ctx, command):
                                  f'\u2000- `{closest[0]}`')
         return embed
 
-    @commands.command()
+    @commands.command(name='help')
     @trigger_typing
-    async def help(self, ctx, *, command: str = None):
+    async def help_(self, ctx, *, command: str = None):
         """Shows the help message."""
 
-        if command is not None:
+        if command:
             cmd = self.bot.get_command(command)
             cog = self.bot.cogs.get(command)
-            if cmd is not None:
-                embeds = [self.format_command_help(cmd)]
-            elif cog is not None:
-                embeds = self.format_cog_help(ctx, cog)
-            else:
-                embeds = [self.format_not_found(ctx, command)]
+            embeds = []
+
+            if cmd:
+                help_msg = await self.format_command_help(ctx, cmd)
+                if help_msg:
+                    embeds = [help_msg]
+
+            elif cog:
+                # checks if cog has commands
+                embeds = await self.format_cog_help(ctx, cog)
+
+            if not embeds:
+                embeds = [await self.format_not_found(ctx, command)]
+
             p_session = PaginatorSession(ctx, *embeds)
             return await p_session.run()
 
         embeds = []
         for cog in sorted(self.bot.cogs.values(),
                           key=lambda cog: cog.__class__.__name__):
-            embeds.extend(self.format_cog_help(ctx, cog))
+            embeds.extend(await self.format_cog_help(ctx, cog))
 
         p_session = PaginatorSession(ctx, *embeds)
         return await p_session.run()

config.json.example

@@ -1,6 +1,7 @@
 {
-  "TOKEN": "MyBotToken",
-  "MODMAIL_API_TOKEN": "MyApiToken",
-  "GUILD_ID": 1234567890,
-  "OWNERS": "Owner1ID,Owner2ID,Owner3ID",
+    "TOKEN": "MyBotToken",
+    "MODMAIL_API_TOKEN": "MyApiToken",
+    "GUILD_ID": 1234567890,
+    "OWNERS": "Owner1ID,Owner2ID,Owner3ID",
+    "MONGO_URI": "mongodb+srv://mongodburi"
 }