Merge pull request #237 from papiersnipper/master

Update the plugins cog

Author: kyb3r

cogs/plugins.py

@@ -41,16 +41,15 @@ def __init__(self, bot):
         self.registry = {}
         self.bot.loop.create_task(self.download_initial_plugins())
         self.bot.loop.create_task(self.populate_registry())
-    
+
     async def populate_registry(self):
         url = 'https://raw.githubusercontent.com/kyb3r/modmail/master/plugins/registry.json'
         async with self.bot.session.get(url) as resp:
             self.registry = json.loads(await resp.text())
 
     @staticmethod
     def _asubprocess_run(cmd):
-        return subprocess.run(cmd, shell=True, check=True,
-                              capture_output=True)
+        return subprocess.run(cmd, shell=True, check=True, capture_output=True)
 
     @staticmethod
     def parse_plugin(name):
@@ -60,10 +59,12 @@ def parse_plugin(name):
             result[2] = '/'.join(result[2:])
         except IndexError:
             return None
+
         return tuple(result)
 
     async def download_initial_plugins(self):
         await self.bot._connected.wait()
+
         for i in self.bot.config.plugins:
             parsed_plugin = self.parse_plugin(i)
 
@@ -78,29 +79,29 @@ async def download_initial_plugins(self):
                 except DownloadError as exc:
                     msg = f'{parsed_plugin[0]}/{parsed_plugin[1]} - {exc}'
                     logger.error(error(msg))
+
         await async_all(env() for env in self.bot.extra_events.get('on_plugin_ready', []))
+
         logger.debug(info('on_plugin_ready called.'))
 
     async def download_plugin_repo(self, username, repo):
         try:
             cmd = f'git clone https://github.com/{username}/{repo} '
             cmd += f'plugins/{username}-{repo} -q'
-            await self.bot.loop.run_in_executor(
-                None,
-                self._asubprocess_run,
-                cmd
-            )
+
+            await self.bot.loop.run_in_executor(None, self._asubprocess_run, cmd)
             # -q (quiet) so there's no terminal output unless there's an error
         except subprocess.CalledProcessError as exc:
             err = exc.stderr.decode('utf-8').strip()
-            if not err.endswith('already exists and is '
-                                'not an empty directory.'):
+
+            if not err.endswith('already exists and is not an empty directory.'):
                 # don't raise error if the plugin folder exists
                 raise DownloadError(error) from exc
 
     async def load_plugin(self, username, repo, plugin_name):
         ext = f'plugins.{username}-{repo}.{plugin_name}.{plugin_name}'
         dirname = f'plugins/{username}-{repo}/{plugin_name}'
+
         if 'requirements.txt' in os.listdir(dirname):
             # Install PIP requirements
             try:
@@ -113,6 +114,7 @@ async def load_plugin(self, username, repo, plugin_name):
                 # so there's no terminal output unless there's an error
             except subprocess.CalledProcessError as exc:
                 err = exc.stderr.decode('utf8').strip()
