heimoshuiyu/gonic
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

add const

Browse Source
This commit is contained in:
sentriz
2020-04-29 20:10:18 +01:00
committed by Senan Kelly
parent f4a1c3fb0c
commit 26457aae6c
8 changed files with 157 additions and 188 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
server/ctrlsubsonic/handlers_by_tags.go
View File

@@ -210,7 +210,7 @@ func (c *Controller) ServeSearchThree(r *http.Request) *spec.Response {
func (c *Controller) ServeGetArtistInfoTwo(r *http.Request) *spec.Response { func (c *Controller) ServeGetArtistInfoTwo(r *http.Request) *spec.Response {
params := r.Context().Value(CtxParams).(params.Params) params := r.Context().Value(CtxParams).(params.Params)
id, err := params.GetIDDefault() id, err := params.GetInt("id")
if err != nil { if err != nil {
return spec.NewError(10, "please provide an `id` parameter") return spec.NewError(10, "please provide an `id` parameter")
} }

2
server/ctrlsubsonic/handlers_raw.go
View File

@@ -82,7 +82,7 @@ func (c *Controller) ServeGetCoverArt(w http.ResponseWriter, r *http.Request) *s
func (c *Controller) ServeStream(w http.ResponseWriter, r *http.Request) *spec.Response { func (c *Controller) ServeStream(w http.ResponseWriter, r *http.Request) *spec.Response {
params := r.Context().Value(CtxParams).(params.Params) params := r.Context().Value(CtxParams).(params.Params)
id, err := params.GetInt("id") id, err := params.GetID("id")
if err != nil { if err != nil {
return spec.NewError(10, "please provide an `id` parameter") return spec.NewError(10, "please provide an `id` parameter")
} }

143
server/ctrlsubsonic/params/params.go
View File

@@ -26,45 +26,23 @@ package params
import ( import (
"errors" "errors"
"fmt"
"net/http" "net/http"
"net/url" "net/url"
"strconv" "strconv"
"strings"
"go.senan.xyz/gonic/server/ids"
) )
var ( // some thin wrappers
ErrKeyNotFound = errors.New("key(s) not found") // may be needed when cleaning up parse() below
ErrIDInvalid = errors.New("invalid id") func parseStr(in string) (string, error) { return in, nil }
ErrIDNotAnInt = errors.New("not an int") func parseInt(in string) (int, error) { return strconv.Atoi(in) }
ErrIDNotABool = errors.New("not an bool") func parseID(in string) (ids.IDV, error) { return ids.Parse(in) }
) func parseBool(in string) (bool, error) { return strconv.ParseBool(in) }
const IDSeparator = "-"
type IDType string
const (
// type values copied from subsonic
IDTypeArtist IDType = "ar"
IDTypeAlbum IDType = "al"
IDTypeTrack IDType = "tr"
)
type ID struct {
Type IDType
Value int
}
func IDArtist(id int) string { return fmt.Sprintf("%d-%s", id, IDTypeArtist) }
func IDAlbum(id int) string { return fmt.Sprintf("%d-%s", id, IDTypeAlbum) }
func IDTrack(id int) string { return fmt.Sprintf("%d-%s", id, IDTypeTrack) }
// ** begin type parsing, support {[],}{string,int,ID} => 6 types
func parse(values []string, i interface{}) error { func parse(values []string, i interface{}) error {
if len(values) == 0 { if len(values) == 0 {
return ErrKeyNotFound return errors.New("no values provided")
} }
var err error var err error
switch v := i.(type) { switch v := i.(type) {
@@ -72,37 +50,37 @@ func parse(values []string, i interface{}) error {
*v, err = parseStr(values[0]) *v, err = parseStr(values[0])
case *int: case *int:
*v, err = parseInt(values[0]) *v, err = parseInt(values[0])
case *ID: case *ids.IDV:
*v, err = parseID(values[0]) *v, err = parseID(values[0])
case *bool: case *bool:
*v, err = parseBool(values[0]) *v, err = parseBool(values[0])
case *[]string: case *[]string:
for _, val := range values { for _, value := range values {
parsed, err := parseStr(val) parsed, err := parseStr(value)
if err != nil { if err != nil {
return err return err
} }
*v = append(*v, parsed) *v = append(*v, parsed)
} }
case *[]int: case *[]int:
for _, val := range values { for _, value := range values {
parsed, err := parseInt(val) parsed, err := parseInt(value)
if err != nil { if err != nil {
return err return err
} }
*v = append(*v, parsed) *v = append(*v, parsed)
} }
case *[]ID: case *[]ids.IDV:
for _, val := range values { for _, value := range values {
parsed, err := parseID(val) parsed, err := parseID(value)
if err != nil { if err != nil {
return err return err
} }
*v = append(*v, parsed) *v = append(*v, parsed)
} }
case *[]bool: case *[]bool:
for _, val := range values { for _, value := range values {
parsed, err := parseBool(val) parsed, err := parseBool(value)
if err != nil { if err != nil {
return err return err
} }
@@ -112,48 +90,6 @@ func parse(values []string, i interface{}) error {
return err return err
} }
// ** begin parse funcs
func parseStr(in string) (string, error) {
return in, nil
}
func parseInt(in string) (int, error) {
if v, err := strconv.Atoi(in); err == nil {
return v, nil
}
return 0, ErrIDNotAnInt
}
func parseID(in string) (ID, error) {
parts := strings.Split(in, IDSeparator)
if len(parts) != 2 {
return ID{}, fmt.Errorf("bad separator: %w", ErrIDInvalid)
}
partType := parts[0]
partValue := parts[1]
val, err := parseInt(partValue)
if err != nil {
return ID{}, fmt.Errorf("%s: %w", partValue, err)
}
switch partType {
case string(IDTypeArtist):
return ID{Type: IDTypeArtist, Value: val}, nil
case string(IDTypeAlbum):
return ID{Type: IDTypeAlbum, Value: val}, nil
case string(IDTypeTrack):
return ID{Type: IDTypeTrack, Value: val}, nil
}
return ID{}, ErrIDInvalid
}
func parseBool(in string) (bool, error) {
if v, err := strconv.ParseBool(in); err == nil {
return v, nil
}
return false, ErrIDNotABool
}
type Params url.Values type Params url.Values
func New(r *http.Request) Params { func New(r *http.Request) Params {
@@ -293,61 +229,56 @@ func (p Params) GetFirstOrIntList(or []int, keys ...string) []int {
return or return or
} }
// ** begin ID {get, get first, get or, get first or} // ** begin ids.IDV {get, get first, get or, get first or}
func (p Params) GetID(key string) (ID, error) { func (p Params) GetID(key string) (ids.IDV, error) {
var ret ID var ret ids.IDV
return ret, parse(p.get(key), &ret) return ret, parse(p.get(key), &ret)
} }
func (p Params) GetIDDefault() (ID, error) { func (p Params) GetFirstID(keys ...string) (ids.IDV, error) {
var ret ID var ret ids.IDV
return ret, parse(p.get("id"), &ret)
}
func (p Params) GetFirstID(keys ...string) (ID, error) {
var ret ID
return ret, parse(p.getFirst(keys), &ret) return ret, parse(p.getFirst(keys), &ret)
} }
func (p Params) GetOrID(key string, or ID) ID { func (p Params) GetOrID(key string, or ids.IDV) ids.IDV {
var ret ID var ret ids.IDV
if err := parse(p.get(key), &ret); err == nil { if err := parse(p.get(key), &ret); err == nil {
return ret return ret
} }
return or return or
} }
func (p Params) GetFirstOrID(or ID, keys ...string) ID { func (p Params) GetFirstOrID(or ids.IDV, keys ...string) ids.IDV {
var ret ID var ret ids.IDV
if err := parse(p.getFirst(keys), &ret); err == nil { if err := parse(p.getFirst(keys), &ret); err == nil {
return ret return ret
} }
return or return or
} }
// ** begin []ID {get, get first, get or, get first or} // ** begin []ids.IDV {get, get first, get or, get first or}
func (p Params) GetIDList(key string) ([]ID, error) { func (p Params) GetIDList(key string) ([]ids.IDV, error) {
var ret []ID var ret []ids.IDV
return ret, parse(p.get(key), &ret) return ret, parse(p.get(key), &ret)
} }
func (p Params) GetFirstIDList(keys ...string) ([]ID, error) { func (p Params) GetFirstIDList(keys ...string) ([]ids.IDV, error) {
var ret []ID var ret []ids.IDV
return ret, parse(p.getFirst(keys), &ret) return ret, parse(p.getFirst(keys), &ret)
} }
func (p Params) GetOrIDList(key string, or []ID) []ID { func (p Params) GetOrIDList(key string, or []ids.IDV) []ids.IDV {
var ret []ID var ret []ids.IDV
if err := parse(p.get(key), &ret); err == nil { if err := parse(p.get(key), &ret); err == nil {
return ret return ret
} }
return or return or
} }
func (p Params) GetFirstOrIDList(or []ID, keys ...string) []ID { func (p Params) GetFirstOrIDList(or []ids.IDV, keys ...string) []ids.IDV {
var ret []ID var ret []ids.IDV
if err := parse(p.getFirst(keys), &ret); err == nil { if err := parse(p.getFirst(keys), &ret); err == nil {
return ret return ret
} }

61
server/ctrlsubsonic/params/params_test.go
View File

@@ -1,61 +0,0 @@
package params
import (
"errors"
"testing"
)
func TestParseID(t *testing.T) {
tcases := []struct {
param string
expType IDType
expValue int
expErr error
}{
{param: "al-45", expType: IDTypeAlbum, expValue: 45},
{param: "ar-2", expType: IDTypeArtist, expValue: 2},
{param: "tr-43", expType: IDTypeTrack, expValue: 43},
{param: "xx-1", expErr: ErrIDInvalid},
{param: "al-howdy", expErr: ErrIDNotAnInt},
}
for _, tcase := range tcases {
t.Run(tcase.param, func(t *testing.T) {
act, err := parseID(tcase.param)
if err != nil && !errors.Is(err, tcase.expErr) {
t.Fatalf("expected err %q, got %q", tcase.expErr, err)
}
if act.Value != tcase.expValue {
t.Errorf("expected value %d, got %d", tcase.expValue, act.Value)
}
if act.Type != tcase.expType {
t.Errorf("expected type %v, got %v", tcase.expType, act.Type)
}
})
}
}
// TODO?
func TestGet(t *testing.T) {}
func TestGetFirst(t *testing.T) {}
func TestGetOr(t *testing.T) {}
func TestGetList(t *testing.T) {}
func TestGetFirstList(t *testing.T) {}
func TestGetOrList(t *testing.T) {}
func TestGetInt(t *testing.T) {}
func TestGetFirstInt(t *testing.T) {}
func TestGetOrInt(t *testing.T) {}
func TestGetIntList(t *testing.T) {}
func TestGetFirstIntList(t *testing.T) {}
func TestGetOrIntList(t *testing.T) {}
func TestGetID(t *testing.T) {}
func TestGetFirstID(t *testing.T) {}
func TestGetOrID(t *testing.T) {}
func TestGetIDList(t *testing.T) {}
func TestGetFirstIDList(t *testing.T) {}
func TestGetOrIDList(t *testing.T) {}
func TestGetBool(t *testing.T) {}
func TestGetFirstBool(t *testing.T) {}
func TestGetOrBool(t *testing.T) {}
func TestGetBoolList(t *testing.T) {}
func TestGetFirstBoolList(t *testing.T) {}
func TestGetOrBoolList(t *testing.T) {}

19
server/ctrlsubsonic/spec/construct_by_folder.go
View File

@@ -3,15 +3,16 @@ package spec
import ( import (
"path" "path"
"go.senan.xyz/gonic/server/ctrlsubsonic/params"
"go.senan.xyz/gonic/server/db" "go.senan.xyz/gonic/server/db"
) )
func NewAlbumByFolder(f *db.Album) *Album { func NewAlbumByFolder(f *db.Album) *Album {
a := &Album{ a := &Album{
Artist: f.Parent.RightPath, Artist: f.Parent.RightPath,
ID: f.ID, ID: params.IDAlbum(f.ID),
IsDir: true, IsDir: true,
ParentID: f.ParentID, ParentID: params.IDAlbum(f.ParentID),
Title: f.RightPath, Title: f.RightPath,
TrackCount: f.ChildCount, TrackCount: f.ChildCount,
} }
@@ -23,10 +24,10 @@ func NewAlbumByFolder(f *db.Album) *Album {
func NewTCAlbumByFolder(f *db.Album) *TrackChild { func NewTCAlbumByFolder(f *db.Album) *TrackChild {
trCh := &TrackChild{ trCh := &TrackChild{
ID: f.ID, ID: params.IDAlbum(f.ID),
IsDir: true, IsDir: true,
Title: f.RightPath, Title: f.RightPath,
ParentID: f.ParentID, ParentID: params.IDAlbum(f.ParentID),
CreatedAt: f.UpdatedAt, CreatedAt: f.UpdatedAt,
} }
if f.Cover != "" { if f.Cover != "" {
@@ -37,7 +38,7 @@ func NewTCAlbumByFolder(f *db.Album) *TrackChild {
func NewTCTrackByFolder(t *db.Track, parent *db.Album) *TrackChild { func NewTCTrackByFolder(t *db.Track, parent *db.Album) *TrackChild {
trCh := &TrackChild{ trCh := &TrackChild{
ID: t.ID, ID: params.IDTrack(t.ID),
ContentType: t.MIME(), ContentType: t.MIME(),
Suffix: t.Ext(), Suffix: t.Ext(),
Size: t.Size, Size: t.Size,
@@ -50,7 +51,7 @@ func NewTCTrackByFolder(t *db.Track, parent *db.Album) *TrackChild {
parent.RightPath, parent.RightPath,
t.Filename, t.Filename,
), ),
ParentID: parent.ID, ParentID: params.IDAlbum(parent.ID),
Duration: t.Length, Duration: t.Length,
Bitrate: t.Bitrate, Bitrate: t.Bitrate,
IsDir: false, IsDir: false,
@@ -67,8 +68,12 @@ func NewTCTrackByFolder(t *db.Track, parent *db.Album) *TrackChild {
} }
func NewArtistByFolder(f *db.Album) *Artist { func NewArtistByFolder(f *db.Album) *Artist {
// the db is structued around "browse by tags", and where
// an album is also a folder. so we're constructing an artist
// from an "album" where
// maybe TODO: rename the Album model to Folder
return &Artist{ return &Artist{
ID: f.ID, ID: params.IDAlbum(f.ID),
Name: f.RightPath, Name: f.RightPath,
AlbumCount: f.ChildCount, AlbumCount: f.ChildCount,
} }

24
server/ctrlsubsonic/spec/spec.go
View File

@@ -90,14 +90,14 @@ type Albums struct {
type Album struct { type Album struct {
// common // common
ID int `xml:"id,attr,omitempty" json:"id,string"` ID string `xml:"id,attr,omitempty" json:"id"`
CoverID int `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty,string"` CoverID int `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty,string"`
ArtistID int `xml:"artistId,attr,omitempty" json:"artistId,omitempty,string"` ArtistID string `xml:"artistId,attr,omitempty" json:"artistId,omitempty"`
Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"` Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"`
// browsing by folder (eg. getAlbumList) // browsing by folder (eg. getAlbumList)
Title string `xml:"title,attr" json:"title"` Title string `xml:"title,attr" json:"title"`
Album string `xml:"album,attr" json:"album"` Album string `xml:"album,attr" json:"album"`
ParentID int `xml:"parent,attr,omitempty" json:"parent,omitempty,string"` ParentID string `xml:"parent,attr,omitempty" json:"parent,omitempty"`
IsDir bool `xml:"isDir,attr,omitempty" json:"isDir,omitempty"` IsDir bool `xml:"isDir,attr,omitempty" json:"isDir,omitempty"`
// browsing by tags (eg. getAlbumList2) // browsing by tags (eg. getAlbumList2)
Name string `xml:"name,attr" json:"name"` Name string `xml:"name,attr" json:"name"`
@@ -119,19 +119,19 @@ type TracksByGenre struct {
type TrackChild struct { type TrackChild struct {
Album string `xml:"album,attr,omitempty" json:"album,omitempty"` Album string `xml:"album,attr,omitempty" json:"album,omitempty"`
AlbumID int `xml:"albumId,attr,omitempty" json:"albumId,omitempty,string"` AlbumID string `xml:"albumId,attr,omitempty" json:"albumId,omitempty"`
Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"` Artist string `xml:"artist,attr,omitempty" json:"artist,omitempty"`
ArtistID int `xml:"artistId,attr,omitempty" json:"artistId,omitempty,string"` ArtistID string `xml:"artistId,attr,omitempty" json:"artistId,omitempty"`
Bitrate int `xml:"bitRate,attr,omitempty" json:"bitRate,omitempty"` Bitrate int `xml:"bitRate,attr,omitempty" json:"bitRate,omitempty"`
ContentType string `xml:"contentType,attr,omitempty" json:"contentType,omitempty"` ContentType string `xml:"contentType,attr,omitempty" json:"contentType,omitempty"`
CoverID int `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty,string"` CoverID int `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty,string"`
CreatedAt time.Time `xml:"created,attr,omitempty" json:"created,omitempty"` CreatedAt time.Time `xml:"created,attr,omitempty" json:"created,omitempty"`
Duration int `xml:"duration,attr,omitempty" json:"duration,omitempty"` Duration int `xml:"duration,attr,omitempty" json:"duration,omitempty"`
Genre string `xml:"genre,attr,omitempty" json:"genre,omitempty"` Genre string `xml:"genre,attr,omitempty" json:"genre,omitempty"`
ID int `xml:"id,attr,omitempty" json:"id,omitempty,string"` ID string `xml:"id,attr,omitempty" json:"id,omitempty"`
IsDir bool `xml:"isDir,attr" json:"isDir"` IsDir bool `xml:"isDir,attr" json:"isDir"`
IsVideo bool `xml:"isVideo,attr" json:"isVideo"` IsVideo bool `xml:"isVideo,attr" json:"isVideo"`
ParentID int `xml:"parent,attr,omitempty" json:"parent,omitempty,string"` ParentID string `xml:"parent,attr,omitempty" json:"parent,omitempty"`
Path string `xml:"path,attr,omitempty" json:"path,omitempty"` Path string `xml:"path,attr,omitempty" json:"path,omitempty"`
Size int `xml:"size,attr,omitempty" json:"size,omitempty"` Size int `xml:"size,attr,omitempty" json:"size,omitempty"`
Suffix string `xml:"suffix,attr,omitempty" json:"suffix,omitempty"` Suffix string `xml:"suffix,attr,omitempty" json:"suffix,omitempty"`
@@ -147,7 +147,7 @@ type Artists struct {
} }
type Artist struct { type Artist struct {
ID int `xml:"id,attr,omitempty" json:"id,string"` ID string `xml:"id,attr,omitempty" json:"id"`
Name string `xml:"name,attr" json:"name"` Name string `xml:"name,attr" json:"name"`
CoverID int `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty,string"` CoverID int `xml:"coverArt,attr,omitempty" json:"coverArt,omitempty,string"`
AlbumCount int `xml:"albumCount,attr" json:"albumCount"` AlbumCount int `xml:"albumCount,attr" json:"albumCount"`
@@ -166,8 +166,8 @@ type Index struct {
} }
type Directory struct { type Directory struct {
ID int `xml:"id,attr,omitempty" json:"id,string"` ID string `xml:"id,attr,omitempty" json:"id"`
ParentID int `xml:"parent,attr,omitempty" json:"parent,omitempty,string"` ParentID string `xml:"parent,attr,omitempty" json:"parent,omitempty"`
Name string `xml:"name,attr,omitempty" json:"name"` Name string `xml:"name,attr,omitempty" json:"name"`
Starred string `xml:"starred,attr,omitempty" json:"starred,omitempty"` Starred string `xml:"starred,attr,omitempty" json:"starred,omitempty"`
Children []*TrackChild `xml:"child,omitempty" json:"child,omitempty"` Children []*TrackChild `xml:"child,omitempty" json:"child,omitempty"`
@@ -178,7 +178,7 @@ type MusicFolders struct {
} }
type MusicFolder struct { type MusicFolder struct {
ID int `xml:"id,attr,omitempty" json:"id,omitempty,string"` ID string `xml:"id,attr,omitempty" json:"id,omitempty"`
Name string `xml:"name,attr,omitempty" json:"name,omitempty"` Name string `xml:"name,attr,omitempty" json:"name,omitempty"`
} }
@@ -238,7 +238,7 @@ type Playlist struct {
} }
type SimilarArtist struct { type SimilarArtist struct {
ID int `xml:"id,attr" json:"id,string"` ID string `xml:"id,attr" json:"id"`
Name string `xml:"name,attr" json:"name"` Name string `xml:"name,attr" json:"name"`
AlbumCount int `xml:"albumCount,attr,omitempty" json:"albumCount,omitempty"` AlbumCount int `xml:"albumCount,attr,omitempty" json:"albumCount,omitempty"`
} }

59
server/ids/ids.go Normal file
View File

@@ -0,0 +1,59 @@
package ids
// this package is at such a high level in the hierarchy because
// it's used by both `server/db` (for now) and `server/ctrlsubsonic`
import (
"errors"
"fmt"
"strconv"
"strings"
)
var (
ErrBadSeparator = errors.New("bad separator")
ErrNotAnInt = errors.New("not an int")
ErrBadPrefix = errors.New("bad prefix")
)
type ID string
const (
// type values copied from subsonic
Artist ID = "ar"
Album ID = "al"
Track ID = "tr"
)
var accepted = []ID{Artist,
Album,
Track,
}
type IDV struct {
Type ID
Value int
}
func (i IDV) String() string {
return fmt.Sprintf("%s-%d", i.Type, i.Value)
}
func Parse(in string) (IDV, error) {
parts := strings.Split(in, "-")
if len(parts) != 2 {
return IDV{}, ErrBadSeparator
}
partType := parts[0]
partValue := parts[1]
val, err := strconv.Atoi(partValue)
if err != nil {
return IDV{}, fmt.Errorf("%q: %w", partValue, ErrNotAnInt)
}
for _, acc := range accepted {
if partType == string(acc) {
return IDV{Type: acc, Value: val}, nil
}
}
return IDV{}, fmt.Errorf("%q: %w", partType, ErrBadPrefix)
}

35
server/ids/ids_test.go Normal file
View File

@@ -0,0 +1,35 @@
package ids
import (
"errors"
"testing"
)
func TestParse(t *testing.T) {
tcases := []struct {
param string
expType ID
expValue int
expErr error
}{
{param: "al-45", expType: Album, expValue: 45},
{param: "ar-2", expType: Artist, expValue: 2},
{param: "tr-43", expType: Track, expValue: 43},
{param: "xx-1", expErr: ErrBadPrefix},
{param: "al-howdy", expErr: ErrNotAnInt},
}
for _, tcase := range tcases {
t.Run(tcase.param, func(t *testing.T) {
act, err := Parse(tcase.param)
if !errors.Is(err, tcase.expErr) {
t.Fatalf("expected err %q, got %q", tcase.expErr, err)
}
if act.Value != tcase.expValue {
t.Errorf("expected value %d, got %d", tcase.expValue, act.Value)
}
if act.Type != tcase.expType {
t.Errorf("expected type %v, got %v", tcase.expType, act.Type)
}
})
}
}