All Around Polish (#1328)

* Added --card-list-item-bg-color for the card list items

* Updated the card list item progress to match how cards render

* Implemented the ability to configure how many backups are retained.

* Fixed a bug where odd jump keys could cause a bad index error for jump bar

* Commented out more code for the pagination route if we go with that.

* Reverted a move of DisableConcurrentExecution to interface, as it seems to not work there.

* Updated manga format utility code to pipes

* Fixed bulk selection on series detail page

* Fixed bulk selection on all other pages

* Changed card item to OnPush

* Updated image component to OnPush

* Updated Series Card to OnPush

* Updated Series Detail to OnPush

* Lots of changes here. Integrated parentscroll support on card detail layout. Added jump bar (custom js implementation) on collection, reading list and all series pages. Updated UserParams to default to no pagination. Lots of cleanup all around

* Updated some notes on a module use

* Some code cleanup

* Fixed up a broken test due to the mapper not being configured in the test.

* Applied TabID pattern to edit collection tags

* Applied css from series detail to collection detail page to remove double scrollbar

* Implemented the ability to sort by Time To Read.

* Throw an error to the UI when we extract an archive and it contains invalid characters in the filename for the Server OS.

* Tweaked how the page scrolls for jumpbar on collection detail. We will have to polish another release

* Cleaned up the styling on directory picker

* Put some code in but it doesn't work for scroll to top on virtual scrolling. I'll do it later.

* Fixed a container bug

API/Controllers/ReadingListController.cs

@@ -72,8 +72,9 @@ namespace API.Controllers
         {
             var userId = await _unitOfWork.UserRepository.GetUserIdByUsernameAsync(User.GetUsername());
             var items = await _unitOfWork.ReadingListRepository.GetReadingListItemDtosByIdAsync(readingListId, userId);
+            return Ok(items);
 
-            return Ok(await _unitOfWork.ReadingListRepository.AddReadingProgressModifiers(userId, items.ToList()));
+            //return Ok(await _unitOfWork.ReadingListRepository.AddReadingProgressModifiers(userId, items.ToList()));
         }
 
         /// <summary>
@@ -463,7 +464,7 @@ namespace API.Controllers
 
             var existingChapterExists = readingList.Items.Select(rli => rli.ChapterId).ToHashSet();
             var chaptersForSeries = (await _unitOfWork.ChapterRepository.GetChaptersByIdsAsync(chapterIds))
-                .OrderBy(c => float.Parse(c.Volume.Name))
+                .OrderBy(c => Parser.Parser.MinNumberFromRange(c.Volume.Name))
                 .ThenBy(x => double.Parse(x.Number), _chapterSortComparerForInChapterSorting);
 
             var index = lastOrder + 1;

API/Controllers/ServerController.cs

@@ -118,7 +118,7 @@ namespace API.Controllers
             try
             {
                 var (fileBytes, zipPath) = await _archiveService.CreateZipForDownload(files, "logs");
-                return File(fileBytes, "application/zip", Path.GetFileName(zipPath));
+                return File(fileBytes, "application/zip", Path.GetFileName(zipPath), true);
             }
             catch (KavitaException ex)
             {

API/Controllers/SettingsController.cs

@@ -54,9 +54,6 @@ namespace API.Controllers
         public async Task<ActionResult<ServerSettingDto>> GetSettings()
         {
             var settingsDto = await _unitOfWork.SettingsRepository.GetSettingsDtoAsync();
-            // TODO: Is this needed as it gets updated in the DB on startup
-            settingsDto.Port = Configuration.Port;
-            settingsDto.LoggingLevel = Configuration.LogLevel;
             return Ok(settingsDto);
         }
 
@@ -212,6 +209,16 @@ namespace API.Controllers
                     _unitOfWork.SettingsRepository.Update(setting);
                 }
 
+                if (setting.Key == ServerSettingKey.TotalBackups && updateSettingsDto.TotalBackups + string.Empty != setting.Value)
+                {
+                    if (updateSettingsDto.TotalBackups > 30 || updateSettingsDto.TotalBackups < 1)
+                    {
+                        return BadRequest("Total Backups must be between 1 and 30");
+                    }
+                    setting.Value = updateSettingsDto.TotalBackups + string.Empty;
+                    _unitOfWork.SettingsRepository.Update(setting);
+                }
+
                 if (setting.Key == ServerSettingKey.EmailServiceUrl && updateSettingsDto.EmailServiceUrl + string.Empty != setting.Value)
                 {
                     setting.Value = string.IsNullOrEmpty(updateSettingsDto.EmailServiceUrl) ? EmailService.DefaultApiUrl : updateSettingsDto.EmailServiceUrl;

API/DTOs/Filtering/SortField.cs

@@ -2,8 +2,24 @@
 
 public enum SortField
 {
+    /// <summary>
+    /// Sort Name of Series
+    /// </summary>
     SortName = 1,
+    /// <summary>
+    /// Date entity was created/imported into Kavita
+    /// </summary>
     CreatedDate = 2,
+    /// <summary>
+    /// Date entity was last modified (tag update, etc)
+    /// </summary>
     LastModifiedDate = 3,
-    LastChapterAdded = 4
+    /// <summary>
+    /// Date series had a chapter added to it
+    /// </summary>
+    LastChapterAdded = 4,
+    /// <summary>
+    /// Time it takes to read. Uses Average.
+    /// </summary>
+    TimeToRead = 5
 }

API/DTOs/ReadingLists/ReadingListDto.cs

@@ -10,5 +10,9 @@
         /// </summary>
         public bool Promoted { get; set; }
         public bool CoverImageLocked { get; set; }
+        /// <summary>
+        /// This is used to tell the UI if it should request a Cover Image or not. If null or empty, it has not been set.
+        /// </summary>
+        public string CoverImage { get; set; } = string.Empty;
     }
 }

