trinity

type AppChangelog struct {
	Logmodel
	Resource    string `json:"resource"  gorm:"type:varchar(50);not null;default:''"`     // resource name
	ResourceKey string `json:"resource_key"  gorm:"type:varchar(50);not null;default:''"` // resource key
	DVersion    string `json:"d_version" gorm:"type:varchar(50);not null;default:''"`     // current change d version
	Type        string `json:"type"  gorm:"type:varchar(50);not null;default:''"`         // operation type create , update , delete
	Column      string `json:"column"  gorm:"type:varchar(50);not null;default:''"`
	OldValue    string `json:"old_value"  gorm:"type:varchar(200);not null;default:''"` // old value before change
	NewValue    string `json:"new_value"  gorm:"type:varchar(200);not null;default:''"` // new value after change
	TraceID     string `json:"trace_id"  gorm:"type:varchar(50);not null;"`
}

type AppError struct {
	Logmodel
	TraceID  string `json:"trace_id"  gorm:"type:varchar(50);index;not null;"` //http seq number
	File     string `json:"file"  `
	Line     string `json:"line"  gorm:"type:varchar(50);"`
	FuncName string `json:"func_name"`
	Error    string `json:"error" `
}

type AutoModel struct {
	ID           int64      `json:"key,string"  gorm:"primary_key;"`
	CreatedTime  *time.Time `json:"created_time" `
	CreateUser   *User      `json:"create_user"`
	CreateUserID int64      `json:"create_user_id,string"`
	UpdatedTime  *time.Time `json:"updated_time" `
	UpdateUser   *User      `json:"update_user"`
	UpdateUserID int64      `json:"update_user_id,string"`
	DeletedTime  *time.Time `json:"deleted_time" `
	DeleteUser   *User      `json:"delete_user"`
	DeleteUserID int64      `json:"delete_user_id,string"`
}

type Claims struct {
	Userkey string `json:"userkey"`
	jwt.StandardClaims
}

type ClientConn struct {
	*grpc.ClientConn
	// contains filtered or unexported fields
}

type Context interface {
	GetDB() *gorm.DB
	GetTXDB() *gorm.DB
	GetLogger() Logger
	GetRequest() interface{}
	GetResponse() interface{}
}

type ContextImpl struct {
	// contains filtered or unexported fields
}

type CustomizeSetting interface {
	Load(runmode string, configFilePath string)
}

type DeleteMixin struct {
	ViewSetRunTime *ViewSetRunTime
}

type Factory func() (*grpc.ClientConn, error)

type FactoryWithContext func(context.Context) (*grpc.ClientConn, error)

type FedidClaims struct {
	ClientID string `json:"client_id,omitempty"`
	UID      string `json:"uid,omitempty"`
	Origin   string `json:"origin,omitempty"`
	jwt.StandardClaims
}

type FilterQuery struct {
	QueryName  string
	QueryValue string

	//output
	ConditionSQL string
	ValueSQL     interface{}
	// contains filtered or unexported fields
}

type GRPCMethod string

type GetMixin struct {
	ViewSetRunTime *ViewSetRunTime
}

type GlobalSetting struct {
	Local   Setting
	Develop Setting
	Preprod Setting
	Master  Setting
}

type Group struct {
	Model
	Name        string       `json:"name" gorm:"type:varchar(50);unique;not null;"`
	Description string       `json:"description" gorm:"type:varchar(100);not null;default:''"`
	Permissions []Permission `json:"permissions" gorm:"many2many:group_permissions;"`
	PGroup      *Group       `json:"p_group"`
	PID         int64        `json:"p_id,string"`
	Roles       []Role       `json:"roles" gorm:"many2many:group_roles;"`
}

