feat(subsonic): add getOpenSubsonicExtensions endpoint and openSubson…

…ic response key
sentriz · Sep 28, 2023 · 2caee44 · 2caee44
1 parent e0b1603
commit 2caee44
Show file tree

Hide file tree

Showing 30 changed files with 122 additions and 82 deletions.
diff --git a/server/ctrlsubsonic/handlers_common.go b/server/ctrlsubsonic/handlers_common.go
@@ -35,6 +35,12 @@ func (c *Controller) ServePing(_ *http.Request) *spec.Response {
 	return spec.NewResponse()
 }
 
+func (c *Controller) ServeGetOpenSubsonicExtensions(_ *http.Request) *spec.Response {
+	sub := spec.NewResponse()
+	sub.OpenSubsonicExtensions = spec.OpenSubsonicExtensions{}
+	return sub
+}
+
 func (c *Controller) ServeScrobble(r *http.Request) *spec.Response {
 	user := r.Context().Value(CtxUser).(*db.User)
 	params := r.Context().Value(CtxParams).(params.Params)

diff --git a/server/ctrlsubsonic/routes.go b/server/ctrlsubsonic/routes.go
@@ -9,9 +9,11 @@ func AddRoutes(c *Controller, r *mux.Router) {
 
 	// common
 	r.Handle("/getLicense{_:(?:\\.view)?}", c.H(c.ServeGetLicence))
+	r.Handle("/ping{_:(?:\\.view)?}", c.H(c.ServePing))
+	r.Handle("/getOpenSubsonicExtensions{_:(?:\\.view)?}", c.H(c.ServeGetOpenSubsonicExtensions))
+
 	r.Handle("/getMusicFolders{_:(?:\\.view)?}", c.H(c.ServeGetMusicFolders))
 	r.Handle("/getScanStatus{_:(?:\\.view)?}", c.H(c.ServeGetScanStatus))
-	r.Handle("/ping{_:(?:\\.view)?}", c.H(c.ServePing))
 	r.Handle("/scrobble{_:(?:\\.view)?}", c.H(c.ServeScrobble))
 	r.Handle("/startScan{_:(?:\\.view)?}", c.H(c.ServeStartScan))
 	r.Handle("/getUser{_:(?:\\.view)?}", c.H(c.ServeGetUser))

diff --git a/server/ctrlsubsonic/spec/spec.go b/server/ctrlsubsonic/spec/spec.go
@@ -26,8 +26,10 @@ type Response struct {
 	XMLNS   string `xml:"xmlns,attr"            json:"-"`
 
 	// https://opensubsonic.netlify.app/docs/responses/subsonic-response/
-	Type          string `xml:"type,attr"          json:"type"`
-	ServerVersion string `xml:"serverVersion,attr" json:"serverVersion"`
+	Type                   string                 `xml:"type,attr"              json:"type"`
+	ServerVersion          string                 `xml:"serverVersion,attr"     json:"serverVersion"`
+	OpenSubsonic           bool                   `xml:"openSubsonic,attr"      json:"openSubsonic"`
+	OpenSubsonicExtensions OpenSubsonicExtensions `xml:"openSubsonicExtensions" json:"openSubsonicExtensions,omitempty"`
 
 	Error                 *Error                 `xml:"error"                 json:"error,omitempty"`
 	Albums                *Albums                `xml:"albumList"             json:"albumList,omitempty"`
@@ -73,6 +75,7 @@ func NewResponse() *Response {
 		Version:       apiVersion,
 		Type:          gonic.Name,
 		ServerVersion: gonic.Version,
+		OpenSubsonic:  true,
 	}
 }
 
@@ -429,6 +432,8 @@ type Lyrics struct {
 	Title  string `xml:"title,attr,omitempty"  json:"title,omitempty"`
 }
 
+type OpenSubsonicExtensions map[string][]int
+
 func formatRating(rating float64) string {
 	if rating == 0 {
 		return ""

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_alpha_artist b/server/ctrlsubsonic/testdata/test_get_album_list_alpha_artist
@@ -4,6 +4,7 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList": {
       "album": [
         {

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_alpha_name b/server/ctrlsubsonic/testdata/test_get_album_list_alpha_name
@@ -4,6 +4,7 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList": {
       "album": [
         {

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_newest b/server/ctrlsubsonic/testdata/test_get_album_list_newest
@@ -4,6 +4,7 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList": {
       "album": [
         {

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_random b/server/ctrlsubsonic/testdata/test_get_album_list_random
@@ -4,16 +4,30 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList": {
       "album": [
         {
-          "id": "al-3",
-          "coverArt": "al-3",
-          "artist": "artist-0",
+          "id": "al-12",
+          "coverArt": "al-12",
+          "artist": "artist-2",
           "created": "2019-11-30T00:00:00Z",
-          "title": "album-0",
+          "title": "album-1",
           "album": "",
-          "parent": "al-2",
+          "parent": "al-10",
+          "isDir": true,
+          "name": "",
+          "songCount": 3,
+          "duration": 300
+        },
+        {
+          "id": "al-9",
+          "coverArt": "al-9",
+          "artist": "artist-1",
+          "created": "2019-11-30T00:00:00Z",
+          "title": "album-2",
+          "album": "",
+          "parent": "al-6",
           "isDir": true,
           "name": "",
           "songCount": 3,
@@ -33,63 +47,63 @@
           "duration": 300
         },
         {
-          "id": "al-7",
-          "coverArt": "al-7",
-          "artist": "artist-1",
+          "id": "al-3",
+          "coverArt": "al-3",
+          "artist": "artist-0",
           "created": "2019-11-30T00:00:00Z",
           "title": "album-0",
           "album": "",
-          "parent": "al-6",
+          "parent": "al-2",
           "isDir": true,
           "name": "",
           "songCount": 3,
           "duration": 300
         },
         {
-          "id": "al-5",
-          "coverArt": "al-5",
-          "artist": "artist-0",
+          "id": "al-8",
+          "coverArt": "al-8",
+          "artist": "artist-1",
           "created": "2019-11-30T00:00:00Z",
-          "title": "album-2",
+          "title": "album-1",
           "album": "",
-          "parent": "al-2",
+          "parent": "al-6",
           "isDir": true,
           "name": "",
           "songCount": 3,
           "duration": 300
         },
         {
-          "id": "al-12",
-          "coverArt": "al-12",
-          "artist": "artist-2",
+          "id": "al-5",
+          "coverArt": "al-5",
+          "artist": "artist-0",
           "created": "2019-11-30T00:00:00Z",
-          "title": "album-1",
+          "title": "album-2",
           "album": "",
-          "parent": "al-10",
+          "parent": "al-2",
           "isDir": true,
           "name": "",
           "songCount": 3,
           "duration": 300
         },
         {
-          "id": "al-8",
-          "coverArt": "al-8",
-          "artist": "artist-1",
+          "id": "al-4",
+          "coverArt": "al-4",
+          "artist": "artist-0",
           "created": "2019-11-30T00:00:00Z",
           "title": "album-1",
           "album": "",
-          "parent": "al-6",
+          "parent": "al-2",
           "isDir": true,
           "name": "",
           "songCount": 3,
           "duration": 300
         },
         {
-          "id": "al-9",
-          "coverArt": "al-9",
+          "id": "al-7",
+          "coverArt": "al-7",
           "artist": "artist-1",
           "created": "2019-11-30T00:00:00Z",
-          "title": "album-2",
+          "title": "album-0",
           "album": "",
           "parent": "al-6",
           "isDir": true,
@@ -109,19 +123,6 @@
           "name": "",
           "songCount": 3,
           "duration": 300
-        },
-        {
-          "id": "al-4",
-          "coverArt": "al-4",
-          "artist": "artist-0",
-          "created": "2019-11-30T00:00:00Z",
-          "title": "album-1",
-          "album": "",
-          "parent": "al-2",
-          "isDir": true,
-          "name": "",
-          "songCount": 3,
-          "duration": 300
         }
       ]
     }

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_two_alpha_artist b/server/ctrlsubsonic/testdata/test_get_album_list_two_alpha_artist
@@ -4,6 +4,7 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList2": {
       "album": [
         {

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_two_alpha_name b/server/ctrlsubsonic/testdata/test_get_album_list_two_alpha_name
@@ -4,6 +4,7 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList2": {
       "album": [
         {

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_two_newest b/server/ctrlsubsonic/testdata/test_get_album_list_two_newest
@@ -4,6 +4,7 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList2": {
       "album": [
         {

diff --git a/server/ctrlsubsonic/testdata/test_get_album_list_two_random b/server/ctrlsubsonic/testdata/test_get_album_list_two_random
@@ -4,28 +4,29 @@
     "version": "1.15.0",
     "type": "gonic",
     "serverVersion": "",
+    "openSubsonic": true,
     "albumList2": {
       "album": [
         {
-          "id": "al-8",
-          "coverArt": "al-8",
-          "artistId": "ar-2",
-          "artist": "artist-1",
-          "artists": [{ "id": "ar-2", "name": "artist-1" }],
+          "id": "al-3",
+          "coverArt": "al-3",
+          "artistId": "ar-1",
+          "artist": "artist-0",
+          "artists": [{ "id": "ar-1", "name": "artist-0" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",
-          "name": "album-1",
+          "name": "album-0",
           "songCount": 3,
           "duration": 300,
           "year": 2021
         },
         {
-          "id": "al-11",
-          "coverArt": "al-11",
-          "artistId": "ar-3",
-          "artist": "artist-2",
-          "artists": [{ "id": "ar-3", "name": "artist-2" }],
+          "id": "al-7",
+          "coverArt": "al-7",
+          "artistId": "ar-2",
+          "artist": "artist-1",
+          "artists": [{ "id": "ar-2", "name": "artist-1" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",
@@ -35,29 +36,29 @@
           "year": 2021
         },
         {
-          "id": "al-5",
-          "coverArt": "al-5",
-          "artistId": "ar-1",
-          "artist": "artist-0",
-          "artists": [{ "id": "ar-1", "name": "artist-0" }],
+          "id": "al-12",
+          "coverArt": "al-12",
+          "artistId": "ar-3",
+          "artist": "artist-2",
+          "artists": [{ "id": "ar-3", "name": "artist-2" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",
-          "name": "album-2",
+          "name": "album-1",
           "songCount": 3,
           "duration": 300,
           "year": 2021
         },
         {
-          "id": "al-3",
-          "coverArt": "al-3",
-          "artistId": "ar-1",
-          "artist": "artist-0",
-          "artists": [{ "id": "ar-1", "name": "artist-0" }],
+          "id": "al-13",
+          "coverArt": "al-13",
+          "artistId": "ar-3",
+          "artist": "artist-2",
+          "artists": [{ "id": "ar-3", "name": "artist-2" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",
-          "name": "album-0",
+          "name": "album-2",
           "songCount": 3,
           "duration": 300,
           "year": 2021
@@ -77,53 +78,53 @@
           "year": 2021
         },
         {
-          "id": "al-7",
-          "coverArt": "al-7",
-          "artistId": "ar-2",
-          "artist": "artist-1",
-          "artists": [{ "id": "ar-2", "name": "artist-1" }],
+          "id": "al-4",
+          "coverArt": "al-4",
+          "artistId": "ar-1",
+          "artist": "artist-0",
+          "artists": [{ "id": "ar-1", "name": "artist-0" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",
-          "name": "album-0",
+          "name": "album-1",
           "songCount": 3,
           "duration": 300,
           "year": 2021
         },
         {
-          "id": "al-13",
-          "coverArt": "al-13",
+          "id": "al-11",
+          "coverArt": "al-11",
           "artistId": "ar-3",
           "artist": "artist-2",
           "artists": [{ "id": "ar-3", "name": "artist-2" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",
-          "name": "album-2",
+          "name": "album-0",
           "songCount": 3,
           "duration": 300,
           "year": 2021
         },
         {
-          "id": "al-4",
-          "coverArt": "al-4",
+          "id": "al-5",
+          "coverArt": "al-5",
           "artistId": "ar-1",
           "artist": "artist-0",
           "artists": [{ "id": "ar-1", "name": "artist-0" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",
-          "name": "album-1",
+          "name": "album-2",
           "songCount": 3,
           "duration": 300,
           "year": 2021
         },
         {
-          "id": "al-12",
-          "coverArt": "al-12",
-          "artistId": "ar-3",
-          "artist": "artist-2",
-          "artists": [{ "id": "ar-3", "name": "artist-2" }],
+          "id": "al-8",
+          "coverArt": "al-8",
+          "artistId": "ar-2",
+          "artist": "artist-1",
+          "artists": [{ "id": "ar-2", "name": "artist-1" }],
           "created": "2019-11-30T00:00:00Z",
           "title": "",
           "album": "",