-
Notifications
You must be signed in to change notification settings - Fork 132
Expand file tree
/
Copy pathapi.ts
More file actions
586 lines (542 loc) · 19.7 KB
/
Copy pathapi.ts
File metadata and controls
586 lines (542 loc) · 19.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
import crypto from "node:crypto";
import fs from "node:fs";
import path from "node:path";
import { fileURLToPath } from "node:url";
import { loadConfigBotAgent, loadConfigRouteTag } from "../auth/accounts.js";
import { logger } from "../util/logger.js";
import { redactBody, redactUrl } from "../util/redact.js";
import type {
BaseInfo,
GetUploadUrlReq,
GetUploadUrlResp,
GetUpdatesReq,
GetUpdatesResp,
NotifyStopResp,
NotifyStartResp,
SendMessageReq,
SendMessageResp,
SendTypingReq,
GetConfigResp,
} from "./types.js";
export type WeixinApiOptions = {
baseUrl: string;
token?: string;
timeoutMs?: number;
/** Long-poll timeout for getUpdates (server may hold the request up to this). */
longPollTimeoutMs?: number;
};
// ---------------------------------------------------------------------------
// BaseInfo — attached to every outgoing CGI request
// ---------------------------------------------------------------------------
interface PackageJson {
name?: string;
version?: string;
ilink_appid?: string;
}
/**
* Identify whether a parsed package.json belongs to this plugin.
*
* The walk-up search may pass through unrelated `package.json` files
* (e.g. nested `node_modules/<dep>/package.json`); only ours is accepted.
*/
function isOwnPackageJson(parsed: PackageJson): boolean {
if (parsed.ilink_appid !== undefined) return true;
return typeof parsed.name === "string" && parsed.name.includes("openclaw-weixin");
}
/**
* Walk up from `startDir` searching for the plugin's own `package.json`.
*
* Resilient to differing layouts between dev (TS source under `src/`) and
* publish (compiled output under `dist/src/`) by not assuming a fixed depth.
*/
export function readPackageJsonFromDir(startDir: string): PackageJson {
try {
let dir = startDir;
const { root } = path.parse(dir);
while (dir && dir !== root) {
const candidate = path.join(dir, "package.json");
if (fs.existsSync(candidate)) {
try {
const parsed = JSON.parse(fs.readFileSync(candidate, "utf-8")) as PackageJson;
if (isOwnPackageJson(parsed)) {
return parsed;
}
} catch {
// Malformed package.json — keep walking up.
}
}
dir = path.dirname(dir);
}
} catch {
// Fall through to empty default.
}
return {};
}
function readPackageJson(): PackageJson {
return readPackageJsonFromDir(path.dirname(fileURLToPath(import.meta.url)));
}
const pkg = readPackageJson();
const CHANNEL_VERSION = pkg.version ?? "unknown";
/** iLink-App-Id: 直接读取 package.json 顶层 ilink_appid 字段。 */
const ILINK_APP_ID: string = pkg.ilink_appid ?? "";
/**
* iLink-App-ClientVersion: uint32 encoded as 0x00MMNNPP
* High 8 bits fixed to 0; remaining bits: major<<16 | minor<<8 | patch.
* e.g. "1.0.11" -> 0x0001000B = 65547
*/
function buildClientVersion(version: string): number {
const parts = version.split(".").map((p) => parseInt(p, 10));
const major = parts[0] ?? 0;
const minor = parts[1] ?? 0;
const patch = parts[2] ?? 0;
return ((major & 0xff) << 16) | ((minor & 0xff) << 8) | (patch & 0xff);
}
const ILINK_APP_CLIENT_VERSION: number = buildClientVersion(pkg.version ?? "0.0.0");
/**
* Default `bot_agent` value used when the upstream app does not declare one.
* Mirrors the role of HTTP `User-Agent`'s implicit "no UA" fallback.
*/
const DEFAULT_BOT_AGENT = "OpenClaw";
/** Maximum length (bytes) of the sanitized `bot_agent` string. */
const BOT_AGENT_MAX_LEN = 256;
/**
* Sanitize a user-supplied `botAgent` config value into a wire-safe string.
*
* Grammar (UA-style):
* bot_agent = product *( SP product )
* product = name "/" version [ SP "(" comment ")" ]
* name = 1*32( ALPHA / DIGIT / "_" / "." / "-" )
* version = 1*32( ALPHA / DIGIT / "_" / "." / "+" / "-" )
* comment = 1*64( printable ASCII minus "(" ")" )
*
* Tokens that fail to parse are dropped silently (no partial tokens kept).
* Returns `DEFAULT_BOT_AGENT` when the input is empty / all tokens dropped /
* the result exceeds the length cap after truncation.
*/
export function sanitizeBotAgent(raw: string | undefined): string {
if (!raw || typeof raw !== "string") return DEFAULT_BOT_AGENT;
const trimmed = raw.trim();
if (!trimmed) return DEFAULT_BOT_AGENT;
const productRe = /^[A-Za-z0-9_.\-]{1,32}\/[A-Za-z0-9_.+\-]{1,32}$/;
const commentCharRe = /^[\x20-\x27\x2A-\x7E]{1,64}$/;
// Tokenize on whitespace, but keep `(comment)` glued to the preceding product.
// Strategy: split by spaces, then re-attach any token that starts with "(".
const rawTokens = trimmed.split(/\s+/);
const tokens: string[] = [];
for (let i = 0; i < rawTokens.length; i += 1) {
const tok = rawTokens[i];
if (tok.startsWith("(") && !tok.endsWith(")")) {
// Multi-word comment; greedily collect until we find the closing ")".
let acc = tok;
while (i + 1 < rawTokens.length && !acc.endsWith(")")) {
i += 1;
acc += " " + rawTokens[i];
}
tokens.push(acc);
} else {
tokens.push(tok);
}
}
const accepted: string[] = [];
let pendingProduct: string | null = null;
for (const tok of tokens) {
if (tok.startsWith("(") && tok.endsWith(")")) {
const inner = tok.slice(1, -1);
if (pendingProduct && commentCharRe.test(inner)) {
accepted.push(`${pendingProduct} (${inner})`);
pendingProduct = null;
} else {
if (pendingProduct) {
accepted.push(pendingProduct);
pendingProduct = null;
}
}
continue;
}
if (pendingProduct) {
accepted.push(pendingProduct);
pendingProduct = null;
}
if (productRe.test(tok)) {
pendingProduct = tok;
}
}
if (pendingProduct) accepted.push(pendingProduct);
if (accepted.length === 0) return DEFAULT_BOT_AGENT;
const joined = accepted.join(" ");
if (Buffer.byteLength(joined, "utf-8") <= BOT_AGENT_MAX_LEN) return joined;
// Truncate by dropping trailing tokens until under the cap.
const truncated: string[] = [];
let len = 0;
for (const t of accepted) {
const add = (truncated.length === 0 ? 0 : 1) + Buffer.byteLength(t, "utf-8");
if (len + add > BOT_AGENT_MAX_LEN) break;
truncated.push(t);
len += add;
}
return truncated.length > 0 ? truncated.join(" ") : DEFAULT_BOT_AGENT;
}
/** Build the `base_info` payload included in every API request. */
export function buildBaseInfo(): BaseInfo {
return {
channel_version: CHANNEL_VERSION,
bot_agent: sanitizeBotAgent(loadConfigBotAgent()),
};
}
/** Default timeout for long-poll getUpdates requests. */
const DEFAULT_LONG_POLL_TIMEOUT_MS = 35_000;
/** Default timeout for regular API requests (sendMessage, getUploadUrl). */
const DEFAULT_API_TIMEOUT_MS = 15_000;
/** Default timeout for lightweight API requests (getConfig, sendTyping). */
const DEFAULT_CONFIG_TIMEOUT_MS = 10_000;
function ensureTrailingSlash(url: string): string {
return url.endsWith("/") ? url : `${url}/`;
}
/** X-WECHAT-UIN header: random uint32 -> decimal string -> base64. */
function randomWechatUin(): string {
const uint32 = crypto.randomBytes(4).readUInt32BE(0);
return Buffer.from(String(uint32), "utf-8").toString("base64");
}
/** Build headers shared by both GET and POST requests. */
function buildCommonHeaders(): Record<string, string> {
const headers: Record<string, string> = {
"iLink-App-Id": ILINK_APP_ID,
"iLink-App-ClientVersion": String(ILINK_APP_CLIENT_VERSION),
};
const routeTag = loadConfigRouteTag();
if (routeTag) {
headers.SKRouteTag = routeTag;
}
return headers;
}
function buildHeaders(opts: { token?: string }): Record<string, string> {
const headers: Record<string, string> = {
"Content-Type": "application/json",
AuthorizationType: "ilink_bot_token",
"X-WECHAT-UIN": randomWechatUin(),
...buildCommonHeaders(),
};
if (opts.token?.trim()) {
headers.Authorization = `Bearer ${opts.token.trim()}`;
}
logger.debug(
`requestHeaders: ${JSON.stringify({ ...headers, Authorization: headers.Authorization ? "Bearer ***" : undefined })}`,
);
return headers;
}
/**
* Classify a fetch-level error into a category for logging / diagnostics.
* This does NOT cover HTTP-level errors (4xx/5xx) — those are thrown separately.
*/
export function classifyFetchError(err: unknown): {
type: "dns" | "tcp" | "tls" | "timeout" | "unknown";
description: string;
code?: string;
} {
if (err instanceof Error && err.name === "AbortError") {
return { type: "timeout", description: "request timeout" };
}
const cause = (err as NodeJS.ErrnoException)?.cause;
const causeCode = (cause as any)?.code ?? "";
const causeStr = String(cause ?? err ?? "") + " " + String(causeCode);
const matchedCode = causeCode || (typeof cause === "string" ? cause : "");
if (/ENOTFOUND|EAI_AGAIN|getaddrinfo/i.test(causeStr)) {
return { type: "dns", description: "DNS resolution failed, check DNS configuration", ...(matchedCode ? { code: matchedCode } : {}) };
}
if (/ECONNREFUSED/i.test(causeStr)) {
return { type: "tcp", description: "TCP connection refused", ...(matchedCode ? { code: matchedCode } : {}) };
}
if (/UND_ERR_CONNECT_TIMEOUT|ETIMEDOUT|ENETUNREACH|EHOSTUNREACH/i.test(causeStr)) {
return { type: "tcp", description: "TCP connection timeout or unreachable", ...(matchedCode ? { code: matchedCode } : {}) };
}
if (/UND_ERR_SOCKET|SSL|TLS|CERT|UNABLE_TO_VERIFY|DEPTH_ZERO/i.test(causeStr)) {
return { type: "tls", description: "TLS handshake error", ...(matchedCode ? { code: matchedCode } : {}) };
}
return { type: "unknown", description: "network request failed" };
}
/**
* GET fetch wrapper: send a GET request to a Weixin API endpoint.
* When `timeoutMs` is set, the request is aborted after that many milliseconds.
* Query parameters should already be encoded in `endpoint`.
* Returns the raw response text on success; throws on HTTP error or (if used) timeout abort.
*/
export async function apiGetFetch(params: {
baseUrl: string;
endpoint: string;
timeoutMs?: number;
label: string;
}): Promise<string> {
const base = ensureTrailingSlash(params.baseUrl);
const url = new URL(params.endpoint, base);
const hdrs = buildCommonHeaders();
logger.debug(`GET ${redactUrl(url.toString())}`);
const timeoutMs = params.timeoutMs;
const controller =
timeoutMs != null && timeoutMs > 0 ? new AbortController() : undefined;
const t =
controller != null && timeoutMs != null
? setTimeout(() => controller.abort(), timeoutMs)
: undefined;
try {
const res = await fetch(url.toString(), {
method: "GET",
headers: hdrs,
...(controller ? { signal: controller.signal } : {}),
});
if (t !== undefined) clearTimeout(t);
const rawText = await res.text();
logger.debug(`${params.label} status=${res.status} raw=${redactBody(rawText)}`);
if (!res.ok) {
throw new Error(`${params.label} ${res.status}: ${rawText}`);
}
return rawText;
} catch (err) {
if (t !== undefined) clearTimeout(t);
const classified = classifyFetchError(err);
logger.error(
`${params.label}: GET fetch failed url=${redactUrl(url.toString())} timeoutMs=${timeoutMs ?? "none"} type=${classified.type} description=${classified.description}${classified.code ? ` code=${classified.code}` : ""} error=${String(err)}`,
);
throw err;
}
}
/**
* Combine an internal timeout controller with an optional external abort signal.
* This lets gateway channel-stop aborts cancel in-flight long-poll requests
* immediately while preserving the existing timeout-driven AbortError path.
*/
function combineAbortSignals(params: {
internal?: AbortController;
external?: AbortSignal;
}): { signal?: AbortSignal; cleanup: () => void } {
const { internal, external } = params;
if (!external) {
return { signal: internal?.signal, cleanup: () => {} };
}
if (!internal) {
return { signal: external, cleanup: () => {} };
}
if (external.aborted) {
internal.abort();
return { signal: internal.signal, cleanup: () => {} };
}
const onExternalAbort = () => internal.abort();
external.addEventListener("abort", onExternalAbort, { once: true });
return {
signal: internal.signal,
cleanup: () => external.removeEventListener("abort", onExternalAbort),
};
}
/**
* Common fetch wrapper: POST JSON to a Weixin API endpoint.
* When `timeoutMs` is provided, the request is aborted after that many milliseconds.
* When omitted, no client-side timeout is applied (relies on OS/TCP stack).
* Returns the raw response text on success; throws on HTTP error or timeout.
*
* When `abortSignal` is provided, an external abort (e.g. gateway channel stop)
* cancels the in-flight request immediately instead of waiting for `timeoutMs`.
*/
export async function apiPostFetch(params: {
baseUrl: string;
endpoint: string;
body: string;
token?: string;
timeoutMs?: number;
label: string;
abortSignal?: AbortSignal;
}): Promise<string> {
const base = ensureTrailingSlash(params.baseUrl);
const url = new URL(params.endpoint, base);
const hdrs = buildHeaders({ token: params.token });
logger.debug(`POST ${redactUrl(url.toString())} body=${redactBody(params.body)}`);
const controller =
params.timeoutMs !== undefined ? new AbortController() : undefined;
const t =
controller != null && params.timeoutMs !== undefined
? setTimeout(() => controller.abort(), params.timeoutMs)
: undefined;
const { signal, cleanup } = combineAbortSignals({
internal: controller,
external: params.abortSignal,
});
try {
const res = await fetch(url.toString(), {
method: "POST",
headers: hdrs,
body: params.body,
...(signal ? { signal } : {}),
});
if (t !== undefined) clearTimeout(t);
const rawText = await res.text();
logger.debug(`${params.label} status=${res.status} raw=${redactBody(rawText)}`);
if (!res.ok) {
throw new Error(`${params.label} ${res.status}: ${rawText}`);
}
return rawText;
} catch (err) {
if (t !== undefined) clearTimeout(t);
const classified = classifyFetchError(err);
logger.error(
`${params.label}: POST fetch failed url=${redactUrl(url.toString())} timeoutMs=${params.timeoutMs ?? "none"} type=${classified.type} description=${classified.description}${classified.code ? ` code=${classified.code}` : ""} error=${String(err)}`,
);
throw err;
} finally {
cleanup();
}
}
/**
* Long-poll getUpdates. Server should hold the request until new messages or timeout.
*
* On client-side timeout (no server response within timeoutMs), returns an empty response
* with ret=0 so the caller can simply retry. This is normal for long-poll.
*/
export async function getUpdates(
params: GetUpdatesReq & {
baseUrl: string;
token?: string;
timeoutMs?: number;
/**
* Optional external abort signal from the gateway. When stopping the channel,
* this aborts the in-flight long-poll immediately so hot reload can restart.
*/
abortSignal?: AbortSignal;
},
): Promise<GetUpdatesResp> {
const timeout = params.timeoutMs ?? DEFAULT_LONG_POLL_TIMEOUT_MS;
try {
const rawText = await apiPostFetch({
baseUrl: params.baseUrl,
endpoint: "ilink/bot/getupdates",
body: JSON.stringify({
get_updates_buf: params.get_updates_buf ?? "",
base_info: buildBaseInfo(),
}),
token: params.token,
timeoutMs: timeout,
label: "getUpdates",
abortSignal: params.abortSignal,
});
const resp: GetUpdatesResp = JSON.parse(rawText);
return resp;
} catch (err) {
// Long-poll timeout or external abort are both normal control-flow exits.
// The monitor loop checks abortSignal after return and exits when needed.
if (err instanceof Error && err.name === "AbortError") {
if (params.abortSignal?.aborted) {
logger.debug(`getUpdates: aborted by external signal`);
} else {
logger.debug(`getUpdates: client-side timeout after ${timeout}ms, returning empty response`);
}
return { ret: 0, msgs: [], get_updates_buf: params.get_updates_buf };
}
throw err;
}
}
/** Get a pre-signed CDN upload URL for a file. */
export async function getUploadUrl(
params: GetUploadUrlReq & WeixinApiOptions,
): Promise<GetUploadUrlResp> {
const rawText = await apiPostFetch({
baseUrl: params.baseUrl,
endpoint: "ilink/bot/getuploadurl",
body: JSON.stringify({
filekey: params.filekey,
media_type: params.media_type,
to_user_id: params.to_user_id,
rawsize: params.rawsize,
rawfilemd5: params.rawfilemd5,
filesize: params.filesize,
thumb_rawsize: params.thumb_rawsize,
thumb_rawfilemd5: params.thumb_rawfilemd5,
thumb_filesize: params.thumb_filesize,
no_need_thumb: params.no_need_thumb,
aeskey: params.aeskey,
base_info: buildBaseInfo(),
}),
token: params.token,
timeoutMs: params.timeoutMs ?? DEFAULT_API_TIMEOUT_MS,
label: "getUploadUrl",
});
const resp: GetUploadUrlResp = JSON.parse(rawText);
return resp;
}
/** Send a single message downstream. */
export async function sendMessage(
params: WeixinApiOptions & { body: SendMessageReq },
): Promise<void> {
const rawText = await apiPostFetch({
baseUrl: params.baseUrl,
endpoint: "ilink/bot/sendmessage",
body: JSON.stringify({ ...params.body, base_info: buildBaseInfo() }),
token: params.token,
timeoutMs: params.timeoutMs ?? DEFAULT_API_TIMEOUT_MS,
label: "sendMessage",
});
const resp: SendMessageResp = JSON.parse(rawText);
if (resp.ret && resp.ret !== 0) {
throw new Error(
`sendMessage ret=${resp.ret} errmsg=${resp.errmsg ?? "(none)"}`,
);
}
}
/** Fetch bot config (includes typing_ticket) for a given user. */
export async function getConfig(
params: WeixinApiOptions & { ilinkUserId: string; contextToken?: string },
): Promise<GetConfigResp> {
const rawText = await apiPostFetch({
baseUrl: params.baseUrl,
endpoint: "ilink/bot/getconfig",
body: JSON.stringify({
ilink_user_id: params.ilinkUserId,
context_token: params.contextToken,
base_info: buildBaseInfo(),
}),
token: params.token,
timeoutMs: params.timeoutMs ?? DEFAULT_CONFIG_TIMEOUT_MS,
label: "getConfig",
});
const resp: GetConfigResp = JSON.parse(rawText);
return resp;
}
/** Send a typing indicator to a user. */
export async function sendTyping(
params: WeixinApiOptions & { body: SendTypingReq },
): Promise<void> {
await apiPostFetch({
baseUrl: params.baseUrl,
endpoint: "ilink/bot/sendtyping",
body: JSON.stringify({ ...params.body, base_info: buildBaseInfo() }),
token: params.token,
timeoutMs: params.timeoutMs ?? DEFAULT_CONFIG_TIMEOUT_MS,
label: "sendTyping",
});
}
/**
* Notify Weixin that this channel client is stopping (gateway shutdown / channel stop).
* Uses a standalone timeout (not the gateway abort signal) so the request can finish
* after OpenClaw has already aborted the long-poll.
*/
export async function notifyStop(params: WeixinApiOptions): Promise<NotifyStopResp> {
const rawText = await apiPostFetch({
baseUrl: params.baseUrl,
endpoint: "ilink/bot/msg/notifystop",
body: JSON.stringify({ base_info: buildBaseInfo() }),
token: params.token,
timeoutMs: params.timeoutMs ?? DEFAULT_CONFIG_TIMEOUT_MS,
label: "notifyStop",
});
return JSON.parse(rawText) as NotifyStopResp;
}
/**
* Notify Weixin that this channel client is starting (gateway startup / channel start).
*/
export async function notifyStart(params: WeixinApiOptions): Promise<NotifyStartResp> {
const rawText = await apiPostFetch({
baseUrl: params.baseUrl,
endpoint: "ilink/bot/msg/notifystart",
body: JSON.stringify({ base_info: buildBaseInfo() }),
token: params.token,
timeoutMs: params.timeoutMs ?? DEFAULT_CONFIG_TIMEOUT_MS,
label: "notifyStart",
});
return JSON.parse(rawText) as NotifyStartResp;
}