Files
HomeAgent/internal/plugins/webui/handler_knowledge_tree.go
JianFeeeee 6d38a164eb chore(module): Go module 路径随托管地迁移 gitcode → github
## 背景

仓库早已迁移到 GitHub(`github.com/JianFeeeee/HomeAgent`,CI/CD 都在那边跑),
gitcode 保留为**国内只读镜像**(`ci.yml` 的 sync-gitcode-main 快进推送)。
但 go.mod 的 module 路径一直是 `gitcode.com/JianFeeeee/...` —— 既与权威源
不符,`meta.SourceURL`(AGPL §13 的源码提供入口)也指向镜像而非实际运行的代码。

## 关键区分(这是本次改动安全的前提)

两个 module 是**不同**的,影响面差一个数量级:

| module | 谁依赖 | 改它的后果 |
|---|---|---|
| `.../HomeAgent`(主仓) | **只有主仓自己** | 内部重构,零外部影响 |
| `.../homeagent-sdk`(SDK 仓) | 主仓 49 文件 + 所有外部插件 | 需重编插件 |

★ 实测确认:**插件不 import 主仓 module**(`strings qq/plugin.bin | grep HomeAgent` = 0),
只依赖 SDK 仓。而插件与内核的边界是 **RPC 方法名字符串**
(`plugin.init` / `tool.invoke`…,见 proc/protocol.go),**与 Go module 名无关**。
⇒ module 改名**不改变任何 wire 协议**,现网已装的插件照常运行。

SDK 的 GitHub 仓名是 `homeagentsdk`(无连字符),module 路径必须与之精确匹配,
否则 `go get` 会因路径不符失败,故取 `github.com/JianFeeeee/homeagentsdk`。

## 改动

- `go.mod` / `go.sum`:两个 module 路径 + require/replace
- 277 个 Go 文件 + Makefile + 打包脚本的 import 与 ldflags 路径
- SDK 仓 `meta.CoreModule`、`tools/hmapdev` 的 module 声明与工程模板
- 对外文档/链接的仓库地址(README、PLUGIN_DEV、OVERVIEW 等)

## 明确**保留** gitcode 的地方(镜像机制,不能动)

- `GITCODE_TOKEN`、`GC_URL="…@gitcode.com"`(CI 同步 job)
- `gitcode.com/api/v5/...`(release 附件上传)
- git remote `gitcode`(镜像拉取/推送)
- `docs/zh/ci-cd-runbook.md`(整篇讲镜像运维)

## 验证

- `go build ./...` / `go vet ./...` 绿
- `go test ./... -count=1` → 48 包 ok / 0 FAIL
- hmapdev 工具链编译通过(`third_party/homeagent-sdk/tools/hmapdev`)
- 全仓残留检查:module 形态的 `gitcode.com/JianFeeeee` = 0
- 镜像机制抽验:GC_URL / @gitcode / api/v5 / remote 均完好

## 顺带修正

`hmapdev/templates.go` 的注释此前写「gitcode 的模块不在 proxy.golang.org 上」——
module 已迁 GitHub,该论断不再成立。改为如实说明**为何仍默认 replace 到本机 SDK**:
离线可构建、避免版本漂移、内网可用。理由与托管地无关,故 replace 保留。
2026-10-08 10:40:17 +08:00

151 lines
4.6 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

