feat(lists): integrate Omegabrr (#1885)

* feat(lists): integrate Omegabrr

* feat(lists): add missing lists index

* feat(lists): add db repo

* feat(lists): add db migrations

* feat(lists): labels

* feat(lists): url lists and more arrs

* fix(lists): db migrations client_id wrong type

* fix(lists): db fields

* feat(lists): create list form wip

* feat(lists): show in list and create

* feat(lists): update and delete

* feat(lists): trigger via webhook

* feat(lists): add webhook handler

* fix(arr): encode json to pointer

* feat(lists): rename endpoint to lists

* feat(lists): fetch tags from arr

* feat(lists): process plaintext lists

* feat(lists): add background refresh job

* run every 6th hour with a random start delay between 1-35 seconds

* feat(lists): refresh on save and improve logging

* feat(lists): cast arr client to pointer

* feat(lists): improve error handling

* feat(lists): reset shows field with match release

* feat(lists): filter opts all lists

* feat(lists): trigger on update if enabled

* feat(lists): update option for lists

* feat(lists): show connected filters in list

* feat(lists): missing listSvc dep

* feat(lists): cleanup

* feat(lists): typo arr list

* feat(lists): radarr include original

* feat(lists): rename ExcludeAlternateTitle to IncludeAlternateTitle

* fix(lists): arr client type conversion to pointer

* fix(actions): only log panic recover if err not nil

* feat(lists): show spinner on save

* feat(lists): show icon in filters list

* feat(lists): change icon color in filters list

* feat(lists): delete relations on filter delete
This commit is contained in:
ze0s 2024-12-25 13:23:37 +01:00 committed by GitHub
parent b68ae334ca
commit 221bc35371
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
77 changed files with 5025 additions and 254 deletions

200
pkg/arr/readarr/client.go Normal file
View file

@ -0,0 +1,200 @@
// Copyright (c) 2021 - 2024, Ludvig Lundgren and the autobrr contributors.
// SPDX-License-Identifier: GPL-2.0-or-later
package readarr
import (
"bytes"
"context"
"encoding/json"
"io"
"net/http"
"net/url"
"path"
"github.com/autobrr/autobrr/pkg/errors"
)
func (c *Client) get(ctx context.Context, endpoint string) (int, []byte, error) {
u, err := url.Parse(c.config.Hostname)
if err != nil {
return 0, nil, errors.Wrap(err, "could not parse url: %s", c.config.Hostname)
}
u.Path = path.Join(u.Path, "/api/v1/", endpoint)
reqUrl := u.String()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqUrl, http.NoBody)
if err != nil {
return 0, nil, errors.Wrap(err, "could not build request")
}
if c.config.BasicAuth {
req.SetBasicAuth(c.config.Username, c.config.Password)
}
c.setHeaders(req)
resp, err := c.http.Do(req)
if err != nil {
return 0, nil, errors.Wrap(err, "readarr.http.Do(req): %+v", req)
}
defer resp.Body.Close()
if resp.Body == nil {
return resp.StatusCode, nil, errors.New("response body is nil")
}
var buf bytes.Buffer
if _, err = io.Copy(&buf, resp.Body); err != nil {
return resp.StatusCode, nil, errors.Wrap(err, "readarr.io.Copy")
}
return resp.StatusCode, buf.Bytes(), nil
}
func (c *Client) getJSON(ctx context.Context, endpoint string, params url.Values, data any) error {
u, err := url.Parse(c.config.Hostname)
if err != nil {
return errors.Wrap(err, "could not parse url: %s", c.config.Hostname)
}
u.Path = path.Join(u.Path, "/api/v1/", endpoint)
reqUrl := u.String()
req, err := http.NewRequestWithContext(ctx, http.MethodGet, reqUrl, http.NoBody)
if err != nil {
return errors.Wrap(err, "could not build request")
}
if c.config.BasicAuth {
req.SetBasicAuth(c.config.Username, c.config.Password)
}
c.setHeaders(req)
req.URL.RawQuery = params.Encode()
resp, err := c.http.Do(req)
if err != nil {
return errors.Wrap(err, "readarr.http.Do(req): %+v", req)
}
defer resp.Body.Close()
if resp.Body == nil {
return errors.New("response body is nil")
}
if err := json.NewDecoder(resp.Body).Decode(&data); err != nil {
return errors.Wrap(err, "could not unmarshal data")
}
return nil
}
func (c *Client) post(ctx context.Context, endpoint string, data interface{}) (*http.Response, error) {
u, err := url.Parse(c.config.Hostname)
if err != nil {
return nil, errors.Wrap(err, "could not parse url: %s", c.config.Hostname)
}
u.Path = path.Join(u.Path, "/api/v1/", endpoint)
reqUrl := u.String()
jsonData, err := json.Marshal(data)
if err != nil {
return nil, errors.Wrap(err, "could not marshal data: %+v", data)
}
req, err := http.NewRequestWithContext(ctx, http.MethodPost, reqUrl, bytes.NewBuffer(jsonData))
if err != nil {
return nil, errors.Wrap(err, "could not build request")
}
if c.config.BasicAuth {
req.SetBasicAuth(c.config.Username, c.config.Password)
}
req.Header.Add("X-Api-Key", c.config.APIKey)
req.Header.Set("Content-Type", "application/json; charset=UTF-8")
req.Header.Set("User-Agent", "autobrr")
res, err := c.http.Do(req)
if err != nil {
return nil, errors.Wrap(err, "could not make request: %+v", req)
}
// validate response
if res.StatusCode == http.StatusUnauthorized {
return res, errors.New("unauthorized: bad credentials")
} else if res.StatusCode != http.StatusOK {
return res, errors.New("readarr: bad request")
}
// return raw response and let the caller handle json unmarshal of body
return res, nil
}
func (c *Client) postBody(ctx context.Context, endpoint string, data interface{}) (int, []byte, error) {
u, err := url.Parse(c.config.Hostname)
if err != nil {
return 0, nil, errors.Wrap(err, "could not parse url: %s", c.config.Hostname)
}
u.Path = path.Join(u.Path, "/api/v1/", endpoint)
reqUrl := u.String()
jsonData, err := json.Marshal(data)
if err != nil {
return 0, nil, errors.Wrap(err, "could not marshal data: %+v", data)
}
c.Log.Printf("readarr push JSON: %s\n", string(jsonData))
req, err := http.NewRequestWithContext(ctx, http.MethodPost, reqUrl, bytes.NewBuffer(jsonData))
if err != nil {
return 0, nil, errors.Wrap(err, "could not build request")
}
if c.config.BasicAuth {
req.SetBasicAuth(c.config.Username, c.config.Password)
}
c.setHeaders(req)
resp, err := c.http.Do(req)
if err != nil {
return 0, nil, errors.Wrap(err, "readarr.http.Do(req): %+v", req)
}
defer resp.Body.Close()
if resp.Body == nil {
return resp.StatusCode, nil, errors.New("response body is nil")
}
var buf bytes.Buffer
if _, err = io.Copy(&buf, resp.Body); err != nil {
return resp.StatusCode, nil, errors.Wrap(err, "readarr.io.Copy")
}
if resp.StatusCode == http.StatusBadRequest {
return resp.StatusCode, buf.Bytes(), nil
} else if resp.StatusCode < 200 || resp.StatusCode > 401 {
return resp.StatusCode, buf.Bytes(), errors.New("readarr: bad request: %v (status: %s): %s", resp.Request.RequestURI, resp.Status, buf.String())
}
return resp.StatusCode, buf.Bytes(), nil
}
func (c *Client) setHeaders(req *http.Request) {
if req.Body != nil {
req.Header.Set("Content-Type", "application/json")
}
req.Header.Set("User-Agent", "autobrr")
req.Header.Set("X-Api-Key", c.config.APIKey)
}

