WeKnora/internal/handler/im.go

556 lines
18 KiB
Go
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

package handler
import (
"context"
"errors"
"net/http"
"sort"
"strings"
"github.com/Tencent/WeKnora/internal/im"
"github.com/Tencent/WeKnora/internal/logger"
"github.com/Tencent/WeKnora/internal/plugin/manifest"
"github.com/Tencent/WeKnora/internal/types"
"github.com/gin-gonic/gin"
"gorm.io/gorm"
)
// validIMPlatforms is the set of supported IM platforms.
var validIMPlatforms = map[string]bool{
"wecom": true, "feishu": true, "lark": true, "slack": true, "telegram": true, "dingtalk": true,
"mattermost": true, "wechat": true, "qqbot": true, "yunzhijia": true,
}
// invalidIMPlatformError is the 400 message listing the accepted platforms. It
// is derived from validIMPlatforms so the two cannot drift apart as platforms
// are added.
var invalidIMPlatformError = func() string {
names := make([]string, 0, len(validIMPlatforms))
for p := range validIMPlatforms {
names = append(names, "'"+p+"'")
}
sort.Strings(names)
return "platform must be one of: " + strings.Join(names, ", ")
}()
// IMHandler handles IM platform callback requests and channel CRUD.
type IMHandler struct {
pluginGated
imService *im.Service
}
// NewIMHandler creates a new IM handler.
func NewIMHandler(imService *im.Service) *IMHandler {
return &IMHandler{
imService: imService,
}
}
// GetIMChannel godoc
// @Summary 获取 IM 渠道
// @Description 返回单个渠道供编辑:凭证中的密钥字段以 *** 代替
// @Tags IM
// @Produce json
// @Param id path string true "渠道 ID"
// @Success 200 {object} map[string]interface{}
// @Security Bearer
// @Security ApiKeyAuth
// @Router /im-channels/{id} [get]
func (h *IMHandler) GetIMChannel(c *gin.Context) {
tenantID, ok := c.Request.Context().Value(types.TenantIDContextKey).(uint64)
if !ok {
c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
return
}
channel, err := h.imService.GetChannelByIDAndTenant(c.Param("id"), tenantID)
if err != nil {
c.JSON(http.StatusNotFound, gin.H{"error": "channel not found"})
return
}
creds, err := im.RedactCredentials(channel.Platform, channel.Credentials)
if err != nil {
creds = map[string]any{}
}
c.JSON(http.StatusOK, gin.H{"data": struct {
*im.IMChannel
Credentials map[string]any `json:"credentials"`
}{channel, creds}})
}
// ListIMPlatforms godoc
// @Summary 列出 IM 平台
// @Description 返回已注册的 IM 平台:支持的接入模式、控制台链接和凭证表单 Schema
// @Tags IM
// @Produce json
// @Success 200 {object} map[string]interface{}
// @Security Bearer
// @Security ApiKeyAuth
// @Router /im-channels/platforms [get]
func (h *IMHandler) ListIMPlatforms(c *gin.Context) {
enabled := h.pluginFilter(c)
platforms := make([]im.PlatformInfo, 0)
for _, p := range h.imService.PlatformInfos() {
if enabled(manifest.PointIMChannels, p.ID) {
platforms = append(platforms, p)
}
}
c.JSON(http.StatusOK, gin.H{"success": true, "data": platforms})
}
// ── Channel CRUD handlers ──
// CreateIMChannel creates a new IM channel for an agent.
func (h *IMHandler) CreateIMChannel(c *gin.Context) {
agentID := c.Param("id")
if agentID == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "agent_id is required"})
return
}
tenantID, ok := c.Request.Context().Value(types.TenantIDContextKey).(uint64)
if !ok {
c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
return
}
var req struct {
Platform string `json:"platform" binding:"required"`
Name string `json:"name"`
Mode string `json:"mode"`
OutputMode string `json:"output_mode"`
Locale string `json:"locale"`
SessionMode string `json:"session_mode"`
KnowledgeBaseID string `json:"knowledge_base_id"`
Credentials types.JSON `json:"credentials"`
Enabled *bool `json:"enabled"`
}
if err := c.ShouldBindJSON(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if !h.pluginFilter(c)(manifest.PointIMChannels, req.Platform) {
c.JSON(http.StatusBadRequest, gin.H{"error": disabledIntegrationError})
return
}
if !validIMPlatforms[req.Platform] {
c.JSON(http.StatusBadRequest, gin.H{"error": invalidIMPlatformError})
return
}
locale, err := normalizeIMLocale(req.Locale)
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
channel := &im.IMChannel{
TenantID: tenantID,
AgentID: agentID,
Platform: req.Platform,
Name: req.Name,
Mode: req.Mode,
OutputMode: req.OutputMode,
Locale: locale,
SessionMode: req.SessionMode,
Credentials: req.Credentials,
Enabled: true,
}
// The route guard passes an agent it cannot find in this workspace; both
// the agent and the file-saving KB must belong to the channel's workspace.
if err := h.imService.SetChannelAgentID(c.Request.Context(), channel, agentID); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": "agent not found"})
return
}
if err := h.imService.SetChannelKnowledgeBaseID(c.Request.Context(), channel, req.KnowledgeBaseID); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": "knowledge base not found"})
return
}
if req.Enabled != nil {
channel.Enabled = *req.Enabled
}
// WeChat uses long-polling mode and full output only
if req.Platform == "wechat" {
channel.Mode = "longpoll"
channel.OutputMode = "full"
} else {
if channel.Mode == "" {
if channel.Platform == "mattermost" || channel.Platform == "yunzhijia" {
channel.Mode = "webhook"
} else {
channel.Mode = "websocket"
}
}
if channel.OutputMode == "" {
channel.OutputMode = "stream"
}
}
if channel.Credentials == nil {
channel.Credentials = types.JSON("{}")
}
if err := h.imService.CreateChannel(channel); err != nil {
logger.Errorf(c.Request.Context(), "[IM] Create channel failed: %v", err)
if strings.HasPrefix(err.Error(), "duplicate_bot:") {
c.JSON(http.StatusConflict, gin.H{"error": strings.TrimPrefix(err.Error(), "duplicate_bot: ")})
return
}
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to create channel"})
return
}
c.JSON(http.StatusOK, gin.H{"data": channel})
}
// ListIMChannels lists all IM channels for an agent.
func (h *IMHandler) ListIMChannels(c *gin.Context) {
agentID := c.Param("id")
if agentID == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "agent_id is required"})
return
}
tenantID, ok := c.Request.Context().Value(types.TenantIDContextKey).(uint64)
if !ok {
c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
return
}
channels, err := h.imService.ListChannelsByAgent(agentID, tenantID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to list channels"})
return
}
c.JSON(http.StatusOK, gin.H{"data": im.SummarizeIMChannels(channels)})
}
// ListAllIMChannels lists every IM channel in the current tenant, across
// agents, for the cross-agent overview page. Credentials are intentionally
// NOT included in the response.
func (h *IMHandler) ListAllIMChannels(c *gin.Context) {
tenantID, ok := c.Request.Context().Value(types.TenantIDContextKey).(uint64)
if !ok {
c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
return
}
channels, err := h.imService.ListChannelsByTenant(c.Request.Context(), tenantID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to list channels"})
return
}
c.JSON(http.StatusOK, gin.H{"data": channels})
}
// UpdateIMChannel updates an IM channel.
//
// UpdateIMChannel godoc
// @Summary 更新 IM 渠道
// @Description 更新指定 IM 渠道的名称、模式、回复语言、知识库、凭证或启用状态
// @Tags IM 渠道
// @Accept json
// @Produce json
// @Param id path string true "渠道 ID"
// @Param request body map[string]interface{} true "更新字段(含 locale)"
// @Success 200 {object} map[string]interface{} "更新后的渠道"
// @Failure 400 {object} map[string]interface{} "请求参数错误"
// @Failure 404 {object} map[string]interface{} "渠道不存在"
// @Security Bearer
// @Security ApiKeyAuth
// @Router /im-channels/{id} [put]
func (h *IMHandler) UpdateIMChannel(c *gin.Context) {
channelID := c.Param("id")
if channelID == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "channel id is required"})
return
}
tenantID, ok := c.Request.Context().Value(types.TenantIDContextKey).(uint64)
if !ok {
c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
return
}
channel, err := h.imService.GetChannelByIDAndTenant(channelID, tenantID)
if err != nil {
c.JSON(http.StatusNotFound, gin.H{"error": "channel not found"})
return
}
var req struct {
Name *string `json:"name"`
Mode *string `json:"mode"`
OutputMode *string `json:"output_mode"`
Locale *string `json:"locale"`
SessionMode *string `json:"session_mode"`
KnowledgeBaseID *string `json:"knowledge_base_id"`
Credentials types.JSON `json:"credentials"`
Enabled *bool `json:"enabled"`
AgentID *string `json:"agent_id"`
}
if err := c.ShouldBindJSON(&req); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
if req.Name != nil {
channel.Name = *req.Name
}
if req.Mode != nil {
channel.Mode = *req.Mode
}
if req.OutputMode != nil {
channel.OutputMode = *req.OutputMode
}
if req.Locale != nil {
locale, err := normalizeIMLocale(*req.Locale)
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
channel.Locale = locale
}
if req.SessionMode != nil {
channel.SessionMode = *req.SessionMode
}
if req.KnowledgeBaseID != nil {
ctx := c.Request.Context()
if err := h.imService.SetChannelKnowledgeBaseID(ctx, channel, *req.KnowledgeBaseID); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": "knowledge base not found"})
return
}
}
if req.Credentials != nil {
// The editor loads credentials redacted (GetIMChannel), so merge
// rather than replace: omitted keys and unchanged secrets keep their
// stored values.
merged, err := im.MergeCredentials(channel.Platform, channel.Credentials, req.Credentials)
if err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": "invalid credentials"})
return
}
channel.Credentials = merged
}
if req.Enabled != nil {
channel.Enabled = *req.Enabled
}
if req.AgentID != nil {
newAgentID := strings.TrimSpace(*req.AgentID)
if newAgentID != "" && newAgentID != channel.AgentID {
if err := h.imService.SetChannelAgentID(c.Request.Context(), channel, newAgentID); err != nil {
logger.Errorf(c.Request.Context(), "[IM] Update channel agent failed: %v", err)
c.JSON(http.StatusBadRequest, gin.H{"error": "agent not found"})
return
}
}
}
if err := h.imService.UpdateChannel(channel); err != nil {
logger.Errorf(c.Request.Context(), "[IM] Update channel failed: %v", err)
if strings.HasPrefix(err.Error(), "duplicate_bot:") {
c.JSON(http.StatusConflict, gin.H{"error": strings.TrimPrefix(err.Error(), "duplicate_bot: ")})
return
}
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to update channel"})
return
}
c.JSON(http.StatusOK, gin.H{"data": channel})
}
func normalizeIMLocale(locale string) (string, error) {
locale = strings.TrimSpace(locale)
if locale == "" {
return "", nil
}
if normalized := types.NormalizeSupportedLocale(locale); normalized != "" {
return normalized, nil
}
return "", errors.New("locale must be one of: 'en-US', 'ja-JP', 'ko-KR', 'ru-RU', 'zh-CN'")
}
// DeleteIMChannel deletes an IM channel.
//
// DeleteIMChannel godoc
// @Summary 删除 IM 渠道
// @Description 删除指定 IM 渠道
// @Tags IM 渠道
// @Produce json
// @Param id path string true "渠道 ID"
// @Success 200 {object} map[string]interface{} "success: true"
// @Failure 400 {object} map[string]interface{} "请求参数错误"
// @Failure 404 {object} map[string]interface{} "渠道不存在"
// @Security Bearer
// @Security ApiKeyAuth
// @Router /im-channels/{id} [delete]
func (h *IMHandler) DeleteIMChannel(c *gin.Context) {
channelID := c.Param("id")
if channelID == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "channel id is required"})
return
}
tenantID, ok := c.Request.Context().Value(types.TenantIDContextKey).(uint64)
if !ok {
c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
return
}
if err := h.imService.DeleteChannel(channelID, tenantID); err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to delete channel"})
return
}
c.JSON(http.StatusOK, gin.H{"success": true})
}
// ToggleIMChannel toggles the enabled state of an IM channel.
//
// ToggleIMChannel godoc
// @Summary 启用/停用 IM 渠道
// @Description 切换指定 IM 渠道的启用状态
// @Tags IM 渠道
// @Produce json
// @Param id path string true "渠道 ID"
// @Success 200 {object} map[string]interface{} "更新后的渠道"
// @Failure 400 {object} map[string]interface{} "请求参数错误"
// @Failure 404 {object} map[string]interface{} "渠道不存在"
// @Security Bearer
// @Security ApiKeyAuth
// @Router /im-channels/{id}/toggle [post]
func (h *IMHandler) ToggleIMChannel(c *gin.Context) {
channelID := c.Param("id")
if channelID == "" {
c.JSON(http.StatusBadRequest, gin.H{"error": "channel id is required"})
return
}
tenantID, ok := c.Request.Context().Value(types.TenantIDContextKey).(uint64)
if !ok {
c.JSON(http.StatusUnauthorized, gin.H{"error": "unauthorized"})
return
}
channel, err := h.imService.ToggleChannel(channelID, tenantID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": "failed to toggle channel"})
return
}
c.JSON(http.StatusOK, gin.H{"data": channel})
}
func writeIMCallbackACK(c *gin.Context, platform string) {
if platform == "yunzhijia" {
c.JSON(http.StatusOK, gin.H{
"success": true,
"data": gin.H{
"type": 2,
"content": "",
},
})
return
}
c.JSON(http.StatusOK, gin.H{"success": true})
}
// ── Callback handlers ──
// IMCallback handles IM platform callback requests for a specific channel.
// Route: POST /api/v1/im/callback/:channel_id
//
// IMCallback godoc
// @Summary IM 平台回调
// @Description 接收各 IM 平台的事件回调;走平台自身签名校验,不使用 API Key
// @Tags IM 回调
// @Accept json
// @Produce json
// @Param channel_id path string true "渠道 ID"
// @Success 200 {object} map[string]interface{} "处理结果"
// @Failure 400 {object} map[string]interface{} "请求参数错误"
// @Failure 401 {object} map[string]interface{} "签名校验失败"
// @Router /im/callback/{channel_id} [get]
// @Router /im/callback/{channel_id} [post]
func (h *IMHandler) IMCallback(c *gin.Context) {
ctx := c.Request.Context()
channelID := c.Param("channel_id")
// Always validate the durable row before using a cached webhook adapter.
// This is the correctness fallback when a replica missed Redis invalidation
// while disconnected, and prevents stale credentials/config from being used.
adapter, channel, err := h.imService.EnsureChannelAdapter(channelID)
if err != nil {
if errors.Is(err, gorm.ErrRecordNotFound) {
logger.Errorf(ctx, "[IM] Channel not found for callback: %s", channelID)
c.JSON(http.StatusNotFound, gin.H{"error": "channel not found"})
return
}
if errors.Is(err, im.ErrChannelDisabled) {
logger.Errorf(ctx, "[IM] Channel disabled for callback: %s", channelID)
c.JSON(http.StatusServiceUnavailable, gin.H{"error": "channel is disabled"})
return
}
logger.Errorf(ctx, "[IM] Channel unavailable for callback %s: %v", channelID, err)
c.JSON(http.StatusServiceUnavailable, gin.H{"error": "channel not available"})
return
}
defaultMode := "websocket"
if channel.Platform == "mattermost" || channel.Platform == "yunzhijia" {
defaultMode = "webhook"
}
if im.ResolveMode(channel, defaultMode) != "webhook" ||
channel.Platform == "qqbot" || channel.Platform == "wechat" || channel.Platform == "dingtalk" {
c.JSON(http.StatusForbidden, gin.H{"error": "HTTP callbacks are disabled for this channel"})
return
}
logger.Infof(ctx, "[IM] Callback received platform=%s path_channel_id=%s", channel.Platform, channelID)
// Handle URL verification
if adapter.HandleURLVerification(c) {
return
}
// Verify callback signature
if err := adapter.VerifyCallback(c); err != nil {
logger.Errorf(ctx, "[IM] Callback verification failed for channel %s: %v", channelID, err)
c.JSON(http.StatusForbidden, gin.H{"error": "verification failed"})
return
}
// Parse the callback message
msg, err := adapter.ParseCallback(c)
if err != nil {
logger.Errorf(ctx, "[IM] Parse callback failed for channel %s: %v", channelID, err)
c.JSON(http.StatusBadRequest, gin.H{"error": "parse failed"})
return
}
// If nil, it's a non-message event - just acknowledge
if msg == nil {
if channel.Platform == "mattermost" {
logger.Infof(ctx, "[IM] Mattermost callback ignored (no message): path_channel_id=%s — check: (1) trigger word must be the *first word* of the post; (2) if channel+trigger are both set, post must be in that channel; (3) bot_user_id must not match the sender", channelID)
} else {
logger.Infof(ctx, "[IM] Callback parsed no message to process platform=%s path_channel_id=%s", channel.Platform, channelID)
}
writeIMCallbackACK(c, channel.Platform)
return
}
// Respond immediately to avoid platform timeout
writeIMCallbackACK(c, channel.Platform)
// Detach from gin request context
asyncCtx := context.WithoutCancel(ctx)
// Process message asynchronously
go func() {
if err := h.imService.HandleMessage(asyncCtx, msg, channelID); err != nil {
logger.Errorf(asyncCtx, "[IM] Handle message error for channel %s: %v", channelID, err)
}
}()
}