v0.4.2 Release

.gitattributes

@@ -0,0 +1,3 @@
+# Set line formatting for scripts
+
+*.sh text eol=lf

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: kavita # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: ["https://paypal.me/majora2007"]

.github/workflows/discord-release-msg.yml

@@ -0,0 +1,17 @@
+name: Release messages to discord announcement channel
+
+on: 
+  release:
+    types:
+      - created
+
+jobs:
+  run_main:
+    runs-on: ubuntu-18.04
+    name: Sends custom message
+    steps:
+      - name: Sending message
+        uses: nhevia/discord-styled-releases@main
+        with:
+          webhook_id: ${{ secrets.DISCORD_WEBHOOK_ID }}
+          webhook_token: ${{ secrets.DISCORD_WEBHOOK_TOKEN }}

.github/workflows/nightly-docker.yml

@@ -0,0 +1,79 @@
+name: Build Nightly Docker
+
+on:
+  push:
+    branches:
+      - 'develop'
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check Out Repo
+        uses: actions/checkout@v2
+
+      - name: Check Out WebUI
+        uses: actions/checkout@v2
+        with:
+          repository: Kareadita/Kavita-webui
+          ref: develop
+          path: Kavita-webui/
+
+      - name: NodeJS to Compile WebUI
+        uses: actions/[email protected]
+        with:
+          node-version: '14'
+      - run: |
+
+          cd Kavita-webui/ || exit
+          echo 'Installing web dependencies'
+          npm install
+
+          echo 'Building UI'
+          npm run prod
+
+          echo 'Copying back to Kavita wwwroot'
+          rsync -a dist/ ../API/wwwroot/
+
+          cd ../ || exit
+
+      - name: Compile dotnet app
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '5.0.x'
+      - run: ./action-build.sh
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          push: true
+          tags: kizaing/kavita:nightly
+
+      - name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}
+
+      - name: Notify Discord
+        uses: rjstone/discord-webhook-notify@v1
+        with:
+            severity: info
+            description: 
+            details: 'https://hub.docker.com/r/kizaing/kavita/tags?page=1&ordering=last_updated'
+            text: A new nightly build has been released for docker.
+            webhookUrl: ${{ secrets.DISCORD_DOCKER_UPDATE_URL }}

.github/workflows/stable-docker.yml

@@ -0,0 +1,79 @@
+name: Build Stable Docker
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check Out Repo
+        uses: actions/checkout@v2
+
+      - name: Check Out WebUI
+        uses: actions/checkout@v2
+        with:
+          repository: Kareadita/Kavita-webui
+          ref: main
+          path: Kavita-webui/
+
+      - name: NodeJS to Compile WebUI
+        uses: actions/[email protected]
+        with:
+          node-version: '14'
+      - run: |
+
+          cd Kavita-webui/ || exit
+          echo 'Installing web dependencies'
+          npm install
+
+          echo 'Building UI'
+          npm run prod
+
+          echo 'Copying back to Kavita wwwroot'
+          rsync -a dist/ ../API/wwwroot/
+
+          cd ../ || exit
+
+      - name: Compile dotnet app
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '5.0.x'
+      - run: ./action-build.sh
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v1
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm/v7,linux/arm64
+          push: true
+          tags: kizaing/kavita:latest
+
+      - name: Image digest
+        run: echo ${{ steps.docker_build.outputs.digest }}
+
+      - name: Notify Discord
+        uses: rjstone/discord-webhook-notify@v1
+        with:
+            severity: info
+            description: 
+            details: 'https://hub.docker.com/r/kizaing/kavita/tags?page=1&ordering=last_updated'
+            text: A new stable build has been released for docker.
+            webhookUrl: ${{ secrets.DISCORD_DOCKER_UPDATE_URL }}

.gitignore

@@ -453,4 +453,5 @@ cache/
 /API/cache/
 /API/temp/
 _temp/
-_output/
+_output/
+stats/

API.Tests/Comparers/NaturalSortComparerTest.cs