150
pkg/arr/readarr/readarr.go Normal file
View file

@ -0,0 +1,150 @@
// Copyright (c) 2021 - 2024, Ludvig Lundgren and the autobrr contributors.
// SPDX-License-Identifier: GPL-2.0-or-later
package readarr
import (
"context"
"encoding/json"
"io"
"net/http"
"net/url"
"strings"
"time"
"log"
"github.com/autobrr/autobrr/pkg/arr"
"github.com/autobrr/autobrr/pkg/errors"
"github.com/autobrr/autobrr/pkg/sharedhttp"
)
type Config struct {
Hostname string
APIKey string
// basic auth username and password
BasicAuth bool
Username string
Password string
Log *log.Logger
}
type ClientInterface interface {
Test(ctx context.Context) (*SystemStatusResponse, error)
Push(ctx context.Context, release Release) ([]string, error)
}
type Client struct {
config Config
http *http.Client
Log *log.Logger
}
// New create new readarr Client
func New(config Config) *Client {
httpClient := &http.Client{
Timeout: time.Second * 120,
Transport: sharedhttp.Transport,
}
c := &Client{
config: config,
http: httpClient,
Log: log.New(io.Discard, "", log.LstdFlags),
}
if config.Log != nil {
c.Log = config.Log
}
return c
}
func (c *Client) Test(ctx context.Context) (*SystemStatusResponse, error) {
status, res, err := c.get(ctx, "system/status")
if err != nil {
return nil, errors.Wrap(err, "could not make Test")
}
if status == http.StatusUnauthorized {
return nil, errors.New("unauthorized: bad credentials")
}
c.Log.Printf("readarr system/status status: (%v) response: %v\n", status, string(res))
response := SystemStatusResponse{}
if err = json.Unmarshal(res, &response); err != nil {
return nil, errors.Wrap(err, "could not unmarshal data")
}
return &response, nil
}
func (c *Client) Push(ctx context.Context, release Release) ([]string, error) {
status, res, err := c.postBody(ctx, "release/push", release)
if err != nil {
return nil, errors.Wrap(err, "could not push release to readarr")
}
c.Log.Printf("readarr release/push status: (%v) response: %v\n", status, string(res))
if status == http.StatusBadRequest {
badRequestResponses := make([]*BadRequestResponse, 0)
if err = json.Unmarshal(res, &badRequestResponses); err != nil {
return nil, errors.Wrap(err, "could not unmarshal data")
}
rejections := []string{}
for _, response := range badRequestResponses {
rejections = append(rejections, response.String())
}
return rejections, nil
}
// pushResponse := make([]PushResponse, 0)
var pushResponse PushResponse
if err = json.Unmarshal(res, &pushResponse); err != nil {
return nil, errors.Wrap(err, "could not unmarshal data")
}
// log and return if rejected
if pushResponse.Rejected {
rejections := strings.Join(pushResponse.Rejections, ", ")
c.Log.Printf("readarr release/push rejected %v reasons: %q\n", release.Title, rejections)
return pushResponse.Rejections, nil
}
// successful push
return nil, nil
}
func (c *Client) GetBooks(ctx context.Context, gridID string) ([]Book, error) {
params := make(url.Values)
if gridID != "" {
params.Set("titleSlug", gridID)
}
data := make([]Book, 0)
err := c.getJSON(ctx, "book", params, &data)
if err != nil {
return nil, errors.Wrap(err, "could not get tags")
}
return data, nil
}
func (c *Client) GetTags(ctx context.Context) ([]*arr.Tag, error) {
data := make([]*arr.Tag, 0)
err := c.getJSON(ctx, "tag", nil, &data)
if err != nil {
return nil, errors.Wrap(err, "could not get tags")
}
return data, nil
}

