arian/navidrome
1
0
Fork 0
Code Issues Pull Requests 1 Packages Projects Releases Wiki Activity

refactor: move request param extractors to utils

Browse Source
This commit is contained in:
Deluan
2020-02-06 18:55:38 -05:00
parent d9dd9fe587
commit 8673533cd4
11 changed files with 129 additions and 116 deletions
Download Patch File Download Diff File Expand all files Collapse all files
server/subsonic/album_lists.go
+4 -4
View File
@@ -47,8 +47,8 @@ func (c *AlbumListController) getAlbumList(r *http.Request) (engine.Entries, err
return nil, errors.New("Not implemented!") return nil, errors.New("Not implemented!")
} }
offset := ParamInt(r, "offset", 0) offset := utils.ParamInt(r, "offset", 0)
size := utils.MinInt(ParamInt(r, "size", 10), 500) size := utils.MinInt(utils.ParamInt(r, "size", 10), 500)
albums, err := listFunc(r.Context(), offset, size) albums, err := listFunc(r.Context(), offset, size)
if err != nil { if err != nil {
@@ -132,8 +132,8 @@ func (c *AlbumListController) GetNowPlaying(w http.ResponseWriter, r *http.Reque
} }
func (c *AlbumListController) GetRandomSongs(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *AlbumListController) GetRandomSongs(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
size := utils.MinInt(ParamInt(r, "size", 10), 500) size := utils.MinInt(utils.ParamInt(r, "size", 10), 500)
genre := ParamString(r, "genre") genre := utils.ParamString(r, "genre")
songs, err := c.listGen.GetRandomSongs(r.Context(), size, genre) songs, err := c.listGen.GetRandomSongs(r.Context(), size, genre)
if err != nil { if err != nil {
server/subsonic/api.go
+3 -2
View File
@@ -9,6 +9,7 @@ import (
"github.com/deluan/navidrome/engine" "github.com/deluan/navidrome/engine"
"github.com/deluan/navidrome/log" "github.com/deluan/navidrome/log"
"github.com/deluan/navidrome/server/subsonic/responses" "github.com/deluan/navidrome/server/subsonic/responses"
"github.com/deluan/navidrome/utils"
"github.com/go-chi/chi" "github.com/go-chi/chi"
) )
@@ -163,7 +164,7 @@ func SendError(w http.ResponseWriter, r *http.Request, err error) {
} }
func SendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Subsonic) { func SendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Subsonic) {
f := ParamString(r, "f") f := utils.ParamString(r, "f")
var response []byte var response []byte
switch f { switch f {
case "json": case "json":
@@ -172,7 +173,7 @@ func SendResponse(w http.ResponseWriter, r *http.Request, payload *responses.Sub
response, _ = json.Marshal(wrapper) response, _ = json.Marshal(wrapper)
case "jsonp": case "jsonp":
w.Header().Set("Content-Type", "application/javascript") w.Header().Set("Content-Type", "application/javascript")
callback := ParamString(r, "callback") callback := utils.ParamString(r, "callback")
wrapper := &responses.JsonWrapper{Subsonic: *payload} wrapper := &responses.JsonWrapper{Subsonic: *payload}
data, _ := json.Marshal(wrapper) data, _ := json.Marshal(wrapper)
response = []byte(fmt.Sprintf("%s(%s)", callback, data)) response = []byte(fmt.Sprintf("%s(%s)", callback, data))
server/subsonic/browsing.go
+7 -7
View File
@@ -59,8 +59,8 @@ func (c *BrowsingController) getArtistIndex(r *http.Request, musicFolderId strin
} }
func (c *BrowsingController) GetIndexes(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *BrowsingController) GetIndexes(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
musicFolderId := ParamString(r, "musicFolderId") musicFolderId := utils.ParamString(r, "musicFolderId")
ifModifiedSince := ParamTime(r, "ifModifiedSince", time.Time{}) ifModifiedSince := utils.ParamTime(r, "ifModifiedSince", time.Time{})
res, err := c.getArtistIndex(r, musicFolderId, ifModifiedSince) res, err := c.getArtistIndex(r, musicFolderId, ifModifiedSince)
if err != nil { if err != nil {
@@ -73,7 +73,7 @@ func (c *BrowsingController) GetIndexes(w http.ResponseWriter, r *http.Request)
} }
func (c *BrowsingController) GetArtists(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *BrowsingController) GetArtists(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
musicFolderId := ParamString(r, "musicFolderId") musicFolderId := utils.ParamString(r, "musicFolderId")
res, err := c.getArtistIndex(r, musicFolderId, time.Time{}) res, err := c.getArtistIndex(r, musicFolderId, time.Time{})
if err != nil { if err != nil {
return nil, err return nil, err
@@ -85,7 +85,7 @@ func (c *BrowsingController) GetArtists(w http.ResponseWriter, r *http.Request)
} }
func (c *BrowsingController) GetMusicDirectory(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *BrowsingController) GetMusicDirectory(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
id := ParamString(r, "id") id := utils.ParamString(r, "id")
dir, err := c.browser.Directory(r.Context(), id) dir, err := c.browser.Directory(r.Context(), id)
switch { switch {
case err == model.ErrNotFound: case err == model.ErrNotFound:
@@ -102,7 +102,7 @@ func (c *BrowsingController) GetMusicDirectory(w http.ResponseWriter, r *http.Re
} }
func (c *BrowsingController) GetArtist(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *BrowsingController) GetArtist(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
id := ParamString(r, "id") id := utils.ParamString(r, "id")
dir, err := c.browser.Artist(r.Context(), id) dir, err := c.browser.Artist(r.Context(), id)
switch { switch {
case err == model.ErrNotFound: case err == model.ErrNotFound:
@@ -119,7 +119,7 @@ func (c *BrowsingController) GetArtist(w http.ResponseWriter, r *http.Request) (
} }
func (c *BrowsingController) GetAlbum(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *BrowsingController) GetAlbum(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
id := ParamString(r, "id") id := utils.ParamString(r, "id")
dir, err := c.browser.Album(r.Context(), id) dir, err := c.browser.Album(r.Context(), id)
switch { switch {
case err == model.ErrNotFound: case err == model.ErrNotFound:
@@ -136,7 +136,7 @@ func (c *BrowsingController) GetAlbum(w http.ResponseWriter, r *http.Request) (*
} }
func (c *BrowsingController) GetSong(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *BrowsingController) GetSong(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
id := ParamString(r, "id") id := utils.ParamString(r, "id")
song, err := c.browser.GetSong(r.Context(), id) song, err := c.browser.GetSong(r.Context(), id)
switch { switch {
case err == model.ErrNotFound: case err == model.ErrNotFound:
server/subsonic/helpers.go
+4 -70
View File
@@ -5,8 +5,6 @@ import (
"mime" "mime"
"net/http" "net/http"
"strconv" "strconv"
"strings"
"time"
"github.com/deluan/navidrome/consts" "github.com/deluan/navidrome/consts"
"github.com/deluan/navidrome/engine" "github.com/deluan/navidrome/engine"
@@ -20,7 +18,7 @@ func NewResponse() *responses.Subsonic {
} }
func RequiredParamString(r *http.Request, param string, msg string) (string, error) { func RequiredParamString(r *http.Request, param string, msg string) (string, error) {
p := ParamString(r, param) p := utils.ParamString(r, param)
if p == "" { if p == "" {
return "", NewError(responses.ErrorMissingParameter, msg) return "", NewError(responses.ErrorMissingParameter, msg)
} }
@@ -28,83 +26,19 @@ func RequiredParamString(r *http.Request, param string, msg string) (string, err
} }
func RequiredParamStrings(r *http.Request, param string, msg string) ([]string, error) { func RequiredParamStrings(r *http.Request, param string, msg string) ([]string, error) {
ps := ParamStrings(r, param) ps := utils.ParamStrings(r, param)
if len(ps) == 0 { if len(ps) == 0 {
return nil, NewError(responses.ErrorMissingParameter, msg) return nil, NewError(responses.ErrorMissingParameter, msg)
} }
return ps, nil return ps, nil
} }
func ParamString(r *http.Request, param string) string {
return r.URL.Query().Get(param)
}
func ParamStrings(r *http.Request, param string) []string {
return r.URL.Query()[param]
}
func ParamTimes(r *http.Request, param string) []time.Time {
pStr := ParamStrings(r, param)
times := make([]time.Time, len(pStr))
for i, t := range pStr {
ti, err := strconv.ParseInt(t, 10, 64)
if err == nil {
times[i] = utils.ToTime(ti)
}
}
return times
}
func ParamTime(r *http.Request, param string, def time.Time) time.Time {
v := ParamString(r, param)
if v == "" {
return def
}
value, err := strconv.ParseInt(v, 10, 64)
if err != nil {
return def
}
return utils.ToTime(value)
}
func RequiredParamInt(r *http.Request, param string, msg string) (int, error) { func RequiredParamInt(r *http.Request, param string, msg string) (int, error) {
p := ParamString(r, param) p := utils.ParamString(r, param)
if p == "" { if p == "" {
return 0, NewError(responses.ErrorMissingParameter, msg) return 0, NewError(responses.ErrorMissingParameter, msg)
} }
return ParamInt(r, param, 0), nil return utils.ParamInt(r, param, 0), nil
}
func ParamInt(r *http.Request, param string, def int) int {
v := ParamString(r, param)
if v == "" {
return def
}
value, err := strconv.ParseInt(v, 10, 32)
if err != nil {
return def
}
return int(value)
}
func ParamInts(r *http.Request, param string) []int {
pStr := ParamStrings(r, param)
ints := make([]int, 0, len(pStr))
for _, s := range pStr {
i, err := strconv.ParseInt(s, 10, 32)
if err == nil {
ints = append(ints, int(i))
}
}
return ints
}
func ParamBool(r *http.Request, param string, def bool) bool {
p := ParamString(r, param)
if p == "" {
return def
}
return strings.Index("/true/on/1/", "/"+p+"/") != -1
} }
type SubsonicError struct { type SubsonicError struct {
server/subsonic/media_annotation.go
+11 -10
View File
@@ -9,6 +9,7 @@ import (
"github.com/deluan/navidrome/log" "github.com/deluan/navidrome/log"
"github.com/deluan/navidrome/model" "github.com/deluan/navidrome/model"
"github.com/deluan/navidrome/server/subsonic/responses" "github.com/deluan/navidrome/server/subsonic/responses"
"github.com/deluan/navidrome/utils"
) )
type MediaAnnotationController struct { type MediaAnnotationController struct {
@@ -49,9 +50,9 @@ func (c *MediaAnnotationController) SetRating(w http.ResponseWriter, r *http.Req
} }
func (c *MediaAnnotationController) Star(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *MediaAnnotationController) Star(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
ids := ParamStrings(r, "id") ids := utils.ParamStrings(r, "id")
albumIds := ParamStrings(r, "albumId") albumIds := utils.ParamStrings(r, "albumId")
artistIds := ParamStrings(r, "artistId") artistIds := utils.ParamStrings(r, "artistId")
if len(ids)+len(albumIds)+len(artistIds) == 0 { if len(ids)+len(albumIds)+len(artistIds) == 0 {
return nil, NewError(responses.ErrorMissingParameter, "Required id parameter is missing") return nil, NewError(responses.ErrorMissingParameter, "Required id parameter is missing")
} }
@@ -84,9 +85,9 @@ func (c *MediaAnnotationController) star(ctx context.Context, starred bool, ids
} }
func (c *MediaAnnotationController) Unstar(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *MediaAnnotationController) Unstar(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
ids := ParamStrings(r, "id") ids := utils.ParamStrings(r, "id")
albumIds := ParamStrings(r, "albumId") albumIds := utils.ParamStrings(r, "albumId")
artistIds := ParamStrings(r, "artistId") artistIds := utils.ParamStrings(r, "artistId")
if len(ids)+len(albumIds)+len(artistIds) == 0 { if len(ids)+len(albumIds)+len(artistIds) == 0 {
return nil, NewError(responses.ErrorMissingParameter, "Required id parameter is missing") return nil, NewError(responses.ErrorMissingParameter, "Required id parameter is missing")
} }
@@ -106,14 +107,14 @@ func (c *MediaAnnotationController) Scrobble(w http.ResponseWriter, r *http.Requ
if err != nil { if err != nil {
return nil, err return nil, err
} }
times := ParamTimes(r, "time") times := utils.ParamTimes(r, "time")
if len(times) > 0 && len(times) != len(ids) { if len(times) > 0 && len(times) != len(ids) {
return nil, NewError(responses.ErrorGeneric, "Wrong number of timestamps: %d, should be %d", len(times), len(ids)) return nil, NewError(responses.ErrorGeneric, "Wrong number of timestamps: %d, should be %d", len(times), len(ids))
} }
submission := ParamBool(r, "submission", true) submission := utils.ParamBool(r, "submission", true)
playerId := 1 // TODO Multiple players, based on playerName/username/clientIP(?) playerId := 1 // TODO Multiple players, based on playerName/username/clientIP(?)
playerName := ParamString(r, "c") playerName := utils.ParamString(r, "c")
username := ParamString(r, "u") username := utils.ParamString(r, "u")
log.Debug(r, "Scrobbling tracks", "ids", ids, "times", times, "submission", submission) log.Debug(r, "Scrobbling tracks", "ids", ids, "times", times, "submission", submission)
for i, id := range ids { for i, id := range ids {
server/subsonic/media_retrieval.go
+2 -1
View File
@@ -9,6 +9,7 @@ import (
"github.com/deluan/navidrome/model" "github.com/deluan/navidrome/model"
"github.com/deluan/navidrome/server/subsonic/responses" "github.com/deluan/navidrome/server/subsonic/responses"
"github.com/deluan/navidrome/static" "github.com/deluan/navidrome/static"
"github.com/deluan/navidrome/utils"
) )
type MediaRetrievalController struct { type MediaRetrievalController struct {
@@ -36,7 +37,7 @@ func (c *MediaRetrievalController) GetCoverArt(w http.ResponseWriter, r *http.Re
if err != nil { if err != nil {
return nil, err return nil, err
} }
size := ParamInt(r, "size", 0) size := utils.ParamInt(r, "size", 0)
err = c.cover.Get(r.Context(), id, size, w) err = c.cover.Get(r.Context(), id, size, w)
server/subsonic/middlewares.go
+10 -9
View File
@@ -11,6 +11,7 @@ import (
"github.com/deluan/navidrome/log" "github.com/deluan/navidrome/log"
"github.com/deluan/navidrome/model" "github.com/deluan/navidrome/model"
"github.com/deluan/navidrome/server/subsonic/responses" "github.com/deluan/navidrome/server/subsonic/responses"
"github.com/deluan/navidrome/utils"
) )
func postFormToQueryParams(next http.Handler) http.Handler { func postFormToQueryParams(next http.Handler) http.Handler {
@@ -36,7 +37,7 @@ func checkRequiredParameters(next http.Handler) http.Handler {
requiredParameters := []string{"u", "v", "c"} requiredParameters := []string{"u", "v", "c"}
for _, p := range requiredParameters { for _, p := range requiredParameters {
if ParamString(r, p) == "" { if utils.ParamString(r, p) == "" {
msg := fmt.Sprintf(`Missing required parameter "%s"`, p) msg := fmt.Sprintf(`Missing required parameter "%s"`, p)
log.Warn(r, msg) log.Warn(r, msg)
SendError(w, r, NewError(responses.ErrorMissingParameter, msg)) SendError(w, r, NewError(responses.ErrorMissingParameter, msg))
@@ -44,9 +45,9 @@ func checkRequiredParameters(next http.Handler) http.Handler {
} }
} }
user := ParamString(r, "u") user := utils.ParamString(r, "u")
client := ParamString(r, "c") client := utils.ParamString(r, "c")
version := ParamString(r, "v") version := utils.ParamString(r, "v")
ctx := r.Context() ctx := r.Context()
ctx = context.WithValue(ctx, "username", user) ctx = context.WithValue(ctx, "username", user)
ctx = context.WithValue(ctx, "client", client) ctx = context.WithValue(ctx, "client", client)
@@ -61,11 +62,11 @@ func checkRequiredParameters(next http.Handler) http.Handler {
func authenticate(users engine.Users) func(next http.Handler) http.Handler { func authenticate(users engine.Users) func(next http.Handler) http.Handler {
return func(next http.Handler) http.Handler { return func(next http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
username := ParamString(r, "u") username := utils.ParamString(r, "u")
pass := ParamString(r, "p") pass := utils.ParamString(r, "p")
token := ParamString(r, "t") token := utils.ParamString(r, "t")
salt := ParamString(r, "s") salt := utils.ParamString(r, "s")
jwt := ParamString(r, "jwt") jwt := utils.ParamString(r, "jwt")
usr, err := users.Authenticate(r.Context(), username, pass, token, salt, jwt) usr, err := users.Authenticate(r.Context(), username, pass, token, salt, jwt)
if err == model.ErrInvalidAuth { if err == model.ErrInvalidAuth {
server/subsonic/playlists.go
+6 -5
View File
@@ -9,6 +9,7 @@ import (
"github.com/deluan/navidrome/log" "github.com/deluan/navidrome/log"
"github.com/deluan/navidrome/model" "github.com/deluan/navidrome/model"
"github.com/deluan/navidrome/server/subsonic/responses" "github.com/deluan/navidrome/server/subsonic/responses"
"github.com/deluan/navidrome/utils"
) )
type PlaylistsController struct { type PlaylistsController struct {
@@ -61,9 +62,9 @@ func (c *PlaylistsController) GetPlaylist(w http.ResponseWriter, r *http.Request
} }
func (c *PlaylistsController) CreatePlaylist(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) { func (c *PlaylistsController) CreatePlaylist(w http.ResponseWriter, r *http.Request) (*responses.Subsonic, error) {
songIds := ParamStrings(r, "songId") songIds := utils.ParamStrings(r, "songId")
playlistId := ParamString(r, "playlistId") playlistId := utils.ParamString(r, "playlistId")
name := ParamString(r, "name") name := utils.ParamString(r, "name")
if playlistId == "" && name == "" { if playlistId == "" && name == "" {
return nil, errors.New("Required parameter name is missing") return nil, errors.New("Required parameter name is missing")
} }
@@ -96,8 +97,8 @@ func (c *PlaylistsController) UpdatePlaylist(w http.ResponseWriter, r *http.Requ
if err != nil { if err != nil {
return nil, err return nil, err
} }
songsToAdd := ParamStrings(r, "songIdToAdd") songsToAdd := utils.ParamStrings(r, "songIdToAdd")
songIndexesToRemove := ParamInts(r, "songIndexToRemove") songIndexesToRemove := utils.ParamInts(r, "songIndexToRemove")
var pname *string var pname *string
if len(r.URL.Query()["name"]) > 0 { if len(r.URL.Query()["name"]) > 0 {
server/subsonic/searching.go
+7 -6
View File
@@ -7,6 +7,7 @@ import (
"github.com/deluan/navidrome/engine" "github.com/deluan/navidrome/engine"
"github.com/deluan/navidrome/log" "github.com/deluan/navidrome/log"
"github.com/deluan/navidrome/server/subsonic/responses" "github.com/deluan/navidrome/server/subsonic/responses"
"github.com/deluan/navidrome/utils"
) )
type SearchingController struct { type SearchingController struct {
@@ -34,12 +35,12 @@ func (c *SearchingController) getParams(r *http.Request) (*searchParams, error)
if err != nil { if err != nil {
return nil, err return nil, err
} }
sp.artistCount = ParamInt(r, "artistCount", 20) sp.artistCount = utils.ParamInt(r, "artistCount", 20)
sp.artistOffset = ParamInt(r, "artistOffset", 0) sp.artistOffset = utils.ParamInt(r, "artistOffset", 0)
sp.albumCount = ParamInt(r, "albumCount", 20) sp.albumCount = utils.ParamInt(r, "albumCount", 20)
sp.albumOffset = ParamInt(r, "albumOffset", 0) sp.albumOffset = utils.ParamInt(r, "albumOffset", 0)
sp.songCount = ParamInt(r, "songCount", 20) sp.songCount = utils.ParamInt(r, "songCount", 20)
sp.songOffset = ParamInt(r, "songOffset", 0) sp.songOffset = utils.ParamInt(r, "songOffset", 0)
return sp, nil return sp, nil
} }
server/subsonic/stream.go
+3 -2
View File
@@ -5,6 +5,7 @@ import (
"github.com/deluan/navidrome/engine" "github.com/deluan/navidrome/engine"
"github.com/deluan/navidrome/server/subsonic/responses" "github.com/deluan/navidrome/server/subsonic/responses"
"github.com/deluan/navidrome/utils"
) )
type StreamController struct { type StreamController struct {
@@ -20,8 +21,8 @@ func (c *StreamController) Stream(w http.ResponseWriter, r *http.Request) (*resp
if err != nil { if err != nil {
return nil, err return nil, err
} }
maxBitRate := ParamInt(r, "maxBitRate", 0) maxBitRate := utils.ParamInt(r, "maxBitRate", 0)
format := ParamString(r, "format") format := utils.ParamString(r, "format")
ms, err := c.streamer.NewStream(r.Context(), id, maxBitRate, format) ms, err := c.streamer.NewStream(r.Context(), id, maxBitRate, format)
if err != nil { if err != nil {
utils/request_helpers.go
+72
View File
@@ -0,0 +1,72 @@
package utils
import (
"net/http"
"strconv"
"strings"
"time"
)
func ParamString(r *http.Request, param string) string {
return r.URL.Query().Get(param)
}
func ParamStrings(r *http.Request, param string) []string {
return r.URL.Query()[param]
}
func ParamTimes(r *http.Request, param string) []time.Time {
pStr := ParamStrings(r, param)
times := make([]time.Time, len(pStr))
for i, t := range pStr {
ti, err := strconv.ParseInt(t, 10, 64)
if err == nil {
times[i] = ToTime(ti)
}
}
return times
}
func ParamTime(r *http.Request, param string, def time.Time) time.Time {
v := ParamString(r, param)
if v == "" {
return def
}
value, err := strconv.ParseInt(v, 10, 64)
if err != nil {
return def
}
return ToTime(value)
}
func ParamInt(r *http.Request, param string, def int) int {
v := ParamString(r, param)
if v == "" {
return def
}
value, err := strconv.ParseInt(v, 10, 32)
if err != nil {
return def
}
return int(value)
}
func ParamInts(r *http.Request, param string) []int {
pStr := ParamStrings(r, param)
ints := make([]int, 0, len(pStr))
for _, s := range pStr {
i, err := strconv.ParseInt(s, 10, 32)
if err == nil {
ints = append(ints, int(i))
}
}
return ints
}
func ParamBool(r *http.Request, param string, def bool) bool {
p := ParamString(r, param)
if p == "" {
return def
}
return strings.Index("/true/on/1/", "/"+p+"/") != -1
}