Kavita/API/Services/DirectoryService.cs

using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.IO;
using System.IO.Compression;
using System.Linq;
using System.Text.RegularExpressions;
using System.Threading;
using System.Threading.Tasks;
using API.Entities;
using API.Interfaces;
using API.Parser;
using Microsoft.Extensions.Logging;

namespace API.Services
{
    public class DirectoryService : IDirectoryService
    {
       private readonly ILogger<DirectoryService> _logger;
       private readonly ISeriesRepository _seriesRepository;
       private readonly ILibraryRepository _libraryRepository;
       
       private ConcurrentDictionary<string, ConcurrentBag<ParserInfo>> _scannedSeries;

       public DirectoryService(ILogger<DirectoryService> logger, 
          ISeriesRepository seriesRepository, 
          ILibraryRepository libraryRepository)
       {
          _logger = logger;
          _seriesRepository = seriesRepository;
          _libraryRepository = libraryRepository;
       }
       
       /// <summary>
       /// Given a set of regex search criteria, get files in the given path. 
       /// </summary>
       /// <param name="path">Directory to search</param>
       /// <param name="searchPatternExpression">Regex version of search pattern (ie \.mp3|\.mp4)</param>
       /// <param name="searchOption">SearchOption to use, defaults to TopDirectoryOnly</param>
       /// <returns>List of file paths</returns>
       public static IEnumerable<string> GetFiles(string path, 
          string searchPatternExpression = "",
          SearchOption searchOption = SearchOption.TopDirectoryOnly)
       {
          Regex reSearchPattern = new Regex(searchPatternExpression, RegexOptions.IgnoreCase);
          return Directory.EnumerateFiles(path, "*", searchOption)
             .Where(file =>
                reSearchPattern.IsMatch(Path.GetExtension(file)));
       }
       
       /// <summary>
        /// Lists out top-level folders for a given directory. Filters out System and Hidden folders.
        /// </summary>
        /// <param name="rootPath">Absolute path </param>
        /// <returns>List of folder names</returns>
        public IEnumerable<string> ListDirectory(string rootPath)
        {
           if (!Directory.Exists(rootPath)) return ImmutableList<string>.Empty;
            
            var di = new DirectoryInfo(rootPath);
            var dirs = di.GetDirectories()
                .Where(dir => !(dir.Attributes.HasFlag(FileAttributes.Hidden) || dir.Attributes.HasFlag(FileAttributes.System)))
                .Select(d => d.Name).ToImmutableList();
            
            
            return dirs;
        }


       /// <summary>
       /// Processes files found during a library scan. 
       /// </summary>
       /// <param name="path"></param>
       private void Process(string path)
       {
          // NOTE: In current implementation, this never runs. We can probably remove. 
          if (Directory.Exists(path))
          {
             DirectoryInfo di = new DirectoryInfo(path);
             _logger.LogDebug($"Parsing directory {di.Name}");

             var seriesName = Parser.Parser.ParseSeries(di.Name);
             if (string.IsNullOrEmpty(seriesName))
             {
                return;
             }

             // We don't need ContainsKey, this is a race condition. We can replace with TryAdd instead
             if (!_scannedSeries.ContainsKey(seriesName))
             {
                _scannedSeries.TryAdd(seriesName, new ConcurrentBag<ParserInfo>());
             }
          }
          else
          {
             var fileName = Path.GetFileName(path);
             _logger.LogDebug($"Parsing file {fileName}");

             var info = Parser.Parser.Parse(fileName);
             info.FullFilePath = path;
             if (info.Volumes == string.Empty)
             {
                return;
             }

             ConcurrentBag<ParserInfo> tempBag;
             ConcurrentBag<ParserInfo> newBag = new ConcurrentBag<ParserInfo>();
             if (_scannedSeries.TryGetValue(info.Series, out tempBag))
             {
                var existingInfos = tempBag.ToArray();
                foreach (var existingInfo in existingInfos)
                {
                   newBag.Add(existingInfo);
                }
             }
             else
             {
                tempBag = new ConcurrentBag<ParserInfo>();
             }

             newBag.Add(info);

             if (!_scannedSeries.TryUpdate(info.Series, newBag, tempBag))
             {
                _scannedSeries.TryAdd(info.Series, newBag);
             }

          }
       }
       