type ISetting interface {
	GetDebug() bool
	GetTLSEnabled() bool
	GetSetting() *Setting
	GetProjectName() string
	GetTags() []string
	GetWebAppType() string
	GetWebAppAddress() string
	GetWebAppPort() int
	GetServiceMeshAddress() string
	GetServiceMeshPort() int
	GetDeregisterAfterCritical() int
	GetHealthCheckInterval() int
	GetCAPemFile() string
	GetServerPemFile() string
	GetServerKeyFile() string
	GetClientPemFile() string
	GetClientKeyFile() string
	GetProjectVersion() string
	GetLogRootPath() string
	GetLogName() string
	GetServiceMeshType() string
	GetServiceMeshAutoRegister() bool
	GetAtomicRequest() bool
	GetTablePrefix() string
	GetWebAppMediaURL() string
	GetWebAppStaticURL() string
	GetWebAppMediaPath() string
	GetWebAppStaticPath() string
	GetCacheSize() int
	GetCacheTimeout() int
	GetPageSize() int
	GetWebAppBaseURL() string
	GetMigrationPath() string
	GetJwtVerifyExpireHour() bool
	GetJwtVerifyIssuer() bool
	GetJwtIssuer() string
	GetJwtHeaderPrefix() string
	GetJwtExpireHour() int
	GetReadTimeoutSecond() int
	GetReadHeaderTimeoutSecond() int
	GetWriteTimeoutSecond() int
	GetIdleTimeoutSecond() int
	GetMaxHeaderBytes() int
	GetSecretKey() string
	GetAllowOrigins() []string
	GetAllowMethods() []string
	GetAllowHeaders() []string
	GetExposeHeaders() []string
	GetAllowCredentials() bool
	GetMaxAgeHour() int
	GetCorsEnable() bool
	GetDBHost() string
	GetDBPort() string
	GetDBUser() string
	GetDBPassword() string
	GetDBName() string
	GetDBOption() string
	GetDBType() string
	GetDbMaxIdleConn() int
	GetDbMaxOpenConn() int
	GetLogEnable() bool
}

type LogFormat struct {
	Timestamp      string        `json:"@timestamp"` // current timestamp
	Version        string        `json:"@version"`   //
	LoggerName     string        `json:"logger_name"`
	ThreadName     string        `json:"thread_name"`
	Level          string        `json:"level"`
	Hostname       string        `json:"hostname"`
	ModuleName     string        `json:"module_name"`
	TraceID        string        `json:"trace_id"`
	Latency        time.Duration `json:"latency"`
	ClientIP       string        `json:"client_ip"`
	HTTPMethod     string        `json:"http_method"`
	HTTPPath       string        `json:"http_path"`
	HTTPStatusCode int           `json:"http_status_code"`
	Message        string        `json:"message"`      // error message
	ErrorDetail    string        `json:"error_detail"` // error detail info
	BodySize       int           `json:"body_size"`
	UserID         int64         `json:"user_id,string"`
	Username       string        `json:"username"`
	// db log
	DBRunningFile  string        `json:"db_running_file"`
	DBRunningTime  time.Duration `json:"db_running_time"`
	DBSQL          string        `json:"db_sql"`
	DBParams       string        `json:"db_params"`
	DBEffectedRows string        `json:"db_effected_rows"`
	DBLogOrigin    string        `json:"db_log_origin"`
}

type Logger interface {
	Print(v ...interface{})
}

type Logmodel struct {
	ID           int64      `json:"key,string"  gorm:"primary_key;AUTO_INCREMENT:false"`
	CreatedTime  *time.Time `json:"created_time" `
	CreateUser   *User      `json:"create_user"`
	CreateUserID int64      `json:"create_user_id,string" `
}

type Migration struct {
	Simpmodel
	Seq    int    `json:"seq"  `
	Name   string `json:"name" gorm:"type:varchar(100);"`
	Status bool   `json:"status" gorm:"default:FALSE"`
	Error  string `json:"error" `
}

type MixinCallback func(r *ViewSetRunTime)