View file

@ -0,0 +1,164 @@
// Copyright (c) 2021 - 2024, Ludvig Lundgren and the autobrr contributors.
// SPDX-License-Identifier: GPL-2.0-or-later
//go:build integration
package readarr
import (
"context"
"net/http"
"net/http/httptest"
"os"
"testing"
"github.com/rs/zerolog"
"github.com/stretchr/testify/assert"
)
func Test_client_Push(t *testing.T) {
// disable logger
zerolog.SetGlobalLevel(zerolog.Disabled)
mux := http.NewServeMux()
ts := httptest.NewServer(mux)
defer ts.Close()
key := "mock-key"
mux.HandleFunc("/api/v1/release/push", func(w http.ResponseWriter, r *http.Request) {
// request validation logic
apiKey := r.Header.Get("X-Api-Key")
if apiKey != "" {
if apiKey != key {
w.WriteHeader(http.StatusUnauthorized)
w.Write(nil)
return
}
}
// read json response
jsonPayload, _ := os.ReadFile("testdata/release_push_ok_response.json")
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write(jsonPayload)
})
type fields struct {
config Config
}
type args struct {
release Release
}
tests := []struct {
name string
fields fields
args args
err error
rejections []string
wantErr bool
}{
{
name: "push",
fields: fields{
config: Config{
Hostname: ts.URL,
APIKey: "",
BasicAuth: false,
Username: "",
Password: "",
},
},
args: args{release: Release{
Title: "The Best Book by Famous Author [English / epub, mobi]",
DownloadUrl: "https://www.mock-indexer.test/tor/download.php?tid=000000",
Size: 1048576,
Indexer: "mock-indexer",
DownloadProtocol: "torrent",
Protocol: "torrent",
PublishDate: "2022-10-14T17:36:15Z",
}},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
c := New(tt.fields.config)
rejections, err := c.Push(context.Background(), tt.args.release)
assert.Equal(t, tt.rejections, rejections)
if tt.wantErr && assert.Error(t, err) {
assert.Equal(t, tt.err, err)
}
})
}
}
func Test_client_Test(t *testing.T) {
// disable logger
zerolog.SetGlobalLevel(zerolog.Disabled)
key := "mock-key"
srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
apiKey := r.Header.Get("X-Api-Key")
if apiKey != "" {
if apiKey != key {
w.WriteHeader(http.StatusUnauthorized)
w.Write(nil)
return
}
}
jsonPayload, _ := os.ReadFile("testdata/system_status_response_ok.json")
w.Header().Set("Content-Type", "application/json")
w.WriteHeader(http.StatusOK)
w.Write(jsonPayload)
}))
defer srv.Close()
tests := []struct {
name string
cfg Config
want *SystemStatusResponse
expectedErr string
wantErr bool
}{
{
name: "fetch",
cfg: Config{
Hostname: srv.URL,
APIKey: key,
BasicAuth: false,
Username: "",
Password: "",
},
want: &SystemStatusResponse{AppName: "Readarr", Version: "0.1.1.1320"},
expectedErr: "",
wantErr: false,
},
{
name: "fetch_unauthorized",
cfg: Config{
Hostname: srv.URL,
APIKey: "bad-mock-key",
BasicAuth: false,
Username: "",
Password: "",
},
want: nil,
wantErr: true,
expectedErr: "unauthorized: bad credentials",
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
c := New(tt.cfg)
got, err := c.Test(context.Background())
if tt.wantErr && assert.Error(t, err) {
assert.EqualErrorf(t, err, tt.expectedErr, "Error should be: %v, got: %v", tt.wantErr, err)
}
assert.Equal(t, tt.want, got)
})
}
}

