mirror of
https://github.com/navidrome/navidrome.git
synced 2026-10-08 18:37:09 +02:00
* refactor(persistence): adopt generic deluan/rest repository API Pin deluan/rest to the refactor branch. REST-facing repository methods take a context and return typed values. Drop DataStore.Resource and ResourceRepository; the native API names typed repositories directly through a per-request adapter that later commits remove. * refactor(persistence): base repository helpers take a context * refactor(persistence): LibraryRepository takes a context per call * refactor(persistence): PropertyRepository takes a context per call * refactor(persistence): UserPropsRepository takes a context per call * refactor(persistence): TranscodingRepository takes a context per call * refactor(persistence): ShareRepository takes a context per call * refactor(persistence): PlayerRepository takes a context per call * refactor(persistence): RadioRepository takes a context per call * refactor(persistence): PlayQueueRepository takes a context per call * refactor(persistence): Tag and Genre repositories take a context per call * refactor(persistence): PluginRepository takes a context per call * refactor(persistence): Scrobble repositories take a context per call * refactor(persistence): FolderRepository takes a context per call * refactor(persistence): Artwork repositories take a context per call * refactor(persistence): UserRepository takes a context per call * refactor(persistence): ArtistRepository takes a context per call ReadAll no longer rewrites the shared sort mappings for the role filter; it works on a per-call copy. * test(persistence): assert artist role sort sanitization in ReadAll * refactor(persistence): AlbumRepository takes a context per call * test(persistence): pass the test context to album repository helpers * refactor(persistence): MediaFileRepository takes a context per call * refactor(persistence): Playlist repositories take a context per call * refactor(persistence): build all repositories once per store * refactor(core): REST repository wrappers are built once * refactor(persistence): repositories are stateless Remove the context field from the base repository and the per-request REST adapter. Enable the containedctx linter so no repository can hold a request context again. * chore(lint): skip containedctx in test files * refactor: share simplifications from the stateless repositories sweep Add deleteOwnedAll on sqlRepository and use it in player/share Delete to remove the duplicated bulk-delete loop; have Share.Repository() return model.ShareRepository so subsonic sharing.go drops its repeated type assertions. * chore(core): assert REST wrappers implement Persistable * chore: reformat imports * perf(persistence): build repositories on first use Each transaction store used to construct all 21 repositories up front, paying for filter and sort mapping setup the block never touched. Fields are now sync.OnceValue thunks, so a store only builds what it uses. * fix(persistence): clean plugin references per deleted user A bulk user delete that fails on a later id had already removed the earlier rows but skipped their plugin cleanup. Cleanup now runs right after each successful delete. * fix(core): unload disabled plugins even when a user delete fails A bulk delete can fail on a later id after earlier users were removed and their plugins auto-disabled. The wrapper returned before unloading, leaving those plugins running until the next successful delete or a restart. * chore(deps): pin deluan/rest to v1.0.1 Replaces the pseudo-version of the refactor branch with the tagged release. REST error messages now name the bare type (Artist, not model.Artist). * test: use the spec context instead of context.Background() Replace the context.Background()/context.TODO() calls this branch added to tests with the spec's ctx, GinkgoT().Context(), or t/b.Context(), so repository calls are bound to the running spec's lifetime. * test: declare the spec context once per Describe Set ctx from GinkgoT().Context() first in each top-level BeforeEach and reuse it, building user contexts on top of it instead of repeating inline calls.
155 lines
4.9 KiB
Go
155 lines
4.9 KiB
Go
package plugins
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/httptest"
|
|
"net/url"
|
|
"path"
|
|
|
|
"github.com/navidrome/navidrome/log"
|
|
"github.com/navidrome/navidrome/model"
|
|
"github.com/navidrome/navidrome/model/request"
|
|
"github.com/navidrome/navidrome/plugins/host"
|
|
)
|
|
|
|
// subsonicAPIVersion is the Subsonic API version used for plugin calls.
|
|
// This is defined locally to avoid import cycle with server/subsonic.
|
|
const subsonicAPIVersion = "1.16.1"
|
|
|
|
// subsonicAPIServiceImpl implements host.SubsonicAPIService.
|
|
// It provides plugins with access to Navidrome's Subsonic API.
|
|
//
|
|
// Authentication: The plugin must provide a valid 'u' (username) parameter in the URL.
|
|
// URL Format: Only the path and query parameters are used - host/protocol are ignored.
|
|
// Automatic Parameters: The service adds 'c' (client), 'v' (version), and optionally 'f' (format).
|
|
type subsonicAPIServiceImpl struct {
|
|
pluginID string
|
|
router SubsonicRouter
|
|
ds model.DataStore
|
|
users userAccess // users this plugin may act as (from DB configuration)
|
|
}
|
|
|
|
// newSubsonicAPIService creates a new SubsonicAPIService for a plugin.
|
|
func newSubsonicAPIService(pluginID string, router SubsonicRouter, ds model.DataStore, users userAccess) host.SubsonicAPIService {
|
|
return &subsonicAPIServiceImpl{
|
|
pluginID: pluginID,
|
|
router: router,
|
|
ds: ds,
|
|
users: users,
|
|
}
|
|
}
|
|
|
|
// executeRequest handles URL parsing, validation, permission checks, HTTP request creation,
|
|
// and router invocation. Shared between Call and CallRaw.
|
|
// If setJSON is true, the 'f=json' query parameter is added.
|
|
func (s *subsonicAPIServiceImpl) executeRequest(ctx context.Context, uri string, setJSON bool) (*httptest.ResponseRecorder, error) {
|
|
if s.router == nil {
|
|
return nil, fmt.Errorf("SubsonicAPI router not available")
|
|
}
|
|
|
|
// Parse the input URL
|
|
parsedURL, err := url.Parse(uri)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("invalid URL format: %w", err)
|
|
}
|
|
|
|
// Extract query parameters
|
|
query := parsedURL.Query()
|
|
|
|
// Validate that 'u' (username) parameter is present
|
|
username := query.Get("u")
|
|
if username == "" {
|
|
return nil, fmt.Errorf("missing required parameter 'u' (username)")
|
|
}
|
|
|
|
if err := s.checkPermissions(ctx, username); err != nil {
|
|
log.Warn(ctx, "SubsonicAPI call blocked by permissions", "plugin", s.pluginID, "user", username, err)
|
|
return nil, err
|
|
}
|
|
|
|
// Add required Subsonic API parameters
|
|
query.Set("c", s.pluginID) // Client name (plugin ID)
|
|
query.Set("v", subsonicAPIVersion) // API version
|
|
if setJSON {
|
|
query.Set("f", "json") // Response format
|
|
}
|
|
|
|
// Extract the endpoint from the path
|
|
endpoint := path.Base(parsedURL.Path)
|
|
|
|
// Build the final URL with processed path and modified query parameters
|
|
finalURL := &url.URL{
|
|
Path: "/" + endpoint,
|
|
RawQuery: query.Encode(),
|
|
}
|
|
|
|
// Create HTTP request with a fresh context to avoid Chi RouteContext pollution.
|
|
// Using http.NewRequest (instead of http.NewRequestWithContext) ensures the internal
|
|
// SubsonicAPI call doesn't inherit routing information from the parent handler,
|
|
// which would cause Chi to invoke the wrong handler. Authentication context is
|
|
// explicitly added in the next step via request.WithInternalAuth.
|
|
httpReq, err := http.NewRequest("GET", finalURL.String(), nil)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to create HTTP request: %w", err)
|
|
}
|
|
|
|
// Set internal authentication context using the username from the 'u' parameter
|
|
authCtx := request.WithInternalAuth(httpReq.Context(), username)
|
|
httpReq = httpReq.WithContext(authCtx)
|
|
|
|
// Use ResponseRecorder to capture the response
|
|
recorder := httptest.NewRecorder()
|
|
|
|
// Call the subsonic router
|
|
s.router.ServeHTTP(recorder, httpReq)
|
|
|
|
return recorder, nil
|
|
}
|
|
|
|
func (s *subsonicAPIServiceImpl) Call(ctx context.Context, uri string) (string, error) {
|
|
recorder, err := s.executeRequest(ctx, uri, true)
|
|
if err != nil {
|
|
return "", err
|
|
}
|
|
return recorder.Body.String(), nil
|
|
}
|
|
|
|
func (s *subsonicAPIServiceImpl) CallRaw(ctx context.Context, uri string) (string, []byte, error) {
|
|
recorder, err := s.executeRequest(ctx, uri, false)
|
|
if err != nil {
|
|
return "", nil, err
|
|
}
|
|
contentType := recorder.Header().Get("Content-Type")
|
|
return contentType, recorder.Body.Bytes(), nil
|
|
}
|
|
|
|
func (s *subsonicAPIServiceImpl) checkPermissions(ctx context.Context, username string) error {
|
|
// If allUsers is true, allow any user
|
|
if s.users.allUsers {
|
|
return nil
|
|
}
|
|
|
|
// Must have at least one allowed user ID configured
|
|
if len(s.users.userIDSet) == 0 {
|
|
return fmt.Errorf("no users configured for plugin %s", s.pluginID)
|
|
}
|
|
|
|
// Look up the user by username to get their ID
|
|
usr, err := s.ds.User().FindByUsername(ctx, username)
|
|
if err != nil {
|
|
if errors.Is(err, model.ErrNotFound) {
|
|
return fmt.Errorf("username %s not found", username)
|
|
}
|
|
return err
|
|
}
|
|
|
|
// Check if the user's ID is in the allowed list
|
|
if !s.users.allows(usr.ID) {
|
|
return fmt.Errorf("user %s is not authorized for this plugin", username)
|
|
}
|
|
|
|
return nil
|
|
}
|