       private Series UpdateSeries(string seriesName, ParserInfo[] infos)
       {
          var series = _seriesRepository.GetSeriesByName(seriesName);

          if (series == null)
          {
             series = new Series()
             {
                Name = seriesName,
                OriginalName = seriesName,
                SortName = seriesName,
                Summary = ""
             };
          }
          
          var volumes = UpdateVolumes(series, infos);
          series.Volumes = volumes;
          series.CoverImage = volumes.OrderBy(x => x.Number).FirstOrDefault()?.CoverImage;
          return series;
       }

       /// <summary>
       /// Creates or Updates volumes for a given series
       /// </summary>
       /// <param name="series">Series wanting to be updated</param>
       /// <param name="infos">Parser info</param>
       /// <returns>Updated Volumes for given series</returns>
       private ICollection<Volume> UpdateVolumes(Series series, ParserInfo[] infos)
       {
          ICollection<Volume> volumes = new List<Volume>();
          IList<Volume> existingVolumes = _seriesRepository.GetVolumes(series.Id).ToList();
          //IList<Volume> existingVolumes = Task.Run(() => _seriesRepository.GetVolumesAsync(series.Id)).Result.ToList();
          foreach (var info in infos)
          {
             var existingVolume = existingVolumes.SingleOrDefault(v => v.Name == info.Volumes);
             if (existingVolume != null)
             {
                // Temp let's overwrite all files (we need to enhance to update files)
                existingVolume.Files = new List<MangaFile>()
                {
                   new MangaFile()
                   {
                      FilePath = info.File
                   }
                };
                volumes.Add(existingVolume);
             }
             else
             {
                var vol = new Volume()
                {
                   Name = info.Volumes,
                   Number = Int32.Parse(info.Volumes),
                   CoverImage = getCoverImage(info.FullFilePath),
                   Files = new List<MangaFile>()
                   {
                      new MangaFile()
                      {
                         FilePath = info.File
                      }
                   }
                };
                volumes.Add(vol);
             }
             
             Console.WriteLine($"Adding volume {volumes.Last().Number} with File: {info.File}");
          }

          return volumes;
       }

        public void ScanLibrary(int libraryId)
        {
           var library = Task.Run(() => _libraryRepository.GetLibraryForIdAsync(libraryId)).Result;
           _scannedSeries = new ConcurrentDictionary<string, ConcurrentBag<ParserInfo>>();
           _logger.LogInformation($"Beginning scan on {library.Name}");
           
           foreach (var folderPath in library.Folders)
           {
              try {
                 TraverseTreeParallelForEach(folderPath.Path, (f) =>
                 {
                    try
                    {
                       Process(f);
                    }
                    catch (FileNotFoundException exception)
                    {
                       _logger.LogError(exception, "The file could not be found");
                    }
                 });
              }
              catch (ArgumentException ex) {
                 _logger.LogError(ex, $"The directory '{folderPath}' does not exist");
              }
           }
           
           var filtered = _scannedSeries.Where(kvp => !kvp.Value.IsEmpty);
           var series = filtered.ToImmutableDictionary(v => v.Key, v => v.Value);

           // Perform DB activities
           library.Series = new List<Series>(); // Temp delete everything until we can mark items Unavailable
           foreach (var seriesKey in series.Keys)
           {
              var s = UpdateSeries(seriesKey, series[seriesKey].ToArray());
              _logger.LogInformation($"Created/Updated series {s.Name}");
              library.Series.Add(s);
           }
           
           
           
           _libraryRepository.Update(library);
           
           if (_libraryRepository.SaveAll())
           {
              _logger.LogInformation($"Scan completed on {library.Name}. Parsed {series.Keys.Count()} series.");
           }
           else
           {
              _logger.LogError("There was a critical error that resulted in a failed scan. Please rescan.");
           }
           

           _scannedSeries = null;
        }

