types

type BackupV1 struct {
	Version             string                `json:"version"`
	Created             time.Time             `json:"created"`
	Users               []*User               `json:"users"`
	FilesystemMasters   []*FilesystemMaster   `json:"filesystem_masters"`
	RegistryFilesystems []*RegistryFilesystem `json:"registry_filesystems"`
	RegistryClones      []*Clone              `json:"registry_clones"`
}

type ByAddress []Server

type Clone struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	TopLevelFilesystemId string
	FilesystemId         string
	Name                 string
	Origin               Origin
}

type CloneWithName struct {
	Name  string
	Clone Clone
}

type ClonesList []CloneWithName

type CommitArgs struct {
	Namespace string
	Name      string
	Branch    string
	Message   string
	Metadata  map[string]string
}

type CommitNotification struct {
	FilesystemId string
	Namespace    string
	Name         string
	Branch       string
	CommitId     string
	Metadata     map[string]string

	OwnerID         string
	CollaboratorIDs []string
}

type DockerContainer struct {
	Name string
	Id   string
}

type DotmeshVolume struct {
	Id                   string
	Name                 VolumeName
	Branch               string
	Master               string
	SizeBytes            int64
	DirtyBytes           int64
	CommitCount          int64
	ServerStates         map[string]string // serverId => state
	ServerStatuses       map[string]string // serverId => status
	ForkParentId         string
	ForkParentSnapshotId string
}

type DotmeshVolumeAndContainers struct {
	Volume     DotmeshVolume
	Containers []DockerContainer
}

type Event struct {
	ID           string
	Name         string
	FilesystemID string
	Type         EventType
	Args         *EventArgs
}

type EventArgs map[string]interface{}

type EventType int

type FileChange uint

type Filesystem struct {
	Id        string
	Exists    bool
	Mounted   bool
	Snapshots []*Snapshot
	// support filesystem which is clone of another filesystem, for branching
	// purposes, with origin e.g. "<fs-uuid-of-actual-origin-snapshot>@<snap-id>"
	Origin Origin
}

type FilesystemContainers struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	FilesystemID string                      `json:"filesystem_id"`
	NodeID       string                      `json:"node_id"`
	Containers   []container.DockerContainer `json:"containers"`
}

type FilesystemDeletionAudit struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	FilesystemID string    `json:"filesystem_id"`
	Server       string    `json:"server"`
	Username     string    `json:"username"`
	DeletedAt    time.Time `json:"deleted_at"`

	// These fields are mandatory
	Name                 VolumeName `json:"name"`
	TopLevelFilesystemId string     `json:"top_level_filesystem_id"`
	Clone                string     `json:"clone"`
}

type FilesystemDirty struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	FilesystemID string `json:"filesystem_id"`
	NodeID       string `json:"node_id"`
	DirtyBytes   int64  `json:"dirty_bytes"`
	SizeBytes    int64  `json:"size_bytes"`
}

type FilesystemLive struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	FilesystemID string `json:"filesystem_id"`
	NodeID       string `json:"node_id"`
}

type FilesystemMaster struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	FilesystemID string `json:"filesystem_id"`
	NodeID       string `json:"node_id"`
}

type ForkRequest struct {
	MasterBranchId string
	ForkNamespace  string
	ForkName       string
}

type InputFile struct {
	Filename string
	// If this is nil, this will delete the file:
	Contents io.Reader
	User     string
	Response chan *Event
	Extract  bool
}

type ItemData struct {
	Name      string
	Size      int64
	VersionId string
	Err       error
}

type KVAction int

type KVMeta struct {
	// KVDBIndex A Monotonically index updated at each modification operation.
	KVDBIndex uint64
	// CreatedIndex for this kv pair
	CreatedIndex uint64
	// ModifiedIndex for this kv pair. It's getting increased
	// for all KV pairs when any modifications are made
	ModifiedIndex uint64

	// Action the last action on this KVPair.
	Action KVAction
}

type LastModified struct {
	Time time.Time
}

type ListFileItem struct {
	Key          string    `json:"key"` // the full path to the item (including folders)
	LastModified time.Time `json:"last_modified"`
	Size         int64     `json:"size"`
	Directory    bool      `json:"directory"` // is this item a directory or a file
}

type ListFileRequest struct {
	Base               string // the root of the dot we are listing
	Prefix             string // the sub path we are listing
	MaxKeys            int64  // limit the number of files we get in the response
	Page               int64  // what page we are viewing - we start listing at Page * Limit
	Recursive          bool   // do we want to recurse into folders or just look at the given path
	IncludeDirectories bool   // do we want directories to be included in the result or just files?
}

type ListFileResponse struct {
	Items      []ListFileItem
	TotalCount int64
}

type MountCommitRequest struct {
	FilesystemId string
	CommitId     string
}

type Origin struct {
	FilesystemId string
	SnapshotId   string
}

type OutputFile struct {
	Filename          string
	SnapshotMountPath string
	Contents          io.Writer
	User              string
	Response          chan *Event
}

type PathToTopLevelFilesystem struct {
	TopLevelFilesystemId   string
	TopLevelFilesystemName VolumeName
	Clones                 ClonesList
}

