feat:强化插件功能，规范化包

Author: JohnRichard4096

.github/workflows/CI.yaml

@@ -26,6 +26,7 @@ jobs:
         run: |
           uv venv
           uv sync
+          uv pip install .
 
       - name: Get Python path
         run: |
@@ -40,7 +41,7 @@ jobs:
         run: |
           source ./.venv/bin/activate
           echo "DATABASE_URL=aiosqlite+:///db.sqlite3" > .env
-          uv run nb orm upgrade
+          uv run amrita orm upgrade
       - name: Run Load Test
         run: |
           echo "ADMIN_GROUP=1" >> .env

.github/workflows/PR.yaml

@@ -25,6 +25,7 @@ jobs:
         run: |
           uv venv
           uv sync
+          uv pip install .
 
       - name: Get Python path
         run: |
@@ -40,7 +41,7 @@ jobs:
         run: |
           source ./.venv/bin/activate
           echo "DATABASE_URL=aiosqlite+:///db.sqlite3" > .env
-          uv run nb orm upgrade
+          uv run amrita orm upgrade
       - name: Run Load Test
         run: |
           echo "ADMIN_GROUP=1" >> .env

.gitignore

@@ -178,3 +178,10 @@ pyrightconfig.json
 # DOTENV
 .env.prod
 .env.dev
+
+# Amrita
+config/
+data/
+logs/
+tmp/
+cache/

=0.6.0

@@ -14,13 +14,45 @@ Amrita的命令执行插件
 uv add amrita-plugin-exec
 ```
 
-或者使用pip安装：
+或者使用amrita-cli安装：
 
 ```bash