        private static void TraverseTreeParallelForEach(string root, Action<string> action)
        {
            //Count of files traversed and timer for diagnostic output
            int fileCount = 0;
            var sw = Stopwatch.StartNew();

            // Determine whether to parallelize file processing on each folder based on processor count.
            int procCount = Environment.ProcessorCount;

            // Data structure to hold names of subfolders to be examined for files.
            Stack<string> dirs = new Stack<string>();

            if (!Directory.Exists(root)) {
                   throw new ArgumentException("The directory doesn't exist");
            }
            dirs.Push(root);

            while (dirs.Count > 0) {
               string currentDir = dirs.Pop();
               string[] subDirs;
               string[] files;

               try {
                  subDirs = Directory.GetDirectories(currentDir);
               }
               // Thrown if we do not have discovery permission on the directory.
               catch (UnauthorizedAccessException e) {
                  Console.WriteLine(e.Message);
                  continue;
               }
               // Thrown if another process has deleted the directory after we retrieved its name.
               catch (DirectoryNotFoundException e) {
                  Console.WriteLine(e.Message);
                  continue;
               }

               try {
                  files = DirectoryService.GetFiles(currentDir, Parser.Parser.MangaFileExtensions)
                     .ToArray();
               }
               catch (UnauthorizedAccessException e) {
                  Console.WriteLine(e.Message);
                  continue;
               }
               catch (DirectoryNotFoundException e) {
                  Console.WriteLine(e.Message);
                  continue;
               }
               catch (IOException e) {
                  Console.WriteLine(e.Message);
                  continue;
               }

               // Execute in parallel if there are enough files in the directory.
               // Otherwise, execute sequentially.Files are opened and processed
               // synchronously but this could be modified to perform async I/O.
               try {
                  if (files.Length < procCount) {
                     foreach (var file in files) {
                        action(file);
                        fileCount++;
                     }
                  }
                  else {
                     Parallel.ForEach(files, () => 0, (file, _, localCount) =>
                                                  { action(file);
                                                    return ++localCount;
                                                  },
                                      (c) => {
                                                Interlocked.Add(ref fileCount, c);
                                      });
                  }
               }
               catch (AggregateException ae) {
                  ae.Handle((ex) => {
                               if (ex is UnauthorizedAccessException) {
                                  // Here we just output a message and go on.
                                  Console.WriteLine(ex.Message);
                                  return true;
                               }
                               // Handle other exceptions here if necessary...

                               return false;
                  });
               }

               // Push the subdirectories onto the stack for traversal.
               // This could also be done before handing the files.
               foreach (string str in subDirs)
                  dirs.Push(str);
            }

            // For diagnostic purposes.
            Console.WriteLine("Processed {0} files in {1} milliseconds", fileCount, sw.ElapsedMilliseconds);
        }

        /// <summary>
        /// Generates byte array of cover image.
        /// Looks for first valid image file (folder.png, first jpg/png file)
        /// </summary>
        /// <param name="filepath"></param>
        /// <returns></returns>
        private byte[] getCoverImage(string filepath)
        {
           // TODO: Sort and file type
           // if file not zip (folder or txt)
           using (ZipArchive archive = ZipFile.OpenRead(filepath))
           {

              if (archive.Entries.Count <= 0) {return null;}
              var stream = archive.Entries[0].Open();
              byte[] data;
              using (var ms = new MemoryStream())
              {
                 stream.CopyTo(ms);
                 data = ms.ToArray();
              }

              return data;
           }
         
        }
    }
}