package api

import "time"

// SystemStorageConfig represents additional configuration for the system's local storage.
type SystemStorageConfig struct {
	ScrubSchedule string              `json:"scrub_schedule" yaml:"scrub_schedule"`
	Pools         []SystemStoragePool `incusos:"-"           json:"pools,omitempty" yaml:"pools,omitempty"`
}

// SystemStorageState represents additional state for the system's local storage.
type SystemStorageState struct {
	Drives        []SystemStorageDrive       `json:"drives"         yaml:"drives"`
	Pools         []SystemStoragePool        `json:"pools"          yaml:"pools"`
	RootPartition SystemStorageRootPartition `json:"root_partition" yaml:"root_partition"`
}

// SystemStorageRootPartition defines a struct that holds usage information about the root ("/") partition.
type SystemStorageRootPartition struct {
	SizeInBytes      int `json:"size_in_bytes"      yaml:"size_in_bytes"`
	AvailableInBytes int `json:"available_in_bytes" yaml:"available_in_bytes"`
}

// SystemStorage defines a struct to hold information about the system's local storage.
//
// swagger:model
type SystemStorage struct {
	Config SystemStorageConfig `json:"config" yaml:"config"`

	State SystemStorageState `incusos:"-" json:"state" yaml:"state"`
}

// SystemStoragePool defines a struct that is used to create or update a storage pool and return its current state.
type SystemStoragePool struct {
	// Name and Type cannot be changed after pool creation.
	Name string `json:"name" yaml:"name"`
	// Supported pool types: zfs-raid0, zfs-raid1, zfs-raid10, zfs-raidz1, zfs-raidz2, zfs-raidz3.
	Type string `json:"type" yaml:"type"`
	// If true, allow creation of a pool with devices of different sizes.
	AllowMixedDevSizes bool `json:"allow_mixed_dev_sizes,omitempty" yaml:"allow_mixed_dev_sizes,omitempty"`

	// Devices, Cache, Log, and Special can be modified to add/remove/replace devices in the pool.
	Devices []string                  `json:"devices"           yaml:"devices"`
	Cache   []string                  `json:"cache,omitempty"   yaml:"cache,omitempty"`
	Log     []string                  `json:"log,omitempty"     yaml:"log,omitempty"`
	Special *SystemStoragePoolSpecial `json:"special,omitempty" yaml:"special"`

	// Read-only fields returned from the server with additional pool information.
	Managed                   bool                          `json:"managed"                       yaml:"managed"`
	State                     string                        `json:"state"                         yaml:"state"`
	LastScrub                 *SystemStoragePoolScrubStatus `json:"last_scrub,omitempty"          yaml:"last_scrub,omitempty,omitempty"`
	EncryptionKeyStatus       string                        `json:"encryption_key_status"         yaml:"encryption_key_status"`
	DevicesDegraded           []string                      `json:"devices_degraded,omitempty"    yaml:"devices_degraded,omitempty"`
	CacheDegraded             []string                      `json:"cache_degraded,omitempty"      yaml:"cache_degraded,omitempty"`
	LogDegraded               []string                      `json:"log_degraded,omitempty"        yaml:"log_degraded,omitempty"`
	SpecialDegraded           []string                      `json:"special_degraded,omitempty"    yaml:"special_degraded,omitempty"`
	RawPoolSizeInBytes        int                           `json:"raw_pool_size_in_bytes"        yaml:"raw_pool_size_in_bytes"`
	UsablePoolSizeInBytes     int                           `json:"usable_pool_size_in_bytes"     yaml:"usable_pool_size_in_bytes"`
	PoolAllocatedSpaceInBytes int                           `json:"pool_allocated_space_in_bytes" yaml:"pool_allocated_space_in_bytes"`
	Volumes                   []SystemStoragePoolVolume     `json:"volumes"                       yaml:"volumes"`
}

// SystemStoragePoolSpecial defines a struct that is used to create or update a pool's special vdev.
type SystemStoragePoolSpecial struct {
	// Supported special device types: zfs-raid0, zfs-raid1, zfs-raid10, zfs-raidz1, zfs-raidz2, zfs-raidz3.
	Type string `json:"type" yaml:"type"`
	// If non-zero, will be used when setting the pool's special_small_blocks property.
	SpecialSmallBlocksSizeInKB int `json:"special_small_blocks_size_in_kb" yaml:"special_small_blocks_size_in_kb"`
	// One or more physical devices to create the pool's special vdev.
	Devices []string `json:"devices" yaml:"devices"`
}

// SystemStoragePoolVolume represents a single IncusOS-managed volume in a pool.
type SystemStoragePoolVolume struct {
	Name         string `json:"name"           yaml:"name"`
	UsageInBytes int    `json:"usage_in_bytes" yaml:"usage_in_bytes"`
	QuotaInBytes int    `json:"quota_in_bytes" yaml:"quota_in_bytes"`
	Use          string `json:"use"            yaml:"use"`
}

// SystemStoragePoolScrubState represents the state of a scan in a pool.
type SystemStoragePoolScrubState string