type Model struct {
	ID           int64      `json:"key,string"  gorm:"primary_key;AUTO_INCREMENT:false" mapstructure:"key"`
	CreatedTime  *time.Time `json:"created_time" `
	CreateUser   *User      `json:"create_user" `
	CreateUserID int64      `json:"create_user_id,string" `
	UpdatedTime  *time.Time `json:"updated_time"`
	UpdateUser   *User      `json:"update_user"`
	UpdateUserID int64      `json:"update_user_id,string" `
	DeletedTime  *time.Time `json:"deleted_time"`
	DeleteUser   *User      `json:"delete_user"`
	DeleteUserID int64      `json:"delete_user_id,string" `
	DVersion     string     `json:"d_version"`
}

type NilLogger struct{}

type PatchMixin struct {
	ViewSetRunTime *ViewSetRunTime
}

type Permission struct {
	Model
	Code string `json:"code" gorm:"type:varchar(100);index;unique;not null;"`
	Name string `json:"name" gorm:"type:varchar(100);not null;default:''"`
}

type Pool struct {
	// contains filtered or unexported fields
}

type PostMixin struct {
	ViewSetRunTime *ViewSetRunTime
}

type PutMixin struct {
	ViewSetRunTime *ViewSetRunTime
}

type ReqUserName string

type ResponseData struct {
	Status  int         // the http response status  to return
	Result  interface{} // the response data  if req success
	TraceID string
}

type RetrieveMixin struct {
	ViewSetRunTime *ViewSetRunTime
}

type Role struct {
	Model
	Name        string       `json:"name" gorm:"type:varchar(50);index;unique;not null;"`
	Description string       `json:"description" gorm:"type:varchar(100);not null;default:''"`
	Permissions []Permission `json:"permissions" gorm:"many2many:role_permissions;"`
}

type ServiceHandler interface {
	Handler()
}

type ServiceMesh interface {
	GetClient() interface{}
	RegService(projectName string, projectVersion string, serviceIP string, servicePort int, Tags []string, deregisterSecondAfterCritical int, interval int, tlsEnabled bool) error
	DeRegService(projectName string, projectVersion string, serviceIP string, servicePort int) error
}

type ServiceMeshConsulImpl struct {
	// config
	ConsulAddress string // consul address
	ConsulPort    int
	// contains filtered or unexported fields
}

type ServiceMeshEtcdImpl struct {
	// config
	Address string // consul address
	Port    int
	// contains filtered or unexported fields
}

