internal

type IsMountPointRequest struct {
	Path string
}

type IsMountPointResponse struct {
	Error        string
	IsMountPoint bool
}

type LinkPathRequest struct {
	// The path where the symlink is created in the host's filesystem.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// source_path cannot already exist in the host filesystem.
	// Maximum path length will be capped to 260 characters.
	SourcePath string
	// Target path in the host's filesystem used for the symlink creation.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// target_path needs to exist as a directory in the host that is empty.
	// target_path cannot be a symbolic link.
	// Maximum path length will be capped to 260 characters.
	TargetPath string
}

type LinkPathResponse struct {
	// Error message if any. Empty string indicates success
	Error string
}

type MkdirRequest struct {
	// The path to create in the host's filesystem.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	// Non-existent parent directories in the path will be automatically created.
	// Directories will be created with Read and Write privileges of the Windows
	// User account under which csi-proxy is started (typically LocalSystem).
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// Depending on the context parameter of this function, the path prefix needs
	// to match the paths specified either as kubelet-csi-plugins-path
	// or as kubelet-pod-path parameters of csi-proxy.
	// The path parameter cannot already exist on host filesystem.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// Maximum path length will be capped to 260 characters.
	Path string
	// Context of the path parameter.
	// This is used to [1] determine the root for relative path parameters
	// or [2] validate prefix for absolute paths (indicated by a drive letter
	// prefix: e.g. "C:\")
	Context PathContext
}

type MkdirResponse struct {
	// Error message if any. Empty string indicates success
	Error string
}

type PathContext int32

type PathExistsRequest struct {
	// The path whose existence we want to check in the host's filesystem
	Path string
	// Context of the path parameter.
	// This is used to determine the root for relative path parameters
	Context PathContext
}

type PathExistsResponse struct {
	// Error message if any. Empty string indicates success
	Error string
	// Indicates whether the path in PathExistsRequest exists in the host's filesystem
	Exists bool
}

type RmdirRequest struct {
	// The path to remove in the host's filesystem.
	// All special characters allowed by Windows in path names will be allowed
	// except for restrictions noted below. For details, please check:
	// https://docs.microsoft.com/en-us/windows/win32/fileio/naming-a-file
	//
	// Restrictions:
	// Only absolute path (indicated by a drive letter prefix: e.g. "C:\") is accepted.
	// Depending on the context parameter of this function, the path prefix needs
	// to match the paths specified either as kubelet-csi-plugins-path
	// or as kubelet-pod-path parameters of csi-proxy.
	// UNC paths of the form "\\server\share\path\file" are not allowed.
	// All directory separators need to be backslash character: "\".
	// Characters: .. / : | ? * in the path are not allowed.
	// Path cannot be a file of type symlink.
	// Maximum path length will be capped to 260 characters.
	Path string
	// Context of the path creation used for path prefix validation
	// This is used to [1] determine the root for relative path parameters
	// or [2] validate prefix for absolute paths (indicated by a drive letter
	// prefix: e.g. "C:\")
	Context PathContext
	// Force remove all contents under path (if any).
	Force bool
}

type RmdirResponse struct {
	// Error message if any. Empty string indicates success
	Error string
}

type ServerInterface interface {
	IsMountPoint(context.Context, *IsMountPointRequest, apiversion.Version) (*IsMountPointResponse, error)
	LinkPath(context.Context, *LinkPathRequest, apiversion.Version) (*LinkPathResponse, error)
	Mkdir(context.Context, *MkdirRequest, apiversion.Version) (*MkdirResponse, error)
	PathExists(context.Context, *PathExistsRequest, apiversion.Version) (*PathExistsResponse, error)
	Rmdir(context.Context, *RmdirRequest, apiversion.Version) (*RmdirResponse, error)
}

type VersionedAPI interface {
	Register(grpcServer *grpc.Server)
}