db

type AllMetadataOwner map[string]string

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

type ClassMetadataOwner map[string]string

type CustomizeListFilterFunc func(item jsonutils.JSONObject) (bool, error)

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

type DBJointModelDispatcher struct {
	DBModelDispatcher
}

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

type FilterByOwnerProvider interface {
	FilterByOwner(q *sqlchemy.SQuery, owner mcclient.IIdentityProvider, scope rbacutils.TRbacScope) *sqlchemy.SQuery
}

type IAdminSharableVirtualModel interface {
	ISharableVirtualModel
	GetInfo() []string

	GetIAdminSharableVirtualModel() IAdminSharableVirtualModel
}

type IAdminSharableVirtualModelManager interface {
	ISharableVirtualModelManager

	GetIAdminSharableVirtualModelManager() IAdminSharableVirtualModelManager

	GetRecordsSeparator() string
	GetRecordsLimit() int
	ParseInputInfo(data *jsonutils.JSONDict) ([]string, error)
}

type IClassMetadataOwner interface {
	GetAllClassMetadata() (map[string]string, error)
}

type IClassMetadataSetter interface {
	// a setter should first be a owner
	IClassMetadataOwner

	SetClassMetadataAll(context.Context, map[string]string, mcclient.TokenCredential) error
}

type IDomainLevelModel interface {
	IStandaloneModel

	IsOwner(userCred mcclient.TokenCredential) bool

	SyncCloudDomainId(userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider)

	GetIDomainLevelModel() IDomainLevelModel

	IOwnerResourceBaseModel
}

type IDomainLevelModelManager interface {
	IStandaloneModelManager

	GetIDomainLevelModelManager() IDomainLevelModelManager
	GetResourceCount() ([]SScopeResourceCount, error)
}

type IEnabledBase interface {
	IModel
	SetEnabled(enabled bool)
	GetEnabled() bool
}

type IExternalizedModel interface {
	IModel

	GetExternalId() string
	SetExternalId(idStr string)
}

type IExternalizedModelManager interface {
	IModelManager
	FetchByExternalId(idStr string) IExternalizedModel
}

type IInfrasModel interface {
	IDomainLevelModel
	ISharableBase

	GetIInfrasModel() IInfrasModel
}

type IInfrasModelManager interface {
	IDomainLevelModelManager

	GetIInfrasModelManager() IInfrasModelManager
}

type IJointModel interface {
	IResourceModel

	GetJointModelManager() IJointModelManager

	GetIJointModel() IJointModel

	Detach(ctx context.Context, userCred mcclient.TokenCredential) error
}

type IJointModelManager interface {
	IResourceModelManager

	GetIJointModelManager() IJointModelManager

	GetMasterManager() IStandaloneModelManager
	GetSlaveManager() IStandaloneModelManager

	GetMasterFieldName() string
	GetSlaveFieldName() string
	// FetchByIds(masterId string, slaveId string, query jsonutils.JSONObject) (IJointModel, error)
	FilterByParams(q *sqlchemy.SQuery, params jsonutils.JSONObject) *sqlchemy.SQuery
}

type IManagedResourceBase interface {
	IsManaged() bool
}

type IMetadataBaseModel interface {
	OnMetadataUpdated(ctx context.Context, userCred mcclient.TokenCredential)
}

type IMetadataBaseModelManager interface {
	GetMetadataHiddenKeys() []string
}

