dupe

package

v1.2.2 Latest Latest Go to latest Published: May 1, 2026 License: MIT Imports: 27 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/bengarrett/dupers

Links

Open Source Insights

Documentation ¶

Overview ¶

Package dupe provides core duplicate file detection functionality.

Index ¶

Constants
Variables
func Bucket(name string) parse.Bucket
func Match(path, match string) string
func Print(quiet, exact bool, term string, m *database.Matches) string
func PrintRM(path string, err error) string
func PrintWalk(lookup bool, c *Config) string
func SkipDirectory(name string) error
func SkipFS(dir, file, regular bool, d fs.DirEntry) error
func SkipFile(name string) bool
type Config

Constants ¶

View Source

const (
	WinOS = "windows"
)

Variables ¶

View Source

var (
	ErrFileEmpty     = errors.New("file is empty, being 0 byte in size")
	ErrNilConfig     = errors.New("config cannot be nil")
	ErrNoMatch       = errors.New("no match found")
	ErrNoNamedBucket = errors.New("a named bucket is required")
	ErrPathEmpty     = errors.New("path is empty")
	ErrPathIsFile    = errors.New("path is a file")
	ErrPathExist     = errors.New("path exists in the database bucket")
	ErrPathNoFound   = errors.New("path does not exist")
	ErrPathTraversal = errors.New("path traversal attempt detected")
)

Functions ¶

func Bucket ¶

func Bucket(name string) parse.Bucket

Bucket returns the named string as a Bucket type.

func Print ¶

func Print(quiet, exact bool, term string, m *database.Matches) string

Print the results of the database comparisons.

func SkipDirectory ¶ added in v1.2.2

func SkipDirectory(name string) error

SkipDirectory tells WalkDir to ignore specific system and hidden directories. This function should only be called for directories, not files.

func SkipFS ¶

func SkipFS(dir, file, regular bool, d fs.DirEntry) error

SkipFS tells WalkDir to ignore specific files and directories. A true dir value will skip directories. A true file value will skip OS specific system files. A true regular value will skip all non-files such as symlinks.

func SkipFile ¶

func SkipFile(name string) bool

SkipFile returns true if the file matches a known Windows or macOS system file.

Types ¶

type Config ¶

type Config struct {
	parse.Scanner

	Debug bool // Debug spams technobabble to stdout.
	Quiet bool // Quiet the feedback sent to stdout.
	Yes   bool // Yes is assumed for all user questions and prompts.
	Test  bool // Test toggles the internal unit test mode.
}

Config options.

func (*Config) Checksum ¶

func (c *Config) Checksum(db *bolt.DB, name, bucket string) error

Checksum the named file and save it to the bucket. The saved checksum is a SHA256 hash.

func (*Config) Clean deprecated

func (c *Config) Clean(w io.Writer) error

Deprecated: Use [DelEmptyDirs] instead.

func (*Config) Debugger ¶

func (c *Config) Debugger(s string)

Debugger prints the string to stdout whenever Config.Debug is true.

func (*Config) DelDirsExcept ¶ added in v1.2.2

func (c *Config) DelDirsExcept() ([]string, error)

DelDirsExcept the directories from the source that do not contain unique MS-DOS or Windows programs. The strings contains the path of any non-deletable files.

func (*Config) DelDupeFiles ¶ added in v1.2.2

func (c *Config) DelDupeFiles() (string, error)

DelDupeFiles duplicate files from the source directory.

func (*Config) DelEmptyDirs ¶ added in v1.2.2

func (c *Config) DelEmptyDirs(w io.Writer) error

DelEmptyDirs removes all empty directories from c.Source. Directories containing hidden system directories or files are not considered empty.

func (*Config) Print ¶

func (c *Config) Print() (string, error)

Print the results of a dupe request.

func (*Config) Read ¶

func (c *Config) Read(db *bolt.DB, bucket parse.Bucket, name, mimeExt string) error

Read opens the named archive, hashes and saves the content to the bucket.

func (*Config) Read7Zip ¶

func (c *Config) Read7Zip(db *bolt.DB, bucket parse.Bucket, name string) error

Read7Zip opens the named 7-Zip archive, hashes and saves the content to the bucket.

func (*Config) Remove deprecated

func (c *Config) Remove() (string, error)

Deprecated: Use [DelDupeFiles] instead.

func (*Config) Removes deprecated

func (c *Config) Removes() ([]string, error)

Deprecated: Use [DelDirsExcept] instead.

func (*Config) StatSource ¶

func (c *Config) StatSource() (bool, int, int, error)

StatSource returns the number of files found in the source to check.

If the given source is a file, the total number of files value will always be 1.

The func returns the following results,

the boolean is true when the source is a directory
the first int are the total number of files in the source
the second int are the number of items in the buckets for the dupe check

func (*Config) Status ¶

func (c *Config) Status() string

Status summarizes the file totals and process duration.

func (*Config) WalkArchiver ¶

func (c *Config) WalkArchiver(db *bolt.DB, bucket parse.Bucket) error

WalkArchiver walks the bucket directory saving the checksums of new files to the database. Any archived files supported by archiver will also have its content hashed. Archives within archives are currently left unwalked.

func (*Config) WalkDir ¶

func (c *Config) WalkDir(db *bolt.DB, bucket parse.Bucket) error

WalkDir walks the named bucket directory for any new files to add their checksums to the database.

func (*Config) WalkDirs ¶

func (c *Config) WalkDirs(db *bolt.DB) error

WalkDirs walks the named bucket directories for any new files to add their checksums to the database.

func (*Config) WalkSource ¶

func (c *Config) WalkSource() error

WalkSource walks the source directory or a file to collect the hashed content for a future comparison.

func (*Config) Writer ¶

func (c *Config) Writer(w io.Writer, s string)

Writer writes the string to the io.writer whenever Config.Debug is true.

Source Files ¶

View all Source files

dupe.go

Directories ¶

Path	Synopsis
internal
archive Package archive provides archive file handling and MIME type detection.	Package archive provides archive file handling and MIME type detection.
parse Package parse provides file parsing and checksum calculation functionality.	Package parse provides file parsing and checksum calculation functionality.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL