feat(subsonic): return playCount in album responses

closes #458
sentriz · Jan 18, 2024 · ec55f3b · ec55f3b
1 parent 87943ea
commit ec55f3b
Show file tree

Hide file tree

Showing 18 changed files with 245 additions and 143 deletions.
diff --git a/db/db.go b/db/db.go
@@ -339,6 +339,7 @@ type Album struct {
 	AlbumStar      *AlbumStar
 	AlbumRating    *AlbumRating
 	AverageRating  float64 `sql:"default: null"`
+	Play           *Play
 }
 
 func (a *Album) SID() *specid.ID {

diff --git a/server/ctrlsubsonic/handlers_by_tags.go b/server/ctrlsubsonic/handlers_by_tags.go
@@ -117,6 +117,8 @@ func (c *Controller) ServeGetAlbum(r *http.Request) *spec.Response {
 		}).
 		Preload("AlbumStar", "user_id=?", user.ID).
 		Preload("AlbumRating", "user_id=?", user.ID).
+		Preload("AlbumRating", "user_id=?", user.ID).
+		Preload("Play", "user_id=?", user.ID).
 		First(album, id.Value).
 		Error
 	if errors.Is(err, gorm.ErrRecordNotFound) {
@@ -199,6 +201,7 @@ func (c *Controller) ServeGetAlbumListTwo(r *http.Request) *spec.Response {
 		Preload("Artists").
 		Preload("AlbumStar", "user_id=?", user.ID).
 		Preload("AlbumRating", "user_id=?", user.ID).
+		Preload("Play", "user_id=?", user.ID).
 		Find(&albums)
 	sub := spec.NewResponse()
 	sub.AlbumsTwo = &spec.Albums{
@@ -256,7 +259,8 @@ func (c *Controller) ServeSearchThree(r *http.Request) *spec.Response {
 		Preload("Artists").
 		Preload("Genres").
 		Preload("AlbumStar", "user_id=?", user.ID).
-		Preload("AlbumRating", "user_id=?", user.ID)
+		Preload("AlbumRating", "user_id=?", user.ID).
+		Preload("Play", "user_id=?", user.ID)
 	for _, s := range queries {
 		q = q.Where(`tag_title LIKE ? OR tag_title_u_dec LIKE ?`, s, s)
 	}
@@ -517,7 +521,8 @@ func (c *Controller) ServeGetStarredTwo(r *http.Request) *spec.Response {
 		Order("album_stars.star_date DESC").
 		Preload("Artists").
 		Preload("AlbumStar", "user_id=?", user.ID).
-		Preload("AlbumRating", "user_id=?", user.ID)
+		Preload("AlbumRating", "user_id=?", user.ID).
+		Preload("Play", "user_id=?", user.ID)
 	if m := getMusicFolder(c.musicPaths, params); m != "" {
 		q = q.Where("albums.root_dir=?", m)
 	}

diff --git a/server/ctrlsubsonic/spec/construct_by_tags.go b/server/ctrlsubsonic/spec/construct_by_tags.go
@@ -51,6 +51,9 @@ func NewAlbumByTags(a *db.Album, artists []*db.Artist) *Album {
 	for _, g := range a.Genres {
 		ret.Genres = append(ret.Genres, &GenreRef{Name: g.Name})
 	}
+	if a.Play != nil {
+		ret.PlayCount = a.Play.Count
+	}
 	return ret
 }
 

diff --git a/server/ctrlsubsonic/spec/spec.go b/server/ctrlsubsonic/spec/spec.go
@@ -144,6 +144,7 @@ type Album struct {
 	Name       string        `xml:"name,attr"              json:"name"`
 	TrackCount int           `xml:"songCount,attr"         json:"songCount"`
 	Duration   int           `xml:"duration,attr"          json:"duration"`
+	PlayCount  int           `xml:"playCount,attr"          json:"playCount"`
 	Genre      string        `xml:"genre,attr,omitempty"   json:"genre,omitempty"`
 	Genres     []*GenreRef   `xml:"genres,omitempty"       json:"genres,omitempty"`
 	Year       int           `xml:"year,attr,omitempty"    json:"year,omitempty"`

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_alpha_artist b/server/ctrlsubsonic/testdata/test_get_album_list_alpha_artist
@@ -20,7 +20,8 @@
           "coverArt": "al-3",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-4",
@@ -35,7 +36,8 @@
           "coverArt": "al-4",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-5",
@@ -50,7 +52,8 @@
           "coverArt": "al-5",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-7",
@@ -65,7 +68,8 @@
           "coverArt": "al-7",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-8",
@@ -80,7 +84,8 @@
           "coverArt": "al-8",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-9",
@@ -95,7 +100,8 @@
           "coverArt": "al-9",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-11",
@@ -110,7 +116,8 @@
           "coverArt": "al-11",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-12",
@@ -125,7 +132,8 @@
           "coverArt": "al-12",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-13",
@@ -140,7 +148,8 @@
           "coverArt": "al-13",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         }
       ]
     }

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_alpha_name b/server/ctrlsubsonic/testdata/test_get_album_list_alpha_name
@@ -20,7 +20,8 @@
           "coverArt": "al-3",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-7",
@@ -35,7 +36,8 @@
           "coverArt": "al-7",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-11",
@@ -50,7 +52,8 @@
           "coverArt": "al-11",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-4",
@@ -65,7 +68,8 @@
           "coverArt": "al-4",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-8",
@@ -80,7 +84,8 @@
           "coverArt": "al-8",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-12",
@@ -95,7 +100,8 @@
           "coverArt": "al-12",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-5",
@@ -110,7 +116,8 @@
           "coverArt": "al-5",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-9",
@@ -125,7 +132,8 @@
           "coverArt": "al-9",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-13",
@@ -140,7 +148,8 @@
           "coverArt": "al-13",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         }
       ]
     }

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_newest b/server/ctrlsubsonic/testdata/test_get_album_list_newest
@@ -20,7 +20,8 @@
           "coverArt": "al-3",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-4",
@@ -35,7 +36,8 @@
           "coverArt": "al-4",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-5",
@@ -50,7 +52,8 @@
           "coverArt": "al-5",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-7",
@@ -65,7 +68,8 @@
           "coverArt": "al-7",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-8",
@@ -80,7 +84,8 @@
           "coverArt": "al-8",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-9",
@@ -95,7 +100,8 @@
           "coverArt": "al-9",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-11",
@@ -110,7 +116,8 @@
           "coverArt": "al-11",
           "name": "album-0",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-12",
@@ -125,7 +132,8 @@
           "coverArt": "al-12",
           "name": "album-1",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         },
         {
           "id": "al-13",
@@ -140,7 +148,8 @@
           "coverArt": "al-13",
           "name": "album-2",
           "songCount": 3,
-          "duration": 300
+          "duration": 300,
+          "playCount": 0
         }
       ]
     }