type IModel interface {
	lockman.ILockedObject
	object.IObject

	GetName() string
	GetUpdateVersion() int
	GetUpdatedAt() time.Time
	GetDeleted() bool

	KeywordPlural() string

	GetModelManager() IModelManager
	SetModelManager(IModelManager, IModel)

	GetIModel() IModel

	GetShortDesc(ctx context.Context) *jsonutils.JSONDict

	// get hooks
	// AllowGetDetails(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) bool
	GetExtraDetailsHeaders(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) map[string]string

	// create hooks
	CustomizeCreate(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data jsonutils.JSONObject) error
	PostCreate(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data jsonutils.JSONObject)

	// allow perform action
	// AllowPerformAction(ctx context.Context, userCred mcclient.TokenCredential, action string, query jsonutils.JSONObject, data jsonutils.JSONObject) bool
	PerformAction(ctx context.Context, userCred mcclient.TokenCredential, action string, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error)
	PreCheckPerformAction(ctx context.Context, userCred mcclient.TokenCredential, action string, query jsonutils.JSONObject, data jsonutils.JSONObject) error

	// update hooks
	ValidateUpdateCondition(ctx context.Context) error

	// AllowUpdateItem(ctx context.Context, userCred mcclient.TokenCredential) bool
	// ValidateUpdateData(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data *jsonutils.JSONDict) (*jsonutils.JSONDict, error)
	PreUpdate(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject)
	PostUpdate(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject)

	UpdateInContext(ctx context.Context, userCred mcclient.TokenCredential, ctxObjs []IModel, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error)

	// delete hooks
	// AllowDeleteItem(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) bool
	// ValidateDeleteCondition(ctx context.Context, info jsonutils.JSONObject) error
	// CustomizeDelete(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) error
	PreDelete(ctx context.Context, userCred mcclient.TokenCredential)
	MarkDelete() error
	Delete(ctx context.Context, userCred mcclient.TokenCredential) error
	PostDelete(ctx context.Context, userCred mcclient.TokenCredential)

	DeleteInContext(ctx context.Context, userCred mcclient.TokenCredential, ctxObjs []IModel, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error)

	GetOwnerId() mcclient.IIdentityProvider
	GetUniqValues() jsonutils.JSONObject

	IsSharable(reqCred mcclient.IIdentityProvider) bool

	CustomizedGetDetailsBody(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) (jsonutils.JSONObject, error)
	MarkDeletePreventionOn()
	MarkDeletePreventionOff()

	GetUsages() []IUsage
	GetI18N(ctx context.Context) *jsonutils.JSONDict
}

type IModelI18nBase interface {
	GetKeyValue() string
	Lookup(tag i18n.Tag) string
}

type IModelI18nEntry interface {
	IModelI18nBase
	GetGlobalId() string
	GetObjType() string
	GetObjId() string
	GetKeyName() string
}

type IModelI18nTable interface {
	GetI18nEntries() map[string]IModelI18nEntry
}

