package persistence import ( "context" "database/sql" "encoding/json" "errors" "fmt" "slices" "time" . "github.com/Masterminds/squirrel" "github.com/deluan/rest" "github.com/navidrome/navidrome/log" "github.com/navidrome/navidrome/model" "github.com/navidrome/navidrome/utils/slice" "github.com/pocketbase/dbx" ) type playlistRepository struct { sqlRepository } type dbPlaylist struct { model.Playlist `structs:",flatten"` Rules sql.NullString `structs:"-"` } func (p *dbPlaylist) PostScan() error { if p.Rules.String == "" { return nil } // Rules come from clients and .nsp files, so a bad one must not fail every query listing it if err := json.Unmarshal([]byte(p.Rules.String), &p.Playlist.Rules); err != nil { log.Warn("Ignoring invalid smart playlist rules", "playlist", p.Name, "id", p.ID, "rules", p.Rules.String, err) p.Playlist.Rules = nil } return nil } func (p dbPlaylist) PostMapArgs(args map[string]any) error { var err error if p.Playlist.IsSmartPlaylist() { args["rules"], err = json.Marshal(p.Playlist.Rules) if err != nil { return fmt.Errorf("invalid criteria expression: %w", err) } // Smart playlist counters are owned by refreshCounters (evaluation), never by callers delete(args, "song_count") delete(args, "duration") delete(args, "size") return nil } delete(args, "rules") return nil } func NewPlaylistRepository(db dbx.Builder) model.PlaylistRepository { r := &playlistRepository{} r.db = db r.registerModel(&model.Playlist{}, map[string]filterFunc{ "id": idFilter("playlist"), "q": playlistFilter, "smart": smartPlaylistFilter, "starred": annotationBoolFilter("starred"), }) r.setSortMappings(map[string]string{ "name": naturalSort("playlist.name"), "owner_name": naturalSort("owner_name"), }) return r } func playlistFilter(_ string, value any) Sqlizer { return Or{ substringFilter("playlist.name", value), substringFilter("playlist.comment", value), } } func smartPlaylistFilter(string, any) Sqlizer { return Or{ Eq{"rules": ""}, Eq{"rules": nil}, } } func (r *playlistRepository) userFilter(ctx context.Context) Sqlizer { user := loggedUser(ctx) if user.IsAdmin { return And{} } return Or{ Eq{"public": true}, Eq{"owner_id": user.ID}, } } func (r *playlistRepository) CountAll(ctx context.Context, options ...model.QueryOptions) (int64, error) { query := Select().Where(r.userFilter(ctx)) if filtersNeedAnnotation(r.applyFilters(query, options...)) { query = r.withAnnotation(ctx, query, "playlist.id") } return r.count(ctx, query, options...) } func (r *playlistRepository) Exists(ctx context.Context, id string) (bool, error) { return r.exists(ctx, And{Eq{"id": id}, r.userFilter(ctx)}) } func (r *playlistRepository) Delete(ctx context.Context, ids ...string) error { return r.delete(ctx, And{Eq{"id": ids}, r.userFilter(ctx)}) } func (r *playlistRepository) Put(ctx context.Context, p *model.Playlist, cols ...string) error { pls := dbPlaylist{Playlist: *p} if len(cols) > 0 { if pls.ID == "" { return errors.New("playlist id is required for partial update") } _, err := r.put(ctx, pls.ID, pls, cols...) return err } isNew := pls.ID == "" if isNew { pls.CreatedAt = time.Now() } pls.UpdatedAt = time.Now() id, err := r.put(ctx, pls.ID, pls) if err != nil { return err } p.ID = id if p.IsSmartPlaylist() { // Do not update tracks at this point, as it may take a long time and lock the DB, breaking the scan process return nil } // Only update tracks if they were specified if len(pls.Tracks) > 0 { return r.updateTracks(ctx, id, p.MediaFiles()) } pls.ID = id // r.put assigns the generated id to p, not to this copy if isNew { // Even a trackless new playlist has art to find (an imported m3u can carry an // ExternalImageURL); an update landing here changed only metadata, so leave its cover be. r.enqueueCoverRebuild(ctx, id) } return r.refreshCounters(ctx, &pls.Playlist) } func (r *playlistRepository) Get(ctx context.Context, id string) (*model.Playlist, error) { return r.findBy(ctx, And{Eq{"playlist.id": id}, r.userFilter(ctx)}) } func (r *playlistRepository) GetWithTracks(ctx context.Context, id string, refreshSmartPlaylist, includeMissing bool) (*model.Playlist, error) { pls, err := r.Get(ctx, id) if err != nil { return nil, err } if refreshSmartPlaylist { r.refreshSmartPlaylist(ctx, pls) } tracks, err := r.loadTracks(ctx, Select().From("playlist_tracks"). Where(Eq{"missing": false}). OrderBy("playlist_tracks.id"), id) if err != nil { log.Error(ctx, "Error loading playlist tracks ", "playlist", pls.Name, "id", pls.ID, err) return nil, err } pls.SetTracks(tracks) return pls, nil } func (r *playlistRepository) FindByPath(ctx context.Context, path string) (*model.Playlist, error) { return r.findBy(ctx, Eq{"path": path}) } func (r *playlistRepository) findBy(ctx context.Context, sql Sqlizer) (*model.Playlist, error) { sel := r.selectPlaylist(ctx).Where(sql) var pls []dbPlaylist err := r.queryAll(ctx, sel, &pls) if err != nil { return nil, err } if len(pls) == 0 { return nil, model.ErrNotFound } list := model.Playlists{pls[0].Playlist} r.hydrateArtwork(ctx, list) return &list[0], nil } func (r *playlistRepository) hydrateArtwork(ctx context.Context, playlists model.Playlists) { hydrateItems(ctx, r.db, model.KindPlaylistArtwork, playlists, func(p *model.Playlist) (string, *model.ItemImage) { return p.ID, &p.ItemImage }) } func (r *playlistRepository) GetAll(ctx context.Context, options ...model.QueryOptions) (model.Playlists, error) { sel := r.selectPlaylist(ctx, options...).Where(r.userFilter(ctx)) var res []dbPlaylist err := r.queryAll(ctx, sel, &res) if err != nil { return nil, err } playlists := make(model.Playlists, len(res)) for i, p := range res { playlists[i] = p.Playlist } r.hydrateArtwork(ctx, playlists) return playlists, err } // getAllIDs returns the IDs of GetAll's row set, skipping its per-row processing. func (r *playlistRepository) getAllIDs(ctx context.Context, options ...model.QueryOptions) ([]string, error) { // Joins a projection of user, not the table: its name/created_at columns would make an ORDER BY // on the playlist's own ambiguous. sq := r.newSelect(ctx, options...).Columns("playlist.id", "user.user_name as owner_name"). Join("(select id, user_name from user) user on user.id = owner_id").Where(r.userFilter(ctx)) if filtersNeedAnnotation(sq) { sq = r.withAnnotation(ctx, sq, "playlist.id") } ids := []string{} err := r.queryAllSlice(ctx, sq, &ids) return ids, err } func (r *playlistRepository) GetCursor(ctx context.Context, options ...model.QueryOptions) (model.PlaylistCursor, error) { // Both passes apply userFilter, so a visibility change between them cannot widen the cursor. ids, err := r.getAllIDs(ctx, options...) if err != nil { return nil, err } opts := chunkOptions(options, "playlist.id") return model.PlaylistCursor(streamByIDs(ids, func(chunk []string) (model.Playlists, error) { return r.GetAll(ctx, opts(chunk)) })), nil } func (r *playlistRepository) GetPlaylists(ctx context.Context, mediaFileId string) (model.Playlists, error) { sel := r.selectPlaylist(ctx, model.QueryOptions{Sort: "name"}). Join("playlist_tracks on playlist.id = playlist_tracks.playlist_id"). Where(And{Eq{"playlist_tracks.media_file_id": mediaFileId}, r.userFilter(ctx)}) var res []dbPlaylist err := r.queryAll(ctx, sel, &res) if err != nil { if errors.Is(err, model.ErrNotFound) { return model.Playlists{}, nil } return nil, err } playlists := make(model.Playlists, len(res)) for i, p := range res { playlists[i] = p.Playlist } r.hydrateArtwork(ctx, playlists) return playlists, nil } func (r *playlistRepository) selectPlaylist(ctx context.Context, options ...model.QueryOptions) SelectBuilder { sel := r.newSelect(ctx, options...).Join("user on user.id = owner_id"). Columns(r.tableName+".*", "user.user_name as owner_name") return r.withAnnotation(ctx, sel, r.tableName+".id") } func (r *playlistRepository) updateTracks(ctx context.Context, id string, tracks model.MediaFiles) error { ids := make([]string, len(tracks)) for i := range tracks { ids[i] = tracks[i].ID } return r.updatePlaylist(ctx, id, ids) } func (r *playlistRepository) updatePlaylist(ctx context.Context, playlistId string, mediaFileIds []string) error { // Remove old tracks del := Delete("playlist_tracks").Where(Eq{"playlist_id": playlistId}) _, err := r.executeSQL(ctx, del) if err != nil { return err } _, err = r.addTracks(ctx, playlistId, 1, mediaFileIds) return err } // addTracks is the only path that writes playlist_tracks rows (smart playlists aside), so it owns // the library and existence check: every caller, including a full replace through Put, goes through it. func (r *playlistRepository) addTracks(ctx context.Context, playlistId string, startingPos int, mediaFileIds []string) (int, error) { mediaFileIds, err := r.keepAccessible(ctx, mediaFileIds) if err != nil { return 0, err } // Break the track list in chunks to avoid hitting SQLITE_MAX_VARIABLE_NUMBER limit // Add new tracks, chunk by chunk pos := startingPos for chunk := range slices.Chunk(mediaFileIds, 200) { ins := Insert("playlist_tracks").Columns("playlist_id", "media_file_id", "id") for _, t := range chunk { ins = ins.Values(playlistId, t, pos) pos++ } if _, err := r.executeSQL(ctx, ins); err != nil { return 0, err } } r.enqueueCoverRebuild(ctx, playlistId) return len(mediaFileIds), r.refreshCounters(ctx, &model.Playlist{ID: playlistId}) } // keepAccessible drops ids the caller cannot read or that match no track, preserving order and duplicates. // Chunked because callers pass unbounded id lists (M3U import), well past SQLITE_MAX_VARIABLE_NUMBER. func (r *playlistRepository) keepAccessible(ctx context.Context, mediaFileIds []string) ([]string, error) { accessible := make(map[string]struct{}, len(mediaFileIds)) for chunk := range slices.Chunk(slice.Unique(mediaFileIds), 200) { sq := r.applyLibraryFilter(ctx, Select("id").From("media_file").Where(Eq{"id": chunk}), "media_file") var found []string if err := r.queryAllSlice(ctx, sq, &found); err != nil { return nil, err } for _, id := range found { accessible[id] = struct{}{} } } return slice.Filter(mediaFileIds, func(id string) bool { _, ok := accessible[id] return ok }), nil } // refreshCounters updates total playlist duration, size and count func (r *playlistRepository) refreshCounters(ctx context.Context, pls *model.Playlist) error { statsSql := Select( "coalesce(sum(duration), 0) as duration", "coalesce(sum(size), 0) as size", "count(*) as count", ). From("media_file"). Join("playlist_tracks f on f.media_file_id = media_file.id"). Where(Eq{"playlist_id": pls.ID}) var res struct{ Duration, Size, Count float32 } err := r.queryOne(ctx, statsSql, &res) if err != nil { return err } // Update playlist's total duration, size and count now := time.Now() upd := Update("playlist"). Set("duration", res.Duration). Set("size", res.Size). Set("song_count", res.Count). Set("updated_at", now). Where(Eq{"id": pls.ID}) _, err = r.executeSQL(ctx, upd) if err != nil { return err } pls.SongCount = int(res.Count) pls.Duration = res.Duration pls.Size = int64(res.Size) pls.UpdatedAt = now return nil } // enqueueCoverRebuild re-resolves the generated 2x2 grid. Call it only when the track set changes: // the grid samples albums at random, so rebuilding after a mere rename would change the cover. func (r *playlistRepository) enqueueCoverRebuild(ctx context.Context, id string) { item := model.ArtworkQueueItem{ItemKind: model.KindPlaylistArtwork.Prefix(), ItemID: id, ImageType: model.ImageTypePrimary, Priority: model.ArtworkPriorityScan} if err := NewArtworkQueueRepository(r.db).Enqueue(ctx, item); err != nil { log.Warn(ctx, "could not enqueue playlist artwork after content change", "id", id, err) } } // tracksQuery is shared by loadTracks and GetCursor, so both hydrate rows identically. func (r *playlistRepository) tracksQuery(ctx context.Context, query SelectBuilder, id string) SelectBuilder { query = r.applyLibraryFilter(ctx, query, "f") userID := loggedUser(ctx).ID return query. Columns( "coalesce(starred, 0) as starred", "starred_at", "coalesce(play_count, 0) as play_count", "play_date", "coalesce(rating, 0) as rating", "rated_at", "f.*", "playlist_tracks.*", "library.path as library_path", "library.name as library_name", ). LeftJoin("annotation on (" + "annotation.item_id = media_file_id" + " AND annotation.item_type = 'media_file'" + " AND annotation.user_id = '" + userID + "')"). Join("media_file f on f.id = media_file_id"). Join("library on f.library_id = library.id"). Where(Eq{"playlist_id": id}) } func (r *playlistRepository) loadTracks(ctx context.Context, query SelectBuilder, id string) (model.PlaylistTracks, error) { tracks := dbPlaylistTracks{} err := r.queryAll(ctx, r.tracksQuery(ctx, query, id), &tracks) if err != nil { return nil, err } res := tracks.toModels() hydratePlaylistTrackArtwork(ctx, r.db, res) return res, err } func (r *playlistRepository) Count(ctx context.Context, options ...rest.QueryOptions) (int64, error) { return r.CountAll(ctx, r.parseRestOptions(ctx, options...)) } func (r *playlistRepository) Read(ctx context.Context, id string) (*model.Playlist, error) { return r.Get(ctx, id) } func (r *playlistRepository) ReadAll(ctx context.Context, options ...rest.QueryOptions) ([]model.Playlist, error) { return r.GetAll(ctx, r.parseRestOptions(ctx, options...)) } func (r *playlistRepository) Save(ctx context.Context, pls *model.Playlist) (string, error) { pls.ID = "" // Force new creation err := r.Put(ctx, pls) if err != nil { return "", err } return pls.ID, err } func (r *playlistRepository) Update(ctx context.Context, id string, entity model.Playlist, cols ...string) error { pls := dbPlaylist{Playlist: entity} pls.ID = id pls.UpdatedAt = time.Now() _, err := r.put(ctx, id, pls, append(cols, "updatedAt")...) return err } func (r *playlistRepository) removeOrphans(ctx context.Context) error { sel := Select("playlist_tracks.playlist_id as id", "p.name").From("playlist_tracks"). Join("playlist p on playlist_tracks.playlist_id = p.id"). LeftJoin("media_file mf on playlist_tracks.media_file_id = mf.id"). Where(Eq{"mf.id": nil}). GroupBy("playlist_tracks.playlist_id") var pls []struct{ Id, Name string } err := r.queryAll(ctx, sel, &pls) if err != nil { return fmt.Errorf("fetching playlists with orphan tracks: %w", err) } for _, pl := range pls { log.Debug(ctx, "Cleaning-up orphan tracks from playlist", "id", pl.Id, "name", pl.Name) del := Delete("playlist_tracks").Where(And{ ConcatExpr("media_file_id not in (select id from media_file)"), Eq{"playlist_id": pl.Id}, }) n, err := r.executeSQL(ctx, del) if n == 0 || err != nil { return fmt.Errorf("deleting orphan tracks from playlist %s: %w", pl.Name, err) } log.Debug(ctx, "Deleted tracks, now reordering", "id", pl.Id, "name", pl.Name, "deleted", n) // Renumber the playlist if any track was removed if err := r.renumber(ctx, pl.Id); err != nil { return fmt.Errorf("renumbering playlist %s: %w", pl.Name, err) } } return nil } // renumber updates the position of all tracks in the playlist to be sequential starting from 1, ordered by their // current position. This is needed after removing orphan tracks, to ensure there are no gaps in the track numbering. // The two-step approach (negate then reassign via CTE) avoids UNIQUE constraint violations on (playlist_id, id). func (r *playlistRepository) renumber(ctx context.Context, id string) error { // Step 1: Negate all IDs to clear the positive ID space _, err := r.executeSQL(ctx, Expr( `UPDATE playlist_tracks SET id = -id WHERE playlist_id = ? AND id > 0`, id)) if err != nil { return err } // Step 2: Assign new sequential positive IDs using UPDATE...FROM with a CTE. // The CTE is fully materialized before the UPDATE begins, avoiding self-referencing issues. // ORDER BY id DESC restores original order since IDs are now negative. _, err = r.executeSQL(ctx, Expr( `WITH new_ids AS ( SELECT rowid as rid, ROW_NUMBER() OVER (ORDER BY id DESC) as new_id FROM playlist_tracks WHERE playlist_id = ? ) UPDATE playlist_tracks SET id = new_ids.new_id FROM new_ids WHERE playlist_tracks.rowid = new_ids.rid AND playlist_tracks.playlist_id = ?`, id, id)) if err != nil { return err } r.enqueueCoverRebuild(ctx, id) return r.refreshCounters(ctx, &model.Playlist{ID: id}) } var _ model.PlaylistRepository = (*playlistRepository)(nil) var _ rest.Repository[model.Playlist] = (*playlistRepository)(nil) var _ rest.Persistable[model.Playlist] = (*playlistRepository)(nil)