AstrBot 4.13.2__py3-none-any.whl → 4.14.1__py3-none-any.whl

astrbot/core/cron/manager.py

@@ -0,0 +1,376 @@
+import asyncio
+import json
+from collections.abc import Awaitable, Callable
+from datetime import datetime, timezone
+from typing import TYPE_CHECKING, Any
+from zoneinfo import ZoneInfo
+
+from apscheduler.schedulers.asyncio import AsyncIOScheduler
+from apscheduler.triggers.cron import CronTrigger
+from apscheduler.triggers.date import DateTrigger
+
+from astrbot import logger
+from astrbot.core.agent.tool import ToolSet
+from astrbot.core.cron.events import CronMessageEvent
+from astrbot.core.db import BaseDatabase
+from astrbot.core.db.po import CronJob
+from astrbot.core.platform.message_session import MessageSession
+from astrbot.core.provider.entites import ProviderRequest
+from astrbot.core.utils.history_saver import persist_agent_history
+
+if TYPE_CHECKING:
+    from astrbot.core.star.context import Context
+
+
+class CronJobManager:
+    """Central scheduler for BasicCronJob and ActiveAgentCronJob."""
+
+    def __init__(self, db: BaseDatabase):
+        self.db = db
+        self.scheduler = AsyncIOScheduler()
+        self._basic_handlers: dict[str, Callable[..., Any]] = {}
+        self._lock = asyncio.Lock()
+        self._started = False
+
+    async def start(self, ctx: "Context"):
+        self.ctx: Context = ctx  # star context
+        async with self._lock:
+            if self._started:
+                return
+            self.scheduler.start()
+            self._started = True
+            await self.sync_from_db()
+
+    async def shutdown(self):
+        async with self._lock:
+            if not self._started:
+                return
+            self.scheduler.shutdown(wait=False)
+            self._started = False
+
+    async def sync_from_db(self):
+        jobs = await self.db.list_cron_jobs()
+        for job in jobs:
+            if not job.enabled or not job.persistent:
+                continue
+            if job.job_type == "basic" and job.job_id not in self._basic_handlers:
+                logger.warning(
+                    "Skip scheduling basic cron job %s due to missing handler.",
+                    job.job_id,
+                )
+                continue
+            self._schedule_job(job)
+
+    async def add_basic_job(
+        self,
+        *,
+        name: str,
+        cron_expression: str,
+        handler: Callable[..., Any | Awaitable[Any]],
+        description: str | None = None,
+        timezone: str | None = None,
+        payload: dict | None = None,
+        enabled: bool = True,
+        persistent: bool = False,
+    ) -> CronJob:
+        job = await self.db.create_cron_job(
+            name=name,
+            job_type="basic",
+            cron_expression=cron_expression,
+            timezone=timezone,
+            payload=payload or {},
+            description=description,
+            enabled=enabled,
+            persistent=persistent,
+        )
+        self._basic_handlers[job.job_id] = handler
+        if enabled:
+            self._schedule_job(job)
+        return job
+
+    async def add_active_job(
+        self,
+        *,
+        name: str,
+        cron_expression: str | None,
+        payload: dict,
+        description: str | None = None,
+        timezone: str | None = None,
+        enabled: bool = True,
+        persistent: bool = True,
+        run_once: bool = False,
+        run_at: datetime | None = None,
+    ) -> CronJob:
+        # If run_once with run_at, store run_at in payload for later reference.
+        if run_once and run_at:
+            payload = {**payload, "run_at": run_at.isoformat()}
+        job = await self.db.create_cron_job(
+            name=name,
+            job_type="active_agent",
+            cron_expression=cron_expression,
+            timezone=timezone,
+            payload=payload,
+            description=description,
+            enabled=enabled,
+            persistent=persistent,
+            run_once=run_once,
+        )
+        if enabled:
+            self._schedule_job(job)
+        return job
+
+    async def update_job(self, job_id: str, **kwargs) -> CronJob | None:
+        job = await self.db.update_cron_job(job_id, **kwargs)
+        if not job:
+            return None
+        self._remove_scheduled(job_id)
+        if job.enabled:
+            self._schedule_job(job)
+        return job
+
+    async def delete_job(self, job_id: str) -> None:
+        self._remove_scheduled(job_id)
+        self._basic_handlers.pop(job_id, None)
+        await self.db.delete_cron_job(job_id)
+
+    async def list_jobs(self, job_type: str | None = None) -> list[CronJob]:
+        return await self.db.list_cron_jobs(job_type)
+
+    def _remove_scheduled(self, job_id: str):
+        if self.scheduler.get_job(job_id):
+            self.scheduler.remove_job(job_id)
+
+    def _schedule_job(self, job: CronJob):
+        if not self._started:
+            self.scheduler.start()
+            self._started = True
+        try:
+            tzinfo = None
+            if job.timezone:
+                try:
+                    tzinfo = ZoneInfo(job.timezone)
+                except Exception:
+                    logger.warning(
+                        "Invalid timezone %s for cron job %s, fallback to system.",
+                        job.timezone,
+                        job.job_id,
+                    )
+            if job.run_once:
+                run_at_str = None
+                if isinstance(job.payload, dict):
+                    run_at_str = job.payload.get("run_at")
+                run_at_str = run_at_str or job.cron_expression
+                if not run_at_str:
+                    raise ValueError("run_once job missing run_at timestamp")
+                run_at = datetime.fromisoformat(run_at_str)
+                if run_at.tzinfo is None and tzinfo is not None:
+                    run_at = run_at.replace(tzinfo=tzinfo)
+                trigger = DateTrigger(run_date=run_at, timezone=tzinfo)
+            else:
+                trigger = CronTrigger.from_crontab(job.cron_expression, timezone=tzinfo)
+            self.scheduler.add_job(
+                self._run_job,
+                id=job.job_id,
+                trigger=trigger,
+                args=[job.job_id],
+                replace_existing=True,
+                misfire_grace_time=30,
+            )
+            asyncio.create_task(
+                self.db.update_cron_job(
+                    job.job_id, next_run_time=self._get_next_run_time(job.job_id)
+                )
+            )
+        except Exception as e:
+            logger.error(f"Failed to schedule cron job {job.job_id}: {e!s}")
+
+    def _get_next_run_time(self, job_id: str):
+        aps_job = self.scheduler.get_job(job_id)
+        return aps_job.next_run_time if aps_job else None
+
+    async def _run_job(self, job_id: str):
+        job = await self.db.get_cron_job(job_id)
+        if not job or not job.enabled:
+            return
+        start_time = datetime.now(timezone.utc)
+        await self.db.update_cron_job(
+            job_id, status="running", last_run_at=start_time, last_error=None
+        )
+        status = "completed"
+        last_error = None
+        try:
+            if job.job_type == "basic":
+                await self._run_basic_job(job)
+            elif job.job_type == "active_agent":
+                await self._run_active_agent_job(job, start_time=start_time)
+            else:
+                raise ValueError(f"Unknown cron job type: {job.job_type}")
+        except Exception as e:  # noqa: BLE001
+            status = "failed"
+            last_error = str(e)
+            logger.error(f"Cron job {job_id} failed: {e!s}", exc_info=True)
+        finally:
+            next_run = self._get_next_run_time(job_id)
+            await self.db.update_cron_job(
+                job_id,
+                status=status,
+                last_run_at=start_time,
+                last_error=last_error,
+                next_run_time=next_run,
+            )
+            if job.run_once:
+                # one-shot: remove after execution regardless of success
+                await self.delete_job(job_id)
+
+    async def _run_basic_job(self, job: CronJob):
+        handler = self._basic_handlers.get(job.job_id)
+        if not handler:
+            raise RuntimeError(f"Basic cron job handler not found for {job.job_id}")
+        payload = job.payload or {}
+        result = handler(**payload) if payload else handler()
+        if asyncio.iscoroutine(result):
+            await result
+
+    async def _run_active_agent_job(self, job: CronJob, start_time: datetime):
+        payload = job.payload or {}
+        session_str = payload.get("session")
+        if not session_str:
+            raise ValueError("ActiveAgentCronJob missing session.")
+        note = payload.get("note") or job.description or job.name
+
+        extras = {
+            "cron_job": {
+                "id": job.job_id,
+                "name": job.name,
+                "type": job.job_type,
+                "run_once": job.run_once,
+                "description": job.description,
+                "note": note,
+                "run_started_at": start_time.isoformat(),
+                "run_at": (
+                    job.payload.get("run_at") if isinstance(job.payload, dict) else None
+                ),
+            },
+            "cron_payload": payload,
+        }
+
+        await self._woke_main_agent(
+            message=note,
+            session_str=session_str,
+            extras=extras,
+        )
+
+    async def _woke_main_agent(
+        self,
+        *,
+        message: str,
+        session_str: str,
+        extras: dict,
+    ):
+        """Woke the main agent to handle the cron job message."""
+        from astrbot.core.astr_main_agent import (
+            MainAgentBuildConfig,
+            _get_session_conv,
+            build_main_agent,
+        )
+        from astrbot.core.astr_main_agent_resources import (
+            PROACTIVE_AGENT_CRON_WOKE_SYSTEM_PROMPT,
+            SEND_MESSAGE_TO_USER_TOOL,
+        )
+
+        try:
+            session = (
+                session_str
+                if isinstance(session_str, MessageSession)
+                else MessageSession.from_str(session_str)
+            )
+        except Exception as e:  # noqa: BLE001
+            logger.error(f"Invalid session for cron job: {e}")
+            return
+
+        cron_event = CronMessageEvent(
+            context=self.ctx,
+            session=session,
+            message=message,
+            extras=extras or {},
+            message_type=session.message_type,
+        )
+
+        # judge user's role
+        umo = cron_event.unified_msg_origin
+        cfg = self.ctx.get_config(umo=umo)
+        cron_payload = extras.get("cron_payload", {}) if extras else {}
+        sender_id = cron_payload.get("sender_id")
+        admin_ids = cfg.get("admins_id", [])
+        if admin_ids:
+            cron_event.role = "admin" if sender_id in admin_ids else "member"
+        if cron_payload.get("origin", "tool") == "api":
+            cron_event.role = "admin"
+
+        config = MainAgentBuildConfig(
+            tool_call_timeout=3600,
+            llm_safety_mode=False,
+        )
+        req = ProviderRequest()
+        conv = await _get_session_conv(event=cron_event, plugin_context=self.ctx)
+        req.conversation = conv
+        # finetine the messages
+        context = json.loads(conv.history)
+        if context:
+            req.contexts = context
+            context_dump = req._print_friendly_context()
+            req.contexts = []
+            req.system_prompt += (
+                "\n\nBellow is you and user previous conversation history:\n"
+                f"---\n"
+                f"{context_dump}\n"
+                f"---\n"
+            )
+        cron_job_str = json.dumps(extras.get("cron_job", {}), ensure_ascii=False)
+        req.system_prompt += PROACTIVE_AGENT_CRON_WOKE_SYSTEM_PROMPT.format(
+            cron_job=cron_job_str
+        )
+        req.prompt = (
+            "You are now responding to a scheduled task"
+            "Proceed according to your system instructions. "
+            "Output using same language as previous conversation."
+            "After completing your task, summarize and output your actions and results."
+        )
+        if not req.func_tool:
+            req.func_tool = ToolSet()
+        req.func_tool.add_tool(SEND_MESSAGE_TO_USER_TOOL)
+
+        result = await build_main_agent(
+            event=cron_event, plugin_context=self.ctx, config=config, req=req
+        )
+        if not result:
+            logger.error("Failed to build main agent for cron job.")
+            return
+
+        runner = result.agent_runner
+        async for _ in runner.step_until_done(30):
+            # agent will send message to user via using tools
+            pass
+        llm_resp = runner.get_final_llm_resp()
+        cron_meta = extras.get("cron_job", {}) if extras else {}
+        summary_note = (
+            f"[CronJob] {cron_meta.get('name') or cron_meta.get('id', 'unknown')}: {cron_meta.get('description', '')} "
+            f" triggered at {cron_meta.get('run_started_at', 'unknown time')}, "
+        )
+        if llm_resp and llm_resp.role == "assistant":
+            summary_note += (
+                f"I finished this job, here is the result: {llm_resp.completion_text}"
+            )
+
+        await persist_agent_history(
+            self.ctx.conversation_manager,
+            event=cron_event,
+            req=req,
+            summary_note=summary_note,
+        )
+        if not llm_resp:
+            logger.warning("Cron job agent got no response")
+            return
+
+
+__all__ = ["CronJobManager"]