type PermissionDenied struct {
}

type Prelude struct {
	SnapshotProperties []*Snapshot
}

type ProcureArgs struct {
	Namespace string
	Name      string
	Subdot    string
}

type Query struct {
	Ref      string // ID, name, email
	Selector string // K8s style selector to filter based on user metadata fields
}

type RPCDiffRequest struct {
	FilesystemID string
}

type RPCDiffResponse struct {
	Files []ZFSFileDiff
}

type RPCForkRequest struct {
	MasterBranchID string
	ForkNamespace  string
	ForkName       string
}

type RegistryFilesystem struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	Id                   string
	OwnerId              string // also know as 'namespace'
	Name                 string // volume name
	ForkParentId         string `json:",omitempty"`
	ForkParentSnapshotId string `json:",omitempty"`
	CollaboratorIds      []string
}

type RollbackRequest struct {
	Namespace  string
	Name       string
	Branch     string
	SnapshotId string
}

type S3TransferRequest struct {
	KeyID           string
	SecretKey       string
	Prefixes        []string
	Endpoint        string
	Direction       string
	LocalNamespace  string
	LocalName       string
	LocalBranchName string
	RemoteName      string
}

type SafeConfig struct {
}

type SafeUser struct {
	Id        string
	Name      string
	Email     string
	EmailHash string
	Metadata  map[string]string
}

type Server struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	Id        string
	Addresses []string
}

type ServerSnapshots struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	ID           string      `json:"id"` // NodeID
	FilesystemID string      `json:"filesystem_id"`
	Snapshots    []*Snapshot `json:"snapshots"`
}

type ServerState struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	ID           string            `json:"id"` // NodeID
	FilesystemID string            `json:"filesystem_id"`
	State        map[string]string `json:"state"`
}

type Snapshot struct {
	// exported for json serialization
	Id       string
	Metadata map[string]string
}

type StashRequest struct {
	FilesystemId string
	SnapshotId   string
}

type SubscribeQuery struct {
	RequestID    string
	FilesystemID string
	Type         EventType
}

type TopLevelFilesystem struct {
	MasterBranch         DotmeshVolume
	OtherBranches        []DotmeshVolume
	Owner                SafeUser
	Collaborators        []SafeUser
	ForkParentId         string
	ForkParentSnapshotId string
}

type TransferPollResult struct {
	// Meta is populated by the KV store implementer
	Meta *KVMeta `json:"-"`

	TransferRequestId string
	Peer              string // hostname
	User              string
	ApiKey            string
	Direction         string // "push" or "pull"

	// Hold onto this information, it might become useful for e.g. recursive
	// receives of clone filesystems.
	LocalNamespace   string
	LocalName        string
	LocalBranchName  string
	RemoteNamespace  string
	RemoteName       string
	RemoteBranchName string

	// Same across both clusters
	FilesystemId string

	// TODO add clusterIds? probably comes from etcd. in fact, could be the
	// discovery id (although that is only for bootstrap... hmmm).
	InitiatorNodeId string
	PeerNodeId      string

	// XXX a Transfer that spans multiple filesystem ids won't have a unique
	// starting/target snapshot, so this is in the wrong place right now.
	// although maybe it makes sense to talk about a target *final* snapshot,
	// with interim snapshots being an implementation detail.
	StartingCommit string
	TargetCommit   string

	Index              int    // i.e. transfer 1/4 (Index=1)
	Total              int    //                   (Total=4)
	Status             string // one of "starting", "running", "finished", "error"
	NanosecondsElapsed int64
	Size               int64 // size of current segment in bytes
	Sent               int64 // number of bytes of current segment sent so far
	Message            string
}

type TransferRequest struct {
	Peer             string // hostname
	User             string
	Port             int
	ApiKey           string //protected value in toString
	Direction        string // "push" or "pull"
	LocalNamespace   string
	LocalName        string
	LocalBranchName  string
	RemoteNamespace  string
	RemoteName       string
	RemoteBranchName string
	// TODO could also include SourceSnapshot here
	TargetCommit    string // optional, "" means "latest"
	StashDivergence bool
}

type TransferUpdate struct {
	Kind TransferUpdateKind

	Changes TransferPollResult

	GetResult chan TransferPollResult
}

type TransferUpdateKind int

type User struct {
	Id       string
	Name     string
	Email    string
	Salt     []byte
	Password []byte
	ApiKey   string
	Metadata map[string]string
}

type VersionInfo struct {
	InstalledVersion    string `json:"installed_version"`
	CurrentVersion      string `json:"current_version"`
	CurrentReleaseDate  int    `json:"current_release_date"`
	CurrentDownloadURL  string `json:"current_download_url"`
	CurrentChangelogURL string `json:"current_changelog_url"`
	ProjectWebsite      string `json:"project_website"`
	Outdated            bool   `json:"outdated"`
}

type VolumeName struct {
	Namespace string
	Name      string
}

type VolumesAndBranches struct {
	Dots    []TopLevelFilesystem
	Servers []Server
}

type ZFSFileDiff struct {
	Change   FileChange `json:"change"`
	Filename string     `json:"filename"`
}