-pip install amrita-plugin-exec
+amrita plugin install amrita-plugin-exec
+```
+
+## 配置
+
+插件提供了以下配置选项，可以在 .env 或环境变量中进行配置：
+
+```dotenv
+ENABLE_DOCKER=false
+# 是否启用Docker下的指令执行，默认为 False
+
+PLUGIN_EXEC_IMAGE_NAME=alpine:latest
+# 要使用的Docker镜像名称，默认为 "alpine:latest"
+
+PLUGIN_EXEC_DOCKER_HOST=unix://var/run/docker.sock
+# Docker守护进程的地址，默认为 "unix://var/run/docker.sock"
+
+PLUGIN_EXEC_SHELL_NAME=sh
+# 在容器中执行命令时使用的shell名称，默认为 "sh"
+
+AUTO_REBUILD_CONTAINER=true
+# 是否在运行完成后自动重建容器，默认为 true
 ```
 
 ## 使用方法
 
 在Amrita机器人中，授权用户可以使用以下命令：
-- `/exec <command>`：执行指定的服务器命令。
+- `/exec <command>`：执行指定的服务器命令。
+
+## 权限节点
+
+插件添加了以下权限节点：
+
+- `amrita.exec.full`：允许用户执行宿主命令。
+- `amrita.exec.safe`：允许用户容器内执行命令。
+
+## TODO
+
+- [ ]  包装为Amrita的Tool

README.md

@@ -11,5 +11,4 @@
     type="application",
 )
 
-__all__ = ["container_exec","main"]
-
+__all__ = ["container_exec", "main"]

src/amrita/plugins/exec/__init__.py amrita_plugin_exec/__init__.pysrc/amrita/plugins/exec/__init__.py renamed to amrita_plugin_exec/__init__.py

@@ -0,0 +1,13 @@
+from nonebot import get_plugin_config
+from pydantic import BaseModel
+
+
+class Config(BaseModel):
+    enable_docker: bool = False
+    image_name: str = "alpine:latest"
+    docker_host: str = "unix://var/run/docker.sock"
+    shell_name: str = "sh"
+    auto_rebuild_container: bool = True
+
+
+CONFIG = get_plugin_config(Config)

amrita_plugin_exec/config.py

@@ -1,28 +1,33 @@
+import asyncio
+
 import docker
 from docker.errors import DockerException, ImageNotFound
 from nonebot import logger
 
+from .config import CONFIG
+
 
 async def pull_image(image_name: str):
     try:
-        client = docker.from_env()
+        client: docker.DockerClient = docker.DockerClient(base_url=CONFIG.docker_host)
         client.images.pull(image_name)
         return True
     except DockerException as e:
-        print(f"Failed to pull image: {e}")
+        logger.opt(exception=e, colors=True).exception(f"Failed to pull image: {e}")
         return False
 
+
 async def execute_in_docker(*cmd_parts):
     image_name = "alpine:latest"
     try:
-        client = docker.from_env()
+        client = docker.DockerClient(base_url=CONFIG.docker_host)
         # 将命令部分组合成完整的命令字符串
         cmd_text = " ".join(cmd_parts)
         container = client.containers.run(
             image_name,
-            f"sh -c '{cmd_text}'",
+            f"{CONFIG.shell_name} -c '{cmd_text}'",
             detach=True,
-            remove=False,
+            remove=CONFIG.auto_rebuild_container,
             network_mode="none",
             mem_limit="128m",
             cpu_period=100000,
@@ -33,19 +38,26 @@ async def execute_in_docker(*cmd_parts):
         )
 
         try:
-            result = container.wait(timeout=10)
+            result = await asyncio.to_thread(
+                lambda: container.wait(timeout=10),
+            )
             logs = container.logs().decode("utf-8")
             exit_code = result.get("StatusCode", 0)
-            container.remove(force=True)
+
             return logs, exit_code
         except DockerException as e:
-            print(f"Failed to get container logs: {e}")
-            container.remove(force=True)
+            logger.opt(exception=e, colors=True).exception(
+                f"Failed to get container logs: {e}"
+            )
+
             return "", 1
+        finally:
+            if CONFIG.auto_rebuild_container:
+                container.remove(force=True)
     except ImageNotFound:
         logger.warning(f"Image {image_name} not found. Pulling...")
         await pull_image(image_name)
         return await execute_in_docker(*cmd_parts)
     except DockerException as e:
         logger.error(f"Failed to run container: {e}")
-        return f"Docker执行失败: {e}", 1
+        return f"Docker执行失败: {e}", 1

src/amrita/plugins/exec/container_exec.py amrita_plugin_exec/container_exec.pysrc/amrita/plugins/exec/container_exec.py renamed to amrita_plugin_exec/container_exec.py

@@ -2,32 +2,46 @@
 import shlex
 import subprocess
 
+from amrita.plugins.menu.models import MatcherData
+from amrita.plugins.perm.API.rules import UserPermissionChecker
+from amrita.utils.send import send_forward_msg
 from nonebot import on_command
 from nonebot.adapters.onebot.v11 import Bot, Message, MessageEvent, MessageSegment
 from nonebot.exception import FinishedException
 from nonebot.params import CommandArg
+from nonebot.permission import Permission
 
-from amrita.plugins.menu.models import MatcherData
-from amrita.plugins.perm.API.rules import UserPermissionChecker
-from amrita.utils.send import send_forward_msg
 from . import container_exec
+from .config import CONFIG
 
 docker_check = UserPermissionChecker(permission="admin.exec.safe")
 host_check = UserPermissionChecker(permission="admin.exec.full")
 permission = host_check.checker()
 permission_docker = docker_check.checker()
 
-execute_in_docker = on_command("exec",
-                     state=MatcherData(name="执行命令(docker)", usage="/exec <command>", description="在docker执行命令").model_dump(),
-                     priority=1,
-                     block=True,
-                     rule=permission_docker or permission)
+execute_in_docker = on_command(
+    "exec",
+    state=MatcherData(
+        name="执行命令(docker)", usage="/exec <command>", description="在docker执行命令"
+    ).model_dump(),
+    priority=1,
+    block=True,
+    permission=Permission(permission_docker, permission),
+    rule=lambda: CONFIG.enable_docker,
+)
+
+execute = on_command(
+    "exec.host",
+    state=MatcherData(
+        name="执行命令(host)",
+        usage="/exec.host <command>",
+        description="在宿主机执行命令",
+    ).model_dump(),
+    priority=1,
+    block=True,
+    rule=permission,
+)
 
-execute = on_command("exec.host",
-                     state=MatcherData(name="执行命令(host)", usage="/exec.host <command>", description="在宿主机执行命令").model_dump(),
-                     priority=1,
-                     block=True,
-                     rule=permission)
 
 @execute.handle()
 async def _(event: MessageEvent, bot: Bot, args: Message = CommandArg()):
@@ -41,20 +55,27 @@ async def _(event: MessageEvent, bot: Bot, args: Message = CommandArg()):
             *cmd_parts, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=False
         )
         try:
-            stdout, stderr = await asyncio.wait_for(execute_result.communicate(), timeout=10)
+            stdout, stderr = await asyncio.wait_for(
+                execute_result.communicate(), timeout=10
+            )
         except asyncio.TimeoutError:
             execute_result.kill()
             await execute.finish("执行超时")
         results = [
             MessageSegment.text(f"执行结果：{stdout.decode('utf-8')}"),
-            MessageSegment.text(f"执行失败：{stderr.decode('utf-8')}") if stderr else None
+            MessageSegment.text(f"执行失败：{stderr.decode('utf-8')}")
+            if stderr
+            else None,
         ]
-        await send_forward_msg(bot, event, name="执行结果", uin=bot.self_id, msgs=results)
+        await send_forward_msg(
+            bot, event, name="执行结果", uin=bot.self_id, msgs=results
+        )
     except FinishedException:
         pass
     except Exception as e:
         await bot.send(event, f"执行失败：{e}")
 
+
 @execute_in_docker.handle()
 async def _(event: MessageEvent, bot: Bot, args: Message = CommandArg()):
     try:
@@ -63,14 +84,12 @@ async def _(event: MessageEvent, bot: Bot, args: Message = CommandArg()):
             await execute_in_docker.finish("请输入要执行的命令")
         cmd_parts = shlex.split(cmd_text)
 
-        logs, exit_code = await container_exec.execute_in_docker(
-            *cmd_parts
-            )
-        results = [
-            MessageSegment.text(f"exit_code: {exit_code}\n执行结果：{logs}")
-        ]
-        await send_forward_msg(bot, event, name="执行结果", uin=bot.self_id, msgs=results)
+        logs, exit_code = await container_exec.execute_in_docker(*cmd_parts)
+        results = [MessageSegment.text(f"exit_code: {exit_code}\n执行结果：{logs}")]
+        await send_forward_msg(
+            bot, event, name="执行结果", uin=bot.self_id, msgs=results
+        )
     except FinishedException:
         pass
     except Exception as e:
-        await bot.send(event, f"执行失败：{e}")
+        await bot.send(event, f"执行失败：{e}")

src/amrita/plugins/exec/main.py amrita_plugin_exec/main.pysrc/amrita/plugins/exec/main.py renamed to amrita_plugin_exec/main.py

@@ -1,24 +1,25 @@
 [project]
 name = "amrita-plugin-exec"
-description = ""
-version = "0.1.1"
+description = "Command execution plugin for Amrita"
+version = "0.1.2"
 dependencies = [
     "amrita[full]>=0.4.2",
-    "docker>=6.0.0"
+    "docker>=6.0.0",
 ]
 readme = "README.md"
 requires-python = ">=3.10, <3.14"
 
 [tool.nonebot]
 plugins = [
     "nonebot_plugin_orm",
-    "amrita.plugins.exec",
 ]
 plugin_dirs = []
 
+[tool.amrita]
+plugins=["amrita_plugin_exec"]  # 修改插件名称，使用下划线格式
+
 [tool.setuptools.packages.find]
-where = ["src"]
-include = ["amrita*"]
+include = ["amrita-plugin-*"]
 
 [[tool.nonebot.adapters]]
 name = "OneBot V11"
@@ -60,4 +61,4 @@ ignore = [
 ]
 
 [tool.pyright]
-typeCheckingMode = "standard"
+typeCheckingMode = "standard"