Custom Cover Images (#499)

* Added some documentation. Removed Require Admin Role from Search Tags. Added Summary to be updated on UpdateTag.

* Added Swagger xml doc generation to beef up the documentation. Started adding xml comments to the APIs. This is a needed, slow task for upcoming Plugins system.

* Implemented the ability to upload a custom series image to override the existing cover image.

Refactored some code out to use ImageService and added more documentation

* When a page cache fails, delete cache directory so user can try to reload.

* Implemented the ability to lock a series cover image such that after user uploads something, it wont get refreshed by Kavita.

* Implemented the ability to reset cover image for series by unlocking

* Kick off a series refresh after a cover is unlocked.

* Ability to press enter to load a url

* Ability to reset selection

* Cleaned up cover chooser such that reset is nicer, errors inform user to use file upload, series edit modal now doesn't use scrollable body. Mobile tweaks. CoverImageLocked is now sent to the UI.

* More css changes to look better

* When no bookmarks, don't show both markups

* Fixed issues where images wouldn't refresh after cover image was changed.

* Implemented the ability to change the cover images for collection tags.

* Added property and API for chapter cover image update

* Added UI code to prepare for updating cover image for chapters. need to rearrange components

* Moved a ton of code around to separate card related screens into their own module.

* Implemented the ability to update a chapter/volume cover image

* Refactored action for volume to say edit to reflect modal action

* Fixed issue where after editing chapter cover image, the underlying card wouldn't update

* Fixed an issue where we were passing volumeId to the reset chapter lock. Changed some logic in volume cover image generation.

* Automatically apply when you hit reset cover image

API/Controllers/CollectionController.cs

@@ -13,17 +13,25 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace API.Controllers
 {
+    /// <summary>
+    /// APIs for Collections
+    /// </summary>
     public class CollectionController : BaseApiController
     {
         private readonly IUnitOfWork _unitOfWork;
         private readonly UserManager<AppUser> _userManager;
 
+        /// <inheritdoc />
         public CollectionController(IUnitOfWork unitOfWork, UserManager<AppUser> userManager)
         {
             _unitOfWork = unitOfWork;
             _userManager = userManager;
         }
 
+        /// <summary>
+        /// Return a list of all collection tags on the server
+        /// </summary>
+        /// <returns></returns>
         [HttpGet]
         public async Task<IEnumerable<CollectionTagDto>> GetAllTags()
         {
@@ -31,11 +39,17 @@ namespace API.Controllers
             var isAdmin = await _userManager.IsInRoleAsync(user, PolicyConstants.AdminRole);
             if (isAdmin)
             {
-                return await _unitOfWork.CollectionTagRepository.GetAllTagDtosAsync();    
+                return await _unitOfWork.CollectionTagRepository.GetAllTagDtosAsync();
             }
             return await _unitOfWork.CollectionTagRepository.GetAllPromotedTagDtosAsync();
         }
-        
+
+        /// <summary>
+        /// Searches against the collection tags on the DB and returns matches that meet the search criteria.
+        /// <remarks>Search strings will be cleaned of certain fields, like %</remarks>
+        /// </summary>
+        /// <param name="queryString">Search term</param>
+        /// <returns></returns>
         [Authorize(Policy = "RequireAdminRole")]
         [HttpGet("search")]
         public async Task<IEnumerable<CollectionTagDto>> SearchTags(string queryString)
@@ -43,20 +57,27 @@ namespace API.Controllers
             queryString ??= "";
             queryString = queryString.Replace(@"%", "");
             if (queryString.Length == 0) return await _unitOfWork.CollectionTagRepository.GetAllTagDtosAsync();
-            
+
             return await _unitOfWork.CollectionTagRepository.SearchTagDtosAsync(queryString);
         }
-        
+
+        /// <summary>
+        /// Updates an existing tag with a new title, promotion status, and summary.
+        /// <remarks>UI does not contain controls to update title</remarks>
+        /// </summary>
+        /// <param name="updatedTag"></param>
+        /// <returns></returns>
         [Authorize(Policy = "RequireAdminRole")]
         [HttpPost("update")]
-        public async Task<ActionResult> UpdateTag(CollectionTagDto updatedTag)
+        public async Task<ActionResult> UpdateTagPromotion(CollectionTagDto updatedTag)
         {
             var existingTag = await _unitOfWork.CollectionTagRepository.GetTagAsync(updatedTag.Id);
             if (existingTag == null) return BadRequest("This tag does not exist");
 
             existingTag.Promoted = updatedTag.Promoted;
-            existingTag.Title = updatedTag.Title;
+            existingTag.Title = updatedTag.Title.Trim();
             existingTag.NormalizedTitle = Parser.Parser.Normalize(updatedTag.Title).ToUpper();
+            existingTag.Summary = updatedTag.Summary.Trim();
 
             if (_unitOfWork.HasChanges())
             {
@@ -73,6 +94,11 @@ namespace API.Controllers
             return BadRequest("Something went wrong, please try again");
         }
 
+        /// <summary>
+        /// For a given tag, update the summary if summary has changed and remove a set of series from the tag.
+        /// </summary>
+        /// <param name="updateSeriesForTagDto"></param>
+        /// <returns></returns>
         [Authorize(Policy = "RequireAdminRole")]
         [HttpPost("update-series")]
         public async Task<ActionResult> UpdateSeriesForTag(UpdateSeriesForTagDto updateSeriesForTagDto)
@@ -90,6 +116,13 @@ namespace API.Controllers
                     _unitOfWork.CollectionTagRepository.Update(tag);
                 }
 
+                if (!updateSeriesForTagDto.Tag.CoverImageLocked)
+                {
+                    tag.CoverImageLocked = false;
+                    tag.CoverImage = Array.Empty<byte>();
+                    _unitOfWork.CollectionTagRepository.Update(tag);
+                }
+
                 foreach (var seriesIdToRemove in updateSeriesForTagDto.SeriesIdsToRemove)
                 {
                     tag.SeriesMetadatas.Remove(tag.SeriesMetadatas.Single(sm => sm.SeriesId == seriesIdToRemove));
@@ -101,7 +134,9 @@ namespace API.Controllers
                     _unitOfWork.CollectionTagRepository.Remove(tag);
                 }
 
-                if (_unitOfWork.HasChanges() && await _unitOfWork.CommitAsync())
+                if (!_unitOfWork.HasChanges()) return Ok("No updates");
+
+                if (await _unitOfWork.CommitAsync())
                 {
                     return Ok("Tag updated");
                 }
@@ -110,9 +145,9 @@ namespace API.Controllers
             {
                 await _unitOfWork.RollbackAsync();
             }
-            
-            
+
+
             return BadRequest("Something went wrong. Please try again.");
         }
     }
