Skip to content

Commit

Permalink
Add req.Params to replace utils.Param*
Browse files Browse the repository at this point in the history
  • Loading branch information
deluan committed Dec 21, 2023
1 parent 965fc9d commit 00597e0
Show file tree
Hide file tree
Showing 5 changed files with 392 additions and 38 deletions.
35 changes: 20 additions & 15 deletions server/subsonic/api.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"github.com/navidrome/navidrome/server/events"
"github.com/navidrome/navidrome/server/subsonic/responses"
"github.com/navidrome/navidrome/utils"
"github.com/navidrome/navidrome/utils/req"
)

const Version = "1.16.1"
Expand Down Expand Up @@ -211,15 +212,6 @@ func hr(r chi.Router, path string, f handlerRaw) {
handle := func(w http.ResponseWriter, r *http.Request) {
res, err := f(w, r)
if err != nil {
// If it is not a Subsonic error, convert it to an ErrorGeneric
var subErr subError
if !errors.As(err, &subErr) {
if errors.Is(err, model.ErrNotFound) {
err = newError(responses.ErrorDataNotFound, "data not found")
} else {
err = newError(responses.ErrorGeneric, fmt.Sprintf("Internal Server Error: %s", err))
}
}
sendError(w, r, err)
return
}
Expand Down Expand Up @@ -264,15 +256,28 @@ func addHandler(r chi.Router, path string, handle func(w http.ResponseWriter, r
r.HandleFunc("/"+path+".view", handle)
}

func mapToSubsonicError(err error) subError {
switch {
case errors.Is(err, errSubsonic): // do nothing
case errors.Is(err, req.ErrMissingParam):
err = newError(responses.ErrorMissingParameter, err.Error())
case errors.Is(err, req.ErrInvalidParam):
err = newError(responses.ErrorGeneric, err.Error())
case errors.Is(err, model.ErrNotFound):
err = newError(responses.ErrorDataNotFound, "data not found")
default:
err = newError(responses.ErrorGeneric, fmt.Sprintf("Internal Server Error: %s", err))
}
var subErr subError
errors.As(err, &subErr)
return subErr
}

func sendError(w http.ResponseWriter, r *http.Request, err error) {
subErr := mapToSubsonicError(err)
response := newResponse()
code := responses.ErrorGeneric
var subErr subError
if errors.As(err, &subErr) {
code = subErr.code
}
response.Status = "failed"
response.Error = &responses.Error{Code: int32(code), Message: err.Error()}
response.Error = &responses.Error{Code: int32(subErr.code), Message: subErr.Error()}

sendResponse(w, r, response)
}
Expand Down
8 changes: 8 additions & 0 deletions server/subsonic/helpers.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package subsonic

import (
"context"
"errors"
"fmt"
"mime"
"net/http"
Expand Down Expand Up @@ -62,6 +63,13 @@ func newError(code int, message ...interface{}) error {
}
}

// errSubsonic and Unwrap are used to allow `errors.Is(err, errSubsonic)` to work
var errSubsonic = errors.New("subsonic API error")

func (e subError) Unwrap() error {
return fmt.Errorf("%w: %d", errSubsonic, e.code)
}

func (e subError) Error() string {
var msg string
if len(e.messages) == 0 {
Expand Down
39 changes: 16 additions & 23 deletions server/subsonic/media_annotation.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package subsonic

import (
"context"
"errors"
"fmt"
"net/http"
"time"
Expand All @@ -13,26 +12,22 @@ import (
"github.com/navidrome/navidrome/model/request"
"github.com/navidrome/navidrome/server/events"
"github.com/navidrome/navidrome/server/subsonic/responses"
"github.com/navidrome/navidrome/utils"
"github.com/navidrome/navidrome/utils/req"
)

func (api *Router) SetRating(r *http.Request) (*responses.Subsonic, error) {
id, err := requiredParamString(r, "id")
p := req.Params(r)
id, err := p.String("id")
if err != nil {
return nil, err
}
rating, err := requiredParamInt(r, "rating")
rating, err := p.Int("rating")
if err != nil {
return nil, err
}

log.Debug(r, "Setting rating", "rating", rating, "id", id)
err = api.setRating(r.Context(), id, rating)

if errors.Is(err, model.ErrNotFound) {
log.Error(r, err)
return nil, newError(responses.ErrorDataNotFound, "ID not found")
}
if err != nil {
log.Error(r, err)
return nil, err
Expand Down Expand Up @@ -70,9 +65,10 @@ func (api *Router) setRating(ctx context.Context, id string, rating int) error {
}

func (api *Router) Star(r *http.Request) (*responses.Subsonic, error) {
ids := utils.ParamStrings(r, "id")
albumIds := utils.ParamStrings(r, "albumId")
artistIds := utils.ParamStrings(r, "artistId")
p := req.Params(r)
ids, _ := p.Strings("id")
albumIds, _ := p.Strings("albumId")
artistIds, _ := p.Strings("artistId")
if len(ids)+len(albumIds)+len(artistIds) == 0 {
return nil, newError(responses.ErrorMissingParameter, "Required id parameter is missing")
}
Expand All @@ -88,9 +84,10 @@ func (api *Router) Star(r *http.Request) (*responses.Subsonic, error) {
}

func (api *Router) Unstar(r *http.Request) (*responses.Subsonic, error) {
ids := utils.ParamStrings(r, "id")
albumIds := utils.ParamStrings(r, "albumId")
artistIds := utils.ParamStrings(r, "artistId")
p := req.Params(r)
ids, _ := p.Strings("id")
albumIds, _ := p.Strings("albumId")
artistIds, _ := p.Strings("artistId")
if len(ids)+len(albumIds)+len(artistIds) == 0 {
return nil, newError(responses.ErrorMissingParameter, "Required id parameter is missing")
}
Expand Down Expand Up @@ -150,11 +147,6 @@ func (api *Router) setStar(ctx context.Context, star bool, ids ...string) error
api.broker.SendMessage(ctx, event)
return nil
})

if errors.Is(err, model.ErrNotFound) {
log.Error(ctx, err)
return newError(responses.ErrorDataNotFound, "ID not found")
}
if err != nil {
log.Error(ctx, err)
return err
Expand All @@ -163,15 +155,16 @@ func (api *Router) setStar(ctx context.Context, star bool, ids ...string) error
}

func (api *Router) Scrobble(r *http.Request) (*responses.Subsonic, error) {
ids, err := requiredParamStrings(r, "id")
p := req.Params(r)
ids, err := p.Strings("id")
if err != nil {
return nil, err
}
times := utils.ParamTimes(r, "time")
times := p.Times("time")
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))
}
submission := utils.ParamBool(r, "submission", true)
submission := p.BoolOr("submission", true)
ctx := r.Context()

if submission {
Expand Down
140 changes: 140 additions & 0 deletions utils/req/req.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
package req

import (
"errors"
"fmt"
"net/http"
"strconv"
"strings"
"time"

"github.com/navidrome/navidrome/log"
"github.com/navidrome/navidrome/utils"
)

type Values struct {
*http.Request
}

func Params(r *http.Request) *Values {
return &Values{r}
}

var (
ErrMissingParam = errors.New("missing parameter")
ErrInvalidParam = errors.New("invalid parameter")
)

func newError(err error, param string) error {
return fmt.Errorf("%w: '%s'", err, param)
}
func (r *Values) String(param string) (string, error) {
v := r.URL.Query().Get(param)
if v == "" {
return "", newError(ErrMissingParam, param)
}
return v, nil
}

func (r *Values) StringOr(param, def string) string {
v, _ := r.String(param)
if v == "" {
return def
}
return v
}

func (r *Values) Strings(param string) ([]string, error) {
values := r.URL.Query()[param]
if len(values) == 0 {
return nil, newError(ErrMissingParam, param)
}
return values, nil
}

func (r *Values) TimeOr(param string, def time.Time) time.Time {
v, _ := r.String(param)
if v == "" || v == "-1" {
return def
}
value, err := strconv.ParseInt(v, 10, 64)
if err != nil {
return def
}
t := utils.ToTime(value)
if t.Before(time.Date(1970, time.January, 2, 0, 0, 0, 0, time.UTC)) {
return def
}
return t
}

func (r *Values) Times(param string) []time.Time {
pStr, _ := r.Strings(param)
times := make([]time.Time, len(pStr))
for i, t := range pStr {
ti, err := strconv.ParseInt(t, 10, 64)
if err != nil {
log.Warn(r.Context(), "Ignoring invalid time param", "time", t, err)
times[i] = time.Now()
continue
}
times[i] = utils.ToTime(ti)
}
return times
}

func (r *Values) Int64(param string) (int64, error) {
v, err := r.String(param)
if err != nil {
return 0, err
}
value, err := strconv.ParseInt(v, 10, 64)
if err != nil {
return 0, fmt.Errorf("%w '%s': expected integer, got '%s'", ErrInvalidParam, param, v)
}
return value, nil
}

func (r *Values) Int(param string) (int, error) {
v, err := r.Int64(param)
if err != nil {
return 0, err
}
return int(v), nil
}

func (r *Values) IntOr(param string, def int) int {
v, err := r.Int64(param)
if err != nil {
return def
}
return int(v)
}

func (r *Values) Int64Or(param string, def int64) int64 {
v, err := r.Int64(param)
if err != nil {
return def
}
return v
}

func (r *Values) Ints(param string) []int {
pStr, _ := r.Strings(param)
ints := make([]int, 0, len(pStr))
for _, s := range pStr {
i, err := strconv.ParseInt(s, 10, 64)
if err == nil {
ints = append(ints, int(i))
}
}
return ints
}

func (r *Values) BoolOr(param string, def bool) bool {
v, _ := r.String(param)
if v == "" {
return def
}
return strings.Contains("/true/on/1/", "/"+strings.ToLower(v)+"/")
}
Loading

0 comments on commit 00597e0

Please sign in to comment.