Files
musicseerr/backend/repositories/lidarr/artist.py
T
shaunrd0 23c9125ad8
Backend CI / Lint (push) Waiting to run
Backend CI / Tests (push) Waiting to run
Personal fork of habirabbu/musicseerr — multi-instance + inline downloads + lidarr-request
Squashes 26 incremental fork commits (Apr–May 2026) onto upstream main as a single
diff for cleaner cross-fork comparison. Original history preserved on the
pre-squash-backup tag locally.

Feature additions
─────────────────

• Inline single-track download via yt-dlp-worker proxy
  New routes: POST /api/v1/track-download/search (source: youtube | spotify),
  POST /api/v1/track-download, GET /api/v1/track-download/{id}. Frontend
  TrackDownloadButton in album track list AND popular-songs row, with a per-button
  source picker. Per-user rate limits live in the worker's SQLite store. On
  completion the backend fires Lidarr RefreshArtist + Plex library refresh +
  cache invalidation, and the popular-songs list auto-refreshes.

• Per-instance library pinning via MUSICSEERR_LIBRARY env
  Backend stamps the library label server-side (music / music-personal /
  music-shared); clients cannot override. Drives an instance-segregated
  deployment of three musicseerr containers sharing one source tree.

• Lidarr-request flow (single-track requests via Lidarr indexers)
  New routes: POST /api/v1/lidarr-request, GET /api/v1/lidarr-request/status.
  Per-album asyncio.Lock keyed on album_mbid so rapid-clicks on the same album
  serialize correctly. Cross-release track matcher with foreignTrackId →
  foreignRecordingId → position+disc → exact-title → substring fallback chain,
  evaluated per release (recording UUIDs frequently differ between album,
  single, and deluxe edition releases of the same song). Flips
  artist.monitored = True on request so Lidarr's WantedAlbums query reaches
  the track. Full Lidarr-chain gate (artist AND album AND track) for the
  status endpoint to avoid false-positive REQUESTED display. Persistent UI
  state so button icons survive refresh and cross-album navigation.

• Privacy: show_now_playing toggle in Settings → Home
  Default off. Plex /status/sessions returns active audio sessions across the
  whole server with no library-section filter, so a shared instance leaks
  every household member's listening activity. The merged store still emits
  the user's local MusicSeerr playback bar; only server-derived sessions
  (Plex / Jellyfin / Navidrome) are gated.

• Per-button visibility prefs for the track-row action cluster
  Settings → Preferences → Download Options / Playback Buttons. Per-context
  (popular_songs / album_page) force-off flags layered on top of the existing
  source-availability gate.

• UX: wrap action cluster on mobile, hide LidarrRequestButton in tight
  layouts, cross-album status-leak fix in AlbumTrackList ($effect keyed on
  album.musicbrainz_id to rebuild lookup; map keyed by
  "{albumMbid}:{position}:{disc}").

Test coverage
─────────────

Backend pytest: full suite green (2031/2031 as of squash). New: schema-default
tests for HomeSettings, lidarr_request_service cross-release matcher
regression test, singleton-registry expected-count bump to 59. Frontend
vitest: SettingsHome.svelte.spec covers new toggle, nowPlayingSessions
.svelte.spec covers the privacy gate (no fetch when off; fetches when on).
2026-05-29 23:55:54 +00:00

327 lines
13 KiB
Python