astrbot/core/db/__init__.py

@@ -13,6 +13,7 @@ from astrbot.core.db.po import (
     CommandConfig,
     CommandConflict,
     ConversationV2,
+    CronJob,
     Persona,
     PersonaFolder,
     PlatformMessageHistory,
@@ -511,6 +512,65 @@ class BaseDatabase(abc.ABC):
         """Get paginated session conversations with joined conversation and persona details, support search and platform filter."""
         ...
 
+    # ====
+    # Cron Job Management
+    # ====
+
+    @abc.abstractmethod
+    async def create_cron_job(
+        self,
+        name: str,
+        job_type: str,
+        cron_expression: str | None,
+        *,
+        timezone: str | None = None,
+        payload: dict | None = None,
+        description: str | None = None,
+        enabled: bool = True,
+        persistent: bool = True,
+        run_once: bool = False,
+        status: str | None = None,
+        job_id: str | None = None,
+    ) -> CronJob:
+        """Create and persist a cron job definition."""
+        ...
+
+    @abc.abstractmethod
+    async def update_cron_job(
+        self,
+        job_id: str,
+        *,
+        name: str | None = None,
+        cron_expression: str | None = None,
+        timezone: str | None = None,
+        payload: dict | None = None,
+        description: str | None = None,
+        enabled: bool | None = None,
+        persistent: bool | None = None,
+        run_once: bool | None = None,
+        status: str | None = None,
+        next_run_time: datetime.datetime | None = None,
+        last_run_at: datetime.datetime | None = None,
+        last_error: str | None = None,
+    ) -> CronJob | None:
+        """Update fields of a cron job by job_id."""
+        ...
+
+    @abc.abstractmethod
+    async def delete_cron_job(self, job_id: str) -> None:
+        """Delete a cron job by its public job_id."""
+        ...
+
+    @abc.abstractmethod
+    async def get_cron_job(self, job_id: str) -> CronJob | None:
+        """Fetch a cron job by job_id."""
+        ...
+
+    @abc.abstractmethod
+    async def list_cron_jobs(self, job_type: str | None = None) -> list[CronJob]:
+        """List cron jobs, optionally filtered by job_type."""
+        ...
+
     # ====
     # Platform Session Management
     # ====

astrbot/core/db/po.py

@@ -139,6 +139,37 @@ class Persona(TimestampMixin, SQLModel, table=True):
     )
 
 
