feat: 配置Schema以及插件支持配置

astrbot/api/platform/__init__.py

@@ -2,4 +2,5 @@ from astrbot.core.platform import (
     AstrMessageEvent, Platform, AstrBotMessage, MessageMember, MessageType, PlatformMetadata
 )
 
-from astrbot.core.platform.register import register_platform_adapter
+from astrbot.core.platform.register import register_platform_adapter
+from astrbot.core.message.components import *

astrbot/core/config/astrbot_config.py

@@ -2,7 +2,7 @@ import os
 import json
 import logging
 import enum
-from .default import DEFAULT_CONFIG
+from .default import DEFAULT_CONFIG, DEFAULT_VALUE_MAP
 from typing import Dict
 
 ASTRBOT_CONFIG_PATH = "data/cmd_config.json"
@@ -17,17 +17,24 @@ class AstrBotConfig(dict):
     
     - 初始化时会将传入的 default_config 与配置文件进行比对，如果配置文件中缺少配置项则会自动插入默认值并进行一次写入操作。会递归检查配置项。
     - 如果配置文件路径对应的文件不存在，则会自动创建并写入默认配置。
+    - 如果传入了 schema，将会通过 schema 解析出 default_config，此时传入的 default_config 会被忽略。
     '''
     
     def __init__(
         self, 
         config_path: str = ASTRBOT_CONFIG_PATH, 
-        default_config: dict = DEFAULT_CONFIG
+        default_config: dict = DEFAULT_CONFIG,
+        schema: dict = None
     ):
         super().__init__()
         
-        self.config_path = config_path
-        self.default_config = default_config
+        # 调用父类的 __setattr__ 方法，防止保存配置时将此属性写入配置文件
+        object.__setattr__(self, 'config_path', config_path)
+        object.__setattr__(self, 'default_config', default_config)
+        object.__setattr__(self, 'schema', schema)
+        
+        if schema:
+            default_config = self._config_schema_to_default_config(schema)
         
         if not self.check_exist():
             '''不存在时载入默认配置'''
@@ -47,7 +54,31 @@ class AstrBotConfig(dict):
             self.save_config()
             
         self.update(conf)
-            
+
+    def _config_schema_to_default_config(self, schema: dict) -> dict:
+        '''将 Schema 转换成 Config'''
+        conf = {}
+        
+        def _parse_schema(schema: dict, conf: dict):
+            for k, v in schema.items():
+                if v['type'] not in DEFAULT_VALUE_MAP:
+                    raise TypeError(f"不受支持的配置类型 {v['type']}。支持的类型有：{DEFAULT_VALUE_MAP.keys()}")
+                if 'default' in v:
+                    default = v['default']
+                else:
+                    default = DEFAULT_VALUE_MAP[v['type']]
+                
+                if v['type'] == 'object':
+                    conf[k] = {}
+                    _parse_schema(v['items'], conf[k])
+                else:
+                    conf[k] = default
+                    
+        _parse_schema(schema, conf)
+
+        return conf
+
+
     def check_config_integrity(self, refer_conf: Dict, conf: Dict, path=""):
         '''检查配置完整性，如果有新的配置项则返回 True'''
         has_new = False

astrbot/core/star/star.py

@@ -3,6 +3,7 @@ from __future__ import annotations
 from types import ModuleType
 from typing import List, Dict
 from dataclasses import dataclass
+from astrbot.core.config import AstrBotConfig
 
 star_registry: List[StarMetadata] = []
 star_map: Dict[str, StarMetadata] = {}
@@ -11,7 +12,7 @@ star_map: Dict[str, StarMetadata] = {}
 @dataclass
 class StarMetadata:
     '''
