AstrBot 4.0.0b5__py3-none-any.whl → 4.1.0__py3-none-any.whl

astrbot/core/star/star_tools.py

@@ -1,15 +1,37 @@
+"""
+插件开发工具集
+封装了许多常用的操作，方便插件开发者使用
+
+说明:
+
+主动发送消息: send_message(session, message_chain)
+    根据 session (unified_msg_origin) 主动发送消息, 前提是需要提前获得或构造 session
+
+根据id直接主动发送消息: send_message_by_id(type, id, message_chain, platform="aiocqhttp")
+    根据 id (例如 qq 号, 群号等) 直接, 主动地发送消息
+
+以上两种方式需要构造消息链, 也就是消息组件的列表
+
+构造事件:
+
+首先需要构造一个 AstrBotMessage 对象, 使用 create_message 方法
+然后使用 create_event 方法提交事件到指定平台
+"""
+
 import inspect
 import os
+import uuid
 from pathlib import Path
 from typing import Union, Awaitable, List, Optional, ClassVar
 from astrbot.core.message.components import BaseMessageComponent
 from astrbot.core.message.message_event_result import MessageChain
-from astrbot.api.platform import MessageMember, AstrBotMessage
+from astrbot.api.platform import MessageMember, AstrBotMessage, MessageType
 from astrbot.core.platform.astr_message_event import MessageSesion
 from astrbot.core.star.context import Context
 from astrbot.core.star.star import star_map
 from astrbot.core.utils.astrbot_path import get_astrbot_data_path
-
+from astrbot.core.platform.sources.aiocqhttp.aiocqhttp_message_event import AiocqhttpMessageEvent
+from astrbot.core.platform.sources.aiocqhttp.aiocqhttp_platform_adapter import AiocqhttpAdapter
 
 class StarTools:
     """
@@ -49,42 +71,76 @@ class StarTools:
         Note:
             qq_official(QQ官方API平台)不支持此方法
         """
+        if cls._context is None:
+            raise ValueError("StarTools not initialized")
         return await cls._context.send_message(session, message_chain)
 
+    @classmethod
+    async def send_message_by_id(
+        cls, type: str, id: str, message_chain: MessageChain, platform: str = "aiocqhttp"
+    ):
+        """
+        根据 id(例如qq号, 群号等) 直接, 主动地发送消息
+
+        Args:
+            type (str): 消息类型, 可选: PrivateMessage, GroupMessage
+            id (str): 目标ID, 例如QQ号, 群号等
+            message_chain (MessageChain): 消息链
+            platform (str): 可选的平台名称，默认平台(aiocqhttp), 目前只支持 aiocqhttp
+        """
+        if cls._context is None:
+            raise ValueError("StarTools not initialized")
+        platforms = cls._context.platform_manager.get_insts()
+        if platform == "aiocqhttp":
+            adapter = next((p for p in platforms if isinstance(p, AiocqhttpAdapter)), None)
+            if adapter is None:
+                raise ValueError("未找到适配器: AiocqhttpAdapter")
+            await AiocqhttpMessageEvent.send_message(
+                bot=adapter.bot,
+                message_chain=message_chain,
+                is_group=(type == "GroupMessage"),
+                session_id=id,
+            )
+        else:
+            raise ValueError(f"不支持的平台: {platform}")
+
     @classmethod
     async def create_message(
         cls,
         type: str,
         self_id: str,
         session_id: str,
-        message_id: str,
         sender: MessageMember,
         message: List[BaseMessageComponent],
         message_str: str,
-        raw_message: object,
-        group_id: str = "",
-    ):
+        message_id: str = "",
+        raw_message: object = None,
+        group_id: str = ""
+    ) -> AstrBotMessage:
         """
         创建一个AstrBot消息对象
 
         Args:
-            type (str): 消息类型
+            type (str): 消息类型, 例如 "GroupMessage" "FriendMessage" "OtherMessage"
             self_id (str): 机器人自身ID
             session_id (str): 会话ID(通常为用户ID)(QQ号, 群号等)
-            message_id (str): 消息ID
-            sender (MessageMember): 发送者信息
-            message (List[BaseMessageComponent]): 消息组件列表
-            message_str (str): 消息字符串
-            raw_message (object): 原始消息对象
+            sender (MessageMember): 发送者信息, 例如 MessageMember(user_id="123456", nickname="昵称")
+            message (List[BaseMessageComponent]): 消息组件列表, 也就是消息链, 这个不会发给 llm, 但是会经过其他处理
+            message_str (str): 消息字符串, 也就是纯文本消息, 也就是发送给 llm 的消息, 与消息链一致
+
+            message_id (str): 消息ID, 构造消息时可以随意填写也可不填
+            raw_message (object): 原始消息对象, 可以随意填写也可不填
             group_id (str, optional): 群组ID, 如果为私聊则为空. Defaults to "".
 
         Returns:
             AstrBotMessage: 创建的消息对象
         """
         abm = AstrBotMessage()
