Spaces:
Paused
Paused
File size: 7,855 Bytes
fb4d8fe | 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 | import { randomBytes } from "node:crypto";
import {
type OpenClawConfig,
DEFAULT_GATEWAY_PORT,
type HooksGmailTailscaleMode,
resolveGatewayPort,
} from "../config/config.js";
export const DEFAULT_GMAIL_LABEL = "INBOX";
export const DEFAULT_GMAIL_TOPIC = "gog-gmail-watch";
export const DEFAULT_GMAIL_SUBSCRIPTION = "gog-gmail-watch-push";
export const DEFAULT_GMAIL_SERVE_BIND = "127.0.0.1";
export const DEFAULT_GMAIL_SERVE_PORT = 8788;
export const DEFAULT_GMAIL_SERVE_PATH = "/gmail-pubsub";
export const DEFAULT_GMAIL_MAX_BYTES = 20_000;
export const DEFAULT_GMAIL_RENEW_MINUTES = 12 * 60;
export const DEFAULT_HOOKS_PATH = "/hooks";
export type GmailHookOverrides = {
account?: string;
label?: string;
topic?: string;
subscription?: string;
pushToken?: string;
hookToken?: string;
hookUrl?: string;
includeBody?: boolean;
maxBytes?: number;
renewEveryMinutes?: number;
serveBind?: string;
servePort?: number;
servePath?: string;
tailscaleMode?: HooksGmailTailscaleMode;
tailscalePath?: string;
tailscaleTarget?: string;
};
export type GmailHookRuntimeConfig = {
account: string;
label: string;
topic: string;
subscription: string;
pushToken: string;
hookToken: string;
hookUrl: string;
includeBody: boolean;
maxBytes: number;
renewEveryMinutes: number;
serve: {
bind: string;
port: number;
path: string;
};
tailscale: {
mode: HooksGmailTailscaleMode;
path: string;
target?: string;
};
};
export function generateHookToken(bytes = 24): string {
return randomBytes(bytes).toString("hex");
}
export function mergeHookPresets(existing: string[] | undefined, preset: string): string[] {
const next = new Set((existing ?? []).map((item) => item.trim()).filter(Boolean));
next.add(preset);
return Array.from(next);
}
export function normalizeHooksPath(raw?: string): string {
const base = raw?.trim() || DEFAULT_HOOKS_PATH;
if (base === "/") {
return DEFAULT_HOOKS_PATH;
}
const withSlash = base.startsWith("/") ? base : `/${base}`;
return withSlash.replace(/\/+$/, "");
}
export function normalizeServePath(raw?: string): string {
const base = raw?.trim() || DEFAULT_GMAIL_SERVE_PATH;
// Tailscale funnel/serve strips the set-path prefix before proxying.
// To accept requests at /<path> externally, gog must listen on "/".
if (base === "/") {
return "/";
}
const withSlash = base.startsWith("/") ? base : `/${base}`;
return withSlash.replace(/\/+$/, "");
}
export function buildDefaultHookUrl(
hooksPath?: string,
port: number = DEFAULT_GATEWAY_PORT,
): string {
const basePath = normalizeHooksPath(hooksPath);
const baseUrl = `http://127.0.0.1:${port}`;
return joinUrl(baseUrl, `${basePath}/gmail`);
}
export function resolveGmailHookRuntimeConfig(
cfg: OpenClawConfig,
overrides: GmailHookOverrides,
): { ok: true; value: GmailHookRuntimeConfig } | { ok: false; error: string } {
const hooks = cfg.hooks;
const gmail = hooks?.gmail;
const hookToken = overrides.hookToken ?? hooks?.token ?? "";
if (!hookToken) {
return { ok: false, error: "hooks.token missing (needed for gmail hook)" };
}
const account = overrides.account ?? gmail?.account ?? "";
if (!account) {
return { ok: false, error: "gmail account required" };
}
const topic = overrides.topic ?? gmail?.topic ?? "";
if (!topic) {
return { ok: false, error: "gmail topic required" };
}
const subscription = overrides.subscription ?? gmail?.subscription ?? DEFAULT_GMAIL_SUBSCRIPTION;
const pushToken = overrides.pushToken ?? gmail?.pushToken ?? "";
if (!pushToken) {
return { ok: false, error: "gmail push token required" };
}
const hookUrl =
overrides.hookUrl ??
gmail?.hookUrl ??
buildDefaultHookUrl(hooks?.path, resolveGatewayPort(cfg));
const includeBody = overrides.includeBody ?? gmail?.includeBody ?? true;
const maxBytesRaw = overrides.maxBytes ?? gmail?.maxBytes;
const maxBytes =
typeof maxBytesRaw === "number" && Number.isFinite(maxBytesRaw) && maxBytesRaw > 0
? Math.floor(maxBytesRaw)
: DEFAULT_GMAIL_MAX_BYTES;
const renewEveryMinutesRaw = overrides.renewEveryMinutes ?? gmail?.renewEveryMinutes;
const renewEveryMinutes =
typeof renewEveryMinutesRaw === "number" &&
Number.isFinite(renewEveryMinutesRaw) &&
renewEveryMinutesRaw > 0
? Math.floor(renewEveryMinutesRaw)
: DEFAULT_GMAIL_RENEW_MINUTES;
const serveBind = overrides.serveBind ?? gmail?.serve?.bind ?? DEFAULT_GMAIL_SERVE_BIND;
const servePortRaw = overrides.servePort ?? gmail?.serve?.port;
const servePort =
typeof servePortRaw === "number" && Number.isFinite(servePortRaw) && servePortRaw > 0
? Math.floor(servePortRaw)
: DEFAULT_GMAIL_SERVE_PORT;
const servePathRaw = overrides.servePath ?? gmail?.serve?.path;
const normalizedServePathRaw =
typeof servePathRaw === "string" && servePathRaw.trim().length > 0
? normalizeServePath(servePathRaw)
: DEFAULT_GMAIL_SERVE_PATH;
const tailscaleTargetRaw = overrides.tailscaleTarget ?? gmail?.tailscale?.target;
const tailscaleMode = overrides.tailscaleMode ?? gmail?.tailscale?.mode ?? "off";
const tailscaleTarget =
tailscaleMode !== "off" &&
typeof tailscaleTargetRaw === "string" &&
tailscaleTargetRaw.trim().length > 0
? tailscaleTargetRaw.trim()
: undefined;
// Tailscale strips the public path before proxying, so listen on "/" when on.
const servePath = normalizeServePath(
tailscaleMode !== "off" && !tailscaleTarget ? "/" : normalizedServePathRaw,
);
const tailscalePathRaw = overrides.tailscalePath ?? gmail?.tailscale?.path;
const tailscalePath = normalizeServePath(
tailscaleMode !== "off"
? (tailscalePathRaw ?? normalizedServePathRaw)
: (tailscalePathRaw ?? servePath),
);
return {
ok: true,
value: {
account,
label: overrides.label ?? gmail?.label ?? DEFAULT_GMAIL_LABEL,
topic,
subscription,
pushToken,
hookToken,
hookUrl,
includeBody,
maxBytes,
renewEveryMinutes,
serve: {
bind: serveBind,
port: servePort,
path: servePath,
},
tailscale: {
mode: tailscaleMode,
path: tailscalePath,
target: tailscaleTarget,
},
},
};
}
export function buildGogWatchStartArgs(
cfg: Pick<GmailHookRuntimeConfig, "account" | "label" | "topic">,
): string[] {
return [
"gmail",
"watch",
"start",
"--account",
cfg.account,
"--label",
cfg.label,
"--topic",
cfg.topic,
];
}
export function buildGogWatchServeArgs(cfg: GmailHookRuntimeConfig): string[] {
const args = [
"gmail",
"watch",
"serve",
"--account",
cfg.account,
"--bind",
cfg.serve.bind,
"--port",
String(cfg.serve.port),
"--path",
cfg.serve.path,
"--token",
cfg.pushToken,
"--hook-url",
cfg.hookUrl,
"--hook-token",
cfg.hookToken,
];
if (cfg.includeBody) {
args.push("--include-body");
}
if (cfg.maxBytes > 0) {
args.push("--max-bytes", String(cfg.maxBytes));
}
return args;
}
export function buildTopicPath(projectId: string, topicName: string): string {
return `projects/${projectId}/topics/${topicName}`;
}
export function parseTopicPath(topic: string): { projectId: string; topicName: string } | null {
const match = topic.trim().match(/^projects\/([^/]+)\/topics\/([^/]+)$/i);
if (!match) {
return null;
}
return { projectId: match[1] ?? "", topicName: match[2] ?? "" };
}
function joinUrl(base: string, path: string): string {
const url = new URL(base);
const basePath = url.pathname.replace(/\/+$/, "");
const extra = path.startsWith("/") ? path : `/${path}`;
url.pathname = `${basePath}${extra}`;
return url.toString();
}
|