f2b/cmd/ip_command_pattern.go

// Package cmd provides command pattern abstractions to reduce code duplication.
// This module handles common patterns for IP-based operations (ban/unban) that
// share identical structure but different processing functions.
package cmd

import (
	"context"
	"fmt"

	"github.com/spf13/cobra"

	"github.com/ivuorinen/f2b/fail2ban"
	"github.com/ivuorinen/f2b/shared"
)

// IPOperationProcessor defines the interface for processing IP-based operations
type IPOperationProcessor interface {
	// ProcessSingle processes a single jail operation
	ProcessSingle(ctx context.Context, client fail2ban.Client, ip string, jails []string) ([]OperationResult, error)
	// ProcessParallel processes multiple jails in parallel
	ProcessParallel(ctx context.Context, client fail2ban.Client, ip string, jails []string) ([]OperationResult, error)
}

// IPCommandConfig holds configuration for IP-based commands
type IPCommandConfig struct {
	CommandName   string   // e.g., "ban", "unban"
	Usage         string   // e.g., "ban <ip> [jail]"
	Description   string   // e.g., "Ban an IP address"
	Aliases       []string // e.g., ["banip", "b"]
	OperationName string   // e.g., "ban_command", "unban_command"
	Processor     IPOperationProcessor
}

// resolveOutputFormat determines the final output format from config and command flags
func resolveOutputFormat(config *Config, cmd *cobra.Command) string {
	finalFormat := ""
	if config != nil {
		finalFormat = config.Format
	}
	format, _ := cmd.Flags().GetString(shared.FlagFormat)
	if format != "" {
		finalFormat = format
	}
	return finalFormat
}

// outputOperationResults outputs the operation results in the specified format
func outputOperationResults(cmd *cobra.Command, results []OperationResult, config *Config, format string) error {
	if format == JSONFormat {
		OutputResults(cmd, results, config)
		return nil
	}

	for _, r := range results {
		if _, err := fmt.Fprintf(GetCmdOutput(cmd), "%s %s in %s\n", r.Status, r.IP, r.Jail); err != nil {
			return err
		}
	}
	return nil
}

// processIPOperation handles the parallel vs single processing logic
func processIPOperation(
	ctx context.Context,
	config *Config,
	processor IPOperationProcessor,
	client fail2ban.Client,
	ip string,
	jails []string,
) ([]OperationResult, error) {
	if len(jails) > 1 {
		// Use parallel timeout for multi-jail operations
		parallelCtx, parallelCancel := context.WithTimeout(ctx, config.ParallelTimeout)
		defer parallelCancel()
		return processor.ProcessParallel(parallelCtx, client, ip, jails)
	}
	return processor.ProcessSingle(ctx, client, ip, jails)
}

// ExecuteIPCommand provides a unified execution pattern for IP-based commands
func ExecuteIPCommand(
	client fail2ban.Client,
	config *Config,
	cmdConfig IPCommandConfig,
) func(*cobra.Command, []string) error {
	return func(cmd *cobra.Command, args []string) error {
		// Get the contextual logger
		logger := GetContextualLogger()

		// Create timeout context for the entire operation
		// Use cmd.Context() to inherit Cobra's signal cancellation
		ctx, cancel := createTimeoutContext(cmd.Context(), config)
		defer cancel()

		// Add command context
		ctx = WithCommand(ctx, cmdConfig.CommandName)

		// Log operation with timing
		return logger.LogOperation(ctx, cmdConfig.OperationName, func() error {
			// Validate IP argument
			ip, err := ValidateIPArgumentWithContext(ctx, args)
			if err != nil {
				return HandleValidationError(err)
			}

			// Add IP to context
			ctx = WithIP(ctx, ip)

			// Get jails from arguments or client (with timeout context)
			jails, err := GetJailsFromArgsWithContext(ctx, client, args, 1)
			if err != nil {
				return HandleClientError(err)
			}

			// Process operation with timeout context
			results, err := processIPOperation(ctx, config, cmdConfig.Processor, client, ip, jails)
			if err != nil {
				return HandleClientError(err)
			}

			// Output results in the appropriate format
			finalFormat := resolveOutputFormat(config, cmd)
			return outputOperationResults(cmd, results, config, finalFormat)
		})
	}
}

// NewIPCommand creates a new IP-based command using the unified pattern
func NewIPCommand(client fail2ban.Client, config *Config, cmdConfig IPCommandConfig) *cobra.Command {
	return NewCommand(
		cmdConfig.Usage,
		cmdConfig.Description,
		cmdConfig.Aliases,
		ExecuteIPCommand(client, config, cmdConfig),
	)
}