add FILE_LIST_SCAN_ENABLED to opt out of the file name check

Author: vedhavyas

README.md

@@ -306,6 +306,7 @@ Configure either SABnzbd or NZBGet for NZB downloads. If both are configured, SA
 | `IMPORT_HARDLINK_FALLBACK` | `error` | What a hardlink import does when source and library are on different filesystems: `error`, `copy`, `symlink`, `move` |
 | `REMOVE_TORRENT_AFTER_IMPORT` | `false` | Remove the torrent from the client once imported (never deletes the data under a source-preserving mode) |
 | `EXTRACT_ARCHIVES` | `false` | Auto-extract downloaded archives |
+| `FILE_LIST_SCAN_ENABLED` | `true` | Block a download whose file names carry a dangerous extension. Set `false` if your sources legitimately ship `.bat`/`.cmd` next to the payload |
 | `MAX_RETRIES` | `2` | Download retry attempts |
 | `RETRY_BACKOFF_SECONDS` | `60` | Seconds between retries |
 

internal/config/config.go

@@ -42,6 +42,9 @@ type Config struct {
 	ClamAVSocket    string
 	DockerSocket    string
 
+	// FileListScanEnabled gates the pre-download file name check.
+	FileListScanEnabled bool
+
 	// Import behavior. ImportMode decides whether a finished download is
 	// moved into the library or preserved in place (hardlink/symlink/copy)
 	// so a torrent can keep seeding. ImportHardlinkFallback applies when a
@@ -174,6 +177,8 @@ func Load() *Config {
 		ClamAVSocket:    envStr("CLAMAV_SOCKET", "/run/clamav/clamd.sock"),
 		DockerSocket:    envStr("DOCKER_SOCKET", "/var/run/docker.sock"),
 
+		FileListScanEnabled: envBool("FILE_LIST_SCAN_ENABLED", true),
+
 		ImportMode:             envImportMode("IMPORT_MODE"),
 		ImportHardlinkFallback: envHardlinkFallback("IMPORT_HARDLINK_FALLBACK"),
 

internal/config/config_test.go

@@ -264,3 +264,15 @@ func TestEnvInt(t *testing.T) {
 		t.Errorf("got %d, want fallback 7", got)
 	}
 }
+
+func TestFileListScanEnabled(t *testing.T) {
+	if !Load().FileListScanEnabled {
+		t.Error("FileListScanEnabled should default to true")
+	}
+
+	os.Setenv("FILE_LIST_SCAN_ENABLED", "false")
+	defer os.Unsetenv("FILE_LIST_SCAN_ENABLED")
+	if Load().FileListScanEnabled {
+		t.Error("FILE_LIST_SCAN_ENABLED=false should turn the scan off")
+	}
+}

internal/download/helpers_test.go

@@ -40,6 +40,9 @@ func newTestConfig(t *testing.T) *config.Config {
 		ClamAVSocket:    filepath.Join(base, "no-such-clamav.sock"),
 		DockerSocket:    filepath.Join(base, "no-such-docker.sock"),
 		MaxRetries:      2,
+		// Mirrors the production default. A zero value here would silently
+		// disable the scan for every test in this package.
+		FileListScanEnabled: true,
 	}
 }
 

internal/download/manager.go

@@ -223,7 +223,7 @@ func (m *Manager) watchGameTorrent(jobID, title, platf, platSlug string, isPC bo
 			}
 
 			// Layer 1: scan file list once metadata is available
-			if !fileScanDone && t.Progress > 0 {
+			if m.cfg.FileListScanEnabled && !fileScanDone && t.Progress > 0 {
 				m.jobs.Update(jobID, "detail", "Scanning file list...")
 				isSafe, issues := safety.ScanTorrentFileList(m.qb, t.Hash)
 				fileScanDone = true

internal/download/manager_test.go

@@ -963,3 +963,41 @@ func TestMaybeExtractArchives(t *testing.T) {
 		}
 	})
 }
+
+// Some sources legitimately ship a .bat next to the payload, and the operator
+// has no other way past a filename match.
+func TestDownloadTorrentFileListScanDisabled(t *testing.T) {
+	cfg := newTestConfig(t)
+	jobs := newTestJobs(t)
+	cfg.QBURL = "configured"
+	cfg.FileListScanEnabled = false
+
+	qm := newQbitMock(t)
+	qm.setFiles([]qbit.TorrentFile{{Name: "Game/keygen.bat"}, {Name: "Game/setup.scr"}})
+	qm.setTorrents([]qbit.Torrent{{
+		Name:     "Repack Game",
+		Hash:     "hash-optout",
+		Progress: 0.5, // metadata available, still downloading
+	}})
+
+	m := New(cfg, jobs, qm.client())
+	jobID, err := m.DownloadTorrent("magnet:x", "Repack Game", "PC", "", true)
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+
+	// With the scan on, the watcher acts on its first pass, so a short wait is
+	// enough to catch it having done so.
+	deadline := time.Now().Add(3 * time.Second)
+	for time.Now().Before(deadline) {
+		if len(qm.deleteCalls()) != 0 {
+			t.Fatalf("torrent was acted on despite the scan being disabled: %+v", qm.deleteCalls())
+		}
+		if job, ok := jobs.Get(jobID); ok {
+			if status, _ := job["status"].(string); status == "error" {
+				t.Fatalf("job errored despite the scan being disabled: %v", job["error"])
+			}
+		}
+		time.Sleep(100 * time.Millisecond)
+	}
+}