Comic Rework, New Scanner, Foundation Overahul (is this a full release?) (#2780)

API/Services/Tasks/Scanner/Parser/BasicParser.cs

@@ -0,0 +1,117 @@
+using System.IO;
+using API.Data.Metadata;
+using API.Entities.Enums;
+
+namespace API.Services.Tasks.Scanner.Parser;
+#nullable enable
+
+/// <summary>
+/// This is the basic parser for handling Manga/Comic/Book libraries. This was previously DefaultParser before splitting each parser
+/// into their own classes.
+/// </summary>
+public class BasicParser(IDirectoryService directoryService, IDefaultParser imageParser) : DefaultParser(directoryService)
+{
+    public override ParserInfo? Parse(string filePath, string rootPath, string libraryRoot, LibraryType type, ComicInfo? comicInfo = null)
+    {
+        var fileName = directoryService.FileSystem.Path.GetFileNameWithoutExtension(filePath);
+        // TODO: Potential Bug: This will return null, but on Image libraries, if all images, we would want to include this.
+        if (type != LibraryType.Image && Parser.IsCoverImage(directoryService.FileSystem.Path.GetFileName(filePath))) return null;
+
+        if (Parser.IsImage(filePath))
+        {
+            return imageParser.Parse(filePath, rootPath, libraryRoot, LibraryType.Image, comicInfo);
+        }
+
+        var ret = new ParserInfo()
+        {
+            Filename = Path.GetFileName(filePath),
+            Format = Parser.ParseFormat(filePath),
+            Title = Parser.RemoveExtensionIfSupported(fileName),
+            FullFilePath = filePath,
+            Series = string.Empty,
+            ComicInfo = comicInfo
+        };
+
+        // This will be called if the epub is already parsed once then we call and merge the information, if the
+        if (Parser.IsEpub(filePath))
+        {
+            ret.Chapters = Parser.ParseChapter(fileName);
+            ret.Series = Parser.ParseSeries(fileName);
+            ret.Volumes = Parser.ParseVolume(fileName);
+        }
+        else
+        {
+            ret.Chapters = type == LibraryType.Comic
+                ? Parser.ParseComicChapter(fileName)
+                : Parser.ParseChapter(fileName);
+            ret.Series = type == LibraryType.Comic ? Parser.ParseComicSeries(fileName) : Parser.ParseSeries(fileName);
+            ret.Volumes = type == LibraryType.Comic ? Parser.ParseComicVolume(fileName) : Parser.ParseVolume(fileName);
+        }
+
+        if (ret.Series == string.Empty || Parser.IsImage(filePath))
+        {
+            // Try to parse information out of each folder all the way to rootPath
+            ParseFromFallbackFolders(filePath, rootPath, type, ref ret);
+        }
+
+        var edition = Parser.ParseEdition(fileName);
+        if (!string.IsNullOrEmpty(edition))
+        {
+            ret.Series = Parser.CleanTitle(ret.Series.Replace(edition, string.Empty), type is LibraryType.Comic);
+            ret.Edition = edition;
+        }
+
+        var isSpecial = type == LibraryType.Comic ? Parser.IsComicSpecial(fileName) : Parser.IsMangaSpecial(fileName);
+        // We must ensure that we can only parse a special out. As some files will have v20 c171-180+Omake and that
+        // could cause a problem as Omake is a special term, but there is valid volume/chapter information.
+        if (ret.Chapters == Parser.DefaultChapter && ret.Volumes == Parser.LooseLeafVolume && isSpecial)
+        {
+            ret.IsSpecial = true;
+            ParseFromFallbackFolders(filePath, rootPath, type, ref ret); // NOTE: This can cause some complications, we should try to be a bit less aggressive to fallback to folder
+        }
+
+        // If we are a special with marker, we need to ensure we use the correct series name. we can do this by falling back to Folder name
+        if (Parser.HasSpecialMarker(fileName))
+        {
+            ret.IsSpecial = true;
+            ret.SpecialIndex = Parser.ParseSpecialIndex(fileName);
+            ret.Chapters = Parser.DefaultChapter;
+            ret.Volumes = Parser.SpecialVolume;
+
+            ParseFromFallbackFolders(filePath, rootPath, type, ref ret);
+        }
+
+        if (string.IsNullOrEmpty(ret.Series))
+        {
+            ret.Series = Parser.CleanTitle(fileName, type is LibraryType.Comic);
+        }
+
+        // Pdfs may have .pdf in the series name, remove that
+        if (Parser.IsPdf(filePath) && ret.Series.ToLower().EndsWith(".pdf"))
+        {
+            ret.Series = ret.Series.Substring(0, ret.Series.Length - ".pdf".Length);
+        }
+
+        // Patch in other information from ComicInfo
+        UpdateFromComicInfo(ret);
+
+        // v0.8.x: Introducing a change where Specials will go in a separate Volume with a reserved number
+        if (ret.IsSpecial)
+        {
+            ret.Volumes = Parser.SpecialVolume;
+        }
+
+        return ret.Series == string.Empty ? null : ret;
+    }
+
+    /// <summary>
+    /// Applicable for everything but ComicVine and Image library types
+    /// </summary>
+    /// <param name="filePath"></param>
+    /// <param name="type"></param>
+    /// <returns></returns>
+    public override bool IsApplicable(string filePath, LibraryType type)
+    {
+        return type != LibraryType.ComicVine && type != LibraryType.Image;
+    }
+}