@dcrays/dcgchat 0.2.34 → 0.3.19

package/src/cron.ts

@@ -0,0 +1,174 @@
+import path from 'node:path'
+import fs from 'node:fs'
+import type { IMsgParams } from './types.js'
+import { mergeDefaultParams, sendEventMessage, sendFinal } from './transport.js'
+import { getCronMessageId, getWorkspaceDir, removeCronMessageId, setCronMessageId, setMsgStatus } from './utils/global.js'
+import { ossUpload } from './request/oss.js'
+import { dcgLogger } from './utils/log.js'
+import { sendMessageToGateway } from './gateway/socket.js'
+import { getCurrentSessionKey, getEffectiveMsgParams } from './utils/params.js'
+
+export function getCronJobsPath(): string {
+  const workspaceDir = getWorkspaceDir()
+  const cronDir = workspaceDir.replace('workspace', 'cron')
+  return path.join(cronDir, 'jobs.json')
+}
+
+type CronJobsFile = {
+  version?: number
+  jobs?: Array<{ id?: string; sessionKey?: string }>
+}
+
+/**
+ * 在 `jobPath` 指向的 jobs.json（通常为 getCronJobsPath()）中按 id 查找任务并返回其 sessionKey。
+ */
+export function readCronJobSessionKey(jobPath: string, jobId: string): string | null {
+  const id = jobId?.trim()
+  if (!id) return null
+  if (!fs.existsSync(jobPath)) {
+    dcgLogger(`readCronJobSessionKey: file not found ${jobPath}`, 'error')
+    return null
+  }
+  try {
+    const raw = fs.readFileSync(jobPath, 'utf8')
+    const data = JSON.parse(raw) as CronJobsFile
+    const job = (data.jobs ?? []).find((j) => j.id === id)
+    const sk = job?.sessionKey?.trim()
+    return sk || null
+  } catch (e) {
+    dcgLogger(`readCronJobSessionKey: failed to read ${jobPath}: ${String(e)}`, 'error')
+    return null
+  }
+}
+
+function msgParamsToCtx(p: IMsgParams): IMsgParams | null {
+  if (!p?.botToken) return null
+  return p
+}
+
+const CRON_UPLOAD_DEBOUNCE_MS = 6600
+
+/** 待合并的上传上下文（短时间内多次调用只保留最后一次） */
+let pendingCronUploadCtx: IMsgParams | null = null
+let cronUploadFlushTimer: ReturnType<typeof setTimeout> | null = null
+
+async function runCronJobsUpload(msgCtx: IMsgParams): Promise<void> {
+  const jobPath = getCronJobsPath()
+  if (fs.existsSync(jobPath)) {
+    try {
+      const url = await ossUpload(jobPath, msgCtx.botToken ?? '', 0)
+      dcgLogger(`定时任务创建成功: ${url}`)
+      if (!msgCtx.sessionKey) {
+        dcgLogger(`runCronJobsUpload: missing sessionKey ${JSON.stringify(msgCtx)} on msgCtx`, 'error')
+        return
+      }
+      sendEventMessage(url, msgCtx.sessionKey)
+    } catch (error) {
+      dcgLogger(`${jobPath} upload failed: ${error}`, 'error')
+    }
+  } else {
+    dcgLogger(`${jobPath} not found`, 'error')
+  }
+}
+
+function flushCronUploadQueue(): void {
+  cronUploadFlushTimer = null
+  const ctx = pendingCronUploadCtx
+  pendingCronUploadCtx = null
+  if (!ctx) return
+  void runCronJobsUpload(ctx)
+}
+
+/**
+ * 将 jobs.json 同步到 OSS 并推送事件。30s 内多次调用合并为一次上传；定时触发后清空待处理项，避免重复执行。
+ * @param msgCtx 可选；省略时使用当前会话 getEffectiveMsgParams(sessionKey) 快照
+ */
+export function sendDcgchatCron(): void {
+  const ctx = msgParamsToCtx(getEffectiveMsgParams(getCurrentSessionKey() ?? ''))
+  if (!ctx) {
+    dcgLogger('sendDcgchatCron: no message context (missing token / params)', 'error')
+    return
+  }
+  pendingCronUploadCtx = ctx
+  if (cronUploadFlushTimer !== null) {
+    clearTimeout(cronUploadFlushTimer)
+  }
+  cronUploadFlushTimer = setTimeout(flushCronUploadQueue, CRON_UPLOAD_DEBOUNCE_MS)
+}
+
+/**
+ * 通过 OpenClaw CLI 删除定时任务（走 Gateway，与内存状态一致）。
+ * 文档：运行中请勿手改 jobs.json，应使用 `openclaw cron rm` 或工具 API。
+ */
+export const onRemoveCronJob = async (jobId: string) => {
+  const id = jobId?.trim()
+  if (!id) {
+    dcgLogger('onRemoveCronJob: empty jobId', 'error')
+    return
+  }
+  sendMessageToGateway(JSON.stringify({ method: 'cron.remove', params: { id: jobId } }))
+}
+export const onDisabledCronJob = async (jobId: string) => {
+  const id = jobId?.trim()
+  if (!id) {
+    dcgLogger('onRemoveCronJob: empty jobId', 'error')
+    return
+  }
+  sendMessageToGateway(JSON.stringify({ method: 'cron.update', params: { id: jobId, patch: { enabled: false } } }))
+}
+export const onEnabledCronJob = async (jobId: string) => {
+  const id = jobId?.trim()
+  if (!id) {
+    dcgLogger('onRemoveCronJob: empty jobId', 'error')
+    return
+  }
+  sendMessageToGateway(JSON.stringify({ method: 'cron.update', params: { id: jobId, patch: { enabled: true } } }))
+}
+export const onRunCronJob = async (jobId: string, messageId: string) => {
+  const id = jobId?.trim()
+  if (!id) {
+    dcgLogger('onRemoveCronJob: empty jobId', 'error')
+    return
+  }
+  const jobPath = getCronJobsPath()
+  const sessionKey = readCronJobSessionKey(jobPath, jobId) || ''
+  if (!sessionKey) {
+    dcgLogger(`finishedDcgchatCron: no sessionKey for job id=${id}`, 'error')
+    return
+  }
+  setCronMessageId(sessionKey, messageId)
+  sendMessageToGateway(JSON.stringify({ method: 'cron.run', params: { id: jobId } }))
+}
+export const finishedDcgchatCron = async (jobId: string) => {
+  const id = jobId?.trim()
+  if (!id) {
+    dcgLogger('finishedDcgchatCron: empty jobId', 'error')
+    return
+  }
+  const jobPath = getCronJobsPath()
+  const sessionKey = readCronJobSessionKey(jobPath, id)
+  if (!sessionKey) {
+    dcgLogger(`finishedDcgchatCron: no sessionKey for job id=${id}`, 'error')
+    return
+  }
+  const outboundCtx = getEffectiveMsgParams(sessionKey)
+  const messageId = getCronMessageId(sessionKey)
+  if (outboundCtx?.sessionId) {
+    const newCtx = messageId ? { ...outboundCtx, messageId } : outboundCtx
+    sendFinal(newCtx, 'cron send')
+  } else {
+    const sessionInfo = sessionKey.split(':')
+    const sessionId = sessionInfo.at(-1) ?? ''
+    const agentId = sessionInfo.at(-2) ?? ''
+    const merged = mergeDefaultParams({
+      agentId: agentId,
+      sessionId: `${sessionId}`,
+      messageId: messageId,
+      is_finish: -1,
+      real_mobook: !sessionId ? 1 : ''
+    })
+    sendFinal(merged, 'cron send')
+  }
+  removeCronMessageId(sessionKey)
+  dcgLogger(`finishedDcgchatCron: job=${id} sessionKey=${sessionKey}`)
+}

