@wecode-ai/weibo-openclaw-plugin 1.0.0

package/src/weibo-hot-search.ts

@@ -0,0 +1,345 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+import { Type, type Static } from "@sinclair/typebox";
+
+// ============ Schema ============
+
+export const WeiboHotSearchSchema = Type.Object({
+  category: Type.String({
+    description:
+      "榜单类型（中文名称）：主榜、文娱榜、社会榜、生活榜、acg榜、科技榜、体育榜",
+    enum: ["主榜", "文娱榜", "社会榜", "生活榜", "acg榜", "科技榜", "体育榜"],
+  }),
+  count: Type.Optional(
+    Type.Number({
+      description: "返回条数，范围 1-50，默认为 50",
+      minimum: 1,
+      maximum: 50,
+    })
+  ),
+});
+
+export type WeiboHotSearchParams = Static<typeof WeiboHotSearchSchema>;
+
+// ============ Helpers ============
+
+function json(data: unknown) {
+  return {
+    content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }],
+    details: data,
+  };
+}
+
+// ============ API Types ============
+
+/**
+ * 热搜榜 API 响应结构
+ * API: http://open-im.api.weibo.com/open/weibo/hot_search
+ */
+export type WeiboHotSearchApiResponse = {
+  code: number;
+  message: string;
+  data: {
+    callTime?: string;
+    source?: string;
+    data: WeiboHotSearchItem[];
+  };
+};
+
+export type WeiboHotSearchItem = {
+  cat: string;
+  id: number;
+  word: string;
+  num: number;
+  flag: number;
+  app_query_link: string;
+  h5_query_link: string;
+  flag_link: string;
+};
+
+// ============ Category Mapping ============
+
+/**
+ * 榜单类型映射：中文名称 -> 内部标识 (sid)
+ */
+const CATEGORY_MAP: Record<string, string> = {
+  主榜: "v_openclaw",
+  文娱榜: "v_openclaw_ent",
+  社会榜: "v_openclaw_social",
+  生活榜: "v_openclaw_live",
+  acg榜: "v_openclaw_acg",
+  科技榜: "v_openclaw_tech",
+  体育榜: "v_openclaw_sport",
+};
+
+// ============ Token Management ============
+
+// Token 过期时间：2小时（7200秒），提前60秒刷新
+const TOKEN_EXPIRE_SECONDS = 7200;
+const TOKEN_REFRESH_BUFFER_SECONDS = 60;
+
+// 默认 token 端点
+const DEFAULT_TOKEN_ENDPOINT = "http://open-im.api.weibo.com/open/auth/ws_token";
+
+type HotSearchTokenCache = {
+  token: string;
+  acquiredAt: number;
+  expiresIn: number;
+};
+
+// 热搜专用的 token 缓存
+let hotSearchTokenCache: HotSearchTokenCache | null = null;
+
+type TokenResponse = {
+  data: {
+    token: string;
+    expire_in: number;
+  };
+};
+
+/**
+ * 获取热搜用的 token
+ * 通过 http://open-im.api.weibo.com/open/auth/ws_token 获取
+ * token 过期时间为 2 小时
+ */
+async function fetchHotSearchToken(
+  appId: string,
+  appSecret: string,
+  tokenEndpoint?: string
+): Promise<HotSearchTokenCache> {
+  const endpoint = tokenEndpoint || DEFAULT_TOKEN_ENDPOINT;
+
+  const response = await fetch(endpoint, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+    },
+    body: JSON.stringify({
+      app_id: appId,
+      app_secret: appSecret,
+    }),
+  });
+
+  if (!response.ok) {
+    const errorText = await response.text().catch(() => "");
+    throw new Error(
+      `获取热搜 token 失败: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`
+    );
+  }
+
+  const result = (await response.json()) as TokenResponse;
+
+  if (!result.data?.token) {
+    throw new Error("获取热搜 token 失败: 响应中缺少 token");
+  }
+
+  const tokenCache: HotSearchTokenCache = {
+    token: result.data.token,
+    acquiredAt: Date.now(),
+    expiresIn: result.data.expire_in || TOKEN_EXPIRE_SECONDS,
+  };
+
+  hotSearchTokenCache = tokenCache;
+  return tokenCache;
+}
+
+/**
+ * 获取有效的热搜 token
+ * 如果缓存的 token 未过期则返回缓存，否则重新获取
+ */
+async function getValidHotSearchToken(
+  appId: string,
+  appSecret: string,
+  tokenEndpoint?: string
+): Promise<string> {
+  // 检查缓存的 token 是否有效
+  if (hotSearchTokenCache) {
+    const expiresAt =
+      hotSearchTokenCache.acquiredAt +
+      hotSearchTokenCache.expiresIn * 1000 -
+      TOKEN_REFRESH_BUFFER_SECONDS * 1000;
+    if (Date.now() < expiresAt) {
+      return hotSearchTokenCache.token;
+    }
+  }
+
+  // 获取新 token
+  const tokenResult = await fetchHotSearchToken(appId, appSecret, tokenEndpoint);
+  return tokenResult.token;
+}
+
+// ============ Core Functions ============
+
+// 默认热搜端点
+const DEFAULT_HOT_SEARCH_ENDPOINT = "http://open-im.api.weibo.com/open/weibo/hot_search";
+
+/**
+ * 获取微博热搜榜
+ * 使用 token 认证方式访问
+ */
+async function fetchHotSearch(
+  token: string,
+  category: string,
+  count?: number,
+  endpoint?: string
+): Promise<WeiboHotSearchApiResponse> {
+  const apiEndpoint = endpoint || DEFAULT_HOT_SEARCH_ENDPOINT;
+
+  const url = new URL(apiEndpoint);
+  url.searchParams.set("token", token);
+  url.searchParams.set("category", category);
+  if (count !== undefined) {
+    url.searchParams.set("count", String(count));
+  }
+
+  const response = await fetch(url.toString(), {
+    method: "GET",
+    headers: {
+      "Content-Type": "application/json;charset=UTF-8",
+    },
+  });
+
+  if (!response.ok) {
+    const errorText = await response.text().catch(() => "");
+    throw new Error(
+      `获取热搜榜失败: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`
+    );
+  }
+
+  const result = (await response.json()) as WeiboHotSearchApiResponse;
+  return result;
+}
+
+/**
+ * 格式化热搜结果
+ */
+function formatHotSearchResult(result: WeiboHotSearchApiResponse, category: string) {
+  if (result.code !== 0) {
+    return {
+      success: false,
+      error: result.message || "获取热搜榜失败",
+    };
+  }
+
+  const data = result.data;
+
+  if (!data.data || data.data.length === 0) {
+    return {
+      success: true,
+      category,
+      total: 0,
+      callTime: data.callTime,
+      source: data.source,
+      items: [],
+      message: "没有找到热搜内容",
+    };
+  }
+
+  return {
+    success: true,
+    category,
+    total: data.data.length,
+    callTime: data.callTime,
+    source: data.source,
+    items: data.data.map((item) => ({
+      rank: item.id,
+      word: item.word,
+      hotValue: item.num,
+      category: item.cat,
+      flag: item.flag,
+      appLink: item.app_query_link,
+      h5Link: item.h5_query_link,
+      flagIcon: item.flag_link,
+    })),
+  };
+}
+
+// ============ Configuration Types ============
+
+export type WeiboHotSearchConfig = {
+  /** 热搜 API 端点，默认为 open-im.api.weibo.com */
+  weiboHotSearchEndpoint?: string;
+  /** App ID，用于获取 token */
+  appId?: string;
+  /** App Secret，用于获取 token */
+  appSecret?: string;
+  /** Token 端点，默认为 http://open-im.api.weibo.com/open/auth/ws_token */
+  tokenEndpoint?: string;
+  /** 是否启用热搜工具，默认为 true */
+  enabled?: boolean;
+};
+
+function getHotSearchConfig(api: OpenClawPluginApi): WeiboHotSearchConfig {
+  const weiboCfg = api.config?.channels?.weibo as Record<string, unknown> | undefined;
+  return {
+    weiboHotSearchEndpoint: weiboCfg?.weiboHotSearchEndpoint as string | undefined,
+    appId: weiboCfg?.appId as string | undefined,
+    appSecret: weiboCfg?.appSecret as string | undefined,
+    tokenEndpoint: weiboCfg?.tokenEndpoint as string | undefined,
+    enabled: weiboCfg?.weiboHotSearchEnabled !== false,
+  };
+}
+
+// ============ Tool Registration ============
+
+export function registerWeiboHotSearchTools(api: OpenClawPluginApi) {
+  const cfg = getHotSearchConfig(api);
+
+  // 检查是否禁用了工具
+  if (!cfg.enabled) {
+    api.logger.debug?.("weibo_hot_search: Tool disabled, skipping registration");
+    return;
+  }
+
+  // 检查是否配置了认证信息
+  if (!cfg.appId || !cfg.appSecret) {
+    api.logger.warn?.("weibo_hot_search: appId or appSecret not configured, tool disabled");
+    return;
+  }
+
+  const appId = cfg.appId;
+  const appSecret = cfg.appSecret;
+
+  api.registerTool(
+    () => ({
+      name: "weibo_hot_search",
+      label: "Weibo Hot Search",
+      description:
+        "获取微博热搜榜。支持多种榜单类型：主榜、文娱榜、社会榜、生活榜、acg榜、科技榜、体育榜。返回热搜词、热度值、排名等信息。使用此工具获取数据后，必须使用查询的榜单类型以及返回的 `callTime` 和 `source` 字段内容注明数据来源, 格式: {category}， 2026-03-12 12:00，来自于微博热搜。",
+      parameters: WeiboHotSearchSchema,
+      async execute(_toolCallId, params) {
+        const p = params as WeiboHotSearchParams;
+        try {
+          // 验证榜单类型
+          if (!CATEGORY_MAP[p.category]) {
+            return json({
+              success: false,
+              error: `无效的榜单类型: ${p.category}。支持的类型: ${Object.keys(CATEGORY_MAP).join("、")}`,
+            });
+          }
+
+          // 获取有效的 token
+          const token = await getValidHotSearchToken(
+            appId,
+            appSecret,
+            cfg.tokenEndpoint
+          );
+
+          const result = await fetchHotSearch(
+            token,
+            p.category,
+            p.count,
+            cfg.weiboHotSearchEndpoint
+          );
+
+          return json(formatHotSearchResult(result, p.category));
+        } catch (err) {
+          return json({
+            error: err instanceof Error ? err.message : String(err),
+          });
+        }
+      },
+    }),
+    { name: "weibo_hot_search" }
+  );
+  api.logger.info?.("weibo_hot_search: Registered weibo_hot_search tool");
+}

