entity

type Adapter struct {
	ContentType    *ContentType
	Executable     *Executable
	IntentTemplate *IntentTemplate
	Media          *Media
	Package        *SoftwarePackage
	Project        *Project
	Repository     *LocalRepository
	Remote         *RemoteRepository
	Setting        *Setting
	Source         *Namespace
	User           *User
	Worktree       *Worktree
}

type Base struct {
	UUID dxo.UUID `gorm:"index:,unique"`

	// ID        uint           `gorm:"primaryKey"`
	CreatedAt time.Time
	UpdatedAt time.Time
	DeletedAt gorm.DeletedAt `gorm:"index"`

	Committer dxo.UserID
	Creator   dxo.UserID
	Owner     dxo.UserID

	Referer string // a URL, refer to owner document of this entity

	Installation dxo.InstallationID // 用来跟踪软件包安装资源项 ,  >0 表示已安装
}

type ContentType struct {
	ID  dxo.ContentTypeID  `gorm:"primaryKey"`
	URN dxo.ContentTypeURN `gorm:"index:,unique"`

	Base

	Name     dxo.ContentTypeName
	Patterns dxo.StringList

	Label       string
	Icon        string
	Description string

	Priority  int // 优先级，数值越高越先处理
	AsFile    bool
	AsDir     bool
	AsProject bool // true 表示这是一个项目类型
}

type ContentTypeLessFn func(o1, o2 *ContentType) bool

type Example struct {
	ID dxo.ExampleID `gorm:"primaryKey"`
	Base
}

type Executable struct {
	ID  dxo.ExecutableID  `gorm:"primaryKey"`
	URN dxo.ExecutableURN // 同名，不同location的多个实体表示 同一个应用的不同版本

	Base

	Name             string
	Aliases          dxo.StringList
	Namespace        string
	Title            string
	IconURL          string
	Description      string
	Size             int64
	SHA256SUM        util.Hex
	OpenWithPriority int // 如果 value<=0, 表示 disable

	OS      string
	Arch    string
	Version string

	Path string `gorm:"index:,unique"`
}

type Holder struct {
	ID        int64
	TableName string
	Meta      Base
	Target    *Adapter
}

type InstalledFile struct {
	ID dxo.InstalledFileID `gorm:"primaryKey"`

	Base

	Name         string // the file name
	Path         string `gorm:"index:,unique"`
	Size         int64
	SHA256SUM    util.Hex
	IsFile       bool
	IsDir        bool
	OwnerPackage dxo.SoftwarePackageURN
}

type IntentTemplate struct {
	ID dxo.IntentTemplateID `gorm:"primaryKey"`
	Base

	Name        string
	Title       string
	Group       string
	Description string
	IconURL     string

	Selector    dxo.IntentTemplateSelector `gorm:"index:,unique"` // 根据（Action + TargetType + ExecutableName）生成
	Method      string
	ContentType string // project-type|content-type|target-type
	// Target      string            // the type of target: file|folder|repository|worktree|...|
	Executable dxo.ExecutableURN // the URN of exe

	Command   string
	Arguments dxo.StringListCRLF // as []string
	Env       dxo.StringMap      // as map[string]string
	WD        string
}

type LocalRepository struct {
	ID dxo.LocalRepositoryID `gorm:"primaryKey"`
	Base

	Name        string
	DisplayName string
	Description string
	Bare        bool

	ConfigFile     string
	RepositoryPath string // the parent of ConfigFile
	DotGitPath     string // can be empty
	WorkingPath    string // can be empty

	Path     string         // this.Path == Location.Path == ConfigFile
	Location dxo.LocationID `gorm:"index:,unique"`
	Class    dxo.LocationClass
}

type Location struct {
	ID dxo.LocationID `gorm:"primaryKey"`
	Base

	Path string `gorm:"index:,unique"` // the normalized full-path

	Class  dxo.LocationClass
	AsFile bool // 表示该路径可以是一个普通文件
	AsDir  bool // 表示该路径可以是一个目录

}

type Media struct {
	ID dxo.MediaID `gorm:"primaryKey"`
	Base

	Name   string
	URL    string `gorm:"index:,unique"`
	Source string // Source 表示资源的原始来源URL，如果本地没有该资源，可以通过此URL下载
	Bucket string
	Label  string

	ContentType   string
	ContentLength int64

	SHA256SUM util.Hex
}

type Namespace struct {
	ID  dxo.NamespaceID  `gorm:"primaryKey"`
	URN dxo.NamespaceURN `gorm:"index:,unique"`

	Base

	Name string // like 'domain/path/to/file' format

	URL string // like 'https://domain/path/to/file' format

	Arch string
	OS   string
}

type Project struct {
	ID dxo.ProjectID `gorm:"primaryKey"`
	Base

	Name           string
	PathInWorktree string
	Description    string
	IsFile         bool
	IsDir          bool
	// ProjectTypeName string
	ConfigFileName  string
	OwnerRepository dxo.LocalRepositoryID

	// FullPath        string `gorm:"index:,unique"`  [已废弃] 用 Path 代替
	ProjectDir string

	Path     string         // this.Path == Location.Path
	Location dxo.LocationID `gorm:"index:,unique"`
	Class    dxo.LocationClass

	Type dxo.ContentTypeName
}

type RemoteRepository struct {
	ID dxo.RemoteRepositoryID `gorm:"primaryKey"`
	Base

	Name        string
	URL         string
	DisplayName string
}

type Setting struct {
	ID dxo.SettingID `gorm:"primaryKey"`
	Base

	Name        string `gorm:"index:,unique"`
	Value       string
	Description string
	Type        string
}

type SoftwarePackage struct {
	ID  dxo.SoftwarePackageID  `gorm:"primaryKey"`
	URN dxo.SoftwarePackageURN `gorm:"index:,unique"`

	Base

	Namespace  string
	Name       string
	ModuleName string // = namespace + "#" + name
	FileName   string

	Icon        string
	Title       string
	Description string

	ContentType string
	Size        int64
	SHA256SUM   util.Hex

	WebPageURL  string
	DownloadURL string
	ResourceURL string

	OS        string
	Arch      string
	Version   string
	Revision  int
	ReleaseAt time.Time
}

type SystemConfig struct {
	Name        string `gorm:"index:,unique"`
	ContentType string
}

type User struct {
	ID dxo.UserID
	Base

	Name     dxo.UserName `gorm:"index:,unique"`
	Avatar   string
	Nickname string
	Home     string // the home dir path
}

type UserConfig struct {
	Name        string `gorm:"index:,unique"`
	ContentType string
}

type Worktree struct {
	ID dxo.WorktreeID `gorm:"primaryKey"`
	Base

	Name string

	DotGitPath       string
	WorkingDirectory string

	Path     string         // this.Path == Location.Path == DotGitPath
	Location dxo.LocationID `gorm:"index:,unique"`
	Class    dxo.LocationClass

	OwnerRepository dxo.LocalRepositoryID
}