type Setting struct {
	Project string   `yaml:"project"`
	Version string   `yaml:"version"`
	Tags    []string `yaml:"tags"`
	Runtime struct {
		Debug bool `yaml:"debug"`
	}
	Security struct {
		Authentication struct {
			SecretKey           string `yaml:"secretkey"`
			JwtVerifyIssuer     bool   `yaml:"jwtverifyissuer"`
			JwtIssuer           string `yaml:"jwtissuer"`
			JwtVerifyExpireHour bool   `yaml:"jwtverifyexpirehour"`
			JwtExpireHour       int    `yaml:"jwtexpirehour"`
			JwtHeaderPrefix     string `yaml:"jwtheaderprefix"`
		}
		Cors struct {
			Enable           bool     `yaml:"enable"`
			AllowOrigins     []string `yaml:"alloworigins"`
			AllowMethods     []string `yaml:"allowmethods"`
			AllowHeaders     []string `yaml:"allowheaders"`
			ExposeHeaders    []string `yaml:"exposeheaders"`
			AllowCredentials bool     `yaml:"allowcredentials"`
			MaxAgeHour       int      `yaml:"maxagehour"`
		}
		TLS struct {
			Enabled       bool   `yaml:"enabled"`
			CAPemFile     string `yaml:"ca_pem_file"`
			ServerPemFile string `yaml:"server_pem_file"`
			ServerKeyFile string `yaml:"server_key_file"`
			ClientPemFile string `yaml:"client_pem_file"`
			ClientKeyFile string `yaml:"client_key_file"`
		}
	}
	Webapp struct {
		// Type support GRPC HTTP
		Type    string `yaml:"type"`
		Address string `yaml:"address"`
		Port    int    `yaml:"port"`
		// ReadTimeout is the maximum duration for reading the entire
		// request, including the body.
		//
		// Because ReadTimeout does not let Handlers make per-request
		// decisions on each request body's acceptable deadline or
		// upload rate, most users will prefer to use
		// ReadHeaderTimeout. It is valid to use them both.
		ReadTimeoutSecond int `yaml:"readtimeoutsecond"`

		// ReadHeaderTimeout is the amount of time allowed to read
		// request headers. The connection's read deadline is reset
		// after reading the headers and the Handler can decide what
		// is considered too slow for the body. If ReadHeaderTimeout
		// is zero, the value of ReadTimeout is used. If both are
		// zero, there is no timeout.
		ReadHeaderTimeoutSecond int `yaml:"readheadertimeoutsecond"`

		// WriteTimeout is the maximum duration before timing out
		// writes of the response. It is reset whenever a new
		// request's header is read. Like ReadTimeout, it does not
		// let Handlers make decisions on a per-request basis.
		WriteTimeoutSecond int `yaml:"writertimeoutsecond"`

		// IdleTimeout is the maximum amount of time to wait for the
		// next request when keep-alives are enabled. If IdleTimeout
		// is zero, the value of ReadTimeout is used. If both are
		// zero, there is no timeout.
		IdleTimeoutSecond int `yaml:"idletimeoutsecond"`

		// MaxHeaderBytes controls the maximum number of bytes the
		// server will read parsing the request header's keys and
		// values, including the request line. It does not limit the
		// size of the request body.
		// If zero, DefaultMaxHeaderBytes is used.
		MaxHeaderBytes int    `yaml:"maxheaderbytes"`
		TemplatePath   string `yaml:"templatepath"`
		MediaURL       string `yaml:"mediaurl"`
		MediaPath      string `yaml:"mediapath"`
		StaticURL      string `yaml:"staticurl"`
		StaticPath     string `yaml:"staticpath"`
		MigrationPath  string `yaml:"migrationpath"`
		PageSize       int    `yaml:"pagesize"`
		MaxBodySize    int    `yaml:"maxbodysize"`
		AtomicRequest  bool   `yaml:"atomicrequest"`
		// if api root is not root , replease with base url
		// e.g : /assetgo
		BaseURL string `yaml:"baseurl"`
	}
	Log struct {
		Enable      bool   `yaml:"enable"`
		LogRootPath string `yaml:"logrootpath"` //   /var/log/mold
		LogName     string `yaml:"logname"`     //  app.log
	}
	Cache struct {
		Redis struct {
			Host        string
			Port        int
			Password    string
			Maxidle     int
			Maxactive   int
			Idletimeout int
		}
		Gcache struct {
			CacheAlgorithm string `yaml:"cache_algorithm"`
			CacheSize      int    `yaml:"cachesize"`
			Timeout        int    `yaml:"timeout"` // hour
		}
	}
	Database struct {
		Type          string
		Name          string
		User          string
		Password      string
		Host          string
		Port          string
		Option        string
		TablePrefix   string
		DbMaxIdleConn int
		DbMaxOpenConn int
	}
	ServiceMesh struct {
		Type                    string // etcd oor consul
		Address                 string
		Port                    int
		DeregisterAfterCritical int  `yaml:"deregister_after_critical"` //second
		HealthCheckInterval     int  `yaml:"health_check_interval"`     //second
		AutoRegister            bool `yaml:"auto_register"`
	}
	// contains filtered or unexported fields
}

type Simpmodel struct {
	ID          int64      `json:"key,string"  gorm:"primary_key;AUTO_INCREMENT:false"`
	CreatedTime *time.Time `json:"created_time" `
}

type TraceID string

type Trinity struct {
	// contains filtered or unexported fields
}

type UnknownMixin struct {
	ViewSetRunTime *ViewSetRunTime
}