type IModelManager interface {
	lockman.ILockedClass
	object.IObject

	IsStandaloneManager() bool
	GetContextManagers() [][]IModelManager

	GetIModelManager() IModelManager

	GetMutableInstance(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) IModelManager
	GetImmutableInstance(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) IModelManager

	// Table() *sqlchemy.STable
	TableSpec() ITableSpec

	// Keyword() string
	KeywordPlural() string
	Alias() string
	AliasPlural() string
	SetAlias(alias string, aliasPlural string)

	HasName() bool
	ValidateName(name string) error
	EnableGenerateName() bool

	// list hooks
	// AllowListItems(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) bool
	ValidateListConditions(ctx context.Context, userCred mcclient.TokenCredential, query *jsonutils.JSONDict) (*jsonutils.JSONDict, error)
	// ListItemFilter dynamic called by dispatcher
	// ListItemFilter(ctx context.Context, q *sqlchemy.SQuery, userCred mcclient.TokenCredential, query jsonutils.JSONObject) (*sqlchemy.SQuery, error)
	CustomizeFilterList(ctx context.Context, q *sqlchemy.SQuery, userCred mcclient.TokenCredential, query jsonutils.JSONObject) (*CustomizeListFilters, error)
	ExtraSearchConditions(ctx context.Context, q *sqlchemy.SQuery, like string) []sqlchemy.ICondition
	GetExportExtraKeys(ctx context.Context, keys stringutils2.SSortedStrings, rowMap map[string]string) *jsonutils.JSONDict
	ListItemExportKeys(ctx context.Context, q *sqlchemy.SQuery, userCred mcclient.TokenCredential, keys stringutils2.SSortedStrings) (*sqlchemy.SQuery, error)

	// fetch hook
	Query(val ...string) *sqlchemy.SQuery
	RawQuery(val ...string) *sqlchemy.SQuery

	FilterById(q *sqlchemy.SQuery, idStr string) *sqlchemy.SQuery
	FilterByNotId(q *sqlchemy.SQuery, idStr string) *sqlchemy.SQuery
	FilterByName(q *sqlchemy.SQuery, name string) *sqlchemy.SQuery
	FilterByOwner(q *sqlchemy.SQuery, userCred mcclient.IIdentityProvider, scope rbacutils.TRbacScope) *sqlchemy.SQuery
	FilterBySystemAttributes(q *sqlchemy.SQuery, userCred mcclient.TokenCredential, query jsonutils.JSONObject, scope rbacutils.TRbacScope) *sqlchemy.SQuery
	FilterByHiddenSystemAttributes(q *sqlchemy.SQuery, userCred mcclient.TokenCredential, query jsonutils.JSONObject, scope rbacutils.TRbacScope) *sqlchemy.SQuery
	FilterByUniqValues(q *sqlchemy.SQuery, uniqValues jsonutils.JSONObject) *sqlchemy.SQuery

	// RawFetchById(idStr string) (IModel, error)
	FetchById(idStr string) (IModel, error)
	FetchByName(userCred mcclient.IIdentityProvider, idStr string) (IModel, error)
	FetchByIdOrName(userCred mcclient.IIdentityProvider, idStr string) (IModel, error)

	// create hooks
	// AllowCreateItem(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) bool
	// BatchCreateValidateCreateData(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data *jsonutils.JSONDict) (*jsonutils.JSONDict, error)
	// ValidateCreateData dynamic called by dispatcher
	// ValidateCreateData(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data *jsonutils.JSONDict) (*jsonutils.JSONDict, error)
	OnCreateComplete(ctx context.Context, items []IModel, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data jsonutils.JSONObject)
	BatchPreValidate(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider,
		query jsonutils.JSONObject, data *jsonutils.JSONDict, count int) error

	OnCreateFailed(ctx context.Context, userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider, query jsonutils.JSONObject, data jsonutils.JSONObject) error

	// allow perform action
	// AllowPerformAction(ctx context.Context, userCred mcclient.TokenCredential, action string, query jsonutils.JSONObject, data jsonutils.JSONObject) bool
	// AllowPerformCheckCreateData(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject, data jsonutils.JSONObject) bool
	PerformAction(ctx context.Context, userCred mcclient.TokenCredential, action string, query jsonutils.JSONObject, data jsonutils.JSONObject) (jsonutils.JSONObject, error)

	InitializeData() error

	CustomizeHandlerInfo(info *appsrv.SHandlerInfo)
	SetHandlerProcessTimeout(info *appsrv.SHandlerInfo, r *http.Request) time.Duration

	FetchCreateHeaderData(ctx context.Context, header http.Header) (jsonutils.JSONObject, error)
	FetchUpdateHeaderData(ctx context.Context, header http.Header) (jsonutils.JSONObject, error)
	IsCustomizedGetDetailsBody() bool
	ListSkipLog(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) bool
	GetSkipLog(ctx context.Context, userCred mcclient.TokenCredential, query jsonutils.JSONObject) bool

	// fetch owner Id from query when create resource
	FetchOwnerId(ctx context.Context, data jsonutils.JSONObject) (mcclient.IIdentityProvider, error)
	FetchUniqValues(ctx context.Context, data jsonutils.JSONObject) jsonutils.JSONObject

	/* name uniqueness scope, system/domain/project, default is system */
	NamespaceScope() rbacutils.TRbacScope
	ResourceScope() rbacutils.TRbacScope

	// 如果error为非空，说明没有匹配的field，如果为空，说明匹配上了
	QueryDistinctExtraField(q *sqlchemy.SQuery, field string) (*sqlchemy.SQuery, error)

	GetPagingConfig() *SPagingConfig

	GetI18N(ctx context.Context, idstr string, resObj jsonutils.JSONObject) *jsonutils.JSONDict

	GetSplitTable() *splitable.SSplitTableSpec

	CreateByInsertOrUpdate() bool
}

type IOwnerResourceBaseModel interface {
	GetChangeOwnerCandidateDomainIds() []string
	GetChangeOwnerRequiredDomainIds() []string
}

type IPendingDeletable interface {
	GetPendingDeleted() bool
	GetPendingDeletedAt() time.Time
}

type IRecordChecksumModel interface {
	IModel
	IRecordChecksumResourceBase
}

type IRecordChecksumModelManager interface {
	IModelManager
	EnableRecordChecksum() bool
	SetEnableRecordChecksum(bool)
}

type IRecordChecksumResourceBase interface {
	GetRecordChecksum() string
	SetRecordChecksum(checksum string)
}

type IResource interface {
	KeywordPlural() string
}

type IResourceCountManager interface {
	GetResourceCount() ([]SScopeResourceCount, error)
	KeywordPlural() string
}

type IResourceModel interface {
	IModel

	GetIResourceModel() IResourceModel
}

type IResourceModelManager interface {
	IModelManager

	GetIResourceModelManager() IResourceModelManager
}

