using System; using System.Collections.Generic; using System.Threading.Tasks; using API.Constants; using API.Data; using API.Data.Repositories; using API.DTOs; using API.DTOs.Dashboard; using API.DTOs.Filtering; using API.DTOs.Filtering.v2; using API.DTOs.Metadata; using API.DTOs.Metadata.Matching; using API.DTOs.Recommendation; using API.DTOs.SeriesDetail; using API.Entities; using API.Entities.Enums; using API.Extensions; using API.Helpers; using API.Services; using API.Services.Plus; using EasyCaching.Core; using Kavita.Common; using Kavita.Common.Extensions; using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Http.HttpResults; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; namespace API.Controllers; #nullable enable public class SeriesController : BaseApiController { private readonly ILogger _logger; private readonly ITaskScheduler _taskScheduler; private readonly IUnitOfWork _unitOfWork; private readonly ISeriesService _seriesService; private readonly ILicenseService _licenseService; private readonly ILocalizationService _localizationService; private readonly IExternalMetadataService _externalMetadataService; private readonly IEasyCachingProvider _externalSeriesCacheProvider; private const string CacheKey = "externalSeriesData_"; public SeriesController(ILogger logger, ITaskScheduler taskScheduler, IUnitOfWork unitOfWork, ISeriesService seriesService, ILicenseService licenseService, IEasyCachingProviderFactory cachingProviderFactory, ILocalizationService localizationService, IExternalMetadataService externalMetadataService) { _logger = logger; _taskScheduler = taskScheduler; _unitOfWork = unitOfWork; _seriesService = seriesService; _licenseService = licenseService; _localizationService = localizationService; _externalMetadataService = externalMetadataService; _externalSeriesCacheProvider = cachingProviderFactory.GetCachingProvider(EasyCacheProfiles.KavitaPlusExternalSeries); } /// /// Gets series with the applied Filter /// /// This is considered v1 and no longer used by Kavita, but will be supported for sometime. See series/v2 /// /// /// /// [HttpPost] [Obsolete("use v2")] public async Task>> GetSeriesForLibrary(int libraryId, [FromQuery] UserParams userParams, [FromBody] FilterDto filterDto) { var userId = User.GetUserId(); var series = await _unitOfWork.SeriesRepository.GetSeriesDtoForLibraryIdAsync(libraryId, userId, userParams, filterDto); // Apply progress/rating information (I can't work out how to do this in initial query) if (series == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "no-series")); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, series); Response.AddPaginationHeader(series.CurrentPage, series.PageSize, series.TotalCount, series.TotalPages); return Ok(series); } /// /// Gets series with the applied Filter /// /// /// /// [HttpPost("v2")] public async Task>> GetSeriesForLibraryV2([FromQuery] UserParams userParams, [FromBody] FilterV2Dto filterDto) { var userId = User.GetUserId(); var series = await _unitOfWork.SeriesRepository.GetSeriesDtoForLibraryIdV2Async(userId, userParams, filterDto); //TODO: We might want something like libraryId as source so that I don't have to muck with the groups // Apply progress/rating information (I can't work out how to do this in initial query) if (series == null) return BadRequest("Could not get series for library"); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, series); Response.AddPaginationHeader(series.CurrentPage, series.PageSize, series.TotalCount, series.TotalPages); return Ok(series); } /// /// Fetches a Series for a given Id /// /// Series Id to fetch details for /// /// Throws an exception if the series Id does exist [HttpGet("{seriesId:int}")] public async Task> GetSeries(int seriesId) { var series = await _unitOfWork.SeriesRepository.GetSeriesDtoByIdAsync(seriesId, User.GetUserId()); if (series == null) return NoContent(); return Ok(series); } /// /// Deletes a series from Kavita /// /// /// If the series was deleted or not [Authorize(Policy = "RequireAdminRole")] [HttpDelete("{seriesId}")] public async Task> DeleteSeries(int seriesId) { var username = User.GetUsername(); _logger.LogInformation("Series {SeriesId} is being deleted by {UserName}", seriesId, username); return Ok(await _seriesService.DeleteMultipleSeries([seriesId])); } [Authorize(Policy = "RequireAdminRole")] [HttpPost("delete-multiple")] public async Task DeleteMultipleSeries(DeleteSeriesDto dto) { var username = User.GetUsername(); _logger.LogInformation("Series {@SeriesId} is being deleted by {UserName}", dto.SeriesIds, username); if (await _seriesService.DeleteMultipleSeries(dto.SeriesIds)) return Ok(true); return BadRequest(await _localizationService.Translate(User.GetUserId(), "generic-series-delete")); } /// /// Returns All volumes for a series with progress information and Chapters /// /// /// [HttpGet("volumes")] public async Task>> GetVolumes(int seriesId) { return Ok(await _unitOfWork.VolumeRepository.GetVolumesDtoAsync(seriesId, User.GetUserId())); } [HttpGet("volume")] public async Task> GetVolume(int volumeId) { var vol = await _unitOfWork.VolumeRepository.GetVolumeDtoAsync(volumeId, User.GetUserId()); if (vol == null) return NoContent(); return Ok(vol); } [HttpGet("chapter")] public async Task> GetChapter(int chapterId) { var chapter = await _unitOfWork.ChapterRepository.GetChapterDtoAsync(chapterId); if (chapter == null) return NoContent(); return Ok(await _unitOfWork.ChapterRepository.AddChapterModifiers(User.GetUserId(), chapter)); } [Obsolete("All chapter entities will load this data by default. Will not be maintained as of v0.8.1")] [HttpGet("chapter-metadata")] public async Task> GetChapterMetadata(int chapterId) { return Ok(await _unitOfWork.ChapterRepository.GetChapterMetadataDtoAsync(chapterId)); } /// /// Update the user rating for the given series /// /// /// [HttpPost("update-rating")] public async Task UpdateSeriesRating(UpdateSeriesRatingDto updateSeriesRatingDto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Ratings); if (!await _seriesService.UpdateRating(user!, updateSeriesRatingDto)) return BadRequest(await _localizationService.Translate(User.GetUserId(), "generic-error")); return Ok(); } /// /// Updates the Series /// /// /// [HttpPost("update")] public async Task UpdateSeries(UpdateSeriesDto updateSeries) { var series = await _unitOfWork.SeriesRepository.GetSeriesByIdAsync(updateSeries.Id); if (series == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "series-doesnt-exist")); series.NormalizedName = series.Name.ToNormalized(); if (!string.IsNullOrEmpty(updateSeries.SortName?.Trim())) { series.SortName = updateSeries.SortName.Trim(); } series.LocalizedName = updateSeries.LocalizedName?.Trim(); series.NormalizedLocalizedName = series.LocalizedName?.ToNormalized(); series.SortNameLocked = updateSeries.SortNameLocked; series.LocalizedNameLocked = updateSeries.LocalizedNameLocked; var needsRefreshMetadata = false; // This is when you hit Reset if (series.CoverImageLocked && !updateSeries.CoverImageLocked) { // Trigger a refresh when we are moving from a locked image to a non-locked needsRefreshMetadata = true; series.CoverImage = null; series.CoverImageLocked = updateSeries.CoverImageLocked; series.ResetColorScape(); } _unitOfWork.SeriesRepository.Update(series); if (!await _unitOfWork.CommitAsync()) { return BadRequest(await _localizationService.Translate(User.GetUserId(), "generic-series-update")); } if (needsRefreshMetadata) { _taskScheduler.RefreshSeriesMetadata(series.LibraryId, series.Id); } return Ok(); } /// /// Gets all recently added series. Obsolete, use recently-added-v2 /// /// /// /// /// [ResponseCache(CacheProfileName = "Instant")] [HttpPost("recently-added")] [Obsolete("use recently-added-v2")] public async Task>> GetRecentlyAdded(FilterDto filterDto, [FromQuery] UserParams userParams, [FromQuery] int libraryId = 0) { var userId = User.GetUserId(); var series = await _unitOfWork.SeriesRepository.GetRecentlyAdded(libraryId, userId, userParams, filterDto); // Apply progress/rating information (I can't work out how to do this in initial query) if (series == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "no-series")); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, series); Response.AddPaginationHeader(series.CurrentPage, series.PageSize, series.TotalCount, series.TotalPages); return Ok(series); } /// /// Gets all recently added series /// /// /// /// [ResponseCache(CacheProfileName = "Instant")] [HttpPost("recently-added-v2")] public async Task>> GetRecentlyAddedV2(FilterV2Dto filterDto, [FromQuery] UserParams userParams) { var userId = User.GetUserId(); var series = await _unitOfWork.SeriesRepository.GetRecentlyAddedV2(userId, userParams, filterDto); // Apply progress/rating information (I can't work out how to do this in initial query) if (series == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "no-series")); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, series); Response.AddPaginationHeader(series.CurrentPage, series.PageSize, series.TotalCount, series.TotalPages); return Ok(series); } /// /// Returns series that were recently updated, like adding or removing a chapter /// /// [ResponseCache(CacheProfileName = "Instant")] [HttpPost("recently-updated-series")] public async Task>> GetRecentlyAddedChapters() { return Ok(await _unitOfWork.SeriesRepository.GetRecentlyUpdatedSeries(User.GetUserId(), 20)); } /// /// Returns all series for the library /// /// /// /// /// [HttpPost("all-v2")] public async Task>> GetAllSeriesV2(FilterV2Dto filterDto, [FromQuery] UserParams userParams, [FromQuery] int libraryId = 0, [FromQuery] QueryContext context = QueryContext.None) { var userId = User.GetUserId(); var series = await _unitOfWork.SeriesRepository.GetSeriesDtoForLibraryIdV2Async(userId, userParams, filterDto, context); // Apply progress/rating information (I can't work out how to do this in initial query) if (series == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "no-series")); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, series); Response.AddPaginationHeader(series.CurrentPage, series.PageSize, series.TotalCount, series.TotalPages); return Ok(series); } /// /// Returns all series for the library. Obsolete, use all-v2 /// /// /// /// /// [HttpPost("all")] [Obsolete("Use all-v2")] public async Task>> GetAllSeries(FilterDto filterDto, [FromQuery] UserParams userParams, [FromQuery] int libraryId = 0) { var userId = User.GetUserId(); var series = await _unitOfWork.SeriesRepository.GetSeriesDtoForLibraryIdAsync(libraryId, userId, userParams, filterDto); // Apply progress/rating information (I can't work out how to do this in initial query) if (series == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "no-series")); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, series); Response.AddPaginationHeader(series.CurrentPage, series.PageSize, series.TotalCount, series.TotalPages); return Ok(series); } /// /// Fetches series that are on deck aka have progress on them. /// /// /// Default of 0 meaning all libraries /// [ResponseCache(CacheProfileName = "Instant")] [HttpPost("on-deck")] public async Task>> GetOnDeck([FromQuery] UserParams userParams, [FromQuery] int libraryId = 0) { var userId = User.GetUserId(); var pagedList = await _unitOfWork.SeriesRepository.GetOnDeck(userId, libraryId, userParams, null); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, pagedList); Response.AddPaginationHeader(pagedList.CurrentPage, pagedList.PageSize, pagedList.TotalCount, pagedList.TotalPages); return Ok(pagedList); } /// /// Removes a series from displaying on deck until the next read event on that series /// /// /// [HttpPost("remove-from-on-deck")] public async Task RemoveFromOnDeck([FromQuery] int seriesId) { await _unitOfWork.SeriesRepository.RemoveFromOnDeck(seriesId, User.GetUserId()); return Ok(); } /// /// Runs a Cover Image Generation task /// /// /// [Authorize(Policy = "RequireAdminRole")] [HttpPost("refresh-metadata")] public ActionResult RefreshSeriesMetadata(RefreshSeriesDto refreshSeriesDto) { _taskScheduler.RefreshSeriesMetadata(refreshSeriesDto.LibraryId, refreshSeriesDto.SeriesId, refreshSeriesDto.ForceUpdate, refreshSeriesDto.ForceColorscape); return Ok(); } /// /// Scan a series and force each file to be updated. This should be invoked via the User, hence why we force. /// /// /// [Authorize(Policy = "RequireAdminRole")] [HttpPost("scan")] public ActionResult ScanSeries(RefreshSeriesDto refreshSeriesDto) { _taskScheduler.ScanSeries(refreshSeriesDto.LibraryId, refreshSeriesDto.SeriesId, true); return Ok(); } /// /// Run a file analysis on the series. /// /// /// [Authorize(Policy = "RequireAdminRole")] [HttpPost("analyze")] public ActionResult AnalyzeSeries(RefreshSeriesDto refreshSeriesDto) { _taskScheduler.AnalyzeFilesForSeries(refreshSeriesDto.LibraryId, refreshSeriesDto.SeriesId, refreshSeriesDto.ForceUpdate); return Ok(); } /// /// Returns metadata for a given series /// /// /// [HttpGet("metadata")] public async Task> GetSeriesMetadata(int seriesId) { return Ok(await _unitOfWork.SeriesRepository.GetSeriesMetadata(seriesId)); } /// /// Update series metadata /// /// /// [HttpPost("metadata")] public async Task UpdateSeriesMetadata(UpdateSeriesMetadataDto updateSeriesMetadataDto) { if (!await _seriesService.UpdateSeriesMetadata(updateSeriesMetadataDto)) return BadRequest(await _localizationService.Translate(User.GetUserId(), "update-metadata-fail")); return Ok(await _localizationService.Translate(User.GetUserId(), "series-updated")); } /// /// Returns all Series grouped by the passed Collection Id with Pagination. /// /// Collection Id to pull series from /// Pagination information /// [HttpGet("series-by-collection")] public async Task>> GetSeriesByCollectionTag(int collectionId, [FromQuery] UserParams userParams) { var userId = User.GetUserId(); var series = await _unitOfWork.SeriesRepository.GetSeriesDtoForCollectionAsync(collectionId, userId, userParams); // Apply progress/rating information (I can't work out how to do this in initial query) if (series == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "no-series-collection")); await _unitOfWork.SeriesRepository.AddSeriesModifiers(userId, series); Response.AddPaginationHeader(series.CurrentPage, series.PageSize, series.TotalCount, series.TotalPages); return Ok(series); } /// /// Fetches Series for a set of Ids. This will check User for permission access and filter out any Ids that don't exist or /// the user does not have access to. /// /// [HttpPost("series-by-ids")] public async Task>> GetAllSeriesById(SeriesByIdsDto dto) { if (dto.SeriesIds == null) return BadRequest(await _localizationService.Translate(User.GetUserId(), "invalid-payload")); return Ok(await _unitOfWork.SeriesRepository.GetSeriesDtoForIdsAsync(dto.SeriesIds, User.GetUserId())); } /// /// Get the age rating for the enum value /// /// /// /// This is cached for an hour [ResponseCache(CacheProfileName = "Month", VaryByQueryKeys = new [] {"ageRating"})] [HttpGet("age-rating")] public async Task> GetAgeRating(int ageRating) { var val = (AgeRating) ageRating; if (val == AgeRating.NotApplicable) return await _localizationService.Translate(User.GetUserId(), "age-restriction-not-applicable"); return Ok(val.ToDescription()); } /// /// Get a special DTO for Series Detail page. /// /// /// /// Do not rely on this API externally. May change without hesitation. [ResponseCache(CacheProfileName = ResponseCacheProfiles.FiveMinute, VaryByQueryKeys = new [] {"seriesId"})] [HttpGet("series-detail")] public async Task> GetSeriesDetailBreakdown(int seriesId) { try { return await _seriesService.GetSeriesDetail(seriesId, User.GetUserId()); } catch (KavitaException ex) { return BadRequest(await _localizationService.Translate(User.GetUserId(), ex.Message)); } } /// /// Fetches the related series for a given series /// /// /// Type of Relationship to pull back /// [HttpGet("related")] public async Task>> GetRelatedSeries(int seriesId, RelationKind relation) { return Ok(await _unitOfWork.SeriesRepository.GetSeriesForRelationKind(User.GetUserId(), seriesId, relation)); } /// /// Returns all related series against the passed series Id /// /// /// [HttpGet("all-related")] public async Task> GetAllRelatedSeries(int seriesId) { return Ok(await _seriesService.GetRelatedSeries(User.GetUserId(), seriesId)); } /// /// Update the relations attached to the Series. Does not generate associated Sequel/Prequel pairs on target series. /// /// /// [Authorize(Policy="RequireAdminRole")] [HttpPost("update-related")] public async Task UpdateRelatedSeries(UpdateRelatedSeriesDto dto) { if (await _seriesService.UpdateRelatedSeries(dto)) { return Ok(); } return BadRequest(await _localizationService.Translate(User.GetUserId(), "generic-relationship")); } [Authorize(Policy = "RequireAdminRole")] [HttpGet("external-series-detail")] public async Task> GetExternalSeriesInfo(int? aniListId, long? malId, int? seriesId) { if (!await _licenseService.HasActiveLicense()) { return BadRequest(); } var cacheKey = $"{CacheKey}-{aniListId ?? 0}-{malId ?? 0}-{seriesId ?? 0}"; var results = await _externalSeriesCacheProvider.GetAsync(cacheKey); if (results.HasValue) { return Ok(results.Value); } try { var ret = await _externalMetadataService.GetExternalSeriesDetail(aniListId, malId, seriesId); await _externalSeriesCacheProvider.SetAsync(cacheKey, ret, TimeSpan.FromMinutes(15)); return Ok(ret); } catch (Exception) { return BadRequest("Unable to load External Series details"); } } /// /// Based on the delta times between when chapters are added, for series that are not Completed/Cancelled/Hiatus, forecast the next /// date when it will be available. /// /// /// [HttpGet("next-expected")] public async Task> GetNextExpectedChapter(int seriesId) { var userId = User.GetUserId(); return Ok(await _seriesService.GetEstimatedChapterCreationDate(seriesId, userId)); } /// /// Sends a request to Kavita+ API for all potential matches, sorted by relevance /// /// /// [HttpPost("match")] public async Task>> MatchSeries(MatchSeriesDto dto) { return Ok(await _externalMetadataService.MatchSeries(dto)); } /// /// This will perform the fix match /// /// /// /// [HttpPost("update-match")] public async Task UpdateSeriesMatch([FromQuery] int seriesId, [FromQuery] int aniListId) { await _externalMetadataService.FixSeriesMatch(seriesId, aniListId); return Ok(); } /// /// When true, will not perform a match and will prevent Kavita from attempting to match/scrobble against this series /// /// /// /// [HttpPost("dont-match")] public async Task UpdateDontMatch([FromQuery] int seriesId, [FromQuery] bool dontMatch) { await _externalMetadataService.UpdateSeriesDontMatch(seriesId, dontMatch); return Ok(); } }