-    Star 的元数据。
+    插件的元数据。
     '''
     name: str
     author: str  # 插件作者
@@ -20,21 +21,24 @@ class StarMetadata:
     repo: str = None  # 插件仓库地址
 
     star_cls_type: type = None
-    '''Star 的类对象的类型'''
+    '''插件的类对象的类型'''
     module_path: str = None
-    '''Star 的模块路径'''
+    '''插件的模块路径'''
     
     star_cls: object = None
-    '''Star 的类对象'''
+    '''插件的类对象'''
     module: ModuleType = None
-    '''Star 的模块对象'''
+    '''插件的模块对象'''
     root_dir_name: str = None
-    '''Star 的根目录名'''
+    '''插件的目录名称'''
     reserved: bool = False
-    '''是否是 AstrBot 的保留 Star'''
+    '''是否是 AstrBot 的保留插件'''
     
     activated: bool = True
     '''是否被激活'''
+    
+    config: AstrBotConfig = None
+    '''插件配置'''
 
     def __str__(self) -> str:
         return f"StarMetadata({self.name}, {self.desc}, {self.version}, {self.repo})"

astrbot/core/star/star_manager.py

@@ -2,12 +2,14 @@ import inspect
 import functools
 import os
 import sys
+import json
 import traceback
 import yaml
 import logging
 from types import ModuleType
 from typing import List
 from astrbot.core.config.astrbot_config import AstrBotConfig
+from astrbot.core.config.default import DEFAULT_VALUE_MAP
 from astrbot.core import logger, sp, pip_installer
 from .context import Context
 from . import StarMetadata
@@ -26,13 +28,20 @@ class PluginManager:
         self.updator = PluginUpdator(config['plugin_repo_mirror'])
         
         self.context = context
-        self.context._star_manager = self # 就这样吧，不想改了
+        self.context._star_manager = self
                 
         self.config = config
         self.plugin_store_path = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../../data/plugins"))
+        '''存储插件的路径。即 data/plugins'''
+        self.plugin_config_path = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../../data/config"))
+        '''存储插件配置的路径。data/config'''
         self.reserved_plugin_path = os.path.abspath(os.path.join(os.path.dirname(os.path.abspath(__file__)), "../../../packages"))
+        '''保留插件的路径。在 packages 目录下'''
+        self.conf_schema_fname = "_conf_schema.json"
+        '''插件配置 Schema 文件名'''
 
     def _get_classes(self, arg: ModuleType):
+        '''获取指定模块（可以理解为一个 python 文件）下所有的类'''
         classes = []
         clsmembers = inspect.getmembers(arg, inspect.isclass)
         for (name, _) in clsmembers:
@@ -128,7 +137,7 @@ class PluginManager:
         return metadata
     
     async def reload(self):
-        '''扫描并加载所有的 Star'''
+        '''扫描并加载所有的插件'''
         for smd in star_registry:
             logger.debug(f"尝试终止插件 {smd.name} ...")
             if hasattr(smd.star_cls, "__del__"):
@@ -150,13 +159,13 @@ class PluginManager:
         inactivated_plugins: list = sp.get("inactivated_plugins", [])
         inactivated_llm_tools: list = sp.get("inactivated_llm_tools", [])
         
-        # 导入 Star 模块，并尝试实例化 Star 类
+        # 导入插件模块，并尝试实例化插件类
         for plugin_module in plugin_modules:
             try:
                 module_str = plugin_module['module']
                 # module_path = plugin_module['module_path']
-                root_dir_name = plugin_module['pname']
-                reserved = plugin_module.get('reserved', False)
+                root_dir_name = plugin_module['pname'] # 插件的目录名
+                reserved = plugin_module.get('reserved', False) # 是否是保留插件。目前在 packages/ 目录下的都是保留插件。保留插件不可以卸载。
                 
                 logger.info(f"正在载入插件 {root_dir_name} ...")
                 
@@ -173,11 +182,33 @@ class PluginManager:
                     logger.error(traceback.format_exc())
                     logger.error(f"插件 {root_dir_name} 导入失败。原因：{str(e)}")
                     continue
+                
+                # 检查 _conf_schema.json
+                plugin_config = None
+                plugin_dir_path = os.path.join(self.plugin_store_path, root_dir_name) \
+                    if not reserved else os.path.join(self.reserved_plugin_path, root_dir_name)
+                plugin_schema_path = os.path.join(plugin_dir_path, self.conf_schema_fname)
+                if os.path.exists(plugin_schema_path):
+                    # 加载插件配置
+                    with open(plugin_schema_path, 'r', encoding='utf-8') as f:
+                        plugin_config = AstrBotConfig(
+                            config_path=os.path.join(self.plugin_config_path, f"{root_dir_name}_config.json"), 
+                            schema=json.loads(f.read())
+                        )
 
                 if path in star_map:
                     # 通过装饰器的方式注册插件
                     metadata = star_map[path]
-                    metadata.star_cls = metadata.star_cls_type(context=self.context)
+                    
+                    if plugin_config:
+                        metadata.config = plugin_config
+                        try:
+                            metadata.star_cls = metadata.star_cls_type(context=self.context, config=plugin_config)
+                        except TypeError as _:
+                            metadata.star_cls = metadata.star_cls_type(context=self.context)
+                    else:
+                        metadata.star_cls = metadata.star_cls_type(context=self.context)
+                            
                     metadata.module = module
                     metadata.root_dir_name = root_dir_name
                     metadata.reserved = reserved
@@ -199,16 +230,20 @@ class PluginManager:
                     # v3.4.0 以前的方式注册插件
                     logger.debug(f"插件 {path} 未通过装饰器注册。尝试通过旧版本方式载入。")
                     classes = self._get_classes(module)
-                    try:
-                        obj = getattr(module, classes[0])(context=self.context)
-                    except BaseException as e:
-                        logger.error(f"插件 {root_dir_name} 实例化失败。")
-                        raise e
                     
+                    if plugin_config:
+                        try:
+                            obj = getattr(module, classes[0])(context=self.context, config=plugin_config) # 实例化插件类
+                        except TypeError as _:
+                            obj = getattr(module, classes[0])(context=self.context) # 实例化插件类
+                    else:
+                        obj = getattr(module, classes[0])(context=self.context) # 实例化插件类
+
                     metadata = None
                     plugin_path = os.path.join(self.plugin_store_path, root_dir_name) if not reserved else os.path.join(self.reserved_plugin_path, root_dir_name)
                     metadata = self._load_plugin_metadata(plugin_path=plugin_path, plugin_obj=obj)
                     metadata.star_cls = obj
+                    metadata.config = plugin_config
                     metadata.module = module
                     metadata.root_dir_name = root_dir_name
                     metadata.reserved = reserved
@@ -221,7 +256,7 @@ class PluginManager:
                 if metadata.module_path in inactivated_plugins:
                     metadata.activated = False
                     
-                # 执行 initialize 函数
+                # 执行 initialize() 方法
                 if hasattr(metadata.star_cls, "initialize"):
                     await metadata.star_cls.initialize()
                     

astrbot/dashboard/routes/config.py

@@ -1,14 +1,11 @@
-import os
-import json
-import traceback
 from .route import Route, Response, RouteContext
 from quart import request
 from astrbot.core.config.default import CONFIG_METADATA_2, DEFAULT_VALUE_MAP
 from astrbot.core.config.astrbot_config import AstrBotConfig
-from astrbot.core.star.config import update_config
 from astrbot.core.core_lifecycle import AstrBotCoreLifecycle
 from astrbot.core.platform.register import platform_registry
 from astrbot.core.provider.register import provider_registry
+from astrbot.core.star.star import star_registry
 from astrbot.core import logger
 
 def try_cast(value: str, type_: str):
@@ -20,9 +17,9 @@ def try_cast(value: str, type_: str):
     elif type_ == "float" and isinstance(value, int):
         return float(value)
 
-def validate_config(data, config: AstrBotConfig):
+def validate_config(data, schema: dict, is_core: bool):
     errors = []
-    def validate(data, metadata=CONFIG_METADATA_2, path=""):
+    def validate(data, metadata=schema, path=""):
         for key, meta in metadata.items():
             if key not in data:
                 continue
@@ -58,44 +55,32 @@ def validate_config(data, config: AstrBotConfig):
                 errors.append(f"错误的类型 {path}{key}: 期望是 dict, 得到了 {type(value).__name__}")
                 validate(value, meta["items"], path=f"{path}{key}.")
 
-    for key, group in CONFIG_METADATA_2.items():
-        group_meta = group.get("metadata")
-        if not group_meta:
-            continue
-        logger.info(f"验证配置: 组 {key} ...")
-        validate(data, group_meta, path=f"{key}.")
+    if is_core:
+        for key, group in schema.items():
+            group_meta = group.get("metadata")
+            if not group_meta:
+                continue
+            logger.info(f"验证配置: 组 {key} ...")
+            validate(data, group_meta, path=f"{key}.")
+    else:
+        validate(data, schema)
     
     return errors
 
-def save_astrbot_config(post_config: dict, config: AstrBotConfig):
+def save_config(post_config: dict, config: AstrBotConfig, is_core: bool = False):
     '''验证并保存配置'''
     errors = None
     try:
-        errors = validate_config(post_config, config)
+        if is_core:
+            errors = validate_config(post_config, CONFIG_METADATA_2, is_core)
+        else:
+            errors = validate_config(post_config, config.schema, is_core)
     except BaseException as e:
         logger.warning(f"验证配置时出现异常: {e}")
     if errors:
         raise ValueError(f"格式校验未通过: {errors}")
     config.save_config(post_config)
     
-def save_extension_config(post_config: dict):
-    if 'namespace' not in post_config:
-        raise ValueError("Missing key: namespace")
-    if 'config' not in post_config:
-        raise ValueError("Missing key: config")
-
-    namespace = post_config['namespace']
-    config: list = post_config['config'][0]['body']
-    for item in config:
-        key = item['path']
-        value = item['value']
-        typ = item['val_type']
-        if typ == 'int':
-            if not value.isdigit():
-                raise ValueError(f"错误的类型 {namespace}.{key}: 期望是 int, 得到了 {type(value).__name__}")
-            value = int(value)
-        update_config(namespace, key, value)
-
 class ConfigRoute(Route):
     def __init__(self, context: RouteContext, core_lifecycle: AstrBotCoreLifecycle) -> None:
         super().__init__(context)
@@ -103,17 +88,17 @@ class ConfigRoute(Route):
         self.routes = {
             '/config/get': ('GET', self.get_configs),
             '/config/astrbot/update': ('POST', self.post_astrbot_configs),
-            '/config/plugin/update': ('POST', self.post_extension_configs),
+            '/config/plugin/update': ('POST', self.post_plugin_configs),
         }
         self.register_routes()
 
     async def get_configs(self):
-        # namespace 为空时返回 AstrBot 配置
-        # 否则返回指定 namespace 的插件配置
-        namespace = "" if "namespace" not in request.args else request.args["namespace"]
-        if not namespace:
+        # plugin_name 为空时返回 AstrBot 配置
+        # 否则返回指定 plugin_name 的插件配置
+        plugin_name = request.args.get("plugin_name", None)
+        if not plugin_name:
             return Response().ok(await self._get_astrbot_config()).__dict__
-        return Response().ok(await self._get_extension_config(namespace)).__dict__
+        return Response().ok(await self._get_plugin_config(plugin_name)).__dict__
 
     async def post_astrbot_configs(self):
         post_configs = await request.json
@@ -124,11 +109,12 @@ class ConfigRoute(Route):
             logger.error(e)
             return Response().error(str(e)).__dict__
     
-    async def post_extension_configs(self):
+    async def post_plugin_configs(self):
         post_configs = await request.json
+        plugin_name = request.args.get("plugin_name", "unknown")
         try:
-            await self._save_extension_configs(post_configs)
-            return Response().ok(None, "保存成功~ 机器人正在重载配置。").__dict__
+            await self._save_plugin_configs(post_configs, plugin_name)
+            return Response().ok(None, f"保存插件 {plugin_name} 成功~ 机器人正在重载配置。").__dict__
         except Exception as e:
             return Response().error(str(e)).__dict__
             
@@ -152,28 +138,48 @@ class ConfigRoute(Route):
             "config": config
         }
 
-    async def _get_extension_config(self, namespace: str):
-        path = f"data/config/{namespace}.json"
-        if not os.path.exists(path):
-            return []
-        with open(path, "r", encoding="utf-8-sig") as f:
-            return [{
-                "config_type": "group",
-                "name": namespace + " 插件配置",
-                "description": "",
-                "body": list(json.load(f).values())
-            },]
-
+    async def _get_plugin_config(self, plugin_name: str):
+        ret = {
+            "metadata": None,
+            "config": None
+        }
+        
+        for plugin_md in star_registry:
+            if plugin_md.name == plugin_name:
+                if not plugin_md.config:
+                    break
+                ret['config'] = plugin_md.config # 这是自定义的 Dict 类（AstrBotConfig）
+                ret['metadata'] = {
+                    plugin_name: {
+                        "description": f"{plugin_name} 配置",
+                        "type": "object",
+                        "items": plugin_md.config.schema # 初始化时通过 __setattr__ 存入了 schema
+                    }
+                }
+                break
+            
+        return ret
+        
     async def _save_astrbot_configs(self, post_configs: dict):
         try:
-            save_astrbot_config(post_configs, self.config)
+            save_config(post_configs, self.config, is_core=True)
             self.core_lifecycle.restart()
         except Exception as e:
             raise e
-    
-    async def _save_extension_configs(self, post_configs: dict):
+        
+    async def _save_plugin_configs(self, post_configs: dict, plugin_name: str):
+        md = None
+        for plugin_md in star_registry:
+            if plugin_md.name == plugin_name:
+                md = plugin_md
+        
+        if not md:
+            raise ValueError(f"插件 {plugin_name} 不存在")
+        if not md.config:
+            raise ValueError(f"插件 {plugin_name} 没有注册配置")
+        
         try:
-            save_extension_config(post_configs)
+            save_config(post_configs, md.config)
             self.core_lifecycle.restart()
         except Exception as e:
             raise e

dashboard/src/components/shared/ConfigDetailCard.vue

@@ -1,41 +0,0 @@
-<script setup>
-import UiParentCard from '@/components/shared/UiParentCard.vue';
-
-const props = defineProps({
-  config: Array
-});
-</script>
-
-<template>
-  <a v-show="config.length === 0">该插件没有配置</a>
-  <UiParentCard v-for="group in config" :key="group.name" :title="group.name" style="margin-bottom: 16px;">
-    <template v-for="item in group.body">
-      <template v-if="item.config_type === 'item'">
-        <template v-if="item.val_type === 'bool'">
-          <v-switch v-model="item.value" :label="item.name" :hint="item.description" color="primary" inset></v-switch>
-        </template>
-        <template v-else-if="item.val_type === 'str'">
-          <v-text-field v-model="item.value" :label="item.name" :hint="item.description" style="margin-bottom: 8px;"
-            variant="outlined"></v-text-field>
-        </template>
-        <template v-else-if="item.val_type === 'int'">
-          <v-text-field v-model="item.value" :label="item.name" :hint="item.description" style="margin-bottom: 8px;"
-            variant="outlined"></v-text-field>
-        </template>
-        <template v-else-if="item.val_type === 'list'">
-          <span>{{ item.name }}</span>
-          <v-combobox v-model="item.value" chips clearable label="请添加" multiple prepend-icon="mdi-tag-multiple-outline">
-            <template v-slot:selection="{ attrs, item, select, selected }">
-              <v-chip v-bind="attrs" :model-value="selected" closable @click="select" @click:close="remove(item)">
-                <strong>{{ item }}</strong>
-              </v-chip>
-            </template>
-          </v-combobox>
-        </template>
-      </template>
-      <template v-else-if="item.config_type === 'divider'">
-        <v-divider style="margin-top: 8px; margin-bottom: 8px;"></v-divider>
-      </template>
-    </template>
-  </UiParentCard>
-</template>

dashboard/src/views/ExtensionPage.vue

@@ -1,7 +1,7 @@
 <script setup>
 import ExtensionCard from '@/components/shared/ExtensionCard.vue';
-import ConfigDetailCard from '@/components/shared/ConfigDetailCard.vue';
 import WaitingForRestart from '@/components/shared/WaitingForRestart.vue';
+import AstrBotConfig from '@/components/shared/AstrBotConfig.vue';
 import ConsoleDisplayer from '@/components/shared/ConsoleDisplayer.vue';
 import axios from 'axios';
 
@@ -56,7 +56,7 @@ import axios from 'axios';
 
   </v-row>
 
-  <v-dialog v-model="configDialog" width="750">
+  <v-dialog v-model="configDialog" width="1000">
     <template v-slot:activator="{ props }">
     </template>
     <v-card>
@@ -65,7 +65,8 @@ import axios from 'axios';
       </v-card-title>
       <v-card-text>
         <v-container>
-          <ConfigDetailCard :config="extension_config"></ConfigDetailCard>
+          <AstrBotConfig v-if="extension_config.metadata" :metadata="extension_config.metadata" :iterable="extension_config.config" :metadataKey=curr_namespace></AstrBotConfig>
+          <p v-else>这个插件没有配置</p>
         </v-container>
       </v-card-text>
       <v-card-actions>
@@ -172,9 +173,9 @@ export default {
   name: 'ExtensionPage',
   components: {
     ExtensionCard,
-    ConfigDetailCard,
     WaitingForRestart,
-    ConsoleDisplayer
+    ConsoleDisplayer,
+    AstrBotConfig
   },
   data() {
     return {
@@ -189,7 +190,10 @@ export default {
       snack_success: "success",
       loading_: false,
       configDialog: false,
-      extension_config: {},
+      extension_config: {
+        "metadata": {},
+        "config": {}
+      },
       upload_file: null,
       pluginMarketData: {},
       loadingDialog: {
@@ -364,7 +368,7 @@ export default {
     openExtensionConfig(extension_name) {
       this.curr_namespace = extension_name;
       this.configDialog = true;
-      axios.get('/api/config/get?namespace=' + extension_name).then((res) => {
+      axios.get('/api/config/get?plugin_name=' + extension_name).then((res) => {
         this.extension_config = res.data.data;
         console.log(this.extension_config);
       }).catch((err) => {
@@ -372,10 +376,7 @@ export default {
       });
     },
     updateConfig() {
-      axios.post('/api/config/plugin/update', {
-        "config": this.extension_config,
-        "namespace": this.curr_namespace
-      }).then((res) => {
+      axios.post('/api/config/plugin/update?plugin_name='+this.curr_namespace, this.extension_config.config).then((res) => {
         if (res.data.status === "ok") {
           this.toast(res.data.message, "success");
           this.$refs.wfr.check();

tests/test_pipeline.py

@@ -5,6 +5,7 @@ import asyncio
 from astrbot.core.pipeline.scheduler import PipelineScheduler, PipelineContext
 from astrbot.core.star import PluginManager
 from astrbot.core.config.astrbot_config import AstrBotConfig
+from astrbot.core.config.default import CONFIG_METADATA_2
 from astrbot.core.platform.astr_message_event import AstrMessageEvent
 from astrbot.core.platform.astrbot_message import AstrBotMessage, MessageMember, MessageType
 from astrbot.core.message.message_event_result import MessageChain, ResultContentType