scanner

Documentation

Index

• Variables
• type FolderScanner
  • func NewTagScanner(rootFolder string, ds model.DataStore, playlists core.Playlists, ...) FolderScanner
• type MediaFileMapper
  • func NewMediaFileMapper(rootFolder string, genres model.GenreRepository) *MediaFileMapper
  • func (s MediaFileMapper) ToMediaFile(md metadata.Tags) model.MediaFile
• type Scanner
  • func GetInstance(ds model.DataStore, playlists core.Playlists, cacheWarmer artwork.CacheWarmer, ...) Scanner
• type StatusInfo
• type TagScanner
  • func (s *TagScanner) Scan(ctx context.Context, lastModifiedSince time.Time, progress chan uint32) (int64, error)

Variables

var (
	ErrAlreadyScanning = errors.New("already scanning")
	ErrScanError       = errors.New("scan error")
)

Types

type FolderScanner

type FolderScanner interface {
	// Scan process finds any changes after `lastModifiedSince` and returns the number of changes found
	Scan(ctx context.Context, lastModifiedSince time.Time, progress chan uint32) (int64, error)
}

func NewTagScanner

func NewTagScanner(rootFolder string, ds model.DataStore, playlists core.Playlists, cacheWarmer artwork.CacheWarmer) FolderScanner

type MediaFileMapper

type MediaFileMapper struct {
	// contains filtered or unexported fields
}

func NewMediaFileMapper

func NewMediaFileMapper(rootFolder string, genres model.GenreRepository) *MediaFileMapper

func (MediaFileMapper) ToMediaFile

func (s MediaFileMapper) ToMediaFile(md metadata.Tags) model.MediaFile

TODO Move most of these mapping functions to setters in the model.MediaFile

type Scanner

type Scanner interface {
	RescanAll(ctx context.Context, fullRescan bool) error
	Status(mediaFolder string) (*StatusInfo, error)
}

func GetInstance

func GetInstance(ds model.DataStore, playlists core.Playlists, cacheWarmer artwork.CacheWarmer, broker events.Broker) Scanner

type StatusInfo

type StatusInfo struct {
	MediaFolder string
	Scanning    bool
	LastScan    time.Time
	Count       uint32
	FolderCount uint32
}

type TagScanner

type TagScanner struct {
	// contains filtered or unexported fields
}

func (*TagScanner) Scan

func (s *TagScanner) Scan(ctx context.Context, lastModifiedSince time.Time, progress chan uint32) (int64, error)

Scan algorithm overview: Load all directories from the DB Traverse the music folder, collecting each subfolder's ModTime (self or any non-dir children, whichever is newer) For each changed folder: get all files from DB whose path starts with the changed folder (non-recursively), check each file: - if file in folder is newer, update the one in DB - if file in folder does not exists in DB, add it - for each file in the DB that is not found in the folder, delete it from DB Compare directories in the fs with the ones in the DB to find deleted folders For each deleted folder: delete all files from DB whose path starts with the delete folder path (non-recursively) Create new albums/artists, update counters: - collect all albumIDs and artistIDs from previous steps - refresh the collected albums and artists with the metadata from the mediafiles For each changed folder, process playlists: - If the playlist is not in the DB, import it, setting sync = true - If the playlist is in the DB and sync == true, import it, or else skip it Delete all empty albums, delete all empty artists, clean-up playlists