-        abm.type = type
+        abm.type = MessageType(type)
         abm.self_id = self_id
         abm.session_id = session_id
+        if message_id == "":
+            message_id = uuid.uuid4().hex
         abm.message_id = message_id
         abm.sender = sender
         abm.message = message
@@ -93,13 +149,38 @@ class StarTools:
         abm.group_id = group_id
         return abm
 
-    # todo: 添加构造事件的方法
-    # async def create_event(
-    #     self, platform: str, umo: str, sender_id: str, session_id: str
-    # ):
-    #     platform = self._context.get_platform(platform)
+    @classmethod
+    async def create_event(
+        cls, abm: AstrBotMessage, platform: str = "aiocqhttp", is_wake: bool = True
+
+    ) -> None:
+        """
+        创建并提交事件到指定平台
+        当有需要创建一个事件, 触发某些处理流程时, 使用该方法
 
-    # todo: 添加找到对应平台并提交对应事件的方法
+        Args:
+            abm (AstrBotMessage): 要提交的消息对象, 请先使用 create_message 创建
+            platform (str): 可选的平台名称，默认平台(aiocqhttp), 目前只支持 aiocqhttp
+            is_wake (bool): 是否标记为唤醒事件, 默认为 True, 只有唤醒事件才会被 llm 响应
+        """
+        if cls._context is None:
+            raise ValueError("StarTools not initialized")
+        platforms = cls._context.platform_manager.get_insts()
+        if platform == "aiocqhttp":
+            adapter = next((p for p in platforms if isinstance(p, AiocqhttpAdapter)), None)
+            if adapter is None:
+                raise ValueError("未找到适配器: AiocqhttpAdapter")
+            event = AiocqhttpMessageEvent(
+                message_str=abm.message_str,
+                message_obj=abm,
+                platform_meta=adapter.metadata,
+                session_id=abm.session_id,
+                bot=adapter.bot,
+            )
+            event.is_wake = is_wake
+            adapter.commit_event(event)
+        else:
+            raise ValueError(f"不支持的平台: {platform}")
 
     @classmethod
     def activate_llm_tool(cls, name: str) -> bool:
@@ -110,6 +191,8 @@ class StarTools:
         Args:
             name (str): 工具名称
         """
+        if cls._context is None:
+            raise ValueError("StarTools not initialized")
         return cls._context.activate_llm_tool(name)
 
     @classmethod
@@ -120,6 +203,8 @@ class StarTools:
         Args:
             name (str): 工具名称
         """
+        if cls._context is None:
+            raise ValueError("StarTools not initialized")
         return cls._context.deactivate_llm_tool(name)
 
     @classmethod
@@ -135,6 +220,8 @@ class StarTools:
             desc (str): 工具描述
             func_obj (Awaitable): 函数对象，必须是异步函数
         """
+        if cls._context is None:
+            raise ValueError("StarTools not initialized")
         cls._context.register_llm_tool(name, func_args, desc, func_obj)
 
     @classmethod
@@ -146,6 +233,8 @@ class StarTools:
         Args:
             name (str): 工具名称
         """
