Support branches in plugin add.

Author: fourjr

CHANGELOG.md

@@ -4,6 +4,12 @@ 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.23.1
+
+### Added
+
+Branch support for `plugin add` and in registry. Typically for developers.    
+
 # v2.23.0
 
 ### Added 

bot.py

@@ -25,7 +25,7 @@
 SOFTWARE.
 """
 
-__version__ = "2.23.0"
+__version__ = "2.23.1"
 
 import asyncio
 import logging
@@ -386,6 +386,7 @@ async def on_ready(self):
         logger.info(info("Client ready."))
         logger.info(LINE)
         logger.info(info(f"Logged in as: {self.user}"))
+        logger.info(info(f"Prefix: {self.prefix}"))
         logger.info(info(f"User ID: {self.user.id}"))
         logger.info(info(f"Guild ID: {self.guild.id if self.guild else 0}"))
         logger.info(LINE)
@@ -983,6 +984,9 @@ async def autoupdate_loop(self):
 
     async def metadata_loop(self):
         await self.wait_until_ready()
+        if not self.guild:
+            return
+
         owner = (await self.application_info()).owner
 
         while not self.is_closed():

cogs/plugins.py

@@ -1,3 +1,4 @@
+import asyncio
 import importlib
 import json
 import logging
@@ -13,13 +14,12 @@
 import discord
 from discord.ext import commands
 from discord.utils import async_all
-
 from pkg_resources import parse_version
 
 from core import checks
 from core.models import PermissionLevel
 from core.paginator import PaginatorSession
-from core.utils import info, error
+from core.utils import error, info
 
 logger = logging.getLogger("Modmail")
 
@@ -55,10 +55,20 @@ def _asubprocess_run(cmd):
 
     @staticmethod
     def parse_plugin(name):
-        # returns: (username, repo, plugin_name)
+        # returns: (username, repo, plugin_name, branch)
+        # default branch = master
         try:
             result = name.split("/")
             result[2] = "/".join(result[2:])
+            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])
+            else:
+                result.append('master')
+
         except IndexError:
             return None
 
@@ -68,18 +78,18 @@ async def download_initial_plugins(self):
         await self.bot._connected.wait()
 
         for i in self.bot.config.plugins:
-            parsed_plugin = self.parse_plugin(i)
+            username, repo, name, branch = self.parse_plugin(i)
 
             try:
-                await self.download_plugin_repo(*parsed_plugin[:-1])
+                await self.download_plugin_repo(username, repo, branch)
             except DownloadError as exc:
-                msg = f"{parsed_plugin[0]}/{parsed_plugin[1]} - {exc}"
+                msg = f"{username}/{repo}@{branch} - {exc}"
                 logger.error(error(msg))
             else:
                 try:
-                    await self.load_plugin(*parsed_plugin)
+                    await self.load_plugin(username, repo, name, branch)
                 except DownloadError as exc:
-                    msg = f"{parsed_plugin[0]}/{parsed_plugin[1]} - {exc}"
+                    msg = f"{username}/{repo}@{branch}[{name}] - {exc}"
                     logger.error(error(msg))
 
         await async_all(
@@ -88,10 +98,11 @@ async def download_initial_plugins(self):
 
         logger.debug(info("on_plugin_ready called."))
 
-    async def download_plugin_repo(self, username, repo):
+    async def download_plugin_repo(self, username, repo, branch):
         try:
-            cmd = f"git clone https://github.com/{username}/{repo} "
-            cmd += f"plugins/{username}-{repo} -q"
+            cmd  = f"git clone https://github.com/{username}/{repo} "
+            cmd += f"plugins/{username}-{repo}-{branch} "
+            cmd += f"-b {branch} -q"
 
             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
@@ -100,11 +111,13 @@ async def download_plugin_repo(self, username, repo):
 
             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
+                msg = f'Download Error: {username}/{repo}@{branch}'
+                logger.error(msg)
+                raise DownloadError(err) 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}"
+    async def load_plugin(self, username, repo, plugin_name, branch):
+        ext = f"plugins.{username}-{repo}-{branch}.{plugin_name}.{plugin_name}"
+        dirname = f"plugins/{username}-{repo}-{branch}/{plugin_name}"
 
         if "requirements.txt" in os.listdir(dirname):
             # Install PIP requirements
@@ -113,7 +126,7 @@ async def load_plugin(self, username, repo, plugin_name):
                     await self.bot.loop.run_in_executor(
                         None,
                         self._asubprocess_run,
-                        f"pip install -r {dirname}/requirements.txt -q -q",
+                        f"pip install -r {dirname}/requirements.txt --user -q -q",
                     )
                 else:
                     await self.bot.loop.run_in_executor(
@@ -128,24 +141,26 @@ async def load_plugin(self, username, repo, plugin_name):
                 err = exc.stderr.decode("utf8").strip()
 
                 if err:
+                    msg = f'Requirements Download Error: {username}/{repo}@{branch}[{plugin_name}]'
+                    logger.error(error(msg))
                     raise DownloadError(
-                        f"Unable to download requirements: ```\n{error}\n```"
+                        f"Unable to download requirements: ```\n{err}\n```"
                     ) from exc
             else:
                 if not os.path.exists(site.USER_SITE):
                     os.makedirs(site.USER_SITE)
 
                 sys.path.insert(0, site.USER_SITE)
 
+        await asyncio.sleep(0.5)
         try:
             self.bot.load_extension(ext)
         except commands.ExtensionError as exc:
-            # TODO: Add better error handling for plugin load faliure
-            import traceback
-            traceback.print_exc()
+            msg = f'Plugin Load Failure: {username}/{repo}@{branch}[{plugin_name}]'
+            logger.error(error(msg))
             raise DownloadError("Invalid plugin") from exc
         else:
-            msg = f"Loaded plugins.{username}-{repo}.{plugin_name}"
+            msg = f"Loaded Plugin: {username}/{repo}@{branch}[{plugin_name}]"
             logger.info(info(msg))
 
     @commands.group(aliases=["plugins"], invoke_without_command=True)
@@ -162,7 +177,7 @@ async def plugin_add(self, ctx, *, plugin_name: str):
 
         if plugin_name in self.registry:
             details = self.registry[plugin_name]
-            plugin_name = details["repository"] + "/" + plugin_name
+            plugin_name = details["repository"] + "/" + plugin_name + "@" + details["branch"]
             required_version = details["bot_version"]
 
             if parse_version(self.bot.version) < parse_version(required_version):
@@ -194,24 +209,24 @@ async def plugin_add(self, ctx, *, plugin_name: str):
 
         async with ctx.typing():
             if len(plugin_name.split("/")) >= 3:
-                parsed_plugin = self.parse_plugin(plugin_name)
+                username, repo, name, branch = self.parse_plugin(plugin_name)
 
                 try:
-                    await self.download_plugin_repo(*parsed_plugin[:-1])
+                    await self.download_plugin_repo(username, repo, branch)
                 except DownloadError as exc:
                     embed = discord.Embed(
-                        description=f"Unable to fetch this plugin from Github: {exc}.",
+                        description=f"Unable to fetch this plugin from Github: `{exc}`.",
                         color=self.bot.main_color,
                     )
                     return await ctx.send(embed=embed)
 
                 importlib.invalidate_caches()
 
                 try:
-                    await self.load_plugin(*parsed_plugin)
+                    await self.load_plugin(username, repo, name, branch)
                 except Exception as exc:
                     embed = discord.Embed(
-                        description=f"Unable to load this plugin: {exc}.",
+                        description=f"Unable to load this plugin: `{exc}`.",
                         color=self.bot.main_color,
                     )
                     return await ctx.send(embed=embed)
@@ -224,7 +239,7 @@ async def plugin_add(self, ctx, *, plugin_name: str):
 
                 embed = discord.Embed(
                     description="The plugin is installed.\n"
-                    "*Please note: any plugin that you install is at your OWN RISK*",
+                    "*Please note: Any plugin that you install is at your **own risk***",
                     color=self.bot.main_color,
                 )
                 await ctx.send(embed=embed)
@@ -242,13 +257,13 @@ async def plugin_remove(self, ctx, *, plugin_name: str):
 
         if plugin_name in self.registry:
             details = self.registry[plugin_name]
-            plugin_name = details["repository"] + "/" + plugin_name
+            plugin_name = details["repository"] + "/" + plugin_name + "@" + details["branch"]
 
         if plugin_name in self.bot.config.plugins:
             try:
-                username, repo, name = self.parse_plugin(plugin_name)
+                username, repo, name, branch = self.parse_plugin(plugin_name)
 
-                self.bot.unload_extension(f"plugins.{username}-{repo}.{name}.{name}")
+                self.bot.unload_extension(f"plugins.{username}-{repo}-{branch}.{name}.{name}")
             except Exception:
                 pass
 
@@ -266,10 +281,11 @@ 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}-{branch}", onerror=onerror)
             except Exception as exc:
                 logger.error(str(exc))
                 self.bot.config.plugins.append(plugin_name)
+                logger.error(error(exc))
                 raise exc
 
             await self.bot.config.update()
@@ -292,7 +308,7 @@ async def plugin_update(self, ctx, *, plugin_name: str):
 
         if plugin_name in self.registry:
             details = self.registry[plugin_name]
-            plugin_name = details["repository"] + "/" + plugin_name
+            plugin_name = details["repository"] + "/" + plugin_name + "@" + details["branch"]
 
         if plugin_name not in self.bot.config.plugins:
             embed = discord.Embed(
@@ -301,10 +317,10 @@ async def plugin_update(self, ctx, *, plugin_name: str):
             return await ctx.send(embed=embed)
 
         async with ctx.typing():
-            username, repo, name = self.parse_plugin(plugin_name)
+            username, repo, name, branch = self.parse_plugin(plugin_name)
 
             try:
-                cmd = f"cd plugins/{username}-{repo} && git reset --hard origin/master && git fetch --all && git pull"
+                cmd = f"cd plugins/{username}-{repo}-{branch} && git reset --hard origin/master && git fetch --all && git pull"
                 cmd = await self.bot.loop.run_in_executor(
                     None, self._asubprocess_run, cmd
                 )
@@ -327,11 +343,11 @@ async def plugin_update(self, ctx, *, plugin_name: str):
 
                 if output != "Already up to date.":
                     # repo was updated locally, now perform the cog reload
-                    ext = f"plugins.{username}-{repo}.{name}.{name}"
+                    ext = f"plugins.{username}-{repo}-{branch}.{name}.{name}"
                     self.bot.unload_extension(ext)
 
                     try:
-                        await self.load_plugin(username, repo, name)
+                        await self.load_plugin(username, repo, name, branch)
                     except DownloadError as exc:
                         em = discord.Embed(
                             description=f"Unable to start the plugin: `{exc}`.",
@@ -434,7 +450,7 @@ async def plugin_registry_compact(self, ctx):
 
         for name, details in registry:
             repo = f"https://github.com/{details['repository']}"
-            url = f"{repo}/tree/master/{name}"
+            url = f"{repo}/tree/{details['branch']}/{name}"
             desc = details["description"].replace("\n", "")
             fmt = f"[`{name}`]({url}) - {desc}"
             length = len(fmt) - len(url) - 4

plugins/fourjr-modmail-plugins-develop

@@ -0,0 +1 @@
+Subproject commit 61921e55e60ccce6a96616b3389474b2b514ca94

plugins/fourjr-modmail-plugins-master

@@ -0,0 +1 @@
+Subproject commit b3ecfd7463671f32a32e1b798143ee0689835c92

plugins/kyb3r-modmail-plugins-master

@@ -0,0 +1 @@
+Subproject commit cdddc083d328b21ad696cbd0362e5206fe4c57b3

plugins/officialpiyush-modmail-plugins-master

@@ -0,0 +1 @@
+Subproject commit a389b6cd1f550c20ec7ce0ad4ba6e5daa657971c

plugins/papiersnipper-modmail-plugins-master

@@ -0,0 +1 @@
+Subproject commit 9be8f4f910794991b6aea0573969d48c5793cd70