type User struct {
	Model
	Username           string       `json:"username" gorm:"type:varchar(50);index;not null;"`             // login username /profile
	NameLocal          string       `json:"name_local"  gorm:"type:varchar(50);" `                        // local name
	NameEN             string       `json:"name_en"  gorm:"type:varchar(50);" `                           // EN name
	Email              string       `json:"email"  gorm:"type:varchar(50);" `                             // login email
	Phone              string       `json:"phone" gorm:"type:varchar(50);" `                              // login phone
	Groups             []Group      `json:"groups" gorm:"many2many:user_groups;"`                         // foreign key -->group
	Permissions        []Permission `json:"permissions" gorm:"many2many:user_permissions;"`               // foreign key --->permission
	PreferenceLanguage string       `json:"preference_language" gorm:"type:varchar(50);default:'en-US'" ` // user preference language

}

type UserRequestsCtx interface {
	GetGRPCMethod() GRPCMethod
	GetTraceID() TraceID
	GetReqUserName() ReqUserName
}

type UserRequestsCtxImpl struct {
	// contains filtered or unexported fields
}

type ViewSetCfg struct {

	// global config
	Db *gorm.DB
	// if do the atomic request
	AtomicRequestMap map[string]bool
	// HasAuthCtl
	// if do the auth check ,default false
	HasAuthCtl bool
	// AuthenticationBackendMap
	// if HasAuthCtl == false ; pass... customize the authentication check , default jwt  ;
	// please set UserID in context
	// e.g : c.Set("UserID", tokenClaims.UID)
	AuthenticationBackendMap map[string]func(c *gin.Context) error
	// GetCurrentUserAuth
	// must be type : func(c *gin.Context, db *gorm.DB) error
	// if HasAuthCtl == false ; pass...
	// get user auth func with UserID if you set in AuthenticationBackend
	// please set UserPermission and UserKey in context
	// e.g : c.Set("UserKey",UserKey) with c.GetString("UserID")
	// e.g : c.Set("UserPermission", UserPermission) with c.GetString("UserID")
	GetCurrentUserAuth func(c *gin.Context, db *gorm.DB) error
	// AccessBackendReqMap
	// if HasAuthCtl == false ; pass... customize the access require permission
	AccessBackendRequireMap map[string][]string
	// AccessBackendCheckMap
	// if HasAuthCtl == false ; pass... customize the access check , check user permission
	// e.g : userPermission :=  c.GetString("UserPermission")
	// e.g : requiredPermission := []string{"123"} get with AccessBackendReqMap by default
	// e.g : trinity.CheckAccessAuthorization(requiredPermission , userPermission) , true?allow:deny
	AccessBackendCheckMap map[string]func(v *ViewSetRunTime) error
	// PreloadListMap gorm preload list
	PreloadListMap map[string]map[string]func(db *gorm.DB) *gorm.DB
	// FilterBackendMap : all the query will with this filter backend
	FilterBackendMap map[string]func(c *gin.Context, db *gorm.DB) *gorm.DB
	// FilterByList : only in FilterByList will do the filter
	FilterByList []string
	// FilterCustomizeFunc : can do the customize filter ,mapping with FilterByList
	FilterCustomizeFunc map[string]func(db *gorm.DB, queryValue string) *gorm.DB
	// SearchingByList : with keyword "SearchBy" on url query ,
	// will do the where (xxx =? or xxx=?)
	SearchingByList []string
	// OrderingByList : with keyword "OrderBy" on url query ,
	// only define in OrderingByList will do the order by
	// e.g: OrderBy=xxx-   ==> order by xxx desc
	// e.g: OrderBy=xxx   ==> order by xxx asc
	OrderingByList map[string]bool
	// PageSize default 10
	// keyword : PageNum , PageSize to do the limit and offset
	PageSize      int
	EnableOrderBy bool
	// EnableChangeLog enable change log
	EnableChangeLog bool
	// EnableDataVersion check
	EnableDataVersion bool
	// EnableHistory enable history version
	EnableVersionControl bool
	// Retrieve
	BeforeRetrieve MixinCallback
	Retrieve       MixinCallback
	AfterRetrieve  MixinCallback

	// Get
	BeforeGet MixinCallback
	Get       MixinCallback
	AfterGet  MixinCallback

	// Post
	PostValidation interface{}
	BeforePost     MixinCallback
	Post           MixinCallback
	AfterPost      MixinCallback

	// Put
	PutValidation interface{}
	BeforePut     MixinCallback
	Put           MixinCallback
	AfterPut      MixinCallback

	// Patch
	PatchValidation interface{}
	BeforePatch     MixinCallback
	Patch           MixinCallback
	AfterPatch      MixinCallback

	// Delete
	BeforeDelete MixinCallback
	Delete       MixinCallback
	AfterDelete  MixinCallback
	// contains filtered or unexported fields
}

