+
+
+
+
+
+
-[](https://www.pikapods.com/pods?run=navidrome)
## Features
diff --git a/adapters/gotaglib/end_to_end_test.go b/adapters/gotaglib/end_to_end_test.go
index e7dd18ac1..0f9a90d94 100644
--- a/adapters/gotaglib/end_to_end_test.go
+++ b/adapters/gotaglib/end_to_end_test.go
@@ -90,7 +90,7 @@ var _ = Describe("Extractor", func() {
info.FileInfo = testFileInfo{FileInfo: fileInfo}
metadata := metadata.New(path, info)
- return new(metadata.ToMediaFile(1, "folderID"))
+ return new(metadata.ToMediaFile(model.Library{ID: 1}, "folderID"))
}
BeforeEach(func() {
diff --git a/adapters/lastfm/agent.go b/adapters/lastfm/agent.go
index 7f005db1a..dbd73c30d 100644
--- a/adapters/lastfm/agent.go
+++ b/adapters/lastfm/agent.go
@@ -241,6 +241,10 @@ func (l *lastfmAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, arti
var (
artistOpenGraphQuery = cascadia.MustCompile(`html > head > meta[property="og:image"]`)
artistIgnoredImage = "2a96cbd8b46e442fc41c2b86b821562f" // Last.fm artist placeholder image name
+
+ // Not a RetryLaterError on purpose: parking the agent would also stall its API-backed
+ // methods, which the page block does not affect.
+ errNoArtistPage = errors.New("no artist image in Last.fm page")
)
func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string) ([]agents.ExternalImage, error) {
@@ -267,7 +271,9 @@ func (l *lastfmAgent) GetArtistImages(ctx context.Context, _, name, mbid string)
var res []agents.ExternalImage
n := cascadia.Query(node, artistOpenGraphQuery)
if n == nil {
- return res, nil
+ // A real artist page always has og:image; its absence means a bot challenge or a redesign.
+ log.Warn(ctx, "Last.fm did not return a usable artist page", "name", name, "url", a.URL)
+ return nil, errNoArtistPage
}
for _, attr := range n.Attr {
if attr.Key != "content" {
diff --git a/adapters/lastfm/agent_test.go b/adapters/lastfm/agent_test.go
index ce81e0916..0f68bd46b 100644
--- a/adapters/lastfm/agent_test.go
+++ b/adapters/lastfm/agent_test.go
@@ -357,7 +357,7 @@ var _ = Describe("lastfmAgent", func() {
var httpClient *tests.FakeHttpClient
var track *model.MediaFile
BeforeEach(func() {
- _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1")
+ _ = ds.UserProps().Put(ctx, "user-1", sessionKeyProperty, "SK-1")
httpClient = &tests.FakeHttpClient{}
client := newClient("API_KEY", "SECRET", httpClient)
agent = lastFMConstructor(ds)
@@ -648,18 +648,41 @@ var _ = Describe("lastfmAgent", func() {
Expect(images).To(BeEmpty())
})
- It("returns empty list if page has no meta tags", func() {
+ It("errors when the page has no meta tags", func() {
fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json")
apiClient.Res = http.Response{Body: fApi, StatusCode: 200}
fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.no_meta.html")
httpClient.Res = http.Response{Body: fScraper, StatusCode: 200}
+ _, err := agent.GetArtistImages(ctx, "123", "U2", "")
+ Expect(err).To(MatchError(errNoArtistPage))
+ })
+
+ It("errors when Last.fm serves a bot challenge page", func() {
+ fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json")
+ apiClient.Res = http.Response{Body: fApi, StatusCode: 200}
+
+ fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.challenge.html")
+ httpClient.Res = http.Response{Body: fScraper, StatusCode: 200}
+
images, err := agent.GetArtistImages(ctx, "123", "U2", "")
- Expect(err).ToNot(HaveOccurred())
+ Expect(err).To(MatchError(errNoArtistPage))
Expect(images).To(BeEmpty())
})
+ It("does not park the agent: the failure is not a retry-later", func() {
+ // A RetryLaterError would cool down the agent's API-backed methods too.
+ fApi, _ := os.Open("tests/fixtures/lastfm.artist.getinfo.json")
+ apiClient.Res = http.Response{Body: fApi, StatusCode: 200}
+
+ fScraper, _ := os.Open("tests/fixtures/lastfm.artist.page.challenge.html")
+ httpClient.Res = http.Response{Body: fScraper, StatusCode: 200}
+
+ _, err := agent.GetArtistImages(ctx, "123", "U2", "")
+ Expect(errors.Is(err, agents.ErrRetryLater)).To(BeFalse())
+ })
+
It("returns error if API call fails", func() {
apiClient.Err = errors.New("api error")
_, err := agent.GetArtistImages(ctx, "123", "U2", "")
diff --git a/adapters/lastfm/auth_router_test.go b/adapters/lastfm/auth_router_test.go
index 1f65c059e..476daf443 100644
--- a/adapters/lastfm/auth_router_test.go
+++ b/adapters/lastfm/auth_router_test.go
@@ -50,7 +50,7 @@ var _ = Describe("auth_router", func() {
})
storedSessionKey := func(userID string) string {
- key, _ := userProps.Get(userID, sessionKeyProperty)
+ key, _ := userProps.Get(GinkgoT().Context(), userID, sessionKeyProperty)
return key
}
diff --git a/adapters/listenbrainz/agent_test.go b/adapters/listenbrainz/agent_test.go
index a201b7c3a..d2aa07f1a 100644
--- a/adapters/listenbrainz/agent_test.go
+++ b/adapters/listenbrainz/agent_test.go
@@ -30,7 +30,7 @@ var _ = Describe("listenBrainzAgent", func() {
BeforeEach(func() {
ds = &tests.MockDataStore{}
ctx = context.Background()
- _ = ds.UserProps(ctx).Put("user-1", sessionKeyProperty, "SK-1")
+ _ = ds.UserProps().Put(ctx, "user-1", sessionKeyProperty, "SK-1")
httpClient = &tests.FakeHttpClient{}
agent = listenBrainzConstructor(ds)
agent.client = newClient("http://localhost:8080", httpClient)
diff --git a/api/.oasdiff-levels.txt b/api/.oasdiff-levels.txt
new file mode 100644
index 000000000..1792adcb2
--- /dev/null
+++ b/api/.oasdiff-levels.txt
@@ -0,0 +1 @@
+response-property-enum-value-added INFO
diff --git a/api/.vacuum.yaml b/api/.vacuum.yaml
new file mode 100644
index 000000000..bd31e23f8
--- /dev/null
+++ b/api/.vacuum.yaml
@@ -0,0 +1,155 @@
+extends: [[spectral:oas, recommended]]
+rules:
+ # vacuum's `enumeration` function mis-resolves hyphenated `then.field` names,
+ # so the value check below targets `x-module` via `given` instead.
+ nd-operation-x-module-required:
+ description: Every operation belongs to exactly one capability module.
+ severity: error
+ given: $.paths[*][get,put,post,delete,patch]
+ then:
+ field: x-module
+ function: truthy
+ nd-operation-x-module:
+ description: Every operation's capability module is one of the known values.
+ severity: error
+ given: $.paths[*][get,put,post,delete,patch]['x-module']
+ then:
+ function: enumeration
+ functionOptions:
+ values:
+ - core
+ - streaming
+ - download
+ - artwork
+ - lyrics
+ - transcoding
+ - annotations
+ - playback
+ - queue
+ - custom-tags
+ - grouping
+ - playlists
+ - smart-playlists
+ - sync
+ - events
+ - jukebox
+ - sharing
+ - radio
+ - admin
+ nd-operation-stability-level-required:
+ description: Every operation declares its stability level, which the breaking-change gate relies on.
+ severity: error
+ given: $.paths[*][get,put,post,delete,patch]
+ then:
+ field: x-stability-level
+ function: truthy
+ nd-operation-stability-level:
+ description: Every operation's stability level is alpha, beta, or stable.
+ severity: error
+ given: $.paths[*][get,put,post,delete,patch]['x-stability-level']
+ then:
+ function: enumeration
+ functionOptions:
+ values:
+ - alpha
+ - beta
+ - stable
+ nd-operation-required-fields:
+ description: Operations need a stable operationId, summary, description and tags.
+ severity: error
+ given: $.paths[*][get,put,post,delete,patch]
+ then:
+ - field: operationId
+ function: truthy
+ - field: summary
+ function: truthy
+ - field: description
+ function: truthy
+ - field: tags
+ function: truthy
+ # Our schemas live in path/response files, not root components, so this
+ # walks every resolved `properties` map in the document via `$..` instead.
+ nd-schema-property-descriptions:
+ description: Every schema property is documented.
+ severity: error
+ given: $..properties[*]
+ then:
+ field: description
+ function: truthy
+ # patternProperties covers the full 4xx/5xx range; needs an explicit
+ # `properties` entry too, or `additionalProperties: false` rejects it.
+ nd-error-responses-are-problems:
+ description: 4xx and 5xx responses use application/problem+json.
+ severity: error
+ given: $.paths[*][*].responses
+ then:
+ function: schema
+ functionOptions:
+ forceValidationOnCurrentNode: true
+ schema:
+ type: object
+ patternProperties:
+ "^[45][0-9][0-9]$":
+ type: object
+ required: [content]
+ properties:
+ content:
+ type: object
+ properties:
+ application/problem+json: {}
+ required: [application/problem+json]
+ additionalProperties: false
+ # Same filter limitation applies here: "is this a list endpoint" is expressed
+ # as a JSON Schema if/then on the operation object instead of a `given` filter.
+ nd-list-endpoints-paginate:
+ description: List endpoints declare the shared offset and limit parameters.
+ severity: error
+ given: $.paths[*].get
+ then:
+ function: schema
+ functionOptions:
+ forceValidationOnCurrentNode: true
+ schema:
+ type: object
+ if:
+ required: [responses]
+ properties:
+ responses:
+ type: object
+ required: ['200']
+ properties:
+ '200':
+ type: object
+ required: [content]
+ properties:
+ content:
+ type: object
+ required: [application/json]
+ properties:
+ application/json:
+ type: object
+ required: [schema]
+ properties:
+ schema:
+ type: object
+ required: [properties]
+ properties:
+ properties:
+ type: object
+ required: [items]
+ then:
+ required: [parameters]
+ properties:
+ parameters:
+ type: array
+ allOf:
+ - contains:
+ type: object
+ properties:
+ name:
+ const: offset
+ - contains:
+ type: object
+ properties:
+ name:
+ const: limit
diff --git a/scanner/metadata_old/ffmpeg/ffmpeg_suite_test.go b/api/api_suite_test.go
similarity index 69%
rename from scanner/metadata_old/ffmpeg/ffmpeg_suite_test.go
rename to api/api_suite_test.go
index 815940381..62a547b7c 100644
--- a/scanner/metadata_old/ffmpeg/ffmpeg_suite_test.go
+++ b/api/api_suite_test.go
@@ -1,4 +1,4 @@
-package ffmpeg
+package api_test
import (
"testing"
@@ -9,9 +9,9 @@ import (
. "github.com/onsi/gomega"
)
-func TestFFMpeg(t *testing.T) {
- tests.Init(t, true)
+func TestAPI(t *testing.T) {
+ tests.Init(t, false)
log.SetLevel(log.LevelFatal)
RegisterFailHandler(Fail)
- RunSpecs(t, "FFMpeg Suite")
+ RunSpecs(t, "API Spec Suite")
}
diff --git a/api/bundled/openapi.json b/api/bundled/openapi.json
new file mode 100644
index 000000000..bfe794c71
--- /dev/null
+++ b/api/bundled/openapi.json
@@ -0,0 +1,262 @@
+{
+ "openapi": "3.0.3",
+ "info": {
+ "title": "Navidrome API",
+ "version": "1.0.0",
+ "description": "Navidrome API v1. Spec-first, additive within v1. Clients discover implemented\ncapability modules through `GET /server` and never sniff versions.\n\nEnums are open: new values may be added to any enum within v1. Clients must\naccept values they do not recognise instead of failing.\n\nEvery operation declares `x-stability-level`: `alpha` operations may change or\ndisappear without notice, `beta` and `stable` operations only change additively.\nA level is only ever raised, never lowered.\n\n`HEAD` is accepted wherever `GET` is. A `405` response lists the allowed methods\nin its `Allow` header.\n",
+ "license": {
+ "name": "GPL-3.0",
+ "url": "https://www.gnu.org/licenses/gpl-3.0.html"
+ }
+ },
+ "servers": [
+ {
+ "url": "/api/v1"
+ }
+ ],
+ "tags": [
+ {
+ "name": "server",
+ "description": "Server discovery and the published OpenAPI document."
+ }
+ ],
+ "paths": {
+ "/server": {
+ "get": {
+ "operationId": "getServerInfo",
+ "x-module": "core",
+ "x-stability-level": "alpha",
+ "tags": [
+ "server"
+ ],
+ "summary": "Describe the server",
+ "description": "Returns the public server description. No authentication required.\nAuthenticated requests will additionally receive the implemented capability modules\nonce authentication is available.\n",
+ "responses": {
+ "200": {
+ "description": "Server description.",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/ServerInfo"
+ }
+ }
+ }
+ },
+ "500": {
+ "$ref": "#/components/responses/InternalError"
+ }
+ }
+ }
+ },
+ "/openapi.json": {
+ "get": {
+ "operationId": "getOpenAPISpecJSON",
+ "x-module": "core",
+ "x-stability-level": "alpha",
+ "tags": [
+ "server"
+ ],
+ "summary": "Get the OpenAPI document (JSON)",
+ "description": "The bundled OpenAPI document of the running server version. Supports ETag revalidation.",
+ "responses": {
+ "200": {
+ "description": "The OpenAPI document.",
+ "headers": {
+ "ETag": {
+ "$ref": "#/components/headers/ETag"
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "description": "OpenAPI 3.0 document."
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/NotModified"
+ }
+ }
+ }
+ },
+ "/openapi.yaml": {
+ "get": {
+ "operationId": "getOpenAPISpecYAML",
+ "x-module": "core",
+ "x-stability-level": "alpha",
+ "tags": [
+ "server"
+ ],
+ "summary": "Get the OpenAPI document (YAML)",
+ "description": "The bundled OpenAPI document of the running server version. Supports ETag revalidation.",
+ "responses": {
+ "200": {
+ "description": "The OpenAPI document.",
+ "headers": {
+ "ETag": {
+ "$ref": "#/components/headers/ETag"
+ }
+ },
+ "content": {
+ "application/yaml": {
+ "schema": {
+ "type": "object",
+ "description": "OpenAPI 3.0 document."
+ }
+ }
+ }
+ },
+ "304": {
+ "$ref": "#/components/responses/NotModified"
+ }
+ }
+ }
+ }
+ },
+ "components": {
+ "securitySchemes": {
+ "bearerAuth": {
+ "type": "http",
+ "scheme": "bearer",
+ "bearerFormat": "JWT",
+ "description": "Short-lived access token minted from a device grant. Not yet applied to any operation."
+ }
+ },
+ "schemas": {
+ "ServerInfo": {
+ "type": "object",
+ "description": "Public server description. Everything an add-server screen needs before login.",
+ "required": [
+ "name",
+ "serverVersion",
+ "specVersion",
+ "setupRequired",
+ "loginMethods"
+ ],
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Human-readable server product name."
+ },
+ "serverVersion": {
+ "type": "string",
+ "description": "Version of the running server build."
+ },
+ "specVersion": {
+ "type": "string",
+ "description": "Version of the OpenAPI document this server implements."
+ },
+ "setupRequired": {
+ "type": "boolean",
+ "description": "True until the first admin user has been created."
+ },
+ "loginMethods": {
+ "type": "array",
+ "description": "Login methods this server accepts. New methods may be added; clients ignore values they do not recognise.",
+ "items": {
+ "type": "string",
+ "enum": [
+ "password"
+ ]
+ }
+ }
+ }
+ },
+ "Problem": {
+ "type": "object",
+ "description": "RFC 9457 problem details, returned for every 4xx and 5xx response.",
+ "required": [
+ "title",
+ "status",
+ "code"
+ ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "URI reference identifying the problem type. Omitted while the problem carries no semantics\nbeyond its HTTP status code, which RFC 9457 defines as `about:blank`. Problems with their\nown semantics get their own URI; switch on `code` instead.\n"
+ },
+ "title": {
+ "type": "string",
+ "description": "Short human-readable summary, the same for all occurrences of this problem type."
+ },
+ "status": {
+ "type": "integer",
+ "description": "HTTP status code of this response."
+ },
+ "detail": {
+ "type": "string",
+ "description": "Human-readable explanation specific to this occurrence. Omitted for internal errors."
+ },
+ "code": {
+ "type": "string",
+ "description": "Machine-readable error code, and the value clients switch on. New codes may be added.",
+ "enum": [
+ "validation",
+ "unauthorized",
+ "forbidden",
+ "not_found",
+ "method_not_allowed",
+ "unavailable",
+ "internal"
+ ]
+ },
+ "errors": {
+ "type": "array",
+ "description": "Per-field failures. Present only when `code` is `validation`.",
+ "items": {
+ "$ref": "#/components/schemas/ValidationError"
+ }
+ }
+ }
+ },
+ "ValidationError": {
+ "type": "object",
+ "description": "One field-level validation failure.",
+ "required": [
+ "field",
+ "message"
+ ],
+ "properties": {
+ "field": {
+ "type": "string",
+ "description": "Name of the offending query parameter, path parameter, or body field (dotted for nested)."
+ },
+ "message": {
+ "type": "string",
+ "description": "Why the value was rejected."
+ }
+ }
+ }
+ },
+ "responses": {
+ "InternalError": {
+ "description": "Unexpected server failure. Details are in the server log.",
+ "content": {
+ "application/problem+json": {
+ "schema": {
+ "$ref": "#/components/schemas/Problem"
+ }
+ }
+ }
+ },
+ "NotModified": {
+ "description": "Not modified.",
+ "headers": {
+ "ETag": {
+ "$ref": "#/components/headers/ETag"
+ }
+ }
+ }
+ },
+ "headers": {
+ "ETag": {
+ "description": "Entity tag for `If-None-Match` revalidation.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/api/bundled/openapi.yaml b/api/bundled/openapi.yaml
new file mode 100644
index 000000000..f1ae95b76
--- /dev/null
+++ b/api/bundled/openapi.yaml
@@ -0,0 +1,194 @@
+openapi: 3.0.3
+info:
+ title: Navidrome API
+ version: 1.0.0
+ description: |
+ Navidrome API v1. Spec-first, additive within v1. Clients discover implemented
+ capability modules through `GET /server` and never sniff versions.
+
+ Enums are open: new values may be added to any enum within v1. Clients must
+ accept values they do not recognise instead of failing.
+
+ Every operation declares `x-stability-level`: `alpha` operations may change or
+ disappear without notice, `beta` and `stable` operations only change additively.
+ A level is only ever raised, never lowered.
+
+ `HEAD` is accepted wherever `GET` is. A `405` response lists the allowed methods
+ in its `Allow` header.
+ license:
+ name: GPL-3.0
+ url: https://www.gnu.org/licenses/gpl-3.0.html
+servers:
+ - url: /api/v1
+tags:
+ - name: server
+ description: Server discovery and the published OpenAPI document.
+paths:
+ /server:
+ get:
+ operationId: getServerInfo
+ x-module: core
+ x-stability-level: alpha
+ tags: [server]
+ summary: Describe the server
+ description: |
+ Returns the public server description. No authentication required.
+ Authenticated requests will additionally receive the implemented capability modules
+ once authentication is available.
+ responses:
+ '200':
+ description: Server description.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ServerInfo'
+ '500':
+ $ref: '#/components/responses/InternalError'
+ /openapi.json:
+ get:
+ operationId: getOpenAPISpecJSON
+ x-module: core
+ x-stability-level: alpha
+ tags: [server]
+ summary: Get the OpenAPI document (JSON)
+ description: The bundled OpenAPI document of the running server version. Supports ETag revalidation.
+ responses:
+ '200':
+ description: The OpenAPI document.
+ headers:
+ ETag:
+ $ref: '#/components/headers/ETag'
+ content:
+ application/json:
+ schema:
+ type: object
+ description: OpenAPI 3.0 document.
+ '304':
+ $ref: '#/components/responses/NotModified'
+ /openapi.yaml:
+ get:
+ operationId: getOpenAPISpecYAML
+ x-module: core
+ x-stability-level: alpha
+ tags: [server]
+ summary: Get the OpenAPI document (YAML)
+ description: The bundled OpenAPI document of the running server version. Supports ETag revalidation.
+ responses:
+ '200':
+ description: The OpenAPI document.
+ headers:
+ ETag:
+ $ref: '#/components/headers/ETag'
+ content:
+ application/yaml:
+ schema:
+ type: object
+ description: OpenAPI 3.0 document.
+ '304':
+ $ref: '#/components/responses/NotModified'
+components:
+ securitySchemes:
+ bearerAuth:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+ description: Short-lived access token minted from a device grant. Not yet applied to any operation.
+ schemas:
+ ServerInfo:
+ type: object
+ description: Public server description. Everything an add-server screen needs before login.
+ required:
+ - name
+ - serverVersion
+ - specVersion
+ - setupRequired
+ - loginMethods
+ properties:
+ name:
+ type: string
+ description: Human-readable server product name.
+ serverVersion:
+ type: string
+ description: Version of the running server build.
+ specVersion:
+ type: string
+ description: Version of the OpenAPI document this server implements.
+ setupRequired:
+ type: boolean
+ description: True until the first admin user has been created.
+ loginMethods:
+ type: array
+ description: Login methods this server accepts. New methods may be added; clients ignore values they do not recognise.
+ items:
+ type: string
+ enum:
+ - password
+ Problem:
+ type: object
+ description: RFC 9457 problem details, returned for every 4xx and 5xx response.
+ required:
+ - title
+ - status
+ - code
+ properties:
+ type:
+ type: string
+ description: |
+ URI reference identifying the problem type. Omitted while the problem carries no semantics
+ beyond its HTTP status code, which RFC 9457 defines as `about:blank`. Problems with their
+ own semantics get their own URI; switch on `code` instead.
+ title:
+ type: string
+ description: Short human-readable summary, the same for all occurrences of this problem type.
+ status:
+ type: integer
+ description: HTTP status code of this response.
+ detail:
+ type: string
+ description: Human-readable explanation specific to this occurrence. Omitted for internal errors.
+ code:
+ type: string
+ description: Machine-readable error code, and the value clients switch on. New codes may be added.
+ enum:
+ - validation
+ - unauthorized
+ - forbidden
+ - not_found
+ - method_not_allowed
+ - unavailable
+ - internal
+ errors:
+ type: array
+ description: Per-field failures. Present only when `code` is `validation`.
+ items:
+ $ref: '#/components/schemas/ValidationError'
+ ValidationError:
+ type: object
+ description: One field-level validation failure.
+ required:
+ - field
+ - message
+ properties:
+ field:
+ type: string
+ description: Name of the offending query parameter, path parameter, or body field (dotted for nested).
+ message:
+ type: string
+ description: Why the value was rejected.
+ responses:
+ InternalError:
+ description: Unexpected server failure. Details are in the server log.
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Problem'
+ NotModified:
+ description: Not modified.
+ headers:
+ ETag:
+ $ref: '#/components/headers/ETag'
+ headers:
+ ETag:
+ description: Entity tag for `If-None-Match` revalidation.
+ schema:
+ type: string
diff --git a/api/embed.go b/api/embed.go
new file mode 100644
index 000000000..7e94c2362
--- /dev/null
+++ b/api/embed.go
@@ -0,0 +1,35 @@
+package api
+
+import (
+ _ "embed"
+ "encoding/json"
+ "sync"
+)
+
+//go:embed bundled/openapi.json
+var specJSON []byte
+
+//go:embed bundled/openapi.yaml
+var specYAML []byte
+
+func SpecJSON() []byte {
+ return specJSON
+}
+
+func SpecYAML() []byte {
+ return specYAML
+}
+
+var specVersion = sync.OnceValue(func() string {
+ var doc struct {
+ Info struct {
+ Version string `json:"version"`
+ } `json:"info"`
+ }
+ _ = json.Unmarshal(SpecJSON(), &doc)
+ return doc.Info.Version
+})
+
+func SpecVersion() string {
+ return specVersion()
+}
diff --git a/api/embed_test.go b/api/embed_test.go
new file mode 100644
index 000000000..ebd5a7d1d
--- /dev/null
+++ b/api/embed_test.go
@@ -0,0 +1,37 @@
+package api_test
+
+import (
+ "os"
+
+ "github.com/getkin/kin-openapi/openapi3"
+ "github.com/navidrome/navidrome/api"
+ . "github.com/onsi/ginkgo/v2"
+ . "github.com/onsi/gomega"
+ "gopkg.in/yaml.v3"
+)
+
+var _ = Describe("Bundled spec", func() {
+ It("embeds a valid OpenAPI 3 document", func() {
+ doc, err := openapi3.NewLoader().LoadFromData(api.SpecJSON())
+ Expect(err).ToNot(HaveOccurred())
+ Expect(doc.Validate(GinkgoT().Context())).To(Succeed())
+ Expect(doc.Paths.Find("/server")).ToNot(BeNil())
+ })
+
+ It("embeds the YAML variant", func() {
+ var doc map[string]any
+ Expect(yaml.Unmarshal(api.SpecYAML(), &doc)).To(Succeed())
+ Expect(doc).To(HaveKey("paths"))
+ })
+
+ It("reports the version from the bundle, matching the source root document", func() {
+ src, err := os.ReadFile("api/openapi/openapi.yaml")
+ Expect(err).ToNot(HaveOccurred())
+ var root struct {
+ Info struct{ Version string } `yaml:"info"`
+ }
+ Expect(yaml.Unmarshal(src, &root)).To(Succeed())
+ Expect(api.SpecVersion()).To(Equal(root.Info.Version))
+ Expect(api.SpecVersion()).ToNot(BeEmpty())
+ })
+})
diff --git a/api/openapi/components/headers/ETag.yaml b/api/openapi/components/headers/ETag.yaml
new file mode 100644
index 000000000..0f64e6792
--- /dev/null
+++ b/api/openapi/components/headers/ETag.yaml
@@ -0,0 +1,3 @@
+description: Entity tag for `If-None-Match` revalidation.
+schema:
+ type: string
diff --git a/api/openapi/components/parameters/limit.yaml b/api/openapi/components/parameters/limit.yaml
new file mode 100644
index 000000000..9bef4fc8b
--- /dev/null
+++ b/api/openapi/components/parameters/limit.yaml
@@ -0,0 +1,9 @@
+name: limit
+in: query
+description: Maximum number of items to return.
+required: false
+schema:
+ type: integer
+ minimum: 1
+ maximum: 2000
+ default: 100
diff --git a/api/openapi/components/parameters/offset.yaml b/api/openapi/components/parameters/offset.yaml
new file mode 100644
index 000000000..9145d6eaa
--- /dev/null
+++ b/api/openapi/components/parameters/offset.yaml
@@ -0,0 +1,8 @@
+name: offset
+in: query
+description: Zero-based index of the first item to return.
+required: false
+schema:
+ type: integer
+ minimum: 0
+ default: 0
diff --git a/api/openapi/components/responses/BadRequest.yaml b/api/openapi/components/responses/BadRequest.yaml
new file mode 100644
index 000000000..1a6e0b657
--- /dev/null
+++ b/api/openapi/components/responses/BadRequest.yaml
@@ -0,0 +1,5 @@
+description: The request is malformed or fails validation.
+content:
+ application/problem+json:
+ schema:
+ $ref: ../schemas/Problem.yaml
diff --git a/api/openapi/components/responses/Forbidden.yaml b/api/openapi/components/responses/Forbidden.yaml
new file mode 100644
index 000000000..6259185ea
--- /dev/null
+++ b/api/openapi/components/responses/Forbidden.yaml
@@ -0,0 +1,5 @@
+description: The caller is authenticated but not allowed to do this.
+content:
+ application/problem+json:
+ schema:
+ $ref: ../schemas/Problem.yaml
diff --git a/api/openapi/components/responses/InternalError.yaml b/api/openapi/components/responses/InternalError.yaml
new file mode 100644
index 000000000..20e654d44
--- /dev/null
+++ b/api/openapi/components/responses/InternalError.yaml
@@ -0,0 +1,5 @@
+description: Unexpected server failure. Details are in the server log.
+content:
+ application/problem+json:
+ schema:
+ $ref: ../schemas/Problem.yaml
diff --git a/api/openapi/components/responses/NotFound.yaml b/api/openapi/components/responses/NotFound.yaml
new file mode 100644
index 000000000..6083a5cd1
--- /dev/null
+++ b/api/openapi/components/responses/NotFound.yaml
@@ -0,0 +1,5 @@
+description: No such resource or endpoint.
+content:
+ application/problem+json:
+ schema:
+ $ref: ../schemas/Problem.yaml
diff --git a/api/openapi/components/responses/NotModified.yaml b/api/openapi/components/responses/NotModified.yaml
new file mode 100644
index 000000000..36bc1a61c
--- /dev/null
+++ b/api/openapi/components/responses/NotModified.yaml
@@ -0,0 +1,4 @@
+description: Not modified.
+headers:
+ ETag:
+ $ref: ../headers/ETag.yaml
diff --git a/api/openapi/components/responses/Unauthorized.yaml b/api/openapi/components/responses/Unauthorized.yaml
new file mode 100644
index 000000000..0209f4dd9
--- /dev/null
+++ b/api/openapi/components/responses/Unauthorized.yaml
@@ -0,0 +1,5 @@
+description: Missing, invalid, or expired credentials.
+content:
+ application/problem+json:
+ schema:
+ $ref: ../schemas/Problem.yaml
diff --git a/api/openapi/components/schemas/ListMeta.yaml b/api/openapi/components/schemas/ListMeta.yaml
new file mode 100644
index 000000000..6321e0588
--- /dev/null
+++ b/api/openapi/components/schemas/ListMeta.yaml
@@ -0,0 +1,13 @@
+type: object
+description: Pagination metadata carried by every list response.
+required: [total, offset, limit]
+properties:
+ total:
+ type: integer
+ description: Total number of items matching the request, ignoring pagination.
+ offset:
+ type: integer
+ description: Zero-based index of the first returned item.
+ limit:
+ type: integer
+ description: Maximum number of items in this page.
diff --git a/api/openapi/components/schemas/Problem.yaml b/api/openapi/components/schemas/Problem.yaml
new file mode 100644
index 000000000..0fd36d4b1
--- /dev/null
+++ b/api/openapi/components/schemas/Problem.yaml
@@ -0,0 +1,35 @@
+type: object
+description: RFC 9457 problem details, returned for every 4xx and 5xx response.
+required: [title, status, code]
+properties:
+ type:
+ type: string
+ description: |
+ URI reference identifying the problem type. Omitted while the problem carries no semantics
+ beyond its HTTP status code, which RFC 9457 defines as `about:blank`. Problems with their
+ own semantics get their own URI; switch on `code` instead.
+ title:
+ type: string
+ description: Short human-readable summary, the same for all occurrences of this problem type.
+ status:
+ type: integer
+ description: HTTP status code of this response.
+ detail:
+ type: string
+ description: Human-readable explanation specific to this occurrence. Omitted for internal errors.
+ code:
+ type: string
+ description: Machine-readable error code, and the value clients switch on. New codes may be added.
+ enum:
+ - validation
+ - unauthorized
+ - forbidden
+ - not_found
+ - method_not_allowed
+ - unavailable
+ - internal
+ errors:
+ type: array
+ description: Per-field failures. Present only when `code` is `validation`.
+ items:
+ $ref: ./ValidationError.yaml
diff --git a/api/openapi/components/schemas/ServerInfo.yaml b/api/openapi/components/schemas/ServerInfo.yaml
new file mode 100644
index 000000000..8906924eb
--- /dev/null
+++ b/api/openapi/components/schemas/ServerInfo.yaml
@@ -0,0 +1,22 @@
+type: object
+description: Public server description. Everything an add-server screen needs before login.
+required: [name, serverVersion, specVersion, setupRequired, loginMethods]
+properties:
+ name:
+ type: string
+ description: Human-readable server product name.
+ serverVersion:
+ type: string
+ description: Version of the running server build.
+ specVersion:
+ type: string
+ description: Version of the OpenAPI document this server implements.
+ setupRequired:
+ type: boolean
+ description: True until the first admin user has been created.
+ loginMethods:
+ type: array
+ description: Login methods this server accepts. New methods may be added; clients ignore values they do not recognise.
+ items:
+ type: string
+ enum: [password]
diff --git a/api/openapi/components/schemas/ValidationError.yaml b/api/openapi/components/schemas/ValidationError.yaml
new file mode 100644
index 000000000..8a1cbc4f9
--- /dev/null
+++ b/api/openapi/components/schemas/ValidationError.yaml
@@ -0,0 +1,10 @@
+type: object
+description: One field-level validation failure.
+required: [field, message]
+properties:
+ field:
+ type: string
+ description: Name of the offending query parameter, path parameter, or body field (dotted for nested).
+ message:
+ type: string
+ description: Why the value was rejected.
diff --git a/api/openapi/openapi.yaml b/api/openapi/openapi.yaml
new file mode 100644
index 000000000..73cbb7b27
--- /dev/null
+++ b/api/openapi/openapi.yaml
@@ -0,0 +1,39 @@
+openapi: 3.0.3
+info:
+ title: Navidrome API
+ version: 1.0.0
+ description: |
+ Navidrome API v1. Spec-first, additive within v1. Clients discover implemented
+ capability modules through `GET /server` and never sniff versions.
+
+ Enums are open: new values may be added to any enum within v1. Clients must
+ accept values they do not recognise instead of failing.
+
+ Every operation declares `x-stability-level`: `alpha` operations may change or
+ disappear without notice, `beta` and `stable` operations only change additively.
+ A level is only ever raised, never lowered.
+
+ `HEAD` is accepted wherever `GET` is. A `405` response lists the allowed methods
+ in its `Allow` header.
+ license:
+ name: GPL-3.0
+ url: https://www.gnu.org/licenses/gpl-3.0.html
+servers:
+ - url: /api/v1
+tags:
+ - name: server
+ description: Server discovery and the published OpenAPI document.
+paths:
+ /server:
+ $ref: ./paths/server.yaml
+ /openapi.json:
+ $ref: ./paths/openapi.yaml#/json
+ /openapi.yaml:
+ $ref: ./paths/openapi.yaml#/yaml
+components:
+ securitySchemes:
+ bearerAuth:
+ type: http
+ scheme: bearer
+ bearerFormat: JWT
+ description: Short-lived access token minted from a device grant. Not yet applied to any operation.
diff --git a/api/openapi/paths/openapi.yaml b/api/openapi/paths/openapi.yaml
new file mode 100644
index 000000000..3c25dc8b7
--- /dev/null
+++ b/api/openapi/paths/openapi.yaml
@@ -0,0 +1,42 @@
+json:
+ get:
+ operationId: getOpenAPISpecJSON
+ x-module: core
+ x-stability-level: alpha
+ tags: [server]
+ summary: Get the OpenAPI document (JSON)
+ description: The bundled OpenAPI document of the running server version. Supports ETag revalidation.
+ responses:
+ '200':
+ description: The OpenAPI document.
+ headers:
+ ETag:
+ $ref: ../components/headers/ETag.yaml
+ content:
+ application/json:
+ schema:
+ type: object
+ description: OpenAPI 3.0 document.
+ '304':
+ $ref: ../components/responses/NotModified.yaml
+yaml:
+ get:
+ operationId: getOpenAPISpecYAML
+ x-module: core
+ x-stability-level: alpha
+ tags: [server]
+ summary: Get the OpenAPI document (YAML)
+ description: The bundled OpenAPI document of the running server version. Supports ETag revalidation.
+ responses:
+ '200':
+ description: The OpenAPI document.
+ headers:
+ ETag:
+ $ref: ../components/headers/ETag.yaml
+ content:
+ application/yaml:
+ schema:
+ type: object
+ description: OpenAPI 3.0 document.
+ '304':
+ $ref: ../components/responses/NotModified.yaml
diff --git a/api/openapi/paths/server.yaml b/api/openapi/paths/server.yaml
new file mode 100644
index 000000000..1f881dbb1
--- /dev/null
+++ b/api/openapi/paths/server.yaml
@@ -0,0 +1,19 @@
+get:
+ operationId: getServerInfo
+ x-module: core
+ x-stability-level: alpha
+ tags: [server]
+ summary: Describe the server
+ description: |
+ Returns the public server description. No authentication required.
+ Authenticated requests will additionally receive the implemented capability modules
+ once authentication is available.
+ responses:
+ '200':
+ description: Server description.
+ content:
+ application/json:
+ schema:
+ $ref: ../components/schemas/ServerInfo.yaml
+ '500':
+ $ref: ../components/responses/InternalError.yaml
diff --git a/cmd/artwork.go b/cmd/artwork.go
index 9a64cd8c3..72685678e 100644
--- a/cmd/artwork.go
+++ b/cmd/artwork.go
@@ -174,28 +174,28 @@ func queueTotal(stats []model.ArtworkQueueStat) int64 {
}
func collectStatus(ctx context.Context, ds model.DataStore) (statusReport, error) {
- q := ds.ArtworkQueue(ctx)
+ q := ds.ArtworkQueue()
var rep statusReport
var err error
- if rep.queue, err = q.CountQueued(nil, nil); err != nil {
+ if rep.queue, err = q.CountQueued(ctx, nil, nil); err != nil {
return rep, fmt.Errorf("breaking the artwork queue down by kind: %w", err)
}
for _, k := range artwork.ReprocessKinds {
- sources, err := q.SourcesInUse(k)
+ sources, err := q.SourcesInUse(ctx, k)
if err != nil {
return rep, fmt.Errorf("listing the sources in use by %s artwork: %w", k, err)
}
slices.Sort(sources)
for _, s := range sources {
- n, err := q.CountBySource(k, []string{s})
+ n, err := q.CountBySource(ctx, k, []string{s})
if err != nil {
return rep, fmt.Errorf("counting %s artwork resolved from %s: %w", k, displaySource(s), err)
}
rep.sources = append(rep.sources, sourceCount{kind: k, source: s, count: n})
// An absent state is exactly a row with no source, so it needs no second query.
if s == "" {
- failed, err := q.CountBySource(k, []string{model.ArtworkSourceFailed})
+ failed, err := q.CountBySource(ctx, k, []string{model.ArtworkSourceFailed})
if err != nil {
return rep, fmt.Errorf("counting failed %s artwork: %w", k, err)
}
@@ -205,7 +205,7 @@ func collectStatus(ctx context.Context, ds model.DataStore) (statusReport, error
}
rep.current, rep.inputs = artwork.ConfigFingerprint(), artwork.FingerprintInputs()
- if rep.stored, err = ds.Property(ctx).DefaultGet(consts.ArtConfFingerprintPropertyKey, ""); err != nil {
+ if rep.stored, err = ds.Property().DefaultGet(ctx, consts.ArtConfFingerprintPropertyKey, ""); err != nil {
return rep, fmt.Errorf("reading the stored artwork fingerprint: %w", err)
}
return rep, nil
@@ -442,13 +442,13 @@ func promptConfirm(in io.Reader, verb string) confirmFunc {
// validateSources rejects a typo'd source: matching nothing silently reads as "nothing to do" when
// it means the filter was wrong. Checked table-wide, so a filter is never a typo for one --kind only.
-func validateSources(q model.ArtworkQueueRepository, sources []string) error {
+func validateSources(ctx context.Context, q model.ArtworkQueueRepository, sources []string) error {
if len(sources) == 0 {
return nil
}
var inUse []string
for _, k := range artwork.ReprocessKinds {
- found, err := q.SourcesInUse(k)
+ found, err := q.SourcesInUse(ctx, k)
if err != nil {
return fmt.Errorf("listing the sources in use by %s artwork: %w", k, err)
}
@@ -475,8 +475,8 @@ func validateSources(q model.ArtworkQueueRepository, sources []string) error {
// actually inserted; the two differ because an already-queued row is left untouched.
func reprocessArtwork(ctx context.Context, ds model.DataStore, kinds []model.Kind, sources []string,
imageAgents artwork.ImageAgentCount, dryRun bool, confirm confirmFunc, out io.Writer) error {
- q := ds.ArtworkQueue(ctx)
- if err := validateSources(q, sources); err != nil {
+ q := ds.ArtworkQueue()
+ if err := validateSources(ctx, q, sources); err != nil {
return err
}
@@ -495,7 +495,7 @@ func reprocessArtwork(ctx context.Context, ds model.DataStore, kinds []model.Kin
matched := make([]int64, len(kinds))
var total, external int64
for i, k := range kinds {
- n, err := q.CountBySource(k, sources)
+ n, err := q.CountBySource(ctx, k, sources)
if err != nil {
return fmt.Errorf("counting %s artwork: %w", k, err)
}
@@ -523,7 +523,7 @@ func reprocessArtwork(ctx context.Context, ds model.DataStore, kinds []model.Kin
if matched[i] == 0 {
continue
}
- n, err := q.EnqueueBySource(k, sources, model.ArtworkPriorityRecheck)
+ n, err := q.EnqueueBySource(ctx, k, sources, model.ArtworkPriorityRecheck)
if err != nil {
return fmt.Errorf("queueing %s artwork: %w", k, err)
}
@@ -590,8 +590,8 @@ func parseAll[T comparable](values []string, parse func(string) (T, error)) ([]T
func cancelArtwork(ctx context.Context, ds model.DataStore, kinds []model.Kind, priorities []int,
dryRun bool, confirm confirmFunc, out io.Writer) error {
- q := ds.ArtworkQueue(ctx)
- matched, err := q.CountQueued(kinds, priorities)
+ q := ds.ArtworkQueue()
+ matched, err := q.CountQueued(ctx, kinds, priorities)
if err != nil {
return fmt.Errorf("counting queued artwork: %w", err)
}
@@ -612,7 +612,7 @@ func cancelArtwork(ctx context.Context, ds model.DataStore, kinds []model.Kind,
return nil
}
- cancelled, err := q.PurgeQueued(kinds, priorities)
+ cancelled, err := q.PurgeQueued(ctx, kinds, priorities)
if err != nil {
return fmt.Errorf("cancelling queued artwork: %w", err)
}
@@ -984,11 +984,11 @@ func runExplain(ctx context.Context, args []string) {
}
rep := explainReport{kind: kind, id: id, name: name}
if artwork.KeepsState(kind) {
- rep.stored, err = ds.Artwork(ctx).GetItemArtwork(kind, id, model.ImageTypePrimary)
+ rep.stored, err = ds.Artwork().GetItemArtwork(ctx, kind, id, model.ImageTypePrimary)
if err != nil && !errors.Is(err, model.ErrNotFound) {
log.Fatal(ctx, "Failed to read artwork state", "kind", kind, "id", id, err)
}
- rep.queued, err = ds.ArtworkQueue(ctx).Get(kind, id, model.ImageTypePrimary)
+ rep.queued, err = ds.ArtworkQueue().Get(ctx, kind, id, model.ImageTypePrimary)
if err != nil && !errors.Is(err, model.ErrNotFound) {
log.Fatal(ctx, "Failed to read the artwork queue", "kind", kind, "id", id, err)
}
diff --git a/cmd/artwork_test.go b/cmd/artwork_test.go
index 71b450914..df0ea0665 100644
--- a/cmd/artwork_test.go
+++ b/cmd/artwork_test.go
@@ -491,17 +491,17 @@ var _ = Describe("explain/reprocess source round trip", func() {
It("names the absent state as reprocess --source accepts it", func() {
ds := &tests.MockDataStore{}
- art := ds.Artwork(ctx).(*tests.MockArtworkRepo)
- Expect(art.PutItemArtwork(&model.ItemArtwork{ItemKind: model.KindArtistArtwork.Prefix(),
+ art := ds.Artwork().(*tests.MockArtworkRepo)
+ Expect(art.PutItemArtwork(ctx, &model.ItemArtwork{ItemKind: model.KindArtistArtwork.Prefix(),
ItemID: "ar-1", ImageType: model.ImageTypePrimary})).To(Succeed())
shown := storedSource(formatExplain(explainReport{kind: model.KindArtistArtwork, id: "ar-1",
stored: &model.ItemArtwork{AttemptedAt: time.Now()}}))
- q := ds.ArtworkQueue(ctx)
- Expect(validateSources(q, repositorySources([]string{shown}))).To(Succeed(),
+ q := ds.ArtworkQueue()
+ Expect(validateSources(ctx, q, repositorySources([]string{shown}))).To(Succeed(),
"explain's spelling of a source must be pasteable into --source")
- Expect(validateSources(q, repositorySources([]string{"(" + shown + ")"}))).ToNot(Succeed(),
+ Expect(validateSources(ctx, q, repositorySources([]string{"(" + shown + ")"}))).ToNot(Succeed(),
"a parenthesised name would be rejected, so explain must not print one")
})
})
@@ -573,7 +573,7 @@ var _ = Describe("reprocessArtwork", func() {
decline := func(io.Writer, int64, int64) bool { return false }
put := func(kind model.Kind, id, source string) {
- Expect(art.PutItemArtwork(&model.ItemArtwork{ItemKind: kind.Prefix(), ItemID: id,
+ Expect(art.PutItemArtwork(ctx, &model.ItemArtwork{ItemKind: kind.Prefix(), ItemID: id,
ImageType: model.ImageTypePrimary, Hash: "h" + id, Source: source})).To(Succeed())
}
@@ -584,8 +584,8 @@ var _ = Describe("reprocessArtwork", func() {
conf.Server.EnableM3UExternalAlbumArt = false
imageAgents = artwork.ImageAgentCount{Artist: 1, Album: 1}
ds = &tests.MockDataStore{}
- art = ds.Artwork(ctx).(*tests.MockArtworkRepo)
- queue = ds.ArtworkQueue(ctx).(*tests.MockArtworkQueueRepo)
+ art = ds.Artwork().(*tests.MockArtworkRepo)
+ queue = ds.ArtworkQueue().(*tests.MockArtworkQueueRepo)
out.Reset()
put(model.KindArtistArtwork, "ar-1", "external:deezer")
put(model.KindArtistArtwork, "ar-2", "")
@@ -601,19 +601,19 @@ var _ = Describe("reprocessArtwork", func() {
Expect(out.String()).To(ContainSubstring("album"))
Expect(out.String()).To(ContainSubstring("TOTAL"))
Expect(out.String()).To(ContainSubstring("Dry run"))
- Expect(queue.Count()).To(BeZero())
+ Expect(queue.Count(ctx)).To(BeZero())
})
It("queues nothing when the operator declines", func() {
Expect(reprocessArtwork(ctx, ds, kinds, nil, imageAgents, false, decline, &out)).To(Succeed())
Expect(out.String()).To(ContainSubstring("Aborted"))
- Expect(queue.Count()).To(BeZero())
+ Expect(queue.Count(ctx)).To(BeZero())
})
DescribeTable("records the applied config only for a run that leaves nothing on the old one",
func(selected []model.Kind, sources []string, dryRun, applied bool) {
- Expect(ds.Property(ctx).Put(consts.ArtConfFingerprintPropertyKey, "stale-fingerprint")).To(Succeed())
+ Expect(ds.Property().Put(ctx, consts.ArtConfFingerprintPropertyKey, "stale-fingerprint")).To(Succeed())
Expect(reprocessArtwork(ctx, ds, selected, sources, imageAgents, dryRun, accept, &out)).To(Succeed())
@@ -621,7 +621,7 @@ var _ = Describe("reprocessArtwork", func() {
if applied {
want = artwork.ConfigFingerprint()
}
- Expect(ds.Property(ctx).Get(consts.ArtConfFingerprintPropertyKey)).To(Equal(want))
+ Expect(ds.Property().Get(ctx, consts.ArtConfFingerprintPropertyKey)).To(Equal(want))
},
Entry("every kind, unfiltered", artwork.ReprocessKinds, nil, false, true),
Entry("every kind, but nothing matched", artwork.ReprocessKinds, []string{}, false, true),
@@ -633,14 +633,14 @@ var _ = Describe("reprocessArtwork", func() {
It("queues the matching items at recheck priority, leaving their artwork state alone", func() {
Expect(reprocessArtwork(ctx, ds, kinds, []string{"external:deezer"}, imageAgents, false, accept, &out)).To(Succeed())
- Expect(queue.Count()).To(Equal(int64(2)))
- queued, err := queue.Get(model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
+ Expect(queue.Count(ctx)).To(Equal(int64(2)))
+ queued, err := queue.Get(ctx, model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
Expect(err).ToNot(HaveOccurred())
Expect(queued.Priority).To(Equal(model.ArtworkPriorityRecheck))
- _, err = queue.Get(model.KindAlbumArtwork, "al-2", model.ImageTypePrimary)
+ _, err = queue.Get(ctx, model.KindAlbumArtwork, "al-2", model.ImageTypePrimary)
Expect(err).To(MatchError(model.ErrNotFound), "a non-matching source must not be queued")
- stored, err := art.GetItemArtwork(model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
+ stored, err := art.GetItemArtwork(ctx, model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
Expect(err).ToNot(HaveOccurred())
Expect(stored.Hash).To(Equal("hal-1"), "bulk reprocessing must not blank the current artwork")
})
@@ -648,20 +648,20 @@ var _ = Describe("reprocessArtwork", func() {
It("targets the absent state", func() {
Expect(reprocessArtwork(ctx, ds, kinds, []string{""}, imageAgents, false, accept, &out)).To(Succeed())
- Expect(queue.Count()).To(Equal(int64(1)))
- _, err := queue.Get(model.KindArtistArtwork, "ar-2", model.ImageTypePrimary)
+ Expect(queue.Count(ctx)).To(Equal(int64(1)))
+ _, err := queue.Get(ctx, model.KindArtistArtwork, "ar-2", model.ImageTypePrimary)
Expect(err).ToNot(HaveOccurred())
})
It("reports matched and queued separately when part of the set is already queued", func() {
- Expect(queue.Enqueue(model.ArtworkQueueItem{ItemKind: "ar", ItemID: "ar-1",
+ Expect(queue.Enqueue(ctx, model.ArtworkQueueItem{ItemKind: "ar", ItemID: "ar-1",
ImageType: model.ImageTypePrimary, Priority: model.ArtworkPriorityBump})).To(Succeed())
Expect(reprocessArtwork(ctx, ds, kinds, []string{"external:deezer"}, imageAgents, false, accept, &out)).To(Succeed())
Expect(out.String()).To(ContainSubstring("Queued 1 of 2 matched items"))
Expect(out.String()).To(ContainSubstring("Already queued, left unchanged: 1"))
- queued, err := queue.Get(model.KindArtistArtwork, "ar-1", model.ImageTypePrimary)
+ queued, err := queue.Get(ctx, model.KindArtistArtwork, "ar-1", model.ImageTypePrimary)
Expect(err).ToNot(HaveOccurred())
Expect(queued.Priority).To(Equal(model.ArtworkPriorityBump),
"an already-queued row keeps its priority and backoff")
@@ -675,7 +675,7 @@ var _ = Describe("reprocessArtwork", func() {
}, &out)).To(Succeed())
Expect(out.String()).To(ContainSubstring("Nothing"))
- Expect(queue.Count()).To(BeZero())
+ Expect(queue.Count(ctx)).To(BeZero())
})
It("reports an empty selection as a dry run when one was asked for", func() {
@@ -767,7 +767,7 @@ var _ = Describe("reprocessArtwork", func() {
Expect(err.Error()).To(ContainSubstring("external:deezer"))
Expect(err.Error()).To(ContainSubstring("folder"))
Expect(err.Error()).To(ContainSubstring("absent"), "the empty source prints under its user-facing name")
- Expect(queue.Count()).To(BeZero())
+ Expect(queue.Count(ctx)).To(BeZero())
})
It("accepts the absent filter with nothing absent, still rejecting a typo", func() {
@@ -777,7 +777,7 @@ var _ = Describe("reprocessArtwork", func() {
imageAgents, false, accept, &out)).To(Succeed(),
"a reserved source must stay valid once the library has none of it")
Expect(out.String()).To(ContainSubstring("Nothing matches"))
- Expect(queue.Count()).To(BeZero())
+ Expect(queue.Count(ctx)).To(BeZero())
Expect(reprocessArtwork(ctx, ds, kinds, repositorySources([]string{"absnt"}),
imageAgents, true, accept, &out)).ToNot(Succeed(), "a typo must still be rejected")
@@ -797,7 +797,7 @@ var _ = Describe("reprocessArtwork", func() {
Expect(out.String()).To(ContainSubstring("Nothing matches"),
"a well-formed filter must not be reported as a typo because of the kinds selected")
- Expect(queue.Count()).To(BeZero())
+ Expect(queue.Count(ctx)).To(BeZero())
})
})
@@ -816,19 +816,19 @@ var _ = Describe("collectStatus", func() {
BeforeEach(func() {
ds = &tests.MockDataStore{}
- art = ds.Artwork(ctx).(*tests.MockArtworkRepo)
- queue = ds.ArtworkQueue(ctx).(*tests.MockArtworkQueueRepo)
+ art = ds.Artwork().(*tests.MockArtworkRepo)
+ queue = ds.ArtworkQueue().(*tests.MockArtworkQueueRepo)
put := func(kind model.Kind, id, source, hash string, attempted time.Time) {
- Expect(art.PutItemArtwork(&model.ItemArtwork{ItemKind: kind.Prefix(), ItemID: id,
+ Expect(art.PutItemArtwork(ctx, &model.ItemArtwork{ItemKind: kind.Prefix(), ItemID: id,
ImageType: model.ImageTypePrimary, Source: source, Hash: hash, AttemptedAt: attempted})).To(Succeed())
}
put(model.KindArtistArtwork, "ar-1", "external:deezer", "h1", time.Now())
put(model.KindArtistArtwork, "ar-2", "", "", time.Now().Add(-24*time.Hour))
// ar-3 is absent because it gave up, so the two absent artists split across the columns.
- Expect(art.PutItemArtwork(&model.ItemArtwork{ItemKind: "ar", ItemID: "ar-3",
+ Expect(art.PutItemArtwork(ctx, &model.ItemArtwork{ItemKind: "ar", ItemID: "ar-3",
ImageType: model.ImageTypePrimary, LastFailure: "[]", AttemptedAt: time.Now()})).To(Succeed())
put(model.KindAlbumArtwork, "al-1", "folder", "h2", time.Now())
- Expect(queue.Enqueue(model.ArtworkQueueItem{ItemKind: "ar", ItemID: "ar-9",
+ Expect(queue.Enqueue(ctx, model.ArtworkQueueItem{ItemKind: "ar", ItemID: "ar-9",
ImageType: model.ImageTypePrimary, Priority: model.ArtworkPriorityBackfill})).To(Succeed())
})
@@ -848,7 +848,7 @@ var _ = Describe("collectStatus", func() {
})
It("compares the stored fingerprint against the current one", func() {
- Expect(ds.Property(ctx).Put(consts.ArtConfFingerprintPropertyKey, "old-fingerprint")).To(Succeed())
+ Expect(ds.Property().Put(ctx, consts.ArtConfFingerprintPropertyKey, "old-fingerprint")).To(Succeed())
rep, err := collectStatus(ctx, ds)
Expect(err).ToNot(HaveOccurred())
@@ -860,7 +860,7 @@ var _ = Describe("collectStatus", func() {
It("queues nothing", func() {
_, err := collectStatus(ctx, ds)
Expect(err).ToNot(HaveOccurred())
- Expect(queue.Count()).To(Equal(int64(1)), "status must not enqueue anything")
+ Expect(queue.Count(ctx)).To(Equal(int64(1)), "status must not enqueue anything")
})
})
@@ -973,21 +973,21 @@ var _ = Describe("refreshItems", func() {
albums := tests.CreateMockAlbumRepo()
albums.SetData(model.Albums{{ID: "al-1"}, {ID: "al-3"}})
ds = &tests.MockDataStore{MockedAlbum: albums}
- art = ds.Artwork(ctx).(*tests.MockArtworkRepo)
- queue = ds.ArtworkQueue(ctx).(*tests.MockArtworkQueueRepo)
+ art = ds.Artwork().(*tests.MockArtworkRepo)
+ queue = ds.ArtworkQueue().(*tests.MockArtworkQueueRepo)
out.Reset()
})
It("clears the stored state and queues each id at Bump priority", func() {
- Expect(art.PutItemArtwork(&model.ItemArtwork{ItemKind: model.KindAlbumArtwork.Prefix(),
+ Expect(art.PutItemArtwork(ctx, &model.ItemArtwork{ItemKind: model.KindAlbumArtwork.Prefix(),
ItemID: "al-1", ImageType: model.ImageTypePrimary, Hash: "abc123"})).To(Succeed())
Expect(refreshItems(ctx, ds, []model.ArtworkID{
{Kind: model.KindAlbumArtwork, ID: "al-1"}, {Kind: model.KindAlbumArtwork, ID: "al-3"}}, &out)).To(BeZero())
- _, err := art.GetItemArtwork(model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
+ _, err := art.GetItemArtwork(ctx, model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
Expect(err).To(MatchError(model.ErrNotFound))
- queued, err := queue.Get(model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
+ queued, err := queue.Get(ctx, model.KindAlbumArtwork, "al-1", model.ImageTypePrimary)
Expect(err).ToNot(HaveOccurred())
Expect(queued.Priority).To(Equal(model.ArtworkPriorityBump))
Expect(out.String()).To(Equal("al/al-1: queued\nal/al-3: queued\n"))
@@ -996,7 +996,7 @@ var _ = Describe("refreshItems", func() {
It("skips an id that does not exist instead of queuing it", func() {
Expect(refreshItems(ctx, ds, []model.ArtworkID{{Kind: model.KindAlbumArtwork, ID: "al-2"}}, &out)).To(Equal(1))
- _, err := queue.Get(model.KindAlbumArtwork, "al-2", model.ImageTypePrimary)
+ _, err := queue.Get(ctx, model.KindAlbumArtwork, "al-2", model.ImageTypePrimary)
Expect(err).To(MatchError(model.ErrNotFound), "a typo must not leave an orphan queue row")
Expect(out.String()).To(BeEmpty())
})
@@ -1145,9 +1145,9 @@ var _ = Describe("cancelArtwork", func() {
BeforeEach(func() {
ds = &tests.MockDataStore{}
- queue = ds.ArtworkQueue(ctx).(*tests.MockArtworkQueueRepo)
+ queue = ds.ArtworkQueue().(*tests.MockArtworkQueueRepo)
out.Reset()
- Expect(queue.Enqueue(
+ Expect(queue.Enqueue(ctx,
model.ArtworkQueueItem{ItemKind: "ar", ItemID: "ar-1", ImageType: model.ImageTypePrimary,
Priority: model.ArtworkPriorityBackfill},
model.ArtworkQueueItem{ItemKind: "ar", ItemID: "ar-2", ImageType: model.ImageTypePrimary,
@@ -1164,28 +1164,28 @@ var _ = Describe("cancelArtwork", func() {
Expect(out.String()).To(ContainSubstring("backfill"))
Expect(out.String()).To(ContainSubstring("TOTAL"))
Expect(out.String()).To(ContainSubstring("Dry run"))
- Expect(queue.Count()).To(BeNumerically("==", 3))
+ Expect(queue.Count(ctx)).To(BeNumerically("==", 3))
})
It("cancels nothing when the operator declines", func() {
Expect(cancelArtwork(ctx, ds, nil, nil, false, decline, &out)).To(Succeed())
Expect(out.String()).To(ContainSubstring("Aborted"))
- Expect(queue.Count()).To(BeNumerically("==", 3))
+ Expect(queue.Count(ctx)).To(BeNumerically("==", 3))
})
It("deletes the selected rows and leaves the rest queued", func() {
Expect(cancelArtwork(ctx, ds, nil, []int{model.ArtworkPriorityBackfill}, false, accept, &out)).To(Succeed())
- Expect(queue.Count()).To(BeNumerically("==", 1))
- _, err := queue.Get(model.KindArtistArtwork, "ar-2", model.ImageTypePrimary)
+ Expect(queue.Count(ctx)).To(BeNumerically("==", 1))
+ _, err := queue.Get(ctx, model.KindArtistArtwork, "ar-2", model.ImageTypePrimary)
Expect(err).ToNot(HaveOccurred(), "a non-matching priority must stay queued")
Expect(out.String()).To(ContainSubstring("Cancelled 2 of 2 matched items."))
})
It("cancels every kind and priority when neither filter is given", func() {
Expect(cancelArtwork(ctx, ds, nil, nil, false, accept, &out)).To(Succeed())
- Expect(queue.Count()).To(BeZero())
+ Expect(queue.Count(ctx)).To(BeZero())
})
It("stops at a selection that matches nothing instead of prompting", func() {
@@ -1196,7 +1196,7 @@ var _ = Describe("cancelArtwork", func() {
Expect(cancelArtwork(ctx, ds, []model.Kind{model.KindPlaylistArtwork}, nil, false, refuse, &out)).To(Succeed())
Expect(out.String()).To(ContainSubstring("Nothing matches this selection."))
- Expect(queue.Count()).To(BeNumerically("==", 3))
+ Expect(queue.Count(ctx)).To(BeNumerically("==", 3))
})
It("reports a queue read failure instead of reporting nothing to cancel", func() {
diff --git a/cmd/inspect.go b/cmd/inspect.go
index 5e88793cc..05f569f3e 100644
--- a/cmd/inspect.go
+++ b/cmd/inspect.go
@@ -1,13 +1,17 @@
package cmd
import (
+ "context"
"encoding/json"
"fmt"
+ "path/filepath"
"strings"
"github.com/navidrome/navidrome/core"
+ "github.com/navidrome/navidrome/db"
"github.com/navidrome/navidrome/log"
"github.com/navidrome/navidrome/model"
+ "github.com/navidrome/navidrome/persistence"
"github.com/pelletier/go-toml/v2"
"github.com/spf13/cobra"
"gopkg.in/yaml.v3"
@@ -28,7 +32,7 @@ var inspectCmd = &cobra.Command{
Long: "Show file tags as seen by Navidrome",
Args: cobra.MinimumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
- runInspector(args)
+ runInspector(cmd.Context(), args)
},
}
@@ -55,18 +59,24 @@ func prettyMarshal(v any) ([]byte, error) {
return []byte(res.String()), nil
}
-func runInspector(args []string) {
+func runInspector(ctx context.Context, args []string) {
marshal := marshalers[format]
if marshal == nil {
log.Fatal("Invalid format", "format", format)
}
+ libs := loadLibraries(ctx)
+ matcher := model.NewLibraryMatcher(libs)
var out []core.InspectOutput
for _, filePath := range args {
if !model.IsAudioFile(filePath) {
log.Warn("Not an audio file", "file", filePath)
continue
}
- output, err := core.Inspect(filePath, 1, "")
+ lib, ok := libraryForFile(matcher, filePath)
+ if !ok && len(libs) > 0 {
+ log.Warn("File is not in any library, using the global PID config", "file", filePath)
+ }
+ output, err := core.Inspect(filePath, lib, "")
if err != nil {
log.Warn("Unable to process file", "file", filePath, "error", err)
continue
@@ -77,3 +87,33 @@ func runInspector(args []string) {
data, _ := marshal(out)
fmt.Println(string(data))
}
+
+// loadLibraries reads the libraries, so each file gets its library's PID config. It never creates a DB.
+func loadLibraries(ctx context.Context) model.Libraries {
+ if dbFile, ok := existingDBFile(); !ok {
+ log.Warn(ctx, "No database found, using the global PID config", "path", dbFile)
+ return nil
+ }
+ defer db.Init(ctx)()
+ libs, err := persistence.New(db.Db()).Library().GetAll(ctx)
+ if err != nil {
+ log.Warn(ctx, "Could not load libraries, using the global PID config", err)
+ return nil
+ }
+ for i := range libs {
+ if absPath, err := filepath.Abs(libs[i].Path); err == nil {
+ libs[i].Path = absPath
+ }
+ }
+ return libs
+}
+
+// libraryForFile falls back to the default library with no overrides, which uses the global PID config.
+func libraryForFile(matcher *model.LibraryMatcher, filePath string) (model.Library, bool) {
+ if absPath, err := filepath.Abs(filePath); err == nil {
+ if lib, ok := matcher.FindLibrary(absPath); ok {
+ return lib, true
+ }
+ }
+ return model.Library{ID: model.DefaultLibraryID}, false
+}
diff --git a/cmd/inspect_test.go b/cmd/inspect_test.go
new file mode 100644
index 000000000..728dc8770
--- /dev/null
+++ b/cmd/inspect_test.go
@@ -0,0 +1,61 @@
+package cmd
+
+import (
+ "os"
+ "path/filepath"
+
+ "github.com/navidrome/navidrome/conf"
+ "github.com/navidrome/navidrome/conf/configtest"
+ "github.com/navidrome/navidrome/model"
+ . "github.com/onsi/ginkgo/v2"
+ . "github.com/onsi/gomega"
+)
+
+var _ = Describe("inspect", func() {
+ Describe("libraryForFile", func() {
+ var matcher *model.LibraryMatcher
+ var root string
+
+ BeforeEach(func() {
+ root = GinkgoT().TempDir()
+ cwd, err := os.Getwd()
+ Expect(err).ToNot(HaveOccurred())
+ matcher = model.NewLibraryMatcher(model.Libraries{
+ {ID: 1, Path: filepath.Join(root, "music")},
+ {ID: 2, Path: filepath.Join(cwd, "loose"), PIDAlbum: "folder"},
+ })
+ })
+
+ It("returns the library that contains an absolute path", func() {
+ lib, ok := libraryForFile(matcher, filepath.Join(root, "music", "album", "track.mp3"))
+ Expect(ok).To(BeTrue())
+ Expect(lib.ID).To(Equal(1))
+ })
+
+ It("resolves a relative path against the working directory", func() {
+ lib, ok := libraryForFile(matcher, filepath.Join("loose", "track.mp3"))
+ Expect(ok).To(BeTrue())
+ Expect(lib.PIDAlbum).To(Equal("folder"))
+ })
+
+ It("falls back to the default library without overrides", func() {
+ lib, ok := libraryForFile(matcher, filepath.Join(root, "elsewhere", "track.mp3"))
+ Expect(ok).To(BeFalse())
+ Expect(lib).To(Equal(model.Library{ID: model.DefaultLibraryID}))
+ })
+ })
+
+ Describe("loadLibraries", func() {
+ BeforeEach(func() {
+ DeferCleanup(configtest.SetupConfig())
+ })
+
+ It("does not create a database when there is none", func() {
+ dbFile := filepath.Join(GinkgoT().TempDir(), "navidrome.db")
+ conf.Server.DbPath = dbFile + "?_journal_mode=WAL"
+
+ Expect(loadLibraries(GinkgoT().Context())).To(BeNil())
+ Expect(dbFile).ToNot(BeAnExistingFile())
+ })
+ })
+})
diff --git a/cmd/missing.go b/cmd/missing.go
index 65f571661..ce95e39f0 100644
--- a/cmd/missing.go
+++ b/cmd/missing.go
@@ -72,7 +72,7 @@ func runMissingList(ctx context.Context) {
}
ds, ctx := getAdminContext(ctx)
- mfs, err := ds.MediaFile(ctx).GetCursor(model.QueryOptions{
+ mfs, err := ds.MediaFile().GetCursor(ctx, model.QueryOptions{
Filters: squirrel.Eq{"missing": true},
Sort: "path",
})
@@ -128,7 +128,7 @@ func runMissingFix(ctx context.Context, missingRef, targetRef string) {
// resolveMediaFile looks up a media file by ID first, then by path (optionally libraryID:path).
func resolveMediaFile(ctx context.Context, ds model.DataStore, ref string) *model.MediaFile {
- mf, err := ds.MediaFile(ctx).Get(ref)
+ mf, err := ds.MediaFile().Get(ctx, ref)
if err == nil {
return mf
}
@@ -136,7 +136,7 @@ func resolveMediaFile(ctx context.Context, ds model.DataStore, ref string) *mode
log.Fatal(ctx, "Error looking up media file", "ref", ref, err)
}
- mfs, err := ds.MediaFile(ctx).FindByPaths([]string{ref})
+ mfs, err := ds.MediaFile().FindByPaths(ctx, []string{ref})
if err != nil {
log.Fatal(ctx, "Error looking up media file by path", "ref", ref, err)
}
diff --git a/cmd/pls.go b/cmd/pls.go
index 93b411483..bf16ea420 100644
--- a/cmd/pls.go
+++ b/cmd/pls.go
@@ -109,7 +109,7 @@ func fetchPlaylists(ctx context.Context, ds model.DataStore, sort string) model.
}
options.Filters = squirrel.Eq{"owner_id": user.ID}
}
- pls, err := ds.Playlist(ctx).GetAll(options)
+ pls, err := ds.Playlist().GetAll(ctx, options)
if err != nil {
log.Fatal(ctx, "Failed to retrieve playlists", err)
}
@@ -117,17 +117,17 @@ func fetchPlaylists(ctx context.Context, ds model.DataStore, sort string) model.
}
func findPlaylist(ctx context.Context, ds model.DataStore, nameOrID string) *model.Playlist {
- playlist, err := ds.Playlist(ctx).GetWithTracks(nameOrID, true, false)
+ playlist, err := ds.Playlist().GetWithTracks(ctx, nameOrID, true, false)
if err != nil && !errors.Is(err, model.ErrNotFound) {
log.Fatal("Error retrieving playlist", "name", nameOrID, err)
}
if errors.Is(err, model.ErrNotFound) {
- playlists, err := ds.Playlist(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"playlist.name": nameOrID}})
+ playlists, err := ds.Playlist().GetAll(ctx, model.QueryOptions{Filters: squirrel.Eq{"playlist.name": nameOrID}})
if err != nil {
log.Fatal("Error retrieving playlist", "name", nameOrID, err)
}
if len(playlists) > 0 {
- playlist, err = ds.Playlist(ctx).GetWithTracks(playlists[0].ID, true, false)
+ playlist, err = ds.Playlist().GetWithTracks(ctx, playlists[0].ID, true, false)
if err != nil {
log.Fatal("Error retrieving playlist", "name", nameOrID, err)
}
@@ -194,7 +194,7 @@ func runExport(ctx context.Context) {
exported := 0
for _, pls := range allPls {
- plsWithTracks, err := ds.Playlist(ctx).GetWithTracks(pls.ID, true, false)
+ plsWithTracks, err := ds.Playlist().GetWithTracks(ctx, pls.ID, true, false)
if err != nil {
log.Error("Error loading playlist tracks", "playlist", pls.Name, err)
continue
diff --git a/cmd/plugin.go b/cmd/plugin.go
index ded28e969..7b8a9a393 100644
--- a/cmd/plugin.go
+++ b/cmd/plugin.go
@@ -243,7 +243,7 @@ func runPluginInfo(ctx context.Context, arg string) {
}
requirePluginsEnabled(ctx)
ds, ctx := getAdminContext(ctx)
- p, err := ds.Plugin(ctx).Get(arg)
+ p, err := ds.Plugin().Get(ctx, arg)
if err != nil {
log.Fatal(ctx, "Plugin not found", "id", arg, err)
}
@@ -264,7 +264,7 @@ func runPluginValidate(ctx context.Context, arg string) {
}
requirePluginsEnabled(ctx)
ds, ctx := getAdminContext(ctx)
- p, err := ds.Plugin(ctx).Get(arg)
+ p, err := ds.Plugin().Get(ctx, arg)
if err != nil {
log.Fatal(ctx, "Plugin not found", "id", arg, err)
}
@@ -329,7 +329,7 @@ func formatPluginList(list model.Plugins, format string) (string, error) {
func runPluginList(ctx context.Context) {
requirePluginsEnabled(ctx)
ds, ctx := getAdminContext(ctx)
- list, err := ds.Plugin(ctx).GetAll()
+ list, err := ds.Plugin().GetAll(ctx)
if err != nil {
log.Fatal(ctx, "Failed to list plugins", err)
}
@@ -372,7 +372,7 @@ var pluginEditCmd = &cobra.Command{
Run: func(cmd *cobra.Command, args []string) {
requirePluginsEnabled(cmd.Context())
ds, ctx := getAdminContext(cmd.Context())
- cur, err := ds.Plugin(ctx).Get(args[0])
+ cur, err := ds.Plugin().Get(ctx, args[0])
if err != nil {
log.Fatal(ctx, "Plugin not found", "id", args[0], err)
}
diff --git a/cmd/root.go b/cmd/root.go
index f632b0425..e39c55365 100644
--- a/cmd/root.go
+++ b/cmd/root.go
@@ -44,7 +44,9 @@ Complete documentation is available at https://www.navidrome.org/docs`,
preRun()
},
Run: func(cmd *cobra.Command, args []string) {
- runNavidrome(cmd.Context())
+ if err := runNavidrome(cmd.Context()); err != nil {
+ log.Fatal("Fatal error in Navidrome. Aborting", err)
+ }
},
PostRun: func(cmd *cobra.Command, args []string) {
postRun()
@@ -76,12 +78,12 @@ func postRun() {
}
// runNavidrome is the main entry point for the Navidrome server. It starts all the services and blocks.
-// If any of the services returns an error, it will log it and exit. If the process receives a signal to exit,
-// it will cancel the context and exit gracefully.
-func runNavidrome(ctx context.Context) {
- defer db.Init(ctx)()
+// If any of the services returns an error, it stops the others and returns that error, so the caller can
+// exit with a non-zero code. If the context is cancelled (a signal or a service stop), it returns nil.
+func runNavidrome(parentCtx context.Context) error {
+ defer db.Init(parentCtx)()
- g, ctx := errgroup.WithContext(ctx)
+ g, ctx := errgroup.WithContext(parentCtx)
g.Go(startServer(ctx))
g.Go(startSignaller(ctx))
g.Go(startScheduler(ctx))
@@ -102,9 +104,11 @@ func runNavidrome(ctx context.Context) {
log.Warn(ctx, "Automatic Scanning is DISABLED")
}
- if err := g.Wait(); err != nil {
- log.Error("Fatal error in Navidrome. Aborting", err)
+ // Errors caused by a normal shutdown are not failures
+ if err := g.Wait(); err != nil && parentCtx.Err() == nil {
+ return err
}
+ return nil
}
// mainContext returns a context that is cancelled when the process receives a signal to exit.
@@ -133,6 +137,9 @@ func startServer(ctx context.Context) func() error {
if conf.Server.Jellyfin.Enabled {
a.MountRouter("Jellyfin API", consts.URLPathJellyfinAPI, CreateJellyfinAPIRouter(ctx))
}
+ if conf.Server.DevAPIv1 {
+ a.MountRouter("API v1", consts.URLPathAPIv1, CreateAPIv1Router(ctx))
+ }
if conf.Server.Prometheus.Enabled {
p := CreatePrometheus()
// blocking call because takes <100ms but useful if fails
@@ -183,46 +190,50 @@ func schedulePeriodicScan(ctx context.Context) func() error {
}
}
-func pidHashChanged(ds model.DataStore) (bool, error) {
- pidAlbum, err := ds.Property(context.Background()).DefaultGet(consts.PIDAlbumKey, "")
+// librariesWithChangedPID returns the names of the libraries whose effective PID config differs from
+// the one used by their last finished scan
+func librariesWithChangedPID(ctx context.Context, ds model.DataStore) ([]string, error) {
+ libs, err := ds.Library().GetAll(ctx)
if err != nil {
- return false, err
+ return nil, err
}
- pidTrack, err := ds.Property(context.Background()).DefaultGet(consts.PIDTrackKey, "")
- if err != nil {
- return false, err
+ var names []string
+ for _, lib := range libs {
+ if lib.PIDChanged() {
+ names = append(names, lib.Name)
+ }
}
- return !strings.EqualFold(pidAlbum, conf.Server.PID.Album) || !strings.EqualFold(pidTrack, conf.Server.PID.Track), nil
+ return names, nil
}
// runInitialScan runs an initial scan of the music library if needed.
func runInitialScan(ctx context.Context) func() error {
return func() error {
ds := CreateDataStore()
- fullScanRequired, err := ds.Property(ctx).DefaultGet(consts.FullScanAfterMigrationFlagKey, "0")
+ fullScanRequired, err := ds.Property().DefaultGet(ctx, consts.FullScanAfterMigrationFlagKey, "0")
if err != nil {
return err
}
- inProgress, err := ds.Library(ctx).ScanInProgress()
+ inProgress, err := ds.Library().ScanInProgress(ctx)
if err != nil {
return err
}
- pidHasChanged, err := pidHashChanged(ds)
+ pidChangedLibs, err := librariesWithChangedPID(ctx, ds)
if err != nil {
return err
}
scanOnStartup := conf.Server.Scanner.Enabled && conf.Server.Scanner.ScanOnStartup
- scanNeeded := scanOnStartup || inProgress || fullScanRequired == "1" || pidHasChanged
+ scanNeeded := scanOnStartup || inProgress || fullScanRequired == "1" || len(pidChangedLibs) > 0
time.Sleep(2 * time.Second) // Wait 2 seconds before the initial scan
if scanNeeded {
s := CreateScanner(ctx)
switch {
case fullScanRequired == "1":
log.Warn(ctx, "Full scan required after migration")
- _ = ds.Property(ctx).Delete(consts.FullScanAfterMigrationFlagKey)
- case pidHasChanged:
- log.Warn(ctx, "PID config changed, performing full scan")
- fullScanRequired = "1"
+ _ = ds.Property().Delete(ctx, consts.FullScanAfterMigrationFlagKey)
+ case len(pidChangedLibs) > 0:
+ // Includes never-scanned libraries. The scanner rescans in full only the ones that need it
+ log.Warn(ctx, "Libraries with a new or changed PID config, scanning", "libraries", pidChangedLibs)
case inProgress:
log.Warn(ctx, "Resuming interrupted scan")
default:
@@ -375,10 +386,26 @@ func startPlaybackServer(ctx context.Context) func() error {
func startArtworkWorker(ctx context.Context, worker *artwork.Worker) func() error {
return func() error {
log.Info(ctx, "Starting artwork worker")
+ // The scanner writes to the DB for its whole run; competing for the write lock makes both fail.
+ worker.PauseWhile(scanner.IsScanning)
return worker.Run(ctx)
}
}
+// outsideScan runs a DB maintenance job unless a scan is running, and keeps a scan from starting
+// until it ends; both write to the DB, and competing for the lock can make either fail.
+func outsideScan(ctx context.Context, job string, run func(context.Context) error) {
+ release, ok := scanner.LockForMaintenance()
+ if !ok {
+ log.Debug(ctx, "Skipping "+job+" because a scan is in progress")
+ return
+ }
+ defer release()
+ if err := run(ctx); err != nil {
+ log.Error(ctx, "Error running "+job, err)
+ }
+}
+
// scheduleArtworkHousekeeping registers the recurring missing-state and prune jobs, and
// reports an artwork config change without acting on it.
func scheduleArtworkHousekeeping(ctx context.Context, worker *artwork.Worker) func() error {
@@ -386,26 +413,20 @@ func scheduleArtworkHousekeeping(ctx context.Context, worker *artwork.Worker) fu
schedulerInstance := scheduler.GetInstance()
if _, err := schedulerInstance.Add(consts.ArtworkEnqueueMissingSchedule, func() {
- if err := worker.EnqueueMissingAll(ctx); err != nil {
- log.Error(ctx, "Error enqueueing missing artwork rechecks", err)
- }
+ outsideScan(ctx, "artwork missing-state recheck", worker.EnqueueMissingAll)
}); err != nil {
log.Error(ctx, "Error scheduling artwork missing-state recheck", err)
}
if _, err := schedulerInstance.Add(consts.ArtworkPruneSchedule, func() {
- if err := worker.RunPrune(ctx); err != nil {
- log.Error(ctx, "Error running artwork prune", err)
- }
+ outsideScan(ctx, "artwork prune", worker.RunPrune)
}); err != nil {
log.Error(ctx, "Error scheduling artwork prune", err)
}
// Also run the missing-row recheck once at startup so a never-scanned entity is picked up
// immediately, not only on the next hourly tick (e.g. after enabling the feature).
- if err := worker.EnqueueMissingAll(ctx); err != nil {
- log.Error(ctx, "Error enqueueing missing artwork rechecks", err)
- }
+ outsideScan(ctx, "artwork missing-state recheck", worker.EnqueueMissingAll)
if err := worker.ReconcileConfig(ctx); err != nil {
log.Error(ctx, "Error checking the artwork config fingerprint", err)
diff --git a/cmd/root_test.go b/cmd/root_test.go
index af8d44e7e..423cd2a8f 100644
--- a/cmd/root_test.go
+++ b/cmd/root_test.go
@@ -1,6 +1,7 @@
package cmd
import (
+ "errors"
"net/http"
"net/http/httptest"
"path"
@@ -9,6 +10,8 @@ import (
"github.com/go-chi/chi/v5"
"github.com/navidrome/navidrome/conf"
"github.com/navidrome/navidrome/conf/configtest"
+ "github.com/navidrome/navidrome/model"
+ "github.com/navidrome/navidrome/tests"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
@@ -44,3 +47,30 @@ var _ = Describe("profilerHandler", func() {
Entry("with a trailing-slash BasePath", "/music/"),
)
})
+
+var _ = Describe("librariesWithChangedPID", func() {
+ var ds *tests.MockDataStore
+ var libs *tests.MockLibraryRepo
+
+ BeforeEach(func() {
+ DeferCleanup(configtest.SetupConfig())
+ libs = &tests.MockLibraryRepo{}
+ ds = &tests.MockDataStore{MockedLibrary: libs}
+ })
+
+ It("returns only the libraries whose PID config changed", func() {
+ pid := model.Library{}.EffectivePID()
+ libs.SetData(model.Libraries{
+ {ID: 1, Name: "Same", ScannedPIDAlbum: pid.Album, ScannedPIDTrack: pid.Track},
+ {ID: 2, Name: "Changed", PIDAlbum: "folder", ScannedPIDAlbum: pid.Album, ScannedPIDTrack: pid.Track},
+ {ID: 3, Name: "Never scanned"},
+ })
+ Expect(librariesWithChangedPID(GinkgoT().Context(), ds)).To(ConsistOf("Changed", "Never scanned"))
+ })
+
+ It("returns the error from the repository", func() {
+ libs.Err = errors.New("db down")
+ _, err := librariesWithChangedPID(GinkgoT().Context(), ds)
+ Expect(err).To(MatchError("db down"))
+ })
+})
diff --git a/cmd/svc.go b/cmd/svc.go
index 7fec708ff..4e8b1fd85 100644
--- a/cmd/svc.go
+++ b/cmd/svc.go
@@ -44,7 +44,7 @@ var svcCmd = &cobra.Command{
}
type svcControl struct {
- ctx context.Context
+ ctx context.Context //nolint:containedctx // service lifecycle ctx, cancelled by Stop
cancel context.CancelFunc
done chan struct{}
}
@@ -53,8 +53,13 @@ func (p *svcControl) Start(service.Service) error {
p.done = make(chan struct{})
p.ctx, p.cancel = context.WithCancel(context.Background())
go func() {
- runNavidrome(p.ctx)
+ err := runNavidrome(p.ctx)
close(p.done)
+ // service.Run() only returns when it gets a stop request, so exit here to let the
+ // service manager see the failure and restart the service
+ if err != nil {
+ log.Fatal("Fatal error in Navidrome. Aborting", err)
+ }
}()
return nil
}
@@ -74,7 +79,7 @@ func (p *svcControl) Stop(service.Service) error {
var svcInstance = sync.OnceValue(func() service.Service {
options := make(service.KeyValue)
options["Restart"] = "on-failure"
- options["SuccessExitStatus"] = "1 2 8 SIGKILL"
+ options["SuccessExitStatus"] = "SIGKILL"
options["UserService"] = false
options["LogDirectory"] = conf.Server.DataFolder.String()
options["SystemdScript"] = systemdScript
diff --git a/cmd/user.go b/cmd/user.go
index 1abf157b7..eb64e69fe 100644
--- a/cmd/user.go
+++ b/cmd/user.go
@@ -183,7 +183,7 @@ func runCreateUser(ctx context.Context) {
ds, ctx := getAdminContext(ctx)
err := ds.WithTx(func(tx model.DataStore) error {
- existingUser, err := tx.User(ctx).FindByUsername(userID)
+ existingUser, err := tx.User().FindByUsername(ctx, userID)
if existingUser != nil {
return fmt.Errorf("existing user '%s'", userID)
}
@@ -193,7 +193,7 @@ func runCreateUser(ctx context.Context) {
}
if len(libraryIds) > 0 && !setAdmin {
- user.Libraries, err = tx.Library(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}})
+ user.Libraries, err = tx.Library().GetAll(ctx, model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}})
if err != nil {
return err
}
@@ -202,13 +202,13 @@ func runCreateUser(ctx context.Context) {
return libraryError(user.Libraries)
}
} else {
- user.Libraries, err = tx.Library(ctx).GetAll()
+ user.Libraries, err = tx.Library().GetAll(ctx)
if err != nil {
return err
}
}
- err = tx.User(ctx).Put(&user)
+ err = tx.User().Put(ctx, &user)
if err != nil {
return err
}
@@ -218,7 +218,7 @@ func runCreateUser(ctx context.Context) {
updatedIds[idx] = lib.ID
}
- err = tx.User(ctx).SetUserLibraries(user.ID, updatedIds)
+ err = tx.User().SetUserLibraries(ctx, user.ID, updatedIds)
return err
})
@@ -236,7 +236,7 @@ func runDeleteUser(ctx context.Context) {
var user *model.User
err = ds.WithTx(func(tx model.DataStore) error {
- count, err := tx.User(ctx).CountAll()
+ count, err := tx.User().CountAll(ctx)
if err != nil {
return err
}
@@ -250,7 +250,7 @@ func runDeleteUser(ctx context.Context) {
return err
}
- return tx.User(ctx).Delete(user.ID)
+ return tx.User().Delete(ctx, user.ID)
})
if err != nil {
@@ -276,7 +276,7 @@ func runUserEdit(ctx context.Context) {
}
if len(libraryIds) > 0 && !setAdmin {
- libraries, err := tx.Library(ctx).GetAll(model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}})
+ libraries, err := tx.Library().GetAll(ctx, model.QueryOptions{Filters: squirrel.Eq{"id": libraryIds}})
if err != nil {
return err
@@ -291,7 +291,7 @@ func runUserEdit(ctx context.Context) {
}
if setAdmin && !user.IsAdmin {
- libraries, err := tx.Library(ctx).GetAll()
+ libraries, err := tx.Library().GetAll(ctx)
if err != nil {
return err
}
@@ -337,7 +337,7 @@ func runUserEdit(ctx context.Context) {
return nil
}
- err := tx.User(ctx).Put(user)
+ err := tx.User().Put(ctx, user)
if err != nil {
return err
}
@@ -348,7 +348,7 @@ func runUserEdit(ctx context.Context) {
updatedIds[idx] = lib.ID
}
- err := tx.User(ctx).SetUserLibraries(user.ID, updatedIds)
+ err := tx.User().SetUserLibraries(ctx, user.ID, updatedIds)
if err != nil {
return err
}
@@ -393,13 +393,11 @@ func runUserList(ctx context.Context) {
ds, ctx := getAdminContext(ctx)
- users, err := ds.User(ctx).ReadAll()
+ userList, err := ds.User().ReadAll(ctx)
if err != nil {
log.Fatal(ctx, "Failed to retrieve users", err)
}
- userList := users.(model.Users)
-
if outputFormat == "csv" {
w := csv.NewWriter(os.Stdout)
_ = w.Write([]string{
diff --git a/cmd/utils.go b/cmd/utils.go
index a67f720ac..f35a31fb1 100644
--- a/cmd/utils.go
+++ b/cmd/utils.go
@@ -18,11 +18,16 @@ import (
"github.com/navidrome/navidrome/persistence"
)
-// requireExistingDB aborts the command when the database file (DbPath minus DSN
-// params) does not exist.
-func requireExistingDB() {
+// existingDBFile returns the database file (DbPath minus DSN params), and whether it exists.
+func existingDBFile() (string, bool) {
path, _, _ := strings.Cut(conf.Server.DbPath, "?")
- if _, err := os.Stat(path); os.IsNotExist(err) {
+ _, err := os.Stat(path)
+ return path, err == nil
+}
+
+// requireExistingDB aborts the command when the database file does not exist.
+func requireExistingDB() {
+ if path, ok := existingDBFile(); !ok {
log.Fatal("No existing database", "path", path)
}
}
@@ -52,14 +57,14 @@ func getAdminContext(ctx context.Context) (model.DataStore, context.Context) {
}
func getUser(ctx context.Context, id string, ds model.DataStore) (*model.User, error) {
- user, err := ds.User(ctx).FindByUsername(id)
+ user, err := ds.User().FindByUsername(ctx, id)
if err != nil && !errors.Is(err, model.ErrNotFound) {
return nil, fmt.Errorf("finding user by name: %w", err)
}
if errors.Is(err, model.ErrNotFound) {
- user, err = ds.User(ctx).Get(id)
+ user, err = ds.User().Get(ctx, id)
if err != nil {
return nil, fmt.Errorf("finding user by id: %w", err)
}
diff --git a/cmd/wire_gen.go b/cmd/wire_gen.go
index d6bf4da07..2a396689d 100644
--- a/cmd/wire_gen.go
+++ b/cmd/wire_gen.go
@@ -21,6 +21,7 @@ import (
"github.com/navidrome/navidrome/core/metrics"
"github.com/navidrome/navidrome/core/playback"
"github.com/navidrome/navidrome/core/playlists"
+ "github.com/navidrome/navidrome/core/quickconnect"
"github.com/navidrome/navidrome/core/scrobbler"
"github.com/navidrome/navidrome/core/sonic"
"github.com/navidrome/navidrome/core/stream"
@@ -30,6 +31,7 @@ import (
"github.com/navidrome/navidrome/plugins"
"github.com/navidrome/navidrome/scanner"
"github.com/navidrome/navidrome/server"
+ "github.com/navidrome/navidrome/server/apiv1"
"github.com/navidrome/navidrome/server/events"
"github.com/navidrome/navidrome/server/jellyfin"
"github.com/navidrome/navidrome/server/nativeapi"
@@ -79,7 +81,8 @@ func CreateNativeAPIRouter(ctx context.Context) *nativeapi.Router {
agentsAgents := agents.GetAgents(dataStore, manager)
matcherMatcher := matcher.New(dataStore)
provider := external.NewProvider(dataStore, agentsAgents, matcherMatcher, broker)
- router := nativeapi.New(dataStore, share, playlistsPlaylists, insights, library, user, maintenance, manager, uploader, provider)
+ quickConnect := quickconnect.GetInstance()
+ router := nativeapi.New(dataStore, share, playlistsPlaylists, insights, library, user, maintenance, manager, uploader, provider, quickConnect)
return router
}
@@ -92,8 +95,9 @@ func CreateSubsonicAPIRouter(ctx context.Context) *subsonic.Router {
artworkArtwork := artwork.NewArtwork(dataStore, fileCache, imageStore, fFmpeg)
transcodingCache := stream.GetTranscodingCache()
mediaStreamer := stream.NewMediaStreamer(dataStore, fFmpeg, transcodingCache)
+ transcodeDecider := stream.NewTranscodeDecider(dataStore, fFmpeg)
share := core.NewShare(dataStore)
- archiver := core.NewArchiver(mediaStreamer, dataStore, share)
+ archiver := core.NewArchiver(mediaStreamer, transcodeDecider, dataStore, share, artworkArtwork)
players := core.NewPlayers(dataStore)
broker := events.GetBroker()
metricsMetrics := metrics.GetPrometheusInstance(dataStore)
@@ -107,7 +111,6 @@ func CreateSubsonicAPIRouter(ctx context.Context) *subsonic.Router {
playTracker := scrobbler.GetPlayTracker(dataStore, broker, manager)
playbackServer := playback.GetInstance(dataStore)
lyricsLyrics := lyrics.NewLyrics(dataStore, manager)
- transcodeDecider := stream.NewTranscodeDecider(dataStore, fFmpeg)
sonicSonic := sonic.New(dataStore, manager, matcherMatcher)
router := subsonic.New(dataStore, artworkArtwork, mediaStreamer, archiver, players, provider, modelScanner, broker, playlistsPlaylists, playTracker, share, playbackServer, metricsMetrics, lyricsLyrics, transcodeDecider, sonicSonic)
return router
@@ -135,7 +138,15 @@ func CreateJellyfinAPIRouter(ctx context.Context) *jellyfin.Router {
provider := external.NewProvider(dataStore, agentsAgents, matcherMatcher, broker)
sonicSonic := sonic.New(dataStore, manager, matcherMatcher)
lyricsLyrics := lyrics.NewLyrics(dataStore, manager)
- router := jellyfin.New(dataStore, artworkArtwork, mediaStreamer, transcodeDecider, players, playTracker, playlistsPlaylists, provider, sonicSonic, lyricsLyrics, broker)
+ quickConnect := quickconnect.GetInstance()
+ router := jellyfin.New(dataStore, artworkArtwork, mediaStreamer, transcodeDecider, players, playTracker, playlistsPlaylists, provider, sonicSonic, lyricsLyrics, broker, quickConnect)
+ return router
+}
+
+func CreateAPIv1Router(ctx context.Context) *apiv1.Router {
+ sqlDB := db.Db()
+ dataStore := persistence.New(sqlDB)
+ router := apiv1.New(dataStore)
return router
}
@@ -148,9 +159,10 @@ func CreatePublicRouter() *public.Router {
artworkArtwork := artwork.NewArtwork(dataStore, fileCache, imageStore, fFmpeg)
transcodingCache := stream.GetTranscodingCache()
mediaStreamer := stream.NewMediaStreamer(dataStore, fFmpeg, transcodingCache)
+ transcodeDecider := stream.NewTranscodeDecider(dataStore, fFmpeg)
share := core.NewShare(dataStore)
- archiver := core.NewArchiver(mediaStreamer, dataStore, share)
- router := public.New(dataStore, artworkArtwork, mediaStreamer, share, archiver)
+ archiver := core.NewArchiver(mediaStreamer, transcodeDecider, dataStore, share, artworkArtwork)
+ router := public.New(dataStore, artworkArtwork, mediaStreamer, transcodeDecider, share, archiver)
return router
}
@@ -256,7 +268,7 @@ func getPluginManager() *plugins.Manager {
// wire_injectors.go:
-var allProviders = wire.NewSet(core.Set, artwork.Set, server.New, subsonic.New, jellyfin.New, jellyfin.NewDiscovery, nativeapi.New, public.New, persistence.New, lastfm.NewRouter, listenbrainz.NewRouter, events.GetBroker, scanner.GetInstance, scanner.GetWatcher, metrics.GetPrometheusInstance, db.Db, plugins.GetManager, sonic.New, wire.Bind(new(agents.PluginLoader), new(*plugins.Manager)), wire.Bind(new(scrobbler.PluginLoader), new(*plugins.Manager)), wire.Bind(new(lyrics.PluginLoader), new(*plugins.Manager)), wire.Bind(new(sonic.PluginLoader), new(*plugins.Manager)), wire.Bind(new(sonic.Engine), new(*sonic.Sonic)), wire.Bind(new(nativeapi.PluginManager), new(*plugins.Manager)), wire.Bind(new(core.PluginUnloader), new(*plugins.Manager)), wire.Bind(new(plugins.PluginMetricsRecorder), new(metrics.Metrics)), wire.Bind(new(core.Watcher), new(scanner.Watcher)), wire.Bind(new(playlists.ImageUploadService), new(artwork.Uploader)))
+var allProviders = wire.NewSet(core.Set, artwork.Set, server.New, subsonic.New, jellyfin.New, jellyfin.NewDiscovery, apiv1.New, nativeapi.New, public.New, persistence.New, lastfm.NewRouter, listenbrainz.NewRouter, events.GetBroker, scanner.GetInstance, scanner.GetWatcher, metrics.GetPrometheusInstance, db.Db, plugins.GetManager, sonic.New, wire.Bind(new(agents.PluginLoader), new(*plugins.Manager)), wire.Bind(new(scrobbler.PluginLoader), new(*plugins.Manager)), wire.Bind(new(lyrics.PluginLoader), new(*plugins.Manager)), wire.Bind(new(sonic.PluginLoader), new(*plugins.Manager)), wire.Bind(new(sonic.Engine), new(*sonic.Sonic)), wire.Bind(new(nativeapi.PluginManager), new(*plugins.Manager)), wire.Bind(new(core.PluginUnloader), new(*plugins.Manager)), wire.Bind(new(plugins.PluginMetricsRecorder), new(metrics.Metrics)), wire.Bind(new(core.Watcher), new(scanner.Watcher)), wire.Bind(new(playlists.ImageUploadService), new(artwork.Uploader)))
func GetPluginManager(ctx context.Context) *plugins.Manager {
manager := getPluginManager()
diff --git a/cmd/wire_injectors.go b/cmd/wire_injectors.go
index 527617959..c5006e07f 100644
--- a/cmd/wire_injectors.go
+++ b/cmd/wire_injectors.go
@@ -23,6 +23,7 @@ import (
"github.com/navidrome/navidrome/plugins"
"github.com/navidrome/navidrome/scanner"
"github.com/navidrome/navidrome/server"
+ "github.com/navidrome/navidrome/server/apiv1"
"github.com/navidrome/navidrome/server/events"
"github.com/navidrome/navidrome/server/jellyfin"
"github.com/navidrome/navidrome/server/nativeapi"
@@ -37,6 +38,7 @@ var allProviders = wire.NewSet(
subsonic.New,
jellyfin.New,
jellyfin.NewDiscovery,
+ apiv1.New,
nativeapi.New,
public.New,
persistence.New,
@@ -91,6 +93,12 @@ func CreateJellyfinAPIRouter(ctx context.Context) *jellyfin.Router {
))
}
+func CreateAPIv1Router(ctx context.Context) *apiv1.Router {
+ panic(wire.Build(
+ allProviders,
+ ))
+}
+
func CreatePublicRouter() *public.Router {
panic(wire.Build(
allProviders,
diff --git a/conf/configuration.go b/conf/configuration.go
index 4812f2515..efa9cbf9a 100644
--- a/conf/configuration.go
+++ b/conf/configuration.go
@@ -161,6 +161,7 @@ type configOptions struct {
DevExternalArtistFetchMultiplier float64
DevPreserveUnicodeInExternalCalls bool
DevEnableMediaFileProbe bool
+ DevAPIv1 bool
}
type scannerOptions struct {
@@ -236,6 +237,7 @@ type jellyfinOptions struct {
// GET /Users/Public, so Jellyfin clients can show a login user-picker. Empty exposes no users.
ExposedPublicUsers string
AutoDiscovery bool
+ QuickConnect bool
// MaxConcurrentStreams bounds how many collection responses can stream at once. Each holds a DB
// cursor — and its pooled connection — for the whole client-paced response, so without a bound
// enough slow clients would take the entire pool and stall the scanner, scrobbles and the UI.
@@ -513,6 +515,11 @@ func Load(noConfigDump bool) {
Server.UICoverArtSize = newValue
}
+ if Server.Scanner.Extractor != consts.DefaultScannerExtractor {
+ log.Warn("Invalid Scanner.Extractor, using default", "value", Server.Scanner.Extractor, "default", consts.DefaultScannerExtractor)
+ Server.Scanner.Extractor = consts.DefaultScannerExtractor
+ }
+
// Floor MaxImageSize at MaxImageUploadSize so accepted uploads can always be read back.
imgSize, _ := humanize.ParseBytes(Server.MaxImageSize)
uploadSize, _ := humanize.ParseBytes(Server.MaxImageUploadSize)
@@ -1089,6 +1096,7 @@ func setViperDefaults() {
viper.SetDefault("jellyfin.enabled", false)
viper.SetDefault("jellyfin.servername", "")
viper.SetDefault("jellyfin.autodiscovery", false)
+ viper.SetDefault("jellyfin.quickconnect", true)
viper.SetDefault("enablescrobblehistory", true)
viper.SetDefault("httpheaders.frameoptions", "DENY")
viper.SetDefault("backup.path", "")
@@ -1117,6 +1125,7 @@ func setViperDefaults() {
viper.SetDefault("devshowartistpage", true)
viper.SetDefault("devuishowconfig", true)
viper.SetDefault("devneweventstream", true)
+ viper.SetDefault("devapiv1", false)
viper.SetDefault("devoffsetoptimize", 50000)
// Half the pool: streams may take up to this many connections, leaving the rest for the scanner,
// scrobbles and the UI. See MaxOpenConns.
diff --git a/conf/configuration_test.go b/conf/configuration_test.go
index 9404f01bc..8c4c8ab86 100644
--- a/conf/configuration_test.go
+++ b/conf/configuration_test.go
@@ -402,6 +402,27 @@ var _ = Describe("Configuration", func() {
})
})
+ Describe("Scanner.Extractor", func() {
+ BeforeEach(func() {
+ viper.Reset()
+ conf.SetViperDefaults()
+ viper.SetDefault("datafolder", GinkgoT().TempDir())
+ viper.SetDefault("loglevel", "error")
+ conf.ResetConf()
+ })
+
+ It("falls back to taglib for an unknown extractor", func() {
+ viper.SetDefault("scanner.extractor", "ffmpeg")
+ conf.Load(true)
+ Expect(conf.Server.Scanner.Extractor).To(Equal("taglib"))
+ })
+
+ It("keeps taglib", func() {
+ conf.Load(true)
+ Expect(conf.Server.Scanner.Extractor).To(Equal("taglib"))
+ })
+ })
+
Describe("EnforceNonRootUser", func() {
It("defaults to false", func() {
conf.Load(true)
diff --git a/consts/consts.go b/consts/consts.go
index f6be9315c..42e9ec42f 100644
--- a/consts/consts.go
+++ b/consts/consts.go
@@ -49,6 +49,7 @@ const (
DefaultEncryptionKey = "just for obfuscation"
PasswordsEncryptedKey = "PasswordsEncryptedKey"
PasswordAutogenPrefix = "__NAVIDROME_AUTOGEN__" //nolint:gosec
+ APIKeyPrefix = "nds_"
DevInitialUserName = "admin"
DevInitialName = "Dev Admin"
@@ -59,6 +60,7 @@ const (
URLPathPublic = "/share"
URLPathPublicImages = URLPathPublic + "/img"
URLPathJellyfinAPI = "/jellyfin"
+ URLPathAPIv1 = "/api/v1"
// JellyfinServerIDKey is the Property key for the stable, persisted server Id reported by the
// Jellyfin API. Jellyfin clients cache this value, so it must survive process restarts.
@@ -88,7 +90,6 @@ const (
I18nFolder = "i18n"
ScanIgnoreFile = ".ndignore"
- NoMediaFile = ".nomedia"
ArtworkFolder = "artwork"
// HashedArtworkFolder is a subtree of ArtworkFolder, kept apart from the name-addressed
// upload folders beside it so Prune's sweep never reaches them.
@@ -155,8 +156,6 @@ const (
//DefaultAlbumPID = "album_legacy"
DefaultAlbumPID = "musicbrainz_albumid|albumartistid,album,albumversion,releasedate"
DefaultTrackPID = "musicbrainz_trackid|albumid,discnumber,tracknumber,title"
- PIDAlbumKey = "PIDAlbum"
- PIDTrackKey = "PIDTrack"
)
const (
diff --git a/contrib/navidrome.service b/contrib/navidrome.service
index 5e6cbedce..ef61d2c65 100644
--- a/contrib/navidrome.service
+++ b/contrib/navidrome.service
@@ -36,7 +36,7 @@ RestrictNamespaces=yes
RestrictRealtime=yes
SystemCallFilter=@system-service
SystemCallFilter=~@privileged @resources
-SystemCallFilter=setrlimit
+SystemCallFilter=setrlimit mbind
SystemCallArchitectures=native
UMask=0066
diff --git a/core/agents/local_agent.go b/core/agents/local_agent.go
index 1cb9060a1..c777ab46d 100644
--- a/core/agents/local_agent.go
+++ b/core/agents/local_agent.go
@@ -24,7 +24,7 @@ func (p *localAgent) AgentName() string {
}
func (p *localAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid string, count int) ([]Song, error) {
- top, err := p.ds.MediaFile(ctx).GetAll(model.QueryOptions{
+ top, err := p.ds.MediaFile().GetAll(ctx, model.QueryOptions{
Sort: "playCount",
Order: "desc",
Max: count,
@@ -43,7 +43,7 @@ func (p *localAgent) GetArtistTopSongs(ctx context.Context, id, artistName, mbid
}
func (p *localAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, artist, mbid string, count int) ([]Song, error) {
- seed, err := p.ds.MediaFile(ctx).Get(id)
+ seed, err := p.ds.MediaFile().Get(ctx, id)
if err != nil {
return nil, err
}
@@ -53,7 +53,7 @@ func (p *localAgent) GetSimilarSongsByTrack(ctx context.Context, id, name, artis
return nil, nil
}
// Ask for extra so we can drop the seed itself and still fill the count.
- candidates, err := p.ds.MediaFile(ctx).GetRandom(model.QueryOptions{
+ candidates, err := p.ds.MediaFile().GetRandom(ctx, model.QueryOptions{
Filters: squirrel.And{
persistence.SongGenres.ByID(genreIDs),
squirrel.Eq{"missing": false},
diff --git a/core/agents/session_keys.go b/core/agents/session_keys.go
index cea6005ff..1eb414b15 100644
--- a/core/agents/session_keys.go
+++ b/core/agents/session_keys.go
@@ -13,13 +13,13 @@ type SessionKeys struct {
}
func (sk *SessionKeys) Put(ctx context.Context, userId, sessionKey string) error {
- return sk.DataStore.UserProps(ctx).Put(userId, sk.KeyName, sessionKey)
+ return sk.DataStore.UserProps().Put(ctx, userId, sk.KeyName, sessionKey)
}
func (sk *SessionKeys) Get(ctx context.Context, userId string) (string, error) {
- return sk.DataStore.UserProps(ctx).Get(userId, sk.KeyName)
+ return sk.DataStore.UserProps().Get(ctx, userId, sk.KeyName)
}
func (sk *SessionKeys) Delete(ctx context.Context, userId string) error {
- return sk.DataStore.UserProps(ctx).Delete(userId, sk.KeyName)
+ return sk.DataStore.UserProps().Delete(ctx, userId, sk.KeyName)
}
diff --git a/core/archiver.go b/core/archiver.go
index c9436279e..60eb44858 100644
--- a/core/archiver.go
+++ b/core/archiver.go
@@ -2,23 +2,32 @@ package core
import (
"archive/zip"
+ "cmp"
"context"
"errors"
"fmt"
"io"
+ "net/http"
"os"
+ "path"
"path/filepath"
+ "strconv"
"strings"
+ "time"
"github.com/Masterminds/squirrel"
+ "github.com/navidrome/navidrome/core/artwork"
"github.com/navidrome/navidrome/core/stream"
"github.com/navidrome/navidrome/log"
"github.com/navidrome/navidrome/model"
+ "github.com/navidrome/navidrome/model/request"
"github.com/navidrome/navidrome/persistence"
"github.com/navidrome/navidrome/utils/slice"
"github.com/navidrome/navidrome/utils/str"
)
+const archiveCoverArtSize = 500
+
type Archiver interface {
ZipAlbum(ctx context.Context, id string, format string, bitrate int, w io.Writer) error
ZipArtist(ctx context.Context, id string, format string, bitrate int, w io.Writer) error
@@ -26,18 +35,20 @@ type Archiver interface {
ZipPlaylist(ctx context.Context, id string, format string, bitrate int, w io.Writer) error
}
-func NewArchiver(ms stream.MediaStreamer, ds model.DataStore, shares Share) Archiver {
- return &archiver{ds: ds, ms: ms, shares: shares}
+func NewArchiver(ms stream.MediaStreamer, decider stream.TranscodeDecider, ds model.DataStore, shares Share, artwork artwork.Artwork) Archiver {
+ return &archiver{ds: ds, ms: ms, decider: decider, shares: shares, artwork: artwork}
}
type archiver struct {
- ds model.DataStore
- ms stream.MediaStreamer
- shares Share
+ ds model.DataStore
+ ms stream.MediaStreamer
+ decider stream.TranscodeDecider
+ shares Share
+ artwork artwork.Artwork
}
func (a *archiver) ZipAlbum(ctx context.Context, id string, format string, bitrate int, out io.Writer) error {
- return a.zipAlbums(ctx, id, format, bitrate, out, squirrel.Eq{"album_id": id})
+ return a.zipAlbums(ctx, id, format, bitrate, out, squirrel.Eq{"album_id": id}, model.ArtworkID{})
}
func (a *archiver) ZipArtist(ctx context.Context, id string, format string, bitrate int, out io.Writer) error {
@@ -47,28 +58,30 @@ func (a *archiver) ZipArtist(ctx context.Context, id string, format string, bitr
persistence.ParticipantIDFilter("media_file", id, model.RoleAlbumArtist),
squirrel.Eq{"missing": false},
}
- return a.zipAlbums(ctx, id, format, bitrate, out, filter)
+ return a.zipAlbums(ctx, id, format, bitrate, out, filter, model.Artist{ID: id}.CoverArtID())
}
-func (a *archiver) zipAlbums(ctx context.Context, id string, format string, bitrate int, out io.Writer, filters squirrel.Sqlizer) error {
- mfs, err := a.ds.MediaFile(ctx).GetAll(model.QueryOptions{Filters: filters, Sort: "album"})
+// rootArt, when set, is added to the archive root.
+func (a *archiver) zipAlbums(ctx context.Context, id string, format string, bitrate int, out io.Writer, filters squirrel.Sqlizer, rootArt model.ArtworkID) error {
+ mfs, err := a.ds.MediaFile().GetAll(ctx, model.QueryOptions{Filters: filters, Sort: "album"})
if err != nil {
log.Error(ctx, "Error loading mediafiles from artist", "id", id, err)
return err
}
z := createZipWriter(out, format, bitrate)
- albums := slice.Group(mfs, func(mf model.MediaFile) string {
- return mf.AlbumID
- })
+ albums := slice.GroupOrdered(mfs, func(mf model.MediaFile) string { return mf.AlbumID })
+ folders := albumFolders(albums)
for _, album := range albums {
discs := slice.Group(album, func(mf model.MediaFile) int { return mf.DiscNumber })
isMultiDisc := len(discs) > 1
- log.Debug(ctx, "Zipping album", "name", album[0].Album, "artist", album[0].AlbumArtist,
+ folder := folders[album[0].AlbumID]
+ log.Debug(ctx, "Zipping album", "name", album[0].Album, "artist", album[0].AlbumArtist, "folder", folder,
"format", format, "bitrate", bitrate, "isMultiDisc", isMultiDisc, "numTracks", len(album))
for _, mf := range album {
- file := a.albumFilename(mf, format, isMultiDisc)
- if addErr := a.addFileToZip(ctx, z, mf, format, bitrate, file); errors.Is(addErr, stream.ErrTooManyTranscodes) {
+ req := a.resolveRequest(ctx, &mf, format, bitrate)
+ file := a.albumFilename(mf, req.Format, isMultiDisc, folder)
+ if addErr := a.addFileToZip(ctx, z, mf, req, file); errors.Is(addErr, stream.ErrTooManyTranscodes) {
// Stop iterating: continuing would just rack up more
// rejections from the limiter. Close finalises whatever
// tracks were already written; the rejected one is not
@@ -78,7 +91,10 @@ func (a *archiver) zipAlbums(ctx context.Context, id string, format string, bitr
return addErr
}
}
+ // After the tracks, so a slow artwork lookup doesn't delay the first bytes.
+ a.addCoverArtToZip(ctx, z, album[0].AlbumCoverArtID(), folder)
}
+ a.addCoverArtToZip(ctx, z, rootArt, "")
err = z.Close()
if err != nil {
log.Error(ctx, "Error closing zip file", "id", id, err)
@@ -96,7 +112,61 @@ func createZipWriter(out io.Writer, format string, bitrate int) *zip.Writer {
return z
}
-func (a *archiver) albumFilename(mf model.MediaFile, format string, isMultiDisc bool) string {
+// Tried in order; the first one whose values are distinct across the clashing albums wins.
+// One album may have an empty value: it keeps the plain name, which the others can't clash with.
+var albumDisambiguators = []func(model.MediaFile) string{
+ func(mf model.MediaFile) string { return mf.Tags.First(model.TagAlbumVersion) },
+ func(mf model.MediaFile) string {
+ // Reissues share Year (often the original's) but not ReleaseYear.
+ if y := cmp.Or(mf.ReleaseYear, mf.Year); y != 0 {
+ return strconv.Itoa(y)
+ }
+ return ""
+ },
+ func(mf model.MediaFile) string { return mf.MbzAlbumType },
+ func(mf model.MediaFile) string { return mf.Tags.First(model.TagRecordLabel) },
+ func(mf model.MediaFile) string { return mf.CatalogNum },
+ func(mf model.MediaFile) string { return mf.AlbumID[:min(6, len(mf.AlbumID))] },
+ func(mf model.MediaFile) string { return mf.AlbumID },
+}
+
+// albumFolders maps each album id to its zip folder. Albums whose names sanitize to the
+// same folder get a " [suffix]" from the first disambiguator that tells them all apart.
+func albumFolders(albums [][]model.MediaFile) map[string]string {
+ byName := map[string][]model.MediaFile{}
+ for _, album := range albums {
+ name := str.SanitizeFilename(album[0].FullAlbumName())
+ byName[name] = append(byName[name], album[0])
+ }
+ folders := make(map[string]string, len(albums))
+ for name, group := range byName {
+ if len(group) == 1 {
+ folders[group[0].AlbumID] = name
+ continue
+ }
+ fields:
+ for _, field := range albumDisambiguators {
+ ids := make(map[string]string, len(group)) // suffix -> album id
+ for _, mf := range group {
+ s := str.SanitizeFilename(field(mf))
+ if _, dup := ids[s]; dup {
+ continue fields
+ }
+ ids[s] = mf.AlbumID
+ }
+ for s, id := range ids {
+ folders[id] = name
+ if s != "" {
+ folders[id] = fmt.Sprintf("%s [%s]", name, s)
+ }
+ }
+ break
+ }
+ }
+ return folders
+}
+
+func (a *archiver) albumFilename(mf model.MediaFile, format string, isMultiDisc bool, folder string) string {
_, file := filepath.Split(mf.Path)
if format != "raw" {
file = strings.TrimSuffix(file, mf.Suffix) + format
@@ -104,7 +174,7 @@ func (a *archiver) albumFilename(mf model.MediaFile, format string, isMultiDisc
if isMultiDisc {
file = fmt.Sprintf("Disc %02d/%s", mf.DiscNumber, file)
}
- return fmt.Sprintf("%s/%s", str.SanitizeFilename(mf.Album), file)
+ return fmt.Sprintf("%s/%s", folder, file)
}
// ZipShare takes an already-loaded share: Share.Load records a visit, so
@@ -114,27 +184,31 @@ func (a *archiver) ZipShare(ctx context.Context, s *model.Share, out io.Writer)
return model.ErrNotAuthorized
}
log.Debug(ctx, "Zipping share", "name", s.ID, "format", s.Format, "bitrate", s.MaxBitRate, "numTracks", len(s.Tracks))
- return a.zipMediaFiles(ctx, s.ID, s.ID, s.Format, s.MaxBitRate, out, s.Tracks, false)
+ // The share is the authorization (as in the public image handler): an anonymous lookup would
+ // hide a private playlist. Only the cover read is elevated.
+ coverCtx := request.WithUser(ctx, model.User{IsAdmin: true})
+ return a.zipMediaFiles(ctx, s.ID, s.ID, s.Format, s.MaxBitRate, out, s.Tracks, coverCtx, s.CoverArtID(), false)
}
func (a *archiver) ZipPlaylist(ctx context.Context, id string, format string, bitrate int, out io.Writer) error {
- pls, err := a.ds.Playlist(ctx).GetWithTracks(id, true, false)
+ pls, err := a.ds.Playlist().GetWithTracks(ctx, id, true, false)
if err != nil {
log.Error(ctx, "Error loading mediafiles from playlist", "id", id, err)
return err
}
mfs := pls.MediaFiles()
log.Debug(ctx, "Zipping playlist", "name", pls.Name, "format", format, "bitrate", bitrate, "numTracks", len(mfs))
- return a.zipMediaFiles(ctx, id, pls.Name, format, bitrate, out, mfs, true)
+ return a.zipMediaFiles(ctx, id, pls.Name, format, bitrate, out, mfs, ctx, pls.CoverArtID(), true)
}
-func (a *archiver) zipMediaFiles(ctx context.Context, id, name string, format string, bitrate int, out io.Writer, mfs model.MediaFiles, addM3U bool) error {
+func (a *archiver) zipMediaFiles(ctx context.Context, id, name string, format string, bitrate int, out io.Writer, mfs model.MediaFiles, coverCtx context.Context, coverArt model.ArtworkID, addM3U bool) error {
z := createZipWriter(out, format, bitrate)
zippedMfs := make(model.MediaFiles, len(mfs))
for idx, mf := range mfs {
- file := a.playlistFilename(mf, format, idx)
- if addErr := a.addFileToZip(ctx, z, mf, format, bitrate, file); errors.Is(addErr, stream.ErrTooManyTranscodes) {
+ req := a.resolveRequest(ctx, &mf, format, bitrate)
+ file := a.playlistFilename(mf, req.Format, idx)
+ if addErr := a.addFileToZip(ctx, z, mf, req, file); errors.Is(addErr, stream.ErrTooManyTranscodes) {
// Abort the whole archive: continuing would silently emit
// empty zip entries since the headers are already written.
_ = z.Close()
@@ -143,6 +217,7 @@ func (a *archiver) zipMediaFiles(ctx context.Context, id, name string, format st
mf.Path = file
zippedMfs[idx] = mf
}
+ a.addCoverArtToZip(coverCtx, z, coverArt, "")
// Add M3U file if requested
if addM3U && len(zippedMfs) > 0 {
@@ -179,7 +254,14 @@ func (a *archiver) playlistFilename(mf model.MediaFile, format string, idx int)
return fmt.Sprintf("%02d - %s - %s.%s", idx+1, str.SanitizeFilename(mf.Artist), str.SanitizeFilename(mf.Title), ext)
}
-func (a *archiver) addFileToZip(ctx context.Context, z *zip.Writer, mf model.MediaFile, format string, bitrate int, filename string) error {
+func (a *archiver) resolveRequest(ctx context.Context, mf *model.MediaFile, format string, bitrate int) stream.Request {
+ if format == "" || format == "raw" {
+ return stream.Request{Format: "raw"}
+ }
+ return a.decider.ResolveRequest(ctx, mf, format, bitrate, 0)
+}
+
+func (a *archiver) addFileToZip(ctx context.Context, z *zip.Writer, mf model.MediaFile, req stream.Request, filename string) error {
path := mf.AbsolutePath()
// Open the source before writing the zip entry header so a rejection
@@ -187,13 +269,13 @@ func (a *archiver) addFileToZip(ctx context.Context, z *zip.Writer, mf model.Med
// archive.
var r io.ReadCloser
var err error
- if format != "raw" && format != "" {
- r, err = a.ms.NewStream(ctx, &mf, stream.Request{Format: format, BitRate: bitrate})
+ if req.Format != "raw" {
+ r, err = a.ms.NewStream(ctx, &mf, req)
} else {
r, err = os.Open(path)
}
if err != nil {
- log.Error(ctx, "Error opening file for zipping", "file", path, "format", format, err)
+ log.Error(ctx, "Error opening file for zipping", "file", path, "format", req.Format, err)
return err
}
defer func() {
@@ -220,3 +302,61 @@ func (a *archiver) addFileToZip(ctx context.Context, z *zip.Writer, mf model.Med
return nil
}
+
+// addCoverArtToZip adds the cover as dir/folder.
+