* feat(metadata): register builtin NFO provider and broaden parsing Phases A and B of the #216 local-NFO work, implemented test-first. Registration & hint-first identity (Phase A): - Migration seeds a reserved kind='builtin' silo.builtin installation and an 'nfo' metadata capability (default_enabled=false, priority 1 for movie/series) with a partial unique index and documented Down. - In-process builtin provider registry (internal/metadata/builtin.go); buildProviders returns the registered provider for builtin rows. - Guard rails keep the reserved row out of every plugin surface (user plugin-settings, installations list, image resolvers, preload, auto-update, store Delete, mutation handlers -> 409); silo.builtin is a reserved manifest id. - Startup sync materializes legacy content_level='' chains per level, then appends builtin capabilities disabled via AppendProviderToAllChains (idempotent); resolveEnabledProvidersBy priority now respects default_enabled=false. - NFO uniqueids seed the trusted-hint machinery via IdentityHintProvider with per-mode conflict policy (stored IDs win on scheduled refresh, NFO wins on manual refresh, Identify skips NFO); ID-less candidates are excluded from provider-priority tie-breaks and nfo never counts as corroboration. - Web chain-editor empty-state gate is now server-derived so builtin providers are reachable on plugin-less servers. Parser breadth & sidecar hardening (Phase B): - Parser covers the practical Kodi/Jellyfin field set for <movie> and <tvshow>: original title, tagline, runtime, dates, content rating, genres/studios/countries/tags, multi-source ratings with scale normalization, cast with roles/order, director/credits. Empty collections stay nil so merge early-returns apply. - findNFO parses candidates and falls through on read/parse failure or root-type mismatch, so a stray movie.nfo cannot shadow tvshow.nfo; GetMetadata gains the same ContentType guard Search has. - New FieldReleaseDates lock gates Year/ReleaseDate/First+LastAirDate in merge (Go) and the edit-metadata dialog (web), closing the gap where a manual refresh re-applied NFO dates over admin corrections. - Merge-contract tests pin NFO fill semantics, genres whole-list first-provider-wins, and NFO edits propagating on manual refresh only. - Docs: new admin wiki page (supported fields, merge semantics, naming-supplies-structure contract), index bullet, sidecar wording revision, v1-scope feature-detection note. Zero behavior change while the provider is disabled (default); pinned by CI-mode and DB-gated test suites. Part of #216 AI-use disclosure: implemented with Claude Code (Fable 5) via spec-driven TDD and agent-assisted implementation. * feat(metadata): ingest local sidecar artwork and read series-depth NFO Phases C and D of the #216 local-NFO work, implemented test-first, plus the mixed-library use-case pins. Together these deliver the headline case: a series absent from every remote database (e.g. a fitness library) scans into a fully presented show -> named seasons -> titled episodes tree from NFO files and sidecar art alone. Local sidecar artwork through the S3 image cache (Phase C): - The NFO provider implements ImageProvider: poster/backdrop/logo sidecar discovery with a fixed precedence map, symlink/non-regular rejection, an 8 MiB cap, and file:// source URLs at rating 0. Generic filenames apply only via the sidecar search paths, so a shared folder.jpg in a flat multi-movie directory applies to none. - file:// becomes a live local source scheme: routed into *_source_path (never *_path), accepted by every image enqueue gate, attributed as provider "local", excluded from cached-path detection. - The image-cache processor caches local files with lexical-on-logical confinement to the library roots, open-handle reads with re-checks, the same variant widths as remote art, and stable (7-day) failure classification. Keys land under local/{contentType}/{contentID}/{hash8}/{imageType}; superseded prefixes are cleaned on re-cache and item deletion. - applyIfBetter gains a local exemption so rating-0 local art can fill matched items without being stickily displaced; ImageRequest carries additive sidecar path context. Series depth (Phase D): - SeasonsRequest/EpisodesRequest carry additive local path context (series roots, per-season directories, per-episode file paths), derived from naming at match time and reconstructed on refresh. - season.nfo supplies season name/plot; NFO season numbers are advisory (directory-derived number wins with a Warn - naming owns structure). <episodedetails> gains aired/runtime/ratings; <basename>.nfo titles episodes and <basename>-thumb.ext supplies thumbs; filename SxxEyy wins over NFO numbers. - Episode NFOs work without a season.nfo (provider seasons unioned with on-disk seasons); SynthesizeFallbackEpisodes always runs after persist so NFO-less episodes keep synthesized rows. Season/episode file:// art rides the Phase C pipeline unchanged. - Migration adds season:1/episode:1 to the builtin NFO capability's default_priority (still default_enabled=false). Mixed sports-library use case (tests only, no product change): - Pins the classification contract for one library holding movie-shaped and show-shaped content (WWE PPV events as movies next to a "WWE SmackDown" show, NASCAR/F1/FIFA with partial TVDB/TMDB data): naming decides movie-vs-series per file before any provider runs; the NFO supplies metadata/identity but never flips type (ContentType guard); the per-root Type override is the correction path. - NFO-driven type classification at scan time is recorded as an explicit deferred open question. Part of #216 AI-use disclosure: implemented with Claude Code (Fable 5) via spec-driven TDD and agent-assisted implementation. * docs(metadata): document local NFO metadata architecture Add a single as-built architecture page (docs/architecture/local-nfo-metadata.md) for the #216 local-NFO feature: the builtin registration model, hint-first identity semantics, the file:// -> S3 artwork pipeline and its deployment constraint, series depth, the mixed-library classification contract, and known limitations. This replaces the working implementation plan, the per-phase specs, and the narrow sidecar-artwork note, which were planning drafts and are left untracked; admin-facing behavior remains in the wiki. Part of #216 AI-use disclosure: planned, drafted, and consolidated with Claude Code (Fable 5) using multi-agent exploration and adversarial review. * fix(metadata): address PR review findings on NFO builtin provider Fold in the valid, low-risk fixes surfaced by automated review on #390: - imagecache: extract validateCacheRequest so CacheBytes (the local sidecar season/episode path) enforces the same episode-requires-season guard as Cache, preventing distinct episodes' art from colliding under one S3 key. - image_cache_processor: close the sidecar symlink-swap window by rejecting the opened handle unless os.SameFile matches the Lstat'd file, so a leaf swapped to a symlink can't pull an out-of-root target into the public cache. - plugins: guard the reserved builtin installation row in the store's Update, matching Delete, so its version/enabled/capabilities can never be rewritten even if a mutation slips past the HTTP layer. - cmd/silo: bound SyncBuiltinProviderChains with a 30s timeout so a stuck DB round-trip fails fast at startup instead of hanging. - metadata: panic instead of silently no-op'ing on an invalid RegisterBuiltinProvider call (init-time programmer error). - docs: correct the media-folder-and-naming NFO paragraph to state season/episode NFOs and sidecar artwork are actively read. --------- Co-authored-by: Quick104 <31828688+Quick104@users.noreply.github.com>
151 lines
5.4 KiB
Go
151 lines
5.4 KiB
Go
package metadata
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
)
|
|
|
|
// ContentLevelsForLibraryType maps a media_folders.type to the metadata
|
|
// content levels it serves. It is the server-side source of truth shared by
|
|
// chain seeding, the provider-defaults endpoint, and the startup builtin
|
|
// chain sync.
|
|
func ContentLevelsForLibraryType(libraryType string) []string {
|
|
switch libraryType {
|
|
case "series":
|
|
return []string{"series", "season", "episode"}
|
|
case "movies", "movie":
|
|
return []string{"movie"}
|
|
case "audiobooks", "audiobook":
|
|
return []string{"audiobook"}
|
|
case "ebooks", "ebook":
|
|
return []string{"ebook"}
|
|
case "manga":
|
|
return []string{"manga"}
|
|
case "mixed":
|
|
return []string{"movie", "series", "season", "episode", "audiobook", "ebook"}
|
|
default:
|
|
return nil
|
|
}
|
|
}
|
|
|
|
// SyncBuiltinProviderChains makes every existing library chain aware of the
|
|
// registered builtin host providers. It is idempotent and runs at startup
|
|
// before serving (callers must invalidate the chain cache afterwards when the
|
|
// service is already constructed). It also doubles as the repair path: if a
|
|
// stale chain-editor save drops a builtin row (SetChain is
|
|
// delete-all-and-reinsert), the row is re-appended disabled on next startup.
|
|
//
|
|
// Two steps, in order:
|
|
//
|
|
// 1. Legacy-” materialization: a library whose chain rows are only
|
|
// content_level=” predates per-level chains. AppendProviderToAllChains
|
|
// cannot insert anything for it (no per-level groups exist), yet the chain
|
|
// editor overlays per-level defaults for levels with no saved rows and the
|
|
// first save would materialize those defaults over the admin's legacy
|
|
// ordering. The sync therefore copies the ” rows to every content level
|
|
// the library type serves (same order/enabled) so the editor shows real
|
|
// rows; the ” rows stay in place for old binaries. GetChain's legacy
|
|
// fallback only applied when a level had zero rows, so resolved chains are
|
|
// unchanged.
|
|
// 2. For every builtin metadata capability (read from the database, the
|
|
// source of truth the registry mirrors), append it to all existing
|
|
// per-level chains it supports — disabled at MAX(priority)+1,
|
|
// ON CONFLICT DO NOTHING — exactly like a plugin install does.
|
|
func SyncBuiltinProviderChains(ctx context.Context, chainRepo *ChainRepository) error {
|
|
if chainRepo == nil {
|
|
return nil
|
|
}
|
|
pool := chainRepo.Pool()
|
|
|
|
if err := materializeLegacyChains(ctx, chainRepo); err != nil {
|
|
return err
|
|
}
|
|
|
|
rows, err := pool.Query(ctx,
|
|
`SELECT pc.plugin_installation_id, pc.capability_id
|
|
FROM plugin_capabilities pc
|
|
JOIN plugin_installations pi ON pi.id = pc.plugin_installation_id
|
|
WHERE pi.kind = 'builtin' AND pc.capability_type = 'metadata_provider.v1'
|
|
ORDER BY pc.plugin_installation_id, pc.capability_id`)
|
|
if err != nil {
|
|
return fmt.Errorf("listing builtin metadata capabilities: %w", err)
|
|
}
|
|
type builtinCap struct {
|
|
installationID int
|
|
capabilityID string
|
|
}
|
|
var caps []builtinCap
|
|
for rows.Next() {
|
|
var c builtinCap
|
|
if err := rows.Scan(&c.installationID, &c.capabilityID); err != nil {
|
|
rows.Close()
|
|
return fmt.Errorf("scanning builtin capability: %w", err)
|
|
}
|
|
caps = append(caps, c)
|
|
}
|
|
rows.Close()
|
|
if err := rows.Err(); err != nil {
|
|
return fmt.Errorf("iterating builtin capabilities: %w", err)
|
|
}
|
|
|
|
for _, c := range caps {
|
|
if err := chainRepo.AppendProviderToAllChains(ctx, c.installationID, c.capabilityID, func(level string) SeedPlacement {
|
|
return LookupSeedPlacement(ctx, pool, c.installationID, c.capabilityID, level)
|
|
}); err != nil {
|
|
return fmt.Errorf("appending builtin capability %q to chains: %w", c.capabilityID, err)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// materializeLegacyChains copies content_level=” chain rows to every content
|
|
// level the library type serves, for libraries that have only legacy rows.
|
|
// The copy preserves order and enabled state; existing rows win via
|
|
// ON CONFLICT DO NOTHING, and the ” rows are left untouched.
|
|
func materializeLegacyChains(ctx context.Context, chainRepo *ChainRepository) error {
|
|
pool := chainRepo.Pool()
|
|
rows, err := pool.Query(ctx,
|
|
`SELECT c.media_folder_id, f.type
|
|
FROM library_provider_chains c
|
|
JOIN media_folders f ON f.id = c.media_folder_id
|
|
GROUP BY c.media_folder_id, f.type
|
|
HAVING COUNT(*) FILTER (WHERE c.content_level <> '') = 0`)
|
|
if err != nil {
|
|
return fmt.Errorf("listing legacy-chain libraries: %w", err)
|
|
}
|
|
type legacyFolder struct {
|
|
folderID int
|
|
libraryType string
|
|
}
|
|
var folders []legacyFolder
|
|
for rows.Next() {
|
|
var f legacyFolder
|
|
if err := rows.Scan(&f.folderID, &f.libraryType); err != nil {
|
|
rows.Close()
|
|
return fmt.Errorf("scanning legacy-chain library: %w", err)
|
|
}
|
|
folders = append(folders, f)
|
|
}
|
|
rows.Close()
|
|
if err := rows.Err(); err != nil {
|
|
return fmt.Errorf("iterating legacy-chain libraries: %w", err)
|
|
}
|
|
|
|
for _, f := range folders {
|
|
for _, level := range ContentLevelsForLibraryType(f.libraryType) {
|
|
if _, err := pool.Exec(ctx,
|
|
`INSERT INTO library_provider_chains
|
|
(media_folder_id, plugin_installation_id, capability_id, capability_type, content_level, priority, enabled)
|
|
SELECT media_folder_id, plugin_installation_id, capability_id, capability_type, $2, priority, enabled
|
|
FROM library_provider_chains
|
|
WHERE media_folder_id = $1 AND content_level = ''
|
|
ON CONFLICT DO NOTHING`,
|
|
f.folderID, level,
|
|
); err != nil {
|
|
return fmt.Errorf("materializing legacy chain for folder %d level %q: %w", f.folderID, level, err)
|
|
}
|
|
}
|
|
}
|
|
return nil
|
|
}
|