API/DTOs/Settings/ServerSettingDTO.cs

@@ -1,4 +1,5 @@
-using API.Services;
+using System.Collections.Generic;
+using API.Services;
 
 namespace API.DTOs.Settings
 {
@@ -44,5 +45,11 @@ namespace API.DTOs.Settings
         /// If the Swagger UI Should be exposed. Does not require authentication, but does require a JWT.
         /// </summary>
         public bool EnableSwaggerUi { get; set; }
+
+        /// <summary>
+        /// The amount of Backups before cleanup
+        /// </summary>
+        /// <remarks>Value should be between 1 and 30</remarks>
+        public int TotalBackups { get; set; } = 30;
     }
 }

API/Data/Repositories/SeriesRepository.cs

@@ -753,6 +753,7 @@ public class SeriesRepository : ISeriesRepository
                 SortField.CreatedDate => query.OrderBy(s => s.Created),
                 SortField.LastModifiedDate => query.OrderBy(s => s.LastModified),
                 SortField.LastChapterAdded => query.OrderBy(s => s.LastChapterAdded),
+                SortField.TimeToRead => query.OrderBy(s => s.AvgHoursToRead),
                 _ => query
             };
         }
@@ -764,6 +765,7 @@ public class SeriesRepository : ISeriesRepository
                 SortField.CreatedDate => query.OrderByDescending(s => s.Created),
                 SortField.LastModifiedDate => query.OrderByDescending(s => s.LastModified),
                 SortField.LastChapterAdded => query.OrderByDescending(s => s.LastChapterAdded),
+                SortField.TimeToRead => query.OrderByDescending(s => s.AvgHoursToRead),
                 _ => query
             };
         }

API/Data/Repositories/SettingsRepository.cs

@@ -5,6 +5,7 @@ using API.DTOs.Settings;
 using API.Entities;
 using API.Entities.Enums;
 using AutoMapper;