type ViewSetRunTime struct {
	TraceID string
	Method  string
	// is atomic request
	IsAtomicRequest bool
	// gin.context
	Gcontext *gin.Context
	// db instance
	Db *gorm.DB
	// ResourceModel
	// target resource model
	ResourceModel     interface{} // ResourceModel for the resource
	ResourceTableName string
	// resource serializer , used to limit the retrieve object
	ModelSerializer interface{}
	// ModelSerializerlist
	// resource serializer , used to limit the get object list
	ModelSerializerlist interface{}
	// HasAuthCtl
	// if do the auth check ,default false
	HasAuthCtl            bool
	AuthenticationBackend func(c *gin.Context) error
	GetCurrentUserAuth    func(c *gin.Context, db *gorm.DB) error
	AccessBackendRequire  []string
	AccessBackendCheck    func(v *ViewSetRunTime) error
	DBFilterBackend       func(db *gorm.DB) *gorm.DB // current dbfilterbackend
	PreloadList           map[string]func(db *gorm.DB) *gorm.DB
	FilterBackend         func(c *gin.Context, db *gorm.DB) *gorm.DB
	FilterByList          []string
	FilterCustomizeFunc   map[string]func(db *gorm.DB, queryValue string) *gorm.DB
	SearchingByList       []string
	OrderingByList        map[string]bool
	PageSize              int
	EnableOrderBy         bool
	EnableChangeLog       bool
	EnableDataVersion     bool
	EnableVersionControl  bool

	// Retrieve
	BeforeRetrieve MixinCallback
	Retrieve       MixinCallback
	AfterRetrieve  MixinCallback

	// Get
	BeforeGet MixinCallback
	Get       MixinCallback
	AfterGet  MixinCallback

	// Post
	PostValidation interface{}
	BeforePost     MixinCallback
	Post           MixinCallback
	AfterPost      MixinCallback

	// Put
	PutValidation interface{}
	BeforePut     MixinCallback
	Put           MixinCallback
	AfterPut      MixinCallback

	// Patch
	PatchValidation interface{}
	BeforePatch     MixinCallback
	Patch           MixinCallback
	AfterPatch      MixinCallback

	// Delete
	BeforeDelete MixinCallback
	Delete       MixinCallback
	AfterDelete  MixinCallback

	Cfg      *ViewSetCfg
	DBLogger Logger

	//response handle
	Status    int
	ResBody   interface{}
	FuncName  uintptr
	File      string
	Line      int
	RealError error
	UserError error
	// contains filtered or unexported fields
}

type Viewmodel struct {
	ID           int64      `json:"key,string"  gorm:"primary_key;AUTO_INCREMENT:false"`
	CreatedTime  *time.Time `json:"created_time" `
	CreateUser   *User      `json:"create_user"`
	CreateUserID int64      `json:"create_user_id,string"`
	UpdatedTime  *time.Time `json:"updated_time" `
	UpdateUser   *User      `json:"update_user"`
	UpdateUserID int64      `json:"update_user_id,string"`
	DeletedTime  *time.Time `json:"deleted_time" `
	DeleteUser   *User      `json:"delete_user"`
	DeleteUserID int64      `json:"delete_user_id,string"`
}