using System; using System.Collections.Generic; using System.Diagnostics; using System.Globalization; using System.IO; using System.Linq; using System.Threading; using System.Threading.Tasks; using API.Data; using API.Data.Repositories; using API.Entities; using API.Entities.Enums; using API.Extensions; using API.Helpers; using API.Services.Tasks.Metadata; using API.Services.Tasks.Scanner; using API.Services.Tasks.Scanner.Parser; using API.SignalR; using Hangfire; using Microsoft.Extensions.Logging; namespace API.Services.Tasks; #nullable enable public interface IScannerService { /// /// Given a library id, scans folders for said library. Parses files and generates DB updates. Will overwrite /// cover images if forceUpdate is true. /// /// Library to scan against /// Don't perform optimization checks, defaults to false [Queue(TaskScheduler.ScanQueue)] [DisableConcurrentExecution(60 * 60 * 60)] [AutomaticRetry(Attempts = 3, OnAttemptsExceeded = AttemptsExceededAction.Delete)] Task ScanLibrary(int libraryId, bool forceUpdate = false, bool isSingleScan = true); [Queue(TaskScheduler.ScanQueue)] [DisableConcurrentExecution(60 * 60 * 60)] [AutomaticRetry(Attempts = 3, OnAttemptsExceeded = AttemptsExceededAction.Delete)] Task ScanLibraries(bool forceUpdate = false); [Queue(TaskScheduler.ScanQueue)] [DisableConcurrentExecution(60 * 60 * 60)] [AutomaticRetry(Attempts = 3, OnAttemptsExceeded = AttemptsExceededAction.Delete)] Task ScanSeries(int seriesId, bool bypassFolderOptimizationChecks = true); Task ScanFolder(string folder); Task AnalyzeFiles(); } public enum ScanCancelReason { /// /// Don't cancel, everything is good /// NoCancel = 0, /// /// A folder is completely empty or missing /// FolderMount = 1, /// /// There has been no change to the filesystem since last scan /// NoChange = 2, /// /// The underlying folder is missing /// FolderMissing = 3 } /** * Responsible for Scanning the disk and importing/updating/deleting files -> DB entities. */ public class ScannerService : IScannerService { public const string Name = "ScannerService"; private readonly IUnitOfWork _unitOfWork; private readonly ILogger _logger; private readonly IMetadataService _metadataService; private readonly ICacheService _cacheService; private readonly IEventHub _eventHub; private readonly IDirectoryService _directoryService; private readonly IReadingItemService _readingItemService; private readonly IProcessSeries _processSeries; private readonly IWordCountAnalyzerService _wordCountAnalyzerService; public ScannerService(IUnitOfWork unitOfWork, ILogger logger, IMetadataService metadataService, ICacheService cacheService, IEventHub eventHub, IDirectoryService directoryService, IReadingItemService readingItemService, IProcessSeries processSeries, IWordCountAnalyzerService wordCountAnalyzerService) { _unitOfWork = unitOfWork; _logger = logger; _metadataService = metadataService; _cacheService = cacheService; _eventHub = eventHub; _directoryService = directoryService; _readingItemService = readingItemService; _processSeries = processSeries; _wordCountAnalyzerService = wordCountAnalyzerService; } /// /// This is only used for v0.7 to get files analyzed /// public async Task AnalyzeFiles() { _logger.LogInformation("Starting Analyze Files task"); var missingExtensions = await _unitOfWork.MangaFileRepository.GetAllWithMissingExtension(); if (missingExtensions.Count == 0) { _logger.LogInformation("Nothing to do"); return; } var sw = Stopwatch.StartNew(); foreach (var file in missingExtensions) { var fileInfo = _directoryService.FileSystem.FileInfo.New(file.FilePath); if (!fileInfo.Exists)continue; file.Extension = fileInfo.Extension.ToLowerInvariant(); file.Bytes = fileInfo.Length; _unitOfWork.MangaFileRepository.Update(file); } await _unitOfWork.CommitAsync(); _logger.LogInformation("Completed Analyze Files task in {ElapsedTime}", sw.Elapsed); } /// /// Given a generic folder path, will invoke a Series scan or Library scan. /// /// This will Schedule the job to run 1 minute in the future to allow for any close-by duplicate requests to be dropped /// public async Task ScanFolder(string folder) { Series? series = null; try { series = await _unitOfWork.SeriesRepository.GetSeriesByFolderPath(folder, SeriesIncludes.Library); } catch (InvalidOperationException ex) { if (ex.Message.Equals("Sequence contains more than one element.")) { _logger.LogCritical("[ScannerService] Multiple series map to this folder. Library scan will be used for ScanFolder"); } } // TODO: Figure out why we have the library type restriction here if (series != null && (series.Library.Type != LibraryType.Book || series.Library.Type != LibraryType.LightNovel)) { if (TaskScheduler.HasScanTaskRunningForSeries(series.Id)) { _logger.LogInformation("[ScannerService] Scan folder invoked for {Folder} but a task is already queued for this series. Dropping request", folder); return; } BackgroundJob.Schedule(() => ScanSeries(series.Id, true), TimeSpan.FromMinutes(1)); return; } // This is basically rework of what's already done in Library Watcher but is needed if invoked via API var parentDirectory = _directoryService.GetParentDirectoryName(folder); if (string.IsNullOrEmpty(parentDirectory)) return; var libraries = (await _unitOfWork.LibraryRepository.GetLibraryDtosAsync()).ToList(); var libraryFolders = libraries.SelectMany(l => l.Folders); var libraryFolder = libraryFolders.Select(Parser.NormalizePath).FirstOrDefault(f => f.Contains(parentDirectory)); if (string.IsNullOrEmpty(libraryFolder)) return; var library = libraries.Find(l => l.Folders.Select(Parser.NormalizePath).Contains(libraryFolder)); if (library != null) { if (TaskScheduler.HasScanTaskRunningForLibrary(library.Id)) { _logger.LogInformation("[ScannerService] Scan folder invoked for {Folder} but a task is already queued for this library. Dropping request", folder); return; } BackgroundJob.Schedule(() => ScanLibrary(library.Id, false, true), TimeSpan.FromMinutes(1)); } } /// /// Scans just an existing Series for changes. If the series doesn't exist, will delete it. /// /// /// Not Used. Scan series will always force [Queue(TaskScheduler.ScanQueue)] public async Task ScanSeries(int seriesId, bool bypassFolderOptimizationChecks = true) { var sw = Stopwatch.StartNew(); var series = await _unitOfWork.SeriesRepository.GetFullSeriesForSeriesIdAsync(seriesId); if (series == null) return; // This can occur when UI deletes a series but doesn't update and user re-requests update var existingChapterIdsToClean = await _unitOfWork.SeriesRepository.GetChapterIdsForSeriesAsync(new[] {seriesId}); var library = await _unitOfWork.LibraryRepository.GetLibraryForIdAsync(series.LibraryId, LibraryIncludes.Folders | LibraryIncludes.FileTypes | LibraryIncludes.ExcludePatterns); if (library == null) return; var libraryPaths = library.Folders.Select(f => f.Path).ToList(); if (await ShouldScanSeries(seriesId, library, libraryPaths, series, true) != ScanCancelReason.NoCancel) { BackgroundJob.Enqueue(() => _metadataService.GenerateCoversForSeries(series.LibraryId, seriesId, false)); BackgroundJob.Enqueue(() => _wordCountAnalyzerService.ScanSeries(library.Id, seriesId, bypassFolderOptimizationChecks)); return; } var folderPath = series.LowestFolderPath ?? series.FolderPath; if (string.IsNullOrEmpty(folderPath) || !_directoryService.Exists(folderPath)) { // We don't care if it's multiple due to new scan loop enforcing all in one root directory var files = await _unitOfWork.SeriesRepository.GetFilesForSeries(seriesId); var seriesDirs = _directoryService.FindHighestDirectoriesFromFiles(libraryPaths, files.Select(f => f.FilePath).ToList()); if (seriesDirs.Keys.Count == 0) { _logger.LogCritical("Scan Series has files spread outside a main series folder. Defaulting to library folder (this is expensive)"); await _eventHub.SendMessageAsync(MessageFactory.Info, MessageFactory.InfoEvent($"{series.Name} is not organized well and scan series will be expensive!", "Scan Series has files spread outside a main series folder. Defaulting to library folder (this is expensive)")); seriesDirs = _directoryService.FindHighestDirectoriesFromFiles(libraryPaths, files.Select(f => f.FilePath).ToList()); } folderPath = seriesDirs.Keys.FirstOrDefault(); // We should check if folderPath is a library folder path and if so, return early and tell user to correct their setup. if (!string.IsNullOrEmpty(folderPath) && libraryPaths.Contains(folderPath)) { _logger.LogCritical("[ScannerSeries] {SeriesName} scan aborted. Files for series are not in a nested folder under library path. Correct this and rescan", series.Name); await _eventHub.SendMessageAsync(MessageFactory.Error, MessageFactory.ErrorEvent($"{series.Name} scan aborted", "Files for series are not in a nested folder under library path. Correct this and rescan.")); return; } } if (string.IsNullOrEmpty(folderPath)) { _logger.LogCritical("[ScannerSeries] Scan Series could not find a single, valid folder root for files"); await _eventHub.SendMessageAsync(MessageFactory.Error, MessageFactory.ErrorEvent($"{series.Name} scan aborted", "Scan Series could not find a single, valid folder root for files")); return; } // If the series path doesn't exist anymore, it was either moved or renamed. We need to essentially delete it var parsedSeries = new Dictionary>(); await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress, MessageFactory.LibraryScanProgressEvent(library.Name, ProgressEventType.Started, series.Name)); _logger.LogInformation("Beginning file scan on {SeriesName}", series.Name); var (scanElapsedTime, processedSeries) = await ScanFiles(library, new []{ folderPath }, false, true); // Transform seen series into the parsedSeries (I think we can actually just have processedSeries be used instead TrackFoundSeriesAndFiles(parsedSeries, processedSeries); _logger.LogInformation("ScanFiles for {Series} took {Time}", series.Name, scanElapsedTime); // We now technically have all scannedSeries, we could invoke each Series to be scanned // Remove any parsedSeries keys that don't belong to our series. This can occur when users store 2 series in the same folder RemoveParsedInfosNotForSeries(parsedSeries, series); // If nothing was found, first validate any of the files still exist. If they don't then we have a deletion and can skip the rest of the logic flow if (parsedSeries.Count == 0) { var seriesFiles = (await _unitOfWork.SeriesRepository.GetFilesForSeries(series.Id)); if (!string.IsNullOrEmpty(series.FolderPath) && !seriesFiles.Where(f => f.FilePath.Contains(series.FolderPath)).Any(m => File.Exists(m.FilePath))) { try { _unitOfWork.SeriesRepository.Remove(series); await CommitAndSend(1, sw, scanElapsedTime, series); await _eventHub.SendMessageAsync(MessageFactory.SeriesRemoved, MessageFactory.SeriesRemovedEvent(seriesId, string.Empty, series.LibraryId), false); } catch (Exception ex) { _logger.LogCritical(ex, "There was an error during ScanSeries to delete the series as no files could be found. Aborting scan"); await _unitOfWork.RollbackAsync(); return; } } else { // I think we should just fail and tell user to fix their setup. This is extremely expensive for an edge case _logger.LogCritical("We weren't able to find any files in the series scan, but there should be. Please correct your naming convention or put Series in a dedicated folder. Aborting scan"); await _eventHub.SendMessageAsync(MessageFactory.Error, MessageFactory.ErrorEvent($"Error scanning {series.Name}", "We weren't able to find any files in the series scan, but there should be. Please correct your naming convention or put Series in a dedicated folder. Aborting scan")); await _unitOfWork.RollbackAsync(); return; } } // At this point, parsedSeries will have at least one key and we can perform the update. If it still doesn't, just return and don't do anything if (parsedSeries.Count == 0) return; // Don't allow any processing on files that aren't part of this series var toProcess = parsedSeries.Keys.Where(key => key.NormalizedName.Equals(series.NormalizedName) || key.NormalizedName.Equals(series.OriginalName?.ToNormalized())) .ToList(); if (toProcess.Count > 0) { await _processSeries.Prime(); } foreach (var pSeries in toProcess) { // Process Series await _processSeries.ProcessSeriesAsync(parsedSeries[pSeries], library, bypassFolderOptimizationChecks); } _processSeries.Reset(); await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress, MessageFactory.LibraryScanProgressEvent(library.Name, ProgressEventType.Ended, series.Name)); // Tell UI that this series is done await _eventHub.SendMessageAsync(MessageFactory.ScanSeries, MessageFactory.ScanSeriesEvent(library.Id, seriesId, series.Name)); await _metadataService.RemoveAbandonedMetadataKeys(); BackgroundJob.Enqueue(() => _cacheService.CleanupChapters(existingChapterIdsToClean)); BackgroundJob.Enqueue(() => _directoryService.ClearDirectory(_directoryService.CacheDirectory)); } private void TrackFoundSeriesAndFiles(Dictionary> parsedSeries, IList seenSeries) { foreach (var series in seenSeries.Where(s => s.ParsedInfos.Count > 0)) { var parsedFiles = series.ParsedInfos; parsedSeries.Add(series.ParsedSeries, parsedFiles); } } private async Task ShouldScanSeries(int seriesId, Library library, IList libraryPaths, Series series, bool bypassFolderChecks = false) { var seriesFolderPaths = (await _unitOfWork.SeriesRepository.GetFilesForSeries(seriesId)) .Select(f => _directoryService.FileSystem.FileInfo.New(f.FilePath).Directory?.FullName ?? string.Empty) .Where(f => !string.IsNullOrEmpty(f)) .Distinct() .ToList(); if (!await CheckMounts(library.Name, seriesFolderPaths)) { _logger.LogCritical( "Some of the root folders for library are not accessible. Please check that drives are connected and rescan. Scan will be aborted"); return ScanCancelReason.FolderMount; } if (!await CheckMounts(library.Name, libraryPaths)) { _logger.LogCritical( "Some of the root folders for library are not accessible. Please check that drives are connected and rescan. Scan will be aborted"); return ScanCancelReason.FolderMount; } // If all series Folder paths haven't been modified since last scan, abort (NOTE: This flow never happens as ScanSeries will always bypass) if (!bypassFolderChecks) { var allFolders = seriesFolderPaths.SelectMany(path => _directoryService.GetDirectories(path)).ToList(); allFolders.AddRange(seriesFolderPaths); try { if (allFolders.TrueForAll(folder => _directoryService.GetLastWriteTime(folder) <= series.LastFolderScanned)) { _logger.LogInformation( "[ScannerService] {SeriesName} scan has no work to do. All folders have not been changed since last scan", series.Name); await _eventHub.SendMessageAsync(MessageFactory.Info, MessageFactory.InfoEvent($"{series.Name} scan has no work to do", $"All folders have not been changed since last scan ({series.LastFolderScanned.ToString(CultureInfo.CurrentCulture)}). Scan will be aborted.")); return ScanCancelReason.NoChange; } } catch (IOException ex) { // If there is an exception it means that the folder doesn't exist. So we should delete the series _logger.LogError(ex, "[ScannerService] Scan series for {SeriesName} found the folder path no longer exists", series.Name); await _eventHub.SendMessageAsync(MessageFactory.Info, MessageFactory.ErrorEvent($"{series.Name} scan has no work to do", "The folder the series was in is missing. Delete series manually or perform a library scan.")); return ScanCancelReason.NoCancel; } } return ScanCancelReason.NoCancel; } private static void RemoveParsedInfosNotForSeries(Dictionary> parsedSeries, Series series) { var keys = parsedSeries.Keys; foreach (var key in keys.Where(key => !SeriesHelper.FindSeries(series, key))) { parsedSeries.Remove(key); } } private async Task CommitAndSend(int seriesCount, Stopwatch sw, long scanElapsedTime, Series series) { if (_unitOfWork.HasChanges()) { await _unitOfWork.CommitAsync(); _logger.LogInformation( "Processed files and {SeriesCount} series in {ElapsedScanTime} milliseconds for {SeriesName}", seriesCount, sw.ElapsedMilliseconds + scanElapsedTime, series.Name); } } /// /// Ensure that all library folders are mounted. In the case that any are empty or non-existent, emit an event to the UI via EventHub and return false /// /// /// /// private async Task CheckMounts(string libraryName, IList folders) { // Check if any of the folder roots are not available (ie disconnected from network, etc) and fail if any of them are if (folders.Any(f => !_directoryService.IsDriveMounted(f))) { _logger.LogCritical("Some of the root folders for library ({LibraryName} are not accessible. Please check that drives are connected and rescan. Scan will be aborted", libraryName); await _eventHub.SendMessageAsync(MessageFactory.Error, MessageFactory.ErrorEvent("Some of the root folders for library are not accessible. Please check that drives are connected and rescan. Scan will be aborted", string.Join(", ", folders.Where(f => !_directoryService.IsDriveMounted(f))))); return false; } // For Docker instances check if any of the folder roots are not available (ie disconnected volumes, etc) and fail if any of them are if (folders.Any(f => _directoryService.IsDirectoryEmpty(f))) { // That way logging and UI informing is all in one place with full context _logger.LogError("Some of the root folders for the library are empty. " + "Either your mount has been disconnected or you are trying to delete all series in the library. " + "Scan has be aborted. " + "Check that your mount is connected or change the library's root folder and rescan"); await _eventHub.SendMessageAsync(MessageFactory.Error, MessageFactory.ErrorEvent( $"Some of the root folders for the library, {libraryName}, are empty.", "Either your mount has been disconnected or you are trying to delete all series in the library. " + "Scan has be aborted. " + "Check that your mount is connected or change the library's root folder and rescan")); return false; } return true; } [Queue(TaskScheduler.ScanQueue)] [DisableConcurrentExecution(60 * 60 * 60)] [AutomaticRetry(Attempts = 3, OnAttemptsExceeded = AttemptsExceededAction.Delete)] public async Task ScanLibraries(bool forceUpdate = false) { _logger.LogInformation("Starting Scan of All Libraries, Forced: {Forced}", forceUpdate); foreach (var lib in await _unitOfWork.LibraryRepository.GetLibrariesAsync()) { await ScanLibrary(lib.Id, forceUpdate, true); } _processSeries.Reset(); _logger.LogInformation("Scan of All Libraries Finished"); } /// /// Scans a library for file changes. /// Will kick off a scheduled background task to refresh metadata, /// ie) all entities will be rechecked for new cover images and comicInfo.xml changes /// /// /// Defaults to false /// Defaults to true. Is this a standalone invocation or is it in a loop? [Queue(TaskScheduler.ScanQueue)] [DisableConcurrentExecution(60 * 60 * 60)] [AutomaticRetry(Attempts = 3, OnAttemptsExceeded = AttemptsExceededAction.Delete)] public async Task ScanLibrary(int libraryId, bool forceUpdate = false, bool isSingleScan = true) { var sw = Stopwatch.StartNew(); var library = await _unitOfWork.LibraryRepository.GetLibraryForIdAsync(libraryId, LibraryIncludes.Folders | LibraryIncludes.FileTypes | LibraryIncludes.ExcludePatterns); var libraryFolderPaths = library!.Folders.Select(fp => fp.Path).ToList(); if (!await CheckMounts(library.Name, libraryFolderPaths)) return; // Validations are done, now we can start actual scan _logger.LogInformation("[ScannerService] Beginning file scan on {LibraryName}", library.Name); // This doesn't work for something like M:/Manga/ and a series has library folder as root var shouldUseLibraryScan = !(await _unitOfWork.LibraryRepository.DoAnySeriesFoldersMatch(libraryFolderPaths)); if (!shouldUseLibraryScan) { _logger.LogError("Library {LibraryName} consists of one or more Series folders, using series scan", library.Name); } var (scanElapsedTime, processedSeries) = await ScanFiles(library, libraryFolderPaths, shouldUseLibraryScan, forceUpdate); var parsedSeries = new Dictionary>(); TrackFoundSeriesAndFiles(parsedSeries, processedSeries); // We need to remove any keys where there is no actual parser info var totalFiles = await ProcessParsedSeries(forceUpdate, parsedSeries, library, scanElapsedTime); UpdateLastScanned(library); _unitOfWork.LibraryRepository.Update(library); if (await _unitOfWork.CommitAsync()) { if (isSingleScan) { _processSeries.Reset(); } if (totalFiles == 0) { _logger.LogInformation( "[ScannerService] Finished library scan of {ParsedSeriesCount} series in {ElapsedScanTime} milliseconds for {LibraryName}. There were no changes", parsedSeries.Count, sw.ElapsedMilliseconds, library.Name); } else { _logger.LogInformation( "[ScannerService] Finished library scan of {TotalFiles} files and {ParsedSeriesCount} series in {ElapsedScanTime} milliseconds for {LibraryName}", totalFiles, parsedSeries.Count, sw.ElapsedMilliseconds, library.Name); } await RemoveSeriesNotFound(parsedSeries, library); } else { _logger.LogCritical( "[ScannerService] There was a critical error that resulted in a failed scan. Please check logs and rescan"); } await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress, MessageFactory.LibraryScanProgressEvent(library.Name, ProgressEventType.Ended, string.Empty)); await _metadataService.RemoveAbandonedMetadataKeys(); BackgroundJob.Enqueue(() => _directoryService.ClearDirectory(_directoryService.CacheDirectory)); } private async Task RemoveSeriesNotFound(Dictionary> parsedSeries, Library library) { try { // Could I delete anything in a Library's Series where the LastScan date is before scanStart? // NOTE: This implementation is expensive _logger.LogDebug("[ScannerService] Removing Series that were not found during the scan"); var removedSeries = await _unitOfWork.SeriesRepository.RemoveSeriesNotInList(parsedSeries.Keys.ToList(), library.Id); _logger.LogDebug("[ScannerService] Found {Count} series that needs to be removed: {SeriesList}", removedSeries.Count, removedSeries.Select(s => s.Name)); _logger.LogDebug("[ScannerService] Removing Series that were not found during the scan - complete"); await _unitOfWork.CommitAsync(); foreach (var s in removedSeries) { await _eventHub.SendMessageAsync(MessageFactory.SeriesRemoved, MessageFactory.SeriesRemovedEvent(s.Id, s.Name, s.LibraryId), false); } } catch (Exception ex) { _logger.LogCritical(ex, "[ScannerService] There was an issue deleting series for cleanup. Please check logs and rescan"); } } private async Task ProcessParsedSeries(bool forceUpdate, Dictionary> parsedSeries, Library library, long scanElapsedTime) { var toProcess = parsedSeries.Keys .Where(k => parsedSeries[k].Any() && !string.IsNullOrEmpty(parsedSeries[k][0].Filename)) .ToList(); if (toProcess.Count > 0) { // This grabs all the shared entities, like tags, genre, people. To be solved later in this refactor on how to not have blocking access. await _processSeries.Prime(); } var totalFiles = 0; //var tasks = new List(); foreach (var pSeries in toProcess) { totalFiles += parsedSeries[pSeries].Count; //tasks.Add(_processSeries.ProcessSeriesAsync(parsedSeries[pSeries], library, forceUpdate)); // We can't do Task.WhenAll because of concurrency issues. await _processSeries.ProcessSeriesAsync(parsedSeries[pSeries], library, forceUpdate); } //await Task.WhenAll(tasks); await _eventHub.SendMessageAsync(MessageFactory.NotificationProgress, MessageFactory.FileScanProgressEvent(string.Empty, library.Name, ProgressEventType.Ended)); _logger.LogInformation("[ScannerService] Finished file scan in {ScanAndUpdateTime} milliseconds. Updating database", scanElapsedTime); return totalFiles; } private static void UpdateLastScanned(Library library) { var time = DateTime.Now; foreach (var folderPath in library.Folders) { folderPath.UpdateLastScanned(time); } library.UpdateLastScanned(time); } private async Task>> ScanFiles(Library library, IEnumerable dirs, bool isLibraryScan, bool forceChecks = false) { var scanner = new ParseScannedFiles(_logger, _directoryService, _readingItemService, _eventHub); var scanWatch = Stopwatch.StartNew(); var processedSeries = await scanner.ScanLibrariesForSeries(library, dirs, isLibraryScan, await _unitOfWork.SeriesRepository.GetFolderPathMap(library.Id), forceChecks); var scanElapsedTime = scanWatch.ElapsedMilliseconds; return Tuple.Create(scanElapsedTime, processedSeries); } public static IEnumerable FindSeriesNotOnDisk(IEnumerable existingSeries, Dictionary> parsedSeries) { return existingSeries.Where(es => !ParserInfoHelpers.SeriesHasMatchingParserInfoFormat(es, parsedSeries)); } }