explorers

type Container struct {
	Namespace        string
	Hostname         string
	ImageBase        string
	SupportContainer bool
	ContainerType    string
	ProcessID        int
	Status           string

	// containerd specific fields
	containers.Container

	// docker specific fields
	Running      bool
	ExposedPorts []string
}

type ContainerExplorer interface {
	// Close releases the internal resources
	Close() error

	// ContainerDrift identifies container filesystem changes
	ContainerDrift(ctx context.Context, filter string, skipsupportcontainers bool, containerID string) ([]Drift, error)

	// ExportAllContainers exports all Docker and containerd containers.
	ExportAllContainers(ctx context.Context, outputDir string, exportOption map[string]bool, filter map[string]string, exportSupportContainers bool) error

	// ExportContainer exports a container as an image or archive.
	ExportContainer(ctx context.Context, containerID string, outputDir string, exportOption map[string]bool) error

	// InfoContainer returns container internal information
	InfoContainer(ctx context.Context, containerid string, spec bool) (interface{}, error)

	// ListContainers returns all the containers in all the namespaces.
	//
	// ListContainers returns the ContainerExplorer's Containers structure
	// that holds additional information about the containers.
	ListContainers(ctx context.Context) ([]Container, error)

	// ListContent returns information about content
	ListContent(ctx context.Context) ([]Content, error)

	// ListImages returns content information
	ListImages(ctx context.Context) ([]Image, error)

	// ListNamespaces returns all the namespaces in the metadata file i.e.
	// meta.db
	ListNamespaces(ctx context.Context) ([]string, error)

	// ListSnapshots returns the snapshot information
	ListSnapshots(ctx context.Context) ([]SnapshotKeyInfo, error)

	// ListTasks returns the container task status
	ListTasks(ctx context.Context) ([]Task, error)

	// MountAllContainer mounts all containers to the specfied path
	MountAllContainers(ctx context.Context, mountpoint string, filter string, skipsupportcontainers bool) error

	// MountContainer mounts a container to the specified path
	MountContainer(ctx context.Context, containerid string, mountpoint string) error

	// SnapshotRoot returns the directory containing snapshots and snapshot
	// database i.e. metadata.db
	//
	// SnapshotRoot is required for the containers managed using containerd.
	SnapshotRoot(snapshotter string) string
}

type Content struct {
	Namespace string
	content.Info
}

type Drift struct {
	ContainerID       string
	ContainerType     string
	AddedOrModified   []FileInfo
	InaccessibleFiles []FileInfo
}

type FileInfo struct {
	FileName     string    `json:"file_name"`
	FullPath     string    `json:"full_path"`
	FileSize     int64     `json:"file_size"`
	FileModified time.Time `json:"file_modified"`
	FileAccessed time.Time `json:"file_accessed"`
	FileChanged  time.Time `json:"file_changed"`
	FileBirth    time.Time `json:"file_birth"`
	FileUid      string    `json:"file_uid,omitempty"`
	FileOwner    string    `json:"file_owner,omitempty"`
	FileGid      string    `json:"file_gid,omitempty"`
	FileType     string    `json:"file_type,omitempty"`
	FileSHA256   string    `json:"file_sha256,omitempty"`
}

type Image struct {
	Namespace             string
	SupportContainerImage bool
	images.Image
}

type SnapshotKeyInfo struct {
	Namespace   string            // namespace only used in meta.db
	Snapshotter string            // only used in meta.db
	Key         string            // snapshot key
	ID          uint64            // File system ID. Only used in metadata.db
	Name        string            // snapshot name. Only used in meta.db
	Parent      string            // snapshot parent
	Kind        snapshots.Kind    // snapshot kind
	Inodes      []int64           // Inode numbers. Only in metadata.db
	Size        uint64            // Only in metadata.db
	OverlayPath string            // Custom field added by container explorer
	Labels      map[string]string // mapped labels
	Children    []string          // array of <snapshot key>. Only in meta.db
	CreatedAt   time.Time         // created timestamp
	UpdatedAt   time.Time         // updated timestamp
}

type State struct {
	ID                  string                 `json:"state,omitempty"`
	InitProcessPid      int                    `json:"init_process_pid"`
	InitProcessstart    int                    `json:"init_process_start"`
	Created             time.Time              `json:"created"`
	Config              map[string]interface{} `json:"config"`
	Rootless            bool                   `json:"rootless"`
	CgroupPaths         map[string]string      `json:"cgroup_paths"`
	NamespacePaths      map[string]string      `json:"namespace_paths"`
	ExternalDescriptors []string               `json:"external_descriptors"`
	IntelRdtPath        string                 `json:"intel_rdt_path"`
}

type SupportContainer struct {
	ContainerNames []string `json:"names" yaml:"names"`
	ImageNames     []string `json:"images" yaml:"images"`
	Labels         []string `json:"labels" yaml:"labels"`
}

type Task struct {
	Namespace     string
	Name          string
	PID           int
	ContainerType string
	Status        string
}