using System.Collections.Immutable; using ErsatzTV.Core; using ErsatzTV.Core.Domain; using ErsatzTV.Core.Domain.MediaServer; using ErsatzTV.Core.Errors; using ErsatzTV.Core.Extensions; using ErsatzTV.Core.Interfaces.Metadata; using ErsatzTV.Core.Interfaces.Repositories; using ErsatzTV.Core.MediaSources; using ErsatzTV.Core.Metadata; using Microsoft.Extensions.Logging; namespace ErsatzTV.Scanner.Core.Metadata; public abstract class MediaServerMovieLibraryScanner where TConnectionParameters : MediaServerConnectionParameters where TLibrary : Library where TMovie : Movie where TEtag : MediaServerItemEtag { private readonly ILocalFileSystem _localFileSystem; private readonly ILogger _logger; private readonly IMediator _mediator; private readonly IMetadataRepository _metadataRepository; protected MediaServerMovieLibraryScanner( ILocalFileSystem localFileSystem, IMetadataRepository metadataRepository, IMediator mediator, ILogger logger) { _localFileSystem = localFileSystem; _metadataRepository = metadataRepository; _mediator = mediator; _logger = logger; } protected virtual bool ServerSupportsRemoteStreaming => false; protected virtual bool ServerReturnsStatisticsWithMetadata => false; protected async Task> ScanLibrary( IMediaServerMovieRepository movieRepository, TConnectionParameters connectionParameters, TLibrary library, Func getLocalPath, bool deepScan, CancellationToken cancellationToken) { try { return await ScanLibrary( movieRepository, connectionParameters, library, getLocalPath, GetMovieLibraryItems(connectionParameters, library), deepScan, cancellationToken); } catch (Exception ex) when (ex is TaskCanceledException or OperationCanceledException) { return new ScanCanceled(); } } private async Task> ScanLibrary( IMediaServerMovieRepository movieRepository, TConnectionParameters connectionParameters, TLibrary library, Func getLocalPath, IAsyncEnumerable> movieEntries, bool deepScan, CancellationToken cancellationToken) { var incomingItemIds = new List(); IReadOnlyDictionary existingMovies = (await movieRepository.GetExistingMovies(library)) .ToImmutableDictionary(e => e.MediaServerItemId, e => e); await foreach ((TMovie incoming, int totalMovieCount) in movieEntries.WithCancellation(cancellationToken)) { if (cancellationToken.IsCancellationRequested) { return new ScanCanceled(); } incomingItemIds.Add(MediaServerItemId(incoming)); decimal percentCompletion = Math.Clamp((decimal)incomingItemIds.Count / totalMovieCount, 0, 1); await _mediator.Publish( new ScannerProgressUpdate( library.Id, library.Name, percentCompletion, Array.Empty(), Array.Empty()), cancellationToken); string localPath = getLocalPath(incoming); if (await ShouldScanItem(movieRepository, library, existingMovies, incoming, localPath, deepScan) == false) { continue; } Either> maybeMovie; if (ServerReturnsStatisticsWithMetadata) { maybeMovie = await movieRepository .GetOrAdd(library, incoming, deepScan) .MapT( result => { result.LocalPath = localPath; return result; }) .BindT( existing => UpdateMetadataAndStatistics( connectionParameters, library, existing, incoming, deepScan)); } else { maybeMovie = await movieRepository .GetOrAdd(library, incoming, deepScan) .MapT( result => { result.LocalPath = localPath; return result; }) .BindT( existing => UpdateMetadata(connectionParameters, library, existing, incoming, deepScan, None)) .BindT( existing => UpdateStatistics( connectionParameters, library, existing, incoming, deepScan, None)) .BindT(UpdateSubtitles); } if (maybeMovie.IsLeft) { foreach (BaseError error in maybeMovie.LeftToSeq()) { _logger.LogWarning( "Error processing movie {Title}: {Error}", incoming.MovieMetadata.Head().Title, error.Value); } continue; } foreach (MediaItemScanResult result in maybeMovie.RightToSeq()) { await movieRepository.SetEtag(result.Item, MediaServerEtag(incoming)); if (_localFileSystem.FileExists(result.LocalPath)) { Option flagResult = await movieRepository.FlagNormal(library, result.Item); if (flagResult.IsSome) { result.IsUpdated = true; } } else if (ServerSupportsRemoteStreaming) { Option flagResult = await movieRepository.FlagRemoteOnly(library, result.Item); if (flagResult.IsSome) { result.IsUpdated = true; } } else { Option flagResult = await movieRepository.FlagUnavailable(library, result.Item); if (flagResult.IsSome) { result.IsUpdated = true; } } if (result.IsAdded || result.IsUpdated) { await _mediator.Publish( new ScannerProgressUpdate( library.Id, null, null, new[] { result.Item.Id }, Array.Empty()), cancellationToken); } } } // trash movies that are no longer present on the media server var fileNotFoundItemIds = existingMovies.Keys.Except(incomingItemIds).ToList(); List ids = await movieRepository.FlagFileNotFound(library, fileNotFoundItemIds); await _mediator.Publish( new ScannerProgressUpdate(library.Id, null, null, ids.ToArray(), Array.Empty()), cancellationToken); await _mediator.Publish( new ScannerProgressUpdate( library.Id, library.Name, 0, Array.Empty(), Array.Empty()), cancellationToken); return Unit.Default; } protected abstract string MediaServerItemId(TMovie movie); protected abstract string MediaServerEtag(TMovie movie); protected abstract IAsyncEnumerable> GetMovieLibraryItems( TConnectionParameters connectionParameters, TLibrary library); protected abstract Task> GetFullMetadata( TConnectionParameters connectionParameters, TLibrary library, MediaItemScanResult result, TMovie incoming, bool deepScan); protected virtual Task> GetMediaServerStatistics( TConnectionParameters connectionParameters, TLibrary library, MediaItemScanResult result, TMovie incoming) => Task.FromResult(Option.None); protected abstract Task>> GetFullMetadataAndStatistics( TConnectionParameters connectionParameters, TLibrary library, MediaItemScanResult result, TMovie incoming); protected abstract Task>> UpdateMetadata( MediaItemScanResult result, MovieMetadata fullMetadata); private async Task ShouldScanItem( IMediaServerMovieRepository movieRepository, TLibrary library, IReadOnlyDictionary existingMovies, TMovie incoming, string localPath, bool deepScan) { // deep scan will always pull every movie if (deepScan) { return true; } string existingEtag = string.Empty; MediaItemState existingState = MediaItemState.Normal; if (existingMovies.TryGetValue(MediaServerItemId(incoming), out TEtag? existingEntry)) { existingEtag = existingEntry.Etag; existingState = existingEntry.State; } if (existingState is MediaItemState.Unavailable or MediaItemState.FileNotFound && existingEtag == MediaServerEtag(incoming)) { // skip scanning unavailable/file not found items that are unchanged and still don't exist locally if (!_localFileSystem.FileExists(localPath) && !ServerSupportsRemoteStreaming) { return false; } } else if (existingEtag == MediaServerEtag(incoming)) { // item is unchanged, but file does not exist // don't scan, but mark as unavailable if (!_localFileSystem.FileExists(localPath)) { if (ServerSupportsRemoteStreaming) { if (existingState is not MediaItemState.RemoteOnly) { foreach (int id in await movieRepository.FlagRemoteOnly(library, incoming)) { await _mediator.Publish( new ScannerProgressUpdate(library.Id, null, null, new[] { id }, Array.Empty()), CancellationToken.None); } } } else { if (existingState is not MediaItemState.Unavailable) { foreach (int id in await movieRepository.FlagUnavailable(library, incoming)) { await _mediator.Publish( new ScannerProgressUpdate(library.Id, null, null, new[] { id }, Array.Empty()), CancellationToken.None); } } } } return false; } if (existingEntry is null) { _logger.LogDebug("INSERT: new movie {Movie}", incoming.MovieMetadata.Head().Title); } else { _logger.LogDebug("UPDATE: Etag has changed for movie {Movie}", incoming.MovieMetadata.Head().Title); } return true; } private async Task>> UpdateMetadataAndStatistics( TConnectionParameters connectionParameters, TLibrary library, MediaItemScanResult result, TMovie incoming, bool deepScan) { Option> maybeMetadataAndStatistics = await GetFullMetadataAndStatistics( connectionParameters, library, result, incoming); foreach ((MovieMetadata fullMetadata, MediaVersion mediaVersion) in maybeMetadataAndStatistics) { Either> metadataResult = await UpdateMetadata( connectionParameters, library, result, incoming, deepScan, fullMetadata); foreach (BaseError error in metadataResult.LeftToSeq()) { return error; } foreach (MediaItemScanResult r in metadataResult.RightToSeq()) { result = r; } Either> statisticsResult = await UpdateStatistics( connectionParameters, library, result, incoming, deepScan, mediaVersion); foreach (BaseError error in statisticsResult.LeftToSeq()) { return error; } foreach (MediaItemScanResult r in metadataResult.RightToSeq()) { result = r; } } return result; } private async Task>> UpdateMetadata( TConnectionParameters connectionParameters, TLibrary library, MediaItemScanResult result, TMovie incoming, bool deepScan, Option maybeFullMetadata) { if (maybeFullMetadata.IsNone) { maybeFullMetadata = await GetFullMetadata(connectionParameters, library, result, incoming, deepScan); } foreach (MovieMetadata fullMetadata in maybeFullMetadata) { // TODO: move some of this code into this scanner // will have to merge JF, Emby, Plex logic return await UpdateMetadata(result, fullMetadata); } return result; } private async Task>> UpdateStatistics( TConnectionParameters connectionParameters, TLibrary library, MediaItemScanResult result, TMovie incoming, bool deepScan, Option maybeMediaVersion) { TMovie existing = result.Item; if (deepScan || result.IsAdded || MediaServerEtag(existing) != MediaServerEtag(incoming) || existing.MediaVersions.Head().Streams.Count == 0) { if (maybeMediaVersion.IsNone) { maybeMediaVersion = await GetMediaServerStatistics( connectionParameters, library, result, incoming); } foreach (MediaVersion mediaVersion in maybeMediaVersion) { if (await _metadataRepository.UpdateStatistics(result.Item, mediaVersion)) { result.IsUpdated = true; } } } return result; } private async Task>> UpdateSubtitles( MediaItemScanResult existing) { try { MediaVersion version = existing.Item.GetHeadVersion(); Option maybeMetadata = existing.Item.MovieMetadata.HeadOrNone(); foreach (MovieMetadata metadata in maybeMetadata) { List subtitles = version.Streams .Filter(s => s.MediaStreamKind is MediaStreamKind.Subtitle or MediaStreamKind.ExternalSubtitle) .Map(Subtitle.FromMediaStream) .ToList(); if (await _metadataRepository.UpdateSubtitles(metadata, subtitles)) { return existing; } } return BaseError.New("Failed to update media server subtitles"); } catch (Exception ex) { return BaseError.New(ex.ToString()); } } }