@yanhaidao/wecom 2.2.4 → 2.2.5

package/src/shared/command-auth.ts

@@ -0,0 +1,101 @@
+import type { OpenClawConfig, PluginRuntime } from "openclaw/plugin-sdk";
+
+import type { WecomAccountConfig } from "../types.js";
+
+function normalizeWecomAllowFromEntry(raw: string): string {
+  return raw
+    .trim()
+    .toLowerCase()
+    .replace(/^wecom:/, "")
+    .replace(/^user:/, "")
+    .replace(/^userid:/, "");
+}
+
+function isWecomSenderAllowed(senderUserId: string, allowFrom: string[]): boolean {
+  const list = allowFrom.map((entry) => normalizeWecomAllowFromEntry(entry)).filter(Boolean);
+  if (list.includes("*")) return true;
+  const normalizedSender = normalizeWecomAllowFromEntry(senderUserId);
+  if (!normalizedSender) return false;
+  return list.includes(normalizedSender);
+}
+
+export async function resolveWecomCommandAuthorization(params: {
+  core: PluginRuntime;
+  cfg: OpenClawConfig;
+  accountConfig: WecomAccountConfig;
+  rawBody: string;
+  senderUserId: string;
+}): Promise<{
+  shouldComputeAuth: boolean;
+  dmPolicy: "pairing" | "allowlist" | "open" | "disabled";
+  senderAllowed: boolean;
+  authorizerConfigured: boolean;
+  commandAuthorized: boolean | undefined;
+  effectiveAllowFrom: string[];
+}> {
+  const { core, cfg, accountConfig, rawBody, senderUserId } = params;
+
+  const dmPolicy = (accountConfig.dm?.policy ?? "pairing") as "pairing" | "allowlist" | "open" | "disabled";
+  const configAllowFrom = (accountConfig.dm?.allowFrom ?? []).map((v) => String(v));
+
+  const shouldComputeAuth = core.channel.commands.shouldComputeCommandAuthorized(rawBody, cfg);
+  // WeCom channel currently does NOT support the `openclaw pairing` CLI workflow
+  // ("Channel wecom does not support pairing"). So we must not rely on pairing
+  // store approvals for command authorization here.
+  //
+  // Policy semantics:
+  // - open: commands are allowed for everyone by default (unless higher-level access-groups deny).
+  // - allowlist: commands require allowFrom entries.
+  // - pairing: treated the same as allowlist for WeCom (since pairing CLI is unsupported).
+  const effectiveAllowFrom = dmPolicy === "open" ? ["*"] : configAllowFrom;
+
+  const senderAllowed = isWecomSenderAllowed(senderUserId, effectiveAllowFrom);
+  const allowAllConfigured = effectiveAllowFrom.some((entry) => normalizeWecomAllowFromEntry(entry) === "*");
+  const authorizerConfigured = allowAllConfigured || effectiveAllowFrom.length > 0;
+  const useAccessGroups = cfg.commands?.useAccessGroups !== false;
+
+  const commandAuthorized = shouldComputeAuth
+    ? core.channel.commands.resolveCommandAuthorizedFromAuthorizers({
+      useAccessGroups,
+      authorizers: [{ configured: authorizerConfigured, allowed: senderAllowed }],
+    })
+    : undefined;
+
+  return {
+    shouldComputeAuth,
+    dmPolicy,
+    senderAllowed,
+    authorizerConfigured,
+    commandAuthorized,
+    effectiveAllowFrom,
+  };
+}
+
+export function buildWecomUnauthorizedCommandPrompt(params: {
+  senderUserId: string;
+  dmPolicy: "pairing" | "allowlist" | "open" | "disabled";
+  scope: "bot" | "agent";
+}): string {
+  const user = params.senderUserId || "unknown";
+  const policy = params.dmPolicy;
+  const scopeLabel = params.scope === "bot" ? "Bot（智能机器人）" : "Agent（自建应用）";
+  const dmPrefix = params.scope === "bot" ? "channels.wecom.bot.dm" : "channels.wecom.agent.dm";
+  const allowCmd = (value: string) => `openclaw config set ${dmPrefix}.allowFrom '${value}'`;
+  const policyCmd = (value: string) => `openclaw config set ${dmPrefix}.policy "${value}"`;
+
+  if (policy === "disabled") {
+    return [
+      `无权限执行命令（${scopeLabel} 已禁用：dm.policy=disabled）`,
+      `触发者：${user}`,
+      `管理员：${policyCmd("open")}（全放开）或 ${policyCmd("allowlist")}（白名单）`,
+    ].join("\n");
+  }
+  // WeCom 不支持 pairing CLI，因此这里统一给出“open / allowlist”两种明确的配置指令
+  return [
+    `无权限执行命令（入口：${scopeLabel}，userid：${user}）`,
+    `管理员全放开：${policyCmd("open")}`,
+    `管理员放行该用户：${policyCmd("allowlist")}`,
+    `然后设置白名单：${allowCmd(JSON.stringify([user]))}`,
+    `如果仍被拦截：检查 commands.useAccessGroups/访问组`,
+  ].join("\n");
+}