View file

@ -0,0 +1,37 @@
{
"guid": "PUSH-https://www.mock-indexer.test/tor/download.php?tid=000000",
"quality": {
"quality": {
"id": 3,
"name": "EPUB"
},
"revision": {
"version": 1,
"real": 0,
"isRepack": false
}
},
"qualityWeight": 301,
"age": 0,
"ageHours": 0.00138141025,
"ageMinutes": 0.08288463833333333,
"size": 1048576,
"indexerId": 0,
"indexer": "mock-indexer",
"releaseHash": "",
"title": "The Best Book by Famous Author [English / epub, mobi]",
"discography": false,
"sceneSource": false,
"authorName": "Famous Author",
"bookTitle": "The best book",
"approved": true,
"temporarilyRejected": false,
"rejected": false,
"rejections": [],
"publishDate": "2022-10-14T17:36:15Z",
"downloadUrl": "https://www.mock-indexer.test/tor/download.php?tid=000000",
"downloadAllowed": true,
"releaseWeight": 0,
"preferredWordScore": 0,
"protocol": "torrent"
}

View file

@ -0,0 +1,31 @@
{
"appName": "Readarr",
"version": "0.1.1.1320",
"buildTime": "2022-05-09T22:53:15Z",
"isDebug": false,
"isProduction": true,
"isAdmin": false,
"isUserInteractive": true,
"startupPath": "/app/bin",
"appData": "/config",
"osName": "alpine",
"osVersion": "3.16.2",
"isNetCore": true,
"isMono": false,
"isLinux": true,
"isOsx": false,
"isWindows": false,
"isDocker": false,
"mode": "console",
"branch": "develop",
"authentication": "none",
"sqliteVersion": "3.38.5",
"migrationVersion": 21,
"urlBase": "",
"runtimeVersion": "6.0.3",
"runtimeName": "netCore",
"startTime": "2022-10-14T17:26:21Z",
"packageVersion": "testing-e06fe51",
"packageAuthor": "[hotio](https://github.com/hotio)",
"packageUpdateMechanism": "docker"
}

122
pkg/arr/readarr/types.go Normal file
View file

