Skip to content

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

8.1 KB
Raw Blame
package dao

import "strings"

// An ORDER BY body is built by string concatenation, so a column name that
// reached it from a query parameter would be an injection point. Every entity
// therefore names the columns its list rows expose, and only those names can be
// rendered. The allowlists and the rendering live here so the rule has one
// owner rather than a copy in each data access file.

// OrderTerm is one column and direction in an ORDER BY list.
type OrderTerm struct {
	Column string
	Desc   bool
}

// ParseOrderTerms reads the `sort` query value, a comma separated list of
// `column:direction` terms such as `name:asc,create_time:desc`. A term that
// omits the direction is ascending. A term with an empty column or a direction
// that is neither `asc` nor `desc` costs its own term rather than the list, and
// an empty result leaves the caller on the older `orderby` and `desc` pair.
// Whether a column is orderable at all stays the entity allowlist's decision.
func ParseOrderTerms(sort string) []OrderTerm {
	terms := make([]OrderTerm, 0, strings.Count(sort, ",")+1)
	for _, part := range strings.Split(sort, ",") {
		column, direction, hasDirection := strings.Cut(part, ":")
		column = strings.TrimSpace(column)
		if column == "" {
			continue
		}
		term := OrderTerm{Column: column}
		if hasDirection {
			switch strings.ToLower(strings.TrimSpace(direction)) {
			case "asc":
			case "desc":
				term.Desc = true
			default:
				continue
			}
		}
		terms = append(terms, term)
	}
	if len(terms) == 0 {
		return nil
	}
	return terms
}

func renderTerm(table string, term OrderTerm) string {
	column := term.Column
	if table != "" {
		column = table + "." + column
	}
	if term.Desc {
		return column + " DESC"
	}
	return column + " ASC"
}

// orderClause renders terms as an ORDER BY body, keeping only the terms whose
// column the entity allows. When no term survives, the fallback column is
// rendered in the direction the first requested term asked for, which is what
// the single-value orderby parameter has always done with a name it does not
// recognise.
func orderClause(allowed map[string]struct{}, terms []OrderTerm, fallback string) string {
	return qualifiedOrderClause("", allowed, terms, fallback)
}

// qualifiedOrderClause is orderClause with a table qualifier on every column,
// for queries whose joins would otherwise leave a bare column name ambiguous.
func qualifiedOrderClause(table string, allowed map[string]struct{}, terms []OrderTerm, fallback string) string {
	kept := make([]string, 0, len(terms))
	for _, term := range terms {
		if _, ok := allowed[term.Column]; ok {
			kept = append(kept, renderTerm(table, term))
		}
	}
	if len(kept) == 0 {
		desc := len(terms) > 0 && terms[0].Desc
		return renderTerm(table, OrderTerm{Column: fallback, Desc: desc})
	}
	return strings.Join(kept, ", ")
}

// defaultOrderColumn is the column every entity falls back to.
const defaultOrderColumn = "create_time"

// chatOrderableColumns allows the scalar dialog columns the list rows expose plus the base timestamp columns.
var chatOrderableColumns = map[string]struct{}{
	"id":                       {},
	"tenant_id":                {},
	"name":                     {},
	"language":                 {},
	"llm_id":                   {},
	"tenant_llm_id":            {},
	"prompt_type":              {},
	"similarity_threshold":     {},
	"vector_similarity_weight": {},
	"top_n":                    {},
	"rerank_candidates_count":  {},
	"top_k":                    {},
	"do_refer":                 {},
	"rerank_id":                {},
	"tenant_rerank_id":         {},
	"status":                   {},
	"create_time":              {},
	"create_date":              {},
	"update_time":              {},
	"update_date":              {},
}

// chatSessionOrderableColumns allows the scalar conversation columns the list rows expose plus the base timestamp columns.
var chatSessionOrderableColumns = map[string]struct{}{
	"id":          {},
	"dialog_id":   {},
	"name":        {},
	"user_id":     {},
	"create_time": {},
	"create_date": {},
	"update_time": {},
	"update_date": {},
}

// compilationTemplateGroupOrderableColumns keeps the four columns this list has
// always accepted rather than every scalar column of the row, so moving the rule
// here does not widen what callers can order by.
var compilationTemplateGroupOrderableColumns = map[string]struct{}{
	"name":        {},
	"scope":       {},
	"create_time": {},
	"update_time": {},
}

