feat(create): support include patterns (#51)

* feat(create): support include patterns

* fix readme

Author: s0up4200

README.md

@@ -168,10 +168,18 @@ mkbrr create path/to/file -t https://example-tracker.com/announce -e
 
 # Create a torrent excluding specific file patterns (comma-separated)
 mkbrr create path/to/file -t https://example-tracker.com/announce --exclude "*.nfo,*.jpg"
+
+# Create a torrent including only specific file patterns (comma-separated)
+mkbrr create path/to/video-folder -t https://example-tracker.com/announce --include "*.mkv,*.mp4"
 ```
 
 > [!NOTE]
-> The exclude patterns feature supports standard glob pattern matching (like `*` for any number of characters, `?` for a single character) and is case-insensitive.
+> The exclude and include patterns feature supports standard glob pattern matching (like `*` for any number of characters, `?` for a single character) and is case-insensitive.
+> **Precedence:** Inclusion patterns (`--include`) take precedence.
+> - If `--include` is used:
+>   - A file matching an `--include` pattern is **always kept**, even if it also matches an `--exclude` pattern.
+>   - A file *not* matching any `--include` pattern is **always ignored**.
+> - If `--include` is *not* used, then only `--exclude` patterns are considered, and matching files are ignored.
 
 ### Inspecting Torrents
 
@@ -223,7 +231,7 @@ mkbrr create -P ptp --source "MySource" path/to/file
 ```
 
 > [!TIP]
-> The preset file can be placed in the current directory, `~/.config/mkbrr/`, or `~/.mkbrr/`. You can also specify a custom location with `--preset-file`. Presets support the `exclude_patterns` field, allowing you to define default or preset-specific file exclusions.
+> The preset file can be placed in the current directory, `~/.config/mkbrr/`, or `~/.mkbrr/`. You can also specify a custom location with `--preset-file`. Presets support both `exclude_patterns` and `include_patterns` fields, allowing you to define default or preset-specific file filtering.
 
 ### Batch Mode
 
@@ -236,7 +244,7 @@ mkbrr create -b batch.yaml
 See [batch example](examples/batch.yaml) here.
 
 > [!TIP]
-> Batch mode processes jobs in parallel (up to 4 at once) and shows a summary when complete. Batch mode also support the `exclude_patterns` field.
+> Batch mode processes jobs in parallel (up to 4 at once) and shows a summary when complete. Batch mode also supports both `exclude_patterns` and `include_patterns` fields.
 
 ## Tracker-Specific Features
 

cmd/create.go

@@ -32,6 +32,7 @@ var (
 	quiet             bool
 	skipPrefix        bool
 	excludePatterns   []string
+	includePatterns   []string
 )
 
 var createCmd = &cobra.Command{
@@ -104,7 +105,8 @@ func init() {
 	createCmd.Flags().BoolVarP(&verbose, "verbose", "v", false, "be verbose")
 	createCmd.Flags().BoolVar(&quiet, "quiet", false, "reduced output mode (prints only final torrent path)")
 	createCmd.Flags().BoolVarP(&skipPrefix, "skip-prefix", "", false, "don't add tracker domain prefix to output filename")
-	createCmd.Flags().StringArrayVarP(&excludePatterns, "exclude", "", nil, "exclude files matching these patterns (e.g., \"*.nfo,*.jpg\" or -e \"*.nfo\" -e \"*.jpg\")")
+	createCmd.Flags().StringArrayVarP(&excludePatterns, "exclude", "", nil, "exclude files matching these patterns (e.g., \"*.nfo,*.jpg\" or --exclude \"*.nfo\" --exclude \"*.jpg\")")
+	createCmd.Flags().StringArrayVarP(&includePatterns, "include", "", nil, "include only files matching these patterns (e.g., \"*.mkv,*.mp4\" or --include \"*.mkv\" --include \"*.mp4\")")
 
 	createCmd.Flags().String("cpuprofile", "", "write cpu profile to file (development flag)")
 
@@ -226,11 +228,15 @@ func runCreate(cmd *cobra.Command, args []string) error {
 			Entropy:         entropy,
 			Quiet:           quiet,
 			ExcludePatterns: []string{},
+			IncludePatterns: []string{},
 		}
 
 		if len(presetOpts.ExcludePatterns) > 0 {
 			opts.ExcludePatterns = slices.Clone(presetOpts.ExcludePatterns)
 		}
+		if len(presetOpts.IncludePatterns) > 0 {
+			opts.IncludePatterns = slices.Clone(presetOpts.IncludePatterns)
+		}
 
 		if presetOpts.PieceLength != 0 {
 			pieceLen := presetOpts.PieceLength
@@ -276,6 +282,9 @@ func runCreate(cmd *cobra.Command, args []string) error {
 		if cmd.Flags().Changed("exclude") {
 			opts.ExcludePatterns = append(opts.ExcludePatterns, excludePatterns...)
 		}
+		if cmd.Flags().Changed("include") {
+			opts.IncludePatterns = append(opts.IncludePatterns, includePatterns...)
+		}
 	} else {
 		// use command line options
 		opts = torrent.CreateTorrentOptions{
@@ -295,6 +304,7 @@ func runCreate(cmd *cobra.Command, args []string) error {
 			Quiet:           quiet,
 			SkipPrefix:      skipPrefix,
 			ExcludePatterns: excludePatterns,
+			IncludePatterns: includePatterns,
 		}
 	}
 

examples/batch.yaml

@@ -18,3 +18,7 @@ jobs:
     exclude_patterns: # Example: exclude NFO files and samples
       - "*.nfo"
       - "*sample*"
+    include_patterns: # Example: include only video files
+      - "*.mkv"
+      - "*.mp4"
+      - "*.avi"

examples/presets.yaml

@@ -12,6 +12,9 @@ default:
   # exclude_patterns:                           # Default list of glob patterns to exclude files
   #   - "*.bak"
   #   - "temp.*"
+  # include_patterns:                           # Default list of glob patterns to include files (only these will be included)
+  #   - "*.mkv"
+  #   - "*.mp4"
 
 presets:
   ptp:
@@ -21,6 +24,9 @@ presets:
     exclude_patterns: # Example: exclude NFO files and samples
       - "*.nfo"
       - "*sample*"
+    include_patterns: # Example: include only video files
+      - "*.mkv"
+      - "*.mp4"
 
   # Public tracker preset with all options shown
   public:
@@ -29,5 +35,4 @@ presets:
     no_creator: true
     trackers:
       - "udp://tracker.opentrackr.org:1337/announce"
-      - "udp://open.tracker.cl:1337/announce"
-      - "udp://9.rarbg.com:2810/announce"
+

internal/preset/preset.go

@@ -32,6 +32,7 @@ type Options struct {
 	NoCreator       *bool    `yaml:"no_creator"`
 	SkipPrefix      *bool    `yaml:"skip_prefix"`
 	ExcludePatterns []string `yaml:"exclude_patterns"`
+	IncludePatterns []string `yaml:"include_patterns"`
 	Version         string   // used for creator string
 }
 
@@ -127,6 +128,9 @@ func (c *Config) GetPreset(name string) (*Options, error) {
 		if len(c.Default.ExcludePatterns) > 0 {
 			merged.ExcludePatterns = c.Default.ExcludePatterns
 		}
+		if len(c.Default.IncludePatterns) > 0 {
+			merged.IncludePatterns = c.Default.IncludePatterns
+		}
 	}
 
 	// override with preset values if they are set
@@ -163,6 +167,9 @@ func (c *Config) GetPreset(name string) (*Options, error) {
 	if len(preset.ExcludePatterns) > 0 {
 		merged.ExcludePatterns = preset.ExcludePatterns
 	}
+	if len(preset.IncludePatterns) > 0 {
+		merged.IncludePatterns = preset.IncludePatterns
+	}
 
 	return &merged, nil
 }

internal/torrent/batch.go

@@ -30,6 +30,7 @@ type BatchJob struct {
 	NoDate          bool     `yaml:"no_date"`
 	SkipPrefix      bool     `yaml:"skip_prefix"`
 	ExcludePatterns []string `yaml:"exclude_patterns"`
+	IncludePatterns []string `yaml:"include_patterns"`
 }
 
 // ToCreateOptions converts a BatchJob to CreateTorrentOptions
@@ -53,6 +54,7 @@ func (j *BatchJob) ToCreateOptions(verbose bool, quiet bool, version string) Cre
 		Version:         version,
 		SkipPrefix:      j.SkipPrefix,
 		ExcludePatterns: j.ExcludePatterns,
+		IncludePatterns: j.IncludePatterns,
 	}
 
 	if j.PieceLength != 0 {

internal/torrent/create.go

@@ -170,7 +170,7 @@ func CreateTorrent(opts CreateTorrentOptions) (*Torrent, error) {
 			}
 			return nil
 		}
-		if shouldIgnoreFile(filePath, opts.ExcludePatterns) {
+		if shouldIgnoreFile(filePath, opts.ExcludePatterns, opts.IncludePatterns) {
 			return nil
 		}
 		files = append(files, fileEntry{

internal/torrent/ignore.go

@@ -5,45 +5,82 @@ import (
 	"strings"
 )
 
-// file patterns to ignore in source directory (case insensitive)
+// file patterns to ignore in source directory (case insensitive) - These are always ignored.
 var ignoredPatterns = []string{
 	".torrent",
 	".ds_store",
 	"thumbs.db",
 	"desktop.ini",
 }
 
-// shouldIgnoreFile checks if a file should be ignored based on predefined patterns
-// and user-defined exclude patterns (glob matching).
-func shouldIgnoreFile(path string, excludePatterns []string) bool {
-	// first check built-in patterns (exact suffix match, case insensitive)
+// shouldIgnoreFile checks if a file should be ignored based on predefined patterns,
+// user-defined include patterns, and user-defined exclude patterns (glob matching).
+// Logic:
+// 1. Check built-in ignored patterns (always ignored).
+// 2. If include patterns are provided:
+//   - Check if the file matches any include pattern. If yes, KEEP the file (return false).
+//   - If it does not match any include pattern, IGNORE the file (return true).
+//
+// 3. If NO include patterns are provided:
+//   - Check if the file matches any exclude pattern. If yes, IGNORE the file (return true).
+//
+// 4. If none of the above conditions cause the file to be ignored, KEEP the file (return false).
+func shouldIgnoreFile(path string, excludePatterns []string, includePatterns []string) bool {
+	// 1. Check built-in patterns (always ignored)
 	lowerPath := strings.ToLower(path)
 	for _, pattern := range ignoredPatterns {
 		if strings.HasSuffix(lowerPath, pattern) {
 			return true
 		}
 	}
 
-	// then check user-defined exclude patterns (glob matching on filename, case insensitive)
-	if len(excludePatterns) > 0 {
-		filename := filepath.Base(path)
-		lowerFilename := strings.ToLower(filename)
+	filename := filepath.Base(path)
+	lowerFilename := strings.ToLower(filename)
 
-		for _, patternGroup := range excludePatterns {
+	// 2. Check include patterns if provided
+	if len(includePatterns) > 0 {
+		matchesInclude := false
+		for _, patternGroup := range includePatterns {
 			for _, pattern := range strings.Split(patternGroup, ",") {
 				pattern = strings.TrimSpace(pattern)
 				if pattern == "" {
 					continue
 				}
+				match, err := filepath.Match(strings.ToLower(pattern), lowerFilename)
+				if err == nil && match {
+					matchesInclude = true
+					break
+				}
+			}
+			if matchesInclude {
+				break
+			}
+		}
+
+		if matchesInclude {
+			return false // Keep the file because it matches an include pattern
+		} else {
+			return true // Ignore the file because include patterns were given, but none matched
+		}
+	}
 
+	// 3. If NO include patterns were provided, check exclude patterns
+	if len(excludePatterns) > 0 {
+		for _, patternGroup := range excludePatterns {
+			for _, pattern := range strings.Split(patternGroup, ",") {
+				pattern = strings.TrimSpace(pattern)
+				if pattern == "" {
+					continue
+				}
 				match, err := filepath.Match(strings.ToLower(pattern), lowerFilename)
 				// we ignore the error from filepath.Match as malformed patterns simply won't match
 				if err == nil && match {
-					return true
+					return true // Ignore if it matches an exclude pattern (and no include patterns were specified)
 				}
 			}
 		}
 	}
 
+	// 4. Keep the file if no ignore conditions were met
 	return false
 }

internal/torrent/types.go

@@ -26,6 +26,7 @@ type CreateTorrentOptions struct {
 	Quiet           bool
 	SkipPrefix      bool
 	ExcludePatterns []string
+	IncludePatterns []string
 }
 
 // Torrent represents a torrent file with additional functionality

schema/batch.json

@@ -71,6 +71,13 @@
             "items": {
               "type": "string"
             }
+          },
+          "include_patterns": {
+            "type": "array",
+            "description": "List of glob patterns to include files (e.g., \"*.mkv\", \"*video*\")",
+            "items": {
+              "type": "string"
+            }
           }
         }
       }

schema/presets.json

@@ -58,6 +58,13 @@
           "items": {
             "type": "string"
           }
+        },
+        "include_patterns": {
+          "type": "array",
+          "description": "List of glob patterns to include files (e.g., \"*.mkv\", \"*video*\")",
+          "items": {
+            "type": "string"
+          }
         }
       }
     },
@@ -116,7 +123,14 @@
             "type": "array",
             "description": "List of glob patterns to exclude files (e.g., \"*.nfo\", \"*sample*\")",
             "items": {
-              "type": "string"
+            "type": "string"
+          }
+        },
+        "include_patterns": {
+          "type": "array",
+          "description": "List of glob patterns to include files (e.g., \"*.mkv\", \"*video*\")",
+          "items": {
+            "type": "string"
             }
           }
         }