UNPKG

@gguf/claw

Version:

Multi-channel AI gateway with extensible messaging integrations

833 lines (758 loc) 22.9 kB
import { timingSafeEqual } from "node:crypto"; import type { IncomingMessage, ServerResponse } from "node:http"; import type { OpenClawConfig, MarkdownTableMode } from "openclaw/plugin-sdk"; import { createReplyPrefixOptions, readJsonBodyWithLimit, registerWebhookTarget, rejectNonPostWebhookRequest, resolveSenderCommandAuthorization, resolveWebhookPath, resolveWebhookTargets, requestBodyErrorToText, } from "openclaw/plugin-sdk"; import type { ResolvedZaloAccount } from "./accounts.js"; import { ZaloApiError, deleteWebhook, getUpdates, sendMessage, sendPhoto, setWebhook, type ZaloFetch, type ZaloMessage, type ZaloUpdate, } from "./api.js"; import { resolveZaloProxyFetch } from "./proxy.js"; import { getZaloRuntime } from "./runtime.js"; export type ZaloRuntimeEnv = { log?: (message: string) => void; error?: (message: string) => void; }; export type ZaloMonitorOptions = { token: string; account: ResolvedZaloAccount; config: OpenClawConfig; runtime: ZaloRuntimeEnv; abortSignal: AbortSignal; useWebhook?: boolean; webhookUrl?: string; webhookSecret?: string; webhookPath?: string; fetcher?: ZaloFetch; statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; }; export type ZaloMonitorResult = { stop: () => void; }; const ZALO_TEXT_LIMIT = 2000; const DEFAULT_MEDIA_MAX_MB = 5; const ZALO_WEBHOOK_RATE_LIMIT_WINDOW_MS = 60_000; const ZALO_WEBHOOK_RATE_LIMIT_MAX_REQUESTS = 120; const ZALO_WEBHOOK_REPLAY_WINDOW_MS = 5 * 60_000; const ZALO_WEBHOOK_COUNTER_LOG_EVERY = 25; type ZaloCoreRuntime = ReturnType<typeof getZaloRuntime>; type WebhookRateLimitState = { count: number; windowStartMs: number }; function logVerbose(core: ZaloCoreRuntime, runtime: ZaloRuntimeEnv, message: string): void { if (core.logging.shouldLogVerbose()) { runtime.log?.(`[zalo] ${message}`); } } function isSenderAllowed(senderId: string, allowFrom: string[]): boolean { if (allowFrom.includes("*")) { return true; } const normalizedSenderId = senderId.toLowerCase(); return allowFrom.some((entry) => { const normalized = entry.toLowerCase().replace(/^(zalo|zl):/i, ""); return normalized === normalizedSenderId; }); } type WebhookTarget = { token: string; account: ResolvedZaloAccount; config: OpenClawConfig; runtime: ZaloRuntimeEnv; core: ZaloCoreRuntime; secret: string; path: string; mediaMaxMb: number; statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; fetcher?: ZaloFetch; }; const webhookTargets = new Map<string, WebhookTarget[]>(); const webhookRateLimits = new Map<string, WebhookRateLimitState>(); const recentWebhookEvents = new Map<string, number>(); const webhookStatusCounters = new Map<string, number>(); function isJsonContentType(value: string | string[] | undefined): boolean { const first = Array.isArray(value) ? value[0] : value; if (!first) { return false; } const mediaType = first.split(";", 1)[0]?.trim().toLowerCase(); return mediaType === "application/json" || Boolean(mediaType?.endsWith("+json")); } function timingSafeEquals(left: string, right: string): boolean { const leftBuffer = Buffer.from(left); const rightBuffer = Buffer.from(right); if (leftBuffer.length !== rightBuffer.length) { const length = Math.max(1, leftBuffer.length, rightBuffer.length); const paddedLeft = Buffer.alloc(length); const paddedRight = Buffer.alloc(length); leftBuffer.copy(paddedLeft); rightBuffer.copy(paddedRight); timingSafeEqual(paddedLeft, paddedRight); return false; } return timingSafeEqual(leftBuffer, rightBuffer); } function isWebhookRateLimited(key: string, nowMs: number): boolean { const state = webhookRateLimits.get(key); if (!state || nowMs - state.windowStartMs >= ZALO_WEBHOOK_RATE_LIMIT_WINDOW_MS) { webhookRateLimits.set(key, { count: 1, windowStartMs: nowMs }); return false; } state.count += 1; if (state.count > ZALO_WEBHOOK_RATE_LIMIT_MAX_REQUESTS) { return true; } return false; } function isReplayEvent(update: ZaloUpdate, nowMs: number): boolean { const messageId = update.message?.message_id; if (!messageId) { return false; } const key = `${update.event_name}:${messageId}`; const seenAt = recentWebhookEvents.get(key); recentWebhookEvents.set(key, nowMs); if (seenAt && nowMs - seenAt < ZALO_WEBHOOK_REPLAY_WINDOW_MS) { return true; } if (recentWebhookEvents.size > 5000) { for (const [eventKey, timestamp] of recentWebhookEvents) { if (nowMs - timestamp >= ZALO_WEBHOOK_REPLAY_WINDOW_MS) { recentWebhookEvents.delete(eventKey); } } } return false; } function recordWebhookStatus( runtime: ZaloRuntimeEnv | undefined, path: string, statusCode: number, ): void { if (![400, 401, 408, 413, 415, 429].includes(statusCode)) { return; } const key = `${path}:${statusCode}`; const next = (webhookStatusCounters.get(key) ?? 0) + 1; webhookStatusCounters.set(key, next); if (next === 1 || next % ZALO_WEBHOOK_COUNTER_LOG_EVERY === 0) { runtime?.log?.( `[zalo] webhook anomaly path=${path} status=${statusCode} count=${String(next)}`, ); } } export function registerZaloWebhookTarget(target: WebhookTarget): () => void { return registerWebhookTarget(webhookTargets, target).unregister; } export async function handleZaloWebhookRequest( req: IncomingMessage, res: ServerResponse, ): Promise<boolean> { const resolved = resolveWebhookTargets(req, webhookTargets); if (!resolved) { return false; } const { targets } = resolved; if (rejectNonPostWebhookRequest(req, res)) { return true; } const headerToken = String(req.headers["x-bot-api-secret-token"] ?? ""); const matching = targets.filter((entry) => timingSafeEquals(entry.secret, headerToken)); if (matching.length === 0) { res.statusCode = 401; res.end("unauthorized"); recordWebhookStatus(targets[0]?.runtime, req.url ?? "<unknown>", res.statusCode); return true; } if (matching.length > 1) { res.statusCode = 401; res.end("ambiguous webhook target"); recordWebhookStatus(targets[0]?.runtime, req.url ?? "<unknown>", res.statusCode); return true; } const target = matching[0]; const path = req.url ?? "<unknown>"; const rateLimitKey = `${path}:${req.socket.remoteAddress ?? "unknown"}`; const nowMs = Date.now(); if (isWebhookRateLimited(rateLimitKey, nowMs)) { res.statusCode = 429; res.end("Too Many Requests"); recordWebhookStatus(target.runtime, path, res.statusCode); return true; } if (!isJsonContentType(req.headers["content-type"])) { res.statusCode = 415; res.end("Unsupported Media Type"); recordWebhookStatus(target.runtime, path, res.statusCode); return true; } const body = await readJsonBodyWithLimit(req, { maxBytes: 1024 * 1024, timeoutMs: 30_000, emptyObjectOnEmpty: false, }); if (!body.ok) { res.statusCode = body.code === "PAYLOAD_TOO_LARGE" ? 413 : body.code === "REQUEST_BODY_TIMEOUT" ? 408 : 400; const message = body.code === "PAYLOAD_TOO_LARGE" ? requestBodyErrorToText("PAYLOAD_TOO_LARGE") : body.code === "REQUEST_BODY_TIMEOUT" ? requestBodyErrorToText("REQUEST_BODY_TIMEOUT") : "Bad Request"; res.end(message); recordWebhookStatus(target.runtime, path, res.statusCode); return true; } // Zalo sends updates directly as { event_name, message, ... }, not wrapped in { ok, result } const raw = body.value; const record = raw && typeof raw === "object" ? (raw as Record<string, unknown>) : null; const update: ZaloUpdate | undefined = record && record.ok === true && record.result ? (record.result as ZaloUpdate) : ((record as ZaloUpdate | null) ?? undefined); if (!update?.event_name) { res.statusCode = 400; res.end("Bad Request"); recordWebhookStatus(target.runtime, path, res.statusCode); return true; } if (isReplayEvent(update, nowMs)) { res.statusCode = 200; res.end("ok"); return true; } target.statusSink?.({ lastInboundAt: Date.now() }); processUpdate( update, target.token, target.account, target.config, target.runtime, target.core, target.mediaMaxMb, target.statusSink, target.fetcher, ).catch((err) => { target.runtime.error?.(`[${target.account.accountId}] Zalo webhook failed: ${String(err)}`); }); res.statusCode = 200; res.end("ok"); return true; } function startPollingLoop(params: { token: string; account: ResolvedZaloAccount; config: OpenClawConfig; runtime: ZaloRuntimeEnv; core: ZaloCoreRuntime; abortSignal: AbortSignal; isStopped: () => boolean; mediaMaxMb: number; statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; fetcher?: ZaloFetch; }) { const { token, account, config, runtime, core, abortSignal, isStopped, mediaMaxMb, statusSink, fetcher, } = params; const pollTimeout = 30; const poll = async () => { if (isStopped() || abortSignal.aborted) { return; } try { const response = await getUpdates(token, { timeout: pollTimeout }, fetcher); if (response.ok && response.result) { statusSink?.({ lastInboundAt: Date.now() }); await processUpdate( response.result, token, account, config, runtime, core, mediaMaxMb, statusSink, fetcher, ); } } catch (err) { if (err instanceof ZaloApiError && err.isPollingTimeout) { // no updates } else if (!isStopped() && !abortSignal.aborted) { console.error(`[${account.accountId}] Zalo polling error:`, err); await new Promise((resolve) => setTimeout(resolve, 5000)); } } if (!isStopped() && !abortSignal.aborted) { setImmediate(poll); } }; void poll(); } async function processUpdate( update: ZaloUpdate, token: string, account: ResolvedZaloAccount, config: OpenClawConfig, runtime: ZaloRuntimeEnv, core: ZaloCoreRuntime, mediaMaxMb: number, statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void, fetcher?: ZaloFetch, ): Promise<void> { const { event_name, message } = update; if (!message) { return; } switch (event_name) { case "message.text.received": await handleTextMessage(message, token, account, config, runtime, core, statusSink, fetcher); break; case "message.image.received": await handleImageMessage( message, token, account, config, runtime, core, mediaMaxMb, statusSink, fetcher, ); break; case "message.sticker.received": console.log(`[${account.accountId}] Received sticker from ${message.from.id}`); break; case "message.unsupported.received": console.log( `[${account.accountId}] Received unsupported message type from ${message.from.id}`, ); break; } } async function handleTextMessage( message: ZaloMessage, token: string, account: ResolvedZaloAccount, config: OpenClawConfig, runtime: ZaloRuntimeEnv, core: ZaloCoreRuntime, statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void, fetcher?: ZaloFetch, ): Promise<void> { const { text } = message; if (!text?.trim()) { return; } await processMessageWithPipeline({ message, token, account, config, runtime, core, text, mediaPath: undefined, mediaType: undefined, statusSink, fetcher, }); } async function handleImageMessage( message: ZaloMessage, token: string, account: ResolvedZaloAccount, config: OpenClawConfig, runtime: ZaloRuntimeEnv, core: ZaloCoreRuntime, mediaMaxMb: number, statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void, fetcher?: ZaloFetch, ): Promise<void> { const { photo, caption } = message; let mediaPath: string | undefined; let mediaType: string | undefined; if (photo) { try { const maxBytes = mediaMaxMb * 1024 * 1024; const fetched = await core.channel.media.fetchRemoteMedia({ url: photo }); const saved = await core.channel.media.saveMediaBuffer( fetched.buffer, fetched.contentType, "inbound", maxBytes, ); mediaPath = saved.path; mediaType = saved.contentType; } catch (err) { console.error(`[${account.accountId}] Failed to download Zalo image:`, err); } } await processMessageWithPipeline({ message, token, account, config, runtime, core, text: caption, mediaPath, mediaType, statusSink, fetcher, }); } async function processMessageWithPipeline(params: { message: ZaloMessage; token: string; account: ResolvedZaloAccount; config: OpenClawConfig; runtime: ZaloRuntimeEnv; core: ZaloCoreRuntime; text?: string; mediaPath?: string; mediaType?: string; statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; fetcher?: ZaloFetch; }): Promise<void> { const { message, token, account, config, runtime, core, text, mediaPath, mediaType, statusSink, fetcher, } = params; const { from, chat, message_id, date } = message; const isGroup = chat.chat_type === "GROUP"; const chatId = chat.id; const senderId = from.id; const senderName = from.name; const dmPolicy = account.config.dmPolicy ?? "pairing"; const configAllowFrom = (account.config.allowFrom ?? []).map((v) => String(v)); const rawBody = text?.trim() || (mediaPath ? "<media:image>" : ""); const { senderAllowedForCommands, commandAuthorized } = await resolveSenderCommandAuthorization({ cfg: config, rawBody, isGroup, dmPolicy, configuredAllowFrom: configAllowFrom, senderId, isSenderAllowed, readAllowFromStore: () => core.channel.pairing.readAllowFromStore("zalo"), shouldComputeCommandAuthorized: (body, cfg) => core.channel.commands.shouldComputeCommandAuthorized(body, cfg), resolveCommandAuthorizedFromAuthorizers: (params) => core.channel.commands.resolveCommandAuthorizedFromAuthorizers(params), }); if (!isGroup) { if (dmPolicy === "disabled") { logVerbose(core, runtime, `Blocked zalo DM from ${senderId} (dmPolicy=disabled)`); return; } if (dmPolicy !== "open") { const allowed = senderAllowedForCommands; if (!allowed) { if (dmPolicy === "pairing") { const { code, created } = await core.channel.pairing.upsertPairingRequest({ channel: "zalo", id: senderId, meta: { name: senderName ?? undefined }, }); if (created) { logVerbose(core, runtime, `zalo pairing request sender=${senderId}`); try { await sendMessage( token, { chat_id: chatId, text: core.channel.pairing.buildPairingReply({ channel: "zalo", idLine: `Your Zalo user id: ${senderId}`, code, }), }, fetcher, ); statusSink?.({ lastOutboundAt: Date.now() }); } catch (err) { logVerbose( core, runtime, `zalo pairing reply failed for ${senderId}: ${String(err)}`, ); } } } else { logVerbose( core, runtime, `Blocked unauthorized zalo sender ${senderId} (dmPolicy=${dmPolicy})`, ); } return; } } } const route = core.channel.routing.resolveAgentRoute({ cfg: config, channel: "zalo", accountId: account.accountId, peer: { kind: isGroup ? "group" : "direct", id: chatId, }, }); if ( isGroup && core.channel.commands.isControlCommandMessage(rawBody, config) && commandAuthorized !== true ) { logVerbose(core, runtime, `zalo: drop control command from unauthorized sender ${senderId}`); return; } const fromLabel = isGroup ? `group:${chatId}` : senderName || `user:${senderId}`; const storePath = core.channel.session.resolveStorePath(config.session?.store, { agentId: route.agentId, }); const envelopeOptions = core.channel.reply.resolveEnvelopeFormatOptions(config); const previousTimestamp = core.channel.session.readSessionUpdatedAt({ storePath, sessionKey: route.sessionKey, }); const body = core.channel.reply.formatAgentEnvelope({ channel: "Zalo", from: fromLabel, timestamp: date ? date * 1000 : undefined, previousTimestamp, envelope: envelopeOptions, body: rawBody, }); const ctxPayload = core.channel.reply.finalizeInboundContext({ Body: body, BodyForAgent: rawBody, RawBody: rawBody, CommandBody: rawBody, From: isGroup ? `zalo:group:${chatId}` : `zalo:${senderId}`, To: `zalo:${chatId}`, SessionKey: route.sessionKey, AccountId: route.accountId, ChatType: isGroup ? "group" : "direct", ConversationLabel: fromLabel, SenderName: senderName || undefined, SenderId: senderId, CommandAuthorized: commandAuthorized, Provider: "zalo", Surface: "zalo", MessageSid: message_id, MediaPath: mediaPath, MediaType: mediaType, MediaUrl: mediaPath, OriginatingChannel: "zalo", OriginatingTo: `zalo:${chatId}`, }); await core.channel.session.recordInboundSession({ storePath, sessionKey: ctxPayload.SessionKey ?? route.sessionKey, ctx: ctxPayload, onRecordError: (err) => { runtime.error?.(`zalo: failed updating session meta: ${String(err)}`); }, }); const tableMode = core.channel.text.resolveMarkdownTableMode({ cfg: config, channel: "zalo", accountId: account.accountId, }); const { onModelSelected, ...prefixOptions } = createReplyPrefixOptions({ cfg: config, agentId: route.agentId, channel: "zalo", accountId: account.accountId, }); await core.channel.reply.dispatchReplyWithBufferedBlockDispatcher({ ctx: ctxPayload, cfg: config, dispatcherOptions: { ...prefixOptions, deliver: async (payload) => { await deliverZaloReply({ payload, token, chatId, runtime, core, config, accountId: account.accountId, statusSink, fetcher, tableMode, }); }, onError: (err, info) => { runtime.error?.(`[${account.accountId}] Zalo ${info.kind} reply failed: ${String(err)}`); }, }, replyOptions: { onModelSelected, }, }); } async function deliverZaloReply(params: { payload: { text?: string; mediaUrls?: string[]; mediaUrl?: string }; token: string; chatId: string; runtime: ZaloRuntimeEnv; core: ZaloCoreRuntime; config: OpenClawConfig; accountId?: string; statusSink?: (patch: { lastInboundAt?: number; lastOutboundAt?: number }) => void; fetcher?: ZaloFetch; tableMode?: MarkdownTableMode; }): Promise<void> { const { payload, token, chatId, runtime, core, config, accountId, statusSink, fetcher } = params; const tableMode = params.tableMode ?? "code"; const text = core.channel.text.convertMarkdownTables(payload.text ?? "", tableMode); const mediaList = payload.mediaUrls?.length ? payload.mediaUrls : payload.mediaUrl ? [payload.mediaUrl] : []; if (mediaList.length > 0) { let first = true; for (const mediaUrl of mediaList) { const caption = first ? text : undefined; first = false; try { await sendPhoto(token, { chat_id: chatId, photo: mediaUrl, caption }, fetcher); statusSink?.({ lastOutboundAt: Date.now() }); } catch (err) { runtime.error?.(`Zalo photo send failed: ${String(err)}`); } } return; } if (text) { const chunkMode = core.channel.text.resolveChunkMode(config, "zalo", accountId); const chunks = core.channel.text.chunkMarkdownTextWithMode(text, ZALO_TEXT_LIMIT, chunkMode); for (const chunk of chunks) { try { await sendMessage(token, { chat_id: chatId, text: chunk }, fetcher); statusSink?.({ lastOutboundAt: Date.now() }); } catch (err) { runtime.error?.(`Zalo message send failed: ${String(err)}`); } } } } export async function monitorZaloProvider(options: ZaloMonitorOptions): Promise<ZaloMonitorResult> { const { token, account, config, runtime, abortSignal, useWebhook, webhookUrl, webhookSecret, webhookPath, statusSink, fetcher: fetcherOverride, } = options; const core = getZaloRuntime(); const effectiveMediaMaxMb = account.config.mediaMaxMb ?? DEFAULT_MEDIA_MAX_MB; const fetcher = fetcherOverride ?? resolveZaloProxyFetch(account.config.proxy); let stopped = false; const stopHandlers: Array<() => void> = []; const stop = () => { stopped = true; for (const handler of stopHandlers) { handler(); } }; if (useWebhook) { if (!webhookUrl || !webhookSecret) { throw new Error("Zalo webhookUrl and webhookSecret are required for webhook mode"); } if (!webhookUrl.startsWith("https://")) { throw new Error("Zalo webhook URL must use HTTPS"); } if (webhookSecret.length < 8 || webhookSecret.length > 256) { throw new Error("Zalo webhook secret must be 8-256 characters"); } const path = resolveWebhookPath({ webhookPath, webhookUrl, defaultPath: null }); if (!path) { throw new Error("Zalo webhookPath could not be derived"); } await setWebhook(token, { url: webhookUrl, secret_token: webhookSecret }, fetcher); const unregister = registerZaloWebhookTarget({ token, account, config, runtime, core, path, secret: webhookSecret, statusSink: (patch) => statusSink?.(patch), mediaMaxMb: effectiveMediaMaxMb, fetcher, }); stopHandlers.push(unregister); abortSignal.addEventListener( "abort", () => { void deleteWebhook(token, fetcher).catch(() => {}); }, { once: true }, ); return { stop }; } try { await deleteWebhook(token, fetcher); } catch { // ignore } startPollingLoop({ token, account, config, runtime, core, abortSignal, isStopped: () => stopped, mediaMaxMb: effectiveMediaMaxMb, statusSink, fetcher, }); return { stop }; }