type IScopedResourceManager interface {
	KeywordPlural() string
	ResourceScope() rbacutils.TRbacScope
	FetchOwnerId(ctx context.Context, data jsonutils.JSONObject) (mcclient.IIdentityProvider, error)
}

type IScopedResourceModel interface {
	IModel

	GetDomainId() string
	GetProjectId() string
	SetResourceScope(domainId, projectId string) error
}

type ISharableBase interface {
	SetShare(scoe rbacutils.TRbacScope)
	GetIsPublic() bool
	GetPublicScope() rbacutils.TRbacScope
	GetSharableTargetDomainIds() []string
	GetRequiredSharedDomainIds() []string
	GetSharedDomains() []string
}

type ISharableBaseModel interface {
	IStandaloneModel
	ISharableBase
}

type ISharableVirtualModel interface {
	IVirtualModel
	ISharableBase

	GetISharableVirtualModel() ISharableVirtualModel
	GetSharedProjects() []string
}

type ISharableVirtualModelManager interface {
	IVirtualModelManager

	GetISharableVirtualModelManager() ISharableVirtualModelManager
}

type IStandaloneModel interface {
	IResourceModel

	StandaloneModelManager() IStandaloneModelManager

	GetIStandaloneModel() IStandaloneModel
	ClearSchedDescCache() error

	GetMetadata(ctx context.Context, key string, userCred mcclient.TokenCredential) string
	GetMetadataJson(ctx context.Context, key string, userCred mcclient.TokenCredential) jsonutils.JSONObject
	SetMetadata(ctx context.Context, key string, value interface{}, userCred mcclient.TokenCredential) error
	SetAllMetadata(ctx context.Context, dictstore map[string]interface{}, userCred mcclient.TokenCredential) error
	SetUserMetadataValues(ctx context.Context, dictstore map[string]interface{}, userCred mcclient.TokenCredential) error
	SetUserMetadataAll(ctx context.Context, dictstore map[string]interface{}, userCred mcclient.TokenCredential) error
	SetCloudMetadataAll(ctx context.Context, dictstore map[string]interface{}, userCred mcclient.TokenCredential) error
	RemoveMetadata(ctx context.Context, key string, userCred mcclient.TokenCredential) error
	RemoveAllMetadata(ctx context.Context, userCred mcclient.TokenCredential) error
	GetAllMetadata(ctx context.Context, userCred mcclient.TokenCredential) (map[string]string, error)
	GetAllClassMetadata() (map[string]string, error)

	IsShared() bool

	IMetadataBaseModel
}

type IStandaloneModelManager interface {
	IResourceModelManager

	GetIStandaloneModelManager() IStandaloneModelManager

	IMetadataBaseModelManager
}

type IStatusBase interface {
	SetStatusValue(status string)
	GetStatus() string
	SetProgressValue(progress float32)
	GetProgress() float32
}

type IStatusBaseModel interface {
	IModel
	IStatusBase
}

type IStatusDomainLevelModel interface {
	IDomainLevelModel
	IStatusBase
}

type IStatusInfrasModel interface {
	IInfrasModel
	IStatusBase
}

type IStatusStandaloneModel interface {
	IStandaloneModel
	IStatusBase
}

type ITableSpec interface {
	Name() string
	Columns() []sqlchemy.IColumnSpec
	PrimaryColumns() []sqlchemy.IColumnSpec
	DataType() reflect.Type
	// CreateSQL() string
	Instance() *sqlchemy.STable
	ColumnSpec(name string) sqlchemy.IColumnSpec
	Insert(ctx context.Context, dt interface{}) error
	InsertOrUpdate(ctx context.Context, dt interface{}) error
	Update(ctx context.Context, dt interface{}, doUpdate func() error) (sqlchemy.UpdateDiffs, error)
	Fetch(dt interface{}) error
	// FetchAll(dest interface{}) error
	SyncSQL() []string
	DropForeignKeySQL() []string
	AddIndex(unique bool, cols ...string) bool
	Increment(ctx context.Context, diff interface{}, target interface{}) error
	Decrement(ctx context.Context, diff interface{}, target interface{}) error

	GetSplitTable() *splitable.SSplitTableSpec

	GetTableSpec() *sqlchemy.STableSpec

	GetDBName() sqlchemy.DBName
}

type IUsage interface {
	FetchUsage(ctx context.Context) error
	IsEmpty() bool
}

type IUserModelManager interface {
	IStandaloneModelManager

	GetIUserModelManager() IUserModelManager
	GetResourceCount() ([]SScopeResourceCount, error)
}

