* feat(req): add Float64Or helper for parsing float query params * feat(scrobbler): extend NowPlayingInfo with state/position/rate fields * feat(scrobbler): implement ReportPlayback with state machine and auto-scrobble * feat(responses): add state/positionMs/playbackRate to NowPlayingEntry * feat(subsonic): add reportPlayback endpoint handler * feat(subsonic): include state/positionMs/playbackRate in getNowPlaying response * feat(subsonic): register playbackReport OpenSubsonic extension * test(e2e): add reportPlayback endpoint e2e tests * refactor(scrobbler): simplify ReportPlayback — extract helpers, remove duplication - Add state constants and exported ValidStates map - Extract remainingTTL() helper (was duplicated 3x) - Merge playing/paused switch cases into single branch - Use Get instead of GetWithParticipants for non-stopped states - Guard NowPlayingCount broadcast with count-change detection - Use cache entry for NowPlaying dispatch instead of extra DB query - Remove redundant Position field from NowPlayingInfo * refactor(scrobbler): skip DB query in playing/paused when playMap has entry * fix(play_tracker): handle errors when adding/updating NowPlayingInfo in cache Signed-off-by: Deluan <deluan@navidrome.org> * refactor(play_tracker): replace sort with slices.SortFunc for NowPlayingInfo Signed-off-by: Deluan <deluan@navidrome.org> * fix(play_tracker): check all ReportPlayback errors in tests Replace _ = with explicit error assertions to avoid masking failures in intermediate calls. Signed-off-by: Deluan <deluan@navidrome.org> * test(e2e): use real PlayTracker and assert getNowPlaying after reportPlayback Replace noopPlayTracker with a real PlayTracker backed by the E2E database. E2E tests now verify the full round-trip: reportPlayback creates/updates/removes entries visible via getNowPlaying, including state, positionMs, and playbackRate fields. Export NewPlayTracker constructor for use outside the scrobbler package. * fix(play_tracker): account for playback rate in TTL and detect track switches The remainingTTL function now divides remaining time by the playback rate, so cache entries expire correctly at non-1x speeds (e.g., 2x playback halves the TTL). Zero/negative rates default to 1.0. The playing/paused case now checks if the cached MediaFile ID matches the reported mediaId, falling back to a DB fetch when the client switches tracks without sending stopped/starting. Adds parameterized tests for remainingTTL covering rate variations and edge cases. * fix(subsonic): validate positionMs and playbackRate in reportPlayback Reject negative positionMs values and invalid playbackRate values (NaN, Inf, zero, negative) at the API boundary before they reach TTL and position estimation math. Returns clear error messages for each case. * feat(play_tracker): add ClientId and ClientName to ReportPlayback parameters Signed-off-by: Deluan <deluan@navidrome.org> * refactor(play_tracker): replace NowPlaying method with ReportPlayback calls Signed-off-by: Deluan <deluan@navidrome.org> * refactor(play_tracker_test): remove redundant TTL behavior tests and clean up mockPluginLoader Signed-off-by: Deluan <deluan@navidrome.org> --------- Signed-off-by: Deluan <deluan@navidrome.org>
288 lines
8.2 KiB
Go
288 lines
8.2 KiB
Go
package subsonic
|
|
|
|
import (
|
|
"context"
|
|
"net/http"
|
|
"strconv"
|
|
"time"
|
|
|
|
"github.com/navidrome/navidrome/core/scrobbler"
|
|
"github.com/navidrome/navidrome/log"
|
|
"github.com/navidrome/navidrome/model"
|
|
"github.com/navidrome/navidrome/server/subsonic/filter"
|
|
"github.com/navidrome/navidrome/server/subsonic/responses"
|
|
"github.com/navidrome/navidrome/utils/req"
|
|
"github.com/navidrome/navidrome/utils/run"
|
|
"github.com/navidrome/navidrome/utils/slice"
|
|
)
|
|
|
|
func (api *Router) getAlbumList(r *http.Request) (model.Albums, int64, error) {
|
|
p := req.Params(r)
|
|
typ, err := p.String("type")
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
|
|
var opts filter.Options
|
|
switch typ {
|
|
case "newest":
|
|
opts = filter.AlbumsByNewest()
|
|
case "recent":
|
|
opts = filter.AlbumsByRecent()
|
|
case "random":
|
|
opts = filter.AlbumsByRandom()
|
|
case "alphabeticalByName":
|
|
opts = filter.AlbumsByName()
|
|
case "alphabeticalByArtist":
|
|
opts = filter.AlbumsByArtist()
|
|
case "frequent":
|
|
opts = filter.AlbumsByFrequent()
|
|
case "starred":
|
|
opts = filter.ByStarred()
|
|
case "highest":
|
|
opts = filter.ByRating()
|
|
case "byGenre":
|
|
genre, err := p.String("genre")
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
opts = filter.ByGenre(genre)
|
|
case "byYear":
|
|
fromYear, err := p.Int("fromYear")
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
toYear, err := p.Int("toYear")
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
opts = filter.AlbumsByYear(fromYear, toYear)
|
|
default:
|
|
log.Error(r, "albumList type not implemented", "type", typ)
|
|
return nil, 0, newError(responses.ErrorGeneric, "type '%s' not implemented", typ)
|
|
}
|
|
|
|
// Get optional library IDs from musicFolderId parameter
|
|
musicFolderIds, err := selectedMusicFolderIds(r, false)
|
|
if err != nil {
|
|
return nil, 0, err
|
|
}
|
|
opts = filter.ApplyLibraryFilter(opts, musicFolderIds)
|
|
|
|
opts.Offset = p.IntOr("offset", 0)
|
|
opts.Max = min(p.IntOr("size", 10), 500)
|
|
albums, err := api.ds.Album(r.Context()).GetAll(opts)
|
|
|
|
if err != nil {
|
|
log.Error(r, "Error retrieving albums", err)
|
|
return nil, 0, newError(responses.ErrorGeneric, "internal error")
|
|
}
|
|
|
|
count, err := api.ds.Album(r.Context()).CountAll(opts)
|
|
if err != nil {
|
|
log.Error(r, "Error counting albums", err)
|
|
return nil, 0, newError(responses.ErrorGeneric, "internal error")
|
|
}
|
|
|
|
return albums, count, nil
|
|
}
|
|
|
|
func (api *Router) GetAlbumList(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
|
|
albums, count, err := api.getAlbumList(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
w.Header().Set("x-total-count", strconv.Itoa(int(count)))
|
|
|
|
response := newResponse()
|
|
response.AlbumList = &responses.AlbumList{
|
|
Album: slice.MapWithArg(albums, r.Context(), childFromAlbum),
|
|
}
|
|
return response, nil
|
|
}
|
|
|
|
func (api *Router) GetAlbumList2(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
|
|
albums, pageCount, err := api.getAlbumList(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
w.Header().Set("x-total-count", strconv.FormatInt(pageCount, 10))
|
|
|
|
response := newResponse()
|
|
response.AlbumList2 = &responses.AlbumList2{
|
|
Album: slice.MapWithArg(albums, r.Context(), buildAlbumID3),
|
|
}
|
|
return response, nil
|
|
}
|
|
|
|
func (api *Router) getStarredItems(r *http.Request) (model.Artists, model.Albums, model.MediaFiles, error) {
|
|
ctx := r.Context()
|
|
|
|
// Get optional library IDs from musicFolderId parameter
|
|
musicFolderIds, err := selectedMusicFolderIds(r, false)
|
|
if err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
|
|
// Prepare variables to capture results from parallel execution
|
|
var artists model.Artists
|
|
var albums model.Albums
|
|
var mediaFiles model.MediaFiles
|
|
|
|
// Execute all three queries in parallel for better performance
|
|
err = run.Parallel(
|
|
// Query starred artists
|
|
func() error {
|
|
artistOpts := filter.ApplyArtistLibraryFilter(filter.ArtistsByStarred(), musicFolderIds)
|
|
var err error
|
|
artists, err = api.ds.Artist(ctx).GetAll(artistOpts)
|
|
if err != nil {
|
|
log.Error(r, "Error retrieving starred artists", err)
|
|
}
|
|
return err
|
|
},
|
|
// Query starred albums
|
|
func() error {
|
|
albumOpts := filter.ApplyLibraryFilter(filter.ByStarred(), musicFolderIds)
|
|
var err error
|
|
albums, err = api.ds.Album(ctx).GetAll(albumOpts)
|
|
if err != nil {
|
|
log.Error(r, "Error retrieving starred albums", err)
|
|
}
|
|
return err
|
|
},
|
|
// Query starred media files
|
|
func() error {
|
|
mediaFileOpts := filter.ApplyLibraryFilter(filter.ByStarred(), musicFolderIds)
|
|
var err error
|
|
mediaFiles, err = api.ds.MediaFile(ctx).GetAll(mediaFileOpts)
|
|
if err != nil {
|
|
log.Error(r, "Error retrieving starred mediaFiles", err)
|
|
}
|
|
return err
|
|
},
|
|
)()
|
|
|
|
// Return the first error if any occurred
|
|
if err != nil {
|
|
return nil, nil, nil, err
|
|
}
|
|
|
|
return artists, albums, mediaFiles, nil
|
|
}
|
|
|
|
func (api *Router) GetStarred(r *http.Request) (*responses.Subsonic, error) {
|
|
artists, albums, mediaFiles, err := api.getStarredItems(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
response := newResponse()
|
|
response.Starred = &responses.Starred{}
|
|
response.Starred.Artist = slice.MapWithArg(artists, r, toArtist)
|
|
response.Starred.Album = slice.MapWithArg(albums, r.Context(), childFromAlbum)
|
|
response.Starred.Song = slice.MapWithArg(mediaFiles, r.Context(), childFromMediaFile)
|
|
return response, nil
|
|
}
|
|
|
|
func (api *Router) GetStarred2(r *http.Request) (*responses.Subsonic, error) {
|
|
artists, albums, mediaFiles, err := api.getStarredItems(r)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
response := newResponse()
|
|
response.Starred2 = &responses.Starred2{}
|
|
response.Starred2.Artist = slice.MapWithArg(artists, r, toArtistID3)
|
|
response.Starred2.Album = slice.MapWithArg(albums, r.Context(), buildAlbumID3)
|
|
response.Starred2.Song = slice.MapWithArg(mediaFiles, r.Context(), childFromMediaFile)
|
|
return response, nil
|
|
}
|
|
|
|
func (api *Router) GetNowPlaying(r *http.Request) (*responses.Subsonic, error) {
|
|
ctx := r.Context()
|
|
npInfo, err := api.scrobbler.GetNowPlaying(ctx)
|
|
if err != nil {
|
|
log.Error(r, "Error retrieving now playing list", err)
|
|
return nil, err
|
|
}
|
|
|
|
response := newResponse()
|
|
response.NowPlaying = &responses.NowPlaying{}
|
|
var i int32
|
|
response.NowPlaying.Entry = slice.Map(npInfo, func(np scrobbler.NowPlayingInfo) responses.NowPlayingEntry {
|
|
return responses.NowPlayingEntry{
|
|
Child: childFromMediaFile(ctx, np.MediaFile),
|
|
UserName: np.Username,
|
|
MinutesAgo: int32(time.Since(np.Start).Minutes()),
|
|
PlayerId: i + 1, // Fake numeric playerId, it does not seem to be used for anything
|
|
PlayerName: np.PlayerName,
|
|
State: np.State,
|
|
PositionMs: np.PositionMs,
|
|
PlaybackRate: np.PlaybackRate,
|
|
}
|
|
})
|
|
return response, nil
|
|
}
|
|
|
|
func (api *Router) GetRandomSongs(r *http.Request) (*responses.Subsonic, error) {
|
|
p := req.Params(r)
|
|
size := min(p.IntOr("size", 10), 500)
|
|
genre, _ := p.String("genre")
|
|
fromYear := p.IntOr("fromYear", 0)
|
|
toYear := p.IntOr("toYear", 0)
|
|
|
|
// Get optional library IDs from musicFolderId parameter
|
|
musicFolderIds, err := selectedMusicFolderIds(r, false)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
opts := filter.SongsByRandom(genre, fromYear, toYear)
|
|
opts = filter.ApplyLibraryFilter(opts, musicFolderIds)
|
|
|
|
songs, err := api.getSongs(r.Context(), 0, size, opts)
|
|
if err != nil {
|
|
log.Error(r, "Error retrieving random songs", err)
|
|
return nil, err
|
|
}
|
|
|
|
response := newResponse()
|
|
response.RandomSongs = &responses.Songs{}
|
|
response.RandomSongs.Songs = slice.MapWithArg(songs, r.Context(), childFromMediaFile)
|
|
return response, nil
|
|
}
|
|
|
|
func (api *Router) GetSongsByGenre(r *http.Request) (*responses.Subsonic, error) {
|
|
p := req.Params(r)
|
|
count := min(p.IntOr("count", 10), 500)
|
|
offset := p.IntOr("offset", 0)
|
|
genre, _ := p.String("genre")
|
|
|
|
// Get optional library IDs from musicFolderId parameter
|
|
musicFolderIds, err := selectedMusicFolderIds(r, false)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
opts := filter.ByGenre(genre)
|
|
opts = filter.ApplyLibraryFilter(opts, musicFolderIds)
|
|
|
|
ctx := r.Context()
|
|
songs, err := api.getSongs(ctx, offset, count, opts)
|
|
if err != nil {
|
|
log.Error(r, "Error retrieving random songs", err)
|
|
return nil, err
|
|
}
|
|
|
|
response := newResponse()
|
|
response.SongsByGenre = &responses.Songs{}
|
|
response.SongsByGenre.Songs = slice.MapWithArg(songs, ctx, childFromMediaFile)
|
|
return response, nil
|
|
}
|
|
|
|
func (api *Router) getSongs(ctx context.Context, offset, size int, opts filter.Options) (model.MediaFiles, error) {
|
|
opts.Offset = offset
|
|
opts.Max = size
|
|
return api.ds.MediaFile(ctx).GetAll(opts)
|
|
}
|