gardel/Mofox-Core
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor(plugin): 优化插件配置加载与同步机制

Browse Source 
- 移除全局插件配置开关 `plugins.centralized_config`。
- 简化 `PluginBase` 的配置加载逻辑，不再使用模板文件，而是直接在中央配置目录生成默认配置。
- 在 `PluginManager` 中增加配置同步逻辑，在加载插件时，实现插件目录与中央配置目录之间的双向同步，确保配置一致性。
- 更新 `bot_config_template.toml`，移除已废弃的 `[plugins]` 配置项并提升版本号。
This commit is contained in:
minecraft1024a
2025-08-30 11:21:26 +08:00
parent c6a0522316
commit 7cb5c3844e
5 changed files with 59 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/plugin_system/base/plugin_base.py
View File

@@ -458,54 +458,35 @@ class PluginBase(ABC):
加载插件配置文件，实现集中化管理和自动迁移。
处理逻辑:
1. 确定插件模板配置文件路径（位于插件目录内）。
2. 如果模板不存在，则在插件目录内生成一份默认配置。
3. 确定用户配置文件路径（位于 `config/plugins/` 目录下）。
4. 如果用户配置文件不存在，则从插件目录复制模板文件过去。
5. 加载用户配置文件，并进行版本检查和自动迁移（如果需要）。
6. 最终加载的配置是用户配置文件。
1. 确定用户配置文件路径（位于 `config/plugins/` 目录下）。
2. 如果用户配置文件不存在，则根据 config_schema 直接在中央目录生成一份。
3. 加载用户配置文件，并进行版本检查和自动迁移（如果需要）。
4. 最终加载的配置是用户配置文件。
"""
if not self.config_file_name:
logger.debug(f"{self.log_prefix} 未指定配置文件，跳过加载")
return
# 1. 确定插件模板配置文件路径
template_config_path = os.path.join(self.plugin_dir, self.config_file_name)
# 1. 确定并确保用户配置文件路径存在
user_config_path = os.path.join(CONFIG_DIR, "plugins", self.plugin_name, self.config_file_name)
os.makedirs(os.path.dirname(user_config_path), exist_ok=True)
# 2. 如果模板不存在，则在插件目录内生成
if not os.path.exists(template_config_path):
logger.info(f"{self.log_prefix} 插件目录缺少配置文件 {template_config_path}，将生成默认配置。")
self._generate_and_save_default_config(template_config_path)
# 3. 确定用户配置文件路径
plugin_config_dir = os.path.join(CONFIG_DIR, "plugins", self.plugin_name)
user_config_path = os.path.join(plugin_config_dir, self.config_file_name)
# 确保用户插件配置目录存在
os.makedirs(plugin_config_dir, exist_ok=True)
# 4. 如果用户配置文件不存在，从模板复制
# 2. 如果用户配置文件不存在，直接在中央目录生成
if not os.path.exists(user_config_path):
try:
shutil.copy2(template_config_path, user_config_path)
logger.info(f"{self.log_prefix} 已从模板创建用户配置文件: {user_config_path}")
except IOError as e:
logger.error(f"{self.log_prefix} 复制配置文件失败: {e}", exc_info=True)
# 如果复制失败，后续将无法加载，直接返回
return
logger.info(f"{self.log_prefix} 用户配置文件 {user_config_path} 不存在，将生成默认配置。")
self._generate_and_save_default_config(user_config_path)
# 检查最终的用户配置文件是否存在
if not os.path.exists(user_config_path):
logger.warning(f"{self.log_prefix} 用户配置文件 {user_config_path} 不存在且无法创建。")
return
# 5. 加载、检查和迁移用户配置文件
# 3. 加载、检查和迁移用户配置文件
_, file_ext = os.path.splitext(self.config_file_name)
if file_ext.lower() != ".toml":
logger.warning(f"{self.log_prefix} 不支持的配置文件格式: {file_ext}，仅支持 .toml")
self.config = {}
return
try:
with open(user_config_path, "r", encoding="utf-8") as f:
existing_config = toml.load(f) or {}

47
src/plugin_system/core/plugin_manager.py
View File

@@ -1,5 +1,7 @@
import asyncio
import os
import shutil
import hashlib
import traceback
import importlib
@@ -37,6 +39,48 @@ class PluginManager:
self._ensure_plugin_directories()
logger.info("插件管理器初始化完成")
def _synchronize_plugin_config(self, plugin_name: str, plugin_dir: str):
"""
同步单个插件的配置。
"""
central_config_dir = os.path.join("config", "plugins", plugin_name)
plugin_config_dir = os.path.join(plugin_dir, "config")
# 确保中央配置目录存在
os.makedirs(central_config_dir, exist_ok=True)
# 1. 从插件目录同步到中央目录（如果中央配置不存在）
if os.path.exists(plugin_config_dir) and os.path.isdir(plugin_config_dir):
for filename in os.listdir(plugin_config_dir):
central_config_file = os.path.join(central_config_dir, filename)
plugin_config_file = os.path.join(plugin_config_dir, filename)
if not os.path.exists(central_config_file) and os.path.isfile(plugin_config_file):
shutil.copy2(plugin_config_file, central_config_file)
logger.info(f"从 {plugin_name} 复制默认配置到中央目录: {filename}")
# 2. 从中央目录同步到插件目录（覆盖）
if os.path.isdir(central_config_dir):
for filename in os.listdir(central_config_dir):
central_config_file = os.path.join(central_config_dir, filename)
plugin_config_file = os.path.join(plugin_config_dir, filename)
if not os.path.isfile(central_config_file):
continue
# 确保插件的 config 目录存在
os.makedirs(plugin_config_dir, exist_ok=True)
should_copy = True
if os.path.exists(plugin_config_file):
with open(central_config_file, 'rb') as f1, open(plugin_config_file, 'rb') as f2:
if hashlib.md5(f1.read()).hexdigest() == hashlib.md5(f2.read()).hexdigest():
should_copy = False
if should_copy:
shutil.copy2(central_config_file, plugin_config_file)
logger.info(f"同步中央配置到 {plugin_name}: {filename}")
# === 插件目录管理 ===
def add_plugin_directory(self, directory: str) -> bool:
@@ -104,6 +148,9 @@ class PluginManager:
if not plugin_dir:
return False, 1
# 同步插件配置
self._synchronize_plugin_config(plugin_name, plugin_dir)
plugin_instance = plugin_class(plugin_dir=plugin_dir) # 实例化插件（可能因为缺少manifest而失败）
if not plugin_instance:
logger.error(f"插件 {plugin_name} 实例化失败")