+class CronJob(TimestampMixin, SQLModel, table=True):
+    """Cron job definition for scheduler and WebUI management."""
+
+    __tablename__: str = "cron_jobs"
+
+    id: int | None = Field(
+        default=None,
+        primary_key=True,
+        sa_column_kwargs={"autoincrement": True},
+    )
+    job_id: str = Field(
+        max_length=64,
+        nullable=False,
+        unique=True,
+        default_factory=lambda: str(uuid.uuid4()),
+    )
+    name: str = Field(max_length=255, nullable=False)
+    description: str | None = Field(default=None, sa_type=Text)
+    job_type: str = Field(max_length=32, nullable=False)  # basic | active_agent
+    cron_expression: str | None = Field(default=None, max_length=255)
+    timezone: str | None = Field(default=None, max_length=64)
+    payload: dict = Field(default_factory=dict, sa_type=JSON)
+    enabled: bool = Field(default=True)
+    persistent: bool = Field(default=True)
+    run_once: bool = Field(default=False)
+    status: str = Field(default="scheduled", max_length=32)
+    last_run_at: datetime | None = Field(default=None)
+    next_run_time: datetime | None = Field(default=None)
+    last_error: str | None = Field(default=None, sa_type=Text)
+
+
 class Preference(TimestampMixin, SQLModel, table=True):
     """This class represents preferences for bots."""
 