+        if cls._context is None:
+            raise ValueError("StarTools not initialized")
         cls._context.unregister_llm_tool(name)
 
     @classmethod
@@ -169,8 +258,11 @@ class StarTools:
                 - 创建目录失败（权限不足或其他IO错误）
         """
         if not plugin_name:
-            frame = inspect.currentframe().f_back
-            module = inspect.getmodule(frame)
+            frame = inspect.currentframe()
+            module = None
+            if frame:
+                frame = frame.f_back
+                module = inspect.getmodule(frame)
 
             if not module:
                 raise RuntimeError("无法获取调用者模块信息")
@@ -182,6 +274,9 @@ class StarTools:
 
             plugin_name = metadata.name
 
+        if not plugin_name:
+            raise ValueError("无法获取插件名称")
+
         data_dir = Path(os.path.join(get_astrbot_data_path(), "plugin_data", plugin_name))
 
         try:

astrbot/core/utils/t2i/network_strategy.py

@@ -1,6 +1,5 @@
 import aiohttp
 import asyncio
-import os
 import ssl
 import certifi
 import logging
@@ -8,10 +7,9 @@ import random
 from . import RenderStrategy
 from astrbot.core.config import VERSION
 from astrbot.core.utils.io import download_image_by_url
-from astrbot.core.utils.astrbot_path import get_astrbot_data_path
+from astrbot.core.utils.t2i.template_manager import TemplateManager
 
 ASTRBOT_T2I_DEFAULT_ENDPOINT = "https://t2i.soulter.top/text2img"
-CUSTOM_T2I_TEMPLATE_PATH = os.path.join(get_astrbot_data_path(), "t2i_template.html")
 
 logger = logging.getLogger("astrbot")
 
@@ -23,26 +21,17 @@ class NetworkRenderStrategy(RenderStrategy):
             self.BASE_RENDER_URL = ASTRBOT_T2I_DEFAULT_ENDPOINT
         else:
             self.BASE_RENDER_URL = self._clean_url(base_url)
-        self.TEMPLATE_PATH = os.path.join(os.path.dirname(__file__), "template", "base.html")
-        with open(self.TEMPLATE_PATH, "r", encoding="utf-8") as f:
-            self.DEFAULT_TEMPLATE = f.read()
 
         self.endpoints = [self.BASE_RENDER_URL]
+        self.template_manager = TemplateManager()
 
     async def initialize(self):
         if self.BASE_RENDER_URL == ASTRBOT_T2I_DEFAULT_ENDPOINT:
             asyncio.create_task(self.get_official_endpoints())
 
-    async def get_template(self) -> str:
-        """获取文转图 HTML 模板
-
-        Returns:
-            str: 文转图 HTML 模板字符串
-        """
-        if os.path.exists(CUSTOM_T2I_TEMPLATE_PATH):
-            with open(CUSTOM_T2I_TEMPLATE_PATH, "r", encoding="utf-8") as f:
-                return f.read()
-        return self.DEFAULT_TEMPLATE
+    async def get_template(self, name: str = "base") -> str:
+        """通过名称获取文转图 HTML 模板"""
+        return self.template_manager.get_template(name)
 
     async def get_official_endpoints(self):
         """获取官方的 t2i 端点列表。"""
@@ -124,11 +113,15 @@ class NetworkRenderStrategy(RenderStrategy):
         logger.error(f"All endpoints failed: {last_exception}")
         raise RuntimeError(f"All endpoints failed: {last_exception}")
 
-    async def render(self, text: str, return_url: bool = False) -> str:
+    async def render(
+        self, text: str, return_url: bool = False, template_name: str | None = "base"
+    ) -> str:
         """
         返回图像的文件路径
         """
-        tmpl_str = await self.get_template()
+        if not template_name:
+            template_name = "base"
+        tmpl_str = await self.get_template(name=template_name)
         text = text.replace("`", "\\`")
         return await self.render_custom_template(
             tmpl_str, {"text": text, "version": f"v{VERSION}"}, return_url

astrbot/core/utils/t2i/renderer.py

@@ -34,12 +34,18 @@ class HtmlRenderer:
         )
 
     async def render_t2i(
-        self, text: str, use_network: bool = True, return_url: bool = False
+        self,
+        text: str,
+        use_network: bool = True,
+        return_url: bool = False,
+        template_name: str | None = None,
     ):
         """使用默认文转图模板。"""
         if use_network:
             try:
-                return await self.network_strategy.render(text, return_url=return_url)
+                return await self.network_strategy.render(
+                    text, return_url=return_url, template_name=template_name
+                )
             except BaseException as e:
                 logger.error(
                     f"Failed to render image via AstrBot API: {e}. Falling back to local rendering."

astrbot/core/utils/t2i/template/astrbot_powershell.html

@@ -0,0 +1,184 @@
+<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8"/>
+  <title>Astrbot PowerShell {{ version }} </title>
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/katex.min.css" integrity="sha384-wcIxkf4k558AjM3Yz3BBFQUbk/zgIYC2R0QpeeYb+TwlBVMrlgLqwRjRtGZiK7ww" crossorigin="anonymous">
+  <script src="https://cdn.jsdelivr.net/npm/highlight.js@11.9.0/lib/common.min.js"></script>
+  <script>hljs.highlightAll();</script>
+  <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/katex.min.js" integrity="sha384-hIoBPJpTUs74ddyc4bFZSM1TVlQDA60VBbJS0oA934VSz82sBx1X7kSx2ATBDIyd" crossorigin="anonymous"></script>
+  <script defer src="https://cdn.jsdelivr.net/npm/katex@0.16.10/dist/contrib/auto-render.min.js" integrity="sha384-43gviWU0YVjaDtb/GhzOouOXtZMP/7XUzwPTstBeZFe/+rCMvRwr4yROQP43s0Xk" crossorigin="anonymous"
+      onload="renderMathInElement(document.getElementById('content'),{delimiters: [{left: '$$', right: '$$', display: true},{left: '$', right: '$', display: false}]});"></script>
+  <style>
+    :root {
+        --bg-color: #010409;
+        --text-color: #e6edf3;
+        --title-bar-color: #161b22;
+        --title-text-color: #e6edf3;
+        --font-family: 'Consolas', 'Microsoft YaHei Mono', 'Dengxian Mono', 'Courier New', monospace;
+        --glow-color: rgba(200, 220, 255, 0.7);
+    }
+
+    @keyframes scanline {
+        0% {
+            background-position: 0 0;
+        }
+        100% {
+            background-position: 0 100%;
+        }
+    }
+
+    body {
+        background-color: var(--bg-color);
+        color: var(--text-color);
+        font-family: var(--font-family);
+        margin: 0;
+        padding: 0;
+        line-height: 1.6;
+        font-size: 18px;
+        /* The CRT glow effect from the image */
+        text-shadow: 0 0 15px var(--glow-color), 0 0 7px rgba(255, 255, 255, 1);
+        position: relative;
+        overflow: hidden;
+    }
+
+    body::after {
+        content: " ";
+        display: block;
+        position: absolute;
+        top: 0;
+        left: 0;
+        right: 0;
+        bottom: 0;
+        background: linear-gradient(to bottom, transparent 50%, rgba(0, 0, 0, 0.3) 50%);
+        background-size: 100% 4px;
+        z-index: 2;
+        pointer-events: none;
+        animation: scanline 8s linear infinite;
+    }
+
+    .header {
+        background-color: var(--title-bar-color);
+        padding: 12px 18px;
+        color: var(--title-text-color);
+        font-size: 16px;
+        border-bottom: 1px solid #30363d;
+        text-shadow: none; /* No glow for title bar */
+    }
+    
+    .header .title {
+        font-weight: bold;
+        font-size: 28px;
+    }
+
+    .header .version {
+        opacity: 0.8;
+        margin-left: 1rem;
+    }
+
+    main {
+        padding: 1rem 1.5rem;
+    }
+
+    #content {
+        /* min-width and max-width removed as per request */
+    }
+
+    /* --- Markdown Styles adjusted for terminal look --- */
+    h1, h2, h3, h4, h5, h6 {
+        line-height: 1.4;
+        margin-top: 20px;
+        margin-bottom: 10px;
+        padding-bottom: 5px;
+        border-bottom: 1px solid #30363d;
+        color: var(--text-color);
+    }
+    h1 { font-size: 2rem; }
+    h2 { font-size: 1.7rem; }
+    h3 { font-size: 1.4rem; }
+
+    p {
+        margin-top: 1rem;
+        margin-bottom: 1rem;
+    }
+
+    strong {
+      color: var(--text-color);
+      font-weight: bold;
+    }
+
+    img {
+        max-width: 100%;
+        border: 1px solid #30363d;
+        display: block;
+        margin: 1rem auto;
+    }
+
+    hr {
+        border: 0;
+        border-top: 1px dashed #30363d;
+        margin: 2rem 0;
+    }
+
+    code {
+        font-family: var(--font-family);
+        padding: 0.2em 0.4em;
+        margin: 0;
+        font-size: 90%;
+        background-color: #161b22;
+        border-radius: 4px;
+    }
+
+    pre {
+        font-family: var(--font-family);
+        border-radius: 4px;
+        background: #0d1117;
+        padding: 1rem;
+        overflow-x: auto;
+        border: 1px solid #30363d;
+    }
+
+    pre > code {
+        padding: 0;
+        margin: 0;
+        font-size: 100%;
+        background-color: transparent;
+        border-radius: 0;
+        text-shadow: none; /* Disable glow inside code blocks for clarity */
+    }
+
+    a {
+        color: #58a6ff;
+        text-decoration: underline;
+    }
+    a:hover {
+        text-decoration: underline;
+    }
+
+    blockquote {
+        border-left: 4px solid #30363d;
+        padding: 0.5rem 1rem;
+        margin: 1.5rem 0;
+        color: #8b949e;
+        background-color: #161b22;
+    }
+  </style>
+</head>
+<body>
+
+  <div class="header">
+    <span class="title">> Astrbot PowerShell</span>
+    <span class="version">{{ version }}</span>
+  </div>
+
+  <main>
+    <div id="content"></div>
+  </main>
+
+  <script src="https://cdn.jsdelivr.net/npm/marked/marked.min.js"></script>
+  <script>
+    document.getElementById('content').innerHTML = marked.parse(`{{ text | safe }}`);
+  </script>
+
+</body>
+</html>

astrbot/core/utils/t2i/template_manager.py

@@ -0,0 +1,112 @@
+# astrbot/core/utils/t2i/template_manager.py
+
+import os
+import shutil
+from astrbot.core.utils.astrbot_path import get_astrbot_data_path, get_astrbot_path
+
+
+class TemplateManager:
+    """
+    负责管理 t2i HTML 模板的 CRUD 和重置操作。
+    采用“用户覆盖内置”策略：用户模板存储在 data 目录中，并优先于内置模板加载。
+    所有创建、更新、删除操作仅影响用户目录，以确保更新框架时用户数据安全。
+    """
+
+    CORE_TEMPLATES = ["base.html", "astrbot_powershell.html"]
+
+    def __init__(self):
+        self.builtin_template_dir = os.path.join(
+            get_astrbot_path(), "astrbot", "core", "utils", "t2i", "template"
+        )
+        self.user_template_dir = os.path.join(get_astrbot_data_path(), "t2i_templates")
+
+        os.makedirs(self.user_template_dir, exist_ok=True)
+        self._initialize_user_templates()
+
+    def _copy_core_templates(self, overwrite: bool = False):
+        """从内置目录复制核心模板到用户目录。"""
+        for filename in self.CORE_TEMPLATES:
+            src = os.path.join(self.builtin_template_dir, filename)
+            dst = os.path.join(self.user_template_dir, filename)
+            if os.path.exists(src) and (overwrite or not os.path.exists(dst)):
+                shutil.copyfile(src, dst)
+
+    def _initialize_user_templates(self):
+        """如果用户目录下缺少核心模板，则进行复制。"""
+        self._copy_core_templates(overwrite=False)
+
+    def _get_user_template_path(self, name: str) -> str:
+        """获取用户模板的完整路径，防止路径遍历漏洞。"""
+        if ".." in name or "/" in name or "\\" in name:
+            raise ValueError("模板名称包含非法字符。")
+        return os.path.join(self.user_template_dir, f"{name}.html")
+
+    def _read_file(self, path: str) -> str:
+        """读取文件内容。"""
+        with open(path, "r", encoding="utf-8") as f:
+            return f.read()
+
+    def list_templates(self) -> list[dict]:
+        """
+        列出所有可用模板。
+        该列表是内置模板和用户模板的合并视图，用户模板将覆盖同名的内置模板。
+        """
+        dirs_to_scan = [self.builtin_template_dir, self.user_template_dir]
+        all_names = {
+            os.path.splitext(f)[0]
+            for d in dirs_to_scan
+            for f in os.listdir(d)
+            if f.endswith(".html")
+        }
+        return [
+            {"name": name, "is_default": name == "base"} for name in sorted(all_names)
+        ]
+
+    def get_template(self, name: str) -> str:
+        """
+        获取指定模板的内容。
+        优先从用户目录加载，如果不存在则回退到内置目录。
+        """
+        user_path = self._get_user_template_path(name)
+        if os.path.exists(user_path):
+            return self._read_file(user_path)
+
+        builtin_path = os.path.join(self.builtin_template_dir, f"{name}.html")
+        if os.path.exists(builtin_path):
+            return self._read_file(builtin_path)
+
+        raise FileNotFoundError("模板不存在。")
+
+    def create_template(self, name: str, content: str):
+        """在用户目录中创建一个新的模板文件。"""
+        path = self._get_user_template_path(name)
+        if os.path.exists(path):
+            raise FileExistsError("同名模板已存在。")
+        with open(path, "w", encoding="utf-8") as f:
+            f.write(content)
+
+    def update_template(self, name: str, content: str):
+        """
+        更新一个模板。此操作始终写入用户目录。
+        如果更新的是一个内置模板，此操作实际上会在用户目录中创建一个修改后的副本，
+        从而实现对内置模板的“覆盖”。
+        """
+        path = self._get_user_template_path(name)
+        with open(path, "w", encoding="utf-8") as f:
+            f.write(content)
+
+    def delete_template(self, name: str):
+        """
+        仅删除用户目录中的模板文件。
+        如果删除的是一个覆盖了内置模板的用户模板，这将有效地“恢复”到内置版本。
+        """
+        path = self._get_user_template_path(name)
+        if not os.path.exists(path):
+            raise FileNotFoundError("用户模板不存在，无法删除。")
+        os.remove(path)
+
+    def reset_default_template(self):
+        """
+        将核心模板从内置目录强制重置到用户目录。
+        """
+        self._copy_core_templates(overwrite=True)

astrbot/dashboard/routes/chat.py

@@ -157,7 +157,11 @@ class ChatRoute(Route):
 
                     if type == "end":
                         break
-                    elif (streaming and type == "complete") or not streaming:
+                    elif (
+                        (streaming and type == "complete")
+                        or not streaming
+                        or type == "break"
+                    ):
                         # append bot message
                         new_his = {"type": "bot", "message": result_text}
                         await self.platform_history_mgr.insert(
@@ -197,6 +201,7 @@ class ChatRoute(Route):
                 "Connection": "keep-alive",
             },
         )
+        response.timeout = None  # fix SSE auto disconnect issue
         return response
 
     async def _get_webchat_conv_id_from_conv_id(self, conversation_id: str) -> str: