feat: auto extract archives (#1212)

pkg/base/model.go

@@ -2,13 +2,14 @@ package base
 
 import (
 	"fmt"
-	"github.com/GopeedLab/gopeed/pkg/util"
-	"github.com/mattn/go-ieproxy"
-	"golang.org/x/exp/slices"
 	"net/http"
 	"net/url"
 	"sync"
 	"time"
+
+	"github.com/GopeedLab/gopeed/pkg/util"
+	"github.com/mattn/go-ieproxy"
+	"golang.org/x/exp/slices"
 )
 
 // Request download request
@@ -183,6 +184,7 @@ type DownloaderStoreConfig struct {
 	Extra          map[string]any         `json:"extra"`
 	Proxy          *DownloaderProxyConfig `json:"proxy"`
 	Webhook        *WebhookConfig         `json:"webhook"` // Webhook is the webhook configuration
+	Archive        *ArchiveConfig         `json:"archive"` // Archive is the archive extraction configuration
 }
 
 func (cfg *DownloaderStoreConfig) Init() *DownloaderStoreConfig {
@@ -198,6 +200,12 @@ func (cfg *DownloaderStoreConfig) Init() *DownloaderStoreConfig {
 	if cfg.Webhook == nil {
 		cfg.Webhook = &WebhookConfig{}
 	}
+	if cfg.Archive == nil {
+		cfg.Archive = &ArchiveConfig{
+			AutoExtract:        false,
+			DeleteAfterExtract: false,
+		}
+	}
 	return cfg
 }
 
@@ -223,6 +231,9 @@ func (cfg *DownloaderStoreConfig) Merge(beforeCfg *DownloaderStoreConfig) *Downl
 	if cfg.Webhook == nil {
 		cfg.Webhook = beforeCfg.Webhook
 	}
+	if cfg.Archive == nil {
+		cfg.Archive = beforeCfg.Archive
+	}
 	return cfg
 }
 
@@ -232,6 +243,12 @@ type WebhookConfig struct {
 	URLs   []string `json:"urls"`   // URLs is the list of webhook URLs
 }
 
+// ArchiveConfig is the archive extraction configuration
+type ArchiveConfig struct {
+	AutoExtract        bool `json:"autoExtract"`        // AutoExtract enables automatic extraction of archives after download
+	DeleteAfterExtract bool `json:"deleteAfterExtract"` // DeleteAfterExtract deletes the archive after successful extraction
+}
+
 type DownloaderProxyConfig struct {
 	Enable bool `json:"enable"`
 	// System is the flag that use system proxy

pkg/base/model_test.go

@@ -19,6 +19,10 @@ func TestDownloaderStoreConfig_Init(t *testing.T) {
 				ProtocolConfig: map[string]any{},
 				Proxy:          &DownloaderProxyConfig{},
 				Webhook:        &WebhookConfig{},
+				Archive: &ArchiveConfig{
+					AutoExtract:        false,
+					DeleteAfterExtract: false,
+				},
 			},
 		},
 		{
@@ -31,6 +35,10 @@ func TestDownloaderStoreConfig_Init(t *testing.T) {
 				ProtocolConfig: map[string]any{},
 				Proxy:          &DownloaderProxyConfig{},
 				Webhook:        &WebhookConfig{},
+				Archive: &ArchiveConfig{
+					AutoExtract:        false,
+					DeleteAfterExtract: false,
+				},
 			},
 		},
 		{
@@ -47,6 +55,10 @@ func TestDownloaderStoreConfig_Init(t *testing.T) {
 				},
 				Proxy:   &DownloaderProxyConfig{},
 				Webhook: &WebhookConfig{},
+				Archive: &ArchiveConfig{
+					AutoExtract:        false,
+					DeleteAfterExtract: false,
+				},
 			},
 		},
 		{
@@ -63,6 +75,29 @@ func TestDownloaderStoreConfig_Init(t *testing.T) {
 					Enable: true,
 				},
 				Webhook: &WebhookConfig{},
+				Archive: &ArchiveConfig{
+					AutoExtract:        false,
+					DeleteAfterExtract: false,
+				},
+			},
+		},
+		{
+			"Init Archive",
+			&DownloaderStoreConfig{
+				Archive: &ArchiveConfig{
+					AutoExtract:        true,
+					DeleteAfterExtract: false,
+				},
+			},
+			&DownloaderStoreConfig{
+				MaxRunning:     5,
+				ProtocolConfig: map[string]any{},
+				Proxy:          &DownloaderProxyConfig{},
+				Webhook:        &WebhookConfig{},
+				Archive: &ArchiveConfig{
+					AutoExtract:        true,
+					DeleteAfterExtract: false,
+				},
 			},
 		},
 	}
@@ -76,6 +111,7 @@ func TestDownloaderStoreConfig_Init(t *testing.T) {
 				Extra:          tt.fields.Extra,
 				Proxy:          tt.fields.Proxy,
 				Webhook:        tt.fields.Webhook,
+				Archive:        tt.fields.Archive,
 			}
 			if got := cfg.Init(); !reflect.DeepEqual(got, tt.want) {
 				t.Errorf("Init() = %v, want %v", got, tt.want)
@@ -250,6 +286,45 @@ func TestDownloaderStoreConfig_Merge(t *testing.T) {
 				},
 			},
 		},
+		{
+			"Merge Archive No Override",
+			&DownloaderStoreConfig{
+				Archive: &ArchiveConfig{
+					AutoExtract: true,
+				},
+			},
+			args{
+				beforeCfg: &DownloaderStoreConfig{
+					Archive: &ArchiveConfig{
+						AutoExtract:        false,
+						DeleteAfterExtract: false,
+					},
+				},
+			},
+			&DownloaderStoreConfig{
+				Archive: &ArchiveConfig{
+					AutoExtract: true,
+				},
+			},
+		},
+		{
+			"Merge Archive Override",
+			&DownloaderStoreConfig{},
+			args{
+				beforeCfg: &DownloaderStoreConfig{
+					Archive: &ArchiveConfig{
+						AutoExtract:        false,
+						DeleteAfterExtract: false,
+					},
+				},
+			},
+			&DownloaderStoreConfig{
+				Archive: &ArchiveConfig{
+					AutoExtract:        false,
+					DeleteAfterExtract: false,
+				},
+			},
+		},
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
@@ -261,6 +336,7 @@ func TestDownloaderStoreConfig_Merge(t *testing.T) {
 				Extra:          tt.fields.Extra,
 				Proxy:          tt.fields.Proxy,
 				Webhook:        tt.fields.Webhook,
+				Archive:        tt.fields.Archive,
 			}
 			if got := cfg.Merge(tt.args.beforeCfg); !reflect.DeepEqual(got, tt.want) {
 				t.Errorf("Merge() = %v, want %v", got, tt.want)