// fileOrderableColumns allows the scalar file columns the list rows expose plus the base timestamp columns.
var fileOrderableColumns = map[string]struct{}{
	"id":          {},
	"parent_id":   {},
	"tenant_id":   {},
	"created_by":  {},
	"name":        {},
	"location":    {},
	"size":        {},
	"type":        {},
	"source_type": {},
	"create_time": {},
	"create_date": {},
	"update_time": {},
	"update_date": {},
}

// knowledgebaseOrderableColumns allows the scalar knowledge base columns the list rows expose plus the base timestamp columns.
var knowledgebaseOrderableColumns = map[string]struct{}{
	"id":             {},
	"tenant_id":      {},
	"name":           {},
	"language":       {},
	"permission":     {},
	"doc_num":        {},
	"token_num":      {},
	"chunk_num":      {},
	"parser_id":      {},
	"pagerank":       {},
	"embd_id":        {},
	"tenant_embd_id": {},
	"create_time":    {},
	"create_date":    {},
	"update_time":    {},
	"update_date":    {},
}

// pipelineLogOrderableColumns allows the scalar pipeline operation log columns the list rows expose plus the base timestamp columns.
var pipelineLogOrderableColumns = map[string]struct{}{
	"id":               {},
	"document_id":      {},
	"tenant_id":        {},
	"kb_id":            {},
	"pipeline_id":      {},
	"pipeline_title":   {},
	"parser_id":        {},
	"document_name":    {},
	"document_suffix":  {},
	"document_type":    {},
	"source_from":      {},
	"progress":         {},
	"process_begin_at": {},
	"process_duration": {},
	"task_type":        {},
	"operation_status": {},
	"status":           {},
	"run_count":        {},
	"create_time":      {},
	"create_date":      {},
	"update_time":      {},
	"update_date":      {},
}

// searchOrderableColumns allows the scalar search columns the list rows expose plus the base timestamp columns.
var searchOrderableColumns = map[string]struct{}{
	"id":          {},
	"tenant_id":   {},
	"name":        {},
	"created_by":  {},
	"status":      {},
	"create_time": {},
	"create_date": {},
	"update_time": {},
	"update_date": {},
}

// userCanvasOrderableColumns allows the scalar user canvas columns the list rows expose plus the base timestamp columns.
var userCanvasOrderableColumns = map[string]struct{}{
	"id":              {},
	"user_id":         {},
	"title":           {},
	"permission":      {},
	"canvas_type":     {},
	"canvas_category": {},
	"tags":            {},
	"create_time":     {},
	"create_date":     {},
	"update_time":     {},
	"update_date":     {},
}

func chatOrderClause(terms []OrderTerm) string {
	return orderClause(chatOrderableColumns, terms, defaultOrderColumn)
}

func chatSessionOrderClause(terms []OrderTerm) string {
	return orderClause(chatSessionOrderableColumns, terms, defaultOrderColumn)
}

func compilationTemplateGroupOrderClause(terms []OrderTerm) string {
	return orderClause(compilationTemplateGroupOrderableColumns, terms, defaultOrderColumn)
}

func fileOrderClause(terms []OrderTerm) string {
	return orderClause(fileOrderableColumns, terms, defaultOrderColumn)
}

func knowledgebaseQualifiedOrderClause(terms []OrderTerm) string {
	return qualifiedOrderClause("knowledgebase", knowledgebaseOrderableColumns, terms, defaultOrderColumn)
}

func pipelineLogOrderClause(terms []OrderTerm) string {
	return orderClause(pipelineLogOrderableColumns, terms, defaultOrderColumn)
}

func searchOrderClause(terms []OrderTerm) string {
	return orderClause(searchOrderableColumns, terms, defaultOrderColumn)
}

func userCanvasOrderClause(terms []OrderTerm) string {
	return orderClause(userCanvasOrderableColumns, terms, defaultOrderColumn)
}

func userCanvasQualifiedOrderClause(terms []OrderTerm) string {
	return qualifiedOrderClause("user_canvas", userCanvasOrderableColumns, terms, defaultOrderColumn)
}