navidrome/scanner/scanner.go

package scanner

import (
	"context"
	"errors"
	"fmt"
	"strconv"
	"sync"
	"time"

	"github.com/deluan/navidrome/core"
	"github.com/deluan/navidrome/log"
	"github.com/deluan/navidrome/model"
)

type Scanner interface {
	Start(interval time.Duration) error
	Stop()
	RescanAll(fullRescan bool)
	Status(mediaFolder string) (*StatusInfo, error)
	Scanning() bool
}

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

type FolderScanner interface {
	Scan(ctx context.Context, lastModifiedSince time.Time) error
}

type scanner struct {
	folders     map[string]FolderScanner
	status      map[string]*scanStatus
	lock        *sync.RWMutex
	ds          model.DataStore
	cacheWarmer core.CacheWarmer
	done        chan bool
	scan        chan bool
}

type scanStatus struct {
	active     bool
	count      int64
	lastUpdate time.Time
}

func New(ds model.DataStore, cacheWarmer core.CacheWarmer) Scanner {
	s := &scanner{
		ds:          ds,
		cacheWarmer: cacheWarmer,
		folders:     map[string]FolderScanner{},
		status:      map[string]*scanStatus{},
		lock:        &sync.RWMutex{},
		done:        make(chan bool),
		scan:        make(chan bool),
	}
	s.loadFolders()
	return s
}

func (s *scanner) Start(interval time.Duration) error {
	if interval == 0 {
		log.Warn("Periodic scan is DISABLED", "interval", interval)
	}
	var sleep <-chan time.Time
	for {
		if interval == 0 {
			sleep = make(chan time.Time)
		} else {
			sleep = time.After(interval)
		}
		select {
		case full := <-s.scan:
			s.rescanAll(full)
		case <-sleep:
			s.rescanAll(false)
			continue
		case <-s.done:
			return nil
		}
	}
}

func (s *scanner) Stop() {
	s.done <- true
}

func (s *scanner) rescan(mediaFolder string, fullRescan bool) error {
	folderScanner := s.folders[mediaFolder]
	start := time.Now()

	lastModifiedSince := time.Time{}
	if !fullRescan {
		lastModifiedSince = s.getLastModifiedSince(mediaFolder)
		log.Debug("Scanning folder", "folder", mediaFolder, "lastModifiedSince", lastModifiedSince)
	} else {
		log.Debug("Scanning folder (full scan)", "folder", mediaFolder)
	}

	s.setStatusActive(mediaFolder, true)
	defer s.setStatus(mediaFolder, false, 0, start)

	err := folderScanner.Scan(log.NewContext(context.TODO()), lastModifiedSince)
	if err != nil {
		log.Error("Error importing MediaFolder", "folder", mediaFolder, err)
	}

	s.updateLastModifiedSince(mediaFolder, start)
	return err
}

func (s *scanner) RescanAll(fullRescan bool) {
	if s.Scanning() {
		log.Debug("Scanner already running, ignoring request for rescan.")
		return
	}
	s.scan <- fullRescan
}

func (s *scanner) rescanAll(fullRescan bool) {
	var hasError bool
	for folder := range s.folders {
		err := s.rescan(folder, fullRescan)
		hasError = hasError || err != nil
	}
	if hasError {
		log.Error("Errors while scanning media. Please check the logs")
	}
}

func (s *scanner) getStatus(folder string) *scanStatus {
	s.lock.RLock()
	defer s.lock.RUnlock()
	if status, ok := s.status[folder]; ok {
		return status
	}
	return nil
}

func (s *scanner) setStatus(folder string, active bool, count int64, lastUpdate time.Time) {
	s.lock.Lock()
	defer s.lock.Unlock()
	if status, ok := s.status[folder]; ok {
		status.active = active
		status.count = count
		status.lastUpdate = lastUpdate
	}
}

func (s *scanner) setStatusActive(folder string, active bool) {
	s.lock.Lock()
	defer s.lock.Unlock()
	if status, ok := s.status[folder]; ok {
		status.active = active
	}
}

func (s *scanner) Scanning() bool {
	s.lock.RLock()
	defer s.lock.RUnlock()
	for _, status := range s.status {
		if status.active {
			return true
		}
	}
	return false
}

func (s *scanner) Status(mediaFolder string) (*StatusInfo, error) {
	status := s.getStatus(mediaFolder)
	if status == nil {
		return nil, errors.New("mediaFolder not found")
	}
	return &StatusInfo{
		MediaFolder: mediaFolder,
		Scanning:    status.active,
		LastScan:    status.lastUpdate,
		Count:       status.count,
	}, nil
}

func (s *scanner) getLastModifiedSince(folder string) time.Time {
	ms, err := s.ds.Property(context.TODO()).Get(model.PropLastScan + "-" + folder)
	if err != nil {
		return time.Time{}
	}
	if ms == "" {
		return time.Time{}
	}
	i, _ := strconv.ParseInt(ms, 10, 64)
	return time.Unix(0, i*int64(time.Millisecond))
}

func (s *scanner) updateLastModifiedSince(folder string, t time.Time) {
	millis := t.UnixNano() / int64(time.Millisecond)
	if err := s.ds.Property(context.TODO()).Put(model.PropLastScan+"-"+folder, fmt.Sprint(millis)); err != nil {
		log.Error("Error updating DB after scan", err)
	}
}

func (s *scanner) loadFolders() {
	fs, _ := s.ds.MediaFolder(context.TODO()).GetAll()
	for _, f := range fs {
		log.Info("Configuring Media Folder", "name", f.Name, "path", f.Path)
		s.folders[f.Path] = s.newScanner(f)
		s.status[f.Path] = &scanStatus{
			active:     false,
			count:      0,
			lastUpdate: s.getLastModifiedSince(f.Path),
		}
	}
}

func (s *scanner) newScanner(f model.MediaFolder) FolderScanner {
	return NewTagScanner(f.Path, s.ds, s.cacheWarmer)
}