astrbot/core/db/sqlite.py

@@ -15,6 +15,7 @@ from astrbot.core.db.po import (
     CommandConfig,
     CommandConflict,
     ConversationV2,
+    CronJob,
     Persona,
     PersonaFolder,
     PlatformMessageHistory,
@@ -33,6 +34,7 @@ from astrbot.core.db.po import (
 
 NOT_GIVEN = T.TypeVar("NOT_GIVEN")
 TxResult = T.TypeVar("TxResult")
+CRON_FIELD_NOT_SET = object()
 
 
 class SQLiteDatabase(BaseDatabase):
@@ -1576,3 +1578,121 @@ class SQLiteDatabase(BaseDatabase):
                 ),
             )
             return result.scalar_one_or_none()
+
+    # ====
+    # Cron Job Management
+    # ====
+
+    async def create_cron_job(
+        self,
+        name: str,
+        job_type: str,
+        cron_expression: str | None,
+        *,
+        timezone: str | None = None,
+        payload: dict | None = None,
+        description: str | None = None,
+        enabled: bool = True,
+        persistent: bool = True,
+        run_once: bool = False,
+        status: str | None = None,
+        job_id: str | None = None,
+    ) -> CronJob:
+        async with self.get_db() as session:
+            session: AsyncSession
+            async with session.begin():
+                job = CronJob(
+                    name=name,
+                    job_type=job_type,
+                    cron_expression=cron_expression,
+                    timezone=timezone,
+                    payload=payload or {},
+                    description=description,
+                    enabled=enabled,
+                    persistent=persistent,
+                    run_once=run_once,
+                    status=status or "scheduled",
+                )
+                if job_id:
+                    job.job_id = job_id
+                session.add(job)
+                await session.flush()
+                await session.refresh(job)
+                return job
+
+    async def update_cron_job(
+        self,
+        job_id: str,
+        *,
+        name: str | None | object = CRON_FIELD_NOT_SET,
+        cron_expression: str | None | object = CRON_FIELD_NOT_SET,
+        timezone: str | None | object = CRON_FIELD_NOT_SET,
+        payload: dict | None | object = CRON_FIELD_NOT_SET,
+        description: str | None | object = CRON_FIELD_NOT_SET,
+        enabled: bool | None | object = CRON_FIELD_NOT_SET,
+        persistent: bool | None | object = CRON_FIELD_NOT_SET,
+        run_once: bool | None | object = CRON_FIELD_NOT_SET,
+        status: str | None | object = CRON_FIELD_NOT_SET,
+        next_run_time: datetime | None | object = CRON_FIELD_NOT_SET,
+        last_run_at: datetime | None | object = CRON_FIELD_NOT_SET,
+        last_error: str | None | object = CRON_FIELD_NOT_SET,
+    ) -> CronJob | None:
+        async with self.get_db() as session:
+            session: AsyncSession
+            async with session.begin():
+                updates: dict = {}
+                for key, val in {
+                    "name": name,
+                    "cron_expression": cron_expression,
+                    "timezone": timezone,
+                    "payload": payload,
+                    "description": description,
+                    "enabled": enabled,
+                    "persistent": persistent,
+                    "run_once": run_once,
+                    "status": status,
+                    "next_run_time": next_run_time,
+                    "last_run_at": last_run_at,
+                    "last_error": last_error,
+                }.items():
+                    if val is CRON_FIELD_NOT_SET:
+                        continue
+                    updates[key] = val
+
+                stmt = (
+                    update(CronJob)
+                    .where(col(CronJob.job_id) == job_id)
+                    .values(**updates)
+                    .execution_options(synchronize_session="fetch")
+                )
+                await session.execute(stmt)
+                result = await session.execute(
+                    select(CronJob).where(col(CronJob.job_id) == job_id)
+                )
+                return result.scalar_one_or_none()
+
+    async def delete_cron_job(self, job_id: str) -> None:
+        async with self.get_db() as session:
+            session: AsyncSession
+            async with session.begin():
+                await session.execute(
+                    delete(CronJob).where(col(CronJob.job_id) == job_id)
+                )
+
+    async def get_cron_job(self, job_id: str) -> CronJob | None:
+        async with self.get_db() as session:
+            session: AsyncSession
+            result = await session.execute(
+                select(CronJob).where(col(CronJob.job_id) == job_id)
+            )
+            return result.scalar_one_or_none()
+
+    async def list_cron_jobs(self, job_type: str | None = None) -> list[CronJob]:
+        async with self.get_db() as session:
+            session: AsyncSession
+            query = select(CronJob)
+            if job_type:
+                query = query.where(col(CronJob.job_type) == job_type)
+            query = query.order_by(desc(CronJob.created_at))
+            result = await session.execute(query)
+            return list(result.scalars().all())

