mediascanner

func FallbackMediaIdentity ¶ added in v2.21.0

func FallbackMediaIdentity(cfg *config.Instance, systemID, path string) (database.MediaIdentity, bool)

FallbackMediaIdentity builds the identity the indexer would give a played file that is not in the index, such as a cartridge dumped by the Operator bridge, so its play history can still be matched to a title. The title, slug and filename tags come from the same derivation StageMediaPath uses, so a later plain folder walk of that file yields the same fingerprint. A later index that supplies scanner inputs this path cannot know (a directory prefix policy, a scanner-provided name, NoExt) can differ, and the server reconciles the two observations. Only absolute filesystem paths qualify: virtual paths and bare names such as arcade set names are not files the indexer would have parsed.

func FindPath ¶

func FindPath(ctx context.Context, path string) (string, error)

FindPath case-insensitively finds a file/folder at a path and returns the actual filesystem case. On case-insensitive filesystems (Windows, macOS), this ensures we get the real case from the filesystem rather than preserving the input case, which prevents case-mismatch issues during string comparisons.

This function recursively normalizes the entire path from root to leaf to ensure all components match the actual filesystem case.

Special handling:

• Linux: Prefers exact match before case-insensitive match (handles File.txt vs file.txt)
• Windows: Handles 8.3 short names (PROGRA~1) via fallback to os.Stat
• All platforms: Works with symlinks, UNC paths, network drives

func GetFiles ¶

func GetFiles(
	ctx context.Context,
	cfg *config.Instance,
	platform platforms.Platform,
	systemID string,
	path string,
	pauser *syncutil.Pauser,
) ([]string, error)

GetFiles searches for all valid games in a given path and returns a list of files. Uses fastwalk for parallel directory traversal with built-in symlink cycle detection. Deep searches .zip files when ZipsAsDirs is enabled.

func MediaDBSettled ¶ added in v2.22.0

func MediaDBSettled(mediaDB database.MediaDBI) bool

MediaDBSettled reports whether the media database is idle: not corrupt or awaiting rebuild, no indexing under way or owed, and no optimization (which includes the disambiguation backfill) under way or owed. Until then a library file may simply not be indexed yet, so a fallback identity must not stand in for its row. Status read failures count as unsettled.

func NewNamesIndex ¶

func NewNamesIndex(
	ctx context.Context,
	platform platforms.Platform,
	cfg *config.Instance,
	systems []systemdefs.System,
	fdb *database.Database,
	update func(IndexStatus),
	pauser *syncutil.Pauser,
) (indexedFiles int, err error)

func NewNamesIndexWithSources ¶ added in v2.18.0

func NewNamesIndexWithSources(
	ctx context.Context, platform platforms.Platform, cfg *config.Instance,
	systems []systemdefs.System, fdb *database.Database, update func(IndexStatus),
	pauser *syncutil.Pauser, sourceOptions *IndexSourceOptions,
) (indexedFiles int, err error)

NewNamesIndexWithSources reports selected successful launcher contributions without changing the existing filesystem or custom scanner contracts.

func SeedCanonicalTags ¶ added in v2.7.0

func SeedCanonicalTags(ctx context.Context, db database.MediaDBI) error

SeedCanonicalTags seeds the database with canonical GameDataBase-style hierarchical tag types and values (e.g. "genre:sports:wrestling", "players:2:vs"). Definitions live in the tags package. Runs set-based inside its own transaction; already-present rows are left untouched.

func StageMediaPath ¶ added in v2.16.0

func StageMediaPath(params *StageMediaPathParams) error

StageMediaPath parses one scanned file into its media fragments and appends them to the scanner staging tables. Tags, missing state, and most existence checks run set-based in ReconcileStagedSystem once the system's files are staged, so scanner memory does not grow with library or database size.