@@ -38,6 +38,14 @@ public class NaturalSortComparerTest
             new[] {"Batman - Black white vol 1 #04.cbr", "Batman - Black white vol 1 #03.cbr", "Batman - Black white vol 1 #01.cbr", "Batman - Black white vol 1 #02.cbr"}, 
             new[] {"Batman - Black white vol 1 #01.cbr", "Batman - Black white vol 1 #02.cbr", "Batman - Black white vol 1 #03.cbr", "Batman - Black white vol 1 #04.cbr"}
         )]
+        [InlineData(
+            new[] {"3and4.cbz", "The World God Only Knows - Oneshot.cbz", "5.cbz", "1and2.cbz"}, 
+            new[] {"1and2.cbz", "3and4.cbz", "5.cbz", "The World God Only Knows - Oneshot.cbz"}
+        )]
+        [InlineData(
+            new[] {"Solo Leveling - c000 (v01) - p000 [Cover] [dig] [Yen Press] [LuCaZ].jpg", "Solo Leveling - c000 (v01) - p001 [dig] [Yen Press] [LuCaZ].jpg", "Solo Leveling - c000 (v01) - p002 [dig] [Yen Press] [LuCaZ].jpg", "Solo Leveling - c000 (v01) - p003 [dig] [Yen Press] [LuCaZ].jpg"}, 
+            new[] {"Solo Leveling - c000 (v01) - p000 [Cover] [dig] [Yen Press] [LuCaZ].jpg", "Solo Leveling - c000 (v01) - p001 [dig] [Yen Press] [LuCaZ].jpg", "Solo Leveling - c000 (v01) - p002 [dig] [Yen Press] [LuCaZ].jpg", "Solo Leveling - c000 (v01) - p003 [dig] [Yen Press] [LuCaZ].jpg"}
+        )]
         public void TestNaturalSortComparer(string[] input, string[] expected)
         {
             Array.Sort(input, _nc);

API.Tests/Extensions/SeriesExtensionsTests.cs

@@ -22,7 +22,8 @@ public void NameInListTest(string[] seriesInput, string[] list, bool expected)
                 Name = seriesInput[0],
                 LocalizedName = seriesInput[1],
                 OriginalName = seriesInput[2],
-                NormalizedName = seriesInput.Length == 4 ? seriesInput[3] : API.Parser.Parser.Normalize(seriesInput[0])
+                NormalizedName = seriesInput.Length == 4 ? seriesInput[3] : API.Parser.Parser.Normalize(seriesInput[0]),
+                Metadata = new SeriesMetadata()
             };
 
             Assert.Equal(expected, series.NameInList(list));

API.Tests/Helpers/EntityFactory.cs

@@ -17,7 +17,8 @@ public static Series CreateSeries(string name)
                 SortName = name,
                 LocalizedName = name,
                 NormalizedName = API.Parser.Parser.Normalize(name),
-                Volumes = new List<Volume>()
+                Volumes = new List<Volume>(),
+                Metadata = new SeriesMetadata()
             };
         }
 
@@ -53,5 +54,25 @@ public static MangaFile CreateMangaFile(string filename, MangaFormat format, int
                 Pages = pages
             };
         }
+
+        public static SeriesMetadata CreateSeriesMetadata(ICollection<CollectionTag> collectionTags)
+        {
+            return new SeriesMetadata()
+            {
+                CollectionTags = collectionTags
+            };
+        }
+
+        public static CollectionTag CreateCollectionTag(int id, string title, string summary, bool promoted)
+        {
+            return new CollectionTag()
+            {
+                Id = id,
+                NormalizedTitle = API.Parser.Parser.Normalize(title).ToUpper(),
+                Title = title,
+                Summary = summary,
+                Promoted = promoted
+            };
+        }
     }
 }

API.Tests/Parser/ComicParserTests.cs

@@ -20,6 +20,8 @@ public class ComicParserTests
         [InlineData("Scott Pilgrim 02 - Scott Pilgrim vs. The World (2005)", "Scott Pilgrim")]
         [InlineData("Wolverine - Origins 003 (2006) (digital) (Minutemen-PhD)", "Wolverine - Origins")]
         [InlineData("Invincible Vol 01 Family matters (2005) (Digital).cbr", "Invincible")]