astrbot/core/event_bus.py

@@ -54,7 +54,6 @@ class EventBus:
             event (AstrMessageEvent): 事件对象
 
         """
-        event.trace.record("event_dispatch", config_name=conf_name)
         # 如果有发送者名称: [平台名] 发送者名称/发送者ID: 消息概要
         if event.get_sender_name():
             logger.info(

astrbot/core/message/message_event_result.py

@@ -9,6 +9,7 @@ from astrbot.core.message.components import (
     AtAll,
     BaseMessageComponent,
     Image,
+    Json,
     Plain,
 )
 
@@ -117,9 +118,26 @@ class MessageChain:
         self.use_t2i_ = use_t2i
         return self
 
-    def get_plain_text(self) -> str:
-        """获取纯文本消息。这个方法将获取 chain 中所有 Plain 组件的文本并拼接成一条消息。空格分隔。"""
-        return " ".join([comp.text for comp in self.chain if isinstance(comp, Plain)])
+    def get_plain_text(self, with_other_comps_mark: bool = False) -> str:
+        """获取纯文本消息。这个方法将获取 chain 中所有 Plain 组件的文本并拼接成一条消息。空格分隔。
+
+        Args:
+            with_other_comps_mark (bool): 是否在纯文本中标记其他组件的位置
+        """
+        if not with_other_comps_mark:
+            return " ".join(
+                [comp.text for comp in self.chain if isinstance(comp, Plain)]
+            )
+        else:
+            texts = []
+            for comp in self.chain:
+                if isinstance(comp, Plain):
+                    texts.append(comp.text)
+                elif isinstance(comp, Json):
+                    texts.append(f"{comp.data}")
+                else:
+                    texts.append(f"[{comp.__class__.__name__}]")
+            return " ".join(texts)
 
     def squash_plain(self):
         """将消息链中的所有 Plain 消息段聚合到第一个 Plain 消息段中。"""