ListenBrainz API listens exporter

backends/base.go

@@ -74,6 +74,7 @@ func ResolveBackend[T interface{}](config *viper.Viper) (T, error) {
 }
 
 var knownBackends = map[string]func() Backend{
-	"dump":          func() Backend { return &DumpBackend{} },
-	"scrobbler-log": func() Backend { return &ScrobblerLogBackend{} },
+	"dump":             func() Backend { return &DumpBackend{} },
+	"listenbrainz-api": func() Backend { return &ListenBrainzApiBackend{} },
+	"scrobbler-log":    func() Backend { return &ScrobblerLogBackend{} },
 }

backends/listenbrainz.go

@@ -0,0 +1,90 @@
+/*
+Copyright © 2023 Philipp Wolfer <phw@uploadedlobster.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+package backends
+
+import (
+	"time"
+
+	"github.com/spf13/viper"
+	"go.uploadedlobster.com/scotty/backends/listenbrainz"
+)
+
+type ListenBrainzApiBackend struct {
+	client   listenbrainz.Client
+	username string
+}
+
+func (b ListenBrainzApiBackend) FromConfig(config *viper.Viper) Backend {
+	b.client = listenbrainz.New(config.GetString("token"))
+	b.client.MaxResults = listenbrainz.MaxItemsPerGet
+	b.username = config.GetString("username")
+	return b
+}
+
+func (b ListenBrainzApiBackend) ExportListens(oldestTimestamp time.Time) ([]Listen, error) {
+	minTs := oldestTimestamp
+	listens := make([]Listen, 0)
+
+	for {
+		result, err := b.client.GetListens(b.username, minTs)
+		if err != nil {
+			return nil, err
+		}
+
+		count := len(result.Payload.Listens)
+		if count == 0 {
+			break
+		}
+
+		// Set minTs to the newest returned listen
+		minTs = time.Unix(result.Payload.Listens[0].ListenedAt, 0)
+
+		// Iterate over the returned listens in reverse order (oldest first)
+		for i := count - 1; i >= 0; i-- {
+			lbListen := result.Payload.Listens[i]
+			listens = append(listens, Listen{}.FromListenBrainz(lbListen))
+		}
+	}
+
+	return listens, nil
+}
+
+func (l Listen) FromListenBrainz(lbListen listenbrainz.Listen) Listen {
+	track := lbListen.TrackMetadata
+	listen := Listen{
+		ListenedAt: time.Unix(lbListen.ListenedAt, 0),
+		UserName:   lbListen.UserName,
+		Track: Track{
+			TrackName:        track.TrackName,
+			ReleaseName:      track.ReleaseName,
+			ArtistNames:      []string{track.ArtistName},
+			Duration:         track.Duration(),
+			TrackNumber:      track.TrackNumber(),
+			RecordingMbid:    MBID(track.RecordingMbid()),
+			ReleaseMbid:      MBID(track.ReleaseMbid()),
+			ReleaseGroupMbid: MBID(track.ReleaseGroupMbid()),
+			Isrc:             track.Isrc(),
+			AdditionalInfo:   track.AdditionalInfo,
+		},
+	}
+	return listen
+}

backends/listenbrainz/client.go

@@ -0,0 +1,67 @@
+/*
+Copyright © 2023 Philipp Wolfer <phw@uploadedlobster.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+package listenbrainz
+
+import (
+	"strconv"
+	"time"
+
+	"github.com/go-resty/resty/v2"
+)
+
+const listenBrainzBaseURL = "https://api.listenbrainz.org/1/"
+
+const DefaultItemsPerGet = 25
+const MaxItemsPerGet = 1000
+
+type Client struct {
+	resty      *resty.Client
+	MaxResults int
+}
+
+func New(token string) Client {
+	resty := resty.New()
+	resty.SetBaseURL(listenBrainzBaseURL)
+	resty.SetAuthScheme("Token")
+	resty.SetAuthToken(token)
+	resty.SetHeader("Accept", "application/json")
+	client := Client{
+		resty:      resty,
+		MaxResults: DefaultItemsPerGet,
+	}
+
+	return client
+}
+
+func (c Client) GetListens(user string, minTs time.Time) (GetListensResult, error) {
+	const path = "/user/{username}/listens"
+	result := &GetListensResult{}
+	_, err := c.resty.R().
+		SetPathParam("username", user).
+		SetQueryParams(map[string]string{
+			"min_ts": strconv.FormatInt(minTs.Unix(), 10),
+			"count":  strconv.FormatInt(int64(c.MaxResults), 10),
+		}).
+		SetResult(result).
+		Get(path)
+	return *result, err
+}

backends/listenbrainz/models.go

@@ -0,0 +1,95 @@
+/*
+Copyright © 2023 Philipp Wolfer <phw@uploadedlobster.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+package listenbrainz
+
+import (
+	"time"
+)
+
+type GetListensResult struct {
+	Payload GetListenPayload `json:"payload"`
+}
+
+type GetListenPayload struct {
+	Count                 int      `json:"count"`
+	UserName              string   `json:"user_id"`
+	LatestListenTimestamp int64    `json:"latest_listen_ts"`
+	Listens               []Listen `json:"listens"`
+}
+
+type Listen struct {
+	InsertedAt    int64  `json:"inserted_at"`
+	ListenedAt    int64  `json:"listened_at"`
+	RecordingMsid string `json:"recording_msid"`
+	UserName      string `json:"user_name"`
+	TrackMetadata Track  `json:"track_metadata"`
+}
+
+type Track struct {
+	TrackName      string         `json:"track_name"`
+	ArtistName     string         `json:"artist_name"`
+	ReleaseName    string         `json:"release_name"`
+	AdditionalInfo map[string]any `json:"additional_info"`
+}
+
+func (t Track) Duration() time.Duration {
+	var duration time.Duration
+	milliseconds, ok := t.AdditionalInfo["duration_ms"].(float64)
+	if ok {
+		duration = time.Duration(int(milliseconds) * int(time.Millisecond))
+	} else {
+		seconds, ok := t.AdditionalInfo["duration_ms"].(float64)
+		if ok {
+			duration = time.Duration(int(seconds) * int(time.Second))
+		}
+	}
+	return duration
+}
+
+func (t Track) TrackNumber() int {
+	return int(tryGetValue[float64](t, "tracknumber"))
+}
+
+func (t Track) Isrc() string {
+	return tryGetValue[string](t, "isrc")
+}
+
+func (t Track) RecordingMbid() string {
+	return tryGetValue[string](t, "recording_mbid")
+}
+
+func (t Track) ReleaseMbid() string {
+	return tryGetValue[string](t, "release_mbid")
+}
+
+func (t Track) ReleaseGroupMbid() string {
+	return tryGetValue[string](t, "release_group_mbid")
+}
+
+func tryGetValue[T any](track Track, key string) T {
+	var result T
+	value, ok := track.AdditionalInfo[key].(T)
+	if ok {
+		result = value
+	}
+	return result
+}

backends/models.go

@@ -28,7 +28,7 @@ import (
 
 type MBID string
 
-type AdditionalInfo map[string]string
+type AdditionalInfo map[string]any
 
 type Track struct {
 	TrackName        string

backends/scrobblerlog.go

@@ -130,8 +130,8 @@ func (b ScrobblerLogBackend) ImportListens(listens []Listen, oldestTimestamp tim
 
 		// A row is:
 		// artistName	releaseName	trackName	trackNumber	duration	rating	timestamp	recordingMbid
-		rating := listen.AdditionalInfo["rockbox_rating"]
-		if rating == "" {
+		rating, ok := listen.AdditionalInfo["rockbox_rating"].(string)
+		if !ok || rating == "" {
 			rating = "L"
 		}
 		tsvWriter.Write([]string{