type IVirtualModel interface {
	IStandaloneModel
	IPendingDeletable

	IsOwner(userCred mcclient.TokenCredential) bool

	SyncCloudProjectId(userCred mcclient.TokenCredential, ownerId mcclient.IIdentityProvider)

	GetIVirtualModel() IVirtualModel

	IOwnerResourceBaseModel
}

type IVirtualModelManager interface {
	IStandaloneModelManager

	GetIVirtualModelManager() IVirtualModelManager
	GetResourceCount() ([]SScopeResourceCount, error)
}

type ListItemExportKeysProvider interface {
	ListItemExportKeys(ctx context.Context, q *sqlchemy.SQuery, userCred mcclient.TokenCredential, keys stringutils2.SSortedStrings) (*sqlchemy.SQuery, error)
}

type QueryDistinctExtraFieldProvider interface {
	QueryDistinctExtraField(q *sqlchemy.SQuery, field string) (*sqlchemy.SQuery, error)
}

type SAdminSharableVirtualResourceBase struct {
	SSharableVirtualResourceBase
	Records string `charset:"utf8" list:"user" create:"optional" update:"user"`
}

type SAdminSharableVirtualResourceBaseManager struct {
	SSharableVirtualResourceBaseManager
	RecordsSeparator string
	RecordsLimit     int
}

type SAutoDeleteResourceBase struct {
	// 是否跟随资源自动删除
	// example: false
	AutoDelete bool `nullable:"false" default:"false" get:"user" update:"user" json:"auto_delete"`
}

type SAutoDeleteResourceBaseManager struct{}

type SCachedTenant struct {
	Id            string            `json:"id"`
	Name          string            `json:"name"`
	DomainId      string            `json:"domain_id"`
	ProjectDomain string            `json:"project_domain"`
	Metadata      map[string]string `json:"metadata"`
}

type SCertificateResourceBase struct {
	Certificate string `create:"required" list:"user" update:"user"`
	PrivateKey  string `create:"required" list:"admin" update:"user"`

	// derived attributes
	PublicKeyAlgorithm      string    `create:"optional" list:"user" update:"user"`
	PublicKeyBitLen         int       `create:"optional" list:"user" update:"user"`
	SignatureAlgorithm      string    `create:"optional" list:"user" update:"user"`
	Fingerprint             string    `create:"optional" list:"user" update:"user"`
	NotBefore               time.Time `create:"optional" list:"user" update:"user"`
	NotAfter                time.Time `create:"optional" list:"user" update:"user"`
	CommonName              string    `create:"optional" list:"user" update:"user"`
	SubjectAlternativeNames string    `create:"optional" list:"user" update:"user"`
}

type SDistinctField struct {
	SModelBase

	// 资源类型
	// example: network
	ObjType string `width:"40" charset:"ascii" index:"true" list:"user" get:"user"`

	// 资源组合ID
	// example: obj_type::key::value
	Id string `width:"128" charset:"utf8" primary:"true" list:"user" get:"user"`

	// Distinct Field
	// exmaple: 部门
	Key string `width:"64" charset:"utf8" primary:"true" list:"user" get:"user"`

	// Distinct Value
	// example: 技术部
	Value string `charset:"utf8" list:"user" get:"user"`
}

type SDistinctFieldManager struct {
	SModelBaseManager
}

type SDnsNameValidatorManager struct{}

type SDomainLevelResourceBase struct {
	SStandaloneResourceBase
	SDomainizedResourceBase

	// 归属Domain信息的来源, local: 本地设置, cloud: 从云上同步过来
	// example: local
	DomainSrc string `width:"10" charset:"ascii" nullable:"true" list:"user" default:"" json:"domain_src"`
}

type SDomainLevelResourceBaseManager struct {
	SStandaloneResourceBaseManager
	SDomainizedResourceBaseManager
}

type SDomainizedResourceBase struct {
	// 域Id
	DomainId string `width:"64" charset:"ascii" default:"default" nullable:"false" index:"true" list:"user" json:"domain_id"`
}

type SDomainizedResourceBaseManager struct {
}

type SEnabledResourceBase struct {
	// 资源是否启用
	Enabled tristate.TriState `default:"false" list:"user" create:"optional"`
}

type SEnabledResourceBaseManager struct{}

type SEnabledStatusDomainLevelResourceBase struct {
	SStatusDomainLevelResourceBase
	SEnabledResourceBase
}