'MapHardlinksFor' filter config option

cmd/clean.go

@@ -12,6 +12,7 @@ import (
 	"github.com/l3uddz/tqm/expression"
 	"github.com/l3uddz/tqm/hardlinkfilemap"
 	"github.com/l3uddz/tqm/logger"
+	"github.com/l3uddz/tqm/sliceutils"
 	"github.com/l3uddz/tqm/torrentfilemap"
 	"github.com/l3uddz/tqm/tracker"
 )
@@ -118,24 +119,31 @@ var cleanCmd = &cobra.Command{
 		tfm := torrentfilemap.New(torrents)
 		log.Infof("Mapped torrents to %d unique torrent files", tfm.Length())
 
-		// download path mapping
-		clientDownloadPathMapping, err := getClientDownloadPathMapping(clientConfig)
-		if err != nil {
-			log.WithError(err).Fatal("Failed loading client download path mappings")
-		} else if clientDownloadPathMapping != nil {
-			log.Debugf("Loaded %d client download path mappings: %#v", len(clientDownloadPathMapping),
-				clientDownloadPathMapping)
-		}
+		var hfm hardlinkfilemap.HardlinkFileMapI
+		if sliceutils.StringSliceContains(clientFilter.MapHardlinksFor, "clean", true) {
+			// download path mapping
+			clientDownloadPathMapping, err := getClientDownloadPathMapping(clientConfig)
+			if err != nil {
+				log.WithError(err).Fatal("Failed loading client download path mappings")
+			} else if clientDownloadPathMapping != nil {
+				log.Debugf("Loaded %d client download path mappings: %#v", len(clientDownloadPathMapping),
+					clientDownloadPathMapping)
+			}
 
-		// create map of paths associated to underlying file ids
-		start := time.Now()
-		hfm := hardlinkfilemap.New(torrents, clientDownloadPathMapping)
-		log.Infof("Mapped all torrent file paths to %d unique underlying file IDs in %s", hfm.Length(), time.Since(start))
+			// create map of paths associated to underlying file ids
+			start := time.Now()
+			hfm = hardlinkfilemap.New(torrents, clientDownloadPathMapping)
+			log.Infof("Mapped all torrent file paths to %d unique underlying file IDs in %s", hfm.Length(), time.Since(start))
 
-		// add HardlinkedOutsideClient field to torrents
-		for h, t := range torrents {
-			t.HardlinkedOutsideClient = hfm.HardlinkedOutsideClient(t)
-			torrents[h] = t
+			// add HardlinkedOutsideClient field to torrents
+			for h, t := range torrents {
+				t.HardlinkedOutsideClient = hfm.HardlinkedOutsideClient(t)
+				torrents[h] = t
+			}
+		} else {
+			log.Warnf("Not mapping hardlinks for client %q", clientName)
+			log.Warnf("If your setup involves multiple torrents sharing the same underlying file using hardlinks, or you are using the 'HardlinkedOutsideClient' field in your filters, you should add 'clean' to the 'MapHardlinksFor' field in your filter configuration")
+			hfm = hardlinkfilemap.NewNoopHardlinkFileMap()
 		}
 
 		// remove torrents that are not ignored and match remove criteria

cmd/helpers.go

@@ -25,8 +25,7 @@ func removeSlice(slice []string, remove []string) []string {
 }
 
 // retag torrent that meet required filters
-func retagEligibleTorrents(log *logrus.Entry, c client.TagInterface, torrents map[string]config.Torrent,
-	tfm *torrentfilemap.TorrentFileMap) error {
+func retagEligibleTorrents(log *logrus.Entry, c client.TagInterface, torrents map[string]config.Torrent) error {
 	// vars
 	ignoredTorrents := 0
 	retaggedTorrents := 0
@@ -154,7 +153,7 @@ func relabelEligibleTorrents(log *logrus.Entry, c client.Interface, torrents map
 
 // remove torrents that meet remove filters
 func removeEligibleTorrents(log *logrus.Entry, c client.Interface, torrents map[string]config.Torrent,
-	tfm *torrentfilemap.TorrentFileMap, hfm *hardlinkfilemap.HardlinkFileMap) error {
+	tfm *torrentfilemap.TorrentFileMap, hfm hardlinkfilemap.HardlinkFileMapI) error {
 	// vars
 	ignoredTorrents := 0
 	hardRemoveTorrents := 0

cmd/relabel.go

@@ -12,6 +12,7 @@ import (
 	"github.com/l3uddz/tqm/expression"
 	"github.com/l3uddz/tqm/hardlinkfilemap"
 	"github.com/l3uddz/tqm/logger"
+	"github.com/l3uddz/tqm/sliceutils"
 	"github.com/l3uddz/tqm/torrentfilemap"
 	"github.com/l3uddz/tqm/tracker"
 )
@@ -118,23 +119,28 @@ var relabelCmd = &cobra.Command{
 		tfm := torrentfilemap.New(torrents)
 		log.Infof("Mapped torrents to %d unique torrent files", tfm.Length())
 
-		// download path mapping
-		clientDownloadPathMapping, err := getClientDownloadPathMapping(clientConfig)
-		if err != nil {
-			log.WithError(err).Fatal("Failed loading client download path mappings")
-		} else if clientDownloadPathMapping != nil {
-			log.Debugf("Loaded %d client download path mappings: %#v", len(clientDownloadPathMapping),
-				clientDownloadPathMapping)
-		}
+		if sliceutils.StringSliceContains(clientFilter.MapHardlinksFor, "relabel", true) {
+			// download path mapping
+			clientDownloadPathMapping, err := getClientDownloadPathMapping(clientConfig)
+			if err != nil {
+				log.WithError(err).Fatal("Failed loading client download path mappings")
+			} else if clientDownloadPathMapping != nil {
+				log.Debugf("Loaded %d client download path mappings: %#v", len(clientDownloadPathMapping),
+					clientDownloadPathMapping)
+			}
 
-		// create map of paths associated to underlying file ids
-		start := time.Now()
-		hfm := hardlinkfilemap.New(torrents, clientDownloadPathMapping)
-		log.Infof("Mapped all torrent file paths to %d unique underlying file IDs in %s", hfm.Length(), time.Since(start))
+			// create map of paths associated to underlying file ids
+			start := time.Now()
+			hfm := hardlinkfilemap.New(torrents, clientDownloadPathMapping)
+			log.Infof("Mapped all torrent file paths to %d unique underlying file IDs in %s", hfm.Length(), time.Since(start))
 
-		// add HardlinkedOutsideClient field to torrents
-		for _, t := range torrents {
-			t.HardlinkedOutsideClient = hfm.HardlinkedOutsideClient(t)
+			// add HardlinkedOutsideClient field to torrents
+			for _, t := range torrents {
+				t.HardlinkedOutsideClient = hfm.HardlinkedOutsideClient(t)
+			}
+		} else {
+			log.Warnf("Not mapping hardlinks for client %q", clientName)
+			log.Warnf("If your setup involves multiple torrents sharing the same underlying file using hardlinks, or you are using the 'HardlinkedOutsideClient' field in your filters, you should add 'relabel' to the 'MapHardlinksFor' field in your filter configuration")
 		}
 
 		// relabel torrents that meet the filter criteria

cmd/retag.go

@@ -12,7 +12,7 @@ import (
 	"github.com/l3uddz/tqm/expression"
 	"github.com/l3uddz/tqm/hardlinkfilemap"
 	"github.com/l3uddz/tqm/logger"
-	"github.com/l3uddz/tqm/torrentfilemap"
+	"github.com/l3uddz/tqm/sliceutils"
 	"github.com/l3uddz/tqm/tracker"
 )
 
@@ -124,27 +124,28 @@ var retagCmd = &cobra.Command{
 			}
 		}
 
-		// create map of files associated to torrents (via hash)
-		tfm := torrentfilemap.New(torrents)
-		log.Infof("Mapped torrents to %d unique torrent files", tfm.Length())
-
-		// download path mapping
-		clientDownloadPathMapping, err := getClientDownloadPathMapping(clientConfig)
-		if err != nil {
-			log.WithError(err).Fatal("Failed loading client download path mappings")
-		} else if clientDownloadPathMapping != nil {
-			log.Debugf("Loaded %d client download path mappings: %#v", len(clientDownloadPathMapping),
-				clientDownloadPathMapping)
-		}
+		if sliceutils.StringSliceContains(clientFilter.MapHardlinksFor, "retag", true) {
+			// download path mapping
+			clientDownloadPathMapping, err := getClientDownloadPathMapping(clientConfig)
+			if err != nil {
+				log.WithError(err).Fatal("Failed loading client download path mappings")
+			} else if clientDownloadPathMapping != nil {
+				log.Debugf("Loaded %d client download path mappings: %#v", len(clientDownloadPathMapping),
+					clientDownloadPathMapping)
+			}
 
-		// create map of paths associated to underlying file ids
-		start := time.Now()
-		hfm := hardlinkfilemap.New(torrents, clientDownloadPathMapping)
-		log.Infof("Mapped all torrent file paths to %d unique underlying file IDs in %s", hfm.Length(), time.Since(start))
+			// create map of paths associated to underlying file ids
+			start := time.Now()
+			hfm := hardlinkfilemap.New(torrents, clientDownloadPathMapping)
+			log.Infof("Mapped all torrent file paths to %d unique underlying file IDs in %s", hfm.Length(), time.Since(start))
 
-		// add HardlinkedOutsideClient field to torrents
-		for _, t := range torrents {
-			t.HardlinkedOutsideClient = hfm.HardlinkedOutsideClient(t)
+			// add HardlinkedOutsideClient field to torrents
+			for _, t := range torrents {
+				t.HardlinkedOutsideClient = hfm.HardlinkedOutsideClient(t)
+			}
+		} else {
+			log.Warnf("Not mapping hardlinks for client %q", clientName)
+			log.Warnf("If your setup involves multiple torrents sharing the same underlying file using hardlinks, or you are using the 'HardlinkedOutsideClient' field in your filters, you should add 'retag' to the 'MapHardlinksFor' field in your filter configuration")
 		}
 
 		// Verify tags exist on client
@@ -159,7 +160,7 @@ var retagCmd = &cobra.Command{
 		}
 
 		// relabel torrents that meet the filter criteria
-		if err := retagEligibleTorrents(log, ct, torrents, tfm); err != nil {
+		if err := retagEligibleTorrents(log, ct, torrents); err != nil {
 			log.WithError(err).Fatal("Failed retagging eligible torrents...")
 		}
 	},

config/filter.go

@@ -1,9 +1,10 @@
 package config
 
 type FilterConfiguration struct {
-	Ignore []string
-	Remove []string
-	Label  []struct {
+	MapHardlinksFor []string
+	Ignore          []string
+	Remove          []string
+	Label           []struct {
 		Name   string
 		Update []string
 	}

hardlinkfilemap/hardlinkfilemap.go

@@ -9,7 +9,7 @@ import (
 	"github.com/scylladb/go-set/strset"
 )
 
-func New(torrents map[string]config.Torrent, torrentPathMapping map[string]string) *HardlinkFileMap {
+func New(torrents map[string]config.Torrent, torrentPathMapping map[string]string) HardlinkFileMapI {
 	tfm := &HardlinkFileMap{
 		hardlinkFileMap:    make(map[string]*strset.Set),
 		log:                logger.GetLogger("hardlinkfilemap"),
@@ -23,7 +23,7 @@ func New(torrents map[string]config.Torrent, torrentPathMapping map[string]strin
 	return tfm
 }
 
-func (t *HardlinkFileMap) ConsiderPathMapping(path string) string {
+func (t *HardlinkFileMap) considerPathMapping(path string) string {
 	for mapFrom, mapTo := range t.torrentPathMapping {
 		if strings.HasPrefix(path, mapFrom) {
 			return strings.Replace(path, mapFrom, mapTo, 1)
@@ -33,7 +33,7 @@ func (t *HardlinkFileMap) ConsiderPathMapping(path string) string {
 	return path
 }
 
-func (t *HardlinkFileMap) LinkInfoByPath(path string) (string, uint64, bool) {
+func (t *HardlinkFileMap) linkInfoByPath(path string) (string, uint64, bool) {
 	stat, err1 := os.Stat(path)
 	if err1 != nil {
 		t.log.Warnf("Failed to stat file: %s - %s", path, err1)
@@ -51,9 +51,9 @@ func (t *HardlinkFileMap) LinkInfoByPath(path string) (string, uint64, bool) {
 
 func (t *HardlinkFileMap) AddByTorrent(torrent config.Torrent) {
 	for _, f := range torrent.Files {
-		f = t.ConsiderPathMapping(f)
+		f = t.considerPathMapping(f)
 
-		id, _, ok := t.LinkInfoByPath(f)
+		id, _, ok := t.linkInfoByPath(f)
 
 		if !ok {
 			continue
@@ -72,9 +72,9 @@ func (t *HardlinkFileMap) AddByTorrent(torrent config.Torrent) {
 
 func (t *HardlinkFileMap) RemoveByTorrent(torrent config.Torrent) {
 	for _, f := range torrent.Files {
-		f = t.ConsiderPathMapping(f)
+		f = t.considerPathMapping(f)
 
-		id, _, ok := t.LinkInfoByPath(f)
+		id, _, ok := t.linkInfoByPath(f)
 
 		if !ok {
 			continue
@@ -94,9 +94,9 @@ func (t *HardlinkFileMap) RemoveByTorrent(torrent config.Torrent) {
 	}
 }
 
-func (t *HardlinkFileMap) CountLinks(f string) (inmap uint64, total uint64, ok bool) {
-	f = t.ConsiderPathMapping(f)
-	id, nlink, ok := t.LinkInfoByPath(f)
+func (t *HardlinkFileMap) countLinks(f string) (inmap uint64, total uint64, ok bool) {
+	f = t.considerPathMapping(f)
+	id, nlink, ok := t.linkInfoByPath(f)
 
 	if !ok {
 		return 0, 0, false
@@ -111,7 +111,7 @@ func (t *HardlinkFileMap) CountLinks(f string) (inmap uint64, total uint64, ok b
 
 func (t *HardlinkFileMap) HardlinkedOutsideClient(torrent config.Torrent) bool {
 	for _, f := range torrent.Files {
-		inmap, total, ok := t.CountLinks(f)
+		inmap, total, ok := t.countLinks(f)
 		if !ok {
 			continue
 		}
@@ -126,7 +126,7 @@ func (t *HardlinkFileMap) HardlinkedOutsideClient(torrent config.Torrent) bool {
 
 func (t *HardlinkFileMap) IsTorrentUnique(torrent config.Torrent) bool {
 	for _, f := range torrent.Files {
-		c, _, ok := t.CountLinks(f)
+		c, _, ok := t.countLinks(f)
 		if !ok {
 			return false
 		}
@@ -141,7 +141,7 @@ func (t *HardlinkFileMap) IsTorrentUnique(torrent config.Torrent) bool {
 
 func (t *HardlinkFileMap) NoInstances(torrent config.Torrent) bool {
 	for _, f := range torrent.Files {
-		c, _, ok := t.CountLinks(f)
+		c, _, ok := t.countLinks(f)
 		if !ok {
 			return false
 		}

hardlinkfilemap/interface.go

@@ -0,0 +1,12 @@
+package hardlinkfilemap
+
+import "github.com/l3uddz/tqm/config"
+
+type HardlinkFileMapI interface {
+	AddByTorrent(torrent config.Torrent)
+	RemoveByTorrent(torrent config.Torrent)
+	NoInstances(torrent config.Torrent) bool
+	IsTorrentUnique(torrent config.Torrent) bool
+	HardlinkedOutsideClient(torrent config.Torrent) bool
+	Length() int
+}

hardlinkfilemap/noophardllinkfilemap.go

@@ -0,0 +1,32 @@
+package hardlinkfilemap
+
+import "github.com/l3uddz/tqm/config"
+
+type noopHardlinkFileMap struct {
+}
+
+func NewNoopHardlinkFileMap() *noopHardlinkFileMap {
+	return &noopHardlinkFileMap{}
+}
+
+func (h *noopHardlinkFileMap) AddByTorrent(torrent config.Torrent) {
+}
+
+func (h *noopHardlinkFileMap) RemoveByTorrent(torrent config.Torrent) {
+}
+
+func (h *noopHardlinkFileMap) NoInstances(torrent config.Torrent) bool {
+	return true
+}
+
+func (h *noopHardlinkFileMap) IsTorrentUnique(torrent config.Torrent) bool {
+	return true
+}
+
+func (h *noopHardlinkFileMap) HardlinkedOutsideClient(torrent config.Torrent) bool {
+	return false
+}
+
+func (h *noopHardlinkFileMap) Length() int {
+	return 0
+}