mirror of
https://github.com/Kareadita/Kavita.git
synced 2026-06-05 14:25:17 -04:00
Text View, View & Filter All Annotations, and More OPDS Love (#4062)
Co-authored-by: Amelia <77553571+Fesaa@users.noreply.github.com>
This commit is contained in:
Joe Milazzo
GitHub
@@ -0,0 +1,278 @@
|
||||
#nullable enable
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Linq;
|
||||
using System.Net;
|
||||
using System.Text.Encodings.Web;
|
||||
using System.Text.Json;
|
||||
using System.Threading.Tasks;
|
||||
using API.Data;
|
||||
using API.Data.Repositories;
|
||||
using API.DTOs.Annotations;
|
||||
using API.DTOs.Reader;
|
||||
using API.Entities;
|
||||
using API.Helpers;
|
||||
using API.SignalR;
|
||||
using HtmlAgilityPack;
|
||||
using Kavita.Common;
|
||||
using Microsoft.Extensions.Logging;
|
||||
|
||||
namespace API.Services;
|
||||
|
||||
public interface IAnnotationService
|
||||
{
|
||||
Task<AnnotationDto> CreateAnnotation(int userId, AnnotationDto dto);
|
||||
Task<AnnotationDto> UpdateAnnotation(int userId, AnnotationDto dto);
|
||||
/// <summary>
|
||||
/// Export all annotations for a user, or optionally specify which annotation exactly
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="annotationIds"></param>
|
||||
/// <returns></returns>
|
||||
Task<string> ExportAnnotations(int userId, IList<int>? annotationIds = null);
|
||||
}
|
||||
|
||||
public class AnnotationService : IAnnotationService
|
||||
{
|
||||
private readonly IUnitOfWork _unitOfWork;
|
||||
private readonly IBookService _bookService;
|
||||
private readonly IDirectoryService _directoryService;
|
||||
private readonly IEventHub _eventHub;
|
||||
private readonly ILogger<AnnotationService> _logger;
|
||||
|
||||
public AnnotationService(IUnitOfWork unitOfWork, IBookService bookService,
|
||||
IDirectoryService directoryService, IEventHub eventHub, ILogger<AnnotationService> logger)
|
||||
{
|
||||
_unitOfWork = unitOfWork;
|
||||
_bookService = bookService;
|
||||
_directoryService = directoryService;
|
||||
_eventHub = eventHub;
|
||||
_logger = logger;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Create a new Annotation for the user against a Chapter
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="dto"></param>
|
||||
/// <returns></returns>
|
||||
/// <exception cref="KavitaException">Message is not localized</exception>
|
||||
public async Task<AnnotationDto> CreateAnnotation(int userId, AnnotationDto dto)
|
||||
{
|
||||
try
|
||||
{
|
||||
if (dto.HighlightCount == 0 || string.IsNullOrWhiteSpace(dto.SelectedText))
|
||||
{
|
||||
throw new KavitaException("invalid-payload");
|
||||
}
|
||||
|
||||
var chapter = await _unitOfWork.ChapterRepository.GetChapterAsync(dto.ChapterId) ?? throw new KavitaException("chapter-doesnt-exist");
|
||||
var chapterTitle = string.Empty;
|
||||
|
||||
try
|
||||
{
|
||||
var toc = await _bookService.GenerateTableOfContents(chapter);
|
||||
var pageTocs = BookChapterItemHelper.GetTocForPage(toc, dto.PageNumber);
|
||||
if (pageTocs.Count > 0)
|
||||
{
|
||||
chapterTitle = pageTocs[0].Title;
|
||||
}
|
||||
}
|
||||
catch (KavitaException)
|
||||
{
|
||||
/* Swallow */
|
||||
}
|
||||
|
||||
var annotation = new AppUserAnnotation()
|
||||
{
|
||||
XPath = dto.XPath,
|
||||
EndingXPath = dto.EndingXPath,
|
||||
ChapterId = dto.ChapterId,
|
||||
SeriesId = dto.SeriesId,
|
||||
VolumeId = dto.VolumeId,
|
||||
LibraryId = dto.LibraryId,
|
||||
HighlightCount = dto.HighlightCount,
|
||||
SelectedText = dto.SelectedText,
|
||||
Comment = dto.Comment,
|
||||
CommentHtml = dto.CommentHtml,
|
||||
CommentPlainText = StripHtml(dto.CommentHtml),
|
||||
ContainsSpoiler = dto.ContainsSpoiler,
|
||||
PageNumber = dto.PageNumber,
|
||||
SelectedSlotIndex = dto.SelectedSlotIndex,
|
||||
AppUserId = userId,
|
||||
Context = dto.Context,
|
||||
ChapterTitle = chapterTitle
|
||||
};
|
||||
|
||||
_unitOfWork.AnnotationRepository.Attach(annotation);
|
||||
await _unitOfWork.CommitAsync();
|
||||
|
||||
return await _unitOfWork.AnnotationRepository.GetAnnotationDto(annotation.Id);
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "There was an exception when creating an annotation on {ChapterId} - Page {Page}", dto.ChapterId, dto.PageNumber);
|
||||
throw new KavitaException("annotation-failed-create");
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Update the modifiable fields (Spoiler, highlight slot, and comment) for an annotation
|
||||
/// </summary>
|
||||
/// <param name="userId"></param>
|
||||
/// <param name="dto"></param>
|
||||
/// <returns></returns>
|
||||
/// <exception cref="KavitaException">Message is not localized</exception>
|
||||
public async Task<AnnotationDto> UpdateAnnotation(int userId, AnnotationDto dto)
|
||||
{
|
||||
try
|
||||
{
|
||||
var annotation = await _unitOfWork.AnnotationRepository.GetAnnotation(dto.Id);
|
||||
if (annotation == null || annotation.AppUserId != userId) throw new KavitaException("denied");
|
||||
|
||||
annotation.ContainsSpoiler = dto.ContainsSpoiler;
|
||||
annotation.SelectedSlotIndex = dto.SelectedSlotIndex;
|
||||
annotation.Comment = dto.Comment;
|
||||
annotation.CommentHtml = dto.CommentHtml;
|
||||
annotation.CommentPlainText = StripHtml(dto.CommentHtml);
|
||||
|
||||
_unitOfWork.AnnotationRepository.Update(annotation);
|
||||
|
||||
if (!_unitOfWork.HasChanges() || await _unitOfWork.CommitAsync())
|
||||
{
|
||||
await _eventHub.SendMessageToAsync(MessageFactory.AnnotationUpdate,
|
||||
MessageFactory.AnnotationUpdateEvent(dto), userId);
|
||||
return dto;
|
||||
}
|
||||
} catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "There was an exception updating Annotation for Chapter {ChapterId} - Page {PageNumber}", dto.ChapterId, dto.PageNumber);
|
||||
}
|
||||
|
||||
throw new KavitaException("generic-error");
|
||||
}
|
||||
|
||||
public async Task<string> ExportAnnotations(int userId, IList<int>? annotationIds = null)
|
||||
{
|
||||
try
|
||||
{
|
||||
// Get users with preferences for highlight colors
|
||||
var users = (await _unitOfWork.UserRepository
|
||||
.GetAllUsersAsync(AppUserIncludes.UserPreferences))
|
||||
.ToDictionary(u => u.Id, u => u);
|
||||
|
||||
// Get all annotations for the user with related data
|
||||
IList<FullAnnotationDto> annotations;
|
||||
if (annotationIds == null)
|
||||
{
|
||||
annotations = await _unitOfWork.AnnotationRepository.GetFullAnnotationsByUserIdAsync(userId);
|
||||
}
|
||||
else
|
||||
{
|
||||
annotations = await _unitOfWork.AnnotationRepository.GetFullAnnotations(userId, annotationIds);
|
||||
}
|
||||
|
||||
// Get settings for hostname
|
||||
var settings = await _unitOfWork.SettingsRepository.GetSettingsDtoAsync();
|
||||
var hostname = !string.IsNullOrWhiteSpace(settings.HostName) ? settings.HostName : "http://localhost:5000";
|
||||
|
||||
// Group annotations by series, then by volume
|
||||
var exportData = annotations
|
||||
.GroupBy(a => new { a.SeriesId, a.SeriesName, a.LibraryId, a.LibraryName })
|
||||
.Select(seriesGroup => new
|
||||
{
|
||||
series = new
|
||||
{
|
||||
id = seriesGroup.Key.SeriesId,
|
||||
title = seriesGroup.Key.SeriesName,
|
||||
libraryName = seriesGroup.Key.LibraryName,
|
||||
libraryId = seriesGroup.Key.LibraryId
|
||||
},
|
||||
volumes = seriesGroup
|
||||
.GroupBy(a => new { a.VolumeId, a.VolumeName })
|
||||
.Select(volumeGroup => new
|
||||
{
|
||||
id = volumeGroup.Key.VolumeId,
|
||||
title = volumeGroup.Key.VolumeName,
|
||||
annotations = volumeGroup.Select(annotation =>
|
||||
{
|
||||
var user = users[annotation.UserId];
|
||||
var highlightSlot = user.UserPreferences.BookReaderHighlightSlots
|
||||
.FirstOrDefault(slot => slot.SlotNumber == annotation.SelectedSlotIndex);
|
||||
|
||||
var slotColor = highlightSlot != null
|
||||
? $"#{highlightSlot.Color.R:X2}{highlightSlot.Color.G:X2}{highlightSlot.Color.B:X2}"
|
||||
: "#000000";
|
||||
|
||||
var deepLink = $"{hostname}/library/{annotation.LibraryId}/series/{annotation.SeriesId}/book/{annotation.ChapterId}?incognitoMode=true&annotationId={annotation.Id}";
|
||||
|
||||
var obsidianTitle = $"{seriesGroup.Key.SeriesName} - {volumeGroup.Key.VolumeName}";
|
||||
if (!string.IsNullOrWhiteSpace(annotation.ChapterTitle))
|
||||
{
|
||||
obsidianTitle += $" - {annotation.ChapterTitle}";
|
||||
}
|
||||
|
||||
return new
|
||||
{
|
||||
id = annotation.Id,
|
||||
selectedText = annotation.SelectedText,
|
||||
comment = annotation.CommentHtml,
|
||||
context = annotation.Context,
|
||||
chapterTitle = annotation.ChapterTitle,
|
||||
pageNumber = annotation.PageNumber,
|
||||
slotColor,
|
||||
containsSpoiler = annotation.ContainsSpoiler,
|
||||
deepLink,
|
||||
createdUtc = annotation.CreatedUtc.ToString("yyyy-MM-ddTHH:mm:ssZ"),
|
||||
lastModifiedUtc = annotation.LastModifiedUtc.ToString("yyyy-MM-ddTHH:mm:ssZ"),
|
||||
obsidianTags = new[] { "#kavita", $"#{seriesGroup.Key.SeriesName.ToLowerInvariant().Replace(" ", "-")}", "#highlights" },
|
||||
obsidianTitle,
|
||||
obsidianBacklinks = new[] { $"[[{seriesGroup.Key.SeriesName} Series]]", $"[[{volumeGroup.Key.VolumeName}]]" }
|
||||
};
|
||||
}).ToArray(),
|
||||
}).ToArray(),
|
||||
}).ToArray();
|
||||
|
||||
// Serialize to JSON
|
||||
var options = new JsonSerializerOptions
|
||||
{
|
||||
WriteIndented = true,
|
||||
PropertyNamingPolicy = JsonNamingPolicy.CamelCase,
|
||||
Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping
|
||||
};
|
||||
|
||||
var json = JsonSerializer.Serialize(exportData, options);
|
||||
|
||||
_logger.LogInformation("Successfully exported {AnnotationCount} annotations for user {UserId}", annotations.Count, userId);
|
||||
|
||||
return json;
|
||||
}
|
||||
catch (Exception ex)
|
||||
{
|
||||
_logger.LogError(ex, "Failed to export annotations for user {UserId}", userId);
|
||||
throw new KavitaException("annotation-export-failed");
|
||||
}
|
||||
}
|
||||
|
||||
private string StripHtml(string? html)
|
||||
{
|
||||
if (string.IsNullOrEmpty(html))
|
||||
{
|
||||
return string.Empty;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
var document = new HtmlDocument();
|
||||
document.LoadHtml(html);
|
||||
|
||||
return document.DocumentNode.InnerText.Replace(" ", " ");
|
||||
}
|
||||
catch (Exception exception)
|
||||
{
|
||||
_logger.LogError(exception, "Invalid html, cannot parse plain text");
|
||||
return string.Empty;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user