pruneEmptyEntities deleted empty albums but never the cover_art rows they referenced, so removing the last track of an album leaked the row and its files forever — the janitor's covers sweep computes its live set from cover_art.file_path, which keeps the orphaned row's files exempt. Extract sweepOrphanedCoverArt/removeCoverArtFiles as one implementation and run it from pruneEmptyEntities (scan orphan path and RemoveFromLibrary) and RemoveLibrary alike. Closes #247
494 lines
15 KiB
Go
494 lines
15 KiB
Go
package library
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
"time"
|
|
|
|
"yellowjacket/backend/database"
|
|
"yellowjacket/backend/database/sql/sqlcgen"
|
|
"yellowjacket/backend/events"
|
|
)
|
|
|
|
// Sentinel errors for library CRUD validation.
|
|
var (
|
|
errLibraryNameEmpty = errors.New("library name must not be empty")
|
|
errLibraryNameTooLong = errors.New("library name must be 50 characters or fewer")
|
|
errLibraryNameDuplicate = errors.New("a library with that name already exists")
|
|
errLibraryPathNotExist = errors.New("directory does not exist")
|
|
errQueryNoRows = errors.New("query returned no rows")
|
|
)
|
|
|
|
// maxLibraryNameLength is the maximum number of characters allowed
|
|
// in a library display name.
|
|
const maxLibraryNameLength = 50
|
|
|
|
// RemovalHooks contains callbacks invoked during library removal.
|
|
// These break circular dependencies between the library, player,
|
|
// and queue packages.
|
|
type RemovalHooks struct {
|
|
// StopPlayback stops the currently-playing track.
|
|
StopPlayback func()
|
|
// CompactQueue reloads queue state after cascade deletes.
|
|
CompactQueue func()
|
|
// PostRemove runs after the removal commits, for cross-cutting
|
|
// invalidation (e.g. clearing library-sync "ready" markers).
|
|
PostRemove func()
|
|
}
|
|
|
|
// SetRemovalHooks provides optional hooks for cross-cutting
|
|
// orchestration during RemoveLibrary.
|
|
//
|
|
//wails:ignore // internal wiring, not part of the app's IPC surface.
|
|
func (l *Library) SetRemovalHooks(h RemovalHooks) {
|
|
l.mu.Lock()
|
|
defer l.mu.Unlock()
|
|
|
|
l.removalHooks = h
|
|
}
|
|
|
|
// RemovalImpact contains pre-removal counts for the confirmation dialog.
|
|
type RemovalImpact struct {
|
|
TrackCount int64 `json:"trackCount"`
|
|
PlaylistsAffected int64 `json:"playlistsAffected"`
|
|
QueueItemCount int64 `json:"queueItemCount"`
|
|
}
|
|
|
|
// RemovalSummary contains post-removal counts for the toast notification.
|
|
type RemovalSummary struct {
|
|
TracksDeleted int64 `json:"tracksDeleted"`
|
|
ArtistsRemoved int64 `json:"artistsRemoved"`
|
|
AlbumsRemoved int64 `json:"albumsRemoved"`
|
|
GenresRemoved int64 `json:"genresRemoved"`
|
|
PlaylistsAffected int64 `json:"playlistsAffected"`
|
|
QueueItemsRemoved int64 `json:"queueItemsRemoved"`
|
|
}
|
|
|
|
// AddLibrary creates a new library from a directory path, emits a
|
|
// LibraryAdded event, and starts an asynchronous scan.
|
|
func (l *Library) AddLibrary(path string) (*sqlcgen.Library, error) {
|
|
if _, err := os.Stat(path); err != nil {
|
|
return nil, fmt.Errorf("%w: %s", errLibraryPathNotExist, path)
|
|
}
|
|
|
|
name := filepath.Base(path)
|
|
|
|
lib, err := l.db.Queries.CreateLibrary(l.ctx, sqlcgen.CreateLibraryParams{
|
|
Name: name,
|
|
Path: path,
|
|
})
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not create library: %w", err)
|
|
}
|
|
|
|
// Claim orphaned tracks whose file_path falls under this library's
|
|
// directory and still have the default library_id (0). This handles
|
|
// the case where tracks exist from a pre-multi-library schema.
|
|
// SAFETY: Hand-crafted UPDATE because sqlc cannot express path-prefix
|
|
// matching with LIKE and dynamic library_id in a single statement.
|
|
// The WHERE clause is safe: library_id=0 targets only unclaimed rows,
|
|
// and the path prefix is escaped by the query parameter.
|
|
claimResult, claimErr := l.db.ExecContext(
|
|
`UPDATE audio_files SET library_id = ? WHERE library_id = 0 AND file_path LIKE ? || '%'`,
|
|
lib.ID, path+"/",
|
|
)
|
|
if claimErr != nil {
|
|
l.logger.Warn("could not claim orphaned tracks",
|
|
"libraryID", lib.ID, "path", path, "err", claimErr)
|
|
} else if claimed, _ := claimResult.RowsAffected(); claimed > 0 {
|
|
l.logger.Info("claimed orphaned tracks for new library",
|
|
"libraryID", lib.ID, "claimed", claimed)
|
|
}
|
|
|
|
l.emit(events.LibraryAdded, lib)
|
|
|
|
go func() {
|
|
if scanErr := l.ScanLibrary(lib.ID); scanErr != nil {
|
|
l.logger.Error("auto-scan after add failed",
|
|
"libraryID", lib.ID,
|
|
"err", scanErr,
|
|
)
|
|
}
|
|
}()
|
|
|
|
return &lib, nil
|
|
}
|
|
|
|
// LibraryPath resolves a library's root directory by id.
|
|
func (l *Library) LibraryPath(id int64) (string, error) {
|
|
lib, err := l.db.ReadQueries.GetLibrary(l.ctx, id)
|
|
if err != nil {
|
|
return "", fmt.Errorf("could not get library %d: %w", id, err)
|
|
}
|
|
|
|
return lib.Path, nil
|
|
}
|
|
|
|
// RenameLibrary validates and updates a library's display name.
|
|
func (l *Library) RenameLibrary(id int64, newName string) error {
|
|
newName = strings.TrimSpace(newName)
|
|
|
|
if newName == "" {
|
|
return errLibraryNameEmpty
|
|
}
|
|
|
|
if len(newName) > maxLibraryNameLength {
|
|
return errLibraryNameTooLong
|
|
}
|
|
|
|
// Application-level uniqueness check (no schema migration needed).
|
|
libs, err := l.db.Queries.GetAllLibraries(l.ctx)
|
|
if err != nil {
|
|
return fmt.Errorf("could not check existing names: %w", err)
|
|
}
|
|
|
|
for _, lib := range libs {
|
|
if lib.ID != id && lib.Name == newName {
|
|
return fmt.Errorf("%w: %q", errLibraryNameDuplicate, newName)
|
|
}
|
|
}
|
|
|
|
if err := l.db.Queries.UpdateLibraryName(l.ctx, sqlcgen.UpdateLibraryNameParams{
|
|
Name: newName,
|
|
ID: id,
|
|
}); err != nil {
|
|
return fmt.Errorf("could not rename library: %w", err)
|
|
}
|
|
|
|
l.emit(events.LibraryRenamed, map[string]any{
|
|
"id": id,
|
|
"name": newName,
|
|
})
|
|
|
|
return nil
|
|
}
|
|
|
|
// GetRemovalImpact returns pre-removal counts for the confirmation
|
|
// dialog. All queries are read-only.
|
|
func (l *Library) GetRemovalImpact(libraryID int64) (*RemovalImpact, error) {
|
|
trackCount, err := l.db.Queries.CountAudioFiles(l.ctx, libraryID)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not count tracks: %w", err)
|
|
}
|
|
|
|
// SAFETY: Hand-crafted SQL for playlists affected by library removal.
|
|
// Multi-table JOIN with DISTINCT unsupported by sqlc. Parameterized.
|
|
playlistsAffected, err := querySingleInt64(l.ctx, l.db,
|
|
`SELECT COUNT(DISTINCT pt.playlist_id)
|
|
FROM playlist_tracks pt
|
|
JOIN audio_files af ON pt.audio_file_id = af.id
|
|
WHERE af.library_id = ?`,
|
|
libraryID,
|
|
)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not count affected playlists: %w", err)
|
|
}
|
|
|
|
// SAFETY: Hand-crafted SQL for queue items affected by library removal.
|
|
// Multi-table JOIN unsupported by sqlc. Parameterized.
|
|
queueItemCount, err := querySingleInt64(l.ctx, l.db,
|
|
`SELECT COUNT(*)
|
|
FROM queue_tracks qt
|
|
JOIN audio_files af ON qt.audio_file_id = af.id
|
|
WHERE af.library_id = ?`,
|
|
libraryID,
|
|
)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not count queue items: %w", err)
|
|
}
|
|
|
|
return &RemovalImpact{
|
|
TrackCount: trackCount,
|
|
PlaylistsAffected: playlistsAffected,
|
|
QueueItemCount: queueItemCount,
|
|
}, nil
|
|
}
|
|
|
|
// RemoveLibrary atomically removes a library and all its data,
|
|
// performing orphan cleanup, phantom metadata conversion, FTS5
|
|
// rebuild, and queue compaction. Returns a summary of what was removed.
|
|
func (l *Library) RemoveLibrary(id int64) (*RemovalSummary, error) {
|
|
// 1. Cancel active scan for this library and wait for it to stop.
|
|
l.cancelLibraryScan(id)
|
|
l.waitForScanIdle(id)
|
|
|
|
// 2. Stop playback if the currently-playing track belongs to this library.
|
|
if l.currentTrackBelongsToLibrary(id) {
|
|
if l.removalHooks.StopPlayback != nil {
|
|
l.removalHooks.StopPlayback()
|
|
}
|
|
}
|
|
|
|
// 3. Pre-count for summary.
|
|
impact, err := l.GetRemovalImpact(id)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not get removal impact: %w", err)
|
|
}
|
|
|
|
// 4. Begin transaction.
|
|
tx, err := l.db.BeginTx()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not begin transaction: %w", err)
|
|
}
|
|
|
|
committed := false
|
|
|
|
defer func() {
|
|
if !committed {
|
|
_ = tx.Rollback()
|
|
}
|
|
}()
|
|
|
|
// 5. Populate phantom metadata BEFORE deleting audio_files.
|
|
// SAFETY: Hand-crafted UPDATE-FROM-SELECT for phantom metadata population.
|
|
// Must run BEFORE DELETE FROM audio_files (which triggers SET NULL on
|
|
// playlist_tracks.audio_file_id). Multi-table JOIN with subqueries
|
|
// unsupported by sqlc. All values parameterized.
|
|
if _, err := tx.ExecContext(l.ctx, `
|
|
UPDATE playlist_tracks SET
|
|
phantom_title = sub.title,
|
|
phantom_artist = sub.artist_name,
|
|
phantom_album = sub.album,
|
|
phantom_duration_ms = sub.length_milliseconds,
|
|
phantom_genre = sub.genre,
|
|
phantom_cover_art_path = sub.cover_art_path,
|
|
phantom_file_path = sub.file_path
|
|
FROM (
|
|
SELECT pt.id AS pt_id, tm.*
|
|
FROM playlist_tracks pt
|
|
JOIN track_metadata tm ON tm.id = pt.audio_file_id
|
|
WHERE tm.library_id = ?
|
|
) sub
|
|
WHERE playlist_tracks.id = sub.pt_id`, id); err != nil {
|
|
return nil, fmt.Errorf("could not populate phantom metadata: %w", err)
|
|
}
|
|
|
|
// 6. Delete audio_files (CASCADE deletes queue_tracks, SET NULL on playlist_tracks).
|
|
// SAFETY: Hand-crafted DELETE for bulk removal by library_id.
|
|
// sqlc DeleteAudioFile only handles single-row deletes. Parameterized.
|
|
result, err := tx.ExecContext(l.ctx,
|
|
`DELETE FROM audio_files WHERE library_id = ?`, id)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not delete audio files: %w", err)
|
|
}
|
|
|
|
tracksDeleted, _ := result.RowsAffected()
|
|
|
|
// 7. Sweep what the files left behind. This used to be eight
|
|
// statements in dependency order, because deleting a file cascaded
|
|
// to none of the five metadata tables it had created. file_genres
|
|
// cascades now, so what is left is the two tables that genuinely
|
|
// outlive a file and the genres nothing references.
|
|
// SAFETY: Hand-crafted orphan cleanup SQL. Parameterless.
|
|
result, err = tx.ExecContext(l.ctx,
|
|
`DELETE FROM albums WHERE id NOT IN (
|
|
SELECT DISTINCT album_id FROM audio_files WHERE album_id IS NOT NULL
|
|
)`)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not delete empty albums: %w", err)
|
|
}
|
|
|
|
albumsRemoved, _ := result.RowsAffected()
|
|
|
|
// Artists after albums: an artist is unreferenced only once the
|
|
// albums pointing at it are gone.
|
|
// SAFETY: Hand-crafted orphan cleanup SQL. Parameterless.
|
|
result, err = tx.ExecContext(l.ctx,
|
|
`DELETE FROM artists WHERE id NOT IN (
|
|
SELECT DISTINCT artist_id FROM audio_files WHERE artist_id IS NOT NULL
|
|
) AND id NOT IN (
|
|
SELECT DISTINCT artist_id FROM albums WHERE artist_id IS NOT NULL
|
|
)`)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not delete unreferenced artists: %w", err)
|
|
}
|
|
|
|
artistsRemoved, _ := result.RowsAffected()
|
|
|
|
// SAFETY: Hand-crafted orphan cleanup SQL. Parameterless.
|
|
result, err = tx.ExecContext(l.ctx,
|
|
`DELETE FROM genres WHERE id NOT IN (
|
|
SELECT DISTINCT genre_id FROM file_genres
|
|
)`)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("could not delete unused genres: %w", err)
|
|
}
|
|
|
|
genresRemoved, _ := result.RowsAffected()
|
|
|
|
// Collect and delete orphaned cover_art rows before the commit. The
|
|
// shared helper is the one place this sweep lives, so the scan path,
|
|
// RemoveFromLibrary and this removal cannot drift (#247).
|
|
orphanedCoverArtPaths, err := l.sweepOrphanedCoverArt(tx)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// 17. Delete the library's tagging queue. tagging_items holds a
|
|
// FOREIGN KEY to libraries with no ON DELETE clause, so leaving these
|
|
// rows behind makes the DELETE below fail the whole transaction and
|
|
// the library becomes unremovable. tagging_candidates is tied to
|
|
// tagging_items by ON DELETE CASCADE and goes with it.
|
|
// SAFETY: Hand-crafted DELETE — sqlc has no query for this. Parameterized.
|
|
if _, err := tx.ExecContext(l.ctx,
|
|
`DELETE FROM tagging_items WHERE library_id = ?`, id); err != nil {
|
|
return nil, fmt.Errorf("could not delete tagging items: %w", err)
|
|
}
|
|
|
|
// 18. Delete library row.
|
|
// SAFETY: Hand-crafted DELETE matching sqlc DeleteLibrary but within
|
|
// the same transaction. Parameterized.
|
|
if _, err := tx.ExecContext(l.ctx,
|
|
`DELETE FROM libraries WHERE id = ?`, id); err != nil {
|
|
return nil, fmt.Errorf("could not delete library: %w", err)
|
|
}
|
|
|
|
// 19. Commit transaction.
|
|
if err := tx.Commit(); err != nil {
|
|
return nil, fmt.Errorf("could not commit removal transaction: %w", err)
|
|
}
|
|
|
|
committed = true
|
|
|
|
// 20. FTS5 rebuild skipped — contentless FTS5 (content='') cannot
|
|
// delete individual rows, but stale entries are harmless: search
|
|
// queries JOIN against track_metadata which filters out deleted
|
|
// rows. The index is rebuilt on the next full rescan. Skipping
|
|
// avoids a costly full re-index of all remaining tracks (~10s for
|
|
// 25K tracks).
|
|
|
|
// Post-commit: remove the orphaned cover art files and their sized
|
|
// variants.
|
|
l.removeCoverArtFiles(orphanedCoverArtPaths)
|
|
|
|
// 22. Post-commit: Compact queue.
|
|
if l.removalHooks.CompactQueue != nil {
|
|
l.removalHooks.CompactQueue()
|
|
}
|
|
|
|
// 23. Post-commit: invalidate library-sync markers so the gated
|
|
// index/lyric re-sync runs on the next launch.
|
|
if l.removalHooks.PostRemove != nil {
|
|
l.removalHooks.PostRemove()
|
|
}
|
|
|
|
summary := &RemovalSummary{
|
|
TracksDeleted: tracksDeleted,
|
|
ArtistsRemoved: artistsRemoved,
|
|
AlbumsRemoved: albumsRemoved,
|
|
GenresRemoved: genresRemoved,
|
|
PlaylistsAffected: impact.PlaylistsAffected,
|
|
QueueItemsRemoved: impact.QueueItemCount,
|
|
}
|
|
|
|
// 22. Emit events.
|
|
l.emit(events.LibraryRemoved, map[string]any{
|
|
"id": id,
|
|
"summary": summary,
|
|
})
|
|
|
|
return summary, nil
|
|
}
|
|
|
|
// waitForScanIdle polls until the specified library is no longer the
|
|
// active scan target. Called after cancelLibraryScan to ensure the
|
|
// scan goroutine has finished before proceeding with removal.
|
|
func (l *Library) waitForScanIdle(id int64) {
|
|
for range 100 { // up to ~5 seconds
|
|
l.mu.Lock()
|
|
active := l.currentScanLibraryID == id
|
|
l.mu.Unlock()
|
|
|
|
if !active {
|
|
return
|
|
}
|
|
|
|
time.Sleep(50 * time.Millisecond)
|
|
}
|
|
|
|
l.logger.Warn("timed out waiting for scan to stop",
|
|
"libraryID", id)
|
|
}
|
|
|
|
// cancelLibraryScan cancels an active scan for the specified library
|
|
// and removes it from the scan queue.
|
|
func (l *Library) cancelLibraryScan(id int64) {
|
|
l.mu.Lock()
|
|
defer l.mu.Unlock()
|
|
|
|
// If this library is currently scanning, cancel it.
|
|
if l.currentScanLibraryID == id {
|
|
if l.scanCancel != nil {
|
|
l.scanCancel()
|
|
}
|
|
}
|
|
|
|
// Remove from the scan queue if queued.
|
|
filtered := l.scanQueue[:0]
|
|
|
|
for _, entry := range l.scanQueue {
|
|
if entry.libraryID != id {
|
|
filtered = append(filtered, entry)
|
|
}
|
|
}
|
|
|
|
l.scanQueue = filtered
|
|
}
|
|
|
|
// currentTrackBelongsToLibrary checks whether the currently-playing
|
|
// queue track belongs to the specified library.
|
|
func (l *Library) currentTrackBelongsToLibrary(libraryID int64) bool {
|
|
// SAFETY: Hand-crafted SQL to check if the current queue track belongs
|
|
// to the library being removed. Multi-table JOIN with subquery
|
|
// unsupported by sqlc. Parameterized.
|
|
count, err := querySingleInt64(l.ctx, l.db,
|
|
`SELECT COUNT(*) FROM audio_files af
|
|
JOIN queue_tracks qt ON qt.audio_file_id = af.id
|
|
WHERE af.library_id = ?
|
|
AND qt.position = (
|
|
SELECT current_position FROM queue LIMIT 1
|
|
)`,
|
|
libraryID,
|
|
)
|
|
if err != nil {
|
|
l.logger.Warn("could not check if current track belongs to library",
|
|
"libraryID", libraryID,
|
|
"err", err,
|
|
)
|
|
|
|
return false
|
|
}
|
|
|
|
return count > 0
|
|
}
|
|
|
|
// querySingleInt64 executes a query that returns a single integer value.
|
|
func querySingleInt64(
|
|
_ context.Context,
|
|
db *database.DB,
|
|
query string,
|
|
args ...any,
|
|
) (int64, error) {
|
|
rows, err := db.QueryContext(query, args...)
|
|
if err != nil {
|
|
return 0, err
|
|
}
|
|
|
|
defer func() { _ = rows.Close() }()
|
|
|
|
if !rows.Next() {
|
|
return 0, errQueryNoRows
|
|
}
|
|
|
|
var val int64
|
|
if err := rows.Scan(&val); err != nil {
|
|
return 0, err
|
|
}
|
|
|
|
return val, rows.Err()
|
|
}
|