Merge pull request #2972 from kyb3r/local-plugins

Local plugins

Author: Taaku18

.dockerignore

@@ -133,6 +133,7 @@ node_modules/
 config.json
 plugins/
 !plugins/registry.json
+!plugins/@local/
 temp/
 test.py
 

.gitignore

@@ -130,9 +130,10 @@ package-lock.json
 node_modules/
 
 # Modmail
-config.json
-plugins/
+plugins/*
 !plugins/registry.json
+!plugins/@local
+config.json
 temp/
 test.py
 stack.yml

CHANGELOG.md

@@ -6,6 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 This project mostly adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html);
 however, insignificant breaking changes do not guarantee a major version bump, see the reasoning [here](https://github.com/kyb3r/modmail/issues/319). If you're a plugin developer, note the "BREAKING" section.
 
+
+# v3.8.6
+
+### Added
+
+- Ability to install local plugins without relying on git / external sources
+  - Simply add your extension to plugins/@local, and use `?plugin add local/plugin-name` to load the plugin as normal
+- Updated deps for requirements.min.txt and pyproject.toml
+
 # v3.8.5
 
 ### Added

bot.py

@@ -1,4 +1,4 @@
-__version__ = "3.8.5"
+__version__ = "3.8.6"
 
 
 import asyncio

cogs/plugins.py

@@ -31,16 +31,28 @@ class InvalidPluginError(commands.BadArgument):
 
 
 class Plugin:
-    def __init__(self, user, repo, name, branch=None):
-        self.user = user
-        self.repo = repo
-        self.name = name
-        self.branch = branch if branch is not None else "master"
-        self.url = f"https://github.com/{user}/{repo}/archive/{self.branch}.zip"
-        self.link = f"https://github.com/{user}/{repo}/tree/{self.branch}/{name}"
+    def __init__(self, user, repo=None, name=None, branch=None):
+        if repo is None:
+            self.user = "@local"
+            self.repo = "@local"
+            self.name = user
+            self.local = True
+            self.branch = "@local"
+            self.url = f"@local/{user}"
+            self.link = f"@local/{user}"
+        else:
+            self.user = user
+            self.repo = repo
+            self.name = name
+            self.local = False
+            self.branch = branch if branch is not None else "master"
+            self.url = f"https://github.com/{user}/{repo}/archive/{self.branch}.zip"
+            self.link = f"https://github.com/{user}/{repo}/tree/{self.branch}/{name}"
 
     @property
     def path(self):
+        if self.local:
+            return PurePath("plugins") / "@local" / self.name
         return PurePath("plugins") / self.user / self.repo / f"{self.name}-{self.branch}"
 
     @property
@@ -49,6 +61,8 @@ def abs_path(self):
 
     @property
     def cache_path(self):
+        if self.local:
+            raise ValueError("No cache path for local plugins!")
         return (
             Path(__file__).absolute().parent.parent
             / "temp"
@@ -58,20 +72,27 @@ def cache_path(self):
 
     @property
     def ext_string(self):
+        if self.local:
+            return f"plugins.@local.{self.name}.{self.name}"
         return f"plugins.{self.user}.{self.repo}.{self.name}-{self.branch}.{self.name}"
 
     def __str__(self):
+        if self.local:
+            return f"@local/{self.name}"
         return f"{self.user}/{self.repo}/{self.name}@{self.branch}"
 
     def __lt__(self, other):
         return self.name.lower() < other.name.lower()
 
     @classmethod
     def from_string(cls, s, strict=False):
-        if not strict:
-            m = match(r"^(.+?)/(.+?)/(.+?)(?:@(.+?))?$", s)
-        else:
-            m = match(r"^(.+?)/(.+?)/(.+?)@(.+?)$", s)
+        m = match(r"^@?local/(.+)$", s)
+        if m is None:
+            if not strict:
+                m = match(r"^(.+?)/(.+?)/(.+?)(?:@(.+?))?$", s)
+            else:
+                m = match(r"^(.+?)/(.+?)/(.+?)@(.+?)$", s)
+
         if m is not None:
             return Plugin(*m.groups())
         raise InvalidPluginError("Cannot decipher %s.", s)  # pylint: disable=raising-format-tuple
@@ -152,9 +173,12 @@ async def initial_load_plugins(self):
         await self.bot.config.update()
 
     async def download_plugin(self, plugin, force=False):
-        if plugin.abs_path.exists() and not force:
+        if plugin.abs_path.exists() and (not force or plugin.local):
             return
 
+        if plugin.local:
+            raise InvalidPluginError(f"Local plugin {plugin} not found!")
+
         plugin.abs_path.mkdir(parents=True, exist_ok=True)
 
         if plugin.cache_path.exists() and not force:
@@ -290,7 +314,7 @@ async def parse_user_input(self, ctx, plugin_name, check_version=False):
                 embed = discord.Embed(
                     description="Invalid plugin name, double check the plugin name "
                     "or use one of the following formats: "
-                    "username/repo/plugin, username/repo/plugin@branch.",
+                    "username/repo/plugin-name, username/repo/plugin-name@branch, local/plugin-name.",
                     color=self.bot.error_color,
                 )
                 await ctx.send(embed=embed)
@@ -314,7 +338,8 @@ async def plugins_add(self, ctx, *, plugin_name: str):
         Install a new plugin for the bot.
 
         `plugin_name` can be the name of the plugin found in `{prefix}plugin registry`,
-        or a direct reference to a GitHub hosted plugin (in the format `user/repo/name[@branch]`).
+        or a direct reference to a GitHub hosted plugin (in the format `user/repo/name[@branch]`)
+        or `local/name` for local plugins.
         """
 
         plugin = await self.parse_user_input(ctx, plugin_name, check_version=True)
@@ -335,10 +360,16 @@ async def plugins_add(self, ctx, *, plugin_name: str):
             )
             return await ctx.send(embed=embed)
 
-        embed = discord.Embed(
-            description=f"Starting to download plugin from {plugin.link}...",
-            color=self.bot.main_color,
-        )
+        if plugin.local:
+            embed = discord.Embed(
+                description=f"Starting to load local plugin from {plugin.link}...",
+                color=self.bot.main_color,
+            )
+        else:
+            embed = discord.Embed(
+                description=f"Starting to download plugin from {plugin.link}...",
+                color=self.bot.main_color,
+            )
         msg = await ctx.send(embed=embed)
 
         try:
@@ -395,7 +426,7 @@ async def plugins_remove(self, ctx, *, plugin_name: str):
         Remove an installed plugin of the bot.
 
         `plugin_name` can be the name of the plugin found in `{prefix}plugin registry`, or a direct reference
-        to a GitHub hosted plugin (in the format `user/repo/name[@branch]`).
+        to a GitHub hosted plugin (in the format `user/repo/name[@branch]`) or `local/name` for local plugins.
         """
         plugin = await self.parse_user_input(ctx, plugin_name)
         if plugin is None:
@@ -416,17 +447,18 @@ async def plugins_remove(self, ctx, *, plugin_name: str):
 
         self.bot.config["plugins"].remove(str(plugin))
         await self.bot.config.update()
-        shutil.rmtree(
-            plugin.abs_path,
-            onerror=lambda *args: logger.warning(
-                "Failed to remove plugin files %s: %s", plugin, str(args[2])
-            ),
-        )
-        try:
-            plugin.abs_path.parent.rmdir()
-            plugin.abs_path.parent.parent.rmdir()
-        except OSError:
-            pass  # dir not empty
+        if not plugin.local:
+            shutil.rmtree(
+                plugin.abs_path,
+                onerror=lambda *args: logger.warning(
+                    "Failed to remove plugin files %s: %s", plugin, str(args[2])
+                ),
+            )
+            try:
+                plugin.abs_path.parent.rmdir()
+                plugin.abs_path.parent.parent.rmdir()
+            except OSError:
+                pass  # dir not empty
 
         embed = discord.Embed(
             description="The plugin is successfully uninstalled.", color=self.bot.main_color
@@ -477,7 +509,7 @@ async def plugins_update(self, ctx, *, plugin_name: str = None):
         Update a plugin for the bot.
 
         `plugin_name` can be the name of the plugin found in `{prefix}plugin registry`, or a direct reference
-        to a GitHub hosted plugin (in the format `user/repo/name[@branch]`).
+        to a GitHub hosted plugin (in the format `user/repo/name[@branch]`) or `local/name` for local plugins.
 
         To update all plugins, do `{prefix}plugins update`.
         """
@@ -514,7 +546,7 @@ async def plugins_reset(self, ctx):
             shutil.rmtree(cache_path)
 
         for entry in os.scandir(Path(__file__).absolute().parent.parent / "plugins"):
-            if entry.is_dir():
+            if entry.is_dir() and entry.name != "@local":
                 shutil.rmtree(entry.path)
                 logger.warning("Removing %s.", entry.name)
 

plugins/@local/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

pyproject.toml

@@ -21,7 +21,7 @@ exclude = '''
 
 [tool.poetry]
 name = 'Modmail'
-version = '3.6.0'
+version = '3.8.6'
 description = "Modmail is similar to Reddit's Modmail, both in functionality and purpose. It serves as a shared inbox for server staff to communicate with their users in a seamless way."
 license = 'AGPL-3.0-only'
 authors = [
@@ -36,7 +36,7 @@ keywords = ['discord', 'modmail']
 
 [tool.poetry.dependencies]
 python = "^3.7"
-"discord.py" = "./discord.py-1.5.2.tar.gz"
+"discord.py" = "discord.py==1.6.0"
 uvloop = {version = ">=0.12.0", markers = "sys_platform != 'win32'"}
 python-dotenv = ">=0.10.3"
 parsedatetime = "^2.6"

requirements.min.txt

@@ -1,24 +1,16 @@
-# Generated as of June, 2020
+# Generated as of March, 2021
 # This is the bare minimum requirements.txt for running Modmail.
 # To install requirements.txt run: pip install -r requirements.min.txt
 
 aiohttp==3.6.2
-async-timeout==3.0.1
-attrs==19.3.0
-chardet==3.0.4
-./discord.py-1.5.2.tar.gz
+discord.py==1.6.0
 dnspython==1.16.0
 emoji==0.5.4
-future==0.18.2
-idna==2.9
 isodate==0.6.0
 motor==2.1.0
-multidict==4.7.6
 natural==0.2.0
 parsedatetime==2.6
 pymongo==3.10.1
 python-dateutil==2.8.1
 python-dotenv==0.14.0
-six==1.15.0
-websockets==8.1
-yarl==1.4.2
+websockets==8.1