* 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>
148 lines
4.5 KiB
Go
148 lines
4.5 KiB
Go
package metadata
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"sort"
|
|
"sync"
|
|
|
|
"github.com/Silo-Server/silo-server/internal/models"
|
|
)
|
|
|
|
// NFOSeriesHarness bridges the in-package fakes to the external NFO
|
|
// integration tests (package metadata_test). Those tests must live outside
|
|
// the package so they can import internal/metadata/nfo (which itself imports
|
|
// this package) without an import cycle.
|
|
type NFOSeriesHarness struct {
|
|
h *testHarness
|
|
seasons *fakeSeasonRepo
|
|
episodes *fakeEpisodeRepo
|
|
jobs *capturingImageJobEnqueuer
|
|
}
|
|
|
|
type capturingImageJobEnqueuer struct {
|
|
mu sync.Mutex
|
|
inputs []EnqueueImageCacheJobInput
|
|
}
|
|
|
|
func (c *capturingImageJobEnqueuer) Enqueue(_ context.Context, in EnqueueImageCacheJobInput) error {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
c.inputs = append(c.inputs, in)
|
|
return nil
|
|
}
|
|
|
|
func (c *capturingImageJobEnqueuer) EnqueueBatch(_ context.Context, inputs []EnqueueImageCacheJobInput) (int, error) {
|
|
c.mu.Lock()
|
|
defer c.mu.Unlock()
|
|
c.inputs = append(c.inputs, inputs...)
|
|
return len(inputs), nil
|
|
}
|
|
|
|
func NewNFOSeriesHarness() *NFOSeriesHarness {
|
|
h := newTestHarness()
|
|
x := &NFOSeriesHarness{
|
|
h: h,
|
|
seasons: newFakeSeasonRepo(),
|
|
episodes: newFakeEpisodeRepo(),
|
|
jobs: &capturingImageJobEnqueuer{},
|
|
}
|
|
h.service.seasonRepo = x.seasons
|
|
h.service.episodeRepo = x.episodes
|
|
h.service.imageCacheJobs = x.jobs
|
|
h.service.autoCacheImages.Store(true)
|
|
return x
|
|
}
|
|
|
|
func (x *NFOSeriesHarness) Service() *MetadataService { return x.h.service }
|
|
|
|
// SeedSeriesSkeleton seeds a pending series item, mirroring the scanner's
|
|
// skeleton for an unmatched series root.
|
|
func (x *NFOSeriesHarness) SeedSeriesSkeleton(contentID, title string) error {
|
|
return x.seedSkeleton(contentID, title, "series")
|
|
}
|
|
|
|
// SeedMovieSkeleton seeds a pending movie item, mirroring the scanner's
|
|
// skeleton for an unmatched movie group (e.g. the movie lane of a mixed
|
|
// library).
|
|
func (x *NFOSeriesHarness) SeedMovieSkeleton(contentID, title string) error {
|
|
return x.seedSkeleton(contentID, title, "movie")
|
|
}
|
|
|
|
func (x *NFOSeriesHarness) seedSkeleton(contentID, title, contentType string) error {
|
|
return x.h.itemRepo.Upsert(context.Background(), &models.MediaItem{
|
|
ContentID: contentID,
|
|
Type: contentType,
|
|
Title: title,
|
|
Status: "pending_match",
|
|
Studios: []string{},
|
|
Networks: []string{},
|
|
Countries: []string{},
|
|
Genres: []string{},
|
|
})
|
|
}
|
|
|
|
func (x *NFOSeriesHarness) Item(contentID string) (*models.MediaItem, error) {
|
|
return x.h.itemRepo.GetByID(context.Background(), contentID)
|
|
}
|
|
|
|
// SeedSeriesFile registers a persisted media file linked to a content id, so
|
|
// refresh flows (which reconstruct local context from the file repo instead
|
|
// of scan hints) can find the series' episode files. observedRootPath is the
|
|
// series root eligible for directory-level sidecars.
|
|
func (x *NFOSeriesHarness) SeedSeriesFile(fileID, folderID int, filePath, observedRootPath, contentID string) {
|
|
x.h.fileRepo.setGroupFiles(folderID, 1, fmt.Sprintf("group-%s-%d", contentID, fileID), &models.MediaFile{
|
|
ID: fileID,
|
|
MediaFolderID: folderID,
|
|
FilePath: filePath,
|
|
ObservedRootPath: observedRootPath,
|
|
})
|
|
x.h.fileRepo.mu.Lock()
|
|
x.h.fileRepo.contentIDs[fileID] = contentID
|
|
x.h.fileRepo.mu.Unlock()
|
|
}
|
|
|
|
// Seasons returns the persisted seasons for a series sorted by season number.
|
|
func (x *NFOSeriesHarness) Seasons(seriesID string) []*models.Season {
|
|
x.seasons.mu.Lock()
|
|
defer x.seasons.mu.Unlock()
|
|
var out []*models.Season
|
|
for _, s := range x.seasons.seasons {
|
|
if s.SeriesID == seriesID {
|
|
cp := *s
|
|
out = append(out, &cp)
|
|
}
|
|
}
|
|
sort.Slice(out, func(i, j int) bool { return out[i].SeasonNumber < out[j].SeasonNumber })
|
|
return out
|
|
}
|
|
|
|
// Episodes returns the persisted episodes for a series sorted by (season, episode).
|
|
func (x *NFOSeriesHarness) Episodes(seriesID string) []*models.Episode {
|
|
x.episodes.mu.Lock()
|
|
defer x.episodes.mu.Unlock()
|
|
var out []*models.Episode
|
|
for _, e := range x.episodes.episodes {
|
|
if e.SeriesID == seriesID {
|
|
cp := *e
|
|
out = append(out, &cp)
|
|
}
|
|
}
|
|
sort.Slice(out, func(i, j int) bool {
|
|
if out[i].SeasonNumber != out[j].SeasonNumber {
|
|
return out[i].SeasonNumber < out[j].SeasonNumber
|
|
}
|
|
return out[i].EpisodeNumber < out[j].EpisodeNumber
|
|
})
|
|
return out
|
|
}
|
|
|
|
// EnqueuedImageJobs returns every image cache job the pipeline enqueued.
|
|
func (x *NFOSeriesHarness) EnqueuedImageJobs() []EnqueueImageCacheJobInput {
|
|
x.jobs.mu.Lock()
|
|
defer x.jobs.mu.Unlock()
|
|
out := make([]EnqueueImageCacheJobInput, len(x.jobs.inputs))
|
|
copy(out, x.jobs.inputs)
|
|
return out
|
|
}
|