package/src/cronToolCall.ts

@@ -0,0 +1,187 @@
+import { channelInfo, ENV } from './utils/constant.js'
+/**
+ * cron-delivery-guard — 定时任务投递守护插件
+ *
+ * 核心机制：通过 before_tool_call 钩子拦截 cron 工具调用，
+ * 当 delivery.mode 为 "announce" 且未指定 channel 时，
+ * 自动注入 bestEffort: true，使投递失败时静默降级，
+ * 不影响 cron 执行结果的保存。
+ *
+ * 背景：
+ * - 定时任务的 delivery 设为 announce 模式，如果没有指定 channel，
+ *   投递可能因找不到有效渠道而失败
+ * - bestEffort: true 让框架在投递失败时不报错，避免丢失执行结果
+ */
+
+import { dcgLogger } from './utils/log.js'
+
+const LOG_TAG = 'cron-delivery-guard'
+
+// ---- 类型定义 ----
+
+interface ToolCallEvent {
+  toolName: string
+  toolCallId: string
+  params: Record<string, unknown>
+  result?: { content: string }
+}
+
+interface HookContext {
+  agentId: string
+  sessionKey: string
+}
+
+interface BeforeToolCallResult {
+  block?: boolean
+  blockReason?: string
+  params?: Record<string, unknown>
+}
+
+// ---- delivery 类型 ----
+
+interface CronDelivery {
+  mode?: string
+  channel?: string
+  to?: string
+  bestEffort?: boolean
+  [key: string]: unknown
+}
+/**
+ * 解析 OpenClaw mobook direct 会话 key。
+ * 形如 `agent:main:mobook:direct:14:5466`（大小写不敏感，与路由 toLowerCase 一致）
+ * - 倒数第二段：account / peer（delivery.accountId）
+ * - 最后一段：会话 id（delivery.to）
+ */
+export function formatterSessionKey(sessionKey: string): { agentId: string; sessionId: string } {
+  const parts = sessionKey.split(':').filter((s) => s.length > 0)
+  const norm = parts.map((s) => s.toLowerCase())
+  if (parts.length >= 6 && norm[0] === 'agent' && norm[2] === 'mobook' && norm[3] === 'direct') {
+    return {
+      agentId: parts[4] ?? '',
+      sessionId: parts[5] ?? ''
+    }
+  }
+  if (parts.length >= 2) {
+    return {
+      agentId: parts[parts.length - 2] ?? '',
+      sessionId: parts[parts.length - 1] ?? ''
+    }
+  }
+  return { agentId: '', sessionId: '' }
+}
+
+// ---- 辅助函数 ----
+
+/**
+ * 判断是否为 cron 工具调用
+ */
+function isCronTool(toolName: string): boolean {
+  return toolName === 'cron'
+}
+
+/**
+ * 从 cron 参数中提取 delivery 配置
+ * cron 工具的参数结构可能是:
+ * - params.delivery (顶层)
+ * - params.job.delivery (嵌套在 job 中)
+ */
+function extractDelivery(params: Record<string, unknown>): CronDelivery | null {
+  // 尝试顶层 delivery
+  if (params.delivery && typeof params.delivery === 'object') {
+    return params.delivery as CronDelivery
+  }
+
+  // 尝试 job.delivery
+  const job = params.job as Record<string, unknown> | undefined
+  if (job?.delivery && typeof job.delivery === 'object') {
+    return job.delivery as CronDelivery
+  }
+
+  // 尝试 payload 中的 deliver 相关字段 (兼容 qqbot-cron 风格)
+  const payload = job?.payload as Record<string, unknown> | undefined
+  if (payload?.deliver === true && payload.channel === undefined) {
+    // payload 风格: { deliver: true, channel?: string }
+    // 这种情况不是 delivery 对象，跳过
+    return null
+  }
+
+  return null
+}
+
+/**
+ * 判断 delivery 是否需要注入 bestEffort
+ * 条件: mode 为 "announce" 且没有 channel
+ */
+function needsBestEffort(delivery: CronDelivery): boolean {
+  return delivery.mode === 'announce' && !delivery.channel && !delivery.bestEffort
+}
+
+/**
+ * 深拷贝 params 并注入 bestEffort: true
+ */
+function injectBestEffort(params: Record<string, unknown>, sk: string): Record<string, unknown> {
+  const newParams = JSON.parse(JSON.stringify(params)) as Record<string, unknown>
+  const { agentId, sessionId } = formatterSessionKey(sk)
+  // 顶层 delivery
+  if (newParams.delivery && typeof newParams.delivery === 'object') {
+    ;(newParams.delivery as CronDelivery).bestEffort = true
+    ;(newParams.delivery as CronDelivery).to = `dcg-cron:${sk}`
+    ;(newParams.delivery as CronDelivery).accountId = agentId
+    ;(newParams.delivery as CronDelivery).channel = "dcgchat"
+    newParams.sessionKey = sk
+    return newParams
+  }
+
+  // job.delivery
+  const job = newParams.job as Record<string, unknown> | undefined
+  if (job?.delivery && typeof job.delivery === 'object') {
+    ;(job.delivery as CronDelivery).bestEffort = true
+    ;(newParams.delivery as CronDelivery).to = `dcg-cron:${sk}`
+    ;(newParams.delivery as CronDelivery).accountId = agentId
+    ;(newParams.delivery as CronDelivery).channel = "dcgchat"
+    newParams.sessionKey = sk
+    return newParams
+  }
+
+  return newParams
+}
+
+export function cronToolCall(event: { toolName: any; params: any; toolCallId: any }, sk: string) {
+  const { toolName, params, toolCallId } = event
+
+  // 仅处理 cron 工具
+  if (isCronTool(toolName)) {
+    const delivery = extractDelivery(params)
+    if (!delivery) {
+      dcgLogger(`[${LOG_TAG}] cron call (${toolCallId}) has no delivery config, skip.`)
+      return params
+    }
+    if (!needsBestEffort(delivery)) {
+      dcgLogger(
+        `[${LOG_TAG}] cron call (${toolCallId}) delivery does not need bestEffort ` +
+          `(mode=${String(delivery.mode)}, channel=${String(delivery.channel)}, bestEffort=${String(delivery.bestEffort)}), skip.`
+      )
+      return params
+    }
+
+    // ★ 核心：注入 bestEffort: true
+    const newParams = injectBestEffort(params, sk)
+    dcgLogger(
+      `[${LOG_TAG}] cron call (${toolCallId}) injected bestEffort=true ` +
+        `(mode=announce, no channel). delivery=${JSON.stringify(newParams.delivery || (newParams.job as Record<string, unknown>)?.delivery)}`
+    )
+
+    return { params: newParams }
+  } else if (toolName === 'exec') {
+    if (params.command.indexOf('cron create') > -1 || params.command.indexOf('cron add') > -1) {
+      const newParams = JSON.parse(JSON.stringify(params)) as Record<string, unknown>
+      newParams.command =
+        params.command.replace('--json', '') + `  --session-key ${sk}  --channel ${"dcgchat"}  --to dcg-cron:${sk} --json`
+      return { params: newParams }
+    } else {
+      return params
+    }
+  }
+
+  return params
+}