* 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>
199 lines
6.5 KiB
Go
199 lines
6.5 KiB
Go
package nfo
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"log/slog"
|
|
"os"
|
|
"path/filepath"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/metadata"
|
|
)
|
|
|
|
// Provider implements metadata.EpisodeProvider for its content types using
|
|
// the request plumbing added in Phase D: per-season directory paths and
|
|
// per-episode media file paths. NFO files never create structure — season
|
|
// and episode numbers come from directory/filename parsing upstream and the
|
|
// numbers declared inside an NFO are advisory only.
|
|
|
|
// GetSeasons reads season.nfo sidecars and season posters for each
|
|
// directory-derived season. A season with neither a season.nfo nor a poster
|
|
// contributes nothing, leaving remote providers (or fallback synthesis) in
|
|
// charge.
|
|
func (p *Provider) GetSeasons(ctx context.Context, req metadata.SeasonsRequest) ([]metadata.SeasonResult, error) {
|
|
if req.ContentType != "" && req.ContentType != typeSeries {
|
|
return nil, nil
|
|
}
|
|
if len(req.SeasonDirectoryPaths) == 0 {
|
|
return nil, nil
|
|
}
|
|
seriesRoots := compactNFOPaths(req.SeriesRootPaths)
|
|
seasonNumbers := make([]int, 0, len(req.SeasonDirectoryPaths))
|
|
for number := range req.SeasonDirectoryPaths {
|
|
seasonNumbers = append(seasonNumbers, number)
|
|
}
|
|
sort.Ints(seasonNumbers)
|
|
|
|
var seasons []metadata.SeasonResult
|
|
for _, number := range seasonNumbers {
|
|
dirs := compactNFOPaths(req.SeasonDirectoryPaths[number])
|
|
parsed := parseSeasonSidecar(ctx, dirs, number)
|
|
poster := findSeasonPoster(dirs, seriesRoots, number)
|
|
if parsed == nil && poster == "" {
|
|
continue
|
|
}
|
|
season := metadata.SeasonResult{SeasonNumber: number}
|
|
if parsed != nil {
|
|
season.Title = parsed.Title
|
|
season.Overview = parsed.Overview
|
|
}
|
|
if poster != "" {
|
|
season.PosterPath = "file://" + poster
|
|
}
|
|
seasons = append(seasons, season)
|
|
}
|
|
return seasons, nil
|
|
}
|
|
|
|
// parseSeasonSidecar loads the first parseable season.nfo across the season's
|
|
// candidate directories. A declared <seasonnumber> that disagrees with the
|
|
// directory-derived number is advisory: naming owns structure, so the
|
|
// directory number wins with a warning.
|
|
func parseSeasonSidecar(ctx context.Context, seasonDirs []string, seasonNumber int) *parsedNFO {
|
|
for _, dir := range seasonDirs {
|
|
path := filepath.Join(dir, "season.nfo")
|
|
data, err := os.ReadFile(path)
|
|
if err != nil {
|
|
continue
|
|
}
|
|
parsed, err := parseNFOData(data)
|
|
if err != nil || parsed.Type != typeSeason {
|
|
continue
|
|
}
|
|
if parsed.SeasonSet && parsed.Season != seasonNumber {
|
|
slog.WarnContext(ctx, "nfo: season.nfo seasonnumber disagrees with directory; preferring directory number",
|
|
"component", "metadata", "path", path,
|
|
"nfo_season", parsed.Season, "directory_season", seasonNumber)
|
|
}
|
|
return parsed
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// findSeasonPoster locates season artwork: poster/folder/cover inside the
|
|
// season directory first, then the Kodi-style seasonNN-poster form in the
|
|
// series root.
|
|
func findSeasonPoster(seasonDirs []string, seriesRoots []string, seasonNumber int) string {
|
|
for _, name := range []string{"poster", "folder", "cover"} {
|
|
for _, dir := range seasonDirs {
|
|
if path := findLocalArtworkFile(dir, name); path != "" {
|
|
return path
|
|
}
|
|
}
|
|
}
|
|
rootNames := []string{fmt.Sprintf("season%02d-poster", seasonNumber)}
|
|
if seasonNumber == 0 {
|
|
rootNames = append(rootNames, "season-specials-poster")
|
|
}
|
|
for _, name := range rootNames {
|
|
for _, dir := range seriesRoots {
|
|
if path := findLocalArtworkFile(dir, name); path != "" {
|
|
return path
|
|
}
|
|
}
|
|
}
|
|
return ""
|
|
}
|
|
|
|
// GetEpisodes reads <basename>.nfo and <basename>-thumb sidecars for each
|
|
// episode media file of the requested season. Episodes with neither
|
|
// contribute nothing (synthesized fallback stays in charge of them).
|
|
func (p *Provider) GetEpisodes(ctx context.Context, req metadata.EpisodesRequest) ([]metadata.EpisodeResult, error) {
|
|
if len(req.EpisodeFilePaths) == 0 {
|
|
return nil, nil
|
|
}
|
|
episodeNumbers := make([]int, 0, len(req.EpisodeFilePaths))
|
|
for number := range req.EpisodeFilePaths {
|
|
episodeNumbers = append(episodeNumbers, number)
|
|
}
|
|
sort.Ints(episodeNumbers)
|
|
|
|
var episodes []metadata.EpisodeResult
|
|
for _, number := range episodeNumbers {
|
|
paths := compactNFOPaths(req.EpisodeFilePaths[number])
|
|
parsed, thumb := findEpisodeSidecars(ctx, paths, req.SeasonNumber, number)
|
|
if parsed == nil && thumb == "" {
|
|
continue
|
|
}
|
|
episode := metadata.EpisodeResult{
|
|
SeasonNumber: req.SeasonNumber,
|
|
EpisodeNumber: number,
|
|
}
|
|
if parsed != nil {
|
|
episode.Title = parsed.Title
|
|
episode.Overview = parsed.Overview
|
|
episode.AirDate = parsed.FirstAirDate
|
|
episode.Runtime = parsed.Runtime
|
|
episode.Ratings = metadata.Ratings{
|
|
IMDB: parsed.RatingIMDB,
|
|
TMDB: parsed.RatingTMDB,
|
|
RTCritic: parsed.RatingRTCritic,
|
|
RTAudience: parsed.RatingRTAudience,
|
|
}
|
|
}
|
|
if thumb != "" {
|
|
episode.StillPath = "file://" + thumb
|
|
}
|
|
episodes = append(episodes, episode)
|
|
}
|
|
return episodes, nil
|
|
}
|
|
|
|
// findEpisodeSidecars locates the episode's <basename>.nfo and
|
|
// <basename>-thumb image across its media file paths. Numbers declared in
|
|
// the NFO are checked against the filename-derived SxxEyy, which wins on
|
|
// conflict (naming owns structure).
|
|
func findEpisodeSidecars(ctx context.Context, mediaPaths []string, seasonNumber, episodeNumber int) (*parsedNFO, string) {
|
|
var parsed *parsedNFO
|
|
thumb := ""
|
|
for _, mediaPath := range mediaPaths {
|
|
dir := filepath.Dir(mediaPath)
|
|
base := strings.TrimSuffix(filepath.Base(mediaPath), filepath.Ext(mediaPath))
|
|
if parsed == nil {
|
|
parsed = parseEpisodeSidecar(ctx, filepath.Join(dir, base+".nfo"), seasonNumber, episodeNumber)
|
|
}
|
|
if thumb == "" {
|
|
thumb = findLocalArtworkFile(dir, base+"-thumb")
|
|
}
|
|
if parsed != nil && thumb != "" {
|
|
break
|
|
}
|
|
}
|
|
return parsed, thumb
|
|
}
|
|
|
|
func parseEpisodeSidecar(ctx context.Context, path string, seasonNumber, episodeNumber int) *parsedNFO {
|
|
data, err := os.ReadFile(path)
|
|
if err != nil {
|
|
return nil
|
|
}
|
|
parsed, err := parseNFOData(data)
|
|
if err != nil || parsed.Type != typeEpisode {
|
|
return nil
|
|
}
|
|
if parsed.MultiEpisode {
|
|
slog.WarnContext(ctx, "nfo: multi-episode NFO documents are not supported; using the first <episodedetails> block",
|
|
"component", "metadata", "path", path)
|
|
}
|
|
if (parsed.SeasonSet && parsed.Season != seasonNumber) ||
|
|
(parsed.EpisodeSet && parsed.Episode != episodeNumber) {
|
|
slog.WarnContext(ctx, "nfo: episode NFO numbers disagree with filename; preferring filename numbers",
|
|
"component", "metadata", "path", path,
|
|
"nfo_season", parsed.Season, "nfo_episode", parsed.Episode,
|
|
"file_season", seasonNumber, "file_episode", episodeNumber)
|
|
}
|
|
return parsed
|
|
}
|