using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Threading.Tasks; using API.Data; using API.Data.Repositories; using API.DTOs; using API.DTOs.Reader; using API.Entities; using API.Entities.Enums; using API.Extensions; using API.Services; using API.Services.Tasks; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Logging; namespace API.Controllers { /// /// For all things regarding reading, mainly focusing on non-Book related entities /// public class ReaderController : BaseApiController { private readonly ICacheService _cacheService; private readonly IUnitOfWork _unitOfWork; private readonly ILogger _logger; private readonly IReaderService _readerService; private readonly IDirectoryService _directoryService; private readonly ICleanupService _cleanupService; /// public ReaderController(ICacheService cacheService, IUnitOfWork unitOfWork, ILogger logger, IReaderService readerService, IDirectoryService directoryService, ICleanupService cleanupService) { _cacheService = cacheService; _unitOfWork = unitOfWork; _logger = logger; _readerService = readerService; _directoryService = directoryService; _cleanupService = cleanupService; } /// /// Returns an image for a given chapter. Side effect: This will cache the chapter images for reading. /// /// /// /// [HttpGet("image")] public async Task GetImage(int chapterId, int page) { if (page < 0) page = 0; var chapter = await _cacheService.Ensure(chapterId); if (chapter == null) return BadRequest("There was an issue finding image file for reading"); try { var path = _cacheService.GetCachedPagePath(chapter, page); if (string.IsNullOrEmpty(path) || !System.IO.File.Exists(path)) return BadRequest($"No such image for page {page}"); var format = Path.GetExtension(path).Replace(".", ""); return PhysicalFile(path, "image/" + format, Path.GetFileName(path)); } catch (Exception) { _cacheService.CleanupChapters(new []{ chapterId }); throw; } } /// /// Returns various information about a Chapter. Side effect: This will cache the chapter images for reading. /// /// /// [HttpGet("chapter-info")] public async Task> GetChapterInfo(int chapterId) { var chapter = await _cacheService.Ensure(chapterId); if (chapter == null) return BadRequest("Could not find Chapter"); var dto = await _unitOfWork.ChapterRepository.GetChapterInfoDtoAsync(chapterId); if (dto == null) return BadRequest("Please perform a scan on this series or library and try again"); var mangaFile = (await _unitOfWork.ChapterRepository.GetFilesForChapterAsync(chapterId)).First(); return Ok(new ChapterInfoDto() { ChapterNumber = dto.ChapterNumber, VolumeNumber = dto.VolumeNumber, VolumeId = dto.VolumeId, FileName = Path.GetFileName(mangaFile.FilePath), SeriesName = dto.SeriesName, SeriesFormat = dto.SeriesFormat, SeriesId = dto.SeriesId, LibraryId = dto.LibraryId, IsSpecial = dto.IsSpecial, Pages = dto.Pages, ChapterTitle = dto.ChapterTitle ?? string.Empty }); } [HttpPost("mark-read")] public async Task MarkRead(MarkReadDto markReadDto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); var volumes = await _unitOfWork.VolumeRepository.GetVolumes(markReadDto.SeriesId); user.Progresses ??= new List(); foreach (var volume in volumes) { _readerService.MarkChaptersAsRead(user, markReadDto.SeriesId, volume.Chapters); } _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("There was an issue saving progress"); } /// /// Marks a Series as Unread (progress) /// /// /// [HttpPost("mark-unread")] public async Task MarkUnread(MarkReadDto markReadDto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); var volumes = await _unitOfWork.VolumeRepository.GetVolumes(markReadDto.SeriesId); user.Progresses ??= new List(); foreach (var volume in volumes) { foreach (var chapter in volume.Chapters) { var userProgress = ReaderService.GetUserProgressForChapter(user, chapter); if (userProgress == null) continue; userProgress.PagesRead = 0; userProgress.SeriesId = markReadDto.SeriesId; userProgress.VolumeId = volume.Id; } } _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("There was an issue saving progress"); } /// /// Marks all chapters within a volume as unread /// /// /// [HttpPost("mark-volume-unread")] public async Task MarkVolumeAsUnread(MarkVolumeReadDto markVolumeReadDto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); var chapters = await _unitOfWork.ChapterRepository.GetChaptersAsync(markVolumeReadDto.VolumeId); _readerService.MarkChaptersAsUnread(user, markVolumeReadDto.SeriesId, chapters); _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("Could not save progress"); } /// /// Marks all chapters within a volume as Read /// /// /// [HttpPost("mark-volume-read")] public async Task MarkVolumeAsRead(MarkVolumeReadDto markVolumeReadDto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); var chapters = await _unitOfWork.ChapterRepository.GetChaptersAsync(markVolumeReadDto.VolumeId); _readerService.MarkChaptersAsRead(user, markVolumeReadDto.SeriesId, chapters); _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("Could not save progress"); } /// /// Marks all chapters within a list of volumes as Read. All volumes must belong to the same Series. /// /// /// [HttpPost("mark-multiple-read")] public async Task MarkMultipleAsRead(MarkVolumesReadDto dto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); user.Progresses ??= new List(); var chapterIds = await _unitOfWork.VolumeRepository.GetChapterIdsByVolumeIds(dto.VolumeIds); foreach (var chapterId in dto.ChapterIds) { chapterIds.Add(chapterId); } var chapters = await _unitOfWork.ChapterRepository.GetChaptersByIdsAsync(chapterIds); _readerService.MarkChaptersAsRead(user, dto.SeriesId, chapters); _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("Could not save progress"); } /// /// Marks all chapters within a list of volumes as Unread. All volumes must belong to the same Series. /// /// /// [HttpPost("mark-multiple-unread")] public async Task MarkMultipleAsUnread(MarkVolumesReadDto dto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); user.Progresses ??= new List(); var chapterIds = await _unitOfWork.VolumeRepository.GetChapterIdsByVolumeIds(dto.VolumeIds); foreach (var chapterId in dto.ChapterIds) { chapterIds.Add(chapterId); } var chapters = await _unitOfWork.ChapterRepository.GetChaptersByIdsAsync(chapterIds); _readerService.MarkChaptersAsUnread(user, dto.SeriesId, chapters); _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("Could not save progress"); } /// /// Marks all chapters within a list of series as Read. /// /// /// [HttpPost("mark-multiple-series-read")] public async Task MarkMultipleSeriesAsRead(MarkMultipleSeriesAsReadDto dto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); user.Progresses ??= new List(); var volumes = await _unitOfWork.VolumeRepository.GetVolumesForSeriesAsync(dto.SeriesIds.ToArray(), true); foreach (var volume in volumes) { _readerService.MarkChaptersAsRead(user, volume.SeriesId, volume.Chapters); } _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("Could not save progress"); } /// /// Marks all chapters within a list of series as Unread. /// /// /// [HttpPost("mark-multiple-series-unread")] public async Task MarkMultipleSeriesAsUnread(MarkMultipleSeriesAsReadDto dto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); user.Progresses ??= new List(); var volumes = await _unitOfWork.VolumeRepository.GetVolumesForSeriesAsync(dto.SeriesIds.ToArray(), true); foreach (var volume in volumes) { _readerService.MarkChaptersAsUnread(user, volume.SeriesId, volume.Chapters); } _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } return BadRequest("Could not save progress"); } /// /// Returns Progress (page number) for a chapter for the logged in user /// /// /// [HttpGet("get-progress")] public async Task> GetProgress(int chapterId) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Progress); var progressBookmark = new ProgressDto() { PageNum = 0, ChapterId = chapterId, VolumeId = 0, SeriesId = 0 }; if (user.Progresses == null) return Ok(progressBookmark); var progress = user.Progresses.FirstOrDefault(x => x.AppUserId == user.Id && x.ChapterId == chapterId); if (progress != null) { progressBookmark.SeriesId = progress.SeriesId; progressBookmark.VolumeId = progress.VolumeId; progressBookmark.PageNum = progress.PagesRead; progressBookmark.BookScrollId = progress.BookScrollId; } return Ok(progressBookmark); } /// /// Save page against Chapter for logged in user /// /// /// [HttpPost("progress")] public async Task BookmarkProgress(ProgressDto progressDto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername()); if (await _readerService.SaveReadingProgress(progressDto, user.Id)) return Ok(true); return BadRequest("Could not save progress"); } /// /// Returns a list of bookmarked pages for a given Chapter /// /// /// [HttpGet("get-bookmarks")] public async Task>> GetBookmarks(int chapterId) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Bookmarks); if (user.Bookmarks == null) return Ok(Array.Empty()); return Ok(await _unitOfWork.UserRepository.GetBookmarkDtosForChapter(user.Id, chapterId)); } /// /// Returns a list of all bookmarked pages for a User /// /// [HttpGet("get-all-bookmarks")] public async Task>> GetAllBookmarks() { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Bookmarks); if (user.Bookmarks == null) return Ok(Array.Empty()); return Ok(await _unitOfWork.UserRepository.GetAllBookmarkDtos(user.Id)); } /// /// Removes all bookmarks for all chapters linked to a Series /// /// /// [HttpPost("remove-bookmarks")] public async Task RemoveBookmarks(RemoveBookmarkForSeriesDto dto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Bookmarks); if (user.Bookmarks == null) return Ok("Nothing to remove"); try { user.Bookmarks = user.Bookmarks.Where(bmk => bmk.SeriesId != dto.SeriesId).ToList(); _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { try { await _cleanupService.CleanupBookmarks(); } catch (Exception ex) { _logger.LogError(ex, "There was an issue cleaning up old bookmarks"); } return Ok(); } } catch (Exception ex) { _logger.LogError(ex, "There was an exception when trying to clear bookmarks"); await _unitOfWork.RollbackAsync(); } return BadRequest("Could not clear bookmarks"); } /// /// Returns all bookmarked pages for a given volume /// /// /// [HttpGet("get-volume-bookmarks")] public async Task>> GetBookmarksForVolume(int volumeId) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Bookmarks); if (user.Bookmarks == null) return Ok(Array.Empty()); return Ok(await _unitOfWork.UserRepository.GetBookmarkDtosForVolume(user.Id, volumeId)); } /// /// Returns all bookmarked pages for a given series /// /// /// [HttpGet("get-series-bookmarks")] public async Task>> GetBookmarksForSeries(int seriesId) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Bookmarks); if (user.Bookmarks == null) return Ok(Array.Empty()); return Ok(await _unitOfWork.UserRepository.GetBookmarkDtosForSeries(user.Id, seriesId)); } /// /// Bookmarks a page against a Chapter /// /// /// [HttpPost("bookmark")] public async Task BookmarkPage(BookmarkDto bookmarkDto) { // Don't let user save past total pages. bookmarkDto.Page = await _readerService.CapPageToChapter(bookmarkDto.ChapterId, bookmarkDto.Page); try { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Bookmarks); var userBookmark = await _unitOfWork.UserRepository.GetBookmarkForPage(bookmarkDto.Page, bookmarkDto.ChapterId, user.Id); // We need to get the image var chapter = await _cacheService.Ensure(bookmarkDto.ChapterId); if (chapter == null) return BadRequest("There was an issue finding image file for reading"); var path = _cacheService.GetCachedPagePath(chapter, bookmarkDto.Page); var fileInfo = new FileInfo(path); var bookmarkDirectory = (await _unitOfWork.SettingsRepository.GetSettingAsync(ServerSettingKey.BookmarkDirectory)).Value; _directoryService.CopyFileToDirectory(path, Path.Join(bookmarkDirectory, $"{user.Id}", $"{bookmarkDto.SeriesId}", $"{bookmarkDto.ChapterId}")); if (userBookmark == null) { user.Bookmarks ??= new List(); user.Bookmarks.Add(new AppUserBookmark() { Page = bookmarkDto.Page, VolumeId = bookmarkDto.VolumeId, SeriesId = bookmarkDto.SeriesId, ChapterId = bookmarkDto.ChapterId, FileName = Path.Join($"{user.Id}", $"{bookmarkDto.SeriesId}", $"{bookmarkDto.ChapterId}", fileInfo.Name) }); _unitOfWork.UserRepository.Update(user); } await _unitOfWork.CommitAsync(); } catch (Exception) { await _unitOfWork.RollbackAsync(); return BadRequest("Could not save bookmark"); } return Ok(); } /// /// Removes a bookmarked page for a Chapter /// /// /// [HttpPost("unbookmark")] public async Task UnBookmarkPage(BookmarkDto bookmarkDto) { var user = await _unitOfWork.UserRepository.GetUserByUsernameAsync(User.GetUsername(), AppUserIncludes.Bookmarks); if (user.Bookmarks == null) return Ok(); try { user.Bookmarks = user.Bookmarks.Where(x => x.ChapterId == bookmarkDto.ChapterId && x.AppUserId == user.Id && x.Page != bookmarkDto.Page).ToList(); _unitOfWork.UserRepository.Update(user); if (await _unitOfWork.CommitAsync()) { return Ok(); } } catch (Exception) { await _unitOfWork.RollbackAsync(); } return BadRequest("Could not remove bookmark"); } /// /// Returns the next logical chapter from the series. /// /// /// V1 → V2 → V3 chapter 0 → V3 chapter 10 → SP 01 → SP 02 /// /// /// /// /// chapter id for next manga [HttpGet("next-chapter")] public async Task> GetNextChapter(int seriesId, int volumeId, int currentChapterId) { var userId = await _unitOfWork.UserRepository.GetUserIdByUsernameAsync(User.GetUsername()); return await _readerService.GetNextChapterIdAsync(seriesId, volumeId, currentChapterId, userId); } /// /// Returns the previous logical chapter from the series. /// /// /// V1 ← V2 ← V3 chapter 0 ← V3 chapter 10 ← SP 01 ← SP 02 /// /// /// /// /// chapter id for next manga [HttpGet("prev-chapter")] public async Task> GetPreviousChapter(int seriesId, int volumeId, int currentChapterId) { var userId = await _unitOfWork.UserRepository.GetUserIdByUsernameAsync(User.GetUsername()); return await _readerService.GetPrevChapterIdAsync(seriesId, volumeId, currentChapterId, userId); } } }