mirror of
https://github.com/openclaw/openclaw.git
synced 2026-04-04 05:42:02 +00:00
965 lines
32 KiB
TypeScript
965 lines
32 KiB
TypeScript
import {
|
|
buildDmGroupAccountAllowlistAdapter,
|
|
createNestedAllowlistOverrideResolver,
|
|
} from "openclaw/plugin-sdk/allowlist-config-edit";
|
|
import { createPairingPrefixStripper } from "openclaw/plugin-sdk/channel-pairing";
|
|
import { createAllowlistProviderRouteAllowlistWarningCollector } from "openclaw/plugin-sdk/channel-policy";
|
|
import { attachChannelToResult } from "openclaw/plugin-sdk/channel-send-result";
|
|
import { createChatChannelPlugin } from "openclaw/plugin-sdk/core";
|
|
import { createChannelDirectoryAdapter } from "openclaw/plugin-sdk/directory-runtime";
|
|
import {
|
|
resolveOutboundSendDep,
|
|
type OutboundSendDeps,
|
|
} from "openclaw/plugin-sdk/outbound-runtime";
|
|
import {
|
|
buildOutboundBaseSessionKey,
|
|
normalizeMessageChannel,
|
|
normalizeOutboundThreadId,
|
|
resolveThreadSessionKeys,
|
|
type RoutePeer,
|
|
} from "openclaw/plugin-sdk/routing";
|
|
import {
|
|
createComputedAccountStatusAdapter,
|
|
createDefaultChannelRuntimeState,
|
|
} from "openclaw/plugin-sdk/status-helpers";
|
|
import {
|
|
buildTokenChannelStatusSummary,
|
|
clearAccountEntryFields,
|
|
DEFAULT_ACCOUNT_ID,
|
|
PAIRING_APPROVED_MESSAGE,
|
|
parseTelegramTopicConversation,
|
|
projectCredentialSnapshotFields,
|
|
resolveConfiguredFromCredentialStatuses,
|
|
type ChannelMessageActionAdapter,
|
|
type OpenClawConfig,
|
|
} from "openclaw/plugin-sdk/telegram-core";
|
|
import {
|
|
listTelegramAccountIds,
|
|
resolveTelegramAccount,
|
|
type ResolvedTelegramAccount,
|
|
} from "./accounts.js";
|
|
import { resolveTelegramAutoThreadId } from "./action-threading.js";
|
|
import { lookupTelegramChatId } from "./api-fetch.js";
|
|
import { telegramApprovalCapability } from "./approval-native.js";
|
|
import * as auditModule from "./audit.js";
|
|
import { buildTelegramGroupPeerId } from "./bot/helpers.js";
|
|
import { telegramMessageActions as telegramMessageActionsImpl } from "./channel-actions.js";
|
|
import {
|
|
listTelegramDirectoryGroupsFromConfig,
|
|
listTelegramDirectoryPeersFromConfig,
|
|
} from "./directory-config.js";
|
|
import { buildTelegramExecApprovalPendingPayload } from "./exec-approval-forwarding.js";
|
|
import {
|
|
getTelegramExecApprovalApprovers,
|
|
isTelegramExecApprovalApprover,
|
|
isTelegramExecApprovalAuthorizedSender,
|
|
isTelegramExecApprovalClientEnabled,
|
|
resolveTelegramExecApprovalTarget,
|
|
shouldSuppressLocalTelegramExecApprovalPrompt,
|
|
} from "./exec-approvals.js";
|
|
import {
|
|
resolveTelegramGroupRequireMention,
|
|
resolveTelegramGroupToolPolicy,
|
|
} from "./group-policy.js";
|
|
import { resolveTelegramInlineButtonsScope } from "./inline-buttons.js";
|
|
import * as monitorModule from "./monitor.js";
|
|
import { looksLikeTelegramTargetId, normalizeTelegramMessagingTarget } from "./normalize.js";
|
|
import { sendTelegramPayloadMessages } from "./outbound-adapter.js";
|
|
import { parseTelegramReplyToMessageId, parseTelegramThreadId } from "./outbound-params.js";
|
|
import * as probeModule from "./probe.js";
|
|
import type { TelegramProbe } from "./probe.js";
|
|
import { resolveTelegramReactionLevel } from "./reaction-level.js";
|
|
import { getTelegramRuntime } from "./runtime.js";
|
|
import { sendMessageTelegram, sendPollTelegram, sendTypingTelegram } from "./send.js";
|
|
import { resolveTelegramSessionConversation } from "./session-conversation.js";
|
|
import { telegramSetupAdapter } from "./setup-core.js";
|
|
import { telegramSetupWizard } from "./setup-surface.js";
|
|
import {
|
|
createTelegramPluginBase,
|
|
findTelegramTokenOwnerAccountId,
|
|
formatDuplicateTelegramTokenReason,
|
|
telegramConfigAdapter,
|
|
} from "./shared.js";
|
|
import { collectTelegramStatusIssues } from "./status-issues.js";
|
|
import { parseTelegramTarget } from "./targets.js";
|
|
import {
|
|
createTelegramThreadBindingManager,
|
|
setTelegramThreadBindingIdleTimeoutBySessionKey,
|
|
setTelegramThreadBindingMaxAgeBySessionKey,
|
|
} from "./thread-bindings.js";
|
|
import { buildTelegramThreadingToolContext } from "./threading-tool-context.js";
|
|
import { resolveTelegramToken } from "./token.js";
|
|
|
|
type TelegramSendFn = typeof sendMessageTelegram;
|
|
|
|
type TelegramSendOptions = NonNullable<Parameters<TelegramSendFn>[2]>;
|
|
|
|
function resolveTelegramProbe() {
|
|
return (
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.probeTelegram ?? probeModule.probeTelegram
|
|
);
|
|
}
|
|
|
|
function resolveTelegramAuditCollector() {
|
|
return (
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.collectTelegramUnmentionedGroupIds ??
|
|
auditModule.collectTelegramUnmentionedGroupIds
|
|
);
|
|
}
|
|
|
|
function resolveTelegramAuditMembership() {
|
|
return (
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.auditTelegramGroupMembership ??
|
|
auditModule.auditTelegramGroupMembership
|
|
);
|
|
}
|
|
|
|
function resolveTelegramMonitor() {
|
|
return (
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.monitorTelegramProvider ??
|
|
monitorModule.monitorTelegramProvider
|
|
);
|
|
}
|
|
|
|
function getOptionalTelegramRuntime() {
|
|
try {
|
|
return getTelegramRuntime();
|
|
} catch {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
function resolveTelegramSend(deps?: OutboundSendDeps): TelegramSendFn {
|
|
return (
|
|
resolveOutboundSendDep<TelegramSendFn>(deps, "telegram") ??
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.sendMessageTelegram ??
|
|
sendMessageTelegram
|
|
);
|
|
}
|
|
|
|
function resolveTelegramTokenHelper() {
|
|
return (
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.resolveTelegramToken ?? resolveTelegramToken
|
|
);
|
|
}
|
|
|
|
function buildTelegramSendOptions(params: {
|
|
cfg: OpenClawConfig;
|
|
mediaUrl?: string | null;
|
|
mediaLocalRoots?: readonly string[] | null;
|
|
accountId?: string | null;
|
|
replyToId?: string | null;
|
|
threadId?: string | number | null;
|
|
silent?: boolean | null;
|
|
forceDocument?: boolean | null;
|
|
gatewayClientScopes?: readonly string[] | null;
|
|
}): TelegramSendOptions {
|
|
return {
|
|
verbose: false,
|
|
cfg: params.cfg,
|
|
...(params.mediaUrl ? { mediaUrl: params.mediaUrl } : {}),
|
|
...(params.mediaLocalRoots?.length ? { mediaLocalRoots: params.mediaLocalRoots } : {}),
|
|
messageThreadId: parseTelegramThreadId(params.threadId),
|
|
replyToMessageId: parseTelegramReplyToMessageId(params.replyToId),
|
|
accountId: params.accountId ?? undefined,
|
|
silent: params.silent ?? undefined,
|
|
forceDocument: params.forceDocument ?? undefined,
|
|
...(Array.isArray(params.gatewayClientScopes)
|
|
? { gatewayClientScopes: [...params.gatewayClientScopes] }
|
|
: {}),
|
|
};
|
|
}
|
|
|
|
async function sendTelegramOutbound(params: {
|
|
cfg: OpenClawConfig;
|
|
to: string;
|
|
text: string;
|
|
mediaUrl?: string | null;
|
|
mediaLocalRoots?: readonly string[] | null;
|
|
accountId?: string | null;
|
|
deps?: OutboundSendDeps;
|
|
replyToId?: string | null;
|
|
threadId?: string | number | null;
|
|
silent?: boolean | null;
|
|
gatewayClientScopes?: readonly string[] | null;
|
|
}) {
|
|
const send = resolveTelegramSend(params.deps);
|
|
return await send(
|
|
params.to,
|
|
params.text,
|
|
buildTelegramSendOptions({
|
|
cfg: params.cfg,
|
|
mediaUrl: params.mediaUrl,
|
|
mediaLocalRoots: params.mediaLocalRoots,
|
|
accountId: params.accountId,
|
|
replyToId: params.replyToId,
|
|
threadId: params.threadId,
|
|
silent: params.silent,
|
|
gatewayClientScopes: params.gatewayClientScopes,
|
|
}),
|
|
);
|
|
}
|
|
|
|
const telegramMessageActions: ChannelMessageActionAdapter = {
|
|
describeMessageTool: (ctx) =>
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.messageActions?.describeMessageTool?.(ctx) ??
|
|
telegramMessageActionsImpl.describeMessageTool?.(ctx) ??
|
|
null,
|
|
extractToolSend: (ctx) =>
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.messageActions?.extractToolSend?.(ctx) ??
|
|
telegramMessageActionsImpl.extractToolSend?.(ctx) ??
|
|
null,
|
|
handleAction: async (ctx) => {
|
|
const runtimeHandleAction =
|
|
getOptionalTelegramRuntime()?.channel?.telegram?.messageActions?.handleAction;
|
|
if (runtimeHandleAction) {
|
|
return await runtimeHandleAction(ctx);
|
|
}
|
|
if (!telegramMessageActionsImpl.handleAction) {
|
|
throw new Error("Telegram message actions not available");
|
|
}
|
|
return await telegramMessageActionsImpl.handleAction(ctx);
|
|
},
|
|
};
|
|
|
|
function normalizeTelegramAcpConversationId(conversationId: string) {
|
|
const parsed = parseTelegramTopicConversation({ conversationId });
|
|
if (!parsed || !parsed.chatId.startsWith("-")) {
|
|
return null;
|
|
}
|
|
return {
|
|
conversationId: parsed.canonicalConversationId,
|
|
parentConversationId: parsed.chatId,
|
|
};
|
|
}
|
|
|
|
function matchTelegramAcpConversation(params: {
|
|
bindingConversationId: string;
|
|
conversationId: string;
|
|
parentConversationId?: string;
|
|
}) {
|
|
const binding = normalizeTelegramAcpConversationId(params.bindingConversationId);
|
|
if (!binding) {
|
|
return null;
|
|
}
|
|
const incoming = parseTelegramTopicConversation({
|
|
conversationId: params.conversationId,
|
|
parentConversationId: params.parentConversationId,
|
|
});
|
|
if (!incoming || !incoming.chatId.startsWith("-")) {
|
|
return null;
|
|
}
|
|
if (binding.conversationId !== incoming.canonicalConversationId) {
|
|
return null;
|
|
}
|
|
return {
|
|
conversationId: incoming.canonicalConversationId,
|
|
parentConversationId: incoming.chatId,
|
|
matchPriority: 2,
|
|
};
|
|
}
|
|
|
|
function resolveTelegramCommandConversation(params: {
|
|
threadId?: string;
|
|
originatingTo?: string;
|
|
commandTo?: string;
|
|
fallbackTo?: string;
|
|
}) {
|
|
const chatId = [params.originatingTo, params.commandTo, params.fallbackTo]
|
|
.map((candidate) => {
|
|
const trimmed = candidate?.trim();
|
|
return trimmed ? parseTelegramTarget(trimmed).chatId.trim() : "";
|
|
})
|
|
.find((candidate) => candidate.length > 0);
|
|
if (!chatId) {
|
|
return null;
|
|
}
|
|
if (params.threadId) {
|
|
return {
|
|
conversationId: `${chatId}:topic:${params.threadId}`,
|
|
parentConversationId: chatId,
|
|
};
|
|
}
|
|
if (chatId.startsWith("-")) {
|
|
return null;
|
|
}
|
|
return {
|
|
conversationId: chatId,
|
|
parentConversationId: chatId,
|
|
};
|
|
}
|
|
|
|
function parseTelegramExplicitTarget(raw: string) {
|
|
const target = parseTelegramTarget(raw);
|
|
return {
|
|
to: target.chatId,
|
|
threadId: target.messageThreadId,
|
|
chatType: target.chatType === "unknown" ? undefined : target.chatType,
|
|
};
|
|
}
|
|
|
|
function buildTelegramBaseSessionKey(params: {
|
|
cfg: OpenClawConfig;
|
|
agentId: string;
|
|
accountId?: string | null;
|
|
peer: RoutePeer;
|
|
}) {
|
|
return buildOutboundBaseSessionKey({ ...params, channel: "telegram" });
|
|
}
|
|
|
|
function resolveTelegramOutboundSessionRoute(params: {
|
|
cfg: OpenClawConfig;
|
|
agentId: string;
|
|
accountId?: string | null;
|
|
target: string;
|
|
resolvedTarget?: { kind: string };
|
|
threadId?: string | number | null;
|
|
}) {
|
|
const parsed = parseTelegramTarget(params.target);
|
|
const chatId = parsed.chatId.trim();
|
|
if (!chatId) {
|
|
return null;
|
|
}
|
|
const fallbackThreadId = normalizeOutboundThreadId(params.threadId);
|
|
const resolvedThreadId = parsed.messageThreadId ?? parseTelegramThreadId(fallbackThreadId);
|
|
const isGroup =
|
|
parsed.chatType === "group" ||
|
|
(parsed.chatType === "unknown" &&
|
|
params.resolvedTarget?.kind &&
|
|
params.resolvedTarget.kind !== "user");
|
|
const peerId =
|
|
isGroup && resolvedThreadId ? buildTelegramGroupPeerId(chatId, resolvedThreadId) : chatId;
|
|
const peer: RoutePeer = {
|
|
kind: isGroup ? "group" : "direct",
|
|
id: peerId,
|
|
};
|
|
const baseSessionKey = buildTelegramBaseSessionKey({
|
|
cfg: params.cfg,
|
|
agentId: params.agentId,
|
|
accountId: params.accountId,
|
|
peer,
|
|
});
|
|
const threadKeys =
|
|
resolvedThreadId && !isGroup
|
|
? resolveThreadSessionKeys({ baseSessionKey, threadId: String(resolvedThreadId) })
|
|
: null;
|
|
return {
|
|
sessionKey: threadKeys?.sessionKey ?? baseSessionKey,
|
|
baseSessionKey,
|
|
peer,
|
|
chatType: isGroup ? ("group" as const) : ("direct" as const),
|
|
from: isGroup
|
|
? `telegram:group:${peerId}`
|
|
: resolvedThreadId
|
|
? `telegram:${chatId}:topic:${resolvedThreadId}`
|
|
: `telegram:${chatId}`,
|
|
to: `telegram:${chatId}`,
|
|
threadId: resolvedThreadId,
|
|
};
|
|
}
|
|
|
|
async function resolveTelegramTargets(params: {
|
|
cfg: OpenClawConfig;
|
|
accountId?: string | null;
|
|
inputs: string[];
|
|
kind: "user" | "group";
|
|
}) {
|
|
if (params.kind !== "user") {
|
|
return params.inputs.map((input) => ({
|
|
input,
|
|
resolved: false as const,
|
|
note: "Telegram runtime target resolution only supports usernames for direct-message lookups.",
|
|
}));
|
|
}
|
|
const account = resolveTelegramAccount({
|
|
cfg: params.cfg,
|
|
accountId: params.accountId,
|
|
});
|
|
const token = account.token.trim();
|
|
if (!token) {
|
|
return params.inputs.map((input) => ({
|
|
input,
|
|
resolved: false as const,
|
|
note: "Telegram bot token is required to resolve @username targets.",
|
|
}));
|
|
}
|
|
return await Promise.all(
|
|
params.inputs.map(async (input) => {
|
|
const trimmed = input.trim();
|
|
if (!trimmed) {
|
|
return {
|
|
input,
|
|
resolved: false as const,
|
|
note: "Telegram target is required.",
|
|
};
|
|
}
|
|
const normalized = trimmed.startsWith("@") ? trimmed : `@${trimmed}`;
|
|
try {
|
|
const id = await lookupTelegramChatId({
|
|
token,
|
|
chatId: normalized,
|
|
network: account.config.network,
|
|
});
|
|
if (!id) {
|
|
return {
|
|
input,
|
|
resolved: false as const,
|
|
note: "Telegram username could not be resolved by the configured bot.",
|
|
};
|
|
}
|
|
return {
|
|
input,
|
|
resolved: true as const,
|
|
id,
|
|
name: normalized,
|
|
};
|
|
} catch (error) {
|
|
return {
|
|
input,
|
|
resolved: false as const,
|
|
note: error instanceof Error ? error.message : String(error),
|
|
};
|
|
}
|
|
}),
|
|
);
|
|
}
|
|
|
|
const resolveTelegramAllowlistGroupOverrides = createNestedAllowlistOverrideResolver({
|
|
resolveRecord: (account: ResolvedTelegramAccount) => account.config.groups,
|
|
outerLabel: (groupId) => groupId,
|
|
resolveOuterEntries: (groupCfg) => groupCfg?.allowFrom,
|
|
resolveChildren: (groupCfg) => groupCfg?.topics,
|
|
innerLabel: (groupId, topicId) => `${groupId} topic ${topicId}`,
|
|
resolveInnerEntries: (topicCfg) => topicCfg?.allowFrom,
|
|
});
|
|
|
|
const collectTelegramSecurityWarnings =
|
|
createAllowlistProviderRouteAllowlistWarningCollector<ResolvedTelegramAccount>({
|
|
providerConfigPresent: (cfg) => cfg.channels?.telegram !== undefined,
|
|
resolveGroupPolicy: (account) => account.config.groupPolicy,
|
|
resolveRouteAllowlistConfigured: (account) =>
|
|
Boolean(account.config.groups) && Object.keys(account.config.groups ?? {}).length > 0,
|
|
restrictSenders: {
|
|
surface: "Telegram groups",
|
|
openScope: "any member in allowed groups",
|
|
groupPolicyPath: "channels.telegram.groupPolicy",
|
|
groupAllowFromPath: "channels.telegram.groupAllowFrom",
|
|
},
|
|
noRouteAllowlist: {
|
|
surface: "Telegram groups",
|
|
routeAllowlistPath: "channels.telegram.groups",
|
|
routeScope: "group",
|
|
groupPolicyPath: "channels.telegram.groupPolicy",
|
|
groupAllowFromPath: "channels.telegram.groupAllowFrom",
|
|
},
|
|
});
|
|
|
|
export const telegramPlugin = createChatChannelPlugin({
|
|
base: {
|
|
...createTelegramPluginBase({
|
|
setupWizard: telegramSetupWizard,
|
|
setup: telegramSetupAdapter,
|
|
}),
|
|
allowlist: buildDmGroupAccountAllowlistAdapter({
|
|
channelId: "telegram",
|
|
resolveAccount: resolveTelegramAccount,
|
|
normalize: ({ cfg, accountId, values }) =>
|
|
telegramConfigAdapter.formatAllowFrom!({ cfg, accountId, allowFrom: values }),
|
|
resolveDmAllowFrom: (account) => account.config.allowFrom,
|
|
resolveGroupAllowFrom: (account) => account.config.groupAllowFrom,
|
|
resolveDmPolicy: (account) => account.config.dmPolicy,
|
|
resolveGroupPolicy: (account) => account.config.groupPolicy,
|
|
resolveGroupOverrides: resolveTelegramAllowlistGroupOverrides,
|
|
}),
|
|
bindings: {
|
|
compileConfiguredBinding: ({ conversationId }) =>
|
|
normalizeTelegramAcpConversationId(conversationId),
|
|
matchInboundConversation: ({ compiledBinding, conversationId, parentConversationId }) =>
|
|
matchTelegramAcpConversation({
|
|
bindingConversationId: compiledBinding.conversationId,
|
|
conversationId,
|
|
parentConversationId,
|
|
}),
|
|
resolveCommandConversation: ({ threadId, originatingTo, commandTo, fallbackTo }) =>
|
|
resolveTelegramCommandConversation({
|
|
threadId,
|
|
originatingTo,
|
|
commandTo,
|
|
fallbackTo,
|
|
}),
|
|
},
|
|
conversationBindings: {
|
|
supportsCurrentConversationBinding: true,
|
|
createManager: ({ accountId }) =>
|
|
createTelegramThreadBindingManager({
|
|
accountId: accountId ?? undefined,
|
|
persist: false,
|
|
enableSweeper: false,
|
|
}),
|
|
setIdleTimeoutBySessionKey: ({ targetSessionKey, accountId, idleTimeoutMs }) =>
|
|
setTelegramThreadBindingIdleTimeoutBySessionKey({
|
|
targetSessionKey,
|
|
accountId: accountId ?? undefined,
|
|
idleTimeoutMs,
|
|
}),
|
|
setMaxAgeBySessionKey: ({ targetSessionKey, accountId, maxAgeMs }) =>
|
|
setTelegramThreadBindingMaxAgeBySessionKey({
|
|
targetSessionKey,
|
|
accountId: accountId ?? undefined,
|
|
maxAgeMs,
|
|
}),
|
|
},
|
|
groups: {
|
|
resolveRequireMention: resolveTelegramGroupRequireMention,
|
|
resolveToolPolicy: resolveTelegramGroupToolPolicy,
|
|
},
|
|
agentPrompt: {
|
|
messageToolCapabilities: ({ cfg, accountId }) => {
|
|
const inlineButtonsScope = resolveTelegramInlineButtonsScope({
|
|
cfg,
|
|
accountId: accountId ?? undefined,
|
|
});
|
|
return inlineButtonsScope === "off" ? [] : ["inlineButtons"];
|
|
},
|
|
reactionGuidance: ({ cfg, accountId }) => {
|
|
const level = resolveTelegramReactionLevel({
|
|
cfg,
|
|
accountId: accountId ?? undefined,
|
|
}).agentReactionGuidance;
|
|
return level ? { level, channelLabel: "Telegram" } : undefined;
|
|
},
|
|
},
|
|
messaging: {
|
|
normalizeTarget: normalizeTelegramMessagingTarget,
|
|
resolveSessionConversation: ({ kind, rawId }) =>
|
|
resolveTelegramSessionConversation({ kind, rawId }),
|
|
parseExplicitTarget: ({ raw }) => parseTelegramExplicitTarget(raw),
|
|
inferTargetChatType: ({ to }) => parseTelegramExplicitTarget(to).chatType,
|
|
formatTargetDisplay: ({ target, display, kind }) => {
|
|
const formatted = display?.trim();
|
|
if (formatted) {
|
|
return formatted;
|
|
}
|
|
const trimmedTarget = target.trim();
|
|
if (!trimmedTarget) {
|
|
return trimmedTarget;
|
|
}
|
|
const withoutProvider = trimmedTarget.replace(/^(telegram|tg):/i, "");
|
|
if (kind === "user" || /^user:/i.test(withoutProvider)) {
|
|
return `@${withoutProvider.replace(/^user:/i, "")}`;
|
|
}
|
|
if (/^channel:/i.test(withoutProvider)) {
|
|
return `#${withoutProvider.replace(/^channel:/i, "")}`;
|
|
}
|
|
return withoutProvider;
|
|
},
|
|
resolveOutboundSessionRoute: (params) => resolveTelegramOutboundSessionRoute(params),
|
|
targetResolver: {
|
|
looksLikeId: looksLikeTelegramTargetId,
|
|
hint: "<chatId>",
|
|
},
|
|
},
|
|
resolver: {
|
|
resolveTargets: async ({ cfg, accountId, inputs, kind }) =>
|
|
await resolveTelegramTargets({ cfg, accountId, inputs, kind }),
|
|
},
|
|
lifecycle: {
|
|
onAccountConfigChanged: async ({ prevCfg, nextCfg, accountId }) => {
|
|
const previousToken = resolveTelegramAccount({ cfg: prevCfg, accountId }).token.trim();
|
|
const nextToken = resolveTelegramAccount({ cfg: nextCfg, accountId }).token.trim();
|
|
if (previousToken !== nextToken) {
|
|
const { deleteTelegramUpdateOffset } = await import("../update-offset-runtime-api.js");
|
|
await deleteTelegramUpdateOffset({ accountId });
|
|
}
|
|
},
|
|
onAccountRemoved: async ({ accountId }) => {
|
|
const { deleteTelegramUpdateOffset } = await import("../update-offset-runtime-api.js");
|
|
await deleteTelegramUpdateOffset({ accountId });
|
|
},
|
|
},
|
|
approvalCapability: {
|
|
...telegramApprovalCapability,
|
|
render: {
|
|
exec: {
|
|
buildPendingPayload: ({ request, nowMs }) =>
|
|
buildTelegramExecApprovalPendingPayload({ request, nowMs }),
|
|
},
|
|
},
|
|
},
|
|
directory: createChannelDirectoryAdapter({
|
|
listPeers: async (params) => listTelegramDirectoryPeersFromConfig(params),
|
|
listGroups: async (params) => listTelegramDirectoryGroupsFromConfig(params),
|
|
}),
|
|
actions: telegramMessageActions,
|
|
status: createComputedAccountStatusAdapter<ResolvedTelegramAccount, TelegramProbe, unknown>({
|
|
defaultRuntime: createDefaultChannelRuntimeState(DEFAULT_ACCOUNT_ID),
|
|
collectStatusIssues: collectTelegramStatusIssues,
|
|
buildChannelSummary: ({ snapshot }) => buildTokenChannelStatusSummary(snapshot),
|
|
probeAccount: async ({ account, timeoutMs }) =>
|
|
resolveTelegramProbe()(account.token, timeoutMs, {
|
|
accountId: account.accountId,
|
|
proxyUrl: account.config.proxy,
|
|
network: account.config.network,
|
|
apiRoot: account.config.apiRoot,
|
|
}),
|
|
formatCapabilitiesProbe: ({ probe }) => {
|
|
const lines = [];
|
|
if (probe?.bot?.username) {
|
|
const botId = probe.bot.id ? ` (${probe.bot.id})` : "";
|
|
lines.push({ text: `Bot: @${probe.bot.username}${botId}` });
|
|
}
|
|
const flags: string[] = [];
|
|
if (typeof probe?.bot?.canJoinGroups === "boolean") {
|
|
flags.push(`joinGroups=${probe.bot.canJoinGroups}`);
|
|
}
|
|
if (typeof probe?.bot?.canReadAllGroupMessages === "boolean") {
|
|
flags.push(`readAllGroupMessages=${probe.bot.canReadAllGroupMessages}`);
|
|
}
|
|
if (typeof probe?.bot?.supportsInlineQueries === "boolean") {
|
|
flags.push(`inlineQueries=${probe.bot.supportsInlineQueries}`);
|
|
}
|
|
if (flags.length > 0) {
|
|
lines.push({ text: `Flags: ${flags.join(" ")}` });
|
|
}
|
|
if (probe?.webhook?.url !== undefined) {
|
|
lines.push({ text: `Webhook: ${probe.webhook.url || "none"}` });
|
|
}
|
|
return lines;
|
|
},
|
|
auditAccount: async ({ account, timeoutMs, probe, cfg }) => {
|
|
const groups =
|
|
cfg.channels?.telegram?.accounts?.[account.accountId]?.groups ??
|
|
cfg.channels?.telegram?.groups;
|
|
const { groupIds, unresolvedGroups, hasWildcardUnmentionedGroups } =
|
|
resolveTelegramAuditCollector()(groups);
|
|
if (!groupIds.length && unresolvedGroups === 0 && !hasWildcardUnmentionedGroups) {
|
|
return undefined;
|
|
}
|
|
const botId = probe?.ok && probe.bot?.id != null ? probe.bot.id : null;
|
|
if (!botId) {
|
|
return {
|
|
ok: unresolvedGroups === 0 && !hasWildcardUnmentionedGroups,
|
|
checkedGroups: 0,
|
|
unresolvedGroups,
|
|
hasWildcardUnmentionedGroups,
|
|
groups: [],
|
|
elapsedMs: 0,
|
|
};
|
|
}
|
|
const audit = await resolveTelegramAuditMembership()({
|
|
token: account.token,
|
|
botId,
|
|
groupIds,
|
|
proxyUrl: account.config.proxy,
|
|
network: account.config.network,
|
|
apiRoot: account.config.apiRoot,
|
|
timeoutMs,
|
|
});
|
|
return { ...audit, unresolvedGroups, hasWildcardUnmentionedGroups };
|
|
},
|
|
resolveAccountSnapshot: ({ account, cfg, runtime, audit }) => {
|
|
const configuredFromStatus = resolveConfiguredFromCredentialStatuses(account);
|
|
const ownerAccountId = findTelegramTokenOwnerAccountId({
|
|
cfg,
|
|
accountId: account.accountId,
|
|
});
|
|
const duplicateTokenReason = ownerAccountId
|
|
? formatDuplicateTelegramTokenReason({
|
|
accountId: account.accountId,
|
|
ownerAccountId,
|
|
})
|
|
: null;
|
|
const configured =
|
|
(configuredFromStatus ?? Boolean(account.token?.trim())) && !ownerAccountId;
|
|
const groups =
|
|
cfg.channels?.telegram?.accounts?.[account.accountId]?.groups ??
|
|
cfg.channels?.telegram?.groups;
|
|
const allowUnmentionedGroups =
|
|
groups?.["*"]?.requireMention === false ||
|
|
Object.entries(groups ?? {}).some(
|
|
([key, value]) => key !== "*" && value?.requireMention === false,
|
|
);
|
|
return {
|
|
accountId: account.accountId,
|
|
name: account.name,
|
|
enabled: account.enabled,
|
|
configured,
|
|
extra: {
|
|
...projectCredentialSnapshotFields(account),
|
|
lastError: runtime?.lastError ?? duplicateTokenReason,
|
|
mode: runtime?.mode ?? (account.config.webhookUrl ? "webhook" : "polling"),
|
|
audit,
|
|
allowUnmentionedGroups,
|
|
},
|
|
};
|
|
},
|
|
}),
|
|
gateway: {
|
|
startAccount: async (ctx) => {
|
|
const account = ctx.account;
|
|
const ownerAccountId = findTelegramTokenOwnerAccountId({
|
|
cfg: ctx.cfg,
|
|
accountId: account.accountId,
|
|
});
|
|
if (ownerAccountId) {
|
|
const reason = formatDuplicateTelegramTokenReason({
|
|
accountId: account.accountId,
|
|
ownerAccountId,
|
|
});
|
|
ctx.log?.error?.(`[${account.accountId}] ${reason}`);
|
|
throw new Error(reason);
|
|
}
|
|
const token = (account.token ?? "").trim();
|
|
let telegramBotLabel = "";
|
|
try {
|
|
const probe = await resolveTelegramProbe()(token, 2500, {
|
|
accountId: account.accountId,
|
|
proxyUrl: account.config.proxy,
|
|
network: account.config.network,
|
|
apiRoot: account.config.apiRoot,
|
|
});
|
|
const username = probe.ok ? probe.bot?.username?.trim() : null;
|
|
if (username) {
|
|
telegramBotLabel = ` (@${username})`;
|
|
}
|
|
} catch (err) {
|
|
if (getTelegramRuntime().logging.shouldLogVerbose()) {
|
|
ctx.log?.debug?.(`[${account.accountId}] bot probe failed: ${String(err)}`);
|
|
}
|
|
}
|
|
ctx.log?.info(`[${account.accountId}] starting provider${telegramBotLabel}`);
|
|
return resolveTelegramMonitor()({
|
|
token,
|
|
accountId: account.accountId,
|
|
config: ctx.cfg,
|
|
runtime: ctx.runtime,
|
|
abortSignal: ctx.abortSignal,
|
|
useWebhook: Boolean(account.config.webhookUrl),
|
|
webhookUrl: account.config.webhookUrl,
|
|
webhookSecret: account.config.webhookSecret,
|
|
webhookPath: account.config.webhookPath,
|
|
webhookHost: account.config.webhookHost,
|
|
webhookPort: account.config.webhookPort,
|
|
webhookCertPath: account.config.webhookCertPath,
|
|
});
|
|
},
|
|
logoutAccount: async ({ accountId, cfg }) => {
|
|
const envToken = process.env.TELEGRAM_BOT_TOKEN?.trim() ?? "";
|
|
const nextCfg = { ...cfg } as OpenClawConfig;
|
|
const nextTelegram = cfg.channels?.telegram ? { ...cfg.channels.telegram } : undefined;
|
|
let cleared = false;
|
|
let changed = false;
|
|
if (nextTelegram) {
|
|
if (accountId === DEFAULT_ACCOUNT_ID && nextTelegram.botToken) {
|
|
delete nextTelegram.botToken;
|
|
cleared = true;
|
|
changed = true;
|
|
}
|
|
const accountCleanup = clearAccountEntryFields({
|
|
accounts: nextTelegram.accounts,
|
|
accountId,
|
|
fields: ["botToken"],
|
|
});
|
|
if (accountCleanup.changed) {
|
|
changed = true;
|
|
if (accountCleanup.cleared) {
|
|
cleared = true;
|
|
}
|
|
if (accountCleanup.nextAccounts) {
|
|
nextTelegram.accounts = accountCleanup.nextAccounts;
|
|
} else {
|
|
delete nextTelegram.accounts;
|
|
}
|
|
}
|
|
}
|
|
if (changed) {
|
|
if (nextTelegram && Object.keys(nextTelegram).length > 0) {
|
|
nextCfg.channels = { ...nextCfg.channels, telegram: nextTelegram };
|
|
} else {
|
|
const nextChannels = { ...nextCfg.channels };
|
|
delete nextChannels.telegram;
|
|
if (Object.keys(nextChannels).length > 0) {
|
|
nextCfg.channels = nextChannels;
|
|
} else {
|
|
delete nextCfg.channels;
|
|
}
|
|
}
|
|
}
|
|
const resolved = resolveTelegramAccount({
|
|
cfg: changed ? nextCfg : cfg,
|
|
accountId,
|
|
});
|
|
const loggedOut = resolved.tokenSource === "none";
|
|
if (changed) {
|
|
await getTelegramRuntime().config.writeConfigFile(nextCfg);
|
|
}
|
|
return { cleared, envToken: Boolean(envToken), loggedOut };
|
|
},
|
|
},
|
|
},
|
|
pairing: {
|
|
text: {
|
|
idLabel: "telegramUserId",
|
|
message: PAIRING_APPROVED_MESSAGE,
|
|
normalizeAllowEntry: createPairingPrefixStripper(/^(telegram|tg):/i),
|
|
notify: async ({ cfg, id, message, accountId }) => {
|
|
const { token } = resolveTelegramTokenHelper()(cfg, { accountId });
|
|
if (!token) {
|
|
throw new Error("telegram token not configured");
|
|
}
|
|
await resolveTelegramSend()(id, message, { token, accountId });
|
|
},
|
|
},
|
|
},
|
|
security: {
|
|
dm: {
|
|
channelKey: "telegram",
|
|
resolvePolicy: (account) => account.config.dmPolicy,
|
|
resolveAllowFrom: (account) => account.config.allowFrom,
|
|
policyPathSuffix: "dmPolicy",
|
|
normalizeEntry: (raw) => raw.replace(/^(telegram|tg):/i, ""),
|
|
},
|
|
collectWarnings: collectTelegramSecurityWarnings,
|
|
},
|
|
threading: {
|
|
topLevelReplyToMode: "telegram",
|
|
buildToolContext: (params) => buildTelegramThreadingToolContext(params),
|
|
resolveAutoThreadId: ({ to, toolContext, replyToId }) =>
|
|
replyToId ? undefined : resolveTelegramAutoThreadId({ to, toolContext }),
|
|
},
|
|
outbound: {
|
|
base: {
|
|
deliveryMode: "direct",
|
|
chunker: (text, limit) => getTelegramRuntime().channel.text.chunkMarkdownText(text, limit),
|
|
chunkerMode: "markdown",
|
|
textChunkLimit: 4000,
|
|
pollMaxOptions: 10,
|
|
shouldSuppressLocalPayloadPrompt: ({ cfg, accountId, payload }) =>
|
|
shouldSuppressLocalTelegramExecApprovalPrompt({
|
|
cfg,
|
|
accountId,
|
|
payload,
|
|
}),
|
|
beforeDeliverPayload: async ({ cfg, target, hint }) => {
|
|
if (hint?.kind !== "approval-pending" || hint.approvalKind !== "exec") {
|
|
return;
|
|
}
|
|
const threadId =
|
|
typeof target.threadId === "number"
|
|
? target.threadId
|
|
: typeof target.threadId === "string"
|
|
? Number.parseInt(target.threadId, 10)
|
|
: undefined;
|
|
await sendTypingTelegram(target.to, {
|
|
cfg,
|
|
accountId: target.accountId ?? undefined,
|
|
...(Number.isFinite(threadId) ? { messageThreadId: threadId } : {}),
|
|
}).catch(() => {});
|
|
},
|
|
shouldSkipPlainTextSanitization: ({ payload }) => Boolean(payload.channelData),
|
|
resolveEffectiveTextChunkLimit: ({ fallbackLimit }) =>
|
|
typeof fallbackLimit === "number" ? Math.min(fallbackLimit, 4096) : 4096,
|
|
sendPayload: async ({
|
|
cfg,
|
|
to,
|
|
payload,
|
|
mediaLocalRoots,
|
|
accountId,
|
|
deps,
|
|
replyToId,
|
|
threadId,
|
|
silent,
|
|
forceDocument,
|
|
gatewayClientScopes,
|
|
}) => {
|
|
const send = resolveTelegramSend(deps);
|
|
const result = await sendTelegramPayloadMessages({
|
|
send,
|
|
to,
|
|
payload,
|
|
baseOpts: buildTelegramSendOptions({
|
|
cfg,
|
|
mediaLocalRoots,
|
|
accountId,
|
|
replyToId,
|
|
threadId,
|
|
silent,
|
|
forceDocument,
|
|
gatewayClientScopes,
|
|
}),
|
|
});
|
|
return attachChannelToResult("telegram", result);
|
|
},
|
|
},
|
|
attachedResults: {
|
|
channel: "telegram",
|
|
sendText: async ({
|
|
cfg,
|
|
to,
|
|
text,
|
|
accountId,
|
|
deps,
|
|
replyToId,
|
|
threadId,
|
|
silent,
|
|
gatewayClientScopes,
|
|
}) =>
|
|
await sendTelegramOutbound({
|
|
cfg,
|
|
to,
|
|
text,
|
|
accountId,
|
|
deps,
|
|
replyToId,
|
|
threadId,
|
|
silent,
|
|
gatewayClientScopes,
|
|
}),
|
|
sendMedia: async ({
|
|
cfg,
|
|
to,
|
|
text,
|
|
mediaUrl,
|
|
mediaLocalRoots,
|
|
accountId,
|
|
deps,
|
|
replyToId,
|
|
threadId,
|
|
silent,
|
|
gatewayClientScopes,
|
|
}) =>
|
|
await sendTelegramOutbound({
|
|
cfg,
|
|
to,
|
|
text,
|
|
mediaUrl,
|
|
mediaLocalRoots,
|
|
accountId,
|
|
deps,
|
|
replyToId,
|
|
threadId,
|
|
silent,
|
|
gatewayClientScopes,
|
|
}),
|
|
sendPoll: async ({
|
|
cfg,
|
|
to,
|
|
poll,
|
|
accountId,
|
|
threadId,
|
|
silent,
|
|
isAnonymous,
|
|
gatewayClientScopes,
|
|
}) =>
|
|
await sendPollTelegram(to, poll, {
|
|
cfg,
|
|
accountId: accountId ?? undefined,
|
|
messageThreadId: parseTelegramThreadId(threadId),
|
|
silent: silent ?? undefined,
|
|
isAnonymous: isAnonymous ?? undefined,
|
|
gatewayClientScopes,
|
|
}),
|
|
},
|
|
},
|
|
});
|