Files
ragflow/internal/handler/api_token.go

153 lines
4.3 KiB
Go
Raw Normal View History

//
// Copyright 2026 The InfiniFlow Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
package handler
import (
Test: release Go-proxy RESTful contract tests verified passing in Go mode (#17468) ### Summary Aligns Go and Python error codes/messages so both backends honor the same RESTful API contract, removing implementation-specific error leaks (MySQL errors, `ValueError`, `AttributeError`, Gin validator format) in favor of clean business error codes. **Chat list** — invalid `orderby` now returns code 101 (was: raw Python `AttributeError` code 100); invalid `page`/`page_size` values fall back to defaults (was: raw `ValueError`/`ProgrammingError` code 100). **Dataset create/update/delete** — adds UUID validation (101), extra-field rejection (101), duplicate-id detection (101), content-type / JSON-syntax / object-shape checks (101), and "lacks permission" for nonexistent datasets (IDOR). Create auto-deduplicates dataset names. Pagerank updates tolerate a missing ES index. List response includes `parser_config` and `pagerank`. **Session list/update** — adds filtering, sorting, and pagination support. Empty payloads are valid no-ops. Authorization errors map to code 109. **Chunk list** — doc object uses Python key names (`chunk_count`, `dataset_id`, `chunk_method`, run text status). Add validates list element types. **Document update** — adds `chunk_method` alias, pydantic-style Field error messages, metadata index auto-create with refresh, and "These documents do not belong to dataset" messages. List validates `metadata_condition` and reports ownership errors for unmatched name/id filters. **Search completion** — `kb_ids` ownership failure returns code 102 instead of 109. Released 31 contract tests from `GO_ONLY_SKIPS` (all verified passing on both Go and Python backends with real LLM keys).
2026-07-30 19:58:49 +08:00
"errors"
"io"
"net/http"
"ragflow/internal/common"
"ragflow/internal/dao"
"ragflow/internal/entity"
"ragflow/internal/service"
"github.com/gin-gonic/gin"
)
func (h *SystemHandler) ListAPIKeys(c *gin.Context) {
// Get current user from context
user, exists := c.Get("user")
if !exists {
common.ResponseWithHttpCodeData(c, http.StatusUnauthorized, 401, nil, "Unauthorized")
return
}
userModel, ok := user.(*entity.User)
if !ok {
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, "Invalid user data")
return
}
// Get user's tenant with owner role
userTenantDAO := dao.NewUserTenantDAO()
ctx := c.Request.Context()
tenants, err := userTenantDAO.GetByUserIDAndRole(ctx, dao.DB, userModel.ID, "owner")
if err != nil || len(tenants) == 0 {
common.ResponseWithHttpCodeData(c, http.StatusBadRequest, 400, nil, "Tenant not found")
return
}
tenantID := tenants[0].TenantID
// Get keys for the tenant
keys, err := h.systemService.ListAPIKeys(ctx, tenantID)
if err != nil {
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, "Failed to list keys")
return
}
common.SuccessWithData(c, keys, "success")
}
func (h *SystemHandler) CreateKey(c *gin.Context) {
// Get current user from context
user, exists := c.Get("user")
if !exists {
common.ResponseWithHttpCodeData(c, http.StatusUnauthorized, 401, nil, "Unauthorized")
return
}
userModel, ok := user.(*entity.User)
if !ok {
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, "Invalid user data")
return
}
// Get user's tenant with owner role
userTenantDAO := dao.NewUserTenantDAO()
ctx := c.Request.Context()
tenants, err := userTenantDAO.GetByUserIDAndRole(ctx, dao.DB, userModel.ID, "owner")
if err != nil || len(tenants) == 0 {
common.ResponseWithHttpCodeData(c, http.StatusBadRequest, 400, nil, "Tenant not found")
return
}
tenantID := tenants[0].TenantID
Test: release Go-proxy RESTful contract tests verified passing in Go mode (#17468) ### Summary Aligns Go and Python error codes/messages so both backends honor the same RESTful API contract, removing implementation-specific error leaks (MySQL errors, `ValueError`, `AttributeError`, Gin validator format) in favor of clean business error codes. **Chat list** — invalid `orderby` now returns code 101 (was: raw Python `AttributeError` code 100); invalid `page`/`page_size` values fall back to defaults (was: raw `ValueError`/`ProgrammingError` code 100). **Dataset create/update/delete** — adds UUID validation (101), extra-field rejection (101), duplicate-id detection (101), content-type / JSON-syntax / object-shape checks (101), and "lacks permission" for nonexistent datasets (IDOR). Create auto-deduplicates dataset names. Pagerank updates tolerate a missing ES index. List response includes `parser_config` and `pagerank`. **Session list/update** — adds filtering, sorting, and pagination support. Empty payloads are valid no-ops. Authorization errors map to code 109. **Chunk list** — doc object uses Python key names (`chunk_count`, `dataset_id`, `chunk_method`, run text status). Add validates list element types. **Document update** — adds `chunk_method` alias, pydantic-style Field error messages, metadata index auto-create with refresh, and "These documents do not belong to dataset" messages. List validates `metadata_condition` and reports ownership errors for unmatched name/id filters. **Search completion** — `kb_ids` ownership failure returns code 102 instead of 109. Released 31 contract tests from `GO_ONLY_SKIPS` (all verified passing on both Go and Python backends with real LLM keys).
2026-07-30 19:58:49 +08:00
// Parse request. An empty body is valid (all fields are optional);
// ShouldBind reports io.EOF for it.
var req service.CreateAPIKeyRequest
Test: release Go-proxy RESTful contract tests verified passing in Go mode (#17468) ### Summary Aligns Go and Python error codes/messages so both backends honor the same RESTful API contract, removing implementation-specific error leaks (MySQL errors, `ValueError`, `AttributeError`, Gin validator format) in favor of clean business error codes. **Chat list** — invalid `orderby` now returns code 101 (was: raw Python `AttributeError` code 100); invalid `page`/`page_size` values fall back to defaults (was: raw `ValueError`/`ProgrammingError` code 100). **Dataset create/update/delete** — adds UUID validation (101), extra-field rejection (101), duplicate-id detection (101), content-type / JSON-syntax / object-shape checks (101), and "lacks permission" for nonexistent datasets (IDOR). Create auto-deduplicates dataset names. Pagerank updates tolerate a missing ES index. List response includes `parser_config` and `pagerank`. **Session list/update** — adds filtering, sorting, and pagination support. Empty payloads are valid no-ops. Authorization errors map to code 109. **Chunk list** — doc object uses Python key names (`chunk_count`, `dataset_id`, `chunk_method`, run text status). Add validates list element types. **Document update** — adds `chunk_method` alias, pydantic-style Field error messages, metadata index auto-create with refresh, and "These documents do not belong to dataset" messages. List validates `metadata_condition` and reports ownership errors for unmatched name/id filters. **Search completion** — `kb_ids` ownership failure returns code 102 instead of 109. Released 31 contract tests from `GO_ONLY_SKIPS` (all verified passing on both Go and Python backends with real LLM keys).
2026-07-30 19:58:49 +08:00
if err = c.ShouldBind(&req); err != nil && !errors.Is(err, io.EOF) {
common.ResponseWithHttpCodeData(c, http.StatusBadRequest, 400, nil, "Invalid request")
return
}
// Create key
key, err := h.systemService.CreateAPIKey(ctx, tenantID, &req)
if err != nil {
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, "Failed to create key")
return
}
common.SuccessWithData(c, key, "success")
}
func (h *SystemHandler) DeleteKey(c *gin.Context) {
// Get current user from context
user, exists := c.Get("user")
if !exists {
common.ResponseWithHttpCodeData(c, http.StatusUnauthorized, 401, nil, "Unauthorized")
return
}
userModel, ok := user.(*entity.User)
if !ok {
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, "Invalid user data")
return
}
ctx := c.Request.Context()
// Get user's tenant with owner role
userTenantDAO := dao.NewUserTenantDAO()
tenants, err := userTenantDAO.GetByUserIDAndRole(ctx, dao.DB, userModel.ID, "owner")
if err != nil || len(tenants) == 0 {
common.ResponseWithHttpCodeData(c, http.StatusBadRequest, 400, nil, "Tenant not found")
return
}
tenantID := tenants[0].TenantID
// Get key from path parameter
key := c.Param("key")
if key == "" {
common.ResponseWithHttpCodeData(c, http.StatusBadRequest, 400, nil, "Key is required")
return
}
// Delete key
if err = h.systemService.DeleteAPIKey(ctx, tenantID, key); err != nil {
common.ResponseWithHttpCodeData(c, http.StatusInternalServerError, 500, nil, "Failed to delete key")
return
}
common.SuccessWithData(c, true, "success")
}