+        [InlineData("Amazing Man Comics chapter 25", "Amazing Man Comics")]
+        [InlineData("Amazing Man Comics issue #25", "Amazing Man Comics")]
         public void ParseComicSeriesTest(string filename, string expected)
         {
             Assert.Equal(expected, API.Parser.Parser.ParseComicSeries(filename));
@@ -40,6 +42,7 @@ public void ParseComicSeriesTest(string filename, string expected)
         [InlineData("Teen Titans v1 001 (1966-02) (digital) (OkC.O.M.P.U.T.O.-Novus)", "1")]
         [InlineData("Scott Pilgrim 02 - Scott Pilgrim vs. The World (2005)", "2")]
         [InlineData("Superman v1 024 (09-10 1943)", "1")]
+        [InlineData("Amazing Man Comics chapter 25", "0")]
         public void ParseComicVolumeTest(string filename, string expected)
         {
             Assert.Equal(expected, API.Parser.Parser.ParseComicVolume(filename));
@@ -61,6 +64,7 @@ public void ParseComicVolumeTest(string filename, string expected)
         [InlineData("Teen Titans v1 001 (1966-02) (digital) (OkC.O.M.P.U.T.O.-Novus)", "1")]
         [InlineData("Superman v1 024 (09-10 1943)", "24")]
         [InlineData("Invincible 070.5 - Invincible Returns 1 (2010) (digital) (Minutemen-InnerDemons).cbr", "70.5")]
+        [InlineData("Amazing Man Comics chapter 25", "25")]
         public void ParseComicChapterTest(string filename, string expected)
         {
             Assert.Equal(expected, API.Parser.Parser.ParseComicChapter(filename));

API.Tests/Parser/MangaParserTests.cs

@@ -53,15 +53,17 @@ public MangaParserTests(ITestOutputHelper testOutputHelper)
         [InlineData("Kedouin Makoto - Corpse Party Musume, Chapter 12 [Dametrans][v2]", "0")]
         [InlineData("Vagabond_v03", "3")]
         [InlineData("Mujaki No Rakune Volume 10.cbz", "10")]
-        [InlineData("Umineko no Naku Koro ni - Episode 3 - Banquet of the Golden Witch #02.cbz", "3")]
+        [InlineData("Umineko no Naku Koro ni - Episode 3 - Banquet of the Golden Witch #02.cbz", "0")]
         [InlineData("Volume 12 - Janken Boy is Coming!.cbz", "12")]
         [InlineData("[dmntsf.net] One Piece - Digital Colored Comics Vol. 20 Ch. 177 - 30 Million vs 81 Million.cbz", "20")]
         [InlineData("Gantz.V26.cbz", "26")]
         [InlineData("NEEDLESS_Vol.4_-Simeon_6_v2[SugoiSugoi].rar", "4")]
         [InlineData("[Hidoi]_Amaenaideyo_MS_vol01_chp02.rar", "1")]
         [InlineData("NEEDLESS_Vol.4_-_Simeon_6_v2_[SugoiSugoi].rar", "4")]
         [InlineData("Okusama wa Shougakusei c003 (v01) [bokuwaNEET]", "1")]
-
+        [InlineData("Sword Art Online Vol 10 - Alicization Running [Yen Press] [LuCaZ] {r2}.epub", "10")]
+        [InlineData("Noblesse - Episode 406 (52 Pages).7z", "0")]
+        [InlineData("X-Men v1 #201 (September 2007).cbz", "1")]
         public void ParseVolumeTest(string filename, string expected)
         {
             Assert.Equal(expected, API.Parser.Parser.ParseVolume(filename));
@@ -137,6 +139,13 @@ public void ParseVolumeTest(string filename, string expected)
         [InlineData("Okusama wa Shougakusei c003 (v01) [bokuwaNEET]", "Okusama wa Shougakusei")]
         [InlineData("VanDread-v01-c001[MD].zip", "VanDread")]
         [InlineData("Momo The Blood Taker - Chapter 027 Violent Emotion.cbz", "Momo The Blood Taker")]
+        [InlineData("Kiss x Sis - Ch.15 - The Angst of a 15 Year Old Boy.cbz", "Kiss x Sis")]
+        [InlineData("Green Worldz - Chapter 112 Final Chapter (End).cbz", "Green Worldz")]
+        [InlineData("Noblesse - Episode 406 (52 Pages).7z", "Noblesse")]
+        [InlineData("X-Men v1 #201 (September 2007).cbz", "X-Men")]
+        [InlineData("Kodoja #001 (March 2016)", "Kodoja")]
+        [InlineData("Boku No Kokoro No Yabai Yatsu - Chapter 054 I Prayed At The Shrine (V0).cbz", "Boku No Kokoro No Yabai Yatsu")]
+        [InlineData("Kiss x Sis - Ch.36 - A Cold Home Visit.cbz", "Kiss x Sis")]
         public void ParseSeriesTest(string filename, string expected)
         {
             Assert.Equal(expected, API.Parser.Parser.ParseSeries(filename));
@@ -197,6 +206,13 @@ public void ParseSeriesTest(string filename, string expected)
         [InlineData("Kiss x Sis - Ch.00 - Let's Start from 0.cbz", "0")]
         [InlineData("[Hidoi]_Amaenaideyo_MS_vol01_chp02.rar", "2")]
         [InlineData("Okusama wa Shougakusei c003 (v01) [bokuwaNEET]", "3")]
+        [InlineData("Kiss x Sis - Ch.15 - The Angst of a 15 Year Old Boy.cbz", "15")]
+        [InlineData("Tomogui Kyoushitsu - Chapter 006 Game 005 - Fingernails On Right Hand (Part 002).cbz", "6")]
+        [InlineData("Noblesse - Episode 406 (52 Pages).7z", "406")]
+        [InlineData("X-Men v1 #201 (September 2007).cbz", "201")]
+        [InlineData("Kodoja #001 (March 2016)", "1")]
+        [InlineData("Noblesse - Episode 429 (74 Pages).7z", "429")]
+        [InlineData("Boku No Kokoro No Yabai Yatsu - Chapter 054 I Prayed At The Shrine (V0).cbz", "54")]
         public void ParseChaptersTest(string filename, string expected)
         {
             Assert.Equal(expected, API.Parser.Parser.ParseChapter(filename));
@@ -225,6 +241,10 @@ public void ParseEditionTest(string input, string expected)
         [InlineData("Corpse Party -The Anthology- Sachikos game of love Hysteric Birthday 2U Extra Chapter", true)]
         [InlineData("Ani-Hina Art Collection.cbz", true)]
         [InlineData("Gifting The Wonderful World With Blessings! - 3 Side Stories [yuNS][Unknown]", true)]
+        [InlineData("A Town Where You Live - Bonus Chapter.zip", true)]
+        [InlineData("Yuki Merry - 4-Komga Anthology", false)]
+        [InlineData("Beastars - SP01", false)]
+        [InlineData("Beastars SP01", false)]
         public void ParseMangaSpecialTest(string input, bool expected)
         {
             Assert.Equal(expected,  !string.IsNullOrEmpty(API.Parser.Parser.ParseMangaSpecial(input)));

API.Tests/Parser/ParserTest.cs

@@ -5,6 +5,16 @@ namespace API.Tests.Parser
 {
     public class ParserTests
     {
+
+        [Theory]
+        [InlineData("Beastars - SP01", true)]
+        [InlineData("Beastars SP01", true)]
+        [InlineData("Beastars Special 01", false)]
+        [InlineData("Beastars Extra 01", false)]
+        public void HasSpecialTest(string input, bool expected)
+        {
+            Assert.Equal(expected,  HasSpecialMarker(input));
+        }
 
         [Theory]
         [InlineData("0001", "1")]
@@ -121,6 +131,8 @@ public void IsEpubTest(string input, bool expected)
         [InlineData("18-04", 4)]
         [InlineData("18-04.5", 4.5)]
         [InlineData("40", 40)]
+        [InlineData("40a-040b", 0)]
+        [InlineData("40.1_a", 0)]
         public void MinimumNumberFromRangeTest(string input, float expected)
         {
             Assert.Equal(expected, MinimumNumberFromRange(input));