const (
	// ScrubUnknown represents and unknown scrub status.
	ScrubUnknown SystemStoragePoolScrubState = "UNKNOWN"
	// ScrubInProgress represents that the scrub is in progress.
	ScrubInProgress SystemStoragePoolScrubState = "IN_PROGRESS"
	// ScrubFinished represents that the scrub has finished.
	ScrubFinished SystemStoragePoolScrubState = "FINISHED"
)

// SystemStoragePoolScrubStatus represents the status of a scrub in a pool.
type SystemStoragePoolScrubStatus struct {
	State     SystemStoragePoolScrubState `json:"state"`
	StartTime time.Time                   `json:"start_time"`
	EndTime   time.Time                   `json:"end_time"`
	Progress  string                      `json:"progress"`
	Errors    int                         `json:"errors"`
}

// SystemStorageDrive defines a struct that holds information about a specific drive.
type SystemStorageDrive struct {
	ID              string                   `json:"id"                     yaml:"id"`
	ModelFamily     string                   `json:"model_family"           yaml:"model_family"`
	ModelName       string                   `json:"model_name"             yaml:"model_name"`
	SerialNumber    string                   `json:"serial_number"          yaml:"serial_number"`
	Bus             string                   `json:"bus"                    yaml:"bus"`
	CapacityInBytes int                      `json:"capacity_in_bytes"      yaml:"capacity_in_bytes"`
	Boot            bool                     `json:"boot"                   yaml:"boot"`
	Multipath       bool                     `json:"multipath"              yaml:"multipath"`
	Removable       bool                     `json:"removable"              yaml:"removable"`
	Remote          bool                     `json:"remote"                 yaml:"remote"`
	WWN             string                   `json:"wwn,omitempty"          yaml:"wwn,omitempty"`
	WWNID           string                   `json:"wwn_id,omitempty"       yaml:"wwn_id,omitempty"`
	SMART           *SystemStorageDriveSMART `json:"smart,omitempty"        yaml:"smart,omitempty"`
	MemberPool      string                   `json:"member_pool,omitempty"  yaml:"member_pool,omitempty"`
	Encrypted       bool                     `json:"encrypted,omitempty"    yaml:"encrypted,omitempty"`
	EncryptedID     string                   `json:"encrypted_id,omitempty" yaml:"encrypted_id,omitempty"`
}

// SystemStorageDriveSMART defines a struct to return basic SMART information about a specific device.
type SystemStorageDriveSMART struct {
	Enabled bool   `json:"enabled"         yaml:"enabled"`
	Passed  bool   `json:"passed"          yaml:"passed"`
	Error   string `json:"error,omitempty" yaml:"error,omitempty"`

	PowerOnHours       int `json:"power_on_hours,omitempty"      yaml:"power_on_hours,omitempty"`
	DataUnitsRead      int `json:"data_units_read,omitempty"     yaml:"data_units_read,omitempty"`
	DataUnitsWritten   int `json:"data_units_written,omitempty"  yaml:"data_units_written,omitempty"`
	AvailableSpare     int `json:"available_spare,omitempty"     yaml:"available_spare,omitempty"`
	PercentageUsed     int `json:"percentage_used,omitempty"     yaml:"percentage_used,omitempty"`
	RawReadErrorRate   int `json:"raw_read_error_rate,omitempty" yaml:"raw_read_error_rate,omitempty"`
	SeekErrorRate      int `json:"seek_error_rate,omitempty"     yaml:"seek_error_rate,omitempty"`
	ReallocatedSectors int `json:"reallocated_sectors,omitempty" yaml:"reallocated_sectors,omitempty"`
}

// SystemStorageWipe defines a struct with information about what drive to wipe.
//
// swagger:model
type SystemStorageWipe struct {
	ID         string `json:"id"          yaml:"id"`
	SecureWipe bool   `json:"secure_wipe" yaml:"secure_wipe"` // If true, require a complete secure wiping of the drive, which might take a long time.
}

// SystemStorageImportEncryptedDrive defines a struct with information about what drive to decrypt.
//
// swagger:model
type SystemStorageImportEncryptedDrive struct {
	ID  string `json:"id"  yaml:"id"`
	Key string `json:"key" yaml:"key"`
}

// SystemStorageEncrypt defines a struct with information about what drive to encrypt.
//
// swagger:model
type SystemStorageEncrypt struct {
	ID         string `json:"id"          yaml:"id"`
	SecureWipe bool   `json:"secure_wipe" yaml:"secure_wipe"` // If true, require a complete secure wiping of the drive, which might take a long time.
}

// SystemStoragePoolKey defines a struct used to provide an encryption key when importing an existing pool.
// Currently the only supported type is "zfs".
//
// swagger:model
type SystemStoragePoolKey struct {
	Name          string `json:"name"           yaml:"name"`
	Type          string `json:"type"           yaml:"type"`
	EncryptionKey string `json:"encryption_key" yaml:"encryption_key"`
}
