marc/scotty
1
0
Fork 0
mirror of https://git.sr.ht/~phw/scotty synced 2025-04-25 22:07:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Basic backend structure and listen transfer implementation

Browse source
This commit is contained in:
Philipp Wolfer 2023-11-09 14:35:10 +01:00
parent 80ef3f23c0
commit 8661075975
No known key found for this signature in database
GPG key ID: 8FDF744D4919943B
6 changed files with 254 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

79
backends/base.go Normal file
View file

@ -0,0 +1,79 @@
/*
Copyright © 2023 Philipp Wolfer <phw@uploadedlobster.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package backends
import (
"errors"
"fmt"
"reflect"
"time"
"github.com/spf13/viper"
)
type Backend interface {
FromConfig(config *viper.Viper) Backend
}
type ListenExport interface {
ExportListens(oldestTimestamp time.Time) ([]Listen, error)
}
type ListenImport interface {
ImportListens(listens []Listen, oldestTimestamp time.Time) (ImportResult, error)
}
type ImportResult struct {
Count int
LastTimestamp time.Time
}
func resolveBackend(config *viper.Viper) (string, Backend, error) {
backendName := config.GetString("backend")
fmt.Printf("requested backend %s\n", backendName)
backendType := knownBackends[backendName]
if backendType == nil {
return backendName, nil, errors.New(fmt.Sprintf("Unknown backend %s", backendName))
}
return backendName, backendType().FromConfig(config), nil
}
func ResolveBackend[T interface{}](config *viper.Viper) (T, error) {
expectedInterface := reflect.TypeOf((*T)(nil)).Elem()
backendName, backend, err := resolveBackend(config)
var result T
if err != nil {
return result, err
}
if backend != nil && reflect.TypeOf(backend).Implements(expectedInterface) {
result = backend.(T)
} else {
err = errors.New(
fmt.Sprintf("Backend %s does not implement %s", backendName, expectedInterface.String()))
}
return result, err
}
var knownBackends = map[string]func() Backend{
"dump": func() Backend { return &DumpBackend{} },
"scrobbler-log": func() Backend { return &ScrobblerLogBackend{} },
}

49
backends/dump.go Normal file
View file

@ -0,0 +1,49 @@
/*
Copyright © 2023 Philipp Wolfer <phw@uploadedlobster.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package backends
import (
"fmt"
"time"
"github.com/spf13/viper"
)
type DumpBackend struct{}
func (b DumpBackend) FromConfig(config *viper.Viper) Backend {
return b
}
func (b DumpBackend) ImportListens(listens []Listen, oldestTimestamp time.Time) (ImportResult, error) {
result := ImportResult{
Count: len(listens),
LastTimestamp: oldestTimestamp,
}
if result.Count > 0 {
result.LastTimestamp = listens[len(listens)-1].ListenedAt
}
for _, listen := range listens {
fmt.Printf("Listen: \"%s\" by %s\n", listen.TrackName, listen.ArtistName())
}
return result, nil
}

58
backends/models.go Normal file
View file

@ -0,0 +1,58 @@
/*
Copyright © 2023 Philipp Wolfer <phw@uploadedlobster.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package backends
import (
"strings"
"time"
)
type MBID string
type AdditionalInfo map[string]string
type Track struct {
TrackName string
ReleaseName string
ArtistNames []string
TrackNumber int
Duration time.Duration
Isrc string
RecordingMbid MBID
ReleaseMbid MBID
ReleaseGroupMbid MBID
ArtistMbids []MBID
WorkMbids []MBID
Tags []string
AdditionalInfo AdditionalInfo
}
func (t Track) ArtistName() string {
return strings.Join(t.ArtistNames, ", ")
}
type Listen struct {
Track
ListenedAt time.Time
ListenDuration time.Duration
UserName string
}

43
backends/scrobblerlog.go Normal file
View file

@ -0,0 +1,43 @@
/*
Copyright © 2023 Philipp Wolfer <phw@uploadedlobster.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
*/
package backends
import (
"time"
"github.com/spf13/viper"
)
type ScrobblerLogBackend struct {
filePath string
includeSkipped bool
}
func (b ScrobblerLogBackend) FromConfig(config *viper.Viper) Backend {
b.filePath = config.GetString("file-path")
b.includeSkipped = config.GetBool("include-skipped")
return b
}
func (b ScrobblerLogBackend) ExportListens(oldestTimestamp time.Time) ([]Listen, error) {
return nil, nil
}