file

type CleanHandler ¶ added in v0.17.0

type CleanHandler interface {
	HandleFile(ctx context.Context, fileDeleter *Deleter, fileID models.FileID) error
	HandleFolder(ctx context.Context, fileDeleter *Deleter, folderID models.FolderID) error
}

CleanHandler provides a handler for cleaning Files and Folders.

type CleanOptions ¶ added in v0.17.0

type CleanOptions struct {
	Paths []string

	// Do a dry run. Don't delete any files
	DryRun bool

	// PathFilter are used to determine if a file should be included.
	// Excluded files are marked for cleaning.
	PathFilter PathFilter
}

ScanOptions provides options for scanning files.

type Cleaner ¶ added in v0.17.0

type Cleaner struct {
	FS         models.FS
	Repository Repository

	Handlers []CleanHandler
}

Cleaner scans through stored file and folder instances and removes those that are no longer present on disk.

func (s *Cleaner) Clean(ctx context.Context, options CleanOptions, progress *job.Progress)

type Decorator ¶ added in v0.17.0

type Decorator interface {
	Decorate(ctx context.Context, fs models.FS, f models.File) (models.File, error)
	IsMissingMetadata(ctx context.Context, fs models.FS, f models.File) bool
}

Decorator wraps the Decorate method to add additional functionality while scanning files.

type Deleter ¶ added in v0.12.0

type Deleter struct {
	RenamerRemover RenamerRemover
	// contains filtered or unexported fields
}

Deleter is used to safely delete files and directories from the filesystem. During a transaction, files and directories are marked for deletion using the Files and Dirs methods. This will rename the files/directories to be deleted. If the transaction is rolled back, then the files/directories can be restored to their original state with the Abort method. If the transaction is committed, the marked files are then deleted from the filesystem using the Complete method.

func NewDeleter() *Deleter

func (d *Deleter) Commit()

func (d *Deleter) Dirs(paths []string) error

func (d *Deleter) Files(paths []string) error

func (d *Deleter) RegisterHooks(ctx context.Context)

func (d *Deleter) Rollback()

type DirMakerStatRenamer ¶ added in v0.20.0

type DirMakerStatRenamer interface {
	Statter
	Renamer
	Mkdir(name string, perm os.FileMode) error
	Remove(name string) error
}

type Filter ¶ added in v0.17.0

type Filter interface {
	Accept(ctx context.Context, f models.File) bool
}

Filter provides a filter function for Files.

type FilterFunc ¶ added in v0.17.0

type FilterFunc func(ctx context.Context, f models.File) bool

func (ff FilterFunc) Accept(ctx context.Context, f models.File) bool

type FilteredDecorator ¶ added in v0.17.0

type FilteredDecorator struct {
	Decorator
	Filter
}

func (d *FilteredDecorator) Decorate(ctx context.Context, fs models.FS, f models.File) (models.File, error)

func (d *FilteredDecorator) IsMissingMetadata(ctx context.Context, fs models.FS, f models.File) bool

type FilteredHandler ¶ added in v0.17.0

type FilteredHandler struct {
	Handler
	Filter
}

FilteredHandler is a Handler runs only if the filter accepts the file.

func (h *FilteredHandler) Handle(ctx context.Context, f models.File, oldFile models.File) error

type FingerprintCalculator ¶ added in v0.17.0

type FingerprintCalculator interface {
	CalculateFingerprints(f *models.BaseFile, o Opener, useExisting bool) ([]models.Fingerprint, error)
}

FingerprintCalculator calculates a fingerprint for the provided file.

type Handler ¶ added in v0.17.0

type Handler interface {
	Handle(ctx context.Context, f models.File, oldFile models.File) error
}

Handler provides a handler for Files.

type Importer ¶ added in v0.23.0

type Importer struct {
	ReaderWriter models.FileFinderCreator
	FolderStore  models.FolderFinderCreator
	Input        jsonschema.DirEntry
	// contains filtered or unexported fields
}

func (i *Importer) Create(ctx context.Context) (*int, error)

func (i *Importer) FindExistingID(ctx context.Context) (*int, error)

func (i *Importer) Name() string

func (i *Importer) PostImport(ctx context.Context, id int) error

func (i *Importer) PreImport(ctx context.Context) error

func (i *Importer) Update(ctx context.Context, id int) error

type Mover ¶ added in v0.20.0

type Mover struct {
	Renamer DirMakerStatRenamer
	Files   models.FileFinderUpdater
	Folders models.FolderReaderWriter
	// contains filtered or unexported fields
}

func NewMover(fileStore models.FileFinderUpdater, folderStore models.FolderReaderWriter) *Mover

func (m *Mover) CreateFolderHierarchy(path string) error

func (m *Mover) Move(ctx context.Context, f models.File, folder *models.Folder, basename string) error

func (m *Mover) RegisterHooks(ctx context.Context)

type Opener ¶ added in v0.17.0