@ -0,0 +1,122 @@
package readarr
import (
"fmt"
"github.com/autobrr/autobrr/pkg/arr"
"time"
)
type Release struct {
Title string `json:"title"`
InfoUrl string `json:"infoUrl,omitempty"`
DownloadUrl string `json:"downloadUrl,omitempty"`
MagnetUrl string `json:"magnetUrl,omitempty"`
Size uint64 `json:"size"`
Indexer string `json:"indexer"`
DownloadProtocol string `json:"downloadProtocol"`
Protocol string `json:"protocol"`
PublishDate string `json:"publishDate"`
DownloadClientId int `json:"downloadClientId,omitempty"`
DownloadClient string `json:"downloadClient,omitempty"`
}
type PushResponse struct {
Approved bool `json:"approved"`
Rejected bool `json:"rejected"`
TempRejected bool `json:"temporarilyRejected"`
Rejections []string `json:"rejections"`
}
type BadRequestResponse struct {
PropertyName string `json:"propertyName"`
ErrorMessage string `json:"errorMessage"`
ErrorCode string `json:"errorCode"`
AttemptedValue string `json:"attemptedValue"`
Severity string `json:"severity"`
}
func (r *BadRequestResponse) String() string {
return fmt.Sprintf("[%s: %s] %s: %s - got value: %s", r.Severity, r.ErrorCode, r.PropertyName, r.ErrorMessage, r.AttemptedValue)
}
type SystemStatusResponse struct {
AppName string `json:"appName"`
Version string `json:"version"`
}
type Book struct {
Title string `json:"title"`
SeriesTitle string `json:"seriesTitle"`
Overview string `json:"overview"`
AuthorID int64 `json:"authorId"`
ForeignBookID string `json:"foreignBookId"`
TitleSlug string `json:"titleSlug"`
Monitored bool `json:"monitored"`
AnyEditionOk bool `json:"anyEditionOk"`
Ratings *arr.Ratings `json:"ratings"`
ReleaseDate time.Time `json:"releaseDate"`
PageCount int `json:"pageCount"`
Genres []interface{} `json:"genres"`
Author *BookAuthor `json:"author,omitempty"`
Images []*arr.Image `json:"images"`
Links []*arr.Link `json:"links"`
Statistics *Statistics `json:"statistics,omitempty"`
Editions []*Edition `json:"editions"`
ID int64 `json:"id"`
Disambiguation string `json:"disambiguation,omitempty"`
}
// Statistics for a Book, or maybe an author.
type Statistics struct {
BookCount int `json:"bookCount"`
BookFileCount int `json:"bookFileCount"`
TotalBookCount int `json:"totalBookCount"`
SizeOnDisk int `json:"sizeOnDisk"`
PercentOfBooks float64 `json:"percentOfBooks"`
}
// BookAuthor of a Book.
type BookAuthor struct {
ID int64 `json:"id"`
Status string `json:"status"`
AuthorName string `json:"authorName"`
ForeignAuthorID string `json:"foreignAuthorId"`
TitleSlug string `json:"titleSlug"`
Overview string `json:"overview"`
Links []*arr.Link `json:"links"`
Images []*arr.Image `json:"images"`
Path string `json:"path"`
QualityProfileID int64 `json:"qualityProfileId"`
MetadataProfileID int64 `json:"metadataProfileId"`
Genres []interface{} `json:"genres"`
CleanName string `json:"cleanName"`
SortName string `json:"sortName"`
Tags []int `json:"tags"`
Added time.Time `json:"added"`
Ratings *arr.Ratings `json:"ratings"`
Statistics *Statistics `json:"statistics"`
Monitored bool `json:"monitored"`
Ended bool `json:"ended"`
}
// Edition is more Book meta data.
type Edition struct {
ID int64 `json:"id"`
BookID int64 `json:"bookId"`
ForeignEditionID string `json:"foreignEditionId"`
TitleSlug string `json:"titleSlug"`
Isbn13 string `json:"isbn13"`
Asin string `json:"asin"`
Title string `json:"title"`
Overview string `json:"overview"`
Format string `json:"format"`
Publisher string `json:"publisher"`
PageCount int `json:"pageCount"`
ReleaseDate time.Time `json:"releaseDate"`
Images []*arr.Image `json:"images"`
Links []*arr.Link `json:"links"`
Ratings *arr.Ratings `json:"ratings"`
Monitored bool `json:"monitored"`
ManualAdd bool `json:"manualAdd"`
IsEbook bool `json:"isEbook"`
}