package/src/weibo-search.ts

@@ -0,0 +1,333 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+import { WeiboSearchSchema, type WeiboSearchParams } from "./search-schema.js";
+
+// ============ Helpers ============
+
+function json(data: unknown) {
+  return {
+    content: [{ type: "text" as const, text: JSON.stringify(data, null, 2) }],
+    details: data,
+  };
+}
+
+// ============ API Types ============
+
+/**
+ * 微博搜索 API 响应结构
+ * API: http://open-im.api.weibo.com/open/wis/search_query
+ */
+export type WeiboSearchApiResponse = {
+  code: number;
+  message: string;
+  data: {
+    analyzing: boolean;
+    completed: boolean;
+    msg: string;
+    msg_format: string;
+    msg_json: string;
+    noContent: boolean;
+    profile_image_url: string;
+    reference_num: number;
+    refused: boolean;
+    scheme: string;
+    status: number;
+    status_stage: number;
+    version: string;
+    callTime?: string;
+    source?: string;
+  };
+};
+// 保留旧类型以兼容可能的其他 API 格式
+export type WeiboSearchStatusItem = {
+  id: string;
+  mid: string;
+  text: string;
+  source: string;
+  created_at: string;
+  user: {
+    id: string;
+    screen_name: string;
+    profile_image_url: string;
+    followers_count: number;
+    friends_count: number;
+    statuses_count: number;
+    verified: boolean;
+    verified_type: number;
+    description: string;
+  };
+  reposts_count: number;
+  comments_count: number;
+  attitudes_count: number;
+  pic_urls?: Array<{ thumbnail_pic: string }>;
+  retweeted_status?: WeiboSearchStatusItem;
+};
+
+export type WeiboSearchResponse = {
+  statuses: WeiboSearchStatusItem[];
+  total_number: number;
+  previous_cursor: number;
+  next_cursor: number;
+};
+
+// ============ Token Management ============
+
+// Token 过期时间：2小时（7200秒），提前60秒刷新
+const TOKEN_EXPIRE_SECONDS = 7200;
+const TOKEN_REFRESH_BUFFER_SECONDS = 60;
+
+// 默认 token 端点
+const DEFAULT_TOKEN_ENDPOINT = "http://open-im.api.weibo.com/open/auth/ws_token";
+
+type SearchTokenCache = {
+  token: string;
+  acquiredAt: number;
+  expiresIn: number;
+};
+
+// 搜索专用的 token 缓存
+let searchTokenCache: SearchTokenCache | null = null;
+
+type SearchTokenResponse = {
+  data: {
+    token: string;
+    expire_in: number;
+  };
+};
+
+/**
+ * 获取搜索用的 token
+ * 通过 http://open-im.api.weibo.com/open/auth/ws_token 获取
+ * token 过期时间为 2 小时
+ */
+async function fetchSearchToken(
+  appId: string,
+  appSecret: string,
+  tokenEndpoint?: string
+): Promise<SearchTokenCache> {
+  const endpoint = tokenEndpoint || DEFAULT_TOKEN_ENDPOINT;
+
+  const response = await fetch(endpoint, {
+    method: "POST",
+    headers: {
+      "Content-Type": "application/json",
+    },
+    body: JSON.stringify({
+      app_id: appId,
+      app_secret: appSecret,
+    }),
+  });
+
+  if (!response.ok) {
+    const errorText = await response.text().catch(() => "");
+    throw new Error(
+      `获取搜索 token 失败: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`
+    );
+  }
+
+  const result = (await response.json()) as SearchTokenResponse;
+
+  if (!result.data?.token) {
+    throw new Error("获取搜索 token 失败: 响应中缺少 token");
+  }
+
+  const tokenCache: SearchTokenCache = {
+    token: result.data.token,
+    acquiredAt: Date.now(),
+    expiresIn: result.data.expire_in || TOKEN_EXPIRE_SECONDS,
+  };
+
+  searchTokenCache = tokenCache;
+  return tokenCache;
+}
+
+/**
+ * 获取有效的搜索 token
+ * 如果缓存的 token 未过期则返回缓存，否则重新获取
+ */
+async function getValidSearchToken(
+  appId: string,
+  appSecret: string,
+  tokenEndpoint?: string
+): Promise<string> {
+  // 检查缓存的 token 是否有效
+  if (searchTokenCache) {
+    const expiresAt =
+      searchTokenCache.acquiredAt +
+      searchTokenCache.expiresIn * 1000 -
+      TOKEN_REFRESH_BUFFER_SECONDS * 1000;
+    if (Date.now() < expiresAt) {
+      return searchTokenCache.token;
+    }
+  }
+
+  // 获取新 token
+  const tokenResult = await fetchSearchToken(appId, appSecret, tokenEndpoint);
+  return tokenResult.token;
+}
+
+// ============ Core Functions ============
+
+// 默认搜索端点
+const DEFAULT_SEARCH_ENDPOINT = "http://open-im.api.weibo.com/open/wis/search_query";
+
+/**
+ * 搜索微博内容
+ * 使用 token 认证方式访问
+ */
+async function searchWeibo(
+  query: string,
+  token: string,
+  weiboSearchEndpoint?: string
+): Promise<WeiboSearchApiResponse> {
+  const endpoint = weiboSearchEndpoint || DEFAULT_SEARCH_ENDPOINT;
+
+  const url = new URL(endpoint);
+  url.searchParams.set("query", query);
+  url.searchParams.set("token", token);
+
+  const response = await fetch(url.toString(), {
+    method: "GET",
+    headers: {
+      "Content-Type": "application/json",
+    },
+  });
+
+  if (!response.ok) {
+    const errorText = await response.text().catch(() => "");
+    throw new Error(
+      `微博搜索失败: ${response.status} ${response.statusText}${errorText ? ` - ${errorText}` : ""}`
+    );
+  }
+
+  const result = (await response.json()) as WeiboSearchApiResponse;
+  return result;
+}
+
+/**
+ * 格式化搜索结果
+ */
+function formatSearchResult(result: WeiboSearchApiResponse) {
+  if (result.code !== 0) {
+    return {
+      success: false,
+      error: result.message || "搜索失败",
+    };
+  }
+
+  const data = result.data;
+
+  // 如果没有内容
+  if (data.noContent) {
+    return {
+      success: true,
+      completed: data.completed,
+      noContent: true,
+      callTime: data.callTime,
+      source: data.source,
+      message: "没有找到相关内容",
+    };
+  }
+
+  // 如果被拒绝
+  if (data.refused) {
+    return {
+      success: false,
+      error: "搜索请求被拒绝",
+    };
+  }
+
+  return {
+    success: true,
+    completed: data.completed,
+    analyzing: data.analyzing,
+    content: data.msg,
+    contentFormat: data.msg_format,
+    referenceCount: data.reference_num,
+    scheme: data.scheme,
+    version: data.version,
+    callTime: data.callTime,
+    source: data.source,
+  };
+}
+
+// ============ Configuration Types ============
+
+export type WeiboSearchConfig = {
+  /** 搜索 API 端点，默认为 open-im.api.weibo.com */
+  weiboSearchEndpoint?: string;
+  /** App ID，用于获取 token */
+  appId?: string;
+  /** App Secret，用于获取 token */
+  appSecret?: string;
+  /** Token 端点，默认为 http://open-im.api.weibo.com/open/auth/ws_token */
+  tokenEndpoint?: string;
+  /** 是否启用搜索工具，默认为 true */
+  enabled?: boolean;
+};
+
+function getSearchConfig(api: OpenClawPluginApi): WeiboSearchConfig {
+  const weiboCfg = api.config?.channels?.weibo as Record<string, unknown> | undefined;
+  return {
+    weiboSearchEndpoint: weiboCfg?.weiboSearchEndpoint as string | undefined,
+    appId: weiboCfg?.appId as string | undefined,
+    appSecret: weiboCfg?.appSecret as string | undefined,
+    tokenEndpoint: weiboCfg?.tokenEndpoint as string | undefined,
+    enabled: weiboCfg?.weiboSearchEnabled !== false,
+  };
+}
+
+// ============ Tool Registration ============
+
+export function registerWeiboSearchTools(api: OpenClawPluginApi) {
+  const searchCfg = getSearchConfig(api);
+
+  // 检查是否禁用了搜索工具
+  if (!searchCfg.enabled) {
+    api.logger.debug?.("weibo_search: Search tool disabled, skipping registration");
+    return;
+  }
+
+  // 检查是否配置了认证信息
+  if (!searchCfg.appId || !searchCfg.appSecret) {
+    api.logger.warn?.("weibo_search: appId or appSecret not configured, search tool disabled");
+    return;
+  }
+
+  const appId = searchCfg.appId;
+  const appSecret = searchCfg.appSecret;
+
+  api.registerTool(
+    () => ({
+      name: "weibo_search",
+      label: "Weibo Search",
+      description:
+        "微博智搜工具，通过关键词获取微博智搜内容。使用此工具获取数据后，必须使用查询关键词以及返回的 `callTime` 和 `source` 字段内容注明数据来源, 格式: 关键词: {query}， 2026-03-12 12:00，来自于微博智搜。查询结果可直接使用",
+      parameters: WeiboSearchSchema,
+      async execute(_toolCallId, params) {
+        const p = params as WeiboSearchParams;
+        try {
+          // 获取有效的 token
+          const token = await getValidSearchToken(
+            appId,
+            appSecret,
+            searchCfg.tokenEndpoint
+          );
+
+          const result = await searchWeibo(
+            p.query,
+            token,
+            searchCfg.weiboSearchEndpoint
+          );
+
+          return json(formatSearchResult(result));
+        } catch (err) {
+          return json({
+            error: err instanceof Error ? err.message : String(err),
+          });
+        }
+      },
+    }),
+    { name: "weibo_search" }
+  );
+  api.logger.info?.("weibo_search: Registered weibo_search tool");
+}