Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

5.7 KB
Raw Blame
//
//  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 (
	"net/http"
	"ragflow/internal/common"
	"ragflow/internal/server"
	"ragflow/internal/service"
	"ragflow/internal/utility"

	"github.com/gin-gonic/gin"
)

// SystemHandler system handler
type SystemHandler struct {
	systemService *service.SystemService
}

// NewSystemHandler create system handler
func NewSystemHandler(systemService *service.SystemService) *SystemHandler {
	return &SystemHandler{
		systemService: systemService,
	}
}

// Ping health check endpoint
// @Summary Ping
// @Description Simple ping endpoint
// @Tags system
// @Produce plain
// @Success 200 {string} string "pong"
// @Router /v1/system/ping [get]
func (h *SystemHandler) Ping(c *gin.Context) {
	c.String(http.StatusOK, "pong")
}

// Health check
func (h *SystemHandler) Health(c *gin.Context) {
	c.JSON(200, gin.H{
		"status": "ok",
	})
}

// Healthz reports dependency health in the Python-compatible format.
func (h *SystemHandler) Healthz(c *gin.Context) {
	result, allOK := h.systemService.Healthz(c.Request.Context())
	statusCode := http.StatusOK
	if !allOK {
		statusCode = http.StatusInternalServerError
	}
	c.JSON(statusCode, result)
}

// GetConfig get system configuration
// @Summary Get System Configuration
// @Description Get system configuration including register enabled status
// @Tags system
// @Accept json
// @Produce json
// @Success 200 {object} map[string]interface{}
// @Router /api/v1/system/config [get]
func (h *SystemHandler) GetConfig(c *gin.Context) {
	config, err := h.systemService.GetConfig()
	if err != nil {
		common.Respond(c, http.StatusInternalServerError, 500, nil, "Failed to get system configuration")
		return
	}

	common.RespondSuccess(c, config, "success")
}

// GetStatus get RAGFlow status
func (h *SystemHandler) GetStatus(c *gin.Context) {

	ctx := c.Request.Context()
	status, err := h.systemService.GetStatus(ctx)
	if err != nil {
		jsonInternalError(c, err)
		return
	}

	common.RespondSuccess(c, status, "success")
}

// GetVersion get RAGFlow version
// @Summary Get RAGFlow Version
// @Description Get the current version of the application
// @Tags system
// @Accept json
// @Produce json
// @Security ApiKeyAuth
// @Success 200 {object} map[string]interface{}
// @Router /v1/system/version [get]
func (h *SystemHandler) GetVersion(c *gin.Context) {
	version, err := h.systemService.GetVersion()
	if err != nil {
		common.Respond(c, http.StatusInternalServerError, 500, nil, "Failed to get version")
		return
	}

	common.RespondSuccess(c, gin.H{"version": version.Version}, "success")
}

// GetLogLevel returns the current log level. The response uses the
// {"level": <value>} shape — the same shape the admin handler's
// /admin/log_level endpoint returns — so the two log endpoints stay
// in lockstep. Per-package level entries that the old pkgLevels
// table carried (e.g. "peewee", "pdfminer") were inert for the Go
// side and are no longer returned.
func (h *SystemHandler) GetLogLevel(c *gin.Context) {
	common.RespondSuccess(c, gin.H{"level": common.GetLogLevel()}, "success")
}

// SetLogLevelRequest set log level request. PkgName is accepted for
// backward compatibility with clients that previously targeted
// per-package levels; it is silently ignored. Only the global level
// can be set on the Go side.
type SetLogLevelRequest struct {
	PkgName string `json:"pkg_name"`
	Level   string `json:"level" binding:"required"`
}

// SetLogLevel sets the log level at runtime.
//
// The "pkg_name and level are required" error message is preserved
// verbatim from the pre-Go-port handler so existing clients that
// inspect `message` on the missing-field path keep working. On the
// Go side `pkg_name` is no longer required (per-package filtering
// is gone), but the message wording is unchanged for backward
// compatibility — only `level` is enforced by binding; `pkg_name`
// is accepted but ignored.
func (h *SystemHandler) SetLogLevel(c *gin.Context) {
	var req SetLogLevelRequest
	if err := c.ShouldBindJSON(&req); err != nil {
		common.RespondError(c, common.CodeDataError, "pkg_name and level are required")
		return
	}

	if err := common.SetLogLevel(req.Level); err != nil {
		common.RespondError(c, common.CodeDataError, "Invalid log level: "+req.Level)
		return
	}

	if config := server.GetConfig(); config != nil {
		config.SetLogLevel(req.Level)
	}

	common.RespondSuccess(c, gin.H{"level": req.Level}, "SUCCESS")
}

// ListEnvironments handle list environments
func (h *SystemHandler) ListEnvironments(c *gin.Context) {
	environments, err := h.systemService.ListEnvironments()
	if err != nil {
		common.RespondError(c, common.CodeServerError, err.Error())
		return
	}

	common.RespondSuccessList(c, environments, "SUCCESS")
}

// Language returns the backend runtime language so the front end can
// choose the appropriate code path (Go vs Python).
func (h *SystemHandler) Language(c *gin.Context) {
	common.RespondSuccess(c, map[string]string{"language": "go"}, "success")
}

func (h *SystemHandler) GetHardwareInfo(c *gin.Context) {
	hardwareInfo, err := utility.GetHardwareInfo()
	if err != nil {
		common.RespondError(c, common.CodeServerError, err.Error())
		return
	}
	common.RespondSuccess(c, hardwareInfo, "SUCCESS")
}