Files
silo-server/internal/metadata/nfo/provider.go
91e1164090 feat(metadata): local NFO metadata and sidecar artwork (builtin chain provider) (#390)
* 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>
2026-07-16 17:55:36 -04:00

231 lines
6.6 KiB
Go

package nfo
import (
"context"
"os"
"path/filepath"
"strings"
"github.com/Silo-Server/silo-server/internal/metadata"
)
// Provider reads metadata from NFO sidecar files.
type Provider struct{}
func NewProvider() *Provider { return &Provider{} }
func (p *Provider) Slug() string { return "nfo" }
func (p *Provider) Name() string { return "NFO Files" }
func (p *Provider) ForTypes() []string { return []string{typeMovie, typeSeries} }
// IdentityHints implements metadata.IdentityHintProvider: the external IDs a
// curated NFO declares (<uniqueid> tmdb/imdb/tvdb) are trusted identity hints
// that anchor Phase-1 candidate selection. A title-only NFO contributes no
// hints; its title participates only as a defanged search candidate.
func (p *Provider) IdentityHints(_ context.Context, query metadata.SearchQuery) map[string]string {
parsed := findNFOForQuery(query)
if parsed == nil {
return nil
}
hints := make(map[string]string)
if parsed.TmdbID != "" {
hints["tmdb"] = parsed.TmdbID
}
if parsed.ImdbID != "" {
hints["imdb"] = parsed.ImdbID
}
if parsed.TvdbID != "" {
hints["tvdb"] = parsed.TvdbID
}
if len(hints) == 0 {
return nil
}
return hints
}
// Search extracts external IDs from NFO for matching.
func (p *Provider) Search(ctx context.Context, query metadata.SearchQuery) ([]metadata.SearchResult, error) {
parsed := findNFOForQuery(query)
if parsed == nil {
return nil, nil // missing/unreadable/mismatched NFOs are not fatal
}
ids := make(map[string]string)
if parsed.TmdbID != "" {
ids["tmdb"] = parsed.TmdbID
}
if parsed.ImdbID != "" {
ids["imdb"] = parsed.ImdbID
}
if parsed.TvdbID != "" {
ids["tvdb"] = parsed.TvdbID
}
if len(ids) == 0 && parsed.Title == "" {
return nil, nil
}
return []metadata.SearchResult{{
Name: parsed.Title,
Year: parsed.Year,
ProviderIDs: ids,
Provider: p.Slug(),
}}, nil
}
// GetMetadata parses full metadata from an NFO file. Like Search, it carries
// the ContentType guard (enforced inside findNFO): a tvshow.nfo next to a
// movie file must not inject series data into a movie item at top priority.
func (p *Provider) GetMetadata(ctx context.Context, req metadata.MetadataRequest) (*metadata.MetadataResult, error) {
parsed := findNFOForRequest(req)
if parsed == nil {
return &metadata.MetadataResult{}, nil
}
result := &metadata.MetadataResult{
HasMetadata: true,
Title: parsed.Title,
OriginalTitle: parsed.OriginalTitle,
Tagline: parsed.Tagline,
Year: parsed.Year,
Overview: parsed.Overview,
Runtime: parsed.Runtime,
ReleaseDate: parsed.ReleaseDate,
FirstAirDate: parsed.FirstAirDate,
ContentRating: parsed.ContentRating,
Genres: parsed.Genres,
Studios: parsed.Studios,
Countries: parsed.Countries,
Keywords: parsed.Keywords,
Ratings: metadata.Ratings{
IMDB: parsed.RatingIMDB,
TMDB: parsed.RatingTMDB,
RTCritic: parsed.RatingRTCritic,
RTAudience: parsed.RatingRTAudience,
},
People: parsed.People,
ProviderIDs: make(map[string]string),
}
if parsed.TmdbID != "" {
result.ProviderIDs["tmdb"] = parsed.TmdbID
}
if parsed.ImdbID != "" {
result.ProviderIDs["imdb"] = parsed.ImdbID
}
if parsed.TvdbID != "" {
result.ProviderIDs["tvdb"] = parsed.TvdbID
}
return result, nil
}
func findNFOForQuery(query metadata.SearchQuery) *parsedNFO {
candidatePaths := candidateSidecarPaths(
query.FilePath,
query.RepresentativeFilePath,
query.AllGroupFilePaths,
query.PrimarySidecarSearchPaths,
query.ProviderIDs["_filepath"],
)
_, parsed := findNFO(candidatePaths, query.ContentType)
return parsed
}
func findNFOForRequest(req metadata.MetadataRequest) *parsedNFO {
candidatePaths := candidateSidecarPaths(
req.FilePath,
req.RepresentativeFilePath,
req.AllGroupFilePaths,
req.PrimarySidecarSearchPaths,
)
_, parsed := findNFO(candidatePaths, req.ContentType)
return parsed
}
func candidateSidecarPaths(primary string, representative string, groupFiles []string, searchPaths []string, extras ...string) []string {
candidates := make([]string, 0, 2+len(groupFiles)+len(searchPaths)+len(extras))
for _, path := range []string{primary, representative} {
if strings.TrimSpace(path) != "" {
candidates = append(candidates, path)
}
}
candidates = append(candidates, groupFiles...)
candidates = append(candidates, searchPaths...)
candidates = append(candidates, extras...)
return compactNFOPaths(candidates)
}
func compactNFOPaths(paths []string) []string {
seen := make(map[string]struct{}, len(paths))
out := make([]string, 0, len(paths))
for _, path := range paths {
clean := filepath.Clean(strings.TrimSpace(path))
if clean == "" || clean == "." {
continue
}
if _, ok := seen[clean]; ok {
continue
}
seen[clean] = struct{}{}
out = append(out, clean)
}
return out
}
// findNFO locates the best candidate NFO file across media-file and directory
// search paths. File paths check legacy directory-level sidecars first, then a
// basename-matched sidecar in the same directory. A candidate that exists but
// fails to parse, or whose root type mismatches contentType, falls through to
// the next candidate — a stray movie.nfo in a series root must not shadow
// tvshow.nfo, and a tvshow.nfo beside a movie file must not inject series
// data. Returns the winning path and its parsed contents, or ("", nil).
func findNFO(paths []string, contentType string) (string, *parsedNFO) {
candidates := make([]string, 0, len(paths)*3)
for _, path := range paths {
candidates = append(candidates, nfoCandidatesForPath(path)...)
}
candidates = compactNFOPaths(candidates)
for _, c := range candidates {
data, err := os.ReadFile(c)
if err != nil {
continue
}
parsed, err := parseNFOData(data)
if err != nil {
continue
}
if contentType != "" && parsed.Type != "" && parsed.Type != contentType {
continue
}
return c, parsed
}
return "", nil
}
func nfoCandidatesForPath(path string) []string {
if path == "" {
return nil
}
info, err := os.Stat(path)
if err == nil {
if info.IsDir() {
return directoryLevelNFOCandidates(path)
}
return fileLevelNFOCandidates(path)
}
return append(fileLevelNFOCandidates(path), directoryLevelNFOCandidates(path)...)
}
func fileLevelNFOCandidates(path string) []string {
ext := filepath.Ext(path)
dir := filepath.Dir(path)
base := strings.TrimSuffix(filepath.Base(path), ext)
return []string{
filepath.Join(dir, "movie.nfo"),
filepath.Join(dir, "tvshow.nfo"),
filepath.Join(dir, base+".nfo"),
}
}
func directoryLevelNFOCandidates(path string) []string {
return []string{
filepath.Join(path, "movie.nfo"),
filepath.Join(path, "tvshow.nfo"),
}
}