import asyncio
import logging
from typing import Any, Optional
from core.exceptions import ExternalServiceError
from infrastructure.cover_urls import prefer_release_group_cover_url
from infrastructure.cache.cache_keys import (
LIDARR_ARTIST_IMAGE_PREFIX, LIDARR_ARTIST_DETAILS_PREFIX, LIDARR_ARTIST_ALBUMS_PREFIX,
)
from .base import LidarrBase
logger = logging.getLogger(__name__)
class LidarrArtistRepository(LidarrBase):
async def get_artist_image_url(self, artist_mbid: str, size: Optional[int] = 250) -> Optional[str]:
cache_key = f"{LIDARR_ARTIST_IMAGE_PREFIX}{artist_mbid}:{size or 'orig'}"
cached_url = await self._cache.get(cache_key)
if cached_url is not None:
return cached_url if cached_url else None
try:
data = await self._get("/api/v1/artist", params={"mbId": artist_mbid})
if not data or not isinstance(data, list) or len(data) == 0:
await self._cache.set(cache_key, "", ttl_seconds=300)
return None
artist = data[0]
artist_id = artist.get("id")
artist_name = artist.get("artistName", "Unknown")
images = artist.get("images", [])
if not artist_id or not images:
await self._cache.set(cache_key, "", ttl_seconds=300)
return None
poster_url = None
fanart_url = None
for img in images:
cover_type = img.get("coverType", "").lower()
url_path = img.get("url", "")
if not url_path:
continue
if url_path.startswith("http"):
constructed_url = url_path
else:
constructed_url = self._build_api_media_cover_url(artist_id, url_path, size)
if cover_type == "poster":
poster_url = constructed_url
break
elif cover_type == "fanart" and not fanart_url:
fanart_url = constructed_url
image_url = poster_url or fanart_url
if image_url:
await self._cache.set(cache_key, image_url, ttl_seconds=3600)
return image_url
logger.info(f"[Lidarr:Image] No poster/fanart for {artist_mbid[:8]} ({artist_name})")
await self._cache.set(cache_key, "", ttl_seconds=300)
return None
except Exception as e: # noqa: BLE001
return None
async def get_artist_details(self, artist_mbid: str) -> Optional[dict[str, Any]]:
cache_key = f"{LIDARR_ARTIST_DETAILS_PREFIX}{artist_mbid}"
cached = await self._cache.get(cache_key)
if cached is not None:
return cached if cached else None
try:
data = await self._get("/api/v1/artist", params={"mbId": artist_mbid})
if not data or not isinstance(data, list) or len(data) == 0:
await self._cache.set(cache_key, "", ttl_seconds=300)
return None
artist = data[0]
artist_id = artist.get("id")
image_urls = self._get_artist_image_urls(artist.get("images", []), artist_id)
links = []
for link in artist.get("links", []):
link_name = link.get("name", "")
link_url = link.get("url", "")
if link_url:
links.append({"name": link_name, "url": link_url})
result = {
"id": artist_id,
"name": artist.get("artistName", "Unknown"),
"mbid": artist.get("foreignArtistId"),
"overview": artist.get("overview"),
"disambiguation": artist.get("disambiguation"),
"artist_type": artist.get("artistType"),
"status": artist.get("status"),
"genres": artist.get("genres", []),
"links": links,
"poster_url": image_urls["poster"],
"fanart_url": image_urls["fanart"],
"banner_url": image_urls["banner"],
"monitored": artist.get("monitored", False),
"monitor_new_items": artist.get("monitorNewItems", "none"),
"statistics": artist.get("statistics", {}),
"ratings": artist.get("ratings", {}),
}
await self._cache.set(cache_key, result, ttl_seconds=300)
return result
except Exception as e: # noqa: BLE001
return None
async def get_artist_albums(self, artist_mbid: str) -> list[dict[str, Any]]:
cache_key = f"{LIDARR_ARTIST_ALBUMS_PREFIX}{artist_mbid}"
cached = await self._cache.get(cache_key)
if cached is not None:
return cached
try:
artist_data = await self._get("/api/v1/artist", params={"mbId": artist_mbid})
if not artist_data or not isinstance(artist_data, list) or len(artist_data) == 0:
await self._cache.set(cache_key, [], ttl_seconds=300)
return []
artist_id = artist_data[0].get("id")
if not artist_id:
await self._cache.set(cache_key, [], ttl_seconds=300)
return []
album_data = await self._get("/api/v1/album", params={"artistId": artist_id, "includeAllArtistAlbums": True})
if not album_data or not isinstance(album_data, list):
await self._cache.set(cache_key, [], ttl_seconds=300)
return []
albums = []
for album in album_data:
album_id = album.get("id")
album_mbid = album.get("foreignAlbumId")
images = album.get("images", [])
cover_url = None
for img in images:
url_path = img.get("url", "")
if url_path:
if url_path.startswith("http"):
cover_url = url_path
else:
cover_url = self._build_api_media_cover_url_album(album_id, url_path, 250)
break
cover_url = prefer_release_group_cover_url(album_mbid, cover_url, size=500)
year = None
if release_date := album.get("releaseDate"):
try:
year = int(release_date.split("-")[0])
except (ValueError, IndexError):
pass
statistics = album.get("statistics", {})
track_file_count = statistics.get("trackFileCount", 0)
album_info = {
"id": album_id,
"title": album.get("title", "Unknown"),
"mbid": album_mbid,
"album_type": album.get("albumType"),
"secondary_types": album.get("secondaryTypes", []),
"release_date": album.get("releaseDate"),
"year": year,
"monitored": album.get("monitored", False),
"track_file_count": track_file_count,
"cover_url": cover_url,
"genres": album.get("genres", []),
}
albums.append(album_info)
albums.sort(key=lambda a: a.get("release_date") or "", reverse=True)
await self._cache.set(cache_key, albums, ttl_seconds=300)
return albums
except Exception as e: # noqa: BLE001
return []
async def _get_artist_by_id(self, artist_id: int) -> Optional[dict[str, Any]]:
try:
return await self._get(f"/api/v1/artist/{artist_id}")
except Exception as e: # noqa: BLE001
return None
async def trigger_refresh_by_mbid(self, artist_mbid: str) -> int | None:
"""Fire RefreshArtist for the artist matching `artist_mbid` (best effort,
does NOT wait for completion). Returns the Lidarr command id on success.
Used by the track-download flow to scope a rescan to JUST the artist
whose file was just written, rather than a full RescanFolders. Failures
are swallowed — this is an enhancement, not a critical-path call.
"""
try:
items = await self._get("/api/v1/artist", params={"mbId": artist_mbid})
if not items or not isinstance(items, list):
logger.debug("trigger_refresh_by_mbid: no Lidarr artist for mbid=%s", artist_mbid)
return None
artist_id = items[0].get("id")
if not artist_id:
return None
cmd = await self._post_command(
{"name": "RefreshArtist", "artistId": artist_id}
)
cmd_id = cmd.get("id") if isinstance(cmd, dict) else None
logger.info(
"trigger_refresh_by_mbid: fired RefreshArtist artist_id=%s mbid=%s cmd_id=%s",
artist_id, artist_mbid, cmd_id,
)
return cmd_id
except Exception as e: # noqa: BLE001
logger.warning(
"trigger_refresh_by_mbid failed for mbid=%s: %s", artist_mbid, e
)
return None
async def delete_artist(self, artist_id: int, delete_files: bool = False) -> bool:
try:
params = {"deleteFiles": str(delete_files).lower(), "addImportListExclusion": "false"}
await self._delete(f"/api/v1/artist/{artist_id}", params=params)
return True
except Exception as e:
logger.error(f"Failed to delete artist {artist_id}: {e}")
raise
async def update_artist_monitoring(
self, artist_mbid: str, *, monitored: bool, monitor_new_items: str = "none",
) -> dict[str, Any]:
if monitor_new_items not in ("none", "all"):
raise ValueError(f"Invalid monitor_new_items value: {monitor_new_items}")
data = await self._get("/api/v1/artist", params={"mbId": artist_mbid})
if not data or not isinstance(data, list) or len(data) == 0:
raise ExternalServiceError(f"Artist {artist_mbid[:8]} not found in Lidarr")
artist_id = data[0].get("id")
if not artist_id:
raise ExternalServiceError(f"Artist {artist_mbid[:8]} has no Lidarr ID")
await self._put(
"/api/v1/artist/editor",
{
"artistIds": [artist_id],
"monitored": monitored,
"monitorNewItems": monitor_new_items,
},
)
cache_key = f"{LIDARR_ARTIST_DETAILS_PREFIX}{artist_mbid}"
await self._cache.delete(cache_key)
return {"monitored": monitored, "auto_download": monitor_new_items == "all"}
async def _ensure_artist_exists(
self, artist_mbid: str, artist_name_hint: Optional[str] = None
) -> tuple[dict[str, Any], bool]:
"""Return (artist_dict, created). created=True means we just added the artist."""
try:
items = await self._get("/api/v1/artist", params={"mbId": artist_mbid})
if items:
return items[0], False
except ExternalServiceError as exc:
pass
try:
roots = await self._get("/api/v1/rootfolder")
if not roots:
raise ExternalServiceError("No root folders configured in Lidarr")
root = next((r for r in roots if r.get("accessible", True)), roots[0])
except ExternalServiceError as e:
raise ExternalServiceError(f"Failed to get root folders: {e}")
qp_id = root.get("defaultQualityProfileId") or self._settings.quality_profile_id
mp_id = root.get("defaultMetadataProfileId") or self._settings.metadata_profile_id
try:
lookup = await self._get("/api/v1/artist/lookup", params={"term": f"mbid:{artist_mbid}"})
if not lookup:
raise ExternalServiceError(f"Artist not found in lookup: {artist_mbid}")
remote = lookup[0]
artist_name = remote.get("artistName") or artist_name_hint or "Unknown Artist"
except Exception as e: # noqa: BLE001
raise ExternalServiceError(f"Failed to lookup artist: {e}")
payload = {
"artistName": artist_name,
"mbId": artist_mbid,
"foreignArtistId": artist_mbid,
"qualityProfileId": qp_id,
"metadataProfileId": mp_id,
"rootFolderPath": root.get("path"),
"monitored": False,
"monitorNewItems": "none",
"addOptions": {
"monitor": "none",
"monitored": False,
"searchForMissingAlbums": False,
},
}
try:
created = await self._post("/api/v1/artist", payload)
artist_id = created["id"]
await self._await_command(
{"name": "RefreshArtist", "artistId": artist_id},
timeout=180.0,
)
return created, True
except ExternalServiceError as exc:
err_str = str(exc).lower()
if "already exists" in err_str or "409" in err_str:
items = await self._get("/api/v1/artist", params={"mbId": artist_mbid})
if items:
return items[0], False
raise ExternalServiceError(f"Failed to add artist: {exc}")