-}
+}

API/Controllers/ImageController.cs

@@ -5,57 +5,78 @@ using Microsoft.AspNetCore.Mvc;
 
 namespace API.Controllers
 {
+    /// <summary>
+    /// Responsible for servicing up images stored in the DB
+    /// </summary>
     public class ImageController : BaseApiController
     {
+        private const string Format = "jpeg";
         private readonly IUnitOfWork _unitOfWork;
 
+        /// <inheritdoc />
         public ImageController(IUnitOfWork unitOfWork)
         {
             _unitOfWork = unitOfWork;
         }
-        
+
+        /// <summary>
+        /// Returns cover image for Chapter
+        /// </summary>
+        /// <param name="chapterId"></param>
+        /// <returns></returns>
         [HttpGet("chapter-cover")]
         public async Task<ActionResult> GetChapterCoverImage(int chapterId)
         {
             var content = await _unitOfWork.VolumeRepository.GetChapterCoverImageAsync(chapterId);
             if (content == null) return BadRequest("No cover image");
-            const string format = "jpeg";
 
             Response.AddCacheHeader(content);
-            return File(content, "image/" + format, $"chapterId");
+            return File(content, "image/" + Format, $"{chapterId}");
         }
 
+        /// <summary>
+        /// Returns cover image for Volume
+        /// </summary>
+        /// <param name="volumeId"></param>
+        /// <returns></returns>
         [HttpGet("volume-cover")]
         public async Task<ActionResult> GetVolumeCoverImage(int volumeId)
         {
             var content = await _unitOfWork.SeriesRepository.GetVolumeCoverImageAsync(volumeId);
             if (content == null) return BadRequest("No cover image");
-            const string format = "jpeg";
 
             Response.AddCacheHeader(content);
-            return File(content, "image/" + format, $"volumeId");
+            return File(content, "image/" + Format, $"{volumeId}");
         }
-        
+
+        /// <summary>
+        /// Returns cover image for Series
+        /// </summary>
+        /// <param name="seriesId">Id of Series</param>
+        /// <returns></returns>
         [HttpGet("series-cover")]
         public async Task<ActionResult> GetSeriesCoverImage(int seriesId)
         {
             var content = await _unitOfWork.SeriesRepository.GetSeriesCoverImageAsync(seriesId);
             if (content == null) return BadRequest("No cover image");
-            const string format = "jpeg";
 
             Response.AddCacheHeader(content);
-            return File(content, "image/" + format, $"seriesId");
+            return File(content, "image/" + Format, $"{seriesId}");
         }
-        
+
+        /// <summary>
+        /// Returns cover image for Collection Tag
+        /// </summary>
+        /// <param name="collectionTagId"></param>
+        /// <returns></returns>
         [HttpGet("collection-cover")]
         public async Task<ActionResult> GetCollectionCoverImage(int collectionTagId)
         {
             var content = await _unitOfWork.CollectionTagRepository.GetCoverImageAsync(collectionTagId);
             if (content == null) return BadRequest("No cover image");
-            const string format = "jpeg";
 
             Response.AddCacheHeader(content);
-            return File(content, "image/" + format, $"collectionTagId");
+            return File(content, "image/" + Format, $"{collectionTagId}");
         }
     }
-}
+}

