- feat(storage): libraries table (name, path); audio_files points at a library
by id instead of repeating the root path; migration 0005 for both drivers
turns every existing root into a library and keeps file ids, tracks and the
missing flag
- feat(library): Libraries service validates names and paths: absolute, an
existing directory, never the filesystem root, never inside or around
another library (checked on real paths, so symlinks cannot hide an overlap)
- feat(api): admin-only GET/POST /libraries, PATCH/DELETE /libraries/{id} and
POST /libraries/{id}/scan; deleting a library drops its index entries and
keeps tracks and listening history
- feat(library): the scanner and the scan manager work on libraries; scanning
with no libraries answers 409 no_libraries
- feat(streaming): the library directory comes from the database instead of
a configured list of roots
- breaking(config): library.roots is removed; an old config fails with a hint
to use POST /api/v1/libraries
- test: CRUD and duplicates on both databases, path change keeps files,
upgrade of a database written before libraries existed
129 lines
3.4 KiB
Go
129 lines
3.4 KiB
Go
// Package library scans the music directories and indexes audio files.
|
|
//
|
|
// The scanner only reads: it never writes, renames or deletes music files.
|
|
package library
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"time"
|
|
)
|
|
|
|
// ErrUnreadable means a file could not be parsed as audio.
|
|
var ErrUnreadable = errors.New("unreadable audio file")
|
|
|
|
// Tags are the descriptive tags of a track. Fields the file lacks are empty.
|
|
type Tags struct {
|
|
Title string
|
|
Album string
|
|
AlbumArtist string
|
|
Artists []string
|
|
TrackNo int
|
|
DiscNo int
|
|
}
|
|
|
|
// Properties are the technical properties of an audio file.
|
|
type Properties struct {
|
|
Format string // "mp3", "flac", ...
|
|
DurationMs int64
|
|
SampleRate int
|
|
BitRate int // kbit/s
|
|
}
|
|
|
|
// Metadata is everything read from one audio file.
|
|
type Metadata struct {
|
|
Tags
|
|
Properties
|
|
}
|
|
|
|
// TagReader reads metadata from a file on disk. It must be safe for
|
|
// concurrent use and return ErrUnreadable for files that are not valid audio.
|
|
type TagReader interface {
|
|
Read(path string) (Metadata, error)
|
|
}
|
|
|
|
// FileInfo identifies a file inside a library root.
|
|
type FileInfo struct {
|
|
RelPath string // slash-separated, relative to the root
|
|
Size int64
|
|
MTimeUnix int64
|
|
}
|
|
|
|
// ExistingFile is a file already indexed in the database.
|
|
type ExistingFile struct {
|
|
ID int64
|
|
FileInfo
|
|
Missing bool // last scan did not find it
|
|
}
|
|
|
|
// ParsedFile is a file together with its metadata, ready to be stored.
|
|
type ParsedFile struct {
|
|
FileInfo
|
|
Metadata
|
|
}
|
|
|
|
// Store is what the scanner needs from persistence. All writes come from a
|
|
// single goroutine, so implementations need no extra locking for the scanner.
|
|
type Store interface {
|
|
ExistingFiles(ctx context.Context, libraryID int64) ([]ExistingFile, error)
|
|
// SaveFile creates the file (existingID == 0) or updates it, together with
|
|
// its track, album and artists. It reports whether a new file was created.
|
|
SaveFile(ctx context.Context, libraryID int64, f ParsedFile, existingID int64) (added bool, err error)
|
|
// RenameFile points an indexed file at a new relative path and clears its missing flag.
|
|
RenameFile(ctx context.Context, id int64, newRelPath string) error
|
|
// MarkMissing flags files that were not found. Rows are never deleted.
|
|
MarkMissing(ctx context.Context, ids []int64, at time.Time) error
|
|
// Restore clears the missing flag of files that reappeared.
|
|
Restore(ctx context.Context, ids []int64) error
|
|
}
|
|
|
|
// EventType names a scan progress event.
|
|
type EventType string
|
|
|
|
// Scan progress events.
|
|
const (
|
|
ScanStarted EventType = "scan_started"
|
|
FileScanned EventType = "file_scanned"
|
|
FileFailed EventType = "file_failed"
|
|
ScanFinished EventType = "scan_finished"
|
|
)
|
|
|
|
// Event is one progress notification. Done and Total count files being
|
|
// parsed in the current library.
|
|
type Event struct {
|
|
Type EventType
|
|
Time time.Time
|
|
LibraryID int64
|
|
Library string // library name
|
|
RelPath string
|
|
Error string
|
|
Done int
|
|
Total int
|
|
Summary *Summary // only on ScanFinished
|
|
}
|
|
|
|
// Summary counts what a scan did.
|
|
type Summary struct {
|
|
Libraries int
|
|
Found int // audio files seen on disk
|
|
Added int
|
|
Updated int
|
|
Unchanged int
|
|
Renamed int
|
|
Restored int
|
|
Missing int // newly marked missing
|
|
Failed int
|
|
Skipped int // symlinks
|
|
}
|
|
|
|
func (s *Summary) add(o Summary) {
|
|
s.Found += o.Found
|
|
s.Added += o.Added
|
|
s.Updated += o.Updated
|
|
s.Unchanged += o.Unchanged
|
|
s.Renamed += o.Renamed
|
|
s.Restored += o.Restored
|
|
s.Missing += o.Missing
|
|
s.Failed += o.Failed
|
|
s.Skipped += o.Skipped
|
|
}
|