transx

type BucketInfo struct {
	Name        string       `xml:"Name"`
	Prefix      string       `xml:"Prefix"`
	Marker      string       `xml:"Marker"`
	MaxKeys     int          `xml:"MaxKeys"`
	IsTruncated bool         `xml:"IsTruncated"`
	Contents    []ObjectInfo `xml:"Contents"`
}

type DataMigrationModel struct {
	Source                     EndpointDetails  `json:"source" validate:"required"`                     // Source endpoint configuration
	SourceTransferOptions      *TransferOptions `json:"sourceTransferOptions" validate:"required"`      // Source-specific transfer options
	Destination                EndpointDetails  `json:"destination" validate:"required"`                // Destination endpoint configuration
	DestinationTransferOptions *TransferOptions `json:"destinationTransferOptions" validate:"required"` // Destination-specific transfer options
}

type EndpointDetails struct {
	// Endpoint configuration (auto-detects protocol based on provided fields)
	Endpoint string `json:"endpoint,omitempty"` // SSH host/IP or Object Storage API endpoint (e.g., "server.com", "http://localhost:1024/spider/s3")
	Port     int    `json:"port,omitempty"`     // Port for SSH host/IP (default: 22) or Object Storage API endpoint (default: 1024)

	// Data location (required)
	DataPath string `json:"dataPath" validate:"required"` // Local path, remote path, or Object Storage bucket path (e.g., "/data", "bucket/object-key")

	// Command execution
	BackupCmd  string `json:"backupCmd,omitempty"`  // Backup command string to be executed on this endpoint
	RestoreCmd string `json:"restoreCmd,omitempty"` // Restore command string to be executed on this endpoint
}

type FilterOption struct {
	Include []string `json:"include,omitempty"` // Patterns to include (e.g., "*.txt", "data/**")
	Exclude []string `json:"exclude,omitempty"` // Patterns to exclude (e.g., "*.log", "temp/**", ".git/**")
}

type MigrationError struct {
	Stage string // "backup", "transfer", or "restore"
	Err   error
}

type ObjectInfo struct {
	Key          string `xml:"Key"`
	LastModified string `xml:"LastModified"`
	ETag         string `xml:"ETag"`
	Size         int64  `xml:"Size"`
	StorageClass string `xml:"StorageClass"`
}

type ObjectStorageOption struct {
	// Client selection
	Client string `json:"client,omitempty" default:"spider"` // Object storage client: "spider" (default) or "minio"

	// Common authentication (REQUIRED - must be provided by user)
	AccessKeyId     string `json:"accessKeyId" validate:"required"`      // AWS Access Key ID or CB-Spider connection name (REQUIRED)
	SecretAccessKey string `json:"secretAccessKey,omitempty"`            // AWS Secret Access Key (REQUIRED for minio client)
	Region          string `json:"region,omitempty" default:"us-east-1"` // AWS region (for minio client, default: "us-east-1")
	UseSSL          bool   `json:"useSSL,omitempty" default:"false"`     // Use HTTPS (default: true)

	// Presigned URL configuration (spider client only)
	ExpiresIn int `json:"expiresIn,omitempty" default:"3600"` // Presigned URL expiration time in seconds (default: 3600)

	// HTTP request configuration (optional)
	Timeout    int `json:"timeout,omitempty" default:"300"`  // HTTP request timeout in seconds (default: 300)
	MaxRetries int `json:"maxRetries,omitempty" default:"3"` // Maximum number of retry attempts (default: 3)

	// File filtering options (applied after listing objects, before upload/download)
	Filter *FilterOption `json:"filter,omitempty"` // File filtering options (include/exclude patterns) - use nested structure for better organization
}

type OperationError struct {
	Operation   string            // "backup", "restore", "transfer"
	Method      string            // transfer method (for transfer operations)
	Source      string            // source path/endpoint
	Destination string            // destination path/endpoint
	Command     string            // executed command (for backup/restore)
	Output      string            // command output (for backup/restore)
	IsRelayMode bool              // relay mode flag (for transfer)
	Context     map[string]string // additional context information
	Err         error             // underlying error
}

type PresignedUrlInfo struct {
	PresignedURL string `xml:"PresignedURL"`
	Expires      int    `xml:"Expires"`
	Method       string `xml:"Method"`
}

type RsyncOption struct {
	// SSH connection & authentication options (integrated)
	Username          string `json:"username,omitempty"`          // SSH username
	SSHPrivateKeyPath string `json:"sshPrivateKeyPath,omitempty"` // SSH private key path

	// InsecureSkipHostKeyVerification, if true, relaxes host key checking for SSH connections.
	// Adds "-o StrictHostKeyChecking=accept-new -o UserKnownHostsFile=/dev/null" options.
	// Warning: This can be a security risk and should only be used in trusted environments.
	InsecureSkipHostKeyVerification bool `json:"insecureSkipHostKeyVerification,omitempty" default:"false"`
	ConnectTimeout                  int  `json:"connectTimeout,omitempty" default:"30"` // SSH connection timeout in seconds

	// Transfer behavior options
	Verbose  bool `json:"verbose,omitempty" default:"false"`  // Enable verbose logging
	DryRun   bool `json:"dryRun,omitempty" default:"false"`   // Perform a trial run with no changes made
	Progress bool `json:"progress,omitempty" default:"false"` // Show progress during transfer

	// Rsync-specific options
	Compress  bool          `json:"compress,omitempty" default:"true"`   // -z, --compress: Compress file data during the transfer
	Archive   bool          `json:"archive,omitempty" default:"true"`    // -a, --archive: Archive mode; equals -rlptgoD (no -H,-A,-X)
	Delete    bool          `json:"delete,omitempty" default:"false"`    // --delete: Delete extraneous files from dest dirs
	RsyncPath string        `json:"rsyncPath,omitempty" default:"rsync"` // Path to the rsync executable (if empty, uses system PATH)
	Filter    *FilterOption `json:"filter,omitempty"`                    // File filtering options (include/exclude patterns) - use nested structure for better organization

	// TransferDirContentsOnly, if true, adds a trailing slash to source paths
	// to transfer only the contents of the directory and not the directory itself.
	TransferDirContentsOnly bool `json:"transferDirContentsOnly,omitempty" default:"false"`
}

type TransferOptions struct {
	// Transfer method specification (required)
	Method string `json:"method" validate:"required"` // Transfer method: "rsync", "object-storage"

	// Rsync-specific options
	RsyncOptions *RsyncOption `json:"rsyncOptions,omitempty"`

	// Object Storage-specific options (CB-Spider, AWS S3, etc.)
	ObjectStorageOptions *ObjectStorageOption `json:"objectStorageOptions,omitempty"`
}