@dcrays/dcgchat 0.4.29 → 0.5.0

package/src/tools/messageTool.ts

@@ -1,224 +0,0 @@
-import fs from 'node:fs'
-import os from 'node:os'
-import path from 'node:path'
-import type { AnyAgentTool } from 'openclaw/plugin-sdk'
-import { jsonResult } from 'openclaw/plugin-sdk'
-import { sendDcgchatMedia } from '../channel.js'
-import { getOutboundMsgParams } from '../utils/params.js'
-import { sendText } from '../transport.js'
-
-/** 与 `registerTool` 工厂入参一致（主包未导出 `OpenClawPluginToolContext` 时仅用所需字段）。 */
-export type DcgchatMessageToolContext = {
-  sessionKey?: string
-  workspaceDir?: string
-}
-
-/** 统一为 POSIX 风格斜杠，便于跨平台判断（不改变语义，仅用于匹配）。 */
-function toPosixPath(p: string): string {
-  return path.normalize(p.trim()).replace(/\\/g, '/')
-}
-
-/** `filepath` 解析后在 `rootDir` 内或等于 `rootDir`（防 `..` 逃逸）。 */
-function isPathInsideDir(filepath: string, rootDir: string): boolean {
-  const root = path.resolve(rootDir)
-  const resolved = path.resolve(filepath)
-  const rel = path.relative(root, resolved)
-  if (rel.startsWith('..') || path.isAbsolute(rel)) return false
-  return true
-}
-
-/**
- * 允许发送的路径：
- * - 当前 Agent 工作区根及其子路径（`workspaceDir`，如 ~/.openclaw/workspace-xxx/output/...）；
- * - 兼容旧挂载：Unix `/workspace`、`/mobook`；Windows 盘符下 `workspace`、`mobook`。
- */
-function isSafePath(filepath: string, workspaceDir?: string): boolean {
-  const ws = workspaceDir?.trim()
-  if (ws && isPathInsideDir(filepath, ws)) return true
-  const p = toPosixPath(filepath)
-  if (p.startsWith('/workspace/') || p === '/workspace') return true
-  if (p.startsWith('/mobook/') || p === '/mobook') return true
-  return /^[A-Za-z]:\/(workspace|mobook)(\/|$)/.test(p)
-}
-
-/** 同一路径在 Windows 上可能大小写不同，用于 Set 去重。 */
-function pathKey(filepath: string): string {
-  const n = path.normalize(filepath.trim())
-  return os.platform() === 'win32' ? n.toLowerCase() : n
-}
-
-const fileType1 = ['.webp', '.gif', '.bmp', '.doc', '.docx', '.xls', '.xlsx', '.ppt', '.pptx', '.pdf', '.txt', '.rtf', '.odt', '.json']
-const fileType2 = ['.xml', '.csv', '.yaml', '.yml', '.html', '.htm', '.md', '.markdown', '.css', '.js', '.ts', '.png', '.jpg', '.jpeg']
-const fileType3 = ['.zip', '.rar', '.7z', '.tar', '.gz', '.bz2', '.xz', '.exe', '.dmg', '.pkg', '.apk', '.ipa', '.log', '.dat', '.bin']
-const fileType4 = ['.svg', '.ico', '.mp3', '.wav', '.ogg', '.aac', '.m4a', '.mp4', '.avi', '.mov', '.wmv', '.flv', '.mkv', '.webm']
-const SAFE_EXTENSIONS = new Set([...fileType1, ...fileType2, ...fileType3, ...fileType4])
-
-const messageToolParameters = {
-  type: 'object',
-  additionalProperties: false,
-  properties: {
-    target: {
-      type: 'string',
-      description: '目标会话键（sessionKey），必须与当前会话 SessionKey 一致，禁止填写 userId。'
-    },
-    content: {
-      type: 'string',
-      description: '发送文本内容'
-    },
-    media: {
-      type: 'array',
-      description: '发送附件',
-      items: {
-        type: 'object',
-        additionalProperties: false,
-        properties: {
-          file: {
-            type: 'string',
-            description:
-              '文件绝对路径：须在「当前 Agent 工作区」目录下（如 /root/.openclaw/workspace-xxx/output/28337/slices_result.json），或为兼容环境的 /workspace/、/mobook/（Windows 盘符下 workspace、mobook）'
-          }
-        },
-        required: ['file']
-      }
-    }
-  },
-  anyOf: [{ required: ['content'] }, { required: ['media'] }]
-}
-
-/** 从正文提取可发送的文件路径（固定挂载 + 当前工作区前缀）。 */
-function extractPaths(text: string | undefined, workspaceDir?: string): string[] {
-  if (!text) return []
-  const unix = text.match(/\/workspace\/[^\s]+|\/mobook\/[^\s]+/g) ?? []
-  const win = text.match(/[A-Za-z]:[/\\](?:workspace|mobook)[/\\][^\s]+/g) ?? []
-  const underWs: string[] = []
-  const ws = workspaceDir?.trim()
-  if (ws) {
-    const variants = new Set<string>()
-    variants.add(ws)
-    variants.add(toPosixPath(ws))
-    if (path.sep === '\\') variants.add(ws.replace(/\//g, '\\'))
-    for (const prefix of variants) {
-      if (!prefix) continue
-      let from = 0
-      while (from < text.length) {
-        const i = text.indexOf(prefix, from)
-        if (i === -1) break
-        let end = i + prefix.length
-        while (end < text.length && !/\s/.test(text[end])) end++
-        underWs.push(text.slice(i, end))
-        from = i + 1
-      }
-    }
-  }
-  return [...new Set([...unix, ...win, ...underWs])]
-}
-
-function isSafeFile(filepath: string) {
-  if (!fs.existsSync(filepath)) return false
-  const stat = fs.statSync(filepath)
-  if (!stat.isFile()) return false
-  if (stat.size === 0) return false
-  const ext = path.extname(filepath).toLowerCase()
-  return SAFE_EXTENSIONS.has(ext)
-}
-
-/**
- * 书灵墨宝出站消息工具：须符合 OpenClaw `AgentTool`（execute 返回 `AgentToolResult`）。
- * 工具名使用 `dcgchat_message`，避免与核心内置 `message` 冲突。
- * 通过注册时的 `OpenClawPluginToolContext.sessionKey` 出站，不再使用非标准的 `execute(args, ctx)`。
- */
-export function createDcgchatMessageTool(pluginCtx: DcgchatMessageToolContext): AnyAgentTool {
-  return {
-    name: 'dcgchat_message',
-    label: 'dcgchat_message',
-    description: `
-      向用户发送消息。
-      若传 target，target 必须是 sessionKey，不能是 userId。
-      如果发送附件：必须使用 media 字段
-      文件路径须在当前 Agent 工作区目录下（随部署变化，如 ~/.openclaw/workspace-xxx/...），或为兼容环境的 /workspace/、/mobook/（Windows 盘符下 workspace、mobook）。
-      禁止在正文中直接输出可访问路径（应通过 media 发送）
-    `,
-    parameters: messageToolParameters,
-    execute: async (_toolCallId, args, signal) => {
-      if (signal?.aborted) {
-        const err = new Error('Message send aborted')
-        err.name = 'AbortError'
-        throw err
-      }
-
-      const sessionKey = pluginCtx.sessionKey?.trim()
-      if (!sessionKey) {
-        return jsonResult({ error: '缺少 sessionKey，无法向当前会话发送消息' })
-      }
-
-      try {
-        const sentFiles = new Set<string>()
-        const sentKeys = new Set<string>()
-        const workspaceDir = pluginCtx.workspaceDir
-
-        if (args.media?.length) {
-          for (const media of args.media) {
-            const filepath = media.file
-            if (!filepath) continue
-            if (!isSafePath(filepath, workspaceDir)) continue
-            if (!isSafeFile(filepath)) continue
-            const key = pathKey(filepath)
-            if (sentKeys.has(key)) continue
-
-            await sendDcgchatMedia({ sessionKey, mediaUrl: filepath })
-            sentFiles.add(filepath)
-            sentKeys.add(key)
-          }
-        }
-
-        const fallbackPaths = extractPaths(args.content, workspaceDir)
-        for (const filepath of fallbackPaths) {
-          if (!isSafePath(filepath, workspaceDir)) continue
-          if (!isSafeFile(filepath)) continue
-          const key = pathKey(filepath)
-          if (sentKeys.has(key)) continue
-
-          await sendDcgchatMedia({ sessionKey, mediaUrl: filepath })
-          sentFiles.add(filepath)
-          sentKeys.add(key)
-        }
-
-        if (args.media?.length && sentFiles.size === 0) {
-          return jsonResult({
-            success: false,
-            error:
-              '未能发送任何附件：路径须位于当前 Agent 工作区，或为 /workspace/、/mobook/ 下的真实文件（非空、扩展名在白名单内）。',
-            sentMediaCount: 0
-          })
-        }
-
-        let content = args.content ?? ''
-        for (const filepath of sentFiles) {
-          const posix = toPosixPath(filepath)
-          const variants = posix === filepath ? [filepath] : [filepath, posix]
-          const seen = new Set<string>()
-          for (const v of variants) {
-            if (!v || seen.has(v)) continue
-            seen.add(v)
-            content = content.split(v).join('')
-          }
-        }
-        content = content.trim()
-
-        if (content.length > 0) {
-          const msgCtx = getOutboundMsgParams(sessionKey)
-          sendText(content, msgCtx)
-        }
-
-        return jsonResult({
-          success: true,
-          sentMediaCount: sentFiles.size
-        })
-      } catch (err) {
-        return jsonResult({
-          error: err instanceof Error ? err.message : String(err)
-        })
-      }
-    }
-  }
-}

package/src/transport.ts

@@ -1,203 +0,0 @@
-import { clearSentMediaKeys, getWsConnection } from './utils/global.js'
-import { dcgLogger } from './utils/log.js'
-import type { IMsgParams } from './types.js'
-import { getEffectiveMsgParams, getParamsDefaults } from './utils/params.js'
-
-/** 用 sessionKey 从 map 取参，再合并 overrides（channel 出站、媒体等） */
-export function mergeSessionParams(sessionKey: string, overrides?: Partial<IMsgParams>): IMsgParams {
-  const base = getEffectiveMsgParams(sessionKey)
-  if (!overrides) return base
-  return { ...base, ...overrides }
-}
-export function mergeDefaultParams(overrides?: Partial<IMsgParams>): IMsgParams {
-  const base = getParamsDefaults()
-  if (!overrides) return base
-  return { ...base, ...overrides }
-}
-
-export type InboundMsgForContext = {
-  _userId: number | string
-  content: {
-    bot_token: string
-    domain_id?: string
-    app_id?: string
-    bot_id?: string
-    agent_id?: string
-    session_id: string
-    message_id: string
-  }
-}
-
-export type OpenclawBotChatEnvelope = {
-  messageType: 'openclaw_bot_chat'
-  _userId: number | undefined
-  source: 'client'
-  content: Record<string, unknown>
-}
-
-function isInboundWire(arg: unknown): arg is InboundMsgForContext {
-  return Boolean(arg && typeof arg === 'object' && '_userId' in arg && 'content' in arg)
-}
-
-/** 下行 WebSocket 帧 → 内部上下文（字段缺省用 channel 配置补） */
-function inboundToCtx(msg: InboundMsgForContext, d: IMsgParams): IMsgParams {
-  const c = msg.content
-  return {
-    userId: Number(msg._userId ?? d.userId),
-    botToken: c.bot_token ?? d.botToken,
-    domainId: String(c.domain_id ?? d.domainId),
-    appId: String(c.app_id ?? d.appId),
-    botId: c.bot_id,
-    agentId: c.agent_id,
-    sessionId: c.session_id,
-    messageId: c.message_id
-  }
-}
-
-/** 上行：与配置合并缺省后再 `...ctx` 覆盖（原 wsSendRaw） */
-function mergeOutboundWithDefaults(ctx: IMsgParams, d: IMsgParams): IMsgParams {
-  return {
-    userId: Number(ctx.userId ?? d.userId),
-    botToken: ctx.botToken ?? d.botToken,
-    domainId: String(ctx.domainId ?? d.domainId),
-    appId: String(ctx.appId ?? d.appId),
-    ...ctx
-  }
-}
-
-/**
- * 组装完整 wire `content` 对象：先写会话/机器人基础字段（回落到 d），再合并调用方传入的 payload。
- * `content` 在使用处构造（如 response、state、files），同名键可覆盖基础字段。
- */
-export function buildWireContent(base: IMsgParams, d: IMsgParams, content: Record<string, unknown>): Record<string, unknown> {
-  const resolvedBotToken = base.botToken ?? d.botToken
-  const domain = base.domainId ?? d.domainId
-  const app = base.appId ?? d.appId
-  return {
-    bot_token: base.botToken || resolvedBotToken,
-    domain_id: base.domainId || domain,
-    app_id: base.appId || app,
-    bot_id: base.botId,
-    agent_id: base.agentId,
-    session_id: base.sessionId,
-    message_id: base.messageId || Date.now().toString(),
-    ...content
-  }
-}
-
-/** 上行：在已合并的 ctx 上套 openclaw_bot_chat 信封（messageType / _userId / source + content） */
-function buildOutboundOpenclawBotChatEnvelope(
-  ctx: IMsgParams,
-  content: Record<string, unknown>,
-  opts?: { mergeChannelDefaults?: boolean }
-): OpenclawBotChatEnvelope {
-  const d = getParamsDefaults()
-  const base = opts?.mergeChannelDefaults ? mergeOutboundWithDefaults(ctx, d) : ctx
-  return {
-    messageType: 'openclaw_bot_chat',
-    _userId: base.userId,
-    source: 'client',
-    content: buildWireContent(base, d, content)
-  }
-}
-
-/**
- * 下行解析为 DcgchatMsgContext，或上行组装 openclaw_bot_chat 信封。
- * 上行时 `content` 由调用方传入；基础参数来自 `ctx` 与 `getParamsDefaults()`（可选 mergeChannelDefaults，同原 wsSendRaw）。
- */
-export function buildOpenclawBotChat(msg: InboundMsgForContext): IMsgParams
-export function buildOpenclawBotChat(
-  ctx: IMsgParams,
-  content: Record<string, unknown>,
-  opts?: { mergeChannelDefaults?: boolean }
-): OpenclawBotChatEnvelope
-export function buildOpenclawBotChat(
-  arg1: InboundMsgForContext | IMsgParams,
-  arg2?: Record<string, unknown>,
-  opts?: { mergeChannelDefaults?: boolean }
-): IMsgParams | OpenclawBotChatEnvelope {
-  const d = getParamsDefaults()
-
-  if (arg2 === undefined && isInboundWire(arg1)) {
-    return inboundToCtx(arg1, d)
-  }
-
-  const ctx = arg1 as IMsgParams
-  return buildOutboundOpenclawBotChatEnvelope(ctx, arg2 ?? {}, opts)
-}
-
-export function isWsOpen(): boolean {
-  const isOpen = getWsConnection()?.readyState === WebSocket.OPEN
-  if (!isOpen) {
-    dcgLogger(`server socket not ready ${getWsConnection()?.readyState}`, 'error')
-  }
-  return isOpen
-}
-
-/**
- * 聊天流路径：content 单独 JSON.stringify（双重编码），符合 dcgchat 协议。
- * `ctx` 须由调用方用 getEffectiveMsgParams(sessionKey) 等解析好；`content` 为完整业务 payload。
- */
-export function wsSend(ctx: IMsgParams, content: Record<string, unknown>): boolean {
-  const ws = getWsConnection()
-  if (ws?.readyState !== WebSocket.OPEN) return false
-  const envelope = buildOpenclawBotChat(ctx, content)
-  ws.send(JSON.stringify({ ...envelope, content: JSON.stringify(envelope.content) }))
-  return true
-}
-
-/**
- * 媒体 / channel 出站：content 保持嵌套对象（单次编码）。
- * `ctx` 须由调用方解析（如需合并覆盖可先 mergeSessionParams）。
- */
-export function wsSendRaw(ctx: IMsgParams, content: Record<string, unknown>, isLog = true): boolean {
-  const ws = getWsConnection()
-  if (ws?.readyState !== WebSocket.OPEN) {
-    dcgLogger(`server socket not ready ${ws?.readyState}`, 'error')
-    return false
-  }
-  const envelope = buildOpenclawBotChat(ctx, content, { mergeChannelDefaults: true })
-  ws.send(JSON.stringify(envelope))
-  if (isLog) {
-    dcgLogger('已发送：' + JSON.stringify(envelope))
-  }
-  return true
-}
-
-export function sendChunk(text: string, ctx: IMsgParams, chunkIdx: number): boolean {
-  return wsSend(ctx, { response: text, state: 'chunk', chunk_idx: chunkIdx })
-}
-
-export function sendFinal(ctx: IMsgParams, tag: string): boolean {
-  dcgLogger(` message handling complete state: to=${ctx.sessionId} final tag:${tag}`)
-  clearSentMediaKeys(ctx.sessionId)
-  return wsSend(ctx, { response: '', state: 'final' })
-}
-
-export function sendText(text: string, ctx: IMsgParams, event?: Record<string, unknown>): boolean {
-  return wsSend(ctx, { response: text, ...event })
-}
-
-export function sendError(errorMsg: string, ctx: IMsgParams): boolean {
-  return wsSend(ctx, { response: `[错误] ${errorMsg}`, state: 'final' })
-}
-
-export function sendEventMessage(params: Record<string, string> = {}) {
-  const ctx = getParamsDefaults()
-  const ws = getWsConnection()
-  if (isWsOpen()) {
-    ws?.send(
-      JSON.stringify({
-        messageType: 'openclaw_bot_event',
-        source: 'client',
-        content: {
-          bot_token: ctx.botToken,
-          domain_id: ctx.domainId,
-          app_id: ctx.appId,
-          bot_id: ctx.botId,
-          ...params
-        }
-      })
-    )
-  }
-}

package/src/types.ts

@@ -1,139 +0,0 @@
-/**
- * 插件配置（channels.dcgchat 下的字段）
- */
-export type DcgchatConfig = {
-  enabled?: boolean
-  /** 后端 WebSocket 地址，例如 ws://localhost:8080/openclaw/ws */
-  wsUrl?: string
-  /** 连接认证 token */
-  botToken?: string
-  /** 用户标识 */
-  userId?: string
-  domainId?: string
-  appId?: string
-  /**
-   * 内置 `message` 工具走 OpenClaw 目标解析：`true`（默认）时仅将符合 sessionKey 形态的字符串视为合法 target，
-   * 纯数字（WS userId 等）会解析失败；设为 `false` 恢复旧版宽松行为（不推荐）。
-   */
-  strictMessageToolTarget?: boolean
-}
-
-export type ResolvedDcgchatAccount = {
-  accountId: string
-  enabled: boolean
-  configured: boolean
-  wsUrl: string
-  botToken: string
-  userId: string
-  domainId?: string
-  appId?: string
-}
-
-/**
- * 下行消息：后端 → OpenClaw（用户发的消息）
- */
-// export type InboundMessage = {
-//   type: "message";
-//   userId: string;
-//   text: string;
-// };
-export type InboundMessage = {
-  messageType: string // "openclaw_bot_chat",
-  _userId: number
-  source: string // 'server',
-  // content: string;
-  content: {
-    skills_scope: Record<string, any>[]
-    bot_token: string
-    agent_clone_code?: string
-    domain_id?: string
-    app_id?: string
-    bot_id?: string
-    agent_id?: string
-    session_id: string
-    real_mobook: string | number
-    message_id: string
-    text: string
-    files?: {
-      url: string
-      name: string
-    }[]
-  }
-}
-
-//  {"_userId":40,"content":"{\"bot_token\":\"sk_b7f8a3e1c5d24e6f8a1b3c4d5e6f7a8b\",\"session_id\":\"1\",\"message_id\":\"1\",\"text\":\"你好\"}","messageType":"openclaw_bot_chat","msgId":398599,"source":"server","title":"OPENCLAW机器人对话"}
-
-/**
- * 上行消息：OpenClaw → 后端（Agent 回复）
- */
-// export type OutboundReply = {
-//   type: "reply";
-//   userId: string;
-//   text: string;
-// };
-
-export type OutboundReply = {
-  messageType: string // "openclaw_bot_chat",
-  _userId: number // 100
-  source: string // 'client',
-  // content: string;
-  content: {
-    bot_token: string // ""
-    session_id: string // ""
-    message_id: string // ""
-    response: string // ""
-    state: string // final, chunk
-    domain_id?: string
-    app_id?: string
-    bot_id?: string
-    agent_id?: string
-    files?: { url: string; name: string }[]
-  }
-}
-
-export interface IResponse<T = unknown> {
-  /** 响应状态码 */
-  code?: number | string
-  /** 响应数据 */
-  data?: T
-  /** 响应消息 */
-  message?: string
-}
-
-export interface IStsToken {
-  bucket: string
-  endPoint: string
-  expiration: string
-  ossFileKey: string
-  policy: string
-  region: string
-  signature: string
-  sourceFileName: string
-  stsEndPoint: string
-  tempAccessKeyId: string
-  tempAccessKeySecret: string
-  tempSecurityToken: string
-  uploadDir: string
-  protocol: string
-}
-
-export interface IStsTokenReq {
-  sourceFileName: string
-  isPrivate: number
-}
-
-export interface IMsgParams {
-  userId?: number
-  botToken?: string
-  sessionId?: string
-  messageId?: string
-  domainId?: string
-  appId?: string
-  botId?: string
-  agentId?: string
-  /** 与 OpenClaw 路由一致，用于 map 与异步链路（工具 / HTTP / cron）对齐当前会话 */
-  sessionKey?: string
-  real_mobook?: string | number
-  is_finish?: number
-  message_tags?: Record<string, string>
-}

package/src/utils/constant.ts

@@ -1,7 +0,0 @@
-export const ENV: 'production' | 'test' | 'develop' = 'production'
-
-
-export const systemCommand = ['/new', '/status']
-export const stopCommand = ['/stop']
-
-export const ignoreToolCommand = ['/search', '/abort', '/queue interrupt', ...systemCommand, ...stopCommand]

package/src/utils/gatewayMsgHanlder.ts

@@ -1,55 +0,0 @@
-import type { GatewayEvent } from '../gateway/index.js'
-import { finishedDcgchatCron, sendDcgchatCron } from '../cron.js'
-import { dcgLogger } from './log.js'
-import { clearParamsMessage, getEffectiveMsgParams, getSessionKeyBySubAgentRunId } from './params.js'
-import { sendChunk, sendFinal, sendText } from '../transport.js'
-import { resetSubagentStateForRequesterSession } from '../tool.js'
-import { setMsgStatus } from './global.js'
-
-/**
- * 处理网关 event 帧的副作用（agent 流式输出、cron 同步），并构造供上层分发的 GatewayEvent。
- */
-export function handleGatewayEventMessage(msg: { event?: string; payload?: Record<string, unknown>; seq?: number }): GatewayEvent {
-  try {
-    // 子agent消息输出
-    if (msg.event === 'agent') {
-      const pl = msg.payload as { runId: string; data?: { delta?: unknown } }
-      const sessionKey = getSessionKeyBySubAgentRunId(pl.runId)
-      const outboundCtx = getEffectiveMsgParams(sessionKey)
-      if (pl.data?.delta) {
-        if (outboundCtx.sessionId) {
-          sendChunk(pl.data.delta as string, outboundCtx, 0)
-        }
-      }
-    }
-    // 定时任务
-    if (msg.event === 'cron') {
-      const p = msg.payload
-      dcgLogger(`[Gateway] 收到定时任务事件: ${JSON.stringify(p)}`)
-      if (p?.action === 'added') {
-        sendDcgchatCron(p?.jobId as string)
-      }
-      if (p?.action === 'updated') {
-        sendDcgchatCron(p?.jobId as string)
-      }
-      if (p?.action === 'removed') {
-        sendDcgchatCron(p?.jobId as string)
-      }
-      if (p?.action === 'finished' && p?.status === 'ok') {
-        const hasFileOutput = p.delivered === true && p.deliveryStatus === 'delivered'
-        let summary = p?.summary as string
-        if (summary.indexOf('HEARTBEAT_OK') >= 0 && summary !== 'HEARTBEAT_OK') {
-          summary = summary.replace('HEARTBEAT_OK', '')
-        }
-        finishedDcgchatCron(p?.jobId as string, summary, hasFileOutput)
-      }
-    }
-  } catch (error) {
-    dcgLogger(`[Gateway] 处理事件失败: ${error}`, 'error')
-  }
-  return {
-    type: msg.event as string,
-    payload: msg.payload,
-    seq: msg.seq as number | undefined
-  }
-}