Skip to content

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

8.9 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 dao

import (
	"context"
	"fmt"
	"strings"

	"ragflow/internal/entity"

	"gorm.io/gorm"
)

const permissionMigrationTargetVersion = "v1.0.0-rc3.dev4"

// migratePermissions applies the permission schema migration and records its version.
func migratePermissions(ctx context.Context, db *gorm.DB) error {
	// Enterprise migrations have their own marker. Run this hook before checking
	// the shared marker so a community migration cannot skip enterprise data work.
	if err := migratePermissionDataEE(ctx, db); err != nil {
		return fmt.Errorf("migrate enterprise permission data: %w", err)
	}

	version, err := GetDatabaseMigrationVersion(ctx, db)
	if err != nil {
		return fmt.Errorf("read database migration version: %w", err)
	}
	if shouldSkipMigration(version, permissionMigrationTargetVersion) {
		return nil
	}
	if err := migrateLegacyTenantInvitationStatuses(ctx, db); err != nil {
		return err
	}
	if err := migrateInvitedByNullable(ctx, db); err != nil {
		return err
	}
	if err := migrateTenantModelProviderUserID(ctx, db); err != nil {
		return err
	}
	if err := migrateAPITokenUserID(ctx, db); err != nil {
		return err
	}
	if err := migrateUserCanvasTenantID(ctx, db); err != nil {
		return err
	}
	if err := setDatabaseMigrationVersion(ctx, db, permissionMigrationTargetVersion); err != nil {
		return fmt.Errorf("mark permission migration version: %w", err)
	}
	return nil
}

func migrateLegacyTenantInvitationStatuses(ctx context.Context, db *gorm.DB) error {
	scoped := db.WithContext(ctx)
	migrator := scoped.Migrator()
	if !migrator.HasTable(&entity.UserTenant{}) || !migrator.HasColumn(&entity.UserTenant{}, "role") || !migrator.HasColumn(&entity.UserTenant{}, "status") {
		return nil
	}
	result := scoped.Model(&entity.UserTenant{}).
		Where("role = ? AND (status = ? OR status IS NULL)", "invite", entity.TenantMembershipStatusJoined).
		Updates(map[string]interface{}{"role": "", "status": entity.TenantMembershipStatusInvited})
	if result.Error != nil {
		return fmt.Errorf("migrate legacy Tenant invitations to pending status: %w", result.Error)
	}
	return nil
}

// migrateUserTenantDuplicates removes duplicate legacy memberships before
// AutoMigrate creates the unique (user_id, tenant_id) index.
func migrateUserTenantDuplicates(ctx context.Context, db *gorm.DB) error {
	scoped := db.WithContext(ctx)
	migrator := scoped.Migrator()
	if !migrator.HasTable(&entity.UserTenant{}) {
		return nil
	}
	hasIndex, err := hasUserTenantUniqueIndex(ctx, scoped)
	if err != nil {
		return fmt.Errorf("inspect user_tenant unique index: %w", err)
	}
	if hasIndex {
		return nil
	}

	return scoped.Transaction(func(tx *gorm.DB) error {
		var duplicateKeys []struct {
			UserID   string `gorm:"column:user_id"`
			TenantID string `gorm:"column:tenant_id"`
		}
		if err := tx.Model(&entity.UserTenant{}).
			Select("user_id, tenant_id").
			Group("user_id, tenant_id").
			Having("COUNT(*) > 1").
			Scan(&duplicateKeys).Error; err != nil {
			return fmt.Errorf("find duplicate user_tenant memberships: %w", err)
		}

		for _, key := range duplicateKeys {
			var memberships []entity.UserTenant
			if err := tx.Where("user_id = ? AND tenant_id = ?", key.UserID, key.TenantID).
				Order("CASE WHEN status = '1' THEN 0 ELSE 1 END").
				Order("CASE role WHEN 'owner' THEN 0 WHEN 'admin' THEN 1 WHEN 'normal' THEN 2 WHEN 'invite' THEN 3 ELSE 4 END").
				Order("update_time DESC").
				Order("create_time ASC").
				Order("id ASC").
				Find(&memberships).Error; err != nil {
				return fmt.Errorf("list duplicate user_tenant memberships for user %s in tenant %s: %w", key.UserID, key.TenantID, err)
			}
			if len(memberships) < 2 {
				continue
			}
			keepID := memberships[0].ID
			for _, duplicate := range memberships[1:] {
				if err := remapUserTenantReferences(ctx, tx, duplicate.ID, keepID); err != nil {
					return err
				}
				if err := tx.Where("id = ?", duplicate.ID).Delete(&entity.UserTenant{}).Error; err != nil {
					return fmt.Errorf("delete duplicate user_tenant membership %s: %w", duplicate.ID, err)
				}
			}
		}
		return nil
	})
}