API/Controllers/ReaderController.cs

@@ -37,16 +37,24 @@ namespace API.Controllers
             var chapter = await _cacheService.Ensure(chapterId);
             if (chapter == null) return BadRequest("There was an issue finding image file for reading");
 
-            var (path, _) = await _cacheService.GetCachedPagePath(chapter, page);
-            if (string.IsNullOrEmpty(path) || !System.IO.File.Exists(path)) return BadRequest($"No such image for page {page}");
+            try
+            {
+                var (path, _) = await _cacheService.GetCachedPagePath(chapter, page);
+                if (string.IsNullOrEmpty(path) || !System.IO.File.Exists(path)) return BadRequest($"No such image for page {page}");
 
-            var content = await _directoryService.ReadFileAsync(path);
-            var format = Path.GetExtension(path).Replace(".", "");
+                var content = await _directoryService.ReadFileAsync(path);
+                var format = Path.GetExtension(path).Replace(".", "");
 
-            // Calculates SHA1 Hash for byte[]
-            Response.AddCacheHeader(content);
+                // Calculates SHA1 Hash for byte[]
+                Response.AddCacheHeader(content);
 
-            return File(content, "image/" + format);
+                return File(content, "image/" + format);
+            }
+            catch (Exception)
+            {
+                _cacheService.CleanupChapters(new []{ chapterId });
+                throw;
+            }
         }
 
         [HttpGet("chapter-info")]

API/Controllers/SeriesController.cs

@@ -9,6 +9,7 @@ using API.Entities;
 using API.Extensions;
 using API.Helpers;
 using API.Interfaces;
+using Kavita.Common;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
@@ -45,11 +46,26 @@ namespace API.Controllers
             return Ok(series);
         }
 
+        /// <summary>
+        /// Fetches a Series for a given Id
+        /// </summary>
+        /// <param name="seriesId">Series Id to fetch details for</param>
+        /// <returns></returns>
+        /// <exception cref="KavitaException">Throws an exception if the series Id does exist</exception>
         [HttpGet("{seriesId}")]
         public async Task<ActionResult<SeriesDto>> GetSeries(int seriesId)
         {
             var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername());
-            return Ok(await _unitOfWork.SeriesRepository.GetSeriesDtoByIdAsync(seriesId, user.Id));
+            try
+            {
+                return Ok(await _unitOfWork.SeriesRepository.GetSeriesDtoByIdAsync(seriesId, user.Id));
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "There was an issue fetching {SeriesId}", seriesId);
+                throw new KavitaException("This series does not exist");
+            }
+
         }
 
         [Authorize(Policy = "RequireAdminRole")]
@@ -138,10 +154,21 @@ namespace API.Controllers
             series.SortName = updateSeries.SortName.Trim();
             series.Summary = updateSeries.Summary.Trim();
 