package/src/shared/xml-parser.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, test } from "vitest";
+
+import { extractContent, extractMediaId, extractMsgId } from "./xml-parser.js";
+
+describe("wecom xml-parser", () => {
+  test("extractContent is robust to non-string Content", () => {
+    const msg: any = { MsgType: "text", Content: { "#text": "hello", "@_foo": "bar" } };
+    expect(extractContent(msg)).toBe("hello");
+  });
+
+  test("extractContent handles array content", () => {
+    const msg: any = { MsgType: "text", Content: ["a", "b"] };
+    expect(extractContent(msg)).toBe("a\nb");
+  });
+
+  test("extractContent handles file messages", () => {
+    const msg: any = { MsgType: "file", MediaId: "MEDIA123" };
+    expect(extractContent(msg)).toBe("[文件消息]");
+  });
+
+  test("extractMediaId handles object MediaId", () => {
+    const msg: any = { MediaId: { "#text": "MEDIA123", "@_foo": "bar" } };
+    expect(extractMediaId(msg)).toBe("MEDIA123");
+  });
+
+  test("extractMsgId handles number MsgId", () => {
+    const msg: any = { MsgId: 123456789 };
+    expect(extractMsgId(msg)).toBe("123456789");
+  });
+});

package/src/shared/xml-parser.ts

@@ -35,6 +35,29 @@ export function extractFromUser(msg: WecomAgentInboundMessage): string {
     return String(msg.FromUserName ?? "");
 }
 
+/**
+ * 从 XML 中提取文件名（主要用于 file 消息）
+ */
+export function extractFileName(msg: WecomAgentInboundMessage): string | undefined {
+    const raw = (msg as any).FileName ?? (msg as any).Filename ?? (msg as any).fileName ?? (msg as any).filename;
+    if (raw == null) return undefined;
+    if (typeof raw === "string") return raw.trim() || undefined;
+    if (typeof raw === "number" || typeof raw === "boolean" || typeof raw === "bigint") return String(raw);
+    if (Array.isArray(raw)) {
+        const merged = raw.map((v) => (v == null ? "" : String(v))).join("\n").trim();
+        return merged || undefined;
+    }
+    if (typeof raw === "object") {
+        const obj = raw as Record<string, unknown>;
+        const text = (typeof obj["#text"] === "string" ? obj["#text"] :
+            typeof obj["_text"] === "string" ? obj["_text"] :
+                typeof obj["text"] === "string" ? obj["text"] : undefined);
+        if (text && text.trim()) return text.trim();
+    }
+    const s = String(raw);
+    return s.trim() || undefined;
+}
+
 /**
  * 从 XML 中提取接收者 ID (CorpID)
  */
