error.go

// SPDX-FileCopyrightText: 2019-2024 caixw
//
// SPDX-License-Identifier: MIT

package config

import (
	"fmt"

	"github.com/issue9/localeutil"
)

// FieldError 表示配置内容字段错误
type FieldError struct {
	Path    string // 配置文件的路径
	Field   string // 字段名
	Message any    // 错误信息
	Value   any    // 字段的原始值
}

// Sanitizer 对配置文件的数据验证和修正
type Sanitizer interface {
	// SanitizeConfig 验证当前对象的数据
	//
	// NOTE: 如果当前对象是个结构体，
	// 需要接口的实现自行判断和调用各个字段 [Sanitizer] 接口。
	SanitizeConfig() *FieldError
}

// NewFieldError 返回表示配置文件错误的对象
//
// field 表示错误的字段名；
// msg 表示错误信息，可以是任意类型，如果类型为 [FieldError]，那么将调用 msg.AddFieldParent(field)；
func NewFieldError(field string, msg any) *FieldError {
	if err, ok := msg.(*FieldError); ok {
		err.AddFieldParent(field)
		return err
	}
	return &FieldError{Field: field, Message: msg}
}

// AddFieldParent 为字段名加上一个前缀
//
// 当字段名存在层级关系时，外层在处理错误时，需要为其加上当前层的字段名作为前缀。
func (err *FieldError) AddFieldParent(prefix string) *FieldError {
	if prefix == "" {
		return err
	}

	if err.Field == "" {
		err.Field = prefix
		return err
	}

	err.Field = prefix + "." + err.Field
	return err
}

func (err *FieldError) Error() string {
	var msg string
	switch v := err.Message.(type) {
	case fmt.Stringer:
		msg = v.String()
	case error:
		msg = v.Error()
	default:
		msg = fmt.Sprint(err.Message)
	}

	return fmt.Sprintf("%s at %s:%s", msg, err.Path, err.Field)
}

func (err *FieldError) LocaleString(p *localeutil.Printer) string {
	msg := err.Message
	if ls, ok := err.Message.(localeutil.Stringer); ok {
		msg = ls.LocaleString(p)
	}

	return localeutil.Phrase("%s at %s:%s", msg, err.Path, err.Field).LocaleString(p)
}