+            var needsRefreshMetadata = false;
+            if (!updateSeries.CoverImageLocked)
+            {
+                series.CoverImageLocked = false;
+                needsRefreshMetadata = true;
+            }
+
             _unitOfWork.SeriesRepository.Update(series);
 
             if (await _unitOfWork.CommitAsync())
             {
+                if (needsRefreshMetadata)
+                {
+                    _taskScheduler.RefreshSeriesMetadata(series.LibraryId, series.Id);
+                }
                 return Ok();
             }
 
@@ -274,6 +301,12 @@ namespace API.Controllers
             return BadRequest("Could not update metadata");
         }
 
+        /// <summary>
+        /// Returns all Series grouped by the passed Collection Id with Pagination.
+        /// </summary>
+        /// <param name="collectionId">Collection Id to pull series from</param>
+        /// <param name="userParams">Pagination information</param>
+        /// <returns></returns>
         [HttpGet("series-by-collection")]
         public async Task<ActionResult<IEnumerable<SeriesDto>>> GetSeriesByCollectionTag(int collectionId, [FromQuery] UserParams userParams)
         {

API/Controllers/UploadController.cs

@@ -0,0 +1,208 @@
+using System;
+using System.Threading.Tasks;
+using API.DTOs.Uploads;
+using API.Interfaces;
+using API.Interfaces.Services;
+using Microsoft.AspNetCore.Authorization;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Logging;
+
+namespace API.Controllers
+{
+    /// <summary>
+    ///
+    /// </summary>
+    [Authorize(Policy = "RequireAdminRole")]
+    public class UploadController : BaseApiController
+    {
+        private readonly IUnitOfWork _unitOfWork;
+        private readonly IImageService _imageService;
+        private readonly ILogger<UploadController> _logger;
+        private readonly ITaskScheduler _taskScheduler;
+
+        /// <inheritdoc />
+        public UploadController(IUnitOfWork unitOfWork, IImageService imageService, ILogger<UploadController> logger, ITaskScheduler taskScheduler)
+        {
+            _unitOfWork = unitOfWork;
+            _imageService = imageService;
+            _logger = logger;
+            _taskScheduler = taskScheduler;
+        }
+
+        /// <summary>
+        /// Replaces series cover image and locks it with a base64 encoded image
+        /// </summary>
+        /// <param name="uploadFileDto"></param>
+        /// <returns></returns>
+        [Authorize(Policy = "RequireAdminRole")]
+        [RequestSizeLimit(8_000_000)]
+        [HttpPost("series")]
+        public async Task<ActionResult> UploadSeriesCoverImageFromUrl(UploadFileDto uploadFileDto)
+        {
+            // Check if Url is non empty, request the image and place in temp, then ask image service to handle it.
+            // See if we can do this all in memory without touching underlying system
+            if (string.IsNullOrEmpty(uploadFileDto.Url))
+            {
+                return BadRequest("You must pass a url to use");
+            }
+
+            try
+            {
+                var bytes = _imageService.CreateThumbnailFromBase64(uploadFileDto.Url);
+                var series = await _unitOfWork.SeriesRepository.GetSeriesByIdAsync(uploadFileDto.Id);
+
+                if (bytes.Length > 0)
+                {
+                    series.CoverImage = bytes;
+                    series.CoverImageLocked = true;
+                    _unitOfWork.SeriesRepository.Update(series);
+                }
+
+                if (_unitOfWork.HasChanges())
+                {
+                    await _unitOfWork.CommitAsync();
+                    return Ok();
+                }
+
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "There was an issue uploading cover image for Series {Id}", uploadFileDto.Id);
+                await _unitOfWork.RollbackAsync();
+            }
+
+            return BadRequest("Unable to save cover image to Series");
+        }
+
+        /// <summary>
+        /// Replaces collection tag cover image and locks it with a base64 encoded image
+        /// </summary>
+        /// <param name="uploadFileDto"></param>
+        /// <returns></returns>
+        [Authorize(Policy = "RequireAdminRole")]
+        [RequestSizeLimit(8_000_000)]
+        [HttpPost("collection")]
+        public async Task<ActionResult> UploadCollectionCoverImageFromUrl(UploadFileDto uploadFileDto)
+        {
+            // Check if Url is non empty, request the image and place in temp, then ask image service to handle it.
+            // See if we can do this all in memory without touching underlying system
+            if (string.IsNullOrEmpty(uploadFileDto.Url))
+            {
+                return BadRequest("You must pass a url to use");
+            }
+
+            try
+            {
+                var bytes = _imageService.CreateThumbnailFromBase64(uploadFileDto.Url);
+                var tag = await _unitOfWork.CollectionTagRepository.GetTagAsync(uploadFileDto.Id);
+
+                if (bytes.Length > 0)
+                {
+                    tag.CoverImage = bytes;
+                    tag.CoverImageLocked = true;
+                    _unitOfWork.CollectionTagRepository.Update(tag);
+                }
+
+                if (_unitOfWork.HasChanges())
+                {
+                    await _unitOfWork.CommitAsync();
+                    return Ok();
+                }
+
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "There was an issue uploading cover image for Collection Tag {Id}", uploadFileDto.Id);
+                await _unitOfWork.RollbackAsync();
+            }
+
+            return BadRequest("Unable to save cover image to Collection Tag");
+        }
+
+        /// <summary>
+        /// Replaces chapter cover image and locks it with a base64 encoded image. This will update the parent volume's cover image.
+        /// </summary>
+        /// <param name="uploadFileDto"></param>
+        /// <returns></returns>
+        [Authorize(Policy = "RequireAdminRole")]
+        [RequestSizeLimit(8_000_000)]
+        [HttpPost("chapter")]
+        public async Task<ActionResult> UploadChapterCoverImageFromUrl(UploadFileDto uploadFileDto)
+        {
+            // Check if Url is non empty, request the image and place in temp, then ask image service to handle it.
+            // See if we can do this all in memory without touching underlying system
+            if (string.IsNullOrEmpty(uploadFileDto.Url))
+            {
+                return BadRequest("You must pass a url to use");
+            }
+
+            try
+            {
+                var bytes = _imageService.CreateThumbnailFromBase64(uploadFileDto.Url);
+
+                if (bytes.Length > 0)
+                {
+                    var chapter = await _unitOfWork.VolumeRepository.GetChapterAsync(uploadFileDto.Id);
+                    chapter.CoverImage = bytes;
+                    chapter.CoverImageLocked = true;
+                    _unitOfWork.ChapterRepository.Update(chapter);
+                    var volume = await _unitOfWork.SeriesRepository.GetVolumeAsync(chapter.VolumeId);
+                    volume.CoverImage = chapter.CoverImage;
+                    _unitOfWork.VolumeRepository.Update(volume);
+                }
+
+                if (_unitOfWork.HasChanges())
+                {
+                    await _unitOfWork.CommitAsync();
+                    return Ok();
+                }
+
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "There was an issue uploading cover image for Chapter {Id}", uploadFileDto.Id);
+                await _unitOfWork.RollbackAsync();
+            }
+
+            return BadRequest("Unable to save cover image to Chapter");
+        }
+
+        /// <summary>
+        /// Replaces chapter cover image and locks it with a base64 encoded image. This will update the parent volume's cover image.
+        /// </summary>
+        /// <param name="uploadFileDto">Does not use Url property</param>
+        /// <returns></returns>
+        [Authorize(Policy = "RequireAdminRole")]
+        [HttpPost("reset-chapter-lock")]
+        public async Task<ActionResult> ResetChapterLock(UploadFileDto uploadFileDto)
+        {
+            try
+            {
+                var chapter = await _unitOfWork.VolumeRepository.GetChapterAsync(uploadFileDto.Id);
+                chapter.CoverImage = Array.Empty<byte>();
+                chapter.CoverImageLocked = false;
+                _unitOfWork.ChapterRepository.Update(chapter);
+                var volume = await _unitOfWork.SeriesRepository.GetVolumeAsync(chapter.VolumeId);
+                volume.CoverImage = chapter.CoverImage;
+                _unitOfWork.VolumeRepository.Update(volume);
+                var series = await _unitOfWork.SeriesRepository.GetSeriesByIdAsync(volume.SeriesId);
+
+                if (_unitOfWork.HasChanges())
+                {
+                    await _unitOfWork.CommitAsync();
+                    _taskScheduler.RefreshSeriesMetadata(series.LibraryId, series.Id);
+                    return Ok();
+                }
+
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "There was an issue resetting cover lock for Chapter {Id}", uploadFileDto.Id);
+                await _unitOfWork.RollbackAsync();
+            }
+
+            return BadRequest("Unable to resetting cover lock for Chapter");
+        }
+
+    }
+}