@@ -55,22 +78,44 @@ export function extractChatId(msg: WecomAgentInboundMessage): string | undefined
 export function extractContent(msg: WecomAgentInboundMessage): string {
     const msgType = extractMsgType(msg);
 
+    const asText = (value: unknown): string => {
+        if (value == null) return "";
+        if (typeof value === "string") return value;
+        if (typeof value === "number" || typeof value === "boolean" || typeof value === "bigint") return String(value);
+        if (Array.isArray(value)) return value.map(asText).filter(Boolean).join("\n");
+        if (typeof value === "object") {
+            const obj = value as Record<string, unknown>;
+            // fast-xml-parser 在某些情况下（例如带属性）会把文本放在 "#text"
+            if (typeof obj["#text"] === "string") return obj["#text"];
+            if (typeof obj["_text"] === "string") return obj["_text"];
+            if (typeof obj["text"] === "string") return obj["text"];
+            try {
+                return JSON.stringify(obj);
+            } catch {
+                return String(value);
+            }
+        }
+        return String(value);
+    };
+
     switch (msgType) {
         case "text":
-            return msg.Content ?? "";
+            return asText(msg.Content);
         case "voice":
             // 语音识别结果
-            return msg.Recognition ?? "[语音消息]";
+            return asText(msg.Recognition) || "[语音消息]";
         case "image":
-            return `[图片] ${msg.PicUrl ?? ""}`;
+            return `[图片] ${asText(msg.PicUrl)}`;
+        case "file":
+            return "[文件消息]";
         case "video":
             return "[视频消息]";
         case "location":
-            return `[位置] ${msg.Label ?? ""} (${msg.Location_X}, ${msg.Location_Y})`;
+            return `[位置] ${asText(msg.Label)} (${asText(msg.Location_X)}, ${asText(msg.Location_Y)})`;
         case "link":
-            return `[链接] ${msg.Title ?? ""}\n${msg.Description ?? ""}\n${msg.Url ?? ""}`;
+            return `[链接] ${asText(msg.Title)}\n${asText(msg.Description)}\n${asText(msg.Url)}`;
         case "event":
-            return `[事件] ${msg.Event ?? ""} - ${msg.EventKey ?? ""}`;
+            return `[事件] ${asText(msg.Event)} - ${asText(msg.EventKey)}`;
         default:
             return `[${msgType || "未知消息类型"}]`;
     }
@@ -81,5 +126,58 @@ export function extractContent(msg: WecomAgentInboundMessage): string {
  * 根据官方文档，MediaId 在 Agent 回调中直接位于根节点
  */
 export function extractMediaId(msg: WecomAgentInboundMessage): string | undefined {
-    return msg.MediaId ? String(msg.MediaId) : undefined;
+    const raw = (msg as any).MediaId ?? (msg as any).MediaID ?? (msg as any).mediaid ?? (msg as any).mediaId;
+    if (raw == null) return undefined;
+    if (typeof raw === "string") return raw.trim() || undefined;
+    if (typeof raw === "number" || typeof raw === "boolean" || typeof raw === "bigint") return String(raw);
+    if (Array.isArray(raw)) {
+        const merged = raw.map((v) => (v == null ? "" : String(v))).join("\n").trim();
+        return merged || undefined;
+    }
+    if (typeof raw === "object") {
+        const obj = raw as Record<string, unknown>;
+        const text = (typeof obj["#text"] === "string" ? obj["#text"] :
+            typeof obj["_text"] === "string" ? obj["_text"] :
+                typeof obj["text"] === "string" ? obj["text"] : undefined);
+        if (text && text.trim()) return text.trim();
+        try {
+            const s = JSON.stringify(obj);
+            return s.trim() || undefined;
+        } catch {
+            const s = String(raw);
+            return s.trim() || undefined;
+        }
+    }
+    const s = String(raw);
+    return s.trim() || undefined;
+}
+
+/**
+ * 从 XML 中提取 MsgId（用于去重）
+ */
+export function extractMsgId(msg: WecomAgentInboundMessage): string | undefined {
+    const raw = (msg as any).MsgId ?? (msg as any).MsgID ?? (msg as any).msgid ?? (msg as any).msgId;
+    if (raw == null) return undefined;
+    if (typeof raw === "string") return raw.trim() || undefined;
+    if (typeof raw === "number" || typeof raw === "boolean" || typeof raw === "bigint") return String(raw);
+    if (Array.isArray(raw)) {
+        const merged = raw.map((v) => (v == null ? "" : String(v))).join("\n").trim();
+        return merged || undefined;
+    }
+    if (typeof raw === "object") {
+        const obj = raw as Record<string, unknown>;
+        const text = (typeof obj["#text"] === "string" ? obj["#text"] :
+            typeof obj["_text"] === "string" ? obj["_text"] :
+                typeof obj["text"] === "string" ? obj["text"] : undefined);
+        if (text && text.trim()) return text.trim();
+        try {
+            const s = JSON.stringify(obj);
+            return s.trim() || undefined;
+        } catch {
+            const s = String(raw);
+            return s.trim() || undefined;
+        }
+    }
+    const s = String(raw);
+    return s.trim() || undefined;
 }

package/src/target.ts

@@ -38,7 +38,7 @@ export function resolveWecomTarget(raw: string | undefined): WecomTarget | undef
     if (!raw?.trim()) return undefined;
 
     // 1. Remove standard namespace prefixes (移除标准命名空间前缀)
-    let clean = raw.trim().replace(/^(wecom|wechatwork|wework|qywx):/i, "");
+    let clean = raw.trim().replace(/^(wecom-agent|wecom|wechatwork|wework|qywx):/i, "");
 
     // 2. Explicit Type Prefixes (显式类型前缀)
     if (/^party:/i.test(clean)) {

package/src/types/message.ts

@@ -109,6 +109,8 @@ export type WecomAgentInboundMessage = {
     // 图片消息
     PicUrl?: string;
     MediaId?: string;
+    // 文件消息
+    FileName?: string;
     // 语音消息
     Format?: string;
     Recognition?: string;

package/GEMINI.md

@@ -1,76 +0,0 @@
-# 企业微信 (WeCom) 插件上下文
-
-## 平台架构：机器人 (Bot) vs 自建应用 (Agent)
-
-本插件采用 **双模 (Dual-Mode)** 架构，结合了企业微信“智能机器人”和“自建应用”的优势。
-
-### 1. 定义与边界
-
-| 特性 | **Bot (智能机器人)** | **Agent (自建应用)** |
-| :--- | :--- | :--- |
-| **身份** | 虚拟用户/助手。 | 工作台中的服务应用。 |
-| **位置** | 存在于 **会话** 中 (单聊或群聊)。 | 存在于 **工作台** 或应用列表。 |
-| **协议** | **JSON** (加密)。 | **XML** (加密)。 |
-| **交互** | 对话式 (回复用户)。 | 事务式 (通知用户/系统)。 |
-| **流式 (Stream)** | ✅ **支持** (打字机效果)。 | ❌ 不支持。 |
-| **文件能力** | ❌ **受限** (被动回复无法发文件)。 | ✅ **完整支持** (API 发送视频、文件、图片)。 |
-| **群聊支持** | ✅ 原生支持 (可被 @)。 | ⚠️ 受限 (仅能在自建群或通过 API 推送)。 |
-
-### 2. 通信协议
-
-#### A. Bot (智能机器人)
-*   **接收 (回调)**:
-    *   **格式**: JSON。
-    *   **单聊**: `chattype: "single"`. 无 `chatid`。`cid` = `from.userid`。
-    *   **群聊**: `chattype: "group"`. 有 `chatid`。`cid` = `chatid`。
-*   **发送 (回复)**:
-    *   **交互回复**: 使用回调中的 `response_url`。支持 `markdown`, `template_card`。**不支持文件/视频**。
-    *   **主动推送**: 使用 Webhook Key。
-
-#### B. Agent (自建应用)
-*   **接收 (回调)**:
-    *   **格式**: XML。
-    *   **结构**: `<ToUserName>`, `<FromUserName>`, `<MsgType>`, `<Content>`。
-*   **发送 (推送)**:
-    *   **API**: `message/send`。
-    *   **能力**: 支持所有媒体类型 (文件, 视频, 语音, 文本, 卡片)。
-    *   **对象**: 用户 (`touser`), 部门 (`toparty`), 标签 (`totag`)。
-
----
-
-## 核心策略：机器人优先，智能体兜底 (接近 6 分钟切换)
-
-### 目标
-*   **默认**: 用户在 Bot 会话触发，结果在 Bot 会话内完成回复（含流式）。
-*   **兜底**: 当 Bot 因超时（接近 6 分钟限制）、异常或流式窗口结束无法完成交付时，若配置了 Agent，则由 Agent 私信触发用户发送最终结果。
-
-### 关键约束
-*   **6 分钟窗口**: 企业微信智能机器人流式链路最多维持 6 分钟。超过后连接断开。
-
-### 流程详解
-
-#### 1. 启动阶段 (Bot)
-1.  **接收消息**: 解析 JSON 回调。
-2.  **生成 StreamID**: 确定性生成 `streamId = hash(accountId + aibotid + msgid)`，防止并发重试导致重复创建流。
-3.  **快速响应**: 立即返回“已接收，处理中”或流式首包，建立连接。
-
-#### 2. 执行阶段 (Worker)
-4.  **异步处理**: 任务入队执行。
-5.  **流式刷新**: 当收到企微的“流式消息刷新”回调时，根据 `streamId` 返回最新生成的内容。
-
-#### 3. 正常交付 (Bot)
-6.  **完成**: 任务在 6 分钟内完成，发送 `finish=true` 信号结束流式消息。
-
-#### 4. 异常切换 (Agent 兜底)
-7.  **触发条件**:
-    *   **超时临界**: `now >= createdAt + 6min - 安全阈值(30s)`。
-    *   **链路中断**: Bot 刷新回调长时间未到达 (如 > 60s)。
-    *   **发送异常**: Bot 接口报错。
-8.  **切换动作**:
-    *   **状态标记**: 将任务标记为 `agent_fallback`。
-    *   **用户提示**: (可选) Bot 在群内尝试发送“结果将私信送达”。
-    *   **私信推送**: Agent 调用 `message/send` 接口，将最终结果（文本/文件）推送给触发者 `userId`。
-    *   **注意**: 即使原会话是群聊，兜底结果通常通过 Agent **私信** 发送给触发者，因为 Agent 难以直接向普通群推送消息。
-
-### 总结
-该策略确保了用户体验（首选流式）和交付可靠性（超时/发文件走 Agent）的平衡。