mirror of
https://github.com/infiniflow/ragflow.git
synced 2026-07-14 08:58:27 +08:00
8bc18154d2
### Summary ``` RAGFlow(admin)> show version; +--------------+-----------------------+ | field | value | +--------------+-----------------------+ | version | v0.26.4-84-g547bc8614 | | version_type | open source | +--------------+-----------------------+ ``` --------- Signed-off-by: Jin Hai <haijin.chn@gmail.com>
114 lines
2.9 KiB
Go
114 lines
2.9 KiB
Go
//
|
|
// 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 common
|
|
|
|
import (
|
|
"fmt"
|
|
"net/http"
|
|
"strconv"
|
|
|
|
"github.com/gin-gonic/gin"
|
|
)
|
|
|
|
type response struct {
|
|
Code ErrorCode `json:"code"`
|
|
Data interface{} `json:"data"`
|
|
Message interface{} `json:"message"`
|
|
}
|
|
|
|
// errorResponse error response
|
|
type errorResponse struct {
|
|
Code ErrorCode `json:"code"`
|
|
Message interface{} `json:"message"`
|
|
}
|
|
|
|
// SuccessWithData returns success response with data
|
|
func SuccessWithData(c *gin.Context, data interface{}, message interface{}) {
|
|
c.JSON(http.StatusOK, response{
|
|
Code: CodeSuccess,
|
|
Data: data,
|
|
Message: message,
|
|
})
|
|
}
|
|
|
|
// SuccessNoMessage returns success response without message
|
|
func SuccessNoMessage(c *gin.Context, data interface{}) {
|
|
c.JSON(http.StatusOK, response{
|
|
Code: CodeSuccess,
|
|
Data: data,
|
|
})
|
|
}
|
|
|
|
// SuccessNoData returns success response without data
|
|
func SuccessNoData(c *gin.Context, message interface{}) {
|
|
c.JSON(http.StatusOK, response{
|
|
Code: CodeSuccess,
|
|
Data: nil,
|
|
Message: message,
|
|
})
|
|
}
|
|
|
|
// SuccessWithMessage returns success response with message only
|
|
func SuccessWithMessage(c *gin.Context, message string) {
|
|
c.JSON(http.StatusOK, response{
|
|
Code: CodeSuccess,
|
|
Message: message,
|
|
})
|
|
}
|
|
|
|
// ErrorWithCode returns error response with code and message
|
|
func ErrorWithCode(c *gin.Context, code ErrorCode, message string) {
|
|
c.JSON(http.StatusOK, errorResponse{
|
|
Code: code,
|
|
Message: message,
|
|
})
|
|
}
|
|
|
|
func ResponseWithCodeData(c *gin.Context, code ErrorCode, data interface{}, message string) {
|
|
c.JSON(http.StatusOK, response{
|
|
Code: code,
|
|
Data: data,
|
|
Message: message,
|
|
})
|
|
}
|
|
|
|
func ResponseWithHttpCodeData(c *gin.Context, httpCode int, code ErrorCode, data interface{}, message string) {
|
|
c.JSON(httpCode, response{
|
|
Code: code,
|
|
Data: data,
|
|
Message: message,
|
|
})
|
|
}
|
|
|
|
func ParseRequestIntPositive(c *gin.Context, parameter, parameterName string, defaultValue int) (int, error) {
|
|
var parameterInt int
|
|
var err error
|
|
if parameter == "" {
|
|
parameterInt = defaultValue
|
|
} else {
|
|
parameterInt, err = strconv.Atoi(parameter)
|
|
if err != nil {
|
|
return defaultValue, fmt.Errorf("%w: %s must be an integer", err, parameterName)
|
|
}
|
|
}
|
|
|
|
if parameterInt < 0 {
|
|
return defaultValue, fmt.Errorf("%w: %s must be a positive integer or zero", err, parameterName)
|
|
}
|
|
return parameterInt, nil
|
|
}
|