mirror of
https://github.com/Kareadita/Kavita.git
synced 2025-06-02 21:24:18 -04:00
* Updating wording on card item when total pages is 0, to be just "Cannot Read" since it could be a non-archive file * Refactored cover images to be stored on disk. This first commit has the extraction to disk and the metadata service to handle updating when applicable. * Refactored code to have the actual save to cover image directory done by ImageService. * Implemented the ability to override cover images. * Some cleanup on Image service * Implemented the ability to cleanup old covers nightly * Added a migration to migrate existing covers to new cover image format (files). * Refactored all CoverImages to just be the filename, leaving the Join with Cover directory to higher level code. * Ensure when getting user progress, we pick the first. * Added cleanup cover images for deleted tags. Don't pull any cover images that are blank. * After series update, clear out cover image. No change on UI, but just keeps things clear before metadata refresh hits * Refactored image formats for covers to ImageService. * Fixed an issue where after refactoring how images were stored, the cleanup service was deleting them after each scan. * Changed how ShouldUpdateCoverImage works to check if file exists or not even if cover image is locked. * Fixed unit tests * Added caching back to cover images. * Caching on series as well * Code Cleanup items * Ensure when checking if a file exists in MetadataService, that we join for cover image directory. After we scan library, do one last filter to delete any series that have 0 pages total. * Catch exceptions so we don't run cover migration if this is first time run. * After a scan, only clear out the cache directory and not do a deep clean. * Implemented the ability to backup custom locked covers only. * Fixed unit tests * Trying to figure out why GA crashes when running MetadataServiceTests.cs * Some debugging on GA tests not running * Commented out tests that were causing issues in GA. * Fixed an issue where series cover images wouldn't migrate * Fixed the updating of links to actually do all series and not just locked
161 lines
6.7 KiB
C#
161 lines
6.7 KiB
C#
using System;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Threading.Tasks;
|
|
using API.Helpers;
|
|
using API.Services;
|
|
using Microsoft.EntityFrameworkCore;
|
|
|
|
namespace API.Data
|
|
{
|
|
/// <summary>
|
|
/// A data structure to migrate Cover Images from byte[] to files.
|
|
/// </summary>
|
|
internal class CoverMigration
|
|
{
|
|
public string Id { get; set; }
|
|
public byte[] CoverImage { get; set; }
|
|
public string ParentId { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// In v0.4.6, Cover Images were migrated from byte[] in the DB to external files. This migration handles that work.
|
|
/// </summary>
|
|
public static class MigrateCoverImages
|
|
{
|
|
/// <summary>
|
|
/// Run first. Will extract byte[]s from DB and write them to the cover directory.
|
|
/// </summary>
|
|
public static void ExtractToImages(DbContext context)
|
|
{
|
|
Console.WriteLine("Migrating Cover Images to disk. Expect delay.");
|
|
DirectoryService.ExistOrCreate(DirectoryService.CoverImageDirectory);
|
|
|
|
Console.WriteLine("Extracting cover images for Series");
|
|
var lockedSeries = SqlHelper.RawSqlQuery(context, "Select Id, CoverImage From Series Where CoverImage IS NOT NULL", x =>
|
|
new CoverMigration()
|
|
{
|
|
Id = x[0] + string.Empty,
|
|
CoverImage = (byte[]) x[1],
|
|
ParentId = "0"
|
|
});
|
|
foreach (var series in lockedSeries)
|
|
{
|
|
if (series.CoverImage == null || !series.CoverImage.Any()) continue;
|
|
if (File.Exists(Path.Join(DirectoryService.CoverImageDirectory,
|
|
$"{ImageService.GetSeriesFormat(int.Parse(series.Id))}.png"))) continue;
|
|
|
|
try
|
|
{
|
|
var stream = new MemoryStream(series.CoverImage);
|
|
stream.Position = 0;
|
|
ImageService.WriteCoverThumbnail(stream, ImageService.GetSeriesFormat(int.Parse(series.Id)));
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
Console.WriteLine(e);
|
|
}
|
|
}
|
|
|
|
Console.WriteLine("Extracting cover images for Chapters");
|
|
var chapters = SqlHelper.RawSqlQuery(context, "Select Id, CoverImage, VolumeId From Chapter Where CoverImage IS NOT NULL;", x =>
|
|
new CoverMigration()
|
|
{
|
|
Id = x[0] + string.Empty,
|
|
CoverImage = (byte[]) x[1],
|
|
ParentId = x[2] + string.Empty
|
|
});
|
|
foreach (var chapter in chapters)
|
|
{
|
|
if (chapter.CoverImage == null || !chapter.CoverImage.Any()) continue;
|
|
if (File.Exists(Path.Join(DirectoryService.CoverImageDirectory,
|
|
$"{ImageService.GetChapterFormat(int.Parse(chapter.Id), int.Parse(chapter.ParentId))}.png"))) continue;
|
|
|
|
try
|
|
{
|
|
var stream = new MemoryStream(chapter.CoverImage);
|
|
stream.Position = 0;
|
|
ImageService.WriteCoverThumbnail(stream, $"{ImageService.GetChapterFormat(int.Parse(chapter.Id), int.Parse(chapter.ParentId))}");
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
Console.WriteLine(e);
|
|
}
|
|
}
|
|
|
|
Console.WriteLine("Extracting cover images for Collection Tags");
|
|
var tags = SqlHelper.RawSqlQuery(context, "Select Id, CoverImage From CollectionTag Where CoverImage IS NOT NULL;", x =>
|
|
new CoverMigration()
|
|
{
|
|
Id = x[0] + string.Empty,
|
|
CoverImage = (byte[]) x[1] ,
|
|
ParentId = "0"
|
|
});
|
|
foreach (var tag in tags)
|
|
{
|
|
if (tag.CoverImage == null || !tag.CoverImage.Any()) continue;
|
|
if (File.Exists(Path.Join(DirectoryService.CoverImageDirectory,
|
|
$"{ImageService.GetCollectionTagFormat(int.Parse(tag.Id))}.png"))) continue;
|
|
try
|
|
{
|
|
var stream = new MemoryStream(tag.CoverImage);
|
|
stream.Position = 0;
|
|
ImageService.WriteCoverThumbnail(stream, $"{ImageService.GetCollectionTagFormat(int.Parse(tag.Id))}");
|
|
}
|
|
catch (Exception e)
|
|
{
|
|
Console.WriteLine(e);
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Run after <see cref="ExtractToImages"/>. Will update the DB with names of files that were extracted.
|
|
/// </summary>
|
|
/// <param name="context"></param>
|
|
public static async Task UpdateDatabaseWithImages(DataContext context)
|
|
{
|
|
Console.WriteLine("Updating Series entities");
|
|
var seriesCovers = await context.Series.Where(s => !string.IsNullOrEmpty(s.CoverImage)).ToListAsync();
|
|
foreach (var series in seriesCovers)
|
|
{
|
|
if (!File.Exists(Path.Join(DirectoryService.CoverImageDirectory,
|
|
$"{ImageService.GetSeriesFormat(series.Id)}.png"))) continue;
|
|
series.CoverImage = $"{ImageService.GetSeriesFormat(series.Id)}.png";
|
|
}
|
|
|
|
await context.SaveChangesAsync();
|
|
|
|
Console.WriteLine("Updating Chapter entities");
|
|
var chapters = await context.Chapter.ToListAsync();
|
|
foreach (var chapter in chapters)
|
|
{
|
|
if (File.Exists(Path.Join(DirectoryService.CoverImageDirectory,
|
|
$"{ImageService.GetChapterFormat(chapter.Id, chapter.VolumeId)}.png")))
|
|
{
|
|
chapter.CoverImage = $"{ImageService.GetChapterFormat(chapter.Id, chapter.VolumeId)}.png";
|
|
}
|
|
|
|
}
|
|
|
|
await context.SaveChangesAsync();
|
|
|
|
Console.WriteLine("Updating Collection Tag entities");
|
|
var tags = await context.CollectionTag.ToListAsync();
|
|
foreach (var tag in tags)
|
|
{
|
|
if (File.Exists(Path.Join(DirectoryService.CoverImageDirectory,
|
|
$"{ImageService.GetCollectionTagFormat(tag.Id)}.png")))
|
|
{
|
|
tag.CoverImage = $"{ImageService.GetCollectionTagFormat(tag.Id)}.png";
|
|
}
|
|
|
|
}
|
|
|
|
await context.SaveChangesAsync();
|
|
Console.WriteLine("Cover Image Migration completed");
|
|
}
|
|
|
|
}
|
|
}
|