diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
index cdd72de1c..805c3b61d 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -28,7 +28,7 @@ body:
label: Kavita Version Number - If you don't see your version number listed, please update Kavita and see if your issue still persists.
multiple: false
options:
- - 0.8.6.2 - Stable
+ - 0.8.7 - Stable
- Nightly Testing Branch
validations:
required: true
diff --git a/API.Benchmark/API.Benchmark.csproj b/API.Benchmark/API.Benchmark.csproj
index 38ec425fe..ec9c1884f 100644
--- a/API.Benchmark/API.Benchmark.csproj
+++ b/API.Benchmark/API.Benchmark.csproj
@@ -10,8 +10,8 @@
-
-
+
+
@@ -26,5 +26,10 @@
Always
+
+
+ PreserveNewest
+
+
diff --git a/API.Benchmark/Data/AesopsFables.epub b/API.Benchmark/Data/AesopsFables.epub
new file mode 100644
index 000000000..d2ab9a8b2
Binary files /dev/null and b/API.Benchmark/Data/AesopsFables.epub differ
diff --git a/API.Benchmark/KoreaderHashBenchmark.cs b/API.Benchmark/KoreaderHashBenchmark.cs
new file mode 100644
index 000000000..c0abfd2ad
--- /dev/null
+++ b/API.Benchmark/KoreaderHashBenchmark.cs
@@ -0,0 +1,41 @@
+using API.Helpers.Builders;
+using BenchmarkDotNet.Attributes;
+using BenchmarkDotNet.Order;
+using System;
+using API.Entities.Enums;
+
+namespace API.Benchmark
+{
+ [StopOnFirstError]
+ [MemoryDiagnoser]
+ [RankColumn]
+ [Orderer(SummaryOrderPolicy.FastestToSlowest)]
+ [SimpleJob(launchCount: 1, warmupCount: 5, invocationCount: 20)]
+ public class KoreaderHashBenchmark
+ {
+ private const string sourceEpub = "./Data/AesopsFables.epub";
+
+ [Benchmark(Baseline = true)]
+ public void TestBuildManga_baseline()
+ {
+ var file = new MangaFileBuilder(sourceEpub, MangaFormat.Epub)
+ .Build();
+ if (file == null)
+ {
+ throw new Exception("Failed to build manga file");
+ }
+ }
+
+ [Benchmark]
+ public void TestBuildManga_withHash()
+ {
+ var file = new MangaFileBuilder(sourceEpub, MangaFormat.Epub)
+ .WithHash()
+ .Build();
+ if (file == null)
+ {
+ throw new Exception("Failed to build manga file");
+ }
+ }
+ }
+}
diff --git a/API.Tests/API.Tests.csproj b/API.Tests/API.Tests.csproj
index 9e7fc3a02..a571a6e72 100644
--- a/API.Tests/API.Tests.csproj
+++ b/API.Tests/API.Tests.csproj
@@ -6,13 +6,13 @@
-
-
+
+
-
+
runtime; build; native; contentfiles; analyzers; buildtransitive
all
@@ -36,4 +36,10 @@
+
+
+ PreserveNewest
+
+
+
diff --git a/API.Tests/Data/AesopsFables.epub b/API.Tests/Data/AesopsFables.epub
new file mode 100644
index 000000000..d2ab9a8b2
Binary files /dev/null and b/API.Tests/Data/AesopsFables.epub differ
diff --git a/API.Tests/Extensions/QueryableExtensionsTests.cs b/API.Tests/Extensions/QueryableExtensionsTests.cs
index 866e0202c..96d74b46d 100644
--- a/API.Tests/Extensions/QueryableExtensionsTests.cs
+++ b/API.Tests/Extensions/QueryableExtensionsTests.cs
@@ -67,7 +67,7 @@ public class QueryableExtensionsTests
[Theory]
[InlineData(true, 2)]
- [InlineData(false, 1)]
+ [InlineData(false, 2)]
public void RestrictAgainstAgeRestriction_Genre_ShouldRestrictEverythingAboveTeen(bool includeUnknowns, int expectedCount)
{
var items = new List()
@@ -94,7 +94,7 @@ public class QueryableExtensionsTests
[Theory]
[InlineData(true, 2)]
- [InlineData(false, 1)]
+ [InlineData(false, 2)]
public void RestrictAgainstAgeRestriction_Tag_ShouldRestrictEverythingAboveTeen(bool includeUnknowns, int expectedCount)
{
var items = new List()
diff --git a/API.Tests/Helpers/BookSortTitlePrefixHelperTests.cs b/API.Tests/Helpers/BookSortTitlePrefixHelperTests.cs
new file mode 100644
index 000000000..e1f585806
--- /dev/null
+++ b/API.Tests/Helpers/BookSortTitlePrefixHelperTests.cs
@@ -0,0 +1,178 @@
+using API.Helpers;
+using Xunit;
+
+namespace API.Tests.Helpers;
+
+public class BookSortTitlePrefixHelperTests
+{
+ [Theory]
+ [InlineData("The Avengers", "Avengers")]
+ [InlineData("A Game of Thrones", "Game of Thrones")]
+ [InlineData("An American Tragedy", "American Tragedy")]
+ public void TestEnglishPrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("El Quijote", "Quijote")]
+ [InlineData("La Casa de Papel", "Casa de Papel")]
+ [InlineData("Los Miserables", "Miserables")]
+ [InlineData("Las Vegas", "Vegas")]
+ [InlineData("Un Mundo Feliz", "Mundo Feliz")]
+ [InlineData("Una Historia", "Historia")]
+ public void TestSpanishPrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("Le Petit Prince", "Petit Prince")]
+ [InlineData("La Belle et la Bête", "Belle et la Bête")]
+ [InlineData("Les Misérables", "Misérables")]
+ [InlineData("Un Amour de Swann", "Amour de Swann")]
+ [InlineData("Une Vie", "Vie")]
+ [InlineData("Des Souris et des Hommes", "Souris et des Hommes")]
+ public void TestFrenchPrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("Der Herr der Ringe", "Herr der Ringe")]
+ [InlineData("Die Verwandlung", "Verwandlung")]
+ [InlineData("Das Kapital", "Kapital")]
+ [InlineData("Ein Sommernachtstraum", "Sommernachtstraum")]
+ [InlineData("Eine Geschichte", "Geschichte")]
+ public void TestGermanPrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("Il Nome della Rosa", "Nome della Rosa")]
+ [InlineData("La Divina Commedia", "Divina Commedia")]
+ [InlineData("Lo Hobbit", "Hobbit")]
+ [InlineData("Gli Ultimi", "Ultimi")]
+ [InlineData("Le Città Invisibili", "Città Invisibili")]
+ [InlineData("Un Giorno", "Giorno")]
+ [InlineData("Una Notte", "Notte")]
+ public void TestItalianPrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("O Alquimista", "Alquimista")]
+ [InlineData("A Moreninha", "Moreninha")]
+ [InlineData("Os Lusíadas", "Lusíadas")]
+ [InlineData("As Meninas", "Meninas")]
+ [InlineData("Um Defeito de Cor", "Defeito de Cor")]
+ [InlineData("Uma História", "História")]
+ public void TestPortuguesePrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("", "")] // Empty string returns empty
+ [InlineData("Book", "Book")] // Single word, no change
+ [InlineData("Avengers", "Avengers")] // No prefix, no change
+ public void TestNoPrefixCases(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("The", "The")] // Just a prefix word alone
+ [InlineData("A", "A")] // Just single letter prefix alone
+ [InlineData("Le", "Le")] // French prefix alone
+ public void TestPrefixWordAlone(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("THE AVENGERS", "AVENGERS")] // All caps
+ [InlineData("the avengers", "avengers")] // All lowercase
+ [InlineData("The AVENGERS", "AVENGERS")] // Mixed case
+ [InlineData("tHe AvEnGeRs", "AvEnGeRs")] // Random case
+ public void TestCaseInsensitivity(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("Then Came You", "Then Came You")] // "The" + "n" = not a prefix
+ [InlineData("And Then There Were None", "And Then There Were None")] // "An" + "d" = not a prefix
+ [InlineData("Elsewhere", "Elsewhere")] // "El" + "sewhere" = not a prefix (no space)
+ [InlineData("Lesson Plans", "Lesson Plans")] // "Les" + "son" = not a prefix (no space)
+ [InlineData("Theory of Everything", "Theory of Everything")] // "The" + "ory" = not a prefix
+ public void TestFalsePositivePrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("The ", "The ")] // Prefix with only space after - returns original
+ [InlineData("La ", "La ")] // Same for other languages
+ [InlineData("El ", "El ")] // Same for Spanish
+ public void TestPrefixWithOnlySpaceAfter(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("The Multiple Spaces", " Multiple Spaces")] // Doesn't trim extra spaces from remainder
+ [InlineData("Le Petit Prince", " Petit Prince")] // Leading space preserved in remainder
+ public void TestSpaceHandling(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("The The Matrix", "The Matrix")] // Removes first "The", leaves second
+ [InlineData("A A Clockwork Orange", "A Clockwork Orange")] // Removes first "A", leaves second
+ [InlineData("El El Cid", "El Cid")] // Spanish version
+ public void TestRepeatedPrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("L'Étranger", "L'Étranger")] // French contraction - no space, no change
+ [InlineData("D'Artagnan", "D'Artagnan")] // Contraction - no space, no change
+ [InlineData("The-Matrix", "The-Matrix")] // Hyphen instead of space - no change
+ [InlineData("The.Avengers", "The.Avengers")] // Period instead of space - no change
+ public void TestNonSpaceSeparators(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("三国演义", "三国演义")] // Chinese - no processing due to CJK detection
+ [InlineData("한국어", "한국어")] // Korean - not in CJK range, would be processed normally
+ public void TestCjkLanguages(string inputString, string expected)
+ {
+ // NOTE: These don't do anything, I am waiting for user input on if these are needed
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("नमस्ते दुनिया", "नमस्ते दुनिया")] // Hindi - not CJK, processed normally
+ [InlineData("مرحبا بالعالم", "مرحبا بالعالم")] // Arabic - not CJK, processed normally
+ [InlineData("שלום עולם", "שלום עולם")] // Hebrew - not CJK, processed normally
+ public void TestNonLatinNonCjkScripts(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+
+ [Theory]
+ [InlineData("в мире", "мире")] // Russian "в" (in) - should be removed
+ [InlineData("на столе", "столе")] // Russian "на" (on) - should be removed
+ [InlineData("с друзьями", "друзьями")] // Russian "с" (with) - should be removed
+ public void TestRussianPrefixes(string inputString, string expected)
+ {
+ Assert.Equal(expected, BookSortTitlePrefixHelper.GetSortTitle(inputString));
+ }
+}
diff --git a/API.Tests/Helpers/KoreaderHelperTests.cs b/API.Tests/Helpers/KoreaderHelperTests.cs
new file mode 100644
index 000000000..66d287a5d
--- /dev/null
+++ b/API.Tests/Helpers/KoreaderHelperTests.cs
@@ -0,0 +1,60 @@
+using API.DTOs.Koreader;
+using API.DTOs.Progress;
+using API.Helpers;
+using System.Runtime.CompilerServices;
+using Xunit;
+
+namespace API.Tests.Helpers;
+
+
+public class KoreaderHelperTests
+{
+
+ [Theory]
+ [InlineData("/body/DocFragment[11]/body/div/a", 10, null)]
+ [InlineData("/body/DocFragment[1]/body/div/p[40]", 0, 40)]
+ [InlineData("/body/DocFragment[8]/body/div/p[28]/text().264", 7, 28)]
+ public void GetEpubPositionDto(string koreaderPosition, int page, int? pNumber)
+ {
+ var expected = EmptyProgressDto();
+ expected.BookScrollId = pNumber.HasValue ? $"//html[1]/BODY/APP-ROOT[1]/DIV[1]/DIV[1]/DIV[1]/APP-BOOK-READER[1]/DIV[1]/DIV[2]/DIV[1]/DIV[1]/DIV[1]/P[{pNumber}]" : null;
+ expected.PageNum = page;
+ var actual = EmptyProgressDto();
+
+ KoreaderHelper.UpdateProgressDto(actual, koreaderPosition);
+ Assert.Equal(expected.BookScrollId, actual.BookScrollId);
+ Assert.Equal(expected.PageNum, actual.PageNum);
+ }
+
+
+ [Theory]
+ [InlineData("//html[1]/BODY/APP-ROOT[1]/DIV[1]/DIV[1]/DIV[1]/APP-BOOK-READER[1]/DIV[1]/DIV[2]/DIV[1]/DIV[1]/DIV[1]/P[20]", 5, "/body/DocFragment[6]/body/div/p[20]")]
+ [InlineData(null, 10, "/body/DocFragment[11]/body/div/a")]
+ public void GetKoreaderPosition(string scrollId, int page, string koreaderPosition)
+ {
+ var given = EmptyProgressDto();
+ given.BookScrollId = scrollId;
+ given.PageNum = page;
+
+ Assert.Equal(koreaderPosition, KoreaderHelper.GetKoreaderPosition(given));
+ }
+
+ [Theory]
+ [InlineData("./Data/AesopsFables.epub", "8795ACA4BF264B57C1EEDF06A0CEE688")]
+ public void GetKoreaderHash(string filePath, string hash)
+ {
+ Assert.Equal(KoreaderHelper.HashContents(filePath), hash);
+ }
+
+ private ProgressDto EmptyProgressDto()
+ {
+ return new ProgressDto
+ {
+ ChapterId = 0,
+ PageNum = 0,
+ VolumeId = 0,
+ SeriesId = 0,
+ LibraryId = 0
+ };
+ }
+}
diff --git a/API.Tests/Parsers/ComicVineParserTests.cs b/API.Tests/Parsers/ComicVineParserTests.cs
index f01e98afd..2f4fd568e 100644
--- a/API.Tests/Parsers/ComicVineParserTests.cs
+++ b/API.Tests/Parsers/ComicVineParserTests.cs
@@ -36,7 +36,7 @@ public class ComicVineParserTests
public void Parse_SeriesWithComicInfo()
{
var actual = _parser.Parse("C:/Comics/Birds of Prey (2002)/Birds of Prey 001 (2002).cbz", "C:/Comics/Birds of Prey (2002)/",
- RootDirectory, LibraryType.ComicVine, new ComicInfo()
+ RootDirectory, LibraryType.ComicVine, true, new ComicInfo()
{
Series = "Birds of Prey",
Volume = "2002"
@@ -54,7 +54,7 @@ public class ComicVineParserTests
public void Parse_SeriesWithDirectoryNameAsSeriesYear()
{
var actual = _parser.Parse("C:/Comics/Birds of Prey (2002)/Birds of Prey 001 (2002).cbz", "C:/Comics/Birds of Prey (2002)/",
- RootDirectory, LibraryType.ComicVine, null);
+ RootDirectory, LibraryType.ComicVine, true, null);
Assert.NotNull(actual);
Assert.Equal("Birds of Prey (2002)", actual.Series);
@@ -69,7 +69,7 @@ public class ComicVineParserTests
public void Parse_SeriesWithADirectoryNameAsSeriesYear()
{
var actual = _parser.Parse("C:/Comics/DC Comics/Birds of Prey (1999)/Birds of Prey 001 (1999).cbz", "C:/Comics/DC Comics/",
- RootDirectory, LibraryType.ComicVine, null);
+ RootDirectory, LibraryType.ComicVine, true, null);
Assert.NotNull(actual);
Assert.Equal("Birds of Prey (1999)", actual.Series);
@@ -84,7 +84,7 @@ public class ComicVineParserTests
public void Parse_FallbackToDirectoryNameOnly()
{
var actual = _parser.Parse("C:/Comics/DC Comics/Blood Syndicate/Blood Syndicate 001 (1999).cbz", "C:/Comics/DC Comics/",
- RootDirectory, LibraryType.ComicVine, null);
+ RootDirectory, LibraryType.ComicVine, true, null);
Assert.NotNull(actual);
Assert.Equal("Blood Syndicate", actual.Series);
diff --git a/API.Tests/Parsers/DefaultParserTests.cs b/API.Tests/Parsers/DefaultParserTests.cs
index 733b55d62..244c08b97 100644
--- a/API.Tests/Parsers/DefaultParserTests.cs
+++ b/API.Tests/Parsers/DefaultParserTests.cs
@@ -33,7 +33,7 @@ public class DefaultParserTests
[InlineData("C:/", "C:/Something Random/Mujaki no Rakuen SP01.cbz", "Something Random")]
public void ParseFromFallbackFolders_FallbackShouldParseSeries(string rootDir, string inputPath, string expectedSeries)
{
- var actual = _defaultParser.Parse(inputPath, rootDir, rootDir, LibraryType.Manga, null);
+ var actual = _defaultParser.Parse(inputPath, rootDir, rootDir, LibraryType.Manga, true, null);
if (actual == null)
{
Assert.NotNull(actual);
@@ -74,7 +74,7 @@ public class DefaultParserTests
fs.AddFile(inputFile, new MockFileData(""));
var ds = new DirectoryService(Substitute.For>(), fs);
var parser = new BasicParser(ds, new ImageParser(ds));
- var actual = parser.Parse(inputFile, rootDirectory, rootDirectory, LibraryType.Manga, null);
+ var actual = parser.Parse(inputFile, rootDirectory, rootDirectory, LibraryType.Manga, true, null);
_defaultParser.ParseFromFallbackFolders(inputFile, rootDirectory, LibraryType.Manga, ref actual);
Assert.Equal(expectedParseInfo, actual.Series);
}
@@ -90,7 +90,7 @@ public class DefaultParserTests
fs.AddFile(inputFile, new MockFileData(""));
var ds = new DirectoryService(Substitute.For>(), fs);
var parser = new BasicParser(ds, new ImageParser(ds));
- var actual = parser.Parse(inputFile, rootDirectory, rootDirectory, LibraryType.Manga, null);
+ var actual = parser.Parse(inputFile, rootDirectory, rootDirectory, LibraryType.Manga, true, null);
_defaultParser.ParseFromFallbackFolders(inputFile, rootDirectory, LibraryType.Manga, ref actual);
Assert.Equal(expectedParseInfo, actual.Series);
}
@@ -251,7 +251,7 @@ public class DefaultParserTests
foreach (var file in expected.Keys)
{
var expectedInfo = expected[file];
- var actual = _defaultParser.Parse(file, rootPath, rootPath, LibraryType.Manga, null);
+ var actual = _defaultParser.Parse(file, rootPath, rootPath, LibraryType.Manga, true, null);
if (expectedInfo == null)
{
Assert.Null(actual);
@@ -289,7 +289,7 @@ public class DefaultParserTests
Chapters = "8", Filename = "13.jpg", Format = MangaFormat.Image,
FullFilePath = filepath, IsSpecial = false
};
- var actual2 = _defaultParser.Parse(filepath, @"E:/Manga/Monster #8", "E:/Manga", LibraryType.Manga, null);
+ var actual2 = _defaultParser.Parse(filepath, @"E:/Manga/Monster #8", "E:/Manga", LibraryType.Manga, true, null);
Assert.NotNull(actual2);
_testOutputHelper.WriteLine($"Validating {filepath}");
Assert.Equal(expectedInfo2.Format, actual2.Format);
@@ -315,7 +315,7 @@ public class DefaultParserTests
FullFilePath = filepath, IsSpecial = false
};
- actual2 = _defaultParser.Parse(filepath, @"E:/Manga/Extra layer for no reason/", "E:/Manga",LibraryType.Manga, null);
+ actual2 = _defaultParser.Parse(filepath, @"E:/Manga/Extra layer for no reason/", "E:/Manga",LibraryType.Manga, true, null);
Assert.NotNull(actual2);
_testOutputHelper.WriteLine($"Validating {filepath}");
Assert.Equal(expectedInfo2.Format, actual2.Format);
@@ -341,7 +341,7 @@ public class DefaultParserTests
FullFilePath = filepath, IsSpecial = false
};
- actual2 = _defaultParser.Parse(filepath, @"E:/Manga/Extra layer for no reason/", "E:/Manga", LibraryType.Manga, null);
+ actual2 = _defaultParser.Parse(filepath, @"E:/Manga/Extra layer for no reason/", "E:/Manga", LibraryType.Manga, true, null);
Assert.NotNull(actual2);
_testOutputHelper.WriteLine($"Validating {filepath}");
Assert.Equal(expectedInfo2.Format, actual2.Format);
@@ -383,7 +383,7 @@ public class DefaultParserTests
FullFilePath = filepath
};
- var actual = parser.Parse(filepath, rootPath, rootPath, LibraryType.Manga, null);
+ var actual = parser.Parse(filepath, rootPath, rootPath, LibraryType.Manga, true, null);
Assert.NotNull(actual);
_testOutputHelper.WriteLine($"Validating {filepath}");
@@ -412,7 +412,7 @@ public class DefaultParserTests
FullFilePath = filepath
};
- actual = parser.Parse(filepath, rootPath, rootPath, LibraryType.Manga, null);
+ actual = parser.Parse(filepath, rootPath, rootPath, LibraryType.Manga, true, null);
Assert.NotNull(actual);
_testOutputHelper.WriteLine($"Validating {filepath}");
Assert.Equal(expected.Format, actual.Format);
@@ -475,7 +475,7 @@ public class DefaultParserTests
foreach (var file in expected.Keys)
{
var expectedInfo = expected[file];
- var actual = _defaultParser.Parse(file, rootPath, rootPath, LibraryType.Comic, null);
+ var actual = _defaultParser.Parse(file, rootPath, rootPath, LibraryType.Comic, true, null);
if (expectedInfo == null)
{
Assert.Null(actual);
diff --git a/API.Tests/Parsers/ImageParserTests.cs b/API.Tests/Parsers/ImageParserTests.cs
index f95c98ddf..63df1926e 100644
--- a/API.Tests/Parsers/ImageParserTests.cs
+++ b/API.Tests/Parsers/ImageParserTests.cs
@@ -34,7 +34,7 @@ public class ImageParserTests
public void Parse_SeriesWithDirectoryName()
{
var actual = _parser.Parse("C:/Comics/Birds of Prey/Chapter 01/01.jpg", "C:/Comics/Birds of Prey/",
- RootDirectory, LibraryType.Image, null);
+ RootDirectory, LibraryType.Image, true, null);
Assert.NotNull(actual);
Assert.Equal("Birds of Prey", actual.Series);
@@ -48,7 +48,7 @@ public class ImageParserTests
public void Parse_SeriesWithNoNestedChapter()
{
var actual = _parser.Parse("C:/Comics/Birds of Prey/Chapter 01 page 01.jpg", "C:/Comics/",
- RootDirectory, LibraryType.Image, null);
+ RootDirectory, LibraryType.Image, true, null);
Assert.NotNull(actual);
Assert.Equal("Birds of Prey", actual.Series);
@@ -62,7 +62,7 @@ public class ImageParserTests
public void Parse_SeriesWithLooseImages()
{
var actual = _parser.Parse("C:/Comics/Birds of Prey/page 01.jpg", "C:/Comics/",
- RootDirectory, LibraryType.Image, null);
+ RootDirectory, LibraryType.Image, true, null);
Assert.NotNull(actual);
Assert.Equal("Birds of Prey", actual.Series);
diff --git a/API.Tests/Parsers/PdfParserTests.cs b/API.Tests/Parsers/PdfParserTests.cs
index 72088526d..08bf9f25d 100644
--- a/API.Tests/Parsers/PdfParserTests.cs
+++ b/API.Tests/Parsers/PdfParserTests.cs
@@ -35,7 +35,7 @@ public class PdfParserTests
{
var actual = _parser.Parse("C:/Books/A Dictionary of Japanese Food - Ingredients and Culture/A Dictionary of Japanese Food - Ingredients and Culture.pdf",
"C:/Books/A Dictionary of Japanese Food - Ingredients and Culture/",
- RootDirectory, LibraryType.Book, null);
+ RootDirectory, LibraryType.Book, true, null);
Assert.NotNull(actual);
Assert.Equal("A Dictionary of Japanese Food - Ingredients and Culture", actual.Series);
diff --git a/API.Tests/Parsing/ImageParsingTests.cs b/API.Tests/Parsing/ImageParsingTests.cs
index 3d78d9372..362b4b08c 100644
--- a/API.Tests/Parsing/ImageParsingTests.cs
+++ b/API.Tests/Parsing/ImageParsingTests.cs
@@ -34,7 +34,7 @@ public class ImageParsingTests
Chapters = "8", Filename = "13.jpg", Format = MangaFormat.Image,
FullFilePath = filepath, IsSpecial = false
};
- var actual2 = _parser.Parse(filepath, @"E:\Manga\Monster #8", "E:/Manga", LibraryType.Image, null);
+ var actual2 = _parser.Parse(filepath, @"E:\Manga\Monster #8", "E:/Manga", LibraryType.Image, true, null);
Assert.NotNull(actual2);
_testOutputHelper.WriteLine($"Validating {filepath}");
Assert.Equal(expectedInfo2.Format, actual2.Format);
@@ -60,7 +60,7 @@ public class ImageParsingTests
FullFilePath = filepath, IsSpecial = false
};
- actual2 = _parser.Parse(filepath, @"E:\Manga\Extra layer for no reason\", "E:/Manga", LibraryType.Image, null);
+ actual2 = _parser.Parse(filepath, @"E:\Manga\Extra layer for no reason\", "E:/Manga", LibraryType.Image, true, null);
Assert.NotNull(actual2);
_testOutputHelper.WriteLine($"Validating {filepath}");
Assert.Equal(expectedInfo2.Format, actual2.Format);
@@ -86,7 +86,7 @@ public class ImageParsingTests
FullFilePath = filepath, IsSpecial = false
};
- actual2 = _parser.Parse(filepath, @"E:\Manga\Extra layer for no reason\", "E:/Manga", LibraryType.Image, null);
+ actual2 = _parser.Parse(filepath, @"E:\Manga\Extra layer for no reason\", "E:/Manga", LibraryType.Image, true, null);
Assert.NotNull(actual2);
_testOutputHelper.WriteLine($"Validating {filepath}");
Assert.Equal(expectedInfo2.Format, actual2.Format);
diff --git a/API.Tests/Parsing/MangaParsingTests.cs b/API.Tests/Parsing/MangaParsingTests.cs
index 8b93c5f90..53f2bc4c9 100644
--- a/API.Tests/Parsing/MangaParsingTests.cs
+++ b/API.Tests/Parsing/MangaParsingTests.cs
@@ -68,10 +68,8 @@ public class MangaParsingTests
[InlineData("Манга Тома 1-4", "1-4")]
[InlineData("Манга Том 1-4", "1-4")]
[InlineData("조선왕조실톡 106화", "106")]
- [InlineData("죽음 13회", "13")]
[InlineData("동의보감 13장", "13")]
[InlineData("몰?루 아카이브 7.5권", "7.5")]
- [InlineData("주술회전 1.5권", "1.5")]
[InlineData("63권#200", "63")]
[InlineData("시즌34삽화2", "34")]
[InlineData("Accel World Chapter 001 Volume 002", "2")]
diff --git a/API.Tests/Repository/GenreRepositoryTests.cs b/API.Tests/Repository/GenreRepositoryTests.cs
new file mode 100644
index 000000000..d197a91ba
--- /dev/null
+++ b/API.Tests/Repository/GenreRepositoryTests.cs
@@ -0,0 +1,280 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using API.DTOs.Metadata.Browse;
+using API.Entities;
+using API.Entities.Enums;
+using API.Entities.Metadata;
+using API.Helpers;
+using API.Helpers.Builders;
+using Xunit;
+
+namespace API.Tests.Repository;
+
+public class GenreRepositoryTests : AbstractDbTest
+{
+ private AppUser _fullAccess;
+ private AppUser _restrictedAccess;
+ private AppUser _restrictedAgeAccess;
+
+ protected override async Task ResetDb()
+ {
+ Context.Genre.RemoveRange(Context.Genre);
+ Context.Library.RemoveRange(Context.Library);
+ await Context.SaveChangesAsync();
+ }
+
+ private TestGenreSet CreateTestGenres()
+ {
+ return new TestGenreSet
+ {
+ SharedSeriesChaptersGenre = new GenreBuilder("Shared Series Chapter Genre").Build(),
+ SharedSeriesGenre = new GenreBuilder("Shared Series Genre").Build(),
+ SharedChaptersGenre = new GenreBuilder("Shared Chapters Genre").Build(),
+ Lib0SeriesChaptersGenre = new GenreBuilder("Lib0 Series Chapter Genre").Build(),
+ Lib0SeriesGenre = new GenreBuilder("Lib0 Series Genre").Build(),
+ Lib0ChaptersGenre = new GenreBuilder("Lib0 Chapters Genre").Build(),
+ Lib1SeriesChaptersGenre = new GenreBuilder("Lib1 Series Chapter Genre").Build(),
+ Lib1SeriesGenre = new GenreBuilder("Lib1 Series Genre").Build(),
+ Lib1ChaptersGenre = new GenreBuilder("Lib1 Chapters Genre").Build(),
+ Lib1ChapterAgeGenre = new GenreBuilder("Lib1 Chapter Age Genre").Build()
+ };
+ }
+
+ private async Task SeedDbWithGenres(TestGenreSet genres)
+ {
+ await CreateTestUsers();
+ await AddGenresToContext(genres);
+ await CreateLibrariesWithGenres(genres);
+ await AssignLibrariesToUsers();
+ }
+
+ private async Task CreateTestUsers()
+ {
+ _fullAccess = new AppUserBuilder("amelia", "amelia@example.com").Build();
+ _restrictedAccess = new AppUserBuilder("mila", "mila@example.com").Build();
+ _restrictedAgeAccess = new AppUserBuilder("eva", "eva@example.com").Build();
+ _restrictedAgeAccess.AgeRestriction = AgeRating.Teen;
+ _restrictedAgeAccess.AgeRestrictionIncludeUnknowns = true;
+
+ Context.Users.Add(_fullAccess);
+ Context.Users.Add(_restrictedAccess);
+ Context.Users.Add(_restrictedAgeAccess);
+ await Context.SaveChangesAsync();
+ }
+
+ private async Task AddGenresToContext(TestGenreSet genres)
+ {
+ var allGenres = genres.GetAllGenres();
+ Context.Genre.AddRange(allGenres);
+ await Context.SaveChangesAsync();
+ }
+
+ private async Task CreateLibrariesWithGenres(TestGenreSet genres)
+ {
+ var lib0 = new LibraryBuilder("lib0")
+ .WithSeries(new SeriesBuilder("lib0-s0")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedSeriesGenre, genres.Lib0SeriesChaptersGenre, genres.Lib0SeriesGenre])
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedChaptersGenre, genres.Lib0SeriesChaptersGenre, genres.Lib0ChaptersGenre])
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedChaptersGenre, genres.Lib1SeriesChaptersGenre, genres.Lib1ChaptersGenre])
+ .Build())
+ .Build())
+ .Build())
+ .Build();
+
+ var lib1 = new LibraryBuilder("lib1")
+ .WithSeries(new SeriesBuilder("lib1-s0")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedSeriesGenre, genres.Lib1SeriesChaptersGenre, genres.Lib1SeriesGenre])
+ .WithAgeRating(AgeRating.Mature17Plus)
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedChaptersGenre, genres.Lib1SeriesChaptersGenre, genres.Lib1ChaptersGenre])
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedChaptersGenre, genres.Lib1SeriesChaptersGenre, genres.Lib1ChaptersGenre, genres.Lib1ChapterAgeGenre])
+ .WithAgeRating(AgeRating.Mature17Plus)
+ .Build())
+ .Build())
+ .Build())
+ .WithSeries(new SeriesBuilder("lib1-s1")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedSeriesGenre, genres.Lib1SeriesChaptersGenre, genres.Lib1SeriesGenre])
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedChaptersGenre, genres.Lib1SeriesChaptersGenre, genres.Lib1ChaptersGenre])
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithGenres([genres.SharedSeriesChaptersGenre, genres.SharedChaptersGenre, genres.Lib1SeriesChaptersGenre, genres.Lib1ChaptersGenre])
+ .Build())
+ .Build())
+ .Build())
+ .Build();
+
+ Context.Library.Add(lib0);
+ Context.Library.Add(lib1);
+ await Context.SaveChangesAsync();
+ }
+
+ private async Task AssignLibrariesToUsers()
+ {
+ var lib0 = Context.Library.First(l => l.Name == "lib0");
+ var lib1 = Context.Library.First(l => l.Name == "lib1");
+
+ _fullAccess.Libraries.Add(lib0);
+ _fullAccess.Libraries.Add(lib1);
+ _restrictedAccess.Libraries.Add(lib1);
+ _restrictedAgeAccess.Libraries.Add(lib1);
+
+ await Context.SaveChangesAsync();
+ }
+
+ private static Predicate ContainsGenreCheck(Genre genre)
+ {
+ return g => g.Id == genre.Id;
+ }
+
+ private static void AssertGenrePresent(IEnumerable genres, Genre expectedGenre)
+ {
+ Assert.Contains(genres, ContainsGenreCheck(expectedGenre));
+ }
+
+ private static void AssertGenreNotPresent(IEnumerable genres, Genre expectedGenre)
+ {
+ Assert.DoesNotContain(genres, ContainsGenreCheck(expectedGenre));
+ }
+
+ private static BrowseGenreDto GetGenreDto(IEnumerable genres, Genre genre)
+ {
+ return genres.First(dto => dto.Id == genre.Id);
+ }
+
+ [Fact]
+ public async Task GetBrowseableGenre_FullAccess_ReturnsAllGenresWithCorrectCounts()
+ {
+ // Arrange
+ await ResetDb();
+ var genres = CreateTestGenres();
+ await SeedDbWithGenres(genres);
+
+ // Act
+ var fullAccessGenres = await UnitOfWork.GenreRepository.GetBrowseableGenre(_fullAccess.Id, new UserParams());
+
+ // Assert
+ Assert.Equal(genres.GetAllGenres().Count, fullAccessGenres.TotalCount);
+
+ foreach (var genre in genres.GetAllGenres())
+ {
+ AssertGenrePresent(fullAccessGenres, genre);
+ }
+
+ // Verify counts - 1 lib0 series, 2 lib1 series = 3 total series
+ Assert.Equal(3, GetGenreDto(fullAccessGenres, genres.SharedSeriesChaptersGenre).SeriesCount);
+ Assert.Equal(6, GetGenreDto(fullAccessGenres, genres.SharedSeriesChaptersGenre).ChapterCount);
+ Assert.Equal(1, GetGenreDto(fullAccessGenres, genres.Lib0SeriesGenre).SeriesCount);
+ }
+
+ [Fact]
+ public async Task GetBrowseableGenre_RestrictedAccess_ReturnsOnlyAccessibleGenres()
+ {
+ // Arrange
+ await ResetDb();
+ var genres = CreateTestGenres();
+ await SeedDbWithGenres(genres);
+
+ // Act
+ var restrictedAccessGenres = await UnitOfWork.GenreRepository.GetBrowseableGenre(_restrictedAccess.Id, new UserParams());
+
+ // Assert - Should see: 3 shared + 4 library 1 specific = 7 genres
+ Assert.Equal(7, restrictedAccessGenres.TotalCount);
+
+ // Verify shared and Library 1 genres are present
+ AssertGenrePresent(restrictedAccessGenres, genres.SharedSeriesChaptersGenre);
+ AssertGenrePresent(restrictedAccessGenres, genres.SharedSeriesGenre);
+ AssertGenrePresent(restrictedAccessGenres, genres.SharedChaptersGenre);
+ AssertGenrePresent(restrictedAccessGenres, genres.Lib1SeriesChaptersGenre);
+ AssertGenrePresent(restrictedAccessGenres, genres.Lib1SeriesGenre);
+ AssertGenrePresent(restrictedAccessGenres, genres.Lib1ChaptersGenre);
+ AssertGenrePresent(restrictedAccessGenres, genres.Lib1ChapterAgeGenre);
+
+ // Verify Library 0 specific genres are not present
+ AssertGenreNotPresent(restrictedAccessGenres, genres.Lib0SeriesChaptersGenre);
+ AssertGenreNotPresent(restrictedAccessGenres, genres.Lib0SeriesGenre);
+ AssertGenreNotPresent(restrictedAccessGenres, genres.Lib0ChaptersGenre);
+
+ // Verify counts - 2 lib1 series
+ Assert.Equal(2, GetGenreDto(restrictedAccessGenres, genres.SharedSeriesChaptersGenre).SeriesCount);
+ Assert.Equal(4, GetGenreDto(restrictedAccessGenres, genres.SharedSeriesChaptersGenre).ChapterCount);
+ Assert.Equal(2, GetGenreDto(restrictedAccessGenres, genres.Lib1SeriesGenre).SeriesCount);
+ Assert.Equal(4, GetGenreDto(restrictedAccessGenres, genres.Lib1ChaptersGenre).ChapterCount);
+ Assert.Equal(1, GetGenreDto(restrictedAccessGenres, genres.Lib1ChapterAgeGenre).ChapterCount);
+ }
+
+ [Fact]
+ public async Task GetBrowseableGenre_RestrictedAgeAccess_FiltersAgeRestrictedContent()
+ {
+ // Arrange
+ await ResetDb();
+ var genres = CreateTestGenres();
+ await SeedDbWithGenres(genres);
+
+ // Act
+ var restrictedAgeAccessGenres = await UnitOfWork.GenreRepository.GetBrowseableGenre(_restrictedAgeAccess.Id, new UserParams());
+
+ // Assert - Should see: 3 shared + 3 lib1 specific = 6 genres (age-restricted genre filtered out)
+ Assert.Equal(6, restrictedAgeAccessGenres.TotalCount);
+
+ // Verify accessible genres are present
+ AssertGenrePresent(restrictedAgeAccessGenres, genres.SharedSeriesChaptersGenre);
+ AssertGenrePresent(restrictedAgeAccessGenres, genres.SharedSeriesGenre);
+ AssertGenrePresent(restrictedAgeAccessGenres, genres.SharedChaptersGenre);
+ AssertGenrePresent(restrictedAgeAccessGenres, genres.Lib1SeriesChaptersGenre);
+ AssertGenrePresent(restrictedAgeAccessGenres, genres.Lib1SeriesGenre);
+ AssertGenrePresent(restrictedAgeAccessGenres, genres.Lib1ChaptersGenre);
+
+ // Verify age-restricted genre is filtered out
+ AssertGenreNotPresent(restrictedAgeAccessGenres, genres.Lib1ChapterAgeGenre);
+
+ // Verify counts - 1 series lib1 (age-restricted series filtered out)
+ Assert.Equal(1, GetGenreDto(restrictedAgeAccessGenres, genres.SharedSeriesChaptersGenre).SeriesCount);
+ Assert.Equal(1, GetGenreDto(restrictedAgeAccessGenres, genres.Lib1SeriesGenre).SeriesCount);
+
+ // These values represent a bug - chapters are not properly filtered when their series is age-restricted
+ // Should be 2, but currently returns 3 due to the filtering issue
+ Assert.Equal(3, GetGenreDto(restrictedAgeAccessGenres, genres.SharedSeriesChaptersGenre).ChapterCount);
+ Assert.Equal(3, GetGenreDto(restrictedAgeAccessGenres, genres.Lib1ChaptersGenre).ChapterCount);
+ }
+
+ private class TestGenreSet
+ {
+ public Genre SharedSeriesChaptersGenre { get; set; }
+ public Genre SharedSeriesGenre { get; set; }
+ public Genre SharedChaptersGenre { get; set; }
+ public Genre Lib0SeriesChaptersGenre { get; set; }
+ public Genre Lib0SeriesGenre { get; set; }
+ public Genre Lib0ChaptersGenre { get; set; }
+ public Genre Lib1SeriesChaptersGenre { get; set; }
+ public Genre Lib1SeriesGenre { get; set; }
+ public Genre Lib1ChaptersGenre { get; set; }
+ public Genre Lib1ChapterAgeGenre { get; set; }
+
+ public List GetAllGenres()
+ {
+ return
+ [
+ SharedSeriesChaptersGenre, SharedSeriesGenre, SharedChaptersGenre,
+ Lib0SeriesChaptersGenre, Lib0SeriesGenre, Lib0ChaptersGenre,
+ Lib1SeriesChaptersGenre, Lib1SeriesGenre, Lib1ChaptersGenre, Lib1ChapterAgeGenre
+ ];
+ }
+ }
+}
diff --git a/API.Tests/Repository/PersonRepositoryTests.cs b/API.Tests/Repository/PersonRepositoryTests.cs
new file mode 100644
index 000000000..a2b19cc0c
--- /dev/null
+++ b/API.Tests/Repository/PersonRepositoryTests.cs
@@ -0,0 +1,342 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using API.DTOs.Metadata.Browse;
+using API.DTOs.Metadata.Browse.Requests;
+using API.Entities;
+using API.Entities.Enums;
+using API.Entities.Person;
+using API.Helpers;
+using API.Helpers.Builders;
+using Xunit;
+
+namespace API.Tests.Repository;
+
+public class PersonRepositoryTests : AbstractDbTest
+{
+ private AppUser _fullAccess;
+ private AppUser _restrictedAccess;
+ private AppUser _restrictedAgeAccess;
+
+ protected override async Task ResetDb()
+ {
+ Context.Person.RemoveRange(Context.Person.ToList());
+ Context.Library.RemoveRange(Context.Library.ToList());
+ Context.AppUser.RemoveRange(Context.AppUser.ToList());
+ await UnitOfWork.CommitAsync();
+ }
+
+ private async Task SeedDb()
+ {
+ _fullAccess = new AppUserBuilder("amelia", "amelia@example.com").Build();
+ _restrictedAccess = new AppUserBuilder("mila", "mila@example.com").Build();
+ _restrictedAgeAccess = new AppUserBuilder("eva", "eva@example.com").Build();
+ _restrictedAgeAccess.AgeRestriction = AgeRating.Teen;
+ _restrictedAgeAccess.AgeRestrictionIncludeUnknowns = true;
+
+ Context.AppUser.Add(_fullAccess);
+ Context.AppUser.Add(_restrictedAccess);
+ Context.AppUser.Add(_restrictedAgeAccess);
+ await Context.SaveChangesAsync();
+
+ var people = CreateTestPeople();
+ Context.Person.AddRange(people);
+ await Context.SaveChangesAsync();
+
+ var libraries = CreateTestLibraries(people);
+ Context.Library.AddRange(libraries);
+ await Context.SaveChangesAsync();
+
+ _fullAccess.Libraries.Add(libraries[0]); // lib0
+ _fullAccess.Libraries.Add(libraries[1]); // lib1
+ _restrictedAccess.Libraries.Add(libraries[1]); // lib1 only
+ _restrictedAgeAccess.Libraries.Add(libraries[1]); // lib1 only
+
+ await Context.SaveChangesAsync();
+ }
+
+ private static List CreateTestPeople()
+ {
+ return new List
+ {
+ new PersonBuilder("Shared Series Chapter Person").Build(),
+ new PersonBuilder("Shared Series Person").Build(),
+ new PersonBuilder("Shared Chapters Person").Build(),
+ new PersonBuilder("Lib0 Series Chapter Person").Build(),
+ new PersonBuilder("Lib0 Series Person").Build(),
+ new PersonBuilder("Lib0 Chapters Person").Build(),
+ new PersonBuilder("Lib1 Series Chapter Person").Build(),
+ new PersonBuilder("Lib1 Series Person").Build(),
+ new PersonBuilder("Lib1 Chapters Person").Build(),
+ new PersonBuilder("Lib1 Chapter Age Person").Build()
+ };
+ }
+
+ private static List CreateTestLibraries(List people)
+ {
+ var lib0 = new LibraryBuilder("lib0")
+ .WithSeries(new SeriesBuilder("lib0-s0")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Writer)
+ .WithPerson(GetPersonByName(people, "Shared Series Person"), PersonRole.Writer)
+ .WithPerson(GetPersonByName(people, "Lib0 Series Chapter Person"), PersonRole.Writer)
+ .WithPerson(GetPersonByName(people, "Lib0 Series Person"), PersonRole.Writer)
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Colorist)
+ .WithPerson(GetPersonByName(people, "Shared Chapters Person"), PersonRole.Colorist)
+ .WithPerson(GetPersonByName(people, "Lib0 Series Chapter Person"), PersonRole.Colorist)
+ .WithPerson(GetPersonByName(people, "Lib0 Chapters Person"), PersonRole.Colorist)
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Editor)
+ .WithPerson(GetPersonByName(people, "Shared Chapters Person"), PersonRole.Editor)
+ .WithPerson(GetPersonByName(people, "Lib0 Series Chapter Person"), PersonRole.Editor)
+ .WithPerson(GetPersonByName(people, "Lib0 Chapters Person"), PersonRole.Editor)
+ .Build())
+ .Build())
+ .Build())
+ .Build();
+
+ var lib1 = new LibraryBuilder("lib1")
+ .WithSeries(new SeriesBuilder("lib1-s0")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Letterer)
+ .WithPerson(GetPersonByName(people, "Shared Series Person"), PersonRole.Letterer)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Chapter Person"), PersonRole.Letterer)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Person"), PersonRole.Letterer)
+ .WithAgeRating(AgeRating.Mature17Plus)
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Imprint)
+ .WithPerson(GetPersonByName(people, "Shared Chapters Person"), PersonRole.Imprint)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Chapter Person"), PersonRole.Imprint)
+ .WithPerson(GetPersonByName(people, "Lib1 Chapters Person"), PersonRole.Imprint)
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.CoverArtist)
+ .WithPerson(GetPersonByName(people, "Shared Chapters Person"), PersonRole.CoverArtist)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Chapter Person"), PersonRole.CoverArtist)
+ .WithPerson(GetPersonByName(people, "Lib1 Chapters Person"), PersonRole.CoverArtist)
+ .WithPerson(GetPersonByName(people, "Lib1 Chapter Age Person"), PersonRole.CoverArtist)
+ .WithAgeRating(AgeRating.Mature17Plus)
+ .Build())
+ .Build())
+ .Build())
+ .WithSeries(new SeriesBuilder("lib1-s1")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Inker)
+ .WithPerson(GetPersonByName(people, "Shared Series Person"), PersonRole.Inker)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Chapter Person"), PersonRole.Inker)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Person"), PersonRole.Inker)
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Team)
+ .WithPerson(GetPersonByName(people, "Shared Chapters Person"), PersonRole.Team)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Chapter Person"), PersonRole.Team)
+ .WithPerson(GetPersonByName(people, "Lib1 Chapters Person"), PersonRole.Team)
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithPerson(GetPersonByName(people, "Shared Series Chapter Person"), PersonRole.Translator)
+ .WithPerson(GetPersonByName(people, "Shared Chapters Person"), PersonRole.Translator)
+ .WithPerson(GetPersonByName(people, "Lib1 Series Chapter Person"), PersonRole.Translator)
+ .WithPerson(GetPersonByName(people, "Lib1 Chapters Person"), PersonRole.Translator)
+ .Build())
+ .Build())
+ .Build())
+ .Build();
+
+ return new List { lib0, lib1 };
+ }
+
+ private static Person GetPersonByName(List people, string name)
+ {
+ return people.First(p => p.Name == name);
+ }
+
+ private Person GetPersonByName(string name)
+ {
+ return Context.Person.First(p => p.Name == name);
+ }
+
+ private static Predicate ContainsPersonCheck(Person person)
+ {
+ return p => p.Id == person.Id;
+ }
+
+ [Fact]
+ public async Task GetBrowsePersonDtos()
+ {
+ await ResetDb();
+ await SeedDb();
+
+ // Get people from database for assertions
+ var sharedSeriesChaptersPerson = GetPersonByName("Shared Series Chapter Person");
+ var lib0SeriesPerson = GetPersonByName("Lib0 Series Person");
+ var lib1SeriesPerson = GetPersonByName("Lib1 Series Person");
+ var lib1ChapterAgePerson = GetPersonByName("Lib1 Chapter Age Person");
+ var allPeople = Context.Person.ToList();
+
+ var fullAccessPeople =
+ await UnitOfWork.PersonRepository.GetBrowsePersonDtos(_fullAccess.Id, new BrowsePersonFilterDto(),
+ new UserParams());
+ Assert.Equal(allPeople.Count, fullAccessPeople.TotalCount);
+
+ foreach (var person in allPeople)
+ Assert.Contains(fullAccessPeople, ContainsPersonCheck(person));
+
+ // 1 series in lib0, 2 series in lib1
+ Assert.Equal(3, fullAccessPeople.First(dto => dto.Id == sharedSeriesChaptersPerson.Id).SeriesCount);
+ // 3 series with each 2 chapters
+ Assert.Equal(6, fullAccessPeople.First(dto => dto.Id == sharedSeriesChaptersPerson.Id).ChapterCount);
+ // 1 series in lib0
+ Assert.Equal(1, fullAccessPeople.First(dto => dto.Id == lib0SeriesPerson.Id).SeriesCount);
+ // 2 series in lib1
+ Assert.Equal(2, fullAccessPeople.First(dto => dto.Id == lib1SeriesPerson.Id).SeriesCount);
+
+ var restrictedAccessPeople =
+ await UnitOfWork.PersonRepository.GetBrowsePersonDtos(_restrictedAccess.Id, new BrowsePersonFilterDto(),
+ new UserParams());
+
+ Assert.Equal(7, restrictedAccessPeople.TotalCount);
+
+ Assert.Contains(restrictedAccessPeople, ContainsPersonCheck(GetPersonByName("Shared Series Chapter Person")));
+ Assert.Contains(restrictedAccessPeople, ContainsPersonCheck(GetPersonByName("Shared Series Person")));
+ Assert.Contains(restrictedAccessPeople, ContainsPersonCheck(GetPersonByName("Shared Chapters Person")));
+ Assert.Contains(restrictedAccessPeople, ContainsPersonCheck(GetPersonByName("Lib1 Series Chapter Person")));
+ Assert.Contains(restrictedAccessPeople, ContainsPersonCheck(GetPersonByName("Lib1 Series Person")));
+ Assert.Contains(restrictedAccessPeople, ContainsPersonCheck(GetPersonByName("Lib1 Chapters Person")));
+ Assert.Contains(restrictedAccessPeople, ContainsPersonCheck(GetPersonByName("Lib1 Chapter Age Person")));
+
+ // 2 series in lib1, no series in lib0
+ Assert.Equal(2, restrictedAccessPeople.First(dto => dto.Id == sharedSeriesChaptersPerson.Id).SeriesCount);
+ // 2 series with each 2 chapters
+ Assert.Equal(4, restrictedAccessPeople.First(dto => dto.Id == sharedSeriesChaptersPerson.Id).ChapterCount);
+ // 2 series in lib1
+ Assert.Equal(2, restrictedAccessPeople.First(dto => dto.Id == lib1SeriesPerson.Id).SeriesCount);
+
+ var restrictedAgeAccessPeople = await UnitOfWork.PersonRepository.GetBrowsePersonDtos(_restrictedAgeAccess.Id,
+ new BrowsePersonFilterDto(), new UserParams());
+
+ // Note: There is a potential bug here where a person in a different chapter of an age restricted series will show up
+ Assert.Equal(6, restrictedAgeAccessPeople.TotalCount);
+
+ // No access to the age restricted chapter
+ Assert.DoesNotContain(restrictedAgeAccessPeople, ContainsPersonCheck(lib1ChapterAgePerson));
+ }
+
+ [Fact]
+ public async Task GetRolesForPersonByName()
+ {
+ await ResetDb();
+ await SeedDb();
+
+ var sharedSeriesPerson = GetPersonByName("Shared Series Person");
+ var sharedChaptersPerson = GetPersonByName("Shared Chapters Person");
+ var lib1ChapterAgePerson = GetPersonByName("Lib1 Chapter Age Person");
+
+ var sharedSeriesRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(sharedSeriesPerson.Id, _fullAccess.Id);
+ var chapterRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(sharedChaptersPerson.Id, _fullAccess.Id);
+ var ageChapterRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(lib1ChapterAgePerson.Id, _fullAccess.Id);
+ Assert.Equal(3, sharedSeriesRoles.Count());
+ Assert.Equal(6, chapterRoles.Count());
+ Assert.Single(ageChapterRoles);
+
+ var restrictedRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(sharedSeriesPerson.Id, _restrictedAccess.Id);
+ var restrictedChapterRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(sharedChaptersPerson.Id, _restrictedAccess.Id);
+ var restrictedAgePersonChapterRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(lib1ChapterAgePerson.Id, _restrictedAccess.Id);
+ Assert.Equal(2, restrictedRoles.Count());
+ Assert.Equal(4, restrictedChapterRoles.Count());
+ Assert.Single(restrictedAgePersonChapterRoles);
+
+ var restrictedAgeRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(sharedSeriesPerson.Id, _restrictedAgeAccess.Id);
+ var restrictedAgeChapterRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(sharedChaptersPerson.Id, _restrictedAgeAccess.Id);
+ var restrictedAgeAgePersonChapterRoles = await UnitOfWork.PersonRepository.GetRolesForPersonByName(lib1ChapterAgePerson.Id, _restrictedAgeAccess.Id);
+ Assert.Single(restrictedAgeRoles);
+ Assert.Equal(2, restrictedAgeChapterRoles.Count());
+ // Note: There is a potential bug here where a person in a different chapter of an age restricted series will show up
+ Assert.Empty(restrictedAgeAgePersonChapterRoles);
+ }
+
+ [Fact]
+ public async Task GetPersonDtoByName()
+ {
+ await ResetDb();
+ await SeedDb();
+
+ var allPeople = Context.Person.ToList();
+
+ foreach (var person in allPeople)
+ {
+ Assert.NotNull(await UnitOfWork.PersonRepository.GetPersonDtoByName(person.Name, _fullAccess.Id));
+ }
+
+ Assert.Null(await UnitOfWork.PersonRepository.GetPersonDtoByName("Lib0 Chapters Person", _restrictedAccess.Id));
+ Assert.NotNull(await UnitOfWork.PersonRepository.GetPersonDtoByName("Shared Series Person", _restrictedAccess.Id));
+ Assert.NotNull(await UnitOfWork.PersonRepository.GetPersonDtoByName("Lib1 Series Person", _restrictedAccess.Id));
+
+ Assert.Null(await UnitOfWork.PersonRepository.GetPersonDtoByName("Lib0 Chapters Person", _restrictedAgeAccess.Id));
+ Assert.NotNull(await UnitOfWork.PersonRepository.GetPersonDtoByName("Lib1 Series Person", _restrictedAgeAccess.Id));
+ // Note: There is a potential bug here where a person in a different chapter of an age restricted series will show up
+ Assert.Null(await UnitOfWork.PersonRepository.GetPersonDtoByName("Lib1 Chapter Age Person", _restrictedAgeAccess.Id));
+ }
+
+ [Fact]
+ public async Task GetSeriesKnownFor()
+ {
+ await ResetDb();
+ await SeedDb();
+
+ var sharedSeriesPerson = GetPersonByName("Shared Series Person");
+ var lib1SeriesPerson = GetPersonByName("Lib1 Series Person");
+
+ var series = await UnitOfWork.PersonRepository.GetSeriesKnownFor(sharedSeriesPerson.Id, _fullAccess.Id);
+ Assert.Equal(3, series.Count());
+
+ series = await UnitOfWork.PersonRepository.GetSeriesKnownFor(sharedSeriesPerson.Id, _restrictedAccess.Id);
+ Assert.Equal(2, series.Count());
+
+ series = await UnitOfWork.PersonRepository.GetSeriesKnownFor(sharedSeriesPerson.Id, _restrictedAgeAccess.Id);
+ Assert.Single(series);
+
+ series = await UnitOfWork.PersonRepository.GetSeriesKnownFor(lib1SeriesPerson.Id, _restrictedAgeAccess.Id);
+ Assert.Single(series);
+ }
+
+ [Fact]
+ public async Task GetChaptersForPersonByRole()
+ {
+ await ResetDb();
+ await SeedDb();
+
+ var sharedChaptersPerson = GetPersonByName("Shared Chapters Person");
+
+ // Lib0
+ var chapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _fullAccess.Id, PersonRole.Colorist);
+ var restrictedChapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _restrictedAccess.Id, PersonRole.Colorist);
+ var restrictedAgeChapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _restrictedAgeAccess.Id, PersonRole.Colorist);
+ Assert.Single(chapters);
+ Assert.Empty(restrictedChapters);
+ Assert.Empty(restrictedAgeChapters);
+
+ // Lib1 - age restricted series
+ chapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _fullAccess.Id, PersonRole.Imprint);
+ restrictedChapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _restrictedAccess.Id, PersonRole.Imprint);
+ restrictedAgeChapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _restrictedAgeAccess.Id, PersonRole.Imprint);
+ Assert.Single(chapters);
+ Assert.Single(restrictedChapters);
+ Assert.Empty(restrictedAgeChapters);
+
+ // Lib1 - not age restricted series
+ chapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _fullAccess.Id, PersonRole.Team);
+ restrictedChapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _restrictedAccess.Id, PersonRole.Team);
+ restrictedAgeChapters = await UnitOfWork.PersonRepository.GetChaptersForPersonByRole(sharedChaptersPerson.Id, _restrictedAgeAccess.Id, PersonRole.Team);
+ Assert.Single(chapters);
+ Assert.Single(restrictedChapters);
+ Assert.Single(restrictedAgeChapters);
+ }
+}
diff --git a/API.Tests/Repository/TagRepositoryTests.cs b/API.Tests/Repository/TagRepositoryTests.cs
new file mode 100644
index 000000000..229082eb6
--- /dev/null
+++ b/API.Tests/Repository/TagRepositoryTests.cs
@@ -0,0 +1,278 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using API.DTOs.Metadata.Browse;
+using API.Entities;
+using API.Entities.Enums;
+using API.Entities.Metadata;
+using API.Helpers;
+using API.Helpers.Builders;
+using Xunit;
+
+namespace API.Tests.Repository;
+
+public class TagRepositoryTests : AbstractDbTest
+{
+ private AppUser _fullAccess;
+ private AppUser _restrictedAccess;
+ private AppUser _restrictedAgeAccess;
+
+ protected override async Task ResetDb()
+ {
+ Context.Tag.RemoveRange(Context.Tag);
+ Context.Library.RemoveRange(Context.Library);
+ await Context.SaveChangesAsync();
+ }
+
+ private TestTagSet CreateTestTags()
+ {
+ return new TestTagSet
+ {
+ SharedSeriesChaptersTag = new TagBuilder("Shared Series Chapter Tag").Build(),
+ SharedSeriesTag = new TagBuilder("Shared Series Tag").Build(),
+ SharedChaptersTag = new TagBuilder("Shared Chapters Tag").Build(),
+ Lib0SeriesChaptersTag = new TagBuilder("Lib0 Series Chapter Tag").Build(),
+ Lib0SeriesTag = new TagBuilder("Lib0 Series Tag").Build(),
+ Lib0ChaptersTag = new TagBuilder("Lib0 Chapters Tag").Build(),
+ Lib1SeriesChaptersTag = new TagBuilder("Lib1 Series Chapter Tag").Build(),
+ Lib1SeriesTag = new TagBuilder("Lib1 Series Tag").Build(),
+ Lib1ChaptersTag = new TagBuilder("Lib1 Chapters Tag").Build(),
+ Lib1ChapterAgeTag = new TagBuilder("Lib1 Chapter Age Tag").Build()
+ };
+ }
+
+ private async Task SeedDbWithTags(TestTagSet tags)
+ {
+ await CreateTestUsers();
+ await AddTagsToContext(tags);
+ await CreateLibrariesWithTags(tags);
+ await AssignLibrariesToUsers();
+ }
+
+ private async Task CreateTestUsers()
+ {
+ _fullAccess = new AppUserBuilder("amelia", "amelia@example.com").Build();
+ _restrictedAccess = new AppUserBuilder("mila", "mila@example.com").Build();
+ _restrictedAgeAccess = new AppUserBuilder("eva", "eva@example.com").Build();
+ _restrictedAgeAccess.AgeRestriction = AgeRating.Teen;
+ _restrictedAgeAccess.AgeRestrictionIncludeUnknowns = true;
+
+ Context.Users.Add(_fullAccess);
+ Context.Users.Add(_restrictedAccess);
+ Context.Users.Add(_restrictedAgeAccess);
+ await Context.SaveChangesAsync();
+ }
+
+ private async Task AddTagsToContext(TestTagSet tags)
+ {
+ var allTags = tags.GetAllTags();
+ Context.Tag.AddRange(allTags);
+ await Context.SaveChangesAsync();
+ }
+
+ private async Task CreateLibrariesWithTags(TestTagSet tags)
+ {
+ var lib0 = new LibraryBuilder("lib0")
+ .WithSeries(new SeriesBuilder("lib0-s0")
+ .WithMetadata(new SeriesMetadata
+ {
+ Tags = [tags.SharedSeriesChaptersTag, tags.SharedSeriesTag, tags.Lib0SeriesChaptersTag, tags.Lib0SeriesTag]
+ })
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedChaptersTag, tags.Lib0SeriesChaptersTag, tags.Lib0ChaptersTag])
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedChaptersTag, tags.Lib1SeriesChaptersTag, tags.Lib1ChaptersTag])
+ .Build())
+ .Build())
+ .Build())
+ .Build();
+
+ var lib1 = new LibraryBuilder("lib1")
+ .WithSeries(new SeriesBuilder("lib1-s0")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedSeriesTag, tags.Lib1SeriesChaptersTag, tags.Lib1SeriesTag])
+ .WithAgeRating(AgeRating.Mature17Plus)
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedChaptersTag, tags.Lib1SeriesChaptersTag, tags.Lib1ChaptersTag])
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedChaptersTag, tags.Lib1SeriesChaptersTag, tags.Lib1ChaptersTag, tags.Lib1ChapterAgeTag])
+ .WithAgeRating(AgeRating.Mature17Plus)
+ .Build())
+ .Build())
+ .Build())
+ .WithSeries(new SeriesBuilder("lib1-s1")
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedSeriesTag, tags.Lib1SeriesChaptersTag, tags.Lib1SeriesTag])
+ .Build())
+ .WithVolume(new VolumeBuilder("1")
+ .WithChapter(new ChapterBuilder("1")
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedChaptersTag, tags.Lib1SeriesChaptersTag, tags.Lib1ChaptersTag])
+ .Build())
+ .WithChapter(new ChapterBuilder("2")
+ .WithTags([tags.SharedSeriesChaptersTag, tags.SharedChaptersTag, tags.Lib1SeriesChaptersTag, tags.Lib1ChaptersTag])
+ .WithAgeRating(AgeRating.Mature17Plus)
+ .Build())
+ .Build())
+ .Build())
+ .Build();
+
+ Context.Library.Add(lib0);
+ Context.Library.Add(lib1);
+ await Context.SaveChangesAsync();
+ }
+
+ private async Task AssignLibrariesToUsers()
+ {
+ var lib0 = Context.Library.First(l => l.Name == "lib0");
+ var lib1 = Context.Library.First(l => l.Name == "lib1");
+
+ _fullAccess.Libraries.Add(lib0);
+ _fullAccess.Libraries.Add(lib1);
+ _restrictedAccess.Libraries.Add(lib1);
+ _restrictedAgeAccess.Libraries.Add(lib1);
+
+ await Context.SaveChangesAsync();
+ }
+
+ private static Predicate ContainsTagCheck(Tag tag)
+ {
+ return t => t.Id == tag.Id;
+ }
+
+ private static void AssertTagPresent(IEnumerable tags, Tag expectedTag)
+ {
+ Assert.Contains(tags, ContainsTagCheck(expectedTag));
+ }
+
+ private static void AssertTagNotPresent(IEnumerable tags, Tag expectedTag)
+ {
+ Assert.DoesNotContain(tags, ContainsTagCheck(expectedTag));
+ }
+
+ private static BrowseTagDto GetTagDto(IEnumerable tags, Tag tag)
+ {
+ return tags.First(dto => dto.Id == tag.Id);
+ }
+
+ [Fact]
+ public async Task GetBrowseableTag_FullAccess_ReturnsAllTagsWithCorrectCounts()
+ {
+ // Arrange
+ await ResetDb();
+ var tags = CreateTestTags();
+ await SeedDbWithTags(tags);
+
+ // Act
+ var fullAccessTags = await UnitOfWork.TagRepository.GetBrowseableTag(_fullAccess.Id, new UserParams());
+
+ // Assert
+ Assert.Equal(tags.GetAllTags().Count, fullAccessTags.TotalCount);
+
+ foreach (var tag in tags.GetAllTags())
+ {
+ AssertTagPresent(fullAccessTags, tag);
+ }
+
+ // Verify counts - 1 series lib0, 2 series lib1 = 3 total series
+ Assert.Equal(3, GetTagDto(fullAccessTags, tags.SharedSeriesChaptersTag).SeriesCount);
+ Assert.Equal(6, GetTagDto(fullAccessTags, tags.SharedSeriesChaptersTag).ChapterCount);
+ Assert.Equal(1, GetTagDto(fullAccessTags, tags.Lib0SeriesTag).SeriesCount);
+ }
+
+ [Fact]
+ public async Task GetBrowseableTag_RestrictedAccess_ReturnsOnlyAccessibleTags()
+ {
+ // Arrange
+ await ResetDb();
+ var tags = CreateTestTags();
+ await SeedDbWithTags(tags);
+
+ // Act
+ var restrictedAccessTags = await UnitOfWork.TagRepository.GetBrowseableTag(_restrictedAccess.Id, new UserParams());
+
+ // Assert - Should see: 3 shared + 4 library 1 specific = 7 tags
+ Assert.Equal(7, restrictedAccessTags.TotalCount);
+
+ // Verify shared and Library 1 tags are present
+ AssertTagPresent(restrictedAccessTags, tags.SharedSeriesChaptersTag);
+ AssertTagPresent(restrictedAccessTags, tags.SharedSeriesTag);
+ AssertTagPresent(restrictedAccessTags, tags.SharedChaptersTag);
+ AssertTagPresent(restrictedAccessTags, tags.Lib1SeriesChaptersTag);
+ AssertTagPresent(restrictedAccessTags, tags.Lib1SeriesTag);
+ AssertTagPresent(restrictedAccessTags, tags.Lib1ChaptersTag);
+ AssertTagPresent(restrictedAccessTags, tags.Lib1ChapterAgeTag);
+
+ // Verify Library 0 specific tags are not present
+ AssertTagNotPresent(restrictedAccessTags, tags.Lib0SeriesChaptersTag);
+ AssertTagNotPresent(restrictedAccessTags, tags.Lib0SeriesTag);
+ AssertTagNotPresent(restrictedAccessTags, tags.Lib0ChaptersTag);
+
+ // Verify counts - 2 series lib1
+ Assert.Equal(2, GetTagDto(restrictedAccessTags, tags.SharedSeriesChaptersTag).SeriesCount);
+ Assert.Equal(4, GetTagDto(restrictedAccessTags, tags.SharedSeriesChaptersTag).ChapterCount);
+ Assert.Equal(2, GetTagDto(restrictedAccessTags, tags.Lib1SeriesTag).SeriesCount);
+ Assert.Equal(4, GetTagDto(restrictedAccessTags, tags.Lib1ChaptersTag).ChapterCount);
+ }
+
+ [Fact]
+ public async Task GetBrowseableTag_RestrictedAgeAccess_FiltersAgeRestrictedContent()
+ {
+ // Arrange
+ await ResetDb();
+ var tags = CreateTestTags();
+ await SeedDbWithTags(tags);
+
+ // Act
+ var restrictedAgeAccessTags = await UnitOfWork.TagRepository.GetBrowseableTag(_restrictedAgeAccess.Id, new UserParams());
+
+ // Assert - Should see: 3 shared + 3 lib1 specific = 6 tags (age-restricted tag filtered out)
+ Assert.Equal(6, restrictedAgeAccessTags.TotalCount);
+
+ // Verify accessible tags are present
+ AssertTagPresent(restrictedAgeAccessTags, tags.SharedSeriesChaptersTag);
+ AssertTagPresent(restrictedAgeAccessTags, tags.SharedSeriesTag);
+ AssertTagPresent(restrictedAgeAccessTags, tags.SharedChaptersTag);
+ AssertTagPresent(restrictedAgeAccessTags, tags.Lib1SeriesChaptersTag);
+ AssertTagPresent(restrictedAgeAccessTags, tags.Lib1SeriesTag);
+ AssertTagPresent(restrictedAgeAccessTags, tags.Lib1ChaptersTag);
+
+ // Verify age-restricted tag is filtered out
+ AssertTagNotPresent(restrictedAgeAccessTags, tags.Lib1ChapterAgeTag);
+
+ // Verify counts - 1 series lib1 (age-restricted series filtered out)
+ Assert.Equal(1, GetTagDto(restrictedAgeAccessTags, tags.SharedSeriesChaptersTag).SeriesCount);
+ Assert.Equal(2, GetTagDto(restrictedAgeAccessTags, tags.SharedSeriesChaptersTag).ChapterCount);
+ Assert.Equal(1, GetTagDto(restrictedAgeAccessTags, tags.Lib1SeriesTag).SeriesCount);
+ Assert.Equal(2, GetTagDto(restrictedAgeAccessTags, tags.Lib1ChaptersTag).ChapterCount);
+ }
+
+ private class TestTagSet
+ {
+ public Tag SharedSeriesChaptersTag { get; set; }
+ public Tag SharedSeriesTag { get; set; }
+ public Tag SharedChaptersTag { get; set; }
+ public Tag Lib0SeriesChaptersTag { get; set; }
+ public Tag Lib0SeriesTag { get; set; }
+ public Tag Lib0ChaptersTag { get; set; }
+ public Tag Lib1SeriesChaptersTag { get; set; }
+ public Tag Lib1SeriesTag { get; set; }
+ public Tag Lib1ChaptersTag { get; set; }
+ public Tag Lib1ChapterAgeTag { get; set; }
+
+ public List GetAllTags()
+ {
+ return
+ [
+ SharedSeriesChaptersTag, SharedSeriesTag, SharedChaptersTag,
+ Lib0SeriesChaptersTag, Lib0SeriesTag, Lib0ChaptersTag,
+ Lib1SeriesChaptersTag, Lib1SeriesTag, Lib1ChaptersTag, Lib1ChapterAgeTag
+ ];
+ }
+ }
+}
diff --git a/API.Tests/Services/BookServiceTests.cs b/API.Tests/Services/BookServiceTests.cs
index a80c1ca01..5848c74ba 100644
--- a/API.Tests/Services/BookServiceTests.cs
+++ b/API.Tests/Services/BookServiceTests.cs
@@ -137,7 +137,7 @@ public class BookServiceTests
var comicInfo = _bookService.GetComicInfo(filePath);
Assert.NotNull(comicInfo);
- var parserInfo = pdfParser.Parse(filePath, testDirectory, ds.GetParentDirectoryName(testDirectory), LibraryType.Book, comicInfo);
+ var parserInfo = pdfParser.Parse(filePath, testDirectory, ds.GetParentDirectoryName(testDirectory), LibraryType.Book, true, comicInfo);
Assert.NotNull(parserInfo);
Assert.Equal(parserInfo.Title, comicInfo.Title);
Assert.Equal(parserInfo.Series, comicInfo.Title);
diff --git a/API.Tests/Services/CacheServiceTests.cs b/API.Tests/Services/CacheServiceTests.cs
index 5c1752cd8..caf1ae393 100644
--- a/API.Tests/Services/CacheServiceTests.cs
+++ b/API.Tests/Services/CacheServiceTests.cs
@@ -50,12 +50,12 @@ internal class MockReadingItemServiceForCacheService : IReadingItemService
throw new System.NotImplementedException();
}
- public ParserInfo Parse(string path, string rootPath, string libraryRoot, LibraryType type)
+ public ParserInfo Parse(string path, string rootPath, string libraryRoot, LibraryType type, bool enableMetadata = true)
{
throw new System.NotImplementedException();
}
- public ParserInfo ParseFile(string path, string rootPath, string libraryRoot, LibraryType type)
+ public ParserInfo ParseFile(string path, string rootPath, string libraryRoot, LibraryType type, bool enableMetadata = true)
{
throw new System.NotImplementedException();
}
diff --git a/API.Tests/Services/ExternalMetadataServiceTests.cs b/API.Tests/Services/ExternalMetadataServiceTests.cs
index 8310ed269..973b7c6df 100644
--- a/API.Tests/Services/ExternalMetadataServiceTests.cs
+++ b/API.Tests/Services/ExternalMetadataServiceTests.cs
@@ -15,6 +15,7 @@ using API.Entities.Person;
using API.Helpers.Builders;
using API.Services.Plus;
using API.Services.Tasks.Metadata;
+using API.Services.Tasks.Scanner.Parser;
using API.SignalR;
using Hangfire;
using Microsoft.EntityFrameworkCore;
@@ -42,7 +43,7 @@ public class ExternalMetadataServiceTests : AbstractDbTest
_externalMetadataService = new ExternalMetadataService(UnitOfWork, Substitute.For>(),
Mapper, Substitute.For(), Substitute.For(), Substitute.For(),
- Substitute.For());
+ Substitute.For(), Substitute.For());
}
#region Gloabl
@@ -881,6 +882,217 @@ public class ExternalMetadataServiceTests : AbstractDbTest
}
+ [Fact]
+ public void IsSeriesCompleted_ExactMatch()
+ {
+ const string seriesName = "Test - Exact Match";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(5)
+ .WithTotalCount(5)
+ .Build())
+ .Build();
+
+ var chapters = new List();
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 5, Volumes = 0 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, Parser.DefaultChapterNumber);
+
+ Assert.True(result);
+ }
+
+ [Fact]
+ public void IsSeriesCompleted_Volumes_DecimalVolumes()
+ {
+ const string seriesName = "Test - Volume Complete";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(2)
+ .WithTotalCount(3)
+ .Build())
+ .WithVolume(new VolumeBuilder("1").WithNumber(1).Build())
+ .WithVolume(new VolumeBuilder("2").WithNumber(2).Build())
+ .WithVolume(new VolumeBuilder("2.5").WithNumber(2.5f).Build())
+ .Build();
+
+ var chapters = new List();
+ // External metadata includes decimal volume 2.5
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 0, Volumes = 3 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, 2);
+
+ Assert.True(result);
+ Assert.Equal(3, series.Metadata.MaxCount);
+ Assert.Equal(3, series.Metadata.TotalCount);
+ }
+
+ ///
+ /// This is validating that we get a completed even though we have a special chapter and AL doesn't count it
+ ///
+ [Fact]
+ public void IsSeriesCompleted_Volumes_HasSpecialAndDecimal_ExternalNoSpecial()
+ {
+ const string seriesName = "Test - Volume Complete";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(2)
+ .WithTotalCount(3)
+ .Build())
+ .WithVolume(new VolumeBuilder("1").WithNumber(1).Build())
+ .WithVolume(new VolumeBuilder("1.5").WithNumber(1.5f).Build())
+ .WithVolume(new VolumeBuilder("2").WithNumber(2).Build())
+ .WithVolume(new VolumeBuilder(Parser.SpecialVolume).Build())
+ .Build();
+
+ var chapters = new List();
+ // External metadata includes volume 1.5, but not the special
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 0, Volumes = 3 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, 2);
+
+ Assert.True(result);
+ Assert.Equal(3, series.Metadata.MaxCount);
+ Assert.Equal(3, series.Metadata.TotalCount);
+ }
+
+ ///
+ /// This unit test also illustrates the bug where you may get a false positive if you had Volumes 1,2, and 2.1. While
+ /// missing volume 3. With the external metadata expecting non-decimal volumes.
+ /// i.e. it would fail if we only had one decimal volume
+ ///
+ [Fact]
+ public void IsSeriesCompleted_Volumes_TooManyDecimalVolumes()
+ {
+ const string seriesName = "Test - Volume Complete";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(2)
+ .WithTotalCount(3)
+ .Build())
+ .WithVolume(new VolumeBuilder("1").WithNumber(1).Build())
+ .WithVolume(new VolumeBuilder("2").WithNumber(2).Build())
+ .WithVolume(new VolumeBuilder("2.1").WithNumber(2.1f).Build())
+ .WithVolume(new VolumeBuilder("2.2").WithNumber(2.2f).Build())
+ .Build();
+
+ var chapters = new List();
+ // External metadata includes no special or decimals. There are 3 volumes. And we're missing volume 3
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 0, Volumes = 3 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, 2);
+
+ Assert.False(result);
+ }
+
+ [Fact]
+ public void IsSeriesCompleted_NoVolumes_GEQChapterCheck()
+ {
+ // We own 11 chapters, the external metadata expects 10
+ const string seriesName = "Test - Chapter MaxCount, no volumes";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(11)
+ .WithTotalCount(10)
+ .Build())
+ .Build();
+
+ var chapters = new List();
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 10, Volumes = 0 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, Parser.DefaultChapterNumber);
+
+ Assert.True(result);
+ Assert.Equal(11, series.Metadata.TotalCount);
+ Assert.Equal(11, series.Metadata.MaxCount);
+ }
+
+ [Fact]
+ public void IsSeriesCompleted_NoVolumes_IncludeAllChaptersCheck()
+ {
+ const string seriesName = "Test - Chapter Count";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(7)
+ .WithTotalCount(10)
+ .Build())
+ .Build();
+
+ var chapters = new List
+ {
+ new ChapterBuilder("0").Build(),
+ new ChapterBuilder("2").Build(),
+ new ChapterBuilder("3").Build(),
+ new ChapterBuilder("4").Build(),
+ new ChapterBuilder("5").Build(),
+ new ChapterBuilder("6").Build(),
+ new ChapterBuilder("7").Build(),
+ new ChapterBuilder("7.1").Build(),
+ new ChapterBuilder("7.2").Build(),
+ new ChapterBuilder("7.3").Build()
+ };
+ // External metadata includes prologues (0) and extra's (7.X)
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 10, Volumes = 0 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, Parser.DefaultChapterNumber);
+
+ Assert.True(result);
+ Assert.Equal(10, series.Metadata.TotalCount);
+ Assert.Equal(10, series.Metadata.MaxCount);
+ }
+
+ [Fact]
+ public void IsSeriesCompleted_NotEnoughVolumes()
+ {
+ const string seriesName = "Test - Incomplete Volume";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(2)
+ .WithTotalCount(5)
+ .Build())
+ .WithVolume(new VolumeBuilder("1").WithNumber(1).Build())
+ .WithVolume(new VolumeBuilder("2").WithNumber(2).Build())
+ .Build();
+
+ var chapters = new List();
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 0, Volumes = 5 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, 2);
+
+ Assert.False(result);
+ }
+
+ [Fact]
+ public void IsSeriesCompleted_NoVolumes_NotEnoughChapters()
+ {
+ const string seriesName = "Test - Incomplete Chapter";
+ var series = new SeriesBuilder(seriesName)
+ .WithLibraryId(1)
+ .WithMetadata(new SeriesMetadataBuilder()
+ .WithMaxCount(5)
+ .WithTotalCount(8)
+ .Build())
+ .Build();
+
+ var chapters = new List
+ {
+ new ChapterBuilder("1").Build(),
+ new ChapterBuilder("2").Build(),
+ new ChapterBuilder("3").Build()
+ };
+ var externalMetadata = new ExternalSeriesDetailDto { Chapters = 10, Volumes = 0 };
+
+ var result = ExternalMetadataService.IsSeriesCompleted(series, chapters, externalMetadata, Parser.DefaultChapterNumber);
+
+ Assert.False(result);
+ }
+
#endregion
@@ -2935,6 +3147,8 @@ public class ExternalMetadataServiceTests : AbstractDbTest
metadataSettings.EnableTags = false;
metadataSettings.EnablePublicationStatus = false;
metadataSettings.EnableStartDate = false;
+ metadataSettings.FieldMappings = [];
+ metadataSettings.AgeRatingMappings = new Dictionary();
Context.MetadataSettings.Update(metadataSettings);
await Context.SaveChangesAsync();
diff --git a/API.Tests/Services/ImageServiceTests.cs b/API.Tests/Services/ImageServiceTests.cs
index a1073a55b..f2c87e1ad 100644
--- a/API.Tests/Services/ImageServiceTests.cs
+++ b/API.Tests/Services/ImageServiceTests.cs
@@ -161,10 +161,10 @@ public class ImageServiceTests
private static void GenerateColorImage(string hexColor, string outputPath)
{
- var color = ImageService.HexToRgb(hexColor);
- using var colorImage = Image.Black(200, 100);
- using var output = colorImage + new[] { color.R / 255.0, color.G / 255.0, color.B / 255.0 };
- output.WriteToFile(outputPath);
+ var (r, g, b) = ImageService.HexToRgb(hexColor);
+ using var blackImage = Image.Black(200, 100);
+ using var colorImage = blackImage.NewFromImage(r, g, b);
+ colorImage.WriteToFile(outputPath);
}
private void GenerateHtmlFileForColorScape()
diff --git a/API.Tests/Services/ParseScannedFilesTests.cs b/API.Tests/Services/ParseScannedFilesTests.cs
index f8714f69a..a732b2526 100644
--- a/API.Tests/Services/ParseScannedFilesTests.cs
+++ b/API.Tests/Services/ParseScannedFilesTests.cs
@@ -58,35 +58,35 @@ public class MockReadingItemService : IReadingItemService
throw new NotImplementedException();
}
- public ParserInfo Parse(string path, string rootPath, string libraryRoot, LibraryType type)
+ public ParserInfo Parse(string path, string rootPath, string libraryRoot, LibraryType type, bool enableMetadata)
{
if (_comicVineParser.IsApplicable(path, type))
{
- return _comicVineParser.Parse(path, rootPath, libraryRoot, type, GetComicInfo(path));
+ return _comicVineParser.Parse(path, rootPath, libraryRoot, type, enableMetadata, GetComicInfo(path));
}
if (_imageParser.IsApplicable(path, type))
{
- return _imageParser.Parse(path, rootPath, libraryRoot, type, GetComicInfo(path));
+ return _imageParser.Parse(path, rootPath, libraryRoot, type, enableMetadata, GetComicInfo(path));
}
if (_bookParser.IsApplicable(path, type))
{
- return _bookParser.Parse(path, rootPath, libraryRoot, type, GetComicInfo(path));
+ return _bookParser.Parse(path, rootPath, libraryRoot, type, enableMetadata, GetComicInfo(path));
}
if (_pdfParser.IsApplicable(path, type))
{
- return _pdfParser.Parse(path, rootPath, libraryRoot, type, GetComicInfo(path));
+ return _pdfParser.Parse(path, rootPath, libraryRoot, type, enableMetadata, GetComicInfo(path));
}
if (_basicParser.IsApplicable(path, type))
{
- return _basicParser.Parse(path, rootPath, libraryRoot, type, GetComicInfo(path));
+ return _basicParser.Parse(path, rootPath, libraryRoot, type, enableMetadata, GetComicInfo(path));
}
return null;
}
- public ParserInfo ParseFile(string path, string rootPath, string libraryRoot, LibraryType type)
+ public ParserInfo ParseFile(string path, string rootPath, string libraryRoot, LibraryType type, bool enableMetadata)
{
- return Parse(path, rootPath, libraryRoot, type);
+ return Parse(path, rootPath, libraryRoot, type, enableMetadata);
}
}
diff --git a/API.Tests/Services/ScannerServiceTests.cs b/API.Tests/Services/ScannerServiceTests.cs
index 2e812647b..c337d2311 100644
--- a/API.Tests/Services/ScannerServiceTests.cs
+++ b/API.Tests/Services/ScannerServiceTests.cs
@@ -483,7 +483,7 @@ public class ScannerServiceTests : AbstractDbTest
var infos = new Dictionary();
var library = await _scannerHelper.GenerateScannerData(testcase, infos);
- library.LibraryExcludePatterns = [new LibraryExcludePattern() {Pattern = "**/Extra/*"}];
+ library.LibraryExcludePatterns = [new LibraryExcludePattern() { Pattern = "**/Extra/*" }];
UnitOfWork.LibraryRepository.Update(library);
await UnitOfWork.CommitAsync();
@@ -507,7 +507,7 @@ public class ScannerServiceTests : AbstractDbTest
var infos = new Dictionary();
var library = await _scannerHelper.GenerateScannerData(testcase, infos);
- library.LibraryExcludePatterns = [new LibraryExcludePattern() {Pattern = "**\\Extra\\*"}];
+ library.LibraryExcludePatterns = [new LibraryExcludePattern() { Pattern = "**\\Extra\\*" }];
UnitOfWork.LibraryRepository.Update(library);
await UnitOfWork.CommitAsync();
@@ -938,4 +938,61 @@ public class ScannerServiceTests : AbstractDbTest
Assert.True(sortedChapters[1].SortOrder.Is(4f));
Assert.True(sortedChapters[2].SortOrder.Is(5f));
}
+
+
+ [Fact]
+ public async Task ScanLibrary_MetadataDisabled_NoOverrides()
+ {
+ const string testcase = "Series with Localized No Metadata - Manga.json";
+
+ // Get the first file and generate a ComicInfo
+ var infos = new Dictionary();
+ infos.Add("Immoral Guild v01.cbz", new ComicInfo()
+ {
+ Series = "Immoral Guild",
+ LocalizedSeries = "Futoku no Guild" // Filename has a capital N and localizedSeries has lowercase
+ });
+
+ var library = await _scannerHelper.GenerateScannerData(testcase, infos);
+
+ // Disable metadata
+ library.EnableMetadata = false;
+ UnitOfWork.LibraryRepository.Update(library);
+ await UnitOfWork.CommitAsync();
+
+ var scanner = _scannerHelper.CreateServices();
+ await scanner.ScanLibrary(library.Id);
+
+ var postLib = await UnitOfWork.LibraryRepository.GetLibraryForIdAsync(library.Id, LibraryIncludes.Series);
+
+ // Validate that there are 2 series
+ Assert.NotNull(postLib);
+ Assert.Equal(2, postLib.Series.Count);
+
+ Assert.Contains(postLib.Series, x => x.Name == "Immoral Guild");
+ Assert.Contains(postLib.Series, x => x.Name == "Futoku No Guild");
+ }
+
+ [Fact]
+ public async Task ScanLibrary_SortName_NoPrefix()
+ {
+ const string testcase = "Series with Prefix - Book.json";
+
+ var library = await _scannerHelper.GenerateScannerData(testcase);
+
+ library.RemovePrefixForSortName = true;
+ UnitOfWork.LibraryRepository.Update(library);
+ await UnitOfWork.CommitAsync();
+
+ var scanner = _scannerHelper.CreateServices();
+ await scanner.ScanLibrary(library.Id);
+
+ var postLib = await UnitOfWork.LibraryRepository.GetLibraryForIdAsync(library.Id, LibraryIncludes.Series);
+
+ Assert.NotNull(postLib);
+ Assert.Equal(1, postLib.Series.Count);
+
+ Assert.Equal("The Avengers", postLib.Series.First().Name);
+ Assert.Equal("Avengers", postLib.Series.First().SortName);
+ }
}
diff --git a/API.Tests/Services/ScrobblingServiceTests.cs b/API.Tests/Services/ScrobblingServiceTests.cs
index 50398a146..9245c8ecd 100644
--- a/API.Tests/Services/ScrobblingServiceTests.cs
+++ b/API.Tests/Services/ScrobblingServiceTests.cs
@@ -1,11 +1,17 @@
-using System.Linq;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
using System.Threading.Tasks;
+using API.Data.Repositories;
using API.DTOs.Scrobbling;
+using API.Entities;
using API.Entities.Enums;
+using API.Entities.Scrobble;
using API.Helpers.Builders;
using API.Services;
using API.Services.Plus;
using API.SignalR;
+using Kavita.Common;
using Microsoft.Extensions.Logging;
using NSubstitute;
using Xunit;
@@ -15,11 +21,33 @@ namespace API.Tests.Services;
public class ScrobblingServiceTests : AbstractDbTest
{
+ private const int ChapterPages = 100;
+
+ ///
+ /// {
+ /// "Issuer": "Issuer",
+ /// "Issued At": "2025-06-15T21:01:57.615Z",
+ /// "Expiration": "2200-06-15T21:01:57.615Z"
+ /// }
+ ///
+ /// Our UnitTests will fail in 2200 :(
+ private const string ValidJwtToken =
+ "eyJhbGciOiJIUzI1NiJ9.eyJJc3N1ZXIiOiJJc3N1ZXIiLCJleHAiOjcyNzI0NTAxMTcsImlhdCI6MTc1MDAyMTMxN30.zADmcGq_BfxbcV8vy4xw5Cbzn4COkmVINxgqpuL17Ng";
+
private readonly ScrobblingService _service;
private readonly ILicenseService _licenseService;
private readonly ILocalizationService _localizationService;
private readonly ILogger _logger;
private readonly IEmailService _emailService;
+ private readonly IKavitaPlusApiService _kavitaPlusApiService;
+ ///
+ /// IReaderService, without the ScrobblingService injected
+ ///
+ private readonly IReaderService _readerService;
+ ///
+ /// IReaderService, with the _service injected
+ ///
+ private readonly IReaderService _hookedUpReaderService;
public ScrobblingServiceTests()
{
@@ -27,8 +55,24 @@ public class ScrobblingServiceTests : AbstractDbTest
_localizationService = Substitute.For();
_logger = Substitute.For>();
_emailService = Substitute.For();
+ _kavitaPlusApiService = Substitute.For();
- _service = new ScrobblingService(UnitOfWork, Substitute.For(), _logger, _licenseService, _localizationService, _emailService);
+ _service = new ScrobblingService(UnitOfWork, Substitute.For(), _logger, _licenseService,
+ _localizationService, _emailService, _kavitaPlusApiService);
+
+ _readerService = new ReaderService(UnitOfWork,
+ Substitute.For>(),
+ Substitute.For(),
+ Substitute.For(),
+ Substitute.For(),
+ Substitute.For()); // Do not use the actual one
+
+ _hookedUpReaderService = new ReaderService(UnitOfWork,
+ Substitute.For>(),
+ Substitute.For(),
+ Substitute.For(),
+ Substitute.For(),
+ _service);
}
protected override async Task ResetDb()
@@ -46,6 +90,30 @@ public class ScrobblingServiceTests : AbstractDbTest
var series = new SeriesBuilder("Test Series")
.WithFormat(MangaFormat.Archive)
.WithMetadata(new SeriesMetadataBuilder().Build())
+ .WithVolume(new VolumeBuilder("Volume 1")
+ .WithChapters([
+ new ChapterBuilder("1")
+ .WithPages(ChapterPages)
+ .Build(),
+ new ChapterBuilder("2")
+ .WithPages(ChapterPages)
+ .Build(),
+ new ChapterBuilder("3")
+ .WithPages(ChapterPages)
+ .Build()])
+ .Build())
+ .WithVolume(new VolumeBuilder("Volume 2")
+ .WithChapters([
+ new ChapterBuilder("4")
+ .WithPages(ChapterPages)
+ .Build(),
+ new ChapterBuilder("5")
+ .WithPages(ChapterPages)
+ .Build(),
+ new ChapterBuilder("6")
+ .WithPages(ChapterPages)
+ .Build()])
+ .Build())
.Build();
var library = new LibraryBuilder("Test Library", LibraryType.Manga)
@@ -67,6 +135,296 @@ public class ScrobblingServiceTests : AbstractDbTest
await UnitOfWork.CommitAsync();
}
+ private async Task CreateScrobbleEvent(int? seriesId = null)
+ {
+ var evt = new ScrobbleEvent
+ {
+ ScrobbleEventType = ScrobbleEventType.ChapterRead,
+ Format = PlusMediaFormat.Manga,
+ SeriesId = seriesId ?? 0,
+ LibraryId = 0,
+ AppUserId = 0,
+ };
+
+ if (seriesId != null)
+ {
+ var series = await UnitOfWork.SeriesRepository.GetSeriesByIdAsync(seriesId.Value);
+ if (series != null) evt.Series = series;
+ }
+
+ return evt;
+ }
+
+
+ #region K+ API Request Tests
+
+ [Fact]
+ public async Task PostScrobbleUpdate_AuthErrors()
+ {
+ _kavitaPlusApiService.PostScrobbleUpdate(null!, "")
+ .ReturnsForAnyArgs(new ScrobbleResponseDto()
+ {
+ ErrorMessage = "Unauthorized"
+ });
+
+ var evt = await CreateScrobbleEvent();
+ await Assert.ThrowsAsync(async () =>
+ {
+ await _service.PostScrobbleUpdate(new ScrobbleDto(), "", evt);
+ });
+ Assert.True(evt.IsErrored);
+ Assert.Equal("Kavita+ subscription no longer active", evt.ErrorDetails);
+ }
+
+ [Fact]
+ public async Task PostScrobbleUpdate_UnknownSeriesLoggedAsError()
+ {
+ _kavitaPlusApiService.PostScrobbleUpdate(null!, "")
+ .ReturnsForAnyArgs(new ScrobbleResponseDto()
+ {
+ ErrorMessage = "Unknown Series"
+ });
+
+ await SeedData();
+ var evt = await CreateScrobbleEvent(1);
+
+ await _service.PostScrobbleUpdate(new ScrobbleDto(), "", evt);
+ await UnitOfWork.CommitAsync();
+ Assert.True(evt.IsErrored);
+
+ var series = await UnitOfWork.SeriesRepository.GetSeriesByIdAsync(1);
+ Assert.NotNull(series);
+ Assert.True(series.IsBlacklisted);
+
+ var errors = await UnitOfWork.ScrobbleRepository.GetAllScrobbleErrorsForSeries(1);
+ Assert.Single(errors);
+ Assert.Equal("Series cannot be matched for Scrobbling", errors.First().Comment);
+ Assert.Equal(series.Id, errors.First().SeriesId);
+ }
+
+ [Fact]
+ public async Task PostScrobbleUpdate_InvalidAccessToken()
+ {
+ _kavitaPlusApiService.PostScrobbleUpdate(null!, "")
+ .ReturnsForAnyArgs(new ScrobbleResponseDto()
+ {
+ ErrorMessage = "Access token is invalid"
+ });
+
+ var evt = await CreateScrobbleEvent();
+
+ await Assert.ThrowsAsync(async () =>
+ {
+ await _service.PostScrobbleUpdate(new ScrobbleDto(), "", evt);
+ });
+
+ Assert.True(evt.IsErrored);
+ Assert.Equal("Access Token needs to be rotated to continue scrobbling", evt.ErrorDetails);
+ }
+
+ #endregion
+
+ #region K+ API Request data tests
+
+ [Fact]
+ public async Task ProcessReadEvents_CreatesNoEventsWhenNoProgress()
+ {
+ await ResetDb();
+ await SeedData();
+
+ // Set Returns
+ _licenseService.HasActiveLicense().Returns(Task.FromResult(true));
+ _kavitaPlusApiService.GetRateLimit(Arg.Any(), Arg.Any())
+ .Returns(100);
+
+ var user = await UnitOfWork.UserRepository.GetUserByIdAsync(1);
+ Assert.NotNull(user);
+
+ // Ensure CanProcessScrobbleEvent returns true
+ user.AniListAccessToken = ValidJwtToken;
+ UnitOfWork.UserRepository.Update(user);
+ await UnitOfWork.CommitAsync();
+
+ var chapter = await UnitOfWork.ChapterRepository.GetChapterAsync(4);
+ Assert.NotNull(chapter);
+
+ var volume = await UnitOfWork.VolumeRepository.GetVolumeAsync(1, VolumeIncludes.Chapters);
+ Assert.NotNull(volume);
+
+ // Call Scrobble without having any progress
+ await _service.ScrobbleReadingUpdate(1, 1);
+ var events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Empty(events);
+ }
+
+ [Fact]
+ public async Task ProcessReadEvents_UpdateVolumeAndChapterData()
+ {
+ await ResetDb();
+ await SeedData();
+
+ // Set Returns
+ _licenseService.HasActiveLicense().Returns(Task.FromResult(true));
+ _kavitaPlusApiService.GetRateLimit(Arg.Any(), Arg.Any())
+ .Returns(100);
+
+ var user = await UnitOfWork.UserRepository.GetUserByIdAsync(1);
+ Assert.NotNull(user);
+
+ // Ensure CanProcessScrobbleEvent returns true
+ user.AniListAccessToken = ValidJwtToken;
+ UnitOfWork.UserRepository.Update(user);
+ await UnitOfWork.CommitAsync();
+
+ var chapter = await UnitOfWork.ChapterRepository.GetChapterAsync(4);
+ Assert.NotNull(chapter);
+
+ var volume = await UnitOfWork.VolumeRepository.GetVolumeAsync(1, VolumeIncludes.Chapters);
+ Assert.NotNull(volume);
+
+ // Mark something as read to trigger event creation
+ await _readerService.MarkChaptersAsRead(user, 1, new List() {volume.Chapters[0]});
+ await UnitOfWork.CommitAsync();
+
+ // Call Scrobble while having some progress
+ await _service.ScrobbleReadingUpdate(user.Id, 1);
+ var events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Single(events);
+
+ // Give it some (more) read progress
+ await _readerService.MarkChaptersAsRead(user, 1, volume.Chapters);
+ await _readerService.MarkChaptersAsRead(user, 1, [chapter]);
+ await UnitOfWork.CommitAsync();
+
+ await _service.ProcessUpdatesSinceLastSync();
+
+ await _kavitaPlusApiService.Received(1).PostScrobbleUpdate(
+ Arg.Is(data =>
+ data.ChapterNumber == (int)chapter.MaxNumber &&
+ data.VolumeNumber == (int)volume.MaxNumber
+ ),
+ Arg.Any());
+ }
+
+ #endregion
+
+ #region Scrobble Reading Update Tests
+
+ [Fact]
+ public async Task ScrobbleReadingUpdate_IgnoreNoLicense()
+ {
+ await ResetDb();
+ await SeedData();
+
+ _licenseService.HasActiveLicense().Returns(false);
+
+ await _service.ScrobbleReadingUpdate(1, 1);
+ var events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Empty(events);
+ }
+
+ [Fact]
+ public async Task ScrobbleReadingUpdate_RemoveWhenNoProgress()
+ {
+ await ResetDb();
+ await SeedData();
+
+ _licenseService.HasActiveLicense().Returns(true);
+
+ var user = await UnitOfWork.UserRepository.GetUserByIdAsync(1);
+ Assert.NotNull(user);
+
+ var volume = await UnitOfWork.VolumeRepository.GetVolumeAsync(1, VolumeIncludes.Chapters);
+ Assert.NotNull(volume);
+
+ await _readerService.MarkChaptersAsRead(user, 1, new List() {volume.Chapters[0]});
+ await UnitOfWork.CommitAsync();
+
+ await _service.ScrobbleReadingUpdate(1, 1);
+ var events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Single(events);
+
+ var readEvent = events.First();
+ Assert.False(readEvent.IsProcessed);
+
+ await _hookedUpReaderService.MarkSeriesAsUnread(user, 1);
+ await UnitOfWork.CommitAsync();
+
+ // Existing event is deleted
+ await _service.ScrobbleReadingUpdate(1, 1);
+ events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Empty(events);
+
+ await _hookedUpReaderService.MarkSeriesAsUnread(user, 1);
+ await UnitOfWork.CommitAsync();
+
+ // No new events are added
+ events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Empty(events);
+ }
+
+ [Fact]
+ public async Task ScrobbleReadingUpdate_UpdateExistingNotIsProcessed()
+ {
+ await ResetDb();
+ await SeedData();
+
+ var user = await UnitOfWork.UserRepository.GetUserByIdAsync(1);
+ Assert.NotNull(user);
+
+ var chapter1 = await UnitOfWork.ChapterRepository.GetChapterAsync(1);
+ var chapter2 = await UnitOfWork.ChapterRepository.GetChapterAsync(2);
+ var chapter3 = await UnitOfWork.ChapterRepository.GetChapterAsync(3);
+ Assert.NotNull(chapter1);
+ Assert.NotNull(chapter2);
+ Assert.NotNull(chapter3);
+
+ _licenseService.HasActiveLicense().Returns(true);
+
+ var events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Empty(events);
+
+
+ await _readerService.MarkChaptersAsRead(user, 1, [chapter1]);
+ await UnitOfWork.CommitAsync();
+
+ // Scrobble update
+ await _service.ScrobbleReadingUpdate(1, 1);
+ events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Single(events);
+
+ var readEvent = events[0];
+ Assert.False(readEvent.IsProcessed);
+ Assert.Equal(1, readEvent.ChapterNumber);
+
+ // Mark as processed
+ readEvent.IsProcessed = true;
+ await UnitOfWork.CommitAsync();
+
+ await _readerService.MarkChaptersAsRead(user, 1, [chapter2]);
+ await UnitOfWork.CommitAsync();
+
+ // Scrobble update
+ await _service.ScrobbleReadingUpdate(1, 1);
+ events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Equal(2, events.Count);
+ Assert.Single(events.Where(e => e.IsProcessed).ToList());
+ Assert.Single(events.Where(e => !e.IsProcessed).ToList());
+
+ // Should update the existing non processed event
+ await _readerService.MarkChaptersAsRead(user, 1, [chapter3]);
+ await UnitOfWork.CommitAsync();
+
+ // Scrobble update
+ await _service.ScrobbleReadingUpdate(1, 1);
+ events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Equal(2, events.Count);
+ Assert.Single(events.Where(e => e.IsProcessed).ToList());
+ Assert.Single(events.Where(e => !e.IsProcessed).ToList());
+ }
+
+ #endregion
+
#region ScrobbleWantToReadUpdate Tests
[Fact]
@@ -203,6 +561,59 @@ public class ScrobblingServiceTests : AbstractDbTest
#endregion
+ #region Scrobble Rating Update Test
+
+ [Fact]
+ public async Task ScrobbleRatingUpdate_IgnoreNoLicense()
+ {
+ await ResetDb();
+ await SeedData();
+
+ _licenseService.HasActiveLicense().Returns(false);
+
+ await _service.ScrobbleRatingUpdate(1, 1, 1);
+ var events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Empty(events);
+ }
+
+ [Fact]
+ public async Task ScrobbleRatingUpdate_UpdateExistingNotIsProcessed()
+ {
+ await ResetDb();
+ await SeedData();
+
+ _licenseService.HasActiveLicense().Returns(true);
+
+ var user = await UnitOfWork.UserRepository.GetUserByIdAsync(1);
+ Assert.NotNull(user);
+
+ var series = await UnitOfWork.SeriesRepository.GetSeriesByIdAsync(1);
+ Assert.NotNull(series);
+
+ await _service.ScrobbleRatingUpdate(user.Id, series.Id, 1);
+ var events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Single(events);
+ Assert.Equal(1, events.First().Rating);
+
+ // Mark as processed
+ events.First().IsProcessed = true;
+ await UnitOfWork.CommitAsync();
+
+ await _service.ScrobbleRatingUpdate(user.Id, series.Id, 5);
+ events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Equal(2, events.Count);
+ Assert.Single(events, evt => evt.IsProcessed);
+ Assert.Single(events, evt => !evt.IsProcessed);
+
+ await _service.ScrobbleRatingUpdate(user.Id, series.Id, 5);
+ events = await UnitOfWork.ScrobbleRepository.GetAllEventsForSeries(1);
+ Assert.Single(events, evt => !evt.IsProcessed);
+ Assert.Equal(5, events.First(evt => !evt.IsProcessed).Rating);
+
+ }
+
+ #endregion
+
[Theory]
[InlineData("https://anilist.co/manga/35851/Byeontaega-Doeja/", 35851)]
[InlineData("https://anilist.co/manga/30105", 30105)]
diff --git a/API.Tests/Services/Test Data/ScannerService/TestCases/Series with Localized No Metadata - Manga.json b/API.Tests/Services/Test Data/ScannerService/TestCases/Series with Localized No Metadata - Manga.json
new file mode 100644
index 000000000..d6e91183b
--- /dev/null
+++ b/API.Tests/Services/Test Data/ScannerService/TestCases/Series with Localized No Metadata - Manga.json
@@ -0,0 +1,5 @@
+[
+ "Immoral Guild/Immoral Guild v01.cbz",
+ "Immoral Guild/Immoral Guild v02.cbz",
+ "Immoral Guild/Futoku No Guild - Vol. 12 Ch. 67 - Take Responsibility.cbz"
+]
diff --git a/API.Tests/Services/Test Data/ScannerService/TestCases/Series with Prefix - Book.json b/API.Tests/Services/Test Data/ScannerService/TestCases/Series with Prefix - Book.json
new file mode 100644
index 000000000..fc2bee18c
--- /dev/null
+++ b/API.Tests/Services/Test Data/ScannerService/TestCases/Series with Prefix - Book.json
@@ -0,0 +1,3 @@
+[
+ "The Avengers/The Avengers vol 1.pdf"
+]
\ No newline at end of file
diff --git a/API/API.csproj b/API/API.csproj
index f9a889d74..a7d1177dc 100644
--- a/API/API.csproj
+++ b/API/API.csproj
@@ -50,9 +50,9 @@
-
-
-
+
+
+
all
runtime; build; native; contentfiles; analyzers; buildtransitive
@@ -62,25 +62,25 @@
-
+
-
+
-
-
-
-
-
+
+
+
+
+
-
-
-
+
+
+
@@ -89,17 +89,17 @@
-
-
-
+
+
+
all
runtime; build; native; contentfiles; analyzers; buildtransitive
-
+
-
+
+
-
diff --git a/API/Controllers/ChapterController.cs b/API/Controllers/ChapterController.cs
index 8de26cf97..94535d499 100644
--- a/API/Controllers/ChapterController.cs
+++ b/API/Controllers/ChapterController.cs
@@ -9,6 +9,7 @@ using API.DTOs;
using API.DTOs.SeriesDetail;
using API.Entities;
using API.Entities.Enums;
+using API.Entities.MetadataMatching;
using API.Entities.Person;
using API.Extensions;
using API.Helpers;
@@ -208,6 +209,7 @@ public class ChapterController : BaseApiController
if (chapter.AgeRating != dto.AgeRating)
{
chapter.AgeRating = dto.AgeRating;
+ chapter.KPlusOverrides.Remove(MetadataSettingField.AgeRating);
}
dto.Summary ??= string.Empty;
@@ -215,6 +217,7 @@ public class ChapterController : BaseApiController
if (chapter.Summary != dto.Summary.Trim())
{
chapter.Summary = dto.Summary.Trim();
+ chapter.KPlusOverrides.Remove(MetadataSettingField.ChapterSummary);
}
if (chapter.Language != dto.Language)
@@ -230,11 +233,13 @@ public class ChapterController : BaseApiController
if (chapter.TitleName != dto.TitleName)
{
chapter.TitleName = dto.TitleName;
+ chapter.KPlusOverrides.Remove(MetadataSettingField.ChapterTitle);
}
if (chapter.ReleaseDate != dto.ReleaseDate)
{
chapter.ReleaseDate = dto.ReleaseDate;
+ chapter.KPlusOverrides.Remove(MetadataSettingField.ChapterReleaseDate);
}
if (!string.IsNullOrEmpty(dto.ISBN) && ArticleNumberHelper.IsValidIsbn10(dto.ISBN) ||
@@ -333,6 +338,8 @@ public class ChapterController : BaseApiController
_unitOfWork
);
+ // TODO: Only remove field if changes were made
+ chapter.KPlusOverrides.Remove(MetadataSettingField.ChapterPublisher);
// Update publishers
await PersonHelper.UpdateChapterPeopleAsync(
chapter,
diff --git a/API/Controllers/KoreaderController.cs b/API/Controllers/KoreaderController.cs
new file mode 100644
index 000000000..8c4c41585
--- /dev/null
+++ b/API/Controllers/KoreaderController.cs
@@ -0,0 +1,119 @@
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using System;
+using System.Threading.Tasks;
+using API.Data;
+using API.Data.Repositories;
+using API.DTOs.Koreader;
+using API.Entities;
+using API.Extensions;
+using API.Services;
+using Kavita.Common;
+using Microsoft.AspNetCore.Identity;
+using Microsoft.Extensions.Logging;
+using static System.Net.WebRequestMethods;
+
+namespace API.Controllers;
+#nullable enable
+
+///
+/// The endpoint to interface with Koreader's Progress Sync plugin.
+///
+///
+/// Koreader uses a different form of authentication. It stores the username and password in headers.
+/// https://github.com/koreader/koreader/blob/master/plugins/kosync.koplugin/KOSyncClient.lua
+///
+[AllowAnonymous]
+public class KoreaderController : BaseApiController
+{
+
+ private readonly IUnitOfWork _unitOfWork;
+ private readonly ILocalizationService _localizationService;
+ private readonly IKoreaderService _koreaderService;
+ private readonly ILogger _logger;
+
+ public KoreaderController(IUnitOfWork unitOfWork, ILocalizationService localizationService,
+ IKoreaderService koreaderService, ILogger logger)
+ {
+ _unitOfWork = unitOfWork;
+ _localizationService = localizationService;
+ _koreaderService = koreaderService;
+ _logger = logger;
+ }
+
+ // We won't allow users to be created from Koreader. Rather, they
+ // must already have an account.
+ /*
+ [HttpPost("/users/create")]
+ public IActionResult CreateUser(CreateUserRequest request)
+ {
+ }
+ */
+
+ [HttpGet("{apiKey}/users/auth")]
+ public async Task Authenticate(string apiKey)
+ {
+ var userId = await GetUserId(apiKey);
+ var user = await _unitOfWork.UserRepository.GetUserByIdAsync(userId);
+ if (user == null) return Unauthorized();
+
+ return Ok(new { username = user.UserName });
+ }
+
+ ///
+ /// Syncs book progress with Kavita. Will attempt to save the underlying reader position if possible.
+ ///
+ ///
+ ///
+ ///
+ [HttpPut("{apiKey}/syncs/progress")]
+ public async Task> UpdateProgress(string apiKey, KoreaderBookDto request)
+ {
+ try
+ {
+ var userId = await GetUserId(apiKey);
+ await _koreaderService.SaveProgress(request, userId);
+
+ return Ok(new KoreaderProgressUpdateDto{ Document = request.Document, Timestamp = DateTime.UtcNow });
+ }
+ catch (KavitaException ex)
+ {
+ return BadRequest(ex.Message);
+ }
+ }
+
+ ///
+ /// Gets book progress from Kavita, if not found will return a 400
+ ///
+ ///
+ ///
+ ///
+ [HttpGet("{apiKey}/syncs/progress/{ebookHash}")]
+ public async Task> GetProgress(string apiKey, string ebookHash)
+ {
+ try
+ {
+ var userId = await GetUserId(apiKey);
+ var response = await _koreaderService.GetProgress(ebookHash, userId);
+ _logger.LogDebug("Koreader response progress for User ({UserId}): {Progress}", userId, response.Progress.Sanitize());
+
+ return Ok(response);
+ }
+ catch (KavitaException ex)
+ {
+ return BadRequest(ex.Message);
+ }
+ }
+
+ private async Task GetUserId(string apiKey)
+ {
+ try
+ {
+ return await _unitOfWork.UserRepository.GetUserIdByApiKeyAsync(apiKey);
+ }
+ catch
+ {
+ throw new KavitaException(await _localizationService.Get("en", "user-doesnt-exist"));
+ }
+ }
+}
diff --git a/API/Controllers/LibraryController.cs b/API/Controllers/LibraryController.cs
index 2f12aa1fe..8f9b18317 100644
--- a/API/Controllers/LibraryController.cs
+++ b/API/Controllers/LibraryController.cs
@@ -623,6 +623,9 @@ public class LibraryController : BaseApiController
library.ManageReadingLists = dto.ManageReadingLists;
library.AllowScrobbling = dto.AllowScrobbling;
library.AllowMetadataMatching = dto.AllowMetadataMatching;
+ library.EnableMetadata = dto.EnableMetadata;
+ library.RemovePrefixForSortName = dto.RemovePrefixForSortName;
+
library.LibraryFileTypes = dto.FileGroupTypes
.Select(t => new LibraryFileTypeGroup() {FileTypeGroup = t, LibraryId = library.Id})
.Distinct()
diff --git a/API/Controllers/MetadataController.cs b/API/Controllers/MetadataController.cs
index 10a5f393a..cab33692a 100644
--- a/API/Controllers/MetadataController.cs
+++ b/API/Controllers/MetadataController.cs
@@ -6,8 +6,10 @@ using System.Threading.Tasks;
using API.Constants;
using API.Data;
using API.Data.Repositories;
+using API.DTOs;
using API.DTOs.Filtering;
using API.DTOs.Metadata;
+using API.DTOs.Metadata.Browse;
using API.DTOs.Person;
using API.DTOs.Recommendation;
using API.DTOs.SeriesDetail;
@@ -46,6 +48,22 @@ public class MetadataController(IUnitOfWork unitOfWork, ILocalizationService loc
return Ok(await unitOfWork.GenreRepository.GetAllGenreDtosForLibrariesAsync(User.GetUserId(), ids, context));
}
+ ///
+ /// Returns a list of Genres with counts for counts when Genre is on Series/Chapter
+ ///
+ ///
+ [HttpPost("genres-with-counts")]
+ [ResponseCache(CacheProfileName = ResponseCacheProfiles.FiveMinute)]
+ public async Task>> GetBrowseGenres(UserParams? userParams = null)
+ {
+ userParams ??= UserParams.Default;
+
+ var list = await unitOfWork.GenreRepository.GetBrowseableGenre(User.GetUserId(), userParams);
+ Response.AddPaginationHeader(list.CurrentPage, list.PageSize, list.TotalCount, list.TotalPages);
+
+ return Ok(list);
+ }
+
///
/// Fetches people from the instance by role
///
@@ -95,6 +113,22 @@ public class MetadataController(IUnitOfWork unitOfWork, ILocalizationService loc
return Ok(await unitOfWork.TagRepository.GetAllTagDtosForLibrariesAsync(User.GetUserId()));
}
+ ///
+ /// Returns a list of Tags with counts for counts when Tag is on Series/Chapter
+ ///
+ ///
+ [HttpPost("tags-with-counts")]
+ [ResponseCache(CacheProfileName = ResponseCacheProfiles.FiveMinute)]
+ public async Task>> GetBrowseTags(UserParams? userParams = null)
+ {
+ userParams ??= UserParams.Default;
+
+ var list = await unitOfWork.TagRepository.GetBrowseableTag(User.GetUserId(), userParams);
+ Response.AddPaginationHeader(list.CurrentPage, list.PageSize, list.TotalCount, list.TotalPages);
+
+ return Ok(list);
+ }
+
///
/// Fetches all age ratings from the instance
///
diff --git a/API/Controllers/PersonController.cs b/API/Controllers/PersonController.cs
index a2ab3bf88..7328ff954 100644
--- a/API/Controllers/PersonController.cs
+++ b/API/Controllers/PersonController.cs
@@ -4,6 +4,9 @@ using System.Threading.Tasks;
using API.Data;
using API.Data.Repositories;
using API.DTOs;
+using API.DTOs.Filtering.v2;
+using API.DTOs.Metadata.Browse;
+using API.DTOs.Metadata.Browse.Requests;
using API.DTOs.Person;
using API.Entities.Enums;
using API.Extensions;
@@ -77,11 +80,13 @@ public class PersonController : BaseApiController
///
///
[HttpPost("all")]
- public async Task>> GetAuthorsForBrowse([FromQuery] UserParams? userParams)
+ public async Task>> GetPeopleForBrowse(BrowsePersonFilterDto filter, [FromQuery] UserParams? userParams)
{
userParams ??= UserParams.Default;
- var list = await _unitOfWork.PersonRepository.GetAllWritersAndSeriesCount(User.GetUserId(), userParams);
+
+ var list = await _unitOfWork.PersonRepository.GetBrowsePersonDtos(User.GetUserId(), filter, userParams);
Response.AddPaginationHeader(list.CurrentPage, list.PageSize, list.TotalCount, list.TotalPages);
+
return Ok(list);
}
@@ -112,6 +117,7 @@ public class PersonController : BaseApiController
person.Name = dto.Name?.Trim();
+ person.NormalizedName = person.Name.ToNormalized();
person.Description = dto.Description ?? string.Empty;
person.CoverImageLocked = dto.CoverImageLocked;
@@ -179,7 +185,7 @@ public class PersonController : BaseApiController
[HttpGet("series-known-for")]
public async Task>> GetKnownSeries(int personId)
{
- return Ok(await _unitOfWork.PersonRepository.GetSeriesKnownFor(personId));
+ return Ok(await _unitOfWork.PersonRepository.GetSeriesKnownFor(personId, User.GetUserId()));
}
///
@@ -200,6 +206,7 @@ public class PersonController : BaseApiController
///
///
[HttpPost("merge")]
+ [Authorize("RequireAdminRole")]
public async Task> MergePeople(PersonMergeDto dto)
{
var dst = await _unitOfWork.PersonRepository.GetPersonById(dto.DestId, PersonIncludes.All);
diff --git a/API/Controllers/ScrobblingController.cs b/API/Controllers/ScrobblingController.cs
index 3904cb8e0..986f4f8e7 100644
--- a/API/Controllers/ScrobblingController.cs
+++ b/API/Controllers/ScrobblingController.cs
@@ -254,7 +254,7 @@ public class ScrobblingController : BaseApiController
}
///
- /// Adds a hold against the Series for user's scrobbling
+ /// Remove a hold against the Series for user's scrobbling
///
///
///
@@ -281,4 +281,18 @@ public class ScrobblingController : BaseApiController
var user = await _unitOfWork.UserRepository.GetUserByIdAsync(User.GetUserId());
return Ok(user is {HasRunScrobbleEventGeneration: true});
}
+
+ ///
+ /// Delete the given scrobble events if they belong to that user
+ ///
+ ///
+ ///
+ [HttpPost("bulk-remove-events")]
+ public async Task BulkRemoveScrobbleEvents(IList eventIds)
+ {
+ var events = await _unitOfWork.ScrobbleRepository.GetUserEvents(User.GetUserId(), eventIds);
+ _unitOfWork.ScrobbleRepository.Remove(events);
+ await _unitOfWork.CommitAsync();
+ return Ok();
+ }
}
diff --git a/API/Controllers/SeriesController.cs b/API/Controllers/SeriesController.cs
index 84eacc838..389ff33a7 100644
--- a/API/Controllers/SeriesController.cs
+++ b/API/Controllers/SeriesController.cs
@@ -14,6 +14,7 @@ using API.DTOs.Recommendation;
using API.DTOs.SeriesDetail;
using API.Entities;
using API.Entities.Enums;
+using API.Entities.MetadataMatching;
using API.Extensions;
using API.Helpers;
using API.Services;
@@ -224,6 +225,7 @@ public class SeriesController : BaseApiController
needsRefreshMetadata = true;
series.CoverImage = null;
series.CoverImageLocked = false;
+ series.Metadata.KPlusOverrides.Remove(MetadataSettingField.Covers);
_logger.LogDebug("[SeriesCoverImageBug] Setting Series Cover Image to null: {SeriesId}", series.Id);
series.ResetColorScape();
diff --git a/API/Controllers/UploadController.cs b/API/Controllers/UploadController.cs
index 4b935a1bf..9652ba494 100644
--- a/API/Controllers/UploadController.cs
+++ b/API/Controllers/UploadController.cs
@@ -6,6 +6,7 @@ using API.Data;
using API.Data.Repositories;
using API.DTOs.Uploads;
using API.Entities.Enums;
+using API.Entities.MetadataMatching;
using API.Extensions;
using API.Services;
using API.Services.Tasks.Metadata;
@@ -112,8 +113,10 @@ public class UploadController : BaseApiController
series.CoverImage = filePath;
series.CoverImageLocked = lockState;
+ series.Metadata.KPlusOverrides.Remove(MetadataSettingField.Covers);
_imageService.UpdateColorScape(series);
_unitOfWork.SeriesRepository.Update(series);
+ _unitOfWork.SeriesRepository.Update(series.Metadata);
if (_unitOfWork.HasChanges())
{
@@ -277,6 +280,7 @@ public class UploadController : BaseApiController
chapter.CoverImage = filePath;
chapter.CoverImageLocked = lockState;
+ chapter.KPlusOverrides.Remove(MetadataSettingField.ChapterCovers);
_unitOfWork.ChapterRepository.Update(chapter);
var volume = await _unitOfWork.VolumeRepository.GetVolumeAsync(chapter.VolumeId);
if (volume != null)
diff --git a/API/DTOs/Filtering/PersonSortField.cs b/API/DTOs/Filtering/PersonSortField.cs
new file mode 100644
index 000000000..5268a1bf9
--- /dev/null
+++ b/API/DTOs/Filtering/PersonSortField.cs
@@ -0,0 +1,8 @@
+namespace API.DTOs.Filtering;
+
+public enum PersonSortField
+{
+ Name = 1,
+ SeriesCount = 2,
+ ChapterCount = 3
+}
diff --git a/API/DTOs/Filtering/SortOptions.cs b/API/DTOs/Filtering/SortOptions.cs
index a08e2968e..18f2b17ea 100644
--- a/API/DTOs/Filtering/SortOptions.cs
+++ b/API/DTOs/Filtering/SortOptions.cs
@@ -8,3 +8,12 @@ public sealed record SortOptions
public SortField SortField { get; set; }
public bool IsAscending { get; set; } = true;
}
+
+///
+/// All Sorting Options for a query related to Person Entity
+///
+public sealed record PersonSortOptions
+{
+ public PersonSortField SortField { get; set; }
+ public bool IsAscending { get; set; } = true;
+}
diff --git a/API/DTOs/Filtering/v2/FilterField.cs b/API/DTOs/Filtering/v2/FilterField.cs
index 5323f2b48..246a92a90 100644
--- a/API/DTOs/Filtering/v2/FilterField.cs
+++ b/API/DTOs/Filtering/v2/FilterField.cs
@@ -56,5 +56,12 @@ public enum FilterField
/// Last time User Read
///
ReadLast = 32,
-
+}
+
+public enum PersonFilterField
+{
+ Role = 1,
+ Name = 2,
+ SeriesCount = 3,
+ ChapterCount = 4,
}
diff --git a/API/DTOs/Filtering/v2/FilterStatementDto.cs b/API/DTOs/Filtering/v2/FilterStatementDto.cs
index ebe6d16af..8c99bd24c 100644
--- a/API/DTOs/Filtering/v2/FilterStatementDto.cs
+++ b/API/DTOs/Filtering/v2/FilterStatementDto.cs
@@ -1,4 +1,6 @@
-namespace API.DTOs.Filtering.v2;
+using API.DTOs.Metadata.Browse.Requests;
+
+namespace API.DTOs.Filtering.v2;
public sealed record FilterStatementDto
{
@@ -6,3 +8,10 @@ public sealed record FilterStatementDto
public FilterField Field { get; set; }
public string Value { get; set; }
}
+
+public sealed record PersonFilterStatementDto
+{
+ public FilterComparison Comparison { get; set; }
+ public PersonFilterField Field { get; set; }
+ public string Value { get; set; }
+}
diff --git a/API/DTOs/Filtering/v2/FilterV2Dto.cs b/API/DTOs/Filtering/v2/FilterV2Dto.cs
index 11dc42a6b..a247a17a6 100644
--- a/API/DTOs/Filtering/v2/FilterV2Dto.cs
+++ b/API/DTOs/Filtering/v2/FilterV2Dto.cs
@@ -16,7 +16,7 @@ public sealed record FilterV2Dto
/// The name of the filter
///
public string? Name { get; set; }
- public ICollection Statements { get; set; } = new List();
+ public ICollection Statements { get; set; } = [];
public FilterCombination Combination { get; set; } = FilterCombination.And;
public SortOptions? SortOptions { get; set; }
diff --git a/API/DTOs/KavitaPlus/ExternalMetadata/ExternalMetadataIdsDto.cs b/API/DTOs/KavitaPlus/ExternalMetadata/ExternalMetadataIdsDto.cs
index 2b7dea8e6..c05ff0567 100644
--- a/API/DTOs/KavitaPlus/ExternalMetadata/ExternalMetadataIdsDto.cs
+++ b/API/DTOs/KavitaPlus/ExternalMetadata/ExternalMetadataIdsDto.cs
@@ -6,7 +6,7 @@ namespace API.DTOs.KavitaPlus.ExternalMetadata;
///
/// Used for matching and fetching metadata on a series
///
-internal sealed record ExternalMetadataIdsDto
+public sealed record ExternalMetadataIdsDto
{
public long? MalId { get; set; }
public int? AniListId { get; set; }
diff --git a/API/DTOs/KavitaPlus/ExternalMetadata/MatchSeriesRequestDto.cs b/API/DTOs/KavitaPlus/ExternalMetadata/MatchSeriesRequestDto.cs
index fae674ded..a7359d69b 100644
--- a/API/DTOs/KavitaPlus/ExternalMetadata/MatchSeriesRequestDto.cs
+++ b/API/DTOs/KavitaPlus/ExternalMetadata/MatchSeriesRequestDto.cs
@@ -7,7 +7,7 @@ namespace API.DTOs.KavitaPlus.ExternalMetadata;
///
/// Represents a request to match some series from Kavita to an external id which K+ uses.
///
-internal sealed record MatchSeriesRequestDto
+public sealed record MatchSeriesRequestDto
{
public required string SeriesName { get; set; }
public ICollection AlternativeNames { get; set; } = [];
diff --git a/API/DTOs/KavitaPlus/ExternalMetadata/SeriesDetailPlusApiDto.cs b/API/DTOs/KavitaPlus/ExternalMetadata/SeriesDetailPlusApiDto.cs
index d0cbb7bd3..84e9bbf3e 100644
--- a/API/DTOs/KavitaPlus/ExternalMetadata/SeriesDetailPlusApiDto.cs
+++ b/API/DTOs/KavitaPlus/ExternalMetadata/SeriesDetailPlusApiDto.cs
@@ -6,7 +6,7 @@ using API.DTOs.SeriesDetail;
namespace API.DTOs.KavitaPlus.ExternalMetadata;
-internal sealed record SeriesDetailPlusApiDto
+public sealed record SeriesDetailPlusApiDto
{
public IEnumerable Recommendations { get; set; }
public IEnumerable Reviews { get; set; }
diff --git a/API/DTOs/KavitaPlus/Manage/ManageMatchFilterDto.cs b/API/DTOs/KavitaPlus/Manage/ManageMatchFilterDto.cs
index 8eb38c98a..c394cf8d4 100644
--- a/API/DTOs/KavitaPlus/Manage/ManageMatchFilterDto.cs
+++ b/API/DTOs/KavitaPlus/Manage/ManageMatchFilterDto.cs
@@ -15,5 +15,9 @@ public enum MatchStateOption
public sealed record ManageMatchFilterDto
{
public MatchStateOption MatchStateOption { get; set; } = MatchStateOption.All;
+ ///
+ /// Library Type in int form. -1 indicates to ignore the field.
+ ///
+ public int LibraryType { get; set; } = -1;
public string SearchTerm { get; set; } = string.Empty;
}
diff --git a/API/DTOs/KavitaPlus/Metadata/ExternalChapterDto.cs b/API/DTOs/KavitaPlus/Metadata/ExternalChapterDto.cs
index 1dcd8494c..add9ca723 100644
--- a/API/DTOs/KavitaPlus/Metadata/ExternalChapterDto.cs
+++ b/API/DTOs/KavitaPlus/Metadata/ExternalChapterDto.cs
@@ -3,6 +3,7 @@ using System.Collections.Generic;
using API.DTOs.SeriesDetail;
namespace API.DTOs.KavitaPlus.Metadata;
+#nullable enable
///
/// Information about an individual issue/chapter/book from Kavita+
diff --git a/API/DTOs/KavitaPlus/Metadata/ExternalSeriesDetailDto.cs b/API/DTOs/KavitaPlus/Metadata/ExternalSeriesDetailDto.cs
index a3cd378b2..6704bf697 100644
--- a/API/DTOs/KavitaPlus/Metadata/ExternalSeriesDetailDto.cs
+++ b/API/DTOs/KavitaPlus/Metadata/ExternalSeriesDetailDto.cs
@@ -29,7 +29,9 @@ public sealed record ExternalSeriesDetailDto
public DateTime? StartDate { get; set; }
public DateTime? EndDate { get; set; }
public int AverageScore { get; set; }
+ /// AniList returns the total count of unique chapters, includes 1.1 for example
public int Chapters { get; set; }
+ /// AniList returns the total count of unique volumes, includes 1.1 for example
public int Volumes { get; set; }
public IList? Relations { get; set; } = [];
public IList? Characters { get; set; } = [];
diff --git a/API/DTOs/Koreader/KoreaderBookDto.cs b/API/DTOs/Koreader/KoreaderBookDto.cs
new file mode 100644
index 000000000..b66b7da3a
--- /dev/null
+++ b/API/DTOs/Koreader/KoreaderBookDto.cs
@@ -0,0 +1,33 @@
+using API.DTOs.Progress;
+
+namespace API.DTOs.Koreader;
+
+///
+/// This is the interface for receiving and sending updates to Koreader. The only fields
+/// that are actually used are the Document and Progress fields.
+///
+public class KoreaderBookDto
+{
+ ///
+ /// This is the Koreader hash of the book. It is used to identify the book.
+ ///
+ public string Document { get; set; }
+ ///
+ /// A randomly generated id from the koreader device. Only used to maintain the Koreader interface.
+ ///
+ public string Device_id { get; set; }
+ ///
+ /// The Koreader device name. Only used to maintain the Koreader interface.
+ ///
+ public string Device { get; set; }
+ ///
+ /// Percent progress of the book. Only used to maintain the Koreader interface.
+ ///
+ public float Percentage { get; set; }
+ ///
+ /// An XPath string read by Koreader to determine the location within the epub.
+ /// Essentially, it is Koreader's equivalent to ProgressDto.BookScrollId.
+ ///
+ ///
+ public string Progress { get; set; }
+}
diff --git a/API/DTOs/Koreader/KoreaderProgressUpdateDto.cs b/API/DTOs/Koreader/KoreaderProgressUpdateDto.cs
new file mode 100644
index 000000000..52a1d6cbd
--- /dev/null
+++ b/API/DTOs/Koreader/KoreaderProgressUpdateDto.cs
@@ -0,0 +1,15 @@
+using System;
+
+namespace API.DTOs.Koreader;
+
+public class KoreaderProgressUpdateDto
+{
+ ///
+ /// This is the Koreader hash of the book. It is used to identify the book.
+ ///
+ public string Document { get; set; }
+ ///
+ /// UTC Timestamp to return to KOReader
+ ///
+ public DateTime Timestamp { get; set; }
+}
diff --git a/API/DTOs/LibraryDto.cs b/API/DTOs/LibraryDto.cs
index 8ba687346..bd72ad2f0 100644
--- a/API/DTOs/LibraryDto.cs
+++ b/API/DTOs/LibraryDto.cs
@@ -66,4 +66,12 @@ public sealed record LibraryDto
/// This does not exclude the library from being linked to wrt Series Relationships
/// Requires a valid LicenseKey
public bool AllowMetadataMatching { get; set; } = true;
+ ///
+ /// Allow Kavita to read metadata (ComicInfo.xml, Epub, PDF)
+ ///
+ public bool EnableMetadata { get; set; } = true;
+ ///
+ /// Should Kavita remove sort articles "The" for the sort name
+ ///
+ public bool RemovePrefixForSortName { get; set; } = false;
}
diff --git a/API/DTOs/Metadata/Browse/BrowseGenreDto.cs b/API/DTOs/Metadata/Browse/BrowseGenreDto.cs
new file mode 100644
index 000000000..8044c7914
--- /dev/null
+++ b/API/DTOs/Metadata/Browse/BrowseGenreDto.cs
@@ -0,0 +1,13 @@
+namespace API.DTOs.Metadata.Browse;
+
+public sealed record BrowseGenreDto : GenreTagDto
+{
+ ///
+ /// Number of Series this Entity is on
+ ///
+ public int SeriesCount { get; set; }
+ ///
+ /// Number of Chapters this Entity is on
+ ///
+ public int ChapterCount { get; set; }
+}
diff --git a/API/DTOs/Person/BrowsePersonDto.cs b/API/DTOs/Metadata/Browse/BrowsePersonDto.cs
similarity index 71%
rename from API/DTOs/Person/BrowsePersonDto.cs
rename to API/DTOs/Metadata/Browse/BrowsePersonDto.cs
index c7d318e79..20f84b783 100644
--- a/API/DTOs/Person/BrowsePersonDto.cs
+++ b/API/DTOs/Metadata/Browse/BrowsePersonDto.cs
@@ -1,6 +1,6 @@
using API.DTOs.Person;
-namespace API.DTOs;
+namespace API.DTOs.Metadata.Browse;
///
/// Used to browse writers and click in to see their series
@@ -12,7 +12,7 @@ public class BrowsePersonDto : PersonDto
///
public int SeriesCount { get; set; }
///
- /// Number or Issues this Person is the Writer for
+ /// Number of Issues this Person is the Writer for
///
- public int IssueCount { get; set; }
+ public int ChapterCount { get; set; }
}
diff --git a/API/DTOs/Metadata/Browse/BrowseTagDto.cs b/API/DTOs/Metadata/Browse/BrowseTagDto.cs
new file mode 100644
index 000000000..9a71876e3
--- /dev/null
+++ b/API/DTOs/Metadata/Browse/BrowseTagDto.cs
@@ -0,0 +1,13 @@
+namespace API.DTOs.Metadata.Browse;
+
+public sealed record BrowseTagDto : TagDto
+{
+ ///
+ /// Number of Series this Entity is on
+ ///
+ public int SeriesCount { get; set; }
+ ///
+ /// Number of Chapters this Entity is on
+ ///
+ public int ChapterCount { get; set; }
+}
diff --git a/API/DTOs/Metadata/Browse/Requests/BrowsePersonFilterDto.cs b/API/DTOs/Metadata/Browse/Requests/BrowsePersonFilterDto.cs
new file mode 100644
index 000000000..d41cf37f3
--- /dev/null
+++ b/API/DTOs/Metadata/Browse/Requests/BrowsePersonFilterDto.cs
@@ -0,0 +1,27 @@
+using System.Collections.Generic;
+using API.DTOs.Filtering;
+using API.DTOs.Filtering.v2;
+using API.Entities.Enums;
+
+namespace API.DTOs.Metadata.Browse.Requests;
+#nullable enable
+
+public sealed record BrowsePersonFilterDto
+{
+ ///
+ /// Not used - For parity with Series Filter
+ ///
+ public int Id { get; set; }
+ ///
+ /// Not used - For parity with Series Filter
+ ///
+ public string? Name { get; set; }
+ public ICollection Statements { get; set; } = [];
+ public FilterCombination Combination { get; set; } = FilterCombination.And;
+ public PersonSortOptions? SortOptions { get; set; }
+
+ ///
+ /// Limit the number of rows returned. Defaults to not applying a limit (aka 0)
+ ///
+ public int LimitTo { get; set; } = 0;
+}
diff --git a/API/DTOs/Metadata/GenreTagDto.cs b/API/DTOs/Metadata/GenreTagDto.cs
index 4846048d2..13a339d38 100644
--- a/API/DTOs/Metadata/GenreTagDto.cs
+++ b/API/DTOs/Metadata/GenreTagDto.cs
@@ -1,6 +1,6 @@
namespace API.DTOs.Metadata;
-public sealed record GenreTagDto
+public record GenreTagDto
{
public int Id { get; set; }
public required string Title { get; set; }
diff --git a/API/DTOs/Metadata/TagDto.cs b/API/DTOs/Metadata/TagDto.cs
index f8deb6913..f5c925e1f 100644
--- a/API/DTOs/Metadata/TagDto.cs
+++ b/API/DTOs/Metadata/TagDto.cs
@@ -1,6 +1,6 @@
namespace API.DTOs.Metadata;
-public sealed record TagDto
+public record TagDto
{
public int Id { get; set; }
public required string Title { get; set; }
diff --git a/API/DTOs/ReadingLists/ReadingListDto.cs b/API/DTOs/ReadingLists/ReadingListDto.cs
index cbc16275d..47a526411 100644
--- a/API/DTOs/ReadingLists/ReadingListDto.cs
+++ b/API/DTOs/ReadingLists/ReadingListDto.cs
@@ -49,6 +49,11 @@ public sealed record ReadingListDto : IHasCoverImage
///
public required AgeRating AgeRating { get; set; } = AgeRating.Unknown;
+ ///
+ /// Username of the User that owns (in the case of a promoted list)
+ ///
+ public string OwnerUserName { get; set; }
+
public void ResetColorScape()
{
PrimaryColor = string.Empty;
diff --git a/API/DTOs/Scrobbling/ScrobbleEventDto.cs b/API/DTOs/Scrobbling/ScrobbleEventDto.cs
index 7b1ccd75a..562d923ff 100644
--- a/API/DTOs/Scrobbling/ScrobbleEventDto.cs
+++ b/API/DTOs/Scrobbling/ScrobbleEventDto.cs
@@ -5,6 +5,7 @@ namespace API.DTOs.Scrobbling;
public sealed record ScrobbleEventDto
{
+ public long Id { get; init; }
public string SeriesName { get; set; }
public int SeriesId { get; set; }
public int LibraryId { get; set; }
diff --git a/API/DTOs/Scrobbling/ScrobbleResponseDto.cs b/API/DTOs/Scrobbling/ScrobbleResponseDto.cs
index 53d3a0cc9..ad66729d0 100644
--- a/API/DTOs/Scrobbling/ScrobbleResponseDto.cs
+++ b/API/DTOs/Scrobbling/ScrobbleResponseDto.cs
@@ -8,5 +8,6 @@ public sealed record ScrobbleResponseDto
{
public bool Successful { get; set; }
public string? ErrorMessage { get; set; }
+ public string? ExtraInformation {get; set;}
public int RateLeft { get; set; }
}
diff --git a/API/DTOs/UpdateLibraryDto.cs b/API/DTOs/UpdateLibraryDto.cs
index 9bd47fd39..d7f314208 100644
--- a/API/DTOs/UpdateLibraryDto.cs
+++ b/API/DTOs/UpdateLibraryDto.cs
@@ -28,6 +28,10 @@ public sealed record UpdateLibraryDto
public bool AllowScrobbling { get; init; }
[Required]
public bool AllowMetadataMatching { get; init; }
+ [Required]
+ public bool EnableMetadata { get; init; }
+ [Required]
+ public bool RemovePrefixForSortName { get; init; }
///
/// What types of files to allow the scanner to pickup
///
diff --git a/API/DTOs/UserReadingProfileDto.cs b/API/DTOs/UserReadingProfileDto.cs
index 23f67ce4d..24dbf1c34 100644
--- a/API/DTOs/UserReadingProfileDto.cs
+++ b/API/DTOs/UserReadingProfileDto.cs
@@ -64,6 +64,9 @@ public sealed record UserReadingProfileDto
///
public int? WidthOverride { get; set; }
+ ///
+ public BreakPoint DisableWidthOverride { get; set; } = BreakPoint.Never;
+
#endregion
#region EpubReader
diff --git a/API/Data/DataContext.cs b/API/Data/DataContext.cs
index 3bbf45e23..7d529b1da 100644
--- a/API/Data/DataContext.cs
+++ b/API/Data/DataContext.cs
@@ -4,7 +4,6 @@ using System.Linq;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
-using API.DTOs.KavitaPlus.Metadata;
using API.Entities;
using API.Entities.Enums;
using API.Entities.Enums.UserPreferences;
@@ -18,7 +17,6 @@ using Microsoft.AspNetCore.Identity;
using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore;
using Microsoft.EntityFrameworkCore.ChangeTracking;
-using Microsoft.EntityFrameworkCore.Diagnostics;
namespace API.Data;
@@ -43,7 +41,7 @@ public sealed class DataContext : IdentityDbContext ServerSetting { get; set; } = null!;
public DbSet AppUserPreferences { get; set; } = null!;
public DbSet SeriesMetadata { get; set; } = null!;
- [Obsolete]
+ [Obsolete("Use AppUserCollection")]
public DbSet CollectionTag { get; set; } = null!;
public DbSet AppUserBookmark { get; set; } = null!;
public DbSet ReadingList { get; set; } = null!;
@@ -72,7 +70,7 @@ public sealed class DataContext : IdentityDbContext ExternalSeriesMetadata { get; set; } = null!;
public DbSet ExternalRecommendation { get; set; } = null!;
public DbSet ManualMigrationHistory { get; set; } = null!;
- [Obsolete]
+ [Obsolete("Use IsBlacklisted field on Series")]
public DbSet SeriesBlacklist { get; set; } = null!;
public DbSet AppUserCollection { get; set; } = null!;
public DbSet ChapterPeople { get; set; } = null!;
@@ -147,6 +145,9 @@ public sealed class DataContext : IdentityDbContext()
.Property(b => b.AllowMetadataMatching)
.HasDefaultValue(true);
+ builder.Entity()
+ .Property(b => b.EnableMetadata)
+ .HasDefaultValue(true);
builder.Entity()
.Property(b => b.WebLinks)
@@ -283,6 +284,22 @@ public sealed class DataContext : IdentityDbContext JsonSerializer.Serialize(v, JsonSerializerOptions.Default),
v => JsonSerializer.Deserialize>(v, JsonSerializerOptions.Default) ?? new List())
.HasColumnType("TEXT");
+
+ builder.Entity()
+ .Property(sm => sm.KPlusOverrides)
+ .HasConversion(
+ v => JsonSerializer.Serialize(v, JsonSerializerOptions.Default),
+ v => JsonSerializer.Deserialize>(v, JsonSerializerOptions.Default) ??
+ new List())
+ .HasColumnType("TEXT")
+ .HasDefaultValue(new List());
+ builder.Entity()
+ .Property(sm => sm.KPlusOverrides)
+ .HasConversion(
+ v => JsonSerializer.Serialize(v, JsonSerializerOptions.Default),
+ v => JsonSerializer.Deserialize>(v, JsonSerializerOptions.Default) ?? new List())
+ .HasColumnType("TEXT")
+ .HasDefaultValue(new List());
}
#nullable enable
diff --git a/API/Data/Migrations/20250519151126_KoreaderHash.Designer.cs b/API/Data/Migrations/20250519151126_KoreaderHash.Designer.cs
new file mode 100644
index 000000000..79f6f9504
--- /dev/null
+++ b/API/Data/Migrations/20250519151126_KoreaderHash.Designer.cs
@@ -0,0 +1,3574 @@
+//
+using System;
+using API.Data;
+using Microsoft.EntityFrameworkCore;
+using Microsoft.EntityFrameworkCore.Infrastructure;
+using Microsoft.EntityFrameworkCore.Migrations;
+using Microsoft.EntityFrameworkCore.Storage.ValueConversion;
+
+#nullable disable
+
+namespace API.Data.Migrations
+{
+ [DbContext(typeof(DataContext))]
+ [Migration("20250519151126_KoreaderHash")]
+ partial class KoreaderHash
+ {
+ ///
+ protected override void BuildTargetModel(ModelBuilder modelBuilder)
+ {
+#pragma warning disable 612, 618
+ modelBuilder.HasAnnotation("ProductVersion", "9.0.4");
+
+ modelBuilder.Entity("API.Entities.AppRole", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("ConcurrencyStamp")
+ .IsConcurrencyToken()
+ .HasColumnType("TEXT");
+
+ b.Property("Name")
+ .HasMaxLength(256)
+ .HasColumnType("TEXT");
+
+ b.Property("NormalizedName")
+ .HasMaxLength(256)
+ .HasColumnType("TEXT");
+
+ b.HasKey("Id");
+
+ b.HasIndex("NormalizedName")
+ .IsUnique()
+ .HasDatabaseName("RoleNameIndex");
+
+ b.ToTable("AspNetRoles", (string)null);
+ });
+
+ modelBuilder.Entity("API.Entities.AppUser", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AccessFailedCount")
+ .HasColumnType("INTEGER");
+
+ b.Property("AgeRestriction")
+ .HasColumnType("INTEGER");
+
+ b.Property("AgeRestrictionIncludeUnknowns")
+ .HasColumnType("INTEGER");
+
+ b.Property("AniListAccessToken")
+ .HasColumnType("TEXT");
+
+ b.Property("ApiKey")
+ .HasColumnType("TEXT");
+
+ b.Property("ConcurrencyStamp")
+ .IsConcurrencyToken()
+ .HasColumnType("TEXT");
+
+ b.Property("ConfirmationToken")
+ .HasColumnType("TEXT");
+
+ b.Property("Created")
+ .HasColumnType("TEXT");
+
+ b.Property("CreatedUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("Email")
+ .HasMaxLength(256)
+ .HasColumnType("TEXT");
+
+ b.Property("EmailConfirmed")
+ .HasColumnType("INTEGER");
+
+ b.Property("HasRunScrobbleEventGeneration")
+ .HasColumnType("INTEGER");
+
+ b.Property("LastActive")
+ .HasColumnType("TEXT");
+
+ b.Property("LastActiveUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("LockoutEnabled")
+ .HasColumnType("INTEGER");
+
+ b.Property("LockoutEnd")
+ .HasColumnType("TEXT");
+
+ b.Property("MalAccessToken")
+ .HasColumnType("TEXT");
+
+ b.Property("MalUserName")
+ .HasColumnType("TEXT");
+
+ b.Property("NormalizedEmail")
+ .HasMaxLength(256)
+ .HasColumnType("TEXT");
+
+ b.Property("NormalizedUserName")
+ .HasMaxLength(256)
+ .HasColumnType("TEXT");
+
+ b.Property("PasswordHash")
+ .HasColumnType("TEXT");
+
+ b.Property("PhoneNumber")
+ .HasColumnType("TEXT");
+
+ b.Property("PhoneNumberConfirmed")
+ .HasColumnType("INTEGER");
+
+ b.Property("RowVersion")
+ .IsConcurrencyToken()
+ .HasColumnType("INTEGER");
+
+ b.Property("ScrobbleEventGenerationRan")
+ .HasColumnType("TEXT");
+
+ b.Property("SecurityStamp")
+ .HasColumnType("TEXT");
+
+ b.Property("TwoFactorEnabled")
+ .HasColumnType("INTEGER");
+
+ b.Property("UserName")
+ .HasMaxLength(256)
+ .HasColumnType("TEXT");
+
+ b.HasKey("Id");
+
+ b.HasIndex("NormalizedEmail")
+ .HasDatabaseName("EmailIndex");
+
+ b.HasIndex("NormalizedUserName")
+ .IsUnique()
+ .HasDatabaseName("UserNameIndex");
+
+ b.ToTable("AspNetUsers", (string)null);
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserBookmark", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("ChapterId")
+ .HasColumnType("INTEGER");
+
+ b.Property("Created")
+ .HasColumnType("TEXT");
+
+ b.Property("CreatedUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("FileName")
+ .HasColumnType("TEXT");
+
+ b.Property("LastModified")
+ .HasColumnType("TEXT");
+
+ b.Property("LastModifiedUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("Page")
+ .HasColumnType("INTEGER");
+
+ b.Property("SeriesId")
+ .HasColumnType("INTEGER");
+
+ b.Property("VolumeId")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.ToTable("AppUserBookmark");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserChapterRating", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("ChapterId")
+ .HasColumnType("INTEGER");
+
+ b.Property("HasBeenRated")
+ .HasColumnType("INTEGER");
+
+ b.Property("Rating")
+ .HasColumnType("REAL");
+
+ b.Property("Review")
+ .HasColumnType("TEXT");
+
+ b.Property("SeriesId")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.HasIndex("ChapterId");
+
+ b.HasIndex("SeriesId");
+
+ b.ToTable("AppUserChapterRating");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserCollection", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AgeRating")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER")
+ .HasDefaultValue(0);
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("CoverImage")
+ .HasColumnType("TEXT");
+
+ b.Property("CoverImageLocked")
+ .HasColumnType("INTEGER");
+
+ b.Property("Created")
+ .HasColumnType("TEXT");
+
+ b.Property("CreatedUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("LastModified")
+ .HasColumnType("TEXT");
+
+ b.Property("LastModifiedUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("LastSyncUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("MissingSeriesFromSource")
+ .HasColumnType("TEXT");
+
+ b.Property("NormalizedTitle")
+ .HasColumnType("TEXT");
+
+ b.Property("PrimaryColor")
+ .HasColumnType("TEXT");
+
+ b.Property("Promoted")
+ .HasColumnType("INTEGER");
+
+ b.Property("SecondaryColor")
+ .HasColumnType("TEXT");
+
+ b.Property("Source")
+ .HasColumnType("INTEGER");
+
+ b.Property("SourceUrl")
+ .HasColumnType("TEXT");
+
+ b.Property("Summary")
+ .HasColumnType("TEXT");
+
+ b.Property("Title")
+ .HasColumnType("TEXT");
+
+ b.Property("TotalSourceCount")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.ToTable("AppUserCollection");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserDashboardStream", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("IsProvided")
+ .HasColumnType("INTEGER");
+
+ b.Property("Name")
+ .HasColumnType("TEXT");
+
+ b.Property("Order")
+ .HasColumnType("INTEGER");
+
+ b.Property("SmartFilterId")
+ .HasColumnType("INTEGER");
+
+ b.Property("StreamType")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER")
+ .HasDefaultValue(4);
+
+ b.Property("Visible")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.HasIndex("SmartFilterId");
+
+ b.HasIndex("Visible");
+
+ b.ToTable("AppUserDashboardStream");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserExternalSource", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("ApiKey")
+ .HasColumnType("TEXT");
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("Host")
+ .HasColumnType("TEXT");
+
+ b.Property("Name")
+ .HasColumnType("TEXT");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.ToTable("AppUserExternalSource");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserOnDeckRemoval", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("SeriesId")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.HasIndex("SeriesId");
+
+ b.ToTable("AppUserOnDeckRemoval");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserPreferences", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AllowAutomaticWebtoonReaderDetection")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER")
+ .HasDefaultValue(true);
+
+ b.Property("AniListScrobblingEnabled")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER")
+ .HasDefaultValue(true);
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("AutoCloseMenu")
+ .HasColumnType("INTEGER");
+
+ b.Property("BackgroundColor")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("TEXT")
+ .HasDefaultValue("#000000");
+
+ b.Property("BlurUnreadSummaries")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderFontFamily")
+ .HasColumnType("TEXT");
+
+ b.Property("BookReaderFontSize")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderImmersiveMode")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderLayoutMode")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderLineSpacing")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderMargin")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderReadingDirection")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderTapToPaginate")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookReaderWritingStyle")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER")
+ .HasDefaultValue(0);
+
+ b.Property("BookThemeName")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("TEXT")
+ .HasDefaultValue("Dark");
+
+ b.Property("CollapseSeriesRelationships")
+ .HasColumnType("INTEGER");
+
+ b.Property("EmulateBook")
+ .HasColumnType("INTEGER");
+
+ b.Property("GlobalPageLayoutMode")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER")
+ .HasDefaultValue(0);
+
+ b.Property("LayoutMode")
+ .HasColumnType("INTEGER");
+
+ b.Property("Locale")
+ .IsRequired()
+ .ValueGeneratedOnAdd()
+ .HasColumnType("TEXT")
+ .HasDefaultValue("en");
+
+ b.Property("NoTransitions")
+ .HasColumnType("INTEGER");
+
+ b.Property("PageSplitOption")
+ .HasColumnType("INTEGER");
+
+ b.Property("PdfScrollMode")
+ .HasColumnType("INTEGER");
+
+ b.Property("PdfSpreadMode")
+ .HasColumnType("INTEGER");
+
+ b.Property("PdfTheme")
+ .HasColumnType("INTEGER");
+
+ b.Property("PromptForDownloadSize")
+ .HasColumnType("INTEGER");
+
+ b.Property("ReaderMode")
+ .HasColumnType("INTEGER");
+
+ b.Property("ReadingDirection")
+ .HasColumnType("INTEGER");
+
+ b.Property("ScalingOption")
+ .HasColumnType("INTEGER");
+
+ b.Property("ShareReviews")
+ .HasColumnType("INTEGER");
+
+ b.Property("ShowScreenHints")
+ .HasColumnType("INTEGER");
+
+ b.Property("SwipeToPaginate")
+ .HasColumnType("INTEGER");
+
+ b.Property("ThemeId")
+ .HasColumnType("INTEGER");
+
+ b.Property("WantToReadSync")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER")
+ .HasDefaultValue(true);
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId")
+ .IsUnique();
+
+ b.HasIndex("ThemeId");
+
+ b.ToTable("AppUserPreferences");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserProgress", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("BookScrollId")
+ .HasColumnType("TEXT");
+
+ b.Property("ChapterId")
+ .HasColumnType("INTEGER");
+
+ b.Property("Created")
+ .HasColumnType("TEXT");
+
+ b.Property("CreatedUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("LastModified")
+ .HasColumnType("TEXT");
+
+ b.Property("LastModifiedUtc")
+ .HasColumnType("TEXT");
+
+ b.Property("LibraryId")
+ .HasColumnType("INTEGER");
+
+ b.Property("PagesRead")
+ .HasColumnType("INTEGER");
+
+ b.Property("SeriesId")
+ .HasColumnType("INTEGER");
+
+ b.Property("VolumeId")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.HasIndex("ChapterId");
+
+ b.HasIndex("SeriesId");
+
+ b.ToTable("AppUserProgresses");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserRating", b =>
+ {
+ b.Property("Id")
+ .ValueGeneratedOnAdd()
+ .HasColumnType("INTEGER");
+
+ b.Property("AppUserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("HasBeenRated")
+ .HasColumnType("INTEGER");
+
+ b.Property("Rating")
+ .HasColumnType("REAL");
+
+ b.Property("Review")
+ .HasColumnType("TEXT");
+
+ b.Property("SeriesId")
+ .HasColumnType("INTEGER");
+
+ b.Property("Tagline")
+ .HasColumnType("TEXT");
+
+ b.HasKey("Id");
+
+ b.HasIndex("AppUserId");
+
+ b.HasIndex("SeriesId");
+
+ b.ToTable("AppUserRating");
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserRole", b =>
+ {
+ b.Property("UserId")
+ .HasColumnType("INTEGER");
+
+ b.Property("RoleId")
+ .HasColumnType("INTEGER");
+
+ b.HasKey("UserId", "RoleId");
+
+ b.HasIndex("RoleId");
+
+ b.ToTable("AspNetUserRoles", (string)null);
+ });
+
+ modelBuilder.Entity("API.Entities.AppUserSideNavStream", b =>
+ {
+ b.Property