type Opener interface {
	Open() (io.ReadCloser, error)
}

Opener provides an interface to open a file.

type OsFS ¶ added in v0.17.0

type OsFS struct{}

OsFS is a file system backed by the OS.

func (f *OsFS) Create(name string) (*os.File, error)

func (f *OsFS) IsPathCaseSensitive(path string) (bool, error)

func (f *OsFS) Lstat(name string) (fs.FileInfo, error)

func (f *OsFS) MkdirAll(path string, perm fs.FileMode) error

func (f *OsFS) Open(name string) (fs.ReadDirFile, error)

func (f *OsFS) OpenZip(name string) (models.ZipFS, error)

func (f *OsFS) Remove(name string) error

func (f *OsFS) RemoveAll(path string) error

func (f *OsFS) Rename(oldpath, newpath string) error

func (f *OsFS) Stat(name string) (fs.FileInfo, error)

type PathFilter ¶ added in v0.17.0

type PathFilter interface {
	Accept(ctx context.Context, path string, info fs.FileInfo) bool
}

PathFilter provides a filter function for paths.

type PathFilterFunc ¶ added in v0.17.0

type PathFilterFunc func(path string) bool

func (pff PathFilterFunc) Accept(path string) bool

type ProgressReporter ¶ added in v0.17.0

type ProgressReporter interface {
	AddTotal(total int)
	Increment()
	Definite()
	ExecuteTask(description string, fn func())
}

ProgressReporter is used to report progress of the scan.

type Renamer ¶ added in v0.20.0

type Renamer interface {
	Rename(oldpath, newpath string) error
}

type RenamerRemover ¶ added in v0.12.0

type RenamerRemover interface {
	Renamer
	Remove(name string) error
	RemoveAll(path string) error
	Statter
}

RenamerRemover provides access to the Rename and Remove functions.

type Repository ¶ added in v0.17.0

type Repository struct {
	TxnManager models.TxnManager

	File   models.FileReaderWriter
	Folder models.FolderReaderWriter
}

Repository provides access to storage methods for files and folders.

func NewRepository(repo models.Repository) Repository

func (r *Repository) WithDB(ctx context.Context, fn txn.TxnFunc) error

func (r *Repository) WithReadTxn(ctx context.Context, fn txn.TxnFunc) error

func (r *Repository) WithTxn(ctx context.Context, fn txn.TxnFunc) error

type ScanOptions ¶ added in v0.17.0

type ScanOptions struct {
	Paths []string

	// ZipFileExtensions is a list of file extensions that are considered zip files.
	// Extension does not include the . character.
	ZipFileExtensions []string

	// ScanFilters are used to determine if a file should be scanned.
	ScanFilters []PathFilter

	// HandlerRequiredFilters are used to determine if an unchanged file needs to be handled
	HandlerRequiredFilters []Filter

	ParallelTasks int
}

ScanOptions provides options for scanning files.

type Scanner ¶

type Scanner struct {
	FS                    models.FS
	Repository            Repository
	FingerprintCalculator FingerprintCalculator

	// FileDecorators are applied to files as they are scanned.
	FileDecorators []Decorator
}

Scanner scans files into the database.

The scan process works using two goroutines. The first walks through the provided paths in the filesystem. It runs each directory entry through the provided ScanFilters. If none of the filter Accept methods return true, then the file/directory is ignored. Any folders found are handled immediately. Files inside zip files are also handled immediately. All other files encountered are sent to the second goroutine queue.

Folders are handled by checking if the folder exists in the database, by its full path. If a folder entry already exists, then its mod time is updated (if applicable). If the folder does not exist in the database, then a new folder entry its created.

Files are handled by first querying for the file by its path. If the file entry exists in the database, then the mod time is compared to the value in the database. If the mod time is different then file is marked as updated - it recalculates any fingerprints and fires decorators, then the file entry is updated and any applicable handlers are fired.

If the file entry does not exist in the database, then fingerprints are calculated for the file. It then determines if the file is a rename of an existing file by querying for file entries with the same fingerprint. If any are found, it checks each to see if any are missing in the file system. If one is, then the file is treated as renamed and its path is updated. If none are missing, or many are, then the file is treated as a new file.

If the file is not a renamed file, then the decorators are fired and the file is created, then the applicable handlers are fired.

func (s *Scanner) Scan(ctx context.Context, handlers []Handler, options ScanOptions, progressReporter ProgressReporter)

type Statter ¶ added in v0.20.0

type Statter interface {
	Stat(name string) (fs.FileInfo, error)
}

type ZipDestroyer ¶ added in v0.17.0

type ZipDestroyer struct {
	FileDestroyer   models.FileFinderDestroyer
	FolderDestroyer models.FolderFinderDestroyer
}

func (d *ZipDestroyer) DestroyZip(ctx context.Context, f models.File, fileDeleter *Deleter, deleteFile bool) error