wizardchen
ef01f99e69
Follow-up to the FAQ + Tag refactor in this same PR. Three additional
handler areas now run through the route-level g.KBAccess* guard:
- chunk.go : full refactor — helper effectiveCtxForKnowledge and
validateAndGetChunk's access check are gone; the
handler's chunk-fetch + ownership-mismatch check stay
as defence-in-depth (a same-tenant attacker can't
pass mismatched knowledge_id + chunk_id).
- knowledge.go and knowledgebase.go : routes now run the guard
BEFORE the handler. The in-handler
validateKnowledgeBaseAccess /
resolveKnowledgeAndValidateKBAccess helpers stay for
now because they branch on the agent_id query param
(specific-agent check vs. any-agent fallback) — that
handler-specific branch can collapse into the guard
in a follow-up. The duplicated DB roundtrip is
negligible compared to the handler's main work.
New middleware exports:
- KBIDFromChunkIDParam : walks chunk_id → KnowledgeBaseID via the
chunk's denormalised column.
- g.KBAccessReadFromChunkIDParam / g.KBAccessWriteFromChunkIDParam
: convenience methods on rbacGuards.
Route changes are purely additive (existing role / ownership guards
stay in place; the new KB-access guard runs after them and rewrites
the request's tenant context to the source tenant for shared KBs).
No new dependencies on the kbShareService / agentShareService at the
handler level for chunk.go — those move to the route layer.
Tests pass; behaviour unchanged.
373 lines
13 KiB
Go
373 lines
13 KiB
Go
package handler
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/Tencent/WeKnora/internal/application/service"
|
|
"github.com/Tencent/WeKnora/internal/errors"
|
|
"github.com/Tencent/WeKnora/internal/logger"
|
|
"github.com/Tencent/WeKnora/internal/types"
|
|
"github.com/Tencent/WeKnora/internal/types/interfaces"
|
|
secutils "github.com/Tencent/WeKnora/internal/utils"
|
|
"github.com/gin-gonic/gin"
|
|
)
|
|
|
|
// ChunkHandler defines HTTP handlers for chunk operations.
|
|
//
|
|
// All KB-access checks (own / org-shared / via shared agent) are now
|
|
// performed by the route-level g.KBAccessRead*FromKnowledgeIDParam /
|
|
// g.KBAccessWrite*FromKnowledgeIDParam / g.KBAccess*FromChunkIDParam
|
|
// guards in router.go — the guard rewrites c.Request.Context() to
|
|
// carry the effective tenant ID, so the handler reads tenant from
|
|
// context the way it always did.
|
|
//
|
|
// kgService is retained because the route-level *creator-ownership*
|
|
// lookup KBCreatorLookupFromKnowledgeIDParam still walks
|
|
// knowledge_id -> kb_id to resolve creator_id (separate axis from
|
|
// access — that lookup answers "is the caller the creator of THIS
|
|
// resource", not "does the caller's tenant have access").
|
|
type ChunkHandler struct {
|
|
service interfaces.ChunkService
|
|
kgService interfaces.KnowledgeService
|
|
}
|
|
|
|
// NewChunkHandler creates a new chunk handler.
|
|
func NewChunkHandler(service interfaces.ChunkService, kgService interfaces.KnowledgeService) *ChunkHandler {
|
|
return &ChunkHandler{service: service, kgService: kgService}
|
|
}
|
|
|
|
// GetChunkByIDOnly godoc
|
|
// @Summary 通过ID获取分块
|
|
// @Description 仅通过分块ID获取分块详情（不需要knowledge_id）；支持共享知识库下的分块访问
|
|
// @Tags 分块管理
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param id path string true "分块ID"
|
|
// @Success 200 {object} map[string]interface{} "分块详情"
|
|
// @Failure 400 {object} errors.AppError "请求参数错误"
|
|
// @Failure 404 {object} errors.AppError "分块不存在"
|
|
// @Security Bearer
|
|
// @Security ApiKeyAuth
|
|
// @Router /chunks/by-id/{id} [get]
|
|
func (h *ChunkHandler) GetChunkByIDOnly(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
logger.Info(ctx, "Start retrieving chunk by ID only")
|
|
|
|
chunkID := secutils.SanitizeForLog(c.Param("id"))
|
|
if chunkID == "" {
|
|
logger.Error(ctx, "Chunk ID is empty")
|
|
c.Error(errors.NewBadRequestError("Chunk ID cannot be empty"))
|
|
return
|
|
}
|
|
|
|
// Get chunk by ID without tenant filter (chunk may belong to shared
|
|
// KB; the route-level KB-access guard already verified read
|
|
// permission against the parent KB before we got here).
|
|
chunk, err := h.service.GetChunkByIDOnly(ctx, chunkID)
|
|
if err != nil {
|
|
if err == service.ErrChunkNotFound {
|
|
logger.Warnf(ctx, "Chunk not found, chunk ID: %s", chunkID)
|
|
c.Error(errors.NewNotFoundError("Chunk not found"))
|
|
return
|
|
}
|
|
logger.ErrorWithFields(ctx, err, nil)
|
|
c.Error(errors.NewInternalServerError(err.Error()))
|
|
return
|
|
}
|
|
|
|
// 对 chunk 内容进行安全清理
|
|
if chunk.Content != "" {
|
|
chunk.Content = secutils.SanitizeForDisplay(chunk.Content)
|
|
}
|
|
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"data": chunk,
|
|
})
|
|
}
|
|
|
|
// ListKnowledgeChunks godoc
|
|
// @Summary 获取知识分块列表
|
|
// @Description 获取指定知识下的所有分块列表，支持分页
|
|
// @Tags 分块管理
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param knowledge_id path string true "知识ID"
|
|
// @Param page query int false "页码" default(1)
|
|
// @Param page_size query int false "每页数量" default(10)
|
|
// @Success 200 {object} map[string]interface{} "分块列表"
|
|
// @Failure 400 {object} errors.AppError "请求参数错误"
|
|
// @Security Bearer
|
|
// @Security ApiKeyAuth
|
|
// @Router /chunks/{knowledge_id} [get]
|
|
func (h *ChunkHandler) ListKnowledgeChunks(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
logger.Info(ctx, "Start retrieving knowledge chunks list")
|
|
|
|
knowledgeID := secutils.SanitizeForLog(c.Param("knowledge_id"))
|
|
if knowledgeID == "" {
|
|
logger.Error(ctx, "Knowledge ID is empty")
|
|
c.Error(errors.NewBadRequestError("Knowledge ID cannot be empty"))
|
|
return
|
|
}
|
|
|
|
// Parse pagination parameters
|
|
var pagination types.Pagination
|
|
if err := c.ShouldBindQuery(&pagination); err != nil {
|
|
logger.Errorf(ctx, "Failed to parse pagination parameters: %s", secutils.SanitizeForLog(err.Error()))
|
|
c.Error(errors.NewBadRequestError(err.Error()))
|
|
return
|
|
}
|
|
if pagination.Page < 1 {
|
|
pagination.Page = 1
|
|
}
|
|
if pagination.PageSize < 1 {
|
|
pagination.PageSize = 10
|
|
}
|
|
if pagination.PageSize > 100 {
|
|
pagination.PageSize = 100
|
|
}
|
|
|
|
chunkType := []types.ChunkType{types.ChunkTypeText}
|
|
|
|
// The route-level guard has rewritten the request's tenant context
|
|
// to the effective tenant for shared KBs.
|
|
result, err := h.service.ListPagedChunksByKnowledgeID(ctx, knowledgeID, &pagination, chunkType)
|
|
if err != nil {
|
|
logger.ErrorWithFields(ctx, err, nil)
|
|
c.Error(errors.NewInternalServerError(err.Error()))
|
|
return
|
|
}
|
|
|
|
// 对 chunk 内容进行安全清理
|
|
for _, chunk := range result.Data.([]*types.Chunk) {
|
|
if chunk.Content != "" {
|
|
chunk.Content = secutils.SanitizeForDisplay(chunk.Content)
|
|
}
|
|
}
|
|
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"data": result.Data,
|
|
"total": result.Total,
|
|
"page": result.Page,
|
|
"page_size": result.PageSize,
|
|
})
|
|
}
|
|
|
|
// UpdateChunkRequest defines the request structure for updating a chunk
|
|
type UpdateChunkRequest struct {
|
|
Content string `json:"content"`
|
|
Embedding []float32 `json:"embedding"`
|
|
ChunkIndex int `json:"chunk_index"`
|
|
IsEnabled bool `json:"is_enabled"`
|
|
StartAt int `json:"start_at"`
|
|
EndAt int `json:"end_at"`
|
|
ImageInfo string `json:"image_info"`
|
|
}
|
|
|
|
// fetchChunkAndVerifyOwnership fetches a chunk by ID and verifies it
|
|
// belongs to the URL :knowledge_id (defence in depth: the route-level
|
|
// KB-access guard already ensured the caller has write access to the
|
|
// KB; this check stops a same-tenant attacker from passing one
|
|
// knowledge_id while addressing a chunk owned by a different
|
|
// knowledge in the same KB).
|
|
func (h *ChunkHandler) fetchChunkAndVerifyOwnership(c *gin.Context) (*types.Chunk, string, error) {
|
|
ctx := c.Request.Context()
|
|
|
|
knowledgeID := secutils.SanitizeForLog(c.Param("knowledge_id"))
|
|
if knowledgeID == "" {
|
|
logger.Error(ctx, "Knowledge ID is empty")
|
|
return nil, "", errors.NewBadRequestError("Knowledge ID cannot be empty")
|
|
}
|
|
id := secutils.SanitizeForLog(c.Param("id"))
|
|
if id == "" {
|
|
logger.Error(ctx, "Chunk ID is empty")
|
|
return nil, knowledgeID, errors.NewBadRequestError("Chunk ID cannot be empty")
|
|
}
|
|
chunk, err := h.service.GetChunkByID(ctx, id)
|
|
if err != nil {
|
|
if err == service.ErrChunkNotFound {
|
|
logger.Warnf(ctx, "Chunk not found, knowledge ID: %s, chunk ID: %s", knowledgeID, id)
|
|
return nil, knowledgeID, errors.NewNotFoundError("Chunk not found")
|
|
}
|
|
logger.ErrorWithFields(ctx, err, nil)
|
|
return nil, knowledgeID, errors.NewInternalServerError(err.Error())
|
|
}
|
|
if chunk.KnowledgeID != knowledgeID {
|
|
logger.Warnf(ctx, "Chunk does not belong to knowledge, knowledge ID: %s, chunk ID: %s", knowledgeID, id)
|
|
return nil, knowledgeID, errors.NewForbiddenError("No permission to access this chunk")
|
|
}
|
|
return chunk, knowledgeID, nil
|
|
}
|
|
|
|
// UpdateChunk godoc
|
|
// @Summary 更新分块
|
|
// @Description 更新指定分块的内容和属性
|
|
// @Tags 分块管理
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param knowledge_id path string true "知识ID"
|
|
// @Param id path string true "分块ID"
|
|
// @Param request body UpdateChunkRequest true "更新请求"
|
|
// @Success 200 {object} map[string]interface{} "更新后的分块"
|
|
// @Failure 400 {object} errors.AppError "请求参数错误"
|
|
// @Failure 404 {object} errors.AppError "分块不存在"
|
|
// @Security Bearer
|
|
// @Security ApiKeyAuth
|
|
// @Router /chunks/{knowledge_id}/{id} [put]
|
|
func (h *ChunkHandler) UpdateChunk(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
logger.Info(ctx, "Start updating knowledge chunk")
|
|
|
|
chunk, knowledgeID, err := h.fetchChunkAndVerifyOwnership(c)
|
|
if err != nil {
|
|
c.Error(err)
|
|
return
|
|
}
|
|
var req UpdateChunkRequest
|
|
if err := c.ShouldBindJSON(&req); err != nil {
|
|
logger.Errorf(ctx, "Failed to parse request parameters: %s", secutils.SanitizeForLog(err.Error()))
|
|
c.Error(errors.NewBadRequestError(err.Error()))
|
|
return
|
|
}
|
|
|
|
if req.Content != "" {
|
|
chunk.Content = req.Content
|
|
}
|
|
|
|
chunk.IsEnabled = req.IsEnabled
|
|
|
|
if err := h.service.UpdateChunk(ctx, chunk); err != nil {
|
|
logger.ErrorWithFields(ctx, err, nil)
|
|
c.Error(errors.NewInternalServerError(err.Error()))
|
|
return
|
|
}
|
|
|
|
logger.Infof(ctx, "Knowledge chunk updated successfully, knowledge ID: %s, chunk ID: %s",
|
|
secutils.SanitizeForLog(knowledgeID), secutils.SanitizeForLog(chunk.ID))
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"data": chunk,
|
|
})
|
|
}
|
|
|
|
// DeleteChunk godoc
|
|
// @Summary 删除分块
|
|
// @Description 删除指定的分块
|
|
// @Tags 分块管理
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param knowledge_id path string true "知识ID"
|
|
// @Param id path string true "分块ID"
|
|
// @Success 200 {object} map[string]interface{} "删除成功"
|
|
// @Failure 400 {object} errors.AppError "请求参数错误"
|
|
// @Failure 404 {object} errors.AppError "分块不存在"
|
|
// @Security Bearer
|
|
// @Security ApiKeyAuth
|
|
// @Router /chunks/{knowledge_id}/{id} [delete]
|
|
func (h *ChunkHandler) DeleteChunk(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
logger.Info(ctx, "Start deleting knowledge chunk")
|
|
|
|
chunk, _, err := h.fetchChunkAndVerifyOwnership(c)
|
|
if err != nil {
|
|
c.Error(err)
|
|
return
|
|
}
|
|
|
|
if err := h.service.DeleteChunk(ctx, chunk.ID); err != nil {
|
|
logger.ErrorWithFields(ctx, err, nil)
|
|
c.Error(errors.NewInternalServerError(err.Error()))
|
|
return
|
|
}
|
|
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"message": "Chunk deleted",
|
|
})
|
|
}
|
|
|
|
// DeleteChunksByKnowledgeID godoc
|
|
// @Summary 删除知识下所有分块
|
|
// @Description 删除指定知识下的所有分块
|
|
// @Tags 分块管理
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param knowledge_id path string true "知识ID"
|
|
// @Success 200 {object} map[string]interface{} "删除成功"
|
|
// @Failure 400 {object} errors.AppError "请求参数错误"
|
|
// @Security Bearer
|
|
// @Security ApiKeyAuth
|
|
// @Router /chunks/{knowledge_id} [delete]
|
|
func (h *ChunkHandler) DeleteChunksByKnowledgeID(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
logger.Info(ctx, "Start deleting all chunks under knowledge")
|
|
|
|
knowledgeID := secutils.SanitizeForLog(c.Param("knowledge_id"))
|
|
if knowledgeID == "" {
|
|
logger.Error(ctx, "Knowledge ID is empty")
|
|
c.Error(errors.NewBadRequestError("Knowledge ID cannot be empty"))
|
|
return
|
|
}
|
|
|
|
if err := h.service.DeleteChunksByKnowledgeID(ctx, knowledgeID); err != nil {
|
|
logger.ErrorWithFields(ctx, err, nil)
|
|
c.Error(errors.NewInternalServerError(err.Error()))
|
|
return
|
|
}
|
|
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"message": "All chunks under knowledge deleted",
|
|
})
|
|
}
|
|
|
|
// DeleteGeneratedQuestion godoc
|
|
// @Summary 删除生成的问题
|
|
// @Description 删除分块中生成的问题
|
|
// @Tags 分块管理
|
|
// @Accept json
|
|
// @Produce json
|
|
// @Param id path string true "分块ID"
|
|
// @Param request body object{question_id=string} true "问题ID"
|
|
// @Success 200 {object} map[string]interface{} "删除成功"
|
|
// @Failure 400 {object} errors.AppError "请求参数错误"
|
|
// @Failure 404 {object} errors.AppError "分块不存在"
|
|
// @Security Bearer
|
|
// @Security ApiKeyAuth
|
|
// @Router /chunks/by-id/{id}/questions [delete]
|
|
func (h *ChunkHandler) DeleteGeneratedQuestion(c *gin.Context) {
|
|
ctx := c.Request.Context()
|
|
logger.Info(ctx, "Start deleting generated question from chunk")
|
|
|
|
chunkID := secutils.SanitizeForLog(c.Param("id"))
|
|
if chunkID == "" {
|
|
logger.Error(ctx, "Chunk ID is empty")
|
|
c.Error(errors.NewBadRequestError("Chunk ID cannot be empty"))
|
|
return
|
|
}
|
|
|
|
var req struct {
|
|
QuestionID string `json:"question_id" binding:"required"`
|
|
}
|
|
if err := c.ShouldBindJSON(&req); err != nil {
|
|
logger.Errorf(ctx, "Failed to parse request parameters: %s", secutils.SanitizeForLog(err.Error()))
|
|
c.Error(errors.NewBadRequestError("Question ID is required"))
|
|
return
|
|
}
|
|
|
|
if err := h.service.DeleteGeneratedQuestion(ctx, chunkID, req.QuestionID); err != nil {
|
|
logger.ErrorWithFields(ctx, err, nil)
|
|
c.Error(errors.NewBadRequestError(err.Error()))
|
|
return
|
|
}
|
|
|
|
logger.Infof(ctx, "Generated question deleted successfully, chunk ID: %s, question ID: %s",
|
|
secutils.SanitizeForLog(chunkID), secutils.SanitizeForLog(req.QuestionID))
|
|
c.JSON(http.StatusOK, gin.H{
|
|
"success": true,
|
|
"message": "Generated question deleted",
|
|
})
|
|
}
|