func hasUserTenantUniqueIndex(ctx context.Context, db *gorm.DB) (bool, error) {
	indexes, err := db.WithContext(ctx).Migrator().GetIndexes(&entity.UserTenant{})
	if err != nil {
		return false, err
	}
	for _, index := range indexes {
		unique, known := index.Unique()
		if !known || !unique {
			continue
		}
		columns := index.Columns()
		if len(columns) != 2 {
			continue
		}
		columnSet := map[string]struct{}{"user_id": {}, "tenant_id": {}}
		for _, column := range columns {
			delete(columnSet, strings.ToLower(column))
		}
		if len(columnSet) == 0 {
			return true, nil
		}
	}
	return false, nil
}

func remapUserTenantReferences(ctx context.Context, tx *gorm.DB, oldID, newID string) error {
	references := []struct {
		table  string
		column string
	}{
		{table: "group_info", column: "owner_id"},
		{table: "group_member", column: "member_id"},
		{table: "department_member", column: "member_id"},
		{table: "permission", column: "member_id"},
	}
	for _, reference := range references {
		migrator := tx.WithContext(ctx).Migrator()
		if !migrator.HasTable(reference.table) || !migrator.HasColumn(reference.table, reference.column) {
			continue
		}
		if err := tx.WithContext(ctx).Table(reference.table).
			Where(reference.column+" = ?", oldID).
			Update(reference.column, newID).Error; err != nil {
			return fmt.Errorf("remap %s.%s from membership %s to %s: %w", reference.table, reference.column, oldID, newID, err)
		}
	}
	return nil
}

// migrateTenantModelProviderUserID backfills missing model provider owner IDs.
func migrateTenantModelProviderUserID(ctx context.Context, db *gorm.DB) error {
	scoped := db.WithContext(ctx)
	migrator := scoped.Migrator()
	if !migrator.HasTable(&entity.TenantModelProvider{}) {
		return nil
	}
	if !migrator.HasColumn(&entity.TenantModelProvider{}, "UserID") {
		return fmt.Errorf("tenant_model_provider.user_id is missing after GORM migration")
	}
	if err := scoped.Model(&entity.TenantModelProvider{}).
		Where("user_id IS NULL OR user_id = ''").
		UpdateColumn("user_id", gorm.Expr("tenant_id")).Error; err != nil {
		return fmt.Errorf("backfill tenant_model_provider.user_id from tenant_id: %w", err)
	}
	return nil
}

// migrateUserCanvasTenantID backfills tenant IDs for existing canvases.
func migrateUserCanvasTenantID(ctx context.Context, db *gorm.DB) error {
	migrator := db.WithContext(ctx).Migrator()
	if !migrator.HasTable(&entity.UserCanvas{}) {
		return nil
	}
	if !migrator.HasColumn(&entity.UserCanvas{}, "TenantID") {
		return fmt.Errorf("user_canvas.tenant_id is missing after GORM migration")
	}
	if err := db.WithContext(ctx).Exec("UPDATE user_canvas SET tenant_id = user_id WHERE tenant_id IS NULL OR tenant_id = ''").Error; err != nil {
		return fmt.Errorf("backfill user_canvas.tenant_id: %w", err)
	}
	return nil
}

// migrateAPITokenUserID backfills user IDs for existing API tokens.
func migrateAPITokenUserID(ctx context.Context, db *gorm.DB) error {
	migrator := db.WithContext(ctx).Migrator()
	if !migrator.HasTable(&entity.APIToken{}) {
		return nil
	}
	if !migrator.HasColumn(&entity.APIToken{}, "UserID") {
		return fmt.Errorf("api_token.user_id is missing after GORM migration")
	}
	if err := db.WithContext(ctx).Exec("UPDATE api_token SET user_id = tenant_id WHERE user_id IS NULL OR user_id = ''").Error; err != nil {
		return fmt.Errorf("backfill api_token.user_id: %w", err)
	}
	return nil
}

// migrateInvitedByNullable allows tenant membership requests without an inviter.
func migrateInvitedByNullable(ctx context.Context, db *gorm.DB) error {
	migrator := db.WithContext(ctx).Migrator()
	columns, err := migrator.ColumnTypes(&entity.UserTenant{})
	if err != nil {
		return fmt.Errorf("inspect user_tenant columns: %w", err)
	}
	for _, column := range columns {
		if column.Name() != "invited_by" {
			continue
		}
		nullable, known := column.Nullable()
		if !known {
			return fmt.Errorf("user_tenant.invited_by nullability is unknown")
		}
		if nullable {
			return nil
		}
		// AutoMigrate does not relax NOT NULL on an existing column for every
		// supported dialect, so use GORM's migrator for this one legacy constraint.
		if err := migrator.AlterColumn(&entity.UserTenant{}, "InvitedBy"); err != nil {
			return fmt.Errorf("make user_tenant.invited_by nullable: %w", err)
		}
		return nil
	}
	return fmt.Errorf("user_tenant.invited_by column is missing")
}