+
                 if err:
                     raise DownloadError(
                         f'Unable to download requirements: ```\n{error}\n```'
@@ -135,68 +137,105 @@ async def load_plugin(self, username, repo, plugin_name):
     @checks.has_permissions(PermissionLevel.OWNER)
     async def plugin(self, ctx):
         """Plugin handler. Controls the plugins in the bot."""
+
         await ctx.send_help(ctx.command)
 
     @plugin.command(name='add', aliases=['install'])
     @checks.has_permissions(PermissionLevel.OWNER)
     async def plugin_add(self, ctx, *, plugin_name: str):
         """Add a plugin."""
+
         if plugin_name in self.registry:
             info = self.registry[plugin_name]
             plugin_name = info['repository'] + '/' + plugin_name
             required_version = info['bot_version']
+
             if parse_version(self.bot.version) < parse_version(required_version):
-                return await ctx.send(f"Bot version too low, plugin requires version `{required_version}`")
+                em = discord.Embed(
+                    description=f'Your bot\'s version is too low. This plugin requires version `{required_version}`.',
+                    color=self.bot.main_color
+                )
+                return await ctx.send(embed=em)
+
         if plugin_name in self.bot.config.plugins:
-            return await ctx.send('Plugin already installed.')
+            em = discord.Embed(
+                description='This plugin is already installed.',
+                color=self.bot.main_color
+            )
+            return await ctx.send(embed=em)
+
         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.')
+            em = discord.Embed(
+                description='There\'s another cog installed with the same name.',
+                color=self.bot.main_color
+            )
+            return await ctx.send(embed=em)
+
+        em = discord.Embed(
+            description='Downloading this plugin...',
+            color=self.bot.main_color
+        )
+        message = await ctx.send(embed=em)
 
-        message = await ctx.send('Downloading plugin...')
         async with ctx.typing():
             if len(plugin_name.split('/')) >= 3:
                 parsed_plugin = self.parse_plugin(plugin_name)
 
                 try:
                     await self.download_plugin_repo(*parsed_plugin[:-1])
                 except DownloadError as exc:
-                    return await ctx.send(
-                        f'Unable to fetch plugin from Github: {exc}.'
+                    em = discord.Embed(
+                        description=f'Unable to fetch this plugin from Github: {exc}.',
+                        color=self.bot.main_color
                     )
+                    return await ctx.send(embed=em)
 
                 importlib.invalidate_caches()
+
                 try:
                     await self.load_plugin(*parsed_plugin)
                 except DownloadError as exc:
-                    return await ctx.send(f'Unable to load plugin: `{exc}`.')
+                    em = discord.Embed(
+                        description=f'Unable to load this plugin: {exc}.',
+                        color=self.bot.main_color
+                    )
+                    return await ctx.send(embed=em)
 
                 # if it makes it here, it has passed all checks and should
                 # be entered into the config
 
                 self.bot.config.plugins.append(plugin_name)
                 await self.bot.config.update()
 
-                await message.edit(content='Plugin installed. Any plugin that '
-                                   'you install is of your OWN RISK.')
+                em = discord.Embed(
+                    description='The plugin is installed.\n'
+                                '*Please note: any plugin that you install is of your OWN RISK*',
+                    color=self.bot.main_color
+                )
+                await message.edit(embed=em)
             else:
-                await message.edit(content='Invalid plugin name format. '
-                                   'Use username/repo/plugin.')
+                em = discord.Embed(
+                    description='Invalid plugin name format: use username/repo/plugin.',
+                    color=self.bot.main_color
+                )
+                await message.edit(embed=em)
 
     @plugin.command(name='remove', aliases=['del', 'delete', 'rm'])
     @checks.has_permissions(PermissionLevel.OWNER)
     async def plugin_remove(self, ctx, *, plugin_name: str):
         """Remove a plugin."""
+
         if plugin_name in self.registry:
             info = self.registry[plugin_name]
             plugin_name = info['repository'] + '/' + plugin_name
+
         if plugin_name in self.bot.config.plugins:
             try:
                 username, repo, name = self.parse_plugin(plugin_name)
-                self.bot.unload_extension(
-                    f'plugins.{username}-{repo}.{name}.{name}'
-                )
-            except:
+
+                self.bot.unload_extension(f'plugins.{username}-{repo}.{name}.{name}')
+            except Exception:
                 pass
 
             self.bot.config.plugins.remove(plugin_name)
@@ -211,67 +250,102 @@ def onerror(func, path, exc_info):  # pylint: disable=W0613
                             os.chmod(path, stat.S_IWUSR)
                             func(path)
 
-                    shutil.rmtree(f'plugins/{username}-{repo}',
-                                  onerror=onerror)
+                    shutil.rmtree(f'plugins/{username}-{repo}', onerror=onerror)
             except Exception as exc:
                 logger.error(str(exc))
                 self.bot.config.plugins.append(plugin_name)
                 raise exc
 
             await self.bot.config.update()
-            await ctx.send('Plugin uninstalled and '
-                           'all related data is erased.')
+
+            em = discord.Embed(
+                description='The plugin is uninstalled and all its data is erased.',
+                color=self.bot.main_color
+            )
+            await ctx.send(embed=em)
         else:
-            await ctx.send('Plugin not installed.')
+            em = discord.Embed(
+                description='That plugin is not installed.',
+                color=self.bot.main_color
+            )
+            await ctx.send(embed=em)
 
     @plugin.command(name='update')
     @checks.has_permissions(PermissionLevel.OWNER)
     async def plugin_update(self, ctx, *, plugin_name: str):
         """Update a plugin."""
+
         if plugin_name in self.registry:
             info = self.registry[plugin_name]
             plugin_name = info['repository'] + '/' + plugin_name
+
         if plugin_name not in self.bot.config.plugins:
-            return await ctx.send('Plugin not installed.')
+            em = discord.Embed(
+                description='That plugin is not installed.',
+                color=self.bot.main_color
+            )
+            return await ctx.send(embed=em)
 
         async with ctx.typing():
             username, repo, name = self.parse_plugin(plugin_name)
+
             try:
                 cmd = f'cd plugins/{username}-{repo} && git pull'
-                cmd = await self.bot.loop.run_in_executor(
-                    None,
-                    self._asubprocess_run,
-                    cmd
-                )
+                cmd = await self.bot.loop.run_in_executor(None, self._asubprocess_run, cmd)
             except subprocess.CalledProcessError as exc:
                 err = exc.stderr.decode('utf8').strip()
-                await ctx.send(f'Error while updating: {err}.')
+
+                em = discord.Embed(
+                    description=f'An error occured while updating: {err}.',
+                    color=self.bot.main_color
+                )
+                await ctx.send(embed=em)
+
             else:
                 output = cmd.stdout.decode('utf8').strip()
-                await ctx.send(f'```\n{output}\n```')
+
+                em = discord.Embed(
+                    description=f'```\n{output}\n```',
+                    color=self.bot.main_color
+                )
+                await ctx.send(embed=em)
 
                 if output != 'Already up to date.':
                     # repo was updated locally, now perform the cog reload
                     ext = f'plugins.{username}-{repo}.{name}.{name}'
                     self.bot.unload_extension(ext)
+
                     try:
                         await self.load_plugin(username, repo, name)
                     except DownloadError as exc:
-                        await ctx.send(f'Unable to start plugin: `{exc}`.')
+                        em = discord.Embed(
+                            description=f'Unable to start the plugin: `{exc}`.',
+                            color=self.bot.main_color
+                        )
+                        await ctx.send(embed=em)
 
     @plugin.command(name='enabled', aliases=['installed'])
     @checks.has_permissions(PermissionLevel.OWNER)
     async def plugin_enabled(self, ctx):
         """Shows a list of currently enabled plugins."""
+
         if self.bot.config.plugins:
             msg = '```\n' + '\n'.join(self.bot.config.plugins) + '\n```'
-            await ctx.send(msg)
+            em = discord.Embed(
+                description=msg,
+                color=self.bot.main_color
+            )
+            await ctx.send(embed=em)
         else:
-            await ctx.send('No plugins installed.')
+            em = discord.Embed(
+                description='There are no plugins installed.',
+                color=self.bot.main_color
+            )
+            await ctx.send(embed=em)
 
     @plugin.group(invoke_without_command=True, name='registry', aliases=['list'])
     @checks.has_permissions(PermissionLevel.OWNER)
-    async def plugin_registry(self, ctx, *, plugin_name:str=None):
+    async def plugin_registry(self, ctx, *, plugin_name: str = None):
         """Shows a list of all approved plugins."""
 
         await self.populate_registry()
@@ -293,13 +367,15 @@ def find_index(name):
             index = find_index(plugin_name)
         elif plugin_name is not None:
             em = discord.Embed(
-                    color=discord.Color.red(), 
-                    description=f'Could not find a plugin with name "{plugin_name}" within the registry.'
-                    )
+                color=discord.Color.red(),
+                description=f'Could not find a plugin with name "{plugin_name}" within the registry.'
+            )
 
             matches = get_close_matches(plugin_name, self.registry.keys())
+
             if matches:
                 em.add_field(name='Perhaps you meant', value='\n'.join(f'`{m}`' for m in matches))
+
             return await ctx.send(embed=em)
 
         for name, info in registry:
@@ -312,11 +388,11 @@ def find_index(name):
                 url=repo,
                 title=info['repository']
                 )
-            
+
             em.add_field(
-                name='Installation', 
+                name='Installation',
                 value=f'```{self.bot.prefix}plugins add {name}```')
-            
+
             em.set_author(name=info['title'], icon_url=info.get('icon_url'), url=url)
             if info.get('thumbnail_url'):
                 em.set_thumbnail(url=info.get('thumbnail_url'))
@@ -351,12 +427,12 @@ async def plugin_registry_compact(self, ctx):
                 pages.append(fmt+'\n')
             else:
                 pages[-1] += fmt + '\n'
-        
+
         embeds = []
 
         for page in pages:
             em = discord.Embed(
-                color=self.bot.main_color, 
+                color=self.bot.main_color,
                 description=page,
                 )
             em.set_author(name='Plugin Registry', icon_url=self.bot.user.avatar_url)
@@ -366,9 +442,5 @@ async def plugin_registry_compact(self, ctx):
         await paginator.run()
 
 
-
-
-
-
 def setup(bot):
     bot.add_cog(Plugins(bot))