package webui
import (
"net/http"
"strconv"
"strings"
sdk "github.com/JianFeeeee/HomeAgent/internal/sdk"
)
// 知识库的**树形只读 API**。供外部 agent、skill、脚本按分类导航知识库。
//
// 为何只读:写入面已有 POST /api/v1/knowledge(可带媒体)。而写操作
// 需要决定"挂到哪个分类、是否带媒体、是否重算稠密向量",那是内核的事;
// 让外部 agent 自己拼分类路径反而容易写出越界/重名的条目。读多写少,
// 且读才是"让别的 agent 用起来"的关键。
//
// 鉴权沿用 requireAPI(api_key 或 cookie session),不新增鉴权面。
//
// 路由:
//
// GET /api/v1/knowledge/tree 整棵树
// GET /api/v1/knowledge/tree/{category} 某棵子树
// ?depth=N 限制层数(0/省略 = 不限)——分类多时做懒加载
// ?items=0|1 是否返回条目详情,默认 1
// ?preview=N 预览字数上限,默认 120
// ?q=关键词 在**该子树内**检索(分类 + 关键词组合)
// ?limit=N q 时的返回条数,默认 10
// GET /api/v1/knowledge/tree/categories 平铺分类列表
// GET /api/v1/knowledge/tree/counts 各分类条目数(倒序)
//
// 为什么把 categories/counts 也挂在 /tree/ 下:它们是**导航辅助**,
// 回答"有哪些分类、哪里的内容最多",与树形视图同源,挂在别处会割裂。
// handleKnowledgeTree 处理树形只读请求。
func (h *Handler) handleKnowledgeTree(w http.ResponseWriter, r *http.Request) {
if r.Method != http.MethodGet {
writeJSON(w, http.StatusMethodNotAllowed, map[string]string{"error": "只支持 GET"})
return
}
if h.knowledge == nil {
writeJSON(w, http.StatusServiceUnavailable, map[string]string{"error": "knowledge not available"})
return
}
// path 形如 /api/v1/knowledge/tree[/sub/category]
sub := strings.Trim(strings.TrimPrefix(r.URL.Path, "/api/v1/knowledge/tree"), "/")
// 平铺分类列表
if sub == "categories" {
names, err := h.knowledge.Categories()
if err != nil {
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": err.Error()})
return
}
if names == nil {
names = []string{}
}
writeJSON(w, http.StatusOK, map[string]interface{}{"categories": names})
return
}
// 各分类条目数
if sub == "counts" {
counts, err := h.knowledge.CategoryCounts()
if err != nil {
writeJSON(w, http.StatusInternalServerError, map[string]string{"error": err.Error()})
return
}
if counts == nil {
counts = []sdk.KnowledgeCategoryCount{}
}
writeJSON(w, http.StatusOK, map[string]interface{}{"counts": counts})
return
}
q := r.URL.Query()
opt := sdk.KnowledgeTreeOptions{
MaxDepth: intQuery(q.Get("depth"), 0),
IncludeItems: boolQuery(q.Get("items"), true),
PreviewLimit: intQuery(q.Get("preview"), 0),
}
// 分类 + 关键词:在该子树内检索
if keyword := strings.TrimSpace(q.Get("q")); keyword != "" {
limit := intQuery(q.Get("limit"), 10)
if limit <= 0 || limit > 100 {
limit = 10
}
results, err := h.knowledge.SearchIn(keyword, sub, limit)
if err != nil {
code, msg := knowledgeStatusFor(err)
writeJSON(w, code, map[string]string{"error": msg})
return
}
views := make([]knowledgeView, 0, len(results))
for _, k := range results {
views = append(views, toKnowledgeView(k, k.Name))
}
writeJSON(w, http.StatusOK, map[string]interface{}{
"results": views,
"category": sub,
"query": keyword,
})
return
}
// 树视图(category 为空 = 整棵树)
view, err := h.knowledge.Subtree(sub, opt)
if err != nil {
code, msg := knowledgeStatusFor(err)
writeJSON(w, code, map[string]string{"error": msg})
return
}
if view == nil {
// 分类不存在:这是调用方能自己纠正的错误,给 404 + 现有分类便于自查
known, _ := h.knowledge.Categories()
writeJSON(w, http.StatusNotFound, map[string]interface{}{
"error": "分类不存在: " + sub,
"categories": known,
})
return
}
writeJSON(w, http.StatusOK, map[string]interface{}{"tree": view})
}
// intQuery 解析整数查询参数;空/非法时用 def。
func intQuery(s string, def int) int {
if s == "" {
return def
}
n, err := strconv.Atoi(s)
if err != nil {
return def
}
return n
}
// boolQuery 解析布尔查询参数;空时用 def。接受 1/0/true/false。
func boolQuery(s string, def bool) bool {
if s == "" {
return def
}
switch strings.ToLower(s) {
case "1", "true", "yes", "on":
return true
case "0", "false", "no", "off":
return false
}
return def
}