+using AutoMapper.QueryableExtensions;
 using Microsoft.EntityFrameworkCore;
 
 namespace API.Data.Repositories;

API/Data/Seed.cs

@@ -102,6 +102,7 @@ namespace API.Data
                 new() {Key = ServerSettingKey.EmailServiceUrl, Value = EmailService.DefaultApiUrl},
                 new() {Key = ServerSettingKey.ConvertBookmarkToWebP, Value = "false"},
                 new() {Key = ServerSettingKey.EnableSwaggerUi, Value = "false"},
+                new() {Key = ServerSettingKey.TotalBackups, Value = "30"},
             }.ToArray());
 
             foreach (var defaultSetting in DefaultSettings)

API/Entities/Enums/ServerSettingKey.cs

@@ -86,5 +86,10 @@ namespace API.Entities.Enums
         /// </summary>
         [Description("EnableSwaggerUi")]
         EnableSwaggerUi = 15,
+        /// <summary>
+        /// Total Number of Backups to maintain before cleaning. Default 30, min 1.
+        /// </summary>
+        [Description("TotalBackups")]
+        TotalBackups = 16,
     }
 }

API/Extensions/ApplicationServiceExtensions.cs

@@ -62,7 +62,7 @@ namespace API.Extensions
         }
 
         private static void AddSqLite(this IServiceCollection services, IConfiguration config,
-            IWebHostEnvironment env)
+            IHostEnvironment env)
         {
             services.AddDbContext<DataContext>(options =>
             {

API/Helpers/AutoMapperProfiles.cs

@@ -138,7 +138,8 @@ namespace API.Helpers
 
             CreateMap<RegisterDto, AppUser>();
 
-
+            CreateMap<IList<ServerSetting>, ServerSettingDto>()
+                .ConvertUsing<ServerSettingConverter>();
 
             CreateMap<IEnumerable<ServerSetting>, ServerSettingDto>()
                 .ConvertUsing<ServerSettingConverter>();

API/Helpers/Converters/ServerSettingConverter.cs

@@ -54,6 +54,9 @@ namespace API.Helpers.Converters
                     case ServerSettingKey.EnableSwaggerUi:
                         destination.EnableSwaggerUi = bool.Parse(row.Value);
                         break;
+                    case ServerSettingKey.TotalBackups:
+                        destination.TotalBackups = int.Parse(row.Value);
+                        break;
                 }
             }
 

API/Helpers/UserParams.cs

@@ -4,7 +4,7 @@
     {
         private const int MaxPageSize = int.MaxValue;
         public int PageNumber { get; init; } = 1;
-        private readonly int _pageSize = 30;
+        private readonly int _pageSize = MaxPageSize;
 
         /// <summary>
         /// If set to 0, will set as MaxInt

API/Services/ArchiveService.cs

@@ -412,7 +412,6 @@ namespace API.Services
 
         private void ExtractArchiveEntries(ZipArchive archive, string extractPath)
         {
-            // TODO: In cases where we try to extract, but there are InvalidPathChars, we need to inform the user (throw exception, let middleware inform user)
             var needsFlattening = ArchiveNeedsFlattening(archive);
             if (!archive.HasFiles() && !needsFlattening) return;
 
@@ -476,7 +475,8 @@ namespace API.Services
             catch (Exception e)
             {
                 _logger.LogWarning(e, "[ExtractArchive] There was a problem extracting {ArchivePath} to {ExtractPath}",archivePath, extractPath);
-                return;
+                throw new KavitaException(
+                    $"There was an error when extracting {archivePath}. Check the file exists, has read permissions or the server OS can support all path characters.");
             }
             _logger.LogDebug("Extracted archive to {ExtractPath} in {ElapsedMilliseconds} milliseconds", extractPath, sw.ElapsedMilliseconds);
         }

API/Services/BookmarkService.cs

@@ -174,6 +174,7 @@ public class BookmarkService : IBookmarkService
     /// <summary>
     /// This is a long-running job that will convert all bookmarks into WebP. Do not invoke anyway except via Hangfire.
     /// </summary>
+    [DisableConcurrentExecution(timeoutInSeconds: 2 * 60 * 60), AutomaticRetry(Attempts = 0)]
     public async Task ConvertAllBookmarkToWebP()
     {
         var bookmarkDirectory =

API/Services/MetadataService.cs

@@ -198,6 +198,8 @@ public class MetadataService : IMetadataService
     /// <remarks>This can be heavy on memory first run</remarks>
     /// <param name="libraryId"></param>
     /// <param name="forceUpdate">Force updating cover image even if underlying file has not been modified or chapter already has a cover image</param>
+    [DisableConcurrentExecution(timeoutInSeconds: 60 * 60 * 60)]
+    [AutomaticRetry(Attempts = 0, OnAttemptsExceeded = AttemptsExceededAction.Delete)]
     public async Task RefreshMetadata(int libraryId, bool forceUpdate = false)
     {
         var library = await _unitOfWork.LibraryRepository.GetLibraryForIdAsync(libraryId, LibraryIncludes.None);

API/Services/Tasks/CleanupService.cs

@@ -147,11 +147,11 @@ namespace API.Services.Tasks
         }
 
         /// <summary>
-        /// Removes Database backups older than 30 days. If all backups are older than 30 days, the latest is kept.
+        /// Removes Database backups older than configured total backups. If all backups are older than total backups days, only the latest is kept.
         /// </summary>
         public async Task CleanupBackups()
         {
-            const int dayThreshold = 30; // TODO: We can make this a config option
+            var dayThreshold = (await _unitOfWork.SettingsRepository.GetSettingsDtoAsync()).TotalBackups;
             _logger.LogInformation("Beginning cleanup of Database backups at {Time}", DateTime.Now);
             var backupDirectory =
                 (await _unitOfWork.SettingsRepository.GetSettingAsync(ServerSettingKey.BackupDirectory)).Value;

API/Services/Tasks/Metadata/WordCountAnalyzerService.cs

@@ -45,6 +45,8 @@ public class WordCountAnalyzerService : IWordCountAnalyzerService
     }
 
 
+    [DisableConcurrentExecution(timeoutInSeconds: 60 * 60 * 60)]
+    [AutomaticRetry(Attempts = 0, OnAttemptsExceeded = AttemptsExceededAction.Delete)]
     public async Task ScanLibrary(int libraryId, bool forceUpdate = false)
     {
         var sw = Stopwatch.StartNew();

API/Services/Tasks/ScannerService.cs

@@ -69,6 +69,8 @@ public class ScannerService : IScannerService
         _wordCountAnalyzerService = wordCountAnalyzerService;
     }
 
+    [DisableConcurrentExecution(60 * 60 * 60)]
+    [AutomaticRetry(Attempts = 3, OnAttemptsExceeded = AttemptsExceededAction.Delete)]
     public async Task ScanSeries(int libraryId, int seriesId, CancellationToken token)
     {
         var sw = new Stopwatch();
@@ -250,7 +252,8 @@ public class ScannerService : IScannerService
         return true;
     }
 
-
+    [DisableConcurrentExecution(60 * 60 * 60)]
+    [AutomaticRetry(Attempts = 0, OnAttemptsExceeded = AttemptsExceededAction.Delete)]
     public async Task ScanLibraries()
     {
         _logger.LogInformation("Starting Scan of All Libraries");
@@ -269,7 +272,8 @@ public class ScannerService : IScannerService
     /// ie) all entities will be rechecked for new cover images and comicInfo.xml changes
     /// </summary>
     /// <param name="libraryId"></param>
-
+    [DisableConcurrentExecution(60 * 60 * 60)]
+    [AutomaticRetry(Attempts = 0, OnAttemptsExceeded = AttemptsExceededAction.Delete)]
     public async Task ScanLibrary(int libraryId)
     {
         Library library;