contract

type App interface {
	// application version
	Version() string
	// base path which is the base folder
	BasePath() string
	// app path which is the app folder
	AppPath() string
	// app/http
	HttpPath() string
	// app/http/swagger
	SwaggerPath() string
	// app/console
	ConsolePath() string
	// config folder which contains config
	ConfigPath() string
	// environmentPath which contain .env
	EnvironmentPath() string
	// storagePath define storage folder
	StoragePath() string
	// logPath define logPath
	LogPath() string

	PidPath() string

	CachePath() string
	// load config
	LoadAppConfig(map[string]string)
}

type Cache interface {
	// Get value by key
	Get(key string) []byte
	// Pull get and delete
	Pull(key string) []byte
	// Check key exists
	Has(key string) bool
	// Set value to key
	Put(key string, val []byte, duration time.Duration) error
	// Forever Put
	Forever(key string, val []byte) error
	// Delete key
	Delete(key string) error
	// increment
	Increment(key string) int
	// decrement
	Decrement(key string) int
}

type Config interface {
	// IsExist check setting is exist
	IsExist(key string) bool

	// Get a new interface
	Get(key string) interface{}
	// GetBool get bool type
	GetBool(key string) bool
	// GetInt get Int type
	GetInt(key string) int
	// GetFloat64 get float64
	GetFloat64(key string) float64
	// GetTime get time type
	GetTime(key string) time.Time
	// GetString get string typen
	GetString(key string) string

	// GetIntSlice get int slice type
	GetIntSlice(key string) []int
	// GetStringSlice get string slice type
	GetStringSlice(key string) []string

	// GetStringMap get map which key is string, value is interface
	GetStringMap(key string) map[string]interface{}
	// GetStringMapString get map which key is string, value is string
	GetStringMapString(key string) map[string]string
	// GetStringMapStringSlice get map which key is string, value is string slice
	GetStringMapStringSlice(key string) map[string][]string

	// Load a config to a struct, val should be an pointer
	Load(key string, val interface{}) error
}

type ConsoleLog interface {
	Log
}

type CtxFielder func(ctx context.Context) map[string]interface{}

type Env interface {
	// AppEnv get current environment
	AppEnv() string

	// IsExist check setting is exist
	IsExist(string) bool
	// Get environment setting, if not exist, return ""
	Get(string) string
	// All return all settings
	All() map[string]string
}

type Formatter func(level LogLevel, t time.Time, msg string, fields map[string]interface{}) ([]byte, error)

type IDService interface {
	NewID() string
}

type Kernel interface {
	HttpEngine() *gin.Engine
}

type Log interface {
	// Panic will call panic(fields) for debug
	Panic(ctx context.Context, msg string, fields map[string]interface{})
	// Fatal will add fatal record which contains msg and fields
	Fatal(ctx context.Context, msg string, fields map[string]interface{})
	// Error will add error record which contains msg and fields
	Error(ctx context.Context, msg string, fields map[string]interface{})
	// Warn will add warn record which contains msg and fields
	Warn(ctx context.Context, msg string, fields map[string]interface{})
	// Info will add info record which contains msg and fields
	Info(ctx context.Context, msg string, fields map[string]interface{})
	// Debug will add debug record which contains msg and fields
	Debug(ctx context.Context, msg string, fields map[string]interface{})
	// Trace will add trace info which contains msg and fields
	Trace(ctx context.Context, msg string, fields map[string]interface{})

	// SetLevel set log level, and higher level will be recorded
	SetLevel(level LogLevel)
	// SetCxtFielder will get fields from context
	SetCxtFielder(handler CtxFielder)
	// SetFormatter will set formatter handler will covert data to string for recording
	SetFormatter(formatter Formatter)
	// SetOutput will set output writer
	SetOutput(out io.Writer)
}

type LogLevel uint32

type RotatingFileLog interface {
	Log
	SetFolder(folder string)
	SetFile(file string)
	SetMaxFiles(maxFiles int)
	SetDateFormat(dateFormat string)
}

type SSH interface {
	// 运行shell，并输出结果
	Run(shell string) ([]byte, error)
	// 将本地文件放到远端
	Upload(src, dist string) error
	// 将远端文件放到本地
	Download(src, dist string) error
	// 将本地文件夹放到远端
	UploadDir(src, dist string) error

	DownloadDir(src, dist string) error
}

type SSHConfig struct {
	User     string
	Password string
	Host     string
	Port     string
	RsaKey   string
	Timeout  int
}

type SingleFileLog interface {
	Log
	SetFile(file string)
	SetFolder(folder string)
}

type Trace interface {

	// WithContext register new trace to context
	WithTrace(c context.Context, trace *TraceContext) context.Context
	// GetTrace From trace context
	GetTrace(c context.Context) *TraceContext
	// NewTrace generate a new trace
	NewTrace() *TraceContext
	// StartSpan generate cspan for child call
	StartSpan(trace *TraceContext) *TraceContext

	// traceContext to map for logger
	ToMap(trace *TraceContext) map[string]string

	// GetTrace By Http
	ExtractHTTP(req *http.Request) *TraceContext
	// Set Trace to Http
	InjectHTTP(req *http.Request, trace *TraceContext) *http.Request
}

type TraceContext struct {
	TraceID  string // traceID global unique
	ParentID string // 父节点SpanID
	SpanID   string // 当前节点SpanID
	CspanID  string // 子节点调用的SpanID, 由调用方指定

	Annotation map[string]string // 标记各种信息
}